orb-billing 0.1.0.pre.alpha.38 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (409) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +10 -2
  3. data/lib/orb/client.rb +4 -0
  4. data/lib/orb/internal/transport/base_client.rb +2 -2
  5. data/lib/orb/internal/transport/pooled_net_requester.rb +15 -6
  6. data/lib/orb/internal/type/array_of.rb +12 -2
  7. data/lib/orb/internal/type/base_model.rb +23 -22
  8. data/lib/orb/internal/type/boolean.rb +5 -1
  9. data/lib/orb/internal/type/converter.rb +62 -39
  10. data/lib/orb/internal/type/enum.rb +13 -9
  11. data/lib/orb/internal/type/hash_of.rb +6 -2
  12. data/lib/orb/internal/type/io_like.rb +75 -0
  13. data/lib/orb/internal/type/request_parameters.rb +11 -2
  14. data/lib/orb/internal/type/union.rb +7 -3
  15. data/lib/orb/internal/type/unknown.rb +5 -1
  16. data/lib/orb/internal/util.rb +81 -26
  17. data/lib/orb/models/alert.rb +9 -9
  18. data/lib/orb/models/alert_create_for_customer_params.rb +3 -3
  19. data/lib/orb/models/alert_create_for_external_customer_params.rb +3 -3
  20. data/lib/orb/models/alert_create_for_subscription_params.rb +3 -3
  21. data/lib/orb/models/alert_list_params.rb +5 -5
  22. data/lib/orb/models/alert_update_params.rb +3 -3
  23. data/lib/orb/models/amount_discount.rb +1 -1
  24. data/lib/orb/models/billable_metric.rb +7 -7
  25. data/lib/orb/models/coupon.rb +7 -7
  26. data/lib/orb/models/coupon_create_params.rb +2 -2
  27. data/lib/orb/models/coupon_list_params.rb +2 -2
  28. data/lib/orb/models/coupons/subscription_list_params.rb +1 -1
  29. data/lib/orb/models/credit_note.rb +1 -1
  30. data/lib/orb/models/credit_note_list_params.rb +5 -5
  31. data/lib/orb/models/customer.rb +232 -232
  32. data/lib/orb/models/customer_create_params.rb +223 -223
  33. data/lib/orb/models/customer_list_params.rb +5 -5
  34. data/lib/orb/models/customer_update_by_external_id_params.rb +224 -224
  35. data/lib/orb/models/customer_update_params.rb +224 -224
  36. data/lib/orb/models/customers/balance_transaction_create_response.rb +2 -2
  37. data/lib/orb/models/customers/balance_transaction_list_params.rb +5 -5
  38. data/lib/orb/models/customers/balance_transaction_list_response.rb +2 -2
  39. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +6 -6
  40. data/lib/orb/models/customers/cost_list_params.rb +6 -6
  41. data/lib/orb/models/customers/credit_list_by_external_id_params.rb +2 -2
  42. data/lib/orb/models/customers/credit_list_params.rb +2 -2
  43. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +20 -20
  44. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +22 -22
  45. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +20 -20
  46. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +22 -22
  47. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +5 -5
  48. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +22 -22
  49. data/lib/orb/models/customers/credits/ledger_list_params.rb +5 -5
  50. data/lib/orb/models/customers/credits/ledger_list_response.rb +22 -22
  51. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +8 -8
  52. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +7 -7
  53. data/lib/orb/models/customers/credits/top_up_create_params.rb +8 -8
  54. data/lib/orb/models/customers/credits/top_up_create_response.rb +7 -7
  55. data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +1 -1
  56. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +7 -7
  57. data/lib/orb/models/customers/credits/top_up_list_params.rb +1 -1
  58. data/lib/orb/models/customers/credits/top_up_list_response.rb +7 -7
  59. data/lib/orb/models/dimensional_price_group.rb +7 -7
  60. data/lib/orb/models/dimensional_price_group_create_params.rb +2 -2
  61. data/lib/orb/models/dimensional_price_group_list_params.rb +1 -1
  62. data/lib/orb/models/event_ingest_params.rb +7 -7
  63. data/lib/orb/models/event_ingest_response.rb +4 -4
  64. data/lib/orb/models/event_search_params.rb +5 -5
  65. data/lib/orb/models/event_search_response.rb +8 -8
  66. data/lib/orb/models/event_update_params.rb +4 -4
  67. data/lib/orb/models/events/backfill_close_response.rb +7 -7
  68. data/lib/orb/models/events/backfill_create_params.rb +11 -11
  69. data/lib/orb/models/events/backfill_create_response.rb +7 -7
  70. data/lib/orb/models/events/backfill_fetch_response.rb +7 -7
  71. data/lib/orb/models/events/backfill_list_params.rb +1 -1
  72. data/lib/orb/models/events/backfill_list_response.rb +7 -7
  73. data/lib/orb/models/events/backfill_revert_response.rb +7 -7
  74. data/lib/orb/models/events/event_volumes.rb +1 -1
  75. data/lib/orb/models/events/volume_list_params.rb +7 -7
  76. data/lib/orb/models/invoice.rb +270 -270
  77. data/lib/orb/models/invoice_create_params.rb +12 -11
  78. data/lib/orb/models/invoice_fetch_upcoming_response.rb +266 -266
  79. data/lib/orb/models/invoice_issue_params.rb +4 -4
  80. data/lib/orb/models/invoice_line_item_create_params.rb +1 -1
  81. data/lib/orb/models/invoice_line_item_create_response.rb +27 -27
  82. data/lib/orb/models/invoice_list_params.rb +12 -12
  83. data/lib/orb/models/invoice_update_params.rb +2 -2
  84. data/lib/orb/models/item.rb +2 -2
  85. data/lib/orb/models/item_list_params.rb +1 -1
  86. data/lib/orb/models/metric_create_params.rb +2 -2
  87. data/lib/orb/models/metric_list_params.rb +5 -5
  88. data/lib/orb/models/metric_update_params.rb +2 -2
  89. data/lib/orb/models/percentage_discount.rb +2 -2
  90. data/lib/orb/models/plan.rb +35 -35
  91. data/lib/orb/models/plan_create_params.rb +267 -267
  92. data/lib/orb/models/plan_list_params.rb +5 -5
  93. data/lib/orb/models/plan_update_params.rb +4 -4
  94. data/lib/orb/models/plans/external_plan_id_update_params.rb +4 -4
  95. data/lib/orb/models/price.rb +158 -158
  96. data/lib/orb/models/price_create_params.rb +20 -20
  97. data/lib/orb/models/price_evaluate_params.rb +4 -4
  98. data/lib/orb/models/price_list_params.rb +1 -1
  99. data/lib/orb/models/price_update_params.rb +2 -2
  100. data/lib/orb/models/prices/external_price_id_update_params.rb +2 -2
  101. data/lib/orb/models/subscription.rb +114 -87
  102. data/lib/orb/models/subscription_cancel_params.rb +3 -3
  103. data/lib/orb/models/subscription_cancel_response.rb +150 -72
  104. data/lib/orb/models/subscription_change_apply_params.rb +33 -0
  105. data/lib/orb/models/subscription_change_apply_response.rb +1372 -0
  106. data/lib/orb/models/subscription_change_cancel_params.rb +19 -0
  107. data/lib/orb/models/subscription_change_cancel_response.rb +1372 -0
  108. data/lib/orb/models/subscription_change_retrieve_params.rb +19 -0
  109. data/lib/orb/models/subscription_change_retrieve_response.rb +1372 -0
  110. data/lib/orb/models/subscription_create_params.rb +641 -641
  111. data/lib/orb/models/subscription_create_response.rb +150 -72
  112. data/lib/orb/models/subscription_fetch_costs_params.rb +6 -6
  113. data/lib/orb/models/subscription_fetch_schedule_params.rb +5 -5
  114. data/lib/orb/models/subscription_fetch_schedule_response.rb +2 -2
  115. data/lib/orb/models/subscription_fetch_usage_params.rb +8 -8
  116. data/lib/orb/models/subscription_list_params.rb +5 -5
  117. data/lib/orb/models/subscription_price_intervals_params.rb +323 -323
  118. data/lib/orb/models/subscription_price_intervals_response.rb +152 -72
  119. data/lib/orb/models/subscription_schedule_plan_change_params.rb +651 -651
  120. data/lib/orb/models/subscription_schedule_plan_change_response.rb +152 -72
  121. data/lib/orb/models/subscription_trigger_phase_params.rb +3 -3
  122. data/lib/orb/models/subscription_trigger_phase_response.rb +152 -72
  123. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +152 -72
  124. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +153 -73
  125. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +152 -72
  126. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +8 -8
  127. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +152 -72
  128. data/lib/orb/models/subscription_update_params.rb +10 -10
  129. data/lib/orb/models/subscription_update_trial_params.rb +3 -3
  130. data/lib/orb/models/subscription_update_trial_response.rb +152 -72
  131. data/lib/orb/models/trial_discount.rb +1 -1
  132. data/lib/orb/models/usage_discount.rb +2 -2
  133. data/lib/orb/request_options.rb +7 -7
  134. data/lib/orb/resources/alerts.rb +38 -38
  135. data/lib/orb/resources/coupons/subscriptions.rb +3 -3
  136. data/lib/orb/resources/coupons.rb +9 -9
  137. data/lib/orb/resources/credit_notes.rb +8 -8
  138. data/lib/orb/resources/customers/balance_transactions.rb +26 -26
  139. data/lib/orb/resources/customers/costs.rb +232 -232
  140. data/lib/orb/resources/customers/credits/ledger.rb +344 -344
  141. data/lib/orb/resources/customers/credits/top_ups.rb +12 -12
  142. data/lib/orb/resources/customers/credits.rb +8 -8
  143. data/lib/orb/resources/customers.rb +59 -59
  144. data/lib/orb/resources/dimensional_price_groups.rb +6 -6
  145. data/lib/orb/resources/events/backfills.rb +49 -49
  146. data/lib/orb/resources/events/volume.rb +10 -10
  147. data/lib/orb/resources/events.rb +295 -295
  148. data/lib/orb/resources/invoice_line_items.rb +1 -1
  149. data/lib/orb/resources/invoices.rb +38 -38
  150. data/lib/orb/resources/items.rb +1 -1
  151. data/lib/orb/resources/metrics.rb +11 -11
  152. data/lib/orb/resources/plans/external_plan_id.rb +14 -14
  153. data/lib/orb/resources/plans.rb +22 -22
  154. data/lib/orb/resources/prices/external_price_id.rb +4 -4
  155. data/lib/orb/resources/prices.rb +30 -30
  156. data/lib/orb/resources/subscription_changes.rb +87 -0
  157. data/lib/orb/resources/subscriptions.rb +813 -813
  158. data/lib/orb/resources/top_level.rb +4 -4
  159. data/lib/orb/version.rb +1 -1
  160. data/lib/orb.rb +8 -0
  161. data/rbi/lib/orb/client.rbi +5 -4
  162. data/rbi/lib/orb/errors.rbi +3 -6
  163. data/rbi/lib/orb/internal/page.rbi +3 -6
  164. data/rbi/lib/orb/internal/transport/base_client.rbi +13 -27
  165. data/rbi/lib/orb/internal/transport/pooled_net_requester.rbi +8 -14
  166. data/rbi/lib/orb/internal/type/array_of.rbi +14 -18
  167. data/rbi/lib/orb/internal/type/base_model.rbi +51 -66
  168. data/rbi/lib/orb/internal/type/base_page.rbi +5 -10
  169. data/rbi/lib/orb/internal/type/boolean.rbi +12 -10
  170. data/rbi/lib/orb/internal/type/converter.rbi +44 -37
  171. data/rbi/lib/orb/internal/type/enum.rbi +24 -21
  172. data/rbi/lib/orb/internal/type/hash_of.rbi +13 -18
  173. data/rbi/lib/orb/internal/type/io_like.rbi +49 -0
  174. data/rbi/lib/orb/internal/type/request_parameters.rbi +1 -2
  175. data/rbi/lib/orb/internal/type/union.rbi +19 -21
  176. data/rbi/lib/orb/internal/type/unknown.rbi +10 -9
  177. data/rbi/lib/orb/internal/util.rbi +67 -70
  178. data/rbi/lib/orb/internal.rbi +1 -1
  179. data/rbi/lib/orb/models/alert.rbi +21 -33
  180. data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +8 -13
  181. data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +8 -13
  182. data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +8 -13
  183. data/rbi/lib/orb/models/alert_disable_params.rbi +2 -4
  184. data/rbi/lib/orb/models/alert_enable_params.rbi +2 -4
  185. data/rbi/lib/orb/models/alert_list_params.rbi +3 -6
  186. data/rbi/lib/orb/models/alert_retrieve_params.rbi +2 -4
  187. data/rbi/lib/orb/models/alert_update_params.rbi +7 -11
  188. data/rbi/lib/orb/models/amount_discount.rbi +4 -7
  189. data/rbi/lib/orb/models/billable_metric.rbi +10 -13
  190. data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -2
  191. data/rbi/lib/orb/models/coupon.rbi +9 -11
  192. data/rbi/lib/orb/models/coupon_archive_params.rbi +2 -4
  193. data/rbi/lib/orb/models/coupon_create_params.rbi +8 -14
  194. data/rbi/lib/orb/models/coupon_fetch_params.rbi +2 -4
  195. data/rbi/lib/orb/models/coupon_list_params.rbi +3 -4
  196. data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +3 -5
  197. data/rbi/lib/orb/models/credit_note.rbi +22 -45
  198. data/rbi/lib/orb/models/credit_note_create_params.rbi +5 -10
  199. data/rbi/lib/orb/models/credit_note_fetch_params.rbi +2 -4
  200. data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -6
  201. data/rbi/lib/orb/models/customer.rbi +256 -281
  202. data/rbi/lib/orb/models/customer_create_params.rbi +251 -276
  203. data/rbi/lib/orb/models/customer_delete_params.rbi +2 -4
  204. data/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi +2 -4
  205. data/rbi/lib/orb/models/customer_fetch_params.rbi +2 -4
  206. data/rbi/lib/orb/models/customer_list_params.rbi +3 -6
  207. data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +2 -4
  208. data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +2 -4
  209. data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +252 -277
  210. data/rbi/lib/orb/models/customer_update_params.rbi +252 -277
  211. data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +3 -6
  212. data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +10 -19
  213. data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -6
  214. data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +10 -19
  215. data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +8 -10
  216. data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +6 -12
  217. data/rbi/lib/orb/models/customers/cost_list_params.rbi +8 -10
  218. data/rbi/lib/orb/models/customers/cost_list_response.rbi +6 -12
  219. data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +3 -4
  220. data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +2 -4
  221. data/rbi/lib/orb/models/customers/credit_list_params.rbi +3 -4
  222. data/rbi/lib/orb/models/customers/credit_list_response.rbi +2 -4
  223. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +26 -33
  224. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +79 -136
  225. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +26 -33
  226. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +78 -135
  227. data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +5 -10
  228. data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +79 -136
  229. data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +5 -10
  230. data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +74 -131
  231. data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +13 -19
  232. data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +12 -18
  233. data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +13 -19
  234. data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +12 -18
  235. data/rbi/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +2 -4
  236. data/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi +2 -4
  237. data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +3 -5
  238. data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +12 -18
  239. data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +3 -5
  240. data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +12 -18
  241. data/rbi/lib/orb/models/dimensional_price_group.rbi +8 -9
  242. data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -7
  243. data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +3 -5
  244. data/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi +2 -4
  245. data/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +2 -4
  246. data/rbi/lib/orb/models/dimensional_price_groups.rbi +2 -4
  247. data/rbi/lib/orb/models/discount.rbi +1 -2
  248. data/rbi/lib/orb/models/evaluate_price_group.rbi +3 -6
  249. data/rbi/lib/orb/models/event_deprecate_params.rbi +2 -4
  250. data/rbi/lib/orb/models/event_deprecate_response.rbi +2 -4
  251. data/rbi/lib/orb/models/event_ingest_params.rbi +10 -13
  252. data/rbi/lib/orb/models/event_ingest_response.rbi +10 -16
  253. data/rbi/lib/orb/models/event_search_params.rbi +7 -9
  254. data/rbi/lib/orb/models/event_search_response.rbi +11 -14
  255. data/rbi/lib/orb/models/event_update_params.rbi +5 -6
  256. data/rbi/lib/orb/models/event_update_response.rbi +2 -4
  257. data/rbi/lib/orb/models/events/backfill_close_params.rbi +2 -4
  258. data/rbi/lib/orb/models/events/backfill_close_response.rbi +10 -14
  259. data/rbi/lib/orb/models/events/backfill_create_params.rbi +13 -16
  260. data/rbi/lib/orb/models/events/backfill_create_response.rbi +10 -14
  261. data/rbi/lib/orb/models/events/backfill_fetch_params.rbi +2 -4
  262. data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +10 -14
  263. data/rbi/lib/orb/models/events/backfill_list_params.rbi +3 -5
  264. data/rbi/lib/orb/models/events/backfill_list_response.rbi +10 -14
  265. data/rbi/lib/orb/models/events/backfill_revert_params.rbi +2 -4
  266. data/rbi/lib/orb/models/events/backfill_revert_response.rbi +10 -14
  267. data/rbi/lib/orb/models/events/event_volumes.rbi +5 -9
  268. data/rbi/lib/orb/models/events/volume_list_params.rbi +9 -11
  269. data/rbi/lib/orb/models/invoice.rbi +388 -465
  270. data/rbi/lib/orb/models/invoice_create_params.rbi +19 -26
  271. data/rbi/lib/orb/models/invoice_fetch_params.rbi +2 -4
  272. data/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi +2 -4
  273. data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +381 -460
  274. data/rbi/lib/orb/models/invoice_issue_params.rbi +6 -8
  275. data/rbi/lib/orb/models/invoice_level_discount.rbi +1 -2
  276. data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +3 -5
  277. data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +101 -143
  278. data/rbi/lib/orb/models/invoice_list_params.rbi +8 -13
  279. data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +2 -4
  280. data/rbi/lib/orb/models/invoice_pay_params.rbi +2 -4
  281. data/rbi/lib/orb/models/invoice_update_params.rbi +4 -6
  282. data/rbi/lib/orb/models/invoice_void_params.rbi +2 -4
  283. data/rbi/lib/orb/models/item.rbi +7 -12
  284. data/rbi/lib/orb/models/item_create_params.rbi +2 -4
  285. data/rbi/lib/orb/models/item_fetch_params.rbi +2 -4
  286. data/rbi/lib/orb/models/item_list_params.rbi +3 -5
  287. data/rbi/lib/orb/models/item_update_params.rbi +5 -10
  288. data/rbi/lib/orb/models/metric_create_params.rbi +4 -6
  289. data/rbi/lib/orb/models/metric_fetch_params.rbi +2 -4
  290. data/rbi/lib/orb/models/metric_list_params.rbi +3 -6
  291. data/rbi/lib/orb/models/metric_update_params.rbi +4 -6
  292. data/rbi/lib/orb/models/pagination_metadata.rbi +2 -4
  293. data/rbi/lib/orb/models/percentage_discount.rbi +5 -8
  294. data/rbi/lib/orb/models/plan.rbi +180 -219
  295. data/rbi/lib/orb/models/plan_create_params.rbi +670 -951
  296. data/rbi/lib/orb/models/plan_fetch_params.rbi +2 -4
  297. data/rbi/lib/orb/models/plan_list_params.rbi +4 -8
  298. data/rbi/lib/orb/models/plan_update_params.rbi +6 -8
  299. data/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi +2 -4
  300. data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +6 -8
  301. data/rbi/lib/orb/models/price.rbi +827 -1494
  302. data/rbi/lib/orb/models/price_create_params.rbi +60 -101
  303. data/rbi/lib/orb/models/price_evaluate_params.rbi +6 -9
  304. data/rbi/lib/orb/models/price_evaluate_response.rbi +2 -4
  305. data/rbi/lib/orb/models/price_fetch_params.rbi +2 -4
  306. data/rbi/lib/orb/models/price_list_params.rbi +3 -5
  307. data/rbi/lib/orb/models/price_update_params.rbi +4 -6
  308. data/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi +2 -4
  309. data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +4 -6
  310. data/rbi/lib/orb/models/subscription.rbi +167 -187
  311. data/rbi/lib/orb/models/subscription_cancel_params.rbi +5 -7
  312. data/rbi/lib/orb/models/subscription_cancel_response.rbi +224 -178
  313. data/rbi/lib/orb/models/subscription_change_apply_params.rbi +40 -0
  314. data/rbi/lib/orb/models/subscription_change_apply_response.rbi +1554 -0
  315. data/rbi/lib/orb/models/subscription_change_cancel_params.rbi +18 -0
  316. data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +1565 -0
  317. data/rbi/lib/orb/models/subscription_change_retrieve_params.rbi +18 -0
  318. data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +1581 -0
  319. data/rbi/lib/orb/models/subscription_create_params.rbi +1372 -1968
  320. data/rbi/lib/orb/models/subscription_create_response.rbi +224 -178
  321. data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +8 -10
  322. data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +6 -12
  323. data/rbi/lib/orb/models/subscription_fetch_params.rbi +2 -4
  324. data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -6
  325. data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +6 -10
  326. data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +12 -17
  327. data/rbi/lib/orb/models/subscription_list_params.rbi +4 -8
  328. data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +772 -1124
  329. data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +228 -178
  330. data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +1396 -1993
  331. data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +238 -182
  332. data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +5 -7
  333. data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +224 -178
  334. data/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi +2 -4
  335. data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +238 -182
  336. data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +2 -4
  337. data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +265 -199
  338. data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +2 -4
  339. data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +264 -198
  340. data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -15
  341. data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +238 -182
  342. data/rbi/lib/orb/models/subscription_update_params.rbi +12 -15
  343. data/rbi/lib/orb/models/subscription_update_trial_params.rbi +6 -9
  344. data/rbi/lib/orb/models/subscription_update_trial_response.rbi +224 -178
  345. data/rbi/lib/orb/models/subscription_usage.rbi +24 -43
  346. data/rbi/lib/orb/models/subscriptions.rbi +2 -4
  347. data/rbi/lib/orb/models/top_level_ping_params.rbi +2 -4
  348. data/rbi/lib/orb/models/top_level_ping_response.rbi +2 -4
  349. data/rbi/lib/orb/models/trial_discount.rbi +4 -8
  350. data/rbi/lib/orb/models/usage_discount.rbi +5 -8
  351. data/rbi/lib/orb/request_options.rbi +9 -11
  352. data/rbi/lib/orb/resources/alerts.rbi +44 -60
  353. data/rbi/lib/orb/resources/coupons/subscriptions.rbi +6 -9
  354. data/rbi/lib/orb/resources/coupons.rbi +18 -25
  355. data/rbi/lib/orb/resources/credit_notes.rbi +9 -15
  356. data/rbi/lib/orb/resources/customers/balance_transactions.rbi +26 -31
  357. data/rbi/lib/orb/resources/customers/costs.rbi +241 -246
  358. data/rbi/lib/orb/resources/customers/credits/ledger.rbi +387 -396
  359. data/rbi/lib/orb/resources/customers/credits/top_ups.rbi +29 -40
  360. data/rbi/lib/orb/resources/customers/credits.rbi +15 -20
  361. data/rbi/lib/orb/resources/customers.rbi +407 -417
  362. data/rbi/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +2 -4
  363. data/rbi/lib/orb/resources/dimensional_price_groups.rbi +13 -19
  364. data/rbi/lib/orb/resources/events/backfills.rbi +61 -69
  365. data/rbi/lib/orb/resources/events/volume.rbi +19 -22
  366. data/rbi/lib/orb/resources/events.rbi +311 -319
  367. data/rbi/lib/orb/resources/invoice_line_items.rbi +4 -7
  368. data/rbi/lib/orb/resources/invoices.rbi +62 -76
  369. data/rbi/lib/orb/resources/items.rbi +7 -14
  370. data/rbi/lib/orb/resources/metrics.rbi +17 -25
  371. data/rbi/lib/orb/resources/plans/external_plan_id.rbi +21 -25
  372. data/rbi/lib/orb/resources/plans.rbi +63 -71
  373. data/rbi/lib/orb/resources/prices/external_price_id.rbi +9 -13
  374. data/rbi/lib/orb/resources/prices.rbi +77 -87
  375. data/rbi/lib/orb/resources/subscription_changes.rbi +61 -0
  376. data/rbi/lib/orb/resources/subscriptions.rbi +933 -963
  377. data/rbi/lib/orb/resources/top_level.rbi +6 -8
  378. data/sig/orb/client.rbs +2 -0
  379. data/sig/orb/internal/transport/pooled_net_requester.rbs +1 -1
  380. data/sig/orb/internal/type/array_of.rbs +5 -2
  381. data/sig/orb/internal/type/base_model.rbs +5 -2
  382. data/sig/orb/internal/type/boolean.rbs +5 -2
  383. data/sig/orb/internal/type/converter.rbs +11 -5
  384. data/sig/orb/internal/type/enum.rbs +5 -2
  385. data/sig/orb/internal/type/hash_of.rbs +5 -2
  386. data/sig/orb/internal/type/io_like.rbs +23 -0
  387. data/sig/orb/internal/type/union.rbs +5 -2
  388. data/sig/orb/internal/type/unknown.rbs +5 -2
  389. data/sig/orb/internal/util.rbs +17 -2
  390. data/sig/orb/models/subscription.rbs +14 -0
  391. data/sig/orb/models/subscription_cancel_response.rbs +47 -2
  392. data/sig/orb/models/subscription_change_apply_params.rbs +24 -0
  393. data/sig/orb/models/subscription_change_apply_response.rbs +784 -0
  394. data/sig/orb/models/subscription_change_cancel_params.rbs +15 -0
  395. data/sig/orb/models/subscription_change_cancel_response.rbs +784 -0
  396. data/sig/orb/models/subscription_change_retrieve_params.rbs +15 -0
  397. data/sig/orb/models/subscription_change_retrieve_response.rbs +784 -0
  398. data/sig/orb/models/subscription_create_response.rbs +47 -2
  399. data/sig/orb/models/subscription_price_intervals_response.rbs +47 -2
  400. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +47 -2
  401. data/sig/orb/models/subscription_trigger_phase_response.rbs +47 -2
  402. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +47 -2
  403. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +47 -2
  404. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +47 -2
  405. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +47 -2
  406. data/sig/orb/models/subscription_update_trial_response.rbs +47 -2
  407. data/sig/orb/resources/customers.rbs +2 -2
  408. data/sig/orb/resources/subscription_changes.rbs +24 -0
  409. metadata +28 -4
