@nexgencloud/hyperstack-sdk-typescript 1.55.6-alpha → 1.55.10-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 +59 -34
- package/dist/api.d.ts +60 -35
- package/dist/api.js +32 -32
- package/dist/esm/api.d.ts +60 -35
- package/dist/esm/api.js +32 -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/git_push.sh +0 -57
package/dist/api.d.ts
CHANGED
|
@@ -6845,6 +6845,31 @@ export interface PaymentInitiateResponse {
|
|
|
6845
6845
|
*/
|
|
6846
6846
|
'status'?: boolean;
|
|
6847
6847
|
}
|
|
6848
|
+
/**
|
|
6849
|
+
*
|
|
6850
|
+
* @export
|
|
6851
|
+
* @interface PaymentReceiptResponse
|
|
6852
|
+
*/
|
|
6853
|
+
export interface PaymentReceiptResponse {
|
|
6854
|
+
/**
|
|
6855
|
+
*
|
|
6856
|
+
* @type {string}
|
|
6857
|
+
* @memberof PaymentReceiptResponse
|
|
6858
|
+
*/
|
|
6859
|
+
'message'?: string;
|
|
6860
|
+
/**
|
|
6861
|
+
*
|
|
6862
|
+
* @type {string}
|
|
6863
|
+
* @memberof PaymentReceiptResponse
|
|
6864
|
+
*/
|
|
6865
|
+
'receipt_url'?: string;
|
|
6866
|
+
/**
|
|
6867
|
+
*
|
|
6868
|
+
* @type {boolean}
|
|
6869
|
+
* @memberof PaymentReceiptResponse
|
|
6870
|
+
*/
|
|
6871
|
+
'status'?: boolean;
|
|
6872
|
+
}
|
|
6848
6873
|
/**
|
|
6849
6874
|
*
|
|
6850
6875
|
* @export
|
|
@@ -10731,7 +10756,7 @@ export declare class AccessKeysApi extends BaseAPI {
|
|
|
10731
10756
|
*/
|
|
10732
10757
|
export declare const AliveApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
10733
10758
|
/**
|
|
10734
|
-
* 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**](
|
|
10759
|
+
* 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/).
|
|
10735
10760
|
* @summary GET: Alive
|
|
10736
10761
|
* @param {*} [options] Override http request option.
|
|
10737
10762
|
* @throws {RequiredError}
|
|
@@ -10750,7 +10775,7 @@ export declare const AliveApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
10750
10775
|
*/
|
|
10751
10776
|
export declare const AliveApiFp: (configuration?: Configuration) => {
|
|
10752
10777
|
/**
|
|
10753
|
-
* 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**](
|
|
10778
|
+
* 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/).
|
|
10754
10779
|
* @summary GET: Alive
|
|
10755
10780
|
* @param {*} [options] Override http request option.
|
|
10756
10781
|
* @throws {RequiredError}
|
|
@@ -10769,7 +10794,7 @@ export declare const AliveApiFp: (configuration?: Configuration) => {
|
|
|
10769
10794
|
*/
|
|
10770
10795
|
export declare const AliveApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
10771
10796
|
/**
|
|
10772
|
-
* 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**](
|
|
10797
|
+
* 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/).
|
|
10773
10798
|
* @summary GET: Alive
|
|
10774
10799
|
* @param {*} [options] Override http request option.
|
|
10775
10800
|
* @throws {RequiredError}
|
|
@@ -10790,7 +10815,7 @@ export declare const AliveApiFactory: (configuration?: Configuration, basePath?:
|
|
|
10790
10815
|
*/
|
|
10791
10816
|
export declare class AliveApi extends BaseAPI {
|
|
10792
10817
|
/**
|
|
10793
|
-
* 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**](
|
|
10818
|
+
* 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/).
|
|
10794
10819
|
* @summary GET: Alive
|
|
10795
10820
|
* @param {*} [options] Override http request option.
|
|
10796
10821
|
* @throws {RequiredError}
|
|
@@ -11229,7 +11254,7 @@ export declare const AutoTopupApiAxiosParamCreator: (configuration?: Configurati
|
|
|
11229
11254
|
*/
|
|
11230
11255
|
getAutoTopUp: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11231
11256
|
/**
|
|
11232
|
-
* 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**](
|
|
11257
|
+
* 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/).
|
|
11233
11258
|
* @summary Get auto top-up status and configuration
|
|
11234
11259
|
* @param {*} [options] Override http request option.
|
|
11235
11260
|
* @throws {RequiredError}
|
|
@@ -11272,7 +11297,7 @@ export declare const AutoTopupApiFp: (configuration?: Configuration) => {
|
|
|
11272
11297
|
*/
|
|
11273
11298
|
getAutoTopUp(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAutoTopupResponse>>;
|
|
11274
11299
|
/**
|
|
11275
|
-
* 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**](
|
|
11300
|
+
* 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/).
|
|
11276
11301
|
* @summary Get auto top-up status and configuration
|
|
11277
11302
|
* @param {*} [options] Override http request option.
|
|
11278
11303
|
* @throws {RequiredError}
|
|
@@ -11315,7 +11340,7 @@ export declare const AutoTopupApiFactory: (configuration?: Configuration, basePa
|
|
|
11315
11340
|
*/
|
|
11316
11341
|
getAutoTopUp(options?: RawAxiosRequestConfig): AxiosPromise<GetAutoTopupResponse>;
|
|
11317
11342
|
/**
|
|
11318
|
-
* 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**](
|
|
11343
|
+
* 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/).
|
|
11319
11344
|
* @summary Get auto top-up status and configuration
|
|
11320
11345
|
* @param {*} [options] Override http request option.
|
|
11321
11346
|
* @throws {RequiredError}
|
|
@@ -11363,7 +11388,7 @@ export declare class AutoTopupApi extends BaseAPI {
|
|
|
11363
11388
|
*/
|
|
11364
11389
|
getAutoTopUp(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAutoTopupResponse, any, {}, any>>;
|
|
11365
11390
|
/**
|
|
11366
|
-
* 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**](
|
|
11391
|
+
* 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/).
|
|
11367
11392
|
* @summary Get auto top-up status and configuration
|
|
11368
11393
|
* @param {*} [options] Override http request option.
|
|
11369
11394
|
* @throws {RequiredError}
|
|
@@ -11631,7 +11656,7 @@ export declare const BillingApiAxiosParamCreator: (configuration?: Configuration
|
|
|
11631
11656
|
*/
|
|
11632
11657
|
getImageGenerationHistoryForResource: (resourceId: number, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11633
11658
|
/**
|
|
11634
|
-
* 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**](
|
|
11659
|
+
* 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/)
|
|
11635
11660
|
* @summary GET: Last Day Cost
|
|
11636
11661
|
* @param {*} [options] Override http request option.
|
|
11637
11662
|
* @throws {RequiredError}
|
|
@@ -11727,7 +11752,7 @@ export declare const BillingApiAxiosParamCreator: (configuration?: Configuration
|
|
|
11727
11752
|
*/
|
|
11728
11753
|
getSnapshotBillingHistoryGraph: (snapshotId: number, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11729
11754
|
/**
|
|
11730
|
-
* 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**](
|
|
11755
|
+
* 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/)
|
|
11731
11756
|
* @summary GET: Billing usage
|
|
11732
11757
|
* @param {string} [deleted] `true` will return inactive resources and `false` will return active resources. By defualt(`deleted=false`)
|
|
11733
11758
|
* @param {string} [environment] Filter resources by environment ID or Name
|
|
@@ -12045,7 +12070,7 @@ export declare const BillingApiFp: (configuration?: Configuration) => {
|
|
|
12045
12070
|
*/
|
|
12046
12071
|
getImageGenerationHistoryForResource(resourceId: number, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImageGenerationBillingHistoryDetailsResponseSchema>>;
|
|
12047
12072
|
/**
|
|
12048
|
-
* 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**](
|
|
12073
|
+
* 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/)
|
|
12049
12074
|
* @summary GET: Last Day Cost
|
|
12050
12075
|
* @param {*} [options] Override http request option.
|
|
12051
12076
|
* @throws {RequiredError}
|
|
@@ -12141,7 +12166,7 @@ export declare const BillingApiFp: (configuration?: Configuration) => {
|
|
|
12141
12166
|
*/
|
|
12142
12167
|
getSnapshotBillingHistoryGraph(snapshotId: number, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResourceLevelVolumeGraphBillingDetailsResponseModel>>;
|
|
12143
12168
|
/**
|
|
12144
|
-
* 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**](
|
|
12169
|
+
* 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/)
|
|
12145
12170
|
* @summary GET: Billing usage
|
|
12146
12171
|
* @param {string} [deleted] `true` will return inactive resources and `false` will return active resources. By defualt(`deleted=false`)
|
|
12147
12172
|
* @param {string} [environment] Filter resources by environment ID or Name
|
|
@@ -12459,7 +12484,7 @@ export declare const BillingApiFactory: (configuration?: Configuration, basePath
|
|
|
12459
12484
|
*/
|
|
12460
12485
|
getImageGenerationHistoryForResource(resourceId: number, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): AxiosPromise<ImageGenerationBillingHistoryDetailsResponseSchema>;
|
|
12461
12486
|
/**
|
|
12462
|
-
* 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**](
|
|
12487
|
+
* 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/)
|
|
12463
12488
|
* @summary GET: Last Day Cost
|
|
12464
12489
|
* @param {*} [options] Override http request option.
|
|
12465
12490
|
* @throws {RequiredError}
|
|
@@ -12555,7 +12580,7 @@ export declare const BillingApiFactory: (configuration?: Configuration, basePath
|
|
|
12555
12580
|
*/
|
|
12556
12581
|
getSnapshotBillingHistoryGraph(snapshotId: number, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): AxiosPromise<ResourceLevelVolumeGraphBillingDetailsResponseModel>;
|
|
12557
12582
|
/**
|
|
12558
|
-
* 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**](
|
|
12583
|
+
* 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/)
|
|
12559
12584
|
* @summary GET: Billing usage
|
|
12560
12585
|
* @param {string} [deleted] `true` will return inactive resources and `false` will return active resources. By defualt(`deleted=false`)
|
|
12561
12586
|
* @param {string} [environment] Filter resources by environment ID or Name
|
|
@@ -12887,7 +12912,7 @@ export declare class BillingApi extends BaseAPI {
|
|
|
12887
12912
|
*/
|
|
12888
12913
|
getImageGenerationHistoryForResource(resourceId: number, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImageGenerationBillingHistoryDetailsResponseSchema, any, {}, any>>;
|
|
12889
12914
|
/**
|
|
12890
|
-
* 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**](
|
|
12915
|
+
* 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/)
|
|
12891
12916
|
* @summary GET: Last Day Cost
|
|
12892
12917
|
* @param {*} [options] Override http request option.
|
|
12893
12918
|
* @throws {RequiredError}
|
|
@@ -12993,7 +13018,7 @@ export declare class BillingApi extends BaseAPI {
|
|
|
12993
13018
|
*/
|
|
12994
13019
|
getSnapshotBillingHistoryGraph(snapshotId: number, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ResourceLevelVolumeGraphBillingDetailsResponseModel, any, {}, any>>;
|
|
12995
13020
|
/**
|
|
12996
|
-
* 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**](
|
|
13021
|
+
* 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/)
|
|
12997
13022
|
* @summary GET: Billing usage
|
|
12998
13023
|
* @param {string} [deleted] `true` will return inactive resources and `false` will return active resources. By defualt(`deleted=false`)
|
|
12999
13024
|
* @param {string} [environment] Filter resources by environment ID or Name
|
|
@@ -14327,7 +14352,7 @@ export declare class ClustersApi extends BaseAPI {
|
|
|
14327
14352
|
*/
|
|
14328
14353
|
export declare const CreditApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
14329
14354
|
/**
|
|
14330
|
-
* 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**](
|
|
14355
|
+
* 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/).
|
|
14331
14356
|
* @summary GET: View credit and threshold
|
|
14332
14357
|
* @param {*} [options] Override http request option.
|
|
14333
14358
|
* @throws {RequiredError}
|
|
@@ -14340,7 +14365,7 @@ export declare const CreditApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
14340
14365
|
*/
|
|
14341
14366
|
export declare const CreditApiFp: (configuration?: Configuration) => {
|
|
14342
14367
|
/**
|
|
14343
|
-
* 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**](
|
|
14368
|
+
* 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/).
|
|
14344
14369
|
* @summary GET: View credit and threshold
|
|
14345
14370
|
* @param {*} [options] Override http request option.
|
|
14346
14371
|
* @throws {RequiredError}
|
|
@@ -14353,7 +14378,7 @@ export declare const CreditApiFp: (configuration?: Configuration) => {
|
|
|
14353
14378
|
*/
|
|
14354
14379
|
export declare const CreditApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
14355
14380
|
/**
|
|
14356
|
-
* 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**](
|
|
14381
|
+
* 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/).
|
|
14357
14382
|
* @summary GET: View credit and threshold
|
|
14358
14383
|
* @param {*} [options] Override http request option.
|
|
14359
14384
|
* @throws {RequiredError}
|
|
@@ -14368,7 +14393,7 @@ export declare const CreditApiFactory: (configuration?: Configuration, basePath?
|
|
|
14368
14393
|
*/
|
|
14369
14394
|
export declare class CreditApi extends BaseAPI {
|
|
14370
14395
|
/**
|
|
14371
|
-
* 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**](
|
|
14396
|
+
* 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/).
|
|
14372
14397
|
* @summary GET: View credit and threshold
|
|
14373
14398
|
* @param {*} [options] Override http request option.
|
|
14374
14399
|
* @throws {RequiredError}
|
|
@@ -16327,7 +16352,7 @@ export declare class PartnerConfigApi extends BaseAPI {
|
|
|
16327
16352
|
*/
|
|
16328
16353
|
export declare const PaymentApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
16329
16354
|
/**
|
|
16330
|
-
* Retrieve the
|
|
16355
|
+
* 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.
|
|
16331
16356
|
* @summary Retrieve Payment Receipt
|
|
16332
16357
|
* @param {string} paymentId
|
|
16333
16358
|
* @param {*} [options] Override http request option.
|
|
@@ -16335,7 +16360,7 @@ export declare const PaymentApiAxiosParamCreator: (configuration?: Configuration
|
|
|
16335
16360
|
*/
|
|
16336
16361
|
getPaymentReceipt: (paymentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16337
16362
|
/**
|
|
16338
|
-
* 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**](
|
|
16363
|
+
* 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).
|
|
16339
16364
|
* @summary POST: Initiate payment
|
|
16340
16365
|
* @param {PaymentInitiatePayload} payload
|
|
16341
16366
|
* @param {*} [options] Override http request option.
|
|
@@ -16343,7 +16368,7 @@ export declare const PaymentApiAxiosParamCreator: (configuration?: Configuration
|
|
|
16343
16368
|
*/
|
|
16344
16369
|
initiatePayment: (payload: PaymentInitiatePayload, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16345
16370
|
/**
|
|
16346
|
-
* 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**](
|
|
16371
|
+
* 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/).
|
|
16347
16372
|
* @summary GET: View payment details
|
|
16348
16373
|
* @param {*} [options] Override http request option.
|
|
16349
16374
|
* @throws {RequiredError}
|
|
@@ -16356,15 +16381,15 @@ export declare const PaymentApiAxiosParamCreator: (configuration?: Configuration
|
|
|
16356
16381
|
*/
|
|
16357
16382
|
export declare const PaymentApiFp: (configuration?: Configuration) => {
|
|
16358
16383
|
/**
|
|
16359
|
-
* Retrieve the
|
|
16384
|
+
* 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.
|
|
16360
16385
|
* @summary Retrieve Payment Receipt
|
|
16361
16386
|
* @param {string} paymentId
|
|
16362
16387
|
* @param {*} [options] Override http request option.
|
|
16363
16388
|
* @throws {RequiredError}
|
|
16364
16389
|
*/
|
|
16365
|
-
getPaymentReceipt(paymentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
16390
|
+
getPaymentReceipt(paymentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentReceiptResponse>>;
|
|
16366
16391
|
/**
|
|
16367
|
-
* 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**](
|
|
16392
|
+
* 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).
|
|
16368
16393
|
* @summary POST: Initiate payment
|
|
16369
16394
|
* @param {PaymentInitiatePayload} payload
|
|
16370
16395
|
* @param {*} [options] Override http request option.
|
|
@@ -16372,7 +16397,7 @@ export declare const PaymentApiFp: (configuration?: Configuration) => {
|
|
|
16372
16397
|
*/
|
|
16373
16398
|
initiatePayment(payload: PaymentInitiatePayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentInitiateResponse>>;
|
|
16374
16399
|
/**
|
|
16375
|
-
* 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**](
|
|
16400
|
+
* 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/).
|
|
16376
16401
|
* @summary GET: View payment details
|
|
16377
16402
|
* @param {*} [options] Override http request option.
|
|
16378
16403
|
* @throws {RequiredError}
|
|
@@ -16385,15 +16410,15 @@ export declare const PaymentApiFp: (configuration?: Configuration) => {
|
|
|
16385
16410
|
*/
|
|
16386
16411
|
export declare const PaymentApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
16387
16412
|
/**
|
|
16388
|
-
* Retrieve the
|
|
16413
|
+
* 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.
|
|
16389
16414
|
* @summary Retrieve Payment Receipt
|
|
16390
16415
|
* @param {string} paymentId
|
|
16391
16416
|
* @param {*} [options] Override http request option.
|
|
16392
16417
|
* @throws {RequiredError}
|
|
16393
16418
|
*/
|
|
16394
|
-
getPaymentReceipt(paymentId: string, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
16419
|
+
getPaymentReceipt(paymentId: string, options?: RawAxiosRequestConfig): AxiosPromise<PaymentReceiptResponse>;
|
|
16395
16420
|
/**
|
|
16396
|
-
* 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**](
|
|
16421
|
+
* 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).
|
|
16397
16422
|
* @summary POST: Initiate payment
|
|
16398
16423
|
* @param {PaymentInitiatePayload} payload
|
|
16399
16424
|
* @param {*} [options] Override http request option.
|
|
@@ -16401,7 +16426,7 @@ export declare const PaymentApiFactory: (configuration?: Configuration, basePath
|
|
|
16401
16426
|
*/
|
|
16402
16427
|
initiatePayment(payload: PaymentInitiatePayload, options?: RawAxiosRequestConfig): AxiosPromise<PaymentInitiateResponse>;
|
|
16403
16428
|
/**
|
|
16404
|
-
* 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**](
|
|
16429
|
+
* 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/).
|
|
16405
16430
|
* @summary GET: View payment details
|
|
16406
16431
|
* @param {*} [options] Override http request option.
|
|
16407
16432
|
* @throws {RequiredError}
|
|
@@ -16416,16 +16441,16 @@ export declare const PaymentApiFactory: (configuration?: Configuration, basePath
|
|
|
16416
16441
|
*/
|
|
16417
16442
|
export declare class PaymentApi extends BaseAPI {
|
|
16418
16443
|
/**
|
|
16419
|
-
* Retrieve the
|
|
16444
|
+
* 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.
|
|
16420
16445
|
* @summary Retrieve Payment Receipt
|
|
16421
16446
|
* @param {string} paymentId
|
|
16422
16447
|
* @param {*} [options] Override http request option.
|
|
16423
16448
|
* @throws {RequiredError}
|
|
16424
16449
|
* @memberof PaymentApi
|
|
16425
16450
|
*/
|
|
16426
|
-
getPaymentReceipt(paymentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
16451
|
+
getPaymentReceipt(paymentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentReceiptResponse, any, {}, any>>;
|
|
16427
16452
|
/**
|
|
16428
|
-
* 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**](
|
|
16453
|
+
* 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).
|
|
16429
16454
|
* @summary POST: Initiate payment
|
|
16430
16455
|
* @param {PaymentInitiatePayload} payload
|
|
16431
16456
|
* @param {*} [options] Override http request option.
|
|
@@ -16434,7 +16459,7 @@ export declare class PaymentApi extends BaseAPI {
|
|
|
16434
16459
|
*/
|
|
16435
16460
|
initiatePayment(payload: PaymentInitiatePayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentInitiateResponse, any, {}, any>>;
|
|
16436
16461
|
/**
|
|
16437
|
-
* 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**](
|
|
16462
|
+
* 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/).
|
|
16438
16463
|
* @summary GET: View payment details
|
|
16439
16464
|
* @param {*} [options] Override http request option.
|
|
16440
16465
|
* @throws {RequiredError}
|