@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,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({
@@ -190,6 +208,31 @@ export declare class EntitlementsClient {
190
208
  */
191
209
  listFeatureUsage(request?: Schematic.ListFeatureUsageRequest, requestOptions?: EntitlementsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListFeatureUsageResponse>;
192
210
  private __listFeatureUsage;
211
+ /**
212
+ * @param {Schematic.ListFeatureUsageHistoryRequest} request
213
+ * @param {EntitlementsClient.RequestOptions} requestOptions - Request-specific configuration.
214
+ *
215
+ * @throws {@link Schematic.BadRequestError}
216
+ * @throws {@link Schematic.UnauthorizedError}
217
+ * @throws {@link Schematic.ForbiddenError}
218
+ * @throws {@link Schematic.NotFoundError}
219
+ * @throws {@link Schematic.InternalServerError}
220
+ * @throws {@link errors.SchematicError}
221
+ * @throws {@link errors.SchematicTimeoutError}
222
+ *
223
+ * @example
224
+ * await client.entitlements.listFeatureUsageHistory({
225
+ * companyIds: ["company_ids"],
226
+ * endTime: new Date("2024-01-15T09:30:00.000Z"),
227
+ * featureIds: ["feature_ids"],
228
+ * granularity: "daily",
229
+ * startTime: new Date("2024-01-15T09:30:00.000Z"),
230
+ * limit: 1000000,
231
+ * offset: 1000000
232
+ * })
233
+ */
234
+ listFeatureUsageHistory(request: Schematic.ListFeatureUsageHistoryRequest, requestOptions?: EntitlementsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListFeatureUsageHistoryResponse>;
235
+ private __listFeatureUsageHistory;
193
236
  /**
194
237
  * @param {Schematic.GetFeatureUsageTimeSeriesRequest} request
195
238
  * @param {EntitlementsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -198,6 +241,8 @@ export declare class EntitlementsClient {
198
241
  * @throws {@link Schematic.ForbiddenError}
199
242
  * @throws {@link Schematic.NotFoundError}
200
243
  * @throws {@link Schematic.InternalServerError}
244
+ * @throws {@link errors.SchematicError}
245
+ * @throws {@link errors.SchematicTimeoutError}
201
246
  *
202
247
  * @example
203
248
  * await client.entitlements.getFeatureUsageTimeSeries({
@@ -219,6 +264,8 @@ export declare class EntitlementsClient {
219
264
  * @throws {@link Schematic.ForbiddenError}
220
265
  * @throws {@link Schematic.NotFoundError}
221
266
  * @throws {@link Schematic.InternalServerError}
267
+ * @throws {@link errors.SchematicError}
268
+ * @throws {@link errors.SchematicTimeoutError}
222
269
  *
223
270
  * @example
224
271
  * await client.entitlements.countFeatureUsage({
@@ -243,6 +290,8 @@ export declare class EntitlementsClient {
243
290
  * @throws {@link Schematic.ForbiddenError}
244
291
  * @throws {@link Schematic.NotFoundError}
245
292
  * @throws {@link Schematic.InternalServerError}
293
+ * @throws {@link errors.SchematicError}
294
+ * @throws {@link errors.SchematicTimeoutError}
246
295
  *
247
296
  * @example
248
297
  * await client.entitlements.listFeatureUsers({
@@ -263,6 +312,8 @@ export declare class EntitlementsClient {
263
312
  * @throws {@link Schematic.ForbiddenError}
264
313
  * @throws {@link Schematic.NotFoundError}
265
314
  * @throws {@link Schematic.InternalServerError}
315
+ * @throws {@link errors.SchematicError}
316
+ * @throws {@link errors.SchematicTimeoutError}
266
317
  *
267
318
  * @example
268
319
  * await client.entitlements.countFeatureUsers({
@@ -283,6 +334,8 @@ export declare class EntitlementsClient {
283
334
  * @throws {@link Schematic.ForbiddenError}
284
335
  * @throws {@link Schematic.NotFoundError}
285
336
  * @throws {@link Schematic.InternalServerError}
337
+ * @throws {@link errors.SchematicError}
338
+ * @throws {@link errors.SchematicTimeoutError}
286
339
  *
287
340
  * @example
288
341
  * await client.entitlements.listPlanEntitlements({
@@ -310,6 +363,8 @@ export declare class EntitlementsClient {
310
363
  * @throws {@link Schematic.ForbiddenError}
311
364
  * @throws {@link Schematic.NotFoundError}
312
365
  * @throws {@link Schematic.InternalServerError}
366
+ * @throws {@link errors.SchematicError}
367
+ * @throws {@link errors.SchematicTimeoutError}
313
368
  *
314
369
  * @example
315
370
  * await client.entitlements.createPlanEntitlement({
@@ -328,6 +383,8 @@ export declare class EntitlementsClient {
328
383
  * @throws {@link Schematic.ForbiddenError}
329
384
  * @throws {@link Schematic.NotFoundError}
330
385
  * @throws {@link Schematic.InternalServerError}
386
+ * @throws {@link errors.SchematicError}
387
+ * @throws {@link errors.SchematicTimeoutError}
331
388
  *
332
389
  * @example
333
390
  * await client.entitlements.getPlanEntitlement("plan_entitlement_id")
@@ -344,6 +401,8 @@ export declare class EntitlementsClient {
344
401
  * @throws {@link Schematic.ForbiddenError}
345
402
  * @throws {@link Schematic.NotFoundError}
346
403
  * @throws {@link Schematic.InternalServerError}
404
+ * @throws {@link errors.SchematicError}
405
+ * @throws {@link errors.SchematicTimeoutError}
347
406
  *
348
407
  * @example
349
408
  * await client.entitlements.updatePlanEntitlement("plan_entitlement_id", {
@@ -361,6 +420,8 @@ export declare class EntitlementsClient {
361
420
  * @throws {@link Schematic.ForbiddenError}
362
421
  * @throws {@link Schematic.NotFoundError}
363
422
  * @throws {@link Schematic.InternalServerError}
423
+ * @throws {@link errors.SchematicError}
424
+ * @throws {@link errors.SchematicTimeoutError}
364
425
  *
365
426
  * @example
366
427
  * await client.entitlements.deletePlanEntitlement("plan_entitlement_id")
@@ -376,6 +437,8 @@ export declare class EntitlementsClient {
376
437
  * @throws {@link Schematic.ForbiddenError}
377
438
  * @throws {@link Schematic.NotFoundError}
378
439
  * @throws {@link Schematic.InternalServerError}
440
+ * @throws {@link errors.SchematicError}
441
+ * @throws {@link errors.SchematicTimeoutError}
379
442
  *
380
443
  * @example
381
444
  * await client.entitlements.upsertPlanEntitlementForBillingProduct({
@@ -397,6 +460,8 @@ export declare class EntitlementsClient {
397
460
  * @throws {@link Schematic.ForbiddenError}
398
461
  * @throws {@link Schematic.NotFoundError}
399
462
  * @throws {@link Schematic.InternalServerError}
463
+ * @throws {@link errors.SchematicError}
464
+ * @throws {@link errors.SchematicTimeoutError}
400
465
  *
401
466
  * @example
402
467
  * await client.entitlements.countPlanEntitlements({
@@ -424,6 +489,8 @@ export declare class EntitlementsClient {
424
489
  * @throws {@link Schematic.ForbiddenError}
425
490
  * @throws {@link Schematic.NotFoundError}
426
491
  * @throws {@link Schematic.InternalServerError}
492
+ * @throws {@link errors.SchematicError}
493
+ * @throws {@link errors.SchematicTimeoutError}
427
494
  *
428
495
  * @example
429
496
  * await client.entitlements.duplicatePlanEntitlements({
@@ -441,6 +508,8 @@ export declare class EntitlementsClient {
441
508
  * @throws {@link Schematic.ForbiddenError}
442
509
  * @throws {@link Schematic.NotFoundError}
443
510
  * @throws {@link Schematic.InternalServerError}
511
+ * @throws {@link errors.SchematicError}
512
+ * @throws {@link errors.SchematicTimeoutError}
444
513
  *
445
514
  * @example
446
515
  * await client.entitlements.getFeatureUsageByCompany({
@@ -459,6 +528,8 @@ export declare class EntitlementsClient {
459
528
  * @throws {@link Schematic.ForbiddenError}
460
529
  * @throws {@link Schematic.NotFoundError}
461
530
  * @throws {@link Schematic.InternalServerError}
531
+ * @throws {@link errors.SchematicError}
532
+ * @throws {@link errors.SchematicTimeoutError}
462
533
  *
463
534
  * @example
464
535
  * await client.entitlements.getUserUsageByCompany({
@@ -478,6 +549,8 @@ export declare class EntitlementsClient {
478
549
  * @throws {@link Schematic.ForbiddenError}
479
550
  * @throws {@link Schematic.NotFoundError}
480
551
  * @throws {@link Schematic.InternalServerError}
552
+ * @throws {@link errors.SchematicError}
553
+ * @throws {@link errors.SchematicTimeoutError}
481
554
  *
482
555
  * @example
483
556
  * await client.entitlements.getUserUsageDetail({
@@ -0,0 +1,29 @@
1
+ import type * as Schematic from "../../../../index";
2
+ /**
3
+ * @example
4
+ * {
5
+ * companyIds: ["company_ids"],
6
+ * endTime: new Date("2024-01-15T09:30:00.000Z"),
7
+ * featureIds: ["feature_ids"],
8
+ * granularity: "daily",
9
+ * startTime: new Date("2024-01-15T09:30:00.000Z"),
10
+ * limit: 1000000,
11
+ * offset: 1000000
12
+ * }
13
+ */
14
+ export interface ListFeatureUsageHistoryRequest {
15
+ /** Restrict to these company IDs; omit for every company in the environment */
16
+ companyIds?: string | string[];
17
+ /** Exclusive end of the window; must fall on an hour boundary */
18
+ endTime: Date;
19
+ /** Restrict to these event features; omit for every event feature in the environment. Where several features measure the same event, each is reported separately and a page may carry more rows than the requested limit */
20
+ featureIds?: string | string[];
21
+ /** Bucket the window; omit for a single total per company and feature */
22
+ granularity?: Schematic.TimeSeriesGranularity;
23
+ /** Inclusive start of the window; must fall on an hour boundary */
24
+ startTime: Date;
25
+ /** Page limit (default 100) */
26
+ limit?: number;
27
+ /** Page offset (default 0) */
28
+ offset?: number;
29
+ }
@@ -13,6 +13,7 @@ export type { GetUserUsageByCompanyRequest } from "./GetUserUsageByCompanyReques
13
13
  export type { GetUserUsageDetailRequest } from "./GetUserUsageDetailRequest";
14
14
  export type { ListCompanyOverridesRequest } from "./ListCompanyOverridesRequest";
15
15
  export type { ListFeatureCompaniesRequest } from "./ListFeatureCompaniesRequest";
16
+ export type { ListFeatureUsageHistoryRequest } from "./ListFeatureUsageHistoryRequest";
16
17
  export type { ListFeatureUsageRequest } from "./ListFeatureUsageRequest";
17
18
  export type { ListFeatureUsersRequest } from "./ListFeatureUsersRequest";
18
19
  export type { ListPlanEntitlementsRequest } from "./ListPlanEntitlementsRequest";
@@ -0,0 +1,20 @@
1
+ import type * as Schematic from "../../../index";
2
+ /**
3
+ * Input parameters
4
+ */
5
+ export interface ListFeatureUsageHistoryParams {
6
+ /** Restrict to these company IDs; omit for every company in the environment */
7
+ companyIds?: string[];
8
+ /** Exclusive end of the window; must fall on an hour boundary */
9
+ endTime?: Date;
10
+ /** Restrict to these event features; omit for every event feature in the environment. Where several features measure the same event, each is reported separately and a page may carry more rows than the requested limit */
11
+ featureIds?: string[];
12
+ /** Bucket the window; omit for a single total per company and feature */
13
+ granularity?: Schematic.TimeSeriesGranularity;
14
+ /** Page limit (default 100) */
15
+ limit?: number;
16
+ /** Page offset (default 0) */
17
+ offset?: number;
18
+ /** Inclusive start of the window; must fall on an hour boundary */
19
+ startTime?: Date;
20
+ }
@@ -0,0 +1,6 @@
1
+ import type * as Schematic from "../../../index";
2
+ export interface ListFeatureUsageHistoryResponse {
3
+ data: Schematic.FeatureUsageHistoryResponseData[];
4
+ /** Input parameters */
5
+ params: Schematic.ListFeatureUsageHistoryParams;
6
+ }
@@ -27,6 +27,8 @@ export * from "./ListCompanyOverridesParams";
27
27
  export * from "./ListCompanyOverridesResponse";
28
28
  export * from "./ListFeatureCompaniesParams";
29
29
  export * from "./ListFeatureCompaniesResponse";
30
+ export * from "./ListFeatureUsageHistoryParams";
31
+ export * from "./ListFeatureUsageHistoryResponse";
30
32
  export * from "./ListFeatureUsageParams";
31
33
  export * from "./ListFeatureUsageResponse";
32
34
  export * from "./ListFeatureUsersParams";
@@ -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()
@@ -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({