orb-billing 0.3.0 → 0.3.2

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 (644) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +47 -0
  3. data/README.md +7 -7
  4. data/lib/orb/errors.rb +9 -9
  5. data/lib/orb/file_part.rb +2 -2
  6. data/lib/orb/internal/page.rb +3 -3
  7. data/lib/orb/internal/transport/base_client.rb +3 -3
  8. data/lib/orb/internal/type/base_model.rb +1 -9
  9. data/lib/orb/internal/type/boolean.rb +10 -11
  10. data/lib/orb/internal/type/enum.rb +13 -14
  11. data/lib/orb/internal/type/request_parameters.rb +6 -12
  12. data/lib/orb/internal/type/union.rb +4 -4
  13. data/lib/orb/internal/type/unknown.rb +10 -11
  14. data/lib/orb/internal/util.rb +21 -5
  15. data/lib/orb/models/alert.rb +29 -32
  16. data/lib/orb/models/alert_create_for_customer_params.rb +7 -8
  17. data/lib/orb/models/alert_create_for_external_customer_params.rb +7 -8
  18. data/lib/orb/models/alert_create_for_subscription_params.rb +7 -8
  19. data/lib/orb/models/alert_list_params.rb +0 -1
  20. data/lib/orb/models/alert_update_params.rb +4 -5
  21. data/lib/orb/models/amount_discount.rb +6 -7
  22. data/lib/orb/models/billable_metric.rb +9 -11
  23. data/lib/orb/models/coupon.rb +9 -12
  24. data/lib/orb/models/coupon_create_params.rb +8 -10
  25. data/lib/orb/models/coupon_list_params.rb +0 -2
  26. data/lib/orb/models/coupons/subscription_list_params.rb +0 -1
  27. data/lib/orb/models/credit_note.rb +48 -46
  28. data/lib/orb/models/credit_note_create_params.rb +6 -6
  29. data/lib/orb/models/credit_note_list_params.rb +0 -1
  30. data/lib/orb/models/customer.rb +54 -61
  31. data/lib/orb/models/customer_create_params.rb +43 -55
  32. data/lib/orb/models/customer_list_params.rb +0 -1
  33. data/lib/orb/models/customer_update_by_external_id_params.rb +43 -57
  34. data/lib/orb/models/customer_update_params.rb +43 -53
  35. data/lib/orb/models/customers/balance_transaction_create_params.rb +3 -3
  36. data/lib/orb/models/customers/balance_transaction_create_response.rb +0 -2
  37. data/lib/orb/models/customers/balance_transaction_list_params.rb +0 -1
  38. data/lib/orb/models/customers/balance_transaction_list_response.rb +0 -2
  39. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +3 -4
  40. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -3
  41. data/lib/orb/models/customers/cost_list_params.rb +3 -4
  42. data/lib/orb/models/customers/cost_list_response.rb +3 -3
  43. data/lib/orb/models/customers/credit_list_by_external_id_params.rb +0 -2
  44. data/lib/orb/models/customers/credit_list_params.rb +0 -2
  45. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +12 -21
  46. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +106 -114
  47. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +11 -22
  48. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +111 -126
  49. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +6 -7
  50. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +110 -121
  51. data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
  52. data/lib/orb/models/customers/credits/ledger_list_response.rb +112 -131
  53. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +10 -15
  54. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +0 -6
  55. data/lib/orb/models/customers/credits/top_up_create_params.rb +7 -15
  56. data/lib/orb/models/customers/credits/top_up_create_response.rb +0 -6
  57. data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +0 -1
  58. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +0 -6
  59. data/lib/orb/models/customers/credits/top_up_list_params.rb +0 -1
  60. data/lib/orb/models/customers/credits/top_up_list_response.rb +0 -6
  61. data/lib/orb/models/dimensional_price_group.rb +1 -3
  62. data/lib/orb/models/dimensional_price_group_create_params.rb +0 -1
  63. data/lib/orb/models/dimensional_price_group_list_params.rb +0 -1
  64. data/lib/orb/models/dimensional_price_groups.rb +6 -6
  65. data/lib/orb/models/discount.rb +5 -5
  66. data/lib/orb/models/evaluate_price_group.rb +1 -1
  67. data/lib/orb/models/event_ingest_params.rb +4 -9
  68. data/lib/orb/models/event_ingest_response.rb +0 -3
  69. data/lib/orb/models/event_search_params.rb +0 -3
  70. data/lib/orb/models/event_search_response.rb +0 -4
  71. data/lib/orb/models/event_update_params.rb +0 -3
  72. data/lib/orb/models/events/backfill_close_response.rb +0 -4
  73. data/lib/orb/models/events/backfill_create_params.rb +0 -7
  74. data/lib/orb/models/events/backfill_create_response.rb +0 -4
  75. data/lib/orb/models/events/backfill_fetch_response.rb +0 -4
  76. data/lib/orb/models/events/backfill_list_params.rb +0 -1
  77. data/lib/orb/models/events/backfill_list_response.rb +0 -4
  78. data/lib/orb/models/events/backfill_revert_response.rb +0 -4
  79. data/lib/orb/models/events/event_volumes.rb +3 -3
  80. data/lib/orb/models/events/volume_list_params.rb +0 -3
  81. data/lib/orb/models/invoice.rb +165 -224
  82. data/lib/orb/models/invoice_create_params.rb +14 -21
  83. data/lib/orb/models/invoice_fetch_upcoming_response.rb +58 -107
  84. data/lib/orb/models/invoice_issue_params.rb +0 -1
  85. data/lib/orb/models/invoice_level_discount.rb +4 -4
  86. data/lib/orb/models/invoice_line_item_create_params.rb +0 -1
  87. data/lib/orb/models/invoice_line_item_create_response.rb +58 -81
  88. data/lib/orb/models/invoice_list_params.rb +6 -10
  89. data/lib/orb/models/invoice_update_params.rb +0 -1
  90. data/lib/orb/models/item.rb +7 -8
  91. data/lib/orb/models/item_list_params.rb +0 -1
  92. data/lib/orb/models/item_update_params.rb +7 -7
  93. data/lib/orb/models/metric_create_params.rb +0 -1
  94. data/lib/orb/models/metric_list_params.rb +0 -1
  95. data/lib/orb/models/metric_update_params.rb +0 -1
  96. data/lib/orb/models/percentage_discount.rb +6 -8
  97. data/lib/orb/models/plan.rb +83 -111
  98. data/lib/orb/models/plan_create_params.rb +753 -861
  99. data/lib/orb/models/plan_list_params.rb +3 -4
  100. data/lib/orb/models/plan_update_params.rb +0 -2
  101. data/lib/orb/models/plans/external_plan_id_update_params.rb +0 -2
  102. data/lib/orb/models/price.rb +1699 -1804
  103. data/lib/orb/models/price_create_params.rb +75 -84
  104. data/lib/orb/models/price_evaluate_params.rb +0 -2
  105. data/lib/orb/models/price_evaluate_response.rb +3 -3
  106. data/lib/orb/models/price_list_params.rb +0 -1
  107. data/lib/orb/models/price_update_params.rb +0 -1
  108. data/lib/orb/models/prices/external_price_id_update_params.rb +0 -1
  109. data/lib/orb/models/subscription.rb +94 -136
  110. data/lib/orb/models/subscription_cancel_params.rb +3 -5
  111. data/lib/orb/models/subscription_cancel_response.rb +52 -91
  112. data/lib/orb/models/subscription_change_apply_response.rb +50 -88
  113. data/lib/orb/models/subscription_change_cancel_response.rb +50 -87
  114. data/lib/orb/models/subscription_change_retrieve_response.rb +50 -87
  115. data/lib/orb/models/subscription_create_params.rb +1927 -1928
  116. data/lib/orb/models/subscription_create_response.rb +52 -91
  117. data/lib/orb/models/subscription_fetch_costs_params.rb +3 -4
  118. data/lib/orb/models/subscription_fetch_costs_response.rb +3 -3
  119. data/lib/orb/models/subscription_fetch_schedule_params.rb +0 -1
  120. data/lib/orb/models/subscription_fetch_schedule_response.rb +0 -1
  121. data/lib/orb/models/subscription_fetch_usage_params.rb +6 -8
  122. data/lib/orb/models/subscription_list_params.rb +3 -4
  123. data/lib/orb/models/subscription_price_intervals_params.rb +1141 -1079
  124. data/lib/orb/models/subscription_price_intervals_response.rb +51 -90
  125. data/lib/orb/models/subscription_schedule_plan_change_params.rb +1966 -1906
  126. data/lib/orb/models/subscription_schedule_plan_change_response.rb +50 -88
  127. data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
  128. data/lib/orb/models/subscription_trigger_phase_response.rb +51 -90
  129. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +50 -88
  130. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +50 -86
  131. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +50 -86
  132. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +3 -6
  133. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +50 -88
  134. data/lib/orb/models/subscription_update_params.rb +0 -5
  135. data/lib/orb/models/subscription_update_trial_params.rb +4 -6
  136. data/lib/orb/models/subscription_update_trial_response.rb +52 -91
  137. data/lib/orb/models/subscription_usage.rb +46 -39
  138. data/lib/orb/models/subscriptions.rb +6 -6
  139. data/lib/orb/models/trial_discount.rb +6 -7
  140. data/lib/orb/models/usage_discount.rb +6 -8
  141. data/lib/orb/models.rb +220 -0
  142. data/lib/orb/request_options.rb +4 -5
  143. data/lib/orb/resources/alerts.rb +30 -31
  144. data/lib/orb/resources/coupons/subscriptions.rb +3 -4
  145. data/lib/orb/resources/coupons.rb +11 -21
  146. data/lib/orb/resources/credit_notes.rb +10 -11
  147. data/lib/orb/resources/customers/balance_transactions.rb +3 -4
  148. data/lib/orb/resources/customers/costs.rb +4 -6
  149. data/lib/orb/resources/customers/credits/ledger.rb +18 -37
  150. data/lib/orb/resources/customers/credits/top_ups.rb +10 -20
  151. data/lib/orb/resources/customers/credits.rb +2 -6
  152. data/lib/orb/resources/customers.rb +40 -67
  153. data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +2 -2
  154. data/lib/orb/resources/dimensional_price_groups.rb +8 -10
  155. data/lib/orb/resources/events/backfills.rb +2 -10
  156. data/lib/orb/resources/events/volume.rb +3 -6
  157. data/lib/orb/resources/events.rb +4 -12
  158. data/lib/orb/resources/invoice_line_items.rb +1 -2
  159. data/lib/orb/resources/invoices.rb +26 -43
  160. data/lib/orb/resources/items.rb +12 -13
  161. data/lib/orb/resources/metrics.rb +11 -14
  162. data/lib/orb/resources/plans/external_plan_id.rb +5 -7
  163. data/lib/orb/resources/plans.rb +14 -23
  164. data/lib/orb/resources/prices/external_price_id.rb +5 -6
  165. data/lib/orb/resources/prices.rb +25 -35
  166. data/lib/orb/resources/subscription_changes.rb +1 -1
  167. data/lib/orb/resources/subscriptions.rb +49 -107
  168. data/lib/orb/version.rb +1 -1
  169. data/lib/orb.rb +1 -0
  170. data/rbi/{lib/orb → orb}/client.rbi +5 -4
  171. data/rbi/{lib/orb → orb}/errors.rbi +58 -27
  172. data/rbi/{lib/orb → orb}/file_part.rbi +9 -6
  173. data/rbi/{lib/orb → orb}/internal/page.rbi +19 -6
  174. data/rbi/{lib/orb → orb}/internal/transport/base_client.rbi +131 -73
  175. data/rbi/{lib/orb → orb}/internal/transport/pooled_net_requester.rbi +25 -12
  176. data/rbi/orb/internal/type/array_of.rbi +98 -0
  177. data/rbi/{lib/orb → orb}/internal/type/base_model.rbi +124 -65
  178. data/rbi/{lib/orb → orb}/internal/type/base_page.rbi +11 -7
  179. data/rbi/{lib/orb → orb}/internal/type/boolean.rbi +16 -10
  180. data/rbi/{lib/orb → orb}/internal/type/converter.rbi +66 -31
  181. data/rbi/{lib/orb → orb}/internal/type/enum.rbi +27 -15
  182. data/rbi/{lib/orb → orb}/internal/type/file_input.rbi +12 -10
  183. data/rbi/{lib/orb → orb}/internal/type/hash_of.rbi +34 -24
  184. data/rbi/orb/internal/type/request_parameters.rbi +29 -0
  185. data/rbi/orb/internal/type/union.rbi +110 -0
  186. data/rbi/orb/internal/type/unknown.rbi +50 -0
  187. data/rbi/orb/internal/util.rbi +424 -0
  188. data/rbi/{lib/orb → orb}/models/alert.rbi +107 -70
  189. data/rbi/{lib/orb → orb}/models/alert_create_for_customer_params.rbi +60 -27
  190. data/rbi/{lib/orb → orb}/models/alert_create_for_external_customer_params.rbi +68 -29
  191. data/rbi/{lib/orb → orb}/models/alert_create_for_subscription_params.rbi +53 -26
  192. data/rbi/{lib/orb → orb}/models/alert_disable_params.rbi +17 -6
  193. data/rbi/{lib/orb → orb}/models/alert_enable_params.rbi +17 -6
  194. data/rbi/{lib/orb → orb}/models/alert_list_params.rbi +23 -20
  195. data/rbi/orb/models/alert_retrieve_params.rbi +24 -0
  196. data/rbi/{lib/orb → orb}/models/alert_update_params.rbi +25 -14
  197. data/rbi/{lib/orb → orb}/models/amount_discount.rbi +28 -19
  198. data/rbi/{lib/orb → orb}/models/billable_metric.rbi +33 -26
  199. data/rbi/orb/models/billing_cycle_relative_date.rbi +24 -0
  200. data/rbi/{lib/orb → orb}/models/coupon.rbi +28 -20
  201. data/rbi/orb/models/coupon_archive_params.rbi +24 -0
  202. data/rbi/{lib/orb → orb}/models/coupon_create_params.rbi +74 -40
  203. data/rbi/orb/models/coupon_fetch_params.rbi +24 -0
  204. data/rbi/{lib/orb → orb}/models/coupon_list_params.rbi +18 -15
  205. data/rbi/{lib/orb → orb}/models/coupons/subscription_list_params.rbi +16 -6
  206. data/rbi/{lib/orb → orb}/models/credit_note.rbi +293 -158
  207. data/rbi/orb/models/credit_note_create_params.rbi +117 -0
  208. data/rbi/orb/models/credit_note_fetch_params.rbi +24 -0
  209. data/rbi/{lib/orb → orb}/models/credit_note_list_params.rbi +20 -17
  210. data/rbi/{lib/orb → orb}/models/customer.rbi +430 -329
  211. data/rbi/{lib/orb → orb}/models/customer_create_params.rbi +664 -327
  212. data/rbi/orb/models/customer_delete_params.rbi +24 -0
  213. data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +24 -0
  214. data/rbi/orb/models/customer_fetch_params.rbi +24 -0
  215. data/rbi/{lib/orb → orb}/models/customer_list_params.rbi +20 -17
  216. data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +24 -0
  217. data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +24 -0
  218. data/rbi/{lib/orb → orb}/models/customer_update_by_external_id_params.rbi +1138 -338
  219. data/rbi/{lib/orb → orb}/models/customer_update_params.rbi +663 -326
  220. data/rbi/orb/models/customers/balance_transaction_create_params.rbi +94 -0
  221. data/rbi/orb/models/customers/balance_transaction_create_response.rbi +301 -0
  222. data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_params.rbi +20 -17
  223. data/rbi/orb/models/customers/balance_transaction_list_response.rbi +301 -0
  224. data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_params.rbi +56 -22
  225. data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +263 -0
  226. data/rbi/{lib/orb → orb}/models/customers/cost_list_params.rbi +45 -22
  227. data/rbi/orb/models/customers/cost_list_response.rbi +254 -0
  228. data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_params.rbi +18 -15
  229. data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +110 -0
  230. data/rbi/{lib/orb → orb}/models/customers/credit_list_params.rbi +18 -15
  231. data/rbi/{lib/orb → orb}/models/customers/credit_list_response.rbi +44 -21
  232. data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_params.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi} +118 -60
  233. data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_response.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi} +685 -468
  234. data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi → orb/models/customers/credits/ledger_create_entry_params.rbi} +107 -69
  235. data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi → orb/models/customers/credits/ledger_create_entry_response.rbi} +643 -470
  236. data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +224 -0
  237. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_response.rbi +658 -469
  238. data/rbi/orb/models/customers/credits/ledger_list_params.rbi +224 -0
  239. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_response.rbi +708 -459
  240. data/rbi/{lib/orb/models/customers/credits/top_up_create_params.rbi → orb/models/customers/credits/top_up_create_by_external_id_params.rbi} +87 -46
  241. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_response.rbi +65 -48
  242. data/rbi/{lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi → orb/models/customers/credits/top_up_create_params.rbi} +73 -54
  243. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_response.rbi +83 -43
  244. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_by_external_id_params.rbi +16 -6
  245. data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +36 -0
  246. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_params.rbi +9 -5
  247. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_response.rbi +70 -49
  248. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_params.rbi +9 -5
  249. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_response.rbi +84 -43
  250. data/rbi/{lib/orb → orb}/models/dimensional_price_group.rbi +18 -15
  251. data/rbi/{lib/orb → orb}/models/dimensional_price_group_create_params.rbi +19 -16
  252. data/rbi/{lib/orb → orb}/models/dimensional_price_group_list_params.rbi +16 -6
  253. data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +24 -0
  254. data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +26 -0
  255. data/rbi/orb/models/dimensional_price_groups.rbi +38 -0
  256. data/rbi/orb/models/discount.rbi +23 -0
  257. data/rbi/{lib/orb → orb}/models/evaluate_price_group.rbi +28 -12
  258. data/rbi/orb/models/event_deprecate_params.rbi +24 -0
  259. data/rbi/{lib/orb → orb}/models/event_deprecate_response.rbi +8 -3
  260. data/rbi/{lib/orb → orb}/models/event_ingest_params.rbi +37 -31
  261. data/rbi/{lib/orb → orb}/models/event_ingest_response.rbi +63 -23
  262. data/rbi/{lib/orb → orb}/models/event_search_params.rbi +17 -14
  263. data/rbi/{lib/orb → orb}/models/event_search_response.rbi +33 -21
  264. data/rbi/{lib/orb → orb}/models/event_update_params.rbi +19 -16
  265. data/rbi/{lib/orb → orb}/models/event_update_response.rbi +8 -3
  266. data/rbi/orb/models/events/backfill_close_params.rbi +26 -0
  267. data/rbi/{lib/orb → orb}/models/events/backfill_close_response.rbi +64 -29
  268. data/rbi/{lib/orb → orb}/models/events/backfill_create_params.rbi +21 -18
  269. data/rbi/{lib/orb → orb}/models/events/backfill_create_response.rbi +63 -29
  270. data/rbi/orb/models/events/backfill_fetch_params.rbi +26 -0
  271. data/rbi/{lib/orb → orb}/models/events/backfill_fetch_response.rbi +64 -29
  272. data/rbi/{lib/orb → orb}/models/events/backfill_list_params.rbi +16 -6
  273. data/rbi/{lib/orb → orb}/models/events/backfill_list_response.rbi +62 -28
  274. data/rbi/orb/models/events/backfill_revert_params.rbi +26 -0
  275. data/rbi/{lib/orb → orb}/models/events/backfill_revert_response.rbi +63 -29
  276. data/rbi/{lib/orb → orb}/models/events/event_volumes.rbi +34 -12
  277. data/rbi/{lib/orb → orb}/models/events/volume_list_params.rbi +18 -15
  278. data/rbi/{lib/orb → orb}/models/invoice.rbi +1294 -831
  279. data/rbi/{lib/orb → orb}/models/invoice_create_params.rbi +97 -69
  280. data/rbi/orb/models/invoice_fetch_params.rbi +24 -0
  281. data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +32 -0
  282. data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_response.rbi +2003 -885
  283. data/rbi/{lib/orb → orb}/models/invoice_issue_params.rbi +16 -5
  284. data/rbi/orb/models/invoice_level_discount.rbi +22 -0
  285. data/rbi/{lib/orb → orb}/models/invoice_line_item_create_params.rbi +20 -17
  286. data/rbi/{lib/orb → orb}/models/invoice_line_item_create_response.rbi +594 -421
  287. data/rbi/{lib/orb → orb}/models/invoice_list_params.rbi +67 -47
  288. data/rbi/{lib/orb → orb}/models/invoice_mark_paid_params.rbi +17 -14
  289. data/rbi/orb/models/invoice_pay_params.rbi +24 -0
  290. data/rbi/{lib/orb → orb}/models/invoice_update_params.rbi +15 -10
  291. data/rbi/orb/models/invoice_void_params.rbi +24 -0
  292. data/rbi/orb/models/item.rbi +143 -0
  293. data/rbi/{lib/orb → orb}/models/item_create_params.rbi +14 -5
  294. data/rbi/orb/models/item_fetch_params.rbi +24 -0
  295. data/rbi/{lib/orb → orb}/models/item_list_params.rbi +16 -6
  296. data/rbi/orb/models/item_update_params.rbi +141 -0
  297. data/rbi/{lib/orb → orb}/models/metric_create_params.rbi +19 -16
  298. data/rbi/orb/models/metric_fetch_params.rbi +24 -0
  299. data/rbi/{lib/orb → orb}/models/metric_list_params.rbi +20 -17
  300. data/rbi/{lib/orb → orb}/models/metric_update_params.rbi +15 -10
  301. data/rbi/orb/models/pagination_metadata.rbi +31 -0
  302. data/rbi/{lib/orb → orb}/models/percentage_discount.rbi +32 -19
  303. data/rbi/{lib/orb → orb}/models/plan.rbi +501 -370
  304. data/rbi/{lib/orb → orb}/models/plan_create_params.rbi +4243 -3094
  305. data/rbi/orb/models/plan_fetch_params.rbi +24 -0
  306. data/rbi/{lib/orb → orb}/models/plan_list_params.rbi +34 -27
  307. data/rbi/{lib/orb → orb}/models/plan_update_params.rbi +16 -13
  308. data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +26 -0
  309. data/rbi/{lib/orb → orb}/models/plans/external_plan_id_update_params.rbi +16 -13
  310. data/rbi/orb/models/price.rbi +19414 -0
  311. data/rbi/{lib/orb → orb}/models/price_create_params.rbi +501 -245
  312. data/rbi/{lib/orb → orb}/models/price_evaluate_params.rbi +20 -17
  313. data/rbi/orb/models/price_evaluate_response.rbi +24 -0
  314. data/rbi/orb/models/price_fetch_params.rbi +24 -0
  315. data/rbi/{lib/orb → orb}/models/price_list_params.rbi +16 -6
  316. data/rbi/{lib/orb → orb}/models/price_update_params.rbi +15 -10
  317. data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +26 -0
  318. data/rbi/{lib/orb → orb}/models/prices/external_price_id_update_params.rbi +15 -10
  319. data/rbi/{lib/orb → orb}/models/subscription.rbi +586 -428
  320. data/rbi/{lib/orb → orb}/models/subscription_cancel_params.rbi +44 -22
  321. data/rbi/{lib/orb → orb}/models/subscription_cancel_response.rbi +724 -462
  322. data/rbi/{lib/orb → orb}/models/subscription_change_apply_params.rbi +16 -13
  323. data/rbi/{lib/orb → orb}/models/subscription_change_apply_response.rbi +808 -528
  324. data/rbi/orb/models/subscription_change_cancel_params.rbi +24 -0
  325. data/rbi/{lib/orb → orb}/models/subscription_change_cancel_response.rbi +807 -538
  326. data/rbi/orb/models/subscription_change_retrieve_params.rbi +24 -0
  327. data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_response.rbi +806 -548
  328. data/rbi/{lib/orb/models/subscription_schedule_plan_change_params.rbi → orb/models/subscription_create_params.rbi} +8466 -7080
  329. data/rbi/{lib/orb → orb}/models/subscription_create_response.rbi +724 -462
  330. data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_params.rbi +47 -22
  331. data/rbi/orb/models/subscription_fetch_costs_response.rbi +252 -0
  332. data/rbi/orb/models/subscription_fetch_params.rbi +24 -0
  333. data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_params.rbi +20 -17
  334. data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_response.rbi +33 -19
  335. data/rbi/{lib/orb → orb}/models/subscription_fetch_usage_params.rbi +81 -34
  336. data/rbi/{lib/orb → orb}/models/subscription_list_params.rbi +39 -28
  337. data/rbi/{lib/orb → orb}/models/subscription_price_intervals_params.rbi +4973 -3944
  338. data/rbi/{lib/orb → orb}/models/subscription_price_intervals_response.rbi +744 -477
  339. data/rbi/{lib/orb/models/subscription_create_params.rbi → orb/models/subscription_schedule_plan_change_params.rbi} +8649 -7019
  340. data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_response.rbi +742 -491
  341. data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_params.rbi +16 -13
  342. data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_response.rbi +736 -472
  343. data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +24 -0
  344. data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_response.rbi +743 -491
  345. data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +16 -5
  346. data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +717 -526
  347. data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +24 -0
  348. data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_response.rbi +732 -521
  349. data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_params.rbi +57 -26
  350. data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_response.rbi +743 -491
  351. data/rbi/{lib/orb → orb}/models/subscription_update_params.rbi +19 -16
  352. data/rbi/orb/models/subscription_update_trial_params.rbi +104 -0
  353. data/rbi/{lib/orb → orb}/models/subscription_update_trial_response.rbi +736 -471
  354. data/rbi/orb/models/subscription_usage.rbi +446 -0
  355. data/rbi/orb/models/subscriptions.rbi +38 -0
  356. data/rbi/orb/models/top_level_ping_params.rbi +24 -0
  357. data/rbi/{lib/orb → orb}/models/top_level_ping_response.rbi +7 -3
  358. data/rbi/{lib/orb → orb}/models/trial_discount.rbi +29 -20
  359. data/rbi/{lib/orb → orb}/models/usage_discount.rbi +28 -19
  360. data/rbi/orb/models.rbi +231 -0
  361. data/rbi/{lib/orb → orb}/request_options.rbi +12 -4
  362. data/rbi/{lib/orb → orb}/resources/alerts.rbi +57 -42
  363. data/rbi/{lib/orb → orb}/resources/coupons/subscriptions.rbi +7 -5
  364. data/rbi/{lib/orb → orb}/resources/coupons.rbi +25 -22
  365. data/rbi/{lib/orb → orb}/resources/credit_notes.rbi +18 -15
  366. data/rbi/{lib/orb → orb}/resources/customers/balance_transactions.rbi +17 -9
  367. data/rbi/{lib/orb → orb}/resources/customers/costs.rbi +18 -11
  368. data/rbi/{lib/orb → orb}/resources/customers/credits/ledger.rbi +98 -74
  369. data/rbi/{lib/orb → orb}/resources/customers/credits/top_ups.rbi +53 -29
  370. data/rbi/{lib/orb → orb}/resources/customers/credits.rbi +16 -7
  371. data/rbi/{lib/orb → orb}/resources/customers.rbi +117 -82
  372. data/rbi/{lib/orb → orb}/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +6 -5
  373. data/rbi/{lib/orb → orb}/resources/dimensional_price_groups.rbi +21 -14
  374. data/rbi/{lib/orb → orb}/resources/events/backfills.rbi +25 -20
  375. data/rbi/{lib/orb → orb}/resources/events/volume.rbi +7 -5
  376. data/rbi/{lib/orb → orb}/resources/events.rbi +22 -18
  377. data/rbi/{lib/orb → orb}/resources/invoice_line_items.rbi +7 -5
  378. data/rbi/{lib/orb → orb}/resources/invoices.rbi +55 -49
  379. data/rbi/{lib/orb → orb}/resources/items.rbi +31 -17
  380. data/rbi/{lib/orb → orb}/resources/metrics.rbi +21 -17
  381. data/rbi/{lib/orb → orb}/resources/plans/external_plan_id.rbi +11 -9
  382. data/rbi/{lib/orb → orb}/resources/plans.rbi +53 -49
  383. data/rbi/orb/resources/prices/external_price_id.rbi +108 -0
  384. data/rbi/{lib/orb → orb}/resources/prices.rbi +170 -157
  385. data/rbi/{lib/orb → orb}/resources/subscription_changes.rbi +15 -13
  386. data/rbi/{lib/orb → orb}/resources/subscriptions.rbi +188 -118
  387. data/rbi/{lib/orb → orb}/resources/top_level.rbi +7 -4
  388. data/sig/orb/internal/page.rbs +0 -2
  389. data/sig/orb/internal/type/request_parameters.rbs +3 -1
  390. data/sig/orb/internal/util.rbs +2 -0
  391. data/sig/orb/models/alert.rbs +19 -31
  392. data/sig/orb/models/alert_create_for_customer_params.rbs +3 -7
  393. data/sig/orb/models/alert_create_for_external_customer_params.rbs +3 -7
  394. data/sig/orb/models/alert_create_for_subscription_params.rbs +3 -7
  395. data/sig/orb/models/alert_disable_params.rbs +0 -2
  396. data/sig/orb/models/alert_enable_params.rbs +0 -2
  397. data/sig/orb/models/alert_list_params.rbs +0 -2
  398. data/sig/orb/models/alert_retrieve_params.rbs +0 -2
  399. data/sig/orb/models/alert_update_params.rbs +3 -7
  400. data/sig/orb/models/amount_discount.rbs +4 -6
  401. data/sig/orb/models/billable_metric.rbs +7 -9
  402. data/sig/orb/models/coupon.rbs +5 -8
  403. data/sig/orb/models/coupon_archive_params.rbs +0 -2
  404. data/sig/orb/models/coupon_create_params.rbs +7 -14
  405. data/sig/orb/models/coupon_fetch_params.rbs +0 -2
  406. data/sig/orb/models/coupon_list_params.rbs +0 -2
  407. data/sig/orb/models/coupons/subscription_list_params.rbs +0 -2
  408. data/sig/orb/models/credit_note.rbs +48 -66
  409. data/sig/orb/models/credit_note_create_params.rbs +3 -7
  410. data/sig/orb/models/credit_note_fetch_params.rbs +0 -2
  411. data/sig/orb/models/credit_note_list_params.rbs +0 -2
  412. data/sig/orb/models/customer.rbs +43 -63
  413. data/sig/orb/models/customer_create_params.rbs +36 -57
  414. data/sig/orb/models/customer_delete_params.rbs +0 -2
  415. data/sig/orb/models/customer_fetch_by_external_id_params.rbs +0 -2
  416. data/sig/orb/models/customer_fetch_params.rbs +0 -2
  417. data/sig/orb/models/customer_list_params.rbs +0 -2
  418. data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +0 -2
  419. data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +0 -2
  420. data/sig/orb/models/customer_update_by_external_id_params.rbs +36 -57
  421. data/sig/orb/models/customer_update_params.rbs +36 -57
  422. data/sig/orb/models/customers/balance_transaction_create_params.rbs +0 -2
  423. data/sig/orb/models/customers/balance_transaction_create_response.rbs +0 -6
  424. data/sig/orb/models/customers/balance_transaction_list_params.rbs +0 -2
  425. data/sig/orb/models/customers/balance_transaction_list_response.rbs +0 -6
  426. data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +0 -2
  427. data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +0 -6
  428. data/sig/orb/models/customers/cost_list_params.rbs +0 -2
  429. data/sig/orb/models/customers/cost_list_response.rbs +0 -6
  430. data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +0 -2
  431. data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +0 -2
  432. data/sig/orb/models/customers/credit_list_params.rbs +0 -2
  433. data/sig/orb/models/customers/credit_list_response.rbs +0 -2
  434. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +3 -7
  435. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +92 -134
  436. data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +3 -7
  437. data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +92 -134
  438. data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +0 -2
  439. data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +92 -134
  440. data/sig/orb/models/customers/credits/ledger_list_params.rbs +0 -2
  441. data/sig/orb/models/customers/credits/ledger_list_response.rbs +92 -134
  442. data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +3 -7
  443. data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +0 -4
  444. data/sig/orb/models/customers/credits/top_up_create_params.rbs +3 -7
  445. data/sig/orb/models/customers/credits/top_up_create_response.rbs +0 -4
  446. data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +0 -2
  447. data/sig/orb/models/customers/credits/top_up_delete_params.rbs +0 -2
  448. data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +0 -2
  449. data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +0 -4
  450. data/sig/orb/models/customers/credits/top_up_list_params.rbs +0 -2
  451. data/sig/orb/models/customers/credits/top_up_list_response.rbs +0 -4
  452. data/sig/orb/models/dimensional_price_group.rbs +0 -2
  453. data/sig/orb/models/dimensional_price_group_create_params.rbs +0 -2
  454. data/sig/orb/models/dimensional_price_group_list_params.rbs +0 -2
  455. data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +0 -2
  456. data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +0 -2
  457. data/sig/orb/models/dimensional_price_groups.rbs +6 -8
  458. data/sig/orb/models/discount.rbs +5 -5
  459. data/sig/orb/models/evaluate_price_group.rbs +4 -6
  460. data/sig/orb/models/event_deprecate_params.rbs +0 -2
  461. data/sig/orb/models/event_deprecate_response.rbs +0 -2
  462. data/sig/orb/models/event_ingest_params.rbs +3 -7
  463. data/sig/orb/models/event_ingest_response.rbs +0 -6
  464. data/sig/orb/models/event_search_params.rbs +0 -2
  465. data/sig/orb/models/event_search_response.rbs +0 -4
  466. data/sig/orb/models/event_update_params.rbs +0 -2
  467. data/sig/orb/models/event_update_response.rbs +0 -2
  468. data/sig/orb/models/events/backfill_close_params.rbs +0 -2
  469. data/sig/orb/models/events/backfill_close_response.rbs +0 -2
  470. data/sig/orb/models/events/backfill_create_params.rbs +0 -2
  471. data/sig/orb/models/events/backfill_create_response.rbs +0 -2
  472. data/sig/orb/models/events/backfill_fetch_params.rbs +0 -2
  473. data/sig/orb/models/events/backfill_fetch_response.rbs +0 -2
  474. data/sig/orb/models/events/backfill_list_params.rbs +0 -2
  475. data/sig/orb/models/events/backfill_list_response.rbs +0 -2
  476. data/sig/orb/models/events/backfill_revert_params.rbs +0 -2
  477. data/sig/orb/models/events/backfill_revert_response.rbs +0 -2
  478. data/sig/orb/models/events/event_volumes.rbs +3 -10
  479. data/sig/orb/models/events/volume_list_params.rbs +0 -2
  480. data/sig/orb/models/invoice.rbs +126 -188
  481. data/sig/orb/models/invoice_create_params.rbs +10 -16
  482. data/sig/orb/models/invoice_fetch_params.rbs +0 -2
  483. data/sig/orb/models/invoice_fetch_upcoming_params.rbs +0 -2
  484. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +41 -103
  485. data/sig/orb/models/invoice_issue_params.rbs +0 -2
  486. data/sig/orb/models/invoice_level_discount.rbs +2 -4
  487. data/sig/orb/models/invoice_line_item_create_params.rbs +0 -2
  488. data/sig/orb/models/invoice_line_item_create_response.rbs +41 -75
  489. data/sig/orb/models/invoice_list_params.rbs +4 -6
  490. data/sig/orb/models/invoice_mark_paid_params.rbs +0 -2
  491. data/sig/orb/models/invoice_pay_params.rbs +0 -2
  492. data/sig/orb/models/invoice_update_params.rbs +0 -2
  493. data/sig/orb/models/invoice_void_params.rbs +0 -2
  494. data/sig/orb/models/item.rbs +7 -11
  495. data/sig/orb/models/item_create_params.rbs +0 -2
  496. data/sig/orb/models/item_fetch_params.rbs +0 -2
  497. data/sig/orb/models/item_list_params.rbs +0 -2
  498. data/sig/orb/models/item_update_params.rbs +7 -11
  499. data/sig/orb/models/metric_create_params.rbs +0 -2
  500. data/sig/orb/models/metric_fetch_params.rbs +0 -2
  501. data/sig/orb/models/metric_list_params.rbs +0 -2
  502. data/sig/orb/models/metric_update_params.rbs +0 -2
  503. data/sig/orb/models/pagination_metadata.rbs +0 -2
  504. data/sig/orb/models/percentage_discount.rbs +4 -6
  505. data/sig/orb/models/plan.rbs +55 -83
  506. data/sig/orb/models/plan_create_params.rbs +568 -746
  507. data/sig/orb/models/plan_fetch_params.rbs +0 -2
  508. data/sig/orb/models/plan_list_params.rbs +0 -2
  509. data/sig/orb/models/plan_update_params.rbs +0 -2
  510. data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +0 -2
  511. data/sig/orb/models/plans/external_plan_id_update_params.rbs +0 -2
  512. data/sig/orb/models/price.rbs +1250 -1790
  513. data/sig/orb/models/price_create_params.rbs +59 -97
  514. data/sig/orb/models/price_evaluate_params.rbs +0 -2
  515. data/sig/orb/models/price_evaluate_response.rbs +3 -6
  516. data/sig/orb/models/price_fetch_params.rbs +0 -2
  517. data/sig/orb/models/price_list_params.rbs +0 -2
  518. data/sig/orb/models/price_update_params.rbs +0 -2
  519. data/sig/orb/models/prices/external_price_id_fetch_params.rbs +0 -2
  520. data/sig/orb/models/prices/external_price_id_update_params.rbs +0 -2
  521. data/sig/orb/models/subscription.rbs +72 -110
  522. data/sig/orb/models/subscription_cancel_params.rbs +0 -2
  523. data/sig/orb/models/subscription_cancel_response.rbs +44 -84
  524. data/sig/orb/models/subscription_change_apply_params.rbs +0 -2
  525. data/sig/orb/models/subscription_change_apply_response.rbs +44 -86
  526. data/sig/orb/models/subscription_change_cancel_params.rbs +0 -2
  527. data/sig/orb/models/subscription_change_cancel_response.rbs +44 -86
  528. data/sig/orb/models/subscription_change_retrieve_params.rbs +0 -2
  529. data/sig/orb/models/subscription_change_retrieve_response.rbs +44 -86
  530. data/sig/orb/models/subscription_create_params.rbs +1223 -1619
  531. data/sig/orb/models/subscription_create_response.rbs +44 -84
  532. data/sig/orb/models/subscription_fetch_costs_params.rbs +0 -2
  533. data/sig/orb/models/subscription_fetch_costs_response.rbs +0 -6
  534. data/sig/orb/models/subscription_fetch_params.rbs +0 -2
  535. data/sig/orb/models/subscription_fetch_schedule_params.rbs +0 -2
  536. data/sig/orb/models/subscription_fetch_schedule_response.rbs +0 -4
  537. data/sig/orb/models/subscription_fetch_usage_params.rbs +0 -2
  538. data/sig/orb/models/subscription_list_params.rbs +0 -2
  539. data/sig/orb/models/subscription_price_intervals_params.rbs +738 -970
  540. data/sig/orb/models/subscription_price_intervals_response.rbs +44 -84
  541. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1223 -1619
  542. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +44 -84
  543. data/sig/orb/models/subscription_trigger_phase_params.rbs +0 -2
  544. data/sig/orb/models/subscription_trigger_phase_response.rbs +44 -84
  545. data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +0 -2
  546. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +44 -84
  547. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +0 -2
  548. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +44 -84
  549. data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +0 -2
  550. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +44 -84
  551. data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +0 -2
  552. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +44 -84
  553. data/sig/orb/models/subscription_update_params.rbs +0 -2
  554. data/sig/orb/models/subscription_update_trial_params.rbs +1 -3
  555. data/sig/orb/models/subscription_update_trial_response.rbs +44 -84
  556. data/sig/orb/models/subscription_usage.rbs +35 -53
  557. data/sig/orb/models/subscriptions.rbs +6 -8
  558. data/sig/orb/models/top_level_ping_params.rbs +0 -2
  559. data/sig/orb/models/top_level_ping_response.rbs +0 -2
  560. data/sig/orb/models/trial_discount.rbs +4 -6
  561. data/sig/orb/models/usage_discount.rbs +4 -6
  562. data/sig/orb/models.rbs +215 -0
  563. data/sig/orb/request_options.rbs +1 -1
  564. data/sig/orb/resources/alerts.rbs +12 -12
  565. data/sig/orb/resources/coupons/subscriptions.rbs +1 -1
  566. data/sig/orb/resources/coupons.rbs +4 -4
  567. data/sig/orb/resources/credit_notes.rbs +4 -4
  568. data/sig/orb/resources/customers/credits/ledger.rbs +2 -2
  569. data/sig/orb/resources/customers/credits/top_ups.rbs +2 -2
  570. data/sig/orb/resources/customers.rbs +24 -24
  571. data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +1 -1
  572. data/sig/orb/resources/dimensional_price_groups.rbs +3 -3
  573. data/sig/orb/resources/events/volume.rbs +1 -1
  574. data/sig/orb/resources/events.rbs +1 -1
  575. data/sig/orb/resources/invoices.rbs +10 -10
  576. data/sig/orb/resources/items.rbs +5 -5
  577. data/sig/orb/resources/metrics.rbs +4 -4
  578. data/sig/orb/resources/plans/external_plan_id.rbs +2 -2
  579. data/sig/orb/resources/plans.rbs +5 -5
  580. data/sig/orb/resources/prices.rbs +11 -11
  581. data/sig/orb/resources/subscriptions.rbs +21 -21
  582. metadata +226 -223
  583. data/rbi/lib/orb/internal/type/array_of.rbi +0 -90
  584. data/rbi/lib/orb/internal/type/request_parameters.rbi +0 -21
  585. data/rbi/lib/orb/internal/type/union.rbi +0 -75
  586. data/rbi/lib/orb/internal/type/unknown.rbi +0 -42
  587. data/rbi/lib/orb/internal/util.rbi +0 -299
  588. data/rbi/lib/orb/models/alert_retrieve_params.rbi +0 -18
  589. data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +0 -18
  590. data/rbi/lib/orb/models/coupon_archive_params.rbi +0 -18
  591. data/rbi/lib/orb/models/coupon_fetch_params.rbi +0 -18
  592. data/rbi/lib/orb/models/credit_note_create_params.rbi +0 -88
  593. data/rbi/lib/orb/models/credit_note_fetch_params.rbi +0 -18
  594. data/rbi/lib/orb/models/customer_delete_params.rbi +0 -18
  595. data/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi +0 -18
  596. data/rbi/lib/orb/models/customer_fetch_params.rbi +0 -18
  597. data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +0 -18
  598. data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +0 -18
  599. data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +0 -65
  600. data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +0 -208
  601. data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +0 -196
  602. data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +0 -225
  603. data/rbi/lib/orb/models/customers/cost_list_response.rbi +0 -223
  604. data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +0 -84
  605. data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +0 -166
  606. data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +0 -141
  607. data/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi +0 -26
  608. data/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi +0 -18
  609. data/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +0 -25
  610. data/rbi/lib/orb/models/dimensional_price_groups.rbi +0 -33
  611. data/rbi/lib/orb/models/discount.rbi +0 -17
  612. data/rbi/lib/orb/models/event_deprecate_params.rbi +0 -18
  613. data/rbi/lib/orb/models/events/backfill_close_params.rbi +0 -25
  614. data/rbi/lib/orb/models/events/backfill_fetch_params.rbi +0 -25
  615. data/rbi/lib/orb/models/events/backfill_revert_params.rbi +0 -25
  616. data/rbi/lib/orb/models/invoice_fetch_params.rbi +0 -18
  617. data/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi +0 -22
  618. data/rbi/lib/orb/models/invoice_level_discount.rbi +0 -15
  619. data/rbi/lib/orb/models/invoice_pay_params.rbi +0 -18
  620. data/rbi/lib/orb/models/invoice_void_params.rbi +0 -18
  621. data/rbi/lib/orb/models/item.rbi +0 -95
  622. data/rbi/lib/orb/models/item_fetch_params.rbi +0 -18
  623. data/rbi/lib/orb/models/item_update_params.rbi +0 -101
  624. data/rbi/lib/orb/models/metric_fetch_params.rbi +0 -18
  625. data/rbi/lib/orb/models/pagination_metadata.rbi +0 -19
  626. data/rbi/lib/orb/models/plan_fetch_params.rbi +0 -18
  627. data/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi +0 -25
  628. data/rbi/lib/orb/models/price.rbi +0 -14861
  629. data/rbi/lib/orb/models/price_evaluate_response.rbi +0 -19
  630. data/rbi/lib/orb/models/price_fetch_params.rbi +0 -18
  631. data/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi +0 -25
  632. data/rbi/lib/orb/models/subscription_change_cancel_params.rbi +0 -18
  633. data/rbi/lib/orb/models/subscription_change_retrieve_params.rbi +0 -18
  634. data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +0 -221
  635. data/rbi/lib/orb/models/subscription_fetch_params.rbi +0 -18
  636. data/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi +0 -18
  637. data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +0 -18
  638. data/rbi/lib/orb/models/subscription_update_trial_params.rbi +0 -66
  639. data/rbi/lib/orb/models/subscription_usage.rbi +0 -296
  640. data/rbi/lib/orb/models/subscriptions.rbi +0 -31
  641. data/rbi/lib/orb/models/top_level_ping_params.rbi +0 -18
  642. data/rbi/lib/orb/resources/prices/external_price_id.rbi +0 -106
  643. /data/rbi/{lib/orb → orb}/internal.rbi +0 -0
  644. /data/rbi/{lib/orb → orb}/version.rbi +0 -0
