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
@@ -23,7 +23,7 @@ module Orb
|
|
23
23
|
active_from: T.nilable(Time),
|
24
24
|
expires_after: T.nilable(Integer),
|
25
25
|
expires_after_unit: T.nilable(Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit::OrSymbol),
|
26
|
-
request_options:
|
26
|
+
request_options: Orb::RequestOpts
|
27
27
|
)
|
28
28
|
.returns(Orb::Models::Customers::Credits::TopUpCreateResponse)
|
29
29
|
end
|
@@ -57,7 +57,7 @@ module Orb
|
|
57
57
|
customer_id: String,
|
58
58
|
cursor: T.nilable(String),
|
59
59
|
limit: Integer,
|
60
|
-
request_options:
|
60
|
+
request_options: Orb::RequestOpts
|
61
61
|
)
|
62
62
|
.returns(Orb::Internal::Page[Orb::Models::Customers::Credits::TopUpListResponse])
|
63
63
|
end
|
@@ -72,14 +72,7 @@ module Orb
|
|
72
72
|
); end
|
73
73
|
# This deactivates the top-up and voids any invoices associated with pending
|
74
74
|
# credit blocks purchased through the top-up.
|
75
|
-
sig
|
76
|
-
params(
|
77
|
-
top_up_id: String,
|
78
|
-
customer_id: String,
|
79
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
80
|
-
)
|
81
|
-
.void
|
82
|
-
end
|
75
|
+
sig { params(top_up_id: String, customer_id: String, request_options: Orb::RequestOpts).void }
|
83
76
|
def delete(top_up_id, customer_id:, request_options: {}); end
|
84
77
|
|
85
78
|
# This endpoint allows you to create a new top-up for a specified customer's
|
@@ -103,7 +96,7 @@ module Orb
|
|
103
96
|
active_from: T.nilable(Time),
|
104
97
|
expires_after: T.nilable(Integer),
|
105
98
|
expires_after_unit: T.nilable(Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit::OrSymbol),
|
106
|
-
request_options:
|
99
|
+
request_options: Orb::RequestOpts
|
107
100
|
)
|
108
101
|
.returns(Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse)
|
109
102
|
end
|
@@ -134,12 +127,7 @@ module Orb
|
|
134
127
|
# This deactivates the top-up and voids any invoices associated with pending
|
135
128
|
# credit blocks purchased through the top-up.
|
136
129
|
sig do
|
137
|
-
params(
|
138
|
-
top_up_id: String,
|
139
|
-
external_customer_id: String,
|
140
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
141
|
-
)
|
142
|
-
.void
|
130
|
+
params(top_up_id: String, external_customer_id: String, request_options: Orb::RequestOpts).void
|
143
131
|
end
|
144
132
|
def delete_by_external_id(top_up_id, external_customer_id:, request_options: {}); end
|
145
133
|
|
@@ -149,7 +137,7 @@ module Orb
|
|
149
137
|
external_customer_id: String,
|
150
138
|
cursor: T.nilable(String),
|
151
139
|
limit: Integer,
|
152
|
-
request_options:
|
140
|
+
request_options: Orb::RequestOpts
|
153
141
|
)
|
154
142
|
.returns(Orb::Internal::Page[Orb::Models::Customers::Credits::TopUpListByExternalIDResponse])
|
155
143
|
end
|
@@ -24,7 +24,7 @@ module Orb
|
|
24
24
|
cursor: T.nilable(String),
|
25
25
|
include_all_blocks: T::Boolean,
|
26
26
|
limit: Integer,
|
27
|
-
request_options:
|
27
|
+
request_options: Orb::RequestOpts
|
28
28
|
)
|
29
29
|
.returns(Orb::Internal::Page[Orb::Models::Customers::CreditListResponse])
|
30
30
|
end
|
@@ -56,7 +56,7 @@ module Orb
|
|
56
56
|
cursor: T.nilable(String),
|
57
57
|
include_all_blocks: T::Boolean,
|
58
58
|
limit: Integer,
|
59
|
-
request_options:
|
59
|
+
request_options: Orb::RequestOpts
|
60
60
|
)
|
61
61
|
.returns(Orb::Internal::Page[Orb::Models::Customers::CreditListByExternalIDResponse])
|
62
62
|
end
|
@@ -43,14 +43,14 @@ module Orb
|
|
43
43
|
shipping_address: T.nilable(T.any(Orb::Models::CustomerCreateParams::ShippingAddress, Orb::Internal::AnyHash)),
|
44
44
|
tax_configuration: T.nilable(
|
45
45
|
T.any(
|
46
|
-
Orb::Models::CustomerCreateParams::TaxConfiguration::
|
46
|
+
Orb::Models::CustomerCreateParams::TaxConfiguration::Avalara,
|
47
47
|
Orb::Internal::AnyHash,
|
48
|
-
Orb::Models::CustomerCreateParams::TaxConfiguration::
|
48
|
+
Orb::Models::CustomerCreateParams::TaxConfiguration::Taxjar
|
49
49
|
)
|
50
50
|
),
|
51
51
|
tax_id: T.nilable(T.any(Orb::Models::CustomerCreateParams::TaxID, Orb::Internal::AnyHash)),
|
52
52
|
timezone: T.nilable(String),
|
53
|
-
request_options:
|
53
|
+
request_options: Orb::RequestOpts
|
54
54
|
)
|
55
55
|
.returns(Orb::Models::Customer)
|
56
56
|
end
|
@@ -231,13 +231,13 @@ module Orb
|
|
231
231
|
shipping_address: T.nilable(T.any(Orb::Models::CustomerUpdateParams::ShippingAddress, Orb::Internal::AnyHash)),
|
232
232
|
tax_configuration: T.nilable(
|
233
233
|
T.any(
|
234
|
-
Orb::Models::CustomerUpdateParams::TaxConfiguration::
|
234
|
+
Orb::Models::CustomerUpdateParams::TaxConfiguration::Avalara,
|
235
235
|
Orb::Internal::AnyHash,
|
236
|
-
Orb::Models::CustomerUpdateParams::TaxConfiguration::
|
236
|
+
Orb::Models::CustomerUpdateParams::TaxConfiguration::Taxjar
|
237
237
|
)
|
238
238
|
),
|
239
239
|
tax_id: T.nilable(T.any(Orb::Models::CustomerUpdateParams::TaxID, Orb::Internal::AnyHash)),
|
240
|
-
request_options:
|
240
|
+
request_options: Orb::RequestOpts
|
241
241
|
)
|
242
242
|
.returns(Orb::Models::Customer)
|
243
243
|
end
|
@@ -405,7 +405,7 @@ module Orb
|
|
405
405
|
created_at_lte: T.nilable(Time),
|
406
406
|
cursor: T.nilable(String),
|
407
407
|
limit: Integer,
|
408
|
-
request_options:
|
408
|
+
request_options: Orb::RequestOpts
|
409
409
|
)
|
410
410
|
.returns(Orb::Internal::Page[Orb::Models::Customer])
|
411
411
|
end
|
@@ -436,13 +436,7 @@ module Orb
|
|
436
436
|
# been fully processed, the customer will not be returned in the API.
|
437
437
|
#
|
438
438
|
# On successful processing, this returns an empty dictionary (`{}`) in the API.
|
439
|
-
sig
|
440
|
-
params(
|
441
|
-
customer_id: String,
|
442
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
443
|
-
)
|
444
|
-
.void
|
445
|
-
end
|
439
|
+
sig { params(customer_id: String, request_options: Orb::RequestOpts).void }
|
446
440
|
def delete(customer_id, request_options: {}); end
|
447
441
|
|
448
442
|
# This endpoint is used to fetch customer details given an identifier. If the
|
@@ -451,13 +445,7 @@ module Orb
|
|
451
445
|
#
|
452
446
|
# See the [Customer resource](/core-concepts#customer) for a full discussion of
|
453
447
|
# the Customer model.
|
454
|
-
sig
|
455
|
-
params(
|
456
|
-
customer_id: String,
|
457
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
458
|
-
)
|
459
|
-
.returns(Orb::Models::Customer)
|
460
|
-
end
|
448
|
+
sig { params(customer_id: String, request_options: Orb::RequestOpts).returns(Orb::Models::Customer) }
|
461
449
|
def fetch(customer_id, request_options: {}); end
|
462
450
|
|
463
451
|
# This endpoint is used to fetch customer details given an `external_customer_id`
|
@@ -465,13 +453,7 @@ module Orb
|
|
465
453
|
#
|
466
454
|
# Note that the resource and semantics of this endpoint exactly mirror
|
467
455
|
# [Get Customer](fetch-customer).
|
468
|
-
sig
|
469
|
-
params(
|
470
|
-
external_customer_id: String,
|
471
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
472
|
-
)
|
473
|
-
.returns(Orb::Models::Customer)
|
474
|
-
end
|
456
|
+
sig { params(external_customer_id: String, request_options: Orb::RequestOpts).returns(Orb::Models::Customer) }
|
475
457
|
def fetch_by_external_id(external_customer_id, request_options: {}); end
|
476
458
|
|
477
459
|
# Sync Orb's payment methods for the customer with their gateway.
|
@@ -480,13 +462,7 @@ module Orb
|
|
480
462
|
# be charged, ensuring that the most up-to-date payment method is charged.
|
481
463
|
#
|
482
464
|
# **Note**: This functionality is currently only available for Stripe.
|
483
|
-
sig
|
484
|
-
params(
|
485
|
-
customer_id: String,
|
486
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
487
|
-
)
|
488
|
-
.void
|
489
|
-
end
|
465
|
+
sig { params(customer_id: String, request_options: Orb::RequestOpts).void }
|
490
466
|
def sync_payment_methods_from_gateway(customer_id, request_options: {}); end
|
491
467
|
|
492
468
|
# Sync Orb's payment methods for the customer with their gateway.
|
@@ -495,13 +471,7 @@ module Orb
|
|
495
471
|
# be charged, ensuring that the most up-to-date payment method is charged.
|
496
472
|
#
|
497
473
|
# **Note**: This functionality is currently only available for Stripe.
|
498
|
-
sig
|
499
|
-
params(
|
500
|
-
external_customer_id: String,
|
501
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
502
|
-
)
|
503
|
-
.void
|
504
|
-
end
|
474
|
+
sig { params(external_customer_id: String, request_options: Orb::RequestOpts).void }
|
505
475
|
def sync_payment_methods_from_gateway_by_external_customer_id(
|
506
476
|
external_customer_id,
|
507
477
|
request_options: {}
|
@@ -536,13 +506,13 @@ module Orb
|
|
536
506
|
shipping_address: T.nilable(T.any(Orb::Models::CustomerUpdateByExternalIDParams::ShippingAddress, Orb::Internal::AnyHash)),
|
537
507
|
tax_configuration: T.nilable(
|
538
508
|
T.any(
|
539
|
-
Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::
|
509
|
+
Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara,
|
540
510
|
Orb::Internal::AnyHash,
|
541
|
-
Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::
|
511
|
+
Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar
|
542
512
|
)
|
543
513
|
),
|
544
514
|
tax_id: T.nilable(T.any(Orb::Models::CustomerUpdateByExternalIDParams::TaxID, Orb::Internal::AnyHash)),
|
545
|
-
request_options:
|
515
|
+
request_options: Orb::RequestOpts
|
546
516
|
)
|
547
517
|
.returns(Orb::Models::Customer)
|
548
518
|
end
|
data/rbi/{lib/orb → orb}/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi
RENAMED
@@ -6,10 +6,7 @@ module Orb
|
|
6
6
|
class ExternalDimensionalPriceGroupID
|
7
7
|
# Fetch dimensional price group by external ID
|
8
8
|
sig do
|
9
|
-
params(
|
10
|
-
external_dimensional_price_group_id: String,
|
11
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
12
|
-
)
|
9
|
+
params(external_dimensional_price_group_id: String, request_options: Orb::RequestOpts)
|
13
10
|
.returns(Orb::Models::DimensionalPriceGroup)
|
14
11
|
end
|
15
12
|
def retrieve(external_dimensional_price_group_id, request_options: {}); end
|
@@ -21,7 +21,7 @@ module Orb
|
|
21
21
|
name: String,
|
22
22
|
external_dimensional_price_group_id: T.nilable(String),
|
23
23
|
metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
|
24
|
-
request_options:
|
24
|
+
request_options: Orb::RequestOpts
|
25
25
|
)
|
26
26
|
.returns(Orb::Models::DimensionalPriceGroup)
|
27
27
|
end
|
@@ -39,21 +39,14 @@ module Orb
|
|
39
39
|
); end
|
40
40
|
# Fetch dimensional price group
|
41
41
|
sig do
|
42
|
-
params(
|
43
|
-
dimensional_price_group_id: String,
|
44
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
45
|
-
)
|
42
|
+
params(dimensional_price_group_id: String, request_options: Orb::RequestOpts)
|
46
43
|
.returns(Orb::Models::DimensionalPriceGroup)
|
47
44
|
end
|
48
45
|
def retrieve(dimensional_price_group_id, request_options: {}); end
|
49
46
|
|
50
47
|
# List dimensional price groups
|
51
48
|
sig do
|
52
|
-
params(
|
53
|
-
cursor: T.nilable(String),
|
54
|
-
limit: Integer,
|
55
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
56
|
-
)
|
49
|
+
params(cursor: T.nilable(String), limit: Integer, request_options: Orb::RequestOpts)
|
57
50
|
.returns(Orb::Internal::Page[Orb::Models::DimensionalPriceGroup])
|
58
51
|
end
|
59
52
|
def list(
|
@@ -50,7 +50,7 @@ module Orb
|
|
50
50
|
deprecation_filter: T.nilable(String),
|
51
51
|
external_customer_id: T.nilable(String),
|
52
52
|
replace_existing_events: T::Boolean,
|
53
|
-
request_options:
|
53
|
+
request_options: Orb::RequestOpts
|
54
54
|
)
|
55
55
|
.returns(Orb::Models::Events::BackfillCreateResponse)
|
56
56
|
end
|
@@ -90,11 +90,7 @@ module Orb
|
|
90
90
|
# retrieve the next page of results if they exist. More information about
|
91
91
|
# pagination can be found in the [Pagination-metadata schema](pagination).
|
92
92
|
sig do
|
93
|
-
params(
|
94
|
-
cursor: T.nilable(String),
|
95
|
-
limit: Integer,
|
96
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
97
|
-
)
|
93
|
+
params(cursor: T.nilable(String), limit: Integer, request_options: Orb::RequestOpts)
|
98
94
|
.returns(Orb::Internal::Page[Orb::Models::Events::BackfillListResponse])
|
99
95
|
end
|
100
96
|
def list(
|
@@ -110,20 +106,14 @@ module Orb
|
|
110
106
|
# and usage graphs. Once all of the updates are complete, the backfill's status
|
111
107
|
# will transition to `reflected`.
|
112
108
|
sig do
|
113
|
-
params(
|
114
|
-
backfill_id: String,
|
115
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
116
|
-
)
|
109
|
+
params(backfill_id: String, request_options: Orb::RequestOpts)
|
117
110
|
.returns(Orb::Models::Events::BackfillCloseResponse)
|
118
111
|
end
|
119
112
|
def close(backfill_id, request_options: {}); end
|
120
113
|
|
121
114
|
# This endpoint is used to fetch a backfill given an identifier.
|
122
115
|
sig do
|
123
|
-
params(
|
124
|
-
backfill_id: String,
|
125
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
126
|
-
)
|
116
|
+
params(backfill_id: String, request_options: Orb::RequestOpts)
|
127
117
|
.returns(Orb::Models::Events::BackfillFetchResponse)
|
128
118
|
end
|
129
119
|
def fetch(backfill_id, request_options: {}); end
|
@@ -136,10 +126,7 @@ module Orb
|
|
136
126
|
# If a backfill is reverted before its closed, no usage will be updated as a
|
137
127
|
# result of the backfill and it will immediately transition to `reverted`.
|
138
128
|
sig do
|
139
|
-
params(
|
140
|
-
backfill_id: String,
|
141
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
142
|
-
)
|
129
|
+
params(backfill_id: String, request_options: Orb::RequestOpts)
|
143
130
|
.returns(Orb::Models::Events::BackfillRevertResponse)
|
144
131
|
end
|
145
132
|
def revert(backfill_id, request_options: {}); end
|
@@ -23,7 +23,7 @@ module Orb
|
|
23
23
|
cursor: T.nilable(String),
|
24
24
|
limit: Integer,
|
25
25
|
timeframe_end: Time,
|
26
|
-
request_options:
|
26
|
+
request_options: Orb::RequestOpts
|
27
27
|
)
|
28
28
|
.returns(Orb::Models::Events::EventVolumes)
|
29
29
|
end
|
@@ -62,7 +62,7 @@ module Orb
|
|
62
62
|
timestamp: Time,
|
63
63
|
customer_id: T.nilable(String),
|
64
64
|
external_customer_id: T.nilable(String),
|
65
|
-
request_options:
|
65
|
+
request_options: Orb::RequestOpts
|
66
66
|
)
|
67
67
|
.returns(Orb::Models::EventUpdateResponse)
|
68
68
|
end
|
@@ -124,13 +124,7 @@ module Orb
|
|
124
124
|
# - By default, no more than 100 events can be deprecated for a single customer in
|
125
125
|
# a 100 day period. For higher volume updates, consider using the
|
126
126
|
# [event backfill](create-backfill) endpoint.
|
127
|
-
sig
|
128
|
-
params(
|
129
|
-
event_id: String,
|
130
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
131
|
-
)
|
132
|
-
.returns(Orb::Models::EventDeprecateResponse)
|
133
|
-
end
|
127
|
+
sig { params(event_id: String, request_options: Orb::RequestOpts).returns(Orb::Models::EventDeprecateResponse) }
|
134
128
|
def deprecate(event_id, request_options: {}); end
|
135
129
|
|
136
130
|
# Orb's event ingestion model and API is designed around two core principles:
|
@@ -342,7 +336,7 @@ module Orb
|
|
342
336
|
events: T::Array[T.any(Orb::Models::EventIngestParams::Event, Orb::Internal::AnyHash)],
|
343
337
|
backfill_id: T.nilable(String),
|
344
338
|
debug: T::Boolean,
|
345
|
-
request_options:
|
339
|
+
request_options: Orb::RequestOpts
|
346
340
|
)
|
347
341
|
.returns(Orb::Models::EventIngestResponse)
|
348
342
|
end
|
@@ -377,7 +371,7 @@ module Orb
|
|
377
371
|
event_ids: T::Array[String],
|
378
372
|
timeframe_end: T.nilable(Time),
|
379
373
|
timeframe_start: T.nilable(Time),
|
380
|
-
request_options:
|
374
|
+
request_options: Orb::RequestOpts
|
381
375
|
)
|
382
376
|
.returns(Orb::Models::EventSearchResponse)
|
383
377
|
end
|
@@ -24,7 +24,7 @@ module Orb
|
|
24
24
|
memo: T.nilable(String),
|
25
25
|
metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
|
26
26
|
will_auto_issue: T::Boolean,
|
27
|
-
request_options:
|
27
|
+
request_options: Orb::RequestOpts
|
28
28
|
)
|
29
29
|
.returns(Orb::Models::Invoice)
|
30
30
|
end
|
@@ -70,7 +70,7 @@ module Orb
|
|
70
70
|
params(
|
71
71
|
invoice_id: String,
|
72
72
|
metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
|
73
|
-
request_options:
|
73
|
+
request_options: Orb::RequestOpts
|
74
74
|
)
|
75
75
|
.returns(Orb::Models::Invoice)
|
76
76
|
end
|
@@ -116,7 +116,7 @@ module Orb
|
|
116
116
|
limit: Integer,
|
117
117
|
status: T.nilable(T::Array[Orb::Models::InvoiceListParams::Status::OrSymbol]),
|
118
118
|
subscription_id: T.nilable(String),
|
119
|
-
request_options:
|
119
|
+
request_options: Orb::RequestOpts
|
120
120
|
)
|
121
121
|
.returns(Orb::Internal::Page[Orb::Models::Invoice])
|
122
122
|
end
|
@@ -151,23 +151,14 @@ module Orb
|
|
151
151
|
); end
|
152
152
|
# This endpoint is used to fetch an [`Invoice`](/core-concepts#invoice) given an
|
153
153
|
# identifier.
|
154
|
-
sig
|
155
|
-
params(
|
156
|
-
invoice_id: String,
|
157
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
158
|
-
)
|
159
|
-
.returns(Orb::Models::Invoice)
|
160
|
-
end
|
154
|
+
sig { params(invoice_id: String, request_options: Orb::RequestOpts).returns(Orb::Models::Invoice) }
|
161
155
|
def fetch(invoice_id, request_options: {}); end
|
162
156
|
|
163
157
|
# This endpoint can be used to fetch the upcoming
|
164
158
|
# [invoice](/core-concepts#invoice) for the current billing period given a
|
165
159
|
# subscription.
|
166
160
|
sig do
|
167
|
-
params(
|
168
|
-
subscription_id: String,
|
169
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
170
|
-
)
|
161
|
+
params(subscription_id: String, request_options: Orb::RequestOpts)
|
171
162
|
.returns(Orb::Models::InvoiceFetchUpcomingResponse)
|
172
163
|
end
|
173
164
|
def fetch_upcoming(subscription_id:, request_options: {}); end
|
@@ -179,11 +170,7 @@ module Orb
|
|
179
170
|
# sending emails, auto-collecting payment, syncing the invoice to external
|
180
171
|
# providers, etc).
|
181
172
|
sig do
|
182
|
-
params(
|
183
|
-
invoice_id: String,
|
184
|
-
synchronous: T::Boolean,
|
185
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
186
|
-
)
|
173
|
+
params(invoice_id: String, synchronous: T::Boolean, request_options: Orb::RequestOpts)
|
187
174
|
.returns(Orb::Models::Invoice)
|
188
175
|
end
|
189
176
|
def issue(
|
@@ -204,7 +191,7 @@ module Orb
|
|
204
191
|
payment_received_date: Date,
|
205
192
|
external_id: T.nilable(String),
|
206
193
|
notes: T.nilable(String),
|
207
|
-
request_options:
|
194
|
+
request_options: Orb::RequestOpts
|
208
195
|
)
|
209
196
|
.returns(Orb::Models::Invoice)
|
210
197
|
end
|
@@ -220,13 +207,7 @@ module Orb
|
|
220
207
|
); end
|
221
208
|
# This endpoint collects payment for an invoice using the customer's default
|
222
209
|
# payment method. This action can only be taken on invoices with status "issued".
|
223
|
-
sig
|
224
|
-
params(
|
225
|
-
invoice_id: String,
|
226
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
227
|
-
)
|
228
|
-
.returns(Orb::Models::Invoice)
|
229
|
-
end
|
210
|
+
sig { params(invoice_id: String, request_options: Orb::RequestOpts).returns(Orb::Models::Invoice) }
|
230
211
|
def pay(invoice_id, request_options: {}); end
|
231
212
|
|
232
213
|
# This endpoint allows an invoice's status to be set the `void` status. This can
|
@@ -240,13 +221,7 @@ module Orb
|
|
240
221
|
# If the invoice was used to purchase a credit block, but the invoice is not yet
|
241
222
|
# paid, the credit block will be voided. If the invoice was created due to a
|
242
223
|
# top-up, the top-up will be disabled.
|
243
|
-
sig
|
244
|
-
params(
|
245
|
-
invoice_id: String,
|
246
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
247
|
-
)
|
248
|
-
.returns(Orb::Models::Invoice)
|
249
|
-
end
|
224
|
+
sig { params(invoice_id: String, request_options: Orb::RequestOpts).returns(Orb::Models::Invoice) }
|
250
225
|
def void(invoice_id, request_options: {}); end
|
251
226
|
|
252
227
|
# @api private
|
@@ -4,10 +4,7 @@ module Orb
|
|
4
4
|
module Resources
|
5
5
|
class Items
|
6
6
|
# This endpoint is used to create an [Item](/core-concepts#item).
|
7
|
-
sig
|
8
|
-
params(name: String, request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash)))
|
9
|
-
.returns(Orb::Models::Item)
|
10
|
-
end
|
7
|
+
sig { params(name: String, request_options: Orb::RequestOpts).returns(Orb::Models::Item) }
|
11
8
|
def create(
|
12
9
|
# The name of the item.
|
13
10
|
name:,
|
@@ -19,7 +16,7 @@ module Orb
|
|
19
16
|
item_id: String,
|
20
17
|
external_connections: T.nilable(T::Array[T.any(Orb::Models::ItemUpdateParams::ExternalConnection, Orb::Internal::AnyHash)]),
|
21
18
|
name: T.nilable(String),
|
22
|
-
request_options:
|
19
|
+
request_options: Orb::RequestOpts
|
23
20
|
)
|
24
21
|
.returns(Orb::Models::Item)
|
25
22
|
end
|
@@ -28,11 +25,7 @@ module Orb
|
|
28
25
|
# This endpoint returns a list of all Items, ordered in descending order by
|
29
26
|
# creation time.
|
30
27
|
sig do
|
31
|
-
params(
|
32
|
-
cursor: T.nilable(String),
|
33
|
-
limit: Integer,
|
34
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
35
|
-
)
|
28
|
+
params(cursor: T.nilable(String), limit: Integer, request_options: Orb::RequestOpts)
|
36
29
|
.returns(Orb::Internal::Page[Orb::Models::Item])
|
37
30
|
end
|
38
31
|
def list(
|
@@ -44,13 +37,7 @@ module Orb
|
|
44
37
|
request_options: {}
|
45
38
|
); end
|
46
39
|
# This endpoint returns an item identified by its item_id.
|
47
|
-
sig
|
48
|
-
params(
|
49
|
-
item_id: String,
|
50
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
51
|
-
)
|
52
|
-
.returns(Orb::Models::Item)
|
53
|
-
end
|
40
|
+
sig { params(item_id: String, request_options: Orb::RequestOpts).returns(Orb::Models::Item) }
|
54
41
|
def fetch(item_id, request_options: {}); end
|
55
42
|
|
56
43
|
# @api private
|
@@ -13,7 +13,7 @@ module Orb
|
|
13
13
|
name: String,
|
14
14
|
sql: String,
|
15
15
|
metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
|
16
|
-
request_options:
|
16
|
+
request_options: Orb::RequestOpts
|
17
17
|
)
|
18
18
|
.returns(Orb::Models::BillableMetric)
|
19
19
|
end
|
@@ -39,7 +39,7 @@ module Orb
|
|
39
39
|
params(
|
40
40
|
metric_id: String,
|
41
41
|
metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
|
42
|
-
request_options:
|
42
|
+
request_options: Orb::RequestOpts
|
43
43
|
)
|
44
44
|
.returns(Orb::Models::BillableMetric)
|
45
45
|
end
|
@@ -62,7 +62,7 @@ module Orb
|
|
62
62
|
created_at_lte: T.nilable(Time),
|
63
63
|
cursor: T.nilable(String),
|
64
64
|
limit: Integer,
|
65
|
-
request_options:
|
65
|
+
request_options: Orb::RequestOpts
|
66
66
|
)
|
67
67
|
.returns(Orb::Internal::Page[Orb::Models::BillableMetric])
|
68
68
|
end
|
@@ -80,13 +80,7 @@ module Orb
|
|
80
80
|
); end
|
81
81
|
# This endpoint is used to list [metrics](/core-concepts#metric). It returns
|
82
82
|
# information about the metrics including its name, description, and item.
|
83
|
-
sig
|
84
|
-
params(
|
85
|
-
metric_id: String,
|
86
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
87
|
-
)
|
88
|
-
.returns(Orb::Models::BillableMetric)
|
89
|
-
end
|
83
|
+
sig { params(metric_id: String, request_options: Orb::RequestOpts).returns(Orb::Models::BillableMetric) }
|
90
84
|
def fetch(metric_id, request_options: {}); end
|
91
85
|
|
92
86
|
# @api private
|
@@ -13,7 +13,7 @@ module Orb
|
|
13
13
|
other_external_plan_id: String,
|
14
14
|
external_plan_id: T.nilable(String),
|
15
15
|
metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
|
16
|
-
request_options:
|
16
|
+
request_options: Orb::RequestOpts
|
17
17
|
)
|
18
18
|
.returns(Orb::Models::Plan)
|
19
19
|
end
|
@@ -45,13 +45,7 @@ module Orb
|
|
45
45
|
# object. The `model_type` field determines the key for the configuration object
|
46
46
|
# that is present. A detailed explanation of price types can be found in the
|
47
47
|
# [Price schema](/core-concepts#plan-and-price). "
|
48
|
-
sig
|
49
|
-
params(
|
50
|
-
external_plan_id: String,
|
51
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
52
|
-
)
|
53
|
-
.returns(Orb::Models::Plan)
|
54
|
-
end
|
48
|
+
sig { params(external_plan_id: String, request_options: Orb::RequestOpts).returns(Orb::Models::Plan) }
|
55
49
|
def fetch(external_plan_id, request_options: {}); end
|
56
50
|
|
57
51
|
# @api private
|