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
@@ -55,11 +55,25 @@ module Orb
55
55
  ?request_options: Orb::request_opts
56
56
  ) -> void
57
57
 
58
+ def to_hash: -> {
59
+ currency: String,
60
+ invoice_date: Time,
61
+ line_items: ::Array[Orb::InvoiceCreateParams::LineItem],
62
+ net_terms: Integer,
63
+ customer_id: String?,
64
+ discount: Orb::Models::discount?,
65
+ external_customer_id: String?,
66
+ memo: String?,
67
+ metadata: ::Hash[Symbol, String?]?,
68
+ will_auto_issue: bool,
69
+ request_options: Orb::RequestOptions
70
+ }
71
+
58
72
  type line_item =
59
73
  {
60
74
  end_date: Date,
61
75
  item_id: String,
62
- model_type: Orb::InvoiceCreateParams::LineItem::model_type,
76
+ model_type: Orb::Models::InvoiceCreateParams::LineItem::model_type,
63
77
  name: String,
64
78
  quantity: Float,
65
79
  start_date: Date,
@@ -71,7 +85,7 @@ module Orb
71
85
 
72
86
  attr_accessor item_id: String
73
87
 
74
- attr_accessor model_type: Orb::InvoiceCreateParams::LineItem::model_type
88
+ attr_accessor model_type: Orb::Models::InvoiceCreateParams::LineItem::model_type
75
89
 
76
90
  attr_accessor name: String
77
91
 
@@ -84,13 +98,23 @@ module Orb
84
98
  def initialize: (
85
99
  end_date: Date,
86
100
  item_id: String,
87
- model_type: Orb::InvoiceCreateParams::LineItem::model_type,
101
+ model_type: Orb::Models::InvoiceCreateParams::LineItem::model_type,
88
102
  name: String,
89
103
  quantity: Float,
90
104
  start_date: Date,
91
105
  unit_config: Orb::InvoiceCreateParams::LineItem::UnitConfig
92
106
  ) -> void
93
107
 
108
+ def to_hash: -> {
109
+ end_date: Date,
110
+ item_id: String,
111
+ model_type: Orb::Models::InvoiceCreateParams::LineItem::model_type,
112
+ name: String,
113
+ quantity: Float,
114
+ start_date: Date,
115
+ unit_config: Orb::InvoiceCreateParams::LineItem::UnitConfig
116
+ }
117
+
94
118
  type model_type = :unit
95
119
 
96
120
  module ModelType
@@ -98,7 +122,7 @@ module Orb
98
122
 
99
123
  UNIT: :unit
100
124
 
101
- def self?.values: -> ::Array[Orb::InvoiceCreateParams::LineItem::model_type]
125
+ def self?.values: -> ::Array[Orb::Models::InvoiceCreateParams::LineItem::model_type]
102
126
  end
103
127
 
104
128
  type unit_config = { unit_amount: String }
@@ -107,6 +131,8 @@ module Orb
107
131
  attr_accessor unit_amount: String
108
132
 
109
133
  def initialize: (unit_amount: String) -> void
134
+
135
+ def to_hash: -> { unit_amount: String }
110
136
  end
111
137
  end
112
138
  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
@@ -13,6 +13,11 @@ module Orb
13
13
  subscription_id: String,
14
14
  ?request_options: Orb::request_opts
15
15
  ) -> void
16
+
17
+ def to_hash: -> {
18
+ subscription_id: String,
19
+ request_options: Orb::RequestOptions
20
+ }
16
21
  end
17
22
  end
18
23
  end
@@ -172,6 +172,50 @@ module Orb
172
172
  will_auto_issue: bool
173
173
  ) -> void
174
174
 
