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