schematichq 1.5.3 → 1.5.5

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 (267) hide show
  1. checksums.yaml +4 -4
  2. data/.fern/metadata.json +4 -4
  3. data/.fern/replay.lock +13 -1
  4. data/.fernignore +2 -0
  5. data/.rubocop.yml +4 -0
  6. data/README.md +1 -1
  7. data/WASM_VERSION +1 -1
  8. data/lib/schematic/accesstokens/client.rb +9 -1
  9. data/lib/schematic/accounts/client.rb +183 -21
  10. data/lib/schematic/billing/client.rb +748 -34
  11. data/lib/schematic/billing/types/count_native_invoices_params.rb +20 -0
  12. data/lib/schematic/billing/types/count_native_invoices_request.rb +19 -0
  13. data/lib/schematic/billing/types/count_native_invoices_response.rb +13 -0
  14. data/lib/schematic/billing/types/create_billing_price_request_body.rb +1 -1
  15. data/lib/schematic/billing/types/create_billing_product_request_body.rb +1 -1
  16. data/lib/schematic/billing/types/create_billing_subscription_request_body.rb +1 -1
  17. data/lib/schematic/billing/types/create_coupon_request_body.rb +2 -2
  18. data/lib/schematic/billing/types/create_invoice_request_body.rb +1 -1
  19. data/lib/schematic/billing/types/finalize_native_invoice_response.rb +13 -0
  20. data/lib/schematic/billing/types/get_billing_settings_response.rb +13 -0
  21. data/lib/schematic/billing/types/get_company_native_subscription_response.rb +13 -0
  22. data/lib/schematic/billing/types/get_native_invoice_response.rb +13 -0
  23. data/lib/schematic/billing/types/list_billing_prices_params.rb +1 -1
  24. data/lib/schematic/billing/types/list_billing_prices_request.rb +1 -1
  25. data/lib/schematic/billing/types/list_billing_product_prices_params.rb +1 -1
  26. data/lib/schematic/billing/types/list_billing_product_prices_request.rb +1 -1
  27. data/lib/schematic/billing/types/list_native_invoices_params.rb +20 -0
  28. data/lib/schematic/billing/types/list_native_invoices_request.rb +19 -0
  29. data/lib/schematic/billing/types/list_native_invoices_response.rb +13 -0
  30. data/lib/schematic/billing/types/mark_invoice_paid_request_body.rb +19 -0
  31. data/lib/schematic/billing/types/mark_native_invoice_paid_response.rb +13 -0
  32. data/lib/schematic/billing/types/update_billing_settings_request_body.rb +11 -0
  33. data/lib/schematic/billing/types/update_billing_settings_response.rb +13 -0
  34. data/lib/schematic/billing/types/void_native_invoice_response.rb +13 -0
  35. data/lib/schematic/catalogs/client.rb +121 -14
  36. data/lib/schematic/checkout/client.rb +80 -9
  37. data/lib/schematic/checkout/types/checkout_data_request_body.rb +1 -1
  38. data/lib/schematic/client.rb +5 -3
  39. data/lib/schematic/companies/client.rb +380 -44
  40. data/lib/schematic/components/client.rb +70 -8
  41. data/lib/schematic/components/types/create_component_request_body.rb +1 -1
  42. data/lib/schematic/components/types/update_component_request_body.rb +1 -1
  43. data/lib/schematic/componentspublic/client.rb +8 -1
  44. data/lib/schematic/credits/client.rb +409 -41
  45. data/lib/schematic/credits/types/acquire_credit_lease_request_body.rb +1 -1
  46. data/lib/schematic/credits/types/create_billing_credit_request_body.rb +1 -1
  47. data/lib/schematic/credits/types/create_company_credit_grant.rb +1 -1
  48. data/lib/schematic/credits/types/create_credit_bundle_request_body.rb +1 -1
  49. data/lib/schematic/credits/types/create_credit_spend_policy_request_body.rb +2 -2
  50. data/lib/schematic/credits/types/extend_credit_lease_request_body.rb +1 -1
  51. data/lib/schematic/credits/types/get_credit_balance_time_series_params.rb +18 -0
  52. data/lib/schematic/credits/types/get_credit_balance_time_series_request.rb +17 -0
  53. data/lib/schematic/credits/types/get_credit_balance_time_series_response.rb +13 -0
  54. data/lib/schematic/credits/types/reserve_credits_request_body.rb +1 -1
  55. data/lib/schematic/credits/types/update_credit_spend_policy_request_body.rb +2 -2
  56. data/lib/schematic/dataexports/client.rb +36 -6
  57. data/lib/schematic/entitlements/client.rb +244 -28
  58. data/lib/schematic/entitlements/types/create_billing_linked_plan_entitlement_request_body.rb +4 -2
  59. data/lib/schematic/entitlements/types/create_company_override_request_body.rb +3 -1
  60. data/lib/schematic/entitlements/types/create_plan_entitlement_request_body.rb +4 -2
  61. data/lib/schematic/entitlements/types/update_company_override_request_body.rb +3 -1
  62. data/lib/schematic/entitlements/types/update_plan_entitlement_request_body.rb +4 -2
  63. data/lib/schematic/errors/connection_error.rb +11 -0
  64. data/lib/schematic/errors/response_error.rb +23 -2
  65. data/lib/schematic/events/client.rb +78 -9
  66. data/lib/schematic/features/client.rb +160 -20
  67. data/lib/schematic/features/types/check_and_reserve_flag_request_body.rb +1 -1
  68. data/lib/schematic/features/types/create_billing_linked_feature_request_body.rb +2 -0
  69. data/lib/schematic/features/types/create_feature_request_body.rb +2 -0
  70. data/lib/schematic/features/types/update_feature_request_body.rb +2 -0
  71. data/lib/schematic/insights/client.rb +48 -6
  72. data/lib/schematic/integrationsapi/client.rb +120 -14
  73. data/lib/schematic/internal/http/base_request.rb +30 -0
  74. data/lib/schematic/internal/http/raw_client.rb +35 -5
  75. data/lib/schematic/internal/iterators/cursor_item_iterator.rb +9 -4
  76. data/lib/schematic/internal/iterators/cursor_page_iterator.rb +78 -15
  77. data/lib/schematic/internal/iterators/item_iterator.rb +70 -15
  78. data/lib/schematic/internal/iterators/offset_item_iterator.rb +9 -4
  79. data/lib/schematic/internal/iterators/offset_page_iterator.rb +71 -14
  80. data/lib/schematic/internal/json/request.rb +11 -2
  81. data/lib/schematic/internal/multipart/multipart_request.rb +1 -0
  82. data/lib/schematic/internal/types/model.rb +24 -4
  83. data/lib/schematic/internal/types/utils.rb +7 -0
  84. data/lib/schematic/licenses/client.rb +26 -3
  85. data/lib/schematic/planbundle/client.rb +27 -3
  86. data/lib/schematic/plangroups/client.rb +26 -3
  87. data/lib/schematic/planmigrations/client.rb +98 -11
  88. data/lib/schematic/plans/client.rb +274 -28
  89. data/lib/schematic/plans/types/get_plan_version_diff_params.rb +12 -0
  90. data/lib/schematic/plans/types/get_plan_version_diff_request.rb +13 -0
  91. data/lib/schematic/plans/types/get_plan_version_diff_response.rb +13 -0
  92. data/lib/schematic/plans/types/list_custom_plan_billings_params.rb +4 -0
  93. data/lib/schematic/plans/types/list_custom_plan_billings_request.rb +4 -0
  94. data/lib/schematic/plans/types/preview_publish_plan_version_response.rb +13 -0
  95. data/lib/schematic/rules_engine.rb +14 -2
  96. data/lib/schematic/scheduledcheckout/client.rb +35 -4
  97. data/lib/schematic/schematic_client.rb +22 -11
  98. data/lib/schematic/types/amendment_proration_lands_on.rb +13 -0
  99. data/lib/schematic/types/billing_coupon_response_data.rb +2 -2
  100. data/lib/schematic/types/billing_credit_grant_response_data.rb +8 -8
  101. data/lib/schematic/types/billing_customer_subscription.rb +1 -1
  102. data/lib/schematic/types/billing_invoice_detail_response_data.rb +49 -0
  103. data/lib/schematic/types/billing_invoice_line_response_data.rb +27 -0
  104. data/lib/schematic/types/billing_invoice_response_data.rb +43 -0
  105. data/lib/schematic/types/billing_invoice_settlement_response_data.rb +17 -0
  106. data/lib/schematic/types/billing_invoice_terms_response_data.rb +19 -0
  107. data/lib/schematic/types/billing_native_subscription_change_response_data.rb +15 -0
  108. data/lib/schematic/types/billing_native_subscription_line_response_data.rb +47 -0
  109. data/lib/schematic/types/billing_native_subscription_response_data.rb +31 -0
  110. data/lib/schematic/types/billing_plan_credit_grant_response_data.rb +1 -1
  111. data/lib/schematic/types/billing_price_response_data.rb +1 -1
  112. data/lib/schematic/types/billing_price_view.rb +1 -1
  113. data/lib/schematic/types/billing_product_detail_response_data.rb +2 -2
  114. data/lib/schematic/types/billing_product_for_subscription_response_data.rb +2 -2
  115. data/lib/schematic/types/billing_product_price_response_data.rb +1 -1
  116. data/lib/schematic/types/billing_product_pricing.rb +1 -1
  117. data/lib/schematic/types/billing_product_response_data.rb +2 -2
  118. data/lib/schematic/types/billing_settings_response_data.rb +9 -0
  119. data/lib/schematic/types/billing_statement_line_response_data.rb +21 -0
  120. data/lib/schematic/types/billing_statement_response_data.rb +19 -0
  121. data/lib/schematic/types/billing_subscription_discount_view.rb +2 -2
  122. data/lib/schematic/types/billing_subscription_response_data.rb +1 -1
  123. data/lib/schematic/types/billing_subscription_view.rb +1 -1
  124. data/lib/schematic/types/catalog_config_ordered_plan.rb +2 -0
  125. data/lib/schematic/types/catalog_config_ordered_plan_response_data.rb +2 -0
  126. data/lib/schematic/types/catalog_config_plan_credit.rb +11 -0
  127. data/lib/schematic/types/catalog_config_plan_credit_response_data.rb +11 -0
  128. data/lib/schematic/types/change_subscription_internal_request_body.rb +1 -1
  129. data/lib/schematic/types/change_subscription_request_body.rb +1 -1
  130. data/lib/schematic/types/charge_timing.rb +12 -0
  131. data/lib/schematic/types/checkout_problem_code.rb +54 -0
  132. data/lib/schematic/types/checkout_problem_response_data.rb +31 -0
  133. data/lib/schematic/types/checkout_problem_source.rb +13 -0
  134. data/lib/schematic/types/checkout_subscription.rb +1 -1
  135. data/lib/schematic/types/collector.rb +13 -0
  136. data/lib/schematic/types/company_billing_entity_subscription_response_data.rb +1 -1
  137. data/lib/schematic/types/company_billing_profile_response_data.rb +12 -0
  138. data/lib/schematic/types/company_credit_balance.rb +7 -3
  139. data/lib/schematic/types/company_credit_balance_response_data.rb +4 -4
  140. data/lib/schematic/types/company_detail_response_data.rb +1 -1
  141. data/lib/schematic/types/company_override_response_data.rb +3 -1
  142. data/lib/schematic/types/company_plan_credit_grant_view.rb +1 -1
  143. data/lib/schematic/types/company_plan_detail_response_data.rb +2 -0
  144. data/lib/schematic/types/company_subscription_response_data.rb +1 -1
  145. data/lib/schematic/types/company_user_usage_response_data.rb +2 -2
  146. data/lib/schematic/types/company_user_usage_row_response_data.rb +2 -2
  147. data/lib/schematic/types/component_response_data.rb +1 -1
  148. data/lib/schematic/types/condition.rb +3 -1
  149. data/lib/schematic/types/condition_response_data.rb +3 -1
  150. data/lib/schematic/types/condition_view.rb +3 -1
  151. data/lib/schematic/types/coupon_request_body.rb +2 -2
  152. data/lib/schematic/types/create_billing_plan_credit_grant_request_body.rb +1 -1
  153. data/lib/schematic/types/create_entitlement_in_bundle_request_body.rb +4 -2
  154. data/lib/schematic/types/create_entitlement_req_common.rb +3 -1
  155. data/lib/schematic/types/create_flag_request_body.rb +1 -1
  156. data/lib/schematic/types/create_or_update_condition_request_body.rb +1 -1
  157. data/lib/schematic/types/create_or_update_flag_request_body.rb +1 -1
  158. data/lib/schematic/types/credit_balance_event_response_data.rb +21 -0
  159. data/lib/schematic/types/credit_balance_feature_consumption_response_data.rb +13 -0
  160. data/lib/schematic/types/credit_balance_point_response_data.rb +15 -0
  161. data/lib/schematic/types/credit_balance_time_series_response_data.rb +15 -0
  162. data/lib/schematic/types/credit_bundle_currency_price.rb +1 -1
  163. data/lib/schematic/types/credit_bundle_currency_price_request_body.rb +1 -1
  164. data/lib/schematic/types/credit_bundle_currency_price_response_data.rb +1 -1
  165. data/lib/schematic/types/credit_burn_breakdown_line.rb +15 -0
  166. data/lib/schematic/types/credit_company_grant_view.rb +8 -8
  167. data/lib/schematic/types/credit_currency_price.rb +1 -1
  168. data/lib/schematic/types/credit_currency_price_request_body.rb +1 -1
  169. data/lib/schematic/types/credit_currency_price_response_data.rb +1 -1
  170. data/lib/schematic/types/credit_event_ledger_response_data.rb +10 -6
  171. data/lib/schematic/types/credit_grant_detail.rb +1 -1
  172. data/lib/schematic/types/credit_lease_response_data.rb +2 -2
  173. data/lib/schematic/types/credit_reservation_response_data.rb +2 -2
  174. data/lib/schematic/types/credit_spend_policy.rb +4 -2
  175. data/lib/schematic/types/credit_spend_policy_response_data.rb +4 -4
  176. data/lib/schematic/types/credit_transfer_response_data.rb +1 -1
  177. data/lib/schematic/types/credit_transfer_view.rb +1 -1
  178. data/lib/schematic/types/credit_usage.rb +5 -5
  179. data/lib/schematic/types/credit_usage_aggregation.rb +4 -4
  180. data/lib/schematic/types/credit_usage_reason.rb +1 -0
  181. data/lib/schematic/types/credits_in_plan.rb +11 -0
  182. data/lib/schematic/types/currency.rb +144 -0
  183. data/lib/schematic/types/currency_price_request_body.rb +1 -1
  184. data/lib/schematic/types/custom_plan_billing_response_data.rb +6 -0
  185. data/lib/schematic/types/entitlement_currency_prices_response_data.rb +1 -1
  186. data/lib/schematic/types/estimated_plan_total.rb +1 -1
  187. data/lib/schematic/types/event_body_inference.rb +4 -0
  188. data/lib/schematic/types/feature_company_response_data.rb +7 -7
  189. data/lib/schematic/types/feature_detail_response_data.rb +2 -0
  190. data/lib/schematic/types/feature_entitlement.rb +8 -6
  191. data/lib/schematic/types/feature_event_source.rb +12 -0
  192. data/lib/schematic/types/feature_in_plan_response_data.rb +2 -0
  193. data/lib/schematic/types/feature_response_data.rb +2 -0
  194. data/lib/schematic/types/feature_usage_response_data.rb +7 -7
  195. data/lib/schematic/types/feature_view.rb +2 -0
  196. data/lib/schematic/types/flag_check_reservation_response_data.rb +3 -3
  197. data/lib/schematic/types/flag_detail_response_data.rb +1 -1
  198. data/lib/schematic/types/flag_in_plan_response_data.rb +1 -1
  199. data/lib/schematic/types/flag_response_data.rb +1 -1
  200. data/lib/schematic/types/insights_summary_response_data.rb +1 -1
  201. data/lib/schematic/types/invoice_collection_state.rb +17 -0
  202. data/lib/schematic/types/invoice_document_state.rb +14 -0
  203. data/lib/schematic/types/invoice_line_kind.rb +15 -0
  204. data/lib/schematic/types/invoice_request_body.rb +1 -1
  205. data/lib/schematic/types/invoice_response_data.rb +1 -1
  206. data/lib/schematic/types/line_kind.rb +13 -0
  207. data/lib/schematic/types/manage_plan_preview_response_response_data.rb +2 -0
  208. data/lib/schematic/types/manage_plan_request.rb +3 -1
  209. data/lib/schematic/types/manage_plan_response_response_data.rb +4 -0
  210. data/lib/schematic/types/mrr_response_data.rb +1 -1
  211. data/lib/schematic/types/onboarding_milestone_view.rb +1 -1
  212. data/lib/schematic/types/ordered_plans_in_group.rb +2 -0
  213. data/lib/schematic/types/payment_gating.rb +12 -0
  214. data/lib/schematic/types/plan_billing_source.rb +1 -0
  215. data/lib/schematic/types/plan_change_action.rb +1 -0
  216. data/lib/schematic/types/plan_change_amendment_status.rb +15 -0
  217. data/lib/schematic/types/plan_change_response_data.rb +4 -0
  218. data/lib/schematic/types/plan_credit_grant_view.rb +1 -1
  219. data/lib/schematic/types/plan_credit_order.rb +11 -0
  220. data/lib/schematic/types/plan_credit_visibility.rb +11 -0
  221. data/lib/schematic/types/plan_currency_price_request_body.rb +1 -1
  222. data/lib/schematic/types/plan_currency_prices_response_data.rb +1 -1
  223. data/lib/schematic/types/plan_entitlement_response_data.rb +3 -1
  224. data/lib/schematic/types/plan_group_plan_entitlements_order.rb +2 -0
  225. data/lib/schematic/types/plan_version_billing_product_change_response_data.rb +11 -0
  226. data/lib/schematic/types/plan_version_credit_grant_change_response_data.rb +17 -0
  227. data/lib/schematic/types/plan_version_diff_change_type.rb +13 -0
  228. data/lib/schematic/types/plan_version_diff_price_cadence.rb +14 -0
  229. data/lib/schematic/types/plan_version_diff_response_data.rb +23 -0
  230. data/lib/schematic/types/plan_version_entitlement_change_response_data.rb +17 -0
  231. data/lib/schematic/types/plan_version_field_change_response_data.rb +13 -0
  232. data/lib/schematic/types/plan_version_price_change_response_data.rb +15 -0
  233. data/lib/schematic/types/plan_view_public_response_data.rb +2 -0
  234. data/lib/schematic/types/preflight_event_quantities_request_body.rb +13 -0
  235. data/lib/schematic/types/preflight_request_body.rb +3 -1
  236. data/lib/schematic/types/preview_subscription_change_response_data.rb +3 -1
  237. data/lib/schematic/types/preview_subscription_discount_response_data.rb +2 -2
  238. data/lib/schematic/types/preview_subscription_finance_response_data.rb +2 -2
  239. data/lib/schematic/types/publish_plan_version_request_body.rb +43 -0
  240. data/lib/schematic/types/publish_preview_pay_in_advance_response_data.rb +15 -0
  241. data/lib/schematic/types/publish_preview_payment_method_response_data.rb +15 -0
  242. data/lib/schematic/types/publish_preview_proration_line_response_data.rb +19 -0
  243. data/lib/schematic/types/publish_preview_response_data.rb +53 -0
  244. data/lib/schematic/types/rulesengine_company.rb +1 -1
  245. data/lib/schematic/types/rulesengine_condition.rb +3 -1
  246. data/lib/schematic/types/rulesengine_credit_postpaid_config.rb +1 -1
  247. data/lib/schematic/types/rulesengine_credit_spend_policy.rb +4 -2
  248. data/lib/schematic/types/rulesengine_feature_entitlement.rb +8 -6
  249. data/lib/schematic/types/scheduled_downgrade_response_data.rb +1 -1
  250. data/lib/schematic/types/subscription_change_action.rb +14 -0
  251. data/lib/schematic/types/top_feature_by_usage_response_data.rb +1 -1
  252. data/lib/schematic/types/upcoming_invoice_response_data.rb +1 -1
  253. data/lib/schematic/types/update_billing_plan_credit_grant_request_body.rb +1 -1
  254. data/lib/schematic/types/update_entitlement_req_common.rb +3 -1
  255. data/lib/schematic/types/upsert_billing_product_request_body.rb +1 -1
  256. data/lib/schematic/types/usage_based_entitlement_request_body.rb +1 -1
  257. data/lib/schematic/types/usage_based_entitlement_response_data.rb +1 -1
  258. data/lib/schematic/types/user_credit_usage_response_data.rb +2 -2
  259. data/lib/schematic/types/user_daily_credit_point_response_data.rb +1 -1
  260. data/lib/schematic/types/user_feature_usage_response_data.rb +1 -1
  261. data/lib/schematic/version.rb +1 -1
  262. data/lib/schematic/wasm/rulesengine.wasm +0 -0
  263. data/lib/schematic/webhooks/client.rb +88 -10
  264. data/lib/schematic.rb +80 -8
  265. data/reference.md +892 -113
  266. metadata +75 -3
  267. data/lib/schematic/plans/types/publish_plan_version_request_body.rb +0 -45