175
+ def to_hash: -> {
176
+ id: String,
177
+ amount_due: String,
178
+ auto_collection: Orb::Models::InvoiceFetchUpcomingResponse::AutoCollection,
179
+ billing_address: Orb::Models::InvoiceFetchUpcomingResponse::BillingAddress?,
180
+ created_at: Time,
181
+ credit_notes: ::Array[Orb::Models::InvoiceFetchUpcomingResponse::CreditNote],
182
+ currency: String,
183
+ customer: Orb::Models::InvoiceFetchUpcomingResponse::Customer,
184
+ customer_balance_transactions: ::Array[Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction],
185
+ customer_tax_id: Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID?,
186
+ discount: top,
187
+ discounts: ::Array[Orb::Models::invoice_level_discount],
188
+ due_date: Time?,
189
+ eligible_to_issue_at: Time?,
190
+ hosted_invoice_url: String?,
191
+ invoice_number: String,
192
+ invoice_pdf: String?,
193
+ invoice_source: Orb::Models::InvoiceFetchUpcomingResponse::invoice_source,
194
+ issue_failed_at: Time?,
195
+ issued_at: Time?,
196
+ line_items: ::Array[Orb::Models::InvoiceFetchUpcomingResponse::LineItem],
197
+ maximum: Orb::Models::InvoiceFetchUpcomingResponse::Maximum?,
198
+ maximum_amount: String?,
199
+ memo: String?,
200
+ metadata: ::Hash[Symbol, String],
201
+ minimum: Orb::Models::InvoiceFetchUpcomingResponse::Minimum?,
202
+ minimum_amount: String?,
203
+ paid_at: Time?,
204
+ payment_attempts: ::Array[Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt],
205
+ payment_failed_at: Time?,
206
+ payment_started_at: Time?,
207
+ scheduled_issue_at: Time?,
208
+ shipping_address: Orb::Models::InvoiceFetchUpcomingResponse::ShippingAddress?,
209
+ status: Orb::Models::InvoiceFetchUpcomingResponse::status,
210
+ subscription: Orb::Models::InvoiceFetchUpcomingResponse::Subscription?,
211
+ subtotal: String,
212
+ sync_failed_at: Time?,
213
+ target_date: Time,
214
+ total: String,
215
+ voided_at: Time?,
216
+ will_auto_issue: bool
217
+ }
218
+
175
219
  type auto_collection =
176
220
  {
177
221
  enabled: bool?,
@@ -195,6 +239,13 @@ module Orb
195
239
  num_attempts: Integer?,
196
240
  previously_attempted_at: Time?
197
241
  ) -> void
242
+
243
+ def to_hash: -> {
244
+ enabled: bool?,
245
+ next_attempt_at: Time?,
246
+ num_attempts: Integer?,
247
+ previously_attempted_at: Time?
248
+ }
198
249
  end
199
250
 
200
251
  type billing_address =
@@ -228,6 +279,15 @@ module Orb
228
279
  postal_code: String?,
229
280
  state: String?
230
281
  ) -> void
282
+
283
+ def to_hash: -> {
284
+ city: String?,
285
+ country: String?,
286
+ :line1 => String?,
287
+ :line2 => String?,
288
+ postal_code: String?,
289
+ state: String?
290
+ }
231
291
  end
232
292
 
233
293
  type credit_note =
@@ -265,6 +325,16 @@ module Orb
265
325
  type: String,
266
326
  voided_at: Time?
267
327
  ) -> void
328
+
329
+ def to_hash: -> {
330
+ id: String,
331
+ credit_note_number: String,
332
+ memo: String?,
333
+ reason: String,
334
+ total: String,
335
+ type: String,
336
+ voided_at: Time?
337
+ }
268
338
  end
269
339
 
270
340
  type customer = { id: String, external_customer_id: String? }
@@ -275,6 +345,8 @@ module Orb
275
345
  attr_accessor external_customer_id: String?
276
346
 
277
347
  def initialize: (id: String, external_customer_id: String?) -> void
348
+
349
+ def to_hash: -> { id: String, external_customer_id: String? }
278
350
  end
279
351
 
280
352
  type customer_balance_transaction =
@@ -325,6 +397,19 @@ module Orb
325
397
  type: Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::type_
326
398
  ) -> void
327
399
 
400
+ def to_hash: -> {
401
+ id: String,
402
+ action: Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::action,
403
+ amount: String,
404
+ created_at: Time,
405
+ credit_note: Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::CreditNote?,
406
+ description: String?,
407
+ ending_balance: String,
408
+ invoice: Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Invoice?,
409
+ starting_balance: String,
410
+ type: Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::type_
411
+ }
412
+
328
413
  type action =
329
414
  :applied_to_invoice
330
415
  | :manual_adjustment
@@ -358,6 +443,8 @@ module Orb
358
443
  attr_accessor id: String
359
444
 
360
445
  def initialize: (id: String) -> void
446
+
447
+ def to_hash: -> { id: String }
361
448
  end
362
449
 
363
450
  type invoice = { id: String }
