orb-billing 0.5.1 → 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 (337) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +26 -0
  3. data/README.md +4 -4
  4. data/SECURITY.md +2 -2
  5. data/lib/orb/internal/type/array_of.rb +8 -0
  6. data/lib/orb/internal/type/base_model.rb +7 -0
  7. data/lib/orb/internal/type/boolean.rb +8 -0
  8. data/lib/orb/internal/type/enum.rb +12 -0
  9. data/lib/orb/internal/type/file_input.rb +7 -0
  10. data/lib/orb/internal/type/hash_of.rb +8 -0
  11. data/lib/orb/internal/type/union.rb +12 -0
  12. data/lib/orb/internal/type/unknown.rb +8 -0
  13. data/lib/orb/internal/util.rb +45 -0
  14. data/lib/orb/internal.rb +3 -0
  15. data/lib/orb/models/alert.rb +23 -23
  16. data/lib/orb/models/alert_create_for_customer_params.rb +5 -5
  17. data/lib/orb/models/alert_create_for_external_customer_params.rb +5 -5
  18. data/lib/orb/models/alert_create_for_subscription_params.rb +5 -5
  19. data/lib/orb/models/alert_update_params.rb +3 -3
  20. data/lib/orb/models/amount_discount.rb +5 -5
  21. data/lib/orb/models/billable_metric.rb +7 -7
  22. data/lib/orb/models/coupon.rb +6 -10
  23. data/lib/orb/models/coupon_create_params.rb +3 -9
  24. data/lib/orb/models/credit_note.rb +33 -33
  25. data/lib/orb/models/credit_note_create_params.rb +4 -4
  26. data/lib/orb/models/customer.rb +39 -39
  27. data/lib/orb/models/customer_create_params.rb +26 -35
  28. data/lib/orb/models/customer_update_by_external_id_params.rb +26 -35
  29. data/lib/orb/models/customer_update_params.rb +26 -35
  30. data/lib/orb/models/customers/balance_transaction_create_params.rb +2 -2
  31. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +2 -2
  32. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +2 -2
  33. data/lib/orb/models/customers/cost_list_params.rb +2 -2
  34. data/lib/orb/models/customers/cost_list_response.rb +2 -2
  35. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +7 -7
  36. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +0 -14
  37. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +8 -8
  38. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +0 -14
  39. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +4 -4
  40. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +0 -14
  41. data/lib/orb/models/customers/credits/ledger_list_params.rb +4 -4
  42. data/lib/orb/models/customers/credits/ledger_list_response.rb +0 -14
  43. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +6 -6
  44. data/lib/orb/models/customers/credits/top_up_create_params.rb +6 -5
  45. data/lib/orb/models/dimensional_price_group.rb +1 -1
  46. data/lib/orb/models/dimensional_price_groups.rb +4 -4
  47. data/lib/orb/models/discount.rb +1 -7
  48. data/lib/orb/models/evaluate_price_group.rb +0 -4
  49. data/lib/orb/models/event_ingest_params.rb +3 -3
  50. data/lib/orb/models/events/event_volumes.rb +2 -2
  51. data/lib/orb/models/invoice.rb +114 -135
  52. data/lib/orb/models/invoice_create_params.rb +10 -10
  53. data/lib/orb/models/invoice_fetch_upcoming_response.rb +6 -28
  54. data/lib/orb/models/invoice_level_discount.rb +1 -5
  55. data/lib/orb/models/invoice_line_item_create_response.rb +4 -26
  56. data/lib/orb/models/invoice_list_params.rb +4 -4
  57. data/lib/orb/models/item.rb +5 -5
  58. data/lib/orb/models/item_update_params.rb +5 -5
  59. data/lib/orb/models/percentage_discount.rb +5 -5
  60. data/lib/orb/models/plan.rb +58 -70
  61. data/lib/orb/models/plan_create_params.rb +448 -476
  62. data/lib/orb/models/plan_list_params.rb +2 -2
  63. data/lib/orb/models/price.rb +1204 -1239
  64. data/lib/orb/models/price_create_params.rb +50 -50
  65. data/lib/orb/models/price_evaluate_response.rb +2 -2
  66. data/lib/orb/models/subscription.rb +58 -78
  67. data/lib/orb/models/subscription_cancel_params.rb +2 -2
  68. data/lib/orb/models/subscription_cancel_response.rb +14 -36
  69. data/lib/orb/models/subscription_change_apply_response.rb +14 -36
  70. data/lib/orb/models/subscription_change_cancel_response.rb +14 -36
  71. data/lib/orb/models/subscription_change_retrieve_response.rb +14 -36
  72. data/lib/orb/models/subscription_create_params.rb +1002 -1075
  73. data/lib/orb/models/subscription_create_response.rb +14 -36
  74. data/lib/orb/models/subscription_fetch_costs_params.rb +2 -2
  75. data/lib/orb/models/subscription_fetch_costs_response.rb +2 -2
  76. data/lib/orb/models/subscription_fetch_usage_params.rb +4 -4
  77. data/lib/orb/models/subscription_list_params.rb +2 -2
  78. data/lib/orb/models/subscription_price_intervals_params.rb +596 -674
  79. data/lib/orb/models/subscription_price_intervals_response.rb +14 -36
  80. data/lib/orb/models/subscription_schedule_plan_change_params.rb +973 -1059
  81. data/lib/orb/models/subscription_schedule_plan_change_response.rb +14 -36
  82. data/lib/orb/models/subscription_trigger_phase_response.rb +14 -36
  83. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +14 -36
  84. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +14 -36
  85. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +14 -36
  86. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +2 -2
  87. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +14 -36
  88. data/lib/orb/models/subscription_update_trial_params.rb +3 -3
  89. data/lib/orb/models/subscription_update_trial_response.rb +14 -36
  90. data/lib/orb/models/subscription_usage.rb +26 -35
  91. data/lib/orb/models/subscriptions.rb +4 -4
  92. data/lib/orb/models/trial_discount.rb +5 -5
  93. data/lib/orb/models/usage_discount.rb +5 -5
  94. data/lib/orb/models.rb +30 -16
  95. data/lib/orb/resources/alerts.rb +15 -15
  96. data/lib/orb/resources/coupons/subscriptions.rb +1 -1
  97. data/lib/orb/resources/coupons.rb +5 -5
  98. data/lib/orb/resources/credit_notes.rb +5 -5
  99. data/lib/orb/resources/customers/balance_transactions.rb +1 -1
  100. data/lib/orb/resources/customers/costs.rb +2 -2
  101. data/lib/orb/resources/customers/credits/ledger.rb +10 -10
  102. data/lib/orb/resources/customers/credits/top_ups.rb +4 -4
  103. data/lib/orb/resources/customers.rb +30 -30
  104. data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +1 -1
  105. data/lib/orb/resources/dimensional_price_groups.rb +3 -3
  106. data/lib/orb/resources/events/volume.rb +1 -1
  107. data/lib/orb/resources/events.rb +1 -1
  108. data/lib/orb/resources/invoices.rb +12 -12
  109. data/lib/orb/resources/items.rb +5 -5
  110. data/lib/orb/resources/metrics.rb +4 -4
  111. data/lib/orb/resources/plans/external_plan_id.rb +2 -2
  112. data/lib/orb/resources/plans.rb +7 -7
  113. data/lib/orb/resources/prices/external_price_id.rb +2 -2
  114. data/lib/orb/resources/prices.rb +17 -17
  115. data/lib/orb/resources/subscriptions.rb +32 -32
  116. data/lib/orb/version.rb +1 -1
  117. data/rbi/orb/internal/type/array_of.rbi +6 -0
  118. data/rbi/orb/internal/type/base_model.rbi +5 -0
  119. data/rbi/orb/internal/type/boolean.rbi +6 -0
  120. data/rbi/orb/internal/type/enum.rbi +5 -0
  121. data/rbi/orb/internal/type/file_input.rbi +5 -0
  122. data/rbi/orb/internal/type/hash_of.rbi +6 -0
  123. data/rbi/orb/internal/type/union.rbi +5 -0
  124. data/rbi/orb/internal/type/unknown.rbi +6 -0
  125. data/rbi/orb/internal/util.rbi +30 -0
  126. data/rbi/orb/internal.rbi +3 -0
  127. data/rbi/orb/models/coupon.rbi +2 -2
  128. data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +2 -65
  129. data/rbi/orb/models/customers/cost_list_response.rbi +2 -65
  130. data/rbi/orb/models/evaluate_price_group.rbi +7 -3
  131. data/rbi/orb/models/invoice.rbi +10 -149
  132. data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +10 -133
  133. data/rbi/orb/models/invoice_line_item_create_response.rbi +8 -114
  134. data/rbi/orb/models/plan.rbi +8 -134
  135. data/rbi/orb/models/price.rbi +56 -588
  136. data/rbi/orb/models/subscription.rbi +6 -99
  137. data/rbi/orb/models/subscription_cancel_response.rbi +6 -89
  138. data/rbi/orb/models/subscription_change_apply_response.rbi +6 -89
  139. data/rbi/orb/models/subscription_change_cancel_response.rbi +6 -89
  140. data/rbi/orb/models/subscription_change_retrieve_response.rbi +6 -89
  141. data/rbi/orb/models/subscription_create_response.rbi +6 -89
  142. data/rbi/orb/models/subscription_fetch_costs_response.rbi +2 -65
  143. data/rbi/orb/models/subscription_price_intervals_response.rbi +6 -89
  144. data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +6 -89
  145. data/rbi/orb/models/subscription_trigger_phase_response.rbi +6 -89
  146. data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +6 -89
  147. data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +6 -89
  148. data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +6 -89
  149. data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +6 -89
  150. data/rbi/orb/models/subscription_update_trial_response.rbi +6 -89
  151. data/rbi/orb/resources/customers/credits/ledger.rbi +4 -36
  152. data/rbi/orb/resources/prices/external_price_id.rbi +2 -64
  153. data/rbi/orb/resources/prices.rbi +4 -130
  154. data/rbi/orb/resources/subscriptions.rbi +1 -6
  155. data/sig/orb/internal/page.rbs +2 -0
  156. data/sig/orb/internal/type/array_of.rbs +3 -0
  157. data/sig/orb/internal/type/base_model.rbs +2 -0
  158. data/sig/orb/internal/type/boolean.rbs +3 -0
  159. data/sig/orb/internal/type/enum.rbs +2 -0
  160. data/sig/orb/internal/type/file_input.rbs +2 -0
  161. data/sig/orb/internal/type/hash_of.rbs +3 -0
  162. data/sig/orb/internal/type/union.rbs +2 -0
  163. data/sig/orb/internal/type/unknown.rbs +3 -0
  164. data/sig/orb/internal/util.rbs +12 -0
  165. data/sig/orb/internal.rbs +2 -0
  166. data/sig/orb/models/alert.rbs +32 -4
  167. data/sig/orb/models/alert_create_for_customer_params.rbs +9 -0
  168. data/sig/orb/models/alert_create_for_external_customer_params.rbs +9 -0
  169. data/sig/orb/models/alert_create_for_subscription_params.rbs +9 -0
  170. data/sig/orb/models/alert_disable_params.rbs +5 -0
  171. data/sig/orb/models/alert_enable_params.rbs +5 -0
  172. data/sig/orb/models/alert_list_params.rbs +13 -0
  173. data/sig/orb/models/alert_retrieve_params.rbs +2 -0
  174. data/sig/orb/models/alert_update_params.rbs +7 -0
  175. data/sig/orb/models/amount_discount.rbs +11 -4
  176. data/sig/orb/models/billable_metric.rbs +13 -4
  177. data/sig/orb/models/coupon.rbs +14 -4
  178. data/sig/orb/models/coupon_archive_params.rbs +2 -0
  179. data/sig/orb/models/coupon_create_params.rbs +15 -0
  180. data/sig/orb/models/coupon_fetch_params.rbs +2 -0
  181. data/sig/orb/models/coupon_list_params.rbs +8 -0
  182. data/sig/orb/models/coupons/subscription_list_params.rbs +6 -0
  183. data/sig/orb/models/credit_note.rbs +88 -20
  184. data/sig/orb/models/credit_note_create_params.rbs +9 -0
  185. data/sig/orb/models/credit_note_fetch_params.rbs +2 -0
  186. data/sig/orb/models/credit_note_list_params.rbs +10 -0
  187. data/sig/orb/models/customer.rbs +86 -16
  188. data/sig/orb/models/customer_create_params.rbs +79 -8
  189. data/sig/orb/models/customer_delete_params.rbs +2 -0
  190. data/sig/orb/models/customer_fetch_by_external_id_params.rbs +2 -0
  191. data/sig/orb/models/customer_fetch_params.rbs +2 -0
  192. data/sig/orb/models/customer_list_params.rbs +10 -0
  193. data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +2 -0
  194. data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +2 -0
  195. data/sig/orb/models/customer_update_by_external_id_params.rbs +78 -8
  196. data/sig/orb/models/customer_update_params.rbs +78 -8
  197. data/sig/orb/models/customers/balance_transaction_create_params.rbs +7 -0
  198. data/sig/orb/models/customers/balance_transaction_create_response.rbs +17 -0
  199. data/sig/orb/models/customers/balance_transaction_list_params.rbs +10 -0
  200. data/sig/orb/models/customers/balance_transaction_list_response.rbs +17 -0
  201. data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +8 -0
  202. data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +20 -0
  203. data/sig/orb/models/customers/cost_list_params.rbs +8 -0
  204. data/sig/orb/models/customers/cost_list_response.rbs +20 -0
  205. data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +8 -0
  206. data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +10 -0
  207. data/sig/orb/models/customers/credit_list_params.rbs +8 -0
  208. data/sig/orb/models/customers/credit_list_response.rbs +10 -0
  209. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +23 -0
  210. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +177 -0
  211. data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +23 -0
  212. data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +177 -0
  213. data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +14 -0
  214. data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +177 -0
  215. data/sig/orb/models/customers/credits/ledger_list_params.rbs +14 -0
  216. data/sig/orb/models/customers/credits/ledger_list_response.rbs +177 -0
  217. data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +19 -0
  218. data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +18 -0
  219. data/sig/orb/models/customers/credits/top_up_create_params.rbs +19 -0
  220. data/sig/orb/models/customers/credits/top_up_create_response.rbs +18 -0
  221. data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +5 -0
  222. data/sig/orb/models/customers/credits/top_up_delete_params.rbs +5 -0
  223. data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +6 -0
  224. data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +18 -0
  225. data/sig/orb/models/customers/credits/top_up_list_params.rbs +6 -0
  226. data/sig/orb/models/customers/credits/top_up_list_response.rbs +18 -0
  227. data/sig/orb/models/dimensional_price_group.rbs +9 -0
  228. data/sig/orb/models/dimensional_price_group_create_params.rbs +9 -0
  229. data/sig/orb/models/dimensional_price_group_list_params.rbs +6 -0
  230. data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +2 -0
  231. data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +2 -0
  232. data/sig/orb/models/dimensional_price_groups.rbs +5 -0
  233. data/sig/orb/models/evaluate_price_group.rbs +10 -4
  234. data/sig/orb/models/event_deprecate_params.rbs +2 -0
  235. data/sig/orb/models/event_deprecate_response.rbs +2 -0
  236. data/sig/orb/models/event_ingest_params.rbs +16 -0
  237. data/sig/orb/models/event_ingest_response.rbs +15 -0
  238. data/sig/orb/models/event_search_params.rbs +7 -0
  239. data/sig/orb/models/event_search_response.rbs +12 -0
  240. data/sig/orb/models/event_update_params.rbs +9 -0
  241. data/sig/orb/models/event_update_response.rbs +2 -0
  242. data/sig/orb/models/events/backfill_close_params.rbs +2 -0
  243. data/sig/orb/models/events/backfill_close_response.rbs +14 -0
  244. data/sig/orb/models/events/backfill_create_params.rbs +11 -0
  245. data/sig/orb/models/events/backfill_create_response.rbs +14 -0
  246. data/sig/orb/models/events/backfill_fetch_params.rbs +2 -0
  247. data/sig/orb/models/events/backfill_fetch_response.rbs +14 -0
  248. data/sig/orb/models/events/backfill_list_params.rbs +6 -0
  249. data/sig/orb/models/events/backfill_list_response.rbs +14 -0
  250. data/sig/orb/models/events/backfill_revert_params.rbs +2 -0
  251. data/sig/orb/models/events/backfill_revert_response.rbs +14 -0
  252. data/sig/orb/models/events/event_volumes.rbs +8 -0
  253. data/sig/orb/models/events/volume_list_params.rbs +8 -0
  254. data/sig/orb/models/invoice.rbs +293 -36
  255. data/sig/orb/models/invoice_create_params.rbs +30 -4
  256. data/sig/orb/models/invoice_fetch_params.rbs +2 -0
  257. data/sig/orb/models/invoice_fetch_upcoming_params.rbs +5 -0
  258. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +257 -0
  259. data/sig/orb/models/invoice_issue_params.rbs +5 -0
  260. data/sig/orb/models/invoice_line_item_create_params.rbs +10 -0
  261. data/sig/orb/models/invoice_line_item_create_response.rbs +132 -0
  262. data/sig/orb/models/invoice_list_params.rbs +27 -4
  263. data/sig/orb/models/invoice_mark_paid_params.rbs +7 -0
  264. data/sig/orb/models/invoice_pay_params.rbs +2 -0
  265. data/sig/orb/models/invoice_update_params.rbs +5 -0
  266. data/sig/orb/models/invoice_void_params.rbs +2 -0
  267. data/sig/orb/models/item.rbs +16 -4
  268. data/sig/orb/models/item_create_params.rbs +2 -0
  269. data/sig/orb/models/item_fetch_params.rbs +2 -0
  270. data/sig/orb/models/item_list_params.rbs +6 -0
  271. data/sig/orb/models/item_update_params.rbs +15 -4
  272. data/sig/orb/models/metric_create_params.rbs +9 -0
  273. data/sig/orb/models/metric_fetch_params.rbs +2 -0
  274. data/sig/orb/models/metric_list_params.rbs +10 -0
  275. data/sig/orb/models/metric_update_params.rbs +5 -0
  276. data/sig/orb/models/pagination_metadata.rbs +2 -0
  277. data/sig/orb/models/percentage_discount.rbs +11 -4
  278. data/sig/orb/models/plan.rbs +141 -16
  279. data/sig/orb/models/plan_create_params.rbs +1070 -304
  280. data/sig/orb/models/plan_fetch_params.rbs +2 -0
  281. data/sig/orb/models/plan_list_params.rbs +11 -0
  282. data/sig/orb/models/plan_update_params.rbs +6 -0
  283. data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +2 -0
  284. data/sig/orb/models/plans/external_plan_id_update_params.rbs +6 -0
  285. data/sig/orb/models/price.rbs +2148 -460
  286. data/sig/orb/models/price_create_params.rbs +130 -8
  287. data/sig/orb/models/price_evaluate_params.rbs +10 -0
  288. data/sig/orb/models/price_evaluate_response.rbs +2 -0
  289. data/sig/orb/models/price_fetch_params.rbs +2 -0
  290. data/sig/orb/models/price_list_params.rbs +6 -0
  291. data/sig/orb/models/price_update_params.rbs +5 -0
  292. data/sig/orb/models/prices/external_price_id_fetch_params.rbs +2 -0
  293. data/sig/orb/models/prices/external_price_id_update_params.rbs +5 -0
  294. data/sig/orb/models/subscription.rbs +177 -12
  295. data/sig/orb/models/subscription_cancel_params.rbs +7 -0
  296. data/sig/orb/models/subscription_cancel_response.rbs +173 -0
  297. data/sig/orb/models/subscription_change_apply_params.rbs +6 -0
  298. data/sig/orb/models/subscription_change_apply_response.rbs +186 -0
  299. data/sig/orb/models/subscription_change_cancel_params.rbs +2 -0
  300. data/sig/orb/models/subscription_change_cancel_response.rbs +186 -0
  301. data/sig/orb/models/subscription_change_retrieve_params.rbs +2 -0
  302. data/sig/orb/models/subscription_change_retrieve_response.rbs +186 -0
  303. data/sig/orb/models/subscription_create_params.rbs +2368 -632
  304. data/sig/orb/models/subscription_create_response.rbs +173 -0
  305. data/sig/orb/models/subscription_fetch_costs_params.rbs +8 -0
  306. data/sig/orb/models/subscription_fetch_costs_response.rbs +20 -0
  307. data/sig/orb/models/subscription_fetch_params.rbs +2 -0
  308. data/sig/orb/models/subscription_fetch_schedule_params.rbs +10 -0
  309. data/sig/orb/models/subscription_fetch_schedule_response.rbs +13 -0
  310. data/sig/orb/models/subscription_fetch_usage_params.rbs +14 -0
  311. data/sig/orb/models/subscription_list_params.rbs +13 -0
  312. data/sig/orb/models/subscription_price_intervals_params.rbs +1348 -396
  313. data/sig/orb/models/subscription_price_intervals_response.rbs +173 -0
  314. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +2363 -632
  315. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +173 -0
  316. data/sig/orb/models/subscription_trigger_phase_params.rbs +6 -0
  317. data/sig/orb/models/subscription_trigger_phase_response.rbs +173 -0
  318. data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +2 -0
  319. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +173 -0
  320. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +2 -0
  321. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +173 -0
  322. data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +2 -0
  323. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +173 -0
  324. data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +9 -0
  325. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +173 -0
  326. data/sig/orb/models/subscription_update_params.rbs +9 -0
  327. data/sig/orb/models/subscription_update_trial_params.rbs +6 -0
  328. data/sig/orb/models/subscription_update_trial_response.rbs +173 -0
  329. data/sig/orb/models/subscription_usage.rbs +48 -8
  330. data/sig/orb/models/subscriptions.rbs +5 -0
  331. data/sig/orb/models/top_level_ping_params.rbs +2 -0
  332. data/sig/orb/models/top_level_ping_response.rbs +2 -0
  333. data/sig/orb/models/trial_discount.rbs +12 -4
  334. data/sig/orb/models/usage_discount.rbs +11 -4
  335. data/sig/orb/resources/invoices.rbs +1 -1
  336. data/sig/orb/resources/plans.rbs +1 -1
  337. metadata +2 -2
