orb-billing 0.5.2 → 0.5.4

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 (280) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +25 -0
  3. data/README.md +4 -4
  4. data/SECURITY.md +2 -2
  5. data/lib/orb/internal/util.rb +3 -1
  6. data/lib/orb/internal.rb +3 -0
  7. data/lib/orb/models/alert.rb +23 -23
  8. data/lib/orb/models/alert_create_for_customer_params.rb +5 -5
  9. data/lib/orb/models/alert_create_for_external_customer_params.rb +5 -5
  10. data/lib/orb/models/alert_create_for_subscription_params.rb +5 -5
  11. data/lib/orb/models/alert_update_params.rb +3 -3
  12. data/lib/orb/models/amount_discount.rb +5 -5
  13. data/lib/orb/models/billable_metric.rb +7 -7
  14. data/lib/orb/models/coupon.rb +6 -6
  15. data/lib/orb/models/coupon_create_params.rb +3 -3
  16. data/lib/orb/models/credit_note.rb +33 -33
  17. data/lib/orb/models/credit_note_create_params.rb +4 -4
  18. data/lib/orb/models/customer.rb +39 -39
  19. data/lib/orb/models/customer_create_params.rb +26 -26
  20. data/lib/orb/models/customer_update_by_external_id_params.rb +26 -26
  21. data/lib/orb/models/customer_update_params.rb +26 -26
  22. data/lib/orb/models/customers/balance_transaction_create_params.rb +2 -2
  23. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +2 -2
  24. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +2 -2
  25. data/lib/orb/models/customers/cost_list_params.rb +2 -2
  26. data/lib/orb/models/customers/cost_list_response.rb +2 -2
  27. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +7 -7
  28. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +8 -8
  29. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +4 -4
  30. data/lib/orb/models/customers/credits/ledger_list_params.rb +4 -4
  31. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +6 -6
  32. data/lib/orb/models/customers/credits/top_up_create_params.rb +6 -5
  33. data/lib/orb/models/dimensional_price_group.rb +1 -1
  34. data/lib/orb/models/dimensional_price_groups.rb +4 -4
  35. data/lib/orb/models/discount.rb +1 -1
  36. data/lib/orb/models/event_ingest_params.rb +3 -3
  37. data/lib/orb/models/events/event_volumes.rb +2 -2
  38. data/lib/orb/models/invoice.rb +114 -113
  39. data/lib/orb/models/invoice_create_params.rb +10 -10
  40. data/lib/orb/models/invoice_fetch_upcoming_response.rb +6 -6
  41. data/lib/orb/models/invoice_level_discount.rb +1 -1
  42. data/lib/orb/models/invoice_line_item_create_response.rb +4 -4
  43. data/lib/orb/models/invoice_list_params.rb +4 -4
  44. data/lib/orb/models/item.rb +5 -5
  45. data/lib/orb/models/item_update_params.rb +5 -5
  46. data/lib/orb/models/percentage_discount.rb +5 -5
  47. data/lib/orb/models/plan.rb +58 -58
  48. data/lib/orb/models/plan_create_params.rb +448 -444
  49. data/lib/orb/models/plan_list_params.rb +2 -2
  50. data/lib/orb/models/price.rb +1204 -1204
  51. data/lib/orb/models/price_create_params.rb +50 -50
  52. data/lib/orb/models/price_evaluate_response.rb +2 -2
  53. data/lib/orb/models/subscription.rb +58 -56
  54. data/lib/orb/models/subscription_cancel_params.rb +2 -2
  55. data/lib/orb/models/subscription_cancel_response.rb +14 -14
  56. data/lib/orb/models/subscription_change_apply_response.rb +14 -14
  57. data/lib/orb/models/subscription_change_cancel_response.rb +14 -14
  58. data/lib/orb/models/subscription_change_retrieve_response.rb +14 -14
  59. data/lib/orb/models/subscription_create_params.rb +1002 -987
  60. data/lib/orb/models/subscription_create_response.rb +14 -14
  61. data/lib/orb/models/subscription_fetch_costs_params.rb +2 -2
  62. data/lib/orb/models/subscription_fetch_costs_response.rb +2 -2
  63. data/lib/orb/models/subscription_fetch_usage_params.rb +4 -4
  64. data/lib/orb/models/subscription_list_params.rb +2 -2
  65. data/lib/orb/models/subscription_price_intervals_params.rb +596 -585
  66. data/lib/orb/models/subscription_price_intervals_response.rb +14 -14
  67. data/lib/orb/models/subscription_schedule_plan_change_params.rb +973 -971
  68. data/lib/orb/models/subscription_schedule_plan_change_response.rb +14 -14
  69. data/lib/orb/models/subscription_trigger_phase_response.rb +14 -14
  70. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +14 -14
  71. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +14 -14
  72. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +14 -14
  73. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +2 -2
  74. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +14 -14
  75. data/lib/orb/models/subscription_update_trial_params.rb +3 -3
  76. data/lib/orb/models/subscription_update_trial_response.rb +14 -14
  77. data/lib/orb/models/subscription_usage.rb +26 -26
  78. data/lib/orb/models/subscriptions.rb +4 -4
  79. data/lib/orb/models/trial_discount.rb +5 -5
  80. data/lib/orb/models/usage_discount.rb +5 -5
  81. data/lib/orb/resources/alerts.rb +15 -15
  82. data/lib/orb/resources/coupons/subscriptions.rb +1 -1
  83. data/lib/orb/resources/coupons.rb +5 -5
  84. data/lib/orb/resources/credit_notes.rb +5 -5
  85. data/lib/orb/resources/customers/balance_transactions.rb +1 -1
  86. data/lib/orb/resources/customers/costs.rb +2 -2
  87. data/lib/orb/resources/customers/credits/ledger.rb +10 -10
  88. data/lib/orb/resources/customers/credits/top_ups.rb +4 -4
  89. data/lib/orb/resources/customers.rb +30 -30
  90. data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +1 -1
  91. data/lib/orb/resources/dimensional_price_groups.rb +3 -3
  92. data/lib/orb/resources/events/volume.rb +1 -1
  93. data/lib/orb/resources/events.rb +1 -1
  94. data/lib/orb/resources/invoices.rb +12 -12
  95. data/lib/orb/resources/items.rb +5 -5
  96. data/lib/orb/resources/metrics.rb +4 -4
  97. data/lib/orb/resources/plans/external_plan_id.rb +2 -2
  98. data/lib/orb/resources/plans.rb +7 -7
  99. data/lib/orb/resources/prices/external_price_id.rb +2 -2
  100. data/lib/orb/resources/prices.rb +17 -17
  101. data/lib/orb/resources/subscriptions.rb +32 -32
  102. data/lib/orb/version.rb +1 -1
  103. data/rbi/orb/internal.rbi +3 -0
  104. data/rbi/orb/models/subscription_price_intervals_params.rbi +26 -72
  105. data/rbi/orb/models/subscription_update_trial_params.rbi +14 -3
  106. data/rbi/orb/resources/subscriptions.rbi +4 -1
  107. data/sig/orb/internal/page.rbs +2 -0
  108. data/sig/orb/internal.rbs +2 -0
  109. data/sig/orb/models/alert.rbs +32 -4
  110. data/sig/orb/models/alert_create_for_customer_params.rbs +9 -0
  111. data/sig/orb/models/alert_create_for_external_customer_params.rbs +9 -0
  112. data/sig/orb/models/alert_create_for_subscription_params.rbs +9 -0
  113. data/sig/orb/models/alert_disable_params.rbs +5 -0
  114. data/sig/orb/models/alert_enable_params.rbs +5 -0
  115. data/sig/orb/models/alert_list_params.rbs +13 -0
  116. data/sig/orb/models/alert_retrieve_params.rbs +2 -0
  117. data/sig/orb/models/alert_update_params.rbs +7 -0
  118. data/sig/orb/models/amount_discount.rbs +11 -4
  119. data/sig/orb/models/billable_metric.rbs +13 -4
  120. data/sig/orb/models/coupon.rbs +14 -4
  121. data/sig/orb/models/coupon_archive_params.rbs +2 -0
  122. data/sig/orb/models/coupon_create_params.rbs +15 -0
  123. data/sig/orb/models/coupon_fetch_params.rbs +2 -0
  124. data/sig/orb/models/coupon_list_params.rbs +8 -0
  125. data/sig/orb/models/coupons/subscription_list_params.rbs +6 -0
  126. data/sig/orb/models/credit_note.rbs +88 -20
  127. data/sig/orb/models/credit_note_create_params.rbs +9 -0
  128. data/sig/orb/models/credit_note_fetch_params.rbs +2 -0
  129. data/sig/orb/models/credit_note_list_params.rbs +10 -0
  130. data/sig/orb/models/customer.rbs +86 -16
  131. data/sig/orb/models/customer_create_params.rbs +79 -8
  132. data/sig/orb/models/customer_delete_params.rbs +2 -0
  133. data/sig/orb/models/customer_fetch_by_external_id_params.rbs +2 -0
  134. data/sig/orb/models/customer_fetch_params.rbs +2 -0
  135. data/sig/orb/models/customer_list_params.rbs +10 -0
  136. data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +2 -0
  137. data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +2 -0
  138. data/sig/orb/models/customer_update_by_external_id_params.rbs +78 -8
  139. data/sig/orb/models/customer_update_params.rbs +78 -8
  140. data/sig/orb/models/customers/balance_transaction_create_params.rbs +7 -0
  141. data/sig/orb/models/customers/balance_transaction_create_response.rbs +17 -0
  142. data/sig/orb/models/customers/balance_transaction_list_params.rbs +10 -0
  143. data/sig/orb/models/customers/balance_transaction_list_response.rbs +17 -0
  144. data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +8 -0
  145. data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +20 -0
  146. data/sig/orb/models/customers/cost_list_params.rbs +8 -0
  147. data/sig/orb/models/customers/cost_list_response.rbs +20 -0
  148. data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +8 -0
  149. data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +10 -0
  150. data/sig/orb/models/customers/credit_list_params.rbs +8 -0
  151. data/sig/orb/models/customers/credit_list_response.rbs +10 -0
  152. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +23 -0
  153. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +177 -0
  154. data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +23 -0
  155. data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +177 -0
  156. data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +14 -0
  157. data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +177 -0
  158. data/sig/orb/models/customers/credits/ledger_list_params.rbs +14 -0
  159. data/sig/orb/models/customers/credits/ledger_list_response.rbs +177 -0
  160. data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +19 -0
  161. data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +18 -0
  162. data/sig/orb/models/customers/credits/top_up_create_params.rbs +19 -0
  163. data/sig/orb/models/customers/credits/top_up_create_response.rbs +18 -0
  164. data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +5 -0
  165. data/sig/orb/models/customers/credits/top_up_delete_params.rbs +5 -0
  166. data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +6 -0
  167. data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +18 -0
  168. data/sig/orb/models/customers/credits/top_up_list_params.rbs +6 -0
  169. data/sig/orb/models/customers/credits/top_up_list_response.rbs +18 -0
  170. data/sig/orb/models/dimensional_price_group.rbs +9 -0
  171. data/sig/orb/models/dimensional_price_group_create_params.rbs +9 -0
  172. data/sig/orb/models/dimensional_price_group_list_params.rbs +6 -0
  173. data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +2 -0
  174. data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +2 -0
  175. data/sig/orb/models/dimensional_price_groups.rbs +5 -0
  176. data/sig/orb/models/evaluate_price_group.rbs +10 -4
  177. data/sig/orb/models/event_deprecate_params.rbs +2 -0
  178. data/sig/orb/models/event_deprecate_response.rbs +2 -0
  179. data/sig/orb/models/event_ingest_params.rbs +16 -0
  180. data/sig/orb/models/event_ingest_response.rbs +15 -0
  181. data/sig/orb/models/event_search_params.rbs +7 -0
  182. data/sig/orb/models/event_search_response.rbs +12 -0
  183. data/sig/orb/models/event_update_params.rbs +9 -0
  184. data/sig/orb/models/event_update_response.rbs +2 -0
  185. data/sig/orb/models/events/backfill_close_params.rbs +2 -0
  186. data/sig/orb/models/events/backfill_close_response.rbs +14 -0
  187. data/sig/orb/models/events/backfill_create_params.rbs +11 -0
  188. data/sig/orb/models/events/backfill_create_response.rbs +14 -0
  189. data/sig/orb/models/events/backfill_fetch_params.rbs +2 -0
  190. data/sig/orb/models/events/backfill_fetch_response.rbs +14 -0
  191. data/sig/orb/models/events/backfill_list_params.rbs +6 -0
  192. data/sig/orb/models/events/backfill_list_response.rbs +14 -0
  193. data/sig/orb/models/events/backfill_revert_params.rbs +2 -0
  194. data/sig/orb/models/events/backfill_revert_response.rbs +14 -0
  195. data/sig/orb/models/events/event_volumes.rbs +8 -0
  196. data/sig/orb/models/events/volume_list_params.rbs +8 -0
  197. data/sig/orb/models/invoice.rbs +293 -36
  198. data/sig/orb/models/invoice_create_params.rbs +30 -4
  199. data/sig/orb/models/invoice_fetch_params.rbs +2 -0
  200. data/sig/orb/models/invoice_fetch_upcoming_params.rbs +5 -0
  201. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +257 -0
  202. data/sig/orb/models/invoice_issue_params.rbs +5 -0
  203. data/sig/orb/models/invoice_line_item_create_params.rbs +10 -0
  204. data/sig/orb/models/invoice_line_item_create_response.rbs +132 -0
  205. data/sig/orb/models/invoice_list_params.rbs +27 -4
  206. data/sig/orb/models/invoice_mark_paid_params.rbs +7 -0
  207. data/sig/orb/models/invoice_pay_params.rbs +2 -0
  208. data/sig/orb/models/invoice_update_params.rbs +5 -0
  209. data/sig/orb/models/invoice_void_params.rbs +2 -0
  210. data/sig/orb/models/item.rbs +16 -4
  211. data/sig/orb/models/item_create_params.rbs +2 -0
  212. data/sig/orb/models/item_fetch_params.rbs +2 -0
  213. data/sig/orb/models/item_list_params.rbs +6 -0
  214. data/sig/orb/models/item_update_params.rbs +15 -4
  215. data/sig/orb/models/metric_create_params.rbs +9 -0
  216. data/sig/orb/models/metric_fetch_params.rbs +2 -0
  217. data/sig/orb/models/metric_list_params.rbs +10 -0
  218. data/sig/orb/models/metric_update_params.rbs +5 -0
  219. data/sig/orb/models/pagination_metadata.rbs +2 -0
  220. data/sig/orb/models/percentage_discount.rbs +11 -4
  221. data/sig/orb/models/plan.rbs +141 -16
  222. data/sig/orb/models/plan_create_params.rbs +1070 -304
  223. data/sig/orb/models/plan_fetch_params.rbs +2 -0
  224. data/sig/orb/models/plan_list_params.rbs +11 -0
  225. data/sig/orb/models/plan_update_params.rbs +6 -0
  226. data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +2 -0
  227. data/sig/orb/models/plans/external_plan_id_update_params.rbs +6 -0
  228. data/sig/orb/models/price.rbs +2148 -460
  229. data/sig/orb/models/price_create_params.rbs +130 -8
  230. data/sig/orb/models/price_evaluate_params.rbs +10 -0
  231. data/sig/orb/models/price_evaluate_response.rbs +2 -0
  232. data/sig/orb/models/price_fetch_params.rbs +2 -0
  233. data/sig/orb/models/price_list_params.rbs +6 -0
  234. data/sig/orb/models/price_update_params.rbs +5 -0
  235. data/sig/orb/models/prices/external_price_id_fetch_params.rbs +2 -0
  236. data/sig/orb/models/prices/external_price_id_update_params.rbs +5 -0
  237. data/sig/orb/models/subscription.rbs +177 -12
  238. data/sig/orb/models/subscription_cancel_params.rbs +7 -0
  239. data/sig/orb/models/subscription_cancel_response.rbs +173 -0
  240. data/sig/orb/models/subscription_change_apply_params.rbs +6 -0
  241. data/sig/orb/models/subscription_change_apply_response.rbs +186 -0
  242. data/sig/orb/models/subscription_change_cancel_params.rbs +2 -0
  243. data/sig/orb/models/subscription_change_cancel_response.rbs +186 -0
  244. data/sig/orb/models/subscription_change_retrieve_params.rbs +2 -0
  245. data/sig/orb/models/subscription_change_retrieve_response.rbs +186 -0
  246. data/sig/orb/models/subscription_create_params.rbs +2368 -632
  247. data/sig/orb/models/subscription_create_response.rbs +173 -0
  248. data/sig/orb/models/subscription_fetch_costs_params.rbs +8 -0
  249. data/sig/orb/models/subscription_fetch_costs_response.rbs +20 -0
  250. data/sig/orb/models/subscription_fetch_params.rbs +2 -0
  251. data/sig/orb/models/subscription_fetch_schedule_params.rbs +10 -0
  252. data/sig/orb/models/subscription_fetch_schedule_response.rbs +13 -0
  253. data/sig/orb/models/subscription_fetch_usage_params.rbs +14 -0
  254. data/sig/orb/models/subscription_list_params.rbs +13 -0
  255. data/sig/orb/models/subscription_price_intervals_params.rbs +1348 -396
  256. data/sig/orb/models/subscription_price_intervals_response.rbs +173 -0
  257. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +2363 -632
  258. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +173 -0
  259. data/sig/orb/models/subscription_trigger_phase_params.rbs +6 -0
  260. data/sig/orb/models/subscription_trigger_phase_response.rbs +173 -0
  261. data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +2 -0
  262. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +173 -0
  263. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +2 -0
  264. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +173 -0
  265. data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +2 -0
  266. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +173 -0
  267. data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +9 -0
  268. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +173 -0
  269. data/sig/orb/models/subscription_update_params.rbs +9 -0
  270. data/sig/orb/models/subscription_update_trial_params.rbs +6 -0
  271. data/sig/orb/models/subscription_update_trial_response.rbs +173 -0
  272. data/sig/orb/models/subscription_usage.rbs +48 -8
  273. data/sig/orb/models/subscriptions.rbs +5 -0
  274. data/sig/orb/models/top_level_ping_params.rbs +2 -0
  275. data/sig/orb/models/top_level_ping_response.rbs +2 -0
  276. data/sig/orb/models/trial_discount.rbs +12 -4
  277. data/sig/orb/models/usage_discount.rbs +11 -4
  278. data/sig/orb/resources/invoices.rbs +1 -1
  279. data/sig/orb/resources/plans.rbs +1 -1
  280. metadata +2 -2
