@schematichq/schematic-typescript-node 1.2.2 → 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 (366) hide show
  1. package/dist/Client.d.ts +2 -2
  2. package/dist/api/resources/accesstokens/client/Client.d.ts +3 -3
  3. package/dist/api/resources/accesstokens/client/requests/IssueTemporaryAccessTokenRequestBody.d.ts +1 -3
  4. package/dist/api/resources/accounts/client/Client.d.ts +29 -8
  5. package/dist/api/resources/accounts/client/requests/CountApiKeysRequest.d.ts +4 -1
  6. package/dist/api/resources/accounts/client/requests/CountApiRequestsRequest.d.ts +7 -1
  7. package/dist/api/resources/accounts/client/requests/ListApiKeysRequest.d.ts +4 -1
  8. package/dist/api/resources/accounts/client/requests/ListApiRequestsRequest.d.ts +7 -1
  9. package/dist/api/resources/accounts/client/requests/ListEnvironmentsRequest.d.ts +4 -1
  10. package/dist/api/resources/accounts/types/ListApiKeysResponse.d.ts +0 -1
  11. package/dist/api/resources/accounts/types/ListApiRequestsResponse.d.ts +0 -1
  12. package/dist/api/resources/accounts/types/ListEnvironmentsResponse.d.ts +0 -1
  13. package/dist/api/resources/billing/client/Client.d.ts +87 -15
  14. package/dist/api/resources/billing/client/requests/CountBillingProductsRequest.d.ts +12 -1
  15. package/dist/api/resources/billing/client/requests/CountCustomersRequest.d.ts +7 -1
  16. package/dist/api/resources/billing/client/requests/{CreateBillingSubscriptionsRequestBody.d.ts → CreateBillingSubscriptionRequestBody.d.ts} +3 -2
  17. package/dist/api/resources/billing/client/requests/ListBillingProductsRequest.d.ts +12 -1
  18. package/dist/api/resources/billing/client/requests/ListCouponsRequest.d.ts +6 -1
  19. package/dist/api/resources/billing/client/requests/ListCustomersWithSubscriptionsRequest.d.ts +7 -1
  20. package/dist/api/resources/billing/client/requests/ListInvoicesRequest.d.ts +4 -1
  21. package/dist/api/resources/billing/client/requests/ListMetersRequest.d.ts +5 -1
  22. package/dist/api/resources/billing/client/requests/ListPaymentMethodsRequest.d.ts +4 -1
  23. package/dist/api/resources/billing/client/requests/ListProductPricesRequest.d.ts +12 -1
  24. package/dist/api/resources/billing/client/requests/SearchBillingPricesRequest.d.ts +28 -3
  25. package/dist/api/resources/billing/client/requests/index.d.ts +1 -1
  26. package/dist/api/resources/billing/types/CreateBillingSubscriptionRequestBodyTrialEndSetting.d.ts +8 -0
  27. package/dist/api/resources/billing/types/ListBillingProductsResponse.d.ts +0 -1
  28. package/dist/api/resources/billing/types/ListCouponsResponse.d.ts +0 -1
  29. package/dist/api/resources/billing/types/ListCustomersWithSubscriptionsResponse.d.ts +0 -1
  30. package/dist/api/resources/billing/types/ListInvoicesResponse.d.ts +0 -1
  31. package/dist/api/resources/billing/types/ListMetersResponse.d.ts +0 -1
  32. package/dist/api/resources/billing/types/ListPaymentMethodsResponse.d.ts +0 -1
  33. package/dist/api/resources/billing/types/ListProductPricesResponse.d.ts +0 -1
  34. package/dist/api/resources/billing/types/SearchBillingPricesParams.d.ts +7 -0
  35. package/dist/api/resources/billing/types/SearchBillingPricesResponse.d.ts +0 -1
  36. package/dist/api/resources/billing/types/index.d.ts +2 -2
  37. package/dist/api/resources/checkout/client/Client.d.ts +59 -3
  38. package/dist/api/resources/checkout/types/CheckoutInternalResponse.d.ts +1 -1
  39. package/dist/api/resources/checkout/types/ManagePlanResponse.d.ts +9 -0
  40. package/dist/api/resources/checkout/types/PreviewManagePlanResponse.d.ts +9 -0
  41. package/dist/api/resources/checkout/types/index.d.ts +2 -0
  42. package/dist/api/resources/companies/client/Client.d.ts +132 -19
  43. package/dist/api/resources/companies/client/requests/CountCompaniesForAdvancedFilterRequest.d.ts +15 -2
  44. package/dist/api/resources/companies/client/requests/CountCompaniesRequest.d.ts +9 -1
  45. package/dist/api/resources/companies/client/requests/CountEntityKeyDefinitionsRequest.d.ts +6 -1
  46. package/dist/api/resources/companies/client/requests/CountEntityTraitDefinitionsRequest.d.ts +7 -1
  47. package/dist/api/resources/companies/client/requests/CountPlanTraitsRequest.d.ts +6 -1
  48. package/dist/api/resources/companies/client/requests/CountUsersRequest.d.ts +7 -1
  49. package/dist/api/resources/companies/client/requests/GetActiveCompanySubscriptionRequest.d.ts +5 -1
  50. package/dist/api/resources/companies/client/requests/GetActiveDealsRequest.d.ts +3 -1
  51. package/dist/api/resources/companies/client/requests/GetEntityTraitValuesRequest.d.ts +4 -1
  52. package/dist/api/resources/companies/client/requests/ListCompaniesForAdvancedFilterRequest.d.ts +15 -2
  53. package/dist/api/resources/companies/client/requests/ListCompaniesRequest.d.ts +9 -1
  54. package/dist/api/resources/companies/client/requests/ListCompanyMembershipsRequest.d.ts +6 -1
  55. package/dist/api/resources/companies/client/requests/ListEntityKeyDefinitionsRequest.d.ts +6 -1
  56. package/dist/api/resources/companies/client/requests/ListEntityTraitDefinitionsRequest.d.ts +7 -1
  57. package/dist/api/resources/companies/client/requests/ListPlanTraitsRequest.d.ts +6 -1
  58. package/dist/api/resources/companies/client/requests/ListUsersRequest.d.ts +7 -1
  59. package/dist/api/resources/companies/client/requests/UpdatePlanTraitBulkRequestBody.d.ts +18 -0
  60. package/dist/api/resources/companies/client/requests/index.d.ts +1 -0
  61. package/dist/api/resources/companies/types/CountCompaniesForAdvancedFilterParams.d.ts +3 -1
  62. package/dist/api/resources/companies/types/GetActiveCompanySubscriptionResponse.d.ts +0 -1
  63. package/dist/api/resources/companies/types/GetActiveDealsResponse.d.ts +0 -1
  64. package/dist/api/resources/companies/types/GetEntityTraitValuesResponse.d.ts +0 -1
  65. package/dist/api/resources/companies/types/ListCompaniesForAdvancedFilterParams.d.ts +3 -1
  66. package/dist/api/resources/companies/types/ListCompaniesForAdvancedFilterResponse.d.ts +0 -1
  67. package/dist/api/resources/companies/types/ListCompaniesResponse.d.ts +0 -1
  68. package/dist/api/resources/companies/types/ListCompanyMembershipsResponse.d.ts +0 -1
  69. package/dist/api/resources/companies/types/ListEntityKeyDefinitionsResponse.d.ts +0 -1
  70. package/dist/api/resources/companies/types/ListEntityTraitDefinitionsResponse.d.ts +0 -1
  71. package/dist/api/resources/companies/types/ListPlanTraitsResponse.d.ts +0 -1
  72. package/dist/api/resources/companies/types/ListUsersResponse.d.ts +0 -1
  73. package/dist/api/resources/companies/types/UpdatePlanTraitsBulkResponse.d.ts +9 -0
  74. package/dist/api/resources/companies/types/index.d.ts +1 -0
  75. package/dist/api/resources/components/client/Client.d.ts +17 -6
  76. package/dist/api/resources/components/client/requests/CountComponentsRequest.d.ts +5 -1
  77. package/dist/api/resources/components/client/requests/ListComponentsRequest.d.ts +5 -1
  78. package/dist/api/resources/components/client/requests/PreviewComponentDataRequest.d.ts +4 -1
  79. package/dist/api/resources/components/types/ListComponentsResponse.d.ts +0 -1
  80. package/dist/api/resources/credits/client/Client.d.ts +104 -12
  81. package/dist/api/resources/credits/client/requests/CountBillingCreditsGrantsRequest.d.ts +5 -1
  82. package/dist/api/resources/credits/client/requests/CountBillingCreditsRequest.d.ts +5 -1
  83. package/dist/api/resources/credits/client/requests/CountBillingPlanCreditGrantsRequest.d.ts +6 -1
  84. package/dist/api/resources/credits/client/requests/CountCreditBundlesRequest.d.ts +7 -1
  85. package/dist/api/resources/credits/client/requests/CountCreditLedgerRequest.d.ts +33 -0
  86. package/dist/api/resources/credits/client/requests/CreateBillingPlanCreditGrantRequestBody.d.ts +4 -0
  87. package/dist/api/resources/credits/client/requests/CreateCompanyCreditGrant.d.ts +5 -0
  88. package/dist/api/resources/credits/client/requests/CreateCreditBundleRequestBody.d.ts +1 -1
  89. package/dist/api/resources/credits/client/requests/GetEnrichedCreditLedgerRequest.d.ts +33 -0
  90. package/dist/api/resources/credits/client/requests/ListBillingCreditsRequest.d.ts +5 -1
  91. package/dist/api/resources/credits/client/requests/ListBillingPlanCreditGrantsRequest.d.ts +6 -1
  92. package/dist/api/resources/credits/client/requests/ListCompanyGrantsRequest.d.ts +7 -1
  93. package/dist/api/resources/credits/client/requests/ListCreditBundlesRequest.d.ts +7 -1
  94. package/dist/api/resources/credits/client/requests/ListGrantsForCreditRequest.d.ts +5 -1
  95. package/dist/api/resources/credits/client/requests/UpdateCreditBundleDetailsRequestBody.d.ts +1 -0
  96. package/dist/api/resources/credits/client/requests/index.d.ts +2 -0
  97. package/dist/api/resources/credits/types/CountCreditLedgerParams.d.ts +19 -0
  98. package/dist/api/resources/credits/types/CountCreditLedgerRequestPeriod.d.ts +10 -0
  99. package/dist/api/resources/credits/types/CountCreditLedgerResponse.d.ts +9 -0
  100. package/dist/api/resources/credits/types/CountCreditLedgerResponseParamsPeriod.d.ts +10 -0
  101. package/dist/api/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyExpiryType.d.ts +11 -0
  102. package/dist/api/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyExpiryUnit.d.ts +8 -0
  103. package/dist/api/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyResetType.d.ts +8 -0
  104. package/dist/api/resources/credits/types/CreateCompanyCreditGrantExpiryType.d.ts +11 -0
  105. package/dist/api/resources/credits/types/CreateCompanyCreditGrantExpiryUnit.d.ts +8 -0
  106. package/dist/api/resources/credits/types/CreateCreditBundleRequestBodyExpiryType.d.ts +5 -2
  107. package/dist/api/resources/credits/types/CreateCreditBundleRequestBodyExpiryUnit.d.ts +8 -0
  108. package/dist/api/resources/credits/types/GetEnrichedCreditLedgerParams.d.ts +19 -0
  109. package/dist/api/resources/credits/types/GetEnrichedCreditLedgerRequestPeriod.d.ts +10 -0
  110. package/dist/api/resources/credits/types/GetEnrichedCreditLedgerResponse.d.ts +9 -0
  111. package/dist/api/resources/credits/types/GetEnrichedCreditLedgerResponseParamsPeriod.d.ts +10 -0
  112. package/dist/api/resources/credits/types/ListBillingCreditsResponse.d.ts +0 -1
  113. package/dist/api/resources/credits/types/ListBillingPlanCreditGrantsResponse.d.ts +0 -1
  114. package/dist/api/resources/credits/types/ListCompanyGrantsResponse.d.ts +0 -1
  115. package/dist/api/resources/credits/types/ListCreditBundlesResponse.d.ts +0 -1
  116. package/dist/api/resources/credits/types/ListGrantsForCreditResponse.d.ts +0 -1
  117. package/dist/api/resources/credits/types/UpdateCreditBundleDetailsRequestBodyExpiryType.d.ts +5 -2
  118. package/dist/api/resources/credits/types/UpdateCreditBundleDetailsRequestBodyExpiryUnit.d.ts +8 -0
  119. package/dist/api/resources/credits/types/ZeroOutGrantRequestBodyReason.d.ts +2 -1
  120. package/dist/api/resources/credits/types/index.d.ts +15 -0
  121. package/dist/api/resources/crm/client/Client.d.ts +8 -4
  122. package/dist/api/resources/crm/client/requests/ListCrmProductsRequest.d.ts +5 -1
  123. package/dist/api/resources/crm/types/ListCrmProductsResponse.d.ts +0 -1
  124. package/dist/api/resources/dataexports/client/Client.d.ts +3 -3
  125. package/dist/api/resources/entitlements/client/Client.d.ts +65 -13
  126. package/dist/api/resources/entitlements/client/requests/CountCompanyOverridesRequest.d.ts +8 -1
  127. package/dist/api/resources/entitlements/client/requests/CountFeatureCompaniesRequest.d.ts +4 -1
  128. package/dist/api/resources/entitlements/client/requests/CountFeatureUsageRequest.d.ts +7 -1
  129. package/dist/api/resources/entitlements/client/requests/CountFeatureUsersRequest.d.ts +4 -1
  130. package/dist/api/resources/entitlements/client/requests/CountPlanEntitlementsRequest.d.ts +8 -1
  131. package/dist/api/resources/entitlements/client/requests/CreateCompanyOverrideRequestBody.d.ts +1 -0
  132. package/dist/api/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +1 -0
  133. package/dist/api/resources/entitlements/client/requests/ListCompanyOverridesRequest.d.ts +8 -1
  134. package/dist/api/resources/entitlements/client/requests/ListFeatureCompaniesRequest.d.ts +4 -1
  135. package/dist/api/resources/entitlements/client/requests/ListFeatureUsageRequest.d.ts +7 -1
  136. package/dist/api/resources/entitlements/client/requests/ListFeatureUsersRequest.d.ts +4 -1
  137. package/dist/api/resources/entitlements/client/requests/ListPlanEntitlementsRequest.d.ts +8 -1
  138. package/dist/api/resources/entitlements/client/requests/UpdateCompanyOverrideRequestBody.d.ts +1 -0
  139. package/dist/api/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts +1 -0
  140. package/dist/api/resources/entitlements/types/ListCompanyOverridesResponse.d.ts +0 -1
  141. package/dist/api/resources/entitlements/types/ListFeatureCompaniesResponse.d.ts +0 -1
  142. package/dist/api/resources/entitlements/types/ListFeatureUsageResponse.d.ts +0 -1
  143. package/dist/api/resources/entitlements/types/ListFeatureUsersResponse.d.ts +0 -1
  144. package/dist/api/resources/entitlements/types/ListPlanEntitlementsResponse.d.ts +0 -1
  145. package/dist/api/resources/events/client/Client.d.ts +16 -5
  146. package/dist/api/resources/events/client/requests/GetEventSummariesRequest.d.ts +5 -1
  147. package/dist/api/resources/events/client/requests/ListEventsRequest.d.ts +8 -1
  148. package/dist/api/resources/events/types/GetEventSummariesResponse.d.ts +0 -1
  149. package/dist/api/resources/events/types/ListEventsResponse.d.ts +0 -1
  150. package/dist/api/resources/features/client/Client.d.ts +31 -7
  151. package/dist/api/resources/features/client/requests/CountFeaturesRequest.d.ts +11 -1
  152. package/dist/api/resources/features/client/requests/CountFlagsRequest.d.ts +9 -1
  153. package/dist/api/resources/features/client/requests/ListFeaturesRequest.d.ts +11 -1
  154. package/dist/api/resources/features/client/requests/ListFlagsRequest.d.ts +9 -1
  155. package/dist/api/resources/features/types/CountFeaturesParams.d.ts +1 -0
  156. package/dist/api/resources/features/types/CountFlagsParams.d.ts +1 -0
  157. package/dist/api/resources/features/types/ListAudienceCompaniesResponse.d.ts +0 -1
  158. package/dist/api/resources/features/types/ListAudienceUsersResponse.d.ts +0 -1
  159. package/dist/api/resources/features/types/ListFeaturesParams.d.ts +1 -0
  160. package/dist/api/resources/features/types/ListFeaturesResponse.d.ts +0 -1
  161. package/dist/api/resources/features/types/ListFlagsParams.d.ts +1 -0
  162. package/dist/api/resources/features/types/ListFlagsResponse.d.ts +0 -1
  163. package/dist/api/resources/plangroups/client/Client.d.ts +21 -5
  164. package/dist/api/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +22 -1
  165. package/dist/api/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +22 -1
  166. package/dist/api/resources/plans/client/Client.d.ts +50 -5
  167. package/dist/api/resources/plans/client/requests/CountPlansRequest.d.ts +31 -1
  168. package/dist/api/resources/plans/client/requests/ListPlanIssuesRequest.d.ts +12 -0
  169. package/dist/api/resources/plans/client/requests/ListPlansRequest.d.ts +31 -1
  170. package/dist/api/resources/plans/client/requests/index.d.ts +1 -0
  171. package/dist/api/resources/plans/types/CountPlansParams.d.ts +8 -0
  172. package/dist/api/resources/plans/types/ListPlanIssuesParams.d.ts +9 -0
  173. package/dist/api/resources/plans/types/ListPlanIssuesResponse.d.ts +9 -0
  174. package/dist/api/resources/plans/types/ListPlansParams.d.ts +8 -0
  175. package/dist/api/resources/plans/types/ListPlansResponse.d.ts +0 -1
  176. package/dist/api/resources/plans/types/index.d.ts +2 -0
  177. package/dist/api/resources/webhooks/client/Client.d.ts +25 -7
  178. package/dist/api/resources/webhooks/client/requests/CountWebhookEventsRequest.d.ts +6 -1
  179. package/dist/api/resources/webhooks/client/requests/CountWebhooksRequest.d.ts +5 -1
  180. package/dist/api/resources/webhooks/client/requests/ListWebhookEventsRequest.d.ts +6 -1
  181. package/dist/api/resources/webhooks/client/requests/ListWebhooksRequest.d.ts +5 -1
  182. package/dist/api/resources/webhooks/types/ListWebhookEventsResponse.d.ts +0 -1
  183. package/dist/api/resources/webhooks/types/ListWebhooksResponse.d.ts +0 -1
  184. package/dist/api/types/ApiKeyCreateResponseData.d.ts +0 -3
  185. package/dist/api/types/ApiKeyRequestResponseData.d.ts +0 -3
  186. package/dist/api/types/ApiKeyResponseData.d.ts +0 -3
  187. package/dist/api/types/BillingCreditBundleResponseData.d.ts +1 -0
  188. package/dist/api/types/BillingCreditBundleView.d.ts +1 -0
  189. package/dist/api/types/BillingCreditLedgerResponseData.d.ts +11 -0
  190. package/dist/api/types/BillingCustomerResponseData.d.ts +0 -3
  191. package/dist/api/types/BillingPlanCreditGrantResponseData.d.ts +7 -0
  192. package/dist/api/types/BillingProductDetailResponseData.d.ts +2 -1
  193. package/dist/api/types/BillingProductForSubscriptionResponseData.d.ts +2 -0
  194. package/dist/api/types/BillingProductPlanResponseData.d.ts +0 -3
  195. package/dist/api/types/BillingProductPricing.d.ts +2 -0
  196. package/dist/api/types/BillingProductResponseData.d.ts +2 -1
  197. package/dist/api/types/BillingSubscriptionView.d.ts +0 -3
  198. package/dist/api/types/CheckFlagResponseData.d.ts +0 -3
  199. package/dist/api/types/CheckFlagsResponseData.d.ts +0 -3
  200. package/dist/api/types/CheckoutDataResponseData.d.ts +0 -3
  201. package/dist/api/types/CheckoutSettingsResponseData.d.ts +8 -0
  202. package/dist/api/types/CheckoutSubscription.d.ts +25 -0
  203. package/dist/api/types/CompanyDetailResponseData.d.ts +1 -0
  204. package/dist/api/types/CompanyLedgerResponseData.d.ts +8 -0
  205. package/dist/api/types/CompanyOverrideNoteResponseData.d.ts +11 -0
  206. package/dist/api/types/CompanyOverrideResponseData.d.ts +1 -0
  207. package/dist/api/types/CompanyPlanDetailResponseData.d.ts +1 -0
  208. package/dist/api/types/CompanyViewWithFeatureUsageResponseData.d.ts +1 -0
  209. package/dist/api/types/ComponentCheckoutSettings.d.ts +9 -0
  210. package/dist/api/types/ComponentHydrateResponseData.d.ts +4 -0
  211. package/dist/api/types/ComponentPreviewResponseData.d.ts +4 -3
  212. package/dist/api/types/ComponentResponseData.d.ts +0 -3
  213. package/dist/api/types/Condition.d.ts +21 -0
  214. package/dist/api/types/ConditionGroup.d.ts +7 -0
  215. package/dist/api/types/CountResponse.d.ts +2 -4
  216. package/dist/api/types/CreditCompanyGrantView.d.ts +3 -0
  217. package/dist/api/types/CreditGrantDetail.d.ts +10 -0
  218. package/dist/api/types/CreditGrantDetailGrantReason.d.ts +9 -0
  219. package/dist/api/types/CreditLedgerEnrichedEntryResponseData.d.ts +27 -0
  220. package/dist/api/types/CreditUsage.d.ts +14 -0
  221. package/dist/api/types/CreditUsageResponseData.d.ts +14 -0
  222. package/dist/api/types/CrmDealResponseData.d.ts +0 -3
  223. package/dist/api/types/CrmLineItemResponseData.d.ts +0 -3
  224. package/dist/api/types/CrmProductResponseData.d.ts +0 -3
  225. package/dist/api/types/DataExportResponseData.d.ts +0 -3
  226. package/dist/api/types/EnvironmentDetailResponseData.d.ts +0 -3
  227. package/dist/api/types/EnvironmentResponseData.d.ts +0 -3
  228. package/dist/api/types/FeatureCompanyResponseData.d.ts +34 -1
  229. package/dist/api/types/FeatureCompanyResponseDataCreditGrantReason.d.ts +12 -0
  230. package/dist/api/types/FeatureCompanyUserResponseDataAllocationType.d.ts +2 -1
  231. package/dist/api/types/FeatureLedgerResponseData.d.ts +9 -0
  232. package/dist/api/types/FeatureUsageDataResponseData.d.ts +8 -0
  233. package/dist/api/types/FeatureUsageResponseData.d.ts +25 -0
  234. package/dist/api/types/FeatureUsageResponseDataCreditGrantReason.d.ts +12 -0
  235. package/dist/api/types/IssueTemporaryAccessTokenResponseData.d.ts +0 -3
  236. package/dist/api/types/ManagePlanPreviewResponseResponseData.d.ts +7 -0
  237. package/dist/api/types/ManagePlanRequest.d.ts +15 -0
  238. package/dist/api/types/ManagePlanResponseResponseData.d.ts +8 -0
  239. package/dist/api/types/PlanAudienceDetailResponseData.d.ts +0 -3
  240. package/dist/api/types/PlanCreditGrantView.d.ts +4 -0
  241. package/dist/api/types/PlanDetailResponseData.d.ts +1 -0
  242. package/dist/api/types/PlanEntitlementResponseData.d.ts +1 -0
  243. package/dist/api/types/PlanGroupDetailResponseData.d.ts +16 -3
  244. package/dist/api/types/PlanGroupPlanDetailResponseData.d.ts +1 -0
  245. package/dist/api/types/PlanGroupResponseData.d.ts +11 -3
  246. package/dist/api/types/PlanIssueResponseData.d.ts +9 -0
  247. package/dist/api/types/PlanSelection.d.ts +7 -0
  248. package/dist/api/types/PlanTraitResponseData.d.ts +0 -3
  249. package/dist/api/types/PreviewSubscriptionChangeResponseData.d.ts +0 -3
  250. package/dist/api/types/PreviewSubscriptionFinanceResponseData.d.ts +3 -0
  251. package/dist/api/types/RawEventBatchResponseData.d.ts +0 -3
  252. package/dist/api/types/Rule.d.ts +16 -0
  253. package/dist/api/types/RulesDetailResponseData.d.ts +0 -3
  254. package/dist/api/types/SegmentStatusResp.d.ts +0 -3
  255. package/dist/api/types/TraitDefinition.d.ts +8 -0
  256. package/dist/api/types/UpdatePlanTraitTraitRequestBody.d.ts +7 -0
  257. package/dist/api/types/UsageBasedEntitlementRequestBody.d.ts +1 -0
  258. package/dist/api/types/UsageBasedEntitlementResponseData.d.ts +1 -0
  259. package/dist/api/types/index.d.ts +24 -0
  260. package/dist/index.js +3 -3
  261. package/dist/serialization/resources/accesstokens/client/requests/IssueTemporaryAccessTokenRequestBody.d.ts +0 -1
  262. package/dist/serialization/resources/billing/client/requests/{CreateBillingSubscriptionsRequestBody.d.ts → CreateBillingSubscriptionRequestBody.d.ts} +5 -4
  263. package/dist/serialization/resources/billing/client/requests/index.d.ts +1 -1
  264. package/dist/serialization/resources/billing/types/CreateBillingSubscriptionRequestBodyTrialEndSetting.d.ts +10 -0
  265. package/dist/serialization/resources/billing/types/SearchBillingPricesParams.d.ts +4 -0
  266. package/dist/serialization/resources/billing/types/index.d.ts +2 -2
  267. package/dist/serialization/resources/checkout/types/CheckoutInternalResponse.d.ts +2 -2
  268. package/dist/serialization/resources/checkout/types/ManagePlanResponse.d.ts +14 -0
  269. package/dist/serialization/resources/checkout/types/PreviewManagePlanResponse.d.ts +14 -0
  270. package/dist/serialization/resources/checkout/types/index.d.ts +2 -0
  271. package/dist/serialization/resources/companies/client/requests/UpdatePlanTraitBulkRequestBody.d.ts +14 -0
  272. package/dist/serialization/resources/companies/client/requests/index.d.ts +1 -0
  273. package/dist/serialization/resources/companies/types/CountCompaniesForAdvancedFilterParams.d.ts +1 -0
  274. package/dist/serialization/resources/companies/types/ListCompaniesForAdvancedFilterParams.d.ts +1 -0
  275. package/dist/serialization/resources/companies/types/UpdatePlanTraitsBulkResponse.d.ts +14 -0
  276. package/dist/serialization/resources/companies/types/index.d.ts +1 -0
  277. package/dist/serialization/resources/credits/client/requests/CreateBillingPlanCreditGrantRequestBody.d.ts +7 -0
  278. package/dist/serialization/resources/credits/client/requests/CreateCompanyCreditGrant.d.ts +6 -0
  279. package/dist/serialization/resources/credits/client/requests/CreateCreditBundleRequestBody.d.ts +2 -1
  280. package/dist/serialization/resources/credits/client/requests/UpdateCreditBundleDetailsRequestBody.d.ts +2 -0
  281. package/dist/serialization/resources/credits/types/CountCreditLedgerParams.d.ts +20 -0
  282. package/dist/serialization/resources/credits/types/CountCreditLedgerRequestPeriod.d.ts +10 -0
  283. package/dist/serialization/resources/credits/types/CountCreditLedgerResponse.d.ts +15 -0
  284. package/dist/serialization/resources/credits/types/CountCreditLedgerResponseParamsPeriod.d.ts +10 -0
  285. package/dist/serialization/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyExpiryType.d.ts +10 -0
  286. package/dist/serialization/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyExpiryUnit.d.ts +10 -0
  287. package/dist/serialization/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyResetType.d.ts +10 -0
  288. package/dist/serialization/resources/credits/types/CreateCompanyCreditGrantExpiryType.d.ts +10 -0
  289. package/dist/serialization/resources/credits/types/CreateCompanyCreditGrantExpiryUnit.d.ts +10 -0
  290. package/dist/serialization/resources/credits/types/CreateCreditBundleRequestBodyExpiryType.d.ts +1 -1
  291. package/dist/serialization/resources/credits/types/CreateCreditBundleRequestBodyExpiryUnit.d.ts +10 -0
  292. package/dist/serialization/resources/credits/types/GetEnrichedCreditLedgerParams.d.ts +20 -0
  293. package/dist/serialization/resources/credits/types/GetEnrichedCreditLedgerRequestPeriod.d.ts +10 -0
  294. package/dist/serialization/resources/credits/types/GetEnrichedCreditLedgerResponse.d.ts +15 -0
  295. package/dist/serialization/resources/credits/types/GetEnrichedCreditLedgerResponseParamsPeriod.d.ts +10 -0
  296. package/dist/serialization/resources/credits/types/UpdateCreditBundleDetailsRequestBodyExpiryType.d.ts +1 -1
  297. package/dist/serialization/resources/credits/types/UpdateCreditBundleDetailsRequestBodyExpiryUnit.d.ts +10 -0
  298. package/dist/serialization/resources/credits/types/ZeroOutGrantRequestBodyReason.d.ts +1 -1
  299. package/dist/serialization/resources/credits/types/index.d.ts +15 -0
  300. package/dist/serialization/resources/entitlements/client/requests/CreateCompanyOverrideRequestBody.d.ts +1 -0
  301. package/dist/serialization/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +1 -0
  302. package/dist/serialization/resources/entitlements/client/requests/UpdateCompanyOverrideRequestBody.d.ts +1 -0
  303. package/dist/serialization/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts +1 -0
  304. package/dist/serialization/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +13 -0
  305. package/dist/serialization/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +13 -0
  306. package/dist/serialization/resources/plans/types/CountPlansParams.d.ts +4 -0
  307. package/dist/serialization/resources/plans/types/ListPlanIssuesParams.d.ts +12 -0
  308. package/dist/serialization/resources/plans/types/ListPlanIssuesResponse.d.ts +15 -0
  309. package/dist/serialization/resources/plans/types/ListPlansParams.d.ts +4 -0
  310. package/dist/serialization/resources/plans/types/index.d.ts +2 -0
  311. package/dist/serialization/types/BillingCreditBundleResponseData.d.ts +1 -0
  312. package/dist/serialization/types/BillingCreditBundleView.d.ts +1 -0
  313. package/dist/serialization/types/BillingCreditLedgerResponseData.d.ts +17 -0
  314. package/dist/serialization/types/BillingPlanCreditGrantResponseData.d.ts +7 -0
  315. package/dist/serialization/types/BillingProductDetailResponseData.d.ts +1 -1
  316. package/dist/serialization/types/BillingProductForSubscriptionResponseData.d.ts +2 -0
  317. package/dist/serialization/types/BillingProductPricing.d.ts +2 -0
  318. package/dist/serialization/types/BillingProductResponseData.d.ts +1 -1
  319. package/dist/serialization/types/CheckoutSettingsResponseData.d.ts +14 -0
  320. package/dist/serialization/types/CheckoutSubscription.d.ts +31 -0
  321. package/dist/serialization/types/CompanyDetailResponseData.d.ts +2 -0
  322. package/dist/serialization/types/CompanyLedgerResponseData.d.ts +14 -0
  323. package/dist/serialization/types/CompanyOverrideNoteResponseData.d.ts +17 -0
  324. package/dist/serialization/types/CompanyOverrideResponseData.d.ts +2 -0
  325. package/dist/serialization/types/CompanyPlanDetailResponseData.d.ts +2 -0
  326. package/dist/serialization/types/CompanyViewWithFeatureUsageResponseData.d.ts +2 -0
  327. package/dist/serialization/types/ComponentCheckoutSettings.d.ts +15 -0
  328. package/dist/serialization/types/ComponentHydrateResponseData.d.ts +5 -0
  329. package/dist/serialization/types/ComponentPreviewResponseData.d.ts +5 -0
  330. package/dist/serialization/types/Condition.d.ts +27 -0
  331. package/dist/serialization/types/ConditionGroup.d.ts +13 -0
  332. package/dist/serialization/types/CountResponse.d.ts +1 -1
  333. package/dist/serialization/types/CreditCompanyGrantView.d.ts +3 -0
  334. package/dist/serialization/types/CreditGrantDetail.d.ts +16 -0
  335. package/dist/serialization/types/CreditGrantDetailGrantReason.d.ts +10 -0
  336. package/dist/serialization/types/CreditLedgerEnrichedEntryResponseData.d.ts +35 -0
  337. package/dist/serialization/types/CreditUsage.d.ts +20 -0
  338. package/dist/serialization/types/CreditUsageResponseData.d.ts +20 -0
  339. package/dist/serialization/types/FeatureCompanyResponseData.d.ts +28 -0
  340. package/dist/serialization/types/FeatureCompanyResponseDataCreditGrantReason.d.ts +10 -0
  341. package/dist/serialization/types/FeatureCompanyUserResponseDataAllocationType.d.ts +1 -1
  342. package/dist/serialization/types/FeatureLedgerResponseData.d.ts +15 -0
  343. package/dist/serialization/types/FeatureUsageDataResponseData.d.ts +9 -0
  344. package/dist/serialization/types/FeatureUsageResponseData.d.ts +17 -0
  345. package/dist/serialization/types/FeatureUsageResponseDataCreditGrantReason.d.ts +10 -0
  346. package/dist/serialization/types/ManagePlanPreviewResponseResponseData.d.ts +13 -0
  347. package/dist/serialization/types/ManagePlanRequest.d.ts +23 -0
  348. package/dist/serialization/types/ManagePlanResponseResponseData.d.ts +14 -0
  349. package/dist/serialization/types/PlanCreditGrantView.d.ts +4 -0
  350. package/dist/serialization/types/PlanDetailResponseData.d.ts +2 -0
  351. package/dist/serialization/types/PlanEntitlementResponseData.d.ts +1 -0
  352. package/dist/serialization/types/PlanGroupDetailResponseData.d.ts +18 -0
  353. package/dist/serialization/types/PlanGroupPlanDetailResponseData.d.ts +2 -0
  354. package/dist/serialization/types/PlanGroupResponseData.d.ts +12 -0
  355. package/dist/serialization/types/PlanIssueResponseData.d.ts +15 -0
  356. package/dist/serialization/types/PlanSelection.d.ts +13 -0
  357. package/dist/serialization/types/PreviewSubscriptionFinanceResponseData.d.ts +3 -0
  358. package/dist/serialization/types/Rule.d.ts +23 -0
  359. package/dist/serialization/types/TraitDefinition.d.ts +14 -0
  360. package/dist/serialization/types/UpdatePlanTraitTraitRequestBody.d.ts +13 -0
  361. package/dist/serialization/types/UsageBasedEntitlementRequestBody.d.ts +1 -0
  362. package/dist/serialization/types/UsageBasedEntitlementResponseData.d.ts +1 -0
  363. package/dist/serialization/types/index.d.ts +24 -0
  364. package/package.json +1 -1
  365. package/dist/api/resources/billing/types/CreateBillingSubscriptionsRequestBodyTrialEndSetting.d.ts +0 -8
  366. package/dist/serialization/resources/billing/types/CreateBillingSubscriptionsRequestBodyTrialEndSetting.d.ts +0 -10
