@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
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # schematic-typescript-node
1
+ # Schematic Typescript Node SDK
2
2
 
3
3
  ## Installation and Setup
4
4
 
@@ -153,7 +153,19 @@ const client = new SchematicClient({
153
153
  client.close();
154
154
  ```
155
155
 
156
- If no logger is provided, the client will use a default console logger that outputs to the standard console methods.
156
+ If no logger is provided, the client uses a default console logger. By default it only emits `warn` and `error` messages; `debug` and `info` are suppressed to keep production output quiet. Use the `logLevel` option to raise or lower the verbosity of the default logger:
157
+
158
+ ```ts
159
+ import { SchematicClient, LogLevel } from "@schematichq/schematic-typescript-node";
160
+
161
+ const apiKey = process.env.SCHEMATIC_API_KEY;
162
+ const client = new SchematicClient({
163
+ apiKey,
164
+ logLevel: "debug", // or LogLevel.Debug — emit all levels (debug, info, warn, error)
165
+ });
166
+ ```
167
+
168
+ The `logLevel` option only affects the default console logger. When you supply your own `logger`, its level configuration is respected as-is and `logLevel` is ignored.
157
169
 
158
170
  ## Usage examples
159
171
 
@@ -234,6 +246,42 @@ client.track({
234
246
  });
235
247
  ```
236
248
 
249
+ Both `track` and `identify` accept an optional second argument for event metadata. Supply an `idempotencyKey` to deduplicate events (duplicates with the same key, scoped to the environment, are dropped server-side for 24 hours):
250
+
251
+ ```ts
252
+ client.track(
253
+ {
254
+ event: "some-action",
255
+ company: { id: "your-company-id" },
256
+ },
257
+ { idempotencyKey: "your-unique-key" },
258
+ );
259
+
260
+ client.identify(
261
+ {
262
+ keys: { userId: "your-user-id" },
263
+ name: "Wile E. Coyote",
264
+ },
265
+ { idempotencyKey: "your-unique-key" },
266
+ );
267
+ ```
268
+
269
+ For `track`, you can also set a trusted client clock to use your own timestamp as the effective event time, and backfill historical data without affecting billing. Both require a secret API key:
270
+
271
+ ```ts
272
+ client.track(
273
+ {
274
+ event: "some-action",
275
+ company: { id: "your-company-id" },
276
+ },
277
+ {
278
+ sentAt: new Date("2026-01-01T00:00:00Z"),
279
+ trustedClientClock: true,
280
+ backfill: true,
281
+ },
282
+ );
283
+ ```
284
+
237
285
  ### Creating and updating companies
238
286
 
239
287
  Although it is faster to create companies and users via identify events, if you need to handle a response, you can use the companies API to upsert companies. Because you use your own identifiers to identify companies, rather than a Schematic company ID, creating and updating companies are both done via the same upsert operation:
@@ -601,6 +649,64 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse)
601
649
  }
