@schematichq/schematic-typescript-node 1.4.5 → 1.4.7

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 (706) hide show
  1. package/README.md +118 -2
  2. package/dist/BaseClient.d.ts +3 -0
  3. package/dist/Client.d.ts +8 -20
  4. package/dist/api/resources/accounts/client/Client.d.ts +35 -0
  5. package/dist/api/resources/accounts/client/requests/ListAccountMembersRequest.d.ts +18 -0
  6. package/dist/api/resources/accounts/client/requests/ListEnvironmentsRequest.d.ts +1 -0
  7. package/dist/api/resources/accounts/client/requests/index.d.ts +1 -0
  8. package/dist/api/resources/accounts/types/GetAccountMemberResponse.d.ts +6 -0
  9. package/dist/api/resources/accounts/types/ListAccountMembersParams.d.ts +12 -0
  10. package/dist/api/resources/accounts/types/ListAccountMembersResponse.d.ts +6 -0
  11. package/dist/api/resources/accounts/types/index.d.ts +3 -0
  12. package/dist/api/resources/billing/client/Client.d.ts +33 -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/CreateBillingSubscriptionRequestBody.d.ts +1 -0
  17. package/dist/api/resources/billing/client/requests/CreateMeterRequestBody.d.ts +2 -0
  18. package/dist/api/resources/billing/client/requests/ListBillingPricesRequest.d.ts +6 -1
  19. package/dist/api/resources/billing/client/requests/ListBillingProductPricesRequest.d.ts +6 -1
  20. package/dist/api/resources/billing/client/requests/ListBillingProductsRequest.d.ts +5 -1
  21. package/dist/api/resources/billing/client/requests/ListCustomersWithSubscriptionsRequest.d.ts +2 -1
  22. package/dist/api/resources/billing/types/CountBillingProductsParams.d.ts +2 -0
  23. package/dist/api/resources/billing/types/DeletePaymentMethodByExternalIdResponse.d.ts +6 -0
  24. package/dist/api/resources/billing/types/ListBillingPricesParams.d.ts +2 -0
  25. package/dist/api/resources/billing/types/ListBillingProductPricesParams.d.ts +2 -0
  26. package/dist/api/resources/billing/types/ListBillingProductsParams.d.ts +2 -0
  27. package/dist/api/resources/billing/types/index.d.ts +1 -0
  28. package/dist/api/resources/checkout/client/Client.d.ts +6 -0
  29. package/dist/api/resources/companies/client/Client.d.ts +31 -55
  30. package/dist/api/resources/companies/client/requests/CountCompaniesRequest.d.ts +11 -0
  31. package/dist/api/resources/companies/client/requests/CountEntityKeyDefinitionsRequest.d.ts +1 -0
  32. package/dist/api/resources/companies/client/requests/CountEntityTraitDefinitionsRequest.d.ts +2 -0
  33. package/dist/api/resources/companies/client/requests/CountPlanTraitsRequest.d.ts +2 -0
  34. package/dist/api/resources/companies/client/requests/CountUsersRequest.d.ts +1 -0
  35. package/dist/api/resources/companies/client/requests/GetActiveCompanySubscriptionRequest.d.ts +1 -0
  36. package/dist/api/resources/companies/client/requests/ListCompaniesRequest.d.ts +11 -0
  37. package/dist/api/resources/companies/client/requests/ListEntityKeyDefinitionsRequest.d.ts +1 -0
  38. package/dist/api/resources/companies/client/requests/ListEntityTraitDefinitionsRequest.d.ts +2 -0
  39. package/dist/api/resources/companies/client/requests/ListPlanChangesRequest.d.ts +7 -4
  40. package/dist/api/resources/companies/client/requests/ListPlanTraitsRequest.d.ts +2 -0
  41. package/dist/api/resources/companies/client/requests/ListUsersRequest.d.ts +1 -0
  42. package/dist/api/resources/companies/client/requests/index.d.ts +0 -2
  43. package/dist/api/resources/companies/types/CountCompaniesParams.d.ts +4 -0
  44. package/dist/api/resources/companies/types/ListCompaniesParams.d.ts +4 -0
  45. package/dist/api/resources/companies/types/ListPlanChangesParams.d.ts +3 -2
  46. package/dist/api/resources/companies/types/index.d.ts +0 -3
  47. package/dist/api/resources/credits/client/Client.d.ts +99 -1
  48. package/dist/api/resources/credits/client/requests/AcquireCreditLeaseRequestBody.d.ts +14 -0
  49. package/dist/api/resources/credits/client/requests/CountBillingCreditsGrantsRequest.d.ts +1 -0
  50. package/dist/api/resources/credits/client/requests/CountBillingCreditsRequest.d.ts +1 -0
  51. package/dist/api/resources/credits/client/requests/CountBillingPlanCreditGrantsRequest.d.ts +4 -0
  52. package/dist/api/resources/credits/client/requests/CountCreditBundlesRequest.d.ts +1 -0
  53. package/dist/api/resources/credits/client/requests/CreateBillingCreditRequestBody.d.ts +1 -0
  54. package/dist/api/resources/credits/client/requests/CreateCompanyCreditGrant.d.ts +2 -1
  55. package/dist/api/resources/credits/client/requests/CreateCreditBundleRequestBody.d.ts +1 -0
  56. package/dist/api/resources/credits/client/requests/ExtendCreditLeaseRequestBody.d.ts +10 -0
  57. package/dist/api/resources/credits/client/requests/ListBillingCreditsRequest.d.ts +1 -0
  58. package/dist/api/resources/credits/client/requests/ListBillingPlanCreditGrantsRequest.d.ts +4 -0
  59. package/dist/api/resources/credits/client/requests/ListCompanyCreditBalancesRequest.d.ts +9 -0
  60. package/dist/api/resources/credits/client/requests/ListCreditBundlesRequest.d.ts +1 -0
  61. package/dist/api/resources/credits/client/requests/ListGrantsForCreditRequest.d.ts +1 -0
  62. package/dist/api/resources/credits/client/requests/UpdateBillingCreditRequestBody.d.ts +1 -0
  63. package/dist/api/resources/credits/client/requests/UpdateCreditBundleDetailsRequestBody.d.ts +1 -0
  64. package/dist/api/resources/credits/client/requests/index.d.ts +3 -0
  65. package/dist/api/resources/credits/types/AcquireCreditLeaseResponse.d.ts +6 -0
  66. package/dist/api/resources/credits/types/CountBillingPlanCreditGrantsParams.d.ts +1 -0
  67. package/dist/api/resources/credits/types/ExtendCreditLeaseResponse.d.ts +6 -0
  68. package/dist/api/resources/credits/types/GetSingleBillingPlanCreditGrantResponse.d.ts +6 -0
  69. package/dist/api/resources/credits/types/ListBillingPlanCreditGrantsParams.d.ts +1 -0
  70. package/dist/api/resources/credits/types/ListCompanyCreditBalancesParams.d.ts +6 -0
  71. package/dist/api/resources/credits/types/ListCompanyCreditBalancesResponse.d.ts +6 -0
  72. package/dist/api/resources/credits/types/ReleaseCreditLeaseResponse.d.ts +6 -0
  73. package/dist/api/resources/credits/types/index.d.ts +6 -0
  74. package/dist/api/resources/entitlements/client/Client.d.ts +39 -0
  75. package/dist/api/resources/entitlements/client/requests/CountCompanyOverridesRequest.d.ts +3 -0
  76. package/dist/api/resources/entitlements/client/requests/CountFeatureUsageRequest.d.ts +5 -0
  77. package/dist/api/resources/entitlements/client/requests/CountPlanEntitlementsRequest.d.ts +4 -0
  78. package/dist/api/resources/entitlements/client/requests/CreateBillingLinkedPlanEntitlementRequestBody.d.ts +50 -0
  79. package/dist/api/resources/entitlements/client/requests/CreateCompanyOverrideRequestBody.d.ts +2 -2
  80. package/dist/api/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +9 -2
  81. package/dist/api/resources/entitlements/client/requests/ListCompanyOverridesRequest.d.ts +3 -0
  82. package/dist/api/resources/entitlements/client/requests/ListFeatureUsageRequest.d.ts +5 -0
  83. package/dist/api/resources/entitlements/client/requests/ListPlanEntitlementsRequest.d.ts +4 -0
  84. package/dist/api/resources/entitlements/client/requests/UpdateCompanyOverrideRequestBody.d.ts +2 -2
  85. package/dist/api/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts +9 -2
  86. package/dist/api/resources/entitlements/client/requests/index.d.ts +1 -0
  87. package/dist/api/resources/entitlements/types/CountFeatureUsageParams.d.ts +3 -0
  88. package/dist/api/resources/entitlements/types/ListFeatureUsageParams.d.ts +3 -0
  89. package/dist/api/resources/entitlements/types/UpsertPlanEntitlementForBillingProductResponse.d.ts +6 -0
  90. package/dist/api/resources/entitlements/types/index.d.ts +1 -8
  91. package/dist/api/resources/events/client/Client.d.ts +3 -0
  92. package/dist/api/resources/events/client/requests/GetEventSummariesRequest.d.ts +1 -0
  93. package/dist/api/resources/events/client/requests/ListEventsRequest.d.ts +3 -0
  94. package/dist/api/resources/events/types/ListEventsParams.d.ts +1 -0
  95. package/dist/api/resources/features/client/Client.d.ts +35 -6
  96. package/dist/api/resources/features/client/requests/CountFeaturesRequest.d.ts +13 -8
  97. package/dist/api/resources/features/client/requests/CountFlagsRequest.d.ts +1 -0
  98. package/dist/api/resources/features/client/requests/CreateBillingLinkedFeatureRequestBody.d.ts +26 -0
  99. package/dist/api/resources/features/client/requests/CreateFeatureRequestBody.d.ts +1 -1
  100. package/dist/api/resources/features/client/requests/ListFeaturesRequest.d.ts +13 -8
  101. package/dist/api/resources/features/client/requests/ListFlagsRequest.d.ts +1 -0
  102. package/dist/api/resources/features/client/requests/UpdateFeatureRequestBody.d.ts +1 -1
  103. package/dist/api/resources/features/client/requests/UpdateFlagRulesRequestBody.d.ts +2 -2
  104. package/dist/api/resources/features/client/requests/index.d.ts +1 -0
  105. package/dist/api/resources/features/types/CountFeaturesParams.d.ts +2 -0
  106. package/dist/api/resources/features/types/ListFeaturesParams.d.ts +2 -0
  107. package/dist/api/resources/features/types/UpsertFeatureForBillingProductResponse.d.ts +6 -0
  108. package/dist/api/resources/features/types/index.d.ts +1 -0
  109. package/dist/api/resources/index.d.ts +6 -0
  110. package/dist/api/resources/insights/client/Client.d.ts +114 -0
  111. package/dist/api/resources/insights/client/index.d.ts +1 -0
  112. package/dist/api/resources/insights/client/requests/GetActivityRequest.d.ts +9 -0
  113. package/dist/api/resources/insights/client/requests/GetEnvironmentFeatureUsageTimeSeriesRequest.d.ts +16 -0
  114. package/dist/api/resources/insights/client/requests/GetEnvironmentTraitUsageTimeSeriesRequest.d.ts +16 -0
  115. package/dist/api/resources/insights/client/requests/GetPlanGrowthRequest.d.ts +9 -0
  116. package/dist/api/resources/insights/client/requests/GetTopFeaturesByUsageRequest.d.ts +13 -0
  117. package/dist/api/resources/insights/client/requests/index.d.ts +5 -0
  118. package/dist/api/resources/insights/exports.d.ts +2 -0
  119. package/dist/api/resources/insights/index.d.ts +2 -0
  120. package/dist/api/resources/insights/types/GetActivityParams.d.ts +6 -0
  121. package/dist/api/resources/insights/types/GetActivityResponse.d.ts +6 -0
  122. package/dist/api/resources/insights/types/GetEnvironmentFeatureUsageTimeSeriesParams.d.ts +10 -0
  123. package/dist/api/resources/insights/types/GetEnvironmentFeatureUsageTimeSeriesResponse.d.ts +6 -0
  124. package/dist/api/resources/insights/types/GetEnvironmentTraitUsageTimeSeriesParams.d.ts +10 -0
  125. package/dist/api/resources/insights/types/GetEnvironmentTraitUsageTimeSeriesResponse.d.ts +6 -0
  126. package/dist/api/resources/insights/types/GetPlanGrowthParams.d.ts +6 -0
  127. package/dist/api/resources/insights/types/GetPlanGrowthResponse.d.ts +6 -0
  128. package/dist/api/resources/{companies/types/UpdatePlanTraitResponse.d.ts → insights/types/GetSummaryResponse.d.ts} +2 -2
  129. package/dist/api/resources/insights/types/GetTopFeaturesByUsageParams.d.ts +8 -0
  130. package/dist/api/resources/insights/types/GetTopFeaturesByUsageResponse.d.ts +6 -0
  131. package/dist/api/resources/insights/types/index.d.ts +11 -0
  132. package/dist/api/resources/integrationsapi/client/Client.d.ts +109 -0
  133. package/dist/api/resources/integrationsapi/client/index.d.ts +1 -0
  134. package/dist/api/resources/integrationsapi/client/requests/ListIntegrationsRequest.d.ts +24 -0
  135. package/dist/api/resources/integrationsapi/client/requests/StartDataImportRequestBody.d.ts +12 -0
  136. package/dist/api/resources/integrationsapi/client/requests/index.d.ts +2 -0
  137. package/dist/api/resources/integrationsapi/exports.d.ts +2 -0
  138. package/dist/api/resources/integrationsapi/index.d.ts +2 -0
  139. package/dist/api/resources/integrationsapi/types/GetIntegrationWebhookUrlResponse.d.ts +6 -0
  140. package/dist/api/resources/integrationsapi/types/ListIntegrationsParams.d.ts +15 -0
  141. package/dist/api/resources/integrationsapi/types/ListIntegrationsResponse.d.ts +6 -0
  142. package/dist/api/resources/integrationsapi/types/LoadSampleDataSetV2Response.d.ts +6 -0
  143. package/dist/api/resources/{companies/types/CreatePlanTraitResponse.d.ts → integrationsapi/types/RunIntegrationResponse.d.ts} +2 -2
  144. package/dist/api/resources/integrationsapi/types/StartDataImportResponse.d.ts +6 -0
  145. package/dist/api/resources/{companies/types/DeletePlanTraitResponse.d.ts → integrationsapi/types/UninstallIntegrationResponse.d.ts} +1 -1
  146. package/dist/api/resources/integrationsapi/types/index.d.ts +7 -0
  147. package/dist/api/resources/planbundle/client/Client.d.ts +19 -0
  148. package/dist/api/resources/planbundle/client/requests/CreateCustomPlanBundleRequestBody.d.ts +14 -0
  149. package/dist/api/resources/planbundle/client/requests/index.d.ts +1 -0
  150. package/dist/api/resources/planbundle/types/CreateCustomPlanBundleResponse.d.ts +6 -0
  151. package/dist/api/resources/planbundle/types/index.d.ts +1 -0
  152. package/dist/api/resources/planmigrations/client/Client.d.ts +56 -0
  153. package/dist/api/resources/planmigrations/client/requests/CreateMigrationInput.d.ts +22 -0
  154. package/dist/api/resources/planmigrations/client/requests/RetryMigrationRequestBody.d.ts +10 -0
  155. package/dist/api/resources/planmigrations/client/requests/index.d.ts +2 -0
  156. package/dist/api/resources/planmigrations/types/CreateMigrationResponse.d.ts +6 -0
  157. package/dist/api/resources/planmigrations/types/RetryCompanyMigrationResponse.d.ts +6 -0
  158. package/dist/api/resources/planmigrations/types/RetryMigrationResponse.d.ts +6 -0
  159. package/dist/api/resources/planmigrations/types/index.d.ts +3 -0
  160. package/dist/api/resources/plans/client/Client.d.ts +162 -3
  161. package/dist/api/resources/plans/client/requests/CountBillingProductMatchCompaniesRequest.d.ts +19 -0
  162. package/dist/api/resources/plans/client/requests/CountPlansRequest.d.ts +13 -0
  163. package/dist/api/resources/plans/client/requests/CreateBillingLinkedPlanRequestBody.d.ts +20 -0
  164. package/dist/api/resources/plans/client/requests/CreateCustomPlanRequestBody.d.ts +16 -0
  165. package/dist/api/resources/plans/client/requests/DeletePlanVersionRequest.d.ts +9 -0
  166. package/dist/api/resources/plans/client/requests/ListBillingProductMatchCompaniesRequest.d.ts +19 -0
  167. package/dist/api/resources/plans/client/requests/ListCustomPlanBillingsRequest.d.ts +26 -0
  168. package/dist/api/resources/plans/client/requests/ListPlansRequest.d.ts +13 -0
  169. package/dist/api/resources/plans/client/requests/PublishPlanVersionRequestBody.d.ts +9 -1
  170. package/dist/api/resources/plans/client/requests/RetryCustomPlanBillingRequestBody.d.ts +17 -0
  171. package/dist/api/resources/plans/client/requests/index.d.ts +7 -0
  172. package/dist/api/resources/plans/types/CountBillingProductMatchCompaniesParams.d.ts +13 -0
  173. package/dist/api/resources/plans/types/CountBillingProductMatchCompaniesResponse.d.ts +6 -0
  174. package/dist/api/resources/plans/types/CountPlansParams.d.ts +8 -0
  175. package/dist/api/resources/plans/types/CreateCustomPlanResponse.d.ts +6 -0
  176. package/dist/api/resources/plans/types/DeletePlanVersionParams.d.ts +6 -0
  177. package/dist/api/resources/plans/types/DeletePlanVersionResponse.d.ts +1 -1
  178. package/dist/api/resources/plans/types/ListBillingProductMatchCompaniesParams.d.ts +13 -0
  179. package/dist/api/resources/plans/types/ListBillingProductMatchCompaniesResponse.d.ts +6 -0
  180. package/dist/api/resources/plans/types/ListCustomPlanBillingsParams.d.ts +18 -0
  181. package/dist/api/resources/plans/types/ListCustomPlanBillingsResponse.d.ts +6 -0
  182. package/dist/api/resources/plans/types/ListPlansParams.d.ts +8 -0
  183. package/dist/api/resources/plans/types/MarkCustomPlanBillingPaidResponse.d.ts +6 -0
  184. package/dist/api/resources/plans/types/RetryCustomPlanBillingResponse.d.ts +6 -0
  185. package/dist/api/resources/plans/types/UpsertPlanForBillingProductResponse.d.ts +6 -0
  186. package/dist/api/resources/plans/types/index.d.ts +11 -0
  187. package/dist/api/resources/webhooks/client/Client.d.ts +2 -0
  188. package/dist/api/resources/webhooks/client/requests/CountWebhookEventsRequest.d.ts +1 -0
  189. package/dist/api/resources/webhooks/client/requests/ListWebhookEventsRequest.d.ts +1 -0
  190. package/dist/api/types/AccountMemberPermission.d.ts +18 -0
  191. package/dist/api/types/AccountMemberResponseData.d.ts +11 -0
  192. package/dist/api/types/AccountMemberRole.d.ts +5 -0
  193. package/dist/api/types/ActivityEntryResponseData.d.ts +8 -0
  194. package/dist/api/types/ActivityResponseResponseData.d.ts +4 -0
  195. package/dist/api/types/ApiKeyCreateResponseData.d.ts +2 -0
  196. package/dist/api/types/ApiKeyIntegrationResponseData.d.ts +6 -0
  197. package/dist/api/types/ApiKeyResponseData.d.ts +2 -0
  198. package/dist/api/types/AuditLogListResponseData.d.ts +2 -0
  199. package/dist/api/types/AuditLogResponseData.d.ts +2 -0
  200. package/dist/api/types/BillingCreditBundleResponseData.d.ts +2 -0
  201. package/dist/api/types/BillingCreditBundleView.d.ts +1 -0
  202. package/dist/api/types/BillingCreditGrantReason.d.ts +1 -0
  203. package/dist/api/types/BillingCreditGrantResponseData.d.ts +1 -0
  204. package/dist/api/types/BillingCreditResponseData.d.ts +1 -0
  205. package/dist/api/types/BillingCreditView.d.ts +1 -0
  206. package/dist/api/types/BillingLinkedResourceResponseData.d.ts +6 -0
  207. package/dist/api/types/BillingPlanCreditGrantResponseData.d.ts +2 -0
  208. package/dist/api/types/BillingPriceResponseData.d.ts +2 -0
  209. package/dist/api/types/BillingPriceView.d.ts +2 -0
  210. package/dist/api/types/BillingProductForSubscriptionResponseData.d.ts +1 -0
  211. package/dist/api/types/BillingProductPlanResponseData.d.ts +2 -1
  212. package/dist/api/types/BillingProductPriceResponseData.d.ts +2 -0
  213. package/dist/api/types/BillingProviderType.d.ts +1 -0
  214. package/dist/api/types/BillingStrategy.d.ts +6 -0
  215. package/dist/api/types/ChangeSubscriptionInternalRequestBody.d.ts +1 -0
  216. package/dist/api/types/ChangeSubscriptionRequestBody.d.ts +1 -0
  217. package/dist/api/types/ChargeType.d.ts +1 -0
  218. package/dist/api/types/CheckFlagResponseData.d.ts +2 -2
  219. package/dist/api/types/CheckoutSubscription.d.ts +2 -0
  220. package/dist/api/types/ClerkIntegrationConfig.d.ts +6 -0
  221. package/dist/api/types/CompanyCreditBalanceResponseData.d.ts +7 -0
  222. package/dist/api/types/CompanyDetailResponseData.d.ts +1 -0
  223. package/dist/api/types/CompanyEventPeriodMetricsResponseData.d.ts +3 -2
  224. package/dist/api/types/CompanyMatchingCriteria.d.ts +5 -0
  225. package/dist/api/types/CompanyOverrideResponseData.d.ts +2 -2
  226. package/dist/api/types/CompanyPlanCreditGrantView.d.ts +40 -0
  227. package/dist/api/types/CompanyPlanDetailResponseData.d.ts +13 -4
  228. package/dist/api/types/CompanyPlanWithBillingSubView.d.ts +1 -1
  229. package/dist/api/types/CompanySubscriptionResponseData.d.ts +1 -0
  230. package/dist/api/types/{ConditionOperator.d.ts → ComparableOperator.d.ts} +5 -5
  231. package/dist/api/types/Condition.d.ts +4 -4
  232. package/dist/api/types/ConditionResponseData.d.ts +4 -4
  233. package/dist/api/types/{ConditionConditionType.d.ts → ConditionType.d.ts} +2 -2
  234. package/dist/api/types/ConditionView.d.ts +4 -4
  235. package/dist/api/types/CreateBillingPlanCreditGrantRequestBody.d.ts +2 -0
  236. package/dist/api/types/CreateCustomPlanBundlePlanRequestBody.d.ts +7 -0
  237. package/dist/api/types/CreateEntitlementInBundleRequestBody.d.ts +9 -2
  238. package/dist/api/types/CreateEntitlementReqCommon.d.ts +2 -2
  239. package/dist/api/types/CreateEventRequestBody.d.ts +6 -0
  240. package/dist/api/types/CreateFlagRequestBody.d.ts +1 -1
  241. package/dist/api/types/CreateOrUpdateConditionRequestBody.d.ts +4 -4
  242. package/dist/api/types/CreateOrUpdateFlagRequestBody.d.ts +1 -1
  243. package/dist/api/types/CreateOrUpdateRuleRequestBody.d.ts +1 -1
  244. package/dist/api/types/CreatePlanRequestBody.d.ts +1 -1
  245. package/dist/api/types/CreditBundleCurrencyPrice.d.ts +5 -0
  246. package/dist/api/types/CreditBundleCurrencyPriceRequestBody.d.ts +5 -0
  247. package/dist/api/types/CreditBundleCurrencyPriceResponseData.d.ts +5 -0
  248. package/dist/api/types/CreditCompanyGrantView.d.ts +1 -0
  249. package/dist/api/types/CreditCurrencyPrice.d.ts +5 -0
  250. package/dist/api/types/CreditCurrencyPriceRequestBody.d.ts +5 -0
  251. package/dist/api/types/CreditCurrencyPriceResponseData.d.ts +5 -0
  252. package/dist/api/types/CreditLeaseResponseData.d.ts +10 -0
  253. package/dist/api/types/CurrencyPriceRequestBody.d.ts +13 -0
  254. package/dist/api/types/CustomPlanActivationStrategy.d.ts +5 -0
  255. package/dist/api/types/CustomPlanBillingResponseData.d.ts +15 -0
  256. package/dist/api/types/CustomPlanBillingStatus.d.ts +7 -0
  257. package/dist/api/types/DataEventPayload.d.ts +3 -0
  258. package/dist/api/types/DatastreamCompanyPlan.d.ts +2 -0
  259. package/dist/api/types/DuplicatePlanEntitlementsResponseResponseData.d.ts +1 -0
  260. package/dist/api/types/EntitlementCurrencyPricesResponseData.d.ts +7 -0
  261. package/dist/api/types/EnvironmentFeatureUsageTimeSeriesResponseData.d.ts +6 -0
  262. package/dist/api/types/EnvironmentTraitUsageTimeSeriesResponseData.d.ts +6 -0
  263. package/dist/api/types/EnvironmentUsagePointResponseData.d.ts +4 -0
  264. package/dist/api/types/EventBodyTrack.d.ts +2 -0
  265. package/dist/api/types/EventDetailResponseData.d.ts +2 -0
  266. package/dist/api/types/EventResponseData.d.ts +1 -0
  267. package/dist/api/types/FeatureCompanyResponseData.d.ts +4 -3
  268. package/dist/api/types/FeatureCompanyUserResponseData.d.ts +2 -2
  269. package/dist/api/types/FeatureDetailResponseData.d.ts +3 -1
  270. package/dist/api/types/FeatureEntitlement.d.ts +2 -2
  271. package/dist/api/types/FeatureInPlanResponseData.d.ts +21 -0
  272. package/dist/api/types/FeatureResponseData.d.ts +1 -1
  273. package/dist/api/types/FeatureUsageResponseData.d.ts +4 -3
  274. package/dist/api/types/FeatureView.d.ts +2 -1
  275. package/dist/api/types/FlagDetailResponseData.d.ts +2 -1
  276. package/dist/api/types/FlagInPlanResponseData.d.ts +16 -0
  277. package/dist/api/types/FlagResponseData.d.ts +1 -1
  278. package/dist/api/types/FlagView.d.ts +0 -1
  279. package/dist/api/types/InsightsSummaryResponseData.d.ts +9 -0
  280. package/dist/api/types/IntegrationCapabilities.d.ts +5 -0
  281. package/dist/api/types/IntegrationConfig.d.ts +16 -0
  282. package/dist/api/types/IntegrationResponseData.d.ts +8 -0
  283. package/dist/api/types/IntegrationState.d.ts +6 -0
  284. package/dist/api/types/IntegrationType.d.ts +8 -0
  285. package/dist/api/types/IntegrationWebhookUrlResponseData.d.ts +5 -0
  286. package/dist/api/types/IntegrationsDataSetResponseData.d.ts +3 -0
  287. package/dist/api/types/IntegrationsListResponseData.d.ts +10 -0
  288. package/dist/api/types/IntegrationsResponseData.d.ts +8 -0
  289. package/dist/api/types/MarkCustomPlanBillingPaidRequestBody.d.ts +1 -0
  290. package/dist/api/types/{ConditionMetricPeriod.d.ts → MetricPeriod.d.ts} +2 -2
  291. package/dist/api/types/MetricPeriodMonthReset.d.ts +5 -0
  292. package/dist/api/types/MigrationErrorCode.d.ts +14 -0
  293. package/dist/api/types/MrrResponseData.d.ts +4 -0
  294. package/dist/api/types/OrbIntegrationConfig.d.ts +4 -0
  295. package/dist/api/types/PlanCreditGrantView.d.ts +2 -0
  296. package/dist/api/types/PlanCurrencyPriceRequestBody.d.ts +7 -0
  297. package/dist/api/types/PlanCurrencyPricesResponseData.d.ts +8 -0
  298. package/dist/api/types/PlanDetailResponseData.d.ts +12 -3
  299. package/dist/api/types/PlanEntitlementResponseData.d.ts +7 -2
  300. package/dist/api/types/PlanGroupPlanDetailResponseData.d.ts +13 -4
  301. package/dist/api/types/PlanGrowthPointResponseData.d.ts +6 -0
  302. package/dist/api/types/PlanGrowthResponseData.d.ts +4 -0
  303. package/dist/api/types/PlanIcon.d.ts +28 -0
  304. package/dist/api/types/PlanPriceCadence.d.ts +6 -0
  305. package/dist/api/types/PlanResponseData.d.ts +3 -1
  306. package/dist/api/types/PlanVersionCompanyMigrationResponseData.d.ts +1 -0
  307. package/dist/api/types/PlanVersionMigrationResponseData.d.ts +1 -0
  308. package/dist/api/types/PlanVersionResponseData.d.ts +1 -1
  309. package/dist/api/types/PlanViewPublicResponseData.d.ts +13 -4
  310. package/dist/api/types/ReleaseCreditLeaseRequestBody.d.ts +1 -0
  311. package/dist/api/types/Rule.d.ts +1 -1
  312. package/dist/api/types/RuleConditionDetailResponseData.d.ts +4 -4
  313. package/dist/api/types/RuleConditionResponseData.d.ts +4 -4
  314. package/dist/api/types/RuleDetailResponseData.d.ts +1 -1
  315. package/dist/api/types/RuleResponseData.d.ts +2 -1
  316. package/dist/api/types/{RuleRuleType.d.ts → RuleType.d.ts} +4 -4
  317. package/dist/api/types/RuleView.d.ts +1 -1
  318. package/dist/api/types/RulesEngineSchemaVersion.d.ts +1 -1
  319. package/dist/api/types/RulesengineCheckFlagResult.d.ts +2 -2
  320. package/dist/api/types/RulesengineCompanyMetric.d.ts +2 -2
  321. package/dist/api/types/RulesengineCondition.d.ts +4 -4
  322. package/dist/api/types/{RulesengineConditionConditionType.d.ts → RulesengineConditionType.d.ts} +2 -2
  323. package/dist/api/types/RulesengineFeatureEntitlement.d.ts +2 -2
  324. package/dist/api/types/RulesengineMetricPeriod.d.ts +7 -0
  325. package/dist/api/types/RulesengineMetricPeriodMonthReset.d.ts +5 -0
  326. package/dist/api/types/RulesengineRule.d.ts +1 -1
  327. package/dist/api/types/{RulesengineRuleRuleType.d.ts → RulesengineRuleType.d.ts} +4 -4
  328. package/dist/api/types/StripeIntegrationConfig.d.ts +14 -0
  329. package/dist/api/types/TopFeatureByUsageResponseData.d.ts +8 -0
  330. package/dist/api/types/TopFeaturesByUsageResponseData.d.ts +4 -0
  331. package/dist/api/types/TrialStatus.d.ts +6 -0
  332. package/dist/api/types/UpdateAutoTopupOverrideRequestBody.d.ts +6 -0
  333. package/dist/api/types/UpdateBillingPlanCreditGrantRequestBody.d.ts +2 -0
  334. package/dist/api/types/UpdateEntitlementReqCommon.d.ts +2 -2
  335. package/dist/api/types/UpdatePlanRequestBody.d.ts +2 -1
  336. package/dist/api/types/UpsertBillingProductRequestBody.d.ts +4 -0
  337. package/dist/api/types/UsageBasedEntitlementRequestBody.d.ts +7 -0
  338. package/dist/api/types/UsageBasedEntitlementResponseData.d.ts +5 -2
  339. package/dist/api/types/WebhookUrl.d.ts +5 -0
  340. package/dist/api/types/WorkOsIntegrationConfig.d.ts +6 -0
  341. package/dist/api/types/index.d.ts +67 -30
  342. package/dist/core/auth/AuthProvider.d.ts +1 -0
  343. package/dist/core/auth/BasicAuth.d.ts +2 -2
  344. package/dist/core/auth/index.d.ts +1 -1
  345. package/dist/core/fetcher/Fetcher.d.ts +8 -0
  346. package/dist/core/schemas/builders/enum/enum.d.ts +1 -0
  347. package/dist/core/schemas/builders/enum/index.d.ts +1 -1
  348. package/dist/core/url/QueryStringBuilder.d.ts +47 -0
  349. package/dist/core/url/index.d.ts +1 -0
  350. package/dist/core/url/qs.d.ts +2 -1
  351. package/dist/datastream/merge.d.ts +11 -7
  352. package/dist/datastream/types.d.ts +1 -0
  353. package/dist/datastream/websocket-client.d.ts +1 -1
  354. package/dist/errors/SchematicError.d.ts +3 -1
  355. package/dist/errors/SchematicTimeoutError.d.ts +4 -1
  356. package/dist/event-capture.d.ts +28 -0
  357. package/dist/events.d.ts +3 -3
  358. package/dist/index.d.ts +2 -1
  359. package/dist/index.js +3 -3
  360. package/dist/logger.d.ts +20 -0
  361. package/dist/rules-engine.d.ts +3 -3
  362. package/dist/serialization/resources/accounts/types/GetAccountMemberResponse.d.ts +11 -0
  363. package/dist/serialization/resources/accounts/types/ListAccountMembersParams.d.ts +12 -0
  364. package/dist/serialization/resources/accounts/types/ListAccountMembersResponse.d.ts +12 -0
  365. package/dist/serialization/resources/accounts/types/index.d.ts +3 -0
  366. package/dist/serialization/resources/billing/client/requests/CreateBillingPriceRequestBody.d.ts +2 -0
  367. package/dist/serialization/resources/billing/client/requests/CreateBillingSubscriptionRequestBody.d.ts +2 -0
  368. package/dist/serialization/resources/billing/client/requests/CreateMeterRequestBody.d.ts +2 -0
  369. package/dist/serialization/resources/billing/types/CountBillingProductsParams.d.ts +1 -0
  370. package/dist/serialization/resources/billing/types/DeletePaymentMethodByExternalIdResponse.d.ts +11 -0
  371. package/dist/serialization/resources/billing/types/ListBillingPricesParams.d.ts +1 -0
  372. package/dist/serialization/resources/billing/types/ListBillingProductPricesParams.d.ts +1 -0
  373. package/dist/serialization/resources/billing/types/ListBillingProductsParams.d.ts +1 -0
  374. package/dist/serialization/resources/billing/types/index.d.ts +1 -0
  375. package/dist/serialization/resources/companies/client/requests/index.d.ts +0 -2
  376. package/dist/serialization/resources/companies/types/CountCompaniesParams.d.ts +2 -0
  377. package/dist/serialization/resources/companies/types/ListCompaniesParams.d.ts +2 -0
  378. package/dist/serialization/resources/companies/types/ListPlanChangesParams.d.ts +4 -2
  379. package/dist/serialization/resources/companies/types/index.d.ts +0 -3
  380. package/dist/serialization/resources/credits/client/requests/AcquireCreditLeaseRequestBody.d.ts +12 -0
  381. package/dist/serialization/resources/credits/client/requests/CreateBillingCreditRequestBody.d.ts +2 -0
  382. package/dist/serialization/resources/credits/client/requests/CreateCompanyCreditGrant.d.ts +1 -0
  383. package/dist/serialization/resources/credits/client/requests/CreateCreditBundleRequestBody.d.ts +2 -0
  384. package/dist/serialization/resources/credits/client/requests/ExtendCreditLeaseRequestBody.d.ts +10 -0
  385. package/dist/serialization/resources/credits/client/requests/UpdateBillingCreditRequestBody.d.ts +2 -0
  386. package/dist/serialization/resources/credits/client/requests/UpdateCreditBundleDetailsRequestBody.d.ts +2 -0
  387. package/dist/serialization/resources/credits/client/requests/index.d.ts +2 -0
  388. package/dist/serialization/resources/credits/types/AcquireCreditLeaseResponse.d.ts +11 -0
  389. package/dist/serialization/resources/credits/types/CountBillingPlanCreditGrantsParams.d.ts +1 -0
  390. package/dist/serialization/resources/credits/types/ExtendCreditLeaseResponse.d.ts +11 -0
  391. package/dist/serialization/resources/credits/types/GetSingleBillingPlanCreditGrantResponse.d.ts +11 -0
  392. package/dist/serialization/resources/credits/types/ListBillingPlanCreditGrantsParams.d.ts +1 -0
  393. package/dist/serialization/resources/credits/types/ListCompanyCreditBalancesParams.d.ts +9 -0
  394. package/dist/serialization/resources/credits/types/ListCompanyCreditBalancesResponse.d.ts +12 -0
  395. package/dist/serialization/resources/credits/types/ReleaseCreditLeaseResponse.d.ts +11 -0
  396. package/dist/serialization/resources/credits/types/index.d.ts +6 -0
  397. package/dist/serialization/resources/entitlements/client/requests/CreateBillingLinkedPlanEntitlementRequestBody.d.ts +51 -0
  398. package/dist/serialization/resources/entitlements/client/requests/CreateCompanyOverrideRequestBody.d.ts +4 -4
  399. package/dist/serialization/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +11 -4
  400. package/dist/serialization/resources/entitlements/client/requests/UpdateCompanyOverrideRequestBody.d.ts +4 -4
  401. package/dist/serialization/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts +11 -4
  402. package/dist/serialization/resources/entitlements/client/requests/index.d.ts +1 -0
  403. package/dist/serialization/resources/entitlements/types/CountFeatureUsageParams.d.ts +2 -0
  404. package/dist/serialization/resources/entitlements/types/ListFeatureUsageParams.d.ts +2 -0
  405. package/dist/serialization/resources/entitlements/types/UpsertPlanEntitlementForBillingProductResponse.d.ts +11 -0
  406. package/dist/serialization/resources/entitlements/types/index.d.ts +1 -8
  407. package/dist/serialization/resources/events/types/ListEventsParams.d.ts +1 -0
  408. package/dist/serialization/resources/features/client/requests/CreateBillingLinkedFeatureRequestBody.d.ts +25 -0
  409. package/dist/serialization/resources/features/client/requests/CreateFeatureRequestBody.d.ts +1 -1
  410. package/dist/serialization/resources/features/client/requests/UpdateFeatureRequestBody.d.ts +1 -1
  411. package/dist/serialization/resources/features/client/requests/index.d.ts +1 -0
  412. package/dist/serialization/resources/features/types/CountFeaturesParams.d.ts +2 -0
  413. package/dist/serialization/resources/features/types/ListFeaturesParams.d.ts +2 -0
  414. package/dist/serialization/resources/features/types/UpsertFeatureForBillingProductResponse.d.ts +11 -0
  415. package/dist/serialization/resources/features/types/index.d.ts +1 -0
  416. package/dist/serialization/resources/index.d.ts +6 -0
  417. package/dist/serialization/resources/insights/index.d.ts +1 -0
  418. package/dist/serialization/resources/insights/types/GetActivityParams.d.ts +9 -0
  419. package/dist/serialization/resources/insights/types/GetActivityResponse.d.ts +12 -0
  420. package/dist/serialization/resources/insights/types/GetEnvironmentFeatureUsageTimeSeriesParams.d.ts +13 -0
  421. package/dist/serialization/resources/insights/types/GetEnvironmentFeatureUsageTimeSeriesResponse.d.ts +12 -0
  422. package/dist/serialization/resources/insights/types/GetEnvironmentTraitUsageTimeSeriesParams.d.ts +13 -0
  423. package/dist/serialization/resources/insights/types/GetEnvironmentTraitUsageTimeSeriesResponse.d.ts +12 -0
  424. package/dist/serialization/resources/insights/types/GetPlanGrowthParams.d.ts +9 -0
  425. package/dist/serialization/resources/insights/types/GetPlanGrowthResponse.d.ts +12 -0
  426. package/dist/serialization/resources/insights/types/GetSummaryResponse.d.ts +11 -0
  427. package/dist/serialization/resources/insights/types/GetTopFeaturesByUsageParams.d.ts +11 -0
  428. package/dist/serialization/resources/insights/types/GetTopFeaturesByUsageResponse.d.ts +12 -0
  429. package/dist/serialization/resources/insights/types/index.d.ts +11 -0
  430. package/dist/serialization/resources/integrationsapi/client/index.d.ts +1 -0
  431. package/dist/serialization/resources/integrationsapi/client/requests/StartDataImportRequestBody.d.ts +12 -0
  432. package/dist/serialization/resources/integrationsapi/client/requests/index.d.ts +1 -0
  433. package/dist/serialization/resources/integrationsapi/index.d.ts +2 -0
  434. package/dist/serialization/resources/integrationsapi/types/GetIntegrationWebhookUrlResponse.d.ts +11 -0
  435. package/dist/serialization/resources/integrationsapi/types/ListIntegrationsParams.d.ts +17 -0
  436. package/dist/serialization/resources/integrationsapi/types/ListIntegrationsResponse.d.ts +12 -0
  437. package/dist/serialization/resources/integrationsapi/types/LoadSampleDataSetV2Response.d.ts +11 -0
  438. package/dist/serialization/resources/integrationsapi/types/RunIntegrationResponse.d.ts +11 -0
  439. package/dist/serialization/resources/integrationsapi/types/StartDataImportResponse.d.ts +11 -0
  440. package/dist/serialization/resources/{companies/types/DeletePlanTraitResponse.d.ts → integrationsapi/types/UninstallIntegrationResponse.d.ts} +2 -2
  441. package/dist/serialization/resources/integrationsapi/types/index.d.ts +7 -0
  442. package/dist/serialization/resources/planbundle/client/requests/CreateCustomPlanBundleRequestBody.d.ts +14 -0
  443. package/dist/serialization/resources/planbundle/client/requests/index.d.ts +1 -0
  444. package/dist/serialization/resources/planbundle/types/CreateCustomPlanBundleResponse.d.ts +11 -0
  445. package/dist/serialization/resources/planbundle/types/index.d.ts +1 -0
  446. package/dist/serialization/resources/planmigrations/client/index.d.ts +1 -0
  447. package/dist/serialization/resources/planmigrations/client/requests/CreateMigrationInput.d.ts +17 -0
  448. package/dist/serialization/resources/planmigrations/client/requests/RetryMigrationRequestBody.d.ts +10 -0
  449. package/dist/serialization/resources/planmigrations/client/requests/index.d.ts +2 -0
  450. package/dist/serialization/resources/planmigrations/index.d.ts +1 -0
  451. package/dist/serialization/resources/planmigrations/types/CreateMigrationResponse.d.ts +11 -0
  452. package/dist/serialization/resources/planmigrations/types/RetryCompanyMigrationResponse.d.ts +11 -0
  453. package/dist/serialization/resources/planmigrations/types/RetryMigrationResponse.d.ts +11 -0
  454. package/dist/serialization/resources/planmigrations/types/index.d.ts +3 -0
  455. package/dist/serialization/resources/plans/client/requests/CreateBillingLinkedPlanRequestBody.d.ts +18 -0
  456. package/dist/serialization/resources/plans/client/requests/CreateCustomPlanRequestBody.d.ts +14 -0
  457. package/dist/serialization/resources/plans/client/requests/PublishPlanVersionRequestBody.d.ts +6 -0
  458. package/dist/serialization/resources/plans/client/requests/RetryCustomPlanBillingRequestBody.d.ts +14 -0
  459. package/dist/serialization/resources/plans/client/requests/index.d.ts +3 -0
  460. package/dist/serialization/resources/plans/types/CountBillingProductMatchCompaniesParams.d.ts +12 -0
  461. package/dist/serialization/resources/plans/types/CountBillingProductMatchCompaniesResponse.d.ts +12 -0
  462. package/dist/serialization/resources/plans/types/CountPlansParams.d.ts +4 -0
  463. package/dist/serialization/resources/plans/types/CreateCustomPlanResponse.d.ts +11 -0
  464. package/dist/serialization/resources/plans/types/DeletePlanVersionParams.d.ts +9 -0
  465. package/dist/serialization/resources/plans/types/DeletePlanVersionResponse.d.ts +2 -1
  466. package/dist/serialization/resources/plans/types/ListBillingProductMatchCompaniesParams.d.ts +12 -0
  467. package/dist/serialization/resources/plans/types/ListBillingProductMatchCompaniesResponse.d.ts +12 -0
  468. package/dist/serialization/resources/plans/types/ListCustomPlanBillingsParams.d.ts +15 -0
  469. package/dist/serialization/resources/plans/types/ListCustomPlanBillingsResponse.d.ts +12 -0
  470. package/dist/serialization/resources/plans/types/ListPlansParams.d.ts +4 -0
  471. package/dist/serialization/resources/plans/types/MarkCustomPlanBillingPaidResponse.d.ts +11 -0
  472. package/dist/serialization/resources/plans/types/RetryCustomPlanBillingResponse.d.ts +11 -0
  473. package/dist/serialization/resources/plans/types/UpsertPlanForBillingProductResponse.d.ts +11 -0
  474. package/dist/serialization/resources/plans/types/index.d.ts +11 -0
  475. package/dist/serialization/types/AccountMemberPermission.d.ts +7 -0
  476. package/dist/serialization/types/AccountMemberResponseData.d.ts +18 -0
  477. package/dist/serialization/types/AccountMemberRole.d.ts +7 -0
  478. package/dist/serialization/types/ActivityEntryResponseData.d.ts +14 -0
  479. package/dist/serialization/types/ActivityResponseResponseData.d.ts +10 -0
  480. package/dist/serialization/types/ApiKeyCreateResponseData.d.ts +4 -0
  481. package/dist/serialization/types/ApiKeyIntegrationResponseData.d.ts +13 -0
  482. package/dist/serialization/types/ApiKeyResponseData.d.ts +4 -0
  483. package/dist/serialization/types/AuditLogListResponseData.d.ts +4 -0
  484. package/dist/serialization/types/AuditLogResponseData.d.ts +4 -0
  485. package/dist/serialization/types/BillingCreditBundleResponseData.d.ts +3 -0
  486. package/dist/serialization/types/BillingCreditBundleView.d.ts +2 -0
  487. package/dist/serialization/types/BillingCreditGrantReason.d.ts +1 -1
  488. package/dist/serialization/types/BillingCreditGrantResponseData.d.ts +1 -0
  489. package/dist/serialization/types/BillingCreditResponseData.d.ts +2 -0
  490. package/dist/serialization/types/BillingCreditView.d.ts +2 -0
  491. package/dist/serialization/types/BillingLinkedResourceResponseData.d.ts +12 -0
  492. package/dist/serialization/types/BillingPlanCreditGrantResponseData.d.ts +2 -0
  493. package/dist/serialization/types/BillingPriceResponseData.d.ts +2 -0
  494. package/dist/serialization/types/BillingPriceView.d.ts +2 -0
  495. package/dist/serialization/types/BillingProductForSubscriptionResponseData.d.ts +1 -0
  496. package/dist/serialization/types/BillingProductPlanResponseData.d.ts +4 -2
  497. package/dist/serialization/types/BillingProductPriceResponseData.d.ts +2 -0
  498. package/dist/serialization/types/BillingProviderType.d.ts +1 -1
  499. package/dist/serialization/types/BillingStrategy.d.ts +7 -0
  500. package/dist/serialization/types/ChangeSubscriptionInternalRequestBody.d.ts +2 -0
  501. package/dist/serialization/types/ChangeSubscriptionRequestBody.d.ts +2 -0
  502. package/dist/serialization/types/ChargeType.d.ts +1 -1
  503. package/dist/serialization/types/CheckFlagResponseData.d.ts +4 -2
  504. package/dist/serialization/types/CheckoutSubscription.d.ts +2 -0
  505. package/dist/serialization/types/ClerkIntegrationConfig.d.ts +10 -0
  506. package/dist/serialization/types/CompanyCreditBalanceResponseData.d.ts +13 -0
  507. package/dist/serialization/types/CompanyDetailResponseData.d.ts +2 -0
  508. package/dist/serialization/types/CompanyEventPeriodMetricsResponseData.d.ts +4 -2
  509. package/dist/serialization/types/CompanyMatchingCriteria.d.ts +7 -0
  510. package/dist/serialization/types/CompanyOverrideResponseData.d.ts +4 -2
  511. package/dist/serialization/types/CompanyPlanCreditGrantView.d.ts +47 -0
  512. package/dist/serialization/types/CompanyPlanDetailResponseData.d.ts +19 -6
  513. package/dist/serialization/types/CompanyPlanWithBillingSubView.d.ts +2 -2
  514. package/dist/serialization/types/CompanySubscriptionResponseData.d.ts +2 -0
  515. package/dist/serialization/types/ComparableOperator.d.ts +7 -0
  516. package/dist/serialization/types/Condition.d.ts +8 -8
  517. package/dist/serialization/types/ConditionResponseData.d.ts +8 -4
  518. package/dist/serialization/types/{ConditionConditionType.d.ts → ConditionType.d.ts} +2 -2
  519. package/dist/serialization/types/ConditionView.d.ts +8 -4
  520. package/dist/serialization/types/CreateBillingPlanCreditGrantRequestBody.d.ts +2 -0
  521. package/dist/serialization/types/CreateCustomPlanBundlePlanRequestBody.d.ts +13 -0
  522. package/dist/serialization/types/CreateEntitlementInBundleRequestBody.d.ts +11 -4
  523. package/dist/serialization/types/CreateEntitlementReqCommon.d.ts +4 -4
  524. package/dist/serialization/types/CreateEventRequestBody.d.ts +3 -0
  525. package/dist/serialization/types/CreateFlagRequestBody.d.ts +1 -1
  526. package/dist/serialization/types/CreateOrUpdateConditionRequestBody.d.ts +8 -8
  527. package/dist/serialization/types/CreateOrUpdateFlagRequestBody.d.ts +1 -1
  528. package/dist/serialization/types/CreateOrUpdateRuleRequestBody.d.ts +2 -2
  529. package/dist/serialization/types/CreatePlanRequestBody.d.ts +2 -1
  530. package/dist/serialization/types/CreditBundleCurrencyPrice.d.ts +11 -0
  531. package/dist/serialization/types/CreditBundleCurrencyPriceRequestBody.d.ts +11 -0
  532. package/dist/serialization/types/CreditBundleCurrencyPriceResponseData.d.ts +11 -0
  533. package/dist/serialization/types/CreditCompanyGrantView.d.ts +1 -0
  534. package/dist/serialization/types/CreditCurrencyPrice.d.ts +11 -0
  535. package/dist/serialization/types/CreditCurrencyPriceRequestBody.d.ts +11 -0
  536. package/dist/serialization/types/CreditCurrencyPriceResponseData.d.ts +11 -0
  537. package/dist/serialization/types/CreditLeaseResponseData.d.ts +16 -0
  538. package/dist/serialization/types/CurrencyPriceRequestBody.d.ts +19 -0
  539. package/dist/serialization/types/CustomPlanActivationStrategy.d.ts +7 -0
  540. package/dist/serialization/types/CustomPlanBillingResponseData.d.ts +22 -0
  541. package/dist/serialization/types/CustomPlanBillingStatus.d.ts +7 -0
  542. package/dist/serialization/types/DataEventPayload.d.ts +3 -0
  543. package/dist/serialization/types/DatastreamCompanyPlan.d.ts +2 -0
  544. package/dist/serialization/types/DuplicatePlanEntitlementsResponseResponseData.d.ts +2 -0
  545. package/dist/serialization/types/EntitlementCurrencyPricesResponseData.d.ts +13 -0
  546. package/dist/serialization/types/EnvironmentFeatureUsageTimeSeriesResponseData.d.ts +12 -0
  547. package/dist/serialization/types/EnvironmentTraitUsageTimeSeriesResponseData.d.ts +12 -0
  548. package/dist/serialization/types/EnvironmentUsagePointResponseData.d.ts +10 -0
  549. package/dist/serialization/types/EventBodyTrack.d.ts +1 -0
  550. package/dist/serialization/types/EventDetailResponseData.d.ts +3 -0
  551. package/dist/serialization/types/EventResponseData.d.ts +1 -0
  552. package/dist/serialization/types/FeatureCompanyResponseData.d.ts +7 -4
  553. package/dist/serialization/types/FeatureCompanyUserResponseData.d.ts +4 -2
  554. package/dist/serialization/types/FeatureDetailResponseData.d.ts +5 -1
  555. package/dist/serialization/types/FeatureEntitlement.d.ts +4 -4
  556. package/dist/serialization/types/FeatureInPlanResponseData.d.ts +33 -0
  557. package/dist/serialization/types/FeatureResponseData.d.ts +1 -1
  558. package/dist/serialization/types/FeatureUsageResponseData.d.ts +7 -4
  559. package/dist/serialization/types/FeatureView.d.ts +3 -1
  560. package/dist/serialization/types/FlagDetailResponseData.d.ts +3 -1
  561. package/dist/serialization/types/FlagInPlanResponseData.d.ts +24 -0
  562. package/dist/serialization/types/FlagResponseData.d.ts +1 -1
  563. package/dist/serialization/types/FlagView.d.ts +0 -1
  564. package/dist/serialization/types/InsightsSummaryResponseData.d.ts +15 -0
  565. package/dist/serialization/types/IntegrationCapabilities.d.ts +11 -0
  566. package/dist/serialization/types/IntegrationConfig.d.ts +23 -0
  567. package/dist/serialization/types/IntegrationResponseData.d.ts +15 -0
  568. package/dist/serialization/types/IntegrationState.d.ts +7 -0
  569. package/dist/serialization/types/IntegrationType.d.ts +7 -0
  570. package/dist/serialization/types/IntegrationWebhookUrlResponseData.d.ts +11 -0
  571. package/dist/serialization/types/IntegrationsDataSetResponseData.d.ts +9 -0
  572. package/dist/serialization/types/IntegrationsListResponseData.d.ts +19 -0
  573. package/dist/serialization/types/IntegrationsResponseData.d.ts +15 -0
  574. package/dist/serialization/types/MarkCustomPlanBillingPaidRequestBody.d.ts +7 -0
  575. package/dist/serialization/types/{ConditionMetricPeriod.d.ts → MetricPeriod.d.ts} +2 -2
  576. package/dist/serialization/types/MetricPeriodMonthReset.d.ts +7 -0
  577. package/dist/serialization/types/MigrationErrorCode.d.ts +7 -0
  578. package/dist/serialization/types/MrrResponseData.d.ts +10 -0
  579. package/dist/serialization/types/OrbIntegrationConfig.d.ts +9 -0
  580. package/dist/serialization/types/PlanCreditGrantView.d.ts +2 -0
  581. package/dist/serialization/types/PlanCurrencyPriceRequestBody.d.ts +13 -0
  582. package/dist/serialization/types/PlanCurrencyPricesResponseData.d.ts +14 -0
  583. package/dist/serialization/types/PlanDetailResponseData.d.ts +18 -5
  584. package/dist/serialization/types/PlanEntitlementResponseData.d.ts +10 -2
  585. package/dist/serialization/types/PlanGroupPlanDetailResponseData.d.ts +19 -6
  586. package/dist/serialization/types/PlanGrowthPointResponseData.d.ts +12 -0
  587. package/dist/serialization/types/PlanGrowthResponseData.d.ts +10 -0
  588. package/dist/serialization/types/PlanIcon.d.ts +7 -0
  589. package/dist/serialization/types/PlanPriceCadence.d.ts +7 -0
  590. package/dist/serialization/types/PlanResponseData.d.ts +4 -1
  591. package/dist/serialization/types/PlanVersionCompanyMigrationResponseData.d.ts +2 -0
  592. package/dist/serialization/types/PlanVersionMigrationResponseData.d.ts +1 -0
  593. package/dist/serialization/types/PlanVersionResponseData.d.ts +2 -1
  594. package/dist/serialization/types/PlanViewPublicResponseData.d.ts +19 -6
  595. package/dist/serialization/types/ReleaseCreditLeaseRequestBody.d.ts +7 -0
  596. package/dist/serialization/types/Rule.d.ts +2 -2
  597. package/dist/serialization/types/RuleConditionDetailResponseData.d.ts +8 -4
  598. package/dist/serialization/types/RuleConditionResponseData.d.ts +8 -4
  599. package/dist/serialization/types/RuleDetailResponseData.d.ts +2 -1
  600. package/dist/serialization/types/RuleResponseData.d.ts +2 -1
  601. package/dist/serialization/types/RuleType.d.ts +7 -0
  602. package/dist/serialization/types/RuleView.d.ts +2 -1
  603. package/dist/serialization/types/RulesEngineSchemaVersion.d.ts +1 -1
  604. package/dist/serialization/types/RulesengineCheckFlagResult.d.ts +4 -4
  605. package/dist/serialization/types/RulesengineCompanyMetric.d.ts +4 -4
  606. package/dist/serialization/types/RulesengineCondition.d.ts +8 -8
  607. package/dist/serialization/types/{RulesengineConditionConditionType.d.ts → RulesengineConditionType.d.ts} +2 -2
  608. package/dist/serialization/types/RulesengineFeatureEntitlement.d.ts +4 -4
  609. package/dist/serialization/types/RulesengineMetricPeriod.d.ts +7 -0
  610. package/dist/serialization/types/RulesengineMetricPeriodMonthReset.d.ts +7 -0
  611. package/dist/serialization/types/RulesengineRule.d.ts +2 -2
  612. package/dist/serialization/types/RulesengineRuleType.d.ts +7 -0
  613. package/dist/serialization/types/StripeIntegrationConfig.d.ts +14 -0
  614. package/dist/serialization/types/TopFeatureByUsageResponseData.d.ts +14 -0
  615. package/dist/serialization/types/TopFeaturesByUsageResponseData.d.ts +10 -0
  616. package/dist/serialization/types/TrialStatus.d.ts +7 -0
  617. package/dist/serialization/types/UpdateAutoTopupOverrideRequestBody.d.ts +12 -0
  618. package/dist/serialization/types/UpdateBillingPlanCreditGrantRequestBody.d.ts +2 -0
  619. package/dist/serialization/types/UpdateEntitlementReqCommon.d.ts +4 -4
  620. package/dist/serialization/types/UpdatePlanRequestBody.d.ts +2 -1
  621. package/dist/serialization/types/UpsertBillingProductRequestBody.d.ts +6 -0
  622. package/dist/serialization/types/UsageBasedEntitlementRequestBody.d.ts +7 -0
  623. package/dist/serialization/types/UsageBasedEntitlementResponseData.d.ts +6 -2
  624. package/dist/serialization/types/WebhookUrl.d.ts +11 -0
  625. package/dist/serialization/types/WorkOsIntegrationConfig.d.ts +10 -0
  626. package/dist/serialization/types/index.d.ts +67 -30
  627. package/dist/version.d.ts +2 -0
  628. package/dist/wasm/rulesengine.d.ts +1 -0
  629. package/dist/wasm/rulesengine.js +41 -9
  630. package/dist/wasm/rulesengine_bg.wasm +0 -0
  631. package/dist/wasm/rulesengine_bg.wasm.d.ts +1 -0
  632. package/dist/wrapper.d.ts +40 -5
  633. package/package.json +9 -9
  634. package/dist/api/resources/companies/client/requests/CreatePlanTraitRequestBody.d.ts +0 -13
  635. package/dist/api/resources/companies/client/requests/UpdatePlanTraitRequestBody.d.ts +0 -11
  636. package/dist/api/resources/entitlements/types/CreateCompanyOverrideRequestBodyMetricPeriod.d.ts +0 -7
  637. package/dist/api/resources/entitlements/types/CreateCompanyOverrideRequestBodyMetricPeriodMonthReset.d.ts +0 -5
  638. package/dist/api/resources/entitlements/types/CreatePlanEntitlementRequestBodyMetricPeriod.d.ts +0 -7
  639. package/dist/api/resources/entitlements/types/CreatePlanEntitlementRequestBodyMetricPeriodMonthReset.d.ts +0 -5
  640. package/dist/api/resources/entitlements/types/UpdateCompanyOverrideRequestBodyMetricPeriod.d.ts +0 -7
  641. package/dist/api/resources/entitlements/types/UpdateCompanyOverrideRequestBodyMetricPeriodMonthReset.d.ts +0 -5
  642. package/dist/api/resources/entitlements/types/UpdatePlanEntitlementRequestBodyMetricPeriod.d.ts +0 -7
  643. package/dist/api/resources/entitlements/types/UpdatePlanEntitlementRequestBodyMetricPeriodMonthReset.d.ts +0 -5
  644. package/dist/api/types/ConditionMetricPeriodMonthReset.d.ts +0 -5
  645. package/dist/api/types/CreateEntitlementInBundleRequestBodyMetricPeriod.d.ts +0 -7
  646. package/dist/api/types/CreateEntitlementInBundleRequestBodyMetricPeriodMonthReset.d.ts +0 -5
  647. package/dist/api/types/CreateEntitlementReqCommonMetricPeriod.d.ts +0 -7
  648. package/dist/api/types/CreateEntitlementReqCommonMetricPeriodMonthReset.d.ts +0 -5
  649. package/dist/api/types/CreateOrUpdateConditionRequestBodyConditionType.d.ts +0 -10
  650. package/dist/api/types/CreateOrUpdateConditionRequestBodyMetricPeriod.d.ts +0 -8
  651. package/dist/api/types/CreateOrUpdateConditionRequestBodyMetricPeriodMonthReset.d.ts +0 -6
  652. package/dist/api/types/CreateOrUpdateConditionRequestBodyOperator.d.ts +0 -11
  653. package/dist/api/types/CreateOrUpdateRuleRequestBodyRuleType.d.ts +0 -8
  654. package/dist/api/types/FeatureEntitlementMetricPeriod.d.ts +0 -8
  655. package/dist/api/types/FeatureEntitlementMonthReset.d.ts +0 -6
  656. package/dist/api/types/PlanControlledByType.d.ts +0 -5
  657. package/dist/api/types/RulesengineCheckFlagResultFeatureUsagePeriod.d.ts +0 -7
  658. package/dist/api/types/RulesengineCheckFlagResultRuleType.d.ts +0 -10
  659. package/dist/api/types/RulesengineCompanyMetricMonthReset.d.ts +0 -5
  660. package/dist/api/types/RulesengineCompanyMetricPeriod.d.ts +0 -7
  661. package/dist/api/types/RulesengineConditionMetricPeriod.d.ts +0 -7
  662. package/dist/api/types/RulesengineConditionMetricPeriodMonthReset.d.ts +0 -5
  663. package/dist/api/types/RulesengineConditionOperator.d.ts +0 -11
  664. package/dist/api/types/RulesengineFeatureEntitlementMetricPeriod.d.ts +0 -8
  665. package/dist/api/types/RulesengineFeatureEntitlementMonthReset.d.ts +0 -6
  666. package/dist/api/types/UpdateEntitlementReqCommonMetricPeriod.d.ts +0 -7
  667. package/dist/api/types/UpdateEntitlementReqCommonMetricPeriodMonthReset.d.ts +0 -5
  668. package/dist/serialization/resources/companies/client/requests/CreatePlanTraitRequestBody.d.ts +0 -11
  669. package/dist/serialization/resources/companies/client/requests/UpdatePlanTraitRequestBody.d.ts +0 -10
  670. package/dist/serialization/resources/companies/types/CreatePlanTraitResponse.d.ts +0 -11
  671. package/dist/serialization/resources/companies/types/UpdatePlanTraitResponse.d.ts +0 -11
  672. package/dist/serialization/resources/entitlements/types/CreateCompanyOverrideRequestBodyMetricPeriod.d.ts +0 -7
  673. package/dist/serialization/resources/entitlements/types/CreateCompanyOverrideRequestBodyMetricPeriodMonthReset.d.ts +0 -7
  674. package/dist/serialization/resources/entitlements/types/CreatePlanEntitlementRequestBodyMetricPeriod.d.ts +0 -7
  675. package/dist/serialization/resources/entitlements/types/CreatePlanEntitlementRequestBodyMetricPeriodMonthReset.d.ts +0 -7
  676. package/dist/serialization/resources/entitlements/types/UpdateCompanyOverrideRequestBodyMetricPeriod.d.ts +0 -7
  677. package/dist/serialization/resources/entitlements/types/UpdateCompanyOverrideRequestBodyMetricPeriodMonthReset.d.ts +0 -7
  678. package/dist/serialization/resources/entitlements/types/UpdatePlanEntitlementRequestBodyMetricPeriod.d.ts +0 -7
  679. package/dist/serialization/resources/entitlements/types/UpdatePlanEntitlementRequestBodyMetricPeriodMonthReset.d.ts +0 -7
  680. package/dist/serialization/types/ConditionMetricPeriodMonthReset.d.ts +0 -7
  681. package/dist/serialization/types/ConditionOperator.d.ts +0 -7
  682. package/dist/serialization/types/CreateEntitlementInBundleRequestBodyMetricPeriod.d.ts +0 -7
  683. package/dist/serialization/types/CreateEntitlementInBundleRequestBodyMetricPeriodMonthReset.d.ts +0 -7
  684. package/dist/serialization/types/CreateEntitlementReqCommonMetricPeriod.d.ts +0 -7
  685. package/dist/serialization/types/CreateEntitlementReqCommonMetricPeriodMonthReset.d.ts +0 -7
  686. package/dist/serialization/types/CreateOrUpdateConditionRequestBodyConditionType.d.ts +0 -7
  687. package/dist/serialization/types/CreateOrUpdateConditionRequestBodyMetricPeriod.d.ts +0 -7
  688. package/dist/serialization/types/CreateOrUpdateConditionRequestBodyMetricPeriodMonthReset.d.ts +0 -7
  689. package/dist/serialization/types/CreateOrUpdateConditionRequestBodyOperator.d.ts +0 -7
  690. package/dist/serialization/types/CreateOrUpdateRuleRequestBodyRuleType.d.ts +0 -7
  691. package/dist/serialization/types/FeatureEntitlementMetricPeriod.d.ts +0 -7
  692. package/dist/serialization/types/FeatureEntitlementMonthReset.d.ts +0 -7
  693. package/dist/serialization/types/PlanControlledByType.d.ts +0 -7
  694. package/dist/serialization/types/RuleRuleType.d.ts +0 -7
  695. package/dist/serialization/types/RulesengineCheckFlagResultFeatureUsagePeriod.d.ts +0 -7
  696. package/dist/serialization/types/RulesengineCheckFlagResultRuleType.d.ts +0 -7
  697. package/dist/serialization/types/RulesengineCompanyMetricMonthReset.d.ts +0 -7
  698. package/dist/serialization/types/RulesengineCompanyMetricPeriod.d.ts +0 -7
  699. package/dist/serialization/types/RulesengineConditionMetricPeriod.d.ts +0 -7
  700. package/dist/serialization/types/RulesengineConditionMetricPeriodMonthReset.d.ts +0 -7
  701. package/dist/serialization/types/RulesengineConditionOperator.d.ts +0 -7
  702. package/dist/serialization/types/RulesengineFeatureEntitlementMetricPeriod.d.ts +0 -7
  703. package/dist/serialization/types/RulesengineFeatureEntitlementMonthReset.d.ts +0 -7
  704. package/dist/serialization/types/RulesengineRuleRuleType.d.ts +0 -7
  705. package/dist/serialization/types/UpdateEntitlementReqCommonMetricPeriod.d.ts +0 -7
  706. package/dist/serialization/types/UpdateEntitlementReqCommonMetricPeriodMonthReset.d.ts +0 -7