@@ -8,15 +8,15 @@ module Orb
8
8
  #
9
9
  # @overload create(line_items:, memo: nil, reason: nil, request_options: {})
10
10
  #
11
- # @param line_items [Array<Orb::CreditNoteCreateParams::LineItem>]
11
+ # @param line_items [Array<Orb::Models::CreditNoteCreateParams::LineItem>]
12
12
  #
13
13
  # @param memo [String, nil] An optional memo to attach to the credit note.
14
14
  #
15
- # @param reason [Symbol, Orb::CreditNoteCreateParams::Reason, nil] An optional reason for the credit note.
15
+ # @param reason [Symbol, Orb::Models::CreditNoteCreateParams::Reason, nil] An optional reason for the credit note.
16
16
  #
17
17
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
18
18
  #
19
- # @return [Orb::CreditNote]
19
+ # @return [Orb::Models::CreditNote]
20
20
  #
21
21
  # @see Orb::Models::CreditNoteCreateParams
22
22
  def create(params)
@@ -53,7 +53,7 @@ module Orb
53
53
  #
54
54
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
55
55
  #
56
- # @return [Orb::Internal::Page<Orb::CreditNote>]
56
+ # @return [Orb::Internal::Page<Orb::Models::CreditNote>]
57
57
  #
58
58
  # @see Orb::Models::CreditNoteListParams