@@ -43,7 +43,7 @@ module Orb
43
43
 
44
44
  # @!attribute ending_balance
45
45
  # The new value of the customer's balance prior to the transaction, in the
46
- # customer's currency.
46
+ # customer's currency.
47
47
  #
48
48
  # @return [String]
49
49
  required :ending_balance, String
@@ -55,7 +55,7 @@ module Orb
55
55
 
56
56
  # @!attribute starting_balance
57
57
  # The original value of the customer's balance prior to the transaction, in the
58
- # customer's currency.
58
+ # customer's currency.
59
59
  #
60
60
  # @return [String]
61
61
  required :starting_balance, String
@@ -11,7 +11,7 @@ module Orb
11
11
 
12
12
  # @!attribute cursor
13
13
  # Cursor for pagination. This can be populated by the `next_cursor` value returned
14
- # from the initial request.
14
+ # from the initial request.
15
15
  #
16
16
  # @return [String, nil]
17
17
  optional :cursor, String, nil?: true
@@ -29,22 +29,22 @@ module Orb
29
29
  # @!attribute operation_time_gt
30
30
  #
31
31
  # @return [Time, nil]
32
- optional :operation_time_gt, Time, api_name: :"operation_time[gt]", nil?: true
32
+ optional :operation_time_gt, Time, nil?: true
33
33
 
