@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
@@ -4,8 +4,11 @@
4
4
  /**
5
5
  * @example
6
6
  * {
7
+ * companyId: "company_id",
7
8
  * customerExternalId: "customer_external_id",
8
- * subscriptionExternalId: "subscription_external_id"
9
+ * subscriptionExternalId: "subscription_external_id",
10
+ * limit: 1,
11
+ * offset: 1
9
12
  * }
10
13
  */
11
14
  export interface ListInvoicesRequest {
@@ -3,7 +3,11 @@
3
3
  */
4
4
  /**
5
5
  * @example
6
- * {}
6
+ * {
7
+ * displayName: "display_name",
8
+ * limit: 1,
9
+ * offset: 1
10
+ * }
7
11
  */
8
12
  export interface ListMetersRequest {
9
13
  displayName?: string;
@@ -4,7 +4,10 @@
4
4
  /**
5
5
  * @example
6
6
  * {
7
- * customerExternalId: "customer_external_id"
7
+ * companyId: "company_id",
8
+ * customerExternalId: "customer_external_id",
9
+ * limit: 1,
10
+ * offset: 1
8
11
  * }
9
12
  */
10
13
  export interface ListPaymentMethodsRequest {
@@ -4,7 +4,18 @@
4
4
  import * as Schematic from "../../../../index";
5
5
  /**
6
6
  * @example
7
- * {}
7
+ * {
8
+ * name: "name",
9
+ * q: "q",
10
+ * priceUsageType: "licensed",
11
+ * withoutLinkedToPlan: true,
12
+ * withOneTimeCharges: true,
13
+ * withZeroPrice: true,
14
+ * withPricesOnly: true,
15
+ * isActive: true,
16
+ * limit: 1,
17
+ * offset: 1
18
+ * }
8
19
  */
9
20
  export interface ListProductPricesRequest {
10
21
  ids?: string | string[];
@@ -4,15 +4,40 @@
4
4
  import * as Schematic from "../../../../index";
5
5
  /**
6
6
  * @example
7
- * {}
7
+ * {
8
+ * forInitialPlan: true,
9
+ * forTrialExpiryPlan: true,
10
+ * productId: "product_id",
11
+ * interval: "interval",
12
+ * price: 1,
13
+ * q: "q",
14
+ * requiresPaymentMethod: true,
15
+ * tiersMode: "volume",
16
+ * usageType: "licensed",
17
+ * limit: 1,
18
+ * offset: 1
19
+ * }
8
20
  */
9
21
  export interface SearchBillingPricesRequest {
22
+ /**
23
+ * Filter for prices valid for initial plans (free prices only)
24
+ */
25
+ forInitialPlan?: boolean;
26
+ /**
27
+ * Filter for prices valid for trial expiry plans (free prices only)
28
+ */
29
+ forTrialExpiryPlan?: boolean;
10
30
  ids?: string | string[];
11
- q?: string;
31
+ productId?: string;
12
32
  interval?: string;
13
- usageType?: Schematic.SearchBillingPricesRequestUsageType;
14
33
  price?: number;
34
+ q?: string;
35
+ /**
36
+ * Filter for prices that require a payment method (inverse of ForInitialPlan)
37
+ */
38
+ requiresPaymentMethod?: boolean;
15
39
  tiersMode?: Schematic.SearchBillingPricesRequestTiersMode;
40
+ usageType?: Schematic.SearchBillingPricesRequestUsageType;
16
41
  /**
17
42
  * Page limit (default 100)
18
43
  */
@@ -15,4 +15,4 @@ export { type ListProductPricesRequest } from "./ListProductPricesRequest";
15
15
  export { type CreateBillingProductRequestBody } from "./CreateBillingProductRequestBody";
16
16
  export { type ListBillingProductsRequest } from "./ListBillingProductsRequest";
17
17
  export { type CountBillingProductsRequest } from "./CountBillingProductsRequest";
18
- export { type CreateBillingSubscriptionsRequestBody } from "./CreateBillingSubscriptionsRequestBody";
18
+ export { type CreateBillingSubscriptionRequestBody } from "./CreateBillingSubscriptionRequestBody";
@@ -0,0 +1,8 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export type CreateBillingSubscriptionRequestBodyTrialEndSetting = "subscribe" | "cancel";
5
+ export declare const CreateBillingSubscriptionRequestBodyTrialEndSetting: {
6
+ readonly Subscribe: "subscribe";
7
+ readonly Cancel: "cancel";
8
+ };
@@ -3,7 +3,6 @@
3
3
  */
4
4
  import * as Schematic from "../../../index";
5
5
  export interface ListBillingProductsResponse {
6
- /** The returned resources */
7
6
  data: Schematic.BillingProductDetailResponseData[];
8
7
  /** Input parameters */
9
8
  params: Schematic.ListBillingProductsParams;
@@ -3,7 +3,6 @@
3
3
  */
4
4
  import * as Schematic from "../../../index";
5
5
  export interface ListCouponsResponse {
6
- /** The returned resources */
7
6
  data: Schematic.BillingCouponResponseData[];
8
7
  /** Input parameters */
9
8
  params: Schematic.ListCouponsParams;
@@ -3,7 +3,6 @@
3
3
  */
4
4
  import * as Schematic from "../../../index";
5
5
  export interface ListCustomersWithSubscriptionsResponse {
6
- /** The returned resources */
7
6
  data: Schematic.BillingCustomerWithSubscriptionsResponseData[];
8
7
  /** Input parameters */
9
8
  params: Schematic.ListCustomersWithSubscriptionsParams;
@@ -3,7 +3,6 @@
3
3
  */
4
4
  import * as Schematic from "../../../index";
5
5
  export interface ListInvoicesResponse {
6
- /** The returned resources */
7
6
  data: Schematic.InvoiceResponseData[];
8
7
  /** Input parameters */
9
8
  params: Schematic.ListInvoicesParams;
@@ -3,7 +3,6 @@
3
3
  */
4
4
  import * as Schematic from "../../../index";
5
5
  export interface ListMetersResponse {
6
- /** The returned resources */
7
6
  data: Schematic.BillingMeterResponseData[];
8
7
  /** Input parameters */
9
8
  params: Schematic.ListMetersParams;
@@ -3,7 +3,6 @@
3
3
  */
4
4
  import * as Schematic from "../../../index";
5
5
  export interface ListPaymentMethodsResponse {
6
- /** The returned resources */
7
6
  data: Schematic.PaymentMethodResponseData[];
8
7
  /** Input parameters */
9
8
  params: Schematic.ListPaymentMethodsParams;
@@ -3,7 +3,6 @@
3
3
  */
4
4
  import * as Schematic from "../../../index";
5
5
  export interface ListProductPricesResponse {
6
- /** The returned resources */
7
6
  data: Schematic.BillingPriceResponseData[];
8
7
  /** Input parameters */
9
8
  params: Schematic.ListProductPricesParams;
@@ -6,6 +6,10 @@ import * as Schematic from "../../../index";
6
6
  * Input parameters
7
7
  */
8
8
  export interface SearchBillingPricesParams {
9
+ /** Filter for prices valid for initial plans (free prices only) */
10
+ forInitialPlan?: boolean;
11
+ /** Filter for prices valid for trial expiry plans (free prices only) */
12
+ forTrialExpiryPlan?: boolean;
9
13
  ids?: string[];
10
14
  interval?: string;
11
15
  /** Page limit (default 100) */
@@ -13,7 +17,10 @@ export interface SearchBillingPricesParams {
13
17
  /** Page offset (default 0) */
14
18
  offset?: number;
15
19
  price?: number;
20
+ productId?: string;
16
21
  q?: string;
22
+ /** Filter for prices that require a payment method (inverse of ForInitialPlan) */
23
+ requiresPaymentMethod?: boolean;
17
24
  tiersMode?: Schematic.SearchBillingPricesResponseParamsTiersMode;
18
25
  usageType?: Schematic.SearchBillingPricesResponseParamsUsageType;
19
26
  }
@@ -3,7 +3,6 @@
3
3
  */
4
4
  import * as Schematic from "../../../index";
5
5
  export interface SearchBillingPricesResponse {
6
- /** The returned resources */
7
6
  data: Schematic.BillingPriceView[];
8
7
  /** Input parameters */
9
8
  params: Schematic.SearchBillingPricesParams;
@@ -15,8 +15,8 @@ export * from "./UpsertBillingMeterResponse";
15
15
  export * from "./ListPaymentMethodsParams";
16
16
  export * from "./ListPaymentMethodsResponse";
17
17
  export * from "./UpsertPaymentMethodResponse";
18
- export * from "./SearchBillingPricesRequestUsageType";
19
18
  export * from "./SearchBillingPricesRequestTiersMode";
19
+ export * from "./SearchBillingPricesRequestUsageType";
20
20
  export * from "./SearchBillingPricesResponseParamsTiersMode";
21
21
  export * from "./SearchBillingPricesResponseParamsUsageType";
22
22
  export * from "./SearchBillingPricesParams";
@@ -40,5 +40,5 @@ export * from "./CountBillingProductsRequestPriceUsageType";
40
40
  export * from "./CountBillingProductsResponseParamsPriceUsageType";
41
41
  export * from "./CountBillingProductsParams";
42
42
  export * from "./CountBillingProductsResponse";
43
- export * from "./CreateBillingSubscriptionsRequestBodyTrialEndSetting";
43
+ export * from "./CreateBillingSubscriptionRequestBodyTrialEndSetting";
44
44
  export * from "./UpsertBillingSubscriptionResponse";
@@ -9,7 +9,7 @@ export declare namespace Checkout {
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 Checkout {
25
25
  }
26
26
  export declare class Checkout {
27
27
  protected readonly _options: Checkout.Options;
28
- constructor(_options: Checkout.Options);
28
+ constructor(_options?: Checkout.Options);
29
29
  /**
30
30
  * @param {Schematic.ChangeSubscriptionInternalRequestBody} request
31
31
  * @param {Checkout.RequestOptions} requestOptions - Request-specific configuration.
@@ -107,6 +107,62 @@ export declare class Checkout {
107
107
  */
108
108
  previewCheckoutInternal(request: Schematic.ChangeSubscriptionInternalRequestBody, requestOptions?: Checkout.RequestOptions): core.HttpResponsePromise<Schematic.PreviewCheckoutInternalResponse>;
109
109
  private __previewCheckoutInternal;
110
+ /**
111
+ * @param {Schematic.ManagePlanRequest} request
112
+ * @param {Checkout.RequestOptions} requestOptions - Request-specific configuration.
113
+ *
114
+ * @throws {@link Schematic.BadRequestError}
115
+ * @throws {@link Schematic.UnauthorizedError}
116
+ * @throws {@link Schematic.ForbiddenError}
117
+ * @throws {@link Schematic.NotFoundError}
118
+ * @throws {@link Schematic.InternalServerError}
119
+ *
120
+ * @example
121
+ * await client.checkout.managePlan({
122
+ * addOnSelections: [{
123
+ * planId: "plan_id"
124
+ * }],
125
+ * companyId: "company_id",
126
+ * creditBundles: [{
127
+ * bundleId: "bundle_id",
128
+ * quantity: 1
129
+ * }],
130
+ * payInAdvanceEntitlements: [{
131
+ * priceId: "price_id",
132
+ * quantity: 1
133
+ * }]
134
+ * })
135
+ */
136
+ managePlan(request: Schematic.ManagePlanRequest, requestOptions?: Checkout.RequestOptions): core.HttpResponsePromise<Schematic.ManagePlanResponse>;
137
+ private __managePlan;
138
+ /**
139
+ * @param {Schematic.ManagePlanRequest} request
140
+ * @param {Checkout.RequestOptions} requestOptions - Request-specific configuration.
141
+ *
142
+ * @throws {@link Schematic.BadRequestError}
143
+ * @throws {@link Schematic.UnauthorizedError}
144
+ * @throws {@link Schematic.ForbiddenError}
145
+ * @throws {@link Schematic.NotFoundError}
146
+ * @throws {@link Schematic.InternalServerError}
147
+ *
148
+ * @example
149
+ * await client.checkout.previewManagePlan({
150
+ * addOnSelections: [{
151
+ * planId: "plan_id"
152
+ * }],
153
+ * companyId: "company_id",
154
+ * creditBundles: [{
155
+ * bundleId: "bundle_id",
156
+ * quantity: 1
157
+ * }],
158
+ * payInAdvanceEntitlements: [{
159
+ * priceId: "price_id",
160
+ * quantity: 1
161
+ * }]
162
+ * })
163
+ */
164
+ previewManagePlan(request: Schematic.ManagePlanRequest, requestOptions?: Checkout.RequestOptions): core.HttpResponsePromise<Schematic.PreviewManagePlanResponse>;
165
+ private __previewManagePlan;
110
166
  /**
111
167
  * @param {string} subscriptionId - subscription_id
112
168
  * @param {Schematic.UpdateTrialEndRequestBody} request
@@ -124,6 +180,6 @@ export declare class Checkout {
124
180
  updateCustomerSubscriptionTrialEnd(subscriptionId: string, request?: Schematic.UpdateTrialEndRequestBody, requestOptions?: Checkout.RequestOptions): core.HttpResponsePromise<Schematic.UpdateCustomerSubscriptionTrialEndResponse>;
125
181
  private __updateCustomerSubscriptionTrialEnd;
126
182
  protected _getCustomAuthorizationHeaders(): Promise<{
127
- "X-Schematic-Api-Key": string;
183
+ "X-Schematic-Api-Key": string | undefined;
128
184
  }>;
129
185
  }
@@ -3,7 +3,7 @@
3
3
  */
4
4
  import * as Schematic from "../../../index";
5
5
  export interface CheckoutInternalResponse {
6
- data: Schematic.BillingSubscriptionResponseData;
6
+ data: Schematic.CheckoutSubscription;
7
7
  /** Input parameters */
8
8
  params: Record<string, unknown>;
9
9
  }
@@ -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 ManagePlanResponse {
6
+ data: Schematic.ManagePlanResponseResponseData;
7
+ /** Input parameters */
8
+ params: Record<string, unknown>;
9
+ }
@@ -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 PreviewManagePlanResponse {
6
+ data: Schematic.ManagePlanPreviewResponseResponseData;
7
+ /** Input parameters */
8
+ params: Record<string, unknown>;
9
+ }
@@ -1,4 +1,6 @@
1
1
  export * from "./CheckoutInternalResponse";
2
2
  export * from "./GetCheckoutDataResponse";
3
3
  export * from "./PreviewCheckoutInternalResponse";
4
+ export * from "./ManagePlanResponse";
5
+ export * from "./PreviewManagePlanResponse";
4
6
  export * from "./UpdateCustomerSubscriptionTrialEndResponse";
@@ -9,7 +9,7 @@ export declare namespace Companies {
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 Companies {
25
25
  }
26
26
  export declare class Companies {
27
27
  protected readonly _options: Companies.Options;
28
- constructor(_options: Companies.Options);
28
+ constructor(_options?: Companies.Options);
29
29
  /**
30
30
  * @param {Schematic.ListCompaniesRequest} request
31
31
  * @param {Companies.RequestOptions} requestOptions - Request-specific configuration.
@@ -37,7 +37,15 @@ export declare class Companies {
37
37
  * @throws {@link Schematic.InternalServerError}
38
38
  *
39
39
  * @example
40
- * await client.companies.listCompanies()
40
+ * await client.companies.listCompanies({
41
+ * planId: "plan_id",
42
+ * q: "q",
43
+ * withoutFeatureOverrideFor: "without_feature_override_for",
44
+ * withoutPlan: true,
45
+ * withSubscription: true,
46
+ * limit: 1,
47
+ * offset: 1
48
+ * })
41
49
  */
42
50
  listCompanies(request?: Schematic.ListCompaniesRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.ListCompaniesResponse>;
43
51
  private __listCompanies;
@@ -100,7 +108,15 @@ export declare class Companies {
100
108
  * @throws {@link Schematic.InternalServerError}
101
109
  *
102
110
  * @example
103
- * await client.companies.countCompanies()
111
+ * await client.companies.countCompanies({
112
+ * planId: "plan_id",
113
+ * q: "q",
114
+ * withoutFeatureOverrideFor: "without_feature_override_for",
115
+ * withoutPlan: true,
116
+ * withSubscription: true,
117
+ * limit: 1,
118
+ * offset: 1
119
+ * })
104
120
  */
105
121
  countCompanies(request?: Schematic.CountCompaniesRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.CountCompaniesResponse>;
106
122
  private __countCompanies;
@@ -115,7 +131,16 @@ export declare class Companies {
115
131
  * @throws {@link Schematic.InternalServerError}
116
132
  *
117
133
  * @example
118
- * await client.companies.countCompaniesForAdvancedFilter()
134
+ * await client.companies.countCompaniesForAdvancedFilter({
135
+ * monetizedSubscriptions: true,
136
+ * q: "q",
137
+ * withoutPlan: true,
138
+ * withoutSubscription: true,
139
+ * sortOrderColumn: "sort_order_column",
140
+ * sortOrderDirection: "asc",
141
+ * limit: 1,
142
+ * offset: 1
143
+ * })
119
144
  */
120
145
  countCompaniesForAdvancedFilter(request?: Schematic.CountCompaniesForAdvancedFilterRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.CountCompaniesForAdvancedFilterResponse>;
121
146
  private __countCompaniesForAdvancedFilter;
@@ -168,7 +193,16 @@ export declare class Companies {
168
193
  * @throws {@link Schematic.InternalServerError}
169
194
  *
170
195
  * @example
171
- * await client.companies.listCompaniesForAdvancedFilter()
196
+ * await client.companies.listCompaniesForAdvancedFilter({
197
+ * monetizedSubscriptions: true,
198
+ * q: "q",
199
+ * withoutPlan: true,
200
+ * withoutSubscription: true,
201
+ * sortOrderColumn: "sort_order_column",
202
+ * sortOrderDirection: "asc",
203
+ * limit: 1,
204
+ * offset: 1
205
+ * })
172
206
  */
173
207
  listCompaniesForAdvancedFilter(request?: Schematic.ListCompaniesForAdvancedFilterRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.ListCompaniesForAdvancedFilterResponse>;
174
208
  private __listCompaniesForAdvancedFilter;
@@ -203,7 +237,9 @@ export declare class Companies {
203
237
  * @example
204
238
  * await client.companies.getActiveDeals({
205
239
  * companyId: "company_id",
206
- * dealStage: "deal_stage"
240
+ * dealStage: "deal_stage",
241
+ * limit: 1,
242
+ * offset: 1
207
243
  * })
208
244
  */
209
245
  getActiveDeals(request: Schematic.GetActiveDealsRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.GetActiveDealsResponse>;
@@ -219,7 +255,12 @@ export declare class Companies {
219
255
  * @throws {@link Schematic.InternalServerError}
220
256
  *
221
257
  * @example
222
- * await client.companies.listCompanyMemberships()
258
+ * await client.companies.listCompanyMemberships({
259
+ * companyId: "company_id",
260
+ * userId: "user_id",
261
+ * limit: 1,
262
+ * offset: 1
263
+ * })
223
264
  */
224
265
  listCompanyMemberships(request?: Schematic.ListCompanyMembershipsRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.ListCompanyMembershipsResponse>;
225
266
  private __listCompanyMemberships;
@@ -267,7 +308,11 @@ export declare class Companies {
267
308
  * @throws {@link Schematic.InternalServerError}
268
309
  *
269
310
  * @example
270
- * await client.companies.getActiveCompanySubscription()
311
+ * await client.companies.getActiveCompanySubscription({
312
+ * companyId: "company_id",
313
+ * limit: 1,
314
+ * offset: 1
315
+ * })
271
316
  */
272
317
  getActiveCompanySubscription(request?: Schematic.GetActiveCompanySubscriptionRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.GetActiveCompanySubscriptionResponse>;
273
318
  private __getActiveCompanySubscription;
@@ -302,7 +347,12 @@ export declare class Companies {
302
347
  * @throws {@link Schematic.InternalServerError}
303
348
  *
304
349
  * @example
305
- * await client.companies.listEntityKeyDefinitions()
350
+ * await client.companies.listEntityKeyDefinitions({
351
+ * entityType: "company",
352
+ * q: "q",
353
+ * limit: 1,
354
+ * offset: 1
355
+ * })
306
356
  */
307
357
  listEntityKeyDefinitions(request?: Schematic.ListEntityKeyDefinitionsRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.ListEntityKeyDefinitionsResponse>;
308
358
  private __listEntityKeyDefinitions;
@@ -317,7 +367,12 @@ export declare class Companies {
317
367
  * @throws {@link Schematic.InternalServerError}
318
368
  *
319
369
  * @example
320
- * await client.companies.countEntityKeyDefinitions()
370
+ * await client.companies.countEntityKeyDefinitions({
371
+ * entityType: "company",
372
+ * q: "q",
373
+ * limit: 1,
374
+ * offset: 1
375
+ * })
321
376
  */
322
377
  countEntityKeyDefinitions(request?: Schematic.CountEntityKeyDefinitionsRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.CountEntityKeyDefinitionsResponse>;
323
378
  private __countEntityKeyDefinitions;
@@ -332,7 +387,13 @@ export declare class Companies {
332
387
  * @throws {@link Schematic.InternalServerError}
333
388
  *
334
389
  * @example
335
- * await client.companies.listEntityTraitDefinitions()
390
+ * await client.companies.listEntityTraitDefinitions({
391
+ * entityType: "company",
392
+ * q: "q",
393
+ * traitType: "boolean",
394
+ * limit: 1,
395
+ * offset: 1
396
+ * })
336
397
  */
337
398
  listEntityTraitDefinitions(request?: Schematic.ListEntityTraitDefinitionsRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.ListEntityTraitDefinitionsResponse>;
338
399
  private __listEntityTraitDefinitions;
@@ -398,7 +459,13 @@ export declare class Companies {
398
459
  * @throws {@link Schematic.InternalServerError}
399
460
  *
400
461
  * @example
401
- * await client.companies.countEntityTraitDefinitions()
462
+ * await client.companies.countEntityTraitDefinitions({
463
+ * entityType: "company",
464
+ * q: "q",
465
+ * traitType: "boolean",
466
+ * limit: 1,
467
+ * offset: 1
468
+ * })
402
469
  */
403
470
  countEntityTraitDefinitions(request?: Schematic.CountEntityTraitDefinitionsRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.CountEntityTraitDefinitionsResponse>;
404
471
  private __countEntityTraitDefinitions;
@@ -414,7 +481,10 @@ export declare class Companies {
414
481
  *
415
482
  * @example
416
483
  * await client.companies.getEntityTraitValues({
417
- * definitionId: "definition_id"
484
+ * definitionId: "definition_id",
485
+ * q: "q",
486
+ * limit: 1,
487
+ * offset: 1
418
488
  * })
419
489
  */
420
490
  getEntityTraitValues(request: Schematic.GetEntityTraitValuesRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.GetEntityTraitValuesResponse>;
@@ -430,7 +500,12 @@ export declare class Companies {
430
500
  * @throws {@link Schematic.InternalServerError}
431
501
  *
432
502
  * @example
433
- * await client.companies.listPlanTraits()
503
+ * await client.companies.listPlanTraits({
504
+ * planId: "plan_id",
505
+ * traitId: "trait_id",
506
+ * limit: 1,
507
+ * offset: 1
508
+ * })
434
509
  */
435
510
  listPlanTraits(request?: Schematic.ListPlanTraitsRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.ListPlanTraitsResponse>;
436
511
  private __listPlanTraits;
@@ -501,6 +576,27 @@ export declare class Companies {
501
576
  */
502
577
  deletePlanTrait(planTraitId: string, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.DeletePlanTraitResponse>;
503
578
  private __deletePlanTrait;
579
+ /**
580
+ * @param {Schematic.UpdatePlanTraitBulkRequestBody} request
581
+ * @param {Companies.RequestOptions} requestOptions - Request-specific configuration.
582
+ *
583
+ * @throws {@link Schematic.BadRequestError}
584
+ * @throws {@link Schematic.UnauthorizedError}
585
+ * @throws {@link Schematic.ForbiddenError}
586
+ * @throws {@link Schematic.NotFoundError}
587
+ * @throws {@link Schematic.InternalServerError}
588
+ *
589
+ * @example
590
+ * await client.companies.updatePlanTraitsBulk({
591
+ * planId: "plan_id",
592
+ * traits: [{
593
+ * traitId: "trait_id",
594
+ * traitValue: "trait_value"
595
+ * }]
596
+ * })
597
+ */
598
+ updatePlanTraitsBulk(request: Schematic.UpdatePlanTraitBulkRequestBody, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.UpdatePlanTraitsBulkResponse>;
599
+ private __updatePlanTraitsBulk;
504
600
  /**
505
601
  * @param {Schematic.CountPlanTraitsRequest} request
506
602
  * @param {Companies.RequestOptions} requestOptions - Request-specific configuration.
@@ -512,7 +608,12 @@ export declare class Companies {
512
608
  * @throws {@link Schematic.InternalServerError}
513
609
  *
514
610
  * @example
515
- * await client.companies.countPlanTraits()
611
+ * await client.companies.countPlanTraits({
612
+ * planId: "plan_id",
613
+ * traitId: "trait_id",
614
+ * limit: 1,
615
+ * offset: 1
616
+ * })
516
617
  */
517
618
  countPlanTraits(request?: Schematic.CountPlanTraitsRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.CountPlanTraitsResponse>;
518
619
  private __countPlanTraits;
@@ -547,7 +648,13 @@ export declare class Companies {
547
648
  * @throws {@link Schematic.InternalServerError}
548
649
  *
549
650
  * @example
550
- * await client.companies.listUsers()
651
+ * await client.companies.listUsers({
652
+ * companyId: "company_id",
653
+ * planId: "plan_id",
654
+ * q: "q",
655
+ * limit: 1,
656
+ * offset: 1
657
+ * })
551
658
  */
552
659
  listUsers(request?: Schematic.ListUsersRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.ListUsersResponse>;
553
660
  private __listUsers;
@@ -610,7 +717,13 @@ export declare class Companies {
610
717
  * @throws {@link Schematic.InternalServerError}
611
718
  *
612
719
  * @example
613
- * await client.companies.countUsers()
720
+ * await client.companies.countUsers({
721
+ * companyId: "company_id",
722
+ * planId: "plan_id",
723
+ * q: "q",
724
+ * limit: 1,
725
+ * offset: 1
726
+ * })
614
727
  */
615
728
  countUsers(request?: Schematic.CountUsersRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.CountUsersResponse>;
616
729
  private __countUsers;
@@ -671,6 +784,6 @@ export declare class Companies {
671
784
  lookupUser(request: Schematic.LookupUserRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.LookupUserResponse>;
672
785
  private __lookupUser;
673
786
  protected _getCustomAuthorizationHeaders(): Promise<{
674
- "X-Schematic-Api-Key": string;
787
+ "X-Schematic-Api-Key": string | undefined;
675
788
  }>;
676
789
  }