@@ -366,6 +453,8 @@ module Orb
366
453
  attr_accessor id: String
367
454
 
368
455
  def initialize: (id: String) -> void
456
+
457
+ def to_hash: -> { id: String }
369
458
  end
370
459
 
371
460
  type type_ = :increment | :decrement
@@ -400,6 +489,12 @@ module Orb
400
489
  value: String
401
490
  ) -> void
402
491
 
492
+ def to_hash: -> {
493
+ country: Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::country,
494
+ type: Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::type_,
495
+ value: String
496
+ }
497
+
403
498
  type country =
404
499
  :AD
405
500
  | :AE
@@ -825,6 +920,31 @@ module Orb
825
920
  usage_customer_ids: ::Array[String]?
826
921
  ) -> void
827
922
 
923
+ def to_hash: -> {
924
+ id: String,
925
+ adjusted_subtotal: String,
926
+ adjustments: ::Array[Orb::Models::InvoiceFetchUpcomingResponse::LineItem::adjustment],
927
+ amount: String,
928
+ credits_applied: String,
929
+ discount: Orb::Models::discount?,
930
+ end_date: Time,
931
+ filter: String?,
932
+ grouping: String?,
933
+ maximum: Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Maximum?,
934
+ maximum_amount: String?,
935
+ minimum: Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Minimum?,
936
+ minimum_amount: String?,
937
+ name: String,
938
+ partially_invoiced_amount: String,
939
+ price: Orb::Models::price?,
940
+ quantity: Float,
941
+ start_date: Time,
942
+ sub_line_items: ::Array[Orb::Models::InvoiceFetchUpcomingResponse::LineItem::sub_line_item],
943
+ subtotal: String,
944
+ tax_amounts: ::Array[Orb::Models::InvoiceFetchUpcomingResponse::LineItem::TaxAmount],
945
+ usage_customer_ids: ::Array[String]?
946
+ }
947
+
828
948
  type adjustment =
829
949
  Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::UsageDiscount
830
950
  | Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::AmountDiscount
@@ -870,6 +990,16 @@ module Orb
870
990
  usage_discount: Float,
871
991
  ?adjustment_type: :usage_discount
872
992
  ) -> void
993
+
994
+ def to_hash: -> {
995
+ id: String,
996
+ adjustment_type: :usage_discount,
997
+ amount: String,
998
+ applies_to_price_ids: ::Array[String],
999
+ is_invoice_level: bool,
1000
+ reason: String?,
1001
+ usage_discount: Float
1002
+ }
873
1003
  end
874
1004
 
875
1005
  type amount_discount =
@@ -907,6 +1037,16 @@ module Orb
907
1037
  reason: String?,
908
1038
  ?adjustment_type: :amount_discount
909
1039
  ) -> void
1040
+
1041
+ def to_hash: -> {
1042
+ id: String,
1043
+ adjustment_type: :amount_discount,
1044
+ amount: String,
1045
+ amount_discount: String,
1046
+ applies_to_price_ids: ::Array[String],
1047
+ is_invoice_level: bool,
1048
+ reason: String?
1049
+ }
910
1050
  end
911
1051
 
912
1052
  type percentage_discount =
@@ -944,6 +1084,16 @@ module Orb
944
1084
  reason: String?,
945
1085
  ?adjustment_type: :percentage_discount
946
1086
  ) -> void
1087
+
1088
+ def to_hash: -> {
1089
+ id: String,
1090
+ adjustment_type: :percentage_discount,
1091
+ amount: String,
1092
+ applies_to_price_ids: ::Array[String],
1093
+ is_invoice_level: bool,
1094
+ percentage_discount: Float,
1095
+ reason: String?
1096
+ }
947
1097
  end
948
1098
 
949
1099
  type minimum =
@@ -985,6 +1135,17 @@ module Orb
985
1135
  reason: String?,
986
1136
  ?adjustment_type: :minimum
987
1137
  ) -> void
1138
+
1139
+ def to_hash: -> {
1140
+ id: String,
1141
+ adjustment_type: :minimum,
1142
+ amount: String,
1143
+ applies_to_price_ids: ::Array[String],
1144
+ is_invoice_level: bool,
1145
+ item_id: String,
1146
+ minimum_amount: String,
1147
+ reason: String?
1148
+ }
988
1149
  end
989
1150
 
990
1151
  type maximum =
