@api7/portal-sdk 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +53 -0
- package/dist/api_product.d.ts +26 -0
- package/dist/api_product.d.ts.map +1 -0
- package/dist/application.d.ts +55 -0
- package/dist/application.d.ts.map +1 -0
- package/dist/credential.d.ts +18 -0
- package/dist/credential.d.ts.map +1 -0
- package/dist/developer.d.ts +27 -0
- package/dist/developer.d.ts.map +1 -0
- package/dist/generated/client/client.gen.d.ts +3 -0
- package/dist/generated/client/client.gen.d.ts.map +1 -0
- package/dist/generated/client/index.d.ts +9 -0
- package/dist/generated/client/index.d.ts.map +1 -0
- package/dist/generated/client/types.gen.d.ts +89 -0
- package/dist/generated/client/types.gen.d.ts.map +1 -0
- package/dist/generated/client/utils.gen.d.ts +15 -0
- package/dist/generated/client/utils.gen.d.ts.map +1 -0
- package/dist/generated/client.gen.d.ts +13 -0
- package/dist/generated/client.gen.d.ts.map +1 -0
- package/dist/generated/core/auth.gen.d.ts +19 -0
- package/dist/generated/core/auth.gen.d.ts.map +1 -0
- package/dist/generated/core/bodySerializer.gen.d.ts +26 -0
- package/dist/generated/core/bodySerializer.gen.d.ts.map +1 -0
- package/dist/generated/core/params.gen.d.ts +44 -0
- package/dist/generated/core/params.gen.d.ts.map +1 -0
- package/dist/generated/core/pathSerializer.gen.d.ts +34 -0
- package/dist/generated/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/generated/core/queryKeySerializer.gen.d.ts +19 -0
- package/dist/generated/core/queryKeySerializer.gen.d.ts.map +1 -0
- package/dist/generated/core/serverSentEvents.gen.d.ts +72 -0
- package/dist/generated/core/serverSentEvents.gen.d.ts.map +1 -0
- package/dist/generated/core/types.gen.d.ts +79 -0
- package/dist/generated/core/types.gen.d.ts.map +1 -0
- package/dist/generated/core/utils.gen.d.ts +20 -0
- package/dist/generated/core/utils.gen.d.ts.map +1 -0
- package/dist/generated/index.d.ts +3 -0
- package/dist/generated/index.d.ts.map +1 -0
- package/dist/generated/sdk.gen.d.ts +124 -0
- package/dist/generated/sdk.gen.d.ts.map +1 -0
- package/dist/generated/transformers.gen.d.ts +16 -0
- package/dist/generated/transformers.gen.d.ts.map +1 -0
- package/dist/generated/types.gen.d.ts +2095 -0
- package/dist/generated/types.gen.d.ts.map +1 -0
- package/dist/index.cjs +7 -0
- package/dist/index.d.ts +19 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +1025 -0
- package/dist/miscellaneous.d.ts +34 -0
- package/dist/miscellaneous.d.ts.map +1 -0
- package/dist/subscription.d.ts +27 -0
- package/dist/subscription.d.ts.map +1 -0
- package/dist/utils.d.ts +35 -0
- package/dist/utils.d.ts.map +1 -0
- package/package.json +43 -0
|
@@ -0,0 +1,2095 @@
|
|
|
1
|
+
export type ClientOptions = {
|
|
2
|
+
baseURL: string;
|
|
3
|
+
};
|
|
4
|
+
/**
|
|
5
|
+
* The object ID.
|
|
6
|
+
*/
|
|
7
|
+
export type Id = string;
|
|
8
|
+
/**
|
|
9
|
+
* The object name.
|
|
10
|
+
*/
|
|
11
|
+
export type Name = string;
|
|
12
|
+
/**
|
|
13
|
+
* The object description.
|
|
14
|
+
*/
|
|
15
|
+
export type Description = string;
|
|
16
|
+
/**
|
|
17
|
+
* Total number of objects.
|
|
18
|
+
*/
|
|
19
|
+
export type Total = number;
|
|
20
|
+
/**
|
|
21
|
+
* Key-value pairs of labels.
|
|
22
|
+
*/
|
|
23
|
+
export type LabelsMap = {
|
|
24
|
+
[key: string]: string;
|
|
25
|
+
};
|
|
26
|
+
export type DateTime = Date;
|
|
27
|
+
export type ResourceBasics = {
|
|
28
|
+
id: Id;
|
|
29
|
+
created_at: DateTime;
|
|
30
|
+
updated_at: DateTime;
|
|
31
|
+
};
|
|
32
|
+
export declare const SubscriptionStatus: {
|
|
33
|
+
readonly UNSUBSCRIBED: "unsubscribed";
|
|
34
|
+
readonly WAIT_FOR_APPROVAL: "wait_for_approval";
|
|
35
|
+
readonly SUBSCRIBED: "subscribed";
|
|
36
|
+
};
|
|
37
|
+
export type SubscriptionStatus = typeof SubscriptionStatus[keyof typeof SubscriptionStatus];
|
|
38
|
+
/**
|
|
39
|
+
* The status of the developer.
|
|
40
|
+
* - pending: The user is pending approval.
|
|
41
|
+
* - active: The user had been approved.
|
|
42
|
+
*/
|
|
43
|
+
export declare const DeveloperStatus: {
|
|
44
|
+
readonly PENDING: "pending";
|
|
45
|
+
readonly ACTIVE: "active";
|
|
46
|
+
};
|
|
47
|
+
/**
|
|
48
|
+
* The status of the developer.
|
|
49
|
+
* - pending: The user is pending approval.
|
|
50
|
+
* - active: The user had been approved.
|
|
51
|
+
*/
|
|
52
|
+
export type DeveloperStatus = typeof DeveloperStatus[keyof typeof DeveloperStatus];
|
|
53
|
+
export type Developer = {
|
|
54
|
+
id: Id;
|
|
55
|
+
/**
|
|
56
|
+
* Developer name.
|
|
57
|
+
*/
|
|
58
|
+
name: string;
|
|
59
|
+
status: DeveloperStatus;
|
|
60
|
+
last_active_at?: DateTime;
|
|
61
|
+
created_at: DateTime;
|
|
62
|
+
updated_at: DateTime;
|
|
63
|
+
};
|
|
64
|
+
export type CreateDeveloperReq = {
|
|
65
|
+
developer_id: Id;
|
|
66
|
+
};
|
|
67
|
+
export type DcrProviderForDeveloper = {
|
|
68
|
+
id: Id;
|
|
69
|
+
/**
|
|
70
|
+
* The name of the Dynamic Client Registration (DCR) Provider.
|
|
71
|
+
*/
|
|
72
|
+
name: string;
|
|
73
|
+
/**
|
|
74
|
+
* The issuer URL of the Authorization Server.
|
|
75
|
+
*/
|
|
76
|
+
issuer: string;
|
|
77
|
+
};
|
|
78
|
+
/**
|
|
79
|
+
* The API product.
|
|
80
|
+
*/
|
|
81
|
+
export type ApiProduct = ({
|
|
82
|
+
type: 'gateway';
|
|
83
|
+
name: Name;
|
|
84
|
+
/**
|
|
85
|
+
* The base64-encoded logo image of the API product.
|
|
86
|
+
*/
|
|
87
|
+
logo?: string;
|
|
88
|
+
/**
|
|
89
|
+
* The description of the API product.
|
|
90
|
+
*/
|
|
91
|
+
desc?: string;
|
|
92
|
+
labels?: LabelsMap;
|
|
93
|
+
/**
|
|
94
|
+
* The authentication configuration of the API product.
|
|
95
|
+
*/
|
|
96
|
+
auth: {
|
|
97
|
+
/**
|
|
98
|
+
* Key authentication configurations.
|
|
99
|
+
*/
|
|
100
|
+
'key-auth'?: {
|
|
101
|
+
/**
|
|
102
|
+
* If true, do not pass the header or query string with key to upstream services.
|
|
103
|
+
*/
|
|
104
|
+
hide_credentials?: boolean;
|
|
105
|
+
/**
|
|
106
|
+
* The query string to get the key from. Lower priority than header.
|
|
107
|
+
*/
|
|
108
|
+
query?: string;
|
|
109
|
+
/**
|
|
110
|
+
* The header to get the key from.
|
|
111
|
+
*/
|
|
112
|
+
header?: string;
|
|
113
|
+
};
|
|
114
|
+
/**
|
|
115
|
+
* Basic authentication configurations.
|
|
116
|
+
*/
|
|
117
|
+
'basic-auth'?: {
|
|
118
|
+
/**
|
|
119
|
+
* If true, do not pass the header or query string with key to upstream services.
|
|
120
|
+
*/
|
|
121
|
+
hide_credentials?: boolean;
|
|
122
|
+
};
|
|
123
|
+
/**
|
|
124
|
+
* DCR authentication configurations.
|
|
125
|
+
*/
|
|
126
|
+
dcr?: {
|
|
127
|
+
dcr_provider_id: Id;
|
|
128
|
+
};
|
|
129
|
+
};
|
|
130
|
+
status: ApiProductStatus;
|
|
131
|
+
/**
|
|
132
|
+
* If true, the subscription is automatically approved.
|
|
133
|
+
*/
|
|
134
|
+
subscription_auto_approval: boolean;
|
|
135
|
+
/**
|
|
136
|
+
* If true, developers can view the unsubscribed API.
|
|
137
|
+
*/
|
|
138
|
+
can_view_unsubscribed: boolean;
|
|
139
|
+
visibility: Visibility;
|
|
140
|
+
/**
|
|
141
|
+
* An array of raw OpenAPI specifications. It is only returned when getting an API product.
|
|
142
|
+
*/
|
|
143
|
+
raw_openapis?: Array<string>;
|
|
144
|
+
} & ResourceBasics) | ({
|
|
145
|
+
/**
|
|
146
|
+
* Type of API product.
|
|
147
|
+
*/
|
|
148
|
+
type: 'external';
|
|
149
|
+
name: Name;
|
|
150
|
+
/**
|
|
151
|
+
* An array of raw OpenAPI specifications. It is only returned when getting an API product.
|
|
152
|
+
*/
|
|
153
|
+
raw_openapis?: Array<string>;
|
|
154
|
+
status: ApiProductStatus;
|
|
155
|
+
visibility: Visibility;
|
|
156
|
+
} & ({
|
|
157
|
+
/**
|
|
158
|
+
* The server URL. It should be configured if the server URL is not defined in the OpenAPI spec.
|
|
159
|
+
*
|
|
160
|
+
* @deprecated
|
|
161
|
+
*/
|
|
162
|
+
server_url: string;
|
|
163
|
+
} | {
|
|
164
|
+
/**
|
|
165
|
+
* The server URLs. It should be configured if the server URLs are not defined in the OpenAPI spec.
|
|
166
|
+
*/
|
|
167
|
+
server_urls: Array<string>;
|
|
168
|
+
}) & {
|
|
169
|
+
tags?: Array<string>;
|
|
170
|
+
/**
|
|
171
|
+
* Description.
|
|
172
|
+
*/
|
|
173
|
+
desc?: string;
|
|
174
|
+
/**
|
|
175
|
+
* API description.
|
|
176
|
+
*/
|
|
177
|
+
api_desc?: string;
|
|
178
|
+
/**
|
|
179
|
+
* API count.
|
|
180
|
+
*/
|
|
181
|
+
api_count?: number;
|
|
182
|
+
} & ResourceBasics);
|
|
183
|
+
/**
|
|
184
|
+
* The developer application response fields.
|
|
185
|
+
*/
|
|
186
|
+
export type DeveloperApplicationBasics = {
|
|
187
|
+
name: Name;
|
|
188
|
+
desc?: Description;
|
|
189
|
+
labels?: LabelsMap;
|
|
190
|
+
};
|
|
191
|
+
/**
|
|
192
|
+
* The developer application.
|
|
193
|
+
*/
|
|
194
|
+
export type DeveloperApplication = DeveloperApplicationBasics & ResourceBasics;
|
|
195
|
+
/**
|
|
196
|
+
* The developer application with subscription status.
|
|
197
|
+
*/
|
|
198
|
+
export type DeveloperApplicationWithSubscriptionStatus = {
|
|
199
|
+
subscription_status?: SubscriptionStatus;
|
|
200
|
+
} & DeveloperApplication;
|
|
201
|
+
/**
|
|
202
|
+
* Create an application request.
|
|
203
|
+
*/
|
|
204
|
+
export type CreateDeveloperApplicationReq = {
|
|
205
|
+
name?: Name;
|
|
206
|
+
desc?: Description;
|
|
207
|
+
labels?: LabelsMap;
|
|
208
|
+
};
|
|
209
|
+
export type ApplicationCredentialBasicsCommon = {
|
|
210
|
+
application_id: Id;
|
|
211
|
+
application_name: Name;
|
|
212
|
+
desc?: Description;
|
|
213
|
+
labels?: LabelsMap;
|
|
214
|
+
};
|
|
215
|
+
/**
|
|
216
|
+
* The developer credential response.
|
|
217
|
+
*/
|
|
218
|
+
export type ApplicationCredentialBasics = (ApplicationCredentialBasicsCommon & {
|
|
219
|
+
name: Name;
|
|
220
|
+
plugins: {
|
|
221
|
+
'key-auth': {
|
|
222
|
+
[key: string]: unknown;
|
|
223
|
+
};
|
|
224
|
+
};
|
|
225
|
+
}) | (ApplicationCredentialBasicsCommon & {
|
|
226
|
+
name: Name;
|
|
227
|
+
plugins: {
|
|
228
|
+
'basic-auth': {
|
|
229
|
+
[key: string]: unknown;
|
|
230
|
+
};
|
|
231
|
+
};
|
|
232
|
+
}) | (ApplicationCredentialBasicsCommon & {
|
|
233
|
+
oauth: {
|
|
234
|
+
/**
|
|
235
|
+
* The DCR provider ID.
|
|
236
|
+
*/
|
|
237
|
+
dcr_provider_id: string;
|
|
238
|
+
dcr_provider?: DcrProviderForDeveloper;
|
|
239
|
+
/**
|
|
240
|
+
* The client ID.
|
|
241
|
+
*/
|
|
242
|
+
client_id: string;
|
|
243
|
+
/**
|
|
244
|
+
* The client secret is only returned upon creation.
|
|
245
|
+
*/
|
|
246
|
+
client_secret?: string;
|
|
247
|
+
/**
|
|
248
|
+
* The redirect URIs.
|
|
249
|
+
*/
|
|
250
|
+
redirect_uris?: Array<string>;
|
|
251
|
+
};
|
|
252
|
+
});
|
|
253
|
+
/**
|
|
254
|
+
* The application credential.
|
|
255
|
+
*/
|
|
256
|
+
export type ApplicationCredential = ApplicationCredentialBasics & ResourceBasics;
|
|
257
|
+
export type CreateApplicationCredentialReqCommon = {
|
|
258
|
+
desc?: Description;
|
|
259
|
+
labels?: LabelsMap;
|
|
260
|
+
};
|
|
261
|
+
/**
|
|
262
|
+
* Create an application credential request.
|
|
263
|
+
*/
|
|
264
|
+
export type CreateApplicationCredentialReq = (CreateApplicationCredentialReqCommon & {
|
|
265
|
+
name: Name;
|
|
266
|
+
plugins: {
|
|
267
|
+
'key-auth': {} | null;
|
|
268
|
+
};
|
|
269
|
+
}) | (CreateApplicationCredentialReqCommon & {
|
|
270
|
+
name: Name;
|
|
271
|
+
plugins: {
|
|
272
|
+
'basic-auth': {
|
|
273
|
+
/**
|
|
274
|
+
* Username.
|
|
275
|
+
*/
|
|
276
|
+
username: string;
|
|
277
|
+
/**
|
|
278
|
+
* User password.
|
|
279
|
+
*/
|
|
280
|
+
password: string;
|
|
281
|
+
};
|
|
282
|
+
};
|
|
283
|
+
}) | (CreateApplicationCredentialReqCommon & {
|
|
284
|
+
oauth: {
|
|
285
|
+
/**
|
|
286
|
+
* The DCR provider ID.
|
|
287
|
+
*/
|
|
288
|
+
dcr_provider_id: string;
|
|
289
|
+
/**
|
|
290
|
+
* The redirect URIs.
|
|
291
|
+
*/
|
|
292
|
+
redirect_uris?: Array<string>;
|
|
293
|
+
};
|
|
294
|
+
});
|
|
295
|
+
/**
|
|
296
|
+
* Update an application credential request.
|
|
297
|
+
*/
|
|
298
|
+
export type UpdateApplicationCredentialReq = {
|
|
299
|
+
name: Name;
|
|
300
|
+
desc?: Description;
|
|
301
|
+
labels?: LabelsMap;
|
|
302
|
+
} | {
|
|
303
|
+
desc?: Description;
|
|
304
|
+
labels?: LabelsMap;
|
|
305
|
+
oauth: {
|
|
306
|
+
/**
|
|
307
|
+
* The redirect URIs.
|
|
308
|
+
*/
|
|
309
|
+
redirect_uris?: Array<string>;
|
|
310
|
+
};
|
|
311
|
+
};
|
|
312
|
+
/**
|
|
313
|
+
* Regenerate an application credential request.
|
|
314
|
+
*/
|
|
315
|
+
export type RegenerateApplicationCredentialReq = {
|
|
316
|
+
'key-auth'?: {
|
|
317
|
+
[key: string]: never;
|
|
318
|
+
} | null;
|
|
319
|
+
'basic-auth'?: {
|
|
320
|
+
/**
|
|
321
|
+
* Username.
|
|
322
|
+
*/
|
|
323
|
+
username: string;
|
|
324
|
+
/**
|
|
325
|
+
* User password.
|
|
326
|
+
*/
|
|
327
|
+
password: string;
|
|
328
|
+
};
|
|
329
|
+
};
|
|
330
|
+
export type Subscription = {
|
|
331
|
+
/**
|
|
332
|
+
* The ID of the subscription.
|
|
333
|
+
*/
|
|
334
|
+
id: string;
|
|
335
|
+
developer_id: string;
|
|
336
|
+
developer_name: string;
|
|
337
|
+
subscribed_at: DateTime;
|
|
338
|
+
application_id: Id;
|
|
339
|
+
application_name: Name;
|
|
340
|
+
api_product_id: Id;
|
|
341
|
+
api_product_name: Name;
|
|
342
|
+
status: SubscriptionStatus;
|
|
343
|
+
};
|
|
344
|
+
/**
|
|
345
|
+
* The request body for creating a subscription.
|
|
346
|
+
*/
|
|
347
|
+
export type CreateApiProductSubscriptionReq = {
|
|
348
|
+
application_id: Id;
|
|
349
|
+
};
|
|
350
|
+
/**
|
|
351
|
+
* The request body for creating subscriptions.
|
|
352
|
+
*/
|
|
353
|
+
export type CreateSubscriptionReq = {
|
|
354
|
+
applications: Array<Id>;
|
|
355
|
+
api_products: Array<Id>;
|
|
356
|
+
};
|
|
357
|
+
export type AllLabels = {
|
|
358
|
+
[key: string]: Array<string>;
|
|
359
|
+
};
|
|
360
|
+
export type PortalPublicAccess = {
|
|
361
|
+
/**
|
|
362
|
+
* If true, allow public access to the developer portal.
|
|
363
|
+
*/
|
|
364
|
+
portal_public_access: boolean;
|
|
365
|
+
};
|
|
366
|
+
export type SmtpServerSettingsStatus = {
|
|
367
|
+
/**
|
|
368
|
+
* Enable SMTP Server.
|
|
369
|
+
*/
|
|
370
|
+
enable: boolean;
|
|
371
|
+
};
|
|
372
|
+
export type ApiCall = {
|
|
373
|
+
api_product_id: Id;
|
|
374
|
+
api_product_name: Name;
|
|
375
|
+
hour_timestamp: DateTime;
|
|
376
|
+
/**
|
|
377
|
+
* The number of API calls.
|
|
378
|
+
*/
|
|
379
|
+
api_calls: number;
|
|
380
|
+
};
|
|
381
|
+
/**
|
|
382
|
+
* The API product with subscription status.
|
|
383
|
+
*/
|
|
384
|
+
export type ApiProductWithSubscriptionStatus = ApiProduct & {
|
|
385
|
+
subscription_status?: SubscriptionStatus;
|
|
386
|
+
};
|
|
387
|
+
/**
|
|
388
|
+
* The visibility of the API product in the API hub. `public` means the product is visible to all users and `logged_in` means the product is only visible to logged-in developers.
|
|
389
|
+
*/
|
|
390
|
+
export declare const Visibility: {
|
|
391
|
+
readonly PUBLIC: "public";
|
|
392
|
+
readonly LOGGED_IN: "logged_in";
|
|
393
|
+
};
|
|
394
|
+
/**
|
|
395
|
+
* The visibility of the API product in the API hub. `public` means the product is visible to all users and `logged_in` means the product is only visible to logged-in developers.
|
|
396
|
+
*/
|
|
397
|
+
export type Visibility = typeof Visibility[keyof typeof Visibility];
|
|
398
|
+
/**
|
|
399
|
+
* Status of the API product.
|
|
400
|
+
*/
|
|
401
|
+
export declare const ApiProductStatus: {
|
|
402
|
+
readonly DRAFT: "draft";
|
|
403
|
+
readonly PUBLISHED: "published";
|
|
404
|
+
};
|
|
405
|
+
/**
|
|
406
|
+
* Status of the API product.
|
|
407
|
+
*/
|
|
408
|
+
export type ApiProductStatus = typeof ApiProductStatus[keyof typeof ApiProductStatus];
|
|
409
|
+
/**
|
|
410
|
+
* Page number of the listed resources. Used together with `page_size`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.
|
|
411
|
+
*/
|
|
412
|
+
export type Page = bigint;
|
|
413
|
+
/**
|
|
414
|
+
* Number of resources listed per page. Used together with `page`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.
|
|
415
|
+
*/
|
|
416
|
+
export type PageSize = bigint;
|
|
417
|
+
/**
|
|
418
|
+
* Order to list the resources by. The sorting index follows the configuration of `order_by`.
|
|
419
|
+
*/
|
|
420
|
+
export declare const Direction: {
|
|
421
|
+
readonly ASC: "asc";
|
|
422
|
+
readonly DESC: "desc";
|
|
423
|
+
};
|
|
424
|
+
/**
|
|
425
|
+
* Order to list the resources by. The sorting index follows the configuration of `order_by`.
|
|
426
|
+
*/
|
|
427
|
+
export type Direction = typeof Direction[keyof typeof Direction];
|
|
428
|
+
/**
|
|
429
|
+
* Ascending or descending order to list the resources, by `created_at` or `updated_by` configured in `order_by`.
|
|
430
|
+
*/
|
|
431
|
+
export declare const OrderBy: {
|
|
432
|
+
readonly CREATED_AT: "created_at";
|
|
433
|
+
readonly UPDATED_AT: "updated_at";
|
|
434
|
+
};
|
|
435
|
+
/**
|
|
436
|
+
* Ascending or descending order to list the resources, by `created_at` or `updated_by` configured in `order_by`.
|
|
437
|
+
*/
|
|
438
|
+
export type OrderBy = typeof OrderBy[keyof typeof OrderBy];
|
|
439
|
+
/**
|
|
440
|
+
* Condition to search resources by.
|
|
441
|
+
*/
|
|
442
|
+
export type Search = string;
|
|
443
|
+
export declare const SubscriptionsOrderBy: {
|
|
444
|
+
readonly DEVELOPER_NAME: "developer_name";
|
|
445
|
+
readonly SUBSCRIBED_AT: "subscribed_at";
|
|
446
|
+
};
|
|
447
|
+
export type SubscriptionsOrderBy = typeof SubscriptionsOrderBy[keyof typeof SubscriptionsOrderBy];
|
|
448
|
+
export type ApplicationId = Id;
|
|
449
|
+
export type ApplicationIdInQuery = Id;
|
|
450
|
+
export type ApplicationsIds = Array<Id>;
|
|
451
|
+
/**
|
|
452
|
+
* The unique identifier of the developer credential.
|
|
453
|
+
*/
|
|
454
|
+
export type DeveloperCredentialId = Id;
|
|
455
|
+
/**
|
|
456
|
+
* The authentication method of the developer credential.
|
|
457
|
+
*/
|
|
458
|
+
export declare const AuthMethod: {
|
|
459
|
+
readonly KEY_AUTH: "key-auth";
|
|
460
|
+
readonly BASIC_AUTH: "basic-auth";
|
|
461
|
+
readonly OAUTH: "oauth";
|
|
462
|
+
};
|
|
463
|
+
/**
|
|
464
|
+
* The authentication method of the developer credential.
|
|
465
|
+
*/
|
|
466
|
+
export type AuthMethod = typeof AuthMethod[keyof typeof AuthMethod];
|
|
467
|
+
/**
|
|
468
|
+
* The plugin name of the developer credential, recommended to use `auth_method` instead.
|
|
469
|
+
*
|
|
470
|
+
* @deprecated
|
|
471
|
+
*/
|
|
472
|
+
export type DeveloperCredentialPluginName = Name;
|
|
473
|
+
/**
|
|
474
|
+
* Index to order credentials by.
|
|
475
|
+
*/
|
|
476
|
+
export declare const CredentialOrderBy: {
|
|
477
|
+
readonly CREATED_AT: "created_at";
|
|
478
|
+
readonly UPDATED_AT: "updated_at";
|
|
479
|
+
readonly NAME: "name";
|
|
480
|
+
};
|
|
481
|
+
/**
|
|
482
|
+
* Index to order credentials by.
|
|
483
|
+
*/
|
|
484
|
+
export type CredentialOrderBy = typeof CredentialOrderBy[keyof typeof CredentialOrderBy];
|
|
485
|
+
export type ApiProductSubscriptionStatus = SubscriptionStatus;
|
|
486
|
+
export type SubscriptionStatusInQuery = Array<SubscriptionStatus>;
|
|
487
|
+
/**
|
|
488
|
+
* Index to order developers by.
|
|
489
|
+
*/
|
|
490
|
+
export declare const DeveloperOrderBy: {
|
|
491
|
+
readonly LAST_ACTIVE_AT: "last_active_at";
|
|
492
|
+
readonly CREATED_AT: "created_at";
|
|
493
|
+
};
|
|
494
|
+
/**
|
|
495
|
+
* Index to order developers by.
|
|
496
|
+
*/
|
|
497
|
+
export type DeveloperOrderBy = typeof DeveloperOrderBy[keyof typeof DeveloperOrderBy];
|
|
498
|
+
/**
|
|
499
|
+
* Developer ID.
|
|
500
|
+
*/
|
|
501
|
+
export type DeveloperId = string;
|
|
502
|
+
export type StartAt = number;
|
|
503
|
+
export type EndAt = number;
|
|
504
|
+
/**
|
|
505
|
+
* The unique identifier of the API product.
|
|
506
|
+
*/
|
|
507
|
+
export type ApiProductId = Id;
|
|
508
|
+
/**
|
|
509
|
+
* The API product ID.
|
|
510
|
+
*/
|
|
511
|
+
export type ApiProductIdInQuery = Id;
|
|
512
|
+
/**
|
|
513
|
+
* The API product IDs.
|
|
514
|
+
*/
|
|
515
|
+
export type ApiProductIds = Array<Id>;
|
|
516
|
+
/**
|
|
517
|
+
* The unique identifier of the service in the API product.
|
|
518
|
+
*/
|
|
519
|
+
export type ApiProductServiceIdInQuery = Id;
|
|
520
|
+
export type SubscriptionId = Id;
|
|
521
|
+
export type CredentialIds = Array<Id>;
|
|
522
|
+
/**
|
|
523
|
+
* Label(s) to filter resources by. The format is `labels[key]=value` and should be URL-encoded.
|
|
524
|
+
*/
|
|
525
|
+
export type LabelsMapInQuery = string;
|
|
526
|
+
export declare const DeveloperPortalLabelResourceType: {
|
|
527
|
+
readonly DEVELOPER_CREDENTIAL: "developer_credential";
|
|
528
|
+
readonly DEVELOPER_APPLICATION: "developer_application";
|
|
529
|
+
readonly API_PRODUCT: "api_product";
|
|
530
|
+
};
|
|
531
|
+
export type DeveloperPortalLabelResourceType = typeof DeveloperPortalLabelResourceType[keyof typeof DeveloperPortalLabelResourceType];
|
|
532
|
+
export type ListDevelopersData = {
|
|
533
|
+
body?: never;
|
|
534
|
+
path?: never;
|
|
535
|
+
query?: {
|
|
536
|
+
/**
|
|
537
|
+
* Page number of the listed resources. Used together with `page_size`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.
|
|
538
|
+
*/
|
|
539
|
+
page?: bigint;
|
|
540
|
+
/**
|
|
541
|
+
* Number of resources listed per page. Used together with `page`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.
|
|
542
|
+
*/
|
|
543
|
+
page_size?: bigint;
|
|
544
|
+
/**
|
|
545
|
+
* Order to list the resources by. The sorting index follows the configuration of `order_by`.
|
|
546
|
+
*/
|
|
547
|
+
direction?: 'asc' | 'desc';
|
|
548
|
+
/**
|
|
549
|
+
* Index to order developers by.
|
|
550
|
+
*/
|
|
551
|
+
order_by?: 'last_active_at' | 'created_at';
|
|
552
|
+
/**
|
|
553
|
+
* Condition to search resources by.
|
|
554
|
+
*/
|
|
555
|
+
search?: string;
|
|
556
|
+
};
|
|
557
|
+
url: '/api/developers';
|
|
558
|
+
};
|
|
559
|
+
export type ListDevelopersErrors = {
|
|
560
|
+
/**
|
|
561
|
+
* Bad request.
|
|
562
|
+
*/
|
|
563
|
+
400: {
|
|
564
|
+
/**
|
|
565
|
+
* The HTTP status code of the error response.
|
|
566
|
+
*/
|
|
567
|
+
status: number;
|
|
568
|
+
/**
|
|
569
|
+
* The error message.
|
|
570
|
+
*/
|
|
571
|
+
message: string;
|
|
572
|
+
};
|
|
573
|
+
/**
|
|
574
|
+
* Unauthorized.
|
|
575
|
+
*/
|
|
576
|
+
401: {
|
|
577
|
+
/**
|
|
578
|
+
* The HTTP status code of the error response.
|
|
579
|
+
*/
|
|
580
|
+
status: number;
|
|
581
|
+
/**
|
|
582
|
+
* The error message.
|
|
583
|
+
*/
|
|
584
|
+
message: string;
|
|
585
|
+
};
|
|
586
|
+
/**
|
|
587
|
+
* Internal server error.
|
|
588
|
+
*/
|
|
589
|
+
500: unknown;
|
|
590
|
+
};
|
|
591
|
+
export type ListDevelopersError = ListDevelopersErrors[keyof ListDevelopersErrors];
|
|
592
|
+
export type ListDevelopersResponses = {
|
|
593
|
+
200: {
|
|
594
|
+
/**
|
|
595
|
+
* An array of developers.
|
|
596
|
+
*/
|
|
597
|
+
list: Array<Developer>;
|
|
598
|
+
total: Total;
|
|
599
|
+
};
|
|
600
|
+
};
|
|
601
|
+
export type ListDevelopersResponse = ListDevelopersResponses[keyof ListDevelopersResponses];
|
|
602
|
+
export type CreateDeveloperData = {
|
|
603
|
+
body?: CreateDeveloperReq;
|
|
604
|
+
path?: never;
|
|
605
|
+
query?: never;
|
|
606
|
+
url: '/api/developers';
|
|
607
|
+
};
|
|
608
|
+
export type CreateDeveloperErrors = {
|
|
609
|
+
/**
|
|
610
|
+
* Bad request.
|
|
611
|
+
*/
|
|
612
|
+
400: {
|
|
613
|
+
/**
|
|
614
|
+
* The HTTP status code of the error response.
|
|
615
|
+
*/
|
|
616
|
+
status: number;
|
|
617
|
+
/**
|
|
618
|
+
* The error message.
|
|
619
|
+
*/
|
|
620
|
+
message: string;
|
|
621
|
+
};
|
|
622
|
+
/**
|
|
623
|
+
* Unauthorized.
|
|
624
|
+
*/
|
|
625
|
+
401: {
|
|
626
|
+
/**
|
|
627
|
+
* The HTTP status code of the error response.
|
|
628
|
+
*/
|
|
629
|
+
status: number;
|
|
630
|
+
/**
|
|
631
|
+
* The error message.
|
|
632
|
+
*/
|
|
633
|
+
message: string;
|
|
634
|
+
};
|
|
635
|
+
/**
|
|
636
|
+
* Internal server error.
|
|
637
|
+
*/
|
|
638
|
+
500: unknown;
|
|
639
|
+
};
|
|
640
|
+
export type CreateDeveloperError = CreateDeveloperErrors[keyof CreateDeveloperErrors];
|
|
641
|
+
export type CreateDeveloperResponses = {
|
|
642
|
+
201: Developer;
|
|
643
|
+
};
|
|
644
|
+
export type CreateDeveloperResponse = CreateDeveloperResponses[keyof CreateDeveloperResponses];
|
|
645
|
+
export type DeleteDeveloperData = {
|
|
646
|
+
body?: never;
|
|
647
|
+
path: {
|
|
648
|
+
/**
|
|
649
|
+
* Developer ID.
|
|
650
|
+
*/
|
|
651
|
+
developer_id: string;
|
|
652
|
+
};
|
|
653
|
+
query?: never;
|
|
654
|
+
url: '/api/developers/{developer_id}';
|
|
655
|
+
};
|
|
656
|
+
export type DeleteDeveloperErrors = {
|
|
657
|
+
/**
|
|
658
|
+
* Bad request.
|
|
659
|
+
*/
|
|
660
|
+
400: {
|
|
661
|
+
/**
|
|
662
|
+
* The HTTP status code of the error response.
|
|
663
|
+
*/
|
|
664
|
+
status: number;
|
|
665
|
+
/**
|
|
666
|
+
* The error message.
|
|
667
|
+
*/
|
|
668
|
+
message: string;
|
|
669
|
+
};
|
|
670
|
+
/**
|
|
671
|
+
* Unauthorized.
|
|
672
|
+
*/
|
|
673
|
+
401: {
|
|
674
|
+
/**
|
|
675
|
+
* The HTTP status code of the error response.
|
|
676
|
+
*/
|
|
677
|
+
status: number;
|
|
678
|
+
/**
|
|
679
|
+
* The error message.
|
|
680
|
+
*/
|
|
681
|
+
message: string;
|
|
682
|
+
};
|
|
683
|
+
/**
|
|
684
|
+
* Resource not found.
|
|
685
|
+
*/
|
|
686
|
+
404: {
|
|
687
|
+
/**
|
|
688
|
+
* The HTTP status code of the error response.
|
|
689
|
+
*/
|
|
690
|
+
status: number;
|
|
691
|
+
/**
|
|
692
|
+
* The error message.
|
|
693
|
+
*/
|
|
694
|
+
message: string;
|
|
695
|
+
};
|
|
696
|
+
/**
|
|
697
|
+
* Internal server error.
|
|
698
|
+
*/
|
|
699
|
+
500: unknown;
|
|
700
|
+
};
|
|
701
|
+
export type DeleteDeveloperError = DeleteDeveloperErrors[keyof DeleteDeveloperErrors];
|
|
702
|
+
export type DeleteDeveloperResponses = {
|
|
703
|
+
/**
|
|
704
|
+
* The resource was deleted successfully.
|
|
705
|
+
*/
|
|
706
|
+
204: void;
|
|
707
|
+
};
|
|
708
|
+
export type DeleteDeveloperResponse = DeleteDeveloperResponses[keyof DeleteDeveloperResponses];
|
|
709
|
+
export type ListApiProductsData = {
|
|
710
|
+
body?: never;
|
|
711
|
+
path?: never;
|
|
712
|
+
query?: {
|
|
713
|
+
/**
|
|
714
|
+
* Page number of the listed resources. Used together with `page_size`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.
|
|
715
|
+
*/
|
|
716
|
+
page?: bigint;
|
|
717
|
+
/**
|
|
718
|
+
* Number of resources listed per page. Used together with `page`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.
|
|
719
|
+
*/
|
|
720
|
+
page_size?: bigint;
|
|
721
|
+
/**
|
|
722
|
+
* Order to list the resources by. The sorting index follows the configuration of `order_by`.
|
|
723
|
+
*/
|
|
724
|
+
direction?: 'asc' | 'desc';
|
|
725
|
+
/**
|
|
726
|
+
* Ascending or descending order to list the resources, by `created_at` or `updated_by` configured in `order_by`.
|
|
727
|
+
*/
|
|
728
|
+
order_by?: 'created_at' | 'updated_at';
|
|
729
|
+
/**
|
|
730
|
+
* Condition to search resources by.
|
|
731
|
+
*/
|
|
732
|
+
search?: string;
|
|
733
|
+
subscription_status?: SubscriptionStatus;
|
|
734
|
+
application_id?: Id;
|
|
735
|
+
};
|
|
736
|
+
url: '/api/api_products';
|
|
737
|
+
};
|
|
738
|
+
export type ListApiProductsErrors = {
|
|
739
|
+
/**
|
|
740
|
+
* Bad request.
|
|
741
|
+
*/
|
|
742
|
+
400: {
|
|
743
|
+
/**
|
|
744
|
+
* The HTTP status code of the error response.
|
|
745
|
+
*/
|
|
746
|
+
status: number;
|
|
747
|
+
/**
|
|
748
|
+
* The error message.
|
|
749
|
+
*/
|
|
750
|
+
message: string;
|
|
751
|
+
};
|
|
752
|
+
/**
|
|
753
|
+
* Unauthorized.
|
|
754
|
+
*/
|
|
755
|
+
401: {
|
|
756
|
+
/**
|
|
757
|
+
* The HTTP status code of the error response.
|
|
758
|
+
*/
|
|
759
|
+
status: number;
|
|
760
|
+
/**
|
|
761
|
+
* The error message.
|
|
762
|
+
*/
|
|
763
|
+
message: string;
|
|
764
|
+
};
|
|
765
|
+
/**
|
|
766
|
+
* Internal server error.
|
|
767
|
+
*/
|
|
768
|
+
500: unknown;
|
|
769
|
+
};
|
|
770
|
+
export type ListApiProductsError = ListApiProductsErrors[keyof ListApiProductsErrors];
|
|
771
|
+
export type ListApiProductsResponses = {
|
|
772
|
+
200: {
|
|
773
|
+
/**
|
|
774
|
+
* An array of API products.
|
|
775
|
+
*/
|
|
776
|
+
list: Array<ApiProductWithSubscriptionStatus>;
|
|
777
|
+
total: Total;
|
|
778
|
+
};
|
|
779
|
+
};
|
|
780
|
+
export type ListApiProductsResponse = ListApiProductsResponses[keyof ListApiProductsResponses];
|
|
781
|
+
export type GetApiProductData = {
|
|
782
|
+
body?: never;
|
|
783
|
+
path: {
|
|
784
|
+
/**
|
|
785
|
+
* The unique identifier of the API product.
|
|
786
|
+
*/
|
|
787
|
+
api_product_id: Id;
|
|
788
|
+
};
|
|
789
|
+
query?: never;
|
|
790
|
+
url: '/api/api_products/{api_product_id}';
|
|
791
|
+
};
|
|
792
|
+
export type GetApiProductErrors = {
|
|
793
|
+
/**
|
|
794
|
+
* Bad request.
|
|
795
|
+
*/
|
|
796
|
+
400: {
|
|
797
|
+
/**
|
|
798
|
+
* The HTTP status code of the error response.
|
|
799
|
+
*/
|
|
800
|
+
status: number;
|
|
801
|
+
/**
|
|
802
|
+
* The error message.
|
|
803
|
+
*/
|
|
804
|
+
message: string;
|
|
805
|
+
};
|
|
806
|
+
/**
|
|
807
|
+
* Unauthorized.
|
|
808
|
+
*/
|
|
809
|
+
401: {
|
|
810
|
+
/**
|
|
811
|
+
* The HTTP status code of the error response.
|
|
812
|
+
*/
|
|
813
|
+
status: number;
|
|
814
|
+
/**
|
|
815
|
+
* The error message.
|
|
816
|
+
*/
|
|
817
|
+
message: string;
|
|
818
|
+
};
|
|
819
|
+
/**
|
|
820
|
+
* Resource not found.
|
|
821
|
+
*/
|
|
822
|
+
404: {
|
|
823
|
+
/**
|
|
824
|
+
* The HTTP status code of the error response.
|
|
825
|
+
*/
|
|
826
|
+
status: number;
|
|
827
|
+
/**
|
|
828
|
+
* The error message.
|
|
829
|
+
*/
|
|
830
|
+
message: string;
|
|
831
|
+
};
|
|
832
|
+
/**
|
|
833
|
+
* Internal server error.
|
|
834
|
+
*/
|
|
835
|
+
500: unknown;
|
|
836
|
+
};
|
|
837
|
+
export type GetApiProductError = GetApiProductErrors[keyof GetApiProductErrors];
|
|
838
|
+
export type GetApiProductResponses = {
|
|
839
|
+
200: ApiProductWithSubscriptionStatus;
|
|
840
|
+
};
|
|
841
|
+
export type GetApiProductResponse = GetApiProductResponses[keyof GetApiProductResponses];
|
|
842
|
+
export type CreateApiProductSubscriptionData = {
|
|
843
|
+
body?: CreateApiProductSubscriptionReq;
|
|
844
|
+
path: {
|
|
845
|
+
/**
|
|
846
|
+
* The unique identifier of the API product.
|
|
847
|
+
*/
|
|
848
|
+
api_product_id: Id;
|
|
849
|
+
};
|
|
850
|
+
query?: never;
|
|
851
|
+
url: '/api/api_products/{api_product_id}/subscriptions';
|
|
852
|
+
};
|
|
853
|
+
export type CreateApiProductSubscriptionErrors = {
|
|
854
|
+
/**
|
|
855
|
+
* Bad request.
|
|
856
|
+
*/
|
|
857
|
+
400: {
|
|
858
|
+
/**
|
|
859
|
+
* The HTTP status code of the error response.
|
|
860
|
+
*/
|
|
861
|
+
status: number;
|
|
862
|
+
/**
|
|
863
|
+
* The error message.
|
|
864
|
+
*/
|
|
865
|
+
message: string;
|
|
866
|
+
};
|
|
867
|
+
/**
|
|
868
|
+
* Unauthorized.
|
|
869
|
+
*/
|
|
870
|
+
401: {
|
|
871
|
+
/**
|
|
872
|
+
* The HTTP status code of the error response.
|
|
873
|
+
*/
|
|
874
|
+
status: number;
|
|
875
|
+
/**
|
|
876
|
+
* The error message.
|
|
877
|
+
*/
|
|
878
|
+
message: string;
|
|
879
|
+
};
|
|
880
|
+
/**
|
|
881
|
+
* Internal server error.
|
|
882
|
+
*/
|
|
883
|
+
500: unknown;
|
|
884
|
+
};
|
|
885
|
+
export type CreateApiProductSubscriptionError = CreateApiProductSubscriptionErrors[keyof CreateApiProductSubscriptionErrors];
|
|
886
|
+
export type CreateApiProductSubscriptionResponses = {
|
|
887
|
+
/**
|
|
888
|
+
* The resource was created successfully.
|
|
889
|
+
*/
|
|
890
|
+
201: unknown;
|
|
891
|
+
};
|
|
892
|
+
export type ListSubscriptionsData = {
|
|
893
|
+
body?: never;
|
|
894
|
+
path?: never;
|
|
895
|
+
query?: {
|
|
896
|
+
/**
|
|
897
|
+
* The API product ID.
|
|
898
|
+
*/
|
|
899
|
+
api_product_id?: Id;
|
|
900
|
+
application_id?: Id;
|
|
901
|
+
status?: Array<SubscriptionStatus>;
|
|
902
|
+
/**
|
|
903
|
+
* Condition to search resources by.
|
|
904
|
+
*/
|
|
905
|
+
search?: string;
|
|
906
|
+
order_by?: 'developer_name' | 'subscribed_at';
|
|
907
|
+
/**
|
|
908
|
+
* Page number of the listed resources. Used together with `page_size`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.
|
|
909
|
+
*/
|
|
910
|
+
page?: bigint;
|
|
911
|
+
/**
|
|
912
|
+
* Number of resources listed per page. Used together with `page`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.
|
|
913
|
+
*/
|
|
914
|
+
page_size?: bigint;
|
|
915
|
+
/**
|
|
916
|
+
* Order to list the resources by. The sorting index follows the configuration of `order_by`.
|
|
917
|
+
*/
|
|
918
|
+
direction?: 'asc' | 'desc';
|
|
919
|
+
};
|
|
920
|
+
url: '/api/subscriptions';
|
|
921
|
+
};
|
|
922
|
+
export type ListSubscriptionsErrors = {
|
|
923
|
+
/**
|
|
924
|
+
* Bad request.
|
|
925
|
+
*/
|
|
926
|
+
400: {
|
|
927
|
+
/**
|
|
928
|
+
* The HTTP status code of the error response.
|
|
929
|
+
*/
|
|
930
|
+
status: number;
|
|
931
|
+
/**
|
|
932
|
+
* The error message.
|
|
933
|
+
*/
|
|
934
|
+
message: string;
|
|
935
|
+
};
|
|
936
|
+
/**
|
|
937
|
+
* Unauthorized.
|
|
938
|
+
*/
|
|
939
|
+
401: {
|
|
940
|
+
/**
|
|
941
|
+
* The HTTP status code of the error response.
|
|
942
|
+
*/
|
|
943
|
+
status: number;
|
|
944
|
+
/**
|
|
945
|
+
* The error message.
|
|
946
|
+
*/
|
|
947
|
+
message: string;
|
|
948
|
+
};
|
|
949
|
+
/**
|
|
950
|
+
* Internal server error.
|
|
951
|
+
*/
|
|
952
|
+
500: unknown;
|
|
953
|
+
};
|
|
954
|
+
export type ListSubscriptionsError = ListSubscriptionsErrors[keyof ListSubscriptionsErrors];
|
|
955
|
+
export type ListSubscriptionsResponses = {
|
|
956
|
+
200: {
|
|
957
|
+
/**
|
|
958
|
+
* An array of subscriptions.
|
|
959
|
+
*/
|
|
960
|
+
list: Array<Subscription>;
|
|
961
|
+
total: Total;
|
|
962
|
+
};
|
|
963
|
+
};
|
|
964
|
+
export type ListSubscriptionsResponse = ListSubscriptionsResponses[keyof ListSubscriptionsResponses];
|
|
965
|
+
export type CreateSubscriptionData = {
|
|
966
|
+
body?: CreateSubscriptionReq;
|
|
967
|
+
path?: never;
|
|
968
|
+
query?: never;
|
|
969
|
+
url: '/api/subscriptions';
|
|
970
|
+
};
|
|
971
|
+
export type CreateSubscriptionErrors = {
|
|
972
|
+
/**
|
|
973
|
+
* Bad request.
|
|
974
|
+
*/
|
|
975
|
+
400: {
|
|
976
|
+
/**
|
|
977
|
+
* The HTTP status code of the error response.
|
|
978
|
+
*/
|
|
979
|
+
status: number;
|
|
980
|
+
/**
|
|
981
|
+
* The error message.
|
|
982
|
+
*/
|
|
983
|
+
message: string;
|
|
984
|
+
};
|
|
985
|
+
/**
|
|
986
|
+
* Unauthorized.
|
|
987
|
+
*/
|
|
988
|
+
401: {
|
|
989
|
+
/**
|
|
990
|
+
* The HTTP status code of the error response.
|
|
991
|
+
*/
|
|
992
|
+
status: number;
|
|
993
|
+
/**
|
|
994
|
+
* The error message.
|
|
995
|
+
*/
|
|
996
|
+
message: string;
|
|
997
|
+
};
|
|
998
|
+
/**
|
|
999
|
+
* Internal server error.
|
|
1000
|
+
*/
|
|
1001
|
+
500: unknown;
|
|
1002
|
+
};
|
|
1003
|
+
export type CreateSubscriptionError = CreateSubscriptionErrors[keyof CreateSubscriptionErrors];
|
|
1004
|
+
export type CreateSubscriptionResponses = {
|
|
1005
|
+
/**
|
|
1006
|
+
* The resource was created successfully.
|
|
1007
|
+
*/
|
|
1008
|
+
201: unknown;
|
|
1009
|
+
};
|
|
1010
|
+
export type DeleteSubscriptionData = {
|
|
1011
|
+
body?: never;
|
|
1012
|
+
path: {
|
|
1013
|
+
subscription_id: Id;
|
|
1014
|
+
};
|
|
1015
|
+
query?: never;
|
|
1016
|
+
url: '/api/subscriptions/{subscription_id}';
|
|
1017
|
+
};
|
|
1018
|
+
export type DeleteSubscriptionErrors = {
|
|
1019
|
+
/**
|
|
1020
|
+
* Bad request.
|
|
1021
|
+
*/
|
|
1022
|
+
400: {
|
|
1023
|
+
/**
|
|
1024
|
+
* The HTTP status code of the error response.
|
|
1025
|
+
*/
|
|
1026
|
+
status: number;
|
|
1027
|
+
/**
|
|
1028
|
+
* The error message.
|
|
1029
|
+
*/
|
|
1030
|
+
message: string;
|
|
1031
|
+
};
|
|
1032
|
+
/**
|
|
1033
|
+
* Unauthorized.
|
|
1034
|
+
*/
|
|
1035
|
+
401: {
|
|
1036
|
+
/**
|
|
1037
|
+
* The HTTP status code of the error response.
|
|
1038
|
+
*/
|
|
1039
|
+
status: number;
|
|
1040
|
+
/**
|
|
1041
|
+
* The error message.
|
|
1042
|
+
*/
|
|
1043
|
+
message: string;
|
|
1044
|
+
};
|
|
1045
|
+
/**
|
|
1046
|
+
* Resource not found.
|
|
1047
|
+
*/
|
|
1048
|
+
404: {
|
|
1049
|
+
/**
|
|
1050
|
+
* The HTTP status code of the error response.
|
|
1051
|
+
*/
|
|
1052
|
+
status: number;
|
|
1053
|
+
/**
|
|
1054
|
+
* The error message.
|
|
1055
|
+
*/
|
|
1056
|
+
message: string;
|
|
1057
|
+
};
|
|
1058
|
+
/**
|
|
1059
|
+
* Internal server error.
|
|
1060
|
+
*/
|
|
1061
|
+
500: unknown;
|
|
1062
|
+
};
|
|
1063
|
+
export type DeleteSubscriptionError = DeleteSubscriptionErrors[keyof DeleteSubscriptionErrors];
|
|
1064
|
+
export type DeleteSubscriptionResponses = {
|
|
1065
|
+
/**
|
|
1066
|
+
* The resource was deleted successfully.
|
|
1067
|
+
*/
|
|
1068
|
+
204: void;
|
|
1069
|
+
};
|
|
1070
|
+
export type DeleteSubscriptionResponse = DeleteSubscriptionResponses[keyof DeleteSubscriptionResponses];
|
|
1071
|
+
export type ListDeveloperApplicationsData = {
|
|
1072
|
+
body?: never;
|
|
1073
|
+
path?: never;
|
|
1074
|
+
query?: {
|
|
1075
|
+
/**
|
|
1076
|
+
* The API product ID.
|
|
1077
|
+
*/
|
|
1078
|
+
api_product_id?: Id;
|
|
1079
|
+
/**
|
|
1080
|
+
* Condition to search resources by.
|
|
1081
|
+
*/
|
|
1082
|
+
search?: string;
|
|
1083
|
+
/**
|
|
1084
|
+
* Label(s) to filter resources by. The format is `labels[key]=value` and should be URL-encoded.
|
|
1085
|
+
*/
|
|
1086
|
+
labels?: string;
|
|
1087
|
+
/**
|
|
1088
|
+
* Ascending or descending order to list the resources, by `created_at` or `updated_by` configured in `order_by`.
|
|
1089
|
+
*/
|
|
1090
|
+
order_by?: 'created_at' | 'updated_at';
|
|
1091
|
+
/**
|
|
1092
|
+
* Page number of the listed resources. Used together with `page_size`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.
|
|
1093
|
+
*/
|
|
1094
|
+
page?: bigint;
|
|
1095
|
+
/**
|
|
1096
|
+
* Number of resources listed per page. Used together with `page`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.
|
|
1097
|
+
*/
|
|
1098
|
+
page_size?: bigint;
|
|
1099
|
+
/**
|
|
1100
|
+
* Order to list the resources by. The sorting index follows the configuration of `order_by`.
|
|
1101
|
+
*/
|
|
1102
|
+
direction?: 'asc' | 'desc';
|
|
1103
|
+
};
|
|
1104
|
+
url: '/api/applications';
|
|
1105
|
+
};
|
|
1106
|
+
export type ListDeveloperApplicationsErrors = {
|
|
1107
|
+
/**
|
|
1108
|
+
* Bad request.
|
|
1109
|
+
*/
|
|
1110
|
+
400: {
|
|
1111
|
+
/**
|
|
1112
|
+
* The HTTP status code of the error response.
|
|
1113
|
+
*/
|
|
1114
|
+
status: number;
|
|
1115
|
+
/**
|
|
1116
|
+
* The error message.
|
|
1117
|
+
*/
|
|
1118
|
+
message: string;
|
|
1119
|
+
};
|
|
1120
|
+
/**
|
|
1121
|
+
* Unauthorized.
|
|
1122
|
+
*/
|
|
1123
|
+
401: {
|
|
1124
|
+
/**
|
|
1125
|
+
* The HTTP status code of the error response.
|
|
1126
|
+
*/
|
|
1127
|
+
status: number;
|
|
1128
|
+
/**
|
|
1129
|
+
* The error message.
|
|
1130
|
+
*/
|
|
1131
|
+
message: string;
|
|
1132
|
+
};
|
|
1133
|
+
/**
|
|
1134
|
+
* Internal server error.
|
|
1135
|
+
*/
|
|
1136
|
+
500: unknown;
|
|
1137
|
+
};
|
|
1138
|
+
export type ListDeveloperApplicationsError = ListDeveloperApplicationsErrors[keyof ListDeveloperApplicationsErrors];
|
|
1139
|
+
export type ListDeveloperApplicationsResponses = {
|
|
1140
|
+
200: {
|
|
1141
|
+
/**
|
|
1142
|
+
* An array of developer applications.
|
|
1143
|
+
*/
|
|
1144
|
+
list: Array<DeveloperApplicationWithSubscriptionStatus>;
|
|
1145
|
+
total: Total;
|
|
1146
|
+
};
|
|
1147
|
+
};
|
|
1148
|
+
export type ListDeveloperApplicationsResponse = ListDeveloperApplicationsResponses[keyof ListDeveloperApplicationsResponses];
|
|
1149
|
+
export type CreateDeveloperApplicationData = {
|
|
1150
|
+
body?: CreateDeveloperApplicationReq;
|
|
1151
|
+
path?: never;
|
|
1152
|
+
query?: never;
|
|
1153
|
+
url: '/api/applications';
|
|
1154
|
+
};
|
|
1155
|
+
export type CreateDeveloperApplicationErrors = {
|
|
1156
|
+
/**
|
|
1157
|
+
* Bad request.
|
|
1158
|
+
*/
|
|
1159
|
+
400: {
|
|
1160
|
+
/**
|
|
1161
|
+
* The HTTP status code of the error response.
|
|
1162
|
+
*/
|
|
1163
|
+
status: number;
|
|
1164
|
+
/**
|
|
1165
|
+
* The error message.
|
|
1166
|
+
*/
|
|
1167
|
+
message: string;
|
|
1168
|
+
};
|
|
1169
|
+
/**
|
|
1170
|
+
* Unauthorized.
|
|
1171
|
+
*/
|
|
1172
|
+
401: {
|
|
1173
|
+
/**
|
|
1174
|
+
* The HTTP status code of the error response.
|
|
1175
|
+
*/
|
|
1176
|
+
status: number;
|
|
1177
|
+
/**
|
|
1178
|
+
* The error message.
|
|
1179
|
+
*/
|
|
1180
|
+
message: string;
|
|
1181
|
+
};
|
|
1182
|
+
/**
|
|
1183
|
+
* Internal server error.
|
|
1184
|
+
*/
|
|
1185
|
+
500: unknown;
|
|
1186
|
+
};
|
|
1187
|
+
export type CreateDeveloperApplicationError = CreateDeveloperApplicationErrors[keyof CreateDeveloperApplicationErrors];
|
|
1188
|
+
export type CreateDeveloperApplicationResponses = {
|
|
1189
|
+
201: DeveloperApplication;
|
|
1190
|
+
};
|
|
1191
|
+
export type CreateDeveloperApplicationResponse = CreateDeveloperApplicationResponses[keyof CreateDeveloperApplicationResponses];
|
|
1192
|
+
export type DeleteDeveloperApplicationData = {
|
|
1193
|
+
body?: never;
|
|
1194
|
+
path: {
|
|
1195
|
+
application_id: Id;
|
|
1196
|
+
};
|
|
1197
|
+
query?: never;
|
|
1198
|
+
url: '/api/applications/{application_id}';
|
|
1199
|
+
};
|
|
1200
|
+
export type DeleteDeveloperApplicationErrors = {
|
|
1201
|
+
/**
|
|
1202
|
+
* Bad request.
|
|
1203
|
+
*/
|
|
1204
|
+
400: {
|
|
1205
|
+
/**
|
|
1206
|
+
* The HTTP status code of the error response.
|
|
1207
|
+
*/
|
|
1208
|
+
status: number;
|
|
1209
|
+
/**
|
|
1210
|
+
* The error message.
|
|
1211
|
+
*/
|
|
1212
|
+
message: string;
|
|
1213
|
+
};
|
|
1214
|
+
/**
|
|
1215
|
+
* Unauthorized.
|
|
1216
|
+
*/
|
|
1217
|
+
401: {
|
|
1218
|
+
/**
|
|
1219
|
+
* The HTTP status code of the error response.
|
|
1220
|
+
*/
|
|
1221
|
+
status: number;
|
|
1222
|
+
/**
|
|
1223
|
+
* The error message.
|
|
1224
|
+
*/
|
|
1225
|
+
message: string;
|
|
1226
|
+
};
|
|
1227
|
+
/**
|
|
1228
|
+
* Resource not found.
|
|
1229
|
+
*/
|
|
1230
|
+
404: {
|
|
1231
|
+
/**
|
|
1232
|
+
* The HTTP status code of the error response.
|
|
1233
|
+
*/
|
|
1234
|
+
status: number;
|
|
1235
|
+
/**
|
|
1236
|
+
* The error message.
|
|
1237
|
+
*/
|
|
1238
|
+
message: string;
|
|
1239
|
+
};
|
|
1240
|
+
/**
|
|
1241
|
+
* Internal server error.
|
|
1242
|
+
*/
|
|
1243
|
+
500: unknown;
|
|
1244
|
+
};
|
|
1245
|
+
export type DeleteDeveloperApplicationError = DeleteDeveloperApplicationErrors[keyof DeleteDeveloperApplicationErrors];
|
|
1246
|
+
export type DeleteDeveloperApplicationResponses = {
|
|
1247
|
+
/**
|
|
1248
|
+
* The resource was deleted successfully.
|
|
1249
|
+
*/
|
|
1250
|
+
204: void;
|
|
1251
|
+
};
|
|
1252
|
+
export type DeleteDeveloperApplicationResponse = DeleteDeveloperApplicationResponses[keyof DeleteDeveloperApplicationResponses];
|
|
1253
|
+
export type GetDeveloperApplicationData = {
|
|
1254
|
+
body?: never;
|
|
1255
|
+
path: {
|
|
1256
|
+
application_id: Id;
|
|
1257
|
+
};
|
|
1258
|
+
query?: never;
|
|
1259
|
+
url: '/api/applications/{application_id}';
|
|
1260
|
+
};
|
|
1261
|
+
export type GetDeveloperApplicationErrors = {
|
|
1262
|
+
/**
|
|
1263
|
+
* Bad request.
|
|
1264
|
+
*/
|
|
1265
|
+
400: {
|
|
1266
|
+
/**
|
|
1267
|
+
* The HTTP status code of the error response.
|
|
1268
|
+
*/
|
|
1269
|
+
status: number;
|
|
1270
|
+
/**
|
|
1271
|
+
* The error message.
|
|
1272
|
+
*/
|
|
1273
|
+
message: string;
|
|
1274
|
+
};
|
|
1275
|
+
/**
|
|
1276
|
+
* Unauthorized.
|
|
1277
|
+
*/
|
|
1278
|
+
401: {
|
|
1279
|
+
/**
|
|
1280
|
+
* The HTTP status code of the error response.
|
|
1281
|
+
*/
|
|
1282
|
+
status: number;
|
|
1283
|
+
/**
|
|
1284
|
+
* The error message.
|
|
1285
|
+
*/
|
|
1286
|
+
message: string;
|
|
1287
|
+
};
|
|
1288
|
+
/**
|
|
1289
|
+
* Resource not found.
|
|
1290
|
+
*/
|
|
1291
|
+
404: {
|
|
1292
|
+
/**
|
|
1293
|
+
* The HTTP status code of the error response.
|
|
1294
|
+
*/
|
|
1295
|
+
status: number;
|
|
1296
|
+
/**
|
|
1297
|
+
* The error message.
|
|
1298
|
+
*/
|
|
1299
|
+
message: string;
|
|
1300
|
+
};
|
|
1301
|
+
/**
|
|
1302
|
+
* Internal server error.
|
|
1303
|
+
*/
|
|
1304
|
+
500: unknown;
|
|
1305
|
+
};
|
|
1306
|
+
export type GetDeveloperApplicationError = GetDeveloperApplicationErrors[keyof GetDeveloperApplicationErrors];
|
|
1307
|
+
export type GetDeveloperApplicationResponses = {
|
|
1308
|
+
200: DeveloperApplication;
|
|
1309
|
+
};
|
|
1310
|
+
export type GetDeveloperApplicationResponse = GetDeveloperApplicationResponses[keyof GetDeveloperApplicationResponses];
|
|
1311
|
+
export type UpdateDeveloperApplicationData = {
|
|
1312
|
+
body?: CreateDeveloperApplicationReq;
|
|
1313
|
+
path: {
|
|
1314
|
+
application_id: Id;
|
|
1315
|
+
};
|
|
1316
|
+
query?: never;
|
|
1317
|
+
url: '/api/applications/{application_id}';
|
|
1318
|
+
};
|
|
1319
|
+
export type UpdateDeveloperApplicationErrors = {
|
|
1320
|
+
/**
|
|
1321
|
+
* Bad request.
|
|
1322
|
+
*/
|
|
1323
|
+
400: {
|
|
1324
|
+
/**
|
|
1325
|
+
* The HTTP status code of the error response.
|
|
1326
|
+
*/
|
|
1327
|
+
status: number;
|
|
1328
|
+
/**
|
|
1329
|
+
* The error message.
|
|
1330
|
+
*/
|
|
1331
|
+
message: string;
|
|
1332
|
+
};
|
|
1333
|
+
/**
|
|
1334
|
+
* Unauthorized.
|
|
1335
|
+
*/
|
|
1336
|
+
401: {
|
|
1337
|
+
/**
|
|
1338
|
+
* The HTTP status code of the error response.
|
|
1339
|
+
*/
|
|
1340
|
+
status: number;
|
|
1341
|
+
/**
|
|
1342
|
+
* The error message.
|
|
1343
|
+
*/
|
|
1344
|
+
message: string;
|
|
1345
|
+
};
|
|
1346
|
+
/**
|
|
1347
|
+
* Resource not found.
|
|
1348
|
+
*/
|
|
1349
|
+
404: {
|
|
1350
|
+
/**
|
|
1351
|
+
* The HTTP status code of the error response.
|
|
1352
|
+
*/
|
|
1353
|
+
status: number;
|
|
1354
|
+
/**
|
|
1355
|
+
* The error message.
|
|
1356
|
+
*/
|
|
1357
|
+
message: string;
|
|
1358
|
+
};
|
|
1359
|
+
/**
|
|
1360
|
+
* Internal server error.
|
|
1361
|
+
*/
|
|
1362
|
+
500: unknown;
|
|
1363
|
+
};
|
|
1364
|
+
export type UpdateDeveloperApplicationError = UpdateDeveloperApplicationErrors[keyof UpdateDeveloperApplicationErrors];
|
|
1365
|
+
export type UpdateDeveloperApplicationResponses = {
|
|
1366
|
+
200: DeveloperApplication;
|
|
1367
|
+
};
|
|
1368
|
+
export type UpdateDeveloperApplicationResponse = UpdateDeveloperApplicationResponses[keyof UpdateDeveloperApplicationResponses];
|
|
1369
|
+
export type ListDeveloperCredentialsData = {
|
|
1370
|
+
body?: never;
|
|
1371
|
+
path: {
|
|
1372
|
+
application_id: Id;
|
|
1373
|
+
};
|
|
1374
|
+
query?: {
|
|
1375
|
+
/**
|
|
1376
|
+
* The authentication method of the developer credential.
|
|
1377
|
+
*/
|
|
1378
|
+
auth_method?: 'key-auth' | 'basic-auth' | 'oauth';
|
|
1379
|
+
/**
|
|
1380
|
+
* The plugin name of the developer credential, recommended to use `auth_method` instead.
|
|
1381
|
+
*
|
|
1382
|
+
* @deprecated
|
|
1383
|
+
*/
|
|
1384
|
+
plugin_name?: Name;
|
|
1385
|
+
/**
|
|
1386
|
+
* Page number of the listed resources. Used together with `page_size`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.
|
|
1387
|
+
*/
|
|
1388
|
+
page?: bigint;
|
|
1389
|
+
/**
|
|
1390
|
+
* Number of resources listed per page. Used together with `page`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.
|
|
1391
|
+
*/
|
|
1392
|
+
page_size?: bigint;
|
|
1393
|
+
/**
|
|
1394
|
+
* Order to list the resources by. The sorting index follows the configuration of `order_by`.
|
|
1395
|
+
*/
|
|
1396
|
+
direction?: 'asc' | 'desc';
|
|
1397
|
+
/**
|
|
1398
|
+
* Index to order credentials by.
|
|
1399
|
+
*/
|
|
1400
|
+
order_by?: 'created_at' | 'updated_at' | 'name';
|
|
1401
|
+
/**
|
|
1402
|
+
* Condition to search resources by.
|
|
1403
|
+
*/
|
|
1404
|
+
search?: string;
|
|
1405
|
+
/**
|
|
1406
|
+
* Label(s) to filter resources by. The format is `labels[key]=value` and should be URL-encoded.
|
|
1407
|
+
*/
|
|
1408
|
+
labels?: string;
|
|
1409
|
+
};
|
|
1410
|
+
url: '/api/applications/{application_id}/credentials';
|
|
1411
|
+
};
|
|
1412
|
+
export type ListDeveloperCredentialsErrors = {
|
|
1413
|
+
/**
|
|
1414
|
+
* Bad request.
|
|
1415
|
+
*/
|
|
1416
|
+
400: {
|
|
1417
|
+
/**
|
|
1418
|
+
* The HTTP status code of the error response.
|
|
1419
|
+
*/
|
|
1420
|
+
status: number;
|
|
1421
|
+
/**
|
|
1422
|
+
* The error message.
|
|
1423
|
+
*/
|
|
1424
|
+
message: string;
|
|
1425
|
+
};
|
|
1426
|
+
/**
|
|
1427
|
+
* Unauthorized.
|
|
1428
|
+
*/
|
|
1429
|
+
401: {
|
|
1430
|
+
/**
|
|
1431
|
+
* The HTTP status code of the error response.
|
|
1432
|
+
*/
|
|
1433
|
+
status: number;
|
|
1434
|
+
/**
|
|
1435
|
+
* The error message.
|
|
1436
|
+
*/
|
|
1437
|
+
message: string;
|
|
1438
|
+
};
|
|
1439
|
+
/**
|
|
1440
|
+
* Internal server error.
|
|
1441
|
+
*/
|
|
1442
|
+
500: unknown;
|
|
1443
|
+
};
|
|
1444
|
+
export type ListDeveloperCredentialsError = ListDeveloperCredentialsErrors[keyof ListDeveloperCredentialsErrors];
|
|
1445
|
+
export type ListDeveloperCredentialsResponses = {
|
|
1446
|
+
200: {
|
|
1447
|
+
/**
|
|
1448
|
+
* An array of application credentials.
|
|
1449
|
+
*/
|
|
1450
|
+
list: Array<ApplicationCredential>;
|
|
1451
|
+
total: Total;
|
|
1452
|
+
};
|
|
1453
|
+
};
|
|
1454
|
+
export type ListDeveloperCredentialsResponse = ListDeveloperCredentialsResponses[keyof ListDeveloperCredentialsResponses];
|
|
1455
|
+
export type CreateDeveloperCredentialData = {
|
|
1456
|
+
body?: CreateApplicationCredentialReq;
|
|
1457
|
+
path: {
|
|
1458
|
+
application_id: Id;
|
|
1459
|
+
};
|
|
1460
|
+
query?: never;
|
|
1461
|
+
url: '/api/applications/{application_id}/credentials';
|
|
1462
|
+
};
|
|
1463
|
+
export type CreateDeveloperCredentialErrors = {
|
|
1464
|
+
/**
|
|
1465
|
+
* Bad request.
|
|
1466
|
+
*/
|
|
1467
|
+
400: {
|
|
1468
|
+
/**
|
|
1469
|
+
* The HTTP status code of the error response.
|
|
1470
|
+
*/
|
|
1471
|
+
status: number;
|
|
1472
|
+
/**
|
|
1473
|
+
* The error message.
|
|
1474
|
+
*/
|
|
1475
|
+
message: string;
|
|
1476
|
+
};
|
|
1477
|
+
/**
|
|
1478
|
+
* Unauthorized.
|
|
1479
|
+
*/
|
|
1480
|
+
401: {
|
|
1481
|
+
/**
|
|
1482
|
+
* The HTTP status code of the error response.
|
|
1483
|
+
*/
|
|
1484
|
+
status: number;
|
|
1485
|
+
/**
|
|
1486
|
+
* The error message.
|
|
1487
|
+
*/
|
|
1488
|
+
message: string;
|
|
1489
|
+
};
|
|
1490
|
+
/**
|
|
1491
|
+
* Internal server error.
|
|
1492
|
+
*/
|
|
1493
|
+
500: unknown;
|
|
1494
|
+
};
|
|
1495
|
+
export type CreateDeveloperCredentialError = CreateDeveloperCredentialErrors[keyof CreateDeveloperCredentialErrors];
|
|
1496
|
+
export type CreateDeveloperCredentialResponses = {
|
|
1497
|
+
201: ApplicationCredential;
|
|
1498
|
+
};
|
|
1499
|
+
export type CreateDeveloperCredentialResponse = CreateDeveloperCredentialResponses[keyof CreateDeveloperCredentialResponses];
|
|
1500
|
+
export type DeleteDeveloperCredentialData = {
|
|
1501
|
+
body?: never;
|
|
1502
|
+
path: {
|
|
1503
|
+
application_id: Id;
|
|
1504
|
+
/**
|
|
1505
|
+
* The unique identifier of the developer credential.
|
|
1506
|
+
*/
|
|
1507
|
+
credential_id: Id;
|
|
1508
|
+
};
|
|
1509
|
+
query?: never;
|
|
1510
|
+
url: '/api/applications/{application_id}/credentials/{credential_id}';
|
|
1511
|
+
};
|
|
1512
|
+
export type DeleteDeveloperCredentialErrors = {
|
|
1513
|
+
/**
|
|
1514
|
+
* Bad request.
|
|
1515
|
+
*/
|
|
1516
|
+
400: {
|
|
1517
|
+
/**
|
|
1518
|
+
* The HTTP status code of the error response.
|
|
1519
|
+
*/
|
|
1520
|
+
status: number;
|
|
1521
|
+
/**
|
|
1522
|
+
* The error message.
|
|
1523
|
+
*/
|
|
1524
|
+
message: string;
|
|
1525
|
+
};
|
|
1526
|
+
/**
|
|
1527
|
+
* Unauthorized.
|
|
1528
|
+
*/
|
|
1529
|
+
401: {
|
|
1530
|
+
/**
|
|
1531
|
+
* The HTTP status code of the error response.
|
|
1532
|
+
*/
|
|
1533
|
+
status: number;
|
|
1534
|
+
/**
|
|
1535
|
+
* The error message.
|
|
1536
|
+
*/
|
|
1537
|
+
message: string;
|
|
1538
|
+
};
|
|
1539
|
+
/**
|
|
1540
|
+
* Resource not found.
|
|
1541
|
+
*/
|
|
1542
|
+
404: {
|
|
1543
|
+
/**
|
|
1544
|
+
* The HTTP status code of the error response.
|
|
1545
|
+
*/
|
|
1546
|
+
status: number;
|
|
1547
|
+
/**
|
|
1548
|
+
* The error message.
|
|
1549
|
+
*/
|
|
1550
|
+
message: string;
|
|
1551
|
+
};
|
|
1552
|
+
/**
|
|
1553
|
+
* Internal server error.
|
|
1554
|
+
*/
|
|
1555
|
+
500: unknown;
|
|
1556
|
+
};
|
|
1557
|
+
export type DeleteDeveloperCredentialError = DeleteDeveloperCredentialErrors[keyof DeleteDeveloperCredentialErrors];
|
|
1558
|
+
export type DeleteDeveloperCredentialResponses = {
|
|
1559
|
+
/**
|
|
1560
|
+
* The resource was deleted successfully.
|
|
1561
|
+
*/
|
|
1562
|
+
204: void;
|
|
1563
|
+
};
|
|
1564
|
+
export type DeleteDeveloperCredentialResponse = DeleteDeveloperCredentialResponses[keyof DeleteDeveloperCredentialResponses];
|
|
1565
|
+
export type GetDeveloperCredentialData = {
|
|
1566
|
+
body?: never;
|
|
1567
|
+
path: {
|
|
1568
|
+
application_id: Id;
|
|
1569
|
+
/**
|
|
1570
|
+
* The unique identifier of the developer credential.
|
|
1571
|
+
*/
|
|
1572
|
+
credential_id: Id;
|
|
1573
|
+
};
|
|
1574
|
+
query?: never;
|
|
1575
|
+
url: '/api/applications/{application_id}/credentials/{credential_id}';
|
|
1576
|
+
};
|
|
1577
|
+
export type GetDeveloperCredentialErrors = {
|
|
1578
|
+
/**
|
|
1579
|
+
* Bad request.
|
|
1580
|
+
*/
|
|
1581
|
+
400: {
|
|
1582
|
+
/**
|
|
1583
|
+
* The HTTP status code of the error response.
|
|
1584
|
+
*/
|
|
1585
|
+
status: number;
|
|
1586
|
+
/**
|
|
1587
|
+
* The error message.
|
|
1588
|
+
*/
|
|
1589
|
+
message: string;
|
|
1590
|
+
};
|
|
1591
|
+
/**
|
|
1592
|
+
* Unauthorized.
|
|
1593
|
+
*/
|
|
1594
|
+
401: {
|
|
1595
|
+
/**
|
|
1596
|
+
* The HTTP status code of the error response.
|
|
1597
|
+
*/
|
|
1598
|
+
status: number;
|
|
1599
|
+
/**
|
|
1600
|
+
* The error message.
|
|
1601
|
+
*/
|
|
1602
|
+
message: string;
|
|
1603
|
+
};
|
|
1604
|
+
/**
|
|
1605
|
+
* Resource not found.
|
|
1606
|
+
*/
|
|
1607
|
+
404: {
|
|
1608
|
+
/**
|
|
1609
|
+
* The HTTP status code of the error response.
|
|
1610
|
+
*/
|
|
1611
|
+
status: number;
|
|
1612
|
+
/**
|
|
1613
|
+
* The error message.
|
|
1614
|
+
*/
|
|
1615
|
+
message: string;
|
|
1616
|
+
};
|
|
1617
|
+
/**
|
|
1618
|
+
* Internal server error.
|
|
1619
|
+
*/
|
|
1620
|
+
500: unknown;
|
|
1621
|
+
};
|
|
1622
|
+
export type GetDeveloperCredentialError = GetDeveloperCredentialErrors[keyof GetDeveloperCredentialErrors];
|
|
1623
|
+
export type GetDeveloperCredentialResponses = {
|
|
1624
|
+
200: ApplicationCredential;
|
|
1625
|
+
};
|
|
1626
|
+
export type GetDeveloperCredentialResponse = GetDeveloperCredentialResponses[keyof GetDeveloperCredentialResponses];
|
|
1627
|
+
export type UpsertDeveloperCredentialData = {
|
|
1628
|
+
body?: UpdateApplicationCredentialReq;
|
|
1629
|
+
path: {
|
|
1630
|
+
application_id: Id;
|
|
1631
|
+
/**
|
|
1632
|
+
* The unique identifier of the developer credential.
|
|
1633
|
+
*/
|
|
1634
|
+
credential_id: Id;
|
|
1635
|
+
};
|
|
1636
|
+
query?: never;
|
|
1637
|
+
url: '/api/applications/{application_id}/credentials/{credential_id}';
|
|
1638
|
+
};
|
|
1639
|
+
export type UpsertDeveloperCredentialErrors = {
|
|
1640
|
+
/**
|
|
1641
|
+
* Bad request.
|
|
1642
|
+
*/
|
|
1643
|
+
400: {
|
|
1644
|
+
/**
|
|
1645
|
+
* The HTTP status code of the error response.
|
|
1646
|
+
*/
|
|
1647
|
+
status: number;
|
|
1648
|
+
/**
|
|
1649
|
+
* The error message.
|
|
1650
|
+
*/
|
|
1651
|
+
message: string;
|
|
1652
|
+
};
|
|
1653
|
+
/**
|
|
1654
|
+
* Unauthorized.
|
|
1655
|
+
*/
|
|
1656
|
+
401: {
|
|
1657
|
+
/**
|
|
1658
|
+
* The HTTP status code of the error response.
|
|
1659
|
+
*/
|
|
1660
|
+
status: number;
|
|
1661
|
+
/**
|
|
1662
|
+
* The error message.
|
|
1663
|
+
*/
|
|
1664
|
+
message: string;
|
|
1665
|
+
};
|
|
1666
|
+
/**
|
|
1667
|
+
* Resource not found.
|
|
1668
|
+
*/
|
|
1669
|
+
404: {
|
|
1670
|
+
/**
|
|
1671
|
+
* The HTTP status code of the error response.
|
|
1672
|
+
*/
|
|
1673
|
+
status: number;
|
|
1674
|
+
/**
|
|
1675
|
+
* The error message.
|
|
1676
|
+
*/
|
|
1677
|
+
message: string;
|
|
1678
|
+
};
|
|
1679
|
+
/**
|
|
1680
|
+
* Internal server error.
|
|
1681
|
+
*/
|
|
1682
|
+
500: unknown;
|
|
1683
|
+
};
|
|
1684
|
+
export type UpsertDeveloperCredentialError = UpsertDeveloperCredentialErrors[keyof UpsertDeveloperCredentialErrors];
|
|
1685
|
+
export type UpsertDeveloperCredentialResponses = {
|
|
1686
|
+
200: ApplicationCredential;
|
|
1687
|
+
};
|
|
1688
|
+
export type UpsertDeveloperCredentialResponse = UpsertDeveloperCredentialResponses[keyof UpsertDeveloperCredentialResponses];
|
|
1689
|
+
export type RegenerateDeveloperCredentialData = {
|
|
1690
|
+
body?: RegenerateApplicationCredentialReq;
|
|
1691
|
+
path: {
|
|
1692
|
+
application_id: Id;
|
|
1693
|
+
/**
|
|
1694
|
+
* The unique identifier of the developer credential.
|
|
1695
|
+
*/
|
|
1696
|
+
credential_id: Id;
|
|
1697
|
+
};
|
|
1698
|
+
query?: never;
|
|
1699
|
+
url: '/api/applications/{application_id}/credentials/{credential_id}/regenerate';
|
|
1700
|
+
};
|
|
1701
|
+
export type RegenerateDeveloperCredentialErrors = {
|
|
1702
|
+
/**
|
|
1703
|
+
* Bad request.
|
|
1704
|
+
*/
|
|
1705
|
+
400: {
|
|
1706
|
+
/**
|
|
1707
|
+
* The HTTP status code of the error response.
|
|
1708
|
+
*/
|
|
1709
|
+
status: number;
|
|
1710
|
+
/**
|
|
1711
|
+
* The error message.
|
|
1712
|
+
*/
|
|
1713
|
+
message: string;
|
|
1714
|
+
};
|
|
1715
|
+
/**
|
|
1716
|
+
* Unauthorized.
|
|
1717
|
+
*/
|
|
1718
|
+
401: {
|
|
1719
|
+
/**
|
|
1720
|
+
* The HTTP status code of the error response.
|
|
1721
|
+
*/
|
|
1722
|
+
status: number;
|
|
1723
|
+
/**
|
|
1724
|
+
* The error message.
|
|
1725
|
+
*/
|
|
1726
|
+
message: string;
|
|
1727
|
+
};
|
|
1728
|
+
/**
|
|
1729
|
+
* Resource not found.
|
|
1730
|
+
*/
|
|
1731
|
+
404: {
|
|
1732
|
+
/**
|
|
1733
|
+
* The HTTP status code of the error response.
|
|
1734
|
+
*/
|
|
1735
|
+
status: number;
|
|
1736
|
+
/**
|
|
1737
|
+
* The error message.
|
|
1738
|
+
*/
|
|
1739
|
+
message: string;
|
|
1740
|
+
};
|
|
1741
|
+
/**
|
|
1742
|
+
* Internal server error.
|
|
1743
|
+
*/
|
|
1744
|
+
500: unknown;
|
|
1745
|
+
};
|
|
1746
|
+
export type RegenerateDeveloperCredentialError = RegenerateDeveloperCredentialErrors[keyof RegenerateDeveloperCredentialErrors];
|
|
1747
|
+
export type RegenerateDeveloperCredentialResponses = {
|
|
1748
|
+
200: ApplicationCredential;
|
|
1749
|
+
};
|
|
1750
|
+
export type RegenerateDeveloperCredentialResponse = RegenerateDeveloperCredentialResponses[keyof RegenerateDeveloperCredentialResponses];
|
|
1751
|
+
export type GetApiCallsData = {
|
|
1752
|
+
body?: never;
|
|
1753
|
+
path?: never;
|
|
1754
|
+
query: {
|
|
1755
|
+
application_id?: Array<Id>;
|
|
1756
|
+
/**
|
|
1757
|
+
* The API product IDs.
|
|
1758
|
+
*/
|
|
1759
|
+
api_product_id?: Array<Id>;
|
|
1760
|
+
credential_id?: Array<Id>;
|
|
1761
|
+
start_at: number;
|
|
1762
|
+
end_at: number;
|
|
1763
|
+
};
|
|
1764
|
+
url: '/api/applications/api_calls';
|
|
1765
|
+
};
|
|
1766
|
+
export type GetApiCallsErrors = {
|
|
1767
|
+
/**
|
|
1768
|
+
* Bad request.
|
|
1769
|
+
*/
|
|
1770
|
+
400: {
|
|
1771
|
+
/**
|
|
1772
|
+
* The HTTP status code of the error response.
|
|
1773
|
+
*/
|
|
1774
|
+
status: number;
|
|
1775
|
+
/**
|
|
1776
|
+
* The error message.
|
|
1777
|
+
*/
|
|
1778
|
+
message: string;
|
|
1779
|
+
};
|
|
1780
|
+
/**
|
|
1781
|
+
* Unauthorized.
|
|
1782
|
+
*/
|
|
1783
|
+
401: {
|
|
1784
|
+
/**
|
|
1785
|
+
* The HTTP status code of the error response.
|
|
1786
|
+
*/
|
|
1787
|
+
status: number;
|
|
1788
|
+
/**
|
|
1789
|
+
* The error message.
|
|
1790
|
+
*/
|
|
1791
|
+
message: string;
|
|
1792
|
+
};
|
|
1793
|
+
/**
|
|
1794
|
+
* Internal server error.
|
|
1795
|
+
*/
|
|
1796
|
+
500: unknown;
|
|
1797
|
+
};
|
|
1798
|
+
export type GetApiCallsError = GetApiCallsErrors[keyof GetApiCallsErrors];
|
|
1799
|
+
export type GetApiCallsResponses = {
|
|
1800
|
+
200: {
|
|
1801
|
+
/**
|
|
1802
|
+
* An array of API calls.
|
|
1803
|
+
*/
|
|
1804
|
+
list: Array<ApiCall>;
|
|
1805
|
+
total: Total;
|
|
1806
|
+
};
|
|
1807
|
+
};
|
|
1808
|
+
export type GetApiCallsResponse = GetApiCallsResponses[keyof GetApiCallsResponses];
|
|
1809
|
+
export type ListCredentialsData = {
|
|
1810
|
+
body?: never;
|
|
1811
|
+
path?: never;
|
|
1812
|
+
query?: {
|
|
1813
|
+
application_id?: Array<Id>;
|
|
1814
|
+
/**
|
|
1815
|
+
* The authentication method of the developer credential.
|
|
1816
|
+
*/
|
|
1817
|
+
auth_method?: 'key-auth' | 'basic-auth' | 'oauth';
|
|
1818
|
+
/**
|
|
1819
|
+
* The plugin name of the developer credential, recommended to use `auth_method` instead.
|
|
1820
|
+
*
|
|
1821
|
+
* @deprecated
|
|
1822
|
+
*/
|
|
1823
|
+
plugin_name?: Name;
|
|
1824
|
+
/**
|
|
1825
|
+
* Page number of the listed resources. Used together with `page_size`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.
|
|
1826
|
+
*/
|
|
1827
|
+
page?: bigint;
|
|
1828
|
+
/**
|
|
1829
|
+
* Number of resources listed per page. Used together with `page`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.
|
|
1830
|
+
*/
|
|
1831
|
+
page_size?: bigint;
|
|
1832
|
+
/**
|
|
1833
|
+
* Order to list the resources by. The sorting index follows the configuration of `order_by`.
|
|
1834
|
+
*/
|
|
1835
|
+
direction?: 'asc' | 'desc';
|
|
1836
|
+
/**
|
|
1837
|
+
* Index to order credentials by.
|
|
1838
|
+
*/
|
|
1839
|
+
order_by?: 'created_at' | 'updated_at' | 'name';
|
|
1840
|
+
/**
|
|
1841
|
+
* Condition to search resources by.
|
|
1842
|
+
*/
|
|
1843
|
+
search?: string;
|
|
1844
|
+
/**
|
|
1845
|
+
* Label(s) to filter resources by. The format is `labels[key]=value` and should be URL-encoded.
|
|
1846
|
+
*/
|
|
1847
|
+
labels?: string;
|
|
1848
|
+
};
|
|
1849
|
+
url: '/api/credentials';
|
|
1850
|
+
};
|
|
1851
|
+
export type ListCredentialsErrors = {
|
|
1852
|
+
/**
|
|
1853
|
+
* Bad request.
|
|
1854
|
+
*/
|
|
1855
|
+
400: {
|
|
1856
|
+
/**
|
|
1857
|
+
* The HTTP status code of the error response.
|
|
1858
|
+
*/
|
|
1859
|
+
status: number;
|
|
1860
|
+
/**
|
|
1861
|
+
* The error message.
|
|
1862
|
+
*/
|
|
1863
|
+
message: string;
|
|
1864
|
+
};
|
|
1865
|
+
/**
|
|
1866
|
+
* Unauthorized.
|
|
1867
|
+
*/
|
|
1868
|
+
401: {
|
|
1869
|
+
/**
|
|
1870
|
+
* The HTTP status code of the error response.
|
|
1871
|
+
*/
|
|
1872
|
+
status: number;
|
|
1873
|
+
/**
|
|
1874
|
+
* The error message.
|
|
1875
|
+
*/
|
|
1876
|
+
message: string;
|
|
1877
|
+
};
|
|
1878
|
+
/**
|
|
1879
|
+
* Internal server error.
|
|
1880
|
+
*/
|
|
1881
|
+
500: unknown;
|
|
1882
|
+
};
|
|
1883
|
+
export type ListCredentialsError = ListCredentialsErrors[keyof ListCredentialsErrors];
|
|
1884
|
+
export type ListCredentialsResponses = {
|
|
1885
|
+
200: {
|
|
1886
|
+
/**
|
|
1887
|
+
* An array of application credentials.
|
|
1888
|
+
*/
|
|
1889
|
+
list: Array<ApplicationCredential>;
|
|
1890
|
+
total: Total;
|
|
1891
|
+
};
|
|
1892
|
+
};
|
|
1893
|
+
export type ListCredentialsResponse = ListCredentialsResponses[keyof ListCredentialsResponses];
|
|
1894
|
+
export type ListLabelsData = {
|
|
1895
|
+
body?: never;
|
|
1896
|
+
path: {
|
|
1897
|
+
resource_type: 'developer_credential' | 'developer_application' | 'api_product';
|
|
1898
|
+
};
|
|
1899
|
+
query?: never;
|
|
1900
|
+
url: '/api/labels/{resource_type}';
|
|
1901
|
+
};
|
|
1902
|
+
export type ListLabelsErrors = {
|
|
1903
|
+
/**
|
|
1904
|
+
* Bad request.
|
|
1905
|
+
*/
|
|
1906
|
+
400: {
|
|
1907
|
+
/**
|
|
1908
|
+
* The HTTP status code of the error response.
|
|
1909
|
+
*/
|
|
1910
|
+
status: number;
|
|
1911
|
+
/**
|
|
1912
|
+
* The error message.
|
|
1913
|
+
*/
|
|
1914
|
+
message: string;
|
|
1915
|
+
};
|
|
1916
|
+
/**
|
|
1917
|
+
* Unauthorized.
|
|
1918
|
+
*/
|
|
1919
|
+
401: {
|
|
1920
|
+
/**
|
|
1921
|
+
* The HTTP status code of the error response.
|
|
1922
|
+
*/
|
|
1923
|
+
status: number;
|
|
1924
|
+
/**
|
|
1925
|
+
* The error message.
|
|
1926
|
+
*/
|
|
1927
|
+
message: string;
|
|
1928
|
+
};
|
|
1929
|
+
/**
|
|
1930
|
+
* Internal server error.
|
|
1931
|
+
*/
|
|
1932
|
+
500: unknown;
|
|
1933
|
+
};
|
|
1934
|
+
export type ListLabelsError = ListLabelsErrors[keyof ListLabelsErrors];
|
|
1935
|
+
export type ListLabelsResponses = {
|
|
1936
|
+
200: AllLabels;
|
|
1937
|
+
};
|
|
1938
|
+
export type ListLabelsResponse = ListLabelsResponses[keyof ListLabelsResponses];
|
|
1939
|
+
export type GetSmtpServerStatusData = {
|
|
1940
|
+
body?: never;
|
|
1941
|
+
path?: never;
|
|
1942
|
+
query?: never;
|
|
1943
|
+
url: '/api/system_settings/smtp_server_status';
|
|
1944
|
+
};
|
|
1945
|
+
export type GetSmtpServerStatusErrors = {
|
|
1946
|
+
/**
|
|
1947
|
+
* Bad request.
|
|
1948
|
+
*/
|
|
1949
|
+
400: {
|
|
1950
|
+
/**
|
|
1951
|
+
* The HTTP status code of the error response.
|
|
1952
|
+
*/
|
|
1953
|
+
status: number;
|
|
1954
|
+
/**
|
|
1955
|
+
* The error message.
|
|
1956
|
+
*/
|
|
1957
|
+
message: string;
|
|
1958
|
+
};
|
|
1959
|
+
/**
|
|
1960
|
+
* Unauthorized.
|
|
1961
|
+
*/
|
|
1962
|
+
401: {
|
|
1963
|
+
/**
|
|
1964
|
+
* The HTTP status code of the error response.
|
|
1965
|
+
*/
|
|
1966
|
+
status: number;
|
|
1967
|
+
/**
|
|
1968
|
+
* The error message.
|
|
1969
|
+
*/
|
|
1970
|
+
message: string;
|
|
1971
|
+
};
|
|
1972
|
+
/**
|
|
1973
|
+
* Internal server error.
|
|
1974
|
+
*/
|
|
1975
|
+
500: unknown;
|
|
1976
|
+
};
|
|
1977
|
+
export type GetSmtpServerStatusError = GetSmtpServerStatusErrors[keyof GetSmtpServerStatusErrors];
|
|
1978
|
+
export type GetSmtpServerStatusResponses = {
|
|
1979
|
+
200: SmtpServerSettingsStatus;
|
|
1980
|
+
};
|
|
1981
|
+
export type GetSmtpServerStatusResponse = GetSmtpServerStatusResponses[keyof GetSmtpServerStatusResponses];
|
|
1982
|
+
export type GetPublicAccessSettingsData = {
|
|
1983
|
+
body?: never;
|
|
1984
|
+
path?: never;
|
|
1985
|
+
query?: never;
|
|
1986
|
+
url: '/api/system_settings/public_access';
|
|
1987
|
+
};
|
|
1988
|
+
export type GetPublicAccessSettingsErrors = {
|
|
1989
|
+
/**
|
|
1990
|
+
* Bad request.
|
|
1991
|
+
*/
|
|
1992
|
+
400: {
|
|
1993
|
+
/**
|
|
1994
|
+
* The HTTP status code of the error response.
|
|
1995
|
+
*/
|
|
1996
|
+
status: number;
|
|
1997
|
+
/**
|
|
1998
|
+
* The error message.
|
|
1999
|
+
*/
|
|
2000
|
+
message: string;
|
|
2001
|
+
};
|
|
2002
|
+
/**
|
|
2003
|
+
* Unauthorized.
|
|
2004
|
+
*/
|
|
2005
|
+
401: {
|
|
2006
|
+
/**
|
|
2007
|
+
* The HTTP status code of the error response.
|
|
2008
|
+
*/
|
|
2009
|
+
status: number;
|
|
2010
|
+
/**
|
|
2011
|
+
* The error message.
|
|
2012
|
+
*/
|
|
2013
|
+
message: string;
|
|
2014
|
+
};
|
|
2015
|
+
/**
|
|
2016
|
+
* Internal server error.
|
|
2017
|
+
*/
|
|
2018
|
+
500: unknown;
|
|
2019
|
+
};
|
|
2020
|
+
export type GetPublicAccessSettingsError = GetPublicAccessSettingsErrors[keyof GetPublicAccessSettingsErrors];
|
|
2021
|
+
export type GetPublicAccessSettingsResponses = {
|
|
2022
|
+
200: PortalPublicAccess;
|
|
2023
|
+
};
|
|
2024
|
+
export type GetPublicAccessSettingsResponse = GetPublicAccessSettingsResponses[keyof GetPublicAccessSettingsResponses];
|
|
2025
|
+
export type ListDcrProvidersData = {
|
|
2026
|
+
body?: never;
|
|
2027
|
+
path?: never;
|
|
2028
|
+
query?: {
|
|
2029
|
+
/**
|
|
2030
|
+
* Page number of the listed resources. Used together with `page_size`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.
|
|
2031
|
+
*/
|
|
2032
|
+
page?: bigint;
|
|
2033
|
+
/**
|
|
2034
|
+
* Number of resources listed per page. Used together with `page`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.
|
|
2035
|
+
*/
|
|
2036
|
+
page_size?: bigint;
|
|
2037
|
+
/**
|
|
2038
|
+
* Order to list the resources by. The sorting index follows the configuration of `order_by`.
|
|
2039
|
+
*/
|
|
2040
|
+
direction?: 'asc' | 'desc';
|
|
2041
|
+
/**
|
|
2042
|
+
* Ascending or descending order to list the resources, by `created_at` or `updated_by` configured in `order_by`.
|
|
2043
|
+
*/
|
|
2044
|
+
order_by?: 'created_at' | 'updated_at';
|
|
2045
|
+
/**
|
|
2046
|
+
* Condition to search resources by.
|
|
2047
|
+
*/
|
|
2048
|
+
search?: string;
|
|
2049
|
+
};
|
|
2050
|
+
url: '/api/dcr_providers';
|
|
2051
|
+
};
|
|
2052
|
+
export type ListDcrProvidersErrors = {
|
|
2053
|
+
/**
|
|
2054
|
+
* Bad request.
|
|
2055
|
+
*/
|
|
2056
|
+
400: {
|
|
2057
|
+
/**
|
|
2058
|
+
* The HTTP status code of the error response.
|
|
2059
|
+
*/
|
|
2060
|
+
status: number;
|
|
2061
|
+
/**
|
|
2062
|
+
* The error message.
|
|
2063
|
+
*/
|
|
2064
|
+
message: string;
|
|
2065
|
+
};
|
|
2066
|
+
/**
|
|
2067
|
+
* Unauthorized.
|
|
2068
|
+
*/
|
|
2069
|
+
401: {
|
|
2070
|
+
/**
|
|
2071
|
+
* The HTTP status code of the error response.
|
|
2072
|
+
*/
|
|
2073
|
+
status: number;
|
|
2074
|
+
/**
|
|
2075
|
+
* The error message.
|
|
2076
|
+
*/
|
|
2077
|
+
message: string;
|
|
2078
|
+
};
|
|
2079
|
+
/**
|
|
2080
|
+
* Internal server error.
|
|
2081
|
+
*/
|
|
2082
|
+
500: unknown;
|
|
2083
|
+
};
|
|
2084
|
+
export type ListDcrProvidersError = ListDcrProvidersErrors[keyof ListDcrProvidersErrors];
|
|
2085
|
+
export type ListDcrProvidersResponses = {
|
|
2086
|
+
200: {
|
|
2087
|
+
/**
|
|
2088
|
+
* An array of DCR providers.
|
|
2089
|
+
*/
|
|
2090
|
+
list: Array<DcrProviderForDeveloper>;
|
|
2091
|
+
total: Total;
|
|
2092
|
+
};
|
|
2093
|
+
};
|
|
2094
|
+
export type ListDcrProvidersResponse = ListDcrProvidersResponses[keyof ListDcrProvidersResponses];
|
|
2095
|
+
//# sourceMappingURL=types.gen.d.ts.map
|