@schematichq/schematic-typescript-node 1.5.8 → 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.
Files changed (218) hide show
  1. package/README.md +1 -1
  2. package/dist/BaseClient.d.ts +12 -0
  3. package/dist/Client.d.ts +3 -0
  4. package/dist/api/errors/BadRequestError.d.ts +1 -0
  5. package/dist/api/errors/ForbiddenError.d.ts +1 -0
  6. package/dist/api/errors/InternalServerError.d.ts +1 -0
  7. package/dist/api/errors/NotFoundError.d.ts +1 -0
  8. package/dist/api/errors/UnauthorizedError.d.ts +1 -0
  9. package/dist/api/resources/accesstokens/client/Client.d.ts +2 -0
  10. package/dist/api/resources/accounts/client/Client.d.ts +70 -0
  11. package/dist/api/resources/accounts/client/requests/UpdateOnboardingStateRequestBody.d.ts +11 -0
  12. package/dist/api/resources/accounts/client/requests/index.d.ts +1 -0
  13. package/dist/api/resources/accounts/types/GetOnboardingStateResponse.d.ts +6 -0
  14. package/dist/api/resources/accounts/types/UpdateOnboardingStateResponse.d.ts +6 -0
  15. package/dist/api/resources/accounts/types/index.d.ts +2 -0
  16. package/dist/api/resources/billing/client/Client.d.ts +48 -0
  17. package/dist/api/resources/catalogs/client/Client.d.ts +28 -0
  18. package/dist/api/resources/checkout/client/Client.d.ts +18 -0
  19. package/dist/api/resources/companies/client/Client.d.ts +139 -3
  20. package/dist/api/resources/companies/client/requests/CountCompaniesRequest.d.ts +3 -0
  21. package/dist/api/resources/companies/client/requests/CountEntityTraitsRequest.d.ts +18 -0
  22. package/dist/api/resources/companies/client/requests/GetBillingEntityChildSubscriptionsRequest.d.ts +1 -1
  23. package/dist/api/resources/companies/client/requests/GetCompanyBillingEntityRequest.d.ts +1 -1
  24. package/dist/api/resources/companies/client/requests/ListCompaniesRequest.d.ts +3 -0
  25. package/dist/api/resources/companies/client/requests/ListPlanChangesRequest.d.ts +0 -2
  26. package/dist/api/resources/companies/client/requests/index.d.ts +1 -0
  27. package/dist/api/resources/companies/types/CountCompaniesParams.d.ts +2 -0
  28. package/dist/api/resources/companies/types/CountEntityTraitsParams.d.ts +12 -0
  29. package/dist/api/resources/companies/types/CountEntityTraitsResponse.d.ts +6 -0
  30. package/dist/api/resources/companies/types/DeleteEntityTraitDefinitionResponse.d.ts +6 -0
  31. package/dist/api/resources/companies/types/GetEntityTraitDefinitionUsageResponse.d.ts +6 -0
  32. package/dist/api/resources/companies/types/ListCompaniesParams.d.ts +2 -0
  33. package/dist/api/resources/companies/types/ListPlanChangesParams.d.ts +0 -1
  34. package/dist/api/resources/companies/types/index.d.ts +4 -0
  35. package/dist/api/resources/components/client/Client.d.ts +16 -0
  36. package/dist/api/resources/componentspublic/client/Client.d.ts +2 -0
  37. package/dist/api/resources/credits/client/Client.d.ts +62 -2
  38. package/dist/api/resources/credits/client/requests/CountCompanyGrantsRequest.d.ts +1 -1
  39. package/dist/api/resources/credits/client/requests/CreateCreditBundleRequestBody.d.ts +2 -0
  40. package/dist/api/resources/credits/client/requests/ListCompanyGrantsRequest.d.ts +1 -1
  41. package/dist/api/resources/credits/client/requests/UpdateCreditBundleDetailsRequestBody.d.ts +2 -0
  42. package/dist/api/resources/dataexports/client/Client.d.ts +8 -0
  43. package/dist/api/resources/entitlements/client/Client.d.ts +73 -0
  44. package/dist/api/resources/entitlements/client/requests/ListFeatureUsageHistoryRequest.d.ts +29 -0
  45. package/dist/api/resources/entitlements/client/requests/index.d.ts +1 -0
  46. package/dist/api/resources/entitlements/types/ListFeatureUsageHistoryParams.d.ts +20 -0
  47. package/dist/api/resources/entitlements/types/ListFeatureUsageHistoryResponse.d.ts +6 -0
  48. package/dist/api/resources/entitlements/types/index.d.ts +2 -0
  49. package/dist/api/resources/events/client/Client.d.ts +12 -0
  50. package/dist/api/resources/features/client/Client.d.ts +34 -0
  51. package/dist/api/resources/insights/client/Client.d.ts +12 -0
  52. package/dist/api/resources/integrationsapi/client/Client.d.ts +18 -0
  53. package/dist/api/resources/licenses/client/Client.d.ts +6 -0
  54. package/dist/api/resources/planbundle/client/Client.d.ts +27 -6
  55. package/dist/api/resources/planbundle/client/requests/CreateCustomPlanBundleRequestBody.d.ts +11 -3
  56. package/dist/api/resources/planbundle/client/requests/CreatePlanBundleRequestBody.d.ts +6 -2
  57. package/dist/api/resources/planbundle/client/requests/UpdatePlanBundleRequestBody.d.ts +5 -2
  58. package/dist/api/resources/plangroups/client/Client.d.ts +8 -0
  59. package/dist/api/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +3 -0
  60. package/dist/api/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +3 -0
  61. package/dist/api/resources/planmigrations/client/Client.d.ts +22 -8
  62. package/dist/api/resources/planmigrations/client/requests/CountCompanyMigrationsRequest.d.ts +1 -1
  63. package/dist/api/resources/planmigrations/client/requests/CountMigrationsRequest.d.ts +1 -1
  64. package/dist/api/resources/planmigrations/client/requests/CreateMigrationInput.d.ts +4 -6
  65. package/dist/api/resources/planmigrations/client/requests/ListCompanyMigrationsRequest.d.ts +1 -1
  66. package/dist/api/resources/planmigrations/client/requests/ListMigrationsRequest.d.ts +1 -1
  67. package/dist/api/resources/planmigrations/client/requests/PreviewMigrationRequestBody.d.ts +2 -2
  68. package/dist/api/resources/plans/client/Client.d.ts +46 -12
  69. package/dist/api/resources/plans/client/requests/CreateBillingLinkedPlanRequestBody.d.ts +1 -2
  70. package/dist/api/resources/plans/client/requests/CreateCustomPlanRequestBody.d.ts +2 -2
  71. package/dist/api/resources/plans/client/requests/ListCustomPlanBillingsRequest.d.ts +3 -0
  72. package/dist/api/resources/plans/client/requests/PublishPlanVersionRequestBody.d.ts +3 -0
  73. package/dist/api/resources/plans/types/ListCustomPlanBillingsParams.d.ts +2 -0
  74. package/dist/api/resources/scheduledcheckout/client/Client.d.ts +8 -0
  75. package/dist/api/resources/webhooks/client/Client.d.ts +20 -0
  76. package/dist/api/types/AuditLogResponseData.d.ts +1 -0
  77. package/dist/api/types/BillingCollectionMethod.d.ts +5 -0
  78. package/dist/api/types/BillingCreditBundleResponseData.d.ts +2 -0
  79. package/dist/api/types/BillingCreditBundleView.d.ts +1 -0
  80. package/dist/api/types/BillingCreditGrantResponseData.d.ts +4 -0
  81. package/dist/api/types/BillingPlanCreditGrantResponseData.d.ts +3 -1
  82. package/dist/api/types/CheckFlagRequestBody.d.ts +3 -0
  83. package/dist/api/types/CheckoutBundlePurchaseBehavior.d.ts +5 -0
  84. package/dist/api/types/CheckoutSettingsResponseData.d.ts +3 -0
  85. package/dist/api/types/CompanyBillingCheckoutSettings.d.ts +1 -0
  86. package/dist/api/types/CompanyFeatureUsageExportMetadata.d.ts +6 -0
  87. package/dist/api/types/CompanyPlanCreditGrantView.d.ts +1 -0
  88. package/dist/api/types/ComponentCheckoutSettings.d.ts +2 -0
  89. package/dist/api/types/ComponentHydrateResponseData.d.ts +1 -1
  90. package/dist/api/types/ComponentPreviewResponseData.d.ts +1 -1
  91. package/dist/api/types/CreateBillingPlanCreditGrantRequestBody.d.ts +3 -0
  92. package/dist/api/types/CreateCustomPlanBundlePlanRequestBody.d.ts +1 -1
  93. package/dist/api/types/CreatePlanRequestBody.d.ts +1 -1
  94. package/dist/api/types/CreditCompanyGrantView.d.ts +2 -0
  95. package/dist/api/types/CustomPlanBillingResponseData.d.ts +4 -0
  96. package/dist/api/types/EntityTraitDefinitionUsage.d.ts +8 -0
  97. package/dist/api/types/EventBodyFlagCheck.d.ts +2 -0
  98. package/dist/api/types/FeatureUsageHistoryResponseData.d.ts +12 -0
  99. package/dist/api/types/GetOnboardingStateResp.d.ts +9 -0
  100. package/dist/api/types/ManagePlanRequest.d.ts +14 -0
  101. package/dist/api/types/MigrationProrationBehavior.d.ts +6 -0
  102. package/dist/api/types/OnboardingMilestone.d.ts +5 -0
  103. package/dist/api/types/OnboardingMilestoneView.d.ts +7 -0
  104. package/dist/api/types/OnboardingPath.d.ts +5 -0
  105. package/dist/api/types/OnboardingRequirement.d.ts +9 -0
  106. package/dist/api/types/OnboardingRequirementStatus.d.ts +6 -0
  107. package/dist/api/types/OnboardingRequirementView.d.ts +8 -0
  108. package/dist/api/types/OnboardingTrack.d.ts +5 -0
  109. package/dist/api/types/PlanBillingSource.d.ts +5 -0
  110. package/dist/api/types/PlanBundleResponseData.d.ts +1 -0
  111. package/dist/api/types/PlanChangeResponseData.d.ts +6 -0
  112. package/dist/api/types/PlanCreditGrantView.d.ts +1 -0
  113. package/dist/api/types/PlanVersionMigrationPreviewCompanyResponseData.d.ts +1 -0
  114. package/dist/api/types/PlanVersionMigrationPreviewResponseData.d.ts +1 -0
  115. package/dist/api/types/PlanVersionMigrationResponseData.d.ts +1 -0
  116. package/dist/api/types/PreflightEventUsageRequestBody.d.ts +6 -0
  117. package/dist/api/types/PreflightRequestBody.d.ts +9 -0
  118. package/dist/api/types/PreviewSubscriptionFinanceResponseData.d.ts +2 -0
  119. package/dist/api/types/RulesEngineSchemaVersion.d.ts +1 -1
  120. package/dist/api/types/StripeIntegrationConfig.d.ts +2 -0
  121. package/dist/api/types/UpcomingInvoiceResponseData.d.ts +23 -0
  122. package/dist/api/types/UpdateBillingPlanCreditGrantRequestBody.d.ts +5 -2
  123. package/dist/api/types/UpsertCompanyRequestBody.d.ts +2 -0
  124. package/dist/api/types/UpsertUserRequestBody.d.ts +2 -0
  125. package/dist/api/types/UpsertUserSubRequestBody.d.ts +2 -0
  126. package/dist/api/types/WhoAmIResponseData.d.ts +1 -0
  127. package/dist/api/types/index.d.ts +17 -0
  128. package/dist/core/fetcher/redactUrl.d.ts +2 -0
  129. package/dist/core/requestBody.d.ts +12 -0
  130. package/dist/core/runtime/index.d.ts +1 -1
  131. package/dist/core/runtime/runtime.d.ts +19 -0
  132. package/dist/errors/SchematicError.d.ts +1 -0
  133. package/dist/errors/SchematicTimeoutError.d.ts +2 -2
  134. package/dist/events.d.ts +6 -0
  135. package/dist/index.js +9 -9
  136. package/dist/serialization/resources/accounts/client/requests/UpdateOnboardingStateRequestBody.d.ts +14 -0
  137. package/dist/serialization/resources/accounts/client/requests/index.d.ts +1 -0
  138. package/dist/serialization/resources/accounts/types/GetOnboardingStateResponse.d.ts +11 -0
  139. package/dist/serialization/resources/accounts/types/UpdateOnboardingStateResponse.d.ts +11 -0
  140. package/dist/serialization/resources/accounts/types/index.d.ts +2 -0
  141. package/dist/serialization/resources/companies/types/CountCompaniesParams.d.ts +1 -0
  142. package/dist/serialization/resources/companies/types/CountEntityTraitsParams.d.ts +13 -0
  143. package/dist/serialization/resources/companies/types/CountEntityTraitsResponse.d.ts +12 -0
  144. package/dist/serialization/resources/companies/types/DeleteEntityTraitDefinitionResponse.d.ts +11 -0
  145. package/dist/serialization/resources/companies/types/GetEntityTraitDefinitionUsageResponse.d.ts +11 -0
  146. package/dist/serialization/resources/companies/types/ListCompaniesParams.d.ts +1 -0
  147. package/dist/serialization/resources/companies/types/ListPlanChangesParams.d.ts +0 -1
  148. package/dist/serialization/resources/companies/types/index.d.ts +4 -0
  149. package/dist/serialization/resources/credits/client/requests/CreateCreditBundleRequestBody.d.ts +1 -0
  150. package/dist/serialization/resources/credits/client/requests/UpdateCreditBundleDetailsRequestBody.d.ts +1 -0
  151. package/dist/serialization/resources/entitlements/types/ListFeatureUsageHistoryParams.d.ts +16 -0
  152. package/dist/serialization/resources/entitlements/types/ListFeatureUsageHistoryResponse.d.ts +12 -0
  153. package/dist/serialization/resources/entitlements/types/index.d.ts +2 -0
  154. package/dist/serialization/resources/planbundle/client/requests/CreateCustomPlanBundleRequestBody.d.ts +2 -2
  155. package/dist/serialization/resources/planbundle/client/requests/CreatePlanBundleRequestBody.d.ts +1 -1
  156. package/dist/serialization/resources/planbundle/client/requests/UpdatePlanBundleRequestBody.d.ts +1 -1
  157. package/dist/serialization/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +3 -0
  158. package/dist/serialization/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +3 -0
  159. package/dist/serialization/resources/planmigrations/client/requests/CreateMigrationInput.d.ts +5 -3
  160. package/dist/serialization/resources/planmigrations/client/requests/PreviewMigrationRequestBody.d.ts +2 -1
  161. package/dist/serialization/resources/plans/client/requests/CreateBillingLinkedPlanRequestBody.d.ts +1 -1
  162. package/dist/serialization/resources/plans/client/requests/CreateCustomPlanRequestBody.d.ts +2 -1
  163. package/dist/serialization/resources/plans/client/requests/PublishPlanVersionRequestBody.d.ts +3 -0
  164. package/dist/serialization/resources/plans/types/ListCustomPlanBillingsParams.d.ts +2 -0
  165. package/dist/serialization/types/AuditLogResponseData.d.ts +1 -0
  166. package/dist/serialization/types/BillingCollectionMethod.d.ts +7 -0
  167. package/dist/serialization/types/BillingCreditBundleResponseData.d.ts +1 -0
  168. package/dist/serialization/types/BillingCreditBundleView.d.ts +1 -0
  169. package/dist/serialization/types/BillingCreditGrantResponseData.d.ts +2 -0
  170. package/dist/serialization/types/BillingPlanCreditGrantResponseData.d.ts +1 -0
  171. package/dist/serialization/types/CheckFlagRequestBody.d.ts +2 -0
  172. package/dist/serialization/types/CheckoutBundlePurchaseBehavior.d.ts +7 -0
  173. package/dist/serialization/types/CheckoutSettingsResponseData.d.ts +3 -0
  174. package/dist/serialization/types/CompanyBillingCheckoutSettings.d.ts +1 -0
  175. package/dist/serialization/types/CompanyFeatureUsageExportMetadata.d.ts +3 -0
  176. package/dist/serialization/types/CompanyPlanCreditGrantView.d.ts +1 -0
  177. package/dist/serialization/types/ComponentCheckoutSettings.d.ts +3 -0
  178. package/dist/serialization/types/ComponentHydrateResponseData.d.ts +2 -2
  179. package/dist/serialization/types/ComponentPreviewResponseData.d.ts +2 -1
  180. package/dist/serialization/types/CreateBillingPlanCreditGrantRequestBody.d.ts +1 -0
  181. package/dist/serialization/types/CreateCustomPlanBundlePlanRequestBody.d.ts +1 -1
  182. package/dist/serialization/types/CreatePlanRequestBody.d.ts +1 -1
  183. package/dist/serialization/types/CreditCompanyGrantView.d.ts +2 -0
  184. package/dist/serialization/types/CustomPlanBillingResponseData.d.ts +3 -0
  185. package/dist/serialization/types/EntityTraitDefinitionUsage.d.ts +14 -0
  186. package/dist/serialization/types/EventBodyFlagCheck.d.ts +1 -0
  187. package/dist/serialization/types/FeatureUsageHistoryResponseData.d.ts +14 -0
  188. package/dist/serialization/types/GetOnboardingStateResp.d.ts +19 -0
  189. package/dist/serialization/types/ManagePlanRequest.d.ts +8 -0
  190. package/dist/serialization/types/MigrationProrationBehavior.d.ts +7 -0
  191. package/dist/serialization/types/OnboardingMilestone.d.ts +7 -0
  192. package/dist/serialization/types/OnboardingMilestoneView.d.ts +14 -0
  193. package/dist/serialization/types/OnboardingPath.d.ts +7 -0
  194. package/dist/serialization/types/OnboardingRequirement.d.ts +7 -0
  195. package/dist/serialization/types/OnboardingRequirementStatus.d.ts +7 -0
  196. package/dist/serialization/types/OnboardingRequirementView.d.ts +15 -0
  197. package/dist/serialization/types/OnboardingTrack.d.ts +7 -0
  198. package/dist/serialization/types/PlanBillingSource.d.ts +7 -0
  199. package/dist/serialization/types/PlanBundleResponseData.d.ts +2 -0
  200. package/dist/serialization/types/PlanChangeResponseData.d.ts +4 -0
  201. package/dist/serialization/types/PlanCreditGrantView.d.ts +1 -0
  202. package/dist/serialization/types/PlanVersionMigrationPreviewCompanyResponseData.d.ts +1 -0
  203. package/dist/serialization/types/PlanVersionMigrationPreviewResponseData.d.ts +1 -0
  204. package/dist/serialization/types/PlanVersionMigrationResponseData.d.ts +2 -0
  205. package/dist/serialization/types/PreflightEventUsageRequestBody.d.ts +10 -0
  206. package/dist/serialization/types/PreflightRequestBody.d.ts +12 -0
  207. package/dist/serialization/types/PreviewSubscriptionFinanceResponseData.d.ts +2 -0
  208. package/dist/serialization/types/RulesEngineSchemaVersion.d.ts +1 -1
  209. package/dist/serialization/types/StripeIntegrationConfig.d.ts +1 -0
  210. package/dist/serialization/types/UpcomingInvoiceResponseData.d.ts +30 -0
  211. package/dist/serialization/types/UpdateBillingPlanCreditGrantRequestBody.d.ts +1 -0
  212. package/dist/serialization/types/UpsertCompanyRequestBody.d.ts +1 -0
  213. package/dist/serialization/types/UpsertUserRequestBody.d.ts +1 -0
  214. package/dist/serialization/types/UpsertUserSubRequestBody.d.ts +1 -0
  215. package/dist/serialization/types/WhoAmIResponseData.d.ts +1 -0
  216. package/dist/serialization/types/index.d.ts +17 -0
  217. package/dist/wasm/rulesengine.js +4 -4
  218. package/package.json +4 -1