34
34
  # @!attribute operation_time_gte
35
35
  #
36
36
  # @return [Time, nil]
37
- optional :operation_time_gte, Time, api_name: :"operation_time[gte]", nil?: true
37
+ optional :operation_time_gte, Time, nil?: true
38
38
 
39
39
  # @!attribute operation_time_lt
40
40
  #
41
41
  # @return [Time, nil]
42
- optional :operation_time_lt, Time, api_name: :"operation_time[lt]", nil?: true
42
+ optional :operation_time_lt, Time, nil?: true
43
43
 
44
44
  # @!attribute operation_time_lte
45
45
  #
46
46
  # @return [Time, nil]
47
- optional :operation_time_lte, Time, api_name: :"operation_time[lte]", nil?: true
47
+ optional :operation_time_lte, Time, nil?: true
48
48
 
49
49
  # @!parse
50
50
  # # @param cursor [String, nil]
@@ -43,7 +43,7 @@ module Orb
43
43
 
44
44
  # @!attribute ending_balance
45
45
  # The new value of the customer's balance prior to the transaction, in the
46
- # customer's currency.
46
+ # customer's currency.
47
47
  #
48
48
  # @return [String]
49
49
  required :ending_balance, String
@@ -55,7 +55,7 @@ module Orb
55
55
 
