orb-billing 0.1.0.pre.alpha.33

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 (635) hide show
  1. checksums.yaml +7 -0
  2. data/README.md +169 -0
  3. data/lib/orb/client.rb +129 -0
  4. data/lib/orb/errors.rb +317 -0
  5. data/lib/orb/models/alert.rb +225 -0
  6. data/lib/orb/models/alert_create_for_customer_params.rb +77 -0
  7. data/lib/orb/models/alert_create_for_external_customer_params.rb +77 -0
  8. data/lib/orb/models/alert_create_for_subscription_params.rb +74 -0
  9. data/lib/orb/models/alert_disable_params.rb +26 -0
  10. data/lib/orb/models/alert_enable_params.rb +26 -0
  11. data/lib/orb/models/alert_list_params.rb +97 -0
  12. data/lib/orb/models/alert_retrieve_params.rb +19 -0
  13. data/lib/orb/models/alert_update_params.rb +46 -0
  14. data/lib/orb/models/amount_discount.rb +53 -0
  15. data/lib/orb/models/billable_metric.rb +76 -0
  16. data/lib/orb/models/billing_cycle_relative_date.rb +18 -0
  17. data/lib/orb/models/coupon.rb +86 -0
  18. data/lib/orb/models/coupon_archive_params.rb +19 -0
  19. data/lib/orb/models/coupon_create_params.rb +102 -0
  20. data/lib/orb/models/coupon_fetch_params.rb +19 -0
  21. data/lib/orb/models/coupon_list_params.rb +53 -0
  22. data/lib/orb/models/coupons/subscription_list_params.rb +40 -0
  23. data/lib/orb/models/credit_note.rb +522 -0
  24. data/lib/orb/models/credit_note_create_params.rb +77 -0
  25. data/lib/orb/models/credit_note_fetch_params.rb +19 -0
  26. data/lib/orb/models/credit_note_list_params.rb +73 -0
  27. data/lib/orb/models/customer.rb +872 -0
  28. data/lib/orb/models/customer_create_params.rb +843 -0
  29. data/lib/orb/models/customer_delete_params.rb +19 -0
  30. data/lib/orb/models/customer_fetch_by_external_id_params.rb +19 -0
  31. data/lib/orb/models/customer_fetch_params.rb +19 -0
  32. data/lib/orb/models/customer_list_params.rb +73 -0
  33. data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +19 -0
  34. data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +19 -0
  35. data/lib/orb/models/customer_update_by_external_id_params.rb +848 -0
  36. data/lib/orb/models/customer_update_params.rb +838 -0
  37. data/lib/orb/models/customers/balance_transaction_create_params.rb +53 -0
  38. data/lib/orb/models/customers/balance_transaction_create_response.rb +167 -0
  39. data/lib/orb/models/customers/balance_transaction_list_params.rb +75 -0
  40. data/lib/orb/models/customers/balance_transaction_list_response.rb +167 -0
  41. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +69 -0
  42. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +106 -0
  43. data/lib/orb/models/customers/cost_list_params.rb +69 -0
  44. data/lib/orb/models/customers/cost_list_response.rb +106 -0
  45. data/lib/orb/models/customers/credit_list_by_external_id_params.rb +59 -0
  46. data/lib/orb/models/customers/credit_list_by_external_id_response.rb +72 -0
  47. data/lib/orb/models/customers/credit_list_params.rb +59 -0
  48. data/lib/orb/models/customers/credit_list_response.rb +72 -0
  49. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +215 -0
  50. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +1311 -0
  51. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +214 -0
  52. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +1310 -0
  53. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +141 -0
  54. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +1310 -0
  55. data/lib/orb/models/customers/credits/ledger_list_params.rb +141 -0
  56. data/lib/orb/models/customers/credits/ledger_list_response.rb +1306 -0
  57. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +159 -0
  58. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +154 -0
  59. data/lib/orb/models/customers/credits/top_up_create_params.rb +158 -0
  60. data/lib/orb/models/customers/credits/top_up_create_response.rb +153 -0
  61. data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +29 -0
  62. data/lib/orb/models/customers/credits/top_up_delete_params.rb +29 -0
  63. data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +42 -0
  64. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +154 -0
  65. data/lib/orb/models/customers/credits/top_up_list_params.rb +42 -0
  66. data/lib/orb/models/customers/credits/top_up_list_response.rb +153 -0
  67. data/lib/orb/models/dimensional_price_group.rb +64 -0
  68. data/lib/orb/models/dimensional_price_group_create_params.rb +63 -0
  69. data/lib/orb/models/dimensional_price_group_list_params.rb +38 -0
  70. data/lib/orb/models/dimensional_price_group_retrieve_params.rb +19 -0
  71. data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +21 -0
  72. data/lib/orb/models/dimensional_price_groups.rb +25 -0
  73. data/lib/orb/models/discount.rb +23 -0
  74. data/lib/orb/models/evaluate_price_group.rb +48 -0
  75. data/lib/orb/models/event_deprecate_params.rb +19 -0
  76. data/lib/orb/models/event_deprecate_response.rb +21 -0
  77. data/lib/orb/models/event_ingest_params.rb +100 -0
  78. data/lib/orb/models/event_ingest_response.rb +77 -0
  79. data/lib/orb/models/event_search_params.rb +45 -0
  80. data/lib/orb/models/event_search_response.rb +87 -0
  81. data/lib/orb/models/event_update_params.rb +58 -0
  82. data/lib/orb/models/event_update_response.rb +21 -0
  83. data/lib/orb/models/events/backfill_close_params.rb +21 -0
  84. data/lib/orb/models/events/backfill_close_response.rb +131 -0
  85. data/lib/orb/models/events/backfill_create_params.rb +97 -0
  86. data/lib/orb/models/events/backfill_create_response.rb +131 -0
  87. data/lib/orb/models/events/backfill_fetch_params.rb +21 -0
  88. data/lib/orb/models/events/backfill_fetch_response.rb +131 -0
  89. data/lib/orb/models/events/backfill_list_params.rb +40 -0
  90. data/lib/orb/models/events/backfill_list_response.rb +131 -0
  91. data/lib/orb/models/events/backfill_revert_params.rb +21 -0
  92. data/lib/orb/models/events/backfill_revert_response.rb +131 -0
  93. data/lib/orb/models/events/event_volumes.rb +54 -0
  94. data/lib/orb/models/events/volume_list_params.rb +64 -0
  95. data/lib/orb/models/invoice.rb +2218 -0
  96. data/lib/orb/models/invoice_create_params.rb +200 -0
  97. data/lib/orb/models/invoice_fetch_params.rb +19 -0
  98. data/lib/orb/models/invoice_fetch_upcoming_params.rb +25 -0
  99. data/lib/orb/models/invoice_fetch_upcoming_response.rb +2226 -0
  100. data/lib/orb/models/invoice_issue_params.rb +34 -0
  101. data/lib/orb/models/invoice_level_discount.rb +21 -0
  102. data/lib/orb/models/invoice_line_item_create_params.rb +62 -0
  103. data/lib/orb/models/invoice_line_item_create_response.rb +929 -0
  104. data/lib/orb/models/invoice_list_params.rb +197 -0
  105. data/lib/orb/models/invoice_mark_paid_params.rb +40 -0
  106. data/lib/orb/models/invoice_pay_params.rb +19 -0
  107. data/lib/orb/models/invoice_update_params.rb +28 -0
  108. data/lib/orb/models/invoice_void_params.rb +19 -0
  109. data/lib/orb/models/item.rb +82 -0
  110. data/lib/orb/models/item_create_params.rb +26 -0
  111. data/lib/orb/models/item_fetch_params.rb +19 -0
  112. data/lib/orb/models/item_list_params.rb +38 -0
  113. data/lib/orb/models/item_update_params.rb +73 -0
  114. data/lib/orb/models/metric_create_params.rb +56 -0
  115. data/lib/orb/models/metric_fetch_params.rb +19 -0
  116. data/lib/orb/models/metric_list_params.rb +73 -0
  117. data/lib/orb/models/metric_update_params.rb +28 -0
  118. data/lib/orb/models/pagination_metadata.rb +25 -0
  119. data/lib/orb/models/percentage_discount.rb +54 -0
  120. data/lib/orb/models/plan.rb +894 -0
  121. data/lib/orb/models/plan_create_params.rb +6702 -0
  122. data/lib/orb/models/plan_fetch_params.rb +19 -0
  123. data/lib/orb/models/plan_list_params.rb +100 -0
  124. data/lib/orb/models/plan_update_params.rb +37 -0
  125. data/lib/orb/models/plans/external_plan_id_fetch_params.rb +21 -0
  126. data/lib/orb/models/plans/external_plan_id_update_params.rb +39 -0
  127. data/lib/orb/models/price.rb +12229 -0
  128. data/lib/orb/models/price_create_params.rb +808 -0
  129. data/lib/orb/models/price_evaluate_params.rb +80 -0
  130. data/lib/orb/models/price_evaluate_response.rb +20 -0
  131. data/lib/orb/models/price_fetch_params.rb +19 -0
  132. data/lib/orb/models/price_list_params.rb +38 -0
  133. data/lib/orb/models/price_update_params.rb +28 -0
  134. data/lib/orb/models/prices/external_price_id_fetch_params.rb +21 -0
  135. data/lib/orb/models/prices/external_price_id_update_params.rb +30 -0
  136. data/lib/orb/models/subscription.rb +1233 -0
  137. data/lib/orb/models/subscription_cancel_params.rb +58 -0
  138. data/lib/orb/models/subscription_cancel_response.rb +1217 -0
  139. data/lib/orb/models/subscription_create_params.rb +15065 -0
  140. data/lib/orb/models/subscription_create_response.rb +1217 -0
  141. data/lib/orb/models/subscription_fetch_costs_params.rb +67 -0
  142. data/lib/orb/models/subscription_fetch_costs_response.rb +104 -0
  143. data/lib/orb/models/subscription_fetch_params.rb +19 -0
  144. data/lib/orb/models/subscription_fetch_schedule_params.rb +73 -0
  145. data/lib/orb/models/subscription_fetch_schedule_response.rb +68 -0
  146. data/lib/orb/models/subscription_fetch_usage_params.rb +135 -0
  147. data/lib/orb/models/subscription_list_params.rb +108 -0
  148. data/lib/orb/models/subscription_price_intervals_params.rb +8358 -0
  149. data/lib/orb/models/subscription_price_intervals_response.rb +1224 -0
  150. data/lib/orb/models/subscription_schedule_plan_change_params.rb +15088 -0
  151. data/lib/orb/models/subscription_schedule_plan_change_response.rb +1224 -0
  152. data/lib/orb/models/subscription_trigger_phase_params.rb +36 -0
  153. data/lib/orb/models/subscription_trigger_phase_response.rb +1224 -0
  154. data/lib/orb/models/subscription_unschedule_cancellation_params.rb +19 -0
  155. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +1224 -0
  156. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +26 -0
  157. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +1228 -0
  158. data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +19 -0
  159. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +1224 -0
  160. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +90 -0
  161. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +1224 -0
  162. data/lib/orb/models/subscription_update_params.rb +74 -0
  163. data/lib/orb/models/subscription_update_trial_params.rb +59 -0
  164. data/lib/orb/models/subscription_update_trial_response.rb +1222 -0
  165. data/lib/orb/models/subscription_usage.rb +258 -0
  166. data/lib/orb/models/subscriptions.rb +25 -0
  167. data/lib/orb/models/top_level_ping_params.rb +19 -0
  168. data/lib/orb/models/top_level_ping_response.rb +20 -0
  169. data/lib/orb/models/trial_discount.rb +69 -0
  170. data/lib/orb/models/usage_discount.rb +54 -0
  171. data/lib/orb/page.rb +114 -0
  172. data/lib/orb/request_options.rb +75 -0
  173. data/lib/orb/resources/alerts.rb +239 -0
  174. data/lib/orb/resources/coupons/subscriptions.rb +43 -0
  175. data/lib/orb/resources/coupons.rb +115 -0
  176. data/lib/orb/resources/credit_notes.rb +87 -0
  177. data/lib/orb/resources/customers/balance_transactions.rb +96 -0
  178. data/lib/orb/resources/customers/costs.rb +298 -0
  179. data/lib/orb/resources/customers/credits/ledger.rb +527 -0
  180. data/lib/orb/resources/customers/credits/top_ups.rb +192 -0
  181. data/lib/orb/resources/customers/credits.rb +88 -0
  182. data/lib/orb/resources/customers.rb +321 -0
  183. data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +38 -0
  184. data/lib/orb/resources/dimensional_price_groups.rb +93 -0
  185. data/lib/orb/resources/events/backfills.rb +174 -0
  186. data/lib/orb/resources/events/volume.rb +52 -0
  187. data/lib/orb/resources/events.rb +415 -0
  188. data/lib/orb/resources/invoice_line_items.rb +41 -0
  189. data/lib/orb/resources/invoices.rb +266 -0
  190. data/lib/orb/resources/items.rb +95 -0
  191. data/lib/orb/resources/metrics.rb +114 -0
  192. data/lib/orb/resources/plans/external_plan_id.rb +76 -0
  193. data/lib/orb/resources/plans.rb +133 -0
  194. data/lib/orb/resources/prices/external_price_id.rb +61 -0
  195. data/lib/orb/resources/prices.rb +197 -0
  196. data/lib/orb/resources/subscriptions.rb +1278 -0
  197. data/lib/orb/resources/top_level.rb +37 -0
  198. data/lib/orb/transport/base_client.rb +459 -0
  199. data/lib/orb/transport/pooled_net_requester.rb +182 -0
  200. data/lib/orb/type/array_of.rb +112 -0
  201. data/lib/orb/type/base_model.rb +367 -0
  202. data/lib/orb/type/base_page.rb +61 -0
  203. data/lib/orb/type/boolean_model.rb +52 -0
  204. data/lib/orb/type/converter.rb +217 -0
  205. data/lib/orb/type/enum.rb +101 -0
  206. data/lib/orb/type/hash_of.rb +132 -0
  207. data/lib/orb/type/request_parameters.rb +38 -0
  208. data/lib/orb/type/union.rb +225 -0
  209. data/lib/orb/type/unknown.rb +56 -0
  210. data/lib/orb/type.rb +23 -0
  211. data/lib/orb/util.rb +722 -0
  212. data/lib/orb/version.rb +5 -0
  213. data/lib/orb.rb +247 -0
  214. data/manifest.yaml +15 -0
  215. data/rbi/lib/orb/client.rbi +90 -0
  216. data/rbi/lib/orb/errors.rbi +246 -0
  217. data/rbi/lib/orb/models/alert.rbi +239 -0
  218. data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +86 -0
  219. data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +88 -0
  220. data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +83 -0
  221. data/rbi/lib/orb/models/alert_disable_params.rbi +28 -0
  222. data/rbi/lib/orb/models/alert_enable_params.rbi +28 -0
  223. data/rbi/lib/orb/models/alert_list_params.rbi +95 -0
  224. data/rbi/lib/orb/models/alert_retrieve_params.rbi +20 -0
  225. data/rbi/lib/orb/models/alert_update_params.rbi +51 -0
  226. data/rbi/lib/orb/models/amount_discount.rbi +62 -0
  227. data/rbi/lib/orb/models/billable_metric.rbi +83 -0
  228. data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +19 -0
  229. data/rbi/lib/orb/models/coupon.rbi +90 -0
  230. data/rbi/lib/orb/models/coupon_archive_params.rbi +20 -0
  231. data/rbi/lib/orb/models/coupon_create_params.rbi +120 -0
  232. data/rbi/lib/orb/models/coupon_fetch_params.rbi +20 -0
  233. data/rbi/lib/orb/models/coupon_list_params.rbi +59 -0
  234. data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +41 -0
  235. data/rbi/lib/orb/models/credit_note.rbi +546 -0
  236. data/rbi/lib/orb/models/credit_note_create_params.rbi +84 -0
  237. data/rbi/lib/orb/models/credit_note_fetch_params.rbi +20 -0
  238. data/rbi/lib/orb/models/credit_note_list_params.rbi +74 -0
  239. data/rbi/lib/orb/models/customer.rbi +941 -0
  240. data/rbi/lib/orb/models/customer_create_params.rbi +923 -0
  241. data/rbi/lib/orb/models/customer_delete_params.rbi +20 -0
  242. data/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi +20 -0
  243. data/rbi/lib/orb/models/customer_fetch_params.rbi +20 -0
  244. data/rbi/lib/orb/models/customer_list_params.rbi +74 -0
  245. data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +20 -0
  246. data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +20 -0
  247. data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +945 -0
  248. data/rbi/lib/orb/models/customer_update_params.rbi +919 -0
  249. data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +64 -0
  250. data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +199 -0
  251. data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +76 -0
  252. data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +191 -0
  253. data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +86 -0
  254. data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +214 -0
  255. data/rbi/lib/orb/models/customers/cost_list_params.rbi +84 -0
  256. data/rbi/lib/orb/models/customers/cost_list_response.rbi +212 -0
  257. data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +64 -0
  258. data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +87 -0
  259. data/rbi/lib/orb/models/customers/credit_list_params.rbi +64 -0
  260. data/rbi/lib/orb/models/customers/credit_list_response.rbi +86 -0
  261. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +270 -0
  262. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +1670 -0
  263. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +238 -0
  264. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +1626 -0
  265. data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +181 -0
  266. data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +1654 -0
  267. data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +144 -0
  268. data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +1588 -0
  269. data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +196 -0
  270. data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +198 -0
  271. data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +176 -0
  272. data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +175 -0
  273. data/rbi/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +31 -0
  274. data/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi +28 -0
  275. data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +49 -0
  276. data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +188 -0
  277. data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +49 -0
  278. data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +168 -0
  279. data/rbi/lib/orb/models/dimensional_price_group.rbi +75 -0
  280. data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +66 -0
  281. data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +39 -0
  282. data/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi +20 -0
  283. data/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +22 -0
  284. data/rbi/lib/orb/models/dimensional_price_groups.rbi +35 -0
  285. data/rbi/lib/orb/models/discount.rbi +18 -0
  286. data/rbi/lib/orb/models/evaluate_price_group.rbi +45 -0
  287. data/rbi/lib/orb/models/event_deprecate_params.rbi +20 -0
  288. data/rbi/lib/orb/models/event_deprecate_response.rbi +19 -0
  289. data/rbi/lib/orb/models/event_ingest_params.rbi +120 -0
  290. data/rbi/lib/orb/models/event_ingest_response.rbi +79 -0
  291. data/rbi/lib/orb/models/event_search_params.rbi +53 -0
  292. data/rbi/lib/orb/models/event_search_response.rbi +100 -0
  293. data/rbi/lib/orb/models/event_update_params.rbi +71 -0
  294. data/rbi/lib/orb/models/event_update_response.rbi +19 -0
  295. data/rbi/lib/orb/models/events/backfill_close_params.rbi +22 -0
  296. data/rbi/lib/orb/models/events/backfill_close_response.rbi +127 -0
  297. data/rbi/lib/orb/models/events/backfill_create_params.rbi +97 -0
  298. data/rbi/lib/orb/models/events/backfill_create_response.rbi +128 -0
  299. data/rbi/lib/orb/models/events/backfill_fetch_params.rbi +22 -0
  300. data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +127 -0
  301. data/rbi/lib/orb/models/events/backfill_list_params.rbi +41 -0
  302. data/rbi/lib/orb/models/events/backfill_list_response.rbi +127 -0
  303. data/rbi/lib/orb/models/events/backfill_revert_params.rbi +22 -0
  304. data/rbi/lib/orb/models/events/backfill_revert_response.rbi +128 -0
  305. data/rbi/lib/orb/models/events/event_volumes.rbi +47 -0
  306. data/rbi/lib/orb/models/events/volume_list_params.rbi +69 -0
  307. data/rbi/lib/orb/models/invoice.rbi +2466 -0
  308. data/rbi/lib/orb/models/invoice_create_params.rbi +230 -0
  309. data/rbi/lib/orb/models/invoice_fetch_params.rbi +20 -0
  310. data/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi +24 -0
  311. data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +2646 -0
  312. data/rbi/lib/orb/models/invoice_issue_params.rbi +32 -0
  313. data/rbi/lib/orb/models/invoice_level_discount.rbi +16 -0
  314. data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +67 -0
  315. data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +1164 -0
  316. data/rbi/lib/orb/models/invoice_list_params.rbi +187 -0
  317. data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +48 -0
  318. data/rbi/lib/orb/models/invoice_pay_params.rbi +20 -0
  319. data/rbi/lib/orb/models/invoice_update_params.rbi +36 -0
  320. data/rbi/lib/orb/models/invoice_void_params.rbi +20 -0
  321. data/rbi/lib/orb/models/item.rbi +101 -0
  322. data/rbi/lib/orb/models/item_create_params.rbi +25 -0
  323. data/rbi/lib/orb/models/item_fetch_params.rbi +20 -0
  324. data/rbi/lib/orb/models/item_list_params.rbi +39 -0
  325. data/rbi/lib/orb/models/item_update_params.rbi +113 -0
  326. data/rbi/lib/orb/models/metric_create_params.rbi +62 -0
  327. data/rbi/lib/orb/models/metric_fetch_params.rbi +20 -0
  328. data/rbi/lib/orb/models/metric_list_params.rbi +74 -0
  329. data/rbi/lib/orb/models/metric_update_params.rbi +36 -0
  330. data/rbi/lib/orb/models/pagination_metadata.rbi +21 -0
  331. data/rbi/lib/orb/models/percentage_discount.rbi +63 -0
  332. data/rbi/lib/orb/models/plan.rbi +1071 -0
  333. data/rbi/lib/orb/models/plan_create_params.rbi +10069 -0
  334. data/rbi/lib/orb/models/plan_fetch_params.rbi +20 -0
  335. data/rbi/lib/orb/models/plan_list_params.rbi +100 -0
  336. data/rbi/lib/orb/models/plan_update_params.rbi +46 -0
  337. data/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi +22 -0
  338. data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +48 -0
  339. data/rbi/lib/orb/models/price.rbi +15341 -0
  340. data/rbi/lib/orb/models/price_create_params.rbi +885 -0
  341. data/rbi/lib/orb/models/price_evaluate_params.rbi +81 -0
  342. data/rbi/lib/orb/models/price_evaluate_response.rbi +21 -0
  343. data/rbi/lib/orb/models/price_fetch_params.rbi +20 -0
  344. data/rbi/lib/orb/models/price_list_params.rbi +39 -0
  345. data/rbi/lib/orb/models/price_update_params.rbi +36 -0
  346. data/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi +22 -0
  347. data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +38 -0
  348. data/rbi/lib/orb/models/subscription.rbi +1381 -0
  349. data/rbi/lib/orb/models/subscription_cancel_params.rbi +75 -0
  350. data/rbi/lib/orb/models/subscription_cancel_response.rbi +1374 -0
  351. data/rbi/lib/orb/models/subscription_create_params.rbi +23422 -0
  352. data/rbi/lib/orb/models/subscription_create_response.rbi +1374 -0
  353. data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +82 -0
  354. data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +210 -0
  355. data/rbi/lib/orb/models/subscription_fetch_params.rbi +20 -0
  356. data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +74 -0
  357. data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +81 -0
  358. data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +137 -0
  359. data/rbi/lib/orb/models/subscription_list_params.rbi +108 -0
  360. data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +12991 -0
  361. data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +1387 -0
  362. data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +23589 -0
  363. data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +1390 -0
  364. data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +45 -0
  365. data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +1381 -0
  366. data/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi +20 -0
  367. data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +1400 -0
  368. data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +25 -0
  369. data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +1451 -0
  370. data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +20 -0
  371. data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +1410 -0
  372. data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +104 -0
  373. data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +1400 -0
  374. data/rbi/lib/orb/models/subscription_update_params.rbi +77 -0
  375. data/rbi/lib/orb/models/subscription_update_trial_params.rbi +63 -0
  376. data/rbi/lib/orb/models/subscription_update_trial_response.rbi +1378 -0
  377. data/rbi/lib/orb/models/subscription_usage.rbi +323 -0
  378. data/rbi/lib/orb/models/subscriptions.rbi +33 -0
  379. data/rbi/lib/orb/models/top_level_ping_params.rbi +20 -0
  380. data/rbi/lib/orb/models/top_level_ping_response.rbi +18 -0
  381. data/rbi/lib/orb/models/trial_discount.rbi +73 -0
  382. data/rbi/lib/orb/models/usage_discount.rbi +62 -0
  383. data/rbi/lib/orb/page.rbi +35 -0
  384. data/rbi/lib/orb/request_options.rbi +48 -0
  385. data/rbi/lib/orb/resources/alerts.rbi +216 -0
  386. data/rbi/lib/orb/resources/coupons/subscriptions.rbi +38 -0
  387. data/rbi/lib/orb/resources/coupons.rbi +96 -0
  388. data/rbi/lib/orb/resources/credit_notes.rbi +74 -0
  389. data/rbi/lib/orb/resources/customers/balance_transactions.rbi +92 -0
  390. data/rbi/lib/orb/resources/customers/costs.rbi +304 -0
  391. data/rbi/lib/orb/resources/customers/credits/ledger.rbi +645 -0
  392. data/rbi/lib/orb/resources/customers/credits/top_ups.rbi +180 -0
  393. data/rbi/lib/orb/resources/customers/credits.rbi +88 -0
  394. data/rbi/lib/orb/resources/customers.rbi +714 -0
  395. data/rbi/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +25 -0
  396. data/rbi/lib/orb/resources/dimensional_price_groups.rbi +78 -0
  397. data/rbi/lib/orb/resources/events/backfills.rbi +161 -0
  398. data/rbi/lib/orb/resources/events/volume.rbi +57 -0
  399. data/rbi/lib/orb/resources/events.rbi +408 -0
  400. data/rbi/lib/orb/resources/invoice_line_items.rbi +44 -0
  401. data/rbi/lib/orb/resources/invoices.rbi +262 -0
  402. data/rbi/lib/orb/resources/items.rbi +65 -0
  403. data/rbi/lib/orb/resources/metrics.rbi +102 -0
  404. data/rbi/lib/orb/resources/plans/external_plan_id.rbi +67 -0
  405. data/rbi/lib/orb/resources/plans.rbi +170 -0
  406. data/rbi/lib/orb/resources/prices/external_price_id.rbi +110 -0
  407. data/rbi/lib/orb/resources/prices.rbi +371 -0
  408. data/rbi/lib/orb/resources/subscriptions.rbi +1469 -0
  409. data/rbi/lib/orb/resources/top_level.rbi +25 -0
  410. data/rbi/lib/orb/transport/base_client.rbi +205 -0
  411. data/rbi/lib/orb/transport/pooled_net_requester.rbi +64 -0
  412. data/rbi/lib/orb/type/array_of.rbi +82 -0
  413. data/rbi/lib/orb/type/base_model.rbi +197 -0
  414. data/rbi/lib/orb/type/base_page.rbi +38 -0
  415. data/rbi/lib/orb/type/boolean_model.rbi +41 -0
  416. data/rbi/lib/orb/type/converter.rbi +95 -0
  417. data/rbi/lib/orb/type/enum.rbi +58 -0
  418. data/rbi/lib/orb/type/hash_of.rbi +86 -0
  419. data/rbi/lib/orb/type/request_parameters.rbi +20 -0
  420. data/rbi/lib/orb/type/union.rbi +66 -0
  421. data/rbi/lib/orb/type/unknown.rbi +37 -0
  422. data/rbi/lib/orb/type.rbi +23 -0
  423. data/rbi/lib/orb/util.rbi +278 -0
  424. data/rbi/lib/orb/version.rbi +5 -0
  425. data/sig/orb/client.rbs +53 -0
  426. data/sig/orb/errors.rbs +201 -0
  427. data/sig/orb/models/alert.rbs +142 -0
  428. data/sig/orb/models/alert_create_for_customer_params.rbs +56 -0
  429. data/sig/orb/models/alert_create_for_external_customer_params.rbs +56 -0
  430. data/sig/orb/models/alert_create_for_subscription_params.rbs +52 -0
  431. data/sig/orb/models/alert_disable_params.rbs +20 -0
  432. data/sig/orb/models/alert_enable_params.rbs +20 -0
  433. data/sig/orb/models/alert_list_params.rbs +57 -0
  434. data/sig/orb/models/alert_retrieve_params.rbs +14 -0
  435. data/sig/orb/models/alert_update_params.rbs +31 -0
  436. data/sig/orb/models/amount_discount.rbs +40 -0
  437. data/sig/orb/models/billable_metric.rbs +50 -0
  438. data/sig/orb/models/billing_cycle_relative_date.rbs +14 -0
  439. data/sig/orb/models/coupon.rbs +51 -0
  440. data/sig/orb/models/coupon_archive_params.rbs +14 -0
  441. data/sig/orb/models/coupon_create_params.rbs +77 -0
  442. data/sig/orb/models/coupon_fetch_params.rbs +14 -0
  443. data/sig/orb/models/coupon_list_params.rbs +37 -0
  444. data/sig/orb/models/coupons/subscription_list_params.rbs +27 -0
  445. data/sig/orb/models/credit_note.rbs +345 -0
  446. data/sig/orb/models/credit_note_create_params.rbs +57 -0
  447. data/sig/orb/models/credit_note_fetch_params.rbs +14 -0
  448. data/sig/orb/models/credit_note_list_params.rbs +45 -0
  449. data/sig/orb/models/customer.rbs +628 -0
  450. data/sig/orb/models/customer_create_params.rbs +624 -0
  451. data/sig/orb/models/customer_delete_params.rbs +14 -0
  452. data/sig/orb/models/customer_fetch_by_external_id_params.rbs +14 -0
  453. data/sig/orb/models/customer_fetch_params.rbs +14 -0
  454. data/sig/orb/models/customer_list_params.rbs +45 -0
  455. data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +15 -0
  456. data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +15 -0
  457. data/sig/orb/models/customer_update_by_external_id_params.rbs +620 -0
  458. data/sig/orb/models/customer_update_params.rbs +620 -0
  459. data/sig/orb/models/customers/balance_transaction_create_params.rbs +44 -0
  460. data/sig/orb/models/customers/balance_transaction_create_response.rbs +114 -0
  461. data/sig/orb/models/customers/balance_transaction_list_params.rbs +47 -0
  462. data/sig/orb/models/customers/balance_transaction_list_response.rbs +114 -0
  463. data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +48 -0
  464. data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +82 -0
  465. data/sig/orb/models/customers/cost_list_params.rbs +48 -0
  466. data/sig/orb/models/customers/cost_list_response.rbs +80 -0
  467. data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +41 -0
  468. data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +55 -0
  469. data/sig/orb/models/customers/credit_list_params.rbs +41 -0
  470. data/sig/orb/models/customers/credit_list_response.rbs +55 -0
  471. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +120 -0
  472. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +814 -0
  473. data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +120 -0
  474. data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +814 -0
  475. data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +99 -0
  476. data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +814 -0
  477. data/sig/orb/models/customers/credits/ledger_list_params.rbs +99 -0
  478. data/sig/orb/models/customers/credits/ledger_list_response.rbs +814 -0
  479. data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +95 -0
  480. data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +90 -0
  481. data/sig/orb/models/customers/credits/top_up_create_params.rbs +95 -0
  482. data/sig/orb/models/customers/credits/top_up_create_response.rbs +90 -0
  483. data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +24 -0
  484. data/sig/orb/models/customers/credits/top_up_delete_params.rbs +24 -0
  485. data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +29 -0
  486. data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +90 -0
  487. data/sig/orb/models/customers/credits/top_up_list_params.rbs +29 -0
  488. data/sig/orb/models/customers/credits/top_up_list_response.rbs +90 -0
  489. data/sig/orb/models/dimensional_price_group.rbs +38 -0
  490. data/sig/orb/models/dimensional_price_group_create_params.rbs +39 -0
  491. data/sig/orb/models/dimensional_price_group_list_params.rbs +25 -0
  492. data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +15 -0
  493. data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +17 -0
  494. data/sig/orb/models/dimensional_price_groups.rbs +22 -0
  495. data/sig/orb/models/discount.rbs +15 -0
  496. data/sig/orb/models/evaluate_price_group.rbs +34 -0
  497. data/sig/orb/models/event_deprecate_params.rbs +14 -0
  498. data/sig/orb/models/event_deprecate_response.rbs +13 -0
  499. data/sig/orb/models/event_ingest_params.rbs +68 -0
  500. data/sig/orb/models/event_ingest_response.rbs +53 -0
  501. data/sig/orb/models/event_search_params.rbs +31 -0
  502. data/sig/orb/models/event_search_response.rbs +55 -0
  503. data/sig/orb/models/event_update_params.rbs +39 -0
  504. data/sig/orb/models/event_update_response.rbs +13 -0
  505. data/sig/orb/models/events/backfill_close_params.rbs +16 -0
  506. data/sig/orb/models/events/backfill_close_response.rbs +73 -0
  507. data/sig/orb/models/events/backfill_create_params.rbs +51 -0
  508. data/sig/orb/models/events/backfill_create_response.rbs +73 -0
  509. data/sig/orb/models/events/backfill_fetch_params.rbs +16 -0
  510. data/sig/orb/models/events/backfill_fetch_response.rbs +73 -0
  511. data/sig/orb/models/events/backfill_list_params.rbs +27 -0
  512. data/sig/orb/models/events/backfill_list_response.rbs +73 -0
  513. data/sig/orb/models/events/backfill_revert_params.rbs +16 -0
  514. data/sig/orb/models/events/backfill_revert_response.rbs +73 -0
  515. data/sig/orb/models/events/event_volumes.rbs +39 -0
  516. data/sig/orb/models/events/volume_list_params.rbs +41 -0
  517. data/sig/orb/models/invoice.rbs +1430 -0
  518. data/sig/orb/models/invoice_create_params.rbs +120 -0
  519. data/sig/orb/models/invoice_fetch_params.rbs +14 -0
  520. data/sig/orb/models/invoice_fetch_upcoming_params.rbs +20 -0
  521. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +1430 -0
  522. data/sig/orb/models/invoice_issue_params.rbs +21 -0
  523. data/sig/orb/models/invoice_level_discount.rbs +14 -0
  524. data/sig/orb/models/invoice_line_item_create_params.rbs +43 -0
  525. data/sig/orb/models/invoice_line_item_create_response.rbs +546 -0
  526. data/sig/orb/models/invoice_list_params.rbs +122 -0
  527. data/sig/orb/models/invoice_mark_paid_params.rbs +27 -0
  528. data/sig/orb/models/invoice_pay_params.rbs +14 -0
  529. data/sig/orb/models/invoice_update_params.rbs +20 -0
  530. data/sig/orb/models/invoice_void_params.rbs +14 -0
  531. data/sig/orb/models/item.rbs +72 -0
  532. data/sig/orb/models/item_create_params.rbs +19 -0
  533. data/sig/orb/models/item_fetch_params.rbs +14 -0
  534. data/sig/orb/models/item_list_params.rbs +25 -0
  535. data/sig/orb/models/item_update_params.rbs +69 -0
  536. data/sig/orb/models/metric_create_params.rbs +39 -0
  537. data/sig/orb/models/metric_fetch_params.rbs +14 -0
  538. data/sig/orb/models/metric_list_params.rbs +45 -0
  539. data/sig/orb/models/metric_update_params.rbs +20 -0
  540. data/sig/orb/models/pagination_metadata.rbs +15 -0
  541. data/sig/orb/models/percentage_discount.rbs +40 -0
  542. data/sig/orb/models/plan.rbs +529 -0
  543. data/sig/orb/models/plan_create_params.rbs +3991 -0
  544. data/sig/orb/models/plan_fetch_params.rbs +14 -0
  545. data/sig/orb/models/plan_list_params.rbs +65 -0
  546. data/sig/orb/models/plan_update_params.rbs +24 -0
  547. data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +16 -0
  548. data/sig/orb/models/plans/external_plan_id_update_params.rbs +26 -0
  549. data/sig/orb/models/price.rbs +8108 -0
  550. data/sig/orb/models/price_create_params.rbs +520 -0
  551. data/sig/orb/models/price_evaluate_params.rbs +45 -0
  552. data/sig/orb/models/price_evaluate_response.rbs +14 -0
  553. data/sig/orb/models/price_fetch_params.rbs +14 -0
  554. data/sig/orb/models/price_list_params.rbs +25 -0
  555. data/sig/orb/models/price_update_params.rbs +20 -0
  556. data/sig/orb/models/prices/external_price_id_fetch_params.rbs +16 -0
  557. data/sig/orb/models/prices/external_price_id_update_params.rbs +22 -0
  558. data/sig/orb/models/subscription.rbs +687 -0
  559. data/sig/orb/models/subscription_cancel_params.rbs +44 -0
  560. data/sig/orb/models/subscription_cancel_response.rbs +687 -0
  561. data/sig/orb/models/subscription_create_params.rbs +9141 -0
  562. data/sig/orb/models/subscription_create_response.rbs +687 -0
  563. data/sig/orb/models/subscription_fetch_costs_params.rbs +46 -0
  564. data/sig/orb/models/subscription_fetch_costs_response.rbs +78 -0
  565. data/sig/orb/models/subscription_fetch_params.rbs +14 -0
  566. data/sig/orb/models/subscription_fetch_schedule_params.rbs +45 -0
  567. data/sig/orb/models/subscription_fetch_schedule_response.rbs +48 -0
  568. data/sig/orb/models/subscription_fetch_usage_params.rbs +80 -0
  569. data/sig/orb/models/subscription_list_params.rbs +69 -0
  570. data/sig/orb/models/subscription_price_intervals_params.rbs +5117 -0
  571. data/sig/orb/models/subscription_price_intervals_response.rbs +687 -0
  572. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +9133 -0
  573. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +687 -0
  574. data/sig/orb/models/subscription_trigger_phase_params.rbs +24 -0
  575. data/sig/orb/models/subscription_trigger_phase_response.rbs +687 -0
  576. data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +15 -0
  577. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +687 -0
  578. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +20 -0
  579. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +687 -0
  580. data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +15 -0
  581. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +687 -0
  582. data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +55 -0
  583. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +687 -0
  584. data/sig/orb/models/subscription_update_params.rbs +39 -0
  585. data/sig/orb/models/subscription_update_trial_params.rbs +39 -0
  586. data/sig/orb/models/subscription_update_trial_response.rbs +687 -0
  587. data/sig/orb/models/subscription_usage.rbs +196 -0
  588. data/sig/orb/models/subscriptions.rbs +22 -0
  589. data/sig/orb/models/top_level_ping_params.rbs +14 -0
  590. data/sig/orb/models/top_level_ping_response.rbs +13 -0
  591. data/sig/orb/models/trial_discount.rbs +44 -0
  592. data/sig/orb/models/usage_discount.rbs +40 -0
  593. data/sig/orb/page.rbs +22 -0
  594. data/sig/orb/request_options.rbs +32 -0
  595. data/sig/orb/resources/alerts.rbs +67 -0
  596. data/sig/orb/resources/coupons/subscriptions.rbs +16 -0
  597. data/sig/orb/resources/coupons.rbs +35 -0
  598. data/sig/orb/resources/credit_notes.rbs +29 -0
  599. data/sig/orb/resources/customers/balance_transactions.rbs +28 -0
  600. data/sig/orb/resources/customers/costs.rbs +27 -0
  601. data/sig/orb/resources/customers/credits/ledger.rbs +75 -0
  602. data/sig/orb/resources/customers/credits/top_ups.rbs +63 -0
  603. data/sig/orb/resources/customers/credits.rbs +31 -0
  604. data/sig/orb/resources/customers.rbs +114 -0
  605. data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +14 -0
  606. data/sig/orb/resources/dimensional_price_groups.rbs +29 -0
  607. data/sig/orb/resources/events/backfills.rbs +41 -0
  608. data/sig/orb/resources/events/volume.rbs +17 -0
  609. data/sig/orb/resources/events.rbs +40 -0
  610. data/sig/orb/resources/invoice_line_items.rbs +17 -0
  611. data/sig/orb/resources/invoices.rbs +84 -0
  612. data/sig/orb/resources/items.rbs +30 -0
  613. data/sig/orb/resources/metrics.rbs +37 -0
  614. data/sig/orb/resources/plans/external_plan_id.rbs +21 -0
  615. data/sig/orb/resources/plans.rbs +44 -0
  616. data/sig/orb/resources/prices/external_price_id.rbs +20 -0
  617. data/sig/orb/resources/prices.rbs +83 -0
  618. data/sig/orb/resources/subscriptions.rbs +194 -0
  619. data/sig/orb/resources/top_level.rbs +11 -0
  620. data/sig/orb/transport/base_client.rbs +110 -0
  621. data/sig/orb/transport/pooled_net_requester.rbs +39 -0
  622. data/sig/orb/type/array_of.rbs +36 -0
  623. data/sig/orb/type/base_model.rbs +77 -0
  624. data/sig/orb/type/base_page.rbs +22 -0
  625. data/sig/orb/type/boolean_model.rbs +18 -0
  626. data/sig/orb/type/converter.rbs +36 -0
  627. data/sig/orb/type/enum.rbs +22 -0
  628. data/sig/orb/type/hash_of.rbs +36 -0
  629. data/sig/orb/type/request_parameters.rbs +13 -0
  630. data/sig/orb/type/union.rbs +37 -0
  631. data/sig/orb/type/unknown.rbs +15 -0
  632. data/sig/orb/type.rbs +22 -0
  633. data/sig/orb/util.rbs +132 -0
  634. data/sig/orb/version.rbs +3 -0
  635. metadata +692 -0