@@ -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). */
@@ -1,6 +1,7 @@
1
1
  import type * as Schematic from "../index";
2
2
  export interface FeatureView {
3
3
  accountId: string;
4
+ billingLinkedResource?: Schematic.BillingLinkedResourceResponseData;
4
5
  createdAt: Date;
5
6
  description: string;
6
7
  eventSubtype?: string;
@@ -10,7 +11,6 @@ export interface FeatureView {
10
11
  icon: string;
11
12
  id: string;
12
13
  lifecyclePhase?: Schematic.FeatureLifecyclePhase;
13
- maintainerId?: string;
14
14
  name: string;
15
15
  plans: Schematic.PreviewObject[];
16
16
  pluralName?: string;
@@ -18,4 +18,5 @@ export interface FeatureView {
18
18
  trait?: Schematic.EntityTraitDefinitionResponseData;
19
19
  traitId?: string;
20
20
  updatedAt: Date;
21
+ usageLimitTraitId?: string;
21
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,5 @@
1
+ export interface IntegrationCapabilities {
2
+ authorPlans: boolean;
3
+ checkout: boolean;
4
+ editBilling: boolean;
5
+ }
@@ -0,0 +1,16 @@
1
+ import type * as Schematic from "../index";
2
+ export type IntegrationConfig = Schematic.IntegrationConfig.Clerk | 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 Orb extends Schematic.OrbIntegrationConfig {
8
+ type: "orb";
9
+ }
10
+ interface Stripe extends Schematic.StripeIntegrationConfig {
11
+ type: "stripe";
12
+ }
13
+ interface Workos extends Schematic.WorkOsIntegrationConfig {
14
+ type: "workos";
15
+ }
16
+ }
@@ -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
+ }
@@ -0,0 +1,6 @@
1
+ export declare const IntegrationState: {
2
+ readonly Active: "active";
3
+ readonly Created: "created";
4
+ readonly Pending: "pending";
5
+ };
6
+ export type IntegrationState = (typeof IntegrationState)[keyof typeof IntegrationState];
@@ -0,0 +1,8 @@
1
+ export declare const IntegrationType: {
2
+ readonly Clerk: "clerk";
3
+ readonly Orb: "orb";
4
+ readonly Stripe: "stripe";
5
+ readonly Unknown: "unknown";
6
+ readonly Workos: "workos";
7
+ };
8
+ export type IntegrationType = (typeof IntegrationType)[keyof typeof IntegrationType];
@@ -0,0 +1,5 @@
1
+ import type * as Schematic from "../index";
2
+ export interface IntegrationWebhookUrlResponseData {
3
+ type: Schematic.IntegrationType;
4
+ url: string;
5
+ }
@@ -0,0 +1,3 @@
1
+ export interface IntegrationsDataSetResponseData {
2
+ keys: string[];
3
+ }
@@ -0,0 +1,10 @@
1
+ import type * as Schematic from "../index";
2
+ export interface IntegrationsListResponseData {
3
+ capabilities: Schematic.IntegrationCapabilities;
4
+ config?: Schematic.IntegrationConfig;
5
+ id: string;
6
+ isAppInstall: boolean;
7
+ isConnectInstall: boolean;
8
+ state: Schematic.IntegrationState;
9
+ type: Schematic.IntegrationType;
10
+ }
@@ -0,0 +1,8 @@
1
+ import type * as Schematic from "../index";
2
+ export interface IntegrationsResponseData {
3
+ createdAt: Date;
4
+ id: string;
5
+ state: Schematic.IntegrationState;
6
+ type: Schematic.IntegrationType;
7
+ updatedAt: Date;
8
+ }
@@ -0,0 +1 @@
1
+ export type MarkCustomPlanBillingPaidRequestBody = Record<string, unknown>;
@@ -1,7 +1,7 @@
1
- export declare const ConditionMetricPeriod: {
1
+ export declare const MetricPeriod: {
2
2
  readonly AllTime: "all_time";
3
3
  readonly CurrentDay: "current_day";
4
4
  readonly CurrentMonth: "current_month";
5
5
  readonly CurrentWeek: "current_week";
6
6
  };
7
- export type ConditionMetricPeriod = (typeof ConditionMetricPeriod)[keyof typeof ConditionMetricPeriod];
7
+ export type MetricPeriod = (typeof MetricPeriod)[keyof typeof MetricPeriod];
@@ -0,0 +1,5 @@
1
+ export declare const MetricPeriodMonthReset: {
2
+ readonly BillingCycle: "billing_cycle";
3
+ readonly FirstOfMonth: "first_of_month";
4
+ };
5
+ export type MetricPeriodMonthReset = (typeof MetricPeriodMonthReset)[keyof typeof MetricPeriodMonthReset];
@@ -0,0 +1,14 @@
1
+ export declare const MigrationErrorCode: {
2
+ readonly AmbiguousSubscriptionItem: "ambiguous_subscription_item";
3
+ readonly MultipleSubscriptions: "multiple_subscriptions";
4
+ readonly NoPriceForInterval: "no_price_for_interval";
5
+ readonly NotOnOriginVersion: "not_on_origin_version";
6
+ readonly PermanentConfig: "permanent_config";
7
+ readonly PermanentDecline: "permanent_decline";
8
+ readonly TransientDecline: "transient_decline";
9
+ readonly TransientInfra: "transient_infra";
10
+ readonly TransientStripe: "transient_stripe";
11
+ readonly Unknown: "unknown";
12
+ readonly WouldLeaveEmptySubscription: "would_leave_empty_subscription";
13
+ };
14
+ export type MigrationErrorCode = (typeof MigrationErrorCode)[keyof typeof MigrationErrorCode];
@@ -0,0 +1,4 @@
1
+ export interface MrrResponseData {
2
+ amount: number;
3
+ currency: string;
4
+ }
@@ -0,0 +1,4 @@
1
+ export interface OrbIntegrationConfig {
2
+ /** Schematic company key used to store Orb's external_customer_id; when unset, defaults to orb_external_customer_id */
3
+ externalCustomerIdKey?: string;
4
+ }
@@ -6,6 +6,8 @@ export interface PlanCreditGrantView {
6
6
  billingCreditAutoTopupExpiryType?: Schematic.BillingCreditExpiryType;
7
7
  billingCreditAutoTopupExpiryUnit?: Schematic.BillingCreditExpiryUnit;
8
8
  billingCreditAutoTopupExpiryUnitCount?: number;
9
+ billingCreditAutoTopupSelfService: boolean;
10
+ billingCreditAutoTopupThresholdCredits?: number;
9
11
  billingCreditAutoTopupThresholdPercent?: number;
10
12
  createdAt: Date;
11
13
  credit?: Schematic.BillingCreditView;
@@ -0,0 +1,7 @@
1
+ export interface PlanCurrencyPriceRequestBody {
2
+ currency: string;
3
+ monthlyPrice?: number;
4
+ oneTimePrice?: number;
5
+ quarterlyPrice?: number;
6
+ yearlyPrice?: number;
7
+ }
@@ -0,0 +1,8 @@
1
+ import type * as Schematic from "../index";
2
+ export interface PlanCurrencyPricesResponseData {
3
+ currency: string;
4
+ monthlyPrice?: Schematic.BillingPriceResponseData;
5
+ oneTimePrice?: Schematic.BillingPriceResponseData;
6
+ quarterlyPrice?: Schematic.BillingPriceResponseData;
7
+ yearlyPrice?: Schematic.BillingPriceResponseData;
8
+ }
@@ -2,24 +2,33 @@ import type * as Schematic from "../index";
2
2
  export interface PlanDetailResponseData {
3
3
  activeVersion?: Schematic.PlanVersionResponseData;
4
4
  audienceType?: string;
5
+ billingLinkedResource?: Schematic.BillingLinkedResourceResponseData;
5
6
  billingProduct?: Schematic.BillingProductDetailResponseData;
7
+ billingStrategy: Schematic.BillingStrategy;
6
8
  chargeType: Schematic.ChargeType;
7
9
  companyCount: number;
8
- controlledBy: Schematic.PlanControlledByType;
10
+ companyId?: string;
11
+ companyName?: string;
12
+ controlledBy: Schematic.BillingProviderType;
13
+ copiedFromPlanId?: string;
9
14
  createdAt: Date;
15
+ currencyPrices: Schematic.PlanCurrencyPricesResponseData[];
10
16
  description: string;
11
17
  draftVersion?: Schematic.PlanVersionResponseData;
12
- features: Schematic.FeatureDetailResponseData[];
13
- icon: string;
18
+ entitlements?: Schematic.PlanEntitlementResponseData[];
19
+ features: Schematic.FeatureInPlanResponseData[];
20
+ icon: Schematic.PlanIcon;
14
21
  id: string;
15
22
  includedCreditGrants?: Schematic.BillingPlanCreditGrantResponseData[];
16
23
  isDefault: boolean;
24
+ /** Deprecated: Use BillingStrategy instead */
17
25
  isFree: boolean;
18
26
  isTrialable: boolean;
19
27
  monthlyPrice?: Schematic.BillingPriceResponseData;
20
28
  name: string;
21
29
  oneTimePrice?: Schematic.BillingPriceResponseData;
22
30
  planType: Schematic.PlanType;
31
+ quarterlyPrice?: Schematic.BillingPriceResponseData;
23
32
  trialDays?: number;
24
33
  updatedAt: Date;
25
34
  versions: Schematic.PlanVersionResponseData[];
@@ -1,16 +1,19 @@
1
1
  import type * as Schematic from "../index";
2
2
  export interface PlanEntitlementResponseData {
3
+ billingLinkedResource?: Schematic.BillingLinkedResourceResponseData;
3
4
  billingThreshold?: number;
4
5
  consumptionRate?: number;
5
6
  createdAt: Date;
7
+ currencyPrices: Schematic.EntitlementCurrencyPricesResponseData[];
6
8
  environmentId: string;
7
9
  feature?: Schematic.FeatureResponseData;
8
10
  featureId: string;
9
11
  id: string;
10
12
  meteredMonthlyPrice?: Schematic.BillingPriceView;
13
+ meteredQuarterlyPrice?: Schematic.BillingPriceView;
11
14
  meteredYearlyPrice?: Schematic.BillingPriceView;
12
- metricPeriod?: string;
13
- metricPeriodMonthReset?: string;
15
+ metricPeriod?: Schematic.MetricPeriod;
16
+ metricPeriodMonthReset?: Schematic.MetricPeriodMonthReset;
14
17
  plan?: Schematic.PlanResponseData;
15
18
  planId: string;
16
19
  priceBehavior?: Schematic.EntitlementPriceBehavior;
@@ -19,6 +22,8 @@ export interface PlanEntitlementResponseData {
19
22
  softLimit?: number;
20
23
  updatedAt: Date;
21
24
  usageBasedProduct?: Schematic.BillingProductResponseData;
25
+ /** 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. */
26
+ usageQuantity?: number;
22
27
  valueBool?: boolean;
23
28
  valueCredit?: Schematic.BillingCreditResponseData;
24
29
  valueNumeric?: number;
@@ -2,28 +2,37 @@ import type * as Schematic from "../index";
2
2
  export interface PlanGroupPlanDetailResponseData {
3
3
  activeVersion?: Schematic.PlanVersionResponseData;
4
4
  audienceType?: string;
5
+ availablePeriods: Schematic.PlanPriceCadence[];
6
+ billingLinkedResource?: Schematic.BillingLinkedResourceResponseData;
5
7
  billingProduct?: Schematic.BillingProductDetailResponseData;
8
+ billingStrategy: Schematic.BillingStrategy;
6
9
  chargeType: Schematic.ChargeType;
7
10
  companyCount: number;
11
+ companyId?: string;
12
+ companyName?: string;
8
13
  compatiblePlanIds: string[];
9
- controlledBy: Schematic.PlanControlledByType;
14
+ controlledBy: Schematic.BillingProviderType;
15
+ copiedFromPlanId?: string;
10
16
  createdAt: Date;
17
+ currencyPrices: Schematic.PlanCurrencyPricesResponseData[];
11
18
  customPlanConfig?: Schematic.CustomPlanViewConfigResponseData;
12
19
  description: string;
13
20
  draftVersion?: Schematic.PlanVersionResponseData;
14
- entitlements: Schematic.PlanEntitlementResponseData[];
15
- features: Schematic.FeatureDetailResponseData[];
16
- icon: string;
21
+ entitlements?: Schematic.PlanEntitlementResponseData[];
22
+ features: Schematic.FeatureInPlanResponseData[];
23
+ icon: Schematic.PlanIcon;
17
24
  id: string;
18
25
  includedCreditGrants?: Schematic.BillingPlanCreditGrantResponseData[];
19
26
  isCustom: boolean;
20
27
  isDefault: boolean;
28
+ /** Deprecated: Use BillingStrategy instead */
21
29
  isFree: boolean;
22
30
  isTrialable: boolean;
23
31
  monthlyPrice?: Schematic.BillingPriceResponseData;
24
32
  name: string;
25
33
  oneTimePrice?: Schematic.BillingPriceResponseData;
26
34
  planType: Schematic.PlanType;
35
+ quarterlyPrice?: Schematic.BillingPriceResponseData;
27
36
  trialDays?: number;
28
37
  updatedAt: Date;
29
38
  versions: Schematic.PlanVersionResponseData[];
@@ -0,0 +1,6 @@
1
+ export interface PlanGrowthPointResponseData {
2
+ month: Date;
3
+ planId: string;
4
+ planName: string;
5
+ subscribers: number;
6
+ }
@@ -0,0 +1,4 @@
1
+ import type * as Schematic from "../index";
2
+ export interface PlanGrowthResponseData {
3
+ points: Schematic.PlanGrowthPointResponseData[];
4
+ }
@@ -0,0 +1,28 @@
1
+ export declare const PlanIcon: {
2
+ readonly Amber: "amber";
3
+ readonly Blue: "blue";
4
+ readonly BlueGray: "blueGray";
5
+ readonly BlueGreen: "blueGreen";
6
+ readonly Cyan: "cyan";
7
+ readonly Emerald: "emerald";
8
+ readonly Fuchsia: "fuchsia";
9
+ readonly Gray: "gray";
10
+ readonly Green: "green";
11
+ readonly Indigo: "indigo";
12
+ readonly LightBlue: "lightBlue";
13
+ readonly Lime: "lime";
14
+ readonly Orange: "orange";
15
+ readonly Pink: "pink";
16
+ readonly Purple: "purple";
17
+ readonly Red: "red";
18
+ readonly RedOrange: "redOrange";
19
+ readonly Rose: "rose";
20
+ readonly Sky: "sky";
21
+ readonly Slate: "slate";
22
+ readonly Teal: "teal";
23
+ readonly TrueGray: "trueGray";
24
+ readonly Violet: "violet";
25
+ readonly WarmGray: "warmGray";
26
+ readonly Yellow: "yellow";
27
+ };
28
+ export type PlanIcon = (typeof PlanIcon)[keyof typeof PlanIcon];
@@ -0,0 +1,6 @@
1
+ export declare const PlanPriceCadence: {
2
+ readonly Monthly: "monthly";
3
+ readonly Quarterly: "quarterly";
4
+ readonly Yearly: "yearly";
5
+ };
6
+ export type PlanPriceCadence = (typeof PlanPriceCadence)[keyof typeof PlanPriceCadence];
@@ -1,9 +1,11 @@
1
1
  import type * as Schematic from "../index";
2
2
  export interface PlanResponseData {
3
3
  audienceType?: string;
4
+ companyId?: string;
5
+ copiedFromPlanId?: string;
4
6
  createdAt: Date;
5
7
  description: string;
6
- icon: string;
8
+ icon: Schematic.PlanIcon;
7
9
  id: string;
8
10
  name: string;
9
11
  planType: Schematic.PlanType;
@@ -5,6 +5,7 @@ export interface PlanVersionCompanyMigrationResponseData {
5
5
  completedAt?: Date;
6
6
  createdAt: Date;
7
7
  error?: string;
8
+ errorCode?: Schematic.MigrationErrorCode;
8
9
  id: string;
9
10
  migrationId: string;
10
11
  planVersionIdFrom?: string;
@@ -9,6 +9,7 @@ export interface PlanVersionMigrationResponseData {
9
9
  planId: string;
10
10
  planVersionIdFrom?: string;
11
11
  planVersionIdTo: string;
12
+ planVersionIdsFrom: string[];
12
13
  skippedCompanies: number;
13
14
  startedAt?: Date;
14
15
  status: Schematic.PlanVersionMigrationStatus;
@@ -3,7 +3,7 @@ export interface PlanVersionResponseData {
3
3
  createdAt: Date;
4
4
  description: string;
5
5
  environmentId: string;
6
- icon: string;
6
+ icon: Schematic.PlanIcon;
7
7
  id: string;
8
8
  name: string;
9
9
  originalPlanId?: string;
@@ -2,29 +2,38 @@ import type * as Schematic from "../index";
2
2
  export interface PlanViewPublicResponseData {
3
3
  activeVersion?: Schematic.PlanVersionResponseData;
4
4
  audienceType?: string;
5
+ availablePeriods: Schematic.PlanPriceCadence[];
6
+ billingLinkedResource?: Schematic.BillingLinkedResourceResponseData;
5
7
  billingProduct?: Schematic.BillingProductDetailResponseData;
8
+ billingStrategy: Schematic.BillingStrategy;
6
9
  chargeType: Schematic.ChargeType;
7
10
  companyCount: number;
11
+ companyId?: string;
12
+ companyName?: string;
8
13
  compatiblePlanIds: string[];
9
- controlledBy: Schematic.PlanControlledByType;
14
+ controlledBy: Schematic.BillingProviderType;
15
+ copiedFromPlanId?: string;
10
16
  createdAt: Date;
17
+ currencyPrices: Schematic.PlanCurrencyPricesResponseData[];
11
18
  custom: boolean;
12
19
  customPlanConfig?: Schematic.CustomPlanConfig;
13
20
  description: string;
14
21
  draftVersion?: Schematic.PlanVersionResponseData;
15
- entitlements: Schematic.PlanEntitlementResponseData[];
16
- features: Schematic.FeatureDetailResponseData[];
17
- icon: string;
22
+ entitlements?: Schematic.PlanEntitlementResponseData[];
23
+ features: Schematic.FeatureInPlanResponseData[];
24
+ icon: Schematic.PlanIcon;
18
25
  id: string;
19
26
  includedCreditGrants: Schematic.PlanCreditGrantView[];
20
27
  isCustom: boolean;
21
28
  isDefault: boolean;
29
+ /** Deprecated: Use BillingStrategy instead */
22
30
  isFree: boolean;
23
31
  isTrialable: boolean;
24
32
  monthlyPrice?: Schematic.BillingPriceResponseData;
25
33
  name: string;
26
34
  oneTimePrice?: Schematic.BillingPriceResponseData;
27
35
  planType: Schematic.PlanType;
36
+ quarterlyPrice?: Schematic.BillingPriceResponseData;
28
37
  trialDays?: number;
29
38
  updatedAt: Date;
30
39
  versions: Schematic.PlanVersionResponseData[];
@@ -0,0 +1 @@
1
+ export type ReleaseCreditLeaseRequestBody = Record<string, unknown>;
@@ -8,6 +8,6 @@ export interface Rule {
8
8
  id: string;
9
9
  name: string;
10
10
  priority: number;
11
- ruleType: Schematic.RuleRuleType;
11
+ ruleType: Schematic.RuleType;
12
12
  value: boolean;
13
13
  }
@@ -3,16 +3,16 @@ export interface RuleConditionDetailResponseData {
3
3
  comparisonTrait?: Schematic.EntityTraitDefinitionResponseData;
4
4
  comparisonTraitId?: string;
5
5
  conditionGroupId?: string;
6
- conditionType: string;
6
+ conditionType: Schematic.ConditionType;
7
7
  createdAt: Date;
8
8
  environmentId: string;
9
9
  eventSubtype?: string;
10
10
  flagId?: string;
11
11
  id: string;
12
- metricPeriod?: string;
13
- metricPeriodMonthReset?: string;
12
+ metricPeriod?: Schematic.MetricPeriod;
13
+ metricPeriodMonthReset?: Schematic.MetricPeriodMonthReset;
14
14
  metricValue?: number;
15
- operator: string;
15
+ operator: Schematic.ComparableOperator;
16
16
  resourceIds: string[];
17
17
  resources: Schematic.PreviewObjectResponseData[];
18
18
  ruleId: string;
@@ -2,16 +2,16 @@ import type * as Schematic from "../index";
2
2
  export interface RuleConditionResponseData {
3
3
  comparisonTraitId?: string;
4
4
  conditionGroupId?: string;
5
- conditionType: string;
5
+ conditionType: Schematic.ConditionType;
6
6
  createdAt: Date;
7
7
  environmentId: string;
8
8
  eventSubtype?: string;
9
9
  flagId?: string;
10
10
  id: string;
11
- metricPeriod?: string;
12
- metricPeriodMonthReset?: string;
11
+ metricPeriod?: Schematic.MetricPeriod;
12
+ metricPeriodMonthReset?: Schematic.MetricPeriodMonthReset;
13
13
  metricValue?: number;
14
- operator: string;
14
+ operator: Schematic.ComparableOperator;
15
15
  resourceIds: string[];
16
16
  ruleId: string;
17
17
  traitEntityType?: Schematic.EntityType;
@@ -8,7 +8,7 @@ export interface RuleDetailResponseData {
8
8
  id: string;
9
9
  name: string;
10
10
  priority: number;
11
- ruleType: string;
11
+ ruleType: Schematic.RuleType;
12
12
  updatedAt: Date;
13
13
  value: boolean;
14
14
  }
@@ -1,3 +1,4 @@
1
+ import type * as Schematic from "../index";
1
2
  export interface RuleResponseData {
2
3
  createdAt: Date;
3
4
  environmentId: string;
@@ -5,7 +6,7 @@ export interface RuleResponseData {
5
6
  id: string;
6
7
  name: string;
7
8
  priority: number;
8
- ruleType: string;
9
+ ruleType: Schematic.RuleType;
9
10
  updatedAt: Date;
10
11
  value: boolean;
11
12
  }
@@ -1,10 +1,10 @@
1
- export declare const RuleRuleType: {
2
- readonly Default: "default";
3
- readonly GlobalOverride: "global_override";
1
+ export declare const RuleType: {
4
2
  readonly CompanyOverride: "company_override";
5
3
  readonly CompanyOverrideUsageExceeded: "company_override_usage_exceeded";
4
+ readonly Default: "default";
5
+ readonly GlobalOverride: "global_override";
6
6
  readonly PlanEntitlement: "plan_entitlement";
7
7
  readonly PlanEntitlementUsageExceeded: "plan_entitlement_usage_exceeded";
8
8
  readonly Standard: "standard";
9
9
  };
10
- export type RuleRuleType = (typeof RuleRuleType)[keyof typeof RuleRuleType];
10
+ export type RuleType = (typeof RuleType)[keyof typeof RuleType];
@@ -9,7 +9,7 @@ export interface RuleView {
9
9
  id: string;
10
10
  name: string;
11
11
  priority: number;
12
- ruleType: string;
12
+ ruleType: Schematic.RuleType;
13
13
  updatedAt: Date;
14
14
  value: boolean;
15
15
  }
@@ -1,6 +1,6 @@
1
1
  /** The current schema version hash for rules engine types. The first enum value is always the current version. */
2
2
  export declare const RulesEngineSchemaVersion: {
3
- readonly V5F633Cc3: "v5f633cc3";
3
+ readonly V97288F60: "v97288f60";
4
4
  readonly PlaceholderForFernCompatibility: "placeholder-for-fern-compatibility";
5
5
  };
6
6
  export type RulesEngineSchemaVersion = (typeof RulesEngineSchemaVersion)[keyof typeof RulesEngineSchemaVersion];