orb-billing 1.13.0 → 1.15.0

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 (624) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +55 -0
  3. data/README.md +1 -1
  4. data/lib/orb/client.rb +21 -0
  5. data/lib/orb/internal/transport/base_client.rb +5 -0
  6. data/lib/orb/internal/type/union.rb +13 -27
  7. data/lib/orb/internal/util.rb +22 -7
  8. data/lib/orb/models/accounting_provider_config.rb +14 -3
  9. data/lib/orb/models/adjustment_interval.rb +185 -3
  10. data/lib/orb/models/alert.rb +114 -1
  11. data/lib/orb/models/alert_create_for_customer_params.rb +8 -1
  12. data/lib/orb/models/alert_create_for_external_customer_params.rb +8 -1
  13. data/lib/orb/models/alert_create_for_subscription_params.rb +142 -1
  14. data/lib/orb/models/alert_disable_params.rb +8 -1
  15. data/lib/orb/models/alert_enable_params.rb +8 -1
  16. data/lib/orb/models/alert_retrieve_params.rb +7 -1
  17. data/lib/orb/models/alert_update_params.rb +120 -1
  18. data/lib/orb/models/beta/external_plan_id_create_plan_version_params.rb +3296 -631
  19. data/lib/orb/models/beta/external_plan_id_fetch_plan_version_params.rb +7 -1
  20. data/lib/orb/models/beta/external_plan_id_set_default_plan_version_params.rb +8 -1
  21. data/lib/orb/models/beta_create_plan_version_params.rb +3263 -622
  22. data/lib/orb/models/beta_fetch_plan_version_params.rb +7 -1
  23. data/lib/orb/models/beta_set_default_plan_version_params.rb +8 -1
  24. data/lib/orb/models/changed_subscription_resources.rb +200 -10
  25. data/lib/orb/models/conversion_rate_config.rb +18 -0
  26. data/lib/orb/models/coupon_archive_params.rb +7 -1
  27. data/lib/orb/models/coupon_fetch_params.rb +7 -1
  28. data/lib/orb/models/coupons/subscription_list_params.rb +8 -1
  29. data/lib/orb/models/credit_block_delete_params.rb +7 -1
  30. data/lib/orb/models/credit_block_list_invoices_params.rb +7 -1
  31. data/lib/orb/models/credit_block_list_invoices_response.rb +155 -1
  32. data/lib/orb/models/credit_block_retrieve_params.rb +7 -1
  33. data/lib/orb/models/credit_block_retrieve_response.rb +150 -1
  34. data/lib/orb/models/credit_note_fetch_params.rb +7 -1
  35. data/lib/orb/models/customer.rb +122 -3
  36. data/lib/orb/models/customer_create_params.rb +17 -1
  37. data/lib/orb/models/customer_delete_params.rb +7 -1
  38. data/lib/orb/models/customer_fetch_by_external_id_params.rb +7 -1
  39. data/lib/orb/models/customer_fetch_params.rb +7 -1
  40. data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +7 -1
  41. data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +7 -1
  42. data/lib/orb/models/customer_tax_id.rb +15 -1
  43. data/lib/orb/models/customer_update_by_external_id_params.rb +39 -5
  44. data/lib/orb/models/customer_update_params.rb +39 -5
  45. data/lib/orb/models/customers/balance_transaction_create_params.rb +8 -1
  46. data/lib/orb/models/customers/balance_transaction_list_params.rb +8 -1
  47. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +8 -1
  48. data/lib/orb/models/customers/cost_list_params.rb +8 -1
  49. data/lib/orb/models/customers/credit_list_by_external_id_params.rb +8 -1
  50. data/lib/orb/models/customers/credit_list_by_external_id_response.rb +155 -1
  51. data/lib/orb/models/customers/credit_list_params.rb +8 -1
  52. data/lib/orb/models/customers/credit_list_response.rb +152 -1
  53. data/lib/orb/models/customers/credits/decrement_ledger_entry.rb +5 -1
  54. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +582 -315
  55. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +580 -313
  56. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +8 -1
  57. data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -1
  58. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +8 -1
  59. data/lib/orb/models/customers/credits/top_up_create_params.rb +8 -1
  60. data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +7 -1
  61. data/lib/orb/models/customers/credits/top_up_delete_params.rb +7 -1
  62. data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +8 -1
  63. data/lib/orb/models/customers/credits/top_up_list_params.rb +8 -1
  64. data/lib/orb/models/dimensional_price_group.rb +1 -1
  65. data/lib/orb/models/dimensional_price_group_retrieve_params.rb +7 -1
  66. data/lib/orb/models/dimensional_price_group_update_params.rb +8 -1
  67. data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +7 -1
  68. data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rb +8 -1
  69. data/lib/orb/models/discount.rb +145 -1
  70. data/lib/orb/models/event_deprecate_params.rb +7 -1
  71. data/lib/orb/models/event_ingest_params.rb +5 -2
  72. data/lib/orb/models/event_update_params.rb +8 -1
  73. data/lib/orb/models/events/backfill_close_params.rb +7 -1
  74. data/lib/orb/models/events/backfill_fetch_params.rb +7 -1
  75. data/lib/orb/models/events/backfill_revert_params.rb +7 -1
  76. data/lib/orb/models/invoice.rb +198 -10
  77. data/lib/orb/models/invoice_create_params.rb +6 -5
  78. data/lib/orb/models/invoice_delete_line_item_params.rb +7 -1
  79. data/lib/orb/models/invoice_fetch_params.rb +7 -1
  80. data/lib/orb/models/invoice_fetch_upcoming_response.rb +200 -10
  81. data/lib/orb/models/invoice_issue_params.rb +8 -1
  82. data/lib/orb/models/invoice_issue_summary_params.rb +8 -1
  83. data/lib/orb/models/invoice_issue_summary_response.rb +9 -3
  84. data/lib/orb/models/invoice_level_discount.rb +145 -1
  85. data/lib/orb/models/invoice_line_item_create_response.rb +189 -5
  86. data/lib/orb/models/invoice_list_summary_response.rb +9 -3
  87. data/lib/orb/models/invoice_mark_paid_params.rb +8 -1
  88. data/lib/orb/models/invoice_pay_params.rb +16 -1
  89. data/lib/orb/models/invoice_update_params.rb +8 -1
  90. data/lib/orb/models/invoice_void_params.rb +7 -1
  91. data/lib/orb/models/item_archive_params.rb +7 -1
  92. data/lib/orb/models/item_fetch_params.rb +7 -1
  93. data/lib/orb/models/item_update_params.rb +8 -1
  94. data/lib/orb/models/license_deactivate_params.rb +8 -1
  95. data/lib/orb/models/license_retrieve_by_external_id_params.rb +8 -1
  96. data/lib/orb/models/license_retrieve_params.rb +7 -1
  97. data/lib/orb/models/license_type_retrieve_params.rb +7 -1
  98. data/lib/orb/models/licenses/external_license_get_usage_params.rb +11 -4
  99. data/lib/orb/models/licenses/usage_get_all_usage_params.rb +3 -3
  100. data/lib/orb/models/licenses/usage_get_usage_params.rb +11 -4
  101. data/lib/orb/models/metric_fetch_params.rb +7 -1
  102. data/lib/orb/models/metric_update_params.rb +8 -1
  103. data/lib/orb/models/mutated_subscription.rb +169 -4
  104. data/lib/orb/models/new_allocation_price.rb +11 -1
  105. data/lib/orb/models/new_floating_bulk_price.rb +1 -3
  106. data/lib/orb/models/new_floating_bulk_with_proration_price.rb +1 -3
  107. data/lib/orb/models/new_floating_cumulative_grouped_bulk_price.rb +1 -3
  108. data/lib/orb/models/new_floating_grouped_allocation_price.rb +1 -3
  109. data/lib/orb/models/new_floating_grouped_tiered_package_price.rb +1 -3
  110. data/lib/orb/models/new_floating_grouped_tiered_price.rb +1 -3
  111. data/lib/orb/models/new_floating_grouped_with_metered_minimum_price.rb +1 -3
  112. data/lib/orb/models/new_floating_grouped_with_prorated_minimum_price.rb +1 -3
  113. data/lib/orb/models/new_floating_matrix_price.rb +1 -3
  114. data/lib/orb/models/new_floating_matrix_with_allocation_price.rb +1 -3
  115. data/lib/orb/models/new_floating_matrix_with_display_name_price.rb +1 -3
  116. data/lib/orb/models/new_floating_max_group_tiered_package_price.rb +1 -3
  117. data/lib/orb/models/new_floating_minimum_composite_price.rb +1 -3
  118. data/lib/orb/models/new_floating_package_price.rb +1 -3
  119. data/lib/orb/models/new_floating_package_with_allocation_price.rb +1 -3
  120. data/lib/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rb +1 -3
  121. data/lib/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rb +1 -3
  122. data/lib/orb/models/new_floating_threshold_total_amount_price.rb +1 -3
  123. data/lib/orb/models/new_floating_tiered_package_price.rb +1 -3
  124. data/lib/orb/models/new_floating_tiered_package_with_minimum_price.rb +1 -3
  125. data/lib/orb/models/new_floating_tiered_price.rb +1 -3
  126. data/lib/orb/models/new_floating_tiered_with_minimum_price.rb +1 -3
  127. data/lib/orb/models/new_floating_tiered_with_proration_price.rb +1 -3
  128. data/lib/orb/models/new_floating_unit_price.rb +1 -3
  129. data/lib/orb/models/new_floating_unit_with_percent_price.rb +1 -3
  130. data/lib/orb/models/new_floating_unit_with_proration_price.rb +1 -3
  131. data/lib/orb/models/new_plan_bulk_price.rb +1 -1
  132. data/lib/orb/models/new_plan_bulk_with_proration_price.rb +1 -3
  133. data/lib/orb/models/new_plan_cumulative_grouped_bulk_price.rb +1 -3
  134. data/lib/orb/models/new_plan_grouped_allocation_price.rb +1 -3
  135. data/lib/orb/models/new_plan_grouped_tiered_package_price.rb +1 -3
  136. data/lib/orb/models/new_plan_grouped_tiered_price.rb +1 -3
  137. data/lib/orb/models/new_plan_grouped_with_metered_minimum_price.rb +1 -3
  138. data/lib/orb/models/new_plan_grouped_with_prorated_minimum_price.rb +1 -3
  139. data/lib/orb/models/new_plan_matrix_price.rb +1 -5
  140. data/lib/orb/models/new_plan_matrix_with_allocation_price.rb +1 -3
  141. data/lib/orb/models/new_plan_matrix_with_display_name_price.rb +1 -3
  142. data/lib/orb/models/new_plan_max_group_tiered_package_price.rb +1 -3
  143. data/lib/orb/models/new_plan_minimum_composite_price.rb +1 -3
  144. data/lib/orb/models/new_plan_package_price.rb +1 -5
  145. data/lib/orb/models/new_plan_package_with_allocation_price.rb +1 -3
  146. data/lib/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rb +1 -3
  147. data/lib/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rb +1 -3
  148. data/lib/orb/models/new_plan_threshold_total_amount_price.rb +1 -3
  149. data/lib/orb/models/new_plan_tiered_package_price.rb +1 -3
  150. data/lib/orb/models/new_plan_tiered_package_with_minimum_price.rb +1 -3
  151. data/lib/orb/models/new_plan_tiered_price.rb +1 -5
  152. data/lib/orb/models/new_plan_tiered_with_minimum_price.rb +1 -3
  153. data/lib/orb/models/new_plan_unit_price.rb +1 -1
  154. data/lib/orb/models/new_plan_unit_with_percent_price.rb +1 -3
  155. data/lib/orb/models/new_plan_unit_with_proration_price.rb +1 -3
  156. data/lib/orb/models/new_subscription_bulk_price.rb +1 -3
  157. data/lib/orb/models/new_subscription_bulk_with_proration_price.rb +1 -3
  158. data/lib/orb/models/new_subscription_cumulative_grouped_bulk_price.rb +1 -3
  159. data/lib/orb/models/new_subscription_grouped_allocation_price.rb +1 -3
  160. data/lib/orb/models/new_subscription_grouped_tiered_package_price.rb +1 -3
  161. data/lib/orb/models/new_subscription_grouped_tiered_price.rb +1 -3
  162. data/lib/orb/models/new_subscription_grouped_with_metered_minimum_price.rb +1 -3
  163. data/lib/orb/models/new_subscription_grouped_with_prorated_minimum_price.rb +1 -3
  164. data/lib/orb/models/new_subscription_matrix_price.rb +1 -3
  165. data/lib/orb/models/new_subscription_matrix_with_allocation_price.rb +1 -3
  166. data/lib/orb/models/new_subscription_matrix_with_display_name_price.rb +1 -3
  167. data/lib/orb/models/new_subscription_max_group_tiered_package_price.rb +1 -3
  168. data/lib/orb/models/new_subscription_minimum_composite_price.rb +1 -3
  169. data/lib/orb/models/new_subscription_package_price.rb +1 -3
  170. data/lib/orb/models/new_subscription_package_with_allocation_price.rb +1 -3
  171. data/lib/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rb +1 -3
  172. data/lib/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rb +1 -3
  173. data/lib/orb/models/new_subscription_threshold_total_amount_price.rb +1 -3
  174. data/lib/orb/models/new_subscription_tiered_package_price.rb +1 -3
  175. data/lib/orb/models/new_subscription_tiered_package_with_minimum_price.rb +1 -3
  176. data/lib/orb/models/new_subscription_tiered_price.rb +1 -3
  177. data/lib/orb/models/new_subscription_tiered_with_minimum_price.rb +1 -3
  178. data/lib/orb/models/new_subscription_unit_price.rb +1 -3
  179. data/lib/orb/models/new_subscription_unit_with_percent_price.rb +1 -3
  180. data/lib/orb/models/new_subscription_unit_with_proration_price.rb +1 -3
  181. data/lib/orb/models/per_price_cost.rb +2 -2
  182. data/lib/orb/models/plan.rb +189 -9
  183. data/lib/orb/models/plan_create_params.rb +1478 -158
  184. data/lib/orb/models/plan_fetch_params.rb +7 -1
  185. data/lib/orb/models/plan_update_params.rb +16 -1
  186. data/lib/orb/models/plan_version.rb +186 -5
  187. data/lib/orb/models/plans/external_plan_id_fetch_params.rb +7 -1
  188. data/lib/orb/models/plans/external_plan_id_update_params.rb +16 -1
  189. data/lib/orb/models/plans/migration_cancel_params.rb +7 -1
  190. data/lib/orb/models/plans/migration_cancel_response.rb +22 -4
  191. data/lib/orb/models/plans/migration_list_params.rb +8 -1
  192. data/lib/orb/models/plans/migration_list_response.rb +22 -4
  193. data/lib/orb/models/plans/migration_retrieve_params.rb +7 -1
  194. data/lib/orb/models/plans/migration_retrieve_response.rb +22 -4
  195. data/lib/orb/models/price.rb +2807 -1244
  196. data/lib/orb/models/price_create_params.rb +1800 -1355
  197. data/lib/orb/models/price_evaluate_multiple_params.rb +889 -54
  198. data/lib/orb/models/price_evaluate_params.rb +8 -1
  199. data/lib/orb/models/price_evaluate_preview_events_params.rb +881 -46
  200. data/lib/orb/models/price_fetch_params.rb +7 -1
  201. data/lib/orb/models/price_interval.rb +2 -2
  202. data/lib/orb/models/price_update_params.rb +8 -1
  203. data/lib/orb/models/prices/external_price_id_fetch_params.rb +7 -1
  204. data/lib/orb/models/prices/external_price_id_update_params.rb +8 -1
  205. data/lib/orb/models/subscription.rb +168 -4
  206. data/lib/orb/models/subscription_cancel_params.rb +8 -1
  207. data/lib/orb/models/subscription_change_apply_params.rb +8 -1
  208. data/lib/orb/models/subscription_change_cancel_params.rb +7 -1
  209. data/lib/orb/models/subscription_change_retrieve_params.rb +7 -1
  210. data/lib/orb/models/subscription_create_params.rb +2818 -674
  211. data/lib/orb/models/subscription_fetch_costs_params.rb +8 -1
  212. data/lib/orb/models/subscription_fetch_params.rb +7 -1
  213. data/lib/orb/models/subscription_fetch_schedule_params.rb +8 -1
  214. data/lib/orb/models/subscription_fetch_usage_params.rb +8 -1
  215. data/lib/orb/models/subscription_price_intervals_params.rb +1103 -55
  216. data/lib/orb/models/subscription_redeem_coupon_params.rb +8 -1
  217. data/lib/orb/models/subscription_schedule_plan_change_params.rb +2839 -685
  218. data/lib/orb/models/subscription_trigger_phase_params.rb +8 -1
  219. data/lib/orb/models/subscription_unschedule_cancellation_params.rb +7 -1
  220. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +8 -1
  221. data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +7 -1
  222. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +8 -1
  223. data/lib/orb/models/subscription_update_params.rb +19 -1
  224. data/lib/orb/models/subscription_update_trial_params.rb +8 -1
  225. data/lib/orb/models.rb +2 -0
  226. data/lib/orb/resources/alerts.rb +20 -2
  227. data/lib/orb/resources/coupons.rb +1 -2
  228. data/lib/orb/resources/credit_blocks.rb +11 -8
  229. data/lib/orb/resources/customers/credits/ledger.rb +40 -81
  230. data/lib/orb/resources/customers.rb +12 -7
  231. data/lib/orb/resources/events/backfills.rb +3 -4
  232. data/lib/orb/resources/events.rb +7 -34
  233. data/lib/orb/resources/invoices.rb +18 -7
  234. data/lib/orb/resources/licenses/external_licenses.rb +1 -1
  235. data/lib/orb/resources/licenses/usage.rb +2 -2
  236. data/lib/orb/resources/metrics.rb +5 -5
  237. data/lib/orb/resources/plans/external_plan_id.rb +5 -3
  238. data/lib/orb/resources/plans.rb +9 -5
  239. data/lib/orb/resources/prices/external_price_id.rb +2 -2
  240. data/lib/orb/resources/prices.rb +13 -104
  241. data/lib/orb/resources/subscriptions.rb +24 -7
  242. data/lib/orb/version.rb +1 -1
  243. data/lib/orb.rb +1 -0
  244. data/rbi/orb/client.rbi +6 -0
  245. data/rbi/orb/internal/util.rbi +8 -0
  246. data/rbi/orb/models/accounting_provider_config.rbi +38 -5
  247. data/rbi/orb/models/adjustment_interval.rbi +336 -0
  248. data/rbi/orb/models/alert.rbi +182 -3
  249. data/rbi/orb/models/alert_create_for_customer_params.rbi +6 -0
  250. data/rbi/orb/models/alert_create_for_external_customer_params.rbi +6 -0
  251. data/rbi/orb/models/alert_create_for_subscription_params.rbi +285 -0
  252. data/rbi/orb/models/alert_disable_params.rbi +6 -0
  253. data/rbi/orb/models/alert_enable_params.rbi +6 -0
  254. data/rbi/orb/models/alert_retrieve_params.rbi +13 -5
  255. data/rbi/orb/models/alert_update_params.rbi +214 -0
  256. data/rbi/orb/models/beta/external_plan_id_create_plan_version_params.rbi +5873 -1161
  257. data/rbi/orb/models/beta/external_plan_id_fetch_plan_version_params.rbi +10 -2
  258. data/rbi/orb/models/beta/external_plan_id_set_default_plan_version_params.rbi +10 -1
  259. data/rbi/orb/models/beta_create_plan_version_params.rbi +5877 -1165
  260. data/rbi/orb/models/beta_fetch_plan_version_params.rbi +10 -2
  261. data/rbi/orb/models/beta_set_default_plan_version_params.rbi +10 -1
  262. data/rbi/orb/models/changed_subscription_resources.rbi +360 -5
  263. data/rbi/orb/models/conversion_rate_config.rbi +18 -0
  264. data/rbi/orb/models/coupon_archive_params.rbi +13 -5
  265. data/rbi/orb/models/coupon_fetch_params.rbi +13 -5
  266. data/rbi/orb/models/coupons/subscription_list_params.rbi +6 -0
  267. data/rbi/orb/models/credit_block_delete_params.rbi +13 -5
  268. data/rbi/orb/models/credit_block_list_invoices_params.rbi +13 -5
  269. data/rbi/orb/models/credit_block_list_invoices_response.rbi +346 -3
  270. data/rbi/orb/models/credit_block_retrieve_params.rbi +13 -5
  271. data/rbi/orb/models/credit_block_retrieve_response.rbi +344 -3
  272. data/rbi/orb/models/credit_note_fetch_params.rbi +13 -5
  273. data/rbi/orb/models/customer.rbi +202 -0
  274. data/rbi/orb/models/customer_create_params.rbi +27 -0
  275. data/rbi/orb/models/customer_delete_params.rbi +13 -5
  276. data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +13 -5
  277. data/rbi/orb/models/customer_fetch_params.rbi +13 -5
  278. data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +13 -5
  279. data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +13 -5
  280. data/rbi/orb/models/customer_tax_id.rbi +15 -1
  281. data/rbi/orb/models/customer_update_by_external_id_params.rbi +51 -4
  282. data/rbi/orb/models/customer_update_params.rbi +51 -4
  283. data/rbi/orb/models/customers/balance_transaction_create_params.rbi +6 -0
  284. data/rbi/orb/models/customers/balance_transaction_list_params.rbi +6 -0
  285. data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +6 -0
  286. data/rbi/orb/models/customers/cost_list_params.rbi +6 -0
  287. data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi +6 -0
  288. data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +346 -3
  289. data/rbi/orb/models/customers/credit_list_params.rbi +6 -0
  290. data/rbi/orb/models/customers/credit_list_response.rbi +347 -3
  291. data/rbi/orb/models/customers/credits/decrement_ledger_entry.rbi +4 -0
  292. data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +861 -478
  293. data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +861 -478
  294. data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -0
  295. data/rbi/orb/models/customers/credits/ledger_list_params.rbi +6 -0
  296. data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +6 -0
  297. data/rbi/orb/models/customers/credits/top_up_create_params.rbi +6 -0
  298. data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +6 -1
  299. data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +10 -2
  300. data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +6 -0
  301. data/rbi/orb/models/customers/credits/top_up_list_params.rbi +6 -0
  302. data/rbi/orb/models/dimensional_price_group.rbi +1 -1
  303. data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +16 -5
  304. data/rbi/orb/models/dimensional_price_group_update_params.rbi +6 -0
  305. data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +16 -5
  306. data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rbi +6 -0
  307. data/rbi/orb/models/discount.rbi +269 -1
  308. data/rbi/orb/models/event_deprecate_params.rbi +13 -5
  309. data/rbi/orb/models/event_ingest_params.rbi +4 -2
  310. data/rbi/orb/models/event_update_params.rbi +6 -0
  311. data/rbi/orb/models/events/backfill_close_params.rbi +13 -5
  312. data/rbi/orb/models/events/backfill_fetch_params.rbi +13 -5
  313. data/rbi/orb/models/events/backfill_revert_params.rbi +13 -5
  314. data/rbi/orb/models/invoice.rbi +360 -5
  315. data/rbi/orb/models/invoice_create_params.rbi +12 -7
  316. data/rbi/orb/models/invoice_delete_line_item_params.rbi +10 -2
  317. data/rbi/orb/models/invoice_fetch_params.rbi +13 -5
  318. data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +360 -5
  319. data/rbi/orb/models/invoice_issue_params.rbi +10 -1
  320. data/rbi/orb/models/invoice_issue_summary_params.rbi +10 -1
  321. data/rbi/orb/models/invoice_issue_summary_response.rbi +19 -4
  322. data/rbi/orb/models/invoice_level_discount.rbi +298 -1
  323. data/rbi/orb/models/invoice_line_item_create_response.rbi +339 -0
  324. data/rbi/orb/models/invoice_list_summary_response.rbi +19 -4
  325. data/rbi/orb/models/invoice_mark_paid_params.rbi +6 -0
  326. data/rbi/orb/models/invoice_pay_params.rbi +27 -5
  327. data/rbi/orb/models/invoice_update_params.rbi +6 -0
  328. data/rbi/orb/models/invoice_void_params.rbi +13 -5
  329. data/rbi/orb/models/item_archive_params.rbi +13 -5
  330. data/rbi/orb/models/item_fetch_params.rbi +13 -5
  331. data/rbi/orb/models/item_update_params.rbi +6 -0
  332. data/rbi/orb/models/license_deactivate_params.rbi +10 -1
  333. data/rbi/orb/models/license_retrieve_by_external_id_params.rbi +6 -0
  334. data/rbi/orb/models/license_retrieve_params.rbi +13 -5
  335. data/rbi/orb/models/license_type_retrieve_params.rbi +13 -5
  336. data/rbi/orb/models/licenses/external_license_get_usage_params.rbi +9 -3
  337. data/rbi/orb/models/licenses/usage_get_all_usage_params.rbi +3 -3
  338. data/rbi/orb/models/licenses/usage_get_usage_params.rbi +9 -3
  339. data/rbi/orb/models/metric_fetch_params.rbi +13 -5
  340. data/rbi/orb/models/metric_update_params.rbi +6 -0
  341. data/rbi/orb/models/mutated_subscription.rbi +324 -2
  342. data/rbi/orb/models/new_allocation_price.rbi +12 -0
  343. data/rbi/orb/models/per_price_cost.rbi +3 -0
  344. data/rbi/orb/models/plan.rbi +339 -2
  345. data/rbi/orb/models/plan_create_params.rbi +2566 -209
  346. data/rbi/orb/models/plan_fetch_params.rbi +13 -5
  347. data/rbi/orb/models/plan_update_params.rbi +14 -0
  348. data/rbi/orb/models/plan_version.rbi +339 -0
  349. data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +13 -5
  350. data/rbi/orb/models/plans/external_plan_id_update_params.rbi +14 -0
  351. data/rbi/orb/models/plans/migration_cancel_params.rbi +10 -2
  352. data/rbi/orb/models/plans/migration_cancel_response.rbi +22 -1
  353. data/rbi/orb/models/plans/migration_list_params.rbi +6 -0
  354. data/rbi/orb/models/plans/migration_list_response.rbi +22 -1
  355. data/rbi/orb/models/plans/migration_retrieve_params.rbi +10 -2
  356. data/rbi/orb/models/plans/migration_retrieve_response.rbi +22 -1
  357. data/rbi/orb/models/price.rbi +4733 -2280
  358. data/rbi/orb/models/price_create_params.rbi +3022 -2408
  359. data/rbi/orb/models/price_evaluate_multiple_params.rbi +1540 -114
  360. data/rbi/orb/models/price_evaluate_params.rbi +6 -0
  361. data/rbi/orb/models/price_evaluate_preview_events_params.rbi +1540 -114
  362. data/rbi/orb/models/price_fetch_params.rbi +13 -5
  363. data/rbi/orb/models/price_interval.rbi +3 -0
  364. data/rbi/orb/models/price_update_params.rbi +6 -0
  365. data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +13 -5
  366. data/rbi/orb/models/prices/external_price_id_update_params.rbi +6 -0
  367. data/rbi/orb/models/subscription.rbi +324 -2
  368. data/rbi/orb/models/subscription_cancel_params.rbi +6 -0
  369. data/rbi/orb/models/subscription_change_apply_params.rbi +6 -0
  370. data/rbi/orb/models/subscription_change_cancel_params.rbi +16 -5
  371. data/rbi/orb/models/subscription_change_retrieve_params.rbi +16 -5
  372. data/rbi/orb/models/subscription_create_params.rbi +4998 -1186
  373. data/rbi/orb/models/subscription_fetch_costs_params.rbi +6 -0
  374. data/rbi/orb/models/subscription_fetch_params.rbi +13 -5
  375. data/rbi/orb/models/subscription_fetch_schedule_params.rbi +6 -0
  376. data/rbi/orb/models/subscription_fetch_usage_params.rbi +6 -0
  377. data/rbi/orb/models/subscription_price_intervals_params.rbi +2133 -264
  378. data/rbi/orb/models/subscription_redeem_coupon_params.rbi +6 -0
  379. data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +5001 -1183
  380. data/rbi/orb/models/subscription_trigger_phase_params.rbi +6 -0
  381. data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +13 -5
  382. data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +10 -1
  383. data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +13 -5
  384. data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +6 -0
  385. data/rbi/orb/models/subscription_update_params.rbi +20 -0
  386. data/rbi/orb/models/subscription_update_trial_params.rbi +6 -0
  387. data/rbi/orb/models.rbi +2 -0
  388. data/rbi/orb/resources/alerts.rbi +43 -0
  389. data/rbi/orb/resources/coupons.rbi +1 -2
  390. data/rbi/orb/resources/credit_blocks.rbi +10 -7
  391. data/rbi/orb/resources/customers/credits/ledger.rbi +50 -146
  392. data/rbi/orb/resources/customers.rbi +35 -7
  393. data/rbi/orb/resources/events/backfills.rbi +3 -4
  394. data/rbi/orb/resources/events.rbi +8 -35
  395. data/rbi/orb/resources/invoices.rbi +20 -6
  396. data/rbi/orb/resources/licenses/external_licenses.rbi +1 -1
  397. data/rbi/orb/resources/licenses/usage.rbi +2 -2
  398. data/rbi/orb/resources/metrics.rbi +5 -5
  399. data/rbi/orb/resources/plans/external_plan_id.rbi +5 -2
  400. data/rbi/orb/resources/plans.rbi +9 -3
  401. data/rbi/orb/resources/prices.rbi +38 -184
  402. data/rbi/orb/resources/subscriptions.rbi +33 -4
  403. data/sig/orb/client.rbs +3 -0
  404. data/sig/orb/internal/util.rbs +4 -0
  405. data/sig/orb/models/accounting_provider_config.rbs +21 -4
  406. data/sig/orb/models/adjustment_interval.rbs +134 -0
  407. data/sig/orb/models/alert.rbs +90 -3
  408. data/sig/orb/models/alert_create_for_customer_params.rbs +5 -0
  409. data/sig/orb/models/alert_create_for_external_customer_params.rbs +5 -0
  410. data/sig/orb/models/alert_create_for_subscription_params.rbs +98 -1
  411. data/sig/orb/models/alert_disable_params.rbs +6 -1
  412. data/sig/orb/models/alert_enable_params.rbs +6 -1
  413. data/sig/orb/models/alert_retrieve_params.rbs +9 -3
  414. data/sig/orb/models/alert_update_params.rbs +90 -1
  415. data/sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs +2318 -397
  416. data/sig/orb/models/beta/external_plan_id_fetch_plan_version_params.rbs +6 -1
  417. data/sig/orb/models/beta/external_plan_id_set_default_plan_version_params.rbs +6 -1
  418. data/sig/orb/models/beta_create_plan_version_params.rbs +2300 -389
  419. data/sig/orb/models/beta_fetch_plan_version_params.rbs +10 -2
  420. data/sig/orb/models/beta_set_default_plan_version_params.rbs +10 -2
  421. data/sig/orb/models/changed_subscription_resources.rbs +140 -1
  422. data/sig/orb/models/conversion_rate_config.rbs +12 -0
  423. data/sig/orb/models/coupon_archive_params.rbs +12 -3
  424. data/sig/orb/models/coupon_fetch_params.rbs +12 -3
  425. data/sig/orb/models/coupons/subscription_list_params.rbs +5 -1
  426. data/sig/orb/models/credit_block_delete_params.rbs +8 -3
  427. data/sig/orb/models/credit_block_list_invoices_params.rbs +8 -3
  428. data/sig/orb/models/credit_block_list_invoices_response.rbs +124 -3
  429. data/sig/orb/models/credit_block_retrieve_params.rbs +8 -3
  430. data/sig/orb/models/credit_block_retrieve_response.rbs +124 -3
  431. data/sig/orb/models/credit_note_fetch_params.rbs +11 -3
  432. data/sig/orb/models/customer.rbs +79 -1
  433. data/sig/orb/models/customer_create_params.rbs +12 -1
  434. data/sig/orb/models/customer_delete_params.rbs +12 -3
  435. data/sig/orb/models/customer_fetch_by_external_id_params.rbs +11 -3
  436. data/sig/orb/models/customer_fetch_params.rbs +12 -3
  437. data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +11 -3
  438. data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +11 -3
  439. data/sig/orb/models/customer_tax_id.rbs +20 -2
  440. data/sig/orb/models/customer_update_by_external_id_params.rbs +22 -1
  441. data/sig/orb/models/customer_update_params.rbs +22 -1
  442. data/sig/orb/models/customers/balance_transaction_create_params.rbs +5 -0
  443. data/sig/orb/models/customers/balance_transaction_list_params.rbs +5 -0
  444. data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +5 -0
  445. data/sig/orb/models/customers/cost_list_params.rbs +5 -0
  446. data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +5 -0
  447. data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +124 -3
  448. data/sig/orb/models/customers/credit_list_params.rbs +5 -0
  449. data/sig/orb/models/customers/credit_list_response.rbs +124 -3
  450. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +345 -157
  451. data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +345 -157
  452. data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +5 -0
  453. data/sig/orb/models/customers/credits/ledger_list_params.rbs +5 -0
  454. data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +5 -0
  455. data/sig/orb/models/customers/credits/top_up_create_params.rbs +5 -0
  456. data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +5 -1
  457. data/sig/orb/models/customers/credits/top_up_delete_params.rbs +6 -1
  458. data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +5 -1
  459. data/sig/orb/models/customers/credits/top_up_list_params.rbs +5 -1
  460. data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +12 -3
  461. data/sig/orb/models/dimensional_price_group_update_params.rbs +5 -0
  462. data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +12 -3
  463. data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rbs +5 -0
  464. data/sig/orb/models/discount.rbs +114 -0
  465. data/sig/orb/models/event_deprecate_params.rbs +9 -3
  466. data/sig/orb/models/event_update_params.rbs +5 -0
  467. data/sig/orb/models/events/backfill_close_params.rbs +11 -3
  468. data/sig/orb/models/events/backfill_fetch_params.rbs +11 -3
  469. data/sig/orb/models/events/backfill_revert_params.rbs +11 -3
  470. data/sig/orb/models/invoice.rbs +140 -1
  471. data/sig/orb/models/invoice_delete_line_item_params.rbs +6 -1
  472. data/sig/orb/models/invoice_fetch_params.rbs +12 -3
  473. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +140 -1
  474. data/sig/orb/models/invoice_issue_params.rbs +6 -1
  475. data/sig/orb/models/invoice_issue_summary_params.rbs +6 -1
  476. data/sig/orb/models/invoice_issue_summary_response.rbs +2 -1
  477. data/sig/orb/models/invoice_level_discount.rbs +117 -1
  478. data/sig/orb/models/invoice_line_item_create_response.rbs +134 -0
  479. data/sig/orb/models/invoice_list_summary_response.rbs +2 -1
  480. data/sig/orb/models/invoice_mark_paid_params.rbs +10 -1
  481. data/sig/orb/models/invoice_pay_params.rbs +17 -3
  482. data/sig/orb/models/invoice_update_params.rbs +5 -0
  483. data/sig/orb/models/invoice_void_params.rbs +12 -3
  484. data/sig/orb/models/item_archive_params.rbs +9 -3
  485. data/sig/orb/models/item_fetch_params.rbs +9 -3
  486. data/sig/orb/models/item_update_params.rbs +5 -0
  487. data/sig/orb/models/license_deactivate_params.rbs +10 -2
  488. data/sig/orb/models/license_retrieve_by_external_id_params.rbs +9 -1
  489. data/sig/orb/models/license_retrieve_params.rbs +11 -3
  490. data/sig/orb/models/license_type_retrieve_params.rbs +11 -3
  491. data/sig/orb/models/licenses/external_license_get_usage_params.rbs +9 -4
  492. data/sig/orb/models/licenses/usage_get_all_usage_params.rbs +4 -4
  493. data/sig/orb/models/licenses/usage_get_usage_params.rbs +9 -4
  494. data/sig/orb/models/metric_fetch_params.rbs +12 -3
  495. data/sig/orb/models/metric_update_params.rbs +5 -1
  496. data/sig/orb/models/mutated_subscription.rbs +124 -0
  497. data/sig/orb/models/new_allocation_price.rbs +5 -0
  498. data/sig/orb/models/new_floating_bulk_price.rbs +4 -4
  499. data/sig/orb/models/new_floating_bulk_with_proration_price.rbs +4 -4
  500. data/sig/orb/models/new_floating_cumulative_grouped_bulk_price.rbs +4 -4
  501. data/sig/orb/models/new_floating_grouped_allocation_price.rbs +4 -4
  502. data/sig/orb/models/new_floating_grouped_tiered_package_price.rbs +4 -4
  503. data/sig/orb/models/new_floating_grouped_tiered_price.rbs +4 -4
  504. data/sig/orb/models/new_floating_grouped_with_metered_minimum_price.rbs +4 -4
  505. data/sig/orb/models/new_floating_grouped_with_prorated_minimum_price.rbs +4 -4
  506. data/sig/orb/models/new_floating_matrix_price.rbs +4 -4
  507. data/sig/orb/models/new_floating_matrix_with_allocation_price.rbs +4 -4
  508. data/sig/orb/models/new_floating_matrix_with_display_name_price.rbs +4 -4
  509. data/sig/orb/models/new_floating_max_group_tiered_package_price.rbs +4 -4
  510. data/sig/orb/models/new_floating_minimum_composite_price.rbs +4 -4
  511. data/sig/orb/models/new_floating_package_price.rbs +4 -4
  512. data/sig/orb/models/new_floating_package_with_allocation_price.rbs +4 -4
  513. data/sig/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rbs +4 -4
  514. data/sig/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rbs +4 -4
  515. data/sig/orb/models/new_floating_threshold_total_amount_price.rbs +4 -4
  516. data/sig/orb/models/new_floating_tiered_package_price.rbs +4 -4
  517. data/sig/orb/models/new_floating_tiered_package_with_minimum_price.rbs +4 -4
  518. data/sig/orb/models/new_floating_tiered_price.rbs +4 -4
  519. data/sig/orb/models/new_floating_tiered_with_minimum_price.rbs +4 -4
  520. data/sig/orb/models/new_floating_tiered_with_proration_price.rbs +4 -4
  521. data/sig/orb/models/new_floating_unit_price.rbs +4 -4
  522. data/sig/orb/models/new_floating_unit_with_percent_price.rbs +4 -4
  523. data/sig/orb/models/new_floating_unit_with_proration_price.rbs +4 -4
  524. data/sig/orb/models/new_plan_bulk_price.rbs +4 -4
  525. data/sig/orb/models/new_plan_bulk_with_proration_price.rbs +4 -4
  526. data/sig/orb/models/new_plan_cumulative_grouped_bulk_price.rbs +4 -4
  527. data/sig/orb/models/new_plan_grouped_allocation_price.rbs +4 -4
  528. data/sig/orb/models/new_plan_grouped_tiered_package_price.rbs +4 -4
  529. data/sig/orb/models/new_plan_grouped_tiered_price.rbs +4 -4
  530. data/sig/orb/models/new_plan_grouped_with_metered_minimum_price.rbs +4 -4
  531. data/sig/orb/models/new_plan_grouped_with_prorated_minimum_price.rbs +4 -4
  532. data/sig/orb/models/new_plan_matrix_price.rbs +4 -4
  533. data/sig/orb/models/new_plan_matrix_with_allocation_price.rbs +4 -4
  534. data/sig/orb/models/new_plan_matrix_with_display_name_price.rbs +4 -4
  535. data/sig/orb/models/new_plan_max_group_tiered_package_price.rbs +4 -4
  536. data/sig/orb/models/new_plan_minimum_composite_price.rbs +4 -4
  537. data/sig/orb/models/new_plan_package_price.rbs +4 -4
  538. data/sig/orb/models/new_plan_package_with_allocation_price.rbs +4 -4
  539. data/sig/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rbs +4 -4
  540. data/sig/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbs +4 -4
  541. data/sig/orb/models/new_plan_threshold_total_amount_price.rbs +4 -4
  542. data/sig/orb/models/new_plan_tiered_package_price.rbs +4 -4
  543. data/sig/orb/models/new_plan_tiered_package_with_minimum_price.rbs +4 -4
  544. data/sig/orb/models/new_plan_tiered_price.rbs +4 -4
  545. data/sig/orb/models/new_plan_tiered_with_minimum_price.rbs +4 -4
  546. data/sig/orb/models/new_plan_unit_price.rbs +4 -4
  547. data/sig/orb/models/new_plan_unit_with_percent_price.rbs +4 -4
  548. data/sig/orb/models/new_plan_unit_with_proration_price.rbs +4 -4
  549. data/sig/orb/models/new_subscription_bulk_price.rbs +4 -4
  550. data/sig/orb/models/new_subscription_bulk_with_proration_price.rbs +4 -4
  551. data/sig/orb/models/new_subscription_cumulative_grouped_bulk_price.rbs +4 -4
  552. data/sig/orb/models/new_subscription_grouped_allocation_price.rbs +4 -4
  553. data/sig/orb/models/new_subscription_grouped_tiered_package_price.rbs +4 -4
  554. data/sig/orb/models/new_subscription_grouped_tiered_price.rbs +4 -4
  555. data/sig/orb/models/new_subscription_grouped_with_metered_minimum_price.rbs +4 -4
  556. data/sig/orb/models/new_subscription_grouped_with_prorated_minimum_price.rbs +4 -4
  557. data/sig/orb/models/new_subscription_matrix_price.rbs +4 -4
  558. data/sig/orb/models/new_subscription_matrix_with_allocation_price.rbs +4 -4
  559. data/sig/orb/models/new_subscription_matrix_with_display_name_price.rbs +4 -4
  560. data/sig/orb/models/new_subscription_max_group_tiered_package_price.rbs +4 -4
  561. data/sig/orb/models/new_subscription_minimum_composite_price.rbs +4 -4
  562. data/sig/orb/models/new_subscription_package_price.rbs +4 -4
  563. data/sig/orb/models/new_subscription_package_with_allocation_price.rbs +4 -4
  564. data/sig/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rbs +4 -4
  565. data/sig/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rbs +4 -4
  566. data/sig/orb/models/new_subscription_threshold_total_amount_price.rbs +4 -4
  567. data/sig/orb/models/new_subscription_tiered_package_price.rbs +4 -4
  568. data/sig/orb/models/new_subscription_tiered_package_with_minimum_price.rbs +4 -4
  569. data/sig/orb/models/new_subscription_tiered_price.rbs +4 -4
  570. data/sig/orb/models/new_subscription_tiered_with_minimum_price.rbs +4 -4
  571. data/sig/orb/models/new_subscription_unit_price.rbs +4 -4
  572. data/sig/orb/models/new_subscription_unit_with_percent_price.rbs +4 -4
  573. data/sig/orb/models/new_subscription_unit_with_proration_price.rbs +4 -4
  574. data/sig/orb/models/plan.rbs +134 -0
  575. data/sig/orb/models/plan_create_params.rbs +1030 -72
  576. data/sig/orb/models/plan_fetch_params.rbs +9 -3
  577. data/sig/orb/models/plan_update_params.rbs +14 -1
  578. data/sig/orb/models/plan_version.rbs +134 -0
  579. data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +11 -3
  580. data/sig/orb/models/plans/external_plan_id_update_params.rbs +14 -1
  581. data/sig/orb/models/plans/migration_cancel_params.rbs +6 -1
  582. data/sig/orb/models/plans/migration_list_params.rbs +5 -1
  583. data/sig/orb/models/plans/migration_retrieve_params.rbs +6 -1
  584. data/sig/orb/models/price.rbs +2361 -1156
  585. data/sig/orb/models/price_create_params.rbs +1124 -931
  586. data/sig/orb/models/price_evaluate_multiple_params.rbs +626 -23
  587. data/sig/orb/models/price_evaluate_params.rbs +5 -0
  588. data/sig/orb/models/price_evaluate_preview_events_params.rbs +626 -23
  589. data/sig/orb/models/price_fetch_params.rbs +9 -3
  590. data/sig/orb/models/price_update_params.rbs +5 -1
  591. data/sig/orb/models/prices/external_price_id_fetch_params.rbs +11 -3
  592. data/sig/orb/models/prices/external_price_id_update_params.rbs +5 -1
  593. data/sig/orb/models/subscription.rbs +124 -0
  594. data/sig/orb/models/subscription_cancel_params.rbs +5 -0
  595. data/sig/orb/models/subscription_change_apply_params.rbs +5 -0
  596. data/sig/orb/models/subscription_change_cancel_params.rbs +12 -3
  597. data/sig/orb/models/subscription_change_retrieve_params.rbs +12 -3
  598. data/sig/orb/models/subscription_create_params.rbs +2009 -430
  599. data/sig/orb/models/subscription_fetch_costs_params.rbs +5 -0
  600. data/sig/orb/models/subscription_fetch_params.rbs +11 -3
  601. data/sig/orb/models/subscription_fetch_schedule_params.rbs +5 -0
  602. data/sig/orb/models/subscription_fetch_usage_params.rbs +5 -0
  603. data/sig/orb/models/subscription_price_intervals_params.rbs +800 -23
  604. data/sig/orb/models/subscription_redeem_coupon_params.rbs +5 -0
  605. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +2014 -430
  606. data/sig/orb/models/subscription_trigger_phase_params.rbs +9 -1
  607. data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +11 -3
  608. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +10 -2
  609. data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +11 -3
  610. data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +5 -0
  611. data/sig/orb/models/subscription_update_params.rbs +10 -0
  612. data/sig/orb/models/subscription_update_trial_params.rbs +5 -0
  613. data/sig/orb/models.rbs +2 -0
  614. data/sig/orb/resources/alerts.rbs +6 -0
  615. data/sig/orb/resources/customers/credits/ledger.rbs +2 -26
  616. data/sig/orb/resources/customers.rbs +2 -0
  617. data/sig/orb/resources/invoices.rbs +1 -0
  618. data/sig/orb/resources/licenses/external_licenses.rbs +1 -1
  619. data/sig/orb/resources/licenses/usage.rbs +2 -2
  620. data/sig/orb/resources/plans/external_plan_id.rbs +1 -0
  621. data/sig/orb/resources/plans.rbs +2 -0
  622. data/sig/orb/resources/prices.rbs +1 -48
  623. data/sig/orb/resources/subscriptions.rbs +3 -0
  624. metadata +6 -7