@@ -19,7 +19,7 @@ module Orb
19
19
  # with all line items, billable metrics, and prices and are used for defining
20
20
  # external sync behavior for invoices and tax calculation purposes.
21
21
  #
22
- # @return [Orb::Item]
22
+ # @return [Orb::Models::Item]
23
23
  required :item, -> { Orb::Item }
24
24
 
25
25
  # @!attribute metadata
@@ -38,12 +38,12 @@ module Orb
38
38
 
39
39
  # @!attribute status
40
40
  #
41
- # @return [Symbol, Orb::BillableMetric::Status]
41
+ # @return [Symbol, Orb::Models::BillableMetric::Status]
42
42
  required :status, enum: -> { Orb::BillableMetric::Status }
43
43
 
44
44
  # @!method initialize(id:, description:, item:, metadata:, name:, status:)
45
- # Some parameter documentations has been truncated, see {Orb::BillableMetric} for
46
- # more details.
45
+ # Some parameter documentations has been truncated, see
46
+ # {Orb::Models::BillableMetric} for more details.
47
47
  #
48
48
  # The Metric resource represents a calculation of a quantity based on events.
49
49
  # Metrics are defined by the query that transforms raw usage events into
@@ -53,15 +53,15 @@ module Orb
53
53
  #
54
54
  # @param description [String, nil]
