orb-billing 0.3.0 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (310) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +33 -0
  3. data/README.md +5 -5
  4. data/lib/orb/errors.rb +9 -9
  5. data/lib/orb/internal/page.rb +3 -3
  6. data/lib/orb/internal/transport/base_client.rb +3 -3
  7. data/lib/orb/internal/type/base_model.rb +1 -9
  8. data/lib/orb/internal/type/boolean.rb +10 -11
  9. data/lib/orb/internal/type/enum.rb +10 -11
  10. data/lib/orb/internal/type/request_parameters.rb +2 -8
  11. data/lib/orb/internal/type/unknown.rb +10 -11
  12. data/lib/orb/internal/util.rb +20 -4
  13. data/lib/orb/models/coupon_create_params.rb +7 -7
  14. data/lib/orb/models/customer_create_params.rb +7 -7
  15. data/lib/orb/models/customer_update_by_external_id_params.rb +7 -9
  16. data/lib/orb/models/customer_update_params.rb +7 -7
  17. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +2 -2
  18. data/lib/orb/models/customers/cost_list_response.rb +2 -2
  19. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +106 -107
  20. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +111 -119
  21. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +110 -114
  22. data/lib/orb/models/customers/credits/ledger_list_response.rb +112 -124
  23. data/lib/orb/models/invoice.rb +50 -64
  24. data/lib/orb/models/invoice_fetch_upcoming_response.rb +51 -55
  25. data/lib/orb/models/invoice_line_item_create_response.rb +54 -57
  26. data/lib/orb/models/plan.rb +20 -23
  27. data/lib/orb/models/plan_create_params.rb +635 -670
  28. data/lib/orb/models/price.rb +1547 -1599
  29. data/lib/orb/models/subscription.rb +35 -41
  30. data/lib/orb/models/subscription_cancel_response.rb +33 -36
  31. data/lib/orb/models/subscription_change_apply_response.rb +31 -32
  32. data/lib/orb/models/subscription_change_cancel_response.rb +31 -31
  33. data/lib/orb/models/subscription_change_retrieve_response.rb +31 -31
  34. data/lib/orb/models/subscription_create_params.rb +1316 -1367
  35. data/lib/orb/models/subscription_create_response.rb +33 -36
  36. data/lib/orb/models/subscription_fetch_costs_response.rb +2 -2
  37. data/lib/orb/models/subscription_price_intervals_params.rb +748 -774
  38. data/lib/orb/models/subscription_price_intervals_response.rb +32 -35
  39. data/lib/orb/models/subscription_schedule_plan_change_params.rb +1299 -1354
  40. data/lib/orb/models/subscription_schedule_plan_change_response.rb +31 -33
  41. data/lib/orb/models/subscription_trigger_phase_response.rb +32 -35
  42. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +31 -33
  43. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +31 -31
  44. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +31 -31
  45. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +31 -33
  46. data/lib/orb/models/subscription_update_trial_response.rb +33 -36
  47. data/lib/orb/models.rb +220 -0
  48. data/lib/orb/request_options.rb +4 -5
  49. data/lib/orb/resources/coupons.rb +1 -1
  50. data/lib/orb/resources/customers/credits/ledger.rb +4 -4
  51. data/lib/orb/resources/customers.rb +3 -3
  52. data/lib/orb/resources/plans.rb +1 -1
  53. data/lib/orb/resources/prices/external_price_id.rb +2 -2
  54. data/lib/orb/resources/prices.rb +4 -4
  55. data/lib/orb/version.rb +1 -1
  56. data/rbi/{lib/orb → orb}/errors.rbi +1 -1
  57. data/rbi/{lib/orb → orb}/internal/transport/base_client.rbi +2 -2
  58. data/rbi/{lib/orb → orb}/internal/type/request_parameters.rbi +1 -1
  59. data/rbi/{lib/orb → orb}/internal/util.rbi +5 -1
  60. data/rbi/{lib/orb → orb}/models/coupon_create_params.rbi +9 -9
  61. data/rbi/{lib/orb → orb}/models/customer_create_params.rbi +9 -9
  62. data/rbi/{lib/orb → orb}/models/customer_update_by_external_id_params.rbi +9 -9
  63. data/rbi/{lib/orb → orb}/models/customer_update_params.rbi +9 -9
  64. data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_response.rbi +84 -84
  65. data/rbi/{lib/orb → orb}/models/customers/cost_list_response.rbi +84 -84
  66. data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_response.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi} +122 -114
  67. data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi → orb/models/customers/credits/ledger_create_entry_response.rbi} +114 -216
  68. data/rbi/{lib/orb/models/customers/credits/ledger_list_response.rbi → orb/models/customers/credits/ledger_list_by_external_id_response.rbi} +114 -114
  69. data/rbi/{lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi → orb/models/customers/credits/ledger_list_response.rbi} +114 -271
  70. data/rbi/{lib/orb → orb}/models/invoice.rbi +138 -156
  71. data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_response.rbi +138 -150
  72. data/rbi/{lib/orb → orb}/models/invoice_line_item_create_response.rbi +138 -162
  73. data/rbi/{lib/orb → orb}/models/plan.rbi +105 -105
  74. data/rbi/{lib/orb → orb}/models/plan_create_params.rbi +973 -1734
  75. data/rbi/{lib/orb → orb}/models/price.rbi +1875 -2267
  76. data/rbi/{lib/orb → orb}/models/subscription.rbi +118 -118
  77. data/rbi/{lib/orb → orb}/models/subscription_cancel_response.rbi +118 -118
  78. data/rbi/{lib/orb → orb}/models/subscription_change_apply_response.rbi +118 -118
  79. data/rbi/{lib/orb → orb}/models/subscription_change_cancel_response.rbi +118 -118
  80. data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_response.rbi +118 -118
  81. data/rbi/{lib/orb → orb}/models/subscription_create_params.rbi +1988 -2733
  82. data/rbi/{lib/orb → orb}/models/subscription_create_response.rbi +118 -118
  83. data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_response.rbi +84 -84
  84. data/rbi/{lib/orb → orb}/models/subscription_price_intervals_params.rbi +1125 -1455
  85. data/rbi/{lib/orb → orb}/models/subscription_price_intervals_response.rbi +118 -118
  86. data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_params.rbi +1988 -2210
  87. data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_response.rbi +118 -118
  88. data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_response.rbi +118 -118
  89. data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_response.rbi +118 -118
  90. data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +118 -118
  91. data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_response.rbi +118 -118
  92. data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_response.rbi +118 -118
  93. data/rbi/{lib/orb → orb}/models/subscription_update_trial_response.rbi +118 -118
  94. data/rbi/orb/models.rbi +220 -0
  95. data/rbi/{lib/orb → orb}/request_options.rbi +2 -0
  96. data/rbi/{lib/orb → orb}/resources/alerts.rbi +8 -14
  97. data/rbi/{lib/orb → orb}/resources/coupons/subscriptions.rbi +1 -1
  98. data/rbi/{lib/orb → orb}/resources/coupons.rbi +6 -18
  99. data/rbi/{lib/orb → orb}/resources/credit_notes.rbi +3 -9
  100. data/rbi/{lib/orb → orb}/resources/customers/balance_transactions.rbi +2 -2
  101. data/rbi/{lib/orb → orb}/resources/customers/costs.rbi +2 -2
  102. data/rbi/{lib/orb → orb}/resources/customers/credits/ledger.rbi +32 -32
  103. data/rbi/{lib/orb → orb}/resources/customers/credits/top_ups.rbi +6 -18
  104. data/rbi/{lib/orb → orb}/resources/customers/credits.rbi +2 -2
  105. data/rbi/{lib/orb → orb}/resources/customers.rbi +15 -45
  106. data/rbi/{lib/orb → orb}/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +1 -4
  107. data/rbi/{lib/orb → orb}/resources/dimensional_price_groups.rbi +3 -10
  108. data/rbi/{lib/orb → orb}/resources/events/backfills.rbi +5 -18
  109. data/rbi/{lib/orb → orb}/resources/events/volume.rbi +1 -1
  110. data/rbi/{lib/orb → orb}/resources/events.rbi +4 -10
  111. data/rbi/{lib/orb → orb}/resources/invoice_line_items.rbi +1 -1
  112. data/rbi/{lib/orb → orb}/resources/invoices.rbi +9 -34
  113. data/rbi/{lib/orb → orb}/resources/items.rbi +4 -17
  114. data/rbi/{lib/orb → orb}/resources/metrics.rbi +4 -10
  115. data/rbi/{lib/orb → orb}/resources/plans/external_plan_id.rbi +2 -8
  116. data/rbi/{lib/orb → orb}/resources/plans.rbi +29 -35
  117. data/rbi/orb/resources/prices/external_price_id.rbi +103 -0
  118. data/rbi/{lib/orb → orb}/resources/prices.rbi +117 -124
  119. data/rbi/{lib/orb → orb}/resources/subscription_changes.rbi +3 -9
  120. data/rbi/{lib/orb → orb}/resources/subscriptions.rbi +16 -32
  121. data/rbi/{lib/orb → orb}/resources/top_level.rbi +1 -4
  122. data/sig/orb/internal/util.rbs +2 -0
  123. data/sig/orb/models/coupon_create_params.rbs +9 -10
  124. data/sig/orb/models/customer_create_params.rbs +9 -10
  125. data/sig/orb/models/customer_update_by_external_id_params.rbs +9 -10
  126. data/sig/orb/models/customer_update_params.rbs +9 -10
  127. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +113 -113
  128. data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +113 -113
  129. data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +113 -113
  130. data/sig/orb/models/customers/credits/ledger_list_response.rbs +113 -113
  131. data/sig/orb/models/invoice.rbs +54 -54
  132. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +54 -54
  133. data/sig/orb/models/invoice_line_item_create_response.rbs +54 -54
  134. data/sig/orb/models/plan.rbs +21 -21
  135. data/sig/orb/models/plan_create_params.rbs +653 -653
  136. data/sig/orb/models/price.rbs +1517 -1521
  137. data/sig/orb/models/subscription.rbs +34 -34
  138. data/sig/orb/models/subscription_cancel_response.rbs +34 -34
  139. data/sig/orb/models/subscription_change_apply_response.rbs +34 -34
  140. data/sig/orb/models/subscription_change_cancel_response.rbs +34 -34
  141. data/sig/orb/models/subscription_change_retrieve_response.rbs +34 -34
  142. data/sig/orb/models/subscription_create_params.rbs +1348 -1348
  143. data/sig/orb/models/subscription_create_response.rbs +34 -34
  144. data/sig/orb/models/subscription_price_intervals_params.rbs +767 -769
  145. data/sig/orb/models/subscription_price_intervals_response.rbs +34 -34
  146. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1348 -1348
  147. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +34 -34
  148. data/sig/orb/models/subscription_trigger_phase_response.rbs +34 -34
  149. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +34 -34
  150. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +34 -34
  151. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +34 -34
  152. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +34 -34
  153. data/sig/orb/models/subscription_update_trial_response.rbs +34 -34
  154. data/sig/orb/models.rbs +215 -0
  155. metadata +226 -223
  156. data/rbi/lib/orb/resources/prices/external_price_id.rbi +0 -106
  157. data/rbi/{lib/orb → orb}/client.rbi +0 -0
  158. data/rbi/{lib/orb → orb}/file_part.rbi +0 -0
  159. data/rbi/{lib/orb → orb}/internal/page.rbi +0 -0
  160. data/rbi/{lib/orb → orb}/internal/transport/pooled_net_requester.rbi +0 -0
  161. data/rbi/{lib/orb → orb}/internal/type/array_of.rbi +0 -0
  162. data/rbi/{lib/orb → orb}/internal/type/base_model.rbi +0 -0
  163. data/rbi/{lib/orb → orb}/internal/type/base_page.rbi +0 -0
  164. data/rbi/{lib/orb → orb}/internal/type/boolean.rbi +0 -0
  165. data/rbi/{lib/orb → orb}/internal/type/converter.rbi +0 -0
  166. data/rbi/{lib/orb → orb}/internal/type/enum.rbi +0 -0
  167. data/rbi/{lib/orb → orb}/internal/type/file_input.rbi +0 -0
  168. data/rbi/{lib/orb → orb}/internal/type/hash_of.rbi +0 -0
  169. data/rbi/{lib/orb → orb}/internal/type/union.rbi +0 -0
  170. data/rbi/{lib/orb → orb}/internal/type/unknown.rbi +0 -0
  171. data/rbi/{lib/orb → orb}/internal.rbi +0 -0
  172. data/rbi/{lib/orb → orb}/models/alert.rbi +0 -0
  173. data/rbi/{lib/orb → orb}/models/alert_create_for_customer_params.rbi +0 -0
  174. data/rbi/{lib/orb → orb}/models/alert_create_for_external_customer_params.rbi +0 -0
  175. data/rbi/{lib/orb → orb}/models/alert_create_for_subscription_params.rbi +0 -0
  176. data/rbi/{lib/orb → orb}/models/alert_disable_params.rbi +0 -0
  177. data/rbi/{lib/orb → orb}/models/alert_enable_params.rbi +0 -0
  178. data/rbi/{lib/orb → orb}/models/alert_list_params.rbi +0 -0
  179. data/rbi/{lib/orb → orb}/models/alert_retrieve_params.rbi +0 -0
  180. data/rbi/{lib/orb → orb}/models/alert_update_params.rbi +0 -0
  181. data/rbi/{lib/orb → orb}/models/amount_discount.rbi +0 -0
  182. data/rbi/{lib/orb → orb}/models/billable_metric.rbi +0 -0
  183. data/rbi/{lib/orb → orb}/models/billing_cycle_relative_date.rbi +0 -0
  184. data/rbi/{lib/orb → orb}/models/coupon.rbi +0 -0
  185. data/rbi/{lib/orb → orb}/models/coupon_archive_params.rbi +0 -0
  186. data/rbi/{lib/orb → orb}/models/coupon_fetch_params.rbi +0 -0
  187. data/rbi/{lib/orb → orb}/models/coupon_list_params.rbi +0 -0
  188. data/rbi/{lib/orb → orb}/models/coupons/subscription_list_params.rbi +0 -0
  189. data/rbi/{lib/orb → orb}/models/credit_note.rbi +0 -0
  190. data/rbi/{lib/orb → orb}/models/credit_note_create_params.rbi +0 -0
  191. data/rbi/{lib/orb → orb}/models/credit_note_fetch_params.rbi +0 -0
  192. data/rbi/{lib/orb → orb}/models/credit_note_list_params.rbi +0 -0
  193. data/rbi/{lib/orb → orb}/models/customer.rbi +0 -0
  194. data/rbi/{lib/orb → orb}/models/customer_delete_params.rbi +0 -0
  195. data/rbi/{lib/orb → orb}/models/customer_fetch_by_external_id_params.rbi +0 -0
  196. data/rbi/{lib/orb → orb}/models/customer_fetch_params.rbi +0 -0
  197. data/rbi/{lib/orb → orb}/models/customer_list_params.rbi +0 -0
  198. data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +0 -0
  199. data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_params.rbi +0 -0
  200. data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_params.rbi +0 -0
  201. data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_response.rbi +0 -0
  202. data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_params.rbi +0 -0
  203. data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_response.rbi +0 -0
  204. data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_params.rbi +0 -0
  205. data/rbi/{lib/orb → orb}/models/customers/cost_list_params.rbi +0 -0
  206. data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_params.rbi +0 -0
  207. data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_response.rbi +0 -0
  208. data/rbi/{lib/orb → orb}/models/customers/credit_list_params.rbi +0 -0
  209. data/rbi/{lib/orb → orb}/models/customers/credit_list_response.rbi +0 -0
  210. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +0 -0
  211. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_params.rbi +0 -0
  212. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_params.rbi +0 -0
  213. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_params.rbi +0 -0
  214. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_params.rbi +0 -0
  215. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_response.rbi +0 -0
  216. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_params.rbi +0 -0
  217. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_response.rbi +0 -0
  218. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_by_external_id_params.rbi +0 -0
  219. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_params.rbi +0 -0
  220. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_params.rbi +0 -0
  221. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_response.rbi +0 -0
  222. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_params.rbi +0 -0
  223. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_response.rbi +0 -0
  224. data/rbi/{lib/orb → orb}/models/dimensional_price_group.rbi +0 -0
  225. data/rbi/{lib/orb → orb}/models/dimensional_price_group_create_params.rbi +0 -0
  226. data/rbi/{lib/orb → orb}/models/dimensional_price_group_list_params.rbi +0 -0
  227. data/rbi/{lib/orb → orb}/models/dimensional_price_group_retrieve_params.rbi +0 -0
  228. data/rbi/{lib/orb → orb}/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +0 -0
  229. data/rbi/{lib/orb → orb}/models/dimensional_price_groups.rbi +0 -0
  230. data/rbi/{lib/orb → orb}/models/discount.rbi +0 -0
  231. data/rbi/{lib/orb → orb}/models/evaluate_price_group.rbi +0 -0
  232. data/rbi/{lib/orb → orb}/models/event_deprecate_params.rbi +0 -0
  233. data/rbi/{lib/orb → orb}/models/event_deprecate_response.rbi +0 -0
  234. data/rbi/{lib/orb → orb}/models/event_ingest_params.rbi +0 -0
  235. data/rbi/{lib/orb → orb}/models/event_ingest_response.rbi +0 -0
  236. data/rbi/{lib/orb → orb}/models/event_search_params.rbi +0 -0
  237. data/rbi/{lib/orb → orb}/models/event_search_response.rbi +0 -0
  238. data/rbi/{lib/orb → orb}/models/event_update_params.rbi +0 -0
  239. data/rbi/{lib/orb → orb}/models/event_update_response.rbi +0 -0
  240. data/rbi/{lib/orb → orb}/models/events/backfill_close_params.rbi +0 -0
  241. data/rbi/{lib/orb → orb}/models/events/backfill_close_response.rbi +0 -0
  242. data/rbi/{lib/orb → orb}/models/events/backfill_create_params.rbi +0 -0
  243. data/rbi/{lib/orb → orb}/models/events/backfill_create_response.rbi +0 -0
  244. data/rbi/{lib/orb → orb}/models/events/backfill_fetch_params.rbi +0 -0
  245. data/rbi/{lib/orb → orb}/models/events/backfill_fetch_response.rbi +0 -0
  246. data/rbi/{lib/orb → orb}/models/events/backfill_list_params.rbi +0 -0
  247. data/rbi/{lib/orb → orb}/models/events/backfill_list_response.rbi +0 -0
  248. data/rbi/{lib/orb → orb}/models/events/backfill_revert_params.rbi +0 -0
  249. data/rbi/{lib/orb → orb}/models/events/backfill_revert_response.rbi +0 -0
  250. data/rbi/{lib/orb → orb}/models/events/event_volumes.rbi +2 -2
  251. /data/rbi/{lib/orb → orb}/models/events/volume_list_params.rbi +0 -0
  252. /data/rbi/{lib/orb → orb}/models/invoice_create_params.rbi +0 -0
  253. /data/rbi/{lib/orb → orb}/models/invoice_fetch_params.rbi +0 -0
  254. /data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_params.rbi +0 -0
  255. /data/rbi/{lib/orb → orb}/models/invoice_issue_params.rbi +0 -0
  256. /data/rbi/{lib/orb → orb}/models/invoice_level_discount.rbi +0 -0
  257. /data/rbi/{lib/orb → orb}/models/invoice_line_item_create_params.rbi +0 -0
  258. /data/rbi/{lib/orb → orb}/models/invoice_list_params.rbi +0 -0
  259. /data/rbi/{lib/orb → orb}/models/invoice_mark_paid_params.rbi +0 -0
  260. /data/rbi/{lib/orb → orb}/models/invoice_pay_params.rbi +0 -0
  261. /data/rbi/{lib/orb → orb}/models/invoice_update_params.rbi +0 -0
  262. /data/rbi/{lib/orb → orb}/models/invoice_void_params.rbi +0 -0
  263. /data/rbi/{lib/orb → orb}/models/item.rbi +0 -0
  264. /data/rbi/{lib/orb → orb}/models/item_create_params.rbi +0 -0
  265. /data/rbi/{lib/orb → orb}/models/item_fetch_params.rbi +0 -0
  266. /data/rbi/{lib/orb → orb}/models/item_list_params.rbi +0 -0
  267. /data/rbi/{lib/orb → orb}/models/item_update_params.rbi +0 -0
  268. /data/rbi/{lib/orb → orb}/models/metric_create_params.rbi +0 -0
  269. /data/rbi/{lib/orb → orb}/models/metric_fetch_params.rbi +0 -0
  270. /data/rbi/{lib/orb → orb}/models/metric_list_params.rbi +0 -0
  271. /data/rbi/{lib/orb → orb}/models/metric_update_params.rbi +0 -0
  272. /data/rbi/{lib/orb → orb}/models/pagination_metadata.rbi +0 -0
  273. /data/rbi/{lib/orb → orb}/models/percentage_discount.rbi +0 -0
  274. /data/rbi/{lib/orb → orb}/models/plan_fetch_params.rbi +0 -0
  275. /data/rbi/{lib/orb → orb}/models/plan_list_params.rbi +0 -0
  276. /data/rbi/{lib/orb → orb}/models/plan_update_params.rbi +0 -0
  277. /data/rbi/{lib/orb → orb}/models/plans/external_plan_id_fetch_params.rbi +0 -0
  278. /data/rbi/{lib/orb → orb}/models/plans/external_plan_id_update_params.rbi +0 -0
  279. /data/rbi/{lib/orb → orb}/models/price_create_params.rbi +0 -0
  280. /data/rbi/{lib/orb → orb}/models/price_evaluate_params.rbi +0 -0
  281. /data/rbi/{lib/orb → orb}/models/price_evaluate_response.rbi +0 -0
  282. /data/rbi/{lib/orb → orb}/models/price_fetch_params.rbi +0 -0
  283. /data/rbi/{lib/orb → orb}/models/price_list_params.rbi +0 -0
  284. /data/rbi/{lib/orb → orb}/models/price_update_params.rbi +0 -0
  285. /data/rbi/{lib/orb → orb}/models/prices/external_price_id_fetch_params.rbi +0 -0
  286. /data/rbi/{lib/orb → orb}/models/prices/external_price_id_update_params.rbi +0 -0
  287. /data/rbi/{lib/orb → orb}/models/subscription_cancel_params.rbi +0 -0
  288. /data/rbi/{lib/orb → orb}/models/subscription_change_apply_params.rbi +0 -0
  289. /data/rbi/{lib/orb → orb}/models/subscription_change_cancel_params.rbi +0 -0
  290. /data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_params.rbi +0 -0
  291. /data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_params.rbi +0 -0
  292. /data/rbi/{lib/orb → orb}/models/subscription_fetch_params.rbi +0 -0
  293. /data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_params.rbi +0 -0
  294. /data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_response.rbi +0 -0
  295. /data/rbi/{lib/orb → orb}/models/subscription_fetch_usage_params.rbi +0 -0
  296. /data/rbi/{lib/orb → orb}/models/subscription_list_params.rbi +0 -0
  297. /data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_params.rbi +0 -0
  298. /data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_params.rbi +0 -0
  299. /data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +0 -0
  300. /data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_params.rbi +0 -0
  301. /data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_params.rbi +0 -0
  302. /data/rbi/{lib/orb → orb}/models/subscription_update_params.rbi +0 -0
  303. /data/rbi/{lib/orb → orb}/models/subscription_update_trial_params.rbi +0 -0
  304. /data/rbi/{lib/orb → orb}/models/subscription_usage.rbi +0 -0
  305. /data/rbi/{lib/orb → orb}/models/subscriptions.rbi +0 -0
  306. /data/rbi/{lib/orb → orb}/models/top_level_ping_params.rbi +0 -0
  307. /data/rbi/{lib/orb → orb}/models/top_level_ping_response.rbi +0 -0
  308. /data/rbi/{lib/orb → orb}/models/trial_discount.rbi +0 -0
  309. /data/rbi/{lib/orb → orb}/models/usage_discount.rbi +0 -0
  310. /data/rbi/{lib/orb → orb}/version.rbi +0 -0
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6367789d025f1cbcd45171eca19809e1cb2cdff2c24af5335fac8641c876b093
4
- data.tar.gz: 57a3c5bcb71ebf4f3e78b4412b386616cc1e37fc6adc682f38f13a129bc9aed4
3
+ metadata.gz: 419ff101a6d09de79a68655064cd315df1915451f0d1b395f411f75fd823623a
4
+ data.tar.gz: 38ef3fa62382d435a88b1d394f7bd28b18cd70d6c9f003ad252e29fa3d1fe53b
5
5
  SHA512:
6
- metadata.gz: 62f9112f730c3b05638d410aba2302c4ce137f46ad72e4a888636eff8eacc0f6649a41d69726f05e05ffb82d2de1fe9996f72556e537f065b43d415ffeb1024d
7
- data.tar.gz: a0f8bd39183054afa8f172d776b20c54c08019b04001b00b33878fb4a69e6c0a0b54038bd7072e930fb85b2a070012fabf6319b4b2ce34195844b9f3b2cbe90a
6
+ metadata.gz: 55004f9c82b06ae34185b2ab4a3ba837772129b737ebb84675f0ffc8a42e7648ce07d2cc476f3d4413c3501181ae72be05e8b94527c2d869f24fb36fba3f552b
7
+ data.tar.gz: b04180071d9065d617e62dc13d4504e132f84ffeda3ecbc2d9b72b5f0c278d37763851a1e35f9d4f75c6c15086a4909715494c72fd2caf3d630fa5c2a1a198b8
data/CHANGELOG.md CHANGED
@@ -1,5 +1,38 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.3.1 (2025-05-06)
4
+
5
+ Full Changelog: [v0.3.0...v0.3.1](https://github.com/orbcorp/orb-ruby/compare/v0.3.0...v0.3.1)
6
+
7
+ ### Bug Fixes
8
+
9
+ * **internal:** fix formatting script for macos ([3d4e166](https://github.com/orbcorp/orb-ruby/commit/3d4e166f77e3e15037d1bd000f249fcb73cd216e))
10
+
11
+
12
+ ### Chores
13
+
14
+ * add generator safe directory ([dc351bd](https://github.com/orbcorp/orb-ruby/commit/dc351bdabe5a44981c8461a5cf8249df075c513f))
15
+ * always check if current page is empty in `next_page?` ([eca7722](https://github.com/orbcorp/orb-ruby/commit/eca772296d3bae2ca18fb60afdb7e3b66a8ae6a8))
16
+ * **internal:** annotate request options with type aliases in sorbet ([85ddf12](https://github.com/orbcorp/orb-ruby/commit/85ddf1253cab3253c621fe5da2715c4332c88f22))
17
+ * **internal:** codegen related update ([43622bc](https://github.com/orbcorp/orb-ruby/commit/43622bc6158b0409520ddafb16b3348b04f133e4))
18
+ * **internal:** codegen related update ([4b21f9a](https://github.com/orbcorp/orb-ruby/commit/4b21f9ae7e8b1d36342b6f4e9e01901b6ea662d5))
19
+ * **internal:** codegen related update ([143f9a8](https://github.com/orbcorp/orb-ruby/commit/143f9a890045832dc6a4690b098a6f54c3d61cb1))
20
+ * **internal:** codegen related update ([25413e1](https://github.com/orbcorp/orb-ruby/commit/25413e1323f09ed82730671f199b7c4b81277230))
21
+ * **internal:** codegen related update ([6d43598](https://github.com/orbcorp/orb-ruby/commit/6d43598c8ffca3220257f5cd6c5e0cbaf78a8322))
22
+ * loosen rubocop rules that don't always make sense ([5a71c5b](https://github.com/orbcorp/orb-ruby/commit/5a71c5b9dce0d43b9ba5016cdcd0a1fe00c62ee6))
23
+ * migrate away from deprecated `JSON#fast_generate` ([6207686](https://github.com/orbcorp/orb-ruby/commit/6207686bfea6cd2504a4a2cc74ca766bc916cb95))
24
+ * more accurate type annotations and aliases ([5528e59](https://github.com/orbcorp/orb-ruby/commit/5528e59e7f77d948dcc3942efd7f0dbc1a167215))
25
+ * re-export top level models under library namespace ([95cbfd9](https://github.com/orbcorp/orb-ruby/commit/95cbfd9241828bee0e537b69d3a014a5394f8ba3))
26
+ * remove Gemfile.lock during bootstrap ([a369d56](https://github.com/orbcorp/orb-ruby/commit/a369d5679a808b24fa88d986898ad0168af90202))
27
+ * reorganize type aliases ([22b91f9](https://github.com/orbcorp/orb-ruby/commit/22b91f9837bb3fd5677cb1325f3c221ae80c8663))
28
+ * validate request option coercion correctness ([2ba6032](https://github.com/orbcorp/orb-ruby/commit/2ba6032243950cdef75e63ea75dd3865d79bca02))
29
+
30
+
31
+ ### Documentation
32
+
33
+ * illustrate environmental defaults for auth variables ([34613d7](https://github.com/orbcorp/orb-ruby/commit/34613d75cd3baab105f5dc5f0d4f4c7bb1fe1e3e))
34
+ * **readme:** fix typo ([9229774](https://github.com/orbcorp/orb-ruby/commit/9229774479cb18ea70941da9652094d4f4b7bfe6))
35
+
3
36
  ## 0.3.0 (2025-04-25)
4
37
 
5
38
  Full Changelog: [v0.2.0...v0.3.0](https://github.com/orbcorp/orb-ruby/compare/v0.2.0...v0.3.0)
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Orb Ruby API library
2
2
 
3
- The Orb Ruby library provides convenient access to the Orb REST API from any Ruby 3.1.0+ application.
3
+ The Orb Ruby library provides convenient access to the Orb REST API from any Ruby 3.2.0+ application.
4
4
 
5
5
  ## Documentation
6
6
 
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
15
15
  <!-- x-release-please-start-version -->
16
16
 
17
17
  ```ruby
18
- gem "orb-billing", "~> 0.3.0"
18
+ gem "orb-billing", "~> 0.3.1"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -27,7 +27,7 @@ require "bundler/setup"
27
27
  require "orb"
28
28
 
29
29
  orb = Orb::Client.new(
30
- api_key: "My API Key" # defaults to ENV["ORB_API_KEY"]
30
+ api_key: ENV["ORB_API_KEY"] # This is the default and can be omitted
31
31
  )
32
32
 
33
33
  customer = orb.customers.create(email: "example-customer@withorb.com", name: "My Customer")
@@ -76,7 +76,7 @@ rescue Orb::Errors::APIError => e
76
76
  end
77
77
  ```
78
78
 
79
- Error codes are as followed:
79
+ Error codes are as follows:
80
80
 
81
81
  | Cause | Error Type |
82
82
  | ---------------- | -------------------------- |
@@ -223,7 +223,7 @@ This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` typ
223
223
 
224
224
  ## Requirements
225
225
 
226
- Ruby 3.1.0 or higher.
226
+ Ruby 3.2.0 or higher.
227
227
 
228
228
  ## Contributing
229
229
 
data/lib/orb/errors.rb CHANGED
@@ -3,9 +3,9 @@
3
3
  module Orb
4
4
  module Errors
5
5
  class Error < StandardError
6
- # @!parse
7
- # # @return [StandardError, nil]
8
- # attr_accessor :cause
6
+ # @!attribute cause
7
+ #
8
+ # @return [StandardError, nil]
9
9
  end
10
10
 
11
11
  class ConversionError < Orb::Errors::Error
@@ -40,13 +40,13 @@ module Orb
40
40
  end
41
41
 
42
42
  class APIConnectionError < Orb::Errors::APIError
43
- # @!parse
44
- # # @return [nil]
45
- # attr_accessor :status
43
+ # @!attribute status
44
+ #
45
+ # @return [nil]
46
46
 
47
- # @!parse
48
- # # @return [nil]
49
- # attr_accessor :body
47
+ # @!attribute body
48
+ #
49
+ # @return [nil]
50
50
 
51
51
  # @api private
52
52
  #
@@ -24,7 +24,7 @@ module Orb
24
24
 
25
25
  # @return [Boolean]
26
26
  def next_page?
27
- !pagination_metadata&.next_cursor.nil?
27
+ !data.to_a.empty? && !pagination_metadata&.next_cursor.to_s.empty?
28
28
  end
29
29
 
30
30
  # @raise [Orb::HTTP::Error]
@@ -66,8 +66,8 @@ module Orb
66
66
  super
67
67
 
68
68
  case page_data
69
- in {data: Array | nil => data}
70
- @data = data&.map { Orb::Internal::Type::Converter.coerce(@model, _1) }
69
+ in {data: Array => data}
70
+ @data = data.map { Orb::Internal::Type::Converter.coerce(@model, _1) }
71
71
  else
72
72
  end
73
73
  case page_data
@@ -261,7 +261,7 @@ module Orb
261
261
  headers["x-stainless-retry-count"] = "0"
262
262
  end
263
263
 
264
- timeout = opts.fetch(:timeout, @timeout).to_f.clamp((0..))
264
+ timeout = opts.fetch(:timeout, @timeout).to_f.clamp(0..)
265
265
  unless headers.key?("x-stainless-timeout") || timeout.zero?
266
266
  headers["x-stainless-timeout"] = timeout.to_s
267
267
  end
@@ -458,9 +458,9 @@ module Orb
458
458
 
459
459
  decoded = Orb::Internal::Util.decode_content(response, stream: stream)
460
460
  case req
461
- in { stream: Class => st }
461
+ in {stream: Class => st}
462
462
  st.new(model: model, url: url, status: status, response: response, stream: decoded)
463
- in { page: Class => page }
463
+ in {page: Class => page}
464
464
  page.new(client: self, req: req, headers: response, page_data: decoded)
465
465
  else
466
466
  unwrapped = Orb::Internal::Util.dig(decoded, req[:unwrap])
@@ -390,15 +390,7 @@ module Orb
390
390
  # Create a new instance of a model.
391
391
  #
392
392
  # @param data [Hash{Symbol=>Object}, self]
393
- def initialize(data = {})
394
- case Orb::Internal::Util.coerce_hash(data)
395
- in Hash => coerced
396
- @data = coerced
397
- else
398
- message = "Expected a #{Hash} or #{Orb::Internal::Type::BaseModel}, got #{data.inspect}"
399
- raise ArgumentError.new(message)
400
- end
401
- end
393
+ def initialize(data = {}) = (@data = Orb::Internal::Util.coerce_hash!(data).to_h)
402
394
 
403
395
  class << self
404
396
  # @api private
@@ -46,17 +46,16 @@ module Orb
46
46
  value
47
47
  end
48
48
 
49
- # @!parse
50
- # # @api private
51
- # #
52
- # # @param value [Boolean, Object]
53
- # #
54
- # # @param state [Hash{Symbol=>Object}] .
55
- # #
56
- # # @option state [Boolean] :can_retry
57
- # #
58
- # # @return [Boolean, Object]
59
- # def dump(value, state:) = super
49
+ # @!method dump(value, state:)
50
+ # @api private
51
+ #
52
+ # @param value [Boolean, Object]
53
+ #
54
+ # @param state [Hash{Symbol=>Object}] .
55
+ #
56
+ # @option state [Boolean] :can_retry
57
+ #
58
+ # @return [Boolean, Object]
60
59
  end
61
60
  end
62
61
  end
@@ -96,17 +96,16 @@ module Orb
96
96
  end
97
97
  end
98
98
 
99
- # @!parse
100
- # # @api private
101
- # #
102
- # # @param value [Symbol, Object]
103
- # #
104
- # # @param state [Hash{Symbol=>Object}] .
105
- # #
106
- # # @option state [Boolean] :can_retry
107
- # #
108
- # # @return [Symbol, Object]
109
- # def dump(value, state:) = super
99
+ # @!method dump(value, state:)
100
+ # @api private
101
+ #
102
+ # @param value [Symbol, Object]
103
+ #
104
+ # @param state [Hash{Symbol=>Object}] .
105
+ #
106
+ # @option state [Boolean] :can_retry
107
+ #
108
+ # @return [Symbol, Object]
110
109
 
111
110
  # @api private
112
111
  #
@@ -28,14 +28,8 @@ module Orb
28
28
  state = {can_retry: true}
29
29
  case (dumped = dump(params, state: state))
30
30
  in Hash
31
- options = Orb::Internal::Util.coerce_hash(dumped[:request_options])
32
- request_options =
33
- case [options, state.fetch(:can_retry)]
34
- in [Hash | nil, false]
35
- {**options.to_h, max_retries: 0}
36
- else
37
- options
38
- end
31
+ options = Orb::Internal::Util.coerce_hash!(dumped[:request_options]).to_h
32
+ request_options = state.fetch(:can_retry) ? options : {**options, max_retries: 0}
39
33
  [dumped.except(:request_options), request_options]
40
34
  else
41
35
  [dumped, nil]
@@ -48,17 +48,16 @@ module Orb
48
48
  value
49
49
  end
50
50
 
51
- # @!parse
52
- # # @api private
53
- # #
54
- # # @param value [Object]
55
- # #
56
- # # @param state [Hash{Symbol=>Object}] .
57
- # #
58
- # # @option state [Boolean] :can_retry
59
- # #
60
- # # @return [Object]
61
- # def dump(value, state:) = super
51
+ # @!method dump(value, state:)
52
+ # @api private
53
+ #
54
+ # @param value [Object]
55
+ #
56
+ # @param state [Hash{Symbol=>Object}] .
57
+ #
58
+ # @option state [Boolean] :can_retry
59
+ #
60
+ # @return [Object]
62
61
  end
63
62
 
64
63
  # rubocop:enable Lint/UnusedMethodArgument
@@ -128,6 +128,22 @@ module Orb
128
128
  input.respond_to?(:to_h) ? input.to_h : input
129
129
  end
130
130
  end
131
+
132
+ # @api private
133
+ #
134
+ # @param input [Object]
135
+ #
136
+ # @raise [ArgumentError]
137
+ # @return [Hash{Object=>Object}, nil]
138
+ def coerce_hash!(input)
139
+ case coerce_hash(input)
140
+ in Hash | nil => coerced
141
+ coerced
142
+ else
143
+ message = "Expected a #{Hash} or #{Orb::Internal::Type::BaseModel}, got #{data.inspect}"
144
+ raise ArgumentError.new(message)
145
+ end
146
+ end
131
147
  end
132
148
 
133
149
  class << self
@@ -454,7 +470,7 @@ module Orb
454
470
  # @type [Regexp]
455
471
  JSON_CONTENT = %r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}
456
472
  # @type [Regexp]
457
- JSONL_CONTENT = %r{^application/(?:x-)?jsonl}
473
+ JSONL_CONTENT = %r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}
458
474
 
459
475
  class << self
460
476
  # @api private
@@ -493,7 +509,7 @@ module Orb
493
509
  y << val.to_s
494
510
  else
495
511
  y << "Content-Type: application/json\r\n\r\n"
496
- y << JSON.fast_generate(val)
512
+ y << JSON.generate(val)
497
513
  end
498
514
  y << "\r\n"
499
515
  end
@@ -570,9 +586,9 @@ module Orb
570
586
  content_type = headers["content-type"]
571
587
  case [content_type, body]
572
588
  in [Orb::Internal::Util::JSON_CONTENT, Hash | Array | -> { primitive?(_1) }]
573
- [headers, JSON.fast_generate(body)]
589
+ [headers, JSON.generate(body)]
574
590
  in [Orb::Internal::Util::JSONL_CONTENT, Enumerable] unless body.is_a?(Orb::Internal::Type::FileInput)
575
- [headers, body.lazy.map { JSON.fast_generate(_1) }]
591
+ [headers, body.lazy.map { JSON.generate(_1) }]
576
592
  in [%r{^multipart/form-data}, Hash | Orb::Internal::Type::FileInput]
577
593
  boundary, strio = encode_multipart_streaming(body)
578
594
  headers = {**headers, "content-type" => "#{content_type}; boundary=#{boundary}"}
@@ -9,7 +9,7 @@ module Orb
9
9
 
10
10
  # @!attribute discount
11
11
  #
12
- # @return [Orb::Models::CouponCreateParams::Discount::NewCouponPercentageDiscount, Orb::Models::CouponCreateParams::Discount::NewCouponAmountDiscount]
12
+ # @return [Orb::Models::CouponCreateParams::Discount::Percentage, Orb::Models::CouponCreateParams::Discount::Amount]
13
13
  required :discount, union: -> { Orb::Models::CouponCreateParams::Discount }
14
14
 
15
15
  # @!attribute redemption_code
@@ -36,7 +36,7 @@ module Orb
36
36
  # Some parameter documentations has been truncated, see
37
37
  # {Orb::Models::CouponCreateParams} for more details.
38
38
  #
39
- # @param discount [Orb::Models::CouponCreateParams::Discount::NewCouponPercentageDiscount, Orb::Models::CouponCreateParams::Discount::NewCouponAmountDiscount]
39
+ # @param discount [Orb::Models::CouponCreateParams::Discount::Percentage, Orb::Models::CouponCreateParams::Discount::Amount]
40
40
  #
41
41
  # @param redemption_code [String] This string can be used to redeem this coupon for a given subscription.
42
42
  #
@@ -53,11 +53,11 @@ module Orb
53
53
 
54
54
  discriminator :discount_type
55
55
 
56
- variant :percentage, -> { Orb::Models::CouponCreateParams::Discount::NewCouponPercentageDiscount }
56
+ variant :percentage, -> { Orb::Models::CouponCreateParams::Discount::Percentage }
57
57
 
58
- variant :amount, -> { Orb::Models::CouponCreateParams::Discount::NewCouponAmountDiscount }
58
+ variant :amount, -> { Orb::Models::CouponCreateParams::Discount::Amount }
59
59
 
60
- class NewCouponPercentageDiscount < Orb::Internal::Type::BaseModel
60
+ class Percentage < Orb::Internal::Type::BaseModel
61
61
  # @!attribute discount_type
62
62
  #
63
63
  # @return [Symbol, :percentage]
@@ -73,7 +73,7 @@ module Orb
73
73
  # @param discount_type [Symbol, :percentage]
74
74
  end
75
75
 
76
- class NewCouponAmountDiscount < Orb::Internal::Type::BaseModel
76
+ class Amount < Orb::Internal::Type::BaseModel
77
77
  # @!attribute amount_discount
78
78
  #
79
79
  # @return [String]
@@ -90,7 +90,7 @@ module Orb
90
90
  end
91
91
 
92
92
  # @!method self.variants
93
- # @return [Array(Orb::Models::CouponCreateParams::Discount::NewCouponPercentageDiscount, Orb::Models::CouponCreateParams::Discount::NewCouponAmountDiscount)]
93
+ # @return [Array(Orb::Models::CouponCreateParams::Discount::Percentage, Orb::Models::CouponCreateParams::Discount::Amount)]
94
94
  end
95
95
  end
96
96
  end
@@ -111,7 +111,7 @@ module Orb
111
111
 
112
112
  # @!attribute tax_configuration
113
113
  #
114
- # @return [Orb::Models::CustomerCreateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerCreateParams::TaxConfiguration::NewTaxJarConfiguration, nil]
114
+ # @return [Orb::Models::CustomerCreateParams::TaxConfiguration::Avalara, Orb::Models::CustomerCreateParams::TaxConfiguration::Taxjar, nil]
115
115
  optional :tax_configuration, union: -> { Orb::Models::CustomerCreateParams::TaxConfiguration }, nil?: true
116
116
 
117
117
  # @!attribute tax_id
@@ -274,7 +274,7 @@ module Orb
274
274
  #
275
275
  # @param shipping_address [Orb::Models::CustomerCreateParams::ShippingAddress, nil]
276
276
  #
277
- # @param tax_configuration [Orb::Models::CustomerCreateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerCreateParams::TaxConfiguration::NewTaxJarConfiguration, nil]
277
+ # @param tax_configuration [Orb::Models::CustomerCreateParams::TaxConfiguration::Avalara, Orb::Models::CustomerCreateParams::TaxConfiguration::Taxjar, nil]
278
278
  #
279
279
  # @param tax_id [Orb::Models::CustomerCreateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
280
280
  # ...
@@ -457,11 +457,11 @@ module Orb
457
457
 
458
458
  discriminator :tax_provider
459
459
 
460
- variant :avalara, -> { Orb::Models::CustomerCreateParams::TaxConfiguration::NewAvalaraTaxConfiguration }
460
+ variant :avalara, -> { Orb::Models::CustomerCreateParams::TaxConfiguration::Avalara }
461
461
 
462
- variant :taxjar, -> { Orb::Models::CustomerCreateParams::TaxConfiguration::NewTaxJarConfiguration }
462
+ variant :taxjar, -> { Orb::Models::CustomerCreateParams::TaxConfiguration::Taxjar }
463
463
 
464
- class NewAvalaraTaxConfiguration < Orb::Internal::Type::BaseModel
464
+ class Avalara < Orb::Internal::Type::BaseModel
465
465
  # @!attribute tax_exempt
466
466
  #
467
467
  # @return [Boolean]
@@ -483,7 +483,7 @@ module Orb
483
483
  # @param tax_provider [Symbol, :avalara]
484
484
  end
485
485
 
486
- class NewTaxJarConfiguration < Orb::Internal::Type::BaseModel
486
+ class Taxjar < Orb::Internal::Type::BaseModel
487
487
  # @!attribute tax_exempt
488
488
  #
489
489
  # @return [Boolean]
@@ -500,7 +500,7 @@ module Orb
500
500
  end
501
501
 
502
502
  # @!method self.variants
503
- # @return [Array(Orb::Models::CustomerCreateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerCreateParams::TaxConfiguration::NewTaxJarConfiguration)]
503
+ # @return [Array(Orb::Models::CustomerCreateParams::TaxConfiguration::Avalara, Orb::Models::CustomerCreateParams::TaxConfiguration::Taxjar)]
504
504
  end
505
505
 
506
506
  class TaxID < Orb::Internal::Type::BaseModel
@@ -118,7 +118,7 @@ module Orb
118
118
 
119
119
  # @!attribute tax_configuration
120
120
  #
121
- # @return [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewTaxJarConfiguration, nil]
121
+ # @return [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar, nil]
122
122
  optional :tax_configuration,
123
123
  union: -> { Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration },
124
124
  nil?: true
@@ -274,7 +274,7 @@ module Orb
274
274
  #
275
275
  # @param shipping_address [Orb::Models::CustomerUpdateByExternalIDParams::ShippingAddress, nil]
276
276
  #
277
- # @param tax_configuration [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewTaxJarConfiguration, nil]
277
+ # @param tax_configuration [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar, nil]
278
278
  #
279
279
  # @param tax_id [Orb::Models::CustomerUpdateByExternalIDParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
280
280
  # ...
@@ -458,13 +458,11 @@ module Orb
458
458
 
459
459
  discriminator :tax_provider
460
460
 
461
- variant :avalara,
462
- -> { Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewAvalaraTaxConfiguration }
461
+ variant :avalara, -> { Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara }
463
462
 
464
- variant :taxjar,
465
- -> { Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewTaxJarConfiguration }
463
+ variant :taxjar, -> { Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar }
466
464
 
467
- class NewAvalaraTaxConfiguration < Orb::Internal::Type::BaseModel
465
+ class Avalara < Orb::Internal::Type::BaseModel
468
466
  # @!attribute tax_exempt
469
467
  #
470
468
  # @return [Boolean]
@@ -486,7 +484,7 @@ module Orb
486
484
  # @param tax_provider [Symbol, :avalara]
487
485
  end
488
486
 
489
- class NewTaxJarConfiguration < Orb::Internal::Type::BaseModel
487
+ class Taxjar < Orb::Internal::Type::BaseModel
490
488
  # @!attribute tax_exempt
491
489
  #
492
490
  # @return [Boolean]
@@ -503,7 +501,7 @@ module Orb
503
501
  end
504
502
 
505
503
  # @!method self.variants
506
- # @return [Array(Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewTaxJarConfiguration)]
504
+ # @return [Array(Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar)]
507
505
  end
508
506
 
509
507
  class TaxID < Orb::Internal::Type::BaseModel
@@ -112,7 +112,7 @@ module Orb
112
112
 
113
113
  # @!attribute tax_configuration
114
114
  #
115
- # @return [Orb::Models::CustomerUpdateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateParams::TaxConfiguration::NewTaxJarConfiguration, nil]
115
+ # @return [Orb::Models::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateParams::TaxConfiguration::Taxjar, nil]
116
116
  optional :tax_configuration, union: -> { Orb::Models::CustomerUpdateParams::TaxConfiguration }, nil?: true
117
117
 
118
118
  # @!attribute tax_id
@@ -266,7 +266,7 @@ module Orb
266
266
  #
267
267
  # @param shipping_address [Orb::Models::CustomerUpdateParams::ShippingAddress, nil]
268
268
  #
269
- # @param tax_configuration [Orb::Models::CustomerUpdateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateParams::TaxConfiguration::NewTaxJarConfiguration, nil]
269
+ # @param tax_configuration [Orb::Models::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateParams::TaxConfiguration::Taxjar, nil]
270
270
  #
271
271
  # @param tax_id [Orb::Models::CustomerUpdateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
272
272
  # ...
@@ -450,11 +450,11 @@ module Orb
450
450
 
451
451
  discriminator :tax_provider
452
452
 
453
- variant :avalara, -> { Orb::Models::CustomerUpdateParams::TaxConfiguration::NewAvalaraTaxConfiguration }
453
+ variant :avalara, -> { Orb::Models::CustomerUpdateParams::TaxConfiguration::Avalara }
454
454
 
455
- variant :taxjar, -> { Orb::Models::CustomerUpdateParams::TaxConfiguration::NewTaxJarConfiguration }
455
+ variant :taxjar, -> { Orb::Models::CustomerUpdateParams::TaxConfiguration::Taxjar }
456
456
 
457
- class NewAvalaraTaxConfiguration < Orb::Internal::Type::BaseModel
457
+ class Avalara < Orb::Internal::Type::BaseModel
458
458
  # @!attribute tax_exempt
459
459
  #
460
460
  # @return [Boolean]
@@ -476,7 +476,7 @@ module Orb
476
476
  # @param tax_provider [Symbol, :avalara]
477
477
  end
478
478
 
479
- class NewTaxJarConfiguration < Orb::Internal::Type::BaseModel
479
+ class Taxjar < Orb::Internal::Type::BaseModel
480
480
  # @!attribute tax_exempt
481
481
  #
482
482
  # @return [Boolean]
@@ -493,7 +493,7 @@ module Orb
493
493
  end
494
494
 
495
495
  # @!method self.variants
496
- # @return [Array(Orb::Models::CustomerUpdateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateParams::TaxConfiguration::NewTaxJarConfiguration)]
496
+ # @return [Array(Orb::Models::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateParams::TaxConfiguration::Taxjar)]
497
497
  end
498
498
 
499
499
  class TaxID < Orb::Internal::Type::BaseModel
@@ -58,7 +58,7 @@ 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]
61
+ # @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk]
62
62
  required :price, union: -> { Orb::Models::Price }
63
63
 
64
64
  # @!attribute price_id
@@ -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::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk] The price object
90
90
  #
91
91
  # @param price_id [String] The price the cost is associated with
92
92
  #
@@ -57,7 +57,7 @@ module Orb
57
57
  # @!attribute price
58
58
  # The price object
59
59
  #
60
- # @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]
60
+ # @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk]
61
61
  required :price, union: -> { Orb::Models::Price }
62
62
 
63
63
  # @!attribute price_id
@@ -85,7 +85,7 @@ module Orb
85
85
  optional :quantity, Float, nil?: true
86
86
 
87
87
  # @!method initialize(price:, price_id:, subtotal:, total:, quantity: nil)
88
- # @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
88
+ # @param price [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk] The price object
89
89
  #
90
90
  # @param price_id [String] The price the cost is associated with
91
91
  #