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
@@ -7,7 +7,13 @@ module Orb
7
7
  extend Orb::Internal::Type::RequestParameters::Converter
8
8
  include Orb::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute block_id
11
+ #
12
+ # @return [String]
13
+ required :block_id, String
14
+
15
+ # @!method initialize(block_id:, request_options: {})
16
+ # @param block_id [String]
11
17
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -14,6 +14,15 @@ module Orb
14
14
  # @return [Float]
15
15
  required :balance, Float
16
16
 
17
+ # @!attribute credit_block_source
18
+ # How this credit block was created: `allocation` (a subscription's recurring
19
+ # credit allocation), `top_up` (an automatic balance-threshold top-up), or
20
+ # `manual` (a manual credit ledger increment, including credits voided or expired
21
+ # off another block).
22
+ #
23
+ # @return [Symbol, Orb::Models::CreditBlockRetrieveResponse::CreditBlockSource]
24
+ required :credit_block_source, enum: -> { Orb::Models::CreditBlockRetrieveResponse::CreditBlockSource }
25
+
17
26
  # @!attribute effective_date
18
27
  #
19
28
  # @return [Time, nil]
@@ -53,7 +62,14 @@ module Orb
53
62
  # @return [Symbol, Orb::Models::CreditBlockRetrieveResponse::Status]
54
63
  required :status, enum: -> { Orb::Models::CreditBlockRetrieveResponse::Status }
55
64
 
56
- # @!method initialize(id:, balance:, effective_date:, expiry_date:, filters:, maximum_initial_balance:, metadata:, per_unit_cost_basis:, status:)
65
+ # @!attribute credit_allocation
66
+ # The credit allocation that funded a block. Extends the allocation resource
67
+ # serialized on prices with the catalog-item attribution of the funding price.
68
+ #
69
+ # @return [Orb::Models::CreditBlockRetrieveResponse::CreditAllocation, nil]
70
+ optional :credit_allocation, -> { Orb::Models::CreditBlockRetrieveResponse::CreditAllocation }, nil?: true
71
+
72
+ # @!method initialize(id:, balance:, credit_block_source:, effective_date:, expiry_date:, filters:, maximum_initial_balance:, metadata:, per_unit_cost_basis:, status:, credit_allocation: nil)
57
73
  # Some parameter documentations has been truncated, see
58
74
  # {Orb::Models::CreditBlockRetrieveResponse} for more details.
59
75
  #
@@ -63,6 +79,8 @@ module Orb
63
79
  #
64
80
  # @param balance [Float]
65
81
  #
82
+ # @param credit_block_source [Symbol, Orb::Models::CreditBlockRetrieveResponse::CreditBlockSource] How this credit block was created: `allocation` (a subscription's recurring cred
83
+ #
66
84
  # @param effective_date [Time, nil]
67
85
  #
68
86
  # @param expiry_date [Time, nil]
@@ -76,6 +94,25 @@ module Orb
76
94
  # @param per_unit_cost_basis [String, nil]
77
95
  #
78
96
  # @param status [Symbol, Orb::Models::CreditBlockRetrieveResponse::Status]
97
+ #
98
+ # @param credit_allocation [Orb::Models::CreditBlockRetrieveResponse::CreditAllocation, nil] The credit allocation that funded a block. Extends the allocation resource
99
+
100
+ # How this credit block was created: `allocation` (a subscription's recurring
101
+ # credit allocation), `top_up` (an automatic balance-threshold top-up), or
102
+ # `manual` (a manual credit ledger increment, including credits voided or expired
103
+ # off another block).
104
+ #
105
+ # @see Orb::Models::CreditBlockRetrieveResponse#credit_block_source
106
+ module CreditBlockSource
107
+ extend Orb::Internal::Type::Enum
108
+
109
+ ALLOCATION = :allocation
110
+ TOP_UP = :top_up
111
+ MANUAL = :manual
112
+
113
+ # @!method self.values
114
+ # @return [Array<Symbol>]
115
+ end
79
116
 
80
117
  class Filter < Orb::Internal::Type::BaseModel
81
118
  # @!attribute field