@@ -9,9 +9,9 @@ module Orb
9
9
 
10
10
  # @!attribute accounting_sync_configuration
11
11
  #
12
- # @return [Orb::Models::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration, nil]
12
+ # @return [Orb::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration, nil]
13
13
  optional :accounting_sync_configuration,
14
- -> { Orb::Models::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration },
14
+ -> { Orb::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration },
15
15
  nil?: true
16
16
 
17
17
  # @!attribute additional_emails
@@ -31,10 +31,8 @@ module Orb
31
31
 
32
32
  # @!attribute billing_address
33
33
  #
34
- # @return [Orb::Models::CustomerUpdateByExternalIDParams::BillingAddress, nil]
35
- optional :billing_address,
36
- -> { Orb::Models::CustomerUpdateByExternalIDParams::BillingAddress },
37
- nil?: true
34
+ # @return [Orb::CustomerUpdateByExternalIDParams::BillingAddress, nil]
35
+ optional :billing_address, -> { Orb::CustomerUpdateByExternalIDParams::BillingAddress }, nil?: true
38
36
 
39
37
  # @!attribute currency
40
38
  # An ISO 4217 currency string used for the customer's invoices and balance. If not
@@ -64,8 +62,8 @@ module Orb
64
62
  # @!attribute hierarchy