56
56
  # @!attribute starting_balance
57
57
  # The original value of the customer's balance prior to the transaction, in the
58
- # customer's currency.
58
+ # customer's currency.
59
59
  #
60
60
  # @return [String]
61
61
  required :starting_balance, String
@@ -29,9 +29,9 @@ module Orb
29
29
 
30
30
  # @!attribute view_mode
31
31
  # Controls whether Orb returns cumulative costs since the start of the billing
32
- # period, or incremental day-by-day costs. If your customer has minimums or
33
- # discounts, it's strongly recommended that you use the default cumulative
34
- # behavior.
32
+ # period, or incremental day-by-day costs. If your customer has minimums or
33
+ # discounts, it's strongly recommended that you use the default cumulative
34
+ # behavior.
35
35
  #
36
36
  # @return [Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode, nil]
37
37
  optional :view_mode, enum: -> { Orb::Models::Customers::CostListByExternalIDParams::ViewMode }, nil?: true
@@ -48,9 +48,9 @@ module Orb
48
48
  # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
49
49
 
50
50
  # Controls whether Orb returns cumulative costs since the start of the billing
51
- # period, or incremental day-by-day costs. If your customer has minimums or
52
- # discounts, it's strongly recommended that you use the default cumulative
53
- # behavior.
51
+ # period, or incremental day-by-day costs. If your customer has minimums or
52
+ # discounts, it's strongly recommended that you use the default cumulative
53
+ # behavior.
54
54
  module ViewMode
