orb-billing 0.5.2 → 0.5.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (280) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +25 -0
  3. data/README.md +4 -4
  4. data/SECURITY.md +2 -2
  5. data/lib/orb/internal/util.rb +3 -1
  6. data/lib/orb/internal.rb +3 -0
  7. data/lib/orb/models/alert.rb +23 -23
  8. data/lib/orb/models/alert_create_for_customer_params.rb +5 -5
  9. data/lib/orb/models/alert_create_for_external_customer_params.rb +5 -5
  10. data/lib/orb/models/alert_create_for_subscription_params.rb +5 -5
  11. data/lib/orb/models/alert_update_params.rb +3 -3
  12. data/lib/orb/models/amount_discount.rb +5 -5
  13. data/lib/orb/models/billable_metric.rb +7 -7
  14. data/lib/orb/models/coupon.rb +6 -6
  15. data/lib/orb/models/coupon_create_params.rb +3 -3
  16. data/lib/orb/models/credit_note.rb +33 -33
  17. data/lib/orb/models/credit_note_create_params.rb +4 -4
  18. data/lib/orb/models/customer.rb +39 -39
  19. data/lib/orb/models/customer_create_params.rb +26 -26
  20. data/lib/orb/models/customer_update_by_external_id_params.rb +26 -26
  21. data/lib/orb/models/customer_update_params.rb +26 -26
  22. data/lib/orb/models/customers/balance_transaction_create_params.rb +2 -2
  23. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +2 -2
  24. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +2 -2
  25. data/lib/orb/models/customers/cost_list_params.rb +2 -2
  26. data/lib/orb/models/customers/cost_list_response.rb +2 -2
  27. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +7 -7
  28. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +8 -8
  29. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +4 -4
  30. data/lib/orb/models/customers/credits/ledger_list_params.rb +4 -4
  31. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +6 -6
  32. data/lib/orb/models/customers/credits/top_up_create_params.rb +6 -5
  33. data/lib/orb/models/dimensional_price_group.rb +1 -1
  34. data/lib/orb/models/dimensional_price_groups.rb +4 -4
  35. data/lib/orb/models/discount.rb +1 -1
  36. data/lib/orb/models/event_ingest_params.rb +3 -3
  37. data/lib/orb/models/events/event_volumes.rb +2 -2
  38. data/lib/orb/models/invoice.rb +114 -113
  39. data/lib/orb/models/invoice_create_params.rb +10 -10
  40. data/lib/orb/models/invoice_fetch_upcoming_response.rb +6 -6
  41. data/lib/orb/models/invoice_level_discount.rb +1 -1
  42. data/lib/orb/models/invoice_line_item_create_response.rb +4 -4
  43. data/lib/orb/models/invoice_list_params.rb +4 -4
  44. data/lib/orb/models/item.rb +5 -5
  45. data/lib/orb/models/item_update_params.rb +5 -5
  46. data/lib/orb/models/percentage_discount.rb +5 -5
  47. data/lib/orb/models/plan.rb +58 -58
  48. data/lib/orb/models/plan_create_params.rb +448 -444
  49. data/lib/orb/models/plan_list_params.rb +2 -2
  50. data/lib/orb/models/price.rb +1204 -1204
  51. data/lib/orb/models/price_create_params.rb +50 -50
  52. data/lib/orb/models/price_evaluate_response.rb +2 -2
  53. data/lib/orb/models/subscription.rb +58 -56
  54. data/lib/orb/models/subscription_cancel_params.rb +2 -2
  55. data/lib/orb/models/subscription_cancel_response.rb +14 -14
  56. data/lib/orb/models/subscription_change_apply_response.rb +14 -14
  57. data/lib/orb/models/subscription_change_cancel_response.rb +14 -14
  58. data/lib/orb/models/subscription_change_retrieve_response.rb +14 -14
  59. data/lib/orb/models/subscription_create_params.rb +1002 -987
  60. data/lib/orb/models/subscription_create_response.rb +14 -14
  61. data/lib/orb/models/subscription_fetch_costs_params.rb +2 -2
  62. data/lib/orb/models/subscription_fetch_costs_response.rb +2 -2
  63. data/lib/orb/models/subscription_fetch_usage_params.rb +4 -4
  64. data/lib/orb/models/subscription_list_params.rb +2 -2
  65. data/lib/orb/models/subscription_price_intervals_params.rb +596 -585
  66. data/lib/orb/models/subscription_price_intervals_response.rb +14 -14
  67. data/lib/orb/models/subscription_schedule_plan_change_params.rb +973 -971
  68. data/lib/orb/models/subscription_schedule_plan_change_response.rb +14 -14
  69. data/lib/orb/models/subscription_trigger_phase_response.rb +14 -14
  70. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +14 -14
  71. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +14 -14
  72. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +14 -14
  73. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +2 -2
  74. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +14 -14
  75. data/lib/orb/models/subscription_update_trial_params.rb +3 -3
  76. data/lib/orb/models/subscription_update_trial_response.rb +14 -14
  77. data/lib/orb/models/subscription_usage.rb +26 -26
  78. data/lib/orb/models/subscriptions.rb +4 -4
  79. data/lib/orb/models/trial_discount.rb +5 -5
  80. data/lib/orb/models/usage_discount.rb +5 -5
  81. data/lib/orb/resources/alerts.rb +15 -15
  82. data/lib/orb/resources/coupons/subscriptions.rb +1 -1
  83. data/lib/orb/resources/coupons.rb +5 -5
  84. data/lib/orb/resources/credit_notes.rb +5 -5
  85. data/lib/orb/resources/customers/balance_transactions.rb +1 -1
  86. data/lib/orb/resources/customers/costs.rb +2 -2
  87. data/lib/orb/resources/customers/credits/ledger.rb +10 -10
  88. data/lib/orb/resources/customers/credits/top_ups.rb +4 -4
  89. data/lib/orb/resources/customers.rb +30 -30
  90. data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +1 -1
  91. data/lib/orb/resources/dimensional_price_groups.rb +3 -3
  92. data/lib/orb/resources/events/volume.rb +1 -1
  93. data/lib/orb/resources/events.rb +1 -1
  94. data/lib/orb/resources/invoices.rb +12 -12
  95. data/lib/orb/resources/items.rb +5 -5
  96. data/lib/orb/resources/metrics.rb +4 -4
  97. data/lib/orb/resources/plans/external_plan_id.rb +2 -2
  98. data/lib/orb/resources/plans.rb +7 -7
  99. data/lib/orb/resources/prices/external_price_id.rb +2 -2
  100. data/lib/orb/resources/prices.rb +17 -17
  101. data/lib/orb/resources/subscriptions.rb +32 -32
  102. data/lib/orb/version.rb +1 -1
  103. data/rbi/orb/internal.rbi +3 -0
  104. data/rbi/orb/models/subscription_price_intervals_params.rbi +26 -72
  105. data/rbi/orb/models/subscription_update_trial_params.rbi +14 -3
  106. data/rbi/orb/resources/subscriptions.rbi +4 -1
  107. data/sig/orb/internal/page.rbs +2 -0
  108. data/sig/orb/internal.rbs +2 -0
  109. data/sig/orb/models/alert.rbs +32 -4
  110. data/sig/orb/models/alert_create_for_customer_params.rbs +9 -0
  111. data/sig/orb/models/alert_create_for_external_customer_params.rbs +9 -0
  112. data/sig/orb/models/alert_create_for_subscription_params.rbs +9 -0
  113. data/sig/orb/models/alert_disable_params.rbs +5 -0
  114. data/sig/orb/models/alert_enable_params.rbs +5 -0
  115. data/sig/orb/models/alert_list_params.rbs +13 -0
  116. data/sig/orb/models/alert_retrieve_params.rbs +2 -0
  117. data/sig/orb/models/alert_update_params.rbs +7 -0
  118. data/sig/orb/models/amount_discount.rbs +11 -4
  119. data/sig/orb/models/billable_metric.rbs +13 -4
  120. data/sig/orb/models/coupon.rbs +14 -4
  121. data/sig/orb/models/coupon_archive_params.rbs +2 -0
  122. data/sig/orb/models/coupon_create_params.rbs +15 -0
  123. data/sig/orb/models/coupon_fetch_params.rbs +2 -0
  124. data/sig/orb/models/coupon_list_params.rbs +8 -0
  125. data/sig/orb/models/coupons/subscription_list_params.rbs +6 -0
  126. data/sig/orb/models/credit_note.rbs +88 -20
  127. data/sig/orb/models/credit_note_create_params.rbs +9 -0
  128. data/sig/orb/models/credit_note_fetch_params.rbs +2 -0
  129. data/sig/orb/models/credit_note_list_params.rbs +10 -0
  130. data/sig/orb/models/customer.rbs +86 -16
  131. data/sig/orb/models/customer_create_params.rbs +79 -8
  132. data/sig/orb/models/customer_delete_params.rbs +2 -0
  133. data/sig/orb/models/customer_fetch_by_external_id_params.rbs +2 -0
  134. data/sig/orb/models/customer_fetch_params.rbs +2 -0
  135. data/sig/orb/models/customer_list_params.rbs +10 -0
  136. data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +2 -0
  137. data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +2 -0
  138. data/sig/orb/models/customer_update_by_external_id_params.rbs +78 -8
  139. data/sig/orb/models/customer_update_params.rbs +78 -8
  140. data/sig/orb/models/customers/balance_transaction_create_params.rbs +7 -0
  141. data/sig/orb/models/customers/balance_transaction_create_response.rbs +17 -0
  142. data/sig/orb/models/customers/balance_transaction_list_params.rbs +10 -0
  143. data/sig/orb/models/customers/balance_transaction_list_response.rbs +17 -0
  144. data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +8 -0
  145. data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +20 -0
  146. data/sig/orb/models/customers/cost_list_params.rbs +8 -0
  147. data/sig/orb/models/customers/cost_list_response.rbs +20 -0
  148. data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +8 -0
  149. data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +10 -0
  150. data/sig/orb/models/customers/credit_list_params.rbs +8 -0
  151. data/sig/orb/models/customers/credit_list_response.rbs +10 -0
  152. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +23 -0
  153. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +177 -0
  154. data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +23 -0
  155. data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +177 -0
  156. data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +14 -0
  157. data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +177 -0
  158. data/sig/orb/models/customers/credits/ledger_list_params.rbs +14 -0
  159. data/sig/orb/models/customers/credits/ledger_list_response.rbs +177 -0
  160. data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +19 -0
  161. data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +18 -0
  162. data/sig/orb/models/customers/credits/top_up_create_params.rbs +19 -0
  163. data/sig/orb/models/customers/credits/top_up_create_response.rbs +18 -0
  164. data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +5 -0
  165. data/sig/orb/models/customers/credits/top_up_delete_params.rbs +5 -0
  166. data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +6 -0
  167. data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +18 -0
  168. data/sig/orb/models/customers/credits/top_up_list_params.rbs +6 -0
  169. data/sig/orb/models/customers/credits/top_up_list_response.rbs +18 -0
  170. data/sig/orb/models/dimensional_price_group.rbs +9 -0
  171. data/sig/orb/models/dimensional_price_group_create_params.rbs +9 -0
  172. data/sig/orb/models/dimensional_price_group_list_params.rbs +6 -0
  173. data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +2 -0
  174. data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +2 -0
  175. data/sig/orb/models/dimensional_price_groups.rbs +5 -0
  176. data/sig/orb/models/evaluate_price_group.rbs +10 -4
  177. data/sig/orb/models/event_deprecate_params.rbs +2 -0
  178. data/sig/orb/models/event_deprecate_response.rbs +2 -0
  179. data/sig/orb/models/event_ingest_params.rbs +16 -0
  180. data/sig/orb/models/event_ingest_response.rbs +15 -0
  181. data/sig/orb/models/event_search_params.rbs +7 -0
  182. data/sig/orb/models/event_search_response.rbs +12 -0
  183. data/sig/orb/models/event_update_params.rbs +9 -0
  184. data/sig/orb/models/event_update_response.rbs +2 -0
  185. data/sig/orb/models/events/backfill_close_params.rbs +2 -0
  186. data/sig/orb/models/events/backfill_close_response.rbs +14 -0
  187. data/sig/orb/models/events/backfill_create_params.rbs +11 -0
  188. data/sig/orb/models/events/backfill_create_response.rbs +14 -0
  189. data/sig/orb/models/events/backfill_fetch_params.rbs +2 -0
  190. data/sig/orb/models/events/backfill_fetch_response.rbs +14 -0
  191. data/sig/orb/models/events/backfill_list_params.rbs +6 -0
  192. data/sig/orb/models/events/backfill_list_response.rbs +14 -0
  193. data/sig/orb/models/events/backfill_revert_params.rbs +2 -0
  194. data/sig/orb/models/events/backfill_revert_response.rbs +14 -0
  195. data/sig/orb/models/events/event_volumes.rbs +8 -0
  196. data/sig/orb/models/events/volume_list_params.rbs +8 -0
  197. data/sig/orb/models/invoice.rbs +293 -36
  198. data/sig/orb/models/invoice_create_params.rbs +30 -4
  199. data/sig/orb/models/invoice_fetch_params.rbs +2 -0
  200. data/sig/orb/models/invoice_fetch_upcoming_params.rbs +5 -0
  201. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +257 -0
  202. data/sig/orb/models/invoice_issue_params.rbs +5 -0
  203. data/sig/orb/models/invoice_line_item_create_params.rbs +10 -0
  204. data/sig/orb/models/invoice_line_item_create_response.rbs +132 -0
  205. data/sig/orb/models/invoice_list_params.rbs +27 -4
  206. data/sig/orb/models/invoice_mark_paid_params.rbs +7 -0
  207. data/sig/orb/models/invoice_pay_params.rbs +2 -0
  208. data/sig/orb/models/invoice_update_params.rbs +5 -0
  209. data/sig/orb/models/invoice_void_params.rbs +2 -0
  210. data/sig/orb/models/item.rbs +16 -4
  211. data/sig/orb/models/item_create_params.rbs +2 -0
  212. data/sig/orb/models/item_fetch_params.rbs +2 -0
  213. data/sig/orb/models/item_list_params.rbs +6 -0
  214. data/sig/orb/models/item_update_params.rbs +15 -4
  215. data/sig/orb/models/metric_create_params.rbs +9 -0
  216. data/sig/orb/models/metric_fetch_params.rbs +2 -0
  217. data/sig/orb/models/metric_list_params.rbs +10 -0
  218. data/sig/orb/models/metric_update_params.rbs +5 -0
  219. data/sig/orb/models/pagination_metadata.rbs +2 -0
  220. data/sig/orb/models/percentage_discount.rbs +11 -4
  221. data/sig/orb/models/plan.rbs +141 -16
  222. data/sig/orb/models/plan_create_params.rbs +1070 -304
  223. data/sig/orb/models/plan_fetch_params.rbs +2 -0
  224. data/sig/orb/models/plan_list_params.rbs +11 -0
  225. data/sig/orb/models/plan_update_params.rbs +6 -0
  226. data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +2 -0
  227. data/sig/orb/models/plans/external_plan_id_update_params.rbs +6 -0
  228. data/sig/orb/models/price.rbs +2148 -460
  229. data/sig/orb/models/price_create_params.rbs +130 -8
  230. data/sig/orb/models/price_evaluate_params.rbs +10 -0
  231. data/sig/orb/models/price_evaluate_response.rbs +2 -0
  232. data/sig/orb/models/price_fetch_params.rbs +2 -0
  233. data/sig/orb/models/price_list_params.rbs +6 -0
  234. data/sig/orb/models/price_update_params.rbs +5 -0
  235. data/sig/orb/models/prices/external_price_id_fetch_params.rbs +2 -0
  236. data/sig/orb/models/prices/external_price_id_update_params.rbs +5 -0
  237. data/sig/orb/models/subscription.rbs +177 -12
  238. data/sig/orb/models/subscription_cancel_params.rbs +7 -0
  239. data/sig/orb/models/subscription_cancel_response.rbs +173 -0
  240. data/sig/orb/models/subscription_change_apply_params.rbs +6 -0
  241. data/sig/orb/models/subscription_change_apply_response.rbs +186 -0
  242. data/sig/orb/models/subscription_change_cancel_params.rbs +2 -0
  243. data/sig/orb/models/subscription_change_cancel_response.rbs +186 -0
  244. data/sig/orb/models/subscription_change_retrieve_params.rbs +2 -0
  245. data/sig/orb/models/subscription_change_retrieve_response.rbs +186 -0
  246. data/sig/orb/models/subscription_create_params.rbs +2368 -632
  247. data/sig/orb/models/subscription_create_response.rbs +173 -0
  248. data/sig/orb/models/subscription_fetch_costs_params.rbs +8 -0
  249. data/sig/orb/models/subscription_fetch_costs_response.rbs +20 -0
  250. data/sig/orb/models/subscription_fetch_params.rbs +2 -0
  251. data/sig/orb/models/subscription_fetch_schedule_params.rbs +10 -0
  252. data/sig/orb/models/subscription_fetch_schedule_response.rbs +13 -0
  253. data/sig/orb/models/subscription_fetch_usage_params.rbs +14 -0
  254. data/sig/orb/models/subscription_list_params.rbs +13 -0
  255. data/sig/orb/models/subscription_price_intervals_params.rbs +1348 -396
  256. data/sig/orb/models/subscription_price_intervals_response.rbs +173 -0
  257. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +2363 -632
  258. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +173 -0
  259. data/sig/orb/models/subscription_trigger_phase_params.rbs +6 -0
  260. data/sig/orb/models/subscription_trigger_phase_response.rbs +173 -0
  261. data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +2 -0
  262. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +173 -0
  263. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +2 -0
  264. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +173 -0
  265. data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +2 -0
  266. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +173 -0
  267. data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +9 -0
  268. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +173 -0
  269. data/sig/orb/models/subscription_update_params.rbs +9 -0
  270. data/sig/orb/models/subscription_update_trial_params.rbs +6 -0
  271. data/sig/orb/models/subscription_update_trial_response.rbs +173 -0
  272. data/sig/orb/models/subscription_usage.rbs +48 -8
  273. data/sig/orb/models/subscriptions.rbs +5 -0
  274. data/sig/orb/models/top_level_ping_params.rbs +2 -0
  275. data/sig/orb/models/top_level_ping_response.rbs +2 -0
  276. data/sig/orb/models/trial_discount.rbs +12 -4
  277. data/sig/orb/models/usage_discount.rbs +11 -4
  278. data/sig/orb/resources/invoices.rbs +1 -1
  279. data/sig/orb/resources/plans.rbs +1 -1
  280. metadata +2 -2