59
59
  def list(params = {})
@@ -81,7 +81,7 @@ module Orb
81
81
  # @param credit_note_id [String]
82
82
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
83
83
  #
84
- # @return [Orb::CreditNote]
84
+ # @return [Orb::Models::CreditNote]
85
85
  #
86
86
  # @see Orb::Models::CreditNoteFetchParams
87
87
  def fetch(credit_note_id, params = {})
@@ -13,7 +13,7 @@ module Orb
13
13
  #
14
14
  # @param amount [String]
15
15
  #
16
- # @param type [Symbol, Orb::Customers::BalanceTransactionCreateParams::Type]
16
+ # @param type [Symbol, Orb::Models::Customers::BalanceTransactionCreateParams::Type]
17
17
  #
18
18
  # @param description [String, nil] An optional description that can be specified around this entry.
19
19
  #
@@ -135,7 +135,7 @@ module Orb
135
135
  #
136
136
  # @param timeframe_start [Time, nil] Costs returned are inclusive of `timeframe_start`.
137
137
  #
138
- # @param view_mode [Symbol, Orb::Customers::CostListParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per
138
+ # @param view_mode [Symbol, Orb::Models::Customers::CostListParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per
139
139
  #
140
140
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
141
141
  #
@@ -284,7 +284,7 @@ module Orb
284
284
  #