55
55
  extend Orb::Internal::Type::Enum
56
56
 
@@ -29,9 +29,9 @@ module Orb
29
29
 
30
30
  # @!attribute view_mode
31
31
  # Controls whether Orb returns cumulative costs since the start of the billing
32
- # period, or incremental day-by-day costs. If your customer has minimums or
33
- # discounts, it's strongly recommended that you use the default cumulative
34
- # behavior.
32
+ # period, or incremental day-by-day costs. If your customer has minimums or
33
+ # discounts, it's strongly recommended that you use the default cumulative
34
+ # behavior.
35
35
  #
36
36
  # @return [Symbol, Orb::Models::Customers::CostListParams::ViewMode, nil]
37
37
  optional :view_mode, enum: -> { Orb::Models::Customers::CostListParams::ViewMode }, nil?: true
@@ -48,9 +48,9 @@ module Orb
48
48
  # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
49
49
 
50
50
  # Controls whether Orb returns cumulative costs since the start of the billing
51
- # period, or incremental day-by-day costs. If your customer has minimums or
52
- # discounts, it's strongly recommended that you use the default cumulative
53
- # behavior.
51
+ # period, or incremental day-by-day costs. If your customer has minimums or
52
+ # discounts, it's strongly recommended that you use the default cumulative
53
+ # behavior.
54
54
  module ViewMode
55
55
  extend Orb::Internal::Type::Enum
56
56
 
@@ -17,14 +17,14 @@ module Orb
17
17
 
18
18
  # @!attribute cursor
19
19
  # Cursor for pagination. This can be populated by the `next_cursor` value returned
20
- # from the initial request.
20
+ # from the initial request.
21
21
  #
22
22
  # @return [String, nil]
23
23
  optional :cursor, String, nil?: true
24
24
 
25
25
  # @!attribute [r] include_all_blocks
26
26
  # If set to True, all expired and depleted blocks, as well as active block will be
27
- # returned.
27
+ # returned.
28
28
  #
29
29
  # @return [Boolean, nil]
30
30
  optional :include_all_blocks, Orb::Internal::Type::Boolean
@@ -17,14 +17,14 @@ module Orb
17
17
 
18
18
  # @!attribute cursor
19
19
  # Cursor for pagination. This can be populated by the `next_cursor` value returned
20
- # from the initial request.
20
+ # from the initial request.
21
21
  #
22
22
  # @return [String, nil]
23
23
  optional :cursor, String, nil?: true
24
24
 
25
25
  # @!attribute [r] include_all_blocks
26
26
  # If set to True, all expired and depleted blocks, as well as active block will be
27
- # returned.
27
+ # returned.
28
28
  #
29
29
  # @return [Boolean, nil]
30
30
  optional :include_all_blocks, Orb::Internal::Type::Boolean
