orb-billing 0.5.2 → 0.5.3

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 (279) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +12 -0
  3. data/README.md +4 -4
  4. data/SECURITY.md +2 -2
  5. data/lib/orb/internal.rb +3 -0
  6. data/lib/orb/models/alert.rb +23 -23
  7. data/lib/orb/models/alert_create_for_customer_params.rb +5 -5
  8. data/lib/orb/models/alert_create_for_external_customer_params.rb +5 -5
  9. data/lib/orb/models/alert_create_for_subscription_params.rb +5 -5
  10. data/lib/orb/models/alert_update_params.rb +3 -3
  11. data/lib/orb/models/amount_discount.rb +5 -5
  12. data/lib/orb/models/billable_metric.rb +7 -7
  13. data/lib/orb/models/coupon.rb +6 -6
  14. data/lib/orb/models/coupon_create_params.rb +3 -3
  15. data/lib/orb/models/credit_note.rb +33 -33
  16. data/lib/orb/models/credit_note_create_params.rb +4 -4
  17. data/lib/orb/models/customer.rb +39 -39
  18. data/lib/orb/models/customer_create_params.rb +26 -26
  19. data/lib/orb/models/customer_update_by_external_id_params.rb +26 -26
  20. data/lib/orb/models/customer_update_params.rb +26 -26
  21. data/lib/orb/models/customers/balance_transaction_create_params.rb +2 -2
  22. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +2 -2
  23. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +2 -2
  24. data/lib/orb/models/customers/cost_list_params.rb +2 -2
  25. data/lib/orb/models/customers/cost_list_response.rb +2 -2
  26. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +7 -7
  27. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +8 -8
  28. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +4 -4
  29. data/lib/orb/models/customers/credits/ledger_list_params.rb +4 -4
  30. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +6 -6
  31. data/lib/orb/models/customers/credits/top_up_create_params.rb +6 -5
  32. data/lib/orb/models/dimensional_price_group.rb +1 -1
  33. data/lib/orb/models/dimensional_price_groups.rb +4 -4
  34. data/lib/orb/models/discount.rb +1 -1
  35. data/lib/orb/models/event_ingest_params.rb +3 -3
  36. data/lib/orb/models/events/event_volumes.rb +2 -2
  37. data/lib/orb/models/invoice.rb +114 -113
  38. data/lib/orb/models/invoice_create_params.rb +10 -10
  39. data/lib/orb/models/invoice_fetch_upcoming_response.rb +6 -6
  40. data/lib/orb/models/invoice_level_discount.rb +1 -1
  41. data/lib/orb/models/invoice_line_item_create_response.rb +4 -4
  42. data/lib/orb/models/invoice_list_params.rb +4 -4
  43. data/lib/orb/models/item.rb +5 -5
  44. data/lib/orb/models/item_update_params.rb +5 -5
  45. data/lib/orb/models/percentage_discount.rb +5 -5
  46. data/lib/orb/models/plan.rb +58 -58
  47. data/lib/orb/models/plan_create_params.rb +448 -444
  48. data/lib/orb/models/plan_list_params.rb +2 -2
  49. data/lib/orb/models/price.rb +1204 -1204
  50. data/lib/orb/models/price_create_params.rb +50 -50
  51. data/lib/orb/models/price_evaluate_response.rb +2 -2
  52. data/lib/orb/models/subscription.rb +58 -56
  53. data/lib/orb/models/subscription_cancel_params.rb +2 -2
  54. data/lib/orb/models/subscription_cancel_response.rb +14 -14
  55. data/lib/orb/models/subscription_change_apply_response.rb +14 -14
  56. data/lib/orb/models/subscription_change_cancel_response.rb +14 -14
  57. data/lib/orb/models/subscription_change_retrieve_response.rb +14 -14
  58. data/lib/orb/models/subscription_create_params.rb +1002 -987
  59. data/lib/orb/models/subscription_create_response.rb +14 -14
  60. data/lib/orb/models/subscription_fetch_costs_params.rb +2 -2
  61. data/lib/orb/models/subscription_fetch_costs_response.rb +2 -2
  62. data/lib/orb/models/subscription_fetch_usage_params.rb +4 -4
  63. data/lib/orb/models/subscription_list_params.rb +2 -2
  64. data/lib/orb/models/subscription_price_intervals_params.rb +596 -585
  65. data/lib/orb/models/subscription_price_intervals_response.rb +14 -14
  66. data/lib/orb/models/subscription_schedule_plan_change_params.rb +973 -971
  67. data/lib/orb/models/subscription_schedule_plan_change_response.rb +14 -14
  68. data/lib/orb/models/subscription_trigger_phase_response.rb +14 -14
  69. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +14 -14
  70. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +14 -14
  71. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +14 -14
  72. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +2 -2
  73. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +14 -14
  74. data/lib/orb/models/subscription_update_trial_params.rb +3 -3
  75. data/lib/orb/models/subscription_update_trial_response.rb +14 -14
  76. data/lib/orb/models/subscription_usage.rb +26 -26
  77. data/lib/orb/models/subscriptions.rb +4 -4
  78. data/lib/orb/models/trial_discount.rb +5 -5
  79. data/lib/orb/models/usage_discount.rb +5 -5
  80. data/lib/orb/resources/alerts.rb +15 -15
  81. data/lib/orb/resources/coupons/subscriptions.rb +1 -1
  82. data/lib/orb/resources/coupons.rb +5 -5
  83. data/lib/orb/resources/credit_notes.rb +5 -5
  84. data/lib/orb/resources/customers/balance_transactions.rb +1 -1
  85. data/lib/orb/resources/customers/costs.rb +2 -2
  86. data/lib/orb/resources/customers/credits/ledger.rb +10 -10
  87. data/lib/orb/resources/customers/credits/top_ups.rb +4 -4
  88. data/lib/orb/resources/customers.rb +30 -30
  89. data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +1 -1
  90. data/lib/orb/resources/dimensional_price_groups.rb +3 -3
  91. data/lib/orb/resources/events/volume.rb +1 -1
  92. data/lib/orb/resources/events.rb +1 -1
  93. data/lib/orb/resources/invoices.rb +12 -12
  94. data/lib/orb/resources/items.rb +5 -5
  95. data/lib/orb/resources/metrics.rb +4 -4
  96. data/lib/orb/resources/plans/external_plan_id.rb +2 -2
  97. data/lib/orb/resources/plans.rb +7 -7
  98. data/lib/orb/resources/prices/external_price_id.rb +2 -2
  99. data/lib/orb/resources/prices.rb +17 -17
  100. data/lib/orb/resources/subscriptions.rb +32 -32
  101. data/lib/orb/version.rb +1 -1
  102. data/rbi/orb/internal.rbi +3 -0
  103. data/rbi/orb/models/subscription_price_intervals_params.rbi +26 -72
  104. data/rbi/orb/models/subscription_update_trial_params.rbi +14 -3
  105. data/rbi/orb/resources/subscriptions.rbi +4 -1
  106. data/sig/orb/internal/page.rbs +2 -0
  107. data/sig/orb/internal.rbs +2 -0
  108. data/sig/orb/models/alert.rbs +32 -4
  109. data/sig/orb/models/alert_create_for_customer_params.rbs +9 -0
  110. data/sig/orb/models/alert_create_for_external_customer_params.rbs +9 -0
  111. data/sig/orb/models/alert_create_for_subscription_params.rbs +9 -0
  112. data/sig/orb/models/alert_disable_params.rbs +5 -0
  113. data/sig/orb/models/alert_enable_params.rbs +5 -0
  114. data/sig/orb/models/alert_list_params.rbs +13 -0
  115. data/sig/orb/models/alert_retrieve_params.rbs +2 -0
  116. data/sig/orb/models/alert_update_params.rbs +7 -0
  117. data/sig/orb/models/amount_discount.rbs +11 -4
  118. data/sig/orb/models/billable_metric.rbs +13 -4
  119. data/sig/orb/models/coupon.rbs +14 -4
  120. data/sig/orb/models/coupon_archive_params.rbs +2 -0
  121. data/sig/orb/models/coupon_create_params.rbs +15 -0
  122. data/sig/orb/models/coupon_fetch_params.rbs +2 -0
  123. data/sig/orb/models/coupon_list_params.rbs +8 -0
  124. data/sig/orb/models/coupons/subscription_list_params.rbs +6 -0
  125. data/sig/orb/models/credit_note.rbs +88 -20
  126. data/sig/orb/models/credit_note_create_params.rbs +9 -0
  127. data/sig/orb/models/credit_note_fetch_params.rbs +2 -0
  128. data/sig/orb/models/credit_note_list_params.rbs +10 -0
  129. data/sig/orb/models/customer.rbs +86 -16
  130. data/sig/orb/models/customer_create_params.rbs +79 -8
  131. data/sig/orb/models/customer_delete_params.rbs +2 -0
  132. data/sig/orb/models/customer_fetch_by_external_id_params.rbs +2 -0
  133. data/sig/orb/models/customer_fetch_params.rbs +2 -0
  134. data/sig/orb/models/customer_list_params.rbs +10 -0
  135. data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +2 -0
  136. data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +2 -0
  137. data/sig/orb/models/customer_update_by_external_id_params.rbs +78 -8
  138. data/sig/orb/models/customer_update_params.rbs +78 -8
  139. data/sig/orb/models/customers/balance_transaction_create_params.rbs +7 -0
  140. data/sig/orb/models/customers/balance_transaction_create_response.rbs +17 -0
  141. data/sig/orb/models/customers/balance_transaction_list_params.rbs +10 -0
  142. data/sig/orb/models/customers/balance_transaction_list_response.rbs +17 -0
  143. data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +8 -0
  144. data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +20 -0
  145. data/sig/orb/models/customers/cost_list_params.rbs +8 -0
  146. data/sig/orb/models/customers/cost_list_response.rbs +20 -0
  147. data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +8 -0
  148. data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +10 -0
  149. data/sig/orb/models/customers/credit_list_params.rbs +8 -0
  150. data/sig/orb/models/customers/credit_list_response.rbs +10 -0
  151. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +23 -0
  152. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +177 -0
  153. data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +23 -0
  154. data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +177 -0
  155. data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +14 -0
  156. data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +177 -0
  157. data/sig/orb/models/customers/credits/ledger_list_params.rbs +14 -0
  158. data/sig/orb/models/customers/credits/ledger_list_response.rbs +177 -0
  159. data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +19 -0
  160. data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +18 -0
  161. data/sig/orb/models/customers/credits/top_up_create_params.rbs +19 -0
  162. data/sig/orb/models/customers/credits/top_up_create_response.rbs +18 -0
  163. data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +5 -0
  164. data/sig/orb/models/customers/credits/top_up_delete_params.rbs +5 -0
  165. data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +6 -0
  166. data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +18 -0
  167. data/sig/orb/models/customers/credits/top_up_list_params.rbs +6 -0
  168. data/sig/orb/models/customers/credits/top_up_list_response.rbs +18 -0
  169. data/sig/orb/models/dimensional_price_group.rbs +9 -0
  170. data/sig/orb/models/dimensional_price_group_create_params.rbs +9 -0
  171. data/sig/orb/models/dimensional_price_group_list_params.rbs +6 -0
  172. data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +2 -0
  173. data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +2 -0
  174. data/sig/orb/models/dimensional_price_groups.rbs +5 -0
  175. data/sig/orb/models/evaluate_price_group.rbs +10 -4
  176. data/sig/orb/models/event_deprecate_params.rbs +2 -0
  177. data/sig/orb/models/event_deprecate_response.rbs +2 -0
  178. data/sig/orb/models/event_ingest_params.rbs +16 -0
  179. data/sig/orb/models/event_ingest_response.rbs +15 -0
  180. data/sig/orb/models/event_search_params.rbs +7 -0
  181. data/sig/orb/models/event_search_response.rbs +12 -0
  182. data/sig/orb/models/event_update_params.rbs +9 -0
  183. data/sig/orb/models/event_update_response.rbs +2 -0
  184. data/sig/orb/models/events/backfill_close_params.rbs +2 -0
  185. data/sig/orb/models/events/backfill_close_response.rbs +14 -0
  186. data/sig/orb/models/events/backfill_create_params.rbs +11 -0
  187. data/sig/orb/models/events/backfill_create_response.rbs +14 -0
  188. data/sig/orb/models/events/backfill_fetch_params.rbs +2 -0
  189. data/sig/orb/models/events/backfill_fetch_response.rbs +14 -0
  190. data/sig/orb/models/events/backfill_list_params.rbs +6 -0
  191. data/sig/orb/models/events/backfill_list_response.rbs +14 -0
  192. data/sig/orb/models/events/backfill_revert_params.rbs +2 -0
  193. data/sig/orb/models/events/backfill_revert_response.rbs +14 -0
  194. data/sig/orb/models/events/event_volumes.rbs +8 -0
  195. data/sig/orb/models/events/volume_list_params.rbs +8 -0
  196. data/sig/orb/models/invoice.rbs +293 -36
  197. data/sig/orb/models/invoice_create_params.rbs +30 -4
  198. data/sig/orb/models/invoice_fetch_params.rbs +2 -0
  199. data/sig/orb/models/invoice_fetch_upcoming_params.rbs +5 -0
  200. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +257 -0
  201. data/sig/orb/models/invoice_issue_params.rbs +5 -0
  202. data/sig/orb/models/invoice_line_item_create_params.rbs +10 -0
  203. data/sig/orb/models/invoice_line_item_create_response.rbs +132 -0
  204. data/sig/orb/models/invoice_list_params.rbs +27 -4
  205. data/sig/orb/models/invoice_mark_paid_params.rbs +7 -0
  206. data/sig/orb/models/invoice_pay_params.rbs +2 -0
  207. data/sig/orb/models/invoice_update_params.rbs +5 -0
  208. data/sig/orb/models/invoice_void_params.rbs +2 -0
  209. data/sig/orb/models/item.rbs +16 -4
  210. data/sig/orb/models/item_create_params.rbs +2 -0
  211. data/sig/orb/models/item_fetch_params.rbs +2 -0
  212. data/sig/orb/models/item_list_params.rbs +6 -0
  213. data/sig/orb/models/item_update_params.rbs +15 -4
  214. data/sig/orb/models/metric_create_params.rbs +9 -0
  215. data/sig/orb/models/metric_fetch_params.rbs +2 -0
  216. data/sig/orb/models/metric_list_params.rbs +10 -0
  217. data/sig/orb/models/metric_update_params.rbs +5 -0
  218. data/sig/orb/models/pagination_metadata.rbs +2 -0
  219. data/sig/orb/models/percentage_discount.rbs +11 -4
  220. data/sig/orb/models/plan.rbs +141 -16
  221. data/sig/orb/models/plan_create_params.rbs +1070 -304
  222. data/sig/orb/models/plan_fetch_params.rbs +2 -0
  223. data/sig/orb/models/plan_list_params.rbs +11 -0
  224. data/sig/orb/models/plan_update_params.rbs +6 -0
  225. data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +2 -0
  226. data/sig/orb/models/plans/external_plan_id_update_params.rbs +6 -0
  227. data/sig/orb/models/price.rbs +2148 -460
  228. data/sig/orb/models/price_create_params.rbs +130 -8
  229. data/sig/orb/models/price_evaluate_params.rbs +10 -0
  230. data/sig/orb/models/price_evaluate_response.rbs +2 -0
  231. data/sig/orb/models/price_fetch_params.rbs +2 -0
  232. data/sig/orb/models/price_list_params.rbs +6 -0
  233. data/sig/orb/models/price_update_params.rbs +5 -0
  234. data/sig/orb/models/prices/external_price_id_fetch_params.rbs +2 -0
  235. data/sig/orb/models/prices/external_price_id_update_params.rbs +5 -0
  236. data/sig/orb/models/subscription.rbs +177 -12
  237. data/sig/orb/models/subscription_cancel_params.rbs +7 -0
  238. data/sig/orb/models/subscription_cancel_response.rbs +173 -0
  239. data/sig/orb/models/subscription_change_apply_params.rbs +6 -0
  240. data/sig/orb/models/subscription_change_apply_response.rbs +186 -0
  241. data/sig/orb/models/subscription_change_cancel_params.rbs +2 -0
  242. data/sig/orb/models/subscription_change_cancel_response.rbs +186 -0
  243. data/sig/orb/models/subscription_change_retrieve_params.rbs +2 -0
  244. data/sig/orb/models/subscription_change_retrieve_response.rbs +186 -0
  245. data/sig/orb/models/subscription_create_params.rbs +2368 -632
  246. data/sig/orb/models/subscription_create_response.rbs +173 -0
  247. data/sig/orb/models/subscription_fetch_costs_params.rbs +8 -0
  248. data/sig/orb/models/subscription_fetch_costs_response.rbs +20 -0
  249. data/sig/orb/models/subscription_fetch_params.rbs +2 -0
  250. data/sig/orb/models/subscription_fetch_schedule_params.rbs +10 -0
  251. data/sig/orb/models/subscription_fetch_schedule_response.rbs +13 -0
  252. data/sig/orb/models/subscription_fetch_usage_params.rbs +14 -0
  253. data/sig/orb/models/subscription_list_params.rbs +13 -0
  254. data/sig/orb/models/subscription_price_intervals_params.rbs +1348 -396
  255. data/sig/orb/models/subscription_price_intervals_response.rbs +173 -0
  256. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +2363 -632
  257. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +173 -0
  258. data/sig/orb/models/subscription_trigger_phase_params.rbs +6 -0
  259. data/sig/orb/models/subscription_trigger_phase_response.rbs +173 -0
  260. data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +2 -0
  261. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +173 -0
  262. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +2 -0
  263. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +173 -0
  264. data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +2 -0
  265. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +173 -0
  266. data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +9 -0
  267. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +173 -0
  268. data/sig/orb/models/subscription_update_params.rbs +9 -0
  269. data/sig/orb/models/subscription_update_trial_params.rbs +6 -0
  270. data/sig/orb/models/subscription_update_trial_response.rbs +173 -0
  271. data/sig/orb/models/subscription_usage.rbs +48 -8
  272. data/sig/orb/models/subscriptions.rbs +5 -0
  273. data/sig/orb/models/top_level_ping_params.rbs +2 -0
  274. data/sig/orb/models/top_level_ping_response.rbs +2 -0
  275. data/sig/orb/models/trial_discount.rbs +12 -4
  276. data/sig/orb/models/usage_discount.rbs +11 -4
  277. data/sig/orb/resources/invoices.rbs +1 -1
  278. data/sig/orb/resources/plans.rbs +1 -1
  279. metadata +2 -2