@@ -13,7 +13,7 @@ module Orb
13
13
  current_billing_period_start_date: Time?,
14
14
  customer: Orb::Customer,
15
15
  default_invoice_memo: String?,
16
- discount_intervals: ::Array[Orb::Subscription::discount_interval],
16
+ discount_intervals: ::Array[Orb::Models::Subscription::discount_interval],
17
17
  end_date: Time?,
18
18
  fixed_fee_quantity_schedule: ::Array[Orb::Subscription::FixedFeeQuantitySchedule],
19
19
  invoicing_threshold: String?,
@@ -26,7 +26,7 @@ module Orb
26
26
  price_intervals: ::Array[Orb::Subscription::PriceInterval],
27
27
  redeemed_coupon: Orb::Subscription::RedeemedCoupon?,
28
28
  start_date: Time,
29
- status: Orb::Subscription::status,
29
+ status: Orb::Models::Subscription::status,
30
30
  trial_info: Orb::Subscription::TrialInfo
31
31
  }
32
32
 
@@ -53,7 +53,7 @@ module Orb
53
53
 
54
54
  attr_accessor default_invoice_memo: String?
55
55
 
56
- attr_accessor discount_intervals: ::Array[Orb::Subscription::discount_interval]
56
+ attr_accessor discount_intervals: ::Array[Orb::Models::Subscription::discount_interval]
57
57
 