@@ -12,7 +12,7 @@ module Orb
12
12
 
13
13
  # @!attribute amount
14
14
  # The number of credits to effect. Note that this is required for increment,
15
- # decrement or void operations.
15
+ # decrement or void operations.
16
16
  #
17
17
  # @return [Float]
18
18
  required :amount, Float
@@ -25,22 +25,22 @@ module Orb
25
25
 
26
26
  # @!attribute currency
27
27
  # The currency or custom pricing unit to use for this ledger entry. If this is a
28
- # real-world currency, it must match the customer's invoicing currency.
28
+ # real-world currency, it must match the customer's invoicing currency.
29
29
  #
30
30
  # @return [String, nil]
31
31
  optional :currency, String, nil?: true
32
32
 
33
33
  # @!attribute description
34
34
  # Optional metadata that can be specified when adding ledger results via the API.
35
- # For example, this can be used to note an increment refers to trial credits, or
36
- # for noting corrections as a result of an incident, etc.
35
+ # For example, this can be used to note an increment refers to trial credits, or
36
+ # for noting corrections as a result of an incident, etc.
37
37
  #
38
38
  # @return [String, nil]
39
39
  optional :description, String, nil?: true
40
40
 
41
41
  # @!attribute effective_date
42
42
  # An ISO 8601 format date that denotes when this credit balance should become
43
- # available for use.
43
+ # available for use.
44
44
  #
45
45
  # @return [Time, nil]
46
46
  optional :effective_date, Time, nil?: true
@@ -53,9 +53,9 @@ module Orb
53
53
 
54
54
  # @!attribute invoice_settings
55
55
  # Passing `invoice_settings` automatically generates an invoice for the newly
56
- # added credits. If `invoice_settings` is passed, you must specify
57
- # per_unit_cost_basis, as the calculation of the invoice total is done on that
58
- # basis.
56
+ # added credits. If `invoice_settings` is passed, you must specify
57
+ # per_unit_cost_basis, as the calculation of the invoice total is done on that
58
+ # basis.
59
59
  #
60
60
  # @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings, nil]
61
61
  optional :invoice_settings,
@@ -64,23 +64,23 @@ module Orb
64
64
 
65
65
  # @!attribute metadata
66
66
  # User-specified key/value pairs for the resource. Individual keys can be removed
67
- # by setting the value to `null`, and the entire metadata mapping can be cleared
68
- # by setting `metadata` to `null`.
67
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
68
+ # by setting `metadata` to `null`.
69
69
  #
70
70
  # @return [Hash{Symbol=>String, nil}, nil]
71
71
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
72
72
 
73
73
  # @!attribute per_unit_cost_basis
74
74
  # Can only be specified when entry_type=increment. How much, in the customer's
75
- # currency, a customer paid for a single credit in this block
75
+ # currency, a customer paid for a single credit in this block
76
76
  #
77
77
  # @return [String, nil]
78
78
  optional :per_unit_cost_basis, String, nil?: true
79
79
 
80
80
  # @!attribute target_expiry_date
81
81
  # A future date (specified in YYYY-MM-DD format) used for expiration change,
82
- # denoting when credits transferred (as part of a partial block expiration) should
83
- # expire.
82
+ # denoting when credits transferred (as part of a partial block expiration) should
83
+ # expire.
84
84
  #
85
85
  # @return [Date]
86
86
  required :target_expiry_date, Date
@@ -150,15 +150,15 @@ module Orb
150
150
  class InvoiceSettings < Orb::Internal::Type::BaseModel
151
151
  # @!attribute auto_collection
152
152
  # Whether the credits purchase invoice should auto collect with the customer's
153
- # saved payment method.
153
+ # saved payment method.
154
154
  #
155
155
  # @return [Boolean]
156
156
  required :auto_collection, Orb::Internal::Type::Boolean
157
157
 
158
158
  # @!attribute net_terms
159
159
  # The net terms determines the difference between the invoice date and the issue
160
- # date for the invoice. If you intend the invoice to be due on issue, set this
161
- # to 0.
160
+ # date for the invoice. If you intend the invoice to be due on issue, set this
161
+ # to 0.
162
162
  #
163
163
  # @return [Integer]
164
164
  required :net_terms, Integer
@@ -171,7 +171,7 @@ module Orb
171
171
 
172
172
  # @!attribute [r] require_successful_payment
173
173
  # If true, the new credit block will require that the corresponding invoice is
174
- # paid before it can be drawn down from.
174
+ # paid before it can be drawn down from.
175
175
  #
176
176
  # @return [Boolean, nil]
177
177
  optional :require_successful_payment, Orb::Internal::Type::Boolean
@@ -182,9 +182,9 @@ module Orb
182
182
 
183
183
  # @!parse
184
184
  # # Passing `invoice_settings` automatically generates an invoice for the newly
185
- # # added credits. If `invoice_settings` is passed, you must specify
186
- # # per_unit_cost_basis, as the calculation of the invoice total is done on that
187
- # # basis.
185
+ # # added credits. If `invoice_settings` is passed, you must specify
186
+ # # per_unit_cost_basis, as the calculation of the invoice total is done on that
187
+ # # basis.
188
188
  # #
189
189
  # # @param auto_collection [Boolean]
190
190
  # # @param net_terms [Integer]
@@ -5,7 +5,7 @@ module Orb
5
5
  module Customers
6
6
  module Credits
7
7
  # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
8
- # credits within Orb.
8
+ # credits within Orb.
9
9
  #
10
10
  # @see Orb::Resources::Customers::Credits::Ledger#create_entry_by_external_id
11
11
  module LedgerCreateEntryByExternalIDResponse
@@ -95,9 +95,9 @@ module Orb
95
95
 
96
96
  # @!attribute metadata
97
97
  # User specified key-value pairs for the resource. If not present, this defaults
98
- # to an empty dictionary. Individual keys can be removed by setting the value to
99
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
100
- # `null`.
98
+ # to an empty dictionary. Individual keys can be removed by setting the value to
99
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
100
+ # `null`.
101
101
  #
102
102
  # @return [Hash{Symbol=>String}]
103
103
  required :metadata, Orb::Internal::Type::HashOf[String]
@@ -267,9 +267,9 @@ module Orb
267
267
 
268
268
  # @!attribute metadata
269
269
  # User specified key-value pairs for the resource. If not present, this defaults
270
- # to an empty dictionary. Individual keys can be removed by setting the value to
271
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
272
- # `null`.
270
+ # to an empty dictionary. Individual keys can be removed by setting the value to
271
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
272
+ # `null`.
273
273
  #
274
274
  # @return [Hash{Symbol=>String}]
275
275
  required :metadata, Orb::Internal::Type::HashOf[String]
@@ -460,9 +460,9 @@ module Orb
460
460
 
461
461
  # @!attribute metadata
462
462
  # User specified key-value pairs for the resource. If not present, this defaults
