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 SubscriptionPriceIntervalsResponse < Orb::Internal::Type::BaseModel
|
6
|
+
OrHash =
|
7
|
+
T.type_alias do
|
8
|
+
T.any(
|
9
|
+
Orb::Models::SubscriptionPriceIntervalsResponse,
|
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::SubscriptionPriceIntervalsResponse::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::SubscriptionPriceIntervalsResponse::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::SubscriptionPriceIntervalsResponse::BillingCycleAnchorConfiguration
|
32
|
-
|
33
|
-
)
|
34
|
-
)
|
35
|
-
.void
|
48
|
+
billing_cycle_anchor_configuration:
|
49
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::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::SubscriptionPriceIntervalsResponse::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::SubscriptionPriceIntervalsResponse::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::SubscriptionPriceIntervalsResponse::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,16 +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::SubscriptionPriceIntervalsResponse::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
|
-
|
145
|
-
|
146
|
-
|
181
|
+
pending_subscription_change:
|
182
|
+
T.nilable(
|
183
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::PendingSubscriptionChange::OrHash
|
184
|
+
)
|
185
|
+
).void
|
147
186
|
end
|
148
187
|
attr_writer :pending_subscription_change
|
149
188
|
|
@@ -151,24 +190,38 @@ module Orb
|
|
151
190
|
# subscribed to by a customer. Plans define the billing behavior of the
|
152
191
|
# subscription. You can see more about how to configure prices in the
|
153
192
|
# [Price resource](/reference/price).
|
154
|
-
sig { returns(Orb::
|
193
|
+
sig { returns(Orb::Plan) }
|
155
194
|
attr_reader :plan
|
156
195
|
|
157
|
-
sig { params(plan:
|
196
|
+
sig { params(plan: Orb::Plan::OrHash).void }
|
158
197
|
attr_writer :plan
|
159
198
|
|
160
199
|
# The price intervals for this subscription.
|
161
|
-
sig
|
200
|
+
sig do
|
201
|
+
returns(
|
202
|
+
T::Array[
|
203
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::PriceInterval
|
204
|
+
]
|
205
|
+
)
|
206
|
+
end
|
162
207
|
attr_accessor :price_intervals
|
163
208
|
|
164
|
-
sig
|
209
|
+
sig do
|
210
|
+
returns(
|
211
|
+
T.nilable(
|
212
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::RedeemedCoupon
|
213
|
+
)
|
214
|
+
)
|
215
|
+
end
|
165
216
|
attr_reader :redeemed_coupon
|
166
217
|
|
167
218
|
sig do
|
168
219
|
params(
|
169
|
-
redeemed_coupon:
|
170
|
-
|
171
|
-
|
220
|
+
redeemed_coupon:
|
221
|
+
T.nilable(
|
222
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::RedeemedCoupon::OrHash
|
223
|
+
)
|
224
|
+
).void
|
172
225
|
end
|
173
226
|
attr_writer :redeemed_coupon
|
174
227
|
|
@@ -176,33 +229,45 @@ module Orb
|
|
176
229
|
sig { returns(Time) }
|
177
230
|
attr_accessor :start_date
|
178
231
|
|
179
|
-
sig
|
232
|
+
sig do
|
233
|
+
returns(
|
234
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::Status::TaggedSymbol
|
235
|
+
)
|
236
|
+
end
|
180
237
|
attr_accessor :status
|
181
238
|
|
182
|
-
sig
|
239
|
+
sig do
|
240
|
+
returns(Orb::Models::SubscriptionPriceIntervalsResponse::TrialInfo)
|
241
|
+
end
|
183
242
|
attr_reader :trial_info
|
184
243
|
|
185
244
|
sig do
|
186
245
|
params(
|
187
|
-
trial_info:
|
188
|
-
|
189
|
-
|
246
|
+
trial_info:
|
247
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::TrialInfo::OrHash
|
248
|
+
).void
|
190
249
|
end
|
191
250
|
attr_writer :trial_info
|
192
251
|
|
193
252
|
# The resources that were changed as part of this operation. Only present when
|
194
253
|
# fetched through the subscription changes API or if the
|
195
254
|
# `include_changed_resources` parameter was passed in the request.
|
196
|
-
sig
|
255
|
+
sig do
|
256
|
+
returns(
|
257
|
+
T.nilable(
|
258
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::ChangedResources
|
259
|
+
)
|
260
|
+
)
|
261
|
+
end
|
197
262
|
attr_reader :changed_resources
|
198
263
|
|
199
264
|
sig do
|
200
265
|
params(
|
201
|
-
changed_resources:
|
202
|
-
T.
|
203
|
-
|
204
|
-
|
205
|
-
|
266
|
+
changed_resources:
|
267
|
+
T.nilable(
|
268
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::ChangedResources::OrHash
|
269
|
+
)
|
270
|
+
).void
|
206
271
|
end
|
207
272
|
attr_writer :changed_resources
|
208
273
|
|
@@ -210,47 +275,66 @@ module Orb
|
|
210
275
|
params(
|
211
276
|
id: String,
|
212
277
|
active_plan_phase_order: T.nilable(Integer),
|
213
|
-
adjustment_intervals:
|
278
|
+
adjustment_intervals:
|
279
|
+
T::Array[
|
280
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::OrHash
|
281
|
+
],
|
214
282
|
auto_collection: T.nilable(T::Boolean),
|
215
|
-
billing_cycle_anchor_configuration:
|
216
|
-
Orb::Models::SubscriptionPriceIntervalsResponse::BillingCycleAnchorConfiguration,
|
217
|
-
Orb::Internal::AnyHash
|
218
|
-
),
|
283
|
+
billing_cycle_anchor_configuration:
|
284
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::BillingCycleAnchorConfiguration::OrHash,
|
219
285
|
billing_cycle_day: Integer,
|
220
286
|
created_at: Time,
|
221
287
|
current_billing_period_end_date: T.nilable(Time),
|
222
288
|
current_billing_period_start_date: T.nilable(Time),
|
223
|
-
customer:
|
289
|
+
customer: Orb::Customer::OrHash,
|
224
290
|
default_invoice_memo: T.nilable(String),
|
225
|
-
discount_intervals:
|
226
|
-
T
|
227
|
-
|
228
|
-
|
229
|
-
|
230
|
-
|
231
|
-
|
232
|
-
|
291
|
+
discount_intervals:
|
292
|
+
T::Array[
|
293
|
+
T.any(
|
294
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::Amount::OrHash,
|
295
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::Percentage::OrHash,
|
296
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::Usage::OrHash
|
297
|
+
)
|
298
|
+
],
|
233
299
|
end_date: T.nilable(Time),
|
234
|
-
fixed_fee_quantity_schedule:
|
300
|
+
fixed_fee_quantity_schedule:
|
301
|
+
T::Array[
|
302
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::FixedFeeQuantitySchedule::OrHash
|
303
|
+
],
|
235
304
|
invoicing_threshold: T.nilable(String),
|
236
|
-
maximum_intervals:
|
305
|
+
maximum_intervals:
|
306
|
+
T::Array[
|
307
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::MaximumInterval::OrHash
|
308
|
+
],
|
237
309
|
metadata: T::Hash[Symbol, String],
|
238
|
-
minimum_intervals:
|
310
|
+
minimum_intervals:
|
311
|
+
T::Array[
|
312
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::MinimumInterval::OrHash
|
313
|
+
],
|
239
314
|
net_terms: Integer,
|
240
|
-
pending_subscription_change:
|
241
|
-
T.
|
242
|
-
|
243
|
-
|
244
|
-
|
245
|
-
|
315
|
+
pending_subscription_change:
|
316
|
+
T.nilable(
|
317
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::PendingSubscriptionChange::OrHash
|
318
|
+
),
|
319
|
+
plan: Orb::Plan::OrHash,
|
320
|
+
price_intervals:
|
321
|
+
T::Array[
|
322
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::PriceInterval::OrHash
|
323
|
+
],
|
324
|
+
redeemed_coupon:
|
325
|
+
T.nilable(
|
326
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::RedeemedCoupon::OrHash
|
327
|
+
),
|
246
328
|
start_date: Time,
|
247
|
-
status:
|
248
|
-
|
249
|
-
|
250
|
-
|
251
|
-
|
252
|
-
|
253
|
-
|
329
|
+
status:
|
330
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::Status::OrSymbol,
|
331
|
+
trial_info:
|
332
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::TrialInfo::OrHash,
|
333
|
+
changed_resources:
|
334
|
+
T.nilable(
|
335
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::ChangedResources::OrHash
|
336
|
+
)
|
337
|
+
).returns(T.attached_class)
|
254
338
|
end
|
255
339
|
def self.new(
|
256
340
|
id:,
|
@@ -339,50 +423,88 @@ module Orb
|
|
339
423
|
# fetched through the subscription changes API or if the
|
340
424
|
# `include_changed_resources` parameter was passed in the request.
|
341
425
|
changed_resources: nil
|
342
|
-
)
|
426
|
+
)
|
427
|
+
end
|
428
|
+
|
343
429
|
sig do
|
344
|
-
override
|
345
|
-
|
346
|
-
|
347
|
-
|
348
|
-
|
349
|
-
|
350
|
-
|
351
|
-
|
352
|
-
|
353
|
-
|
354
|
-
|
355
|
-
|
356
|
-
|
357
|
-
|
358
|
-
|
430
|
+
override.returns(
|
431
|
+
{
|
432
|
+
id: String,
|
433
|
+
active_plan_phase_order: T.nilable(Integer),
|
434
|
+
adjustment_intervals:
|
435
|
+
T::Array[
|
436
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval
|
437
|
+
],
|
438
|
+
auto_collection: T.nilable(T::Boolean),
|
439
|
+
billing_cycle_anchor_configuration:
|
440
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::BillingCycleAnchorConfiguration,
|
441
|
+
billing_cycle_day: Integer,
|
442
|
+
created_at: Time,
|
443
|
+
current_billing_period_end_date: T.nilable(Time),
|
444
|
+
current_billing_period_start_date: T.nilable(Time),
|
445
|
+
customer: Orb::Customer,
|
446
|
+
default_invoice_memo: T.nilable(String),
|
447
|
+
discount_intervals:
|
448
|
+
T::Array[
|
359
449
|
T.any(
|
360
450
|
Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::Amount,
|
361
451
|
Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::Percentage,
|
362
452
|
Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::Usage
|
363
453
|
)
|
364
454
|
],
|
365
|
-
|
366
|
-
|
367
|
-
|
368
|
-
|
369
|
-
|
370
|
-
|
371
|
-
|
372
|
-
|
373
|
-
|
374
|
-
|
375
|
-
|
376
|
-
|
377
|
-
|
378
|
-
|
379
|
-
|
380
|
-
|
381
|
-
|
455
|
+
end_date: T.nilable(Time),
|
456
|
+
fixed_fee_quantity_schedule:
|
457
|
+
T::Array[
|
458
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::FixedFeeQuantitySchedule
|
459
|
+
],
|
460
|
+
invoicing_threshold: T.nilable(String),
|
461
|
+
maximum_intervals:
|
462
|
+
T::Array[
|
463
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::MaximumInterval
|
464
|
+
],
|
465
|
+
metadata: T::Hash[Symbol, String],
|
466
|
+
minimum_intervals:
|
467
|
+
T::Array[
|
468
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::MinimumInterval
|
469
|
+
],
|
470
|
+
net_terms: Integer,
|
471
|
+
pending_subscription_change:
|
472
|
+
T.nilable(
|
473
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::PendingSubscriptionChange
|
474
|
+
),
|
475
|
+
plan: Orb::Plan,
|
476
|
+
price_intervals:
|
477
|
+
T::Array[
|
478
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::PriceInterval
|
479
|
+
],
|
480
|
+
redeemed_coupon:
|
481
|
+
T.nilable(
|
482
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::RedeemedCoupon
|
483
|
+
),
|
484
|
+
start_date: Time,
|
485
|
+
status:
|
486
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::Status::TaggedSymbol,
|
487
|
+
trial_info:
|
488
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::TrialInfo,
|
489
|
+
changed_resources:
|
490
|
+
T.nilable(
|
491
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::ChangedResources
|
492
|
+
)
|
493
|
+
}
|
494
|
+
)
|
495
|
+
end
|
496
|
+
def to_hash
|
382
497
|
end
|
383
|
-
def to_hash; end
|
384
498
|
|
385
499
|
class AdjustmentInterval < Orb::Internal::Type::BaseModel
|
500
|
+
OrHash =
|
501
|
+
T.type_alias do
|
502
|
+
T.any(
|
503
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval,
|
504
|
+
Orb::Internal::AnyHash
|
505
|
+
)
|
506
|
+
end
|
507
|
+
|
386
508
|
sig { returns(String) }
|
387
509
|
attr_accessor :id
|
388
510
|
|
@@ -414,19 +536,18 @@ module Orb
|
|
414
536
|
sig do
|
415
537
|
params(
|
416
538
|
id: String,
|
417
|
-
adjustment:
|
418
|
-
|
419
|
-
|
420
|
-
|
421
|
-
|
422
|
-
|
423
|
-
|
424
|
-
|
539
|
+
adjustment:
|
540
|
+
T.any(
|
541
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::UsageDiscount::OrHash,
|
542
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::AmountDiscount::OrHash,
|
543
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PercentageDiscount::OrHash,
|
544
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::Minimum::OrHash,
|
545
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::Maximum::OrHash
|
546
|
+
),
|
425
547
|
applies_to_price_interval_ids: T::Array[String],
|
426
548
|
end_date: T.nilable(Time),
|
427
549
|
start_date: Time
|
428
|
-
)
|
429
|
-
.returns(T.attached_class)
|
550
|
+
).returns(T.attached_class)
|
430
551
|
end
|
431
552
|
def self.new(
|
432
553
|
id:,
|
@@ -437,31 +558,53 @@ module Orb
|
|
437
558
|
end_date:,
|
438
559
|
# The start date of the adjustment interval.
|
439
560
|
start_date:
|
440
|
-
)
|
561
|
+
)
|
562
|
+
end
|
563
|
+
|
441
564
|
sig do
|
442
|
-
override
|
443
|
-
|
444
|
-
|
445
|
-
|
446
|
-
|
565
|
+
override.returns(
|
566
|
+
{
|
567
|
+
id: String,
|
568
|
+
adjustment:
|
569
|
+
T.any(
|
447
570
|
Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::UsageDiscount,
|
448
571
|
Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::AmountDiscount,
|
449
572
|
Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
|
450
573
|
Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::Minimum,
|
451
574
|
Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::Maximum
|
452
575
|
),
|
453
|
-
|
454
|
-
|
455
|
-
|
456
|
-
|
457
|
-
|
576
|
+
applies_to_price_interval_ids: T::Array[String],
|
577
|
+
end_date: T.nilable(Time),
|
578
|
+
start_date: Time
|
579
|
+
}
|
580
|
+
)
|
581
|
+
end
|
582
|
+
def to_hash
|
458
583
|
end
|
459
|
-
def to_hash; end
|
460
584
|
|
461
585
|
module Adjustment
|
462
586
|
extend Orb::Internal::Type::Union
|
463
587
|
|
588
|
+
Variants =
|
589
|
+
T.type_alias do
|
590
|
+
T.any(
|
591
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::UsageDiscount,
|
592
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::AmountDiscount,
|
593
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
|
594
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::Minimum,
|
595
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::Maximum
|
596
|
+
)
|
597
|
+
end
|
598
|
+
|
464
599
|
class UsageDiscount < Orb::Internal::Type::BaseModel
|
600
|
+
OrHash =
|
601
|
+
T.type_alias do
|
602
|
+
T.any(
|
603
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::UsageDiscount,
|
604
|
+
Orb::Internal::AnyHash
|
605
|
+
)
|
606
|
+
end
|
607
|
+
|
465
608
|
sig { returns(String) }
|
466
609
|
attr_accessor :id
|
467
610
|
|
@@ -499,8 +642,7 @@ module Orb
|
|
499
642
|
reason: T.nilable(String),
|
500
643
|
usage_discount: Float,
|
501
644
|
adjustment_type: Symbol
|
502
|
-
)
|
503
|
-
.returns(T.attached_class)
|
645
|
+
).returns(T.attached_class)
|
504
646
|
end
|
505
647
|
def self.new(
|
506
648
|
id:,
|
@@ -517,25 +659,35 @@ module Orb
|
|
517
659
|
# to in a given billing period.
|
518
660
|
usage_discount:,
|
519
661
|
adjustment_type: :usage_discount
|
520
|
-
)
|
662
|
+
)
|
663
|
+
end
|
664
|
+
|
521
665
|
sig do
|
522
|
-
override
|
523
|
-
|
524
|
-
|
525
|
-
|
526
|
-
|
527
|
-
|
528
|
-
|
529
|
-
|
530
|
-
|
531
|
-
|
532
|
-
|
533
|
-
|
666
|
+
override.returns(
|
667
|
+
{
|
668
|
+
id: String,
|
669
|
+
adjustment_type: Symbol,
|
670
|
+
applies_to_price_ids: T::Array[String],
|
671
|
+
is_invoice_level: T::Boolean,
|
672
|
+
plan_phase_order: T.nilable(Integer),
|
673
|
+
reason: T.nilable(String),
|
674
|
+
usage_discount: Float
|
675
|
+
}
|
676
|
+
)
|
677
|
+
end
|
678
|
+
def to_hash
|
534
679
|
end
|
535
|
-
def to_hash; end
|
536
680
|
end
|
537
681
|
|
538
682
|
class AmountDiscount < Orb::Internal::Type::BaseModel
|
683
|
+
OrHash =
|
684
|
+
T.type_alias do
|
685
|
+
T.any(
|
686
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::AmountDiscount,
|
687
|
+
Orb::Internal::AnyHash
|
688
|
+
)
|
689
|
+
end
|
690
|
+
|
539
691
|
sig { returns(String) }
|
540
692
|
attr_accessor :id
|
541
693
|
|
@@ -573,8 +725,7 @@ module Orb
|
|
573
725
|
plan_phase_order: T.nilable(Integer),
|
574
726
|
reason: T.nilable(String),
|
575
727
|
adjustment_type: Symbol
|
576
|
-
)
|
577
|
-
.returns(T.attached_class)
|
728
|
+
).returns(T.attached_class)
|
578
729
|
end
|
579
730
|
def self.new(
|
580
731
|
id:,
|
@@ -591,25 +742,35 @@ module Orb
|
|
591
742
|
# The reason for the adjustment.
|
592
743
|
reason:,
|
593
744
|
adjustment_type: :amount_discount
|
594
|
-
)
|
745
|
+
)
|
746
|
+
end
|
747
|
+
|
595
748
|
sig do
|
596
|
-
override
|
597
|
-
|
598
|
-
|
599
|
-
|
600
|
-
|
601
|
-
|
602
|
-
|
603
|
-
|
604
|
-
|
605
|
-
|
606
|
-
|
607
|
-
|
749
|
+
override.returns(
|
750
|
+
{
|
751
|
+
id: String,
|
752
|
+
adjustment_type: Symbol,
|
753
|
+
amount_discount: String,
|
754
|
+
applies_to_price_ids: T::Array[String],
|
755
|
+
is_invoice_level: T::Boolean,
|
756
|
+
plan_phase_order: T.nilable(Integer),
|
757
|
+
reason: T.nilable(String)
|
758
|
+
}
|
759
|
+
)
|
760
|
+
end
|
761
|
+
def to_hash
|
608
762
|
end
|
609
|
-
def to_hash; end
|
610
763
|
end
|
611
764
|
|
612
765
|
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
766
|
+
OrHash =
|
767
|
+
T.type_alias do
|
768
|
+
T.any(
|
769
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
|
770
|
+
Orb::Internal::AnyHash
|
771
|
+
)
|
772
|
+
end
|
773
|
+
|
613
774
|
sig { returns(String) }
|
614
775
|
attr_accessor :id
|
615
776
|
|
@@ -647,8 +808,7 @@ module Orb
|
|
647
808
|
plan_phase_order: T.nilable(Integer),
|
648
809
|
reason: T.nilable(String),
|
649
810
|
adjustment_type: Symbol
|
650
|
-
)
|
651
|
-
.returns(T.attached_class)
|
811
|
+
).returns(T.attached_class)
|
652
812
|
end
|
653
813
|
def self.new(
|
654
814
|
id:,
|
@@ -665,25 +825,35 @@ module Orb
|
|
665
825
|
# The reason for the adjustment.
|
666
826
|
reason:,
|
667
827
|
adjustment_type: :percentage_discount
|
668
|
-
)
|
828
|
+
)
|
829
|
+
end
|
830
|
+
|
669
831
|
sig do
|
670
|
-
override
|
671
|
-
|
672
|
-
|
673
|
-
|
674
|
-
|
675
|
-
|
676
|
-
|
677
|
-
|
678
|
-
|
679
|
-
|
680
|
-
|
681
|
-
|
832
|
+
override.returns(
|
833
|
+
{
|
834
|
+
id: String,
|
835
|
+
adjustment_type: Symbol,
|
836
|
+
applies_to_price_ids: T::Array[String],
|
837
|
+
is_invoice_level: T::Boolean,
|
838
|
+
percentage_discount: Float,
|
839
|
+
plan_phase_order: T.nilable(Integer),
|
840
|
+
reason: T.nilable(String)
|
841
|
+
}
|
842
|
+
)
|
843
|
+
end
|
844
|
+
def to_hash
|
682
845
|
end
|
683
|
-
def to_hash; end
|
684
846
|
end
|
685
847
|
|
686
848
|
class Minimum < Orb::Internal::Type::BaseModel
|
849
|
+
OrHash =
|
850
|
+
T.type_alias do
|
851
|
+
T.any(
|
852
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::Minimum,
|
853
|
+
Orb::Internal::AnyHash
|
854
|
+
)
|
855
|
+
end
|
856
|
+
|
687
857
|
sig { returns(String) }
|
688
858
|
attr_accessor :id
|
689
859
|
|
@@ -726,8 +896,7 @@ module Orb
|
|
726
896
|
plan_phase_order: T.nilable(Integer),
|
727
897
|
reason: T.nilable(String),
|
728
898
|
adjustment_type: Symbol
|
729
|
-
)
|
730
|
-
.returns(T.attached_class)
|
899
|
+
).returns(T.attached_class)
|
731
900
|
end
|
732
901
|
def self.new(
|
733
902
|
id:,
|
@@ -746,26 +915,36 @@ module Orb
|
|
746
915
|
# The reason for the adjustment.
|
747
916
|
reason:,
|
748
917
|
adjustment_type: :minimum
|
749
|
-
)
|
918
|
+
)
|
919
|
+
end
|
920
|
+
|
750
921
|
sig do
|
751
|
-
override
|
752
|
-
|
753
|
-
|
754
|
-
|
755
|
-
|
756
|
-
|
757
|
-
|
758
|
-
|
759
|
-
|
760
|
-
|
761
|
-
|
762
|
-
|
763
|
-
|
922
|
+
override.returns(
|
923
|
+
{
|
924
|
+
id: String,
|
925
|
+
adjustment_type: Symbol,
|
926
|
+
applies_to_price_ids: T::Array[String],
|
927
|
+
is_invoice_level: T::Boolean,
|
928
|
+
item_id: String,
|
929
|
+
minimum_amount: String,
|
930
|
+
plan_phase_order: T.nilable(Integer),
|
931
|
+
reason: T.nilable(String)
|
932
|
+
}
|
933
|
+
)
|
934
|
+
end
|
935
|
+
def to_hash
|
764
936
|
end
|
765
|
-
def to_hash; end
|
766
937
|
end
|
767
938
|
|
768
939
|
class Maximum < Orb::Internal::Type::BaseModel
|
940
|
+
OrHash =
|
941
|
+
T.type_alias do
|
942
|
+
T.any(
|
943
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::Maximum,
|
944
|
+
Orb::Internal::AnyHash
|
945
|
+
)
|
946
|
+
end
|
947
|
+
|
769
948
|
sig { returns(String) }
|
770
949
|
attr_accessor :id
|
771
950
|
|
@@ -803,8 +982,7 @@ module Orb
|
|
803
982
|
plan_phase_order: T.nilable(Integer),
|
804
983
|
reason: T.nilable(String),
|
805
984
|
adjustment_type: Symbol
|
806
|
-
)
|
807
|
-
.returns(T.attached_class)
|
985
|
+
).returns(T.attached_class)
|
808
986
|
end
|
809
987
|
def self.new(
|
810
988
|
id:,
|
@@ -821,35 +999,47 @@ module Orb
|
|
821
999
|
# The reason for the adjustment.
|
822
1000
|
reason:,
|
823
1001
|
adjustment_type: :maximum
|
824
|
-
)
|
1002
|
+
)
|
1003
|
+
end
|
1004
|
+
|
825
1005
|
sig do
|
826
|
-
override
|
827
|
-
|
828
|
-
|
829
|
-
|
830
|
-
|
831
|
-
|
832
|
-
|
833
|
-
|
834
|
-
|
835
|
-
|
836
|
-
|
837
|
-
|
1006
|
+
override.returns(
|
1007
|
+
{
|
1008
|
+
id: String,
|
1009
|
+
adjustment_type: Symbol,
|
1010
|
+
applies_to_price_ids: T::Array[String],
|
1011
|
+
is_invoice_level: T::Boolean,
|
1012
|
+
maximum_amount: String,
|
1013
|
+
plan_phase_order: T.nilable(Integer),
|
1014
|
+
reason: T.nilable(String)
|
1015
|
+
}
|
1016
|
+
)
|
1017
|
+
end
|
1018
|
+
def to_hash
|
838
1019
|
end
|
839
|
-
def to_hash; end
|
840
1020
|
end
|
841
1021
|
|
842
1022
|
sig do
|
843
|
-
override
|
844
|
-
|
845
|
-
|
846
|
-
|
1023
|
+
override.returns(
|
1024
|
+
T::Array[
|
1025
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::Variants
|
1026
|
+
]
|
1027
|
+
)
|
1028
|
+
end
|
1029
|
+
def self.variants
|
847
1030
|
end
|
848
|
-
def self.variants; end
|
849
1031
|
end
|
850
1032
|
end
|
851
1033
|
|
852
1034
|
class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel
|
1035
|
+
OrHash =
|
1036
|
+
T.type_alias do
|
1037
|
+
T.any(
|
1038
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::BillingCycleAnchorConfiguration,
|
1039
|
+
Orb::Internal::AnyHash
|
1040
|
+
)
|
1041
|
+
end
|
1042
|
+
|
853
1043
|
# The day of the month on which the billing cycle is anchored. If the maximum
|
854
1044
|
# number of days in a month is greater than this value, the last day of the month
|
855
1045
|
# is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
|
@@ -869,7 +1059,11 @@ module Orb
|
|
869
1059
|
attr_accessor :year
|
870
1060
|
|
871
1061
|
sig do
|
872
|
-
params(
|
1062
|
+
params(
|
1063
|
+
day: Integer,
|
1064
|
+
month: T.nilable(Integer),
|
1065
|
+
year: T.nilable(Integer)
|
1066
|
+
).returns(T.attached_class)
|
873
1067
|
end
|
874
1068
|
def self.new(
|
875
1069
|
# The day of the month on which the billing cycle is anchored. If the maximum
|
@@ -884,15 +1078,43 @@ module Orb
|
|
884
1078
|
# The year on which the billing cycle is anchored (e.g. a 2 year billing cycle
|
885
1079
|
# anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.).
|
886
1080
|
year: nil
|
887
|
-
)
|
888
|
-
|
889
|
-
|
1081
|
+
)
|
1082
|
+
end
|
1083
|
+
|
1084
|
+
sig do
|
1085
|
+
override.returns(
|
1086
|
+
{
|
1087
|
+
day: Integer,
|
1088
|
+
month: T.nilable(Integer),
|
1089
|
+
year: T.nilable(Integer)
|
1090
|
+
}
|
1091
|
+
)
|
1092
|
+
end
|
1093
|
+
def to_hash
|
1094
|
+
end
|
890
1095
|
end
|
891
1096
|
|
892
1097
|
module DiscountInterval
|
893
1098
|
extend Orb::Internal::Type::Union
|
894
1099
|
|
1100
|
+
Variants =
|
1101
|
+
T.type_alias do
|
1102
|
+
T.any(
|
1103
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::Amount,
|
1104
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::Percentage,
|
1105
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::Usage
|
1106
|
+
)
|
1107
|
+
end
|
1108
|
+
|
895
1109
|
class Amount < Orb::Internal::Type::BaseModel
|
1110
|
+
OrHash =
|
1111
|
+
T.type_alias do
|
1112
|
+
T.any(
|
1113
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::Amount,
|
1114
|
+
Orb::Internal::AnyHash
|
1115
|
+
)
|
1116
|
+
end
|
1117
|
+
|
896
1118
|
# Only available if discount_type is `amount`.
|
897
1119
|
sig { returns(String) }
|
898
1120
|
attr_accessor :amount_discount
|
@@ -924,8 +1146,7 @@ module Orb
|
|
924
1146
|
end_date: T.nilable(Time),
|
925
1147
|
start_date: Time,
|
926
1148
|
discount_type: Symbol
|
927
|
-
)
|
928
|
-
.returns(T.attached_class)
|
1149
|
+
).returns(T.attached_class)
|
929
1150
|
end
|
930
1151
|
def self.new(
|
931
1152
|
# Only available if discount_type is `amount`.
|
@@ -939,24 +1160,34 @@ module Orb
|
|
939
1160
|
# The start date of the discount interval.
|
940
1161
|
start_date:,
|
941
1162
|
discount_type: :amount
|
942
|
-
)
|
1163
|
+
)
|
1164
|
+
end
|
1165
|
+
|
943
1166
|
sig do
|
944
|
-
override
|
945
|
-
|
946
|
-
|
947
|
-
|
948
|
-
|
949
|
-
|
950
|
-
|
951
|
-
|
952
|
-
|
953
|
-
|
954
|
-
|
1167
|
+
override.returns(
|
1168
|
+
{
|
1169
|
+
amount_discount: String,
|
1170
|
+
applies_to_price_ids: T::Array[String],
|
1171
|
+
applies_to_price_interval_ids: T::Array[String],
|
1172
|
+
discount_type: Symbol,
|
1173
|
+
end_date: T.nilable(Time),
|
1174
|
+
start_date: Time
|
1175
|
+
}
|
1176
|
+
)
|
1177
|
+
end
|
1178
|
+
def to_hash
|
955
1179
|
end
|
956
|
-
def to_hash; end
|
957
1180
|
end
|
958
1181
|
|
959
1182
|
class Percentage < Orb::Internal::Type::BaseModel
|
1183
|
+
OrHash =
|
1184
|
+
T.type_alias do
|
1185
|
+
T.any(
|
1186
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::Percentage,
|
1187
|
+
Orb::Internal::AnyHash
|
1188
|
+
)
|
1189
|
+
end
|
1190
|
+
|
960
1191
|
# The price ids that this discount interval applies to.
|
961
1192
|
sig { returns(T::Array[String]) }
|
962
1193
|
attr_accessor :applies_to_price_ids
|
@@ -989,8 +1220,7 @@ module Orb
|
|
989
1220
|
percentage_discount: Float,
|
990
1221
|
start_date: Time,
|
991
1222
|
discount_type: Symbol
|
992
|
-
)
|
993
|
-
.returns(T.attached_class)
|
1223
|
+
).returns(T.attached_class)
|
994
1224
|
end
|
995
1225
|
def self.new(
|
996
1226
|
# The price ids that this discount interval applies to.
|
@@ -1005,24 +1235,34 @@ module Orb
|
|
1005
1235
|
# The start date of the discount interval.
|
1006
1236
|
start_date:,
|
1007
1237
|
discount_type: :percentage
|
1008
|
-
)
|
1238
|
+
)
|
1239
|
+
end
|
1240
|
+
|
1009
1241
|
sig do
|
1010
|
-
override
|
1011
|
-
|
1012
|
-
|
1013
|
-
|
1014
|
-
|
1015
|
-
|
1016
|
-
|
1017
|
-
|
1018
|
-
|
1019
|
-
|
1020
|
-
|
1242
|
+
override.returns(
|
1243
|
+
{
|
1244
|
+
applies_to_price_ids: T::Array[String],
|
1245
|
+
applies_to_price_interval_ids: T::Array[String],
|
1246
|
+
discount_type: Symbol,
|
1247
|
+
end_date: T.nilable(Time),
|
1248
|
+
percentage_discount: Float,
|
1249
|
+
start_date: Time
|
1250
|
+
}
|
1251
|
+
)
|
1252
|
+
end
|
1253
|
+
def to_hash
|
1021
1254
|
end
|
1022
|
-
def to_hash; end
|
1023
1255
|
end
|
1024
1256
|
|
1025
1257
|
class Usage < Orb::Internal::Type::BaseModel
|
1258
|
+
OrHash =
|
1259
|
+
T.type_alias do
|
1260
|
+
T.any(
|
1261
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::Usage,
|
1262
|
+
Orb::Internal::AnyHash
|
1263
|
+
)
|
1264
|
+
end
|
1265
|
+
|
1026
1266
|
# The price ids that this discount interval applies to.
|
1027
1267
|
sig { returns(T::Array[String]) }
|
1028
1268
|
attr_accessor :applies_to_price_ids
|
@@ -1055,8 +1295,7 @@ module Orb
|
|
1055
1295
|
start_date: Time,
|
1056
1296
|
usage_discount: Float,
|
1057
1297
|
discount_type: Symbol
|
1058
|
-
)
|
1059
|
-
.returns(T.attached_class)
|
1298
|
+
).returns(T.attached_class)
|
1060
1299
|
end
|
1061
1300
|
def self.new(
|
1062
1301
|
# The price ids that this discount interval applies to.
|
@@ -1071,33 +1310,45 @@ module Orb
|
|
1071
1310
|
# discount is for
|
1072
1311
|
usage_discount:,
|
1073
1312
|
discount_type: :usage
|
1074
|
-
)
|
1313
|
+
)
|
1314
|
+
end
|
1315
|
+
|
1075
1316
|
sig do
|
1076
|
-
override
|
1077
|
-
|
1078
|
-
|
1079
|
-
|
1080
|
-
|
1081
|
-
|
1082
|
-
|
1083
|
-
|
1084
|
-
|
1085
|
-
|
1086
|
-
|
1317
|
+
override.returns(
|
1318
|
+
{
|
1319
|
+
applies_to_price_ids: T::Array[String],
|
1320
|
+
applies_to_price_interval_ids: T::Array[String],
|
1321
|
+
discount_type: Symbol,
|
1322
|
+
end_date: T.nilable(Time),
|
1323
|
+
start_date: Time,
|
1324
|
+
usage_discount: Float
|
1325
|
+
}
|
1326
|
+
)
|
1327
|
+
end
|
1328
|
+
def to_hash
|
1087
1329
|
end
|
1088
|
-
def to_hash; end
|
1089
1330
|
end
|
1090
1331
|
|
1091
1332
|
sig do
|
1092
|
-
override
|
1093
|
-
|
1094
|
-
|
1095
|
-
|
1333
|
+
override.returns(
|
1334
|
+
T::Array[
|
1335
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::Variants
|
1336
|
+
]
|
1337
|
+
)
|
1338
|
+
end
|
1339
|
+
def self.variants
|
1096
1340
|
end
|
1097
|
-
def self.variants; end
|
1098
1341
|
end
|
1099
1342
|
|
1100
1343
|
class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
|
1344
|
+
OrHash =
|
1345
|
+
T.type_alias do
|
1346
|
+
T.any(
|
1347
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::FixedFeeQuantitySchedule,
|
1348
|
+
Orb::Internal::AnyHash
|
1349
|
+
)
|
1350
|
+
end
|
1351
|
+
|
1101
1352
|
sig { returns(T.nilable(Time)) }
|
1102
1353
|
attr_accessor :end_date
|
1103
1354
|
|
@@ -1111,18 +1362,39 @@ module Orb
|
|
1111
1362
|
attr_accessor :start_date
|
1112
1363
|
|
1113
1364
|
sig do
|
1114
|
-
params(
|
1115
|
-
.
|
1365
|
+
params(
|
1366
|
+
end_date: T.nilable(Time),
|
1367
|
+
price_id: String,
|
1368
|
+
quantity: Float,
|
1369
|
+
start_date: Time
|
1370
|
+
).returns(T.attached_class)
|
1371
|
+
end
|
1372
|
+
def self.new(end_date:, price_id:, quantity:, start_date:)
|
1116
1373
|
end
|
1117
|
-
def self.new(end_date:, price_id:, quantity:, start_date:); end
|
1118
1374
|
|
1119
1375
|
sig do
|
1120
|
-
override.returns(
|
1376
|
+
override.returns(
|
1377
|
+
{
|
1378
|
+
end_date: T.nilable(Time),
|
1379
|
+
price_id: String,
|
1380
|
+
quantity: Float,
|
1381
|
+
start_date: Time
|
1382
|
+
}
|
1383
|
+
)
|
1384
|
+
end
|
1385
|
+
def to_hash
|
1121
1386
|
end
|
1122
|
-
def to_hash; end
|
1123
1387
|
end
|
1124
1388
|
|
1125
1389
|
class MaximumInterval < Orb::Internal::Type::BaseModel
|
1390
|
+
OrHash =
|
1391
|
+
T.type_alias do
|
1392
|
+
T.any(
|
1393
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::MaximumInterval,
|
1394
|
+
Orb::Internal::AnyHash
|
1395
|
+
)
|
1396
|
+
end
|
1397
|
+
|
1126
1398
|
# The price ids that this maximum interval applies to.
|
1127
1399
|
sig { returns(T::Array[String]) }
|
1128
1400
|
attr_accessor :applies_to_price_ids
|
@@ -1151,8 +1423,7 @@ module Orb
|
|
1151
1423
|
end_date: T.nilable(Time),
|
1152
1424
|
maximum_amount: String,
|
1153
1425
|
start_date: Time
|
1154
|
-
)
|
1155
|
-
.returns(T.attached_class)
|
1426
|
+
).returns(T.attached_class)
|
1156
1427
|
end
|
1157
1428
|
def self.new(
|
1158
1429
|
# The price ids that this maximum interval applies to.
|
@@ -1166,23 +1437,33 @@ module Orb
|
|
1166
1437
|
maximum_amount:,
|
1167
1438
|
# The start date of the maximum interval.
|
1168
1439
|
start_date:
|
1169
|
-
)
|
1440
|
+
)
|
1441
|
+
end
|
1442
|
+
|
1170
1443
|
sig do
|
1171
|
-
override
|
1172
|
-
|
1173
|
-
|
1174
|
-
|
1175
|
-
|
1176
|
-
|
1177
|
-
|
1178
|
-
|
1179
|
-
|
1180
|
-
|
1444
|
+
override.returns(
|
1445
|
+
{
|
1446
|
+
applies_to_price_ids: T::Array[String],
|
1447
|
+
applies_to_price_interval_ids: T::Array[String],
|
1448
|
+
end_date: T.nilable(Time),
|
1449
|
+
maximum_amount: String,
|
1450
|
+
start_date: Time
|
1451
|
+
}
|
1452
|
+
)
|
1453
|
+
end
|
1454
|
+
def to_hash
|
1181
1455
|
end
|
1182
|
-
def to_hash; end
|
1183
1456
|
end
|
1184
1457
|
|
1185
1458
|
class MinimumInterval < Orb::Internal::Type::BaseModel
|
1459
|
+
OrHash =
|
1460
|
+
T.type_alias do
|
1461
|
+
T.any(
|
1462
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::MinimumInterval,
|
1463
|
+
Orb::Internal::AnyHash
|
1464
|
+
)
|
1465
|
+
end
|
1466
|
+
|
1186
1467
|
# The price ids that this minimum interval applies to.
|
1187
1468
|
sig { returns(T::Array[String]) }
|
1188
1469
|
attr_accessor :applies_to_price_ids
|
@@ -1211,8 +1492,7 @@ module Orb
|
|
1211
1492
|
end_date: T.nilable(Time),
|
1212
1493
|
minimum_amount: String,
|
1213
1494
|
start_date: Time
|
1214
|
-
)
|
1215
|
-
.returns(T.attached_class)
|
1495
|
+
).returns(T.attached_class)
|
1216
1496
|
end
|
1217
1497
|
def self.new(
|
1218
1498
|
# The price ids that this minimum interval applies to.
|
@@ -1226,35 +1506,55 @@ module Orb
|
|
1226
1506
|
minimum_amount:,
|
1227
1507
|
# The start date of the minimum interval.
|
1228
1508
|
start_date:
|
1229
|
-
)
|
1509
|
+
)
|
1510
|
+
end
|
1511
|
+
|
1230
1512
|
sig do
|
1231
|
-
override
|
1232
|
-
|
1233
|
-
|
1234
|
-
|
1235
|
-
|
1236
|
-
|
1237
|
-
|
1238
|
-
|
1239
|
-
|
1240
|
-
|
1513
|
+
override.returns(
|
1514
|
+
{
|
1515
|
+
applies_to_price_ids: T::Array[String],
|
1516
|
+
applies_to_price_interval_ids: T::Array[String],
|
1517
|
+
end_date: T.nilable(Time),
|
1518
|
+
minimum_amount: String,
|
1519
|
+
start_date: Time
|
1520
|
+
}
|
1521
|
+
)
|
1522
|
+
end
|
1523
|
+
def to_hash
|
1241
1524
|
end
|
1242
|
-
def to_hash; end
|
1243
1525
|
end
|
1244
1526
|
|
1245
1527
|
class PendingSubscriptionChange < Orb::Internal::Type::BaseModel
|
1528
|
+
OrHash =
|
1529
|
+
T.type_alias do
|
1530
|
+
T.any(
|
1531
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::PendingSubscriptionChange,
|
1532
|
+
Orb::Internal::AnyHash
|
1533
|
+
)
|
1534
|
+
end
|
1535
|
+
|
1246
1536
|
sig { returns(String) }
|
1247
1537
|
attr_accessor :id
|
1248
1538
|
|
1249
1539
|
# A pending subscription change if one exists on this subscription.
|
1250
1540
|
sig { params(id: String).returns(T.attached_class) }
|
1251
|
-
def self.new(id:)
|
1541
|
+
def self.new(id:)
|
1542
|
+
end
|
1252
1543
|
|
1253
|
-
sig { override.returns({id: String}) }
|
1254
|
-
def to_hash
|
1544
|
+
sig { override.returns({ id: String }) }
|
1545
|
+
def to_hash
|
1546
|
+
end
|
1255
1547
|
end
|
1256
1548
|
|
1257
1549
|
class PriceInterval < Orb::Internal::Type::BaseModel
|
1550
|
+
OrHash =
|
1551
|
+
T.type_alias do
|
1552
|
+
T.any(
|
1553
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::PriceInterval,
|
1554
|
+
Orb::Internal::AnyHash
|
1555
|
+
)
|
1556
|
+
end
|
1557
|
+
|
1258
1558
|
sig { returns(String) }
|
1259
1559
|
attr_accessor :id
|
1260
1560
|
|
@@ -1288,7 +1588,9 @@ module Orb
|
|
1288
1588
|
sig do
|
1289
1589
|
returns(
|
1290
1590
|
T.nilable(
|
1291
|
-
T::Array[
|
1591
|
+
T::Array[
|
1592
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::PriceInterval::FixedFeeQuantityTransition
|
1593
|
+
]
|
1292
1594
|
)
|
1293
1595
|
)
|
1294
1596
|
end
|
@@ -1307,34 +1609,34 @@ module Orb
|
|
1307
1609
|
sig do
|
1308
1610
|
returns(
|
1309
1611
|
T.any(
|
1310
|
-
Orb::
|
1311
|
-
Orb::
|
1312
|
-
Orb::
|
1313
|
-
Orb::
|
1314
|
-
Orb::
|
1315
|
-
Orb::
|
1316
|
-
Orb::
|
1317
|
-
Orb::
|
1318
|
-
Orb::
|
1319
|
-
Orb::
|
1320
|
-
Orb::
|
1321
|
-
Orb::
|
1322
|
-
Orb::
|
1323
|
-
Orb::
|
1324
|
-
Orb::
|
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::
|
1612
|
+
Orb::Price::Unit,
|
1613
|
+
Orb::Price::Package,
|
1614
|
+
Orb::Price::Matrix,
|
1615
|
+
Orb::Price::Tiered,
|
1616
|
+
Orb::Price::TieredBps,
|
1617
|
+
Orb::Price::Bps,
|
1618
|
+
Orb::Price::BulkBps,
|
1619
|
+
Orb::Price::Bulk,
|
1620
|
+
Orb::Price::ThresholdTotalAmount,
|
1621
|
+
Orb::Price::TieredPackage,
|
1622
|
+
Orb::Price::GroupedTiered,
|
1623
|
+
Orb::Price::TieredWithMinimum,
|
1624
|
+
Orb::Price::TieredPackageWithMinimum,
|
1625
|
+
Orb::Price::PackageWithAllocation,
|
1626
|
+
Orb::Price::UnitWithPercent,
|
1627
|
+
Orb::Price::MatrixWithAllocation,
|
1628
|
+
Orb::Price::TieredWithProration,
|
1629
|
+
Orb::Price::UnitWithProration,
|
1630
|
+
Orb::Price::GroupedAllocation,
|
1631
|
+
Orb::Price::GroupedWithProratedMinimum,
|
1632
|
+
Orb::Price::GroupedWithMeteredMinimum,
|
1633
|
+
Orb::Price::MatrixWithDisplayName,
|
1634
|
+
Orb::Price::BulkWithProration,
|
1635
|
+
Orb::Price::GroupedTieredPackage,
|
1636
|
+
Orb::Price::MaxGroupTieredPackage,
|
1637
|
+
Orb::Price::ScalableMatrixWithUnitPricing,
|
1638
|
+
Orb::Price::ScalableMatrixWithTieredPricing,
|
1639
|
+
Orb::Price::CumulativeGroupedBulk
|
1338
1640
|
)
|
1339
1641
|
)
|
1340
1642
|
end
|
@@ -1361,49 +1663,46 @@ module Orb
|
|
1361
1663
|
current_billing_period_start_date: T.nilable(Time),
|
1362
1664
|
end_date: T.nilable(Time),
|
1363
1665
|
filter: T.nilable(String),
|
1364
|
-
fixed_fee_quantity_transitions:
|
1365
|
-
T
|
1366
|
-
T
|
1367
|
-
Orb::Models::SubscriptionPriceIntervalsResponse::PriceInterval::FixedFeeQuantityTransition
|
1368
|
-
|
1369
|
-
|
1370
|
-
|
1371
|
-
|
1372
|
-
|
1373
|
-
|
1374
|
-
|
1375
|
-
|
1376
|
-
|
1377
|
-
|
1378
|
-
|
1379
|
-
|
1380
|
-
|
1381
|
-
|
1382
|
-
|
1383
|
-
|
1384
|
-
|
1385
|
-
|
1386
|
-
|
1387
|
-
|
1388
|
-
|
1389
|
-
|
1390
|
-
|
1391
|
-
|
1392
|
-
|
1393
|
-
|
1394
|
-
|
1395
|
-
|
1396
|
-
|
1397
|
-
|
1398
|
-
|
1399
|
-
|
1400
|
-
|
1401
|
-
Orb::Models::Price::CumulativeGroupedBulk
|
1402
|
-
),
|
1666
|
+
fixed_fee_quantity_transitions:
|
1667
|
+
T.nilable(
|
1668
|
+
T::Array[
|
1669
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::PriceInterval::FixedFeeQuantityTransition::OrHash
|
1670
|
+
]
|
1671
|
+
),
|
1672
|
+
price:
|
1673
|
+
T.any(
|
1674
|
+
Orb::Price::Unit::OrHash,
|
1675
|
+
Orb::Price::Package::OrHash,
|
1676
|
+
Orb::Price::Matrix::OrHash,
|
1677
|
+
Orb::Price::Tiered::OrHash,
|
1678
|
+
Orb::Price::TieredBps::OrHash,
|
1679
|
+
Orb::Price::Bps::OrHash,
|
1680
|
+
Orb::Price::BulkBps::OrHash,
|
1681
|
+
Orb::Price::Bulk::OrHash,
|
1682
|
+
Orb::Price::ThresholdTotalAmount::OrHash,
|
1683
|
+
Orb::Price::TieredPackage::OrHash,
|
1684
|
+
Orb::Price::GroupedTiered::OrHash,
|
1685
|
+
Orb::Price::TieredWithMinimum::OrHash,
|
1686
|
+
Orb::Price::TieredPackageWithMinimum::OrHash,
|
1687
|
+
Orb::Price::PackageWithAllocation::OrHash,
|
1688
|
+
Orb::Price::UnitWithPercent::OrHash,
|
1689
|
+
Orb::Price::MatrixWithAllocation::OrHash,
|
1690
|
+
Orb::Price::TieredWithProration::OrHash,
|
1691
|
+
Orb::Price::UnitWithProration::OrHash,
|
1692
|
+
Orb::Price::GroupedAllocation::OrHash,
|
1693
|
+
Orb::Price::GroupedWithProratedMinimum::OrHash,
|
1694
|
+
Orb::Price::GroupedWithMeteredMinimum::OrHash,
|
1695
|
+
Orb::Price::MatrixWithDisplayName::OrHash,
|
1696
|
+
Orb::Price::BulkWithProration::OrHash,
|
1697
|
+
Orb::Price::GroupedTieredPackage::OrHash,
|
1698
|
+
Orb::Price::MaxGroupTieredPackage::OrHash,
|
1699
|
+
Orb::Price::ScalableMatrixWithUnitPricing::OrHash,
|
1700
|
+
Orb::Price::ScalableMatrixWithTieredPricing::OrHash,
|
1701
|
+
Orb::Price::CumulativeGroupedBulk::OrHash
|
1702
|
+
),
|
1403
1703
|
start_date: Time,
|
1404
1704
|
usage_customer_ids: T.nilable(T::Array[String])
|
1405
|
-
)
|
1406
|
-
.returns(T.attached_class)
|
1705
|
+
).returns(T.attached_class)
|
1407
1706
|
end
|
1408
1707
|
def self.new(
|
1409
1708
|
id:,
|
@@ -1442,58 +1741,72 @@ module Orb
|
|
1442
1741
|
# A list of customer IDs whose usage events will be aggregated and billed under
|
1443
1742
|
# this price interval.
|
1444
1743
|
usage_customer_ids:
|
1445
|
-
)
|
1744
|
+
)
|
1745
|
+
end
|
1746
|
+
|
1446
1747
|
sig do
|
1447
|
-
override
|
1448
|
-
|
1449
|
-
|
1450
|
-
|
1451
|
-
|
1452
|
-
|
1453
|
-
|
1454
|
-
|
1455
|
-
|
1456
|
-
|
1457
|
-
T::Array[
|
1748
|
+
override.returns(
|
1749
|
+
{
|
1750
|
+
id: String,
|
1751
|
+
billing_cycle_day: Integer,
|
1752
|
+
current_billing_period_end_date: T.nilable(Time),
|
1753
|
+
current_billing_period_start_date: T.nilable(Time),
|
1754
|
+
end_date: T.nilable(Time),
|
1755
|
+
filter: T.nilable(String),
|
1756
|
+
fixed_fee_quantity_transitions:
|
1757
|
+
T.nilable(
|
1758
|
+
T::Array[
|
1759
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::PriceInterval::FixedFeeQuantityTransition
|
1760
|
+
]
|
1458
1761
|
),
|
1459
|
-
|
1460
|
-
|
1461
|
-
Orb::
|
1462
|
-
Orb::
|
1463
|
-
Orb::
|
1464
|
-
Orb::
|
1465
|
-
Orb::
|
1466
|
-
Orb::
|
1467
|
-
Orb::
|
1468
|
-
Orb::
|
1469
|
-
Orb::
|
1470
|
-
Orb::
|
1471
|
-
Orb::
|
1472
|
-
Orb::
|
1473
|
-
Orb::
|
1474
|
-
Orb::
|
1475
|
-
Orb::
|
1476
|
-
Orb::
|
1477
|
-
Orb::
|
1478
|
-
Orb::
|
1479
|
-
Orb::
|
1480
|
-
Orb::
|
1481
|
-
Orb::
|
1482
|
-
Orb::
|
1483
|
-
Orb::
|
1484
|
-
Orb::
|
1485
|
-
Orb::
|
1486
|
-
Orb::
|
1487
|
-
Orb::
|
1762
|
+
price:
|
1763
|
+
T.any(
|
1764
|
+
Orb::Price::Unit,
|
1765
|
+
Orb::Price::Package,
|
1766
|
+
Orb::Price::Matrix,
|
1767
|
+
Orb::Price::Tiered,
|
1768
|
+
Orb::Price::TieredBps,
|
1769
|
+
Orb::Price::Bps,
|
1770
|
+
Orb::Price::BulkBps,
|
1771
|
+
Orb::Price::Bulk,
|
1772
|
+
Orb::Price::ThresholdTotalAmount,
|
1773
|
+
Orb::Price::TieredPackage,
|
1774
|
+
Orb::Price::GroupedTiered,
|
1775
|
+
Orb::Price::TieredWithMinimum,
|
1776
|
+
Orb::Price::TieredPackageWithMinimum,
|
1777
|
+
Orb::Price::PackageWithAllocation,
|
1778
|
+
Orb::Price::UnitWithPercent,
|
1779
|
+
Orb::Price::MatrixWithAllocation,
|
1780
|
+
Orb::Price::TieredWithProration,
|
1781
|
+
Orb::Price::UnitWithProration,
|
1782
|
+
Orb::Price::GroupedAllocation,
|
1783
|
+
Orb::Price::GroupedWithProratedMinimum,
|
1784
|
+
Orb::Price::GroupedWithMeteredMinimum,
|
1785
|
+
Orb::Price::MatrixWithDisplayName,
|
1786
|
+
Orb::Price::BulkWithProration,
|
1787
|
+
Orb::Price::GroupedTieredPackage,
|
1788
|
+
Orb::Price::MaxGroupTieredPackage,
|
1789
|
+
Orb::Price::ScalableMatrixWithUnitPricing,
|
1790
|
+
Orb::Price::ScalableMatrixWithTieredPricing,
|
1791
|
+
Orb::Price::CumulativeGroupedBulk
|
1488
1792
|
),
|
1489
|
-
|
1490
|
-
|
1491
|
-
|
1492
|
-
|
1793
|
+
start_date: Time,
|
1794
|
+
usage_customer_ids: T.nilable(T::Array[String])
|
1795
|
+
}
|
1796
|
+
)
|
1797
|
+
end
|
1798
|
+
def to_hash
|
1493
1799
|
end
|
1494
|
-
def to_hash; end
|
1495
1800
|
|
1496
1801
|
class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
|
1802
|
+
OrHash =
|
1803
|
+
T.type_alias do
|
1804
|
+
T.any(
|
1805
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::PriceInterval::FixedFeeQuantityTransition,
|
1806
|
+
Orb::Internal::AnyHash
|
1807
|
+
)
|
1808
|
+
end
|
1809
|
+
|
1497
1810
|
sig { returns(Time) }
|
1498
1811
|
attr_accessor :effective_date
|
1499
1812
|
|
@@ -1503,15 +1816,35 @@ module Orb
|
|
1503
1816
|
sig { returns(Integer) }
|
1504
1817
|
attr_accessor :quantity
|
1505
1818
|
|
1506
|
-
sig
|
1507
|
-
|
1819
|
+
sig do
|
1820
|
+
params(
|
1821
|
+
effective_date: Time,
|
1822
|
+
price_id: String,
|
1823
|
+
quantity: Integer
|
1824
|
+
).returns(T.attached_class)
|
1825
|
+
end
|
1826
|
+
def self.new(effective_date:, price_id:, quantity:)
|
1827
|
+
end
|
1508
1828
|
|
1509
|
-
sig
|
1510
|
-
|
1829
|
+
sig do
|
1830
|
+
override.returns(
|
1831
|
+
{ effective_date: Time, price_id: String, quantity: Integer }
|
1832
|
+
)
|
1833
|
+
end
|
1834
|
+
def to_hash
|
1835
|
+
end
|
1511
1836
|
end
|
1512
1837
|
end
|
1513
1838
|
|
1514
1839
|
class RedeemedCoupon < Orb::Internal::Type::BaseModel
|
1840
|
+
OrHash =
|
1841
|
+
T.type_alias do
|
1842
|
+
T.any(
|
1843
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::RedeemedCoupon,
|
1844
|
+
Orb::Internal::AnyHash
|
1845
|
+
)
|
1846
|
+
end
|
1847
|
+
|
1515
1848
|
sig { returns(String) }
|
1516
1849
|
attr_accessor :coupon_id
|
1517
1850
|
|
@@ -1522,54 +1855,107 @@ module Orb
|
|
1522
1855
|
attr_accessor :start_date
|
1523
1856
|
|
1524
1857
|
sig do
|
1525
|
-
params(
|
1858
|
+
params(
|
1859
|
+
coupon_id: String,
|
1860
|
+
end_date: T.nilable(Time),
|
1861
|
+
start_date: Time
|
1862
|
+
).returns(T.attached_class)
|
1863
|
+
end
|
1864
|
+
def self.new(coupon_id:, end_date:, start_date:)
|
1526
1865
|
end
|
1527
|
-
def self.new(coupon_id:, end_date:, start_date:); end
|
1528
1866
|
|
1529
|
-
sig
|
1530
|
-
|
1867
|
+
sig do
|
1868
|
+
override.returns(
|
1869
|
+
{ coupon_id: String, end_date: T.nilable(Time), start_date: Time }
|
1870
|
+
)
|
1871
|
+
end
|
1872
|
+
def to_hash
|
1873
|
+
end
|
1531
1874
|
end
|
1532
1875
|
|
1533
1876
|
module Status
|
1534
1877
|
extend Orb::Internal::Type::Enum
|
1535
1878
|
|
1536
|
-
TaggedSymbol =
|
1879
|
+
TaggedSymbol =
|
1880
|
+
T.type_alias do
|
1881
|
+
T.all(
|
1882
|
+
Symbol,
|
1883
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::Status
|
1884
|
+
)
|
1885
|
+
end
|
1537
1886
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
1538
1887
|
|
1539
|
-
ACTIVE =
|
1540
|
-
|
1541
|
-
|
1888
|
+
ACTIVE =
|
1889
|
+
T.let(
|
1890
|
+
:active,
|
1891
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::Status::TaggedSymbol
|
1892
|
+
)
|
1893
|
+
ENDED =
|
1894
|
+
T.let(
|
1895
|
+
:ended,
|
1896
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::Status::TaggedSymbol
|
1897
|
+
)
|
1898
|
+
UPCOMING =
|
1899
|
+
T.let(
|
1900
|
+
:upcoming,
|
1901
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::Status::TaggedSymbol
|
1902
|
+
)
|
1542
1903
|
|
1543
|
-
sig
|
1544
|
-
|
1904
|
+
sig do
|
1905
|
+
override.returns(
|
1906
|
+
T::Array[
|
1907
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::Status::TaggedSymbol
|
1908
|
+
]
|
1909
|
+
)
|
1910
|
+
end
|
1911
|
+
def self.values
|
1912
|
+
end
|
1545
1913
|
end
|
1546
1914
|
|
1547
1915
|
class TrialInfo < Orb::Internal::Type::BaseModel
|
1916
|
+
OrHash =
|
1917
|
+
T.type_alias do
|
1918
|
+
T.any(
|
1919
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::TrialInfo,
|
1920
|
+
Orb::Internal::AnyHash
|
1921
|
+
)
|
1922
|
+
end
|
1923
|
+
|
1548
1924
|
sig { returns(T.nilable(Time)) }
|
1549
1925
|
attr_accessor :end_date
|
1550
1926
|
|
1551
1927
|
sig { params(end_date: T.nilable(Time)).returns(T.attached_class) }
|
1552
|
-
def self.new(end_date:)
|
1928
|
+
def self.new(end_date:)
|
1929
|
+
end
|
1553
1930
|
|
1554
|
-
sig { override.returns({end_date: T.nilable(Time)}) }
|
1555
|
-
def to_hash
|
1931
|
+
sig { override.returns({ end_date: T.nilable(Time) }) }
|
1932
|
+
def to_hash
|
1933
|
+
end
|
1556
1934
|
end
|
1557
1935
|
|
1558
1936
|
class ChangedResources < Orb::Internal::Type::BaseModel
|
1937
|
+
OrHash =
|
1938
|
+
T.type_alias do
|
1939
|
+
T.any(
|
1940
|
+
Orb::Models::SubscriptionPriceIntervalsResponse::ChangedResources,
|
1941
|
+
Orb::Internal::AnyHash
|
1942
|
+
)
|
1943
|
+
end
|
1944
|
+
|
1559
1945
|
# The credit notes that were created as part of this operation.
|
1560
|
-
sig { returns(T::Array[Orb::
|
1946
|
+
sig { returns(T::Array[Orb::CreditNote]) }
|
1561
1947
|
attr_accessor :created_credit_notes
|
1562
1948
|
|
1563
1949
|
# The invoices that were created as part of this operation.
|
1564
|
-
sig { returns(T::Array[Orb::
|
1950
|
+
sig { returns(T::Array[Orb::Invoice]) }
|
1565
1951
|
attr_accessor :created_invoices
|
1566
1952
|
|
1567
1953
|
# The credit notes that were voided as part of this operation.
|
1568
|
-
sig { returns(T::Array[Orb::
|
1954
|
+
sig { returns(T::Array[Orb::CreditNote]) }
|
1569
1955
|
attr_accessor :voided_credit_notes
|
1570
1956
|
|
1571
1957
|
# The invoices that were voided as part of this operation.
|
1572
|
-
sig { returns(T::Array[Orb::
|
1958
|
+
sig { returns(T::Array[Orb::Invoice]) }
|
1573
1959
|
attr_accessor :voided_invoices
|
1574
1960
|
|
1575
1961
|
# The resources that were changed as part of this operation. Only present when
|
@@ -1577,12 +1963,11 @@ module Orb
|
|
1577
1963
|
# `include_changed_resources` parameter was passed in the request.
|
1578
1964
|
sig do
|
1579
1965
|
params(
|
1580
|
-
created_credit_notes: T::Array[
|
1581
|
-
created_invoices: T::Array[
|
1582
|
-
voided_credit_notes: T::Array[
|
1583
|
-
voided_invoices: T::Array[
|
1584
|
-
)
|
1585
|
-
.returns(T.attached_class)
|
1966
|
+
created_credit_notes: T::Array[Orb::CreditNote::OrHash],
|
1967
|
+
created_invoices: T::Array[Orb::Invoice::OrHash],
|
1968
|
+
voided_credit_notes: T::Array[Orb::CreditNote::OrHash],
|
1969
|
+
voided_invoices: T::Array[Orb::Invoice::OrHash]
|
1970
|
+
).returns(T.attached_class)
|
1586
1971
|
end
|
1587
1972
|
def self.new(
|
1588
1973
|
# The credit notes that were created as part of this operation.
|
@@ -1593,19 +1978,21 @@ module Orb
|
|
1593
1978
|
voided_credit_notes:,
|
1594
1979
|
# The invoices that were voided as part of this operation.
|
1595
1980
|
voided_invoices:
|
1596
|
-
)
|
1981
|
+
)
|
1982
|
+
end
|
1983
|
+
|
1597
1984
|
sig do
|
1598
|
-
override
|
1599
|
-
|
1600
|
-
|
1601
|
-
|
1602
|
-
|
1603
|
-
|
1604
|
-
|
1605
|
-
|
1606
|
-
|
1985
|
+
override.returns(
|
1986
|
+
{
|
1987
|
+
created_credit_notes: T::Array[Orb::CreditNote],
|
1988
|
+
created_invoices: T::Array[Orb::Invoice],
|
1989
|
+
voided_credit_notes: T::Array[Orb::CreditNote],
|
1990
|
+
voided_invoices: T::Array[Orb::Invoice]
|
1991
|
+
}
|
1992
|
+
)
|
1993
|
+
end
|
1994
|
+
def to_hash
|
1607
1995
|
end
|
1608
|
-
def to_hash; end
|
1609
1996
|
end
|
1610
1997
|
end
|
1611
1998
|
end
|