65
63
  # The hierarchical relationships for this customer.
66
64
  #
67
- # @return [Orb::Models::CustomerUpdateByExternalIDParams::Hierarchy, nil]
68
- optional :hierarchy, -> { Orb::Models::CustomerUpdateByExternalIDParams::Hierarchy }, nil?: true
65
+ # @return [Orb::CustomerUpdateByExternalIDParams::Hierarchy, nil]
66
+ optional :hierarchy, -> { Orb::CustomerUpdateByExternalIDParams::Hierarchy }, nil?: true
69
67
 
70
68
  # @!attribute metadata
71
69
  # User-specified key/value pairs for the resource. Individual keys can be removed
@@ -90,9 +88,9 @@ module Orb
90
88
  # `bill.com`, `netsuite`), any product mappings must first be configured with
91
89
  # the Orb team.
92
90
  #
93
- # @return [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider, nil]
91
+ # @return [Symbol, Orb::CustomerUpdateByExternalIDParams::PaymentProvider, nil]
94
92
  optional :payment_provider,
95
- enum: -> { Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider },
93
+ enum: -> { Orb::CustomerUpdateByExternalIDParams::PaymentProvider },
96
94
  nil?: true
97
95
 
98
96
  # @!attribute payment_provider_id
@@ -104,23 +102,21 @@ module Orb
104
102
 