55
55
  #
56
- # @param item [Orb::Item] The Item resource represents a sellable product or good. Items are associated wi
56
+ # @param item [Orb::Models::Item] The Item resource represents a sellable product or good. Items are associated wi
57
57
  #
58
58
  # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
59
59
  #
60
60
  # @param name [String]
61
61
  #
62
- # @param status [Symbol, Orb::BillableMetric::Status]
62
+ # @param status [Symbol, Orb::Models::BillableMetric::Status]
63
63
 
64
- # @see Orb::BillableMetric#status
64
+ # @see Orb::Models::BillableMetric#status
65
65
  module Status
66
66
  extend Orb::Internal::Type::Enum
67
67
 
@@ -19,7 +19,7 @@ module Orb
19
19
 
20
20
  # @!attribute discount
21
21
  #
22
- # @return [Orb::PercentageDiscount, Orb::AmountDiscount]
22
+ # @return [Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount]
23
23
  required :discount, union: -> { Orb::Coupon::Discount }
24
24
 
25
25
  # @!attribute duration_in_months
@@ -49,8 +49,8 @@ module Orb
49
49
  required :times_redeemed, Integer
50
50
 
51
51
  # @!method initialize(id:, archived_at:, discount:, duration_in_months:, max_redemptions:, redemption_code:, times_redeemed:)
