-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmodel__api_v1_url_pools__id__urls_post_request.go
More file actions
270 lines (219 loc) · 11.7 KB
/
Copy pathmodel__api_v1_url_pools__id__urls_post_request.go
File metadata and controls
270 lines (219 loc) · 11.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
/*
GoAdServer Public API
Public REST API for advertisers and publishers on the GoAdServer platform. **Authentication.** All endpoints (except `/api/public/_*`) require an API key passed as `Authorization: Bearer gas_live_…`. Create and manage keys in your account settings — each key has its own scopes, optional resource pinning, optional IP allowlist, and per-key rate limit. **System rules apply over API rules.** The public API never lets a key bypass restrictions the same user faces in the panel: - **Source names** (`stats_source_names` right). When the user lacks this right, advertiser stats responses return `{id, name}` with `name` equal to the id — no human label leaks through. - **SubID encoding** (`modules.global.subid_encoding`). When enabled for the system, the user only ever sees encoded SubIDs in the panel. The API mirrors this both ways: `subid_excl`/`subid_incl` filter endpoints accept the encoded form on write (decoded server-side before storage) and emit the encoded form on read. - **Module gating.** Endpoints whose module is disabled for the tenant don't appear in the spec or routes.txt at all. **Client SDKs.** Each SDK is generated from this spec and published as a public GitHub repository under the `goadserver` organization. The same tarball is also embedded in the API server and downloadable from `/api/public/sdk/<lang>.tgz` — useful when GitHub is unreachable. > **Per-network host.** The default `https://up.go-adserver.com` > baked into the published SDKs is a reference host. Every white-label > tenant runs on its own panel domain — override the host on first use > (`setHost()` / `Configuration.host` / `basePath` etc.). Or, fetch the > spec from your own tenant (`/api/public/openapi.yaml` returns it with > *your* hostname as the default) and regenerate the SDK locally — the > regenerated client has your URL baked in. - **PHP** — `github.com/goadserver/goadserver-php` (namespace `GoAdServer\\Api`, composer name `goadserver/sdk`). ```bash composer config repositories.goadserver vcs https://github.com/goadserver/goadserver-php composer require goadserver/sdk:dev-main ``` ```php $cfg = GoAdServer\\Api\\Configuration::getDefaultConfiguration() ->setHost('https://up.go-adserver.com') ->setAccessToken('gas_live_…'); $api = new GoAdServer\\Api\\Api\\AccountAPIApi(null, $cfg); $me = $api->apiV1AccountGet(); ``` - **Go** — `github.com/goadserver/goadserver-go`. ```bash go get github.com/goadserver/goadserver-go@latest ``` ```go import gas \"github.com/goadserver/goadserver-go\" cfg := gas.NewConfiguration() cfg.Servers = gas.ServerConfigurations{{URL: \"https://up.go-adserver.com\"}} cli := gas.NewAPIClient(cfg) ctx := context.WithValue(context.Background(), gas.ContextAccessToken, \"gas_live_…\") me, _, err := cli.AccountAPI.ApiV1AccountGet(ctx).Execute() ``` - **Python** — `github.com/goadserver/goadserver-python` (package `goadserver`). Pulls `pydantic` + `urllib3` automatically. ```bash pip install git+https://github.com/goadserver/goadserver-python.git ``` ```python from goadserver import ApiClient, Configuration from goadserver.api import AccountApi, CampaignsApi cfg = Configuration(host=\"https://up.go-adserver.com\") cfg.access_token = \"gas_live_…\" client = ApiClient(cfg) me = AccountApi(client).api_v1_account_get() camps = CampaignsApi(client).api_v1_campaigns_get(per_page=10) ``` - **JavaScript / TypeScript** — `github.com/goadserver/goadserver-js` (npm name `goadserver-sdk`, generator `typescript-fetch`). ```bash npm install github:goadserver/goadserver-js ``` ```ts import { Configuration, AccountApi, CampaignsApi } from \"goadserver-sdk\"; const cfg = new Configuration({ basePath: \"https://up.go-adserver.com\", accessToken: \"gas_live_…\", }); const me = await new AccountApi(cfg).apiV1AccountGet(); const list = await new CampaignsApi(cfg).apiV1CampaignsGet({ perPage: 10 }); ``` The CJS build is broadly compatible (Node + bundlers); the ESM build is missing trailing `.js` extensions in its imports, a known `typescript-fetch` quirk — most consumers use CJS. **Offline / firewalled install.** If the customer's network can't reach GitHub, every SDK's source is also served as a tarball from the API host: ```bash curl -O https://up.go-adserver.com/api/public/sdk/python.tgz tar xzf python.tgz && pip install ./python ``` Round-trip smoke tests for all four SDKs live at `clients/_smoke/` in the platform repo.
API version: 1.0.0
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package goadserver
import (
"encoding/json"
"bytes"
"fmt"
)
// checks if the ApiV1UrlPoolsIdUrlsPostRequest type satisfies the MappedNullable interface at compile time
var _ MappedNullable = &ApiV1UrlPoolsIdUrlsPostRequest{}
// ApiV1UrlPoolsIdUrlsPostRequest struct for ApiV1UrlPoolsIdUrlsPostRequest
type ApiV1UrlPoolsIdUrlsPostRequest struct {
Url string `json:"url"`
Title *string `json:"title,omitempty"`
Weight *int32 `json:"weight,omitempty"`
Properties *string `json:"properties,omitempty"`
}
type _ApiV1UrlPoolsIdUrlsPostRequest ApiV1UrlPoolsIdUrlsPostRequest
// NewApiV1UrlPoolsIdUrlsPostRequest instantiates a new ApiV1UrlPoolsIdUrlsPostRequest object
// This constructor will assign default values to properties that have it defined,
// and makes sure properties required by API are set, but the set of arguments
// will change when the set of required properties is changed
func NewApiV1UrlPoolsIdUrlsPostRequest(url string) *ApiV1UrlPoolsIdUrlsPostRequest {
this := ApiV1UrlPoolsIdUrlsPostRequest{}
this.Url = url
var weight int32 = 1
this.Weight = &weight
return &this
}
// NewApiV1UrlPoolsIdUrlsPostRequestWithDefaults instantiates a new ApiV1UrlPoolsIdUrlsPostRequest object
// This constructor will only assign default values to properties that have it defined,
// but it doesn't guarantee that properties required by API are set
func NewApiV1UrlPoolsIdUrlsPostRequestWithDefaults() *ApiV1UrlPoolsIdUrlsPostRequest {
this := ApiV1UrlPoolsIdUrlsPostRequest{}
var weight int32 = 1
this.Weight = &weight
return &this
}
// GetUrl returns the Url field value
func (o *ApiV1UrlPoolsIdUrlsPostRequest) GetUrl() string {
if o == nil {
var ret string
return ret
}
return o.Url
}
// GetUrlOk returns a tuple with the Url field value
// and a boolean to check if the value has been set.
func (o *ApiV1UrlPoolsIdUrlsPostRequest) GetUrlOk() (*string, bool) {
if o == nil {
return nil, false
}
return &o.Url, true
}
// SetUrl sets field value
func (o *ApiV1UrlPoolsIdUrlsPostRequest) SetUrl(v string) {
o.Url = v
}
// GetTitle returns the Title field value if set, zero value otherwise.
func (o *ApiV1UrlPoolsIdUrlsPostRequest) GetTitle() string {
if o == nil || IsNil(o.Title) {
var ret string
return ret
}
return *o.Title
}
// GetTitleOk returns a tuple with the Title field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *ApiV1UrlPoolsIdUrlsPostRequest) GetTitleOk() (*string, bool) {
if o == nil || IsNil(o.Title) {
return nil, false
}
return o.Title, true
}
// HasTitle returns a boolean if a field has been set.
func (o *ApiV1UrlPoolsIdUrlsPostRequest) HasTitle() bool {
if o != nil && !IsNil(o.Title) {
return true
}
return false
}
// SetTitle gets a reference to the given string and assigns it to the Title field.
func (o *ApiV1UrlPoolsIdUrlsPostRequest) SetTitle(v string) {
o.Title = &v
}
// GetWeight returns the Weight field value if set, zero value otherwise.
func (o *ApiV1UrlPoolsIdUrlsPostRequest) GetWeight() int32 {
if o == nil || IsNil(o.Weight) {
var ret int32
return ret
}
return *o.Weight
}
// GetWeightOk returns a tuple with the Weight field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *ApiV1UrlPoolsIdUrlsPostRequest) GetWeightOk() (*int32, bool) {
if o == nil || IsNil(o.Weight) {
return nil, false
}
return o.Weight, true
}
// HasWeight returns a boolean if a field has been set.
func (o *ApiV1UrlPoolsIdUrlsPostRequest) HasWeight() bool {
if o != nil && !IsNil(o.Weight) {
return true
}
return false
}
// SetWeight gets a reference to the given int32 and assigns it to the Weight field.
func (o *ApiV1UrlPoolsIdUrlsPostRequest) SetWeight(v int32) {
o.Weight = &v
}
// GetProperties returns the Properties field value if set, zero value otherwise.
func (o *ApiV1UrlPoolsIdUrlsPostRequest) GetProperties() string {
if o == nil || IsNil(o.Properties) {
var ret string
return ret
}
return *o.Properties
}
// GetPropertiesOk returns a tuple with the Properties field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *ApiV1UrlPoolsIdUrlsPostRequest) GetPropertiesOk() (*string, bool) {
if o == nil || IsNil(o.Properties) {
return nil, false
}
return o.Properties, true
}
// HasProperties returns a boolean if a field has been set.
func (o *ApiV1UrlPoolsIdUrlsPostRequest) HasProperties() bool {
if o != nil && !IsNil(o.Properties) {
return true
}
return false
}
// SetProperties gets a reference to the given string and assigns it to the Properties field.
func (o *ApiV1UrlPoolsIdUrlsPostRequest) SetProperties(v string) {
o.Properties = &v
}
func (o ApiV1UrlPoolsIdUrlsPostRequest) MarshalJSON() ([]byte, error) {
toSerialize,err := o.ToMap()
if err != nil {
return []byte{}, err
}
return json.Marshal(toSerialize)
}
func (o ApiV1UrlPoolsIdUrlsPostRequest) ToMap() (map[string]interface{}, error) {
toSerialize := map[string]interface{}{}
toSerialize["url"] = o.Url
if !IsNil(o.Title) {
toSerialize["title"] = o.Title
}
if !IsNil(o.Weight) {
toSerialize["weight"] = o.Weight
}
if !IsNil(o.Properties) {
toSerialize["properties"] = o.Properties
}
return toSerialize, nil
}
func (o *ApiV1UrlPoolsIdUrlsPostRequest) UnmarshalJSON(data []byte) (err error) {
// This validates that all required properties are included in the JSON object
// by unmarshalling the object into a generic map with string keys and checking
// that every required field exists as a key in the generic map.
requiredProperties := []string{
"url",
}
allProperties := make(map[string]interface{})
err = json.Unmarshal(data, &allProperties)
if err != nil {
return err;
}
for _, requiredProperty := range(requiredProperties) {
if _, exists := allProperties[requiredProperty]; !exists {
return fmt.Errorf("no value given for required property %v", requiredProperty)
}
}
varApiV1UrlPoolsIdUrlsPostRequest := _ApiV1UrlPoolsIdUrlsPostRequest{}
decoder := json.NewDecoder(bytes.NewReader(data))
decoder.DisallowUnknownFields()
err = decoder.Decode(&varApiV1UrlPoolsIdUrlsPostRequest)
if err != nil {
return err
}
*o = ApiV1UrlPoolsIdUrlsPostRequest(varApiV1UrlPoolsIdUrlsPostRequest)
return err
}
type NullableApiV1UrlPoolsIdUrlsPostRequest struct {
value *ApiV1UrlPoolsIdUrlsPostRequest
isSet bool
}
func (v NullableApiV1UrlPoolsIdUrlsPostRequest) Get() *ApiV1UrlPoolsIdUrlsPostRequest {
return v.value
}
func (v *NullableApiV1UrlPoolsIdUrlsPostRequest) Set(val *ApiV1UrlPoolsIdUrlsPostRequest) {
v.value = val
v.isSet = true
}
func (v NullableApiV1UrlPoolsIdUrlsPostRequest) IsSet() bool {
return v.isSet
}
func (v *NullableApiV1UrlPoolsIdUrlsPostRequest) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableApiV1UrlPoolsIdUrlsPostRequest(val *ApiV1UrlPoolsIdUrlsPostRequest) *NullableApiV1UrlPoolsIdUrlsPostRequest {
return &NullableApiV1UrlPoolsIdUrlsPostRequest{value: val, isSet: true}
}
func (v NullableApiV1UrlPoolsIdUrlsPostRequest) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableApiV1UrlPoolsIdUrlsPostRequest) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
}