@@ -116,6 +116,36 @@ module Orb
116
116
  ?changed_resources: Orb::Models::SubscriptionUpdateTrialResponse::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::SubscriptionUpdateTrialResponse::AdjustmentInterval],
123
+ auto_collection: bool?,
124
+ billing_cycle_anchor_configuration: Orb::Models::SubscriptionUpdateTrialResponse::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::SubscriptionUpdateTrialResponse::discount_interval],
132
+ end_date: Time?,
133
+ fixed_fee_quantity_schedule: ::Array[Orb::Models::SubscriptionUpdateTrialResponse::FixedFeeQuantitySchedule],
134
+ invoicing_threshold: String?,
135
+ maximum_intervals: ::Array[Orb::Models::SubscriptionUpdateTrialResponse::MaximumInterval],
136
+ metadata: ::Hash[Symbol, String],
137
+ minimum_intervals: ::Array[Orb::Models::SubscriptionUpdateTrialResponse::MinimumInterval],
138
+ net_terms: Integer,
139
+ pending_subscription_change: Orb::Models::SubscriptionUpdateTrialResponse::PendingSubscriptionChange?,
140
+ plan: Orb::Plan,
141
+ price_intervals: ::Array[Orb::Models::SubscriptionUpdateTrialResponse::PriceInterval],
142
+ redeemed_coupon: Orb::Models::SubscriptionUpdateTrialResponse::RedeemedCoupon?,
143
+ start_date: Time,
144
+ status: Orb::Models::SubscriptionUpdateTrialResponse::status,
145
+ trial_info: Orb::Models::SubscriptionUpdateTrialResponse::TrialInfo,
146
+ changed_resources: Orb::Models::SubscriptionUpdateTrialResponse::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::SubscriptionUpdateTrialResponse::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::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::UsageDiscount
149
187
  | Orb::Models::SubscriptionUpdateTrialResponse::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::SubscriptionUpdateTrialResponse::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::SubscriptionUpdateTrialResponse::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::SubscriptionUpdateTrialResponse::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
