@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/DomainApi.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
|
|[**domainDomainCancelCreate**](#domaindomaincancelcreate) | **POST** /api/domain/domain/{domain}/cancel/ | |
|
|
8
|
-
|[**domainDomainCancelCreate2**](#domaindomaincancelcreate2) | **POST** /api/v1/domain/domain/{domain}/cancel/ | |
|
|
9
8
|
|[**domainDomainCheckAvailabilityCreate**](#domaindomaincheckavailabilitycreate) | **POST** /api/domain/domain/check-availability/ | |
|
|
10
|
-
|[**domainDomainCheckAvailabilityCreate2**](#domaindomaincheckavailabilitycreate2) | **POST** /api/v1/domain/domain/check-availability/ | |
|
|
11
9
|
|[**domainDomainContactsCreate**](#domaindomaincontactscreate) | **POST** /api/domain/domain/{domain}/contacts/ | |
|
|
12
|
-
|[**domainDomainContactsCreate2**](#domaindomaincontactscreate2) | **POST** /api/v1/domain/domain/{domain}/contacts/ | |
|
|
13
10
|
|[**domainDomainCreate**](#domaindomaincreate) | **POST** /api/domain/domain/ | |
|
|
14
|
-
|[**domainDomainCreate2**](#domaindomaincreate2) | **POST** /api/v1/domain/domain/ | |
|
|
15
11
|
|[**domainDomainList**](#domaindomainlist) | **GET** /api/domain/domain/ | |
|
|
16
|
-
|[**domainDomainList2**](#domaindomainlist2) | **GET** /api/v1/domain/domain/ | |
|
|
17
12
|
|[**domainDomainNameserversCreate**](#domaindomainnameserverscreate) | **POST** /api/domain/domain/{domain}/nameservers/ | |
|
|
18
|
-
|[**domainDomainNameserversCreate2**](#domaindomainnameserverscreate2) | **POST** /api/v1/domain/domain/{domain}/nameservers/ | |
|
|
19
13
|
|[**domainDomainPartialUpdate**](#domaindomainpartialupdate) | **PATCH** /api/domain/domain/{domain}/ | |
|
|
20
|
-
|[**domainDomainPartialUpdate2**](#domaindomainpartialupdate2) | **PATCH** /api/v1/domain/domain/{domain}/ | |
|
|
21
14
|
|[**domainDomainRenewCreate**](#domaindomainrenewcreate) | **POST** /api/domain/domain/{domain}/renew/ | |
|
|
22
|
-
|[**domainDomainRenewCreate2**](#domaindomainrenewcreate2) | **POST** /api/v1/domain/domain/{domain}/renew/ | |
|
|
23
15
|
|[**domainDomainRetrieve**](#domaindomainretrieve) | **GET** /api/domain/domain/{domain}/ | |
|
|
24
|
-
|[**domainDomainRetrieve2**](#domaindomainretrieve2) | **GET** /api/v1/domain/domain/{domain}/ | |
|
|
25
16
|
|[**domainDomainTransferRoDomainCreate**](#domaindomaintransferrodomaincreate) | **POST** /api/domain/domain/transfer-ro-domain/ | |
|
|
26
|
-
|[**domainDomainTransferRoDomainCreate2**](#domaindomaintransferrodomaincreate2) | **POST** /api/v1/domain/domain/transfer-ro-domain/ | |
|
|
27
17
|
|[**domainDomainUpdate**](#domaindomainupdate) | **PUT** /api/domain/domain/{domain}/ | |
|
|
28
|
-
|[**domainDomainUpdate2**](#domaindomainupdate2) | **PUT** /api/v1/domain/domain/{domain}/ | |
|
|
29
18
|
|[**domainRegistrantsCreate**](#domainregistrantscreate) | **POST** /api/domain/registrants/ | |
|
|
30
|
-
|[**domainRegistrantsCreate2**](#domainregistrantscreate2) | **POST** /api/v1/domain/registrants/ | |
|
|
31
19
|
|[**domainRegistrantsDestroy**](#domainregistrantsdestroy) | **DELETE** /api/domain/registrants/{id}/ | |
|
|
32
|
-
|[**domainRegistrantsDestroy2**](#domainregistrantsdestroy2) | **DELETE** /api/v1/domain/registrants/{id}/ | |
|
|
33
20
|
|[**domainRegistrantsList**](#domainregistrantslist) | **GET** /api/domain/registrants/ | |
|
|
34
|
-
|[**domainRegistrantsList2**](#domainregistrantslist2) | **GET** /api/v1/domain/registrants/ | |
|
|
35
21
|
|[**domainRegistrantsPartialUpdate**](#domainregistrantspartialupdate) | **PATCH** /api/domain/registrants/{id}/ | |
|
|
36
|
-
|[**domainRegistrantsPartialUpdate2**](#domainregistrantspartialupdate2) | **PATCH** /api/v1/domain/registrants/{id}/ | |
|
|
37
22
|
|[**domainRegistrantsRetrieve**](#domainregistrantsretrieve) | **GET** /api/domain/registrants/{id}/ | |
|
|
38
|
-
|[**domainRegistrantsRetrieve2**](#domainregistrantsretrieve2) | **GET** /api/v1/domain/registrants/{id}/ | |
|
|
39
23
|
|[**domainRegistrantsUpdate**](#domainregistrantsupdate) | **PUT** /api/domain/registrants/{id}/ | |
|
|
40
|
-
|[**domainRegistrantsUpdate2**](#domainregistrantsupdate2) | **PUT** /api/v1/domain/registrants/{id}/ | |
|
|
41
24
|
|[**domainTldList**](#domaintldlist) | **GET** /api/domain/tld/ | |
|
|
42
|
-
|[**domainTldList2**](#domaintldlist2) | **GET** /api/v1/domain/tld/ | |
|
|
43
25
|
|[**domainTldRetrieve**](#domaintldretrieve) | **GET** /api/domain/tld/{id}/ | |
|
|
44
|
-
|[**domainTldRetrieve2**](#domaintldretrieve2) | **GET** /api/v1/domain/tld/{id}/ | |
|
|
45
26
|
|
|
46
27
|
# **domainDomainCancelCreate**
|
|
47
28
|
> DomainCancelResponse domainDomainCancelCreate()
|
|
@@ -73,57 +54,6 @@ const { status, data } = await apiInstance.domainDomainCancelCreate(
|
|
|
73
54
|
| **domain** | [**string**] | | defaults to undefined|
|
|
74
55
|
|
|
75
56
|
|
|
76
|
-
### Return type
|
|
77
|
-
|
|
78
|
-
**DomainCancelResponse**
|
|
79
|
-
|
|
80
|
-
### Authorization
|
|
81
|
-
|
|
82
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
83
|
-
|
|
84
|
-
### HTTP request headers
|
|
85
|
-
|
|
86
|
-
- **Content-Type**: Not defined
|
|
87
|
-
- **Accept**: application/json
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
### HTTP response details
|
|
91
|
-
| Status code | Description | Response headers |
|
|
92
|
-
|-------------|-------------|------------------|
|
|
93
|
-
|**200** | | - |
|
|
94
|
-
|
|
95
|
-
[[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)
|
|
96
|
-
|
|
97
|
-
# **domainDomainCancelCreate2**
|
|
98
|
-
> DomainCancelResponse domainDomainCancelCreate2()
|
|
99
|
-
|
|
100
|
-
Cancel the service associated with this domain.
|
|
101
|
-
|
|
102
|
-
### Example
|
|
103
|
-
|
|
104
|
-
```typescript
|
|
105
|
-
import {
|
|
106
|
-
DomainApi,
|
|
107
|
-
Configuration
|
|
108
|
-
} from '@pidginhost/sdk';
|
|
109
|
-
|
|
110
|
-
const configuration = new Configuration();
|
|
111
|
-
const apiInstance = new DomainApi(configuration);
|
|
112
|
-
|
|
113
|
-
let domain: string; // (default to undefined)
|
|
114
|
-
|
|
115
|
-
const { status, data } = await apiInstance.domainDomainCancelCreate2(
|
|
116
|
-
domain
|
|
117
|
-
);
|
|
118
|
-
```
|
|
119
|
-
|
|
120
|
-
### Parameters
|
|
121
|
-
|
|
122
|
-
|Name | Type | Description | Notes|
|
|
123
|
-
|------------- | ------------- | ------------- | -------------|
|
|
124
|
-
| **domain** | [**string**] | | defaults to undefined|
|
|
125
|
-
|
|
126
|
-
|
|
127
57
|
### Return type
|
|
128
58
|
|
|
129
59
|
**DomainCancelResponse**
|
|
@@ -176,58 +106,6 @@ const { status, data } = await apiInstance.domainDomainCheckAvailabilityCreate(
|
|
|
176
106
|
| **checkAvailability** | **CheckAvailability**| | |
|
|
177
107
|
|
|
178
108
|
|
|
179
|
-
### Return type
|
|
180
|
-
|
|
181
|
-
**CheckAvailability**
|
|
182
|
-
|
|
183
|
-
### Authorization
|
|
184
|
-
|
|
185
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
186
|
-
|
|
187
|
-
### HTTP request headers
|
|
188
|
-
|
|
189
|
-
- **Content-Type**: application/json
|
|
190
|
-
- **Accept**: application/json
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
### HTTP response details
|
|
194
|
-
| Status code | Description | Response headers |
|
|
195
|
-
|-------------|-------------|------------------|
|
|
196
|
-
|**200** | | - |
|
|
197
|
-
|
|
198
|
-
[[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)
|
|
199
|
-
|
|
200
|
-
# **domainDomainCheckAvailabilityCreate2**
|
|
201
|
-
> CheckAvailability domainDomainCheckAvailabilityCreate2(checkAvailability)
|
|
202
|
-
|
|
203
|
-
Manage your domains
|
|
204
|
-
|
|
205
|
-
### Example
|
|
206
|
-
|
|
207
|
-
```typescript
|
|
208
|
-
import {
|
|
209
|
-
DomainApi,
|
|
210
|
-
Configuration,
|
|
211
|
-
CheckAvailability
|
|
212
|
-
} from '@pidginhost/sdk';
|
|
213
|
-
|
|
214
|
-
const configuration = new Configuration();
|
|
215
|
-
const apiInstance = new DomainApi(configuration);
|
|
216
|
-
|
|
217
|
-
let checkAvailability: CheckAvailability; //
|
|
218
|
-
|
|
219
|
-
const { status, data } = await apiInstance.domainDomainCheckAvailabilityCreate2(
|
|
220
|
-
checkAvailability
|
|
221
|
-
);
|
|
222
|
-
```
|
|
223
|
-
|
|
224
|
-
### Parameters
|
|
225
|
-
|
|
226
|
-
|Name | Type | Description | Notes|
|
|
227
|
-
|------------- | ------------- | ------------- | -------------|
|
|
228
|
-
| **checkAvailability** | **CheckAvailability**| | |
|
|
229
|
-
|
|
230
|
-
|
|
231
109
|
### Return type
|
|
232
110
|
|
|
233
111
|
**CheckAvailability**
|
|
@@ -283,61 +161,6 @@ const { status, data } = await apiInstance.domainDomainContactsCreate(
|
|
|
283
161
|
| **domain** | [**string**] | | defaults to undefined|
|
|
284
162
|
|
|
285
163
|
|
|
286
|
-
### Return type
|
|
287
|
-
|
|
288
|
-
**ContactsUpdateResponse**
|
|
289
|
-
|
|
290
|
-
### Authorization
|
|
291
|
-
|
|
292
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
293
|
-
|
|
294
|
-
### HTTP request headers
|
|
295
|
-
|
|
296
|
-
- **Content-Type**: application/json
|
|
297
|
-
- **Accept**: application/json
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
### HTTP response details
|
|
301
|
-
| Status code | Description | Response headers |
|
|
302
|
-
|-------------|-------------|------------------|
|
|
303
|
-
|**200** | | - |
|
|
304
|
-
|
|
305
|
-
[[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)
|
|
306
|
-
|
|
307
|
-
# **domainDomainContactsCreate2**
|
|
308
|
-
> ContactsUpdateResponse domainDomainContactsCreate2(contactsUpdate)
|
|
309
|
-
|
|
310
|
-
Update a contact on this domain using a saved DomainRegistrant.
|
|
311
|
-
|
|
312
|
-
### Example
|
|
313
|
-
|
|
314
|
-
```typescript
|
|
315
|
-
import {
|
|
316
|
-
DomainApi,
|
|
317
|
-
Configuration,
|
|
318
|
-
ContactsUpdate
|
|
319
|
-
} from '@pidginhost/sdk';
|
|
320
|
-
|
|
321
|
-
const configuration = new Configuration();
|
|
322
|
-
const apiInstance = new DomainApi(configuration);
|
|
323
|
-
|
|
324
|
-
let domain: string; // (default to undefined)
|
|
325
|
-
let contactsUpdate: ContactsUpdate; //
|
|
326
|
-
|
|
327
|
-
const { status, data } = await apiInstance.domainDomainContactsCreate2(
|
|
328
|
-
domain,
|
|
329
|
-
contactsUpdate
|
|
330
|
-
);
|
|
331
|
-
```
|
|
332
|
-
|
|
333
|
-
### Parameters
|
|
334
|
-
|
|
335
|
-
|Name | Type | Description | Notes|
|
|
336
|
-
|------------- | ------------- | ------------- | -------------|
|
|
337
|
-
| **contactsUpdate** | **ContactsUpdate**| | |
|
|
338
|
-
| **domain** | [**string**] | | defaults to undefined|
|
|
339
|
-
|
|
340
|
-
|
|
341
164
|
### Return type
|
|
342
165
|
|
|
343
166
|
**ContactsUpdateResponse**
|
|
@@ -390,58 +213,6 @@ const { status, data } = await apiInstance.domainDomainCreate(
|
|
|
390
213
|
| **domainCreate** | **DomainCreate**| | |
|
|
391
214
|
|
|
392
215
|
|
|
393
|
-
### Return type
|
|
394
|
-
|
|
395
|
-
**DomainCreate**
|
|
396
|
-
|
|
397
|
-
### Authorization
|
|
398
|
-
|
|
399
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
400
|
-
|
|
401
|
-
### HTTP request headers
|
|
402
|
-
|
|
403
|
-
- **Content-Type**: application/json
|
|
404
|
-
- **Accept**: application/json
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
### HTTP response details
|
|
408
|
-
| Status code | Description | Response headers |
|
|
409
|
-
|-------------|-------------|------------------|
|
|
410
|
-
|**201** | | - |
|
|
411
|
-
|
|
412
|
-
[[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)
|
|
413
|
-
|
|
414
|
-
# **domainDomainCreate2**
|
|
415
|
-
> DomainCreate domainDomainCreate2(domainCreate)
|
|
416
|
-
|
|
417
|
-
Manage your domains
|
|
418
|
-
|
|
419
|
-
### Example
|
|
420
|
-
|
|
421
|
-
```typescript
|
|
422
|
-
import {
|
|
423
|
-
DomainApi,
|
|
424
|
-
Configuration,
|
|
425
|
-
DomainCreate
|
|
426
|
-
} from '@pidginhost/sdk';
|
|
427
|
-
|
|
428
|
-
const configuration = new Configuration();
|
|
429
|
-
const apiInstance = new DomainApi(configuration);
|
|
430
|
-
|
|
431
|
-
let domainCreate: DomainCreate; //
|
|
432
|
-
|
|
433
|
-
const { status, data } = await apiInstance.domainDomainCreate2(
|
|
434
|
-
domainCreate
|
|
435
|
-
);
|
|
436
|
-
```
|
|
437
|
-
|
|
438
|
-
### Parameters
|
|
439
|
-
|
|
440
|
-
|Name | Type | Description | Notes|
|
|
441
|
-
|------------- | ------------- | ------------- | -------------|
|
|
442
|
-
| **domainCreate** | **DomainCreate**| | |
|
|
443
|
-
|
|
444
|
-
|
|
445
216
|
### Return type
|
|
446
217
|
|
|
447
218
|
**DomainCreate**
|
|
@@ -482,808 +253,7 @@ const apiInstance = new DomainApi(configuration);
|
|
|
482
253
|
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
483
254
|
|
|
484
255
|
const { status, data } = await apiInstance.domainDomainList(
|
|
485
|
-
page
|
|
486
|
-
);
|
|
487
|
-
```
|
|
488
|
-
|
|
489
|
-
### Parameters
|
|
490
|
-
|
|
491
|
-
|Name | Type | Description | Notes|
|
|
492
|
-
|------------- | ------------- | ------------- | -------------|
|
|
493
|
-
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
### Return type
|
|
497
|
-
|
|
498
|
-
**PaginatedDomainList**
|
|
499
|
-
|
|
500
|
-
### Authorization
|
|
501
|
-
|
|
502
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
503
|
-
|
|
504
|
-
### HTTP request headers
|
|
505
|
-
|
|
506
|
-
- **Content-Type**: Not defined
|
|
507
|
-
- **Accept**: application/json
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
### HTTP response details
|
|
511
|
-
| Status code | Description | Response headers |
|
|
512
|
-
|-------------|-------------|------------------|
|
|
513
|
-
|**200** | | - |
|
|
514
|
-
|
|
515
|
-
[[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)
|
|
516
|
-
|
|
517
|
-
# **domainDomainList2**
|
|
518
|
-
> PaginatedDomainList domainDomainList2()
|
|
519
|
-
|
|
520
|
-
Manage your domains
|
|
521
|
-
|
|
522
|
-
### Example
|
|
523
|
-
|
|
524
|
-
```typescript
|
|
525
|
-
import {
|
|
526
|
-
DomainApi,
|
|
527
|
-
Configuration
|
|
528
|
-
} from '@pidginhost/sdk';
|
|
529
|
-
|
|
530
|
-
const configuration = new Configuration();
|
|
531
|
-
const apiInstance = new DomainApi(configuration);
|
|
532
|
-
|
|
533
|
-
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
534
|
-
|
|
535
|
-
const { status, data } = await apiInstance.domainDomainList2(
|
|
536
|
-
page
|
|
537
|
-
);
|
|
538
|
-
```
|
|
539
|
-
|
|
540
|
-
### Parameters
|
|
541
|
-
|
|
542
|
-
|Name | Type | Description | Notes|
|
|
543
|
-
|------------- | ------------- | ------------- | -------------|
|
|
544
|
-
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
### Return type
|
|
548
|
-
|
|
549
|
-
**PaginatedDomainList**
|
|
550
|
-
|
|
551
|
-
### Authorization
|
|
552
|
-
|
|
553
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
554
|
-
|
|
555
|
-
### HTTP request headers
|
|
556
|
-
|
|
557
|
-
- **Content-Type**: Not defined
|
|
558
|
-
- **Accept**: application/json
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
### HTTP response details
|
|
562
|
-
| Status code | Description | Response headers |
|
|
563
|
-
|-------------|-------------|------------------|
|
|
564
|
-
|**200** | | - |
|
|
565
|
-
|
|
566
|
-
[[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)
|
|
567
|
-
|
|
568
|
-
# **domainDomainNameserversCreate**
|
|
569
|
-
> NameserversUpdateResponse domainDomainNameserversCreate(nameserversUpdate)
|
|
570
|
-
|
|
571
|
-
Update nameservers for this domain.
|
|
572
|
-
|
|
573
|
-
### Example
|
|
574
|
-
|
|
575
|
-
```typescript
|
|
576
|
-
import {
|
|
577
|
-
DomainApi,
|
|
578
|
-
Configuration,
|
|
579
|
-
NameserversUpdate
|
|
580
|
-
} from '@pidginhost/sdk';
|
|
581
|
-
|
|
582
|
-
const configuration = new Configuration();
|
|
583
|
-
const apiInstance = new DomainApi(configuration);
|
|
584
|
-
|
|
585
|
-
let domain: string; // (default to undefined)
|
|
586
|
-
let nameserversUpdate: NameserversUpdate; //
|
|
587
|
-
|
|
588
|
-
const { status, data } = await apiInstance.domainDomainNameserversCreate(
|
|
589
|
-
domain,
|
|
590
|
-
nameserversUpdate
|
|
591
|
-
);
|
|
592
|
-
```
|
|
593
|
-
|
|
594
|
-
### Parameters
|
|
595
|
-
|
|
596
|
-
|Name | Type | Description | Notes|
|
|
597
|
-
|------------- | ------------- | ------------- | -------------|
|
|
598
|
-
| **nameserversUpdate** | **NameserversUpdate**| | |
|
|
599
|
-
| **domain** | [**string**] | | defaults to undefined|
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
### Return type
|
|
603
|
-
|
|
604
|
-
**NameserversUpdateResponse**
|
|
605
|
-
|
|
606
|
-
### Authorization
|
|
607
|
-
|
|
608
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
609
|
-
|
|
610
|
-
### HTTP request headers
|
|
611
|
-
|
|
612
|
-
- **Content-Type**: application/json
|
|
613
|
-
- **Accept**: application/json
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
### HTTP response details
|
|
617
|
-
| Status code | Description | Response headers |
|
|
618
|
-
|-------------|-------------|------------------|
|
|
619
|
-
|**200** | | - |
|
|
620
|
-
|
|
621
|
-
[[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)
|
|
622
|
-
|
|
623
|
-
# **domainDomainNameserversCreate2**
|
|
624
|
-
> NameserversUpdateResponse domainDomainNameserversCreate2(nameserversUpdate)
|
|
625
|
-
|
|
626
|
-
Update nameservers for this domain.
|
|
627
|
-
|
|
628
|
-
### Example
|
|
629
|
-
|
|
630
|
-
```typescript
|
|
631
|
-
import {
|
|
632
|
-
DomainApi,
|
|
633
|
-
Configuration,
|
|
634
|
-
NameserversUpdate
|
|
635
|
-
} from '@pidginhost/sdk';
|
|
636
|
-
|
|
637
|
-
const configuration = new Configuration();
|
|
638
|
-
const apiInstance = new DomainApi(configuration);
|
|
639
|
-
|
|
640
|
-
let domain: string; // (default to undefined)
|
|
641
|
-
let nameserversUpdate: NameserversUpdate; //
|
|
642
|
-
|
|
643
|
-
const { status, data } = await apiInstance.domainDomainNameserversCreate2(
|
|
644
|
-
domain,
|
|
645
|
-
nameserversUpdate
|
|
646
|
-
);
|
|
647
|
-
```
|
|
648
|
-
|
|
649
|
-
### Parameters
|
|
650
|
-
|
|
651
|
-
|Name | Type | Description | Notes|
|
|
652
|
-
|------------- | ------------- | ------------- | -------------|
|
|
653
|
-
| **nameserversUpdate** | **NameserversUpdate**| | |
|
|
654
|
-
| **domain** | [**string**] | | defaults to undefined|
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
### Return type
|
|
658
|
-
|
|
659
|
-
**NameserversUpdateResponse**
|
|
660
|
-
|
|
661
|
-
### Authorization
|
|
662
|
-
|
|
663
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
664
|
-
|
|
665
|
-
### HTTP request headers
|
|
666
|
-
|
|
667
|
-
- **Content-Type**: application/json
|
|
668
|
-
- **Accept**: application/json
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
### HTTP response details
|
|
672
|
-
| Status code | Description | Response headers |
|
|
673
|
-
|-------------|-------------|------------------|
|
|
674
|
-
|**200** | | - |
|
|
675
|
-
|
|
676
|
-
[[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)
|
|
677
|
-
|
|
678
|
-
# **domainDomainPartialUpdate**
|
|
679
|
-
> Domain domainDomainPartialUpdate()
|
|
680
|
-
|
|
681
|
-
Manage your domains
|
|
682
|
-
|
|
683
|
-
### Example
|
|
684
|
-
|
|
685
|
-
```typescript
|
|
686
|
-
import {
|
|
687
|
-
DomainApi,
|
|
688
|
-
Configuration,
|
|
689
|
-
PatchedDomain
|
|
690
|
-
} from '@pidginhost/sdk';
|
|
691
|
-
|
|
692
|
-
const configuration = new Configuration();
|
|
693
|
-
const apiInstance = new DomainApi(configuration);
|
|
694
|
-
|
|
695
|
-
let domain: string; // (default to undefined)
|
|
696
|
-
let patchedDomain: PatchedDomain; // (optional)
|
|
697
|
-
|
|
698
|
-
const { status, data } = await apiInstance.domainDomainPartialUpdate(
|
|
699
|
-
domain,
|
|
700
|
-
patchedDomain
|
|
701
|
-
);
|
|
702
|
-
```
|
|
703
|
-
|
|
704
|
-
### Parameters
|
|
705
|
-
|
|
706
|
-
|Name | Type | Description | Notes|
|
|
707
|
-
|------------- | ------------- | ------------- | -------------|
|
|
708
|
-
| **patchedDomain** | **PatchedDomain**| | |
|
|
709
|
-
| **domain** | [**string**] | | defaults to undefined|
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
### Return type
|
|
713
|
-
|
|
714
|
-
**Domain**
|
|
715
|
-
|
|
716
|
-
### Authorization
|
|
717
|
-
|
|
718
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
719
|
-
|
|
720
|
-
### HTTP request headers
|
|
721
|
-
|
|
722
|
-
- **Content-Type**: application/json
|
|
723
|
-
- **Accept**: application/json
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
### HTTP response details
|
|
727
|
-
| Status code | Description | Response headers |
|
|
728
|
-
|-------------|-------------|------------------|
|
|
729
|
-
|**200** | | - |
|
|
730
|
-
|
|
731
|
-
[[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)
|
|
732
|
-
|
|
733
|
-
# **domainDomainPartialUpdate2**
|
|
734
|
-
> Domain domainDomainPartialUpdate2()
|
|
735
|
-
|
|
736
|
-
Manage your domains
|
|
737
|
-
|
|
738
|
-
### Example
|
|
739
|
-
|
|
740
|
-
```typescript
|
|
741
|
-
import {
|
|
742
|
-
DomainApi,
|
|
743
|
-
Configuration,
|
|
744
|
-
PatchedDomain
|
|
745
|
-
} from '@pidginhost/sdk';
|
|
746
|
-
|
|
747
|
-
const configuration = new Configuration();
|
|
748
|
-
const apiInstance = new DomainApi(configuration);
|
|
749
|
-
|
|
750
|
-
let domain: string; // (default to undefined)
|
|
751
|
-
let patchedDomain: PatchedDomain; // (optional)
|
|
752
|
-
|
|
753
|
-
const { status, data } = await apiInstance.domainDomainPartialUpdate2(
|
|
754
|
-
domain,
|
|
755
|
-
patchedDomain
|
|
756
|
-
);
|
|
757
|
-
```
|
|
758
|
-
|
|
759
|
-
### Parameters
|
|
760
|
-
|
|
761
|
-
|Name | Type | Description | Notes|
|
|
762
|
-
|------------- | ------------- | ------------- | -------------|
|
|
763
|
-
| **patchedDomain** | **PatchedDomain**| | |
|
|
764
|
-
| **domain** | [**string**] | | defaults to undefined|
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
### Return type
|
|
768
|
-
|
|
769
|
-
**Domain**
|
|
770
|
-
|
|
771
|
-
### Authorization
|
|
772
|
-
|
|
773
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
774
|
-
|
|
775
|
-
### HTTP request headers
|
|
776
|
-
|
|
777
|
-
- **Content-Type**: application/json
|
|
778
|
-
- **Accept**: application/json
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
### HTTP response details
|
|
782
|
-
| Status code | Description | Response headers |
|
|
783
|
-
|-------------|-------------|------------------|
|
|
784
|
-
|**200** | | - |
|
|
785
|
-
|
|
786
|
-
[[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)
|
|
787
|
-
|
|
788
|
-
# **domainDomainRenewCreate**
|
|
789
|
-
> RenewDomain domainDomainRenewCreate(renewDomain)
|
|
790
|
-
|
|
791
|
-
Manage your domains
|
|
792
|
-
|
|
793
|
-
### Example
|
|
794
|
-
|
|
795
|
-
```typescript
|
|
796
|
-
import {
|
|
797
|
-
DomainApi,
|
|
798
|
-
Configuration,
|
|
799
|
-
RenewDomain
|
|
800
|
-
} from '@pidginhost/sdk';
|
|
801
|
-
|
|
802
|
-
const configuration = new Configuration();
|
|
803
|
-
const apiInstance = new DomainApi(configuration);
|
|
804
|
-
|
|
805
|
-
let domain: string; // (default to undefined)
|
|
806
|
-
let renewDomain: RenewDomain; //
|
|
807
|
-
|
|
808
|
-
const { status, data } = await apiInstance.domainDomainRenewCreate(
|
|
809
|
-
domain,
|
|
810
|
-
renewDomain
|
|
811
|
-
);
|
|
812
|
-
```
|
|
813
|
-
|
|
814
|
-
### Parameters
|
|
815
|
-
|
|
816
|
-
|Name | Type | Description | Notes|
|
|
817
|
-
|------------- | ------------- | ------------- | -------------|
|
|
818
|
-
| **renewDomain** | **RenewDomain**| | |
|
|
819
|
-
| **domain** | [**string**] | | defaults to undefined|
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
### Return type
|
|
823
|
-
|
|
824
|
-
**RenewDomain**
|
|
825
|
-
|
|
826
|
-
### Authorization
|
|
827
|
-
|
|
828
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
829
|
-
|
|
830
|
-
### HTTP request headers
|
|
831
|
-
|
|
832
|
-
- **Content-Type**: application/json
|
|
833
|
-
- **Accept**: application/json
|
|
834
|
-
|
|
835
|
-
|
|
836
|
-
### HTTP response details
|
|
837
|
-
| Status code | Description | Response headers |
|
|
838
|
-
|-------------|-------------|------------------|
|
|
839
|
-
|**200** | | - |
|
|
840
|
-
|
|
841
|
-
[[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)
|
|
842
|
-
|
|
843
|
-
# **domainDomainRenewCreate2**
|
|
844
|
-
> RenewDomain domainDomainRenewCreate2(renewDomain)
|
|
845
|
-
|
|
846
|
-
Manage your domains
|
|
847
|
-
|
|
848
|
-
### Example
|
|
849
|
-
|
|
850
|
-
```typescript
|
|
851
|
-
import {
|
|
852
|
-
DomainApi,
|
|
853
|
-
Configuration,
|
|
854
|
-
RenewDomain
|
|
855
|
-
} from '@pidginhost/sdk';
|
|
856
|
-
|
|
857
|
-
const configuration = new Configuration();
|
|
858
|
-
const apiInstance = new DomainApi(configuration);
|
|
859
|
-
|
|
860
|
-
let domain: string; // (default to undefined)
|
|
861
|
-
let renewDomain: RenewDomain; //
|
|
862
|
-
|
|
863
|
-
const { status, data } = await apiInstance.domainDomainRenewCreate2(
|
|
864
|
-
domain,
|
|
865
|
-
renewDomain
|
|
866
|
-
);
|
|
867
|
-
```
|
|
868
|
-
|
|
869
|
-
### Parameters
|
|
870
|
-
|
|
871
|
-
|Name | Type | Description | Notes|
|
|
872
|
-
|------------- | ------------- | ------------- | -------------|
|
|
873
|
-
| **renewDomain** | **RenewDomain**| | |
|
|
874
|
-
| **domain** | [**string**] | | defaults to undefined|
|
|
875
|
-
|
|
876
|
-
|
|
877
|
-
### Return type
|
|
878
|
-
|
|
879
|
-
**RenewDomain**
|
|
880
|
-
|
|
881
|
-
### Authorization
|
|
882
|
-
|
|
883
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
884
|
-
|
|
885
|
-
### HTTP request headers
|
|
886
|
-
|
|
887
|
-
- **Content-Type**: application/json
|
|
888
|
-
- **Accept**: application/json
|
|
889
|
-
|
|
890
|
-
|
|
891
|
-
### HTTP response details
|
|
892
|
-
| Status code | Description | Response headers |
|
|
893
|
-
|-------------|-------------|------------------|
|
|
894
|
-
|**200** | | - |
|
|
895
|
-
|
|
896
|
-
[[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)
|
|
897
|
-
|
|
898
|
-
# **domainDomainRetrieve**
|
|
899
|
-
> Domain domainDomainRetrieve()
|
|
900
|
-
|
|
901
|
-
Manage your domains
|
|
902
|
-
|
|
903
|
-
### Example
|
|
904
|
-
|
|
905
|
-
```typescript
|
|
906
|
-
import {
|
|
907
|
-
DomainApi,
|
|
908
|
-
Configuration
|
|
909
|
-
} from '@pidginhost/sdk';
|
|
910
|
-
|
|
911
|
-
const configuration = new Configuration();
|
|
912
|
-
const apiInstance = new DomainApi(configuration);
|
|
913
|
-
|
|
914
|
-
let domain: string; // (default to undefined)
|
|
915
|
-
|
|
916
|
-
const { status, data } = await apiInstance.domainDomainRetrieve(
|
|
917
|
-
domain
|
|
918
|
-
);
|
|
919
|
-
```
|
|
920
|
-
|
|
921
|
-
### Parameters
|
|
922
|
-
|
|
923
|
-
|Name | Type | Description | Notes|
|
|
924
|
-
|------------- | ------------- | ------------- | -------------|
|
|
925
|
-
| **domain** | [**string**] | | defaults to undefined|
|
|
926
|
-
|
|
927
|
-
|
|
928
|
-
### Return type
|
|
929
|
-
|
|
930
|
-
**Domain**
|
|
931
|
-
|
|
932
|
-
### Authorization
|
|
933
|
-
|
|
934
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
935
|
-
|
|
936
|
-
### HTTP request headers
|
|
937
|
-
|
|
938
|
-
- **Content-Type**: Not defined
|
|
939
|
-
- **Accept**: application/json
|
|
940
|
-
|
|
941
|
-
|
|
942
|
-
### HTTP response details
|
|
943
|
-
| Status code | Description | Response headers |
|
|
944
|
-
|-------------|-------------|------------------|
|
|
945
|
-
|**200** | | - |
|
|
946
|
-
|
|
947
|
-
[[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)
|
|
948
|
-
|
|
949
|
-
# **domainDomainRetrieve2**
|
|
950
|
-
> Domain domainDomainRetrieve2()
|
|
951
|
-
|
|
952
|
-
Manage your domains
|
|
953
|
-
|
|
954
|
-
### Example
|
|
955
|
-
|
|
956
|
-
```typescript
|
|
957
|
-
import {
|
|
958
|
-
DomainApi,
|
|
959
|
-
Configuration
|
|
960
|
-
} from '@pidginhost/sdk';
|
|
961
|
-
|
|
962
|
-
const configuration = new Configuration();
|
|
963
|
-
const apiInstance = new DomainApi(configuration);
|
|
964
|
-
|
|
965
|
-
let domain: string; // (default to undefined)
|
|
966
|
-
|
|
967
|
-
const { status, data } = await apiInstance.domainDomainRetrieve2(
|
|
968
|
-
domain
|
|
969
|
-
);
|
|
970
|
-
```
|
|
971
|
-
|
|
972
|
-
### Parameters
|
|
973
|
-
|
|
974
|
-
|Name | Type | Description | Notes|
|
|
975
|
-
|------------- | ------------- | ------------- | -------------|
|
|
976
|
-
| **domain** | [**string**] | | defaults to undefined|
|
|
977
|
-
|
|
978
|
-
|
|
979
|
-
### Return type
|
|
980
|
-
|
|
981
|
-
**Domain**
|
|
982
|
-
|
|
983
|
-
### Authorization
|
|
984
|
-
|
|
985
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
986
|
-
|
|
987
|
-
### HTTP request headers
|
|
988
|
-
|
|
989
|
-
- **Content-Type**: Not defined
|
|
990
|
-
- **Accept**: application/json
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
### HTTP response details
|
|
994
|
-
| Status code | Description | Response headers |
|
|
995
|
-
|-------------|-------------|------------------|
|
|
996
|
-
|**200** | | - |
|
|
997
|
-
|
|
998
|
-
[[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)
|
|
999
|
-
|
|
1000
|
-
# **domainDomainTransferRoDomainCreate**
|
|
1001
|
-
> TransferRoDomain domainDomainTransferRoDomainCreate(transferRoDomain)
|
|
1002
|
-
|
|
1003
|
-
Manage your domains
|
|
1004
|
-
|
|
1005
|
-
### Example
|
|
1006
|
-
|
|
1007
|
-
```typescript
|
|
1008
|
-
import {
|
|
1009
|
-
DomainApi,
|
|
1010
|
-
Configuration,
|
|
1011
|
-
TransferRoDomain
|
|
1012
|
-
} from '@pidginhost/sdk';
|
|
1013
|
-
|
|
1014
|
-
const configuration = new Configuration();
|
|
1015
|
-
const apiInstance = new DomainApi(configuration);
|
|
1016
|
-
|
|
1017
|
-
let transferRoDomain: TransferRoDomain; //
|
|
1018
|
-
|
|
1019
|
-
const { status, data } = await apiInstance.domainDomainTransferRoDomainCreate(
|
|
1020
|
-
transferRoDomain
|
|
1021
|
-
);
|
|
1022
|
-
```
|
|
1023
|
-
|
|
1024
|
-
### Parameters
|
|
1025
|
-
|
|
1026
|
-
|Name | Type | Description | Notes|
|
|
1027
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1028
|
-
| **transferRoDomain** | **TransferRoDomain**| | |
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
### Return type
|
|
1032
|
-
|
|
1033
|
-
**TransferRoDomain**
|
|
1034
|
-
|
|
1035
|
-
### Authorization
|
|
1036
|
-
|
|
1037
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1038
|
-
|
|
1039
|
-
### HTTP request headers
|
|
1040
|
-
|
|
1041
|
-
- **Content-Type**: application/json
|
|
1042
|
-
- **Accept**: application/json
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
### HTTP response details
|
|
1046
|
-
| Status code | Description | Response headers |
|
|
1047
|
-
|-------------|-------------|------------------|
|
|
1048
|
-
|**200** | | - |
|
|
1049
|
-
|
|
1050
|
-
[[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)
|
|
1051
|
-
|
|
1052
|
-
# **domainDomainTransferRoDomainCreate2**
|
|
1053
|
-
> TransferRoDomain domainDomainTransferRoDomainCreate2(transferRoDomain)
|
|
1054
|
-
|
|
1055
|
-
Manage your domains
|
|
1056
|
-
|
|
1057
|
-
### Example
|
|
1058
|
-
|
|
1059
|
-
```typescript
|
|
1060
|
-
import {
|
|
1061
|
-
DomainApi,
|
|
1062
|
-
Configuration,
|
|
1063
|
-
TransferRoDomain
|
|
1064
|
-
} from '@pidginhost/sdk';
|
|
1065
|
-
|
|
1066
|
-
const configuration = new Configuration();
|
|
1067
|
-
const apiInstance = new DomainApi(configuration);
|
|
1068
|
-
|
|
1069
|
-
let transferRoDomain: TransferRoDomain; //
|
|
1070
|
-
|
|
1071
|
-
const { status, data } = await apiInstance.domainDomainTransferRoDomainCreate2(
|
|
1072
|
-
transferRoDomain
|
|
1073
|
-
);
|
|
1074
|
-
```
|
|
1075
|
-
|
|
1076
|
-
### Parameters
|
|
1077
|
-
|
|
1078
|
-
|Name | Type | Description | Notes|
|
|
1079
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1080
|
-
| **transferRoDomain** | **TransferRoDomain**| | |
|
|
1081
|
-
|
|
1082
|
-
|
|
1083
|
-
### Return type
|
|
1084
|
-
|
|
1085
|
-
**TransferRoDomain**
|
|
1086
|
-
|
|
1087
|
-
### Authorization
|
|
1088
|
-
|
|
1089
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1090
|
-
|
|
1091
|
-
### HTTP request headers
|
|
1092
|
-
|
|
1093
|
-
- **Content-Type**: application/json
|
|
1094
|
-
- **Accept**: application/json
|
|
1095
|
-
|
|
1096
|
-
|
|
1097
|
-
### HTTP response details
|
|
1098
|
-
| Status code | Description | Response headers |
|
|
1099
|
-
|-------------|-------------|------------------|
|
|
1100
|
-
|**200** | | - |
|
|
1101
|
-
|
|
1102
|
-
[[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)
|
|
1103
|
-
|
|
1104
|
-
# **domainDomainUpdate**
|
|
1105
|
-
> Domain domainDomainUpdate()
|
|
1106
|
-
|
|
1107
|
-
Manage your domains
|
|
1108
|
-
|
|
1109
|
-
### Example
|
|
1110
|
-
|
|
1111
|
-
```typescript
|
|
1112
|
-
import {
|
|
1113
|
-
DomainApi,
|
|
1114
|
-
Configuration,
|
|
1115
|
-
Domain
|
|
1116
|
-
} from '@pidginhost/sdk';
|
|
1117
|
-
|
|
1118
|
-
const configuration = new Configuration();
|
|
1119
|
-
const apiInstance = new DomainApi(configuration);
|
|
1120
|
-
|
|
1121
|
-
let domain: string; // (default to undefined)
|
|
1122
|
-
let domain2: Domain; // (optional)
|
|
1123
|
-
|
|
1124
|
-
const { status, data } = await apiInstance.domainDomainUpdate(
|
|
1125
|
-
domain,
|
|
1126
|
-
domain2
|
|
1127
|
-
);
|
|
1128
|
-
```
|
|
1129
|
-
|
|
1130
|
-
### Parameters
|
|
1131
|
-
|
|
1132
|
-
|Name | Type | Description | Notes|
|
|
1133
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1134
|
-
| **domain2** | **Domain**| | |
|
|
1135
|
-
| **domain** | [**string**] | | defaults to undefined|
|
|
1136
|
-
|
|
1137
|
-
|
|
1138
|
-
### Return type
|
|
1139
|
-
|
|
1140
|
-
**Domain**
|
|
1141
|
-
|
|
1142
|
-
### Authorization
|
|
1143
|
-
|
|
1144
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1145
|
-
|
|
1146
|
-
### HTTP request headers
|
|
1147
|
-
|
|
1148
|
-
- **Content-Type**: application/json
|
|
1149
|
-
- **Accept**: application/json
|
|
1150
|
-
|
|
1151
|
-
|
|
1152
|
-
### HTTP response details
|
|
1153
|
-
| Status code | Description | Response headers |
|
|
1154
|
-
|-------------|-------------|------------------|
|
|
1155
|
-
|**200** | | - |
|
|
1156
|
-
|
|
1157
|
-
[[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)
|
|
1158
|
-
|
|
1159
|
-
# **domainDomainUpdate2**
|
|
1160
|
-
> Domain domainDomainUpdate2()
|
|
1161
|
-
|
|
1162
|
-
Manage your domains
|
|
1163
|
-
|
|
1164
|
-
### Example
|
|
1165
|
-
|
|
1166
|
-
```typescript
|
|
1167
|
-
import {
|
|
1168
|
-
DomainApi,
|
|
1169
|
-
Configuration,
|
|
1170
|
-
Domain
|
|
1171
|
-
} from '@pidginhost/sdk';
|
|
1172
|
-
|
|
1173
|
-
const configuration = new Configuration();
|
|
1174
|
-
const apiInstance = new DomainApi(configuration);
|
|
1175
|
-
|
|
1176
|
-
let domain: string; // (default to undefined)
|
|
1177
|
-
let domain2: Domain; // (optional)
|
|
1178
|
-
|
|
1179
|
-
const { status, data } = await apiInstance.domainDomainUpdate2(
|
|
1180
|
-
domain,
|
|
1181
|
-
domain2
|
|
1182
|
-
);
|
|
1183
|
-
```
|
|
1184
|
-
|
|
1185
|
-
### Parameters
|
|
1186
|
-
|
|
1187
|
-
|Name | Type | Description | Notes|
|
|
1188
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1189
|
-
| **domain2** | **Domain**| | |
|
|
1190
|
-
| **domain** | [**string**] | | defaults to undefined|
|
|
1191
|
-
|
|
1192
|
-
|
|
1193
|
-
### Return type
|
|
1194
|
-
|
|
1195
|
-
**Domain**
|
|
1196
|
-
|
|
1197
|
-
### Authorization
|
|
1198
|
-
|
|
1199
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1200
|
-
|
|
1201
|
-
### HTTP request headers
|
|
1202
|
-
|
|
1203
|
-
- **Content-Type**: application/json
|
|
1204
|
-
- **Accept**: application/json
|
|
1205
|
-
|
|
1206
|
-
|
|
1207
|
-
### HTTP response details
|
|
1208
|
-
| Status code | Description | Response headers |
|
|
1209
|
-
|-------------|-------------|------------------|
|
|
1210
|
-
|**200** | | - |
|
|
1211
|
-
|
|
1212
|
-
[[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)
|
|
1213
|
-
|
|
1214
|
-
# **domainRegistrantsCreate**
|
|
1215
|
-
> DomainRegistrant domainRegistrantsCreate(domainRegistrant)
|
|
1216
|
-
|
|
1217
|
-
Manage your domain registrant views
|
|
1218
|
-
|
|
1219
|
-
### Example
|
|
1220
|
-
|
|
1221
|
-
```typescript
|
|
1222
|
-
import {
|
|
1223
|
-
DomainApi,
|
|
1224
|
-
Configuration,
|
|
1225
|
-
DomainRegistrant
|
|
1226
|
-
} from '@pidginhost/sdk';
|
|
1227
|
-
|
|
1228
|
-
const configuration = new Configuration();
|
|
1229
|
-
const apiInstance = new DomainApi(configuration);
|
|
1230
|
-
|
|
1231
|
-
let domainRegistrant: DomainRegistrant; //
|
|
1232
|
-
|
|
1233
|
-
const { status, data } = await apiInstance.domainRegistrantsCreate(
|
|
1234
|
-
domainRegistrant
|
|
1235
|
-
);
|
|
1236
|
-
```
|
|
1237
|
-
|
|
1238
|
-
### Parameters
|
|
1239
|
-
|
|
1240
|
-
|Name | Type | Description | Notes|
|
|
1241
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1242
|
-
| **domainRegistrant** | **DomainRegistrant**| | |
|
|
1243
|
-
|
|
1244
|
-
|
|
1245
|
-
### Return type
|
|
1246
|
-
|
|
1247
|
-
**DomainRegistrant**
|
|
1248
|
-
|
|
1249
|
-
### Authorization
|
|
1250
|
-
|
|
1251
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1252
|
-
|
|
1253
|
-
### HTTP request headers
|
|
1254
|
-
|
|
1255
|
-
- **Content-Type**: application/json
|
|
1256
|
-
- **Accept**: application/json
|
|
1257
|
-
|
|
1258
|
-
|
|
1259
|
-
### HTTP response details
|
|
1260
|
-
| Status code | Description | Response headers |
|
|
1261
|
-
|-------------|-------------|------------------|
|
|
1262
|
-
|**201** | | - |
|
|
1263
|
-
|
|
1264
|
-
[[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)
|
|
1265
|
-
|
|
1266
|
-
# **domainRegistrantsCreate2**
|
|
1267
|
-
> DomainRegistrant domainRegistrantsCreate2(domainRegistrant)
|
|
1268
|
-
|
|
1269
|
-
Manage your domain registrant views
|
|
1270
|
-
|
|
1271
|
-
### Example
|
|
1272
|
-
|
|
1273
|
-
```typescript
|
|
1274
|
-
import {
|
|
1275
|
-
DomainApi,
|
|
1276
|
-
Configuration,
|
|
1277
|
-
DomainRegistrant
|
|
1278
|
-
} from '@pidginhost/sdk';
|
|
1279
|
-
|
|
1280
|
-
const configuration = new Configuration();
|
|
1281
|
-
const apiInstance = new DomainApi(configuration);
|
|
1282
|
-
|
|
1283
|
-
let domainRegistrant: DomainRegistrant; //
|
|
1284
|
-
|
|
1285
|
-
const { status, data } = await apiInstance.domainRegistrantsCreate2(
|
|
1286
|
-
domainRegistrant
|
|
256
|
+
page
|
|
1287
257
|
);
|
|
1288
258
|
```
|
|
1289
259
|
|
|
@@ -1291,12 +261,12 @@ const { status, data } = await apiInstance.domainRegistrantsCreate2(
|
|
|
1291
261
|
|
|
1292
262
|
|Name | Type | Description | Notes|
|
|
1293
263
|
|------------- | ------------- | ------------- | -------------|
|
|
1294
|
-
| **
|
|
264
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
1295
265
|
|
|
1296
266
|
|
|
1297
267
|
### Return type
|
|
1298
268
|
|
|
1299
|
-
**
|
|
269
|
+
**PaginatedDomainList**
|
|
1300
270
|
|
|
1301
271
|
### Authorization
|
|
1302
272
|
|
|
@@ -1304,37 +274,40 @@ const { status, data } = await apiInstance.domainRegistrantsCreate2(
|
|
|
1304
274
|
|
|
1305
275
|
### HTTP request headers
|
|
1306
276
|
|
|
1307
|
-
- **Content-Type**:
|
|
277
|
+
- **Content-Type**: Not defined
|
|
1308
278
|
- **Accept**: application/json
|
|
1309
279
|
|
|
1310
280
|
|
|
1311
281
|
### HTTP response details
|
|
1312
282
|
| Status code | Description | Response headers |
|
|
1313
283
|
|-------------|-------------|------------------|
|
|
1314
|
-
|**
|
|
284
|
+
|**200** | | - |
|
|
1315
285
|
|
|
1316
286
|
[[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)
|
|
1317
287
|
|
|
1318
|
-
# **
|
|
1319
|
-
>
|
|
288
|
+
# **domainDomainNameserversCreate**
|
|
289
|
+
> NameserversUpdateResponse domainDomainNameserversCreate(nameserversUpdate)
|
|
1320
290
|
|
|
1321
|
-
|
|
291
|
+
Update nameservers for this domain.
|
|
1322
292
|
|
|
1323
293
|
### Example
|
|
1324
294
|
|
|
1325
295
|
```typescript
|
|
1326
296
|
import {
|
|
1327
297
|
DomainApi,
|
|
1328
|
-
Configuration
|
|
298
|
+
Configuration,
|
|
299
|
+
NameserversUpdate
|
|
1329
300
|
} from '@pidginhost/sdk';
|
|
1330
301
|
|
|
1331
302
|
const configuration = new Configuration();
|
|
1332
303
|
const apiInstance = new DomainApi(configuration);
|
|
1333
304
|
|
|
1334
|
-
let
|
|
305
|
+
let domain: string; // (default to undefined)
|
|
306
|
+
let nameserversUpdate: NameserversUpdate; //
|
|
1335
307
|
|
|
1336
|
-
const { status, data } = await apiInstance.
|
|
1337
|
-
|
|
308
|
+
const { status, data } = await apiInstance.domainDomainNameserversCreate(
|
|
309
|
+
domain,
|
|
310
|
+
nameserversUpdate
|
|
1338
311
|
);
|
|
1339
312
|
```
|
|
1340
313
|
|
|
@@ -1342,12 +315,13 @@ const { status, data } = await apiInstance.domainRegistrantsDestroy(
|
|
|
1342
315
|
|
|
1343
316
|
|Name | Type | Description | Notes|
|
|
1344
317
|
|------------- | ------------- | ------------- | -------------|
|
|
1345
|
-
| **
|
|
318
|
+
| **nameserversUpdate** | **NameserversUpdate**| | |
|
|
319
|
+
| **domain** | [**string**] | | defaults to undefined|
|
|
1346
320
|
|
|
1347
321
|
|
|
1348
322
|
### Return type
|
|
1349
323
|
|
|
1350
|
-
|
|
324
|
+
**NameserversUpdateResponse**
|
|
1351
325
|
|
|
1352
326
|
### Authorization
|
|
1353
327
|
|
|
@@ -1355,37 +329,40 @@ void (empty response body)
|
|
|
1355
329
|
|
|
1356
330
|
### HTTP request headers
|
|
1357
331
|
|
|
1358
|
-
- **Content-Type**:
|
|
1359
|
-
- **Accept**:
|
|
332
|
+
- **Content-Type**: application/json
|
|
333
|
+
- **Accept**: application/json
|
|
1360
334
|
|
|
1361
335
|
|
|
1362
336
|
### HTTP response details
|
|
1363
337
|
| Status code | Description | Response headers |
|
|
1364
338
|
|-------------|-------------|------------------|
|
|
1365
|
-
|**
|
|
339
|
+
|**200** | | - |
|
|
1366
340
|
|
|
1367
341
|
[[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)
|
|
1368
342
|
|
|
1369
|
-
# **
|
|
1370
|
-
>
|
|
343
|
+
# **domainDomainPartialUpdate**
|
|
344
|
+
> Domain domainDomainPartialUpdate()
|
|
1371
345
|
|
|
1372
|
-
Manage your
|
|
346
|
+
Manage your domains
|
|
1373
347
|
|
|
1374
348
|
### Example
|
|
1375
349
|
|
|
1376
350
|
```typescript
|
|
1377
351
|
import {
|
|
1378
352
|
DomainApi,
|
|
1379
|
-
Configuration
|
|
353
|
+
Configuration,
|
|
354
|
+
PatchedDomain
|
|
1380
355
|
} from '@pidginhost/sdk';
|
|
1381
356
|
|
|
1382
357
|
const configuration = new Configuration();
|
|
1383
358
|
const apiInstance = new DomainApi(configuration);
|
|
1384
359
|
|
|
1385
|
-
let
|
|
360
|
+
let domain: string; // (default to undefined)
|
|
361
|
+
let patchedDomain: PatchedDomain; // (optional)
|
|
1386
362
|
|
|
1387
|
-
const { status, data } = await apiInstance.
|
|
1388
|
-
|
|
363
|
+
const { status, data } = await apiInstance.domainDomainPartialUpdate(
|
|
364
|
+
domain,
|
|
365
|
+
patchedDomain
|
|
1389
366
|
);
|
|
1390
367
|
```
|
|
1391
368
|
|
|
@@ -1393,12 +370,13 @@ const { status, data } = await apiInstance.domainRegistrantsDestroy2(
|
|
|
1393
370
|
|
|
1394
371
|
|Name | Type | Description | Notes|
|
|
1395
372
|
|------------- | ------------- | ------------- | -------------|
|
|
1396
|
-
| **
|
|
373
|
+
| **patchedDomain** | **PatchedDomain**| | |
|
|
374
|
+
| **domain** | [**string**] | | defaults to undefined|
|
|
1397
375
|
|
|
1398
376
|
|
|
1399
377
|
### Return type
|
|
1400
378
|
|
|
1401
|
-
|
|
379
|
+
**Domain**
|
|
1402
380
|
|
|
1403
381
|
### Authorization
|
|
1404
382
|
|
|
@@ -1406,37 +384,40 @@ void (empty response body)
|
|
|
1406
384
|
|
|
1407
385
|
### HTTP request headers
|
|
1408
386
|
|
|
1409
|
-
- **Content-Type**:
|
|
1410
|
-
- **Accept**:
|
|
387
|
+
- **Content-Type**: application/json
|
|
388
|
+
- **Accept**: application/json
|
|
1411
389
|
|
|
1412
390
|
|
|
1413
391
|
### HTTP response details
|
|
1414
392
|
| Status code | Description | Response headers |
|
|
1415
393
|
|-------------|-------------|------------------|
|
|
1416
|
-
|**
|
|
394
|
+
|**200** | | - |
|
|
1417
395
|
|
|
1418
396
|
[[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)
|
|
1419
397
|
|
|
1420
|
-
# **
|
|
1421
|
-
>
|
|
398
|
+
# **domainDomainRenewCreate**
|
|
399
|
+
> RenewDomain domainDomainRenewCreate(renewDomain)
|
|
1422
400
|
|
|
1423
|
-
Manage your
|
|
401
|
+
Manage your domains
|
|
1424
402
|
|
|
1425
403
|
### Example
|
|
1426
404
|
|
|
1427
405
|
```typescript
|
|
1428
406
|
import {
|
|
1429
407
|
DomainApi,
|
|
1430
|
-
Configuration
|
|
408
|
+
Configuration,
|
|
409
|
+
RenewDomain
|
|
1431
410
|
} from '@pidginhost/sdk';
|
|
1432
411
|
|
|
1433
412
|
const configuration = new Configuration();
|
|
1434
413
|
const apiInstance = new DomainApi(configuration);
|
|
1435
414
|
|
|
1436
|
-
let
|
|
415
|
+
let domain: string; // (default to undefined)
|
|
416
|
+
let renewDomain: RenewDomain; //
|
|
1437
417
|
|
|
1438
|
-
const { status, data } = await apiInstance.
|
|
1439
|
-
|
|
418
|
+
const { status, data } = await apiInstance.domainDomainRenewCreate(
|
|
419
|
+
domain,
|
|
420
|
+
renewDomain
|
|
1440
421
|
);
|
|
1441
422
|
```
|
|
1442
423
|
|
|
@@ -1444,12 +425,13 @@ const { status, data } = await apiInstance.domainRegistrantsList(
|
|
|
1444
425
|
|
|
1445
426
|
|Name | Type | Description | Notes|
|
|
1446
427
|
|------------- | ------------- | ------------- | -------------|
|
|
1447
|
-
| **
|
|
428
|
+
| **renewDomain** | **RenewDomain**| | |
|
|
429
|
+
| **domain** | [**string**] | | defaults to undefined|
|
|
1448
430
|
|
|
1449
431
|
|
|
1450
432
|
### Return type
|
|
1451
433
|
|
|
1452
|
-
**
|
|
434
|
+
**RenewDomain**
|
|
1453
435
|
|
|
1454
436
|
### Authorization
|
|
1455
437
|
|
|
@@ -1457,7 +439,7 @@ const { status, data } = await apiInstance.domainRegistrantsList(
|
|
|
1457
439
|
|
|
1458
440
|
### HTTP request headers
|
|
1459
441
|
|
|
1460
|
-
- **Content-Type**:
|
|
442
|
+
- **Content-Type**: application/json
|
|
1461
443
|
- **Accept**: application/json
|
|
1462
444
|
|
|
1463
445
|
|
|
@@ -1468,10 +450,10 @@ const { status, data } = await apiInstance.domainRegistrantsList(
|
|
|
1468
450
|
|
|
1469
451
|
[[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)
|
|
1470
452
|
|
|
1471
|
-
# **
|
|
1472
|
-
>
|
|
453
|
+
# **domainDomainRetrieve**
|
|
454
|
+
> Domain domainDomainRetrieve()
|
|
1473
455
|
|
|
1474
|
-
Manage your
|
|
456
|
+
Manage your domains
|
|
1475
457
|
|
|
1476
458
|
### Example
|
|
1477
459
|
|
|
@@ -1484,10 +466,10 @@ import {
|
|
|
1484
466
|
const configuration = new Configuration();
|
|
1485
467
|
const apiInstance = new DomainApi(configuration);
|
|
1486
468
|
|
|
1487
|
-
let
|
|
469
|
+
let domain: string; // (default to undefined)
|
|
1488
470
|
|
|
1489
|
-
const { status, data } = await apiInstance.
|
|
1490
|
-
|
|
471
|
+
const { status, data } = await apiInstance.domainDomainRetrieve(
|
|
472
|
+
domain
|
|
1491
473
|
);
|
|
1492
474
|
```
|
|
1493
475
|
|
|
@@ -1495,12 +477,12 @@ const { status, data } = await apiInstance.domainRegistrantsList2(
|
|
|
1495
477
|
|
|
1496
478
|
|Name | Type | Description | Notes|
|
|
1497
479
|
|------------- | ------------- | ------------- | -------------|
|
|
1498
|
-
| **
|
|
480
|
+
| **domain** | [**string**] | | defaults to undefined|
|
|
1499
481
|
|
|
1500
482
|
|
|
1501
483
|
### Return type
|
|
1502
484
|
|
|
1503
|
-
**
|
|
485
|
+
**Domain**
|
|
1504
486
|
|
|
1505
487
|
### Authorization
|
|
1506
488
|
|
|
@@ -1519,10 +501,10 @@ const { status, data } = await apiInstance.domainRegistrantsList2(
|
|
|
1519
501
|
|
|
1520
502
|
[[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)
|
|
1521
503
|
|
|
1522
|
-
# **
|
|
1523
|
-
>
|
|
504
|
+
# **domainDomainTransferRoDomainCreate**
|
|
505
|
+
> TransferRoDomain domainDomainTransferRoDomainCreate(transferRoDomain)
|
|
1524
506
|
|
|
1525
|
-
Manage your
|
|
507
|
+
Manage your domains
|
|
1526
508
|
|
|
1527
509
|
### Example
|
|
1528
510
|
|
|
@@ -1530,18 +512,16 @@ Manage your domain registrant views
|
|
|
1530
512
|
import {
|
|
1531
513
|
DomainApi,
|
|
1532
514
|
Configuration,
|
|
1533
|
-
|
|
515
|
+
TransferRoDomain
|
|
1534
516
|
} from '@pidginhost/sdk';
|
|
1535
517
|
|
|
1536
518
|
const configuration = new Configuration();
|
|
1537
519
|
const apiInstance = new DomainApi(configuration);
|
|
1538
520
|
|
|
1539
|
-
let
|
|
1540
|
-
let patchedDomainRegistrant: PatchedDomainRegistrant; // (optional)
|
|
521
|
+
let transferRoDomain: TransferRoDomain; //
|
|
1541
522
|
|
|
1542
|
-
const { status, data } = await apiInstance.
|
|
1543
|
-
|
|
1544
|
-
patchedDomainRegistrant
|
|
523
|
+
const { status, data } = await apiInstance.domainDomainTransferRoDomainCreate(
|
|
524
|
+
transferRoDomain
|
|
1545
525
|
);
|
|
1546
526
|
```
|
|
1547
527
|
|
|
@@ -1549,13 +529,12 @@ const { status, data } = await apiInstance.domainRegistrantsPartialUpdate(
|
|
|
1549
529
|
|
|
1550
530
|
|Name | Type | Description | Notes|
|
|
1551
531
|
|------------- | ------------- | ------------- | -------------|
|
|
1552
|
-
| **
|
|
1553
|
-
| **id** | [**string**] | | defaults to undefined|
|
|
532
|
+
| **transferRoDomain** | **TransferRoDomain**| | |
|
|
1554
533
|
|
|
1555
534
|
|
|
1556
535
|
### Return type
|
|
1557
536
|
|
|
1558
|
-
**
|
|
537
|
+
**TransferRoDomain**
|
|
1559
538
|
|
|
1560
539
|
### Authorization
|
|
1561
540
|
|
|
@@ -1574,10 +553,10 @@ const { status, data } = await apiInstance.domainRegistrantsPartialUpdate(
|
|
|
1574
553
|
|
|
1575
554
|
[[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)
|
|
1576
555
|
|
|
1577
|
-
# **
|
|
1578
|
-
>
|
|
556
|
+
# **domainDomainUpdate**
|
|
557
|
+
> Domain domainDomainUpdate()
|
|
1579
558
|
|
|
1580
|
-
Manage your
|
|
559
|
+
Manage your domains
|
|
1581
560
|
|
|
1582
561
|
### Example
|
|
1583
562
|
|
|
@@ -1585,18 +564,18 @@ Manage your domain registrant views
|
|
|
1585
564
|
import {
|
|
1586
565
|
DomainApi,
|
|
1587
566
|
Configuration,
|
|
1588
|
-
|
|
567
|
+
Domain
|
|
1589
568
|
} from '@pidginhost/sdk';
|
|
1590
569
|
|
|
1591
570
|
const configuration = new Configuration();
|
|
1592
571
|
const apiInstance = new DomainApi(configuration);
|
|
1593
572
|
|
|
1594
|
-
let
|
|
1595
|
-
let
|
|
573
|
+
let domain: string; // (default to undefined)
|
|
574
|
+
let domain2: Domain; // (optional)
|
|
1596
575
|
|
|
1597
|
-
const { status, data } = await apiInstance.
|
|
1598
|
-
|
|
1599
|
-
|
|
576
|
+
const { status, data } = await apiInstance.domainDomainUpdate(
|
|
577
|
+
domain,
|
|
578
|
+
domain2
|
|
1600
579
|
);
|
|
1601
580
|
```
|
|
1602
581
|
|
|
@@ -1604,13 +583,13 @@ const { status, data } = await apiInstance.domainRegistrantsPartialUpdate2(
|
|
|
1604
583
|
|
|
1605
584
|
|Name | Type | Description | Notes|
|
|
1606
585
|
|------------- | ------------- | ------------- | -------------|
|
|
1607
|
-
| **
|
|
1608
|
-
| **
|
|
586
|
+
| **domain2** | **Domain**| | |
|
|
587
|
+
| **domain** | [**string**] | | defaults to undefined|
|
|
1609
588
|
|
|
1610
589
|
|
|
1611
590
|
### Return type
|
|
1612
591
|
|
|
1613
|
-
**
|
|
592
|
+
**Domain**
|
|
1614
593
|
|
|
1615
594
|
### Authorization
|
|
1616
595
|
|
|
@@ -1629,8 +608,8 @@ const { status, data } = await apiInstance.domainRegistrantsPartialUpdate2(
|
|
|
1629
608
|
|
|
1630
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)
|
|
1631
610
|
|
|
1632
|
-
# **
|
|
1633
|
-
> DomainRegistrant
|
|
611
|
+
# **domainRegistrantsCreate**
|
|
612
|
+
> DomainRegistrant domainRegistrantsCreate(domainRegistrant)
|
|
1634
613
|
|
|
1635
614
|
Manage your domain registrant views
|
|
1636
615
|
|
|
@@ -1639,16 +618,17 @@ Manage your domain registrant views
|
|
|
1639
618
|
```typescript
|
|
1640
619
|
import {
|
|
1641
620
|
DomainApi,
|
|
1642
|
-
Configuration
|
|
621
|
+
Configuration,
|
|
622
|
+
DomainRegistrant
|
|
1643
623
|
} from '@pidginhost/sdk';
|
|
1644
624
|
|
|
1645
625
|
const configuration = new Configuration();
|
|
1646
626
|
const apiInstance = new DomainApi(configuration);
|
|
1647
627
|
|
|
1648
|
-
let
|
|
628
|
+
let domainRegistrant: DomainRegistrant; //
|
|
1649
629
|
|
|
1650
|
-
const { status, data } = await apiInstance.
|
|
1651
|
-
|
|
630
|
+
const { status, data } = await apiInstance.domainRegistrantsCreate(
|
|
631
|
+
domainRegistrant
|
|
1652
632
|
);
|
|
1653
633
|
```
|
|
1654
634
|
|
|
@@ -1656,7 +636,7 @@ const { status, data } = await apiInstance.domainRegistrantsRetrieve(
|
|
|
1656
636
|
|
|
1657
637
|
|Name | Type | Description | Notes|
|
|
1658
638
|
|------------- | ------------- | ------------- | -------------|
|
|
1659
|
-
| **
|
|
639
|
+
| **domainRegistrant** | **DomainRegistrant**| | |
|
|
1660
640
|
|
|
1661
641
|
|
|
1662
642
|
### Return type
|
|
@@ -1669,19 +649,19 @@ const { status, data } = await apiInstance.domainRegistrantsRetrieve(
|
|
|
1669
649
|
|
|
1670
650
|
### HTTP request headers
|
|
1671
651
|
|
|
1672
|
-
- **Content-Type**:
|
|
652
|
+
- **Content-Type**: application/json
|
|
1673
653
|
- **Accept**: application/json
|
|
1674
654
|
|
|
1675
655
|
|
|
1676
656
|
### HTTP response details
|
|
1677
657
|
| Status code | Description | Response headers |
|
|
1678
658
|
|-------------|-------------|------------------|
|
|
1679
|
-
|**
|
|
659
|
+
|**201** | | - |
|
|
1680
660
|
|
|
1681
661
|
[[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)
|
|
1682
662
|
|
|
1683
|
-
# **
|
|
1684
|
-
>
|
|
663
|
+
# **domainRegistrantsDestroy**
|
|
664
|
+
> domainRegistrantsDestroy()
|
|
1685
665
|
|
|
1686
666
|
Manage your domain registrant views
|
|
1687
667
|
|
|
@@ -1698,7 +678,7 @@ const apiInstance = new DomainApi(configuration);
|
|
|
1698
678
|
|
|
1699
679
|
let id: string; // (default to undefined)
|
|
1700
680
|
|
|
1701
|
-
const { status, data } = await apiInstance.
|
|
681
|
+
const { status, data } = await apiInstance.domainRegistrantsDestroy(
|
|
1702
682
|
id
|
|
1703
683
|
);
|
|
1704
684
|
```
|
|
@@ -1712,7 +692,7 @@ const { status, data } = await apiInstance.domainRegistrantsRetrieve2(
|
|
|
1712
692
|
|
|
1713
693
|
### Return type
|
|
1714
694
|
|
|
1715
|
-
|
|
695
|
+
void (empty response body)
|
|
1716
696
|
|
|
1717
697
|
### Authorization
|
|
1718
698
|
|
|
@@ -1721,18 +701,18 @@ const { status, data } = await apiInstance.domainRegistrantsRetrieve2(
|
|
|
1721
701
|
### HTTP request headers
|
|
1722
702
|
|
|
1723
703
|
- **Content-Type**: Not defined
|
|
1724
|
-
- **Accept**:
|
|
704
|
+
- **Accept**: Not defined
|
|
1725
705
|
|
|
1726
706
|
|
|
1727
707
|
### HTTP response details
|
|
1728
708
|
| Status code | Description | Response headers |
|
|
1729
709
|
|-------------|-------------|------------------|
|
|
1730
|
-
|**
|
|
710
|
+
|**204** | No response body | - |
|
|
1731
711
|
|
|
1732
712
|
[[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)
|
|
1733
713
|
|
|
1734
|
-
# **
|
|
1735
|
-
>
|
|
714
|
+
# **domainRegistrantsList**
|
|
715
|
+
> PaginatedDomainRegistrantList domainRegistrantsList()
|
|
1736
716
|
|
|
1737
717
|
Manage your domain registrant views
|
|
1738
718
|
|
|
@@ -1741,19 +721,16 @@ Manage your domain registrant views
|
|
|
1741
721
|
```typescript
|
|
1742
722
|
import {
|
|
1743
723
|
DomainApi,
|
|
1744
|
-
Configuration
|
|
1745
|
-
DomainRegistrant
|
|
724
|
+
Configuration
|
|
1746
725
|
} from '@pidginhost/sdk';
|
|
1747
726
|
|
|
1748
727
|
const configuration = new Configuration();
|
|
1749
728
|
const apiInstance = new DomainApi(configuration);
|
|
1750
729
|
|
|
1751
|
-
let
|
|
1752
|
-
let domainRegistrant: DomainRegistrant; //
|
|
730
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
1753
731
|
|
|
1754
|
-
const { status, data } = await apiInstance.
|
|
1755
|
-
|
|
1756
|
-
domainRegistrant
|
|
732
|
+
const { status, data } = await apiInstance.domainRegistrantsList(
|
|
733
|
+
page
|
|
1757
734
|
);
|
|
1758
735
|
```
|
|
1759
736
|
|
|
@@ -1761,13 +738,12 @@ const { status, data } = await apiInstance.domainRegistrantsUpdate(
|
|
|
1761
738
|
|
|
1762
739
|
|Name | Type | Description | Notes|
|
|
1763
740
|
|------------- | ------------- | ------------- | -------------|
|
|
1764
|
-
| **
|
|
1765
|
-
| **id** | [**string**] | | defaults to undefined|
|
|
741
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
1766
742
|
|
|
1767
743
|
|
|
1768
744
|
### Return type
|
|
1769
745
|
|
|
1770
|
-
**
|
|
746
|
+
**PaginatedDomainRegistrantList**
|
|
1771
747
|
|
|
1772
748
|
### Authorization
|
|
1773
749
|
|
|
@@ -1775,7 +751,7 @@ const { status, data } = await apiInstance.domainRegistrantsUpdate(
|
|
|
1775
751
|
|
|
1776
752
|
### HTTP request headers
|
|
1777
753
|
|
|
1778
|
-
- **Content-Type**:
|
|
754
|
+
- **Content-Type**: Not defined
|
|
1779
755
|
- **Accept**: application/json
|
|
1780
756
|
|
|
1781
757
|
|
|
@@ -1786,8 +762,8 @@ const { status, data } = await apiInstance.domainRegistrantsUpdate(
|
|
|
1786
762
|
|
|
1787
763
|
[[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)
|
|
1788
764
|
|
|
1789
|
-
# **
|
|
1790
|
-
> DomainRegistrant
|
|
765
|
+
# **domainRegistrantsPartialUpdate**
|
|
766
|
+
> DomainRegistrant domainRegistrantsPartialUpdate()
|
|
1791
767
|
|
|
1792
768
|
Manage your domain registrant views
|
|
1793
769
|
|
|
@@ -1797,18 +773,18 @@ Manage your domain registrant views
|
|
|
1797
773
|
import {
|
|
1798
774
|
DomainApi,
|
|
1799
775
|
Configuration,
|
|
1800
|
-
|
|
776
|
+
PatchedDomainRegistrant
|
|
1801
777
|
} from '@pidginhost/sdk';
|
|
1802
778
|
|
|
1803
779
|
const configuration = new Configuration();
|
|
1804
780
|
const apiInstance = new DomainApi(configuration);
|
|
1805
781
|
|
|
1806
782
|
let id: string; // (default to undefined)
|
|
1807
|
-
let
|
|
783
|
+
let patchedDomainRegistrant: PatchedDomainRegistrant; // (optional)
|
|
1808
784
|
|
|
1809
|
-
const { status, data } = await apiInstance.
|
|
785
|
+
const { status, data } = await apiInstance.domainRegistrantsPartialUpdate(
|
|
1810
786
|
id,
|
|
1811
|
-
|
|
787
|
+
patchedDomainRegistrant
|
|
1812
788
|
);
|
|
1813
789
|
```
|
|
1814
790
|
|
|
@@ -1816,7 +792,7 @@ const { status, data } = await apiInstance.domainRegistrantsUpdate2(
|
|
|
1816
792
|
|
|
1817
793
|
|Name | Type | Description | Notes|
|
|
1818
794
|
|------------- | ------------- | ------------- | -------------|
|
|
1819
|
-
| **
|
|
795
|
+
| **patchedDomainRegistrant** | **PatchedDomainRegistrant**| | |
|
|
1820
796
|
| **id** | [**string**] | | defaults to undefined|
|
|
1821
797
|
|
|
1822
798
|
|
|
@@ -1841,10 +817,10 @@ const { status, data } = await apiInstance.domainRegistrantsUpdate2(
|
|
|
1841
817
|
|
|
1842
818
|
[[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)
|
|
1843
819
|
|
|
1844
|
-
# **
|
|
1845
|
-
>
|
|
820
|
+
# **domainRegistrantsRetrieve**
|
|
821
|
+
> DomainRegistrant domainRegistrantsRetrieve()
|
|
1846
822
|
|
|
1847
|
-
Manage your
|
|
823
|
+
Manage your domain registrant views
|
|
1848
824
|
|
|
1849
825
|
### Example
|
|
1850
826
|
|
|
@@ -1857,10 +833,10 @@ import {
|
|
|
1857
833
|
const configuration = new Configuration();
|
|
1858
834
|
const apiInstance = new DomainApi(configuration);
|
|
1859
835
|
|
|
1860
|
-
let
|
|
836
|
+
let id: string; // (default to undefined)
|
|
1861
837
|
|
|
1862
|
-
const { status, data } = await apiInstance.
|
|
1863
|
-
|
|
838
|
+
const { status, data } = await apiInstance.domainRegistrantsRetrieve(
|
|
839
|
+
id
|
|
1864
840
|
);
|
|
1865
841
|
```
|
|
1866
842
|
|
|
@@ -1868,12 +844,12 @@ const { status, data } = await apiInstance.domainTldList(
|
|
|
1868
844
|
|
|
1869
845
|
|Name | Type | Description | Notes|
|
|
1870
846
|
|------------- | ------------- | ------------- | -------------|
|
|
1871
|
-
| **
|
|
847
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
1872
848
|
|
|
1873
849
|
|
|
1874
850
|
### Return type
|
|
1875
851
|
|
|
1876
|
-
**
|
|
852
|
+
**DomainRegistrant**
|
|
1877
853
|
|
|
1878
854
|
### Authorization
|
|
1879
855
|
|
|
@@ -1892,26 +868,29 @@ const { status, data } = await apiInstance.domainTldList(
|
|
|
1892
868
|
|
|
1893
869
|
[[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)
|
|
1894
870
|
|
|
1895
|
-
# **
|
|
1896
|
-
>
|
|
871
|
+
# **domainRegistrantsUpdate**
|
|
872
|
+
> DomainRegistrant domainRegistrantsUpdate(domainRegistrant)
|
|
1897
873
|
|
|
1898
|
-
Manage your
|
|
874
|
+
Manage your domain registrant views
|
|
1899
875
|
|
|
1900
876
|
### Example
|
|
1901
877
|
|
|
1902
878
|
```typescript
|
|
1903
879
|
import {
|
|
1904
880
|
DomainApi,
|
|
1905
|
-
Configuration
|
|
881
|
+
Configuration,
|
|
882
|
+
DomainRegistrant
|
|
1906
883
|
} from '@pidginhost/sdk';
|
|
1907
884
|
|
|
1908
885
|
const configuration = new Configuration();
|
|
1909
886
|
const apiInstance = new DomainApi(configuration);
|
|
1910
887
|
|
|
1911
|
-
let
|
|
888
|
+
let id: string; // (default to undefined)
|
|
889
|
+
let domainRegistrant: DomainRegistrant; //
|
|
1912
890
|
|
|
1913
|
-
const { status, data } = await apiInstance.
|
|
1914
|
-
|
|
891
|
+
const { status, data } = await apiInstance.domainRegistrantsUpdate(
|
|
892
|
+
id,
|
|
893
|
+
domainRegistrant
|
|
1915
894
|
);
|
|
1916
895
|
```
|
|
1917
896
|
|
|
@@ -1919,12 +898,13 @@ const { status, data } = await apiInstance.domainTldList2(
|
|
|
1919
898
|
|
|
1920
899
|
|Name | Type | Description | Notes|
|
|
1921
900
|
|------------- | ------------- | ------------- | -------------|
|
|
1922
|
-
| **
|
|
901
|
+
| **domainRegistrant** | **DomainRegistrant**| | |
|
|
902
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
1923
903
|
|
|
1924
904
|
|
|
1925
905
|
### Return type
|
|
1926
906
|
|
|
1927
|
-
**
|
|
907
|
+
**DomainRegistrant**
|
|
1928
908
|
|
|
1929
909
|
### Authorization
|
|
1930
910
|
|
|
@@ -1932,7 +912,7 @@ const { status, data } = await apiInstance.domainTldList2(
|
|
|
1932
912
|
|
|
1933
913
|
### HTTP request headers
|
|
1934
914
|
|
|
1935
|
-
- **Content-Type**:
|
|
915
|
+
- **Content-Type**: application/json
|
|
1936
916
|
- **Accept**: application/json
|
|
1937
917
|
|
|
1938
918
|
|
|
@@ -1943,8 +923,8 @@ const { status, data } = await apiInstance.domainTldList2(
|
|
|
1943
923
|
|
|
1944
924
|
[[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
925
|
|
|
1946
|
-
# **
|
|
1947
|
-
>
|
|
926
|
+
# **domainTldList**
|
|
927
|
+
> PaginatedTLDList domainTldList()
|
|
1948
928
|
|
|
1949
929
|
Manage your TLDs
|
|
1950
930
|
|
|
@@ -1959,10 +939,10 @@ import {
|
|
|
1959
939
|
const configuration = new Configuration();
|
|
1960
940
|
const apiInstance = new DomainApi(configuration);
|
|
1961
941
|
|
|
1962
|
-
let
|
|
942
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
1963
943
|
|
|
1964
|
-
const { status, data } = await apiInstance.
|
|
1965
|
-
|
|
944
|
+
const { status, data } = await apiInstance.domainTldList(
|
|
945
|
+
page
|
|
1966
946
|
);
|
|
1967
947
|
```
|
|
1968
948
|
|
|
@@ -1970,12 +950,12 @@ const { status, data } = await apiInstance.domainTldRetrieve(
|
|
|
1970
950
|
|
|
1971
951
|
|Name | Type | Description | Notes|
|
|
1972
952
|
|------------- | ------------- | ------------- | -------------|
|
|
1973
|
-
| **
|
|
953
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
1974
954
|
|
|
1975
955
|
|
|
1976
956
|
### Return type
|
|
1977
957
|
|
|
1978
|
-
**
|
|
958
|
+
**PaginatedTLDList**
|
|
1979
959
|
|
|
1980
960
|
### Authorization
|
|
1981
961
|
|
|
@@ -1994,8 +974,8 @@ const { status, data } = await apiInstance.domainTldRetrieve(
|
|
|
1994
974
|
|
|
1995
975
|
[[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)
|
|
1996
976
|
|
|
1997
|
-
# **
|
|
1998
|
-
> TLD
|
|
977
|
+
# **domainTldRetrieve**
|
|
978
|
+
> TLD domainTldRetrieve()
|
|
1999
979
|
|
|
2000
980
|
Manage your TLDs
|
|
2001
981
|
|
|
@@ -2012,7 +992,7 @@ const apiInstance = new DomainApi(configuration);
|
|
|
2012
992
|
|
|
2013
993
|
let id: number; //A unique integer value identifying this top level domain. (default to undefined)
|
|
2014
994
|
|
|
2015
|
-
const { status, data } = await apiInstance.
|
|
995
|
+
const { status, data } = await apiInstance.domainTldRetrieve(
|
|
2016
996
|
id
|
|
2017
997
|
);
|
|
2018
998
|
```
|