@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 FeaturesClient {
|
|
|
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.features.listFeatures({
|
|
@@ -45,6 +47,8 @@ export declare class FeaturesClient {
|
|
|
45
47
|
* @throws {@link Schematic.ForbiddenError}
|
|
46
48
|
* @throws {@link Schematic.NotFoundError}
|
|
47
49
|
* @throws {@link Schematic.InternalServerError}
|
|
50
|
+
* @throws {@link errors.SchematicError}
|
|
51
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
48
52
|
*
|
|
49
53
|
* @example
|
|
50
54
|
* await client.features.createFeature({
|
|
@@ -63,6 +67,8 @@ export declare class FeaturesClient {
|
|
|
63
67
|
* @throws {@link Schematic.ForbiddenError}
|
|
64
68
|
* @throws {@link Schematic.NotFoundError}
|
|
65
69
|
* @throws {@link Schematic.InternalServerError}
|
|
70
|
+
* @throws {@link errors.SchematicError}
|
|
71
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
66
72
|
*
|
|
67
73
|
* @example
|
|
68
74
|
* await client.features.getFeature("feature_id")
|
|
@@ -79,6 +85,8 @@ export declare class FeaturesClient {
|
|
|
79
85
|
* @throws {@link Schematic.ForbiddenError}
|
|
80
86
|
* @throws {@link Schematic.NotFoundError}
|
|
81
87
|
* @throws {@link Schematic.InternalServerError}
|
|
88
|
+
* @throws {@link errors.SchematicError}
|
|
89
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
82
90
|
*
|
|
83
91
|
* @example
|
|
84
92
|
* await client.features.updateFeature("feature_id")
|
|
@@ -94,6 +102,8 @@ export declare class FeaturesClient {
|
|
|
94
102
|
* @throws {@link Schematic.ForbiddenError}
|
|
95
103
|
* @throws {@link Schematic.NotFoundError}
|
|
96
104
|
* @throws {@link Schematic.InternalServerError}
|
|
105
|
+
* @throws {@link errors.SchematicError}
|
|
106
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
97
107
|
*
|
|
98
108
|
* @example
|
|
99
109
|
* await client.features.deleteFeature("feature_id")
|
|
@@ -109,6 +119,8 @@ export declare class FeaturesClient {
|
|
|
109
119
|
* @throws {@link Schematic.ForbiddenError}
|
|
110
120
|
* @throws {@link Schematic.NotFoundError}
|
|
111
121
|
* @throws {@link Schematic.InternalServerError}
|
|
122
|
+
* @throws {@link errors.SchematicError}
|
|
123
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
112
124
|
*
|
|
113
125
|
* @example
|
|
114
126
|
* await client.features.upsertFeatureForBillingProduct({
|
|
@@ -130,6 +142,8 @@ export declare class FeaturesClient {
|
|
|
130
142
|
* @throws {@link Schematic.ForbiddenError}
|
|
131
143
|
* @throws {@link Schematic.NotFoundError}
|
|
132
144
|
* @throws {@link Schematic.InternalServerError}
|
|
145
|
+
* @throws {@link errors.SchematicError}
|
|
146
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
133
147
|
*
|
|
134
148
|
* @example
|
|
135
149
|
* await client.features.countFeatures({
|
|
@@ -156,6 +170,8 @@ export declare class FeaturesClient {
|
|
|
156
170
|
* @throws {@link Schematic.ForbiddenError}
|
|
157
171
|
* @throws {@link Schematic.NotFoundError}
|
|
158
172
|
* @throws {@link Schematic.InternalServerError}
|
|
173
|
+
* @throws {@link errors.SchematicError}
|
|
174
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
159
175
|
*
|
|
160
176
|
* @example
|
|
161
177
|
* await client.features.listFlags({
|
|
@@ -177,6 +193,8 @@ export declare class FeaturesClient {
|
|
|
177
193
|
* @throws {@link Schematic.ForbiddenError}
|
|
178
194
|
* @throws {@link Schematic.NotFoundError}
|
|
179
195
|
* @throws {@link Schematic.InternalServerError}
|
|
196
|
+
* @throws {@link errors.SchematicError}
|
|
197
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
180
198
|
*
|
|
181
199
|
* @example
|
|
182
200
|
* await client.features.createFlag({
|
|
@@ -197,6 +215,8 @@ export declare class FeaturesClient {
|
|
|
197
215
|
* @throws {@link Schematic.ForbiddenError}
|
|
198
216
|
* @throws {@link Schematic.NotFoundError}
|
|
199
217
|
* @throws {@link Schematic.InternalServerError}
|
|
218
|
+
* @throws {@link errors.SchematicError}
|
|
219
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
200
220
|
*
|
|
201
221
|
* @example
|
|
202
222
|
* await client.features.getFlag("flag_id")
|
|
@@ -213,6 +233,8 @@ export declare class FeaturesClient {
|
|
|
213
233
|
* @throws {@link Schematic.ForbiddenError}
|
|
214
234
|
* @throws {@link Schematic.NotFoundError}
|
|
215
235
|
* @throws {@link Schematic.InternalServerError}
|
|
236
|
+
* @throws {@link errors.SchematicError}
|
|
237
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
216
238
|
*
|
|
217
239
|
* @example
|
|
218
240
|
* await client.features.updateFlag("flag_id", {
|
|
@@ -234,6 +256,8 @@ export declare class FeaturesClient {
|
|
|
234
256
|
* @throws {@link Schematic.ForbiddenError}
|
|
235
257
|
* @throws {@link Schematic.NotFoundError}
|
|
236
258
|
* @throws {@link Schematic.InternalServerError}
|
|
259
|
+
* @throws {@link errors.SchematicError}
|
|
260
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
237
261
|
*
|
|
238
262
|
* @example
|
|
239
263
|
* await client.features.deleteFlag("flag_id")
|
|
@@ -250,6 +274,8 @@ export declare class FeaturesClient {
|
|
|
250
274
|
* @throws {@link Schematic.ForbiddenError}
|
|
251
275
|
* @throws {@link Schematic.NotFoundError}
|
|
252
276
|
* @throws {@link Schematic.InternalServerError}
|
|
277
|
+
* @throws {@link errors.SchematicError}
|
|
278
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
253
279
|
*
|
|
254
280
|
* @example
|
|
255
281
|
* await client.features.updateFlagRules("flag_id", {
|
|
@@ -284,6 +310,8 @@ export declare class FeaturesClient {
|
|
|
284
310
|
* @throws {@link Schematic.ForbiddenError}
|
|
285
311
|
* @throws {@link Schematic.NotFoundError}
|
|
286
312
|
* @throws {@link Schematic.InternalServerError}
|
|
313
|
+
* @throws {@link errors.SchematicError}
|
|
314
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
287
315
|
*
|
|
288
316
|
* @example
|
|
289
317
|
* await client.features.checkFlag("key", {})
|
|
@@ -299,6 +327,8 @@ export declare class FeaturesClient {
|
|
|
299
327
|
* @throws {@link Schematic.ForbiddenError}
|
|
300
328
|
* @throws {@link Schematic.NotFoundError}
|
|
301
329
|
* @throws {@link Schematic.InternalServerError}
|
|
330
|
+
* @throws {@link errors.SchematicError}
|
|
331
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
302
332
|
*
|
|
303
333
|
* @example
|
|
304
334
|
* await client.features.checkFlags({})
|
|
@@ -314,6 +344,8 @@ export declare class FeaturesClient {
|
|
|
314
344
|
* @throws {@link Schematic.ForbiddenError}
|
|
315
345
|
* @throws {@link Schematic.NotFoundError}
|
|
316
346
|
* @throws {@link Schematic.InternalServerError}
|
|
347
|
+
* @throws {@link errors.SchematicError}
|
|
348
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
317
349
|
*
|
|
318
350
|
* @example
|
|
319
351
|
* await client.features.checkFlagsBulk({
|
|
@@ -331,6 +363,8 @@ export declare class FeaturesClient {
|
|
|
331
363
|
* @throws {@link Schematic.ForbiddenError}
|
|
332
364
|
* @throws {@link Schematic.NotFoundError}
|
|
333
365
|
* @throws {@link Schematic.InternalServerError}
|
|
366
|
+
* @throws {@link errors.SchematicError}
|
|
367
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
334
368
|
*
|
|
335
369
|
* @example
|
|
336
370
|
* await client.features.countFlags({
|
|
@@ -18,6 +18,8 @@ export declare class InsightsClient {
|
|
|
18
18
|
* @throws {@link Schematic.ForbiddenError}
|
|
19
19
|
* @throws {@link Schematic.NotFoundError}
|
|
20
20
|
* @throws {@link Schematic.InternalServerError}
|
|
21
|
+
* @throws {@link errors.SchematicError}
|
|
22
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
21
23
|
*
|
|
22
24
|
* @example
|
|
23
25
|
* await client.insights.getActivity({
|
|
@@ -34,6 +36,8 @@ export declare class InsightsClient {
|
|
|
34
36
|
* @throws {@link Schematic.ForbiddenError}
|
|
35
37
|
* @throws {@link Schematic.NotFoundError}
|
|
36
38
|
* @throws {@link Schematic.InternalServerError}
|
|
39
|
+
* @throws {@link errors.SchematicError}
|
|
40
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
37
41
|
*
|
|
38
42
|
* @example
|
|
39
43
|
* await client.insights.getEnvironmentFeatureUsageTimeSeries({
|
|
@@ -53,6 +57,8 @@ export declare class InsightsClient {
|
|
|
53
57
|
* @throws {@link Schematic.ForbiddenError}
|
|
54
58
|
* @throws {@link Schematic.NotFoundError}
|
|
55
59
|
* @throws {@link Schematic.InternalServerError}
|
|
60
|
+
* @throws {@link errors.SchematicError}
|
|
61
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
56
62
|
*
|
|
57
63
|
* @example
|
|
58
64
|
* await client.insights.getPlanGrowth({
|
|
@@ -68,6 +74,8 @@ export declare class InsightsClient {
|
|
|
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
|
* @example
|
|
73
81
|
* await client.insights.getSummary()
|
|
@@ -82,6 +90,8 @@ export declare class InsightsClient {
|
|
|
82
90
|
* @throws {@link Schematic.ForbiddenError}
|
|
83
91
|
* @throws {@link Schematic.NotFoundError}
|
|
84
92
|
* @throws {@link Schematic.InternalServerError}
|
|
93
|
+
* @throws {@link errors.SchematicError}
|
|
94
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
85
95
|
*
|
|
86
96
|
* @example
|
|
87
97
|
* await client.insights.getTopFeaturesByUsage({
|
|
@@ -100,6 +110,8 @@ export declare class InsightsClient {
|
|
|
100
110
|
* @throws {@link Schematic.ForbiddenError}
|
|
101
111
|
* @throws {@link Schematic.NotFoundError}
|
|
102
112
|
* @throws {@link Schematic.InternalServerError}
|
|
113
|
+
* @throws {@link errors.SchematicError}
|
|
114
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
103
115
|
*
|
|
104
116
|
* @example
|
|
105
117
|
* await client.insights.getEnvironmentTraitUsageTimeSeries({
|
|
@@ -18,6 +18,8 @@ export declare class IntegrationsapiClient {
|
|
|
18
18
|
* @throws {@link Schematic.ForbiddenError}
|
|
19
19
|
* @throws {@link Schematic.NotFoundError}
|
|
20
20
|
* @throws {@link Schematic.InternalServerError}
|
|
21
|
+
* @throws {@link errors.SchematicError}
|
|
22
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
21
23
|
*
|
|
22
24
|
* @example
|
|
23
25
|
* await client.integrationsapi.runIntegration("integration_id")
|
|
@@ -33,6 +35,8 @@ export declare class IntegrationsapiClient {
|
|
|
33
35
|
* @throws {@link Schematic.ForbiddenError}
|
|
34
36
|
* @throws {@link Schematic.NotFoundError}
|
|
35
37
|
* @throws {@link Schematic.InternalServerError}
|
|
38
|
+
* @throws {@link errors.SchematicError}
|
|
39
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
36
40
|
*
|
|
37
41
|
* @example
|
|
38
42
|
* await client.integrationsapi.listIntegrations({
|
|
@@ -55,6 +59,8 @@ export declare class IntegrationsapiClient {
|
|
|
55
59
|
* @throws {@link Schematic.ForbiddenError}
|
|
56
60
|
* @throws {@link Schematic.NotFoundError}
|
|
57
61
|
* @throws {@link Schematic.InternalServerError}
|
|
62
|
+
* @throws {@link errors.SchematicError}
|
|
63
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
58
64
|
*
|
|
59
65
|
* @example
|
|
60
66
|
* await client.integrationsapi.getIntegrationWebhookUrl("type")
|
|
@@ -70,6 +76,8 @@ export declare class IntegrationsapiClient {
|
|
|
70
76
|
* @throws {@link Schematic.ForbiddenError}
|
|
71
77
|
* @throws {@link Schematic.NotFoundError}
|
|
72
78
|
* @throws {@link Schematic.InternalServerError}
|
|
79
|
+
* @throws {@link errors.SchematicError}
|
|
80
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
73
81
|
*
|
|
74
82
|
* @example
|
|
75
83
|
* await client.integrationsapi.installIntegration({
|
|
@@ -87,6 +95,8 @@ export declare class IntegrationsapiClient {
|
|
|
87
95
|
* @throws {@link Schematic.ForbiddenError}
|
|
88
96
|
* @throws {@link Schematic.NotFoundError}
|
|
89
97
|
* @throws {@link Schematic.InternalServerError}
|
|
98
|
+
* @throws {@link errors.SchematicError}
|
|
99
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
90
100
|
*
|
|
91
101
|
* @example
|
|
92
102
|
* await client.integrationsapi.startDataImport({
|
|
@@ -102,6 +112,8 @@ export declare class IntegrationsapiClient {
|
|
|
102
112
|
* @throws {@link Schematic.ForbiddenError}
|
|
103
113
|
* @throws {@link Schematic.NotFoundError}
|
|
104
114
|
* @throws {@link Schematic.InternalServerError}
|
|
115
|
+
* @throws {@link errors.SchematicError}
|
|
116
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
105
117
|
*
|
|
106
118
|
* @example
|
|
107
119
|
* await client.integrationsapi.loadSampleDataSet()
|
|
@@ -117,6 +129,8 @@ export declare class IntegrationsapiClient {
|
|
|
117
129
|
* @throws {@link Schematic.ForbiddenError}
|
|
118
130
|
* @throws {@link Schematic.NotFoundError}
|
|
119
131
|
* @throws {@link Schematic.InternalServerError}
|
|
132
|
+
* @throws {@link errors.SchematicError}
|
|
133
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
120
134
|
*
|
|
121
135
|
* @example
|
|
122
136
|
* await client.integrationsapi.assumeStripeInstalled({
|
|
@@ -134,6 +148,8 @@ export declare class IntegrationsapiClient {
|
|
|
134
148
|
* @throws {@link Schematic.ForbiddenError}
|
|
135
149
|
* @throws {@link Schematic.NotFoundError}
|
|
136
150
|
* @throws {@link Schematic.InternalServerError}
|
|
151
|
+
* @throws {@link errors.SchematicError}
|
|
152
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
137
153
|
*
|
|
138
154
|
* @example
|
|
139
155
|
* await client.integrationsapi.installStripe({
|
|
@@ -151,6 +167,8 @@ export declare class IntegrationsapiClient {
|
|
|
151
167
|
* @throws {@link Schematic.ForbiddenError}
|
|
152
168
|
* @throws {@link Schematic.NotFoundError}
|
|
153
169
|
* @throws {@link Schematic.InternalServerError}
|
|
170
|
+
* @throws {@link errors.SchematicError}
|
|
171
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
154
172
|
*
|
|
155
173
|
* @example
|
|
156
174
|
* await client.integrationsapi.uninstallIntegration("integration_id")
|
|
@@ -19,6 +19,8 @@ export declare class LicensesClient {
|
|
|
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.licenses.listLicenses({
|
|
@@ -39,6 +41,8 @@ export declare class LicensesClient {
|
|
|
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.licenses.getSingleLicense("license_id")
|
|
@@ -54,6 +58,8 @@ export declare class LicensesClient {
|
|
|
54
58
|
* @throws {@link Schematic.ForbiddenError}
|
|
55
59
|
* @throws {@link Schematic.NotFoundError}
|
|
56
60
|
* @throws {@link Schematic.InternalServerError}
|
|
61
|
+
* @throws {@link errors.SchematicError}
|
|
62
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
57
63
|
*
|
|
58
64
|
* @example
|
|
59
65
|
* await client.licenses.countLicenses({
|
|
@@ -19,6 +19,8 @@ export declare class PlanbundleClient {
|
|
|
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.planbundle.createCustomPlanBundle({
|
|
@@ -31,7 +33,6 @@ export declare class PlanbundleClient {
|
|
|
31
33
|
* }],
|
|
32
34
|
* plan: {
|
|
33
35
|
* companyId: "company_id",
|
|
34
|
-
* description: "description",
|
|
35
36
|
* name: "name"
|
|
36
37
|
* }
|
|
37
38
|
* })
|
|
@@ -47,6 +48,8 @@ export declare class PlanbundleClient {
|
|
|
47
48
|
* @throws {@link Schematic.ForbiddenError}
|
|
48
49
|
* @throws {@link Schematic.NotFoundError}
|
|
49
50
|
* @throws {@link Schematic.InternalServerError}
|
|
51
|
+
* @throws {@link errors.SchematicError}
|
|
52
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
50
53
|
*
|
|
51
54
|
* @example
|
|
52
55
|
* await client.planbundle.createPlanBundle({
|
|
@@ -54,7 +57,6 @@ export declare class PlanbundleClient {
|
|
|
54
57
|
* action: "create"
|
|
55
58
|
* }],
|
|
56
59
|
* plan: {
|
|
57
|
-
* description: "description",
|
|
58
60
|
* name: "name",
|
|
59
61
|
* planType: "plan"
|
|
60
62
|
* }
|
|
@@ -72,6 +74,8 @@ export declare class PlanbundleClient {
|
|
|
72
74
|
* @throws {@link Schematic.ForbiddenError}
|
|
73
75
|
* @throws {@link Schematic.NotFoundError}
|
|
74
76
|
* @throws {@link Schematic.InternalServerError}
|
|
77
|
+
* @throws {@link errors.SchematicError}
|
|
78
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
75
79
|
*
|
|
76
80
|
* @example
|
|
77
81
|
* await client.planbundle.updatePlanBundle("plan_id", {
|
|
@@ -18,6 +18,8 @@ export declare class PlangroupsClient {
|
|
|
18
18
|
* @throws {@link Schematic.ForbiddenError}
|
|
19
19
|
* @throws {@link Schematic.NotFoundError}
|
|
20
20
|
* @throws {@link Schematic.InternalServerError}
|
|
21
|
+
* @throws {@link errors.SchematicError}
|
|
22
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
21
23
|
*
|
|
22
24
|
* @example
|
|
23
25
|
* await client.plangroups.getPlanGroup({
|
|
@@ -35,6 +37,8 @@ export declare class PlangroupsClient {
|
|
|
35
37
|
* @throws {@link Schematic.ForbiddenError}
|
|
36
38
|
* @throws {@link Schematic.NotFoundError}
|
|
37
39
|
* @throws {@link Schematic.InternalServerError}
|
|
40
|
+
* @throws {@link errors.SchematicError}
|
|
41
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
38
42
|
*
|
|
39
43
|
* @example
|
|
40
44
|
* await client.plangroups.createPlanGroup({
|
|
@@ -78,6 +82,8 @@ export declare class PlangroupsClient {
|
|
|
78
82
|
* @throws {@link Schematic.ForbiddenError}
|
|
79
83
|
* @throws {@link Schematic.NotFoundError}
|
|
80
84
|
* @throws {@link Schematic.InternalServerError}
|
|
85
|
+
* @throws {@link errors.SchematicError}
|
|
86
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
81
87
|
*
|
|
82
88
|
* @example
|
|
83
89
|
* await client.plangroups.updatePlanGroup("plan_group_id", {
|
|
@@ -19,6 +19,8 @@ export declare class PlanmigrationsClient {
|
|
|
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.planmigrations.listCompanyMigrations({
|
|
@@ -40,6 +42,8 @@ export declare class PlanmigrationsClient {
|
|
|
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.planmigrations.retryCompanyMigration("plan_version_company_migration_id")
|
|
@@ -55,6 +59,8 @@ export declare class PlanmigrationsClient {
|
|
|
55
59
|
* @throws {@link Schematic.ForbiddenError}
|
|
56
60
|
* @throws {@link Schematic.NotFoundError}
|
|
57
61
|
* @throws {@link Schematic.InternalServerError}
|
|
62
|
+
* @throws {@link errors.SchematicError}
|
|
63
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
58
64
|
*
|
|
59
65
|
* @example
|
|
60
66
|
* await client.planmigrations.countCompanyMigrations({
|
|
@@ -76,6 +82,8 @@ export declare class PlanmigrationsClient {
|
|
|
76
82
|
* @throws {@link Schematic.ForbiddenError}
|
|
77
83
|
* @throws {@link Schematic.NotFoundError}
|
|
78
84
|
* @throws {@link Schematic.InternalServerError}
|
|
85
|
+
* @throws {@link errors.SchematicError}
|
|
86
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
79
87
|
*
|
|
80
88
|
* @example
|
|
81
89
|
* await client.planmigrations.listMigrations({
|
|
@@ -96,6 +104,8 @@ export declare class PlanmigrationsClient {
|
|
|
96
104
|
* @throws {@link Schematic.ForbiddenError}
|
|
97
105
|
* @throws {@link Schematic.NotFoundError}
|
|
98
106
|
* @throws {@link Schematic.InternalServerError}
|
|
107
|
+
* @throws {@link errors.SchematicError}
|
|
108
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
99
109
|
*
|
|
100
110
|
* @example
|
|
101
111
|
* await client.planmigrations.createMigration({
|
|
@@ -115,6 +125,8 @@ export declare class PlanmigrationsClient {
|
|
|
115
125
|
* @throws {@link Schematic.ForbiddenError}
|
|
116
126
|
* @throws {@link Schematic.NotFoundError}
|
|
117
127
|
* @throws {@link Schematic.InternalServerError}
|
|
128
|
+
* @throws {@link errors.SchematicError}
|
|
129
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
118
130
|
*
|
|
119
131
|
* @example
|
|
120
132
|
* await client.planmigrations.getMigration("plan_version_migration_id")
|
|
@@ -131,6 +143,8 @@ export declare class PlanmigrationsClient {
|
|
|
131
143
|
* @throws {@link Schematic.ForbiddenError}
|
|
132
144
|
* @throws {@link Schematic.NotFoundError}
|
|
133
145
|
* @throws {@link Schematic.InternalServerError}
|
|
146
|
+
* @throws {@link errors.SchematicError}
|
|
147
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
134
148
|
*
|
|
135
149
|
* @example
|
|
136
150
|
* await client.planmigrations.retryMigration("plan_version_migration_id", {
|
|
@@ -148,6 +162,8 @@ export declare class PlanmigrationsClient {
|
|
|
148
162
|
* @throws {@link Schematic.ForbiddenError}
|
|
149
163
|
* @throws {@link Schematic.NotFoundError}
|
|
150
164
|
* @throws {@link Schematic.InternalServerError}
|
|
165
|
+
* @throws {@link errors.SchematicError}
|
|
166
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
151
167
|
*
|
|
152
168
|
* @example
|
|
153
169
|
* await client.planmigrations.countMigrations({
|
|
@@ -168,6 +184,8 @@ export declare class PlanmigrationsClient {
|
|
|
168
184
|
* @throws {@link Schematic.ForbiddenError}
|
|
169
185
|
* @throws {@link Schematic.NotFoundError}
|
|
170
186
|
* @throws {@link Schematic.InternalServerError}
|
|
187
|
+
* @throws {@link errors.SchematicError}
|
|
188
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
171
189
|
*
|
|
172
190
|
* @example
|
|
173
191
|
* await client.planmigrations.previewMigration({
|
|
@@ -20,6 +20,8 @@ export declare class PlansClient {
|
|
|
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.plans.updateCompanyPlans("company_id", {
|
|
@@ -37,6 +39,8 @@ export declare class PlansClient {
|
|
|
37
39
|
* @throws {@link Schematic.ForbiddenError}
|
|
38
40
|
* @throws {@link Schematic.NotFoundError}
|
|
39
41
|
* @throws {@link Schematic.InternalServerError}
|
|
42
|
+
* @throws {@link errors.SchematicError}
|
|
43
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
40
44
|
*
|
|
41
45
|
* @example
|
|
42
46
|
* await client.plans.listCustomPlanBillings({
|
|
@@ -61,6 +65,8 @@ export declare class PlansClient {
|
|
|
61
65
|
* @throws {@link Schematic.ForbiddenError}
|
|
62
66
|
* @throws {@link Schematic.NotFoundError}
|
|
63
67
|
* @throws {@link Schematic.InternalServerError}
|
|
68
|
+
* @throws {@link errors.SchematicError}
|
|
69
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
64
70
|
*
|
|
65
71
|
* @example
|
|
66
72
|
* await client.plans.markCustomPlanBillingPaid("custom_plan_billing_id", {
|
|
@@ -79,6 +85,8 @@ export declare class PlansClient {
|
|
|
79
85
|
* @throws {@link Schematic.ForbiddenError}
|
|
80
86
|
* @throws {@link Schematic.NotFoundError}
|
|
81
87
|
* @throws {@link Schematic.InternalServerError}
|
|
88
|
+
* @throws {@link errors.SchematicError}
|
|
89
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
82
90
|
*
|
|
83
91
|
* @example
|
|
84
92
|
* await client.plans.retryCustomPlanBilling("custom_plan_billing_id", {
|
|
@@ -96,11 +104,12 @@ export declare class PlansClient {
|
|
|
96
104
|
* @throws {@link Schematic.ForbiddenError}
|
|
97
105
|
* @throws {@link Schematic.NotFoundError}
|
|
98
106
|
* @throws {@link Schematic.InternalServerError}
|
|
107
|
+
* @throws {@link errors.SchematicError}
|
|
108
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
99
109
|
*
|
|
100
110
|
* @example
|
|
101
111
|
* await client.plans.createCustomPlan({
|
|
102
112
|
* companyId: "company_id",
|
|
103
|
-
* description: "description",
|
|
104
113
|
* name: "name"
|
|
105
114
|
* })
|
|
106
115
|
*/
|
|
@@ -115,6 +124,8 @@ export declare class PlansClient {
|
|
|
115
124
|
* @throws {@link Schematic.ForbiddenError}
|
|
116
125
|
* @throws {@link Schematic.NotFoundError}
|
|
117
126
|
* @throws {@link Schematic.InternalServerError}
|
|
127
|
+
* @throws {@link errors.SchematicError}
|
|
128
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
118
129
|
*
|
|
119
130
|
* @example
|
|
120
131
|
* await client.plans.listPlans({
|
|
@@ -148,10 +159,11 @@ export declare class PlansClient {
|
|
|
148
159
|
* @throws {@link Schematic.ForbiddenError}
|
|
149
160
|
* @throws {@link Schematic.NotFoundError}
|
|
150
161
|
* @throws {@link Schematic.InternalServerError}
|
|
162
|
+
* @throws {@link errors.SchematicError}
|
|
163
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
151
164
|
*
|
|
152
165
|
* @example
|
|
153
166
|
* await client.plans.createPlan({
|
|
154
|
-
* description: "description",
|
|
155
167
|
* name: "name",
|
|
156
168
|
* planType: "plan"
|
|
157
169
|
* })
|
|
@@ -167,6 +179,8 @@ export declare class PlansClient {
|
|
|
167
179
|
* @throws {@link Schematic.ForbiddenError}
|
|
168
180
|
* @throws {@link Schematic.NotFoundError}
|
|
169
181
|
* @throws {@link Schematic.InternalServerError}
|
|
182
|
+
* @throws {@link errors.SchematicError}
|
|
183
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
170
184
|
*
|
|
171
185
|
* @example
|
|
172
186
|
* await client.plans.getPlan("plan_id", {
|
|
@@ -185,6 +199,8 @@ export declare class PlansClient {
|
|
|
185
199
|
* @throws {@link Schematic.ForbiddenError}
|
|
186
200
|
* @throws {@link Schematic.NotFoundError}
|
|
187
201
|
* @throws {@link Schematic.InternalServerError}
|
|
202
|
+
* @throws {@link errors.SchematicError}
|
|
203
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
188
204
|
*
|
|
189
205
|
* @example
|
|
190
206
|
* await client.plans.updatePlan("plan_id", {
|
|
@@ -202,6 +218,8 @@ export declare class PlansClient {
|
|
|
202
218
|
* @throws {@link Schematic.ForbiddenError}
|
|
203
219
|
* @throws {@link Schematic.NotFoundError}
|
|
204
220
|
* @throws {@link Schematic.InternalServerError}
|
|
221
|
+
* @throws {@link errors.SchematicError}
|
|
222
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
205
223
|
*
|
|
206
224
|
* @example
|
|
207
225
|
* await client.plans.deletePlan("plan_id")
|
|
@@ -218,6 +236,8 @@ export declare class PlansClient {
|
|
|
218
236
|
* @throws {@link Schematic.ForbiddenError}
|
|
219
237
|
* @throws {@link Schematic.NotFoundError}
|
|
220
238
|
* @throws {@link Schematic.InternalServerError}
|
|
239
|
+
* @throws {@link errors.SchematicError}
|
|
240
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
221
241
|
*
|
|
222
242
|
* @example
|
|
223
243
|
* await client.plans.upsertBillingProductPlan("plan_id", {
|
|
@@ -236,11 +256,12 @@ export declare class PlansClient {
|
|
|
236
256
|
* @throws {@link Schematic.ForbiddenError}
|
|
237
257
|
* @throws {@link Schematic.NotFoundError}
|
|
238
258
|
* @throws {@link Schematic.InternalServerError}
|
|
259
|
+
* @throws {@link errors.SchematicError}
|
|
260
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
239
261
|
*
|
|
240
262
|
* @example
|
|
241
263
|
* await client.plans.upsertPlanForBillingProduct({
|
|
242
264
|
* billingProvider: "metronome",
|
|
243
|
-
* description: "description",
|
|
244
265
|
* externalResourceId: "external_resource_id",
|
|
245
266
|
* name: "name",
|
|
246
267
|
* planType: "plan"
|
|
@@ -257,6 +278,8 @@ export declare class PlansClient {
|
|
|
257
278
|
* @throws {@link Schematic.ForbiddenError}
|
|
258
279
|
* @throws {@link Schematic.NotFoundError}
|
|
259
280
|
* @throws {@link Schematic.InternalServerError}
|
|
281
|
+
* @throws {@link errors.SchematicError}
|
|
282
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
260
283
|
*
|
|
261
284
|
* @example
|
|
262
285
|
* await client.plans.listBillingProductMatchCompanies({
|
|
@@ -277,6 +300,8 @@ export declare class PlansClient {
|
|
|
277
300
|
* @throws {@link Schematic.ForbiddenError}
|
|
278
301
|
* @throws {@link Schematic.NotFoundError}
|
|
279
302
|
* @throws {@link Schematic.InternalServerError}
|
|
303
|
+
* @throws {@link errors.SchematicError}
|
|
304
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
280
305
|
*
|
|
281
306
|
* @example
|
|
282
307
|
* await client.plans.countBillingProductMatchCompanies({
|
|
@@ -297,6 +322,8 @@ export declare class PlansClient {
|
|
|
297
322
|
* @throws {@link Schematic.ForbiddenError}
|
|
298
323
|
* @throws {@link Schematic.NotFoundError}
|
|
299
324
|
* @throws {@link Schematic.InternalServerError}
|
|
325
|
+
* @throws {@link errors.SchematicError}
|
|
326
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
300
327
|
*
|
|
301
328
|
* @example
|
|
302
329
|
* await client.plans.countPlans({
|
|
@@ -330,6 +357,8 @@ export declare class PlansClient {
|
|
|
330
357
|
* @throws {@link Schematic.ForbiddenError}
|
|
331
358
|
* @throws {@link Schematic.NotFoundError}
|
|
332
359
|
* @throws {@link Schematic.InternalServerError}
|
|
360
|
+
* @throws {@link errors.SchematicError}
|
|
361
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
333
362
|
*
|
|
334
363
|
* @example
|
|
335
364
|
* await client.plans.listPlanIssues({
|
|
@@ -349,6 +378,8 @@ export declare class PlansClient {
|
|
|
349
378
|
* @throws {@link Schematic.ForbiddenError}
|
|
350
379
|
* @throws {@link Schematic.NotFoundError}
|
|
351
380
|
* @throws {@link Schematic.InternalServerError}
|
|
381
|
+
* @throws {@link errors.SchematicError}
|
|
382
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
352
383
|
*
|
|
353
384
|
* @example
|
|
354
385
|
* await client.plans.deletePlanVersion("plan_version_id", {
|
|
@@ -367,6 +398,8 @@ export declare class PlansClient {
|
|
|
367
398
|
* @throws {@link Schematic.ForbiddenError}
|
|
368
399
|
* @throws {@link Schematic.NotFoundError}
|
|
369
400
|
* @throws {@link Schematic.InternalServerError}
|
|
401
|
+
* @throws {@link errors.SchematicError}
|
|
402
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
370
403
|
*
|
|
371
404
|
* @example
|
|
372
405
|
* await client.plans.publishPlanVersion("plan_version_id", {
|
|
@@ -3,7 +3,6 @@ import type * as Schematic from "../../../../index";
|
|
|
3
3
|
* @example
|
|
4
4
|
* {
|
|
5
5
|
* billingProvider: "metronome",
|
|
6
|
-
* description: "description",
|
|
7
6
|
* externalResourceId: "external_resource_id",
|
|
8
7
|
* name: "name",
|
|
9
8
|
* planType: "plan"
|
|
@@ -11,7 +10,7 @@ import type * as Schematic from "../../../../index";
|
|
|
11
10
|
*/
|
|
12
11
|
export interface CreateBillingLinkedPlanRequestBody {
|
|
13
12
|
billingProvider: Schematic.BillingProviderType;
|
|
14
|
-
description
|
|
13
|
+
description?: string;
|
|
15
14
|
externalResourceId: string;
|
|
16
15
|
externalResourceVersion?: string;
|
|
17
16
|
icon?: Schematic.PlanIcon;
|
|
@@ -3,7 +3,6 @@ import type * as Schematic from "../../../../index";
|
|
|
3
3
|
* @example
|
|
4
4
|
* {
|
|
5
5
|
* companyId: "company_id",
|
|
6
|
-
* description: "description",
|
|
7
6
|
* name: "name"
|
|
8
7
|
* }
|
|
9
8
|
*/
|
|
@@ -11,7 +10,7 @@ export interface CreateCustomPlanRequestBody {
|
|
|
11
10
|
companyId: string;
|
|
12
11
|
copiedFromPlanId?: string;
|
|
13
12
|
copiedPriceId?: string;
|
|
14
|
-
description
|
|
13
|
+
description?: string;
|
|
15
14
|
icon?: Schematic.PlanIcon;
|
|
16
15
|
name: string;
|
|
17
16
|
}
|