orb-billing 0.12.0 → 1.0.1

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