105
103
  # @!attribute reporting_configuration
106
104
  #
107
- # @return [Orb::Models::CustomerUpdateByExternalIDParams::ReportingConfiguration, nil]
105
+ # @return [Orb::CustomerUpdateByExternalIDParams::ReportingConfiguration, nil]
108
106
  optional :reporting_configuration,
109
- -> { Orb::Models::CustomerUpdateByExternalIDParams::ReportingConfiguration },
107
+ -> { Orb::CustomerUpdateByExternalIDParams::ReportingConfiguration },
110
108
  nil?: true
111
109
 
112
110
  # @!attribute shipping_address
113
111
  #
114
- # @return [Orb::Models::CustomerUpdateByExternalIDParams::ShippingAddress, nil]
115
- optional :shipping_address,
116
- -> { Orb::Models::CustomerUpdateByExternalIDParams::ShippingAddress },
117
- nil?: true
112
+ # @return [Orb::CustomerUpdateByExternalIDParams::ShippingAddress, nil]
113
+ optional :shipping_address, -> { Orb::CustomerUpdateByExternalIDParams::ShippingAddress }, nil?: true
118
114
 
119
115
  # @!attribute tax_configuration
120
116
  #
121
- # @return [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewTaxJarConfiguration, nil]
117
+ # @return [Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar, nil]
122
118
  optional :tax_configuration,