602
650
  ```
603
651
 
652
+ ## Caching
653
+
654
+ ### Local Caching
655
+
656
+ By default, the client will do some local caching for flag checks. You can customize this behavior by specifying the max size of the cache and the max age of the cache (in milliseconds) as shown in the setup section above.
657
+
658
+ ### Cloudflare KV Caching
659
+
660
+ If you're using Cloudflare Workers, you can leverage Cloudflare's KV storage for caching flag check results. This provides a more persistent and distributed cache compared to the local in-memory cache.
661
+
662
+ To use Cloudflare KV caching, you'll need to install the Cloudflare adapter package:
663
+
664
+ ```bash
665
+ npm install @schematichq/schematic-typescript-cloudflare
666
+ # or
667
+ yarn add @schematichq/schematic-typescript-cloudflare
668
+ # or
669
+ pnpm add @schematichq/schematic-typescript-cloudflare
670
+ ```
671
+
672
+ Then, in your Cloudflare Worker, you can set up the client with KV caching:
673
+
674
+ ```typescript
675
+ import { SchematicClient } from "@schematichq/schematic-typescript-node";
676
+ import { CloudflareKVCache } from "@schematichq/schematic-typescript-cloudflare";
677
+
678
+ // Inside a Cloudflare Worker
679
+ export default {
680
+ async fetch(request, env, ctx) {
681
+ // Create a CloudflareKVCache instance
682
+ const cache = new CloudflareKVCache<boolean>(env.MY_KV_NAMESPACE, {
683
+ ttl: 1000 * 60 * 60, // 1 hour cache TTL
684
+ keyPrefix: 'schematic:', // Optional prefix for KV keys
685
+ });
686
+
687
+ // Initialize Schematic with the KV cache
688
+ const schematic = new SchematicClient({
689
+ apiKey: env.SCHEMATIC_API_KEY,
690
+ cacheProviders: {
691
+ flagChecks: [cache],
692
+ }
693
+ });
694
+
695
+ // Your application logic...
696
+ // ...
697
+
698
+ // Don't forget to close the client when done
699
+ schematic.close();
700
+ }
701
+ };
702
+ ```
703
+
704
+ The CloudflareKVCache constructor accepts the following options:
705
+ - `ttl`: Time-to-live for cache entries in milliseconds (default: 5000ms)
706
+ - `keyPrefix`: Prefix to add to all KV keys (default: 'schematic:')
707
+
708
+ With this setup, flag check results will be cached in your Cloudflare KV namespace, allowing for persistence across worker invocations and global distribution of your cache.
709
+
604
710
  ## DataStream
605
711
 
606
712
  DataStream enables local flag evaluation by maintaining a WebSocket connection to Schematic and caching flag rules, company, and user data locally.
@@ -720,3 +826,13 @@ const client = new SchematicClient({
720
826
 
721
827
  client.close();
722
828
  ```
829
+
830
+ ## Contributing
831
+
832
+ While we value open-source contributions to this SDK, this library is generated programmatically.
833
+ Additions made directly to this library would have to be moved over to our generation code,
834
+ otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
835
+ a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
836
+ an issue first to discuss with us!
837
+
838
+ On the other hand, contributions to the README are always very welcome!
@@ -1,6 +1,7 @@
1
1
  import { HeaderAuthProvider } from "./auth/HeaderAuthProvider";
2
2
  import * as core from "./core";
3
3
  import type * as environments from "./environments";