52
- # Some parameter documentations has been truncated, see {Orb::Coupon} for more
53
- # details.
52
+ # Some parameter documentations has been truncated, see {Orb::Models::Coupon} for
53
+ # more details.
54
54
  #
55
55
  # A coupon represents a reusable discount configuration that can be applied either
56
56
  # as a fixed or percentage amount to an invoice or subscription. Coupons are
@@ -62,7 +62,7 @@ module Orb
62
62
  #
63
63
  # @param archived_at [Time, nil] An archived coupon can no longer be redeemed. Active coupons will have a value o
64
64
  #
65
- # @param discount [Orb::PercentageDiscount, Orb::AmountDiscount]
65
+ # @param discount [Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount]
66
66
  #
67
67
  # @param duration_in_months [Integer, nil] This allows for a coupon's discount to apply for a limited time (determined in m
68
68
  #
@@ -72,7 +72,7 @@ module Orb
72
72
  #
73
73
  # @param times_redeemed [Integer] The number of times this coupon has been redeemed.
74
74
 
75
- # @see Orb::Coupon#discount
75
+ # @see Orb::Models::Coupon#discount
76
76
  module Discount
77
77
  extend Orb::Internal::Type::Union
78
78
 
@@ -83,11 +83,7 @@ module Orb
83
83
  variant :amount, -> { Orb::AmountDiscount }
84
84
 
85
85
  # @!method self.variants
86
- # @return [Array(Orb::PercentageDiscount, Orb::AmountDiscount)]
87
-
88
- define_sorbet_constant!(:Variants) do
89
- T.type_alias { T.any(Orb::PercentageDiscount, Orb::AmountDiscount) }
90
- end
86
+ # @return [Array(Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount)]
91
87
  end
92
88
  end
93
89
  end
@@ -9,7 +9,7 @@ module Orb
9
9
 
10
10
  # @!attribute discount
11
11
  #
12
- # @return [Orb::CouponCreateParams::Discount::Percentage, Orb::CouponCreateParams::Discount::Amount]
12
+ # @return [Orb::Models::CouponCreateParams::Discount::Percentage, Orb::Models::CouponCreateParams::Discount::Amount]
13
13
  required :discount, union: -> { Orb::CouponCreateParams::Discount }
14
14
 
15
15
  # @!attribute redemption_code
@@ -36,7 +36,7 @@ module Orb
36
36
  # Some parameter documentations has been truncated, see
37
37
  # {Orb::Models::CouponCreateParams} for more details.
38
38
  #
39
- # @param discount [Orb::CouponCreateParams::Discount::Percentage, Orb::CouponCreateParams::Discount::Amount]
39
+ # @param discount [Orb::Models::CouponCreateParams::Discount::Percentage, Orb::Models::CouponCreateParams::Discount::Amount]
40
40
  #
41
41
  # @param redemption_code [String] This string can be used to redeem this coupon for a given subscription.
42
42
  #
@@ -88,13 +88,7 @@ module Orb
88
88
  end
89
89
 
90
90
  # @!method self.variants
