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
@@ -207,69 +207,75 @@ module Orb
|
|
207
207
|
# @return [Orb::Models::SubscriptionCreateResponse::ChangedResources, nil]
|
208
208
|
optional :changed_resources, -> { Orb::Models::SubscriptionCreateResponse::ChangedResources }, nil?: true
|
209
209
|
|
210
|
-
# @!
|
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
|
-
#
|
210
|
+
# @!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)
|
211
|
+
# Some parameter documentations has been truncated, see
|
212
|
+
# {Orb::Models::SubscriptionCreateResponse} for more details.
|
213
|
+
#
|
214
|
+
# @param id [String]
|
215
|
+
#
|
216
|
+
# @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase
|
217
|
+
# ...
|
218
|
+
#
|
219
|
+
# @param adjustment_intervals [Array<Orb::Models::SubscriptionCreateResponse::AdjustmentInterval>] The adjustment intervals for this subscription sorted by the start_date of the a
|
220
|
+
# ...
|
221
|
+
#
|
222
|
+
# @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c
|
223
|
+
# ...
|
224
|
+
#
|
225
|
+
# @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionCreateResponse::BillingCycleAnchorConfiguration]
|
226
|
+
#
|
227
|
+
# @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
|
228
|
+
# ...
|
229
|
+
#
|
230
|
+
# @param created_at [Time]
|
231
|
+
#
|
232
|
+
# @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
|
233
|
+
# ...
|
234
|
+
#
|
235
|
+
# @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
|
236
|
+
# ...
|
237
|
+
#
|
238
|
+
# @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
|
239
|
+
# ...
|
240
|
+
#
|
241
|
+
# @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
|
242
|
+
# ...
|
243
|
+
#
|
244
|
+
# @param discount_intervals [Array<Orb::Models::SubscriptionCreateResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionCreateResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionCreateResponse::DiscountInterval::UsageDiscountInterval>] The discount intervals for this subscription sorted by the start_date.
|
245
|
+
#
|
246
|
+
# @param end_date [Time, nil] The date Orb stops billing for this subscription.
|
247
|
+
#
|
248
|
+
# @param fixed_fee_quantity_schedule [Array<Orb::Models::SubscriptionCreateResponse::FixedFeeQuantitySchedule>]
|
249
|
+
#
|
250
|
+
# @param invoicing_threshold [String, nil]
|
251
|
+
#
|
252
|
+
# @param maximum_intervals [Array<Orb::Models::SubscriptionCreateResponse::MaximumInterval>] The maximum intervals for this subscription sorted by the start_date.
|
253
|
+
#
|
254
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
255
|
+
# ...
|
256
|
+
#
|
257
|
+
# @param minimum_intervals [Array<Orb::Models::SubscriptionCreateResponse::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
|
258
|
+
#
|
259
|
+
# @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
|
260
|
+
# ...
|
261
|
+
#
|
262
|
+
# @param pending_subscription_change [Orb::Models::SubscriptionCreateResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
|
263
|
+
#
|
264
|
+
# @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
265
|
+
# ...
|
266
|
+
#
|
267
|
+
# @param price_intervals [Array<Orb::Models::SubscriptionCreateResponse::PriceInterval>] The price intervals for this subscription.
|
268
|
+
#
|
269
|
+
# @param redeemed_coupon [Orb::Models::SubscriptionCreateResponse::RedeemedCoupon, nil]
|
270
|
+
#
|
271
|
+
# @param start_date [Time] The date Orb starts billing for this subscription.
|
272
|
+
#
|
273
|
+
# @param status [Symbol, Orb::Models::SubscriptionCreateResponse::Status]
|
274
|
+
#
|
275
|
+
# @param trial_info [Orb::Models::SubscriptionCreateResponse::TrialInfo]
|
276
|
+
#
|
277
|
+
# @param changed_resources [Orb::Models::SubscriptionCreateResponse::ChangedResources, nil] The resources that were changed as part of this operation. Only present when fet
|
278
|
+
# ...
|
273
279
|
|
274
280
|
class AdjustmentInterval < Orb::Internal::Type::BaseModel
|
275
281
|
# @!attribute id
|
@@ -301,16 +307,16 @@ module Orb
|
|
301
307
|
# @return [Time]
|
302
308
|
required :start_date, Time
|
303
309
|
|
304
|
-
# @!
|
305
|
-
#
|
306
|
-
#
|
307
|
-
#
|
308
|
-
#
|
309
|
-
#
|
310
|
-
#
|
311
|
-
#
|
312
|
-
|
313
|
-
#
|
310
|
+
# @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:)
|
311
|
+
# @param id [String]
|
312
|
+
#
|
313
|
+
# @param adjustment [Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment]
|
314
|
+
#
|
315
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval IDs that this adjustment applies to.
|
316
|
+
#
|
317
|
+
# @param end_date [Time, nil] The end date of the adjustment interval.
|
318
|
+
#
|
319
|
+
# @param start_date [Time] The start date of the adjustment interval.
|
314
320
|
|
315
321
|
# @see Orb::Models::SubscriptionCreateResponse::AdjustmentInterval#adjustment
|
316
322
|
module Adjustment
|
@@ -376,29 +382,26 @@ module Orb
|
|
376
382
|
# @return [Float]
|
377
383
|
required :usage_discount, Float
|
378
384
|
|
379
|
-
# @!
|
380
|
-
#
|
381
|
-
#
|
382
|
-
#
|
383
|
-
#
|
384
|
-
#
|
385
|
-
#
|
386
|
-
#
|
387
|
-
#
|
388
|
-
#
|
389
|
-
#
|
390
|
-
#
|
391
|
-
#
|
392
|
-
#
|
393
|
-
#
|
394
|
-
#
|
395
|
-
#
|
396
|
-
#
|
397
|
-
#
|
398
|
-
#
|
399
|
-
# end
|
400
|
-
|
401
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
385
|
+
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
386
|
+
# Some parameter documentations has been truncated, see
|
387
|
+
# {Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment}
|
388
|
+
# for more details.
|
389
|
+
#
|
390
|
+
# @param id [String]
|
391
|
+
#
|
392
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
393
|
+
#
|
394
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
395
|
+
# ...
|
396
|
+
#
|
397
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
398
|
+
#
|
399
|
+
# @param reason [String, nil] The reason for the adjustment.
|
400
|
+
#
|
401
|
+
# @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
|
402
|
+
# ...
|
403
|
+
#
|
404
|
+
# @param adjustment_type [Symbol, :usage_discount]
|
402
405
|
end
|
403
406
|
|
404
407
|
class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
|
@@ -444,29 +447,26 @@ module Orb
|
|
444
447
|
# @return [String, nil]
|
445
448
|
required :reason, String, nil?: true
|
446
449
|
|
447
|
-
# @!
|
448
|
-
#
|
449
|
-
#
|
450
|
-
#
|
451
|
-
#
|
452
|
-
#
|
453
|
-
#
|
454
|
-
#
|
455
|
-
#
|
456
|
-
#
|
457
|
-
#
|
458
|
-
#
|
459
|
-
#
|
460
|
-
#
|
461
|
-
#
|
462
|
-
#
|
463
|
-
#
|
464
|
-
#
|
465
|
-
#
|
466
|
-
#
|
467
|
-
# end
|
468
|
-
|
469
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
450
|
+
# @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
|
451
|
+
# Some parameter documentations has been truncated, see
|
452
|
+
# {Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment}
|
453
|
+
# for more details.
|
454
|
+
#
|
455
|
+
# @param id [String]
|
456
|
+
#
|
457
|
+
# @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
|
458
|
+
# ...
|
459
|
+
#
|
460
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
461
|
+
#
|
462
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
463
|
+
# ...
|
464
|
+
#
|
465
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
466
|
+
#
|
467
|
+
# @param reason [String, nil] The reason for the adjustment.
|
468
|
+
#
|
469
|
+
# @param adjustment_type [Symbol, :amount_discount]
|
470
470
|
end
|
471
471
|
|
472
472
|
class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
|
@@ -512,29 +512,26 @@ module Orb
|
|
512
512
|
# @return [String, nil]
|
513
513
|
required :reason, String, nil?: true
|
514
514
|
|
515
|
-
# @!
|
516
|
-
#
|
517
|
-
#
|
518
|
-
#
|
519
|
-
#
|
520
|
-
#
|
521
|
-
#
|
522
|
-
#
|
523
|
-
#
|
524
|
-
#
|
525
|
-
#
|
526
|
-
#
|
527
|
-
#
|
528
|
-
#
|
529
|
-
#
|
530
|
-
#
|
531
|
-
#
|
532
|
-
#
|
533
|
-
#
|
534
|
-
#
|
535
|
-
# end
|
536
|
-
|
537
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
515
|
+
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
|
516
|
+
# Some parameter documentations has been truncated, see
|
517
|
+
# {Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment}
|
518
|
+
# for more details.
|
519
|
+
#
|
520
|
+
# @param id [String]
|
521
|
+
#
|
522
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
523
|
+
#
|
524
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
525
|
+
# ...
|
526
|
+
#
|
527
|
+
# @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
|
528
|
+
# ...
|
529
|
+
#
|
530
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
531
|
+
#
|
532
|
+
# @param reason [String, nil] The reason for the adjustment.
|
533
|
+
#
|
534
|
+
# @param adjustment_type [Symbol, :percentage_discount]
|
538
535
|
end
|
539
536
|
|
540
537
|
class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel
|
@@ -586,31 +583,28 @@ module Orb
|
|
586
583
|
# @return [String, nil]
|
587
584
|
required :reason, String, nil?: true
|
588
585
|
|
589
|
-
# @!
|
590
|
-
#
|
591
|
-
#
|
592
|
-
#
|
593
|
-
#
|
594
|
-
#
|
595
|
-
#
|
596
|
-
#
|
597
|
-
#
|
598
|
-
#
|
599
|
-
#
|
600
|
-
#
|
601
|
-
#
|
602
|
-
#
|
603
|
-
#
|
604
|
-
#
|
605
|
-
#
|
606
|
-
#
|
607
|
-
#
|
608
|
-
#
|
609
|
-
#
|
610
|
-
#
|
611
|
-
# end
|
612
|
-
|
613
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
586
|
+
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
|
587
|
+
# Some parameter documentations has been truncated, see
|
588
|
+
# {Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment}
|
589
|
+
# for more details.
|
590
|
+
#
|
591
|
+
# @param id [String]
|
592
|
+
#
|
593
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
594
|
+
#
|
595
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
596
|
+
# ...
|
597
|
+
#
|
598
|
+
# @param item_id [String] The item ID that revenue from this minimum will be attributed to.
|
599
|
+
#
|
600
|
+
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
|
601
|
+
# ...
|
602
|
+
#
|
603
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
604
|
+
#
|
605
|
+
# @param reason [String, nil] The reason for the adjustment.
|
606
|
+
#
|
607
|
+
# @param adjustment_type [Symbol, :minimum]
|
614
608
|
end
|
615
609
|
|
616
610
|
class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel
|
@@ -656,34 +650,30 @@ module Orb
|
|
656
650
|
# @return [String, nil]
|
657
651
|
required :reason, String, nil?: true
|
658
652
|
|
659
|
-
# @!
|
660
|
-
#
|
661
|
-
#
|
662
|
-
#
|
663
|
-
#
|
664
|
-
#
|
665
|
-
#
|
666
|
-
#
|
667
|
-
#
|
668
|
-
#
|
669
|
-
#
|
670
|
-
#
|
671
|
-
#
|
672
|
-
#
|
673
|
-
#
|
674
|
-
#
|
675
|
-
#
|
676
|
-
#
|
677
|
-
#
|
678
|
-
#
|
679
|
-
# end
|
680
|
-
|
681
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
653
|
+
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
|
654
|
+
# Some parameter documentations has been truncated, see
|
655
|
+
# {Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment}
|
656
|
+
# for more details.
|
657
|
+
#
|
658
|
+
# @param id [String]
|
659
|
+
#
|
660
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
661
|
+
#
|
662
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
663
|
+
# ...
|
664
|
+
#
|
665
|
+
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
|
666
|
+
# ...
|
667
|
+
#
|
668
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
669
|
+
#
|
670
|
+
# @param reason [String, nil] The reason for the adjustment.
|
671
|
+
#
|
672
|
+
# @param adjustment_type [Symbol, :maximum]
|
682
673
|
end
|
683
674
|
|
684
|
-
# @!
|
685
|
-
#
|
686
|
-
# def self.variants; end
|
675
|
+
# @!method self.variants
|
676
|
+
# @return [Array(Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)]
|
687
677
|
end
|
688
678
|
end
|
689
679
|
|
@@ -713,14 +703,19 @@ module Orb
|
|
713
703
|
# @return [Integer, nil]
|
714
704
|
optional :year, Integer, nil?: true
|
715
705
|
|
716
|
-
# @!
|
717
|
-
#
|
718
|
-
#
|
719
|
-
#
|
720
|
-
#
|
721
|
-
#
|
722
|
-
|
723
|
-
#
|
706
|
+
# @!method initialize(day:, month: nil, year: nil)
|
707
|
+
# Some parameter documentations has been truncated, see
|
708
|
+
# {Orb::Models::SubscriptionCreateResponse::BillingCycleAnchorConfiguration} for
|
709
|
+
# more details.
|
710
|
+
#
|
711
|
+
# @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
|
712
|
+
# ...
|
713
|
+
#
|
714
|
+
# @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore
|
715
|
+
# ...
|
716
|
+
#
|
717
|
+
# @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc
|
718
|
+
# ...
|
724
719
|
end
|
725
720
|
|
726
721
|
module DiscountInterval
|
@@ -771,27 +766,18 @@ module Orb
|
|
771
766
|
# @return [Time]
|
772
767
|
required :start_date, Time
|
773
768
|
|
774
|
-
# @!
|
775
|
-
#
|
776
|
-
#
|
777
|
-
#
|
778
|
-
#
|
779
|
-
#
|
780
|
-
#
|
781
|
-
#
|
782
|
-
#
|
783
|
-
#
|
784
|
-
#
|
785
|
-
#
|
786
|
-
# end_date:,
|
787
|
-
# start_date:,
|
788
|
-
# discount_type: :amount,
|
789
|
-
# **
|
790
|
-
# )
|
791
|
-
# super
|
792
|
-
# end
|
793
|
-
|
794
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
769
|
+
# @!method initialize(amount_discount:, applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, discount_type: :amount)
|
770
|
+
# @param amount_discount [String] Only available if discount_type is `amount`.
|
771
|
+
#
|
772
|
+
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
773
|
+
#
|
774
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
|
775
|
+
#
|
776
|
+
# @param end_date [Time, nil] The end date of the discount interval.
|
777
|
+
#
|
778
|
+
# @param start_date [Time] The start date of the discount interval.
|
779
|
+
#
|
780
|
+
# @param discount_type [Symbol, :amount]
|
795
781
|
end
|
796
782
|
|
797
783
|
class PercentageDiscountInterval < Orb::Internal::Type::BaseModel
|
@@ -831,27 +817,23 @@ module Orb
|
|
831
817
|
# @return [Time]
|
832
818
|
required :start_date, Time
|
833
819
|
|
834
|
-
# @!
|
835
|
-
#
|
836
|
-
#
|
837
|
-
#
|
838
|
-
#
|
839
|
-
#
|
840
|
-
#
|
841
|
-
#
|
842
|
-
#
|
843
|
-
#
|
844
|
-
#
|
845
|
-
#
|
846
|
-
#
|
847
|
-
#
|
848
|
-
#
|
849
|
-
#
|
850
|
-
#
|
851
|
-
# super
|
852
|
-
# end
|
853
|
-
|
854
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
820
|
+
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage)
|
821
|
+
# Some parameter documentations has been truncated, see
|
822
|
+
# {Orb::Models::SubscriptionCreateResponse::DiscountInterval::PercentageDiscountInterval}
|
823
|
+
# for more details.
|
824
|
+
#
|
825
|
+
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
826
|
+
#
|
827
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
|
828
|
+
#
|
829
|
+
# @param end_date [Time, nil] The end date of the discount interval.
|
830
|
+
#
|
831
|
+
# @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1
|
832
|
+
# ...
|
833
|
+
#
|
834
|
+
# @param start_date [Time] The start date of the discount interval.
|
835
|
+
#
|
836
|
+
# @param discount_type [Symbol, :percentage]
|
855
837
|
end
|
856
838
|
|
857
839
|
class UsageDiscountInterval < Orb::Internal::Type::BaseModel
|
@@ -891,32 +873,27 @@ module Orb
|
|
891
873
|
# @return [Float]
|
892
874
|
required :usage_discount, Float
|
893
875
|
|
894
|
-
# @!
|
895
|
-
#
|
896
|
-
#
|
897
|
-
#
|
898
|
-
#
|
899
|
-
#
|
900
|
-
#
|
901
|
-
#
|
902
|
-
#
|
903
|
-
#
|
904
|
-
#
|
905
|
-
#
|
906
|
-
#
|
907
|
-
#
|
908
|
-
#
|
909
|
-
#
|
910
|
-
#
|
911
|
-
# super
|
912
|
-
# end
|
913
|
-
|
914
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
876
|
+
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage)
|
877
|
+
# Some parameter documentations has been truncated, see
|
878
|
+
# {Orb::Models::SubscriptionCreateResponse::DiscountInterval::UsageDiscountInterval}
|
879
|
+
# for more details.
|
880
|
+
#
|
881
|
+
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
882
|
+
#
|
883
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
|
884
|
+
#
|
885
|
+
# @param end_date [Time, nil] The end date of the discount interval.
|
886
|
+
#
|
887
|
+
# @param start_date [Time] The start date of the discount interval.
|
888
|
+
#
|
889
|
+
# @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
|
890
|
+
# ...
|
891
|
+
#
|
892
|
+
# @param discount_type [Symbol, :usage]
|
915
893
|
end
|
916
894
|
|
917
|
-
# @!
|
918
|
-
#
|
919
|
-
# def self.variants; end
|
895
|
+
# @!method self.variants
|
896
|
+
# @return [Array(Orb::Models::SubscriptionCreateResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionCreateResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionCreateResponse::DiscountInterval::UsageDiscountInterval)]
|
920
897
|
end
|
921
898
|
|
922
899
|
class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
|
@@ -940,15 +917,11 @@ module Orb
|
|
940
917
|
# @return [Time]
|
941
918
|
required :start_date, Time
|
942
919
|
|
943
|
-
# @!
|
944
|
-
#
|
945
|
-
#
|
946
|
-
#
|
947
|
-
#
|
948
|
-
# #
|
949
|
-
# def initialize(end_date:, price_id:, quantity:, start_date:, **) = super
|
950
|
-
|
951
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
920
|
+
# @!method initialize(end_date:, price_id:, quantity:, start_date:)
|
921
|
+
# @param end_date [Time, nil]
|
922
|
+
# @param price_id [String]
|
923
|
+
# @param quantity [Float]
|
924
|
+
# @param start_date [Time]
|
952
925
|
end
|
953
926
|
|
954
927
|
class MaximumInterval < Orb::Internal::Type::BaseModel
|
@@ -983,16 +956,20 @@ module Orb
|
|
983
956
|
# @return [Time]
|
984
957
|
required :start_date, Time
|
985
958
|
|
986
|
-
# @!
|
987
|
-
#
|
988
|
-
#
|
989
|
-
#
|
990
|
-
#
|
991
|
-
#
|
992
|
-
#
|
993
|
-
#
|
994
|
-
|
995
|
-
#
|
959
|
+
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:)
|
960
|
+
# Some parameter documentations has been truncated, see
|
961
|
+
# {Orb::Models::SubscriptionCreateResponse::MaximumInterval} for more details.
|
962
|
+
#
|
963
|
+
# @param applies_to_price_ids [Array<String>] The price ids that this maximum interval applies to.
|
964
|
+
#
|
965
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this maximum interval applies to.
|
966
|
+
#
|
967
|
+
# @param end_date [Time, nil] The end date of the maximum interval.
|
968
|
+
#
|
969
|
+
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t
|
970
|
+
# ...
|
971
|
+
#
|
972
|
+
# @param start_date [Time] The start date of the maximum interval.
|
996
973
|
end
|
997
974
|
|
998
975
|
class MinimumInterval < Orb::Internal::Type::BaseModel
|
@@ -1027,16 +1004,20 @@ module Orb
|
|
1027
1004
|
# @return [Time]
|
1028
1005
|
required :start_date, Time
|
1029
1006
|
|
1030
|
-
# @!
|
1031
|
-
#
|
1032
|
-
#
|
1033
|
-
#
|
1034
|
-
#
|
1035
|
-
#
|
1036
|
-
#
|
1037
|
-
#
|
1038
|
-
|
1039
|
-
#
|
1007
|
+
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:)
|
1008
|
+
# Some parameter documentations has been truncated, see
|
1009
|
+
# {Orb::Models::SubscriptionCreateResponse::MinimumInterval} for more details.
|
1010
|
+
#
|
1011
|
+
# @param applies_to_price_ids [Array<String>] The price ids that this minimum interval applies to.
|
1012
|
+
#
|
1013
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this minimum interval applies to.
|
1014
|
+
#
|
1015
|
+
# @param end_date [Time, nil] The end date of the minimum interval.
|
1016
|
+
#
|
1017
|
+
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t
|
1018
|
+
# ...
|
1019
|
+
#
|
1020
|
+
# @param start_date [Time] The start date of the minimum interval.
|
1040
1021
|
end
|
1041
1022
|
|
1042
1023
|
# @see Orb::Models::SubscriptionCreateResponse#pending_subscription_change
|
@@ -1046,14 +1027,10 @@ module Orb
|
|
1046
1027
|
# @return [String]
|
1047
1028
|
required :id, String
|
1048
1029
|
|
1049
|
-
# @!
|
1050
|
-
#
|
1051
|
-
#
|
1052
|
-
#
|
1053
|
-
# #
|
1054
|
-
# def initialize(id:, **) = super
|
1055
|
-
|
1056
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1030
|
+
# @!method initialize(id:)
|
1031
|
+
# A pending subscription change if one exists on this subscription.
|
1032
|
+
#
|
1033
|
+
# @param id [String]
|
1057
1034
|
end
|
1058
1035
|
|
1059
1036
|
class PriceInterval < Orb::Internal::Type::BaseModel
|
@@ -1135,39 +1112,40 @@ module Orb
|
|
1135
1112
|
# @return [Array<String>, nil]
|
1136
1113
|
required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
|
1137
1114
|
|
1138
|
-
# @!
|
1139
|
-
#
|
1140
|
-
#
|
1141
|
-
#
|
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
|
-
#
|
1115
|
+
# @!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:)
|
1116
|
+
# Some parameter documentations has been truncated, see
|
1117
|
+
# {Orb::Models::SubscriptionCreateResponse::PriceInterval} for more details.
|
1118
|
+
#
|
1119
|
+
# The Price Interval resource represents a period of time for which a price will
|
1120
|
+
# bill on a subscription. A subscription’s price intervals define its billing
|
1121
|
+
# behavior.
|
1122
|
+
#
|
1123
|
+
# @param id [String]
|
1124
|
+
#
|
1125
|
+
# @param billing_cycle_day [Integer] The day of the month that Orb bills for this price
|
1126
|
+
#
|
1127
|
+
# @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
|
1128
|
+
# ...
|
1129
|
+
#
|
1130
|
+
# @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
|
1131
|
+
# ...
|
1132
|
+
#
|
1133
|
+
# @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for
|
1134
|
+
# ...
|
1135
|
+
#
|
1136
|
+
# @param filter [String, nil] An additional filter to apply to usage queries.
|
1137
|
+
#
|
1138
|
+
# @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionCreateResponse::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
|
1139
|
+
# ...
|
1140
|
+
#
|
1141
|
+
# @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
|
1142
|
+
# ...
|
1143
|
+
#
|
1144
|
+
# @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
|
1145
|
+
# ...
|
1146
|
+
#
|
1147
|
+
# @param usage_customer_ids [Array<String>, nil] A list of customer IDs whose usage events will be aggregated and billed under th
|
1148
|
+
# ...
|
1171
1149
|
|
1172
1150
|
class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
|
1173
1151
|
# @!attribute effective_date
|
@@ -1185,14 +1163,10 @@ module Orb
|
|
1185
1163
|
# @return [Integer]
|
1186
1164
|
required :quantity, Integer
|
1187
1165
|
|
1188
|
-
# @!
|
1189
|
-
#
|
1190
|
-
#
|
1191
|
-
#
|
1192
|
-
# #
|
1193
|
-
# def initialize(effective_date:, price_id:, quantity:, **) = super
|
1194
|
-
|
1195
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1166
|
+
# @!method initialize(effective_date:, price_id:, quantity:)
|
1167
|
+
# @param effective_date [Time]
|
1168
|
+
# @param price_id [String]
|
1169
|
+
# @param quantity [Integer]
|
1196
1170
|
end
|
1197
1171
|
end
|
1198
1172
|
|
@@ -1213,14 +1187,10 @@ module Orb
|
|
1213
1187
|
# @return [Time]
|
1214
1188
|
required :start_date, Time
|
1215
1189
|
|
1216
|
-
# @!
|
1217
|
-
#
|
1218
|
-
#
|
1219
|
-
#
|
1220
|
-
# #
|
1221
|
-
# def initialize(coupon_id:, end_date:, start_date:, **) = super
|
1222
|
-
|
1223
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1190
|
+
# @!method initialize(coupon_id:, end_date:, start_date:)
|
1191
|
+
# @param coupon_id [String]
|
1192
|
+
# @param end_date [Time, nil]
|
1193
|
+
# @param start_date [Time]
|
1224
1194
|
end
|
1225
1195
|
|
1226
1196
|
# @see Orb::Models::SubscriptionCreateResponse#status
|
@@ -1231,11 +1201,8 @@ module Orb
|
|
1231
1201
|
ENDED = :ended
|
1232
1202
|
UPCOMING = :upcoming
|
1233
1203
|
|
1234
|
-
|
1235
|
-
|
1236
|
-
# @!parse
|
1237
|
-
# # @return [Array<Symbol>]
|
1238
|
-
# def self.values; end
|
1204
|
+
# @!method self.values
|
1205
|
+
# @return [Array<Symbol>]
|
1239
1206
|
end
|
1240
1207
|
|
1241
1208
|
# @see Orb::Models::SubscriptionCreateResponse#trial_info
|
@@ -1245,12 +1212,8 @@ module Orb
|
|
1245
1212
|
# @return [Time, nil]
|
1246
1213
|
required :end_date, Time, nil?: true
|
1247
1214
|
|
1248
|
-
# @!
|
1249
|
-
#
|
1250
|
-
# #
|
1251
|
-
# def initialize(end_date:, **) = super
|
1252
|
-
|
1253
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1215
|
+
# @!method initialize(end_date:)
|
1216
|
+
# @param end_date [Time, nil]
|
1254
1217
|
end
|
1255
1218
|
|
1256
1219
|
# @see Orb::Models::SubscriptionCreateResponse#changed_resources
|
@@ -1279,19 +1242,18 @@ module Orb
|
|
1279
1242
|
# @return [Array<Orb::Models::Invoice>]
|
1280
1243
|
required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] }
|
1281
1244
|
|
1282
|
-
# @!
|
1283
|
-
#
|
1284
|
-
#
|
1285
|
-
#
|
1286
|
-
#
|
1287
|
-
#
|
1288
|
-
#
|
1289
|
-
#
|
1290
|
-
#
|
1291
|
-
#
|
1292
|
-
#
|
1293
|
-
|
1294
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1245
|
+
# @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:)
|
1246
|
+
# The resources that were changed as part of this operation. Only present when
|
1247
|
+
# fetched through the subscription changes API or if the
|
1248
|
+
# `include_changed_resources` parameter was passed in the request.
|
1249
|
+
#
|
1250
|
+
# @param created_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were created as part of this operation.
|
1251
|
+
#
|
1252
|
+
# @param created_invoices [Array<Orb::Models::Invoice>] The invoices that were created as part of this operation.
|
1253
|
+
#
|
1254
|
+
# @param voided_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were voided as part of this operation.
|
1255
|
+
#
|
1256
|
+
# @param voided_invoices [Array<Orb::Models::Invoice>] The invoices that were voided as part of this operation.
|
1295
1257
|
end
|
1296
1258
|
end
|
1297
1259
|
end
|