4
+ export type AuthOption = false | core.AuthProvider["getAuthRequest"] | core.AuthProvider | HeaderAuthProvider.AuthOptions;
4
5
  export type BaseClientOptions = {
5
6
  environment?: core.Supplier<environments.SchematicEnvironment | string>;
6
7
  /** Specify a custom URL to connect the client to. */
@@ -16,6 +17,8 @@ export type BaseClientOptions = {
16
17
  fetcher?: core.FetchFunction;
17
18
  /** Configure logging for the client. */
18
19
  logging?: core.logging.LogConfig | core.logging.Logger;
20
+ /** Override auth. Pass false to disable, a function returning auth headers, an AuthProvider, or auth options. */
21
+ auth?: AuthOption;
19
22
  } & HeaderAuthProvider.AuthOptions;
20
23
  export interface BaseRequestOptions {
21
24
  /** The maximum time to wait for a response in seconds. */
package/dist/Client.d.ts CHANGED
@@ -10,6 +10,8 @@ import { DataexportsClient } from "./api/resources/dataexports/client/Client";
10
10
  import { EntitlementsClient } from "./api/resources/entitlements/client/Client";
11
11
  import { EventsClient } from "./api/resources/events/client/Client";
12
12
  import { FeaturesClient } from "./api/resources/features/client/Client";
13
+ import { InsightsClient } from "./api/resources/insights/client/Client";
14
+ import { IntegrationsapiClient } from "./api/resources/integrationsapi/client/Client";
13
15
  import { PlanbundleClient } from "./api/resources/planbundle/client/Client";
14
16
  import { PlangroupsClient } from "./api/resources/plangroups/client/Client";
15
17
  import { PlanmigrationsClient } from "./api/resources/planmigrations/client/Client";
@@ -34,10 +36,12 @@ export declare class SchematicClient {
34
36
  protected _entitlements: EntitlementsClient | undefined;
35
37
  protected _plans: PlansClient | undefined;
36
38
  protected _components: ComponentsClient | undefined;
39
+ protected _planbundle: PlanbundleClient | undefined;
37
40
  protected _dataexports: DataexportsClient | undefined;
38
41
  protected _events: EventsClient | undefined;
39
42
  protected _features: FeaturesClient | undefined;
40
- protected _planbundle: PlanbundleClient | undefined;
43
+ protected _insights: InsightsClient | undefined;
44
+ protected _integrationsapi: IntegrationsapiClient | undefined;
41
45
  protected _plangroups: PlangroupsClient | undefined;
42
46
  protected _planmigrations: PlanmigrationsClient | undefined;
43
47
  protected _componentspublic: ComponentspublicClient | undefined;
@@ -53,34 +57,18 @@ export declare class SchematicClient {
53
57
  get entitlements(): EntitlementsClient;
54
58
  get plans(): PlansClient;
55
59
  get components(): ComponentsClient;
60
+ get planbundle(): PlanbundleClient;
56
61
  get dataexports(): DataexportsClient;
57
62
  get events(): EventsClient;
58
63
  get features(): FeaturesClient;
59
- get planbundle(): PlanbundleClient;
64
+ get insights(): InsightsClient;
65
+ get integrationsapi(): IntegrationsapiClient;
60
66
  get plangroups(): PlangroupsClient;
61
67
  get planmigrations(): PlanmigrationsClient;
62
68
  get componentspublic(): ComponentspublicClient;
63
69
  get scheduledcheckout(): ScheduledcheckoutClient;
64
70
  get accesstokens(): AccesstokensClient;
65
71
  get webhooks(): WebhooksClient;
66
- /**
67
- * @param {string} plan_audience_id
68
- * @param {SchematicClient.RequestOptions} requestOptions - Request-specific configuration.
69
- *
70
- * @example
71
- * await client.putPlanAudiencesPlanAudienceId("plan_audience_id")
72
- */
73
- putPlanAudiencesPlanAudienceId(plan_audience_id: string, requestOptions?: SchematicClient.RequestOptions): core.HttpResponsePromise<void>;
74
- private __putPlanAudiencesPlanAudienceId;
75
- /**
76
- * @param {string} plan_audience_id
77
- * @param {SchematicClient.RequestOptions} requestOptions - Request-specific configuration.
78
- *
79
- * @example
80
- * await client.deletePlanAudiencesPlanAudienceId("plan_audience_id")
81
- */
82
- deletePlanAudiencesPlanAudienceId(plan_audience_id: string, requestOptions?: SchematicClient.RequestOptions): core.HttpResponsePromise<void>;
83
- private __deletePlanAudiencesPlanAudienceId;
84
72
  /**
85
73
  * Make a passthrough request using the SDK's configured auth, retry, logging, etc.
86
74
  * This is useful for making requests to endpoints not yet supported in the SDK.
@@ -10,6 +10,40 @@ export declare namespace AccountsClient {
10
10
  export declare class AccountsClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<AccountsClient.Options>;
12
12
  constructor(options: AccountsClient.Options);
13
+ /**
14
+ * @param {Schematic.ListAccountMembersRequest} request
15
+ * @param {AccountsClient.RequestOptions} requestOptions - Request-specific configuration.
16
+ *
17
+ * @throws {@link Schematic.BadRequestError}
18
+ * @throws {@link Schematic.UnauthorizedError}
19
+ * @throws {@link Schematic.ForbiddenError}
20
+ * @throws {@link Schematic.NotFoundError}
21
+ * @throws {@link Schematic.InternalServerError}
22
+ *
23
+ * @example
24
+ * await client.accounts.listAccountMembers({
25
+ * ids: ["ids"],
26
+ * q: "q",
27
+ * limit: 1000000,
28
+ * offset: 1000000
29
+ * })
30
+ */
31
+ listAccountMembers(request?: Schematic.ListAccountMembersRequest, requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListAccountMembersResponse>;
32
+ private __listAccountMembers;
33
+ /**
34
+ * @param {string} account_member_id - account_member_id
35
+ * @param {AccountsClient.RequestOptions} requestOptions - Request-specific configuration.
36
+ *
37
+ * @throws {@link Schematic.UnauthorizedError}
38
+ * @throws {@link Schematic.ForbiddenError}
39
+ * @throws {@link Schematic.NotFoundError}
40
+ * @throws {@link Schematic.InternalServerError}
41
+ *
42
+ * @example
43
+ * await client.accounts.getAccountMember("account_member_id")
44
+ */
45
+ getAccountMember(account_member_id: string, requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetAccountMemberResponse>;
46
+ private __getAccountMember;
13
47
  /**
14
48
  * @param {Schematic.ListApiKeysRequest} request
15
49
  * @param {AccountsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -184,6 +218,7 @@ export declare class AccountsClient {
184
218
  *
185
219
  * @example
186
220
  * await client.accounts.listEnvironments({
221
+ * ids: ["ids"],
187
222
  * limit: 1000000,
188
223
  * offset: 1000000
189
224
  * })
@@ -0,0 +1,18 @@
1
+ /**
2
+ * @example
3
+ * {
4
+ * ids: ["ids"],
5
+ * q: "q",
6
+ * limit: 1000000,
7
+ * offset: 1000000
8
+ * }
9
+ */
10
+ export interface ListAccountMembersRequest {
11
+ ids?: string | string[];
12
+ /** Search filter */
13
+ q?: string;
14
+ /** Page limit (default 100) */
15
+ limit?: number;
16
+ /** Page offset (default 0) */
17
+ offset?: number;
18
+ }
@@ -1,6 +1,7 @@
1
1
  /**
2
2
  * @example
3
3
  * {
4
+ * ids: ["ids"],
4
5
  * limit: 1000000,
5
6
  * offset: 1000000
6
7
  * }
@@ -2,6 +2,7 @@ export type { CountApiKeysRequest } from "./CountApiKeysRequest";
2
2
  export type { CountAuditLogsRequest } from "./CountAuditLogsRequest";
3
3
  export type { CreateApiKeyRequestBody } from "./CreateApiKeyRequestBody";
4
4
  export type { CreateEnvironmentRequestBody } from "./CreateEnvironmentRequestBody";
5
+ export type { ListAccountMembersRequest } from "./ListAccountMembersRequest";
5
6
  export type { ListApiKeysRequest } from "./ListApiKeysRequest";
6
7
  export type { ListAuditLogsRequest } from "./ListAuditLogsRequest";
7
8
  export type { ListEnvironmentsRequest } from "./ListEnvironmentsRequest";
@@ -0,0 +1,6 @@
1
+ import type * as Schematic from "../../../index";
2
+ export interface GetAccountMemberResponse {
3
+ data: Schematic.AccountMemberResponseData;
4
+ /** Input parameters */
5
+ params: Record<string, unknown>;
6
+ }
@@ -0,0 +1,12 @@
1
+ /**
2
+ * Input parameters
3
+ */
4
+ export interface ListAccountMembersParams {
5
+ ids?: string[];
6
+ /** Page limit (default 100) */
7
+ limit?: number;
8
+ /** Page offset (default 0) */
9
+ offset?: number;
10
+ /** Search filter */
11
+ q?: string;
12
+ }
@@ -0,0 +1,6 @@
1
+ import type * as Schematic from "../../../index";
2
+ export interface ListAccountMembersResponse {
3
+ data: Schematic.AccountMemberResponseData[];
4
+ /** Input parameters */
5
+ params: Schematic.ListAccountMembersParams;
6
+ }
@@ -6,10 +6,13 @@ export * from "./CreateApiKeyResponse";
6
6
  export * from "./CreateEnvironmentResponse";
7
7
  export * from "./DeleteApiKeyResponse";
8
8
  export * from "./DeleteEnvironmentResponse";
9
+ export * from "./GetAccountMemberResponse";
9
10
  export * from "./GetApiKeyResponse";
10
11
  export * from "./GetAuditLogResponse";
11
12
  export * from "./GetEnvironmentResponse";
12
13
  export * from "./GetWhoAmIResponse";
14
+ export * from "./ListAccountMembersParams";
15
+ export * from "./ListAccountMembersResponse";
13
16
  export * from "./ListApiKeysParams";
14
17
  export * from "./ListApiKeysResponse";
15
18
  export * from "./ListAuditLogsParams";
@@ -88,8 +88,9 @@ export declare class BillingClient {
88
88
  *
89
89
  * @example
90
90
  * await client.billing.listCustomersWithSubscriptions({
91
+ * companyIds: ["company_ids"],
91
92
  * name: "name",
92
- * providerType: "schematic",
93
+ * providerType: "orb",
93
94
  * q: "q",
94
95
  * limit: 1000000,
95
96
  * offset: 1000000
@@ -109,8 +110,9 @@ export declare class BillingClient {
109
110
  *
110
111
  * @example
111
112
  * await client.billing.countCustomers({
113
+ * companyIds: ["company_ids"],
112
114
  * name: "name",
113
- * providerType: "schematic",
115
+ * providerType: "orb",
114
116
  * q: "q",
115
117
  * limit: 1000000,
116
118
  * offset: 1000000
@@ -240,6 +242,21 @@ export declare class BillingClient {
240
242
  */
241
243
  upsertPaymentMethod(request: Schematic.CreatePaymentMethodRequestBody, requestOptions?: BillingClient.RequestOptions): core.HttpResponsePromise<Schematic.UpsertPaymentMethodResponse>;
242
244
  private __upsertPaymentMethod;
245
+ /**
246
+ * @param {string} billing_id - billing_id
247
+ * @param {BillingClient.RequestOptions} requestOptions - Request-specific configuration.
248
+ *
249
+ * @throws {@link Schematic.BadRequestError}
250
+ * @throws {@link Schematic.UnauthorizedError}
251
+ * @throws {@link Schematic.ForbiddenError}
252
+ * @throws {@link Schematic.NotFoundError}
253
+ * @throws {@link Schematic.InternalServerError}
254
+ *
255
+ * @example
256
+ * await client.billing.deletePaymentMethodByExternalId("billing_id")
257
+ */
258
+ deletePaymentMethodByExternalId(billing_id: string, requestOptions?: BillingClient.RequestOptions): core.HttpResponsePromise<Schematic.DeletePaymentMethodByExternalIdResponse>;
259
+ private __deletePaymentMethodByExternalId;
243
260
  /**
244
261
  * @param {Schematic.ListBillingPricesRequest} request
245
262
  * @param {BillingClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -252,13 +269,16 @@ export declare class BillingClient {
252
269
  *
253
270
  * @example
254
271
  * await client.billing.listBillingPrices({
272
+ * currency: "currency",
255
273
  * forInitialPlan: true,
256
274
  * forTrialExpiryPlan: true,
275
+ * ids: ["ids"],
257
276
  * interval: "interval",
258
277
  * isActive: true,
259
278
  * price: 1000000,
260
279
  * productId: "product_id",
261
- * providerType: "schematic",
280
+ * productIds: ["product_ids"],
281
+ * providerType: "orb",
262
282
  * q: "q",
263
283
  * tiersMode: "graduated",
264
284
  * usageType: "licensed",
@@ -324,13 +344,16 @@ export declare class BillingClient {
324
344
  *
325
345
  * @example
326
346
  * await client.billing.listBillingProductPrices({
347
+ * currency: "currency",
327
348
  * forInitialPlan: true,
328
349
  * forTrialExpiryPlan: true,
350
+ * ids: ["ids"],
329
351
  * interval: "interval",
330
352
  * isActive: true,
331
353
  * price: 1000000,
332
354
  * productId: "product_id",
333
- * providerType: "schematic",
355
+ * productIds: ["product_ids"],
356
+ * providerType: "orb",
334
357
  * q: "q",
335
358
  * tiersMode: "graduated",
336
359
  * usageType: "licensed",
@@ -386,11 +409,13 @@ export declare class BillingClient {
386
409
  *
387
410
  * @example
388
411
  * await client.billing.listBillingProducts({
412
+ * ids: ["ids"],
389
413
  * isActive: true,
390
414
  * name: "name",
391
415
  * priceUsageType: "licensed",
392
- * providerType: "schematic",
416
+ * providerType: "orb",
393
417
  * q: "q",
418
+ * recurringChargesOnly: true,
394
419
  * withOneTimeCharges: true,
395
420
  * withPricesOnly: true,
396
421
  * withZeroPrice: true,
@@ -413,11 +438,13 @@ export declare class BillingClient {
413
438
  *
414
439
  * @example
415
440
  * await client.billing.countBillingProducts({
441
+ * ids: ["ids"],
416
442
  * isActive: true,
417
443
  * name: "name",
418
444
  * priceUsageType: "licensed",
419
- * providerType: "schematic",
445
+ * providerType: "orb",
420
446
  * q: "q",
447
+ * recurringChargesOnly: true,
421
448
  * withOneTimeCharges: true,
422
449
  * withPricesOnly: true,
423
450
  * withZeroPrice: true,
@@ -2,11 +2,13 @@ import type * as Schematic from "../../../../index";
2
2
  /**
3
3
  * @example
4
4
  * {
5
+ * ids: ["ids"],
5
6
  * isActive: true,
6
7
  * name: "name",
7
8
  * priceUsageType: "licensed",
8
- * providerType: "schematic",
9
+ * providerType: "orb",
9
10
  * q: "q",
11
+ * recurringChargesOnly: true,
10
12
  * withOneTimeCharges: true,
11
13
  * withPricesOnly: true,
12
14
  * withZeroPrice: true,
@@ -23,6 +25,8 @@ export interface CountBillingProductsRequest {
23
25
  priceUsageType?: Schematic.BillingPriceUsageType;
24
26
  providerType?: Schematic.BillingProviderType;
25
27
  q?: string;
28
+ /** Filter to products that have at least one recurring price */
29
+ recurringChargesOnly?: boolean;
26
30
  /** Filter products that are one time charges */
27
31
  withOneTimeCharges?: boolean;
28
32
  /** Filter products that have prices */
@@ -2,8 +2,9 @@ import type * as Schematic from "../../../../index";
2
2
  /**
3
3
  * @example
4
4
  * {
5
+ * companyIds: ["company_ids"],
5
6
  * name: "name",
6
- * providerType: "schematic",
7
+ * providerType: "orb",
7
8
  * q: "q",
8
9
  * limit: 1000000,
9
10
  * offset: 1000000
@@ -21,8 +21,10 @@ export interface CreateBillingPriceRequestBody {
21
21
  currency: string;
22
22
  externalAccountId: string;
23
23
  interval: string;
24
+ intervalCount?: number;
24
25
  isActive: boolean;
25
26
  meterId?: string;
27
+ nickname?: string;
26
28
  packageSize?: number;
27
29
  price: number;
28
30
  priceDecimal?: string;
@@ -40,6 +40,7 @@ export interface CreateBillingSubscriptionRequestBody {
40
40
  periodEnd?: number;
41
41
  periodStart?: number;
42
42
  productExternalIds: Schematic.BillingProductPricing[];
43
+ providerType?: Schematic.BillingProviderType;
43
44
  status?: string;
44
45
  subscriptionExternalId: string;
45
46
  totalPrice: number;
@@ -1,3 +1,4 @@
1
+ import type * as Schematic from "../../../../index";
1
2
  /**
2
3
  * @example
3
4
  * {
@@ -12,4 +13,5 @@ export interface CreateMeterRequestBody {
12
13
  eventName: string;
13
14
  eventPayloadKey: string;
14
15
  externalId: string;
16
+ providerType?: Schematic.BillingProviderType;
15
17
  }
@@ -2,13 +2,16 @@ import type * as Schematic from "../../../../index";
2
2
  /**
3
3
  * @example
4
4
  * {
5
+ * currency: "currency",
5
6
  * forInitialPlan: true,
6
7
  * forTrialExpiryPlan: true,
8
+ * ids: ["ids"],
7
9
  * interval: "interval",
8
10
  * isActive: true,
9
11
  * price: 1000000,
10
12
  * productId: "product_id",
11
- * providerType: "schematic",
13
+ * productIds: ["product_ids"],
14
+ * providerType: "orb",
12
15
  * q: "q",
13
16
  * tiersMode: "graduated",
14
17
  * usageType: "licensed",
@@ -18,6 +21,8 @@ import type * as Schematic from "../../../../index";
18
21
  * }
19
22
  */
20
23
  export interface ListBillingPricesRequest {
24
+ /** Filter for prices in a specific currency (e.g. usd, eur) */
25
+ currency?: string;
21
26
  /** Filter for prices valid for initial plans (free prices only) */
22
27
  forInitialPlan?: boolean;
23
28
  /** Filter for prices valid for trial expiry plans (free prices only) */
@@ -2,13 +2,16 @@ import type * as Schematic from "../../../../index";
2
2
  /**
3
3
  * @example
4
4
  * {
5
+ * currency: "currency",
5
6
  * forInitialPlan: true,
6
7
  * forTrialExpiryPlan: true,
8
+ * ids: ["ids"],
7
9
  * interval: "interval",
8
10
  * isActive: true,
9
11
  * price: 1000000,
10
12
  * productId: "product_id",
11
- * providerType: "schematic",
13
+ * productIds: ["product_ids"],
14
+ * providerType: "orb",
12
15
  * q: "q",
13
16
  * tiersMode: "graduated",
14
17
  * usageType: "licensed",
@@ -18,6 +21,8 @@ import type * as Schematic from "../../../../index";
18
21
  * }
19
22
  */
20
23
  export interface ListBillingProductPricesRequest {
24
+ /** Filter for prices in a specific currency (e.g. usd, eur) */
25
+ currency?: string;
21
26
  /** Filter for prices valid for initial plans (free prices only) */
22
27
  forInitialPlan?: boolean;
23
28
  /** Filter for prices valid for trial expiry plans (free prices only) */
@@ -2,11 +2,13 @@ import type * as Schematic from "../../../../index";
2
2
  /**
3
3
  * @example
4
4
  * {
5
+ * ids: ["ids"],
5
6
  * isActive: true,
6
7
  * name: "name",
7
8
  * priceUsageType: "licensed",
8
- * providerType: "schematic",
9
+ * providerType: "orb",
9
10
  * q: "q",
11
+ * recurringChargesOnly: true,
10
12
  * withOneTimeCharges: true,
11
13
  * withPricesOnly: true,
12
14
  * withZeroPrice: true,
@@ -23,6 +25,8 @@ export interface ListBillingProductsRequest {
23
25
  priceUsageType?: Schematic.BillingPriceUsageType;
24
26
  providerType?: Schematic.BillingProviderType;
25
27
  q?: string;
28
+ /** Filter to products that have at least one recurring price */
29
+ recurringChargesOnly?: boolean;
26
30
  /** Filter products that are one time charges */
27
31
  withOneTimeCharges?: boolean;
28
32
  /** Filter products that have prices */
@@ -2,8 +2,9 @@ import type * as Schematic from "../../../../index";
2
2
  /**
3
3
  * @example
4
4
  * {
5
+ * companyIds: ["company_ids"],
5
6
  * name: "name",
6
- * providerType: "schematic",
7
+ * providerType: "orb",
7
8
  * q: "q",
8
9
  * limit: 1000000,
9
10
  * offset: 1000000
@@ -14,6 +14,8 @@ export interface CountBillingProductsParams {
14
14
  priceUsageType?: Schematic.BillingPriceUsageType;
15
15
  providerType?: Schematic.BillingProviderType;
16
16
  q?: string;
17
+ /** Filter to products that have at least one recurring price */
18
+ recurringChargesOnly?: boolean;
17
19
  /** Filter products that are one time charges */
18
20
  withOneTimeCharges?: boolean;
19
21
  /** Filter products that have prices */
@@ -0,0 +1,6 @@
1
+ import type * as Schematic from "../../../index";
2
+ export interface DeletePaymentMethodByExternalIdResponse {
3
+ data: Schematic.DeleteResponse;
4
+ /** Input parameters */
5
+ params: Record<string, unknown>;
6
+ }
@@ -3,6 +3,8 @@ import type * as Schematic from "../../../index";
3
3
  * Input parameters
4
4
  */
5
5
  export interface ListBillingPricesParams {
6
+ /** Filter for prices in a specific currency (e.g. usd, eur) */
7
+ currency?: string;
6
8
  /** Filter for prices valid for initial plans (free prices only) */
7
9
  forInitialPlan?: boolean;
8
10
  /** Filter for prices valid for trial expiry plans (free prices only) */
@@ -3,6 +3,8 @@ import type * as Schematic from "../../../index";
3
3
  * Input parameters
4
4
  */
5
5
  export interface ListBillingProductPricesParams {
6
+ /** Filter for prices in a specific currency (e.g. usd, eur) */
7
+ currency?: string;
6
8
  /** Filter for prices valid for initial plans (free prices only) */
7
9
  forInitialPlan?: boolean;
8
10
  /** Filter for prices valid for trial expiry plans (free prices only) */