@@ -19,11 +19,15 @@ module Orb
19
19
  data: ::Array[Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data]
20
20
  ) -> void
21
21
 
22
+ def to_hash: -> {
23
+ data: ::Array[Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data]
24
+ }
25
+
22
26
  type data =
23
27
  {
24
28
  billable_metric: Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data::BillableMetric,
25
29
  usage: ::Array[Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data::Usage],
26
- view_mode: Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data::view_mode
30
+ view_mode: Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::view_mode
27
31
  }
28
32
 
29
33
  class Data < Orb::Internal::Type::BaseModel
@@ -31,14 +35,20 @@ module Orb
31
35
 
32
36
  attr_accessor usage: ::Array[Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data::Usage]
33
37
 
34
- attr_accessor view_mode: Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data::view_mode
38
+ attr_accessor view_mode: Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::view_mode
35
39
 
36
40
  def initialize: (
37
41
  billable_metric: Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data::BillableMetric,
38
42
  usage: ::Array[Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data::Usage],
39
- view_mode: Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data::view_mode
43
+ view_mode: Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::view_mode
40
44
  ) -> void
41
45
 
46
+ def to_hash: -> {
47
+ billable_metric: Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data::BillableMetric,
48
+ usage: ::Array[Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data::Usage],
49
+ view_mode: Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::view_mode
50
+ }
51
+
42
52
  type billable_metric = { id: String, name: String }