@@ -5,7 +5,9 @@
5
5
  * @example
6
6
  * {
7
7
  * companyId: "company_id",
8
- * dealStage: "deal_stage"
8
+ * dealStage: "deal_stage",
9
+ * limit: 1,
10
+ * offset: 1
9
11
  * }
10
12
  */
11
13
  export interface GetActiveDealsRequest {
@@ -4,7 +4,10 @@
4
4
  /**
5
5
  * @example
6
6
  * {
7
- * definitionId: "definition_id"
7
+ * definitionId: "definition_id",
8
+ * q: "q",
9
+ * limit: 1,
10
+ * offset: 1
8
11
  * }
9
12
  */
10
13
  export interface GetEntityTraitValuesRequest {
@@ -4,7 +4,16 @@
4
4
  import * as Schematic from "../../../../index";
5
5
  /**
6
6
  * @example
7
- * {}
7
+ * {
8
+ * monetizedSubscriptions: true,
9
+ * q: "q",
10
+ * withoutPlan: true,
11
+ * withoutSubscription: true,
12
+ * sortOrderColumn: "sort_order_column",
13
+ * sortOrderDirection: "asc",
14
+ * limit: 1,
15
+ * offset: 1
16
+ * }
8
17
  */
9
18
  export interface ListCompaniesForAdvancedFilterRequest {
10
19
  /**
@@ -19,6 +28,10 @@ export interface ListCompaniesForAdvancedFilterRequest {
19
28
  * Filter companies by one or more feature IDs (each ID starts with feat_)
20
29
  */
21
30
  featureIds?: string | string[];
31
+ /**
32
+ * Filter companies by one or more credit type IDs (each ID starts with bcrd_)
33
+ */
34
+ creditTypeIds?: string | string[];
22
35
  /**
23
36
  * Filter companies by one or more subscription statuses (active, canceled, expired, incomplete, incomplete_expired, past_due, paused, trialing, unpaid)
24
37
  */
@@ -52,7 +65,7 @@ export interface ListCompaniesForAdvancedFilterRequest {
52
65
  */
53
66
  sortOrderDirection?: Schematic.ListCompaniesForAdvancedFilterRequestSortOrderDirection;
54
67
  /**
55
- * Select the display columns to return (e.g. plan, subscription, users, last_seen)
68
+ * Select the display columns to return (e.g. plan, subscription, users, last_seen_at)
56
69
  */
57
70
  displayProperties?: string | string[];
58
71
  /**
@@ -3,7 +3,15 @@
3
3
  */
4
4
  /**
5
5
  * @example
6
- * {}
6
+ * {
7
+ * planId: "plan_id",
8
+ * q: "q",
9
+ * withoutFeatureOverrideFor: "without_feature_override_for",
10
+ * withoutPlan: true,
11
+ * withSubscription: true,
12
+ * limit: 1,
13
+ * offset: 1
14
+ * }
7
15
  */
8
16
  export interface ListCompaniesRequest {
9
17
  /**
@@ -3,7 +3,12 @@
3
3
  */
4
4
  /**
5
5
  * @example
6
- * {}
6
+ * {
7
+ * companyId: "company_id",
8
+ * userId: "user_id",
9
+ * limit: 1,
10
+ * offset: 1
11
+ * }
7
12
  */
8
13
  export interface ListCompanyMembershipsRequest {
9
14
  companyId?: string;
@@ -4,7 +4,12 @@
4
4
  import * as Schematic from "../../../../index";
5
5
  /**
6
6
  * @example
7
- * {}
7
+ * {
8
+ * entityType: "company",
9
+ * q: "q",
10
+ * limit: 1,
11
+ * offset: 1
12
+ * }
8
13
  */
9
14
  export interface ListEntityKeyDefinitionsRequest {
10
15
  entityType?: Schematic.ListEntityKeyDefinitionsRequestEntityType;
@@ -4,7 +4,13 @@
4
4
  import * as Schematic from "../../../../index";
5
5
  /**
6
6
  * @example
7
- * {}
7
+ * {
8
+ * entityType: "company",
9
+ * q: "q",
10
+ * traitType: "boolean",
11
+ * limit: 1,
12
+ * offset: 1
13
+ * }
8
14
  */
9
15
  export interface ListEntityTraitDefinitionsRequest {
10
16
  entityType?: Schematic.ListEntityTraitDefinitionsRequestEntityType;
@@ -3,7 +3,12 @@
3
3
  */
4
4
  /**
5
5
  * @example
6
- * {}
6
+ * {
7
+ * planId: "plan_id",
8
+ * traitId: "trait_id",
9
+ * limit: 1,
10
+ * offset: 1
11
+ * }
7
12
  */
8
13
  export interface ListPlanTraitsRequest {
9
14
  ids?: string | string[];
@@ -3,7 +3,13 @@
3
3
  */
4
4
  /**
5
5
  * @example
6
- * {}
6
+ * {
7
+ * companyId: "company_id",
8
+ * planId: "plan_id",
9
+ * q: "q",
10
+ * limit: 1,
11
+ * offset: 1
12
+ * }
7
13
  */
8
14
  export interface ListUsersRequest {
9
15
  /**
@@ -0,0 +1,18 @@
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
+ * planId: "plan_id",
9
+ * traits: [{
10
+ * traitId: "trait_id",
11
+ * traitValue: "trait_value"
12
+ * }]
13
+ * }
14
+ */
15
+ export interface UpdatePlanTraitBulkRequestBody {
16
+ planId: string;
17
+ traits: Schematic.UpdatePlanTraitTraitRequestBody[];
18
+ }
@@ -17,6 +17,7 @@ export { type GetEntityTraitValuesRequest } from "./GetEntityTraitValuesRequest"
17
17
  export { type ListPlanTraitsRequest } from "./ListPlanTraitsRequest";
18
18
  export { type CreatePlanTraitRequestBody } from "./CreatePlanTraitRequestBody";
19
19
  export { type UpdatePlanTraitRequestBody } from "./UpdatePlanTraitRequestBody";
20
+ export { type UpdatePlanTraitBulkRequestBody } from "./UpdatePlanTraitBulkRequestBody";
20
21
  export { type CountPlanTraitsRequest } from "./CountPlanTraitsRequest";
21
22
  export { type ListUsersRequest } from "./ListUsersRequest";
22
23
  export { type CountUsersRequest } from "./CountUsersRequest";
@@ -6,7 +6,9 @@ import * as Schematic from "../../../index";
6
6
  * Input parameters
7
7
  */
8
8
  export interface CountCompaniesForAdvancedFilterParams {
9
- /** Select the display columns to return (e.g. plan, subscription, users, last_seen) */
9
+ /** Filter companies by one or more credit type IDs (each ID starts with bcrd_) */
10
+ creditTypeIds?: string[];
11
+ /** Select the display columns to return (e.g. plan, subscription, users, last_seen_at) */
10
12
  displayProperties?: string[];
11
13
  /** Filter companies by one or more feature IDs (each ID starts with feat_) */
12
14
  featureIds?: string[];
@@ -3,7 +3,6 @@
3
3
  */
4
4
  import * as Schematic from "../../../index";
5
5
  export interface GetActiveCompanySubscriptionResponse {
6
- /** The returned resources */
7
6
  data: Schematic.CompanySubscriptionResponseData[];
8
7
  /** Input parameters */
9
8
  params: Schematic.GetActiveCompanySubscriptionParams;
@@ -3,7 +3,6 @@
3
3
  */
4
4
  import * as Schematic from "../../../index";
5
5
  export interface GetActiveDealsResponse {
6
- /** The returned resources */
7
6
  data: Schematic.CompanyCrmDealsResponseData[];
8
7
  /** Input parameters */
9
8
  params: Schematic.GetActiveDealsParams;
@@ -3,7 +3,6 @@
3
3
  */
4
4
  import * as Schematic from "../../../index";
5
5
  export interface GetEntityTraitValuesResponse {
6
- /** The returned resources */
7
6
  data: Schematic.EntityTraitValue[];
8
7
  /** Input parameters */
9
8
  params: Schematic.GetEntityTraitValuesParams;
@@ -6,7 +6,9 @@ import * as Schematic from "../../../index";
6
6
  * Input parameters
7
7
  */
8
8
  export interface ListCompaniesForAdvancedFilterParams {
9
- /** Select the display columns to return (e.g. plan, subscription, users, last_seen) */
9
+ /** Filter companies by one or more credit type IDs (each ID starts with bcrd_) */
10
+ creditTypeIds?: string[];
11
+ /** Select the display columns to return (e.g. plan, subscription, users, last_seen_at) */
10
12
  displayProperties?: string[];
11
13
  /** Filter companies by one or more feature IDs (each ID starts with feat_) */
12
14
  featureIds?: string[];
@@ -3,7 +3,6 @@
3
3
  */
4
4
  import * as Schematic from "../../../index";
5
5
  export interface ListCompaniesForAdvancedFilterResponse {
6
- /** The returned resources */
7
6
  data: Schematic.CompanyViewWithFeatureUsageResponseData[];
8
7
  /** Input parameters */
9
8
  params: Schematic.ListCompaniesForAdvancedFilterParams;
@@ -3,7 +3,6 @@
3
3
  */
4
4
  import * as Schematic from "../../../index";
5
5
  export interface ListCompaniesResponse {
6
- /** The returned resources */
7
6
  data: Schematic.CompanyDetailResponseData[];
8
7
  /** Input parameters */
9
8
  params: Schematic.ListCompaniesParams;
@@ -3,7 +3,6 @@
3
3
  */
4
4
  import * as Schematic from "../../../index";
5
5
  export interface ListCompanyMembershipsResponse {
6
- /** The returned resources */
7
6
  data: Schematic.CompanyMembershipDetailResponseData[];
8
7
  /** Input parameters */
9
8
  params: Schematic.ListCompanyMembershipsParams;
@@ -3,7 +3,6 @@
3
3
  */
4
4
  import * as Schematic from "../../../index";
5
5
  export interface ListEntityKeyDefinitionsResponse {
6
- /** The returned resources */
7
6
  data: Schematic.EntityKeyDefinitionResponseData[];
8
7
  /** Input parameters */
9
8
  params: Schematic.ListEntityKeyDefinitionsParams;
@@ -3,7 +3,6 @@
3
3
  */
4
4
  import * as Schematic from "../../../index";
5
5
  export interface ListEntityTraitDefinitionsResponse {
6
- /** The returned resources */
7
6
  data: Schematic.EntityTraitDefinitionResponseData[];
8
7
  /** Input parameters */
9
8
  params: Schematic.ListEntityTraitDefinitionsParams;
@@ -3,7 +3,6 @@
3
3
  */
4
4
  import * as Schematic from "../../../index";
5
5
  export interface ListPlanTraitsResponse {
6
- /** The returned resources */
7
6
  data: Schematic.PlanTraitResponseData[];
8
7
  /** Input parameters */
9
8
  params: Schematic.ListPlanTraitsParams;
@@ -3,7 +3,6 @@
3
3
  */
4
4
  import * as Schematic from "../../../index";
5
5
  export interface ListUsersResponse {
6
- /** The returned resources */
7
6
  data: Schematic.UserDetailResponseData[];
8
7
  /** Input parameters */
9
8
  params: Schematic.ListUsersParams;
@@ -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 UpdatePlanTraitsBulkResponse {
6
+ data: Schematic.PlanTraitResponseData[];
7
+ /** Input parameters */
8
+ params: Record<string, unknown>;
9
+ }
@@ -60,6 +60,7 @@ export * from "./CreatePlanTraitResponse";
60
60
  export * from "./GetPlanTraitResponse";
61
61
  export * from "./UpdatePlanTraitResponse";
62
62
  export * from "./DeletePlanTraitResponse";
63
+ export * from "./UpdatePlanTraitsBulkResponse";
63
64
  export * from "./CountPlanTraitsParams";
64
65
  export * from "./CountPlanTraitsResponse";
65
66
  export * from "./UpsertUserTraitResponse";
@@ -9,7 +9,7 @@ export declare namespace Components {
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 Components {
25
25
  }
26
26
  export declare class Components {
27
27
  protected readonly _options: Components.Options;
28
- constructor(_options: Components.Options);
28
+ constructor(_options?: Components.Options);
29
29
  /**
30
30
  * @param {Schematic.ListComponentsRequest} request
31
31
  * @param {Components.RequestOptions} requestOptions - Request-specific configuration.
@@ -37,7 +37,11 @@ export declare class Components {
37
37
  * @throws {@link Schematic.InternalServerError}
38
38
  *
39
39
  * @example
40
- * await client.components.listComponents()
40
+ * await client.components.listComponents({
41
+ * q: "q",
42
+ * limit: 1,
43
+ * offset: 1
44
+ * })
41
45
  */
42
46
  listComponents(request?: Schematic.ListComponentsRequest, requestOptions?: Components.RequestOptions): core.HttpResponsePromise<Schematic.ListComponentsResponse>;
43
47
  private __listComponents;
@@ -115,7 +119,11 @@ export declare class Components {
115
119
  * @throws {@link Schematic.InternalServerError}
116
120
  *
117
121
  * @example
118
- * await client.components.countComponents()
122
+ * await client.components.countComponents({
123
+ * q: "q",
124
+ * limit: 1,
125
+ * offset: 1
126
+ * })
119
127
  */
120
128
  countComponents(request?: Schematic.CountComponentsRequest, requestOptions?: Components.RequestOptions): core.HttpResponsePromise<Schematic.CountComponentsResponse>;
121
129
  private __countComponents;
@@ -129,11 +137,14 @@ export declare class Components {
129
137
  * @throws {@link Schematic.InternalServerError}
130
138
  *
131
139
  * @example
132
- * await client.components.previewComponentData()
140
+ * await client.components.previewComponentData({
141
+ * companyId: "company_id",
142
+ * componentId: "component_id"
143
+ * })
133
144
  */
134
145
  previewComponentData(request?: Schematic.PreviewComponentDataRequest, requestOptions?: Components.RequestOptions): core.HttpResponsePromise<Schematic.PreviewComponentDataResponse>;
135
146
  private __previewComponentData;
136
147
  protected _getCustomAuthorizationHeaders(): Promise<{
137
- "X-Schematic-Api-Key": string;
148
+ "X-Schematic-Api-Key": string | undefined;
138
149
  }>;
139
150
  }
@@ -3,7 +3,11 @@
3
3
  */
4
4
  /**
5
5
  * @example
6
- * {}
6
+ * {
7
+ * q: "q",
8
+ * limit: 1,
9
+ * offset: 1
10
+ * }
7
11
  */
8
12
  export interface CountComponentsRequest {
9
13
  q?: string;
@@ -3,7 +3,11 @@
3
3
  */
4
4
  /**
5
5
  * @example
6
- * {}
6
+ * {
7
+ * q: "q",
8
+ * limit: 1,
9
+ * offset: 1
10
+ * }
7
11
  */
8
12
  export interface ListComponentsRequest {
9
13
  q?: string;
@@ -3,7 +3,10 @@
3
3
  */
4
4
  /**
5
5
  * @example
6
- * {}
6
+ * {
7
+ * companyId: "company_id",
8
+ * componentId: "component_id"
9
+ * }
7
10
  */
8
11
  export interface PreviewComponentDataRequest {
9
12
  companyId?: string;
@@ -3,7 +3,6 @@
3
3
  */
4
4
  import * as Schematic from "../../../index";
5
5
  export interface ListComponentsResponse {
6
- /** The returned resources */
7
6
  data: Schematic.ComponentResponseData[];
8
7
  /** Input parameters */
9
8
  params: Schematic.ListComponentsParams;
@@ -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[];