58
58
  attr_accessor end_date: Time?
59
59
 
@@ -79,7 +79,7 @@ module Orb
79
79
 
80
80
  attr_accessor start_date: Time
81
81
 
82
- attr_accessor status: Orb::Subscription::status
82
+ attr_accessor status: Orb::Models::Subscription::status
83
83
 
84
84
  attr_accessor trial_info: Orb::Subscription::TrialInfo
85
85
 
@@ -95,7 +95,7 @@ module Orb
95
95
  current_billing_period_start_date: Time?,
96
96
  customer: Orb::Customer,
97
97
  default_invoice_memo: String?,
98
- discount_intervals: ::Array[Orb::Subscription::discount_interval],
98
+ discount_intervals: ::Array[Orb::Models::Subscription::discount_interval],
99
99
  end_date: Time?,
100
100
  fixed_fee_quantity_schedule: ::Array[Orb::Subscription::FixedFeeQuantitySchedule],
101
101
  invoicing_threshold: String?,
@@ -108,14 +108,43 @@ module Orb
108
108
  price_intervals: ::Array[Orb::Subscription::PriceInterval],
109
109
  redeemed_coupon: Orb::Subscription::RedeemedCoupon?,
110
110
  start_date: Time,
111
- status: Orb::Subscription::status,
111
+ status: Orb::Models::Subscription::status,
112
112
  trial_info: Orb::Subscription::TrialInfo
