orb-billing 0.11.0 → 1.0.0

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 (746) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +39 -0
  3. data/README.md +1 -1
  4. data/lib/orb/internal/type/base_model.rb +5 -5
  5. data/lib/orb/internal/type/union.rb +3 -8
  6. data/lib/orb/internal/util.rb +8 -9
  7. data/lib/orb/models/accounting_provider_config.rb +21 -0
  8. data/lib/orb/models/address.rb +45 -0
  9. data/lib/orb/models/address_input.rb +45 -0
  10. data/lib/orb/models/adjustment_interval.rb +66 -0
  11. data/lib/orb/models/aggregated_cost.rb +45 -0
  12. data/lib/orb/models/alert.rb +9 -60
  13. data/lib/orb/models/alert_create_for_customer_params.rb +3 -24
  14. data/lib/orb/models/alert_create_for_external_customer_params.rb +3 -24
  15. data/lib/orb/models/alert_create_for_subscription_params.rb +3 -23
  16. data/lib/orb/models/alert_update_params.rb +3 -22
  17. data/lib/orb/models/allocation.rb +27 -0
  18. data/lib/orb/models/amount_discount.rb +9 -1
  19. data/lib/orb/models/amount_discount_interval.rb +65 -0
  20. data/lib/orb/models/beta/external_plan_id_create_plan_version_params.rb +186 -17772
  21. data/lib/orb/models/beta_create_plan_version_params.rb +183 -17605
  22. data/lib/orb/models/billable_metric_tiny.rb +15 -0
  23. data/lib/orb/models/billing_cycle_anchor_configuration.rb +41 -0
  24. data/lib/orb/models/billing_cycle_configuration.rb +32 -0
  25. data/lib/orb/models/bps_config.rb +24 -0
  26. data/lib/orb/models/bps_tier.rb +40 -0
  27. data/lib/orb/models/bulk_bps_config.rb +20 -0
  28. data/lib/orb/models/bulk_bps_tier.rb +32 -0
  29. data/lib/orb/models/bulk_config.rb +16 -0
  30. data/lib/orb/models/bulk_tier.rb +24 -0
  31. data/lib/orb/models/changed_subscription_resources.rb +40 -0
  32. data/lib/orb/models/conversion_rate_tier.rb +32 -0
  33. data/lib/orb/models/conversion_rate_tiered_config.rb +16 -0
  34. data/lib/orb/models/conversion_rate_unit_config.rb +16 -0
  35. data/lib/orb/models/coupon_redemption.rb +27 -0
  36. data/lib/orb/models/credit_note.rb +6 -51
  37. data/lib/orb/models/credit_note_tiny.rb +16 -0
  38. data/lib/orb/models/custom_expiration.rb +32 -0
  39. data/lib/orb/models/customer.rb +15 -426
  40. data/lib/orb/models/customer_create_params.rb +24 -527
  41. data/lib/orb/models/customer_hierarchy_config.rb +29 -0
  42. data/lib/orb/models/customer_minified.rb +21 -0
  43. data/lib/orb/models/customer_tax_id.rb +300 -0
  44. data/lib/orb/models/customer_update_by_external_id_params.rb +24 -529
  45. data/lib/orb/models/customer_update_params.rb +24 -527
  46. data/lib/orb/models/customers/balance_transaction_create_response.rb +6 -32
  47. data/lib/orb/models/customers/balance_transaction_list_response.rb +6 -32
  48. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -88
  49. data/lib/orb/models/customers/cost_list_response.rb +3 -87
  50. data/lib/orb/models/customers/credits/affected_block.rb +31 -0
  51. data/lib/orb/models/customers/credits/amendment_ledger_entry.rb +131 -0
  52. data/lib/orb/models/customers/credits/credit_block_expiry_ledger_entry.rb +137 -0
  53. data/lib/orb/models/customers/credits/decrement_ledger_entry.rb +152 -0
  54. data/lib/orb/models/customers/credits/expiration_change_ledger_entry.rb +141 -0
  55. data/lib/orb/models/customers/credits/increment_ledger_entry.rb +139 -0
  56. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +8 -1177
  57. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +8 -1169
  58. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +8 -1173
  59. data/lib/orb/models/customers/credits/ledger_list_response.rb +8 -1161
  60. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +3 -52
  61. data/lib/orb/models/customers/credits/top_up_create_response.rb +3 -51
  62. data/lib/orb/models/customers/credits/top_up_invoice_settings.rb +53 -0
  63. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +3 -52
  64. data/lib/orb/models/customers/credits/top_up_list_response.rb +3 -51
  65. data/lib/orb/models/customers/credits/void_initiated_ledger_entry.rb +152 -0
  66. data/lib/orb/models/customers/credits/void_ledger_entry.rb +145 -0
  67. data/lib/orb/models/dimensional_price_configuration.rb +21 -0
  68. data/lib/orb/models/discount_override.rb +56 -0
  69. data/lib/orb/models/fixed_fee_quantity_schedule_entry.rb +33 -0
  70. data/lib/orb/models/fixed_fee_quantity_transition.rb +27 -0
  71. data/lib/orb/models/invoice.rb +56 -1777
  72. data/lib/orb/models/invoice_create_params.rb +3 -15
  73. data/lib/orb/models/invoice_fetch_upcoming_response.rb +56 -1794
  74. data/lib/orb/models/invoice_line_item_create_response.rb +25 -1142
  75. data/lib/orb/models/invoice_tiny.rb +16 -0
  76. data/lib/orb/models/item_slim.rb +21 -0
  77. data/lib/orb/models/matrix_config.rb +32 -0
  78. data/lib/orb/models/matrix_sub_line_item.rb +61 -0
  79. data/lib/orb/models/matrix_value.rb +29 -0
  80. data/lib/orb/models/matrix_with_allocation_config.rb +40 -0
  81. data/lib/orb/models/maximum.rb +38 -0
  82. data/lib/orb/models/maximum_interval.rb +52 -0
  83. data/lib/orb/models/minimum.rb +38 -0
  84. data/lib/orb/models/minimum_interval.rb +52 -0
  85. data/lib/orb/models/monetary_amount_discount_adjustment.rb +87 -0
  86. data/lib/orb/models/monetary_maximum_adjustment.rb +87 -0
  87. data/lib/orb/models/monetary_minimum_adjustment.rb +95 -0
  88. data/lib/orb/models/monetary_percentage_discount_adjustment.rb +87 -0
  89. data/lib/orb/models/monetary_usage_discount_adjustment.rb +87 -0
  90. data/lib/orb/models/mutated_subscription.rb +302 -0
  91. data/lib/orb/models/new_accounting_sync_configuration.rb +23 -0
  92. data/lib/orb/models/new_allocation_price.rb +70 -0
  93. data/lib/orb/models/new_amount_discount.rb +120 -0
  94. data/lib/orb/models/new_avalara_tax_configuration.rb +37 -0
  95. data/lib/orb/models/new_billing_cycle_configuration.rb +37 -0
  96. data/lib/orb/models/new_dimensional_price_configuration.rb +36 -0
  97. data/lib/orb/models/new_floating_bps_price.rb +199 -0
  98. data/lib/orb/models/new_floating_bulk_bps_price.rb +197 -0
  99. data/lib/orb/models/new_floating_bulk_price.rb +197 -0
  100. data/lib/orb/models/new_floating_bulk_with_proration_price.rb +197 -0
  101. data/lib/orb/models/new_floating_cumulative_grouped_bulk_price.rb +197 -0
  102. data/lib/orb/models/new_floating_grouped_allocation_price.rb +197 -0
  103. data/lib/orb/models/new_floating_grouped_tiered_package_price.rb +197 -0
  104. data/lib/orb/models/new_floating_grouped_tiered_price.rb +197 -0
  105. data/lib/orb/models/new_floating_grouped_with_metered_minimum_price.rb +197 -0
  106. data/lib/orb/models/new_floating_grouped_with_prorated_minimum_price.rb +198 -0
  107. data/lib/orb/models/new_floating_matrix_price.rb +197 -0
  108. data/lib/orb/models/new_floating_matrix_with_allocation_price.rb +197 -0
  109. data/lib/orb/models/new_floating_matrix_with_display_name_price.rb +197 -0
  110. data/lib/orb/models/new_floating_max_group_tiered_package_price.rb +197 -0
  111. data/lib/orb/models/new_floating_package_price.rb +197 -0
  112. data/lib/orb/models/new_floating_package_with_allocation_price.rb +197 -0
  113. data/lib/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rb +198 -0
  114. data/lib/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rb +198 -0
  115. data/lib/orb/models/new_floating_threshold_total_amount_price.rb +197 -0
  116. data/lib/orb/models/new_floating_tiered_bps_price.rb +197 -0
  117. data/lib/orb/models/new_floating_tiered_package_price.rb +197 -0
  118. data/lib/orb/models/new_floating_tiered_package_with_minimum_price.rb +197 -0
  119. data/lib/orb/models/new_floating_tiered_price.rb +197 -0
  120. data/lib/orb/models/new_floating_tiered_with_minimum_price.rb +197 -0
  121. data/lib/orb/models/new_floating_tiered_with_proration_price.rb +197 -0
  122. data/lib/orb/models/new_floating_unit_price.rb +197 -0
  123. data/lib/orb/models/new_floating_unit_with_percent_price.rb +197 -0
  124. data/lib/orb/models/new_floating_unit_with_proration_price.rb +197 -0
  125. data/lib/orb/models/new_maximum.rb +120 -0
  126. data/lib/orb/models/new_minimum.rb +128 -0
  127. data/lib/orb/models/new_percentage_discount.rb +120 -0
  128. data/lib/orb/models/new_plan_bps_price.rb +196 -0
  129. data/lib/orb/models/new_plan_bulk_bps_price.rb +200 -0
  130. data/lib/orb/models/new_plan_bulk_price.rb +196 -0
  131. data/lib/orb/models/new_plan_bulk_with_proration_price.rb +198 -0
  132. data/lib/orb/models/new_plan_cumulative_grouped_bulk_price.rb +198 -0
  133. data/lib/orb/models/new_plan_grouped_allocation_price.rb +198 -0
  134. data/lib/orb/models/new_plan_grouped_tiered_package_price.rb +198 -0
  135. data/lib/orb/models/new_plan_grouped_tiered_price.rb +198 -0
  136. data/lib/orb/models/new_plan_grouped_with_metered_minimum_price.rb +198 -0
  137. data/lib/orb/models/new_plan_grouped_with_prorated_minimum_price.rb +199 -0
  138. data/lib/orb/models/new_plan_matrix_price.rb +200 -0
  139. data/lib/orb/models/new_plan_matrix_with_allocation_price.rb +198 -0
  140. data/lib/orb/models/new_plan_matrix_with_display_name_price.rb +198 -0
  141. data/lib/orb/models/new_plan_max_group_tiered_package_price.rb +198 -0
  142. data/lib/orb/models/new_plan_package_price.rb +200 -0
  143. data/lib/orb/models/new_plan_package_with_allocation_price.rb +198 -0
  144. data/lib/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rb +199 -0
  145. data/lib/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rb +199 -0
  146. data/lib/orb/models/new_plan_threshold_total_amount_price.rb +198 -0
  147. data/lib/orb/models/new_plan_tier_with_proration_price.rb +198 -0
  148. data/lib/orb/models/new_plan_tiered_bps_price.rb +198 -0
  149. data/lib/orb/models/new_plan_tiered_package_price.rb +198 -0
  150. data/lib/orb/models/new_plan_tiered_package_with_minimum_price.rb +198 -0
  151. data/lib/orb/models/new_plan_tiered_price.rb +200 -0
  152. data/lib/orb/models/new_plan_tiered_with_minimum_price.rb +198 -0
  153. data/lib/orb/models/new_plan_unit_price.rb +196 -0
  154. data/lib/orb/models/new_plan_unit_with_percent_price.rb +198 -0
  155. data/lib/orb/models/new_plan_unit_with_proration_price.rb +198 -0
  156. data/lib/orb/models/new_reporting_configuration.rb +15 -0
  157. data/lib/orb/models/new_sphere_configuration.rb +31 -0
  158. data/lib/orb/models/new_subscription_bps_price.rb +207 -0
  159. data/lib/orb/models/new_subscription_bulk_bps_price.rb +207 -0
  160. data/lib/orb/models/new_subscription_bulk_price.rb +207 -0
  161. data/lib/orb/models/new_subscription_bulk_with_proration_price.rb +207 -0
  162. data/lib/orb/models/new_subscription_cumulative_grouped_bulk_price.rb +207 -0
  163. data/lib/orb/models/new_subscription_grouped_allocation_price.rb +207 -0
  164. data/lib/orb/models/new_subscription_grouped_tiered_package_price.rb +207 -0
  165. data/lib/orb/models/new_subscription_grouped_tiered_price.rb +207 -0
  166. data/lib/orb/models/new_subscription_grouped_with_metered_minimum_price.rb +207 -0
  167. data/lib/orb/models/new_subscription_grouped_with_prorated_minimum_price.rb +208 -0
  168. data/lib/orb/models/new_subscription_matrix_price.rb +207 -0
  169. data/lib/orb/models/new_subscription_matrix_with_allocation_price.rb +207 -0
  170. data/lib/orb/models/new_subscription_matrix_with_display_name_price.rb +207 -0
  171. data/lib/orb/models/new_subscription_max_group_tiered_package_price.rb +207 -0
  172. data/lib/orb/models/new_subscription_package_price.rb +207 -0
  173. data/lib/orb/models/new_subscription_package_with_allocation_price.rb +207 -0
  174. data/lib/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rb +209 -0
  175. data/lib/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rb +209 -0
  176. data/lib/orb/models/new_subscription_threshold_total_amount_price.rb +207 -0
  177. data/lib/orb/models/new_subscription_tier_with_proration_price.rb +207 -0
  178. data/lib/orb/models/new_subscription_tiered_bps_price.rb +207 -0
  179. data/lib/orb/models/new_subscription_tiered_package_price.rb +207 -0
  180. data/lib/orb/models/new_subscription_tiered_package_with_minimum_price.rb +207 -0
  181. data/lib/orb/models/new_subscription_tiered_price.rb +207 -0
  182. data/lib/orb/models/new_subscription_tiered_with_minimum_price.rb +207 -0
  183. data/lib/orb/models/new_subscription_unit_price.rb +207 -0
  184. data/lib/orb/models/new_subscription_unit_with_percent_price.rb +207 -0
  185. data/lib/orb/models/new_subscription_unit_with_proration_price.rb +207 -0
  186. data/lib/orb/models/new_tax_jar_configuration.rb +31 -0
  187. data/lib/orb/models/new_usage_discount.rb +120 -0
  188. data/lib/orb/models/other_sub_line_item.rb +54 -0
  189. data/lib/orb/models/package_config.rb +28 -0
  190. data/lib/orb/models/per_price_cost.rb +48 -0
  191. data/lib/orb/models/percentage_discount.rb +9 -1
  192. data/lib/orb/models/percentage_discount_interval.rb +69 -0
  193. data/lib/orb/models/plan.rb +22 -1040
  194. data/lib/orb/models/plan_create_params.rb +31 -8145
  195. data/lib/orb/models/plan_phase_amount_discount_adjustment.rb +87 -0
  196. data/lib/orb/models/plan_phase_maximum_adjustment.rb +87 -0
  197. data/lib/orb/models/plan_phase_minimum_adjustment.rb +95 -0
  198. data/lib/orb/models/plan_phase_percentage_discount_adjustment.rb +87 -0
  199. data/lib/orb/models/plan_phase_usage_discount_adjustment.rb +87 -0
  200. data/lib/orb/models/plan_version.rb +10 -672
  201. data/lib/orb/models/price.rb +1225 -10817
  202. data/lib/orb/models/price_create_params.rb +53 -472
  203. data/lib/orb/models/price_evaluate_multiple_params.rb +32 -8479
  204. data/lib/orb/models/price_evaluate_preview_events_params.rb +236 -0
  205. data/lib/orb/models/price_evaluate_preview_events_response.rb +51 -0
  206. data/lib/orb/models/price_interval.rb +113 -0
  207. data/lib/orb/models/sub_line_item_grouping.rb +23 -0
  208. data/lib/orb/models/sub_line_item_matrix_config.rb +16 -0
  209. data/lib/orb/models/subscription.rb +33 -1581
  210. data/lib/orb/models/subscription_change_apply_response.rb +3 -1904
  211. data/lib/orb/models/subscription_change_cancel_response.rb +3 -1905
  212. data/lib/orb/models/subscription_change_minified.rb +15 -0
  213. data/lib/orb/models/subscription_change_retrieve_response.rb +3 -1906
  214. data/lib/orb/models/subscription_create_params.rb +232 -18278
  215. data/lib/orb/models/subscription_fetch_costs_response.rb +3 -87
  216. data/lib/orb/models/subscription_minified.rb +15 -0
  217. data/lib/orb/models/subscription_price_intervals_params.rb +86 -8758
  218. data/lib/orb/models/subscription_redeem_coupon_params.rb +17 -9
  219. data/lib/orb/models/subscription_schedule_plan_change_params.rb +238 -18372
  220. data/lib/orb/models/subscription_trial_info.rb +15 -0
  221. data/lib/orb/models/tax_amount.rb +32 -0
  222. data/lib/orb/models/threshold.rb +24 -0
  223. data/lib/orb/models/tier.rb +32 -0
  224. data/lib/orb/models/tier_config.rb +27 -0
  225. data/lib/orb/models/tier_sub_line_item.rb +61 -0
  226. data/lib/orb/models/tiered_bps_config.rb +20 -0
  227. data/lib/orb/models/tiered_config.rb +16 -0
  228. data/lib/orb/models/tiered_conversion_rate_config.rb +31 -0
  229. data/lib/orb/models/transform_price_filter.rb +61 -0
  230. data/lib/orb/models/trial_discount.rb +9 -1
  231. data/lib/orb/models/unit_config.rb +16 -0
  232. data/lib/orb/models/unit_conversion_rate_config.rb +31 -0
  233. data/lib/orb/models/usage_discount.rb +9 -1
  234. data/lib/orb/models/usage_discount_interval.rb +69 -0
  235. data/lib/orb/models.rb +348 -0
  236. data/lib/orb/resources/alerts.rb +4 -4
  237. data/lib/orb/resources/customers/credits/ledger.rb +4 -4
  238. data/lib/orb/resources/customers.rb +21 -21
  239. data/lib/orb/resources/plans.rb +1 -1
  240. data/lib/orb/resources/prices/external_price_id.rb +2 -2
  241. data/lib/orb/resources/prices.rb +82 -34
  242. data/lib/orb/resources/subscriptions.rb +29 -27
  243. data/lib/orb/version.rb +1 -1
  244. data/lib/orb.rb +181 -11
  245. data/rbi/orb/internal/util.rbi +2 -0
  246. data/rbi/orb/models/accounting_provider_config.rbi +34 -0
  247. data/rbi/orb/models/address.rbi +55 -0
  248. data/rbi/orb/models/address_input.rbi +62 -0
  249. data/rbi/orb/models/adjustment_interval.rbi +93 -0
  250. data/rbi/orb/models/aggregated_cost.rbi +61 -0
  251. data/rbi/orb/models/alert.rbi +11 -84
  252. data/rbi/orb/models/alert_create_for_customer_params.rbi +3 -42
  253. data/rbi/orb/models/alert_create_for_external_customer_params.rbi +3 -48
  254. data/rbi/orb/models/alert_create_for_subscription_params.rbi +3 -38
  255. data/rbi/orb/models/alert_update_params.rbi +3 -31
  256. data/rbi/orb/models/allocation.rbi +45 -0
  257. data/rbi/orb/models/amount_discount.rbi +8 -0
  258. data/rbi/orb/models/amount_discount_interval.rbi +100 -0
  259. data/rbi/orb/models/beta/external_plan_id_create_plan_version_params.rbi +482 -32442
  260. data/rbi/orb/models/beta_create_plan_version_params.rbi +484 -32436
  261. data/rbi/orb/models/billable_metric_tiny.rbi +21 -0
  262. data/rbi/orb/models/billing_cycle_anchor_configuration.rbi +61 -0
  263. data/rbi/orb/models/billing_cycle_configuration.rbi +70 -0
  264. data/rbi/orb/models/bps_config.rbi +36 -0
  265. data/rbi/orb/models/bps_tier.rbi +58 -0
  266. data/rbi/orb/models/bulk_bps_config.rbi +31 -0
  267. data/rbi/orb/models/bulk_bps_tier.rbi +50 -0
  268. data/rbi/orb/models/bulk_config.rbi +26 -0
  269. data/rbi/orb/models/bulk_tier.rbi +38 -0
  270. data/rbi/orb/models/changed_subscription_resources.rbi +61 -0
  271. data/rbi/orb/models/conversion_rate_tier.rbi +51 -0
  272. data/rbi/orb/models/conversion_rate_tiered_config.rbi +31 -0
  273. data/rbi/orb/models/conversion_rate_unit_config.rbi +27 -0
  274. data/rbi/orb/models/coupon_redemption.rbi +37 -0
  275. data/rbi/orb/models/credit_note.rbi +7 -87
  276. data/rbi/orb/models/credit_note_tiny.rbi +25 -0
  277. data/rbi/orb/models/custom_expiration.rbi +55 -0
  278. data/rbi/orb/models/customer.rbi +19 -522
  279. data/rbi/orb/models/customer_create_params.rbi +36 -957
  280. data/rbi/orb/models/customer_hierarchy_config.rbi +52 -0
  281. data/rbi/orb/models/customer_minified.rbi +32 -0
  282. data/rbi/orb/models/customer_tax_id.rbi +324 -0
  283. data/rbi/orb/models/customer_update_by_external_id_params.rbi +36 -1436
  284. data/rbi/orb/models/customer_update_params.rbi +36 -957
  285. data/rbi/orb/models/customers/balance_transaction_create_response.rbi +8 -96
  286. data/rbi/orb/models/customers/balance_transaction_list_response.rbi +8 -96
  287. data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +5 -191
  288. data/rbi/orb/models/customers/cost_list_response.rbi +5 -182
  289. data/rbi/orb/models/customers/credits/affected_block.rbi +50 -0
  290. data/rbi/orb/models/customers/credits/amendment_ledger_entry.rbi +207 -0
  291. data/rbi/orb/models/customers/credits/credit_block_expiry_ledger_entry.rbi +209 -0
  292. data/rbi/orb/models/customers/credits/decrement_ledger_entry.rbi +225 -0
  293. data/rbi/orb/models/customers/credits/expiration_change_ledger_entry.rbi +213 -0
  294. data/rbi/orb/models/customers/credits/increment_ledger_entry.rbi +215 -0
  295. data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +7 -1854
  296. data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +7 -1854
  297. data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +7 -1854
  298. data/rbi/orb/models/customers/credits/ledger_list_response.rbi +7 -1854
  299. data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +4 -84
  300. data/rbi/orb/models/customers/credits/top_up_create_response.rbi +4 -84
  301. data/rbi/orb/models/customers/credits/top_up_invoice_settings.rbi +83 -0
  302. data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +4 -84
  303. data/rbi/orb/models/customers/credits/top_up_list_response.rbi +4 -84
  304. data/rbi/orb/models/customers/credits/void_initiated_ledger_entry.rbi +225 -0
  305. data/rbi/orb/models/customers/credits/void_ledger_entry.rbi +219 -0
  306. data/rbi/orb/models/dimensional_price_configuration.rbi +38 -0
  307. data/rbi/orb/models/discount_override.rbi +83 -0
  308. data/rbi/orb/models/fixed_fee_quantity_schedule_entry.rbi +48 -0
  309. data/rbi/orb/models/fixed_fee_quantity_transition.rbi +39 -0
  310. data/rbi/orb/models/invoice.rbi +212 -3345
  311. data/rbi/orb/models/invoice_create_params.rbi +4 -33
  312. data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +355 -4329
  313. data/rbi/orb/models/invoice_line_item_create_response.rbi +30 -2260
  314. data/rbi/orb/models/invoice_tiny.rbi +24 -0
  315. data/rbi/orb/models/item_slim.rbi +23 -0
  316. data/rbi/orb/models/matrix_config.rbi +50 -0
  317. data/rbi/orb/models/matrix_sub_line_item.rbi +87 -0
  318. data/rbi/orb/models/matrix_value.rbi +43 -0
  319. data/rbi/orb/models/matrix_with_allocation_config.rbi +61 -0
  320. data/rbi/orb/models/maximum.rbi +52 -0
  321. data/rbi/orb/models/maximum_interval.rbi +69 -0
  322. data/rbi/orb/models/minimum.rbi +52 -0
  323. data/rbi/orb/models/minimum_interval.rbi +69 -0
  324. data/rbi/orb/models/monetary_amount_discount_adjustment.rbi +125 -0
  325. data/rbi/orb/models/monetary_maximum_adjustment.rbi +123 -0
  326. data/rbi/orb/models/monetary_minimum_adjustment.rbi +131 -0
  327. data/rbi/orb/models/monetary_percentage_discount_adjustment.rbi +131 -0
  328. data/rbi/orb/models/monetary_usage_discount_adjustment.rbi +125 -0
  329. data/rbi/orb/models/mutated_subscription.rbi +412 -0
  330. data/rbi/orb/models/new_accounting_sync_configuration.rbi +40 -0
  331. data/rbi/orb/models/new_allocation_price.rbi +104 -0
  332. data/rbi/orb/models/new_amount_discount.rbi +179 -0
  333. data/rbi/orb/models/new_avalara_tax_configuration.rbi +68 -0
  334. data/rbi/orb/models/new_billing_cycle_configuration.rbi +79 -0
  335. data/rbi/orb/models/new_dimensional_price_configuration.rbi +55 -0
  336. data/rbi/orb/models/new_floating_bps_price.rbi +294 -0
  337. data/rbi/orb/models/new_floating_bulk_bps_price.rbi +309 -0
  338. data/rbi/orb/models/new_floating_bulk_price.rbi +298 -0
  339. data/rbi/orb/models/new_floating_bulk_with_proration_price.rbi +331 -0
  340. data/rbi/orb/models/new_floating_cumulative_grouped_bulk_price.rbi +338 -0
  341. data/rbi/orb/models/new_floating_grouped_allocation_price.rbi +331 -0
  342. data/rbi/orb/models/new_floating_grouped_tiered_package_price.rbi +337 -0
  343. data/rbi/orb/models/new_floating_grouped_tiered_price.rbi +325 -0
  344. data/rbi/orb/models/new_floating_grouped_with_metered_minimum_price.rbi +348 -0
  345. data/rbi/orb/models/new_floating_grouped_with_prorated_minimum_price.rbi +348 -0
  346. data/rbi/orb/models/new_floating_matrix_price.rbi +304 -0
  347. data/rbi/orb/models/new_floating_matrix_with_allocation_price.rbi +345 -0
  348. data/rbi/orb/models/new_floating_matrix_with_display_name_price.rbi +338 -0
  349. data/rbi/orb/models/new_floating_max_group_tiered_package_price.rbi +338 -0
  350. data/rbi/orb/models/new_floating_package_price.rbi +306 -0
  351. data/rbi/orb/models/new_floating_package_with_allocation_price.rbi +338 -0
  352. data/rbi/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rbi +350 -0
  353. data/rbi/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rbi +349 -0
  354. data/rbi/orb/models/new_floating_threshold_total_amount_price.rbi +337 -0
  355. data/rbi/orb/models/new_floating_tiered_bps_price.rbi +317 -0
  356. data/rbi/orb/models/new_floating_tiered_package_price.rbi +325 -0
  357. data/rbi/orb/models/new_floating_tiered_package_with_minimum_price.rbi +348 -0
  358. data/rbi/orb/models/new_floating_tiered_price.rbi +304 -0
  359. data/rbi/orb/models/new_floating_tiered_with_minimum_price.rbi +331 -0
  360. data/rbi/orb/models/new_floating_tiered_with_proration_price.rbi +337 -0
  361. data/rbi/orb/models/new_floating_unit_price.rbi +298 -0
  362. data/rbi/orb/models/new_floating_unit_with_percent_price.rbi +328 -0
  363. data/rbi/orb/models/new_floating_unit_with_proration_price.rbi +331 -0
  364. data/rbi/orb/models/new_maximum.rbi +160 -0
  365. data/rbi/orb/models/new_minimum.rbi +168 -0
  366. data/rbi/orb/models/new_percentage_discount.rbi +193 -0
  367. data/rbi/orb/models/new_plan_bps_price.rbi +294 -0
  368. data/rbi/orb/models/new_plan_bulk_bps_price.rbi +297 -0
  369. data/rbi/orb/models/new_plan_bulk_price.rbi +295 -0
  370. data/rbi/orb/models/new_plan_bulk_with_proration_price.rbi +327 -0
  371. data/rbi/orb/models/new_plan_cumulative_grouped_bulk_price.rbi +333 -0
  372. data/rbi/orb/models/new_plan_grouped_allocation_price.rbi +327 -0
  373. data/rbi/orb/models/new_plan_grouped_tiered_package_price.rbi +333 -0
  374. data/rbi/orb/models/new_plan_grouped_tiered_price.rbi +316 -0
  375. data/rbi/orb/models/new_plan_grouped_with_metered_minimum_price.rbi +340 -0
  376. data/rbi/orb/models/new_plan_grouped_with_prorated_minimum_price.rbi +345 -0
  377. data/rbi/orb/models/new_plan_matrix_price.rbi +297 -0
  378. data/rbi/orb/models/new_plan_matrix_with_allocation_price.rbi +341 -0
  379. data/rbi/orb/models/new_plan_matrix_with_display_name_price.rbi +333 -0
  380. data/rbi/orb/models/new_plan_max_group_tiered_package_price.rbi +333 -0
  381. data/rbi/orb/models/new_plan_package_price.rbi +297 -0
  382. data/rbi/orb/models/new_plan_package_with_allocation_price.rbi +333 -0
  383. data/rbi/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rbi +352 -0
  384. data/rbi/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbi +351 -0
  385. data/rbi/orb/models/new_plan_threshold_total_amount_price.rbi +333 -0
  386. data/rbi/orb/models/new_plan_tier_with_proration_price.rbi +327 -0
  387. data/rbi/orb/models/new_plan_tiered_bps_price.rbi +304 -0
  388. data/rbi/orb/models/new_plan_tiered_package_price.rbi +316 -0
  389. data/rbi/orb/models/new_plan_tiered_package_with_minimum_price.rbi +339 -0
  390. data/rbi/orb/models/new_plan_tiered_price.rbi +297 -0
  391. data/rbi/orb/models/new_plan_tiered_with_minimum_price.rbi +327 -0
  392. data/rbi/orb/models/new_plan_unit_price.rbi +295 -0
  393. data/rbi/orb/models/new_plan_unit_with_percent_price.rbi +325 -0
  394. data/rbi/orb/models/new_plan_unit_with_proration_price.rbi +327 -0
  395. data/rbi/orb/models/new_reporting_configuration.rbi +23 -0
  396. data/rbi/orb/models/new_sphere_configuration.rbi +59 -0
  397. data/rbi/orb/models/new_subscription_bps_price.rbi +317 -0
  398. data/rbi/orb/models/new_subscription_bulk_bps_price.rbi +338 -0
  399. data/rbi/orb/models/new_subscription_bulk_price.rbi +321 -0
  400. data/rbi/orb/models/new_subscription_bulk_with_proration_price.rbi +350 -0
  401. data/rbi/orb/models/new_subscription_cumulative_grouped_bulk_price.rbi +360 -0
  402. data/rbi/orb/models/new_subscription_grouped_allocation_price.rbi +350 -0
  403. data/rbi/orb/models/new_subscription_grouped_tiered_package_price.rbi +360 -0
  404. data/rbi/orb/models/new_subscription_grouped_tiered_price.rbi +343 -0
  405. data/rbi/orb/models/new_subscription_grouped_with_metered_minimum_price.rbi +360 -0
  406. data/rbi/orb/models/new_subscription_grouped_with_prorated_minimum_price.rbi +360 -0
  407. data/rbi/orb/models/new_subscription_matrix_price.rbi +332 -0
  408. data/rbi/orb/models/new_subscription_matrix_with_allocation_price.rbi +368 -0
  409. data/rbi/orb/models/new_subscription_matrix_with_display_name_price.rbi +360 -0
  410. data/rbi/orb/models/new_subscription_max_group_tiered_package_price.rbi +360 -0
  411. data/rbi/orb/models/new_subscription_package_price.rbi +338 -0
  412. data/rbi/orb/models/new_subscription_package_with_allocation_price.rbi +360 -0
  413. data/rbi/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rbi +362 -0
  414. data/rbi/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rbi +361 -0
  415. data/rbi/orb/models/new_subscription_threshold_total_amount_price.rbi +360 -0
  416. data/rbi/orb/models/new_subscription_tier_with_proration_price.rbi +350 -0
  417. data/rbi/orb/models/new_subscription_tiered_bps_price.rbi +340 -0
  418. data/rbi/orb/models/new_subscription_tiered_package_price.rbi +343 -0
  419. data/rbi/orb/models/new_subscription_tiered_package_with_minimum_price.rbi +360 -0
  420. data/rbi/orb/models/new_subscription_tiered_price.rbi +332 -0
  421. data/rbi/orb/models/new_subscription_tiered_with_minimum_price.rbi +350 -0
  422. data/rbi/orb/models/new_subscription_unit_price.rbi +321 -0
  423. data/rbi/orb/models/new_subscription_unit_with_percent_price.rbi +349 -0
  424. data/rbi/orb/models/new_subscription_unit_with_proration_price.rbi +350 -0
  425. data/rbi/orb/models/new_tax_jar_configuration.rbi +59 -0
  426. data/rbi/orb/models/new_usage_discount.rbi +177 -0
  427. data/rbi/orb/models/other_sub_line_item.rbi +78 -0
  428. data/rbi/orb/models/package_config.rbi +39 -0
  429. data/rbi/orb/models/per_price_cost.rbi +96 -0
  430. data/rbi/orb/models/percentage_discount.rbi +8 -0
  431. data/rbi/orb/models/percentage_discount_interval.rbi +107 -0
  432. data/rbi/orb/models/plan.rbi +29 -1937
  433. data/rbi/orb/models/plan_create_params.rbi +112 -15428
  434. data/rbi/orb/models/plan_phase_amount_discount_adjustment.rbi +128 -0
  435. data/rbi/orb/models/plan_phase_maximum_adjustment.rbi +123 -0
  436. data/rbi/orb/models/plan_phase_minimum_adjustment.rbi +131 -0
  437. data/rbi/orb/models/plan_phase_percentage_discount_adjustment.rbi +131 -0
  438. data/rbi/orb/models/plan_phase_usage_discount_adjustment.rbi +125 -0
  439. data/rbi/orb/models/plan_version.rbi +13 -1252
  440. data/rbi/orb/models/price.rbi +3518 -26097
  441. data/rbi/orb/models/price_create_params.rbi +81 -937
  442. data/rbi/orb/models/price_evaluate_multiple_params.rbi +112 -15566
  443. data/rbi/orb/models/price_evaluate_preview_events_params.rbi +411 -0
  444. data/rbi/orb/models/price_evaluate_preview_events_response.rbi +101 -0
  445. data/rbi/orb/models/price_interval.rbi +174 -0
  446. data/rbi/orb/models/sub_line_item_grouping.rbi +31 -0
  447. data/rbi/orb/models/sub_line_item_matrix_config.rbi +33 -0
  448. data/rbi/orb/models/subscription.rbi +51 -2939
  449. data/rbi/orb/models/subscription_change_apply_response.rbi +4 -3580
  450. data/rbi/orb/models/subscription_change_cancel_response.rbi +4 -3580
  451. data/rbi/orb/models/subscription_change_minified.rbi +23 -0
  452. data/rbi/orb/models/subscription_change_retrieve_response.rbi +4 -3582
  453. data/rbi/orb/models/subscription_create_params.rbi +541 -33368
  454. data/rbi/orb/models/subscription_fetch_costs_response.rbi +5 -182
  455. data/rbi/orb/models/subscription_minified.rbi +23 -0
  456. data/rbi/orb/models/subscription_price_intervals_params.rbi +224 -16144
  457. data/rbi/orb/models/subscription_redeem_coupon_params.rbi +16 -8
  458. data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +549 -33384
  459. data/rbi/orb/models/subscription_trial_info.rbi +23 -0
  460. data/rbi/orb/models/tax_amount.rbi +50 -0
  461. data/rbi/orb/models/threshold.rbi +30 -0
  462. data/rbi/orb/models/tier.rbi +50 -0
  463. data/rbi/orb/models/tier_config.rbi +40 -0
  464. data/rbi/orb/models/tier_sub_line_item.rbi +87 -0
  465. data/rbi/orb/models/tiered_bps_config.rbi +29 -0
  466. data/rbi/orb/models/tiered_config.rbi +26 -0
  467. data/rbi/orb/models/tiered_conversion_rate_config.rbi +73 -0
  468. data/rbi/orb/models/transform_price_filter.rbi +106 -0
  469. data/rbi/orb/models/trial_discount.rbi +8 -0
  470. data/rbi/orb/models/unit_config.rbi +24 -0
  471. data/rbi/orb/models/unit_conversion_rate_config.rbi +71 -0
  472. data/rbi/orb/models/usage_discount.rbi +8 -0
  473. data/rbi/orb/models/usage_discount_interval.rbi +99 -0
  474. data/rbi/orb/models.rbi +398 -0
  475. data/rbi/orb/resources/alerts.rbi +4 -13
  476. data/rbi/orb/resources/customers.rbi +27 -51
  477. data/rbi/orb/resources/plans.rbi +28 -28
  478. data/rbi/orb/resources/prices.rbi +82 -36
  479. data/rbi/orb/resources/subscriptions.rbi +19 -22
  480. data/sig/orb/models/accounting_provider_config.rbs +19 -0
  481. data/sig/orb/models/address.rbs +45 -0
  482. data/sig/orb/models/address_input.rbs +45 -0
  483. data/sig/orb/models/adjustment_interval.rbs +53 -0
  484. data/sig/orb/models/aggregated_cost.rbs +40 -0
  485. data/sig/orb/models/alert.rbs +12 -44
  486. data/sig/orb/models/alert_create_for_customer_params.rbs +4 -14
  487. data/sig/orb/models/alert_create_for_external_customer_params.rbs +4 -14
  488. data/sig/orb/models/alert_create_for_subscription_params.rbs +4 -14
  489. data/sig/orb/models/alert_update_params.rbs +4 -14
  490. data/sig/orb/models/allocation.rbs +30 -0
  491. data/sig/orb/models/amount_discount.rbs +5 -0
  492. data/sig/orb/models/amount_discount_interval.rbs +55 -0
  493. data/sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs +147 -12821
  494. data/sig/orb/models/beta_create_plan_version_params.rbs +144 -12802
  495. data/sig/orb/models/billable_metric_tiny.rbs +13 -0
  496. data/sig/orb/models/billing_cycle_anchor_configuration.rbs +18 -0
  497. data/sig/orb/models/billing_cycle_configuration.rbs +36 -0
  498. data/sig/orb/models/bps_config.rbs +15 -0
  499. data/sig/orb/models/bps_tier.rbs +35 -0
  500. data/sig/orb/models/bulk_bps_config.rbs +13 -0
  501. data/sig/orb/models/bulk_bps_tier.rbs +26 -0
  502. data/sig/orb/models/bulk_config.rbs +13 -0
  503. data/sig/orb/models/bulk_tier.rbs +15 -0
  504. data/sig/orb/models/changed_subscription_resources.rbs +35 -0
  505. data/sig/orb/models/conversion_rate_tier.rbs +26 -0
  506. data/sig/orb/models/conversion_rate_tiered_config.rbs +14 -0
  507. data/sig/orb/models/conversion_rate_unit_config.rbs +13 -0
  508. data/sig/orb/models/coupon_redemption.rbs +22 -0
  509. data/sig/orb/models/credit_note.rbs +8 -47
  510. data/sig/orb/models/credit_note_tiny.rbs +13 -0
  511. data/sig/orb/models/custom_expiration.rbs +36 -0
  512. data/sig/orb/models/customer.rbs +20 -471
  513. data/sig/orb/models/customer_create_params.rbs +27 -577
  514. data/sig/orb/models/customer_hierarchy_config.rbs +24 -0
  515. data/sig/orb/models/customer_minified.rbs +15 -0
  516. data/sig/orb/models/customer_tax_id.rbs +346 -0
  517. data/sig/orb/models/customer_update_by_external_id_params.rbs +27 -577
  518. data/sig/orb/models/customer_update_params.rbs +27 -577
  519. data/sig/orb/models/customers/balance_transaction_create_response.rbs +8 -28
  520. data/sig/orb/models/customers/balance_transaction_list_response.rbs +8 -28
  521. data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +4 -84
  522. data/sig/orb/models/customers/cost_list_response.rbs +4 -83
  523. data/sig/orb/models/customers/credits/affected_block.rbs +30 -0
  524. data/sig/orb/models/customers/credits/amendment_ledger_entry.rbs +105 -0
  525. data/sig/orb/models/customers/credits/credit_block_expiry_ledger_entry.rbs +107 -0
  526. data/sig/orb/models/customers/credits/decrement_ledger_entry.rbs +120 -0
  527. data/sig/orb/models/customers/credits/expiration_change_ledger_entry.rbs +110 -0
  528. data/sig/orb/models/customers/credits/increment_ledger_entry.rbs +110 -0
  529. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +7 -939
  530. data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +7 -939
  531. data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +7 -939
  532. data/sig/orb/models/customers/credits/ledger_list_response.rbs +7 -939
  533. data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +4 -38
  534. data/sig/orb/models/customers/credits/top_up_create_response.rbs +4 -38
  535. data/sig/orb/models/customers/credits/top_up_invoice_settings.rbs +41 -0
  536. data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +4 -38
  537. data/sig/orb/models/customers/credits/top_up_list_response.rbs +4 -38
  538. data/sig/orb/models/customers/credits/void_initiated_ledger_entry.rbs +120 -0
  539. data/sig/orb/models/customers/credits/void_ledger_entry.rbs +115 -0
  540. data/sig/orb/models/dimensional_price_configuration.rbs +22 -0
  541. data/sig/orb/models/discount_override.rbs +47 -0
  542. data/sig/orb/models/fixed_fee_quantity_schedule_entry.rbs +30 -0
  543. data/sig/orb/models/fixed_fee_quantity_transition.rbs +26 -0
  544. data/sig/orb/models/invoice.rbs +54 -1612
  545. data/sig/orb/models/invoice_create_params.rbs +4 -14
  546. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +54 -1612
  547. data/sig/orb/models/invoice_line_item_create_response.rbs +18 -927
  548. data/sig/orb/models/invoice_tiny.rbs +13 -0
  549. data/sig/orb/models/item_slim.rbs +15 -0
  550. data/sig/orb/models/matrix_config.rbs +30 -0
  551. data/sig/orb/models/matrix_sub_line_item.rbs +55 -0
  552. data/sig/orb/models/matrix_value.rbs +22 -0
  553. data/sig/orb/models/matrix_with_allocation_config.rbs +35 -0
  554. data/sig/orb/models/maximum.rbs +30 -0
  555. data/sig/orb/models/maximum_interval.rbs +40 -0
  556. data/sig/orb/models/minimum.rbs +30 -0
  557. data/sig/orb/models/minimum_interval.rbs +40 -0
  558. data/sig/orb/models/monetary_amount_discount_adjustment.rbs +65 -0
  559. data/sig/orb/models/monetary_maximum_adjustment.rbs +65 -0
  560. data/sig/orb/models/monetary_minimum_adjustment.rbs +70 -0
  561. data/sig/orb/models/monetary_percentage_discount_adjustment.rbs +65 -0
  562. data/sig/orb/models/monetary_usage_discount_adjustment.rbs +65 -0
  563. data/sig/orb/models/mutated_subscription.rbs +178 -0
  564. data/sig/orb/models/new_accounting_sync_configuration.rbs +25 -0
  565. data/sig/orb/models/new_allocation_price.rbs +56 -0
  566. data/sig/orb/models/new_amount_discount.rbs +97 -0
  567. data/sig/orb/models/new_avalara_tax_configuration.rbs +40 -0
  568. data/sig/orb/models/new_billing_cycle_configuration.rbs +36 -0
  569. data/sig/orb/models/new_dimensional_price_configuration.rbs +30 -0
  570. data/sig/orb/models/new_floating_bps_price.rbs +135 -0
  571. data/sig/orb/models/new_floating_bulk_bps_price.rbs +135 -0
  572. data/sig/orb/models/new_floating_bulk_price.rbs +135 -0
  573. data/sig/orb/models/new_floating_bulk_with_proration_price.rbs +135 -0
  574. data/sig/orb/models/new_floating_cumulative_grouped_bulk_price.rbs +135 -0
  575. data/sig/orb/models/new_floating_grouped_allocation_price.rbs +135 -0
  576. data/sig/orb/models/new_floating_grouped_tiered_package_price.rbs +135 -0
  577. data/sig/orb/models/new_floating_grouped_tiered_price.rbs +135 -0
  578. data/sig/orb/models/new_floating_grouped_with_metered_minimum_price.rbs +135 -0
  579. data/sig/orb/models/new_floating_grouped_with_prorated_minimum_price.rbs +135 -0
  580. data/sig/orb/models/new_floating_matrix_price.rbs +135 -0
  581. data/sig/orb/models/new_floating_matrix_with_allocation_price.rbs +135 -0
  582. data/sig/orb/models/new_floating_matrix_with_display_name_price.rbs +135 -0
  583. data/sig/orb/models/new_floating_max_group_tiered_package_price.rbs +135 -0
  584. data/sig/orb/models/new_floating_package_price.rbs +135 -0
  585. data/sig/orb/models/new_floating_package_with_allocation_price.rbs +135 -0
  586. data/sig/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rbs +135 -0
  587. data/sig/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rbs +135 -0
  588. data/sig/orb/models/new_floating_threshold_total_amount_price.rbs +135 -0
  589. data/sig/orb/models/new_floating_tiered_bps_price.rbs +135 -0
  590. data/sig/orb/models/new_floating_tiered_package_price.rbs +135 -0
  591. data/sig/orb/models/new_floating_tiered_package_with_minimum_price.rbs +135 -0
  592. data/sig/orb/models/new_floating_tiered_price.rbs +135 -0
  593. data/sig/orb/models/new_floating_tiered_with_minimum_price.rbs +135 -0
  594. data/sig/orb/models/new_floating_tiered_with_proration_price.rbs +135 -0
  595. data/sig/orb/models/new_floating_unit_price.rbs +135 -0
  596. data/sig/orb/models/new_floating_unit_with_percent_price.rbs +135 -0
  597. data/sig/orb/models/new_floating_unit_with_proration_price.rbs +135 -0
  598. data/sig/orb/models/new_maximum.rbs +97 -0
  599. data/sig/orb/models/new_minimum.rbs +102 -0
  600. data/sig/orb/models/new_percentage_discount.rbs +97 -0
  601. data/sig/orb/models/new_plan_bps_price.rbs +135 -0
  602. data/sig/orb/models/new_plan_bulk_bps_price.rbs +135 -0
  603. data/sig/orb/models/new_plan_bulk_price.rbs +135 -0
  604. data/sig/orb/models/new_plan_bulk_with_proration_price.rbs +135 -0
  605. data/sig/orb/models/new_plan_cumulative_grouped_bulk_price.rbs +135 -0
  606. data/sig/orb/models/new_plan_grouped_allocation_price.rbs +135 -0
  607. data/sig/orb/models/new_plan_grouped_tiered_package_price.rbs +135 -0
  608. data/sig/orb/models/new_plan_grouped_tiered_price.rbs +135 -0
  609. data/sig/orb/models/new_plan_grouped_with_metered_minimum_price.rbs +135 -0
  610. data/sig/orb/models/new_plan_grouped_with_prorated_minimum_price.rbs +135 -0
  611. data/sig/orb/models/new_plan_matrix_price.rbs +135 -0
  612. data/sig/orb/models/new_plan_matrix_with_allocation_price.rbs +135 -0
  613. data/sig/orb/models/new_plan_matrix_with_display_name_price.rbs +135 -0
  614. data/sig/orb/models/new_plan_max_group_tiered_package_price.rbs +135 -0
  615. data/sig/orb/models/new_plan_package_price.rbs +135 -0
  616. data/sig/orb/models/new_plan_package_with_allocation_price.rbs +135 -0
  617. data/sig/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rbs +135 -0
  618. data/sig/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbs +135 -0
  619. data/sig/orb/models/new_plan_threshold_total_amount_price.rbs +135 -0
  620. data/sig/orb/models/new_plan_tier_with_proration_price.rbs +135 -0
  621. data/sig/orb/models/new_plan_tiered_bps_price.rbs +135 -0
  622. data/sig/orb/models/new_plan_tiered_package_price.rbs +135 -0
  623. data/sig/orb/models/new_plan_tiered_package_with_minimum_price.rbs +135 -0
  624. data/sig/orb/models/new_plan_tiered_price.rbs +135 -0
  625. data/sig/orb/models/new_plan_tiered_with_minimum_price.rbs +135 -0
  626. data/sig/orb/models/new_plan_unit_price.rbs +135 -0
  627. data/sig/orb/models/new_plan_unit_with_percent_price.rbs +135 -0
  628. data/sig/orb/models/new_plan_unit_with_proration_price.rbs +135 -0
  629. data/sig/orb/models/new_reporting_configuration.rbs +13 -0
  630. data/sig/orb/models/new_sphere_configuration.rbs +35 -0
  631. data/sig/orb/models/new_subscription_bps_price.rbs +140 -0
  632. data/sig/orb/models/new_subscription_bulk_bps_price.rbs +140 -0
  633. data/sig/orb/models/new_subscription_bulk_price.rbs +140 -0
  634. data/sig/orb/models/new_subscription_bulk_with_proration_price.rbs +140 -0
  635. data/sig/orb/models/new_subscription_cumulative_grouped_bulk_price.rbs +140 -0
  636. data/sig/orb/models/new_subscription_grouped_allocation_price.rbs +140 -0
  637. data/sig/orb/models/new_subscription_grouped_tiered_package_price.rbs +140 -0
  638. data/sig/orb/models/new_subscription_grouped_tiered_price.rbs +140 -0
  639. data/sig/orb/models/new_subscription_grouped_with_metered_minimum_price.rbs +140 -0
  640. data/sig/orb/models/new_subscription_grouped_with_prorated_minimum_price.rbs +140 -0
  641. data/sig/orb/models/new_subscription_matrix_price.rbs +140 -0
  642. data/sig/orb/models/new_subscription_matrix_with_allocation_price.rbs +140 -0
  643. data/sig/orb/models/new_subscription_matrix_with_display_name_price.rbs +140 -0
  644. data/sig/orb/models/new_subscription_max_group_tiered_package_price.rbs +140 -0
  645. data/sig/orb/models/new_subscription_package_price.rbs +140 -0
  646. data/sig/orb/models/new_subscription_package_with_allocation_price.rbs +140 -0
  647. data/sig/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rbs +140 -0
  648. data/sig/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rbs +140 -0
  649. data/sig/orb/models/new_subscription_threshold_total_amount_price.rbs +140 -0
  650. data/sig/orb/models/new_subscription_tier_with_proration_price.rbs +140 -0
  651. data/sig/orb/models/new_subscription_tiered_bps_price.rbs +140 -0
  652. data/sig/orb/models/new_subscription_tiered_package_price.rbs +140 -0
  653. data/sig/orb/models/new_subscription_tiered_package_with_minimum_price.rbs +140 -0
  654. data/sig/orb/models/new_subscription_tiered_price.rbs +140 -0
  655. data/sig/orb/models/new_subscription_tiered_with_minimum_price.rbs +140 -0
  656. data/sig/orb/models/new_subscription_unit_price.rbs +140 -0
  657. data/sig/orb/models/new_subscription_unit_with_percent_price.rbs +140 -0
  658. data/sig/orb/models/new_subscription_unit_with_proration_price.rbs +140 -0
  659. data/sig/orb/models/new_tax_jar_configuration.rbs +35 -0
  660. data/sig/orb/models/new_usage_discount.rbs +97 -0
  661. data/sig/orb/models/other_sub_line_item.rbs +50 -0
  662. data/sig/orb/models/package_config.rbs +15 -0
  663. data/sig/orb/models/per_price_cost.rbs +40 -0
  664. data/sig/orb/models/percentage_discount.rbs +5 -0
  665. data/sig/orb/models/percentage_discount_interval.rbs +55 -0
  666. data/sig/orb/models/plan.rbs +21 -871
  667. data/sig/orb/models/plan_create_params.rbs +28 -5952
  668. data/sig/orb/models/plan_phase_amount_discount_adjustment.rbs +65 -0
  669. data/sig/orb/models/plan_phase_maximum_adjustment.rbs +65 -0
  670. data/sig/orb/models/plan_phase_minimum_adjustment.rbs +70 -0
  671. data/sig/orb/models/plan_phase_percentage_discount_adjustment.rbs +65 -0
  672. data/sig/orb/models/plan_phase_usage_discount_adjustment.rbs +65 -0
  673. data/sig/orb/models/plan_version.rbs +5 -535
  674. data/sig/orb/models/price.rbs +2164 -11297
  675. data/sig/orb/models/price_create_params.rbs +58 -418
  676. data/sig/orb/models/price_evaluate_multiple_params.rbs +28 -6138
  677. data/sig/orb/models/price_evaluate_preview_events_params.rbs +166 -0
  678. data/sig/orb/models/price_evaluate_preview_events_response.rbs +50 -0
  679. data/sig/orb/models/price_interval.rbs +65 -0
  680. data/sig/orb/models/sub_line_item_grouping.rbs +15 -0
  681. data/sig/orb/models/sub_line_item_matrix_config.rbs +13 -0
  682. data/sig/orb/models/subscription.rbs +39 -1274
  683. data/sig/orb/models/subscription_change_apply_response.rbs +4 -1467
  684. data/sig/orb/models/subscription_change_cancel_response.rbs +4 -1467
  685. data/sig/orb/models/subscription_change_minified.rbs +13 -0
  686. data/sig/orb/models/subscription_change_retrieve_response.rbs +4 -1467
  687. data/sig/orb/models/subscription_create_params.rbs +174 -13219
  688. data/sig/orb/models/subscription_fetch_costs_response.rbs +4 -82
  689. data/sig/orb/models/subscription_minified.rbs +13 -0
  690. data/sig/orb/models/subscription_price_intervals_params.rbs +61 -6390
  691. data/sig/orb/models/subscription_redeem_coupon_params.rbs +11 -6
  692. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +175 -13220
  693. data/sig/orb/models/subscription_trial_info.rbs +13 -0
  694. data/sig/orb/models/tax_amount.rbs +30 -0
  695. data/sig/orb/models/threshold.rbs +13 -0
  696. data/sig/orb/models/tier.rbs +25 -0
  697. data/sig/orb/models/tier_config.rbs +26 -0
  698. data/sig/orb/models/tier_sub_line_item.rbs +55 -0
  699. data/sig/orb/models/tiered_bps_config.rbs +13 -0
  700. data/sig/orb/models/tiered_config.rbs +13 -0
  701. data/sig/orb/models/tiered_conversion_rate_config.rbs +35 -0
  702. data/sig/orb/models/transform_price_filter.rbs +56 -0
  703. data/sig/orb/models/trial_discount.rbs +5 -0
  704. data/sig/orb/models/unit_config.rbs +13 -0
  705. data/sig/orb/models/unit_conversion_rate_config.rbs +35 -0
  706. data/sig/orb/models/usage_discount.rbs +5 -0
  707. data/sig/orb/models/usage_discount_interval.rbs +55 -0
  708. data/sig/orb/models.rbs +342 -0
  709. data/sig/orb/resources/alerts.rbs +4 -4
  710. data/sig/orb/resources/customers.rbs +18 -18
  711. data/sig/orb/resources/prices.rbs +23 -13
  712. data/sig/orb/resources/subscriptions.rbs +15 -14
  713. metadata +545 -35
  714. data/lib/orb/models/subscription_cancel_response.rb +0 -1873
  715. data/lib/orb/models/subscription_create_response.rb +0 -1873
  716. data/lib/orb/models/subscription_price_intervals_response.rb +0 -1888
  717. data/lib/orb/models/subscription_redeem_coupon_response.rb +0 -1883
  718. data/lib/orb/models/subscription_schedule_plan_change_response.rb +0 -1893
  719. data/lib/orb/models/subscription_trigger_phase_response.rb +0 -1883
  720. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +0 -1897
  721. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +0 -1912
  722. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +0 -1908
  723. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +0 -1897
  724. data/lib/orb/models/subscription_update_trial_response.rb +0 -1879
  725. data/rbi/orb/models/subscription_cancel_response.rbi +0 -3537
  726. data/rbi/orb/models/subscription_create_response.rbi +0 -3537
  727. data/rbi/orb/models/subscription_price_intervals_response.rbi +0 -3564
  728. data/rbi/orb/models/subscription_redeem_coupon_response.rbi +0 -3557
  729. data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +0 -3564
  730. data/rbi/orb/models/subscription_trigger_phase_response.rbi +0 -3557
  731. data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +0 -3566
  732. data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +0 -3566
  733. data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +0 -3566
  734. data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +0 -3566
  735. data/rbi/orb/models/subscription_update_trial_response.rbi +0 -3556
  736. data/sig/orb/models/subscription_cancel_response.rbs +0 -1445
  737. data/sig/orb/models/subscription_create_response.rbs +0 -1445
  738. data/sig/orb/models/subscription_price_intervals_response.rbs +0 -1445
  739. data/sig/orb/models/subscription_redeem_coupon_response.rbs +0 -1445
  740. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +0 -1445
  741. data/sig/orb/models/subscription_trigger_phase_response.rbs +0 -1445
  742. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +0 -1445
  743. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +0 -1445
  744. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +0 -1445
  745. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +0 -1445
  746. data/sig/orb/models/subscription_update_trial_response.rbs +0 -1445
