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,941 @@
1
+ # typed: strong
2
+
3
+ module Orb
4
+ module Models
5
+ class Customer < Orb::BaseModel
6
+ sig { returns(String) }
7
+ attr_accessor :id
8
+
9
+ sig { returns(T::Array[String]) }
10
+ attr_accessor :additional_emails
11
+
12
+ sig { returns(T::Boolean) }
13
+ attr_accessor :auto_collection
14
+
15
+ # The customer's current balance in their currency.
16
+ sig { returns(String) }
17
+ attr_accessor :balance
18
+
19
+ sig { returns(T.nilable(Orb::Models::Customer::BillingAddress)) }
20
+ attr_reader :billing_address
21
+
22
+ sig { params(billing_address: T.nilable(T.any(Orb::Models::Customer::BillingAddress, Orb::Util::AnyHash))).void }
23
+ attr_writer :billing_address
24
+
25
+ sig { returns(Time) }
26
+ attr_accessor :created_at
27
+
28
+ sig { returns(T.nilable(String)) }
29
+ attr_accessor :currency
30
+
31
+ # A valid customer email, to be used for notifications. When Orb triggers payment
32
+ # through a payment gateway, this email will be used for any automatically issued
33
+ # receipts.
34
+ sig { returns(String) }
35
+ attr_accessor :email
36
+
37
+ sig { returns(T::Boolean) }
38
+ attr_accessor :email_delivery
39
+
40
+ sig { returns(T.nilable(T::Boolean)) }
41
+ attr_accessor :exempt_from_automated_tax
42
+
43
+ # An optional user-defined ID for this customer resource, used throughout the
44
+ # system as an alias for this Customer. Use this field to identify a customer by
45
+ # an existing identifier in your system.
46
+ sig { returns(T.nilable(String)) }
47
+ attr_accessor :external_customer_id
48
+
49
+ # The hierarchical relationships for this customer.
50
+ sig { returns(Orb::Models::Customer::Hierarchy) }
51
+ attr_reader :hierarchy
52
+
53
+ sig { params(hierarchy: T.any(Orb::Models::Customer::Hierarchy, Orb::Util::AnyHash)).void }
54
+ attr_writer :hierarchy
55
+
56
+ # User specified key-value pairs for the resource. If not present, this defaults
57
+ # to an empty dictionary. Individual keys can be removed by setting the value to
58
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
59
+ # `null`.
60
+ sig { returns(T::Hash[Symbol, String]) }
61
+ attr_accessor :metadata
62
+
63
+ # The full name of the customer
64
+ sig { returns(String) }
65
+ attr_accessor :name
66
+
67
+ # This is used for creating charges or invoices in an external system via Orb.
68
+ # When not in test mode, the connection must first be configured in the Orb
69
+ # webapp.
70
+ sig { returns(T.nilable(Orb::Models::Customer::PaymentProvider::TaggedSymbol)) }
71
+ attr_accessor :payment_provider
72
+
73
+ # The ID of this customer in an external payments solution, such as Stripe. This
74
+ # is used for creating charges or invoices in the external system via Orb.
75
+ sig { returns(T.nilable(String)) }
76
+ attr_accessor :payment_provider_id
77
+
78
+ sig { returns(T.nilable(String)) }
79
+ attr_accessor :portal_url
80
+
81
+ sig { returns(T.nilable(Orb::Models::Customer::ShippingAddress)) }
82
+ attr_reader :shipping_address
83
+
84
+ sig { params(shipping_address: T.nilable(T.any(Orb::Models::Customer::ShippingAddress, Orb::Util::AnyHash))).void }
85
+ attr_writer :shipping_address
86
+
87
+ # Tax IDs are commonly required to be displayed on customer invoices, which are
88
+ # added to the headers of invoices.
89
+ #
90
+ # ### Supported Tax ID Countries and Types
91
+ #
92
+ # | Country | Type | Description |
93
+ # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
94
+ # | Andorra | `ad_nrt` | Andorran NRT Number |
95
+ # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
96
+ # | Australia | `au_abn` | Australian Business Number (AU ABN) |
97
+ # | Australia | `au_arn` | Australian Taxation Office Reference Number |
98
+ # | Austria | `eu_vat` | European VAT Number |
99
+ # | Bahrain | `bh_vat` | Bahraini VAT Number |
100
+ # | Belgium | `eu_vat` | European VAT Number |
101
+ # | Bolivia | `bo_tin` | Bolivian Tax ID |
102
+ # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
103
+ # | Brazil | `br_cpf` | Brazilian CPF Number |
104
+ # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
105
+ # | Bulgaria | `eu_vat` | European VAT Number |
106
+ # | Canada | `ca_bn` | Canadian BN |
107
+ # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
108
+ # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
109
+ # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
110
+ # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
111
+ # | Canada | `ca_qst` | Canadian QST Number (Québec) |
112
+ # | Chile | `cl_tin` | Chilean TIN |
113
+ # | China | `cn_tin` | Chinese Tax ID |
114
+ # | Colombia | `co_nit` | Colombian NIT Number |
115
+ # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
116
+ # | Croatia | `eu_vat` | European VAT Number |
117
+ # | Cyprus | `eu_vat` | European VAT Number |
118
+ # | Czech Republic | `eu_vat` | European VAT Number |
119
+ # | Denmark | `eu_vat` | European VAT Number |
120
+ # | Dominican Republic | `do_rcn` | Dominican RCN Number |
121
+ # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
122
+ # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
123
+ # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
124
+ # | Estonia | `eu_vat` | European VAT Number |
125
+ # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
126
+ # | Finland | `eu_vat` | European VAT Number |
127
+ # | France | `eu_vat` | European VAT Number |
128
+ # | Georgia | `ge_vat` | Georgian VAT |
129
+ # | Germany | `eu_vat` | European VAT Number |
130
+ # | Greece | `eu_vat` | European VAT Number |
131
+ # | Hong Kong | `hk_br` | Hong Kong BR Number |
132
+ # | Hungary | `eu_vat` | European VAT Number |
133
+ # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
134
+ # | Iceland | `is_vat` | Icelandic VAT |
135
+ # | India | `in_gst` | Indian GST Number |
136
+ # | Indonesia | `id_npwp` | Indonesian NPWP Number |
137
+ # | Ireland | `eu_vat` | European VAT Number |
138
+ # | Israel | `il_vat` | Israel VAT |
139
+ # | Italy | `eu_vat` | European VAT Number |
140
+ # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
141
+ # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
142
+ # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
143
+ # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
144
+ # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
145
+ # | Latvia | `eu_vat` | European VAT Number |
146
+ # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
147
+ # | Lithuania | `eu_vat` | European VAT Number |
148
+ # | Luxembourg | `eu_vat` | European VAT Number |
149
+ # | Malaysia | `my_frp` | Malaysian FRP Number |
150
+ # | Malaysia | `my_itn` | Malaysian ITN |
151
+ # | Malaysia | `my_sst` | Malaysian SST Number |
152
+ # | Malta | `eu_vat ` | European VAT Number |
153
+ # | Mexico | `mx_rfc` | Mexican RFC Number |
154
+ # | Netherlands | `eu_vat` | European VAT Number |
155
+ # | New Zealand | `nz_gst` | New Zealand GST Number |
156
+ # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
157
+ # | Norway | `no_vat` | Norwegian VAT Number |
158
+ # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
159
+ # | Oman | `om_vat` | Omani VAT Number |
160
+ # | Peru | `pe_ruc` | Peruvian RUC Number |
161
+ # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
162
+ # | Poland | `eu_vat` | European VAT Number |
163
+ # | Portugal | `eu_vat` | European VAT Number |
164
+ # | Romania | `eu_vat` | European VAT Number |
165
+ # | Romania | `ro_tin` | Romanian Tax ID Number |
166
+ # | Russia | `ru_inn` | Russian INN |
167
+ # | Russia | `ru_kpp` | Russian KPP |
168
+ # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
169
+ # | Serbia | `rs_pib` | Serbian PIB Number |
170
+ # | Singapore | `sg_gst` | Singaporean GST |
171
+ # | Singapore | `sg_uen` | Singaporean UEN |
172
+ # | Slovakia | `eu_vat` | European VAT Number |
173
+ # | Slovenia | `eu_vat` | European VAT Number |
174
+ # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
175
+ # | South Africa | `za_vat` | South African VAT Number |
176
+ # | South Korea | `kr_brn` | Korean BRN |
177
+ # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
178
+ # | Spain | `eu_vat` | European VAT Number |
179
+ # | Sweden | `eu_vat` | European VAT Number |
180
+ # | Switzerland | `ch_vat` | Switzerland VAT Number |
181
+ # | Taiwan | `tw_vat` | Taiwanese VAT |
182
+ # | Thailand | `th_vat` | Thai VAT |
183
+ # | Turkey | `tr_tin` | Turkish Tax Identification Number |
184
+ # | Ukraine | `ua_vat` | Ukrainian VAT |
185
+ # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
186
+ # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
187
+ # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
188
+ # | United States | `us_ein` | United States EIN |
189
+ # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
190
+ # | Venezuela | `ve_rif` | Venezuelan RIF Number |
191
+ # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
192
+ sig { returns(T.nilable(Orb::Models::Customer::TaxID)) }
193
+ attr_reader :tax_id
194
+
195
+ sig { params(tax_id: T.nilable(T.any(Orb::Models::Customer::TaxID, Orb::Util::AnyHash))).void }
196
+ attr_writer :tax_id
197
+
198
+ # A timezone identifier from the IANA timezone database, such as
199
+ # "America/Los_Angeles". This "defaults to your account's timezone if not set.
200
+ # This cannot be changed after customer creation.
201
+ sig { returns(String) }
202
+ attr_accessor :timezone
203
+
204
+ sig { returns(T.nilable(Orb::Models::Customer::AccountingSyncConfiguration)) }
205
+ attr_reader :accounting_sync_configuration
206
+
207
+ sig do
208
+ params(
209
+ accounting_sync_configuration: T.nilable(T.any(Orb::Models::Customer::AccountingSyncConfiguration, Orb::Util::AnyHash))
210
+ )
211
+ .void
212
+ end
213
+ attr_writer :accounting_sync_configuration
214
+
215
+ sig { returns(T.nilable(Orb::Models::Customer::ReportingConfiguration)) }
216
+ attr_reader :reporting_configuration
217
+
218
+ sig do
219
+ params(
220
+ reporting_configuration: T.nilable(T.any(Orb::Models::Customer::ReportingConfiguration, Orb::Util::AnyHash))
221
+ )
222
+ .void
223
+ end
224
+ attr_writer :reporting_configuration
225
+
226
+ # A customer is a buyer of your products, and the other party to the billing
227
+ # relationship.
228
+ #
229
+ # In Orb, customers are assigned system generated identifiers automatically, but
230
+ # it's often desirable to have these match existing identifiers in your system. To
231
+ # avoid having to denormalize Orb ID information, you can pass in an
232
+ # `external_customer_id` with your own identifier. See
233
+ # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
234
+ # information about how these aliases work in Orb.
235
+ #
236
+ # In addition to having an identifier in your system, a customer may exist in a
237
+ # payment provider solution like Stripe. Use the `payment_provider_id` and the
238
+ # `payment_provider` enum field to express this mapping.
239
+ #
240
+ # A customer also has a timezone (from the standard
241
+ # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
242
+ # your account's timezone. See [Timezone localization](/essentials/timezones) for
243
+ # information on what this timezone parameter influences within Orb.
244
+ sig do
245
+ params(
246
+ id: String,
247
+ additional_emails: T::Array[String],
248
+ auto_collection: T::Boolean,
249
+ balance: String,
250
+ billing_address: T.nilable(T.any(Orb::Models::Customer::BillingAddress, Orb::Util::AnyHash)),
251
+ created_at: Time,
252
+ currency: T.nilable(String),
253
+ email: String,
254
+ email_delivery: T::Boolean,
255
+ exempt_from_automated_tax: T.nilable(T::Boolean),
256
+ external_customer_id: T.nilable(String),
257
+ hierarchy: T.any(Orb::Models::Customer::Hierarchy, Orb::Util::AnyHash),
258
+ metadata: T::Hash[Symbol, String],
259
+ name: String,
260
+ payment_provider: T.nilable(Orb::Models::Customer::PaymentProvider::OrSymbol),
261
+ payment_provider_id: T.nilable(String),
262
+ portal_url: T.nilable(String),
263
+ shipping_address: T.nilable(T.any(Orb::Models::Customer::ShippingAddress, Orb::Util::AnyHash)),
264
+ tax_id: T.nilable(T.any(Orb::Models::Customer::TaxID, Orb::Util::AnyHash)),
265
+ timezone: String,
266
+ accounting_sync_configuration: T.nilable(T.any(Orb::Models::Customer::AccountingSyncConfiguration, Orb::Util::AnyHash)),
267
+ reporting_configuration: T.nilable(T.any(Orb::Models::Customer::ReportingConfiguration, Orb::Util::AnyHash))
268
+ )
269
+ .returns(T.attached_class)
270
+ end
271
+ def self.new(
272
+ id:,
273
+ additional_emails:,
274
+ auto_collection:,
275
+ balance:,
276
+ billing_address:,
277
+ created_at:,
278
+ currency:,
279
+ email:,
280
+ email_delivery:,
281
+ exempt_from_automated_tax:,
282
+ external_customer_id:,
283
+ hierarchy:,
284
+ metadata:,
285
+ name:,
286
+ payment_provider:,
287
+ payment_provider_id:,
288
+ portal_url:,
289
+ shipping_address:,
290
+ tax_id:,
291
+ timezone:,
292
+ accounting_sync_configuration: nil,
293
+ reporting_configuration: nil
294
+ )
295
+ end
296
+
297
+ sig do
298
+ override
299
+ .returns(
300
+ {
301
+ id: String,
302
+ additional_emails: T::Array[String],
303
+ auto_collection: T::Boolean,
304
+ balance: String,
305
+ billing_address: T.nilable(Orb::Models::Customer::BillingAddress),
306
+ created_at: Time,
307
+ currency: T.nilable(String),
308
+ email: String,
309
+ email_delivery: T::Boolean,
310
+ exempt_from_automated_tax: T.nilable(T::Boolean),
311
+ external_customer_id: T.nilable(String),
312
+ hierarchy: Orb::Models::Customer::Hierarchy,
313
+ metadata: T::Hash[Symbol, String],
314
+ name: String,
315
+ payment_provider: T.nilable(Orb::Models::Customer::PaymentProvider::TaggedSymbol),
316
+ payment_provider_id: T.nilable(String),
317
+ portal_url: T.nilable(String),
318
+ shipping_address: T.nilable(Orb::Models::Customer::ShippingAddress),
319
+ tax_id: T.nilable(Orb::Models::Customer::TaxID),
320
+ timezone: String,
321
+ accounting_sync_configuration: T.nilable(Orb::Models::Customer::AccountingSyncConfiguration),
322
+ reporting_configuration: T.nilable(Orb::Models::Customer::ReportingConfiguration)
323
+ }
324
+ )
325
+ end
326
+ def to_hash
327
+ end
328
+
329
+ class BillingAddress < Orb::BaseModel
330
+ sig { returns(T.nilable(String)) }
331
+ attr_accessor :city
332
+
333
+ sig { returns(T.nilable(String)) }
334
+ attr_accessor :country
335
+
336
+ sig { returns(T.nilable(String)) }
337
+ attr_accessor :line1
338
+
339
+ sig { returns(T.nilable(String)) }
340
+ attr_accessor :line2
341
+
342
+ sig { returns(T.nilable(String)) }
343
+ attr_accessor :postal_code
344
+
345
+ sig { returns(T.nilable(String)) }
346
+ attr_accessor :state
347
+
348
+ sig do
349
+ params(
350
+ city: T.nilable(String),
351
+ country: T.nilable(String),
352
+ line1: T.nilable(String),
353
+ line2: T.nilable(String),
354
+ postal_code: T.nilable(String),
355
+ state: T.nilable(String)
356
+ )
357
+ .returns(T.attached_class)
358
+ end
359
+ def self.new(city:, country:, line1:, line2:, postal_code:, state:)
360
+ end
361
+
362
+ sig do
363
+ override
364
+ .returns(
365
+ {
366
+ city: T.nilable(String),
367
+ country: T.nilable(String),
368
+ line1: T.nilable(String),
369
+ line2: T.nilable(String),
370
+ postal_code: T.nilable(String),
371
+ state: T.nilable(String)
372
+ }
373
+ )
374
+ end
375
+ def to_hash
376
+ end
377
+ end
378
+
379
+ class Hierarchy < Orb::BaseModel
380
+ sig { returns(T::Array[Orb::Models::Customer::Hierarchy::Child]) }
381
+ attr_accessor :children
382
+
383
+ sig { returns(T.nilable(Orb::Models::Customer::Hierarchy::Parent)) }
384
+ attr_reader :parent
385
+
386
+ sig { params(parent: T.nilable(T.any(Orb::Models::Customer::Hierarchy::Parent, Orb::Util::AnyHash))).void }
387
+ attr_writer :parent
388
+
389
+ # The hierarchical relationships for this customer.
390
+ sig do
391
+ params(
392
+ children: T::Array[T.any(Orb::Models::Customer::Hierarchy::Child, Orb::Util::AnyHash)],
393
+ parent: T.nilable(T.any(Orb::Models::Customer::Hierarchy::Parent, Orb::Util::AnyHash))
394
+ )
395
+ .returns(T.attached_class)
396
+ end
397
+ def self.new(children:, parent:)
398
+ end
399
+
400
+ sig do
401
+ override
402
+ .returns(
403
+ {
404
+ children: T::Array[Orb::Models::Customer::Hierarchy::Child],
405
+ parent: T.nilable(Orb::Models::Customer::Hierarchy::Parent)
406
+ }
407
+ )
408
+ end
409
+ def to_hash
410
+ end
411
+
412
+ class Child < Orb::BaseModel
413
+ sig { returns(String) }
414
+ attr_accessor :id
415
+
416
+ sig { returns(T.nilable(String)) }
417
+ attr_accessor :external_customer_id
418
+
419
+ sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) }
420
+ def self.new(id:, external_customer_id:)
421
+ end
422
+
423
+ sig { override.returns({id: String, external_customer_id: T.nilable(String)}) }
424
+ def to_hash
425
+ end
426
+ end
427
+
428
+ class Parent < Orb::BaseModel
429
+ sig { returns(String) }
430
+ attr_accessor :id
431
+
432
+ sig { returns(T.nilable(String)) }
433
+ attr_accessor :external_customer_id
434
+
435
+ sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) }
436
+ def self.new(id:, external_customer_id:)
437
+ end
438
+
439
+ sig { override.returns({id: String, external_customer_id: T.nilable(String)}) }
440
+ def to_hash
441
+ end
442
+ end
443
+ end
444
+
445
+ # This is used for creating charges or invoices in an external system via Orb.
446
+ # When not in test mode, the connection must first be configured in the Orb
447
+ # webapp.
448
+ module PaymentProvider
449
+ extend Orb::Enum
450
+
451
+ TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customer::PaymentProvider) }
452
+ OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Customer::PaymentProvider::TaggedSymbol) }
453
+
454
+ QUICKBOOKS = T.let(:quickbooks, Orb::Models::Customer::PaymentProvider::TaggedSymbol)
455
+ BILL_COM = T.let(:"bill.com", Orb::Models::Customer::PaymentProvider::TaggedSymbol)
456
+ STRIPE_CHARGE = T.let(:stripe_charge, Orb::Models::Customer::PaymentProvider::TaggedSymbol)
457
+ STRIPE_INVOICE = T.let(:stripe_invoice, Orb::Models::Customer::PaymentProvider::TaggedSymbol)
458
+ NETSUITE = T.let(:netsuite, Orb::Models::Customer::PaymentProvider::TaggedSymbol)
459
+
460
+ sig { override.returns(T::Array[Orb::Models::Customer::PaymentProvider::TaggedSymbol]) }
461
+ def self.values
462
+ end
463
+ end
464
+
465
+ class ShippingAddress < Orb::BaseModel
466
+ sig { returns(T.nilable(String)) }
467
+ attr_accessor :city
468
+
469
+ sig { returns(T.nilable(String)) }
470
+ attr_accessor :country
471
+
472
+ sig { returns(T.nilable(String)) }
473
+ attr_accessor :line1
474
+
475
+ sig { returns(T.nilable(String)) }
476
+ attr_accessor :line2
477
+
478
+ sig { returns(T.nilable(String)) }
479
+ attr_accessor :postal_code
480
+
481
+ sig { returns(T.nilable(String)) }
482
+ attr_accessor :state
483
+
484
+ sig do
485
+ params(
486
+ city: T.nilable(String),
487
+ country: T.nilable(String),
488
+ line1: T.nilable(String),
489
+ line2: T.nilable(String),
490
+ postal_code: T.nilable(String),
491
+ state: T.nilable(String)
492
+ )
493
+ .returns(T.attached_class)
494
+ end
495
+ def self.new(city:, country:, line1:, line2:, postal_code:, state:)
496
+ end
497
+
498
+ sig do
499
+ override
500
+ .returns(
501
+ {
502
+ city: T.nilable(String),
503
+ country: T.nilable(String),
504
+ line1: T.nilable(String),
505
+ line2: T.nilable(String),
506
+ postal_code: T.nilable(String),
507
+ state: T.nilable(String)
508
+ }
509
+ )
510
+ end
511
+ def to_hash
512
+ end
513
+ end
514
+
515
+ class TaxID < Orb::BaseModel
516
+ sig { returns(Orb::Models::Customer::TaxID::Country::TaggedSymbol) }
517
+ attr_accessor :country
518
+
519
+ sig { returns(Orb::Models::Customer::TaxID::Type::TaggedSymbol) }
520
+ attr_accessor :type
521
+
522
+ sig { returns(String) }
523
+ attr_accessor :value
524
+
525
+ # Tax IDs are commonly required to be displayed on customer invoices, which are
526
+ # added to the headers of invoices.
527
+ #
528
+ # ### Supported Tax ID Countries and Types
529
+ #
530
+ # | Country | Type | Description |
531
+ # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
532
+ # | Andorra | `ad_nrt` | Andorran NRT Number |
533
+ # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
534
+ # | Australia | `au_abn` | Australian Business Number (AU ABN) |
535
+ # | Australia | `au_arn` | Australian Taxation Office Reference Number |
536
+ # | Austria | `eu_vat` | European VAT Number |
537
+ # | Bahrain | `bh_vat` | Bahraini VAT Number |
538
+ # | Belgium | `eu_vat` | European VAT Number |
539
+ # | Bolivia | `bo_tin` | Bolivian Tax ID |
540
+ # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
541
+ # | Brazil | `br_cpf` | Brazilian CPF Number |
542
+ # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
543
+ # | Bulgaria | `eu_vat` | European VAT Number |
544
+ # | Canada | `ca_bn` | Canadian BN |
545
+ # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
546
+ # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
547
+ # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
548
+ # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
549
+ # | Canada | `ca_qst` | Canadian QST Number (Québec) |
550
+ # | Chile | `cl_tin` | Chilean TIN |
551
+ # | China | `cn_tin` | Chinese Tax ID |
552
+ # | Colombia | `co_nit` | Colombian NIT Number |
553
+ # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
554
+ # | Croatia | `eu_vat` | European VAT Number |
555
+ # | Cyprus | `eu_vat` | European VAT Number |
556
+ # | Czech Republic | `eu_vat` | European VAT Number |
557
+ # | Denmark | `eu_vat` | European VAT Number |
558
+ # | Dominican Republic | `do_rcn` | Dominican RCN Number |
559
+ # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
560
+ # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
561
+ # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
562
+ # | Estonia | `eu_vat` | European VAT Number |
563
+ # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
564
+ # | Finland | `eu_vat` | European VAT Number |
565
+ # | France | `eu_vat` | European VAT Number |
566
+ # | Georgia | `ge_vat` | Georgian VAT |
567
+ # | Germany | `eu_vat` | European VAT Number |
568
+ # | Greece | `eu_vat` | European VAT Number |
569
+ # | Hong Kong | `hk_br` | Hong Kong BR Number |
570
+ # | Hungary | `eu_vat` | European VAT Number |
571
+ # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
572
+ # | Iceland | `is_vat` | Icelandic VAT |
573
+ # | India | `in_gst` | Indian GST Number |
574
+ # | Indonesia | `id_npwp` | Indonesian NPWP Number |
575
+ # | Ireland | `eu_vat` | European VAT Number |
576
+ # | Israel | `il_vat` | Israel VAT |
577
+ # | Italy | `eu_vat` | European VAT Number |
578
+ # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
579
+ # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
580
+ # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
581
+ # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
582
+ # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
583
+ # | Latvia | `eu_vat` | European VAT Number |
584
+ # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
585
+ # | Lithuania | `eu_vat` | European VAT Number |
586
+ # | Luxembourg | `eu_vat` | European VAT Number |
587
+ # | Malaysia | `my_frp` | Malaysian FRP Number |
588
+ # | Malaysia | `my_itn` | Malaysian ITN |
589
+ # | Malaysia | `my_sst` | Malaysian SST Number |
590
+ # | Malta | `eu_vat ` | European VAT Number |
591
+ # | Mexico | `mx_rfc` | Mexican RFC Number |
592
+ # | Netherlands | `eu_vat` | European VAT Number |
593
+ # | New Zealand | `nz_gst` | New Zealand GST Number |
594
+ # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
595
+ # | Norway | `no_vat` | Norwegian VAT Number |
596
+ # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
597
+ # | Oman | `om_vat` | Omani VAT Number |
598
+ # | Peru | `pe_ruc` | Peruvian RUC Number |
599
+ # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
600
+ # | Poland | `eu_vat` | European VAT Number |
601
+ # | Portugal | `eu_vat` | European VAT Number |
602
+ # | Romania | `eu_vat` | European VAT Number |
603
+ # | Romania | `ro_tin` | Romanian Tax ID Number |
604
+ # | Russia | `ru_inn` | Russian INN |
605
+ # | Russia | `ru_kpp` | Russian KPP |
606
+ # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
607
+ # | Serbia | `rs_pib` | Serbian PIB Number |
608
+ # | Singapore | `sg_gst` | Singaporean GST |
609
+ # | Singapore | `sg_uen` | Singaporean UEN |
610
+ # | Slovakia | `eu_vat` | European VAT Number |
611
+ # | Slovenia | `eu_vat` | European VAT Number |
612
+ # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
613
+ # | South Africa | `za_vat` | South African VAT Number |
614
+ # | South Korea | `kr_brn` | Korean BRN |
615
+ # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
616
+ # | Spain | `eu_vat` | European VAT Number |
617
+ # | Sweden | `eu_vat` | European VAT Number |
618
+ # | Switzerland | `ch_vat` | Switzerland VAT Number |
619
+ # | Taiwan | `tw_vat` | Taiwanese VAT |
620
+ # | Thailand | `th_vat` | Thai VAT |
621
+ # | Turkey | `tr_tin` | Turkish Tax Identification Number |
622
+ # | Ukraine | `ua_vat` | Ukrainian VAT |
623
+ # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
624
+ # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
625
+ # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
626
+ # | United States | `us_ein` | United States EIN |
627
+ # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
628
+ # | Venezuela | `ve_rif` | Venezuelan RIF Number |
629
+ # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
630
+ sig do
631
+ params(
632
+ country: Orb::Models::Customer::TaxID::Country::OrSymbol,
633
+ type: Orb::Models::Customer::TaxID::Type::OrSymbol,
634
+ value: String
635
+ )
636
+ .returns(T.attached_class)
637
+ end
638
+ def self.new(country:, type:, value:)
639
+ end
640
+
641
+ sig do
642
+ override
643
+ .returns(
644
+ {
645
+ country: Orb::Models::Customer::TaxID::Country::TaggedSymbol,
646
+ type: Orb::Models::Customer::TaxID::Type::TaggedSymbol,
647
+ value: String
648
+ }
649
+ )
650
+ end
651
+ def to_hash
652
+ end
653
+
654
+ module Country
655
+ extend Orb::Enum
656
+
657
+ TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customer::TaxID::Country) }
658
+ OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Customer::TaxID::Country::TaggedSymbol) }
659
+
660
+ AD = T.let(:AD, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
661
+ AE = T.let(:AE, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
662
+ AR = T.let(:AR, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
663
+ AT = T.let(:AT, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
664
+ AU = T.let(:AU, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
665
+ BE = T.let(:BE, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
666
+ BG = T.let(:BG, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
667
+ BH = T.let(:BH, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
668
+ BO = T.let(:BO, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
669
+ BR = T.let(:BR, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
670
+ CA = T.let(:CA, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
671
+ CH = T.let(:CH, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
672
+ CL = T.let(:CL, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
673
+ CN = T.let(:CN, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
674
+ CO = T.let(:CO, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
675
+ CR = T.let(:CR, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
676
+ CY = T.let(:CY, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
677
+ CZ = T.let(:CZ, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
678
+ DE = T.let(:DE, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
679
+ DK = T.let(:DK, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
680
+ EE = T.let(:EE, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
681
+ DO = T.let(:DO, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
682
+ EC = T.let(:EC, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
683
+ EG = T.let(:EG, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
684
+ ES = T.let(:ES, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
685
+ EU = T.let(:EU, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
686
+ FI = T.let(:FI, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
687
+ FR = T.let(:FR, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
688
+ GB = T.let(:GB, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
689
+ GE = T.let(:GE, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
690
+ GR = T.let(:GR, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
691
+ HK = T.let(:HK, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
692
+ HR = T.let(:HR, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
693
+ HU = T.let(:HU, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
694
+ ID = T.let(:ID, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
695
+ IE = T.let(:IE, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
696
+ IL = T.let(:IL, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
697
+ IN = T.let(:IN, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
698
+ IS = T.let(:IS, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
699
+ IT = T.let(:IT, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
700
+ JP = T.let(:JP, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
701
+ KE = T.let(:KE, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
702
+ KR = T.let(:KR, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
703
+ KZ = T.let(:KZ, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
704
+ LI = T.let(:LI, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
705
+ LT = T.let(:LT, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
706
+ LU = T.let(:LU, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
707
+ LV = T.let(:LV, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
708
+ MT = T.let(:MT, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
709
+ MX = T.let(:MX, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
710
+ MY = T.let(:MY, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
711
+ NG = T.let(:NG, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
712
+ NL = T.let(:NL, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
713
+ NO = T.let(:NO, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
714
+ NZ = T.let(:NZ, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
715
+ OM = T.let(:OM, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
716
+ PE = T.let(:PE, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
717
+ PH = T.let(:PH, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
718
+ PL = T.let(:PL, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
719
+ PT = T.let(:PT, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
720
+ RO = T.let(:RO, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
721
+ RS = T.let(:RS, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
722
+ RU = T.let(:RU, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
723
+ SA = T.let(:SA, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
724
+ SE = T.let(:SE, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
725
+ SG = T.let(:SG, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
726
+ SI = T.let(:SI, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
727
+ SK = T.let(:SK, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
728
+ SV = T.let(:SV, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
729
+ TH = T.let(:TH, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
730
+ TR = T.let(:TR, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
731
+ TW = T.let(:TW, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
732
+ UA = T.let(:UA, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
733
+ US = T.let(:US, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
734
+ UY = T.let(:UY, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
735
+ VE = T.let(:VE, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
736
+ VN = T.let(:VN, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
737
+ ZA = T.let(:ZA, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
738
+
739
+ sig { override.returns(T::Array[Orb::Models::Customer::TaxID::Country::TaggedSymbol]) }
740
+ def self.values
741
+ end
742
+ end
743
+
744
+ module Type
745
+ extend Orb::Enum
746
+
747
+ TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customer::TaxID::Type) }
748
+ OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Customer::TaxID::Type::TaggedSymbol) }
749
+
750
+ AD_NRT = T.let(:ad_nrt, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
751
+ AE_TRN = T.let(:ae_trn, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
752
+ AR_CUIT = T.let(:ar_cuit, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
753
+ EU_VAT = T.let(:eu_vat, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
754
+ AU_ABN = T.let(:au_abn, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
755
+ AU_ARN = T.let(:au_arn, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
756
+ BG_UIC = T.let(:bg_uic, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
757
+ BH_VAT = T.let(:bh_vat, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
758
+ BO_TIN = T.let(:bo_tin, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
759
+ BR_CNPJ = T.let(:br_cnpj, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
760
+ BR_CPF = T.let(:br_cpf, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
761
+ CA_BN = T.let(:ca_bn, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
762
+ CA_GST_HST = T.let(:ca_gst_hst, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
763
+ CA_PST_BC = T.let(:ca_pst_bc, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
764
+ CA_PST_MB = T.let(:ca_pst_mb, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
765
+ CA_PST_SK = T.let(:ca_pst_sk, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
766
+ CA_QST = T.let(:ca_qst, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
767
+ CH_VAT = T.let(:ch_vat, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
768
+ CL_TIN = T.let(:cl_tin, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
769
+ CN_TIN = T.let(:cn_tin, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
770
+ CO_NIT = T.let(:co_nit, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
771
+ CR_TIN = T.let(:cr_tin, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
772
+ DO_RCN = T.let(:do_rcn, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
773
+ EC_RUC = T.let(:ec_ruc, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
774
+ EG_TIN = T.let(:eg_tin, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
775
+ ES_CIF = T.let(:es_cif, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
776
+ EU_OSS_VAT = T.let(:eu_oss_vat, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
777
+ GB_VAT = T.let(:gb_vat, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
778
+ GE_VAT = T.let(:ge_vat, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
779
+ HK_BR = T.let(:hk_br, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
780
+ HU_TIN = T.let(:hu_tin, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
781
+ ID_NPWP = T.let(:id_npwp, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
782
+ IL_VAT = T.let(:il_vat, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
783
+ IN_GST = T.let(:in_gst, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
784
+ IS_VAT = T.let(:is_vat, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
785
+ JP_CN = T.let(:jp_cn, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
786
+ JP_RN = T.let(:jp_rn, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
787
+ JP_TRN = T.let(:jp_trn, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
788
+ KE_PIN = T.let(:ke_pin, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
789
+ KR_BRN = T.let(:kr_brn, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
790
+ KZ_BIN = T.let(:kz_bin, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
791
+ LI_UID = T.let(:li_uid, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
792
+ MX_RFC = T.let(:mx_rfc, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
793
+ MY_FRP = T.let(:my_frp, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
794
+ MY_ITN = T.let(:my_itn, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
795
+ MY_SST = T.let(:my_sst, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
796
+ NG_TIN = T.let(:ng_tin, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
797
+ NO_VAT = T.let(:no_vat, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
798
+ NO_VOEC = T.let(:no_voec, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
799
+ NZ_GST = T.let(:nz_gst, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
800
+ OM_VAT = T.let(:om_vat, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
801
+ PE_RUC = T.let(:pe_ruc, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
802
+ PH_TIN = T.let(:ph_tin, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
803
+ RO_TIN = T.let(:ro_tin, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
804
+ RS_PIB = T.let(:rs_pib, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
805
+ RU_INN = T.let(:ru_inn, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
806
+ RU_KPP = T.let(:ru_kpp, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
807
+ SA_VAT = T.let(:sa_vat, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
808
+ SG_GST = T.let(:sg_gst, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
809
+ SG_UEN = T.let(:sg_uen, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
810
+ SI_TIN = T.let(:si_tin, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
811
+ SV_NIT = T.let(:sv_nit, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
812
+ TH_VAT = T.let(:th_vat, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
813
+ TR_TIN = T.let(:tr_tin, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
814
+ TW_VAT = T.let(:tw_vat, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
815
+ UA_VAT = T.let(:ua_vat, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
816
+ US_EIN = T.let(:us_ein, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
817
+ UY_RUC = T.let(:uy_ruc, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
818
+ VE_RIF = T.let(:ve_rif, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
819
+ VN_TIN = T.let(:vn_tin, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
820
+ ZA_VAT = T.let(:za_vat, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
821
+
822
+ sig { override.returns(T::Array[Orb::Models::Customer::TaxID::Type::TaggedSymbol]) }
823
+ def self.values
824
+ end
825
+ end
826
+ end
827
+
828
+ class AccountingSyncConfiguration < Orb::BaseModel
829
+ sig { returns(T::Array[Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider]) }
830
+ attr_accessor :accounting_providers
831
+
832
+ sig { returns(T::Boolean) }
833
+ attr_accessor :excluded
834
+
835
+ sig do
836
+ params(
837
+ accounting_providers: T::Array[T.any(Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider, Orb::Util::AnyHash)],
838
+ excluded: T::Boolean
839
+ )
840
+ .returns(T.attached_class)
841
+ end
842
+ def self.new(accounting_providers:, excluded:)
843
+ end
844
+
845
+ sig do
846
+ override
847
+ .returns(
848
+ {
849
+ accounting_providers: T::Array[Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider],
850
+ excluded: T::Boolean
851
+ }
852
+ )
853
+ end
854
+ def to_hash
855
+ end
856
+
857
+ class AccountingProvider < Orb::BaseModel
858
+ sig { returns(T.nilable(String)) }
859
+ attr_accessor :external_provider_id
860
+
861
+ sig do
862
+ returns(
863
+ Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType::TaggedSymbol
864
+ )
865
+ end
866
+ attr_accessor :provider_type
867
+
868
+ sig do
869
+ params(
870
+ external_provider_id: T.nilable(String),
871
+ provider_type: Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType::OrSymbol
872
+ )
873
+ .returns(T.attached_class)
874
+ end
875
+ def self.new(external_provider_id:, provider_type:)
876
+ end
877
+
878
+ sig do
879
+ override
880
+ .returns(
881
+ {
882
+ external_provider_id: T.nilable(String),
883
+ provider_type: Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType::TaggedSymbol
884
+ }
885
+ )
886
+ end
887
+ def to_hash
888
+ end
889
+
890
+ module ProviderType
891
+ extend Orb::Enum
892
+
893
+ TaggedSymbol =
894
+ T.type_alias { T.all(Symbol, Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType) }
895
+ OrSymbol =
896
+ T.type_alias do
897
+ T.any(
898
+ Symbol,
899
+ String,
900
+ Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType::TaggedSymbol
901
+ )
902
+ end
903
+
904
+ QUICKBOOKS =
905
+ T.let(
906
+ :quickbooks,
907
+ Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType::TaggedSymbol
908
+ )
909
+ NETSUITE =
910
+ T.let(
911
+ :netsuite,
912
+ Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType::TaggedSymbol
913
+ )
914
+
915
+ sig do
916
+ override
917
+ .returns(
918
+ T::Array[Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType::TaggedSymbol]
919
+ )
920
+ end
921
+ def self.values
922
+ end
923
+ end
924
+ end
925
+ end
926
+
927
+ class ReportingConfiguration < Orb::BaseModel
928
+ sig { returns(T::Boolean) }
929
+ attr_accessor :exempt
930
+
931
+ sig { params(exempt: T::Boolean).returns(T.attached_class) }
932
+ def self.new(exempt:)
933
+ end
934
+
935
+ sig { override.returns({exempt: T::Boolean}) }
936
+ def to_hash
937
+ end
938
+ end
939
+ end
940
+ end
941
+ end