91
- # @return [Array(Orb::CouponCreateParams::Discount::Percentage, Orb::CouponCreateParams::Discount::Amount)]
92
-
93
- define_sorbet_constant!(:Variants) do
94
- T.type_alias do
95
- T.any(Orb::CouponCreateParams::Discount::Percentage, Orb::CouponCreateParams::Discount::Amount)
96
- end
97
- end
91
+ # @return [Array(Orb::Models::CouponCreateParams::Discount::Percentage, Orb::Models::CouponCreateParams::Discount::Amount)]
98
92
  end
99
93
  end
100
94
  end
@@ -30,7 +30,7 @@ module Orb
30
30
 
31
31
  # @!attribute customer
32
32
  #
33
- # @return [Orb::CreditNote::Customer]
33
+ # @return [Orb::Models::CreditNote::Customer]
34
34
  required :customer, -> { Orb::CreditNote::Customer }
35
35
 
36
36
  # @!attribute invoice_id
@@ -42,13 +42,13 @@ module Orb
42
42
  # @!attribute line_items
43
43
  # All of the line items associated with this credit note.
44
44
  #
45
- # @return [Array<Orb::CreditNote::LineItem>]
45
+ # @return [Array<Orb::Models::CreditNote::LineItem>]
46
46
  required :line_items, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote::LineItem] }
47
47
 
48
48
  # @!attribute maximum_amount_adjustment
49
49
  # The maximum amount applied on the original invoice
50
50
  #
51
- # @return [Orb::CreditNote::MaximumAmountAdjustment, nil]
51
+ # @return [Orb::Models::CreditNote::MaximumAmountAdjustment, nil]
52
52
  required :maximum_amount_adjustment, -> { Orb::CreditNote::MaximumAmountAdjustment }, nil?: true
53
53
 
54
54
  # @!attribute memo
@@ -65,7 +65,7 @@ module Orb
65
65
 
66
66
  # @!attribute reason
67
67
  #
68
- # @return [Symbol, Orb::CreditNote::Reason, nil]
68
+ # @return [Symbol, Orb::Models::CreditNote::Reason, nil]
69
69
  required :reason, enum: -> { Orb::CreditNote::Reason }, nil?: true
70
70
 
71
71
  # @!attribute subtotal
@@ -82,7 +82,7 @@ module Orb
82
82
 
83
83
  # @!attribute type
84
84
  #
85
- # @return [Symbol, Orb::CreditNote::Type]
85
+ # @return [Symbol, Orb::Models::CreditNote::Type]
86
86
  required :type, enum: -> { Orb::CreditNote::Type }
87
87
 
88
88
  # @!attribute voided_at
@@ -94,7 +94,7 @@ module Orb
94
94
  # @!attribute discounts
95
95
  # Any discounts applied on the original invoice.
96
96
  #
97
- # @return [Array<Orb::CreditNote::Discount>, nil]
97
+ # @return [Array<Orb::Models::CreditNote::Discount>, nil]
98
98
  optional :discounts, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote::Discount] }
99
99
 
100
100
  # @!method initialize(id:, created_at:, credit_note_number:, credit_note_pdf:, customer:, invoice_id:, line_items:, maximum_amount_adjustment:, memo:, minimum_amount_refunded:, reason:, subtotal:, total:, type:, voided_at:, discounts: nil)
@@ -109,31 +109,31 @@ module Orb
109
109
  #
110
110
  # @param credit_note_pdf [String, nil] A URL to a PDF of the credit note.
111
111
  #
112
- # @param customer [Orb::CreditNote::Customer]
112
+ # @param customer [Orb::Models::CreditNote::Customer]
113
113
  #
114
114
  # @param invoice_id [String] The id of the invoice resource that this credit note is applied to.
115
115
  #
116
- # @param line_items [Array<Orb::CreditNote::LineItem>] All of the line items associated with this credit note.
116
+ # @param line_items [Array<Orb::Models::CreditNote::LineItem>] All of the line items associated with this credit note.
117
117
  #
118
- # @param maximum_amount_adjustment [Orb::CreditNote::MaximumAmountAdjustment, nil] The maximum amount applied on the original invoice
118
+ # @param maximum_amount_adjustment [Orb::Models::CreditNote::MaximumAmountAdjustment, nil] The maximum amount applied on the original invoice
119
119
  #
120
120
  # @param memo [String, nil] An optional memo supplied on the credit note.
121
121
  #
122
122
  # @param minimum_amount_refunded [String, nil] Any credited amount from the applied minimum on the invoice.
123
123
  #
124
- # @param reason [Symbol, Orb::CreditNote::Reason, nil]
124
+ # @param reason [Symbol, Orb::Models::CreditNote::Reason, nil]
125
125
  #
126
126
  # @param subtotal [String] The total prior to any creditable invoice-level discounts or minimums.
127
127
  #
128
128
  # @param total [String] The total including creditable invoice-level discounts or minimums, and tax.
129
129
  #
130
- # @param type [Symbol, Orb::CreditNote::Type]
130
+ # @param type [Symbol, Orb::Models::CreditNote::Type]
131
131
  #
132
132
  # @param voided_at [Time, nil] The time at which the credit note was voided in Orb, if applicable.
133
133
  #
134
- # @param discounts [Array<Orb::CreditNote::Discount>] Any discounts applied on the original invoice.
134
+ # @param discounts [Array<Orb::Models::CreditNote::Discount>] Any discounts applied on the original invoice.
135
135
 
136
- # @see Orb::CreditNote#customer
136
+ # @see Orb::Models::CreditNote#customer
137
137
  class Customer < Orb::Internal::Type::BaseModel
138
138
  # @!attribute id
139
139
  #
@@ -190,13 +190,13 @@ module Orb
190
190
  # @!attribute tax_amounts
191
191
  # Any tax amounts applied onto the line item.
192
192
  #
193
- # @return [Array<Orb::CreditNote::LineItem::TaxAmount>]
193
+ # @return [Array<Orb::Models::CreditNote::LineItem::TaxAmount>]
194
194
  required :tax_amounts, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote::LineItem::TaxAmount] }
195
195
 
196
196
  # @!attribute discounts
197
197
  # Any line item discounts from the invoice's line item.
198
198
  #
199
- # @return [Array<Orb::CreditNote::LineItem::Discount>, nil]
199
+ # @return [Array<Orb::Models::CreditNote::LineItem::Discount>, nil]
200
200
  optional :discounts, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote::LineItem::Discount] }
201
201
 
202
202
  # @!method initialize(id:, amount:, item_id:, name:, quantity:, subtotal:, tax_amounts:, discounts: nil)
@@ -212,9 +212,9 @@ module Orb
212
212
  #
213
213
  # @param subtotal [String] The amount of the line item, excluding any line item minimums and discounts.
214
214
  #
215
- # @param tax_amounts [Array<Orb::CreditNote::LineItem::TaxAmount>] Any tax amounts applied onto the line item.
215
+ # @param tax_amounts [Array<Orb::Models::CreditNote::LineItem::TaxAmount>] Any tax amounts applied onto the line item.
216
216
  #
217
- # @param discounts [Array<Orb::CreditNote::LineItem::Discount>] Any line item discounts from the invoice's line item.
217
+ # @param discounts [Array<Orb::Models::CreditNote::LineItem::Discount>] Any line item discounts from the invoice's line item.
218
218
 