@@ -143,6 +180,118 @@ module Orb
143
180
  # @!method self.values
144
181
  # @return [Array<Symbol>]
145
182
  end
183
+
184
+ # @see Orb::Models::CreditBlockRetrieveResponse#credit_allocation
185
+ class CreditAllocation < Orb::Internal::Type::BaseModel
186
+ # @!attribute allows_rollover
187
+ #
188
+ # @return [Boolean]
189
+ required :allows_rollover, Orb::Internal::Type::Boolean
190
+
191
+ # @!attribute currency
192
+ #
193
+ # @return [String]
194
+ required :currency, String
195
+
196
+ # @!attribute custom_expiration
197
+ #
198
+ # @return [Orb::Models::CustomExpiration, nil]
199
+ required :custom_expiration, -> { Orb::CustomExpiration }, nil?: true
200
+
201
+ # @!attribute item_id
202
+ # The ID of the catalog item this block was allocated from, derived from the
203
+ # allocation's price.
204
+ #
205
+ # @return [String]
206
+ required :item_id, String
207
+
208
+ # @!attribute filters
209
+ #
210
+ # @return [Array<Orb::Models::CreditBlockRetrieveResponse::CreditAllocation::Filter>, nil]
211
+ optional :filters,
212
+ -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditBlockRetrieveResponse::CreditAllocation::Filter] }
213
+
214
+ # @!attribute license_type_id
215
+ #
216
+ # @return [String, nil]
217
+ optional :license_type_id, String, nil?: true
218
+
219
+ # @!method initialize(allows_rollover:, currency:, custom_expiration:, item_id:, filters: nil, license_type_id: nil)
220
+ # Some parameter documentations has been truncated, see
221
+ # {Orb::Models::CreditBlockRetrieveResponse::CreditAllocation} for more details.
222
+ #
223
+ # The credit allocation that funded a block. Extends the allocation resource
224
+ # serialized on prices with the catalog-item attribution of the funding price.
225
+ #
226
+ # @param allows_rollover [Boolean]
227
+ #
228
+ # @param currency [String]
229
+ #
230
+ # @param custom_expiration [Orb::Models::CustomExpiration, nil]
231
+ #
232
+ # @param item_id [String] The ID of the catalog item this block was allocated from, derived from the alloc
233
+ #
234
+ # @param filters [Array<Orb::Models::CreditBlockRetrieveResponse::CreditAllocation::Filter>]
235
+ #
236
+ # @param license_type_id [String, nil]
237
+
238
+ class Filter < Orb::Internal::Type::BaseModel
239
+ # @!attribute field
240
+ # The property of the price to filter on.
241
+ #
242
+ # @return [Symbol, Orb::Models::CreditBlockRetrieveResponse::CreditAllocation::Filter::Field]
243
+ required :field, enum: -> { Orb::Models::CreditBlockRetrieveResponse::CreditAllocation::Filter::Field }
244
+
245
+ # @!attribute operator
246
+ # Should prices that match the filter be included or excluded.
247
+ #
248
+ # @return [Symbol, Orb::Models::CreditBlockRetrieveResponse::CreditAllocation::Filter::Operator]
249
+ required :operator,
250
+ enum: -> { Orb::Models::CreditBlockRetrieveResponse::CreditAllocation::Filter::Operator }
251
+
252
+ # @!attribute values
253
+ # The IDs or values that match this filter.
254
+ #
255
+ # @return [Array<String>]
256
+ required :values, Orb::Internal::Type::ArrayOf[String]
257
+
258
+ # @!method initialize(field:, operator:, values:)
259
+ # @param field [Symbol, Orb::Models::CreditBlockRetrieveResponse::CreditAllocation::Filter::Field] The property of the price to filter on.
260
+ #
261
+ # @param operator [Symbol, Orb::Models::CreditBlockRetrieveResponse::CreditAllocation::Filter::Operator] Should prices that match the filter be included or excluded.
262
+ #
263
+ # @param values [Array<String>] The IDs or values that match this filter.
264
+
265
+ # The property of the price to filter on.
266
+ #
267
+ # @see Orb::Models::CreditBlockRetrieveResponse::CreditAllocation::Filter#field
268
+ module Field
269
+ extend Orb::Internal::Type::Enum
270
+
271
+ PRICE_ID = :price_id
272
+ ITEM_ID = :item_id
273
+ PRICE_TYPE = :price_type
274
+ CURRENCY = :currency
275
+ PRICING_UNIT_ID = :pricing_unit_id
276
+
277
+ # @!method self.values
278
+ # @return [Array<Symbol>]
279
+ end
280
+
281
+ # Should prices that match the filter be included or excluded.
282
+ #
283
+ # @see Orb::Models::CreditBlockRetrieveResponse::CreditAllocation::Filter#operator
284
+ module Operator
285
+ extend Orb::Internal::Type::Enum
286
+
287
+ INCLUDES = :includes
288
+ EXCLUDES = :excludes
289
+
290
+ # @!method self.values
291
+ # @return [Array<Symbol>]
292
+ end
293
+ end
294
+ end
146
295
  end