@@ -72,11 +72,13 @@ module Orb
72
72
  # | Estonia | `eu_vat` | European VAT Number |
73
73
  # | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
74
74
  # | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
75
+ # | Faroe Islands | `fo_vat` | Faroe Islands VAT Number |
75
76
  # | Finland | `eu_vat` | European VAT Number |
76
77
  # | France | `eu_vat` | European VAT Number |
77
78
  # | Georgia | `ge_vat` | Georgian VAT |
78
79
  # | Germany | `de_stn` | German Tax Number (Steuernummer) |
79
80
  # | Germany | `eu_vat` | European VAT Number |
81
+ # | Gibraltar | `gi_tin` | Gibraltar Tax Identification Number |
80
82
  # | Greece | `eu_vat` | European VAT Number |
81
83
  # | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
82
84
  # | Hong Kong | `hk_br` | Hong Kong BR Number |
@@ -88,6 +90,7 @@ module Orb
88
90
  # | Ireland | `eu_vat` | European VAT Number |
89
91
  # | Israel | `il_vat` | Israel VAT |
90
92
  # | Italy | `eu_vat` | European VAT Number |
93
+ # | Italy | `it_cf` | Italian Codice Fiscale Number |
91
94
  # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
92
95
  # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
93
96
  # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
@@ -118,6 +121,7 @@ module Orb
118
121
  # | Norway | `no_vat` | Norwegian VAT Number |
