@pidginhost/sdk 0.7.0 → 0.8.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/README.md +2 -2
- package/api.ts +19 -7
- package/dist/api.d.ts +12 -4
- package/dist/api.js +14 -7
- package/dist/esm/api.d.ts +12 -4
- package/dist/esm/api.js +14 -7
- package/docs/CloudApi.md +3 -0
- package/docs/ServerProduct.md +8 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @pidginhost/sdk@0.
|
|
1
|
+
## @pidginhost/sdk@0.8.0
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @pidginhost/sdk@0.
|
|
39
|
+
npm install @pidginhost/sdk@0.8.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
package/api.ts
CHANGED
|
@@ -2333,6 +2333,10 @@ export interface ServerProduct {
|
|
|
2333
2333
|
'id': number;
|
|
2334
2334
|
'slug': string;
|
|
2335
2335
|
'name': string;
|
|
2336
|
+
'cpus': number;
|
|
2337
|
+
'memory': number;
|
|
2338
|
+
'disk_size': number;
|
|
2339
|
+
'traffic': number;
|
|
2336
2340
|
}
|
|
2337
2341
|
export interface ServerProductUpgrade {
|
|
2338
2342
|
/**
|
|
@@ -7992,11 +7996,12 @@ export const CloudApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
7992
7996
|
},
|
|
7993
7997
|
/**
|
|
7994
7998
|
* List of available server products
|
|
7999
|
+
* @param {string} [generation] Filter packages available on the given hardware generation (slug). Excludes free-tier-only packages when the generation is not free-tier eligible.
|
|
7995
8000
|
* @param {number} [page] A page number within the paginated result set.
|
|
7996
8001
|
* @param {*} [options] Override http request option.
|
|
7997
8002
|
* @throws {RequiredError}
|
|
7998
8003
|
*/
|
|
7999
|
-
cloudServerPackagesList: async (page?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
8004
|
+
cloudServerPackagesList: async (generation?: string, page?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
8000
8005
|
const localVarPath = `/api/cloud/server-packages/`;
|
|
8001
8006
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
8002
8007
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -8014,6 +8019,10 @@ export const CloudApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
8014
8019
|
// authentication tokenAuth required
|
|
8015
8020
|
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
8016
8021
|
|
|
8022
|
+
if (generation !== undefined) {
|
|
8023
|
+
localVarQueryParameter['generation'] = generation;
|
|
8024
|
+
}
|
|
8025
|
+
|
|
8017
8026
|
if (page !== undefined) {
|
|
8018
8027
|
localVarQueryParameter['page'] = page;
|
|
8019
8028
|
}
|
|
@@ -10468,12 +10477,13 @@ export const CloudApiFp = function(configuration?: Configuration) {
|
|
|
10468
10477
|
},
|
|
10469
10478
|
/**
|
|
10470
10479
|
* List of available server products
|
|
10480
|
+
* @param {string} [generation] Filter packages available on the given hardware generation (slug). Excludes free-tier-only packages when the generation is not free-tier eligible.
|
|
10471
10481
|
* @param {number} [page] A page number within the paginated result set.
|
|
10472
10482
|
* @param {*} [options] Override http request option.
|
|
10473
10483
|
* @throws {RequiredError}
|
|
10474
10484
|
*/
|
|
10475
|
-
async cloudServerPackagesList(page?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedServerProductList>> {
|
|
10476
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.cloudServerPackagesList(page, options);
|
|
10485
|
+
async cloudServerPackagesList(generation?: string, page?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedServerProductList>> {
|
|
10486
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.cloudServerPackagesList(generation, page, options);
|
|
10477
10487
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
10478
10488
|
const localVarOperationServerBasePath = operationServerMap['CloudApi.cloudServerPackagesList']?.[localVarOperationServerIndex]?.url;
|
|
10479
10489
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -11582,12 +11592,13 @@ export const CloudApiFactory = function (configuration?: Configuration, basePath
|
|
|
11582
11592
|
},
|
|
11583
11593
|
/**
|
|
11584
11594
|
* List of available server products
|
|
11595
|
+
* @param {string} [generation] Filter packages available on the given hardware generation (slug). Excludes free-tier-only packages when the generation is not free-tier eligible.
|
|
11585
11596
|
* @param {number} [page] A page number within the paginated result set.
|
|
11586
11597
|
* @param {*} [options] Override http request option.
|
|
11587
11598
|
* @throws {RequiredError}
|
|
11588
11599
|
*/
|
|
11589
|
-
cloudServerPackagesList(page?: number, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedServerProductList> {
|
|
11590
|
-
return localVarFp.cloudServerPackagesList(page, options).then((request) => request(axios, basePath));
|
|
11600
|
+
cloudServerPackagesList(generation?: string, page?: number, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedServerProductList> {
|
|
11601
|
+
return localVarFp.cloudServerPackagesList(generation, page, options).then((request) => request(axios, basePath));
|
|
11591
11602
|
},
|
|
11592
11603
|
/**
|
|
11593
11604
|
* List of available server products
|
|
@@ -12629,12 +12640,13 @@ export class CloudApi extends BaseAPI {
|
|
|
12629
12640
|
|
|
12630
12641
|
/**
|
|
12631
12642
|
* List of available server products
|
|
12643
|
+
* @param {string} [generation] Filter packages available on the given hardware generation (slug). Excludes free-tier-only packages when the generation is not free-tier eligible.
|
|
12632
12644
|
* @param {number} [page] A page number within the paginated result set.
|
|
12633
12645
|
* @param {*} [options] Override http request option.
|
|
12634
12646
|
* @throws {RequiredError}
|
|
12635
12647
|
*/
|
|
12636
|
-
public cloudServerPackagesList(page?: number, options?: RawAxiosRequestConfig) {
|
|
12637
|
-
return CloudApiFp(this.configuration).cloudServerPackagesList(page, options).then((request) => request(this.axios, this.basePath));
|
|
12648
|
+
public cloudServerPackagesList(generation?: string, page?: number, options?: RawAxiosRequestConfig) {
|
|
12649
|
+
return CloudApiFp(this.configuration).cloudServerPackagesList(generation, page, options).then((request) => request(this.axios, this.basePath));
|
|
12638
12650
|
}
|
|
12639
12651
|
|
|
12640
12652
|
/**
|
package/dist/api.d.ts
CHANGED
|
@@ -2164,6 +2164,10 @@ export interface ServerProduct {
|
|
|
2164
2164
|
'id': number;
|
|
2165
2165
|
'slug': string;
|
|
2166
2166
|
'name': string;
|
|
2167
|
+
'cpus': number;
|
|
2168
|
+
'memory': number;
|
|
2169
|
+
'disk_size': number;
|
|
2170
|
+
'traffic': number;
|
|
2167
2171
|
}
|
|
2168
2172
|
export interface ServerProductUpgrade {
|
|
2169
2173
|
/**
|
|
@@ -4165,11 +4169,12 @@ export declare const CloudApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
4165
4169
|
cloudServerPackagesByGenerationRetrieve: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4166
4170
|
/**
|
|
4167
4171
|
* List of available server products
|
|
4172
|
+
* @param {string} [generation] Filter packages available on the given hardware generation (slug). Excludes free-tier-only packages when the generation is not free-tier eligible.
|
|
4168
4173
|
* @param {number} [page] A page number within the paginated result set.
|
|
4169
4174
|
* @param {*} [options] Override http request option.
|
|
4170
4175
|
* @throws {RequiredError}
|
|
4171
4176
|
*/
|
|
4172
|
-
cloudServerPackagesList: (page?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4177
|
+
cloudServerPackagesList: (generation?: string, page?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4173
4178
|
/**
|
|
4174
4179
|
* List of available server products
|
|
4175
4180
|
* @param {number} id A unique integer value identifying this metered product.
|
|
@@ -4943,11 +4948,12 @@ export declare const CloudApiFp: (configuration?: Configuration) => {
|
|
|
4943
4948
|
cloudServerPackagesByGenerationRetrieve(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServerProduct>>;
|
|
4944
4949
|
/**
|
|
4945
4950
|
* List of available server products
|
|
4951
|
+
* @param {string} [generation] Filter packages available on the given hardware generation (slug). Excludes free-tier-only packages when the generation is not free-tier eligible.
|
|
4946
4952
|
* @param {number} [page] A page number within the paginated result set.
|
|
4947
4953
|
* @param {*} [options] Override http request option.
|
|
4948
4954
|
* @throws {RequiredError}
|
|
4949
4955
|
*/
|
|
4950
|
-
cloudServerPackagesList(page?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedServerProductList>>;
|
|
4956
|
+
cloudServerPackagesList(generation?: string, page?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedServerProductList>>;
|
|
4951
4957
|
/**
|
|
4952
4958
|
* List of available server products
|
|
4953
4959
|
* @param {number} id A unique integer value identifying this metered product.
|
|
@@ -5721,11 +5727,12 @@ export declare const CloudApiFactory: (configuration?: Configuration, basePath?:
|
|
|
5721
5727
|
cloudServerPackagesByGenerationRetrieve(options?: RawAxiosRequestConfig): AxiosPromise<ServerProduct>;
|
|
5722
5728
|
/**
|
|
5723
5729
|
* List of available server products
|
|
5730
|
+
* @param {string} [generation] Filter packages available on the given hardware generation (slug). Excludes free-tier-only packages when the generation is not free-tier eligible.
|
|
5724
5731
|
* @param {number} [page] A page number within the paginated result set.
|
|
5725
5732
|
* @param {*} [options] Override http request option.
|
|
5726
5733
|
* @throws {RequiredError}
|
|
5727
5734
|
*/
|
|
5728
|
-
cloudServerPackagesList(page?: number, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedServerProductList>;
|
|
5735
|
+
cloudServerPackagesList(generation?: string, page?: number, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedServerProductList>;
|
|
5729
5736
|
/**
|
|
5730
5737
|
* List of available server products
|
|
5731
5738
|
* @param {number} id A unique integer value identifying this metered product.
|
|
@@ -6499,11 +6506,12 @@ export declare class CloudApi extends BaseAPI {
|
|
|
6499
6506
|
cloudServerPackagesByGenerationRetrieve(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ServerProduct, any, {}>>;
|
|
6500
6507
|
/**
|
|
6501
6508
|
* List of available server products
|
|
6509
|
+
* @param {string} [generation] Filter packages available on the given hardware generation (slug). Excludes free-tier-only packages when the generation is not free-tier eligible.
|
|
6502
6510
|
* @param {number} [page] A page number within the paginated result set.
|
|
6503
6511
|
* @param {*} [options] Override http request option.
|
|
6504
6512
|
* @throws {RequiredError}
|
|
6505
6513
|
*/
|
|
6506
|
-
cloudServerPackagesList(page?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedServerProductList, any, {}>>;
|
|
6514
|
+
cloudServerPackagesList(generation?: string, page?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedServerProductList, any, {}>>;
|
|
6507
6515
|
/**
|
|
6508
6516
|
* List of available server products
|
|
6509
6517
|
* @param {number} id A unique integer value identifying this metered product.
|
package/dist/api.js
CHANGED
|
@@ -5262,11 +5262,12 @@ const CloudApiAxiosParamCreator = function (configuration) {
|
|
|
5262
5262
|
}),
|
|
5263
5263
|
/**
|
|
5264
5264
|
* List of available server products
|
|
5265
|
+
* @param {string} [generation] Filter packages available on the given hardware generation (slug). Excludes free-tier-only packages when the generation is not free-tier eligible.
|
|
5265
5266
|
* @param {number} [page] A page number within the paginated result set.
|
|
5266
5267
|
* @param {*} [options] Override http request option.
|
|
5267
5268
|
* @throws {RequiredError}
|
|
5268
5269
|
*/
|
|
5269
|
-
cloudServerPackagesList: (page_1, ...args_1) => __awaiter(this, [page_1, ...args_1], void 0, function* (page, options = {}) {
|
|
5270
|
+
cloudServerPackagesList: (generation_1, page_1, ...args_1) => __awaiter(this, [generation_1, page_1, ...args_1], void 0, function* (generation, page, options = {}) {
|
|
5270
5271
|
const localVarPath = `/api/cloud/server-packages/`;
|
|
5271
5272
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5272
5273
|
const localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -5280,6 +5281,9 @@ const CloudApiAxiosParamCreator = function (configuration) {
|
|
|
5280
5281
|
// authentication cookieAuth required
|
|
5281
5282
|
// authentication tokenAuth required
|
|
5282
5283
|
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
5284
|
+
if (generation !== undefined) {
|
|
5285
|
+
localVarQueryParameter['generation'] = generation;
|
|
5286
|
+
}
|
|
5283
5287
|
if (page !== undefined) {
|
|
5284
5288
|
localVarQueryParameter['page'] = page;
|
|
5285
5289
|
}
|
|
@@ -7664,14 +7668,15 @@ const CloudApiFp = function (configuration) {
|
|
|
7664
7668
|
},
|
|
7665
7669
|
/**
|
|
7666
7670
|
* List of available server products
|
|
7671
|
+
* @param {string} [generation] Filter packages available on the given hardware generation (slug). Excludes free-tier-only packages when the generation is not free-tier eligible.
|
|
7667
7672
|
* @param {number} [page] A page number within the paginated result set.
|
|
7668
7673
|
* @param {*} [options] Override http request option.
|
|
7669
7674
|
* @throws {RequiredError}
|
|
7670
7675
|
*/
|
|
7671
|
-
cloudServerPackagesList(page, options) {
|
|
7676
|
+
cloudServerPackagesList(generation, page, options) {
|
|
7672
7677
|
return __awaiter(this, void 0, void 0, function* () {
|
|
7673
7678
|
var _a, _b, _c;
|
|
7674
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.cloudServerPackagesList(page, options);
|
|
7679
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.cloudServerPackagesList(generation, page, options);
|
|
7675
7680
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
7676
7681
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CloudApi.cloudServerPackagesList']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
7677
7682
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -8904,12 +8909,13 @@ const CloudApiFactory = function (configuration, basePath, axios) {
|
|
|
8904
8909
|
},
|
|
8905
8910
|
/**
|
|
8906
8911
|
* List of available server products
|
|
8912
|
+
* @param {string} [generation] Filter packages available on the given hardware generation (slug). Excludes free-tier-only packages when the generation is not free-tier eligible.
|
|
8907
8913
|
* @param {number} [page] A page number within the paginated result set.
|
|
8908
8914
|
* @param {*} [options] Override http request option.
|
|
8909
8915
|
* @throws {RequiredError}
|
|
8910
8916
|
*/
|
|
8911
|
-
cloudServerPackagesList(page, options) {
|
|
8912
|
-
return localVarFp.cloudServerPackagesList(page, options).then((request) => request(axios, basePath));
|
|
8917
|
+
cloudServerPackagesList(generation, page, options) {
|
|
8918
|
+
return localVarFp.cloudServerPackagesList(generation, page, options).then((request) => request(axios, basePath));
|
|
8913
8919
|
},
|
|
8914
8920
|
/**
|
|
8915
8921
|
* List of available server products
|
|
@@ -9890,12 +9896,13 @@ class CloudApi extends base_1.BaseAPI {
|
|
|
9890
9896
|
}
|
|
9891
9897
|
/**
|
|
9892
9898
|
* List of available server products
|
|
9899
|
+
* @param {string} [generation] Filter packages available on the given hardware generation (slug). Excludes free-tier-only packages when the generation is not free-tier eligible.
|
|
9893
9900
|
* @param {number} [page] A page number within the paginated result set.
|
|
9894
9901
|
* @param {*} [options] Override http request option.
|
|
9895
9902
|
* @throws {RequiredError}
|
|
9896
9903
|
*/
|
|
9897
|
-
cloudServerPackagesList(page, options) {
|
|
9898
|
-
return (0, exports.CloudApiFp)(this.configuration).cloudServerPackagesList(page, options).then((request) => request(this.axios, this.basePath));
|
|
9904
|
+
cloudServerPackagesList(generation, page, options) {
|
|
9905
|
+
return (0, exports.CloudApiFp)(this.configuration).cloudServerPackagesList(generation, page, options).then((request) => request(this.axios, this.basePath));
|
|
9899
9906
|
}
|
|
9900
9907
|
/**
|
|
9901
9908
|
* List of available server products
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -2164,6 +2164,10 @@ export interface ServerProduct {
|
|
|
2164
2164
|
'id': number;
|
|
2165
2165
|
'slug': string;
|
|
2166
2166
|
'name': string;
|
|
2167
|
+
'cpus': number;
|
|
2168
|
+
'memory': number;
|
|
2169
|
+
'disk_size': number;
|
|
2170
|
+
'traffic': number;
|
|
2167
2171
|
}
|
|
2168
2172
|
export interface ServerProductUpgrade {
|
|
2169
2173
|
/**
|
|
@@ -4165,11 +4169,12 @@ export declare const CloudApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
4165
4169
|
cloudServerPackagesByGenerationRetrieve: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4166
4170
|
/**
|
|
4167
4171
|
* List of available server products
|
|
4172
|
+
* @param {string} [generation] Filter packages available on the given hardware generation (slug). Excludes free-tier-only packages when the generation is not free-tier eligible.
|
|
4168
4173
|
* @param {number} [page] A page number within the paginated result set.
|
|
4169
4174
|
* @param {*} [options] Override http request option.
|
|
4170
4175
|
* @throws {RequiredError}
|
|
4171
4176
|
*/
|
|
4172
|
-
cloudServerPackagesList: (page?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4177
|
+
cloudServerPackagesList: (generation?: string, page?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4173
4178
|
/**
|
|
4174
4179
|
* List of available server products
|
|
4175
4180
|
* @param {number} id A unique integer value identifying this metered product.
|
|
@@ -4943,11 +4948,12 @@ export declare const CloudApiFp: (configuration?: Configuration) => {
|
|
|
4943
4948
|
cloudServerPackagesByGenerationRetrieve(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServerProduct>>;
|
|
4944
4949
|
/**
|
|
4945
4950
|
* List of available server products
|
|
4951
|
+
* @param {string} [generation] Filter packages available on the given hardware generation (slug). Excludes free-tier-only packages when the generation is not free-tier eligible.
|
|
4946
4952
|
* @param {number} [page] A page number within the paginated result set.
|
|
4947
4953
|
* @param {*} [options] Override http request option.
|
|
4948
4954
|
* @throws {RequiredError}
|
|
4949
4955
|
*/
|
|
4950
|
-
cloudServerPackagesList(page?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedServerProductList>>;
|
|
4956
|
+
cloudServerPackagesList(generation?: string, page?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedServerProductList>>;
|
|
4951
4957
|
/**
|
|
4952
4958
|
* List of available server products
|
|
4953
4959
|
* @param {number} id A unique integer value identifying this metered product.
|
|
@@ -5721,11 +5727,12 @@ export declare const CloudApiFactory: (configuration?: Configuration, basePath?:
|
|
|
5721
5727
|
cloudServerPackagesByGenerationRetrieve(options?: RawAxiosRequestConfig): AxiosPromise<ServerProduct>;
|
|
5722
5728
|
/**
|
|
5723
5729
|
* List of available server products
|
|
5730
|
+
* @param {string} [generation] Filter packages available on the given hardware generation (slug). Excludes free-tier-only packages when the generation is not free-tier eligible.
|
|
5724
5731
|
* @param {number} [page] A page number within the paginated result set.
|
|
5725
5732
|
* @param {*} [options] Override http request option.
|
|
5726
5733
|
* @throws {RequiredError}
|
|
5727
5734
|
*/
|
|
5728
|
-
cloudServerPackagesList(page?: number, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedServerProductList>;
|
|
5735
|
+
cloudServerPackagesList(generation?: string, page?: number, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedServerProductList>;
|
|
5729
5736
|
/**
|
|
5730
5737
|
* List of available server products
|
|
5731
5738
|
* @param {number} id A unique integer value identifying this metered product.
|
|
@@ -6499,11 +6506,12 @@ export declare class CloudApi extends BaseAPI {
|
|
|
6499
6506
|
cloudServerPackagesByGenerationRetrieve(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ServerProduct, any, {}>>;
|
|
6500
6507
|
/**
|
|
6501
6508
|
* List of available server products
|
|
6509
|
+
* @param {string} [generation] Filter packages available on the given hardware generation (slug). Excludes free-tier-only packages when the generation is not free-tier eligible.
|
|
6502
6510
|
* @param {number} [page] A page number within the paginated result set.
|
|
6503
6511
|
* @param {*} [options] Override http request option.
|
|
6504
6512
|
* @throws {RequiredError}
|
|
6505
6513
|
*/
|
|
6506
|
-
cloudServerPackagesList(page?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedServerProductList, any, {}>>;
|
|
6514
|
+
cloudServerPackagesList(generation?: string, page?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedServerProductList, any, {}>>;
|
|
6507
6515
|
/**
|
|
6508
6516
|
* List of available server products
|
|
6509
6517
|
* @param {number} id A unique integer value identifying this metered product.
|
package/dist/esm/api.js
CHANGED
|
@@ -5246,11 +5246,12 @@ export const CloudApiAxiosParamCreator = function (configuration) {
|
|
|
5246
5246
|
}),
|
|
5247
5247
|
/**
|
|
5248
5248
|
* List of available server products
|
|
5249
|
+
* @param {string} [generation] Filter packages available on the given hardware generation (slug). Excludes free-tier-only packages when the generation is not free-tier eligible.
|
|
5249
5250
|
* @param {number} [page] A page number within the paginated result set.
|
|
5250
5251
|
* @param {*} [options] Override http request option.
|
|
5251
5252
|
* @throws {RequiredError}
|
|
5252
5253
|
*/
|
|
5253
|
-
cloudServerPackagesList: (page_1, ...args_1) => __awaiter(this, [page_1, ...args_1], void 0, function* (page, options = {}) {
|
|
5254
|
+
cloudServerPackagesList: (generation_1, page_1, ...args_1) => __awaiter(this, [generation_1, page_1, ...args_1], void 0, function* (generation, page, options = {}) {
|
|
5254
5255
|
const localVarPath = `/api/cloud/server-packages/`;
|
|
5255
5256
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5256
5257
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -5264,6 +5265,9 @@ export const CloudApiAxiosParamCreator = function (configuration) {
|
|
|
5264
5265
|
// authentication cookieAuth required
|
|
5265
5266
|
// authentication tokenAuth required
|
|
5266
5267
|
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
5268
|
+
if (generation !== undefined) {
|
|
5269
|
+
localVarQueryParameter['generation'] = generation;
|
|
5270
|
+
}
|
|
5267
5271
|
if (page !== undefined) {
|
|
5268
5272
|
localVarQueryParameter['page'] = page;
|
|
5269
5273
|
}
|
|
@@ -7647,14 +7651,15 @@ export const CloudApiFp = function (configuration) {
|
|
|
7647
7651
|
},
|
|
7648
7652
|
/**
|
|
7649
7653
|
* List of available server products
|
|
7654
|
+
* @param {string} [generation] Filter packages available on the given hardware generation (slug). Excludes free-tier-only packages when the generation is not free-tier eligible.
|
|
7650
7655
|
* @param {number} [page] A page number within the paginated result set.
|
|
7651
7656
|
* @param {*} [options] Override http request option.
|
|
7652
7657
|
* @throws {RequiredError}
|
|
7653
7658
|
*/
|
|
7654
|
-
cloudServerPackagesList(page, options) {
|
|
7659
|
+
cloudServerPackagesList(generation, page, options) {
|
|
7655
7660
|
return __awaiter(this, void 0, void 0, function* () {
|
|
7656
7661
|
var _a, _b, _c;
|
|
7657
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.cloudServerPackagesList(page, options);
|
|
7662
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.cloudServerPackagesList(generation, page, options);
|
|
7658
7663
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
7659
7664
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CloudApi.cloudServerPackagesList']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
7660
7665
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -8886,12 +8891,13 @@ export const CloudApiFactory = function (configuration, basePath, axios) {
|
|
|
8886
8891
|
},
|
|
8887
8892
|
/**
|
|
8888
8893
|
* List of available server products
|
|
8894
|
+
* @param {string} [generation] Filter packages available on the given hardware generation (slug). Excludes free-tier-only packages when the generation is not free-tier eligible.
|
|
8889
8895
|
* @param {number} [page] A page number within the paginated result set.
|
|
8890
8896
|
* @param {*} [options] Override http request option.
|
|
8891
8897
|
* @throws {RequiredError}
|
|
8892
8898
|
*/
|
|
8893
|
-
cloudServerPackagesList(page, options) {
|
|
8894
|
-
return localVarFp.cloudServerPackagesList(page, options).then((request) => request(axios, basePath));
|
|
8899
|
+
cloudServerPackagesList(generation, page, options) {
|
|
8900
|
+
return localVarFp.cloudServerPackagesList(generation, page, options).then((request) => request(axios, basePath));
|
|
8895
8901
|
},
|
|
8896
8902
|
/**
|
|
8897
8903
|
* List of available server products
|
|
@@ -9871,12 +9877,13 @@ export class CloudApi extends BaseAPI {
|
|
|
9871
9877
|
}
|
|
9872
9878
|
/**
|
|
9873
9879
|
* List of available server products
|
|
9880
|
+
* @param {string} [generation] Filter packages available on the given hardware generation (slug). Excludes free-tier-only packages when the generation is not free-tier eligible.
|
|
9874
9881
|
* @param {number} [page] A page number within the paginated result set.
|
|
9875
9882
|
* @param {*} [options] Override http request option.
|
|
9876
9883
|
* @throws {RequiredError}
|
|
9877
9884
|
*/
|
|
9878
|
-
cloudServerPackagesList(page, options) {
|
|
9879
|
-
return CloudApiFp(this.configuration).cloudServerPackagesList(page, options).then((request) => request(this.axios, this.basePath));
|
|
9885
|
+
cloudServerPackagesList(generation, page, options) {
|
|
9886
|
+
return CloudApiFp(this.configuration).cloudServerPackagesList(generation, page, options).then((request) => request(this.axios, this.basePath));
|
|
9880
9887
|
}
|
|
9881
9888
|
/**
|
|
9882
9889
|
* List of available server products
|
package/docs/CloudApi.md
CHANGED
|
@@ -3314,9 +3314,11 @@ import {
|
|
|
3314
3314
|
const configuration = new Configuration();
|
|
3315
3315
|
const apiInstance = new CloudApi(configuration);
|
|
3316
3316
|
|
|
3317
|
+
let generation: string; //Filter packages available on the given hardware generation (slug). Excludes free-tier-only packages when the generation is not free-tier eligible. (optional) (default to undefined)
|
|
3317
3318
|
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
3318
3319
|
|
|
3319
3320
|
const { status, data } = await apiInstance.cloudServerPackagesList(
|
|
3321
|
+
generation,
|
|
3320
3322
|
page
|
|
3321
3323
|
);
|
|
3322
3324
|
```
|
|
@@ -3325,6 +3327,7 @@ const { status, data } = await apiInstance.cloudServerPackagesList(
|
|
|
3325
3327
|
|
|
3326
3328
|
|Name | Type | Description | Notes|
|
|
3327
3329
|
|------------- | ------------- | ------------- | -------------|
|
|
3330
|
+
| **generation** | [**string**] | Filter packages available on the given hardware generation (slug). Excludes free-tier-only packages when the generation is not free-tier eligible. | (optional) defaults to undefined|
|
|
3328
3331
|
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
3329
3332
|
|
|
3330
3333
|
|
package/docs/ServerProduct.md
CHANGED
|
@@ -8,6 +8,10 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**id** | **number** | | [readonly] [default to undefined]
|
|
9
9
|
**slug** | **string** | | [default to undefined]
|
|
10
10
|
**name** | **string** | | [readonly] [default to undefined]
|
|
11
|
+
**cpus** | **number** | | [readonly] [default to undefined]
|
|
12
|
+
**memory** | **number** | | [readonly] [default to undefined]
|
|
13
|
+
**disk_size** | **number** | | [readonly] [default to undefined]
|
|
14
|
+
**traffic** | **number** | | [readonly] [default to undefined]
|
|
11
15
|
|
|
12
16
|
## Example
|
|
13
17
|
|
|
@@ -18,6 +22,10 @@ const instance: ServerProduct = {
|
|
|
18
22
|
id,
|
|
19
23
|
slug,
|
|
20
24
|
name,
|
|
25
|
+
cpus,
|
|
26
|
+
memory,
|
|
27
|
+
disk_size,
|
|
28
|
+
traffic,
|
|
21
29
|
};
|
|
22
30
|
```
|
|
23
31
|
|