@@ -19,12 +19,22 @@ 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({
27
+ * billingProduct: {
28
+ * chargeType: "free",
29
+ * isTrialable: true
30
+ * },
25
31
  * entitlements: [{
26
32
  * action: "create"
27
- * }]
33
+ * }],
34
+ * plan: {
35
+ * companyId: "company_id",
36
+ * name: "name"
37
+ * }
28
38
  * })
29
39
  */
30
40
  createCustomPlanBundle(request: Schematic.CreateCustomPlanBundleRequestBody, requestOptions?: PlanbundleClient.RequestOptions): core.HttpResponsePromise<Schematic.CreateCustomPlanBundleResponse>;
@@ -38,18 +48,24 @@ export declare class PlanbundleClient {
38
48
  * @throws {@link Schematic.ForbiddenError}
39
49
  * @throws {@link Schematic.NotFoundError}
40
50
  * @throws {@link Schematic.InternalServerError}
51
+ * @throws {@link errors.SchematicError}
52
+ * @throws {@link errors.SchematicTimeoutError}
41
53
  *
42
54
  * @example
43
55
  * await client.planbundle.createPlanBundle({
44
56
  * entitlements: [{
45
57
  * action: "create"
46
- * }]
58
+ * }],
59
+ * plan: {
60
+ * name: "name",
61
+ * planType: "plan"
62
+ * }
47
63
  * })
