schematichq 1.5.3 → 1.5.4

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 (220) hide show
  1. checksums.yaml +4 -4
  2. data/.fern/metadata.json +4 -4
  3. data/.fern/replay.lock +7 -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 +325 -34
  11. data/lib/schematic/billing/types/create_billing_price_request_body.rb +1 -1
  12. data/lib/schematic/billing/types/create_billing_product_request_body.rb +1 -1
  13. data/lib/schematic/billing/types/create_billing_subscription_request_body.rb +1 -1
  14. data/lib/schematic/billing/types/create_coupon_request_body.rb +2 -2
  15. data/lib/schematic/billing/types/create_invoice_request_body.rb +1 -1
  16. data/lib/schematic/billing/types/get_billing_settings_response.rb +13 -0
  17. data/lib/schematic/billing/types/list_billing_prices_params.rb +1 -1
  18. data/lib/schematic/billing/types/list_billing_prices_request.rb +1 -1
  19. data/lib/schematic/billing/types/list_billing_product_prices_params.rb +1 -1
  20. data/lib/schematic/billing/types/list_billing_product_prices_request.rb +1 -1
  21. data/lib/schematic/billing/types/update_billing_settings_request_body.rb +11 -0
  22. data/lib/schematic/billing/types/update_billing_settings_response.rb +13 -0
  23. data/lib/schematic/catalogs/client.rb +121 -14
  24. data/lib/schematic/checkout/client.rb +80 -9
  25. data/lib/schematic/checkout/types/checkout_data_request_body.rb +1 -1
  26. data/lib/schematic/client.rb +5 -3
  27. data/lib/schematic/companies/client.rb +380 -44
  28. data/lib/schematic/components/client.rb +70 -8
  29. data/lib/schematic/components/types/create_component_request_body.rb +1 -1
  30. data/lib/schematic/components/types/update_component_request_body.rb +1 -1
  31. data/lib/schematic/componentspublic/client.rb +8 -1
  32. data/lib/schematic/credits/client.rb +409 -41
  33. data/lib/schematic/credits/types/acquire_credit_lease_request_body.rb +1 -1
  34. data/lib/schematic/credits/types/create_billing_credit_request_body.rb +1 -1
  35. data/lib/schematic/credits/types/create_company_credit_grant.rb +1 -1
  36. data/lib/schematic/credits/types/create_credit_bundle_request_body.rb +1 -1
  37. data/lib/schematic/credits/types/create_credit_spend_policy_request_body.rb +2 -2
  38. data/lib/schematic/credits/types/extend_credit_lease_request_body.rb +1 -1
  39. data/lib/schematic/credits/types/get_credit_balance_time_series_params.rb +18 -0
  40. data/lib/schematic/credits/types/get_credit_balance_time_series_request.rb +17 -0
  41. data/lib/schematic/credits/types/get_credit_balance_time_series_response.rb +13 -0
  42. data/lib/schematic/credits/types/reserve_credits_request_body.rb +1 -1
  43. data/lib/schematic/credits/types/update_credit_spend_policy_request_body.rb +2 -2
  44. data/lib/schematic/dataexports/client.rb +36 -6
  45. data/lib/schematic/entitlements/client.rb +244 -28
  46. data/lib/schematic/entitlements/types/create_billing_linked_plan_entitlement_request_body.rb +4 -2
  47. data/lib/schematic/entitlements/types/create_company_override_request_body.rb +3 -1
  48. data/lib/schematic/entitlements/types/create_plan_entitlement_request_body.rb +4 -2
  49. data/lib/schematic/entitlements/types/update_company_override_request_body.rb +3 -1
  50. data/lib/schematic/entitlements/types/update_plan_entitlement_request_body.rb +4 -2
  51. data/lib/schematic/errors/connection_error.rb +11 -0
  52. data/lib/schematic/errors/response_error.rb +23 -2
  53. data/lib/schematic/events/client.rb +78 -9
  54. data/lib/schematic/features/client.rb +160 -18
  55. data/lib/schematic/features/types/check_and_reserve_flag_request_body.rb +1 -1
  56. data/lib/schematic/features/types/create_billing_linked_feature_request_body.rb +2 -0
  57. data/lib/schematic/features/types/create_feature_request_body.rb +2 -0
  58. data/lib/schematic/features/types/update_feature_request_body.rb +2 -0
  59. data/lib/schematic/insights/client.rb +48 -6
  60. data/lib/schematic/integrationsapi/client.rb +120 -14
  61. data/lib/schematic/internal/http/base_request.rb +30 -0
  62. data/lib/schematic/internal/http/raw_client.rb +35 -5
  63. data/lib/schematic/internal/iterators/cursor_item_iterator.rb +7 -2
  64. data/lib/schematic/internal/iterators/cursor_page_iterator.rb +68 -14
  65. data/lib/schematic/internal/iterators/item_iterator.rb +61 -15
  66. data/lib/schematic/internal/iterators/offset_item_iterator.rb +7 -2
  67. data/lib/schematic/internal/iterators/offset_page_iterator.rb +57 -9
  68. data/lib/schematic/internal/json/request.rb +11 -2
  69. data/lib/schematic/internal/multipart/multipart_request.rb +1 -0
  70. data/lib/schematic/internal/types/model.rb +7 -3
  71. data/lib/schematic/internal/types/utils.rb +7 -0
  72. data/lib/schematic/licenses/client.rb +26 -3
  73. data/lib/schematic/planbundle/client.rb +27 -3
  74. data/lib/schematic/plangroups/client.rb +26 -3
  75. data/lib/schematic/planmigrations/client.rb +98 -11
  76. data/lib/schematic/plans/client.rb +213 -23
  77. data/lib/schematic/plans/types/get_plan_version_diff_params.rb +12 -0
  78. data/lib/schematic/plans/types/get_plan_version_diff_request.rb +13 -0
  79. data/lib/schematic/plans/types/get_plan_version_diff_response.rb +13 -0
  80. data/lib/schematic/plans/types/publish_plan_version_request_body.rb +2 -0
  81. data/lib/schematic/rules_engine.rb +14 -2
  82. data/lib/schematic/scheduledcheckout/client.rb +35 -4
  83. data/lib/schematic/schematic_client.rb +22 -11
  84. data/lib/schematic/types/billing_coupon_response_data.rb +2 -2
  85. data/lib/schematic/types/billing_credit_grant_response_data.rb +8 -8
  86. data/lib/schematic/types/billing_customer_subscription.rb +1 -1
  87. data/lib/schematic/types/billing_plan_credit_grant_response_data.rb +1 -1
  88. data/lib/schematic/types/billing_price_response_data.rb +1 -1
  89. data/lib/schematic/types/billing_price_view.rb +1 -1
  90. data/lib/schematic/types/billing_product_detail_response_data.rb +2 -2
  91. data/lib/schematic/types/billing_product_for_subscription_response_data.rb +2 -2
  92. data/lib/schematic/types/billing_product_price_response_data.rb +1 -1
  93. data/lib/schematic/types/billing_product_pricing.rb +1 -1
  94. data/lib/schematic/types/billing_product_response_data.rb +2 -2
  95. data/lib/schematic/types/billing_settings_response_data.rb +9 -0
  96. data/lib/schematic/types/billing_subscription_discount_view.rb +2 -2
  97. data/lib/schematic/types/billing_subscription_response_data.rb +1 -1
  98. data/lib/schematic/types/billing_subscription_view.rb +1 -1
  99. data/lib/schematic/types/catalog_config_ordered_plan.rb +2 -0
  100. data/lib/schematic/types/catalog_config_ordered_plan_response_data.rb +2 -0
  101. data/lib/schematic/types/catalog_config_plan_credit.rb +11 -0
  102. data/lib/schematic/types/catalog_config_plan_credit_response_data.rb +11 -0
  103. data/lib/schematic/types/change_subscription_internal_request_body.rb +1 -1
  104. data/lib/schematic/types/change_subscription_request_body.rb +1 -1
  105. data/lib/schematic/types/checkout_problem_code.rb +54 -0
  106. data/lib/schematic/types/checkout_problem_response_data.rb +31 -0
  107. data/lib/schematic/types/checkout_problem_source.rb +13 -0
  108. data/lib/schematic/types/checkout_subscription.rb +1 -1
  109. data/lib/schematic/types/company_billing_entity_subscription_response_data.rb +1 -1
  110. data/lib/schematic/types/company_credit_balance.rb +3 -3
  111. data/lib/schematic/types/company_credit_balance_response_data.rb +4 -4
  112. data/lib/schematic/types/company_detail_response_data.rb +1 -1
  113. data/lib/schematic/types/company_override_response_data.rb +3 -1
  114. data/lib/schematic/types/company_plan_credit_grant_view.rb +1 -1
  115. data/lib/schematic/types/company_plan_detail_response_data.rb +2 -0
  116. data/lib/schematic/types/company_subscription_response_data.rb +1 -1
  117. data/lib/schematic/types/company_user_usage_response_data.rb +2 -2
  118. data/lib/schematic/types/company_user_usage_row_response_data.rb +2 -2
  119. data/lib/schematic/types/component_response_data.rb +1 -1
  120. data/lib/schematic/types/condition.rb +3 -1
  121. data/lib/schematic/types/condition_response_data.rb +3 -1
  122. data/lib/schematic/types/condition_view.rb +3 -1
  123. data/lib/schematic/types/coupon_request_body.rb +2 -2
  124. data/lib/schematic/types/create_billing_plan_credit_grant_request_body.rb +1 -1
  125. data/lib/schematic/types/create_entitlement_in_bundle_request_body.rb +4 -2
  126. data/lib/schematic/types/create_entitlement_req_common.rb +3 -1
  127. data/lib/schematic/types/create_or_update_condition_request_body.rb +1 -1
  128. data/lib/schematic/types/credit_balance_event_response_data.rb +21 -0
  129. data/lib/schematic/types/credit_balance_feature_consumption_response_data.rb +13 -0
  130. data/lib/schematic/types/credit_balance_point_response_data.rb +15 -0
  131. data/lib/schematic/types/credit_balance_time_series_response_data.rb +15 -0
  132. data/lib/schematic/types/credit_bundle_currency_price.rb +1 -1
  133. data/lib/schematic/types/credit_bundle_currency_price_request_body.rb +1 -1
  134. data/lib/schematic/types/credit_bundle_currency_price_response_data.rb +1 -1
  135. data/lib/schematic/types/credit_burn_breakdown_line.rb +15 -0
  136. data/lib/schematic/types/credit_company_grant_view.rb +8 -8
  137. data/lib/schematic/types/credit_currency_price.rb +1 -1
  138. data/lib/schematic/types/credit_currency_price_request_body.rb +1 -1
  139. data/lib/schematic/types/credit_currency_price_response_data.rb +1 -1
  140. data/lib/schematic/types/credit_event_ledger_response_data.rb +10 -6
  141. data/lib/schematic/types/credit_grant_detail.rb +1 -1
  142. data/lib/schematic/types/credit_lease_response_data.rb +2 -2
  143. data/lib/schematic/types/credit_reservation_response_data.rb +2 -2
  144. data/lib/schematic/types/credit_spend_policy.rb +2 -2
  145. data/lib/schematic/types/credit_spend_policy_response_data.rb +4 -4
  146. data/lib/schematic/types/credit_transfer_response_data.rb +1 -1
  147. data/lib/schematic/types/credit_transfer_view.rb +1 -1
  148. data/lib/schematic/types/credit_usage.rb +5 -5
  149. data/lib/schematic/types/credit_usage_aggregation.rb +4 -4
  150. data/lib/schematic/types/credit_usage_reason.rb +1 -0
  151. data/lib/schematic/types/credits_in_plan.rb +11 -0
  152. data/lib/schematic/types/currency.rb +144 -0
  153. data/lib/schematic/types/currency_price_request_body.rb +1 -1
  154. data/lib/schematic/types/custom_plan_billing_response_data.rb +6 -0
  155. data/lib/schematic/types/entitlement_currency_prices_response_data.rb +1 -1
  156. data/lib/schematic/types/estimated_plan_total.rb +1 -1
  157. data/lib/schematic/types/feature_company_response_data.rb +7 -7
  158. data/lib/schematic/types/feature_detail_response_data.rb +2 -0
  159. data/lib/schematic/types/feature_entitlement.rb +8 -6
  160. data/lib/schematic/types/feature_event_source.rb +12 -0
  161. data/lib/schematic/types/feature_in_plan_response_data.rb +2 -0
  162. data/lib/schematic/types/feature_response_data.rb +2 -0
  163. data/lib/schematic/types/feature_usage_response_data.rb +7 -7
  164. data/lib/schematic/types/feature_view.rb +2 -0
  165. data/lib/schematic/types/flag_check_reservation_response_data.rb +3 -3
  166. data/lib/schematic/types/insights_summary_response_data.rb +1 -1
  167. data/lib/schematic/types/invoice_request_body.rb +1 -1
  168. data/lib/schematic/types/invoice_response_data.rb +1 -1
  169. data/lib/schematic/types/manage_plan_preview_response_response_data.rb +2 -0
  170. data/lib/schematic/types/manage_plan_request.rb +3 -1
  171. data/lib/schematic/types/manage_plan_response_response_data.rb +4 -0
  172. data/lib/schematic/types/mrr_response_data.rb +1 -1
  173. data/lib/schematic/types/onboarding_milestone_view.rb +1 -1
  174. data/lib/schematic/types/ordered_plans_in_group.rb +2 -0
  175. data/lib/schematic/types/plan_billing_source.rb +1 -0
  176. data/lib/schematic/types/plan_change_action.rb +1 -0
  177. data/lib/schematic/types/plan_change_amendment_status.rb +15 -0
  178. data/lib/schematic/types/plan_change_response_data.rb +4 -0
  179. data/lib/schematic/types/plan_credit_grant_view.rb +1 -1
  180. data/lib/schematic/types/plan_credit_order.rb +11 -0
  181. data/lib/schematic/types/plan_credit_visibility.rb +11 -0
  182. data/lib/schematic/types/plan_currency_price_request_body.rb +1 -1
  183. data/lib/schematic/types/plan_currency_prices_response_data.rb +1 -1
  184. data/lib/schematic/types/plan_entitlement_response_data.rb +3 -1
  185. data/lib/schematic/types/plan_group_plan_entitlements_order.rb +2 -0
  186. data/lib/schematic/types/plan_version_billing_product_change_response_data.rb +11 -0
  187. data/lib/schematic/types/plan_version_credit_grant_change_response_data.rb +17 -0
  188. data/lib/schematic/types/plan_version_diff_change_type.rb +13 -0
  189. data/lib/schematic/types/plan_version_diff_price_cadence.rb +14 -0
  190. data/lib/schematic/types/plan_version_diff_response_data.rb +23 -0
  191. data/lib/schematic/types/plan_version_entitlement_change_response_data.rb +17 -0
  192. data/lib/schematic/types/plan_version_field_change_response_data.rb +13 -0
  193. data/lib/schematic/types/plan_version_price_change_response_data.rb +15 -0
  194. data/lib/schematic/types/plan_view_public_response_data.rb +2 -0
  195. data/lib/schematic/types/preflight_request_body.rb +1 -1
  196. data/lib/schematic/types/preview_subscription_change_response_data.rb +3 -1
  197. data/lib/schematic/types/preview_subscription_discount_response_data.rb +2 -2
  198. data/lib/schematic/types/preview_subscription_finance_response_data.rb +2 -2
  199. data/lib/schematic/types/rulesengine_company.rb +1 -1
  200. data/lib/schematic/types/rulesengine_condition.rb +3 -1
  201. data/lib/schematic/types/rulesengine_credit_postpaid_config.rb +1 -1
  202. data/lib/schematic/types/rulesengine_credit_spend_policy.rb +2 -2
  203. data/lib/schematic/types/rulesengine_feature_entitlement.rb +8 -6
  204. data/lib/schematic/types/scheduled_downgrade_response_data.rb +1 -1
  205. data/lib/schematic/types/top_feature_by_usage_response_data.rb +1 -1
  206. data/lib/schematic/types/upcoming_invoice_response_data.rb +1 -1
  207. data/lib/schematic/types/update_billing_plan_credit_grant_request_body.rb +1 -1
  208. data/lib/schematic/types/update_entitlement_req_common.rb +3 -1
  209. data/lib/schematic/types/upsert_billing_product_request_body.rb +1 -1
  210. data/lib/schematic/types/usage_based_entitlement_request_body.rb +1 -1
  211. data/lib/schematic/types/usage_based_entitlement_response_data.rb +1 -1
  212. data/lib/schematic/types/user_credit_usage_response_data.rb +2 -2
  213. data/lib/schematic/types/user_daily_credit_point_response_data.rb +1 -1
  214. data/lib/schematic/types/user_feature_usage_response_data.rb +1 -1
  215. data/lib/schematic/version.rb +1 -1
  216. data/lib/schematic/wasm/rulesengine.wasm +0 -0
  217. data/lib/schematic/webhooks/client.rb +88 -10
  218. data/lib/schematic.rb +38 -3
  219. data/reference.md +340 -44
  220. metadata +37 -2
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>
@@ -4342,7 +4430,7 @@ client.credits.list_billing_credits(
4342
4430
 
4343
4431
  ```ruby
4344
4432
  client.credits.create_billing_credit(
4345
- currency: "currency",
4433
+ currency: "aed",
4346
4434
  description: "description",
4347
4435
  name: "name"
4348
4436
  )
@@ -4368,7 +4456,7 @@ client.credits.create_billing_credit(
4368
4456
  <dl>
4369
4457
  <dd>
4370
4458
 
4371
- **currency:** `String`
4459
+ **currency:** `Schematic::Types::Currency`
4372
4460
 
4373
4461
  </dd>
4374
4462
  </dl>
@@ -4764,6 +4852,83 @@ client.credits.list_company_credit_balances(company_id: "company_id")
4764
4852
  </dl>
4765
4853
 
4766
4854
 
4855
+ </dd>
4856
+ </dl>
4857
+ </details>
4858
+
4859
+ <details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">get_credit_balance_time_series</a>() -> Schematic::Credits::Types::GetCreditBalanceTimeSeriesResponse</code></summary>
4860
+ <dl>
4861
+ <dd>
4862
+
4863
+ #### 🔌 Usage
4864
+
4865
+ <dl>
4866
+ <dd>
4867
+
4868
+ <dl>
4869
+ <dd>
4870
+
4871
+ ```ruby
4872
+ client.credits.get_credit_balance_time_series(
4873
+ billing_credit_id: "billing_credit_id",
4874
+ company_id: "company_id",
4875
+ end_time: "2024-01-15T09:30:00Z",
4876
+ start_time: "2024-01-15T09:30:00Z"
4877
+ )
4878
+ ```
4879
+ </dd>
4880
+ </dl>
4881
+ </dd>
4882
+ </dl>
4883
+
4884
+ #### ⚙️ Parameters
4885
+
4886
+ <dl>
4887
+ <dd>
4888
+
4889
+ <dl>
4890
+ <dd>
4891
+
4892
+ **billing_credit_id:** `String`
4893
+
4894
+ </dd>
4895
+ </dl>
4896
+
4897
+ <dl>
4898
+ <dd>
4899
+
4900
+ **company_id:** `String`
4901
+
4902
+ </dd>
4903
+ </dl>
4904
+
4905
+ <dl>
4906
+ <dd>
4907
+
4908
+ **end_time:** `String`
4909
+
4910
+ </dd>
4911
+ </dl>
4912
+
4913
+ <dl>
4914
+ <dd>
4915
+
4916
+ **start_time:** `String`
4917
+
4918
+ </dd>
4919
+ </dl>
4920
+
4921
+ <dl>
4922
+ <dd>
4923
+
4924
+ **request_options:** `Schematic::Credits::RequestOptions`
4925
+
4926
+ </dd>
4927
+ </dl>
4928
+ </dd>
4929
+ </dl>
4930
+
4931
+
4767
4932
  </dd>
4768
4933
  </dl>
4769
4934
  </details>
@@ -4879,7 +5044,7 @@ client.credits.list_credit_bundles(
4879
5044
  client.credits.create_credit_bundle(
4880
5045
  bundle_name: "bundle_name",
4881
5046
  credit_id: "credit_id",
4882
- currency: "currency",
5047
+ currency: "aed",
4883
5048
  price_per_unit: 1000000
4884
5049
  )
4885
5050
  ```
@@ -4928,7 +5093,7 @@ client.credits.create_credit_bundle(
4928
5093
  <dl>
4929
5094
  <dd>
4930
5095
 
4931
- **currency:** `String`
5096
+ **currency:** `Schematic::Types::Currency`
4932
5097
 
4933
5098
  </dd>
4934
5099
  </dl>
@@ -5533,7 +5698,7 @@ client.credits.grant_billing_credits_to_company(
5533
5698
  <dl>
5534
5699
  <dd>
5535
5700
 
5536
- **currency:** `String`
5701
+ **currency:** `Schematic::Types::Currency`
5537
5702
 
5538
5703
  </dd>
5539
5704
  </dl>
@@ -5999,7 +6164,7 @@ client.credits.acquire_credit_lease(
5999
6164
  <dl>
6000
6165
  <dd>
6001
6166
 
6002
- **requested_amount:** `Integer`
6167
+ **requested_amount:** `Float`
6003
6168
 
6004
6169
  </dd>
6005
6170
  </dl>
@@ -6066,7 +6231,7 @@ client.credits.extend_credit_lease(
6066
6231
  <dl>
6067
6232
  <dd>
6068
6233
 
6069
- **additional_amount:** `Integer`
6234
+ **additional_amount:** `Float`
6070
6235
 
6071
6236
  </dd>
6072
6237
  </dl>
@@ -6637,7 +6802,7 @@ client.credits.reserve_credits(
6637
6802
  <dl>
6638
6803
  <dd>
6639
6804
 
6640
- **amount:** `Integer` — Credits to hold for the operation. The full amount must be available; a partial hold is never taken
6805
+ **amount:** `Float` — Credits to hold for the operation. The full amount must be available; a partial hold is never taken
6641
6806
 
6642
6807
  </dd>
6643
6808
  </dl>
@@ -6893,7 +7058,7 @@ client.credits.create_credit_spend_policy(billing_credit_id: "billing_credit_id"
6893
7058
  <dl>
6894
7059
  <dd>
6895
7060
 
6896
- **max_per_draw:** `Integer` — The largest number of credits a single draw may spend. Set either this or window_amount.
7061
+ **max_per_draw:** `Float` — The largest number of credits a single draw may spend. Set either this or window_amount.
6897
7062
 
6898
7063
  </dd>
6899
7064
  </dl>
@@ -6909,7 +7074,7 @@ client.credits.create_credit_spend_policy(billing_credit_id: "billing_credit_id"
6909
7074
  <dl>
6910
7075
  <dd>
6911
7076
 
6912
- **window_amount:** `Integer` — The number of credits the company or user may spend in one window. Set either this or max_per_draw.
7077
+ **window_amount:** `Float` — The number of credits the company or user may spend in one window. Set either this or max_per_draw.
6913
7078
 
6914
7079
  </dd>
6915
7080
  </dl>
@@ -7029,7 +7194,7 @@ client.credits.update_credit_spend_policy(spend_policy_id: "spend_policy_id")
7029
7194
  <dl>
7030
7195
  <dd>
7031
7196
 
7032
- **max_per_draw:** `Integer`
7197
+ **max_per_draw:** `Float`
7033
7198
 
7034
7199
  </dd>
7035
7200
  </dl>
@@ -7037,7 +7202,7 @@ client.credits.update_credit_spend_policy(spend_policy_id: "spend_policy_id")
7037
7202
  <dl>
7038
7203
  <dd>
7039
7204
 
7040
- **window_amount:** `Integer`
7205
+ **window_amount:** `Float`
7041
7206
 
7042
7207
  </dd>
7043
7208
  </dl>
@@ -8470,7 +8635,7 @@ client.checkout.get_checkout_data(company_id: "company_id")
8470
8635
  <dl>
8471
8636
  <dd>
8472
8637
 
8473
- **currency:** `String`
8638
+ **currency:** `Schematic::Types::Currency`
8474
8639
 
8475
8640
  </dd>
8476
8641
  </dl>
@@ -11127,7 +11292,7 @@ client.companies.count_entity_traits(
11127
11292
 
11128
11293
  ```ruby
11129
11294
  client.companies.list_plan_changes(
11130
- action: "checkout",
11295
+ action: "amendment",
11131
11296
  base_plan_action: "fallback",
11132
11297
  company_id: "company_id",
11133
11298
  company_ids: ["company_ids"],
@@ -12267,7 +12432,7 @@ client.entitlements.create_company_override(
12267
12432
  <dl>
12268
12433
  <dd>
12269
12434
 
12270
- **credit_consumption_rate:** `Integer`
12435
+ **credit_consumption_rate:** `Float`
12271
12436
 
12272
12437
  </dd>
12273
12438
  </dl>
@@ -12315,6 +12480,14 @@ client.entitlements.create_company_override(
12315
12480
  <dl>
12316
12481
  <dd>
12317
12482
 
12483
+ **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.
12484
+
12485
+ </dd>
12486
+ </dl>
12487
+
12488
+ <dl>
12489
+ <dd>
12490
+
12318
12491
  **value_bool:** `Internal::Types::Boolean`
12319
12492
 
12320
12493
  </dd>
@@ -12454,7 +12627,7 @@ client.entitlements.update_company_override(
12454
12627
  <dl>
12455
12628
  <dd>
12456
12629
 
12457
- **credit_consumption_rate:** `Integer`
12630
+ **credit_consumption_rate:** `Float`
12458
12631
 
12459
12632
  </dd>
12460
12633
  </dl>
@@ -12494,6 +12667,14 @@ client.entitlements.update_company_override(
12494
12667
  <dl>
12495
12668
  <dd>
12496
12669
 
12670
+ **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.
12671
+
12672
+ </dd>
12673
+ </dl>
12674
+
12675
+ <dl>
12676
+ <dd>
12677
+
12497
12678
  **value_bool:** `Internal::Types::Boolean`
12498
12679
 
12499
12680
  </dd>
@@ -13644,7 +13825,7 @@ client.entitlements.create_plan_entitlement(
13644
13825
  <dl>
13645
13826
  <dd>
13646
13827
 
13647
- **credit_consumption_rate:** `Integer`
13828
+ **credit_consumption_rate:** `Float`
13648
13829
 
13649
13830
  </dd>
13650
13831
  </dl>
@@ -13652,7 +13833,7 @@ client.entitlements.create_plan_entitlement(
13652
13833
  <dl>
13653
13834
  <dd>
13654
13835
 
13655
- **currency:** `String`
13836
+ **currency:** `Schematic::Types::Currency`
13656
13837
 
13657
13838
  </dd>
13658
13839
  </dl>
@@ -13780,6 +13961,14 @@ client.entitlements.create_plan_entitlement(
13780
13961
  <dl>
13781
13962
  <dd>
13782
13963
 
13964
+ **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.
13965
+
13966
+ </dd>
13967
+ </dl>
13968
+
13969
+ <dl>
13970
+ <dd>
13971
+
13783
13972
  **quarterly_metered_price_id:** `String`
13784
13973
 
13785
13974
  </dd>
@@ -14031,7 +14220,7 @@ client.entitlements.update_plan_entitlement(
14031
14220
  <dl>
14032
14221
  <dd>
14033
14222
 
14034
- **credit_consumption_rate:** `Integer`
14223
+ **credit_consumption_rate:** `Float`
14035
14224
 
14036
14225
  </dd>
14037
14226
  </dl>
@@ -14039,7 +14228,7 @@ client.entitlements.update_plan_entitlement(
14039
14228
  <dl>
14040
14229
  <dd>
14041
14230
 
14042
- **currency:** `String`
14231
+ **currency:** `Schematic::Types::Currency`
14043
14232
 
14044
14233
  </dd>
14045
14234
  </dl>
@@ -14143,6 +14332,14 @@ client.entitlements.update_plan_entitlement(
14143
14332
  <dl>
14144
14333
  <dd>
14145
14334
 
14335
+ **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.
14336
+
14337
+ </dd>
14338
+ </dl>
14339
+
14340
+ <dl>
14341
+ <dd>
14342
+
14146
14343
  **quarterly_metered_price_id:** `String`
14147
14344
 
14148
14345
  </dd>
@@ -14397,7 +14594,7 @@ client.entitlements.upsert_plan_entitlement_for_billing_product(
14397
14594
  <dl>
14398
14595
  <dd>
14399
14596
 
14400
- **credit_consumption_rate:** `Integer`
14597
+ **credit_consumption_rate:** `Float`
14401
14598
 
14402
14599
  </dd>
14403
14600
  </dl>
@@ -14405,7 +14602,7 @@ client.entitlements.upsert_plan_entitlement_for_billing_product(
14405
14602
  <dl>
14406
14603
  <dd>
14407
14604
 
14408
- **currency:** `String`
14605
+ **currency:** `Schematic::Types::Currency`
14409
14606
 
14410
14607
  </dd>
14411
14608
  </dl>
@@ -14541,6 +14738,14 @@ client.entitlements.upsert_plan_entitlement_for_billing_product(
14541
14738
  <dl>
14542
14739
  <dd>
14543
14740
 
14741
+ **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.
14742
+
14743
+ </dd>
14744
+ </dl>
14745
+
14746
+ <dl>
14747
+ <dd>
14748
+
14544
14749
  **quarterly_metered_price_id:** `String`
14545
14750
 
14546
14751
  </dd>
@@ -15452,7 +15657,7 @@ client.plans.update_company_plans(
15452
15657
  client.plans.list_custom_plan_billings(
15453
15658
  company_id: "company_id",
15454
15659
  plan_id: "plan_id",
15455
- plan_billing_source: "custom_plan",
15660
+ plan_billing_source: "amendment",
15456
15661
  status: "active",
15457
15662
  statuses: ["active"],
15458
15663
  limit: 1000000,
@@ -15488,7 +15693,7 @@ client.plans.list_custom_plan_billings(
15488
15693
  <dl>
15489
15694
  <dd>
15490
15695
 
15491
- **plan_billing_source:** `Schematic::Types::PlanBillingSource` — Filter by the flow that created the billing record. Defaults to custom_plan.
15696
+ **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.
15492
15697
 
15493
15698
  </dd>
15494
15699
  </dl>
@@ -16887,6 +17092,65 @@ client.plans.delete_plan_version(
16887
17092
  </dl>
16888
17093
 
16889
17094
 
17095
+ </dd>
17096
+ </dl>
17097
+ </details>
17098
+
17099
+ <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>
17100
+ <dl>
17101
+ <dd>
17102
+
17103
+ #### 🔌 Usage
17104
+
17105
+ <dl>
17106
+ <dd>
17107
+
17108
+ <dl>
17109
+ <dd>
17110
+
17111
+ ```ruby
17112
+ client.plans.get_plan_version_diff(
17113
+ plan_version_id: "plan_version_id",
17114
+ against: "against"
17115
+ )
17116
+ ```
17117
+ </dd>
17118
+ </dl>
17119
+ </dd>
17120
+ </dl>
17121
+
17122
+ #### ⚙️ Parameters
17123
+
17124
+ <dl>
17125
+ <dd>
17126
+
17127
+ <dl>
17128
+ <dd>
17129
+
17130
+ **plan_version_id:** `String` — plan_version_id
17131
+
17132
+ </dd>
17133
+ </dl>
17134
+
17135
+ <dl>
17136
+ <dd>
17137
+
17138
+ **against:** `String` — The version to compare against. Defaults to the plan's published version.
17139
+
17140
+ </dd>
17141
+ </dl>
17142
+
17143
+ <dl>
17144
+ <dd>
17145
+
17146
+ **request_options:** `Schematic::Plans::RequestOptions`
17147
+
17148
+ </dd>
17149
+ </dl>
17150
+ </dd>
17151
+ </dl>
17152
+
17153
+
16890
17154
  </dd>
16891
17155
  </dl>
16892
17156
  </details>
@@ -16931,7 +17195,7 @@ client.plans.publish_plan_version(
16931
17195
  <dl>
16932
17196
  <dd>
16933
17197
 
16934
- **activation_strategy:** `Schematic::Types::CustomPlanActivationStrategy`
17198
+ **activation_strategy:** `Schematic::Types::CustomPlanActivationStrategy` — When the company gets the plan. On a custom-plan republish, on_payment is only accepted when the amendment is invoiced today (migration_strategy immediate, proration_behavior always_invoice, collection_method send_invoice): the company stays on its current version until that invoice is paid.
16935
17199
 
16936
17200
  </dd>
16937
17201
  </dl>
@@ -16963,7 +17227,15 @@ client.plans.publish_plan_version(
16963
17227
  <dl>
16964
17228
  <dd>
16965
17229
 
16966
- **coupon_external_id:** `String`
17230
+ **collection_method:** `Schematic::Types::BillingCollectionMethod` — How the invoice a custom-plan republish raises today is collected. send_invoice (the default) issues it for the company to pay; charge_automatically charges the default payment method straight away. Only accepted on a custom-plan republish with migration_strategy immediate and proration_behavior always_invoice.
17231
+
17232
+ </dd>
17233
+ </dl>
17234
+
17235
+ <dl>
17236
+ <dd>
17237
+
17238
+ **coupon_external_id:** `String` — A Stripe coupon to apply. On a custom-plan republish it discounts the amendment invoice and is only used when that invoice is raised today; it must exist in Stripe. It is attached to the subscription, so a repeating or forever coupon also discounts the renewals that follow.
16967
17239
 
16968
17240
  </dd>
16969
17241
  </dl>
@@ -16987,7 +17259,7 @@ client.plans.publish_plan_version(
16987
17259
  <dl>
16988
17260
  <dd>
16989
17261
 
16990
- **days_until_due:** `Integer`
17262
+ **days_until_due:** `Integer` — Payment terms in days. On a custom-plan republish they apply to the amendment invoice only, leave the subscription's renewal terms unchanged, and are only used when that invoice is raised today and sent rather than charged. Defaults to the subscription's terms.
16991
17263
 
16992
17264
  </dd>
16993
17265
  </dl>
@@ -17179,7 +17451,7 @@ client.components.create_component(
17179
17451
  <dl>
17180
17452
  <dd>
17181
17453
 
17182
- **ast:** `Internal::Types::Hash[String, Integer]`
17454
+ **ast:** `Internal::Types::Hash[String, Float]`
17183
17455
 
17184
17456
  </dd>
17185
17457
  </dl>
@@ -17299,7 +17571,7 @@ client.components.update_component(component_id: "component_id")
17299
17571
  <dl>
17300
17572
  <dd>
17301
17573
 
17302
- **ast:** `Internal::Types::Hash[String, Integer]`
17574
+ **ast:** `Internal::Types::Hash[String, Float]`
17303
17575
 
17304
17576
  </dd>
17305
17577
  </dl>
@@ -18785,6 +19057,14 @@ client.features.create_feature(
18785
19057
  <dl>
18786
19058
  <dd>
18787
19059
 
19060
+ **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.
19061
+
19062
+ </dd>
19063
+ </dl>
19064
+
19065
+ <dl>
19066
+ <dd>
19067
+
18788
19068
  **event_subtype:** `String`
18789
19069
 
18790
19070
  </dd>
@@ -18969,6 +19249,14 @@ client.features.update_feature(feature_id: "feature_id")
18969
19249
  <dl>
18970
19250
  <dd>
18971
19251
 
19252
+ **event_source:** `Schematic::Types::FeatureEventSource` — Which event stream meters this feature. It is fixed at creation: an update that changes it is rejected.
19253
+
19254
+ </dd>
19255
+ </dl>
19256
+
19257
+ <dl>
19258
+ <dd>
19259
+
18972
19260
  **event_subtype:** `String`
18973
19261
 
18974
19262
  </dd>
@@ -19159,6 +19447,14 @@ client.features.upsert_feature_for_billing_product(
19159
19447
  <dl>
19160
19448
  <dd>
19161
19449
 
19450
+ **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.
19451
+
19452
+ </dd>
19453
+ </dl>
19454
+
19455
+ <dl>
19456
+ <dd>
19457
+
19162
19458
  **event_subtype:** `String`
19163
19459
 
19164
19460
  </dd>
@@ -19888,7 +20184,7 @@ client.features.check_and_reserve_flag(key: "key")
19888
20184
  <dl>
19889
20185
  <dd>
19890
20186
 
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
20187
+ **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
19892
20188
 
19893
20189
  </dd>
19894
20190
  </dl>