43
53
 
44
54
  class BillableMetric < Orb::Internal::Type::BaseModel
@@ -47,6 +57,8 @@ module Orb
47
57
  attr_accessor name: String
48
58
 
49
59
  def initialize: (id: String, name: String) -> void
60
+
61
+ def to_hash: -> { id: String, name: String }
50
62
  end
51
63
 
52
64
  type usage =
@@ -64,6 +76,12 @@ module Orb
64
76
  timeframe_end: Time,
65
77
  timeframe_start: Time
66
78
  ) -> void
79
+
80
+ def to_hash: -> {
81
+ quantity: Float,
82
+ timeframe_end: Time,
83
+ timeframe_start: Time
84
+ }
67
85
  end
68
86
 
69
87
  type view_mode = :periodic | :cumulative
@@ -74,7 +92,7 @@ module Orb
74
92
  PERIODIC: :periodic
75
93
  CUMULATIVE: :cumulative
76
94
 
77
- def self?.values: -> ::Array[Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data::view_mode]
95
+ def self?.values: -> ::Array[Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::view_mode]
78
96
  end
79
97
  end
80
98
  end
@@ -95,12 +113,17 @@ module Orb
95
113
  ?pagination_metadata: Orb::PaginationMetadata?
96
114
  ) -> void
97
115
 
