@stigg/typescript 0.1.0-beta.20 → 0.1.0-beta.21
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/CHANGELOG.md +8 -0
- package/package.json +1 -1
- package/resources/v1/addons/addons.d.mts +143 -33
- package/resources/v1/addons/addons.d.mts.map +1 -1
- package/resources/v1/addons/addons.d.ts +143 -33
- package/resources/v1/addons/addons.d.ts.map +1 -1
- package/resources/v1/addons/addons.js +110 -17
- package/resources/v1/addons/addons.js.map +1 -1
- package/resources/v1/addons/addons.mjs +110 -17
- package/resources/v1/addons/addons.mjs.map +1 -1
- package/resources/v1/addons/entitlements.d.mts +62 -5
- package/resources/v1/addons/entitlements.d.mts.map +1 -1
- package/resources/v1/addons/entitlements.d.ts +62 -5
- package/resources/v1/addons/entitlements.d.ts.map +1 -1
- package/resources/v1/addons/entitlements.js +49 -8
- package/resources/v1/addons/entitlements.js.map +1 -1
- package/resources/v1/addons/entitlements.mjs +49 -8
- package/resources/v1/addons/entitlements.mjs.map +1 -1
- package/resources/v1/addons/index.d.mts +2 -2
- package/resources/v1/addons/index.d.mts.map +1 -1
- package/resources/v1/addons/index.d.ts +2 -2
- package/resources/v1/addons/index.d.ts.map +1 -1
- package/resources/v1/addons/index.js.map +1 -1
- package/resources/v1/addons/index.mjs.map +1 -1
- package/resources/v1/coupons.d.mts +80 -20
- package/resources/v1/coupons.d.mts.map +1 -1
- package/resources/v1/coupons.d.ts +80 -20
- package/resources/v1/coupons.d.ts.map +1 -1
- package/resources/v1/coupons.js +60 -9
- package/resources/v1/coupons.js.map +1 -1
- package/resources/v1/coupons.mjs +60 -9
- package/resources/v1/coupons.mjs.map +1 -1
- package/resources/v1/credits/credits.d.mts +59 -26
- package/resources/v1/credits/credits.d.mts.map +1 -1
- package/resources/v1/credits/credits.d.ts +59 -26
- package/resources/v1/credits/credits.d.ts.map +1 -1
- package/resources/v1/credits/credits.js +36 -5
- package/resources/v1/credits/credits.js.map +1 -1
- package/resources/v1/credits/credits.mjs +36 -5
- package/resources/v1/credits/credits.mjs.map +1 -1
- package/resources/v1/credits/custom-currencies.d.mts +96 -23
- package/resources/v1/credits/custom-currencies.d.mts.map +1 -1
- package/resources/v1/credits/custom-currencies.d.ts +96 -23
- package/resources/v1/credits/custom-currencies.d.ts.map +1 -1
- package/resources/v1/credits/custom-currencies.js +76 -12
- package/resources/v1/credits/custom-currencies.js.map +1 -1
- package/resources/v1/credits/custom-currencies.mjs +76 -12
- package/resources/v1/credits/custom-currencies.mjs.map +1 -1
- package/resources/v1/credits/grants.d.mts +60 -23
- package/resources/v1/credits/grants.d.mts.map +1 -1
- package/resources/v1/credits/grants.d.ts +60 -23
- package/resources/v1/credits/grants.d.ts.map +1 -1
- package/resources/v1/credits/grants.js +35 -5
- package/resources/v1/credits/grants.js.map +1 -1
- package/resources/v1/credits/grants.mjs +35 -5
- package/resources/v1/credits/grants.mjs.map +1 -1
- package/resources/v1/credits/index.d.mts +2 -2
- package/resources/v1/credits/index.d.mts.map +1 -1
- package/resources/v1/credits/index.d.ts +2 -2
- package/resources/v1/credits/index.d.ts.map +1 -1
- package/resources/v1/credits/index.js.map +1 -1
- package/resources/v1/credits/index.mjs.map +1 -1
- package/resources/v1/customers/customers.d.mts +165 -48
- package/resources/v1/customers/customers.d.mts.map +1 -1
- package/resources/v1/customers/customers.d.ts +165 -48
- package/resources/v1/customers/customers.d.ts.map +1 -1
- package/resources/v1/customers/customers.js +124 -19
- package/resources/v1/customers/customers.js.map +1 -1
- package/resources/v1/customers/customers.mjs +124 -19
- package/resources/v1/customers/customers.mjs.map +1 -1
- package/resources/v1/customers/index.d.mts +2 -2
- package/resources/v1/customers/index.d.mts.map +1 -1
- package/resources/v1/customers/index.d.ts +2 -2
- package/resources/v1/customers/index.d.ts.map +1 -1
- package/resources/v1/customers/index.js.map +1 -1
- package/resources/v1/customers/index.mjs +1 -1
- package/resources/v1/customers/index.mjs.map +1 -1
- package/resources/v1/customers/integrations.d.mts +64 -9
- package/resources/v1/customers/integrations.d.mts.map +1 -1
- package/resources/v1/customers/integrations.d.ts +64 -9
- package/resources/v1/customers/integrations.d.ts.map +1 -1
- package/resources/v1/customers/integrations.js +57 -9
- package/resources/v1/customers/integrations.js.map +1 -1
- package/resources/v1/customers/integrations.mjs +57 -9
- package/resources/v1/customers/integrations.mjs.map +1 -1
- package/resources/v1/customers/payment-method.d.mts +31 -7
- package/resources/v1/customers/payment-method.d.mts.map +1 -1
- package/resources/v1/customers/payment-method.d.ts +31 -7
- package/resources/v1/customers/payment-method.d.ts.map +1 -1
- package/resources/v1/customers/payment-method.js +26 -4
- package/resources/v1/customers/payment-method.js.map +1 -1
- package/resources/v1/customers/payment-method.mjs +26 -4
- package/resources/v1/customers/payment-method.mjs.map +1 -1
- package/resources/v1/customers/promotional-entitlements.d.mts +40 -7
- package/resources/v1/customers/promotional-entitlements.d.mts.map +1 -1
- package/resources/v1/customers/promotional-entitlements.d.ts +40 -7
- package/resources/v1/customers/promotional-entitlements.d.ts.map +1 -1
- package/resources/v1/customers/promotional-entitlements.js +38 -6
- package/resources/v1/customers/promotional-entitlements.js.map +1 -1
- package/resources/v1/customers/promotional-entitlements.mjs +38 -6
- package/resources/v1/customers/promotional-entitlements.mjs.map +1 -1
- package/resources/v1/events/beta/customers/assignments.d.mts +27 -5
- package/resources/v1/events/beta/customers/assignments.d.mts.map +1 -1
- package/resources/v1/events/beta/customers/assignments.d.ts +27 -5
- package/resources/v1/events/beta/customers/assignments.d.ts.map +1 -1
- package/resources/v1/events/beta/customers/assignments.js +27 -4
- package/resources/v1/events/beta/customers/assignments.js.map +1 -1
- package/resources/v1/events/beta/customers/assignments.mjs +27 -4
- package/resources/v1/events/beta/customers/assignments.mjs.map +1 -1
- package/resources/v1/events/beta/customers/entities.d.mts +66 -10
- package/resources/v1/events/beta/customers/entities.d.mts.map +1 -1
- package/resources/v1/events/beta/customers/entities.d.ts +66 -10
- package/resources/v1/events/beta/customers/entities.d.ts.map +1 -1
- package/resources/v1/events/beta/customers/entities.js +64 -10
- package/resources/v1/events/beta/customers/entities.js.map +1 -1
- package/resources/v1/events/beta/customers/entities.mjs +64 -10
- package/resources/v1/events/beta/customers/entities.mjs.map +1 -1
- package/resources/v1/events/beta/customers/entitlements.d.mts +23 -10
- package/resources/v1/events/beta/customers/entitlements.d.mts.map +1 -1
- package/resources/v1/events/beta/customers/entitlements.d.ts +23 -10
- package/resources/v1/events/beta/customers/entitlements.d.ts.map +1 -1
- package/resources/v1/events/beta/customers/entitlements.js +14 -2
- package/resources/v1/events/beta/customers/entitlements.js.map +1 -1
- package/resources/v1/events/beta/customers/entitlements.mjs +14 -2
- package/resources/v1/events/beta/customers/entitlements.mjs.map +1 -1
- package/resources/v1/events/beta/entity-types.d.mts +25 -3
- package/resources/v1/events/beta/entity-types.d.mts.map +1 -1
- package/resources/v1/events/beta/entity-types.d.ts +25 -3
- package/resources/v1/events/beta/entity-types.d.ts.map +1 -1
- package/resources/v1/events/beta/entity-types.js +23 -3
- package/resources/v1/events/beta/entity-types.js.map +1 -1
- package/resources/v1/events/beta/entity-types.mjs +23 -3
- package/resources/v1/events/beta/entity-types.mjs.map +1 -1
- package/resources/v1/events/events.d.mts +13 -2
- package/resources/v1/events/events.d.mts.map +1 -1
- package/resources/v1/events/events.d.ts +13 -2
- package/resources/v1/events/events.d.ts.map +1 -1
- package/resources/v1/events/events.js +14 -2
- package/resources/v1/events/events.js.map +1 -1
- package/resources/v1/events/events.mjs +14 -2
- package/resources/v1/events/events.mjs.map +1 -1
- package/resources/v1/features.d.mts +108 -30
- package/resources/v1/features.d.mts.map +1 -1
- package/resources/v1/features.d.ts +108 -30
- package/resources/v1/features.d.ts.map +1 -1
- package/resources/v1/features.js +72 -11
- package/resources/v1/features.js.map +1 -1
- package/resources/v1/features.mjs +72 -11
- package/resources/v1/features.mjs.map +1 -1
- package/resources/v1/index.d.mts +7 -7
- package/resources/v1/index.d.mts.map +1 -1
- package/resources/v1/index.d.ts +7 -7
- package/resources/v1/index.d.ts.map +1 -1
- package/resources/v1/index.js.map +1 -1
- package/resources/v1/index.mjs.map +1 -1
- package/resources/v1/plans/entitlements.d.mts +62 -5
- package/resources/v1/plans/entitlements.d.mts.map +1 -1
- package/resources/v1/plans/entitlements.d.ts +62 -5
- package/resources/v1/plans/entitlements.d.ts.map +1 -1
- package/resources/v1/plans/entitlements.js +49 -8
- package/resources/v1/plans/entitlements.js.map +1 -1
- package/resources/v1/plans/entitlements.mjs +49 -8
- package/resources/v1/plans/entitlements.mjs.map +1 -1
- package/resources/v1/plans/index.d.mts +2 -2
- package/resources/v1/plans/index.d.mts.map +1 -1
- package/resources/v1/plans/index.d.ts +2 -2
- package/resources/v1/plans/index.d.ts.map +1 -1
- package/resources/v1/plans/index.js.map +1 -1
- package/resources/v1/plans/index.mjs.map +1 -1
- package/resources/v1/plans/plans.d.mts +156 -34
- package/resources/v1/plans/plans.d.mts.map +1 -1
- package/resources/v1/plans/plans.d.ts +156 -34
- package/resources/v1/plans/plans.d.ts.map +1 -1
- package/resources/v1/plans/plans.js +127 -20
- package/resources/v1/plans/plans.js.map +1 -1
- package/resources/v1/plans/plans.mjs +127 -20
- package/resources/v1/plans/plans.mjs.map +1 -1
- package/resources/v1/products.d.mts +97 -23
- package/resources/v1/products.d.mts.map +1 -1
- package/resources/v1/products.d.ts +97 -23
- package/resources/v1/products.d.ts.map +1 -1
- package/resources/v1/products.js +73 -11
- package/resources/v1/products.js.map +1 -1
- package/resources/v1/products.mjs +73 -11
- package/resources/v1/products.mjs.map +1 -1
- package/resources/v1/subscriptions/future-update.d.mts +29 -3
- package/resources/v1/subscriptions/future-update.d.mts.map +1 -1
- package/resources/v1/subscriptions/future-update.d.ts +29 -3
- package/resources/v1/subscriptions/future-update.d.ts.map +1 -1
- package/resources/v1/subscriptions/future-update.js +25 -4
- package/resources/v1/subscriptions/future-update.js.map +1 -1
- package/resources/v1/subscriptions/future-update.mjs +25 -4
- package/resources/v1/subscriptions/future-update.mjs.map +1 -1
- package/resources/v1/subscriptions/index.d.mts +4 -4
- package/resources/v1/subscriptions/index.d.mts.map +1 -1
- package/resources/v1/subscriptions/index.d.ts +4 -4
- package/resources/v1/subscriptions/index.d.ts.map +1 -1
- package/resources/v1/subscriptions/index.js.map +1 -1
- package/resources/v1/subscriptions/index.mjs +1 -1
- package/resources/v1/subscriptions/index.mjs.map +1 -1
- package/resources/v1/subscriptions/invoice.d.mts +15 -2
- package/resources/v1/subscriptions/invoice.d.mts.map +1 -1
- package/resources/v1/subscriptions/invoice.d.ts +15 -2
- package/resources/v1/subscriptions/invoice.d.ts.map +1 -1
- package/resources/v1/subscriptions/invoice.js +13 -2
- package/resources/v1/subscriptions/invoice.js.map +1 -1
- package/resources/v1/subscriptions/invoice.mjs +13 -2
- package/resources/v1/subscriptions/invoice.mjs.map +1 -1
- package/resources/v1/subscriptions/subscriptions.d.mts +242 -78
- package/resources/v1/subscriptions/subscriptions.d.mts.map +1 -1
- package/resources/v1/subscriptions/subscriptions.d.ts +242 -78
- package/resources/v1/subscriptions/subscriptions.d.ts.map +1 -1
- package/resources/v1/subscriptions/subscriptions.js +126 -19
- package/resources/v1/subscriptions/subscriptions.js.map +1 -1
- package/resources/v1/subscriptions/subscriptions.mjs +128 -21
- package/resources/v1/subscriptions/subscriptions.mjs.map +1 -1
- package/resources/v1/subscriptions/usage.d.mts +29 -4
- package/resources/v1/subscriptions/usage.d.mts.map +1 -1
- package/resources/v1/subscriptions/usage.d.ts +29 -4
- package/resources/v1/subscriptions/usage.d.ts.map +1 -1
- package/resources/v1/subscriptions/usage.js +26 -4
- package/resources/v1/subscriptions/usage.js.map +1 -1
- package/resources/v1/subscriptions/usage.mjs +26 -4
- package/resources/v1/subscriptions/usage.mjs.map +1 -1
- package/resources/v1/usage.d.mts +24 -2
- package/resources/v1/usage.d.mts.map +1 -1
- package/resources/v1/usage.d.ts +24 -2
- package/resources/v1/usage.d.ts.map +1 -1
- package/resources/v1/usage.js +26 -4
- package/resources/v1/usage.js.map +1 -1
- package/resources/v1/usage.mjs +26 -4
- package/resources/v1/usage.mjs.map +1 -1
- package/resources/v1/v1.d.mts +14 -14
- package/resources/v1/v1.d.mts.map +1 -1
- package/resources/v1/v1.d.ts +14 -14
- package/resources/v1/v1.d.ts.map +1 -1
- package/resources/v1/v1.js.map +1 -1
- package/resources/v1/v1.mjs.map +1 -1
- package/src/resources/v1/addons/addons.ts +286 -39
- package/src/resources/v1/addons/entitlements.ts +123 -10
- package/src/resources/v1/addons/index.ts +5 -0
- package/src/resources/v1/coupons.ts +154 -23
- package/src/resources/v1/credits/credits.ts +102 -24
- package/src/resources/v1/credits/custom-currencies.ts +188 -30
- package/src/resources/v1/credits/grants.ts +102 -24
- package/src/resources/v1/credits/index.ts +4 -0
- package/src/resources/v1/customers/customers.ts +318 -57
- package/src/resources/v1/customers/index.ts +8 -1
- package/src/resources/v1/customers/integrations.ts +129 -16
- package/src/resources/v1/customers/payment-method.ts +66 -9
- package/src/resources/v1/customers/promotional-entitlements.ts +82 -11
- package/src/resources/v1/events/beta/customers/assignments.ts +56 -7
- package/src/resources/v1/events/beta/customers/entities.ts +136 -16
- package/src/resources/v1/events/beta/customers/entitlements.ts +38 -11
- package/src/resources/v1/events/beta/entity-types.ts +51 -5
- package/src/resources/v1/events/events.ts +28 -3
- package/src/resources/v1/features.ts +204 -34
- package/src/resources/v1/index.ts +19 -0
- package/src/resources/v1/plans/entitlements.ts +123 -10
- package/src/resources/v1/plans/index.ts +5 -0
- package/src/resources/v1/plans/plans.ts +314 -43
- package/src/resources/v1/products.ts +189 -27
- package/src/resources/v1/subscriptions/future-update.ts +68 -5
- package/src/resources/v1/subscriptions/index.ts +9 -2
- package/src/resources/v1/subscriptions/invoice.ts +36 -3
- package/src/resources/v1/subscriptions/subscriptions.ts +410 -85
- package/src/resources/v1/subscriptions/usage.ts +61 -5
- package/src/resources/v1/usage.ts +53 -5
- package/src/resources/v1/v1.ts +38 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
import { APIResource } from '../../../core/resource';
|
|
4
4
|
import { APIPromise } from '../../../core/api-promise';
|
|
5
5
|
import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../../core/pagination';
|
|
6
|
+
import { buildHeaders } from '../../../internal/headers';
|
|
6
7
|
import { RequestOptions } from '../../../internal/request-options';
|
|
7
8
|
import { path } from '../../../internal/utils/path';
|
|
8
9
|
|
|
@@ -26,8 +27,19 @@ export class Grants extends APIResource {
|
|
|
26
27
|
* });
|
|
27
28
|
* ```
|
|
28
29
|
*/
|
|
29
|
-
create(
|
|
30
|
-
|
|
30
|
+
create(params: GrantCreateParams, options?: RequestOptions): APIPromise<CreditGrantResponse> {
|
|
31
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
|
|
32
|
+
return this._client.post('/api/v1/credits/grants', {
|
|
33
|
+
body,
|
|
34
|
+
...options,
|
|
35
|
+
headers: buildHeaders([
|
|
36
|
+
{
|
|
37
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
38
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
39
|
+
},
|
|
40
|
+
options?.headers,
|
|
41
|
+
]),
|
|
42
|
+
});
|
|
31
43
|
}
|
|
32
44
|
|
|
33
45
|
/**
|
|
@@ -44,12 +56,20 @@ export class Grants extends APIResource {
|
|
|
44
56
|
* ```
|
|
45
57
|
*/
|
|
46
58
|
list(
|
|
47
|
-
|
|
59
|
+
params: GrantListParams,
|
|
48
60
|
options?: RequestOptions,
|
|
49
61
|
): PagePromise<GrantListResponsesMyCursorIDPage, GrantListResponse> {
|
|
62
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params;
|
|
50
63
|
return this._client.getAPIList('/api/v1/credits/grants', MyCursorIDPage<GrantListResponse>, {
|
|
51
64
|
query,
|
|
52
65
|
...options,
|
|
66
|
+
headers: buildHeaders([
|
|
67
|
+
{
|
|
68
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
69
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
70
|
+
},
|
|
71
|
+
options?.headers,
|
|
72
|
+
]),
|
|
53
73
|
});
|
|
54
74
|
}
|
|
55
75
|
|
|
@@ -63,8 +83,22 @@ export class Grants extends APIResource {
|
|
|
63
83
|
* await client.v1.credits.grants.void('x');
|
|
64
84
|
* ```
|
|
65
85
|
*/
|
|
66
|
-
void(
|
|
67
|
-
|
|
86
|
+
void(
|
|
87
|
+
id: string,
|
|
88
|
+
params: GrantVoidParams | null | undefined = {},
|
|
89
|
+
options?: RequestOptions,
|
|
90
|
+
): APIPromise<CreditGrantResponse> {
|
|
91
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
|
|
92
|
+
return this._client.post(path`/api/v1/credits/grants/${id}/void`, {
|
|
93
|
+
...options,
|
|
94
|
+
headers: buildHeaders([
|
|
95
|
+
{
|
|
96
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
97
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
98
|
+
},
|
|
99
|
+
options?.headers,
|
|
100
|
+
]),
|
|
101
|
+
});
|
|
68
102
|
}
|
|
69
103
|
}
|
|
70
104
|
|
|
@@ -498,79 +532,93 @@ export namespace GrantListResponse {
|
|
|
498
532
|
|
|
499
533
|
export interface GrantCreateParams {
|
|
500
534
|
/**
|
|
501
|
-
* The credit amount to grant
|
|
535
|
+
* Body param: The credit amount to grant
|
|
502
536
|
*/
|
|
503
537
|
amount: number;
|
|
504
538
|
|
|
505
539
|
/**
|
|
506
|
-
* The credit currency ID (required)
|
|
540
|
+
* Body param: The credit currency ID (required)
|
|
507
541
|
*/
|
|
508
542
|
currencyId: string;
|
|
509
543
|
|
|
510
544
|
/**
|
|
511
|
-
* The customer ID to grant credits to (required)
|
|
545
|
+
* Body param: The customer ID to grant credits to (required)
|
|
512
546
|
*/
|
|
513
547
|
customerId: string;
|
|
514
548
|
|
|
515
549
|
/**
|
|
516
|
-
* The display name for the credit grant
|
|
550
|
+
* Body param: The display name for the credit grant
|
|
517
551
|
*/
|
|
518
552
|
displayName: string;
|
|
519
553
|
|
|
520
554
|
/**
|
|
521
|
-
* The type of credit grant (PAID, PROMOTIONAL)
|
|
555
|
+
* Body param: The type of credit grant (PAID, PROMOTIONAL)
|
|
522
556
|
*/
|
|
523
557
|
grantType: 'PAID' | 'PROMOTIONAL';
|
|
524
558
|
|
|
525
559
|
/**
|
|
526
|
-
* Whether to wait for payment confirmation before returning (default:
|
|
560
|
+
* Body param: Whether to wait for payment confirmation before returning (default:
|
|
561
|
+
* true)
|
|
527
562
|
*/
|
|
528
563
|
awaitPaymentConfirmation?: boolean;
|
|
529
564
|
|
|
530
565
|
/**
|
|
531
|
-
* Billing information for the credit grant
|
|
566
|
+
* Body param: Billing information for the credit grant
|
|
532
567
|
*/
|
|
533
568
|
billingInformation?: GrantCreateParams.BillingInformation;
|
|
534
569
|
|
|
535
570
|
/**
|
|
536
|
-
* An optional comment on the credit grant
|
|
571
|
+
* Body param: An optional comment on the credit grant
|
|
537
572
|
*/
|
|
538
573
|
comment?: string;
|
|
539
574
|
|
|
540
575
|
/**
|
|
541
|
-
* The monetary cost of the credit grant
|
|
576
|
+
* Body param: The monetary cost of the credit grant
|
|
542
577
|
*/
|
|
543
578
|
cost?: GrantCreateParams.Cost;
|
|
544
579
|
|
|
545
580
|
/**
|
|
546
|
-
* The date when the credit grant becomes effective
|
|
581
|
+
* Body param: The date when the credit grant becomes effective
|
|
547
582
|
*/
|
|
548
583
|
effectiveAt?: string;
|
|
549
584
|
|
|
550
585
|
/**
|
|
551
|
-
* The date when the credit grant expires
|
|
586
|
+
* Body param: The date when the credit grant expires
|
|
552
587
|
*/
|
|
553
588
|
expireAt?: string;
|
|
554
589
|
|
|
555
590
|
/**
|
|
556
|
-
* Additional metadata for the credit grant
|
|
591
|
+
* Body param: Additional metadata for the credit grant
|
|
557
592
|
*/
|
|
558
593
|
metadata?: { [key: string]: string };
|
|
559
594
|
|
|
560
595
|
/**
|
|
561
|
-
* The payment collection method (CHARGE, INVOICE, NONE)
|
|
596
|
+
* Body param: The payment collection method (CHARGE, INVOICE, NONE)
|
|
562
597
|
*/
|
|
563
598
|
paymentCollectionMethod?: 'CHARGE' | 'INVOICE' | 'NONE';
|
|
564
599
|
|
|
565
600
|
/**
|
|
566
|
-
* The priority of the credit grant (lower number = higher priority)
|
|
601
|
+
* Body param: The priority of the credit grant (lower number = higher priority)
|
|
567
602
|
*/
|
|
568
603
|
priority?: number;
|
|
569
604
|
|
|
570
605
|
/**
|
|
571
|
-
* The resource ID to scope the grant to
|
|
606
|
+
* Body param: The resource ID to scope the grant to
|
|
572
607
|
*/
|
|
573
608
|
resourceId?: string;
|
|
609
|
+
|
|
610
|
+
/**
|
|
611
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
612
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
613
|
+
*/
|
|
614
|
+
'X-ACCOUNT-ID'?: string;
|
|
615
|
+
|
|
616
|
+
/**
|
|
617
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
618
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
619
|
+
* intrinsic to the key).
|
|
620
|
+
*/
|
|
621
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
574
622
|
}
|
|
575
623
|
|
|
576
624
|
export namespace GrantCreateParams {
|
|
@@ -765,24 +813,38 @@ export namespace GrantCreateParams {
|
|
|
765
813
|
|
|
766
814
|
export interface GrantListParams extends MyCursorIDPageParams {
|
|
767
815
|
/**
|
|
768
|
-
* Filter by customer ID (required)
|
|
816
|
+
* Query param: Filter by customer ID (required)
|
|
769
817
|
*/
|
|
770
818
|
customerId: string;
|
|
771
819
|
|
|
772
820
|
/**
|
|
773
|
-
* Filter by creation date using range operators: gt, gte, lt, lte
|
|
821
|
+
* Query param: Filter by creation date using range operators: gt, gte, lt, lte
|
|
774
822
|
*/
|
|
775
823
|
createdAt?: GrantListParams.CreatedAt;
|
|
776
824
|
|
|
777
825
|
/**
|
|
778
|
-
* Filter by currency ID
|
|
826
|
+
* Query param: Filter by currency ID
|
|
779
827
|
*/
|
|
780
828
|
currencyId?: string;
|
|
781
829
|
|
|
782
830
|
/**
|
|
783
|
-
* Filter by resource ID. When omitted, only grants without a resource
|
|
831
|
+
* Query param: Filter by resource ID. When omitted, only grants without a resource
|
|
832
|
+
* are returned
|
|
784
833
|
*/
|
|
785
834
|
resourceId?: string;
|
|
835
|
+
|
|
836
|
+
/**
|
|
837
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
838
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
839
|
+
*/
|
|
840
|
+
'X-ACCOUNT-ID'?: string;
|
|
841
|
+
|
|
842
|
+
/**
|
|
843
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
844
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
845
|
+
* intrinsic to the key).
|
|
846
|
+
*/
|
|
847
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
786
848
|
}
|
|
787
849
|
|
|
788
850
|
export namespace GrantListParams {
|
|
@@ -812,6 +874,21 @@ export namespace GrantListParams {
|
|
|
812
874
|
}
|
|
813
875
|
}
|
|
814
876
|
|
|
877
|
+
export interface GrantVoidParams {
|
|
878
|
+
/**
|
|
879
|
+
* Account ID — optional when authenticating with a user JWT (Bearer token); falls
|
|
880
|
+
* back to the user's first membership. Ignored for API-key auth.
|
|
881
|
+
*/
|
|
882
|
+
'X-ACCOUNT-ID'?: string;
|
|
883
|
+
|
|
884
|
+
/**
|
|
885
|
+
* Environment ID — required when authenticating with a user JWT (Bearer token) on
|
|
886
|
+
* environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the
|
|
887
|
+
* key).
|
|
888
|
+
*/
|
|
889
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
890
|
+
}
|
|
891
|
+
|
|
815
892
|
export declare namespace Grants {
|
|
816
893
|
export {
|
|
817
894
|
type CreditGrantResponse as CreditGrantResponse,
|
|
@@ -819,5 +896,6 @@ export declare namespace Grants {
|
|
|
819
896
|
type GrantListResponsesMyCursorIDPage as GrantListResponsesMyCursorIDPage,
|
|
820
897
|
type GrantCreateParams as GrantCreateParams,
|
|
821
898
|
type GrantListParams as GrantListParams,
|
|
899
|
+
type GrantVoidParams as GrantVoidParams,
|
|
822
900
|
};
|
|
823
901
|
}
|
|
@@ -18,6 +18,9 @@ export {
|
|
|
18
18
|
type CustomCurrencyCreateParams,
|
|
19
19
|
type CustomCurrencyUpdateParams,
|
|
20
20
|
type CustomCurrencyListParams,
|
|
21
|
+
type CustomCurrencyArchiveParams,
|
|
22
|
+
type CustomCurrencyListAssociatedEntitiesParams,
|
|
23
|
+
type CustomCurrencyUnarchiveParams,
|
|
21
24
|
type CustomCurrencyListResponsesMyCursorIDPage,
|
|
22
25
|
} from './custom-currencies';
|
|
23
26
|
export {
|
|
@@ -26,5 +29,6 @@ export {
|
|
|
26
29
|
type GrantListResponse,
|
|
27
30
|
type GrantCreateParams,
|
|
28
31
|
type GrantListParams,
|
|
32
|
+
type GrantVoidParams,
|
|
29
33
|
type GrantListResponsesMyCursorIDPage,
|
|
30
34
|
} from './grants';
|