@schematichq/schematic-typescript-node 1.3.0 → 1.4.0

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 (440) hide show
  1. package/README.md +36 -2
  2. package/dist/Client.d.ts +12 -0
  3. package/dist/api/resources/accounts/client/Client.d.ts +33 -16
  4. package/dist/api/resources/accounts/client/requests/CountAuditLogsRequest.d.ts +24 -0
  5. package/dist/api/resources/accounts/client/requests/CreateApiKeyRequestBody.d.ts +1 -0
  6. package/dist/api/resources/accounts/client/requests/ListAuditLogsRequest.d.ts +24 -0
  7. package/dist/api/resources/accounts/client/requests/index.d.ts +2 -2
  8. package/dist/api/resources/accounts/types/{ListApiRequestsParams.d.ts → CountAuditLogsParams.d.ts} +5 -2
  9. package/dist/api/resources/accounts/types/{CountApiRequestsResponse.d.ts → CountAuditLogsResponse.d.ts} +2 -2
  10. package/dist/api/resources/accounts/types/{GetApiRequestResponse.d.ts → GetAuditLogResponse.d.ts} +2 -2
  11. package/dist/api/resources/accounts/types/GetWhoAmIResponse.d.ts +6 -0
  12. package/dist/api/resources/accounts/types/{CountApiRequestsParams.d.ts → ListAuditLogsParams.d.ts} +5 -2
  13. package/dist/api/resources/accounts/types/ListAuditLogsResponse.d.ts +6 -0
  14. package/dist/api/resources/accounts/types/index.d.ts +6 -5
  15. package/dist/api/resources/billing/client/Client.d.ts +0 -3
  16. package/dist/api/resources/billing/client/requests/CountBillingProductsRequest.d.ts +1 -1
  17. package/dist/api/resources/billing/client/requests/CountCustomersRequest.d.ts +0 -2
  18. package/dist/api/resources/billing/client/requests/CreateBillingCustomerRequestBody.d.ts +0 -2
  19. package/dist/api/resources/billing/client/requests/CreateInvoiceRequestBody.d.ts +2 -0
  20. package/dist/api/resources/billing/client/requests/ListBillingProductsRequest.d.ts +1 -1
  21. package/dist/api/resources/billing/client/requests/ListCustomersWithSubscriptionsRequest.d.ts +0 -2
  22. package/dist/api/resources/billing/types/CountBillingProductsParams.d.ts +1 -1
  23. package/dist/api/resources/billing/types/CountCustomersParams.d.ts +0 -1
  24. package/dist/api/resources/billing/types/ListBillingProductsParams.d.ts +1 -1
  25. package/dist/api/resources/billing/types/ListCustomersWithSubscriptionsParams.d.ts +0 -1
  26. package/dist/api/resources/companies/client/Client.d.ts +12 -48
  27. package/dist/api/resources/companies/client/requests/CountCompaniesRequest.d.ts +27 -0
  28. package/dist/api/resources/companies/client/requests/ListCompaniesRequest.d.ts +27 -0
  29. package/dist/api/resources/companies/client/requests/index.d.ts +0 -2
  30. package/dist/api/resources/companies/types/CountCompaniesParams.d.ts +21 -0
  31. package/dist/api/resources/companies/types/ListCompaniesParams.d.ts +21 -0
  32. package/dist/api/resources/companies/types/index.d.ts +0 -4
  33. package/dist/api/resources/componentspublic/client/Client.d.ts +26 -0
  34. package/dist/api/resources/componentspublic/client/index.d.ts +1 -0
  35. package/dist/api/resources/componentspublic/index.d.ts +2 -0
  36. package/dist/api/resources/componentspublic/types/GetPublicPlansResponse.d.ts +6 -0
  37. package/dist/api/resources/componentspublic/types/index.d.ts +1 -0
  38. package/dist/api/resources/credits/client/Client.d.ts +71 -0
  39. package/dist/api/resources/credits/client/requests/CountBillingPlanCreditGrantsRequest.d.ts +3 -1
  40. package/dist/api/resources/credits/client/requests/CountCompanyGrantsRequest.d.ts +20 -0
  41. package/dist/api/resources/credits/client/requests/CountCreditEventLedgerRequest.d.ts +26 -0
  42. package/dist/api/resources/credits/client/requests/ListBillingPlanCreditGrantsRequest.d.ts +3 -1
  43. package/dist/api/resources/credits/client/requests/ListCreditEventLedgerRequest.d.ts +26 -0
  44. package/dist/api/resources/credits/client/requests/index.d.ts +3 -2
  45. package/dist/api/resources/credits/types/CountBillingPlanCreditGrantsParams.d.ts +1 -0
  46. package/dist/api/resources/credits/types/CountCompanyGrantsParams.d.ts +13 -0
  47. package/dist/api/resources/credits/types/CountCompanyGrantsResponse.d.ts +6 -0
  48. package/dist/api/resources/credits/types/CountCreditEventLedgerParams.d.ts +16 -0
  49. package/dist/api/resources/credits/types/CountCreditEventLedgerResponse.d.ts +6 -0
  50. package/dist/api/resources/credits/types/ListBillingPlanCreditGrantsParams.d.ts +1 -0
  51. package/dist/api/resources/credits/types/ListCreditEventLedgerParams.d.ts +16 -0
  52. package/dist/api/resources/credits/types/ListCreditEventLedgerResponse.d.ts +6 -0
  53. package/dist/api/resources/credits/types/index.d.ts +6 -0
  54. package/dist/api/resources/entitlements/client/Client.d.ts +22 -0
  55. package/dist/api/resources/entitlements/client/requests/CountPlanEntitlementsRequest.d.ts +5 -0
  56. package/dist/api/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +1 -0
  57. package/dist/api/resources/entitlements/client/requests/GetFeatureUsageTimeSeriesRequest.d.ts +18 -0
  58. package/dist/api/resources/entitlements/client/requests/ListPlanEntitlementsRequest.d.ts +5 -0
  59. package/dist/api/resources/entitlements/client/requests/index.d.ts +1 -0
  60. package/dist/api/resources/entitlements/types/CountPlanEntitlementsParams.d.ts +4 -0
  61. package/dist/api/resources/entitlements/types/GetFeatureUsageTimeSeriesParams.d.ts +11 -0
  62. package/dist/api/resources/entitlements/types/GetFeatureUsageTimeSeriesResponse.d.ts +6 -0
  63. package/dist/api/resources/entitlements/types/ListPlanEntitlementsParams.d.ts +4 -0
  64. package/dist/api/resources/entitlements/types/index.d.ts +2 -0
  65. package/dist/api/resources/features/client/Client.d.ts +2 -0
  66. package/dist/api/resources/features/client/requests/CountFeaturesRequest.d.ts +3 -0
  67. package/dist/api/resources/features/client/requests/ListFeaturesRequest.d.ts +3 -0
  68. package/dist/api/resources/features/types/CountFeaturesParams.d.ts +2 -0
  69. package/dist/api/resources/features/types/ListFeaturesParams.d.ts +2 -0
  70. package/dist/api/resources/index.d.ts +11 -0
  71. package/dist/api/resources/planbundle/client/Client.d.ts +52 -0
  72. package/dist/api/resources/planbundle/client/index.d.ts +1 -0
  73. package/dist/api/resources/planbundle/client/requests/CreatePlanBundleRequestBody.d.ts +16 -0
  74. package/dist/api/resources/planbundle/client/requests/UpdatePlanBundleRequestBody.d.ts +17 -0
  75. package/dist/api/resources/planbundle/client/requests/index.d.ts +2 -0
  76. package/dist/api/resources/planbundle/index.d.ts +2 -0
  77. package/dist/api/resources/planbundle/types/CreatePlanBundleResponse.d.ts +6 -0
  78. package/dist/api/resources/planbundle/types/UpdatePlanBundleResponse.d.ts +6 -0
  79. package/dist/api/resources/planbundle/types/index.d.ts +2 -0
  80. package/dist/api/resources/plangroups/client/Client.d.ts +4 -0
  81. package/dist/api/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +6 -0
  82. package/dist/api/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +6 -0
  83. package/dist/api/resources/planmigrations/client/Client.d.ts +109 -0
  84. package/dist/api/resources/planmigrations/client/index.d.ts +1 -0
  85. package/dist/api/resources/planmigrations/client/requests/CountCompanyMigrationsRequest.d.ts +20 -0
  86. package/dist/api/resources/planmigrations/client/requests/CountMigrationsRequest.d.ts +18 -0
  87. package/dist/api/resources/planmigrations/client/requests/ListCompanyMigrationsRequest.d.ts +20 -0
  88. package/dist/api/resources/planmigrations/client/requests/ListMigrationsRequest.d.ts +18 -0
  89. package/dist/api/resources/planmigrations/client/requests/index.d.ts +4 -0
  90. package/dist/api/resources/planmigrations/index.d.ts +2 -0
  91. package/dist/api/resources/planmigrations/types/CountCompanyMigrationsParams.d.ts +13 -0
  92. package/dist/api/resources/planmigrations/types/CountCompanyMigrationsResponse.d.ts +6 -0
  93. package/dist/api/resources/planmigrations/types/CountMigrationsParams.d.ts +12 -0
  94. package/dist/api/resources/planmigrations/types/CountMigrationsResponse.d.ts +6 -0
  95. package/dist/api/resources/planmigrations/types/GetMigrationResponse.d.ts +6 -0
  96. package/dist/api/resources/planmigrations/types/ListCompanyMigrationsParams.d.ts +13 -0
  97. package/dist/api/resources/planmigrations/types/ListCompanyMigrationsResponse.d.ts +6 -0
  98. package/dist/api/resources/planmigrations/types/ListMigrationsParams.d.ts +12 -0
  99. package/dist/api/resources/planmigrations/types/ListMigrationsResponse.d.ts +6 -0
  100. package/dist/api/resources/planmigrations/types/index.d.ts +9 -0
  101. package/dist/api/resources/plans/client/Client.d.ts +41 -3
  102. package/dist/api/resources/plans/client/requests/GetPlanRequest.d.ts +10 -0
  103. package/dist/api/resources/plans/client/requests/ListPlanIssuesRequest.d.ts +3 -1
  104. package/dist/api/resources/plans/client/requests/PublishPlanVersionRequestBody.d.ts +12 -0
  105. package/dist/api/resources/plans/client/requests/index.d.ts +2 -3
  106. package/dist/api/resources/plans/types/CountPlansParams.d.ts +1 -0
  107. package/dist/api/resources/plans/types/DeletePlanVersionResponse.d.ts +6 -0
  108. package/dist/api/resources/plans/types/GetPlanParams.d.ts +7 -0
  109. package/dist/api/resources/plans/types/GetPlanResponse.d.ts +1 -1
  110. package/dist/api/resources/plans/types/ListPlanIssuesParams.d.ts +1 -0
  111. package/dist/api/resources/plans/types/ListPlansParams.d.ts +1 -0
  112. package/dist/api/resources/plans/types/PublishPlanVersionResponse.d.ts +6 -0
  113. package/dist/api/resources/plans/types/index.d.ts +3 -0
  114. package/dist/api/resources/scheduledcheckout/client/Client.d.ts +83 -0
  115. package/dist/api/resources/scheduledcheckout/client/index.d.ts +1 -0
  116. package/dist/api/resources/scheduledcheckout/client/requests/CreateScheduledCheckoutRequest.d.ts +15 -0
  117. package/dist/api/resources/scheduledcheckout/client/requests/ListScheduledCheckoutsRequest.d.ts +18 -0
  118. package/dist/api/resources/scheduledcheckout/client/requests/UpdateScheduledCheckoutRequest.d.ts +9 -0
  119. package/dist/api/resources/scheduledcheckout/client/requests/index.d.ts +3 -0
  120. package/dist/api/resources/scheduledcheckout/index.d.ts +2 -0
  121. package/dist/api/resources/scheduledcheckout/types/CreateScheduledCheckoutResponse.d.ts +6 -0
  122. package/dist/api/resources/scheduledcheckout/types/GetScheduledCheckoutResponse.d.ts +6 -0
  123. package/dist/api/resources/scheduledcheckout/types/ListScheduledCheckoutsParams.d.ts +12 -0
  124. package/dist/api/resources/scheduledcheckout/types/ListScheduledCheckoutsResponse.d.ts +6 -0
  125. package/dist/api/resources/scheduledcheckout/types/UpdateScheduledCheckoutResponse.d.ts +6 -0
  126. package/dist/api/resources/scheduledcheckout/types/index.d.ts +5 -0
  127. package/dist/api/types/{PlanChangeActorType.d.ts → ActorType.d.ts} +3 -2
  128. package/dist/api/types/ApiKeyCreateResponseData.d.ts +1 -0
  129. package/dist/api/types/ApiKeyResponseData.d.ts +1 -0
  130. package/dist/api/types/{ApiKeyRequestListResponseData.d.ts → AuditLogListResponseData.d.ts} +4 -4
  131. package/dist/api/types/{ApiKeyRequestResponseData.d.ts → AuditLogResponseData.d.ts} +3 -5
  132. package/dist/api/types/BillingCreditGrantResponseData.d.ts +2 -0
  133. package/dist/api/types/BillingCreditResponseData.d.ts +1 -0
  134. package/dist/api/types/BillingCreditView.d.ts +22 -0
  135. package/dist/api/types/BillingCustomerResponseData.d.ts +0 -1
  136. package/dist/api/types/BillingCustomerWithSubscriptionsResponseData.d.ts +0 -1
  137. package/dist/api/types/BillingPlanCreditGrantResponseData.d.ts +9 -2
  138. package/dist/api/types/CheckFlagResponseData.d.ts +8 -5
  139. package/dist/api/types/CompanyDetailResponseData.d.ts +2 -0
  140. package/dist/api/types/CompanyPlanDetailResponseData.d.ts +3 -0
  141. package/dist/api/types/CompanyPlanWithBillingSubView.d.ts +1 -0
  142. package/dist/api/types/ComponentDisplaySettings.d.ts +2 -0
  143. package/dist/api/types/ComponentHydrateResponseData.d.ts +1 -0
  144. package/dist/api/types/ComponentPreviewResponseData.d.ts +1 -0
  145. package/dist/api/types/ComponentSettingsResponseData.d.ts +2 -0
  146. package/dist/api/types/ConditionConditionType.d.ts +1 -1
  147. package/dist/api/types/ConditionGroupResponseData.d.ts +10 -0
  148. package/dist/api/types/ConditionGroupView.d.ts +12 -0
  149. package/dist/api/types/ConditionResponseData.d.ts +28 -0
  150. package/dist/api/types/ConditionView.d.ts +35 -0
  151. package/dist/api/{resources/credits/client/requests → types}/CreateBillingPlanCreditGrantRequestBody.d.ts +2 -11
  152. package/dist/api/types/CreateEntitlementInBundleRequestBody.d.ts +31 -0
  153. package/dist/api/types/CreateEntitlementInBundleRequestBodyMetricPeriod.d.ts +7 -0
  154. package/dist/api/types/CreateEntitlementInBundleRequestBodyMetricPeriodMonthReset.d.ts +5 -0
  155. package/dist/api/types/CreateEventRequestBody.d.ts +1 -0
  156. package/dist/api/types/CreatePlanRequestBody.d.ts +7 -0
  157. package/dist/api/types/CreditCompanyGrantView.d.ts +2 -0
  158. package/dist/api/types/CreditEventLedgerResponseData.d.ts +34 -0
  159. package/dist/api/types/CreditEventType.d.ts +7 -0
  160. package/dist/api/types/CreditsAutoTopupCompanySummary.d.ts +4 -0
  161. package/dist/api/types/CreditsAutoTopupCreditSummary.d.ts +4 -0
  162. package/dist/api/types/CreditsAutoTopupHardFailure.d.ts +7 -0
  163. package/dist/api/types/CreditsAutoTopupRetryFailure.d.ts +8 -0
  164. package/dist/api/types/DeleteBillingPlanCreditGrantRequestBody.d.ts +3 -0
  165. package/dist/api/types/EventDetailResponseData.d.ts +1 -1
  166. package/dist/api/types/EventResponseData.d.ts +1 -1
  167. package/dist/api/types/FeatureCompanyResponseData.d.ts +3 -0
  168. package/dist/api/types/FeatureCompanyUserResponseData.d.ts +1 -0
  169. package/dist/api/types/FeatureEntitlement.d.ts +31 -0
  170. package/dist/api/types/FeatureEntitlementMetricPeriod.d.ts +8 -0
  171. package/dist/api/types/FeatureEntitlementMonthReset.d.ts +6 -0
  172. package/dist/api/types/FeatureUsageLegacyResponseData.d.ts +9 -0
  173. package/dist/api/types/FeatureUsageResponseData.d.ts +3 -0
  174. package/dist/api/types/FeatureUsageTimeSeriesResponseData.d.ts +8 -0
  175. package/dist/api/types/FeatureView.d.ts +21 -0
  176. package/dist/api/types/FlagView.d.ts +17 -0
  177. package/dist/api/types/InvoiceRequestBody.d.ts +2 -0
  178. package/dist/api/types/InvoiceResponseData.d.ts +1 -0
  179. package/dist/api/types/InvoiceStatus.d.ts +8 -0
  180. package/dist/api/types/LimitTimeSeriesPointResponseData.d.ts +9 -0
  181. package/dist/api/types/PlanBundleAction.d.ts +6 -0
  182. package/dist/api/types/PlanBundleCreditGrantRequestBody.d.ts +8 -0
  183. package/dist/api/types/PlanBundleEntitlementRequestBody.d.ts +6 -0
  184. package/dist/api/types/PlanBundleResponseData.d.ts +8 -0
  185. package/dist/api/types/PlanChangeAction.d.ts +1 -0
  186. package/dist/api/types/PlanChangeResponseData.d.ts +4 -2
  187. package/dist/api/types/PlanChangeSubscriptionAction.d.ts +1 -0
  188. package/dist/api/types/PlanCreditGrantView.d.ts +10 -3
  189. package/dist/api/types/PlanDetailResponseData.d.ts +3 -0
  190. package/dist/api/types/PlanGroupDetailResponseData.d.ts +2 -0
  191. package/dist/api/types/PlanGroupPlanDetailResponseData.d.ts +3 -0
  192. package/dist/api/types/PlanGroupResponseData.d.ts +2 -0
  193. package/dist/api/types/PlanVersionCompanyMigrationResponseData.d.ts +14 -0
  194. package/dist/api/types/PlanVersionCompanyMigrationStatus.d.ts +8 -0
  195. package/dist/api/types/PlanVersionMigrationResponseData.d.ts +18 -0
  196. package/dist/api/types/PlanVersionMigrationStatus.d.ts +7 -0
  197. package/dist/api/types/PlanVersionMigrationStrategy.d.ts +5 -0
  198. package/dist/api/types/PlanVersionResponseData.d.ts +14 -0
  199. package/dist/api/types/PlanVersionStatus.d.ts +6 -0
  200. package/dist/api/types/PlanViewPublicResponseData.d.ts +32 -0
  201. package/dist/api/types/PreviewSubscriptionChangeResponseData.d.ts +2 -0
  202. package/dist/api/types/PublicPlansResponseData.d.ts +12 -0
  203. package/dist/api/types/RawEventResponseData.d.ts +1 -1
  204. package/dist/api/types/RuleView.d.ts +16 -0
  205. package/dist/api/types/RulesEngineSchemaVersion.d.ts +1 -1
  206. package/dist/api/types/RulesengineCheckFlagResult.d.ts +1 -0
  207. package/dist/api/types/RulesengineCompany.d.ts +2 -1
  208. package/dist/api/types/RulesengineConditionConditionType.d.ts +1 -1
  209. package/dist/api/types/RulesengineEntitlementValueType.d.ts +9 -0
  210. package/dist/api/types/RulesengineFeatureEntitlement.d.ts +31 -0
  211. package/dist/api/types/RulesengineFeatureEntitlementMetricPeriod.d.ts +8 -0
  212. package/dist/api/types/RulesengineFeatureEntitlementMonthReset.d.ts +6 -0
  213. package/dist/api/types/ScheduledCheckoutResponseData.d.ts +17 -0
  214. package/dist/api/types/ScheduledCheckoutStatus.d.ts +8 -0
  215. package/dist/api/types/ScheduledDowngradeConfigBehavior.d.ts +5 -0
  216. package/dist/api/types/ScheduledDowngradeResponseData.d.ts +13 -0
  217. package/dist/api/types/TimeSeriesGranularity.d.ts +7 -0
  218. package/dist/api/{resources/credits/client/requests → types}/UpdateBillingPlanCreditGrantRequestBody.d.ts +1 -8
  219. package/dist/api/{resources/plans/client/requests → types}/UpdatePlanRequestBody.d.ts +0 -6
  220. package/dist/api/{resources/plans/client/requests → types}/UpsertBillingProductRequestBody.d.ts +1 -8
  221. package/dist/api/types/UpsertCompanyRequestBody.d.ts +1 -0
  222. package/dist/api/types/UsageTimeSeriesPointResponseData.d.ts +6 -0
  223. package/dist/api/types/WebFeatureUsageWebhookOutput.d.ts +10 -0
  224. package/dist/api/types/WebhookRequestType.d.ts +3 -0
  225. package/dist/api/types/WhoAmIResponseData.d.ts +12 -0
  226. package/dist/api/types/index.d.ts +58 -6
  227. package/dist/cache/index.d.ts +3 -0
  228. package/dist/{cache.d.ts → cache/local.d.ts} +9 -10
  229. package/dist/cache/redis.d.ts +38 -0
  230. package/dist/cache/types.d.ts +19 -0
  231. package/dist/datastream/datastream-client.d.ts +239 -0
  232. package/dist/datastream/index.d.ts +2 -0
  233. package/dist/datastream/types.d.ts +48 -0
  234. package/dist/datastream/websocket-client.d.ts +127 -0
  235. package/dist/index.d.ts +4 -2
  236. package/dist/index.js +3 -3
  237. package/dist/rules-engine.d.ts +54 -0
  238. package/dist/serialization/resources/accounts/client/requests/CreateApiKeyRequestBody.d.ts +1 -0
  239. package/dist/serialization/resources/accounts/types/CountAuditLogsParams.d.ts +16 -0
  240. package/dist/serialization/resources/accounts/types/CountAuditLogsResponse.d.ts +12 -0
  241. package/dist/serialization/resources/accounts/types/GetAuditLogResponse.d.ts +11 -0
  242. package/dist/serialization/resources/accounts/types/GetWhoAmIResponse.d.ts +11 -0
  243. package/dist/serialization/resources/accounts/types/ListAuditLogsParams.d.ts +16 -0
  244. package/dist/serialization/resources/accounts/types/ListAuditLogsResponse.d.ts +12 -0
  245. package/dist/serialization/resources/accounts/types/index.d.ts +6 -5
  246. package/dist/serialization/resources/billing/client/requests/CreateBillingCustomerRequestBody.d.ts +0 -1
  247. package/dist/serialization/resources/billing/client/requests/CreateInvoiceRequestBody.d.ts +2 -0
  248. package/dist/serialization/resources/billing/types/CountCustomersParams.d.ts +0 -1
  249. package/dist/serialization/resources/billing/types/ListCustomersWithSubscriptionsParams.d.ts +0 -1
  250. package/dist/serialization/resources/companies/types/CountCompaniesParams.d.ts +13 -0
  251. package/dist/serialization/resources/companies/types/ListCompaniesParams.d.ts +13 -0
  252. package/dist/serialization/resources/companies/types/index.d.ts +0 -4
  253. package/dist/serialization/resources/componentspublic/index.d.ts +1 -0
  254. package/dist/serialization/resources/componentspublic/types/GetPublicPlansResponse.d.ts +11 -0
  255. package/dist/serialization/resources/componentspublic/types/index.d.ts +1 -0
  256. package/dist/serialization/resources/credits/client/requests/index.d.ts +0 -2
  257. package/dist/serialization/resources/credits/types/CountBillingPlanCreditGrantsParams.d.ts +1 -0
  258. package/dist/serialization/resources/credits/types/CountCompanyGrantsParams.d.ts +15 -0
  259. package/dist/serialization/resources/credits/types/CountCompanyGrantsResponse.d.ts +12 -0
  260. package/dist/serialization/resources/credits/types/CountCreditEventLedgerParams.d.ts +17 -0
  261. package/dist/serialization/resources/credits/types/CountCreditEventLedgerResponse.d.ts +12 -0
  262. package/dist/serialization/resources/credits/types/ListBillingPlanCreditGrantsParams.d.ts +1 -0
  263. package/dist/serialization/resources/credits/types/ListCreditEventLedgerParams.d.ts +17 -0
  264. package/dist/serialization/resources/credits/types/ListCreditEventLedgerResponse.d.ts +12 -0
  265. package/dist/serialization/resources/credits/types/index.d.ts +6 -0
  266. package/dist/serialization/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +1 -0
  267. package/dist/serialization/resources/entitlements/types/CountPlanEntitlementsParams.d.ts +2 -0
  268. package/dist/serialization/resources/entitlements/types/GetFeatureUsageTimeSeriesParams.d.ts +14 -0
  269. package/dist/serialization/resources/entitlements/types/GetFeatureUsageTimeSeriesResponse.d.ts +12 -0
  270. package/dist/serialization/resources/entitlements/types/ListPlanEntitlementsParams.d.ts +2 -0
  271. package/dist/serialization/resources/entitlements/types/index.d.ts +2 -0
  272. package/dist/serialization/resources/features/types/CountFeaturesParams.d.ts +1 -0
  273. package/dist/serialization/resources/features/types/ListFeaturesParams.d.ts +1 -0
  274. package/dist/serialization/resources/index.d.ts +10 -0
  275. package/dist/serialization/resources/planbundle/client/index.d.ts +1 -0
  276. package/dist/serialization/resources/planbundle/client/requests/CreatePlanBundleRequestBody.d.ts +18 -0
  277. package/dist/serialization/resources/planbundle/client/requests/UpdatePlanBundleRequestBody.d.ts +19 -0
  278. package/dist/serialization/resources/planbundle/client/requests/index.d.ts +2 -0
  279. package/dist/serialization/resources/planbundle/index.d.ts +2 -0
  280. package/dist/serialization/resources/planbundle/types/CreatePlanBundleResponse.d.ts +11 -0
  281. package/dist/serialization/resources/planbundle/types/UpdatePlanBundleResponse.d.ts +11 -0
  282. package/dist/serialization/resources/planbundle/types/index.d.ts +2 -0
  283. package/dist/serialization/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +5 -0
  284. package/dist/serialization/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +5 -0
  285. package/dist/serialization/resources/planmigrations/index.d.ts +1 -0
  286. package/dist/serialization/resources/planmigrations/types/CountCompanyMigrationsParams.d.ts +14 -0
  287. package/dist/serialization/resources/planmigrations/types/CountCompanyMigrationsResponse.d.ts +12 -0
  288. package/dist/serialization/resources/planmigrations/types/CountMigrationsParams.d.ts +13 -0
  289. package/dist/serialization/resources/planmigrations/types/CountMigrationsResponse.d.ts +12 -0
  290. package/dist/serialization/resources/planmigrations/types/GetMigrationResponse.d.ts +11 -0
  291. package/dist/serialization/resources/planmigrations/types/ListCompanyMigrationsParams.d.ts +14 -0
  292. package/dist/serialization/resources/planmigrations/types/ListCompanyMigrationsResponse.d.ts +12 -0
  293. package/dist/serialization/resources/planmigrations/types/ListMigrationsParams.d.ts +13 -0
  294. package/dist/serialization/resources/planmigrations/types/ListMigrationsResponse.d.ts +12 -0
  295. package/dist/serialization/resources/planmigrations/types/index.d.ts +9 -0
  296. package/dist/serialization/resources/plans/client/requests/PublishPlanVersionRequestBody.d.ts +11 -0
  297. package/dist/serialization/resources/plans/client/requests/index.d.ts +1 -3
  298. package/dist/serialization/resources/plans/types/DeletePlanVersionResponse.d.ts +11 -0
  299. package/dist/serialization/resources/plans/types/GetPlanParams.d.ts +9 -0
  300. package/dist/serialization/resources/plans/types/GetPlanResponse.d.ts +2 -1
  301. package/dist/serialization/resources/plans/types/ListPlanIssuesParams.d.ts +1 -0
  302. package/dist/serialization/resources/plans/types/PublishPlanVersionResponse.d.ts +11 -0
  303. package/dist/serialization/resources/plans/types/index.d.ts +3 -0
  304. package/dist/serialization/resources/scheduledcheckout/client/index.d.ts +1 -0
  305. package/dist/serialization/resources/scheduledcheckout/client/requests/CreateScheduledCheckoutRequest.d.ts +12 -0
  306. package/dist/serialization/resources/scheduledcheckout/client/requests/UpdateScheduledCheckoutRequest.d.ts +11 -0
  307. package/dist/serialization/resources/scheduledcheckout/client/requests/index.d.ts +2 -0
  308. package/dist/serialization/resources/scheduledcheckout/index.d.ts +2 -0
  309. package/dist/serialization/resources/scheduledcheckout/types/CreateScheduledCheckoutResponse.d.ts +11 -0
  310. package/dist/serialization/resources/scheduledcheckout/types/GetScheduledCheckoutResponse.d.ts +11 -0
  311. package/dist/serialization/resources/scheduledcheckout/types/ListScheduledCheckoutsParams.d.ts +13 -0
  312. package/dist/serialization/resources/scheduledcheckout/types/ListScheduledCheckoutsResponse.d.ts +12 -0
  313. package/dist/serialization/resources/scheduledcheckout/types/UpdateScheduledCheckoutResponse.d.ts +11 -0
  314. package/dist/serialization/resources/scheduledcheckout/types/index.d.ts +5 -0
  315. package/dist/serialization/types/ActorType.d.ts +7 -0
  316. package/dist/serialization/types/ApiKeyCreateResponseData.d.ts +1 -0
  317. package/dist/serialization/types/ApiKeyResponseData.d.ts +1 -0
  318. package/dist/serialization/types/{ApiKeyRequestListResponseData.d.ts → AuditLogListResponseData.d.ts} +5 -5
  319. package/dist/serialization/types/{ApiKeyRequestResponseData.d.ts → AuditLogResponseData.d.ts} +5 -7
  320. package/dist/serialization/types/BillingCreditGrantResponseData.d.ts +3 -0
  321. package/dist/serialization/types/BillingCreditResponseData.d.ts +1 -0
  322. package/dist/serialization/types/BillingCreditView.d.ts +32 -0
  323. package/dist/serialization/types/BillingCustomerResponseData.d.ts +0 -1
  324. package/dist/serialization/types/BillingCustomerWithSubscriptionsResponseData.d.ts +0 -1
  325. package/dist/serialization/types/BillingPlanCreditGrantResponseData.d.ts +7 -2
  326. package/dist/serialization/types/CheckFlagResponseData.d.ts +2 -0
  327. package/dist/serialization/types/CompanyDetailResponseData.d.ts +4 -0
  328. package/dist/serialization/types/CompanyPlanDetailResponseData.d.ts +4 -0
  329. package/dist/serialization/types/CompanyPlanWithBillingSubView.d.ts +1 -0
  330. package/dist/serialization/types/ComponentDisplaySettings.d.ts +2 -0
  331. package/dist/serialization/types/ComponentHydrateResponseData.d.ts +2 -0
  332. package/dist/serialization/types/ComponentPreviewResponseData.d.ts +2 -0
  333. package/dist/serialization/types/ComponentSettingsResponseData.d.ts +2 -0
  334. package/dist/serialization/types/ConditionConditionType.d.ts +1 -1
  335. package/dist/serialization/types/ConditionGroupResponseData.d.ts +16 -0
  336. package/dist/serialization/types/ConditionGroupView.d.ts +18 -0
  337. package/dist/serialization/types/ConditionResponseData.d.ts +34 -0
  338. package/dist/serialization/types/ConditionView.d.ts +43 -0
  339. package/dist/serialization/{resources/credits/client/requests → types}/CreateBillingPlanCreditGrantRequestBody.d.ts +11 -10
  340. package/dist/serialization/types/CreateEntitlementInBundleRequestBody.d.ts +41 -0
  341. package/dist/serialization/types/CreateEntitlementInBundleRequestBodyMetricPeriod.d.ts +7 -0
  342. package/dist/serialization/types/CreateEntitlementInBundleRequestBodyMetricPeriodMonthReset.d.ts +7 -0
  343. package/dist/serialization/types/CreatePlanRequestBody.d.ts +13 -0
  344. package/dist/serialization/types/CreditCompanyGrantView.d.ts +3 -0
  345. package/dist/serialization/types/CreditEventLedgerResponseData.d.ts +47 -0
  346. package/dist/serialization/types/CreditEventType.d.ts +7 -0
  347. package/dist/serialization/types/CreditsAutoTopupCompanySummary.d.ts +10 -0
  348. package/dist/serialization/types/CreditsAutoTopupCreditSummary.d.ts +10 -0
  349. package/dist/serialization/types/CreditsAutoTopupHardFailure.d.ts +14 -0
  350. package/dist/serialization/types/CreditsAutoTopupRetryFailure.d.ts +15 -0
  351. package/dist/serialization/types/DeleteBillingPlanCreditGrantRequestBody.d.ts +9 -0
  352. package/dist/serialization/types/EventDetailResponseData.d.ts +1 -1
  353. package/dist/serialization/types/EventResponseData.d.ts +1 -1
  354. package/dist/serialization/types/FeatureEntitlement.d.ts +25 -0
  355. package/dist/serialization/types/FeatureEntitlementMetricPeriod.d.ts +7 -0
  356. package/dist/serialization/types/FeatureEntitlementMonthReset.d.ts +7 -0
  357. package/dist/serialization/types/FeatureUsageLegacyResponseData.d.ts +16 -0
  358. package/dist/serialization/types/FeatureUsageTimeSeriesResponseData.d.ts +16 -0
  359. package/dist/serialization/types/FeatureView.d.ts +32 -0
  360. package/dist/serialization/types/FlagView.d.ts +25 -0
  361. package/dist/serialization/types/InvoiceRequestBody.d.ts +2 -0
  362. package/dist/serialization/types/InvoiceResponseData.d.ts +2 -0
  363. package/dist/serialization/types/InvoiceStatus.d.ts +7 -0
  364. package/dist/serialization/types/LimitTimeSeriesPointResponseData.d.ts +16 -0
  365. package/dist/serialization/types/PlanBundleAction.d.ts +7 -0
  366. package/dist/serialization/types/PlanBundleCreditGrantRequestBody.d.ts +17 -0
  367. package/dist/serialization/types/PlanBundleEntitlementRequestBody.d.ts +13 -0
  368. package/dist/serialization/types/PlanBundleResponseData.d.ts +18 -0
  369. package/dist/serialization/types/PlanChangeAction.d.ts +1 -1
  370. package/dist/serialization/types/PlanChangeResponseData.d.ts +4 -4
  371. package/dist/serialization/types/PlanChangeSubscriptionAction.d.ts +1 -1
  372. package/dist/serialization/types/PlanCreditGrantView.d.ts +7 -3
  373. package/dist/serialization/types/PlanDetailResponseData.d.ts +4 -0
  374. package/dist/serialization/types/PlanGroupDetailResponseData.d.ts +2 -0
  375. package/dist/serialization/types/PlanGroupPlanDetailResponseData.d.ts +4 -0
  376. package/dist/serialization/types/PlanGroupResponseData.d.ts +2 -0
  377. package/dist/serialization/types/PlanVersionCompanyMigrationResponseData.d.ts +20 -0
  378. package/dist/serialization/types/PlanVersionCompanyMigrationStatus.d.ts +7 -0
  379. package/dist/serialization/types/PlanVersionMigrationResponseData.d.ts +25 -0
  380. package/dist/serialization/types/PlanVersionMigrationStatus.d.ts +7 -0
  381. package/dist/serialization/types/PlanVersionMigrationStrategy.d.ts +7 -0
  382. package/dist/serialization/types/PlanVersionResponseData.d.ts +21 -0
  383. package/dist/serialization/types/PlanVersionStatus.d.ts +7 -0
  384. package/dist/serialization/types/PlanViewPublicResponseData.d.ts +47 -0
  385. package/dist/serialization/types/PreviewSubscriptionChangeResponseData.d.ts +2 -0
  386. package/dist/serialization/types/PublicPlansResponseData.d.ts +21 -0
  387. package/dist/serialization/types/RawEventResponseData.d.ts +1 -1
  388. package/dist/serialization/types/RuleView.d.ts +23 -0
  389. package/dist/serialization/types/RulesEngineSchemaVersion.d.ts +1 -1
  390. package/dist/serialization/types/RulesengineCheckFlagResult.d.ts +2 -0
  391. package/dist/serialization/types/RulesengineCompany.d.ts +3 -1
  392. package/dist/serialization/types/RulesengineConditionConditionType.d.ts +1 -1
  393. package/dist/serialization/types/RulesengineEntitlementValueType.d.ts +7 -0
  394. package/dist/serialization/types/RulesengineFeatureEntitlement.d.ts +25 -0
  395. package/dist/serialization/types/RulesengineFeatureEntitlementMetricPeriod.d.ts +7 -0
  396. package/dist/serialization/types/RulesengineFeatureEntitlementMonthReset.d.ts +7 -0
  397. package/dist/serialization/types/ScheduledCheckoutResponseData.d.ts +23 -0
  398. package/dist/serialization/types/ScheduledCheckoutStatus.d.ts +7 -0
  399. package/dist/serialization/types/ScheduledDowngradeConfigBehavior.d.ts +7 -0
  400. package/dist/serialization/types/ScheduledDowngradeResponseData.d.ts +19 -0
  401. package/dist/serialization/types/TimeSeriesGranularity.d.ts +7 -0
  402. package/dist/serialization/{resources/credits/client/requests → types}/UpdateBillingPlanCreditGrantRequestBody.d.ts +10 -10
  403. package/dist/serialization/types/UpdatePlanRequestBody.d.ts +11 -0
  404. package/dist/serialization/{resources/plans/client/requests → types}/UpsertBillingProductRequestBody.d.ts +5 -5
  405. package/dist/serialization/types/UpsertCompanyRequestBody.d.ts +1 -0
  406. package/dist/serialization/types/UsageTimeSeriesPointResponseData.d.ts +12 -0
  407. package/dist/serialization/types/WebFeatureUsageWebhookOutput.d.ts +18 -0
  408. package/dist/serialization/types/WebhookRequestType.d.ts +1 -1
  409. package/dist/serialization/types/WhoAmIResponseData.d.ts +18 -0
  410. package/dist/serialization/types/index.d.ts +58 -6
  411. package/dist/wrapper.d.ts +58 -5
  412. package/package.json +4 -2
  413. package/dist/api/resources/accounts/client/requests/CountApiRequestsRequest.d.ts +0 -19
  414. package/dist/api/resources/accounts/client/requests/ListApiRequestsRequest.d.ts +0 -19
  415. package/dist/api/resources/accounts/types/ListApiRequestsResponse.d.ts +0 -6
  416. package/dist/api/resources/companies/client/requests/CountCompaniesForAdvancedFilterRequest.d.ts +0 -46
  417. package/dist/api/resources/companies/client/requests/ListCompaniesForAdvancedFilterRequest.d.ts +0 -46
  418. package/dist/api/resources/companies/types/CountCompaniesForAdvancedFilterParams.d.ts +0 -35
  419. package/dist/api/resources/companies/types/CountCompaniesForAdvancedFilterResponse.d.ts +0 -6
  420. package/dist/api/resources/companies/types/ListCompaniesForAdvancedFilterParams.d.ts +0 -35
  421. package/dist/api/resources/companies/types/ListCompaniesForAdvancedFilterResponse.d.ts +0 -6
  422. package/dist/api/resources/plans/client/requests/CreatePlanRequestBody.d.ts +0 -15
  423. package/dist/api/types/CompanyViewWithFeatureUsageResponseData.d.ts +0 -26
  424. package/dist/api/types/CreditUsageResponseData.d.ts +0 -12
  425. package/dist/api/types/FeatureUsageDataResponseData.d.ts +0 -19
  426. package/dist/serialization/resources/accounts/types/CountApiRequestsParams.d.ts +0 -13
  427. package/dist/serialization/resources/accounts/types/CountApiRequestsResponse.d.ts +0 -12
  428. package/dist/serialization/resources/accounts/types/GetApiRequestResponse.d.ts +0 -11
  429. package/dist/serialization/resources/accounts/types/ListApiRequestsParams.d.ts +0 -13
  430. package/dist/serialization/resources/accounts/types/ListApiRequestsResponse.d.ts +0 -12
  431. package/dist/serialization/resources/companies/types/CountCompaniesForAdvancedFilterParams.d.ts +0 -26
  432. package/dist/serialization/resources/companies/types/CountCompaniesForAdvancedFilterResponse.d.ts +0 -12
  433. package/dist/serialization/resources/companies/types/ListCompaniesForAdvancedFilterParams.d.ts +0 -26
  434. package/dist/serialization/resources/companies/types/ListCompaniesForAdvancedFilterResponse.d.ts +0 -12
  435. package/dist/serialization/resources/plans/client/requests/CreatePlanRequestBody.d.ts +0 -13
  436. package/dist/serialization/resources/plans/client/requests/UpdatePlanRequestBody.d.ts +0 -11
  437. package/dist/serialization/types/CompanyViewWithFeatureUsageResponseData.d.ts +0 -39
  438. package/dist/serialization/types/CreditUsageResponseData.d.ts +0 -17
  439. package/dist/serialization/types/FeatureUsageDataResponseData.d.ts +0 -27
  440. package/dist/serialization/types/PlanChangeActorType.d.ts +0 -7
