-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmodel__api_v1_campaigns_get_200_response_data_inner.go
More file actions
378 lines (317 loc) · 15.3 KB
/
Copy pathmodel__api_v1_campaigns_get_200_response_data_inner.go
File metadata and controls
378 lines (317 loc) · 15.3 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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
/*
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"
)
// checks if the ApiV1CampaignsGet200ResponseDataInner type satisfies the MappedNullable interface at compile time
var _ MappedNullable = &ApiV1CampaignsGet200ResponseDataInner{}
// ApiV1CampaignsGet200ResponseDataInner struct for ApiV1CampaignsGet200ResponseDataInner
type ApiV1CampaignsGet200ResponseDataInner struct {
Id *int32 `json:"id,omitempty"`
Name *string `json:"name,omitempty"`
CampaignType *string `json:"campaign_type,omitempty"`
AdType *int32 `json:"ad_type,omitempty"`
SellingType *int32 `json:"selling_type,omitempty"`
IsPaused *bool `json:"is_paused,omitempty"`
IsActive *bool `json:"is_active,omitempty"`
IsDeleted *bool `json:"is_deleted,omitempty"`
}
// NewApiV1CampaignsGet200ResponseDataInner instantiates a new ApiV1CampaignsGet200ResponseDataInner 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 NewApiV1CampaignsGet200ResponseDataInner() *ApiV1CampaignsGet200ResponseDataInner {
this := ApiV1CampaignsGet200ResponseDataInner{}
return &this
}
// NewApiV1CampaignsGet200ResponseDataInnerWithDefaults instantiates a new ApiV1CampaignsGet200ResponseDataInner 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 NewApiV1CampaignsGet200ResponseDataInnerWithDefaults() *ApiV1CampaignsGet200ResponseDataInner {
this := ApiV1CampaignsGet200ResponseDataInner{}
return &this
}
// GetId returns the Id field value if set, zero value otherwise.
func (o *ApiV1CampaignsGet200ResponseDataInner) GetId() int32 {
if o == nil || IsNil(o.Id) {
var ret int32
return ret
}
return *o.Id
}
// GetIdOk returns a tuple with the Id field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *ApiV1CampaignsGet200ResponseDataInner) GetIdOk() (*int32, bool) {
if o == nil || IsNil(o.Id) {
return nil, false
}
return o.Id, true
}
// HasId returns a boolean if a field has been set.
func (o *ApiV1CampaignsGet200ResponseDataInner) HasId() bool {
if o != nil && !IsNil(o.Id) {
return true
}
return false
}
// SetId gets a reference to the given int32 and assigns it to the Id field.
func (o *ApiV1CampaignsGet200ResponseDataInner) SetId(v int32) {
o.Id = &v
}
// GetName returns the Name field value if set, zero value otherwise.
func (o *ApiV1CampaignsGet200ResponseDataInner) GetName() string {
if o == nil || IsNil(o.Name) {
var ret string
return ret
}
return *o.Name
}
// GetNameOk returns a tuple with the Name field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *ApiV1CampaignsGet200ResponseDataInner) GetNameOk() (*string, bool) {
if o == nil || IsNil(o.Name) {
return nil, false
}
return o.Name, true
}
// HasName returns a boolean if a field has been set.
func (o *ApiV1CampaignsGet200ResponseDataInner) HasName() bool {
if o != nil && !IsNil(o.Name) {
return true
}
return false
}
// SetName gets a reference to the given string and assigns it to the Name field.
func (o *ApiV1CampaignsGet200ResponseDataInner) SetName(v string) {
o.Name = &v
}
// GetCampaignType returns the CampaignType field value if set, zero value otherwise.
func (o *ApiV1CampaignsGet200ResponseDataInner) GetCampaignType() string {
if o == nil || IsNil(o.CampaignType) {
var ret string
return ret
}
return *o.CampaignType
}
// GetCampaignTypeOk returns a tuple with the CampaignType field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *ApiV1CampaignsGet200ResponseDataInner) GetCampaignTypeOk() (*string, bool) {
if o == nil || IsNil(o.CampaignType) {
return nil, false
}
return o.CampaignType, true
}
// HasCampaignType returns a boolean if a field has been set.
func (o *ApiV1CampaignsGet200ResponseDataInner) HasCampaignType() bool {
if o != nil && !IsNil(o.CampaignType) {
return true
}
return false
}
// SetCampaignType gets a reference to the given string and assigns it to the CampaignType field.
func (o *ApiV1CampaignsGet200ResponseDataInner) SetCampaignType(v string) {
o.CampaignType = &v
}
// GetAdType returns the AdType field value if set, zero value otherwise.
func (o *ApiV1CampaignsGet200ResponseDataInner) GetAdType() int32 {
if o == nil || IsNil(o.AdType) {
var ret int32
return ret
}
return *o.AdType
}
// GetAdTypeOk returns a tuple with the AdType field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *ApiV1CampaignsGet200ResponseDataInner) GetAdTypeOk() (*int32, bool) {
if o == nil || IsNil(o.AdType) {
return nil, false
}
return o.AdType, true
}
// HasAdType returns a boolean if a field has been set.
func (o *ApiV1CampaignsGet200ResponseDataInner) HasAdType() bool {
if o != nil && !IsNil(o.AdType) {
return true
}
return false
}
// SetAdType gets a reference to the given int32 and assigns it to the AdType field.
func (o *ApiV1CampaignsGet200ResponseDataInner) SetAdType(v int32) {
o.AdType = &v
}
// GetSellingType returns the SellingType field value if set, zero value otherwise.
func (o *ApiV1CampaignsGet200ResponseDataInner) GetSellingType() int32 {
if o == nil || IsNil(o.SellingType) {
var ret int32
return ret
}
return *o.SellingType
}
// GetSellingTypeOk returns a tuple with the SellingType field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *ApiV1CampaignsGet200ResponseDataInner) GetSellingTypeOk() (*int32, bool) {
if o == nil || IsNil(o.SellingType) {
return nil, false
}
return o.SellingType, true
}
// HasSellingType returns a boolean if a field has been set.
func (o *ApiV1CampaignsGet200ResponseDataInner) HasSellingType() bool {
if o != nil && !IsNil(o.SellingType) {
return true
}
return false
}
// SetSellingType gets a reference to the given int32 and assigns it to the SellingType field.
func (o *ApiV1CampaignsGet200ResponseDataInner) SetSellingType(v int32) {
o.SellingType = &v
}
// GetIsPaused returns the IsPaused field value if set, zero value otherwise.
func (o *ApiV1CampaignsGet200ResponseDataInner) GetIsPaused() bool {
if o == nil || IsNil(o.IsPaused) {
var ret bool
return ret
}
return *o.IsPaused
}
// GetIsPausedOk returns a tuple with the IsPaused field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *ApiV1CampaignsGet200ResponseDataInner) GetIsPausedOk() (*bool, bool) {
if o == nil || IsNil(o.IsPaused) {
return nil, false
}
return o.IsPaused, true
}
// HasIsPaused returns a boolean if a field has been set.
func (o *ApiV1CampaignsGet200ResponseDataInner) HasIsPaused() bool {
if o != nil && !IsNil(o.IsPaused) {
return true
}
return false
}
// SetIsPaused gets a reference to the given bool and assigns it to the IsPaused field.
func (o *ApiV1CampaignsGet200ResponseDataInner) SetIsPaused(v bool) {
o.IsPaused = &v
}
// GetIsActive returns the IsActive field value if set, zero value otherwise.
func (o *ApiV1CampaignsGet200ResponseDataInner) GetIsActive() bool {
if o == nil || IsNil(o.IsActive) {
var ret bool
return ret
}
return *o.IsActive
}
// GetIsActiveOk returns a tuple with the IsActive field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *ApiV1CampaignsGet200ResponseDataInner) GetIsActiveOk() (*bool, bool) {
if o == nil || IsNil(o.IsActive) {
return nil, false
}
return o.IsActive, true
}
// HasIsActive returns a boolean if a field has been set.
func (o *ApiV1CampaignsGet200ResponseDataInner) HasIsActive() bool {
if o != nil && !IsNil(o.IsActive) {
return true
}
return false
}
// SetIsActive gets a reference to the given bool and assigns it to the IsActive field.
func (o *ApiV1CampaignsGet200ResponseDataInner) SetIsActive(v bool) {
o.IsActive = &v
}
// GetIsDeleted returns the IsDeleted field value if set, zero value otherwise.
func (o *ApiV1CampaignsGet200ResponseDataInner) GetIsDeleted() bool {
if o == nil || IsNil(o.IsDeleted) {
var ret bool
return ret
}
return *o.IsDeleted
}
// GetIsDeletedOk returns a tuple with the IsDeleted field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *ApiV1CampaignsGet200ResponseDataInner) GetIsDeletedOk() (*bool, bool) {
if o == nil || IsNil(o.IsDeleted) {
return nil, false
}
return o.IsDeleted, true
}
// HasIsDeleted returns a boolean if a field has been set.
func (o *ApiV1CampaignsGet200ResponseDataInner) HasIsDeleted() bool {
if o != nil && !IsNil(o.IsDeleted) {
return true
}
return false
}
// SetIsDeleted gets a reference to the given bool and assigns it to the IsDeleted field.
func (o *ApiV1CampaignsGet200ResponseDataInner) SetIsDeleted(v bool) {
o.IsDeleted = &v
}
func (o ApiV1CampaignsGet200ResponseDataInner) MarshalJSON() ([]byte, error) {
toSerialize,err := o.ToMap()
if err != nil {
return []byte{}, err
}
return json.Marshal(toSerialize)
}
func (o ApiV1CampaignsGet200ResponseDataInner) ToMap() (map[string]interface{}, error) {
toSerialize := map[string]interface{}{}
if !IsNil(o.Id) {
toSerialize["id"] = o.Id
}
if !IsNil(o.Name) {
toSerialize["name"] = o.Name
}
if !IsNil(o.CampaignType) {
toSerialize["campaign_type"] = o.CampaignType
}
if !IsNil(o.AdType) {
toSerialize["ad_type"] = o.AdType
}
if !IsNil(o.SellingType) {
toSerialize["selling_type"] = o.SellingType
}
if !IsNil(o.IsPaused) {
toSerialize["is_paused"] = o.IsPaused
}
if !IsNil(o.IsActive) {
toSerialize["is_active"] = o.IsActive
}
if !IsNil(o.IsDeleted) {
toSerialize["is_deleted"] = o.IsDeleted
}
return toSerialize, nil
}
type NullableApiV1CampaignsGet200ResponseDataInner struct {
value *ApiV1CampaignsGet200ResponseDataInner
isSet bool
}
func (v NullableApiV1CampaignsGet200ResponseDataInner) Get() *ApiV1CampaignsGet200ResponseDataInner {
return v.value
}
func (v *NullableApiV1CampaignsGet200ResponseDataInner) Set(val *ApiV1CampaignsGet200ResponseDataInner) {
v.value = val
v.isSet = true
}
func (v NullableApiV1CampaignsGet200ResponseDataInner) IsSet() bool {
return v.isSet
}
func (v *NullableApiV1CampaignsGet200ResponseDataInner) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableApiV1CampaignsGet200ResponseDataInner(val *ApiV1CampaignsGet200ResponseDataInner) *NullableApiV1CampaignsGet200ResponseDataInner {
return &NullableApiV1CampaignsGet200ResponseDataInner{value: val, isSet: true}
}
func (v NullableApiV1CampaignsGet200ResponseDataInner) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableApiV1CampaignsGet200ResponseDataInner) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
}