@@ -1022,6 +1183,16 @@ module Orb
1022
1183
  reason: String?,
1023
1184
  ?adjustment_type: :maximum
1024
1185
  ) -> void
1186
+
1187
+ def to_hash: -> {
1188
+ id: String,
1189
+ adjustment_type: :maximum,
1190
+ amount: String,
1191
+ applies_to_price_ids: ::Array[String],
1192
+ is_invoice_level: bool,
1193
+ maximum_amount: String,
1194
+ reason: String?
1195
+ }
1025
1196
  end
1026
1197
 
1027
1198
  def self?.variants: -> ::Array[Orb::Models::InvoiceFetchUpcomingResponse::LineItem::adjustment]
@@ -1039,6 +1210,11 @@ module Orb
1039
1210
  applies_to_price_ids: ::Array[String],
1040
1211
  maximum_amount: String
1041
1212
  ) -> void
1213
+
1214
+ def to_hash: -> {
1215
+ applies_to_price_ids: ::Array[String],
1216
+ maximum_amount: String
1217
+ }
1042
1218
  end
1043
1219
 
1044
1220
  type minimum =
@@ -1053,6 +1229,11 @@ module Orb
1053
1229
  applies_to_price_ids: ::Array[String],
1054
1230
  minimum_amount: String
1055
1231
  ) -> void
1232
+
1233
+ def to_hash: -> {
1234
+ applies_to_price_ids: ::Array[String],
1235
+ minimum_amount: String
1236
+ }
1056
1237
  end
1057
1238
 
1058
1239
  type sub_line_item =
@@ -1095,6 +1276,15 @@ module Orb
1095
1276
  ?type: :matrix
1096
1277
  ) -> void
1097
1278
 
1279
+ def to_hash: -> {
1280
+ amount: String,
1281
+ grouping: Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix::Grouping?,
1282
+ matrix_config: Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix::MatrixConfig,
1283
+ name: String,
1284
+ quantity: Float,
1285
+ type: :matrix
1286
+ }
1287
+
1098
1288
  type grouping = { key: String, value: String? }
1099
1289
 
1100
1290
  class Grouping < Orb::Internal::Type::BaseModel
@@ -1103,6 +1293,8 @@ module Orb
1103
1293
  attr_accessor value: String?
1104
1294
 
1105
1295
  def initialize: (key: String, value: String?) -> void
1296
+
1297
+ def to_hash: -> { key: String, value: String? }
1106
1298
  end
1107
1299
 
1108
1300
  type matrix_config = { dimension_values: ::Array[String?] }
@@ -1111,6 +1303,8 @@ module Orb
1111
1303
  attr_accessor dimension_values: ::Array[String?]
1112
1304
 
1113
1305
  def initialize: (dimension_values: ::Array[String?]) -> void
1306
+
1307
+ def to_hash: -> { dimension_values: ::Array[String?] }
1114
1308
  end
1115
1309
  end
1116
1310
 
@@ -1146,6 +1340,15 @@ module Orb
1146
1340
  ?type: :tier
1147
1341
  ) -> void
1148
1342
 
1343
+ def to_hash: -> {
1344
+ amount: String,
1345
+ grouping: Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier::Grouping?,
1346
+ name: String,
1347
+ quantity: Float,
1348
+ tier_config: Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier::TierConfig,
1349
+ type: :tier
1350
+ }
1351
+
1149
1352
  type grouping = { key: String, value: String? }
1150
1353
 
1151
1354
  class Grouping < Orb::Internal::Type::BaseModel
@@ -1154,6 +1357,8 @@ module Orb
1154
1357
  attr_accessor value: String?
1155
1358
 
1156
1359
  def initialize: (key: String, value: String?) -> void
1360
+
1361
+ def to_hash: -> { key: String, value: String? }
1157
1362
  end
1158
1363
 
1159
1364
  type tier_config =
@@ -1171,6 +1376,12 @@ module Orb
1171
1376
  last_unit: Float?,
1172
1377
  unit_amount: String
1173
1378
  ) -> void
1379
+
1380
+ def to_hash: -> {
1381
+ first_unit: Float,
1382
+ last_unit: Float?,
1383
+ unit_amount: String
1384
+ }
1174
1385
  end
1175
1386
  end
1176
1387
 
@@ -1202,6 +1413,14 @@ module Orb
1202
1413
  ?type: :"'null'"
