orb-billing 0.3.1 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +35 -0
- data/README.md +3 -3
- data/lib/orb/errors.rb +1 -1
- data/lib/orb/file_part.rb +2 -2
- data/lib/orb/internal/transport/base_client.rb +74 -5
- data/lib/orb/internal/transport/pooled_net_requester.rb +14 -0
- data/lib/orb/internal/type/array_of.rb +1 -1
- data/lib/orb/internal/type/base_model.rb +62 -30
- data/lib/orb/internal/type/converter.rb +18 -0
- data/lib/orb/internal/type/enum.rb +4 -3
- data/lib/orb/internal/type/hash_of.rb +1 -1
- data/lib/orb/internal/type/request_parameters.rb +4 -4
- data/lib/orb/internal/type/union.rb +5 -4
- data/lib/orb/internal/util.rb +57 -1
- data/lib/orb/internal.rb +6 -0
- data/lib/orb/models/alert.rb +29 -32
- data/lib/orb/models/alert_create_for_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_external_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_subscription_params.rb +7 -8
- data/lib/orb/models/alert_list_params.rb +0 -1
- data/lib/orb/models/alert_update_params.rb +4 -5
- data/lib/orb/models/amount_discount.rb +6 -7
- data/lib/orb/models/billable_metric.rb +9 -11
- data/lib/orb/models/coupon.rb +13 -12
- data/lib/orb/models/coupon_create_params.rb +12 -8
- data/lib/orb/models/coupon_list_params.rb +0 -2
- data/lib/orb/models/coupons/subscription_list_params.rb +0 -1
- data/lib/orb/models/credit_note.rb +48 -46
- data/lib/orb/models/credit_note_create_params.rb +6 -6
- data/lib/orb/models/credit_note_list_params.rb +0 -1
- data/lib/orb/models/customer.rb +54 -61
- data/lib/orb/models/customer_create_params.rb +50 -53
- data/lib/orb/models/customer_list_params.rb +0 -1
- data/lib/orb/models/customer_update_by_external_id_params.rb +50 -53
- data/lib/orb/models/customer_update_params.rb +50 -51
- data/lib/orb/models/customers/balance_transaction_create_params.rb +3 -3
- data/lib/orb/models/customers/balance_transaction_create_response.rb +0 -2
- data/lib/orb/models/customers/balance_transaction_list_params.rb +0 -1
- data/lib/orb/models/customers/balance_transaction_list_response.rb +0 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -3
- data/lib/orb/models/customers/cost_list_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_response.rb +3 -3
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +0 -2
- data/lib/orb/models/customers/credit_list_params.rb +0 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +12 -21
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +14 -7
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +11 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +14 -7
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +6 -7
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +14 -7
- data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
- data/lib/orb/models/customers/credits/ledger_list_response.rb +14 -7
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +10 -15
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_create_params.rb +7 -15
- data/lib/orb/models/customers/credits/top_up_create_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_response.rb +0 -6
- data/lib/orb/models/dimensional_price_group.rb +1 -3
- data/lib/orb/models/dimensional_price_group_create_params.rb +0 -1
- data/lib/orb/models/dimensional_price_group_list_params.rb +0 -1
- data/lib/orb/models/dimensional_price_groups.rb +6 -6
- data/lib/orb/models/discount.rb +11 -5
- data/lib/orb/models/evaluate_price_group.rb +5 -1
- data/lib/orb/models/event_ingest_params.rb +4 -9
- data/lib/orb/models/event_ingest_response.rb +0 -3
- data/lib/orb/models/event_search_params.rb +0 -3
- data/lib/orb/models/event_search_response.rb +0 -4
- data/lib/orb/models/event_update_params.rb +0 -3
- data/lib/orb/models/events/backfill_close_response.rb +0 -4
- data/lib/orb/models/events/backfill_create_params.rb +0 -7
- data/lib/orb/models/events/backfill_create_response.rb +0 -4
- data/lib/orb/models/events/backfill_fetch_response.rb +0 -4
- data/lib/orb/models/events/backfill_list_params.rb +0 -1
- data/lib/orb/models/events/backfill_list_response.rb +0 -4
- data/lib/orb/models/events/backfill_revert_response.rb +0 -4
- data/lib/orb/models/events/event_volumes.rb +3 -3
- data/lib/orb/models/events/volume_list_params.rb +0 -3
- data/lib/orb/models/invoice.rb +179 -202
- data/lib/orb/models/invoice_create_params.rb +14 -21
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +31 -54
- data/lib/orb/models/invoice_issue_params.rb +0 -1
- data/lib/orb/models/invoice_level_discount.rb +8 -4
- data/lib/orb/models/invoice_line_item_create_params.rb +0 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +28 -26
- data/lib/orb/models/invoice_list_params.rb +6 -10
- data/lib/orb/models/invoice_update_params.rb +0 -1
- data/lib/orb/models/item.rb +7 -8
- data/lib/orb/models/item_list_params.rb +0 -1
- data/lib/orb/models/item_update_params.rb +7 -7
- data/lib/orb/models/metric_create_params.rb +0 -1
- data/lib/orb/models/metric_list_params.rb +0 -1
- data/lib/orb/models/metric_update_params.rb +0 -1
- data/lib/orb/models/percentage_discount.rb +6 -8
- data/lib/orb/models/plan.rb +90 -103
- data/lib/orb/models/plan_create_params.rb +759 -800
- data/lib/orb/models/plan_list_params.rb +3 -4
- data/lib/orb/models/plan_update_params.rb +0 -2
- data/lib/orb/models/plans/external_plan_id_update_params.rb +0 -2
- data/lib/orb/models/price.rb +1706 -1724
- data/lib/orb/models/price_create_params.rb +75 -84
- data/lib/orb/models/price_evaluate_params.rb +0 -2
- data/lib/orb/models/price_evaluate_response.rb +3 -3
- data/lib/orb/models/price_list_params.rb +0 -1
- data/lib/orb/models/price_update_params.rb +0 -1
- data/lib/orb/models/prices/external_price_id_update_params.rb +0 -1
- data/lib/orb/models/subscription.rb +108 -122
- data/lib/orb/models/subscription_cancel_params.rb +3 -5
- data/lib/orb/models/subscription_cancel_response.rb +43 -57
- data/lib/orb/models/subscription_change_apply_response.rb +43 -58
- data/lib/orb/models/subscription_change_cancel_response.rb +43 -58
- data/lib/orb/models/subscription_change_retrieve_response.rb +43 -58
- data/lib/orb/models/subscription_create_params.rb +1953 -1815
- data/lib/orb/models/subscription_create_response.rb +43 -57
- data/lib/orb/models/subscription_fetch_costs_params.rb +3 -4
- data/lib/orb/models/subscription_fetch_costs_response.rb +3 -3
- data/lib/orb/models/subscription_fetch_schedule_params.rb +0 -1
- data/lib/orb/models/subscription_fetch_schedule_response.rb +0 -1
- data/lib/orb/models/subscription_fetch_usage_params.rb +6 -8
- data/lib/orb/models/subscription_list_params.rb +3 -4
- data/lib/orb/models/subscription_price_intervals_params.rb +1194 -1017
- data/lib/orb/models/subscription_price_intervals_response.rb +43 -57
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +1994 -1791
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +43 -57
- data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
- data/lib/orb/models/subscription_trigger_phase_response.rb +43 -57
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +43 -57
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +43 -57
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +43 -57
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +3 -6
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +43 -57
- data/lib/orb/models/subscription_update_params.rb +0 -5
- data/lib/orb/models/subscription_update_trial_params.rb +8 -6
- data/lib/orb/models/subscription_update_trial_response.rb +43 -57
- data/lib/orb/models/subscription_usage.rb +55 -39
- data/lib/orb/models/subscriptions.rb +6 -6
- data/lib/orb/models/trial_discount.rb +6 -7
- data/lib/orb/models/usage_discount.rb +6 -8
- data/lib/orb/models.rb +24 -0
- data/lib/orb/request_options.rb +4 -0
- data/lib/orb/resources/alerts.rb +30 -31
- data/lib/orb/resources/coupons/subscriptions.rb +3 -4
- data/lib/orb/resources/coupons.rb +11 -21
- data/lib/orb/resources/credit_notes.rb +10 -11
- data/lib/orb/resources/customers/balance_transactions.rb +3 -4
- data/lib/orb/resources/customers/costs.rb +4 -6
- data/lib/orb/resources/customers/credits/ledger.rb +14 -33
- data/lib/orb/resources/customers/credits/top_ups.rb +10 -20
- data/lib/orb/resources/customers/credits.rb +2 -6
- data/lib/orb/resources/customers.rb +40 -67
- data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +2 -2
- data/lib/orb/resources/dimensional_price_groups.rb +8 -10
- data/lib/orb/resources/events/backfills.rb +2 -10
- data/lib/orb/resources/events/volume.rb +3 -6
- data/lib/orb/resources/events.rb +4 -12
- data/lib/orb/resources/invoice_line_items.rb +1 -2
- data/lib/orb/resources/invoices.rb +26 -43
- data/lib/orb/resources/items.rb +12 -13
- data/lib/orb/resources/metrics.rb +11 -14
- data/lib/orb/resources/plans/external_plan_id.rb +5 -7
- data/lib/orb/resources/plans.rb +14 -23
- data/lib/orb/resources/prices/external_price_id.rb +5 -6
- data/lib/orb/resources/prices.rb +25 -35
- data/lib/orb/resources/subscription_changes.rb +1 -1
- data/lib/orb/resources/subscriptions.rb +49 -107
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +3 -0
- data/rbi/orb/client.rbi +5 -4
- data/rbi/orb/errors.rbi +59 -28
- data/rbi/orb/file_part.rbi +9 -6
- data/rbi/orb/internal/page.rbi +20 -6
- data/rbi/orb/internal/transport/base_client.rbi +159 -78
- data/rbi/orb/internal/transport/pooled_net_requester.rbi +27 -13
- data/rbi/orb/internal/type/array_of.rbi +42 -34
- data/rbi/orb/internal/type/base_model.rbi +144 -69
- data/rbi/orb/internal/type/base_page.rbi +12 -8
- data/rbi/orb/internal/type/boolean.rbi +16 -10
- data/rbi/orb/internal/type/converter.rbi +68 -31
- data/rbi/orb/internal/type/enum.rbi +28 -15
- data/rbi/orb/internal/type/file_input.rbi +12 -10
- data/rbi/orb/internal/type/hash_of.rbi +34 -24
- data/rbi/orb/internal/type/request_parameters.rbi +12 -4
- data/rbi/orb/internal/type/union.rbi +61 -25
- data/rbi/orb/internal/type/unknown.rbi +20 -12
- data/rbi/orb/internal/util.rbi +232 -90
- data/rbi/orb/internal.rbi +2 -0
- data/rbi/orb/models/alert.rbi +114 -70
- data/rbi/orb/models/alert_create_for_customer_params.rbi +69 -27
- data/rbi/orb/models/alert_create_for_external_customer_params.rbi +80 -29
- data/rbi/orb/models/alert_create_for_subscription_params.rbi +62 -26
- data/rbi/orb/models/alert_disable_params.rbi +18 -6
- data/rbi/orb/models/alert_enable_params.rbi +18 -6
- data/rbi/orb/models/alert_list_params.rbi +24 -20
- data/rbi/orb/models/alert_retrieve_params.rbi +11 -4
- data/rbi/orb/models/alert_update_params.rbi +29 -14
- data/rbi/orb/models/amount_discount.rbi +29 -19
- data/rbi/orb/models/billable_metric.rbi +34 -26
- data/rbi/orb/models/billing_cycle_relative_date.rbi +11 -5
- data/rbi/orb/models/coupon.rbi +28 -20
- data/rbi/orb/models/coupon_archive_params.rbi +11 -4
- data/rbi/orb/models/coupon_create_params.rbi +85 -38
- data/rbi/orb/models/coupon_fetch_params.rbi +11 -4
- data/rbi/orb/models/coupon_list_params.rbi +19 -15
- data/rbi/orb/models/coupons/subscription_list_params.rbi +19 -6
- data/rbi/orb/models/credit_note.rbi +329 -158
- data/rbi/orb/models/credit_note_create_params.rbi +64 -29
- data/rbi/orb/models/credit_note_fetch_params.rbi +13 -4
- data/rbi/orb/models/credit_note_list_params.rbi +23 -17
- data/rbi/orb/models/customer.rbi +461 -329
- data/rbi/orb/models/customer_create_params.rbi +713 -325
- data/rbi/orb/models/customer_delete_params.rbi +13 -4
- data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +13 -4
- data/rbi/orb/models/customer_fetch_params.rbi +11 -4
- data/rbi/orb/models/customer_list_params.rbi +21 -17
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +16 -4
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +16 -4
- data/rbi/orb/models/customer_update_by_external_id_params.rbi +1193 -336
- data/rbi/orb/models/customer_update_params.rbi +712 -324
- data/rbi/orb/models/customers/balance_transaction_create_params.rbi +56 -21
- data/rbi/orb/models/customers/balance_transaction_create_response.rbi +172 -61
- data/rbi/orb/models/customers/balance_transaction_list_params.rbi +26 -17
- data/rbi/orb/models/customers/balance_transaction_list_response.rbi +182 -59
- data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +62 -22
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +180 -124
- data/rbi/orb/models/customers/cost_list_params.rbi +48 -22
- data/rbi/orb/models/customers/cost_list_response.rbi +172 -123
- data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi +24 -15
- data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +54 -22
- data/rbi/orb/models/customers/credit_list_params.rbi +21 -15
- data/rbi/orb/models/customers/credit_list_response.rbi +50 -21
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +118 -68
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +755 -434
- data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +129 -59
- data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +812 -425
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +108 -44
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +793 -432
- data/rbi/orb/models/customers/credits/ledger_list_params.rbi +129 -40
- data/rbi/orb/models/customers/credits/ledger_list_response.rbi +847 -389
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +86 -53
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +77 -48
- data/rbi/orb/models/customers/credits/top_up_create_params.rbi +96 -45
- data/rbi/orb/models/customers/credits/top_up_create_response.rbi +95 -43
- data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +22 -6
- data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +21 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +15 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +82 -49
- data/rbi/orb/models/customers/credits/top_up_list_params.rbi +15 -5
- data/rbi/orb/models/customers/credits/top_up_list_response.rbi +96 -43
- data/rbi/orb/models/dimensional_price_group.rbi +21 -15
- data/rbi/orb/models/dimensional_price_group_create_params.rbi +22 -16
- data/rbi/orb/models/dimensional_price_group_list_params.rbi +19 -6
- data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +16 -4
- data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +15 -8
- data/rbi/orb/models/dimensional_price_groups.rbi +21 -13
- data/rbi/orb/models/discount.rbi +11 -5
- data/rbi/orb/models/evaluate_price_group.rbi +29 -12
- data/rbi/orb/models/event_deprecate_params.rbi +13 -4
- data/rbi/orb/models/event_deprecate_response.rbi +11 -3
- data/rbi/orb/models/event_ingest_params.rbi +41 -31
- data/rbi/orb/models/event_ingest_response.rbi +78 -23
- data/rbi/orb/models/event_search_params.rbi +18 -14
- data/rbi/orb/models/event_search_response.rbi +42 -21
- data/rbi/orb/models/event_update_params.rbi +20 -16
- data/rbi/orb/models/event_update_response.rbi +11 -3
- data/rbi/orb/models/events/backfill_close_params.rbi +13 -9
- data/rbi/orb/models/events/backfill_close_response.rbi +70 -29
- data/rbi/orb/models/events/backfill_create_params.rbi +24 -18
- data/rbi/orb/models/events/backfill_create_response.rbi +69 -29
- data/rbi/orb/models/events/backfill_fetch_params.rbi +13 -9
- data/rbi/orb/models/events/backfill_fetch_response.rbi +70 -29
- data/rbi/orb/models/events/backfill_list_params.rbi +19 -6
- data/rbi/orb/models/events/backfill_list_response.rbi +68 -28
- data/rbi/orb/models/events/backfill_revert_params.rbi +13 -9
- data/rbi/orb/models/events/backfill_revert_response.rbi +69 -29
- data/rbi/orb/models/events/event_volumes.rbi +38 -10
- data/rbi/orb/models/events/volume_list_params.rbi +21 -15
- data/rbi/orb/models/invoice.rbi +1411 -805
- data/rbi/orb/models/invoice_create_params.rbi +107 -69
- data/rbi/orb/models/invoice_fetch_params.rbi +11 -4
- data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +18 -5
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +2187 -876
- data/rbi/orb/models/invoice_issue_params.rbi +17 -5
- data/rbi/orb/models/invoice_level_discount.rbi +11 -4
- data/rbi/orb/models/invoice_line_item_create_params.rbi +23 -17
- data/rbi/orb/models/invoice_line_item_create_response.rbi +675 -376
- data/rbi/orb/models/invoice_list_params.rbi +68 -47
- data/rbi/orb/models/invoice_mark_paid_params.rbi +20 -14
- data/rbi/orb/models/invoice_pay_params.rbi +11 -4
- data/rbi/orb/models/invoice_update_params.rbi +16 -10
- data/rbi/orb/models/invoice_void_params.rbi +11 -4
- data/rbi/orb/models/item.rbi +90 -39
- data/rbi/orb/models/item_create_params.rbi +15 -5
- data/rbi/orb/models/item_fetch_params.rbi +11 -4
- data/rbi/orb/models/item_list_params.rbi +17 -6
- data/rbi/orb/models/item_update_params.rbi +86 -39
- data/rbi/orb/models/metric_create_params.rbi +20 -16
- data/rbi/orb/models/metric_fetch_params.rbi +11 -4
- data/rbi/orb/models/metric_list_params.rbi +21 -17
- data/rbi/orb/models/metric_update_params.rbi +16 -10
- data/rbi/orb/models/pagination_metadata.rbi +17 -4
- data/rbi/orb/models/percentage_discount.rbi +33 -19
- data/rbi/orb/models/plan.rbi +532 -365
- data/rbi/orb/models/plan_create_params.rbi +5295 -2870
- data/rbi/orb/models/plan_fetch_params.rbi +11 -4
- data/rbi/orb/models/plan_list_params.rbi +35 -27
- data/rbi/orb/models/plan_update_params.rbi +17 -13
- data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +13 -9
- data/rbi/orb/models/plans/external_plan_id_update_params.rbi +22 -13
- data/rbi/orb/models/price.rbi +11332 -5033
- data/rbi/orb/models/price_create_params.rbi +583 -245
- data/rbi/orb/models/price_evaluate_params.rbi +21 -17
- data/rbi/orb/models/price_evaluate_response.rbi +14 -6
- data/rbi/orb/models/price_fetch_params.rbi +11 -4
- data/rbi/orb/models/price_list_params.rbi +17 -6
- data/rbi/orb/models/price_update_params.rbi +16 -10
- data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +15 -8
- data/rbi/orb/models/prices/external_price_id_update_params.rbi +21 -10
- data/rbi/orb/models/subscription.rbi +668 -420
- data/rbi/orb/models/subscription_cancel_params.rbi +47 -22
- data/rbi/orb/models/subscription_cancel_response.rbi +817 -438
- data/rbi/orb/models/subscription_change_apply_params.rbi +19 -13
- data/rbi/orb/models/subscription_change_apply_response.rbi +906 -505
- data/rbi/orb/models/subscription_change_cancel_params.rbi +13 -4
- data/rbi/orb/models/subscription_change_cancel_response.rbi +906 -516
- data/rbi/orb/models/subscription_change_retrieve_params.rbi +13 -4
- data/rbi/orb/models/subscription_change_retrieve_response.rbi +903 -524
- data/rbi/orb/models/subscription_create_params.rbi +10096 -6746
- data/rbi/orb/models/subscription_create_response.rbi +817 -438
- data/rbi/orb/models/subscription_fetch_costs_params.rbi +50 -22
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +172 -123
- data/rbi/orb/models/subscription_fetch_params.rbi +13 -4
- data/rbi/orb/models/subscription_fetch_schedule_params.rbi +23 -17
- data/rbi/orb/models/subscription_fetch_schedule_response.rbi +45 -19
- data/rbi/orb/models/subscription_fetch_usage_params.rbi +84 -34
- data/rbi/orb/models/subscription_list_params.rbi +42 -28
- data/rbi/orb/models/subscription_price_intervals_params.rbi +5798 -3823
- data/rbi/orb/models/subscription_price_intervals_response.rbi +840 -453
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +9676 -6922
- data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +838 -467
- data/rbi/orb/models/subscription_trigger_phase_params.rbi +19 -13
- data/rbi/orb/models/subscription_trigger_phase_response.rbi +832 -448
- data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +16 -4
- data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +839 -467
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +22 -5
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +815 -504
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +16 -4
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +828 -497
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +63 -26
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +839 -467
- data/rbi/orb/models/subscription_update_params.rbi +22 -16
- data/rbi/orb/models/subscription_update_trial_params.rbi +60 -19
- data/rbi/orb/models/subscription_update_trial_response.rbi +832 -447
- data/rbi/orb/models/subscription_usage.rbi +325 -121
- data/rbi/orb/models/subscriptions.rbi +19 -11
- data/rbi/orb/models/top_level_ping_params.rbi +11 -4
- data/rbi/orb/models/top_level_ping_response.rbi +10 -3
- data/rbi/orb/models/trial_discount.rbi +30 -20
- data/rbi/orb/models/usage_discount.rbi +29 -19
- data/rbi/orb/models.rbi +22 -11
- data/rbi/orb/request_options.rbi +12 -6
- data/rbi/orb/resources/alerts.rbi +61 -40
- data/rbi/orb/resources/coupons/subscriptions.rbi +7 -5
- data/rbi/orb/resources/coupons.rbi +33 -18
- data/rbi/orb/resources/credit_notes.rbi +22 -13
- data/rbi/orb/resources/customers/balance_transactions.rbi +17 -9
- data/rbi/orb/resources/customers/costs.rbi +18 -11
- data/rbi/orb/resources/customers/credits/ledger.rbi +98 -74
- data/rbi/orb/resources/customers/credits/top_ups.rbi +61 -25
- data/rbi/orb/resources/customers/credits.rbi +16 -7
- data/rbi/orb/resources/customers.rbi +137 -72
- data/rbi/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +8 -4
- data/rbi/orb/resources/dimensional_price_groups.rbi +26 -12
- data/rbi/orb/resources/events/backfills.rbi +35 -17
- data/rbi/orb/resources/events/volume.rbi +7 -5
- data/rbi/orb/resources/events.rbi +26 -16
- data/rbi/orb/resources/invoice_line_items.rbi +7 -5
- data/rbi/orb/resources/invoices.rbi +72 -41
- data/rbi/orb/resources/items.rbi +40 -13
- data/rbi/orb/resources/metrics.rbi +25 -15
- data/rbi/orb/resources/plans/external_plan_id.rbi +15 -7
- data/rbi/orb/resources/plans.rbi +57 -47
- data/rbi/orb/resources/prices/external_price_id.rbi +73 -68
- data/rbi/orb/resources/prices.rbi +176 -156
- data/rbi/orb/resources/subscription_changes.rbi +19 -11
- data/rbi/orb/resources/subscriptions.rbi +200 -114
- data/rbi/orb/resources/top_level.rbi +9 -3
- data/sig/orb/internal/page.rbs +0 -2
- data/sig/orb/internal/transport/base_client.rbs +16 -1
- data/sig/orb/internal/transport/pooled_net_requester.rbs +2 -0
- data/sig/orb/internal/type/base_model.rbs +11 -5
- data/sig/orb/internal/type/base_page.rbs +1 -1
- data/sig/orb/internal/type/converter.rbs +2 -0
- data/sig/orb/internal/type/enum.rbs +1 -0
- data/sig/orb/internal/type/request_parameters.rbs +3 -1
- data/sig/orb/internal/type/union.rbs +1 -0
- data/sig/orb/internal/util.rbs +13 -0
- data/sig/orb/internal.rbs +2 -0
- data/sig/orb/models/alert.rbs +19 -31
- data/sig/orb/models/alert_create_for_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_subscription_params.rbs +3 -7
- data/sig/orb/models/alert_disable_params.rbs +0 -2
- data/sig/orb/models/alert_enable_params.rbs +0 -2
- data/sig/orb/models/alert_list_params.rbs +0 -2
- data/sig/orb/models/alert_retrieve_params.rbs +0 -2
- data/sig/orb/models/alert_update_params.rbs +3 -7
- data/sig/orb/models/amount_discount.rbs +4 -6
- data/sig/orb/models/billable_metric.rbs +7 -9
- data/sig/orb/models/coupon.rbs +5 -8
- data/sig/orb/models/coupon_archive_params.rbs +0 -2
- data/sig/orb/models/coupon_create_params.rbs +3 -9
- data/sig/orb/models/coupon_fetch_params.rbs +0 -2
- data/sig/orb/models/coupon_list_params.rbs +0 -2
- data/sig/orb/models/coupons/subscription_list_params.rbs +0 -2
- data/sig/orb/models/credit_note.rbs +48 -66
- data/sig/orb/models/credit_note_create_params.rbs +3 -7
- data/sig/orb/models/credit_note_fetch_params.rbs +0 -2
- data/sig/orb/models/credit_note_list_params.rbs +0 -2
- data/sig/orb/models/customer.rbs +43 -63
- data/sig/orb/models/customer_create_params.rbs +32 -52
- data/sig/orb/models/customer_delete_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_params.rbs +0 -2
- data/sig/orb/models/customer_list_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +0 -2
- data/sig/orb/models/customer_update_by_external_id_params.rbs +32 -52
- data/sig/orb/models/customer_update_params.rbs +32 -52
- data/sig/orb/models/customers/balance_transaction_create_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_create_response.rbs +0 -6
- data/sig/orb/models/customers/balance_transaction_list_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_list_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_response.rbs +0 -6
- data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +0 -2
- data/sig/orb/models/customers/credit_list_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_response.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +1 -43
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_create_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_delete_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_response.rbs +0 -4
- data/sig/orb/models/dimensional_price_group.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_create_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_list_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups.rbs +6 -8
- data/sig/orb/models/discount.rbs +5 -5
- data/sig/orb/models/evaluate_price_group.rbs +4 -6
- data/sig/orb/models/event_deprecate_params.rbs +0 -2
- data/sig/orb/models/event_deprecate_response.rbs +0 -2
- data/sig/orb/models/event_ingest_params.rbs +3 -7
- data/sig/orb/models/event_ingest_response.rbs +0 -6
- data/sig/orb/models/event_search_params.rbs +0 -2
- data/sig/orb/models/event_search_response.rbs +0 -4
- data/sig/orb/models/event_update_params.rbs +0 -2
- data/sig/orb/models/event_update_response.rbs +0 -2
- data/sig/orb/models/events/backfill_close_params.rbs +0 -2
- data/sig/orb/models/events/backfill_close_response.rbs +0 -2
- data/sig/orb/models/events/backfill_create_params.rbs +0 -2
- data/sig/orb/models/events/backfill_create_response.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_params.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_response.rbs +0 -2
- data/sig/orb/models/events/backfill_list_params.rbs +0 -2
- data/sig/orb/models/events/backfill_list_response.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_params.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_response.rbs +0 -2
- data/sig/orb/models/events/event_volumes.rbs +3 -10
- data/sig/orb/models/events/volume_list_params.rbs +0 -2
- data/sig/orb/models/invoice.rbs +110 -172
- data/sig/orb/models/invoice_create_params.rbs +10 -16
- data/sig/orb/models/invoice_fetch_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +2 -64
- data/sig/orb/models/invoice_issue_params.rbs +0 -2
- data/sig/orb/models/invoice_level_discount.rbs +2 -4
- data/sig/orb/models/invoice_line_item_create_params.rbs +0 -2
- data/sig/orb/models/invoice_line_item_create_response.rbs +2 -36
- data/sig/orb/models/invoice_list_params.rbs +4 -6
- data/sig/orb/models/invoice_mark_paid_params.rbs +0 -2
- data/sig/orb/models/invoice_pay_params.rbs +0 -2
- data/sig/orb/models/invoice_update_params.rbs +0 -2
- data/sig/orb/models/invoice_void_params.rbs +0 -2
- data/sig/orb/models/item.rbs +7 -11
- data/sig/orb/models/item_create_params.rbs +0 -2
- data/sig/orb/models/item_fetch_params.rbs +0 -2
- data/sig/orb/models/item_list_params.rbs +0 -2
- data/sig/orb/models/item_update_params.rbs +7 -11
- data/sig/orb/models/metric_create_params.rbs +0 -2
- data/sig/orb/models/metric_fetch_params.rbs +0 -2
- data/sig/orb/models/metric_list_params.rbs +0 -2
- data/sig/orb/models/metric_update_params.rbs +0 -2
- data/sig/orb/models/pagination_metadata.rbs +0 -2
- data/sig/orb/models/percentage_discount.rbs +4 -6
- data/sig/orb/models/plan.rbs +45 -73
- data/sig/orb/models/plan_create_params.rbs +518 -696
- data/sig/orb/models/plan_fetch_params.rbs +0 -2
- data/sig/orb/models/plan_list_params.rbs +0 -2
- data/sig/orb/models/plan_update_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +0 -2
- data/sig/orb/models/price.rbs +1194 -1730
- data/sig/orb/models/price_create_params.rbs +59 -97
- data/sig/orb/models/price_evaluate_params.rbs +0 -2
- data/sig/orb/models/price_evaluate_response.rbs +3 -6
- data/sig/orb/models/price_fetch_params.rbs +0 -2
- data/sig/orb/models/price_list_params.rbs +0 -2
- data/sig/orb/models/price_update_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_fetch_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_update_params.rbs +0 -2
- data/sig/orb/models/subscription.rbs +56 -94
- data/sig/orb/models/subscription_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_cancel_response.rbs +20 -60
- data/sig/orb/models/subscription_change_apply_params.rbs +0 -2
- data/sig/orb/models/subscription_change_apply_response.rbs +20 -62
- data/sig/orb/models/subscription_change_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_change_cancel_response.rbs +20 -62
- data/sig/orb/models/subscription_change_retrieve_params.rbs +0 -2
- data/sig/orb/models/subscription_change_retrieve_response.rbs +20 -62
- data/sig/orb/models/subscription_create_params.rbs +1103 -1499
- data/sig/orb/models/subscription_create_response.rbs +20 -60
- data/sig/orb/models/subscription_fetch_costs_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_costs_response.rbs +0 -6
- data/sig/orb/models/subscription_fetch_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_response.rbs +0 -4
- data/sig/orb/models/subscription_fetch_usage_params.rbs +0 -2
- data/sig/orb/models/subscription_list_params.rbs +0 -2
- data/sig/orb/models/subscription_price_intervals_params.rbs +666 -896
- data/sig/orb/models/subscription_price_intervals_response.rbs +20 -60
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1103 -1499
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +20 -60
- data/sig/orb/models/subscription_trigger_phase_params.rbs +0 -2
- data/sig/orb/models/subscription_trigger_phase_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +20 -60
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +0 -2
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +20 -60
- data/sig/orb/models/subscription_update_params.rbs +0 -2
- data/sig/orb/models/subscription_update_trial_params.rbs +1 -3
- data/sig/orb/models/subscription_update_trial_response.rbs +20 -60
- data/sig/orb/models/subscription_usage.rbs +35 -53
- data/sig/orb/models/subscriptions.rbs +6 -8
- data/sig/orb/models/top_level_ping_params.rbs +0 -2
- data/sig/orb/models/top_level_ping_response.rbs +0 -2
- data/sig/orb/models/trial_discount.rbs +4 -6
- data/sig/orb/models/usage_discount.rbs +4 -6
- data/sig/orb/request_options.rbs +1 -1
- data/sig/orb/resources/alerts.rbs +12 -12
- data/sig/orb/resources/coupons/subscriptions.rbs +1 -1
- data/sig/orb/resources/coupons.rbs +4 -4
- data/sig/orb/resources/credit_notes.rbs +4 -4
- data/sig/orb/resources/customers/credits/ledger.rbs +2 -2
- data/sig/orb/resources/customers/credits/top_ups.rbs +2 -2
- data/sig/orb/resources/customers.rbs +24 -24
- data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +1 -1
- data/sig/orb/resources/dimensional_price_groups.rbs +3 -3
- data/sig/orb/resources/events/volume.rbs +1 -1
- data/sig/orb/resources/events.rbs +1 -1
- data/sig/orb/resources/invoices.rbs +10 -10
- data/sig/orb/resources/items.rbs +5 -5
- data/sig/orb/resources/metrics.rbs +4 -4
- data/sig/orb/resources/plans/external_plan_id.rbs +2 -2
- data/sig/orb/resources/plans.rbs +5 -5
- data/sig/orb/resources/prices.rbs +11 -11
- data/sig/orb/resources/subscriptions.rbs +21 -21
- metadata +2 -2
@@ -3,6 +3,14 @@
|
|
3
3
|
module Orb
|
4
4
|
module Models
|
5
5
|
class SubscriptionUpdateFixedFeeQuantityResponse < Orb::Internal::Type::BaseModel
|
6
|
+
OrHash =
|
7
|
+
T.type_alias do
|
8
|
+
T.any(
|
9
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse,
|
10
|
+
Orb::Internal::AnyHash
|
11
|
+
)
|
12
|
+
end
|
13
|
+
|
6
14
|
sig { returns(String) }
|
7
15
|
attr_accessor :id
|
8
16
|
|
@@ -13,7 +21,13 @@ module Orb
|
|
13
21
|
|
14
22
|
# The adjustment intervals for this subscription sorted by the start_date of the
|
15
23
|
# adjustment interval.
|
16
|
-
sig
|
24
|
+
sig do
|
25
|
+
returns(
|
26
|
+
T::Array[
|
27
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval
|
28
|
+
]
|
29
|
+
)
|
30
|
+
end
|
17
31
|
attr_accessor :adjustment_intervals
|
18
32
|
|
19
33
|
# Determines whether issued invoices for this subscription will automatically be
|
@@ -22,17 +36,18 @@ module Orb
|
|
22
36
|
sig { returns(T.nilable(T::Boolean)) }
|
23
37
|
attr_accessor :auto_collection
|
24
38
|
|
25
|
-
sig
|
39
|
+
sig do
|
40
|
+
returns(
|
41
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::BillingCycleAnchorConfiguration
|
42
|
+
)
|
43
|
+
end
|
26
44
|
attr_reader :billing_cycle_anchor_configuration
|
27
45
|
|
28
46
|
sig do
|
29
47
|
params(
|
30
|
-
billing_cycle_anchor_configuration:
|
31
|
-
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::BillingCycleAnchorConfiguration
|
32
|
-
|
33
|
-
)
|
34
|
-
)
|
35
|
-
.void
|
48
|
+
billing_cycle_anchor_configuration:
|
49
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::BillingCycleAnchorConfiguration::OrHash
|
50
|
+
).void
|
36
51
|
end
|
37
52
|
attr_writer :billing_cycle_anchor_configuration
|
38
53
|
|
@@ -76,10 +91,10 @@ module Orb
|
|
76
91
|
# [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
|
77
92
|
# your account's timezone. See [Timezone localization](/essentials/timezones) for
|
78
93
|
# information on what this timezone parameter influences within Orb.
|
79
|
-
sig { returns(Orb::
|
94
|
+
sig { returns(Orb::Customer) }
|
80
95
|
attr_reader :customer
|
81
96
|
|
82
|
-
sig { params(customer:
|
97
|
+
sig { params(customer: Orb::Customer::OrHash).void }
|
83
98
|
attr_writer :customer
|
84
99
|
|
85
100
|
# Determines the default memo on this subscriptions' invoices. Note that if this
|
@@ -105,14 +120,26 @@ module Orb
|
|
105
120
|
sig { returns(T.nilable(Time)) }
|
106
121
|
attr_accessor :end_date
|
107
122
|
|
108
|
-
sig
|
123
|
+
sig do
|
124
|
+
returns(
|
125
|
+
T::Array[
|
126
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::FixedFeeQuantitySchedule
|
127
|
+
]
|
128
|
+
)
|
129
|
+
end
|
109
130
|
attr_accessor :fixed_fee_quantity_schedule
|
110
131
|
|
111
132
|
sig { returns(T.nilable(String)) }
|
112
133
|
attr_accessor :invoicing_threshold
|
113
134
|
|
114
135
|
# The maximum intervals for this subscription sorted by the start_date.
|
115
|
-
sig
|
136
|
+
sig do
|
137
|
+
returns(
|
138
|
+
T::Array[
|
139
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::MaximumInterval
|
140
|
+
]
|
141
|
+
)
|
142
|
+
end
|
116
143
|
attr_accessor :maximum_intervals
|
117
144
|
|
118
145
|
# User specified key-value pairs for the resource. If not present, this defaults
|
@@ -123,7 +150,13 @@ module Orb
|
|
123
150
|
attr_accessor :metadata
|
124
151
|
|
125
152
|
# The minimum intervals for this subscription sorted by the start_date.
|
126
|
-
sig
|
153
|
+
sig do
|
154
|
+
returns(
|
155
|
+
T::Array[
|
156
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::MinimumInterval
|
157
|
+
]
|
158
|
+
)
|
159
|
+
end
|
127
160
|
attr_accessor :minimum_intervals
|
128
161
|
|
129
162
|
# Determines the difference between the invoice issue date for subscription
|
@@ -134,19 +167,22 @@ module Orb
|
|
134
167
|
attr_accessor :net_terms
|
135
168
|
|
136
169
|
# A pending subscription change if one exists on this subscription.
|
137
|
-
sig
|
170
|
+
sig do
|
171
|
+
returns(
|
172
|
+
T.nilable(
|
173
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PendingSubscriptionChange
|
174
|
+
)
|
175
|
+
)
|
176
|
+
end
|
138
177
|
attr_reader :pending_subscription_change
|
139
178
|
|
140
179
|
sig do
|
141
180
|
params(
|
142
|
-
pending_subscription_change:
|
143
|
-
T.
|
144
|
-
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PendingSubscriptionChange
|
145
|
-
Orb::Internal::AnyHash
|
181
|
+
pending_subscription_change:
|
182
|
+
T.nilable(
|
183
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PendingSubscriptionChange::OrHash
|
146
184
|
)
|
147
|
-
|
148
|
-
)
|
149
|
-
.void
|
185
|
+
).void
|
150
186
|
end
|
151
187
|
attr_writer :pending_subscription_change
|
152
188
|
|
@@ -154,26 +190,38 @@ module Orb
|
|
154
190
|
# subscribed to by a customer. Plans define the billing behavior of the
|
155
191
|
# subscription. You can see more about how to configure prices in the
|
156
192
|
# [Price resource](/reference/price).
|
157
|
-
sig { returns(Orb::
|
193
|
+
sig { returns(Orb::Plan) }
|
158
194
|
attr_reader :plan
|
159
195
|
|
160
|
-
sig { params(plan:
|
196
|
+
sig { params(plan: Orb::Plan::OrHash).void }
|
161
197
|
attr_writer :plan
|
162
198
|
|
163
199
|
# The price intervals for this subscription.
|
164
|
-
sig
|
200
|
+
sig do
|
201
|
+
returns(
|
202
|
+
T::Array[
|
203
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PriceInterval
|
204
|
+
]
|
205
|
+
)
|
206
|
+
end
|
165
207
|
attr_accessor :price_intervals
|
166
208
|
|
167
|
-
sig
|
209
|
+
sig do
|
210
|
+
returns(
|
211
|
+
T.nilable(
|
212
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::RedeemedCoupon
|
213
|
+
)
|
214
|
+
)
|
215
|
+
end
|
168
216
|
attr_reader :redeemed_coupon
|
169
217
|
|
170
218
|
sig do
|
171
219
|
params(
|
172
|
-
redeemed_coupon:
|
173
|
-
T.
|
174
|
-
|
175
|
-
|
176
|
-
|
220
|
+
redeemed_coupon:
|
221
|
+
T.nilable(
|
222
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::RedeemedCoupon::OrHash
|
223
|
+
)
|
224
|
+
).void
|
177
225
|
end
|
178
226
|
attr_writer :redeemed_coupon
|
179
227
|
|
@@ -181,33 +229,47 @@ module Orb
|
|
181
229
|
sig { returns(Time) }
|
182
230
|
attr_accessor :start_date
|
183
231
|
|
184
|
-
sig
|
232
|
+
sig do
|
233
|
+
returns(
|
234
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::Status::TaggedSymbol
|
235
|
+
)
|
236
|
+
end
|
185
237
|
attr_accessor :status
|
186
238
|
|
187
|
-
sig
|
239
|
+
sig do
|
240
|
+
returns(
|
241
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::TrialInfo
|
242
|
+
)
|
243
|
+
end
|
188
244
|
attr_reader :trial_info
|
189
245
|
|
190
246
|
sig do
|
191
247
|
params(
|
192
|
-
trial_info:
|
193
|
-
|
194
|
-
|
248
|
+
trial_info:
|
249
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::TrialInfo::OrHash
|
250
|
+
).void
|
195
251
|
end
|
196
252
|
attr_writer :trial_info
|
197
253
|
|
198
254
|
# The resources that were changed as part of this operation. Only present when
|
199
255
|
# fetched through the subscription changes API or if the
|
200
256
|
# `include_changed_resources` parameter was passed in the request.
|
201
|
-
sig
|
257
|
+
sig do
|
258
|
+
returns(
|
259
|
+
T.nilable(
|
260
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::ChangedResources
|
261
|
+
)
|
262
|
+
)
|
263
|
+
end
|
202
264
|
attr_reader :changed_resources
|
203
265
|
|
204
266
|
sig do
|
205
267
|
params(
|
206
|
-
changed_resources:
|
207
|
-
T.
|
208
|
-
|
209
|
-
|
210
|
-
|
268
|
+
changed_resources:
|
269
|
+
T.nilable(
|
270
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::ChangedResources::OrHash
|
271
|
+
)
|
272
|
+
).void
|
211
273
|
end
|
212
274
|
attr_writer :changed_resources
|
213
275
|
|
@@ -215,57 +277,66 @@ module Orb
|
|
215
277
|
params(
|
216
278
|
id: String,
|
217
279
|
active_plan_phase_order: T.nilable(Integer),
|
218
|
-
adjustment_intervals:
|
280
|
+
adjustment_intervals:
|
281
|
+
T::Array[
|
282
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::OrHash
|
283
|
+
],
|
219
284
|
auto_collection: T.nilable(T::Boolean),
|
220
|
-
billing_cycle_anchor_configuration:
|
221
|
-
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::BillingCycleAnchorConfiguration,
|
222
|
-
Orb::Internal::AnyHash
|
223
|
-
),
|
285
|
+
billing_cycle_anchor_configuration:
|
286
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::BillingCycleAnchorConfiguration::OrHash,
|
224
287
|
billing_cycle_day: Integer,
|
225
288
|
created_at: Time,
|
226
289
|
current_billing_period_end_date: T.nilable(Time),
|
227
290
|
current_billing_period_start_date: T.nilable(Time),
|
228
|
-
customer:
|
291
|
+
customer: Orb::Customer::OrHash,
|
229
292
|
default_invoice_memo: T.nilable(String),
|
230
|
-
discount_intervals:
|
231
|
-
T
|
232
|
-
|
233
|
-
|
234
|
-
|
235
|
-
|
236
|
-
|
237
|
-
|
293
|
+
discount_intervals:
|
294
|
+
T::Array[
|
295
|
+
T.any(
|
296
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::Amount::OrHash,
|
297
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::Percentage::OrHash,
|
298
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::Usage::OrHash
|
299
|
+
)
|
300
|
+
],
|
238
301
|
end_date: T.nilable(Time),
|
239
|
-
fixed_fee_quantity_schedule:
|
240
|
-
T
|
241
|
-
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::FixedFeeQuantitySchedule
|
242
|
-
|
243
|
-
)
|
244
|
-
],
|
302
|
+
fixed_fee_quantity_schedule:
|
303
|
+
T::Array[
|
304
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::FixedFeeQuantitySchedule::OrHash
|
305
|
+
],
|
245
306
|
invoicing_threshold: T.nilable(String),
|
246
|
-
maximum_intervals:
|
307
|
+
maximum_intervals:
|
308
|
+
T::Array[
|
309
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::MaximumInterval::OrHash
|
310
|
+
],
|
247
311
|
metadata: T::Hash[Symbol, String],
|
248
|
-
minimum_intervals:
|
312
|
+
minimum_intervals:
|
313
|
+
T::Array[
|
314
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::MinimumInterval::OrHash
|
315
|
+
],
|
249
316
|
net_terms: Integer,
|
250
|
-
pending_subscription_change:
|
251
|
-
T.
|
252
|
-
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PendingSubscriptionChange
|
253
|
-
|
254
|
-
|
255
|
-
|
256
|
-
|
257
|
-
|
258
|
-
|
259
|
-
|
260
|
-
|
317
|
+
pending_subscription_change:
|
318
|
+
T.nilable(
|
319
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PendingSubscriptionChange::OrHash
|
320
|
+
),
|
321
|
+
plan: Orb::Plan::OrHash,
|
322
|
+
price_intervals:
|
323
|
+
T::Array[
|
324
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PriceInterval::OrHash
|
325
|
+
],
|
326
|
+
redeemed_coupon:
|
327
|
+
T.nilable(
|
328
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::RedeemedCoupon::OrHash
|
329
|
+
),
|
261
330
|
start_date: Time,
|
262
|
-
status:
|
263
|
-
|
264
|
-
|
265
|
-
|
266
|
-
|
267
|
-
|
268
|
-
|
331
|
+
status:
|
332
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::Status::OrSymbol,
|
333
|
+
trial_info:
|
334
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::TrialInfo::OrHash,
|
335
|
+
changed_resources:
|
336
|
+
T.nilable(
|
337
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::ChangedResources::OrHash
|
338
|
+
)
|
339
|
+
).returns(T.attached_class)
|
269
340
|
end
|
270
341
|
def self.new(
|
271
342
|
id:,
|
@@ -354,50 +425,88 @@ module Orb
|
|
354
425
|
# fetched through the subscription changes API or if the
|
355
426
|
# `include_changed_resources` parameter was passed in the request.
|
356
427
|
changed_resources: nil
|
357
|
-
)
|
428
|
+
)
|
429
|
+
end
|
430
|
+
|
358
431
|
sig do
|
359
|
-
override
|
360
|
-
|
361
|
-
|
362
|
-
|
363
|
-
|
364
|
-
|
365
|
-
|
366
|
-
|
367
|
-
|
368
|
-
|
369
|
-
|
370
|
-
|
371
|
-
|
372
|
-
|
373
|
-
|
432
|
+
override.returns(
|
433
|
+
{
|
434
|
+
id: String,
|
435
|
+
active_plan_phase_order: T.nilable(Integer),
|
436
|
+
adjustment_intervals:
|
437
|
+
T::Array[
|
438
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval
|
439
|
+
],
|
440
|
+
auto_collection: T.nilable(T::Boolean),
|
441
|
+
billing_cycle_anchor_configuration:
|
442
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::BillingCycleAnchorConfiguration,
|
443
|
+
billing_cycle_day: Integer,
|
444
|
+
created_at: Time,
|
445
|
+
current_billing_period_end_date: T.nilable(Time),
|
446
|
+
current_billing_period_start_date: T.nilable(Time),
|
447
|
+
customer: Orb::Customer,
|
448
|
+
default_invoice_memo: T.nilable(String),
|
449
|
+
discount_intervals:
|
450
|
+
T::Array[
|
374
451
|
T.any(
|
375
452
|
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::Amount,
|
376
453
|
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::Percentage,
|
377
454
|
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::Usage
|
378
455
|
)
|
379
456
|
],
|
380
|
-
|
381
|
-
|
382
|
-
|
383
|
-
|
384
|
-
|
385
|
-
|
386
|
-
|
387
|
-
|
388
|
-
|
389
|
-
|
390
|
-
|
391
|
-
|
392
|
-
|
393
|
-
|
394
|
-
|
395
|
-
|
396
|
-
|
457
|
+
end_date: T.nilable(Time),
|
458
|
+
fixed_fee_quantity_schedule:
|
459
|
+
T::Array[
|
460
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::FixedFeeQuantitySchedule
|
461
|
+
],
|
462
|
+
invoicing_threshold: T.nilable(String),
|
463
|
+
maximum_intervals:
|
464
|
+
T::Array[
|
465
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::MaximumInterval
|
466
|
+
],
|
467
|
+
metadata: T::Hash[Symbol, String],
|
468
|
+
minimum_intervals:
|
469
|
+
T::Array[
|
470
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::MinimumInterval
|
471
|
+
],
|
472
|
+
net_terms: Integer,
|
473
|
+
pending_subscription_change:
|
474
|
+
T.nilable(
|
475
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PendingSubscriptionChange
|
476
|
+
),
|
477
|
+
plan: Orb::Plan,
|
478
|
+
price_intervals:
|
479
|
+
T::Array[
|
480
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PriceInterval
|
481
|
+
],
|
482
|
+
redeemed_coupon:
|
483
|
+
T.nilable(
|
484
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::RedeemedCoupon
|
485
|
+
),
|
486
|
+
start_date: Time,
|
487
|
+
status:
|
488
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::Status::TaggedSymbol,
|
489
|
+
trial_info:
|
490
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::TrialInfo,
|
491
|
+
changed_resources:
|
492
|
+
T.nilable(
|
493
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::ChangedResources
|
494
|
+
)
|
495
|
+
}
|
496
|
+
)
|
497
|
+
end
|
498
|
+
def to_hash
|
397
499
|
end
|
398
|
-
def to_hash; end
|
399
500
|
|
400
501
|
class AdjustmentInterval < Orb::Internal::Type::BaseModel
|
502
|
+
OrHash =
|
503
|
+
T.type_alias do
|
504
|
+
T.any(
|
505
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval,
|
506
|
+
Orb::Internal::AnyHash
|
507
|
+
)
|
508
|
+
end
|
509
|
+
|
401
510
|
sig { returns(String) }
|
402
511
|
attr_accessor :id
|
403
512
|
|
@@ -429,19 +538,18 @@ module Orb
|
|
429
538
|
sig do
|
430
539
|
params(
|
431
540
|
id: String,
|
432
|
-
adjustment:
|
433
|
-
|
434
|
-
|
435
|
-
|
436
|
-
|
437
|
-
|
438
|
-
|
439
|
-
|
541
|
+
adjustment:
|
542
|
+
T.any(
|
543
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::UsageDiscount::OrHash,
|
544
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::AmountDiscount::OrHash,
|
545
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PercentageDiscount::OrHash,
|
546
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::Minimum::OrHash,
|
547
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::Maximum::OrHash
|
548
|
+
),
|
440
549
|
applies_to_price_interval_ids: T::Array[String],
|
441
550
|
end_date: T.nilable(Time),
|
442
551
|
start_date: Time
|
443
|
-
)
|
444
|
-
.returns(T.attached_class)
|
552
|
+
).returns(T.attached_class)
|
445
553
|
end
|
446
554
|
def self.new(
|
447
555
|
id:,
|
@@ -452,31 +560,53 @@ module Orb
|
|
452
560
|
end_date:,
|
453
561
|
# The start date of the adjustment interval.
|
454
562
|
start_date:
|
455
|
-
)
|
563
|
+
)
|
564
|
+
end
|
565
|
+
|
456
566
|
sig do
|
457
|
-
override
|
458
|
-
|
459
|
-
|
460
|
-
|
461
|
-
|
567
|
+
override.returns(
|
568
|
+
{
|
569
|
+
id: String,
|
570
|
+
adjustment:
|
571
|
+
T.any(
|
462
572
|
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::UsageDiscount,
|
463
573
|
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::AmountDiscount,
|
464
574
|
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
|
465
575
|
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::Minimum,
|
466
576
|
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::Maximum
|
467
577
|
),
|
468
|
-
|
469
|
-
|
470
|
-
|
471
|
-
|
472
|
-
|
578
|
+
applies_to_price_interval_ids: T::Array[String],
|
579
|
+
end_date: T.nilable(Time),
|
580
|
+
start_date: Time
|
581
|
+
}
|
582
|
+
)
|
583
|
+
end
|
584
|
+
def to_hash
|
473
585
|
end
|
474
|
-
def to_hash; end
|
475
586
|
|
476
587
|
module Adjustment
|
477
588
|
extend Orb::Internal::Type::Union
|
478
589
|
|
590
|
+
Variants =
|
591
|
+
T.type_alias do
|
592
|
+
T.any(
|
593
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::UsageDiscount,
|
594
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::AmountDiscount,
|
595
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
|
596
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::Minimum,
|
597
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::Maximum
|
598
|
+
)
|
599
|
+
end
|
600
|
+
|
479
601
|
class UsageDiscount < Orb::Internal::Type::BaseModel
|
602
|
+
OrHash =
|
603
|
+
T.type_alias do
|
604
|
+
T.any(
|
605
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::UsageDiscount,
|
606
|
+
Orb::Internal::AnyHash
|
607
|
+
)
|
608
|
+
end
|
609
|
+
|
480
610
|
sig { returns(String) }
|
481
611
|
attr_accessor :id
|
482
612
|
|
@@ -514,8 +644,7 @@ module Orb
|
|
514
644
|
reason: T.nilable(String),
|
515
645
|
usage_discount: Float,
|
516
646
|
adjustment_type: Symbol
|
517
|
-
)
|
518
|
-
.returns(T.attached_class)
|
647
|
+
).returns(T.attached_class)
|
519
648
|
end
|
520
649
|
def self.new(
|
521
650
|
id:,
|
@@ -532,25 +661,35 @@ module Orb
|
|
532
661
|
# to in a given billing period.
|
533
662
|
usage_discount:,
|
534
663
|
adjustment_type: :usage_discount
|
535
|
-
)
|
664
|
+
)
|
665
|
+
end
|
666
|
+
|
536
667
|
sig do
|
537
|
-
override
|
538
|
-
|
539
|
-
|
540
|
-
|
541
|
-
|
542
|
-
|
543
|
-
|
544
|
-
|
545
|
-
|
546
|
-
|
547
|
-
|
548
|
-
|
668
|
+
override.returns(
|
669
|
+
{
|
670
|
+
id: String,
|
671
|
+
adjustment_type: Symbol,
|
672
|
+
applies_to_price_ids: T::Array[String],
|
673
|
+
is_invoice_level: T::Boolean,
|
674
|
+
plan_phase_order: T.nilable(Integer),
|
675
|
+
reason: T.nilable(String),
|
676
|
+
usage_discount: Float
|
677
|
+
}
|
678
|
+
)
|
679
|
+
end
|
680
|
+
def to_hash
|
549
681
|
end
|
550
|
-
def to_hash; end
|
551
682
|
end
|
552
683
|
|
553
684
|
class AmountDiscount < Orb::Internal::Type::BaseModel
|
685
|
+
OrHash =
|
686
|
+
T.type_alias do
|
687
|
+
T.any(
|
688
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::AmountDiscount,
|
689
|
+
Orb::Internal::AnyHash
|
690
|
+
)
|
691
|
+
end
|
692
|
+
|
554
693
|
sig { returns(String) }
|
555
694
|
attr_accessor :id
|
556
695
|
|
@@ -588,8 +727,7 @@ module Orb
|
|
588
727
|
plan_phase_order: T.nilable(Integer),
|
589
728
|
reason: T.nilable(String),
|
590
729
|
adjustment_type: Symbol
|
591
|
-
)
|
592
|
-
.returns(T.attached_class)
|
730
|
+
).returns(T.attached_class)
|
593
731
|
end
|
594
732
|
def self.new(
|
595
733
|
id:,
|
@@ -606,25 +744,35 @@ module Orb
|
|
606
744
|
# The reason for the adjustment.
|
607
745
|
reason:,
|
608
746
|
adjustment_type: :amount_discount
|
609
|
-
)
|
747
|
+
)
|
748
|
+
end
|
749
|
+
|
610
750
|
sig do
|
611
|
-
override
|
612
|
-
|
613
|
-
|
614
|
-
|
615
|
-
|
616
|
-
|
617
|
-
|
618
|
-
|
619
|
-
|
620
|
-
|
621
|
-
|
622
|
-
|
751
|
+
override.returns(
|
752
|
+
{
|
753
|
+
id: String,
|
754
|
+
adjustment_type: Symbol,
|
755
|
+
amount_discount: String,
|
756
|
+
applies_to_price_ids: T::Array[String],
|
757
|
+
is_invoice_level: T::Boolean,
|
758
|
+
plan_phase_order: T.nilable(Integer),
|
759
|
+
reason: T.nilable(String)
|
760
|
+
}
|
761
|
+
)
|
762
|
+
end
|
763
|
+
def to_hash
|
623
764
|
end
|
624
|
-
def to_hash; end
|
625
765
|
end
|
626
766
|
|
627
767
|
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
768
|
+
OrHash =
|
769
|
+
T.type_alias do
|
770
|
+
T.any(
|
771
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
|
772
|
+
Orb::Internal::AnyHash
|
773
|
+
)
|
774
|
+
end
|
775
|
+
|
628
776
|
sig { returns(String) }
|
629
777
|
attr_accessor :id
|
630
778
|
|
@@ -662,8 +810,7 @@ module Orb
|
|
662
810
|
plan_phase_order: T.nilable(Integer),
|
663
811
|
reason: T.nilable(String),
|
664
812
|
adjustment_type: Symbol
|
665
|
-
)
|
666
|
-
.returns(T.attached_class)
|
813
|
+
).returns(T.attached_class)
|
667
814
|
end
|
668
815
|
def self.new(
|
669
816
|
id:,
|
@@ -680,25 +827,35 @@ module Orb
|
|
680
827
|
# The reason for the adjustment.
|
681
828
|
reason:,
|
682
829
|
adjustment_type: :percentage_discount
|
683
|
-
)
|
830
|
+
)
|
831
|
+
end
|
832
|
+
|
684
833
|
sig do
|
685
|
-
override
|
686
|
-
|
687
|
-
|
688
|
-
|
689
|
-
|
690
|
-
|
691
|
-
|
692
|
-
|
693
|
-
|
694
|
-
|
695
|
-
|
696
|
-
|
834
|
+
override.returns(
|
835
|
+
{
|
836
|
+
id: String,
|
837
|
+
adjustment_type: Symbol,
|
838
|
+
applies_to_price_ids: T::Array[String],
|
839
|
+
is_invoice_level: T::Boolean,
|
840
|
+
percentage_discount: Float,
|
841
|
+
plan_phase_order: T.nilable(Integer),
|
842
|
+
reason: T.nilable(String)
|
843
|
+
}
|
844
|
+
)
|
845
|
+
end
|
846
|
+
def to_hash
|
697
847
|
end
|
698
|
-
def to_hash; end
|
699
848
|
end
|
700
849
|
|
701
850
|
class Minimum < Orb::Internal::Type::BaseModel
|
851
|
+
OrHash =
|
852
|
+
T.type_alias do
|
853
|
+
T.any(
|
854
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::Minimum,
|
855
|
+
Orb::Internal::AnyHash
|
856
|
+
)
|
857
|
+
end
|
858
|
+
|
702
859
|
sig { returns(String) }
|
703
860
|
attr_accessor :id
|
704
861
|
|
@@ -741,8 +898,7 @@ module Orb
|
|
741
898
|
plan_phase_order: T.nilable(Integer),
|
742
899
|
reason: T.nilable(String),
|
743
900
|
adjustment_type: Symbol
|
744
|
-
)
|
745
|
-
.returns(T.attached_class)
|
901
|
+
).returns(T.attached_class)
|
746
902
|
end
|
747
903
|
def self.new(
|
748
904
|
id:,
|
@@ -761,26 +917,36 @@ module Orb
|
|
761
917
|
# The reason for the adjustment.
|
762
918
|
reason:,
|
763
919
|
adjustment_type: :minimum
|
764
|
-
)
|
920
|
+
)
|
921
|
+
end
|
922
|
+
|
765
923
|
sig do
|
766
|
-
override
|
767
|
-
|
768
|
-
|
769
|
-
|
770
|
-
|
771
|
-
|
772
|
-
|
773
|
-
|
774
|
-
|
775
|
-
|
776
|
-
|
777
|
-
|
778
|
-
|
924
|
+
override.returns(
|
925
|
+
{
|
926
|
+
id: String,
|
927
|
+
adjustment_type: Symbol,
|
928
|
+
applies_to_price_ids: T::Array[String],
|
929
|
+
is_invoice_level: T::Boolean,
|
930
|
+
item_id: String,
|
931
|
+
minimum_amount: String,
|
932
|
+
plan_phase_order: T.nilable(Integer),
|
933
|
+
reason: T.nilable(String)
|
934
|
+
}
|
935
|
+
)
|
936
|
+
end
|
937
|
+
def to_hash
|
779
938
|
end
|
780
|
-
def to_hash; end
|
781
939
|
end
|
782
940
|
|
783
941
|
class Maximum < Orb::Internal::Type::BaseModel
|
942
|
+
OrHash =
|
943
|
+
T.type_alias do
|
944
|
+
T.any(
|
945
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::Maximum,
|
946
|
+
Orb::Internal::AnyHash
|
947
|
+
)
|
948
|
+
end
|
949
|
+
|
784
950
|
sig { returns(String) }
|
785
951
|
attr_accessor :id
|
786
952
|
|
@@ -818,8 +984,7 @@ module Orb
|
|
818
984
|
plan_phase_order: T.nilable(Integer),
|
819
985
|
reason: T.nilable(String),
|
820
986
|
adjustment_type: Symbol
|
821
|
-
)
|
822
|
-
.returns(T.attached_class)
|
987
|
+
).returns(T.attached_class)
|
823
988
|
end
|
824
989
|
def self.new(
|
825
990
|
id:,
|
@@ -836,35 +1001,47 @@ module Orb
|
|
836
1001
|
# The reason for the adjustment.
|
837
1002
|
reason:,
|
838
1003
|
adjustment_type: :maximum
|
839
|
-
)
|
1004
|
+
)
|
1005
|
+
end
|
1006
|
+
|
840
1007
|
sig do
|
841
|
-
override
|
842
|
-
|
843
|
-
|
844
|
-
|
845
|
-
|
846
|
-
|
847
|
-
|
848
|
-
|
849
|
-
|
850
|
-
|
851
|
-
|
852
|
-
|
1008
|
+
override.returns(
|
1009
|
+
{
|
1010
|
+
id: String,
|
1011
|
+
adjustment_type: Symbol,
|
1012
|
+
applies_to_price_ids: T::Array[String],
|
1013
|
+
is_invoice_level: T::Boolean,
|
1014
|
+
maximum_amount: String,
|
1015
|
+
plan_phase_order: T.nilable(Integer),
|
1016
|
+
reason: T.nilable(String)
|
1017
|
+
}
|
1018
|
+
)
|
1019
|
+
end
|
1020
|
+
def to_hash
|
853
1021
|
end
|
854
|
-
def to_hash; end
|
855
1022
|
end
|
856
1023
|
|
857
1024
|
sig do
|
858
|
-
override
|
859
|
-
|
860
|
-
|
861
|
-
|
1025
|
+
override.returns(
|
1026
|
+
T::Array[
|
1027
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::Variants
|
1028
|
+
]
|
1029
|
+
)
|
1030
|
+
end
|
1031
|
+
def self.variants
|
862
1032
|
end
|
863
|
-
def self.variants; end
|
864
1033
|
end
|
865
1034
|
end
|
866
1035
|
|
867
1036
|
class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel
|
1037
|
+
OrHash =
|
1038
|
+
T.type_alias do
|
1039
|
+
T.any(
|
1040
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::BillingCycleAnchorConfiguration,
|
1041
|
+
Orb::Internal::AnyHash
|
1042
|
+
)
|
1043
|
+
end
|
1044
|
+
|
868
1045
|
# The day of the month on which the billing cycle is anchored. If the maximum
|
869
1046
|
# number of days in a month is greater than this value, the last day of the month
|
870
1047
|
# is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
|
@@ -884,7 +1061,11 @@ module Orb
|
|
884
1061
|
attr_accessor :year
|
885
1062
|
|
886
1063
|
sig do
|
887
|
-
params(
|
1064
|
+
params(
|
1065
|
+
day: Integer,
|
1066
|
+
month: T.nilable(Integer),
|
1067
|
+
year: T.nilable(Integer)
|
1068
|
+
).returns(T.attached_class)
|
888
1069
|
end
|
889
1070
|
def self.new(
|
890
1071
|
# The day of the month on which the billing cycle is anchored. If the maximum
|
@@ -899,15 +1080,43 @@ module Orb
|
|
899
1080
|
# The year on which the billing cycle is anchored (e.g. a 2 year billing cycle
|
900
1081
|
# anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.).
|
901
1082
|
year: nil
|
902
|
-
)
|
903
|
-
|
904
|
-
|
1083
|
+
)
|
1084
|
+
end
|
1085
|
+
|
1086
|
+
sig do
|
1087
|
+
override.returns(
|
1088
|
+
{
|
1089
|
+
day: Integer,
|
1090
|
+
month: T.nilable(Integer),
|
1091
|
+
year: T.nilable(Integer)
|
1092
|
+
}
|
1093
|
+
)
|
1094
|
+
end
|
1095
|
+
def to_hash
|
1096
|
+
end
|
905
1097
|
end
|
906
1098
|
|
907
1099
|
module DiscountInterval
|
908
1100
|
extend Orb::Internal::Type::Union
|
909
1101
|
|
1102
|
+
Variants =
|
1103
|
+
T.type_alias do
|
1104
|
+
T.any(
|
1105
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::Amount,
|
1106
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::Percentage,
|
1107
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::Usage
|
1108
|
+
)
|
1109
|
+
end
|
1110
|
+
|
910
1111
|
class Amount < Orb::Internal::Type::BaseModel
|
1112
|
+
OrHash =
|
1113
|
+
T.type_alias do
|
1114
|
+
T.any(
|
1115
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::Amount,
|
1116
|
+
Orb::Internal::AnyHash
|
1117
|
+
)
|
1118
|
+
end
|
1119
|
+
|
911
1120
|
# Only available if discount_type is `amount`.
|
912
1121
|
sig { returns(String) }
|
913
1122
|
attr_accessor :amount_discount
|
@@ -939,8 +1148,7 @@ module Orb
|
|
939
1148
|
end_date: T.nilable(Time),
|
940
1149
|
start_date: Time,
|
941
1150
|
discount_type: Symbol
|
942
|
-
)
|
943
|
-
.returns(T.attached_class)
|
1151
|
+
).returns(T.attached_class)
|
944
1152
|
end
|
945
1153
|
def self.new(
|
946
1154
|
# Only available if discount_type is `amount`.
|
@@ -954,24 +1162,34 @@ module Orb
|
|
954
1162
|
# The start date of the discount interval.
|
955
1163
|
start_date:,
|
956
1164
|
discount_type: :amount
|
957
|
-
)
|
1165
|
+
)
|
1166
|
+
end
|
1167
|
+
|
958
1168
|
sig do
|
959
|
-
override
|
960
|
-
|
961
|
-
|
962
|
-
|
963
|
-
|
964
|
-
|
965
|
-
|
966
|
-
|
967
|
-
|
968
|
-
|
969
|
-
|
1169
|
+
override.returns(
|
1170
|
+
{
|
1171
|
+
amount_discount: String,
|
1172
|
+
applies_to_price_ids: T::Array[String],
|
1173
|
+
applies_to_price_interval_ids: T::Array[String],
|
1174
|
+
discount_type: Symbol,
|
1175
|
+
end_date: T.nilable(Time),
|
1176
|
+
start_date: Time
|
1177
|
+
}
|
1178
|
+
)
|
1179
|
+
end
|
1180
|
+
def to_hash
|
970
1181
|
end
|
971
|
-
def to_hash; end
|
972
1182
|
end
|
973
1183
|
|
974
1184
|
class Percentage < Orb::Internal::Type::BaseModel
|
1185
|
+
OrHash =
|
1186
|
+
T.type_alias do
|
1187
|
+
T.any(
|
1188
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::Percentage,
|
1189
|
+
Orb::Internal::AnyHash
|
1190
|
+
)
|
1191
|
+
end
|
1192
|
+
|
975
1193
|
# The price ids that this discount interval applies to.
|
976
1194
|
sig { returns(T::Array[String]) }
|
977
1195
|
attr_accessor :applies_to_price_ids
|
@@ -1004,8 +1222,7 @@ module Orb
|
|
1004
1222
|
percentage_discount: Float,
|
1005
1223
|
start_date: Time,
|
1006
1224
|
discount_type: Symbol
|
1007
|
-
)
|
1008
|
-
.returns(T.attached_class)
|
1225
|
+
).returns(T.attached_class)
|
1009
1226
|
end
|
1010
1227
|
def self.new(
|
1011
1228
|
# The price ids that this discount interval applies to.
|
@@ -1020,24 +1237,34 @@ module Orb
|
|
1020
1237
|
# The start date of the discount interval.
|
1021
1238
|
start_date:,
|
1022
1239
|
discount_type: :percentage
|
1023
|
-
)
|
1240
|
+
)
|
1241
|
+
end
|
1242
|
+
|
1024
1243
|
sig do
|
1025
|
-
override
|
1026
|
-
|
1027
|
-
|
1028
|
-
|
1029
|
-
|
1030
|
-
|
1031
|
-
|
1032
|
-
|
1033
|
-
|
1034
|
-
|
1035
|
-
|
1244
|
+
override.returns(
|
1245
|
+
{
|
1246
|
+
applies_to_price_ids: T::Array[String],
|
1247
|
+
applies_to_price_interval_ids: T::Array[String],
|
1248
|
+
discount_type: Symbol,
|
1249
|
+
end_date: T.nilable(Time),
|
1250
|
+
percentage_discount: Float,
|
1251
|
+
start_date: Time
|
1252
|
+
}
|
1253
|
+
)
|
1254
|
+
end
|
1255
|
+
def to_hash
|
1036
1256
|
end
|
1037
|
-
def to_hash; end
|
1038
1257
|
end
|
1039
1258
|
|
1040
1259
|
class Usage < Orb::Internal::Type::BaseModel
|
1260
|
+
OrHash =
|
1261
|
+
T.type_alias do
|
1262
|
+
T.any(
|
1263
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::Usage,
|
1264
|
+
Orb::Internal::AnyHash
|
1265
|
+
)
|
1266
|
+
end
|
1267
|
+
|
1041
1268
|
# The price ids that this discount interval applies to.
|
1042
1269
|
sig { returns(T::Array[String]) }
|
1043
1270
|
attr_accessor :applies_to_price_ids
|
@@ -1070,8 +1297,7 @@ module Orb
|
|
1070
1297
|
start_date: Time,
|
1071
1298
|
usage_discount: Float,
|
1072
1299
|
discount_type: Symbol
|
1073
|
-
)
|
1074
|
-
.returns(T.attached_class)
|
1300
|
+
).returns(T.attached_class)
|
1075
1301
|
end
|
1076
1302
|
def self.new(
|
1077
1303
|
# The price ids that this discount interval applies to.
|
@@ -1086,33 +1312,45 @@ module Orb
|
|
1086
1312
|
# discount is for
|
1087
1313
|
usage_discount:,
|
1088
1314
|
discount_type: :usage
|
1089
|
-
)
|
1315
|
+
)
|
1316
|
+
end
|
1317
|
+
|
1090
1318
|
sig do
|
1091
|
-
override
|
1092
|
-
|
1093
|
-
|
1094
|
-
|
1095
|
-
|
1096
|
-
|
1097
|
-
|
1098
|
-
|
1099
|
-
|
1100
|
-
|
1101
|
-
|
1319
|
+
override.returns(
|
1320
|
+
{
|
1321
|
+
applies_to_price_ids: T::Array[String],
|
1322
|
+
applies_to_price_interval_ids: T::Array[String],
|
1323
|
+
discount_type: Symbol,
|
1324
|
+
end_date: T.nilable(Time),
|
1325
|
+
start_date: Time,
|
1326
|
+
usage_discount: Float
|
1327
|
+
}
|
1328
|
+
)
|
1329
|
+
end
|
1330
|
+
def to_hash
|
1102
1331
|
end
|
1103
|
-
def to_hash; end
|
1104
1332
|
end
|
1105
1333
|
|
1106
1334
|
sig do
|
1107
|
-
override
|
1108
|
-
|
1109
|
-
|
1110
|
-
|
1335
|
+
override.returns(
|
1336
|
+
T::Array[
|
1337
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::Variants
|
1338
|
+
]
|
1339
|
+
)
|
1340
|
+
end
|
1341
|
+
def self.variants
|
1111
1342
|
end
|
1112
|
-
def self.variants; end
|
1113
1343
|
end
|
1114
1344
|
|
1115
1345
|
class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
|
1346
|
+
OrHash =
|
1347
|
+
T.type_alias do
|
1348
|
+
T.any(
|
1349
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::FixedFeeQuantitySchedule,
|
1350
|
+
Orb::Internal::AnyHash
|
1351
|
+
)
|
1352
|
+
end
|
1353
|
+
|
1116
1354
|
sig { returns(T.nilable(Time)) }
|
1117
1355
|
attr_accessor :end_date
|
1118
1356
|
|
@@ -1126,18 +1364,39 @@ module Orb
|
|
1126
1364
|
attr_accessor :start_date
|
1127
1365
|
|
1128
1366
|
sig do
|
1129
|
-
params(
|
1130
|
-
.
|
1367
|
+
params(
|
1368
|
+
end_date: T.nilable(Time),
|
1369
|
+
price_id: String,
|
1370
|
+
quantity: Float,
|
1371
|
+
start_date: Time
|
1372
|
+
).returns(T.attached_class)
|
1373
|
+
end
|
1374
|
+
def self.new(end_date:, price_id:, quantity:, start_date:)
|
1131
1375
|
end
|
1132
|
-
def self.new(end_date:, price_id:, quantity:, start_date:); end
|
1133
1376
|
|
1134
1377
|
sig do
|
1135
|
-
override.returns(
|
1378
|
+
override.returns(
|
1379
|
+
{
|
1380
|
+
end_date: T.nilable(Time),
|
1381
|
+
price_id: String,
|
1382
|
+
quantity: Float,
|
1383
|
+
start_date: Time
|
1384
|
+
}
|
1385
|
+
)
|
1386
|
+
end
|
1387
|
+
def to_hash
|
1136
1388
|
end
|
1137
|
-
def to_hash; end
|
1138
1389
|
end
|
1139
1390
|
|
1140
1391
|
class MaximumInterval < Orb::Internal::Type::BaseModel
|
1392
|
+
OrHash =
|
1393
|
+
T.type_alias do
|
1394
|
+
T.any(
|
1395
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::MaximumInterval,
|
1396
|
+
Orb::Internal::AnyHash
|
1397
|
+
)
|
1398
|
+
end
|
1399
|
+
|
1141
1400
|
# The price ids that this maximum interval applies to.
|
1142
1401
|
sig { returns(T::Array[String]) }
|
1143
1402
|
attr_accessor :applies_to_price_ids
|
@@ -1166,8 +1425,7 @@ module Orb
|
|
1166
1425
|
end_date: T.nilable(Time),
|
1167
1426
|
maximum_amount: String,
|
1168
1427
|
start_date: Time
|
1169
|
-
)
|
1170
|
-
.returns(T.attached_class)
|
1428
|
+
).returns(T.attached_class)
|
1171
1429
|
end
|
1172
1430
|
def self.new(
|
1173
1431
|
# The price ids that this maximum interval applies to.
|
@@ -1181,23 +1439,33 @@ module Orb
|
|
1181
1439
|
maximum_amount:,
|
1182
1440
|
# The start date of the maximum interval.
|
1183
1441
|
start_date:
|
1184
|
-
)
|
1442
|
+
)
|
1443
|
+
end
|
1444
|
+
|
1185
1445
|
sig do
|
1186
|
-
override
|
1187
|
-
|
1188
|
-
|
1189
|
-
|
1190
|
-
|
1191
|
-
|
1192
|
-
|
1193
|
-
|
1194
|
-
|
1195
|
-
|
1446
|
+
override.returns(
|
1447
|
+
{
|
1448
|
+
applies_to_price_ids: T::Array[String],
|
1449
|
+
applies_to_price_interval_ids: T::Array[String],
|
1450
|
+
end_date: T.nilable(Time),
|
1451
|
+
maximum_amount: String,
|
1452
|
+
start_date: Time
|
1453
|
+
}
|
1454
|
+
)
|
1455
|
+
end
|
1456
|
+
def to_hash
|
1196
1457
|
end
|
1197
|
-
def to_hash; end
|
1198
1458
|
end
|
1199
1459
|
|
1200
1460
|
class MinimumInterval < Orb::Internal::Type::BaseModel
|
1461
|
+
OrHash =
|
1462
|
+
T.type_alias do
|
1463
|
+
T.any(
|
1464
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::MinimumInterval,
|
1465
|
+
Orb::Internal::AnyHash
|
1466
|
+
)
|
1467
|
+
end
|
1468
|
+
|
1201
1469
|
# The price ids that this minimum interval applies to.
|
1202
1470
|
sig { returns(T::Array[String]) }
|
1203
1471
|
attr_accessor :applies_to_price_ids
|
@@ -1226,8 +1494,7 @@ module Orb
|
|
1226
1494
|
end_date: T.nilable(Time),
|
1227
1495
|
minimum_amount: String,
|
1228
1496
|
start_date: Time
|
1229
|
-
)
|
1230
|
-
.returns(T.attached_class)
|
1497
|
+
).returns(T.attached_class)
|
1231
1498
|
end
|
1232
1499
|
def self.new(
|
1233
1500
|
# The price ids that this minimum interval applies to.
|
@@ -1241,35 +1508,55 @@ module Orb
|
|
1241
1508
|
minimum_amount:,
|
1242
1509
|
# The start date of the minimum interval.
|
1243
1510
|
start_date:
|
1244
|
-
)
|
1511
|
+
)
|
1512
|
+
end
|
1513
|
+
|
1245
1514
|
sig do
|
1246
|
-
override
|
1247
|
-
|
1248
|
-
|
1249
|
-
|
1250
|
-
|
1251
|
-
|
1252
|
-
|
1253
|
-
|
1254
|
-
|
1255
|
-
|
1515
|
+
override.returns(
|
1516
|
+
{
|
1517
|
+
applies_to_price_ids: T::Array[String],
|
1518
|
+
applies_to_price_interval_ids: T::Array[String],
|
1519
|
+
end_date: T.nilable(Time),
|
1520
|
+
minimum_amount: String,
|
1521
|
+
start_date: Time
|
1522
|
+
}
|
1523
|
+
)
|
1524
|
+
end
|
1525
|
+
def to_hash
|
1256
1526
|
end
|
1257
|
-
def to_hash; end
|
1258
1527
|
end
|
1259
1528
|
|
1260
1529
|
class PendingSubscriptionChange < Orb::Internal::Type::BaseModel
|
1530
|
+
OrHash =
|
1531
|
+
T.type_alias do
|
1532
|
+
T.any(
|
1533
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PendingSubscriptionChange,
|
1534
|
+
Orb::Internal::AnyHash
|
1535
|
+
)
|
1536
|
+
end
|
1537
|
+
|
1261
1538
|
sig { returns(String) }
|
1262
1539
|
attr_accessor :id
|
1263
1540
|
|
1264
1541
|
# A pending subscription change if one exists on this subscription.
|
1265
1542
|
sig { params(id: String).returns(T.attached_class) }
|
1266
|
-
def self.new(id:)
|
1543
|
+
def self.new(id:)
|
1544
|
+
end
|
1267
1545
|
|
1268
|
-
sig { override.returns({id: String}) }
|
1269
|
-
def to_hash
|
1546
|
+
sig { override.returns({ id: String }) }
|
1547
|
+
def to_hash
|
1548
|
+
end
|
1270
1549
|
end
|
1271
1550
|
|
1272
1551
|
class PriceInterval < Orb::Internal::Type::BaseModel
|
1552
|
+
OrHash =
|
1553
|
+
T.type_alias do
|
1554
|
+
T.any(
|
1555
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PriceInterval,
|
1556
|
+
Orb::Internal::AnyHash
|
1557
|
+
)
|
1558
|
+
end
|
1559
|
+
|
1273
1560
|
sig { returns(String) }
|
1274
1561
|
attr_accessor :id
|
1275
1562
|
|
@@ -1303,7 +1590,9 @@ module Orb
|
|
1303
1590
|
sig do
|
1304
1591
|
returns(
|
1305
1592
|
T.nilable(
|
1306
|
-
T::Array[
|
1593
|
+
T::Array[
|
1594
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PriceInterval::FixedFeeQuantityTransition
|
1595
|
+
]
|
1307
1596
|
)
|
1308
1597
|
)
|
1309
1598
|
end
|
@@ -1322,34 +1611,34 @@ module Orb
|
|
1322
1611
|
sig do
|
1323
1612
|
returns(
|
1324
1613
|
T.any(
|
1325
|
-
Orb::
|
1326
|
-
Orb::
|
1327
|
-
Orb::
|
1328
|
-
Orb::
|
1329
|
-
Orb::
|
1330
|
-
Orb::
|
1331
|
-
Orb::
|
1332
|
-
Orb::
|
1333
|
-
Orb::
|
1334
|
-
Orb::
|
1335
|
-
Orb::
|
1336
|
-
Orb::
|
1337
|
-
Orb::
|
1338
|
-
Orb::
|
1339
|
-
Orb::
|
1340
|
-
Orb::
|
1341
|
-
Orb::
|
1342
|
-
Orb::
|
1343
|
-
Orb::
|
1344
|
-
Orb::
|
1345
|
-
Orb::
|
1346
|
-
Orb::
|
1347
|
-
Orb::
|
1348
|
-
Orb::
|
1349
|
-
Orb::
|
1350
|
-
Orb::
|
1351
|
-
Orb::
|
1352
|
-
Orb::
|
1614
|
+
Orb::Price::Unit,
|
1615
|
+
Orb::Price::Package,
|
1616
|
+
Orb::Price::Matrix,
|
1617
|
+
Orb::Price::Tiered,
|
1618
|
+
Orb::Price::TieredBps,
|
1619
|
+
Orb::Price::Bps,
|
1620
|
+
Orb::Price::BulkBps,
|
1621
|
+
Orb::Price::Bulk,
|
1622
|
+
Orb::Price::ThresholdTotalAmount,
|
1623
|
+
Orb::Price::TieredPackage,
|
1624
|
+
Orb::Price::GroupedTiered,
|
1625
|
+
Orb::Price::TieredWithMinimum,
|
1626
|
+
Orb::Price::TieredPackageWithMinimum,
|
1627
|
+
Orb::Price::PackageWithAllocation,
|
1628
|
+
Orb::Price::UnitWithPercent,
|
1629
|
+
Orb::Price::MatrixWithAllocation,
|
1630
|
+
Orb::Price::TieredWithProration,
|
1631
|
+
Orb::Price::UnitWithProration,
|
1632
|
+
Orb::Price::GroupedAllocation,
|
1633
|
+
Orb::Price::GroupedWithProratedMinimum,
|
1634
|
+
Orb::Price::GroupedWithMeteredMinimum,
|
1635
|
+
Orb::Price::MatrixWithDisplayName,
|
1636
|
+
Orb::Price::BulkWithProration,
|
1637
|
+
Orb::Price::GroupedTieredPackage,
|
1638
|
+
Orb::Price::MaxGroupTieredPackage,
|
1639
|
+
Orb::Price::ScalableMatrixWithUnitPricing,
|
1640
|
+
Orb::Price::ScalableMatrixWithTieredPricing,
|
1641
|
+
Orb::Price::CumulativeGroupedBulk
|
1353
1642
|
)
|
1354
1643
|
)
|
1355
1644
|
end
|
@@ -1376,49 +1665,46 @@ module Orb
|
|
1376
1665
|
current_billing_period_start_date: T.nilable(Time),
|
1377
1666
|
end_date: T.nilable(Time),
|
1378
1667
|
filter: T.nilable(String),
|
1379
|
-
fixed_fee_quantity_transitions:
|
1380
|
-
T
|
1381
|
-
T
|
1382
|
-
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PriceInterval::FixedFeeQuantityTransition
|
1383
|
-
|
1384
|
-
|
1385
|
-
|
1386
|
-
|
1387
|
-
|
1388
|
-
|
1389
|
-
|
1390
|
-
|
1391
|
-
|
1392
|
-
|
1393
|
-
|
1394
|
-
|
1395
|
-
|
1396
|
-
|
1397
|
-
|
1398
|
-
|
1399
|
-
|
1400
|
-
|
1401
|
-
|
1402
|
-
|
1403
|
-
|
1404
|
-
|
1405
|
-
|
1406
|
-
|
1407
|
-
|
1408
|
-
|
1409
|
-
|
1410
|
-
|
1411
|
-
|
1412
|
-
|
1413
|
-
|
1414
|
-
|
1415
|
-
|
1416
|
-
Orb::Models::Price::CumulativeGroupedBulk
|
1417
|
-
),
|
1668
|
+
fixed_fee_quantity_transitions:
|
1669
|
+
T.nilable(
|
1670
|
+
T::Array[
|
1671
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PriceInterval::FixedFeeQuantityTransition::OrHash
|
1672
|
+
]
|
1673
|
+
),
|
1674
|
+
price:
|
1675
|
+
T.any(
|
1676
|
+
Orb::Price::Unit::OrHash,
|
1677
|
+
Orb::Price::Package::OrHash,
|
1678
|
+
Orb::Price::Matrix::OrHash,
|
1679
|
+
Orb::Price::Tiered::OrHash,
|
1680
|
+
Orb::Price::TieredBps::OrHash,
|
1681
|
+
Orb::Price::Bps::OrHash,
|
1682
|
+
Orb::Price::BulkBps::OrHash,
|
1683
|
+
Orb::Price::Bulk::OrHash,
|
1684
|
+
Orb::Price::ThresholdTotalAmount::OrHash,
|
1685
|
+
Orb::Price::TieredPackage::OrHash,
|
1686
|
+
Orb::Price::GroupedTiered::OrHash,
|
1687
|
+
Orb::Price::TieredWithMinimum::OrHash,
|
1688
|
+
Orb::Price::TieredPackageWithMinimum::OrHash,
|
1689
|
+
Orb::Price::PackageWithAllocation::OrHash,
|
1690
|
+
Orb::Price::UnitWithPercent::OrHash,
|
1691
|
+
Orb::Price::MatrixWithAllocation::OrHash,
|
1692
|
+
Orb::Price::TieredWithProration::OrHash,
|
1693
|
+
Orb::Price::UnitWithProration::OrHash,
|
1694
|
+
Orb::Price::GroupedAllocation::OrHash,
|
1695
|
+
Orb::Price::GroupedWithProratedMinimum::OrHash,
|
1696
|
+
Orb::Price::GroupedWithMeteredMinimum::OrHash,
|
1697
|
+
Orb::Price::MatrixWithDisplayName::OrHash,
|
1698
|
+
Orb::Price::BulkWithProration::OrHash,
|
1699
|
+
Orb::Price::GroupedTieredPackage::OrHash,
|
1700
|
+
Orb::Price::MaxGroupTieredPackage::OrHash,
|
1701
|
+
Orb::Price::ScalableMatrixWithUnitPricing::OrHash,
|
1702
|
+
Orb::Price::ScalableMatrixWithTieredPricing::OrHash,
|
1703
|
+
Orb::Price::CumulativeGroupedBulk::OrHash
|
1704
|
+
),
|
1418
1705
|
start_date: Time,
|
1419
1706
|
usage_customer_ids: T.nilable(T::Array[String])
|
1420
|
-
)
|
1421
|
-
.returns(T.attached_class)
|
1707
|
+
).returns(T.attached_class)
|
1422
1708
|
end
|
1423
1709
|
def self.new(
|
1424
1710
|
id:,
|
@@ -1457,58 +1743,72 @@ module Orb
|
|
1457
1743
|
# A list of customer IDs whose usage events will be aggregated and billed under
|
1458
1744
|
# this price interval.
|
1459
1745
|
usage_customer_ids:
|
1460
|
-
)
|
1746
|
+
)
|
1747
|
+
end
|
1748
|
+
|
1461
1749
|
sig do
|
1462
|
-
override
|
1463
|
-
|
1464
|
-
|
1465
|
-
|
1466
|
-
|
1467
|
-
|
1468
|
-
|
1469
|
-
|
1470
|
-
|
1471
|
-
|
1472
|
-
T::Array[
|
1750
|
+
override.returns(
|
1751
|
+
{
|
1752
|
+
id: String,
|
1753
|
+
billing_cycle_day: Integer,
|
1754
|
+
current_billing_period_end_date: T.nilable(Time),
|
1755
|
+
current_billing_period_start_date: T.nilable(Time),
|
1756
|
+
end_date: T.nilable(Time),
|
1757
|
+
filter: T.nilable(String),
|
1758
|
+
fixed_fee_quantity_transitions:
|
1759
|
+
T.nilable(
|
1760
|
+
T::Array[
|
1761
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PriceInterval::FixedFeeQuantityTransition
|
1762
|
+
]
|
1473
1763
|
),
|
1474
|
-
|
1475
|
-
|
1476
|
-
Orb::
|
1477
|
-
Orb::
|
1478
|
-
Orb::
|
1479
|
-
Orb::
|
1480
|
-
Orb::
|
1481
|
-
Orb::
|
1482
|
-
Orb::
|
1483
|
-
Orb::
|
1484
|
-
Orb::
|
1485
|
-
Orb::
|
1486
|
-
Orb::
|
1487
|
-
Orb::
|
1488
|
-
Orb::
|
1489
|
-
Orb::
|
1490
|
-
Orb::
|
1491
|
-
Orb::
|
1492
|
-
Orb::
|
1493
|
-
Orb::
|
1494
|
-
Orb::
|
1495
|
-
Orb::
|
1496
|
-
Orb::
|
1497
|
-
Orb::
|
1498
|
-
Orb::
|
1499
|
-
Orb::
|
1500
|
-
Orb::
|
1501
|
-
Orb::
|
1502
|
-
Orb::
|
1764
|
+
price:
|
1765
|
+
T.any(
|
1766
|
+
Orb::Price::Unit,
|
1767
|
+
Orb::Price::Package,
|
1768
|
+
Orb::Price::Matrix,
|
1769
|
+
Orb::Price::Tiered,
|
1770
|
+
Orb::Price::TieredBps,
|
1771
|
+
Orb::Price::Bps,
|
1772
|
+
Orb::Price::BulkBps,
|
1773
|
+
Orb::Price::Bulk,
|
1774
|
+
Orb::Price::ThresholdTotalAmount,
|
1775
|
+
Orb::Price::TieredPackage,
|
1776
|
+
Orb::Price::GroupedTiered,
|
1777
|
+
Orb::Price::TieredWithMinimum,
|
1778
|
+
Orb::Price::TieredPackageWithMinimum,
|
1779
|
+
Orb::Price::PackageWithAllocation,
|
1780
|
+
Orb::Price::UnitWithPercent,
|
1781
|
+
Orb::Price::MatrixWithAllocation,
|
1782
|
+
Orb::Price::TieredWithProration,
|
1783
|
+
Orb::Price::UnitWithProration,
|
1784
|
+
Orb::Price::GroupedAllocation,
|
1785
|
+
Orb::Price::GroupedWithProratedMinimum,
|
1786
|
+
Orb::Price::GroupedWithMeteredMinimum,
|
1787
|
+
Orb::Price::MatrixWithDisplayName,
|
1788
|
+
Orb::Price::BulkWithProration,
|
1789
|
+
Orb::Price::GroupedTieredPackage,
|
1790
|
+
Orb::Price::MaxGroupTieredPackage,
|
1791
|
+
Orb::Price::ScalableMatrixWithUnitPricing,
|
1792
|
+
Orb::Price::ScalableMatrixWithTieredPricing,
|
1793
|
+
Orb::Price::CumulativeGroupedBulk
|
1503
1794
|
),
|
1504
|
-
|
1505
|
-
|
1506
|
-
|
1507
|
-
|
1795
|
+
start_date: Time,
|
1796
|
+
usage_customer_ids: T.nilable(T::Array[String])
|
1797
|
+
}
|
1798
|
+
)
|
1799
|
+
end
|
1800
|
+
def to_hash
|
1508
1801
|
end
|
1509
|
-
def to_hash; end
|
1510
1802
|
|
1511
1803
|
class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
|
1804
|
+
OrHash =
|
1805
|
+
T.type_alias do
|
1806
|
+
T.any(
|
1807
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PriceInterval::FixedFeeQuantityTransition,
|
1808
|
+
Orb::Internal::AnyHash
|
1809
|
+
)
|
1810
|
+
end
|
1811
|
+
|
1512
1812
|
sig { returns(Time) }
|
1513
1813
|
attr_accessor :effective_date
|
1514
1814
|
|
@@ -1518,15 +1818,35 @@ module Orb
|
|
1518
1818
|
sig { returns(Integer) }
|
1519
1819
|
attr_accessor :quantity
|
1520
1820
|
|
1521
|
-
sig
|
1522
|
-
|
1821
|
+
sig do
|
1822
|
+
params(
|
1823
|
+
effective_date: Time,
|
1824
|
+
price_id: String,
|
1825
|
+
quantity: Integer
|
1826
|
+
).returns(T.attached_class)
|
1827
|
+
end
|
1828
|
+
def self.new(effective_date:, price_id:, quantity:)
|
1829
|
+
end
|
1523
1830
|
|
1524
|
-
sig
|
1525
|
-
|
1831
|
+
sig do
|
1832
|
+
override.returns(
|
1833
|
+
{ effective_date: Time, price_id: String, quantity: Integer }
|
1834
|
+
)
|
1835
|
+
end
|
1836
|
+
def to_hash
|
1837
|
+
end
|
1526
1838
|
end
|
1527
1839
|
end
|
1528
1840
|
|
1529
1841
|
class RedeemedCoupon < Orb::Internal::Type::BaseModel
|
1842
|
+
OrHash =
|
1843
|
+
T.type_alias do
|
1844
|
+
T.any(
|
1845
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::RedeemedCoupon,
|
1846
|
+
Orb::Internal::AnyHash
|
1847
|
+
)
|
1848
|
+
end
|
1849
|
+
|
1530
1850
|
sig { returns(String) }
|
1531
1851
|
attr_accessor :coupon_id
|
1532
1852
|
|
@@ -1537,56 +1857,107 @@ module Orb
|
|
1537
1857
|
attr_accessor :start_date
|
1538
1858
|
|
1539
1859
|
sig do
|
1540
|
-
params(
|
1860
|
+
params(
|
1861
|
+
coupon_id: String,
|
1862
|
+
end_date: T.nilable(Time),
|
1863
|
+
start_date: Time
|
1864
|
+
).returns(T.attached_class)
|
1865
|
+
end
|
1866
|
+
def self.new(coupon_id:, end_date:, start_date:)
|
1541
1867
|
end
|
1542
|
-
def self.new(coupon_id:, end_date:, start_date:); end
|
1543
1868
|
|
1544
|
-
sig
|
1545
|
-
|
1869
|
+
sig do
|
1870
|
+
override.returns(
|
1871
|
+
{ coupon_id: String, end_date: T.nilable(Time), start_date: Time }
|
1872
|
+
)
|
1873
|
+
end
|
1874
|
+
def to_hash
|
1875
|
+
end
|
1546
1876
|
end
|
1547
1877
|
|
1548
1878
|
module Status
|
1549
1879
|
extend Orb::Internal::Type::Enum
|
1550
1880
|
|
1551
1881
|
TaggedSymbol =
|
1552
|
-
T.type_alias
|
1882
|
+
T.type_alias do
|
1883
|
+
T.all(
|
1884
|
+
Symbol,
|
1885
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::Status
|
1886
|
+
)
|
1887
|
+
end
|
1553
1888
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
1554
1889
|
|
1555
|
-
ACTIVE =
|
1556
|
-
|
1890
|
+
ACTIVE =
|
1891
|
+
T.let(
|
1892
|
+
:active,
|
1893
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::Status::TaggedSymbol
|
1894
|
+
)
|
1895
|
+
ENDED =
|
1896
|
+
T.let(
|
1897
|
+
:ended,
|
1898
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::Status::TaggedSymbol
|
1899
|
+
)
|
1557
1900
|
UPCOMING =
|
1558
|
-
T.let(
|
1901
|
+
T.let(
|
1902
|
+
:upcoming,
|
1903
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::Status::TaggedSymbol
|
1904
|
+
)
|
1559
1905
|
|
1560
|
-
sig
|
1561
|
-
|
1906
|
+
sig do
|
1907
|
+
override.returns(
|
1908
|
+
T::Array[
|
1909
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::Status::TaggedSymbol
|
1910
|
+
]
|
1911
|
+
)
|
1912
|
+
end
|
1913
|
+
def self.values
|
1914
|
+
end
|
1562
1915
|
end
|
1563
1916
|
|
1564
1917
|
class TrialInfo < Orb::Internal::Type::BaseModel
|
1918
|
+
OrHash =
|
1919
|
+
T.type_alias do
|
1920
|
+
T.any(
|
1921
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::TrialInfo,
|
1922
|
+
Orb::Internal::AnyHash
|
1923
|
+
)
|
1924
|
+
end
|
1925
|
+
|
1565
1926
|
sig { returns(T.nilable(Time)) }
|
1566
1927
|
attr_accessor :end_date
|
1567
1928
|
|
1568
1929
|
sig { params(end_date: T.nilable(Time)).returns(T.attached_class) }
|
1569
|
-
def self.new(end_date:)
|
1930
|
+
def self.new(end_date:)
|
1931
|
+
end
|
1570
1932
|
|
1571
|
-
sig { override.returns({end_date: T.nilable(Time)}) }
|
1572
|
-
def to_hash
|
1933
|
+
sig { override.returns({ end_date: T.nilable(Time) }) }
|
1934
|
+
def to_hash
|
1935
|
+
end
|
1573
1936
|
end
|
1574
1937
|
|
1575
1938
|
class ChangedResources < Orb::Internal::Type::BaseModel
|
1939
|
+
OrHash =
|
1940
|
+
T.type_alias do
|
1941
|
+
T.any(
|
1942
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::ChangedResources,
|
1943
|
+
Orb::Internal::AnyHash
|
1944
|
+
)
|
1945
|
+
end
|
1946
|
+
|
1576
1947
|
# The credit notes that were created as part of this operation.
|
1577
|
-
sig { returns(T::Array[Orb::
|
1948
|
+
sig { returns(T::Array[Orb::CreditNote]) }
|
1578
1949
|
attr_accessor :created_credit_notes
|
1579
1950
|
|
1580
1951
|
# The invoices that were created as part of this operation.
|
1581
|
-
sig { returns(T::Array[Orb::
|
1952
|
+
sig { returns(T::Array[Orb::Invoice]) }
|
1582
1953
|
attr_accessor :created_invoices
|
1583
1954
|
|
1584
1955
|
# The credit notes that were voided as part of this operation.
|
1585
|
-
sig { returns(T::Array[Orb::
|
1956
|
+
sig { returns(T::Array[Orb::CreditNote]) }
|
1586
1957
|
attr_accessor :voided_credit_notes
|
1587
1958
|
|
1588
1959
|
# The invoices that were voided as part of this operation.
|
1589
|
-
sig { returns(T::Array[Orb::
|
1960
|
+
sig { returns(T::Array[Orb::Invoice]) }
|
1590
1961
|
attr_accessor :voided_invoices
|
1591
1962
|
|
1592
1963
|
# The resources that were changed as part of this operation. Only present when
|
@@ -1594,12 +1965,11 @@ module Orb
|
|
1594
1965
|
# `include_changed_resources` parameter was passed in the request.
|
1595
1966
|
sig do
|
1596
1967
|
params(
|
1597
|
-
created_credit_notes: T::Array[
|
1598
|
-
created_invoices: T::Array[
|
1599
|
-
voided_credit_notes: T::Array[
|
1600
|
-
voided_invoices: T::Array[
|
1601
|
-
)
|
1602
|
-
.returns(T.attached_class)
|
1968
|
+
created_credit_notes: T::Array[Orb::CreditNote::OrHash],
|
1969
|
+
created_invoices: T::Array[Orb::Invoice::OrHash],
|
1970
|
+
voided_credit_notes: T::Array[Orb::CreditNote::OrHash],
|
1971
|
+
voided_invoices: T::Array[Orb::Invoice::OrHash]
|
1972
|
+
).returns(T.attached_class)
|
1603
1973
|
end
|
1604
1974
|
def self.new(
|
1605
1975
|
# The credit notes that were created as part of this operation.
|
@@ -1610,19 +1980,21 @@ module Orb
|
|
1610
1980
|
voided_credit_notes:,
|
1611
1981
|
# The invoices that were voided as part of this operation.
|
1612
1982
|
voided_invoices:
|
1613
|
-
)
|
1983
|
+
)
|
1984
|
+
end
|
1985
|
+
|
1614
1986
|
sig do
|
1615
|
-
override
|
1616
|
-
|
1617
|
-
|
1618
|
-
|
1619
|
-
|
1620
|
-
|
1621
|
-
|
1622
|
-
|
1623
|
-
|
1987
|
+
override.returns(
|
1988
|
+
{
|
1989
|
+
created_credit_notes: T::Array[Orb::CreditNote],
|
1990
|
+
created_invoices: T::Array[Orb::Invoice],
|
1991
|
+
voided_credit_notes: T::Array[Orb::CreditNote],
|
1992
|
+
voided_invoices: T::Array[Orb::Invoice]
|
1993
|
+
}
|
1994
|
+
)
|
1995
|
+
end
|
1996
|
+
def to_hash
|
1624
1997
|
end
|
1625
|
-
def to_hash; end
|
1626
1998
|
end
|
1627
1999
|
end
|
1628
2000
|
end
|