@pidginhost/sdk 0.2.0 → 0.5.0
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/.openapi-generator/FILES +10 -0
- package/.openapi-generator/VERSION +1 -1
- package/CHANGELOG.md +62 -0
- package/README.md +24 -215
- package/api.ts +11413 -26360
- package/dist/api.d.ts +799 -6912
- package/dist/api.js +10802 -25003
- package/dist/esm/api.d.ts +799 -6912
- package/dist/esm/api.js +11170 -25375
- package/dist/esm/pidginhost.d.ts +7 -1
- package/dist/esm/pidginhost.js +7 -1
- package/dist/pidginhost.d.ts +7 -1
- package/dist/pidginhost.js +6 -0
- package/docs/AccountApi.md +142 -1138
- package/docs/AuthApi.md +104 -0
- package/docs/BillingApi.md +134 -1073
- package/docs/CLISessionCreateResponse.md +26 -0
- package/docs/CLISessionPollResponse.md +26 -0
- package/docs/CLISessionPollResponseStatusEnum.md +15 -0
- package/docs/CloudApi.md +906 -4971
- package/docs/ClusterAdd.md +2 -0
- package/docs/ClusterDetail.md +8 -0
- package/docs/DedicatedApi.md +0 -272
- package/docs/DomainApi.md +144 -1164
- package/docs/EligibleVM.md +22 -0
- package/docs/EligibleVMsResponse.md +20 -0
- package/docs/FreednsApi.md +0 -324
- package/docs/HardwareGeneration.md +34 -0
- package/docs/HostingApi.md +0 -160
- package/docs/KubeVersionEnum.md +4 -4
- package/docs/KubernetesApi.md +565 -3562
- package/docs/PatchedClusterDetail.md +8 -0
- package/docs/PatchedResourcePool.md +2 -0
- package/docs/PatchedServerDetail.md +52 -0
- package/docs/ResourcePool.md +2 -0
- package/docs/ResourcePoolAdd.md +2 -0
- package/docs/SchemaApi.md +0 -55
- package/docs/Server.md +5 -3
- package/docs/ServerAdd.md +2 -0
- package/docs/ServerDetail.md +52 -0
- package/docs/SupportApi.md +0 -417
- package/docs/ToggleCloudVMAccessResponse.md +22 -0
- package/package.json +1 -1
- package/pidginhost.ts +13 -1
package/docs/AccountApi.md
CHANGED
|
@@ -5,43 +5,24 @@ All URIs are relative to *https://www.pidginhost.com*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**accountApiTokensCreate**](#accountapitokenscreate) | **POST** /api/account/api-tokens/ | |
|
|
8
|
-
|[**accountApiTokensCreate2**](#accountapitokenscreate2) | **POST** /api/v1/account/api-tokens/ | |
|
|
9
8
|
|[**accountApiTokensDestroy**](#accountapitokensdestroy) | **DELETE** /api/account/api-tokens/{id}/ | |
|
|
10
|
-
|[**accountApiTokensDestroy2**](#accountapitokensdestroy2) | **DELETE** /api/v1/account/api-tokens/{id}/ | |
|
|
11
9
|
|[**accountApiTokensList**](#accountapitokenslist) | **GET** /api/account/api-tokens/ | |
|
|
12
|
-
|[**accountApiTokensList2**](#accountapitokenslist2) | **GET** /api/v1/account/api-tokens/ | |
|
|
13
10
|
|[**accountCompaniesCreate**](#accountcompaniescreate) | **POST** /api/account/companies/ | |
|
|
14
|
-
|[**accountCompaniesCreate2**](#accountcompaniescreate2) | **POST** /api/v1/account/companies/ | |
|
|
15
11
|
|[**accountCompaniesDestroy**](#accountcompaniesdestroy) | **DELETE** /api/account/companies/{id}/ | |
|
|
16
|
-
|[**accountCompaniesDestroy2**](#accountcompaniesdestroy2) | **DELETE** /api/v1/account/companies/{id}/ | |
|
|
17
12
|
|[**accountCompaniesList**](#accountcompanieslist) | **GET** /api/account/companies/ | |
|
|
18
|
-
|[**accountCompaniesList2**](#accountcompanieslist2) | **GET** /api/v1/account/companies/ | |
|
|
19
13
|
|[**accountCompaniesPartialUpdate**](#accountcompaniespartialupdate) | **PATCH** /api/account/companies/{id}/ | |
|
|
20
|
-
|[**accountCompaniesPartialUpdate2**](#accountcompaniespartialupdate2) | **PATCH** /api/v1/account/companies/{id}/ | |
|
|
21
14
|
|[**accountCompaniesRetrieve**](#accountcompaniesretrieve) | **GET** /api/account/companies/{id}/ | |
|
|
22
|
-
|[**accountCompaniesRetrieve2**](#accountcompaniesretrieve2) | **GET** /api/v1/account/companies/{id}/ | |
|
|
23
15
|
|[**accountCompaniesUpdate**](#accountcompaniesupdate) | **PUT** /api/account/companies/{id}/ | |
|
|
24
|
-
|[**accountCompaniesUpdate2**](#accountcompaniesupdate2) | **PUT** /api/v1/account/companies/{id}/ | |
|
|
25
16
|
|[**accountEmailsList**](#accountemailslist) | **GET** /api/account/emails/ | |
|
|
26
|
-
|[**accountEmailsList2**](#accountemailslist2) | **GET** /api/v1/account/emails/ | |
|
|
27
17
|
|[**accountProfilePartialUpdate**](#accountprofilepartialupdate) | **PATCH** /api/account/profile | |
|
|
28
|
-
|[**accountProfilePartialUpdate2**](#accountprofilepartialupdate2) | **PATCH** /api/v1/account/profile | |
|
|
29
18
|
|[**accountProfileRetrieve**](#accountprofileretrieve) | **GET** /api/account/profile | |
|
|
30
|
-
|[**accountProfileRetrieve2**](#accountprofileretrieve2) | **GET** /api/v1/account/profile | |
|
|
31
19
|
|[**accountProfileUpdate**](#accountprofileupdate) | **PUT** /api/account/profile | |
|
|
32
|
-
|[**accountProfileUpdate2**](#accountprofileupdate2) | **PUT** /api/v1/account/profile | |
|
|
33
20
|
|[**accountSshKeysCreate**](#accountsshkeyscreate) | **POST** /api/account/ssh-keys/ | |
|
|
34
|
-
|[**accountSshKeysCreate2**](#accountsshkeyscreate2) | **POST** /api/v1/account/ssh-keys/ | |
|
|
35
21
|
|[**accountSshKeysDestroy**](#accountsshkeysdestroy) | **DELETE** /api/account/ssh-keys/{id}/ | |
|
|
36
|
-
|[**accountSshKeysDestroy2**](#accountsshkeysdestroy2) | **DELETE** /api/v1/account/ssh-keys/{id}/ | |
|
|
37
22
|
|[**accountSshKeysList**](#accountsshkeyslist) | **GET** /api/account/ssh-keys/ | |
|
|
38
|
-
|[**accountSshKeysList2**](#accountsshkeyslist2) | **GET** /api/v1/account/ssh-keys/ | |
|
|
39
23
|
|[**accountSshKeysPartialUpdate**](#accountsshkeyspartialupdate) | **PATCH** /api/account/ssh-keys/{id}/ | |
|
|
40
|
-
|[**accountSshKeysPartialUpdate2**](#accountsshkeyspartialupdate2) | **PATCH** /api/v1/account/ssh-keys/{id}/ | |
|
|
41
24
|
|[**accountSshKeysRetrieve**](#accountsshkeysretrieve) | **GET** /api/account/ssh-keys/{id}/ | |
|
|
42
|
-
|[**accountSshKeysRetrieve2**](#accountsshkeysretrieve2) | **GET** /api/v1/account/ssh-keys/{id}/ | |
|
|
43
25
|
|[**accountSshKeysUpdate**](#accountsshkeysupdate) | **PUT** /api/account/ssh-keys/{id}/ | |
|
|
44
|
-
|[**accountSshKeysUpdate2**](#accountsshkeysupdate2) | **PUT** /api/v1/account/ssh-keys/{id}/ | |
|
|
45
26
|
|
|
46
27
|
# **accountApiTokensCreate**
|
|
47
28
|
> APITokenCreate accountApiTokensCreate(aPITokenCreate)
|
|
@@ -74,58 +55,6 @@ const { status, data } = await apiInstance.accountApiTokensCreate(
|
|
|
74
55
|
| **aPITokenCreate** | **APITokenCreate**| | |
|
|
75
56
|
|
|
76
57
|
|
|
77
|
-
### Return type
|
|
78
|
-
|
|
79
|
-
**APITokenCreate**
|
|
80
|
-
|
|
81
|
-
### Authorization
|
|
82
|
-
|
|
83
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
84
|
-
|
|
85
|
-
### HTTP request headers
|
|
86
|
-
|
|
87
|
-
- **Content-Type**: application/json
|
|
88
|
-
- **Accept**: application/json
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
### HTTP response details
|
|
92
|
-
| Status code | Description | Response headers |
|
|
93
|
-
|-------------|-------------|------------------|
|
|
94
|
-
|**201** | | - |
|
|
95
|
-
|
|
96
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
97
|
-
|
|
98
|
-
# **accountApiTokensCreate2**
|
|
99
|
-
> APITokenCreate accountApiTokensCreate2(aPITokenCreate)
|
|
100
|
-
|
|
101
|
-
Manage your API tokens
|
|
102
|
-
|
|
103
|
-
### Example
|
|
104
|
-
|
|
105
|
-
```typescript
|
|
106
|
-
import {
|
|
107
|
-
AccountApi,
|
|
108
|
-
Configuration,
|
|
109
|
-
APITokenCreate
|
|
110
|
-
} from '@pidginhost/sdk';
|
|
111
|
-
|
|
112
|
-
const configuration = new Configuration();
|
|
113
|
-
const apiInstance = new AccountApi(configuration);
|
|
114
|
-
|
|
115
|
-
let aPITokenCreate: APITokenCreate; //
|
|
116
|
-
|
|
117
|
-
const { status, data } = await apiInstance.accountApiTokensCreate2(
|
|
118
|
-
aPITokenCreate
|
|
119
|
-
);
|
|
120
|
-
```
|
|
121
|
-
|
|
122
|
-
### Parameters
|
|
123
|
-
|
|
124
|
-
|Name | Type | Description | Notes|
|
|
125
|
-
|------------- | ------------- | ------------- | -------------|
|
|
126
|
-
| **aPITokenCreate** | **APITokenCreate**| | |
|
|
127
|
-
|
|
128
|
-
|
|
129
58
|
### Return type
|
|
130
59
|
|
|
131
60
|
**APITokenCreate**
|
|
@@ -177,57 +106,6 @@ const { status, data } = await apiInstance.accountApiTokensDestroy(
|
|
|
177
106
|
| **id** | [**string**] | | defaults to undefined|
|
|
178
107
|
|
|
179
108
|
|
|
180
|
-
### Return type
|
|
181
|
-
|
|
182
|
-
void (empty response body)
|
|
183
|
-
|
|
184
|
-
### Authorization
|
|
185
|
-
|
|
186
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
187
|
-
|
|
188
|
-
### HTTP request headers
|
|
189
|
-
|
|
190
|
-
- **Content-Type**: Not defined
|
|
191
|
-
- **Accept**: Not defined
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
### HTTP response details
|
|
195
|
-
| Status code | Description | Response headers |
|
|
196
|
-
|-------------|-------------|------------------|
|
|
197
|
-
|**204** | No response body | - |
|
|
198
|
-
|
|
199
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
200
|
-
|
|
201
|
-
# **accountApiTokensDestroy2**
|
|
202
|
-
> accountApiTokensDestroy2()
|
|
203
|
-
|
|
204
|
-
Manage your API tokens
|
|
205
|
-
|
|
206
|
-
### Example
|
|
207
|
-
|
|
208
|
-
```typescript
|
|
209
|
-
import {
|
|
210
|
-
AccountApi,
|
|
211
|
-
Configuration
|
|
212
|
-
} from '@pidginhost/sdk';
|
|
213
|
-
|
|
214
|
-
const configuration = new Configuration();
|
|
215
|
-
const apiInstance = new AccountApi(configuration);
|
|
216
|
-
|
|
217
|
-
let id: string; // (default to undefined)
|
|
218
|
-
|
|
219
|
-
const { status, data } = await apiInstance.accountApiTokensDestroy2(
|
|
220
|
-
id
|
|
221
|
-
);
|
|
222
|
-
```
|
|
223
|
-
|
|
224
|
-
### Parameters
|
|
225
|
-
|
|
226
|
-
|Name | Type | Description | Notes|
|
|
227
|
-
|------------- | ------------- | ------------- | -------------|
|
|
228
|
-
| **id** | [**string**] | | defaults to undefined|
|
|
229
|
-
|
|
230
|
-
|
|
231
109
|
### Return type
|
|
232
110
|
|
|
233
111
|
void (empty response body)
|
|
@@ -279,57 +157,6 @@ const { status, data } = await apiInstance.accountApiTokensList(
|
|
|
279
157
|
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
280
158
|
|
|
281
159
|
|
|
282
|
-
### Return type
|
|
283
|
-
|
|
284
|
-
**PaginatedAPITokenListList**
|
|
285
|
-
|
|
286
|
-
### Authorization
|
|
287
|
-
|
|
288
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
289
|
-
|
|
290
|
-
### HTTP request headers
|
|
291
|
-
|
|
292
|
-
- **Content-Type**: Not defined
|
|
293
|
-
- **Accept**: application/json
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
### HTTP response details
|
|
297
|
-
| Status code | Description | Response headers |
|
|
298
|
-
|-------------|-------------|------------------|
|
|
299
|
-
|**200** | | - |
|
|
300
|
-
|
|
301
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
302
|
-
|
|
303
|
-
# **accountApiTokensList2**
|
|
304
|
-
> PaginatedAPITokenListList accountApiTokensList2()
|
|
305
|
-
|
|
306
|
-
Manage your API tokens
|
|
307
|
-
|
|
308
|
-
### Example
|
|
309
|
-
|
|
310
|
-
```typescript
|
|
311
|
-
import {
|
|
312
|
-
AccountApi,
|
|
313
|
-
Configuration
|
|
314
|
-
} from '@pidginhost/sdk';
|
|
315
|
-
|
|
316
|
-
const configuration = new Configuration();
|
|
317
|
-
const apiInstance = new AccountApi(configuration);
|
|
318
|
-
|
|
319
|
-
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
320
|
-
|
|
321
|
-
const { status, data } = await apiInstance.accountApiTokensList2(
|
|
322
|
-
page
|
|
323
|
-
);
|
|
324
|
-
```
|
|
325
|
-
|
|
326
|
-
### Parameters
|
|
327
|
-
|
|
328
|
-
|Name | Type | Description | Notes|
|
|
329
|
-
|------------- | ------------- | ------------- | -------------|
|
|
330
|
-
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
331
|
-
|
|
332
|
-
|
|
333
160
|
### Return type
|
|
334
161
|
|
|
335
162
|
**PaginatedAPITokenListList**
|
|
@@ -382,58 +209,6 @@ const { status, data } = await apiInstance.accountCompaniesCreate(
|
|
|
382
209
|
| **company** | **Company**| | |
|
|
383
210
|
|
|
384
211
|
|
|
385
|
-
### Return type
|
|
386
|
-
|
|
387
|
-
**Company**
|
|
388
|
-
|
|
389
|
-
### Authorization
|
|
390
|
-
|
|
391
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
392
|
-
|
|
393
|
-
### HTTP request headers
|
|
394
|
-
|
|
395
|
-
- **Content-Type**: application/json
|
|
396
|
-
- **Accept**: application/json
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
### HTTP response details
|
|
400
|
-
| Status code | Description | Response headers |
|
|
401
|
-
|-------------|-------------|------------------|
|
|
402
|
-
|**201** | | - |
|
|
403
|
-
|
|
404
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
405
|
-
|
|
406
|
-
# **accountCompaniesCreate2**
|
|
407
|
-
> Company accountCompaniesCreate2(company)
|
|
408
|
-
|
|
409
|
-
Manage your companies
|
|
410
|
-
|
|
411
|
-
### Example
|
|
412
|
-
|
|
413
|
-
```typescript
|
|
414
|
-
import {
|
|
415
|
-
AccountApi,
|
|
416
|
-
Configuration,
|
|
417
|
-
Company
|
|
418
|
-
} from '@pidginhost/sdk';
|
|
419
|
-
|
|
420
|
-
const configuration = new Configuration();
|
|
421
|
-
const apiInstance = new AccountApi(configuration);
|
|
422
|
-
|
|
423
|
-
let company: Company; //
|
|
424
|
-
|
|
425
|
-
const { status, data } = await apiInstance.accountCompaniesCreate2(
|
|
426
|
-
company
|
|
427
|
-
);
|
|
428
|
-
```
|
|
429
|
-
|
|
430
|
-
### Parameters
|
|
431
|
-
|
|
432
|
-
|Name | Type | Description | Notes|
|
|
433
|
-
|------------- | ------------- | ------------- | -------------|
|
|
434
|
-
| **company** | **Company**| | |
|
|
435
|
-
|
|
436
|
-
|
|
437
212
|
### Return type
|
|
438
213
|
|
|
439
214
|
**Company**
|
|
@@ -458,783 +233,7 @@ const { status, data } = await apiInstance.accountCompaniesCreate2(
|
|
|
458
233
|
# **accountCompaniesDestroy**
|
|
459
234
|
> accountCompaniesDestroy()
|
|
460
235
|
|
|
461
|
-
Manage your companies
|
|
462
|
-
|
|
463
|
-
### Example
|
|
464
|
-
|
|
465
|
-
```typescript
|
|
466
|
-
import {
|
|
467
|
-
AccountApi,
|
|
468
|
-
Configuration
|
|
469
|
-
} from '@pidginhost/sdk';
|
|
470
|
-
|
|
471
|
-
const configuration = new Configuration();
|
|
472
|
-
const apiInstance = new AccountApi(configuration);
|
|
473
|
-
|
|
474
|
-
let id: number; //A unique integer value identifying this company. (default to undefined)
|
|
475
|
-
|
|
476
|
-
const { status, data } = await apiInstance.accountCompaniesDestroy(
|
|
477
|
-
id
|
|
478
|
-
);
|
|
479
|
-
```
|
|
480
|
-
|
|
481
|
-
### Parameters
|
|
482
|
-
|
|
483
|
-
|Name | Type | Description | Notes|
|
|
484
|
-
|------------- | ------------- | ------------- | -------------|
|
|
485
|
-
| **id** | [**number**] | A unique integer value identifying this company. | defaults to undefined|
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
### Return type
|
|
489
|
-
|
|
490
|
-
void (empty response body)
|
|
491
|
-
|
|
492
|
-
### Authorization
|
|
493
|
-
|
|
494
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
495
|
-
|
|
496
|
-
### HTTP request headers
|
|
497
|
-
|
|
498
|
-
- **Content-Type**: Not defined
|
|
499
|
-
- **Accept**: Not defined
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
### HTTP response details
|
|
503
|
-
| Status code | Description | Response headers |
|
|
504
|
-
|-------------|-------------|------------------|
|
|
505
|
-
|**204** | No response body | - |
|
|
506
|
-
|
|
507
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
508
|
-
|
|
509
|
-
# **accountCompaniesDestroy2**
|
|
510
|
-
> accountCompaniesDestroy2()
|
|
511
|
-
|
|
512
|
-
Manage your companies
|
|
513
|
-
|
|
514
|
-
### Example
|
|
515
|
-
|
|
516
|
-
```typescript
|
|
517
|
-
import {
|
|
518
|
-
AccountApi,
|
|
519
|
-
Configuration
|
|
520
|
-
} from '@pidginhost/sdk';
|
|
521
|
-
|
|
522
|
-
const configuration = new Configuration();
|
|
523
|
-
const apiInstance = new AccountApi(configuration);
|
|
524
|
-
|
|
525
|
-
let id: number; //A unique integer value identifying this company. (default to undefined)
|
|
526
|
-
|
|
527
|
-
const { status, data } = await apiInstance.accountCompaniesDestroy2(
|
|
528
|
-
id
|
|
529
|
-
);
|
|
530
|
-
```
|
|
531
|
-
|
|
532
|
-
### Parameters
|
|
533
|
-
|
|
534
|
-
|Name | Type | Description | Notes|
|
|
535
|
-
|------------- | ------------- | ------------- | -------------|
|
|
536
|
-
| **id** | [**number**] | A unique integer value identifying this company. | defaults to undefined|
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
### Return type
|
|
540
|
-
|
|
541
|
-
void (empty response body)
|
|
542
|
-
|
|
543
|
-
### Authorization
|
|
544
|
-
|
|
545
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
546
|
-
|
|
547
|
-
### HTTP request headers
|
|
548
|
-
|
|
549
|
-
- **Content-Type**: Not defined
|
|
550
|
-
- **Accept**: Not defined
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
### HTTP response details
|
|
554
|
-
| Status code | Description | Response headers |
|
|
555
|
-
|-------------|-------------|------------------|
|
|
556
|
-
|**204** | No response body | - |
|
|
557
|
-
|
|
558
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
559
|
-
|
|
560
|
-
# **accountCompaniesList**
|
|
561
|
-
> PaginatedCompanyList accountCompaniesList()
|
|
562
|
-
|
|
563
|
-
Manage your companies
|
|
564
|
-
|
|
565
|
-
### Example
|
|
566
|
-
|
|
567
|
-
```typescript
|
|
568
|
-
import {
|
|
569
|
-
AccountApi,
|
|
570
|
-
Configuration
|
|
571
|
-
} from '@pidginhost/sdk';
|
|
572
|
-
|
|
573
|
-
const configuration = new Configuration();
|
|
574
|
-
const apiInstance = new AccountApi(configuration);
|
|
575
|
-
|
|
576
|
-
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
577
|
-
|
|
578
|
-
const { status, data } = await apiInstance.accountCompaniesList(
|
|
579
|
-
page
|
|
580
|
-
);
|
|
581
|
-
```
|
|
582
|
-
|
|
583
|
-
### Parameters
|
|
584
|
-
|
|
585
|
-
|Name | Type | Description | Notes|
|
|
586
|
-
|------------- | ------------- | ------------- | -------------|
|
|
587
|
-
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
### Return type
|
|
591
|
-
|
|
592
|
-
**PaginatedCompanyList**
|
|
593
|
-
|
|
594
|
-
### Authorization
|
|
595
|
-
|
|
596
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
597
|
-
|
|
598
|
-
### HTTP request headers
|
|
599
|
-
|
|
600
|
-
- **Content-Type**: Not defined
|
|
601
|
-
- **Accept**: application/json
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
### HTTP response details
|
|
605
|
-
| Status code | Description | Response headers |
|
|
606
|
-
|-------------|-------------|------------------|
|
|
607
|
-
|**200** | | - |
|
|
608
|
-
|
|
609
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
610
|
-
|
|
611
|
-
# **accountCompaniesList2**
|
|
612
|
-
> PaginatedCompanyList accountCompaniesList2()
|
|
613
|
-
|
|
614
|
-
Manage your companies
|
|
615
|
-
|
|
616
|
-
### Example
|
|
617
|
-
|
|
618
|
-
```typescript
|
|
619
|
-
import {
|
|
620
|
-
AccountApi,
|
|
621
|
-
Configuration
|
|
622
|
-
} from '@pidginhost/sdk';
|
|
623
|
-
|
|
624
|
-
const configuration = new Configuration();
|
|
625
|
-
const apiInstance = new AccountApi(configuration);
|
|
626
|
-
|
|
627
|
-
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
628
|
-
|
|
629
|
-
const { status, data } = await apiInstance.accountCompaniesList2(
|
|
630
|
-
page
|
|
631
|
-
);
|
|
632
|
-
```
|
|
633
|
-
|
|
634
|
-
### Parameters
|
|
635
|
-
|
|
636
|
-
|Name | Type | Description | Notes|
|
|
637
|
-
|------------- | ------------- | ------------- | -------------|
|
|
638
|
-
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
### Return type
|
|
642
|
-
|
|
643
|
-
**PaginatedCompanyList**
|
|
644
|
-
|
|
645
|
-
### Authorization
|
|
646
|
-
|
|
647
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
648
|
-
|
|
649
|
-
### HTTP request headers
|
|
650
|
-
|
|
651
|
-
- **Content-Type**: Not defined
|
|
652
|
-
- **Accept**: application/json
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
### HTTP response details
|
|
656
|
-
| Status code | Description | Response headers |
|
|
657
|
-
|-------------|-------------|------------------|
|
|
658
|
-
|**200** | | - |
|
|
659
|
-
|
|
660
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
661
|
-
|
|
662
|
-
# **accountCompaniesPartialUpdate**
|
|
663
|
-
> Company accountCompaniesPartialUpdate()
|
|
664
|
-
|
|
665
|
-
Manage your companies
|
|
666
|
-
|
|
667
|
-
### Example
|
|
668
|
-
|
|
669
|
-
```typescript
|
|
670
|
-
import {
|
|
671
|
-
AccountApi,
|
|
672
|
-
Configuration,
|
|
673
|
-
PatchedCompany
|
|
674
|
-
} from '@pidginhost/sdk';
|
|
675
|
-
|
|
676
|
-
const configuration = new Configuration();
|
|
677
|
-
const apiInstance = new AccountApi(configuration);
|
|
678
|
-
|
|
679
|
-
let id: number; //A unique integer value identifying this company. (default to undefined)
|
|
680
|
-
let patchedCompany: PatchedCompany; // (optional)
|
|
681
|
-
|
|
682
|
-
const { status, data } = await apiInstance.accountCompaniesPartialUpdate(
|
|
683
|
-
id,
|
|
684
|
-
patchedCompany
|
|
685
|
-
);
|
|
686
|
-
```
|
|
687
|
-
|
|
688
|
-
### Parameters
|
|
689
|
-
|
|
690
|
-
|Name | Type | Description | Notes|
|
|
691
|
-
|------------- | ------------- | ------------- | -------------|
|
|
692
|
-
| **patchedCompany** | **PatchedCompany**| | |
|
|
693
|
-
| **id** | [**number**] | A unique integer value identifying this company. | defaults to undefined|
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
### Return type
|
|
697
|
-
|
|
698
|
-
**Company**
|
|
699
|
-
|
|
700
|
-
### Authorization
|
|
701
|
-
|
|
702
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
703
|
-
|
|
704
|
-
### HTTP request headers
|
|
705
|
-
|
|
706
|
-
- **Content-Type**: application/json
|
|
707
|
-
- **Accept**: application/json
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
### HTTP response details
|
|
711
|
-
| Status code | Description | Response headers |
|
|
712
|
-
|-------------|-------------|------------------|
|
|
713
|
-
|**200** | | - |
|
|
714
|
-
|
|
715
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
716
|
-
|
|
717
|
-
# **accountCompaniesPartialUpdate2**
|
|
718
|
-
> Company accountCompaniesPartialUpdate2()
|
|
719
|
-
|
|
720
|
-
Manage your companies
|
|
721
|
-
|
|
722
|
-
### Example
|
|
723
|
-
|
|
724
|
-
```typescript
|
|
725
|
-
import {
|
|
726
|
-
AccountApi,
|
|
727
|
-
Configuration,
|
|
728
|
-
PatchedCompany
|
|
729
|
-
} from '@pidginhost/sdk';
|
|
730
|
-
|
|
731
|
-
const configuration = new Configuration();
|
|
732
|
-
const apiInstance = new AccountApi(configuration);
|
|
733
|
-
|
|
734
|
-
let id: number; //A unique integer value identifying this company. (default to undefined)
|
|
735
|
-
let patchedCompany: PatchedCompany; // (optional)
|
|
736
|
-
|
|
737
|
-
const { status, data } = await apiInstance.accountCompaniesPartialUpdate2(
|
|
738
|
-
id,
|
|
739
|
-
patchedCompany
|
|
740
|
-
);
|
|
741
|
-
```
|
|
742
|
-
|
|
743
|
-
### Parameters
|
|
744
|
-
|
|
745
|
-
|Name | Type | Description | Notes|
|
|
746
|
-
|------------- | ------------- | ------------- | -------------|
|
|
747
|
-
| **patchedCompany** | **PatchedCompany**| | |
|
|
748
|
-
| **id** | [**number**] | A unique integer value identifying this company. | defaults to undefined|
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
### Return type
|
|
752
|
-
|
|
753
|
-
**Company**
|
|
754
|
-
|
|
755
|
-
### Authorization
|
|
756
|
-
|
|
757
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
758
|
-
|
|
759
|
-
### HTTP request headers
|
|
760
|
-
|
|
761
|
-
- **Content-Type**: application/json
|
|
762
|
-
- **Accept**: application/json
|
|
763
|
-
|
|
764
|
-
|
|
765
|
-
### HTTP response details
|
|
766
|
-
| Status code | Description | Response headers |
|
|
767
|
-
|-------------|-------------|------------------|
|
|
768
|
-
|**200** | | - |
|
|
769
|
-
|
|
770
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
771
|
-
|
|
772
|
-
# **accountCompaniesRetrieve**
|
|
773
|
-
> Company accountCompaniesRetrieve()
|
|
774
|
-
|
|
775
|
-
Manage your companies
|
|
776
|
-
|
|
777
|
-
### Example
|
|
778
|
-
|
|
779
|
-
```typescript
|
|
780
|
-
import {
|
|
781
|
-
AccountApi,
|
|
782
|
-
Configuration
|
|
783
|
-
} from '@pidginhost/sdk';
|
|
784
|
-
|
|
785
|
-
const configuration = new Configuration();
|
|
786
|
-
const apiInstance = new AccountApi(configuration);
|
|
787
|
-
|
|
788
|
-
let id: number; //A unique integer value identifying this company. (default to undefined)
|
|
789
|
-
|
|
790
|
-
const { status, data } = await apiInstance.accountCompaniesRetrieve(
|
|
791
|
-
id
|
|
792
|
-
);
|
|
793
|
-
```
|
|
794
|
-
|
|
795
|
-
### Parameters
|
|
796
|
-
|
|
797
|
-
|Name | Type | Description | Notes|
|
|
798
|
-
|------------- | ------------- | ------------- | -------------|
|
|
799
|
-
| **id** | [**number**] | A unique integer value identifying this company. | defaults to undefined|
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
### Return type
|
|
803
|
-
|
|
804
|
-
**Company**
|
|
805
|
-
|
|
806
|
-
### Authorization
|
|
807
|
-
|
|
808
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
809
|
-
|
|
810
|
-
### HTTP request headers
|
|
811
|
-
|
|
812
|
-
- **Content-Type**: Not defined
|
|
813
|
-
- **Accept**: application/json
|
|
814
|
-
|
|
815
|
-
|
|
816
|
-
### HTTP response details
|
|
817
|
-
| Status code | Description | Response headers |
|
|
818
|
-
|-------------|-------------|------------------|
|
|
819
|
-
|**200** | | - |
|
|
820
|
-
|
|
821
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
822
|
-
|
|
823
|
-
# **accountCompaniesRetrieve2**
|
|
824
|
-
> Company accountCompaniesRetrieve2()
|
|
825
|
-
|
|
826
|
-
Manage your companies
|
|
827
|
-
|
|
828
|
-
### Example
|
|
829
|
-
|
|
830
|
-
```typescript
|
|
831
|
-
import {
|
|
832
|
-
AccountApi,
|
|
833
|
-
Configuration
|
|
834
|
-
} from '@pidginhost/sdk';
|
|
835
|
-
|
|
836
|
-
const configuration = new Configuration();
|
|
837
|
-
const apiInstance = new AccountApi(configuration);
|
|
838
|
-
|
|
839
|
-
let id: number; //A unique integer value identifying this company. (default to undefined)
|
|
840
|
-
|
|
841
|
-
const { status, data } = await apiInstance.accountCompaniesRetrieve2(
|
|
842
|
-
id
|
|
843
|
-
);
|
|
844
|
-
```
|
|
845
|
-
|
|
846
|
-
### Parameters
|
|
847
|
-
|
|
848
|
-
|Name | Type | Description | Notes|
|
|
849
|
-
|------------- | ------------- | ------------- | -------------|
|
|
850
|
-
| **id** | [**number**] | A unique integer value identifying this company. | defaults to undefined|
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
### Return type
|
|
854
|
-
|
|
855
|
-
**Company**
|
|
856
|
-
|
|
857
|
-
### Authorization
|
|
858
|
-
|
|
859
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
860
|
-
|
|
861
|
-
### HTTP request headers
|
|
862
|
-
|
|
863
|
-
- **Content-Type**: Not defined
|
|
864
|
-
- **Accept**: application/json
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
### HTTP response details
|
|
868
|
-
| Status code | Description | Response headers |
|
|
869
|
-
|-------------|-------------|------------------|
|
|
870
|
-
|**200** | | - |
|
|
871
|
-
|
|
872
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
873
|
-
|
|
874
|
-
# **accountCompaniesUpdate**
|
|
875
|
-
> Company accountCompaniesUpdate(company)
|
|
876
|
-
|
|
877
|
-
Manage your companies
|
|
878
|
-
|
|
879
|
-
### Example
|
|
880
|
-
|
|
881
|
-
```typescript
|
|
882
|
-
import {
|
|
883
|
-
AccountApi,
|
|
884
|
-
Configuration,
|
|
885
|
-
Company
|
|
886
|
-
} from '@pidginhost/sdk';
|
|
887
|
-
|
|
888
|
-
const configuration = new Configuration();
|
|
889
|
-
const apiInstance = new AccountApi(configuration);
|
|
890
|
-
|
|
891
|
-
let id: number; //A unique integer value identifying this company. (default to undefined)
|
|
892
|
-
let company: Company; //
|
|
893
|
-
|
|
894
|
-
const { status, data } = await apiInstance.accountCompaniesUpdate(
|
|
895
|
-
id,
|
|
896
|
-
company
|
|
897
|
-
);
|
|
898
|
-
```
|
|
899
|
-
|
|
900
|
-
### Parameters
|
|
901
|
-
|
|
902
|
-
|Name | Type | Description | Notes|
|
|
903
|
-
|------------- | ------------- | ------------- | -------------|
|
|
904
|
-
| **company** | **Company**| | |
|
|
905
|
-
| **id** | [**number**] | A unique integer value identifying this company. | defaults to undefined|
|
|
906
|
-
|
|
907
|
-
|
|
908
|
-
### Return type
|
|
909
|
-
|
|
910
|
-
**Company**
|
|
911
|
-
|
|
912
|
-
### Authorization
|
|
913
|
-
|
|
914
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
915
|
-
|
|
916
|
-
### HTTP request headers
|
|
917
|
-
|
|
918
|
-
- **Content-Type**: application/json
|
|
919
|
-
- **Accept**: application/json
|
|
920
|
-
|
|
921
|
-
|
|
922
|
-
### HTTP response details
|
|
923
|
-
| Status code | Description | Response headers |
|
|
924
|
-
|-------------|-------------|------------------|
|
|
925
|
-
|**200** | | - |
|
|
926
|
-
|
|
927
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
928
|
-
|
|
929
|
-
# **accountCompaniesUpdate2**
|
|
930
|
-
> Company accountCompaniesUpdate2(company)
|
|
931
|
-
|
|
932
|
-
Manage your companies
|
|
933
|
-
|
|
934
|
-
### Example
|
|
935
|
-
|
|
936
|
-
```typescript
|
|
937
|
-
import {
|
|
938
|
-
AccountApi,
|
|
939
|
-
Configuration,
|
|
940
|
-
Company
|
|
941
|
-
} from '@pidginhost/sdk';
|
|
942
|
-
|
|
943
|
-
const configuration = new Configuration();
|
|
944
|
-
const apiInstance = new AccountApi(configuration);
|
|
945
|
-
|
|
946
|
-
let id: number; //A unique integer value identifying this company. (default to undefined)
|
|
947
|
-
let company: Company; //
|
|
948
|
-
|
|
949
|
-
const { status, data } = await apiInstance.accountCompaniesUpdate2(
|
|
950
|
-
id,
|
|
951
|
-
company
|
|
952
|
-
);
|
|
953
|
-
```
|
|
954
|
-
|
|
955
|
-
### Parameters
|
|
956
|
-
|
|
957
|
-
|Name | Type | Description | Notes|
|
|
958
|
-
|------------- | ------------- | ------------- | -------------|
|
|
959
|
-
| **company** | **Company**| | |
|
|
960
|
-
| **id** | [**number**] | A unique integer value identifying this company. | defaults to undefined|
|
|
961
|
-
|
|
962
|
-
|
|
963
|
-
### Return type
|
|
964
|
-
|
|
965
|
-
**Company**
|
|
966
|
-
|
|
967
|
-
### Authorization
|
|
968
|
-
|
|
969
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
970
|
-
|
|
971
|
-
### HTTP request headers
|
|
972
|
-
|
|
973
|
-
- **Content-Type**: application/json
|
|
974
|
-
- **Accept**: application/json
|
|
975
|
-
|
|
976
|
-
|
|
977
|
-
### HTTP response details
|
|
978
|
-
| Status code | Description | Response headers |
|
|
979
|
-
|-------------|-------------|------------------|
|
|
980
|
-
|**200** | | - |
|
|
981
|
-
|
|
982
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
983
|
-
|
|
984
|
-
# **accountEmailsList**
|
|
985
|
-
> PaginatedEmailHistoryList accountEmailsList()
|
|
986
|
-
|
|
987
|
-
List email history for the authenticated user.
|
|
988
|
-
|
|
989
|
-
### Example
|
|
990
|
-
|
|
991
|
-
```typescript
|
|
992
|
-
import {
|
|
993
|
-
AccountApi,
|
|
994
|
-
Configuration
|
|
995
|
-
} from '@pidginhost/sdk';
|
|
996
|
-
|
|
997
|
-
const configuration = new Configuration();
|
|
998
|
-
const apiInstance = new AccountApi(configuration);
|
|
999
|
-
|
|
1000
|
-
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
1001
|
-
|
|
1002
|
-
const { status, data } = await apiInstance.accountEmailsList(
|
|
1003
|
-
page
|
|
1004
|
-
);
|
|
1005
|
-
```
|
|
1006
|
-
|
|
1007
|
-
### Parameters
|
|
1008
|
-
|
|
1009
|
-
|Name | Type | Description | Notes|
|
|
1010
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1011
|
-
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
### Return type
|
|
1015
|
-
|
|
1016
|
-
**PaginatedEmailHistoryList**
|
|
1017
|
-
|
|
1018
|
-
### Authorization
|
|
1019
|
-
|
|
1020
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1021
|
-
|
|
1022
|
-
### HTTP request headers
|
|
1023
|
-
|
|
1024
|
-
- **Content-Type**: Not defined
|
|
1025
|
-
- **Accept**: application/json
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
### HTTP response details
|
|
1029
|
-
| Status code | Description | Response headers |
|
|
1030
|
-
|-------------|-------------|------------------|
|
|
1031
|
-
|**200** | | - |
|
|
1032
|
-
|
|
1033
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1034
|
-
|
|
1035
|
-
# **accountEmailsList2**
|
|
1036
|
-
> PaginatedEmailHistoryList accountEmailsList2()
|
|
1037
|
-
|
|
1038
|
-
List email history for the authenticated user.
|
|
1039
|
-
|
|
1040
|
-
### Example
|
|
1041
|
-
|
|
1042
|
-
```typescript
|
|
1043
|
-
import {
|
|
1044
|
-
AccountApi,
|
|
1045
|
-
Configuration
|
|
1046
|
-
} from '@pidginhost/sdk';
|
|
1047
|
-
|
|
1048
|
-
const configuration = new Configuration();
|
|
1049
|
-
const apiInstance = new AccountApi(configuration);
|
|
1050
|
-
|
|
1051
|
-
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
1052
|
-
|
|
1053
|
-
const { status, data } = await apiInstance.accountEmailsList2(
|
|
1054
|
-
page
|
|
1055
|
-
);
|
|
1056
|
-
```
|
|
1057
|
-
|
|
1058
|
-
### Parameters
|
|
1059
|
-
|
|
1060
|
-
|Name | Type | Description | Notes|
|
|
1061
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1062
|
-
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
### Return type
|
|
1066
|
-
|
|
1067
|
-
**PaginatedEmailHistoryList**
|
|
1068
|
-
|
|
1069
|
-
### Authorization
|
|
1070
|
-
|
|
1071
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1072
|
-
|
|
1073
|
-
### HTTP request headers
|
|
1074
|
-
|
|
1075
|
-
- **Content-Type**: Not defined
|
|
1076
|
-
- **Accept**: application/json
|
|
1077
|
-
|
|
1078
|
-
|
|
1079
|
-
### HTTP response details
|
|
1080
|
-
| Status code | Description | Response headers |
|
|
1081
|
-
|-------------|-------------|------------------|
|
|
1082
|
-
|**200** | | - |
|
|
1083
|
-
|
|
1084
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1085
|
-
|
|
1086
|
-
# **accountProfilePartialUpdate**
|
|
1087
|
-
> Profile accountProfilePartialUpdate()
|
|
1088
|
-
|
|
1089
|
-
Manage your profile data
|
|
1090
|
-
|
|
1091
|
-
### Example
|
|
1092
|
-
|
|
1093
|
-
```typescript
|
|
1094
|
-
import {
|
|
1095
|
-
AccountApi,
|
|
1096
|
-
Configuration,
|
|
1097
|
-
PatchedProfile
|
|
1098
|
-
} from '@pidginhost/sdk';
|
|
1099
|
-
|
|
1100
|
-
const configuration = new Configuration();
|
|
1101
|
-
const apiInstance = new AccountApi(configuration);
|
|
1102
|
-
|
|
1103
|
-
let patchedProfile: PatchedProfile; // (optional)
|
|
1104
|
-
|
|
1105
|
-
const { status, data } = await apiInstance.accountProfilePartialUpdate(
|
|
1106
|
-
patchedProfile
|
|
1107
|
-
);
|
|
1108
|
-
```
|
|
1109
|
-
|
|
1110
|
-
### Parameters
|
|
1111
|
-
|
|
1112
|
-
|Name | Type | Description | Notes|
|
|
1113
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1114
|
-
| **patchedProfile** | **PatchedProfile**| | |
|
|
1115
|
-
|
|
1116
|
-
|
|
1117
|
-
### Return type
|
|
1118
|
-
|
|
1119
|
-
**Profile**
|
|
1120
|
-
|
|
1121
|
-
### Authorization
|
|
1122
|
-
|
|
1123
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1124
|
-
|
|
1125
|
-
### HTTP request headers
|
|
1126
|
-
|
|
1127
|
-
- **Content-Type**: application/json
|
|
1128
|
-
- **Accept**: application/json
|
|
1129
|
-
|
|
1130
|
-
|
|
1131
|
-
### HTTP response details
|
|
1132
|
-
| Status code | Description | Response headers |
|
|
1133
|
-
|-------------|-------------|------------------|
|
|
1134
|
-
|**200** | | - |
|
|
1135
|
-
|
|
1136
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1137
|
-
|
|
1138
|
-
# **accountProfilePartialUpdate2**
|
|
1139
|
-
> Profile accountProfilePartialUpdate2()
|
|
1140
|
-
|
|
1141
|
-
Manage your profile data
|
|
1142
|
-
|
|
1143
|
-
### Example
|
|
1144
|
-
|
|
1145
|
-
```typescript
|
|
1146
|
-
import {
|
|
1147
|
-
AccountApi,
|
|
1148
|
-
Configuration,
|
|
1149
|
-
PatchedProfile
|
|
1150
|
-
} from '@pidginhost/sdk';
|
|
1151
|
-
|
|
1152
|
-
const configuration = new Configuration();
|
|
1153
|
-
const apiInstance = new AccountApi(configuration);
|
|
1154
|
-
|
|
1155
|
-
let patchedProfile: PatchedProfile; // (optional)
|
|
1156
|
-
|
|
1157
|
-
const { status, data } = await apiInstance.accountProfilePartialUpdate2(
|
|
1158
|
-
patchedProfile
|
|
1159
|
-
);
|
|
1160
|
-
```
|
|
1161
|
-
|
|
1162
|
-
### Parameters
|
|
1163
|
-
|
|
1164
|
-
|Name | Type | Description | Notes|
|
|
1165
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1166
|
-
| **patchedProfile** | **PatchedProfile**| | |
|
|
1167
|
-
|
|
1168
|
-
|
|
1169
|
-
### Return type
|
|
1170
|
-
|
|
1171
|
-
**Profile**
|
|
1172
|
-
|
|
1173
|
-
### Authorization
|
|
1174
|
-
|
|
1175
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1176
|
-
|
|
1177
|
-
### HTTP request headers
|
|
1178
|
-
|
|
1179
|
-
- **Content-Type**: application/json
|
|
1180
|
-
- **Accept**: application/json
|
|
1181
|
-
|
|
1182
|
-
|
|
1183
|
-
### HTTP response details
|
|
1184
|
-
| Status code | Description | Response headers |
|
|
1185
|
-
|-------------|-------------|------------------|
|
|
1186
|
-
|**200** | | - |
|
|
1187
|
-
|
|
1188
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1189
|
-
|
|
1190
|
-
# **accountProfileRetrieve**
|
|
1191
|
-
> Profile accountProfileRetrieve()
|
|
1192
|
-
|
|
1193
|
-
Manage your profile data
|
|
1194
|
-
|
|
1195
|
-
### Example
|
|
1196
|
-
|
|
1197
|
-
```typescript
|
|
1198
|
-
import {
|
|
1199
|
-
AccountApi,
|
|
1200
|
-
Configuration
|
|
1201
|
-
} from '@pidginhost/sdk';
|
|
1202
|
-
|
|
1203
|
-
const configuration = new Configuration();
|
|
1204
|
-
const apiInstance = new AccountApi(configuration);
|
|
1205
|
-
|
|
1206
|
-
const { status, data } = await apiInstance.accountProfileRetrieve();
|
|
1207
|
-
```
|
|
1208
|
-
|
|
1209
|
-
### Parameters
|
|
1210
|
-
This endpoint does not have any parameters.
|
|
1211
|
-
|
|
1212
|
-
|
|
1213
|
-
### Return type
|
|
1214
|
-
|
|
1215
|
-
**Profile**
|
|
1216
|
-
|
|
1217
|
-
### Authorization
|
|
1218
|
-
|
|
1219
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1220
|
-
|
|
1221
|
-
### HTTP request headers
|
|
1222
|
-
|
|
1223
|
-
- **Content-Type**: Not defined
|
|
1224
|
-
- **Accept**: application/json
|
|
1225
|
-
|
|
1226
|
-
|
|
1227
|
-
### HTTP response details
|
|
1228
|
-
| Status code | Description | Response headers |
|
|
1229
|
-
|-------------|-------------|------------------|
|
|
1230
|
-
|**200** | | - |
|
|
1231
|
-
|
|
1232
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1233
|
-
|
|
1234
|
-
# **accountProfileRetrieve2**
|
|
1235
|
-
> Profile accountProfileRetrieve2()
|
|
1236
|
-
|
|
1237
|
-
Manage your profile data
|
|
236
|
+
Manage your companies
|
|
1238
237
|
|
|
1239
238
|
### Example
|
|
1240
239
|
|
|
@@ -1247,16 +246,23 @@ import {
|
|
|
1247
246
|
const configuration = new Configuration();
|
|
1248
247
|
const apiInstance = new AccountApi(configuration);
|
|
1249
248
|
|
|
1250
|
-
|
|
249
|
+
let id: number; //A unique integer value identifying this company. (default to undefined)
|
|
250
|
+
|
|
251
|
+
const { status, data } = await apiInstance.accountCompaniesDestroy(
|
|
252
|
+
id
|
|
253
|
+
);
|
|
1251
254
|
```
|
|
1252
255
|
|
|
1253
256
|
### Parameters
|
|
1254
|
-
|
|
257
|
+
|
|
258
|
+
|Name | Type | Description | Notes|
|
|
259
|
+
|------------- | ------------- | ------------- | -------------|
|
|
260
|
+
| **id** | [**number**] | A unique integer value identifying this company. | defaults to undefined|
|
|
1255
261
|
|
|
1256
262
|
|
|
1257
263
|
### Return type
|
|
1258
264
|
|
|
1259
|
-
|
|
265
|
+
void (empty response body)
|
|
1260
266
|
|
|
1261
267
|
### Authorization
|
|
1262
268
|
|
|
@@ -1265,37 +271,36 @@ This endpoint does not have any parameters.
|
|
|
1265
271
|
### HTTP request headers
|
|
1266
272
|
|
|
1267
273
|
- **Content-Type**: Not defined
|
|
1268
|
-
- **Accept**:
|
|
274
|
+
- **Accept**: Not defined
|
|
1269
275
|
|
|
1270
276
|
|
|
1271
277
|
### HTTP response details
|
|
1272
278
|
| Status code | Description | Response headers |
|
|
1273
279
|
|-------------|-------------|------------------|
|
|
1274
|
-
|**
|
|
280
|
+
|**204** | No response body | - |
|
|
1275
281
|
|
|
1276
282
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1277
283
|
|
|
1278
|
-
# **
|
|
1279
|
-
>
|
|
284
|
+
# **accountCompaniesList**
|
|
285
|
+
> PaginatedCompanyList accountCompaniesList()
|
|
1280
286
|
|
|
1281
|
-
Manage your
|
|
287
|
+
Manage your companies
|
|
1282
288
|
|
|
1283
289
|
### Example
|
|
1284
290
|
|
|
1285
291
|
```typescript
|
|
1286
292
|
import {
|
|
1287
293
|
AccountApi,
|
|
1288
|
-
Configuration
|
|
1289
|
-
Profile
|
|
294
|
+
Configuration
|
|
1290
295
|
} from '@pidginhost/sdk';
|
|
1291
296
|
|
|
1292
297
|
const configuration = new Configuration();
|
|
1293
298
|
const apiInstance = new AccountApi(configuration);
|
|
1294
299
|
|
|
1295
|
-
let
|
|
300
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
1296
301
|
|
|
1297
|
-
const { status, data } = await apiInstance.
|
|
1298
|
-
|
|
302
|
+
const { status, data } = await apiInstance.accountCompaniesList(
|
|
303
|
+
page
|
|
1299
304
|
);
|
|
1300
305
|
```
|
|
1301
306
|
|
|
@@ -1303,12 +308,12 @@ const { status, data } = await apiInstance.accountProfileUpdate(
|
|
|
1303
308
|
|
|
1304
309
|
|Name | Type | Description | Notes|
|
|
1305
310
|
|------------- | ------------- | ------------- | -------------|
|
|
1306
|
-
| **
|
|
311
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
1307
312
|
|
|
1308
313
|
|
|
1309
314
|
### Return type
|
|
1310
315
|
|
|
1311
|
-
**
|
|
316
|
+
**PaginatedCompanyList**
|
|
1312
317
|
|
|
1313
318
|
### Authorization
|
|
1314
319
|
|
|
@@ -1316,7 +321,7 @@ const { status, data } = await apiInstance.accountProfileUpdate(
|
|
|
1316
321
|
|
|
1317
322
|
### HTTP request headers
|
|
1318
323
|
|
|
1319
|
-
- **Content-Type**:
|
|
324
|
+
- **Content-Type**: Not defined
|
|
1320
325
|
- **Accept**: application/json
|
|
1321
326
|
|
|
1322
327
|
|
|
@@ -1327,10 +332,10 @@ const { status, data } = await apiInstance.accountProfileUpdate(
|
|
|
1327
332
|
|
|
1328
333
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1329
334
|
|
|
1330
|
-
# **
|
|
1331
|
-
>
|
|
335
|
+
# **accountCompaniesPartialUpdate**
|
|
336
|
+
> Company accountCompaniesPartialUpdate()
|
|
1332
337
|
|
|
1333
|
-
Manage your
|
|
338
|
+
Manage your companies
|
|
1334
339
|
|
|
1335
340
|
### Example
|
|
1336
341
|
|
|
@@ -1338,16 +343,18 @@ Manage your profile data
|
|
|
1338
343
|
import {
|
|
1339
344
|
AccountApi,
|
|
1340
345
|
Configuration,
|
|
1341
|
-
|
|
346
|
+
PatchedCompany
|
|
1342
347
|
} from '@pidginhost/sdk';
|
|
1343
348
|
|
|
1344
349
|
const configuration = new Configuration();
|
|
1345
350
|
const apiInstance = new AccountApi(configuration);
|
|
1346
351
|
|
|
1347
|
-
let
|
|
352
|
+
let id: number; //A unique integer value identifying this company. (default to undefined)
|
|
353
|
+
let patchedCompany: PatchedCompany; // (optional)
|
|
1348
354
|
|
|
1349
|
-
const { status, data } = await apiInstance.
|
|
1350
|
-
|
|
355
|
+
const { status, data } = await apiInstance.accountCompaniesPartialUpdate(
|
|
356
|
+
id,
|
|
357
|
+
patchedCompany
|
|
1351
358
|
);
|
|
1352
359
|
```
|
|
1353
360
|
|
|
@@ -1355,12 +362,13 @@ const { status, data } = await apiInstance.accountProfileUpdate2(
|
|
|
1355
362
|
|
|
1356
363
|
|Name | Type | Description | Notes|
|
|
1357
364
|
|------------- | ------------- | ------------- | -------------|
|
|
1358
|
-
| **
|
|
365
|
+
| **patchedCompany** | **PatchedCompany**| | |
|
|
366
|
+
| **id** | [**number**] | A unique integer value identifying this company. | defaults to undefined|
|
|
1359
367
|
|
|
1360
368
|
|
|
1361
369
|
### Return type
|
|
1362
370
|
|
|
1363
|
-
**
|
|
371
|
+
**Company**
|
|
1364
372
|
|
|
1365
373
|
### Authorization
|
|
1366
374
|
|
|
@@ -1379,26 +387,26 @@ const { status, data } = await apiInstance.accountProfileUpdate2(
|
|
|
1379
387
|
|
|
1380
388
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1381
389
|
|
|
1382
|
-
# **
|
|
1383
|
-
>
|
|
390
|
+
# **accountCompaniesRetrieve**
|
|
391
|
+
> Company accountCompaniesRetrieve()
|
|
1384
392
|
|
|
393
|
+
Manage your companies
|
|
1385
394
|
|
|
1386
395
|
### Example
|
|
1387
396
|
|
|
1388
397
|
```typescript
|
|
1389
398
|
import {
|
|
1390
399
|
AccountApi,
|
|
1391
|
-
Configuration
|
|
1392
|
-
SSHKey
|
|
400
|
+
Configuration
|
|
1393
401
|
} from '@pidginhost/sdk';
|
|
1394
402
|
|
|
1395
403
|
const configuration = new Configuration();
|
|
1396
404
|
const apiInstance = new AccountApi(configuration);
|
|
1397
405
|
|
|
1398
|
-
let
|
|
406
|
+
let id: number; //A unique integer value identifying this company. (default to undefined)
|
|
1399
407
|
|
|
1400
|
-
const { status, data } = await apiInstance.
|
|
1401
|
-
|
|
408
|
+
const { status, data } = await apiInstance.accountCompaniesRetrieve(
|
|
409
|
+
id
|
|
1402
410
|
);
|
|
1403
411
|
```
|
|
1404
412
|
|
|
@@ -1406,12 +414,12 @@ const { status, data } = await apiInstance.accountSshKeysCreate(
|
|
|
1406
414
|
|
|
1407
415
|
|Name | Type | Description | Notes|
|
|
1408
416
|
|------------- | ------------- | ------------- | -------------|
|
|
1409
|
-
| **
|
|
417
|
+
| **id** | [**number**] | A unique integer value identifying this company. | defaults to undefined|
|
|
1410
418
|
|
|
1411
419
|
|
|
1412
420
|
### Return type
|
|
1413
421
|
|
|
1414
|
-
**
|
|
422
|
+
**Company**
|
|
1415
423
|
|
|
1416
424
|
### Authorization
|
|
1417
425
|
|
|
@@ -1419,20 +427,21 @@ const { status, data } = await apiInstance.accountSshKeysCreate(
|
|
|
1419
427
|
|
|
1420
428
|
### HTTP request headers
|
|
1421
429
|
|
|
1422
|
-
- **Content-Type**:
|
|
430
|
+
- **Content-Type**: Not defined
|
|
1423
431
|
- **Accept**: application/json
|
|
1424
432
|
|
|
1425
433
|
|
|
1426
434
|
### HTTP response details
|
|
1427
435
|
| Status code | Description | Response headers |
|
|
1428
436
|
|-------------|-------------|------------------|
|
|
1429
|
-
|**
|
|
437
|
+
|**200** | | - |
|
|
1430
438
|
|
|
1431
439
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1432
440
|
|
|
1433
|
-
# **
|
|
1434
|
-
>
|
|
441
|
+
# **accountCompaniesUpdate**
|
|
442
|
+
> Company accountCompaniesUpdate(company)
|
|
1435
443
|
|
|
444
|
+
Manage your companies
|
|
1436
445
|
|
|
1437
446
|
### Example
|
|
1438
447
|
|
|
@@ -1440,16 +449,18 @@ const { status, data } = await apiInstance.accountSshKeysCreate(
|
|
|
1440
449
|
import {
|
|
1441
450
|
AccountApi,
|
|
1442
451
|
Configuration,
|
|
1443
|
-
|
|
452
|
+
Company
|
|
1444
453
|
} from '@pidginhost/sdk';
|
|
1445
454
|
|
|
1446
455
|
const configuration = new Configuration();
|
|
1447
456
|
const apiInstance = new AccountApi(configuration);
|
|
1448
457
|
|
|
1449
|
-
let
|
|
458
|
+
let id: number; //A unique integer value identifying this company. (default to undefined)
|
|
459
|
+
let company: Company; //
|
|
1450
460
|
|
|
1451
|
-
const { status, data } = await apiInstance.
|
|
1452
|
-
|
|
461
|
+
const { status, data } = await apiInstance.accountCompaniesUpdate(
|
|
462
|
+
id,
|
|
463
|
+
company
|
|
1453
464
|
);
|
|
1454
465
|
```
|
|
1455
466
|
|
|
@@ -1457,12 +468,13 @@ const { status, data } = await apiInstance.accountSshKeysCreate2(
|
|
|
1457
468
|
|
|
1458
469
|
|Name | Type | Description | Notes|
|
|
1459
470
|
|------------- | ------------- | ------------- | -------------|
|
|
1460
|
-
| **
|
|
471
|
+
| **company** | **Company**| | |
|
|
472
|
+
| **id** | [**number**] | A unique integer value identifying this company. | defaults to undefined|
|
|
1461
473
|
|
|
1462
474
|
|
|
1463
475
|
### Return type
|
|
1464
476
|
|
|
1465
|
-
**
|
|
477
|
+
**Company**
|
|
1466
478
|
|
|
1467
479
|
### Authorization
|
|
1468
480
|
|
|
@@ -1477,13 +489,14 @@ const { status, data } = await apiInstance.accountSshKeysCreate2(
|
|
|
1477
489
|
### HTTP response details
|
|
1478
490
|
| Status code | Description | Response headers |
|
|
1479
491
|
|-------------|-------------|------------------|
|
|
1480
|
-
|**
|
|
492
|
+
|**200** | | - |
|
|
1481
493
|
|
|
1482
494
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1483
495
|
|
|
1484
|
-
# **
|
|
1485
|
-
>
|
|
496
|
+
# **accountEmailsList**
|
|
497
|
+
> PaginatedEmailHistoryList accountEmailsList()
|
|
1486
498
|
|
|
499
|
+
List email history for the authenticated user.
|
|
1487
500
|
|
|
1488
501
|
### Example
|
|
1489
502
|
|
|
@@ -1496,10 +509,10 @@ import {
|
|
|
1496
509
|
const configuration = new Configuration();
|
|
1497
510
|
const apiInstance = new AccountApi(configuration);
|
|
1498
511
|
|
|
1499
|
-
let
|
|
512
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
1500
513
|
|
|
1501
|
-
const { status, data } = await apiInstance.
|
|
1502
|
-
|
|
514
|
+
const { status, data } = await apiInstance.accountEmailsList(
|
|
515
|
+
page
|
|
1503
516
|
);
|
|
1504
517
|
```
|
|
1505
518
|
|
|
@@ -1507,12 +520,12 @@ const { status, data } = await apiInstance.accountSshKeysDestroy(
|
|
|
1507
520
|
|
|
1508
521
|
|Name | Type | Description | Notes|
|
|
1509
522
|
|------------- | ------------- | ------------- | -------------|
|
|
1510
|
-
| **
|
|
523
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
1511
524
|
|
|
1512
525
|
|
|
1513
526
|
### Return type
|
|
1514
527
|
|
|
1515
|
-
|
|
528
|
+
**PaginatedEmailHistoryList**
|
|
1516
529
|
|
|
1517
530
|
### Authorization
|
|
1518
531
|
|
|
@@ -1521,35 +534,37 @@ void (empty response body)
|
|
|
1521
534
|
### HTTP request headers
|
|
1522
535
|
|
|
1523
536
|
- **Content-Type**: Not defined
|
|
1524
|
-
- **Accept**:
|
|
537
|
+
- **Accept**: application/json
|
|
1525
538
|
|
|
1526
539
|
|
|
1527
540
|
### HTTP response details
|
|
1528
541
|
| Status code | Description | Response headers |
|
|
1529
542
|
|-------------|-------------|------------------|
|
|
1530
|
-
|**
|
|
543
|
+
|**200** | | - |
|
|
1531
544
|
|
|
1532
545
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1533
546
|
|
|
1534
|
-
# **
|
|
1535
|
-
>
|
|
547
|
+
# **accountProfilePartialUpdate**
|
|
548
|
+
> Profile accountProfilePartialUpdate()
|
|
1536
549
|
|
|
550
|
+
Manage your profile data
|
|
1537
551
|
|
|
1538
552
|
### Example
|
|
1539
553
|
|
|
1540
554
|
```typescript
|
|
1541
555
|
import {
|
|
1542
556
|
AccountApi,
|
|
1543
|
-
Configuration
|
|
557
|
+
Configuration,
|
|
558
|
+
PatchedProfile
|
|
1544
559
|
} from '@pidginhost/sdk';
|
|
1545
560
|
|
|
1546
561
|
const configuration = new Configuration();
|
|
1547
562
|
const apiInstance = new AccountApi(configuration);
|
|
1548
563
|
|
|
1549
|
-
let
|
|
564
|
+
let patchedProfile: PatchedProfile; // (optional)
|
|
1550
565
|
|
|
1551
|
-
const { status, data } = await apiInstance.
|
|
1552
|
-
|
|
566
|
+
const { status, data } = await apiInstance.accountProfilePartialUpdate(
|
|
567
|
+
patchedProfile
|
|
1553
568
|
);
|
|
1554
569
|
```
|
|
1555
570
|
|
|
@@ -1557,12 +572,12 @@ const { status, data } = await apiInstance.accountSshKeysDestroy2(
|
|
|
1557
572
|
|
|
1558
573
|
|Name | Type | Description | Notes|
|
|
1559
574
|
|------------- | ------------- | ------------- | -------------|
|
|
1560
|
-
| **
|
|
575
|
+
| **patchedProfile** | **PatchedProfile**| | |
|
|
1561
576
|
|
|
1562
577
|
|
|
1563
578
|
### Return type
|
|
1564
579
|
|
|
1565
|
-
|
|
580
|
+
**Profile**
|
|
1566
581
|
|
|
1567
582
|
### Authorization
|
|
1568
583
|
|
|
@@ -1570,20 +585,21 @@ void (empty response body)
|
|
|
1570
585
|
|
|
1571
586
|
### HTTP request headers
|
|
1572
587
|
|
|
1573
|
-
- **Content-Type**:
|
|
1574
|
-
- **Accept**:
|
|
588
|
+
- **Content-Type**: application/json
|
|
589
|
+
- **Accept**: application/json
|
|
1575
590
|
|
|
1576
591
|
|
|
1577
592
|
### HTTP response details
|
|
1578
593
|
| Status code | Description | Response headers |
|
|
1579
594
|
|-------------|-------------|------------------|
|
|
1580
|
-
|**
|
|
595
|
+
|**200** | | - |
|
|
1581
596
|
|
|
1582
597
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1583
598
|
|
|
1584
|
-
# **
|
|
1585
|
-
>
|
|
599
|
+
# **accountProfileRetrieve**
|
|
600
|
+
> Profile accountProfileRetrieve()
|
|
1586
601
|
|
|
602
|
+
Manage your profile data
|
|
1587
603
|
|
|
1588
604
|
### Example
|
|
1589
605
|
|
|
@@ -1596,23 +612,16 @@ import {
|
|
|
1596
612
|
const configuration = new Configuration();
|
|
1597
613
|
const apiInstance = new AccountApi(configuration);
|
|
1598
614
|
|
|
1599
|
-
|
|
1600
|
-
|
|
1601
|
-
const { status, data } = await apiInstance.accountSshKeysList(
|
|
1602
|
-
page
|
|
1603
|
-
);
|
|
615
|
+
const { status, data } = await apiInstance.accountProfileRetrieve();
|
|
1604
616
|
```
|
|
1605
617
|
|
|
1606
618
|
### Parameters
|
|
1607
|
-
|
|
1608
|
-
|Name | Type | Description | Notes|
|
|
1609
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1610
|
-
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
619
|
+
This endpoint does not have any parameters.
|
|
1611
620
|
|
|
1612
621
|
|
|
1613
622
|
### Return type
|
|
1614
623
|
|
|
1615
|
-
**
|
|
624
|
+
**Profile**
|
|
1616
625
|
|
|
1617
626
|
### Authorization
|
|
1618
627
|
|
|
@@ -1631,25 +640,27 @@ const { status, data } = await apiInstance.accountSshKeysList(
|
|
|
1631
640
|
|
|
1632
641
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1633
642
|
|
|
1634
|
-
# **
|
|
1635
|
-
>
|
|
643
|
+
# **accountProfileUpdate**
|
|
644
|
+
> Profile accountProfileUpdate(profile)
|
|
1636
645
|
|
|
646
|
+
Manage your profile data
|
|
1637
647
|
|
|
1638
648
|
### Example
|
|
1639
649
|
|
|
1640
650
|
```typescript
|
|
1641
651
|
import {
|
|
1642
652
|
AccountApi,
|
|
1643
|
-
Configuration
|
|
653
|
+
Configuration,
|
|
654
|
+
Profile
|
|
1644
655
|
} from '@pidginhost/sdk';
|
|
1645
656
|
|
|
1646
657
|
const configuration = new Configuration();
|
|
1647
658
|
const apiInstance = new AccountApi(configuration);
|
|
1648
659
|
|
|
1649
|
-
let
|
|
660
|
+
let profile: Profile; //
|
|
1650
661
|
|
|
1651
|
-
const { status, data } = await apiInstance.
|
|
1652
|
-
|
|
662
|
+
const { status, data } = await apiInstance.accountProfileUpdate(
|
|
663
|
+
profile
|
|
1653
664
|
);
|
|
1654
665
|
```
|
|
1655
666
|
|
|
@@ -1657,12 +668,12 @@ const { status, data } = await apiInstance.accountSshKeysList2(
|
|
|
1657
668
|
|
|
1658
669
|
|Name | Type | Description | Notes|
|
|
1659
670
|
|------------- | ------------- | ------------- | -------------|
|
|
1660
|
-
| **
|
|
671
|
+
| **profile** | **Profile**| | |
|
|
1661
672
|
|
|
1662
673
|
|
|
1663
674
|
### Return type
|
|
1664
675
|
|
|
1665
|
-
**
|
|
676
|
+
**Profile**
|
|
1666
677
|
|
|
1667
678
|
### Authorization
|
|
1668
679
|
|
|
@@ -1670,7 +681,7 @@ const { status, data } = await apiInstance.accountSshKeysList2(
|
|
|
1670
681
|
|
|
1671
682
|
### HTTP request headers
|
|
1672
683
|
|
|
1673
|
-
- **Content-Type**:
|
|
684
|
+
- **Content-Type**: application/json
|
|
1674
685
|
- **Accept**: application/json
|
|
1675
686
|
|
|
1676
687
|
|
|
@@ -1681,8 +692,8 @@ const { status, data } = await apiInstance.accountSshKeysList2(
|
|
|
1681
692
|
|
|
1682
693
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1683
694
|
|
|
1684
|
-
# **
|
|
1685
|
-
> SSHKey
|
|
695
|
+
# **accountSshKeysCreate**
|
|
696
|
+
> SSHKey accountSshKeysCreate()
|
|
1686
697
|
|
|
1687
698
|
|
|
1688
699
|
### Example
|
|
@@ -1691,18 +702,16 @@ const { status, data } = await apiInstance.accountSshKeysList2(
|
|
|
1691
702
|
import {
|
|
1692
703
|
AccountApi,
|
|
1693
704
|
Configuration,
|
|
1694
|
-
|
|
705
|
+
SSHKey
|
|
1695
706
|
} from '@pidginhost/sdk';
|
|
1696
707
|
|
|
1697
708
|
const configuration = new Configuration();
|
|
1698
709
|
const apiInstance = new AccountApi(configuration);
|
|
1699
710
|
|
|
1700
|
-
let
|
|
1701
|
-
let patchedSSHKey: PatchedSSHKey; // (optional)
|
|
711
|
+
let sSHKey: SSHKey; // (optional)
|
|
1702
712
|
|
|
1703
|
-
const { status, data } = await apiInstance.
|
|
1704
|
-
|
|
1705
|
-
patchedSSHKey
|
|
713
|
+
const { status, data } = await apiInstance.accountSshKeysCreate(
|
|
714
|
+
sSHKey
|
|
1706
715
|
);
|
|
1707
716
|
```
|
|
1708
717
|
|
|
@@ -1710,8 +719,7 @@ const { status, data } = await apiInstance.accountSshKeysPartialUpdate(
|
|
|
1710
719
|
|
|
1711
720
|
|Name | Type | Description | Notes|
|
|
1712
721
|
|------------- | ------------- | ------------- | -------------|
|
|
1713
|
-
| **
|
|
1714
|
-
| **id** | [**string**] | | defaults to undefined|
|
|
722
|
+
| **sSHKey** | **SSHKey**| | |
|
|
1715
723
|
|
|
1716
724
|
|
|
1717
725
|
### Return type
|
|
@@ -1731,12 +739,12 @@ const { status, data } = await apiInstance.accountSshKeysPartialUpdate(
|
|
|
1731
739
|
### HTTP response details
|
|
1732
740
|
| Status code | Description | Response headers |
|
|
1733
741
|
|-------------|-------------|------------------|
|
|
1734
|
-
|**
|
|
742
|
+
|**201** | | - |
|
|
1735
743
|
|
|
1736
744
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1737
745
|
|
|
1738
|
-
# **
|
|
1739
|
-
>
|
|
746
|
+
# **accountSshKeysDestroy**
|
|
747
|
+
> accountSshKeysDestroy()
|
|
1740
748
|
|
|
1741
749
|
|
|
1742
750
|
### Example
|
|
@@ -1744,19 +752,16 @@ const { status, data } = await apiInstance.accountSshKeysPartialUpdate(
|
|
|
1744
752
|
```typescript
|
|
1745
753
|
import {
|
|
1746
754
|
AccountApi,
|
|
1747
|
-
Configuration
|
|
1748
|
-
PatchedSSHKey
|
|
755
|
+
Configuration
|
|
1749
756
|
} from '@pidginhost/sdk';
|
|
1750
757
|
|
|
1751
758
|
const configuration = new Configuration();
|
|
1752
759
|
const apiInstance = new AccountApi(configuration);
|
|
1753
760
|
|
|
1754
761
|
let id: string; // (default to undefined)
|
|
1755
|
-
let patchedSSHKey: PatchedSSHKey; // (optional)
|
|
1756
762
|
|
|
1757
|
-
const { status, data } = await apiInstance.
|
|
1758
|
-
id
|
|
1759
|
-
patchedSSHKey
|
|
763
|
+
const { status, data } = await apiInstance.accountSshKeysDestroy(
|
|
764
|
+
id
|
|
1760
765
|
);
|
|
1761
766
|
```
|
|
1762
767
|
|
|
@@ -1764,13 +769,12 @@ const { status, data } = await apiInstance.accountSshKeysPartialUpdate2(
|
|
|
1764
769
|
|
|
1765
770
|
|Name | Type | Description | Notes|
|
|
1766
771
|
|------------- | ------------- | ------------- | -------------|
|
|
1767
|
-
| **patchedSSHKey** | **PatchedSSHKey**| | |
|
|
1768
772
|
| **id** | [**string**] | | defaults to undefined|
|
|
1769
773
|
|
|
1770
774
|
|
|
1771
775
|
### Return type
|
|
1772
776
|
|
|
1773
|
-
|
|
777
|
+
void (empty response body)
|
|
1774
778
|
|
|
1775
779
|
### Authorization
|
|
1776
780
|
|
|
@@ -1778,19 +782,19 @@ const { status, data } = await apiInstance.accountSshKeysPartialUpdate2(
|
|
|
1778
782
|
|
|
1779
783
|
### HTTP request headers
|
|
1780
784
|
|
|
1781
|
-
- **Content-Type**:
|
|
1782
|
-
- **Accept**:
|
|
785
|
+
- **Content-Type**: Not defined
|
|
786
|
+
- **Accept**: Not defined
|
|
1783
787
|
|
|
1784
788
|
|
|
1785
789
|
### HTTP response details
|
|
1786
790
|
| Status code | Description | Response headers |
|
|
1787
791
|
|-------------|-------------|------------------|
|
|
1788
|
-
|**
|
|
792
|
+
|**204** | No response body | - |
|
|
1789
793
|
|
|
1790
794
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1791
795
|
|
|
1792
|
-
# **
|
|
1793
|
-
>
|
|
796
|
+
# **accountSshKeysList**
|
|
797
|
+
> PaginatedSSHKeyList accountSshKeysList()
|
|
1794
798
|
|
|
1795
799
|
|
|
1796
800
|
### Example
|
|
@@ -1804,10 +808,10 @@ import {
|
|
|
1804
808
|
const configuration = new Configuration();
|
|
1805
809
|
const apiInstance = new AccountApi(configuration);
|
|
1806
810
|
|
|
1807
|
-
let
|
|
811
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
1808
812
|
|
|
1809
|
-
const { status, data } = await apiInstance.
|
|
1810
|
-
|
|
813
|
+
const { status, data } = await apiInstance.accountSshKeysList(
|
|
814
|
+
page
|
|
1811
815
|
);
|
|
1812
816
|
```
|
|
1813
817
|
|
|
@@ -1815,12 +819,12 @@ const { status, data } = await apiInstance.accountSshKeysRetrieve(
|
|
|
1815
819
|
|
|
1816
820
|
|Name | Type | Description | Notes|
|
|
1817
821
|
|------------- | ------------- | ------------- | -------------|
|
|
1818
|
-
| **
|
|
822
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
1819
823
|
|
|
1820
824
|
|
|
1821
825
|
### Return type
|
|
1822
826
|
|
|
1823
|
-
**
|
|
827
|
+
**PaginatedSSHKeyList**
|
|
1824
828
|
|
|
1825
829
|
### Authorization
|
|
1826
830
|
|
|
@@ -1839,8 +843,8 @@ const { status, data } = await apiInstance.accountSshKeysRetrieve(
|
|
|
1839
843
|
|
|
1840
844
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1841
845
|
|
|
1842
|
-
# **
|
|
1843
|
-
> SSHKey
|
|
846
|
+
# **accountSshKeysPartialUpdate**
|
|
847
|
+
> SSHKey accountSshKeysPartialUpdate()
|
|
1844
848
|
|
|
1845
849
|
|
|
1846
850
|
### Example
|
|
@@ -1848,16 +852,19 @@ const { status, data } = await apiInstance.accountSshKeysRetrieve(
|
|
|
1848
852
|
```typescript
|
|
1849
853
|
import {
|
|
1850
854
|
AccountApi,
|
|
1851
|
-
Configuration
|
|
855
|
+
Configuration,
|
|
856
|
+
PatchedSSHKey
|
|
1852
857
|
} from '@pidginhost/sdk';
|
|
1853
858
|
|
|
1854
859
|
const configuration = new Configuration();
|
|
1855
860
|
const apiInstance = new AccountApi(configuration);
|
|
1856
861
|
|
|
1857
862
|
let id: string; // (default to undefined)
|
|
863
|
+
let patchedSSHKey: PatchedSSHKey; // (optional)
|
|
1858
864
|
|
|
1859
|
-
const { status, data } = await apiInstance.
|
|
1860
|
-
id
|
|
865
|
+
const { status, data } = await apiInstance.accountSshKeysPartialUpdate(
|
|
866
|
+
id,
|
|
867
|
+
patchedSSHKey
|
|
1861
868
|
);
|
|
1862
869
|
```
|
|
1863
870
|
|
|
@@ -1865,6 +872,7 @@ const { status, data } = await apiInstance.accountSshKeysRetrieve2(
|
|
|
1865
872
|
|
|
1866
873
|
|Name | Type | Description | Notes|
|
|
1867
874
|
|------------- | ------------- | ------------- | -------------|
|
|
875
|
+
| **patchedSSHKey** | **PatchedSSHKey**| | |
|
|
1868
876
|
| **id** | [**string**] | | defaults to undefined|
|
|
1869
877
|
|
|
1870
878
|
|
|
@@ -1878,7 +886,7 @@ const { status, data } = await apiInstance.accountSshKeysRetrieve2(
|
|
|
1878
886
|
|
|
1879
887
|
### HTTP request headers
|
|
1880
888
|
|
|
1881
|
-
- **Content-Type**:
|
|
889
|
+
- **Content-Type**: application/json
|
|
1882
890
|
- **Accept**: application/json
|
|
1883
891
|
|
|
1884
892
|
|
|
@@ -1889,8 +897,8 @@ const { status, data } = await apiInstance.accountSshKeysRetrieve2(
|
|
|
1889
897
|
|
|
1890
898
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1891
899
|
|
|
1892
|
-
# **
|
|
1893
|
-
> SSHKey
|
|
900
|
+
# **accountSshKeysRetrieve**
|
|
901
|
+
> SSHKey accountSshKeysRetrieve()
|
|
1894
902
|
|
|
1895
903
|
|
|
1896
904
|
### Example
|
|
@@ -1898,19 +906,16 @@ const { status, data } = await apiInstance.accountSshKeysRetrieve2(
|
|
|
1898
906
|
```typescript
|
|
1899
907
|
import {
|
|
1900
908
|
AccountApi,
|
|
1901
|
-
Configuration
|
|
1902
|
-
SSHKey
|
|
909
|
+
Configuration
|
|
1903
910
|
} from '@pidginhost/sdk';
|
|
1904
911
|
|
|
1905
912
|
const configuration = new Configuration();
|
|
1906
913
|
const apiInstance = new AccountApi(configuration);
|
|
1907
914
|
|
|
1908
915
|
let id: string; // (default to undefined)
|
|
1909
|
-
let sSHKey: SSHKey; // (optional)
|
|
1910
916
|
|
|
1911
|
-
const { status, data } = await apiInstance.
|
|
1912
|
-
id
|
|
1913
|
-
sSHKey
|
|
917
|
+
const { status, data } = await apiInstance.accountSshKeysRetrieve(
|
|
918
|
+
id
|
|
1914
919
|
);
|
|
1915
920
|
```
|
|
1916
921
|
|
|
@@ -1918,7 +923,6 @@ const { status, data } = await apiInstance.accountSshKeysUpdate(
|
|
|
1918
923
|
|
|
1919
924
|
|Name | Type | Description | Notes|
|
|
1920
925
|
|------------- | ------------- | ------------- | -------------|
|
|
1921
|
-
| **sSHKey** | **SSHKey**| | |
|
|
1922
926
|
| **id** | [**string**] | | defaults to undefined|
|
|
1923
927
|
|
|
1924
928
|
|
|
@@ -1932,7 +936,7 @@ const { status, data } = await apiInstance.accountSshKeysUpdate(
|
|
|
1932
936
|
|
|
1933
937
|
### HTTP request headers
|
|
1934
938
|
|
|
1935
|
-
- **Content-Type**:
|
|
939
|
+
- **Content-Type**: Not defined
|
|
1936
940
|
- **Accept**: application/json
|
|
1937
941
|
|
|
1938
942
|
|
|
@@ -1943,8 +947,8 @@ const { status, data } = await apiInstance.accountSshKeysUpdate(
|
|
|
1943
947
|
|
|
1944
948
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1945
949
|
|
|
1946
|
-
# **
|
|
1947
|
-
> SSHKey
|
|
950
|
+
# **accountSshKeysUpdate**
|
|
951
|
+
> SSHKey accountSshKeysUpdate()
|
|
1948
952
|
|
|
1949
953
|
|
|
1950
954
|
### Example
|
|
@@ -1962,7 +966,7 @@ const apiInstance = new AccountApi(configuration);
|
|
|
1962
966
|
let id: string; // (default to undefined)
|
|
1963
967
|
let sSHKey: SSHKey; // (optional)
|
|
1964
968
|
|
|
1965
|
-
const { status, data } = await apiInstance.
|
|
969
|
+
const { status, data } = await apiInstance.accountSshKeysUpdate(
|
|
1966
970
|
id,
|
|
1967
971
|
sSHKey
|
|
1968
972
|
);
|