123
- union: -> { Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration },
119
+ union: -> { Orb::CustomerUpdateByExternalIDParams::TaxConfiguration },
124
120
  nil?: true
125
121
 
126
122
  # @!attribute tax_id
@@ -230,63 +226,57 @@ module Orb
230
226
  # | Venezuela | `ve_rif` | Venezuelan RIF Number |
231
227
  # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
232
228
  #
233
- # @return [Orb::Models::CustomerUpdateByExternalIDParams::TaxID, nil]
234
- optional :tax_id, -> { Orb::Models::CustomerUpdateByExternalIDParams::TaxID }, nil?: true
229
+ # @return [Orb::CustomerUpdateByExternalIDParams::TaxID, nil]
230
+ optional :tax_id, -> { Orb::CustomerUpdateByExternalIDParams::TaxID }, nil?: true
235
231
 
236
232
  # @!method initialize(accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {})
237
233
  # Some parameter documentations has been truncated, see
238
234
  # {Orb::Models::CustomerUpdateByExternalIDParams} for more details.
239
235
  #
240
- # @param accounting_sync_configuration [Orb::Models::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration, nil]
236
+ # @param accounting_sync_configuration [Orb::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration, nil]
241
237
  #
242
238
  # @param additional_emails [Array<String>, nil] Additional email addresses for this customer. If populated, these email addresse
