@pidginhost/sdk 0.2.0 → 0.3.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 +9 -0
- package/README.md +24 -2
- package/api.ts +713 -35
- package/dist/api.d.ts +372 -25
- package/dist/api.js +595 -30
- package/dist/esm/api.d.ts +372 -25
- package/dist/esm/api.js +589 -28
- 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/AuthApi.md +201 -0
- package/docs/CLISessionCreateResponse.md +26 -0
- package/docs/CLISessionPollResponse.md +26 -0
- package/docs/CLISessionPollResponseStatusEnum.md +15 -0
- package/docs/CloudApi.md +52 -36
- package/docs/EligibleVM.md +22 -0
- package/docs/EligibleVMsResponse.md +20 -0
- package/docs/KubernetesApi.md +208 -0
- package/docs/PatchedServerDetail.md +50 -0
- package/docs/Server.md +3 -3
- package/docs/ServerDetail.md +50 -0
- package/docs/ToggleCloudVMAccessResponse.md +22 -0
- package/package.json +1 -1
- package/pidginhost.ts +13 -1
package/dist/esm/pidginhost.d.ts
CHANGED
|
@@ -1,8 +1,14 @@
|
|
|
1
|
-
import { AccountApi, CloudApi, DomainApi, KubernetesApi } from "./index";
|
|
1
|
+
import { AccountApi, AuthApi, BillingApi, CloudApi, DedicatedApi, DomainApi, FreednsApi, HostingApi, KubernetesApi, SupportApi } from "./index";
|
|
2
2
|
export declare class PidginHost {
|
|
3
3
|
account: AccountApi;
|
|
4
|
+
auth: AuthApi;
|
|
5
|
+
billing: BillingApi;
|
|
4
6
|
cloud: CloudApi;
|
|
7
|
+
dedicated: DedicatedApi;
|
|
5
8
|
domain: DomainApi;
|
|
9
|
+
freedns: FreednsApi;
|
|
10
|
+
hosting: HostingApi;
|
|
6
11
|
kubernetes: KubernetesApi;
|
|
12
|
+
support: SupportApi;
|
|
7
13
|
constructor(token: string, basePath?: string);
|
|
8
14
|
}
|
package/dist/esm/pidginhost.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Configuration, AccountApi, CloudApi, DomainApi, KubernetesApi } from "./index";
|
|
1
|
+
import { Configuration, AccountApi, AuthApi, BillingApi, CloudApi, DedicatedApi, DomainApi, FreednsApi, HostingApi, KubernetesApi, SupportApi } from "./index";
|
|
2
2
|
export class PidginHost {
|
|
3
3
|
constructor(token, basePath) {
|
|
4
4
|
const config = new Configuration({
|
|
@@ -6,8 +6,14 @@ export class PidginHost {
|
|
|
6
6
|
basePath,
|
|
7
7
|
});
|
|
8
8
|
this.account = new AccountApi(config);
|
|
9
|
+
this.auth = new AuthApi(config);
|
|
10
|
+
this.billing = new BillingApi(config);
|
|
9
11
|
this.cloud = new CloudApi(config);
|
|
12
|
+
this.dedicated = new DedicatedApi(config);
|
|
10
13
|
this.domain = new DomainApi(config);
|
|
14
|
+
this.freedns = new FreednsApi(config);
|
|
15
|
+
this.hosting = new HostingApi(config);
|
|
11
16
|
this.kubernetes = new KubernetesApi(config);
|
|
17
|
+
this.support = new SupportApi(config);
|
|
12
18
|
}
|
|
13
19
|
}
|
package/dist/pidginhost.d.ts
CHANGED
|
@@ -1,8 +1,14 @@
|
|
|
1
|
-
import { AccountApi, CloudApi, DomainApi, KubernetesApi } from "./index";
|
|
1
|
+
import { AccountApi, AuthApi, BillingApi, CloudApi, DedicatedApi, DomainApi, FreednsApi, HostingApi, KubernetesApi, SupportApi } from "./index";
|
|
2
2
|
export declare class PidginHost {
|
|
3
3
|
account: AccountApi;
|
|
4
|
+
auth: AuthApi;
|
|
5
|
+
billing: BillingApi;
|
|
4
6
|
cloud: CloudApi;
|
|
7
|
+
dedicated: DedicatedApi;
|
|
5
8
|
domain: DomainApi;
|
|
9
|
+
freedns: FreednsApi;
|
|
10
|
+
hosting: HostingApi;
|
|
6
11
|
kubernetes: KubernetesApi;
|
|
12
|
+
support: SupportApi;
|
|
7
13
|
constructor(token: string, basePath?: string);
|
|
8
14
|
}
|
package/dist/pidginhost.js
CHANGED
|
@@ -9,9 +9,15 @@ class PidginHost {
|
|
|
9
9
|
basePath,
|
|
10
10
|
});
|
|
11
11
|
this.account = new index_1.AccountApi(config);
|
|
12
|
+
this.auth = new index_1.AuthApi(config);
|
|
13
|
+
this.billing = new index_1.BillingApi(config);
|
|
12
14
|
this.cloud = new index_1.CloudApi(config);
|
|
15
|
+
this.dedicated = new index_1.DedicatedApi(config);
|
|
13
16
|
this.domain = new index_1.DomainApi(config);
|
|
17
|
+
this.freedns = new index_1.FreednsApi(config);
|
|
18
|
+
this.hosting = new index_1.HostingApi(config);
|
|
14
19
|
this.kubernetes = new index_1.KubernetesApi(config);
|
|
20
|
+
this.support = new index_1.SupportApi(config);
|
|
15
21
|
}
|
|
16
22
|
}
|
|
17
23
|
exports.PidginHost = PidginHost;
|
package/docs/AuthApi.md
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
# AuthApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://www.pidginhost.com*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**authCliSessionCreate**](#authclisessioncreate) | **POST** /api/auth/cli-session/ | |
|
|
8
|
+
|[**authCliSessionCreate2**](#authclisessioncreate2) | **POST** /api/v1/auth/cli-session/ | |
|
|
9
|
+
|[**authCliSessionRetrieve**](#authclisessionretrieve) | **GET** /api/auth/cli-session/{session_id}/ | |
|
|
10
|
+
|[**authCliSessionRetrieve2**](#authclisessionretrieve2) | **GET** /api/v1/auth/cli-session/{session_id}/ | |
|
|
11
|
+
|
|
12
|
+
# **authCliSessionCreate**
|
|
13
|
+
> CLISessionCreateResponse authCliSessionCreate()
|
|
14
|
+
|
|
15
|
+
Create a CLI authentication session for browser-based approval
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import {
|
|
21
|
+
AuthApi,
|
|
22
|
+
Configuration
|
|
23
|
+
} from '@pidginhost/sdk';
|
|
24
|
+
|
|
25
|
+
const configuration = new Configuration();
|
|
26
|
+
const apiInstance = new AuthApi(configuration);
|
|
27
|
+
|
|
28
|
+
const { status, data } = await apiInstance.authCliSessionCreate();
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### Parameters
|
|
32
|
+
This endpoint does not have any parameters.
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
### Return type
|
|
36
|
+
|
|
37
|
+
**CLISessionCreateResponse**
|
|
38
|
+
|
|
39
|
+
### Authorization
|
|
40
|
+
|
|
41
|
+
No authorization required
|
|
42
|
+
|
|
43
|
+
### HTTP request headers
|
|
44
|
+
|
|
45
|
+
- **Content-Type**: Not defined
|
|
46
|
+
- **Accept**: application/json
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
### HTTP response details
|
|
50
|
+
| Status code | Description | Response headers |
|
|
51
|
+
|-------------|-------------|------------------|
|
|
52
|
+
|**201** | | - |
|
|
53
|
+
|
|
54
|
+
[[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)
|
|
55
|
+
|
|
56
|
+
# **authCliSessionCreate2**
|
|
57
|
+
> CLISessionCreateResponse authCliSessionCreate2()
|
|
58
|
+
|
|
59
|
+
Create a CLI authentication session for browser-based approval
|
|
60
|
+
|
|
61
|
+
### Example
|
|
62
|
+
|
|
63
|
+
```typescript
|
|
64
|
+
import {
|
|
65
|
+
AuthApi,
|
|
66
|
+
Configuration
|
|
67
|
+
} from '@pidginhost/sdk';
|
|
68
|
+
|
|
69
|
+
const configuration = new Configuration();
|
|
70
|
+
const apiInstance = new AuthApi(configuration);
|
|
71
|
+
|
|
72
|
+
const { status, data } = await apiInstance.authCliSessionCreate2();
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### Parameters
|
|
76
|
+
This endpoint does not have any parameters.
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
### Return type
|
|
80
|
+
|
|
81
|
+
**CLISessionCreateResponse**
|
|
82
|
+
|
|
83
|
+
### Authorization
|
|
84
|
+
|
|
85
|
+
No authorization required
|
|
86
|
+
|
|
87
|
+
### HTTP request headers
|
|
88
|
+
|
|
89
|
+
- **Content-Type**: Not defined
|
|
90
|
+
- **Accept**: application/json
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
### HTTP response details
|
|
94
|
+
| Status code | Description | Response headers |
|
|
95
|
+
|-------------|-------------|------------------|
|
|
96
|
+
|**201** | | - |
|
|
97
|
+
|
|
98
|
+
[[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)
|
|
99
|
+
|
|
100
|
+
# **authCliSessionRetrieve**
|
|
101
|
+
> CLISessionPollResponse authCliSessionRetrieve()
|
|
102
|
+
|
|
103
|
+
Poll a CLI authentication session. Returns token when approved.
|
|
104
|
+
|
|
105
|
+
### Example
|
|
106
|
+
|
|
107
|
+
```typescript
|
|
108
|
+
import {
|
|
109
|
+
AuthApi,
|
|
110
|
+
Configuration
|
|
111
|
+
} from '@pidginhost/sdk';
|
|
112
|
+
|
|
113
|
+
const configuration = new Configuration();
|
|
114
|
+
const apiInstance = new AuthApi(configuration);
|
|
115
|
+
|
|
116
|
+
let sessionId: string; // (default to undefined)
|
|
117
|
+
|
|
118
|
+
const { status, data } = await apiInstance.authCliSessionRetrieve(
|
|
119
|
+
sessionId
|
|
120
|
+
);
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
### Parameters
|
|
124
|
+
|
|
125
|
+
|Name | Type | Description | Notes|
|
|
126
|
+
|------------- | ------------- | ------------- | -------------|
|
|
127
|
+
| **sessionId** | [**string**] | | defaults to undefined|
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
### Return type
|
|
131
|
+
|
|
132
|
+
**CLISessionPollResponse**
|
|
133
|
+
|
|
134
|
+
### Authorization
|
|
135
|
+
|
|
136
|
+
No authorization required
|
|
137
|
+
|
|
138
|
+
### HTTP request headers
|
|
139
|
+
|
|
140
|
+
- **Content-Type**: Not defined
|
|
141
|
+
- **Accept**: application/json
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
### HTTP response details
|
|
145
|
+
| Status code | Description | Response headers |
|
|
146
|
+
|-------------|-------------|------------------|
|
|
147
|
+
|**200** | | - |
|
|
148
|
+
|
|
149
|
+
[[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)
|
|
150
|
+
|
|
151
|
+
# **authCliSessionRetrieve2**
|
|
152
|
+
> CLISessionPollResponse authCliSessionRetrieve2()
|
|
153
|
+
|
|
154
|
+
Poll a CLI authentication session. Returns token when approved.
|
|
155
|
+
|
|
156
|
+
### Example
|
|
157
|
+
|
|
158
|
+
```typescript
|
|
159
|
+
import {
|
|
160
|
+
AuthApi,
|
|
161
|
+
Configuration
|
|
162
|
+
} from '@pidginhost/sdk';
|
|
163
|
+
|
|
164
|
+
const configuration = new Configuration();
|
|
165
|
+
const apiInstance = new AuthApi(configuration);
|
|
166
|
+
|
|
167
|
+
let sessionId: string; // (default to undefined)
|
|
168
|
+
|
|
169
|
+
const { status, data } = await apiInstance.authCliSessionRetrieve2(
|
|
170
|
+
sessionId
|
|
171
|
+
);
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
### Parameters
|
|
175
|
+
|
|
176
|
+
|Name | Type | Description | Notes|
|
|
177
|
+
|------------- | ------------- | ------------- | -------------|
|
|
178
|
+
| **sessionId** | [**string**] | | defaults to undefined|
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
### Return type
|
|
182
|
+
|
|
183
|
+
**CLISessionPollResponse**
|
|
184
|
+
|
|
185
|
+
### Authorization
|
|
186
|
+
|
|
187
|
+
No authorization required
|
|
188
|
+
|
|
189
|
+
### HTTP request headers
|
|
190
|
+
|
|
191
|
+
- **Content-Type**: Not defined
|
|
192
|
+
- **Accept**: application/json
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
### HTTP response details
|
|
196
|
+
| Status code | Description | Response headers |
|
|
197
|
+
|-------------|-------------|------------------|
|
|
198
|
+
|**200** | | - |
|
|
199
|
+
|
|
200
|
+
[[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)
|
|
201
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# CLISessionCreateResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**session_id** | **string** | | [default to undefined]
|
|
9
|
+
**verification_url** | **string** | | [default to undefined]
|
|
10
|
+
**expires_at** | **string** | | [default to undefined]
|
|
11
|
+
**poll_interval** | **number** | Recommended polling interval in seconds | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { CLISessionCreateResponse } from '@pidginhost/sdk';
|
|
17
|
+
|
|
18
|
+
const instance: CLISessionCreateResponse = {
|
|
19
|
+
session_id,
|
|
20
|
+
verification_url,
|
|
21
|
+
expires_at,
|
|
22
|
+
poll_interval,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# CLISessionPollResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | [**CLISessionPollResponseStatusEnum**](CLISessionPollResponseStatusEnum.md) | | [default to undefined]
|
|
9
|
+
**token_key** | **string** | Only present when status is approved | [optional] [default to undefined]
|
|
10
|
+
**token_name** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**token_scope** | **string** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { CLISessionPollResponse } from '@pidginhost/sdk';
|
|
17
|
+
|
|
18
|
+
const instance: CLISessionPollResponse = {
|
|
19
|
+
status,
|
|
20
|
+
token_key,
|
|
21
|
+
token_name,
|
|
22
|
+
token_scope,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# CLISessionPollResponseStatusEnum
|
|
2
|
+
|
|
3
|
+
* `pending` - pending * `approved` - approved * `expired` - expired * `denied` - denied
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `Pending` (value: `'pending'`)
|
|
8
|
+
|
|
9
|
+
* `Approved` (value: `'approved'`)
|
|
10
|
+
|
|
11
|
+
* `Expired` (value: `'expired'`)
|
|
12
|
+
|
|
13
|
+
* `Denied` (value: `'denied'`)
|
|
14
|
+
|
|
15
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/CloudApi.md
CHANGED
|
@@ -5340,7 +5340,7 @@ const { status, data } = await apiInstance.cloudServersModifyPackageCreate2(
|
|
|
5340
5340
|
[[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)
|
|
5341
5341
|
|
|
5342
5342
|
# **cloudServersPartialUpdate**
|
|
5343
|
-
> cloudServersPartialUpdate()
|
|
5343
|
+
> ServerDetail cloudServersPartialUpdate()
|
|
5344
5344
|
|
|
5345
5345
|
Cloud servers
|
|
5346
5346
|
|
|
@@ -5349,16 +5349,19 @@ Cloud servers
|
|
|
5349
5349
|
```typescript
|
|
5350
5350
|
import {
|
|
5351
5351
|
CloudApi,
|
|
5352
|
-
Configuration
|
|
5352
|
+
Configuration,
|
|
5353
|
+
PatchedServerDetail
|
|
5353
5354
|
} from '@pidginhost/sdk';
|
|
5354
5355
|
|
|
5355
5356
|
const configuration = new Configuration();
|
|
5356
5357
|
const apiInstance = new CloudApi(configuration);
|
|
5357
5358
|
|
|
5358
5359
|
let id: number; //A unique integer value identifying this virtual machine. (default to undefined)
|
|
5360
|
+
let patchedServerDetail: PatchedServerDetail; // (optional)
|
|
5359
5361
|
|
|
5360
5362
|
const { status, data } = await apiInstance.cloudServersPartialUpdate(
|
|
5361
|
-
id
|
|
5363
|
+
id,
|
|
5364
|
+
patchedServerDetail
|
|
5362
5365
|
);
|
|
5363
5366
|
```
|
|
5364
5367
|
|
|
@@ -5366,12 +5369,13 @@ const { status, data } = await apiInstance.cloudServersPartialUpdate(
|
|
|
5366
5369
|
|
|
5367
5370
|
|Name | Type | Description | Notes|
|
|
5368
5371
|
|------------- | ------------- | ------------- | -------------|
|
|
5372
|
+
| **patchedServerDetail** | **PatchedServerDetail**| | |
|
|
5369
5373
|
| **id** | [**number**] | A unique integer value identifying this virtual machine. | defaults to undefined|
|
|
5370
5374
|
|
|
5371
5375
|
|
|
5372
5376
|
### Return type
|
|
5373
5377
|
|
|
5374
|
-
|
|
5378
|
+
**ServerDetail**
|
|
5375
5379
|
|
|
5376
5380
|
### Authorization
|
|
5377
5381
|
|
|
@@ -5379,19 +5383,19 @@ void (empty response body)
|
|
|
5379
5383
|
|
|
5380
5384
|
### HTTP request headers
|
|
5381
5385
|
|
|
5382
|
-
- **Content-Type**:
|
|
5383
|
-
- **Accept**:
|
|
5386
|
+
- **Content-Type**: application/json
|
|
5387
|
+
- **Accept**: application/json
|
|
5384
5388
|
|
|
5385
5389
|
|
|
5386
5390
|
### HTTP response details
|
|
5387
5391
|
| Status code | Description | Response headers |
|
|
5388
5392
|
|-------------|-------------|------------------|
|
|
5389
|
-
|**200** |
|
|
5393
|
+
|**200** | | - |
|
|
5390
5394
|
|
|
5391
5395
|
[[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)
|
|
5392
5396
|
|
|
5393
5397
|
# **cloudServersPartialUpdate2**
|
|
5394
|
-
> cloudServersPartialUpdate2()
|
|
5398
|
+
> ServerDetail cloudServersPartialUpdate2()
|
|
5395
5399
|
|
|
5396
5400
|
Cloud servers
|
|
5397
5401
|
|
|
@@ -5400,16 +5404,19 @@ Cloud servers
|
|
|
5400
5404
|
```typescript
|
|
5401
5405
|
import {
|
|
5402
5406
|
CloudApi,
|
|
5403
|
-
Configuration
|
|
5407
|
+
Configuration,
|
|
5408
|
+
PatchedServerDetail
|
|
5404
5409
|
} from '@pidginhost/sdk';
|
|
5405
5410
|
|
|
5406
5411
|
const configuration = new Configuration();
|
|
5407
5412
|
const apiInstance = new CloudApi(configuration);
|
|
5408
5413
|
|
|
5409
5414
|
let id: number; //A unique integer value identifying this virtual machine. (default to undefined)
|
|
5415
|
+
let patchedServerDetail: PatchedServerDetail; // (optional)
|
|
5410
5416
|
|
|
5411
5417
|
const { status, data } = await apiInstance.cloudServersPartialUpdate2(
|
|
5412
|
-
id
|
|
5418
|
+
id,
|
|
5419
|
+
patchedServerDetail
|
|
5413
5420
|
);
|
|
5414
5421
|
```
|
|
5415
5422
|
|
|
@@ -5417,12 +5424,13 @@ const { status, data } = await apiInstance.cloudServersPartialUpdate2(
|
|
|
5417
5424
|
|
|
5418
5425
|
|Name | Type | Description | Notes|
|
|
5419
5426
|
|------------- | ------------- | ------------- | -------------|
|
|
5427
|
+
| **patchedServerDetail** | **PatchedServerDetail**| | |
|
|
5420
5428
|
| **id** | [**number**] | A unique integer value identifying this virtual machine. | defaults to undefined|
|
|
5421
5429
|
|
|
5422
5430
|
|
|
5423
5431
|
### Return type
|
|
5424
5432
|
|
|
5425
|
-
|
|
5433
|
+
**ServerDetail**
|
|
5426
5434
|
|
|
5427
5435
|
### Authorization
|
|
5428
5436
|
|
|
@@ -5430,14 +5438,14 @@ void (empty response body)
|
|
|
5430
5438
|
|
|
5431
5439
|
### HTTP request headers
|
|
5432
5440
|
|
|
5433
|
-
- **Content-Type**:
|
|
5434
|
-
- **Accept**:
|
|
5441
|
+
- **Content-Type**: application/json
|
|
5442
|
+
- **Accept**: application/json
|
|
5435
5443
|
|
|
5436
5444
|
|
|
5437
5445
|
### HTTP response details
|
|
5438
5446
|
| Status code | Description | Response headers |
|
|
5439
5447
|
|-------------|-------------|------------------|
|
|
5440
|
-
|**200** |
|
|
5448
|
+
|**200** | | - |
|
|
5441
5449
|
|
|
5442
5450
|
[[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)
|
|
5443
5451
|
|
|
@@ -5968,7 +5976,7 @@ const { status, data } = await apiInstance.cloudServersPublicInterfaceRetrieve2(
|
|
|
5968
5976
|
[[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)
|
|
5969
5977
|
|
|
5970
5978
|
# **cloudServersRetrieve**
|
|
5971
|
-
> cloudServersRetrieve()
|
|
5979
|
+
> ServerDetail cloudServersRetrieve()
|
|
5972
5980
|
|
|
5973
5981
|
Cloud servers
|
|
5974
5982
|
|
|
@@ -5999,7 +6007,7 @@ const { status, data } = await apiInstance.cloudServersRetrieve(
|
|
|
5999
6007
|
|
|
6000
6008
|
### Return type
|
|
6001
6009
|
|
|
6002
|
-
|
|
6010
|
+
**ServerDetail**
|
|
6003
6011
|
|
|
6004
6012
|
### Authorization
|
|
6005
6013
|
|
|
@@ -6008,18 +6016,18 @@ void (empty response body)
|
|
|
6008
6016
|
### HTTP request headers
|
|
6009
6017
|
|
|
6010
6018
|
- **Content-Type**: Not defined
|
|
6011
|
-
- **Accept**:
|
|
6019
|
+
- **Accept**: application/json
|
|
6012
6020
|
|
|
6013
6021
|
|
|
6014
6022
|
### HTTP response details
|
|
6015
6023
|
| Status code | Description | Response headers |
|
|
6016
6024
|
|-------------|-------------|------------------|
|
|
6017
|
-
|**200** |
|
|
6025
|
+
|**200** | | - |
|
|
6018
6026
|
|
|
6019
6027
|
[[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)
|
|
6020
6028
|
|
|
6021
6029
|
# **cloudServersRetrieve2**
|
|
6022
|
-
> cloudServersRetrieve2()
|
|
6030
|
+
> ServerDetail cloudServersRetrieve2()
|
|
6023
6031
|
|
|
6024
6032
|
Cloud servers
|
|
6025
6033
|
|
|
@@ -6050,7 +6058,7 @@ const { status, data } = await apiInstance.cloudServersRetrieve2(
|
|
|
6050
6058
|
|
|
6051
6059
|
### Return type
|
|
6052
6060
|
|
|
6053
|
-
|
|
6061
|
+
**ServerDetail**
|
|
6054
6062
|
|
|
6055
6063
|
### Authorization
|
|
6056
6064
|
|
|
@@ -6059,13 +6067,13 @@ void (empty response body)
|
|
|
6059
6067
|
### HTTP request headers
|
|
6060
6068
|
|
|
6061
6069
|
- **Content-Type**: Not defined
|
|
6062
|
-
- **Accept**:
|
|
6070
|
+
- **Accept**: application/json
|
|
6063
6071
|
|
|
6064
6072
|
|
|
6065
6073
|
### HTTP response details
|
|
6066
6074
|
| Status code | Description | Response headers |
|
|
6067
6075
|
|-------------|-------------|------------------|
|
|
6068
|
-
|**200** |
|
|
6076
|
+
|**200** | | - |
|
|
6069
6077
|
|
|
6070
6078
|
[[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)
|
|
6071
6079
|
|
|
@@ -6632,7 +6640,7 @@ const { status, data } = await apiInstance.cloudServersSnapshotsRollbackCreate2(
|
|
|
6632
6640
|
[[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)
|
|
6633
6641
|
|
|
6634
6642
|
# **cloudServersUpdate**
|
|
6635
|
-
> cloudServersUpdate()
|
|
6643
|
+
> ServerDetail cloudServersUpdate()
|
|
6636
6644
|
|
|
6637
6645
|
Cloud servers
|
|
6638
6646
|
|
|
@@ -6641,16 +6649,19 @@ Cloud servers
|
|
|
6641
6649
|
```typescript
|
|
6642
6650
|
import {
|
|
6643
6651
|
CloudApi,
|
|
6644
|
-
Configuration
|
|
6652
|
+
Configuration,
|
|
6653
|
+
ServerDetail
|
|
6645
6654
|
} from '@pidginhost/sdk';
|
|
6646
6655
|
|
|
6647
6656
|
const configuration = new Configuration();
|
|
6648
6657
|
const apiInstance = new CloudApi(configuration);
|
|
6649
6658
|
|
|
6650
6659
|
let id: number; //A unique integer value identifying this virtual machine. (default to undefined)
|
|
6660
|
+
let serverDetail: ServerDetail; // (optional)
|
|
6651
6661
|
|
|
6652
6662
|
const { status, data } = await apiInstance.cloudServersUpdate(
|
|
6653
|
-
id
|
|
6663
|
+
id,
|
|
6664
|
+
serverDetail
|
|
6654
6665
|
);
|
|
6655
6666
|
```
|
|
6656
6667
|
|
|
@@ -6658,12 +6669,13 @@ const { status, data } = await apiInstance.cloudServersUpdate(
|
|
|
6658
6669
|
|
|
6659
6670
|
|Name | Type | Description | Notes|
|
|
6660
6671
|
|------------- | ------------- | ------------- | -------------|
|
|
6672
|
+
| **serverDetail** | **ServerDetail**| | |
|
|
6661
6673
|
| **id** | [**number**] | A unique integer value identifying this virtual machine. | defaults to undefined|
|
|
6662
6674
|
|
|
6663
6675
|
|
|
6664
6676
|
### Return type
|
|
6665
6677
|
|
|
6666
|
-
|
|
6678
|
+
**ServerDetail**
|
|
6667
6679
|
|
|
6668
6680
|
### Authorization
|
|
6669
6681
|
|
|
@@ -6671,19 +6683,19 @@ void (empty response body)
|
|
|
6671
6683
|
|
|
6672
6684
|
### HTTP request headers
|
|
6673
6685
|
|
|
6674
|
-
- **Content-Type**:
|
|
6675
|
-
- **Accept**:
|
|
6686
|
+
- **Content-Type**: application/json
|
|
6687
|
+
- **Accept**: application/json
|
|
6676
6688
|
|
|
6677
6689
|
|
|
6678
6690
|
### HTTP response details
|
|
6679
6691
|
| Status code | Description | Response headers |
|
|
6680
6692
|
|-------------|-------------|------------------|
|
|
6681
|
-
|**200** |
|
|
6693
|
+
|**200** | | - |
|
|
6682
6694
|
|
|
6683
6695
|
[[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)
|
|
6684
6696
|
|
|
6685
6697
|
# **cloudServersUpdate2**
|
|
6686
|
-
> cloudServersUpdate2()
|
|
6698
|
+
> ServerDetail cloudServersUpdate2()
|
|
6687
6699
|
|
|
6688
6700
|
Cloud servers
|
|
6689
6701
|
|
|
@@ -6692,16 +6704,19 @@ Cloud servers
|
|
|
6692
6704
|
```typescript
|
|
6693
6705
|
import {
|
|
6694
6706
|
CloudApi,
|
|
6695
|
-
Configuration
|
|
6707
|
+
Configuration,
|
|
6708
|
+
ServerDetail
|
|
6696
6709
|
} from '@pidginhost/sdk';
|
|
6697
6710
|
|
|
6698
6711
|
const configuration = new Configuration();
|
|
6699
6712
|
const apiInstance = new CloudApi(configuration);
|
|
6700
6713
|
|
|
6701
6714
|
let id: number; //A unique integer value identifying this virtual machine. (default to undefined)
|
|
6715
|
+
let serverDetail: ServerDetail; // (optional)
|
|
6702
6716
|
|
|
6703
6717
|
const { status, data } = await apiInstance.cloudServersUpdate2(
|
|
6704
|
-
id
|
|
6718
|
+
id,
|
|
6719
|
+
serverDetail
|
|
6705
6720
|
);
|
|
6706
6721
|
```
|
|
6707
6722
|
|
|
@@ -6709,12 +6724,13 @@ const { status, data } = await apiInstance.cloudServersUpdate2(
|
|
|
6709
6724
|
|
|
6710
6725
|
|Name | Type | Description | Notes|
|
|
6711
6726
|
|------------- | ------------- | ------------- | -------------|
|
|
6727
|
+
| **serverDetail** | **ServerDetail**| | |
|
|
6712
6728
|
| **id** | [**number**] | A unique integer value identifying this virtual machine. | defaults to undefined|
|
|
6713
6729
|
|
|
6714
6730
|
|
|
6715
6731
|
### Return type
|
|
6716
6732
|
|
|
6717
|
-
|
|
6733
|
+
**ServerDetail**
|
|
6718
6734
|
|
|
6719
6735
|
### Authorization
|
|
6720
6736
|
|
|
@@ -6722,14 +6738,14 @@ void (empty response body)
|
|
|
6722
6738
|
|
|
6723
6739
|
### HTTP request headers
|
|
6724
6740
|
|
|
6725
|
-
- **Content-Type**:
|
|
6726
|
-
- **Accept**:
|
|
6741
|
+
- **Content-Type**: application/json
|
|
6742
|
+
- **Accept**: application/json
|
|
6727
6743
|
|
|
6728
6744
|
|
|
6729
6745
|
### HTTP response details
|
|
6730
6746
|
| Status code | Description | Response headers |
|
|
6731
6747
|
|-------------|-------------|------------------|
|
|
6732
|
-
|**200** |
|
|
6748
|
+
|**200** | | - |
|
|
6733
6749
|
|
|
6734
6750
|
[[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)
|
|
6735
6751
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# EligibleVM
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **number** | | [default to undefined]
|
|
9
|
+
**hostname** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { EligibleVM } from '@pidginhost/sdk';
|
|
15
|
+
|
|
16
|
+
const instance: EligibleVM = {
|
|
17
|
+
id,
|
|
18
|
+
hostname,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# EligibleVMsResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**vms** | [**Array<EligibleVM>**](EligibleVM.md) | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { EligibleVMsResponse } from '@pidginhost/sdk';
|
|
14
|
+
|
|
15
|
+
const instance: EligibleVMsResponse = {
|
|
16
|
+
vms,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|