@schematichq/schematic-typescript-node 1.2.1 → 1.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (368) hide show
  1. package/README.md +114 -0
  2. package/dist/Client.d.ts +2 -2
  3. package/dist/api/resources/accesstokens/client/Client.d.ts +3 -3
  4. package/dist/api/resources/accesstokens/client/requests/IssueTemporaryAccessTokenRequestBody.d.ts +1 -3
  5. package/dist/api/resources/accounts/client/Client.d.ts +29 -8
  6. package/dist/api/resources/accounts/client/requests/CountApiKeysRequest.d.ts +4 -1
  7. package/dist/api/resources/accounts/client/requests/CountApiRequestsRequest.d.ts +7 -1
  8. package/dist/api/resources/accounts/client/requests/ListApiKeysRequest.d.ts +4 -1
  9. package/dist/api/resources/accounts/client/requests/ListApiRequestsRequest.d.ts +7 -1
  10. package/dist/api/resources/accounts/client/requests/ListEnvironmentsRequest.d.ts +4 -1
  11. package/dist/api/resources/accounts/types/ListApiKeysResponse.d.ts +0 -1
  12. package/dist/api/resources/accounts/types/ListApiRequestsResponse.d.ts +0 -1
  13. package/dist/api/resources/accounts/types/ListEnvironmentsResponse.d.ts +0 -1
  14. package/dist/api/resources/billing/client/Client.d.ts +87 -15
  15. package/dist/api/resources/billing/client/requests/CountBillingProductsRequest.d.ts +12 -1
  16. package/dist/api/resources/billing/client/requests/CountCustomersRequest.d.ts +7 -1
  17. package/dist/api/resources/billing/client/requests/{CreateBillingSubscriptionsRequestBody.d.ts → CreateBillingSubscriptionRequestBody.d.ts} +3 -2
  18. package/dist/api/resources/billing/client/requests/ListBillingProductsRequest.d.ts +12 -1
  19. package/dist/api/resources/billing/client/requests/ListCouponsRequest.d.ts +6 -1
  20. package/dist/api/resources/billing/client/requests/ListCustomersWithSubscriptionsRequest.d.ts +7 -1
  21. package/dist/api/resources/billing/client/requests/ListInvoicesRequest.d.ts +4 -1
  22. package/dist/api/resources/billing/client/requests/ListMetersRequest.d.ts +5 -1
  23. package/dist/api/resources/billing/client/requests/ListPaymentMethodsRequest.d.ts +4 -1
  24. package/dist/api/resources/billing/client/requests/ListProductPricesRequest.d.ts +12 -1
  25. package/dist/api/resources/billing/client/requests/SearchBillingPricesRequest.d.ts +28 -3
  26. package/dist/api/resources/billing/client/requests/index.d.ts +1 -1
  27. package/dist/api/resources/billing/types/CreateBillingSubscriptionRequestBodyTrialEndSetting.d.ts +8 -0
  28. package/dist/api/resources/billing/types/ListBillingProductsResponse.d.ts +0 -1
  29. package/dist/api/resources/billing/types/ListCouponsResponse.d.ts +0 -1
  30. package/dist/api/resources/billing/types/ListCustomersWithSubscriptionsResponse.d.ts +0 -1
  31. package/dist/api/resources/billing/types/ListInvoicesResponse.d.ts +0 -1
  32. package/dist/api/resources/billing/types/ListMetersResponse.d.ts +0 -1
  33. package/dist/api/resources/billing/types/ListPaymentMethodsResponse.d.ts +0 -1
  34. package/dist/api/resources/billing/types/ListProductPricesResponse.d.ts +0 -1
  35. package/dist/api/resources/billing/types/SearchBillingPricesParams.d.ts +7 -0
  36. package/dist/api/resources/billing/types/SearchBillingPricesResponse.d.ts +0 -1
  37. package/dist/api/resources/billing/types/index.d.ts +2 -2
  38. package/dist/api/resources/checkout/client/Client.d.ts +59 -3
  39. package/dist/api/resources/checkout/types/CheckoutInternalResponse.d.ts +1 -1
  40. package/dist/api/resources/checkout/types/ManagePlanResponse.d.ts +9 -0
  41. package/dist/api/resources/checkout/types/PreviewManagePlanResponse.d.ts +9 -0
  42. package/dist/api/resources/checkout/types/index.d.ts +2 -0
  43. package/dist/api/resources/companies/client/Client.d.ts +132 -19
  44. package/dist/api/resources/companies/client/requests/CountCompaniesForAdvancedFilterRequest.d.ts +15 -2
  45. package/dist/api/resources/companies/client/requests/CountCompaniesRequest.d.ts +9 -1
  46. package/dist/api/resources/companies/client/requests/CountEntityKeyDefinitionsRequest.d.ts +6 -1
  47. package/dist/api/resources/companies/client/requests/CountEntityTraitDefinitionsRequest.d.ts +7 -1
  48. package/dist/api/resources/companies/client/requests/CountPlanTraitsRequest.d.ts +6 -1
  49. package/dist/api/resources/companies/client/requests/CountUsersRequest.d.ts +7 -1
  50. package/dist/api/resources/companies/client/requests/GetActiveCompanySubscriptionRequest.d.ts +5 -1
  51. package/dist/api/resources/companies/client/requests/GetActiveDealsRequest.d.ts +3 -1
  52. package/dist/api/resources/companies/client/requests/GetEntityTraitValuesRequest.d.ts +4 -1
  53. package/dist/api/resources/companies/client/requests/ListCompaniesForAdvancedFilterRequest.d.ts +15 -2
  54. package/dist/api/resources/companies/client/requests/ListCompaniesRequest.d.ts +9 -1
  55. package/dist/api/resources/companies/client/requests/ListCompanyMembershipsRequest.d.ts +6 -1
  56. package/dist/api/resources/companies/client/requests/ListEntityKeyDefinitionsRequest.d.ts +6 -1
  57. package/dist/api/resources/companies/client/requests/ListEntityTraitDefinitionsRequest.d.ts +7 -1
  58. package/dist/api/resources/companies/client/requests/ListPlanTraitsRequest.d.ts +6 -1
  59. package/dist/api/resources/companies/client/requests/ListUsersRequest.d.ts +7 -1
  60. package/dist/api/resources/companies/client/requests/UpdatePlanTraitBulkRequestBody.d.ts +18 -0
  61. package/dist/api/resources/companies/client/requests/index.d.ts +1 -0
  62. package/dist/api/resources/companies/types/CountCompaniesForAdvancedFilterParams.d.ts +3 -1
  63. package/dist/api/resources/companies/types/GetActiveCompanySubscriptionResponse.d.ts +0 -1
  64. package/dist/api/resources/companies/types/GetActiveDealsResponse.d.ts +0 -1
  65. package/dist/api/resources/companies/types/GetEntityTraitValuesResponse.d.ts +0 -1
  66. package/dist/api/resources/companies/types/ListCompaniesForAdvancedFilterParams.d.ts +3 -1
  67. package/dist/api/resources/companies/types/ListCompaniesForAdvancedFilterResponse.d.ts +0 -1
  68. package/dist/api/resources/companies/types/ListCompaniesResponse.d.ts +0 -1
  69. package/dist/api/resources/companies/types/ListCompanyMembershipsResponse.d.ts +0 -1
  70. package/dist/api/resources/companies/types/ListEntityKeyDefinitionsResponse.d.ts +0 -1
  71. package/dist/api/resources/companies/types/ListEntityTraitDefinitionsResponse.d.ts +0 -1
  72. package/dist/api/resources/companies/types/ListPlanTraitsResponse.d.ts +0 -1
  73. package/dist/api/resources/companies/types/ListUsersResponse.d.ts +0 -1
  74. package/dist/api/resources/companies/types/UpdatePlanTraitsBulkResponse.d.ts +9 -0
  75. package/dist/api/resources/companies/types/index.d.ts +1 -0
  76. package/dist/api/resources/components/client/Client.d.ts +17 -6
  77. package/dist/api/resources/components/client/requests/CountComponentsRequest.d.ts +5 -1
  78. package/dist/api/resources/components/client/requests/ListComponentsRequest.d.ts +5 -1
  79. package/dist/api/resources/components/client/requests/PreviewComponentDataRequest.d.ts +4 -1
  80. package/dist/api/resources/components/types/ListComponentsResponse.d.ts +0 -1
  81. package/dist/api/resources/credits/client/Client.d.ts +104 -12
  82. package/dist/api/resources/credits/client/requests/CountBillingCreditsGrantsRequest.d.ts +5 -1
  83. package/dist/api/resources/credits/client/requests/CountBillingCreditsRequest.d.ts +5 -1
  84. package/dist/api/resources/credits/client/requests/CountBillingPlanCreditGrantsRequest.d.ts +6 -1
  85. package/dist/api/resources/credits/client/requests/CountCreditBundlesRequest.d.ts +7 -1
  86. package/dist/api/resources/credits/client/requests/CountCreditLedgerRequest.d.ts +33 -0
  87. package/dist/api/resources/credits/client/requests/CreateBillingPlanCreditGrantRequestBody.d.ts +4 -0
  88. package/dist/api/resources/credits/client/requests/CreateCompanyCreditGrant.d.ts +5 -0
  89. package/dist/api/resources/credits/client/requests/CreateCreditBundleRequestBody.d.ts +1 -1
  90. package/dist/api/resources/credits/client/requests/GetEnrichedCreditLedgerRequest.d.ts +33 -0
  91. package/dist/api/resources/credits/client/requests/ListBillingCreditsRequest.d.ts +5 -1
  92. package/dist/api/resources/credits/client/requests/ListBillingPlanCreditGrantsRequest.d.ts +6 -1
  93. package/dist/api/resources/credits/client/requests/ListCompanyGrantsRequest.d.ts +7 -1
  94. package/dist/api/resources/credits/client/requests/ListCreditBundlesRequest.d.ts +7 -1
  95. package/dist/api/resources/credits/client/requests/ListGrantsForCreditRequest.d.ts +5 -1
  96. package/dist/api/resources/credits/client/requests/UpdateCreditBundleDetailsRequestBody.d.ts +1 -0
  97. package/dist/api/resources/credits/client/requests/index.d.ts +2 -0
  98. package/dist/api/resources/credits/types/CountCreditLedgerParams.d.ts +19 -0
  99. package/dist/api/resources/credits/types/CountCreditLedgerRequestPeriod.d.ts +10 -0
  100. package/dist/api/resources/credits/types/CountCreditLedgerResponse.d.ts +9 -0
  101. package/dist/api/resources/credits/types/CountCreditLedgerResponseParamsPeriod.d.ts +10 -0
  102. package/dist/api/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyExpiryType.d.ts +11 -0
  103. package/dist/api/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyExpiryUnit.d.ts +8 -0
  104. package/dist/api/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyResetType.d.ts +8 -0
  105. package/dist/api/resources/credits/types/CreateCompanyCreditGrantExpiryType.d.ts +11 -0
  106. package/dist/api/resources/credits/types/CreateCompanyCreditGrantExpiryUnit.d.ts +8 -0
  107. package/dist/api/resources/credits/types/CreateCreditBundleRequestBodyExpiryType.d.ts +5 -2
  108. package/dist/api/resources/credits/types/CreateCreditBundleRequestBodyExpiryUnit.d.ts +8 -0
  109. package/dist/api/resources/credits/types/GetEnrichedCreditLedgerParams.d.ts +19 -0
  110. package/dist/api/resources/credits/types/GetEnrichedCreditLedgerRequestPeriod.d.ts +10 -0
  111. package/dist/api/resources/credits/types/GetEnrichedCreditLedgerResponse.d.ts +9 -0
  112. package/dist/api/resources/credits/types/GetEnrichedCreditLedgerResponseParamsPeriod.d.ts +10 -0
  113. package/dist/api/resources/credits/types/ListBillingCreditsResponse.d.ts +0 -1
  114. package/dist/api/resources/credits/types/ListBillingPlanCreditGrantsResponse.d.ts +0 -1
  115. package/dist/api/resources/credits/types/ListCompanyGrantsResponse.d.ts +0 -1
  116. package/dist/api/resources/credits/types/ListCreditBundlesResponse.d.ts +0 -1
  117. package/dist/api/resources/credits/types/ListGrantsForCreditResponse.d.ts +0 -1
  118. package/dist/api/resources/credits/types/UpdateCreditBundleDetailsRequestBodyExpiryType.d.ts +5 -2
  119. package/dist/api/resources/credits/types/UpdateCreditBundleDetailsRequestBodyExpiryUnit.d.ts +8 -0
  120. package/dist/api/resources/credits/types/ZeroOutGrantRequestBodyReason.d.ts +2 -1
  121. package/dist/api/resources/credits/types/index.d.ts +15 -0
  122. package/dist/api/resources/crm/client/Client.d.ts +8 -4
  123. package/dist/api/resources/crm/client/requests/ListCrmProductsRequest.d.ts +5 -1
  124. package/dist/api/resources/crm/types/ListCrmProductsResponse.d.ts +0 -1
  125. package/dist/api/resources/dataexports/client/Client.d.ts +3 -3
  126. package/dist/api/resources/entitlements/client/Client.d.ts +65 -13
  127. package/dist/api/resources/entitlements/client/requests/CountCompanyOverridesRequest.d.ts +8 -1
  128. package/dist/api/resources/entitlements/client/requests/CountFeatureCompaniesRequest.d.ts +4 -1
  129. package/dist/api/resources/entitlements/client/requests/CountFeatureUsageRequest.d.ts +7 -1
  130. package/dist/api/resources/entitlements/client/requests/CountFeatureUsersRequest.d.ts +4 -1
  131. package/dist/api/resources/entitlements/client/requests/CountPlanEntitlementsRequest.d.ts +8 -1
  132. package/dist/api/resources/entitlements/client/requests/CreateCompanyOverrideRequestBody.d.ts +1 -0
  133. package/dist/api/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +1 -0
  134. package/dist/api/resources/entitlements/client/requests/ListCompanyOverridesRequest.d.ts +8 -1
  135. package/dist/api/resources/entitlements/client/requests/ListFeatureCompaniesRequest.d.ts +4 -1
  136. package/dist/api/resources/entitlements/client/requests/ListFeatureUsageRequest.d.ts +7 -1
  137. package/dist/api/resources/entitlements/client/requests/ListFeatureUsersRequest.d.ts +4 -1
  138. package/dist/api/resources/entitlements/client/requests/ListPlanEntitlementsRequest.d.ts +8 -1
  139. package/dist/api/resources/entitlements/client/requests/UpdateCompanyOverrideRequestBody.d.ts +1 -0
  140. package/dist/api/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts +1 -0
  141. package/dist/api/resources/entitlements/types/ListCompanyOverridesResponse.d.ts +0 -1
  142. package/dist/api/resources/entitlements/types/ListFeatureCompaniesResponse.d.ts +0 -1
  143. package/dist/api/resources/entitlements/types/ListFeatureUsageResponse.d.ts +0 -1
  144. package/dist/api/resources/entitlements/types/ListFeatureUsersResponse.d.ts +0 -1
  145. package/dist/api/resources/entitlements/types/ListPlanEntitlementsResponse.d.ts +0 -1
  146. package/dist/api/resources/events/client/Client.d.ts +16 -5
  147. package/dist/api/resources/events/client/requests/GetEventSummariesRequest.d.ts +5 -1
  148. package/dist/api/resources/events/client/requests/ListEventsRequest.d.ts +8 -1
  149. package/dist/api/resources/events/types/GetEventSummariesResponse.d.ts +0 -1
  150. package/dist/api/resources/events/types/ListEventsResponse.d.ts +0 -1
  151. package/dist/api/resources/features/client/Client.d.ts +31 -7
  152. package/dist/api/resources/features/client/requests/CountFeaturesRequest.d.ts +11 -1
  153. package/dist/api/resources/features/client/requests/CountFlagsRequest.d.ts +9 -1
  154. package/dist/api/resources/features/client/requests/ListFeaturesRequest.d.ts +11 -1
  155. package/dist/api/resources/features/client/requests/ListFlagsRequest.d.ts +9 -1
  156. package/dist/api/resources/features/types/CountFeaturesParams.d.ts +1 -0
  157. package/dist/api/resources/features/types/CountFlagsParams.d.ts +1 -0
  158. package/dist/api/resources/features/types/ListAudienceCompaniesResponse.d.ts +0 -1
  159. package/dist/api/resources/features/types/ListAudienceUsersResponse.d.ts +0 -1
  160. package/dist/api/resources/features/types/ListFeaturesParams.d.ts +1 -0
  161. package/dist/api/resources/features/types/ListFeaturesResponse.d.ts +0 -1
  162. package/dist/api/resources/features/types/ListFlagsParams.d.ts +1 -0
  163. package/dist/api/resources/features/types/ListFlagsResponse.d.ts +0 -1
  164. package/dist/api/resources/plangroups/client/Client.d.ts +21 -5
  165. package/dist/api/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +22 -1
  166. package/dist/api/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +22 -1
  167. package/dist/api/resources/plans/client/Client.d.ts +50 -5
  168. package/dist/api/resources/plans/client/requests/CountPlansRequest.d.ts +31 -1
  169. package/dist/api/resources/plans/client/requests/ListPlanIssuesRequest.d.ts +12 -0
  170. package/dist/api/resources/plans/client/requests/ListPlansRequest.d.ts +31 -1
  171. package/dist/api/resources/plans/client/requests/index.d.ts +1 -0
  172. package/dist/api/resources/plans/types/CountPlansParams.d.ts +8 -0
  173. package/dist/api/resources/plans/types/ListPlanIssuesParams.d.ts +9 -0
  174. package/dist/api/resources/plans/types/ListPlanIssuesResponse.d.ts +9 -0
  175. package/dist/api/resources/plans/types/ListPlansParams.d.ts +8 -0
  176. package/dist/api/resources/plans/types/ListPlansResponse.d.ts +0 -1
  177. package/dist/api/resources/plans/types/index.d.ts +2 -0
  178. package/dist/api/resources/webhooks/client/Client.d.ts +25 -7
  179. package/dist/api/resources/webhooks/client/requests/CountWebhookEventsRequest.d.ts +6 -1
  180. package/dist/api/resources/webhooks/client/requests/CountWebhooksRequest.d.ts +5 -1
  181. package/dist/api/resources/webhooks/client/requests/ListWebhookEventsRequest.d.ts +6 -1
  182. package/dist/api/resources/webhooks/client/requests/ListWebhooksRequest.d.ts +5 -1
  183. package/dist/api/resources/webhooks/types/ListWebhookEventsResponse.d.ts +0 -1
  184. package/dist/api/resources/webhooks/types/ListWebhooksResponse.d.ts +0 -1
  185. package/dist/api/types/ApiKeyCreateResponseData.d.ts +0 -3
  186. package/dist/api/types/ApiKeyRequestResponseData.d.ts +0 -3
  187. package/dist/api/types/ApiKeyResponseData.d.ts +0 -3
  188. package/dist/api/types/BillingCreditBundleResponseData.d.ts +1 -0
  189. package/dist/api/types/BillingCreditBundleView.d.ts +1 -0
  190. package/dist/api/types/BillingCreditLedgerResponseData.d.ts +11 -0
  191. package/dist/api/types/BillingCustomerResponseData.d.ts +0 -3
  192. package/dist/api/types/BillingPlanCreditGrantResponseData.d.ts +7 -0
  193. package/dist/api/types/BillingProductDetailResponseData.d.ts +2 -1
  194. package/dist/api/types/BillingProductForSubscriptionResponseData.d.ts +2 -0
  195. package/dist/api/types/BillingProductPlanResponseData.d.ts +0 -3
  196. package/dist/api/types/BillingProductPricing.d.ts +2 -0
  197. package/dist/api/types/BillingProductResponseData.d.ts +2 -1
  198. package/dist/api/types/BillingSubscriptionView.d.ts +0 -3
  199. package/dist/api/types/CheckFlagResponseData.d.ts +0 -3
  200. package/dist/api/types/CheckFlagsResponseData.d.ts +0 -3
  201. package/dist/api/types/CheckoutDataResponseData.d.ts +0 -3
  202. package/dist/api/types/CheckoutSettingsResponseData.d.ts +8 -0
  203. package/dist/api/types/CheckoutSubscription.d.ts +25 -0
  204. package/dist/api/types/CompanyDetailResponseData.d.ts +1 -0
  205. package/dist/api/types/CompanyLedgerResponseData.d.ts +8 -0
  206. package/dist/api/types/CompanyOverrideNoteResponseData.d.ts +11 -0
  207. package/dist/api/types/CompanyOverrideResponseData.d.ts +1 -0
  208. package/dist/api/types/CompanyPlanDetailResponseData.d.ts +1 -0
  209. package/dist/api/types/CompanyViewWithFeatureUsageResponseData.d.ts +1 -0
  210. package/dist/api/types/ComponentCheckoutSettings.d.ts +9 -0
  211. package/dist/api/types/ComponentHydrateResponseData.d.ts +4 -0
  212. package/dist/api/types/ComponentPreviewResponseData.d.ts +4 -3
  213. package/dist/api/types/ComponentResponseData.d.ts +0 -3
  214. package/dist/api/types/Condition.d.ts +21 -0
  215. package/dist/api/types/ConditionGroup.d.ts +7 -0
  216. package/dist/api/types/CountResponse.d.ts +2 -4
  217. package/dist/api/types/CreditCompanyGrantView.d.ts +3 -0
  218. package/dist/api/types/CreditGrantDetail.d.ts +10 -0
  219. package/dist/api/types/CreditGrantDetailGrantReason.d.ts +9 -0
  220. package/dist/api/types/CreditLedgerEnrichedEntryResponseData.d.ts +27 -0
  221. package/dist/api/types/CreditUsage.d.ts +14 -0
  222. package/dist/api/types/CreditUsageResponseData.d.ts +14 -0
  223. package/dist/api/types/CrmDealResponseData.d.ts +0 -3
  224. package/dist/api/types/CrmLineItemResponseData.d.ts +0 -3
  225. package/dist/api/types/CrmProductResponseData.d.ts +0 -3
  226. package/dist/api/types/DataExportResponseData.d.ts +0 -3
  227. package/dist/api/types/EnvironmentDetailResponseData.d.ts +0 -3
  228. package/dist/api/types/EnvironmentResponseData.d.ts +0 -3
  229. package/dist/api/types/FeatureCompanyResponseData.d.ts +34 -1
  230. package/dist/api/types/FeatureCompanyResponseDataCreditGrantReason.d.ts +12 -0
  231. package/dist/api/types/FeatureCompanyUserResponseDataAllocationType.d.ts +2 -1
  232. package/dist/api/types/FeatureLedgerResponseData.d.ts +9 -0
  233. package/dist/api/types/FeatureUsageDataResponseData.d.ts +8 -0
  234. package/dist/api/types/FeatureUsageResponseData.d.ts +25 -0
  235. package/dist/api/types/FeatureUsageResponseDataCreditGrantReason.d.ts +12 -0
  236. package/dist/api/types/IssueTemporaryAccessTokenResponseData.d.ts +0 -3
  237. package/dist/api/types/ManagePlanPreviewResponseResponseData.d.ts +7 -0
  238. package/dist/api/types/ManagePlanRequest.d.ts +15 -0
  239. package/dist/api/types/ManagePlanResponseResponseData.d.ts +8 -0
  240. package/dist/api/types/PlanAudienceDetailResponseData.d.ts +0 -3
  241. package/dist/api/types/PlanCreditGrantView.d.ts +4 -0
  242. package/dist/api/types/PlanDetailResponseData.d.ts +1 -0
  243. package/dist/api/types/PlanEntitlementResponseData.d.ts +1 -0
  244. package/dist/api/types/PlanGroupDetailResponseData.d.ts +16 -3
  245. package/dist/api/types/PlanGroupPlanDetailResponseData.d.ts +1 -0
  246. package/dist/api/types/PlanGroupResponseData.d.ts +11 -3
  247. package/dist/api/types/PlanIssueResponseData.d.ts +9 -0
  248. package/dist/api/types/PlanSelection.d.ts +7 -0
  249. package/dist/api/types/PlanTraitResponseData.d.ts +0 -3
  250. package/dist/api/types/PreviewSubscriptionChangeResponseData.d.ts +0 -3
  251. package/dist/api/types/PreviewSubscriptionFinanceResponseData.d.ts +3 -0
  252. package/dist/api/types/RawEventBatchResponseData.d.ts +0 -3
  253. package/dist/api/types/Rule.d.ts +16 -0
  254. package/dist/api/types/RulesDetailResponseData.d.ts +0 -3
  255. package/dist/api/types/SegmentStatusResp.d.ts +0 -3
  256. package/dist/api/types/TraitDefinition.d.ts +8 -0
  257. package/dist/api/types/UpdatePlanTraitTraitRequestBody.d.ts +7 -0
  258. package/dist/api/types/UsageBasedEntitlementRequestBody.d.ts +1 -0
  259. package/dist/api/types/UsageBasedEntitlementResponseData.d.ts +1 -0
  260. package/dist/api/types/index.d.ts +24 -0
  261. package/dist/index.js +3 -3
  262. package/dist/serialization/resources/accesstokens/client/requests/IssueTemporaryAccessTokenRequestBody.d.ts +0 -1
  263. package/dist/serialization/resources/billing/client/requests/{CreateBillingSubscriptionsRequestBody.d.ts → CreateBillingSubscriptionRequestBody.d.ts} +5 -4
  264. package/dist/serialization/resources/billing/client/requests/index.d.ts +1 -1
  265. package/dist/serialization/resources/billing/types/CreateBillingSubscriptionRequestBodyTrialEndSetting.d.ts +10 -0
  266. package/dist/serialization/resources/billing/types/SearchBillingPricesParams.d.ts +4 -0
  267. package/dist/serialization/resources/billing/types/index.d.ts +2 -2
  268. package/dist/serialization/resources/checkout/types/CheckoutInternalResponse.d.ts +2 -2
  269. package/dist/serialization/resources/checkout/types/ManagePlanResponse.d.ts +14 -0
  270. package/dist/serialization/resources/checkout/types/PreviewManagePlanResponse.d.ts +14 -0
  271. package/dist/serialization/resources/checkout/types/index.d.ts +2 -0
  272. package/dist/serialization/resources/companies/client/requests/UpdatePlanTraitBulkRequestBody.d.ts +14 -0
  273. package/dist/serialization/resources/companies/client/requests/index.d.ts +1 -0
  274. package/dist/serialization/resources/companies/types/CountCompaniesForAdvancedFilterParams.d.ts +1 -0
  275. package/dist/serialization/resources/companies/types/ListCompaniesForAdvancedFilterParams.d.ts +1 -0
  276. package/dist/serialization/resources/companies/types/UpdatePlanTraitsBulkResponse.d.ts +14 -0
  277. package/dist/serialization/resources/companies/types/index.d.ts +1 -0
  278. package/dist/serialization/resources/credits/client/requests/CreateBillingPlanCreditGrantRequestBody.d.ts +7 -0
  279. package/dist/serialization/resources/credits/client/requests/CreateCompanyCreditGrant.d.ts +6 -0
  280. package/dist/serialization/resources/credits/client/requests/CreateCreditBundleRequestBody.d.ts +2 -1
  281. package/dist/serialization/resources/credits/client/requests/UpdateCreditBundleDetailsRequestBody.d.ts +2 -0
  282. package/dist/serialization/resources/credits/types/CountCreditLedgerParams.d.ts +20 -0
  283. package/dist/serialization/resources/credits/types/CountCreditLedgerRequestPeriod.d.ts +10 -0
  284. package/dist/serialization/resources/credits/types/CountCreditLedgerResponse.d.ts +15 -0
  285. package/dist/serialization/resources/credits/types/CountCreditLedgerResponseParamsPeriod.d.ts +10 -0
  286. package/dist/serialization/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyExpiryType.d.ts +10 -0
  287. package/dist/serialization/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyExpiryUnit.d.ts +10 -0
  288. package/dist/serialization/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyResetType.d.ts +10 -0
  289. package/dist/serialization/resources/credits/types/CreateCompanyCreditGrantExpiryType.d.ts +10 -0
  290. package/dist/serialization/resources/credits/types/CreateCompanyCreditGrantExpiryUnit.d.ts +10 -0
  291. package/dist/serialization/resources/credits/types/CreateCreditBundleRequestBodyExpiryType.d.ts +1 -1
  292. package/dist/serialization/resources/credits/types/CreateCreditBundleRequestBodyExpiryUnit.d.ts +10 -0
  293. package/dist/serialization/resources/credits/types/GetEnrichedCreditLedgerParams.d.ts +20 -0
  294. package/dist/serialization/resources/credits/types/GetEnrichedCreditLedgerRequestPeriod.d.ts +10 -0
  295. package/dist/serialization/resources/credits/types/GetEnrichedCreditLedgerResponse.d.ts +15 -0
  296. package/dist/serialization/resources/credits/types/GetEnrichedCreditLedgerResponseParamsPeriod.d.ts +10 -0
  297. package/dist/serialization/resources/credits/types/UpdateCreditBundleDetailsRequestBodyExpiryType.d.ts +1 -1
  298. package/dist/serialization/resources/credits/types/UpdateCreditBundleDetailsRequestBodyExpiryUnit.d.ts +10 -0
  299. package/dist/serialization/resources/credits/types/ZeroOutGrantRequestBodyReason.d.ts +1 -1
  300. package/dist/serialization/resources/credits/types/index.d.ts +15 -0
  301. package/dist/serialization/resources/entitlements/client/requests/CreateCompanyOverrideRequestBody.d.ts +1 -0
  302. package/dist/serialization/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +1 -0
  303. package/dist/serialization/resources/entitlements/client/requests/UpdateCompanyOverrideRequestBody.d.ts +1 -0
  304. package/dist/serialization/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts +1 -0
  305. package/dist/serialization/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +13 -0
  306. package/dist/serialization/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +13 -0
  307. package/dist/serialization/resources/plans/types/CountPlansParams.d.ts +4 -0
  308. package/dist/serialization/resources/plans/types/ListPlanIssuesParams.d.ts +12 -0
  309. package/dist/serialization/resources/plans/types/ListPlanIssuesResponse.d.ts +15 -0
  310. package/dist/serialization/resources/plans/types/ListPlansParams.d.ts +4 -0
  311. package/dist/serialization/resources/plans/types/index.d.ts +2 -0
  312. package/dist/serialization/types/BillingCreditBundleResponseData.d.ts +1 -0
  313. package/dist/serialization/types/BillingCreditBundleView.d.ts +1 -0
  314. package/dist/serialization/types/BillingCreditLedgerResponseData.d.ts +17 -0
  315. package/dist/serialization/types/BillingPlanCreditGrantResponseData.d.ts +7 -0
  316. package/dist/serialization/types/BillingProductDetailResponseData.d.ts +1 -1
  317. package/dist/serialization/types/BillingProductForSubscriptionResponseData.d.ts +2 -0
  318. package/dist/serialization/types/BillingProductPricing.d.ts +2 -0
  319. package/dist/serialization/types/BillingProductResponseData.d.ts +1 -1
  320. package/dist/serialization/types/CheckoutSettingsResponseData.d.ts +14 -0
  321. package/dist/serialization/types/CheckoutSubscription.d.ts +31 -0
  322. package/dist/serialization/types/CompanyDetailResponseData.d.ts +2 -0
  323. package/dist/serialization/types/CompanyLedgerResponseData.d.ts +14 -0
  324. package/dist/serialization/types/CompanyOverrideNoteResponseData.d.ts +17 -0
  325. package/dist/serialization/types/CompanyOverrideResponseData.d.ts +2 -0
  326. package/dist/serialization/types/CompanyPlanDetailResponseData.d.ts +2 -0
  327. package/dist/serialization/types/CompanyViewWithFeatureUsageResponseData.d.ts +2 -0
  328. package/dist/serialization/types/ComponentCheckoutSettings.d.ts +15 -0
  329. package/dist/serialization/types/ComponentHydrateResponseData.d.ts +5 -0
  330. package/dist/serialization/types/ComponentPreviewResponseData.d.ts +5 -0
  331. package/dist/serialization/types/Condition.d.ts +27 -0
  332. package/dist/serialization/types/ConditionGroup.d.ts +13 -0
  333. package/dist/serialization/types/CountResponse.d.ts +1 -1
  334. package/dist/serialization/types/CreditCompanyGrantView.d.ts +3 -0
  335. package/dist/serialization/types/CreditGrantDetail.d.ts +16 -0
  336. package/dist/serialization/types/CreditGrantDetailGrantReason.d.ts +10 -0
  337. package/dist/serialization/types/CreditLedgerEnrichedEntryResponseData.d.ts +35 -0
  338. package/dist/serialization/types/CreditUsage.d.ts +20 -0
  339. package/dist/serialization/types/CreditUsageResponseData.d.ts +20 -0
  340. package/dist/serialization/types/FeatureCompanyResponseData.d.ts +28 -0
  341. package/dist/serialization/types/FeatureCompanyResponseDataCreditGrantReason.d.ts +10 -0
  342. package/dist/serialization/types/FeatureCompanyUserResponseDataAllocationType.d.ts +1 -1
  343. package/dist/serialization/types/FeatureLedgerResponseData.d.ts +15 -0
  344. package/dist/serialization/types/FeatureUsageDataResponseData.d.ts +9 -0
  345. package/dist/serialization/types/FeatureUsageResponseData.d.ts +17 -0
  346. package/dist/serialization/types/FeatureUsageResponseDataCreditGrantReason.d.ts +10 -0
  347. package/dist/serialization/types/ManagePlanPreviewResponseResponseData.d.ts +13 -0
  348. package/dist/serialization/types/ManagePlanRequest.d.ts +23 -0
  349. package/dist/serialization/types/ManagePlanResponseResponseData.d.ts +14 -0
  350. package/dist/serialization/types/PlanCreditGrantView.d.ts +4 -0
  351. package/dist/serialization/types/PlanDetailResponseData.d.ts +2 -0
  352. package/dist/serialization/types/PlanEntitlementResponseData.d.ts +1 -0
  353. package/dist/serialization/types/PlanGroupDetailResponseData.d.ts +18 -0
  354. package/dist/serialization/types/PlanGroupPlanDetailResponseData.d.ts +2 -0
  355. package/dist/serialization/types/PlanGroupResponseData.d.ts +12 -0
  356. package/dist/serialization/types/PlanIssueResponseData.d.ts +15 -0
  357. package/dist/serialization/types/PlanSelection.d.ts +13 -0
  358. package/dist/serialization/types/PreviewSubscriptionFinanceResponseData.d.ts +3 -0
  359. package/dist/serialization/types/Rule.d.ts +23 -0
  360. package/dist/serialization/types/TraitDefinition.d.ts +14 -0
  361. package/dist/serialization/types/UpdatePlanTraitTraitRequestBody.d.ts +13 -0
  362. package/dist/serialization/types/UsageBasedEntitlementRequestBody.d.ts +1 -0
  363. package/dist/serialization/types/UsageBasedEntitlementResponseData.d.ts +1 -0
  364. package/dist/serialization/types/index.d.ts +24 -0
  365. package/dist/wrapper.d.ts +8 -0
  366. package/package.json +2 -1
  367. package/dist/api/resources/billing/types/CreateBillingSubscriptionsRequestBodyTrialEndSetting.d.ts +0 -8
  368. package/dist/serialization/resources/billing/types/CreateBillingSubscriptionsRequestBodyTrialEndSetting.d.ts +0 -10