243
- # ...
244
239
  #
245
240
  # @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch
246
- # ...
247
241
  #
248
- # @param billing_address [Orb::Models::CustomerUpdateByExternalIDParams::BillingAddress, nil]
242
+ # @param billing_address [Orb::CustomerUpdateByExternalIDParams::BillingAddress, nil]
249
243
  #
250
244
  # @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
251
- # ...
252
245
  #
253
246
  # @param email [String, nil] A valid customer email, to be used for invoicing and notifications.
254
247
  #
255
248
  # @param email_delivery [Boolean, nil]
256
249
  #
257
250
  # @param external_customer_id [String, nil] The external customer ID. This can only be set if empty and the customer has no
258
- # ...
259
251
  #
260
- # @param hierarchy [Orb::Models::CustomerUpdateByExternalIDParams::Hierarchy, nil] The hierarchical relationships for this customer.
252
+ # @param hierarchy [Orb::CustomerUpdateByExternalIDParams::Hierarchy, nil] The hierarchical relationships for this customer.
261
253
  #
262
254
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
263
- # ...
264
255
  #
265
256
  # @param name [String, nil] The full name of the customer
266
257
  #
267
- # @param payment_provider [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
268
- # ...
258
+ # @param payment_provider [Symbol, Orb::CustomerUpdateByExternalIDParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
269
259
  #
270
260
  # @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
271
- # ...
272
261
  #
273
- # @param reporting_configuration [Orb::Models::CustomerUpdateByExternalIDParams::ReportingConfiguration, nil]
262
+ # @param reporting_configuration [Orb::CustomerUpdateByExternalIDParams::ReportingConfiguration, nil]
274
263
  #
275
- # @param shipping_address [Orb::Models::CustomerUpdateByExternalIDParams::ShippingAddress, nil]
264
+ # @param shipping_address [Orb::CustomerUpdateByExternalIDParams::ShippingAddress, nil]
276
265
  #
277
- # @param tax_configuration [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewTaxJarConfiguration, nil]
266
+ # @param tax_configuration [Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar, nil]
278
267
  #
279
- # @param tax_id [Orb::Models::CustomerUpdateByExternalIDParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
280
- # ...
268
+ # @param tax_id [Orb::CustomerUpdateByExternalIDParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
281
269
  #
282
270
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
283
271
 
284
272
  class AccountingSyncConfiguration < Orb::Internal::Type::BaseModel
285
273
  # @!attribute accounting_providers
286
274
  #
287
- # @return [Array<Orb::Models::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration::AccountingProvider>, nil]
275
+ # @return [Array<Orb::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration::AccountingProvider>, nil]
288
276
  optional :accounting_providers,
289
- -> { Orb::Internal::Type::ArrayOf[Orb::Models::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration::AccountingProvider] },
277
+ -> {
278
+ Orb::Internal::Type::ArrayOf[Orb::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration::AccountingProvider]
279
+ },
290
280
  nil?: true
291
281
 
292
282
  # @!attribute excluded
@@ -295,7 +285,7 @@ module Orb
295
285
  optional :excluded, Orb::Internal::Type::Boolean, nil?: true
296
286
 
297
287
  # @!method initialize(accounting_providers: nil, excluded: nil)
298
- # @param accounting_providers [Array<Orb::Models::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration::AccountingProvider>, nil]
288
+ # @param accounting_providers [Array<Orb::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration::AccountingProvider>, nil]
299
289
  # @param excluded [Boolean, nil]
300
290
 
301
291
  class AccountingProvider < Orb::Internal::Type::BaseModel
@@ -372,15 +362,13 @@ module Orb
372
362
 
373
363
  # @!method initialize(child_customer_ids: nil, parent_customer_id: nil)
374
364
  # Some parameter documentations has been truncated, see
375
- # {Orb::Models::CustomerUpdateByExternalIDParams::Hierarchy} for more details.
365
+ # {Orb::CustomerUpdateByExternalIDParams::Hierarchy} for more details.
376
366
  #
377
367
  # The hierarchical relationships for this customer.
378
368
  #
379
369
  # @param child_customer_ids [Array<String>] A list of child customer IDs to add to the hierarchy. The desired child customer
380
- # ...
381
370
  #
382
371
  # @param parent_customer_id [String, nil] The ID of the parent customer in the hierarchy. The desired parent customer must
383
- # ...
384
372
  end
385
373
 
386
374
  # This is used for creating charges or invoices in an external system via Orb.
@@ -458,13 +446,11 @@ module Orb
458
446
 
459
447
  discriminator :tax_provider
460
448
 
461
- variant :avalara,
462
- -> { Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewAvalaraTaxConfiguration }
449
+ variant :avalara, -> { Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara }
463
450
 
464
- variant :taxjar,
465
- -> { Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewTaxJarConfiguration }
451
+ variant :taxjar, -> { Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar }
466
452
 
467
- class NewAvalaraTaxConfiguration < Orb::Internal::Type::BaseModel
453
+ class Avalara < Orb::Internal::Type::BaseModel
468
454
  # @!attribute tax_exempt
469
455
  #
470
456
  # @return [Boolean]
@@ -486,7 +472,7 @@ module Orb
486
472
  # @param tax_provider [Symbol, :avalara]
487
473
  end
488
474
 
489
- class NewTaxJarConfiguration < Orb::Internal::Type::BaseModel
475
+ class Taxjar < Orb::Internal::Type::BaseModel
490
476
  # @!attribute tax_exempt
491
477
  #
492
478
  # @return [Boolean]
@@ -503,19 +489,19 @@ module Orb
503
489
  end
504
490
 
505
491
  # @!method self.variants
506
- # @return [Array(Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewTaxJarConfiguration)]
492
+ # @return [Array(Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar)]
507
493
  end
508
494
 
509
495
  class TaxID < Orb::Internal::Type::BaseModel
510
496
  # @!attribute country
511
497
  #
512
- # @return [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country]
513
- required :country, enum: -> { Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country }
498
+ # @return [Symbol, Orb::CustomerUpdateByExternalIDParams::TaxID::Country]
499
+ required :country, enum: -> { Orb::CustomerUpdateByExternalIDParams::TaxID::Country }
514
500
 
515
501
  # @!attribute type
516
502
  #
517
- # @return [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Type]
518
- required :type, enum: -> { Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Type }
503
+ # @return [Symbol, Orb::CustomerUpdateByExternalIDParams::TaxID::Type]
504
+ required :type, enum: -> { Orb::CustomerUpdateByExternalIDParams::TaxID::Type }
519
505
 
520
506
  # @!attribute value
521
507
  #
@@ -629,11 +615,11 @@ module Orb
629
615
  # | Venezuela | `ve_rif` | Venezuelan RIF Number |
630
616
  # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
631
617
  #
632
- # @param country [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country]
633
- # @param type [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Type]
618
+ # @param country [Symbol, Orb::CustomerUpdateByExternalIDParams::TaxID::Country]
619
+ # @param type [Symbol, Orb::CustomerUpdateByExternalIDParams::TaxID::Type]
634
620
  # @param value [String]
635
621
 
636
- # @see Orb::Models::CustomerUpdateByExternalIDParams::TaxID#country
622
+ # @see Orb::CustomerUpdateByExternalIDParams::TaxID#country
637
623
  module Country
638
624
  extend Orb::Internal::Type::Enum
639
625
 
@@ -720,7 +706,7 @@ module Orb
720
706
  # @return [Array<Symbol>]
721
707
  end
722
708
 