113
113
  ) -> void
114
114
 
115
+ def to_hash: -> {
116
+ id: String,
117
+ active_plan_phase_order: Integer?,
118
+ adjustment_intervals: ::Array[Orb::Subscription::AdjustmentInterval],
119
+ auto_collection: bool?,
120
+ billing_cycle_anchor_configuration: Orb::Subscription::BillingCycleAnchorConfiguration,
121
+ billing_cycle_day: Integer,
122
+ created_at: Time,
123
+ current_billing_period_end_date: Time?,
124
+ current_billing_period_start_date: Time?,
125
+ customer: Orb::Customer,
126
+ default_invoice_memo: String?,
127
+ discount_intervals: ::Array[Orb::Models::Subscription::discount_interval],
128
+ end_date: Time?,
129
+ fixed_fee_quantity_schedule: ::Array[Orb::Subscription::FixedFeeQuantitySchedule],
130
+ invoicing_threshold: String?,
131
+ maximum_intervals: ::Array[Orb::Subscription::MaximumInterval],
132
+ metadata: ::Hash[Symbol, String],
133
+ minimum_intervals: ::Array[Orb::Subscription::MinimumInterval],
134
+ net_terms: Integer,
135
+ pending_subscription_change: Orb::Subscription::PendingSubscriptionChange?,
136
+ plan: Orb::Plan,
137
+ price_intervals: ::Array[Orb::Subscription::PriceInterval],
138
+ redeemed_coupon: Orb::Subscription::RedeemedCoupon?,
139
+ start_date: Time,
140
+ status: Orb::Models::Subscription::status,
141
+ trial_info: Orb::Subscription::TrialInfo
142
+ }
143
+
115
144
  type adjustment_interval =