285
285
  # @param timeframe_start [Time, nil] Costs returned are inclusive of `timeframe_start`.
286
286
  #
287
- # @param view_mode [Symbol, Orb::Customers::CostListByExternalIDParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per
287
+ # @param view_mode [Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per
288
288
  #
289
289
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
290
290
  #
@@ -106,9 +106,9 @@ module Orb
106
106
  #
107
107
  # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
108
108
  #
109
- # @param entry_status [Symbol, Orb::Customers::Credits::LedgerListParams::EntryStatus, nil]
109
+ # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryStatus, nil]
110
110
  #
111
- # @param entry_type [Symbol, Orb::Customers::Credits::LedgerListParams::EntryType, nil]
111
+ # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryType, nil]
112
112
  #
113
113
  # @param limit [Integer] The number of items to fetch. Defaults to 20.
114
114
  #
@@ -256,7 +256,7 @@ module Orb
256
256
  #
257
257
  # @param amount [Float] The number of credits to effect. Note that this is required for increment, decre
258
258
  #
259
- # @param entry_type [Symbol, Orb::Customers::Credits::LedgerCreateEntryParams::EntryType]
259
+ # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::EntryType]
260
260
  #
261
261
  # @param expiry_date [Time, nil] An ISO 8601 format date that identifies the origination credit block to expire
262
262
  #
@@ -270,13 +270,13 @@ module Orb
270
270
  #
271
271
  # @param effective_date [Time, nil] An ISO 8601 format date that denotes when this credit balance should become avai
272
272
  #
273
- # @param invoice_settings [Orb::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings, nil] Passing `invoice_settings` automatically generates an invoice for the newly adde
273
+ # @param invoice_settings [Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings, nil] Passing `invoice_settings` automatically generates an invoice for the newly adde
274
274
  #
275
275
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
276
276
  #
277
277
  # @param per_unit_cost_basis [String, nil] Can only be specified when entry_type=increment. How much, in the customer's cur
278
278
  #