119
122
  # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
120
123
  # | Oman | `om_vat` | Omani VAT Number |
124
+ # | Paraguay | `py_ruc` | Paraguayan RUC Number |
121
125
  # | Peru | `pe_ruc` | Peruvian RUC Number |
122
126
  # | Philippines | `ph_tin` | Philippines Tax Identification Number |
123
127
  # | Poland | `eu_vat` | European VAT Number |
@@ -139,6 +143,7 @@ module Orb
139
143
  # | South Korea | `kr_brn` | Korean BRN |
140
144
  # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
141
145
  # | Spain | `eu_vat` | European VAT Number |
146
+ # | Sri Lanka | `lk_vat` | Sri Lanka VAT Number |
142
147
  # | Suriname | `sr_fin` | Suriname FIN Number |
143
148
  # | Sweden | `eu_vat` | European VAT Number |
144
149
  # | Switzerland | `ch_uid` | Switzerland UID Number |
@@ -220,9 +225,9 @@ module Orb
220
225
  CO = T.let(:CO, Orb::CustomerTaxID::Country::TaggedSymbol)
221
226
  CR = T.let(:CR, Orb::CustomerTaxID::Country::TaggedSymbol)
222
227
  CV = T.let(:CV, Orb::CustomerTaxID::Country::TaggedSymbol)