@@ -13,1175 +13,22 @@ module Orb
13
13
 
14
14
  discriminator :entry_type
15
15
 
16
- variant :increment, -> { Orb::Models::Customers::Credits::LedgerListResponse::Increment }
16
+ variant :increment, -> { Orb::Customers::Credits::IncrementLedgerEntry }
17
17
 
18
- variant :decrement, -> { Orb::Models::Customers::Credits::LedgerListResponse::Decrement }
18
+ variant :decrement, -> { Orb::Customers::Credits::DecrementLedgerEntry }
19
19
 
20
- variant :expiration_change, -> { Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChange }
20
+ variant :expiration_change, -> { Orb::Customers::Credits::ExpirationChangeLedgerEntry }
21
21
 
22
- variant :credit_block_expiry,
23
- -> { Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiry }
22
+ variant :credit_block_expiry, -> { Orb::Customers::Credits::CreditBlockExpiryLedgerEntry }
24
23
 
25
- variant :void, -> { Orb::Models::Customers::Credits::LedgerListResponse::Void }
24
+ variant :void, -> { Orb::Customers::Credits::VoidLedgerEntry }
26
25
 
27
- variant :void_initiated, -> { Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiated }
26
+ variant :void_initiated, -> { Orb::Customers::Credits::VoidInitiatedLedgerEntry }
28
27
 