279
- # @param void_reason [Symbol, Orb::Customers::Credits::LedgerCreateEntryParams::VoidReason, nil] Can only be specified when `entry_type=void`. The reason for the void.
279
+ # @param void_reason [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::VoidReason, nil] Can only be specified when `entry_type=void`. The reason for the void.
280
280
  #
281
281
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
282
282
  #
@@ -415,7 +415,7 @@ module Orb
415
415
  #
416
416
  # @param amount [Float] The number of credits to effect. Note that this is required for increment, decre
417
417
  #
418
- # @param entry_type [Symbol, Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType]
418
+ # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType]
419
419
  #
420
420
  # @param expiry_date [Time, nil] An ISO 8601 format date that identifies the origination credit block to expire
421
421
  #
@@ -429,13 +429,13 @@ module Orb
429
429
  #
430
430
  # @param effective_date [Time, nil] An ISO 8601 format date that denotes when this credit balance should become avai
431
431
  #
432
- # @param invoice_settings [Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings, nil] Passing `invoice_settings` automatically generates an invoice for the newly adde
432
+ # @param invoice_settings [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings, nil] Passing `invoice_settings` automatically generates an invoice for the newly adde
433
433
  #
434
434
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
435
435
  #
436
436
  # @param per_unit_cost_basis [String, nil] Can only be specified when entry_type=increment. How much, in the customer's cur
437
437
  #
438
- # @param void_reason [Symbol, Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason, nil] Can only be specified when `entry_type=void`. The reason for the void.
438
+ # @param void_reason [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason, nil] Can only be specified when `entry_type=void`. The reason for the void.
439
439
  #
440
440
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
441
441
  #
@@ -555,9 +555,9 @@ module Orb
555
555
  #
556
556
  # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
557
557
  #
558
- # @param entry_status [Symbol, Orb::Customers::Credits::LedgerListByExternalIDParams::EntryStatus, nil]
558
+ # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryStatus, nil]
559
559
  #
560
- # @param entry_type [Symbol, Orb::Customers::Credits::LedgerListByExternalIDParams::EntryType, nil]
560
+ # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryType, nil]
561
561
  #
562
562
  # @param limit [Integer] The number of items to fetch. Defaults to 20.
563
563
  #
@@ -24,7 +24,7 @@ module Orb
24
24
  #
25
25
  # @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo
26
26
  #
27
- # @param invoice_settings [Orb::Customers::Credits::TopUpCreateParams::InvoiceSettings] Settings for invoices generated by triggered top-ups.
27
+ # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateParams::InvoiceSettings] Settings for invoices generated by triggered top-ups.
28
28
  #
29
29
  # @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit.
30
30
  #
@@ -34,7 +34,7 @@ module Orb
34
34
  #
35
35
  # @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it
36
36
  #
37
- # @param expires_after_unit [Symbol, Orb::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit, nil] The unit of expires_after.
37
+ # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit, nil] The unit of expires_after.
38
38
  #
39
39
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
40
40
  #
@@ -128,7 +128,7 @@ module Orb
128
128
  #
129
129
  # @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo
130
130
  #
131
- # @param invoice_settings [Orb::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings] Settings for invoices generated by triggered top-ups.
131
+ # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings] Settings for invoices generated by triggered top-ups.
132
132
  #
133
133
  # @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit.
134
134
  #
@@ -138,7 +138,7 @@ module Orb
138
138
  #
139
139
  # @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it
140
140
  #
141
- # @param expires_after_unit [Symbol, Orb::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit, nil] The unit of expires_after.
141
+ # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit, nil] The unit of expires_after.
142
142
  #
143
143
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
144
144
  #
@@ -34,13 +34,13 @@ module Orb
34
34
  #
35
35
  # @param name [String] The full name of the customer
36
36
  #
37
- # @param accounting_sync_configuration [Orb::CustomerCreateParams::AccountingSyncConfiguration, nil]
37
+ # @param accounting_sync_configuration [Orb::Models::CustomerCreateParams::AccountingSyncConfiguration, nil]
38
38
  #
39
39
  # @param additional_emails [Array<String>, nil] Additional email addresses for this customer. If populated, these email addresse
40
40
  #
41
41
  # @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch
42
42
  #
43
- # @param billing_address [Orb::CustomerCreateParams::BillingAddress, nil]
43
+ # @param billing_address [Orb::Models::CustomerCreateParams::BillingAddress, nil]
44
44
  #
45
45
  # @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
46
46
  #
@@ -48,27 +48,27 @@ module Orb
48
48
  #
49
49
  # @param external_customer_id [String, nil] An optional user-defined ID for this customer resource, used throughout the syst
50
50
  #
51
- # @param hierarchy [Orb::CustomerCreateParams::Hierarchy, nil] The hierarchical relationships for this customer.
51
+ # @param hierarchy [Orb::Models::CustomerCreateParams::Hierarchy, nil] The hierarchical relationships for this customer.
52
52
  #
53
53
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
54
54
  #
55
- # @param payment_provider [Symbol, Orb::CustomerCreateParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
55
+ # @param payment_provider [Symbol, Orb::Models::CustomerCreateParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
56
56
  #
57
57
  # @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
58
58
  #
59
- # @param reporting_configuration [Orb::CustomerCreateParams::ReportingConfiguration, nil]
59
+ # @param reporting_configuration [Orb::Models::CustomerCreateParams::ReportingConfiguration, nil]
60
60
  #
61
- # @param shipping_address [Orb::CustomerCreateParams::ShippingAddress, nil]
61
+ # @param shipping_address [Orb::Models::CustomerCreateParams::ShippingAddress, nil]
62
62
  #
63
- # @param tax_configuration [Orb::CustomerCreateParams::TaxConfiguration::Avalara, Orb::CustomerCreateParams::TaxConfiguration::Taxjar, nil]
63
+ # @param tax_configuration [Orb::Models::CustomerCreateParams::TaxConfiguration::Avalara, Orb::Models::CustomerCreateParams::TaxConfiguration::Taxjar, nil]
64
64
  #
