@stigg/typescript 0.1.0-alpha.24 → 0.1.0-alpha.26
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 +35 -0
- package/client.d.mts +3 -0
- package/client.d.mts.map +1 -1
- package/client.d.ts +3 -0
- package/client.d.ts.map +1 -1
- package/client.js +3 -0
- package/client.js.map +1 -1
- package/client.mjs +3 -0
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/index.d.mts +1 -0
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +1 -0
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/internal/beta/beta.d.mts +10 -0
- package/resources/internal/beta/beta.d.mts.map +1 -0
- package/resources/internal/beta/beta.d.ts +10 -0
- package/resources/internal/beta/beta.d.ts.map +1 -0
- package/resources/internal/beta/beta.js +17 -0
- package/resources/internal/beta/beta.js.map +1 -0
- package/resources/internal/beta/beta.mjs +12 -0
- package/resources/internal/beta/beta.mjs.map +1 -0
- package/resources/internal/beta/event-queues.d.mts +315 -0
- package/resources/internal/beta/event-queues.d.mts.map +1 -0
- package/resources/internal/beta/event-queues.d.ts +315 -0
- package/resources/internal/beta/event-queues.d.ts.map +1 -0
- package/resources/internal/beta/event-queues.js +40 -0
- package/resources/internal/beta/event-queues.js.map +1 -0
- package/resources/internal/beta/event-queues.mjs +36 -0
- package/resources/internal/beta/event-queues.mjs.map +1 -0
- package/resources/internal/beta/index.d.mts +3 -0
- package/resources/internal/beta/index.d.mts.map +1 -0
- package/resources/internal/beta/index.d.ts +3 -0
- package/resources/internal/beta/index.d.ts.map +1 -0
- package/resources/internal/beta/index.js +9 -0
- package/resources/internal/beta/index.js.map +1 -0
- package/resources/internal/beta/index.mjs +4 -0
- package/resources/internal/beta/index.mjs.map +1 -0
- package/resources/internal/beta.d.mts +2 -0
- package/resources/internal/beta.d.mts.map +1 -0
- package/resources/internal/beta.d.ts +2 -0
- package/resources/internal/beta.d.ts.map +1 -0
- package/resources/internal/beta.js +6 -0
- package/resources/internal/beta.js.map +1 -0
- package/resources/internal/beta.mjs +3 -0
- package/resources/internal/beta.mjs.map +1 -0
- package/resources/internal/index.d.mts +3 -0
- package/resources/internal/index.d.mts.map +1 -0
- package/resources/internal/index.d.ts +3 -0
- package/resources/internal/index.d.ts.map +1 -0
- package/resources/internal/index.js +9 -0
- package/resources/internal/index.js.map +1 -0
- package/resources/internal/index.mjs +4 -0
- package/resources/internal/index.mjs.map +1 -0
- package/resources/internal/internal.d.mts +10 -0
- package/resources/internal/internal.d.mts.map +1 -0
- package/resources/internal/internal.d.ts +10 -0
- package/resources/internal/internal.d.ts.map +1 -0
- package/resources/internal/internal.js +17 -0
- package/resources/internal/internal.js.map +1 -0
- package/resources/internal/internal.mjs +12 -0
- package/resources/internal/internal.mjs.map +1 -0
- package/resources/internal.d.mts +2 -0
- package/resources/internal.d.mts.map +1 -0
- package/resources/internal.d.ts +2 -0
- package/resources/internal.d.ts.map +1 -0
- package/resources/internal.js +6 -0
- package/resources/internal.js.map +1 -0
- package/resources/internal.mjs +3 -0
- package/resources/internal.mjs.map +1 -0
- package/resources/v1/customers/customers.d.mts +4 -0
- package/resources/v1/customers/customers.d.mts.map +1 -1
- package/resources/v1/customers/customers.d.ts +4 -0
- package/resources/v1/customers/customers.d.ts.map +1 -1
- package/resources/v1/customers/customers.js +4 -0
- package/resources/v1/customers/customers.js.map +1 -1
- package/resources/v1/customers/customers.mjs +4 -0
- package/resources/v1/customers/customers.mjs.map +1 -1
- package/resources/v1/customers/index.d.mts +1 -0
- package/resources/v1/customers/index.d.mts.map +1 -1
- package/resources/v1/customers/index.d.ts +1 -0
- package/resources/v1/customers/index.d.ts.map +1 -1
- package/resources/v1/customers/index.js +3 -1
- package/resources/v1/customers/index.js.map +1 -1
- package/resources/v1/customers/index.mjs +1 -0
- package/resources/v1/customers/index.mjs.map +1 -1
- package/resources/v1/customers/integrations.d.mts +441 -0
- package/resources/v1/customers/integrations.d.mts.map +1 -0
- package/resources/v1/customers/integrations.d.ts +441 -0
- package/resources/v1/customers/integrations.d.ts.map +1 -0
- package/resources/v1/customers/integrations.js +50 -0
- package/resources/v1/customers/integrations.js.map +1 -0
- package/resources/v1/customers/integrations.mjs +46 -0
- package/resources/v1/customers/integrations.mjs.map +1 -0
- package/resources/v1/subscriptions/subscriptions.d.mts +9 -0
- package/resources/v1/subscriptions/subscriptions.d.mts.map +1 -1
- package/resources/v1/subscriptions/subscriptions.d.ts +9 -0
- package/resources/v1/subscriptions/subscriptions.d.ts.map +1 -1
- package/resources/v1/subscriptions/subscriptions.js.map +1 -1
- package/resources/v1/subscriptions/subscriptions.mjs.map +1 -1
- package/src/client.ts +5 -0
- package/src/resources/index.ts +1 -0
- package/src/resources/internal/beta/beta.ts +33 -0
- package/src/resources/internal/beta/event-queues.ts +798 -0
- package/src/resources/internal/beta/index.ts +13 -0
- package/src/resources/internal/beta.ts +3 -0
- package/src/resources/internal/index.ts +4 -0
- package/src/resources/internal/internal.ts +15 -0
- package/src/resources/internal.ts +3 -0
- package/src/resources/v1/customers/customers.ts +32 -0
- package/src/resources/v1/customers/index.ts +14 -0
- package/src/resources/v1/customers/integrations.ts +644 -0
- package/src/resources/v1/subscriptions/subscriptions.ts +9 -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
|
@@ -0,0 +1,441 @@
|
|
|
1
|
+
import { APIResource } from "../../../core/resource.js";
|
|
2
|
+
import { APIPromise } from "../../../core/api-promise.js";
|
|
3
|
+
import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from "../../../core/pagination.js";
|
|
4
|
+
import { RequestOptions } from "../../../internal/request-options.js";
|
|
5
|
+
export declare class Integrations extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Retrieves a specific integration for a customer by integration ID.
|
|
8
|
+
*/
|
|
9
|
+
retrieve(integrationID: string, params: IntegrationRetrieveParams, options?: RequestOptions): APIPromise<IntegrationRetrieveResponse>;
|
|
10
|
+
/**
|
|
11
|
+
* Updates a customer's integration link, such as changing the synced external
|
|
12
|
+
* entity ID.
|
|
13
|
+
*/
|
|
14
|
+
update(integrationID: string, params: IntegrationUpdateParams, options?: RequestOptions): APIPromise<IntegrationUpdateResponse>;
|
|
15
|
+
/**
|
|
16
|
+
* Retrieves a paginated list of a customer's external integrations (billing, CRM,
|
|
17
|
+
* etc.).
|
|
18
|
+
*/
|
|
19
|
+
list(id: string, query?: IntegrationListParams | null | undefined, options?: RequestOptions): PagePromise<IntegrationListResponsesMyCursorIDPage, IntegrationListResponse>;
|
|
20
|
+
/**
|
|
21
|
+
* Links a customer to an external integration by specifying the vendor and
|
|
22
|
+
* external entity ID.
|
|
23
|
+
*/
|
|
24
|
+
link(id: string, body: IntegrationLinkParams, options?: RequestOptions): APIPromise<IntegrationLinkResponse>;
|
|
25
|
+
/**
|
|
26
|
+
* Removes the link between a customer and an external integration.
|
|
27
|
+
*/
|
|
28
|
+
unlink(integrationID: string, params: IntegrationUnlinkParams, options?: RequestOptions): APIPromise<IntegrationUnlinkResponse>;
|
|
29
|
+
}
|
|
30
|
+
export type IntegrationListResponsesMyCursorIDPage = MyCursorIDPage<IntegrationListResponse>;
|
|
31
|
+
/**
|
|
32
|
+
* Response object
|
|
33
|
+
*/
|
|
34
|
+
export interface IntegrationRetrieveResponse {
|
|
35
|
+
/**
|
|
36
|
+
* External billing or CRM integration link
|
|
37
|
+
*/
|
|
38
|
+
data: IntegrationRetrieveResponse.Data;
|
|
39
|
+
}
|
|
40
|
+
export declare namespace IntegrationRetrieveResponse {
|
|
41
|
+
/**
|
|
42
|
+
* External billing or CRM integration link
|
|
43
|
+
*/
|
|
44
|
+
interface Data {
|
|
45
|
+
/**
|
|
46
|
+
* Integration details
|
|
47
|
+
*/
|
|
48
|
+
id: string;
|
|
49
|
+
/**
|
|
50
|
+
* Synced entity id
|
|
51
|
+
*/
|
|
52
|
+
syncedEntityId: string | null;
|
|
53
|
+
/**
|
|
54
|
+
* The vendor identifier of integration
|
|
55
|
+
*/
|
|
56
|
+
vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
|
|
57
|
+
/**
|
|
58
|
+
* Price billing sync revision data containing billing ID, link URL, and price
|
|
59
|
+
* group package billing ID
|
|
60
|
+
*/
|
|
61
|
+
syncData?: Data.SyncRevisionPriceBillingData | Data.SyncRevisionBillingData | Data.SyncRevisionMarketplaceData | null;
|
|
62
|
+
}
|
|
63
|
+
namespace Data {
|
|
64
|
+
/**
|
|
65
|
+
* Price billing sync revision data containing billing ID, link URL, and price
|
|
66
|
+
* group package billing ID
|
|
67
|
+
*/
|
|
68
|
+
interface SyncRevisionPriceBillingData {
|
|
69
|
+
/**
|
|
70
|
+
* Billing integration id
|
|
71
|
+
*/
|
|
72
|
+
billingId: string;
|
|
73
|
+
/**
|
|
74
|
+
* Billing integration url
|
|
75
|
+
*/
|
|
76
|
+
billingLinkUrl: string;
|
|
77
|
+
/**
|
|
78
|
+
* Price group package billing id
|
|
79
|
+
*/
|
|
80
|
+
priceGroupPackageBillingId: string;
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* Billing sync revision data containing billing ID and link URL
|
|
84
|
+
*/
|
|
85
|
+
interface SyncRevisionBillingData {
|
|
86
|
+
/**
|
|
87
|
+
* Billing integration id
|
|
88
|
+
*/
|
|
89
|
+
billingId: string;
|
|
90
|
+
/**
|
|
91
|
+
* Billing integration url
|
|
92
|
+
*/
|
|
93
|
+
billingLinkUrl: string;
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
* Marketplace sync revision data containing dimensions
|
|
97
|
+
*/
|
|
98
|
+
interface SyncRevisionMarketplaceData {
|
|
99
|
+
/**
|
|
100
|
+
* Dimensions of the marketplace sync revision
|
|
101
|
+
*/
|
|
102
|
+
dimensions: string;
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
/**
|
|
107
|
+
* Response object
|
|
108
|
+
*/
|
|
109
|
+
export interface IntegrationUpdateResponse {
|
|
110
|
+
/**
|
|
111
|
+
* External billing or CRM integration link
|
|
112
|
+
*/
|
|
113
|
+
data: IntegrationUpdateResponse.Data;
|
|
114
|
+
}
|
|
115
|
+
export declare namespace IntegrationUpdateResponse {
|
|
116
|
+
/**
|
|
117
|
+
* External billing or CRM integration link
|
|
118
|
+
*/
|
|
119
|
+
interface Data {
|
|
120
|
+
/**
|
|
121
|
+
* Integration details
|
|
122
|
+
*/
|
|
123
|
+
id: string;
|
|
124
|
+
/**
|
|
125
|
+
* Synced entity id
|
|
126
|
+
*/
|
|
127
|
+
syncedEntityId: string | null;
|
|
128
|
+
/**
|
|
129
|
+
* The vendor identifier of integration
|
|
130
|
+
*/
|
|
131
|
+
vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
|
|
132
|
+
/**
|
|
133
|
+
* Price billing sync revision data containing billing ID, link URL, and price
|
|
134
|
+
* group package billing ID
|
|
135
|
+
*/
|
|
136
|
+
syncData?: Data.SyncRevisionPriceBillingData | Data.SyncRevisionBillingData | Data.SyncRevisionMarketplaceData | null;
|
|
137
|
+
}
|
|
138
|
+
namespace Data {
|
|
139
|
+
/**
|
|
140
|
+
* Price billing sync revision data containing billing ID, link URL, and price
|
|
141
|
+
* group package billing ID
|
|
142
|
+
*/
|
|
143
|
+
interface SyncRevisionPriceBillingData {
|
|
144
|
+
/**
|
|
145
|
+
* Billing integration id
|
|
146
|
+
*/
|
|
147
|
+
billingId: string;
|
|
148
|
+
/**
|
|
149
|
+
* Billing integration url
|
|
150
|
+
*/
|
|
151
|
+
billingLinkUrl: string;
|
|
152
|
+
/**
|
|
153
|
+
* Price group package billing id
|
|
154
|
+
*/
|
|
155
|
+
priceGroupPackageBillingId: string;
|
|
156
|
+
}
|
|
157
|
+
/**
|
|
158
|
+
* Billing sync revision data containing billing ID and link URL
|
|
159
|
+
*/
|
|
160
|
+
interface SyncRevisionBillingData {
|
|
161
|
+
/**
|
|
162
|
+
* Billing integration id
|
|
163
|
+
*/
|
|
164
|
+
billingId: string;
|
|
165
|
+
/**
|
|
166
|
+
* Billing integration url
|
|
167
|
+
*/
|
|
168
|
+
billingLinkUrl: string;
|
|
169
|
+
}
|
|
170
|
+
/**
|
|
171
|
+
* Marketplace sync revision data containing dimensions
|
|
172
|
+
*/
|
|
173
|
+
interface SyncRevisionMarketplaceData {
|
|
174
|
+
/**
|
|
175
|
+
* Dimensions of the marketplace sync revision
|
|
176
|
+
*/
|
|
177
|
+
dimensions: string;
|
|
178
|
+
}
|
|
179
|
+
}
|
|
180
|
+
}
|
|
181
|
+
/**
|
|
182
|
+
* External billing or CRM integration link
|
|
183
|
+
*/
|
|
184
|
+
export interface IntegrationListResponse {
|
|
185
|
+
/**
|
|
186
|
+
* Integration details
|
|
187
|
+
*/
|
|
188
|
+
id: string;
|
|
189
|
+
/**
|
|
190
|
+
* Synced entity id
|
|
191
|
+
*/
|
|
192
|
+
syncedEntityId: string | null;
|
|
193
|
+
/**
|
|
194
|
+
* The vendor identifier of integration
|
|
195
|
+
*/
|
|
196
|
+
vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
|
|
197
|
+
/**
|
|
198
|
+
* Price billing sync revision data containing billing ID, link URL, and price
|
|
199
|
+
* group package billing ID
|
|
200
|
+
*/
|
|
201
|
+
syncData?: IntegrationListResponse.SyncRevisionPriceBillingData | IntegrationListResponse.SyncRevisionBillingData | IntegrationListResponse.SyncRevisionMarketplaceData | null;
|
|
202
|
+
}
|
|
203
|
+
export declare namespace IntegrationListResponse {
|
|
204
|
+
/**
|
|
205
|
+
* Price billing sync revision data containing billing ID, link URL, and price
|
|
206
|
+
* group package billing ID
|
|
207
|
+
*/
|
|
208
|
+
interface SyncRevisionPriceBillingData {
|
|
209
|
+
/**
|
|
210
|
+
* Billing integration id
|
|
211
|
+
*/
|
|
212
|
+
billingId: string;
|
|
213
|
+
/**
|
|
214
|
+
* Billing integration url
|
|
215
|
+
*/
|
|
216
|
+
billingLinkUrl: string;
|
|
217
|
+
/**
|
|
218
|
+
* Price group package billing id
|
|
219
|
+
*/
|
|
220
|
+
priceGroupPackageBillingId: string;
|
|
221
|
+
}
|
|
222
|
+
/**
|
|
223
|
+
* Billing sync revision data containing billing ID and link URL
|
|
224
|
+
*/
|
|
225
|
+
interface SyncRevisionBillingData {
|
|
226
|
+
/**
|
|
227
|
+
* Billing integration id
|
|
228
|
+
*/
|
|
229
|
+
billingId: string;
|
|
230
|
+
/**
|
|
231
|
+
* Billing integration url
|
|
232
|
+
*/
|
|
233
|
+
billingLinkUrl: string;
|
|
234
|
+
}
|
|
235
|
+
/**
|
|
236
|
+
* Marketplace sync revision data containing dimensions
|
|
237
|
+
*/
|
|
238
|
+
interface SyncRevisionMarketplaceData {
|
|
239
|
+
/**
|
|
240
|
+
* Dimensions of the marketplace sync revision
|
|
241
|
+
*/
|
|
242
|
+
dimensions: string;
|
|
243
|
+
}
|
|
244
|
+
}
|
|
245
|
+
/**
|
|
246
|
+
* Response object
|
|
247
|
+
*/
|
|
248
|
+
export interface IntegrationLinkResponse {
|
|
249
|
+
/**
|
|
250
|
+
* External billing or CRM integration link
|
|
251
|
+
*/
|
|
252
|
+
data: IntegrationLinkResponse.Data;
|
|
253
|
+
}
|
|
254
|
+
export declare namespace IntegrationLinkResponse {
|
|
255
|
+
/**
|
|
256
|
+
* External billing or CRM integration link
|
|
257
|
+
*/
|
|
258
|
+
interface Data {
|
|
259
|
+
/**
|
|
260
|
+
* Integration details
|
|
261
|
+
*/
|
|
262
|
+
id: string;
|
|
263
|
+
/**
|
|
264
|
+
* Synced entity id
|
|
265
|
+
*/
|
|
266
|
+
syncedEntityId: string | null;
|
|
267
|
+
/**
|
|
268
|
+
* The vendor identifier of integration
|
|
269
|
+
*/
|
|
270
|
+
vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
|
|
271
|
+
/**
|
|
272
|
+
* Price billing sync revision data containing billing ID, link URL, and price
|
|
273
|
+
* group package billing ID
|
|
274
|
+
*/
|
|
275
|
+
syncData?: Data.SyncRevisionPriceBillingData | Data.SyncRevisionBillingData | Data.SyncRevisionMarketplaceData | null;
|
|
276
|
+
}
|
|
277
|
+
namespace Data {
|
|
278
|
+
/**
|
|
279
|
+
* Price billing sync revision data containing billing ID, link URL, and price
|
|
280
|
+
* group package billing ID
|
|
281
|
+
*/
|
|
282
|
+
interface SyncRevisionPriceBillingData {
|
|
283
|
+
/**
|
|
284
|
+
* Billing integration id
|
|
285
|
+
*/
|
|
286
|
+
billingId: string;
|
|
287
|
+
/**
|
|
288
|
+
* Billing integration url
|
|
289
|
+
*/
|
|
290
|
+
billingLinkUrl: string;
|
|
291
|
+
/**
|
|
292
|
+
* Price group package billing id
|
|
293
|
+
*/
|
|
294
|
+
priceGroupPackageBillingId: string;
|
|
295
|
+
}
|
|
296
|
+
/**
|
|
297
|
+
* Billing sync revision data containing billing ID and link URL
|
|
298
|
+
*/
|
|
299
|
+
interface SyncRevisionBillingData {
|
|
300
|
+
/**
|
|
301
|
+
* Billing integration id
|
|
302
|
+
*/
|
|
303
|
+
billingId: string;
|
|
304
|
+
/**
|
|
305
|
+
* Billing integration url
|
|
306
|
+
*/
|
|
307
|
+
billingLinkUrl: string;
|
|
308
|
+
}
|
|
309
|
+
/**
|
|
310
|
+
* Marketplace sync revision data containing dimensions
|
|
311
|
+
*/
|
|
312
|
+
interface SyncRevisionMarketplaceData {
|
|
313
|
+
/**
|
|
314
|
+
* Dimensions of the marketplace sync revision
|
|
315
|
+
*/
|
|
316
|
+
dimensions: string;
|
|
317
|
+
}
|
|
318
|
+
}
|
|
319
|
+
}
|
|
320
|
+
/**
|
|
321
|
+
* Response object
|
|
322
|
+
*/
|
|
323
|
+
export interface IntegrationUnlinkResponse {
|
|
324
|
+
/**
|
|
325
|
+
* External billing or CRM integration link
|
|
326
|
+
*/
|
|
327
|
+
data: IntegrationUnlinkResponse.Data;
|
|
328
|
+
}
|
|
329
|
+
export declare namespace IntegrationUnlinkResponse {
|
|
330
|
+
/**
|
|
331
|
+
* External billing or CRM integration link
|
|
332
|
+
*/
|
|
333
|
+
interface Data {
|
|
334
|
+
/**
|
|
335
|
+
* Integration details
|
|
336
|
+
*/
|
|
337
|
+
id: string;
|
|
338
|
+
/**
|
|
339
|
+
* Synced entity id
|
|
340
|
+
*/
|
|
341
|
+
syncedEntityId: string | null;
|
|
342
|
+
/**
|
|
343
|
+
* The vendor identifier of integration
|
|
344
|
+
*/
|
|
345
|
+
vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
|
|
346
|
+
/**
|
|
347
|
+
* Price billing sync revision data containing billing ID, link URL, and price
|
|
348
|
+
* group package billing ID
|
|
349
|
+
*/
|
|
350
|
+
syncData?: Data.SyncRevisionPriceBillingData | Data.SyncRevisionBillingData | Data.SyncRevisionMarketplaceData | null;
|
|
351
|
+
}
|
|
352
|
+
namespace Data {
|
|
353
|
+
/**
|
|
354
|
+
* Price billing sync revision data containing billing ID, link URL, and price
|
|
355
|
+
* group package billing ID
|
|
356
|
+
*/
|
|
357
|
+
interface SyncRevisionPriceBillingData {
|
|
358
|
+
/**
|
|
359
|
+
* Billing integration id
|
|
360
|
+
*/
|
|
361
|
+
billingId: string;
|
|
362
|
+
/**
|
|
363
|
+
* Billing integration url
|
|
364
|
+
*/
|
|
365
|
+
billingLinkUrl: string;
|
|
366
|
+
/**
|
|
367
|
+
* Price group package billing id
|
|
368
|
+
*/
|
|
369
|
+
priceGroupPackageBillingId: string;
|
|
370
|
+
}
|
|
371
|
+
/**
|
|
372
|
+
* Billing sync revision data containing billing ID and link URL
|
|
373
|
+
*/
|
|
374
|
+
interface SyncRevisionBillingData {
|
|
375
|
+
/**
|
|
376
|
+
* Billing integration id
|
|
377
|
+
*/
|
|
378
|
+
billingId: string;
|
|
379
|
+
/**
|
|
380
|
+
* Billing integration url
|
|
381
|
+
*/
|
|
382
|
+
billingLinkUrl: string;
|
|
383
|
+
}
|
|
384
|
+
/**
|
|
385
|
+
* Marketplace sync revision data containing dimensions
|
|
386
|
+
*/
|
|
387
|
+
interface SyncRevisionMarketplaceData {
|
|
388
|
+
/**
|
|
389
|
+
* Dimensions of the marketplace sync revision
|
|
390
|
+
*/
|
|
391
|
+
dimensions: string;
|
|
392
|
+
}
|
|
393
|
+
}
|
|
394
|
+
}
|
|
395
|
+
export interface IntegrationRetrieveParams {
|
|
396
|
+
/**
|
|
397
|
+
* Customer slug
|
|
398
|
+
*/
|
|
399
|
+
id: string;
|
|
400
|
+
}
|
|
401
|
+
export interface IntegrationUpdateParams {
|
|
402
|
+
/**
|
|
403
|
+
* Path param: Customer slug
|
|
404
|
+
*/
|
|
405
|
+
id: string;
|
|
406
|
+
/**
|
|
407
|
+
* Body param: Synced entity id
|
|
408
|
+
*/
|
|
409
|
+
syncedEntityId: string | null;
|
|
410
|
+
}
|
|
411
|
+
export interface IntegrationListParams extends MyCursorIDPageParams {
|
|
412
|
+
/**
|
|
413
|
+
* Filter by vendor identifier. Supports comma-separated values for multiple
|
|
414
|
+
* vendors (e.g., STRIPE,HUBSPOT)
|
|
415
|
+
*/
|
|
416
|
+
vendorIdentifier?: string;
|
|
417
|
+
}
|
|
418
|
+
export interface IntegrationLinkParams {
|
|
419
|
+
/**
|
|
420
|
+
* Integration details
|
|
421
|
+
*/
|
|
422
|
+
id: string;
|
|
423
|
+
/**
|
|
424
|
+
* Synced entity id
|
|
425
|
+
*/
|
|
426
|
+
syncedEntityId: string;
|
|
427
|
+
/**
|
|
428
|
+
* The vendor identifier of integration
|
|
429
|
+
*/
|
|
430
|
+
vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
|
|
431
|
+
}
|
|
432
|
+
export interface IntegrationUnlinkParams {
|
|
433
|
+
/**
|
|
434
|
+
* Customer slug
|
|
435
|
+
*/
|
|
436
|
+
id: string;
|
|
437
|
+
}
|
|
438
|
+
export declare namespace Integrations {
|
|
439
|
+
export { type IntegrationRetrieveResponse as IntegrationRetrieveResponse, type IntegrationUpdateResponse as IntegrationUpdateResponse, type IntegrationListResponse as IntegrationListResponse, type IntegrationLinkResponse as IntegrationLinkResponse, type IntegrationUnlinkResponse as IntegrationUnlinkResponse, type IntegrationListResponsesMyCursorIDPage as IntegrationListResponsesMyCursorIDPage, type IntegrationRetrieveParams as IntegrationRetrieveParams, type IntegrationUpdateParams as IntegrationUpdateParams, type IntegrationListParams as IntegrationListParams, type IntegrationLinkParams as IntegrationLinkParams, type IntegrationUnlinkParams as IntegrationUnlinkParams, };
|
|
440
|
+
}
|
|
441
|
+
//# sourceMappingURL=integrations.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"integrations.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/customers/integrations.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,WAAW,EAAE;OAC1D,EAAE,cAAc,EAAE;AAGzB,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,QAAQ,CACN,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,yBAAyB,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAK1C;;;OAGG;IACH,MAAM,CACJ,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAQxC;;;OAGG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,sCAAsC,EAAE,uBAAuB,CAAC;IAQ/E;;;OAGG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAItC;;OAEG;IACH,MAAM,CACJ,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;CAIzC;AAED,MAAM,MAAM,sCAAsC,GAAG,cAAc,CAAC,uBAAuB,CAAC,CAAC;AAE7F;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,IAAI,EAAE,2BAA2B,CAAC,IAAI,CAAC;CACxC;AAED,yBAAiB,2BAA2B,CAAC;IAC3C;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,gBAAgB,EACZ,OAAO,GACP,OAAO,GACP,QAAQ,GACR,SAAS,GACT,iBAAiB,GACjB,WAAW,GACX,YAAY,GACZ,WAAW,GACX,UAAU,GACV,WAAW,CAAC;QAEhB;;;WAGG;QACH,QAAQ,CAAC,EACL,IAAI,CAAC,4BAA4B,GACjC,IAAI,CAAC,uBAAuB,GAC5B,IAAI,CAAC,2BAA2B,GAChC,IAAI,CAAC;KACV;IAED,UAAiB,IAAI,CAAC;QACpB;;;WAGG;QACH,UAAiB,4BAA4B;YAC3C;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,cAAc,EAAE,MAAM,CAAC;YAEvB;;eAEG;YACH,0BAA0B,EAAE,MAAM,CAAC;SACpC;QAED;;WAEG;QACH,UAAiB,uBAAuB;YACtC;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,cAAc,EAAE,MAAM,CAAC;SACxB;QAED;;WAEG;QACH,UAAiB,2BAA2B;YAC1C;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;SACpB;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,EAAE,yBAAyB,CAAC,IAAI,CAAC;CACtC;AAED,yBAAiB,yBAAyB,CAAC;IACzC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,gBAAgB,EACZ,OAAO,GACP,OAAO,GACP,QAAQ,GACR,SAAS,GACT,iBAAiB,GACjB,WAAW,GACX,YAAY,GACZ,WAAW,GACX,UAAU,GACV,WAAW,CAAC;QAEhB;;;WAGG;QACH,QAAQ,CAAC,EACL,IAAI,CAAC,4BAA4B,GACjC,IAAI,CAAC,uBAAuB,GAC5B,IAAI,CAAC,2BAA2B,GAChC,IAAI,CAAC;KACV;IAED,UAAiB,IAAI,CAAC;QACpB;;;WAGG;QACH,UAAiB,4BAA4B;YAC3C;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,cAAc,EAAE,MAAM,CAAC;YAEvB;;eAEG;YACH,0BAA0B,EAAE,MAAM,CAAC;SACpC;QAED;;WAEG;QACH,UAAiB,uBAAuB;YACtC;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,cAAc,EAAE,MAAM,CAAC;SACxB;QAED;;WAEG;QACH,UAAiB,2BAA2B;YAC1C;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;SACpB;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,gBAAgB,EACZ,OAAO,GACP,OAAO,GACP,QAAQ,GACR,SAAS,GACT,iBAAiB,GACjB,WAAW,GACX,YAAY,GACZ,WAAW,GACX,UAAU,GACV,WAAW,CAAC;IAEhB;;;OAGG;IACH,QAAQ,CAAC,EACL,uBAAuB,CAAC,4BAA4B,GACpD,uBAAuB,CAAC,uBAAuB,GAC/C,uBAAuB,CAAC,2BAA2B,GACnD,IAAI,CAAC;CACV;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;;OAGG;IACH,UAAiB,4BAA4B;QAC3C;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,0BAA0B,EAAE,MAAM,CAAC;KACpC;IAED;;OAEG;IACH,UAAiB,uBAAuB;QACtC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;KACxB;IAED;;OAEG;IACH,UAAiB,2BAA2B;QAC1C;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC;CACpC;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,gBAAgB,EACZ,OAAO,GACP,OAAO,GACP,QAAQ,GACR,SAAS,GACT,iBAAiB,GACjB,WAAW,GACX,YAAY,GACZ,WAAW,GACX,UAAU,GACV,WAAW,CAAC;QAEhB;;;WAGG;QACH,QAAQ,CAAC,EACL,IAAI,CAAC,4BAA4B,GACjC,IAAI,CAAC,uBAAuB,GAC5B,IAAI,CAAC,2BAA2B,GAChC,IAAI,CAAC;KACV;IAED,UAAiB,IAAI,CAAC;QACpB;;;WAGG;QACH,UAAiB,4BAA4B;YAC3C;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,cAAc,EAAE,MAAM,CAAC;YAEvB;;eAEG;YACH,0BAA0B,EAAE,MAAM,CAAC;SACpC;QAED;;WAEG;QACH,UAAiB,uBAAuB;YACtC;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,cAAc,EAAE,MAAM,CAAC;SACxB;QAED;;WAEG;QACH,UAAiB,2BAA2B;YAC1C;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;SACpB;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,EAAE,yBAAyB,CAAC,IAAI,CAAC;CACtC;AAED,yBAAiB,yBAAyB,CAAC;IACzC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,gBAAgB,EACZ,OAAO,GACP,OAAO,GACP,QAAQ,GACR,SAAS,GACT,iBAAiB,GACjB,WAAW,GACX,YAAY,GACZ,WAAW,GACX,UAAU,GACV,WAAW,CAAC;QAEhB;;;WAGG;QACH,QAAQ,CAAC,EACL,IAAI,CAAC,4BAA4B,GACjC,IAAI,CAAC,uBAAuB,GAC5B,IAAI,CAAC,2BAA2B,GAChC,IAAI,CAAC;KACV;IAED,UAAiB,IAAI,CAAC;QACpB;;;WAGG;QACH,UAAiB,4BAA4B;YAC3C;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,cAAc,EAAE,MAAM,CAAC;YAEvB;;eAEG;YACH,0BAA0B,EAAE,MAAM,CAAC;SACpC;QAED;;WAEG;QACH,UAAiB,uBAAuB;YACtC;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,cAAc,EAAE,MAAM,CAAC;SACxB;QAED;;WAEG;QACH,UAAiB,2BAA2B;YAC1C;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;SACpB;KACF;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,WAAW,qBAAsB,SAAQ,oBAAoB;IACjE;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,gBAAgB,EACZ,OAAO,GACP,OAAO,GACP,QAAQ,GACR,SAAS,GACT,iBAAiB,GACjB,WAAW,GACX,YAAY,GACZ,WAAW,GACX,UAAU,GACV,WAAW,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.Integrations = void 0;
|
|
5
|
+
const resource_1 = require("../../../core/resource.js");
|
|
6
|
+
const pagination_1 = require("../../../core/pagination.js");
|
|
7
|
+
const path_1 = require("../../../internal/utils/path.js");
|
|
8
|
+
class Integrations extends resource_1.APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* Retrieves a specific integration for a customer by integration ID.
|
|
11
|
+
*/
|
|
12
|
+
retrieve(integrationID, params, options) {
|
|
13
|
+
const { id } = params;
|
|
14
|
+
return this._client.get((0, path_1.path) `/api/v1/customers/${id}/integrations/${integrationID}`, options);
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* Updates a customer's integration link, such as changing the synced external
|
|
18
|
+
* entity ID.
|
|
19
|
+
*/
|
|
20
|
+
update(integrationID, params, options) {
|
|
21
|
+
const { id, ...body } = params;
|
|
22
|
+
return this._client.patch((0, path_1.path) `/api/v1/customers/${id}/integrations/${integrationID}`, {
|
|
23
|
+
body,
|
|
24
|
+
...options,
|
|
25
|
+
});
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Retrieves a paginated list of a customer's external integrations (billing, CRM,
|
|
29
|
+
* etc.).
|
|
30
|
+
*/
|
|
31
|
+
list(id, query = {}, options) {
|
|
32
|
+
return this._client.getAPIList((0, path_1.path) `/api/v1/customers/${id}/integrations`, (pagination_1.MyCursorIDPage), { query, ...options });
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* Links a customer to an external integration by specifying the vendor and
|
|
36
|
+
* external entity ID.
|
|
37
|
+
*/
|
|
38
|
+
link(id, body, options) {
|
|
39
|
+
return this._client.post((0, path_1.path) `/api/v1/customers/${id}/integrations`, { body, ...options });
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* Removes the link between a customer and an external integration.
|
|
43
|
+
*/
|
|
44
|
+
unlink(integrationID, params, options) {
|
|
45
|
+
const { id } = params;
|
|
46
|
+
return this._client.delete((0, path_1.path) `/api/v1/customers/${id}/integrations/${integrationID}`, options);
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
exports.Integrations = Integrations;
|
|
50
|
+
//# sourceMappingURL=integrations.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"integrations.js","sourceRoot":"","sources":["../../../src/resources/v1/customers/integrations.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAErD,4DAAkG;AAElG,0DAAoD;AAEpD,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;OAEG;IACH,QAAQ,CACN,aAAqB,EACrB,MAAiC,EACjC,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,GAAG,MAAM,CAAC;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,iBAAiB,aAAa,EAAE,EAAE,OAAO,CAAC,CAAC;IAChG,CAAC;IAED;;;OAGG;IACH,MAAM,CACJ,aAAqB,EACrB,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,iBAAiB,aAAa,EAAE,EAAE;YACrF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,IAAI,CACF,EAAU,EACV,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,qBAAqB,EAAE,eAAe,EAC1C,CAAA,2BAAuC,CAAA,EACvC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,IAAI,CACF,EAAU,EACV,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,aAAqB,EACrB,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,GAAG,MAAM,CAAC;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,iBAAiB,aAAa,EAAE,EAAE,OAAO,CAAC,CAAC;IACnG,CAAC;CACF;AApED,oCAoEC"}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../../../core/resource.mjs";
|
|
3
|
+
import { MyCursorIDPage } from "../../../core/pagination.mjs";
|
|
4
|
+
import { path } from "../../../internal/utils/path.mjs";
|
|
5
|
+
export class Integrations extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Retrieves a specific integration for a customer by integration ID.
|
|
8
|
+
*/
|
|
9
|
+
retrieve(integrationID, params, options) {
|
|
10
|
+
const { id } = params;
|
|
11
|
+
return this._client.get(path `/api/v1/customers/${id}/integrations/${integrationID}`, options);
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Updates a customer's integration link, such as changing the synced external
|
|
15
|
+
* entity ID.
|
|
16
|
+
*/
|
|
17
|
+
update(integrationID, params, options) {
|
|
18
|
+
const { id, ...body } = params;
|
|
19
|
+
return this._client.patch(path `/api/v1/customers/${id}/integrations/${integrationID}`, {
|
|
20
|
+
body,
|
|
21
|
+
...options,
|
|
22
|
+
});
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Retrieves a paginated list of a customer's external integrations (billing, CRM,
|
|
26
|
+
* etc.).
|
|
27
|
+
*/
|
|
28
|
+
list(id, query = {}, options) {
|
|
29
|
+
return this._client.getAPIList(path `/api/v1/customers/${id}/integrations`, (MyCursorIDPage), { query, ...options });
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Links a customer to an external integration by specifying the vendor and
|
|
33
|
+
* external entity ID.
|
|
34
|
+
*/
|
|
35
|
+
link(id, body, options) {
|
|
36
|
+
return this._client.post(path `/api/v1/customers/${id}/integrations`, { body, ...options });
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Removes the link between a customer and an external integration.
|
|
40
|
+
*/
|
|
41
|
+
unlink(integrationID, params, options) {
|
|
42
|
+
const { id } = params;
|
|
43
|
+
return this._client.delete(path `/api/v1/customers/${id}/integrations/${integrationID}`, options);
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
//# sourceMappingURL=integrations.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"integrations.mjs","sourceRoot":"","sources":["../../../src/resources/v1/customers/integrations.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,cAAc,EAA0C;OAE1D,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,QAAQ,CACN,aAAqB,EACrB,MAAiC,EACjC,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,GAAG,MAAM,CAAC;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,EAAE,iBAAiB,aAAa,EAAE,EAAE,OAAO,CAAC,CAAC;IAChG,CAAC;IAED;;;OAGG;IACH,MAAM,CACJ,aAAqB,EACrB,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,qBAAqB,EAAE,iBAAiB,aAAa,EAAE,EAAE;YACrF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,IAAI,CACF,EAAU,EACV,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,qBAAqB,EAAE,eAAe,EAC1C,CAAA,cAAuC,CAAA,EACvC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,IAAI,CACF,EAAU,EACV,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,qBAAqB,EAAE,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,aAAqB,EACrB,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,GAAG,MAAM,CAAC;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,qBAAqB,EAAE,iBAAiB,aAAa,EAAE,EAAE,OAAO,CAAC,CAAC;IACnG,CAAC;CACF"}
|
|
@@ -1662,6 +1662,9 @@ export declare namespace SubscriptionProvisionResponse {
|
|
|
1662
1662
|
export interface SubscriptionUpdateParams {
|
|
1663
1663
|
addons?: Array<SubscriptionUpdateParams.Addon>;
|
|
1664
1664
|
appliedCoupon?: SubscriptionUpdateParams.AppliedCoupon;
|
|
1665
|
+
/**
|
|
1666
|
+
* Await payment confirmation
|
|
1667
|
+
*/
|
|
1665
1668
|
awaitPaymentConfirmation?: boolean;
|
|
1666
1669
|
billingCycleAnchor?: 'UNCHANGED' | 'NOW';
|
|
1667
1670
|
billingInformation?: SubscriptionUpdateParams.BillingInformation;
|
|
@@ -1680,6 +1683,9 @@ export interface SubscriptionUpdateParams {
|
|
|
1680
1683
|
*/
|
|
1681
1684
|
minimumSpend?: SubscriptionUpdateParams.MinimumSpend | null;
|
|
1682
1685
|
priceOverrides?: Array<SubscriptionUpdateParams.PriceOverride>;
|
|
1686
|
+
/**
|
|
1687
|
+
* Promotion code
|
|
1688
|
+
*/
|
|
1683
1689
|
promotionCode?: string;
|
|
1684
1690
|
scheduleStrategy?: 'END_OF_BILLING_PERIOD' | 'END_OF_BILLING_MONTH' | 'IMMEDIATE';
|
|
1685
1691
|
/**
|
|
@@ -2478,6 +2484,9 @@ export interface SubscriptionProvisionParams {
|
|
|
2478
2484
|
* Trial period override settings
|
|
2479
2485
|
*/
|
|
2480
2486
|
trialOverrideConfiguration?: SubscriptionProvisionParams.TrialOverrideConfiguration;
|
|
2487
|
+
/**
|
|
2488
|
+
* Unit quantity
|
|
2489
|
+
*/
|
|
2481
2490
|
unitQuantity?: number;
|
|
2482
2491
|
}
|
|
2483
2492
|
export declare namespace SubscriptionProvisionParams {
|