orb-billing 0.12.0 → 1.0.0

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