116
145
  {
117
146
  id: String,
118
- adjustment: Orb::Subscription::AdjustmentInterval::adjustment,
147
+ adjustment: Orb::Models::Subscription::AdjustmentInterval::adjustment,
119
148
  applies_to_price_interval_ids: ::Array[String],
120
149
  end_date: Time?,
121
150
  start_date: Time
@@ -124,7 +153,7 @@ module Orb
124
153
  class AdjustmentInterval < Orb::Internal::Type::BaseModel
125
154
  attr_accessor id: String
126
155
 
127
- attr_accessor adjustment: Orb::Subscription::AdjustmentInterval::adjustment
156
+ attr_accessor adjustment: Orb::Models::Subscription::AdjustmentInterval::adjustment
128
157
 
129
158
  attr_accessor applies_to_price_interval_ids: ::Array[String]
130
159
 
@@ -134,12 +163,20 @@ module Orb
134
163
 
135
164
  def initialize: (
136
165
  id: String,
137
- adjustment: Orb::Subscription::AdjustmentInterval::adjustment,
166
+ adjustment: Orb::Models::Subscription::AdjustmentInterval::adjustment,
138
167
  applies_to_price_interval_ids: ::Array[String],
139
168
  end_date: Time?,
140
169
  start_date: Time
141
170
  ) -> void
142
171
 
172
+ def to_hash: -> {
173
+ id: String,
174
+ adjustment: Orb::Models::Subscription::AdjustmentInterval::adjustment,
175
+ applies_to_price_interval_ids: ::Array[String],
176
+ end_date: Time?,
177
+ start_date: Time
178
+ }
179
+
143
180
  type adjustment =
144
181
  Orb::Subscription::AdjustmentInterval::Adjustment::UsageDiscount
145
182
  | Orb::Subscription::AdjustmentInterval::Adjustment::AmountDiscount
@@ -185,6 +222,16 @@ module Orb
185
222
  usage_discount: Float,
186
223
  ?adjustment_type: :usage_discount
187
224
  ) -> void
225
+
226
+ def to_hash: -> {
227
+ id: String,
228
+ adjustment_type: :usage_discount,
229
+ applies_to_price_ids: ::Array[String],
230
+ is_invoice_level: bool,
231
+ plan_phase_order: Integer?,
232
+ reason: String?,
233
+ usage_discount: Float
234
+ }
188
235
  end
189
236
 
190
237
  type amount_discount =
@@ -222,6 +269,16 @@ module Orb
222
269
  reason: String?,
223
270
  ?adjustment_type: :amount_discount
224
271
  ) -> void
272
+
273
+ def to_hash: -> {
274
+ id: String,
275
+ adjustment_type: :amount_discount,
276
+ amount_discount: String,
277
+ applies_to_price_ids: ::Array[String],
278
+ is_invoice_level: bool,
279
+ plan_phase_order: Integer?,
280
+ reason: String?
281
+ }
225
282
  end
226
283
 
227
284
  type percentage_discount =
@@ -259,6 +316,16 @@ module Orb
259
316
  reason: String?,
260
317
  ?adjustment_type: :percentage_discount
261
318
  ) -> void
319
+
320
+ def to_hash: -> {
321
+ id: String,
322
+ adjustment_type: :percentage_discount,
323
+ applies_to_price_ids: ::Array[String],
324
+ is_invoice_level: bool,
325
+ percentage_discount: Float,
326
+ plan_phase_order: Integer?,
327
+ reason: String?
328
+ }
262
329
  end
263
330
 
264
331
  type minimum =
@@ -300,6 +367,17 @@ module Orb
300
367
  reason: String?,
301
368
  ?adjustment_type: :minimum
302
369
  ) -> void
370
+
371
+ def to_hash: -> {
372
+ id: String,
373
+ adjustment_type: :minimum,
374
+ applies_to_price_ids: ::Array[String],
375
+ is_invoice_level: bool,
376
+ item_id: String,
377
+ minimum_amount: String,
378
+ plan_phase_order: Integer?,
379
+ reason: String?
380
+ }
303
381
  end
304
382
 
305
383
  type maximum =
@@ -337,9 +415,19 @@ module Orb
337
415
  reason: String?,
338
416
  ?adjustment_type: :maximum
339
417
  ) -> void
418
+
419
+ def to_hash: -> {
420
+ id: String,
421
+ adjustment_type: :maximum,
422
+ applies_to_price_ids: ::Array[String],
423
+ is_invoice_level: bool,
424
+ maximum_amount: String,
425
+ plan_phase_order: Integer?,
426
+ reason: String?
427
+ }
340
428
  end
341
429
 
342
- def self?.variants: -> ::Array[Orb::Subscription::AdjustmentInterval::adjustment]
430
+ def self?.variants: -> ::Array[Orb::Models::Subscription::AdjustmentInterval::adjustment]
343
431
  end
344
432
  end
345
433
 
@@ -358,6 +446,8 @@ module Orb
358
446
  ?month: Integer?,
359
447
  ?year: Integer?
360
448
  ) -> void
449
+
450
+ def to_hash: -> { day: Integer, month: Integer?, year: Integer? }
361
451
  end
362
452
 
363
453
  type discount_interval =
@@ -399,6 +489,15 @@ module Orb
399
489
  start_date: Time,
400
490
  ?discount_type: :amount
401
491
  ) -> void
492
+
493
+ def to_hash: -> {
494
+ amount_discount: String,
495
+ applies_to_price_ids: ::Array[String],
496
+ applies_to_price_interval_ids: ::Array[String],
497
+ discount_type: :amount,
498
+ end_date: Time?,
499
+ start_date: Time
500
+ }
402
501
  end
403
502
 
404
503
  type percentage =
@@ -432,6 +531,15 @@ module Orb
432
531
  start_date: Time,
433
532
  ?discount_type: :percentage
434
533
  ) -> void