723
- # @see Orb::Models::CustomerUpdateByExternalIDParams::TaxID#type
709
+ # @see Orb::CustomerUpdateByExternalIDParams::TaxID#type
724
710
  module Type
725
711
  extend Orb::Internal::Type::Enum
726
712
 
@@ -9,9 +9,9 @@ module Orb
9
9
 
10
10
  # @!attribute accounting_sync_configuration
11
11
  #
12
- # @return [Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration, nil]
12
+ # @return [Orb::CustomerUpdateParams::AccountingSyncConfiguration, nil]
13
13
  optional :accounting_sync_configuration,
14
- -> { Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration },
14
+ -> { Orb::CustomerUpdateParams::AccountingSyncConfiguration },
15
15
  nil?: true
16
16
 
17
17
  # @!attribute additional_emails
@@ -31,8 +31,8 @@ module Orb
31
31
 
32
32
  # @!attribute billing_address
33
33
  #
34
- # @return [Orb::Models::CustomerUpdateParams::BillingAddress, nil]
35
- optional :billing_address, -> { Orb::Models::CustomerUpdateParams::BillingAddress }, nil?: true
34
+ # @return [Orb::CustomerUpdateParams::BillingAddress, nil]
35
+ optional :billing_address, -> { Orb::CustomerUpdateParams::BillingAddress }, nil?: true
36
36
 
37
37
  # @!attribute currency
38
38
  # An ISO 4217 currency string used for the customer's invoices and balance. If not
@@ -62,8 +62,8 @@ module Orb
62
62
  # @!attribute hierarchy
63
63
  # The hierarchical relationships for this customer.
64
64
  #
65
- # @return [Orb::Models::CustomerUpdateParams::Hierarchy, nil]
66
- optional :hierarchy, -> { Orb::Models::CustomerUpdateParams::Hierarchy }, nil?: true
65
+ # @return [Orb::CustomerUpdateParams::Hierarchy, nil]
66
+ optional :hierarchy, -> { Orb::CustomerUpdateParams::Hierarchy }, nil?: true
67
67
 
68
68
  # @!attribute metadata
69
69
  # User-specified key/value pairs for the resource. Individual keys can be removed
@@ -88,8 +88,8 @@ module Orb
88
88
  # `bill.com`, `netsuite`), any product mappings must first be configured with
89
89
  # the Orb team.
90
90
  #
91
- # @return [Symbol, Orb::Models::CustomerUpdateParams::PaymentProvider, nil]
92
- optional :payment_provider, enum: -> { Orb::Models::CustomerUpdateParams::PaymentProvider }, nil?: true
91
+ # @return [Symbol, Orb::CustomerUpdateParams::PaymentProvider, nil]
92
+ optional :payment_provider, enum: -> { Orb::CustomerUpdateParams::PaymentProvider }, nil?: true
93
93
 
94
94
  # @!attribute payment_provider_id
95
95
  # The ID of this customer in an external payments solution, such as Stripe. This
@@ -100,20 +100,18 @@ module Orb
100
100
 
101
101
  # @!attribute reporting_configuration
102
102
  #
103
- # @return [Orb::Models::CustomerUpdateParams::ReportingConfiguration, nil]
104
- optional :reporting_configuration,
105
- -> { Orb::Models::CustomerUpdateParams::ReportingConfiguration },
106
- nil?: true
103
+ # @return [Orb::CustomerUpdateParams::ReportingConfiguration, nil]
104
+ optional :reporting_configuration, -> { Orb::CustomerUpdateParams::ReportingConfiguration }, nil?: true
107
105
 
108
106
  # @!attribute shipping_address
109
107
  #
110
- # @return [Orb::Models::CustomerUpdateParams::ShippingAddress, nil]
111
- optional :shipping_address, -> { Orb::Models::CustomerUpdateParams::ShippingAddress }, nil?: true
108
+ # @return [Orb::CustomerUpdateParams::ShippingAddress, nil]
109
+ optional :shipping_address, -> { Orb::CustomerUpdateParams::ShippingAddress }, nil?: true
112
110
 
113
111
  # @!attribute tax_configuration
114
112
  #
115
- # @return [Orb::Models::CustomerUpdateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateParams::TaxConfiguration::NewTaxJarConfiguration, nil]
116
- optional :tax_configuration, union: -> { Orb::Models::CustomerUpdateParams::TaxConfiguration }, nil?: true
113
+ # @return [Orb::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::CustomerUpdateParams::TaxConfiguration::Taxjar, nil]
114
+ optional :tax_configuration, union: -> { Orb::CustomerUpdateParams::TaxConfiguration }, nil?: true
117
115
 
118
116
  # @!attribute tax_id
119
117
  # Tax IDs are commonly required to be displayed on customer invoices, which are
@@ -222,63 +220,57 @@ module Orb
222
220
  # | Venezuela | `ve_rif` | Venezuelan RIF Number |
223
221
  # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
224
222
  #
225
- # @return [Orb::Models::CustomerUpdateParams::TaxID, nil]
226
- optional :tax_id, -> { Orb::Models::CustomerUpdateParams::TaxID }, nil?: true
223
+ # @return [Orb::CustomerUpdateParams::TaxID, nil]
224
+ optional :tax_id, -> { Orb::CustomerUpdateParams::TaxID }, nil?: true
227
225
 
228
226
  # @!method initialize(accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {})
229
227
  # Some parameter documentations has been truncated, see
230
228
  # {Orb::Models::CustomerUpdateParams} for more details.
231
229
  #
232
- # @param accounting_sync_configuration [Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration, nil]
230
+ # @param accounting_sync_configuration [Orb::CustomerUpdateParams::AccountingSyncConfiguration, nil]
233
231
  #
234
232
  # @param additional_emails [Array<String>, nil] Additional email addresses for this customer. If populated, these email addresse
235
- # ...
236
233
  #
237
234
  # @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch
238
- # ...
239
235
  #
240
- # @param billing_address [Orb::Models::CustomerUpdateParams::BillingAddress, nil]
236
+ # @param billing_address [Orb::CustomerUpdateParams::BillingAddress, nil]
241
237
  #
242
238
  # @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
243
- # ...
244
239
  #
245
240
  # @param email [String, nil] A valid customer email, to be used for invoicing and notifications.
246
241
  #
247
242
  # @param email_delivery [Boolean, nil]
248
243
  #
249
244
  # @param external_customer_id [String, nil] The external customer ID. This can only be set if empty and the customer has no
250
- # ...
251
245
  #
252
- # @param hierarchy [Orb::Models::CustomerUpdateParams::Hierarchy, nil] The hierarchical relationships for this customer.
246
+ # @param hierarchy [Orb::CustomerUpdateParams::Hierarchy, nil] The hierarchical relationships for this customer.
253
247
  #
254
248
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
255
- # ...
256
249
  #
257
250
  # @param name [String, nil] The full name of the customer
258
251
  #
259
- # @param payment_provider [Symbol, Orb::Models::CustomerUpdateParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
260
- # ...
252
+ # @param payment_provider [Symbol, Orb::CustomerUpdateParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
261
253
  #
262
254
  # @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
263
- # ...
264
255
  #
265
- # @param reporting_configuration [Orb::Models::CustomerUpdateParams::ReportingConfiguration, nil]
256
+ # @param reporting_configuration [Orb::CustomerUpdateParams::ReportingConfiguration, nil]
266
257
  #
267
- # @param shipping_address [Orb::Models::CustomerUpdateParams::ShippingAddress, nil]
258
+ # @param shipping_address [Orb::CustomerUpdateParams::ShippingAddress, nil]
268
259
  #
269
- # @param tax_configuration [Orb::Models::CustomerUpdateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateParams::TaxConfiguration::NewTaxJarConfiguration, nil]
260
+ # @param tax_configuration [Orb::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::CustomerUpdateParams::TaxConfiguration::Taxjar, nil]
270
261
  #
271
- # @param tax_id [Orb::Models::CustomerUpdateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
272
- # ...
262
+ # @param tax_id [Orb::CustomerUpdateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
273
263
  #
274
264
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
275
265
 
276
266
  class AccountingSyncConfiguration < Orb::Internal::Type::BaseModel
277
267
  # @!attribute accounting_providers
278
268
  #
279
- # @return [Array<Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration::AccountingProvider>, nil]
269
+ # @return [Array<Orb::CustomerUpdateParams::AccountingSyncConfiguration::AccountingProvider>, nil]
280
270
  optional :accounting_providers,
281
- -> { Orb::Internal::Type::ArrayOf[Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration::AccountingProvider] },
271
+ -> {
272
+ Orb::Internal::Type::ArrayOf[Orb::CustomerUpdateParams::AccountingSyncConfiguration::AccountingProvider]
273
+ },
282
274
  nil?: true
283
275
 
284
276
  # @!attribute excluded
@@ -287,7 +279,7 @@ module Orb
287
279
  optional :excluded, Orb::Internal::Type::Boolean, nil?: true
288
280
 
289
281
  # @!method initialize(accounting_providers: nil, excluded: nil)
290
- # @param accounting_providers [Array<Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration::AccountingProvider>, nil]
282
+ # @param accounting_providers [Array<Orb::CustomerUpdateParams::AccountingSyncConfiguration::AccountingProvider>, nil]
291
283
  # @param excluded [Boolean, nil]
292
284
 
293
285
  class AccountingProvider < Orb::Internal::Type::BaseModel
@@ -364,15 +356,13 @@ module Orb
364
356
 
365
357
  # @!method initialize(child_customer_ids: nil, parent_customer_id: nil)
366
358
  # Some parameter documentations has been truncated, see
367
- # {Orb::Models::CustomerUpdateParams::Hierarchy} for more details.
359
+ # {Orb::CustomerUpdateParams::Hierarchy} for more details.
368
360
  #
369
361
  # The hierarchical relationships for this customer.
370
362
  #
371
363
  # @param child_customer_ids [Array<String>] A list of child customer IDs to add to the hierarchy. The desired child customer
