orb-billing 0.2.0 → 0.3.1

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 (488) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +67 -0
  3. data/README.md +63 -53
  4. data/lib/orb/client.rb +4 -4
  5. data/lib/orb/errors.rb +9 -9
  6. data/lib/orb/file_part.rb +55 -0
  7. data/lib/orb/internal/page.rb +7 -11
  8. data/lib/orb/internal/transport/base_client.rb +10 -10
  9. data/lib/orb/internal/transport/pooled_net_requester.rb +2 -2
  10. data/lib/orb/internal/type/array_of.rb +11 -0
  11. data/lib/orb/internal/type/base_model.rb +33 -23
  12. data/lib/orb/internal/type/base_page.rb +9 -1
  13. data/lib/orb/internal/type/boolean.rb +14 -11
  14. data/lib/orb/internal/type/converter.rb +4 -1
  15. data/lib/orb/internal/type/enum.rb +19 -16
  16. data/lib/orb/internal/type/{io_like.rb → file_input.rb} +33 -15
  17. data/lib/orb/internal/type/hash_of.rb +11 -0
  18. data/lib/orb/internal/type/request_parameters.rb +3 -10
  19. data/lib/orb/internal/type/union.rb +10 -1
  20. data/lib/orb/internal/type/unknown.rb +14 -11
  21. data/lib/orb/internal/util.rb +88 -64
  22. data/lib/orb/internal.rb +0 -1
  23. data/lib/orb/models/alert.rb +68 -71
  24. data/lib/orb/models/alert_create_for_customer_params.rb +20 -25
  25. data/lib/orb/models/alert_create_for_external_customer_params.rb +20 -25
  26. data/lib/orb/models/alert_create_for_subscription_params.rb +20 -25
  27. data/lib/orb/models/alert_disable_params.rb +5 -9
  28. data/lib/orb/models/alert_enable_params.rb +5 -9
  29. data/lib/orb/models/alert_list_params.rb +26 -36
  30. data/lib/orb/models/alert_retrieve_params.rb +3 -8
  31. data/lib/orb/models/alert_update_params.rb +14 -18
  32. data/lib/orb/models/amount_discount.rb +14 -14
  33. data/lib/orb/models/billable_metric.rb +23 -20
  34. data/lib/orb/models/billing_cycle_relative_date.rb +2 -5
  35. data/lib/orb/models/coupon.rb +28 -21
  36. data/lib/orb/models/coupon_archive_params.rb +3 -8
  37. data/lib/orb/models/coupon_create_params.rb +29 -34
  38. data/lib/orb/models/coupon_fetch_params.rb +3 -8
  39. data/lib/orb/models/coupon_list_params.rb +17 -17
  40. data/lib/orb/models/coupons/subscription_list_params.rb +12 -15
  41. data/lib/orb/models/credit_note.rb +100 -166
  42. data/lib/orb/models/credit_note_create_params.rb +15 -23
  43. data/lib/orb/models/credit_note_fetch_params.rb +3 -8
  44. data/lib/orb/models/credit_note_list_params.rb +20 -30
  45. data/lib/orb/models/customer.rb +224 -271
  46. data/lib/orb/models/customer_create_params.rb +216 -257
  47. data/lib/orb/models/customer_delete_params.rb +3 -8
  48. data/lib/orb/models/customer_fetch_by_external_id_params.rb +3 -8
  49. data/lib/orb/models/customer_fetch_params.rb +3 -8
  50. data/lib/orb/models/customer_list_params.rb +20 -30
  51. data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +3 -8
  52. data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +3 -8
  53. data/lib/orb/models/customer_update_by_external_id_params.rb +212 -257
  54. data/lib/orb/models/customer_update_params.rb +212 -255
  55. data/lib/orb/models/customers/balance_transaction_create_params.rb +11 -16
  56. data/lib/orb/models/customers/balance_transaction_create_response.rb +33 -51
  57. data/lib/orb/models/customers/balance_transaction_list_params.rb +20 -30
  58. data/lib/orb/models/customers/balance_transaction_list_response.rb +33 -51
  59. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +17 -17
  60. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +23 -27
  61. data/lib/orb/models/customers/cost_list_params.rb +17 -17
  62. data/lib/orb/models/customers/cost_list_response.rb +23 -27
  63. data/lib/orb/models/customers/credit_list_by_external_id_params.rb +18 -22
  64. data/lib/orb/models/customers/credit_list_by_external_id_response.rb +10 -17
  65. data/lib/orb/models/customers/credit_list_params.rb +18 -22
  66. data/lib/orb/models/customers/credit_list_response.rb +10 -17
  67. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +64 -66
  68. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +384 -491
  69. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +63 -66
  70. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +384 -498
  71. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +33 -48
  72. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +384 -494
  73. data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
  74. data/lib/orb/models/customers/credits/ledger_list_response.rb +383 -501
  75. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +47 -50
  76. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +43 -46
  77. data/lib/orb/models/customers/credits/top_up_create_params.rb +46 -50
  78. data/lib/orb/models/customers/credits/top_up_create_response.rb +42 -46
  79. data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +4 -9
  80. data/lib/orb/models/customers/credits/top_up_delete_params.rb +4 -9
  81. data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +12 -15
  82. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +43 -46
  83. data/lib/orb/models/customers/credits/top_up_list_params.rb +12 -15
  84. data/lib/orb/models/customers/credits/top_up_list_response.rb +42 -46
  85. data/lib/orb/models/dimensional_price_group.rb +21 -15
  86. data/lib/orb/models/dimensional_price_group_create_params.rb +17 -23
  87. data/lib/orb/models/dimensional_price_group_list_params.rb +12 -15
  88. data/lib/orb/models/dimensional_price_group_retrieve_params.rb +3 -8
  89. data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +3 -8
  90. data/lib/orb/models/dimensional_price_groups.rb +3 -7
  91. data/lib/orb/models/discount.rb +2 -3
  92. data/lib/orb/models/evaluate_price_group.rb +8 -11
  93. data/lib/orb/models/event_deprecate_params.rb +3 -8
  94. data/lib/orb/models/event_deprecate_response.rb +2 -6
  95. data/lib/orb/models/event_ingest_params.rb +33 -27
  96. data/lib/orb/models/event_ingest_response.rb +23 -24
  97. data/lib/orb/models/event_search_params.rb +15 -11
  98. data/lib/orb/models/event_search_response.rb +27 -22
  99. data/lib/orb/models/event_update_params.rb +19 -13
  100. data/lib/orb/models/event_update_response.rb +2 -6
  101. data/lib/orb/models/events/backfill_close_params.rb +3 -8
  102. data/lib/orb/models/events/backfill_close_response.rb +34 -39
  103. data/lib/orb/models/events/backfill_create_params.rb +28 -32
  104. data/lib/orb/models/events/backfill_create_response.rb +34 -39
  105. data/lib/orb/models/events/backfill_fetch_params.rb +3 -8
  106. data/lib/orb/models/events/backfill_fetch_response.rb +34 -39
  107. data/lib/orb/models/events/backfill_list_params.rb +12 -15
  108. data/lib/orb/models/events/backfill_list_response.rb +34 -39
  109. data/lib/orb/models/events/backfill_revert_params.rb +3 -8
  110. data/lib/orb/models/events/backfill_revert_response.rb +34 -39
  111. data/lib/orb/models/events/event_volumes.rb +11 -17
  112. data/lib/orb/models/events/volume_list_params.rb +19 -22
  113. data/lib/orb/models/invoice.rb +619 -681
  114. data/lib/orb/models/invoice_create_params.rb +52 -61
  115. data/lib/orb/models/invoice_fetch_params.rb +3 -8
  116. data/lib/orb/models/invoice_fetch_upcoming_params.rb +4 -9
  117. data/lib/orb/models/invoice_fetch_upcoming_response.rb +618 -669
  118. data/lib/orb/models/invoice_issue_params.rb +10 -14
  119. data/lib/orb/models/invoice_level_discount.rb +2 -3
  120. data/lib/orb/models/invoice_line_item_create_params.rb +19 -14
  121. data/lib/orb/models/invoice_line_item_create_response.rb +281 -306
  122. data/lib/orb/models/invoice_list_params.rb +51 -66
  123. data/lib/orb/models/invoice_mark_paid_params.rb +9 -11
  124. data/lib/orb/models/invoice_pay_params.rb +3 -8
  125. data/lib/orb/models/invoice_update_params.rb +9 -9
  126. data/lib/orb/models/invoice_void_params.rb +3 -8
  127. data/lib/orb/models/item.rb +14 -25
  128. data/lib/orb/models/item_create_params.rb +5 -9
  129. data/lib/orb/models/item_fetch_params.rb +3 -8
  130. data/lib/orb/models/item_list_params.rb +12 -15
  131. data/lib/orb/models/item_update_params.rb +10 -22
  132. data/lib/orb/models/metric_create_params.rb +17 -13
  133. data/lib/orb/models/metric_fetch_params.rb +3 -8
  134. data/lib/orb/models/metric_list_params.rb +20 -30
  135. data/lib/orb/models/metric_update_params.rb +9 -9
  136. data/lib/orb/models/pagination_metadata.rb +3 -7
  137. data/lib/orb/models/percentage_discount.rb +15 -14
  138. data/lib/orb/models/plan.rb +259 -291
  139. data/lib/orb/models/plan_create_params.rb +2070 -2466
  140. data/lib/orb/models/plan_fetch_params.rb +3 -8
  141. data/lib/orb/models/plan_list_params.rb +25 -42
  142. data/lib/orb/models/plan_update_params.rb +12 -10
  143. data/lib/orb/models/plans/external_plan_id_fetch_params.rb +3 -8
  144. data/lib/orb/models/plans/external_plan_id_update_params.rb +12 -10
  145. data/lib/orb/models/price.rb +3842 -5005
  146. data/lib/orb/models/price_create_params.rb +203 -244
  147. data/lib/orb/models/price_evaluate_params.rb +21 -30
  148. data/lib/orb/models/price_evaluate_response.rb +2 -6
  149. data/lib/orb/models/price_fetch_params.rb +3 -8
  150. data/lib/orb/models/price_list_params.rb +12 -15
  151. data/lib/orb/models/price_update_params.rb +9 -9
  152. data/lib/orb/models/prices/external_price_id_fetch_params.rb +3 -8
  153. data/lib/orb/models/prices/external_price_id_update_params.rb +9 -9
  154. data/lib/orb/models/subscription.rb +360 -405
  155. data/lib/orb/models/subscription_cancel_params.rb +16 -16
  156. data/lib/orb/models/subscription_cancel_response.rb +358 -399
  157. data/lib/orb/models/subscription_change_apply_params.rb +7 -10
  158. data/lib/orb/models/subscription_change_apply_response.rb +384 -418
  159. data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
  160. data/lib/orb/models/subscription_change_cancel_response.rb +384 -417
  161. data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
  162. data/lib/orb/models/subscription_change_retrieve_response.rb +385 -417
  163. data/lib/orb/models/subscription_create_params.rb +4735 -5417
  164. data/lib/orb/models/subscription_create_response.rb +358 -399
  165. data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
  166. data/lib/orb/models/subscription_fetch_costs_response.rb +23 -27
  167. data/lib/orb/models/subscription_fetch_params.rb +3 -8
  168. data/lib/orb/models/subscription_fetch_schedule_params.rb +20 -30
  169. data/lib/orb/models/subscription_fetch_schedule_response.rb +15 -17
  170. data/lib/orb/models/subscription_fetch_usage_params.rb +32 -43
  171. data/lib/orb/models/subscription_list_params.rb +28 -41
  172. data/lib/orb/models/subscription_price_intervals_params.rb +2560 -3040
  173. data/lib/orb/models/subscription_price_intervals_response.rb +361 -399
  174. data/lib/orb/models/subscription_schedule_plan_change_params.rb +4728 -5411
  175. data/lib/orb/models/subscription_schedule_plan_change_response.rb +361 -398
  176. data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
  177. data/lib/orb/models/subscription_trigger_phase_response.rb +360 -399
  178. data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
  179. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +361 -398
  180. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +5 -9
  181. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +362 -396
  182. data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +3 -8
  183. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +362 -396
  184. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +22 -33
  185. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +361 -398
  186. data/lib/orb/models/subscription_update_params.rb +21 -23
  187. data/lib/orb/models/subscription_update_trial_params.rb +15 -18
  188. data/lib/orb/models/subscription_update_trial_response.rb +360 -399
  189. data/lib/orb/models/subscription_usage.rb +37 -80
  190. data/lib/orb/models/subscriptions.rb +3 -7
  191. data/lib/orb/models/top_level_ping_params.rb +3 -8
  192. data/lib/orb/models/top_level_ping_response.rb +2 -6
  193. data/lib/orb/models/trial_discount.rb +16 -24
  194. data/lib/orb/models/usage_discount.rb +15 -14
  195. data/lib/orb/models.rb +220 -0
  196. data/lib/orb/request_options.rb +4 -6
  197. data/lib/orb/resources/alerts.rb +48 -17
  198. data/lib/orb/resources/coupons/subscriptions.rb +9 -2
  199. data/lib/orb/resources/coupons.rb +26 -8
  200. data/lib/orb/resources/credit_notes.rb +17 -4
  201. data/lib/orb/resources/customers/balance_transactions.rb +18 -3
  202. data/lib/orb/resources/customers/costs.rb +26 -8
  203. data/lib/orb/resources/customers/credits/ledger.rb +112 -32
  204. data/lib/orb/resources/customers/credits/top_ups.rb +67 -20
  205. data/lib/orb/resources/customers/credits.rb +28 -8
  206. data/lib/orb/resources/customers.rb +138 -39
  207. data/lib/orb/resources/dimensional_price_groups.rb +19 -4
  208. data/lib/orb/resources/events/backfills.rb +32 -9
  209. data/lib/orb/resources/events/volume.rb +14 -4
  210. data/lib/orb/resources/events.rb +40 -11
  211. data/lib/orb/resources/invoice_line_items.rb +16 -6
  212. data/lib/orb/resources/invoices.rb +77 -17
  213. data/lib/orb/resources/items.rb +10 -3
  214. data/lib/orb/resources/metrics.rb +33 -8
  215. data/lib/orb/resources/plans/external_plan_id.rb +10 -2
  216. data/lib/orb/resources/plans.rb +47 -11
  217. data/lib/orb/resources/prices/external_price_id.rb +9 -3
  218. data/lib/orb/resources/prices.rb +101 -26
  219. data/lib/orb/resources/subscription_changes.rb +5 -2
  220. data/lib/orb/resources/subscriptions.rb +292 -78
  221. data/lib/orb/version.rb +1 -1
  222. data/lib/orb.rb +2 -10
  223. data/rbi/{lib/orb → orb}/client.rbi +4 -4
  224. data/rbi/{lib/orb → orb}/errors.rbi +1 -1
  225. data/rbi/orb/file_part.rbi +34 -0
  226. data/rbi/{lib/orb → orb}/internal/transport/base_client.rbi +19 -5
  227. data/rbi/{lib/orb → orb}/internal/type/array_of.rbi +3 -0
  228. data/rbi/{lib/orb → orb}/internal/type/base_model.rbi +7 -1
  229. data/rbi/{lib/orb → orb}/internal/type/base_page.rbi +2 -0
  230. data/rbi/{lib/orb → orb}/internal/type/enum.rbi +3 -6
  231. data/rbi/{lib/orb/internal/type/io_like.rbi → orb/internal/type/file_input.rbi} +5 -2
  232. data/rbi/{lib/orb → orb}/internal/type/hash_of.rbi +3 -0
  233. data/rbi/{lib/orb → orb}/internal/type/request_parameters.rbi +1 -1
  234. data/rbi/{lib/orb → orb}/internal/type/union.rbi +3 -0
  235. data/rbi/{lib/orb → orb}/internal/util.rbi +28 -19
  236. data/rbi/{lib/orb → orb}/internal.rbi +0 -1
  237. data/rbi/{lib/orb → orb}/models/alert.rbi +28 -8
  238. data/rbi/{lib/orb → orb}/models/alert_create_for_customer_params.rbi +16 -6
  239. data/rbi/{lib/orb → orb}/models/alert_create_for_external_customer_params.rbi +16 -6
  240. data/rbi/{lib/orb → orb}/models/alert_create_for_subscription_params.rbi +16 -6
  241. data/rbi/{lib/orb → orb}/models/alert_disable_params.rbi +5 -2
  242. data/rbi/{lib/orb → orb}/models/alert_enable_params.rbi +5 -2
  243. data/rbi/{lib/orb → orb}/models/alert_list_params.rbi +6 -0
  244. data/rbi/{lib/orb → orb}/models/alert_update_params.rbi +11 -4
  245. data/rbi/{lib/orb → orb}/models/amount_discount.rbi +10 -4
  246. data/rbi/{lib/orb → orb}/models/billable_metric.rbi +16 -3
  247. data/rbi/{lib/orb → orb}/models/billing_cycle_relative_date.rbi +1 -1
  248. data/rbi/{lib/orb → orb}/models/coupon.rbi +10 -3
  249. data/rbi/{lib/orb → orb}/models/coupon_create_params.rbi +15 -12
  250. data/rbi/{lib/orb → orb}/models/coupon_list_params.rbi +13 -3
  251. data/rbi/{lib/orb → orb}/models/coupons/subscription_list_params.rbi +8 -2
  252. data/rbi/{lib/orb → orb}/models/credit_note.rbi +44 -12
  253. data/rbi/{lib/orb → orb}/models/credit_note_create_params.rbi +15 -6
  254. data/rbi/{lib/orb → orb}/models/credit_note_list_params.rbi +3 -0
  255. data/rbi/{lib/orb → orb}/models/customer.rbi +130 -11
  256. data/rbi/{lib/orb → orb}/models/customer_create_params.rbi +151 -17
  257. data/rbi/{lib/orb → orb}/models/customer_list_params.rbi +3 -0
  258. data/rbi/{lib/orb → orb}/models/customer_update_by_external_id_params.rbi +149 -17
  259. data/rbi/{lib/orb → orb}/models/customer_update_params.rbi +149 -17
  260. data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_params.rbi +8 -4
  261. data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_response.rbi +18 -8
  262. data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_params.rbi +3 -0
  263. data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_response.rbi +18 -8
  264. data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_params.rbi +9 -5
  265. data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +225 -0
  266. data/rbi/{lib/orb → orb}/models/customers/cost_list_params.rbi +9 -5
  267. data/rbi/orb/models/customers/cost_list_response.rbi +223 -0
  268. data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_params.rbi +13 -3
  269. data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_response.rbi +1 -2
  270. data/rbi/{lib/orb → orb}/models/customers/credit_list_params.rbi +13 -3
  271. data/rbi/{lib/orb → orb}/models/customers/credit_list_response.rbi +1 -2
  272. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
  273. data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_response.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi} +157 -170
  274. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_params.rbi +40 -6
  275. data/rbi/{lib/orb/models/customers/credits/ledger_list_response.rbi → orb/models/customers/credits/ledger_create_entry_response.rbi} +149 -196
  276. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
  277. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_response.rbi +148 -229
  278. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_params.rbi +6 -4
  279. data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi → orb/models/customers/credits/ledger_list_response.rbi} +149 -343
  280. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
  281. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
  282. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_params.rbi +27 -4
  283. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_response.rbi +25 -10
  284. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
  285. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
  286. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_params.rbi +8 -2
  287. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_response.rbi +25 -4
  288. data/rbi/{lib/orb → orb}/models/dimensional_price_group.rbi +11 -3
  289. data/rbi/{lib/orb → orb}/models/dimensional_price_group_create_params.rbi +4 -0
  290. data/rbi/{lib/orb → orb}/models/dimensional_price_group_list_params.rbi +8 -2
  291. data/rbi/{lib/orb → orb}/models/evaluate_price_group.rbi +8 -2
  292. data/rbi/{lib/orb → orb}/models/event_deprecate_response.rbi +4 -2
  293. data/rbi/{lib/orb → orb}/models/event_ingest_params.rbi +22 -5
  294. data/rbi/{lib/orb → orb}/models/event_ingest_response.rbi +15 -4
  295. data/rbi/{lib/orb → orb}/models/event_search_params.rbi +14 -2
  296. data/rbi/{lib/orb → orb}/models/event_search_response.rbi +14 -3
  297. data/rbi/{lib/orb → orb}/models/event_update_params.rbi +10 -3
  298. data/rbi/{lib/orb → orb}/models/event_update_response.rbi +4 -2
  299. data/rbi/{lib/orb → orb}/models/events/backfill_close_response.rbi +14 -2
  300. data/rbi/{lib/orb → orb}/models/events/backfill_create_params.rbi +18 -0
  301. data/rbi/{lib/orb → orb}/models/events/backfill_create_response.rbi +14 -2
  302. data/rbi/{lib/orb → orb}/models/events/backfill_fetch_response.rbi +14 -2
  303. data/rbi/{lib/orb → orb}/models/events/backfill_list_params.rbi +8 -2
  304. data/rbi/{lib/orb → orb}/models/events/backfill_list_response.rbi +14 -2
  305. data/rbi/{lib/orb → orb}/models/events/backfill_revert_response.rbi +14 -2
  306. data/rbi/{lib/orb → orb}/models/events/event_volumes.rbi +8 -4
  307. data/rbi/{lib/orb → orb}/models/events/volume_list_params.rbi +18 -2
  308. data/rbi/{lib/orb → orb}/models/invoice.rbi +513 -202
  309. data/rbi/{lib/orb → orb}/models/invoice_create_params.rbi +38 -6
  310. data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_response.rbi +513 -216
  311. data/rbi/{lib/orb → orb}/models/invoice_issue_params.rbi +9 -2
  312. data/rbi/{lib/orb → orb}/models/invoice_line_item_create_params.rbi +16 -2
  313. data/rbi/{lib/orb → orb}/models/invoice_line_item_create_response.rbi +279 -182
  314. data/rbi/{lib/orb → orb}/models/invoice_list_params.rbi +9 -2
  315. data/rbi/{lib/orb → orb}/models/invoice_mark_paid_params.rbi +9 -2
  316. data/rbi/{lib/orb → orb}/models/invoice_update_params.rbi +7 -2
  317. data/rbi/{lib/orb → orb}/models/item.rbi +1 -2
  318. data/rbi/{lib/orb → orb}/models/item_create_params.rbi +5 -2
  319. data/rbi/{lib/orb → orb}/models/item_list_params.rbi +8 -2
  320. data/rbi/{lib/orb → orb}/models/item_update_params.rbi +1 -8
  321. data/rbi/{lib/orb → orb}/models/metric_create_params.rbi +15 -2
  322. data/rbi/{lib/orb → orb}/models/metric_list_params.rbi +3 -0
  323. data/rbi/{lib/orb → orb}/models/metric_update_params.rbi +7 -2
  324. data/rbi/{lib/orb → orb}/models/percentage_discount.rbi +11 -4
  325. data/rbi/{lib/orb → orb}/models/plan.rbi +207 -120
  326. data/rbi/{lib/orb → orb}/models/plan_create_params.rbi +1971 -2414
  327. data/rbi/{lib/orb → orb}/models/plan_list_params.rbi +5 -1
  328. data/rbi/{lib/orb → orb}/models/plan_update_params.rbi +11 -2
  329. data/rbi/{lib/orb → orb}/models/plans/external_plan_id_update_params.rbi +11 -2
  330. data/rbi/{lib/orb → orb}/models/price.rbi +2594 -2957
  331. data/rbi/{lib/orb → orb}/models/price_create_params.rbi +137 -53
  332. data/rbi/{lib/orb → orb}/models/price_evaluate_params.rbi +10 -0
  333. data/rbi/{lib/orb → orb}/models/price_list_params.rbi +8 -2
  334. data/rbi/{lib/orb → orb}/models/price_update_params.rbi +7 -2
  335. data/rbi/{lib/orb → orb}/models/prices/external_price_id_update_params.rbi +7 -2
  336. data/rbi/{lib/orb → orb}/models/subscription.rbi +292 -129
  337. data/rbi/{lib/orb → orb}/models/subscription_cancel_params.rbi +8 -5
  338. data/rbi/{lib/orb → orb}/models/subscription_cancel_response.rbi +305 -132
  339. data/rbi/{lib/orb → orb}/models/subscription_change_apply_params.rbi +7 -2
  340. data/rbi/{lib/orb → orb}/models/subscription_change_apply_response.rbi +317 -136
  341. data/rbi/{lib/orb → orb}/models/subscription_change_cancel_response.rbi +317 -136
  342. data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_response.rbi +317 -136
  343. data/rbi/{lib/orb → orb}/models/subscription_create_params.rbi +4271 -4270
  344. data/rbi/{lib/orb → orb}/models/subscription_create_response.rbi +305 -132
  345. data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_params.rbi +9 -5
  346. data/rbi/orb/models/subscription_fetch_costs_response.rbi +221 -0
  347. data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_params.rbi +3 -0
  348. data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_response.rbi +8 -2
  349. data/rbi/{lib/orb → orb}/models/subscription_fetch_usage_params.rbi +13 -4
  350. data/rbi/{lib/orb → orb}/models/subscription_list_params.rbi +4 -2
  351. data/rbi/{lib/orb → orb}/models/subscription_price_intervals_params.rbi +2354 -2317
  352. data/rbi/{lib/orb → orb}/models/subscription_price_intervals_response.rbi +305 -132
  353. data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_params.rbi +4280 -3758
  354. data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_response.rbi +305 -132
  355. data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_params.rbi +10 -2
  356. data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_response.rbi +305 -132
  357. data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_response.rbi +305 -132
  358. data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
  359. data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +305 -138
  360. data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_response.rbi +305 -132
  361. data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
  362. data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_response.rbi +305 -132
  363. data/rbi/{lib/orb → orb}/models/subscription_update_params.rbi +15 -0
  364. data/rbi/{lib/orb → orb}/models/subscription_update_trial_params.rbi +11 -5
  365. data/rbi/{lib/orb → orb}/models/subscription_update_trial_response.rbi +305 -132
  366. data/rbi/{lib/orb → orb}/models/subscription_usage.rbi +2 -16
  367. data/rbi/{lib/orb → orb}/models/trial_discount.rbi +5 -1
  368. data/rbi/{lib/orb → orb}/models/usage_discount.rbi +11 -3
  369. data/rbi/orb/models.rbi +220 -0
  370. data/rbi/{lib/orb → orb}/request_options.rbi +2 -0
  371. data/rbi/{lib/orb → orb}/resources/alerts.rbi +8 -14
  372. data/rbi/{lib/orb → orb}/resources/coupons/subscriptions.rbi +1 -1
  373. data/rbi/{lib/orb → orb}/resources/coupons.rbi +6 -18
  374. data/rbi/{lib/orb → orb}/resources/credit_notes.rbi +3 -9
  375. data/rbi/{lib/orb → orb}/resources/customers/balance_transactions.rbi +2 -2
  376. data/rbi/{lib/orb → orb}/resources/customers/costs.rbi +2 -2
  377. data/rbi/{lib/orb → orb}/resources/customers/credits/ledger.rbi +32 -32
  378. data/rbi/{lib/orb → orb}/resources/customers/credits/top_ups.rbi +6 -18
  379. data/rbi/{lib/orb → orb}/resources/customers/credits.rbi +2 -2
  380. data/rbi/{lib/orb → orb}/resources/customers.rbi +15 -45
  381. data/rbi/{lib/orb → orb}/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +1 -4
  382. data/rbi/{lib/orb → orb}/resources/dimensional_price_groups.rbi +3 -10
  383. data/rbi/{lib/orb → orb}/resources/events/backfills.rbi +5 -18
  384. data/rbi/{lib/orb → orb}/resources/events/volume.rbi +1 -1
  385. data/rbi/{lib/orb → orb}/resources/events.rbi +4 -10
  386. data/rbi/{lib/orb → orb}/resources/invoice_line_items.rbi +1 -1
  387. data/rbi/{lib/orb → orb}/resources/invoices.rbi +9 -34
  388. data/rbi/{lib/orb → orb}/resources/items.rbi +4 -17
  389. data/rbi/{lib/orb → orb}/resources/metrics.rbi +4 -10
  390. data/rbi/{lib/orb → orb}/resources/plans/external_plan_id.rbi +2 -8
  391. data/rbi/{lib/orb → orb}/resources/plans.rbi +29 -35
  392. data/rbi/orb/resources/prices/external_price_id.rbi +103 -0
  393. data/rbi/{lib/orb → orb}/resources/prices.rbi +117 -124
  394. data/rbi/{lib/orb → orb}/resources/subscription_changes.rbi +3 -9
  395. data/rbi/{lib/orb → orb}/resources/subscriptions.rbi +16 -32
  396. data/rbi/{lib/orb → orb}/resources/top_level.rbi +1 -4
  397. data/sig/orb/file_part.rbs +21 -0
  398. data/sig/orb/internal/transport/base_client.rbs +9 -3
  399. data/sig/orb/internal/type/array_of.rbs +2 -0
  400. data/sig/orb/internal/type/base_model.rbs +4 -0
  401. data/sig/orb/internal/type/enum.rbs +2 -2
  402. data/sig/orb/internal/type/{io_like.rbs → file_input.rbs} +1 -1
  403. data/sig/orb/internal/type/hash_of.rbs +2 -0
  404. data/sig/orb/internal/type/union.rbs +2 -0
  405. data/sig/orb/internal/util.rbs +16 -12
  406. data/sig/orb/models/coupon_create_params.rbs +9 -10
  407. data/sig/orb/models/customer_create_params.rbs +9 -10
  408. data/sig/orb/models/customer_update_by_external_id_params.rbs +9 -10
  409. data/sig/orb/models/customer_update_params.rbs +9 -10
  410. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +113 -113
  411. data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +113 -113
  412. data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +113 -113
  413. data/sig/orb/models/customers/credits/ledger_list_response.rbs +113 -113
  414. data/sig/orb/models/invoice.rbs +54 -54
  415. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +54 -54
  416. data/sig/orb/models/invoice_line_item_create_response.rbs +54 -54
  417. data/sig/orb/models/plan.rbs +21 -21
  418. data/sig/orb/models/plan_create_params.rbs +653 -653
  419. data/sig/orb/models/price.rbs +1517 -1521
  420. data/sig/orb/models/subscription.rbs +34 -34
  421. data/sig/orb/models/subscription_cancel_response.rbs +34 -34
  422. data/sig/orb/models/subscription_change_apply_response.rbs +34 -34
  423. data/sig/orb/models/subscription_change_cancel_response.rbs +34 -34
  424. data/sig/orb/models/subscription_change_retrieve_response.rbs +34 -34
  425. data/sig/orb/models/subscription_create_params.rbs +1348 -1348
  426. data/sig/orb/models/subscription_create_response.rbs +34 -34
  427. data/sig/orb/models/subscription_price_intervals_params.rbs +767 -769
  428. data/sig/orb/models/subscription_price_intervals_response.rbs +34 -34
  429. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1348 -1348
  430. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +34 -34
  431. data/sig/orb/models/subscription_trigger_phase_response.rbs +34 -34
  432. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +34 -34
  433. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +34 -34
  434. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +34 -34
  435. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +34 -34
  436. data/sig/orb/models/subscription_update_trial_response.rbs +34 -34
  437. data/sig/orb/models.rbs +215 -0
  438. metadata +230 -224
  439. data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +0 -208
  440. data/rbi/lib/orb/models/customers/cost_list_response.rbi +0 -206
  441. data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +0 -204
  442. data/rbi/lib/orb/resources/prices/external_price_id.rbi +0 -106
  443. /data/rbi/{lib/orb → orb}/internal/page.rbi +0 -0
  444. /data/rbi/{lib/orb → orb}/internal/transport/pooled_net_requester.rbi +0 -0
  445. /data/rbi/{lib/orb → orb}/internal/type/boolean.rbi +0 -0
  446. /data/rbi/{lib/orb → orb}/internal/type/converter.rbi +0 -0
  447. /data/rbi/{lib/orb → orb}/internal/type/unknown.rbi +0 -0
  448. /data/rbi/{lib/orb → orb}/models/alert_retrieve_params.rbi +0 -0
  449. /data/rbi/{lib/orb → orb}/models/coupon_archive_params.rbi +0 -0
  450. /data/rbi/{lib/orb → orb}/models/coupon_fetch_params.rbi +0 -0
  451. /data/rbi/{lib/orb → orb}/models/credit_note_fetch_params.rbi +0 -0
  452. /data/rbi/{lib/orb → orb}/models/customer_delete_params.rbi +0 -0
  453. /data/rbi/{lib/orb → orb}/models/customer_fetch_by_external_id_params.rbi +0 -0
  454. /data/rbi/{lib/orb → orb}/models/customer_fetch_params.rbi +0 -0
  455. /data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +0 -0
  456. /data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_params.rbi +0 -0
  457. /data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_by_external_id_params.rbi +0 -0
  458. /data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_params.rbi +0 -0
  459. /data/rbi/{lib/orb → orb}/models/dimensional_price_group_retrieve_params.rbi +0 -0
  460. /data/rbi/{lib/orb → orb}/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +0 -0
  461. /data/rbi/{lib/orb → orb}/models/dimensional_price_groups.rbi +0 -0
  462. /data/rbi/{lib/orb → orb}/models/discount.rbi +0 -0
  463. /data/rbi/{lib/orb → orb}/models/event_deprecate_params.rbi +0 -0
  464. /data/rbi/{lib/orb → orb}/models/events/backfill_close_params.rbi +0 -0
  465. /data/rbi/{lib/orb → orb}/models/events/backfill_fetch_params.rbi +0 -0
  466. /data/rbi/{lib/orb → orb}/models/events/backfill_revert_params.rbi +0 -0
  467. /data/rbi/{lib/orb → orb}/models/invoice_fetch_params.rbi +0 -0
  468. /data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_params.rbi +0 -0
  469. /data/rbi/{lib/orb → orb}/models/invoice_level_discount.rbi +0 -0
  470. /data/rbi/{lib/orb → orb}/models/invoice_pay_params.rbi +0 -0
  471. /data/rbi/{lib/orb → orb}/models/invoice_void_params.rbi +0 -0
  472. /data/rbi/{lib/orb → orb}/models/item_fetch_params.rbi +0 -0
  473. /data/rbi/{lib/orb → orb}/models/metric_fetch_params.rbi +0 -0
  474. /data/rbi/{lib/orb → orb}/models/pagination_metadata.rbi +0 -0
  475. /data/rbi/{lib/orb → orb}/models/plan_fetch_params.rbi +0 -0
  476. /data/rbi/{lib/orb → orb}/models/plans/external_plan_id_fetch_params.rbi +0 -0
  477. /data/rbi/{lib/orb → orb}/models/price_evaluate_response.rbi +0 -0
  478. /data/rbi/{lib/orb → orb}/models/price_fetch_params.rbi +0 -0
  479. /data/rbi/{lib/orb → orb}/models/prices/external_price_id_fetch_params.rbi +0 -0
  480. /data/rbi/{lib/orb → orb}/models/subscription_change_cancel_params.rbi +0 -0
  481. /data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_params.rbi +0 -0
  482. /data/rbi/{lib/orb → orb}/models/subscription_fetch_params.rbi +0 -0
  483. /data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_params.rbi +0 -0
  484. /data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_params.rbi +0 -0
  485. /data/rbi/{lib/orb → orb}/models/subscriptions.rbi +0 -0
  486. /data/rbi/{lib/orb → orb}/models/top_level_ping_params.rbi +0 -0
  487. /data/rbi/{lib/orb → orb}/models/top_level_ping_response.rbi +0 -0
  488. /data/rbi/{lib/orb → orb}/version.rbi +0 -0
