-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmodel__api_v1_adspaces_get_200_response_data_inner_site.go
More file actions
162 lines (131 loc) · 9.2 KB
/
Copy pathmodel__api_v1_adspaces_get_200_response_data_inner_site.go
File metadata and controls
162 lines (131 loc) · 9.2 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
/*
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 ApiV1AdspacesGet200ResponseDataInnerSite type satisfies the MappedNullable interface at compile time
var _ MappedNullable = &ApiV1AdspacesGet200ResponseDataInnerSite{}
// ApiV1AdspacesGet200ResponseDataInnerSite struct for ApiV1AdspacesGet200ResponseDataInnerSite
type ApiV1AdspacesGet200ResponseDataInnerSite struct {
Id *int32 `json:"id,omitempty"`
Name *string `json:"name,omitempty"`
}
// NewApiV1AdspacesGet200ResponseDataInnerSite instantiates a new ApiV1AdspacesGet200ResponseDataInnerSite 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 NewApiV1AdspacesGet200ResponseDataInnerSite() *ApiV1AdspacesGet200ResponseDataInnerSite {
this := ApiV1AdspacesGet200ResponseDataInnerSite{}
return &this
}
// NewApiV1AdspacesGet200ResponseDataInnerSiteWithDefaults instantiates a new ApiV1AdspacesGet200ResponseDataInnerSite 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 NewApiV1AdspacesGet200ResponseDataInnerSiteWithDefaults() *ApiV1AdspacesGet200ResponseDataInnerSite {
this := ApiV1AdspacesGet200ResponseDataInnerSite{}
return &this
}
// GetId returns the Id field value if set, zero value otherwise.
func (o *ApiV1AdspacesGet200ResponseDataInnerSite) 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 *ApiV1AdspacesGet200ResponseDataInnerSite) 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 *ApiV1AdspacesGet200ResponseDataInnerSite) 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 *ApiV1AdspacesGet200ResponseDataInnerSite) SetId(v int32) {
o.Id = &v
}
// GetName returns the Name field value if set, zero value otherwise.
func (o *ApiV1AdspacesGet200ResponseDataInnerSite) 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 *ApiV1AdspacesGet200ResponseDataInnerSite) 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 *ApiV1AdspacesGet200ResponseDataInnerSite) 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 *ApiV1AdspacesGet200ResponseDataInnerSite) SetName(v string) {
o.Name = &v
}
func (o ApiV1AdspacesGet200ResponseDataInnerSite) MarshalJSON() ([]byte, error) {
toSerialize,err := o.ToMap()
if err != nil {
return []byte{}, err
}
return json.Marshal(toSerialize)
}
func (o ApiV1AdspacesGet200ResponseDataInnerSite) 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
}
return toSerialize, nil
}
type NullableApiV1AdspacesGet200ResponseDataInnerSite struct {
value *ApiV1AdspacesGet200ResponseDataInnerSite
isSet bool
}
func (v NullableApiV1AdspacesGet200ResponseDataInnerSite) Get() *ApiV1AdspacesGet200ResponseDataInnerSite {
return v.value
}
func (v *NullableApiV1AdspacesGet200ResponseDataInnerSite) Set(val *ApiV1AdspacesGet200ResponseDataInnerSite) {
v.value = val
v.isSet = true
}
func (v NullableApiV1AdspacesGet200ResponseDataInnerSite) IsSet() bool {
return v.isSet
}
func (v *NullableApiV1AdspacesGet200ResponseDataInnerSite) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableApiV1AdspacesGet200ResponseDataInnerSite(val *ApiV1AdspacesGet200ResponseDataInnerSite) *NullableApiV1AdspacesGet200ResponseDataInnerSite {
return &NullableApiV1AdspacesGet200ResponseDataInnerSite{value: val, isSet: true}
}
func (v NullableApiV1AdspacesGet200ResponseDataInnerSite) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableApiV1AdspacesGet200ResponseDataInnerSite) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
}