data/reference.md CHANGED
@@ -1544,7 +1544,7 @@ client.billing.upsert_billing_coupon(
1544
1544
  <dl>
1545
1545
  <dd>
1546
1546
 
1547
- **currency:** `String`
1547
+ **currency:** `Schematic::Types::Currency`
1548
1548
 
1549
1549
  </dd>
1550
1550
  </dl>
@@ -1592,7 +1592,7 @@ client.billing.upsert_billing_coupon(
1592
1592
  <dl>
1593
1593
  <dd>
1594
1594
 
1595
- **percent_off:** `Integer`
1595
+ **percent_off:** `Float`
1596
1596
 
1597
1597
  </dd>
1598
1598
  </dl>
@@ -2113,7 +2113,7 @@ client.billing.upsert_invoice(
2113
2113
  amount_paid: 1000000,
2114
2114
  amount_remaining: 1000000,
2115
2115
  collection_method: "collection_method",
2116
- currency: "currency",
2116
+ currency: "aed",
2117
2117
  customer_external_id: "customer_external_id",
2118
2118
  subtotal: 1000000
2119
2119
  )
@@ -2163,7 +2163,7 @@ client.billing.upsert_invoice(
2163
2163
  <dl>
2164
2164
  <dd>
2165
2165
 
2166
- **currency:** `String`
2166
+ **currency:** `Schematic::Types::Currency`
2167
2167
 
2168
2168
  </dd>
2169
2169
  </dl>
@@ -2751,7 +2751,7 @@ client.billing.delete_payment_method_by_external_id(billing_id: "billing_id")
2751
2751
 
2752
2752
  ```ruby
2753
2753
  client.billing.list_billing_prices(
2754
- currency: "currency",
2754
+ currency: "aed",
2755
2755
  for_initial_plan: true,
2756
2756
  for_trial_expiry_plan: true,
2757
2757
  ids: ["ids"],
@@ -2784,7 +2784,7 @@ client.billing.list_billing_prices(
2784
2784
  <dl>
2785
2785
  <dd>
2786
2786
 
2787
- **currency:** `String` — Filter for prices in a specific currency (e.g. usd, eur)
2787
+ **currency:** `Schematic::Types::Currency` — Filter for prices in a specific currency (e.g. usd, eur)
2788
2788
 
2789
2789
  </dd>
2790
2790
  </dl>
@@ -2955,7 +2955,7 @@ client.billing.list_billing_prices(
2955
2955
  ```ruby
2956
2956
  client.billing.upsert_billing_price(
2957
2957
  billing_scheme: "per_unit",
2958
- currency: "currency",
2958
+ currency: "aed",
2959
2959
  external_account_id: "external_account_id",
2960
2960
  interval: "interval",
2961
2961
  is_active: true,
@@ -2989,7 +2989,7 @@ client.billing.upsert_billing_price(
2989
2989
  <dl>
2990
2990
  <dd>
2991
2991
 
2992
- **currency:** `String`
2992
+ **currency:** `Schematic::Types::Currency`
2993
2993
 
2994
2994
  </dd>
2995
2995
  </dl>
@@ -3191,7 +3191,7 @@ client.billing.delete_billing_product(billing_id: "billing_id")
3191
3191
 
3192
3192
  ```ruby
3193
3193
  client.billing.list_billing_product_prices(
3194
- currency: "currency",
3194
+ currency: "aed",
3195
3195
  for_initial_plan: true,
3196
3196
  for_trial_expiry_plan: true,
3197
3197
  ids: ["ids"],
@@ -3224,7 +3224,7 @@ client.billing.list_billing_product_prices(
3224
3224
  <dl>
3225
3225
  <dd>
3226
3226
 
3227
- **currency:** `String` — Filter for prices in a specific currency (e.g. usd, eur)
3227
+ **currency:** `Schematic::Types::Currency` — Filter for prices in a specific currency (e.g. usd, eur)
3228
3228
 
3229
3229
  </dd>
3230
3230
  </dl>
@@ -3483,7 +3483,7 @@ client.billing.upsert_billing_product(
3483
3483
  <dl>
3484
3484
  <dd>
3485
3485
 
3486
- **price:** `Integer`
3486
+ **price:** `Float`
3487
3487
 
3488
3488
  </dd>
3489
3489
  </dl>
@@ -4008,6 +4008,94 @@ client.billing.update_company_billing_profile(
4008
4008
  </dl>
4009
4009
 
4010
4010
 
4011
+ </dd>
4012
+ </dl>
4013
+ </details>
4014
+
4015
+ <details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">get_billing_settings</a>() -> Schematic::Billing::Types::GetBillingSettingsResponse</code></summary>
4016
+ <dl>
4017
+ <dd>
4018
+
4019
+ #### 🔌 Usage
4020
+
4021
+ <dl>
4022
+ <dd>
4023
+
4024
+ <dl>
4025
+ <dd>
4026
+
4027
+ ```ruby
4028
+ client.billing.get_billing_settings
4029
+ ```
4030
+ </dd>
4031
+ </dl>
4032
+ </dd>
4033
+ </dl>
4034
+
4035
+ #### ⚙️ Parameters
4036
+
4037
+ <dl>
4038
+ <dd>
4039
+
4040
+ <dl>
4041
+ <dd>
4042
+
4043
+ **request_options:** `Schematic::Billing::RequestOptions`
4044
+
4045
+ </dd>
4046
+ </dl>
4047
+ </dd>
4048
+ </dl>
4049
+
4050
+
4051
+ </dd>
4052
+ </dl>
4053
+ </details>
4054
+
4055
+ <details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">update_billing_settings</a>(request) -> Schematic::Billing::Types::UpdateBillingSettingsResponse</code></summary>
4056
+ <dl>
4057
+ <dd>
4058
+
4059
+ #### 🔌 Usage
4060
+
4061
+ <dl>
4062
+ <dd>
4063
+
4064
+ <dl>
4065
+ <dd>
4066
+
4067
+ ```ruby
4068
+ client.billing.update_billing_settings
4069
+ ```
4070
+ </dd>
4071
+ </dl>
4072
+ </dd>
4073
+ </dl>
4074
+
4075
+ #### ⚙️ Parameters
4076
+
4077
+ <dl>
4078
+ <dd>
4079
+
4080
+ <dl>
4081
+ <dd>
4082
+
4083
+ **default_provider_type:** `Schematic::Types::BillingProviderType`
4084
+
4085
+ </dd>
4086
+ </dl>
4087
+
4088
+ <dl>
4089
+ <dd>
4090
+
4091
+ **request_options:** `Schematic::Billing::RequestOptions`
4092
+
4093
+ </dd>
4094
+ </dl>
4095
+ </dd>
4096
+ </dl>
4097
+
4098
+
4011
4099
  </dd>
4012
4100
  </dl>
4013
4101
  </details>
@@ -4027,7 +4115,7 @@ client.billing.update_company_billing_profile(
4027
4115
  ```ruby
4028
4116
  client.billing.upsert_billing_subscription(
4029
4117
  cancel_at_period_end: true,
4030
- currency: "currency",
4118
+ currency: "aed",
4031
4119
  customer_external_id: "customer_external_id",
4032
4120
  discounts: [{
4033
4121
  coupon_external_id: "coupon_external_id",
@@ -4037,7 +4125,7 @@ client.billing.upsert_billing_subscription(
4037
4125
  }],
4038
4126
  expired_at: "2024-01-15T09:30:00Z",
4039
4127
  product_external_ids: [{
4040
- currency: "currency",
4128
+ currency: "aed",
4041
4129
  interval: "interval",
4042
4130
  price: 1000000,
4043
4131
  price_external_id: "price_external_id",
@@ -4094,7 +4182,7 @@ client.billing.upsert_billing_subscription(
4094
4182
  <dl>
4095
4183
  <dd>
4096
4184
 
4097
- **currency:** `String`
4185
+ **currency:** `Schematic::Types::Currency`
4098
4186
 
4099
4187
  </dd>
4100
4188
  </dl>
@@ -4182,23 +4270,566 @@ client.billing.upsert_billing_subscription(
4182
4270
  <dl>
4183
4271
  <dd>
4184
4272
 
4185
- **provider_type:** `Schematic::Types::BillingProviderType`
4186
-
4187
- </dd>
4188
- </dl>
4273
+ **provider_type:** `Schematic::Types::BillingProviderType`
4274
+
4275
+ </dd>
4276
+ </dl>
4277
+
4278
+ <dl>
4279
+ <dd>
4280
+
4281
+ **started_at:** `String`
4282
+
4283
+ </dd>
4284
+ </dl>
4285
+
4286
+ <dl>
4287
+ <dd>
4288
+
4289
+ **status:** `String`
4290
+
4291
+ </dd>
4292
+ </dl>
4293
+
4294
+ <dl>
4295
+ <dd>
4296
+
4297
+ **subscription_external_id:** `String`
4298
+
4299
+ </dd>
4300
+ </dl>
4301
+
4302
+ <dl>
4303
+ <dd>
4304
+
4305
+ **total_price:** `Integer`
4306
+
4307
+ </dd>
4308
+ </dl>
4309
+
4310
+ <dl>
4311
+ <dd>
4312
+
4313
+ **trial_end:** `Integer`
4314
+
4315
+ </dd>
4316
+ </dl>
4317
+
4318
+ <dl>
4319
+ <dd>
4320
+
4321
+ **trial_end_setting:** `Schematic::Types::BillingSubscriptionTrialEndSetting`
4322
+
4323
+ </dd>
4324
+ </dl>
4325
+
4326
+ <dl>
4327
+ <dd>
4328
+
4329
+ **request_options:** `Schematic::Billing::RequestOptions`
4330
+
4331
+ </dd>
4332
+ </dl>
4333
+ </dd>
4334
+ </dl>
4335
+
4336
+
4337
+ </dd>
4338
+ </dl>
4339
+ </details>
4340
+
4341
+ <details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">get_company_native_subscription</a>(company_id:) -> Schematic::Billing::Types::GetCompanyNativeSubscriptionResponse</code></summary>
4342
+ <dl>
4343
+ <dd>
4344
+
4345
+ #### 🔌 Usage
4346
+
4347
+ <dl>
4348
+ <dd>
4349
+
4350
+ <dl>
4351
+ <dd>
4352
+
4353
+ ```ruby
4354
+ client.billing.get_company_native_subscription(company_id: "company_id")
4355
+ ```
4356
+ </dd>
4357
+ </dl>
4358
+ </dd>
4359
+ </dl>
4360
+
4361
+ #### ⚙️ Parameters
4362
+
4363
+ <dl>
4364
+ <dd>
4365
+
4366
+ <dl>
4367
+ <dd>
4368
+
4369
+ **company_id:** `String` — company_id
4370
+
4371
+ </dd>
4372
+ </dl>
4373
+
4374
+ <dl>
4375
+ <dd>
4376
+
4377
+ **request_options:** `Schematic::Billing::RequestOptions`
4378
+
4379
+ </dd>
4380
+ </dl>
4381
+ </dd>
4382
+ </dl>
4383
+
4384
+
4385
+ </dd>
4386
+ </dl>
4387
+ </details>
4388
+
4389
+ <details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">list_native_invoices</a>() -> Schematic::Billing::Types::ListNativeInvoicesResponse</code></summary>
4390
+ <dl>
4391
+ <dd>
4392
+
4393
+ #### 🔌 Usage
4394
+
4395
+ <dl>
4396
+ <dd>
4397
+
4398
+ <dl>
4399
+ <dd>
4400
+
4401
+ ```ruby
4402
+ client.billing.list_native_invoices(
4403
+ company_id: "company_id",
4404
+ contract_id: "contract_id",
4405
+ document_state: "credited",
4406
+ limit: 1000000,
4407
+ offset: 1000000
4408
+ )
4409
+ ```
4410
+ </dd>
4411
+ </dl>
4412
+ </dd>
4413
+ </dl>
4414
+
4415
+ #### ⚙️ Parameters
4416
+
4417
+ <dl>
4418
+ <dd>
4419
+
4420
+ <dl>
4421
+ <dd>
4422
+
4423
+ **company_id:** `String`
4424
+
4425
+ </dd>
4426
+ </dl>
4427
+
4428
+ <dl>
4429
+ <dd>
4430
+
4431
+ **contract_id:** `String`
4432
+
4433
+ </dd>
4434
+ </dl>
4435
+
4436
+ <dl>
4437
+ <dd>
4438
+
4439
+ **document_state:** `Schematic::Types::InvoiceDocumentState`
4440
+
4441
+ </dd>
4442
+ </dl>
4443
+
4444
+ <dl>
4445
+ <dd>
4446
+
4447
+ **limit:** `Integer` — Page limit (default 100)
4448
+
4449
+ </dd>
4450
+ </dl>
4451
+
4452
+ <dl>
4453
+ <dd>
4454
+
4455
+ **offset:** `Integer` — Page offset (default 0)
4456
+
4457
+ </dd>
4458
+ </dl>
4459
+
4460
+ <dl>
4461
+ <dd>
4462
+
4463
+ **request_options:** `Schematic::Billing::RequestOptions`
4464
+
4465
+ </dd>
4466
+ </dl>
4467
+ </dd>
4468
+ </dl>
4469
+
4470
+
4471
+ </dd>
4472
+ </dl>
4473
+ </details>
4474
+
4475
+ <details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">get_native_invoice</a>(invoice_id:) -> Schematic::Billing::Types::GetNativeInvoiceResponse</code></summary>
4476
+ <dl>
4477
+ <dd>
4478
+
4479
+ #### 🔌 Usage
4480
+
4481
+ <dl>
4482
+ <dd>
4483
+
4484
+ <dl>
4485
+ <dd>
4486
+
4487
+ ```ruby
4488
+ client.billing.get_native_invoice(invoice_id: "invoice_id")
4489
+ ```
4490
+ </dd>
4491
+ </dl>
4492
+ </dd>
4493
+ </dl>
4494
+
4495
+ #### ⚙️ Parameters
4496
+
4497
+ <dl>
4498
+ <dd>
4499
+
4500
+ <dl>
4501
+ <dd>
4502
+
4503
+ **invoice_id:** `String` — invoice_id
4504
+
4505
+ </dd>
4506
+ </dl>
4507
+
4508
+ <dl>
4509
+ <dd>
4510
+
4511
+ **request_options:** `Schematic::Billing::RequestOptions`
4512
+
4513
+ </dd>
4514
+ </dl>
4515
+ </dd>
4516
+ </dl>
4517
+
4518
+
4519
+ </dd>
4520
+ </dl>
4521
+ </details>
4522
+
4523
+ <details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">export_native_invoice</a>(invoice_id:) -> String</code></summary>
4524
+ <dl>
4525
+ <dd>
4526
+
4527
+ #### 🔌 Usage
4528
+
4529
+ <dl>
4530
+ <dd>
4531
+
4532
+ <dl>
4533
+ <dd>
4534
+
4535
+ ```ruby
4536
+ client.billing.export_native_invoice(invoice_id: "invoice_id")
4537
+ ```
4538
+ </dd>
4539
+ </dl>
4540
+ </dd>
4541
+ </dl>
4542
+
4543
+ #### ⚙️ Parameters
4544
+
4545
+ <dl>
4546
+ <dd>
4547
+
4548
+ <dl>
4549
+ <dd>
4550
+
4551
+ **invoice_id:** `String` — invoice_id
4552
+
4553
+ </dd>
4554
+ </dl>
4555
+
4556
+ <dl>
4557
+ <dd>
4558
+
4559
+ **request_options:** `Schematic::Billing::RequestOptions`
4560
+
4561
+ </dd>
4562
+ </dl>
4563
+ </dd>
4564
+ </dl>
4565
+
4566
+
4567
+ </dd>
4568
+ </dl>
4569
+ </details>
4570
+
4571
+ <details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">finalize_native_invoice</a>(invoice_id:) -> Schematic::Billing::Types::FinalizeNativeInvoiceResponse</code></summary>
4572
+ <dl>
4573
+ <dd>
4574
+
4575
+ #### 🔌 Usage
4576
+
4577
+ <dl>
4578
+ <dd>
4579
+
4580
+ <dl>
4581
+ <dd>
4582
+
4583
+ ```ruby
4584
+ client.billing.finalize_native_invoice(invoice_id: "invoice_id")
4585
+ ```
4586
+ </dd>
4587
+ </dl>
4588
+ </dd>
4589
+ </dl>
4590
+
4591
+ #### ⚙️ Parameters
4592
+
4593
+ <dl>
4594
+ <dd>
4595
+
4596
+ <dl>
4597
+ <dd>
4598
+
4599
+ **invoice_id:** `String` — invoice_id
4600
+
4601
+ </dd>
4602
+ </dl>
4603
+
4604
+ <dl>
4605
+ <dd>
4606
+
4607
+ **request_options:** `Schematic::Billing::RequestOptions`
4608
+
4609
+ </dd>
4610
+ </dl>
4611
+ </dd>
4612
+ </dl>
4613
+
4614
+
4615
+ </dd>
4616
+ </dl>
4617
+ </details>
4618
+
4619
+ <details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">mark_native_invoice_paid</a>(invoice_id:, request) -> Schematic::Billing::Types::MarkNativeInvoicePaidResponse</code></summary>
4620
+ <dl>
4621
+ <dd>
4622
+
4623
+ #### 🔌 Usage
4624
+
4625
+ <dl>
4626
+ <dd>
4627
+
4628
+ <dl>
4629
+ <dd>
4630
+
4631
+ ```ruby
4632
+ client.billing.mark_native_invoice_paid(
4633
+ invoice_id: "invoice_id",
4634
+ idempotency_key: "idempotency_key"
4635
+ )
4636
+ ```
4637
+ </dd>
4638
+ </dl>
4639
+ </dd>
4640
+ </dl>
4641
+
4642
+ #### ⚙️ Parameters
4643
+
4644
+ <dl>
4645
+ <dd>
4646
+
4647
+ <dl>
4648
+ <dd>
4649
+
4650
+ **invoice_id:** `String` — invoice_id
4651
+
4652
+ </dd>
4653
+ </dl>
4654
+
4655
+ <dl>
4656
+ <dd>
4657
+
4658
+ **amount:** `Integer` — Amount paid, in minor units of the invoice's currency. Leave empty to mark the whole remaining amount as paid.
4659
+
4660
+ </dd>
4661
+ </dl>
4662
+
4663
+ <dl>
4664
+ <dd>
4665
+
4666
+ **idempotency_key:** `String` — A retry with the same key records the payment once.
4667
+
4668
+ </dd>
4669
+ </dl>
4670
+
4671
+ <dl>
4672
+ <dd>
4673
+
4674
+ **reference:** `String` — A note that identifies the payment, such as a bank transfer reference.
4675
+
4676
+ </dd>
4677
+ </dl>
4678
+
4679
+ <dl>
4680
+ <dd>
4681
+
4682
+ **settled_at:** `String` — When the payment arrived. Defaults to now, and cannot be in the future.
4683
+
4684
+ </dd>
4685
+ </dl>
4686
+
4687
+ <dl>
4688
+ <dd>
4689
+
4690
+ **request_options:** `Schematic::Billing::RequestOptions`
4691
+
4692
+ </dd>
4693
+ </dl>
4694
+ </dd>
4695
+ </dl>
4696
+
4697
+
4698
+ </dd>
4699
+ </dl>
4700
+ </details>
4701
+
4702
+ <details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">download_native_invoice_pdf</a>(invoice_id:) -> String</code></summary>
4703
+ <dl>
4704
+ <dd>
4705
+
4706
+ #### 🔌 Usage
4707
+
4708
+ <dl>
4709
+ <dd>
4710
+
4711
+ <dl>
4712
+ <dd>
4713
+
4714
+ ```ruby
4715
+ client.billing.download_native_invoice_pdf(invoice_id: "invoice_id")
4716
+ ```
4717
+ </dd>
4718
+ </dl>
4719
+ </dd>
4720
+ </dl>
4721
+
4722
+ #### ⚙️ Parameters
4723
+
4724
+ <dl>
4725
+ <dd>
4726
+
4727
+ <dl>
4728
+ <dd>
4729
+
4730
+ **invoice_id:** `String` — invoice_id
4731
+
4732
+ </dd>
4733
+ </dl>
4734
+
4735
+ <dl>
4736
+ <dd>
4737
+
4738
+ **request_options:** `Schematic::Billing::RequestOptions`
4739
+
4740
+ </dd>
4741
+ </dl>
4742
+ </dd>
4743
+ </dl>
4744
+
4745
+
4746
+ </dd>
4747
+ </dl>
4748
+ </details>
4749
+
4750
+ <details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">void_native_invoice</a>(invoice_id:) -> Schematic::Billing::Types::VoidNativeInvoiceResponse</code></summary>
4751
+ <dl>
4752
+ <dd>
4753
+
4754
+ #### 🔌 Usage
4755
+
4756
+ <dl>
4757
+ <dd>
4758
+
4759
+ <dl>
4760
+ <dd>
4761
+
4762
+ ```ruby
4763
+ client.billing.void_native_invoice(invoice_id: "invoice_id")
4764
+ ```
4765
+ </dd>
4766
+ </dl>
4767
+ </dd>
4768
+ </dl>
4769
+
4770
+ #### ⚙️ Parameters
4771
+
4772
+ <dl>
4773
+ <dd>
4774
+
4775
+ <dl>
4776
+ <dd>
4777
+
4778
+ **invoice_id:** `String` — invoice_id
4779
+
4780
+ </dd>
4781
+ </dl>
4782
+
4783
+ <dl>
4784
+ <dd>
4785
+
4786
+ **request_options:** `Schematic::Billing::RequestOptions`
4787
+
4788
+ </dd>
4789
+ </dl>
4790
+ </dd>
4791
+ </dl>
4792
+
4793
+
4794
+ </dd>
4795
+ </dl>
4796
+ </details>
4797
+
4798
+ <details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">count_native_invoices</a>() -> Schematic::Billing::Types::CountNativeInvoicesResponse</code></summary>
4799
+ <dl>
4800
+ <dd>
4801
+
4802
+ #### 🔌 Usage
4189
4803
 
4190
4804
  <dl>
4191
4805
  <dd>
4192
4806
 
4193
- **started_at:** `String`
4194
-
4807
+ <dl>
4808
+ <dd>
4809
+
4810
+ ```ruby
4811
+ client.billing.count_native_invoices(
4812
+ company_id: "company_id",
4813
+ contract_id: "contract_id",
4814
+ document_state: "credited",
4815
+ limit: 1000000,
4816
+ offset: 1000000
4817
+ )
4818
+ ```
4819
+ </dd>
4820
+ </dl>
4195
4821
  </dd>
4196
4822
  </dl>
4197
4823
 
4824
+ #### ⚙️ Parameters
4825
+
4198
4826
  <dl>
4199
4827
  <dd>
4200
4828
 
4201
- **status:** `String`
4829
+ <dl>
4830
+ <dd>
4831
+
4832
+ **company_id:** `String`
4202
4833
 
4203
4834
  </dd>
4204
4835
  </dl>
@@ -4206,7 +4837,7 @@ client.billing.upsert_billing_subscription(
4206
4837
  <dl>
4207
4838
  <dd>
4208
4839
 
4209
- **subscription_external_id:** `String`
4840
+ **contract_id:** `String`
4210
4841
 
4211
4842
  </dd>
4212
4843
  </dl>
@@ -4214,7 +4845,7 @@ client.billing.upsert_billing_subscription(
4214
4845
  <dl>
4215
4846
  <dd>
4216
4847
 
4217
- **total_price:** `Integer`
4848
+ **document_state:** `Schematic::Types::InvoiceDocumentState`
4218
4849
 
4219
4850
  </dd>
4220
4851
  </dl>
@@ -4222,7 +4853,7 @@ client.billing.upsert_billing_subscription(
4222
4853
  <dl>
4223
4854
  <dd>
4224
4855
 
4225
- **trial_end:** `Integer`
4856
+ **limit:** `Integer` — Page limit (default 100)
4226
4857
 
4227
4858
  </dd>
4228
4859
  </dl>
@@ -4230,7 +4861,7 @@ client.billing.upsert_billing_subscription(
4230
4861
  <dl>
4231
4862
  <dd>
4232
4863
 
4233
- **trial_end_setting:** `Schematic::Types::BillingSubscriptionTrialEndSetting`
4864
+ **offset:** `Integer` — Page offset (default 0)
4234
4865
 
4235
4866
  </dd>
4236
4867
  </dl>
@@ -4342,7 +4973,7 @@ client.credits.list_billing_credits(
4342
4973
 
4343
4974
  ```ruby
4344
4975
  client.credits.create_billing_credit(
4345
- currency: "currency",
4976
+ currency: "aed",
4346
4977
  description: "description",
4347
4978
  name: "name"
4348
4979
  )
@@ -4368,7 +4999,7 @@ client.credits.create_billing_credit(
4368
4999
  <dl>
4369
5000
  <dd>
4370
5001
 
4371
- **currency:** `String`
5002
+ **currency:** `Schematic::Types::Currency`
4372
5003
 
4373
5004
  </dd>
4374
5005
  </dl>
@@ -4764,6 +5395,83 @@ client.credits.list_company_credit_balances(company_id: "company_id")
4764
5395
  </dl>
4765
5396
 
4766
5397
 
5398
+ </dd>
5399
+ </dl>
5400
+ </details>
5401
+
5402
+ <details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">get_credit_balance_time_series</a>() -> Schematic::Credits::Types::GetCreditBalanceTimeSeriesResponse</code></summary>
5403
+ <dl>
5404
+ <dd>
5405
+
5406
+ #### 🔌 Usage
5407
+
5408
+ <dl>
5409
+ <dd>
5410
+
5411
+ <dl>
5412
+ <dd>
5413
+
5414
+ ```ruby
5415
+ client.credits.get_credit_balance_time_series(
5416
+ billing_credit_id: "billing_credit_id",
5417
+ company_id: "company_id",
5418
+ end_time: "2024-01-15T09:30:00Z",
5419
+ start_time: "2024-01-15T09:30:00Z"
5420
+ )
5421
+ ```
5422
+ </dd>
5423
+ </dl>
5424
+ </dd>
5425
+ </dl>
5426
+
5427
+ #### ⚙️ Parameters
5428
+
5429
+ <dl>
5430
+ <dd>
5431
+
5432
+ <dl>
5433
+ <dd>
5434
+
5435
+ **billing_credit_id:** `String`
5436
+
5437
+ </dd>
5438
+ </dl>
5439
+
5440
+ <dl>
5441
+ <dd>
5442
+
5443
+ **company_id:** `String`
5444
+
5445
+ </dd>
5446
+ </dl>
5447
+
5448
+ <dl>
5449
+ <dd>
5450
+
5451
+ **end_time:** `String`
5452
+
5453
+ </dd>
5454
+ </dl>
5455
+
5456
+ <dl>
5457
+ <dd>
5458
+
5459
+ **start_time:** `String`
5460
+
5461
+ </dd>
5462
+ </dl>
5463
+
5464
+ <dl>
5465
+ <dd>
5466
+
5467
+ **request_options:** `Schematic::Credits::RequestOptions`
5468
+
5469
+ </dd>
5470
+ </dl>
5471
+ </dd>
5472
+ </dl>
5473
+
5474
+
4767
5475
  </dd>
4768
5476
  </dl>
4769
5477
  </details>
@@ -4879,7 +5587,7 @@ client.credits.list_credit_bundles(
4879
5587
  client.credits.create_credit_bundle(
4880
5588
  bundle_name: "bundle_name",
4881
5589
  credit_id: "credit_id",
4882
- currency: "currency",
5590
+ currency: "aed",
4883
5591
  price_per_unit: 1000000
4884
5592
  )
4885
5593
  ```
@@ -4928,7 +5636,7 @@ client.credits.create_credit_bundle(
4928
5636
  <dl>
4929
5637
  <dd>
4930
5638
 
4931
- **currency:** `String`
5639
+ **currency:** `Schematic::Types::Currency`
4932
5640
 
4933
5641
  </dd>
4934
5642
  </dl>
@@ -5533,7 +6241,7 @@ client.credits.grant_billing_credits_to_company(
5533
6241
  <dl>
5534
6242
  <dd>
5535
6243
 
5536
- **currency:** `String`
6244
+ **currency:** `Schematic::Types::Currency`
5537
6245
 
5538
6246
  </dd>
5539
6247
  </dl>
@@ -5999,7 +6707,7 @@ client.credits.acquire_credit_lease(
5999
6707
  <dl>
6000
6708
  <dd>
6001
6709
 
6002
- **requested_amount:** `Integer`
6710
+ **requested_amount:** `Float`
6003
6711
 
6004
6712
  </dd>
6005
6713
  </dl>
@@ -6066,7 +6774,7 @@ client.credits.extend_credit_lease(
6066
6774
  <dl>
6067
6775
  <dd>
6068
6776
 
6069
- **additional_amount:** `Integer`
6777
+ **additional_amount:** `Float`
6070
6778
 
6071
6779
  </dd>
6072
6780
  </dl>
@@ -6637,7 +7345,7 @@ client.credits.reserve_credits(
6637
7345
  <dl>
6638
7346
  <dd>
6639
7347
 
6640
- **amount:** `Integer` — Credits to hold for the operation. The full amount must be available; a partial hold is never taken
7348
+ **amount:** `Float` — Credits to hold for the operation. The full amount must be available; a partial hold is never taken
6641
7349
 
6642
7350
  </dd>
6643
7351
  </dl>
@@ -6877,7 +7585,7 @@ client.credits.create_credit_spend_policy(billing_credit_id: "billing_credit_id"
6877
7585
  <dl>
6878
7586
  <dd>
6879
7587
 
6880
- **company_id:** `String` — The company the cap applies to. Set exactly one of company_id and user_id.
7588
+ **company_id:** `String` — The company the cap applies in. Alone, it caps the whole company. With user_id, it caps that user's spend in this company. Required with user_id when the user belongs to more than one company.
6881
7589
 
6882
7590
  </dd>
6883
7591
  </dl>
@@ -6893,7 +7601,7 @@ client.credits.create_credit_spend_policy(billing_credit_id: "billing_credit_id"
6893
7601
  <dl>
6894
7602
  <dd>
6895
7603
 
6896
- **max_per_draw:** `Integer` — The largest number of credits a single draw may spend. Set either this or window_amount.
7604
+ **max_per_draw:** `Float` — The largest number of credits a single draw may spend. Set either this or window_amount.
6897
7605
 
6898
7606
  </dd>
6899
7607
  </dl>
@@ -6901,7 +7609,7 @@ client.credits.create_credit_spend_policy(billing_credit_id: "billing_credit_id"
6901
7609
  <dl>
6902
7610
  <dd>
6903
7611
 
6904
- **user_id:** `String` — The user the cap applies to. Set exactly one of company_id and user_id.
7612
+ **user_id:** `String` — The user the cap applies to. The user must belong to company_id, and with no company_id, to exactly one company.
6905
7613
 
6906
7614
  </dd>
6907
7615
  </dl>
@@ -6909,7 +7617,7 @@ client.credits.create_credit_spend_policy(billing_credit_id: "billing_credit_id"
6909
7617
  <dl>
6910
7618
  <dd>
6911
7619
 
6912
- **window_amount:** `Integer` — The number of credits the company or user may spend in one window. Set either this or max_per_draw.
7620
+ **window_amount:** `Float` — The number of credits the company or user may spend in one window. Set either this or max_per_draw.
6913
7621
 
6914
7622
  </dd>
6915
7623
  </dl>
@@ -7029,7 +7737,7 @@ client.credits.update_credit_spend_policy(spend_policy_id: "spend_policy_id")
7029
7737
  <dl>
7030
7738
  <dd>
7031
7739
 
7032
- **max_per_draw:** `Integer`
7740
+ **max_per_draw:** `Float`
7033
7741
 
7034
7742
  </dd>
7035
7743
  </dl>
@@ -7037,7 +7745,7 @@ client.credits.update_credit_spend_policy(spend_policy_id: "spend_policy_id")
7037
7745
  <dl>
7038
7746
  <dd>
7039
7747
 
7040
- **window_amount:** `Integer`
7748
+ **window_amount:** `Float`
7041
7749
 
7042
7750
  </dd>
7043
7751
  </dl>
@@ -8470,7 +9178,7 @@ client.checkout.get_checkout_data(company_id: "company_id")
8470
9178
  <dl>
8471
9179
  <dd>
8472
9180
 
8473
- **currency:** `String`
9181
+ **currency:** `Schematic::Types::Currency`
8474
9182
 
8475
9183
  </dd>
8476
9184
  </dl>
@@ -9133,7 +9841,7 @@ client.companies.list_companies(
9133
9841
  <dl>
9134
9842
  <dd>
9135
9843
 
9136
- **without_feature_override_for:** `String` — Filter out companies that already have a company override for the specified feature ID
9844
+ **without_feature_override_for:** `String` — Filter out companies that have an unexpired company override for the specified feature ID
9137
9845
 
9138
9846
  </dd>
9139
9847
  </dl>
@@ -9529,7 +10237,7 @@ client.companies.count_companies(
9529
10237
  <dl>
9530
10238
  <dd>
9531
10239
 
9532
- **without_feature_override_for:** `String` — Filter out companies that already have a company override for the specified feature ID
10240
+ **without_feature_override_for:** `String` — Filter out companies that have an unexpired company override for the specified feature ID
9533
10241
 
9534
10242
  </dd>
9535
10243
  </dl>
@@ -11127,7 +11835,7 @@ client.companies.count_entity_traits(
11127
11835
 
11128
11836
  ```ruby
11129
11837
  client.companies.list_plan_changes(
11130
- action: "checkout",
11838
+ action: "amendment",
11131
11839
  base_plan_action: "fallback",
11132
11840
  company_id: "company_id",
11133
11841
  company_ids: ["company_ids"],
@@ -12267,7 +12975,7 @@ client.entitlements.create_company_override(
12267
12975
  <dl>
12268
12976
  <dd>
12269
12977
 
12270
- **credit_consumption_rate:** `Integer`
12978
+ **credit_consumption_rate:** `Float`
12271
12979
 
12272
12980
  </dd>
12273
12981
  </dl>
@@ -12315,6 +13023,14 @@ client.entitlements.create_company_override(
12315
13023
  <dl>
12316
13024
  <dd>
12317
13025
 
13026
+ **quantity_rates:** `Internal::Types::Hash[String, Float]` — Credits per unit of the quantity (per token for inference features), keyed by quantity key. Inference features may price input_tokens, output_tokens, cached_input_tokens, cache_creation_input_tokens and reasoning_tokens; reasoning_tokens is priced on top of output_tokens, so leave its rate at zero for providers that count reasoning inside output. Omit to leave the schedule as it is; send null to clear it.
13027
+
13028
+ </dd>
13029
+ </dl>
13030
+
13031
+ <dl>
13032
+ <dd>
13033
+
12318
13034
  **value_bool:** `Internal::Types::Boolean`
12319
13035
 
12320
13036
  </dd>
@@ -12454,7 +13170,7 @@ client.entitlements.update_company_override(
12454
13170
  <dl>
12455
13171
  <dd>
12456
13172
 
12457
- **credit_consumption_rate:** `Integer`
13173
+ **credit_consumption_rate:** `Float`
12458
13174
 
12459
13175
  </dd>
12460
13176
  </dl>
@@ -12494,6 +13210,14 @@ client.entitlements.update_company_override(
12494
13210
  <dl>
12495
13211
  <dd>
12496
13212
 
13213
+ **quantity_rates:** `Internal::Types::Hash[String, Float]` — Credits per unit of the quantity (per token for inference features), keyed by quantity key. Inference features may price input_tokens, output_tokens, cached_input_tokens, cache_creation_input_tokens and reasoning_tokens; reasoning_tokens is priced on top of output_tokens, so leave its rate at zero for providers that count reasoning inside output. Omit to leave the schedule as it is; send null to clear it.
13214
+
13215
+ </dd>
13216
+ </dl>
13217
+
13218
+ <dl>
13219
+ <dd>
13220
+
12497
13221
  **value_bool:** `Internal::Types::Boolean`
12498
13222
 
12499
13223
  </dd>
@@ -13644,7 +14368,7 @@ client.entitlements.create_plan_entitlement(
13644
14368
  <dl>
13645
14369
  <dd>
13646
14370
 
13647
- **credit_consumption_rate:** `Integer`
14371
+ **credit_consumption_rate:** `Float`
13648
14372
 
13649
14373
  </dd>
13650
14374
  </dl>
@@ -13652,7 +14376,7 @@ client.entitlements.create_plan_entitlement(
13652
14376
  <dl>
13653
14377
  <dd>
13654
14378
 
13655
- **currency:** `String`
14379
+ **currency:** `Schematic::Types::Currency`
13656
14380
 
13657
14381
  </dd>
13658
14382
  </dl>
@@ -13780,6 +14504,14 @@ client.entitlements.create_plan_entitlement(
13780
14504
  <dl>
13781
14505
  <dd>
13782
14506
 
14507
+ **quantity_rates:** `Internal::Types::Hash[String, Float]` — Credits per unit of the quantity (per token for inference features), keyed by quantity key. Inference features may price input_tokens, output_tokens, cached_input_tokens, cache_creation_input_tokens and reasoning_tokens; reasoning_tokens is priced on top of output_tokens, so leave its rate at zero for providers that count reasoning inside output. Omit to leave the schedule as it is; send null to clear it.
14508
+
14509
+ </dd>
14510
+ </dl>
14511
+
14512
+ <dl>
14513
+ <dd>
14514
+
13783
14515
  **quarterly_metered_price_id:** `String`
13784
14516
 
13785
14517
  </dd>
@@ -14031,7 +14763,7 @@ client.entitlements.update_plan_entitlement(
14031
14763
  <dl>
14032
14764
  <dd>
14033
14765
 
14034
- **credit_consumption_rate:** `Integer`
14766
+ **credit_consumption_rate:** `Float`
14035
14767
 
14036
14768
  </dd>
14037
14769
  </dl>
@@ -14039,7 +14771,7 @@ client.entitlements.update_plan_entitlement(
14039
14771
  <dl>
14040
14772
  <dd>
14041
14773
 
14042
- **currency:** `String`
14774
+ **currency:** `Schematic::Types::Currency`
14043
14775
 
14044
14776
  </dd>
14045
14777
  </dl>
@@ -14143,6 +14875,14 @@ client.entitlements.update_plan_entitlement(
14143
14875
  <dl>
14144
14876
  <dd>
14145
14877
 
14878
+ **quantity_rates:** `Internal::Types::Hash[String, Float]` — Credits per unit of the quantity (per token for inference features), keyed by quantity key. Inference features may price input_tokens, output_tokens, cached_input_tokens, cache_creation_input_tokens and reasoning_tokens; reasoning_tokens is priced on top of output_tokens, so leave its rate at zero for providers that count reasoning inside output. Omit to leave the schedule as it is; send null to clear it.
14879
+
14880
+ </dd>
14881
+ </dl>
14882
+
14883
+ <dl>
14884
+ <dd>
14885
+
14146
14886
  **quarterly_metered_price_id:** `String`
14147
14887
 
14148
14888
  </dd>
@@ -14397,7 +15137,7 @@ client.entitlements.upsert_plan_entitlement_for_billing_product(
14397
15137
  <dl>
14398
15138
  <dd>
14399
15139
 
14400
- **credit_consumption_rate:** `Integer`
15140
+ **credit_consumption_rate:** `Float`
14401
15141
 
14402
15142
  </dd>
14403
15143
  </dl>
@@ -14405,7 +15145,7 @@ client.entitlements.upsert_plan_entitlement_for_billing_product(
14405
15145
  <dl>
14406
15146
  <dd>
14407
15147
 
14408
- **currency:** `String`
15148
+ **currency:** `Schematic::Types::Currency`
14409
15149
 
14410
15150
  </dd>
14411
15151
  </dl>
@@ -14541,6 +15281,14 @@ client.entitlements.upsert_plan_entitlement_for_billing_product(
14541
15281
  <dl>
14542
15282
  <dd>
14543
15283
 
15284
+ **quantity_rates:** `Internal::Types::Hash[String, Float]` — Credits per unit of the quantity (per token for inference features), keyed by quantity key. Inference features may price input_tokens, output_tokens, cached_input_tokens, cache_creation_input_tokens and reasoning_tokens; reasoning_tokens is priced on top of output_tokens, so leave its rate at zero for providers that count reasoning inside output. Omit to leave the schedule as it is; send null to clear it.
15285
+
15286
+ </dd>
15287
+ </dl>
15288
+
15289
+ <dl>
15290
+ <dd>
15291
+
14544
15292
  **quarterly_metered_price_id:** `String`
14545
15293
 
14546
15294
  </dd>
@@ -15452,7 +16200,9 @@ client.plans.update_company_plans(
15452
16200
  client.plans.list_custom_plan_billings(
15453
16201
  company_id: "company_id",
15454
16202
  plan_id: "plan_id",
15455
- plan_billing_source: "custom_plan",
16203
+ plan_version_id: "plan_version_id",
16204
+ plan_billing_source: "amendment",
16205
+ plan_billing_sources: ["amendment"],
15456
16206
  status: "active",
15457
16207
  statuses: ["active"],
15458
16208
  limit: 1000000,
@@ -15488,7 +16238,23 @@ client.plans.list_custom_plan_billings(
15488
16238
  <dl>
15489
16239
  <dd>
15490
16240
 
15491
- **plan_billing_source:** `Schematic::Types::PlanBillingSource` — Filter by the flow that created the billing record. Defaults to custom_plan.
16241
+ **plan_version_id:** `String` — Filter by the plan version the billing record was created for
16242
+
16243
+ </dd>
16244
+ </dl>
16245
+
16246
+ <dl>
16247
+ <dd>
16248
+
16249
+ **plan_billing_source:** `Schematic::Types::PlanBillingSource` — Filter by the flow that created the billing record: custom_plan for a first publish, amendment for a republish, manage_plan for a standard plan assigned by invoice. Defaults to custom_plan unless plan_billing_sources is set.
16250
+
16251
+ </dd>
16252
+ </dl>
16253
+
16254
+ <dl>
16255
+ <dd>
16256
+
16257
+ **plan_billing_sources:** `Schematic::Types::PlanBillingSource` — Filter by multiple billing sources. Takes precedence over plan_billing_source.
15492
16258
 
15493
16259
  </dd>
15494
16260
  </dl>
@@ -16891,7 +17657,7 @@ client.plans.delete_plan_version(
16891
17657
  </dl>
16892
17658
  </details>
16893
17659
 
16894
- <details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">publish_plan_version</a>(plan_version_id:, request) -> Schematic::Plans::Types::PublishPlanVersionResponse</code></summary>
17660
+ <details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">get_plan_version_diff</a>(plan_version_id:) -> Schematic::Plans::Types::GetPlanVersionDiffResponse</code></summary>
16895
17661
  <dl>
16896
17662
  <dd>
16897
17663
 
@@ -16904,10 +17670,9 @@ client.plans.delete_plan_version(
16904
17670
  <dd>
16905
17671
 
16906
17672
  ```ruby
16907
- client.plans.publish_plan_version(
17673
+ client.plans.get_plan_version_diff(
16908
17674
  plan_version_id: "plan_version_id",
16909
- excluded_company_ids: ["excluded_company_ids"],
16910
- migration_strategy: "end_of_billing_period"
17675
+ against: "against"
16911
17676
  )
16912
17677
  ```
16913
17678
  </dd>
@@ -16931,7 +17696,7 @@ client.plans.publish_plan_version(
16931
17696
  <dl>
16932
17697
  <dd>
16933
17698
 
16934
- **activation_strategy:** `Schematic::Types::CustomPlanActivationStrategy`
17699
+ **against:** `String` — The version to compare against. Defaults to the plan's published version.
16935
17700
 
16936
17701
  </dd>
16937
17702
  </dl>
@@ -16939,55 +17704,51 @@ client.plans.publish_plan_version(
16939
17704
  <dl>
16940
17705
  <dd>
16941
17706
 
16942
- **address:** `Schematic::Types::CustomerBillingAddress`
17707
+ **request_options:** `Schematic::Plans::RequestOptions`
16943
17708
 
16944
17709
  </dd>
16945
17710
  </dl>
17711
+ </dd>
17712
+ </dl>
16946
17713
 
16947
- <dl>
16948
- <dd>
16949
17714
 
16950
- **billing_cycle_anchor:** `String` — The date the subscription's billing period renews on. Only honored on a first publish that starts a subscription.
16951
-
16952
17715
  </dd>
16953
17716
  </dl>
17717
+ </details>
16954
17718
 
17719
+ <details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">publish_plan_version</a>(plan_version_id:, request) -> Schematic::Plans::Types::PublishPlanVersionResponse</code></summary>
16955
17720
  <dl>
16956
17721
  <dd>
16957
17722
 
16958
- **billing_start_date:** `String` — The date the contract term starts. A past date backdates the subscription so the first invoice covers the term from this date to the renewal date. Requires billing_cycle_anchor. Only honored on a first publish that starts a subscription.
16959
-
16960
- </dd>
16961
- </dl>
17723
+ #### 🔌 Usage
16962
17724
 
16963
17725
  <dl>
16964
17726
  <dd>
16965
17727
 
16966
- **coupon_external_id:** `String`
16967
-
16968
- </dd>
16969
- </dl>
16970
-
16971
17728
  <dl>
16972
17729
  <dd>
16973
17730
 
16974
- **custom_field_values:** `Internal::Types::Array[Schematic::Types::CheckoutFieldValue]`
16975
-
17731
+ ```ruby
17732
+ client.plans.publish_plan_version(
17733
+ plan_version_id: "plan_version_id",
17734
+ excluded_company_ids: ["excluded_company_ids"],
17735
+ migration_strategy: "end_of_billing_period"
17736
+ )
17737
+ ```
17738
+ </dd>
17739
+ </dl>
16976
17740
  </dd>
16977
17741
  </dl>
16978
17742
 
17743
+ #### ⚙️ Parameters
17744
+
16979
17745
  <dl>
16980
17746
  <dd>
16981
17747
 
16982
- **customer_email:** `String`
16983
-
16984
- </dd>
16985
- </dl>
16986
-
16987
17748
  <dl>
16988
17749
  <dd>
16989
17750
 
16990
- **days_until_due:** `Integer`
17751
+ **plan_version_id:** `String` — plan_version_id
16991
17752
 
16992
17753
  </dd>
16993
17754
  </dl>
@@ -16995,7 +17756,7 @@ client.plans.publish_plan_version(
16995
17756
  <dl>
16996
17757
  <dd>
16997
17758
 
16998
- **excluded_company_ids:** `Internal::Types::Array[String]`
17759
+ **request:** `Schematic::Types::PublishPlanVersionRequestBody`
16999
17760
 
17000
17761
  </dd>
17001
17762
  </dl>
@@ -17003,55 +17764,51 @@ client.plans.publish_plan_version(
17003
17764
  <dl>
17004
17765
  <dd>
17005
17766
 
17006
- **migration_strategy:** `Schematic::Types::PlanVersionMigrationStrategy`
17767
+ **request_options:** `Schematic::Plans::RequestOptions`
17007
17768
 
17008
17769
  </dd>
17009
17770
  </dl>
17771
+ </dd>
17772
+ </dl>
17010
17773
 
17011
- <dl>
17012
- <dd>
17013
17774
 
17014
- **phone:** `String`
17015
-
17016
17775
  </dd>
17017
17776
  </dl>
17777
+ </details>
17018
17778
 
17779
+ <details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">preview_publish_plan_version</a>(plan_version_id:, request) -> Schematic::Plans::Types::PreviewPublishPlanVersionResponse</code></summary>
17019
17780
  <dl>
17020
17781
  <dd>
17021
17782
 
17022
- **prorate_first_period:** `Internal::Types::Boolean` — When true, the partial period between the subscription starting and its renewal date is billed pro rata straight away. When false that period is free and no invoice is raised until the renewal date. Only applies alongside billing_cycle_anchor. Defaults to true.
17023
-
17024
- </dd>
17025
- </dl>
17783
+ #### 🔌 Usage
17026
17784
 
17027
17785
  <dl>
17028
17786
  <dd>
17029
17787
 
17030
- **proration_behavior:** `Schematic::Types::MigrationProrationBehavior` — How Stripe handles the price difference when companies are migrated. With migration_strategy immediate, omitted means create_prorations. With end_of_billing_period only none is accepted and means the same as omitting it: the change lands on the renewal boundary, so there is nothing to prorate. With scheduled any value is accepted and omitted means none. Not accepted with leave.
17031
-
17032
- </dd>
17033
- </dl>
17034
-
17035
17788
  <dl>
17036
17789
  <dd>
17037
17790
 
17038
- **require_no_migration:** `Internal::Types::Boolean` — Refuse the publish if any company would be migrated onto the new version
17039
-
17791
+ ```ruby
17792
+ client.plans.preview_publish_plan_version(
17793
+ plan_version_id: "plan_version_id",
17794
+ excluded_company_ids: ["excluded_company_ids"],
17795
+ migration_strategy: "end_of_billing_period"
17796
+ )
17797
+ ```
17798
+ </dd>
17799
+ </dl>
17040
17800
  </dd>
17041
17801
  </dl>
17042
17802
 
17803
+ #### ⚙️ Parameters
17804
+
17043
17805
  <dl>
17044
17806
  <dd>
17045
17807
 
17046
- **scheduled_at:** `String` — When every company moves, for migration_strategy scheduled. Must be in the future; the migration runs within about a minute of this time. Not accepted with other strategies.
17047
-
17048
- </dd>
17049
- </dl>
17050
-
17051
17808
  <dl>
17052
17809
  <dd>
17053
17810
 
17054
- **send_invoice:** `Internal::Types::Boolean` — Whether Stripe emails the invoice when it is finalized. Defaults to true.
17811
+ **plan_version_id:** `String` — plan_version_id
17055
17812
 
17056
17813
  </dd>
17057
17814
  </dl>
@@ -17059,7 +17816,7 @@ client.plans.publish_plan_version(
17059
17816
  <dl>
17060
17817
  <dd>
17061
17818
 
17062
- **tax_id:** `Schematic::Types::TaxIdInput`
17819
+ **request:** `Schematic::Types::PublishPlanVersionRequestBody`
17063
17820
 
17064
17821
  </dd>
17065
17822
  </dl>
@@ -17179,7 +17936,7 @@ client.components.create_component(
17179
17936
  <dl>
17180
17937
  <dd>
17181
17938
 
17182
- **ast:** `Internal::Types::Hash[String, Integer]`
17939
+ **ast:** `Internal::Types::Hash[String, Float]`
17183
17940
 
17184
17941
  </dd>
17185
17942
  </dl>
@@ -17299,7 +18056,7 @@ client.components.update_component(component_id: "component_id")
17299
18056
  <dl>
17300
18057
  <dd>
17301
18058
 
17302
- **ast:** `Internal::Types::Hash[String, Integer]`
18059
+ **ast:** `Internal::Types::Hash[String, Float]`
17303
18060
 
17304
18061
  </dd>
17305
18062
  </dl>
@@ -18701,7 +19458,7 @@ client.features.list_features(
18701
19458
  <dl>
18702
19459
  <dd>
18703
19460
 
18704
- **without_company_override_for:** `String` — Filter out features that already have a company override for the specified company ID
19461
+ **without_company_override_for:** `String` — Filter out features that have an unexpired company override for the specified company ID
18705
19462
 
18706
19463
  </dd>
18707
19464
  </dl>
@@ -18785,6 +19542,14 @@ client.features.create_feature(
18785
19542
  <dl>
18786
19543
  <dd>
18787
19544
 
19545
+ **event_source:** `Schematic::Types::FeatureEventSource` — Which event stream meters this feature; defaults to track, and cannot change after creation. Inference is only valid on event features: their event_subtype matches the event label on inference events, and they meter through credits only.
19546
+
19547
+ </dd>
19548
+ </dl>
19549
+
19550
+ <dl>
19551
+ <dd>
19552
+
18788
19553
  **event_subtype:** `String`
18789
19554
 
18790
19555
  </dd>
@@ -18969,6 +19734,14 @@ client.features.update_feature(feature_id: "feature_id")
18969
19734
  <dl>
18970
19735
  <dd>
18971
19736
 
19737
+ **event_source:** `Schematic::Types::FeatureEventSource` — Which event stream meters this feature. It is fixed at creation: an update that changes it is rejected.
19738
+
19739
+ </dd>
19740
+ </dl>
19741
+
19742
+ <dl>
19743
+ <dd>
19744
+
18972
19745
  **event_subtype:** `String`
18973
19746
 
18974
19747
  </dd>
@@ -19159,6 +19932,14 @@ client.features.upsert_feature_for_billing_product(
19159
19932
  <dl>
19160
19933
  <dd>
19161
19934
 
19935
+ **event_source:** `Schematic::Types::FeatureEventSource` — Which event stream meters this feature; defaults to track, and cannot change after creation. Inference is only valid on event features: their event_subtype matches the event label on inference events, and they meter through credits only.
19936
+
19937
+ </dd>
19938
+ </dl>
19939
+
19940
+ <dl>
19941
+ <dd>
19942
+
19162
19943
  **event_subtype:** `String`
19163
19944
 
19164
19945
  </dd>
@@ -19346,7 +20127,7 @@ client.features.count_features(
19346
20127
  <dl>
19347
20128
  <dd>
19348
20129
 
19349
- **without_company_override_for:** `String` — Filter out features that already have a company override for the specified company ID
20130
+ **without_company_override_for:** `String` — Filter out features that have an unexpired company override for the specified company ID
19350
20131
 
19351
20132
  </dd>
19352
20133
  </dl>
@@ -19490,7 +20271,6 @@ client.features.list_flags(
19490
20271
 
19491
20272
  ```ruby
19492
20273
  client.features.create_flag(
19493
- default_value: true,
19494
20274
  description: "description",
19495
20275
  flag_type: "boolean",
19496
20276
  key: "key",
@@ -19593,7 +20373,6 @@ client.features.get_flag(flag_id: "flag_id")
19593
20373
  ```ruby
19594
20374
  client.features.update_flag(
19595
20375
  flag_id: "flag_id",
19596
- default_value: true,
19597
20376
  description: "description",
19598
20377
  flag_type: "boolean",
19599
20378
  key: "key",
@@ -19864,7 +20643,7 @@ client.features.check_and_reserve_flag(key: "key")
19864
20643
  <dl>
19865
20644
  <dd>
19866
20645
 
19867
- **expires_at:** `String` — When the hold lapses if no track event settles it; defaults to one minute from now and may be at most one hour out. The unspent hold is refunded on expiry
20646
+ **expires_at:** `String` — When the hold lapses if no track or inference event settles it; defaults to one minute from now and may be at most one hour out. The unspent hold is refunded on expiry
19868
20647
 
19869
20648
  </dd>
19870
20649
  </dl>
@@ -19880,7 +20659,7 @@ client.features.check_and_reserve_flag(key: "key")
19880
20659
  <dl>
19881
20660
  <dd>
19882
20661
 
19883
- **preflight:** `Schematic::Types::PreflightRequestBody` — Hypothetical usage to evaluate the flag against. When credit_cost names the entitlement's credit, that cost is what gets held; otherwise the hold is the entitlement's consumption rate times quantity, or, when quantity is omitted, times the usage stated here
20662
+ **preflight:** `Schematic::Types::PreflightRequestBody` — Hypothetical usage to evaluate the flag against. When credit_cost names the entitlement's credit, that cost is what gets held; otherwise, when event_quantities names the entitlement's event subtype, the hold is that event priced at the entitlement's consumption rate and quantity rates, and quantity is ignored; otherwise the hold is the entitlement's consumption rate times quantity, or, when quantity is omitted, times the usage stated here
19884
20663
 
19885
20664
  </dd>
19886
20665
  </dl>
@@ -19888,7 +20667,7 @@ client.features.check_and_reserve_flag(key: "key")
19888
20667
  <dl>
19889
20668
  <dd>
19890
20669
 
19891
- **quantity:** `Integer` — Units of the feature the operation will consume. Sets the hold size together with the entitlement's consumption rate, and is echoed back on the reservation for the settling track event. When it is omitted the units come from preflight.event_usage.quantity, if that event subtype is the entitlement's, else from preflight.usage, else 1
20670
+ **quantity:** `Float` — Units of the feature the operation will consume. Sets the hold size together with the entitlement's consumption rate, and is echoed back on the reservation for the settling track event. When it is omitted the units come from preflight.event_usage.quantity, if that event subtype is the entitlement's, else from preflight.usage, else 1. Ignored when preflight.event_quantities names the entitlement's event subtype, whose quantity is used instead
19892
20671
 
19893
20672
  </dd>
19894
20673
  </dl>