48
64
  */
49
65
  createPlanBundle(request: Schematic.CreatePlanBundleRequestBody, requestOptions?: PlanbundleClient.RequestOptions): core.HttpResponsePromise<Schematic.CreatePlanBundleResponse>;
50
66
  private __createPlanBundle;
51
67
  /**
52
- * @param {string} plan_bundle_id - plan_bundle_id
68
+ * @param {string} plan_id - plan_id
53
69
  * @param {Schematic.UpdatePlanBundleRequestBody} request
54
70
  * @param {PlanbundleClient.RequestOptions} requestOptions - Request-specific configuration.
55
71
  *
@@ -58,14 +74,19 @@ export declare class PlanbundleClient {
58
74
  * @throws {@link Schematic.ForbiddenError}
59
75
  * @throws {@link Schematic.NotFoundError}
60
76
  * @throws {@link Schematic.InternalServerError}
77
+ * @throws {@link errors.SchematicError}
78
+ * @throws {@link errors.SchematicTimeoutError}
61
79
  *
62
80
  * @example
63
- * await client.planbundle.updatePlanBundle("plan_bundle_id", {
81
+ * await client.planbundle.updatePlanBundle("plan_id", {
64
82
  * entitlements: [{
65
83
  * action: "create"
66
- * }]
84
+ * }],
85
+ * plan: {
86
+ * name: "name"
87
+ * }
67
88
  * })
68
89
  */
