orb-billing 0.2.0 → 0.3.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/CHANGELOG.md +67 -0
- data/README.md +63 -53
- data/lib/orb/client.rb +4 -4
- data/lib/orb/errors.rb +9 -9
- data/lib/orb/file_part.rb +55 -0
- data/lib/orb/internal/page.rb +7 -11
- data/lib/orb/internal/transport/base_client.rb +10 -10
- data/lib/orb/internal/transport/pooled_net_requester.rb +2 -2
- data/lib/orb/internal/type/array_of.rb +11 -0
- data/lib/orb/internal/type/base_model.rb +33 -23
- data/lib/orb/internal/type/base_page.rb +9 -1
- data/lib/orb/internal/type/boolean.rb +14 -11
- data/lib/orb/internal/type/converter.rb +4 -1
- data/lib/orb/internal/type/enum.rb +19 -16
- data/lib/orb/internal/type/{io_like.rb → file_input.rb} +33 -15
- data/lib/orb/internal/type/hash_of.rb +11 -0
- data/lib/orb/internal/type/request_parameters.rb +3 -10
- data/lib/orb/internal/type/union.rb +10 -1
- data/lib/orb/internal/type/unknown.rb +14 -11
- data/lib/orb/internal/util.rb +88 -64
- data/lib/orb/internal.rb +0 -1
- data/lib/orb/models/alert.rb +68 -71
- data/lib/orb/models/alert_create_for_customer_params.rb +20 -25
- data/lib/orb/models/alert_create_for_external_customer_params.rb +20 -25
- data/lib/orb/models/alert_create_for_subscription_params.rb +20 -25
- data/lib/orb/models/alert_disable_params.rb +5 -9
- data/lib/orb/models/alert_enable_params.rb +5 -9
- data/lib/orb/models/alert_list_params.rb +26 -36
- data/lib/orb/models/alert_retrieve_params.rb +3 -8
- data/lib/orb/models/alert_update_params.rb +14 -18
- data/lib/orb/models/amount_discount.rb +14 -14
- data/lib/orb/models/billable_metric.rb +23 -20
- data/lib/orb/models/billing_cycle_relative_date.rb +2 -5
- data/lib/orb/models/coupon.rb +28 -21
- data/lib/orb/models/coupon_archive_params.rb +3 -8
- data/lib/orb/models/coupon_create_params.rb +29 -34
- data/lib/orb/models/coupon_fetch_params.rb +3 -8
- data/lib/orb/models/coupon_list_params.rb +17 -17
- data/lib/orb/models/coupons/subscription_list_params.rb +12 -15
- data/lib/orb/models/credit_note.rb +100 -166
- data/lib/orb/models/credit_note_create_params.rb +15 -23
- data/lib/orb/models/credit_note_fetch_params.rb +3 -8
- data/lib/orb/models/credit_note_list_params.rb +20 -30
- data/lib/orb/models/customer.rb +224 -271
- data/lib/orb/models/customer_create_params.rb +216 -257
- data/lib/orb/models/customer_delete_params.rb +3 -8
- data/lib/orb/models/customer_fetch_by_external_id_params.rb +3 -8
- data/lib/orb/models/customer_fetch_params.rb +3 -8
- data/lib/orb/models/customer_list_params.rb +20 -30
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +3 -8
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +3 -8
- data/lib/orb/models/customer_update_by_external_id_params.rb +212 -257
- data/lib/orb/models/customer_update_params.rb +212 -255
- data/lib/orb/models/customers/balance_transaction_create_params.rb +11 -16
- data/lib/orb/models/customers/balance_transaction_create_response.rb +33 -51
- data/lib/orb/models/customers/balance_transaction_list_params.rb +20 -30
- data/lib/orb/models/customers/balance_transaction_list_response.rb +33 -51
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +23 -27
- data/lib/orb/models/customers/cost_list_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_response.rb +23 -27
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +18 -22
- data/lib/orb/models/customers/credit_list_by_external_id_response.rb +10 -17
- data/lib/orb/models/customers/credit_list_params.rb +18 -22
- data/lib/orb/models/customers/credit_list_response.rb +10 -17
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +64 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +384 -491
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +63 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +384 -498
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +33 -48
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +384 -494
- data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
- data/lib/orb/models/customers/credits/ledger_list_response.rb +383 -501
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +47 -50
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +43 -46
- data/lib/orb/models/customers/credits/top_up_create_params.rb +46 -50
- data/lib/orb/models/customers/credits/top_up_create_response.rb +42 -46
- data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +4 -9
- data/lib/orb/models/customers/credits/top_up_delete_params.rb +4 -9
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +12 -15
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +43 -46
- data/lib/orb/models/customers/credits/top_up_list_params.rb +12 -15
- data/lib/orb/models/customers/credits/top_up_list_response.rb +42 -46
- data/lib/orb/models/dimensional_price_group.rb +21 -15
- data/lib/orb/models/dimensional_price_group_create_params.rb +17 -23
- data/lib/orb/models/dimensional_price_group_list_params.rb +12 -15
- data/lib/orb/models/dimensional_price_group_retrieve_params.rb +3 -8
- data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +3 -8
- data/lib/orb/models/dimensional_price_groups.rb +3 -7
- data/lib/orb/models/discount.rb +2 -3
- data/lib/orb/models/evaluate_price_group.rb +8 -11
- data/lib/orb/models/event_deprecate_params.rb +3 -8
- data/lib/orb/models/event_deprecate_response.rb +2 -6
- data/lib/orb/models/event_ingest_params.rb +33 -27
- data/lib/orb/models/event_ingest_response.rb +23 -24
- data/lib/orb/models/event_search_params.rb +15 -11
- data/lib/orb/models/event_search_response.rb +27 -22
- data/lib/orb/models/event_update_params.rb +19 -13
- data/lib/orb/models/event_update_response.rb +2 -6
- data/lib/orb/models/events/backfill_close_params.rb +3 -8
- data/lib/orb/models/events/backfill_close_response.rb +34 -39
- data/lib/orb/models/events/backfill_create_params.rb +28 -32
- data/lib/orb/models/events/backfill_create_response.rb +34 -39
- data/lib/orb/models/events/backfill_fetch_params.rb +3 -8
- data/lib/orb/models/events/backfill_fetch_response.rb +34 -39
- data/lib/orb/models/events/backfill_list_params.rb +12 -15
- data/lib/orb/models/events/backfill_list_response.rb +34 -39
- data/lib/orb/models/events/backfill_revert_params.rb +3 -8
- data/lib/orb/models/events/backfill_revert_response.rb +34 -39
- data/lib/orb/models/events/event_volumes.rb +11 -17
- data/lib/orb/models/events/volume_list_params.rb +19 -22
- data/lib/orb/models/invoice.rb +619 -681
- data/lib/orb/models/invoice_create_params.rb +52 -61
- data/lib/orb/models/invoice_fetch_params.rb +3 -8
- data/lib/orb/models/invoice_fetch_upcoming_params.rb +4 -9
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +618 -669
- data/lib/orb/models/invoice_issue_params.rb +10 -14
- data/lib/orb/models/invoice_level_discount.rb +2 -3
- data/lib/orb/models/invoice_line_item_create_params.rb +19 -14
- data/lib/orb/models/invoice_line_item_create_response.rb +281 -306
- data/lib/orb/models/invoice_list_params.rb +51 -66
- data/lib/orb/models/invoice_mark_paid_params.rb +9 -11
- data/lib/orb/models/invoice_pay_params.rb +3 -8
- data/lib/orb/models/invoice_update_params.rb +9 -9
- data/lib/orb/models/invoice_void_params.rb +3 -8
- data/lib/orb/models/item.rb +14 -25
- data/lib/orb/models/item_create_params.rb +5 -9
- data/lib/orb/models/item_fetch_params.rb +3 -8
- data/lib/orb/models/item_list_params.rb +12 -15
- data/lib/orb/models/item_update_params.rb +10 -22
- data/lib/orb/models/metric_create_params.rb +17 -13
- data/lib/orb/models/metric_fetch_params.rb +3 -8
- data/lib/orb/models/metric_list_params.rb +20 -30
- data/lib/orb/models/metric_update_params.rb +9 -9
- data/lib/orb/models/pagination_metadata.rb +3 -7
- data/lib/orb/models/percentage_discount.rb +15 -14
- data/lib/orb/models/plan.rb +259 -291
- data/lib/orb/models/plan_create_params.rb +2070 -2466
- data/lib/orb/models/plan_fetch_params.rb +3 -8
- data/lib/orb/models/plan_list_params.rb +25 -42
- data/lib/orb/models/plan_update_params.rb +12 -10
- data/lib/orb/models/plans/external_plan_id_fetch_params.rb +3 -8
- data/lib/orb/models/plans/external_plan_id_update_params.rb +12 -10
- data/lib/orb/models/price.rb +3842 -5005
- data/lib/orb/models/price_create_params.rb +203 -244
- data/lib/orb/models/price_evaluate_params.rb +21 -30
- data/lib/orb/models/price_evaluate_response.rb +2 -6
- data/lib/orb/models/price_fetch_params.rb +3 -8
- data/lib/orb/models/price_list_params.rb +12 -15
- data/lib/orb/models/price_update_params.rb +9 -9
- data/lib/orb/models/prices/external_price_id_fetch_params.rb +3 -8
- data/lib/orb/models/prices/external_price_id_update_params.rb +9 -9
- data/lib/orb/models/subscription.rb +360 -405
- data/lib/orb/models/subscription_cancel_params.rb +16 -16
- data/lib/orb/models/subscription_cancel_response.rb +358 -399
- data/lib/orb/models/subscription_change_apply_params.rb +7 -10
- data/lib/orb/models/subscription_change_apply_response.rb +384 -418
- data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
- data/lib/orb/models/subscription_change_cancel_response.rb +384 -417
- data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
- data/lib/orb/models/subscription_change_retrieve_response.rb +385 -417
- data/lib/orb/models/subscription_create_params.rb +4735 -5417
- data/lib/orb/models/subscription_create_response.rb +358 -399
- data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
- data/lib/orb/models/subscription_fetch_costs_response.rb +23 -27
- data/lib/orb/models/subscription_fetch_params.rb +3 -8
- data/lib/orb/models/subscription_fetch_schedule_params.rb +20 -30
- data/lib/orb/models/subscription_fetch_schedule_response.rb +15 -17
- data/lib/orb/models/subscription_fetch_usage_params.rb +32 -43
- data/lib/orb/models/subscription_list_params.rb +28 -41
- data/lib/orb/models/subscription_price_intervals_params.rb +2560 -3040
- data/lib/orb/models/subscription_price_intervals_response.rb +361 -399
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +4728 -5411
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +361 -398
- data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
- data/lib/orb/models/subscription_trigger_phase_response.rb +360 -399
- data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +361 -398
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +5 -9
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +362 -396
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +362 -396
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +22 -33
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +361 -398
- data/lib/orb/models/subscription_update_params.rb +21 -23
- data/lib/orb/models/subscription_update_trial_params.rb +15 -18
- data/lib/orb/models/subscription_update_trial_response.rb +360 -399
- data/lib/orb/models/subscription_usage.rb +37 -80
- data/lib/orb/models/subscriptions.rb +3 -7
- data/lib/orb/models/top_level_ping_params.rb +3 -8
- data/lib/orb/models/top_level_ping_response.rb +2 -6
- data/lib/orb/models/trial_discount.rb +16 -24
- data/lib/orb/models/usage_discount.rb +15 -14
- data/lib/orb/models.rb +220 -0
- data/lib/orb/request_options.rb +4 -6
- data/lib/orb/resources/alerts.rb +48 -17
- data/lib/orb/resources/coupons/subscriptions.rb +9 -2
- data/lib/orb/resources/coupons.rb +26 -8
- data/lib/orb/resources/credit_notes.rb +17 -4
- data/lib/orb/resources/customers/balance_transactions.rb +18 -3
- data/lib/orb/resources/customers/costs.rb +26 -8
- data/lib/orb/resources/customers/credits/ledger.rb +112 -32
- data/lib/orb/resources/customers/credits/top_ups.rb +67 -20
- data/lib/orb/resources/customers/credits.rb +28 -8
- data/lib/orb/resources/customers.rb +138 -39
- data/lib/orb/resources/dimensional_price_groups.rb +19 -4
- data/lib/orb/resources/events/backfills.rb +32 -9
- data/lib/orb/resources/events/volume.rb +14 -4
- data/lib/orb/resources/events.rb +40 -11
- data/lib/orb/resources/invoice_line_items.rb +16 -6
- data/lib/orb/resources/invoices.rb +77 -17
- data/lib/orb/resources/items.rb +10 -3
- data/lib/orb/resources/metrics.rb +33 -8
- data/lib/orb/resources/plans/external_plan_id.rb +10 -2
- data/lib/orb/resources/plans.rb +47 -11
- data/lib/orb/resources/prices/external_price_id.rb +9 -3
- data/lib/orb/resources/prices.rb +101 -26
- data/lib/orb/resources/subscription_changes.rb +5 -2
- data/lib/orb/resources/subscriptions.rb +292 -78
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +2 -10
- data/rbi/{lib/orb → orb}/client.rbi +4 -4
- data/rbi/{lib/orb → orb}/errors.rbi +1 -1
- data/rbi/orb/file_part.rbi +34 -0
- data/rbi/{lib/orb → orb}/internal/transport/base_client.rbi +19 -5
- data/rbi/{lib/orb → orb}/internal/type/array_of.rbi +3 -0
- data/rbi/{lib/orb → orb}/internal/type/base_model.rbi +7 -1
- data/rbi/{lib/orb → orb}/internal/type/base_page.rbi +2 -0
- data/rbi/{lib/orb → orb}/internal/type/enum.rbi +3 -6
- data/rbi/{lib/orb/internal/type/io_like.rbi → orb/internal/type/file_input.rbi} +5 -2
- data/rbi/{lib/orb → orb}/internal/type/hash_of.rbi +3 -0
- data/rbi/{lib/orb → orb}/internal/type/request_parameters.rbi +1 -1
- data/rbi/{lib/orb → orb}/internal/type/union.rbi +3 -0
- data/rbi/{lib/orb → orb}/internal/util.rbi +28 -19
- data/rbi/{lib/orb → orb}/internal.rbi +0 -1
- data/rbi/{lib/orb → orb}/models/alert.rbi +28 -8
- data/rbi/{lib/orb → orb}/models/alert_create_for_customer_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/alert_create_for_external_customer_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/alert_create_for_subscription_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/alert_disable_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/alert_enable_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/alert_list_params.rbi +6 -0
- data/rbi/{lib/orb → orb}/models/alert_update_params.rbi +11 -4
- data/rbi/{lib/orb → orb}/models/amount_discount.rbi +10 -4
- data/rbi/{lib/orb → orb}/models/billable_metric.rbi +16 -3
- data/rbi/{lib/orb → orb}/models/billing_cycle_relative_date.rbi +1 -1
- data/rbi/{lib/orb → orb}/models/coupon.rbi +10 -3
- data/rbi/{lib/orb → orb}/models/coupon_create_params.rbi +15 -12
- data/rbi/{lib/orb → orb}/models/coupon_list_params.rbi +13 -3
- data/rbi/{lib/orb → orb}/models/coupons/subscription_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/credit_note.rbi +44 -12
- data/rbi/{lib/orb → orb}/models/credit_note_create_params.rbi +15 -6
- data/rbi/{lib/orb → orb}/models/credit_note_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/customer.rbi +130 -11
- data/rbi/{lib/orb → orb}/models/customer_create_params.rbi +151 -17
- data/rbi/{lib/orb → orb}/models/customer_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/customer_update_by_external_id_params.rbi +149 -17
- data/rbi/{lib/orb → orb}/models/customer_update_params.rbi +149 -17
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_params.rbi +8 -4
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_response.rbi +18 -8
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_response.rbi +18 -8
- data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_params.rbi +9 -5
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +225 -0
- data/rbi/{lib/orb → orb}/models/customers/cost_list_params.rbi +9 -5
- data/rbi/orb/models/customers/cost_list_response.rbi +223 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_params.rbi +13 -3
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_response.rbi +1 -2
- data/rbi/{lib/orb → orb}/models/customers/credit_list_params.rbi +13 -3
- data/rbi/{lib/orb → orb}/models/customers/credit_list_response.rbi +1 -2
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_response.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi} +157 -170
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_params.rbi +40 -6
- data/rbi/{lib/orb/models/customers/credits/ledger_list_response.rbi → orb/models/customers/credits/ledger_create_entry_response.rbi} +149 -196
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_response.rbi +148 -229
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_params.rbi +6 -4
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi → orb/models/customers/credits/ledger_list_response.rbi} +149 -343
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_params.rbi +27 -4
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_response.rbi +25 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_response.rbi +25 -4
- data/rbi/{lib/orb → orb}/models/dimensional_price_group.rbi +11 -3
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_create_params.rbi +4 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/evaluate_price_group.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/event_deprecate_response.rbi +4 -2
- data/rbi/{lib/orb → orb}/models/event_ingest_params.rbi +22 -5
- data/rbi/{lib/orb → orb}/models/event_ingest_response.rbi +15 -4
- data/rbi/{lib/orb → orb}/models/event_search_params.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/event_search_response.rbi +14 -3
- data/rbi/{lib/orb → orb}/models/event_update_params.rbi +10 -3
- data/rbi/{lib/orb → orb}/models/event_update_response.rbi +4 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_close_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_create_params.rbi +18 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_create_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_fetch_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_list_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_revert_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/event_volumes.rbi +8 -4
- data/rbi/{lib/orb → orb}/models/events/volume_list_params.rbi +18 -2
- data/rbi/{lib/orb → orb}/models/invoice.rbi +513 -202
- data/rbi/{lib/orb → orb}/models/invoice_create_params.rbi +38 -6
- data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_response.rbi +513 -216
- data/rbi/{lib/orb → orb}/models/invoice_issue_params.rbi +9 -2
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_params.rbi +16 -2
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_response.rbi +279 -182
- data/rbi/{lib/orb → orb}/models/invoice_list_params.rbi +9 -2
- data/rbi/{lib/orb → orb}/models/invoice_mark_paid_params.rbi +9 -2
- data/rbi/{lib/orb → orb}/models/invoice_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/item.rbi +1 -2
- data/rbi/{lib/orb → orb}/models/item_create_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/item_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/item_update_params.rbi +1 -8
- data/rbi/{lib/orb → orb}/models/metric_create_params.rbi +15 -2
- data/rbi/{lib/orb → orb}/models/metric_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/metric_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/percentage_discount.rbi +11 -4
- data/rbi/{lib/orb → orb}/models/plan.rbi +207 -120
- data/rbi/{lib/orb → orb}/models/plan_create_params.rbi +1971 -2414
- data/rbi/{lib/orb → orb}/models/plan_list_params.rbi +5 -1
- data/rbi/{lib/orb → orb}/models/plan_update_params.rbi +11 -2
- data/rbi/{lib/orb → orb}/models/plans/external_plan_id_update_params.rbi +11 -2
- data/rbi/{lib/orb → orb}/models/price.rbi +2594 -2957
- data/rbi/{lib/orb → orb}/models/price_create_params.rbi +137 -53
- data/rbi/{lib/orb → orb}/models/price_evaluate_params.rbi +10 -0
- data/rbi/{lib/orb → orb}/models/price_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/price_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/prices/external_price_id_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/subscription.rbi +292 -129
- data/rbi/{lib/orb → orb}/models/subscription_cancel_params.rbi +8 -5
- data/rbi/{lib/orb → orb}/models/subscription_cancel_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_response.rbi +317 -136
- data/rbi/{lib/orb → orb}/models/subscription_change_cancel_response.rbi +317 -136
- data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_response.rbi +317 -136
- data/rbi/{lib/orb → orb}/models/subscription_create_params.rbi +4271 -4270
- data/rbi/{lib/orb → orb}/models/subscription_create_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_params.rbi +9 -5
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +221 -0
- data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_response.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/subscription_fetch_usage_params.rbi +13 -4
- data/rbi/{lib/orb → orb}/models/subscription_list_params.rbi +4 -2
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_params.rbi +2354 -2317
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_params.rbi +4280 -3758
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_params.rbi +10 -2
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +305 -138
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_update_params.rbi +15 -0
- data/rbi/{lib/orb → orb}/models/subscription_update_trial_params.rbi +11 -5
- data/rbi/{lib/orb → orb}/models/subscription_update_trial_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_usage.rbi +2 -16
- data/rbi/{lib/orb → orb}/models/trial_discount.rbi +5 -1
- data/rbi/{lib/orb → orb}/models/usage_discount.rbi +11 -3
- data/rbi/orb/models.rbi +220 -0
- data/rbi/{lib/orb → orb}/request_options.rbi +2 -0
- data/rbi/{lib/orb → orb}/resources/alerts.rbi +8 -14
- data/rbi/{lib/orb → orb}/resources/coupons/subscriptions.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/coupons.rbi +6 -18
- data/rbi/{lib/orb → orb}/resources/credit_notes.rbi +3 -9
- data/rbi/{lib/orb → orb}/resources/customers/balance_transactions.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers/costs.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers/credits/ledger.rbi +32 -32
- data/rbi/{lib/orb → orb}/resources/customers/credits/top_ups.rbi +6 -18
- data/rbi/{lib/orb → orb}/resources/customers/credits.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers.rbi +15 -45
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +1 -4
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups.rbi +3 -10
- data/rbi/{lib/orb → orb}/resources/events/backfills.rbi +5 -18
- data/rbi/{lib/orb → orb}/resources/events/volume.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/events.rbi +4 -10
- data/rbi/{lib/orb → orb}/resources/invoice_line_items.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/invoices.rbi +9 -34
- data/rbi/{lib/orb → orb}/resources/items.rbi +4 -17
- data/rbi/{lib/orb → orb}/resources/metrics.rbi +4 -10
- data/rbi/{lib/orb → orb}/resources/plans/external_plan_id.rbi +2 -8
- data/rbi/{lib/orb → orb}/resources/plans.rbi +29 -35
- data/rbi/orb/resources/prices/external_price_id.rbi +103 -0
- data/rbi/{lib/orb → orb}/resources/prices.rbi +117 -124
- data/rbi/{lib/orb → orb}/resources/subscription_changes.rbi +3 -9
- data/rbi/{lib/orb → orb}/resources/subscriptions.rbi +16 -32
- data/rbi/{lib/orb → orb}/resources/top_level.rbi +1 -4
- data/sig/orb/file_part.rbs +21 -0
- data/sig/orb/internal/transport/base_client.rbs +9 -3
- data/sig/orb/internal/type/array_of.rbs +2 -0
- data/sig/orb/internal/type/base_model.rbs +4 -0
- data/sig/orb/internal/type/enum.rbs +2 -2
- data/sig/orb/internal/type/{io_like.rbs → file_input.rbs} +1 -1
- data/sig/orb/internal/type/hash_of.rbs +2 -0
- data/sig/orb/internal/type/union.rbs +2 -0
- data/sig/orb/internal/util.rbs +16 -12
- data/sig/orb/models/coupon_create_params.rbs +9 -10
- data/sig/orb/models/customer_create_params.rbs +9 -10
- data/sig/orb/models/customer_update_by_external_id_params.rbs +9 -10
- data/sig/orb/models/customer_update_params.rbs +9 -10
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +113 -113
- data/sig/orb/models/invoice.rbs +54 -54
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +54 -54
- data/sig/orb/models/invoice_line_item_create_response.rbs +54 -54
- data/sig/orb/models/plan.rbs +21 -21
- data/sig/orb/models/plan_create_params.rbs +653 -653
- data/sig/orb/models/price.rbs +1517 -1521
- data/sig/orb/models/subscription.rbs +34 -34
- data/sig/orb/models/subscription_cancel_response.rbs +34 -34
- data/sig/orb/models/subscription_change_apply_response.rbs +34 -34
- data/sig/orb/models/subscription_change_cancel_response.rbs +34 -34
- data/sig/orb/models/subscription_change_retrieve_response.rbs +34 -34
- data/sig/orb/models/subscription_create_params.rbs +1348 -1348
- data/sig/orb/models/subscription_create_response.rbs +34 -34
- data/sig/orb/models/subscription_price_intervals_params.rbs +767 -769
- data/sig/orb/models/subscription_price_intervals_response.rbs +34 -34
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1348 -1348
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +34 -34
- data/sig/orb/models/subscription_trigger_phase_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +34 -34
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +34 -34
- data/sig/orb/models/subscription_update_trial_response.rbs +34 -34
- data/sig/orb/models.rbs +215 -0
- metadata +230 -224
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +0 -208
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +0 -206
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +0 -204
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +0 -106
- /data/rbi/{lib/orb → orb}/internal/page.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/transport/pooled_net_requester.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/type/boolean.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/type/converter.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/type/unknown.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/alert_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/coupon_archive_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/coupon_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/credit_note_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_delete_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_fetch_by_external_id_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_by_external_id_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/dimensional_price_group_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/dimensional_price_groups.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/event_deprecate_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/events/backfill_close_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/events/backfill_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/events/backfill_revert_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_level_discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_pay_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_void_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/metric_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/pagination_metadata.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plan_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plans/external_plan_id_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_evaluate_response.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/prices/external_price_id_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_change_cancel_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscriptions.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/top_level_ping_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/top_level_ping_response.rbi +0 -0
- /data/rbi/{lib/orb → orb}/version.rbi +0 -0
@@ -13,32 +13,32 @@ module Orb
|
|
13
13
|
name: String,
|
14
14
|
prices: T::Array[
|
15
15
|
T.any(
|
16
|
-
Orb::Models::PlanCreateParams::Price::
|
16
|
+
Orb::Models::PlanCreateParams::Price::Unit,
|
17
17
|
Orb::Internal::AnyHash,
|
18
|
-
Orb::Models::PlanCreateParams::Price::
|
19
|
-
Orb::Models::PlanCreateParams::Price::
|
20
|
-
Orb::Models::PlanCreateParams::Price::
|
21
|
-
Orb::Models::PlanCreateParams::Price::
|
22
|
-
Orb::Models::PlanCreateParams::Price::
|
23
|
-
Orb::Models::PlanCreateParams::Price::
|
24
|
-
Orb::Models::PlanCreateParams::Price::
|
25
|
-
Orb::Models::PlanCreateParams::Price::
|
26
|
-
Orb::Models::PlanCreateParams::Price::
|
27
|
-
Orb::Models::PlanCreateParams::Price::
|
28
|
-
Orb::Models::PlanCreateParams::Price::
|
29
|
-
Orb::Models::PlanCreateParams::Price::
|
30
|
-
Orb::Models::PlanCreateParams::Price::
|
31
|
-
Orb::Models::PlanCreateParams::Price::
|
32
|
-
Orb::Models::PlanCreateParams::Price::
|
33
|
-
Orb::Models::PlanCreateParams::Price::
|
34
|
-
Orb::Models::PlanCreateParams::Price::
|
35
|
-
Orb::Models::PlanCreateParams::Price::
|
36
|
-
Orb::Models::PlanCreateParams::Price::
|
37
|
-
Orb::Models::PlanCreateParams::Price::
|
38
|
-
Orb::Models::PlanCreateParams::Price::
|
39
|
-
Orb::Models::PlanCreateParams::Price::
|
40
|
-
Orb::Models::PlanCreateParams::Price::
|
41
|
-
Orb::Models::PlanCreateParams::Price::
|
18
|
+
Orb::Models::PlanCreateParams::Price::Package,
|
19
|
+
Orb::Models::PlanCreateParams::Price::Matrix,
|
20
|
+
Orb::Models::PlanCreateParams::Price::Tiered,
|
21
|
+
Orb::Models::PlanCreateParams::Price::TieredBps,
|
22
|
+
Orb::Models::PlanCreateParams::Price::Bps,
|
23
|
+
Orb::Models::PlanCreateParams::Price::BulkBps,
|
24
|
+
Orb::Models::PlanCreateParams::Price::Bulk,
|
25
|
+
Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount,
|
26
|
+
Orb::Models::PlanCreateParams::Price::TieredPackage,
|
27
|
+
Orb::Models::PlanCreateParams::Price::TieredWithMinimum,
|
28
|
+
Orb::Models::PlanCreateParams::Price::UnitWithPercent,
|
29
|
+
Orb::Models::PlanCreateParams::Price::PackageWithAllocation,
|
30
|
+
Orb::Models::PlanCreateParams::Price::TieredWithProration,
|
31
|
+
Orb::Models::PlanCreateParams::Price::UnitWithProration,
|
32
|
+
Orb::Models::PlanCreateParams::Price::GroupedAllocation,
|
33
|
+
Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum,
|
34
|
+
Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum,
|
35
|
+
Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName,
|
36
|
+
Orb::Models::PlanCreateParams::Price::BulkWithProration,
|
37
|
+
Orb::Models::PlanCreateParams::Price::GroupedTieredPackage,
|
38
|
+
Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage,
|
39
|
+
Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing,
|
40
|
+
Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing,
|
41
|
+
Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk
|
42
42
|
)
|
43
43
|
],
|
44
44
|
default_invoice_memo: T.nilable(String),
|
@@ -46,7 +46,7 @@ module Orb
|
|
46
46
|
metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
|
47
47
|
net_terms: T.nilable(Integer),
|
48
48
|
status: Orb::Models::PlanCreateParams::Status::OrSymbol,
|
49
|
-
request_options:
|
49
|
+
request_options: Orb::RequestOpts
|
50
50
|
)
|
51
51
|
.returns(Orb::Models::Plan)
|
52
52
|
end
|
@@ -83,7 +83,7 @@ module Orb
|
|
83
83
|
plan_id: String,
|
84
84
|
external_plan_id: T.nilable(String),
|
85
85
|
metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
|
86
|
-
request_options:
|
86
|
+
request_options: Orb::RequestOpts
|
87
87
|
)
|
88
88
|
.returns(Orb::Models::Plan)
|
89
89
|
end
|
@@ -113,7 +113,7 @@ module Orb
|
|
113
113
|
cursor: T.nilable(String),
|
114
114
|
limit: Integer,
|
115
115
|
status: Orb::Models::PlanListParams::Status::OrSymbol,
|
116
|
-
request_options:
|
116
|
+
request_options: Orb::RequestOpts
|
117
117
|
)
|
118
118
|
.returns(Orb::Internal::Page[Orb::Models::Plan])
|
119
119
|
end
|
@@ -148,13 +148,7 @@ module Orb
|
|
148
148
|
#
|
149
149
|
# Orb supports plan phases, also known as contract ramps. For plans with phases,
|
150
150
|
# the serialized prices refer to all prices across all phases.
|
151
|
-
sig
|
152
|
-
params(
|
153
|
-
plan_id: String,
|
154
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
155
|
-
)
|
156
|
-
.returns(Orb::Models::Plan)
|
157
|
-
end
|
151
|
+
sig { params(plan_id: String, request_options: Orb::RequestOpts).returns(Orb::Models::Plan) }
|
158
152
|
def fetch(plan_id, request_options: {}); end
|
159
153
|
|
160
154
|
# @api private
|
@@ -0,0 +1,103 @@
|
|
1
|
+
# typed: strong
|
2
|
+
|
3
|
+
module Orb
|
4
|
+
module Resources
|
5
|
+
class Prices
|
6
|
+
class ExternalPriceID
|
7
|
+
# This endpoint allows you to update the `metadata` property on a price. If you
|
8
|
+
# pass null for the metadata value, it will clear any existing metadata for that
|
9
|
+
# price.
|
10
|
+
sig do
|
11
|
+
params(
|
12
|
+
external_price_id: String,
|
13
|
+
metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
|
14
|
+
request_options: Orb::RequestOpts
|
15
|
+
)
|
16
|
+
.returns(
|
17
|
+
T.any(
|
18
|
+
Orb::Models::Price::Unit,
|
19
|
+
Orb::Models::Price::Package,
|
20
|
+
Orb::Models::Price::Matrix,
|
21
|
+
Orb::Models::Price::Tiered,
|
22
|
+
Orb::Models::Price::TieredBps,
|
23
|
+
Orb::Models::Price::Bps,
|
24
|
+
Orb::Models::Price::BulkBps,
|
25
|
+
Orb::Models::Price::Bulk,
|
26
|
+
Orb::Models::Price::ThresholdTotalAmount,
|
27
|
+
Orb::Models::Price::TieredPackage,
|
28
|
+
Orb::Models::Price::GroupedTiered,
|
29
|
+
Orb::Models::Price::TieredWithMinimum,
|
30
|
+
Orb::Models::Price::TieredPackageWithMinimum,
|
31
|
+
Orb::Models::Price::PackageWithAllocation,
|
32
|
+
Orb::Models::Price::UnitWithPercent,
|
33
|
+
Orb::Models::Price::MatrixWithAllocation,
|
34
|
+
Orb::Models::Price::TieredWithProration,
|
35
|
+
Orb::Models::Price::UnitWithProration,
|
36
|
+
Orb::Models::Price::GroupedAllocation,
|
37
|
+
Orb::Models::Price::GroupedWithProratedMinimum,
|
38
|
+
Orb::Models::Price::GroupedWithMeteredMinimum,
|
39
|
+
Orb::Models::Price::MatrixWithDisplayName,
|
40
|
+
Orb::Models::Price::BulkWithProration,
|
41
|
+
Orb::Models::Price::GroupedTieredPackage,
|
42
|
+
Orb::Models::Price::MaxGroupTieredPackage,
|
43
|
+
Orb::Models::Price::ScalableMatrixWithUnitPricing,
|
44
|
+
Orb::Models::Price::ScalableMatrixWithTieredPricing,
|
45
|
+
Orb::Models::Price::CumulativeGroupedBulk
|
46
|
+
)
|
47
|
+
)
|
48
|
+
end
|
49
|
+
def update(
|
50
|
+
external_price_id,
|
51
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
52
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
53
|
+
# by setting `metadata` to `null`.
|
54
|
+
metadata: nil,
|
55
|
+
request_options: {}
|
56
|
+
); end
|
57
|
+
# This endpoint returns a price given an external price id. See the
|
58
|
+
# [price creation API](/api-reference/price/create-price) for more information
|
59
|
+
# about external price aliases.
|
60
|
+
sig do
|
61
|
+
params(external_price_id: String, request_options: Orb::RequestOpts)
|
62
|
+
.returns(
|
63
|
+
T.any(
|
64
|
+
Orb::Models::Price::Unit,
|
65
|
+
Orb::Models::Price::Package,
|
66
|
+
Orb::Models::Price::Matrix,
|
67
|
+
Orb::Models::Price::Tiered,
|
68
|
+
Orb::Models::Price::TieredBps,
|
69
|
+
Orb::Models::Price::Bps,
|
70
|
+
Orb::Models::Price::BulkBps,
|
71
|
+
Orb::Models::Price::Bulk,
|
72
|
+
Orb::Models::Price::ThresholdTotalAmount,
|
73
|
+
Orb::Models::Price::TieredPackage,
|
74
|
+
Orb::Models::Price::GroupedTiered,
|
75
|
+
Orb::Models::Price::TieredWithMinimum,
|
76
|
+
Orb::Models::Price::TieredPackageWithMinimum,
|
77
|
+
Orb::Models::Price::PackageWithAllocation,
|
78
|
+
Orb::Models::Price::UnitWithPercent,
|
79
|
+
Orb::Models::Price::MatrixWithAllocation,
|
80
|
+
Orb::Models::Price::TieredWithProration,
|
81
|
+
Orb::Models::Price::UnitWithProration,
|
82
|
+
Orb::Models::Price::GroupedAllocation,
|
83
|
+
Orb::Models::Price::GroupedWithProratedMinimum,
|
84
|
+
Orb::Models::Price::GroupedWithMeteredMinimum,
|
85
|
+
Orb::Models::Price::MatrixWithDisplayName,
|
86
|
+
Orb::Models::Price::BulkWithProration,
|
87
|
+
Orb::Models::Price::GroupedTieredPackage,
|
88
|
+
Orb::Models::Price::MaxGroupTieredPackage,
|
89
|
+
Orb::Models::Price::ScalableMatrixWithUnitPricing,
|
90
|
+
Orb::Models::Price::ScalableMatrixWithTieredPricing,
|
91
|
+
Orb::Models::Price::CumulativeGroupedBulk
|
92
|
+
)
|
93
|
+
)
|
94
|
+
end
|
95
|
+
def fetch(external_price_id, request_options: {}); end
|
96
|
+
|
97
|
+
# @api private
|
98
|
+
sig { params(client: Orb::Client).returns(T.attached_class) }
|
99
|
+
def self.new(client:); end
|
100
|
+
end
|
101
|
+
end
|
102
|
+
end
|
103
|
+
end
|
@@ -60,38 +60,38 @@ module Orb
|
|
60
60
|
invoice_grouping_key: T.nilable(String),
|
61
61
|
invoicing_cycle_configuration: T.nilable(T.any(Orb::Models::PriceCreateParams::InvoicingCycleConfiguration, Orb::Internal::AnyHash)),
|
62
62
|
metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
|
63
|
-
request_options:
|
63
|
+
request_options: Orb::RequestOpts
|
64
64
|
)
|
65
65
|
.returns(
|
66
66
|
T.any(
|
67
|
-
Orb::Models::Price::
|
68
|
-
Orb::Models::Price::
|
69
|
-
Orb::Models::Price::
|
70
|
-
Orb::Models::Price::
|
71
|
-
Orb::Models::Price::
|
72
|
-
Orb::Models::Price::
|
73
|
-
Orb::Models::Price::
|
74
|
-
Orb::Models::Price::
|
75
|
-
Orb::Models::Price::
|
76
|
-
Orb::Models::Price::
|
77
|
-
Orb::Models::Price::
|
78
|
-
Orb::Models::Price::
|
79
|
-
Orb::Models::Price::
|
80
|
-
Orb::Models::Price::
|
81
|
-
Orb::Models::Price::
|
82
|
-
Orb::Models::Price::
|
83
|
-
Orb::Models::Price::
|
84
|
-
Orb::Models::Price::
|
85
|
-
Orb::Models::Price::
|
86
|
-
Orb::Models::Price::
|
87
|
-
Orb::Models::Price::
|
88
|
-
Orb::Models::Price::
|
89
|
-
Orb::Models::Price::
|
90
|
-
Orb::Models::Price::
|
91
|
-
Orb::Models::Price::
|
92
|
-
Orb::Models::Price::
|
93
|
-
Orb::Models::Price::
|
94
|
-
Orb::Models::Price::
|
67
|
+
Orb::Models::Price::Unit,
|
68
|
+
Orb::Models::Price::Package,
|
69
|
+
Orb::Models::Price::Matrix,
|
70
|
+
Orb::Models::Price::Tiered,
|
71
|
+
Orb::Models::Price::TieredBps,
|
72
|
+
Orb::Models::Price::Bps,
|
73
|
+
Orb::Models::Price::BulkBps,
|
74
|
+
Orb::Models::Price::Bulk,
|
75
|
+
Orb::Models::Price::ThresholdTotalAmount,
|
76
|
+
Orb::Models::Price::TieredPackage,
|
77
|
+
Orb::Models::Price::GroupedTiered,
|
78
|
+
Orb::Models::Price::TieredWithMinimum,
|
79
|
+
Orb::Models::Price::TieredPackageWithMinimum,
|
80
|
+
Orb::Models::Price::PackageWithAllocation,
|
81
|
+
Orb::Models::Price::UnitWithPercent,
|
82
|
+
Orb::Models::Price::MatrixWithAllocation,
|
83
|
+
Orb::Models::Price::TieredWithProration,
|
84
|
+
Orb::Models::Price::UnitWithProration,
|
85
|
+
Orb::Models::Price::GroupedAllocation,
|
86
|
+
Orb::Models::Price::GroupedWithProratedMinimum,
|
87
|
+
Orb::Models::Price::GroupedWithMeteredMinimum,
|
88
|
+
Orb::Models::Price::MatrixWithDisplayName,
|
89
|
+
Orb::Models::Price::BulkWithProration,
|
90
|
+
Orb::Models::Price::GroupedTieredPackage,
|
91
|
+
Orb::Models::Price::MaxGroupTieredPackage,
|
92
|
+
Orb::Models::Price::ScalableMatrixWithUnitPricing,
|
93
|
+
Orb::Models::Price::ScalableMatrixWithTieredPricing,
|
94
|
+
Orb::Models::Price::CumulativeGroupedBulk
|
95
95
|
)
|
96
96
|
)
|
97
97
|
end
|
@@ -167,38 +167,38 @@ module Orb
|
|
167
167
|
params(
|
168
168
|
price_id: String,
|
169
169
|
metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
|
170
|
-
request_options:
|
170
|
+
request_options: Orb::RequestOpts
|
171
171
|
)
|
172
172
|
.returns(
|
173
173
|
T.any(
|
174
|
-
Orb::Models::Price::
|
175
|
-
Orb::Models::Price::
|
176
|
-
Orb::Models::Price::
|
177
|
-
Orb::Models::Price::
|
178
|
-
Orb::Models::Price::
|
179
|
-
Orb::Models::Price::
|
180
|
-
Orb::Models::Price::
|
181
|
-
Orb::Models::Price::
|
182
|
-
Orb::Models::Price::
|
183
|
-
Orb::Models::Price::
|
184
|
-
Orb::Models::Price::
|
185
|
-
Orb::Models::Price::
|
186
|
-
Orb::Models::Price::
|
187
|
-
Orb::Models::Price::
|
188
|
-
Orb::Models::Price::
|
189
|
-
Orb::Models::Price::
|
190
|
-
Orb::Models::Price::
|
191
|
-
Orb::Models::Price::
|
192
|
-
Orb::Models::Price::
|
193
|
-
Orb::Models::Price::
|
194
|
-
Orb::Models::Price::
|
195
|
-
Orb::Models::Price::
|
196
|
-
Orb::Models::Price::
|
197
|
-
Orb::Models::Price::
|
198
|
-
Orb::Models::Price::
|
199
|
-
Orb::Models::Price::
|
200
|
-
Orb::Models::Price::
|
201
|
-
Orb::Models::Price::
|
174
|
+
Orb::Models::Price::Unit,
|
175
|
+
Orb::Models::Price::Package,
|
176
|
+
Orb::Models::Price::Matrix,
|
177
|
+
Orb::Models::Price::Tiered,
|
178
|
+
Orb::Models::Price::TieredBps,
|
179
|
+
Orb::Models::Price::Bps,
|
180
|
+
Orb::Models::Price::BulkBps,
|
181
|
+
Orb::Models::Price::Bulk,
|
182
|
+
Orb::Models::Price::ThresholdTotalAmount,
|
183
|
+
Orb::Models::Price::TieredPackage,
|
184
|
+
Orb::Models::Price::GroupedTiered,
|
185
|
+
Orb::Models::Price::TieredWithMinimum,
|
186
|
+
Orb::Models::Price::TieredPackageWithMinimum,
|
187
|
+
Orb::Models::Price::PackageWithAllocation,
|
188
|
+
Orb::Models::Price::UnitWithPercent,
|
189
|
+
Orb::Models::Price::MatrixWithAllocation,
|
190
|
+
Orb::Models::Price::TieredWithProration,
|
191
|
+
Orb::Models::Price::UnitWithProration,
|
192
|
+
Orb::Models::Price::GroupedAllocation,
|
193
|
+
Orb::Models::Price::GroupedWithProratedMinimum,
|
194
|
+
Orb::Models::Price::GroupedWithMeteredMinimum,
|
195
|
+
Orb::Models::Price::MatrixWithDisplayName,
|
196
|
+
Orb::Models::Price::BulkWithProration,
|
197
|
+
Orb::Models::Price::GroupedTieredPackage,
|
198
|
+
Orb::Models::Price::MaxGroupTieredPackage,
|
199
|
+
Orb::Models::Price::ScalableMatrixWithUnitPricing,
|
200
|
+
Orb::Models::Price::ScalableMatrixWithTieredPricing,
|
201
|
+
Orb::Models::Price::CumulativeGroupedBulk
|
202
202
|
)
|
203
203
|
)
|
204
204
|
end
|
@@ -213,42 +213,38 @@ module Orb
|
|
213
213
|
# This endpoint is used to list all add-on prices created using the
|
214
214
|
# [price creation endpoint](/api-reference/price/create-price).
|
215
215
|
sig do
|
216
|
-
params(
|
217
|
-
cursor: T.nilable(String),
|
218
|
-
limit: Integer,
|
219
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
220
|
-
)
|
216
|
+
params(cursor: T.nilable(String), limit: Integer, request_options: Orb::RequestOpts)
|
221
217
|
.returns(
|
222
218
|
Orb::Internal::Page[
|
223
219
|
T.any(
|
224
|
-
Orb::Models::Price::
|
225
|
-
Orb::Models::Price::
|
226
|
-
Orb::Models::Price::
|
227
|
-
Orb::Models::Price::
|
228
|
-
Orb::Models::Price::
|
229
|
-
Orb::Models::Price::
|
230
|
-
Orb::Models::Price::
|
231
|
-
Orb::Models::Price::
|
232
|
-
Orb::Models::Price::
|
233
|
-
Orb::Models::Price::
|
234
|
-
Orb::Models::Price::
|
235
|
-
Orb::Models::Price::
|
236
|
-
Orb::Models::Price::
|
237
|
-
Orb::Models::Price::
|
238
|
-
Orb::Models::Price::
|
239
|
-
Orb::Models::Price::
|
240
|
-
Orb::Models::Price::
|
241
|
-
Orb::Models::Price::
|
242
|
-
Orb::Models::Price::
|
243
|
-
Orb::Models::Price::
|
244
|
-
Orb::Models::Price::
|
245
|
-
Orb::Models::Price::
|
246
|
-
Orb::Models::Price::
|
247
|
-
Orb::Models::Price::
|
248
|
-
Orb::Models::Price::
|
249
|
-
Orb::Models::Price::
|
250
|
-
Orb::Models::Price::
|
251
|
-
Orb::Models::Price::
|
220
|
+
Orb::Models::Price::Unit,
|
221
|
+
Orb::Models::Price::Package,
|
222
|
+
Orb::Models::Price::Matrix,
|
223
|
+
Orb::Models::Price::Tiered,
|
224
|
+
Orb::Models::Price::TieredBps,
|
225
|
+
Orb::Models::Price::Bps,
|
226
|
+
Orb::Models::Price::BulkBps,
|
227
|
+
Orb::Models::Price::Bulk,
|
228
|
+
Orb::Models::Price::ThresholdTotalAmount,
|
229
|
+
Orb::Models::Price::TieredPackage,
|
230
|
+
Orb::Models::Price::GroupedTiered,
|
231
|
+
Orb::Models::Price::TieredWithMinimum,
|
232
|
+
Orb::Models::Price::TieredPackageWithMinimum,
|
233
|
+
Orb::Models::Price::PackageWithAllocation,
|
234
|
+
Orb::Models::Price::UnitWithPercent,
|
235
|
+
Orb::Models::Price::MatrixWithAllocation,
|
236
|
+
Orb::Models::Price::TieredWithProration,
|
237
|
+
Orb::Models::Price::UnitWithProration,
|
238
|
+
Orb::Models::Price::GroupedAllocation,
|
239
|
+
Orb::Models::Price::GroupedWithProratedMinimum,
|
240
|
+
Orb::Models::Price::GroupedWithMeteredMinimum,
|
241
|
+
Orb::Models::Price::MatrixWithDisplayName,
|
242
|
+
Orb::Models::Price::BulkWithProration,
|
243
|
+
Orb::Models::Price::GroupedTieredPackage,
|
244
|
+
Orb::Models::Price::MaxGroupTieredPackage,
|
245
|
+
Orb::Models::Price::ScalableMatrixWithUnitPricing,
|
246
|
+
Orb::Models::Price::ScalableMatrixWithTieredPricing,
|
247
|
+
Orb::Models::Price::CumulativeGroupedBulk
|
252
248
|
)
|
253
249
|
]
|
254
250
|
)
|
@@ -291,7 +287,7 @@ module Orb
|
|
291
287
|
external_customer_id: T.nilable(String),
|
292
288
|
filter: T.nilable(String),
|
293
289
|
grouping_keys: T::Array[String],
|
294
|
-
request_options:
|
290
|
+
request_options: Orb::RequestOpts
|
295
291
|
)
|
296
292
|
.returns(Orb::Models::PriceEvaluateResponse)
|
297
293
|
end
|
@@ -317,40 +313,37 @@ module Orb
|
|
317
313
|
); end
|
318
314
|
# This endpoint returns a price given an identifier.
|
319
315
|
sig do
|
320
|
-
params(
|
321
|
-
price_id: String,
|
322
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
323
|
-
)
|
316
|
+
params(price_id: String, request_options: Orb::RequestOpts)
|
324
317
|
.returns(
|
325
318
|
T.any(
|
326
|
-
Orb::Models::Price::
|
327
|
-
Orb::Models::Price::
|
328
|
-
Orb::Models::Price::
|
329
|
-
Orb::Models::Price::
|
330
|
-
Orb::Models::Price::
|
331
|
-
Orb::Models::Price::
|
332
|
-
Orb::Models::Price::
|
333
|
-
Orb::Models::Price::
|
334
|
-
Orb::Models::Price::
|
335
|
-
Orb::Models::Price::
|
336
|
-
Orb::Models::Price::
|
337
|
-
Orb::Models::Price::
|
338
|
-
Orb::Models::Price::
|
339
|
-
Orb::Models::Price::
|
340
|
-
Orb::Models::Price::
|
341
|
-
Orb::Models::Price::
|
342
|
-
Orb::Models::Price::
|
343
|
-
Orb::Models::Price::
|
344
|
-
Orb::Models::Price::
|
345
|
-
Orb::Models::Price::
|
346
|
-
Orb::Models::Price::
|
347
|
-
Orb::Models::Price::
|
348
|
-
Orb::Models::Price::
|
349
|
-
Orb::Models::Price::
|
350
|
-
Orb::Models::Price::
|
351
|
-
Orb::Models::Price::
|
352
|
-
Orb::Models::Price::
|
353
|
-
Orb::Models::Price::
|
319
|
+
Orb::Models::Price::Unit,
|
320
|
+
Orb::Models::Price::Package,
|
321
|
+
Orb::Models::Price::Matrix,
|
322
|
+
Orb::Models::Price::Tiered,
|
323
|
+
Orb::Models::Price::TieredBps,
|
324
|
+
Orb::Models::Price::Bps,
|
325
|
+
Orb::Models::Price::BulkBps,
|
326
|
+
Orb::Models::Price::Bulk,
|
327
|
+
Orb::Models::Price::ThresholdTotalAmount,
|
328
|
+
Orb::Models::Price::TieredPackage,
|
329
|
+
Orb::Models::Price::GroupedTiered,
|
330
|
+
Orb::Models::Price::TieredWithMinimum,
|
331
|
+
Orb::Models::Price::TieredPackageWithMinimum,
|
332
|
+
Orb::Models::Price::PackageWithAllocation,
|
333
|
+
Orb::Models::Price::UnitWithPercent,
|
334
|
+
Orb::Models::Price::MatrixWithAllocation,
|
335
|
+
Orb::Models::Price::TieredWithProration,
|
336
|
+
Orb::Models::Price::UnitWithProration,
|
337
|
+
Orb::Models::Price::GroupedAllocation,
|
338
|
+
Orb::Models::Price::GroupedWithProratedMinimum,
|
339
|
+
Orb::Models::Price::GroupedWithMeteredMinimum,
|
340
|
+
Orb::Models::Price::MatrixWithDisplayName,
|
341
|
+
Orb::Models::Price::BulkWithProration,
|
342
|
+
Orb::Models::Price::GroupedTieredPackage,
|
343
|
+
Orb::Models::Price::MaxGroupTieredPackage,
|
344
|
+
Orb::Models::Price::ScalableMatrixWithUnitPricing,
|
345
|
+
Orb::Models::Price::ScalableMatrixWithTieredPricing,
|
346
|
+
Orb::Models::Price::CumulativeGroupedBulk
|
354
347
|
)
|
355
348
|
)
|
356
349
|
end
|
@@ -13,10 +13,7 @@ module Orb
|
|
13
13
|
# ...). The subscription change will be referenced by the
|
14
14
|
# `pending_subscription_change` field in the response.
|
15
15
|
sig do
|
16
|
-
params(
|
17
|
-
subscription_change_id: String,
|
18
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
19
|
-
)
|
16
|
+
params(subscription_change_id: String, request_options: Orb::RequestOpts)
|
20
17
|
.returns(Orb::Models::SubscriptionChangeRetrieveResponse)
|
21
18
|
end
|
22
19
|
def retrieve(subscription_change_id, request_options: {}); end
|
@@ -29,7 +26,7 @@ module Orb
|
|
29
26
|
subscription_change_id: String,
|
30
27
|
description: T.nilable(String),
|
31
28
|
previously_collected_amount: T.nilable(String),
|
32
|
-
request_options:
|
29
|
+
request_options: Orb::RequestOpts
|
33
30
|
)
|
34
31
|
.returns(Orb::Models::SubscriptionChangeApplyResponse)
|
35
32
|
end
|
@@ -45,10 +42,7 @@ module Orb
|
|
45
42
|
# subscription can only have one "pending" change at a time - use this endpoint to
|
46
43
|
# cancel an existing change before creating a new one.
|
47
44
|
sig do
|
48
|
-
params(
|
49
|
-
subscription_change_id: String,
|
50
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
51
|
-
)
|
45
|
+
params(subscription_change_id: String, request_options: Orb::RequestOpts)
|
52
46
|
.returns(Orb::Models::SubscriptionChangeCancelResponse)
|
53
47
|
end
|
54
48
|
def cancel(subscription_change_id, request_options: {}); end
|