65
- # @param tax_id [Orb::CustomerCreateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
65
+ # @param tax_id [Orb::Models::CustomerCreateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
66
66
  #
67
67
  # @param timezone [String, nil] A timezone identifier from the IANA timezone database, such as `"America/Los_Ang
68
68
  #
69
69
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
70
70
  #
71
- # @return [Orb::Customer]
71
+ # @return [Orb::Models::Customer]
72
72
  #
73
73
  # @see Orb::Models::CustomerCreateParams
74
74
  def create(params)
@@ -95,13 +95,13 @@ module Orb
95
95
  #
96
96
  # @param customer_id [String]
97
97
  #
98
- # @param accounting_sync_configuration [Orb::CustomerUpdateParams::AccountingSyncConfiguration, nil]
98
+ # @param accounting_sync_configuration [Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration, nil]
99
99
  #
100
100
  # @param additional_emails [Array<String>, nil] Additional email addresses for this customer. If populated, these email addresse
101
101
  #
102
102
  # @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch
103
103
  #
104
- # @param billing_address [Orb::CustomerUpdateParams::BillingAddress, nil]
104
+ # @param billing_address [Orb::Models::CustomerUpdateParams::BillingAddress, nil]
105
105
  #
106
106
  # @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
107
107
  #
@@ -111,27 +111,27 @@ module Orb
111
111
  #
112
112
  # @param external_customer_id [String, nil] The external customer ID. This can only be set if empty and the customer has no
113
113
  #
114
- # @param hierarchy [Orb::CustomerUpdateParams::Hierarchy, nil] The hierarchical relationships for this customer.
114
+ # @param hierarchy [Orb::Models::CustomerUpdateParams::Hierarchy, nil] The hierarchical relationships for this customer.
115
115
  #
116
116
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
117
117
  #
118
118
  # @param name [String, nil] The full name of the customer
119
119
  #
120
- # @param payment_provider [Symbol, Orb::CustomerUpdateParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
120
+ # @param payment_provider [Symbol, Orb::Models::CustomerUpdateParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
121
121
  #
122
122
  # @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
123
123
  #
124
- # @param reporting_configuration [Orb::CustomerUpdateParams::ReportingConfiguration, nil]
124
+ # @param reporting_configuration [Orb::Models::CustomerUpdateParams::ReportingConfiguration, nil]
125
125
  #
126
- # @param shipping_address [Orb::CustomerUpdateParams::ShippingAddress, nil]
126
+ # @param shipping_address [Orb::Models::CustomerUpdateParams::ShippingAddress, nil]
127
127
  #
128
- # @param tax_configuration [Orb::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::CustomerUpdateParams::TaxConfiguration::Taxjar, nil]
128
+ # @param tax_configuration [Orb::Models::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateParams::TaxConfiguration::Taxjar, nil]
129
129
  #
130
- # @param tax_id [Orb::CustomerUpdateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
130
+ # @param tax_id [Orb::Models::CustomerUpdateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
131
131
  #
132
132
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
133
133
  #
134
- # @return [Orb::Customer]
134
+ # @return [Orb::Models::Customer]
135
135
  #
136
136
  # @see Orb::Models::CustomerUpdateParams
137
137
  def update(customer_id, params = {})
@@ -171,7 +171,7 @@ module Orb
171
171
  #
172
172
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
173
173
  #
174
- # @return [Orb::Internal::Page<Orb::Customer>]
174
+ # @return [Orb::Internal::Page<Orb::Models::Customer>]
175
175
  #
176
176
  # @see Orb::Models::CustomerListParams
177
177
  def list(params = {})
@@ -236,7 +236,7 @@ module Orb
236
236
  # @param customer_id [String]
237
237
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
238
238
  #
239
- # @return [Orb::Customer]
239
+ # @return [Orb::Models::Customer]
240
240
  #
241
241
  # @see Orb::Models::CustomerFetchParams
242
242
  def fetch(customer_id, params = {})
@@ -259,7 +259,7 @@ module Orb
259
259
  # @param external_customer_id [String]
260
260
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
261
261
  #
262
- # @return [Orb::Customer]
262
+ # @return [Orb::Models::Customer]
263
263
  #
264
264
  # @see Orb::Models::CustomerFetchByExternalIDParams
265
265
  def fetch_by_external_id(external_customer_id, params = {})
@@ -334,13 +334,13 @@ module Orb
334
334
  #
335
335
  # @param id [String]
336
336
  #
337
- # @param accounting_sync_configuration [Orb::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration, nil]
337
+ # @param accounting_sync_configuration [Orb::Models::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration, nil]
338
338
  #
339
339
  # @param additional_emails [Array<String>, nil] Additional email addresses for this customer. If populated, these email addresse
340
340
  #
341
341
  # @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch
342
342
  #
343
- # @param billing_address [Orb::CustomerUpdateByExternalIDParams::BillingAddress, nil]
343
+ # @param billing_address [Orb::Models::CustomerUpdateByExternalIDParams::BillingAddress, nil]
344
344
  #
345
345
  # @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
346
346
  #
@@ -350,27 +350,27 @@ module Orb
350
350
  #
351
351
  # @param external_customer_id [String, nil] The external customer ID. This can only be set if empty and the customer has no
352
352
  #
353
- # @param hierarchy [Orb::CustomerUpdateByExternalIDParams::Hierarchy, nil] The hierarchical relationships for this customer.
353
+ # @param hierarchy [Orb::Models::CustomerUpdateByExternalIDParams::Hierarchy, nil] The hierarchical relationships for this customer.
354
354
  #
355
355
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
356
356
  #
357
357
  # @param name [String, nil] The full name of the customer
358
358
  #
359
- # @param payment_provider [Symbol, Orb::CustomerUpdateByExternalIDParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
359
+ # @param payment_provider [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
360
360
  #
