@schematichq/schematic-typescript-node 1.2.1 → 1.2.3

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 (368) hide show
  1. package/README.md +114 -0
  2. package/dist/Client.d.ts +2 -2
  3. package/dist/api/resources/accesstokens/client/Client.d.ts +3 -3
  4. package/dist/api/resources/accesstokens/client/requests/IssueTemporaryAccessTokenRequestBody.d.ts +1 -3
  5. package/dist/api/resources/accounts/client/Client.d.ts +29 -8
  6. package/dist/api/resources/accounts/client/requests/CountApiKeysRequest.d.ts +4 -1
  7. package/dist/api/resources/accounts/client/requests/CountApiRequestsRequest.d.ts +7 -1
  8. package/dist/api/resources/accounts/client/requests/ListApiKeysRequest.d.ts +4 -1
  9. package/dist/api/resources/accounts/client/requests/ListApiRequestsRequest.d.ts +7 -1
  10. package/dist/api/resources/accounts/client/requests/ListEnvironmentsRequest.d.ts +4 -1
  11. package/dist/api/resources/accounts/types/ListApiKeysResponse.d.ts +0 -1
  12. package/dist/api/resources/accounts/types/ListApiRequestsResponse.d.ts +0 -1
  13. package/dist/api/resources/accounts/types/ListEnvironmentsResponse.d.ts +0 -1
  14. package/dist/api/resources/billing/client/Client.d.ts +87 -15
  15. package/dist/api/resources/billing/client/requests/CountBillingProductsRequest.d.ts +12 -1
  16. package/dist/api/resources/billing/client/requests/CountCustomersRequest.d.ts +7 -1
  17. package/dist/api/resources/billing/client/requests/{CreateBillingSubscriptionsRequestBody.d.ts → CreateBillingSubscriptionRequestBody.d.ts} +3 -2
  18. package/dist/api/resources/billing/client/requests/ListBillingProductsRequest.d.ts +12 -1
  19. package/dist/api/resources/billing/client/requests/ListCouponsRequest.d.ts +6 -1
  20. package/dist/api/resources/billing/client/requests/ListCustomersWithSubscriptionsRequest.d.ts +7 -1
  21. package/dist/api/resources/billing/client/requests/ListInvoicesRequest.d.ts +4 -1
  22. package/dist/api/resources/billing/client/requests/ListMetersRequest.d.ts +5 -1
  23. package/dist/api/resources/billing/client/requests/ListPaymentMethodsRequest.d.ts +4 -1
  24. package/dist/api/resources/billing/client/requests/ListProductPricesRequest.d.ts +12 -1
  25. package/dist/api/resources/billing/client/requests/SearchBillingPricesRequest.d.ts +28 -3
  26. package/dist/api/resources/billing/client/requests/index.d.ts +1 -1
  27. package/dist/api/resources/billing/types/CreateBillingSubscriptionRequestBodyTrialEndSetting.d.ts +8 -0
  28. package/dist/api/resources/billing/types/ListBillingProductsResponse.d.ts +0 -1
  29. package/dist/api/resources/billing/types/ListCouponsResponse.d.ts +0 -1
  30. package/dist/api/resources/billing/types/ListCustomersWithSubscriptionsResponse.d.ts +0 -1
  31. package/dist/api/resources/billing/types/ListInvoicesResponse.d.ts +0 -1
  32. package/dist/api/resources/billing/types/ListMetersResponse.d.ts +0 -1
  33. package/dist/api/resources/billing/types/ListPaymentMethodsResponse.d.ts +0 -1
  34. package/dist/api/resources/billing/types/ListProductPricesResponse.d.ts +0 -1
  35. package/dist/api/resources/billing/types/SearchBillingPricesParams.d.ts +7 -0
  36. package/dist/api/resources/billing/types/SearchBillingPricesResponse.d.ts +0 -1
  37. package/dist/api/resources/billing/types/index.d.ts +2 -2
  38. package/dist/api/resources/checkout/client/Client.d.ts +59 -3
  39. package/dist/api/resources/checkout/types/CheckoutInternalResponse.d.ts +1 -1
  40. package/dist/api/resources/checkout/types/ManagePlanResponse.d.ts +9 -0
  41. package/dist/api/resources/checkout/types/PreviewManagePlanResponse.d.ts +9 -0
  42. package/dist/api/resources/checkout/types/index.d.ts +2 -0
  43. package/dist/api/resources/companies/client/Client.d.ts +132 -19
  44. package/dist/api/resources/companies/client/requests/CountCompaniesForAdvancedFilterRequest.d.ts +15 -2
  45. package/dist/api/resources/companies/client/requests/CountCompaniesRequest.d.ts +9 -1
  46. package/dist/api/resources/companies/client/requests/CountEntityKeyDefinitionsRequest.d.ts +6 -1
  47. package/dist/api/resources/companies/client/requests/CountEntityTraitDefinitionsRequest.d.ts +7 -1
  48. package/dist/api/resources/companies/client/requests/CountPlanTraitsRequest.d.ts +6 -1
  49. package/dist/api/resources/companies/client/requests/CountUsersRequest.d.ts +7 -1
  50. package/dist/api/resources/companies/client/requests/GetActiveCompanySubscriptionRequest.d.ts +5 -1
  51. package/dist/api/resources/companies/client/requests/GetActiveDealsRequest.d.ts +3 -1
  52. package/dist/api/resources/companies/client/requests/GetEntityTraitValuesRequest.d.ts +4 -1
  53. package/dist/api/resources/companies/client/requests/ListCompaniesForAdvancedFilterRequest.d.ts +15 -2
  54. package/dist/api/resources/companies/client/requests/ListCompaniesRequest.d.ts +9 -1
  55. package/dist/api/resources/companies/client/requests/ListCompanyMembershipsRequest.d.ts +6 -1
  56. package/dist/api/resources/companies/client/requests/ListEntityKeyDefinitionsRequest.d.ts +6 -1
  57. package/dist/api/resources/companies/client/requests/ListEntityTraitDefinitionsRequest.d.ts +7 -1
  58. package/dist/api/resources/companies/client/requests/ListPlanTraitsRequest.d.ts +6 -1
  59. package/dist/api/resources/companies/client/requests/ListUsersRequest.d.ts +7 -1
  60. package/dist/api/resources/companies/client/requests/UpdatePlanTraitBulkRequestBody.d.ts +18 -0
  61. package/dist/api/resources/companies/client/requests/index.d.ts +1 -0
  62. package/dist/api/resources/companies/types/CountCompaniesForAdvancedFilterParams.d.ts +3 -1
  63. package/dist/api/resources/companies/types/GetActiveCompanySubscriptionResponse.d.ts +0 -1
  64. package/dist/api/resources/companies/types/GetActiveDealsResponse.d.ts +0 -1
  65. package/dist/api/resources/companies/types/GetEntityTraitValuesResponse.d.ts +0 -1
  66. package/dist/api/resources/companies/types/ListCompaniesForAdvancedFilterParams.d.ts +3 -1
  67. package/dist/api/resources/companies/types/ListCompaniesForAdvancedFilterResponse.d.ts +0 -1
  68. package/dist/api/resources/companies/types/ListCompaniesResponse.d.ts +0 -1
  69. package/dist/api/resources/companies/types/ListCompanyMembershipsResponse.d.ts +0 -1
  70. package/dist/api/resources/companies/types/ListEntityKeyDefinitionsResponse.d.ts +0 -1
  71. package/dist/api/resources/companies/types/ListEntityTraitDefinitionsResponse.d.ts +0 -1
  72. package/dist/api/resources/companies/types/ListPlanTraitsResponse.d.ts +0 -1
  73. package/dist/api/resources/companies/types/ListUsersResponse.d.ts +0 -1
  74. package/dist/api/resources/companies/types/UpdatePlanTraitsBulkResponse.d.ts +9 -0
  75. package/dist/api/resources/companies/types/index.d.ts +1 -0
  76. package/dist/api/resources/components/client/Client.d.ts +17 -6
  77. package/dist/api/resources/components/client/requests/CountComponentsRequest.d.ts +5 -1
  78. package/dist/api/resources/components/client/requests/ListComponentsRequest.d.ts +5 -1
  79. package/dist/api/resources/components/client/requests/PreviewComponentDataRequest.d.ts +4 -1
  80. package/dist/api/resources/components/types/ListComponentsResponse.d.ts +0 -1
  81. package/dist/api/resources/credits/client/Client.d.ts +104 -12
  82. package/dist/api/resources/credits/client/requests/CountBillingCreditsGrantsRequest.d.ts +5 -1
  83. package/dist/api/resources/credits/client/requests/CountBillingCreditsRequest.d.ts +5 -1
  84. package/dist/api/resources/credits/client/requests/CountBillingPlanCreditGrantsRequest.d.ts +6 -1
  85. package/dist/api/resources/credits/client/requests/CountCreditBundlesRequest.d.ts +7 -1
  86. package/dist/api/resources/credits/client/requests/CountCreditLedgerRequest.d.ts +33 -0
  87. package/dist/api/resources/credits/client/requests/CreateBillingPlanCreditGrantRequestBody.d.ts +4 -0
  88. package/dist/api/resources/credits/client/requests/CreateCompanyCreditGrant.d.ts +5 -0
  89. package/dist/api/resources/credits/client/requests/CreateCreditBundleRequestBody.d.ts +1 -1
  90. package/dist/api/resources/credits/client/requests/GetEnrichedCreditLedgerRequest.d.ts +33 -0
  91. package/dist/api/resources/credits/client/requests/ListBillingCreditsRequest.d.ts +5 -1
  92. package/dist/api/resources/credits/client/requests/ListBillingPlanCreditGrantsRequest.d.ts +6 -1
  93. package/dist/api/resources/credits/client/requests/ListCompanyGrantsRequest.d.ts +7 -1
  94. package/dist/api/resources/credits/client/requests/ListCreditBundlesRequest.d.ts +7 -1
  95. package/dist/api/resources/credits/client/requests/ListGrantsForCreditRequest.d.ts +5 -1
  96. package/dist/api/resources/credits/client/requests/UpdateCreditBundleDetailsRequestBody.d.ts +1 -0
  97. package/dist/api/resources/credits/client/requests/index.d.ts +2 -0
  98. package/dist/api/resources/credits/types/CountCreditLedgerParams.d.ts +19 -0
  99. package/dist/api/resources/credits/types/CountCreditLedgerRequestPeriod.d.ts +10 -0
  100. package/dist/api/resources/credits/types/CountCreditLedgerResponse.d.ts +9 -0
  101. package/dist/api/resources/credits/types/CountCreditLedgerResponseParamsPeriod.d.ts +10 -0
  102. package/dist/api/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyExpiryType.d.ts +11 -0
  103. package/dist/api/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyExpiryUnit.d.ts +8 -0
  104. package/dist/api/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyResetType.d.ts +8 -0
  105. package/dist/api/resources/credits/types/CreateCompanyCreditGrantExpiryType.d.ts +11 -0
  106. package/dist/api/resources/credits/types/CreateCompanyCreditGrantExpiryUnit.d.ts +8 -0
  107. package/dist/api/resources/credits/types/CreateCreditBundleRequestBodyExpiryType.d.ts +5 -2
  108. package/dist/api/resources/credits/types/CreateCreditBundleRequestBodyExpiryUnit.d.ts +8 -0
  109. package/dist/api/resources/credits/types/GetEnrichedCreditLedgerParams.d.ts +19 -0
  110. package/dist/api/resources/credits/types/GetEnrichedCreditLedgerRequestPeriod.d.ts +10 -0
  111. package/dist/api/resources/credits/types/GetEnrichedCreditLedgerResponse.d.ts +9 -0
  112. package/dist/api/resources/credits/types/GetEnrichedCreditLedgerResponseParamsPeriod.d.ts +10 -0
  113. package/dist/api/resources/credits/types/ListBillingCreditsResponse.d.ts +0 -1
  114. package/dist/api/resources/credits/types/ListBillingPlanCreditGrantsResponse.d.ts +0 -1
  115. package/dist/api/resources/credits/types/ListCompanyGrantsResponse.d.ts +0 -1
  116. package/dist/api/resources/credits/types/ListCreditBundlesResponse.d.ts +0 -1
  117. package/dist/api/resources/credits/types/ListGrantsForCreditResponse.d.ts +0 -1
  118. package/dist/api/resources/credits/types/UpdateCreditBundleDetailsRequestBodyExpiryType.d.ts +5 -2
  119. package/dist/api/resources/credits/types/UpdateCreditBundleDetailsRequestBodyExpiryUnit.d.ts +8 -0
  120. package/dist/api/resources/credits/types/ZeroOutGrantRequestBodyReason.d.ts +2 -1
  121. package/dist/api/resources/credits/types/index.d.ts +15 -0
  122. package/dist/api/resources/crm/client/Client.d.ts +8 -4
  123. package/dist/api/resources/crm/client/requests/ListCrmProductsRequest.d.ts +5 -1
  124. package/dist/api/resources/crm/types/ListCrmProductsResponse.d.ts +0 -1
  125. package/dist/api/resources/dataexports/client/Client.d.ts +3 -3
  126. package/dist/api/resources/entitlements/client/Client.d.ts +65 -13
  127. package/dist/api/resources/entitlements/client/requests/CountCompanyOverridesRequest.d.ts +8 -1
  128. package/dist/api/resources/entitlements/client/requests/CountFeatureCompaniesRequest.d.ts +4 -1
  129. package/dist/api/resources/entitlements/client/requests/CountFeatureUsageRequest.d.ts +7 -1
  130. package/dist/api/resources/entitlements/client/requests/CountFeatureUsersRequest.d.ts +4 -1
  131. package/dist/api/resources/entitlements/client/requests/CountPlanEntitlementsRequest.d.ts +8 -1
  132. package/dist/api/resources/entitlements/client/requests/CreateCompanyOverrideRequestBody.d.ts +1 -0
  133. package/dist/api/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +1 -0
  134. package/dist/api/resources/entitlements/client/requests/ListCompanyOverridesRequest.d.ts +8 -1
  135. package/dist/api/resources/entitlements/client/requests/ListFeatureCompaniesRequest.d.ts +4 -1
  136. package/dist/api/resources/entitlements/client/requests/ListFeatureUsageRequest.d.ts +7 -1
  137. package/dist/api/resources/entitlements/client/requests/ListFeatureUsersRequest.d.ts +4 -1
  138. package/dist/api/resources/entitlements/client/requests/ListPlanEntitlementsRequest.d.ts +8 -1
  139. package/dist/api/resources/entitlements/client/requests/UpdateCompanyOverrideRequestBody.d.ts +1 -0
  140. package/dist/api/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts +1 -0
  141. package/dist/api/resources/entitlements/types/ListCompanyOverridesResponse.d.ts +0 -1
  142. package/dist/api/resources/entitlements/types/ListFeatureCompaniesResponse.d.ts +0 -1
  143. package/dist/api/resources/entitlements/types/ListFeatureUsageResponse.d.ts +0 -1
  144. package/dist/api/resources/entitlements/types/ListFeatureUsersResponse.d.ts +0 -1
  145. package/dist/api/resources/entitlements/types/ListPlanEntitlementsResponse.d.ts +0 -1
  146. package/dist/api/resources/events/client/Client.d.ts +16 -5
  147. package/dist/api/resources/events/client/requests/GetEventSummariesRequest.d.ts +5 -1
  148. package/dist/api/resources/events/client/requests/ListEventsRequest.d.ts +8 -1
  149. package/dist/api/resources/events/types/GetEventSummariesResponse.d.ts +0 -1
  150. package/dist/api/resources/events/types/ListEventsResponse.d.ts +0 -1
  151. package/dist/api/resources/features/client/Client.d.ts +31 -7
  152. package/dist/api/resources/features/client/requests/CountFeaturesRequest.d.ts +11 -1
  153. package/dist/api/resources/features/client/requests/CountFlagsRequest.d.ts +9 -1
  154. package/dist/api/resources/features/client/requests/ListFeaturesRequest.d.ts +11 -1
  155. package/dist/api/resources/features/client/requests/ListFlagsRequest.d.ts +9 -1
  156. package/dist/api/resources/features/types/CountFeaturesParams.d.ts +1 -0
  157. package/dist/api/resources/features/types/CountFlagsParams.d.ts +1 -0
  158. package/dist/api/resources/features/types/ListAudienceCompaniesResponse.d.ts +0 -1
  159. package/dist/api/resources/features/types/ListAudienceUsersResponse.d.ts +0 -1
  160. package/dist/api/resources/features/types/ListFeaturesParams.d.ts +1 -0
  161. package/dist/api/resources/features/types/ListFeaturesResponse.d.ts +0 -1
  162. package/dist/api/resources/features/types/ListFlagsParams.d.ts +1 -0
  163. package/dist/api/resources/features/types/ListFlagsResponse.d.ts +0 -1
  164. package/dist/api/resources/plangroups/client/Client.d.ts +21 -5
  165. package/dist/api/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +22 -1
  166. package/dist/api/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +22 -1
  167. package/dist/api/resources/plans/client/Client.d.ts +50 -5
  168. package/dist/api/resources/plans/client/requests/CountPlansRequest.d.ts +31 -1
  169. package/dist/api/resources/plans/client/requests/ListPlanIssuesRequest.d.ts +12 -0
  170. package/dist/api/resources/plans/client/requests/ListPlansRequest.d.ts +31 -1
  171. package/dist/api/resources/plans/client/requests/index.d.ts +1 -0
  172. package/dist/api/resources/plans/types/CountPlansParams.d.ts +8 -0
  173. package/dist/api/resources/plans/types/ListPlanIssuesParams.d.ts +9 -0
  174. package/dist/api/resources/plans/types/ListPlanIssuesResponse.d.ts +9 -0
  175. package/dist/api/resources/plans/types/ListPlansParams.d.ts +8 -0
  176. package/dist/api/resources/plans/types/ListPlansResponse.d.ts +0 -1
  177. package/dist/api/resources/plans/types/index.d.ts +2 -0
  178. package/dist/api/resources/webhooks/client/Client.d.ts +25 -7
  179. package/dist/api/resources/webhooks/client/requests/CountWebhookEventsRequest.d.ts +6 -1
  180. package/dist/api/resources/webhooks/client/requests/CountWebhooksRequest.d.ts +5 -1
  181. package/dist/api/resources/webhooks/client/requests/ListWebhookEventsRequest.d.ts +6 -1
  182. package/dist/api/resources/webhooks/client/requests/ListWebhooksRequest.d.ts +5 -1
  183. package/dist/api/resources/webhooks/types/ListWebhookEventsResponse.d.ts +0 -1
  184. package/dist/api/resources/webhooks/types/ListWebhooksResponse.d.ts +0 -1
  185. package/dist/api/types/ApiKeyCreateResponseData.d.ts +0 -3
  186. package/dist/api/types/ApiKeyRequestResponseData.d.ts +0 -3
  187. package/dist/api/types/ApiKeyResponseData.d.ts +0 -3
  188. package/dist/api/types/BillingCreditBundleResponseData.d.ts +1 -0
  189. package/dist/api/types/BillingCreditBundleView.d.ts +1 -0
  190. package/dist/api/types/BillingCreditLedgerResponseData.d.ts +11 -0
  191. package/dist/api/types/BillingCustomerResponseData.d.ts +0 -3
  192. package/dist/api/types/BillingPlanCreditGrantResponseData.d.ts +7 -0
  193. package/dist/api/types/BillingProductDetailResponseData.d.ts +2 -1
  194. package/dist/api/types/BillingProductForSubscriptionResponseData.d.ts +2 -0
  195. package/dist/api/types/BillingProductPlanResponseData.d.ts +0 -3
  196. package/dist/api/types/BillingProductPricing.d.ts +2 -0
  197. package/dist/api/types/BillingProductResponseData.d.ts +2 -1
  198. package/dist/api/types/BillingSubscriptionView.d.ts +0 -3
  199. package/dist/api/types/CheckFlagResponseData.d.ts +0 -3
  200. package/dist/api/types/CheckFlagsResponseData.d.ts +0 -3
  201. package/dist/api/types/CheckoutDataResponseData.d.ts +0 -3
  202. package/dist/api/types/CheckoutSettingsResponseData.d.ts +8 -0
  203. package/dist/api/types/CheckoutSubscription.d.ts +25 -0
  204. package/dist/api/types/CompanyDetailResponseData.d.ts +1 -0
  205. package/dist/api/types/CompanyLedgerResponseData.d.ts +8 -0
  206. package/dist/api/types/CompanyOverrideNoteResponseData.d.ts +11 -0
  207. package/dist/api/types/CompanyOverrideResponseData.d.ts +1 -0
  208. package/dist/api/types/CompanyPlanDetailResponseData.d.ts +1 -0
  209. package/dist/api/types/CompanyViewWithFeatureUsageResponseData.d.ts +1 -0
  210. package/dist/api/types/ComponentCheckoutSettings.d.ts +9 -0
  211. package/dist/api/types/ComponentHydrateResponseData.d.ts +4 -0
  212. package/dist/api/types/ComponentPreviewResponseData.d.ts +4 -3
  213. package/dist/api/types/ComponentResponseData.d.ts +0 -3
  214. package/dist/api/types/Condition.d.ts +21 -0
  215. package/dist/api/types/ConditionGroup.d.ts +7 -0
  216. package/dist/api/types/CountResponse.d.ts +2 -4
  217. package/dist/api/types/CreditCompanyGrantView.d.ts +3 -0
  218. package/dist/api/types/CreditGrantDetail.d.ts +10 -0
  219. package/dist/api/types/CreditGrantDetailGrantReason.d.ts +9 -0
  220. package/dist/api/types/CreditLedgerEnrichedEntryResponseData.d.ts +27 -0
  221. package/dist/api/types/CreditUsage.d.ts +14 -0
  222. package/dist/api/types/CreditUsageResponseData.d.ts +14 -0
  223. package/dist/api/types/CrmDealResponseData.d.ts +0 -3
  224. package/dist/api/types/CrmLineItemResponseData.d.ts +0 -3
  225. package/dist/api/types/CrmProductResponseData.d.ts +0 -3
  226. package/dist/api/types/DataExportResponseData.d.ts +0 -3
  227. package/dist/api/types/EnvironmentDetailResponseData.d.ts +0 -3
  228. package/dist/api/types/EnvironmentResponseData.d.ts +0 -3
  229. package/dist/api/types/FeatureCompanyResponseData.d.ts +34 -1
  230. package/dist/api/types/FeatureCompanyResponseDataCreditGrantReason.d.ts +12 -0
  231. package/dist/api/types/FeatureCompanyUserResponseDataAllocationType.d.ts +2 -1
  232. package/dist/api/types/FeatureLedgerResponseData.d.ts +9 -0
  233. package/dist/api/types/FeatureUsageDataResponseData.d.ts +8 -0
  234. package/dist/api/types/FeatureUsageResponseData.d.ts +25 -0
  235. package/dist/api/types/FeatureUsageResponseDataCreditGrantReason.d.ts +12 -0
  236. package/dist/api/types/IssueTemporaryAccessTokenResponseData.d.ts +0 -3
  237. package/dist/api/types/ManagePlanPreviewResponseResponseData.d.ts +7 -0
  238. package/dist/api/types/ManagePlanRequest.d.ts +15 -0
  239. package/dist/api/types/ManagePlanResponseResponseData.d.ts +8 -0
  240. package/dist/api/types/PlanAudienceDetailResponseData.d.ts +0 -3
  241. package/dist/api/types/PlanCreditGrantView.d.ts +4 -0
  242. package/dist/api/types/PlanDetailResponseData.d.ts +1 -0
  243. package/dist/api/types/PlanEntitlementResponseData.d.ts +1 -0
  244. package/dist/api/types/PlanGroupDetailResponseData.d.ts +16 -3
  245. package/dist/api/types/PlanGroupPlanDetailResponseData.d.ts +1 -0
  246. package/dist/api/types/PlanGroupResponseData.d.ts +11 -3
  247. package/dist/api/types/PlanIssueResponseData.d.ts +9 -0
  248. package/dist/api/types/PlanSelection.d.ts +7 -0
  249. package/dist/api/types/PlanTraitResponseData.d.ts +0 -3
  250. package/dist/api/types/PreviewSubscriptionChangeResponseData.d.ts +0 -3
  251. package/dist/api/types/PreviewSubscriptionFinanceResponseData.d.ts +3 -0
  252. package/dist/api/types/RawEventBatchResponseData.d.ts +0 -3
  253. package/dist/api/types/Rule.d.ts +16 -0
  254. package/dist/api/types/RulesDetailResponseData.d.ts +0 -3
  255. package/dist/api/types/SegmentStatusResp.d.ts +0 -3
  256. package/dist/api/types/TraitDefinition.d.ts +8 -0
  257. package/dist/api/types/UpdatePlanTraitTraitRequestBody.d.ts +7 -0
  258. package/dist/api/types/UsageBasedEntitlementRequestBody.d.ts +1 -0
  259. package/dist/api/types/UsageBasedEntitlementResponseData.d.ts +1 -0
  260. package/dist/api/types/index.d.ts +24 -0
  261. package/dist/index.js +3 -3
  262. package/dist/serialization/resources/accesstokens/client/requests/IssueTemporaryAccessTokenRequestBody.d.ts +0 -1
  263. package/dist/serialization/resources/billing/client/requests/{CreateBillingSubscriptionsRequestBody.d.ts → CreateBillingSubscriptionRequestBody.d.ts} +5 -4
  264. package/dist/serialization/resources/billing/client/requests/index.d.ts +1 -1
  265. package/dist/serialization/resources/billing/types/CreateBillingSubscriptionRequestBodyTrialEndSetting.d.ts +10 -0
  266. package/dist/serialization/resources/billing/types/SearchBillingPricesParams.d.ts +4 -0
  267. package/dist/serialization/resources/billing/types/index.d.ts +2 -2
  268. package/dist/serialization/resources/checkout/types/CheckoutInternalResponse.d.ts +2 -2
  269. package/dist/serialization/resources/checkout/types/ManagePlanResponse.d.ts +14 -0
  270. package/dist/serialization/resources/checkout/types/PreviewManagePlanResponse.d.ts +14 -0
  271. package/dist/serialization/resources/checkout/types/index.d.ts +2 -0
  272. package/dist/serialization/resources/companies/client/requests/UpdatePlanTraitBulkRequestBody.d.ts +14 -0
  273. package/dist/serialization/resources/companies/client/requests/index.d.ts +1 -0
  274. package/dist/serialization/resources/companies/types/CountCompaniesForAdvancedFilterParams.d.ts +1 -0
  275. package/dist/serialization/resources/companies/types/ListCompaniesForAdvancedFilterParams.d.ts +1 -0
  276. package/dist/serialization/resources/companies/types/UpdatePlanTraitsBulkResponse.d.ts +14 -0
  277. package/dist/serialization/resources/companies/types/index.d.ts +1 -0
  278. package/dist/serialization/resources/credits/client/requests/CreateBillingPlanCreditGrantRequestBody.d.ts +7 -0
  279. package/dist/serialization/resources/credits/client/requests/CreateCompanyCreditGrant.d.ts +6 -0
  280. package/dist/serialization/resources/credits/client/requests/CreateCreditBundleRequestBody.d.ts +2 -1
  281. package/dist/serialization/resources/credits/client/requests/UpdateCreditBundleDetailsRequestBody.d.ts +2 -0
  282. package/dist/serialization/resources/credits/types/CountCreditLedgerParams.d.ts +20 -0
  283. package/dist/serialization/resources/credits/types/CountCreditLedgerRequestPeriod.d.ts +10 -0
  284. package/dist/serialization/resources/credits/types/CountCreditLedgerResponse.d.ts +15 -0
  285. package/dist/serialization/resources/credits/types/CountCreditLedgerResponseParamsPeriod.d.ts +10 -0
  286. package/dist/serialization/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyExpiryType.d.ts +10 -0
  287. package/dist/serialization/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyExpiryUnit.d.ts +10 -0
  288. package/dist/serialization/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyResetType.d.ts +10 -0
  289. package/dist/serialization/resources/credits/types/CreateCompanyCreditGrantExpiryType.d.ts +10 -0
  290. package/dist/serialization/resources/credits/types/CreateCompanyCreditGrantExpiryUnit.d.ts +10 -0
  291. package/dist/serialization/resources/credits/types/CreateCreditBundleRequestBodyExpiryType.d.ts +1 -1
  292. package/dist/serialization/resources/credits/types/CreateCreditBundleRequestBodyExpiryUnit.d.ts +10 -0
  293. package/dist/serialization/resources/credits/types/GetEnrichedCreditLedgerParams.d.ts +20 -0
  294. package/dist/serialization/resources/credits/types/GetEnrichedCreditLedgerRequestPeriod.d.ts +10 -0
  295. package/dist/serialization/resources/credits/types/GetEnrichedCreditLedgerResponse.d.ts +15 -0
  296. package/dist/serialization/resources/credits/types/GetEnrichedCreditLedgerResponseParamsPeriod.d.ts +10 -0
  297. package/dist/serialization/resources/credits/types/UpdateCreditBundleDetailsRequestBodyExpiryType.d.ts +1 -1
  298. package/dist/serialization/resources/credits/types/UpdateCreditBundleDetailsRequestBodyExpiryUnit.d.ts +10 -0
  299. package/dist/serialization/resources/credits/types/ZeroOutGrantRequestBodyReason.d.ts +1 -1
  300. package/dist/serialization/resources/credits/types/index.d.ts +15 -0
  301. package/dist/serialization/resources/entitlements/client/requests/CreateCompanyOverrideRequestBody.d.ts +1 -0
  302. package/dist/serialization/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +1 -0
  303. package/dist/serialization/resources/entitlements/client/requests/UpdateCompanyOverrideRequestBody.d.ts +1 -0
  304. package/dist/serialization/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts +1 -0
  305. package/dist/serialization/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +13 -0
  306. package/dist/serialization/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +13 -0
  307. package/dist/serialization/resources/plans/types/CountPlansParams.d.ts +4 -0
  308. package/dist/serialization/resources/plans/types/ListPlanIssuesParams.d.ts +12 -0
  309. package/dist/serialization/resources/plans/types/ListPlanIssuesResponse.d.ts +15 -0
  310. package/dist/serialization/resources/plans/types/ListPlansParams.d.ts +4 -0
  311. package/dist/serialization/resources/plans/types/index.d.ts +2 -0
  312. package/dist/serialization/types/BillingCreditBundleResponseData.d.ts +1 -0
  313. package/dist/serialization/types/BillingCreditBundleView.d.ts +1 -0
  314. package/dist/serialization/types/BillingCreditLedgerResponseData.d.ts +17 -0
  315. package/dist/serialization/types/BillingPlanCreditGrantResponseData.d.ts +7 -0
  316. package/dist/serialization/types/BillingProductDetailResponseData.d.ts +1 -1
  317. package/dist/serialization/types/BillingProductForSubscriptionResponseData.d.ts +2 -0
  318. package/dist/serialization/types/BillingProductPricing.d.ts +2 -0
  319. package/dist/serialization/types/BillingProductResponseData.d.ts +1 -1
  320. package/dist/serialization/types/CheckoutSettingsResponseData.d.ts +14 -0
  321. package/dist/serialization/types/CheckoutSubscription.d.ts +31 -0
  322. package/dist/serialization/types/CompanyDetailResponseData.d.ts +2 -0
  323. package/dist/serialization/types/CompanyLedgerResponseData.d.ts +14 -0
  324. package/dist/serialization/types/CompanyOverrideNoteResponseData.d.ts +17 -0
  325. package/dist/serialization/types/CompanyOverrideResponseData.d.ts +2 -0
  326. package/dist/serialization/types/CompanyPlanDetailResponseData.d.ts +2 -0
  327. package/dist/serialization/types/CompanyViewWithFeatureUsageResponseData.d.ts +2 -0
  328. package/dist/serialization/types/ComponentCheckoutSettings.d.ts +15 -0
  329. package/dist/serialization/types/ComponentHydrateResponseData.d.ts +5 -0
  330. package/dist/serialization/types/ComponentPreviewResponseData.d.ts +5 -0
  331. package/dist/serialization/types/Condition.d.ts +27 -0
  332. package/dist/serialization/types/ConditionGroup.d.ts +13 -0
  333. package/dist/serialization/types/CountResponse.d.ts +1 -1
  334. package/dist/serialization/types/CreditCompanyGrantView.d.ts +3 -0
  335. package/dist/serialization/types/CreditGrantDetail.d.ts +16 -0
  336. package/dist/serialization/types/CreditGrantDetailGrantReason.d.ts +10 -0
  337. package/dist/serialization/types/CreditLedgerEnrichedEntryResponseData.d.ts +35 -0
  338. package/dist/serialization/types/CreditUsage.d.ts +20 -0
  339. package/dist/serialization/types/CreditUsageResponseData.d.ts +20 -0
  340. package/dist/serialization/types/FeatureCompanyResponseData.d.ts +28 -0
  341. package/dist/serialization/types/FeatureCompanyResponseDataCreditGrantReason.d.ts +10 -0
  342. package/dist/serialization/types/FeatureCompanyUserResponseDataAllocationType.d.ts +1 -1
  343. package/dist/serialization/types/FeatureLedgerResponseData.d.ts +15 -0
  344. package/dist/serialization/types/FeatureUsageDataResponseData.d.ts +9 -0
  345. package/dist/serialization/types/FeatureUsageResponseData.d.ts +17 -0
  346. package/dist/serialization/types/FeatureUsageResponseDataCreditGrantReason.d.ts +10 -0
  347. package/dist/serialization/types/ManagePlanPreviewResponseResponseData.d.ts +13 -0
  348. package/dist/serialization/types/ManagePlanRequest.d.ts +23 -0
  349. package/dist/serialization/types/ManagePlanResponseResponseData.d.ts +14 -0
  350. package/dist/serialization/types/PlanCreditGrantView.d.ts +4 -0
  351. package/dist/serialization/types/PlanDetailResponseData.d.ts +2 -0
  352. package/dist/serialization/types/PlanEntitlementResponseData.d.ts +1 -0
  353. package/dist/serialization/types/PlanGroupDetailResponseData.d.ts +18 -0
  354. package/dist/serialization/types/PlanGroupPlanDetailResponseData.d.ts +2 -0
  355. package/dist/serialization/types/PlanGroupResponseData.d.ts +12 -0
  356. package/dist/serialization/types/PlanIssueResponseData.d.ts +15 -0
  357. package/dist/serialization/types/PlanSelection.d.ts +13 -0
  358. package/dist/serialization/types/PreviewSubscriptionFinanceResponseData.d.ts +3 -0
  359. package/dist/serialization/types/Rule.d.ts +23 -0
  360. package/dist/serialization/types/TraitDefinition.d.ts +14 -0
  361. package/dist/serialization/types/UpdatePlanTraitTraitRequestBody.d.ts +13 -0
  362. package/dist/serialization/types/UsageBasedEntitlementRequestBody.d.ts +1 -0
  363. package/dist/serialization/types/UsageBasedEntitlementResponseData.d.ts +1 -0
  364. package/dist/serialization/types/index.d.ts +24 -0
  365. package/dist/wrapper.d.ts +8 -0
  366. package/package.json +2 -1
  367. package/dist/api/resources/billing/types/CreateBillingSubscriptionsRequestBodyTrialEndSetting.d.ts +0 -8
  368. package/dist/serialization/resources/billing/types/CreateBillingSubscriptionsRequestBodyTrialEndSetting.d.ts +0 -10
