@pidginhost/sdk 0.3.0 → 0.6.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.
@@ -5,17 +5,11 @@ All URIs are relative to *https://www.pidginhost.com*
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
7
  |[**freednsDnsActivateCreate**](#freednsdnsactivatecreate) | **POST** /api/freedns/dns/activate/ | |
8
- |[**freednsDnsActivateCreate2**](#freednsdnsactivatecreate2) | **POST** /api/v1/freedns/dns/activate/ | |
9
8
  |[**freednsDnsAddRecordCreate**](#freednsdnsaddrecordcreate) | **POST** /api/freedns/dns/add-record/ | |
10
- |[**freednsDnsAddRecordCreate2**](#freednsdnsaddrecordcreate2) | **POST** /api/v1/freedns/dns/add-record/ | |
11
9
  |[**freednsDnsDeactivateCreate**](#freednsdnsdeactivatecreate) | **POST** /api/freedns/dns/deactivate/ | |
12
- |[**freednsDnsDeactivateCreate2**](#freednsdnsdeactivatecreate2) | **POST** /api/v1/freedns/dns/deactivate/ | |
13
10
  |[**freednsDnsDeleteRecordCreate**](#freednsdnsdeleterecordcreate) | **POST** /api/freedns/dns/delete-record/ | |
14
- |[**freednsDnsDeleteRecordCreate2**](#freednsdnsdeleterecordcreate2) | **POST** /api/v1/freedns/dns/delete-record/ | |
15
11
  |[**freednsDnsList**](#freednsdnslist) | **GET** /api/freedns/dns/ | |
16
- |[**freednsDnsList2**](#freednsdnslist2) | **GET** /api/v1/freedns/dns/ | |
17
12
  |[**freednsDnsRecordsList**](#freednsdnsrecordslist) | **GET** /api/freedns/dns/records/ | |
18
- |[**freednsDnsRecordsList2**](#freednsdnsrecordslist2) | **GET** /api/v1/freedns/dns/records/ | |
19
13
 
20
14
  # **freednsDnsActivateCreate**
21
15
  > ActivateFreeDNSResponse freednsDnsActivateCreate(activateFreeDNS)
@@ -48,58 +42,6 @@ const { status, data } = await apiInstance.freednsDnsActivateCreate(
48
42
  | **activateFreeDNS** | **ActivateFreeDNS**| | |
49
43
 
50
44
 
51
- ### Return type
52
-
53
- **ActivateFreeDNSResponse**
54
-
55
- ### Authorization
56
-
57
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
58
-
59
- ### HTTP request headers
60
-
61
- - **Content-Type**: application/json
62
- - **Accept**: application/json
63
-
64
-
65
- ### HTTP response details
66
- | Status code | Description | Response headers |
67
- |-------------|-------------|------------------|
68
- |**200** | | - |
69
-
70
- [[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)
71
-
72
- # **freednsDnsActivateCreate2**
73
- > ActivateFreeDNSResponse freednsDnsActivateCreate2(activateFreeDNS)
74
-
75
- Activate FreeDNS for a domain. For internal domains the nameservers are changed to PidginHost NS. A default zone is created on the cPanel node.
76
-
77
- ### Example
78
-
79
- ```typescript
80
- import {
81
- FreednsApi,
82
- Configuration,
83
- ActivateFreeDNS
84
- } from '@pidginhost/sdk';
85
-
86
- const configuration = new Configuration();
87
- const apiInstance = new FreednsApi(configuration);
88
-
89
- let activateFreeDNS: ActivateFreeDNS; //
90
-
91
- const { status, data } = await apiInstance.freednsDnsActivateCreate2(
92
- activateFreeDNS
93
- );
94
- ```
95
-
96
- ### Parameters
97
-
98
- |Name | Type | Description | Notes|
99
- |------------- | ------------- | ------------- | -------------|
100
- | **activateFreeDNS** | **ActivateFreeDNS**| | |
101
-
102
-
103
45
  ### Return type
104
46
 
105
47
  **ActivateFreeDNSResponse**
@@ -158,64 +100,6 @@ const { status, data } = await apiInstance.freednsDnsAddRecordCreate(
158
100
  | **source** | [**string**] | \'internal\' or \'external\'. | defaults to undefined|
159
101
 
160
102
 
161
- ### Return type
162
-
163
- **DNSRecordMutateResponse**
164
-
165
- ### Authorization
166
-
167
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
168
-
169
- ### HTTP request headers
170
-
171
- - **Content-Type**: application/json
172
- - **Accept**: application/json
173
-
174
-
175
- ### HTTP response details
176
- | Status code | Description | Response headers |
177
- |-------------|-------------|------------------|
178
- |**200** | | - |
179
-
180
- [[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)
181
-
182
- # **freednsDnsAddRecordCreate2**
183
- > DNSRecordMutateResponse freednsDnsAddRecordCreate2(dNSRecordCreate)
184
-
185
- Add or edit a DNS record. To edit an existing record, include the \'line\' field with its line number. Required type-specific fields depend on \'type\': A/AAAA → address; CNAME → cname; MX → preference, exchange; SRV → priority, weight, port, target; TXT → txtdata, unencoded; TYPE257 (CAA) → flag, tag, value.
186
-
187
- ### Example
188
-
189
- ```typescript
190
- import {
191
- FreednsApi,
192
- Configuration,
193
- DNSRecordCreate
194
- } from '@pidginhost/sdk';
195
-
196
- const configuration = new Configuration();
197
- const apiInstance = new FreednsApi(configuration);
198
-
199
- let domain: string; //Domain name or PK. (default to undefined)
200
- let source: string; //\'internal\' or \'external\'. (default to undefined)
201
- let dNSRecordCreate: DNSRecordCreate; //
202
-
203
- const { status, data } = await apiInstance.freednsDnsAddRecordCreate2(
204
- domain,
205
- source,
206
- dNSRecordCreate
207
- );
208
- ```
209
-
210
- ### Parameters
211
-
212
- |Name | Type | Description | Notes|
213
- |------------- | ------------- | ------------- | -------------|
214
- | **dNSRecordCreate** | **DNSRecordCreate**| | |
215
- | **domain** | [**string**] | Domain name or PK. | defaults to undefined|
216
- | **source** | [**string**] | \'internal\' or \'external\'. | defaults to undefined|
217
-
218
-
219
103
  ### Return type
220
104
 
221
105
  **DNSRecordMutateResponse**
@@ -268,58 +152,6 @@ const { status, data } = await apiInstance.freednsDnsDeactivateCreate(
268
152
  | **deactivateFreeDNS** | **DeactivateFreeDNS**| | |
269
153
 
270
154
 
271
- ### Return type
272
-
273
- **DeactivateFreeDNSResponse**
274
-
275
- ### Authorization
276
-
277
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
278
-
279
- ### HTTP request headers
280
-
281
- - **Content-Type**: application/json
282
- - **Accept**: application/json
283
-
284
-
285
- ### HTTP response details
286
- | Status code | Description | Response headers |
287
- |-------------|-------------|------------------|
288
- |**200** | | - |
289
-
290
- [[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)
291
-
292
- # **freednsDnsDeactivateCreate2**
293
- > DeactivateFreeDNSResponse freednsDnsDeactivateCreate2(deactivateFreeDNS)
294
-
295
- Deactivate FreeDNS for a domain. The DNS zone is removed from the cPanel node and, for internal domains, the original nameservers are restored.
296
-
297
- ### Example
298
-
299
- ```typescript
300
- import {
301
- FreednsApi,
302
- Configuration,
303
- DeactivateFreeDNS
304
- } from '@pidginhost/sdk';
305
-
306
- const configuration = new Configuration();
307
- const apiInstance = new FreednsApi(configuration);
308
-
309
- let deactivateFreeDNS: DeactivateFreeDNS; //
310
-
311
- const { status, data } = await apiInstance.freednsDnsDeactivateCreate2(
312
- deactivateFreeDNS
313
- );
314
- ```
315
-
316
- ### Parameters
317
-
318
- |Name | Type | Description | Notes|
319
- |------------- | ------------- | ------------- | -------------|
320
- | **deactivateFreeDNS** | **DeactivateFreeDNS**| | |
321
-
322
-
323
155
  ### Return type
324
156
 
325
157
  **DeactivateFreeDNSResponse**
@@ -378,64 +210,6 @@ const { status, data } = await apiInstance.freednsDnsDeleteRecordCreate(
378
210
  | **source** | [**string**] | \'internal\' or \'external\'. | defaults to undefined|
379
211
 
380
212
 
381
- ### Return type
382
-
383
- **DeleteRecordResponse**
384
-
385
- ### Authorization
386
-
387
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
388
-
389
- ### HTTP request headers
390
-
391
- - **Content-Type**: application/json
392
- - **Accept**: application/json
393
-
394
-
395
- ### HTTP response details
396
- | Status code | Description | Response headers |
397
- |-------------|-------------|------------------|
398
- |**200** | | - |
399
-
400
- [[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)
401
-
402
- # **freednsDnsDeleteRecordCreate2**
403
- > DeleteRecordResponse freednsDnsDeleteRecordCreate2(deleteRecord)
404
-
405
- Delete a DNS record by its line number.
406
-
407
- ### Example
408
-
409
- ```typescript
410
- import {
411
- FreednsApi,
412
- Configuration,
413
- DeleteRecord
414
- } from '@pidginhost/sdk';
415
-
416
- const configuration = new Configuration();
417
- const apiInstance = new FreednsApi(configuration);
418
-
419
- let domain: string; //Domain name or PK. (default to undefined)
420
- let source: string; //\'internal\' or \'external\'. (default to undefined)
421
- let deleteRecord: DeleteRecord; //
422
-
423
- const { status, data } = await apiInstance.freednsDnsDeleteRecordCreate2(
424
- domain,
425
- source,
426
- deleteRecord
427
- );
428
- ```
429
-
430
- ### Parameters
431
-
432
- |Name | Type | Description | Notes|
433
- |------------- | ------------- | ------------- | -------------|
434
- | **deleteRecord** | **DeleteRecord**| | |
435
- | **domain** | [**string**] | Domain name or PK. | defaults to undefined|
436
- | **source** | [**string**] | \'internal\' or \'external\'. | defaults to undefined|
437
-
438
-
439
213
  ### Return type
440
214
 
441
215
  **DeleteRecordResponse**
@@ -480,50 +254,6 @@ const { status, data } = await apiInstance.freednsDnsList();
480
254
  This endpoint does not have any parameters.
481
255
 
482
256
 
483
- ### Return type
484
-
485
- **Array<FreeDNSDomain>**
486
-
487
- ### Authorization
488
-
489
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
490
-
491
- ### HTTP request headers
492
-
493
- - **Content-Type**: Not defined
494
- - **Accept**: application/json
495
-
496
-
497
- ### HTTP response details
498
- | Status code | Description | Response headers |
499
- |-------------|-------------|------------------|
500
- |**200** | | - |
501
-
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)
503
-
504
- # **freednsDnsList2**
505
- > Array<FreeDNSDomain> freednsDnsList2()
506
-
507
- List all domains with active FreeDNS for the authenticated user.
508
-
509
- ### Example
510
-
511
- ```typescript
512
- import {
513
- FreednsApi,
514
- Configuration
515
- } from '@pidginhost/sdk';
516
-
517
- const configuration = new Configuration();
518
- const apiInstance = new FreednsApi(configuration);
519
-
520
- const { status, data } = await apiInstance.freednsDnsList2();
521
- ```
522
-
523
- ### Parameters
524
- This endpoint does not have any parameters.
525
-
526
-
527
257
  ### Return type
528
258
 
529
259
  **Array<FreeDNSDomain>**
@@ -599,57 +329,3 @@ const { status, data } = await apiInstance.freednsDnsRecordsList(
599
329
 
600
330
  [[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)
601
331
 
602
- # **freednsDnsRecordsList2**
603
- > Array<DNSRecord> freednsDnsRecordsList2()
604
-
605
- List all DNS records for a domain with active FreeDNS.
606
-
607
- ### Example
608
-
609
- ```typescript
610
- import {
611
- FreednsApi,
612
- Configuration
613
- } from '@pidginhost/sdk';
614
-
615
- const configuration = new Configuration();
616
- const apiInstance = new FreednsApi(configuration);
617
-
618
- let domain: string; //Domain name or PK. (default to undefined)
619
- let source: string; //\'internal\' or \'external\'. (default to undefined)
620
-
621
- const { status, data } = await apiInstance.freednsDnsRecordsList2(
622
- domain,
623
- source
624
- );
625
- ```
626
-
627
- ### Parameters
628
-
629
- |Name | Type | Description | Notes|
630
- |------------- | ------------- | ------------- | -------------|
631
- | **domain** | [**string**] | Domain name or PK. | defaults to undefined|
632
- | **source** | [**string**] | \&#39;internal\&#39; or \&#39;external\&#39;. | defaults to undefined|
633
-
634
-
635
- ### Return type
636
-
637
- **Array<DNSRecord>**
638
-
639
- ### Authorization
640
-
641
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
642
-
643
- ### HTTP request headers
644
-
645
- - **Content-Type**: Not defined
646
- - **Accept**: application/json
647
-
648
-
649
- ### HTTP response details
650
- | Status code | Description | Response headers |
651
- |-------------|-------------|------------------|
652
- |**200** | | - |
653
-
654
- [[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)
655
-
@@ -0,0 +1,34 @@
1
+ # HardwareGeneration
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **slug** | **string** | | [default to undefined]
9
+ **name** | **string** | | [default to undefined]
10
+ **description** | **string** | | [optional] [default to undefined]
11
+ **cpu_label** | **string** | | [optional] [default to undefined]
12
+ **price_multiplier** | **string** | Multiplier applied to base MeteredProduct price (1.00 &#x3D; no change, 1.50 &#x3D; +50%) | [optional] [default to undefined]
13
+ **is_default** | **boolean** | | [optional] [default to undefined]
14
+ **icon_class** | **string** | | [optional] [default to undefined]
15
+ **free_tier_eligible** | **boolean** | Whether free tier VM plans are available on this generation | [optional] [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { HardwareGeneration } from '@pidginhost/sdk';
21
+
22
+ const instance: HardwareGeneration = {
23
+ slug,
24
+ name,
25
+ description,
26
+ cpu_label,
27
+ price_multiplier,
28
+ is_default,
29
+ icon_class,
30
+ free_tier_eligible,
31
+ };
32
+ ```
33
+
34
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -5,11 +5,8 @@ All URIs are relative to *https://www.pidginhost.com*
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
7
  |[**hostingHostingChangePasswordCreate**](#hostinghostingchangepasswordcreate) | **POST** /api/hosting/hosting/{id}/change-password/ | |
8
- |[**hostingHostingChangePasswordCreate2**](#hostinghostingchangepasswordcreate2) | **POST** /api/v1/hosting/hosting/{id}/change-password/ | |
9
8
  |[**hostingHostingList**](#hostinghostinglist) | **GET** /api/hosting/hosting/ | |
10
- |[**hostingHostingList2**](#hostinghostinglist2) | **GET** /api/v1/hosting/hosting/ | |
11
9
  |[**hostingHostingRetrieve**](#hostinghostingretrieve) | **GET** /api/hosting/hosting/{id}/ | |
12
- |[**hostingHostingRetrieve2**](#hostinghostingretrieve2) | **GET** /api/v1/hosting/hosting/{id}/ | |
13
10
 
14
11
  # **hostingHostingChangePasswordCreate**
15
12
  > HostingChangePasswordResponse hostingHostingChangePasswordCreate(changePassword)
@@ -45,61 +42,6 @@ const { status, data } = await apiInstance.hostingHostingChangePasswordCreate(
45
42
  | **id** | [**string**] | | defaults to undefined|
46
43
 
47
44
 
48
- ### Return type
49
-
50
- **HostingChangePasswordResponse**
51
-
52
- ### Authorization
53
-
54
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
55
-
56
- ### HTTP request headers
57
-
58
- - **Content-Type**: application/json
59
- - **Accept**: application/json
60
-
61
-
62
- ### HTTP response details
63
- | Status code | Description | Response headers |
64
- |-------------|-------------|------------------|
65
- |**200** | | - |
66
-
67
- [[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)
68
-
69
- # **hostingHostingChangePasswordCreate2**
70
- > HostingChangePasswordResponse hostingHostingChangePasswordCreate2(changePassword)
71
-
72
- Change the cPanel password for this hosting service.
73
-
74
- ### Example
75
-
76
- ```typescript
77
- import {
78
- HostingApi,
79
- Configuration,
80
- ChangePassword
81
- } from '@pidginhost/sdk';
82
-
83
- const configuration = new Configuration();
84
- const apiInstance = new HostingApi(configuration);
85
-
86
- let id: string; // (default to undefined)
87
- let changePassword: ChangePassword; //
88
-
89
- const { status, data } = await apiInstance.hostingHostingChangePasswordCreate2(
90
- id,
91
- changePassword
92
- );
93
- ```
94
-
95
- ### Parameters
96
-
97
- |Name | Type | Description | Notes|
98
- |------------- | ------------- | ------------- | -------------|
99
- | **changePassword** | **ChangePassword**| | |
100
- | **id** | [**string**] | | defaults to undefined|
101
-
102
-
103
45
  ### Return type
104
46
 
105
47
  **HostingChangePasswordResponse**
@@ -151,57 +93,6 @@ const { status, data } = await apiInstance.hostingHostingList(
151
93
  | **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
152
94
 
153
95
 
154
- ### Return type
155
-
156
- **PaginatedHostingServiceList**
157
-
158
- ### Authorization
159
-
160
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
161
-
162
- ### HTTP request headers
163
-
164
- - **Content-Type**: Not defined
165
- - **Accept**: application/json
166
-
167
-
168
- ### HTTP response details
169
- | Status code | Description | Response headers |
170
- |-------------|-------------|------------------|
171
- |**200** | | - |
172
-
173
- [[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)
174
-
175
- # **hostingHostingList2**
176
- > PaginatedHostingServiceList hostingHostingList2()
177
-
178
- List and manage cPanel/shared hosting services.
179
-
180
- ### Example
181
-
182
- ```typescript
183
- import {
184
- HostingApi,
185
- Configuration
186
- } from '@pidginhost/sdk';
187
-
188
- const configuration = new Configuration();
189
- const apiInstance = new HostingApi(configuration);
190
-
191
- let page: number; //A page number within the paginated result set. (optional) (default to undefined)
192
-
193
- const { status, data } = await apiInstance.hostingHostingList2(
194
- page
195
- );
196
- ```
197
-
198
- ### Parameters
199
-
200
- |Name | Type | Description | Notes|
201
- |------------- | ------------- | ------------- | -------------|
202
- | **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
203
-
204
-
205
96
  ### Return type
206
97
 
207
98
  **PaginatedHostingServiceList**
@@ -274,54 +165,3 @@ const { status, data } = await apiInstance.hostingHostingRetrieve(
274
165
 
275
166
  [[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)
276
167
 
277
- # **hostingHostingRetrieve2**
278
- > HostingService hostingHostingRetrieve2()
279
-
280
- List and manage cPanel/shared hosting services.
281
-
282
- ### Example
283
-
284
- ```typescript
285
- import {
286
- HostingApi,
287
- Configuration
288
- } from '@pidginhost/sdk';
289
-
290
- const configuration = new Configuration();
291
- const apiInstance = new HostingApi(configuration);
292
-
293
- let id: string; // (default to undefined)
294
-
295
- const { status, data } = await apiInstance.hostingHostingRetrieve2(
296
- id
297
- );
298
- ```
299
-
300
- ### Parameters
301
-
302
- |Name | Type | Description | Notes|
303
- |------------- | ------------- | ------------- | -------------|
304
- | **id** | [**string**] | | defaults to undefined|
305
-
306
-
307
- ### Return type
308
-
309
- **HostingService**
310
-
311
- ### Authorization
312
-
313
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
314
-
315
- ### HTTP request headers
316
-
317
- - **Content-Type**: Not defined
318
- - **Accept**: application/json
319
-
320
-
321
- ### HTTP response details
322
- | Status code | Description | Response headers |
323
- |-------------|-------------|------------------|
324
- |**200** | | - |
325
-
326
- [[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)
327
-
@@ -1,13 +1,13 @@
1
1
  # KubeVersionEnum
2
2
 
3
- * `1.33.8` - 1.33.8 * `1.34.4` - 1.34.4 * `1.35.1` - 1.35.1
3
+ * `1.33.11` - 1.33.11 * `1.34.7` - 1.34.7 * `1.35.4` - 1.35.4
4
4
 
5
5
  ## Enum
6
6
 
7
- * `_1338` (value: `'1.33.8'`)
7
+ * `_13311` (value: `'1.33.11'`)
8
8
 
9
- * `_1344` (value: `'1.34.4'`)
9
+ * `_1347` (value: `'1.34.7'`)
10
10
 
11
- * `_1351` (value: `'1.35.1'`)
11
+ * `_1354` (value: `'1.35.4'`)
12
12
 
13
13
  [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)