@schematichq/schematic-typescript-node 1.5.9 → 1.5.10
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/dist/BaseClient.d.ts +12 -0
- package/dist/Client.d.ts +3 -0
- package/dist/api/errors/BadRequestError.d.ts +1 -0
- package/dist/api/errors/ForbiddenError.d.ts +1 -0
- package/dist/api/errors/InternalServerError.d.ts +1 -0
- package/dist/api/errors/NotFoundError.d.ts +1 -0
- package/dist/api/errors/UnauthorizedError.d.ts +1 -0
- package/dist/api/resources/accesstokens/client/Client.d.ts +2 -0
- package/dist/api/resources/accounts/client/Client.d.ts +42 -0
- package/dist/api/resources/billing/client/Client.d.ts +48 -0
- package/dist/api/resources/catalogs/client/Client.d.ts +28 -0
- package/dist/api/resources/checkout/client/Client.d.ts +18 -0
- package/dist/api/resources/companies/client/Client.d.ts +86 -0
- package/dist/api/resources/components/client/Client.d.ts +16 -0
- package/dist/api/resources/componentspublic/client/Client.d.ts +2 -0
- package/dist/api/resources/credits/client/Client.d.ts +60 -0
- package/dist/api/resources/dataexports/client/Client.d.ts +8 -0
- package/dist/api/resources/entitlements/client/Client.d.ts +50 -0
- package/dist/api/resources/events/client/Client.d.ts +12 -0
- package/dist/api/resources/features/client/Client.d.ts +34 -0
- package/dist/api/resources/insights/client/Client.d.ts +12 -0
- package/dist/api/resources/integrationsapi/client/Client.d.ts +18 -0
- package/dist/api/resources/licenses/client/Client.d.ts +6 -0
- package/dist/api/resources/planbundle/client/Client.d.ts +6 -2
- package/dist/api/resources/planbundle/client/requests/CreateCustomPlanBundleRequestBody.d.ts +0 -1
- package/dist/api/resources/planbundle/client/requests/CreatePlanBundleRequestBody.d.ts +0 -1
- package/dist/api/resources/plangroups/client/Client.d.ts +6 -0
- package/dist/api/resources/planmigrations/client/Client.d.ts +18 -0
- package/dist/api/resources/plans/client/Client.d.ts +36 -3
- package/dist/api/resources/plans/client/requests/CreateBillingLinkedPlanRequestBody.d.ts +1 -2
- package/dist/api/resources/plans/client/requests/CreateCustomPlanRequestBody.d.ts +1 -2
- package/dist/api/resources/scheduledcheckout/client/Client.d.ts +8 -0
- package/dist/api/resources/webhooks/client/Client.d.ts +20 -0
- package/dist/api/types/AuditLogResponseData.d.ts +1 -0
- package/dist/api/types/BillingPlanCreditGrantResponseData.d.ts +1 -1
- package/dist/api/types/ComponentHydrateResponseData.d.ts +1 -1
- package/dist/api/types/ComponentPreviewResponseData.d.ts +1 -1
- package/dist/api/types/CreateBillingPlanCreditGrantRequestBody.d.ts +1 -0
- package/dist/api/types/CreateCustomPlanBundlePlanRequestBody.d.ts +1 -1
- package/dist/api/types/CreatePlanRequestBody.d.ts +1 -1
- package/dist/api/types/OnboardingRequirementView.d.ts +1 -0
- package/dist/api/types/PlanChangeResponseData.d.ts +6 -0
- package/dist/api/types/PreviewSubscriptionFinanceResponseData.d.ts +1 -0
- package/dist/api/types/StripeIntegrationConfig.d.ts +2 -0
- package/dist/api/types/UpcomingInvoiceResponseData.d.ts +23 -0
- package/dist/api/types/UpdateBillingPlanCreditGrantRequestBody.d.ts +1 -0
- package/dist/api/types/index.d.ts +1 -0
- package/dist/core/fetcher/redactUrl.d.ts +2 -0
- package/dist/core/requestBody.d.ts +12 -0
- package/dist/core/runtime/index.d.ts +1 -1
- package/dist/core/runtime/runtime.d.ts +19 -0
- package/dist/errors/SchematicError.d.ts +1 -0
- package/dist/errors/SchematicTimeoutError.d.ts +2 -2
- package/dist/events.d.ts +6 -0
- package/dist/index.js +9 -9
- package/dist/serialization/resources/plans/client/requests/CreateBillingLinkedPlanRequestBody.d.ts +1 -1
- package/dist/serialization/resources/plans/client/requests/CreateCustomPlanRequestBody.d.ts +1 -1
- package/dist/serialization/types/AuditLogResponseData.d.ts +1 -0
- package/dist/serialization/types/ComponentHydrateResponseData.d.ts +2 -2
- package/dist/serialization/types/ComponentPreviewResponseData.d.ts +2 -1
- package/dist/serialization/types/CreateCustomPlanBundlePlanRequestBody.d.ts +1 -1
- package/dist/serialization/types/CreatePlanRequestBody.d.ts +1 -1
- package/dist/serialization/types/OnboardingRequirementView.d.ts +1 -0
- package/dist/serialization/types/PlanChangeResponseData.d.ts +4 -0
- package/dist/serialization/types/PreviewSubscriptionFinanceResponseData.d.ts +1 -0
- package/dist/serialization/types/StripeIntegrationConfig.d.ts +1 -0
- package/dist/serialization/types/UpcomingInvoiceResponseData.d.ts +30 -0
- package/dist/serialization/types/index.d.ts +1 -0
- package/package.json +1 -1
|
@@ -19,6 +19,8 @@ export declare class CreditsClient {
|
|
|
19
19
|
* @throws {@link Schematic.ForbiddenError}
|
|
20
20
|
* @throws {@link Schematic.NotFoundError}
|
|
21
21
|
* @throws {@link Schematic.InternalServerError}
|
|
22
|
+
* @throws {@link errors.SchematicError}
|
|
23
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
22
24
|
*
|
|
23
25
|
* @example
|
|
24
26
|
* await client.credits.listBillingCredits({
|
|
@@ -39,6 +41,8 @@ export declare class CreditsClient {
|
|
|
39
41
|
* @throws {@link Schematic.ForbiddenError}
|
|
40
42
|
* @throws {@link Schematic.NotFoundError}
|
|
41
43
|
* @throws {@link Schematic.InternalServerError}
|
|
44
|
+
* @throws {@link errors.SchematicError}
|
|
45
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
42
46
|
*
|
|
43
47
|
* @example
|
|
44
48
|
* await client.credits.createBillingCredit({
|
|
@@ -57,6 +61,8 @@ export declare class CreditsClient {
|
|
|
57
61
|
* @throws {@link Schematic.ForbiddenError}
|
|
58
62
|
* @throws {@link Schematic.NotFoundError}
|
|
59
63
|
* @throws {@link Schematic.InternalServerError}
|
|
64
|
+
* @throws {@link errors.SchematicError}
|
|
65
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
60
66
|
*
|
|
61
67
|
* @example
|
|
62
68
|
* await client.credits.getSingleBillingCredit("credit_id")
|
|
@@ -73,6 +79,8 @@ export declare class CreditsClient {
|
|
|
73
79
|
* @throws {@link Schematic.ForbiddenError}
|
|
74
80
|
* @throws {@link Schematic.NotFoundError}
|
|
75
81
|
* @throws {@link Schematic.InternalServerError}
|
|
82
|
+
* @throws {@link errors.SchematicError}
|
|
83
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
76
84
|
*
|
|
77
85
|
* @example
|
|
78
86
|
* await client.credits.updateBillingCredit("credit_id", {
|
|
@@ -91,6 +99,8 @@ export declare class CreditsClient {
|
|
|
91
99
|
* @throws {@link Schematic.ForbiddenError}
|
|
92
100
|
* @throws {@link Schematic.NotFoundError}
|
|
93
101
|
* @throws {@link Schematic.InternalServerError}
|
|
102
|
+
* @throws {@link errors.SchematicError}
|
|
103
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
94
104
|
*
|
|
95
105
|
* @example
|
|
96
106
|
* await client.credits.softDeleteBillingCredit("credit_id")
|
|
@@ -106,6 +116,8 @@ export declare class CreditsClient {
|
|
|
106
116
|
* @throws {@link Schematic.ForbiddenError}
|
|
107
117
|
* @throws {@link Schematic.NotFoundError}
|
|
108
118
|
* @throws {@link Schematic.InternalServerError}
|
|
119
|
+
* @throws {@link errors.SchematicError}
|
|
120
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
109
121
|
*
|
|
110
122
|
* @example
|
|
111
123
|
* await client.credits.listCompanyCreditBalances({
|
|
@@ -123,6 +135,8 @@ export declare class CreditsClient {
|
|
|
123
135
|
* @throws {@link Schematic.ForbiddenError}
|
|
124
136
|
* @throws {@link Schematic.NotFoundError}
|
|
125
137
|
* @throws {@link Schematic.InternalServerError}
|
|
138
|
+
* @throws {@link errors.SchematicError}
|
|
139
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
126
140
|
*
|
|
127
141
|
* @example
|
|
128
142
|
* await client.credits.listCreditBundles({
|
|
@@ -145,6 +159,8 @@ export declare class CreditsClient {
|
|
|
145
159
|
* @throws {@link Schematic.ForbiddenError}
|
|
146
160
|
* @throws {@link Schematic.NotFoundError}
|
|
147
161
|
* @throws {@link Schematic.InternalServerError}
|
|
162
|
+
* @throws {@link errors.SchematicError}
|
|
163
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
148
164
|
*
|
|
149
165
|
* @example
|
|
150
166
|
* await client.credits.createCreditBundle({
|
|
@@ -164,6 +180,8 @@ export declare class CreditsClient {
|
|
|
164
180
|
* @throws {@link Schematic.ForbiddenError}
|
|
165
181
|
* @throws {@link Schematic.NotFoundError}
|
|
166
182
|
* @throws {@link Schematic.InternalServerError}
|
|
183
|
+
* @throws {@link errors.SchematicError}
|
|
184
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
167
185
|
*
|
|
168
186
|
* @example
|
|
169
187
|
* await client.credits.getCreditBundle("bundle_id")
|
|
@@ -180,6 +198,8 @@ export declare class CreditsClient {
|
|
|
180
198
|
* @throws {@link Schematic.ForbiddenError}
|
|
181
199
|
* @throws {@link Schematic.NotFoundError}
|
|
182
200
|
* @throws {@link Schematic.InternalServerError}
|
|
201
|
+
* @throws {@link errors.SchematicError}
|
|
202
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
183
203
|
*
|
|
184
204
|
* @example
|
|
185
205
|
* await client.credits.updateCreditBundleDetails("bundle_id", {
|
|
@@ -198,6 +218,8 @@ export declare class CreditsClient {
|
|
|
198
218
|
* @throws {@link Schematic.ForbiddenError}
|
|
199
219
|
* @throws {@link Schematic.NotFoundError}
|
|
200
220
|
* @throws {@link Schematic.InternalServerError}
|
|
221
|
+
* @throws {@link errors.SchematicError}
|
|
222
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
201
223
|
*
|
|
202
224
|
* @example
|
|
203
225
|
* await client.credits.deleteCreditBundle("bundle_id")
|
|
@@ -213,6 +235,8 @@ export declare class CreditsClient {
|
|
|
213
235
|
* @throws {@link Schematic.ForbiddenError}
|
|
214
236
|
* @throws {@link Schematic.NotFoundError}
|
|
215
237
|
* @throws {@link Schematic.InternalServerError}
|
|
238
|
+
* @throws {@link errors.SchematicError}
|
|
239
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
216
240
|
*
|
|
217
241
|
* @example
|
|
218
242
|
* await client.credits.countCreditBundles({
|
|
@@ -235,6 +259,8 @@ export declare class CreditsClient {
|
|
|
235
259
|
* @throws {@link Schematic.ForbiddenError}
|
|
236
260
|
* @throws {@link Schematic.NotFoundError}
|
|
237
261
|
* @throws {@link Schematic.InternalServerError}
|
|
262
|
+
* @throws {@link errors.SchematicError}
|
|
263
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
238
264
|
*
|
|
239
265
|
* @example
|
|
240
266
|
* await client.credits.countBillingCredits({
|
|
@@ -256,6 +282,8 @@ export declare class CreditsClient {
|
|
|
256
282
|
* @throws {@link Schematic.ForbiddenError}
|
|
257
283
|
* @throws {@link Schematic.NotFoundError}
|
|
258
284
|
* @throws {@link Schematic.InternalServerError}
|
|
285
|
+
* @throws {@link errors.SchematicError}
|
|
286
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
259
287
|
*
|
|
260
288
|
* @example
|
|
261
289
|
* await client.credits.zeroOutGrant("grant_id")
|
|
@@ -271,6 +299,8 @@ export declare class CreditsClient {
|
|
|
271
299
|
* @throws {@link Schematic.ForbiddenError}
|
|
272
300
|
* @throws {@link Schematic.NotFoundError}
|
|
273
301
|
* @throws {@link Schematic.InternalServerError}
|
|
302
|
+
* @throws {@link errors.SchematicError}
|
|
303
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
274
304
|
*
|
|
275
305
|
* @example
|
|
276
306
|
* await client.credits.grantBillingCreditsToCompany({
|
|
@@ -291,6 +321,8 @@ export declare class CreditsClient {
|
|
|
291
321
|
* @throws {@link Schematic.ForbiddenError}
|
|
292
322
|
* @throws {@link Schematic.NotFoundError}
|
|
293
323
|
* @throws {@link Schematic.InternalServerError}
|
|
324
|
+
* @throws {@link errors.SchematicError}
|
|
325
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
294
326
|
*
|
|
295
327
|
* @example
|
|
296
328
|
* await client.credits.countCompanyGrants({
|
|
@@ -312,6 +344,8 @@ export declare class CreditsClient {
|
|
|
312
344
|
* @throws {@link Schematic.ForbiddenError}
|
|
313
345
|
* @throws {@link Schematic.NotFoundError}
|
|
314
346
|
* @throws {@link Schematic.InternalServerError}
|
|
347
|
+
* @throws {@link errors.SchematicError}
|
|
348
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
315
349
|
*
|
|
316
350
|
* @example
|
|
317
351
|
* await client.credits.listCompanyGrants({
|
|
@@ -333,6 +367,8 @@ export declare class CreditsClient {
|
|
|
333
367
|
* @throws {@link Schematic.ForbiddenError}
|
|
334
368
|
* @throws {@link Schematic.NotFoundError}
|
|
335
369
|
* @throws {@link Schematic.InternalServerError}
|
|
370
|
+
* @throws {@link errors.SchematicError}
|
|
371
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
336
372
|
*
|
|
337
373
|
* @example
|
|
338
374
|
* await client.credits.countBillingCreditsGrants({
|
|
@@ -353,6 +389,8 @@ export declare class CreditsClient {
|
|
|
353
389
|
* @throws {@link Schematic.ForbiddenError}
|
|
354
390
|
* @throws {@link Schematic.NotFoundError}
|
|
355
391
|
* @throws {@link Schematic.InternalServerError}
|
|
392
|
+
* @throws {@link errors.SchematicError}
|
|
393
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
356
394
|
*
|
|
357
395
|
* @example
|
|
358
396
|
* await client.credits.listGrantsForCredit({
|
|
@@ -373,6 +411,8 @@ export declare class CreditsClient {
|
|
|
373
411
|
* @throws {@link Schematic.ForbiddenError}
|
|
374
412
|
* @throws {@link Schematic.NotFoundError}
|
|
375
413
|
* @throws {@link Schematic.InternalServerError}
|
|
414
|
+
* @throws {@link errors.SchematicError}
|
|
415
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
376
416
|
*
|
|
377
417
|
* @example
|
|
378
418
|
* await client.credits.acquireCreditLease({
|
|
@@ -393,6 +433,8 @@ export declare class CreditsClient {
|
|
|
393
433
|
* @throws {@link Schematic.ForbiddenError}
|
|
394
434
|
* @throws {@link Schematic.NotFoundError}
|
|
395
435
|
* @throws {@link Schematic.InternalServerError}
|
|
436
|
+
* @throws {@link errors.SchematicError}
|
|
437
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
396
438
|
*
|
|
397
439
|
* @example
|
|
398
440
|
* await client.credits.extendCreditLease("lease_id", {
|
|
@@ -411,6 +453,8 @@ export declare class CreditsClient {
|
|
|
411
453
|
* @throws {@link Schematic.ForbiddenError}
|
|
412
454
|
* @throws {@link Schematic.NotFoundError}
|
|
413
455
|
* @throws {@link Schematic.InternalServerError}
|
|
456
|
+
* @throws {@link errors.SchematicError}
|
|
457
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
414
458
|
*
|
|
415
459
|
* @example
|
|
416
460
|
* await client.credits.releaseCreditLease("lease_id", {
|
|
@@ -428,6 +472,8 @@ export declare class CreditsClient {
|
|
|
428
472
|
* @throws {@link Schematic.ForbiddenError}
|
|
429
473
|
* @throws {@link Schematic.NotFoundError}
|
|
430
474
|
* @throws {@link Schematic.InternalServerError}
|
|
475
|
+
* @throws {@link errors.SchematicError}
|
|
476
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
431
477
|
*
|
|
432
478
|
* @example
|
|
433
479
|
* await client.credits.listBillingPlanCreditGrants({
|
|
@@ -452,6 +498,8 @@ export declare class CreditsClient {
|
|
|
452
498
|
* @throws {@link Schematic.ForbiddenError}
|
|
453
499
|
* @throws {@link Schematic.NotFoundError}
|
|
454
500
|
* @throws {@link Schematic.InternalServerError}
|
|
501
|
+
* @throws {@link errors.SchematicError}
|
|
502
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
455
503
|
*
|
|
456
504
|
* @example
|
|
457
505
|
* await client.credits.createBillingPlanCreditGrant({
|
|
@@ -472,6 +520,8 @@ export declare class CreditsClient {
|
|
|
472
520
|
* @throws {@link Schematic.ForbiddenError}
|
|
473
521
|
* @throws {@link Schematic.NotFoundError}
|
|
474
522
|
* @throws {@link Schematic.InternalServerError}
|
|
523
|
+
* @throws {@link errors.SchematicError}
|
|
524
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
475
525
|
*
|
|
476
526
|
* @example
|
|
477
527
|
* await client.credits.getSingleBillingPlanCreditGrant("plan_grant_id")
|
|
@@ -488,6 +538,8 @@ export declare class CreditsClient {
|
|
|
488
538
|
* @throws {@link Schematic.ForbiddenError}
|
|
489
539
|
* @throws {@link Schematic.NotFoundError}
|
|
490
540
|
* @throws {@link Schematic.InternalServerError}
|
|
541
|
+
* @throws {@link errors.SchematicError}
|
|
542
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
491
543
|
*
|
|
492
544
|
* @example
|
|
493
545
|
* await client.credits.updateBillingPlanCreditGrant("plan_grant_id", {
|
|
@@ -507,6 +559,8 @@ export declare class CreditsClient {
|
|
|
507
559
|
* @throws {@link Schematic.ForbiddenError}
|
|
508
560
|
* @throws {@link Schematic.NotFoundError}
|
|
509
561
|
* @throws {@link Schematic.InternalServerError}
|
|
562
|
+
* @throws {@link errors.SchematicError}
|
|
563
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
510
564
|
*
|
|
511
565
|
* @example
|
|
512
566
|
* await client.credits.deleteBillingPlanCreditGrant("plan_grant_id", {
|
|
@@ -524,6 +578,8 @@ export declare class CreditsClient {
|
|
|
524
578
|
* @throws {@link Schematic.ForbiddenError}
|
|
525
579
|
* @throws {@link Schematic.NotFoundError}
|
|
526
580
|
* @throws {@link Schematic.InternalServerError}
|
|
581
|
+
* @throws {@link errors.SchematicError}
|
|
582
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
527
583
|
*
|
|
528
584
|
* @example
|
|
529
585
|
* await client.credits.countBillingPlanCreditGrants({
|
|
@@ -548,6 +604,8 @@ export declare class CreditsClient {
|
|
|
548
604
|
* @throws {@link Schematic.ForbiddenError}
|
|
549
605
|
* @throws {@link Schematic.NotFoundError}
|
|
550
606
|
* @throws {@link Schematic.InternalServerError}
|
|
607
|
+
* @throws {@link errors.SchematicError}
|
|
608
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
551
609
|
*
|
|
552
610
|
* @example
|
|
553
611
|
* await client.credits.listCreditEventLedger({
|
|
@@ -572,6 +630,8 @@ export declare class CreditsClient {
|
|
|
572
630
|
* @throws {@link Schematic.ForbiddenError}
|
|
573
631
|
* @throws {@link Schematic.NotFoundError}
|
|
574
632
|
* @throws {@link Schematic.InternalServerError}
|
|
633
|
+
* @throws {@link errors.SchematicError}
|
|
634
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
575
635
|
*
|
|
576
636
|
* @example
|
|
577
637
|
* await client.credits.countCreditEventLedger({
|
|
@@ -20,6 +20,8 @@ export declare class DataexportsClient {
|
|
|
20
20
|
* @throws {@link Schematic.ForbiddenError}
|
|
21
21
|
* @throws {@link Schematic.NotFoundError}
|
|
22
22
|
* @throws {@link Schematic.InternalServerError}
|
|
23
|
+
* @throws {@link errors.SchematicError}
|
|
24
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
23
25
|
*
|
|
24
26
|
* @example
|
|
25
27
|
* await client.dataexports.listDataExports({
|
|
@@ -40,6 +42,8 @@ export declare class DataexportsClient {
|
|
|
40
42
|
* @throws {@link Schematic.ForbiddenError}
|
|
41
43
|
* @throws {@link Schematic.NotFoundError}
|
|
42
44
|
* @throws {@link Schematic.InternalServerError}
|
|
45
|
+
* @throws {@link errors.SchematicError}
|
|
46
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
43
47
|
*
|
|
44
48
|
* @example
|
|
45
49
|
* await client.dataexports.createDataExport({
|
|
@@ -57,6 +61,8 @@ export declare class DataexportsClient {
|
|
|
57
61
|
* @throws {@link Schematic.ForbiddenError}
|
|
58
62
|
* @throws {@link Schematic.NotFoundError}
|
|
59
63
|
* @throws {@link Schematic.InternalServerError}
|
|
64
|
+
* @throws {@link errors.SchematicError}
|
|
65
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
60
66
|
*
|
|
61
67
|
* @example
|
|
62
68
|
* await client.dataexports.getDataExport("data_export_id")
|
|
@@ -68,6 +74,8 @@ export declare class DataexportsClient {
|
|
|
68
74
|
* @throws {@link Schematic.ForbiddenError}
|
|
69
75
|
* @throws {@link Schematic.NotFoundError}
|
|
70
76
|
* @throws {@link Schematic.InternalServerError}
|
|
77
|
+
* @throws {@link errors.SchematicError}
|
|
78
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
71
79
|
*/
|
|
72
80
|
getDataExportArtifact(data_export_id: string, requestOptions?: DataexportsClient.RequestOptions): core.HttpResponsePromise<stream.Readable>;
|
|
73
81
|
private __getDataExportArtifact;
|
|
@@ -19,6 +19,8 @@ export declare class EntitlementsClient {
|
|
|
19
19
|
* @throws {@link Schematic.ForbiddenError}
|
|
20
20
|
* @throws {@link Schematic.NotFoundError}
|
|
21
21
|
* @throws {@link Schematic.InternalServerError}
|
|
22
|
+
* @throws {@link errors.SchematicError}
|
|
23
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
22
24
|
*
|
|
23
25
|
* @example
|
|
24
26
|
* await client.entitlements.listCompanyOverrides({
|
|
@@ -44,6 +46,8 @@ export declare class EntitlementsClient {
|
|
|
44
46
|
* @throws {@link Schematic.ForbiddenError}
|
|
45
47
|
* @throws {@link Schematic.NotFoundError}
|
|
46
48
|
* @throws {@link Schematic.InternalServerError}
|
|
49
|
+
* @throws {@link errors.SchematicError}
|
|
50
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
47
51
|
*
|
|
48
52
|
* @example
|
|
49
53
|
* await client.entitlements.createCompanyOverride({
|
|
@@ -62,6 +66,8 @@ export declare class EntitlementsClient {
|
|
|
62
66
|
* @throws {@link Schematic.ForbiddenError}
|
|
63
67
|
* @throws {@link Schematic.NotFoundError}
|
|
64
68
|
* @throws {@link Schematic.InternalServerError}
|
|
69
|
+
* @throws {@link errors.SchematicError}
|
|
70
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
65
71
|
*
|
|
66
72
|
* @example
|
|
67
73
|
* await client.entitlements.getCompanyOverride("company_override_id")
|
|
@@ -78,6 +84,8 @@ export declare class EntitlementsClient {
|
|
|
78
84
|
* @throws {@link Schematic.ForbiddenError}
|
|
79
85
|
* @throws {@link Schematic.NotFoundError}
|
|
80
86
|
* @throws {@link Schematic.InternalServerError}
|
|
87
|
+
* @throws {@link errors.SchematicError}
|
|
88
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
81
89
|
*
|
|
82
90
|
* @example
|
|
83
91
|
* await client.entitlements.updateCompanyOverride("company_override_id", {
|
|
@@ -95,6 +103,8 @@ export declare class EntitlementsClient {
|
|
|
95
103
|
* @throws {@link Schematic.ForbiddenError}
|
|
96
104
|
* @throws {@link Schematic.NotFoundError}
|
|
97
105
|
* @throws {@link Schematic.InternalServerError}
|
|
106
|
+
* @throws {@link errors.SchematicError}
|
|
107
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
98
108
|
*
|
|
99
109
|
* @example
|
|
100
110
|
* await client.entitlements.deleteCompanyOverride("company_override_id")
|
|
@@ -110,6 +120,8 @@ export declare class EntitlementsClient {
|
|
|
110
120
|
* @throws {@link Schematic.ForbiddenError}
|
|
111
121
|
* @throws {@link Schematic.NotFoundError}
|
|
112
122
|
* @throws {@link Schematic.InternalServerError}
|
|
123
|
+
* @throws {@link errors.SchematicError}
|
|
124
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
113
125
|
*
|
|
114
126
|
* @example
|
|
115
127
|
* await client.entitlements.countCompanyOverrides({
|
|
@@ -135,6 +147,8 @@ export declare class EntitlementsClient {
|
|
|
135
147
|
* @throws {@link Schematic.ForbiddenError}
|
|
136
148
|
* @throws {@link Schematic.NotFoundError}
|
|
137
149
|
* @throws {@link Schematic.InternalServerError}
|
|
150
|
+
* @throws {@link errors.SchematicError}
|
|
151
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
138
152
|
*
|
|
139
153
|
* @example
|
|
140
154
|
* await client.entitlements.listFeatureCompanies({
|
|
@@ -155,6 +169,8 @@ export declare class EntitlementsClient {
|
|
|
155
169
|
* @throws {@link Schematic.ForbiddenError}
|
|
156
170
|
* @throws {@link Schematic.NotFoundError}
|
|
157
171
|
* @throws {@link Schematic.InternalServerError}
|
|
172
|
+
* @throws {@link errors.SchematicError}
|
|
173
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
158
174
|
*
|
|
159
175
|
* @example
|
|
160
176
|
* await client.entitlements.countFeatureCompanies({
|
|
@@ -175,6 +191,8 @@ export declare class EntitlementsClient {
|
|
|
175
191
|
* @throws {@link Schematic.ForbiddenError}
|
|
176
192
|
* @throws {@link Schematic.NotFoundError}
|
|
177
193
|
* @throws {@link Schematic.InternalServerError}
|
|
194
|
+
* @throws {@link errors.SchematicError}
|
|
195
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
178
196
|
*
|
|
179
197
|
* @example
|
|
180
198
|
* await client.entitlements.listFeatureUsage({
|
|
@@ -199,6 +217,8 @@ export declare class EntitlementsClient {
|
|
|
199
217
|
* @throws {@link Schematic.ForbiddenError}
|
|
200
218
|
* @throws {@link Schematic.NotFoundError}
|
|
201
219
|
* @throws {@link Schematic.InternalServerError}
|
|
220
|
+
* @throws {@link errors.SchematicError}
|
|
221
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
202
222
|
*
|
|
203
223
|
* @example
|
|
204
224
|
* await client.entitlements.listFeatureUsageHistory({
|
|
@@ -221,6 +241,8 @@ export declare class EntitlementsClient {
|
|
|
221
241
|
* @throws {@link Schematic.ForbiddenError}
|
|
222
242
|
* @throws {@link Schematic.NotFoundError}
|
|
223
243
|
* @throws {@link Schematic.InternalServerError}
|
|
244
|
+
* @throws {@link errors.SchematicError}
|
|
245
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
224
246
|
*
|
|
225
247
|
* @example
|
|
226
248
|
* await client.entitlements.getFeatureUsageTimeSeries({
|
|
@@ -242,6 +264,8 @@ export declare class EntitlementsClient {
|
|
|
242
264
|
* @throws {@link Schematic.ForbiddenError}
|
|
243
265
|
* @throws {@link Schematic.NotFoundError}
|
|
244
266
|
* @throws {@link Schematic.InternalServerError}
|
|
267
|
+
* @throws {@link errors.SchematicError}
|
|
268
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
245
269
|
*
|
|
246
270
|
* @example
|
|
247
271
|
* await client.entitlements.countFeatureUsage({
|
|
@@ -266,6 +290,8 @@ export declare class EntitlementsClient {
|
|
|
266
290
|
* @throws {@link Schematic.ForbiddenError}
|
|
267
291
|
* @throws {@link Schematic.NotFoundError}
|
|
268
292
|
* @throws {@link Schematic.InternalServerError}
|
|
293
|
+
* @throws {@link errors.SchematicError}
|
|
294
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
269
295
|
*
|
|
270
296
|
* @example
|
|
271
297
|
* await client.entitlements.listFeatureUsers({
|
|
@@ -286,6 +312,8 @@ export declare class EntitlementsClient {
|
|
|
286
312
|
* @throws {@link Schematic.ForbiddenError}
|
|
287
313
|
* @throws {@link Schematic.NotFoundError}
|
|
288
314
|
* @throws {@link Schematic.InternalServerError}
|
|
315
|
+
* @throws {@link errors.SchematicError}
|
|
316
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
289
317
|
*
|
|
290
318
|
* @example
|
|
291
319
|
* await client.entitlements.countFeatureUsers({
|
|
@@ -306,6 +334,8 @@ export declare class EntitlementsClient {
|
|
|
306
334
|
* @throws {@link Schematic.ForbiddenError}
|
|
307
335
|
* @throws {@link Schematic.NotFoundError}
|
|
308
336
|
* @throws {@link Schematic.InternalServerError}
|
|
337
|
+
* @throws {@link errors.SchematicError}
|
|
338
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
309
339
|
*
|
|
310
340
|
* @example
|
|
311
341
|
* await client.entitlements.listPlanEntitlements({
|
|
@@ -333,6 +363,8 @@ export declare class EntitlementsClient {
|
|
|
333
363
|
* @throws {@link Schematic.ForbiddenError}
|
|
334
364
|
* @throws {@link Schematic.NotFoundError}
|
|
335
365
|
* @throws {@link Schematic.InternalServerError}
|
|
366
|
+
* @throws {@link errors.SchematicError}
|
|
367
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
336
368
|
*
|
|
337
369
|
* @example
|
|
338
370
|
* await client.entitlements.createPlanEntitlement({
|
|
@@ -351,6 +383,8 @@ export declare class EntitlementsClient {
|
|
|
351
383
|
* @throws {@link Schematic.ForbiddenError}
|
|
352
384
|
* @throws {@link Schematic.NotFoundError}
|
|
353
385
|
* @throws {@link Schematic.InternalServerError}
|
|
386
|
+
* @throws {@link errors.SchematicError}
|
|
387
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
354
388
|
*
|
|
355
389
|
* @example
|
|
356
390
|
* await client.entitlements.getPlanEntitlement("plan_entitlement_id")
|
|
@@ -367,6 +401,8 @@ export declare class EntitlementsClient {
|
|
|
367
401
|
* @throws {@link Schematic.ForbiddenError}
|
|
368
402
|
* @throws {@link Schematic.NotFoundError}
|
|
369
403
|
* @throws {@link Schematic.InternalServerError}
|
|
404
|
+
* @throws {@link errors.SchematicError}
|
|
405
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
370
406
|
*
|
|
371
407
|
* @example
|
|
372
408
|
* await client.entitlements.updatePlanEntitlement("plan_entitlement_id", {
|
|
@@ -384,6 +420,8 @@ export declare class EntitlementsClient {
|
|
|
384
420
|
* @throws {@link Schematic.ForbiddenError}
|
|
385
421
|
* @throws {@link Schematic.NotFoundError}
|
|
386
422
|
* @throws {@link Schematic.InternalServerError}
|
|
423
|
+
* @throws {@link errors.SchematicError}
|
|
424
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
387
425
|
*
|
|
388
426
|
* @example
|
|
389
427
|
* await client.entitlements.deletePlanEntitlement("plan_entitlement_id")
|
|
@@ -399,6 +437,8 @@ export declare class EntitlementsClient {
|
|
|
399
437
|
* @throws {@link Schematic.ForbiddenError}
|
|
400
438
|
* @throws {@link Schematic.NotFoundError}
|
|
401
439
|
* @throws {@link Schematic.InternalServerError}
|
|
440
|
+
* @throws {@link errors.SchematicError}
|
|
441
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
402
442
|
*
|
|
403
443
|
* @example
|
|
404
444
|
* await client.entitlements.upsertPlanEntitlementForBillingProduct({
|
|
@@ -420,6 +460,8 @@ export declare class EntitlementsClient {
|
|
|
420
460
|
* @throws {@link Schematic.ForbiddenError}
|
|
421
461
|
* @throws {@link Schematic.NotFoundError}
|
|
422
462
|
* @throws {@link Schematic.InternalServerError}
|
|
463
|
+
* @throws {@link errors.SchematicError}
|
|
464
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
423
465
|
*
|
|
424
466
|
* @example
|
|
425
467
|
* await client.entitlements.countPlanEntitlements({
|
|
@@ -447,6 +489,8 @@ export declare class EntitlementsClient {
|
|
|
447
489
|
* @throws {@link Schematic.ForbiddenError}
|
|
448
490
|
* @throws {@link Schematic.NotFoundError}
|
|
449
491
|
* @throws {@link Schematic.InternalServerError}
|
|
492
|
+
* @throws {@link errors.SchematicError}
|
|
493
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
450
494
|
*
|
|
451
495
|
* @example
|
|
452
496
|
* await client.entitlements.duplicatePlanEntitlements({
|
|
@@ -464,6 +508,8 @@ export declare class EntitlementsClient {
|
|
|
464
508
|
* @throws {@link Schematic.ForbiddenError}
|
|
465
509
|
* @throws {@link Schematic.NotFoundError}
|
|
466
510
|
* @throws {@link Schematic.InternalServerError}
|
|
511
|
+
* @throws {@link errors.SchematicError}
|
|
512
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
467
513
|
*
|
|
468
514
|
* @example
|
|
469
515
|
* await client.entitlements.getFeatureUsageByCompany({
|
|
@@ -482,6 +528,8 @@ export declare class EntitlementsClient {
|
|
|
482
528
|
* @throws {@link Schematic.ForbiddenError}
|
|
483
529
|
* @throws {@link Schematic.NotFoundError}
|
|
484
530
|
* @throws {@link Schematic.InternalServerError}
|
|
531
|
+
* @throws {@link errors.SchematicError}
|
|
532
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
485
533
|
*
|
|
486
534
|
* @example
|
|
487
535
|
* await client.entitlements.getUserUsageByCompany({
|
|
@@ -501,6 +549,8 @@ export declare class EntitlementsClient {
|
|
|
501
549
|
* @throws {@link Schematic.ForbiddenError}
|
|
502
550
|
* @throws {@link Schematic.NotFoundError}
|
|
503
551
|
* @throws {@link Schematic.InternalServerError}
|
|
552
|
+
* @throws {@link errors.SchematicError}
|
|
553
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
504
554
|
*
|
|
505
555
|
* @example
|
|
506
556
|
* await client.entitlements.getUserUsageDetail({
|
|
@@ -19,6 +19,8 @@ export declare class EventsClient {
|
|
|
19
19
|
* @throws {@link Schematic.ForbiddenError}
|
|
20
20
|
* @throws {@link Schematic.NotFoundError}
|
|
21
21
|
* @throws {@link Schematic.InternalServerError}
|
|
22
|
+
* @throws {@link errors.SchematicError}
|
|
23
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
22
24
|
*
|
|
23
25
|
* @example
|
|
24
26
|
* await client.events.createEventBatch({
|
|
@@ -38,6 +40,8 @@ export declare class EventsClient {
|
|
|
38
40
|
* @throws {@link Schematic.ForbiddenError}
|
|
39
41
|
* @throws {@link Schematic.NotFoundError}
|
|
40
42
|
* @throws {@link Schematic.InternalServerError}
|
|
43
|
+
* @throws {@link errors.SchematicError}
|
|
44
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
41
45
|
*
|
|
42
46
|
* @example
|
|
43
47
|
* await client.events.getEventSummaries({
|
|
@@ -58,6 +62,8 @@ export declare class EventsClient {
|
|
|
58
62
|
* @throws {@link Schematic.ForbiddenError}
|
|
59
63
|
* @throws {@link Schematic.NotFoundError}
|
|
60
64
|
* @throws {@link Schematic.InternalServerError}
|
|
65
|
+
* @throws {@link errors.SchematicError}
|
|
66
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
61
67
|
*
|
|
62
68
|
* @example
|
|
63
69
|
* await client.events.listEvents({
|
|
@@ -82,6 +88,8 @@ export declare class EventsClient {
|
|
|
82
88
|
* @throws {@link Schematic.ForbiddenError}
|
|
83
89
|
* @throws {@link Schematic.NotFoundError}
|
|
84
90
|
* @throws {@link Schematic.InternalServerError}
|
|
91
|
+
* @throws {@link errors.SchematicError}
|
|
92
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
85
93
|
*
|
|
86
94
|
* @example
|
|
87
95
|
* await client.events.createEvent({
|
|
@@ -98,6 +106,8 @@ export declare class EventsClient {
|
|
|
98
106
|
* @throws {@link Schematic.ForbiddenError}
|
|
99
107
|
* @throws {@link Schematic.NotFoundError}
|
|
100
108
|
* @throws {@link Schematic.InternalServerError}
|
|
109
|
+
* @throws {@link errors.SchematicError}
|
|
110
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
101
111
|
*
|
|
102
112
|
* @example
|
|
103
113
|
* await client.events.getEvent("event_id")
|
|
@@ -111,6 +121,8 @@ export declare class EventsClient {
|
|
|
111
121
|
* @throws {@link Schematic.ForbiddenError}
|
|
112
122
|
* @throws {@link Schematic.NotFoundError}
|
|
113
123
|
* @throws {@link Schematic.InternalServerError}
|
|
124
|
+
* @throws {@link errors.SchematicError}
|
|
125
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
114
126
|
*
|
|
115
127
|
* @example
|
|
116
128
|
* await client.events.getSegmentIntegrationStatus()
|