@schematichq/schematic-typescript-node 1.4.6 → 1.4.8

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 (647) hide show
  1. package/README.md +118 -2
  2. package/dist/BaseClient.d.ts +3 -0
  3. package/dist/Client.d.ts +5 -20
  4. package/dist/api/resources/accounts/client/Client.d.ts +22 -0
  5. package/dist/api/resources/accounts/client/requests/CountAccountMembersRequest.d.ts +18 -0
  6. package/dist/api/resources/accounts/client/requests/ListAccountMembersRequest.d.ts +1 -0
  7. package/dist/api/resources/accounts/client/requests/ListEnvironmentsRequest.d.ts +1 -0
  8. package/dist/api/resources/accounts/client/requests/index.d.ts +1 -0
  9. package/dist/api/resources/accounts/types/CountAccountMembersParams.d.ts +12 -0
  10. package/dist/api/resources/accounts/types/CountAccountMembersResponse.d.ts +6 -0
  11. package/dist/api/resources/accounts/types/index.d.ts +2 -0
  12. package/dist/api/resources/billing/client/Client.d.ts +31 -6
  13. package/dist/api/resources/billing/client/requests/CountBillingProductsRequest.d.ts +5 -1
  14. package/dist/api/resources/billing/client/requests/CountCustomersRequest.d.ts +2 -1
  15. package/dist/api/resources/billing/client/requests/CreateBillingPriceRequestBody.d.ts +2 -0
  16. package/dist/api/resources/billing/client/requests/ListBillingPricesRequest.d.ts +3 -1
  17. package/dist/api/resources/billing/client/requests/ListBillingProductPricesRequest.d.ts +3 -1
  18. package/dist/api/resources/billing/client/requests/ListBillingProductsRequest.d.ts +5 -1
  19. package/dist/api/resources/billing/client/requests/ListCustomersWithSubscriptionsRequest.d.ts +2 -1
  20. package/dist/api/resources/billing/types/CountBillingProductsParams.d.ts +2 -0
  21. package/dist/api/resources/billing/types/DeletePaymentMethodByExternalIdResponse.d.ts +6 -0
  22. package/dist/api/resources/billing/types/ListBillingProductsParams.d.ts +2 -0
  23. package/dist/api/resources/billing/types/index.d.ts +1 -0
  24. package/dist/api/resources/checkout/client/Client.d.ts +22 -0
  25. package/dist/api/resources/companies/client/Client.d.ts +27 -53
  26. package/dist/api/resources/companies/client/requests/CountCompaniesRequest.d.ts +8 -0
  27. package/dist/api/resources/companies/client/requests/CountEntityKeyDefinitionsRequest.d.ts +1 -0
  28. package/dist/api/resources/companies/client/requests/CountEntityTraitDefinitionsRequest.d.ts +2 -0
  29. package/dist/api/resources/companies/client/requests/CountPlanTraitsRequest.d.ts +2 -0
  30. package/dist/api/resources/companies/client/requests/CountUsersRequest.d.ts +1 -0
  31. package/dist/api/resources/companies/client/requests/GetActiveCompanySubscriptionRequest.d.ts +1 -0
  32. package/dist/api/resources/companies/client/requests/ListCompaniesRequest.d.ts +8 -0
  33. package/dist/api/resources/companies/client/requests/ListEntityKeyDefinitionsRequest.d.ts +1 -0
  34. package/dist/api/resources/companies/client/requests/ListEntityTraitDefinitionsRequest.d.ts +2 -0
  35. package/dist/api/resources/companies/client/requests/ListPlanChangesRequest.d.ts +2 -0
  36. package/dist/api/resources/companies/client/requests/ListPlanTraitsRequest.d.ts +2 -0
  37. package/dist/api/resources/companies/client/requests/ListUsersRequest.d.ts +1 -0
  38. package/dist/api/resources/companies/client/requests/index.d.ts +0 -2
  39. package/dist/api/resources/companies/types/CountCompaniesParams.d.ts +2 -0
  40. package/dist/api/resources/companies/types/ListCompaniesParams.d.ts +2 -0
  41. package/dist/api/resources/companies/types/index.d.ts +0 -3
  42. package/dist/api/resources/credits/client/Client.d.ts +84 -0
  43. package/dist/api/resources/credits/client/requests/AcquireCreditLeaseRequestBody.d.ts +14 -0
  44. package/dist/api/resources/credits/client/requests/CountBillingCreditsGrantsRequest.d.ts +1 -0
  45. package/dist/api/resources/credits/client/requests/CountBillingCreditsRequest.d.ts +1 -0
  46. package/dist/api/resources/credits/client/requests/CountBillingPlanCreditGrantsRequest.d.ts +4 -0
  47. package/dist/api/resources/credits/client/requests/CountCreditBundlesRequest.d.ts +1 -0
  48. package/dist/api/resources/credits/client/requests/ExtendCreditLeaseRequestBody.d.ts +10 -0
  49. package/dist/api/resources/credits/client/requests/ListBillingCreditsRequest.d.ts +1 -0
  50. package/dist/api/resources/credits/client/requests/ListBillingPlanCreditGrantsRequest.d.ts +4 -0
  51. package/dist/api/resources/credits/client/requests/ListCompanyCreditBalancesRequest.d.ts +9 -0
  52. package/dist/api/resources/credits/client/requests/ListCreditBundlesRequest.d.ts +1 -0
  53. package/dist/api/resources/credits/client/requests/ListGrantsForCreditRequest.d.ts +1 -0
  54. package/dist/api/resources/credits/client/requests/index.d.ts +3 -0
  55. package/dist/api/resources/credits/types/AcquireCreditLeaseResponse.d.ts +6 -0
  56. package/dist/api/resources/credits/types/CountBillingPlanCreditGrantsParams.d.ts +1 -0
  57. package/dist/api/resources/credits/types/ExtendCreditLeaseResponse.d.ts +6 -0
  58. package/dist/api/resources/credits/types/ListBillingPlanCreditGrantsParams.d.ts +1 -0
  59. package/dist/api/resources/credits/types/ListCompanyCreditBalancesParams.d.ts +6 -0
  60. package/dist/api/resources/credits/types/ListCompanyCreditBalancesResponse.d.ts +6 -0
  61. package/dist/api/resources/credits/types/ReleaseCreditLeaseResponse.d.ts +6 -0
  62. package/dist/api/resources/credits/types/index.d.ts +5 -0
  63. package/dist/api/resources/entitlements/client/Client.d.ts +19 -1
  64. package/dist/api/resources/entitlements/client/requests/CountCompanyOverridesRequest.d.ts +3 -0
  65. package/dist/api/resources/entitlements/client/requests/CountFeatureUsageRequest.d.ts +5 -0
  66. package/dist/api/resources/entitlements/client/requests/CountPlanEntitlementsRequest.d.ts +4 -0
  67. package/dist/api/resources/entitlements/client/requests/CreateBillingLinkedPlanEntitlementRequestBody.d.ts +9 -3
  68. package/dist/api/resources/entitlements/client/requests/CreateCompanyOverrideRequestBody.d.ts +2 -2
  69. package/dist/api/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +8 -2
  70. package/dist/api/resources/entitlements/client/requests/ListCompanyOverridesRequest.d.ts +3 -0
  71. package/dist/api/resources/entitlements/client/requests/ListFeatureUsageRequest.d.ts +5 -0
  72. package/dist/api/resources/entitlements/client/requests/ListPlanEntitlementsRequest.d.ts +4 -0
  73. package/dist/api/resources/entitlements/client/requests/UpdateCompanyOverrideRequestBody.d.ts +2 -2
  74. package/dist/api/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts +8 -2
  75. package/dist/api/resources/entitlements/types/CountFeatureUsageParams.d.ts +3 -0
  76. package/dist/api/resources/entitlements/types/ListFeatureUsageParams.d.ts +3 -0
  77. package/dist/api/resources/entitlements/types/index.d.ts +0 -10
  78. package/dist/api/resources/events/client/Client.d.ts +3 -0
  79. package/dist/api/resources/events/client/requests/GetEventSummariesRequest.d.ts +1 -0
  80. package/dist/api/resources/events/client/requests/ListEventsRequest.d.ts +3 -0
  81. package/dist/api/resources/events/types/ListEventsParams.d.ts +1 -0
  82. package/dist/api/resources/features/client/Client.d.ts +11 -3
  83. package/dist/api/resources/features/client/requests/CountFeaturesRequest.d.ts +5 -0
  84. package/dist/api/resources/features/client/requests/CountFlagsRequest.d.ts +1 -0
  85. package/dist/api/resources/features/client/requests/CreateBillingLinkedFeatureRequestBody.d.ts +2 -2
  86. package/dist/api/resources/features/client/requests/CreateFeatureRequestBody.d.ts +1 -1
  87. package/dist/api/resources/features/client/requests/ListFeaturesRequest.d.ts +5 -0
  88. package/dist/api/resources/features/client/requests/ListFlagsRequest.d.ts +1 -0
  89. package/dist/api/resources/features/client/requests/UpdateFeatureRequestBody.d.ts +1 -1
  90. package/dist/api/resources/features/client/requests/UpdateFlagRulesRequestBody.d.ts +2 -2
  91. package/dist/api/resources/features/types/CountFeaturesParams.d.ts +2 -0
  92. package/dist/api/resources/features/types/ListFeaturesParams.d.ts +2 -0
  93. package/dist/api/resources/index.d.ts +4 -0
  94. package/dist/api/resources/insights/client/Client.d.ts +114 -0
  95. package/dist/api/resources/insights/client/index.d.ts +1 -0
  96. package/dist/api/resources/insights/client/requests/GetActivityRequest.d.ts +9 -0
  97. package/dist/api/resources/insights/client/requests/GetEnvironmentFeatureUsageTimeSeriesRequest.d.ts +16 -0
  98. package/dist/api/resources/insights/client/requests/GetEnvironmentTraitUsageTimeSeriesRequest.d.ts +16 -0
  99. package/dist/api/resources/insights/client/requests/GetPlanGrowthRequest.d.ts +9 -0
  100. package/dist/api/resources/insights/client/requests/GetTopFeaturesByUsageRequest.d.ts +13 -0
  101. package/dist/api/resources/insights/client/requests/index.d.ts +5 -0
  102. package/dist/api/resources/insights/exports.d.ts +2 -0
  103. package/dist/api/resources/insights/index.d.ts +2 -0
  104. package/dist/api/resources/insights/types/GetActivityParams.d.ts +6 -0
  105. package/dist/api/resources/insights/types/GetActivityResponse.d.ts +6 -0
  106. package/dist/api/resources/insights/types/GetEnvironmentFeatureUsageTimeSeriesParams.d.ts +10 -0
  107. package/dist/api/resources/insights/types/GetEnvironmentFeatureUsageTimeSeriesResponse.d.ts +6 -0
  108. package/dist/api/resources/insights/types/GetEnvironmentTraitUsageTimeSeriesParams.d.ts +10 -0
  109. package/dist/api/resources/insights/types/GetEnvironmentTraitUsageTimeSeriesResponse.d.ts +6 -0
  110. package/dist/api/resources/insights/types/GetPlanGrowthParams.d.ts +6 -0
  111. package/dist/api/resources/insights/types/GetPlanGrowthResponse.d.ts +6 -0
  112. package/dist/api/resources/{companies/types/UpdatePlanTraitResponse.d.ts → insights/types/GetSummaryResponse.d.ts} +2 -2
  113. package/dist/api/resources/insights/types/GetTopFeaturesByUsageParams.d.ts +8 -0
  114. package/dist/api/resources/insights/types/GetTopFeaturesByUsageResponse.d.ts +6 -0
  115. package/dist/api/resources/insights/types/index.d.ts +11 -0
  116. package/dist/api/resources/integrationsapi/client/Client.d.ts +133 -0
  117. package/dist/api/resources/integrationsapi/client/index.d.ts +1 -1
  118. package/dist/api/resources/integrationsapi/client/requests/ListIntegrationsRequest.d.ts +24 -0
  119. package/dist/api/resources/integrationsapi/client/requests/StartDataImportRequestBody.d.ts +12 -0
  120. package/dist/api/resources/integrationsapi/client/requests/index.d.ts +2 -0
  121. package/dist/api/resources/integrationsapi/types/AssumeStripeInstalledResponse.d.ts +6 -0
  122. package/dist/api/resources/integrationsapi/types/InstallIntegrationResponse.d.ts +6 -0
  123. package/dist/api/resources/integrationsapi/types/InstallStripeResponse.d.ts +6 -0
  124. package/dist/api/resources/integrationsapi/types/ListIntegrationsParams.d.ts +15 -0
  125. package/dist/api/resources/integrationsapi/types/ListIntegrationsResponse.d.ts +6 -0
  126. package/dist/api/resources/integrationsapi/types/LoadSampleDataSetResponse.d.ts +6 -0
  127. package/dist/api/resources/{companies/types/CreatePlanTraitResponse.d.ts → integrationsapi/types/RunIntegrationResponse.d.ts} +2 -2
  128. package/dist/api/resources/integrationsapi/types/StartDataImportResponse.d.ts +6 -0
  129. package/dist/api/resources/{companies/types/DeletePlanTraitResponse.d.ts → integrationsapi/types/UninstallIntegrationResponse.d.ts} +1 -1
  130. package/dist/api/resources/integrationsapi/types/index.d.ts +9 -0
  131. package/dist/api/resources/planbundle/client/Client.d.ts +19 -0
  132. package/dist/api/resources/planbundle/client/requests/CreateCustomPlanBundleRequestBody.d.ts +14 -0
  133. package/dist/api/resources/planbundle/client/requests/index.d.ts +1 -0
  134. package/dist/api/resources/planbundle/types/CreateCustomPlanBundleResponse.d.ts +6 -0
  135. package/dist/api/resources/planbundle/types/index.d.ts +1 -0
  136. package/dist/api/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +1 -0
  137. package/dist/api/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +1 -0
  138. package/dist/api/resources/planmigrations/client/Client.d.ts +56 -0
  139. package/dist/api/resources/planmigrations/client/requests/CreateMigrationInput.d.ts +22 -0
  140. package/dist/api/resources/planmigrations/client/requests/RetryMigrationRequestBody.d.ts +10 -0
  141. package/dist/api/resources/planmigrations/client/requests/index.d.ts +2 -0
  142. package/dist/api/resources/planmigrations/types/CreateMigrationResponse.d.ts +6 -0
  143. package/dist/api/resources/planmigrations/types/RetryCompanyMigrationResponse.d.ts +6 -0
  144. package/dist/api/resources/planmigrations/types/RetryMigrationResponse.d.ts +6 -0
  145. package/dist/api/resources/planmigrations/types/index.d.ts +3 -0
  146. package/dist/api/resources/plans/client/Client.d.ts +71 -1
  147. package/dist/api/resources/plans/client/requests/CountPlansRequest.d.ts +10 -0
  148. package/dist/api/resources/plans/client/requests/CreateBillingLinkedPlanRequestBody.d.ts +2 -1
  149. package/dist/api/resources/plans/client/requests/ListCustomPlanBillingsRequest.d.ts +26 -0
  150. package/dist/api/resources/plans/client/requests/ListPlansRequest.d.ts +10 -0
  151. package/dist/api/resources/plans/client/requests/RetryCustomPlanBillingRequestBody.d.ts +17 -0
  152. package/dist/api/resources/plans/client/requests/index.d.ts +2 -0
  153. package/dist/api/resources/plans/types/CountPlansParams.d.ts +6 -0
  154. package/dist/api/resources/plans/types/ListCustomPlanBillingsParams.d.ts +18 -0
  155. package/dist/api/resources/plans/types/ListCustomPlanBillingsResponse.d.ts +6 -0
  156. package/dist/api/resources/plans/types/ListPlansParams.d.ts +6 -0
  157. package/dist/api/resources/plans/types/MarkCustomPlanBillingPaidResponse.d.ts +6 -0
  158. package/dist/api/resources/plans/types/RetryCustomPlanBillingResponse.d.ts +6 -0
  159. package/dist/api/resources/plans/types/index.d.ts +4 -0
  160. package/dist/api/resources/webhooks/client/Client.d.ts +2 -0
  161. package/dist/api/resources/webhooks/client/requests/CountWebhookEventsRequest.d.ts +1 -0
  162. package/dist/api/resources/webhooks/client/requests/ListWebhookEventsRequest.d.ts +1 -0
  163. package/dist/api/types/AccountMemberResponseData.d.ts +2 -0
  164. package/dist/api/types/ActivityEntryResponseData.d.ts +8 -0
  165. package/dist/api/types/ActivityResponseResponseData.d.ts +4 -0
  166. package/dist/api/types/ApiKeyCreateResponseData.d.ts +2 -0
  167. package/dist/api/types/ApiKeyIntegrationResponseData.d.ts +6 -0
  168. package/dist/api/types/ApiKeyResponseData.d.ts +2 -0
  169. package/dist/api/types/AuditLogListResponseData.d.ts +2 -0
  170. package/dist/api/types/AuditLogResponseData.d.ts +2 -0
  171. package/dist/api/types/BillingCreditBundleView.d.ts +1 -1
  172. package/dist/api/types/BillingCreditGrantReason.d.ts +1 -0
  173. package/dist/api/types/BillingCreditGrantResponseData.d.ts +4 -0
  174. package/dist/api/types/BillingCreditLedgerAuthority.d.ts +6 -0
  175. package/dist/api/types/BillingCreditView.d.ts +2 -0
  176. package/dist/api/types/BillingPlanCreditGrantResponseData.d.ts +3 -0
  177. package/dist/api/types/BillingPriceResponseData.d.ts +2 -0
  178. package/dist/api/types/BillingPriceView.d.ts +2 -0
  179. package/dist/api/types/BillingProductForSubscriptionResponseData.d.ts +1 -0
  180. package/dist/api/types/BillingProductPlanResponseData.d.ts +1 -0
  181. package/dist/api/types/BillingProductPriceResponseData.d.ts +2 -0
  182. package/dist/api/types/BillingProviderType.d.ts +1 -0
  183. package/dist/api/types/BillingStrategy.d.ts +6 -0
  184. package/dist/api/types/ChangeSubscriptionInternalRequestBody.d.ts +2 -0
  185. package/dist/api/types/ChangeSubscriptionRequestBody.d.ts +2 -0
  186. package/dist/api/types/ChargeType.d.ts +1 -0
  187. package/dist/api/types/CheckFlagResponseData.d.ts +2 -2
  188. package/dist/api/types/CheckoutDataResponseData.d.ts +1 -0
  189. package/dist/api/types/CheckoutFieldInput.d.ts +8 -0
  190. package/dist/api/types/CheckoutFieldResponseData.d.ts +12 -0
  191. package/dist/api/types/CheckoutFieldValue.d.ts +4 -0
  192. package/dist/api/types/CheckoutFieldWithValue.d.ts +9 -0
  193. package/dist/api/types/CheckoutSubscription.d.ts +1 -0
  194. package/dist/api/types/ClerkIntegrationConfig.d.ts +6 -0
  195. package/dist/api/types/CompanyCreditBalanceResponseData.d.ts +9 -0
  196. package/dist/api/types/CompanyEventPeriodMetricsResponseData.d.ts +3 -2
  197. package/dist/api/types/CompanyMatchingCriteria.d.ts +5 -0
  198. package/dist/api/types/CompanyOverrideResponseData.d.ts +2 -2
  199. package/dist/api/types/CompanyPlanCreditGrantView.d.ts +41 -0
  200. package/dist/api/types/CompanyPlanDetailResponseData.d.ts +7 -3
  201. package/dist/api/types/CompanyPlanWithBillingSubView.d.ts +1 -1
  202. package/dist/api/types/CompanySubscriptionResponseData.d.ts +1 -0
  203. package/dist/api/types/{ConditionOperator.d.ts → ComparableOperator.d.ts} +5 -5
  204. package/dist/api/types/ComponentHydrateResponseData.d.ts +1 -0
  205. package/dist/api/types/ComponentPreviewResponseData.d.ts +1 -0
  206. package/dist/api/types/Condition.d.ts +4 -4
  207. package/dist/api/types/ConditionResponseData.d.ts +4 -4
  208. package/dist/api/types/{ConditionConditionType.d.ts → ConditionType.d.ts} +2 -2
  209. package/dist/api/types/ConditionView.d.ts +4 -4
  210. package/dist/api/types/CreateBillingPlanCreditGrantRequestBody.d.ts +3 -0
  211. package/dist/api/types/CreateCustomPlanBundlePlanRequestBody.d.ts +7 -0
  212. package/dist/api/types/CreateEntitlementInBundleRequestBody.d.ts +8 -2
  213. package/dist/api/types/CreateEntitlementReqCommon.d.ts +2 -2
  214. package/dist/api/types/CreateEventRequestBody.d.ts +6 -0
  215. package/dist/api/types/CreateFlagRequestBody.d.ts +1 -1
  216. package/dist/api/types/CreateOrUpdateConditionRequestBody.d.ts +4 -4
  217. package/dist/api/types/CreateOrUpdateFlagRequestBody.d.ts +1 -1
  218. package/dist/api/types/CreateOrUpdateRuleRequestBody.d.ts +1 -1
  219. package/dist/api/types/CreditCompanyGrantView.d.ts +3 -0
  220. package/dist/api/types/CreditCurrencyPrice.d.ts +5 -0
  221. package/dist/api/types/CreditEventLedgerResponseData.d.ts +1 -0
  222. package/dist/api/types/CreditLeaseResponseData.d.ts +10 -0
  223. package/dist/api/types/CreditUsageReason.d.ts +8 -0
  224. package/dist/api/types/CurrencyPriceRequestBody.d.ts +3 -0
  225. package/dist/api/types/CustomPlanBillingResponseData.d.ts +1 -0
  226. package/dist/api/types/CustomPlanBillingStatus.d.ts +1 -0
  227. package/dist/api/types/DataEventPayload.d.ts +3 -0
  228. package/dist/api/types/DuplicatePlanEntitlementsResponseResponseData.d.ts +1 -0
  229. package/dist/api/types/EntitlementCurrencyPricesResponseData.d.ts +1 -0
  230. package/dist/api/types/EnvironmentFeatureUsageTimeSeriesResponseData.d.ts +6 -0
  231. package/dist/api/types/EnvironmentTraitUsageTimeSeriesResponseData.d.ts +6 -0
  232. package/dist/api/types/EnvironmentUsagePointResponseData.d.ts +4 -0
  233. package/dist/api/types/EventBodyTrack.d.ts +2 -0
  234. package/dist/api/types/EventDetailResponseData.d.ts +3 -0
  235. package/dist/api/types/EventResponseData.d.ts +2 -0
  236. package/dist/api/types/FeatureCompanyResponseData.d.ts +4 -3
  237. package/dist/api/types/FeatureCompanyUserResponseData.d.ts +2 -2
  238. package/dist/api/types/FeatureDetailResponseData.d.ts +2 -1
  239. package/dist/api/types/FeatureEntitlement.d.ts +2 -2
  240. package/dist/api/types/FeatureInPlanResponseData.d.ts +21 -0
  241. package/dist/api/types/FeatureResponseData.d.ts +1 -1
  242. package/dist/api/types/FeatureUsageResponseData.d.ts +4 -3
  243. package/dist/api/types/FeatureView.d.ts +1 -1
  244. package/dist/api/types/FlagDetailResponseData.d.ts +2 -1
  245. package/dist/api/types/FlagInPlanResponseData.d.ts +16 -0
  246. package/dist/api/types/FlagResponseData.d.ts +1 -1
  247. package/dist/api/types/FlagView.d.ts +0 -1
  248. package/dist/api/types/InsightsSummaryResponseData.d.ts +9 -0
  249. package/dist/api/types/InstallIntegrationRequestBody.d.ts +9 -0
  250. package/dist/api/types/IntegrationCapabilities.d.ts +5 -0
  251. package/dist/api/types/IntegrationConfig.d.ts +19 -0
  252. package/dist/api/types/IntegrationInstallConfig.d.ts +13 -0
  253. package/dist/api/types/IntegrationInstallResponseData.d.ts +6 -0
  254. package/dist/api/types/IntegrationResponseData.d.ts +8 -0
  255. package/dist/api/types/IntegrationState.d.ts +6 -0
  256. package/dist/api/types/IntegrationType.d.ts +2 -0
  257. package/dist/api/types/IntegrationsDataSetResponseData.d.ts +3 -0
  258. package/dist/api/types/IntegrationsListResponseData.d.ts +10 -0
  259. package/dist/api/types/IntegrationsResponseData.d.ts +8 -0
  260. package/dist/api/types/ManagePlanRequest.d.ts +1 -0
  261. package/dist/api/types/MarkCustomPlanBillingPaidRequestBody.d.ts +1 -0
  262. package/dist/api/types/{ConditionMetricPeriod.d.ts → MetricPeriod.d.ts} +2 -2
  263. package/dist/api/types/MetricPeriodMonthReset.d.ts +5 -0
  264. package/dist/api/types/MetronomeIntegrationConfig.d.ts +1 -0
  265. package/dist/api/types/MigrationErrorCode.d.ts +15 -0
  266. package/dist/api/types/MrrResponseData.d.ts +4 -0
  267. package/dist/api/types/OrbIntegrationConfig.d.ts +4 -0
  268. package/dist/api/types/PlanCreditGrantView.d.ts +2 -0
  269. package/dist/api/types/PlanCurrencyPriceRequestBody.d.ts +1 -0
  270. package/dist/api/types/PlanCurrencyPricesResponseData.d.ts +1 -0
  271. package/dist/api/types/PlanDetailResponseData.d.ts +6 -2
  272. package/dist/api/types/PlanEntitlementResponseData.d.ts +5 -2
  273. package/dist/api/types/PlanGroupDetailResponseData.d.ts +1 -0
  274. package/dist/api/types/PlanGroupPlanDetailResponseData.d.ts +7 -3
  275. package/dist/api/types/PlanGrowthPointResponseData.d.ts +6 -0
  276. package/dist/api/types/PlanGrowthResponseData.d.ts +4 -0
  277. package/dist/api/types/PlanPriceCadence.d.ts +6 -0
  278. package/dist/api/types/PlanVersionCompanyMigrationResponseData.d.ts +1 -0
  279. package/dist/api/types/PlanVersionMigrationResponseData.d.ts +1 -0
  280. package/dist/api/types/PlanViewPublicResponseData.d.ts +7 -3
  281. package/dist/api/types/ReleaseCreditLeaseRequestBody.d.ts +1 -0
  282. package/dist/api/types/Rule.d.ts +1 -1
  283. package/dist/api/types/RuleConditionDetailResponseData.d.ts +4 -4
  284. package/dist/api/types/RuleConditionResponseData.d.ts +4 -4
  285. package/dist/api/types/RuleDetailResponseData.d.ts +1 -1
  286. package/dist/api/types/RuleResponseData.d.ts +2 -1
  287. package/dist/api/types/{RuleRuleType.d.ts → RuleType.d.ts} +4 -4
  288. package/dist/api/types/RuleView.d.ts +1 -1
  289. package/dist/api/types/RulesEngineSchemaVersion.d.ts +1 -1
  290. package/dist/api/types/RulesengineCheckFlagResult.d.ts +2 -2
  291. package/dist/api/types/RulesengineCompanyMetric.d.ts +2 -2
  292. package/dist/api/types/RulesengineCondition.d.ts +4 -4
  293. package/dist/api/types/{RulesengineConditionConditionType.d.ts → RulesengineConditionType.d.ts} +2 -2
  294. package/dist/api/types/RulesengineFeatureEntitlement.d.ts +2 -2
  295. package/dist/api/types/RulesengineMetricPeriod.d.ts +7 -0
  296. package/dist/api/types/RulesengineMetricPeriodMonthReset.d.ts +5 -0
  297. package/dist/api/types/RulesengineRule.d.ts +1 -1
  298. package/dist/api/types/{RulesengineRuleRuleType.d.ts → RulesengineRuleType.d.ts} +4 -4
  299. package/dist/api/types/StripeIntegrationConfig.d.ts +14 -0
  300. package/dist/api/types/TopFeatureByUsageResponseData.d.ts +8 -0
  301. package/dist/api/types/TopFeaturesByUsageResponseData.d.ts +4 -0
  302. package/dist/api/types/UpdateAutoTopupOverrideRequestBody.d.ts +6 -0
  303. package/dist/api/types/UpdateBillingPlanCreditGrantRequestBody.d.ts +3 -0
  304. package/dist/api/types/UpdateEntitlementReqCommon.d.ts +2 -2
  305. package/dist/api/types/UpsertBillingProductRequestBody.d.ts +3 -0
  306. package/dist/api/types/UsageBasedEntitlementRequestBody.d.ts +6 -0
  307. package/dist/api/types/UsageBasedEntitlementResponseData.d.ts +5 -2
  308. package/dist/api/types/WorkOsIntegrationConfig.d.ts +6 -0
  309. package/dist/api/types/index.d.ts +56 -29
  310. package/dist/core/auth/AuthProvider.d.ts +1 -0
  311. package/dist/core/auth/BasicAuth.d.ts +2 -2
  312. package/dist/core/auth/index.d.ts +1 -1
  313. package/dist/core/fetcher/Fetcher.d.ts +8 -0
  314. package/dist/core/schemas/builders/enum/enum.d.ts +1 -0
  315. package/dist/core/schemas/builders/enum/index.d.ts +1 -1
  316. package/dist/core/url/QueryStringBuilder.d.ts +47 -0
  317. package/dist/core/url/index.d.ts +1 -0
  318. package/dist/core/url/qs.d.ts +2 -1
  319. package/dist/datastream/merge.d.ts +13 -10
  320. package/dist/datastream/websocket-client.d.ts +1 -1
  321. package/dist/errors/SchematicError.d.ts +3 -1
  322. package/dist/errors/SchematicTimeoutError.d.ts +4 -1
  323. package/dist/event-capture.d.ts +28 -0
  324. package/dist/events.d.ts +3 -3
  325. package/dist/index.d.ts +2 -1
  326. package/dist/index.js +3 -3
  327. package/dist/logger.d.ts +20 -0
  328. package/dist/rules-engine.d.ts +3 -3
  329. package/dist/serialization/resources/accounts/types/CountAccountMembersParams.d.ts +12 -0
  330. package/dist/serialization/resources/accounts/types/CountAccountMembersResponse.d.ts +12 -0
  331. package/dist/serialization/resources/accounts/types/index.d.ts +2 -0
  332. package/dist/serialization/resources/billing/client/requests/CreateBillingPriceRequestBody.d.ts +2 -0
  333. package/dist/serialization/resources/billing/types/CountBillingProductsParams.d.ts +1 -0
  334. package/dist/serialization/resources/billing/types/DeletePaymentMethodByExternalIdResponse.d.ts +11 -0
  335. package/dist/serialization/resources/billing/types/ListBillingProductsParams.d.ts +1 -0
  336. package/dist/serialization/resources/billing/types/index.d.ts +1 -0
  337. package/dist/serialization/resources/companies/client/requests/index.d.ts +0 -2
  338. package/dist/serialization/resources/companies/types/CountCompaniesParams.d.ts +1 -0
  339. package/dist/serialization/resources/companies/types/ListCompaniesParams.d.ts +1 -0
  340. package/dist/serialization/resources/companies/types/index.d.ts +0 -3
  341. package/dist/serialization/resources/credits/client/requests/AcquireCreditLeaseRequestBody.d.ts +12 -0
  342. package/dist/serialization/resources/credits/client/requests/ExtendCreditLeaseRequestBody.d.ts +10 -0
  343. package/dist/serialization/resources/credits/client/requests/index.d.ts +2 -0
  344. package/dist/serialization/resources/credits/types/AcquireCreditLeaseResponse.d.ts +11 -0
  345. package/dist/serialization/resources/credits/types/CountBillingPlanCreditGrantsParams.d.ts +1 -0
  346. package/dist/serialization/resources/credits/types/ExtendCreditLeaseResponse.d.ts +11 -0
  347. package/dist/serialization/resources/credits/types/ListBillingPlanCreditGrantsParams.d.ts +1 -0
  348. package/dist/serialization/resources/credits/types/ListCompanyCreditBalancesParams.d.ts +9 -0
  349. package/dist/serialization/resources/credits/types/ListCompanyCreditBalancesResponse.d.ts +12 -0
  350. package/dist/serialization/resources/credits/types/ReleaseCreditLeaseResponse.d.ts +11 -0
  351. package/dist/serialization/resources/credits/types/index.d.ts +5 -0
  352. package/dist/serialization/resources/entitlements/client/requests/CreateBillingLinkedPlanEntitlementRequestBody.d.ts +9 -4
  353. package/dist/serialization/resources/entitlements/client/requests/CreateCompanyOverrideRequestBody.d.ts +4 -4
  354. package/dist/serialization/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +9 -4
  355. package/dist/serialization/resources/entitlements/client/requests/UpdateCompanyOverrideRequestBody.d.ts +4 -4
  356. package/dist/serialization/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts +9 -4
  357. package/dist/serialization/resources/entitlements/types/CountFeatureUsageParams.d.ts +2 -0
  358. package/dist/serialization/resources/entitlements/types/ListFeatureUsageParams.d.ts +2 -0
  359. package/dist/serialization/resources/entitlements/types/index.d.ts +0 -10
  360. package/dist/serialization/resources/events/types/ListEventsParams.d.ts +1 -0
  361. package/dist/serialization/resources/features/client/requests/CreateBillingLinkedFeatureRequestBody.d.ts +1 -1
  362. package/dist/serialization/resources/features/client/requests/CreateFeatureRequestBody.d.ts +1 -1
  363. package/dist/serialization/resources/features/client/requests/UpdateFeatureRequestBody.d.ts +1 -1
  364. package/dist/serialization/resources/features/types/CountFeaturesParams.d.ts +2 -0
  365. package/dist/serialization/resources/features/types/ListFeaturesParams.d.ts +2 -0
  366. package/dist/serialization/resources/index.d.ts +4 -0
  367. package/dist/serialization/resources/insights/index.d.ts +1 -0
  368. package/dist/serialization/resources/insights/types/GetActivityParams.d.ts +9 -0
  369. package/dist/serialization/resources/insights/types/GetActivityResponse.d.ts +12 -0
  370. package/dist/serialization/resources/insights/types/GetEnvironmentFeatureUsageTimeSeriesParams.d.ts +13 -0
  371. package/dist/serialization/resources/insights/types/GetEnvironmentFeatureUsageTimeSeriesResponse.d.ts +12 -0
  372. package/dist/serialization/resources/insights/types/GetEnvironmentTraitUsageTimeSeriesParams.d.ts +13 -0
  373. package/dist/serialization/resources/insights/types/GetEnvironmentTraitUsageTimeSeriesResponse.d.ts +12 -0
  374. package/dist/serialization/resources/insights/types/GetPlanGrowthParams.d.ts +9 -0
  375. package/dist/serialization/resources/insights/types/GetPlanGrowthResponse.d.ts +12 -0
  376. package/dist/serialization/resources/insights/types/GetSummaryResponse.d.ts +11 -0
  377. package/dist/serialization/resources/insights/types/GetTopFeaturesByUsageParams.d.ts +11 -0
  378. package/dist/serialization/resources/insights/types/GetTopFeaturesByUsageResponse.d.ts +12 -0
  379. package/dist/serialization/resources/insights/types/index.d.ts +11 -0
  380. package/dist/serialization/resources/integrationsapi/client/index.d.ts +1 -0
  381. package/dist/serialization/resources/integrationsapi/client/requests/StartDataImportRequestBody.d.ts +12 -0
  382. package/dist/serialization/resources/integrationsapi/client/requests/index.d.ts +1 -0
  383. package/dist/serialization/resources/integrationsapi/index.d.ts +1 -0
  384. package/dist/serialization/resources/integrationsapi/types/AssumeStripeInstalledResponse.d.ts +11 -0
  385. package/dist/serialization/resources/integrationsapi/types/InstallIntegrationResponse.d.ts +11 -0
  386. package/dist/serialization/resources/integrationsapi/types/InstallStripeResponse.d.ts +11 -0
  387. package/dist/serialization/resources/integrationsapi/types/ListIntegrationsParams.d.ts +17 -0
  388. package/dist/serialization/resources/integrationsapi/types/ListIntegrationsResponse.d.ts +12 -0
  389. package/dist/serialization/resources/integrationsapi/types/LoadSampleDataSetResponse.d.ts +11 -0
  390. package/dist/serialization/resources/integrationsapi/types/RunIntegrationResponse.d.ts +11 -0
  391. package/dist/serialization/resources/integrationsapi/types/StartDataImportResponse.d.ts +11 -0
  392. package/dist/serialization/resources/{companies/types/DeletePlanTraitResponse.d.ts → integrationsapi/types/UninstallIntegrationResponse.d.ts} +2 -2
  393. package/dist/serialization/resources/integrationsapi/types/index.d.ts +9 -0
  394. package/dist/serialization/resources/planbundle/client/requests/CreateCustomPlanBundleRequestBody.d.ts +14 -0
  395. package/dist/serialization/resources/planbundle/client/requests/index.d.ts +1 -0
  396. package/dist/serialization/resources/planbundle/types/CreateCustomPlanBundleResponse.d.ts +11 -0
  397. package/dist/serialization/resources/planbundle/types/index.d.ts +1 -0
  398. package/dist/serialization/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +2 -0
  399. package/dist/serialization/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +2 -0
  400. package/dist/serialization/resources/planmigrations/client/index.d.ts +1 -0
  401. package/dist/serialization/resources/planmigrations/client/requests/CreateMigrationInput.d.ts +17 -0
  402. package/dist/serialization/resources/planmigrations/client/requests/RetryMigrationRequestBody.d.ts +10 -0
  403. package/dist/serialization/resources/planmigrations/client/requests/index.d.ts +2 -0
  404. package/dist/serialization/resources/planmigrations/index.d.ts +1 -0
  405. package/dist/serialization/resources/planmigrations/types/CreateMigrationResponse.d.ts +11 -0
  406. package/dist/serialization/resources/planmigrations/types/RetryCompanyMigrationResponse.d.ts +11 -0
  407. package/dist/serialization/resources/planmigrations/types/RetryMigrationResponse.d.ts +11 -0
  408. package/dist/serialization/resources/planmigrations/types/index.d.ts +3 -0
  409. package/dist/serialization/resources/plans/client/requests/CreateBillingLinkedPlanRequestBody.d.ts +1 -0
  410. package/dist/serialization/resources/plans/client/requests/RetryCustomPlanBillingRequestBody.d.ts +14 -0
  411. package/dist/serialization/resources/plans/client/requests/index.d.ts +1 -0
  412. package/dist/serialization/resources/plans/types/CountPlansParams.d.ts +3 -0
  413. package/dist/serialization/resources/plans/types/ListCustomPlanBillingsParams.d.ts +15 -0
  414. package/dist/serialization/resources/plans/types/ListCustomPlanBillingsResponse.d.ts +12 -0
  415. package/dist/serialization/resources/plans/types/ListPlansParams.d.ts +3 -0
  416. package/dist/serialization/resources/plans/types/MarkCustomPlanBillingPaidResponse.d.ts +11 -0
  417. package/dist/serialization/resources/plans/types/RetryCustomPlanBillingResponse.d.ts +11 -0
  418. package/dist/serialization/resources/plans/types/index.d.ts +4 -0
  419. package/dist/serialization/types/AccountMemberResponseData.d.ts +2 -0
  420. package/dist/serialization/types/ActivityEntryResponseData.d.ts +14 -0
  421. package/dist/serialization/types/ActivityResponseResponseData.d.ts +10 -0
  422. package/dist/serialization/types/ApiKeyCreateResponseData.d.ts +4 -0
  423. package/dist/serialization/types/ApiKeyIntegrationResponseData.d.ts +13 -0
  424. package/dist/serialization/types/ApiKeyResponseData.d.ts +4 -0
  425. package/dist/serialization/types/AuditLogListResponseData.d.ts +4 -0
  426. package/dist/serialization/types/AuditLogResponseData.d.ts +4 -0
  427. package/dist/serialization/types/BillingCreditBundleView.d.ts +1 -1
  428. package/dist/serialization/types/BillingCreditGrantReason.d.ts +1 -1
  429. package/dist/serialization/types/BillingCreditGrantResponseData.d.ts +3 -0
  430. package/dist/serialization/types/BillingCreditLedgerAuthority.d.ts +7 -0
  431. package/dist/serialization/types/BillingCreditView.d.ts +4 -0
  432. package/dist/serialization/types/BillingPlanCreditGrantResponseData.d.ts +2 -0
  433. package/dist/serialization/types/BillingPriceResponseData.d.ts +2 -0
  434. package/dist/serialization/types/BillingPriceView.d.ts +2 -0
  435. package/dist/serialization/types/BillingProductForSubscriptionResponseData.d.ts +1 -0
  436. package/dist/serialization/types/BillingProductPlanResponseData.d.ts +2 -0
  437. package/dist/serialization/types/BillingProductPriceResponseData.d.ts +2 -0
  438. package/dist/serialization/types/BillingProviderType.d.ts +1 -1
  439. package/dist/serialization/types/BillingStrategy.d.ts +7 -0
  440. package/dist/serialization/types/ChangeSubscriptionInternalRequestBody.d.ts +4 -0
  441. package/dist/serialization/types/ChangeSubscriptionRequestBody.d.ts +4 -0
  442. package/dist/serialization/types/ChargeType.d.ts +1 -1
  443. package/dist/serialization/types/CheckFlagResponseData.d.ts +4 -2
  444. package/dist/serialization/types/CheckoutDataResponseData.d.ts +2 -0
  445. package/dist/serialization/types/CheckoutFieldInput.d.ts +14 -0
  446. package/dist/serialization/types/CheckoutFieldResponseData.d.ts +18 -0
  447. package/dist/serialization/types/CheckoutFieldValue.d.ts +10 -0
  448. package/dist/serialization/types/CheckoutFieldWithValue.d.ts +15 -0
  449. package/dist/serialization/types/CheckoutSubscription.d.ts +1 -0
  450. package/dist/serialization/types/ClerkIntegrationConfig.d.ts +10 -0
  451. package/dist/serialization/types/CompanyCreditBalanceResponseData.d.ts +15 -0
  452. package/dist/serialization/types/CompanyEventPeriodMetricsResponseData.d.ts +4 -2
  453. package/dist/serialization/types/CompanyMatchingCriteria.d.ts +7 -0
  454. package/dist/serialization/types/CompanyOverrideResponseData.d.ts +4 -2
  455. package/dist/serialization/types/CompanyPlanCreditGrantView.d.ts +48 -0
  456. package/dist/serialization/types/CompanyPlanDetailResponseData.d.ts +10 -4
  457. package/dist/serialization/types/CompanyPlanWithBillingSubView.d.ts +2 -2
  458. package/dist/serialization/types/CompanySubscriptionResponseData.d.ts +2 -0
  459. package/dist/serialization/types/ComparableOperator.d.ts +7 -0
  460. package/dist/serialization/types/ComponentHydrateResponseData.d.ts +2 -0
  461. package/dist/serialization/types/ComponentPreviewResponseData.d.ts +2 -0
  462. package/dist/serialization/types/Condition.d.ts +8 -8
  463. package/dist/serialization/types/ConditionResponseData.d.ts +8 -4
  464. package/dist/serialization/types/{ConditionConditionType.d.ts → ConditionType.d.ts} +2 -2
  465. package/dist/serialization/types/ConditionView.d.ts +8 -4
  466. package/dist/serialization/types/CreateBillingPlanCreditGrantRequestBody.d.ts +2 -0
  467. package/dist/serialization/types/CreateCustomPlanBundlePlanRequestBody.d.ts +13 -0
  468. package/dist/serialization/types/CreateEntitlementInBundleRequestBody.d.ts +9 -4
  469. package/dist/serialization/types/CreateEntitlementReqCommon.d.ts +4 -4
  470. package/dist/serialization/types/CreateEventRequestBody.d.ts +3 -0
  471. package/dist/serialization/types/CreateFlagRequestBody.d.ts +1 -1
  472. package/dist/serialization/types/CreateOrUpdateConditionRequestBody.d.ts +8 -8
  473. package/dist/serialization/types/CreateOrUpdateFlagRequestBody.d.ts +1 -1
  474. package/dist/serialization/types/CreateOrUpdateRuleRequestBody.d.ts +2 -2
  475. package/dist/serialization/types/CreditCompanyGrantView.d.ts +3 -0
  476. package/dist/serialization/types/CreditCurrencyPrice.d.ts +11 -0
  477. package/dist/serialization/types/CreditEventLedgerResponseData.d.ts +2 -0
  478. package/dist/serialization/types/CreditLeaseResponseData.d.ts +16 -0
  479. package/dist/serialization/types/CreditUsageReason.d.ts +7 -0
  480. package/dist/serialization/types/CurrencyPriceRequestBody.d.ts +3 -0
  481. package/dist/serialization/types/CustomPlanBillingResponseData.d.ts +1 -0
  482. package/dist/serialization/types/CustomPlanBillingStatus.d.ts +1 -1
  483. package/dist/serialization/types/DataEventPayload.d.ts +3 -0
  484. package/dist/serialization/types/DuplicatePlanEntitlementsResponseResponseData.d.ts +2 -0
  485. package/dist/serialization/types/EntitlementCurrencyPricesResponseData.d.ts +1 -0
  486. package/dist/serialization/types/EnvironmentFeatureUsageTimeSeriesResponseData.d.ts +12 -0
  487. package/dist/serialization/types/EnvironmentTraitUsageTimeSeriesResponseData.d.ts +12 -0
  488. package/dist/serialization/types/EnvironmentUsagePointResponseData.d.ts +10 -0
  489. package/dist/serialization/types/EventBodyTrack.d.ts +1 -0
  490. package/dist/serialization/types/EventDetailResponseData.d.ts +4 -0
  491. package/dist/serialization/types/EventResponseData.d.ts +2 -0
  492. package/dist/serialization/types/FeatureCompanyResponseData.d.ts +7 -4
  493. package/dist/serialization/types/FeatureCompanyUserResponseData.d.ts +4 -2
  494. package/dist/serialization/types/FeatureDetailResponseData.d.ts +3 -1
  495. package/dist/serialization/types/FeatureEntitlement.d.ts +4 -4
  496. package/dist/serialization/types/FeatureInPlanResponseData.d.ts +33 -0
  497. package/dist/serialization/types/FeatureResponseData.d.ts +1 -1
  498. package/dist/serialization/types/FeatureUsageResponseData.d.ts +7 -4
  499. package/dist/serialization/types/FeatureView.d.ts +1 -1
  500. package/dist/serialization/types/FlagDetailResponseData.d.ts +3 -1
  501. package/dist/serialization/types/FlagInPlanResponseData.d.ts +24 -0
  502. package/dist/serialization/types/FlagResponseData.d.ts +1 -1
  503. package/dist/serialization/types/FlagView.d.ts +0 -1
  504. package/dist/serialization/types/InsightsSummaryResponseData.d.ts +15 -0
  505. package/dist/serialization/types/InstallIntegrationRequestBody.d.ts +16 -0
  506. package/dist/serialization/types/IntegrationCapabilities.d.ts +11 -0
  507. package/dist/serialization/types/IntegrationConfig.d.ts +27 -0
  508. package/dist/serialization/types/IntegrationInstallConfig.d.ts +20 -0
  509. package/dist/serialization/types/IntegrationInstallResponseData.d.ts +14 -0
  510. package/dist/serialization/types/IntegrationResponseData.d.ts +15 -0
  511. package/dist/serialization/types/IntegrationState.d.ts +7 -0
  512. package/dist/serialization/types/IntegrationType.d.ts +1 -1
  513. package/dist/serialization/types/IntegrationsDataSetResponseData.d.ts +9 -0
  514. package/dist/serialization/types/IntegrationsListResponseData.d.ts +19 -0
  515. package/dist/serialization/types/IntegrationsResponseData.d.ts +15 -0
  516. package/dist/serialization/types/ManagePlanRequest.d.ts +2 -0
  517. package/dist/serialization/types/MarkCustomPlanBillingPaidRequestBody.d.ts +7 -0
  518. package/dist/serialization/types/{ConditionMetricPeriod.d.ts → MetricPeriod.d.ts} +2 -2
  519. package/dist/serialization/types/MetricPeriodMonthReset.d.ts +7 -0
  520. package/dist/serialization/types/MetronomeIntegrationConfig.d.ts +7 -0
  521. package/dist/serialization/types/MigrationErrorCode.d.ts +7 -0
  522. package/dist/serialization/types/MrrResponseData.d.ts +10 -0
  523. package/dist/serialization/types/OrbIntegrationConfig.d.ts +9 -0
  524. package/dist/serialization/types/PlanCreditGrantView.d.ts +2 -0
  525. package/dist/serialization/types/PlanCurrencyPriceRequestBody.d.ts +1 -0
  526. package/dist/serialization/types/PlanCurrencyPricesResponseData.d.ts +1 -0
  527. package/dist/serialization/types/PlanDetailResponseData.d.ts +9 -3
  528. package/dist/serialization/types/PlanEntitlementResponseData.d.ts +6 -2
  529. package/dist/serialization/types/PlanGroupDetailResponseData.d.ts +2 -0
  530. package/dist/serialization/types/PlanGroupPlanDetailResponseData.d.ts +10 -4
  531. package/dist/serialization/types/PlanGrowthPointResponseData.d.ts +12 -0
  532. package/dist/serialization/types/PlanGrowthResponseData.d.ts +10 -0
  533. package/dist/serialization/types/PlanPriceCadence.d.ts +7 -0
  534. package/dist/serialization/types/PlanVersionCompanyMigrationResponseData.d.ts +2 -0
  535. package/dist/serialization/types/PlanVersionMigrationResponseData.d.ts +1 -0
  536. package/dist/serialization/types/PlanViewPublicResponseData.d.ts +10 -4
  537. package/dist/serialization/types/ReleaseCreditLeaseRequestBody.d.ts +7 -0
  538. package/dist/serialization/types/Rule.d.ts +2 -2
  539. package/dist/serialization/types/RuleConditionDetailResponseData.d.ts +8 -4
  540. package/dist/serialization/types/RuleConditionResponseData.d.ts +8 -4
  541. package/dist/serialization/types/RuleDetailResponseData.d.ts +2 -1
  542. package/dist/serialization/types/RuleResponseData.d.ts +2 -1
  543. package/dist/serialization/types/RuleType.d.ts +7 -0
  544. package/dist/serialization/types/RuleView.d.ts +2 -1
  545. package/dist/serialization/types/RulesEngineSchemaVersion.d.ts +1 -1
  546. package/dist/serialization/types/RulesengineCheckFlagResult.d.ts +4 -4
  547. package/dist/serialization/types/RulesengineCompanyMetric.d.ts +4 -4
  548. package/dist/serialization/types/RulesengineCondition.d.ts +8 -8
  549. package/dist/serialization/types/{RulesengineConditionConditionType.d.ts → RulesengineConditionType.d.ts} +2 -2
  550. package/dist/serialization/types/RulesengineFeatureEntitlement.d.ts +4 -4
  551. package/dist/serialization/types/RulesengineMetricPeriod.d.ts +7 -0
  552. package/dist/serialization/types/RulesengineMetricPeriodMonthReset.d.ts +7 -0
  553. package/dist/serialization/types/RulesengineRule.d.ts +2 -2
  554. package/dist/serialization/types/RulesengineRuleType.d.ts +7 -0
  555. package/dist/serialization/types/StripeIntegrationConfig.d.ts +14 -0
  556. package/dist/serialization/types/TopFeatureByUsageResponseData.d.ts +14 -0
  557. package/dist/serialization/types/TopFeaturesByUsageResponseData.d.ts +10 -0
  558. package/dist/serialization/types/UpdateAutoTopupOverrideRequestBody.d.ts +12 -0
  559. package/dist/serialization/types/UpdateBillingPlanCreditGrantRequestBody.d.ts +2 -0
  560. package/dist/serialization/types/UpdateEntitlementReqCommon.d.ts +4 -4
  561. package/dist/serialization/types/UpsertBillingProductRequestBody.d.ts +4 -0
  562. package/dist/serialization/types/UsageBasedEntitlementRequestBody.d.ts +5 -0
  563. package/dist/serialization/types/UsageBasedEntitlementResponseData.d.ts +6 -2
  564. package/dist/serialization/types/WorkOsIntegrationConfig.d.ts +10 -0
  565. package/dist/serialization/types/index.d.ts +56 -29
  566. package/dist/version.d.ts +2 -0
  567. package/dist/wasm/rulesengine.d.ts +1 -0
  568. package/dist/wasm/rulesengine.js +43 -11
  569. package/dist/wasm/rulesengine_bg.wasm.d.ts +1 -0
  570. package/dist/wrapper.d.ts +40 -5
  571. package/package.json +3 -3
  572. package/dist/api/resources/companies/client/requests/CreatePlanTraitRequestBody.d.ts +0 -13
  573. package/dist/api/resources/companies/client/requests/UpdatePlanTraitRequestBody.d.ts +0 -11
  574. package/dist/api/resources/entitlements/types/CreateBillingLinkedPlanEntitlementRequestBodyMetricPeriod.d.ts +0 -7
  575. package/dist/api/resources/entitlements/types/CreateBillingLinkedPlanEntitlementRequestBodyMetricPeriodMonthReset.d.ts +0 -5
  576. package/dist/api/resources/entitlements/types/CreateCompanyOverrideRequestBodyMetricPeriod.d.ts +0 -7
  577. package/dist/api/resources/entitlements/types/CreateCompanyOverrideRequestBodyMetricPeriodMonthReset.d.ts +0 -5
  578. package/dist/api/resources/entitlements/types/CreatePlanEntitlementRequestBodyMetricPeriod.d.ts +0 -7
  579. package/dist/api/resources/entitlements/types/CreatePlanEntitlementRequestBodyMetricPeriodMonthReset.d.ts +0 -5
  580. package/dist/api/resources/entitlements/types/UpdateCompanyOverrideRequestBodyMetricPeriod.d.ts +0 -7
  581. package/dist/api/resources/entitlements/types/UpdateCompanyOverrideRequestBodyMetricPeriodMonthReset.d.ts +0 -5
  582. package/dist/api/resources/entitlements/types/UpdatePlanEntitlementRequestBodyMetricPeriod.d.ts +0 -7
  583. package/dist/api/resources/entitlements/types/UpdatePlanEntitlementRequestBodyMetricPeriodMonthReset.d.ts +0 -5
  584. package/dist/api/types/ConditionMetricPeriodMonthReset.d.ts +0 -5
  585. package/dist/api/types/CreateEntitlementInBundleRequestBodyMetricPeriod.d.ts +0 -7
  586. package/dist/api/types/CreateEntitlementInBundleRequestBodyMetricPeriodMonthReset.d.ts +0 -5
  587. package/dist/api/types/CreateEntitlementReqCommonMetricPeriod.d.ts +0 -7
  588. package/dist/api/types/CreateEntitlementReqCommonMetricPeriodMonthReset.d.ts +0 -5
  589. package/dist/api/types/CreateOrUpdateConditionRequestBodyConditionType.d.ts +0 -10
  590. package/dist/api/types/CreateOrUpdateConditionRequestBodyMetricPeriod.d.ts +0 -8
  591. package/dist/api/types/CreateOrUpdateConditionRequestBodyMetricPeriodMonthReset.d.ts +0 -6
  592. package/dist/api/types/CreateOrUpdateConditionRequestBodyOperator.d.ts +0 -11
  593. package/dist/api/types/CreateOrUpdateRuleRequestBodyRuleType.d.ts +0 -8
  594. package/dist/api/types/FeatureEntitlementMetricPeriod.d.ts +0 -8
  595. package/dist/api/types/FeatureEntitlementMonthReset.d.ts +0 -6
  596. package/dist/api/types/RulesengineCheckFlagResultFeatureUsagePeriod.d.ts +0 -7
  597. package/dist/api/types/RulesengineCheckFlagResultRuleType.d.ts +0 -10
  598. package/dist/api/types/RulesengineCompanyMetricMonthReset.d.ts +0 -5
  599. package/dist/api/types/RulesengineCompanyMetricPeriod.d.ts +0 -7
  600. package/dist/api/types/RulesengineConditionMetricPeriod.d.ts +0 -7
  601. package/dist/api/types/RulesengineConditionMetricPeriodMonthReset.d.ts +0 -5
  602. package/dist/api/types/RulesengineConditionOperator.d.ts +0 -11
  603. package/dist/api/types/RulesengineFeatureEntitlementMetricPeriod.d.ts +0 -8
  604. package/dist/api/types/RulesengineFeatureEntitlementMonthReset.d.ts +0 -6
  605. package/dist/api/types/UpdateEntitlementReqCommonMetricPeriod.d.ts +0 -7
  606. package/dist/api/types/UpdateEntitlementReqCommonMetricPeriodMonthReset.d.ts +0 -5
  607. package/dist/serialization/resources/companies/client/requests/CreatePlanTraitRequestBody.d.ts +0 -11
  608. package/dist/serialization/resources/companies/client/requests/UpdatePlanTraitRequestBody.d.ts +0 -10
  609. package/dist/serialization/resources/companies/types/CreatePlanTraitResponse.d.ts +0 -11
  610. package/dist/serialization/resources/companies/types/UpdatePlanTraitResponse.d.ts +0 -11
  611. package/dist/serialization/resources/entitlements/types/CreateBillingLinkedPlanEntitlementRequestBodyMetricPeriod.d.ts +0 -7
  612. package/dist/serialization/resources/entitlements/types/CreateBillingLinkedPlanEntitlementRequestBodyMetricPeriodMonthReset.d.ts +0 -7
  613. package/dist/serialization/resources/entitlements/types/CreateCompanyOverrideRequestBodyMetricPeriod.d.ts +0 -7
  614. package/dist/serialization/resources/entitlements/types/CreateCompanyOverrideRequestBodyMetricPeriodMonthReset.d.ts +0 -7
  615. package/dist/serialization/resources/entitlements/types/CreatePlanEntitlementRequestBodyMetricPeriod.d.ts +0 -7
  616. package/dist/serialization/resources/entitlements/types/CreatePlanEntitlementRequestBodyMetricPeriodMonthReset.d.ts +0 -7
  617. package/dist/serialization/resources/entitlements/types/UpdateCompanyOverrideRequestBodyMetricPeriod.d.ts +0 -7
  618. package/dist/serialization/resources/entitlements/types/UpdateCompanyOverrideRequestBodyMetricPeriodMonthReset.d.ts +0 -7
  619. package/dist/serialization/resources/entitlements/types/UpdatePlanEntitlementRequestBodyMetricPeriod.d.ts +0 -7
  620. package/dist/serialization/resources/entitlements/types/UpdatePlanEntitlementRequestBodyMetricPeriodMonthReset.d.ts +0 -7
  621. package/dist/serialization/types/ConditionMetricPeriodMonthReset.d.ts +0 -7
  622. package/dist/serialization/types/ConditionOperator.d.ts +0 -7
  623. package/dist/serialization/types/CreateEntitlementInBundleRequestBodyMetricPeriod.d.ts +0 -7
  624. package/dist/serialization/types/CreateEntitlementInBundleRequestBodyMetricPeriodMonthReset.d.ts +0 -7
  625. package/dist/serialization/types/CreateEntitlementReqCommonMetricPeriod.d.ts +0 -7
  626. package/dist/serialization/types/CreateEntitlementReqCommonMetricPeriodMonthReset.d.ts +0 -7
  627. package/dist/serialization/types/CreateOrUpdateConditionRequestBodyConditionType.d.ts +0 -7
  628. package/dist/serialization/types/CreateOrUpdateConditionRequestBodyMetricPeriod.d.ts +0 -7
  629. package/dist/serialization/types/CreateOrUpdateConditionRequestBodyMetricPeriodMonthReset.d.ts +0 -7
  630. package/dist/serialization/types/CreateOrUpdateConditionRequestBodyOperator.d.ts +0 -7
  631. package/dist/serialization/types/CreateOrUpdateRuleRequestBodyRuleType.d.ts +0 -7
  632. package/dist/serialization/types/FeatureEntitlementMetricPeriod.d.ts +0 -7
  633. package/dist/serialization/types/FeatureEntitlementMonthReset.d.ts +0 -7
  634. package/dist/serialization/types/RuleRuleType.d.ts +0 -7
  635. package/dist/serialization/types/RulesengineCheckFlagResultFeatureUsagePeriod.d.ts +0 -7
  636. package/dist/serialization/types/RulesengineCheckFlagResultRuleType.d.ts +0 -7
  637. package/dist/serialization/types/RulesengineCompanyMetricMonthReset.d.ts +0 -7
  638. package/dist/serialization/types/RulesengineCompanyMetricPeriod.d.ts +0 -7
  639. package/dist/serialization/types/RulesengineConditionMetricPeriod.d.ts +0 -7
  640. package/dist/serialization/types/RulesengineConditionMetricPeriodMonthReset.d.ts +0 -7
  641. package/dist/serialization/types/RulesengineConditionOperator.d.ts +0 -7
  642. package/dist/serialization/types/RulesengineFeatureEntitlementMetricPeriod.d.ts +0 -7
  643. package/dist/serialization/types/RulesengineFeatureEntitlementMonthReset.d.ts +0 -7
  644. package/dist/serialization/types/RulesengineRuleRuleType.d.ts +0 -7
  645. package/dist/serialization/types/UpdateEntitlementReqCommonMetricPeriod.d.ts +0 -7
  646. package/dist/serialization/types/UpdateEntitlementReqCommonMetricPeriodMonthReset.d.ts +0 -7
  647. package/dist/wasm/rulesengine_bg.wasm +0 -0