69
- updatePlanBundle(plan_bundle_id: string, request: Schematic.UpdatePlanBundleRequestBody, requestOptions?: PlanbundleClient.RequestOptions): core.HttpResponsePromise<Schematic.UpdatePlanBundleResponse>;
90
+ updatePlanBundle(plan_id: string, request: Schematic.UpdatePlanBundleRequestBody, requestOptions?: PlanbundleClient.RequestOptions): core.HttpResponsePromise<Schematic.UpdatePlanBundleResponse>;
70
91
  private __updatePlanBundle;
71
92
  }
@@ -2,14 +2,22 @@ import type * as Schematic from "../../../../index";
2
2
  /**
3
3
  * @example
4
4
  * {
5
+ * billingProduct: {
6
+ * chargeType: "free",
7
+ * isTrialable: true
8
+ * },
5
9
  * entitlements: [{
6
10
  * action: "create"
7
- * }]
11
+ * }],
12
+ * plan: {
13
+ * companyId: "company_id",
14
+ * name: "name"
15
+ * }
8
16
  * }
9
17
  */
10
18
  export interface CreateCustomPlanBundleRequestBody {
11
- billingProduct?: Schematic.UpsertBillingProductRequestBody;
19
+ billingProduct: Schematic.UpsertBillingProductRequestBody;
12
20
  creditGrants?: Schematic.PlanBundleCreditGrantRequestBody[];
13
21
  entitlements: Schematic.PlanBundleEntitlementRequestBody[];
14
- plan?: Schematic.CreateCustomPlanBundlePlanRequestBody;
22
+ plan: Schematic.CreateCustomPlanBundlePlanRequestBody;
15
23
  }
