-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmodel__api_v1_adspaces_get_200_response.go
More file actions
234 lines (193 loc) · 10.9 KB
/
Copy pathmodel__api_v1_adspaces_get_200_response.go
File metadata and controls
234 lines (193 loc) · 10.9 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
/*
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 ApiV1AdspacesGet200Response type satisfies the MappedNullable interface at compile time
var _ MappedNullable = &ApiV1AdspacesGet200Response{}
// ApiV1AdspacesGet200Response struct for ApiV1AdspacesGet200Response
type ApiV1AdspacesGet200Response struct {
Data []ApiV1AdspacesGet200ResponseDataInner `json:"data,omitempty"`
Page *int32 `json:"page,omitempty"`
PerPage *int32 `json:"per_page,omitempty"`
TotalRows *int32 `json:"total_rows,omitempty"`
}
// NewApiV1AdspacesGet200Response instantiates a new ApiV1AdspacesGet200Response 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 NewApiV1AdspacesGet200Response() *ApiV1AdspacesGet200Response {
this := ApiV1AdspacesGet200Response{}
return &this
}
// NewApiV1AdspacesGet200ResponseWithDefaults instantiates a new ApiV1AdspacesGet200Response 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 NewApiV1AdspacesGet200ResponseWithDefaults() *ApiV1AdspacesGet200Response {
this := ApiV1AdspacesGet200Response{}
return &this
}
// GetData returns the Data field value if set, zero value otherwise.
func (o *ApiV1AdspacesGet200Response) GetData() []ApiV1AdspacesGet200ResponseDataInner {
if o == nil || IsNil(o.Data) {
var ret []ApiV1AdspacesGet200ResponseDataInner
return ret
}
return o.Data
}
// GetDataOk returns a tuple with the Data field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *ApiV1AdspacesGet200Response) GetDataOk() ([]ApiV1AdspacesGet200ResponseDataInner, bool) {
if o == nil || IsNil(o.Data) {
return nil, false
}
return o.Data, true
}
// HasData returns a boolean if a field has been set.
func (o *ApiV1AdspacesGet200Response) HasData() bool {
if o != nil && !IsNil(o.Data) {
return true
}
return false
}
// SetData gets a reference to the given []ApiV1AdspacesGet200ResponseDataInner and assigns it to the Data field.
func (o *ApiV1AdspacesGet200Response) SetData(v []ApiV1AdspacesGet200ResponseDataInner) {
o.Data = v
}
// GetPage returns the Page field value if set, zero value otherwise.
func (o *ApiV1AdspacesGet200Response) GetPage() int32 {
if o == nil || IsNil(o.Page) {
var ret int32
return ret
}
return *o.Page
}
// GetPageOk returns a tuple with the Page field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *ApiV1AdspacesGet200Response) GetPageOk() (*int32, bool) {
if o == nil || IsNil(o.Page) {
return nil, false
}
return o.Page, true
}
// HasPage returns a boolean if a field has been set.
func (o *ApiV1AdspacesGet200Response) HasPage() bool {
if o != nil && !IsNil(o.Page) {
return true
}
return false
}
// SetPage gets a reference to the given int32 and assigns it to the Page field.
func (o *ApiV1AdspacesGet200Response) SetPage(v int32) {
o.Page = &v
}
// GetPerPage returns the PerPage field value if set, zero value otherwise.
func (o *ApiV1AdspacesGet200Response) GetPerPage() int32 {
if o == nil || IsNil(o.PerPage) {
var ret int32
return ret
}
return *o.PerPage
}
// GetPerPageOk returns a tuple with the PerPage field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *ApiV1AdspacesGet200Response) GetPerPageOk() (*int32, bool) {
if o == nil || IsNil(o.PerPage) {
return nil, false
}
return o.PerPage, true
}
// HasPerPage returns a boolean if a field has been set.
func (o *ApiV1AdspacesGet200Response) HasPerPage() bool {
if o != nil && !IsNil(o.PerPage) {
return true
}
return false
}
// SetPerPage gets a reference to the given int32 and assigns it to the PerPage field.
func (o *ApiV1AdspacesGet200Response) SetPerPage(v int32) {
o.PerPage = &v
}
// GetTotalRows returns the TotalRows field value if set, zero value otherwise.
func (o *ApiV1AdspacesGet200Response) GetTotalRows() int32 {
if o == nil || IsNil(o.TotalRows) {
var ret int32
return ret
}
return *o.TotalRows
}
// GetTotalRowsOk returns a tuple with the TotalRows field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *ApiV1AdspacesGet200Response) GetTotalRowsOk() (*int32, bool) {
if o == nil || IsNil(o.TotalRows) {
return nil, false
}
return o.TotalRows, true
}
// HasTotalRows returns a boolean if a field has been set.
func (o *ApiV1AdspacesGet200Response) HasTotalRows() bool {
if o != nil && !IsNil(o.TotalRows) {
return true
}
return false
}
// SetTotalRows gets a reference to the given int32 and assigns it to the TotalRows field.
func (o *ApiV1AdspacesGet200Response) SetTotalRows(v int32) {
o.TotalRows = &v
}
func (o ApiV1AdspacesGet200Response) MarshalJSON() ([]byte, error) {
toSerialize,err := o.ToMap()
if err != nil {
return []byte{}, err
}
return json.Marshal(toSerialize)
}
func (o ApiV1AdspacesGet200Response) ToMap() (map[string]interface{}, error) {
toSerialize := map[string]interface{}{}
if !IsNil(o.Data) {
toSerialize["data"] = o.Data
}
if !IsNil(o.Page) {
toSerialize["page"] = o.Page
}
if !IsNil(o.PerPage) {
toSerialize["per_page"] = o.PerPage
}
if !IsNil(o.TotalRows) {
toSerialize["total_rows"] = o.TotalRows
}
return toSerialize, nil
}
type NullableApiV1AdspacesGet200Response struct {
value *ApiV1AdspacesGet200Response
isSet bool
}
func (v NullableApiV1AdspacesGet200Response) Get() *ApiV1AdspacesGet200Response {
return v.value
}
func (v *NullableApiV1AdspacesGet200Response) Set(val *ApiV1AdspacesGet200Response) {
v.value = val
v.isSet = true
}
func (v NullableApiV1AdspacesGet200Response) IsSet() bool {
return v.isSet
}
func (v *NullableApiV1AdspacesGet200Response) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableApiV1AdspacesGet200Response(val *ApiV1AdspacesGet200Response) *NullableApiV1AdspacesGet200Response {
return &NullableApiV1AdspacesGet200Response{value: val, isSet: true}
}
func (v NullableApiV1AdspacesGet200Response) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableApiV1AdspacesGet200Response) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
}