219
219
  class TaxAmount < Orb::Internal::Type::BaseModel
220
220
  # @!attribute amount
@@ -261,7 +261,7 @@ module Orb
261
261
 
262
262
  # @!attribute discount_type
263
263
  #
264
- # @return [Symbol, Orb::CreditNote::LineItem::Discount::DiscountType]
264
+ # @return [Symbol, Orb::Models::CreditNote::LineItem::Discount::DiscountType]
265
265
  required :discount_type, enum: -> { Orb::CreditNote::LineItem::Discount::DiscountType }
266
266
 
267
267
  # @!attribute percentage_discount
@@ -283,12 +283,12 @@ module Orb
283
283
  # @param id [String]
284
284
  # @param amount_applied [String]
285
285
  # @param applies_to_price_ids [Array<String>]
286
- # @param discount_type [Symbol, Orb::CreditNote::LineItem::Discount::DiscountType]
286
+ # @param discount_type [Symbol, Orb::Models::CreditNote::LineItem::Discount::DiscountType]
287
287
  # @param percentage_discount [Float]
288
288
  # @param amount_discount [String, nil]
289
289
  # @param reason [String, nil]
290
290
 
291
- # @see Orb::CreditNote::LineItem::Discount#discount_type
291
+ # @see Orb::Models::CreditNote::LineItem::Discount#discount_type
292
292
  module DiscountType
293
293
  extend Orb::Internal::Type::Enum
294
294
 
@@ -301,7 +301,7 @@ module Orb
301
301
  end
302
302
  end
303
303
 
304
- # @see Orb::CreditNote#maximum_amount_adjustment
304
+ # @see Orb::Models::CreditNote#maximum_amount_adjustment
305
305
  class MaximumAmountAdjustment < Orb::Internal::Type::BaseModel
306
306
  # @!attribute amount_applied
307
307
  #
@@ -310,7 +310,7 @@ module Orb
310
310
 
311
311
  # @!attribute discount_type
312
312
  #
313
- # @return [Symbol, Orb::CreditNote::MaximumAmountAdjustment::DiscountType]
313
+ # @return [Symbol, Orb::Models::CreditNote::MaximumAmountAdjustment::DiscountType]
314
314
  required :discount_type, enum: -> { Orb::CreditNote::MaximumAmountAdjustment::DiscountType }
315
315
 
316
316
  # @!attribute percentage_discount
@@ -320,7 +320,7 @@ module Orb
320
320
 
321
321
  # @!attribute applies_to_prices
322
322
  #
323
- # @return [Array<Orb::CreditNote::MaximumAmountAdjustment::AppliesToPrice>, nil]
323
+ # @return [Array<Orb::Models::CreditNote::MaximumAmountAdjustment::AppliesToPrice>, nil]
324
324
  optional :applies_to_prices,
325
325
  -> {
326
326
  Orb::Internal::Type::ArrayOf[Orb::CreditNote::MaximumAmountAdjustment::AppliesToPrice]
@@ -336,12 +336,12 @@ module Orb
336
336
  # The maximum amount applied on the original invoice
337
337
  #
338
338
  # @param amount_applied [String]
339
- # @param discount_type [Symbol, Orb::CreditNote::MaximumAmountAdjustment::DiscountType]
339
+ # @param discount_type [Symbol, Orb::Models::CreditNote::MaximumAmountAdjustment::DiscountType]
340
340
  # @param percentage_discount [Float]
341
- # @param applies_to_prices [Array<Orb::CreditNote::MaximumAmountAdjustment::AppliesToPrice>, nil]
341
+ # @param applies_to_prices [Array<Orb::Models::CreditNote::MaximumAmountAdjustment::AppliesToPrice>, nil]
342
342
  # @param reason [String, nil]
343
343
 
344
- # @see Orb::CreditNote::MaximumAmountAdjustment#discount_type
344
+ # @see Orb::Models::CreditNote::MaximumAmountAdjustment#discount_type
345
345
  module DiscountType
346
346
  extend Orb::Internal::Type::Enum
347
347
 
@@ -368,7 +368,7 @@ module Orb
368
368
  end
369
369
  end
370
370
 
371
- # @see Orb::CreditNote#reason
371
+ # @see Orb::Models::CreditNote#reason
372
372
  module Reason
373
373
  extend Orb::Internal::Type::Enum
374
374
 
@@ -381,7 +381,7 @@ module Orb
381
381
  # @return [Array<Symbol>]
382
382
  end
383
383
 
384
- # @see Orb::CreditNote#type
384
+ # @see Orb::Models::CreditNote#type
385
385
  module Type
386
386
  extend Orb::Internal::Type::Enum
387
387
 
@@ -400,7 +400,7 @@ module Orb
400
400
 
401
401
  # @!attribute discount_type
402
402
  #
403
- # @return [Symbol, Orb::CreditNote::Discount::DiscountType]
403
+ # @return [Symbol, Orb::Models::CreditNote::Discount::DiscountType]
404
404
  required :discount_type, enum: -> { Orb::CreditNote::Discount::DiscountType }
405
405
 
406
406
  # @!attribute percentage_discount
@@ -410,7 +410,7 @@ module Orb
410
410
 
411
411
  # @!attribute applies_to_prices
412
412
  #
413
- # @return [Array<Orb::CreditNote::Discount::AppliesToPrice>, nil]
413
+ # @return [Array<Orb::Models::CreditNote::Discount::AppliesToPrice>, nil]
414
414
  optional :applies_to_prices,
415
415
  -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote::Discount::AppliesToPrice] },
416
416
  nil?: true
@@ -422,12 +422,12 @@ module Orb
422
422
 
423
423
  # @!method initialize(amount_applied:, discount_type:, percentage_discount:, applies_to_prices: nil, reason: nil)
424
424
  # @param amount_applied [String]
425
- # @param discount_type [Symbol, Orb::CreditNote::Discount::DiscountType]
425
+ # @param discount_type [Symbol, Orb::Models::CreditNote::Discount::DiscountType]
426
426
  # @param percentage_discount [Float]
427
- # @param applies_to_prices [Array<Orb::CreditNote::Discount::AppliesToPrice>, nil]
427
+ # @param applies_to_prices [Array<Orb::Models::CreditNote::Discount::AppliesToPrice>, nil]
428
428
  # @param reason [String, nil]
429
429
 
430
- # @see Orb::CreditNote::Discount#discount_type
430
+ # @see Orb::Models::CreditNote::Discount#discount_type
431
431
  module DiscountType
432
432
  extend Orb::Internal::Type::Enum
433
433
 
@@ -9,7 +9,7 @@ module Orb
9
9
 
10
10
  # @!attribute line_items
11
11
  #
12
- # @return [Array<Orb::CreditNoteCreateParams::LineItem>]
12
+ # @return [Array<Orb::Models::CreditNoteCreateParams::LineItem>]
13
13
  required :line_items, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNoteCreateParams::LineItem] }
14
14
 
15
15
  # @!attribute memo