116
+ def to_hash: -> {
117
+ data: ::Array[Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data],
118
+ pagination_metadata: Orb::PaginationMetadata?
119
+ }
120
+
98
121
  type data =
99
122
  {
100
123
  billable_metric: Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::BillableMetric,
101
124
  metric_group: Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::MetricGroup,
102
125
  usage: ::Array[Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::Usage],
103
- view_mode: Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::view_mode
126
+ view_mode: Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::view_mode
104
127
  }
105
128
 
106
129
  class Data < Orb::Internal::Type::BaseModel
@@ -110,15 +133,22 @@ module Orb
110
133
 
111
134
  attr_accessor usage: ::Array[Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::Usage]
112
135
 
113
- attr_accessor view_mode: Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::view_mode
136
+ attr_accessor view_mode: Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::view_mode
114
137
 
115
138
  def initialize: (
116
139
  billable_metric: Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::BillableMetric,
117
140
  metric_group: Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::MetricGroup,
118
141
  usage: ::Array[Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::Usage],
119
- view_mode: Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::view_mode
142
+ view_mode: Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::view_mode
120
143
  ) -> void
121
144
 
145
+ def to_hash: -> {
146
+ billable_metric: Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::BillableMetric,
147
+ metric_group: Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::MetricGroup,
148
+ usage: ::Array[Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::Usage],
149
+ view_mode: Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::view_mode
150
+ }
151
+
122
152
  type billable_metric = { id: String, name: String }