223
- DE = T.let(:DE, Orb::CustomerTaxID::Country::TaggedSymbol)
224
228
  CY = T.let(:CY, Orb::CustomerTaxID::Country::TaggedSymbol)
225
229
  CZ = T.let(:CZ, Orb::CustomerTaxID::Country::TaggedSymbol)
230
+ DE = T.let(:DE, Orb::CustomerTaxID::Country::TaggedSymbol)
226
231
  DK = T.let(:DK, Orb::CustomerTaxID::Country::TaggedSymbol)
227
232
  DO = T.let(:DO, Orb::CustomerTaxID::Country::TaggedSymbol)
228
233
  EC = T.let(:EC, Orb::CustomerTaxID::Country::TaggedSymbol)
@@ -232,9 +237,11 @@ module Orb
232
237
  ET = T.let(:ET, Orb::CustomerTaxID::Country::TaggedSymbol)
233
238
  EU = T.let(:EU, Orb::CustomerTaxID::Country::TaggedSymbol)
234
239
  FI = T.let(:FI, Orb::CustomerTaxID::Country::TaggedSymbol)
240
+ FO = T.let(:FO, Orb::CustomerTaxID::Country::TaggedSymbol)
235
241
  FR = T.let(:FR, Orb::CustomerTaxID::Country::TaggedSymbol)