@@ -3,7 +3,7 @@ export interface ConditionResponseData {
3
3
  accountId: string;
4
4
  comparisonTraitId?: string;
5
5
  conditionGroupId?: string;
6
- conditionType: string;
6
+ conditionType: Schematic.ConditionType;
7
7
  consumptionRate?: number;
8
8
  createdAt: Date;
9
9
  creditId?: string;
@@ -11,10 +11,10 @@ export interface ConditionResponseData {
11
11
  eventSubtype?: string;
12
12
  flagId?: string;
13
13
  id: string;
14
- metricPeriod?: string;
15
- metricPeriodMonthReset?: string;
14
+ metricPeriod?: Schematic.MetricPeriod;
15
+ metricPeriodMonthReset?: Schematic.MetricPeriodMonthReset;
16
16
  metricValue?: number;
17
- operator: string;
17
+ operator: Schematic.ComparableOperator;
18
18
  resourceUnspecifiedIds: string[];
19
19
  ruleId: string;
20
20
  traitEntityType?: Schematic.EntityType;
@@ -1,4 +1,4 @@
1
- export declare const ConditionConditionType: {
1
+ export declare const ConditionType: {
2
2
  readonly BasePlan: "base_plan";
3
3
  readonly BillingProduct: "billing_product";
4
4
  readonly Company: "company";
@@ -9,4 +9,4 @@ export declare const ConditionConditionType: {
9
9
  readonly Trait: "trait";
10
10
  readonly User: "user";
11
11
  };
12
- export type ConditionConditionType = (typeof ConditionConditionType)[keyof typeof ConditionConditionType];
12
+ export type ConditionType = (typeof ConditionType)[keyof typeof ConditionType];
@@ -6,7 +6,7 @@ export interface ConditionView {
6
6
  comparisonTrait?: Schematic.EntityTraitDefinitionResponseData;
7
7
  comparisonTraitId?: string;
8
8
  conditionGroupId?: string;
9
- conditionType: string;
9
+ conditionType: Schematic.ConditionType;
10
10
  consumptionRate?: number;
11
11
  createdAt: Date;
12
12
  creditId?: string;
@@ -14,10 +14,10 @@ export interface ConditionView {
14
14
  eventSubtype?: string;
15
15
  flagId?: string;
16
16
  id: string;
17
- metricPeriod?: string;
18
- metricPeriodMonthReset?: string;
17
+ metricPeriod?: Schematic.MetricPeriod;
18
+ metricPeriodMonthReset?: Schematic.MetricPeriodMonthReset;
19
19
  metricValue?: number;
20
- operator: string;
20
+ operator: Schematic.ComparableOperator;
21
21
  planVersions: Schematic.GenericPreviewObject[];
22
22
  plans: Schematic.GenericPreviewObject[];
23
23
  resourceUnspecifiedIds: string[];
@@ -7,6 +7,7 @@ export interface CreateBillingPlanCreditGrantRequestBody {
7
7
  autoTopupExpiryType?: Schematic.BillingCreditExpiryType;
8
8
  autoTopupExpiryUnit?: Schematic.BillingCreditExpiryUnit;
9
9
  autoTopupExpiryUnitCount?: number;
10
+ autoTopupSelfService?: boolean;
10
11
  autoTopupThresholdCredits?: number;
11
12
  autoTopupThresholdPercent?: number;
12
13
  creditAmount: number;
@@ -19,4 +20,6 @@ export interface CreateBillingPlanCreditGrantRequestBody {
19
20
  resetCadence: Schematic.BillingPlanCreditGrantResetCadence;
20
21
  resetStart: Schematic.BillingPlanCreditGrantResetStart;
21
22
  resetType?: Schematic.BillingPlanCreditGrantResetType;
23
+ /** Percentage of unused credits that carry over when this grant resets. Only applies when reset_type is plan_period. Rolled-over credits expire at the next reset and are not rolled again. Defaults to 0. */
24
+ rolloverPercentage?: number;
22
25
  }
@@ -0,0 +1,7 @@
1
+ import type * as Schematic from "../index";
2
+ export interface CreateCustomPlanBundlePlanRequestBody {
3
+ companyId: string;
4
+ description: string;
5
+ icon?: Schematic.PlanIcon;
6
+ name: string;
7
+ }
@@ -6,8 +6,8 @@ export interface CreateEntitlementInBundleRequestBody {
6
6
  currency?: string;
7
7
  currencyPrices?: Schematic.CurrencyPriceRequestBody[];
8
8
  featureId: string;
9
- metricPeriod?: Schematic.CreateEntitlementInBundleRequestBodyMetricPeriod;
10
- metricPeriodMonthReset?: Schematic.CreateEntitlementInBundleRequestBodyMetricPeriodMonthReset;
9
+ metricPeriod?: Schematic.MetricPeriod;
10
+ metricPeriodMonthReset?: Schematic.MetricPeriodMonthReset;
11
11
  monthlyMeteredPriceId?: string;
12
12
  monthlyPriceTiers?: Schematic.CreatePriceTierRequestBody[];
13
13
  monthlyUnitPrice?: number;
@@ -18,8 +18,14 @@ export interface CreateEntitlementInBundleRequestBody {
18
18
  priceBehavior?: Schematic.EntitlementPriceBehavior;
19
19
  /** Use MonthlyPriceTiers or YearlyPriceTiers instead */
20
20
  priceTiers?: Schematic.CreatePriceTierRequestBody[];
21
+ quarterlyMeteredPriceId?: string;
22
+ quarterlyPriceTiers?: Schematic.CreatePriceTierRequestBody[];
23
+ quarterlyUnitPrice?: number;
24
+ quarterlyUnitPriceDecimal?: string;
21
25
  softLimit?: number;
22
26
  tierMode?: Schematic.BillingTiersMode;
27
+ /** The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use. */
28
+ usageQuantity?: number;
23
29
  valueBool?: boolean;
24
30
  valueCreditId?: string;
25
31
  valueNumeric?: number;
@@ -2,8 +2,8 @@ import type * as Schematic from "../index";
2
2
  export interface CreateEntitlementReqCommon {
3
3
  creditConsumptionRate?: number;
4
4
  featureId: string;
5
- metricPeriod?: Schematic.CreateEntitlementReqCommonMetricPeriod;
6
- metricPeriodMonthReset?: Schematic.CreateEntitlementReqCommonMetricPeriodMonthReset;
5
+ metricPeriod?: Schematic.MetricPeriod;
6
+ metricPeriodMonthReset?: Schematic.MetricPeriodMonthReset;
7
7
  valueBool?: boolean;
8
8
  valueCreditId?: string;
9
9
  valueNumeric?: number;
@@ -1,8 +1,14 @@
1
1
  import type * as Schematic from "../index";
2
2
  export interface CreateEventRequestBody {
3
+ /** Requires a secret API key, and trusted_client_clock. Import historical data without affecting billing. */
4
+ backfill?: boolean;
3
5
  body?: Schematic.EventBody;
4
6
  /** Either 'identify' or 'track' */
5
7
  eventType: Schematic.EventType;
8
+ /** Optional client-supplied key. Duplicate events with the same key (scoped to the environment) are dropped for 24h. */
9
+ idempotencyKey?: string;
6
10
  /** Optionally provide a timestamp at which the event was sent to Schematic */
7
11
  sentAt?: Date;
12
+ /** Requires a secret API key and sent_at. Use sent_at as the effective timestamp. */
13
+ trustedClientClock?: boolean;
8
14
  }
@@ -5,6 +5,6 @@ export interface CreateFlagRequestBody {
5
5
  featureId?: string;
6
6
  flagType: Schematic.FlagType;
7
7
  key: string;
8
- maintainerId?: string;
8
+ maintainerAccountMemberId?: string;
9
9
  name: string;
10
10
  }
@@ -2,7 +2,7 @@ import type * as Schematic from "../index";
2
2
  export interface CreateOrUpdateConditionRequestBody {
3
3
  /** Optionally provide a trait ID to compare a metric or trait value against instead of a value */
4
4
  comparisonTraitId?: string;
5
- conditionType: Schematic.CreateOrUpdateConditionRequestBodyConditionType;
5
+ conditionType: Schematic.ConditionType;
6
6
  /** Cost of credit to use to measure this condition */
7
7
  creditCost?: number;
8
8
  /** ID of credit to use to measure this condition */
@@ -11,12 +11,12 @@ export interface CreateOrUpdateConditionRequestBody {
11
11
  eventSubtype?: string;
12
12
  id?: string;
13
13
  /** Period of time over which to measure the track event metric */
14
- metricPeriod?: Schematic.CreateOrUpdateConditionRequestBodyMetricPeriod;
14
+ metricPeriod?: Schematic.MetricPeriod;
15
15
  /** When metric_period=current_month, specify whether the month restarts based on the calendar month or the billing period */
16
- metricPeriodMonthReset?: Schematic.CreateOrUpdateConditionRequestBodyMetricPeriodMonthReset;
16
+ metricPeriodMonthReset?: Schematic.MetricPeriodMonthReset;
17
17
  /** Value to compare the track event metric against */
18
18
  metricValue?: number;
19
- operator: Schematic.CreateOrUpdateConditionRequestBodyOperator;
19
+ operator: Schematic.ComparableOperator;
20
20
  /** List of resource IDs (companies, users, or plans) targeted by this condition */
21
21
  resourceIds: string[];
22
22
  /** ID of trait to use to measure this condition */
@@ -6,6 +6,6 @@ export interface CreateOrUpdateFlagRequestBody {
6
6
  flagType: Schematic.FlagType;
7
7
  id?: string;
8
8
  key: string;
9
- maintainerId?: string;
9
+ maintainerAccountMemberId?: string;
10
10
  name: string;
11
11
  }
@@ -5,6 +5,6 @@ export interface CreateOrUpdateRuleRequestBody {
5
5
  id?: string;
6
6
  name: string;
7
7
  priority: number;
8
- ruleType?: Schematic.CreateOrUpdateRuleRequestBodyRuleType;
8
+ ruleType?: Schematic.RuleType;
9
9
  value: boolean;
10
10
  }
@@ -25,7 +25,10 @@ export interface CreditCompanyGrantView {
25
25
  quantityUsed: number;
26
26
  renewalEnabled: boolean;
27
27
  renewalPeriod?: Schematic.BillingPlanCreditGrantResetCadence;
28
+ reserved?: number;
29
+ settled?: number;
28
30
  singularName?: string;
31
+ sourceGrantId?: string;
29
32
  sourceLabel: string;
30
33
  transfers?: Schematic.CreditTransferView[];
31
34
  updatedAt: Date;
@@ -0,0 +1,5 @@
1
+ import type * as Schematic from "../index";
2
+ export interface CreditCurrencyPrice {
3
+ currency: string;
4
+ price?: Schematic.BillingPriceView;
5
+ }
@@ -30,5 +30,6 @@ export interface CreditEventLedgerResponseData {
30
30
  sourceId: number;
31
31
  toGrantId?: string;
32
32
  usageEventId?: string;
33
+ usageReason?: Schematic.CreditUsageReason;
33
34
  zeroedOutReason?: Schematic.BillingCreditGrantZeroedOutReason;
34
35
  }
@@ -0,0 +1,10 @@
1
+ export interface CreditLeaseResponseData {
2
+ companyId: string;
3
+ createdAt: Date;
4
+ creditTypeId: string;
5
+ expiresAt: Date;
6
+ grantedAmount: number;
7
+ id: string;
8
+ releasedAt?: Date;
9
+ updatedAt: Date;
10
+ }
@@ -0,0 +1,8 @@
1
+ export declare const CreditUsageReason: {
2
+ readonly LeaseHold: "lease_hold";
3
+ readonly LeaseRelease: "lease_release";
4
+ readonly ManualAdjustment: "manual_adjustment";
5
+ readonly Reconciliation: "reconciliation";
6
+ readonly Track: "track";
7
+ };
8
+ export type CreditUsageReason = (typeof CreditUsageReason)[keyof typeof CreditUsageReason];
@@ -4,6 +4,9 @@ export interface CurrencyPriceRequestBody {
4
4
  monthlyPriceTiers?: Schematic.CreatePriceTierRequestBody[];
5
5
  monthlyUnitPrice?: number;
6
6
  monthlyUnitPriceDecimal?: string;
7
+ quarterlyPriceTiers?: Schematic.CreatePriceTierRequestBody[];
8
+ quarterlyUnitPrice?: number;
9
+ quarterlyUnitPriceDecimal?: string;
7
10
  yearlyPriceTiers?: Schematic.CreatePriceTierRequestBody[];
8
11
  yearlyUnitPrice?: number;
9
12
  yearlyUnitPriceDecimal?: string;
@@ -4,6 +4,7 @@ export interface CustomPlanBillingResponseData {
4
4
  companyId: string;
5
5
  createdAt: Date;
6
6
  daysUntilDue: number;
7
+ externalInvoiceId?: string;
7
8
  id: string;
8
9
  paidAt?: Date;
9
10
  planId: string;
@@ -1,5 +1,6 @@
1
1
  export declare const CustomPlanBillingStatus: {
2
2
  readonly Active: "active";
3
+ readonly Expired: "expired";
3
4
  readonly Paid: "paid";
4
5
  readonly Pending: "pending";
5
6
  };
@@ -1,7 +1,10 @@
1
1
  import type * as Schematic from "../index";
2
2
  export interface DataEventPayload {
3
3
  apiKey: string;
4
+ backfill?: boolean;
4
5
  body?: Record<string, unknown>;
6
+ idempotencyKey?: string;
5
7
  sentAt?: Date;
8
+ trustedClientClock?: boolean;
6
9
  type: Schematic.EventType;
7
10
  }
@@ -1,5 +1,6 @@
1
1
  import type * as Schematic from "../index";
2
2
  export interface DuplicatePlanEntitlementsResponseResponseData {
3
3
  data: Schematic.PlanEntitlementResponseData[];
4
+ issues: Schematic.PlanIssueResponseData[];
4
5
  skipped: Schematic.SkippedEntitlementResponseData[];
5
6
  }
@@ -2,5 +2,6 @@ import type * as Schematic from "../index";
2
2
  export interface EntitlementCurrencyPricesResponseData {
3
3
  currency: string;
4
4
  monthlyPrice?: Schematic.BillingPriceView;
5
+ quarterlyPrice?: Schematic.BillingPriceView;
5
6
  yearlyPrice?: Schematic.BillingPriceView;
6
7
  }
@@ -0,0 +1,6 @@
1
+ import type * as Schematic from "../index";
2
+ export interface EnvironmentFeatureUsageTimeSeriesResponseData {
3
+ eventSubtype: string;
4
+ featureId: string;
5
+ points: Schematic.EnvironmentUsagePointResponseData[];
6
+ }
@@ -0,0 +1,6 @@
1
+ import type * as Schematic from "../index";
2
+ export interface EnvironmentTraitUsageTimeSeriesResponseData {
3
+ featureId: string;
4
+ points: Schematic.EnvironmentUsagePointResponseData[];
5
+ traitDefinitionId: string;
6
+ }
@@ -0,0 +1,4 @@
1
+ export interface EnvironmentUsagePointResponseData {
2
+ timestamp: Date;
3
+ usage: number;
4
+ }
@@ -3,6 +3,8 @@ export interface EventBodyTrack {
3
3
  company?: Record<string, string>;
4
4
  /** The name of the type of track event */
5
5
  event: string;
6
+ /** Credit lease ID this track event is redeeming against */
7
+ leaseId?: string;
6
8
  /** Optionally specify the quantity of the event */
7
9
  quantity?: number;
8
10
  /** A map of trait names to trait values */
@@ -1,6 +1,7 @@
1
1
  import type * as Schematic from "../index";
2
2
  export interface EventDetailResponseData {
3
3
  apiKey?: string;
4
+ apiKeyView?: Schematic.ApiKeyResponseData;
4
5
  body: Record<string, unknown>;
5
6
  bodyPreview: string;
6
7
  capturedAt: Date;
@@ -12,6 +13,8 @@ export interface EventDetailResponseData {
12
13
  featureIds: string[];
13
14
  features: Schematic.PreviewObject[];
14
15
  id: string;
16
+ idempotencyKey?: string;
17
+ leaseId?: string;
15
18
  loadedAt?: Date;
16
19
  processedAt?: Date;
17
20
  quantity: number;
@@ -10,6 +10,8 @@ export interface EventResponseData {
10
10
  errorMessage?: string;
11
11
  featureIds: string[];
12
12
  id: string;
13
+ idempotencyKey?: string;
14
+ leaseId?: string;
13
15
  loadedAt?: Date;
14
16
  processedAt?: Date;
15
17
  quantity: number;
@@ -32,7 +32,7 @@ export interface FeatureCompanyResponseData {
32
32
  /** Source of the entitlement (plan or company_override) */
33
33
  entitlementSource?: string;
34
34
  entitlementType: Schematic.EntitlementType;
35
- feature?: Schematic.FeatureDetailResponseData;
35
+ feature?: Schematic.FeatureInPlanResponseData;
36
36
  /** Whether a valid allocation exists */
37
37
  hasValidAllocation?: boolean;
38
38
  /** Whether this is an unlimited allocation */
@@ -40,17 +40,18 @@ export interface FeatureCompanyResponseData {
40
40
  /** The time at which the metric will reset. */
41
41
  metricResetAt?: Date;
42
42
  /** If the period is current_month, when the month resets. */
43
- monthReset?: string;
43
+ monthReset?: Schematic.MetricPeriodMonthReset;
44
44
  monthlyUsageBasedPrice?: Schematic.BillingPriceView;
45
45
  /** Amount of usage exceeding soft limit (overage pricing only) */
46
46
  overuse?: number;
47
47
  /** Percentage of allocation consumed (0-100+) */
48
48
  percentUsed?: number;
49
49
  /** The period over which usage is measured. */
50
- period?: string;
50
+ period?: Schematic.MetricPeriod;
51
51
  plan?: Schematic.PlanResponseData;
52
52
  planEntitlement?: Schematic.PlanEntitlementResponseData;
53
53
  priceBehavior?: Schematic.EntitlementPriceBehavior;
54
+ quarterlyUsageBasedPrice?: Schematic.BillingPriceView;
54
55
  /** The soft limit for the feature usage. Available only for overage price behavior */
55
56
  softLimit?: number;
56
57
  /** The amount of usage that has been consumed; a null value indicates that usage is not being measured or that this is a credit-based entitlement (use credit_used instead). */
@@ -13,9 +13,9 @@ export interface FeatureCompanyUserResponseData {
13
13
  /** The time at which the metric will resets. */
14
14
  metricResetAt?: Date;
15
15
  /** If the period is current_month, when the month resets. */
16
- monthReset?: string;
16
+ monthReset?: Schematic.MetricPeriodMonthReset;
17
17
  /** The period over which usage is measured. */
18
- period?: string;
18
+ period?: Schematic.MetricPeriod;
19
19
  plan?: Schematic.PlanResponseData;
20
20
  /** The amount of usage that has been consumed; a null value indicates that usage is not being measured. */
21
21
  usage?: number;
@@ -10,7 +10,8 @@ export interface FeatureDetailResponseData {
10
10
  icon: string;
11
11
  id: string;
12
12
  lifecyclePhase?: Schematic.FeatureLifecyclePhase;
13
- maintainerId?: string;
13
+ maintainer?: Schematic.AccountMemberResponseData;
14
+ maintainerAccountMemberId?: string;
14
15
  name: string;
15
16
  plans: Schematic.PreviewObject[];
16
17
  pluralName?: string;
@@ -17,11 +17,11 @@ export interface FeatureEntitlement {
17
17
  /** The key of the flag associated with the feature */
18
18
  featureKey: string;
19
19
  /** For event-based feature entitlements, the period over which usage is tracked */
20
- metricPeriod?: Schematic.FeatureEntitlementMetricPeriod;
20
+ metricPeriod?: Schematic.MetricPeriod;
21
21
  /** For event-based feature entitlements, when the usage period will reset */
22
22
  metricResetAt?: Date;
23
23
  /** For event-based feature entitlements that have a monthly period, whether that monthly reset is based on the calendar month or a billing cycle */
24
- monthReset?: Schematic.FeatureEntitlementMonthReset;
24
+ monthReset?: Schematic.MetricPeriodMonthReset;
25
25
  /** For usage-based pricing, the soft limit for overage charges or the next tier boundary */
26
26
  softLimit?: number;
27
27
  /** If the company has a numeric entitlement for this feature, the current usage amount */
@@ -0,0 +1,21 @@
1
+ import type * as Schematic from "../index";
2
+ export interface FeatureInPlanResponseData {
3
+ billingLinkedResource?: Schematic.BillingLinkedResourceResponseData;
4
+ createdAt: Date;
5
+ description: string;
6
+ eventSubtype?: string;
7
+ eventSummary?: Schematic.EventSummaryResponseData;
8
+ featureType: Schematic.FeatureType;
9
+ flags: Schematic.FlagInPlanResponseData[];
10
+ icon: string;
11
+ id: string;
12
+ lifecyclePhase?: Schematic.FeatureLifecyclePhase;
13
+ maintainerAccountMemberId?: string;
14
+ name: string;
15
+ plans: Schematic.PreviewObject[];
16
+ pluralName?: string;
17
+ singularName?: string;
18
+ trait?: Schematic.EntityTraitDefinitionResponseData;
19
+ traitId?: string;
20
+ updatedAt: Date;
21
+ }
@@ -7,7 +7,7 @@ export interface FeatureResponseData {
7
7
  icon: string;
8
8
  id: string;
9
9
  lifecyclePhase?: Schematic.FeatureLifecyclePhase;
10
- maintainerId?: string;
10
+ maintainerAccountMemberId?: string;
11
11
  name: string;
12
12
  pluralName?: string;
13
13
  singularName?: string;
@@ -30,7 +30,7 @@ export interface FeatureUsageResponseData {
30
30
  /** Source of the entitlement (plan or company_override) */
31
31
  entitlementSource?: string;
32
32
  entitlementType: Schematic.EntitlementType;
33
- feature?: Schematic.FeatureDetailResponseData;
33
+ feature?: Schematic.FeatureInPlanResponseData;
34
34
  /** Whether a valid allocation exists */
35
35
  hasValidAllocation?: boolean;
36
36
  /** Whether this is an unlimited allocation */
@@ -38,17 +38,18 @@ export interface FeatureUsageResponseData {
38
38
  /** The time at which the metric will reset. */
39
39
  metricResetAt?: Date;
40
40
  /** If the period is current_month, when the month resets. */
41
- monthReset?: string;
41
+ monthReset?: Schematic.MetricPeriodMonthReset;
42
42
  monthlyUsageBasedPrice?: Schematic.BillingPriceView;
43
43
  /** Amount of usage exceeding soft limit (overage pricing only) */
44
44
  overuse?: number;
45
45
  /** Percentage of allocation consumed (0-100+) */
46
46
  percentUsed?: number;
47
47
  /** The period over which usage is measured. */
48
- period?: string;
48
+ period?: Schematic.MetricPeriod;
49
49
  plan?: Schematic.PlanResponseData;
50
50
  planEntitlement?: Schematic.PlanEntitlementResponseData;
51
51
  priceBehavior?: Schematic.EntitlementPriceBehavior;
52
+ quarterlyUsageBasedPrice?: Schematic.BillingPriceView;
52
53
  /** The soft limit for the feature usage. Available only for overage price behavior */
53
54
  softLimit?: number;
54
55
  /** The amount of usage that has been consumed; a null value indicates that usage is not being measured or that this is a credit-based entitlement (use credit_used instead). */
@@ -11,7 +11,6 @@ export interface FeatureView {
11
11
  icon: string;
12
12
  id: string;
13
13
  lifecyclePhase?: Schematic.FeatureLifecyclePhase;
14
- maintainerId?: string;
15
14
  name: string;
16
15
  plans: Schematic.PreviewObject[];
17
16
  pluralName?: string;
@@ -19,4 +18,5 @@ export interface FeatureView {
19
18
  trait?: Schematic.EntityTraitDefinitionResponseData;
20
19
  traitId?: string;
21
20
  updatedAt: Date;
21
+ usageLimitTraitId?: string;
22
22
  }
@@ -9,7 +9,8 @@ export interface FlagDetailResponseData {
9
9
  id: string;
10
10
  key: string;
11
11
  lastCheckedAt?: Date;
12
- maintainerId?: string;
12
+ maintainer?: Schematic.AccountMemberResponseData;
13
+ maintainerAccountMemberId?: string;
13
14
  name: string;
14
15
  rules: Schematic.RuleDetailResponseData[];
15
16
  updatedAt: Date;
@@ -0,0 +1,16 @@
1
+ import type * as Schematic from "../index";
2
+ export interface FlagInPlanResponseData {
3
+ createdAt: Date;
4
+ defaultValue: boolean;
5
+ description: string;
6
+ feature?: Schematic.FeatureResponseData;
7
+ featureId?: string;
8
+ flagType: Schematic.FlagType;
9
+ id: string;
10
+ key: string;
11
+ lastCheckedAt?: Date;
12
+ maintainerAccountMemberId?: string;
13
+ name: string;
14
+ rules: Schematic.RuleDetailResponseData[];
15
+ updatedAt: Date;
16
+ }
@@ -7,7 +7,7 @@ export interface FlagResponseData {
7
7
  flagType: Schematic.FlagType;
8
8
  id: string;
9
9
  key: string;
10
- maintainerId?: string;
10
+ maintainerAccountMemberId?: string;
11
11
  name: string;
12
12
  updatedAt: Date;
13
13
  }
@@ -10,7 +10,6 @@ export interface FlagView {
10
10
  id: string;
11
11
  key: string;
12
12
  lastCheckedAt?: Date;
13
- maintainerId?: string;
14
13
  name: string;
15
14
  rules: Schematic.RuleView[];
16
15
  updatedAt: Date;
@@ -0,0 +1,9 @@
1
+ import type * as Schematic from "../index";
2
+ export interface InsightsSummaryResponseData {
3
+ activeCredits: number;
4
+ mrr: Schematic.MrrResponseData[];
5
+ paidCompanies: number;
6
+ totalCompanies: number;
7
+ totalFeatures: number;
8
+ totalPlans: number;
9
+ }
@@ -0,0 +1,9 @@
1
+ import type * as Schematic from "../index";
2
+ export interface InstallIntegrationRequestBody {
3
+ companyMatchingCriteria?: Schematic.CompanyMatchingCriteria;
4
+ companyMatchingField?: string;
5
+ config?: Record<string, unknown>;
6
+ isSandbox?: boolean;
7
+ liveMode?: boolean;
8
+ type: Schematic.IntegrationType;
9
+ }
@@ -0,0 +1,5 @@
1
+ export interface IntegrationCapabilities {
2
+ authorPlans: boolean;
3
+ checkout: boolean;
4
+ editBilling: boolean;
5
+ }
@@ -0,0 +1,19 @@
1
+ import type * as Schematic from "../index";
2
+ export type IntegrationConfig = Schematic.IntegrationConfig.Clerk | Schematic.IntegrationConfig.Metronome | Schematic.IntegrationConfig.Orb | Schematic.IntegrationConfig.Stripe | Schematic.IntegrationConfig.Workos;
3
+ export declare namespace IntegrationConfig {
4
+ interface Clerk extends Schematic.ClerkIntegrationConfig {
5
+ type: "clerk";
6
+ }
7
+ interface Metronome extends Schematic.MetronomeIntegrationConfig {
8
+ type: "metronome";
9
+ }
10
+ interface Orb extends Schematic.OrbIntegrationConfig {
11
+ type: "orb";
12
+ }
13
+ interface Stripe extends Schematic.StripeIntegrationConfig {
14
+ type: "stripe";
15
+ }
16
+ interface Workos extends Schematic.WorkOsIntegrationConfig {
17
+ type: "workos";
18
+ }
19
+ }
@@ -0,0 +1,13 @@
1
+ import type * as Schematic from "../index";
2
+ export interface IntegrationInstallConfig {
3
+ companyMatchingCriteria?: Schematic.CompanyMatchingCriteria;
4
+ companyMatchingField?: string;
5
+ config?: Schematic.IntegrationConfig;
6
+ createdAt: Date;
7
+ id: string;
8
+ integrationId: string;
9
+ isAppInstall: boolean;
10
+ isConnectInstall: boolean;
11
+ liveMode: boolean;
12
+ updatedAt: Date;
13
+ }
@@ -0,0 +1,6 @@
1
+ import type * as Schematic from "../index";
2
+ export interface IntegrationInstallResponseData {
3
+ capabilities: Schematic.IntegrationCapabilities;
4
+ config: Schematic.IntegrationInstallConfig;
5
+ integration: Schematic.IntegrationResponseData;
6
+ }
@@ -0,0 +1,8 @@
1
+ import type * as Schematic from "../index";
2
+ export interface IntegrationResponseData {
3
+ createdAt: Date;
4
+ id: string;
5
+ state: Schematic.IntegrationState;
6
+ type: Schematic.IntegrationType;
7
+ updatedAt: Date;
8
+ }