@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/dist/api.js
CHANGED
|
@@ -425,7 +425,7 @@ exports.AccessKeysApi = AccessKeysApi;
|
|
|
425
425
|
const AliveApiAxiosParamCreator = function (configuration) {
|
|
426
426
|
return {
|
|
427
427
|
/**
|
|
428
|
-
* 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**](
|
|
428
|
+
* 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/).
|
|
429
429
|
* @summary GET: Alive
|
|
430
430
|
* @param {*} [options] Override http request option.
|
|
431
431
|
* @throws {RequiredError}
|
|
@@ -488,7 +488,7 @@ const AliveApiFp = function (configuration) {
|
|
|
488
488
|
const localVarAxiosParamCreator = (0, exports.AliveApiAxiosParamCreator)(configuration);
|
|
489
489
|
return {
|
|
490
490
|
/**
|
|
491
|
-
* 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**](
|
|
491
|
+
* 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/).
|
|
492
492
|
* @summary GET: Alive
|
|
493
493
|
* @param {*} [options] Override http request option.
|
|
494
494
|
* @throws {RequiredError}
|
|
@@ -527,7 +527,7 @@ const AliveApiFactory = function (configuration, basePath, axios) {
|
|
|
527
527
|
const localVarFp = (0, exports.AliveApiFp)(configuration);
|
|
528
528
|
return {
|
|
529
529
|
/**
|
|
530
|
-
* 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**](
|
|
530
|
+
* 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/).
|
|
531
531
|
* @summary GET: Alive
|
|
532
532
|
* @param {*} [options] Override http request option.
|
|
533
533
|
* @throws {RequiredError}
|
|
@@ -554,7 +554,7 @@ exports.AliveApiFactory = AliveApiFactory;
|
|
|
554
554
|
*/
|
|
555
555
|
class AliveApi extends base_1.BaseAPI {
|
|
556
556
|
/**
|
|
557
|
-
* 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**](
|
|
557
|
+
* 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/).
|
|
558
558
|
* @summary GET: Alive
|
|
559
559
|
* @param {*} [options] Override http request option.
|
|
560
560
|
* @throws {RequiredError}
|
|
@@ -1446,7 +1446,7 @@ const AutoTopupApiAxiosParamCreator = function (configuration) {
|
|
|
1446
1446
|
};
|
|
1447
1447
|
}),
|
|
1448
1448
|
/**
|
|
1449
|
-
* 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**](
|
|
1449
|
+
* 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/).
|
|
1450
1450
|
* @summary Get auto top-up status and configuration
|
|
1451
1451
|
* @param {*} [options] Override http request option.
|
|
1452
1452
|
* @throws {RequiredError}
|
|
@@ -1561,7 +1561,7 @@ const AutoTopupApiFp = function (configuration) {
|
|
|
1561
1561
|
});
|
|
1562
1562
|
},
|
|
1563
1563
|
/**
|
|
1564
|
-
* 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**](
|
|
1564
|
+
* 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/).
|
|
1565
1565
|
* @summary Get auto top-up status and configuration
|
|
1566
1566
|
* @param {*} [options] Override http request option.
|
|
1567
1567
|
* @throws {RequiredError}
|
|
@@ -1630,7 +1630,7 @@ const AutoTopupApiFactory = function (configuration, basePath, axios) {
|
|
|
1630
1630
|
return localVarFp.getAutoTopUp(options).then((request) => request(axios, basePath));
|
|
1631
1631
|
},
|
|
1632
1632
|
/**
|
|
1633
|
-
* 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**](
|
|
1633
|
+
* 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/).
|
|
1634
1634
|
* @summary Get auto top-up status and configuration
|
|
1635
1635
|
* @param {*} [options] Override http request option.
|
|
1636
1636
|
* @throws {RequiredError}
|
|
@@ -1690,7 +1690,7 @@ class AutoTopupApi extends base_1.BaseAPI {
|
|
|
1690
1690
|
return (0, exports.AutoTopupApiFp)(this.configuration).getAutoTopUp(options).then((request) => request(this.axios, this.basePath));
|
|
1691
1691
|
}
|
|
1692
1692
|
/**
|
|
1693
|
-
* 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**](
|
|
1693
|
+
* 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/).
|
|
1694
1694
|
* @summary Get auto top-up status and configuration
|
|
1695
1695
|
* @param {*} [options] Override http request option.
|
|
1696
1696
|
* @throws {RequiredError}
|
|
@@ -2445,7 +2445,7 @@ const BillingApiAxiosParamCreator = function (configuration) {
|
|
|
2445
2445
|
};
|
|
2446
2446
|
}),
|
|
2447
2447
|
/**
|
|
2448
|
-
* 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**](
|
|
2448
|
+
* 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/)
|
|
2449
2449
|
* @summary GET: Last Day Cost
|
|
2450
2450
|
* @param {*} [options] Override http request option.
|
|
2451
2451
|
* @throws {RequiredError}
|
|
@@ -2826,7 +2826,7 @@ const BillingApiAxiosParamCreator = function (configuration) {
|
|
|
2826
2826
|
};
|
|
2827
2827
|
}),
|
|
2828
2828
|
/**
|
|
2829
|
-
* 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**](
|
|
2829
|
+
* 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/)
|
|
2830
2830
|
* @summary GET: Billing usage
|
|
2831
2831
|
* @param {string} [deleted] `true` will return inactive resources and `false` will return active resources. By defualt(`deleted=false`)
|
|
2832
2832
|
* @param {string} [environment] Filter resources by environment ID or Name
|
|
@@ -3790,7 +3790,7 @@ const BillingApiFp = function (configuration) {
|
|
|
3790
3790
|
});
|
|
3791
3791
|
},
|
|
3792
3792
|
/**
|
|
3793
|
-
* 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**](
|
|
3793
|
+
* 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/)
|
|
3794
3794
|
* @summary GET: Last Day Cost
|
|
3795
3795
|
* @param {*} [options] Override http request option.
|
|
3796
3796
|
* @throws {RequiredError}
|
|
@@ -3966,7 +3966,7 @@ const BillingApiFp = function (configuration) {
|
|
|
3966
3966
|
});
|
|
3967
3967
|
},
|
|
3968
3968
|
/**
|
|
3969
|
-
* 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**](
|
|
3969
|
+
* 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/)
|
|
3970
3970
|
* @summary GET: Billing usage
|
|
3971
3971
|
* @param {string} [deleted] `true` will return inactive resources and `false` will return active resources. By defualt(`deleted=false`)
|
|
3972
3972
|
* @param {string} [environment] Filter resources by environment ID or Name
|
|
@@ -4456,7 +4456,7 @@ const BillingApiFactory = function (configuration, basePath, axios) {
|
|
|
4456
4456
|
return localVarFp.getImageGenerationHistoryForResource(resourceId, startDate, endDate, options).then((request) => request(axios, basePath));
|
|
4457
4457
|
},
|
|
4458
4458
|
/**
|
|
4459
|
-
* 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**](
|
|
4459
|
+
* 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/)
|
|
4460
4460
|
* @summary GET: Last Day Cost
|
|
4461
4461
|
* @param {*} [options] Override http request option.
|
|
4462
4462
|
* @throws {RequiredError}
|
|
@@ -4572,7 +4572,7 @@ const BillingApiFactory = function (configuration, basePath, axios) {
|
|
|
4572
4572
|
return localVarFp.getSnapshotBillingHistoryGraph(snapshotId, startDate, endDate, options).then((request) => request(axios, basePath));
|
|
4573
4573
|
},
|
|
4574
4574
|
/**
|
|
4575
|
-
* 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**](
|
|
4575
|
+
* 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/)
|
|
4576
4576
|
* @summary GET: Billing usage
|
|
4577
4577
|
* @param {string} [deleted] `true` will return inactive resources and `false` will return active resources. By defualt(`deleted=false`)
|
|
4578
4578
|
* @param {string} [environment] Filter resources by environment ID or Name
|
|
@@ -4966,7 +4966,7 @@ class BillingApi extends base_1.BaseAPI {
|
|
|
4966
4966
|
return (0, exports.BillingApiFp)(this.configuration).getImageGenerationHistoryForResource(resourceId, startDate, endDate, options).then((request) => request(this.axios, this.basePath));
|
|
4967
4967
|
}
|
|
4968
4968
|
/**
|
|
4969
|
-
* 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**](
|
|
4969
|
+
* 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/)
|
|
4970
4970
|
* @summary GET: Last Day Cost
|
|
4971
4971
|
* @param {*} [options] Override http request option.
|
|
4972
4972
|
* @throws {RequiredError}
|
|
@@ -5092,7 +5092,7 @@ class BillingApi extends base_1.BaseAPI {
|
|
|
5092
5092
|
return (0, exports.BillingApiFp)(this.configuration).getSnapshotBillingHistoryGraph(snapshotId, startDate, endDate, options).then((request) => request(this.axios, this.basePath));
|
|
5093
5093
|
}
|
|
5094
5094
|
/**
|
|
5095
|
-
* 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**](
|
|
5095
|
+
* 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/)
|
|
5096
5096
|
* @summary GET: Billing usage
|
|
5097
5097
|
* @param {string} [deleted] `true` will return inactive resources and `false` will return active resources. By defualt(`deleted=false`)
|
|
5098
5098
|
* @param {string} [environment] Filter resources by environment ID or Name
|
|
@@ -7568,7 +7568,7 @@ exports.ClustersApi = ClustersApi;
|
|
|
7568
7568
|
const CreditApiAxiosParamCreator = function (configuration) {
|
|
7569
7569
|
return {
|
|
7570
7570
|
/**
|
|
7571
|
-
* 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**](
|
|
7571
|
+
* 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/).
|
|
7572
7572
|
* @summary GET: View credit and threshold
|
|
7573
7573
|
* @param {*} [options] Override http request option.
|
|
7574
7574
|
* @throws {RequiredError}
|
|
@@ -7605,7 +7605,7 @@ const CreditApiFp = function (configuration) {
|
|
|
7605
7605
|
const localVarAxiosParamCreator = (0, exports.CreditApiAxiosParamCreator)(configuration);
|
|
7606
7606
|
return {
|
|
7607
7607
|
/**
|
|
7608
|
-
* 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**](
|
|
7608
|
+
* 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/).
|
|
7609
7609
|
* @summary GET: View credit and threshold
|
|
7610
7610
|
* @param {*} [options] Override http request option.
|
|
7611
7611
|
* @throws {RequiredError}
|
|
@@ -7630,7 +7630,7 @@ const CreditApiFactory = function (configuration, basePath, axios) {
|
|
|
7630
7630
|
const localVarFp = (0, exports.CreditApiFp)(configuration);
|
|
7631
7631
|
return {
|
|
7632
7632
|
/**
|
|
7633
|
-
* 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**](
|
|
7633
|
+
* 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/).
|
|
7634
7634
|
* @summary GET: View credit and threshold
|
|
7635
7635
|
* @param {*} [options] Override http request option.
|
|
7636
7636
|
* @throws {RequiredError}
|
|
@@ -7649,7 +7649,7 @@ exports.CreditApiFactory = CreditApiFactory;
|
|
|
7649
7649
|
*/
|
|
7650
7650
|
class CreditApi extends base_1.BaseAPI {
|
|
7651
7651
|
/**
|
|
7652
|
-
* 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**](
|
|
7652
|
+
* 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/).
|
|
7653
7653
|
* @summary GET: View credit and threshold
|
|
7654
7654
|
* @param {*} [options] Override http request option.
|
|
7655
7655
|
* @throws {RequiredError}
|
|
@@ -11430,7 +11430,7 @@ exports.PartnerConfigApi = PartnerConfigApi;
|
|
|
11430
11430
|
const PaymentApiAxiosParamCreator = function (configuration) {
|
|
11431
11431
|
return {
|
|
11432
11432
|
/**
|
|
11433
|
-
* Retrieve the
|
|
11433
|
+
* 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.
|
|
11434
11434
|
* @summary Retrieve Payment Receipt
|
|
11435
11435
|
* @param {string} paymentId
|
|
11436
11436
|
* @param {*} [options] Override http request option.
|
|
@@ -11461,7 +11461,7 @@ const PaymentApiAxiosParamCreator = function (configuration) {
|
|
|
11461
11461
|
};
|
|
11462
11462
|
}),
|
|
11463
11463
|
/**
|
|
11464
|
-
* 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**](
|
|
11464
|
+
* 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).
|
|
11465
11465
|
* @summary POST: Initiate payment
|
|
11466
11466
|
* @param {PaymentInitiatePayload} payload
|
|
11467
11467
|
* @param {*} [options] Override http request option.
|
|
@@ -11493,7 +11493,7 @@ const PaymentApiAxiosParamCreator = function (configuration) {
|
|
|
11493
11493
|
};
|
|
11494
11494
|
}),
|
|
11495
11495
|
/**
|
|
11496
|
-
* 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**](
|
|
11496
|
+
* 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/).
|
|
11497
11497
|
* @summary GET: View payment details
|
|
11498
11498
|
* @param {*} [options] Override http request option.
|
|
11499
11499
|
* @throws {RequiredError}
|
|
@@ -11530,7 +11530,7 @@ const PaymentApiFp = function (configuration) {
|
|
|
11530
11530
|
const localVarAxiosParamCreator = (0, exports.PaymentApiAxiosParamCreator)(configuration);
|
|
11531
11531
|
return {
|
|
11532
11532
|
/**
|
|
11533
|
-
* Retrieve the
|
|
11533
|
+
* 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.
|
|
11534
11534
|
* @summary Retrieve Payment Receipt
|
|
11535
11535
|
* @param {string} paymentId
|
|
11536
11536
|
* @param {*} [options] Override http request option.
|
|
@@ -11546,7 +11546,7 @@ const PaymentApiFp = function (configuration) {
|
|
|
11546
11546
|
});
|
|
11547
11547
|
},
|
|
11548
11548
|
/**
|
|
11549
|
-
* 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**](
|
|
11549
|
+
* 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).
|
|
11550
11550
|
* @summary POST: Initiate payment
|
|
11551
11551
|
* @param {PaymentInitiatePayload} payload
|
|
11552
11552
|
* @param {*} [options] Override http request option.
|
|
@@ -11562,7 +11562,7 @@ const PaymentApiFp = function (configuration) {
|
|
|
11562
11562
|
});
|
|
11563
11563
|
},
|
|
11564
11564
|
/**
|
|
11565
|
-
* 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**](
|
|
11565
|
+
* 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/).
|
|
11566
11566
|
* @summary GET: View payment details
|
|
11567
11567
|
* @param {*} [options] Override http request option.
|
|
11568
11568
|
* @throws {RequiredError}
|
|
@@ -11587,7 +11587,7 @@ const PaymentApiFactory = function (configuration, basePath, axios) {
|
|
|
11587
11587
|
const localVarFp = (0, exports.PaymentApiFp)(configuration);
|
|
11588
11588
|
return {
|
|
11589
11589
|
/**
|
|
11590
|
-
* Retrieve the
|
|
11590
|
+
* 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.
|
|
11591
11591
|
* @summary Retrieve Payment Receipt
|
|
11592
11592
|
* @param {string} paymentId
|
|
11593
11593
|
* @param {*} [options] Override http request option.
|
|
@@ -11597,7 +11597,7 @@ const PaymentApiFactory = function (configuration, basePath, axios) {
|
|
|
11597
11597
|
return localVarFp.getPaymentReceipt(paymentId, options).then((request) => request(axios, basePath));
|
|
11598
11598
|
},
|
|
11599
11599
|
/**
|
|
11600
|
-
* 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**](
|
|
11600
|
+
* 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).
|
|
11601
11601
|
* @summary POST: Initiate payment
|
|
11602
11602
|
* @param {PaymentInitiatePayload} payload
|
|
11603
11603
|
* @param {*} [options] Override http request option.
|
|
@@ -11607,7 +11607,7 @@ const PaymentApiFactory = function (configuration, basePath, axios) {
|
|
|
11607
11607
|
return localVarFp.initiatePayment(payload, options).then((request) => request(axios, basePath));
|
|
11608
11608
|
},
|
|
11609
11609
|
/**
|
|
11610
|
-
* 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**](
|
|
11610
|
+
* 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/).
|
|
11611
11611
|
* @summary GET: View payment details
|
|
11612
11612
|
* @param {*} [options] Override http request option.
|
|
11613
11613
|
* @throws {RequiredError}
|
|
@@ -11626,7 +11626,7 @@ exports.PaymentApiFactory = PaymentApiFactory;
|
|
|
11626
11626
|
*/
|
|
11627
11627
|
class PaymentApi extends base_1.BaseAPI {
|
|
11628
11628
|
/**
|
|
11629
|
-
* Retrieve the
|
|
11629
|
+
* 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.
|
|
11630
11630
|
* @summary Retrieve Payment Receipt
|
|
11631
11631
|
* @param {string} paymentId
|
|
11632
11632
|
* @param {*} [options] Override http request option.
|
|
@@ -11637,7 +11637,7 @@ class PaymentApi extends base_1.BaseAPI {
|
|
|
11637
11637
|
return (0, exports.PaymentApiFp)(this.configuration).getPaymentReceipt(paymentId, options).then((request) => request(this.axios, this.basePath));
|
|
11638
11638
|
}
|
|
11639
11639
|
/**
|
|
11640
|
-
* 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**](
|
|
11640
|
+
* 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).
|
|
11641
11641
|
* @summary POST: Initiate payment
|
|
11642
11642
|
* @param {PaymentInitiatePayload} payload
|
|
11643
11643
|
* @param {*} [options] Override http request option.
|
|
@@ -11648,7 +11648,7 @@ class PaymentApi extends base_1.BaseAPI {
|
|
|
11648
11648
|
return (0, exports.PaymentApiFp)(this.configuration).initiatePayment(payload, options).then((request) => request(this.axios, this.basePath));
|
|
11649
11649
|
}
|
|
11650
11650
|
/**
|
|
11651
|
-
* 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**](
|
|
11651
|
+
* 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/).
|
|
11652
11652
|
* @summary GET: View payment details
|
|
11653
11653
|
* @param {*} [options] Override http request option.
|
|
11654
11654
|
* @throws {RequiredError}
|