@@ -117,8 +117,8 @@ module Orb
117
117
  returns(
118
118
  T.nilable(
119
119
  T.any(
120
- Orb::Models::CustomerUpdateParams::TaxConfiguration::NewAvalaraTaxConfiguration,
121
- Orb::Models::CustomerUpdateParams::TaxConfiguration::NewTaxJarConfiguration
120
+ Orb::Models::CustomerUpdateParams::TaxConfiguration::Avalara,
121
+ Orb::Models::CustomerUpdateParams::TaxConfiguration::Taxjar
122
122
  )
123
123
  )
124
124
  )
@@ -255,9 +255,9 @@ module Orb
255
255
  shipping_address: T.nilable(T.any(Orb::Models::CustomerUpdateParams::ShippingAddress, Orb::Internal::AnyHash)),
256
256
  tax_configuration: T.nilable(
257
257
  T.any(
258
- Orb::Models::CustomerUpdateParams::TaxConfiguration::NewAvalaraTaxConfiguration,
258
+ Orb::Models::CustomerUpdateParams::TaxConfiguration::Avalara,
259
259
  Orb::Internal::AnyHash,
260
- Orb::Models::CustomerUpdateParams::TaxConfiguration::NewTaxJarConfiguration
260
+ Orb::Models::CustomerUpdateParams::TaxConfiguration::Taxjar
261
261
  )
262
262
  ),
