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,1654 @@
1
+ # typed: strong
2
+
3
+ module Orb
4
+ module Models
5
+ module Customers
6
+ module Credits
7
+ # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
8
+ # credits within Orb.
9
+ module LedgerListByExternalIDResponse
10
+ extend Orb::Union
11
+
12
+ class IncrementLedgerEntry < Orb::BaseModel
13
+ sig { returns(String) }
14
+ attr_accessor :id
15
+
16
+ sig { returns(Float) }
17
+ attr_accessor :amount
18
+
19
+ sig { returns(Time) }
20
+ attr_accessor :created_at
21
+
22
+ sig do
23
+ returns(
24
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::CreditBlock
25
+ )
26
+ end
27
+ attr_reader :credit_block
28
+
29
+ sig do
30
+ params(
31
+ credit_block: T.any(
32
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::CreditBlock,
33
+ Orb::Util::AnyHash
34
+ )
35
+ )
36
+ .void
37
+ end
38
+ attr_writer :credit_block
39
+
40
+ sig { returns(String) }
41
+ attr_accessor :currency
42
+
43
+ sig { returns(Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::Customer) }
44
+ attr_reader :customer
45
+
46
+ sig do
47
+ params(
48
+ customer: T.any(
49
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::Customer,
50
+ Orb::Util::AnyHash
51
+ )
52
+ )
53
+ .void
54
+ end
55
+ attr_writer :customer
56
+
57
+ sig { returns(T.nilable(String)) }
58
+ attr_accessor :description
59
+
60
+ sig { returns(Float) }
61
+ attr_accessor :ending_balance
62
+
63
+ sig do
64
+ returns(
65
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::EntryStatus::TaggedSymbol
66
+ )
67
+ end
68
+ attr_accessor :entry_status
69
+
70
+ sig { returns(Symbol) }
71
+ attr_accessor :entry_type
72
+
73
+ sig { returns(Integer) }
74
+ attr_accessor :ledger_sequence_number
75
+
76
+ # User specified key-value pairs for the resource. If not present, this defaults
77
+ # to an empty dictionary. Individual keys can be removed by setting the value to
78
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
79
+ # `null`.
80
+ sig { returns(T::Hash[Symbol, String]) }
81
+ attr_accessor :metadata
82
+
83
+ sig { returns(Float) }
84
+ attr_accessor :starting_balance
85
+
86
+ sig do
87
+ params(
88
+ id: String,
89
+ amount: Float,
90
+ created_at: Time,
91
+ credit_block: T.any(
92
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::CreditBlock,
93
+ Orb::Util::AnyHash
94
+ ),
95
+ currency: String,
96
+ customer: T.any(
97
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::Customer,
98
+ Orb::Util::AnyHash
99
+ ),
100
+ description: T.nilable(String),
101
+ ending_balance: Float,
102
+ entry_status: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::EntryStatus::OrSymbol,
103
+ ledger_sequence_number: Integer,
104
+ metadata: T::Hash[Symbol, String],
105
+ starting_balance: Float,
106
+ entry_type: Symbol
107
+ )
108
+ .returns(T.attached_class)
109
+ end
110
+ def self.new(
111
+ id:,
112
+ amount:,
113
+ created_at:,
114
+ credit_block:,
115
+ currency:,
116
+ customer:,
117
+ description:,
118
+ ending_balance:,
119
+ entry_status:,
120
+ ledger_sequence_number:,
121
+ metadata:,
122
+ starting_balance:,
123
+ entry_type: :increment
124
+ )
125
+ end
126
+
127
+ sig do
128
+ override
129
+ .returns(
130
+ {
131
+ id: String,
132
+ amount: Float,
133
+ created_at: Time,
134
+ credit_block: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::CreditBlock,
135
+ currency: String,
136
+ customer: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::Customer,
137
+ description: T.nilable(String),
138
+ ending_balance: Float,
139
+ entry_status: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::EntryStatus::TaggedSymbol,
140
+ entry_type: Symbol,
141
+ ledger_sequence_number: Integer,
142
+ metadata: T::Hash[Symbol, String],
143
+ starting_balance: Float
144
+ }
145
+ )
146
+ end
147
+ def to_hash
148
+ end
149
+
150
+ class CreditBlock < Orb::BaseModel
151
+ sig { returns(String) }
152
+ attr_accessor :id
153
+
154
+ sig { returns(T.nilable(Time)) }
155
+ attr_accessor :expiry_date
156
+
157
+ sig { returns(T.nilable(String)) }
158
+ attr_accessor :per_unit_cost_basis
159
+
160
+ sig do
161
+ params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String))
162
+ .returns(T.attached_class)
163
+ end
164
+ def self.new(id:, expiry_date:, per_unit_cost_basis:)
165
+ end
166
+
167
+ sig do
168
+ override.returns(
169
+ {
170
+ id: String,
171
+ expiry_date: T.nilable(Time),
172
+ per_unit_cost_basis: T.nilable(String)
173
+ }
174
+ )
175
+ end
176
+ def to_hash
177
+ end
178
+ end
179
+
180
+ class Customer < Orb::BaseModel
181
+ sig { returns(String) }
182
+ attr_accessor :id
183
+
184
+ sig { returns(T.nilable(String)) }
185
+ attr_accessor :external_customer_id
186
+
187
+ sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) }
188
+ def self.new(id:, external_customer_id:)
189
+ end
190
+
191
+ sig { override.returns({id: String, external_customer_id: T.nilable(String)}) }
192
+ def to_hash
193
+ end
194
+ end
195
+
196
+ module EntryStatus
197
+ extend Orb::Enum
198
+
199
+ TaggedSymbol =
200
+ T.type_alias do
201
+ T.all(Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::EntryStatus)
202
+ end
203
+ OrSymbol =
204
+ T.type_alias do
205
+ T.any(
206
+ Symbol,
207
+ String,
208
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::EntryStatus::TaggedSymbol
209
+ )
210
+ end
211
+
212
+ COMMITTED =
213
+ T.let(
214
+ :committed,
215
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::EntryStatus::TaggedSymbol
216
+ )
217
+ PENDING =
218
+ T.let(
219
+ :pending,
220
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::EntryStatus::TaggedSymbol
221
+ )
222
+
223
+ sig do
224
+ override
225
+ .returns(
226
+ T::Array[
227
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::EntryStatus::TaggedSymbol
228
+ ]
229
+ )
230
+ end
231
+ def self.values
232
+ end
233
+ end
234
+ end
235
+
236
+ class DecrementLedgerEntry < Orb::BaseModel
237
+ sig { returns(String) }
238
+ attr_accessor :id
239
+
240
+ sig { returns(Float) }
241
+ attr_accessor :amount
242
+
243
+ sig { returns(Time) }
244
+ attr_accessor :created_at
245
+
246
+ sig do
247
+ returns(
248
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::CreditBlock
249
+ )
250
+ end
251
+ attr_reader :credit_block
252
+
253
+ sig do
254
+ params(
255
+ credit_block: T.any(
256
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::CreditBlock,
257
+ Orb::Util::AnyHash
258
+ )
259
+ )
260
+ .void
261
+ end
262
+ attr_writer :credit_block
263
+
264
+ sig { returns(String) }
265
+ attr_accessor :currency
266
+
267
+ sig { returns(Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::Customer) }
268
+ attr_reader :customer
269
+
270
+ sig do
271
+ params(
272
+ customer: T.any(
273
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::Customer,
274
+ Orb::Util::AnyHash
275
+ )
276
+ )
277
+ .void
278
+ end
279
+ attr_writer :customer
280
+
281
+ sig { returns(T.nilable(String)) }
282
+ attr_accessor :description
283
+
284
+ sig { returns(Float) }
285
+ attr_accessor :ending_balance
286
+
287
+ sig do
288
+ returns(
289
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::EntryStatus::TaggedSymbol
290
+ )
291
+ end
292
+ attr_accessor :entry_status
293
+
294
+ sig { returns(Symbol) }
295
+ attr_accessor :entry_type
296
+
297
+ sig { returns(Integer) }
298
+ attr_accessor :ledger_sequence_number
299
+
300
+ # User specified key-value pairs for the resource. If not present, this defaults
301
+ # to an empty dictionary. Individual keys can be removed by setting the value to
302
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
303
+ # `null`.
304
+ sig { returns(T::Hash[Symbol, String]) }
305
+ attr_accessor :metadata
306
+
307
+ sig { returns(Float) }
308
+ attr_accessor :starting_balance
309
+
310
+ sig { returns(T.nilable(String)) }
311
+ attr_accessor :event_id
312
+
313
+ sig { returns(T.nilable(String)) }
314
+ attr_accessor :invoice_id
315
+
316
+ sig { returns(T.nilable(String)) }
317
+ attr_accessor :price_id
318
+
319
+ sig do
320
+ params(
321
+ id: String,
322
+ amount: Float,
323
+ created_at: Time,
324
+ credit_block: T.any(
325
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::CreditBlock,
326
+ Orb::Util::AnyHash
327
+ ),
328
+ currency: String,
329
+ customer: T.any(
330
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::Customer,
331
+ Orb::Util::AnyHash
332
+ ),
333
+ description: T.nilable(String),
334
+ ending_balance: Float,
335
+ entry_status: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::EntryStatus::OrSymbol,
336
+ ledger_sequence_number: Integer,
337
+ metadata: T::Hash[Symbol, String],
338
+ starting_balance: Float,
339
+ event_id: T.nilable(String),
340
+ invoice_id: T.nilable(String),
341
+ price_id: T.nilable(String),
342
+ entry_type: Symbol
343
+ )
344
+ .returns(T.attached_class)
345
+ end
346
+ def self.new(
347
+ id:,
348
+ amount:,
349
+ created_at:,
350
+ credit_block:,
351
+ currency:,
352
+ customer:,
353
+ description:,
354
+ ending_balance:,
355
+ entry_status:,
356
+ ledger_sequence_number:,
357
+ metadata:,
358
+ starting_balance:,
359
+ event_id: nil,
360
+ invoice_id: nil,
361
+ price_id: nil,
362
+ entry_type: :decrement
363
+ )
364
+ end
365
+
366
+ sig do
367
+ override
368
+ .returns(
369
+ {
370
+ id: String,
371
+ amount: Float,
372
+ created_at: Time,
373
+ credit_block: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::CreditBlock,
374
+ currency: String,
375
+ customer: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::Customer,
376
+ description: T.nilable(String),
377
+ ending_balance: Float,
378
+ entry_status: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::EntryStatus::TaggedSymbol,
379
+ entry_type: Symbol,
380
+ ledger_sequence_number: Integer,
381
+ metadata: T::Hash[Symbol, String],
382
+ starting_balance: Float,
383
+ event_id: T.nilable(String),
384
+ invoice_id: T.nilable(String),
385
+ price_id: T.nilable(String)
386
+ }
387
+ )
388
+ end
389
+ def to_hash
390
+ end
391
+
392
+ class CreditBlock < Orb::BaseModel
393
+ sig { returns(String) }
394
+ attr_accessor :id
395
+
396
+ sig { returns(T.nilable(Time)) }
397
+ attr_accessor :expiry_date
398
+
399
+ sig { returns(T.nilable(String)) }
400
+ attr_accessor :per_unit_cost_basis
401
+
402
+ sig do
403
+ params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String))
404
+ .returns(T.attached_class)
405
+ end
406
+ def self.new(id:, expiry_date:, per_unit_cost_basis:)
407
+ end
408
+
409
+ sig do
410
+ override.returns(
411
+ {
412
+ id: String,
413
+ expiry_date: T.nilable(Time),
414
+ per_unit_cost_basis: T.nilable(String)
415
+ }
416
+ )
417
+ end
418
+ def to_hash
419
+ end
420
+ end
421
+
422
+ class Customer < Orb::BaseModel
423
+ sig { returns(String) }
424
+ attr_accessor :id
425
+
426
+ sig { returns(T.nilable(String)) }
427
+ attr_accessor :external_customer_id
428
+
429
+ sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) }
430
+ def self.new(id:, external_customer_id:)
431
+ end
432
+
433
+ sig { override.returns({id: String, external_customer_id: T.nilable(String)}) }
434
+ def to_hash
435
+ end
436
+ end
437
+
438
+ module EntryStatus
439
+ extend Orb::Enum
440
+
441
+ TaggedSymbol =
442
+ T.type_alias do
443
+ T.all(Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::EntryStatus)
444
+ end
445
+ OrSymbol =
446
+ T.type_alias do
447
+ T.any(
448
+ Symbol,
449
+ String,
450
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::EntryStatus::TaggedSymbol
451
+ )
452
+ end
453
+
454
+ COMMITTED =
455
+ T.let(
456
+ :committed,
457
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::EntryStatus::TaggedSymbol
458
+ )
459
+ PENDING =
460
+ T.let(
461
+ :pending,
462
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::EntryStatus::TaggedSymbol
463
+ )
464
+
465
+ sig do
466
+ override
467
+ .returns(
468
+ T::Array[
469
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::EntryStatus::TaggedSymbol
470
+ ]
471
+ )
472
+ end
473
+ def self.values
474
+ end
475
+ end
476
+ end
477
+
478
+ class ExpirationChangeLedgerEntry < Orb::BaseModel
479
+ sig { returns(String) }
480
+ attr_accessor :id
481
+
482
+ sig { returns(Float) }
483
+ attr_accessor :amount
484
+
485
+ sig { returns(Time) }
486
+ attr_accessor :created_at
487
+
488
+ sig do
489
+ returns(
490
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::CreditBlock
491
+ )
492
+ end
493
+ attr_reader :credit_block
494
+
495
+ sig do
496
+ params(
497
+ credit_block: T.any(
498
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::CreditBlock,
499
+ Orb::Util::AnyHash
500
+ )
501
+ )
502
+ .void
503
+ end
504
+ attr_writer :credit_block
505
+
506
+ sig { returns(String) }
507
+ attr_accessor :currency
508
+
509
+ sig do
510
+ returns(
511
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::Customer
512
+ )
513
+ end
514
+ attr_reader :customer
515
+
516
+ sig do
517
+ params(
518
+ customer: T.any(
519
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::Customer,
520
+ Orb::Util::AnyHash
521
+ )
522
+ )
523
+ .void
524
+ end
525
+ attr_writer :customer
526
+
527
+ sig { returns(T.nilable(String)) }
528
+ attr_accessor :description
529
+
530
+ sig { returns(Float) }
531
+ attr_accessor :ending_balance
532
+
533
+ sig do
534
+ returns(
535
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus::TaggedSymbol
536
+ )
537
+ end
538
+ attr_accessor :entry_status
539
+
540
+ sig { returns(Symbol) }
541
+ attr_accessor :entry_type
542
+
543
+ sig { returns(Integer) }
544
+ attr_accessor :ledger_sequence_number
545
+
546
+ # User specified key-value pairs for the resource. If not present, this defaults
547
+ # to an empty dictionary. Individual keys can be removed by setting the value to
548
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
549
+ # `null`.
550
+ sig { returns(T::Hash[Symbol, String]) }
551
+ attr_accessor :metadata
552
+
553
+ sig { returns(T.nilable(Time)) }
554
+ attr_accessor :new_block_expiry_date
555
+
556
+ sig { returns(Float) }
557
+ attr_accessor :starting_balance
558
+
559
+ sig do
560
+ params(
561
+ id: String,
562
+ amount: Float,
563
+ created_at: Time,
564
+ credit_block: T.any(
565
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::CreditBlock,
566
+ Orb::Util::AnyHash
567
+ ),
568
+ currency: String,
569
+ customer: T.any(
570
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::Customer,
571
+ Orb::Util::AnyHash
572
+ ),
573
+ description: T.nilable(String),
574
+ ending_balance: Float,
575
+ entry_status: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus::OrSymbol,
576
+ ledger_sequence_number: Integer,
577
+ metadata: T::Hash[Symbol, String],
578
+ new_block_expiry_date: T.nilable(Time),
579
+ starting_balance: Float,
580
+ entry_type: Symbol
581
+ )
582
+ .returns(T.attached_class)
583
+ end
584
+ def self.new(
585
+ id:,
586
+ amount:,
587
+ created_at:,
588
+ credit_block:,
589
+ currency:,
590
+ customer:,
591
+ description:,
592
+ ending_balance:,
593
+ entry_status:,
594
+ ledger_sequence_number:,
595
+ metadata:,
596
+ new_block_expiry_date:,
597
+ starting_balance:,
598
+ entry_type: :expiration_change
599
+ )
600
+ end
601
+
602
+ sig do
603
+ override
604
+ .returns(
605
+ {
606
+ id: String,
607
+ amount: Float,
608
+ created_at: Time,
609
+ credit_block: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::CreditBlock,
610
+ currency: String,
611
+ customer: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::Customer,
612
+ description: T.nilable(String),
613
+ ending_balance: Float,
614
+ entry_status: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus::TaggedSymbol,
615
+ entry_type: Symbol,
616
+ ledger_sequence_number: Integer,
617
+ metadata: T::Hash[Symbol, String],
618
+ new_block_expiry_date: T.nilable(Time),
619
+ starting_balance: Float
620
+ }
621
+ )
622
+ end
623
+ def to_hash
624
+ end
625
+
626
+ class CreditBlock < Orb::BaseModel
627
+ sig { returns(String) }
628
+ attr_accessor :id
629
+
630
+ sig { returns(T.nilable(Time)) }
631
+ attr_accessor :expiry_date
632
+
633
+ sig { returns(T.nilable(String)) }
634
+ attr_accessor :per_unit_cost_basis
635
+
636
+ sig do
637
+ params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String))
638
+ .returns(T.attached_class)
639
+ end
640
+ def self.new(id:, expiry_date:, per_unit_cost_basis:)
641
+ end
642
+
643
+ sig do
644
+ override.returns(
645
+ {
646
+ id: String,
647
+ expiry_date: T.nilable(Time),
648
+ per_unit_cost_basis: T.nilable(String)
649
+ }
650
+ )
651
+ end
652
+ def to_hash
653
+ end
654
+ end
655
+
656
+ class Customer < Orb::BaseModel
657
+ sig { returns(String) }
658
+ attr_accessor :id
659
+
660
+ sig { returns(T.nilable(String)) }
661
+ attr_accessor :external_customer_id
662
+
663
+ sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) }
664
+ def self.new(id:, external_customer_id:)
665
+ end
666
+
667
+ sig { override.returns({id: String, external_customer_id: T.nilable(String)}) }
668
+ def to_hash
669
+ end
670
+ end
671
+
672
+ module EntryStatus
673
+ extend Orb::Enum
674
+
675
+ TaggedSymbol =
676
+ T.type_alias do
677
+ T.all(Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus)
678
+ end
679
+ OrSymbol =
680
+ T.type_alias do
681
+ T.any(
682
+ Symbol,
683
+ String,
684
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus::TaggedSymbol
685
+ )
686
+ end
687
+
688
+ COMMITTED =
689
+ T.let(
690
+ :committed,
691
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus::TaggedSymbol
692
+ )
693
+ PENDING =
694
+ T.let(
695
+ :pending,
696
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus::TaggedSymbol
697
+ )
698
+
699
+ sig do
700
+ override
701
+ .returns(
702
+ T::Array[
703
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus::TaggedSymbol
704
+ ]
705
+ )
706
+ end
707
+ def self.values
708
+ end
709
+ end
710
+ end
711
+
712
+ class CreditBlockExpiryLedgerEntry < Orb::BaseModel
713
+ sig { returns(String) }
714
+ attr_accessor :id
715
+
716
+ sig { returns(Float) }
717
+ attr_accessor :amount
718
+
719
+ sig { returns(Time) }
720
+ attr_accessor :created_at
721
+
722
+ sig do
723
+ returns(
724
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::CreditBlock
725
+ )
726
+ end
727
+ attr_reader :credit_block
728
+
729
+ sig do
730
+ params(
731
+ credit_block: T.any(
732
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::CreditBlock,
733
+ Orb::Util::AnyHash
734
+ )
735
+ )
736
+ .void
737
+ end
738
+ attr_writer :credit_block
739
+
740
+ sig { returns(String) }
741
+ attr_accessor :currency
742
+
743
+ sig do
744
+ returns(
745
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::Customer
746
+ )
747
+ end
748
+ attr_reader :customer
749
+
750
+ sig do
751
+ params(
752
+ customer: T.any(
753
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::Customer,
754
+ Orb::Util::AnyHash
755
+ )
756
+ )
757
+ .void
758
+ end
759
+ attr_writer :customer
760
+
761
+ sig { returns(T.nilable(String)) }
762
+ attr_accessor :description
763
+
764
+ sig { returns(Float) }
765
+ attr_accessor :ending_balance
766
+
767
+ sig do
768
+ returns(
769
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus::TaggedSymbol
770
+ )
771
+ end
772
+ attr_accessor :entry_status
773
+
774
+ sig { returns(Symbol) }
775
+ attr_accessor :entry_type
776
+
777
+ sig { returns(Integer) }
778
+ attr_accessor :ledger_sequence_number
779
+
780
+ # User specified key-value pairs for the resource. If not present, this defaults
781
+ # to an empty dictionary. Individual keys can be removed by setting the value to
782
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
783
+ # `null`.
784
+ sig { returns(T::Hash[Symbol, String]) }
785
+ attr_accessor :metadata
786
+
787
+ sig { returns(Float) }
788
+ attr_accessor :starting_balance
789
+
790
+ sig do
791
+ params(
792
+ id: String,
793
+ amount: Float,
794
+ created_at: Time,
795
+ credit_block: T.any(
796
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::CreditBlock,
797
+ Orb::Util::AnyHash
798
+ ),
799
+ currency: String,
800
+ customer: T.any(
801
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::Customer,
802
+ Orb::Util::AnyHash
803
+ ),
804
+ description: T.nilable(String),
805
+ ending_balance: Float,
806
+ entry_status: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus::OrSymbol,
807
+ ledger_sequence_number: Integer,
808
+ metadata: T::Hash[Symbol, String],
809
+ starting_balance: Float,
810
+ entry_type: Symbol
811
+ )
812
+ .returns(T.attached_class)
813
+ end
814
+ def self.new(
815
+ id:,
816
+ amount:,
817
+ created_at:,
818
+ credit_block:,
819
+ currency:,
820
+ customer:,
821
+ description:,
822
+ ending_balance:,
823
+ entry_status:,
824
+ ledger_sequence_number:,
825
+ metadata:,
826
+ starting_balance:,
827
+ entry_type: :credit_block_expiry
828
+ )
829
+ end
830
+
831
+ sig do
832
+ override
833
+ .returns(
834
+ {
835
+ id: String,
836
+ amount: Float,
837
+ created_at: Time,
838
+ credit_block: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::CreditBlock,
839
+ currency: String,
840
+ customer: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::Customer,
841
+ description: T.nilable(String),
842
+ ending_balance: Float,
843
+ entry_status: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus::TaggedSymbol,
844
+ entry_type: Symbol,
845
+ ledger_sequence_number: Integer,
846
+ metadata: T::Hash[Symbol, String],
847
+ starting_balance: Float
848
+ }
849
+ )
850
+ end
851
+ def to_hash
852
+ end
853
+
854
+ class CreditBlock < Orb::BaseModel
855
+ sig { returns(String) }
856
+ attr_accessor :id
857
+
858
+ sig { returns(T.nilable(Time)) }
859
+ attr_accessor :expiry_date
860
+
861
+ sig { returns(T.nilable(String)) }
862
+ attr_accessor :per_unit_cost_basis
863
+
864
+ sig do
865
+ params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String))
866
+ .returns(T.attached_class)
867
+ end
868
+ def self.new(id:, expiry_date:, per_unit_cost_basis:)
869
+ end
870
+
871
+ sig do
872
+ override.returns(
873
+ {
874
+ id: String,
875
+ expiry_date: T.nilable(Time),
876
+ per_unit_cost_basis: T.nilable(String)
877
+ }
878
+ )
879
+ end
880
+ def to_hash
881
+ end
882
+ end
883
+
884
+ class Customer < Orb::BaseModel
885
+ sig { returns(String) }
886
+ attr_accessor :id
887
+
888
+ sig { returns(T.nilable(String)) }
889
+ attr_accessor :external_customer_id
890
+
891
+ sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) }
892
+ def self.new(id:, external_customer_id:)
893
+ end
894
+
895
+ sig { override.returns({id: String, external_customer_id: T.nilable(String)}) }
896
+ def to_hash
897
+ end
898
+ end
899
+
900
+ module EntryStatus
901
+ extend Orb::Enum
902
+
903
+ TaggedSymbol =
904
+ T.type_alias do
905
+ T.all(Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus)
906
+ end
907
+ OrSymbol =
908
+ T.type_alias do
909
+ T.any(
910
+ Symbol,
911
+ String,
912
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus::TaggedSymbol
913
+ )
914
+ end
915
+
916
+ COMMITTED =
917
+ T.let(
918
+ :committed,
919
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus::TaggedSymbol
920
+ )
921
+ PENDING =
922
+ T.let(
923
+ :pending,
924
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus::TaggedSymbol
925
+ )
926
+
927
+ sig do
928
+ override
929
+ .returns(
930
+ T::Array[
931
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus::TaggedSymbol
932
+ ]
933
+ )
934
+ end
935
+ def self.values
936
+ end
937
+ end
938
+ end
939
+
940
+ class VoidLedgerEntry < Orb::BaseModel
941
+ sig { returns(String) }
942
+ attr_accessor :id
943
+
944
+ sig { returns(Float) }
945
+ attr_accessor :amount
946
+
947
+ sig { returns(Time) }
948
+ attr_accessor :created_at
949
+
950
+ sig { returns(Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::CreditBlock) }
951
+ attr_reader :credit_block
952
+
953
+ sig do
954
+ params(
955
+ credit_block: T.any(
956
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::CreditBlock,
957
+ Orb::Util::AnyHash
958
+ )
959
+ )
960
+ .void
961
+ end
962
+ attr_writer :credit_block
963
+
964
+ sig { returns(String) }
965
+ attr_accessor :currency
966
+
967
+ sig { returns(Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::Customer) }
968
+ attr_reader :customer
969
+
970
+ sig do
971
+ params(
972
+ customer: T.any(
973
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::Customer,
974
+ Orb::Util::AnyHash
975
+ )
976
+ )
977
+ .void
978
+ end
979
+ attr_writer :customer
980
+
981
+ sig { returns(T.nilable(String)) }
982
+ attr_accessor :description
983
+
984
+ sig { returns(Float) }
985
+ attr_accessor :ending_balance
986
+
987
+ sig do
988
+ returns(
989
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::EntryStatus::TaggedSymbol
990
+ )
991
+ end
992
+ attr_accessor :entry_status
993
+
994
+ sig { returns(Symbol) }
995
+ attr_accessor :entry_type
996
+
997
+ sig { returns(Integer) }
998
+ attr_accessor :ledger_sequence_number
999
+
1000
+ # User specified key-value pairs for the resource. If not present, this defaults
1001
+ # to an empty dictionary. Individual keys can be removed by setting the value to
1002
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
1003
+ # `null`.
1004
+ sig { returns(T::Hash[Symbol, String]) }
1005
+ attr_accessor :metadata
1006
+
1007
+ sig { returns(Float) }
1008
+ attr_accessor :starting_balance
1009
+
1010
+ sig { returns(Float) }
1011
+ attr_accessor :void_amount
1012
+
1013
+ sig { returns(T.nilable(String)) }
1014
+ attr_accessor :void_reason
1015
+
1016
+ sig do
1017
+ params(
1018
+ id: String,
1019
+ amount: Float,
1020
+ created_at: Time,
1021
+ credit_block: T.any(
1022
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::CreditBlock,
1023
+ Orb::Util::AnyHash
1024
+ ),
1025
+ currency: String,
1026
+ customer: T.any(
1027
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::Customer,
1028
+ Orb::Util::AnyHash
1029
+ ),
1030
+ description: T.nilable(String),
1031
+ ending_balance: Float,
1032
+ entry_status: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::EntryStatus::OrSymbol,
1033
+ ledger_sequence_number: Integer,
1034
+ metadata: T::Hash[Symbol, String],
1035
+ starting_balance: Float,
1036
+ void_amount: Float,
1037
+ void_reason: T.nilable(String),
1038
+ entry_type: Symbol
1039
+ )
1040
+ .returns(T.attached_class)
1041
+ end
1042
+ def self.new(
1043
+ id:,
1044
+ amount:,
1045
+ created_at:,
1046
+ credit_block:,
1047
+ currency:,
1048
+ customer:,
1049
+ description:,
1050
+ ending_balance:,
1051
+ entry_status:,
1052
+ ledger_sequence_number:,
1053
+ metadata:,
1054
+ starting_balance:,
1055
+ void_amount:,
1056
+ void_reason:,
1057
+ entry_type: :void
1058
+ )
1059
+ end
1060
+
1061
+ sig do
1062
+ override
1063
+ .returns(
1064
+ {
1065
+ id: String,
1066
+ amount: Float,
1067
+ created_at: Time,
1068
+ credit_block: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::CreditBlock,
1069
+ currency: String,
1070
+ customer: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::Customer,
1071
+ description: T.nilable(String),
1072
+ ending_balance: Float,
1073
+ entry_status: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::EntryStatus::TaggedSymbol,
1074
+ entry_type: Symbol,
1075
+ ledger_sequence_number: Integer,
1076
+ metadata: T::Hash[Symbol, String],
1077
+ starting_balance: Float,
1078
+ void_amount: Float,
1079
+ void_reason: T.nilable(String)
1080
+ }
1081
+ )
1082
+ end
1083
+ def to_hash
1084
+ end
1085
+
1086
+ class CreditBlock < Orb::BaseModel
1087
+ sig { returns(String) }
1088
+ attr_accessor :id
1089
+
1090
+ sig { returns(T.nilable(Time)) }
1091
+ attr_accessor :expiry_date
1092
+
1093
+ sig { returns(T.nilable(String)) }
1094
+ attr_accessor :per_unit_cost_basis
1095
+
1096
+ sig do
1097
+ params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String))
1098
+ .returns(T.attached_class)
1099
+ end
1100
+ def self.new(id:, expiry_date:, per_unit_cost_basis:)
1101
+ end
1102
+
1103
+ sig do
1104
+ override.returns(
1105
+ {
1106
+ id: String,
1107
+ expiry_date: T.nilable(Time),
1108
+ per_unit_cost_basis: T.nilable(String)
1109
+ }
1110
+ )
1111
+ end
1112
+ def to_hash
1113
+ end
1114
+ end
1115
+
1116
+ class Customer < Orb::BaseModel
1117
+ sig { returns(String) }
1118
+ attr_accessor :id
1119
+
1120
+ sig { returns(T.nilable(String)) }
1121
+ attr_accessor :external_customer_id
1122
+
1123
+ sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) }
1124
+ def self.new(id:, external_customer_id:)
1125
+ end
1126
+
1127
+ sig { override.returns({id: String, external_customer_id: T.nilable(String)}) }
1128
+ def to_hash
1129
+ end
1130
+ end
1131
+
1132
+ module EntryStatus
1133
+ extend Orb::Enum
1134
+
1135
+ TaggedSymbol =
1136
+ T.type_alias do
1137
+ T.all(Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::EntryStatus)
1138
+ end
1139
+ OrSymbol =
1140
+ T.type_alias do
1141
+ T.any(
1142
+ Symbol,
1143
+ String,
1144
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::EntryStatus::TaggedSymbol
1145
+ )
1146
+ end
1147
+
1148
+ COMMITTED =
1149
+ T.let(
1150
+ :committed,
1151
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::EntryStatus::TaggedSymbol
1152
+ )
1153
+ PENDING =
1154
+ T.let(
1155
+ :pending,
1156
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::EntryStatus::TaggedSymbol
1157
+ )
1158
+
1159
+ sig do
1160
+ override
1161
+ .returns(
1162
+ T::Array[
1163
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::EntryStatus::TaggedSymbol
1164
+ ]
1165
+ )
1166
+ end
1167
+ def self.values
1168
+ end
1169
+ end
1170
+ end
1171
+
1172
+ class VoidInitiatedLedgerEntry < Orb::BaseModel
1173
+ sig { returns(String) }
1174
+ attr_accessor :id
1175
+
1176
+ sig { returns(Float) }
1177
+ attr_accessor :amount
1178
+
1179
+ sig { returns(Time) }
1180
+ attr_accessor :created_at
1181
+
1182
+ sig do
1183
+ returns(
1184
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::CreditBlock
1185
+ )
1186
+ end
1187
+ attr_reader :credit_block
1188
+
1189
+ sig do
1190
+ params(
1191
+ credit_block: T.any(
1192
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::CreditBlock,
1193
+ Orb::Util::AnyHash
1194
+ )
1195
+ )
1196
+ .void
1197
+ end
1198
+ attr_writer :credit_block
1199
+
1200
+ sig { returns(String) }
1201
+ attr_accessor :currency
1202
+
1203
+ sig do
1204
+ returns(
1205
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::Customer
1206
+ )
1207
+ end
1208
+ attr_reader :customer
1209
+
1210
+ sig do
1211
+ params(
1212
+ customer: T.any(
1213
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::Customer,
1214
+ Orb::Util::AnyHash
1215
+ )
1216
+ )
1217
+ .void
1218
+ end
1219
+ attr_writer :customer
1220
+
1221
+ sig { returns(T.nilable(String)) }
1222
+ attr_accessor :description
1223
+
1224
+ sig { returns(Float) }
1225
+ attr_accessor :ending_balance
1226
+
1227
+ sig do
1228
+ returns(
1229
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus::TaggedSymbol
1230
+ )
1231
+ end
1232
+ attr_accessor :entry_status
1233
+
1234
+ sig { returns(Symbol) }
1235
+ attr_accessor :entry_type
1236
+
1237
+ sig { returns(Integer) }
1238
+ attr_accessor :ledger_sequence_number
1239
+
1240
+ # User specified key-value pairs for the resource. If not present, this defaults
1241
+ # to an empty dictionary. Individual keys can be removed by setting the value to
1242
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
1243
+ # `null`.
1244
+ sig { returns(T::Hash[Symbol, String]) }
1245
+ attr_accessor :metadata
1246
+
1247
+ sig { returns(Time) }
1248
+ attr_accessor :new_block_expiry_date
1249
+
1250
+ sig { returns(Float) }
1251
+ attr_accessor :starting_balance
1252
+
1253
+ sig { returns(Float) }
1254
+ attr_accessor :void_amount
1255
+
1256
+ sig { returns(T.nilable(String)) }
1257
+ attr_accessor :void_reason
1258
+
1259
+ sig do
1260
+ params(
1261
+ id: String,
1262
+ amount: Float,
1263
+ created_at: Time,
1264
+ credit_block: T.any(
1265
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::CreditBlock,
1266
+ Orb::Util::AnyHash
1267
+ ),
1268
+ currency: String,
1269
+ customer: T.any(
1270
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::Customer,
1271
+ Orb::Util::AnyHash
1272
+ ),
1273
+ description: T.nilable(String),
1274
+ ending_balance: Float,
1275
+ entry_status: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus::OrSymbol,
1276
+ ledger_sequence_number: Integer,
1277
+ metadata: T::Hash[Symbol, String],
1278
+ new_block_expiry_date: Time,
1279
+ starting_balance: Float,
1280
+ void_amount: Float,
1281
+ void_reason: T.nilable(String),
1282
+ entry_type: Symbol
1283
+ )
1284
+ .returns(T.attached_class)
1285
+ end
1286
+ def self.new(
1287
+ id:,
1288
+ amount:,
1289
+ created_at:,
1290
+ credit_block:,
1291
+ currency:,
1292
+ customer:,
1293
+ description:,
1294
+ ending_balance:,
1295
+ entry_status:,
1296
+ ledger_sequence_number:,
1297
+ metadata:,
1298
+ new_block_expiry_date:,
1299
+ starting_balance:,
1300
+ void_amount:,
1301
+ void_reason:,
1302
+ entry_type: :void_initiated
1303
+ )
1304
+ end
1305
+
1306
+ sig do
1307
+ override
1308
+ .returns(
1309
+ {
1310
+ id: String,
1311
+ amount: Float,
1312
+ created_at: Time,
1313
+ credit_block: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::CreditBlock,
1314
+ currency: String,
1315
+ customer: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::Customer,
1316
+ description: T.nilable(String),
1317
+ ending_balance: Float,
1318
+ entry_status: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus::TaggedSymbol,
1319
+ entry_type: Symbol,
1320
+ ledger_sequence_number: Integer,
1321
+ metadata: T::Hash[Symbol, String],
1322
+ new_block_expiry_date: Time,
1323
+ starting_balance: Float,
1324
+ void_amount: Float,
1325
+ void_reason: T.nilable(String)
1326
+ }
1327
+ )
1328
+ end
1329
+ def to_hash
1330
+ end
1331
+
1332
+ class CreditBlock < Orb::BaseModel
1333
+ sig { returns(String) }
1334
+ attr_accessor :id
1335
+
1336
+ sig { returns(T.nilable(Time)) }
1337
+ attr_accessor :expiry_date
1338
+
1339
+ sig { returns(T.nilable(String)) }
1340
+ attr_accessor :per_unit_cost_basis
1341
+
1342
+ sig do
1343
+ params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String))
1344
+ .returns(T.attached_class)
1345
+ end
1346
+ def self.new(id:, expiry_date:, per_unit_cost_basis:)
1347
+ end
1348
+
1349
+ sig do
1350
+ override.returns(
1351
+ {
1352
+ id: String,
1353
+ expiry_date: T.nilable(Time),
1354
+ per_unit_cost_basis: T.nilable(String)
1355
+ }
1356
+ )
1357
+ end
1358
+ def to_hash
1359
+ end
1360
+ end
1361
+
1362
+ class Customer < Orb::BaseModel
1363
+ sig { returns(String) }
1364
+ attr_accessor :id
1365
+
1366
+ sig { returns(T.nilable(String)) }
1367
+ attr_accessor :external_customer_id
1368
+
1369
+ sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) }
1370
+ def self.new(id:, external_customer_id:)
1371
+ end
1372
+
1373
+ sig { override.returns({id: String, external_customer_id: T.nilable(String)}) }
1374
+ def to_hash
1375
+ end
1376
+ end
1377
+
1378
+ module EntryStatus
1379
+ extend Orb::Enum
1380
+
1381
+ TaggedSymbol =
1382
+ T.type_alias do
1383
+ T.all(Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus)
1384
+ end
1385
+ OrSymbol =
1386
+ T.type_alias do
1387
+ T.any(
1388
+ Symbol,
1389
+ String,
1390
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus::TaggedSymbol
1391
+ )
1392
+ end
1393
+
1394
+ COMMITTED =
1395
+ T.let(
1396
+ :committed,
1397
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus::TaggedSymbol
1398
+ )
1399
+ PENDING =
1400
+ T.let(
1401
+ :pending,
1402
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus::TaggedSymbol
1403
+ )
1404
+
1405
+ sig do
1406
+ override
1407
+ .returns(
1408
+ T::Array[
1409
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus::TaggedSymbol
1410
+ ]
1411
+ )
1412
+ end
1413
+ def self.values
1414
+ end
1415
+ end
1416
+ end
1417
+
1418
+ class AmendmentLedgerEntry < Orb::BaseModel
1419
+ sig { returns(String) }
1420
+ attr_accessor :id
1421
+
1422
+ sig { returns(Float) }
1423
+ attr_accessor :amount
1424
+
1425
+ sig { returns(Time) }
1426
+ attr_accessor :created_at
1427
+
1428
+ sig do
1429
+ returns(
1430
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::CreditBlock
1431
+ )
1432
+ end
1433
+ attr_reader :credit_block
1434
+
1435
+ sig do
1436
+ params(
1437
+ credit_block: T.any(
1438
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::CreditBlock,
1439
+ Orb::Util::AnyHash
1440
+ )
1441
+ )
1442
+ .void
1443
+ end
1444
+ attr_writer :credit_block
1445
+
1446
+ sig { returns(String) }
1447
+ attr_accessor :currency
1448
+
1449
+ sig { returns(Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::Customer) }
1450
+ attr_reader :customer
1451
+
1452
+ sig do
1453
+ params(
1454
+ customer: T.any(
1455
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::Customer,
1456
+ Orb::Util::AnyHash
1457
+ )
1458
+ )
1459
+ .void
1460
+ end
1461
+ attr_writer :customer
1462
+
1463
+ sig { returns(T.nilable(String)) }
1464
+ attr_accessor :description
1465
+
1466
+ sig { returns(Float) }
1467
+ attr_accessor :ending_balance
1468
+
1469
+ sig do
1470
+ returns(
1471
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::EntryStatus::TaggedSymbol
1472
+ )
1473
+ end
1474
+ attr_accessor :entry_status
1475
+
1476
+ sig { returns(Symbol) }
1477
+ attr_accessor :entry_type
1478
+
1479
+ sig { returns(Integer) }
1480
+ attr_accessor :ledger_sequence_number
1481
+
1482
+ # User specified key-value pairs for the resource. If not present, this defaults
1483
+ # to an empty dictionary. Individual keys can be removed by setting the value to
1484
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
1485
+ # `null`.
1486
+ sig { returns(T::Hash[Symbol, String]) }
1487
+ attr_accessor :metadata
1488
+
1489
+ sig { returns(Float) }
1490
+ attr_accessor :starting_balance
1491
+
1492
+ sig do
1493
+ params(
1494
+ id: String,
1495
+ amount: Float,
1496
+ created_at: Time,
1497
+ credit_block: T.any(
1498
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::CreditBlock,
1499
+ Orb::Util::AnyHash
1500
+ ),
1501
+ currency: String,
1502
+ customer: T.any(
1503
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::Customer,
1504
+ Orb::Util::AnyHash
1505
+ ),
1506
+ description: T.nilable(String),
1507
+ ending_balance: Float,
1508
+ entry_status: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::EntryStatus::OrSymbol,
1509
+ ledger_sequence_number: Integer,
1510
+ metadata: T::Hash[Symbol, String],
1511
+ starting_balance: Float,
1512
+ entry_type: Symbol
1513
+ )
1514
+ .returns(T.attached_class)
1515
+ end
1516
+ def self.new(
1517
+ id:,
1518
+ amount:,
1519
+ created_at:,
1520
+ credit_block:,
1521
+ currency:,
1522
+ customer:,
1523
+ description:,
1524
+ ending_balance:,
1525
+ entry_status:,
1526
+ ledger_sequence_number:,
1527
+ metadata:,
1528
+ starting_balance:,
1529
+ entry_type: :amendment
1530
+ )
1531
+ end
1532
+
1533
+ sig do
1534
+ override
1535
+ .returns(
1536
+ {
1537
+ id: String,
1538
+ amount: Float,
1539
+ created_at: Time,
1540
+ credit_block: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::CreditBlock,
1541
+ currency: String,
1542
+ customer: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::Customer,
1543
+ description: T.nilable(String),
1544
+ ending_balance: Float,
1545
+ entry_status: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::EntryStatus::TaggedSymbol,
1546
+ entry_type: Symbol,
1547
+ ledger_sequence_number: Integer,
1548
+ metadata: T::Hash[Symbol, String],
1549
+ starting_balance: Float
1550
+ }
1551
+ )
1552
+ end
1553
+ def to_hash
1554
+ end
1555
+
1556
+ class CreditBlock < Orb::BaseModel
1557
+ sig { returns(String) }
1558
+ attr_accessor :id
1559
+
1560
+ sig { returns(T.nilable(Time)) }
1561
+ attr_accessor :expiry_date
1562
+
1563
+ sig { returns(T.nilable(String)) }
1564
+ attr_accessor :per_unit_cost_basis
1565
+
1566
+ sig do
1567
+ params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String))
1568
+ .returns(T.attached_class)
1569
+ end
1570
+ def self.new(id:, expiry_date:, per_unit_cost_basis:)
1571
+ end
1572
+
1573
+ sig do
1574
+ override.returns(
1575
+ {
1576
+ id: String,
1577
+ expiry_date: T.nilable(Time),
1578
+ per_unit_cost_basis: T.nilable(String)
1579
+ }
1580
+ )
1581
+ end
1582
+ def to_hash
1583
+ end
1584
+ end
1585
+
1586
+ class Customer < Orb::BaseModel
1587
+ sig { returns(String) }
1588
+ attr_accessor :id
1589
+
1590
+ sig { returns(T.nilable(String)) }
1591
+ attr_accessor :external_customer_id
1592
+
1593
+ sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) }
1594
+ def self.new(id:, external_customer_id:)
1595
+ end
1596
+
1597
+ sig { override.returns({id: String, external_customer_id: T.nilable(String)}) }
1598
+ def to_hash
1599
+ end
1600
+ end
1601
+
1602
+ module EntryStatus
1603
+ extend Orb::Enum
1604
+
1605
+ TaggedSymbol =
1606
+ T.type_alias do
1607
+ T.all(Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::EntryStatus)
1608
+ end
1609
+ OrSymbol =
1610
+ T.type_alias do
1611
+ T.any(
1612
+ Symbol,
1613
+ String,
1614
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::EntryStatus::TaggedSymbol
1615
+ )
1616
+ end
1617
+
1618
+ COMMITTED =
1619
+ T.let(
1620
+ :committed,
1621
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::EntryStatus::TaggedSymbol
1622
+ )
1623
+ PENDING =
1624
+ T.let(
1625
+ :pending,
1626
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::EntryStatus::TaggedSymbol
1627
+ )
1628
+
1629
+ sig do
1630
+ override
1631
+ .returns(
1632
+ T::Array[
1633
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::EntryStatus::TaggedSymbol
1634
+ ]
1635
+ )
1636
+ end
1637
+ def self.values
1638
+ end
1639
+ end
1640
+ end
1641
+
1642
+ sig do
1643
+ override
1644
+ .returns(
1645
+ [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry]
1646
+ )
1647
+ end
1648
+ def self.variants
1649
+ end
1650
+ end
1651
+ end
1652
+ end
1653
+ end
1654
+ end