123
153
 
124
154
  class BillableMetric < Orb::Internal::Type::BaseModel
@@ -127,6 +157,8 @@ module Orb
127
157
  attr_accessor name: String
128
158
 
129
159
  def initialize: (id: String, name: String) -> void
160
+
161
+ def to_hash: -> { id: String, name: String }
130
162
  end
131
163
 
132
164
  type metric_group = { property_key: String, property_value: String }
@@ -140,6 +172,8 @@ module Orb
140
172
  property_key: String,
141
173
  property_value: String
142
174
  ) -> void
175
+
176
+ def to_hash: -> { property_key: String, property_value: String }
143
177
  end
144
178
 
145
179
  type usage =
@@ -157,6 +191,12 @@ module Orb
157
191
  timeframe_end: Time,
158
192
  timeframe_start: Time
159
193
  ) -> void
194
+
195
+ def to_hash: -> {
196
+ quantity: Float,
197
+ timeframe_end: Time,
198
+ timeframe_start: Time
199
+ }
160
200
  end
161
201
 
162
202
  type view_mode = :periodic | :cumulative
@@ -167,7 +207,7 @@ module Orb
167
207
  PERIODIC: :periodic
168
208
  CUMULATIVE: :cumulative
169
209
 
170
- def self?.values: -> ::Array[Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::view_mode]
210
+ def self?.values: -> ::Array[Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::view_mode]
171
211
  end