372
- # ...
373
364
  #
374
365
  # @param parent_customer_id [String, nil] The ID of the parent customer in the hierarchy. The desired parent customer must
375
- # ...
376
366
  end
377
367
 
378
368
  # This is used for creating charges or invoices in an external system via Orb.
@@ -450,11 +440,11 @@ module Orb
450
440
 
451
441
  discriminator :tax_provider
452
442
 
453
- variant :avalara, -> { Orb::Models::CustomerUpdateParams::TaxConfiguration::NewAvalaraTaxConfiguration }
443
+ variant :avalara, -> { Orb::CustomerUpdateParams::TaxConfiguration::Avalara }
454
444
 
455
- variant :taxjar, -> { Orb::Models::CustomerUpdateParams::TaxConfiguration::NewTaxJarConfiguration }
445
+ variant :taxjar, -> { Orb::CustomerUpdateParams::TaxConfiguration::Taxjar }
456
446
 
457
- class NewAvalaraTaxConfiguration < Orb::Internal::Type::BaseModel
447
+ class Avalara < Orb::Internal::Type::BaseModel
458
448
  # @!attribute tax_exempt
459
449
  #
460
450
  # @return [Boolean]
@@ -476,7 +466,7 @@ module Orb
476
466
  # @param tax_provider [Symbol, :avalara]
477
467
  end
478
468
 
479
- class NewTaxJarConfiguration < Orb::Internal::Type::BaseModel
469
+ class Taxjar < Orb::Internal::Type::BaseModel
480
470
  # @!attribute tax_exempt
481
471
  #
482
472
  # @return [Boolean]
@@ -493,19 +483,19 @@ module Orb
493
483
  end
494
484
 
495
485
  # @!method self.variants
496
- # @return [Array(Orb::Models::CustomerUpdateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateParams::TaxConfiguration::NewTaxJarConfiguration)]
486
+ # @return [Array(Orb::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::CustomerUpdateParams::TaxConfiguration::Taxjar)]
497
487
  end
498
488
 
499
489
  class TaxID < Orb::Internal::Type::BaseModel
500
490
  # @!attribute country
501
491
  #
502
- # @return [Symbol, Orb::Models::CustomerUpdateParams::TaxID::Country]
503
- required :country, enum: -> { Orb::Models::CustomerUpdateParams::TaxID::Country }
492
+ # @return [Symbol, Orb::CustomerUpdateParams::TaxID::Country]
493
+ required :country, enum: -> { Orb::CustomerUpdateParams::TaxID::Country }
504
494
 
505
495
  # @!attribute type
506
496
  #
507
- # @return [Symbol, Orb::Models::CustomerUpdateParams::TaxID::Type]
508
- required :type, enum: -> { Orb::Models::CustomerUpdateParams::TaxID::Type }
497
+ # @return [Symbol, Orb::CustomerUpdateParams::TaxID::Type]
498
+ required :type, enum: -> { Orb::CustomerUpdateParams::TaxID::Type }
509
499
 
510
500
  # @!attribute value
511
501
  #
@@ -619,11 +609,11 @@ module Orb
619
609
  # | Venezuela | `ve_rif` | Venezuelan RIF Number |
620
610
  # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
621
611
  #
622
- # @param country [Symbol, Orb::Models::CustomerUpdateParams::TaxID::Country]
623
- # @param type [Symbol, Orb::Models::CustomerUpdateParams::TaxID::Type]
612
+ # @param country [Symbol, Orb::CustomerUpdateParams::TaxID::Country]
613
+ # @param type [Symbol, Orb::CustomerUpdateParams::TaxID::Type]
624
614
  # @param value [String]
625
615
 
626
- # @see Orb::Models::CustomerUpdateParams::TaxID#country
616
+ # @see Orb::CustomerUpdateParams::TaxID#country
627
617
  module Country
628
618
  extend Orb::Internal::Type::Enum
629
619
 
@@ -710,7 +700,7 @@ module Orb
710
700
  # @return [Array<Symbol>]
711
701
  end
712
702
 
713
- # @see Orb::Models::CustomerUpdateParams::TaxID#type
703
+ # @see Orb::CustomerUpdateParams::TaxID#type
714
704
  module Type
715
705
  extend Orb::Internal::Type::Enum
716
706
 
@@ -15,8 +15,8 @@ module Orb
15
15
 
16
16
  # @!attribute type
17
17
  #
18
- # @return [Symbol, Orb::Models::Customers::BalanceTransactionCreateParams::Type]
19
- required :type, enum: -> { Orb::Models::Customers::BalanceTransactionCreateParams::Type }
18
+ # @return [Symbol, Orb::Customers::BalanceTransactionCreateParams::Type]
19
+ required :type, enum: -> { Orb::Customers::BalanceTransactionCreateParams::Type }
20
20
 
21
21
  # @!attribute description
22
22
  # An optional description that can be specified around this entry.
@@ -27,7 +27,7 @@ module Orb
27
27
  # @!method initialize(amount:, type:, description: nil, request_options: {})
28
28
  # @param amount [String]
29
29
  #
30
- # @param type [Symbol, Orb::Models::Customers::BalanceTransactionCreateParams::Type]
30
+ # @param type [Symbol, Orb::Customers::BalanceTransactionCreateParams::Type]
31
31
  #
32
32
  # @param description [String, nil] An optional description that can be specified around this entry.
33
33
  #
@@ -82,12 +82,10 @@ module Orb
82
82
  # @param description [String, nil] An optional description provided for manual customer balance adjustments.
83
83
  #
84
84
  # @param ending_balance [String] The new value of the customer's balance prior to the transaction, in the custome
85
- # ...
86
85
  #
87
86
  # @param invoice [Orb::Models::Customers::BalanceTransactionCreateResponse::Invoice, nil]
88
87
  #
89
88
  # @param starting_balance [String] The original value of the customer's balance prior to the transaction, in the cu
90
- # ...
91
89
  #
92
90
  # @param type [Symbol, Orb::Models::Customers::BalanceTransactionCreateResponse::Type]
93
91
 
@@ -46,7 +46,6 @@ module Orb
46
46
  # {Orb::Models::Customers::BalanceTransactionListParams} for more details.
47
47
  #
48
48
  # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
49
- # ...
50
49
  #
51
50
  # @param limit [Integer] The number of items to fetch. Defaults to 20.
52
51
  #
@@ -82,12 +82,10 @@ module Orb
82
82
  # @param description [String, nil] An optional description provided for manual customer balance adjustments.
83
83
  #
84
84
  # @param ending_balance [String] The new value of the customer's balance prior to the transaction, in the custome
85
- # ...
86
85
  #
87
86
  # @param invoice [Orb::Models::Customers::BalanceTransactionListResponse::Invoice, nil]
88
87
  #
89
88
  # @param starting_balance [String] The original value of the customer's balance prior to the transaction, in the cu
90
- # ...
91
89
  #
92
90
  # @param type [Symbol, Orb::Models::Customers::BalanceTransactionListResponse::Type]
93
91
 
@@ -32,8 +32,8 @@ module Orb
32
32
  # discounts, it's strongly recommended that you use the default cumulative
33
33
  # behavior.
34
34
  #
35
- # @return [Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode, nil]
36
- optional :view_mode, enum: -> { Orb::Models::Customers::CostListByExternalIDParams::ViewMode }, nil?: true
35
+ # @return [Symbol, Orb::Customers::CostListByExternalIDParams::ViewMode, nil]
36
+ optional :view_mode, enum: -> { Orb::Customers::CostListByExternalIDParams::ViewMode }, nil?: true
37
37
 
38
38
  # @!method initialize(currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {})
39
39
  # Some parameter documentations has been truncated, see
@@ -45,8 +45,7 @@ module Orb
45
45
  #
46
46
  # @param timeframe_start [Time, nil] Costs returned are inclusive of `timeframe_start`.
47
47
  #
48
- # @param view_mode [Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per
49
- # ...
48
+ # @param view_mode [Symbol, Orb::Customers::CostListByExternalIDParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per
50
49
  #
51
50
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
52
51
 
@@ -58,8 +58,8 @@ module Orb
58
58
  # @!attribute price
59
59
  # The price object
60
60
  #
61
- # @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice]
62
- required :price, union: -> { Orb::Models::Price }
61
+ # @return [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk]
62
+ required :price, union: -> { Orb::Price }
63
63
 
64
64
  # @!attribute price_id
65
65
  # The price the cost is associated with
@@ -86,7 +86,7 @@ module Orb
86
86
  optional :quantity, Float, nil?: true
87
87
 
88
88
  # @!method initialize(price:, price_id:, subtotal:, total:, quantity: nil)
89
- # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] The price object
89
+ # @param price [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk] The price object
90
90
  #
91
91
  # @param price_id [String] The price the cost is associated with
92
92
  #
@@ -32,8 +32,8 @@ module Orb
32
32
  # discounts, it's strongly recommended that you use the default cumulative
33
33
  # behavior.
34
34
  #
35
- # @return [Symbol, Orb::Models::Customers::CostListParams::ViewMode, nil]
36
- optional :view_mode, enum: -> { Orb::Models::Customers::CostListParams::ViewMode }, nil?: true
35
+ # @return [Symbol, Orb::Customers::CostListParams::ViewMode, nil]
36
+ optional :view_mode, enum: -> { Orb::Customers::CostListParams::ViewMode }, nil?: true
37
37
 
38
38
  # @!method initialize(currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {})
39
39
  # Some parameter documentations has been truncated, see
@@ -45,8 +45,7 @@ module Orb
45
45
  #
46
46
  # @param timeframe_start [Time, nil] Costs returned are inclusive of `timeframe_start`.
47
47
  #
48
- # @param view_mode [Symbol, Orb::Models::Customers::CostListParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per
49
- # ...
48
+ # @param view_mode [Symbol, Orb::Customers::CostListParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per
50
49
  #
51
50
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
52
51