-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmodel_api_key.go
More file actions
342 lines (282 loc) · 9.2 KB
/
Copy pathmodel_api_key.go
File metadata and controls
342 lines (282 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
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
/*
RankVectors API
Intelligent internal linking optimization API using AI. RankVectors helps you automatically discover and implement optimal internal links across your website to improve SEO performance and user experience. ## Key Features - **AI-Powered Analysis**: Uses OpenAI embeddings to find optimal linking opportunities - **Smart Crawling**: Automatically crawls and analyzes your website content - **Automated Implementation**: Implement links via webhooks or manual instructions - **Page-Based Plans**: Predictable pricing by number of pages monitored - **Multi-Platform Support**: Works with any CMS or platform via REST API ## Getting Started 1. Create a project with your website URL 2. Start a crawl to analyze your content 3. Generate AI-powered link suggestions 4. Implement suggestions via API or webhook 5. Track performance and manage page usage and limits ## Authentication Most API endpoints support authentication using your RankVectors API key. Include your API key in the `Authorization` header: ``` Authorization: Bearer YOUR_API_KEY ``` Get your API key from your RankVectors dashboard: Settings → API Keys **Note**: Some endpoints (marked in the documentation) support both API key authentication and web session authentication (Stack Auth). API key authentication is required for SDK usage and external integrations like WordPress plugins.
API version: 1.3.1
Contact: [email protected]
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package rankvectors
import (
"encoding/json"
"time"
"bytes"
"fmt"
)
// checks if the ApiKey type satisfies the MappedNullable interface at compile time
var _ MappedNullable = &ApiKey{}
// ApiKey struct for ApiKey
type ApiKey struct {
// API key identifier
Id string `json:"id"`
// API key name
Name string `json:"name"`
// Creation timestamp
CreatedAt time.Time `json:"createdAt"`
// Expiration timestamp
ExpiresAt NullableTime `json:"expiresAt,omitempty"`
// Whether the key is active
IsActive bool `json:"isActive"`
// Last usage timestamp
LastUsedAt NullableTime `json:"lastUsedAt,omitempty"`
}
type _ApiKey ApiKey
// NewApiKey instantiates a new ApiKey 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 NewApiKey(id string, name string, createdAt time.Time, isActive bool) *ApiKey {
this := ApiKey{}
this.Id = id
this.Name = name
this.CreatedAt = createdAt
this.IsActive = isActive
return &this
}
// NewApiKeyWithDefaults instantiates a new ApiKey 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 NewApiKeyWithDefaults() *ApiKey {
this := ApiKey{}
return &this
}
// GetId returns the Id field value
func (o *ApiKey) GetId() string {
if o == nil {
var ret string
return ret
}
return o.Id
}
// GetIdOk returns a tuple with the Id field value
// and a boolean to check if the value has been set.
func (o *ApiKey) GetIdOk() (*string, bool) {
if o == nil {
return nil, false
}
return &o.Id, true
}
// SetId sets field value
func (o *ApiKey) SetId(v string) {
o.Id = v
}
// GetName returns the Name field value
func (o *ApiKey) GetName() string {
if o == nil {
var ret string
return ret
}
return o.Name
}
// GetNameOk returns a tuple with the Name field value
// and a boolean to check if the value has been set.
func (o *ApiKey) GetNameOk() (*string, bool) {
if o == nil {
return nil, false
}
return &o.Name, true
}
// SetName sets field value
func (o *ApiKey) SetName(v string) {
o.Name = v
}
// GetCreatedAt returns the CreatedAt field value
func (o *ApiKey) GetCreatedAt() time.Time {
if o == nil {
var ret time.Time
return ret
}
return o.CreatedAt
}
// GetCreatedAtOk returns a tuple with the CreatedAt field value
// and a boolean to check if the value has been set.
func (o *ApiKey) GetCreatedAtOk() (*time.Time, bool) {
if o == nil {
return nil, false
}
return &o.CreatedAt, true
}
// SetCreatedAt sets field value
func (o *ApiKey) SetCreatedAt(v time.Time) {
o.CreatedAt = v
}
// GetExpiresAt returns the ExpiresAt field value if set, zero value otherwise (both if not set or set to explicit null).
func (o *ApiKey) GetExpiresAt() time.Time {
if o == nil || IsNil(o.ExpiresAt.Get()) {
var ret time.Time
return ret
}
return *o.ExpiresAt.Get()
}
// GetExpiresAtOk returns a tuple with the ExpiresAt field value if set, nil otherwise
// and a boolean to check if the value has been set.
// NOTE: If the value is an explicit nil, `nil, true` will be returned
func (o *ApiKey) GetExpiresAtOk() (*time.Time, bool) {
if o == nil {
return nil, false
}
return o.ExpiresAt.Get(), o.ExpiresAt.IsSet()
}
// HasExpiresAt returns a boolean if a field has been set.
func (o *ApiKey) HasExpiresAt() bool {
if o != nil && o.ExpiresAt.IsSet() {
return true
}
return false
}
// SetExpiresAt gets a reference to the given NullableTime and assigns it to the ExpiresAt field.
func (o *ApiKey) SetExpiresAt(v time.Time) {
o.ExpiresAt.Set(&v)
}
// SetExpiresAtNil sets the value for ExpiresAt to be an explicit nil
func (o *ApiKey) SetExpiresAtNil() {
o.ExpiresAt.Set(nil)
}
// UnsetExpiresAt ensures that no value is present for ExpiresAt, not even an explicit nil
func (o *ApiKey) UnsetExpiresAt() {
o.ExpiresAt.Unset()
}
// GetIsActive returns the IsActive field value
func (o *ApiKey) GetIsActive() bool {
if o == nil {
var ret bool
return ret
}
return o.IsActive
}
// GetIsActiveOk returns a tuple with the IsActive field value
// and a boolean to check if the value has been set.
func (o *ApiKey) GetIsActiveOk() (*bool, bool) {
if o == nil {
return nil, false
}
return &o.IsActive, true
}
// SetIsActive sets field value
func (o *ApiKey) SetIsActive(v bool) {
o.IsActive = v
}
// GetLastUsedAt returns the LastUsedAt field value if set, zero value otherwise (both if not set or set to explicit null).
func (o *ApiKey) GetLastUsedAt() time.Time {
if o == nil || IsNil(o.LastUsedAt.Get()) {
var ret time.Time
return ret
}
return *o.LastUsedAt.Get()
}
// GetLastUsedAtOk returns a tuple with the LastUsedAt field value if set, nil otherwise
// and a boolean to check if the value has been set.
// NOTE: If the value is an explicit nil, `nil, true` will be returned
func (o *ApiKey) GetLastUsedAtOk() (*time.Time, bool) {
if o == nil {
return nil, false
}
return o.LastUsedAt.Get(), o.LastUsedAt.IsSet()
}
// HasLastUsedAt returns a boolean if a field has been set.
func (o *ApiKey) HasLastUsedAt() bool {
if o != nil && o.LastUsedAt.IsSet() {
return true
}
return false
}
// SetLastUsedAt gets a reference to the given NullableTime and assigns it to the LastUsedAt field.
func (o *ApiKey) SetLastUsedAt(v time.Time) {
o.LastUsedAt.Set(&v)
}
// SetLastUsedAtNil sets the value for LastUsedAt to be an explicit nil
func (o *ApiKey) SetLastUsedAtNil() {
o.LastUsedAt.Set(nil)
}
// UnsetLastUsedAt ensures that no value is present for LastUsedAt, not even an explicit nil
func (o *ApiKey) UnsetLastUsedAt() {
o.LastUsedAt.Unset()
}
func (o ApiKey) MarshalJSON() ([]byte, error) {
toSerialize,err := o.ToMap()
if err != nil {
return []byte{}, err
}
return json.Marshal(toSerialize)
}
func (o ApiKey) ToMap() (map[string]interface{}, error) {
toSerialize := map[string]interface{}{}
toSerialize["id"] = o.Id
toSerialize["name"] = o.Name
toSerialize["createdAt"] = o.CreatedAt
if o.ExpiresAt.IsSet() {
toSerialize["expiresAt"] = o.ExpiresAt.Get()
}
toSerialize["isActive"] = o.IsActive
if o.LastUsedAt.IsSet() {
toSerialize["lastUsedAt"] = o.LastUsedAt.Get()
}
return toSerialize, nil
}
func (o *ApiKey) 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{
"id",
"name",
"createdAt",
"isActive",
}
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)
}
}
varApiKey := _ApiKey{}
decoder := json.NewDecoder(bytes.NewReader(data))
decoder.DisallowUnknownFields()
err = decoder.Decode(&varApiKey)
if err != nil {
return err
}
*o = ApiKey(varApiKey)
return err
}
type NullableApiKey struct {
value *ApiKey
isSet bool
}
func (v NullableApiKey) Get() *ApiKey {
return v.value
}
func (v *NullableApiKey) Set(val *ApiKey) {
v.value = val
v.isSet = true
}
func (v NullableApiKey) IsSet() bool {
return v.isSet
}
func (v *NullableApiKey) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableApiKey(val *ApiKey) *NullableApiKey {
return &NullableApiKey{value: val, isSet: true}
}
func (v NullableApiKey) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableApiKey) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
}