534
+
535
+ def to_hash: -> {
536
+ applies_to_price_ids: ::Array[String],
537
+ applies_to_price_interval_ids: ::Array[String],
538
+ discount_type: :percentage,
539
+ end_date: Time?,
540
+ percentage_discount: Float,
541
+ start_date: Time
542
+ }
435
543
  end
436
544
 
437
545
  type usage =
@@ -465,9 +573,18 @@ module Orb
465
573
  usage_discount: Float,
466
574
  ?discount_type: :usage
467
575
  ) -> void
576
+
577
+ def to_hash: -> {
578
+ applies_to_price_ids: ::Array[String],
579
+ applies_to_price_interval_ids: ::Array[String],
580
+ discount_type: :usage,
581
+ end_date: Time?,
582
+ start_date: Time,
583
+ usage_discount: Float
584
+ }
468
585
  end
469
586
 
470
- def self?.variants: -> ::Array[Orb::Subscription::discount_interval]
587
+ def self?.variants: -> ::Array[Orb::Models::Subscription::discount_interval]
471
588
  end
472
589
 
473
590
  type fixed_fee_quantity_schedule =
@@ -488,6 +605,13 @@ module Orb
488
605
  quantity: Float,
489
606
  start_date: Time
490
607
  ) -> void
608
+
609
+ def to_hash: -> {
610
+ end_date: Time?,
611
+ price_id: String,
612
+ quantity: Float,
613
+ start_date: Time
614
+ }
491
615
  end
492
616
 
493
617
  type maximum_interval =
@@ -517,6 +641,14 @@ module Orb
517
641
  maximum_amount: String,
518
642
  start_date: Time
519
643
  ) -> void
644
+
645
+ def to_hash: -> {
646
+ applies_to_price_ids: ::Array[String],
647
+ applies_to_price_interval_ids: ::Array[String],
648
+ end_date: Time?,
649
+ maximum_amount: String,
650
+ start_date: Time
651
+ }
520
652
  end
521
653
 
522
654
  type minimum_interval =
@@ -546,6 +678,14 @@ module Orb
546
678
  minimum_amount: String,
547
679
  start_date: Time
548
680
  ) -> void
681
+
682
+ def to_hash: -> {
683
+ applies_to_price_ids: ::Array[String],
684
+ applies_to_price_interval_ids: ::Array[String],
685
+ end_date: Time?,
686
+ minimum_amount: String,
687
+ start_date: Time
688
+ }
549
689
  end
550
690
 
551
691
  type pending_subscription_change = { id: String }
@@ -554,6 +694,8 @@ module Orb
554
694
  attr_accessor id: String
555
695
 
556
696
  def initialize: (id: String) -> void
697
+
698
+ def to_hash: -> { id: String }
557
699
  end
558
700
 
559
701
  type price_interval =
@@ -604,6 +746,19 @@ module Orb
604
746
  usage_customer_ids: ::Array[String]?
605
747
  ) -> void
606
748
 
749
+ def to_hash: -> {
750
+ id: String,
751
+ billing_cycle_day: Integer,
752
+ current_billing_period_end_date: Time?,
753
+ current_billing_period_start_date: Time?,
754
+ end_date: Time?,
755
+ filter: String?,
756
+ fixed_fee_quantity_transitions: ::Array[Orb::Subscription::PriceInterval::FixedFeeQuantityTransition]?,
757
+ price: Orb::Models::price,
758
+ start_date: Time,
759
+ usage_customer_ids: ::Array[String]?
760
+ }
761
+
607
762
  type fixed_fee_quantity_transition =
608
763
  { effective_date: Time, price_id: String, quantity: Integer }
609
764
 
@@ -619,6 +774,12 @@ module Orb
619
774
  price_id: String,
620
775
  quantity: Integer
621
776
  ) -> void
777
+
778
+ def to_hash: -> {
779
+ effective_date: Time,
780
+ price_id: String,
781
+ quantity: Integer
782
+ }
622
783
  end
623
784
  end
624
785
 
@@ -637,6 +798,8 @@ module Orb
637
798
  end_date: Time?,
638
799
  start_date: Time
639
800
  ) -> void
801
+
802
+ def to_hash: -> { coupon_id: String, end_date: Time?, start_date: Time }
640
803
  end
641
804
 
642
805
  type status = :active | :ended | :upcoming
@@ -648,7 +811,7 @@ module Orb
648
811
  ENDED: :ended
649
812
  UPCOMING: :upcoming
650
813
 
651
- def self?.values: -> ::Array[Orb::Subscription::status]
814
+ def self?.values: -> ::Array[Orb::Models::Subscription::status]
652
815
  end
653
816
 
654
817
  type trial_info = { end_date: Time? }
@@ -657,6 +820,8 @@ module Orb
657
820
  attr_accessor end_date: Time?
658
821
 
659
822
  def initialize: (end_date: Time?) -> void
823
+
824
+ def to_hash: -> { end_date: Time? }
660
825
  end
661
826
  end
662
827
  end
@@ -25,6 +25,13 @@ module Orb
25
25
  ?request_options: Orb::request_opts
26
26
  ) -> void
27
27
 
28
+ def to_hash: -> {
29
+ cancel_option: Orb::Models::SubscriptionCancelParams::cancel_option,
30
+ allow_invoice_credit_or_void: bool?,
31
+ cancellation_date: Time?,
32
+ request_options: Orb::RequestOptions
33
+ }
34
+
28
35
  type cancel_option =
29
36
  :end_of_subscription_term | :immediate | :requested_date
30
37
 
@@ -116,6 +116,36 @@ module Orb
116
116
  ?changed_resources: Orb::Models::SubscriptionCancelResponse::ChangedResources?
117
117
  ) -> void
118
118
 