236
242
  GB = T.let(:GB, Orb::CustomerTaxID::Country::TaggedSymbol)
237
243
  GE = T.let(:GE, Orb::CustomerTaxID::Country::TaggedSymbol)
244
+ GI = T.let(:GI, Orb::CustomerTaxID::Country::TaggedSymbol)
238
245
  GN = T.let(:GN, Orb::CustomerTaxID::Country::TaggedSymbol)
239
246
  GR = T.let(:GR, Orb::CustomerTaxID::Country::TaggedSymbol)
240
247
  HK = T.let(:HK, Orb::CustomerTaxID::Country::TaggedSymbol)
@@ -254,6 +261,7 @@ module Orb
254
261
  KZ = T.let(:KZ, Orb::CustomerTaxID::Country::TaggedSymbol)
255
262
  LA = T.let(:LA, Orb::CustomerTaxID::Country::TaggedSymbol)
256
263
  LI = T.let(:LI, Orb::CustomerTaxID::Country::TaggedSymbol)
264
+ LK = T.let(:LK, Orb::CustomerTaxID::Country::TaggedSymbol)
257
265
  LT = T.let(:LT, Orb::CustomerTaxID::Country::TaggedSymbol)
258
266
  LU = T.let(:LU, Orb::CustomerTaxID::Country::TaggedSymbol)