@@ -1,6 +0,0 @@
1
- import type * as Schematic from "../../../index";
2
- export interface ListApiRequestsResponse {
3
- data: Schematic.ApiKeyRequestListResponseData[];
4
- /** Input parameters */
5
- params: Schematic.ListApiRequestsParams;
6
- }
@@ -1,46 +0,0 @@
1
- import type * as Schematic from "../../../../index";
2
- /**
3
- * @example
4
- * {
5
- * monetizedSubscriptions: true,
6
- * q: "q",
7
- * withoutPlan: true,
8
- * withoutSubscription: true,
9
- * sortOrderColumn: "sort_order_column",
10
- * sortOrderDirection: "asc",
11
- * limit: 1,
12
- * offset: 1
13
- * }
14
- */
15
- export interface CountCompaniesForAdvancedFilterRequest {
16
- /** Filter companies by multiple company IDs (starts with comp_) */
17
- ids?: string | string[];
18
- /** Filter companies by one or more plan IDs (each ID starts with plan_) */
19
- planIds?: string | string[];
20
- /** Filter companies by one or more feature IDs (each ID starts with feat_) */
21
- featureIds?: string | string[];
22
- /** Filter companies by one or more credit type IDs (each ID starts with bcrd_) */
23
- creditTypeIds?: string | string[];
24
- /** Filter companies by one or more subscription statuses (active, canceled, expired, incomplete, incomplete_expired, past_due, paused, trialing, unpaid) */
25
- subscriptionStatuses?: Schematic.SubscriptionStatus | Schematic.SubscriptionStatus[];
26
- /** Filter companies by one or more subscription types (paid, free, trial) */
27
- subscriptionTypes?: Schematic.SubscriptionType | Schematic.SubscriptionType[];
28
- /** Filter companies that have monetized subscriptions */
29
- monetizedSubscriptions?: boolean;
30
- /** Search for companies by name, keys or string traits */
31
- q?: string;
32
- /** Filter out companies that have a plan */
33
- withoutPlan?: boolean;
34
- /** Filter out companies that have a subscription */
35
- withoutSubscription?: boolean;
36
- /** Column to sort by (e.g. name, created_at, last_seen_at) */
37
- sortOrderColumn?: string;
38
- /** Direction to sort by (asc or desc) */
39
- sortOrderDirection?: Schematic.SortDirection;
40
- /** Select the display columns to return (e.g. plan, subscription, users, last_seen_at) */
41
- displayProperties?: string | string[];
42
- /** Page limit (default 100) */
43
- limit?: number;
44
- /** Page offset (default 0) */
45
- offset?: number;
46
- }
@@ -1,46 +0,0 @@
1
- import type * as Schematic from "../../../../index";
2
- /**
3
- * @example
4
- * {
5
- * monetizedSubscriptions: true,
6
- * q: "q",
7
- * withoutPlan: true,
8
- * withoutSubscription: true,
9
- * sortOrderColumn: "sort_order_column",
10
- * sortOrderDirection: "asc",
11
- * limit: 1,
12
- * offset: 1
13
- * }
14
- */
15
- export interface ListCompaniesForAdvancedFilterRequest {
16
- /** Filter companies by multiple company IDs (starts with comp_) */
17
- ids?: string | string[];
18
- /** Filter companies by one or more plan IDs (each ID starts with plan_) */
19
- planIds?: string | string[];
20
- /** Filter companies by one or more feature IDs (each ID starts with feat_) */
21
- featureIds?: string | string[];
22
- /** Filter companies by one or more credit type IDs (each ID starts with bcrd_) */
23
- creditTypeIds?: string | string[];
24
- /** Filter companies by one or more subscription statuses (active, canceled, expired, incomplete, incomplete_expired, past_due, paused, trialing, unpaid) */
25
- subscriptionStatuses?: Schematic.SubscriptionStatus | Schematic.SubscriptionStatus[];
26
- /** Filter companies by one or more subscription types (paid, free, trial) */
27
- subscriptionTypes?: Schematic.SubscriptionType | Schematic.SubscriptionType[];
28
- /** Filter companies that have monetized subscriptions */
29
- monetizedSubscriptions?: boolean;
30
- /** Search for companies by name, keys or string traits */
31
- q?: string;
32
- /** Filter out companies that have a plan */
33
- withoutPlan?: boolean;
34
- /** Filter out companies that have a subscription */
35
- withoutSubscription?: boolean;
36
- /** Column to sort by (e.g. name, created_at, last_seen_at) */
37
- sortOrderColumn?: string;
38
- /** Direction to sort by (asc or desc) */
39
- sortOrderDirection?: Schematic.SortDirection;
40
- /** Select the display columns to return (e.g. plan, subscription, users, last_seen_at) */
41
- displayProperties?: string | string[];
42
- /** Page limit (default 100) */
43
- limit?: number;
44
- /** Page offset (default 0) */
45
- offset?: number;
46
- }
@@ -1,35 +0,0 @@
1
- import type * as Schematic from "../../../index";
2
- /**
3
- * Input parameters
4
- */
5
- export interface CountCompaniesForAdvancedFilterParams {
6
- /** Filter companies by one or more credit type IDs (each ID starts with bcrd_) */
7
- creditTypeIds?: string[];
8
- /** Select the display columns to return (e.g. plan, subscription, users, last_seen_at) */
9
- displayProperties?: string[];
10
- /** Filter companies by one or more feature IDs (each ID starts with feat_) */
11
- featureIds?: string[];
12
- /** Filter companies by multiple company IDs (starts with comp_) */
13
- ids?: string[];
14
- /** Page limit (default 100) */
15
- limit?: number;
16
- /** Filter companies that have monetized subscriptions */
17
- monetizedSubscriptions?: boolean;
18
- /** Page offset (default 0) */
19
- offset?: number;
20
- /** Filter companies by one or more plan IDs (each ID starts with plan_) */
21
- planIds?: string[];
22
- /** Search for companies by name, keys or string traits */
23
- q?: string;
24
- /** Column to sort by (e.g. name, created_at, last_seen_at) */
25
- sortOrderColumn?: string;
26
- sortOrderDirection?: Schematic.SortDirection;
27
- /** Filter companies by one or more subscription statuses (active, canceled, expired, incomplete, incomplete_expired, past_due, paused, trialing, unpaid) */
28
- subscriptionStatuses?: Schematic.SubscriptionStatus[];
29
- /** Filter companies by one or more subscription types (paid, free, trial) */
30
- subscriptionTypes?: Schematic.SubscriptionType[];
31
- /** Filter out companies that have a plan */
32
- withoutPlan?: boolean;
33
- /** Filter out companies that have a subscription */
34
- withoutSubscription?: boolean;
35
- }
@@ -1,6 +0,0 @@
1
- import type * as Schematic from "../../../index";
2
- export interface CountCompaniesForAdvancedFilterResponse {
3
- data: Schematic.CountResponse;
4
- /** Input parameters */
5
- params: Schematic.CountCompaniesForAdvancedFilterParams;
6
- }
@@ -1,35 +0,0 @@
1
- import type * as Schematic from "../../../index";
2
- /**
3
- * Input parameters
4
- */
5
- export interface ListCompaniesForAdvancedFilterParams {
6
- /** Filter companies by one or more credit type IDs (each ID starts with bcrd_) */
7
- creditTypeIds?: string[];
8
- /** Select the display columns to return (e.g. plan, subscription, users, last_seen_at) */
9
- displayProperties?: string[];
10
- /** Filter companies by one or more feature IDs (each ID starts with feat_) */
11
- featureIds?: string[];
12
- /** Filter companies by multiple company IDs (starts with comp_) */
13
- ids?: string[];
14
- /** Page limit (default 100) */
15
- limit?: number;
16
- /** Filter companies that have monetized subscriptions */
17
- monetizedSubscriptions?: boolean;
18
- /** Page offset (default 0) */
19
- offset?: number;
20
- /** Filter companies by one or more plan IDs (each ID starts with plan_) */
21
- planIds?: string[];
22
- /** Search for companies by name, keys or string traits */
23
- q?: string;
24
- /** Column to sort by (e.g. name, created_at, last_seen_at) */
25
- sortOrderColumn?: string;
26
- sortOrderDirection?: Schematic.SortDirection;
27
- /** Filter companies by one or more subscription statuses (active, canceled, expired, incomplete, incomplete_expired, past_due, paused, trialing, unpaid) */
28
- subscriptionStatuses?: Schematic.SubscriptionStatus[];
29
- /** Filter companies by one or more subscription types (paid, free, trial) */
30
- subscriptionTypes?: Schematic.SubscriptionType[];
31
- /** Filter out companies that have a plan */
32
- withoutPlan?: boolean;
33
- /** Filter out companies that have a subscription */
34
- withoutSubscription?: boolean;
35
- }
@@ -1,6 +0,0 @@
1
- import type * as Schematic from "../../../index";
2
- export interface ListCompaniesForAdvancedFilterResponse {
3
- data: Schematic.CompanyViewWithFeatureUsageResponseData[];
4
- /** Input parameters */
5
- params: Schematic.ListCompaniesForAdvancedFilterParams;
6
- }
@@ -1,15 +0,0 @@
1
- import type * as Schematic from "../../../../index";
2
- /**
3
- * @example
4
- * {
5
- * description: "description",
6
- * name: "name",
7
- * planType: "plan"
8
- * }
9
- */
10
- export interface CreatePlanRequestBody {
11
- description: string;
12
- icon?: string;
13
- name: string;
14
- planType: Schematic.PlanType;
15
- }
@@ -1,26 +0,0 @@
1
- import type * as Schematic from "../index";
2
- export interface CompanyViewWithFeatureUsageResponseData {
3
- addOns: Schematic.CompanyPlanWithBillingSubView[];
4
- billingCreditBalances?: Record<string, number>;
5
- billingSubscription?: Schematic.BillingSubscriptionView;
6
- billingSubscriptions: Schematic.BillingSubscriptionView[];
7
- createdAt: Date;
8
- defaultPaymentMethod?: Schematic.PaymentMethodResponseData;
9
- entityTraits: Schematic.EntityTraitDetailResponseData[];
10
- environmentId: string;
11
- featureUsage: Schematic.FeatureUsageDataResponseData[];
12
- id: string;
13
- keys: Schematic.EntityKeyDetailResponseData[];
14
- lastSeenAt?: Date;
15
- logoUrl?: string;
16
- metrics: Schematic.CompanyEventPeriodMetricsResponseData[];
17
- name: string;
18
- paymentMethods: Schematic.PaymentMethodResponseData[];
19
- plan?: Schematic.CompanyPlanWithBillingSubView;
20
- plans: Schematic.GenericPreviewObject[];
21
- rules: Schematic.Rule[];
22
- /** A map of trait names to trait values */
23
- traits?: Record<string, unknown>;
24
- updatedAt: Date;
25
- userCount: number;
26
- }
@@ -1,12 +0,0 @@
1
- import type * as Schematic from "../index";
2
- export interface CreditUsageResponseData {
3
- creditConsumptionRate?: number;
4
- creditGrantCounts?: Record<string, number>;
5
- creditGrantDetails: Schematic.CreditGrantDetail[];
6
- creditRemaining?: number;
7
- /** Deprecated: Use credit_remaining instead. */
8
- creditTotal?: number;
9
- creditTypeIcon?: string;
10
- creditTypeName?: string;
11
- creditUsed?: number;
12
- }
@@ -1,19 +0,0 @@
1
- import type * as Schematic from "../index";
2
- export interface FeatureUsageDataResponseData {
3
- creditTypeId?: string;
4
- creditUsage?: Schematic.CreditUsageResponseData;
5
- entitlementSource: string;
6
- entitlementValueType: string;
7
- featureId: string;
8
- featureName: string;
9
- featureType: Schematic.FeatureType;
10
- hardLimit: string;
11
- hasAccess: boolean;
12
- metricResetAt?: Date;
13
- monthlyUsageBasedPrice?: Schematic.BillingPriceView;
14
- priceBehavior?: string;
15
- softLimit: string;
16
- usage: string;
17
- valueNumeric?: number;
18
- yearlyUsageBasedPrice?: Schematic.BillingPriceView;
19
- }
@@ -1,13 +0,0 @@
1
- import type * as Schematic from "../../../../api/index";
2
- import * as core from "../../../../core";
3
- import type * as serializers from "../../../index";
4
- export declare const CountApiRequestsParams: core.serialization.ObjectSchema<serializers.CountApiRequestsParams.Raw, Schematic.CountApiRequestsParams>;
5
- export declare namespace CountApiRequestsParams {
6
- interface Raw {
7
- environment_id?: string | null;
8
- limit?: number | null;
9
- offset?: number | null;
10
- q?: string | null;
11
- request_type?: string | null;
12
- }
13
- }
@@ -1,12 +0,0 @@
1
- import type * as Schematic from "../../../../api/index";
2
- import * as core from "../../../../core";
3
- import type * as serializers from "../../../index";
4
- import { CountResponse } from "../../../types/CountResponse";
5
- import { CountApiRequestsParams } from "./CountApiRequestsParams";
6
- export declare const CountApiRequestsResponse: core.serialization.ObjectSchema<serializers.CountApiRequestsResponse.Raw, Schematic.CountApiRequestsResponse>;
7
- export declare namespace CountApiRequestsResponse {
8
- interface Raw {
9
- data: CountResponse.Raw;
10
- params: CountApiRequestsParams.Raw;
11
- }
12
- }
@@ -1,11 +0,0 @@
1
- import type * as Schematic from "../../../../api/index";
2
- import * as core from "../../../../core";
3
- import type * as serializers from "../../../index";
4
- import { ApiKeyRequestResponseData } from "../../../types/ApiKeyRequestResponseData";
5
- export declare const GetApiRequestResponse: core.serialization.ObjectSchema<serializers.GetApiRequestResponse.Raw, Schematic.GetApiRequestResponse>;
6
- export declare namespace GetApiRequestResponse {
7
- interface Raw {
8
- data: ApiKeyRequestResponseData.Raw;
9
- params: Record<string, unknown>;
10
- }
11
- }
@@ -1,13 +0,0 @@
1
- import type * as Schematic from "../../../../api/index";
2
- import * as core from "../../../../core";
3
- import type * as serializers from "../../../index";
4
- export declare const ListApiRequestsParams: core.serialization.ObjectSchema<serializers.ListApiRequestsParams.Raw, Schematic.ListApiRequestsParams>;
5
- export declare namespace ListApiRequestsParams {
6
- interface Raw {
7
- environment_id?: string | null;
8
- limit?: number | null;
9
- offset?: number | null;
10
- q?: string | null;
11
- request_type?: string | null;
12
- }
13
- }
@@ -1,12 +0,0 @@
1
- import type * as Schematic from "../../../../api/index";
2
- import * as core from "../../../../core";
3
- import type * as serializers from "../../../index";
4
- import { ApiKeyRequestListResponseData } from "../../../types/ApiKeyRequestListResponseData";
5
- import { ListApiRequestsParams } from "./ListApiRequestsParams";
6
- export declare const ListApiRequestsResponse: core.serialization.ObjectSchema<serializers.ListApiRequestsResponse.Raw, Schematic.ListApiRequestsResponse>;
7
- export declare namespace ListApiRequestsResponse {
8
- interface Raw {
9
- data: ApiKeyRequestListResponseData.Raw[];
10
- params: ListApiRequestsParams.Raw;
11
- }
12
- }
@@ -1,26 +0,0 @@
1
- import type * as Schematic from "../../../../api/index";
2
- import * as core from "../../../../core";
3
- import type * as serializers from "../../../index";
4
- import { SortDirection } from "../../../types/SortDirection";
5
- import { SubscriptionStatus } from "../../../types/SubscriptionStatus";
6
- import { SubscriptionType } from "../../../types/SubscriptionType";
7
- export declare const CountCompaniesForAdvancedFilterParams: core.serialization.ObjectSchema<serializers.CountCompaniesForAdvancedFilterParams.Raw, Schematic.CountCompaniesForAdvancedFilterParams>;
8
- export declare namespace CountCompaniesForAdvancedFilterParams {
9
- interface Raw {
10
- credit_type_ids?: string[] | null;
11
- display_properties?: string[] | null;
12
- feature_ids?: string[] | null;
13
- ids?: string[] | null;
14
- limit?: number | null;
15
- monetized_subscriptions?: boolean | null;
16
- offset?: number | null;
17
- plan_ids?: string[] | null;
18
- q?: string | null;
19
- sort_order_column?: string | null;
20
- sort_order_direction?: SortDirection.Raw | null;
21
- subscription_statuses?: SubscriptionStatus.Raw[] | null;
22
- subscription_types?: SubscriptionType.Raw[] | null;
23
- without_plan?: boolean | null;
24
- without_subscription?: boolean | null;
25
- }
26
- }
@@ -1,12 +0,0 @@
1
- import type * as Schematic from "../../../../api/index";
2
- import * as core from "../../../../core";
3
- import type * as serializers from "../../../index";
4
- import { CountResponse } from "../../../types/CountResponse";
5
- import { CountCompaniesForAdvancedFilterParams } from "./CountCompaniesForAdvancedFilterParams";
6
- export declare const CountCompaniesForAdvancedFilterResponse: core.serialization.ObjectSchema<serializers.CountCompaniesForAdvancedFilterResponse.Raw, Schematic.CountCompaniesForAdvancedFilterResponse>;
7
- export declare namespace CountCompaniesForAdvancedFilterResponse {
8
- interface Raw {
9
- data: CountResponse.Raw;
10
- params: CountCompaniesForAdvancedFilterParams.Raw;
11
- }
12
- }
@@ -1,26 +0,0 @@
1
- import type * as Schematic from "../../../../api/index";
2
- import * as core from "../../../../core";
3
- import type * as serializers from "../../../index";
4
- import { SortDirection } from "../../../types/SortDirection";
5
- import { SubscriptionStatus } from "../../../types/SubscriptionStatus";
6
- import { SubscriptionType } from "../../../types/SubscriptionType";
7
- export declare const ListCompaniesForAdvancedFilterParams: core.serialization.ObjectSchema<serializers.ListCompaniesForAdvancedFilterParams.Raw, Schematic.ListCompaniesForAdvancedFilterParams>;
8
- export declare namespace ListCompaniesForAdvancedFilterParams {
9
- interface Raw {
10
- credit_type_ids?: string[] | null;
11
- display_properties?: string[] | null;
12
- feature_ids?: string[] | null;
13
- ids?: string[] | null;
14
- limit?: number | null;
15
- monetized_subscriptions?: boolean | null;
16
- offset?: number | null;
17
- plan_ids?: string[] | null;
18
- q?: string | null;
19
- sort_order_column?: string | null;
20
- sort_order_direction?: SortDirection.Raw | null;
21
- subscription_statuses?: SubscriptionStatus.Raw[] | null;
22
- subscription_types?: SubscriptionType.Raw[] | null;
23
- without_plan?: boolean | null;
24
- without_subscription?: boolean | null;
25
- }
26
- }
@@ -1,12 +0,0 @@
1
- import type * as Schematic from "../../../../api/index";
2
- import * as core from "../../../../core";
3
- import type * as serializers from "../../../index";
4
- import { CompanyViewWithFeatureUsageResponseData } from "../../../types/CompanyViewWithFeatureUsageResponseData";
5
- import { ListCompaniesForAdvancedFilterParams } from "./ListCompaniesForAdvancedFilterParams";
6
- export declare const ListCompaniesForAdvancedFilterResponse: core.serialization.ObjectSchema<serializers.ListCompaniesForAdvancedFilterResponse.Raw, Schematic.ListCompaniesForAdvancedFilterResponse>;
7
- export declare namespace ListCompaniesForAdvancedFilterResponse {
8
- interface Raw {
9
- data: CompanyViewWithFeatureUsageResponseData.Raw[];
10
- params: ListCompaniesForAdvancedFilterParams.Raw;
11
- }
12
- }
@@ -1,13 +0,0 @@
1
- import type * as Schematic from "../../../../../api/index";
2
- import * as core from "../../../../../core";
3
- import type * as serializers from "../../../../index";
4
- import { PlanType } from "../../../../types/PlanType";
5
- export declare const CreatePlanRequestBody: core.serialization.Schema<serializers.CreatePlanRequestBody.Raw, Schematic.CreatePlanRequestBody>;
6
- export declare namespace CreatePlanRequestBody {
7
- interface Raw {
8
- description: string;
9
- icon?: string | null;
10
- name: string;
11
- plan_type: PlanType.Raw;
12
- }
13
- }
@@ -1,11 +0,0 @@
1
- import type * as Schematic from "../../../../../api/index";
2
- import * as core from "../../../../../core";
3
- import type * as serializers from "../../../../index";
4
- export declare const UpdatePlanRequestBody: core.serialization.Schema<serializers.UpdatePlanRequestBody.Raw, Schematic.UpdatePlanRequestBody>;
5
- export declare namespace UpdatePlanRequestBody {
6
- interface Raw {
7
- description?: string | null;
8
- icon?: string | null;
9
- name: string;
10
- }
11
- }
@@ -1,39 +0,0 @@
1
- import type * as Schematic from "../../api/index";
2
- import * as core from "../../core";
3
- import type * as serializers from "../index";
4
- import { BillingSubscriptionView } from "./BillingSubscriptionView";
5
- import { CompanyEventPeriodMetricsResponseData } from "./CompanyEventPeriodMetricsResponseData";
6
- import { CompanyPlanWithBillingSubView } from "./CompanyPlanWithBillingSubView";
7
- import { EntityKeyDetailResponseData } from "./EntityKeyDetailResponseData";
8
- import { EntityTraitDetailResponseData } from "./EntityTraitDetailResponseData";
9
- import { FeatureUsageDataResponseData } from "./FeatureUsageDataResponseData";
10
- import { GenericPreviewObject } from "./GenericPreviewObject";
11
- import { PaymentMethodResponseData } from "./PaymentMethodResponseData";
12
- import { Rule } from "./Rule";
13
- export declare const CompanyViewWithFeatureUsageResponseData: core.serialization.ObjectSchema<serializers.CompanyViewWithFeatureUsageResponseData.Raw, Schematic.CompanyViewWithFeatureUsageResponseData>;
14
- export declare namespace CompanyViewWithFeatureUsageResponseData {
15
- interface Raw {
16
- add_ons: CompanyPlanWithBillingSubView.Raw[];
17
- billing_credit_balances?: Record<string, number> | null;
18
- billing_subscription?: BillingSubscriptionView.Raw | null;
19
- billing_subscriptions: BillingSubscriptionView.Raw[];
20
- created_at: string;
21
- default_payment_method?: PaymentMethodResponseData.Raw | null;
22
- entity_traits: EntityTraitDetailResponseData.Raw[];
23
- environment_id: string;
24
- feature_usage: FeatureUsageDataResponseData.Raw[];
25
- id: string;
26
- keys: EntityKeyDetailResponseData.Raw[];
27
- last_seen_at?: string | null;
28
- logo_url?: string | null;
29
- metrics: CompanyEventPeriodMetricsResponseData.Raw[];
30
- name: string;
31
- payment_methods: PaymentMethodResponseData.Raw[];
32
- plan?: CompanyPlanWithBillingSubView.Raw | null;
33
- plans: GenericPreviewObject.Raw[];
34
- rules: Rule.Raw[];
35
- traits?: Record<string, unknown> | null;
36
- updated_at: string;
37
- user_count: number;
38
- }
39
- }
@@ -1,17 +0,0 @@
1
- import type * as Schematic from "../../api/index";
2
- import * as core from "../../core";
3
- import type * as serializers from "../index";
4
- import { CreditGrantDetail } from "./CreditGrantDetail";
5
- export declare const CreditUsageResponseData: core.serialization.ObjectSchema<serializers.CreditUsageResponseData.Raw, Schematic.CreditUsageResponseData>;
6
- export declare namespace CreditUsageResponseData {
7
- interface Raw {
8
- credit_consumption_rate?: number | null;
9
- credit_grant_counts?: Record<string, number> | null;
10
- credit_grant_details: CreditGrantDetail.Raw[];
11
- credit_remaining?: number | null;
12
- credit_total?: number | null;
13
- credit_type_icon?: string | null;
14
- credit_type_name?: string | null;
15
- credit_used?: number | null;
16
- }
17
- }
@@ -1,27 +0,0 @@
1
- import type * as Schematic from "../../api/index";
2
- import * as core from "../../core";
3
- import type * as serializers from "../index";
4
- import { BillingPriceView } from "./BillingPriceView";
5
- import { CreditUsageResponseData } from "./CreditUsageResponseData";
6
- import { FeatureType } from "./FeatureType";
7
- export declare const FeatureUsageDataResponseData: core.serialization.ObjectSchema<serializers.FeatureUsageDataResponseData.Raw, Schematic.FeatureUsageDataResponseData>;
8
- export declare namespace FeatureUsageDataResponseData {
9
- interface Raw {
10
- credit_type_id?: string | null;
11
- credit_usage?: CreditUsageResponseData.Raw | null;
12
- entitlement_source: string;
13
- entitlement_value_type: string;
14
- feature_id: string;
15
- feature_name: string;
16
- feature_type: FeatureType.Raw;
17
- hard_limit: string;
18
- has_access: boolean;
19
- metric_reset_at?: string | null;
20
- monthly_usage_based_price?: BillingPriceView.Raw | null;
21
- price_behavior?: string | null;
22
- soft_limit: string;
23
- usage: string;
24
- value_numeric?: number | null;
25
- yearly_usage_based_price?: BillingPriceView.Raw | null;
26
- }
27
- }
@@ -1,7 +0,0 @@
1
- import type * as Schematic from "../../api/index";
2
- import * as core from "../../core";
3
- import type * as serializers from "../index";
4
- export declare const PlanChangeActorType: core.serialization.Schema<serializers.PlanChangeActorType.Raw, Schematic.PlanChangeActorType>;
5
- export declare namespace PlanChangeActorType {
6
- type Raw = "api_key" | "app_user" | "system" | "temporary_access_token";
7
- }