orb-billing 0.1.0.pre.alpha.38 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +10 -2
- data/lib/orb/client.rb +4 -0
- data/lib/orb/internal/transport/base_client.rb +2 -2
- data/lib/orb/internal/transport/pooled_net_requester.rb +15 -6
- data/lib/orb/internal/type/array_of.rb +12 -2
- data/lib/orb/internal/type/base_model.rb +23 -22
- data/lib/orb/internal/type/boolean.rb +5 -1
- data/lib/orb/internal/type/converter.rb +62 -39
- data/lib/orb/internal/type/enum.rb +13 -9
- data/lib/orb/internal/type/hash_of.rb +6 -2
- data/lib/orb/internal/type/io_like.rb +75 -0
- data/lib/orb/internal/type/request_parameters.rb +11 -2
- data/lib/orb/internal/type/union.rb +7 -3
- data/lib/orb/internal/type/unknown.rb +5 -1
- data/lib/orb/internal/util.rb +81 -26
- data/lib/orb/models/alert.rb +9 -9
- data/lib/orb/models/alert_create_for_customer_params.rb +3 -3
- data/lib/orb/models/alert_create_for_external_customer_params.rb +3 -3
- data/lib/orb/models/alert_create_for_subscription_params.rb +3 -3
- data/lib/orb/models/alert_list_params.rb +5 -5
- data/lib/orb/models/alert_update_params.rb +3 -3
- data/lib/orb/models/amount_discount.rb +1 -1
- data/lib/orb/models/billable_metric.rb +7 -7
- data/lib/orb/models/coupon.rb +7 -7
- data/lib/orb/models/coupon_create_params.rb +2 -2
- data/lib/orb/models/coupon_list_params.rb +2 -2
- data/lib/orb/models/coupons/subscription_list_params.rb +1 -1
- data/lib/orb/models/credit_note.rb +1 -1
- data/lib/orb/models/credit_note_list_params.rb +5 -5
- data/lib/orb/models/customer.rb +232 -232
- data/lib/orb/models/customer_create_params.rb +223 -223
- data/lib/orb/models/customer_list_params.rb +5 -5
- data/lib/orb/models/customer_update_by_external_id_params.rb +224 -224
- data/lib/orb/models/customer_update_params.rb +224 -224
- data/lib/orb/models/customers/balance_transaction_create_response.rb +2 -2
- data/lib/orb/models/customers/balance_transaction_list_params.rb +5 -5
- data/lib/orb/models/customers/balance_transaction_list_response.rb +2 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +6 -6
- data/lib/orb/models/customers/cost_list_params.rb +6 -6
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +2 -2
- data/lib/orb/models/customers/credit_list_params.rb +2 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +20 -20
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +20 -20
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +5 -5
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_list_params.rb +5 -5
- data/lib/orb/models/customers/credits/ledger_list_response.rb +22 -22
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +8 -8
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +7 -7
- data/lib/orb/models/customers/credits/top_up_create_params.rb +8 -8
- data/lib/orb/models/customers/credits/top_up_create_response.rb +7 -7
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +1 -1
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +7 -7
- data/lib/orb/models/customers/credits/top_up_list_params.rb +1 -1
- data/lib/orb/models/customers/credits/top_up_list_response.rb +7 -7
- data/lib/orb/models/dimensional_price_group.rb +7 -7
- data/lib/orb/models/dimensional_price_group_create_params.rb +2 -2
- data/lib/orb/models/dimensional_price_group_list_params.rb +1 -1
- data/lib/orb/models/event_ingest_params.rb +7 -7
- data/lib/orb/models/event_ingest_response.rb +4 -4
- data/lib/orb/models/event_search_params.rb +5 -5
- data/lib/orb/models/event_search_response.rb +8 -8
- data/lib/orb/models/event_update_params.rb +4 -4
- data/lib/orb/models/events/backfill_close_response.rb +7 -7
- data/lib/orb/models/events/backfill_create_params.rb +11 -11
- data/lib/orb/models/events/backfill_create_response.rb +7 -7
- data/lib/orb/models/events/backfill_fetch_response.rb +7 -7
- data/lib/orb/models/events/backfill_list_params.rb +1 -1
- data/lib/orb/models/events/backfill_list_response.rb +7 -7
- data/lib/orb/models/events/backfill_revert_response.rb +7 -7
- data/lib/orb/models/events/event_volumes.rb +1 -1
- data/lib/orb/models/events/volume_list_params.rb +7 -7
- data/lib/orb/models/invoice.rb +270 -270
- data/lib/orb/models/invoice_create_params.rb +12 -11
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +266 -266
- data/lib/orb/models/invoice_issue_params.rb +4 -4
- data/lib/orb/models/invoice_line_item_create_params.rb +1 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +27 -27
- data/lib/orb/models/invoice_list_params.rb +12 -12
- data/lib/orb/models/invoice_update_params.rb +2 -2
- data/lib/orb/models/item.rb +2 -2
- data/lib/orb/models/item_list_params.rb +1 -1
- data/lib/orb/models/metric_create_params.rb +2 -2
- data/lib/orb/models/metric_list_params.rb +5 -5
- data/lib/orb/models/metric_update_params.rb +2 -2
- data/lib/orb/models/percentage_discount.rb +2 -2
- data/lib/orb/models/plan.rb +35 -35
- data/lib/orb/models/plan_create_params.rb +267 -267
- data/lib/orb/models/plan_list_params.rb +5 -5
- data/lib/orb/models/plan_update_params.rb +4 -4
- data/lib/orb/models/plans/external_plan_id_update_params.rb +4 -4
- data/lib/orb/models/price.rb +158 -158
- data/lib/orb/models/price_create_params.rb +20 -20
- data/lib/orb/models/price_evaluate_params.rb +4 -4
- data/lib/orb/models/price_list_params.rb +1 -1
- data/lib/orb/models/price_update_params.rb +2 -2
- data/lib/orb/models/prices/external_price_id_update_params.rb +2 -2
- data/lib/orb/models/subscription.rb +114 -87
- data/lib/orb/models/subscription_cancel_params.rb +3 -3
- data/lib/orb/models/subscription_cancel_response.rb +150 -72
- data/lib/orb/models/subscription_change_apply_params.rb +33 -0
- data/lib/orb/models/subscription_change_apply_response.rb +1372 -0
- data/lib/orb/models/subscription_change_cancel_params.rb +19 -0
- data/lib/orb/models/subscription_change_cancel_response.rb +1372 -0
- data/lib/orb/models/subscription_change_retrieve_params.rb +19 -0
- data/lib/orb/models/subscription_change_retrieve_response.rb +1372 -0
- data/lib/orb/models/subscription_create_params.rb +641 -641
- data/lib/orb/models/subscription_create_response.rb +150 -72
- data/lib/orb/models/subscription_fetch_costs_params.rb +6 -6
- data/lib/orb/models/subscription_fetch_schedule_params.rb +5 -5
- data/lib/orb/models/subscription_fetch_schedule_response.rb +2 -2
- data/lib/orb/models/subscription_fetch_usage_params.rb +8 -8
- data/lib/orb/models/subscription_list_params.rb +5 -5
- data/lib/orb/models/subscription_price_intervals_params.rb +323 -323
- data/lib/orb/models/subscription_price_intervals_response.rb +152 -72
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +651 -651
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +152 -72
- data/lib/orb/models/subscription_trigger_phase_params.rb +3 -3
- data/lib/orb/models/subscription_trigger_phase_response.rb +152 -72
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +152 -72
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +153 -73
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +152 -72
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +8 -8
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +152 -72
- data/lib/orb/models/subscription_update_params.rb +10 -10
- data/lib/orb/models/subscription_update_trial_params.rb +3 -3
- data/lib/orb/models/subscription_update_trial_response.rb +152 -72
- data/lib/orb/models/trial_discount.rb +1 -1
- data/lib/orb/models/usage_discount.rb +2 -2
- data/lib/orb/request_options.rb +7 -7
- data/lib/orb/resources/alerts.rb +38 -38
- data/lib/orb/resources/coupons/subscriptions.rb +3 -3
- data/lib/orb/resources/coupons.rb +9 -9
- data/lib/orb/resources/credit_notes.rb +8 -8
- data/lib/orb/resources/customers/balance_transactions.rb +26 -26
- data/lib/orb/resources/customers/costs.rb +232 -232
- data/lib/orb/resources/customers/credits/ledger.rb +344 -344
- data/lib/orb/resources/customers/credits/top_ups.rb +12 -12
- data/lib/orb/resources/customers/credits.rb +8 -8
- data/lib/orb/resources/customers.rb +59 -59
- data/lib/orb/resources/dimensional_price_groups.rb +6 -6
- data/lib/orb/resources/events/backfills.rb +49 -49
- data/lib/orb/resources/events/volume.rb +10 -10
- data/lib/orb/resources/events.rb +295 -295
- data/lib/orb/resources/invoice_line_items.rb +1 -1
- data/lib/orb/resources/invoices.rb +38 -38
- data/lib/orb/resources/items.rb +1 -1
- data/lib/orb/resources/metrics.rb +11 -11
- data/lib/orb/resources/plans/external_plan_id.rb +14 -14
- data/lib/orb/resources/plans.rb +22 -22
- data/lib/orb/resources/prices/external_price_id.rb +4 -4
- data/lib/orb/resources/prices.rb +30 -30
- data/lib/orb/resources/subscription_changes.rb +87 -0
- data/lib/orb/resources/subscriptions.rb +813 -813
- data/lib/orb/resources/top_level.rb +4 -4
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +8 -0
- data/rbi/lib/orb/client.rbi +5 -4
- data/rbi/lib/orb/errors.rbi +3 -6
- data/rbi/lib/orb/internal/page.rbi +3 -6
- data/rbi/lib/orb/internal/transport/base_client.rbi +13 -27
- data/rbi/lib/orb/internal/transport/pooled_net_requester.rbi +8 -14
- data/rbi/lib/orb/internal/type/array_of.rbi +14 -18
- data/rbi/lib/orb/internal/type/base_model.rbi +51 -66
- data/rbi/lib/orb/internal/type/base_page.rbi +5 -10
- data/rbi/lib/orb/internal/type/boolean.rbi +12 -10
- data/rbi/lib/orb/internal/type/converter.rbi +44 -37
- data/rbi/lib/orb/internal/type/enum.rbi +24 -21
- data/rbi/lib/orb/internal/type/hash_of.rbi +13 -18
- data/rbi/lib/orb/internal/type/io_like.rbi +49 -0
- data/rbi/lib/orb/internal/type/request_parameters.rbi +1 -2
- data/rbi/lib/orb/internal/type/union.rbi +19 -21
- data/rbi/lib/orb/internal/type/unknown.rbi +10 -9
- data/rbi/lib/orb/internal/util.rbi +67 -70
- data/rbi/lib/orb/internal.rbi +1 -1
- data/rbi/lib/orb/models/alert.rbi +21 -33
- data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +8 -13
- data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +8 -13
- data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +8 -13
- data/rbi/lib/orb/models/alert_disable_params.rbi +2 -4
- data/rbi/lib/orb/models/alert_enable_params.rbi +2 -4
- data/rbi/lib/orb/models/alert_list_params.rbi +3 -6
- data/rbi/lib/orb/models/alert_retrieve_params.rbi +2 -4
- data/rbi/lib/orb/models/alert_update_params.rbi +7 -11
- data/rbi/lib/orb/models/amount_discount.rbi +4 -7
- data/rbi/lib/orb/models/billable_metric.rbi +10 -13
- data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -2
- data/rbi/lib/orb/models/coupon.rbi +9 -11
- data/rbi/lib/orb/models/coupon_archive_params.rbi +2 -4
- data/rbi/lib/orb/models/coupon_create_params.rbi +8 -14
- data/rbi/lib/orb/models/coupon_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/coupon_list_params.rbi +3 -4
- data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +3 -5
- data/rbi/lib/orb/models/credit_note.rbi +22 -45
- data/rbi/lib/orb/models/credit_note_create_params.rbi +5 -10
- data/rbi/lib/orb/models/credit_note_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -6
- data/rbi/lib/orb/models/customer.rbi +256 -281
- data/rbi/lib/orb/models/customer_create_params.rbi +251 -276
- data/rbi/lib/orb/models/customer_delete_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_list_params.rbi +3 -6
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +252 -277
- data/rbi/lib/orb/models/customer_update_params.rbi +252 -277
- data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +3 -6
- data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +10 -19
- data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -6
- data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +10 -19
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +8 -10
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +6 -12
- data/rbi/lib/orb/models/customers/cost_list_params.rbi +8 -10
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +6 -12
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +3 -4
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +2 -4
- data/rbi/lib/orb/models/customers/credit_list_params.rbi +3 -4
- data/rbi/lib/orb/models/customers/credit_list_response.rbi +2 -4
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +26 -33
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +79 -136
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +26 -33
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +78 -135
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +5 -10
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +79 -136
- data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +5 -10
- data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +74 -131
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +13 -19
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +12 -18
- data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +13 -19
- data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +12 -18
- data/rbi/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +2 -4
- data/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi +2 -4
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +3 -5
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +12 -18
- data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +3 -5
- data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +12 -18
- data/rbi/lib/orb/models/dimensional_price_group.rbi +8 -9
- data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -7
- data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +3 -5
- data/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi +2 -4
- data/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +2 -4
- data/rbi/lib/orb/models/dimensional_price_groups.rbi +2 -4
- data/rbi/lib/orb/models/discount.rbi +1 -2
- data/rbi/lib/orb/models/evaluate_price_group.rbi +3 -6
- data/rbi/lib/orb/models/event_deprecate_params.rbi +2 -4
- data/rbi/lib/orb/models/event_deprecate_response.rbi +2 -4
- data/rbi/lib/orb/models/event_ingest_params.rbi +10 -13
- data/rbi/lib/orb/models/event_ingest_response.rbi +10 -16
- data/rbi/lib/orb/models/event_search_params.rbi +7 -9
- data/rbi/lib/orb/models/event_search_response.rbi +11 -14
- data/rbi/lib/orb/models/event_update_params.rbi +5 -6
- data/rbi/lib/orb/models/event_update_response.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_close_params.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_close_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_create_params.rbi +13 -16
- data/rbi/lib/orb/models/events/backfill_create_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_list_params.rbi +3 -5
- data/rbi/lib/orb/models/events/backfill_list_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_revert_params.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_revert_response.rbi +10 -14
- data/rbi/lib/orb/models/events/event_volumes.rbi +5 -9
- data/rbi/lib/orb/models/events/volume_list_params.rbi +9 -11
- data/rbi/lib/orb/models/invoice.rbi +388 -465
- data/rbi/lib/orb/models/invoice_create_params.rbi +19 -26
- data/rbi/lib/orb/models/invoice_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +381 -460
- data/rbi/lib/orb/models/invoice_issue_params.rbi +6 -8
- data/rbi/lib/orb/models/invoice_level_discount.rbi +1 -2
- data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +3 -5
- data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +101 -143
- data/rbi/lib/orb/models/invoice_list_params.rbi +8 -13
- data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_pay_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_update_params.rbi +4 -6
- data/rbi/lib/orb/models/invoice_void_params.rbi +2 -4
- data/rbi/lib/orb/models/item.rbi +7 -12
- data/rbi/lib/orb/models/item_create_params.rbi +2 -4
- data/rbi/lib/orb/models/item_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/item_list_params.rbi +3 -5
- data/rbi/lib/orb/models/item_update_params.rbi +5 -10
- data/rbi/lib/orb/models/metric_create_params.rbi +4 -6
- data/rbi/lib/orb/models/metric_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/metric_list_params.rbi +3 -6
- data/rbi/lib/orb/models/metric_update_params.rbi +4 -6
- data/rbi/lib/orb/models/pagination_metadata.rbi +2 -4
- data/rbi/lib/orb/models/percentage_discount.rbi +5 -8
- data/rbi/lib/orb/models/plan.rbi +180 -219
- data/rbi/lib/orb/models/plan_create_params.rbi +670 -951
- data/rbi/lib/orb/models/plan_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/plan_list_params.rbi +4 -8
- data/rbi/lib/orb/models/plan_update_params.rbi +6 -8
- data/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +6 -8
- data/rbi/lib/orb/models/price.rbi +827 -1494
- data/rbi/lib/orb/models/price_create_params.rbi +60 -101
- data/rbi/lib/orb/models/price_evaluate_params.rbi +6 -9
- data/rbi/lib/orb/models/price_evaluate_response.rbi +2 -4
- data/rbi/lib/orb/models/price_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/price_list_params.rbi +3 -5
- data/rbi/lib/orb/models/price_update_params.rbi +4 -6
- data/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +4 -6
- data/rbi/lib/orb/models/subscription.rbi +167 -187
- data/rbi/lib/orb/models/subscription_cancel_params.rbi +5 -7
- data/rbi/lib/orb/models/subscription_cancel_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_change_apply_params.rbi +40 -0
- data/rbi/lib/orb/models/subscription_change_apply_response.rbi +1554 -0
- data/rbi/lib/orb/models/subscription_change_cancel_params.rbi +18 -0
- data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +1565 -0
- data/rbi/lib/orb/models/subscription_change_retrieve_params.rbi +18 -0
- data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +1581 -0
- data/rbi/lib/orb/models/subscription_create_params.rbi +1372 -1968
- data/rbi/lib/orb/models/subscription_create_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +8 -10
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +6 -12
- data/rbi/lib/orb/models/subscription_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -6
- data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +6 -10
- data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +12 -17
- data/rbi/lib/orb/models/subscription_list_params.rbi +4 -8
- data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +772 -1124
- data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +228 -178
- data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +1396 -1993
- data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +238 -182
- data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +5 -7
- data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +238 -182
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +265 -199
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +264 -198
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -15
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +238 -182
- data/rbi/lib/orb/models/subscription_update_params.rbi +12 -15
- data/rbi/lib/orb/models/subscription_update_trial_params.rbi +6 -9
- data/rbi/lib/orb/models/subscription_update_trial_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_usage.rbi +24 -43
- data/rbi/lib/orb/models/subscriptions.rbi +2 -4
- data/rbi/lib/orb/models/top_level_ping_params.rbi +2 -4
- data/rbi/lib/orb/models/top_level_ping_response.rbi +2 -4
- data/rbi/lib/orb/models/trial_discount.rbi +4 -8
- data/rbi/lib/orb/models/usage_discount.rbi +5 -8
- data/rbi/lib/orb/request_options.rbi +9 -11
- data/rbi/lib/orb/resources/alerts.rbi +44 -60
- data/rbi/lib/orb/resources/coupons/subscriptions.rbi +6 -9
- data/rbi/lib/orb/resources/coupons.rbi +18 -25
- data/rbi/lib/orb/resources/credit_notes.rbi +9 -15
- data/rbi/lib/orb/resources/customers/balance_transactions.rbi +26 -31
- data/rbi/lib/orb/resources/customers/costs.rbi +241 -246
- data/rbi/lib/orb/resources/customers/credits/ledger.rbi +387 -396
- data/rbi/lib/orb/resources/customers/credits/top_ups.rbi +29 -40
- data/rbi/lib/orb/resources/customers/credits.rbi +15 -20
- data/rbi/lib/orb/resources/customers.rbi +407 -417
- data/rbi/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +2 -4
- data/rbi/lib/orb/resources/dimensional_price_groups.rbi +13 -19
- data/rbi/lib/orb/resources/events/backfills.rbi +61 -69
- data/rbi/lib/orb/resources/events/volume.rbi +19 -22
- data/rbi/lib/orb/resources/events.rbi +311 -319
- data/rbi/lib/orb/resources/invoice_line_items.rbi +4 -7
- data/rbi/lib/orb/resources/invoices.rbi +62 -76
- data/rbi/lib/orb/resources/items.rbi +7 -14
- data/rbi/lib/orb/resources/metrics.rbi +17 -25
- data/rbi/lib/orb/resources/plans/external_plan_id.rbi +21 -25
- data/rbi/lib/orb/resources/plans.rbi +63 -71
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +9 -13
- data/rbi/lib/orb/resources/prices.rbi +77 -87
- data/rbi/lib/orb/resources/subscription_changes.rbi +61 -0
- data/rbi/lib/orb/resources/subscriptions.rbi +933 -963
- data/rbi/lib/orb/resources/top_level.rbi +6 -8
- data/sig/orb/client.rbs +2 -0
- data/sig/orb/internal/transport/pooled_net_requester.rbs +1 -1
- data/sig/orb/internal/type/array_of.rbs +5 -2
- data/sig/orb/internal/type/base_model.rbs +5 -2
- data/sig/orb/internal/type/boolean.rbs +5 -2
- data/sig/orb/internal/type/converter.rbs +11 -5
- data/sig/orb/internal/type/enum.rbs +5 -2
- data/sig/orb/internal/type/hash_of.rbs +5 -2
- data/sig/orb/internal/type/io_like.rbs +23 -0
- data/sig/orb/internal/type/union.rbs +5 -2
- data/sig/orb/internal/type/unknown.rbs +5 -2
- data/sig/orb/internal/util.rbs +17 -2
- data/sig/orb/models/subscription.rbs +14 -0
- data/sig/orb/models/subscription_cancel_response.rbs +47 -2
- data/sig/orb/models/subscription_change_apply_params.rbs +24 -0
- data/sig/orb/models/subscription_change_apply_response.rbs +784 -0
- data/sig/orb/models/subscription_change_cancel_params.rbs +15 -0
- data/sig/orb/models/subscription_change_cancel_response.rbs +784 -0
- data/sig/orb/models/subscription_change_retrieve_params.rbs +15 -0
- data/sig/orb/models/subscription_change_retrieve_response.rbs +784 -0
- data/sig/orb/models/subscription_create_response.rbs +47 -2
- data/sig/orb/models/subscription_price_intervals_response.rbs +47 -2
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +47 -2
- data/sig/orb/models/subscription_trigger_phase_response.rbs +47 -2
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +47 -2
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +47 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +47 -2
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +47 -2
- data/sig/orb/models/subscription_update_trial_response.rbs +47 -2
- data/sig/orb/resources/customers.rbs +2 -2
- data/sig/orb/resources/subscription_changes.rbs +24 -0
- metadata +28 -4
@@ -7,18 +7,18 @@ module Orb
|
|
7
7
|
attr_accessor :id
|
8
8
|
|
9
9
|
# The current plan phase that is active, only if the subscription's plan has
|
10
|
-
#
|
10
|
+
# phases.
|
11
11
|
sig { returns(T.nilable(Integer)) }
|
12
12
|
attr_accessor :active_plan_phase_order
|
13
13
|
|
14
14
|
# The adjustment intervals for this subscription sorted by the start_date of the
|
15
|
-
#
|
15
|
+
# adjustment interval.
|
16
16
|
sig { returns(T::Array[Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval]) }
|
17
17
|
attr_accessor :adjustment_intervals
|
18
18
|
|
19
19
|
# Determines whether issued invoices for this subscription will automatically be
|
20
|
-
#
|
21
|
-
#
|
20
|
+
# charged with the saved payment method on the due date. This property defaults to
|
21
|
+
# the plan's behavior. If null, defaults to the customer's setting.
|
22
22
|
sig { returns(T.nilable(T::Boolean)) }
|
23
23
|
attr_accessor :auto_collection
|
24
24
|
|
@@ -37,9 +37,9 @@ module Orb
|
|
37
37
|
attr_writer :billing_cycle_anchor_configuration
|
38
38
|
|
39
39
|
# The day of the month on which the billing cycle is anchored. If the maximum
|
40
|
-
#
|
41
|
-
#
|
42
|
-
#
|
40
|
+
# number of days in a month is greater than this value, the last day of the month
|
41
|
+
# is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
|
42
|
+
# period begins on the 30th.
|
43
43
|
sig { returns(Integer) }
|
44
44
|
attr_accessor :billing_cycle_day
|
45
45
|
|
@@ -47,35 +47,35 @@ module Orb
|
|
47
47
|
attr_accessor :created_at
|
48
48
|
|
49
49
|
# The end of the current billing period. This is an exclusive timestamp, such that
|
50
|
-
#
|
51
|
-
#
|
50
|
+
# the instant returned is not part of the billing period. Set to null for
|
51
|
+
# subscriptions that are not currently active.
|
52
52
|
sig { returns(T.nilable(Time)) }
|
53
53
|
attr_accessor :current_billing_period_end_date
|
54
54
|
|
55
55
|
# The start date of the current billing period. This is an inclusive timestamp;
|
56
|
-
#
|
57
|
-
#
|
56
|
+
# the instant returned is exactly the beginning of the billing period. Set to null
|
57
|
+
# if the subscription is not currently active.
|
58
58
|
sig { returns(T.nilable(Time)) }
|
59
59
|
attr_accessor :current_billing_period_start_date
|
60
60
|
|
61
61
|
# A customer is a buyer of your products, and the other party to the billing
|
62
|
-
#
|
62
|
+
# relationship.
|
63
63
|
#
|
64
|
-
#
|
65
|
-
#
|
66
|
-
#
|
67
|
-
#
|
68
|
-
#
|
69
|
-
#
|
64
|
+
# In Orb, customers are assigned system generated identifiers automatically, but
|
65
|
+
# it's often desirable to have these match existing identifiers in your system. To
|
66
|
+
# avoid having to denormalize Orb ID information, you can pass in an
|
67
|
+
# `external_customer_id` with your own identifier. See
|
68
|
+
# [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
|
69
|
+
# information about how these aliases work in Orb.
|
70
70
|
#
|
71
|
-
#
|
72
|
-
#
|
73
|
-
#
|
71
|
+
# In addition to having an identifier in your system, a customer may exist in a
|
72
|
+
# payment provider solution like Stripe. Use the `payment_provider_id` and the
|
73
|
+
# `payment_provider` enum field to express this mapping.
|
74
74
|
#
|
75
|
-
#
|
76
|
-
#
|
77
|
-
#
|
78
|
-
#
|
75
|
+
# A customer also has a timezone (from the standard
|
76
|
+
# [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
|
77
|
+
# your account's timezone. See [Timezone localization](/essentials/timezones) for
|
78
|
+
# information on what this timezone parameter influences within Orb.
|
79
79
|
sig { returns(Orb::Models::Customer) }
|
80
80
|
attr_reader :customer
|
81
81
|
|
@@ -83,7 +83,7 @@ module Orb
|
|
83
83
|
attr_writer :customer
|
84
84
|
|
85
85
|
# Determines the default memo on this subscriptions' invoices. Note that if this
|
86
|
-
#
|
86
|
+
# is not provided, it is determined by the plan configuration.
|
87
87
|
sig { returns(T.nilable(String)) }
|
88
88
|
attr_accessor :default_invoice_memo
|
89
89
|
|
@@ -91,11 +91,11 @@ module Orb
|
|
91
91
|
sig do
|
92
92
|
returns(
|
93
93
|
T::Array[
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
|
98
|
-
|
94
|
+
T.any(
|
95
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::AmountDiscountInterval,
|
96
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::PercentageDiscountInterval,
|
97
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::UsageDiscountInterval
|
98
|
+
)
|
99
99
|
]
|
100
100
|
)
|
101
101
|
end
|
@@ -116,9 +116,9 @@ module Orb
|
|
116
116
|
attr_accessor :maximum_intervals
|
117
117
|
|
118
118
|
# User specified key-value pairs for the resource. If not present, this defaults
|
119
|
-
#
|
120
|
-
#
|
121
|
-
#
|
119
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
120
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
121
|
+
# `null`.
|
122
122
|
sig { returns(T::Hash[Symbol, String]) }
|
123
123
|
attr_accessor :metadata
|
124
124
|
|
@@ -127,16 +127,37 @@ module Orb
|
|
127
127
|
attr_accessor :minimum_intervals
|
128
128
|
|
129
129
|
# Determines the difference between the invoice issue date for subscription
|
130
|
-
#
|
131
|
-
#
|
132
|
-
#
|
130
|
+
# invoices as the date that they are due. A value of `0` here represents that the
|
131
|
+
# invoice is due on issue, whereas a value of `30` represents that the customer
|
132
|
+
# has a month to pay the invoice.
|
133
133
|
sig { returns(Integer) }
|
134
134
|
attr_accessor :net_terms
|
135
135
|
|
136
|
+
# A pending subscription change if one exists on this subscription.
|
137
|
+
sig do
|
138
|
+
returns(
|
139
|
+
T.nilable(Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PendingSubscriptionChange)
|
140
|
+
)
|
141
|
+
end
|
142
|
+
attr_reader :pending_subscription_change
|
143
|
+
|
144
|
+
sig do
|
145
|
+
params(
|
146
|
+
pending_subscription_change: T.nilable(
|
147
|
+
T.any(
|
148
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PendingSubscriptionChange,
|
149
|
+
Orb::Internal::AnyHash
|
150
|
+
)
|
151
|
+
)
|
152
|
+
)
|
153
|
+
.void
|
154
|
+
end
|
155
|
+
attr_writer :pending_subscription_change
|
156
|
+
|
136
157
|
# The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
137
|
-
#
|
138
|
-
#
|
139
|
-
#
|
158
|
+
# subscribed to by a customer. Plans define the billing behavior of the
|
159
|
+
# subscription. You can see more about how to configure prices in the
|
160
|
+
# [Price resource](/reference/price).
|
140
161
|
sig { returns(Orb::Models::Plan) }
|
141
162
|
attr_reader :plan
|
142
163
|
|
@@ -181,15 +202,34 @@ module Orb
|
|
181
202
|
end
|
182
203
|
attr_writer :trial_info
|
183
204
|
|
205
|
+
# The resources that were changed as part of this operation. Only present when
|
206
|
+
# fetched through the subscription changes API or if the
|
207
|
+
# `include_changed_resources` parameter was passed in the request.
|
208
|
+
sig { returns(T.nilable(Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::ChangedResources)) }
|
209
|
+
attr_reader :changed_resources
|
210
|
+
|
211
|
+
sig do
|
212
|
+
params(
|
213
|
+
changed_resources: T.nilable(
|
214
|
+
T.any(
|
215
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::ChangedResources,
|
216
|
+
Orb::Internal::AnyHash
|
217
|
+
)
|
218
|
+
)
|
219
|
+
)
|
220
|
+
.void
|
221
|
+
end
|
222
|
+
attr_writer :changed_resources
|
223
|
+
|
184
224
|
sig do
|
185
225
|
params(
|
186
226
|
id: String,
|
187
227
|
active_plan_phase_order: T.nilable(Integer),
|
188
228
|
adjustment_intervals: T::Array[
|
189
|
-
|
190
|
-
|
191
|
-
|
192
|
-
|
229
|
+
T.any(
|
230
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval,
|
231
|
+
Orb::Internal::AnyHash
|
232
|
+
)
|
193
233
|
],
|
194
234
|
auto_collection: T.nilable(T::Boolean),
|
195
235
|
billing_cycle_anchor_configuration: T.any(
|
@@ -203,41 +243,47 @@ module Orb
|
|
203
243
|
customer: T.any(Orb::Models::Customer, Orb::Internal::AnyHash),
|
204
244
|
default_invoice_memo: T.nilable(String),
|
205
245
|
discount_intervals: T::Array[
|
206
|
-
|
207
|
-
|
208
|
-
|
209
|
-
|
210
|
-
|
211
|
-
|
246
|
+
T.any(
|
247
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::AmountDiscountInterval,
|
248
|
+
Orb::Internal::AnyHash,
|
249
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::PercentageDiscountInterval,
|
250
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::UsageDiscountInterval
|
251
|
+
)
|
212
252
|
],
|
213
253
|
end_date: T.nilable(Time),
|
214
254
|
fixed_fee_quantity_schedule: T::Array[
|
215
|
-
|
216
|
-
|
217
|
-
|
218
|
-
|
255
|
+
T.any(
|
256
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::FixedFeeQuantitySchedule,
|
257
|
+
Orb::Internal::AnyHash
|
258
|
+
)
|
219
259
|
],
|
220
260
|
invoicing_threshold: T.nilable(String),
|
221
261
|
maximum_intervals: T::Array[
|
222
|
-
|
223
|
-
|
224
|
-
|
225
|
-
|
262
|
+
T.any(
|
263
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::MaximumInterval,
|
264
|
+
Orb::Internal::AnyHash
|
265
|
+
)
|
226
266
|
],
|
227
267
|
metadata: T::Hash[Symbol, String],
|
228
268
|
minimum_intervals: T::Array[
|
229
|
-
|
230
|
-
|
231
|
-
|
232
|
-
|
269
|
+
T.any(
|
270
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::MinimumInterval,
|
271
|
+
Orb::Internal::AnyHash
|
272
|
+
)
|
233
273
|
],
|
234
274
|
net_terms: Integer,
|
275
|
+
pending_subscription_change: T.nilable(
|
276
|
+
T.any(
|
277
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PendingSubscriptionChange,
|
278
|
+
Orb::Internal::AnyHash
|
279
|
+
)
|
280
|
+
),
|
235
281
|
plan: T.any(Orb::Models::Plan, Orb::Internal::AnyHash),
|
236
282
|
price_intervals: T::Array[
|
237
|
-
|
238
|
-
|
239
|
-
|
240
|
-
|
283
|
+
T.any(
|
284
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PriceInterval,
|
285
|
+
Orb::Internal::AnyHash
|
286
|
+
)
|
241
287
|
],
|
242
288
|
redeemed_coupon: T.nilable(
|
243
289
|
T.any(
|
@@ -247,7 +293,13 @@ module Orb
|
|
247
293
|
),
|
248
294
|
start_date: Time,
|
249
295
|
status: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::Status::OrSymbol,
|
250
|
-
trial_info: T.any(Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::TrialInfo, Orb::Internal::AnyHash)
|
296
|
+
trial_info: T.any(Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::TrialInfo, Orb::Internal::AnyHash),
|
297
|
+
changed_resources: T.nilable(
|
298
|
+
T.any(
|
299
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::ChangedResources,
|
300
|
+
Orb::Internal::AnyHash
|
301
|
+
)
|
302
|
+
)
|
251
303
|
)
|
252
304
|
.returns(T.attached_class)
|
253
305
|
end
|
@@ -271,15 +323,15 @@ module Orb
|
|
271
323
|
metadata:,
|
272
324
|
minimum_intervals:,
|
273
325
|
net_terms:,
|
326
|
+
pending_subscription_change:,
|
274
327
|
plan:,
|
275
328
|
price_intervals:,
|
276
329
|
redeemed_coupon:,
|
277
330
|
start_date:,
|
278
331
|
status:,
|
279
|
-
trial_info
|
280
|
-
|
281
|
-
end
|
282
|
-
|
332
|
+
trial_info:,
|
333
|
+
changed_resources: nil
|
334
|
+
); end
|
283
335
|
sig do
|
284
336
|
override
|
285
337
|
.returns(
|
@@ -296,11 +348,11 @@ module Orb
|
|
296
348
|
customer: Orb::Models::Customer,
|
297
349
|
default_invoice_memo: T.nilable(String),
|
298
350
|
discount_intervals: T::Array[
|
299
|
-
|
300
|
-
|
301
|
-
|
302
|
-
|
303
|
-
|
351
|
+
T.any(
|
352
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::AmountDiscountInterval,
|
353
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::PercentageDiscountInterval,
|
354
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::UsageDiscountInterval
|
355
|
+
)
|
304
356
|
],
|
305
357
|
end_date: T.nilable(Time),
|
306
358
|
fixed_fee_quantity_schedule: T::Array[Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::FixedFeeQuantitySchedule],
|
@@ -309,17 +361,18 @@ module Orb
|
|
309
361
|
metadata: T::Hash[Symbol, String],
|
310
362
|
minimum_intervals: T::Array[Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::MinimumInterval],
|
311
363
|
net_terms: Integer,
|
364
|
+
pending_subscription_change: T.nilable(Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PendingSubscriptionChange),
|
312
365
|
plan: Orb::Models::Plan,
|
313
366
|
price_intervals: T::Array[Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PriceInterval],
|
314
367
|
redeemed_coupon: T.nilable(Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::RedeemedCoupon),
|
315
368
|
start_date: Time,
|
316
369
|
status: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::Status::TaggedSymbol,
|
317
|
-
trial_info: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::TrialInfo
|
370
|
+
trial_info: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::TrialInfo,
|
371
|
+
changed_resources: T.nilable(Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::ChangedResources)
|
318
372
|
}
|
319
373
|
)
|
320
374
|
end
|
321
|
-
def to_hash
|
322
|
-
end
|
375
|
+
def to_hash; end
|
323
376
|
|
324
377
|
class AdjustmentInterval < Orb::Internal::Type::BaseModel
|
325
378
|
sig { returns(String) }
|
@@ -367,8 +420,7 @@ module Orb
|
|
367
420
|
)
|
368
421
|
.returns(T.attached_class)
|
369
422
|
end
|
370
|
-
def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:)
|
371
|
-
end
|
423
|
+
def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end
|
372
424
|
|
373
425
|
sig do
|
374
426
|
override
|
@@ -388,8 +440,7 @@ module Orb
|
|
388
440
|
}
|
389
441
|
)
|
390
442
|
end
|
391
|
-
def to_hash
|
392
|
-
end
|
443
|
+
def to_hash; end
|
393
444
|
|
394
445
|
module Adjustment
|
395
446
|
extend Orb::Internal::Type::Union
|
@@ -406,7 +457,7 @@ module Orb
|
|
406
457
|
attr_accessor :applies_to_price_ids
|
407
458
|
|
408
459
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
409
|
-
#
|
460
|
+
# that apply to only one price.
|
410
461
|
sig { returns(T::Boolean) }
|
411
462
|
attr_accessor :is_invoice_level
|
412
463
|
|
@@ -419,7 +470,7 @@ module Orb
|
|
419
470
|
attr_accessor :reason
|
420
471
|
|
421
472
|
# The number of usage units by which to discount the price this adjustment applies
|
422
|
-
#
|
473
|
+
# to in a given billing period.
|
423
474
|
sig { returns(Float) }
|
424
475
|
attr_accessor :usage_discount
|
425
476
|
|
@@ -443,9 +494,7 @@ module Orb
|
|
443
494
|
reason:,
|
444
495
|
usage_discount:,
|
445
496
|
adjustment_type: :usage_discount
|
446
|
-
)
|
447
|
-
end
|
448
|
-
|
497
|
+
); end
|
449
498
|
sig do
|
450
499
|
override
|
451
500
|
.returns(
|
@@ -460,8 +509,7 @@ module Orb
|
|
460
509
|
}
|
461
510
|
)
|
462
511
|
end
|
463
|
-
def to_hash
|
464
|
-
end
|
512
|
+
def to_hash; end
|
465
513
|
end
|
466
514
|
|
467
515
|
class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
|
@@ -472,7 +520,7 @@ module Orb
|
|
472
520
|
attr_accessor :adjustment_type
|
473
521
|
|
474
522
|
# The amount by which to discount the prices this adjustment applies to in a given
|
475
|
-
#
|
523
|
+
# billing period.
|
476
524
|
sig { returns(String) }
|
477
525
|
attr_accessor :amount_discount
|
478
526
|
|
@@ -481,7 +529,7 @@ module Orb
|
|
481
529
|
attr_accessor :applies_to_price_ids
|
482
530
|
|
483
531
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
484
|
-
#
|
532
|
+
# that apply to only one price.
|
485
533
|
sig { returns(T::Boolean) }
|
486
534
|
attr_accessor :is_invoice_level
|
487
535
|
|
@@ -513,9 +561,7 @@ module Orb
|
|
513
561
|
plan_phase_order:,
|
514
562
|
reason:,
|
515
563
|
adjustment_type: :amount_discount
|
516
|
-
)
|
517
|
-
end
|
518
|
-
|
564
|
+
); end
|
519
565
|
sig do
|
520
566
|
override
|
521
567
|
.returns(
|
@@ -530,8 +576,7 @@ module Orb
|
|
530
576
|
}
|
531
577
|
)
|
532
578
|
end
|
533
|
-
def to_hash
|
534
|
-
end
|
579
|
+
def to_hash; end
|
535
580
|
end
|
536
581
|
|
537
582
|
class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
|
@@ -546,12 +591,12 @@ module Orb
|
|
546
591
|
attr_accessor :applies_to_price_ids
|
547
592
|
|
548
593
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
549
|
-
#
|
594
|
+
# that apply to only one price.
|
550
595
|
sig { returns(T::Boolean) }
|
551
596
|
attr_accessor :is_invoice_level
|
552
597
|
|
553
598
|
# The percentage (as a value between 0 and 1) by which to discount the price
|
554
|
-
#
|
599
|
+
# intervals this adjustment applies to in a given billing period.
|
555
600
|
sig { returns(Float) }
|
556
601
|
attr_accessor :percentage_discount
|
557
602
|
|
@@ -583,9 +628,7 @@ module Orb
|
|
583
628
|
plan_phase_order:,
|
584
629
|
reason:,
|
585
630
|
adjustment_type: :percentage_discount
|
586
|
-
)
|
587
|
-
end
|
588
|
-
|
631
|
+
); end
|
589
632
|
sig do
|
590
633
|
override
|
591
634
|
.returns(
|
@@ -600,8 +643,7 @@ module Orb
|
|
600
643
|
}
|
601
644
|
)
|
602
645
|
end
|
603
|
-
def to_hash
|
604
|
-
end
|
646
|
+
def to_hash; end
|
605
647
|
end
|
606
648
|
|
607
649
|
class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel
|
@@ -616,7 +658,7 @@ module Orb
|
|
616
658
|
attr_accessor :applies_to_price_ids
|
617
659
|
|
618
660
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
619
|
-
#
|
661
|
+
# that apply to only one price.
|
620
662
|
sig { returns(T::Boolean) }
|
621
663
|
attr_accessor :is_invoice_level
|
622
664
|
|
@@ -625,7 +667,7 @@ module Orb
|
|
625
667
|
attr_accessor :item_id
|
626
668
|
|
627
669
|
# The minimum amount to charge in a given billing period for the prices this
|
628
|
-
#
|
670
|
+
# adjustment applies to.
|
629
671
|
sig { returns(String) }
|
630
672
|
attr_accessor :minimum_amount
|
631
673
|
|
@@ -659,9 +701,7 @@ module Orb
|
|
659
701
|
plan_phase_order:,
|
660
702
|
reason:,
|
661
703
|
adjustment_type: :minimum
|
662
|
-
)
|
663
|
-
end
|
664
|
-
|
704
|
+
); end
|
665
705
|
sig do
|
666
706
|
override
|
667
707
|
.returns(
|
@@ -677,8 +717,7 @@ module Orb
|
|
677
717
|
}
|
678
718
|
)
|
679
719
|
end
|
680
|
-
def to_hash
|
681
|
-
end
|
720
|
+
def to_hash; end
|
682
721
|
end
|
683
722
|
|
684
723
|
class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel
|
@@ -693,12 +732,12 @@ module Orb
|
|
693
732
|
attr_accessor :applies_to_price_ids
|
694
733
|
|
695
734
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
696
|
-
#
|
735
|
+
# that apply to only one price.
|
697
736
|
sig { returns(T::Boolean) }
|
698
737
|
attr_accessor :is_invoice_level
|
699
738
|
|
700
739
|
# The maximum amount to charge in a given billing period for the prices this
|
701
|
-
#
|
740
|
+
# adjustment applies to.
|
702
741
|
sig { returns(String) }
|
703
742
|
attr_accessor :maximum_amount
|
704
743
|
|
@@ -730,9 +769,7 @@ module Orb
|
|
730
769
|
plan_phase_order:,
|
731
770
|
reason:,
|
732
771
|
adjustment_type: :maximum
|
733
|
-
)
|
734
|
-
end
|
735
|
-
|
772
|
+
); end
|
736
773
|
sig do
|
737
774
|
override
|
738
775
|
.returns(
|
@@ -747,8 +784,7 @@ module Orb
|
|
747
784
|
}
|
748
785
|
)
|
749
786
|
end
|
750
|
-
def to_hash
|
751
|
-
end
|
787
|
+
def to_hash; end
|
752
788
|
end
|
753
789
|
|
754
790
|
sig do
|
@@ -757,39 +793,36 @@ module Orb
|
|
757
793
|
[Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment]
|
758
794
|
)
|
759
795
|
end
|
760
|
-
def self.variants
|
761
|
-
end
|
796
|
+
def self.variants; end
|
762
797
|
end
|
763
798
|
end
|
764
799
|
|
765
800
|
class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel
|
766
801
|
# The day of the month on which the billing cycle is anchored. If the maximum
|
767
|
-
#
|
768
|
-
#
|
769
|
-
#
|
802
|
+
# number of days in a month is greater than this value, the last day of the month
|
803
|
+
# is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
|
804
|
+
# period begins on the 30th.
|
770
805
|
sig { returns(Integer) }
|
771
806
|
attr_accessor :day
|
772
807
|
|
773
808
|
# The month on which the billing cycle is anchored (e.g. a quarterly price
|
774
|
-
#
|
775
|
-
#
|
809
|
+
# anchored in February would have cycles starting February, May, August, and
|
810
|
+
# November).
|
776
811
|
sig { returns(T.nilable(Integer)) }
|
777
812
|
attr_accessor :month
|
778
813
|
|
779
814
|
# The year on which the billing cycle is anchored (e.g. a 2 year billing cycle
|
780
|
-
#
|
815
|
+
# anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.).
|
781
816
|
sig { returns(T.nilable(Integer)) }
|
782
817
|
attr_accessor :year
|
783
818
|
|
784
819
|
sig do
|
785
820
|
params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class)
|
786
821
|
end
|
787
|
-
def self.new(day:, month: nil, year: nil)
|
788
|
-
end
|
822
|
+
def self.new(day:, month: nil, year: nil); end
|
789
823
|
|
790
824
|
sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) }
|
791
|
-
def to_hash
|
792
|
-
end
|
825
|
+
def to_hash; end
|
793
826
|
end
|
794
827
|
|
795
828
|
module DiscountInterval
|
@@ -837,9 +870,7 @@ module Orb
|
|
837
870
|
end_date:,
|
838
871
|
start_date:,
|
839
872
|
discount_type: :amount
|
840
|
-
)
|
841
|
-
end
|
842
|
-
|
873
|
+
); end
|
843
874
|
sig do
|
844
875
|
override
|
845
876
|
.returns(
|
@@ -853,8 +884,7 @@ module Orb
|
|
853
884
|
}
|
854
885
|
)
|
855
886
|
end
|
856
|
-
def to_hash
|
857
|
-
end
|
887
|
+
def to_hash; end
|
858
888
|
end
|
859
889
|
|
860
890
|
class PercentageDiscountInterval < Orb::Internal::Type::BaseModel
|
@@ -874,7 +904,7 @@ module Orb
|
|
874
904
|
attr_accessor :end_date
|
875
905
|
|
876
906
|
# Only available if discount_type is `percentage`.This is a number between 0
|
877
|
-
#
|
907
|
+
# and 1.
|
878
908
|
sig { returns(Float) }
|
879
909
|
attr_accessor :percentage_discount
|
880
910
|
|
@@ -900,9 +930,7 @@ module Orb
|
|
900
930
|
percentage_discount:,
|
901
931
|
start_date:,
|
902
932
|
discount_type: :percentage
|
903
|
-
)
|
904
|
-
end
|
905
|
-
|
933
|
+
); end
|
906
934
|
sig do
|
907
935
|
override
|
908
936
|
.returns(
|
@@ -916,8 +944,7 @@ module Orb
|
|
916
944
|
}
|
917
945
|
)
|
918
946
|
end
|
919
|
-
def to_hash
|
920
|
-
end
|
947
|
+
def to_hash; end
|
921
948
|
end
|
922
949
|
|
923
950
|
class UsageDiscountInterval < Orb::Internal::Type::BaseModel
|
@@ -941,7 +968,7 @@ module Orb
|
|
941
968
|
attr_accessor :start_date
|
942
969
|
|
943
970
|
# Only available if discount_type is `usage`. Number of usage units that this
|
944
|
-
#
|
971
|
+
# discount is for
|
945
972
|
sig { returns(Float) }
|
946
973
|
attr_accessor :usage_discount
|
947
974
|
|
@@ -963,9 +990,7 @@ module Orb
|
|
963
990
|
start_date:,
|
964
991
|
usage_discount:,
|
965
992
|
discount_type: :usage
|
966
|
-
)
|
967
|
-
end
|
968
|
-
|
993
|
+
); end
|
969
994
|
sig do
|
970
995
|
override
|
971
996
|
.returns(
|
@@ -979,8 +1004,7 @@ module Orb
|
|
979
1004
|
}
|
980
1005
|
)
|
981
1006
|
end
|
982
|
-
def to_hash
|
983
|
-
end
|
1007
|
+
def to_hash; end
|
984
1008
|
end
|
985
1009
|
|
986
1010
|
sig do
|
@@ -989,8 +1013,7 @@ module Orb
|
|
989
1013
|
[Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::UsageDiscountInterval]
|
990
1014
|
)
|
991
1015
|
end
|
992
|
-
def self.variants
|
993
|
-
end
|
1016
|
+
def self.variants; end
|
994
1017
|
end
|
995
1018
|
|
996
1019
|
class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
|
@@ -1010,14 +1033,12 @@ module Orb
|
|
1010
1033
|
params(end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time)
|
1011
1034
|
.returns(T.attached_class)
|
1012
1035
|
end
|
1013
|
-
def self.new(end_date:, price_id:, quantity:, start_date:)
|
1014
|
-
end
|
1036
|
+
def self.new(end_date:, price_id:, quantity:, start_date:); end
|
1015
1037
|
|
1016
1038
|
sig do
|
1017
1039
|
override.returns({end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time})
|
1018
1040
|
end
|
1019
|
-
def to_hash
|
1020
|
-
end
|
1041
|
+
def to_hash; end
|
1021
1042
|
end
|
1022
1043
|
|
1023
1044
|
class MaximumInterval < Orb::Internal::Type::BaseModel
|
@@ -1034,7 +1055,7 @@ module Orb
|
|
1034
1055
|
attr_accessor :end_date
|
1035
1056
|
|
1036
1057
|
# The maximum amount to charge in a given billing period for the price intervals
|
1037
|
-
#
|
1058
|
+
# this transform applies to.
|
1038
1059
|
sig { returns(String) }
|
1039
1060
|
attr_accessor :maximum_amount
|
1040
1061
|
|
@@ -1073,8 +1094,7 @@ module Orb
|
|
1073
1094
|
}
|
1074
1095
|
)
|
1075
1096
|
end
|
1076
|
-
def to_hash
|
1077
|
-
end
|
1097
|
+
def to_hash; end
|
1078
1098
|
end
|
1079
1099
|
|
1080
1100
|
class MinimumInterval < Orb::Internal::Type::BaseModel
|
@@ -1091,7 +1111,7 @@ module Orb
|
|
1091
1111
|
attr_accessor :end_date
|
1092
1112
|
|
1093
1113
|
# The minimum amount to charge in a given billing period for the price intervals
|
1094
|
-
#
|
1114
|
+
# this minimum applies to.
|
1095
1115
|
sig { returns(String) }
|
1096
1116
|
attr_accessor :minimum_amount
|
1097
1117
|
|
@@ -1130,8 +1150,19 @@ module Orb
|
|
1130
1150
|
}
|
1131
1151
|
)
|
1132
1152
|
end
|
1133
|
-
def to_hash
|
1134
|
-
|
1153
|
+
def to_hash; end
|
1154
|
+
end
|
1155
|
+
|
1156
|
+
class PendingSubscriptionChange < Orb::Internal::Type::BaseModel
|
1157
|
+
sig { returns(String) }
|
1158
|
+
attr_accessor :id
|
1159
|
+
|
1160
|
+
# A pending subscription change if one exists on this subscription.
|
1161
|
+
sig { params(id: String).returns(T.attached_class) }
|
1162
|
+
def self.new(id:); end
|
1163
|
+
|
1164
|
+
sig { override.returns({id: String}) }
|
1165
|
+
def to_hash; end
|
1135
1166
|
end
|
1136
1167
|
|
1137
1168
|
class PriceInterval < Orb::Internal::Type::BaseModel
|
@@ -1143,19 +1174,19 @@ module Orb
|
|
1143
1174
|
attr_accessor :billing_cycle_day
|
1144
1175
|
|
1145
1176
|
# The end of the current billing period. This is an exclusive timestamp, such that
|
1146
|
-
#
|
1147
|
-
#
|
1177
|
+
# the instant returned is exactly the end of the billing period. Set to null if
|
1178
|
+
# this price interval is not currently active.
|
1148
1179
|
sig { returns(T.nilable(Time)) }
|
1149
1180
|
attr_accessor :current_billing_period_end_date
|
1150
1181
|
|
1151
1182
|
# The start date of the current billing period. This is an inclusive timestamp;
|
1152
|
-
#
|
1153
|
-
#
|
1183
|
+
# the instant returned is exactly the beginning of the billing period. Set to null
|
1184
|
+
# if this price interval is not currently active.
|
1154
1185
|
sig { returns(T.nilable(Time)) }
|
1155
1186
|
attr_accessor :current_billing_period_start_date
|
1156
1187
|
|
1157
1188
|
# The end date of the price interval. This is the date that Orb stops billing for
|
1158
|
-
#
|
1189
|
+
# this price.
|
1159
1190
|
sig { returns(T.nilable(Time)) }
|
1160
1191
|
attr_accessor :end_date
|
1161
1192
|
|
@@ -1164,7 +1195,7 @@ module Orb
|
|
1164
1195
|
attr_accessor :filter
|
1165
1196
|
|
1166
1197
|
# The fixed fee quantity transitions for this price interval. This is only
|
1167
|
-
#
|
1198
|
+
# relevant for fixed fees.
|
1168
1199
|
sig do
|
1169
1200
|
returns(
|
1170
1201
|
T.nilable(
|
@@ -1175,15 +1206,15 @@ module Orb
|
|
1175
1206
|
attr_accessor :fixed_fee_quantity_transitions
|
1176
1207
|
|
1177
1208
|
# The Price resource represents a price that can be billed on a subscription,
|
1178
|
-
#
|
1179
|
-
#
|
1209
|
+
# resulting in a charge on an invoice in the form of an invoice line item. Prices
|
1210
|
+
# take a quantity and determine an amount to bill.
|
1180
1211
|
#
|
1181
|
-
#
|
1182
|
-
#
|
1183
|
-
#
|
1212
|
+
# Orb supports a few different pricing models out of the box. Each of these models
|
1213
|
+
# is serialized differently in a given Price object. The model_type field
|
1214
|
+
# determines the key for the configuration object that is present.
|
1184
1215
|
#
|
1185
|
-
#
|
1186
|
-
#
|
1216
|
+
# For more on the types of prices, see
|
1217
|
+
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1187
1218
|
sig do
|
1188
1219
|
returns(
|
1189
1220
|
T.any(
|
@@ -1221,18 +1252,18 @@ module Orb
|
|
1221
1252
|
attr_accessor :price
|
1222
1253
|
|
1223
1254
|
# The start date of the price interval. This is the date that Orb starts billing
|
1224
|
-
#
|
1255
|
+
# for this price.
|
1225
1256
|
sig { returns(Time) }
|
1226
1257
|
attr_accessor :start_date
|
1227
1258
|
|
1228
1259
|
# A list of customer IDs whose usage events will be aggregated and billed under
|
1229
|
-
#
|
1260
|
+
# this price interval.
|
1230
1261
|
sig { returns(T.nilable(T::Array[String])) }
|
1231
1262
|
attr_accessor :usage_customer_ids
|
1232
1263
|
|
1233
1264
|
# The Price Interval resource represents a period of time for which a price will
|
1234
|
-
#
|
1235
|
-
#
|
1265
|
+
# bill on a subscription. A subscription’s price intervals define its billing
|
1266
|
+
# behavior.
|
1236
1267
|
sig do
|
1237
1268
|
params(
|
1238
1269
|
id: String,
|
@@ -1243,10 +1274,10 @@ module Orb
|
|
1243
1274
|
filter: T.nilable(String),
|
1244
1275
|
fixed_fee_quantity_transitions: T.nilable(
|
1245
1276
|
T::Array[
|
1246
|
-
|
1247
|
-
|
1248
|
-
|
1249
|
-
|
1277
|
+
T.any(
|
1278
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PriceInterval::FixedFeeQuantityTransition,
|
1279
|
+
Orb::Internal::AnyHash
|
1280
|
+
)
|
1250
1281
|
]
|
1251
1282
|
),
|
1252
1283
|
price: T.any(
|
@@ -1296,9 +1327,7 @@ module Orb
|
|
1296
1327
|
price:,
|
1297
1328
|
start_date:,
|
1298
1329
|
usage_customer_ids:
|
1299
|
-
)
|
1300
|
-
end
|
1301
|
-
|
1330
|
+
); end
|
1302
1331
|
sig do
|
1303
1332
|
override
|
1304
1333
|
.returns(
|
@@ -1347,8 +1376,7 @@ module Orb
|
|
1347
1376
|
}
|
1348
1377
|
)
|
1349
1378
|
end
|
1350
|
-
def to_hash
|
1351
|
-
end
|
1379
|
+
def to_hash; end
|
1352
1380
|
|
1353
1381
|
class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
|
1354
1382
|
sig { returns(Time) }
|
@@ -1361,12 +1389,10 @@ module Orb
|
|
1361
1389
|
attr_accessor :quantity
|
1362
1390
|
|
1363
1391
|
sig { params(effective_date: Time, price_id: String, quantity: Integer).returns(T.attached_class) }
|
1364
|
-
def self.new(effective_date:, price_id:, quantity:)
|
1365
|
-
end
|
1392
|
+
def self.new(effective_date:, price_id:, quantity:); end
|
1366
1393
|
|
1367
1394
|
sig { override.returns({effective_date: Time, price_id: String, quantity: Integer}) }
|
1368
|
-
def to_hash
|
1369
|
-
end
|
1395
|
+
def to_hash; end
|
1370
1396
|
end
|
1371
1397
|
end
|
1372
1398
|
|
@@ -1383,12 +1409,10 @@ module Orb
|
|
1383
1409
|
sig do
|
1384
1410
|
params(coupon_id: String, end_date: T.nilable(Time), start_date: Time).returns(T.attached_class)
|
1385
1411
|
end
|
1386
|
-
def self.new(coupon_id:, end_date:, start_date:)
|
1387
|
-
end
|
1412
|
+
def self.new(coupon_id:, end_date:, start_date:); end
|
1388
1413
|
|
1389
1414
|
sig { override.returns({coupon_id: String, end_date: T.nilable(Time), start_date: Time}) }
|
1390
|
-
def to_hash
|
1391
|
-
end
|
1415
|
+
def to_hash; end
|
1392
1416
|
end
|
1393
1417
|
|
1394
1418
|
module Status
|
@@ -1410,8 +1434,7 @@ module Orb
|
|
1410
1434
|
override
|
1411
1435
|
.returns(T::Array[Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::Status::TaggedSymbol])
|
1412
1436
|
end
|
1413
|
-
def self.values
|
1414
|
-
end
|
1437
|
+
def self.values; end
|
1415
1438
|
end
|
1416
1439
|
|
1417
1440
|
class TrialInfo < Orb::Internal::Type::BaseModel
|
@@ -1419,12 +1442,55 @@ module Orb
|
|
1419
1442
|
attr_accessor :end_date
|
1420
1443
|
|
1421
1444
|
sig { params(end_date: T.nilable(Time)).returns(T.attached_class) }
|
1422
|
-
def self.new(end_date:)
|
1423
|
-
end
|
1445
|
+
def self.new(end_date:); end
|
1424
1446
|
|
1425
1447
|
sig { override.returns({end_date: T.nilable(Time)}) }
|
1426
|
-
def to_hash
|
1448
|
+
def to_hash; end
|
1449
|
+
end
|
1450
|
+
|
1451
|
+
class ChangedResources < Orb::Internal::Type::BaseModel
|
1452
|
+
# The credit notes that were created as part of this operation.
|
1453
|
+
sig { returns(T::Array[Orb::Models::CreditNote]) }
|
1454
|
+
attr_accessor :created_credit_notes
|
1455
|
+
|
1456
|
+
# The invoices that were created as part of this operation.
|
1457
|
+
sig { returns(T::Array[Orb::Models::Invoice]) }
|
1458
|
+
attr_accessor :created_invoices
|
1459
|
+
|
1460
|
+
# The credit notes that were voided as part of this operation.
|
1461
|
+
sig { returns(T::Array[Orb::Models::CreditNote]) }
|
1462
|
+
attr_accessor :voided_credit_notes
|
1463
|
+
|
1464
|
+
# The invoices that were voided as part of this operation.
|
1465
|
+
sig { returns(T::Array[Orb::Models::Invoice]) }
|
1466
|
+
attr_accessor :voided_invoices
|
1467
|
+
|
1468
|
+
# The resources that were changed as part of this operation. Only present when
|
1469
|
+
# fetched through the subscription changes API or if the
|
1470
|
+
# `include_changed_resources` parameter was passed in the request.
|
1471
|
+
sig do
|
1472
|
+
params(
|
1473
|
+
created_credit_notes: T::Array[T.any(Orb::Models::CreditNote, Orb::Internal::AnyHash)],
|
1474
|
+
created_invoices: T::Array[T.any(Orb::Models::Invoice, Orb::Internal::AnyHash)],
|
1475
|
+
voided_credit_notes: T::Array[T.any(Orb::Models::CreditNote, Orb::Internal::AnyHash)],
|
1476
|
+
voided_invoices: T::Array[T.any(Orb::Models::Invoice, Orb::Internal::AnyHash)]
|
1477
|
+
)
|
1478
|
+
.returns(T.attached_class)
|
1479
|
+
end
|
1480
|
+
def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end
|
1481
|
+
|
1482
|
+
sig do
|
1483
|
+
override
|
1484
|
+
.returns(
|
1485
|
+
{
|
1486
|
+
created_credit_notes: T::Array[Orb::Models::CreditNote],
|
1487
|
+
created_invoices: T::Array[Orb::Models::Invoice],
|
1488
|
+
voided_credit_notes: T::Array[Orb::Models::CreditNote],
|
1489
|
+
voided_invoices: T::Array[Orb::Models::Invoice]
|
1490
|
+
}
|
1491
|
+
)
|
1427
1492
|
end
|
1493
|
+
def to_hash; end
|
1428
1494
|
end
|
1429
1495
|
end
|
1430
1496
|
end
|