@nexgencloud/hyperstack-sdk-typescript 1.55.7-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/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @nexgencloud/hyperstack-sdk-typescript@v1.55.
|
|
1
|
+
## @nexgencloud/hyperstack-sdk-typescript@v1.55.10-alpha
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @nexgencloud/hyperstack-sdk-typescript@v1.55.
|
|
39
|
+
npm install @nexgencloud/hyperstack-sdk-typescript@v1.55.10-alpha --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
package/api.ts
CHANGED
|
@@ -6895,6 +6895,31 @@ export interface PaymentInitiateResponse {
|
|
|
6895
6895
|
*/
|
|
6896
6896
|
'status'?: boolean;
|
|
6897
6897
|
}
|
|
6898
|
+
/**
|
|
6899
|
+
*
|
|
6900
|
+
* @export
|
|
6901
|
+
* @interface PaymentReceiptResponse
|
|
6902
|
+
*/
|
|
6903
|
+
export interface PaymentReceiptResponse {
|
|
6904
|
+
/**
|
|
6905
|
+
*
|
|
6906
|
+
* @type {string}
|
|
6907
|
+
* @memberof PaymentReceiptResponse
|
|
6908
|
+
*/
|
|
6909
|
+
'message'?: string;
|
|
6910
|
+
/**
|
|
6911
|
+
*
|
|
6912
|
+
* @type {string}
|
|
6913
|
+
* @memberof PaymentReceiptResponse
|
|
6914
|
+
*/
|
|
6915
|
+
'receipt_url'?: string;
|
|
6916
|
+
/**
|
|
6917
|
+
*
|
|
6918
|
+
* @type {boolean}
|
|
6919
|
+
* @memberof PaymentReceiptResponse
|
|
6920
|
+
*/
|
|
6921
|
+
'status'?: boolean;
|
|
6922
|
+
}
|
|
6898
6923
|
/**
|
|
6899
6924
|
*
|
|
6900
6925
|
* @export
|
|
@@ -10934,7 +10959,7 @@ export class AccessKeysApi extends BaseAPI {
|
|
|
10934
10959
|
export const AliveApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
10935
10960
|
return {
|
|
10936
10961
|
/**
|
|
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**](
|
|
10962
|
+
* 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
10963
|
* @summary GET: Alive
|
|
10939
10964
|
* @param {*} [options] Override http request option.
|
|
10940
10965
|
* @throws {RequiredError}
|
|
@@ -11009,7 +11034,7 @@ export const AliveApiFp = function(configuration?: Configuration) {
|
|
|
11009
11034
|
const localVarAxiosParamCreator = AliveApiAxiosParamCreator(configuration)
|
|
11010
11035
|
return {
|
|
11011
11036
|
/**
|
|
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**](
|
|
11037
|
+
* 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
11038
|
* @summary GET: Alive
|
|
11014
11039
|
* @param {*} [options] Override http request option.
|
|
11015
11040
|
* @throws {RequiredError}
|
|
@@ -11042,7 +11067,7 @@ export const AliveApiFactory = function (configuration?: Configuration, basePath
|
|
|
11042
11067
|
const localVarFp = AliveApiFp(configuration)
|
|
11043
11068
|
return {
|
|
11044
11069
|
/**
|
|
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**](
|
|
11070
|
+
* 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
11071
|
* @summary GET: Alive
|
|
11047
11072
|
* @param {*} [options] Override http request option.
|
|
11048
11073
|
* @throws {RequiredError}
|
|
@@ -11069,7 +11094,7 @@ export const AliveApiFactory = function (configuration?: Configuration, basePath
|
|
|
11069
11094
|
*/
|
|
11070
11095
|
export class AliveApi extends BaseAPI {
|
|
11071
11096
|
/**
|
|
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**](
|
|
11097
|
+
* 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
11098
|
* @summary GET: Alive
|
|
11074
11099
|
* @param {*} [options] Override http request option.
|
|
11075
11100
|
* @throws {RequiredError}
|
|
@@ -12029,7 +12054,7 @@ export const AutoTopupApiAxiosParamCreator = function (configuration?: Configura
|
|
|
12029
12054
|
};
|
|
12030
12055
|
},
|
|
12031
12056
|
/**
|
|
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**](
|
|
12057
|
+
* 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
12058
|
* @summary Get auto top-up status and configuration
|
|
12034
12059
|
* @param {*} [options] Override http request option.
|
|
12035
12060
|
* @throws {RequiredError}
|
|
@@ -12148,7 +12173,7 @@ export const AutoTopupApiFp = function(configuration?: Configuration) {
|
|
|
12148
12173
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12149
12174
|
},
|
|
12150
12175
|
/**
|
|
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**](
|
|
12176
|
+
* 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
12177
|
* @summary Get auto top-up status and configuration
|
|
12153
12178
|
* @param {*} [options] Override http request option.
|
|
12154
12179
|
* @throws {RequiredError}
|
|
@@ -12211,7 +12236,7 @@ export const AutoTopupApiFactory = function (configuration?: Configuration, base
|
|
|
12211
12236
|
return localVarFp.getAutoTopUp(options).then((request) => request(axios, basePath));
|
|
12212
12237
|
},
|
|
12213
12238
|
/**
|
|
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**](
|
|
12239
|
+
* 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
12240
|
* @summary Get auto top-up status and configuration
|
|
12216
12241
|
* @param {*} [options] Override http request option.
|
|
12217
12242
|
* @throws {RequiredError}
|
|
@@ -12274,7 +12299,7 @@ export class AutoTopupApi extends BaseAPI {
|
|
|
12274
12299
|
}
|
|
12275
12300
|
|
|
12276
12301
|
/**
|
|
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**](
|
|
12302
|
+
* 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
12303
|
* @summary Get auto top-up status and configuration
|
|
12279
12304
|
* @param {*} [options] Override http request option.
|
|
12280
12305
|
* @throws {RequiredError}
|
|
@@ -13151,7 +13176,7 @@ export const BillingApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
13151
13176
|
};
|
|
13152
13177
|
},
|
|
13153
13178
|
/**
|
|
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**](
|
|
13179
|
+
* 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
13180
|
* @summary GET: Last Day Cost
|
|
13156
13181
|
* @param {*} [options] Override http request option.
|
|
13157
13182
|
* @throws {RequiredError}
|
|
@@ -13612,7 +13637,7 @@ export const BillingApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
13612
13637
|
};
|
|
13613
13638
|
},
|
|
13614
13639
|
/**
|
|
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**](
|
|
13640
|
+
* 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
13641
|
* @summary GET: Billing usage
|
|
13617
13642
|
* @param {string} [deleted] `true` will return inactive resources and `false` will return active resources. By defualt(`deleted=false`)
|
|
13618
13643
|
* @param {string} [environment] Filter resources by environment ID or Name
|
|
@@ -14702,7 +14727,7 @@ export const BillingApiFp = function(configuration?: Configuration) {
|
|
|
14702
14727
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14703
14728
|
},
|
|
14704
14729
|
/**
|
|
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**](
|
|
14730
|
+
* 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
14731
|
* @summary GET: Last Day Cost
|
|
14707
14732
|
* @param {*} [options] Override http request option.
|
|
14708
14733
|
* @throws {RequiredError}
|
|
@@ -14848,7 +14873,7 @@ export const BillingApiFp = function(configuration?: Configuration) {
|
|
|
14848
14873
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14849
14874
|
},
|
|
14850
14875
|
/**
|
|
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**](
|
|
14876
|
+
* 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
14877
|
* @summary GET: Billing usage
|
|
14853
14878
|
* @param {string} [deleted] `true` will return inactive resources and `false` will return active resources. By defualt(`deleted=false`)
|
|
14854
14879
|
* @param {string} [environment] Filter resources by environment ID or Name
|
|
@@ -15284,7 +15309,7 @@ export const BillingApiFactory = function (configuration?: Configuration, basePa
|
|
|
15284
15309
|
return localVarFp.getImageGenerationHistoryForResource(resourceId, startDate, endDate, options).then((request) => request(axios, basePath));
|
|
15285
15310
|
},
|
|
15286
15311
|
/**
|
|
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**](
|
|
15312
|
+
* 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
15313
|
* @summary GET: Last Day Cost
|
|
15289
15314
|
* @param {*} [options] Override http request option.
|
|
15290
15315
|
* @throws {RequiredError}
|
|
@@ -15400,7 +15425,7 @@ export const BillingApiFactory = function (configuration?: Configuration, basePa
|
|
|
15400
15425
|
return localVarFp.getSnapshotBillingHistoryGraph(snapshotId, startDate, endDate, options).then((request) => request(axios, basePath));
|
|
15401
15426
|
},
|
|
15402
15427
|
/**
|
|
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**](
|
|
15428
|
+
* 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
15429
|
* @summary GET: Billing usage
|
|
15405
15430
|
* @param {string} [deleted] `true` will return inactive resources and `false` will return active resources. By defualt(`deleted=false`)
|
|
15406
15431
|
* @param {string} [environment] Filter resources by environment ID or Name
|
|
@@ -15806,7 +15831,7 @@ export class BillingApi extends BaseAPI {
|
|
|
15806
15831
|
}
|
|
15807
15832
|
|
|
15808
15833
|
/**
|
|
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**](
|
|
15834
|
+
* 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
15835
|
* @summary GET: Last Day Cost
|
|
15811
15836
|
* @param {*} [options] Override http request option.
|
|
15812
15837
|
* @throws {RequiredError}
|
|
@@ -15942,7 +15967,7 @@ export class BillingApi extends BaseAPI {
|
|
|
15942
15967
|
}
|
|
15943
15968
|
|
|
15944
15969
|
/**
|
|
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**](
|
|
15970
|
+
* 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
15971
|
* @summary GET: Billing usage
|
|
15947
15972
|
* @param {string} [deleted] `true` will return inactive resources and `false` will return active resources. By defualt(`deleted=false`)
|
|
15948
15973
|
* @param {string} [environment] Filter resources by environment ID or Name
|
|
@@ -18571,7 +18596,7 @@ export class ClustersApi extends BaseAPI {
|
|
|
18571
18596
|
export const CreditApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
18572
18597
|
return {
|
|
18573
18598
|
/**
|
|
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**](
|
|
18599
|
+
* 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
18600
|
* @summary GET: View credit and threshold
|
|
18576
18601
|
* @param {*} [options] Override http request option.
|
|
18577
18602
|
* @throws {RequiredError}
|
|
@@ -18614,7 +18639,7 @@ export const CreditApiFp = function(configuration?: Configuration) {
|
|
|
18614
18639
|
const localVarAxiosParamCreator = CreditApiAxiosParamCreator(configuration)
|
|
18615
18640
|
return {
|
|
18616
18641
|
/**
|
|
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**](
|
|
18642
|
+
* 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
18643
|
* @summary GET: View credit and threshold
|
|
18619
18644
|
* @param {*} [options] Override http request option.
|
|
18620
18645
|
* @throws {RequiredError}
|
|
@@ -18636,7 +18661,7 @@ export const CreditApiFactory = function (configuration?: Configuration, basePat
|
|
|
18636
18661
|
const localVarFp = CreditApiFp(configuration)
|
|
18637
18662
|
return {
|
|
18638
18663
|
/**
|
|
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**](
|
|
18664
|
+
* 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
18665
|
* @summary GET: View credit and threshold
|
|
18641
18666
|
* @param {*} [options] Override http request option.
|
|
18642
18667
|
* @throws {RequiredError}
|
|
@@ -18655,7 +18680,7 @@ export const CreditApiFactory = function (configuration?: Configuration, basePat
|
|
|
18655
18680
|
*/
|
|
18656
18681
|
export class CreditApi extends BaseAPI {
|
|
18657
18682
|
/**
|
|
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**](
|
|
18683
|
+
* 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
18684
|
* @summary GET: View credit and threshold
|
|
18660
18685
|
* @param {*} [options] Override http request option.
|
|
18661
18686
|
* @throws {RequiredError}
|
|
@@ -22668,7 +22693,7 @@ export class PartnerConfigApi extends BaseAPI {
|
|
|
22668
22693
|
export const PaymentApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
22669
22694
|
return {
|
|
22670
22695
|
/**
|
|
22671
|
-
* Retrieve the
|
|
22696
|
+
* 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
22697
|
* @summary Retrieve Payment Receipt
|
|
22673
22698
|
* @param {string} paymentId
|
|
22674
22699
|
* @param {*} [options] Override http request option.
|
|
@@ -22705,7 +22730,7 @@ export const PaymentApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
22705
22730
|
};
|
|
22706
22731
|
},
|
|
22707
22732
|
/**
|
|
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**](
|
|
22733
|
+
* 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
22734
|
* @summary POST: Initiate payment
|
|
22710
22735
|
* @param {PaymentInitiatePayload} payload
|
|
22711
22736
|
* @param {*} [options] Override http request option.
|
|
@@ -22744,7 +22769,7 @@ export const PaymentApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
22744
22769
|
};
|
|
22745
22770
|
},
|
|
22746
22771
|
/**
|
|
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**](
|
|
22772
|
+
* 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
22773
|
* @summary GET: View payment details
|
|
22749
22774
|
* @param {*} [options] Override http request option.
|
|
22750
22775
|
* @throws {RequiredError}
|
|
@@ -22787,20 +22812,20 @@ export const PaymentApiFp = function(configuration?: Configuration) {
|
|
|
22787
22812
|
const localVarAxiosParamCreator = PaymentApiAxiosParamCreator(configuration)
|
|
22788
22813
|
return {
|
|
22789
22814
|
/**
|
|
22790
|
-
* Retrieve the
|
|
22815
|
+
* 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
22816
|
* @summary Retrieve Payment Receipt
|
|
22792
22817
|
* @param {string} paymentId
|
|
22793
22818
|
* @param {*} [options] Override http request option.
|
|
22794
22819
|
* @throws {RequiredError}
|
|
22795
22820
|
*/
|
|
22796
|
-
async getPaymentReceipt(paymentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
22821
|
+
async getPaymentReceipt(paymentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentReceiptResponse>> {
|
|
22797
22822
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getPaymentReceipt(paymentId, options);
|
|
22798
22823
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
22799
22824
|
const localVarOperationServerBasePath = operationServerMap['PaymentApi.getPaymentReceipt']?.[localVarOperationServerIndex]?.url;
|
|
22800
22825
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
22801
22826
|
},
|
|
22802
22827
|
/**
|
|
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**](
|
|
22828
|
+
* 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
22829
|
* @summary POST: Initiate payment
|
|
22805
22830
|
* @param {PaymentInitiatePayload} payload
|
|
22806
22831
|
* @param {*} [options] Override http request option.
|
|
@@ -22813,7 +22838,7 @@ export const PaymentApiFp = function(configuration?: Configuration) {
|
|
|
22813
22838
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
22814
22839
|
},
|
|
22815
22840
|
/**
|
|
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**](
|
|
22841
|
+
* 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
22842
|
* @summary GET: View payment details
|
|
22818
22843
|
* @param {*} [options] Override http request option.
|
|
22819
22844
|
* @throws {RequiredError}
|
|
@@ -22835,17 +22860,17 @@ export const PaymentApiFactory = function (configuration?: Configuration, basePa
|
|
|
22835
22860
|
const localVarFp = PaymentApiFp(configuration)
|
|
22836
22861
|
return {
|
|
22837
22862
|
/**
|
|
22838
|
-
* Retrieve the
|
|
22863
|
+
* 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
22864
|
* @summary Retrieve Payment Receipt
|
|
22840
22865
|
* @param {string} paymentId
|
|
22841
22866
|
* @param {*} [options] Override http request option.
|
|
22842
22867
|
* @throws {RequiredError}
|
|
22843
22868
|
*/
|
|
22844
|
-
getPaymentReceipt(paymentId: string, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
22869
|
+
getPaymentReceipt(paymentId: string, options?: RawAxiosRequestConfig): AxiosPromise<PaymentReceiptResponse> {
|
|
22845
22870
|
return localVarFp.getPaymentReceipt(paymentId, options).then((request) => request(axios, basePath));
|
|
22846
22871
|
},
|
|
22847
22872
|
/**
|
|
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**](
|
|
22873
|
+
* 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
22874
|
* @summary POST: Initiate payment
|
|
22850
22875
|
* @param {PaymentInitiatePayload} payload
|
|
22851
22876
|
* @param {*} [options] Override http request option.
|
|
@@ -22855,7 +22880,7 @@ export const PaymentApiFactory = function (configuration?: Configuration, basePa
|
|
|
22855
22880
|
return localVarFp.initiatePayment(payload, options).then((request) => request(axios, basePath));
|
|
22856
22881
|
},
|
|
22857
22882
|
/**
|
|
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**](
|
|
22883
|
+
* 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
22884
|
* @summary GET: View payment details
|
|
22860
22885
|
* @param {*} [options] Override http request option.
|
|
22861
22886
|
* @throws {RequiredError}
|
|
@@ -22874,7 +22899,7 @@ export const PaymentApiFactory = function (configuration?: Configuration, basePa
|
|
|
22874
22899
|
*/
|
|
22875
22900
|
export class PaymentApi extends BaseAPI {
|
|
22876
22901
|
/**
|
|
22877
|
-
* Retrieve the
|
|
22902
|
+
* 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
22903
|
* @summary Retrieve Payment Receipt
|
|
22879
22904
|
* @param {string} paymentId
|
|
22880
22905
|
* @param {*} [options] Override http request option.
|
|
@@ -22886,7 +22911,7 @@ export class PaymentApi extends BaseAPI {
|
|
|
22886
22911
|
}
|
|
22887
22912
|
|
|
22888
22913
|
/**
|
|
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**](
|
|
22914
|
+
* 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
22915
|
* @summary POST: Initiate payment
|
|
22891
22916
|
* @param {PaymentInitiatePayload} payload
|
|
22892
22917
|
* @param {*} [options] Override http request option.
|
|
@@ -22898,7 +22923,7 @@ export class PaymentApi extends BaseAPI {
|
|
|
22898
22923
|
}
|
|
22899
22924
|
|
|
22900
22925
|
/**
|
|
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**](
|
|
22926
|
+
* 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
22927
|
* @summary GET: View payment details
|
|
22903
22928
|
* @param {*} [options] Override http request option.
|
|
22904
22929
|
* @throws {RequiredError}
|