361
361
  # @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
362
362
  #
363
- # @param reporting_configuration [Orb::CustomerUpdateByExternalIDParams::ReportingConfiguration, nil]
363
+ # @param reporting_configuration [Orb::Models::CustomerUpdateByExternalIDParams::ReportingConfiguration, nil]
364
364
  #
365
- # @param shipping_address [Orb::CustomerUpdateByExternalIDParams::ShippingAddress, nil]
365
+ # @param shipping_address [Orb::Models::CustomerUpdateByExternalIDParams::ShippingAddress, nil]
366
366
  #
367
- # @param tax_configuration [Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar, nil]
367
+ # @param tax_configuration [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar, nil]
368
368
  #
369
- # @param tax_id [Orb::CustomerUpdateByExternalIDParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
369
+ # @param tax_id [Orb::Models::CustomerUpdateByExternalIDParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
370
370
  #
371
371
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
372
372
  #
373
- # @return [Orb::Customer]
373
+ # @return [Orb::Models::Customer]
374
374
  #
375
375
  # @see Orb::Models::CustomerUpdateByExternalIDParams
376
376
  def update_by_external_id(id, params = {})
@@ -11,7 +11,7 @@ module Orb
11
11
  # @param external_dimensional_price_group_id [String]
12
12
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
13
13
  #
14
- # @return [Orb::DimensionalPriceGroup]
14
+ # @return [Orb::Models::DimensionalPriceGroup]
15
15
  #
16
16
  # @see Orb::Models::DimensionalPriceGroups::ExternalDimensionalPriceGroupIDRetrieveParams
17
17
  def retrieve(external_dimensional_price_group_id, params = {})
@@ -32,7 +32,7 @@ module Orb
32
32
  #
33
33
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
34
34
  #
35
- # @return [Orb::DimensionalPriceGroup]
35
+ # @return [Orb::Models::DimensionalPriceGroup]
36
36
  #
37
37
  # @see Orb::Models::DimensionalPriceGroupCreateParams
38
38
  def create(params)
@@ -53,7 +53,7 @@ module Orb
53
53
  # @param dimensional_price_group_id [String]
54
54
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
55
55
  #
56
- # @return [Orb::DimensionalPriceGroup]
56
+ # @return [Orb::Models::DimensionalPriceGroup]
57
57
  #
58
58
  # @see Orb::Models::DimensionalPriceGroupRetrieveParams
59
59
  def retrieve(dimensional_price_group_id, params = {})
@@ -78,7 +78,7 @@ module Orb
78
78
  #
79
79
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
80
80
  #
81
- # @return [Orb::Internal::Page<Orb::DimensionalPriceGroup>]
81
+ # @return [Orb::Internal::Page<Orb::Models::DimensionalPriceGroup>]
82
82
  #
83
83
  # @see Orb::Models::DimensionalPriceGroupListParams
84
84
  def list(params = {})
@@ -33,7 +33,7 @@ module Orb
33
33
  #
34
34
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
35
35
  #
36
- # @return [Orb::Events::EventVolumes]
36
+ # @return [Orb::Models::Events::EventVolumes]
37
37
  #
38
38
  # @see Orb::Models::Events::VolumeListParams
39
39
  def list(params)
@@ -356,7 +356,7 @@ module Orb
356
356
  #
357
357
  # @overload ingest(events:, backfill_id: nil, debug: nil, request_options: {})
358
358
  #
359
- # @param events [Array<Orb::EventIngestParams::Event>] Body param:
359
+ # @param events [Array<Orb::Models::EventIngestParams::Event>] Body param:
360
360
  #
361
361
  # @param backfill_id [String, nil] Query param: If this ingestion request is part of a backfill, this parameter tie
362
362
  #
@@ -14,13 +14,13 @@ module Orb
14
14
  #
15
15
  # @param invoice_date [Time] Optional invoice date to set. Must be in the past, if not set, `invoice_date` is
16
16
  #
17
- # @param line_items [Array<Orb::InvoiceCreateParams::LineItem>]
17
+ # @param line_items [Array<Orb::Models::InvoiceCreateParams::LineItem>]
18
18
  #
19
19
  # @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
20
20
  #
21
21
  # @param customer_id [String, nil] The id of the `Customer` to create this invoice for. One of `customer_id` and `e
22
22
  #
23
- # @param discount [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil] An optional discount to attach to the invoice.
23
+ # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] An optional discount to attach to the invoice.
24
24
  #
25
25
  # @param external_customer_id [String, nil] The `external_customer_id` of the `Customer` to create this invoice for. One of
26
26
  #
@@ -32,7 +32,7 @@ module Orb
32
32
  #
33
33
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
34
34
  #
35
- # @return [Orb::Invoice]
35
+ # @return [Orb::Models::Invoice]
36
36
  #
37
37
  # @see Orb::Models::InvoiceCreateParams
38
38
  def create(params)
@@ -57,7 +57,7 @@ module Orb
57
57
  #
58
58
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
59
59
  #
60
- # @return [Orb::Invoice]
60
+ # @return [Orb::Models::Invoice]
61
61
  #
62
62
  # @see Orb::Models::InvoiceUpdateParams
63
63
  def update(invoice_id, params = {})
@@ -100,7 +100,7 @@ module Orb
100
100
  #
101
101
  # @param customer_id [String, nil]
102
102
  #
103
- # @param date_type [Symbol, Orb::InvoiceListParams::DateType, nil]
103
+ # @param date_type [Symbol, Orb::Models::InvoiceListParams::DateType, nil]
104
104
  #
105
105
  # @param due_date [Date, nil]
106
106
  #
@@ -124,13 +124,13 @@ module Orb
124
124
  #
125
125
  # @param limit [Integer] The number of items to fetch. Defaults to 20.
126
126
  #
127
- # @param status [Array<Symbol, Orb::InvoiceListParams::Status>, nil]
127
+ # @param status [Array<Symbol, Orb::Models::InvoiceListParams::Status>, nil]
128
128
  #