147
296
  end
148
297
  end
@@ -7,7 +7,13 @@ module Orb
7
7
  extend Orb::Internal::Type::RequestParameters::Converter
8
8
  include Orb::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute credit_note_id
11
+ #
12
+ # @return [String]
13
+ required :credit_note_id, String
14
+
15
+ # @!method initialize(credit_note_id:, request_options: {})
16
+ # @param credit_note_id [String]
11
17
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -111,6 +111,10 @@ module Orb
111
111
  required :payment_provider_id, String, nil?: true
112
112
 
113
113
  # @!attribute portal_url
114
+ # Deprecated. Returns the URL of the most recent non-expired portal link, or null.
115
+ # When the account has opted into customer portal sessions, this field always
116
+ # returns null. Use POST /v1/customers/{id}/portal_sessions to mint short-lived
117
+ # portal session URLs.
114
118
  #
115
119
  # @return [String, nil]
116
120
  required :portal_url, String, nil?: true
@@ -178,11 +182,13 @@ module Orb
178
182
  # | Estonia | `eu_vat` | European VAT Number |
179
183
  # | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
180
184
  # | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
185
+ # | Faroe Islands | `fo_vat` | Faroe Islands VAT Number |
181
186
  # | Finland | `eu_vat` | European VAT Number |
182
187
  # | France | `eu_vat` | European VAT Number |
183
188
  # | Georgia | `ge_vat` | Georgian VAT |
184
189
  # | Germany | `de_stn` | German Tax Number (Steuernummer) |
185
190
  # | Germany | `eu_vat` | European VAT Number |
191
+ # | Gibraltar | `gi_tin` | Gibraltar Tax Identification Number |
186
192
  # | Greece | `eu_vat` | European VAT Number |
187
193
  # | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
188
194
  # | Hong Kong | `hk_br` | Hong Kong BR Number |
@@ -194,6 +200,7 @@ module Orb
194
200
  # | Ireland | `eu_vat` | European VAT Number |
195
201
  # | Israel | `il_vat` | Israel VAT |
196
202
  # | Italy | `eu_vat` | European VAT Number |
203
+ # | Italy | `it_cf` | Italian Codice Fiscale Number |
197
204
  # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
198
205
  # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
199
206
  # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
@@ -224,6 +231,7 @@ module Orb
224
231
  # | Norway | `no_vat` | Norwegian VAT Number |
225
232
  # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
226
233
  # | Oman | `om_vat` | Omani VAT Number |
234
+ # | Paraguay | `py_ruc` | Paraguayan RUC Number |
227
235
  # | Peru | `pe_ruc` | Peruvian RUC Number |
228
236
  # | Philippines | `ph_tin` | Philippines Tax Identification Number |
229
237
  # | Poland | `eu_vat` | European VAT Number |
@@ -245,6 +253,7 @@ module Orb
245
253
  # | South Korea | `kr_brn` | Korean BRN |
246
254
  # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
247
255
  # | Spain | `eu_vat` | European VAT Number |
256
+ # | Sri Lanka | `lk_vat` | Sri Lanka VAT Number |
248
257
  # | Suriname | `sr_fin` | Suriname FIN Number |