263
263
  tax_id: T.nilable(T.any(Orb::Models::CustomerUpdateParams::TaxID, Orb::Internal::AnyHash)),
@@ -267,21 +267,150 @@ module Orb
267
267
  end
268
268
  def self.new(
269
269
  accounting_sync_configuration: nil,
270
+ # Additional email addresses for this customer. If populated, these email
271
+ # addresses will be CC'd for customer communications.
270
272
  additional_emails: nil,
273
+ # Used to determine if invoices for this customer will automatically attempt to
274
+ # charge a saved payment method, if available. This parameter defaults to `True`
275
+ # when a payment provider is provided on customer creation.
271
276
  auto_collection: nil,
272
277
  billing_address: nil,
278
+ # An ISO 4217 currency string used for the customer's invoices and balance. If not
279
+ # set at creation time, will be set at subscription creation time.
273
280
  currency: nil,
281
+ # A valid customer email, to be used for invoicing and notifications.
274
282
  email: nil,
275
283
  email_delivery: nil,
284
+ # The external customer ID. This can only be set if empty and the customer has no
285
+ # past or current subscriptions.
276
286
  external_customer_id: nil,
287
+ # The hierarchical relationships for this customer.
277
288
  hierarchy: nil,
289
+ # User-specified key/value pairs for the resource. Individual keys can be removed
290
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
291
+ # by setting `metadata` to `null`.
278
292
  metadata: nil,
293
+ # The full name of the customer
279
294
  name: nil,
295
+ # This is used for creating charges or invoices in an external system via Orb.
296
+ # When not in test mode:
297
+ #
298
+ # - the connection must first be configured in the Orb webapp.
299
+ # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`,
300
+ # `bill.com`, `netsuite`), any product mappings must first be configured with
301
+ # the Orb team.
280
302
  payment_provider: nil,
303
+ # The ID of this customer in an external payments solution, such as Stripe. This
304
+ # is used for creating charges or invoices in the external system via Orb.
281
305
  payment_provider_id: nil,
282
306
  reporting_configuration: nil,
283
307
  shipping_address: nil,
284
308
  tax_configuration: nil,
309
+ # Tax IDs are commonly required to be displayed on customer invoices, which are
310
+ # added to the headers of invoices.
311
+ #
312
+ # ### Supported Tax ID Countries and Types
313
+ #
314
+ # | Country | Type | Description |
315
+ # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
316
+ # | Andorra | `ad_nrt` | Andorran NRT Number |
317
+ # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
318
+ # | Australia | `au_abn` | Australian Business Number (AU ABN) |
319
+ # | Australia | `au_arn` | Australian Taxation Office Reference Number |
320
+ # | Austria | `eu_vat` | European VAT Number |
321
+ # | Bahrain | `bh_vat` | Bahraini VAT Number |
322
+ # | Belgium | `eu_vat` | European VAT Number |
323
+ # | Bolivia | `bo_tin` | Bolivian Tax ID |
324
+ # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
325
+ # | Brazil | `br_cpf` | Brazilian CPF Number |
326
+ # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
327
+ # | Bulgaria | `eu_vat` | European VAT Number |
328
+ # | Canada | `ca_bn` | Canadian BN |
329
+ # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
330
+ # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
331
+ # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
332
+ # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
333
+ # | Canada | `ca_qst` | Canadian QST Number (Québec) |
334
+ # | Chile | `cl_tin` | Chilean TIN |
335
+ # | China | `cn_tin` | Chinese Tax ID |
336
+ # | Colombia | `co_nit` | Colombian NIT Number |
337
+ # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
338
+ # | Croatia | `eu_vat` | European VAT Number |
339
+ # | Cyprus | `eu_vat` | European VAT Number |
340
+ # | Czech Republic | `eu_vat` | European VAT Number |
341
+ # | Denmark | `eu_vat` | European VAT Number |
342
+ # | Dominican Republic | `do_rcn` | Dominican RCN Number |
343
+ # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
344
+ # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
345
+ # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
346
+ # | Estonia | `eu_vat` | European VAT Number |
347
+ # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
348
+ # | Finland | `eu_vat` | European VAT Number |
349
+ # | France | `eu_vat` | European VAT Number |
350
+ # | Georgia | `ge_vat` | Georgian VAT |
351
+ # | Germany | `eu_vat` | European VAT Number |
352
+ # | Greece | `eu_vat` | European VAT Number |
353
+ # | Hong Kong | `hk_br` | Hong Kong BR Number |
354
+ # | Hungary | `eu_vat` | European VAT Number |
355
+ # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
356
+ # | Iceland | `is_vat` | Icelandic VAT |
357
+ # | India | `in_gst` | Indian GST Number |
358
+ # | Indonesia | `id_npwp` | Indonesian NPWP Number |
359
+ # | Ireland | `eu_vat` | European VAT Number |
360
+ # | Israel | `il_vat` | Israel VAT |
361
+ # | Italy | `eu_vat` | European VAT Number |
362
+ # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
363
+ # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
364
+ # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
365
+ # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
366
+ # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
367
+ # | Latvia | `eu_vat` | European VAT Number |
368
+ # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
369
+ # | Lithuania | `eu_vat` | European VAT Number |
370
+ # | Luxembourg | `eu_vat` | European VAT Number |
371
+ # | Malaysia | `my_frp` | Malaysian FRP Number |
372
+ # | Malaysia | `my_itn` | Malaysian ITN |
373
+ # | Malaysia | `my_sst` | Malaysian SST Number |
374
+ # | Malta | `eu_vat ` | European VAT Number |
375
+ # | Mexico | `mx_rfc` | Mexican RFC Number |
376
+ # | Netherlands | `eu_vat` | European VAT Number |
377
+ # | New Zealand | `nz_gst` | New Zealand GST Number |
378
+ # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
379
+ # | Norway | `no_vat` | Norwegian VAT Number |
380
+ # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
381
+ # | Oman | `om_vat` | Omani VAT Number |
382
+ # | Peru | `pe_ruc` | Peruvian RUC Number |
383
+ # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
384
+ # | Poland | `eu_vat` | European VAT Number |
385
+ # | Portugal | `eu_vat` | European VAT Number |
386
+ # | Romania | `eu_vat` | European VAT Number |
387
+ # | Romania | `ro_tin` | Romanian Tax ID Number |
388
+ # | Russia | `ru_inn` | Russian INN |
389
+ # | Russia | `ru_kpp` | Russian KPP |
390
+ # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
391
+ # | Serbia | `rs_pib` | Serbian PIB Number |
392
+ # | Singapore | `sg_gst` | Singaporean GST |
393
+ # | Singapore | `sg_uen` | Singaporean UEN |
394
+ # | Slovakia | `eu_vat` | European VAT Number |
395
+ # | Slovenia | `eu_vat` | European VAT Number |
396
+ # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
397
+ # | South Africa | `za_vat` | South African VAT Number |
398
+ # | South Korea | `kr_brn` | Korean BRN |
399
+ # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
400
+ # | Spain | `eu_vat` | European VAT Number |
401
+ # | Sweden | `eu_vat` | European VAT Number |
402
+ # | Switzerland | `ch_vat` | Switzerland VAT Number |
403
+ # | Taiwan | `tw_vat` | Taiwanese VAT |
404
+ # | Thailand | `th_vat` | Thai VAT |
405
+ # | Turkey | `tr_tin` | Turkish Tax Identification Number |
406
+ # | Ukraine | `ua_vat` | Ukrainian VAT |
407
+ # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
408
+ # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
409
+ # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
410
+ # | United States | `us_ein` | United States EIN |
411
+ # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
412
+ # | Venezuela | `ve_rif` | Venezuelan RIF Number |
413
+ # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
285
414
  tax_id: nil,
286
415
  request_options: {}
287
416
  ); end