463
- # to an empty dictionary. Individual keys can be removed by setting the value to
464
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
465
- # `null`.
463
+ # to an empty dictionary. Individual keys can be removed by setting the value to
464
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
465
+ # `null`.
466
466
  #
467
467
  # @return [Hash{Symbol=>String}]
468
468
  required :metadata, Orb::Internal::Type::HashOf[String]
@@ -639,9 +639,9 @@ module Orb
639
639
 
640
640
  # @!attribute metadata
641
641
  # User specified key-value pairs for the resource. If not present, this defaults
642
- # to an empty dictionary. Individual keys can be removed by setting the value to
643
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
644
- # `null`.
642
+ # to an empty dictionary. Individual keys can be removed by setting the value to
643
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
644
+ # `null`.
645
645
  #
646
646
  # @return [Hash{Symbol=>String}]
647
647
  required :metadata, Orb::Internal::Type::HashOf[String]
@@ -811,9 +811,9 @@ module Orb
811
811
 
812
812
  # @!attribute metadata
813
813
  # User specified key-value pairs for the resource. If not present, this defaults
814
- # to an empty dictionary. Individual keys can be removed by setting the value to
815
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
816
- # `null`.
814
+ # to an empty dictionary. Individual keys can be removed by setting the value to
815
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
816
+ # `null`.
817
817
  #
818
818
  # @return [Hash{Symbol=>String}]
819
819
  required :metadata, Orb::Internal::Type::HashOf[String]
@@ -997,9 +997,9 @@ module Orb
997
997
 
998
998
  # @!attribute metadata
999
999
  # User specified key-value pairs for the resource. If not present, this defaults
1000
- # to an empty dictionary. Individual keys can be removed by setting the value to
1001
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
1002
- # `null`.
1000
+ # to an empty dictionary. Individual keys can be removed by setting the value to
1001
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
1002
+ # `null`.
1003
1003
  #
1004
1004
  # @return [Hash{Symbol=>String}]
1005
1005
  required :metadata, Orb::Internal::Type::HashOf[String]
@@ -1190,9 +1190,9 @@ module Orb
1190
1190
 
1191
1191
  # @!attribute metadata
1192
1192
  # User specified key-value pairs for the resource. If not present, this defaults
1193
- # to an empty dictionary. Individual keys can be removed by setting the value to
1194
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
1195
- # `null`.
1193
+ # to an empty dictionary. Individual keys can be removed by setting the value to
1194
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
1195
+ # `null`.
1196
1196
  #
1197
1197
  # @return [Hash{Symbol=>String}]
1198
1198
  required :metadata, Orb::Internal::Type::HashOf[String]
@@ -12,7 +12,7 @@ module Orb
12
12
 
13
13
  # @!attribute amount
14
14
  # The number of credits to effect. Note that this is required for increment,
15
- # decrement or void operations.
15
+ # decrement or void operations.
16
16
  #
17
17
  # @return [Float]
18
18
  required :amount, Float
@@ -24,22 +24,22 @@ module Orb
24
24
 
25
25
  # @!attribute currency
26
26
  # The currency or custom pricing unit to use for this ledger entry. If this is a
27
- # real-world currency, it must match the customer's invoicing currency.
27
+ # real-world currency, it must match the customer's invoicing currency.
28
28
  #
29
29
  # @return [String, nil]
30
30
  optional :currency, String, nil?: true
31
31
 
32
32
  # @!attribute description
33
33
  # Optional metadata that can be specified when adding ledger results via the API.
34
- # For example, this can be used to note an increment refers to trial credits, or
35
- # for noting corrections as a result of an incident, etc.
34
+ # For example, this can be used to note an increment refers to trial credits, or
35
+ # for noting corrections as a result of an incident, etc.
36
36
  #
37
37
  # @return [String, nil]
38
38
  optional :description, String, nil?: true
39
39
 
40
40
  # @!attribute effective_date
41
41
  # An ISO 8601 format date that denotes when this credit balance should become
42
- # available for use.
42
+ # available for use.
43
43
  #
44
44
  # @return [Time, nil]
45
45
  optional :effective_date, Time, nil?: true
@@ -52,9 +52,9 @@ module Orb
52
52
 
53
53
  # @!attribute invoice_settings
54
54
  # Passing `invoice_settings` automatically generates an invoice for the newly
55
- # added credits. If `invoice_settings` is passed, you must specify
56
- # per_unit_cost_basis, as the calculation of the invoice total is done on that
57
- # basis.
55
+ # added credits. If `invoice_settings` is passed, you must specify
56
+ # per_unit_cost_basis, as the calculation of the invoice total is done on that
57
+ # basis.
58
58
  #
59
59
  # @return [Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings, nil]
60
60
  optional :invoice_settings,
@@ -63,23 +63,23 @@ module Orb
63
63
 
64
64
  # @!attribute metadata
65
65
  # User-specified key/value pairs for the resource. Individual keys can be removed
66
- # by setting the value to `null`, and the entire metadata mapping can be cleared
67
- # by setting `metadata` to `null`.
66
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
67
+ # by setting `metadata` to `null`.
68
68
  #
69
69
  # @return [Hash{Symbol=>String, nil}, nil]
70
70
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
71
71
 
72
72
  # @!attribute per_unit_cost_basis
73
73
  # Can only be specified when entry_type=increment. How much, in the customer's
74
- # currency, a customer paid for a single credit in this block
74
+ # currency, a customer paid for a single credit in this block
75
75
  #
76
76
  # @return [String, nil]
77
77
  optional :per_unit_cost_basis, String, nil?: true
78
78
 
79
79
  # @!attribute target_expiry_date
80
80
  # A future date (specified in YYYY-MM-DD format) used for expiration change,
81
- # denoting when credits transferred (as part of a partial block expiration) should
82
- # expire.
81
+ # denoting when credits transferred (as part of a partial block expiration) should
82
+ # expire.
83
83
  #
84
84
  # @return [Date]
85
85
  required :target_expiry_date, Date
@@ -149,15 +149,15 @@ module Orb
149
149
  class InvoiceSettings < Orb::Internal::Type::BaseModel
150
150
  # @!attribute auto_collection
151
151
  # Whether the credits purchase invoice should auto collect with the customer's
152
- # saved payment method.
152
+ # saved payment method.
153
153
  #
154
154
  # @return [Boolean]
155
155
  required :auto_collection, Orb::Internal::Type::Boolean
156
156
 
157
157
  # @!attribute net_terms
158
158
  # The net terms determines the difference between the invoice date and the issue
159
- # date for the invoice. If you intend the invoice to be due on issue, set this
160
- # to 0.
159
+ # date for the invoice. If you intend the invoice to be due on issue, set this
160
+ # to 0.
161
161
  #
162
162
  # @return [Integer]
163
163
  required :net_terms, Integer
