@usehercules/sdk 1.10.1 → 1.11.0
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 +9 -0
- package/README.md +7 -7
- package/package.json +1 -1
- package/resources/beta/commerce/commerce.d.mts +31 -11
- package/resources/beta/commerce/commerce.d.mts.map +1 -1
- package/resources/beta/commerce/commerce.d.ts +31 -11
- package/resources/beta/commerce/commerce.d.ts.map +1 -1
- package/resources/beta/commerce/commerce.js +4 -0
- package/resources/beta/commerce/commerce.js.map +1 -1
- package/resources/beta/commerce/commerce.mjs +4 -0
- package/resources/beta/commerce/commerce.mjs.map +1 -1
- package/resources/beta/commerce/coupons.d.mts +7 -184
- package/resources/beta/commerce/coupons.d.mts.map +1 -1
- package/resources/beta/commerce/coupons.d.ts +7 -184
- package/resources/beta/commerce/coupons.d.ts.map +1 -1
- package/resources/beta/commerce/coupons.js +1 -4
- package/resources/beta/commerce/coupons.js.map +1 -1
- package/resources/beta/commerce/coupons.mjs +1 -4
- package/resources/beta/commerce/coupons.mjs.map +1 -1
- package/resources/beta/commerce/customers.d.mts +24 -239
- package/resources/beta/commerce/customers.d.mts.map +1 -1
- package/resources/beta/commerce/customers.d.ts +24 -239
- package/resources/beta/commerce/customers.d.ts.map +1 -1
- package/resources/beta/commerce/customers.js +1 -4
- package/resources/beta/commerce/customers.js.map +1 -1
- package/resources/beta/commerce/customers.mjs +1 -4
- package/resources/beta/commerce/customers.mjs.map +1 -1
- package/resources/beta/commerce/features.d.mts +127 -0
- package/resources/beta/commerce/features.d.mts.map +1 -0
- package/resources/beta/commerce/features.d.ts +127 -0
- package/resources/beta/commerce/features.d.ts.map +1 -0
- package/resources/beta/commerce/features.js +49 -0
- package/resources/beta/commerce/features.js.map +1 -0
- package/resources/beta/commerce/features.mjs +45 -0
- package/resources/beta/commerce/features.mjs.map +1 -0
- package/resources/beta/commerce/index.d.mts +4 -3
- package/resources/beta/commerce/index.d.mts.map +1 -1
- package/resources/beta/commerce/index.d.ts +4 -3
- package/resources/beta/commerce/index.d.ts.map +1 -1
- package/resources/beta/commerce/index.js +3 -1
- package/resources/beta/commerce/index.js.map +1 -1
- package/resources/beta/commerce/index.mjs +1 -0
- package/resources/beta/commerce/index.mjs.map +1 -1
- package/resources/beta/commerce/products/index.d.mts +2 -2
- package/resources/beta/commerce/products/index.d.mts.map +1 -1
- package/resources/beta/commerce/products/index.d.ts +2 -2
- package/resources/beta/commerce/products/index.d.ts.map +1 -1
- package/resources/beta/commerce/products/index.js.map +1 -1
- package/resources/beta/commerce/products/index.mjs.map +1 -1
- package/resources/beta/commerce/products/products.d.mts +17 -673
- package/resources/beta/commerce/products/products.d.mts.map +1 -1
- package/resources/beta/commerce/products/products.d.ts +17 -673
- package/resources/beta/commerce/products/products.d.ts.map +1 -1
- package/resources/beta/commerce/products/products.js +1 -4
- package/resources/beta/commerce/products/products.js.map +1 -1
- package/resources/beta/commerce/products/products.mjs +1 -4
- package/resources/beta/commerce/products/products.mjs.map +1 -1
- package/resources/beta/commerce/products/variants.d.mts +12 -540
- package/resources/beta/commerce/products/variants.d.mts.map +1 -1
- package/resources/beta/commerce/products/variants.d.ts +12 -540
- package/resources/beta/commerce/products/variants.d.ts.map +1 -1
- package/resources/beta/commerce/products/variants.js +4 -1
- package/resources/beta/commerce/products/variants.js.map +1 -1
- package/resources/beta/commerce/products/variants.mjs +4 -1
- package/resources/beta/commerce/products/variants.mjs.map +1 -1
- package/src/resources/beta/commerce/commerce.ts +57 -35
- package/src/resources/beta/commerce/coupons.ts +9 -231
- package/src/resources/beta/commerce/customers.ts +27 -291
- package/src/resources/beta/commerce/features.ts +175 -0
- package/src/resources/beta/commerce/index.ts +15 -15
- package/src/resources/beta/commerce/products/index.ts +4 -12
- package/src/resources/beta/commerce/products/products.ts +21 -800
- package/src/resources/beta/commerce/products/variants.ts +17 -658
- 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
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"customers.d.mts","sourceRoot":"","sources":["../../../src/resources/beta/commerce/customers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE;OAEtD,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;OAKG;IACH,MAAM,
|
|
1
|
+
{"version":3,"file":"customers.d.mts","sourceRoot":"","sources":["../../../src/resources/beta/commerce/customers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE;OAEtD,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;OAKG;IACH,MAAM,CAAC,IAAI,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAI1G;;;OAGG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC;IAIvB;;;OAGG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qBAAqB,EAAE,QAAQ,CAAC;IAI/C;;;OAGG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOtE;;;;OAIG;IACH,aAAa,CACX,UAAU,EAAE,MAAM,EAClB,IAAI,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAI5C;;;;OAIG;IACH,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAGnF;AAED,MAAM,MAAM,qBAAqB,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;AAE3D;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAE9C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;IAE3D;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;CACzD;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnC;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,eAAe,GAAG,IAAI,CAAC;KACtE;IAED;;OAEG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,UAAU,EAAE,OAAO,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,iBAAiB,GAAG,YAAY,GAAG,MAAM,GAAG,OAAO,CAAC;QAEnE;;WAEG;QACH,IAAI,CAAC,EAAE,aAAa,CAAC,IAAI,GAAG,IAAI,CAAC;KAClC;IAED,UAAiB,aAAa,CAAC;QAC7B;;WAEG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;SACf;KACF;IAED;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,oBAAoB,EAAE,OAAO,CAAC;QAE9B;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,oBAAoB,EAAE,MAAM,CAAC;QAE7B;;WAEG;QACH,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC;QAE9B;;WAEG;QACH,MAAM,EACF,QAAQ,GACR,UAAU,GACV,YAAY,GACZ,oBAAoB,GACpB,UAAU,GACV,QAAQ,GACR,UAAU,GACV,QAAQ,CAAC;QAEb;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,OAAO,CAAC,EAAE,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC;KACvC;IAED,UAAiB,YAAY,CAAC;QAC5B;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;QAED;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,kBAAmB,SAAQ,kBAAkB;IAC5D;;;OAGG;IACH,OAAO,CAAC,EAAE,kBAAkB,CAAC,OAAO,CAAC;IAErC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;;OAGG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}
|
|
@@ -9,17 +9,17 @@ export declare class Customers extends APIResource {
|
|
|
9
9
|
* recommends creating a customer immediately after creating the corresponding
|
|
10
10
|
* entity in your app.
|
|
11
11
|
*/
|
|
12
|
-
create(body?: CustomerCreateParams | null | undefined, options?: RequestOptions): APIPromise<
|
|
12
|
+
create(body?: CustomerCreateParams | null | undefined, options?: RequestOptions): APIPromise<Customer>;
|
|
13
13
|
/**
|
|
14
14
|
* Updates an existing customer. Use this to modify contact information or billing
|
|
15
15
|
* address. Only provided fields are updated; omitted fields remain unchanged.
|
|
16
16
|
*/
|
|
17
|
-
update(customerID: string, body?: CustomerUpdateParams | null | undefined, options?: RequestOptions): APIPromise<
|
|
17
|
+
update(customerID: string, body?: CustomerUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Customer>;
|
|
18
18
|
/**
|
|
19
19
|
* Retrieves a paginated list of all customers. Customers are the billable entities
|
|
20
20
|
* in your app—typically users, organizations, or projects.
|
|
21
21
|
*/
|
|
22
|
-
list(query?: CustomerListParams | null | undefined, options?: RequestOptions): PagePromise<
|
|
22
|
+
list(query?: CustomerListParams | null | undefined, options?: RequestOptions): PagePromise<CustomersCursorIDPage, Customer>;
|
|
23
23
|
/**
|
|
24
24
|
* Permanently deletes a customer. This also cancels any active subscriptions. This
|
|
25
25
|
* action cannot be undone.
|
|
@@ -38,12 +38,12 @@ export declare class Customers extends APIResource {
|
|
|
38
38
|
*/
|
|
39
39
|
get(customerID: string, options?: RequestOptions): APIPromise<CustomerGetResponse>;
|
|
40
40
|
}
|
|
41
|
-
export type
|
|
41
|
+
export type CustomersCursorIDPage = CursorIDPage<Customer>;
|
|
42
42
|
/**
|
|
43
43
|
* A billable customer. Represents the entity in your app that will be
|
|
44
44
|
* charged—typically a user, organization, or project.
|
|
45
45
|
*/
|
|
46
|
-
export interface
|
|
46
|
+
export interface Customer {
|
|
47
47
|
/**
|
|
48
48
|
* Unique identifier for the topic subscription
|
|
49
49
|
*/
|
|
@@ -55,7 +55,7 @@ export interface CustomerCreateResponse {
|
|
|
55
55
|
/**
|
|
56
56
|
* The customer's billing address
|
|
57
57
|
*/
|
|
58
|
-
address?:
|
|
58
|
+
address?: CustomerAddress | null;
|
|
59
59
|
/**
|
|
60
60
|
* The customer's email address for receipts and notifications
|
|
61
61
|
*/
|
|
@@ -69,158 +69,34 @@ export interface CustomerCreateResponse {
|
|
|
69
69
|
*/
|
|
70
70
|
phone?: string | null;
|
|
71
71
|
}
|
|
72
|
-
export declare namespace CustomerCreateResponse {
|
|
73
|
-
/**
|
|
74
|
-
* The customer's billing address
|
|
75
|
-
*/
|
|
76
|
-
interface Address {
|
|
77
|
-
/**
|
|
78
|
-
* City name
|
|
79
|
-
*/
|
|
80
|
-
city?: string | null;
|
|
81
|
-
/**
|
|
82
|
-
* Two-letter ISO country code
|
|
83
|
-
*/
|
|
84
|
-
country?: string | null;
|
|
85
|
-
/**
|
|
86
|
-
* Street address line 1
|
|
87
|
-
*/
|
|
88
|
-
line1?: string | null;
|
|
89
|
-
/**
|
|
90
|
-
* Street address line 2 (apartment, suite, etc.)
|
|
91
|
-
*/
|
|
92
|
-
line2?: string | null;
|
|
93
|
-
/**
|
|
94
|
-
* Postal or ZIP code
|
|
95
|
-
*/
|
|
96
|
-
postal_code?: string | null;
|
|
97
|
-
/**
|
|
98
|
-
* State, province, or region
|
|
99
|
-
*/
|
|
100
|
-
state?: string | null;
|
|
101
|
-
}
|
|
102
|
-
}
|
|
103
72
|
/**
|
|
104
|
-
*
|
|
105
|
-
* charged—typically a user, organization, or project.
|
|
73
|
+
* The customer's billing address
|
|
106
74
|
*/
|
|
107
|
-
export interface
|
|
108
|
-
/**
|
|
109
|
-
* Unique identifier for the topic subscription
|
|
110
|
-
*/
|
|
111
|
-
id: string;
|
|
112
|
-
/**
|
|
113
|
-
* Timestamp when the customer was created
|
|
114
|
-
*/
|
|
115
|
-
created: string;
|
|
75
|
+
export interface CustomerAddress {
|
|
116
76
|
/**
|
|
117
|
-
*
|
|
77
|
+
* City name
|
|
118
78
|
*/
|
|
119
|
-
|
|
120
|
-
/**
|
|
121
|
-
* The customer's email address for receipts and notifications
|
|
122
|
-
*/
|
|
123
|
-
email?: string | null;
|
|
124
|
-
/**
|
|
125
|
-
* The customer's full name
|
|
126
|
-
*/
|
|
127
|
-
name?: string | null;
|
|
79
|
+
city?: string | null;
|
|
128
80
|
/**
|
|
129
|
-
*
|
|
130
|
-
*/
|
|
131
|
-
phone?: string | null;
|
|
132
|
-
}
|
|
133
|
-
export declare namespace CustomerUpdateResponse {
|
|
134
|
-
/**
|
|
135
|
-
* The customer's billing address
|
|
136
|
-
*/
|
|
137
|
-
interface Address {
|
|
138
|
-
/**
|
|
139
|
-
* City name
|
|
140
|
-
*/
|
|
141
|
-
city?: string | null;
|
|
142
|
-
/**
|
|
143
|
-
* Two-letter ISO country code
|
|
144
|
-
*/
|
|
145
|
-
country?: string | null;
|
|
146
|
-
/**
|
|
147
|
-
* Street address line 1
|
|
148
|
-
*/
|
|
149
|
-
line1?: string | null;
|
|
150
|
-
/**
|
|
151
|
-
* Street address line 2 (apartment, suite, etc.)
|
|
152
|
-
*/
|
|
153
|
-
line2?: string | null;
|
|
154
|
-
/**
|
|
155
|
-
* Postal or ZIP code
|
|
156
|
-
*/
|
|
157
|
-
postal_code?: string | null;
|
|
158
|
-
/**
|
|
159
|
-
* State, province, or region
|
|
160
|
-
*/
|
|
161
|
-
state?: string | null;
|
|
162
|
-
}
|
|
163
|
-
}
|
|
164
|
-
/**
|
|
165
|
-
* A billable customer. Represents the entity in your app that will be
|
|
166
|
-
* charged—typically a user, organization, or project.
|
|
167
|
-
*/
|
|
168
|
-
export interface CustomerListResponse {
|
|
169
|
-
/**
|
|
170
|
-
* Unique identifier for the topic subscription
|
|
171
|
-
*/
|
|
172
|
-
id: string;
|
|
173
|
-
/**
|
|
174
|
-
* Timestamp when the customer was created
|
|
175
|
-
*/
|
|
176
|
-
created: string;
|
|
177
|
-
/**
|
|
178
|
-
* The customer's billing address
|
|
81
|
+
* Two-letter ISO country code
|
|
179
82
|
*/
|
|
180
|
-
|
|
83
|
+
country?: string | null;
|
|
181
84
|
/**
|
|
182
|
-
*
|
|
85
|
+
* Street address line 1
|
|
183
86
|
*/
|
|
184
|
-
|
|
87
|
+
line1?: string | null;
|
|
185
88
|
/**
|
|
186
|
-
*
|
|
89
|
+
* Street address line 2 (apartment, suite, etc.)
|
|
187
90
|
*/
|
|
188
|
-
|
|
91
|
+
line2?: string | null;
|
|
189
92
|
/**
|
|
190
|
-
*
|
|
93
|
+
* Postal or ZIP code
|
|
191
94
|
*/
|
|
192
|
-
|
|
193
|
-
}
|
|
194
|
-
export declare namespace CustomerListResponse {
|
|
95
|
+
postal_code?: string | null;
|
|
195
96
|
/**
|
|
196
|
-
*
|
|
97
|
+
* State, province, or region
|
|
197
98
|
*/
|
|
198
|
-
|
|
199
|
-
/**
|
|
200
|
-
* City name
|
|
201
|
-
*/
|
|
202
|
-
city?: string | null;
|
|
203
|
-
/**
|
|
204
|
-
* Two-letter ISO country code
|
|
205
|
-
*/
|
|
206
|
-
country?: string | null;
|
|
207
|
-
/**
|
|
208
|
-
* Street address line 1
|
|
209
|
-
*/
|
|
210
|
-
line1?: string | null;
|
|
211
|
-
/**
|
|
212
|
-
* Street address line 2 (apartment, suite, etc.)
|
|
213
|
-
*/
|
|
214
|
-
line2?: string | null;
|
|
215
|
-
/**
|
|
216
|
-
* Postal or ZIP code
|
|
217
|
-
*/
|
|
218
|
-
postal_code?: string | null;
|
|
219
|
-
/**
|
|
220
|
-
* State, province, or region
|
|
221
|
-
*/
|
|
222
|
-
state?: string | null;
|
|
223
|
-
}
|
|
99
|
+
state?: string | null;
|
|
224
100
|
}
|
|
225
101
|
/**
|
|
226
102
|
* Response containing the billing portal URL
|
|
@@ -247,7 +123,7 @@ export interface CustomerGetResponse {
|
|
|
247
123
|
/**
|
|
248
124
|
* The customer's billing address
|
|
249
125
|
*/
|
|
250
|
-
address?:
|
|
126
|
+
address?: CustomerAddress | null;
|
|
251
127
|
/**
|
|
252
128
|
* The customer's email address for receipts and notifications
|
|
253
129
|
*/
|
|
@@ -274,35 +150,6 @@ export interface CustomerGetResponse {
|
|
|
274
150
|
subscriptions?: Array<CustomerGetResponse.Subscription>;
|
|
275
151
|
}
|
|
276
152
|
export declare namespace CustomerGetResponse {
|
|
277
|
-
/**
|
|
278
|
-
* The customer's billing address
|
|
279
|
-
*/
|
|
280
|
-
interface Address {
|
|
281
|
-
/**
|
|
282
|
-
* City name
|
|
283
|
-
*/
|
|
284
|
-
city?: string | null;
|
|
285
|
-
/**
|
|
286
|
-
* Two-letter ISO country code
|
|
287
|
-
*/
|
|
288
|
-
country?: string | null;
|
|
289
|
-
/**
|
|
290
|
-
* Street address line 1
|
|
291
|
-
*/
|
|
292
|
-
line1?: string | null;
|
|
293
|
-
/**
|
|
294
|
-
* Street address line 2 (apartment, suite, etc.)
|
|
295
|
-
*/
|
|
296
|
-
line2?: string | null;
|
|
297
|
-
/**
|
|
298
|
-
* Postal or ZIP code
|
|
299
|
-
*/
|
|
300
|
-
postal_code?: string | null;
|
|
301
|
-
/**
|
|
302
|
-
* State, province, or region
|
|
303
|
-
*/
|
|
304
|
-
state?: string | null;
|
|
305
|
-
}
|
|
306
153
|
/**
|
|
307
154
|
* An invoice for a customer
|
|
308
155
|
*/
|
|
@@ -507,7 +354,7 @@ export interface CustomerCreateParams {
|
|
|
507
354
|
/**
|
|
508
355
|
* The customer's billing address
|
|
509
356
|
*/
|
|
510
|
-
address?:
|
|
357
|
+
address?: CustomerAddress;
|
|
511
358
|
/**
|
|
512
359
|
* The customer's email address for receipts and notifications
|
|
513
360
|
*/
|
|
@@ -521,42 +368,11 @@ export interface CustomerCreateParams {
|
|
|
521
368
|
*/
|
|
522
369
|
phone?: string;
|
|
523
370
|
}
|
|
524
|
-
export declare namespace CustomerCreateParams {
|
|
525
|
-
/**
|
|
526
|
-
* The customer's billing address
|
|
527
|
-
*/
|
|
528
|
-
interface Address {
|
|
529
|
-
/**
|
|
530
|
-
* City name
|
|
531
|
-
*/
|
|
532
|
-
city?: string | null;
|
|
533
|
-
/**
|
|
534
|
-
* Two-letter ISO country code
|
|
535
|
-
*/
|
|
536
|
-
country?: string | null;
|
|
537
|
-
/**
|
|
538
|
-
* Street address line 1
|
|
539
|
-
*/
|
|
540
|
-
line1?: string | null;
|
|
541
|
-
/**
|
|
542
|
-
* Street address line 2 (apartment, suite, etc.)
|
|
543
|
-
*/
|
|
544
|
-
line2?: string | null;
|
|
545
|
-
/**
|
|
546
|
-
* Postal or ZIP code
|
|
547
|
-
*/
|
|
548
|
-
postal_code?: string | null;
|
|
549
|
-
/**
|
|
550
|
-
* State, province, or region
|
|
551
|
-
*/
|
|
552
|
-
state?: string | null;
|
|
553
|
-
}
|
|
554
|
-
}
|
|
555
371
|
export interface CustomerUpdateParams {
|
|
556
372
|
/**
|
|
557
373
|
* The customer's billing address
|
|
558
374
|
*/
|
|
559
|
-
address?:
|
|
375
|
+
address?: CustomerAddress;
|
|
560
376
|
/**
|
|
561
377
|
* The customer's email address for receipts and notifications
|
|
562
378
|
*/
|
|
@@ -570,37 +386,6 @@ export interface CustomerUpdateParams {
|
|
|
570
386
|
*/
|
|
571
387
|
phone?: string;
|
|
572
388
|
}
|
|
573
|
-
export declare namespace CustomerUpdateParams {
|
|
574
|
-
/**
|
|
575
|
-
* The customer's billing address
|
|
576
|
-
*/
|
|
577
|
-
interface Address {
|
|
578
|
-
/**
|
|
579
|
-
* City name
|
|
580
|
-
*/
|
|
581
|
-
city?: string | null;
|
|
582
|
-
/**
|
|
583
|
-
* Two-letter ISO country code
|
|
584
|
-
*/
|
|
585
|
-
country?: string | null;
|
|
586
|
-
/**
|
|
587
|
-
* Street address line 1
|
|
588
|
-
*/
|
|
589
|
-
line1?: string | null;
|
|
590
|
-
/**
|
|
591
|
-
* Street address line 2 (apartment, suite, etc.)
|
|
592
|
-
*/
|
|
593
|
-
line2?: string | null;
|
|
594
|
-
/**
|
|
595
|
-
* Postal or ZIP code
|
|
596
|
-
*/
|
|
597
|
-
postal_code?: string | null;
|
|
598
|
-
/**
|
|
599
|
-
* State, province, or region
|
|
600
|
-
*/
|
|
601
|
-
state?: string | null;
|
|
602
|
-
}
|
|
603
|
-
}
|
|
604
389
|
export interface CustomerListParams extends CursorIDPageParams {
|
|
605
390
|
/**
|
|
606
391
|
* Filter by creation date. Accepts an object with gt, gte, lt, lte operators using
|
|
@@ -653,6 +438,6 @@ export interface CustomerBillingPortalParams {
|
|
|
653
438
|
return_url?: string;
|
|
654
439
|
}
|
|
655
440
|
export declare namespace Customers {
|
|
656
|
-
export { type
|
|
441
|
+
export { type Customer as Customer, type CustomerAddress as CustomerAddress, type CustomerBillingPortalResponse as CustomerBillingPortalResponse, type CustomerGetResponse as CustomerGetResponse, type CustomersCursorIDPage as CustomersCursorIDPage, type CustomerCreateParams as CustomerCreateParams, type CustomerUpdateParams as CustomerUpdateParams, type CustomerListParams as CustomerListParams, type CustomerBillingPortalParams as CustomerBillingPortalParams, };
|
|
657
442
|
}
|
|
658
443
|
//# sourceMappingURL=customers.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"customers.d.ts","sourceRoot":"","sources":["../../../src/resources/beta/commerce/customers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE;OAEtD,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;OAKG;IACH,MAAM,
|
|
1
|
+
{"version":3,"file":"customers.d.ts","sourceRoot":"","sources":["../../../src/resources/beta/commerce/customers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE;OAEtD,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;OAKG;IACH,MAAM,CAAC,IAAI,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAI1G;;;OAGG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC;IAIvB;;;OAGG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qBAAqB,EAAE,QAAQ,CAAC;IAI/C;;;OAGG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOtE;;;;OAIG;IACH,aAAa,CACX,UAAU,EAAE,MAAM,EAClB,IAAI,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAI5C;;;;OAIG;IACH,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAGnF;AAED,MAAM,MAAM,qBAAqB,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;AAE3D;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAE9C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;IAE3D;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;CACzD;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnC;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,eAAe,GAAG,IAAI,CAAC;KACtE;IAED;;OAEG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,UAAU,EAAE,OAAO,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,iBAAiB,GAAG,YAAY,GAAG,MAAM,GAAG,OAAO,CAAC;QAEnE;;WAEG;QACH,IAAI,CAAC,EAAE,aAAa,CAAC,IAAI,GAAG,IAAI,CAAC;KAClC;IAED,UAAiB,aAAa,CAAC;QAC7B;;WAEG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;SACf;KACF;IAED;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,oBAAoB,EAAE,OAAO,CAAC;QAE9B;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,oBAAoB,EAAE,MAAM,CAAC;QAE7B;;WAEG;QACH,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC;QAE9B;;WAEG;QACH,MAAM,EACF,QAAQ,GACR,UAAU,GACV,YAAY,GACZ,oBAAoB,GACpB,UAAU,GACV,QAAQ,GACR,UAAU,GACV,QAAQ,CAAC;QAEb;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,OAAO,CAAC,EAAE,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC;KACvC;IAED,UAAiB,YAAY,CAAC;QAC5B;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;QAED;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,kBAAmB,SAAQ,kBAAkB;IAC5D;;;OAGG;IACH,OAAO,CAAC,EAAE,kBAAkB,CAAC,OAAO,CAAC;IAErC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;;OAGG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}
|
|
@@ -28,10 +28,7 @@ class Customers extends resource_1.APIResource {
|
|
|
28
28
|
* in your app—typically users, organizations, or projects.
|
|
29
29
|
*/
|
|
30
30
|
list(query = {}, options) {
|
|
31
|
-
return this._client.getAPIList('/v1/commerce/customers', (pagination_1.CursorIDPage), {
|
|
32
|
-
query,
|
|
33
|
-
...options,
|
|
34
|
-
});
|
|
31
|
+
return this._client.getAPIList('/v1/commerce/customers', (pagination_1.CursorIDPage), { query, ...options });
|
|
35
32
|
}
|
|
36
33
|
/**
|
|
37
34
|
* Permanently deletes a customer. This also cancels any active subscriptions. This
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"customers.js","sourceRoot":"","sources":["../../../src/resources/beta/commerce/customers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAErD,4DAA8F;AAC9F,0DAAyD;AAEzD,0DAAoD;AAEpD,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;OAKG;IACH,MAAM,
|
|
1
|
+
{"version":3,"file":"customers.js","sourceRoot":"","sources":["../../../src/resources/beta/commerce/customers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAErD,4DAA8F;AAC9F,0DAAyD;AAEzD,0DAAoD;AAEpD,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;OAKG;IACH,MAAM,CAAC,OAAgD,EAAE,EAAE,OAAwB;QACjF,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;OAGG;IACH,MAAM,CACJ,UAAkB,EAClB,OAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,0BAA0B,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;OAGG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,wBAAwB,EAAE,CAAA,yBAAsB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,UAAkB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,0BAA0B,UAAU,EAAE,EAAE;YACrE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,aAAa,CACX,UAAkB,EAClB,OAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,0BAA0B,UAAU,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5G,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,UAAkB,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;CACF;AAlED,8BAkEC"}
|
|
@@ -25,10 +25,7 @@ export class Customers extends APIResource {
|
|
|
25
25
|
* in your app—typically users, organizations, or projects.
|
|
26
26
|
*/
|
|
27
27
|
list(query = {}, options) {
|
|
28
|
-
return this._client.getAPIList('/v1/commerce/customers', (CursorIDPage), {
|
|
29
|
-
query,
|
|
30
|
-
...options,
|
|
31
|
-
});
|
|
28
|
+
return this._client.getAPIList('/v1/commerce/customers', (CursorIDPage), { query, ...options });
|
|
32
29
|
}
|
|
33
30
|
/**
|
|
34
31
|
* Permanently deletes a customer. This also cancels any active subscriptions. This
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"customers.mjs","sourceRoot":"","sources":["../../../src/resources/beta/commerce/customers.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAwC;OACtD,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;OAKG;IACH,MAAM,
|
|
1
|
+
{"version":3,"file":"customers.mjs","sourceRoot":"","sources":["../../../src/resources/beta/commerce/customers.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAwC;OACtD,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;OAKG;IACH,MAAM,CAAC,OAAgD,EAAE,EAAE,OAAwB;QACjF,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;OAGG;IACH,MAAM,CACJ,UAAkB,EAClB,OAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,0BAA0B,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;OAGG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,wBAAwB,EAAE,CAAA,YAAsB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,UAAkB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,0BAA0B,UAAU,EAAE,EAAE;YACrE,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,aAAa,CACX,UAAkB,EAClB,OAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,0BAA0B,UAAU,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5G,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,UAAkB,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;CACF"}
|
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
import { APIResource } from "../../../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../../../core/api-promise.mjs";
|
|
3
|
+
import { CursorIDPage, type CursorIDPageParams, PagePromise } from "../../../core/pagination.mjs";
|
|
4
|
+
import { RequestOptions } from "../../../internal/request-options.mjs";
|
|
5
|
+
export declare class Features extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Creates a new feature with a lookup key. Features can be attached to multiple
|
|
8
|
+
* products to grant customers access to the same entitlement across different
|
|
9
|
+
* subscription tiers.
|
|
10
|
+
*/
|
|
11
|
+
create(body: FeatureCreateParams, options?: RequestOptions): APIPromise<Feature>;
|
|
12
|
+
/**
|
|
13
|
+
* Updates an existing feature. Use this to modify metadata or active status.
|
|
14
|
+
*/
|
|
15
|
+
update(featureID: string, body?: FeatureUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Feature>;
|
|
16
|
+
/**
|
|
17
|
+
* Retrieves a paginated list of features. Features are reusable entitlements that
|
|
18
|
+
* can be attached to multiple products.
|
|
19
|
+
*/
|
|
20
|
+
list(query?: FeatureListParams | null | undefined, options?: RequestOptions): PagePromise<FeaturesCursorIDPage, Feature>;
|
|
21
|
+
/**
|
|
22
|
+
* Deletes a feature. This will also remove all product attachments for this
|
|
23
|
+
* feature.
|
|
24
|
+
*/
|
|
25
|
+
delete(featureID: string, options?: RequestOptions): APIPromise<void>;
|
|
26
|
+
/**
|
|
27
|
+
* Retrieves a feature by ID.
|
|
28
|
+
*/
|
|
29
|
+
get(featureID: string, options?: RequestOptions): APIPromise<Feature>;
|
|
30
|
+
}
|
|
31
|
+
export type FeaturesCursorIDPage = CursorIDPage<Feature>;
|
|
32
|
+
/**
|
|
33
|
+
* A feature that can be attached to multiple products. Features represent
|
|
34
|
+
* monetizable content or functionality in your app.
|
|
35
|
+
*/
|
|
36
|
+
export interface Feature {
|
|
37
|
+
/**
|
|
38
|
+
* Unique identifier for the topic subscription
|
|
39
|
+
*/
|
|
40
|
+
id: string;
|
|
41
|
+
/**
|
|
42
|
+
* Whether the feature is active
|
|
43
|
+
*/
|
|
44
|
+
active: boolean;
|
|
45
|
+
/**
|
|
46
|
+
* Timestamp when the feature was created
|
|
47
|
+
*/
|
|
48
|
+
created: string;
|
|
49
|
+
/**
|
|
50
|
+
* Description of what this feature provides
|
|
51
|
+
*/
|
|
52
|
+
description: string | null;
|
|
53
|
+
/**
|
|
54
|
+
* The lookup key used to check access (e.g., 'feature.pro_features')
|
|
55
|
+
*/
|
|
56
|
+
lookup_key: string;
|
|
57
|
+
/**
|
|
58
|
+
* Human-readable name for the feature
|
|
59
|
+
*/
|
|
60
|
+
name: string;
|
|
61
|
+
/**
|
|
62
|
+
* Type of feature
|
|
63
|
+
*/
|
|
64
|
+
type: 'feature';
|
|
65
|
+
/**
|
|
66
|
+
* Custom metadata for the feature
|
|
67
|
+
*/
|
|
68
|
+
metadata?: {
|
|
69
|
+
[key: string]: unknown;
|
|
70
|
+
};
|
|
71
|
+
}
|
|
72
|
+
export interface FeatureCreateParams {
|
|
73
|
+
/**
|
|
74
|
+
* The lookup key used to check access. Will be prefixed with 'feature.'
|
|
75
|
+
* automatically.
|
|
76
|
+
*/
|
|
77
|
+
lookup_key: string;
|
|
78
|
+
/**
|
|
79
|
+
* Human-readable name for the feature
|
|
80
|
+
*/
|
|
81
|
+
name: string;
|
|
82
|
+
/**
|
|
83
|
+
* Optional custom ID for the feature. Must start with 'feat\_'. If not provided,
|
|
84
|
+
* one will be generated.
|
|
85
|
+
*/
|
|
86
|
+
id?: string;
|
|
87
|
+
/**
|
|
88
|
+
* Description of what this feature provides
|
|
89
|
+
*/
|
|
90
|
+
description?: string;
|
|
91
|
+
/**
|
|
92
|
+
* Custom metadata for the feature
|
|
93
|
+
*/
|
|
94
|
+
metadata?: {
|
|
95
|
+
[key: string]: unknown;
|
|
96
|
+
};
|
|
97
|
+
}
|
|
98
|
+
export interface FeatureUpdateParams {
|
|
99
|
+
/**
|
|
100
|
+
* Whether the feature is active
|
|
101
|
+
*/
|
|
102
|
+
active?: boolean;
|
|
103
|
+
/**
|
|
104
|
+
* Description of what this feature provides
|
|
105
|
+
*/
|
|
106
|
+
description?: string | null;
|
|
107
|
+
/**
|
|
108
|
+
* Custom metadata for the feature
|
|
109
|
+
*/
|
|
110
|
+
metadata?: {
|
|
111
|
+
[key: string]: unknown;
|
|
112
|
+
};
|
|
113
|
+
/**
|
|
114
|
+
* Human-readable name for the feature
|
|
115
|
+
*/
|
|
116
|
+
name?: string;
|
|
117
|
+
}
|
|
118
|
+
export interface FeatureListParams extends CursorIDPageParams {
|
|
119
|
+
/**
|
|
120
|
+
* Filter by active status
|
|
121
|
+
*/
|
|
122
|
+
active?: 'true' | 'false';
|
|
123
|
+
}
|
|
124
|
+
export declare namespace Features {
|
|
125
|
+
export { type Feature as Feature, type FeaturesCursorIDPage as FeaturesCursorIDPage, type FeatureCreateParams as FeatureCreateParams, type FeatureUpdateParams as FeatureUpdateParams, type FeatureListParams as FeatureListParams, };
|
|
126
|
+
}
|
|
127
|
+
//# sourceMappingURL=features.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"features.d.mts","sourceRoot":"","sources":["../../../src/resources/beta/commerce/features.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE;OAEtD,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAIhF;;OAEG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAItB;;;OAGG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oBAAoB,EAAE,OAAO,CAAC;IAI7C;;;OAGG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOrE;;OAEG;IACH,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;CAGtE;AAED,MAAM,MAAM,oBAAoB,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;AAEzD;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,SAAS,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACvC;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACvC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,iBAAkB,SAAQ,kBAAkB;IAC3D;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
|