@@ -306,8 +435,8 @@ module Orb
306
435
  shipping_address: T.nilable(Orb::Models::CustomerUpdateParams::ShippingAddress),
307
436
  tax_configuration: T.nilable(
308
437
  T.any(
309
- Orb::Models::CustomerUpdateParams::TaxConfiguration::NewAvalaraTaxConfiguration,
310
- Orb::Models::CustomerUpdateParams::TaxConfiguration::NewTaxJarConfiguration
438
+ Orb::Models::CustomerUpdateParams::TaxConfiguration::Avalara,
439
+ Orb::Models::CustomerUpdateParams::TaxConfiguration::Taxjar
311
440
  )
312
441
  ),
313
442
  tax_id: T.nilable(Orb::Models::CustomerUpdateParams::TaxID),
@@ -437,8 +566,14 @@ module Orb
437
566
  params(child_customer_ids: T::Array[String], parent_customer_id: T.nilable(String))
438
567
  .returns(T.attached_class)
439
568
  end
440
- def self.new(child_customer_ids: nil, parent_customer_id: nil); end
441
-
569
+ def self.new(
570
+ # A list of child customer IDs to add to the hierarchy. The desired child
571
+ # customers must not already be part of another hierarchy.
572
+ child_customer_ids: nil,
573
+ # The ID of the parent customer in the hierarchy. The desired parent customer must
574
+ # not be a child of another customer.
575
+ parent_customer_id: nil
576
+ ); end
442
577
  sig do
