orb-billing 0.1.3 → 0.3.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/.ignore +2 -0
- data/CHANGELOG.md +65 -0
- data/README.md +61 -51
- data/lib/orb/client.rb +7 -6
- data/lib/orb/file_part.rb +55 -0
- data/lib/orb/internal/page.rb +37 -39
- data/lib/orb/internal/transport/base_client.rb +21 -11
- data/lib/orb/internal/transport/pooled_net_requester.rb +3 -3
- data/lib/orb/internal/type/array_of.rb +28 -2
- data/lib/orb/internal/type/base_model.rb +83 -21
- data/lib/orb/internal/type/base_page.rb +10 -1
- data/lib/orb/internal/type/boolean.rb +6 -0
- data/lib/orb/internal/type/converter.rb +28 -1
- data/lib/orb/internal/type/enum.rb +28 -8
- data/lib/orb/internal/type/{io_like.rb → file_input.rb} +35 -15
- data/lib/orb/internal/type/hash_of.rb +28 -2
- data/lib/orb/internal/type/request_parameters.rb +1 -2
- data/lib/orb/internal/type/union.rb +27 -4
- data/lib/orb/internal/type/unknown.rb +6 -0
- data/lib/orb/internal/util.rb +105 -70
- data/lib/orb/internal.rb +5 -2
- 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 +24 -29
- 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 +211 -252
- 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 +207 -250
- data/lib/orb/models/customer_update_params.rb +207 -250
- 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 +22 -26
- data/lib/orb/models/customers/cost_list_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_response.rb +22 -26
- 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 +300 -406
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +63 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +300 -406
- 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 +300 -406
- data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
- data/lib/orb/models/customers/credits/ledger_list_response.rb +300 -406
- 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 +589 -637
- 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 +584 -631
- 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 +247 -269
- 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 +250 -279
- data/lib/orb/models/plan_create_params.rb +1623 -1984
- 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 +2709 -3820
- 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 +343 -382
- data/lib/orb/models/subscription_cancel_params.rb +16 -16
- data/lib/orb/models/subscription_cancel_response.rb +339 -377
- data/lib/orb/models/subscription_change_apply_params.rb +7 -10
- data/lib/orb/models/subscription_change_apply_response.rb +365 -398
- data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
- data/lib/orb/models/subscription_change_cancel_response.rb +365 -398
- data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
- data/lib/orb/models/subscription_change_retrieve_response.rb +366 -398
- data/lib/orb/models/subscription_create_params.rb +3771 -4402
- data/lib/orb/models/subscription_create_response.rb +339 -377
- data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
- data/lib/orb/models/subscription_fetch_costs_response.rb +22 -26
- 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 +2018 -2472
- data/lib/orb/models/subscription_price_intervals_response.rb +342 -377
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +3764 -4392
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +342 -377
- data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
- data/lib/orb/models/subscription_trigger_phase_response.rb +341 -377
- data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +342 -377
- 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 +343 -377
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +343 -377
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +22 -33
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +342 -377
- 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 +341 -377
- 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/request_options.rb +3 -4
- data/lib/orb/resources/alerts.rb +48 -17
- data/lib/orb/resources/coupons/subscriptions.rb +9 -2
- data/lib/orb/resources/coupons.rb +25 -7
- 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 +108 -28
- 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 +135 -36
- 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 +7 -1
- data/lib/orb/resources/prices.rb +97 -22
- 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/client.rbi +7 -6
- data/rbi/lib/orb/file_part.rbi +34 -0
- data/rbi/lib/orb/internal/page.rbi +1 -0
- data/rbi/lib/orb/internal/transport/base_client.rbi +18 -3
- data/rbi/lib/orb/internal/type/array_of.rbi +15 -9
- data/rbi/lib/orb/internal/type/base_model.rbi +22 -0
- data/rbi/lib/orb/internal/type/base_page.rbi +2 -0
- data/rbi/lib/orb/internal/type/boolean.rbi +4 -5
- data/rbi/lib/orb/internal/type/converter.rbi +8 -0
- data/rbi/lib/orb/internal/type/enum.rbi +7 -6
- data/rbi/lib/orb/internal/type/{io_like.rbi → file_input.rbi} +9 -7
- data/rbi/lib/orb/internal/type/hash_of.rbi +15 -9
- data/rbi/lib/orb/internal/type/union.rbi +7 -0
- data/rbi/lib/orb/internal/type/unknown.rbi +4 -5
- data/rbi/lib/orb/internal/util.rbi +39 -19
- data/rbi/lib/orb/internal.rbi +1 -2
- data/rbi/lib/orb/models/alert.rbi +28 -8
- data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_disable_params.rbi +5 -2
- data/rbi/lib/orb/models/alert_enable_params.rbi +5 -2
- data/rbi/lib/orb/models/alert_list_params.rbi +6 -0
- data/rbi/lib/orb/models/alert_update_params.rbi +11 -4
- data/rbi/lib/orb/models/amount_discount.rbi +10 -4
- data/rbi/lib/orb/models/billable_metric.rbi +16 -3
- data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -1
- data/rbi/lib/orb/models/coupon.rbi +10 -3
- data/rbi/lib/orb/models/coupon_create_params.rbi +6 -3
- data/rbi/lib/orb/models/coupon_list_params.rbi +13 -3
- data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +8 -2
- data/rbi/lib/orb/models/credit_note.rbi +44 -12
- data/rbi/lib/orb/models/credit_note_create_params.rbi +15 -6
- data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customer.rbi +130 -11
- data/rbi/lib/orb/models/customer_create_params.rbi +142 -8
- data/rbi/lib/orb/models/customer_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +140 -8
- data/rbi/lib/orb/models/customer_update_params.rbi +140 -8
- data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +8 -4
- data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +18 -8
- data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +18 -8
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +9 -5
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +21 -4
- data/rbi/lib/orb/models/customers/cost_list_params.rbi +9 -5
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +21 -4
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +13 -3
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +1 -2
- data/rbi/lib/orb/models/customers/credit_list_params.rbi +13 -3
- data/rbi/lib/orb/models/customers/credit_list_response.rbi +1 -2
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +40 -6
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +6 -4
- data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +27 -4
- data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +8 -2
- data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +25 -4
- data/rbi/lib/orb/models/dimensional_price_group.rbi +11 -3
- data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -0
- data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +8 -2
- data/rbi/lib/orb/models/evaluate_price_group.rbi +8 -2
- data/rbi/lib/orb/models/event_deprecate_response.rbi +4 -2
- data/rbi/lib/orb/models/event_ingest_params.rbi +22 -5
- data/rbi/lib/orb/models/event_ingest_response.rbi +15 -4
- data/rbi/lib/orb/models/event_search_params.rbi +14 -2
- data/rbi/lib/orb/models/event_search_response.rbi +14 -3
- data/rbi/lib/orb/models/event_update_params.rbi +10 -3
- data/rbi/lib/orb/models/event_update_response.rbi +4 -2
- data/rbi/lib/orb/models/events/backfill_close_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_create_params.rbi +18 -0
- data/rbi/lib/orb/models/events/backfill_create_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_list_params.rbi +8 -2
- data/rbi/lib/orb/models/events/backfill_list_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_revert_response.rbi +14 -2
- data/rbi/lib/orb/models/events/event_volumes.rbi +6 -2
- data/rbi/lib/orb/models/events/volume_list_params.rbi +18 -2
- data/rbi/lib/orb/models/invoice.rbi +375 -46
- data/rbi/lib/orb/models/invoice_create_params.rbi +38 -6
- data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +375 -66
- data/rbi/lib/orb/models/invoice_issue_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +16 -2
- data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +141 -20
- data/rbi/lib/orb/models/invoice_list_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_update_params.rbi +7 -2
- data/rbi/lib/orb/models/item.rbi +1 -2
- data/rbi/lib/orb/models/item_create_params.rbi +5 -2
- data/rbi/lib/orb/models/item_list_params.rbi +8 -2
- data/rbi/lib/orb/models/item_update_params.rbi +1 -8
- data/rbi/lib/orb/models/metric_create_params.rbi +15 -2
- data/rbi/lib/orb/models/metric_list_params.rbi +3 -0
- data/rbi/lib/orb/models/metric_update_params.rbi +7 -2
- data/rbi/lib/orb/models/percentage_discount.rbi +11 -4
- data/rbi/lib/orb/models/plan.rbi +102 -15
- data/rbi/lib/orb/models/plan_create_params.rbi +997 -679
- data/rbi/lib/orb/models/plan_list_params.rbi +5 -1
- data/rbi/lib/orb/models/plan_update_params.rbi +11 -2
- data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +11 -2
- data/rbi/lib/orb/models/price.rbi +717 -688
- data/rbi/lib/orb/models/price_create_params.rbi +137 -53
- data/rbi/lib/orb/models/price_evaluate_params.rbi +10 -0
- data/rbi/lib/orb/models/price_list_params.rbi +8 -2
- data/rbi/lib/orb/models/price_update_params.rbi +7 -2
- data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +7 -2
- data/rbi/lib/orb/models/subscription.rbi +174 -11
- data/rbi/lib/orb/models/subscription_cancel_params.rbi +8 -5
- data/rbi/lib/orb/models/subscription_cancel_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_change_apply_params.rbi +7 -2
- data/rbi/lib/orb/models/subscription_change_apply_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_create_params.rbi +2282 -1536
- data/rbi/lib/orb/models/subscription_create_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +9 -5
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +21 -4
- data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -0
- data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +8 -2
- data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +13 -4
- data/rbi/lib/orb/models/subscription_list_params.rbi +4 -2
- data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +1228 -861
- data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +2288 -1544
- data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +10 -2
- data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +187 -20
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_update_params.rbi +15 -0
- data/rbi/lib/orb/models/subscription_update_trial_params.rbi +11 -5
- data/rbi/lib/orb/models/subscription_update_trial_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_usage.rbi +2 -16
- data/rbi/lib/orb/models/trial_discount.rbi +5 -1
- data/rbi/lib/orb/models/usage_discount.rbi +11 -3
- 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 +4 -0
- data/sig/orb/internal/type/base_model.rbs +12 -0
- data/sig/orb/internal/type/converter.rbs +4 -0
- data/sig/orb/internal/type/enum.rbs +4 -2
- data/sig/orb/internal/type/{io_like.rbs → file_input.rbs} +1 -1
- data/sig/orb/internal/type/hash_of.rbs +4 -0
- data/sig/orb/internal/type/union.rbs +4 -0
- data/sig/orb/internal/util.rbs +16 -12
- data/sig/orb/internal.rbs +1 -1
- metadata +9 -5
@@ -211,69 +211,76 @@ module Orb
|
|
211
211
|
-> { Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::ChangedResources },
|
212
212
|
nil?: true
|
213
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
|
-
#
|
275
|
-
|
276
|
-
#
|
214
|
+
# @!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)
|
215
|
+
# Some parameter documentations has been truncated, see
|
216
|
+
# {Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse} for more
|
217
|
+
# details.
|
218
|
+
#
|
219
|
+
# @param id [String]
|
220
|
+
#
|
221
|
+
# @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase
|
222
|
+
# ...
|
223
|
+
#
|
224
|
+
# @param adjustment_intervals [Array<Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval>] The adjustment intervals for this subscription sorted by the start_date of the a
|
225
|
+
# ...
|
226
|
+
#
|
227
|
+
# @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c
|
228
|
+
# ...
|
229
|
+
#
|
230
|
+
# @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::BillingCycleAnchorConfiguration]
|
231
|
+
#
|
232
|
+
# @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
|
233
|
+
# ...
|
234
|
+
#
|
235
|
+
# @param created_at [Time]
|
236
|
+
#
|
237
|
+
# @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
|
238
|
+
# ...
|
239
|
+
#
|
240
|
+
# @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
|
241
|
+
# ...
|
242
|
+
#
|
243
|
+
# @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
|
244
|
+
# ...
|
245
|
+
#
|
246
|
+
# @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
|
247
|
+
# ...
|
248
|
+
#
|
249
|
+
# @param discount_intervals [Array<Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::UsageDiscountInterval>] The discount intervals for this subscription sorted by the start_date.
|
250
|
+
#
|
251
|
+
# @param end_date [Time, nil] The date Orb stops billing for this subscription.
|
252
|
+
#
|
253
|
+
# @param fixed_fee_quantity_schedule [Array<Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::FixedFeeQuantitySchedule>]
|
254
|
+
#
|
255
|
+
# @param invoicing_threshold [String, nil]
|
256
|
+
#
|
257
|
+
# @param maximum_intervals [Array<Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::MaximumInterval>] The maximum intervals for this subscription sorted by the start_date.
|
258
|
+
#
|
259
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
260
|
+
# ...
|
261
|
+
#
|
262
|
+
# @param minimum_intervals [Array<Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
|
263
|
+
#
|
264
|
+
# @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
|
265
|
+
# ...
|
266
|
+
#
|
267
|
+
# @param pending_subscription_change [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
|
268
|
+
#
|
269
|
+
# @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
270
|
+
# ...
|
271
|
+
#
|
272
|
+
# @param price_intervals [Array<Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PriceInterval>] The price intervals for this subscription.
|
273
|
+
#
|
274
|
+
# @param redeemed_coupon [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::RedeemedCoupon, nil]
|
275
|
+
#
|
276
|
+
# @param start_date [Time] The date Orb starts billing for this subscription.
|
277
|
+
#
|
278
|
+
# @param status [Symbol, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::Status]
|
279
|
+
#
|
280
|
+
# @param trial_info [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::TrialInfo]
|
281
|
+
#
|
282
|
+
# @param changed_resources [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::ChangedResources, nil] The resources that were changed as part of this operation. Only present when fet
|
283
|
+
# ...
|
277
284
|
|
278
285
|
class AdjustmentInterval < Orb::Internal::Type::BaseModel
|
279
286
|
# @!attribute id
|
@@ -305,16 +312,16 @@ module Orb
|
|
305
312
|
# @return [Time]
|
306
313
|
required :start_date, Time
|
307
314
|
|
308
|
-
# @!
|
309
|
-
#
|
310
|
-
#
|
311
|
-
#
|
312
|
-
#
|
313
|
-
#
|
314
|
-
#
|
315
|
-
#
|
316
|
-
|
317
|
-
#
|
315
|
+
# @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:)
|
316
|
+
# @param id [String]
|
317
|
+
#
|
318
|
+
# @param adjustment [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment]
|
319
|
+
#
|
320
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval IDs that this adjustment applies to.
|
321
|
+
#
|
322
|
+
# @param end_date [Time, nil] The end date of the adjustment interval.
|
323
|
+
#
|
324
|
+
# @param start_date [Time] The start date of the adjustment interval.
|
318
325
|
|
319
326
|
# @see Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval#adjustment
|
320
327
|
module Adjustment
|
@@ -380,29 +387,26 @@ module Orb
|
|
380
387
|
# @return [Float]
|
381
388
|
required :usage_discount, Float
|
382
389
|
|
383
|
-
# @!
|
384
|
-
#
|
385
|
-
#
|
386
|
-
#
|
387
|
-
#
|
388
|
-
#
|
389
|
-
#
|
390
|
-
#
|
391
|
-
#
|
392
|
-
#
|
393
|
-
#
|
394
|
-
#
|
395
|
-
#
|
396
|
-
#
|
397
|
-
#
|
398
|
-
#
|
399
|
-
#
|
400
|
-
#
|
401
|
-
#
|
402
|
-
#
|
403
|
-
# end
|
404
|
-
|
405
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
390
|
+
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
391
|
+
# Some parameter documentations has been truncated, see
|
392
|
+
# {Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment}
|
393
|
+
# for more details.
|
394
|
+
#
|
395
|
+
# @param id [String]
|
396
|
+
#
|
397
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
398
|
+
#
|
399
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
400
|
+
# ...
|
401
|
+
#
|
402
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
403
|
+
#
|
404
|
+
# @param reason [String, nil] The reason for the adjustment.
|
405
|
+
#
|
406
|
+
# @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
|
407
|
+
# ...
|
408
|
+
#
|
409
|
+
# @param adjustment_type [Symbol, :usage_discount]
|
406
410
|
end
|
407
411
|
|
408
412
|
class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
|
@@ -448,29 +452,26 @@ module Orb
|
|
448
452
|
# @return [String, nil]
|
449
453
|
required :reason, String, nil?: true
|
450
454
|
|
451
|
-
# @!
|
452
|
-
#
|
453
|
-
#
|
454
|
-
#
|
455
|
-
#
|
456
|
-
#
|
457
|
-
#
|
458
|
-
#
|
459
|
-
#
|
460
|
-
#
|
461
|
-
#
|
462
|
-
#
|
463
|
-
#
|
464
|
-
#
|
465
|
-
#
|
466
|
-
#
|
467
|
-
#
|
468
|
-
#
|
469
|
-
#
|
470
|
-
#
|
471
|
-
# end
|
472
|
-
|
473
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
455
|
+
# @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
|
456
|
+
# Some parameter documentations has been truncated, see
|
457
|
+
# {Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment}
|
458
|
+
# for more details.
|
459
|
+
#
|
460
|
+
# @param id [String]
|
461
|
+
#
|
462
|
+
# @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
|
463
|
+
# ...
|
464
|
+
#
|
465
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
466
|
+
#
|
467
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
468
|
+
# ...
|
469
|
+
#
|
470
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
471
|
+
#
|
472
|
+
# @param reason [String, nil] The reason for the adjustment.
|
473
|
+
#
|
474
|
+
# @param adjustment_type [Symbol, :amount_discount]
|
474
475
|
end
|
475
476
|
|
476
477
|
class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
|
@@ -516,29 +517,26 @@ module Orb
|
|
516
517
|
# @return [String, nil]
|
517
518
|
required :reason, String, nil?: true
|
518
519
|
|
519
|
-
# @!
|
520
|
-
#
|
521
|
-
#
|
522
|
-
#
|
523
|
-
#
|
524
|
-
#
|
525
|
-
#
|
526
|
-
#
|
527
|
-
#
|
528
|
-
#
|
529
|
-
#
|
530
|
-
#
|
531
|
-
#
|
532
|
-
#
|
533
|
-
#
|
534
|
-
#
|
535
|
-
#
|
536
|
-
#
|
537
|
-
#
|
538
|
-
#
|
539
|
-
# end
|
540
|
-
|
541
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
520
|
+
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
|
521
|
+
# Some parameter documentations has been truncated, see
|
522
|
+
# {Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment}
|
523
|
+
# for more details.
|
524
|
+
#
|
525
|
+
# @param id [String]
|
526
|
+
#
|
527
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
528
|
+
#
|
529
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
530
|
+
# ...
|
531
|
+
#
|
532
|
+
# @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
|
533
|
+
# ...
|
534
|
+
#
|
535
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
536
|
+
#
|
537
|
+
# @param reason [String, nil] The reason for the adjustment.
|
538
|
+
#
|
539
|
+
# @param adjustment_type [Symbol, :percentage_discount]
|
542
540
|
end
|
543
541
|
|
544
542
|
class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel
|
@@ -590,31 +588,28 @@ module Orb
|
|
590
588
|
# @return [String, nil]
|
591
589
|
required :reason, String, nil?: true
|
592
590
|
|
593
|
-
# @!
|
594
|
-
#
|
595
|
-
#
|
596
|
-
#
|
597
|
-
#
|
598
|
-
#
|
599
|
-
#
|
600
|
-
#
|
601
|
-
#
|
602
|
-
#
|
603
|
-
#
|
604
|
-
#
|
605
|
-
#
|
606
|
-
#
|
607
|
-
#
|
608
|
-
#
|
609
|
-
#
|
610
|
-
#
|
611
|
-
#
|
612
|
-
#
|
613
|
-
#
|
614
|
-
#
|
615
|
-
# end
|
616
|
-
|
617
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
591
|
+
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
|
592
|
+
# Some parameter documentations has been truncated, see
|
593
|
+
# {Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment}
|
594
|
+
# for more details.
|
595
|
+
#
|
596
|
+
# @param id [String]
|
597
|
+
#
|
598
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
599
|
+
#
|
600
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
601
|
+
# ...
|
602
|
+
#
|
603
|
+
# @param item_id [String] The item ID that revenue from this minimum will be attributed to.
|
604
|
+
#
|
605
|
+
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
|
606
|
+
# ...
|
607
|
+
#
|
608
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
609
|
+
#
|
610
|
+
# @param reason [String, nil] The reason for the adjustment.
|
611
|
+
#
|
612
|
+
# @param adjustment_type [Symbol, :minimum]
|
618
613
|
end
|
619
614
|
|
620
615
|
class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel
|
@@ -660,34 +655,30 @@ module Orb
|
|
660
655
|
# @return [String, nil]
|
661
656
|
required :reason, String, nil?: true
|
662
657
|
|
663
|
-
# @!
|
664
|
-
#
|
665
|
-
#
|
666
|
-
#
|
667
|
-
#
|
668
|
-
#
|
669
|
-
#
|
670
|
-
#
|
671
|
-
#
|
672
|
-
#
|
673
|
-
#
|
674
|
-
#
|
675
|
-
#
|
676
|
-
#
|
677
|
-
#
|
678
|
-
#
|
679
|
-
#
|
680
|
-
#
|
681
|
-
#
|
682
|
-
#
|
683
|
-
# end
|
684
|
-
|
685
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
658
|
+
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
|
659
|
+
# Some parameter documentations has been truncated, see
|
660
|
+
# {Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment}
|
661
|
+
# for more details.
|
662
|
+
#
|
663
|
+
# @param id [String]
|
664
|
+
#
|
665
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
666
|
+
#
|
667
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
668
|
+
# ...
|
669
|
+
#
|
670
|
+
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
|
671
|
+
# ...
|
672
|
+
#
|
673
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
674
|
+
#
|
675
|
+
# @param reason [String, nil] The reason for the adjustment.
|
676
|
+
#
|
677
|
+
# @param adjustment_type [Symbol, :maximum]
|
686
678
|
end
|
687
679
|
|
688
|
-
# @!
|
689
|
-
#
|
690
|
-
# def self.variants; end
|
680
|
+
# @!method self.variants
|
681
|
+
# @return [Array(Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)]
|
691
682
|
end
|
692
683
|
end
|
693
684
|
|
@@ -717,14 +708,19 @@ module Orb
|
|
717
708
|
# @return [Integer, nil]
|
718
709
|
optional :year, Integer, nil?: true
|
719
710
|
|
720
|
-
# @!
|
721
|
-
#
|
722
|
-
#
|
723
|
-
#
|
724
|
-
#
|
725
|
-
#
|
726
|
-
|
727
|
-
#
|
711
|
+
# @!method initialize(day:, month: nil, year: nil)
|
712
|
+
# Some parameter documentations has been truncated, see
|
713
|
+
# {Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::BillingCycleAnchorConfiguration}
|
714
|
+
# for more details.
|
715
|
+
#
|
716
|
+
# @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
|
717
|
+
# ...
|
718
|
+
#
|
719
|
+
# @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore
|
720
|
+
# ...
|
721
|
+
#
|
722
|
+
# @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc
|
723
|
+
# ...
|
728
724
|
end
|
729
725
|
|
730
726
|
module DiscountInterval
|
@@ -777,27 +773,18 @@ module Orb
|
|
777
773
|
# @return [Time]
|
778
774
|
required :start_date, Time
|
779
775
|
|
780
|
-
# @!
|
781
|
-
#
|
782
|
-
#
|
783
|
-
#
|
784
|
-
#
|
785
|
-
#
|
786
|
-
#
|
787
|
-
#
|
788
|
-
#
|
789
|
-
#
|
790
|
-
#
|
791
|
-
#
|
792
|
-
# end_date:,
|
793
|
-
# start_date:,
|
794
|
-
# discount_type: :amount,
|
795
|
-
# **
|
796
|
-
# )
|
797
|
-
# super
|
798
|
-
# end
|
799
|
-
|
800
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
776
|
+
# @!method initialize(amount_discount:, applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, discount_type: :amount)
|
777
|
+
# @param amount_discount [String] Only available if discount_type is `amount`.
|
778
|
+
#
|
779
|
+
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
780
|
+
#
|
781
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
|
782
|
+
#
|
783
|
+
# @param end_date [Time, nil] The end date of the discount interval.
|
784
|
+
#
|
785
|
+
# @param start_date [Time] The start date of the discount interval.
|
786
|
+
#
|
787
|
+
# @param discount_type [Symbol, :amount]
|
801
788
|
end
|
802
789
|
|
803
790
|
class PercentageDiscountInterval < Orb::Internal::Type::BaseModel
|
@@ -837,27 +824,23 @@ module Orb
|
|
837
824
|
# @return [Time]
|
838
825
|
required :start_date, Time
|
839
826
|
|
840
|
-
# @!
|
841
|
-
#
|
842
|
-
#
|
843
|
-
#
|
844
|
-
#
|
845
|
-
#
|
846
|
-
#
|
847
|
-
#
|
848
|
-
#
|
849
|
-
#
|
850
|
-
#
|
851
|
-
#
|
852
|
-
#
|
853
|
-
#
|
854
|
-
#
|
855
|
-
#
|
856
|
-
#
|
857
|
-
# super
|
858
|
-
# end
|
859
|
-
|
860
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
827
|
+
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage)
|
828
|
+
# Some parameter documentations has been truncated, see
|
829
|
+
# {Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::PercentageDiscountInterval}
|
830
|
+
# for more details.
|
831
|
+
#
|
832
|
+
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
833
|
+
#
|
834
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
|
835
|
+
#
|
836
|
+
# @param end_date [Time, nil] The end date of the discount interval.
|
837
|
+
#
|
838
|
+
# @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1
|
839
|
+
# ...
|
840
|
+
#
|
841
|
+
# @param start_date [Time] The start date of the discount interval.
|
842
|
+
#
|
843
|
+
# @param discount_type [Symbol, :percentage]
|
861
844
|
end
|
862
845
|
|
863
846
|
class UsageDiscountInterval < Orb::Internal::Type::BaseModel
|
@@ -897,32 +880,27 @@ module Orb
|
|
897
880
|
# @return [Float]
|
898
881
|
required :usage_discount, Float
|
899
882
|
|
900
|
-
# @!
|
901
|
-
#
|
902
|
-
#
|
903
|
-
#
|
904
|
-
#
|
905
|
-
#
|
906
|
-
#
|
907
|
-
#
|
908
|
-
#
|
909
|
-
#
|
910
|
-
#
|
911
|
-
#
|
912
|
-
#
|
913
|
-
#
|
914
|
-
#
|
915
|
-
#
|
916
|
-
#
|
917
|
-
# super
|
918
|
-
# end
|
919
|
-
|
920
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
883
|
+
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage)
|
884
|
+
# Some parameter documentations has been truncated, see
|
885
|
+
# {Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::UsageDiscountInterval}
|
886
|
+
# for more details.
|
887
|
+
#
|
888
|
+
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
889
|
+
#
|
890
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
|
891
|
+
#
|
892
|
+
# @param end_date [Time, nil] The end date of the discount interval.
|
893
|
+
#
|
894
|
+
# @param start_date [Time] The start date of the discount interval.
|
895
|
+
#
|
896
|
+
# @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
|
897
|
+
# ...
|
898
|
+
#
|
899
|
+
# @param discount_type [Symbol, :usage]
|
921
900
|
end
|
922
901
|
|
923
|
-
# @!
|
924
|
-
#
|
925
|
-
# def self.variants; end
|
902
|
+
# @!method self.variants
|
903
|
+
# @return [Array(Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::UsageDiscountInterval)]
|
926
904
|
end
|
927
905
|
|
928
906
|
class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
|
@@ -946,15 +924,11 @@ module Orb
|
|
946
924
|
# @return [Time]
|
947
925
|
required :start_date, Time
|
948
926
|
|
949
|
-
# @!
|
950
|
-
#
|
951
|
-
#
|
952
|
-
#
|
953
|
-
#
|
954
|
-
# #
|
955
|
-
# def initialize(end_date:, price_id:, quantity:, start_date:, **) = super
|
956
|
-
|
957
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
927
|
+
# @!method initialize(end_date:, price_id:, quantity:, start_date:)
|
928
|
+
# @param end_date [Time, nil]
|
929
|
+
# @param price_id [String]
|
930
|
+
# @param quantity [Float]
|
931
|
+
# @param start_date [Time]
|
958
932
|
end
|
959
933
|
|
960
934
|
class MaximumInterval < Orb::Internal::Type::BaseModel
|
@@ -989,16 +963,21 @@ module Orb
|
|
989
963
|
# @return [Time]
|
990
964
|
required :start_date, Time
|
991
965
|
|
992
|
-
# @!
|
993
|
-
#
|
994
|
-
#
|
995
|
-
#
|
996
|
-
#
|
997
|
-
#
|
998
|
-
#
|
999
|
-
#
|
1000
|
-
|
1001
|
-
#
|
966
|
+
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:)
|
967
|
+
# Some parameter documentations has been truncated, see
|
968
|
+
# {Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::MaximumInterval}
|
969
|
+
# for more details.
|
970
|
+
#
|
971
|
+
# @param applies_to_price_ids [Array<String>] The price ids that this maximum interval applies to.
|
972
|
+
#
|
973
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this maximum interval applies to.
|
974
|
+
#
|
975
|
+
# @param end_date [Time, nil] The end date of the maximum interval.
|
976
|
+
#
|
977
|
+
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t
|
978
|
+
# ...
|
979
|
+
#
|
980
|
+
# @param start_date [Time] The start date of the maximum interval.
|
1002
981
|
end
|
1003
982
|
|
1004
983
|
class MinimumInterval < Orb::Internal::Type::BaseModel
|
@@ -1033,16 +1012,21 @@ module Orb
|
|
1033
1012
|
# @return [Time]
|
1034
1013
|
required :start_date, Time
|
1035
1014
|
|
1036
|
-
# @!
|
1037
|
-
#
|
1038
|
-
#
|
1039
|
-
#
|
1040
|
-
#
|
1041
|
-
#
|
1042
|
-
#
|
1043
|
-
#
|
1044
|
-
|
1045
|
-
#
|
1015
|
+
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:)
|
1016
|
+
# Some parameter documentations has been truncated, see
|
1017
|
+
# {Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::MinimumInterval}
|
1018
|
+
# for more details.
|
1019
|
+
#
|
1020
|
+
# @param applies_to_price_ids [Array<String>] The price ids that this minimum interval applies to.
|
1021
|
+
#
|
1022
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this minimum interval applies to.
|
1023
|
+
#
|
1024
|
+
# @param end_date [Time, nil] The end date of the minimum interval.
|
1025
|
+
#
|
1026
|
+
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t
|
1027
|
+
# ...
|
1028
|
+
#
|
1029
|
+
# @param start_date [Time] The start date of the minimum interval.
|
1046
1030
|
end
|
1047
1031
|
|
1048
1032
|
# @see Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse#pending_subscription_change
|
@@ -1052,14 +1036,10 @@ module Orb
|
|
1052
1036
|
# @return [String]
|
1053
1037
|
required :id, String
|
1054
1038
|
|
1055
|
-
# @!
|
1056
|
-
#
|
1057
|
-
#
|
1058
|
-
#
|
1059
|
-
# #
|
1060
|
-
# def initialize(id:, **) = super
|
1061
|
-
|
1062
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1039
|
+
# @!method initialize(id:)
|
1040
|
+
# A pending subscription change if one exists on this subscription.
|
1041
|
+
#
|
1042
|
+
# @param id [String]
|
1063
1043
|
end
|
1064
1044
|
|
1065
1045
|
class PriceInterval < Orb::Internal::Type::BaseModel
|
@@ -1141,39 +1121,41 @@ module Orb
|
|
1141
1121
|
# @return [Array<String>, nil]
|
1142
1122
|
required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
|
1143
1123
|
|
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
|
-
#
|
1175
|
-
|
1176
|
-
#
|
1124
|
+
# @!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:)
|
1125
|
+
# Some parameter documentations has been truncated, see
|
1126
|
+
# {Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PriceInterval}
|
1127
|
+
# for more details.
|
1128
|
+
#
|
1129
|
+
# The Price Interval resource represents a period of time for which a price will
|
1130
|
+
# bill on a subscription. A subscription’s price intervals define its billing
|
1131
|
+
# behavior.
|
1132
|
+
#
|
1133
|
+
# @param id [String]
|
1134
|
+
#
|
1135
|
+
# @param billing_cycle_day [Integer] The day of the month that Orb bills for this price
|
1136
|
+
#
|
1137
|
+
# @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
|
1138
|
+
# ...
|
1139
|
+
#
|
1140
|
+
# @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
|
1141
|
+
# ...
|
1142
|
+
#
|
1143
|
+
# @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for
|
1144
|
+
# ...
|
1145
|
+
#
|
1146
|
+
# @param filter [String, nil] An additional filter to apply to usage queries.
|
1147
|
+
#
|
1148
|
+
# @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
|
1149
|
+
# ...
|
1150
|
+
#
|
1151
|
+
# @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] The Price resource represents a price that can be billed on a subscription, resu
|
1152
|
+
# ...
|
1153
|
+
#
|
1154
|
+
# @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
|
1155
|
+
# ...
|
1156
|
+
#
|
1157
|
+
# @param usage_customer_ids [Array<String>, nil] A list of customer IDs whose usage events will be aggregated and billed under th
|
1158
|
+
# ...
|
1177
1159
|
|
1178
1160
|
class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
|
1179
1161
|
# @!attribute effective_date
|
@@ -1191,14 +1173,10 @@ module Orb
|
|
1191
1173
|
# @return [Integer]
|
1192
1174
|
required :quantity, Integer
|
1193
1175
|
|
1194
|
-
# @!
|
1195
|
-
#
|
1196
|
-
#
|
1197
|
-
#
|
1198
|
-
# #
|
1199
|
-
# def initialize(effective_date:, price_id:, quantity:, **) = super
|
1200
|
-
|
1201
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1176
|
+
# @!method initialize(effective_date:, price_id:, quantity:)
|
1177
|
+
# @param effective_date [Time]
|
1178
|
+
# @param price_id [String]
|
1179
|
+
# @param quantity [Integer]
|
1202
1180
|
end
|
1203
1181
|
end
|
1204
1182
|
|
@@ -1219,14 +1197,10 @@ module Orb
|
|
1219
1197
|
# @return [Time]
|
1220
1198
|
required :start_date, Time
|
1221
1199
|
|
1222
|
-
# @!
|
1223
|
-
#
|
1224
|
-
#
|
1225
|
-
#
|
1226
|
-
# #
|
1227
|
-
# def initialize(coupon_id:, end_date:, start_date:, **) = super
|
1228
|
-
|
1229
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1200
|
+
# @!method initialize(coupon_id:, end_date:, start_date:)
|
1201
|
+
# @param coupon_id [String]
|
1202
|
+
# @param end_date [Time, nil]
|
1203
|
+
# @param start_date [Time]
|
1230
1204
|
end
|
1231
1205
|
|
1232
1206
|
# @see Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse#status
|
@@ -1237,11 +1211,8 @@ module Orb
|
|
1237
1211
|
ENDED = :ended
|
1238
1212
|
UPCOMING = :upcoming
|
1239
1213
|
|
1240
|
-
|
1241
|
-
|
1242
|
-
# @!parse
|
1243
|
-
# # @return [Array<Symbol>]
|
1244
|
-
# def self.values; end
|
1214
|
+
# @!method self.values
|
1215
|
+
# @return [Array<Symbol>]
|
1245
1216
|
end
|
1246
1217
|
|
1247
1218
|
# @see Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse#trial_info
|
@@ -1251,12 +1222,8 @@ module Orb
|
|
1251
1222
|
# @return [Time, nil]
|
1252
1223
|
required :end_date, Time, nil?: true
|
1253
1224
|
|
1254
|
-
# @!
|
1255
|
-
#
|
1256
|
-
# #
|
1257
|
-
# def initialize(end_date:, **) = super
|
1258
|
-
|
1259
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1225
|
+
# @!method initialize(end_date:)
|
1226
|
+
# @param end_date [Time, nil]
|
1260
1227
|
end
|
1261
1228
|
|
1262
1229
|
# @see Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse#changed_resources
|
@@ -1285,19 +1252,18 @@ module Orb
|
|
1285
1252
|
# @return [Array<Orb::Models::Invoice>]
|
1286
1253
|
required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] }
|
1287
1254
|
|
1288
|
-
# @!
|
1289
|
-
#
|
1290
|
-
#
|
1291
|
-
#
|
1292
|
-
#
|
1293
|
-
#
|
1294
|
-
#
|
1295
|
-
#
|
1296
|
-
#
|
1297
|
-
#
|
1298
|
-
#
|
1299
|
-
|
1300
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1255
|
+
# @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:)
|
1256
|
+
# The resources that were changed as part of this operation. Only present when
|
1257
|
+
# fetched through the subscription changes API or if the
|
1258
|
+
# `include_changed_resources` parameter was passed in the request.
|
1259
|
+
#
|
1260
|
+
# @param created_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were created as part of this operation.
|
1261
|
+
#
|
1262
|
+
# @param created_invoices [Array<Orb::Models::Invoice>] The invoices that were created as part of this operation.
|
1263
|
+
#
|
1264
|
+
# @param voided_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were voided as part of this operation.
|
1265
|
+
#
|
1266
|
+
# @param voided_invoices [Array<Orb::Models::Invoice>] The invoices that were voided as part of this operation.
|
1301
1267
|
end
|
1302
1268
|
end
|
1303
1269
|
end
|