@@ -21,15 +21,15 @@ module Orb
21
21
  # @!attribute reason
22
22
  # An optional reason for the credit note.
23
23
  #
24
- # @return [Symbol, Orb::CreditNoteCreateParams::Reason, nil]
24
+ # @return [Symbol, Orb::Models::CreditNoteCreateParams::Reason, nil]
25
25
  optional :reason, enum: -> { Orb::CreditNoteCreateParams::Reason }, nil?: true
26
26
 
27
27
  # @!method initialize(line_items:, memo: nil, reason: nil, request_options: {})
28
- # @param line_items [Array<Orb::CreditNoteCreateParams::LineItem>]
28
+ # @param line_items [Array<Orb::Models::CreditNoteCreateParams::LineItem>]
29
29
  #
30
30
  # @param memo [String, nil] An optional memo to attach to the credit note.
31
31
  #
32
- # @param reason [Symbol, Orb::CreditNoteCreateParams::Reason, nil] An optional reason for the credit note.
32
+ # @param reason [Symbol, Orb::Models::CreditNoteCreateParams::Reason, nil] An optional reason for the credit note.
33
33
  #
34
34
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
35
35
 
@@ -27,7 +27,7 @@ module Orb
27
27
 
28
28
  # @!attribute billing_address
29
29
  #
30
- # @return [Orb::Customer::BillingAddress, nil]
30
+ # @return [Orb::Models::Customer::BillingAddress, nil]
31
31
  required :billing_address, -> { Orb::Customer::BillingAddress }, nil?: true
32
32
 
33
33
  # @!attribute created_at
@@ -69,7 +69,7 @@ module Orb
69
69
  # @!attribute hierarchy
70
70
  # The hierarchical relationships for this customer.
71
71
  #
72
- # @return [Orb::Customer::Hierarchy]
72
+ # @return [Orb::Models::Customer::Hierarchy]
73
73
  required :hierarchy, -> { Orb::Customer::Hierarchy }
74
74
 
75
75
  # @!attribute metadata
@@ -92,7 +92,7 @@ module Orb
92
92
  # When not in test mode, the connection must first be configured in the Orb
93
93
  # webapp.
94
94
  #
95
- # @return [Symbol, Orb::Customer::PaymentProvider, nil]
95
+ # @return [Symbol, Orb::Models::Customer::PaymentProvider, nil]
96
96
  required :payment_provider, enum: -> { Orb::Customer::PaymentProvider }, nil?: true
97
97
 
98
98
  # @!attribute payment_provider_id
@@ -109,7 +109,7 @@ module Orb
109
109
 
110
110
  # @!attribute shipping_address
111
111
  #
112
- # @return [Orb::Customer::ShippingAddress, nil]
112
+ # @return [Orb::Models::Customer::ShippingAddress, nil]
113
113
  required :shipping_address, -> { Orb::Customer::ShippingAddress }, nil?: true
114
114
 
115
115
  # @!attribute tax_id
@@ -219,7 +219,7 @@ module Orb
219
219
  # | Venezuela | `ve_rif` | Venezuelan RIF Number |
220
220
  # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
221
221
  #
222
- # @return [Orb::Customer::TaxID, nil]
222
+ # @return [Orb::Models::Customer::TaxID, nil]
223
223
  required :tax_id, -> { Orb::Customer::TaxID }, nil?: true
224
224
 
225
225
  # @!attribute timezone
@@ -232,17 +232,17 @@ module Orb
232
232
 
233
233
  # @!attribute accounting_sync_configuration
234
234
  #
235
- # @return [Orb::Customer::AccountingSyncConfiguration, nil]
235
+ # @return [Orb::Models::Customer::AccountingSyncConfiguration, nil]
236
236
  optional :accounting_sync_configuration, -> { Orb::Customer::AccountingSyncConfiguration }, nil?: true
237
237
 
238
238
  # @!attribute reporting_configuration
239
239
  #
240
- # @return [Orb::Customer::ReportingConfiguration, nil]
240
+ # @return [Orb::Models::Customer::ReportingConfiguration, nil]
241
241
  optional :reporting_configuration, -> { Orb::Customer::ReportingConfiguration }, nil?: true
242
242
 
243
243
  # @!method initialize(id:, additional_emails:, auto_collection:, balance:, billing_address:, created_at:, currency:, email:, email_delivery:, exempt_from_automated_tax:, external_customer_id:, hierarchy:, metadata:, name:, payment_provider:, payment_provider_id:, portal_url:, shipping_address:, tax_id:, timezone:, accounting_sync_configuration: nil, reporting_configuration: nil)
244
- # Some parameter documentations has been truncated, see {Orb::Customer} for more
245
- # details.
244
+ # Some parameter documentations has been truncated, see {Orb::Models::Customer}
245
+ # for more details.
246
246
  #
247
247
  # A customer is a buyer of your products, and the other party to the billing
248
248
  # relationship.
@@ -271,7 +271,7 @@ module Orb
271
271
  #
272
272
  # @param balance [String] The customer's current balance in their currency.
273
273
  #
274
- # @param billing_address [Orb::Customer::BillingAddress, nil]
274
+ # @param billing_address [Orb::Models::Customer::BillingAddress, nil]
275
275
  #
276
276
  # @param created_at [Time]
277
277
  #
@@ -285,29 +285,29 @@ module Orb
285
285
  #
286
286
  # @param external_customer_id [String, nil] An optional user-defined ID for this customer resource, used throughout the syst
287
287
  #
288
- # @param hierarchy [Orb::Customer::Hierarchy] The hierarchical relationships for this customer.
288
+ # @param hierarchy [Orb::Models::Customer::Hierarchy] The hierarchical relationships for this customer.
289
289
  #
290
290
  # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
291
291
  #
292
292
  # @param name [String] The full name of the customer
293
293
  #
294
- # @param payment_provider [Symbol, Orb::Customer::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
294
+ # @param payment_provider [Symbol, Orb::Models::Customer::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
295
295
  #
296
296
  # @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
297
297
  #
298
298
  # @param portal_url [String, nil]
299
299
  #
300
- # @param shipping_address [Orb::Customer::ShippingAddress, nil]
300
+ # @param shipping_address [Orb::Models::Customer::ShippingAddress, nil]
301
301
  #
302
- # @param tax_id [Orb::Customer::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
302
+ # @param tax_id [Orb::Models::Customer::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
303
303
  #
304
304
  # @param timezone [String] A timezone identifier from the IANA timezone database, such as "America/Los_Ange
305
305
  #
306
- # @param accounting_sync_configuration [Orb::Customer::AccountingSyncConfiguration, nil]
306
+ # @param accounting_sync_configuration [Orb::Models::Customer::AccountingSyncConfiguration, nil]
307
307
  #
308
- # @param reporting_configuration [Orb::Customer::ReportingConfiguration, nil]
308
+ # @param reporting_configuration [Orb::Models::Customer::ReportingConfiguration, nil]
309
309
 
310
- # @see Orb::Customer#billing_address
310
+ # @see Orb::Models::Customer#billing_address
311
311
  class BillingAddress < Orb::Internal::Type::BaseModel
312
312
  # @!attribute city