@@ -0,0 +1,838 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Orb
4
+ module Models
5
+ # @see Orb::Resources::Customers#update
6
+ class CustomerUpdateParams < Orb::BaseModel
7
+ # @!parse
8
+ # extend Orb::Type::RequestParameters::Converter
9
+ include Orb::RequestParameters
10
+
11
+ # @!attribute accounting_sync_configuration
12
+ #
13
+ # @return [Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration, nil]
14
+ optional :accounting_sync_configuration,
15
+ -> { Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration },
16
+ nil?: true
17
+
18
+ # @!attribute additional_emails
19
+ # Additional email addresses for this customer. If populated, these email
20
+ # addresses will be CC'd for customer communications.
21
+ #
22
+ # @return [Array<String>, nil]
23
+ optional :additional_emails, Orb::ArrayOf[String], nil?: true
24
+
25
+ # @!attribute auto_collection
26
+ # Used to determine if invoices for this customer will automatically attempt to
27
+ # charge a saved payment method, if available. This parameter defaults to `True`
28
+ # when a payment provider is provided on customer creation.
29
+ #
30
+ # @return [Boolean, nil]
31
+ optional :auto_collection, Orb::BooleanModel, nil?: true
32
+
33
+ # @!attribute billing_address
34
+ #
35
+ # @return [Orb::Models::CustomerUpdateParams::BillingAddress, nil]
36
+ optional :billing_address, -> { Orb::Models::CustomerUpdateParams::BillingAddress }, nil?: true
37
+
38
+ # @!attribute currency
39
+ # An ISO 4217 currency string used for the customer's invoices and balance. If not
40
+ # set at creation time, will be set at subscription creation time.
41
+ #
42
+ # @return [String, nil]
43
+ optional :currency, String, nil?: true
44
+
45
+ # @!attribute email
46
+ # A valid customer email, to be used for invoicing and notifications.
47
+ #
48
+ # @return [String, nil]
49
+ optional :email, String, nil?: true
50
+
51
+ # @!attribute email_delivery
52
+ #
53
+ # @return [Boolean, nil]
54
+ optional :email_delivery, Orb::BooleanModel, nil?: true
55
+
56
+ # @!attribute external_customer_id
57
+ # The external customer ID. This can only be set if empty and the customer has no
58
+ # past or current subscriptions.
59
+ #
60
+ # @return [String, nil]
61
+ optional :external_customer_id, String, nil?: true
62
+
63
+ # @!attribute hierarchy
64
+ # The hierarchical relationships for this customer.
65
+ #
66
+ # @return [Orb::Models::CustomerUpdateParams::Hierarchy, nil]
67
+ optional :hierarchy, -> { Orb::Models::CustomerUpdateParams::Hierarchy }, nil?: true
68
+
69
+ # @!attribute metadata
70
+ # User-specified key/value pairs for the resource. Individual keys can be removed
71
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
72
+ # by setting `metadata` to `null`.
73
+ #
74
+ # @return [Hash{Symbol=>String, nil}, nil]
75
+ optional :metadata, Orb::HashOf[String, nil?: true], nil?: true
76
+
77
+ # @!attribute name
78
+ # The full name of the customer
79
+ #
80
+ # @return [String, nil]
81
+ optional :name, String, nil?: true
82
+
83
+ # @!attribute payment_provider
84
+ # This is used for creating charges or invoices in an external system via Orb.
85
+ # When not in test mode:
86
+ #
87
+ # - the connection must first be configured in the Orb webapp.
88
+ # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`,
89
+ # `bill.com`, `netsuite`), any product mappings must first be configured with
90
+ # the Orb team.
91
+ #
92
+ # @return [Symbol, Orb::Models::CustomerUpdateParams::PaymentProvider, nil]
93
+ optional :payment_provider, enum: -> { Orb::Models::CustomerUpdateParams::PaymentProvider }, nil?: true
94
+
95
+ # @!attribute payment_provider_id
96
+ # The ID of this customer in an external payments solution, such as Stripe. This
97
+ # is used for creating charges or invoices in the external system via Orb.
98
+ #
99
+ # @return [String, nil]
100
+ optional :payment_provider_id, String, nil?: true
101
+
102
+ # @!attribute reporting_configuration
103
+ #
104
+ # @return [Orb::Models::CustomerUpdateParams::ReportingConfiguration, nil]
105
+ optional :reporting_configuration,
106
+ -> { Orb::Models::CustomerUpdateParams::ReportingConfiguration },
107
+ nil?: true
108
+
109
+ # @!attribute shipping_address
110
+ #
111
+ # @return [Orb::Models::CustomerUpdateParams::ShippingAddress, nil]
112
+ optional :shipping_address, -> { Orb::Models::CustomerUpdateParams::ShippingAddress }, nil?: true
113
+
114
+ # @!attribute tax_configuration
115
+ #
116
+ # @return [Orb::Models::CustomerUpdateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateParams::TaxConfiguration::NewTaxJarConfiguration, nil]
117
+ optional :tax_configuration, union: -> { Orb::Models::CustomerUpdateParams::TaxConfiguration }, nil?: true
118
+
119
+ # @!attribute tax_id
120
+ # Tax IDs are commonly required to be displayed on customer invoices, which are
121
+ # added to the headers of invoices.
122
+ #
123
+ # ### Supported Tax ID Countries and Types
124
+ #
125
+ # | Country | Type | Description |
126
+ # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
127
+ # | Andorra | `ad_nrt` | Andorran NRT Number |
128
+ # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
129
+ # | Australia | `au_abn` | Australian Business Number (AU ABN) |
130
+ # | Australia | `au_arn` | Australian Taxation Office Reference Number |
131
+ # | Austria | `eu_vat` | European VAT Number |
132
+ # | Bahrain | `bh_vat` | Bahraini VAT Number |
133
+ # | Belgium | `eu_vat` | European VAT Number |
134
+ # | Bolivia | `bo_tin` | Bolivian Tax ID |
135
+ # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
136
+ # | Brazil | `br_cpf` | Brazilian CPF Number |
137
+ # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
138
+ # | Bulgaria | `eu_vat` | European VAT Number |
139
+ # | Canada | `ca_bn` | Canadian BN |
140
+ # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
141
+ # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
142
+ # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
143
+ # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
144
+ # | Canada | `ca_qst` | Canadian QST Number (Québec) |
145
+ # | Chile | `cl_tin` | Chilean TIN |
146
+ # | China | `cn_tin` | Chinese Tax ID |
147
+ # | Colombia | `co_nit` | Colombian NIT Number |
148
+ # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
149
+ # | Croatia | `eu_vat` | European VAT Number |
150
+ # | Cyprus | `eu_vat` | European VAT Number |
151
+ # | Czech Republic | `eu_vat` | European VAT Number |
152
+ # | Denmark | `eu_vat` | European VAT Number |
153
+ # | Dominican Republic | `do_rcn` | Dominican RCN Number |
154
+ # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
155
+ # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
156
+ # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
157
+ # | Estonia | `eu_vat` | European VAT Number |
158
+ # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
159
+ # | Finland | `eu_vat` | European VAT Number |
160
+ # | France | `eu_vat` | European VAT Number |
161
+ # | Georgia | `ge_vat` | Georgian VAT |
162
+ # | Germany | `eu_vat` | European VAT Number |
163
+ # | Greece | `eu_vat` | European VAT Number |
164
+ # | Hong Kong | `hk_br` | Hong Kong BR Number |
165
+ # | Hungary | `eu_vat` | European VAT Number |
166
+ # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
167
+ # | Iceland | `is_vat` | Icelandic VAT |
168
+ # | India | `in_gst` | Indian GST Number |
169
+ # | Indonesia | `id_npwp` | Indonesian NPWP Number |
170
+ # | Ireland | `eu_vat` | European VAT Number |
171
+ # | Israel | `il_vat` | Israel VAT |
172
+ # | Italy | `eu_vat` | European VAT Number |
173
+ # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
174
+ # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
175
+ # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
176
+ # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
177
+ # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
178
+ # | Latvia | `eu_vat` | European VAT Number |
179
+ # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
180
+ # | Lithuania | `eu_vat` | European VAT Number |
181
+ # | Luxembourg | `eu_vat` | European VAT Number |
182
+ # | Malaysia | `my_frp` | Malaysian FRP Number |
183
+ # | Malaysia | `my_itn` | Malaysian ITN |
184
+ # | Malaysia | `my_sst` | Malaysian SST Number |
185
+ # | Malta | `eu_vat ` | European VAT Number |
186
+ # | Mexico | `mx_rfc` | Mexican RFC Number |
187
+ # | Netherlands | `eu_vat` | European VAT Number |
188
+ # | New Zealand | `nz_gst` | New Zealand GST Number |
189
+ # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
190
+ # | Norway | `no_vat` | Norwegian VAT Number |
191
+ # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
192
+ # | Oman | `om_vat` | Omani VAT Number |
193
+ # | Peru | `pe_ruc` | Peruvian RUC Number |
194
+ # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
195
+ # | Poland | `eu_vat` | European VAT Number |
196
+ # | Portugal | `eu_vat` | European VAT Number |
197
+ # | Romania | `eu_vat` | European VAT Number |
198
+ # | Romania | `ro_tin` | Romanian Tax ID Number |
199
+ # | Russia | `ru_inn` | Russian INN |
200
+ # | Russia | `ru_kpp` | Russian KPP |
201
+ # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
202
+ # | Serbia | `rs_pib` | Serbian PIB Number |
203
+ # | Singapore | `sg_gst` | Singaporean GST |
204
+ # | Singapore | `sg_uen` | Singaporean UEN |
205
+ # | Slovakia | `eu_vat` | European VAT Number |
206
+ # | Slovenia | `eu_vat` | European VAT Number |
207
+ # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
208
+ # | South Africa | `za_vat` | South African VAT Number |
209
+ # | South Korea | `kr_brn` | Korean BRN |
210
+ # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
211
+ # | Spain | `eu_vat` | European VAT Number |
212
+ # | Sweden | `eu_vat` | European VAT Number |
213
+ # | Switzerland | `ch_vat` | Switzerland VAT Number |
214
+ # | Taiwan | `tw_vat` | Taiwanese VAT |
215
+ # | Thailand | `th_vat` | Thai VAT |
216
+ # | Turkey | `tr_tin` | Turkish Tax Identification Number |
217
+ # | Ukraine | `ua_vat` | Ukrainian VAT |
218
+ # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
219
+ # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
220
+ # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
221
+ # | United States | `us_ein` | United States EIN |
222
+ # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
223
+ # | Venezuela | `ve_rif` | Venezuelan RIF Number |
224
+ # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
225
+ #
226
+ # @return [Orb::Models::CustomerUpdateParams::TaxID, nil]
227
+ optional :tax_id, -> { Orb::Models::CustomerUpdateParams::TaxID }, nil?: true
228
+
229
+ # @!parse
230
+ # # @param accounting_sync_configuration [Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration, nil]
231
+ # # @param additional_emails [Array<String>, nil]
232
+ # # @param auto_collection [Boolean, nil]
233
+ # # @param billing_address [Orb::Models::CustomerUpdateParams::BillingAddress, nil]
234
+ # # @param currency [String, nil]
235
+ # # @param email [String, nil]
236
+ # # @param email_delivery [Boolean, nil]
237
+ # # @param external_customer_id [String, nil]
238
+ # # @param hierarchy [Orb::Models::CustomerUpdateParams::Hierarchy, nil]
239
+ # # @param metadata [Hash{Symbol=>String, nil}, nil]
240
+ # # @param name [String, nil]
241
+ # # @param payment_provider [Symbol, Orb::Models::CustomerUpdateParams::PaymentProvider, nil]
242
+ # # @param payment_provider_id [String, nil]
243
+ # # @param reporting_configuration [Orb::Models::CustomerUpdateParams::ReportingConfiguration, nil]
244
+ # # @param shipping_address [Orb::Models::CustomerUpdateParams::ShippingAddress, nil]
245
+ # # @param tax_configuration [Orb::Models::CustomerUpdateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateParams::TaxConfiguration::NewTaxJarConfiguration, nil]
246
+ # # @param tax_id [Orb::Models::CustomerUpdateParams::TaxID, nil]
247
+ # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
248
+ # #
249
+ # def initialize(
250
+ # accounting_sync_configuration: nil,
251
+ # additional_emails: nil,
252
+ # auto_collection: nil,
253
+ # billing_address: nil,
254
+ # currency: nil,
255
+ # email: nil,
256
+ # email_delivery: nil,
257
+ # external_customer_id: nil,
258
+ # hierarchy: nil,
259
+ # metadata: nil,
260
+ # name: nil,
261
+ # payment_provider: nil,
262
+ # payment_provider_id: nil,
263
+ # reporting_configuration: nil,
264
+ # shipping_address: nil,
265
+ # tax_configuration: nil,
266
+ # tax_id: nil,
267
+ # request_options: {},
268
+ # **
269
+ # )
270
+ # super
271
+ # end
272
+
273
+ # def initialize: (Hash | Orb::BaseModel) -> void
274
+
275
+ class AccountingSyncConfiguration < Orb::BaseModel
276
+ # @!attribute accounting_providers
277
+ #
278
+ # @return [Array<Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration::AccountingProvider>, nil]
279
+ optional :accounting_providers,
280
+ -> { Orb::ArrayOf[Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration::AccountingProvider] },
281
+ nil?: true
282
+
283
+ # @!attribute excluded
284
+ #
285
+ # @return [Boolean, nil]
286
+ optional :excluded, Orb::BooleanModel, nil?: true
287
+
288
+ # @!parse
289
+ # # @param accounting_providers [Array<Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration::AccountingProvider>, nil]
290
+ # # @param excluded [Boolean, nil]
291
+ # #
292
+ # def initialize(accounting_providers: nil, excluded: nil, **) = super
293
+
294
+ # def initialize: (Hash | Orb::BaseModel) -> void
295
+
296
+ class AccountingProvider < Orb::BaseModel
297
+ # @!attribute external_provider_id
298
+ #
299
+ # @return [String]
300
+ required :external_provider_id, String
301
+
302
+ # @!attribute provider_type
303
+ #
304
+ # @return [String]
305
+ required :provider_type, String
306
+
307
+ # @!parse
308
+ # # @param external_provider_id [String]
309
+ # # @param provider_type [String]
310
+ # #
311
+ # def initialize(external_provider_id:, provider_type:, **) = super
312
+
313
+ # def initialize: (Hash | Orb::BaseModel) -> void
314
+ end
315
+ end
316
+
317
+ class BillingAddress < Orb::BaseModel
318
+ # @!attribute city
319
+ #
320
+ # @return [String, nil]
321
+ optional :city, String, nil?: true
322
+
323
+ # @!attribute country
324
+ #
325
+ # @return [String, nil]
326
+ optional :country, String, nil?: true
327
+
328
+ # @!attribute line1
329
+ #
330
+ # @return [String, nil]
331
+ optional :line1, String, nil?: true
332
+
333
+ # @!attribute line2
334
+ #
335
+ # @return [String, nil]
336
+ optional :line2, String, nil?: true
337
+
338
+ # @!attribute postal_code
339
+ #
340
+ # @return [String, nil]
341
+ optional :postal_code, String, nil?: true
342
+
343
+ # @!attribute state
344
+ #
345
+ # @return [String, nil]
346
+ optional :state, String, nil?: true
347
+
348
+ # @!parse
349
+ # # @param city [String, nil]
350
+ # # @param country [String, nil]
351
+ # # @param line1 [String, nil]
352
+ # # @param line2 [String, nil]
353
+ # # @param postal_code [String, nil]
354
+ # # @param state [String, nil]
355
+ # #
356
+ # def initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil, **) = super
357
+
358
+ # def initialize: (Hash | Orb::BaseModel) -> void
359
+ end
360
+
361
+ class Hierarchy < Orb::BaseModel
362
+ # @!attribute [r] child_customer_ids
363
+ # A list of child customer IDs to add to the hierarchy. The desired child
364
+ # customers must not already be part of another hierarchy.
365
+ #
366
+ # @return [Array<String>, nil]
367
+ optional :child_customer_ids, Orb::ArrayOf[String]
368
+
369
+ # @!parse
370
+ # # @return [Array<String>]
371
+ # attr_writer :child_customer_ids
372
+
373
+ # @!attribute parent_customer_id
374
+ # The ID of the parent customer in the hierarchy. The desired parent customer must
375
+ # not be a child of another customer.
376
+ #
377
+ # @return [String, nil]
378
+ optional :parent_customer_id, String, nil?: true
379
+
380
+ # @!parse
381
+ # # The hierarchical relationships for this customer.
382
+ # #
383
+ # # @param child_customer_ids [Array<String>]
384
+ # # @param parent_customer_id [String, nil]
385
+ # #
386
+ # def initialize(child_customer_ids: nil, parent_customer_id: nil, **) = super
387
+
388
+ # def initialize: (Hash | Orb::BaseModel) -> void
389
+ end
390
+
391
+ # This is used for creating charges or invoices in an external system via Orb.
392
+ # When not in test mode:
393
+ #
394
+ # - the connection must first be configured in the Orb webapp.
395
+ # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`,
396
+ # `bill.com`, `netsuite`), any product mappings must first be configured with
397
+ # the Orb team.
398
+ module PaymentProvider
399
+ extend Orb::Enum
400
+
401
+ QUICKBOOKS = :quickbooks
402
+ BILL_COM = :"bill.com"
403
+ STRIPE_CHARGE = :stripe_charge
404
+ STRIPE_INVOICE = :stripe_invoice
405
+ NETSUITE = :netsuite
406
+
407
+ finalize!
408
+
409
+ # @!parse
410
+ # # @return [Array<Symbol>]
411
+ # def self.values; end
412
+ end
413
+
414
+ class ReportingConfiguration < Orb::BaseModel
415
+ # @!attribute exempt
416
+ #
417
+ # @return [Boolean]
418
+ required :exempt, Orb::BooleanModel
419
+
420
+ # @!parse
421
+ # # @param exempt [Boolean]
422
+ # #
423
+ # def initialize(exempt:, **) = super
424
+
425
+ # def initialize: (Hash | Orb::BaseModel) -> void
426
+ end
427
+
428
+ class ShippingAddress < Orb::BaseModel
429
+ # @!attribute city
430
+ #
431
+ # @return [String, nil]
432
+ optional :city, String, nil?: true
433
+
434
+ # @!attribute country
435
+ #
436
+ # @return [String, nil]
437
+ optional :country, String, nil?: true
438
+
439
+ # @!attribute line1
440
+ #
441
+ # @return [String, nil]
442
+ optional :line1, String, nil?: true
443
+
444
+ # @!attribute line2
445
+ #
446
+ # @return [String, nil]
447
+ optional :line2, String, nil?: true
448
+
449
+ # @!attribute postal_code
450
+ #
451
+ # @return [String, nil]
452
+ optional :postal_code, String, nil?: true
453
+
454
+ # @!attribute state
455
+ #
456
+ # @return [String, nil]
457
+ optional :state, String, nil?: true
458
+
459
+ # @!parse
460
+ # # @param city [String, nil]
461
+ # # @param country [String, nil]
462
+ # # @param line1 [String, nil]
463
+ # # @param line2 [String, nil]
464
+ # # @param postal_code [String, nil]
465
+ # # @param state [String, nil]
466
+ # #
467
+ # def initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil, **) = super
468
+
469
+ # def initialize: (Hash | Orb::BaseModel) -> void
470
+ end
471
+
472
+ module TaxConfiguration
473
+ extend Orb::Union
474
+
475
+ discriminator :tax_provider
476
+
477
+ variant :avalara, -> { Orb::Models::CustomerUpdateParams::TaxConfiguration::NewAvalaraTaxConfiguration }
478
+
479
+ variant :taxjar, -> { Orb::Models::CustomerUpdateParams::TaxConfiguration::NewTaxJarConfiguration }
480
+
481
+ class NewAvalaraTaxConfiguration < Orb::BaseModel
482
+ # @!attribute tax_exempt
483
+ #
484
+ # @return [Boolean]
485
+ required :tax_exempt, Orb::BooleanModel
486
+
487
+ # @!attribute tax_provider
488
+ #
489
+ # @return [Symbol, :avalara]
490
+ required :tax_provider, const: :avalara
491
+
492
+ # @!attribute tax_exemption_code
493
+ #
494
+ # @return [String, nil]
495
+ optional :tax_exemption_code, String, nil?: true
496
+
497
+ # @!parse
498
+ # # @param tax_exempt [Boolean]
499
+ # # @param tax_exemption_code [String, nil]
500
+ # # @param tax_provider [Symbol, :avalara]
501
+ # #
502
+ # def initialize(tax_exempt:, tax_exemption_code: nil, tax_provider: :avalara, **) = super
503
+
504
+ # def initialize: (Hash | Orb::BaseModel) -> void
505
+ end
506
+
507
+ class NewTaxJarConfiguration < Orb::BaseModel
508
+ # @!attribute tax_exempt
509
+ #
510
+ # @return [Boolean]
511
+ required :tax_exempt, Orb::BooleanModel
512
+
513
+ # @!attribute tax_provider
514
+ #
515
+ # @return [Symbol, :taxjar]
516
+ required :tax_provider, const: :taxjar
517
+
518
+ # @!parse
519
+ # # @param tax_exempt [Boolean]
520
+ # # @param tax_provider [Symbol, :taxjar]
521
+ # #
522
+ # def initialize(tax_exempt:, tax_provider: :taxjar, **) = super
523
+
524
+ # def initialize: (Hash | Orb::BaseModel) -> void
525
+ end
526
+
527
+ # @!parse
528
+ # # @return [Array(Orb::Models::CustomerUpdateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateParams::TaxConfiguration::NewTaxJarConfiguration)]
529
+ # def self.variants; end
530
+ end
531
+
532
+ class TaxID < Orb::BaseModel
533
+ # @!attribute country
534
+ #
535
+ # @return [Symbol, Orb::Models::CustomerUpdateParams::TaxID::Country]
536
+ required :country, enum: -> { Orb::Models::CustomerUpdateParams::TaxID::Country }
537
+
538
+ # @!attribute type
539
+ #
540
+ # @return [Symbol, Orb::Models::CustomerUpdateParams::TaxID::Type]
541
+ required :type, enum: -> { Orb::Models::CustomerUpdateParams::TaxID::Type }
542
+
543
+ # @!attribute value
544
+ #
545
+ # @return [String]
546
+ required :value, String
547
+
548
+ # @!parse
549
+ # # Tax IDs are commonly required to be displayed on customer invoices, which are
550
+ # # added to the headers of invoices.
551
+ # #
552
+ # # ### Supported Tax ID Countries and Types
553
+ # #
554
+ # # | Country | Type | Description |
555
+ # # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
556
+ # # | Andorra | `ad_nrt` | Andorran NRT Number |
557
+ # # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
558
+ # # | Australia | `au_abn` | Australian Business Number (AU ABN) |
559
+ # # | Australia | `au_arn` | Australian Taxation Office Reference Number |
560
+ # # | Austria | `eu_vat` | European VAT Number |
561
+ # # | Bahrain | `bh_vat` | Bahraini VAT Number |
562
+ # # | Belgium | `eu_vat` | European VAT Number |
563
+ # # | Bolivia | `bo_tin` | Bolivian Tax ID |
564
+ # # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
565
+ # # | Brazil | `br_cpf` | Brazilian CPF Number |
566
+ # # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
567
+ # # | Bulgaria | `eu_vat` | European VAT Number |
568
+ # # | Canada | `ca_bn` | Canadian BN |
569
+ # # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
570
+ # # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
571
+ # # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
572
+ # # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
573
+ # # | Canada | `ca_qst` | Canadian QST Number (Québec) |
574
+ # # | Chile | `cl_tin` | Chilean TIN |
575
+ # # | China | `cn_tin` | Chinese Tax ID |
576
+ # # | Colombia | `co_nit` | Colombian NIT Number |
577
+ # # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
578
+ # # | Croatia | `eu_vat` | European VAT Number |
579
+ # # | Cyprus | `eu_vat` | European VAT Number |
580
+ # # | Czech Republic | `eu_vat` | European VAT Number |
581
+ # # | Denmark | `eu_vat` | European VAT Number |
582
+ # # | Dominican Republic | `do_rcn` | Dominican RCN Number |
583
+ # # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
584
+ # # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
585
+ # # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
586
+ # # | Estonia | `eu_vat` | European VAT Number |
587
+ # # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
588
+ # # | Finland | `eu_vat` | European VAT Number |
589
+ # # | France | `eu_vat` | European VAT Number |
590
+ # # | Georgia | `ge_vat` | Georgian VAT |
591
+ # # | Germany | `eu_vat` | European VAT Number |
592
+ # # | Greece | `eu_vat` | European VAT Number |
593
+ # # | Hong Kong | `hk_br` | Hong Kong BR Number |
594
+ # # | Hungary | `eu_vat` | European VAT Number |
595
+ # # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
596
+ # # | Iceland | `is_vat` | Icelandic VAT |
597
+ # # | India | `in_gst` | Indian GST Number |
598
+ # # | Indonesia | `id_npwp` | Indonesian NPWP Number |
599
+ # # | Ireland | `eu_vat` | European VAT Number |
600
+ # # | Israel | `il_vat` | Israel VAT |
601
+ # # | Italy | `eu_vat` | European VAT Number |
602
+ # # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
603
+ # # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
604
+ # # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
605
+ # # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
606
+ # # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
607
+ # # | Latvia | `eu_vat` | European VAT Number |
608
+ # # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
609
+ # # | Lithuania | `eu_vat` | European VAT Number |
610
+ # # | Luxembourg | `eu_vat` | European VAT Number |
611
+ # # | Malaysia | `my_frp` | Malaysian FRP Number |
612
+ # # | Malaysia | `my_itn` | Malaysian ITN |
613
+ # # | Malaysia | `my_sst` | Malaysian SST Number |
614
+ # # | Malta | `eu_vat ` | European VAT Number |
615
+ # # | Mexico | `mx_rfc` | Mexican RFC Number |
616
+ # # | Netherlands | `eu_vat` | European VAT Number |
617
+ # # | New Zealand | `nz_gst` | New Zealand GST Number |
618
+ # # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
619
+ # # | Norway | `no_vat` | Norwegian VAT Number |
620
+ # # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
621
+ # # | Oman | `om_vat` | Omani VAT Number |
622
+ # # | Peru | `pe_ruc` | Peruvian RUC Number |
623
+ # # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
624
+ # # | Poland | `eu_vat` | European VAT Number |
625
+ # # | Portugal | `eu_vat` | European VAT Number |
626
+ # # | Romania | `eu_vat` | European VAT Number |
627
+ # # | Romania | `ro_tin` | Romanian Tax ID Number |
628
+ # # | Russia | `ru_inn` | Russian INN |
629
+ # # | Russia | `ru_kpp` | Russian KPP |
630
+ # # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
631
+ # # | Serbia | `rs_pib` | Serbian PIB Number |
632
+ # # | Singapore | `sg_gst` | Singaporean GST |
633
+ # # | Singapore | `sg_uen` | Singaporean UEN |
634
+ # # | Slovakia | `eu_vat` | European VAT Number |
635
+ # # | Slovenia | `eu_vat` | European VAT Number |
636
+ # # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
637
+ # # | South Africa | `za_vat` | South African VAT Number |
638
+ # # | South Korea | `kr_brn` | Korean BRN |
639
+ # # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
640
+ # # | Spain | `eu_vat` | European VAT Number |
641
+ # # | Sweden | `eu_vat` | European VAT Number |
642
+ # # | Switzerland | `ch_vat` | Switzerland VAT Number |
643
+ # # | Taiwan | `tw_vat` | Taiwanese VAT |
644
+ # # | Thailand | `th_vat` | Thai VAT |
645
+ # # | Turkey | `tr_tin` | Turkish Tax Identification Number |
646
+ # # | Ukraine | `ua_vat` | Ukrainian VAT |
647
+ # # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
648
+ # # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
649
+ # # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
650
+ # # | United States | `us_ein` | United States EIN |
651
+ # # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
652
+ # # | Venezuela | `ve_rif` | Venezuelan RIF Number |
653
+ # # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
654
+ # #
655
+ # # @param country [Symbol, Orb::Models::CustomerUpdateParams::TaxID::Country]
656
+ # # @param type [Symbol, Orb::Models::CustomerUpdateParams::TaxID::Type]
657
+ # # @param value [String]
658
+ # #
659
+ # def initialize(country:, type:, value:, **) = super
660
+
661
+ # def initialize: (Hash | Orb::BaseModel) -> void
662
+
663
+ # @see Orb::Models::CustomerUpdateParams::TaxID#country
664
+ module Country
665
+ extend Orb::Enum
666
+
667
+ AD = :AD
668
+ AE = :AE
669
+ AR = :AR
670
+ AT = :AT
671
+ AU = :AU
672
+ BE = :BE
673
+ BG = :BG
674
+ BH = :BH
675
+ BO = :BO
676
+ BR = :BR
677
+ CA = :CA
678
+ CH = :CH
679
+ CL = :CL
680
+ CN = :CN
681
+ CO = :CO
682
+ CR = :CR
683
+ CY = :CY
684
+ CZ = :CZ
685
+ DE = :DE
686
+ DK = :DK
687
+ EE = :EE
688
+ DO = :DO
689
+ EC = :EC
690
+ EG = :EG
691
+ ES = :ES
692
+ EU = :EU
693
+ FI = :FI
694
+ FR = :FR
695
+ GB = :GB
696
+ GE = :GE
697
+ GR = :GR
698
+ HK = :HK
699
+ HR = :HR
700
+ HU = :HU
701
+ ID = :ID
702
+ IE = :IE
703
+ IL = :IL
704
+ IN = :IN
705
+ IS = :IS
706
+ IT = :IT
707
+ JP = :JP
708
+ KE = :KE
709
+ KR = :KR
710
+ KZ = :KZ
711
+ LI = :LI
712
+ LT = :LT
713
+ LU = :LU
714
+ LV = :LV
715
+ MT = :MT
716
+ MX = :MX
717
+ MY = :MY
718
+ NG = :NG
719
+ NL = :NL
720
+ NO = :NO
721
+ NZ = :NZ
722
+ OM = :OM
723
+ PE = :PE
724
+ PH = :PH
725
+ PL = :PL
726
+ PT = :PT
727
+ RO = :RO
728
+ RS = :RS
729
+ RU = :RU
730
+ SA = :SA
731
+ SE = :SE
732
+ SG = :SG
733
+ SI = :SI
734
+ SK = :SK
735
+ SV = :SV
736
+ TH = :TH
737
+ TR = :TR
738
+ TW = :TW
739
+ UA = :UA
740
+ US = :US
741
+ UY = :UY
742
+ VE = :VE
743
+ VN = :VN
744
+ ZA = :ZA
745
+
746
+ finalize!
747
+
748
+ # @!parse
749
+ # # @return [Array<Symbol>]
750
+ # def self.values; end
751
+ end
752
+
753
+ # @see Orb::Models::CustomerUpdateParams::TaxID#type
754
+ module Type
755
+ extend Orb::Enum
756
+
757
+ AD_NRT = :ad_nrt
758
+ AE_TRN = :ae_trn
759
+ AR_CUIT = :ar_cuit
760
+ EU_VAT = :eu_vat
761
+ AU_ABN = :au_abn
762
+ AU_ARN = :au_arn
763
+ BG_UIC = :bg_uic
764
+ BH_VAT = :bh_vat
765
+ BO_TIN = :bo_tin
766
+ BR_CNPJ = :br_cnpj
767
+ BR_CPF = :br_cpf
768
+ CA_BN = :ca_bn
769
+ CA_GST_HST = :ca_gst_hst
770
+ CA_PST_BC = :ca_pst_bc
771
+ CA_PST_MB = :ca_pst_mb
772
+ CA_PST_SK = :ca_pst_sk
773
+ CA_QST = :ca_qst
774
+ CH_VAT = :ch_vat
775
+ CL_TIN = :cl_tin
776
+ CN_TIN = :cn_tin
777
+ CO_NIT = :co_nit
778
+ CR_TIN = :cr_tin
779
+ DO_RCN = :do_rcn
780
+ EC_RUC = :ec_ruc
781
+ EG_TIN = :eg_tin
782
+ ES_CIF = :es_cif
783
+ EU_OSS_VAT = :eu_oss_vat
784
+ GB_VAT = :gb_vat
785
+ GE_VAT = :ge_vat
786
+ HK_BR = :hk_br
787
+ HU_TIN = :hu_tin
788
+ ID_NPWP = :id_npwp
789
+ IL_VAT = :il_vat
790
+ IN_GST = :in_gst
791
+ IS_VAT = :is_vat
792
+ JP_CN = :jp_cn
793
+ JP_RN = :jp_rn
794
+ JP_TRN = :jp_trn
795
+ KE_PIN = :ke_pin
796
+ KR_BRN = :kr_brn
797
+ KZ_BIN = :kz_bin
798
+ LI_UID = :li_uid
799
+ MX_RFC = :mx_rfc
800
+ MY_FRP = :my_frp
801
+ MY_ITN = :my_itn
802
+ MY_SST = :my_sst
803
+ NG_TIN = :ng_tin
804
+ NO_VAT = :no_vat
805
+ NO_VOEC = :no_voec
806
+ NZ_GST = :nz_gst
807
+ OM_VAT = :om_vat
808
+ PE_RUC = :pe_ruc
809
+ PH_TIN = :ph_tin
810
+ RO_TIN = :ro_tin
811
+ RS_PIB = :rs_pib
812
+ RU_INN = :ru_inn
813
+ RU_KPP = :ru_kpp
814
+ SA_VAT = :sa_vat
815
+ SG_GST = :sg_gst
816
+ SG_UEN = :sg_uen
817
+ SI_TIN = :si_tin
818
+ SV_NIT = :sv_nit
819
+ TH_VAT = :th_vat
820
+ TR_TIN = :tr_tin
821
+ TW_VAT = :tw_vat
822
+ UA_VAT = :ua_vat
823
+ US_EIN = :us_ein
824
+ UY_RUC = :uy_ruc
825
+ VE_RIF = :ve_rif
826
+ VN_TIN = :vn_tin
827
+ ZA_VAT = :za_vat
828
+
829
+ finalize!
830
+
831
+ # @!parse
832
+ # # @return [Array<Symbol>]
833
+ # def self.values; end
834
+ end
835
+ end
836
+ end
837
+ end
838
+ end