443
578
  override.returns({child_customer_ids: T::Array[String], parent_customer_id: T.nilable(String)})
444
579
  end
@@ -456,8 +591,7 @@ module Orb
456
591
  extend Orb::Internal::Type::Enum
457
592
 
458
593
  TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CustomerUpdateParams::PaymentProvider) }
459
- OrSymbol =
460
- T.type_alias { T.any(Symbol, String, Orb::Models::CustomerUpdateParams::PaymentProvider::TaggedSymbol) }
594
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
461
595
 
462
596
  QUICKBOOKS = T.let(:quickbooks, Orb::Models::CustomerUpdateParams::PaymentProvider::TaggedSymbol)
463
597
  BILL_COM = T.let(:"bill.com", Orb::Models::CustomerUpdateParams::PaymentProvider::TaggedSymbol)
@@ -531,7 +665,7 @@ module Orb
531
665
  module TaxConfiguration
532
666
  extend Orb::Internal::Type::Union
533
667
 
534
- class NewAvalaraTaxConfiguration < Orb::Internal::Type::BaseModel
668
+ class Avalara < Orb::Internal::Type::BaseModel
535
669
  sig { returns(T::Boolean) }
536
670
  attr_accessor :tax_exempt
537
671
 
@@ -559,7 +693,7 @@ module Orb
559
693
  def to_hash; end