172
212
  end
173
213
  end
@@ -15,6 +15,11 @@ module Orb
15
15
  data: ::Array[Orb::Subscription],
16
16
  pagination_metadata: Orb::PaginationMetadata
17
17
  ) -> void
18
+
19
+ def to_hash: -> {
20
+ data: ::Array[Orb::Subscription],
21
+ pagination_metadata: Orb::PaginationMetadata
22
+ }
18
23
  end
19
24
  end
20
25
  end
@@ -7,6 +7,8 @@ module Orb
7
7
  include Orb::Internal::Type::RequestParameters
8
8
 
9
9
  def initialize: (?request_options: Orb::request_opts) -> void
10
+
11
+ def to_hash: -> { request_options: Orb::RequestOptions }
10
12
  end
11
13
  end
12
14
  end
@@ -6,6 +6,8 @@ module Orb
6
6
  attr_accessor response: String
7
7
 
8
8
  def initialize: (response: String) -> void
9
+
10
+ def to_hash: -> { response: String }
9
11
  end
10
12
  end
11
13
  end
@@ -3,7 +3,7 @@ module Orb
3
3
  type trial_discount =
4
4
  {
5
5
  applies_to_price_ids: ::Array[String],
6
- discount_type: Orb::TrialDiscount::discount_type,
6
+ discount_type: Orb::Models::TrialDiscount::discount_type,
7
7
  reason: String?,
8
8
  trial_amount_discount: String?,
9
9
  trial_percentage_discount: Float?
@@ -12,7 +12,7 @@ module Orb
12
12
  class TrialDiscount < Orb::Internal::Type::BaseModel
13
13
  attr_accessor applies_to_price_ids: ::Array[String]
14
14
 
15
- attr_accessor discount_type: Orb::TrialDiscount::discount_type
15
+ attr_accessor discount_type: Orb::Models::TrialDiscount::discount_type
16
16
 
17
17
  attr_accessor reason: String?
18
18
 
@@ -22,12 +22,20 @@ module Orb
22
22
 
23
23
  def initialize: (
24
24
  applies_to_price_ids: ::Array[String],
25
- discount_type: Orb::TrialDiscount::discount_type,
25
+ discount_type: Orb::Models::TrialDiscount::discount_type,
26
26
  ?reason: String?,
27
27
  ?trial_amount_discount: String?,
28
28
  ?trial_percentage_discount: Float?
29
29
  ) -> void
30
30
 
31
+ def to_hash: -> {
32
+ applies_to_price_ids: ::Array[String],
33
+ discount_type: Orb::Models::TrialDiscount::discount_type,
34
+ reason: String?,
35
+ trial_amount_discount: String?,
36
+ trial_percentage_discount: Float?
37
+ }
38
+
31
39
  type discount_type = :trial
32
40
 
33
41
  module DiscountType
@@ -35,7 +43,7 @@ module Orb
35
43
 
36
44
  TRIAL: :trial
37
45
 
38
- def self?.values: -> ::Array[Orb::TrialDiscount::discount_type]
46
+ def self?.values: -> ::Array[Orb::Models::TrialDiscount::discount_type]
39
47
  end
40
48
  end
41
49
  end
@@ -3,7 +3,7 @@ module Orb
3
3
  type usage_discount =
4
4
  {
5
5
  applies_to_price_ids: ::Array[String],
6
- discount_type: Orb::UsageDiscount::discount_type,
6
+ discount_type: Orb::Models::UsageDiscount::discount_type,
7
7
  usage_discount: Float,
8
8
  reason: String?
9
9
  }
@@ -11,7 +11,7 @@ module Orb
11
11
  class UsageDiscount < Orb::Internal::Type::BaseModel
12
12
  attr_accessor applies_to_price_ids: ::Array[String]
13
13
 
14
- attr_accessor discount_type: Orb::UsageDiscount::discount_type
14
+ attr_accessor discount_type: Orb::Models::UsageDiscount::discount_type
15
15
 
16
16
  attr_accessor usage_discount: Float
17
17
 
@@ -19,11 +19,18 @@ module Orb
19
19
 
20
20
  def initialize: (
21
21
  applies_to_price_ids: ::Array[String],
22
- discount_type: Orb::UsageDiscount::discount_type,
22
+ discount_type: Orb::Models::UsageDiscount::discount_type,
23
23
  usage_discount: Float,
24
24
  ?reason: String?
25
25
  ) -> void
26
26
 
27
+ def to_hash: -> {
28
+ applies_to_price_ids: ::Array[String],
29
+ discount_type: Orb::Models::UsageDiscount::discount_type,
30
+ usage_discount: Float,
31
+ reason: String?
32
+ }
33
+
27
34
  type discount_type = :usage
28
35
 
29
36
  module DiscountType
@@ -31,7 +38,7 @@ module Orb
31
38
 
32
39
  USAGE: :usage
33
40
 
34
- def self?.values: -> ::Array[Orb::UsageDiscount::discount_type]
41
+ def self?.values: -> ::Array[Orb::Models::UsageDiscount::discount_type]
35
42
  end
36
43
  end
37
44
  end
@@ -39,7 +39,7 @@ module Orb
39
39
  ?invoice_date_lte: Time?,
40
40
  ?is_recurring: bool?,
41
41
  ?limit: Integer,
42
- ?status: ::Array[Orb::InvoiceListParams::status]?,
42
+ ?status: ::Array[Orb::Models::InvoiceListParams::status]?,
43
43
  ?subscription_id: String?,
44
44
  ?request_options: Orb::request_opts
45
45
  ) -> Orb::Internal::Page[Orb::Invoice]
@@ -6,7 +6,7 @@ module Orb
6
6
  def create: (
7
7
  currency: String,
8
8
  name: String,
9
- prices: ::Array[Orb::PlanCreateParams::price],
9
+ prices: ::Array[Orb::Models::PlanCreateParams::price],
10
10
  ?default_invoice_memo: String?,
11
11
  ?external_plan_id: String?,
12
12
  ?metadata: ::Hash[Symbol, String?]?,
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: orb-billing
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.5.2
4
+ version: 0.5.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Orb
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-05-20 00:00:00.000000000 Z
11
+ date: 2025-05-22 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: connection_pool