129
129
  # @param subscription_id [String, nil]
130
130
  #
131
131
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
132
132
  #
133
- # @return [Orb::Internal::Page<Orb::Invoice>]
133
+ # @return [Orb::Internal::Page<Orb::Models::Invoice>]
134
134
  #
135
135
  # @see Orb::Models::InvoiceListParams
136
136
  def list(params = {})
@@ -162,7 +162,7 @@ module Orb
162
162
  # @param invoice_id [String]
163
163
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
164
164
  #
165
- # @return [Orb::Invoice]
165
+ # @return [Orb::Models::Invoice]
166
166
  #
167
167
  # @see Orb::Models::InvoiceFetchParams
168
168
  def fetch(invoice_id, params = {})
@@ -215,7 +215,7 @@ module Orb
215
215
  #
216
216
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
217
217
  #
218
- # @return [Orb::Invoice]
218
+ # @return [Orb::Models::Invoice]
219
219
  #
220
220
  # @see Orb::Models::InvoiceIssueParams
221
221
  def issue(invoice_id, params = {})
@@ -244,7 +244,7 @@ module Orb
244
244
  #
245
245
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
246
246
  #
247
- # @return [Orb::Invoice]
247
+ # @return [Orb::Models::Invoice]
248
248
  #
249
249
  # @see Orb::Models::InvoiceMarkPaidParams
250
250
  def mark_paid(invoice_id, params)
@@ -266,7 +266,7 @@ module Orb
266
266
  # @param invoice_id [String]
267
267
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
268
268
  #
269
- # @return [Orb::Invoice]
269
+ # @return [Orb::Models::Invoice]
270
270
  #
271
271
  # @see Orb::Models::InvoicePayParams
272
272
  def pay(invoice_id, params = {})
@@ -295,7 +295,7 @@ module Orb
295
295
  # @param invoice_id [String]
296
296
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
297
297
  #
298
- # @return [Orb::Invoice]
298
+ # @return [Orb::Models::Invoice]
299
299
  #
300
300
  # @see Orb::Models::InvoiceVoidParams
301
301
  def void(invoice_id, params = {})
@@ -11,7 +11,7 @@ module Orb
11
11
  #
12
12
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
13
13
  #
14
- # @return [Orb::Item]
14
+ # @return [Orb::Models::Item]
15
15
  #
16
16
  # @see Orb::Models::ItemCreateParams
17
17
  def create(params)
@@ -24,11 +24,11 @@ module Orb
24
24
  # @overload update(item_id, external_connections: nil, name: nil, request_options: {})
25
25
  #
26
26
  # @param item_id [String]
27
- # @param external_connections [Array<Orb::ItemUpdateParams::ExternalConnection>, nil]
27
+ # @param external_connections [Array<Orb::Models::ItemUpdateParams::ExternalConnection>, nil]
28
28
  # @param name [String, nil]
29
29
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
30
30
  #
31
- # @return [Orb::Item]
31
+ # @return [Orb::Models::Item]
32
32
  #
33
33
  # @see Orb::Models::ItemUpdateParams
34
34
  def update(item_id, params = {})
@@ -56,7 +56,7 @@ module Orb
56
56
  #
57
57
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
58
58
  #
59
- # @return [Orb::Internal::Page<Orb::Item>]
59
+ # @return [Orb::Internal::Page<Orb::Models::Item>]
60
60
  #
61
61
  # @see Orb::Models::ItemListParams
62
62
  def list(params = {})
@@ -78,7 +78,7 @@ module Orb
78
78
  # @param item_id [String]
79
79
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
80
80
  #
81
- # @return [Orb::Item]
81
+ # @return [Orb::Models::Item]
82
82
  #
83
83
  # @see Orb::Models::ItemFetchParams
84
84
  def fetch(item_id, params = {})
@@ -24,7 +24,7 @@ module Orb
24
24
  #
25
25
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
26
26
  #
27
- # @return [Orb::BillableMetric]
27
+ # @return [Orb::Models::BillableMetric]
28
28
  #
29
29
  # @see Orb::Models::MetricCreateParams
30
30
  def create(params)
@@ -53,7 +53,7 @@ module Orb
53
53
  #
54
54
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
55
55
  #
56
- # @return [Orb::BillableMetric]
56
+ # @return [Orb::Models::BillableMetric]
57
57
  #
58
58
  # @see Orb::Models::MetricUpdateParams
59
59
  def update(metric_id, params = {})
@@ -90,7 +90,7 @@ module Orb
90
90
  #
91
91
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
92
92
  #
93
- # @return [Orb::Internal::Page<Orb::BillableMetric>]
93
+ # @return [Orb::Internal::Page<Orb::Models::BillableMetric>]
94
94
  #
95
95
  # @see Orb::Models::MetricListParams
96
96
  def list(params = {})
@@ -118,7 +118,7 @@ module Orb
118
118
  # @param metric_id [String]
119
119
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
120
120
  #
121
- # @return [Orb::BillableMetric]
121
+ # @return [Orb::Models::BillableMetric]
122
122
  #
123
123
  # @see Orb::Models::MetricFetchParams
124
124
  def fetch(metric_id, params = {})
@@ -22,7 +22,7 @@ module Orb
22
22
  #
23
23
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
24
24
  #
25
- # @return [Orb::Plan]
25
+ # @return [Orb::Models::Plan]
26
26
  #
27
27
  # @see Orb::Models::Plans::ExternalPlanIDUpdateParams
28
28
  def update(other_external_plan_id, params = {})
@@ -58,7 +58,7 @@ module Orb
58
58
  # @param external_plan_id [String]
59
59
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
60
60
  #
61
- # @return [Orb::Plan]
61
+ # @return [Orb::Models::Plan]
62
62
  #
63
63
  # @see Orb::Models::Plans::ExternalPlanIDFetchParams
64
64
  def fetch(external_plan_id, params = {})