119
+ def to_hash: -> {
120
+ id: String,
121
+ active_plan_phase_order: Integer?,
122
+ adjustment_intervals: ::Array[Orb::Models::SubscriptionCancelResponse::AdjustmentInterval],
123
+ auto_collection: bool?,
124
+ billing_cycle_anchor_configuration: Orb::Models::SubscriptionCancelResponse::BillingCycleAnchorConfiguration,
125
+ billing_cycle_day: Integer,
126
+ created_at: Time,
127
+ current_billing_period_end_date: Time?,
128
+ current_billing_period_start_date: Time?,
129
+ customer: Orb::Customer,
130
+ default_invoice_memo: String?,
131
+ discount_intervals: ::Array[Orb::Models::SubscriptionCancelResponse::discount_interval],
132
+ end_date: Time?,
133
+ fixed_fee_quantity_schedule: ::Array[Orb::Models::SubscriptionCancelResponse::FixedFeeQuantitySchedule],
134
+ invoicing_threshold: String?,
135
+ maximum_intervals: ::Array[Orb::Models::SubscriptionCancelResponse::MaximumInterval],
136
+ metadata: ::Hash[Symbol, String],
137
+ minimum_intervals: ::Array[Orb::Models::SubscriptionCancelResponse::MinimumInterval],
138
+ net_terms: Integer,
139
+ pending_subscription_change: Orb::Models::SubscriptionCancelResponse::PendingSubscriptionChange?,
140
+ plan: Orb::Plan,
141
+ price_intervals: ::Array[Orb::Models::SubscriptionCancelResponse::PriceInterval],
142
+ redeemed_coupon: Orb::Models::SubscriptionCancelResponse::RedeemedCoupon?,
143
+ start_date: Time,
144
+ status: Orb::Models::SubscriptionCancelResponse::status,
145
+ trial_info: Orb::Models::SubscriptionCancelResponse::TrialInfo,
146
+ changed_resources: Orb::Models::SubscriptionCancelResponse::ChangedResources?
147
+ }
148
+
119
149
  type adjustment_interval =
120
150
  {
121
151
  id: String,
@@ -144,6 +174,14 @@ module Orb
144
174
  start_date: Time
145
175
  ) -> void
146
176
 
177
+ def to_hash: -> {
178
+ id: String,
179
+ adjustment: Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::adjustment,
180
+ applies_to_price_interval_ids: ::Array[String],
181
+ end_date: Time?,
182
+ start_date: Time
183
+ }
184
+
147
185
  type adjustment =
148
186
  Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::UsageDiscount
149
187
  | Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::AmountDiscount
@@ -189,6 +227,16 @@ module Orb
189
227
  usage_discount: Float,
190
228
  ?adjustment_type: :usage_discount
191
229
  ) -> void
230
+
231
+ def to_hash: -> {
232
+ id: String,
233
+ adjustment_type: :usage_discount,
234
+ applies_to_price_ids: ::Array[String],
235
+ is_invoice_level: bool,
236
+ plan_phase_order: Integer?,
237
+ reason: String?,
238
+ usage_discount: Float
239
+ }
192
240
  end
193
241
 
194
242
  type amount_discount =
@@ -226,6 +274,16 @@ module Orb
226
274
  reason: String?,
227
275
  ?adjustment_type: :amount_discount
228
276
  ) -> void
277
+
278
+ def to_hash: -> {
279
+ id: String,
280
+ adjustment_type: :amount_discount,
281
+ amount_discount: String,
282
+ applies_to_price_ids: ::Array[String],
283
+ is_invoice_level: bool,
284
+ plan_phase_order: Integer?,
285
+ reason: String?
286
+ }
229
287
  end
230
288
 
231
289
  type percentage_discount =
@@ -263,6 +321,16 @@ module Orb
263
321
  reason: String?,
264
322
  ?adjustment_type: :percentage_discount
265
323
  ) -> void
324
+
325
+ def to_hash: -> {
326
+ id: String,
327
+ adjustment_type: :percentage_discount,
328
+ applies_to_price_ids: ::Array[String],
329
+ is_invoice_level: bool,
330
+ percentage_discount: Float,
331
+ plan_phase_order: Integer?,
332
+ reason: String?
333
+ }
266
334
  end
267
335
 
268
336
  type minimum =
@@ -304,6 +372,17 @@ module Orb
304
372
  reason: String?,
305
373
  ?adjustment_type: :minimum
306
374
  ) -> void
375
+
376
+ def to_hash: -> {
377
+ id: String,
378
+ adjustment_type: :minimum,
379
+ applies_to_price_ids: ::Array[String],
380
+ is_invoice_level: bool,
381
+ item_id: String,
382
+ minimum_amount: String,
383
+ plan_phase_order: Integer?,
384
+ reason: String?
385
+ }
307
386
  end
308
387
 
309
388
  type maximum =
@@ -341,6 +420,16 @@ module Orb
341
420
  reason: String?,
342
421
  ?adjustment_type: :maximum
343
422
  ) -> void
423
+
424
+ def to_hash: -> {
425
+ id: String,
426
+ adjustment_type: :maximum,
427
+ applies_to_price_ids: ::Array[String],
428
+ is_invoice_level: bool,
429
+ maximum_amount: String,
430
+ plan_phase_order: Integer?,
431
+ reason: String?
432
+ }
344
433
  end
345
434
 
346
435
  def self?.variants: -> ::Array[Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::adjustment]
@@ -362,6 +451,8 @@ module Orb
362
451
  ?month: Integer?,
363
452
  ?year: Integer?
364
453
  ) -> void
454
+
455
+ def to_hash: -> { day: Integer, month: Integer?, year: Integer? }
365
456
  end
366
457
 
367
458
  type discount_interval =
@@ -403,6 +494,15 @@ module Orb
403
494
  start_date: Time,
404
495
  ?discount_type: :amount
405
496
  ) -> void