249
258
  # | Sweden | `eu_vat` | European VAT Number |
250
259
  # | Switzerland | `ch_uid` | Switzerland UID Number |
@@ -290,6 +299,16 @@ module Orb
290
299
  # @return [Boolean, nil]
291
300
  optional :automatic_tax_enabled, Orb::Internal::Type::Boolean, nil?: true
292
301
 
302
+ # @!attribute default_payment_method
303
+ # A payment method represents a customer's stored payment instrument held with an
304
+ # external payment provider (such as Adyen or Stripe).
305
+ #
306
+ # The serialization is intentionally minimal for now; provider-pulled details
307
+ # (e.g. card display metadata) will be added over time.
308
+ #
309
+ # @return [Orb::Models::Customer::DefaultPaymentMethod, nil]
310
+ optional :default_payment_method, -> { Orb::Customer::DefaultPaymentMethod }, nil?: true
311
+
293
312
  # @!attribute payment_configuration
294
313
  # Payment configuration for the customer, applicable when using Orb Invoicing with
295
314
  # a supported payment provider such as Stripe.
@@ -302,7 +321,7 @@ module Orb
302
321
  # @return [Orb::Models::Customer::ReportingConfiguration, nil]
303
322
  optional :reporting_configuration, -> { Orb::Customer::ReportingConfiguration }, nil?: true
304
323
 
305
- # @!method initialize(id:, additional_emails:, auto_collection:, auto_issuance:, balance:, billing_address:, created_at:, currency:, email:, email_delivery:, exempt_from_automated_tax:, external_customer_id:, hierarchy:, metadata:, name:, payment_provider:, payment_provider_id:, portal_url:, shipping_address:, tax_id:, timezone:, accounting_sync_configuration: nil, automatic_tax_enabled: nil, payment_configuration: nil, reporting_configuration: nil)
324
+ # @!method initialize(id:, additional_emails:, auto_collection:, auto_issuance:, balance:, billing_address:, created_at:, currency:, email:, email_delivery:, exempt_from_automated_tax:, external_customer_id:, hierarchy:, metadata:, name:, payment_provider:, payment_provider_id:, portal_url:, shipping_address:, tax_id:, timezone:, accounting_sync_configuration: nil, automatic_tax_enabled: nil, default_payment_method: nil, payment_configuration: nil, reporting_configuration: nil)
306
325
  # Some parameter documentations has been truncated, see {Orb::Models::Customer}
307
326
  # for more details.
308
327
  #
@@ -359,7 +378,7 @@ module Orb
359
378
  #
360
379
  # @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
361
380
  #
362
- # @param portal_url [String, nil]
381
+ # @param portal_url [String, nil] Deprecated. Returns the URL of the most recent non-expired portal link, or null.
363
382
  #
364
383
  # @param shipping_address [Orb::Models::Address, nil]
365
384
  #
@@ -371,6 +390,8 @@ module Orb
371
390
  #
372
391
  # @param automatic_tax_enabled [Boolean, nil] Whether automatic tax calculation is enabled for this customer. This field is nu
373
392
  #
393
+ # @param default_payment_method [Orb::Models::Customer::DefaultPaymentMethod, nil] A payment method represents a customer's stored payment instrument held with an
394
+ #
374
395
  # @param payment_configuration [Orb::Models::Customer::PaymentConfiguration, nil] Payment configuration for the customer, applicable when using Orb Invoicing with
375
396
  #
376
397
  # @param reporting_configuration [Orb::Models::Customer::ReportingConfiguration, nil]
@@ -407,6 +428,7 @@ module Orb
407
428
  STRIPE_CHARGE = :stripe_charge
408
429
  STRIPE_INVOICE = :stripe_invoice
409
430
  NETSUITE = :netsuite
431
+ ADYEN = :adyen
410
432
 
411
433
  # @!method self.values
412
434
  # @return [Array<Symbol>]
@@ -458,6 +480,93 @@ module Orb
458
480
  end
459
481
  end
460
482
 