259
267
  LV = T.let(:LV, Orb::CustomerTaxID::Country::TaggedSymbol)
@@ -275,6 +283,7 @@ module Orb
275
283
  PH = T.let(:PH, Orb::CustomerTaxID::Country::TaggedSymbol)
276
284
  PL = T.let(:PL, Orb::CustomerTaxID::Country::TaggedSymbol)
277
285
  PT = T.let(:PT, Orb::CustomerTaxID::Country::TaggedSymbol)
286
+ PY = T.let(:PY, Orb::CustomerTaxID::Country::TaggedSymbol)
278
287
  RO = T.let(:RO, Orb::CustomerTaxID::Country::TaggedSymbol)
279
288
  RS = T.let(:RS, Orb::CustomerTaxID::Country::TaggedSymbol)
280
289
  RU = T.let(:RU, Orb::CustomerTaxID::Country::TaggedSymbol)
@@ -360,8 +369,10 @@ module Orb
360
369
  ES_CIF = T.let(:es_cif, Orb::CustomerTaxID::Type::TaggedSymbol)
361
370
  ET_TIN = T.let(:et_tin, Orb::CustomerTaxID::Type::TaggedSymbol)
362
371
  EU_OSS_VAT = T.let(:eu_oss_vat, Orb::CustomerTaxID::Type::TaggedSymbol)
372
+ FO_VAT = T.let(:fo_vat, Orb::CustomerTaxID::Type::TaggedSymbol)
363
373
  GB_VAT = T.let(:gb_vat, Orb::CustomerTaxID::Type::TaggedSymbol)
364
374
  GE_VAT = T.let(:ge_vat, Orb::CustomerTaxID::Type::TaggedSymbol)
375
+ GI_TIN = T.let(:gi_tin, Orb::CustomerTaxID::Type::TaggedSymbol)
365
376
  GN_NIF = T.let(:gn_nif, Orb::CustomerTaxID::Type::TaggedSymbol)
366
377
  HK_BR = T.let(:hk_br, Orb::CustomerTaxID::Type::TaggedSymbol)
367
378
  HR_OIB = T.let(:hr_oib, Orb::CustomerTaxID::Type::TaggedSymbol)
@@ -370,6 +381,7 @@ module Orb
370
381
  IL_VAT = T.let(:il_vat, Orb::CustomerTaxID::Type::TaggedSymbol)
371
382
  IN_GST = T.let(:in_gst, Orb::CustomerTaxID::Type::TaggedSymbol)
372
383
  IS_VAT = T.let(:is_vat, Orb::CustomerTaxID::Type::TaggedSymbol)
384
+ IT_CF = T.let(:it_cf, Orb::CustomerTaxID::Type::TaggedSymbol)
373
385
  JP_CN = T.let(:jp_cn, Orb::CustomerTaxID::Type::TaggedSymbol)
374
386
  JP_RN = T.let(:jp_rn, Orb::CustomerTaxID::Type::TaggedSymbol)
375
387
  JP_TRN = T.let(:jp_trn, Orb::CustomerTaxID::Type::TaggedSymbol)
@@ -381,6 +393,7 @@ module Orb
381
393
  LA_TIN = T.let(:la_tin, Orb::CustomerTaxID::Type::TaggedSymbol)
382
394
  LI_UID = T.let(:li_uid, Orb::CustomerTaxID::Type::TaggedSymbol)
383
395
  LI_VAT = T.let(:li_vat, Orb::CustomerTaxID::Type::TaggedSymbol)
396
+ LK_VAT = T.let(:lk_vat, Orb::CustomerTaxID::Type::TaggedSymbol)
384
397
  MA_VAT = T.let(:ma_vat, Orb::CustomerTaxID::Type::TaggedSymbol)
385
398
  MD_VAT = T.let(:md_vat, Orb::CustomerTaxID::Type::TaggedSymbol)
386
399
  ME_PIB = T.let(:me_pib, Orb::CustomerTaxID::Type::TaggedSymbol)
@@ -399,6 +412,7 @@ module Orb
399
412
  PE_RUC = T.let(:pe_ruc, Orb::CustomerTaxID::Type::TaggedSymbol)
400
413
  PH_TIN = T.let(:ph_tin, Orb::CustomerTaxID::Type::TaggedSymbol)
401
414
  PL_NIP = T.let(:pl_nip, Orb::CustomerTaxID::Type::TaggedSymbol)
415
+ PY_RUC = T.let(:py_ruc, Orb::CustomerTaxID::Type::TaggedSymbol)
402
416
  RO_TIN = T.let(:ro_tin, Orb::CustomerTaxID::Type::TaggedSymbol)
403
417
  RS_PIB = T.let(:rs_pib, Orb::CustomerTaxID::Type::TaggedSymbol)
404
418
  RU_INN = T.let(:ru_inn, Orb::CustomerTaxID::Type::TaggedSymbol)
@@ -11,6 +11,9 @@ module Orb
11
11
  T.any(Orb::CustomerUpdateByExternalIDParams, Orb::Internal::AnyHash)
12
12
  end
13
13
 
14
+ sig { returns(String) }
15
+ attr_accessor :id
16
+
14
17
  sig { returns(T.nilable(Orb::NewAccountingSyncConfiguration)) }
15
18
  attr_reader :accounting_sync_configuration
16
19
 
@@ -47,11 +50,18 @@ module Orb
47
50
  sig { params(billing_address: T.nilable(Orb::AddressInput::OrHash)).void }
48
51
  attr_writer :billing_address
49
52
 
50
- # An ISO 4217 currency string used for the customer's invoices and balance. If not
51
- # set at creation time, will be set at subscription creation time.
53
+ # An ISO 4217 currency string used for the customer's invoices and balance. This
54
+ # can only be set if the customer does not already have a currency configured. If
55
+ # not set at creation or update time, it will be set at subscription creation
56
+ # time.
52
57
  sig { returns(T.nilable(String)) }
53
58
  attr_accessor :currency
54
59
 
60
+ # The Orb ID of the payment method to set as this customer's default. Pass `null`
61
+ # to clear the customer's default payment method.
62
+ sig { returns(T.nilable(String)) }
63
+ attr_accessor :default_payment_method_id
64
+
55
65
  # A valid customer email, to be used for invoicing and notifications.
56
66
  sig { returns(T.nilable(String)) }
57
67
  attr_accessor :email
@@ -218,11 +228,13 @@ module Orb
218
228
  # | Estonia | `eu_vat` | European VAT Number |
219
229
  # | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
220
230
  # | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
231
+ # | Faroe Islands | `fo_vat` | Faroe Islands VAT Number |
221
232
  # | Finland | `eu_vat` | European VAT Number |
222
233
  # | France | `eu_vat` | European VAT Number |
223
234
  # | Georgia | `ge_vat` | Georgian VAT |
224
235
  # | Germany | `de_stn` | German Tax Number (Steuernummer) |
225
236
  # | Germany | `eu_vat` | European VAT Number |
237
+ # | Gibraltar | `gi_tin` | Gibraltar Tax Identification Number |
226
238
  # | Greece | `eu_vat` | European VAT Number |
227
239
  # | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
228
240
  # | Hong Kong | `hk_br` | Hong Kong BR Number |
@@ -234,6 +246,7 @@ module Orb
234
246
  # | Ireland | `eu_vat` | European VAT Number |
235
247
  # | Israel | `il_vat` | Israel VAT |
236
248
  # | Italy | `eu_vat` | European VAT Number |
249
+ # | Italy | `it_cf` | Italian Codice Fiscale Number |
237
250
  # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
238
251
  # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
239
252
  # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
@@ -264,6 +277,7 @@ module Orb
264
277
  # | Norway | `no_vat` | Norwegian VAT Number |
265
278
  # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
266
279
  # | Oman | `om_vat` | Omani VAT Number |
280
+ # | Paraguay | `py_ruc` | Paraguayan RUC Number |
267
281
  # | Peru | `pe_ruc` | Peruvian RUC Number |
268
282
  # | Philippines | `ph_tin` | Philippines Tax Identification Number |
269
283
  # | Poland | `eu_vat` | European VAT Number |
@@ -285,6 +299,7 @@ module Orb
285
299
  # | South Korea | `kr_brn` | Korean BRN |
286
300
  # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
287
301
  # | Spain | `eu_vat` | European VAT Number |
302
+ # | Sri Lanka | `lk_vat` | Sri Lanka VAT Number |
288
303
  # | Suriname | `sr_fin` | Suriname FIN Number |
289
304
  # | Sweden | `eu_vat` | European VAT Number |
290
305
  # | Switzerland | `ch_uid` | Switzerland UID Number |
@@ -314,6 +329,7 @@ module Orb
314
329
 
315
330
  sig do
316
331
  params(
332
+ id: String,
317
333
  accounting_sync_configuration:
318
334
  T.nilable(Orb::NewAccountingSyncConfiguration::OrHash),
319
335
  additional_emails: T.nilable(T::Array[String]),
@@ -321,6 +337,7 @@ module Orb
321
337
  auto_issuance: T.nilable(T::Boolean),
322
338
  billing_address: T.nilable(Orb::AddressInput::OrHash),
323
339
  currency: T.nilable(String),
340
+ default_payment_method_id: T.nilable(String),
324
341
  email: T.nilable(String),
325
342
  email_delivery: T.nilable(T::Boolean),
326
343
  external_customer_id: T.nilable(String),
@@ -355,6 +372,7 @@ module Orb
355
372
  ).returns(T.attached_class)
356
373
  end