560
694
  end
561
695
 
562
- class NewTaxJarConfiguration < Orb::Internal::Type::BaseModel
696
+ class Taxjar < Orb::Internal::Type::BaseModel
563
697
  sig { returns(T::Boolean) }
564
698
  attr_accessor :tax_exempt
565
699
 
@@ -576,7 +710,7 @@ module Orb
576
710
  sig do
577
711
  override
578
712
  .returns(
579
- [Orb::Models::CustomerUpdateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateParams::TaxConfiguration::NewTaxJarConfiguration]
713
+ [Orb::Models::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateParams::TaxConfiguration::Taxjar]
580
714
  )
581
715
  end
582
716
  def self.variants; end
@@ -723,8 +857,7 @@ module Orb
723
857
  extend Orb::Internal::Type::Enum
724
858
 
725
859
  TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CustomerUpdateParams::TaxID::Country) }
726
- OrSymbol =
727
- T.type_alias { T.any(Symbol, String, Orb::Models::CustomerUpdateParams::TaxID::Country::TaggedSymbol) }
860
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
728
861
 
729
862
  AD = T.let(:AD, Orb::Models::CustomerUpdateParams::TaxID::Country::TaggedSymbol)
730
863
  AE = T.let(:AE, Orb::Models::CustomerUpdateParams::TaxID::Country::TaggedSymbol)