483
+ # @see Orb::Models::Customer#default_payment_method
484
+ class DefaultPaymentMethod < Orb::Internal::Type::BaseModel
485
+ # @!attribute id
486
+ # The Orb-assigned unique identifier for the payment method.
487
+ #
488
+ # @return [String]
489
+ required :id, String
490
+
491
+ # @!attribute created_at
492
+ # The time at which the payment method was created.
493
+ #
494
+ # @return [Time]
495
+ required :created_at, Time
496
+
497
+ # @!attribute customer_id
498
+ # The ID of the Orb customer this payment method is attached to.
499
+ #
500
+ # @return [String]
501
+ required :customer_id, String
502
+
503
+ # @!attribute default
504
+ # Whether this is the customer's default payment method.
505
+ #
506
+ # @return [Boolean]
507
+ required :default, Orb::Internal::Type::Boolean
508
+
509
+ # @!attribute external_payment_method_id
510
+ # The identifier of this payment method in the external payment provider.
511
+ #
512
+ # @return [String]
513
+ required :external_payment_method_id, String
514
+
515
+ # @!attribute payment_method_type
516
+ # The type of the underlying payment instrument, e.g. `card` or `us_bank_account`.
517
+ #
518
+ # @return [Symbol, Orb::Models::Customer::DefaultPaymentMethod::PaymentMethodType]
519
+ required :payment_method_type, enum: -> { Orb::Customer::DefaultPaymentMethod::PaymentMethodType }
520
+
521
+ # @!attribute provider_type
522
+ # The external payment provider this method belongs to, derived from the linked
523
+ # payment gateway connection (e.g. `adyen` or `stripe`). Null if the connection
524
+ # has been removed.
525
+ #
526
+ # @return [String, nil]
527
+ required :provider_type, String, nil?: true
528
+
529
+ # @!method initialize(id:, created_at:, customer_id:, default:, external_payment_method_id:, payment_method_type:, provider_type:)
530
+ # Some parameter documentations has been truncated, see
531
+ # {Orb::Models::Customer::DefaultPaymentMethod} for more details.
532
+ #
533
+ # A payment method represents a customer's stored payment instrument held with an
534
+ # external payment provider (such as Adyen or Stripe).
535
+ #
536
+ # The serialization is intentionally minimal for now; provider-pulled details
537
+ # (e.g. card display metadata) will be added over time.
538
+ #
539
+ # @param id [String] The Orb-assigned unique identifier for the payment method.
540
+ #
541
+ # @param created_at [Time] The time at which the payment method was created.
542
+ #
543
+ # @param customer_id [String] The ID of the Orb customer this payment method is attached to.
544
+ #
545
+ # @param default [Boolean] Whether this is the customer's default payment method.
546
+ #
547
+ # @param external_payment_method_id [String] The identifier of this payment method in the external payment provider.
548
+ #
549
+ # @param payment_method_type [Symbol, Orb::Models::Customer::DefaultPaymentMethod::PaymentMethodType] The type of the underlying payment instrument, e.g. `card` or `us_bank_account`.
550
+ #
551
+ # @param provider_type [String, nil] The external payment provider this method belongs to, derived from the linked pa
552
+
553
+ # The type of the underlying payment instrument, e.g. `card` or `us_bank_account`.
554
+ #
555
+ # @see Orb::Models::Customer::DefaultPaymentMethod#payment_method_type
556
+ module PaymentMethodType
557
+ extend Orb::Internal::Type::Enum
558
+
559
+ CARD = :card
560
+ US_BANK_ACCOUNT = :us_bank_account
561
+ LINK = :link
562
+ AMAZON_PAY = :amazon_pay
563
+ CRYPTO = :crypto
564
+
565
+ # @!method self.values
566
+ # @return [Array<Symbol>]
567
+ end
568
+ end
569
+
461
570
  # @see Orb::Models::Customer#payment_configuration
462
571
  class PaymentConfiguration < Orb::Internal::Type::BaseModel
463
572
  # @!attribute payment_providers
@@ -480,6 +589,14 @@ module Orb
480
589
  # @return [Symbol, Orb::Models::Customer::PaymentConfiguration::PaymentProvider::ProviderType]