357
374
  def self.new(
375
+ id:,
358
376
  accounting_sync_configuration: nil,
359
377
  # Additional email addresses for this customer. If populated, these email
360
378
  # addresses will be CC'd for customer communications. The total number of email
@@ -370,9 +388,14 @@ module Orb
370
388
  # will be inherited from the account-level setting.
371
389
  auto_issuance: nil,
372
390
  billing_address: nil,
373
- # An ISO 4217 currency string used for the customer's invoices and balance. If not
374
- # set at creation time, will be set at subscription creation time.
391
+ # An ISO 4217 currency string used for the customer's invoices and balance. This
392
+ # can only be set if the customer does not already have a currency configured. If
393
+ # not set at creation or update time, it will be set at subscription creation
394
+ # time.
375
395
  currency: nil,
396
+ # The Orb ID of the payment method to set as this customer's default. Pass `null`
397
+ # to clear the customer's default payment method.
398
+ default_payment_method_id: nil,
376
399
  # A valid customer email, to be used for invoicing and notifications.
377
400
  email: nil,
378
401
  email_delivery: nil,
@@ -464,11 +487,13 @@ module Orb
464
487
  # | Estonia | `eu_vat` | European VAT Number |
465
488
  # | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
466
489
  # | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
490
+ # | Faroe Islands | `fo_vat` | Faroe Islands VAT Number |
467
491
  # | Finland | `eu_vat` | European VAT Number |
468
492
  # | France | `eu_vat` | European VAT Number |
469
493
  # | Georgia | `ge_vat` | Georgian VAT |
470
494
  # | Germany | `de_stn` | German Tax Number (Steuernummer) |
471
495
  # | Germany | `eu_vat` | European VAT Number |
496
+ # | Gibraltar | `gi_tin` | Gibraltar Tax Identification Number |
472
497
  # | Greece | `eu_vat` | European VAT Number |
473
498
  # | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
474
499
  # | Hong Kong | `hk_br` | Hong Kong BR Number |
@@ -480,6 +505,7 @@ module Orb
480
505
  # | Ireland | `eu_vat` | European VAT Number |
481
506
  # | Israel | `il_vat` | Israel VAT |
482
507
  # | Italy | `eu_vat` | European VAT Number |
508
+ # | Italy | `it_cf` | Italian Codice Fiscale Number |
483
509
  # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
484
510
  # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
485
511
  # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
@@ -510,6 +536,7 @@ module Orb
510
536
  # | Norway | `no_vat` | Norwegian VAT Number |
511
537
  # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
512
538
  # | Oman | `om_vat` | Omani VAT Number |
539
+ # | Paraguay | `py_ruc` | Paraguayan RUC Number |
513
540
  # | Peru | `pe_ruc` | Peruvian RUC Number |
514
541
  # | Philippines | `ph_tin` | Philippines Tax Identification Number |
515
542
  # | Poland | `eu_vat` | European VAT Number |
@@ -531,6 +558,7 @@ module Orb
531
558
  # | South Korea | `kr_brn` | Korean BRN |
532
559
  # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
533
560
  # | Spain | `eu_vat` | European VAT Number |
561
+ # | Sri Lanka | `lk_vat` | Sri Lanka VAT Number |
534
562
  # | Suriname | `sr_fin` | Suriname FIN Number |
535
563
  # | Sweden | `eu_vat` | European VAT Number |
536
564
  # | Switzerland | `ch_uid` | Switzerland UID Number |
@@ -560,6 +588,7 @@ module Orb
560
588
  sig do
561
589
  override.returns(
562
590
  {
591
+ id: String,
563
592
  accounting_sync_configuration:
564
593
  T.nilable(Orb::NewAccountingSyncConfiguration),
565
594
  additional_emails: T.nilable(T::Array[String]),
@@ -567,6 +596,7 @@ module Orb
567
596
  auto_issuance: T.nilable(T::Boolean),
568
597
  billing_address: T.nilable(Orb::AddressInput),
569
598
  currency: T.nilable(String),
599
+ default_payment_method_id: T.nilable(String),
570
600
  email: T.nilable(String),
571
601
  email_delivery: T.nilable(T::Boolean),
572
602
  external_customer_id: T.nilable(String),
@@ -680,6 +710,12 @@ module Orb
680
710
  end
681
711
  attr_accessor :provider_type
682
712
 
713
+ # The ID of a shared payment token granted by an agent to use as the default
714
+ # payment instrument for this customer. When set, auto-collection will use this
715
+ # token instead of the customer's default payment method.
716
+ sig { returns(T.nilable(String)) }
717
+ attr_accessor :default_shared_payment_token
718
+
683
719
  # List of Stripe payment method types to exclude for this customer. Excluded
684
720
  # payment methods will not be available for the customer to select during payment,
685
721
  # and will not be used for auto-collection. If a customer's default payment method
@@ -695,12 +731,17 @@ module Orb
695
731
  params(
696
732
  provider_type:
697
733
  Orb::CustomerUpdateByExternalIDParams::PaymentConfiguration::PaymentProvider::ProviderType::OrSymbol,
734
+ default_shared_payment_token: T.nilable(String),
698
735
  excluded_payment_method_types: T::Array[String]
699
736
  ).returns(T.attached_class)
700
737
  end
701
738
  def self.new(
702
739
  # The payment provider to configure.
703
740
  provider_type:,
741
+ # The ID of a shared payment token granted by an agent to use as the default
742
+ # payment instrument for this customer. When set, auto-collection will use this
743
+ # token instead of the customer's default payment method.
744
+ default_shared_payment_token: nil,
704
745
  # List of Stripe payment method types to exclude for this customer. Excluded
705
746
  # payment methods will not be available for the customer to select during payment,
706
747
  # and will not be used for auto-collection. If a customer's default payment method
@@ -715,6 +756,7 @@ module Orb
715
756
  {
716
757
  provider_type:
717
758
  Orb::CustomerUpdateByExternalIDParams::PaymentConfiguration::PaymentProvider::ProviderType::OrSymbol,
759
+ default_shared_payment_token: T.nilable(String),
718
760
  excluded_payment_method_types: T::Array[String]
719
761
  }
720
762
  )
@@ -798,6 +840,11 @@ module Orb
798
840
  :netsuite,
799
841
  Orb::CustomerUpdateByExternalIDParams::PaymentProvider::TaggedSymbol
800
842
  )
843
+ ADYEN =
844
+ T.let(
845
+ :adyen,
846
+ Orb::CustomerUpdateByExternalIDParams::PaymentProvider::TaggedSymbol
847
+ )
801
848
 
802
849
  sig do
803
850
  override.returns(
@@ -11,6 +11,9 @@ module Orb
11
11
  T.any(Orb::CustomerUpdateParams, Orb::Internal::AnyHash)
12
12
  end
13
13
 
14
+ sig { returns(String) }
15
+ attr_accessor :customer_id
16
+
14
17
  sig { returns(T.nilable(Orb::NewAccountingSyncConfiguration)) }
15
18
  attr_reader :accounting_sync_configuration
16
19
 
@@ -47,11 +50,18 @@ module Orb
47
50
  sig { params(billing_address: T.nilable(Orb::AddressInput::OrHash)).void }
48
51
  attr_writer :billing_address
49
52
 
50
- # An ISO 4217 currency string used for the customer's invoices and balance. If not
51
- # set at creation time, will be set at subscription creation time.
53
+ # An ISO 4217 currency string used for the customer's invoices and balance. This
54
+ # can only be set if the customer does not already have a currency configured. If
55
+ # not set at creation or update time, it will be set at subscription creation
56
+ # time.
52
57
  sig { returns(T.nilable(String)) }
53
58
  attr_accessor :currency
54
59
 
60
+ # The Orb ID of the payment method to set as this customer's default. Pass `null`
61
+ # to clear the customer's default payment method.
62
+ sig { returns(T.nilable(String)) }
63
+ attr_accessor :default_payment_method_id
64
+
55
65
  # A valid customer email, to be used for invoicing and notifications.
56
66
  sig { returns(T.nilable(String)) }
57
67
  attr_accessor :email
@@ -210,11 +220,13 @@ module Orb
210
220
  # | Estonia | `eu_vat` | European VAT Number |
211
221
  # | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
212
222
  # | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
223
+ # | Faroe Islands | `fo_vat` | Faroe Islands VAT Number |
213
224
  # | Finland | `eu_vat` | European VAT Number |
214
225
  # | France | `eu_vat` | European VAT Number |
215
226
  # | Georgia | `ge_vat` | Georgian VAT |
216
227
  # | Germany | `de_stn` | German Tax Number (Steuernummer) |
217
228
  # | Germany | `eu_vat` | European VAT Number |
229
+ # | Gibraltar | `gi_tin` | Gibraltar Tax Identification Number |
218
230
  # | Greece | `eu_vat` | European VAT Number |
219
231
  # | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
220
232
  # | Hong Kong | `hk_br` | Hong Kong BR Number |
@@ -226,6 +238,7 @@ module Orb
226
238
  # | Ireland | `eu_vat` | European VAT Number |
227
239
  # | Israel | `il_vat` | Israel VAT |
228
240
  # | Italy | `eu_vat` | European VAT Number |
241
+ # | Italy | `it_cf` | Italian Codice Fiscale Number |
229
242
  # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
230
243
  # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
231
244
  # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
@@ -256,6 +269,7 @@ module Orb
256
269
  # | Norway | `no_vat` | Norwegian VAT Number |
257
270
  # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
258
271
  # | Oman | `om_vat` | Omani VAT Number |
272
+ # | Paraguay | `py_ruc` | Paraguayan RUC Number |
259
273
  # | Peru | `pe_ruc` | Peruvian RUC Number |
260
274
  # | Philippines | `ph_tin` | Philippines Tax Identification Number |
261
275
  # | Poland | `eu_vat` | European VAT Number |
@@ -277,6 +291,7 @@ module Orb
277
291
  # | South Korea | `kr_brn` | Korean BRN |
278
292
  # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
279
293
  # | Spain | `eu_vat` | European VAT Number |
294
+ # | Sri Lanka | `lk_vat` | Sri Lanka VAT Number |
280
295
  # | Suriname | `sr_fin` | Suriname FIN Number |
281
296
  # | Sweden | `eu_vat` | European VAT Number |
282
297
  # | Switzerland | `ch_uid` | Switzerland UID Number |
@@ -306,6 +321,7 @@ module Orb
306
321
 
307
322
  sig do
308
323
  params(
324
+ customer_id: String,
309
325
  accounting_sync_configuration:
310
326
  T.nilable(Orb::NewAccountingSyncConfiguration::OrHash),
311
327
  additional_emails: T.nilable(T::Array[String]),
@@ -313,6 +329,7 @@ module Orb
313
329
  auto_issuance: T.nilable(T::Boolean),
314
330
  billing_address: T.nilable(Orb::AddressInput::OrHash),
315
331
  currency: T.nilable(String),
332
+ default_payment_method_id: T.nilable(String),
316
333
  email: T.nilable(String),
317
334
  email_delivery: T.nilable(T::Boolean),
318
335
  external_customer_id: T.nilable(String),
@@ -343,6 +360,7 @@ module Orb
343
360
  ).returns(T.attached_class)
344
361
  end
345
362
  def self.new(
363
+ customer_id:,
346
364
  accounting_sync_configuration: nil,
347
365
  # Additional email addresses for this customer. If populated, these email
348
366
  # addresses will be CC'd for customer communications. The total number of email
@@ -358,9 +376,14 @@ module Orb
358
376
  # will be inherited from the account-level setting.
359
377
  auto_issuance: nil,
360
378
  billing_address: nil,
361
- # An ISO 4217 currency string used for the customer's invoices and balance. If not
362
- # set at creation time, will be set at subscription creation time.
379
+ # An ISO 4217 currency string used for the customer's invoices and balance. This
380
+ # can only be set if the customer does not already have a currency configured. If
381
+ # not set at creation or update time, it will be set at subscription creation
382
+ # time.
363
383
  currency: nil,
384
+ # The Orb ID of the payment method to set as this customer's default. Pass `null`
385
+ # to clear the customer's default payment method.
386
+ default_payment_method_id: nil,
364
387
  # A valid customer email, to be used for invoicing and notifications.
365
388
  email: nil,
366
389
  email_delivery: nil,
@@ -452,11 +475,13 @@ module Orb
452
475
  # | Estonia | `eu_vat` | European VAT Number |
453
476
  # | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
454
477
  # | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
478
+ # | Faroe Islands | `fo_vat` | Faroe Islands VAT Number |
455
479
  # | Finland | `eu_vat` | European VAT Number |
456
480
  # | France | `eu_vat` | European VAT Number |
457
481
  # | Georgia | `ge_vat` | Georgian VAT |
458
482
  # | Germany | `de_stn` | German Tax Number (Steuernummer) |
459
483
  # | Germany | `eu_vat` | European VAT Number |
484
+ # | Gibraltar | `gi_tin` | Gibraltar Tax Identification Number |
460
485
  # | Greece | `eu_vat` | European VAT Number |
461
486
  # | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
462
487
  # | Hong Kong | `hk_br` | Hong Kong BR Number |
@@ -468,6 +493,7 @@ module Orb
468
493
  # | Ireland | `eu_vat` | European VAT Number |
469
494
  # | Israel | `il_vat` | Israel VAT |
470
495
  # | Italy | `eu_vat` | European VAT Number |
496
+ # | Italy | `it_cf` | Italian Codice Fiscale Number |
471
497
  # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
472
498
  # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
473
499
  # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
@@ -498,6 +524,7 @@ module Orb
498
524
  # | Norway | `no_vat` | Norwegian VAT Number |
499
525
  # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
500
526
  # | Oman | `om_vat` | Omani VAT Number |
527
+ # | Paraguay | `py_ruc` | Paraguayan RUC Number |
501
528
  # | Peru | `pe_ruc` | Peruvian RUC Number |
502
529
  # | Philippines | `ph_tin` | Philippines Tax Identification Number |
503
530
  # | Poland | `eu_vat` | European VAT Number |
@@ -519,6 +546,7 @@ module Orb
519
546
  # | South Korea | `kr_brn` | Korean BRN |
520
547
  # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
521
548
  # | Spain | `eu_vat` | European VAT Number |
549
+ # | Sri Lanka | `lk_vat` | Sri Lanka VAT Number |
522
550
  # | Suriname | `sr_fin` | Suriname FIN Number |
523
551
  # | Sweden | `eu_vat` | European VAT Number |
524
552
  # | Switzerland | `ch_uid` | Switzerland UID Number |
@@ -548,6 +576,7 @@ module Orb
548
576
  sig do
549
577
  override.returns(
550
578
  {
579
+ customer_id: String,
551
580
  accounting_sync_configuration:
552
581
  T.nilable(Orb::NewAccountingSyncConfiguration),
553
582
  additional_emails: T.nilable(T::Array[String]),
@@ -555,6 +584,7 @@ module Orb
555
584
  auto_issuance: T.nilable(T::Boolean),
556
585
  billing_address: T.nilable(Orb::AddressInput),
557
586
  currency: T.nilable(String),
587
+ default_payment_method_id: T.nilable(String),
558
588
  email: T.nilable(String),
559
589
  email_delivery: T.nilable(T::Boolean),
560
590
  external_customer_id: T.nilable(String),
@@ -664,6 +694,12 @@ module Orb
664
694
  end
665
695
  attr_accessor :provider_type
666
696
 
697
+ # The ID of a shared payment token granted by an agent to use as the default
698
+ # payment instrument for this customer. When set, auto-collection will use this
699
+ # token instead of the customer's default payment method.
700
+ sig { returns(T.nilable(String)) }
701
+ attr_accessor :default_shared_payment_token
702
+
667
703
  # List of Stripe payment method types to exclude for this customer. Excluded
668
704
  # payment methods will not be available for the customer to select during payment,
669
705
  # and will not be used for auto-collection. If a customer's default payment method
@@ -679,12 +715,17 @@ module Orb
679
715
  params(
680
716
  provider_type:
681
717
  Orb::CustomerUpdateParams::PaymentConfiguration::PaymentProvider::ProviderType::OrSymbol,
718
+ default_shared_payment_token: T.nilable(String),
682
719
  excluded_payment_method_types: T::Array[String]
683
720
  ).returns(T.attached_class)
684
721
  end
685
722
  def self.new(
686
723
  # The payment provider to configure.
687
724
  provider_type:,
725
+ # The ID of a shared payment token granted by an agent to use as the default
726
+ # payment instrument for this customer. When set, auto-collection will use this
727
+ # token instead of the customer's default payment method.
728
+ default_shared_payment_token: nil,
688
729
  # List of Stripe payment method types to exclude for this customer. Excluded
689
730
  # payment methods will not be available for the customer to select during payment,
690
731
  # and will not be used for auto-collection. If a customer's default payment method
@@ -699,6 +740,7 @@ module Orb
699
740
  {
700
741
  provider_type:
701
742
  Orb::CustomerUpdateParams::PaymentConfiguration::PaymentProvider::ProviderType::OrSymbol,
743
+ default_shared_payment_token: T.nilable(String),
702
744
  excluded_payment_method_types: T::Array[String]
703
745
  }
704
746
  )
@@ -779,6 +821,11 @@ module Orb
779
821
  :netsuite,
780
822
  Orb::CustomerUpdateParams::PaymentProvider::TaggedSymbol
781
823
  )
824
+ ADYEN =
825
+ T.let(
826
+ :adyen,
827
+ Orb::CustomerUpdateParams::PaymentProvider::TaggedSymbol
828
+ )
782
829
 
783
830
  sig do
784
831
  override.returns(
@@ -15,6 +15,9 @@ module Orb
15
15
  )
16
16
  end
17
17
 
18
+ sig { returns(String) }
19
+ attr_accessor :customer_id
20
+
18
21
  sig { returns(String) }
19
22
  attr_accessor :amount
20
23
 
@@ -31,6 +34,7 @@ module Orb
31
34
 
32
35
  sig do
33
36
  params(
37
+ customer_id: String,
34
38
  amount: String,
35
39
  type:
36
40
  Orb::Customers::BalanceTransactionCreateParams::Type::OrSymbol,
@@ -39,6 +43,7 @@ module Orb
39
43
  ).returns(T.attached_class)
40
44
  end
41
45
  def self.new(
46
+ customer_id:,
42
47
  amount:,
43
48
  type:,
44
49
  # An optional description that can be specified around this entry.
@@ -50,6 +55,7 @@ module Orb
50
55
  sig do
51
56
  override.returns(
52
57
  {
58
+ customer_id: String,
53
59
  amount: String,
54
60
  type:
55
61
  Orb::Customers::BalanceTransactionCreateParams::Type::OrSymbol,
@@ -15,6 +15,9 @@ module Orb
15
15
  )
16
16
  end
17
17
 
18
+ sig { returns(String) }
19
+ attr_accessor :customer_id
20
+
18
21
  # Cursor for pagination. This can be populated by the `next_cursor` value returned
19
22
  # from the initial request.
20
23
  sig { returns(T.nilable(String)) }
@@ -41,6 +44,7 @@ module Orb
41
44
 
42
45
  sig do
43
46
  params(
47
+ customer_id: String,
44
48
  cursor: T.nilable(String),
45
49
  limit: Integer,
46
50
  operation_time_gt: T.nilable(Time),
@@ -51,6 +55,7 @@ module Orb
51
55
  ).returns(T.attached_class)
52
56
  end
53
57
  def self.new(
58
+ customer_id:,
54
59
  # Cursor for pagination. This can be populated by the `next_cursor` value returned
55
60
  # from the initial request.
56
61
  cursor: nil,
@@ -67,6 +72,7 @@ module Orb
67
72
  sig do
68
73
  override.returns(
69
74
  {
75
+ customer_id: String,
70
76
  cursor: T.nilable(String),
71
77
  limit: Integer,
72
78
  operation_time_gt: T.nilable(Time),
@@ -15,6 +15,9 @@ module Orb
15
15
  )
16
16
  end
17
17
 
18
+ sig { returns(String) }
19
+ attr_accessor :external_customer_id
20
+
18
21
  # The currency or custom pricing unit to use.
19
22
  sig { returns(T.nilable(String)) }
20
23
  attr_accessor :currency
@@ -42,6 +45,7 @@ module Orb
42
45
 
43
46
  sig do
44
47
  params(
48
+ external_customer_id: String,
45
49
  currency: T.nilable(String),
46
50
  timeframe_end: T.nilable(Time),
47
51
  timeframe_start: T.nilable(Time),
@@ -53,6 +57,7 @@ module Orb
53
57
  ).returns(T.attached_class)
54
58
  end
55
59
  def self.new(
60
+ external_customer_id:,
56
61
  # The currency or custom pricing unit to use.
57
62
  currency: nil,
58
63
  # Costs returned are exclusive of `timeframe_end`.
@@ -71,6 +76,7 @@ module Orb
71
76
  sig do
72
77
  override.returns(
73
78
  {
79
+ external_customer_id: String,
74
80
  currency: T.nilable(String),
75
81
  timeframe_end: T.nilable(Time),
76
82
  timeframe_start: T.nilable(Time),