@@ -9,7 +9,7 @@ export declare namespace Events {
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 Events {
25
25
  }
26
26
  export declare class Events {
27
27
  protected readonly _options: Events.Options;
28
- constructor(_options: Events.Options);
28
+ constructor(_options?: Events.Options);
29
29
  /**
30
30
  * @param {Schematic.CreateEventBatchRequestBody} request
31
31
  * @param {Events.RequestOptions} requestOptions - Request-specific configuration.
@@ -56,7 +56,11 @@ export declare class Events {
56
56
  * @throws {@link Schematic.InternalServerError}
57
57
  *
58
58
  * @example
59
- * await client.events.getEventSummaries()
59
+ * await client.events.getEventSummaries({
60
+ * q: "q",
61
+ * limit: 1,
62
+ * offset: 1
63
+ * })
60
64
  */
61
65
  getEventSummaries(request?: Schematic.GetEventSummariesRequest, requestOptions?: Events.RequestOptions): core.HttpResponsePromise<Schematic.GetEventSummariesResponse>;
62
66
  private __getEventSummaries;
@@ -71,7 +75,14 @@ export declare class Events {
71
75
  * @throws {@link Schematic.InternalServerError}
72
76
  *
73
77
  * @example
74
- * await client.events.listEvents()
78
+ * await client.events.listEvents({
79
+ * companyId: "company_id",
80
+ * eventSubtype: "event_subtype",
81
+ * flagId: "flag_id",
82
+ * userId: "user_id",
83
+ * limit: 1,
84
+ * offset: 1
85
+ * })
75
86
  */
76
87
  listEvents(request?: Schematic.ListEventsRequest, requestOptions?: Events.RequestOptions): core.HttpResponsePromise<Schematic.ListEventsResponse>;
77
88
  private __listEvents;
@@ -120,6 +131,6 @@ export declare class Events {
120
131
  getSegmentIntegrationStatus(requestOptions?: Events.RequestOptions): core.HttpResponsePromise<Schematic.GetSegmentIntegrationStatusResponse>;
121
132
  private __getSegmentIntegrationStatus;
122
133
  protected _getCustomAuthorizationHeaders(): Promise<{
123
- "X-Schematic-Api-Key": string;
134
+ "X-Schematic-Api-Key": string | undefined;
124
135
  }>;
125
136
  }
@@ -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 GetEventSummariesRequest {
9
13
  q?: string;
@@ -4,7 +4,14 @@
4
4
  import * as Schematic from "../../../../index";
5
5
  /**
6
6
  * @example
7
- * {}
7
+ * {
8
+ * companyId: "company_id",
9
+ * eventSubtype: "event_subtype",
10
+ * flagId: "flag_id",
11
+ * userId: "user_id",
12
+ * limit: 1,
13
+ * offset: 1
14
+ * }
8
15
  */
9
16
  export interface ListEventsRequest {
10
17
  companyId?: string;
@@ -3,7 +3,6 @@
3
3
  */
4
4
  import * as Schematic from "../../../index";
5
5
  export interface GetEventSummariesResponse {
6
- /** The returned resources */
7
6
  data: Schematic.EventSummaryResponseData[];
8
7
  /** Input parameters */
9
8
  params: Schematic.GetEventSummariesParams;
@@ -3,7 +3,6 @@
3
3
  */
4
4
  import * as Schematic from "../../../index";
5
5
  export interface ListEventsResponse {
6
- /** The returned resources */
7
6
  data: Schematic.EventDetailResponseData[];
8
7
  /** Input parameters */
9
8
  params: Schematic.ListEventsParams;
@@ -9,7 +9,7 @@ export declare namespace Features {
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 Features {
25
25
  }
26
26
  export declare class Features {
27
27
  protected readonly _options: Features.Options;
28
- constructor(_options: Features.Options);
28
+ constructor(_options?: Features.Options);
29
29
  /**
30
30
  * @param {Schematic.AudienceRequestBody} request
31
31
  * @param {Features.RequestOptions} requestOptions - Request-specific configuration.
@@ -149,7 +149,14 @@ export declare class Features {
149
149
  * @throws {@link Schematic.InternalServerError}
150
150
  *
151
151
  * @example
152
- * await client.features.listFeatures()
152
+ * await client.features.listFeatures({
153
+ * q: "q",
154
+ * withoutCompanyOverrideFor: "without_company_override_for",
155
+ * withoutPlanEntitlementFor: "without_plan_entitlement_for",
156
+ * booleanRequireEvent: true,
157
+ * limit: 1,
158
+ * offset: 1
159
+ * })
153
160
  */
154
161
  listFeatures(request?: Schematic.ListFeaturesRequest, requestOptions?: Features.RequestOptions): core.HttpResponsePromise<Schematic.ListFeaturesResponse>;
155
162
  private __listFeatures;
@@ -228,7 +235,14 @@ export declare class Features {
228
235
  * @throws {@link Schematic.InternalServerError}
229
236
  *
230
237
  * @example
231
- * await client.features.countFeatures()
238
+ * await client.features.countFeatures({
239
+ * q: "q",
240
+ * withoutCompanyOverrideFor: "without_company_override_for",
241
+ * withoutPlanEntitlementFor: "without_plan_entitlement_for",
242
+ * booleanRequireEvent: true,
243
+ * limit: 1,
244
+ * offset: 1
245
+ * })
232
246
  */
233
247
  countFeatures(request?: Schematic.CountFeaturesRequest, requestOptions?: Features.RequestOptions): core.HttpResponsePromise<Schematic.CountFeaturesResponse>;
234
248
  private __countFeatures;
@@ -243,7 +257,12 @@ export declare class Features {
243
257
  * @throws {@link Schematic.InternalServerError}
244
258
  *
245
259
  * @example
246
- * await client.features.listFlags()
260
+ * await client.features.listFlags({
261
+ * featureId: "feature_id",
262
+ * q: "q",
263
+ * limit: 1,
264
+ * offset: 1
265
+ * })
247
266
  */
248
267
  listFlags(request?: Schematic.ListFlagsRequest, requestOptions?: Features.RequestOptions): core.HttpResponsePromise<Schematic.ListFlagsResponse>;
249
268
  private __listFlags;
@@ -395,11 +414,16 @@ export declare class Features {
395
414
  * @throws {@link Schematic.InternalServerError}
396
415
  *
397
416
  * @example
398
- * await client.features.countFlags()
417
+ * await client.features.countFlags({
418
+ * featureId: "feature_id",
419
+ * q: "q",
420
+ * limit: 1,
421
+ * offset: 1
422
+ * })
399
423
  */
400
424
  countFlags(request?: Schematic.CountFlagsRequest, requestOptions?: Features.RequestOptions): core.HttpResponsePromise<Schematic.CountFlagsResponse>;
401
425
  private __countFlags;
402
426
  protected _getCustomAuthorizationHeaders(): Promise<{
403
- "X-Schematic-Api-Key": string;
427
+ "X-Schematic-Api-Key": string | undefined;
404
428
  }>;
405
429
  }
@@ -3,10 +3,20 @@
3
3
  */
4
4
  /**
5
5
  * @example
6
- * {}
6
+ * {
7
+ * q: "q",
8
+ * withoutCompanyOverrideFor: "without_company_override_for",
9
+ * withoutPlanEntitlementFor: "without_plan_entitlement_for",
10
+ * booleanRequireEvent: true,
11
+ * limit: 1,
12
+ * offset: 1
13
+ * }
7
14
  */
8
15
  export interface CountFeaturesRequest {
9
16
  ids?: string | string[];
17
+ /**
18
+ * Search by feature name or ID
19
+ */
10
20
  q?: string;
11
21
  /**
12
22
  * Filter out features that already have a company override for the specified company ID
@@ -3,11 +3,19 @@
3
3
  */
4
4
  /**
5
5
  * @example
6
- * {}
6
+ * {
7
+ * featureId: "feature_id",
8
+ * q: "q",
9
+ * limit: 1,
10
+ * offset: 1
11
+ * }
7
12
  */
8
13
  export interface CountFlagsRequest {
9
14
  featureId?: string;
10
15
  ids?: string | string[];
16
+ /**
17
+ * Search by flag name, key, or ID
18
+ */
11
19
  q?: string;
12
20
  /**
13
21
  * Page limit (default 100)
@@ -3,10 +3,20 @@
3
3
  */
4
4
  /**
5
5
  * @example
6
- * {}
6
+ * {
7
+ * q: "q",
8
+ * withoutCompanyOverrideFor: "without_company_override_for",
9
+ * withoutPlanEntitlementFor: "without_plan_entitlement_for",
10
+ * booleanRequireEvent: true,
11
+ * limit: 1,
12
+ * offset: 1
13
+ * }
7
14
  */
8
15
  export interface ListFeaturesRequest {
9
16
  ids?: string | string[];
17
+ /**
18
+ * Search by feature name or ID
19
+ */
10
20
  q?: string;
11
21
  /**
12
22
  * Filter out features that already have a company override for the specified company ID
@@ -3,11 +3,19 @@
3
3
  */
4
4
  /**
5
5
  * @example
6
- * {}
6
+ * {
7
+ * featureId: "feature_id",
8
+ * q: "q",
9
+ * limit: 1,
10
+ * offset: 1
11
+ * }
7
12
  */
8
13
  export interface ListFlagsRequest {
9
14
  featureId?: string;
10
15
  ids?: string | string[];
16
+ /**
17
+ * Search by flag name, key, or ID
18
+ */
11
19
  q?: string;
12
20
  /**
13
21
  * Page limit (default 100)
@@ -14,6 +14,7 @@ export interface CountFeaturesParams {
14
14
  limit?: number;
15
15
  /** Page offset (default 0) */
16
16
  offset?: number;
17
+ /** Search by feature name or ID */
17
18
  q?: string;
18
19
  /** Filter out features that already have a company override for the specified company ID */
19
20
  withoutCompanyOverrideFor?: string;
@@ -11,5 +11,6 @@ export interface CountFlagsParams {
11
11
  limit?: number;
12
12
  /** Page offset (default 0) */
13
13
  offset?: number;
14
+ /** Search by flag name, key, or ID */
14
15
  q?: string;
15
16
  }
@@ -3,7 +3,6 @@
3
3
  */
4
4
  import * as Schematic from "../../../index";
5
5
  export interface ListAudienceCompaniesResponse {
6
- /** The returned resources */
7
6
  data: Schematic.CompanyDetailResponseData[];
8
7
  /** Input parameters */
9
8
  params: Record<string, unknown>;
@@ -3,7 +3,6 @@
3
3
  */
4
4
  import * as Schematic from "../../../index";
5
5
  export interface ListAudienceUsersResponse {
6
- /** The returned resources */
7
6
  data: Schematic.UserDetailResponseData[];
8
7
  /** Input parameters */
9
8
  params: Record<string, unknown>;
@@ -14,6 +14,7 @@ export interface ListFeaturesParams {
14
14
  limit?: number;
15
15
  /** Page offset (default 0) */
16
16
  offset?: number;
17
+ /** Search by feature name or ID */
17
18
  q?: string;
18
19
  /** Filter out features that already have a company override for the specified company ID */
19
20
  withoutCompanyOverrideFor?: string;
@@ -3,7 +3,6 @@
3
3
  */
4
4
  import * as Schematic from "../../../index";
5
5
  export interface ListFeaturesResponse {
6
- /** The returned resources */
7
6
  data: Schematic.FeatureDetailResponseData[];
8
7
  /** Input parameters */
9
8
  params: Schematic.ListFeaturesParams;
@@ -11,5 +11,6 @@ export interface ListFlagsParams {
11
11
  limit?: number;
12
12
  /** Page offset (default 0) */
13
13
  offset?: number;
14
+ /** Search by flag name, key, or ID */
14
15
  q?: string;
15
16
  }
@@ -3,7 +3,6 @@
3
3
  */
4
4
  import * as Schematic from "../../../index";
5
5
  export interface ListFlagsResponse {
6
- /** The returned resources */
7
6
  data: Schematic.FlagDetailResponseData[];
8
7
  /** Input parameters */
9
8
  params: Schematic.ListFlagsParams;
@@ -9,7 +9,7 @@ export declare namespace Plangroups {
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 Plangroups {
25
25
  }
26
26
  export declare class Plangroups {
27
27
  protected readonly _options: Plangroups.Options;
28
- constructor(_options: Plangroups.Options);
28
+ constructor(_options?: Plangroups.Options);
29
29
  /**
30
30
  * @param {Plangroups.RequestOptions} requestOptions - Request-specific configuration.
31
31
  *
@@ -52,6 +52,10 @@ export declare class Plangroups {
52
52
  * @example
53
53
  * await client.plangroups.createPlanGroup({
54
54
  * addOnIds: ["add_on_ids"],
55
+ * checkoutCollectAddress: true,
56
+ * checkoutCollectEmail: true,
57
+ * checkoutCollectPhone: true,
58
+ * enableTaxCollection: true,
55
59
  * orderedAddOns: [{
56
60
  * planId: "plan_id"
57
61
  * }],
@@ -61,7 +65,11 @@ export declare class Plangroups {
61
65
  * orderedPlans: [{
62
66
  * planId: "plan_id"
63
67
  * }],
64
- * showPeriodToggle: true
68
+ * preventDowngradesWhenOverLimit: true,
69
+ * showCredits: true,
70
+ * showPeriodToggle: true,
71
+ * showZeroPriceAsFree: true,
72
+ * syncCustomerBillingDetailsForTax: true
65
73
  * })
66
74
  */
67
75
  createPlanGroup(request: Schematic.CreatePlanGroupRequestBody, requestOptions?: Plangroups.RequestOptions): core.HttpResponsePromise<Schematic.CreatePlanGroupResponse>;
@@ -80,6 +88,10 @@ export declare class Plangroups {
80
88
  * @example
81
89
  * await client.plangroups.updatePlanGroup("plan_group_id", {
82
90
  * addOnIds: ["add_on_ids"],
91
+ * checkoutCollectAddress: true,
92
+ * checkoutCollectEmail: true,
93
+ * checkoutCollectPhone: true,
94
+ * enableTaxCollection: true,
83
95
  * orderedAddOns: [{
84
96
  * planId: "plan_id"
85
97
  * }],
@@ -89,12 +101,16 @@ export declare class Plangroups {
89
101
  * orderedPlans: [{
90
102
  * planId: "plan_id"
91
103
  * }],
92
- * showPeriodToggle: true
104
+ * preventDowngradesWhenOverLimit: true,
105
+ * showCredits: true,
106
+ * showPeriodToggle: true,
107
+ * showZeroPriceAsFree: true,
108
+ * syncCustomerBillingDetailsForTax: true
93
109
  * })
94
110
  */
95
111
  updatePlanGroup(planGroupId: string, request: Schematic.UpdatePlanGroupRequestBody, requestOptions?: Plangroups.RequestOptions): core.HttpResponsePromise<Schematic.UpdatePlanGroupResponse>;
96
112
  private __updatePlanGroup;
97
113
  protected _getCustomAuthorizationHeaders(): Promise<{
98
- "X-Schematic-Api-Key": string;
114
+ "X-Schematic-Api-Key": string | undefined;
99
115
  }>;
100
116
  }
@@ -6,6 +6,10 @@ import * as Schematic from "../../../../index";
6
6
  * @example
7
7
  * {
8
8
  * addOnIds: ["add_on_ids"],
9
+ * checkoutCollectAddress: true,
10
+ * checkoutCollectEmail: true,
11
+ * checkoutCollectPhone: true,
12
+ * enableTaxCollection: true,
9
13
  * orderedAddOns: [{
10
14
  * planId: "plan_id"
11
15
  * }],
@@ -15,20 +19,37 @@ import * as Schematic from "../../../../index";
15
19
  * orderedPlans: [{
16
20
  * planId: "plan_id"
17
21
  * }],
18
- * showPeriodToggle: true
22
+ * preventDowngradesWhenOverLimit: true,
23
+ * showCredits: true,
24
+ * showPeriodToggle: true,
25
+ * showZeroPriceAsFree: true,
26
+ * syncCustomerBillingDetailsForTax: true
19
27
  * }
20
28
  */
21
29
  export interface CreatePlanGroupRequestBody {
22
30
  addOnCompatibilities?: Schematic.CompatiblePlans[];
23
31
  /** Use OrderedAddOns instead */
24
32
  addOnIds: string[];
33
+ checkoutCollectAddress: boolean;
34
+ checkoutCollectEmail: boolean;
35
+ checkoutCollectPhone: boolean;
25
36
  customPlanConfig?: Schematic.CustomPlanConfig;
26
37
  customPlanId?: string;
27
38
  defaultPlanId?: string;
39
+ enableTaxCollection: boolean;
40
+ fallbackPlanId?: string;
41
+ initialPlanId?: string;
42
+ initialPlanPriceId?: string;
28
43
  orderedAddOns: Schematic.OrderedPlansInGroup[];
29
44
  orderedBundleList: Schematic.PlanGroupBundleOrder[];
30
45
  orderedPlans: Schematic.OrderedPlansInGroup[];
46
+ preventDowngradesWhenOverLimit: boolean;
47
+ showCredits: boolean;
31
48
  showPeriodToggle: boolean;
49
+ showZeroPriceAsFree: boolean;
50
+ syncCustomerBillingDetailsForTax: boolean;
32
51
  trialDays?: number;
52
+ trialExpiryPlanId?: string;
53
+ trialExpiryPlanPriceId?: string;
33
54
  trialPaymentMethodRequired?: boolean;
34
55
  }
@@ -6,6 +6,10 @@ import * as Schematic from "../../../../index";
6
6
  * @example
7
7
  * {
8
8
  * addOnIds: ["add_on_ids"],
9
+ * checkoutCollectAddress: true,
10
+ * checkoutCollectEmail: true,
11
+ * checkoutCollectPhone: true,
12
+ * enableTaxCollection: true,
9
13
  * orderedAddOns: [{
10
14
  * planId: "plan_id"
11
15
  * }],
@@ -15,20 +19,37 @@ import * as Schematic from "../../../../index";
15
19
  * orderedPlans: [{
16
20
  * planId: "plan_id"
17
21
  * }],
18
- * showPeriodToggle: true
22
+ * preventDowngradesWhenOverLimit: true,
23
+ * showCredits: true,
24
+ * showPeriodToggle: true,
25
+ * showZeroPriceAsFree: true,
26
+ * syncCustomerBillingDetailsForTax: true
19
27
  * }
20
28
  */
21
29
  export interface UpdatePlanGroupRequestBody {
22
30
  addOnCompatibilities?: Schematic.CompatiblePlans[];
23
31
  /** Use OrderedAddOns instead */
24
32
  addOnIds: string[];
33
+ checkoutCollectAddress: boolean;
34
+ checkoutCollectEmail: boolean;
35
+ checkoutCollectPhone: boolean;
25
36
  customPlanConfig?: Schematic.CustomPlanConfig;
26
37
  customPlanId?: string;
27
38
  defaultPlanId?: string;
39
+ enableTaxCollection: boolean;
40
+ fallbackPlanId?: string;
41
+ initialPlanId?: string;
42
+ initialPlanPriceId?: string;
28
43
  orderedAddOns: Schematic.OrderedPlansInGroup[];
29
44
  orderedBundleList: Schematic.PlanGroupBundleOrder[];
30
45
  orderedPlans: Schematic.OrderedPlansInGroup[];
46
+ preventDowngradesWhenOverLimit: boolean;
47
+ showCredits: boolean;
31
48
  showPeriodToggle: boolean;
49
+ showZeroPriceAsFree: boolean;
50
+ syncCustomerBillingDetailsForTax: boolean;
32
51
  trialDays?: number;
52
+ trialExpiryPlanId?: string;
53
+ trialExpiryPlanPriceId?: string;
33
54
  trialPaymentMethodRequired?: boolean;
34
55
  }
@@ -9,7 +9,7 @@ export declare namespace Plans {
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 Plans {
25
25
  }
26
26
  export declare class Plans {
27
27
  protected readonly _options: Plans.Options;
28
- constructor(_options: Plans.Options);
28
+ constructor(_options?: Plans.Options);
29
29
  /**
30
30
  * @param {string} companyPlanId - company_plan_id
31
31
  * @param {Schematic.UpdateCompanyPlansRequestBody} request
@@ -113,7 +113,21 @@ export declare class Plans {
113
113
  * @throws {@link Schematic.InternalServerError}
114
114
  *
115
115
  * @example
116
- * await client.plans.listPlans()
116
+ * await client.plans.listPlans({
117
+ * companyId: "company_id",
118
+ * forFallbackPlan: true,
119
+ * forInitialPlan: true,
120
+ * forTrialExpiryPlan: true,
121
+ * hasProductId: true,
122
+ * planType: "plan",
123
+ * q: "q",
124
+ * requiresPaymentMethod: true,
125
+ * withoutEntitlementFor: "without_entitlement_for",
126
+ * withoutProductId: true,
127
+ * withoutPaidProductId: true,
128
+ * limit: 1,
129
+ * offset: 1
130
+ * })
117
131
  */
118
132
  listPlans(request?: Schematic.ListPlansRequest, requestOptions?: Plans.RequestOptions): core.HttpResponsePromise<Schematic.ListPlansResponse>;
119
133
  private __listPlans;
@@ -213,11 +227,42 @@ export declare class Plans {
213
227
  * @throws {@link Schematic.InternalServerError}
214
228
  *
215
229
  * @example
216
- * await client.plans.countPlans()
230
+ * await client.plans.countPlans({
231
+ * companyId: "company_id",
232
+ * forFallbackPlan: true,
233
+ * forInitialPlan: true,
234
+ * forTrialExpiryPlan: true,
235
+ * hasProductId: true,
236
+ * planType: "plan",
237
+ * q: "q",
238
+ * requiresPaymentMethod: true,
239
+ * withoutEntitlementFor: "without_entitlement_for",
240
+ * withoutProductId: true,
241
+ * withoutPaidProductId: true,
242
+ * limit: 1,
243
+ * offset: 1
244
+ * })
217
245
  */
218
246
  countPlans(request?: Schematic.CountPlansRequest, requestOptions?: Plans.RequestOptions): core.HttpResponsePromise<Schematic.CountPlansResponse>;
219
247
  private __countPlans;
248
+ /**
249
+ * @param {Schematic.ListPlanIssuesRequest} request
250
+ * @param {Plans.RequestOptions} requestOptions - Request-specific configuration.
251
+ *
252
+ * @throws {@link Schematic.BadRequestError}
253
+ * @throws {@link Schematic.UnauthorizedError}
254
+ * @throws {@link Schematic.ForbiddenError}
255
+ * @throws {@link Schematic.NotFoundError}
256
+ * @throws {@link Schematic.InternalServerError}
257
+ *
258
+ * @example
259
+ * await client.plans.listPlanIssues({
260
+ * planId: "plan_id"
261
+ * })
262
+ */
263
+ listPlanIssues(request: Schematic.ListPlanIssuesRequest, requestOptions?: Plans.RequestOptions): core.HttpResponsePromise<Schematic.ListPlanIssuesResponse>;
264
+ private __listPlanIssues;
220
265
  protected _getCustomAuthorizationHeaders(): Promise<{
221
- "X-Schematic-Api-Key": string;
266
+ "X-Schematic-Api-Key": string | undefined;
222
267
  }>;
223
268
  }
@@ -4,10 +4,36 @@
4
4
  import * as Schematic from "../../../../index";
5
5
  /**
6
6
  * @example
7
- * {}
7
+ * {
8
+ * companyId: "company_id",
9
+ * forFallbackPlan: true,
10
+ * forInitialPlan: true,
11
+ * forTrialExpiryPlan: true,
12
+ * hasProductId: true,
13
+ * planType: "plan",
14
+ * q: "q",
15
+ * requiresPaymentMethod: true,
16
+ * withoutEntitlementFor: "without_entitlement_for",
17
+ * withoutProductId: true,
18
+ * withoutPaidProductId: true,
19
+ * limit: 1,
20
+ * offset: 1
21
+ * }
8
22
  */
9
23
  export interface CountPlansRequest {
10
24
  companyId?: string;
25
+ /**
26
+ * Filter for plans valid as fallback plans (not linked to billing)
27
+ */
28
+ forFallbackPlan?: boolean;
29
+ /**
30
+ * Filter for plans valid as initial plans (not linked to billing, free, or auto-cancelling trial)
31
+ */
32
+ forInitialPlan?: boolean;
33
+ /**
34
+ * Filter for plans valid as trial expiry plans (not linked to billing or free)
35
+ */
36
+ forTrialExpiryPlan?: boolean;
11
37
  /**
12
38
  * Filter out plans that do not have a billing product ID
13
39
  */
@@ -18,6 +44,10 @@ export interface CountPlansRequest {
18
44
  */
19
45
  planType?: Schematic.CountPlansRequestPlanType;
20
46
  q?: string;
47
+ /**
48
+ * Filter for plans that require a payment method (inverse of ForInitialPlan)
49
+ */
50
+ requiresPaymentMethod?: boolean;
21
51
  /**
22
52
  * Filter out plans that already have a plan entitlement for the specified feature ID
23
53
  */
@@ -0,0 +1,12 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ /**
5
+ * @example
6
+ * {
7
+ * planId: "plan_id"
8
+ * }
9
+ */
10
+ export interface ListPlanIssuesRequest {
11
+ planId: string;
12
+ }