497
+
498
+ def to_hash: -> {
499
+ amount_discount: String,
500
+ applies_to_price_ids: ::Array[String],
501
+ applies_to_price_interval_ids: ::Array[String],
502
+ discount_type: :amount,
503
+ end_date: Time?,
504
+ start_date: Time
505
+ }
406
506
  end
407
507
 
408
508
  type percentage =
@@ -436,6 +536,15 @@ module Orb
436
536
  start_date: Time,
437
537
  ?discount_type: :percentage
438
538
  ) -> void
539
+
540
+ def to_hash: -> {
541
+ applies_to_price_ids: ::Array[String],
542
+ applies_to_price_interval_ids: ::Array[String],
543
+ discount_type: :percentage,
544
+ end_date: Time?,
545
+ percentage_discount: Float,
546
+ start_date: Time
547
+ }
439
548
  end
440
549
 
441
550
  type usage =
@@ -469,6 +578,15 @@ module Orb
469
578
  usage_discount: Float,
470
579
  ?discount_type: :usage
471
580
  ) -> void
581
+
582
+ def to_hash: -> {
583
+ applies_to_price_ids: ::Array[String],
584
+ applies_to_price_interval_ids: ::Array[String],
585
+ discount_type: :usage,
586
+ end_date: Time?,
587
+ start_date: Time,
588
+ usage_discount: Float
589
+ }
472
590
  end
473
591
 
474
592
  def self?.variants: -> ::Array[Orb::Models::SubscriptionCancelResponse::discount_interval]
@@ -492,6 +610,13 @@ module Orb
492
610
  quantity: Float,
493
611
  start_date: Time
494
612
  ) -> void
613
+
614
+ def to_hash: -> {
615
+ end_date: Time?,
616
+ price_id: String,
617
+ quantity: Float,
618
+ start_date: Time
619
+ }
495
620
  end
496
621
 
497
622
  type maximum_interval =
@@ -521,6 +646,14 @@ module Orb
521
646
  maximum_amount: String,
522
647
  start_date: Time
523
648
  ) -> void
649
+
650
+ def to_hash: -> {
651
+ applies_to_price_ids: ::Array[String],
652
+ applies_to_price_interval_ids: ::Array[String],
653
+ end_date: Time?,
654
+ maximum_amount: String,
655
+ start_date: Time
656
+ }
524
657
  end
525
658
 
526
659
  type minimum_interval =
@@ -550,6 +683,14 @@ module Orb
550
683
  minimum_amount: String,
551
684
  start_date: Time
552
685
  ) -> void
686
+
687
+ def to_hash: -> {
688
+ applies_to_price_ids: ::Array[String],
689
+ applies_to_price_interval_ids: ::Array[String],
690
+ end_date: Time?,
691
+ minimum_amount: String,
692
+ start_date: Time
693
+ }
553
694
  end
554
695
 
555
696
  type pending_subscription_change = { id: String }
@@ -558,6 +699,8 @@ module Orb
558
699
  attr_accessor id: String
559
700
 
560
701
  def initialize: (id: String) -> void
702
+
703
+ def to_hash: -> { id: String }
561
704
  end
562
705
 
563
706
  type price_interval =
@@ -608,6 +751,19 @@ module Orb
608
751
  usage_customer_ids: ::Array[String]?
609
752
  ) -> void
610
753
 
754
+ def to_hash: -> {
755
+ id: String,
756
+ billing_cycle_day: Integer,
757
+ current_billing_period_end_date: Time?,
758
+ current_billing_period_start_date: Time?,
759
+ end_date: Time?,
760
+ filter: String?,
761
+ fixed_fee_quantity_transitions: ::Array[Orb::Models::SubscriptionCancelResponse::PriceInterval::FixedFeeQuantityTransition]?,
762
+ price: Orb::Models::price,
763
+ start_date: Time,
764
+ usage_customer_ids: ::Array[String]?
765
+ }
766
+
611
767
  type fixed_fee_quantity_transition =
612
768
  { effective_date: Time, price_id: String, quantity: Integer }
613
769
 
@@ -623,6 +779,12 @@ module Orb
623
779
  price_id: String,
624
780
  quantity: Integer
625
781
  ) -> void
782
+
783
+ def to_hash: -> {
784
+ effective_date: Time,
785
+ price_id: String,
786
+ quantity: Integer
787
+ }
626
788
  end
627
789
  end
628
790
 
@@ -641,6 +803,8 @@ module Orb
641
803
  end_date: Time?,
642
804
  start_date: Time
643
805
  ) -> void
806
+
807
+ def to_hash: -> { coupon_id: String, end_date: Time?, start_date: Time }
644
808
  end
645
809
 
646
810
  type status = :active | :ended | :upcoming
@@ -661,6 +825,8 @@ module Orb
661
825
  attr_accessor end_date: Time?
662
826
 
663
827
  def initialize: (end_date: Time?) -> void
828
+
829
+ def to_hash: -> { end_date: Time? }
664
830
  end
665
831
 
666
832
  type changed_resources =
@@ -686,6 +852,13 @@ module Orb
686
852
  voided_credit_notes: ::Array[Orb::CreditNote],
687
853
  voided_invoices: ::Array[Orb::Invoice]
688
854
  ) -> void
855
+
856
+ def to_hash: -> {
857
+ created_credit_notes: ::Array[Orb::CreditNote],
858
+ created_invoices: ::Array[Orb::Invoice],
859
+ voided_credit_notes: ::Array[Orb::CreditNote],
860
+ voided_invoices: ::Array[Orb::Invoice]
861
+ }
689
862
  end
690
863
  end
691
864
  end
@@ -17,6 +17,12 @@ module Orb
17
17
  ?previously_collected_amount: String?,
18
18
  ?request_options: Orb::request_opts
19
19
  ) -> void
20
+
21
+ def to_hash: -> {
22
+ description: String?,
23
+ previously_collected_amount: String?,
24
+ request_options: Orb::RequestOptions
25
+ }
20
26
  end
21
27
  end
22
28
  end