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,1183 +13,22 @@ module Orb
13
13
 
14
14
  discriminator :entry_type
15
15
 
16
- variant :increment, -> { Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Increment }
16
+ variant :increment, -> { Orb::Customers::Credits::IncrementLedgerEntry }
17
17
 
18
- variant :decrement, -> { Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Decrement }
18
+ variant :decrement, -> { Orb::Customers::Credits::DecrementLedgerEntry }
19
19
 
20
- variant :expiration_change,
21
- -> { Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChange }
20
+ variant :expiration_change, -> { Orb::Customers::Credits::ExpirationChangeLedgerEntry }
22
21
 
23
- variant :credit_block_expiry,
24
- -> { Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiry }
22
+ variant :credit_block_expiry, -> { Orb::Customers::Credits::CreditBlockExpiryLedgerEntry }
25
23
 
26
- variant :void, -> { Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Void }
24
+ variant :void, -> { Orb::Customers::Credits::VoidLedgerEntry }
27
25
 
28
- variant :void_initiated, -> { Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiated }
26
+ variant :void_initiated, -> { Orb::Customers::Credits::VoidInitiatedLedgerEntry }
29
27
 
30
- variant :amendment, -> { Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Amendment }
31
-
32
- class Increment < Orb::Internal::Type::BaseModel
33
- # @!attribute id
34
- #
35
- # @return [String]
36
- required :id, String
37
-
38
- # @!attribute amount
39
- #
40
- # @return [Float]
41
- required :amount, Float
42
-
43
- # @!attribute created_at
44
- #
45
- # @return [Time]
46
- required :created_at, Time
47
-
48
- # @!attribute credit_block
49
- #
50
- # @return [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Increment::CreditBlock]
51
- required :credit_block,
52
- -> { Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Increment::CreditBlock }
53
-
54
- # @!attribute currency
55
- #
56
- # @return [String]
57
- required :currency, String
58
-
59
- # @!attribute customer
60
- #
61
- # @return [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Increment::Customer]
62
- required :customer, -> { Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Increment::Customer }
63
-
64
- # @!attribute description
65
- #
66
- # @return [String, nil]
67
- required :description, String, nil?: true
68
-
69
- # @!attribute ending_balance
70
- #
71
- # @return [Float]
72
- required :ending_balance, Float
73
-
74
- # @!attribute entry_status
75
- #
76
- # @return [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Increment::EntryStatus]
77
- required :entry_status,
78
- enum: -> { Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Increment::EntryStatus }
79
-
80
- # @!attribute entry_type
81
- #
82
- # @return [Symbol, :increment]
83
- required :entry_type, const: :increment
84
-
85
- # @!attribute ledger_sequence_number
86
- #
87
- # @return [Integer]
88
- required :ledger_sequence_number, Integer
89
-
90
- # @!attribute metadata
91
- # User specified key-value pairs for the resource. If not present, this defaults
92
- # to an empty dictionary. Individual keys can be removed by setting the value to
93
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
94
- # `null`.
95
- #
96
- # @return [Hash{Symbol=>String}]
97
- required :metadata, Orb::Internal::Type::HashOf[String]
98
-
99
- # @!attribute starting_balance
100
- #
101
- # @return [Float]
102
- required :starting_balance, Float
103
-
104
- # @!attribute created_invoices
105
- # If the increment resulted in invoice creation, the list of created invoices
106
- #
107
- # @return [Array<Orb::Models::Invoice>, nil]
108
- optional :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }, nil?: true
109
-
110
- # @!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)
111
- # Some parameter documentations has been truncated, see
112
- # {Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Increment} for more
113
- # details.
114
- #
115
- # @param id [String]
116
- #
117
- # @param amount [Float]
118
- #
119
- # @param created_at [Time]
120
- #
121
- # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Increment::CreditBlock]
122
- #
123
- # @param currency [String]
124
- #
125
- # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Increment::Customer]
126
- #
127
- # @param description [String, nil]
128
- #
129
- # @param ending_balance [Float]
130
- #
131
- # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Increment::EntryStatus]
132
- #
133
- # @param ledger_sequence_number [Integer]
134
- #
135
- # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
136
- #
137
- # @param starting_balance [Float]
138
- #
139
- # @param created_invoices [Array<Orb::Models::Invoice>, nil] If the increment resulted in invoice creation, the list of created invoices
140
- #
141
- # @param entry_type [Symbol, :increment]
142
-
143
- # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Increment#credit_block
144
- class CreditBlock < Orb::Internal::Type::BaseModel
145
- # @!attribute id
146
- #
147
- # @return [String]
148
- required :id, String
149
-
150
- # @!attribute expiry_date
151
- #
152
- # @return [Time, nil]
153
- required :expiry_date, Time, nil?: true
154
-
155
- # @!attribute per_unit_cost_basis
156
- #
157
- # @return [String, nil]
158
- required :per_unit_cost_basis, String, nil?: true
159
-
160
- # @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
161
- # @param id [String]
162
- # @param expiry_date [Time, nil]
163
- # @param per_unit_cost_basis [String, nil]
164
- end
165
-
166
- # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Increment#customer
167
- class Customer < Orb::Internal::Type::BaseModel
168
- # @!attribute id
169
- #
170
- # @return [String]
171
- required :id, String
172
-
173
- # @!attribute external_customer_id
174
- #
175
- # @return [String, nil]
176
- required :external_customer_id, String, nil?: true
177
-
178
- # @!method initialize(id:, external_customer_id:)
179
- # @param id [String]
180
- # @param external_customer_id [String, nil]
181
- end
182
-
183
- # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Increment#entry_status
184
- module EntryStatus
185
- extend Orb::Internal::Type::Enum
186
-
187
- COMMITTED = :committed
188
- PENDING = :pending
189
-
190
- # @!method self.values
191
- # @return [Array<Symbol>]
192
- end
193
- end
194
-
195
- class Decrement < Orb::Internal::Type::BaseModel
196
- # @!attribute id
197
- #
198
- # @return [String]
199
- required :id, String
200
-
201
- # @!attribute amount
202
- #
203
- # @return [Float]
204
- required :amount, Float
205
-
206
- # @!attribute created_at
207
- #
208
- # @return [Time]
209
- required :created_at, Time
210
-
211
- # @!attribute credit_block
212
- #
213
- # @return [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Decrement::CreditBlock]
214
- required :credit_block,
215
- -> { Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Decrement::CreditBlock }
216
-
217
- # @!attribute currency
218
- #
219
- # @return [String]
220
- required :currency, String
221
-
222
- # @!attribute customer
223
- #
224
- # @return [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Decrement::Customer]
225
- required :customer, -> { Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Decrement::Customer }
226
-
227
- # @!attribute description
228
- #
229
- # @return [String, nil]
230
- required :description, String, nil?: true
231
-
232
- # @!attribute ending_balance
233
- #
234
- # @return [Float]
235
- required :ending_balance, Float
236
-
237
- # @!attribute entry_status
238
- #
239
- # @return [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Decrement::EntryStatus]
240
- required :entry_status,
241
- enum: -> { Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Decrement::EntryStatus }
242
-
243
- # @!attribute entry_type
244
- #
245
- # @return [Symbol, :decrement]
246
- required :entry_type, const: :decrement
247
-
248
- # @!attribute ledger_sequence_number
249
- #
250
- # @return [Integer]
251
- required :ledger_sequence_number, Integer
252
-
253
- # @!attribute metadata
254
- # User specified key-value pairs for the resource. If not present, this defaults
255
- # to an empty dictionary. Individual keys can be removed by setting the value to
256
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
257
- # `null`.
258
- #
259
- # @return [Hash{Symbol=>String}]
260
- required :metadata, Orb::Internal::Type::HashOf[String]
261
-
262
- # @!attribute starting_balance
263
- #
264
- # @return [Float]
265
- required :starting_balance, Float
266
-
267
- # @!attribute event_id
268
- #
269
- # @return [String, nil]
270
- optional :event_id, String, nil?: true
271
-
272
- # @!attribute invoice_id
273
- #
274
- # @return [String, nil]
275
- optional :invoice_id, String, nil?: true
276
-
277
- # @!attribute price_id
278
- #
279
- # @return [String, nil]
280
- optional :price_id, String, nil?: true
281
-
282
- # @!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)
283
- # Some parameter documentations has been truncated, see
284
- # {Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Decrement} for more
285
- # details.
286
- #
287
- # @param id [String]
288
- #
289
- # @param amount [Float]
290
- #
291
- # @param created_at [Time]
292
- #
293
- # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Decrement::CreditBlock]
294
- #
295
- # @param currency [String]
296
- #
297
- # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Decrement::Customer]
298
- #
299
- # @param description [String, nil]
300
- #
301
- # @param ending_balance [Float]
302
- #
303
- # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Decrement::EntryStatus]
304
- #
305
- # @param ledger_sequence_number [Integer]
306
- #
307
- # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
308
- #
309
- # @param starting_balance [Float]
310
- #
311
- # @param event_id [String, nil]
312
- #
313
- # @param invoice_id [String, nil]
314
- #
315
- # @param price_id [String, nil]
316
- #
317
- # @param entry_type [Symbol, :decrement]
318
-
319
- # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Decrement#credit_block
320
- class CreditBlock < Orb::Internal::Type::BaseModel
321
- # @!attribute id
322
- #
323
- # @return [String]
324
- required :id, String
325
-
326
- # @!attribute expiry_date
327
- #
328
- # @return [Time, nil]
329
- required :expiry_date, Time, nil?: true
330
-
331
- # @!attribute per_unit_cost_basis
332
- #
333
- # @return [String, nil]
334
- required :per_unit_cost_basis, String, nil?: true
335
-
336
- # @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
337
- # @param id [String]
338
- # @param expiry_date [Time, nil]
339
- # @param per_unit_cost_basis [String, nil]
340
- end
341
-
342
- # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Decrement#customer
343
- class Customer < Orb::Internal::Type::BaseModel
344
- # @!attribute id
345
- #
346
- # @return [String]
347
- required :id, String
348
-
349
- # @!attribute external_customer_id
350
- #
351
- # @return [String, nil]
352
- required :external_customer_id, String, nil?: true
353
-
354
- # @!method initialize(id:, external_customer_id:)
355
- # @param id [String]
356
- # @param external_customer_id [String, nil]
357
- end
358
-
359
- # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Decrement#entry_status
360
- module EntryStatus
361
- extend Orb::Internal::Type::Enum
362
-
363
- COMMITTED = :committed
364
- PENDING = :pending
365
-
366
- # @!method self.values
367
- # @return [Array<Symbol>]
368
- end
369
- end
370
-
371
- class ExpirationChange < Orb::Internal::Type::BaseModel
372
- # @!attribute id
373
- #
374
- # @return [String]
375
- required :id, String
376
-
377
- # @!attribute amount
378
- #
379
- # @return [Float]
380
- required :amount, Float
381
-
382
- # @!attribute created_at
383
- #
384
- # @return [Time]
385
- required :created_at, Time
386
-
387
- # @!attribute credit_block
388
- #
389
- # @return [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChange::CreditBlock]
390
- required :credit_block,
391
- -> { Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChange::CreditBlock }
392
-
393
- # @!attribute currency
394
- #
395
- # @return [String]
396
- required :currency, String
397
-
398
- # @!attribute customer
399
- #
400
- # @return [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChange::Customer]
401
- required :customer,
402
- -> { Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChange::Customer }
403
-
404
- # @!attribute description
405
- #
406
- # @return [String, nil]
407
- required :description, String, nil?: true
408
-
409
- # @!attribute ending_balance
410
- #
411
- # @return [Float]
412
- required :ending_balance, Float
413
-
414
- # @!attribute entry_status
415
- #
416
- # @return [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChange::EntryStatus]
417
- required :entry_status,
418
- enum: -> { Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChange::EntryStatus }
419
-
420
- # @!attribute entry_type
421
- #
422
- # @return [Symbol, :expiration_change]
423
- required :entry_type, const: :expiration_change
424
-
425
- # @!attribute ledger_sequence_number
426
- #
427
- # @return [Integer]
428
- required :ledger_sequence_number, Integer
429
-
430
- # @!attribute metadata
431
- # User specified key-value pairs for the resource. If not present, this defaults
432
- # to an empty dictionary. Individual keys can be removed by setting the value to
433
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
434
- # `null`.
435
- #
436
- # @return [Hash{Symbol=>String}]
437
- required :metadata, Orb::Internal::Type::HashOf[String]
438
-
439
- # @!attribute new_block_expiry_date
440
- #
441
- # @return [Time, nil]
442
- required :new_block_expiry_date, Time, nil?: true
443
-
444
- # @!attribute starting_balance
445
- #
446
- # @return [Float]
447
- required :starting_balance, Float
448
-
449
- # @!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)
450
- # Some parameter documentations has been truncated, see
451
- # {Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChange}
452
- # for more details.
453
- #
454
- # @param id [String]
455
- #
456
- # @param amount [Float]
457
- #
458
- # @param created_at [Time]
459
- #
460
- # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChange::CreditBlock]
461
- #
462
- # @param currency [String]
463
- #
464
- # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChange::Customer]
465
- #
466
- # @param description [String, nil]
467
- #
468
- # @param ending_balance [Float]
469
- #
470
- # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChange::EntryStatus]
471
- #
472
- # @param ledger_sequence_number [Integer]
473
- #
474
- # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
475
- #
476
- # @param new_block_expiry_date [Time, nil]
477
- #
478
- # @param starting_balance [Float]
479
- #
480
- # @param entry_type [Symbol, :expiration_change]
481
-
482
- # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChange#credit_block
483
- class CreditBlock < Orb::Internal::Type::BaseModel
484
- # @!attribute id
485
- #
486
- # @return [String]
487
- required :id, String
488
-
489
- # @!attribute expiry_date
490
- #
491
- # @return [Time, nil]
492
- required :expiry_date, Time, nil?: true
493
-
494
- # @!attribute per_unit_cost_basis
495
- #
496
- # @return [String, nil]
497
- required :per_unit_cost_basis, String, nil?: true
498
-
499
- # @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
500
- # @param id [String]
501
- # @param expiry_date [Time, nil]
502
- # @param per_unit_cost_basis [String, nil]
503
- end
504
-
505
- # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChange#customer
506
- class Customer < Orb::Internal::Type::BaseModel
507
- # @!attribute id
508
- #
509
- # @return [String]
510
- required :id, String
511
-
512
- # @!attribute external_customer_id
513
- #
514
- # @return [String, nil]
515
- required :external_customer_id, String, nil?: true
516
-
517
- # @!method initialize(id:, external_customer_id:)
518
- # @param id [String]
519
- # @param external_customer_id [String, nil]
520
- end
521
-
522
- # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChange#entry_status
523
- module EntryStatus
524
- extend Orb::Internal::Type::Enum
525
-
526
- COMMITTED = :committed
527
- PENDING = :pending
528
-
529
- # @!method self.values
530
- # @return [Array<Symbol>]
531
- end
532
- end
533
-
534
- class CreditBlockExpiry < Orb::Internal::Type::BaseModel
535
- # @!attribute id
536
- #
537
- # @return [String]
538
- required :id, String
539
-
540
- # @!attribute amount
541
- #
542
- # @return [Float]
543
- required :amount, Float
544
-
545
- # @!attribute created_at
546
- #
547
- # @return [Time]
548
- required :created_at, Time
549
-
550
- # @!attribute credit_block
551
- #
552
- # @return [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiry::CreditBlock]
553
- required :credit_block,
554
- -> { Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiry::CreditBlock }
555
-
556
- # @!attribute currency
557
- #
558
- # @return [String]
559
- required :currency, String
560
-
561
- # @!attribute customer
562
- #
563
- # @return [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiry::Customer]
564
- required :customer,
565
- -> { Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiry::Customer }
566
-
567
- # @!attribute description
568
- #
569
- # @return [String, nil]
570
- required :description, String, nil?: true
571
-
572
- # @!attribute ending_balance
573
- #
574
- # @return [Float]
575
- required :ending_balance, Float
576
-
577
- # @!attribute entry_status
578
- #
579
- # @return [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiry::EntryStatus]
580
- required :entry_status,
581
- enum: -> { Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiry::EntryStatus }
582
-
583
- # @!attribute entry_type
584
- #
585
- # @return [Symbol, :credit_block_expiry]
586
- required :entry_type, const: :credit_block_expiry
587
-
588
- # @!attribute ledger_sequence_number
589
- #
590
- # @return [Integer]
591
- required :ledger_sequence_number, Integer
592
-
593
- # @!attribute metadata
594
- # User specified key-value pairs for the resource. If not present, this defaults
595
- # to an empty dictionary. Individual keys can be removed by setting the value to
596
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
597
- # `null`.
598
- #
599
- # @return [Hash{Symbol=>String}]
600
- required :metadata, Orb::Internal::Type::HashOf[String]
601
-
602
- # @!attribute starting_balance
603
- #
604
- # @return [Float]
605
- required :starting_balance, Float
606
-
607
- # @!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)
608
- # Some parameter documentations has been truncated, see
609
- # {Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiry}
610
- # for more details.
611
- #
612
- # @param id [String]
613
- #
614
- # @param amount [Float]
615
- #
616
- # @param created_at [Time]
617
- #
618
- # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiry::CreditBlock]
619
- #
620
- # @param currency [String]
621
- #
622
- # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiry::Customer]
623
- #
624
- # @param description [String, nil]
625
- #
626
- # @param ending_balance [Float]
627
- #
628
- # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiry::EntryStatus]
629
- #
630
- # @param ledger_sequence_number [Integer]
631
- #
632
- # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
633
- #
634
- # @param starting_balance [Float]
635
- #
636
- # @param entry_type [Symbol, :credit_block_expiry]
637
-
638
- # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiry#credit_block
639
- class CreditBlock < Orb::Internal::Type::BaseModel
640
- # @!attribute id
641
- #
642
- # @return [String]
643
- required :id, String
644
-
645
- # @!attribute expiry_date
646
- #
647
- # @return [Time, nil]
648
- required :expiry_date, Time, nil?: true
649
-
650
- # @!attribute per_unit_cost_basis
651
- #
652
- # @return [String, nil]
653
- required :per_unit_cost_basis, String, nil?: true
654
-
655
- # @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
656
- # @param id [String]
657
- # @param expiry_date [Time, nil]
658
- # @param per_unit_cost_basis [String, nil]
659
- end
660
-
661
- # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiry#customer
662
- class Customer < Orb::Internal::Type::BaseModel
663
- # @!attribute id
664
- #
665
- # @return [String]
666
- required :id, String
667
-
668
- # @!attribute external_customer_id
669
- #
670
- # @return [String, nil]
671
- required :external_customer_id, String, nil?: true
672
-
673
- # @!method initialize(id:, external_customer_id:)
674
- # @param id [String]
675
- # @param external_customer_id [String, nil]
676
- end
677
-
678
- # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiry#entry_status
679
- module EntryStatus
680
- extend Orb::Internal::Type::Enum
681
-
682
- COMMITTED = :committed
683
- PENDING = :pending
684
-
685
- # @!method self.values
686
- # @return [Array<Symbol>]
687
- end
688
- end
689
-
690
- class Void < Orb::Internal::Type::BaseModel
691
- # @!attribute id
692
- #
693
- # @return [String]
694
- required :id, String
695
-
696
- # @!attribute amount
697
- #
698
- # @return [Float]
699
- required :amount, Float
700
-
701
- # @!attribute created_at
702
- #
703
- # @return [Time]
704
- required :created_at, Time
705
-
706
- # @!attribute credit_block
707
- #
708
- # @return [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Void::CreditBlock]
709
- required :credit_block,
710
- -> { Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Void::CreditBlock }
711
-
712
- # @!attribute currency
713
- #
714
- # @return [String]
715
- required :currency, String
716
-
717
- # @!attribute customer
718
- #
719
- # @return [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Void::Customer]
720
- required :customer, -> { Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Void::Customer }
721
-
722
- # @!attribute description
723
- #
724
- # @return [String, nil]
725
- required :description, String, nil?: true
726
-
727
- # @!attribute ending_balance
728
- #
729
- # @return [Float]
730
- required :ending_balance, Float
731
-
732
- # @!attribute entry_status
733
- #
734
- # @return [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Void::EntryStatus]
735
- required :entry_status,
736
- enum: -> { Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Void::EntryStatus }
737
-
738
- # @!attribute entry_type
739
- #
740
- # @return [Symbol, :void]
741
- required :entry_type, const: :void
742
-
743
- # @!attribute ledger_sequence_number
744
- #
745
- # @return [Integer]
746
- required :ledger_sequence_number, Integer
747
-
748
- # @!attribute metadata
749
- # User specified key-value pairs for the resource. If not present, this defaults
750
- # to an empty dictionary. Individual keys can be removed by setting the value to
751
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
752
- # `null`.
753
- #
754
- # @return [Hash{Symbol=>String}]
755
- required :metadata, Orb::Internal::Type::HashOf[String]
756
-
757
- # @!attribute starting_balance
758
- #
759
- # @return [Float]
760
- required :starting_balance, Float
761
-
762
- # @!attribute void_amount
763
- #
764
- # @return [Float]
765
- required :void_amount, Float
766
-
767
- # @!attribute void_reason
768
- #
769
- # @return [String, nil]
770
- required :void_reason, String, nil?: true
771
-
772
- # @!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)
773
- # Some parameter documentations has been truncated, see
774
- # {Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Void} for more
775
- # details.
776
- #
777
- # @param id [String]
778
- #
779
- # @param amount [Float]
780
- #
781
- # @param created_at [Time]
782
- #
783
- # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Void::CreditBlock]
784
- #
785
- # @param currency [String]
786
- #
787
- # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Void::Customer]
788
- #
789
- # @param description [String, nil]
790
- #
791
- # @param ending_balance [Float]
792
- #
793
- # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Void::EntryStatus]
794
- #
795
- # @param ledger_sequence_number [Integer]
796
- #
797
- # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
798
- #
799
- # @param starting_balance [Float]
800
- #
801
- # @param void_amount [Float]
802
- #
803
- # @param void_reason [String, nil]
804
- #
805
- # @param entry_type [Symbol, :void]
806
-
807
- # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Void#credit_block
808
- class CreditBlock < Orb::Internal::Type::BaseModel
809
- # @!attribute id
810
- #
811
- # @return [String]
812
- required :id, String
813
-
814
- # @!attribute expiry_date
815
- #
816
- # @return [Time, nil]
817
- required :expiry_date, Time, nil?: true
818
-
819
- # @!attribute per_unit_cost_basis
820
- #
821
- # @return [String, nil]
822
- required :per_unit_cost_basis, String, nil?: true
823
-
824
- # @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
825
- # @param id [String]
826
- # @param expiry_date [Time, nil]
827
- # @param per_unit_cost_basis [String, nil]
828
- end
829
-
830
- # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Void#customer
831
- class Customer < Orb::Internal::Type::BaseModel
832
- # @!attribute id
833
- #
834
- # @return [String]
835
- required :id, String
836
-
837
- # @!attribute external_customer_id
838
- #
839
- # @return [String, nil]
840
- required :external_customer_id, String, nil?: true
841
-
842
- # @!method initialize(id:, external_customer_id:)
843
- # @param id [String]
844
- # @param external_customer_id [String, nil]
845
- end
846
-
847
- # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Void#entry_status
848
- module EntryStatus
849
- extend Orb::Internal::Type::Enum
850
-
851
- COMMITTED = :committed
852
- PENDING = :pending
853
-
854
- # @!method self.values
855
- # @return [Array<Symbol>]
856
- end
857
- end
858
-
859
- class VoidInitiated < Orb::Internal::Type::BaseModel
860
- # @!attribute id
861
- #
862
- # @return [String]
863
- required :id, String
864
-
865
- # @!attribute amount
866
- #
867
- # @return [Float]
868
- required :amount, Float
869
-
870
- # @!attribute created_at
871
- #
872
- # @return [Time]
873
- required :created_at, Time
874
-
875
- # @!attribute credit_block
876
- #
877
- # @return [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiated::CreditBlock]
878
- required :credit_block,
879
- -> { Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiated::CreditBlock }
880
-
881
- # @!attribute currency
882
- #
883
- # @return [String]
884
- required :currency, String
885
-
886
- # @!attribute customer
887
- #
888
- # @return [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiated::Customer]
889
- required :customer,
890
- -> { Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiated::Customer }
891
-
892
- # @!attribute description
893
- #
894
- # @return [String, nil]
895
- required :description, String, nil?: true
896
-
897
- # @!attribute ending_balance
898
- #
899
- # @return [Float]
900
- required :ending_balance, Float
901
-
902
- # @!attribute entry_status
903
- #
904
- # @return [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiated::EntryStatus]
905
- required :entry_status,
906
- enum: -> { Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiated::EntryStatus }
907
-
908
- # @!attribute entry_type
909
- #
910
- # @return [Symbol, :void_initiated]
911
- required :entry_type, const: :void_initiated
912
-
913
- # @!attribute ledger_sequence_number
914
- #
915
- # @return [Integer]
916
- required :ledger_sequence_number, Integer
917
-
918
- # @!attribute metadata
919
- # User specified key-value pairs for the resource. If not present, this defaults
920
- # to an empty dictionary. Individual keys can be removed by setting the value to
921
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
922
- # `null`.
923
- #
924
- # @return [Hash{Symbol=>String}]
925
- required :metadata, Orb::Internal::Type::HashOf[String]
926
-
927
- # @!attribute new_block_expiry_date
928
- #
929
- # @return [Time]
930
- required :new_block_expiry_date, Time
931
-
932
- # @!attribute starting_balance
933
- #
934
- # @return [Float]
935
- required :starting_balance, Float
936
-
937
- # @!attribute void_amount
938
- #
939
- # @return [Float]
940
- required :void_amount, Float
941
-
942
- # @!attribute void_reason
943
- #
944
- # @return [String, nil]
945
- required :void_reason, String, nil?: true
946
-
947
- # @!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)
948
- # Some parameter documentations has been truncated, see
949
- # {Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiated} for
950
- # more details.
951
- #
952
- # @param id [String]
953
- #
954
- # @param amount [Float]
955
- #
956
- # @param created_at [Time]
957
- #
958
- # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiated::CreditBlock]
959
- #
960
- # @param currency [String]
961
- #
962
- # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiated::Customer]
963
- #
964
- # @param description [String, nil]
965
- #
966
- # @param ending_balance [Float]
967
- #
968
- # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiated::EntryStatus]
969
- #
970
- # @param ledger_sequence_number [Integer]
971
- #
972
- # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
973
- #
974
- # @param new_block_expiry_date [Time]
975
- #
976
- # @param starting_balance [Float]
977
- #
978
- # @param void_amount [Float]
979
- #
980
- # @param void_reason [String, nil]
981
- #
982
- # @param entry_type [Symbol, :void_initiated]
983
-
984
- # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiated#credit_block
985
- class CreditBlock < Orb::Internal::Type::BaseModel
986
- # @!attribute id
987
- #
988
- # @return [String]
989
- required :id, String
990
-
991
- # @!attribute expiry_date
992
- #
993
- # @return [Time, nil]
994
- required :expiry_date, Time, nil?: true
995
-
996
- # @!attribute per_unit_cost_basis
997
- #
998
- # @return [String, nil]
999
- required :per_unit_cost_basis, String, nil?: true
1000
-
1001
- # @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
1002
- # @param id [String]
1003
- # @param expiry_date [Time, nil]
1004
- # @param per_unit_cost_basis [String, nil]
1005
- end
1006
-
1007
- # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiated#customer
1008
- class Customer < Orb::Internal::Type::BaseModel
1009
- # @!attribute id
1010
- #
1011
- # @return [String]
1012
- required :id, String
1013
-
1014
- # @!attribute external_customer_id
1015
- #
1016
- # @return [String, nil]
1017
- required :external_customer_id, String, nil?: true
1018
-
1019
- # @!method initialize(id:, external_customer_id:)
1020
- # @param id [String]
1021
- # @param external_customer_id [String, nil]
1022
- end
1023
-
1024
- # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiated#entry_status
1025
- module EntryStatus
1026
- extend Orb::Internal::Type::Enum
1027
-
1028
- COMMITTED = :committed
1029
- PENDING = :pending
1030
-
1031
- # @!method self.values
1032
- # @return [Array<Symbol>]
1033
- end
1034
- end
1035
-
1036
- class Amendment < Orb::Internal::Type::BaseModel
1037
- # @!attribute id
1038
- #
1039
- # @return [String]
1040
- required :id, String
1041
-
1042
- # @!attribute amount
1043
- #
1044
- # @return [Float]
1045
- required :amount, Float
1046
-
1047
- # @!attribute created_at
1048
- #
1049
- # @return [Time]
1050
- required :created_at, Time
1051
-
1052
- # @!attribute credit_block
1053
- #
1054
- # @return [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Amendment::CreditBlock]
1055
- required :credit_block,
1056
- -> { Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Amendment::CreditBlock }
1057
-
1058
- # @!attribute currency
1059
- #
1060
- # @return [String]
1061
- required :currency, String
1062
-
1063
- # @!attribute customer
1064
- #
1065
- # @return [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Amendment::Customer]
1066
- required :customer, -> { Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Amendment::Customer }
1067
-
1068
- # @!attribute description
1069
- #
1070
- # @return [String, nil]
1071
- required :description, String, nil?: true
1072
-
1073
- # @!attribute ending_balance
1074
- #
1075
- # @return [Float]
1076
- required :ending_balance, Float
1077
-
1078
- # @!attribute entry_status
1079
- #
1080
- # @return [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Amendment::EntryStatus]
1081
- required :entry_status,
1082
- enum: -> { Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Amendment::EntryStatus }
1083
-
1084
- # @!attribute entry_type
1085
- #
1086
- # @return [Symbol, :amendment]
1087
- required :entry_type, const: :amendment
1088
-
1089
- # @!attribute ledger_sequence_number
1090
- #
1091
- # @return [Integer]
1092
- required :ledger_sequence_number, Integer
1093
-
1094
- # @!attribute metadata
1095
- # User specified key-value pairs for the resource. If not present, this defaults
1096
- # to an empty dictionary. Individual keys can be removed by setting the value to
1097
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
1098
- # `null`.
1099
- #
1100
- # @return [Hash{Symbol=>String}]
1101
- required :metadata, Orb::Internal::Type::HashOf[String]
1102
-
1103
- # @!attribute starting_balance
1104
- #
1105
- # @return [Float]
1106
- required :starting_balance, Float
1107
-
1108
- # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :amendment)
1109
- # Some parameter documentations has been truncated, see
1110
- # {Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Amendment} for more
1111
- # details.
1112
- #
1113
- # @param id [String]
1114
- #
1115
- # @param amount [Float]
1116
- #
1117
- # @param created_at [Time]
1118
- #
1119
- # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Amendment::CreditBlock]
1120
- #
1121
- # @param currency [String]
1122
- #
1123
- # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Amendment::Customer]
1124
- #
1125
- # @param description [String, nil]
1126
- #
1127
- # @param ending_balance [Float]
1128
- #
1129
- # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Amendment::EntryStatus]
1130
- #
1131
- # @param ledger_sequence_number [Integer]
1132
- #
1133
- # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
1134
- #
1135
- # @param starting_balance [Float]
1136
- #
1137
- # @param entry_type [Symbol, :amendment]
1138
-
1139
- # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Amendment#credit_block
1140
- class CreditBlock < Orb::Internal::Type::BaseModel
1141
- # @!attribute id
1142
- #
1143
- # @return [String]
1144
- required :id, String
1145
-
1146
- # @!attribute expiry_date
1147
- #
1148
- # @return [Time, nil]
1149
- required :expiry_date, Time, nil?: true
1150
-
1151
- # @!attribute per_unit_cost_basis
1152
- #
1153
- # @return [String, nil]
1154
- required :per_unit_cost_basis, String, nil?: true
1155
-
1156
- # @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
1157
- # @param id [String]
1158
- # @param expiry_date [Time, nil]
1159
- # @param per_unit_cost_basis [String, nil]
1160
- end
1161
-
1162
- # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Amendment#customer
1163
- class Customer < Orb::Internal::Type::BaseModel
1164
- # @!attribute id
1165
- #
1166
- # @return [String]
1167
- required :id, String
1168
-
1169
- # @!attribute external_customer_id
1170
- #
1171
- # @return [String, nil]
1172
- required :external_customer_id, String, nil?: true
1173
-
1174
- # @!method initialize(id:, external_customer_id:)
1175
- # @param id [String]
1176
- # @param external_customer_id [String, nil]
1177
- end
1178
-
1179
- # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Amendment#entry_status
1180
- module EntryStatus
1181
- extend Orb::Internal::Type::Enum
1182
-
1183
- COMMITTED = :committed
1184
- PENDING = :pending
1185
-
1186
- # @!method self.values
1187
- # @return [Array<Symbol>]
1188
- end
1189
- end
28
+ variant :amendment, -> { Orb::Customers::Credits::AmendmentLedgerEntry }
1190
29
 
1191
30
  # @!method self.variants
1192
- # @return [Array(Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Increment, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Decrement, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChange, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Void, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiated, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::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)]
1193
32
  end
1194
33
  end
1195
34
  end