29
- variant :amendment, -> { Orb::Models::Customers::Credits::LedgerListResponse::Amendment }
30
-
31
- class Increment < Orb::Internal::Type::BaseModel
32
- # @!attribute id
33
- #
34
- # @return [String]
35
- required :id, String
36
-
37
- # @!attribute amount
38
- #
39
- # @return [Float]
40
- required :amount, Float
41
-
42
- # @!attribute created_at
43
- #
44
- # @return [Time]
45
- required :created_at, Time
46
-
47
- # @!attribute credit_block
48
- #
49
- # @return [Orb::Models::Customers::Credits::LedgerListResponse::Increment::CreditBlock]
50
- required :credit_block, -> { Orb::Models::Customers::Credits::LedgerListResponse::Increment::CreditBlock }
51
-
52
- # @!attribute currency
53
- #
54
- # @return [String]
55
- required :currency, String
56
-
57
- # @!attribute customer
58
- #
59
- # @return [Orb::Models::Customers::Credits::LedgerListResponse::Increment::Customer]
60
- required :customer, -> { Orb::Models::Customers::Credits::LedgerListResponse::Increment::Customer }
61
-
62
- # @!attribute description
63
- #
64
- # @return [String, nil]
65
- required :description, String, nil?: true
66
-
67
- # @!attribute ending_balance
68
- #
69
- # @return [Float]
70
- required :ending_balance, Float
71
-
72
- # @!attribute entry_status
73
- #
74
- # @return [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::Increment::EntryStatus]
75
- required :entry_status,
76
- enum: -> { Orb::Models::Customers::Credits::LedgerListResponse::Increment::EntryStatus }
77
-
78
- # @!attribute entry_type
79
- #
80
- # @return [Symbol, :increment]
81
- required :entry_type, const: :increment
82
-
83
- # @!attribute ledger_sequence_number
84
- #
85
- # @return [Integer]
86
- required :ledger_sequence_number, Integer
87
-
88
- # @!attribute metadata
89
- # User specified key-value pairs for the resource. If not present, this defaults
90
- # to an empty dictionary. Individual keys can be removed by setting the value to
91
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
92
- # `null`.
93
- #
94
- # @return [Hash{Symbol=>String}]
95
- required :metadata, Orb::Internal::Type::HashOf[String]
96
-
97
- # @!attribute starting_balance
98
- #
99
- # @return [Float]
100
- required :starting_balance, Float
101
-
102
- # @!attribute created_invoices
103
- # If the increment resulted in invoice creation, the list of created invoices
104
- #
105
- # @return [Array<Orb::Models::Invoice>, nil]
106
- optional :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }, nil?: true
107
-
108
- # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, created_invoices: nil, entry_type: :increment)
109
- # Some parameter documentations has been truncated, see
110
- # {Orb::Models::Customers::Credits::LedgerListResponse::Increment} for more
111
- # details.
112
- #
113
- # @param id [String]
114
- #
115
- # @param amount [Float]
116
- #
117
- # @param created_at [Time]
118
- #
119
- # @param credit_block [Orb::Models::Customers::Credits::LedgerListResponse::Increment::CreditBlock]
120
- #
121
- # @param currency [String]
122
- #
123
- # @param customer [Orb::Models::Customers::Credits::LedgerListResponse::Increment::Customer]
124
- #
125
- # @param description [String, nil]
126
- #
127
- # @param ending_balance [Float]
128
- #
129
- # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::Increment::EntryStatus]
130
- #
131
- # @param ledger_sequence_number [Integer]
132
- #
133
- # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
134
- #
135
- # @param starting_balance [Float]
136
- #
137
- # @param created_invoices [Array<Orb::Models::Invoice>, nil] If the increment resulted in invoice creation, the list of created invoices
138
- #
139
- # @param entry_type [Symbol, :increment]
140
-
141
- # @see Orb::Models::Customers::Credits::LedgerListResponse::Increment#credit_block
142
- class CreditBlock < Orb::Internal::Type::BaseModel
143
- # @!attribute id
144
- #
145
- # @return [String]
146
- required :id, String
147
-
148
- # @!attribute expiry_date
149
- #
150
- # @return [Time, nil]
151
- required :expiry_date, Time, nil?: true
152
-
153
- # @!attribute per_unit_cost_basis
154
- #
155
- # @return [String, nil]
156
- required :per_unit_cost_basis, String, nil?: true
157
-
158
- # @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
159
- # @param id [String]
160
- # @param expiry_date [Time, nil]
161
- # @param per_unit_cost_basis [String, nil]
162
- end
163
-
164
- # @see Orb::Models::Customers::Credits::LedgerListResponse::Increment#customer
165
- class Customer < Orb::Internal::Type::BaseModel
166
- # @!attribute id
167
- #
168
- # @return [String]
169
- required :id, String
170
-
171
- # @!attribute external_customer_id
172
- #
173
- # @return [String, nil]
174
- required :external_customer_id, String, nil?: true
175
-
176
- # @!method initialize(id:, external_customer_id:)
177
- # @param id [String]
178
- # @param external_customer_id [String, nil]
179
- end
180
-
181
- # @see Orb::Models::Customers::Credits::LedgerListResponse::Increment#entry_status
182
- module EntryStatus
183
- extend Orb::Internal::Type::Enum
184
-
185
- COMMITTED = :committed
186
- PENDING = :pending
187
-
188
- # @!method self.values
189
- # @return [Array<Symbol>]
190
- end
191
- end
192
-
193
- class Decrement < Orb::Internal::Type::BaseModel
194
- # @!attribute id
195
- #
196
- # @return [String]
197
- required :id, String
198
-
199
- # @!attribute amount
200
- #
201
- # @return [Float]
202
- required :amount, Float
203
-
204
- # @!attribute created_at
205
- #
206
- # @return [Time]
207
- required :created_at, Time
208
-
209
- # @!attribute credit_block
210
- #
211
- # @return [Orb::Models::Customers::Credits::LedgerListResponse::Decrement::CreditBlock]
212
- required :credit_block, -> { Orb::Models::Customers::Credits::LedgerListResponse::Decrement::CreditBlock }
213
-
214
- # @!attribute currency
215
- #
216
- # @return [String]
217
- required :currency, String
218
-
219
- # @!attribute customer
220
- #
221
- # @return [Orb::Models::Customers::Credits::LedgerListResponse::Decrement::Customer]
222
- required :customer, -> { Orb::Models::Customers::Credits::LedgerListResponse::Decrement::Customer }
223
-
224
- # @!attribute description
225
- #
226
- # @return [String, nil]
227
- required :description, String, nil?: true
228
-
229
- # @!attribute ending_balance
230
- #
231
- # @return [Float]
232
- required :ending_balance, Float
233
-
234
- # @!attribute entry_status
235
- #
236
- # @return [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::Decrement::EntryStatus]
237
- required :entry_status,
238
- enum: -> { Orb::Models::Customers::Credits::LedgerListResponse::Decrement::EntryStatus }
239
-
240
- # @!attribute entry_type
241
- #
242
- # @return [Symbol, :decrement]
243
- required :entry_type, const: :decrement
244
-
245
- # @!attribute ledger_sequence_number
246
- #
247
- # @return [Integer]
248
- required :ledger_sequence_number, Integer
249
-
250
- # @!attribute metadata
251
- # User specified key-value pairs for the resource. If not present, this defaults
252
- # to an empty dictionary. Individual keys can be removed by setting the value to
253
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
254
- # `null`.
255
- #
256
- # @return [Hash{Symbol=>String}]
257
- required :metadata, Orb::Internal::Type::HashOf[String]
258
-
259
- # @!attribute starting_balance
260
- #
261
- # @return [Float]
262
- required :starting_balance, Float
263
-
264
- # @!attribute event_id
265
- #
266
- # @return [String, nil]
267
- optional :event_id, String, nil?: true
268
-
269
- # @!attribute invoice_id
270
- #
271
- # @return [String, nil]
272
- optional :invoice_id, String, nil?: true
273
-
274
- # @!attribute price_id
275
- #
276
- # @return [String, nil]
277
- optional :price_id, String, nil?: true
278
-
279
- # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, event_id: nil, invoice_id: nil, price_id: nil, entry_type: :decrement)
280
- # Some parameter documentations has been truncated, see
281
- # {Orb::Models::Customers::Credits::LedgerListResponse::Decrement} for more
282
- # details.
283
- #
284
- # @param id [String]
285
- #
286
- # @param amount [Float]
287
- #
288
- # @param created_at [Time]
289
- #
290
- # @param credit_block [Orb::Models::Customers::Credits::LedgerListResponse::Decrement::CreditBlock]
291
- #
292
- # @param currency [String]
293
- #
294
- # @param customer [Orb::Models::Customers::Credits::LedgerListResponse::Decrement::Customer]
295
- #
296
- # @param description [String, nil]
297
- #
298
- # @param ending_balance [Float]
299
- #
300
- # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::Decrement::EntryStatus]
301
- #
302
- # @param ledger_sequence_number [Integer]
303
- #
304
- # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
305
- #
306
- # @param starting_balance [Float]
307
- #
308
- # @param event_id [String, nil]
309
- #
310
- # @param invoice_id [String, nil]
311
- #
312
- # @param price_id [String, nil]
313
- #
314
- # @param entry_type [Symbol, :decrement]
315
-
316
- # @see Orb::Models::Customers::Credits::LedgerListResponse::Decrement#credit_block
317
- class CreditBlock < Orb::Internal::Type::BaseModel
318
- # @!attribute id
319
- #
320
- # @return [String]
321
- required :id, String
322
-
323
- # @!attribute expiry_date
324
- #
325
- # @return [Time, nil]
326
- required :expiry_date, Time, nil?: true
327
-
328
- # @!attribute per_unit_cost_basis
329
- #
330
- # @return [String, nil]
331
- required :per_unit_cost_basis, String, nil?: true
332
-
333
- # @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
334
- # @param id [String]
335
- # @param expiry_date [Time, nil]
336
- # @param per_unit_cost_basis [String, nil]
337
- end
338
-
339
- # @see Orb::Models::Customers::Credits::LedgerListResponse::Decrement#customer
340
- class Customer < Orb::Internal::Type::BaseModel
341
- # @!attribute id
342
- #
343
- # @return [String]
344
- required :id, String
345
-
346
- # @!attribute external_customer_id
347
- #
348
- # @return [String, nil]
349
- required :external_customer_id, String, nil?: true
350
-
351
- # @!method initialize(id:, external_customer_id:)
352
- # @param id [String]
353
- # @param external_customer_id [String, nil]
354
- end
355
-
356
- # @see Orb::Models::Customers::Credits::LedgerListResponse::Decrement#entry_status
357
- module EntryStatus
358
- extend Orb::Internal::Type::Enum
359
-
360
- COMMITTED = :committed
361
- PENDING = :pending
362
-
363
- # @!method self.values
364
- # @return [Array<Symbol>]
365
- end
366
- end
367
-
368
- class ExpirationChange < Orb::Internal::Type::BaseModel
369
- # @!attribute id
370
- #
371
- # @return [String]
372
- required :id, String
373
-
374
- # @!attribute amount
375
- #
376
- # @return [Float]
377
- required :amount, Float
378
-
379
- # @!attribute created_at
380
- #
381
- # @return [Time]
382
- required :created_at, Time
383
-
384
- # @!attribute credit_block
385
- #
386
- # @return [Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChange::CreditBlock]
387
- required :credit_block,
388
- -> { Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChange::CreditBlock }
389
-
390
- # @!attribute currency
391
- #
392
- # @return [String]
393
- required :currency, String
394
-
395
- # @!attribute customer
396
- #
397
- # @return [Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChange::Customer]
398
- required :customer, -> { Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChange::Customer }
399
-
400
- # @!attribute description
401
- #
402
- # @return [String, nil]
403
- required :description, String, nil?: true
404
-
405
- # @!attribute ending_balance
406
- #
407
- # @return [Float]
408
- required :ending_balance, Float
409
-
410
- # @!attribute entry_status
411
- #
412
- # @return [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChange::EntryStatus]
413
- required :entry_status,
414
- enum: -> { Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChange::EntryStatus }
415
-
416
- # @!attribute entry_type
417
- #
418
- # @return [Symbol, :expiration_change]
419
- required :entry_type, const: :expiration_change
420
-
421
- # @!attribute ledger_sequence_number
422
- #
423
- # @return [Integer]
424
- required :ledger_sequence_number, Integer
425
-
426
- # @!attribute metadata
427
- # User specified key-value pairs for the resource. If not present, this defaults
428
- # to an empty dictionary. Individual keys can be removed by setting the value to
429
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
430
- # `null`.
431
- #
432
- # @return [Hash{Symbol=>String}]
433
- required :metadata, Orb::Internal::Type::HashOf[String]
434
-
435
- # @!attribute new_block_expiry_date
436
- #
437
- # @return [Time, nil]
438
- required :new_block_expiry_date, Time, nil?: true
439
-
440
- # @!attribute starting_balance
441
- #
442
- # @return [Float]
443
- required :starting_balance, Float
444
-
445
- # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, new_block_expiry_date:, starting_balance:, entry_type: :expiration_change)
446
- # Some parameter documentations has been truncated, see
447
- # {Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChange} for more
448
- # details.
449
- #
450
- # @param id [String]
451
- #
452
- # @param amount [Float]
453
- #
454
- # @param created_at [Time]
455
- #
456
- # @param credit_block [Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChange::CreditBlock]
457
- #
458
- # @param currency [String]
459
- #
460
- # @param customer [Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChange::Customer]
461
- #
462
- # @param description [String, nil]
463
- #
464
- # @param ending_balance [Float]
465
- #
466
- # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChange::EntryStatus]
467
- #
468
- # @param ledger_sequence_number [Integer]
469
- #
470
- # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
471
- #
472
- # @param new_block_expiry_date [Time, nil]
473
- #
474
- # @param starting_balance [Float]
475
- #
476
- # @param entry_type [Symbol, :expiration_change]
477
-
478
- # @see Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChange#credit_block
479
- class CreditBlock < Orb::Internal::Type::BaseModel
480
- # @!attribute id
481
- #
482
- # @return [String]
483
- required :id, String
484
-
485
- # @!attribute expiry_date
486
- #
487
- # @return [Time, nil]
488
- required :expiry_date, Time, nil?: true
489
-
490
- # @!attribute per_unit_cost_basis
491
- #
492
- # @return [String, nil]
493
- required :per_unit_cost_basis, String, nil?: true
494
-
495
- # @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
496
- # @param id [String]
497
- # @param expiry_date [Time, nil]
498
- # @param per_unit_cost_basis [String, nil]
499
- end
500
-
501
- # @see Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChange#customer
502
- class Customer < Orb::Internal::Type::BaseModel
503
- # @!attribute id
504
- #
505
- # @return [String]
506
- required :id, String
507
-
508
- # @!attribute external_customer_id
509
- #
510
- # @return [String, nil]
511
- required :external_customer_id, String, nil?: true
512
-
513
- # @!method initialize(id:, external_customer_id:)
514
- # @param id [String]
515
- # @param external_customer_id [String, nil]
516
- end
517
-
518
- # @see Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChange#entry_status
519
- module EntryStatus
520
- extend Orb::Internal::Type::Enum
521
-
522
- COMMITTED = :committed
523
- PENDING = :pending
524
-
525
- # @!method self.values
526
- # @return [Array<Symbol>]
527
- end
528
- end
529
-
530
- class CreditBlockExpiry < Orb::Internal::Type::BaseModel
531
- # @!attribute id
532
- #
533
- # @return [String]
534
- required :id, String
535
-
536
- # @!attribute amount
537
- #
538
- # @return [Float]
539
- required :amount, Float
540
-
541
- # @!attribute created_at
542
- #
543
- # @return [Time]
544
- required :created_at, Time
545
-
546
- # @!attribute credit_block
547
- #
548
- # @return [Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiry::CreditBlock]
549
- required :credit_block,
550
- -> { Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiry::CreditBlock }
551
-
552
- # @!attribute currency
553
- #
554
- # @return [String]
555
- required :currency, String
556
-
557
- # @!attribute customer
558
- #
559
- # @return [Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiry::Customer]
560
- required :customer,
561
- -> { Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiry::Customer }
562
-
563
- # @!attribute description
564
- #
565
- # @return [String, nil]
566
- required :description, String, nil?: true
567
-
568
- # @!attribute ending_balance
569
- #
570
- # @return [Float]
571
- required :ending_balance, Float
572
-
573
- # @!attribute entry_status
574
- #
575
- # @return [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiry::EntryStatus]
576
- required :entry_status,
577
- enum: -> { Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiry::EntryStatus }
578
-
579
- # @!attribute entry_type
580
- #
581
- # @return [Symbol, :credit_block_expiry]
582
- required :entry_type, const: :credit_block_expiry
583
-
584
- # @!attribute ledger_sequence_number
585
- #
586
- # @return [Integer]
587
- required :ledger_sequence_number, Integer
588
-
589
- # @!attribute metadata
590
- # User specified key-value pairs for the resource. If not present, this defaults
591
- # to an empty dictionary. Individual keys can be removed by setting the value to
592
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
593
- # `null`.
594
- #
595
- # @return [Hash{Symbol=>String}]
596
- required :metadata, Orb::Internal::Type::HashOf[String]
597
-
598
- # @!attribute starting_balance
599
- #
600
- # @return [Float]
601
- required :starting_balance, Float
602
-
603
- # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :credit_block_expiry)
604
- # Some parameter documentations has been truncated, see
605
- # {Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiry} for
606
- # more details.
607
- #
608
- # @param id [String]
609
- #
610
- # @param amount [Float]
611
- #
612
- # @param created_at [Time]
613
- #
614
- # @param credit_block [Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiry::CreditBlock]
615
- #
616
- # @param currency [String]
617
- #
618
- # @param customer [Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiry::Customer]
619
- #
620
- # @param description [String, nil]
621
- #
622
- # @param ending_balance [Float]
623
- #
624
- # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiry::EntryStatus]
625
- #
626
- # @param ledger_sequence_number [Integer]
627
- #
628
- # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
629
- #
630
- # @param starting_balance [Float]
631
- #
632
- # @param entry_type [Symbol, :credit_block_expiry]
633
-
634
- # @see Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiry#credit_block
635
- class CreditBlock < Orb::Internal::Type::BaseModel
636
- # @!attribute id
637
- #
638
- # @return [String]
639
- required :id, String
640
-
641
- # @!attribute expiry_date
642
- #
643
- # @return [Time, nil]
644
- required :expiry_date, Time, nil?: true
645
-
646
- # @!attribute per_unit_cost_basis
647
- #
648
- # @return [String, nil]
649
- required :per_unit_cost_basis, String, nil?: true
650
-
651
- # @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
652
- # @param id [String]
653
- # @param expiry_date [Time, nil]
654
- # @param per_unit_cost_basis [String, nil]
655
- end
656
-
657
- # @see Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiry#customer
658
- class Customer < Orb::Internal::Type::BaseModel
659
- # @!attribute id
660
- #
661
- # @return [String]
662
- required :id, String
663
-
664
- # @!attribute external_customer_id
665
- #
666
- # @return [String, nil]
667
- required :external_customer_id, String, nil?: true
668
-
669
- # @!method initialize(id:, external_customer_id:)
670
- # @param id [String]
671
- # @param external_customer_id [String, nil]
672
- end
673
-
674
- # @see Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiry#entry_status
675
- module EntryStatus
676
- extend Orb::Internal::Type::Enum
677
-
678
- COMMITTED = :committed
679
- PENDING = :pending
680
-
681
- # @!method self.values
682
- # @return [Array<Symbol>]
683
- end
684
- end
685
-
686
- class Void < Orb::Internal::Type::BaseModel
687
- # @!attribute id
688
- #
689
- # @return [String]
690
- required :id, String
691
-
692
- # @!attribute amount
693
- #
694
- # @return [Float]
695
- required :amount, Float
696
-
697
- # @!attribute created_at
698
- #
699
- # @return [Time]
700
- required :created_at, Time
701
-
702
- # @!attribute credit_block
703
- #
704
- # @return [Orb::Models::Customers::Credits::LedgerListResponse::Void::CreditBlock]
705
- required :credit_block, -> { Orb::Models::Customers::Credits::LedgerListResponse::Void::CreditBlock }
706
-
707
- # @!attribute currency
708
- #
709
- # @return [String]
710
- required :currency, String
711
-
712
- # @!attribute customer
713
- #
714
- # @return [Orb::Models::Customers::Credits::LedgerListResponse::Void::Customer]
715
- required :customer, -> { Orb::Models::Customers::Credits::LedgerListResponse::Void::Customer }
716
-
717
- # @!attribute description
718
- #
719
- # @return [String, nil]
720
- required :description, String, nil?: true
721
-
722
- # @!attribute ending_balance
723
- #
724
- # @return [Float]
725
- required :ending_balance, Float
726
-
727
- # @!attribute entry_status
728
- #
729
- # @return [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::Void::EntryStatus]
730
- required :entry_status,
731
- enum: -> { Orb::Models::Customers::Credits::LedgerListResponse::Void::EntryStatus }
732
-
733
- # @!attribute entry_type
734
- #
735
- # @return [Symbol, :void]
736
- required :entry_type, const: :void
737
-
738
- # @!attribute ledger_sequence_number
739
- #
740
- # @return [Integer]
741
- required :ledger_sequence_number, Integer
742
-
743
- # @!attribute metadata
744
- # User specified key-value pairs for the resource. If not present, this defaults
745
- # to an empty dictionary. Individual keys can be removed by setting the value to
746
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
747
- # `null`.
748
- #
749
- # @return [Hash{Symbol=>String}]
750
- required :metadata, Orb::Internal::Type::HashOf[String]
751
-
752
- # @!attribute starting_balance
753
- #
754
- # @return [Float]
755
- required :starting_balance, Float
756
-
757
- # @!attribute void_amount
758
- #
759
- # @return [Float]
760
- required :void_amount, Float
761
-
762
- # @!attribute void_reason
763
- #
764
- # @return [String, nil]
765
- required :void_reason, String, nil?: true
766
-
767
- # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, void_amount:, void_reason:, entry_type: :void)
768
- # Some parameter documentations has been truncated, see
769
- # {Orb::Models::Customers::Credits::LedgerListResponse::Void} for more details.
770
- #
771
- # @param id [String]
772
- #
773
- # @param amount [Float]
774
- #
775
- # @param created_at [Time]
776
- #
777
- # @param credit_block [Orb::Models::Customers::Credits::LedgerListResponse::Void::CreditBlock]
778
- #
779
- # @param currency [String]
780
- #
781
- # @param customer [Orb::Models::Customers::Credits::LedgerListResponse::Void::Customer]
782
- #
783
- # @param description [String, nil]
784
- #
785
- # @param ending_balance [Float]
786
- #
787
- # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::Void::EntryStatus]
788
- #
789
- # @param ledger_sequence_number [Integer]
790
- #
791
- # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
792
- #
793
- # @param starting_balance [Float]
794
- #
795
- # @param void_amount [Float]
796
- #
797
- # @param void_reason [String, nil]
798
- #
799
- # @param entry_type [Symbol, :void]
800
-
801
- # @see Orb::Models::Customers::Credits::LedgerListResponse::Void#credit_block
802
- class CreditBlock < Orb::Internal::Type::BaseModel
803
- # @!attribute id
804
- #
805
- # @return [String]
806
- required :id, String
807
-
808
- # @!attribute expiry_date
809
- #
810
- # @return [Time, nil]
811
- required :expiry_date, Time, nil?: true
812
-
813
- # @!attribute per_unit_cost_basis
814
- #
815
- # @return [String, nil]
816
- required :per_unit_cost_basis, String, nil?: true
817
-
818
- # @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
819
- # @param id [String]
820
- # @param expiry_date [Time, nil]
821
- # @param per_unit_cost_basis [String, nil]
822
- end
823
-
824
- # @see Orb::Models::Customers::Credits::LedgerListResponse::Void#customer
825
- class Customer < Orb::Internal::Type::BaseModel
826
- # @!attribute id
827
- #
828
- # @return [String]
829
- required :id, String
830
-
831
- # @!attribute external_customer_id
832
- #
833
- # @return [String, nil]
834
- required :external_customer_id, String, nil?: true
835
-
836
- # @!method initialize(id:, external_customer_id:)
837
- # @param id [String]
838
- # @param external_customer_id [String, nil]
839
- end
840
-
841
- # @see Orb::Models::Customers::Credits::LedgerListResponse::Void#entry_status
842
- module EntryStatus
843
- extend Orb::Internal::Type::Enum
844
-
845
- COMMITTED = :committed
846
- PENDING = :pending
847
-
848
- # @!method self.values
849
- # @return [Array<Symbol>]
850
- end
851
- end
852
-
853
- class VoidInitiated < Orb::Internal::Type::BaseModel
854
- # @!attribute id
855
- #
856
- # @return [String]
857
- required :id, String
858
-
859
- # @!attribute amount
860
- #
861
- # @return [Float]
862
- required :amount, Float
863
-
864
- # @!attribute created_at
865
- #
866
- # @return [Time]
867
- required :created_at, Time
868
-
869
- # @!attribute credit_block
870
- #
871
- # @return [Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiated::CreditBlock]
872
- required :credit_block,
873
- -> { Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiated::CreditBlock }
874
-
875
- # @!attribute currency
876
- #
877
- # @return [String]
878
- required :currency, String
879
-
880
- # @!attribute customer
881
- #
882
- # @return [Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiated::Customer]
883
- required :customer, -> { Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiated::Customer }
884
-
885
- # @!attribute description
886
- #
887
- # @return [String, nil]
888
- required :description, String, nil?: true
889
-
890
- # @!attribute ending_balance
891
- #
892
- # @return [Float]
893
- required :ending_balance, Float
894
-
895
- # @!attribute entry_status
896
- #
897
- # @return [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiated::EntryStatus]
898
- required :entry_status,
899
- enum: -> { Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiated::EntryStatus }
900
-
901
- # @!attribute entry_type
902
- #
903
- # @return [Symbol, :void_initiated]
904
- required :entry_type, const: :void_initiated
905
-
906
- # @!attribute ledger_sequence_number
907
- #
908
- # @return [Integer]
909
- required :ledger_sequence_number, Integer
910
-
911
- # @!attribute metadata
912
- # User specified key-value pairs for the resource. If not present, this defaults
913
- # to an empty dictionary. Individual keys can be removed by setting the value to
914
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
915
- # `null`.
916
- #
917
- # @return [Hash{Symbol=>String}]
918
- required :metadata, Orb::Internal::Type::HashOf[String]
919
-
920
- # @!attribute new_block_expiry_date
921
- #
922
- # @return [Time]
923
- required :new_block_expiry_date, Time
924
-
925
- # @!attribute starting_balance
926
- #
927
- # @return [Float]
928
- required :starting_balance, Float
929
-
930
- # @!attribute void_amount
931
- #
932
- # @return [Float]
933
- required :void_amount, Float
934
-
935
- # @!attribute void_reason
936
- #
937
- # @return [String, nil]
938
- required :void_reason, String, nil?: true
939
-
940
- # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, new_block_expiry_date:, starting_balance:, void_amount:, void_reason:, entry_type: :void_initiated)
941
- # Some parameter documentations has been truncated, see
942
- # {Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiated} for more
943
- # details.
944
- #
945
- # @param id [String]
946
- #
947
- # @param amount [Float]
948
- #
949
- # @param created_at [Time]
950
- #
951
- # @param credit_block [Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiated::CreditBlock]
952
- #
953
- # @param currency [String]
954
- #
955
- # @param customer [Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiated::Customer]
956
- #
957
- # @param description [String, nil]
958
- #
959
- # @param ending_balance [Float]
960
- #
961
- # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiated::EntryStatus]
962
- #
963
- # @param ledger_sequence_number [Integer]
964
- #
965
- # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
966
- #
967
- # @param new_block_expiry_date [Time]
968
- #
969
- # @param starting_balance [Float]
970
- #
971
- # @param void_amount [Float]
972
- #
973
- # @param void_reason [String, nil]
974
- #
975
- # @param entry_type [Symbol, :void_initiated]
976
-
977
- # @see Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiated#credit_block
978
- class CreditBlock < Orb::Internal::Type::BaseModel
979
- # @!attribute id
980
- #
981
- # @return [String]
982
- required :id, String
983
-
984
- # @!attribute expiry_date
985
- #
986
- # @return [Time, nil]
987
- required :expiry_date, Time, nil?: true
988
-
989
- # @!attribute per_unit_cost_basis
990
- #
991
- # @return [String, nil]
992
- required :per_unit_cost_basis, String, nil?: true
993
-
994
- # @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
995
- # @param id [String]
996
- # @param expiry_date [Time, nil]
997
- # @param per_unit_cost_basis [String, nil]
998
- end
999
-
1000
- # @see Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiated#customer
1001
- class Customer < Orb::Internal::Type::BaseModel
1002
- # @!attribute id
1003
- #
1004
- # @return [String]
1005
- required :id, String
1006
-
1007
- # @!attribute external_customer_id
1008
- #
1009
- # @return [String, nil]
1010
- required :external_customer_id, String, nil?: true
1011
-
1012
- # @!method initialize(id:, external_customer_id:)
1013
- # @param id [String]
1014
- # @param external_customer_id [String, nil]
1015
- end
1016
-
1017
- # @see Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiated#entry_status
1018
- module EntryStatus
1019
- extend Orb::Internal::Type::Enum
1020
-
1021
- COMMITTED = :committed
1022
- PENDING = :pending
1023
-
1024
- # @!method self.values
1025
- # @return [Array<Symbol>]
1026
- end
1027
- end
1028
-
1029
- class Amendment < Orb::Internal::Type::BaseModel
1030
- # @!attribute id
1031
- #
1032
- # @return [String]
1033
- required :id, String
1034
-
1035
- # @!attribute amount
1036
- #
1037
- # @return [Float]
1038
- required :amount, Float
1039
-
1040
- # @!attribute created_at
1041
- #
1042
- # @return [Time]
1043
- required :created_at, Time
1044
-
1045
- # @!attribute credit_block
1046
- #
1047
- # @return [Orb::Models::Customers::Credits::LedgerListResponse::Amendment::CreditBlock]
1048
- required :credit_block, -> { Orb::Models::Customers::Credits::LedgerListResponse::Amendment::CreditBlock }
1049
-
1050
- # @!attribute currency
1051
- #
1052
- # @return [String]
1053
- required :currency, String
1054
-
1055
- # @!attribute customer
1056
- #
1057
- # @return [Orb::Models::Customers::Credits::LedgerListResponse::Amendment::Customer]
1058
- required :customer, -> { Orb::Models::Customers::Credits::LedgerListResponse::Amendment::Customer }
1059
-
1060
- # @!attribute description
1061
- #
1062
- # @return [String, nil]
1063
- required :description, String, nil?: true
1064
-
1065
- # @!attribute ending_balance
1066
- #
1067
- # @return [Float]
1068
- required :ending_balance, Float
1069
-
1070
- # @!attribute entry_status
1071
- #
1072
- # @return [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::Amendment::EntryStatus]
1073
- required :entry_status,
1074
- enum: -> { Orb::Models::Customers::Credits::LedgerListResponse::Amendment::EntryStatus }
1075
-
1076
- # @!attribute entry_type
1077
- #
1078
- # @return [Symbol, :amendment]
1079
- required :entry_type, const: :amendment
1080
-
1081
- # @!attribute ledger_sequence_number
1082
- #
1083
- # @return [Integer]
1084
- required :ledger_sequence_number, Integer
1085
-
1086
- # @!attribute metadata
1087
- # User specified key-value pairs for the resource. If not present, this defaults
1088
- # to an empty dictionary. Individual keys can be removed by setting the value to
1089
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
1090
- # `null`.
1091
- #
1092
- # @return [Hash{Symbol=>String}]
1093
- required :metadata, Orb::Internal::Type::HashOf[String]
1094
-
1095
- # @!attribute starting_balance
1096
- #
1097
- # @return [Float]
1098
- required :starting_balance, Float
1099
-
1100
- # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :amendment)
1101
- # Some parameter documentations has been truncated, see
1102
- # {Orb::Models::Customers::Credits::LedgerListResponse::Amendment} for more
1103
- # details.
1104
- #
1105
- # @param id [String]
1106
- #
1107
- # @param amount [Float]
1108
- #
1109
- # @param created_at [Time]
1110
- #
1111
- # @param credit_block [Orb::Models::Customers::Credits::LedgerListResponse::Amendment::CreditBlock]
1112
- #
1113
- # @param currency [String]
1114
- #
1115
- # @param customer [Orb::Models::Customers::Credits::LedgerListResponse::Amendment::Customer]
1116
- #
1117
- # @param description [String, nil]
1118
- #
1119
- # @param ending_balance [Float]
1120
- #
1121
- # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::Amendment::EntryStatus]
1122
- #
1123
- # @param ledger_sequence_number [Integer]
1124
- #
1125
- # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
1126
- #
1127
- # @param starting_balance [Float]
1128
- #
1129
- # @param entry_type [Symbol, :amendment]
1130
-
1131
- # @see Orb::Models::Customers::Credits::LedgerListResponse::Amendment#credit_block
1132
- class CreditBlock < Orb::Internal::Type::BaseModel
1133
- # @!attribute id
1134
- #
1135
- # @return [String]
1136
- required :id, String
1137
-
1138
- # @!attribute expiry_date
1139
- #
1140
- # @return [Time, nil]
1141
- required :expiry_date, Time, nil?: true
1142
-
1143
- # @!attribute per_unit_cost_basis
1144
- #
1145
- # @return [String, nil]
1146
- required :per_unit_cost_basis, String, nil?: true
1147
-
1148
- # @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
1149
- # @param id [String]
1150
- # @param expiry_date [Time, nil]
1151
- # @param per_unit_cost_basis [String, nil]
1152
- end
1153
-
1154
- # @see Orb::Models::Customers::Credits::LedgerListResponse::Amendment#customer
1155
- class Customer < Orb::Internal::Type::BaseModel
1156
- # @!attribute id
1157
- #
1158
- # @return [String]
1159
- required :id, String
1160
-
1161
- # @!attribute external_customer_id
1162
- #
1163
- # @return [String, nil]
1164
- required :external_customer_id, String, nil?: true
1165
-
1166
- # @!method initialize(id:, external_customer_id:)
1167
- # @param id [String]
1168
- # @param external_customer_id [String, nil]
1169
- end
1170
-
1171
- # @see Orb::Models::Customers::Credits::LedgerListResponse::Amendment#entry_status
1172
- module EntryStatus
1173
- extend Orb::Internal::Type::Enum
1174
-
1175
- COMMITTED = :committed
1176
- PENDING = :pending
1177
-
1178
- # @!method self.values
1179
- # @return [Array<Symbol>]
1180
- end
1181
- end
28
+ variant :amendment, -> { Orb::Customers::Credits::AmendmentLedgerEntry }
1182
29
 
1183
30
  # @!method self.variants
1184
- # @return [Array(Orb::Models::Customers::Credits::LedgerListResponse::Increment, Orb::Models::Customers::Credits::LedgerListResponse::Decrement, Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChange, Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiry, Orb::Models::Customers::Credits::LedgerListResponse::Void, Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiated, Orb::Models::Customers::Credits::LedgerListResponse::Amendment)]
31
+ # @return [Array(Orb::Models::Customers::Credits::IncrementLedgerEntry, Orb::Models::Customers::Credits::DecrementLedgerEntry, Orb::Models::Customers::Credits::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::VoidLedgerEntry, Orb::Models::Customers::Credits::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::AmendmentLedgerEntry)]
1185
32
  end
1186
33
  end
1187
34
  end