481
590
  required :provider_type, enum: -> { Orb::Customer::PaymentConfiguration::PaymentProvider::ProviderType }
482
591
 
592
+ # @!attribute default_shared_payment_token
593
+ # The ID of a shared payment token granted by an agent to use as the default
594
+ # payment instrument for this customer. When set, auto-collection will use this
595
+ # token instead of the customer's default payment method.
596
+ #
597
+ # @return [String, nil]
598
+ optional :default_shared_payment_token, String, nil?: true
599
+
483
600
  # @!attribute excluded_payment_method_types
484
601
  # List of Stripe payment method types to exclude for this customer. Excluded
485
602
  # payment methods will not be available for the customer to select during payment,
@@ -490,12 +607,14 @@ module Orb
490
607
  # @return [Array<String>, nil]
491
608
  optional :excluded_payment_method_types, Orb::Internal::Type::ArrayOf[String]
492
609
 
493
- # @!method initialize(provider_type:, excluded_payment_method_types: nil)
610
+ # @!method initialize(provider_type:, default_shared_payment_token: nil, excluded_payment_method_types: nil)
494
611
  # Some parameter documentations has been truncated, see
495
612
  # {Orb::Models::Customer::PaymentConfiguration::PaymentProvider} for more details.
496
613
  #
497
614
  # @param provider_type [Symbol, Orb::Models::Customer::PaymentConfiguration::PaymentProvider::ProviderType] The payment provider to configure.
498
615
  #
616
+ # @param default_shared_payment_token [String, nil] The ID of a shared payment token granted by an agent to use as the default payme
617
+ #
499
618
  # @param excluded_payment_method_types [Array<String>] List of Stripe payment method types to exclude for this customer. Excluded payme
500
619
 
501
620
  # The payment provider to configure.
@@ -185,11 +185,13 @@ module Orb
185
185
  # | Estonia | `eu_vat` | European VAT Number |
186
186
  # | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
187
187
  # | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
188
+ # | Faroe Islands | `fo_vat` | Faroe Islands VAT Number |
188
189
  # | Finland | `eu_vat` | European VAT Number |
189
190
  # | France | `eu_vat` | European VAT Number |
190
191
  # | Georgia | `ge_vat` | Georgian VAT |
191
192
  # | Germany | `de_stn` | German Tax Number (Steuernummer) |
192
193
  # | Germany | `eu_vat` | European VAT Number |
194
+ # | Gibraltar | `gi_tin` | Gibraltar Tax Identification Number |
193
195
  # | Greece | `eu_vat` | European VAT Number |
194
196
  # | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
195
197
  # | Hong Kong | `hk_br` | Hong Kong BR Number |
@@ -201,6 +203,7 @@ module Orb
201
203
  # | Ireland | `eu_vat` | European VAT Number |
202
204
  # | Israel | `il_vat` | Israel VAT |
203
205
  # | Italy | `eu_vat` | European VAT Number |
206
+ # | Italy | `it_cf` | Italian Codice Fiscale Number |
204
207
  # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
205
208
  # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
206
209
  # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
@@ -231,6 +234,7 @@ module Orb
231
234
  # | Norway | `no_vat` | Norwegian VAT Number |
232
235
  # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
233
236
  # | Oman | `om_vat` | Omani VAT Number |
237
+ # | Paraguay | `py_ruc` | Paraguayan RUC Number |
234
238
  # | Peru | `pe_ruc` | Peruvian RUC Number |
235
239
  # | Philippines | `ph_tin` | Philippines Tax Identification Number |
236
240
  # | Poland | `eu_vat` | European VAT Number |
@@ -252,6 +256,7 @@ module Orb
252
256
  # | South Korea | `kr_brn` | Korean BRN |
253
257
  # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
254
258
  # | Spain | `eu_vat` | European VAT Number |
259
+ # | Sri Lanka | `lk_vat` | Sri Lanka VAT Number |
255
260
  # | Suriname | `sr_fin` | Suriname FIN Number |
256
261
  # | Sweden | `eu_vat` | European VAT Number |
257
262
  # | Switzerland | `ch_uid` | Switzerland UID Number |