@@ -813,8 +946,7 @@ module Orb
813
946
  extend Orb::Internal::Type::Enum
814
947
 
815
948
  TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CustomerUpdateParams::TaxID::Type) }
816
- OrSymbol =
817
- T.type_alias { T.any(Symbol, String, Orb::Models::CustomerUpdateParams::TaxID::Type::TaggedSymbol) }
949
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
818
950
 
819
951
  AD_NRT = T.let(:ad_nrt, Orb::Models::CustomerUpdateParams::TaxID::Type::TaggedSymbol)
820
952
  AE_TRN = T.let(:ae_trn, Orb::Models::CustomerUpdateParams::TaxID::Type::TaggedSymbol)
@@ -26,8 +26,13 @@ module Orb
26
26
  )
27
27
  .returns(T.attached_class)
28
28
  end
29
- def self.new(amount:, type:, description: nil, request_options: {}); end
30
-
29
+ def self.new(
30
+ amount:,
31
+ type:,
32
+ # An optional description that can be specified around this entry.
33
+ description: nil,
34
+ request_options: {}
35
+ ); end
31
36
  sig do
32
37
  override
33
38
  .returns(
@@ -46,8 +51,7 @@ module Orb
46
51
 
47
52
  TaggedSymbol =
48
53
  T.type_alias { T.all(Symbol, Orb::Models::Customers::BalanceTransactionCreateParams::Type) }
49
- OrSymbol =
50
- T.type_alias { T.any(Symbol, String, Orb::Models::Customers::BalanceTransactionCreateParams::Type::TaggedSymbol) }
54
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
51
55
 
52
56
  INCREMENT = T.let(:increment, Orb::Models::Customers::BalanceTransactionCreateParams::Type::TaggedSymbol)
53
57
  DECREMENT = T.let(:decrement, Orb::Models::Customers::BalanceTransactionCreateParams::Type::TaggedSymbol)
@@ -82,14 +82,22 @@ module Orb
82
82
  .returns(T.attached_class)
83
83
  end
84
84
  def self.new(
85
+ # A unique id for this transaction.
85
86
  id:,
86
87
  action:,
88
+ # The value of the amount changed in the transaction.
87
89
  amount:,
90
+ # The creation time of this transaction.
88
91
  created_at:,
89
92
  credit_note:,
93
+ # An optional description provided for manual customer balance adjustments.
90
94
  description:,
95
+ # The new value of the customer's balance prior to the transaction, in the
96
+ # customer's currency.
91
97
  ending_balance:,
92
98
  invoice:,
99
+ # The original value of the customer's balance prior to the transaction, in the
100
+ # customer's currency.
93
101
  starting_balance:,
94
102
  type:
95
103
  ); end
@@ -117,8 +125,7 @@ module Orb
117
125
 
118
126
  TaggedSymbol =
119
127
  T.type_alias { T.all(Symbol, Orb::Models::Customers::BalanceTransactionCreateResponse::Action) }
120
- OrSymbol =
121
- T.type_alias { T.any(Symbol, String, Orb::Models::Customers::BalanceTransactionCreateResponse::Action::TaggedSymbol) }
128
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
122
129
 
123
130
  APPLIED_TO_INVOICE =
124
131
  T.let(:applied_to_invoice, Orb::Models::Customers::BalanceTransactionCreateResponse::Action::TaggedSymbol)
@@ -158,8 +165,10 @@ module Orb
158
165
  attr_accessor :id
159
166
 
160
167
  sig { params(id: String).returns(T.attached_class) }
161
- def self.new(id:); end
162
-
168
+ def self.new(
169
+ # The id of the Credit note
170
+ id:
171
+ ); end
163
172
  sig { override.returns({id: String}) }
164
173
  def to_hash; end
165
174
  end
@@ -170,8 +179,10 @@ module Orb
170
179
  attr_accessor :id
171
180
 
172
181
  sig { params(id: String).returns(T.attached_class) }
173
- def self.new(id:); end
174
-
182
+ def self.new(
183
+ # The Invoice id
184
+ id:
185
+ ); end
175
186
  sig { override.returns({id: String}) }
176
187
  def to_hash; end
177
188
  end
@@ -181,8 +192,7 @@ module Orb
181
192
 
182
193
  TaggedSymbol =
183
194
  T.type_alias { T.all(Symbol, Orb::Models::Customers::BalanceTransactionCreateResponse::Type) }
184
- OrSymbol =
185
- T.type_alias { T.any(Symbol, String, Orb::Models::Customers::BalanceTransactionCreateResponse::Type::TaggedSymbol) }
195
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
186
196
 
187
197
  INCREMENT =
188
198
  T.let(:increment, Orb::Models::Customers::BalanceTransactionCreateResponse::Type::TaggedSymbol)
@@ -44,7 +44,10 @@ module Orb
44
44
  .returns(T.attached_class)
45
45
  end
46
46
  def self.new(
47
+ # Cursor for pagination. This can be populated by the `next_cursor` value returned
48
+ # from the initial request.
47
49
  cursor: nil,
50
+ # The number of items to fetch. Defaults to 20.
48
51
  limit: nil,
49
52
  operation_time_gt: nil,
50
53
  operation_time_gte: nil,
@@ -78,14 +78,22 @@ module Orb
78
78
  .returns(T.attached_class)
79
79
  end
80
80
  def self.new(
81
+ # A unique id for this transaction.
81
82
  id:,
82
83
  action:,
84
+ # The value of the amount changed in the transaction.
83
85
  amount:,
86
+ # The creation time of this transaction.
84
87
  created_at:,
85
88
  credit_note:,
89
+ # An optional description provided for manual customer balance adjustments.
86
90
  description:,
91
+ # The new value of the customer's balance prior to the transaction, in the
92
+ # customer's currency.
87
93
  ending_balance:,
88
94
  invoice:,
95
+ # The original value of the customer's balance prior to the transaction, in the
96
+ # customer's currency.
89
97
  starting_balance:,
90
98
  type:
91
99
  ); end
@@ -113,8 +121,7 @@ module Orb
113
121
 
114
122
  TaggedSymbol =
115
123
  T.type_alias { T.all(Symbol, Orb::Models::Customers::BalanceTransactionListResponse::Action) }
116
- OrSymbol =
117
- T.type_alias { T.any(Symbol, String, Orb::Models::Customers::BalanceTransactionListResponse::Action::TaggedSymbol) }
124
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
118
125
 
119
126
  APPLIED_TO_INVOICE =
120
127
  T.let(:applied_to_invoice, Orb::Models::Customers::BalanceTransactionListResponse::Action::TaggedSymbol)
@@ -148,8 +155,10 @@ module Orb
148
155
  attr_accessor :id
149
156
 
150
157
  sig { params(id: String).returns(T.attached_class) }
151
- def self.new(id:); end
152
-
158
+ def self.new(
159
+ # The id of the Credit note
160
+ id:
161
+ ); end
153
162
  sig { override.returns({id: String}) }
154
163
  def to_hash; end
155
164
  end
@@ -160,8 +169,10 @@ module Orb
160
169
  attr_accessor :id
161
170
 
162
171
  sig { params(id: String).returns(T.attached_class) }
163
- def self.new(id:); end
164
-
172
+ def self.new(
173
+ # The Invoice id
174
+ id:
175
+ ); end
165
176
  sig { override.returns({id: String}) }
166
177
  def to_hash; end
167
178
  end
@@ -171,8 +182,7 @@ module Orb
171
182
 
172
183
  TaggedSymbol =
173
184
  T.type_alias { T.all(Symbol, Orb::Models::Customers::BalanceTransactionListResponse::Type) }
174
- OrSymbol =
175
- T.type_alias { T.any(Symbol, String, Orb::Models::Customers::BalanceTransactionListResponse::Type::TaggedSymbol) }
185
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
176
186
 
177
187
  INCREMENT = T.let(:increment, Orb::Models::Customers::BalanceTransactionListResponse::Type::TaggedSymbol)
178
188
  DECREMENT = T.let(:decrement, Orb::Models::Customers::BalanceTransactionListResponse::Type::TaggedSymbol)
@@ -37,14 +37,19 @@ module Orb
37
37
  .returns(T.attached_class)
38
38
  end
39
39
  def self.new(
40
+ # The currency or custom pricing unit to use.
40
41
  currency: nil,
42
+ # Costs returned are exclusive of `timeframe_end`.
41
43
  timeframe_end: nil,
44
+ # Costs returned are inclusive of `timeframe_start`.
42
45
  timeframe_start: nil,
46
+ # Controls whether Orb returns cumulative costs since the start of the billing
47
+ # period, or incremental day-by-day costs. If your customer has minimums or
48
+ # discounts, it's strongly recommended that you use the default cumulative
49
+ # behavior.
43
50
  view_mode: nil,
44
51
  request_options: {}
45
- )
46
- end
47
-
52
+ ); end
48
53
  sig do
49
54
  override
50
55
  .returns(
@@ -68,8 +73,7 @@ module Orb
68
73
 
69
74
  TaggedSymbol =
70
75
  T.type_alias { T.all(Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode) }
71
- OrSymbol =
72
- T.type_alias { T.any(Symbol, String, Orb::Models::Customers::CostListByExternalIDParams::ViewMode::TaggedSymbol) }
76
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
73
77
 
74
78
  PERIODIC = T.let(:periodic, Orb::Models::Customers::CostListByExternalIDParams::ViewMode::TaggedSymbol)
75
79
  CUMULATIVE =