orb-billing 0.2.0 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +67 -0
- data/README.md +63 -53
- data/lib/orb/client.rb +4 -4
- data/lib/orb/errors.rb +9 -9
- data/lib/orb/file_part.rb +55 -0
- data/lib/orb/internal/page.rb +7 -11
- data/lib/orb/internal/transport/base_client.rb +10 -10
- data/lib/orb/internal/transport/pooled_net_requester.rb +2 -2
- data/lib/orb/internal/type/array_of.rb +11 -0
- data/lib/orb/internal/type/base_model.rb +33 -23
- data/lib/orb/internal/type/base_page.rb +9 -1
- data/lib/orb/internal/type/boolean.rb +14 -11
- data/lib/orb/internal/type/converter.rb +4 -1
- data/lib/orb/internal/type/enum.rb +19 -16
- data/lib/orb/internal/type/{io_like.rb → file_input.rb} +33 -15
- data/lib/orb/internal/type/hash_of.rb +11 -0
- data/lib/orb/internal/type/request_parameters.rb +3 -10
- data/lib/orb/internal/type/union.rb +10 -1
- data/lib/orb/internal/type/unknown.rb +14 -11
- data/lib/orb/internal/util.rb +88 -64
- data/lib/orb/internal.rb +0 -1
- data/lib/orb/models/alert.rb +68 -71
- data/lib/orb/models/alert_create_for_customer_params.rb +20 -25
- data/lib/orb/models/alert_create_for_external_customer_params.rb +20 -25
- data/lib/orb/models/alert_create_for_subscription_params.rb +20 -25
- data/lib/orb/models/alert_disable_params.rb +5 -9
- data/lib/orb/models/alert_enable_params.rb +5 -9
- data/lib/orb/models/alert_list_params.rb +26 -36
- data/lib/orb/models/alert_retrieve_params.rb +3 -8
- data/lib/orb/models/alert_update_params.rb +14 -18
- data/lib/orb/models/amount_discount.rb +14 -14
- data/lib/orb/models/billable_metric.rb +23 -20
- data/lib/orb/models/billing_cycle_relative_date.rb +2 -5
- data/lib/orb/models/coupon.rb +28 -21
- data/lib/orb/models/coupon_archive_params.rb +3 -8
- data/lib/orb/models/coupon_create_params.rb +29 -34
- data/lib/orb/models/coupon_fetch_params.rb +3 -8
- data/lib/orb/models/coupon_list_params.rb +17 -17
- data/lib/orb/models/coupons/subscription_list_params.rb +12 -15
- data/lib/orb/models/credit_note.rb +100 -166
- data/lib/orb/models/credit_note_create_params.rb +15 -23
- data/lib/orb/models/credit_note_fetch_params.rb +3 -8
- data/lib/orb/models/credit_note_list_params.rb +20 -30
- data/lib/orb/models/customer.rb +224 -271
- data/lib/orb/models/customer_create_params.rb +216 -257
- data/lib/orb/models/customer_delete_params.rb +3 -8
- data/lib/orb/models/customer_fetch_by_external_id_params.rb +3 -8
- data/lib/orb/models/customer_fetch_params.rb +3 -8
- data/lib/orb/models/customer_list_params.rb +20 -30
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +3 -8
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +3 -8
- data/lib/orb/models/customer_update_by_external_id_params.rb +212 -257
- data/lib/orb/models/customer_update_params.rb +212 -255
- data/lib/orb/models/customers/balance_transaction_create_params.rb +11 -16
- data/lib/orb/models/customers/balance_transaction_create_response.rb +33 -51
- data/lib/orb/models/customers/balance_transaction_list_params.rb +20 -30
- data/lib/orb/models/customers/balance_transaction_list_response.rb +33 -51
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +23 -27
- data/lib/orb/models/customers/cost_list_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_response.rb +23 -27
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +18 -22
- data/lib/orb/models/customers/credit_list_by_external_id_response.rb +10 -17
- data/lib/orb/models/customers/credit_list_params.rb +18 -22
- data/lib/orb/models/customers/credit_list_response.rb +10 -17
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +64 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +384 -491
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +63 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +384 -498
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +33 -48
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +384 -494
- data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
- data/lib/orb/models/customers/credits/ledger_list_response.rb +383 -501
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +47 -50
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +43 -46
- data/lib/orb/models/customers/credits/top_up_create_params.rb +46 -50
- data/lib/orb/models/customers/credits/top_up_create_response.rb +42 -46
- data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +4 -9
- data/lib/orb/models/customers/credits/top_up_delete_params.rb +4 -9
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +12 -15
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +43 -46
- data/lib/orb/models/customers/credits/top_up_list_params.rb +12 -15
- data/lib/orb/models/customers/credits/top_up_list_response.rb +42 -46
- data/lib/orb/models/dimensional_price_group.rb +21 -15
- data/lib/orb/models/dimensional_price_group_create_params.rb +17 -23
- data/lib/orb/models/dimensional_price_group_list_params.rb +12 -15
- data/lib/orb/models/dimensional_price_group_retrieve_params.rb +3 -8
- data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +3 -8
- data/lib/orb/models/dimensional_price_groups.rb +3 -7
- data/lib/orb/models/discount.rb +2 -3
- data/lib/orb/models/evaluate_price_group.rb +8 -11
- data/lib/orb/models/event_deprecate_params.rb +3 -8
- data/lib/orb/models/event_deprecate_response.rb +2 -6
- data/lib/orb/models/event_ingest_params.rb +33 -27
- data/lib/orb/models/event_ingest_response.rb +23 -24
- data/lib/orb/models/event_search_params.rb +15 -11
- data/lib/orb/models/event_search_response.rb +27 -22
- data/lib/orb/models/event_update_params.rb +19 -13
- data/lib/orb/models/event_update_response.rb +2 -6
- data/lib/orb/models/events/backfill_close_params.rb +3 -8
- data/lib/orb/models/events/backfill_close_response.rb +34 -39
- data/lib/orb/models/events/backfill_create_params.rb +28 -32
- data/lib/orb/models/events/backfill_create_response.rb +34 -39
- data/lib/orb/models/events/backfill_fetch_params.rb +3 -8
- data/lib/orb/models/events/backfill_fetch_response.rb +34 -39
- data/lib/orb/models/events/backfill_list_params.rb +12 -15
- data/lib/orb/models/events/backfill_list_response.rb +34 -39
- data/lib/orb/models/events/backfill_revert_params.rb +3 -8
- data/lib/orb/models/events/backfill_revert_response.rb +34 -39
- data/lib/orb/models/events/event_volumes.rb +11 -17
- data/lib/orb/models/events/volume_list_params.rb +19 -22
- data/lib/orb/models/invoice.rb +619 -681
- data/lib/orb/models/invoice_create_params.rb +52 -61
- data/lib/orb/models/invoice_fetch_params.rb +3 -8
- data/lib/orb/models/invoice_fetch_upcoming_params.rb +4 -9
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +618 -669
- data/lib/orb/models/invoice_issue_params.rb +10 -14
- data/lib/orb/models/invoice_level_discount.rb +2 -3
- data/lib/orb/models/invoice_line_item_create_params.rb +19 -14
- data/lib/orb/models/invoice_line_item_create_response.rb +281 -306
- data/lib/orb/models/invoice_list_params.rb +51 -66
- data/lib/orb/models/invoice_mark_paid_params.rb +9 -11
- data/lib/orb/models/invoice_pay_params.rb +3 -8
- data/lib/orb/models/invoice_update_params.rb +9 -9
- data/lib/orb/models/invoice_void_params.rb +3 -8
- data/lib/orb/models/item.rb +14 -25
- data/lib/orb/models/item_create_params.rb +5 -9
- data/lib/orb/models/item_fetch_params.rb +3 -8
- data/lib/orb/models/item_list_params.rb +12 -15
- data/lib/orb/models/item_update_params.rb +10 -22
- data/lib/orb/models/metric_create_params.rb +17 -13
- data/lib/orb/models/metric_fetch_params.rb +3 -8
- data/lib/orb/models/metric_list_params.rb +20 -30
- data/lib/orb/models/metric_update_params.rb +9 -9
- data/lib/orb/models/pagination_metadata.rb +3 -7
- data/lib/orb/models/percentage_discount.rb +15 -14
- data/lib/orb/models/plan.rb +259 -291
- data/lib/orb/models/plan_create_params.rb +2070 -2466
- data/lib/orb/models/plan_fetch_params.rb +3 -8
- data/lib/orb/models/plan_list_params.rb +25 -42
- data/lib/orb/models/plan_update_params.rb +12 -10
- data/lib/orb/models/plans/external_plan_id_fetch_params.rb +3 -8
- data/lib/orb/models/plans/external_plan_id_update_params.rb +12 -10
- data/lib/orb/models/price.rb +3842 -5005
- data/lib/orb/models/price_create_params.rb +203 -244
- data/lib/orb/models/price_evaluate_params.rb +21 -30
- data/lib/orb/models/price_evaluate_response.rb +2 -6
- data/lib/orb/models/price_fetch_params.rb +3 -8
- data/lib/orb/models/price_list_params.rb +12 -15
- data/lib/orb/models/price_update_params.rb +9 -9
- data/lib/orb/models/prices/external_price_id_fetch_params.rb +3 -8
- data/lib/orb/models/prices/external_price_id_update_params.rb +9 -9
- data/lib/orb/models/subscription.rb +360 -405
- data/lib/orb/models/subscription_cancel_params.rb +16 -16
- data/lib/orb/models/subscription_cancel_response.rb +358 -399
- data/lib/orb/models/subscription_change_apply_params.rb +7 -10
- data/lib/orb/models/subscription_change_apply_response.rb +384 -418
- data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
- data/lib/orb/models/subscription_change_cancel_response.rb +384 -417
- data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
- data/lib/orb/models/subscription_change_retrieve_response.rb +385 -417
- data/lib/orb/models/subscription_create_params.rb +4735 -5417
- data/lib/orb/models/subscription_create_response.rb +358 -399
- data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
- data/lib/orb/models/subscription_fetch_costs_response.rb +23 -27
- data/lib/orb/models/subscription_fetch_params.rb +3 -8
- data/lib/orb/models/subscription_fetch_schedule_params.rb +20 -30
- data/lib/orb/models/subscription_fetch_schedule_response.rb +15 -17
- data/lib/orb/models/subscription_fetch_usage_params.rb +32 -43
- data/lib/orb/models/subscription_list_params.rb +28 -41
- data/lib/orb/models/subscription_price_intervals_params.rb +2560 -3040
- data/lib/orb/models/subscription_price_intervals_response.rb +361 -399
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +4728 -5411
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +361 -398
- data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
- data/lib/orb/models/subscription_trigger_phase_response.rb +360 -399
- data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +361 -398
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +5 -9
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +362 -396
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +362 -396
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +22 -33
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +361 -398
- data/lib/orb/models/subscription_update_params.rb +21 -23
- data/lib/orb/models/subscription_update_trial_params.rb +15 -18
- data/lib/orb/models/subscription_update_trial_response.rb +360 -399
- data/lib/orb/models/subscription_usage.rb +37 -80
- data/lib/orb/models/subscriptions.rb +3 -7
- data/lib/orb/models/top_level_ping_params.rb +3 -8
- data/lib/orb/models/top_level_ping_response.rb +2 -6
- data/lib/orb/models/trial_discount.rb +16 -24
- data/lib/orb/models/usage_discount.rb +15 -14
- data/lib/orb/models.rb +220 -0
- data/lib/orb/request_options.rb +4 -6
- data/lib/orb/resources/alerts.rb +48 -17
- data/lib/orb/resources/coupons/subscriptions.rb +9 -2
- data/lib/orb/resources/coupons.rb +26 -8
- data/lib/orb/resources/credit_notes.rb +17 -4
- data/lib/orb/resources/customers/balance_transactions.rb +18 -3
- data/lib/orb/resources/customers/costs.rb +26 -8
- data/lib/orb/resources/customers/credits/ledger.rb +112 -32
- data/lib/orb/resources/customers/credits/top_ups.rb +67 -20
- data/lib/orb/resources/customers/credits.rb +28 -8
- data/lib/orb/resources/customers.rb +138 -39
- data/lib/orb/resources/dimensional_price_groups.rb +19 -4
- data/lib/orb/resources/events/backfills.rb +32 -9
- data/lib/orb/resources/events/volume.rb +14 -4
- data/lib/orb/resources/events.rb +40 -11
- data/lib/orb/resources/invoice_line_items.rb +16 -6
- data/lib/orb/resources/invoices.rb +77 -17
- data/lib/orb/resources/items.rb +10 -3
- data/lib/orb/resources/metrics.rb +33 -8
- data/lib/orb/resources/plans/external_plan_id.rb +10 -2
- data/lib/orb/resources/plans.rb +47 -11
- data/lib/orb/resources/prices/external_price_id.rb +9 -3
- data/lib/orb/resources/prices.rb +101 -26
- data/lib/orb/resources/subscription_changes.rb +5 -2
- data/lib/orb/resources/subscriptions.rb +292 -78
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +2 -10
- data/rbi/{lib/orb → orb}/client.rbi +4 -4
- data/rbi/{lib/orb → orb}/errors.rbi +1 -1
- data/rbi/orb/file_part.rbi +34 -0
- data/rbi/{lib/orb → orb}/internal/transport/base_client.rbi +19 -5
- data/rbi/{lib/orb → orb}/internal/type/array_of.rbi +3 -0
- data/rbi/{lib/orb → orb}/internal/type/base_model.rbi +7 -1
- data/rbi/{lib/orb → orb}/internal/type/base_page.rbi +2 -0
- data/rbi/{lib/orb → orb}/internal/type/enum.rbi +3 -6
- data/rbi/{lib/orb/internal/type/io_like.rbi → orb/internal/type/file_input.rbi} +5 -2
- data/rbi/{lib/orb → orb}/internal/type/hash_of.rbi +3 -0
- data/rbi/{lib/orb → orb}/internal/type/request_parameters.rbi +1 -1
- data/rbi/{lib/orb → orb}/internal/type/union.rbi +3 -0
- data/rbi/{lib/orb → orb}/internal/util.rbi +28 -19
- data/rbi/{lib/orb → orb}/internal.rbi +0 -1
- data/rbi/{lib/orb → orb}/models/alert.rbi +28 -8
- data/rbi/{lib/orb → orb}/models/alert_create_for_customer_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/alert_create_for_external_customer_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/alert_create_for_subscription_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/alert_disable_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/alert_enable_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/alert_list_params.rbi +6 -0
- data/rbi/{lib/orb → orb}/models/alert_update_params.rbi +11 -4
- data/rbi/{lib/orb → orb}/models/amount_discount.rbi +10 -4
- data/rbi/{lib/orb → orb}/models/billable_metric.rbi +16 -3
- data/rbi/{lib/orb → orb}/models/billing_cycle_relative_date.rbi +1 -1
- data/rbi/{lib/orb → orb}/models/coupon.rbi +10 -3
- data/rbi/{lib/orb → orb}/models/coupon_create_params.rbi +15 -12
- data/rbi/{lib/orb → orb}/models/coupon_list_params.rbi +13 -3
- data/rbi/{lib/orb → orb}/models/coupons/subscription_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/credit_note.rbi +44 -12
- data/rbi/{lib/orb → orb}/models/credit_note_create_params.rbi +15 -6
- data/rbi/{lib/orb → orb}/models/credit_note_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/customer.rbi +130 -11
- data/rbi/{lib/orb → orb}/models/customer_create_params.rbi +151 -17
- data/rbi/{lib/orb → orb}/models/customer_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/customer_update_by_external_id_params.rbi +149 -17
- data/rbi/{lib/orb → orb}/models/customer_update_params.rbi +149 -17
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_params.rbi +8 -4
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_response.rbi +18 -8
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_response.rbi +18 -8
- data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_params.rbi +9 -5
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +225 -0
- data/rbi/{lib/orb → orb}/models/customers/cost_list_params.rbi +9 -5
- data/rbi/orb/models/customers/cost_list_response.rbi +223 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_params.rbi +13 -3
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_response.rbi +1 -2
- data/rbi/{lib/orb → orb}/models/customers/credit_list_params.rbi +13 -3
- data/rbi/{lib/orb → orb}/models/customers/credit_list_response.rbi +1 -2
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_response.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi} +157 -170
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_params.rbi +40 -6
- data/rbi/{lib/orb/models/customers/credits/ledger_list_response.rbi → orb/models/customers/credits/ledger_create_entry_response.rbi} +149 -196
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_response.rbi +148 -229
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_params.rbi +6 -4
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi → orb/models/customers/credits/ledger_list_response.rbi} +149 -343
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_params.rbi +27 -4
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_response.rbi +25 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_response.rbi +25 -4
- data/rbi/{lib/orb → orb}/models/dimensional_price_group.rbi +11 -3
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_create_params.rbi +4 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/evaluate_price_group.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/event_deprecate_response.rbi +4 -2
- data/rbi/{lib/orb → orb}/models/event_ingest_params.rbi +22 -5
- data/rbi/{lib/orb → orb}/models/event_ingest_response.rbi +15 -4
- data/rbi/{lib/orb → orb}/models/event_search_params.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/event_search_response.rbi +14 -3
- data/rbi/{lib/orb → orb}/models/event_update_params.rbi +10 -3
- data/rbi/{lib/orb → orb}/models/event_update_response.rbi +4 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_close_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_create_params.rbi +18 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_create_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_fetch_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_list_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_revert_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/event_volumes.rbi +8 -4
- data/rbi/{lib/orb → orb}/models/events/volume_list_params.rbi +18 -2
- data/rbi/{lib/orb → orb}/models/invoice.rbi +513 -202
- data/rbi/{lib/orb → orb}/models/invoice_create_params.rbi +38 -6
- data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_response.rbi +513 -216
- data/rbi/{lib/orb → orb}/models/invoice_issue_params.rbi +9 -2
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_params.rbi +16 -2
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_response.rbi +279 -182
- data/rbi/{lib/orb → orb}/models/invoice_list_params.rbi +9 -2
- data/rbi/{lib/orb → orb}/models/invoice_mark_paid_params.rbi +9 -2
- data/rbi/{lib/orb → orb}/models/invoice_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/item.rbi +1 -2
- data/rbi/{lib/orb → orb}/models/item_create_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/item_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/item_update_params.rbi +1 -8
- data/rbi/{lib/orb → orb}/models/metric_create_params.rbi +15 -2
- data/rbi/{lib/orb → orb}/models/metric_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/metric_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/percentage_discount.rbi +11 -4
- data/rbi/{lib/orb → orb}/models/plan.rbi +207 -120
- data/rbi/{lib/orb → orb}/models/plan_create_params.rbi +1971 -2414
- data/rbi/{lib/orb → orb}/models/plan_list_params.rbi +5 -1
- data/rbi/{lib/orb → orb}/models/plan_update_params.rbi +11 -2
- data/rbi/{lib/orb → orb}/models/plans/external_plan_id_update_params.rbi +11 -2
- data/rbi/{lib/orb → orb}/models/price.rbi +2594 -2957
- data/rbi/{lib/orb → orb}/models/price_create_params.rbi +137 -53
- data/rbi/{lib/orb → orb}/models/price_evaluate_params.rbi +10 -0
- data/rbi/{lib/orb → orb}/models/price_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/price_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/prices/external_price_id_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/subscription.rbi +292 -129
- data/rbi/{lib/orb → orb}/models/subscription_cancel_params.rbi +8 -5
- data/rbi/{lib/orb → orb}/models/subscription_cancel_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_response.rbi +317 -136
- data/rbi/{lib/orb → orb}/models/subscription_change_cancel_response.rbi +317 -136
- data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_response.rbi +317 -136
- data/rbi/{lib/orb → orb}/models/subscription_create_params.rbi +4271 -4270
- data/rbi/{lib/orb → orb}/models/subscription_create_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_params.rbi +9 -5
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +221 -0
- data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_response.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/subscription_fetch_usage_params.rbi +13 -4
- data/rbi/{lib/orb → orb}/models/subscription_list_params.rbi +4 -2
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_params.rbi +2354 -2317
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_params.rbi +4280 -3758
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_params.rbi +10 -2
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +305 -138
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_update_params.rbi +15 -0
- data/rbi/{lib/orb → orb}/models/subscription_update_trial_params.rbi +11 -5
- data/rbi/{lib/orb → orb}/models/subscription_update_trial_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_usage.rbi +2 -16
- data/rbi/{lib/orb → orb}/models/trial_discount.rbi +5 -1
- data/rbi/{lib/orb → orb}/models/usage_discount.rbi +11 -3
- data/rbi/orb/models.rbi +220 -0
- data/rbi/{lib/orb → orb}/request_options.rbi +2 -0
- data/rbi/{lib/orb → orb}/resources/alerts.rbi +8 -14
- data/rbi/{lib/orb → orb}/resources/coupons/subscriptions.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/coupons.rbi +6 -18
- data/rbi/{lib/orb → orb}/resources/credit_notes.rbi +3 -9
- data/rbi/{lib/orb → orb}/resources/customers/balance_transactions.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers/costs.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers/credits/ledger.rbi +32 -32
- data/rbi/{lib/orb → orb}/resources/customers/credits/top_ups.rbi +6 -18
- data/rbi/{lib/orb → orb}/resources/customers/credits.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers.rbi +15 -45
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +1 -4
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups.rbi +3 -10
- data/rbi/{lib/orb → orb}/resources/events/backfills.rbi +5 -18
- data/rbi/{lib/orb → orb}/resources/events/volume.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/events.rbi +4 -10
- data/rbi/{lib/orb → orb}/resources/invoice_line_items.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/invoices.rbi +9 -34
- data/rbi/{lib/orb → orb}/resources/items.rbi +4 -17
- data/rbi/{lib/orb → orb}/resources/metrics.rbi +4 -10
- data/rbi/{lib/orb → orb}/resources/plans/external_plan_id.rbi +2 -8
- data/rbi/{lib/orb → orb}/resources/plans.rbi +29 -35
- data/rbi/orb/resources/prices/external_price_id.rbi +103 -0
- data/rbi/{lib/orb → orb}/resources/prices.rbi +117 -124
- data/rbi/{lib/orb → orb}/resources/subscription_changes.rbi +3 -9
- data/rbi/{lib/orb → orb}/resources/subscriptions.rbi +16 -32
- data/rbi/{lib/orb → orb}/resources/top_level.rbi +1 -4
- data/sig/orb/file_part.rbs +21 -0
- data/sig/orb/internal/transport/base_client.rbs +9 -3
- data/sig/orb/internal/type/array_of.rbs +2 -0
- data/sig/orb/internal/type/base_model.rbs +4 -0
- data/sig/orb/internal/type/enum.rbs +2 -2
- data/sig/orb/internal/type/{io_like.rbs → file_input.rbs} +1 -1
- data/sig/orb/internal/type/hash_of.rbs +2 -0
- data/sig/orb/internal/type/union.rbs +2 -0
- data/sig/orb/internal/util.rbs +16 -12
- data/sig/orb/models/coupon_create_params.rbs +9 -10
- data/sig/orb/models/customer_create_params.rbs +9 -10
- data/sig/orb/models/customer_update_by_external_id_params.rbs +9 -10
- data/sig/orb/models/customer_update_params.rbs +9 -10
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +113 -113
- data/sig/orb/models/invoice.rbs +54 -54
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +54 -54
- data/sig/orb/models/invoice_line_item_create_response.rbs +54 -54
- data/sig/orb/models/plan.rbs +21 -21
- data/sig/orb/models/plan_create_params.rbs +653 -653
- data/sig/orb/models/price.rbs +1517 -1521
- data/sig/orb/models/subscription.rbs +34 -34
- data/sig/orb/models/subscription_cancel_response.rbs +34 -34
- data/sig/orb/models/subscription_change_apply_response.rbs +34 -34
- data/sig/orb/models/subscription_change_cancel_response.rbs +34 -34
- data/sig/orb/models/subscription_change_retrieve_response.rbs +34 -34
- data/sig/orb/models/subscription_create_params.rbs +1348 -1348
- data/sig/orb/models/subscription_create_response.rbs +34 -34
- data/sig/orb/models/subscription_price_intervals_params.rbs +767 -769
- data/sig/orb/models/subscription_price_intervals_response.rbs +34 -34
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1348 -1348
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +34 -34
- data/sig/orb/models/subscription_trigger_phase_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +34 -34
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +34 -34
- data/sig/orb/models/subscription_update_trial_response.rbs +34 -34
- data/sig/orb/models.rbs +215 -0
- metadata +230 -224
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +0 -208
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +0 -206
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +0 -204
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +0 -106
- /data/rbi/{lib/orb → orb}/internal/page.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/transport/pooled_net_requester.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/type/boolean.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/type/converter.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/type/unknown.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/alert_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/coupon_archive_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/coupon_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/credit_note_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_delete_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_fetch_by_external_id_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_by_external_id_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/dimensional_price_group_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/dimensional_price_groups.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/event_deprecate_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/events/backfill_close_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/events/backfill_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/events/backfill_revert_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_level_discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_pay_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_void_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/metric_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/pagination_metadata.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plan_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plans/external_plan_id_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_evaluate_response.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/prices/external_price_id_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_change_cancel_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscriptions.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/top_level_ping_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/top_level_ping_response.rbi +0 -0
- /data/rbi/{lib/orb → orb}/version.rbi +0 -0
@@ -101,7 +101,7 @@ module Orb
|
|
101
101
|
# @!attribute discount_intervals
|
102
102
|
# The discount intervals for this subscription sorted by the start_date.
|
103
103
|
#
|
104
|
-
# @return [Array<Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::
|
104
|
+
# @return [Array<Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Usage>]
|
105
105
|
required :discount_intervals,
|
106
106
|
-> { Orb::Internal::Type::ArrayOf[union: Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval] }
|
107
107
|
|
@@ -209,69 +209,75 @@ module Orb
|
|
209
209
|
-> { Orb::Models::SubscriptionUpdateTrialResponse::ChangedResources },
|
210
210
|
nil?: true
|
211
211
|
|
212
|
-
# @!
|
213
|
-
#
|
214
|
-
#
|
215
|
-
#
|
216
|
-
#
|
217
|
-
#
|
218
|
-
#
|
219
|
-
#
|
220
|
-
#
|
221
|
-
#
|
222
|
-
#
|
223
|
-
#
|
224
|
-
#
|
225
|
-
#
|
226
|
-
#
|
227
|
-
#
|
228
|
-
#
|
229
|
-
#
|
230
|
-
#
|
231
|
-
#
|
232
|
-
#
|
233
|
-
#
|
234
|
-
#
|
235
|
-
#
|
236
|
-
#
|
237
|
-
#
|
238
|
-
#
|
239
|
-
#
|
240
|
-
#
|
241
|
-
#
|
242
|
-
#
|
243
|
-
#
|
244
|
-
#
|
245
|
-
#
|
246
|
-
#
|
247
|
-
#
|
248
|
-
#
|
249
|
-
#
|
250
|
-
#
|
251
|
-
#
|
252
|
-
#
|
253
|
-
#
|
254
|
-
#
|
255
|
-
#
|
256
|
-
#
|
257
|
-
#
|
258
|
-
#
|
259
|
-
#
|
260
|
-
#
|
261
|
-
#
|
262
|
-
#
|
263
|
-
#
|
264
|
-
#
|
265
|
-
#
|
266
|
-
#
|
267
|
-
#
|
268
|
-
#
|
269
|
-
#
|
270
|
-
#
|
271
|
-
#
|
272
|
-
#
|
273
|
-
|
274
|
-
#
|
212
|
+
# @!method initialize(id:, active_plan_phase_order:, adjustment_intervals:, auto_collection:, billing_cycle_anchor_configuration:, billing_cycle_day:, created_at:, current_billing_period_end_date:, current_billing_period_start_date:, customer:, default_invoice_memo:, discount_intervals:, end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, maximum_intervals:, metadata:, minimum_intervals:, net_terms:, pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, trial_info:, changed_resources: nil)
|
213
|
+
# Some parameter documentations has been truncated, see
|
214
|
+
# {Orb::Models::SubscriptionUpdateTrialResponse} for more details.
|
215
|
+
#
|
216
|
+
# @param id [String]
|
217
|
+
#
|
218
|
+
# @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase
|
219
|
+
# ...
|
220
|
+
#
|
221
|
+
# @param adjustment_intervals [Array<Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval>] The adjustment intervals for this subscription sorted by the start_date of the a
|
222
|
+
# ...
|
223
|
+
#
|
224
|
+
# @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c
|
225
|
+
# ...
|
226
|
+
#
|
227
|
+
# @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionUpdateTrialResponse::BillingCycleAnchorConfiguration]
|
228
|
+
#
|
229
|
+
# @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
|
230
|
+
# ...
|
231
|
+
#
|
232
|
+
# @param created_at [Time]
|
233
|
+
#
|
234
|
+
# @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
|
235
|
+
# ...
|
236
|
+
#
|
237
|
+
# @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
|
238
|
+
# ...
|
239
|
+
#
|
240
|
+
# @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
|
241
|
+
# ...
|
242
|
+
#
|
243
|
+
# @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
|
244
|
+
# ...
|
245
|
+
#
|
246
|
+
# @param discount_intervals [Array<Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Usage>] The discount intervals for this subscription sorted by the start_date.
|
247
|
+
#
|
248
|
+
# @param end_date [Time, nil] The date Orb stops billing for this subscription.
|
249
|
+
#
|
250
|
+
# @param fixed_fee_quantity_schedule [Array<Orb::Models::SubscriptionUpdateTrialResponse::FixedFeeQuantitySchedule>]
|
251
|
+
#
|
252
|
+
# @param invoicing_threshold [String, nil]
|
253
|
+
#
|
254
|
+
# @param maximum_intervals [Array<Orb::Models::SubscriptionUpdateTrialResponse::MaximumInterval>] The maximum intervals for this subscription sorted by the start_date.
|
255
|
+
#
|
256
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
257
|
+
# ...
|
258
|
+
#
|
259
|
+
# @param minimum_intervals [Array<Orb::Models::SubscriptionUpdateTrialResponse::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
|
260
|
+
#
|
261
|
+
# @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
|
262
|
+
# ...
|
263
|
+
#
|
264
|
+
# @param pending_subscription_change [Orb::Models::SubscriptionUpdateTrialResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
|
265
|
+
#
|
266
|
+
# @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
267
|
+
# ...
|
268
|
+
#
|
269
|
+
# @param price_intervals [Array<Orb::Models::SubscriptionUpdateTrialResponse::PriceInterval>] The price intervals for this subscription.
|
270
|
+
#
|
271
|
+
# @param redeemed_coupon [Orb::Models::SubscriptionUpdateTrialResponse::RedeemedCoupon, nil]
|
272
|
+
#
|
273
|
+
# @param start_date [Time] The date Orb starts billing for this subscription.
|
274
|
+
#
|
275
|
+
# @param status [Symbol, Orb::Models::SubscriptionUpdateTrialResponse::Status]
|
276
|
+
#
|
277
|
+
# @param trial_info [Orb::Models::SubscriptionUpdateTrialResponse::TrialInfo]
|
278
|
+
#
|
279
|
+
# @param changed_resources [Orb::Models::SubscriptionUpdateTrialResponse::ChangedResources, nil] The resources that were changed as part of this operation. Only present when fet
|
280
|
+
# ...
|
275
281
|
|
276
282
|
class AdjustmentInterval < Orb::Internal::Type::BaseModel
|
277
283
|
# @!attribute id
|
@@ -281,7 +287,7 @@ module Orb
|
|
281
287
|
|
282
288
|
# @!attribute adjustment
|
283
289
|
#
|
284
|
-
# @return [Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
290
|
+
# @return [Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Maximum]
|
285
291
|
required :adjustment,
|
286
292
|
union: -> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment }
|
287
293
|
|
@@ -303,16 +309,16 @@ module Orb
|
|
303
309
|
# @return [Time]
|
304
310
|
required :start_date, Time
|
305
311
|
|
306
|
-
# @!
|
307
|
-
#
|
308
|
-
#
|
309
|
-
#
|
310
|
-
#
|
311
|
-
#
|
312
|
-
#
|
313
|
-
#
|
314
|
-
|
315
|
-
#
|
312
|
+
# @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:)
|
313
|
+
# @param id [String]
|
314
|
+
#
|
315
|
+
# @param adjustment [Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Maximum]
|
316
|
+
#
|
317
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval IDs that this adjustment applies to.
|
318
|
+
#
|
319
|
+
# @param end_date [Time, nil] The end date of the adjustment interval.
|
320
|
+
#
|
321
|
+
# @param start_date [Time] The start date of the adjustment interval.
|
316
322
|
|
317
323
|
# @see Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval#adjustment
|
318
324
|
module Adjustment
|
@@ -321,21 +327,21 @@ module Orb
|
|
321
327
|
discriminator :adjustment_type
|
322
328
|
|
323
329
|
variant :usage_discount,
|
324
|
-
-> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
330
|
+
-> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::UsageDiscount }
|
325
331
|
|
326
332
|
variant :amount_discount,
|
327
|
-
-> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
333
|
+
-> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::AmountDiscount }
|
328
334
|
|
329
335
|
variant :percentage_discount,
|
330
|
-
-> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
336
|
+
-> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PercentageDiscount }
|
331
337
|
|
332
338
|
variant :minimum,
|
333
|
-
-> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
339
|
+
-> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Minimum }
|
334
340
|
|
335
341
|
variant :maximum,
|
336
|
-
-> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
342
|
+
-> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Maximum }
|
337
343
|
|
338
|
-
class
|
344
|
+
class UsageDiscount < Orb::Internal::Type::BaseModel
|
339
345
|
# @!attribute id
|
340
346
|
#
|
341
347
|
# @return [String]
|
@@ -378,32 +384,29 @@ module Orb
|
|
378
384
|
# @return [Float]
|
379
385
|
required :usage_discount, Float
|
380
386
|
|
381
|
-
# @!
|
382
|
-
#
|
383
|
-
#
|
384
|
-
#
|
385
|
-
#
|
386
|
-
#
|
387
|
-
#
|
388
|
-
#
|
389
|
-
#
|
390
|
-
#
|
391
|
-
#
|
392
|
-
#
|
393
|
-
#
|
394
|
-
#
|
395
|
-
#
|
396
|
-
#
|
397
|
-
#
|
398
|
-
#
|
399
|
-
#
|
400
|
-
#
|
401
|
-
# end
|
402
|
-
|
403
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
387
|
+
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
388
|
+
# Some parameter documentations has been truncated, see
|
389
|
+
# {Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::UsageDiscount}
|
390
|
+
# for more details.
|
391
|
+
#
|
392
|
+
# @param id [String]
|
393
|
+
#
|
394
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
395
|
+
#
|
396
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
397
|
+
# ...
|
398
|
+
#
|
399
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
400
|
+
#
|
401
|
+
# @param reason [String, nil] The reason for the adjustment.
|
402
|
+
#
|
403
|
+
# @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
|
404
|
+
# ...
|
405
|
+
#
|
406
|
+
# @param adjustment_type [Symbol, :usage_discount]
|
404
407
|
end
|
405
408
|
|
406
|
-
class
|
409
|
+
class AmountDiscount < Orb::Internal::Type::BaseModel
|
407
410
|
# @!attribute id
|
408
411
|
#
|
409
412
|
# @return [String]
|
@@ -446,32 +449,29 @@ module Orb
|
|
446
449
|
# @return [String, nil]
|
447
450
|
required :reason, String, nil?: true
|
448
451
|
|
449
|
-
# @!
|
450
|
-
#
|
451
|
-
#
|
452
|
-
#
|
453
|
-
#
|
454
|
-
#
|
455
|
-
#
|
456
|
-
#
|
457
|
-
#
|
458
|
-
#
|
459
|
-
#
|
460
|
-
#
|
461
|
-
#
|
462
|
-
#
|
463
|
-
#
|
464
|
-
#
|
465
|
-
#
|
466
|
-
#
|
467
|
-
#
|
468
|
-
#
|
469
|
-
# end
|
470
|
-
|
471
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
452
|
+
# @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
|
453
|
+
# Some parameter documentations has been truncated, see
|
454
|
+
# {Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::AmountDiscount}
|
455
|
+
# for more details.
|
456
|
+
#
|
457
|
+
# @param id [String]
|
458
|
+
#
|
459
|
+
# @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
|
460
|
+
# ...
|
461
|
+
#
|
462
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
463
|
+
#
|
464
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
465
|
+
# ...
|
466
|
+
#
|
467
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
468
|
+
#
|
469
|
+
# @param reason [String, nil] The reason for the adjustment.
|
470
|
+
#
|
471
|
+
# @param adjustment_type [Symbol, :amount_discount]
|
472
472
|
end
|
473
473
|
|
474
|
-
class
|
474
|
+
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
475
475
|
# @!attribute id
|
476
476
|
#
|
477
477
|
# @return [String]
|
@@ -514,32 +514,29 @@ module Orb
|
|
514
514
|
# @return [String, nil]
|
515
515
|
required :reason, String, nil?: true
|
516
516
|
|
517
|
-
# @!
|
518
|
-
#
|
519
|
-
#
|
520
|
-
#
|
521
|
-
#
|
522
|
-
#
|
523
|
-
#
|
524
|
-
#
|
525
|
-
#
|
526
|
-
#
|
527
|
-
#
|
528
|
-
#
|
529
|
-
#
|
530
|
-
#
|
531
|
-
#
|
532
|
-
#
|
533
|
-
#
|
534
|
-
#
|
535
|
-
#
|
536
|
-
#
|
537
|
-
# end
|
538
|
-
|
539
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
517
|
+
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
|
518
|
+
# Some parameter documentations has been truncated, see
|
519
|
+
# {Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PercentageDiscount}
|
520
|
+
# for more details.
|
521
|
+
#
|
522
|
+
# @param id [String]
|
523
|
+
#
|
524
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
525
|
+
#
|
526
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
527
|
+
# ...
|
528
|
+
#
|
529
|
+
# @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
|
530
|
+
# ...
|
531
|
+
#
|
532
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
533
|
+
#
|
534
|
+
# @param reason [String, nil] The reason for the adjustment.
|
535
|
+
#
|
536
|
+
# @param adjustment_type [Symbol, :percentage_discount]
|
540
537
|
end
|
541
538
|
|
542
|
-
class
|
539
|
+
class Minimum < Orb::Internal::Type::BaseModel
|
543
540
|
# @!attribute id
|
544
541
|
#
|
545
542
|
# @return [String]
|
@@ -588,34 +585,31 @@ module Orb
|
|
588
585
|
# @return [String, nil]
|
589
586
|
required :reason, String, nil?: true
|
590
587
|
|
591
|
-
# @!
|
592
|
-
#
|
593
|
-
#
|
594
|
-
#
|
595
|
-
#
|
596
|
-
#
|
597
|
-
#
|
598
|
-
#
|
599
|
-
#
|
600
|
-
#
|
601
|
-
#
|
602
|
-
#
|
603
|
-
#
|
604
|
-
#
|
605
|
-
#
|
606
|
-
#
|
607
|
-
#
|
608
|
-
#
|
609
|
-
#
|
610
|
-
#
|
611
|
-
#
|
612
|
-
#
|
613
|
-
# end
|
614
|
-
|
615
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
588
|
+
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
|
589
|
+
# Some parameter documentations has been truncated, see
|
590
|
+
# {Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Minimum}
|
591
|
+
# for more details.
|
592
|
+
#
|
593
|
+
# @param id [String]
|
594
|
+
#
|
595
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
596
|
+
#
|
597
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
598
|
+
# ...
|
599
|
+
#
|
600
|
+
# @param item_id [String] The item ID that revenue from this minimum will be attributed to.
|
601
|
+
#
|
602
|
+
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
|
603
|
+
# ...
|
604
|
+
#
|
605
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
606
|
+
#
|
607
|
+
# @param reason [String, nil] The reason for the adjustment.
|
608
|
+
#
|
609
|
+
# @param adjustment_type [Symbol, :minimum]
|
616
610
|
end
|
617
611
|
|
618
|
-
class
|
612
|
+
class Maximum < Orb::Internal::Type::BaseModel
|
619
613
|
# @!attribute id
|
620
614
|
#
|
621
615
|
# @return [String]
|
@@ -658,34 +652,30 @@ module Orb
|
|
658
652
|
# @return [String, nil]
|
659
653
|
required :reason, String, nil?: true
|
660
654
|
|
661
|
-
# @!
|
662
|
-
#
|
663
|
-
#
|
664
|
-
#
|
665
|
-
#
|
666
|
-
#
|
667
|
-
#
|
668
|
-
#
|
669
|
-
#
|
670
|
-
#
|
671
|
-
#
|
672
|
-
#
|
673
|
-
#
|
674
|
-
#
|
675
|
-
#
|
676
|
-
#
|
677
|
-
#
|
678
|
-
#
|
679
|
-
#
|
680
|
-
#
|
681
|
-
# end
|
682
|
-
|
683
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
655
|
+
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
|
656
|
+
# Some parameter documentations has been truncated, see
|
657
|
+
# {Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Maximum}
|
658
|
+
# for more details.
|
659
|
+
#
|
660
|
+
# @param id [String]
|
661
|
+
#
|
662
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
663
|
+
#
|
664
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
665
|
+
# ...
|
666
|
+
#
|
667
|
+
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
|
668
|
+
# ...
|
669
|
+
#
|
670
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
671
|
+
#
|
672
|
+
# @param reason [String, nil] The reason for the adjustment.
|
673
|
+
#
|
674
|
+
# @param adjustment_type [Symbol, :maximum]
|
684
675
|
end
|
685
676
|
|
686
|
-
# @!
|
687
|
-
#
|
688
|
-
# def self.variants; end
|
677
|
+
# @!method self.variants
|
678
|
+
# @return [Array(Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Maximum)]
|
689
679
|
end
|
690
680
|
end
|
691
681
|
|
@@ -715,14 +705,19 @@ module Orb
|
|
715
705
|
# @return [Integer, nil]
|
716
706
|
optional :year, Integer, nil?: true
|
717
707
|
|
718
|
-
# @!
|
719
|
-
#
|
720
|
-
#
|
721
|
-
#
|
722
|
-
#
|
723
|
-
#
|
724
|
-
|
725
|
-
#
|
708
|
+
# @!method initialize(day:, month: nil, year: nil)
|
709
|
+
# Some parameter documentations has been truncated, see
|
710
|
+
# {Orb::Models::SubscriptionUpdateTrialResponse::BillingCycleAnchorConfiguration}
|
711
|
+
# for more details.
|
712
|
+
#
|
713
|
+
# @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
|
714
|
+
# ...
|
715
|
+
#
|
716
|
+
# @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore
|
717
|
+
# ...
|
718
|
+
#
|
719
|
+
# @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc
|
720
|
+
# ...
|
726
721
|
end
|
727
722
|
|
728
723
|
module DiscountInterval
|
@@ -730,16 +725,13 @@ module Orb
|
|
730
725
|
|
731
726
|
discriminator :discount_type
|
732
727
|
|
733
|
-
variant :amount,
|
734
|
-
-> { Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::AmountDiscountInterval }
|
728
|
+
variant :amount, -> { Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Amount }
|
735
729
|
|
736
|
-
variant :percentage,
|
737
|
-
-> { Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::PercentageDiscountInterval }
|
730
|
+
variant :percentage, -> { Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Percentage }
|
738
731
|
|
739
|
-
variant :usage,
|
740
|
-
-> { Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::UsageDiscountInterval }
|
732
|
+
variant :usage, -> { Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Usage }
|
741
733
|
|
742
|
-
class
|
734
|
+
class Amount < Orb::Internal::Type::BaseModel
|
743
735
|
# @!attribute amount_discount
|
744
736
|
# Only available if discount_type is `amount`.
|
745
737
|
#
|
@@ -775,30 +767,21 @@ module Orb
|
|
775
767
|
# @return [Time]
|
776
768
|
required :start_date, Time
|
777
769
|
|
778
|
-
# @!
|
779
|
-
#
|
780
|
-
#
|
781
|
-
#
|
782
|
-
#
|
783
|
-
#
|
784
|
-
#
|
785
|
-
#
|
786
|
-
#
|
787
|
-
#
|
788
|
-
#
|
789
|
-
#
|
790
|
-
# end_date:,
|
791
|
-
# start_date:,
|
792
|
-
# discount_type: :amount,
|
793
|
-
# **
|
794
|
-
# )
|
795
|
-
# super
|
796
|
-
# end
|
797
|
-
|
798
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
770
|
+
# @!method initialize(amount_discount:, applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, discount_type: :amount)
|
771
|
+
# @param amount_discount [String] Only available if discount_type is `amount`.
|
772
|
+
#
|
773
|
+
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
774
|
+
#
|
775
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
|
776
|
+
#
|
777
|
+
# @param end_date [Time, nil] The end date of the discount interval.
|
778
|
+
#
|
779
|
+
# @param start_date [Time] The start date of the discount interval.
|
780
|
+
#
|
781
|
+
# @param discount_type [Symbol, :amount]
|
799
782
|
end
|
800
783
|
|
801
|
-
class
|
784
|
+
class Percentage < Orb::Internal::Type::BaseModel
|
802
785
|
# @!attribute applies_to_price_ids
|
803
786
|
# The price ids that this discount interval applies to.
|
804
787
|
#
|
@@ -835,30 +818,26 @@ module Orb
|
|
835
818
|
# @return [Time]
|
836
819
|
required :start_date, Time
|
837
820
|
|
838
|
-
# @!
|
839
|
-
#
|
840
|
-
#
|
841
|
-
#
|
842
|
-
#
|
843
|
-
#
|
844
|
-
#
|
845
|
-
#
|
846
|
-
#
|
847
|
-
#
|
848
|
-
#
|
849
|
-
#
|
850
|
-
#
|
851
|
-
#
|
852
|
-
#
|
853
|
-
#
|
854
|
-
#
|
855
|
-
# super
|
856
|
-
# end
|
857
|
-
|
858
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
821
|
+
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage)
|
822
|
+
# Some parameter documentations has been truncated, see
|
823
|
+
# {Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Percentage} for
|
824
|
+
# more details.
|
825
|
+
#
|
826
|
+
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
827
|
+
#
|
828
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
|
829
|
+
#
|
830
|
+
# @param end_date [Time, nil] The end date of the discount interval.
|
831
|
+
#
|
832
|
+
# @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1
|
833
|
+
# ...
|
834
|
+
#
|
835
|
+
# @param start_date [Time] The start date of the discount interval.
|
836
|
+
#
|
837
|
+
# @param discount_type [Symbol, :percentage]
|
859
838
|
end
|
860
839
|
|
861
|
-
class
|
840
|
+
class Usage < Orb::Internal::Type::BaseModel
|
862
841
|
# @!attribute applies_to_price_ids
|
863
842
|
# The price ids that this discount interval applies to.
|
864
843
|
#
|
@@ -895,32 +874,27 @@ module Orb
|
|
895
874
|
# @return [Float]
|
896
875
|
required :usage_discount, Float
|
897
876
|
|
898
|
-
# @!
|
899
|
-
#
|
900
|
-
#
|
901
|
-
#
|
902
|
-
#
|
903
|
-
#
|
904
|
-
#
|
905
|
-
#
|
906
|
-
#
|
907
|
-
#
|
908
|
-
#
|
909
|
-
#
|
910
|
-
#
|
911
|
-
#
|
912
|
-
#
|
913
|
-
#
|
914
|
-
#
|
915
|
-
# super
|
916
|
-
# end
|
917
|
-
|
918
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
877
|
+
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage)
|
878
|
+
# Some parameter documentations has been truncated, see
|
879
|
+
# {Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Usage} for more
|
880
|
+
# details.
|
881
|
+
#
|
882
|
+
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
883
|
+
#
|
884
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
|
885
|
+
#
|
886
|
+
# @param end_date [Time, nil] The end date of the discount interval.
|
887
|
+
#
|
888
|
+
# @param start_date [Time] The start date of the discount interval.
|
889
|
+
#
|
890
|
+
# @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
|
891
|
+
# ...
|
892
|
+
#
|
893
|
+
# @param discount_type [Symbol, :usage]
|
919
894
|
end
|
920
895
|
|
921
|
-
# @!
|
922
|
-
#
|
923
|
-
# def self.variants; end
|
896
|
+
# @!method self.variants
|
897
|
+
# @return [Array(Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Usage)]
|
924
898
|
end
|
925
899
|
|
926
900
|
class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
|
@@ -944,15 +918,11 @@ module Orb
|
|
944
918
|
# @return [Time]
|
945
919
|
required :start_date, Time
|
946
920
|
|
947
|
-
# @!
|
948
|
-
#
|
949
|
-
#
|
950
|
-
#
|
951
|
-
#
|
952
|
-
# #
|
953
|
-
# def initialize(end_date:, price_id:, quantity:, start_date:, **) = super
|
954
|
-
|
955
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
921
|
+
# @!method initialize(end_date:, price_id:, quantity:, start_date:)
|
922
|
+
# @param end_date [Time, nil]
|
923
|
+
# @param price_id [String]
|
924
|
+
# @param quantity [Float]
|
925
|
+
# @param start_date [Time]
|
956
926
|
end
|
957
927
|
|
958
928
|
class MaximumInterval < Orb::Internal::Type::BaseModel
|
@@ -987,16 +957,21 @@ module Orb
|
|
987
957
|
# @return [Time]
|
988
958
|
required :start_date, Time
|
989
959
|
|
990
|
-
# @!
|
991
|
-
#
|
992
|
-
#
|
993
|
-
#
|
994
|
-
#
|
995
|
-
#
|
996
|
-
#
|
997
|
-
#
|
998
|
-
|
999
|
-
#
|
960
|
+
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:)
|
961
|
+
# Some parameter documentations has been truncated, see
|
962
|
+
# {Orb::Models::SubscriptionUpdateTrialResponse::MaximumInterval} for more
|
963
|
+
# details.
|
964
|
+
#
|
965
|
+
# @param applies_to_price_ids [Array<String>] The price ids that this maximum interval applies to.
|
966
|
+
#
|
967
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this maximum interval applies to.
|
968
|
+
#
|
969
|
+
# @param end_date [Time, nil] The end date of the maximum interval.
|
970
|
+
#
|
971
|
+
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t
|
972
|
+
# ...
|
973
|
+
#
|
974
|
+
# @param start_date [Time] The start date of the maximum interval.
|
1000
975
|
end
|
1001
976
|
|
1002
977
|
class MinimumInterval < Orb::Internal::Type::BaseModel
|
@@ -1031,16 +1006,21 @@ module Orb
|
|
1031
1006
|
# @return [Time]
|
1032
1007
|
required :start_date, Time
|
1033
1008
|
|
1034
|
-
# @!
|
1035
|
-
#
|
1036
|
-
#
|
1037
|
-
#
|
1038
|
-
#
|
1039
|
-
#
|
1040
|
-
#
|
1041
|
-
#
|
1042
|
-
|
1043
|
-
#
|
1009
|
+
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:)
|
1010
|
+
# Some parameter documentations has been truncated, see
|
1011
|
+
# {Orb::Models::SubscriptionUpdateTrialResponse::MinimumInterval} for more
|
1012
|
+
# details.
|
1013
|
+
#
|
1014
|
+
# @param applies_to_price_ids [Array<String>] The price ids that this minimum interval applies to.
|
1015
|
+
#
|
1016
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this minimum interval applies to.
|
1017
|
+
#
|
1018
|
+
# @param end_date [Time, nil] The end date of the minimum interval.
|
1019
|
+
#
|
1020
|
+
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t
|
1021
|
+
# ...
|
1022
|
+
#
|
1023
|
+
# @param start_date [Time] The start date of the minimum interval.
|
1044
1024
|
end
|
1045
1025
|
|
1046
1026
|
# @see Orb::Models::SubscriptionUpdateTrialResponse#pending_subscription_change
|
@@ -1050,14 +1030,10 @@ module Orb
|
|
1050
1030
|
# @return [String]
|
1051
1031
|
required :id, String
|
1052
1032
|
|
1053
|
-
# @!
|
1054
|
-
#
|
1055
|
-
#
|
1056
|
-
#
|
1057
|
-
# #
|
1058
|
-
# def initialize(id:, **) = super
|
1059
|
-
|
1060
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1033
|
+
# @!method initialize(id:)
|
1034
|
+
# A pending subscription change if one exists on this subscription.
|
1035
|
+
#
|
1036
|
+
# @param id [String]
|
1061
1037
|
end
|
1062
1038
|
|
1063
1039
|
class PriceInterval < Orb::Internal::Type::BaseModel
|
@@ -1122,7 +1098,7 @@ module Orb
|
|
1122
1098
|
# For more on the types of prices, see
|
1123
1099
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1124
1100
|
#
|
1125
|
-
# @return [Orb::Models::Price::
|
1101
|
+
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk]
|
1126
1102
|
required :price, union: -> { Orb::Models::Price }
|
1127
1103
|
|
1128
1104
|
# @!attribute start_date
|
@@ -1139,39 +1115,40 @@ module Orb
|
|
1139
1115
|
# @return [Array<String>, nil]
|
1140
1116
|
required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
|
1141
1117
|
|
1142
|
-
# @!
|
1143
|
-
#
|
1144
|
-
#
|
1145
|
-
#
|
1146
|
-
#
|
1147
|
-
#
|
1148
|
-
#
|
1149
|
-
#
|
1150
|
-
#
|
1151
|
-
#
|
1152
|
-
#
|
1153
|
-
#
|
1154
|
-
#
|
1155
|
-
#
|
1156
|
-
#
|
1157
|
-
#
|
1158
|
-
#
|
1159
|
-
#
|
1160
|
-
#
|
1161
|
-
#
|
1162
|
-
#
|
1163
|
-
#
|
1164
|
-
#
|
1165
|
-
#
|
1166
|
-
#
|
1167
|
-
#
|
1168
|
-
#
|
1169
|
-
#
|
1170
|
-
#
|
1171
|
-
#
|
1172
|
-
#
|
1173
|
-
|
1174
|
-
#
|
1118
|
+
# @!method initialize(id:, billing_cycle_day:, current_billing_period_end_date:, current_billing_period_start_date:, end_date:, filter:, fixed_fee_quantity_transitions:, price:, start_date:, usage_customer_ids:)
|
1119
|
+
# Some parameter documentations has been truncated, see
|
1120
|
+
# {Orb::Models::SubscriptionUpdateTrialResponse::PriceInterval} for more details.
|
1121
|
+
#
|
1122
|
+
# The Price Interval resource represents a period of time for which a price will
|
1123
|
+
# bill on a subscription. A subscription’s price intervals define its billing
|
1124
|
+
# behavior.
|
1125
|
+
#
|
1126
|
+
# @param id [String]
|
1127
|
+
#
|
1128
|
+
# @param billing_cycle_day [Integer] The day of the month that Orb bills for this price
|
1129
|
+
#
|
1130
|
+
# @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
|
1131
|
+
# ...
|
1132
|
+
#
|
1133
|
+
# @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
|
1134
|
+
# ...
|
1135
|
+
#
|
1136
|
+
# @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for
|
1137
|
+
# ...
|
1138
|
+
#
|
1139
|
+
# @param filter [String, nil] An additional filter to apply to usage queries.
|
1140
|
+
#
|
1141
|
+
# @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionUpdateTrialResponse::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
|
1142
|
+
# ...
|
1143
|
+
#
|
1144
|
+
# @param price [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk] The Price resource represents a price that can be billed on a subscription, resu
|
1145
|
+
# ...
|
1146
|
+
#
|
1147
|
+
# @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
|
1148
|
+
# ...
|
1149
|
+
#
|
1150
|
+
# @param usage_customer_ids [Array<String>, nil] A list of customer IDs whose usage events will be aggregated and billed under th
|
1151
|
+
# ...
|
1175
1152
|
|
1176
1153
|
class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
|
1177
1154
|
# @!attribute effective_date
|
@@ -1189,14 +1166,10 @@ module Orb
|
|
1189
1166
|
# @return [Integer]
|
1190
1167
|
required :quantity, Integer
|
1191
1168
|
|
1192
|
-
# @!
|
1193
|
-
#
|
1194
|
-
#
|
1195
|
-
#
|
1196
|
-
# #
|
1197
|
-
# def initialize(effective_date:, price_id:, quantity:, **) = super
|
1198
|
-
|
1199
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1169
|
+
# @!method initialize(effective_date:, price_id:, quantity:)
|
1170
|
+
# @param effective_date [Time]
|
1171
|
+
# @param price_id [String]
|
1172
|
+
# @param quantity [Integer]
|
1200
1173
|
end
|
1201
1174
|
end
|
1202
1175
|
|
@@ -1217,14 +1190,10 @@ module Orb
|
|
1217
1190
|
# @return [Time]
|
1218
1191
|
required :start_date, Time
|
1219
1192
|
|
1220
|
-
# @!
|
1221
|
-
#
|
1222
|
-
#
|
1223
|
-
#
|
1224
|
-
# #
|
1225
|
-
# def initialize(coupon_id:, end_date:, start_date:, **) = super
|
1226
|
-
|
1227
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1193
|
+
# @!method initialize(coupon_id:, end_date:, start_date:)
|
1194
|
+
# @param coupon_id [String]
|
1195
|
+
# @param end_date [Time, nil]
|
1196
|
+
# @param start_date [Time]
|
1228
1197
|
end
|
1229
1198
|
|
1230
1199
|
# @see Orb::Models::SubscriptionUpdateTrialResponse#status
|
@@ -1235,11 +1204,8 @@ module Orb
|
|
1235
1204
|
ENDED = :ended
|
1236
1205
|
UPCOMING = :upcoming
|
1237
1206
|
|
1238
|
-
|
1239
|
-
|
1240
|
-
# @!parse
|
1241
|
-
# # @return [Array<Symbol>]
|
1242
|
-
# def self.values; end
|
1207
|
+
# @!method self.values
|
1208
|
+
# @return [Array<Symbol>]
|
1243
1209
|
end
|
1244
1210
|
|
1245
1211
|
# @see Orb::Models::SubscriptionUpdateTrialResponse#trial_info
|
@@ -1249,12 +1215,8 @@ module Orb
|
|
1249
1215
|
# @return [Time, nil]
|
1250
1216
|
required :end_date, Time, nil?: true
|
1251
1217
|
|
1252
|
-
# @!
|
1253
|
-
#
|
1254
|
-
# #
|
1255
|
-
# def initialize(end_date:, **) = super
|
1256
|
-
|
1257
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1218
|
+
# @!method initialize(end_date:)
|
1219
|
+
# @param end_date [Time, nil]
|
1258
1220
|
end
|
1259
1221
|
|
1260
1222
|
# @see Orb::Models::SubscriptionUpdateTrialResponse#changed_resources
|
@@ -1283,19 +1245,18 @@ module Orb
|
|
1283
1245
|
# @return [Array<Orb::Models::Invoice>]
|
1284
1246
|
required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] }
|
1285
1247
|
|
1286
|
-
# @!
|
1287
|
-
#
|
1288
|
-
#
|
1289
|
-
#
|
1290
|
-
#
|
1291
|
-
#
|
1292
|
-
#
|
1293
|
-
#
|
1294
|
-
#
|
1295
|
-
#
|
1296
|
-
#
|
1297
|
-
|
1298
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1248
|
+
# @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:)
|
1249
|
+
# The resources that were changed as part of this operation. Only present when
|
1250
|
+
# fetched through the subscription changes API or if the
|
1251
|
+
# `include_changed_resources` parameter was passed in the request.
|
1252
|
+
#
|
1253
|
+
# @param created_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were created as part of this operation.
|
1254
|
+
#
|
1255
|
+
# @param created_invoices [Array<Orb::Models::Invoice>] The invoices that were created as part of this operation.
|
1256
|
+
#
|
1257
|
+
# @param voided_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were voided as part of this operation.
|
1258
|
+
#
|
1259
|
+
# @param voided_invoices [Array<Orb::Models::Invoice>] The invoices that were voided as part of this operation.
|
1299
1260
|
end
|
1300
1261
|
end
|
1301
1262
|
end
|