@@ -353,6 +358,14 @@ module Orb
353
358
  required :provider_type,
354
359
  enum: -> { Orb::CustomerCreateParams::PaymentConfiguration::PaymentProvider::ProviderType }
355
360
 
361
+ # @!attribute default_shared_payment_token
362
+ # The ID of a shared payment token granted by an agent to use as the default
363
+ # payment instrument for this customer. When set, auto-collection will use this
364
+ # token instead of the customer's default payment method.
365
+ #
366
+ # @return [String, nil]
367
+ optional :default_shared_payment_token, String, nil?: true
368
+
356
369
  # @!attribute excluded_payment_method_types
357
370
  # List of Stripe payment method types to exclude for this customer. Excluded
358
371
  # payment methods will not be available for the customer to select during payment,
@@ -363,13 +376,15 @@ module Orb
363
376
  # @return [Array<String>, nil]
364
377
  optional :excluded_payment_method_types, Orb::Internal::Type::ArrayOf[String]
365
378
 
366
- # @!method initialize(provider_type:, excluded_payment_method_types: nil)
379
+ # @!method initialize(provider_type:, default_shared_payment_token: nil, excluded_payment_method_types: nil)
367
380
  # Some parameter documentations has been truncated, see
368
381
  # {Orb::Models::CustomerCreateParams::PaymentConfiguration::PaymentProvider} for
369
382
  # more details.
370
383
  #
371
384
  # @param provider_type [Symbol, Orb::Models::CustomerCreateParams::PaymentConfiguration::PaymentProvider::ProviderType] The payment provider to configure.
372
385
  #
386
+ # @param default_shared_payment_token [String, nil] The ID of a shared payment token granted by an agent to use as the default payme
387
+ #
373
388
  # @param excluded_payment_method_types [Array<String>] List of Stripe payment method types to exclude for this customer. Excluded payme
374
389
 
375
390
  # The payment provider to configure.
@@ -397,6 +412,7 @@ module Orb
397
412
  STRIPE_CHARGE = :stripe_charge
398
413
  STRIPE_INVOICE = :stripe_invoice
399
414
  NETSUITE = :netsuite
415
+ ADYEN = :adyen
400
416
 
401
417
  # @!method self.values
402
418
  # @return [Array<Symbol>]
@@ -7,7 +7,13 @@ module Orb
7
7
  extend Orb::Internal::Type::RequestParameters::Converter
8
8
  include Orb::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute customer_id
11
+ #
12
+ # @return [String]
13
+ required :customer_id, String
14
+
15
+ # @!method initialize(customer_id:, request_options: {})
16
+ # @param customer_id [String]
11
17
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -7,7 +7,13 @@ module Orb
7
7
  extend Orb::Internal::Type::RequestParameters::Converter
8
8
  include Orb::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute external_customer_id
11
+ #
12
+ # @return [String]
13
+ required :external_customer_id, String
14
+
15
+ # @!method initialize(external_customer_id:, request_options: {})
16
+ # @param external_customer_id [String]
11
17
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -7,7 +7,13 @@ module Orb
7
7
  extend Orb::Internal::Type::RequestParameters::Converter
8
8
  include Orb::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute customer_id
11
+ #
12
+ # @return [String]
13
+ required :customer_id, String
14
+
15
+ # @!method initialize(customer_id:, request_options: {})
16
+ # @param customer_id [String]
11
17
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -7,7 +7,13 @@ module Orb
7
7
  extend Orb::Internal::Type::RequestParameters::Converter
8
8
  include Orb::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute external_customer_id
11
+ #
12
+ # @return [String]
13
+ required :external_customer_id, String
14
+
15
+ # @!method initialize(external_customer_id:, request_options: {})
16
+ # @param external_customer_id [String]
11
17
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -7,7 +7,13 @@ module Orb
7
7
  extend Orb::Internal::Type::RequestParameters::Converter
8
8
  include Orb::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute customer_id
11
+ #
12
+ # @return [String]
13
+ required :customer_id, String
14
+
15
+ # @!method initialize(customer_id:, request_options: {})
16
+ # @param customer_id [String]
11
17
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end