313
313
  #
@@ -348,23 +348,23 @@ module Orb
348
348
  # @param state [String, nil]
349
349
  end
350
350
 
351
- # @see Orb::Customer#hierarchy
351
+ # @see Orb::Models::Customer#hierarchy
352
352
  class Hierarchy < Orb::Internal::Type::BaseModel
353
353
  # @!attribute children
354
354
  #
355
- # @return [Array<Orb::Customer::Hierarchy::Child>]
355
+ # @return [Array<Orb::Models::Customer::Hierarchy::Child>]
356
356
  required :children, -> { Orb::Internal::Type::ArrayOf[Orb::Customer::Hierarchy::Child] }
357
357
 
358
358
  # @!attribute parent
359
359
  #
360
- # @return [Orb::Customer::Hierarchy::Parent, nil]
360
+ # @return [Orb::Models::Customer::Hierarchy::Parent, nil]
361
361
  required :parent, -> { Orb::Customer::Hierarchy::Parent }, nil?: true
362
362
 
363
363
  # @!method initialize(children:, parent:)
364
364
  # The hierarchical relationships for this customer.
365
365
  #
366
- # @param children [Array<Orb::Customer::Hierarchy::Child>]
367
- # @param parent [Orb::Customer::Hierarchy::Parent, nil]
366
+ # @param children [Array<Orb::Models::Customer::Hierarchy::Child>]
367
+ # @param parent [Orb::Models::Customer::Hierarchy::Parent, nil]
368
368
 
369
369
  class Child < Orb::Internal::Type::BaseModel
370
370
  # @!attribute id
@@ -382,7 +382,7 @@ module Orb
382
382
  # @param external_customer_id [String, nil]
383
383
  end
384
384
 
385
- # @see Orb::Customer::Hierarchy#parent
385
+ # @see Orb::Models::Customer::Hierarchy#parent
386
386
  class Parent < Orb::Internal::Type::BaseModel
387
387
  # @!attribute id
388
388
  #
@@ -404,7 +404,7 @@ module Orb
404
404
  # When not in test mode, the connection must first be configured in the Orb
405
405
  # webapp.
406
406
  #
407
- # @see Orb::Customer#payment_provider
407
+ # @see Orb::Models::Customer#payment_provider
408
408
  module PaymentProvider
409
409
  extend Orb::Internal::Type::Enum
410
410
 
@@ -418,7 +418,7 @@ module Orb
418
418
  # @return [Array<Symbol>]
419
419
  end
420
420
 
421
- # @see Orb::Customer#shipping_address
421
+ # @see Orb::Models::Customer#shipping_address
422
422
  class ShippingAddress < Orb::Internal::Type::BaseModel
423
423
  # @!attribute city
424
424
  #
@@ -459,16 +459,16 @@ module Orb
459
459
  # @param state [String, nil]
460
460
  end
461
461
 
462
- # @see Orb::Customer#tax_id
462
+ # @see Orb::Models::Customer#tax_id
463
463
  class TaxID < Orb::Internal::Type::BaseModel
464
464
  # @!attribute country
465
465
  #
466
- # @return [Symbol, Orb::Customer::TaxID::Country]
466
+ # @return [Symbol, Orb::Models::Customer::TaxID::Country]
467
467
  required :country, enum: -> { Orb::Customer::TaxID::Country }
468
468
 
469
469
  # @!attribute type
470
470
  #
471
- # @return [Symbol, Orb::Customer::TaxID::Type]
471
+ # @return [Symbol, Orb::Models::Customer::TaxID::Type]
472
472
  required :type, enum: -> { Orb::Customer::TaxID::Type }
473
473
 
474
474
  # @!attribute value
@@ -583,11 +583,11 @@ module Orb
583
583
  # | Venezuela | `ve_rif` | Venezuelan RIF Number |
584
584
  # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
585
585
  #
586
- # @param country [Symbol, Orb::Customer::TaxID::Country]
587
- # @param type [Symbol, Orb::Customer::TaxID::Type]
586
+ # @param country [Symbol, Orb::Models::Customer::TaxID::Country]
587
+ # @param type [Symbol, Orb::Models::Customer::TaxID::Type]
588
588
  # @param value [String]
589
589
 
590
- # @see Orb::Customer::TaxID#country
590
+ # @see Orb::Models::Customer::TaxID#country
591
591
  module Country
592
592
  extend Orb::Internal::Type::Enum
593
593
 
@@ -674,7 +674,7 @@ module Orb
674
674
  # @return [Array<Symbol>]
675
675
  end
676
676
 
677
- # @see Orb::Customer::TaxID#type
677
+ # @see Orb::Models::Customer::TaxID#type
678
678
  module Type
679
679
  extend Orb::Internal::Type::Enum
680
680
 
@@ -755,11 +755,11 @@ module Orb
755
755
  end
756
756
  end
757
757
 
758
- # @see Orb::Customer#accounting_sync_configuration
758
+ # @see Orb::Models::Customer#accounting_sync_configuration
759
759
  class AccountingSyncConfiguration < Orb::Internal::Type::BaseModel
760
760
  # @!attribute accounting_providers
761
761
  #
762
- # @return [Array<Orb::Customer::AccountingSyncConfiguration::AccountingProvider>]
762
+ # @return [Array<Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider>]
763
763
  required :accounting_providers,
764
764
  -> {
765
765
  Orb::Internal::Type::ArrayOf[Orb::Customer::AccountingSyncConfiguration::AccountingProvider]
@@ -771,7 +771,7 @@ module Orb
771
771
  required :excluded, Orb::Internal::Type::Boolean
772
772
 
773
773
  # @!method initialize(accounting_providers:, excluded:)
774
- # @param accounting_providers [Array<Orb::Customer::AccountingSyncConfiguration::AccountingProvider>]
774
+ # @param accounting_providers [Array<Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider>]
775
775
  # @param excluded [Boolean]
776
776
 
777
777
  class AccountingProvider < Orb::Internal::Type::BaseModel
@@ -782,15 +782,15 @@ module Orb
782
782
 
783
783
  # @!attribute provider_type
784
784
  #
785
- # @return [Symbol, Orb::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType]
785
+ # @return [Symbol, Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType]
786
786
  required :provider_type,
787
787
  enum: -> { Orb::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType }
788
788
 
789
789
  # @!method initialize(external_provider_id:, provider_type:)
790
790
  # @param external_provider_id [String, nil]
791
- # @param provider_type [Symbol, Orb::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType]
791
+ # @param provider_type [Symbol, Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType]
792
792
 
793
- # @see Orb::Customer::AccountingSyncConfiguration::AccountingProvider#provider_type
793
+ # @see Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider#provider_type
794
794
  module ProviderType
795
795
  extend Orb::Internal::Type::Enum
796
796
 
@@ -803,7 +803,7 @@ module Orb
803
803
  end
804
804
  end
805
805
 
806
- # @see Orb::Customer#reporting_configuration
806
+ # @see Orb::Models::Customer#reporting_configuration
807
807
  class ReportingConfiguration < Orb::Internal::Type::BaseModel
808
808
  # @!attribute exempt
809
809
  #