@@ -4,12 +4,16 @@ import type * as Schematic from "../../../../index";
4
4
  * {
5
5
  * entitlements: [{
6
6
  * action: "create"
7
- * }]
7
+ * }],
8
+ * plan: {
9
+ * name: "name",
10
+ * planType: "plan"
11
+ * }
8
12
  * }
9
13
  */
10
14
  export interface CreatePlanBundleRequestBody {
11
15
  billingProduct?: Schematic.UpsertBillingProductRequestBody;
12
16
  creditGrants?: Schematic.PlanBundleCreditGrantRequestBody[];
13
17
  entitlements: Schematic.PlanBundleEntitlementRequestBody[];
14
- plan?: Schematic.CreatePlanRequestBody;
18
+ plan: Schematic.CreatePlanRequestBody;
15
19
  }
@@ -4,13 +4,16 @@ import type * as Schematic from "../../../../index";
4
4
  * {
5
5
  * entitlements: [{
6
6
  * action: "create"
7
- * }]
7
+ * }],
8
+ * plan: {
9
+ * name: "name"
10
+ * }
8
11
  * }
9
12
  */
10
13
  export interface UpdatePlanBundleRequestBody {
11
14
  billingProduct?: Schematic.UpsertBillingProductRequestBody;
12
15
  creditGrants?: Schematic.PlanBundleCreditGrantRequestBody[];
13
16
  entitlements: Schematic.PlanBundleEntitlementRequestBody[];
14
- plan?: Schematic.UpdatePlanRequestBody;
17
+ plan: Schematic.UpdatePlanRequestBody;
15
18
  planVersionId?: string;
16
19
  }
