@nexgencloud/hyperstack-sdk-typescript 1.55.7-alpha → 1.56.0-alpha
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 +408 -34
- package/dist/api.d.ts +279 -35
- package/dist/api.js +274 -33
- package/dist/esm/api.d.ts +279 -35
- package/dist/esm/api.js +269 -32
- package/dist/esm/hyperstackHeaders.js +1 -1
- package/dist/hyperstackHeaders.js +1 -1
- package/hyperstackHeaders.ts +1 -1
- package/package.json +1 -1
package/api.ts
CHANGED
|
@@ -1124,6 +1124,12 @@ export interface ClusterFields {
|
|
|
1124
1124
|
* @memberof ClusterFields
|
|
1125
1125
|
*/
|
|
1126
1126
|
'environment_name'?: string;
|
|
1127
|
+
/**
|
|
1128
|
+
*
|
|
1129
|
+
* @type {boolean}
|
|
1130
|
+
* @memberof ClusterFields
|
|
1131
|
+
*/
|
|
1132
|
+
'has_persistent_storage'?: boolean;
|
|
1127
1133
|
/**
|
|
1128
1134
|
*
|
|
1129
1135
|
* @type {number}
|
|
@@ -1640,6 +1646,56 @@ export interface ClusterResponse {
|
|
|
1640
1646
|
*/
|
|
1641
1647
|
'status'?: boolean;
|
|
1642
1648
|
}
|
|
1649
|
+
/**
|
|
1650
|
+
*
|
|
1651
|
+
* @export
|
|
1652
|
+
* @interface ClusterRestoreFailedNode
|
|
1653
|
+
*/
|
|
1654
|
+
export interface ClusterRestoreFailedNode {
|
|
1655
|
+
/**
|
|
1656
|
+
*
|
|
1657
|
+
* @type {string}
|
|
1658
|
+
* @memberof ClusterRestoreFailedNode
|
|
1659
|
+
*/
|
|
1660
|
+
'error'?: string;
|
|
1661
|
+
/**
|
|
1662
|
+
*
|
|
1663
|
+
* @type {number}
|
|
1664
|
+
* @memberof ClusterRestoreFailedNode
|
|
1665
|
+
*/
|
|
1666
|
+
'id'?: number;
|
|
1667
|
+
}
|
|
1668
|
+
/**
|
|
1669
|
+
*
|
|
1670
|
+
* @export
|
|
1671
|
+
* @interface ClusterRestoreResponse
|
|
1672
|
+
*/
|
|
1673
|
+
export interface ClusterRestoreResponse {
|
|
1674
|
+
/**
|
|
1675
|
+
*
|
|
1676
|
+
* @type {Array<ClusterRestoreFailedNode>}
|
|
1677
|
+
* @memberof ClusterRestoreResponse
|
|
1678
|
+
*/
|
|
1679
|
+
'failed_nodes'?: Array<ClusterRestoreFailedNode>;
|
|
1680
|
+
/**
|
|
1681
|
+
*
|
|
1682
|
+
* @type {string}
|
|
1683
|
+
* @memberof ClusterRestoreResponse
|
|
1684
|
+
*/
|
|
1685
|
+
'message'?: string;
|
|
1686
|
+
/**
|
|
1687
|
+
*
|
|
1688
|
+
* @type {Array<number>}
|
|
1689
|
+
* @memberof ClusterRestoreResponse
|
|
1690
|
+
*/
|
|
1691
|
+
'restoring_nodes'?: Array<number>;
|
|
1692
|
+
/**
|
|
1693
|
+
*
|
|
1694
|
+
* @type {boolean}
|
|
1695
|
+
* @memberof ClusterRestoreResponse
|
|
1696
|
+
*/
|
|
1697
|
+
'status'?: boolean;
|
|
1698
|
+
}
|
|
1643
1699
|
/**
|
|
1644
1700
|
*
|
|
1645
1701
|
* @export
|
|
@@ -6073,6 +6129,19 @@ export interface ObjectStorageAccessKeyResponse {
|
|
|
6073
6129
|
}
|
|
6074
6130
|
|
|
6075
6131
|
|
|
6132
|
+
/**
|
|
6133
|
+
*
|
|
6134
|
+
* @export
|
|
6135
|
+
* @interface ObjectStorageAccessKeyUpdateRequest
|
|
6136
|
+
*/
|
|
6137
|
+
export interface ObjectStorageAccessKeyUpdateRequest {
|
|
6138
|
+
/**
|
|
6139
|
+
*
|
|
6140
|
+
* @type {string}
|
|
6141
|
+
* @memberof ObjectStorageAccessKeyUpdateRequest
|
|
6142
|
+
*/
|
|
6143
|
+
'description': string;
|
|
6144
|
+
}
|
|
6076
6145
|
/**
|
|
6077
6146
|
*
|
|
6078
6147
|
* @export
|
|
@@ -6895,6 +6964,31 @@ export interface PaymentInitiateResponse {
|
|
|
6895
6964
|
*/
|
|
6896
6965
|
'status'?: boolean;
|
|
6897
6966
|
}
|
|
6967
|
+
/**
|
|
6968
|
+
*
|
|
6969
|
+
* @export
|
|
6970
|
+
* @interface PaymentReceiptResponse
|
|
6971
|
+
*/
|
|
6972
|
+
export interface PaymentReceiptResponse {
|
|
6973
|
+
/**
|
|
6974
|
+
*
|
|
6975
|
+
* @type {string}
|
|
6976
|
+
* @memberof PaymentReceiptResponse
|
|
6977
|
+
*/
|
|
6978
|
+
'message'?: string;
|
|
6979
|
+
/**
|
|
6980
|
+
*
|
|
6981
|
+
* @type {string}
|
|
6982
|
+
* @memberof PaymentReceiptResponse
|
|
6983
|
+
*/
|
|
6984
|
+
'receipt_url'?: string;
|
|
6985
|
+
/**
|
|
6986
|
+
*
|
|
6987
|
+
* @type {boolean}
|
|
6988
|
+
* @memberof PaymentReceiptResponse
|
|
6989
|
+
*/
|
|
6990
|
+
'status'?: boolean;
|
|
6991
|
+
}
|
|
6898
6992
|
/**
|
|
6899
6993
|
*
|
|
6900
6994
|
* @export
|
|
@@ -10654,6 +10748,31 @@ export interface WorkloadBillingHistoryResponse {
|
|
|
10654
10748
|
*/
|
|
10655
10749
|
'success'?: boolean;
|
|
10656
10750
|
}
|
|
10751
|
+
/**
|
|
10752
|
+
*
|
|
10753
|
+
* @export
|
|
10754
|
+
* @interface ZendeskMessagingToken
|
|
10755
|
+
*/
|
|
10756
|
+
export interface ZendeskMessagingToken {
|
|
10757
|
+
/**
|
|
10758
|
+
*
|
|
10759
|
+
* @type {string}
|
|
10760
|
+
* @memberof ZendeskMessagingToken
|
|
10761
|
+
*/
|
|
10762
|
+
'message'?: string;
|
|
10763
|
+
/**
|
|
10764
|
+
*
|
|
10765
|
+
* @type {boolean}
|
|
10766
|
+
* @memberof ZendeskMessagingToken
|
|
10767
|
+
*/
|
|
10768
|
+
'status'?: boolean;
|
|
10769
|
+
/**
|
|
10770
|
+
* Signed HS256 JWT to pass to the Zendesk Web Widget loginUser API
|
|
10771
|
+
* @type {string}
|
|
10772
|
+
* @memberof ZendeskMessagingToken
|
|
10773
|
+
*/
|
|
10774
|
+
'token'?: string;
|
|
10775
|
+
}
|
|
10657
10776
|
|
|
10658
10777
|
/**
|
|
10659
10778
|
* AccessKeysApi - axios parameter creator
|
|
@@ -10778,6 +10897,47 @@ export const AccessKeysApiAxiosParamCreator = function (configuration?: Configur
|
|
|
10778
10897
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10779
10898
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
10780
10899
|
|
|
10900
|
+
return {
|
|
10901
|
+
url: toPathString(localVarUrlObj),
|
|
10902
|
+
options: localVarRequestOptions,
|
|
10903
|
+
};
|
|
10904
|
+
},
|
|
10905
|
+
/**
|
|
10906
|
+
*
|
|
10907
|
+
* @summary Rename an existing access key
|
|
10908
|
+
* @param {string} accessKeyId
|
|
10909
|
+
* @param {ObjectStorageAccessKeyUpdateRequest} [body]
|
|
10910
|
+
* @param {*} [options] Override http request option.
|
|
10911
|
+
* @throws {RequiredError}
|
|
10912
|
+
*/
|
|
10913
|
+
updateAccessKeyEndpoint: async (accessKeyId: string, body?: ObjectStorageAccessKeyUpdateRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
10914
|
+
// verify required parameter 'accessKeyId' is not null or undefined
|
|
10915
|
+
assertParamExists('updateAccessKeyEndpoint', 'accessKeyId', accessKeyId)
|
|
10916
|
+
const localVarPath = `/object-storage/access-keys/{access_key_id}`
|
|
10917
|
+
.replace(`{${"access_key_id"}}`, encodeURIComponent(String(accessKeyId)));
|
|
10918
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
10919
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
10920
|
+
let baseOptions;
|
|
10921
|
+
if (configuration) {
|
|
10922
|
+
baseOptions = configuration.baseOptions;
|
|
10923
|
+
}
|
|
10924
|
+
|
|
10925
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
10926
|
+
const localVarHeaderParameter = {} as any;
|
|
10927
|
+
const localVarQueryParameter = {} as any;
|
|
10928
|
+
|
|
10929
|
+
// authentication apiKey required
|
|
10930
|
+
await setApiKeyToObject(localVarHeaderParameter, "api_key", configuration)
|
|
10931
|
+
|
|
10932
|
+
|
|
10933
|
+
|
|
10934
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
10935
|
+
|
|
10936
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
10937
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10938
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
10939
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
|
|
10940
|
+
|
|
10781
10941
|
return {
|
|
10782
10942
|
url: toPathString(localVarUrlObj),
|
|
10783
10943
|
options: localVarRequestOptions,
|
|
@@ -10834,6 +10994,20 @@ export const AccessKeysApiFp = function(configuration?: Configuration) {
|
|
|
10834
10994
|
const localVarOperationServerBasePath = operationServerMap['AccessKeysApi.listAccessKeysEndpoint']?.[localVarOperationServerIndex]?.url;
|
|
10835
10995
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
10836
10996
|
},
|
|
10997
|
+
/**
|
|
10998
|
+
*
|
|
10999
|
+
* @summary Rename an existing access key
|
|
11000
|
+
* @param {string} accessKeyId
|
|
11001
|
+
* @param {ObjectStorageAccessKeyUpdateRequest} [body]
|
|
11002
|
+
* @param {*} [options] Override http request option.
|
|
11003
|
+
* @throws {RequiredError}
|
|
11004
|
+
*/
|
|
11005
|
+
async updateAccessKeyEndpoint(accessKeyId: string, body?: ObjectStorageAccessKeyUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ObjectStorageAccessKeyResponse>> {
|
|
11006
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccessKeyEndpoint(accessKeyId, body, options);
|
|
11007
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11008
|
+
const localVarOperationServerBasePath = operationServerMap['AccessKeysApi.updateAccessKeyEndpoint']?.[localVarOperationServerIndex]?.url;
|
|
11009
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11010
|
+
},
|
|
10837
11011
|
}
|
|
10838
11012
|
};
|
|
10839
11013
|
|
|
@@ -10876,6 +11050,17 @@ export const AccessKeysApiFactory = function (configuration?: Configuration, bas
|
|
|
10876
11050
|
listAccessKeysEndpoint(search?: string, page?: string, pageSize?: string, options?: RawAxiosRequestConfig): AxiosPromise<ObjectStorageAccessKeyListResponse> {
|
|
10877
11051
|
return localVarFp.listAccessKeysEndpoint(search, page, pageSize, options).then((request) => request(axios, basePath));
|
|
10878
11052
|
},
|
|
11053
|
+
/**
|
|
11054
|
+
*
|
|
11055
|
+
* @summary Rename an existing access key
|
|
11056
|
+
* @param {string} accessKeyId
|
|
11057
|
+
* @param {ObjectStorageAccessKeyUpdateRequest} [body]
|
|
11058
|
+
* @param {*} [options] Override http request option.
|
|
11059
|
+
* @throws {RequiredError}
|
|
11060
|
+
*/
|
|
11061
|
+
updateAccessKeyEndpoint(accessKeyId: string, body?: ObjectStorageAccessKeyUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<ObjectStorageAccessKeyResponse> {
|
|
11062
|
+
return localVarFp.updateAccessKeyEndpoint(accessKeyId, body, options).then((request) => request(axios, basePath));
|
|
11063
|
+
},
|
|
10879
11064
|
};
|
|
10880
11065
|
};
|
|
10881
11066
|
|
|
@@ -10923,6 +11108,19 @@ export class AccessKeysApi extends BaseAPI {
|
|
|
10923
11108
|
public listAccessKeysEndpoint(search?: string, page?: string, pageSize?: string, options?: RawAxiosRequestConfig) {
|
|
10924
11109
|
return AccessKeysApiFp(this.configuration).listAccessKeysEndpoint(search, page, pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
10925
11110
|
}
|
|
11111
|
+
|
|
11112
|
+
/**
|
|
11113
|
+
*
|
|
11114
|
+
* @summary Rename an existing access key
|
|
11115
|
+
* @param {string} accessKeyId
|
|
11116
|
+
* @param {ObjectStorageAccessKeyUpdateRequest} [body]
|
|
11117
|
+
* @param {*} [options] Override http request option.
|
|
11118
|
+
* @throws {RequiredError}
|
|
11119
|
+
* @memberof AccessKeysApi
|
|
11120
|
+
*/
|
|
11121
|
+
public updateAccessKeyEndpoint(accessKeyId: string, body?: ObjectStorageAccessKeyUpdateRequest, options?: RawAxiosRequestConfig) {
|
|
11122
|
+
return AccessKeysApiFp(this.configuration).updateAccessKeyEndpoint(accessKeyId, body, options).then((request) => request(this.axios, this.basePath));
|
|
11123
|
+
}
|
|
10926
11124
|
}
|
|
10927
11125
|
|
|
10928
11126
|
|
|
@@ -10934,7 +11132,7 @@ export class AccessKeysApi extends BaseAPI {
|
|
|
10934
11132
|
export const AliveApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
10935
11133
|
return {
|
|
10936
11134
|
/**
|
|
10937
|
-
* Retrieve the billing status of your account to ensure that it is active. An active billing status ensures uninterrupted service. For additional information [**click here**](
|
|
11135
|
+
* Retrieve the billing status of your account to ensure that it is active. An active billing status ensures uninterrupted service. For additional information [**click here**](https://docs.hyperstack.cloud/docs/api-reference/billing-resources/alive/).
|
|
10938
11136
|
* @summary GET: Alive
|
|
10939
11137
|
* @param {*} [options] Override http request option.
|
|
10940
11138
|
* @throws {RequiredError}
|
|
@@ -11009,7 +11207,7 @@ export const AliveApiFp = function(configuration?: Configuration) {
|
|
|
11009
11207
|
const localVarAxiosParamCreator = AliveApiAxiosParamCreator(configuration)
|
|
11010
11208
|
return {
|
|
11011
11209
|
/**
|
|
11012
|
-
* Retrieve the billing status of your account to ensure that it is active. An active billing status ensures uninterrupted service. For additional information [**click here**](
|
|
11210
|
+
* Retrieve the billing status of your account to ensure that it is active. An active billing status ensures uninterrupted service. For additional information [**click here**](https://docs.hyperstack.cloud/docs/api-reference/billing-resources/alive/).
|
|
11013
11211
|
* @summary GET: Alive
|
|
11014
11212
|
* @param {*} [options] Override http request option.
|
|
11015
11213
|
* @throws {RequiredError}
|
|
@@ -11042,7 +11240,7 @@ export const AliveApiFactory = function (configuration?: Configuration, basePath
|
|
|
11042
11240
|
const localVarFp = AliveApiFp(configuration)
|
|
11043
11241
|
return {
|
|
11044
11242
|
/**
|
|
11045
|
-
* Retrieve the billing status of your account to ensure that it is active. An active billing status ensures uninterrupted service. For additional information [**click here**](
|
|
11243
|
+
* Retrieve the billing status of your account to ensure that it is active. An active billing status ensures uninterrupted service. For additional information [**click here**](https://docs.hyperstack.cloud/docs/api-reference/billing-resources/alive/).
|
|
11046
11244
|
* @summary GET: Alive
|
|
11047
11245
|
* @param {*} [options] Override http request option.
|
|
11048
11246
|
* @throws {RequiredError}
|
|
@@ -11069,7 +11267,7 @@ export const AliveApiFactory = function (configuration?: Configuration, basePath
|
|
|
11069
11267
|
*/
|
|
11070
11268
|
export class AliveApi extends BaseAPI {
|
|
11071
11269
|
/**
|
|
11072
|
-
* Retrieve the billing status of your account to ensure that it is active. An active billing status ensures uninterrupted service. For additional information [**click here**](
|
|
11270
|
+
* Retrieve the billing status of your account to ensure that it is active. An active billing status ensures uninterrupted service. For additional information [**click here**](https://docs.hyperstack.cloud/docs/api-reference/billing-resources/alive/).
|
|
11073
11271
|
* @summary GET: Alive
|
|
11074
11272
|
* @param {*} [options] Override http request option.
|
|
11075
11273
|
* @throws {RequiredError}
|
|
@@ -12029,7 +12227,7 @@ export const AutoTopupApiAxiosParamCreator = function (configuration?: Configura
|
|
|
12029
12227
|
};
|
|
12030
12228
|
},
|
|
12031
12229
|
/**
|
|
12032
|
-
* Retrieves the current auto top-up configuration and status for your organization. Returns the status (active, disabled, pending_setup, or null if never configured), along with the threshold and top-up amounts. For additional information, [**click here**](
|
|
12230
|
+
* Retrieves the current auto top-up configuration and status for your organization. Returns the status (active, disabled, pending_setup, or null if never configured), along with the threshold and top-up amounts. For additional information, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/billing-resources/).
|
|
12033
12231
|
* @summary Get auto top-up status and configuration
|
|
12034
12232
|
* @param {*} [options] Override http request option.
|
|
12035
12233
|
* @throws {RequiredError}
|
|
@@ -12148,7 +12346,7 @@ export const AutoTopupApiFp = function(configuration?: Configuration) {
|
|
|
12148
12346
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12149
12347
|
},
|
|
12150
12348
|
/**
|
|
12151
|
-
* Retrieves the current auto top-up configuration and status for your organization. Returns the status (active, disabled, pending_setup, or null if never configured), along with the threshold and top-up amounts. For additional information, [**click here**](
|
|
12349
|
+
* Retrieves the current auto top-up configuration and status for your organization. Returns the status (active, disabled, pending_setup, or null if never configured), along with the threshold and top-up amounts. For additional information, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/billing-resources/).
|
|
12152
12350
|
* @summary Get auto top-up status and configuration
|
|
12153
12351
|
* @param {*} [options] Override http request option.
|
|
12154
12352
|
* @throws {RequiredError}
|
|
@@ -12211,7 +12409,7 @@ export const AutoTopupApiFactory = function (configuration?: Configuration, base
|
|
|
12211
12409
|
return localVarFp.getAutoTopUp(options).then((request) => request(axios, basePath));
|
|
12212
12410
|
},
|
|
12213
12411
|
/**
|
|
12214
|
-
* Retrieves the current auto top-up configuration and status for your organization. Returns the status (active, disabled, pending_setup, or null if never configured), along with the threshold and top-up amounts. For additional information, [**click here**](
|
|
12412
|
+
* Retrieves the current auto top-up configuration and status for your organization. Returns the status (active, disabled, pending_setup, or null if never configured), along with the threshold and top-up amounts. For additional information, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/billing-resources/).
|
|
12215
12413
|
* @summary Get auto top-up status and configuration
|
|
12216
12414
|
* @param {*} [options] Override http request option.
|
|
12217
12415
|
* @throws {RequiredError}
|
|
@@ -12274,7 +12472,7 @@ export class AutoTopupApi extends BaseAPI {
|
|
|
12274
12472
|
}
|
|
12275
12473
|
|
|
12276
12474
|
/**
|
|
12277
|
-
* Retrieves the current auto top-up configuration and status for your organization. Returns the status (active, disabled, pending_setup, or null if never configured), along with the threshold and top-up amounts. For additional information, [**click here**](
|
|
12475
|
+
* Retrieves the current auto top-up configuration and status for your organization. Returns the status (active, disabled, pending_setup, or null if never configured), along with the threshold and top-up amounts. For additional information, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/billing-resources/).
|
|
12278
12476
|
* @summary Get auto top-up status and configuration
|
|
12279
12477
|
* @param {*} [options] Override http request option.
|
|
12280
12478
|
* @throws {RequiredError}
|
|
@@ -13151,7 +13349,7 @@ export const BillingApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
13151
13349
|
};
|
|
13152
13350
|
},
|
|
13153
13351
|
/**
|
|
13154
|
-
* Retrieve the previous day\'s costs for instances, volumes, and clusters. Returns a breakdown of the costs and the total cost for the last day. For additional information on Retrieve Previous Day Usage Costs, [**click here**](
|
|
13352
|
+
* Retrieve the previous day\'s costs for instances, volumes, and clusters. Returns a breakdown of the costs and the total cost for the last day. For additional information on Retrieve Previous Day Usage Costs, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/billing-resources/last-day-usage/)
|
|
13155
13353
|
* @summary GET: Last Day Cost
|
|
13156
13354
|
* @param {*} [options] Override http request option.
|
|
13157
13355
|
* @throws {RequiredError}
|
|
@@ -13612,7 +13810,7 @@ export const BillingApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
13612
13810
|
};
|
|
13613
13811
|
},
|
|
13614
13812
|
/**
|
|
13615
|
-
* Retrieve active billing metrics for the organization\'s resources, including pricing, uptime, and total cost. Returns usage details for each active resource by defualt(`deleted=false` will return active resources). Additionally, adding `deleted=true` in query parameter will return inactive resources. For additional information on view usage costs for all resources, [**click here**](
|
|
13813
|
+
* Retrieve active billing metrics for the organization\'s resources, including pricing, uptime, and total cost. Returns usage details for each active resource by defualt(`deleted=false` will return active resources). Additionally, adding `deleted=true` in query parameter will return inactive resources. For additional information on view usage costs for all resources, [**click here**](https://docs.hyperstack.cloud/docs/billing/pricebook/)
|
|
13616
13814
|
* @summary GET: Billing usage
|
|
13617
13815
|
* @param {string} [deleted] `true` will return inactive resources and `false` will return active resources. By defualt(`deleted=false`)
|
|
13618
13816
|
* @param {string} [environment] Filter resources by environment ID or Name
|
|
@@ -14702,7 +14900,7 @@ export const BillingApiFp = function(configuration?: Configuration) {
|
|
|
14702
14900
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14703
14901
|
},
|
|
14704
14902
|
/**
|
|
14705
|
-
* Retrieve the previous day\'s costs for instances, volumes, and clusters. Returns a breakdown of the costs and the total cost for the last day. For additional information on Retrieve Previous Day Usage Costs, [**click here**](
|
|
14903
|
+
* Retrieve the previous day\'s costs for instances, volumes, and clusters. Returns a breakdown of the costs and the total cost for the last day. For additional information on Retrieve Previous Day Usage Costs, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/billing-resources/last-day-usage/)
|
|
14706
14904
|
* @summary GET: Last Day Cost
|
|
14707
14905
|
* @param {*} [options] Override http request option.
|
|
14708
14906
|
* @throws {RequiredError}
|
|
@@ -14848,7 +15046,7 @@ export const BillingApiFp = function(configuration?: Configuration) {
|
|
|
14848
15046
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14849
15047
|
},
|
|
14850
15048
|
/**
|
|
14851
|
-
* Retrieve active billing metrics for the organization\'s resources, including pricing, uptime, and total cost. Returns usage details for each active resource by defualt(`deleted=false` will return active resources). Additionally, adding `deleted=true` in query parameter will return inactive resources. For additional information on view usage costs for all resources, [**click here**](
|
|
15049
|
+
* Retrieve active billing metrics for the organization\'s resources, including pricing, uptime, and total cost. Returns usage details for each active resource by defualt(`deleted=false` will return active resources). Additionally, adding `deleted=true` in query parameter will return inactive resources. For additional information on view usage costs for all resources, [**click here**](https://docs.hyperstack.cloud/docs/billing/pricebook/)
|
|
14852
15050
|
* @summary GET: Billing usage
|
|
14853
15051
|
* @param {string} [deleted] `true` will return inactive resources and `false` will return active resources. By defualt(`deleted=false`)
|
|
14854
15052
|
* @param {string} [environment] Filter resources by environment ID or Name
|
|
@@ -15284,7 +15482,7 @@ export const BillingApiFactory = function (configuration?: Configuration, basePa
|
|
|
15284
15482
|
return localVarFp.getImageGenerationHistoryForResource(resourceId, startDate, endDate, options).then((request) => request(axios, basePath));
|
|
15285
15483
|
},
|
|
15286
15484
|
/**
|
|
15287
|
-
* Retrieve the previous day\'s costs for instances, volumes, and clusters. Returns a breakdown of the costs and the total cost for the last day. For additional information on Retrieve Previous Day Usage Costs, [**click here**](
|
|
15485
|
+
* Retrieve the previous day\'s costs for instances, volumes, and clusters. Returns a breakdown of the costs and the total cost for the last day. For additional information on Retrieve Previous Day Usage Costs, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/billing-resources/last-day-usage/)
|
|
15288
15486
|
* @summary GET: Last Day Cost
|
|
15289
15487
|
* @param {*} [options] Override http request option.
|
|
15290
15488
|
* @throws {RequiredError}
|
|
@@ -15400,7 +15598,7 @@ export const BillingApiFactory = function (configuration?: Configuration, basePa
|
|
|
15400
15598
|
return localVarFp.getSnapshotBillingHistoryGraph(snapshotId, startDate, endDate, options).then((request) => request(axios, basePath));
|
|
15401
15599
|
},
|
|
15402
15600
|
/**
|
|
15403
|
-
* Retrieve active billing metrics for the organization\'s resources, including pricing, uptime, and total cost. Returns usage details for each active resource by defualt(`deleted=false` will return active resources). Additionally, adding `deleted=true` in query parameter will return inactive resources. For additional information on view usage costs for all resources, [**click here**](
|
|
15601
|
+
* Retrieve active billing metrics for the organization\'s resources, including pricing, uptime, and total cost. Returns usage details for each active resource by defualt(`deleted=false` will return active resources). Additionally, adding `deleted=true` in query parameter will return inactive resources. For additional information on view usage costs for all resources, [**click here**](https://docs.hyperstack.cloud/docs/billing/pricebook/)
|
|
15404
15602
|
* @summary GET: Billing usage
|
|
15405
15603
|
* @param {string} [deleted] `true` will return inactive resources and `false` will return active resources. By defualt(`deleted=false`)
|
|
15406
15604
|
* @param {string} [environment] Filter resources by environment ID or Name
|
|
@@ -15806,7 +16004,7 @@ export class BillingApi extends BaseAPI {
|
|
|
15806
16004
|
}
|
|
15807
16005
|
|
|
15808
16006
|
/**
|
|
15809
|
-
* Retrieve the previous day\'s costs for instances, volumes, and clusters. Returns a breakdown of the costs and the total cost for the last day. For additional information on Retrieve Previous Day Usage Costs, [**click here**](
|
|
16007
|
+
* Retrieve the previous day\'s costs for instances, volumes, and clusters. Returns a breakdown of the costs and the total cost for the last day. For additional information on Retrieve Previous Day Usage Costs, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/billing-resources/last-day-usage/)
|
|
15810
16008
|
* @summary GET: Last Day Cost
|
|
15811
16009
|
* @param {*} [options] Override http request option.
|
|
15812
16010
|
* @throws {RequiredError}
|
|
@@ -15942,7 +16140,7 @@ export class BillingApi extends BaseAPI {
|
|
|
15942
16140
|
}
|
|
15943
16141
|
|
|
15944
16142
|
/**
|
|
15945
|
-
* Retrieve active billing metrics for the organization\'s resources, including pricing, uptime, and total cost. Returns usage details for each active resource by defualt(`deleted=false` will return active resources). Additionally, adding `deleted=true` in query parameter will return inactive resources. For additional information on view usage costs for all resources, [**click here**](
|
|
16143
|
+
* Retrieve active billing metrics for the organization\'s resources, including pricing, uptime, and total cost. Returns usage details for each active resource by defualt(`deleted=false` will return active resources). Additionally, adding `deleted=true` in query parameter will return inactive resources. For additional information on view usage costs for all resources, [**click here**](https://docs.hyperstack.cloud/docs/billing/pricebook/)
|
|
15946
16144
|
* @summary GET: Billing usage
|
|
15947
16145
|
* @param {string} [deleted] `true` will return inactive resources and `false` will return active resources. By defualt(`deleted=false`)
|
|
15948
16146
|
* @param {string} [environment] Filter resources by environment ID or Name
|
|
@@ -17850,6 +18048,43 @@ export const ClustersApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
17850
18048
|
|
|
17851
18049
|
|
|
17852
18050
|
|
|
18051
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
18052
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
18053
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
18054
|
+
|
|
18055
|
+
return {
|
|
18056
|
+
url: toPathString(localVarUrlObj),
|
|
18057
|
+
options: localVarRequestOptions,
|
|
18058
|
+
};
|
|
18059
|
+
},
|
|
18060
|
+
/**
|
|
18061
|
+
*
|
|
18062
|
+
* @summary Restore a hibernated cluster\'s nodes and reconcile the cluster
|
|
18063
|
+
* @param {number} clusterId
|
|
18064
|
+
* @param {*} [options] Override http request option.
|
|
18065
|
+
* @throws {RequiredError}
|
|
18066
|
+
*/
|
|
18067
|
+
restoreAHibernatedCluster: async (clusterId: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
18068
|
+
// verify required parameter 'clusterId' is not null or undefined
|
|
18069
|
+
assertParamExists('restoreAHibernatedCluster', 'clusterId', clusterId)
|
|
18070
|
+
const localVarPath = `/core/clusters/{cluster_id}/restore`
|
|
18071
|
+
.replace(`{${"cluster_id"}}`, encodeURIComponent(String(clusterId)));
|
|
18072
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
18073
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
18074
|
+
let baseOptions;
|
|
18075
|
+
if (configuration) {
|
|
18076
|
+
baseOptions = configuration.baseOptions;
|
|
18077
|
+
}
|
|
18078
|
+
|
|
18079
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
18080
|
+
const localVarHeaderParameter = {} as any;
|
|
18081
|
+
const localVarQueryParameter = {} as any;
|
|
18082
|
+
|
|
18083
|
+
// authentication apiKey required
|
|
18084
|
+
await setApiKeyToObject(localVarHeaderParameter, "api_key", configuration)
|
|
18085
|
+
|
|
18086
|
+
|
|
18087
|
+
|
|
17853
18088
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
17854
18089
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
17855
18090
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -18132,6 +18367,19 @@ export const ClustersApiFp = function(configuration?: Configuration) {
|
|
|
18132
18367
|
const localVarOperationServerBasePath = operationServerMap['ClustersApi.reconcileCluster']?.[localVarOperationServerIndex]?.url;
|
|
18133
18368
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18134
18369
|
},
|
|
18370
|
+
/**
|
|
18371
|
+
*
|
|
18372
|
+
* @summary Restore a hibernated cluster\'s nodes and reconcile the cluster
|
|
18373
|
+
* @param {number} clusterId
|
|
18374
|
+
* @param {*} [options] Override http request option.
|
|
18375
|
+
* @throws {RequiredError}
|
|
18376
|
+
*/
|
|
18377
|
+
async restoreAHibernatedCluster(clusterId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClusterRestoreResponse>> {
|
|
18378
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.restoreAHibernatedCluster(clusterId, options);
|
|
18379
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
18380
|
+
const localVarOperationServerBasePath = operationServerMap['ClustersApi.restoreAHibernatedCluster']?.[localVarOperationServerIndex]?.url;
|
|
18381
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18382
|
+
},
|
|
18135
18383
|
/**
|
|
18136
18384
|
*
|
|
18137
18385
|
* @summary Update a node group in a cluster
|
|
@@ -18325,6 +18573,16 @@ export const ClustersApiFactory = function (configuration?: Configuration, baseP
|
|
|
18325
18573
|
reconcileCluster(clusterId: number, options?: RawAxiosRequestConfig): AxiosPromise<ManualReconciliationModel> {
|
|
18326
18574
|
return localVarFp.reconcileCluster(clusterId, options).then((request) => request(axios, basePath));
|
|
18327
18575
|
},
|
|
18576
|
+
/**
|
|
18577
|
+
*
|
|
18578
|
+
* @summary Restore a hibernated cluster\'s nodes and reconcile the cluster
|
|
18579
|
+
* @param {number} clusterId
|
|
18580
|
+
* @param {*} [options] Override http request option.
|
|
18581
|
+
* @throws {RequiredError}
|
|
18582
|
+
*/
|
|
18583
|
+
restoreAHibernatedCluster(clusterId: number, options?: RawAxiosRequestConfig): AxiosPromise<ClusterRestoreResponse> {
|
|
18584
|
+
return localVarFp.restoreAHibernatedCluster(clusterId, options).then((request) => request(axios, basePath));
|
|
18585
|
+
},
|
|
18328
18586
|
/**
|
|
18329
18587
|
*
|
|
18330
18588
|
* @summary Update a node group in a cluster
|
|
@@ -18547,6 +18805,18 @@ export class ClustersApi extends BaseAPI {
|
|
|
18547
18805
|
return ClustersApiFp(this.configuration).reconcileCluster(clusterId, options).then((request) => request(this.axios, this.basePath));
|
|
18548
18806
|
}
|
|
18549
18807
|
|
|
18808
|
+
/**
|
|
18809
|
+
*
|
|
18810
|
+
* @summary Restore a hibernated cluster\'s nodes and reconcile the cluster
|
|
18811
|
+
* @param {number} clusterId
|
|
18812
|
+
* @param {*} [options] Override http request option.
|
|
18813
|
+
* @throws {RequiredError}
|
|
18814
|
+
* @memberof ClustersApi
|
|
18815
|
+
*/
|
|
18816
|
+
public restoreAHibernatedCluster(clusterId: number, options?: RawAxiosRequestConfig) {
|
|
18817
|
+
return ClustersApiFp(this.configuration).restoreAHibernatedCluster(clusterId, options).then((request) => request(this.axios, this.basePath));
|
|
18818
|
+
}
|
|
18819
|
+
|
|
18550
18820
|
/**
|
|
18551
18821
|
*
|
|
18552
18822
|
* @summary Update a node group in a cluster
|
|
@@ -18571,7 +18841,7 @@ export class ClustersApi extends BaseAPI {
|
|
|
18571
18841
|
export const CreditApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
18572
18842
|
return {
|
|
18573
18843
|
/**
|
|
18574
|
-
* Retrieves the current credit balance for your [**organization**](/docs/rbac/organization). Ensuring a positive credit balance allows you to create resources. However, for prepaid accounts, if the credit balance falls below $0, all associated resources will be temporarily suspended until a [**payment**](/docs/api-reference/billing-resources/create-payment) is made. For additional information, [**click here**](
|
|
18844
|
+
* Retrieves the current credit balance for your [**organization**](/docs/rbac/organization). Ensuring a positive credit balance allows you to create resources. However, for prepaid accounts, if the credit balance falls below $0, all associated resources will be temporarily suspended until a [**payment**](/docs/api-reference/billing-resources/create-payment) is made. For additional information, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/billing-resources/retrieve-credit-balance/).
|
|
18575
18845
|
* @summary GET: View credit and threshold
|
|
18576
18846
|
* @param {*} [options] Override http request option.
|
|
18577
18847
|
* @throws {RequiredError}
|
|
@@ -18614,7 +18884,7 @@ export const CreditApiFp = function(configuration?: Configuration) {
|
|
|
18614
18884
|
const localVarAxiosParamCreator = CreditApiAxiosParamCreator(configuration)
|
|
18615
18885
|
return {
|
|
18616
18886
|
/**
|
|
18617
|
-
* Retrieves the current credit balance for your [**organization**](/docs/rbac/organization). Ensuring a positive credit balance allows you to create resources. However, for prepaid accounts, if the credit balance falls below $0, all associated resources will be temporarily suspended until a [**payment**](/docs/api-reference/billing-resources/create-payment) is made. For additional information, [**click here**](
|
|
18887
|
+
* Retrieves the current credit balance for your [**organization**](/docs/rbac/organization). Ensuring a positive credit balance allows you to create resources. However, for prepaid accounts, if the credit balance falls below $0, all associated resources will be temporarily suspended until a [**payment**](/docs/api-reference/billing-resources/create-payment) is made. For additional information, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/billing-resources/retrieve-credit-balance/).
|
|
18618
18888
|
* @summary GET: View credit and threshold
|
|
18619
18889
|
* @param {*} [options] Override http request option.
|
|
18620
18890
|
* @throws {RequiredError}
|
|
@@ -18636,7 +18906,7 @@ export const CreditApiFactory = function (configuration?: Configuration, basePat
|
|
|
18636
18906
|
const localVarFp = CreditApiFp(configuration)
|
|
18637
18907
|
return {
|
|
18638
18908
|
/**
|
|
18639
|
-
* Retrieves the current credit balance for your [**organization**](/docs/rbac/organization). Ensuring a positive credit balance allows you to create resources. However, for prepaid accounts, if the credit balance falls below $0, all associated resources will be temporarily suspended until a [**payment**](/docs/api-reference/billing-resources/create-payment) is made. For additional information, [**click here**](
|
|
18909
|
+
* Retrieves the current credit balance for your [**organization**](/docs/rbac/organization). Ensuring a positive credit balance allows you to create resources. However, for prepaid accounts, if the credit balance falls below $0, all associated resources will be temporarily suspended until a [**payment**](/docs/api-reference/billing-resources/create-payment) is made. For additional information, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/billing-resources/retrieve-credit-balance/).
|
|
18640
18910
|
* @summary GET: View credit and threshold
|
|
18641
18911
|
* @param {*} [options] Override http request option.
|
|
18642
18912
|
* @throws {RequiredError}
|
|
@@ -18655,7 +18925,7 @@ export const CreditApiFactory = function (configuration?: Configuration, basePat
|
|
|
18655
18925
|
*/
|
|
18656
18926
|
export class CreditApi extends BaseAPI {
|
|
18657
18927
|
/**
|
|
18658
|
-
* Retrieves the current credit balance for your [**organization**](/docs/rbac/organization). Ensuring a positive credit balance allows you to create resources. However, for prepaid accounts, if the credit balance falls below $0, all associated resources will be temporarily suspended until a [**payment**](/docs/api-reference/billing-resources/create-payment) is made. For additional information, [**click here**](
|
|
18928
|
+
* Retrieves the current credit balance for your [**organization**](/docs/rbac/organization). Ensuring a positive credit balance allows you to create resources. However, for prepaid accounts, if the credit balance falls below $0, all associated resources will be temporarily suspended until a [**payment**](/docs/api-reference/billing-resources/create-payment) is made. For additional information, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/billing-resources/retrieve-credit-balance/).
|
|
18659
18929
|
* @summary GET: View credit and threshold
|
|
18660
18930
|
* @param {*} [options] Override http request option.
|
|
18661
18931
|
* @throws {RequiredError}
|
|
@@ -22668,7 +22938,7 @@ export class PartnerConfigApi extends BaseAPI {
|
|
|
22668
22938
|
export const PaymentApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
22669
22939
|
return {
|
|
22670
22940
|
/**
|
|
22671
|
-
* Retrieve the
|
|
22941
|
+
* Retrieve the URL of the Stripe-hosted invoice page for a specific payment. The hosted URL is refreshed by Stripe on every retrieval, so it never expires.
|
|
22672
22942
|
* @summary Retrieve Payment Receipt
|
|
22673
22943
|
* @param {string} paymentId
|
|
22674
22944
|
* @param {*} [options] Override http request option.
|
|
@@ -22705,7 +22975,7 @@ export const PaymentApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
22705
22975
|
};
|
|
22706
22976
|
},
|
|
22707
22977
|
/**
|
|
22708
|
-
* Creates a payment for a specified amount, adding credit to the balance of your [**organization**](/docs/rbac/organization). Include the `amount` in the body of the request to make a payment for the specified value in dollars. View a history of past payments by calling the [**Retrieve Payment History**](/docs/api-reference/billing-resources/retrieve-payment-history) API. For additional information [**click here**](
|
|
22978
|
+
* Creates a payment for a specified amount, adding credit to the balance of your [**organization**](/docs/rbac/organization). Include the `amount` in the body of the request to make a payment for the specified value in dollars. View a history of past payments by calling the [**Retrieve Payment History**](/docs/api-reference/billing-resources/retrieve-payment-history) API. For additional information [**click here**](https://docs.hyperstack.cloud/docs/api-reference/billing-resources/create-payment).
|
|
22709
22979
|
* @summary POST: Initiate payment
|
|
22710
22980
|
* @param {PaymentInitiatePayload} payload
|
|
22711
22981
|
* @param {*} [options] Override http request option.
|
|
@@ -22744,7 +23014,7 @@ export const PaymentApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
22744
23014
|
};
|
|
22745
23015
|
},
|
|
22746
23016
|
/**
|
|
22747
|
-
* Retrieves a list of all payments made within your [**organization**](/docs/rbac/organization) and their details, including the amount, payment status, and more. For additional information [**click here**](
|
|
23017
|
+
* Retrieves a list of all payments made within your [**organization**](/docs/rbac/organization) and their details, including the amount, payment status, and more. For additional information [**click here**](https://docs.hyperstack.cloud/docs/api-reference/billing-resources/retrieve-payment-history/).
|
|
22748
23018
|
* @summary GET: View payment details
|
|
22749
23019
|
* @param {*} [options] Override http request option.
|
|
22750
23020
|
* @throws {RequiredError}
|
|
@@ -22787,20 +23057,20 @@ export const PaymentApiFp = function(configuration?: Configuration) {
|
|
|
22787
23057
|
const localVarAxiosParamCreator = PaymentApiAxiosParamCreator(configuration)
|
|
22788
23058
|
return {
|
|
22789
23059
|
/**
|
|
22790
|
-
* Retrieve the
|
|
23060
|
+
* Retrieve the URL of the Stripe-hosted invoice page for a specific payment. The hosted URL is refreshed by Stripe on every retrieval, so it never expires.
|
|
22791
23061
|
* @summary Retrieve Payment Receipt
|
|
22792
23062
|
* @param {string} paymentId
|
|
22793
23063
|
* @param {*} [options] Override http request option.
|
|
22794
23064
|
* @throws {RequiredError}
|
|
22795
23065
|
*/
|
|
22796
|
-
async getPaymentReceipt(paymentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
23066
|
+
async getPaymentReceipt(paymentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentReceiptResponse>> {
|
|
22797
23067
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getPaymentReceipt(paymentId, options);
|
|
22798
23068
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
22799
23069
|
const localVarOperationServerBasePath = operationServerMap['PaymentApi.getPaymentReceipt']?.[localVarOperationServerIndex]?.url;
|
|
22800
23070
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
22801
23071
|
},
|
|
22802
23072
|
/**
|
|
22803
|
-
* Creates a payment for a specified amount, adding credit to the balance of your [**organization**](/docs/rbac/organization). Include the `amount` in the body of the request to make a payment for the specified value in dollars. View a history of past payments by calling the [**Retrieve Payment History**](/docs/api-reference/billing-resources/retrieve-payment-history) API. For additional information [**click here**](
|
|
23073
|
+
* Creates a payment for a specified amount, adding credit to the balance of your [**organization**](/docs/rbac/organization). Include the `amount` in the body of the request to make a payment for the specified value in dollars. View a history of past payments by calling the [**Retrieve Payment History**](/docs/api-reference/billing-resources/retrieve-payment-history) API. For additional information [**click here**](https://docs.hyperstack.cloud/docs/api-reference/billing-resources/create-payment).
|
|
22804
23074
|
* @summary POST: Initiate payment
|
|
22805
23075
|
* @param {PaymentInitiatePayload} payload
|
|
22806
23076
|
* @param {*} [options] Override http request option.
|
|
@@ -22813,7 +23083,7 @@ export const PaymentApiFp = function(configuration?: Configuration) {
|
|
|
22813
23083
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
22814
23084
|
},
|
|
22815
23085
|
/**
|
|
22816
|
-
* Retrieves a list of all payments made within your [**organization**](/docs/rbac/organization) and their details, including the amount, payment status, and more. For additional information [**click here**](
|
|
23086
|
+
* Retrieves a list of all payments made within your [**organization**](/docs/rbac/organization) and their details, including the amount, payment status, and more. For additional information [**click here**](https://docs.hyperstack.cloud/docs/api-reference/billing-resources/retrieve-payment-history/).
|
|
22817
23087
|
* @summary GET: View payment details
|
|
22818
23088
|
* @param {*} [options] Override http request option.
|
|
22819
23089
|
* @throws {RequiredError}
|
|
@@ -22835,17 +23105,17 @@ export const PaymentApiFactory = function (configuration?: Configuration, basePa
|
|
|
22835
23105
|
const localVarFp = PaymentApiFp(configuration)
|
|
22836
23106
|
return {
|
|
22837
23107
|
/**
|
|
22838
|
-
* Retrieve the
|
|
23108
|
+
* Retrieve the URL of the Stripe-hosted invoice page for a specific payment. The hosted URL is refreshed by Stripe on every retrieval, so it never expires.
|
|
22839
23109
|
* @summary Retrieve Payment Receipt
|
|
22840
23110
|
* @param {string} paymentId
|
|
22841
23111
|
* @param {*} [options] Override http request option.
|
|
22842
23112
|
* @throws {RequiredError}
|
|
22843
23113
|
*/
|
|
22844
|
-
getPaymentReceipt(paymentId: string, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
23114
|
+
getPaymentReceipt(paymentId: string, options?: RawAxiosRequestConfig): AxiosPromise<PaymentReceiptResponse> {
|
|
22845
23115
|
return localVarFp.getPaymentReceipt(paymentId, options).then((request) => request(axios, basePath));
|
|
22846
23116
|
},
|
|
22847
23117
|
/**
|
|
22848
|
-
* Creates a payment for a specified amount, adding credit to the balance of your [**organization**](/docs/rbac/organization). Include the `amount` in the body of the request to make a payment for the specified value in dollars. View a history of past payments by calling the [**Retrieve Payment History**](/docs/api-reference/billing-resources/retrieve-payment-history) API. For additional information [**click here**](
|
|
23118
|
+
* Creates a payment for a specified amount, adding credit to the balance of your [**organization**](/docs/rbac/organization). Include the `amount` in the body of the request to make a payment for the specified value in dollars. View a history of past payments by calling the [**Retrieve Payment History**](/docs/api-reference/billing-resources/retrieve-payment-history) API. For additional information [**click here**](https://docs.hyperstack.cloud/docs/api-reference/billing-resources/create-payment).
|
|
22849
23119
|
* @summary POST: Initiate payment
|
|
22850
23120
|
* @param {PaymentInitiatePayload} payload
|
|
22851
23121
|
* @param {*} [options] Override http request option.
|
|
@@ -22855,7 +23125,7 @@ export const PaymentApiFactory = function (configuration?: Configuration, basePa
|
|
|
22855
23125
|
return localVarFp.initiatePayment(payload, options).then((request) => request(axios, basePath));
|
|
22856
23126
|
},
|
|
22857
23127
|
/**
|
|
22858
|
-
* Retrieves a list of all payments made within your [**organization**](/docs/rbac/organization) and their details, including the amount, payment status, and more. For additional information [**click here**](
|
|
23128
|
+
* Retrieves a list of all payments made within your [**organization**](/docs/rbac/organization) and their details, including the amount, payment status, and more. For additional information [**click here**](https://docs.hyperstack.cloud/docs/api-reference/billing-resources/retrieve-payment-history/).
|
|
22859
23129
|
* @summary GET: View payment details
|
|
22860
23130
|
* @param {*} [options] Override http request option.
|
|
22861
23131
|
* @throws {RequiredError}
|
|
@@ -22874,7 +23144,7 @@ export const PaymentApiFactory = function (configuration?: Configuration, basePa
|
|
|
22874
23144
|
*/
|
|
22875
23145
|
export class PaymentApi extends BaseAPI {
|
|
22876
23146
|
/**
|
|
22877
|
-
* Retrieve the
|
|
23147
|
+
* Retrieve the URL of the Stripe-hosted invoice page for a specific payment. The hosted URL is refreshed by Stripe on every retrieval, so it never expires.
|
|
22878
23148
|
* @summary Retrieve Payment Receipt
|
|
22879
23149
|
* @param {string} paymentId
|
|
22880
23150
|
* @param {*} [options] Override http request option.
|
|
@@ -22886,7 +23156,7 @@ export class PaymentApi extends BaseAPI {
|
|
|
22886
23156
|
}
|
|
22887
23157
|
|
|
22888
23158
|
/**
|
|
22889
|
-
* Creates a payment for a specified amount, adding credit to the balance of your [**organization**](/docs/rbac/organization). Include the `amount` in the body of the request to make a payment for the specified value in dollars. View a history of past payments by calling the [**Retrieve Payment History**](/docs/api-reference/billing-resources/retrieve-payment-history) API. For additional information [**click here**](
|
|
23159
|
+
* Creates a payment for a specified amount, adding credit to the balance of your [**organization**](/docs/rbac/organization). Include the `amount` in the body of the request to make a payment for the specified value in dollars. View a history of past payments by calling the [**Retrieve Payment History**](/docs/api-reference/billing-resources/retrieve-payment-history) API. For additional information [**click here**](https://docs.hyperstack.cloud/docs/api-reference/billing-resources/create-payment).
|
|
22890
23160
|
* @summary POST: Initiate payment
|
|
22891
23161
|
* @param {PaymentInitiatePayload} payload
|
|
22892
23162
|
* @param {*} [options] Override http request option.
|
|
@@ -22898,7 +23168,7 @@ export class PaymentApi extends BaseAPI {
|
|
|
22898
23168
|
}
|
|
22899
23169
|
|
|
22900
23170
|
/**
|
|
22901
|
-
* Retrieves a list of all payments made within your [**organization**](/docs/rbac/organization) and their details, including the amount, payment status, and more. For additional information [**click here**](
|
|
23171
|
+
* Retrieves a list of all payments made within your [**organization**](/docs/rbac/organization) and their details, including the amount, payment status, and more. For additional information [**click here**](https://docs.hyperstack.cloud/docs/api-reference/billing-resources/retrieve-payment-history/).
|
|
22902
23172
|
* @summary GET: View payment details
|
|
22903
23173
|
* @param {*} [options] Override http request option.
|
|
22904
23174
|
* @throws {RequiredError}
|
|
@@ -29095,3 +29365,107 @@ export class VouchersApi extends BaseAPI {
|
|
|
29095
29365
|
|
|
29096
29366
|
|
|
29097
29367
|
|
|
29368
|
+
/**
|
|
29369
|
+
* ZendeskApi - axios parameter creator
|
|
29370
|
+
* @export
|
|
29371
|
+
*/
|
|
29372
|
+
export const ZendeskApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
29373
|
+
return {
|
|
29374
|
+
/**
|
|
29375
|
+
* Returns a short-lived signed JWT for the currently authenticated user, to be passed to the Zendesk Web Widget\'s loginUser API so chat tickets are attributed to the real user instead of an anonymous \'Web User\'.
|
|
29376
|
+
* @summary Retrieve a Zendesk messaging JWT for the current user
|
|
29377
|
+
* @param {*} [options] Override http request option.
|
|
29378
|
+
* @throws {RequiredError}
|
|
29379
|
+
*/
|
|
29380
|
+
getZendeskMessagingToken: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
29381
|
+
const localVarPath = `/auth/zendesk/messaging-token`;
|
|
29382
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
29383
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
29384
|
+
let baseOptions;
|
|
29385
|
+
if (configuration) {
|
|
29386
|
+
baseOptions = configuration.baseOptions;
|
|
29387
|
+
}
|
|
29388
|
+
|
|
29389
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
29390
|
+
const localVarHeaderParameter = {} as any;
|
|
29391
|
+
const localVarQueryParameter = {} as any;
|
|
29392
|
+
|
|
29393
|
+
// authentication apiKey required
|
|
29394
|
+
await setApiKeyToObject(localVarHeaderParameter, "api_key", configuration)
|
|
29395
|
+
|
|
29396
|
+
|
|
29397
|
+
|
|
29398
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
29399
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
29400
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
29401
|
+
|
|
29402
|
+
return {
|
|
29403
|
+
url: toPathString(localVarUrlObj),
|
|
29404
|
+
options: localVarRequestOptions,
|
|
29405
|
+
};
|
|
29406
|
+
},
|
|
29407
|
+
}
|
|
29408
|
+
};
|
|
29409
|
+
|
|
29410
|
+
/**
|
|
29411
|
+
* ZendeskApi - functional programming interface
|
|
29412
|
+
* @export
|
|
29413
|
+
*/
|
|
29414
|
+
export const ZendeskApiFp = function(configuration?: Configuration) {
|
|
29415
|
+
const localVarAxiosParamCreator = ZendeskApiAxiosParamCreator(configuration)
|
|
29416
|
+
return {
|
|
29417
|
+
/**
|
|
29418
|
+
* Returns a short-lived signed JWT for the currently authenticated user, to be passed to the Zendesk Web Widget\'s loginUser API so chat tickets are attributed to the real user instead of an anonymous \'Web User\'.
|
|
29419
|
+
* @summary Retrieve a Zendesk messaging JWT for the current user
|
|
29420
|
+
* @param {*} [options] Override http request option.
|
|
29421
|
+
* @throws {RequiredError}
|
|
29422
|
+
*/
|
|
29423
|
+
async getZendeskMessagingToken(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ZendeskMessagingToken>> {
|
|
29424
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getZendeskMessagingToken(options);
|
|
29425
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
29426
|
+
const localVarOperationServerBasePath = operationServerMap['ZendeskApi.getZendeskMessagingToken']?.[localVarOperationServerIndex]?.url;
|
|
29427
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
29428
|
+
},
|
|
29429
|
+
}
|
|
29430
|
+
};
|
|
29431
|
+
|
|
29432
|
+
/**
|
|
29433
|
+
* ZendeskApi - factory interface
|
|
29434
|
+
* @export
|
|
29435
|
+
*/
|
|
29436
|
+
export const ZendeskApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
29437
|
+
const localVarFp = ZendeskApiFp(configuration)
|
|
29438
|
+
return {
|
|
29439
|
+
/**
|
|
29440
|
+
* Returns a short-lived signed JWT for the currently authenticated user, to be passed to the Zendesk Web Widget\'s loginUser API so chat tickets are attributed to the real user instead of an anonymous \'Web User\'.
|
|
29441
|
+
* @summary Retrieve a Zendesk messaging JWT for the current user
|
|
29442
|
+
* @param {*} [options] Override http request option.
|
|
29443
|
+
* @throws {RequiredError}
|
|
29444
|
+
*/
|
|
29445
|
+
getZendeskMessagingToken(options?: RawAxiosRequestConfig): AxiosPromise<ZendeskMessagingToken> {
|
|
29446
|
+
return localVarFp.getZendeskMessagingToken(options).then((request) => request(axios, basePath));
|
|
29447
|
+
},
|
|
29448
|
+
};
|
|
29449
|
+
};
|
|
29450
|
+
|
|
29451
|
+
/**
|
|
29452
|
+
* ZendeskApi - object-oriented interface
|
|
29453
|
+
* @export
|
|
29454
|
+
* @class ZendeskApi
|
|
29455
|
+
* @extends {BaseAPI}
|
|
29456
|
+
*/
|
|
29457
|
+
export class ZendeskApi extends BaseAPI {
|
|
29458
|
+
/**
|
|
29459
|
+
* Returns a short-lived signed JWT for the currently authenticated user, to be passed to the Zendesk Web Widget\'s loginUser API so chat tickets are attributed to the real user instead of an anonymous \'Web User\'.
|
|
29460
|
+
* @summary Retrieve a Zendesk messaging JWT for the current user
|
|
29461
|
+
* @param {*} [options] Override http request option.
|
|
29462
|
+
* @throws {RequiredError}
|
|
29463
|
+
* @memberof ZendeskApi
|
|
29464
|
+
*/
|
|
29465
|
+
public getZendeskMessagingToken(options?: RawAxiosRequestConfig) {
|
|
29466
|
+
return ZendeskApiFp(this.configuration).getZendeskMessagingToken(options).then((request) => request(this.axios, this.basePath));
|
|
29467
|
+
}
|
|
29468
|
+
}
|
|
29469
|
+
|
|
29470
|
+
|
|
29471
|
+
|