1203
1414
  ) -> void
1204
1415
 
1416
+ def to_hash: -> {
1417
+ amount: String,
1418
+ grouping: Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Null::Grouping?,
1419
+ name: String,
1420
+ quantity: Float,
1421
+ type: :"'null'"
1422
+ }
1423
+
1205
1424
  type grouping = { key: String, value: String? }
1206
1425
 
1207
1426
  class Grouping < Orb::Internal::Type::BaseModel
@@ -1210,6 +1429,8 @@ module Orb
1210
1429
  attr_accessor value: String?
1211
1430
 
1212
1431
  def initialize: (key: String, value: String?) -> void
1432
+
1433
+ def to_hash: -> { key: String, value: String? }
1213
1434
  end
1214
1435
  end
1215
1436
 
@@ -1235,6 +1456,12 @@ module Orb
1235
1456
  tax_rate_description: String,
1236
1457
  tax_rate_percentage: String?
1237
1458
  ) -> void
1459
+
1460
+ def to_hash: -> {
1461
+ amount: String,
1462
+ tax_rate_description: String,
1463
+ tax_rate_percentage: String?
1464
+ }
1238
1465
  end
1239
1466
  end
1240
1467
 
@@ -1250,6 +1477,11 @@ module Orb
1250
1477
  applies_to_price_ids: ::Array[String],
1251
1478
  maximum_amount: String
1252
1479
  ) -> void
1480
+
1481
+ def to_hash: -> {
1482
+ applies_to_price_ids: ::Array[String],
1483
+ maximum_amount: String
1484
+ }
1253
1485
  end
1254
1486
 
1255
1487
  type minimum =
@@ -1264,6 +1496,11 @@ module Orb
1264
1496
  applies_to_price_ids: ::Array[String],
1265
1497
  minimum_amount: String
1266
1498
  ) -> void
1499
+
1500
+ def to_hash: -> {
1501
+ applies_to_price_ids: ::Array[String],
1502
+ minimum_amount: String
1503
+ }
1267
1504
  end
1268
1505
 
1269
1506
  type payment_attempt =
@@ -1298,6 +1535,15 @@ module Orb
1298
1535
  succeeded: bool
1299
1536
  ) -> void
1300
1537
 
1538
+ def to_hash: -> {
1539
+ id: String,
1540
+ amount: String,
1541
+ created_at: Time,
1542
+ payment_provider: Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt::payment_provider?,
1543
+ payment_provider_id: String?,
1544
+ succeeded: bool
1545
+ }
1546
+
1301
1547
  type payment_provider = :stripe
1302
1548
 
1303
1549
  module PaymentProvider
@@ -1340,6 +1586,15 @@ module Orb
1340
1586
  postal_code: String?,
1341
1587
  state: String?
1342
1588
  ) -> void
1589
+
1590
+ def to_hash: -> {
1591
+ city: String?,
1592
+ country: String?,
1593
+ :line1 => String?,
1594
+ :line2 => String?,
1595
+ postal_code: String?,
1596
+ state: String?
1597
+ }
1343
1598
  end
1344
1599
 
1345
1600
  type status = :issued | :paid | :synced | :void | :draft
@@ -1362,6 +1617,8 @@ module Orb
1362
1617
  attr_accessor id: String
1363
1618
 
1364
1619
  def initialize: (id: String) -> void
1620
+
1621
+ def to_hash: -> { id: String }
1365
1622
  end
1366
1623
  end
1367
1624
  end
@@ -15,6 +15,11 @@ module Orb
15
15
  ?synchronous: bool,
16
16
  ?request_options: Orb::request_opts
17
17
  ) -> void
18
+
19
+ def to_hash: -> {
20
+ synchronous: bool,
21
+ request_options: Orb::RequestOptions
22
+ }
18
23
  end
19
24
  end
20
25
  end
@@ -36,6 +36,16 @@ module Orb
36
36
  start_date: Date,
37
37
  ?request_options: Orb::request_opts
38
38
  ) -> void
39
+
40
+ def to_hash: -> {
41
+ amount: String,
42
+ end_date: Date,
43
+ invoice_id: String,
44
+ name: String,
45
+ quantity: Float,
46
+ start_date: Date,
47
+ request_options: Orb::RequestOptions
48
+ }
39
49
  end
40
50
  end
41
51
  end