@@ -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({
@@ -42,6 +46,7 @@ export declare class PlangroupsClient {
42
46
  * checkoutCollectAddress: true,
43
47
  * checkoutCollectEmail: true,
44
48
  * checkoutCollectPhone: true,
49
+ * checkoutCollectTaxId: true,
45
50
  * enableTaxCollection: true,
46
51
  * optInEnabled: true,
47
52
  * orderedAddOns: [{
@@ -77,6 +82,8 @@ export declare class PlangroupsClient {
77
82
  * @throws {@link Schematic.ForbiddenError}
78
83
  * @throws {@link Schematic.NotFoundError}
79
84
  * @throws {@link Schematic.InternalServerError}
85
+ * @throws {@link errors.SchematicError}
86
+ * @throws {@link errors.SchematicTimeoutError}
80
87
  *
81
88
  * @example
82
89
  * await client.plangroups.updatePlanGroup("plan_group_id", {
@@ -84,6 +91,7 @@ export declare class PlangroupsClient {
84
91
  * checkoutCollectAddress: true,
85
92
  * checkoutCollectEmail: true,
86
93
  * checkoutCollectPhone: true,
94
+ * checkoutCollectTaxId: true,
87
95
  * enableTaxCollection: true,
88
96
  * optInEnabled: true,
89
97
  * orderedAddOns: [{
@@ -6,6 +6,7 @@ import type * as Schematic from "../../../../index";
6
6
  * checkoutCollectAddress: true,
7
7
  * checkoutCollectEmail: true,
8
8
  * checkoutCollectPhone: true,
9
+ * checkoutCollectTaxId: true,
9
10
  * enableTaxCollection: true,
10
11
  * optInEnabled: true,
11
12
  * orderedAddOns: [{
@@ -33,9 +34,11 @@ export interface CreatePlanGroupRequestBody {
33
34
  addOnCompatibilities?: Schematic.CompatiblePlans[];
34
35
  /** Use OrderedAddOns instead */
35
36
  addOnIds: string[];
37
+ checkoutBundlePurchaseBehavior?: Schematic.CheckoutBundlePurchaseBehavior;
36
38
  checkoutCollectAddress: boolean;
37
39
  checkoutCollectEmail: boolean;
38
40
  checkoutCollectPhone: boolean;
41
+ checkoutCollectTaxId: boolean;
39
42
  customCheckoutFields?: Schematic.CheckoutFieldInput[];
40
43
  customPlanConfig?: Schematic.CustomPlanConfig;
41
44
  customPlanId?: string;
@@ -6,6 +6,7 @@ import type * as Schematic from "../../../../index";
6
6
  * checkoutCollectAddress: true,
7
7
  * checkoutCollectEmail: true,
8
8
  * checkoutCollectPhone: true,
9
+ * checkoutCollectTaxId: true,
9
10
  * enableTaxCollection: true,
10
11
  * optInEnabled: true,
11
12
  * orderedAddOns: [{
@@ -33,9 +34,11 @@ export interface UpdatePlanGroupRequestBody {
33
34
  addOnCompatibilities?: Schematic.CompatiblePlans[];
34
35
  /** Use OrderedAddOns instead */
35
36
  addOnIds: string[];
37
+ checkoutBundlePurchaseBehavior?: Schematic.CheckoutBundlePurchaseBehavior;
36
38
  checkoutCollectAddress: boolean;
37
39
  checkoutCollectEmail: boolean;
38
40
  checkoutCollectPhone: boolean;
41
+ checkoutCollectTaxId: boolean;
39
42
  customCheckoutFields?: Schematic.CheckoutFieldInput[];
40
43
  customPlanConfig?: Schematic.CustomPlanConfig;
41
44
  customPlanId?: string;
@@ -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({
@@ -29,7 +31,7 @@ export declare class PlanmigrationsClient {
29
31
  * offset: 1000000
30
32
  * })
31
33
  */
32
- listCompanyMigrations(request?: Schematic.ListCompanyMigrationsRequest, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListCompanyMigrationsResponse>;
34
+ listCompanyMigrations(request: Schematic.ListCompanyMigrationsRequest, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListCompanyMigrationsResponse>;
33
35
  private __listCompanyMigrations;
34
36
  /**
35
37
  * @param {string} plan_version_company_migration_id - plan_version_company_migration_id
@@ -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({
@@ -65,7 +71,7 @@ export declare class PlanmigrationsClient {
65
71
  * offset: 1000000
66
72
  * })
67
73
  */
68
- countCompanyMigrations(request?: Schematic.CountCompanyMigrationsRequest, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.CountCompanyMigrationsResponse>;
74
+ countCompanyMigrations(request: Schematic.CountCompanyMigrationsRequest, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.CountCompanyMigrationsResponse>;
69
75
  private __countCompanyMigrations;
70
76
  /**
71
77
  * @param {Schematic.ListMigrationsRequest} request
@@ -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({
@@ -85,7 +93,7 @@ export declare class PlanmigrationsClient {
85
93
  * offset: 1000000
86
94
  * })
87
95
  */
88
- listMigrations(request?: Schematic.ListMigrationsRequest, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListMigrationsResponse>;
96
+ listMigrations(request: Schematic.ListMigrationsRequest, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListMigrationsResponse>;
89
97
  private __listMigrations;
90
98
  /**
91
99
  * @param {Schematic.CreateMigrationInput} request
@@ -96,14 +104,13 @@ 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({
102
- * companyIds: ["company_ids"],
103
- * excludedCompanyIds: ["excluded_company_ids"],
104
112
  * planId: "plan_id",
105
113
  * planVersionIdTo: "plan_version_id_to",
106
- * planVersionIdsFrom: ["plan_version_ids_from"],
107
114
  * strategy: "immediate",
108
115
  * targetPlanType: "plan"
109
116
  * })
@@ -118,6 +125,8 @@ export declare class PlanmigrationsClient {
118
125
  * @throws {@link Schematic.ForbiddenError}
119
126
  * @throws {@link Schematic.NotFoundError}
120
127
  * @throws {@link Schematic.InternalServerError}
128
+ * @throws {@link errors.SchematicError}
129
+ * @throws {@link errors.SchematicTimeoutError}
121
130
  *
122
131
  * @example
123
132
  * await client.planmigrations.getMigration("plan_version_migration_id")
@@ -134,6 +143,8 @@ export declare class PlanmigrationsClient {
134
143
  * @throws {@link Schematic.ForbiddenError}
135
144
  * @throws {@link Schematic.NotFoundError}
136
145
  * @throws {@link Schematic.InternalServerError}
146
+ * @throws {@link errors.SchematicError}
147
+ * @throws {@link errors.SchematicTimeoutError}
137
148
  *
138
149
  * @example
139
150
  * await client.planmigrations.retryMigration("plan_version_migration_id", {
@@ -151,6 +162,8 @@ export declare class PlanmigrationsClient {
151
162
  * @throws {@link Schematic.ForbiddenError}
152
163
  * @throws {@link Schematic.NotFoundError}
153
164
  * @throws {@link Schematic.InternalServerError}
165
+ * @throws {@link errors.SchematicError}
166
+ * @throws {@link errors.SchematicTimeoutError}
154
167
  *
155
168
  * @example
156
169
  * await client.planmigrations.countMigrations({
@@ -160,7 +173,7 @@ export declare class PlanmigrationsClient {
160
173
  * offset: 1000000
161
174
  * })
162
175
  */
163
- countMigrations(request?: Schematic.CountMigrationsRequest, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.CountMigrationsResponse>;
176
+ countMigrations(request: Schematic.CountMigrationsRequest, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.CountMigrationsResponse>;
164
177
  private __countMigrations;
165
178
  /**
166
179
  * @param {Schematic.PreviewMigrationRequestBody} request
@@ -171,10 +184,11 @@ export declare class PlanmigrationsClient {
171
184
  * @throws {@link Schematic.ForbiddenError}
172
185
  * @throws {@link Schematic.NotFoundError}
173
186
  * @throws {@link Schematic.InternalServerError}
187
+ * @throws {@link errors.SchematicError}
188
+ * @throws {@link errors.SchematicTimeoutError}
174
189
  *
175
190
  * @example
176
191
  * await client.planmigrations.previewMigration({
177
- * companyIds: ["company_ids"],
178
192
  * planId: "plan_id",
179
193
  * planVersionIdTo: "plan_version_id_to",
180
194
  * targetPlanType: "plan"
@@ -10,7 +10,7 @@ import type * as Schematic from "../../../../index";
10
10
  * }
11
11
  */
12
12
  export interface CountCompanyMigrationsRequest {
13
- migrationId?: string;
13
+ migrationId: string;
14
14
  q?: string;
15
15
  status?: Schematic.PlanVersionCompanyMigrationStatus;
16
16
  /** Page limit (default 100) */
@@ -9,7 +9,7 @@ import type * as Schematic from "../../../../index";
9
9
  * }
10
10
  */
11
11
  export interface CountMigrationsRequest {
12
- planVersionId?: string;
12
+ planVersionId: string;
13
13
  status?: Schematic.PlanVersionMigrationStatus;
14
14
  /** Page limit (default 100) */
15
15
  limit?: number;
@@ -2,21 +2,19 @@ import type * as Schematic from "../../../../index";
2
2
  /**
3
3
  * @example
4
4
  * {
5
- * companyIds: ["company_ids"],
6
- * excludedCompanyIds: ["excluded_company_ids"],
7
5
  * planId: "plan_id",
8
6
  * planVersionIdTo: "plan_version_id_to",
9
- * planVersionIdsFrom: ["plan_version_ids_from"],
10
7
  * strategy: "immediate",
11
8
  * targetPlanType: "plan"
12
9
  * }
13
10
  */
14
11
  export interface CreateMigrationInput {
15
- companyIds: string[];
16
- excludedCompanyIds: string[];
12
+ companyIds?: string[];
13
+ excludedCompanyIds?: string[];
17
14
  planId: string;
18
15
  planVersionIdTo: string;
19
- planVersionIdsFrom: string[];
16
+ planVersionIdsFrom?: string[];
17
+ prorationBehavior?: Schematic.MigrationProrationBehavior;
20
18
  strategy: Schematic.PlanVersionMigrationStrategy;
21
19
  targetPlanType: Schematic.PlanType;
22
20
  }
@@ -10,7 +10,7 @@ import type * as Schematic from "../../../../index";
10
10
  * }
11
11
  */
12
12
  export interface ListCompanyMigrationsRequest {
13
- migrationId?: string;
13
+ migrationId: string;
14
14
  q?: string;
15
15
  status?: Schematic.PlanVersionCompanyMigrationStatus;
16
16
  /** Page limit (default 100) */
@@ -9,7 +9,7 @@ import type * as Schematic from "../../../../index";
9
9
  * }
10
10
  */
11
11
  export interface ListMigrationsRequest {
12
- planVersionId?: string;
12
+ planVersionId: string;
13
13
  status?: Schematic.PlanVersionMigrationStatus;
14
14
  /** Page limit (default 100) */
15
15
  limit?: number;
@@ -2,15 +2,15 @@ import type * as Schematic from "../../../../index";
2
2
  /**
3
3
  * @example
4
4
  * {
5
- * companyIds: ["company_ids"],
6
5
  * planId: "plan_id",
7
6
  * planVersionIdTo: "plan_version_id_to",
8
7
  * targetPlanType: "plan"
9
8
  * }
10
9
  */
11
10
  export interface PreviewMigrationRequestBody {
12
- companyIds: string[];
11
+ companyIds?: string[];
13
12
  planId: string;
14
13
  planVersionIdTo: string;
14
+ planVersionIdsFrom?: string[];
15
15
  targetPlanType: Schematic.PlanType;
16
16
  }
@@ -11,7 +11,7 @@ export declare class PlansClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<PlansClient.Options>;
12
12
  constructor(options: PlansClient.Options);
13
13
  /**
14
- * @param {string} company_plan_id - company_plan_id
14
+ * @param {string} company_id - company_id
15
15
  * @param {Schematic.UpdateCompanyPlansRequestBody} request
16
16
  * @param {PlansClient.RequestOptions} requestOptions - Request-specific configuration.
17
17
  *
@@ -20,13 +20,15 @@ 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
- * await client.plans.updateCompanyPlans("company_plan_id", {
27
+ * await client.plans.updateCompanyPlans("company_id", {
26
28
  * addOnIds: ["add_on_ids"]
27
29
  * })
28
30
  */
29
- updateCompanyPlans(company_plan_id: string, request: Schematic.UpdateCompanyPlansRequestBody, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.UpdateCompanyPlansResponse>;
31
+ updateCompanyPlans(company_id: string, request: Schematic.UpdateCompanyPlansRequestBody, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.UpdateCompanyPlansResponse>;
30
32
  private __updateCompanyPlans;
31
33
  /**
32
34
  * @param {Schematic.ListCustomPlanBillingsRequest} request
@@ -37,11 +39,14 @@ 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({
43
47
  * companyId: "company_id",
44
48
  * planId: "plan_id",
49
+ * planBillingSource: "custom_plan",
45
50
  * status: "active",
46
51
  * statuses: ["active"],
47
52
  * limit: 1000000,
@@ -60,6 +65,8 @@ export declare class PlansClient {
60
65
  * @throws {@link Schematic.ForbiddenError}
61
66
  * @throws {@link Schematic.NotFoundError}
62
67
  * @throws {@link Schematic.InternalServerError}
68
+ * @throws {@link errors.SchematicError}
69
+ * @throws {@link errors.SchematicTimeoutError}
63
70
  *
64
71
  * @example
65
72
  * await client.plans.markCustomPlanBillingPaid("custom_plan_billing_id", {
@@ -78,6 +85,8 @@ export declare class PlansClient {
78
85
  * @throws {@link Schematic.ForbiddenError}
79
86
  * @throws {@link Schematic.NotFoundError}
80
87
  * @throws {@link Schematic.InternalServerError}
88
+ * @throws {@link errors.SchematicError}
89
+ * @throws {@link errors.SchematicTimeoutError}
81
90
  *
82
91
  * @example
83
92
  * await client.plans.retryCustomPlanBilling("custom_plan_billing_id", {
@@ -95,11 +104,12 @@ export declare class PlansClient {
95
104
  * @throws {@link Schematic.ForbiddenError}
96
105
  * @throws {@link Schematic.NotFoundError}
97
106
  * @throws {@link Schematic.InternalServerError}
107
+ * @throws {@link errors.SchematicError}
108
+ * @throws {@link errors.SchematicTimeoutError}
98
109
  *
99
110
  * @example
100
111
  * await client.plans.createCustomPlan({
101
112
  * companyId: "company_id",
102
- * description: "description",
103
113
  * name: "name"
104
114
  * })
105
115
  */
@@ -114,6 +124,8 @@ export declare class PlansClient {
114
124
  * @throws {@link Schematic.ForbiddenError}
115
125
  * @throws {@link Schematic.NotFoundError}
116
126
  * @throws {@link Schematic.InternalServerError}
127
+ * @throws {@link errors.SchematicError}
128
+ * @throws {@link errors.SchematicTimeoutError}
117
129
  *
118
130
  * @example
119
131
  * await client.plans.listPlans({
@@ -147,10 +159,11 @@ export declare class PlansClient {
147
159
  * @throws {@link Schematic.ForbiddenError}
148
160
  * @throws {@link Schematic.NotFoundError}
149
161
  * @throws {@link Schematic.InternalServerError}
162
+ * @throws {@link errors.SchematicError}
163
+ * @throws {@link errors.SchematicTimeoutError}
150
164
  *
151
165
  * @example
152
166
  * await client.plans.createPlan({
153
- * description: "description",
154
167
  * name: "name",
155
168
  * planType: "plan"
156
169
  * })
@@ -166,6 +179,8 @@ export declare class PlansClient {
166
179
  * @throws {@link Schematic.ForbiddenError}
167
180
  * @throws {@link Schematic.NotFoundError}
168
181
  * @throws {@link Schematic.InternalServerError}
182
+ * @throws {@link errors.SchematicError}
183
+ * @throws {@link errors.SchematicTimeoutError}
169
184
  *
170
185
  * @example
171
186
  * await client.plans.getPlan("plan_id", {
@@ -184,6 +199,8 @@ export declare class PlansClient {
184
199
  * @throws {@link Schematic.ForbiddenError}
185
200
  * @throws {@link Schematic.NotFoundError}
186
201
  * @throws {@link Schematic.InternalServerError}
202
+ * @throws {@link errors.SchematicError}
203
+ * @throws {@link errors.SchematicTimeoutError}
187
204
  *
188
205
  * @example
189
206
  * await client.plans.updatePlan("plan_id", {
@@ -201,6 +218,8 @@ export declare class PlansClient {
201
218
  * @throws {@link Schematic.ForbiddenError}
202
219
  * @throws {@link Schematic.NotFoundError}
203
220
  * @throws {@link Schematic.InternalServerError}
221
+ * @throws {@link errors.SchematicError}
222
+ * @throws {@link errors.SchematicTimeoutError}
204
223
  *
205
224
  * @example
206
225
  * await client.plans.deletePlan("plan_id")
@@ -217,6 +236,8 @@ export declare class PlansClient {
217
236
  * @throws {@link Schematic.ForbiddenError}
218
237
  * @throws {@link Schematic.NotFoundError}
219
238
  * @throws {@link Schematic.InternalServerError}
239
+ * @throws {@link errors.SchematicError}
240
+ * @throws {@link errors.SchematicTimeoutError}
220
241
  *
221
242
  * @example
222
243
  * await client.plans.upsertBillingProductPlan("plan_id", {
@@ -235,11 +256,12 @@ export declare class PlansClient {
235
256
  * @throws {@link Schematic.ForbiddenError}
236
257
  * @throws {@link Schematic.NotFoundError}
237
258
  * @throws {@link Schematic.InternalServerError}
259
+ * @throws {@link errors.SchematicError}
260
+ * @throws {@link errors.SchematicTimeoutError}
238
261
  *
239
262
  * @example
240
263
  * await client.plans.upsertPlanForBillingProduct({
241
264
  * billingProvider: "metronome",
242
- * description: "description",
243
265
  * externalResourceId: "external_resource_id",
244
266
  * name: "name",
245
267
  * planType: "plan"
@@ -256,6 +278,8 @@ export declare class PlansClient {
256
278
  * @throws {@link Schematic.ForbiddenError}
257
279
  * @throws {@link Schematic.NotFoundError}
258
280
  * @throws {@link Schematic.InternalServerError}
281
+ * @throws {@link errors.SchematicError}
282
+ * @throws {@link errors.SchematicTimeoutError}
259
283
  *
260
284
  * @example
261
285
  * await client.plans.listBillingProductMatchCompanies({
@@ -276,6 +300,8 @@ export declare class PlansClient {
276
300
  * @throws {@link Schematic.ForbiddenError}
277
301
  * @throws {@link Schematic.NotFoundError}
278
302
  * @throws {@link Schematic.InternalServerError}
303
+ * @throws {@link errors.SchematicError}
304
+ * @throws {@link errors.SchematicTimeoutError}
279
305
  *
280
306
  * @example
281
307
  * await client.plans.countBillingProductMatchCompanies({
@@ -296,6 +322,8 @@ export declare class PlansClient {
296
322
  * @throws {@link Schematic.ForbiddenError}
297
323
  * @throws {@link Schematic.NotFoundError}
298
324
  * @throws {@link Schematic.InternalServerError}
325
+ * @throws {@link errors.SchematicError}
326
+ * @throws {@link errors.SchematicTimeoutError}
299
327
  *
300
328
  * @example
301
329
  * await client.plans.countPlans({
@@ -329,6 +357,8 @@ export declare class PlansClient {
329
357
  * @throws {@link Schematic.ForbiddenError}
330
358
  * @throws {@link Schematic.NotFoundError}
331
359
  * @throws {@link Schematic.InternalServerError}
360
+ * @throws {@link errors.SchematicError}
361
+ * @throws {@link errors.SchematicTimeoutError}
332
362
  *
333
363
  * @example
334
364
  * await client.plans.listPlanIssues({
@@ -339,7 +369,7 @@ export declare class PlansClient {
339
369
  listPlanIssues(request: Schematic.ListPlanIssuesRequest, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.ListPlanIssuesResponse>;
340
370
  private __listPlanIssues;
341
371
  /**
342
- * @param {string} plan_id - plan_id
372
+ * @param {string} plan_version_id - plan_version_id
343
373
  * @param {Schematic.DeletePlanVersionRequest} request
344
374
  * @param {PlansClient.RequestOptions} requestOptions - Request-specific configuration.
345
375
  *
@@ -348,16 +378,18 @@ export declare class PlansClient {
348
378
  * @throws {@link Schematic.ForbiddenError}
349
379
  * @throws {@link Schematic.NotFoundError}
350
380
  * @throws {@link Schematic.InternalServerError}
381
+ * @throws {@link errors.SchematicError}
382
+ * @throws {@link errors.SchematicTimeoutError}
351
383
  *
352
384
  * @example
353
- * await client.plans.deletePlanVersion("plan_id", {
385
+ * await client.plans.deletePlanVersion("plan_version_id", {
354
386
  * promoteArchivedVersion: true
355
387
  * })
356
388
  */
357
- deletePlanVersion(plan_id: string, request?: Schematic.DeletePlanVersionRequest, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.DeletePlanVersionResponse>;
389
+ deletePlanVersion(plan_version_id: string, request?: Schematic.DeletePlanVersionRequest, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.DeletePlanVersionResponse>;
358
390
  private __deletePlanVersion;
359
391
  /**
360
- * @param {string} plan_id - plan_id
392
+ * @param {string} plan_version_id - plan_version_id
361
393
  * @param {Schematic.PublishPlanVersionRequestBody} request
362
394
  * @param {PlansClient.RequestOptions} requestOptions - Request-specific configuration.
363
395
  *
@@ -366,13 +398,15 @@ export declare class PlansClient {
366
398
  * @throws {@link Schematic.ForbiddenError}
367
399
  * @throws {@link Schematic.NotFoundError}
368
400
  * @throws {@link Schematic.InternalServerError}
401
+ * @throws {@link errors.SchematicError}
402
+ * @throws {@link errors.SchematicTimeoutError}
369
403
  *
370
404
  * @example
371
- * await client.plans.publishPlanVersion("plan_id", {
405
+ * await client.plans.publishPlanVersion("plan_version_id", {
372
406
  * excludedCompanyIds: ["excluded_company_ids"],
373
407
  * migrationStrategy: "immediate"
374
408
  * })
375
409
  */
376
- publishPlanVersion(plan_id: string, request: Schematic.PublishPlanVersionRequestBody, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.PublishPlanVersionResponse>;
410
+ publishPlanVersion(plan_version_id: string, request: Schematic.PublishPlanVersionRequestBody, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.PublishPlanVersionResponse>;
377
411
  private __publishPlanVersion;
378
412
  }