@@ -9,7 +9,7 @@ export declare namespace Credits {
9
9
  environment?: core.Supplier<environments.SchematicEnvironment | string>;
10
10
  /** Specify a custom URL to connect the client to. */
11
11
  baseUrl?: core.Supplier<string>;
12
- apiKey: core.Supplier<string>;
12
+ apiKey?: core.Supplier<string | undefined>;
13
13
  fetcher?: core.FetchFunction;
14
14
  }
15
15
  interface RequestOptions {
@@ -25,7 +25,7 @@ export declare namespace Credits {
25
25
  }
26
26
  export declare class Credits {
27
27
  protected readonly _options: Credits.Options;
28
- constructor(_options: Credits.Options);
28
+ constructor(_options?: Credits.Options);
29
29
  /**
30
30
  * @param {Schematic.ListBillingCreditsRequest} request
31
31
  * @param {Credits.RequestOptions} requestOptions - Request-specific configuration.
@@ -37,7 +37,11 @@ export declare class Credits {
37
37
  * @throws {@link Schematic.InternalServerError}
38
38
  *
39
39
  * @example
40
- * await client.credits.listBillingCredits()
40
+ * await client.credits.listBillingCredits({
41
+ * name: "name",
42
+ * limit: 1,
43
+ * offset: 1
44
+ * })
41
45
  */
42
46
  listBillingCredits(request?: Schematic.ListBillingCreditsRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.ListBillingCreditsResponse>;
43
47
  private __listBillingCredits;
@@ -119,7 +123,13 @@ export declare class Credits {
119
123
  * @throws {@link Schematic.InternalServerError}
120
124
  *
121
125
  * @example
122
- * await client.credits.listCreditBundles()
126
+ * await client.credits.listCreditBundles({
127
+ * creditId: "credit_id",
128
+ * status: "active",
129
+ * bundleType: "fixed",
130
+ * limit: 1,
131
+ * offset: 1
132
+ * })
123
133
  */
124
134
  listCreditBundles(request?: Schematic.ListCreditBundlesRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.ListCreditBundlesResponse>;
125
135
  private __listCreditBundles;
@@ -202,7 +212,13 @@ export declare class Credits {
202
212
  * @throws {@link Schematic.InternalServerError}
203
213
  *
204
214
  * @example
205
- * await client.credits.countCreditBundles()
215
+ * await client.credits.countCreditBundles({
216
+ * creditId: "credit_id",
217
+ * status: "active",
218
+ * bundleType: "fixed",
219
+ * limit: 1,
220
+ * offset: 1
221
+ * })
206
222
  */
207
223
  countCreditBundles(request?: Schematic.CountCreditBundlesRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.CountCreditBundlesResponse>;
208
224
  private __countCreditBundles;
@@ -217,7 +233,11 @@ export declare class Credits {
217
233
  * @throws {@link Schematic.InternalServerError}
218
234
  *
219
235
  * @example
220
- * await client.credits.countBillingCredits()
236
+ * await client.credits.countBillingCredits({
237
+ * name: "name",
238
+ * limit: 1,
239
+ * offset: 1
240
+ * })
221
241
  */
222
242
  countBillingCredits(request?: Schematic.CountBillingCreditsRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.CountBillingCreditsResponse>;
223
243
  private __countBillingCredits;
@@ -268,7 +288,13 @@ export declare class Credits {
268
288
  * @throws {@link Schematic.InternalServerError}
269
289
  *
270
290
  * @example
271
- * await client.credits.listCompanyGrants()
291
+ * await client.credits.listCompanyGrants({
292
+ * companyId: "company_id",
293
+ * order: "created_at",
294
+ * dir: "asc",
295
+ * limit: 1,
296
+ * offset: 1
297
+ * })
272
298
  */
273
299
  listCompanyGrants(request?: Schematic.ListCompanyGrantsRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.ListCompanyGrantsResponse>;
274
300
  private __listCompanyGrants;
@@ -283,7 +309,11 @@ export declare class Credits {
283
309
  * @throws {@link Schematic.InternalServerError}
284
310
  *
285
311
  * @example
286
- * await client.credits.countBillingCreditsGrants()
312
+ * await client.credits.countBillingCreditsGrants({
313
+ * creditId: "credit_id",
314
+ * limit: 1,
315
+ * offset: 1
316
+ * })
287
317
  */
288
318
  countBillingCreditsGrants(request?: Schematic.CountBillingCreditsGrantsRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.CountBillingCreditsGrantsResponse>;
289
319
  private __countBillingCreditsGrants;
@@ -298,10 +328,62 @@ export declare class Credits {
298
328
  * @throws {@link Schematic.InternalServerError}
299
329
  *
300
330
  * @example
301
- * await client.credits.listGrantsForCredit()
331
+ * await client.credits.listGrantsForCredit({
332
+ * creditId: "credit_id",
333
+ * limit: 1,
334
+ * offset: 1
335
+ * })
302
336
  */
303
337
  listGrantsForCredit(request?: Schematic.ListGrantsForCreditRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.ListGrantsForCreditResponse>;
304
338
  private __listGrantsForCredit;
339
+ /**
340
+ * @param {Schematic.GetEnrichedCreditLedgerRequest} request
341
+ * @param {Credits.RequestOptions} requestOptions - Request-specific configuration.
342
+ *
343
+ * @throws {@link Schematic.BadRequestError}
344
+ * @throws {@link Schematic.UnauthorizedError}
345
+ * @throws {@link Schematic.ForbiddenError}
346
+ * @throws {@link Schematic.NotFoundError}
347
+ * @throws {@link Schematic.InternalServerError}
348
+ *
349
+ * @example
350
+ * await client.credits.getEnrichedCreditLedger({
351
+ * companyId: "company_id",
352
+ * billingCreditId: "billing_credit_id",
353
+ * featureId: "feature_id",
354
+ * period: "daily",
355
+ * startTime: "start_time",
356
+ * endTime: "end_time",
357
+ * limit: 1,
358
+ * offset: 1
359
+ * })
360
+ */
361
+ getEnrichedCreditLedger(request: Schematic.GetEnrichedCreditLedgerRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.GetEnrichedCreditLedgerResponse>;
362
+ private __getEnrichedCreditLedger;
363
+ /**
364
+ * @param {Schematic.CountCreditLedgerRequest} request
365
+ * @param {Credits.RequestOptions} requestOptions - Request-specific configuration.
366
+ *
367
+ * @throws {@link Schematic.BadRequestError}
368
+ * @throws {@link Schematic.UnauthorizedError}
369
+ * @throws {@link Schematic.ForbiddenError}
370
+ * @throws {@link Schematic.NotFoundError}
371
+ * @throws {@link Schematic.InternalServerError}
372
+ *
373
+ * @example
374
+ * await client.credits.countCreditLedger({
375
+ * companyId: "company_id",
376
+ * billingCreditId: "billing_credit_id",
377
+ * featureId: "feature_id",
378
+ * period: "daily",
379
+ * startTime: "start_time",
380
+ * endTime: "end_time",
381
+ * limit: 1,
382
+ * offset: 1
383
+ * })
384
+ */
385
+ countCreditLedger(request: Schematic.CountCreditLedgerRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.CountCreditLedgerResponse>;
386
+ private __countCreditLedger;
305
387
  /**
306
388
  * @param {Schematic.ListBillingPlanCreditGrantsRequest} request
307
389
  * @param {Credits.RequestOptions} requestOptions - Request-specific configuration.
@@ -313,7 +395,12 @@ export declare class Credits {
313
395
  * @throws {@link Schematic.InternalServerError}
314
396
  *
315
397
  * @example
316
- * await client.credits.listBillingPlanCreditGrants()
398
+ * await client.credits.listBillingPlanCreditGrants({
399
+ * creditId: "credit_id",
400
+ * planId: "plan_id",
401
+ * limit: 1,
402
+ * offset: 1
403
+ * })
317
404
  */
318
405
  listBillingPlanCreditGrants(request?: Schematic.ListBillingPlanCreditGrantsRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.ListBillingPlanCreditGrantsResponse>;
319
406
  private __listBillingPlanCreditGrants;
@@ -364,11 +451,16 @@ export declare class Credits {
364
451
  * @throws {@link Schematic.InternalServerError}
365
452
  *
366
453
  * @example
367
- * await client.credits.countBillingPlanCreditGrants()
454
+ * await client.credits.countBillingPlanCreditGrants({
455
+ * creditId: "credit_id",
456
+ * planId: "plan_id",
457
+ * limit: 1,
458
+ * offset: 1
459
+ * })
368
460
  */
369
461
  countBillingPlanCreditGrants(request?: Schematic.CountBillingPlanCreditGrantsRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.CountBillingPlanCreditGrantsResponse>;
370
462
  private __countBillingPlanCreditGrants;
371
463
  protected _getCustomAuthorizationHeaders(): Promise<{
372
- "X-Schematic-Api-Key": string;
464
+ "X-Schematic-Api-Key": string | undefined;
373
465
  }>;
374
466
  }
@@ -3,7 +3,11 @@
3
3
  */
4
4
  /**
5
5
  * @example
6
- * {}
6
+ * {
7
+ * creditId: "credit_id",
8
+ * limit: 1,
9
+ * offset: 1
10
+ * }
7
11
  */
8
12
  export interface CountBillingCreditsGrantsRequest {
9
13
  creditId?: string;
@@ -3,7 +3,11 @@
3
3
  */
4
4
  /**
5
5
  * @example
6
- * {}
6
+ * {
7
+ * name: "name",
8
+ * limit: 1,
9
+ * offset: 1
10
+ * }
7
11
  */
8
12
  export interface CountBillingCreditsRequest {
9
13
  ids?: string | string[];
@@ -3,7 +3,12 @@
3
3
  */
4
4
  /**
5
5
  * @example
6
- * {}
6
+ * {
7
+ * creditId: "credit_id",
8
+ * planId: "plan_id",
9
+ * limit: 1,
10
+ * offset: 1
11
+ * }
7
12
  */
8
13
  export interface CountBillingPlanCreditGrantsRequest {
9
14
  creditId?: string;
@@ -4,7 +4,13 @@
4
4
  import * as Schematic from "../../../../index";
5
5
  /**
6
6
  * @example
7
- * {}
7
+ * {
8
+ * creditId: "credit_id",
9
+ * status: "active",
10
+ * bundleType: "fixed",
11
+ * limit: 1,
12
+ * offset: 1
13
+ * }
8
14
  */
9
15
  export interface CountCreditBundlesRequest {
10
16
  ids?: string | string[];
@@ -0,0 +1,33 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Schematic from "../../../../index";
5
+ /**
6
+ * @example
7
+ * {
8
+ * companyId: "company_id",
9
+ * billingCreditId: "billing_credit_id",
10
+ * featureId: "feature_id",
11
+ * period: "daily",
12
+ * startTime: "start_time",
13
+ * endTime: "end_time",
14
+ * limit: 1,
15
+ * offset: 1
16
+ * }
17
+ */
18
+ export interface CountCreditLedgerRequest {
19
+ companyId: string;
20
+ billingCreditId?: string;
21
+ featureId?: string;
22
+ period: Schematic.CountCreditLedgerRequestPeriod;
23
+ startTime?: string;
24
+ endTime?: string;
25
+ /**
26
+ * Page limit (default 100)
27
+ */
28
+ limit?: number;
29
+ /**
30
+ * Page offset (default 0)
31
+ */
32
+ offset?: number;
33
+ }
@@ -15,7 +15,11 @@ import * as Schematic from "../../../../index";
15
15
  export interface CreateBillingPlanCreditGrantRequestBody {
16
16
  creditAmount: number;
17
17
  creditId: string;
18
+ expiryType?: Schematic.CreateBillingPlanCreditGrantRequestBodyExpiryType;
19
+ expiryUnit?: Schematic.CreateBillingPlanCreditGrantRequestBodyExpiryUnit;
20
+ expiryUnitCount?: number;
18
21
  planId: string;
19
22
  resetCadence: Schematic.CreateBillingPlanCreditGrantRequestBodyResetCadence;
20
23
  resetStart: Schematic.CreateBillingPlanCreditGrantRequestBodyResetStart;
24
+ resetType?: Schematic.CreateBillingPlanCreditGrantRequestBodyResetType;
21
25
  }
@@ -1,6 +1,7 @@
1
1
  /**
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
+ import * as Schematic from "../../../../index";
4
5
  /**
5
6
  * @example
6
7
  * {
@@ -11,9 +12,13 @@
11
12
  * }
12
13
  */
13
14
  export interface CreateCompanyCreditGrant {
15
+ billingPeriodsCount?: number;
14
16
  companyId: string;
15
17
  creditId: string;
16
18
  expiresAt?: Date;
19
+ expiryType?: Schematic.CreateCompanyCreditGrantExpiryType;
20
+ expiryUnit?: Schematic.CreateCompanyCreditGrantExpiryUnit;
21
+ expiryUnitCount?: number;
17
22
  quantity: number;
18
23
  reason: string;
19
24
  }
@@ -17,7 +17,7 @@ export interface CreateCreditBundleRequestBody {
17
17
  creditId: string;
18
18
  currency: string;
19
19
  expiryType?: Schematic.CreateCreditBundleRequestBodyExpiryType;
20
- expiryUnit?: "days";
20
+ expiryUnit?: Schematic.CreateCreditBundleRequestBodyExpiryUnit;
21
21
  expiryUnitCount?: number;
22
22
  pricePerUnit: number;
23
23
  pricePerUnitDecimal?: string;
@@ -0,0 +1,33 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Schematic from "../../../../index";
5
+ /**
6
+ * @example
7
+ * {
8
+ * companyId: "company_id",
9
+ * billingCreditId: "billing_credit_id",
10
+ * featureId: "feature_id",
11
+ * period: "daily",
12
+ * startTime: "start_time",
13
+ * endTime: "end_time",
14
+ * limit: 1,
15
+ * offset: 1
16
+ * }
17
+ */
18
+ export interface GetEnrichedCreditLedgerRequest {
19
+ companyId: string;
20
+ billingCreditId?: string;
21
+ featureId?: string;
22
+ period: Schematic.GetEnrichedCreditLedgerRequestPeriod;
23
+ startTime?: string;
24
+ endTime?: string;
25
+ /**
26
+ * Page limit (default 100)
27
+ */
28
+ limit?: number;
29
+ /**
30
+ * Page offset (default 0)
31
+ */
32
+ offset?: number;
33
+ }
@@ -3,7 +3,11 @@
3
3
  */
4
4
  /**
5
5
  * @example
6
- * {}
6
+ * {
7
+ * name: "name",
8
+ * limit: 1,
9
+ * offset: 1
10
+ * }
7
11
  */
8
12
  export interface ListBillingCreditsRequest {
9
13
  ids?: string | string[];
@@ -3,7 +3,12 @@
3
3
  */
4
4
  /**
5
5
  * @example
6
- * {}
6
+ * {
7
+ * creditId: "credit_id",
8
+ * planId: "plan_id",
9
+ * limit: 1,
10
+ * offset: 1
11
+ * }
7
12
  */
8
13
  export interface ListBillingPlanCreditGrantsRequest {
9
14
  creditId?: string;
@@ -4,7 +4,13 @@
4
4
  import * as Schematic from "../../../../index";
5
5
  /**
6
6
  * @example
7
- * {}
7
+ * {
8
+ * companyId: "company_id",
9
+ * order: "created_at",
10
+ * dir: "asc",
11
+ * limit: 1,
12
+ * offset: 1
13
+ * }
8
14
  */
9
15
  export interface ListCompanyGrantsRequest {
10
16
  companyId?: string;
@@ -4,7 +4,13 @@
4
4
  import * as Schematic from "../../../../index";
5
5
  /**
6
6
  * @example
7
- * {}
7
+ * {
8
+ * creditId: "credit_id",
9
+ * status: "active",
10
+ * bundleType: "fixed",
11
+ * limit: 1,
12
+ * offset: 1
13
+ * }
8
14
  */
9
15
  export interface ListCreditBundlesRequest {
10
16
  ids?: string | string[];
@@ -3,7 +3,11 @@
3
3
  */
4
4
  /**
5
5
  * @example
6
- * {}
6
+ * {
7
+ * creditId: "credit_id",
8
+ * limit: 1,
9
+ * offset: 1
10
+ * }
7
11
  */
8
12
  export interface ListGrantsForCreditRequest {
9
13
  creditId?: string;
@@ -12,6 +12,7 @@ import * as Schematic from "../../../../index";
12
12
  export interface UpdateCreditBundleDetailsRequestBody {
13
13
  bundleName: string;
14
14
  expiryType?: Schematic.UpdateCreditBundleDetailsRequestBodyExpiryType;
15
+ expiryUnit?: Schematic.UpdateCreditBundleDetailsRequestBodyExpiryUnit;
15
16
  expiryUnitCount?: number;
16
17
  pricePerUnit: number;
17
18
  pricePerUnitDecimal?: string;
@@ -11,6 +11,8 @@ export { type CreateCompanyCreditGrant } from "./CreateCompanyCreditGrant";
11
11
  export { type ListCompanyGrantsRequest } from "./ListCompanyGrantsRequest";
12
12
  export { type CountBillingCreditsGrantsRequest } from "./CountBillingCreditsGrantsRequest";
13
13
  export { type ListGrantsForCreditRequest } from "./ListGrantsForCreditRequest";
14
+ export { type GetEnrichedCreditLedgerRequest } from "./GetEnrichedCreditLedgerRequest";
15
+ export { type CountCreditLedgerRequest } from "./CountCreditLedgerRequest";
14
16
  export { type ListBillingPlanCreditGrantsRequest } from "./ListBillingPlanCreditGrantsRequest";
15
17
  export { type CreateBillingPlanCreditGrantRequestBody } from "./CreateBillingPlanCreditGrantRequestBody";
16
18
  export { type CountBillingPlanCreditGrantsRequest } from "./CountBillingPlanCreditGrantsRequest";
@@ -0,0 +1,19 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Schematic from "../../../index";
5
+ /**
6
+ * Input parameters
7
+ */
8
+ export interface CountCreditLedgerParams {
9
+ billingCreditId?: string;
10
+ companyId?: string;
11
+ endTime?: string;
12
+ featureId?: string;
13
+ /** Page limit (default 100) */
14
+ limit?: number;
15
+ /** Page offset (default 0) */
16
+ offset?: number;
17
+ period?: Schematic.CountCreditLedgerResponseParamsPeriod;
18
+ startTime?: string;
19
+ }
@@ -0,0 +1,10 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export type CountCreditLedgerRequestPeriod = "daily" | "weekly" | "monthly" | "raw";
5
+ export declare const CountCreditLedgerRequestPeriod: {
6
+ readonly Daily: "daily";
7
+ readonly Weekly: "weekly";
8
+ readonly Monthly: "monthly";
9
+ readonly Raw: "raw";
10
+ };
@@ -0,0 +1,9 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Schematic from "../../../index";
5
+ export interface CountCreditLedgerResponse {
6
+ data: Schematic.CountResponse;
7
+ /** Input parameters */
8
+ params: Schematic.CountCreditLedgerParams;
9
+ }
@@ -0,0 +1,10 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export type CountCreditLedgerResponseParamsPeriod = "daily" | "weekly" | "monthly" | "raw";
5
+ export declare const CountCreditLedgerResponseParamsPeriod: {
6
+ readonly Daily: "daily";
7
+ readonly Weekly: "weekly";
8
+ readonly Monthly: "monthly";
9
+ readonly Raw: "raw";
10
+ };
@@ -0,0 +1,11 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export type CreateBillingPlanCreditGrantRequestBodyExpiryType = "duration" | "no_expiry" | "end_of_trial" | "end_of_billing_period" | "end_of_next_billing_period";
5
+ export declare const CreateBillingPlanCreditGrantRequestBodyExpiryType: {
6
+ readonly Duration: "duration";
7
+ readonly NoExpiry: "no_expiry";
8
+ readonly EndOfTrial: "end_of_trial";
9
+ readonly EndOfBillingPeriod: "end_of_billing_period";
10
+ readonly EndOfNextBillingPeriod: "end_of_next_billing_period";
11
+ };
@@ -0,0 +1,8 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export type CreateBillingPlanCreditGrantRequestBodyExpiryUnit = "days" | "billing_periods";
5
+ export declare const CreateBillingPlanCreditGrantRequestBodyExpiryUnit: {
6
+ readonly Days: "days";
7
+ readonly BillingPeriods: "billing_periods";
8
+ };
@@ -0,0 +1,8 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export type CreateBillingPlanCreditGrantRequestBodyResetType = "plan_period" | "no_reset";
5
+ export declare const CreateBillingPlanCreditGrantRequestBodyResetType: {
6
+ readonly PlanPeriod: "plan_period";
7
+ readonly NoReset: "no_reset";
8
+ };
@@ -0,0 +1,11 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export type CreateCompanyCreditGrantExpiryType = "duration" | "no_expiry" | "end_of_trial" | "end_of_billing_period" | "end_of_next_billing_period";
5
+ export declare const CreateCompanyCreditGrantExpiryType: {
6
+ readonly Duration: "duration";
7
+ readonly NoExpiry: "no_expiry";
8
+ readonly EndOfTrial: "end_of_trial";
9
+ readonly EndOfBillingPeriod: "end_of_billing_period";
10
+ readonly EndOfNextBillingPeriod: "end_of_next_billing_period";
11
+ };
@@ -0,0 +1,8 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export type CreateCompanyCreditGrantExpiryUnit = "days" | "billing_periods";
5
+ export declare const CreateCompanyCreditGrantExpiryUnit: {
6
+ readonly Days: "days";
7
+ readonly BillingPeriods: "billing_periods";
8
+ };
@@ -1,8 +1,11 @@
1
1
  /**
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
- export type CreateCreditBundleRequestBodyExpiryType = "days_from_purchase" | "no_expiry";
4
+ export type CreateCreditBundleRequestBodyExpiryType = "duration" | "no_expiry" | "end_of_trial" | "end_of_billing_period" | "end_of_next_billing_period";
5
5
  export declare const CreateCreditBundleRequestBodyExpiryType: {
6
- readonly DaysFromPurchase: "days_from_purchase";
6
+ readonly Duration: "duration";
7
7
  readonly NoExpiry: "no_expiry";
8
+ readonly EndOfTrial: "end_of_trial";
9
+ readonly EndOfBillingPeriod: "end_of_billing_period";
10
+ readonly EndOfNextBillingPeriod: "end_of_next_billing_period";
8
11
  };
@@ -0,0 +1,8 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export type CreateCreditBundleRequestBodyExpiryUnit = "days" | "billing_periods";
5
+ export declare const CreateCreditBundleRequestBodyExpiryUnit: {
6
+ readonly Days: "days";
7
+ readonly BillingPeriods: "billing_periods";
8
+ };
@@ -0,0 +1,19 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Schematic from "../../../index";
5
+ /**
6
+ * Input parameters
7
+ */
8
+ export interface GetEnrichedCreditLedgerParams {
9
+ billingCreditId?: string;
10
+ companyId?: string;
11
+ endTime?: string;
12
+ featureId?: string;
13
+ /** Page limit (default 100) */
14
+ limit?: number;
15
+ /** Page offset (default 0) */
16
+ offset?: number;
17
+ period?: Schematic.GetEnrichedCreditLedgerResponseParamsPeriod;
18
+ startTime?: string;
19
+ }
@@ -0,0 +1,10 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export type GetEnrichedCreditLedgerRequestPeriod = "daily" | "weekly" | "monthly" | "raw";
5
+ export declare const GetEnrichedCreditLedgerRequestPeriod: {
6
+ readonly Daily: "daily";
7
+ readonly Weekly: "weekly";
8
+ readonly Monthly: "monthly";
9
+ readonly Raw: "raw";
10
+ };
@@ -0,0 +1,9 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Schematic from "../../../index";
5
+ export interface GetEnrichedCreditLedgerResponse {
6
+ data: Schematic.CreditLedgerEnrichedEntryResponseData[];
7
+ /** Input parameters */
8
+ params: Schematic.GetEnrichedCreditLedgerParams;
9
+ }
@@ -0,0 +1,10 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export type GetEnrichedCreditLedgerResponseParamsPeriod = "daily" | "weekly" | "monthly" | "raw";
5
+ export declare const GetEnrichedCreditLedgerResponseParamsPeriod: {
6
+ readonly Daily: "daily";
7
+ readonly Weekly: "weekly";
8
+ readonly Monthly: "monthly";
9
+ readonly Raw: "raw";
10
+ };
@@ -3,7 +3,6 @@
3
3
  */
4
4
  import * as Schematic from "../../../index";
5
5
  export interface ListBillingCreditsResponse {
6
- /** The returned resources */
7
6
  data: Schematic.BillingCreditResponseData[];
8
7
  /** Input parameters */
9
8
  params: Schematic.ListBillingCreditsParams;