@@ -170,7 +170,7 @@ module Orb
170
170
 
171
171
  # @!attribute [r] require_successful_payment
172
172
  # If true, the new credit block will require that the corresponding invoice is
173
- # paid before it can be drawn down from.
173
+ # paid before it can be drawn down from.
174
174
  #
175
175
  # @return [Boolean, nil]
176
176
  optional :require_successful_payment, Orb::Internal::Type::Boolean
@@ -181,9 +181,9 @@ module Orb
181
181
 
182
182
  # @!parse
183
183
  # # Passing `invoice_settings` automatically generates an invoice for the newly
184
- # # added credits. If `invoice_settings` is passed, you must specify
185
- # # per_unit_cost_basis, as the calculation of the invoice total is done on that
186
- # # basis.
184
+ # # added credits. If `invoice_settings` is passed, you must specify
185
+ # # per_unit_cost_basis, as the calculation of the invoice total is done on that
186
+ # # basis.
187
187
  # #
188
188
  # # @param auto_collection [Boolean]
189
189
  # # @param net_terms [Integer]
@@ -5,7 +5,7 @@ module Orb
5
5
  module Customers
6
6
  module Credits
7
7
  # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
8
- # credits within Orb.
8
+ # credits within Orb.
9
9
  #
10
10
  # @see Orb::Resources::Customers::Credits::Ledger#create_entry
11
11
  module LedgerCreateEntryResponse
@@ -94,9 +94,9 @@ module Orb
94
94
 
95
95
  # @!attribute metadata
96
96
  # User specified key-value pairs for the resource. If not present, this defaults
97
- # to an empty dictionary. Individual keys can be removed by setting the value to
98
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
99
- # `null`.
97
+ # to an empty dictionary. Individual keys can be removed by setting the value to
98
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
99
+ # `null`.
100
100
  #
101
101
  # @return [Hash{Symbol=>String}]
102
102
  required :metadata, Orb::Internal::Type::HashOf[String]
@@ -266,9 +266,9 @@ module Orb
266
266
 
267
267
  # @!attribute metadata
268
268
  # User specified key-value pairs for the resource. If not present, this defaults
269
- # to an empty dictionary. Individual keys can be removed by setting the value to
270
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
271
- # `null`.
269
+ # to an empty dictionary. Individual keys can be removed by setting the value to
270
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
271
+ # `null`.
272
272
  #
273
273
  # @return [Hash{Symbol=>String}]
274
274
  required :metadata, Orb::Internal::Type::HashOf[String]
@@ -459,9 +459,9 @@ module Orb
459
459
 
460
460
  # @!attribute metadata
461
461
  # User specified key-value pairs for the resource. If not present, this defaults
462
- # to an empty dictionary. Individual keys can be removed by setting the value to
463
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
464
- # `null`.
462
+ # to an empty dictionary. Individual keys can be removed by setting the value to
463
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
464
+ # `null`.
465
465
  #
466
466
  # @return [Hash{Symbol=>String}]
467
467
  required :metadata, Orb::Internal::Type::HashOf[String]
@@ -638,9 +638,9 @@ module Orb
638
638
 
639
639
  # @!attribute metadata
640
640
  # User specified key-value pairs for the resource. If not present, this defaults
641
- # to an empty dictionary. Individual keys can be removed by setting the value to
642
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
643
- # `null`.
641
+ # to an empty dictionary. Individual keys can be removed by setting the value to
642
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
643
+ # `null`.
644
644
  #
645
645
  # @return [Hash{Symbol=>String}]
646
646
  required :metadata, Orb::Internal::Type::HashOf[String]
@@ -810,9 +810,9 @@ module Orb
810
810
 
811
811
  # @!attribute metadata
812
812
  # User specified key-value pairs for the resource. If not present, this defaults
813
- # to an empty dictionary. Individual keys can be removed by setting the value to
814
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
815
- # `null`.
813
+ # to an empty dictionary. Individual keys can be removed by setting the value to
814
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
815
+ # `null`.
816
816
  #
817
817
  # @return [Hash{Symbol=>String}]
818
818
  required :metadata, Orb::Internal::Type::HashOf[String]
@@ -996,9 +996,9 @@ module Orb
996
996
 
997
997
  # @!attribute metadata
998
998
  # User specified key-value pairs for the resource. If not present, this defaults
999
- # to an empty dictionary. Individual keys can be removed by setting the value to
1000
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
1001
- # `null`.
999
+ # to an empty dictionary. Individual keys can be removed by setting the value to
1000
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
1001
+ # `null`.
1002
1002
  #
1003
1003
  # @return [Hash{Symbol=>String}]
1004
1004
  required :metadata, Orb::Internal::Type::HashOf[String]
@@ -1189,9 +1189,9 @@ module Orb
1189
1189
 
1190
1190
  # @!attribute metadata
1191
1191
  # User specified key-value pairs for the resource. If not present, this defaults
1192
- # to an empty dictionary. Individual keys can be removed by setting the value to
1193
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
1194
- # `null`.
1192
+ # to an empty dictionary. Individual keys can be removed by setting the value to
1193
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
1194
+ # `null`.
1195
1195
  #
1196
1196
  # @return [Hash{Symbol=>String}]
1197
1197
  required :metadata, Orb::Internal::Type::HashOf[String]
@@ -13,22 +13,22 @@ module Orb
13
13
  # @!attribute created_at_gt
14
14
  #
15
15
  # @return [Time, nil]
16
- optional :created_at_gt, Time, api_name: :"created_at[gt]", nil?: true
16
+ optional :created_at_gt, Time, nil?: true
17
17
 
18
18
  # @!attribute created_at_gte
19
19
  #
20
20
  # @return [Time, nil]
21
- optional :created_at_gte, Time, api_name: :"created_at[gte]", nil?: true
21
+ optional :created_at_gte, Time, nil?: true
22
22
 
23
23
  # @!attribute created_at_lt
24
24
  #
25
25
  # @return [Time, nil]
26
- optional :created_at_lt, Time, api_name: :"created_at[lt]", nil?: true
26
+ optional :created_at_lt, Time, nil?: true
27
27
 
28
28
  # @!attribute created_at_lte
29
29
  #
30
30
  # @return [Time, nil]
31
- optional :created_at_lte, Time, api_name: :"created_at[lte]", nil?: true
31
+ optional :created_at_lte, Time, nil?: true
32
32
 
33
33
  # @!attribute currency
34
34
  # The ledger currency or custom pricing unit to use.
@@ -38,7 +38,7 @@ module Orb
38
38
 
39
39
  # @!attribute cursor
40
40
  # Cursor for pagination. This can be populated by the `next_cursor` value returned
41
- # from the initial request.
41
+ # from the initial request.
42
42
  #
43
43
  # @return [String, nil]
44
44
  optional :cursor, String, nil?: true