orb-billing 0.3.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 +33 -0
- data/README.md +5 -5
- data/lib/orb/errors.rb +9 -9
- data/lib/orb/internal/page.rb +3 -3
- data/lib/orb/internal/transport/base_client.rb +3 -3
- data/lib/orb/internal/type/base_model.rb +1 -9
- data/lib/orb/internal/type/boolean.rb +10 -11
- data/lib/orb/internal/type/enum.rb +10 -11
- data/lib/orb/internal/type/request_parameters.rb +2 -8
- data/lib/orb/internal/type/unknown.rb +10 -11
- data/lib/orb/internal/util.rb +20 -4
- data/lib/orb/models/coupon_create_params.rb +7 -7
- data/lib/orb/models/customer_create_params.rb +7 -7
- data/lib/orb/models/customer_update_by_external_id_params.rb +7 -9
- data/lib/orb/models/customer_update_params.rb +7 -7
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +2 -2
- data/lib/orb/models/customers/cost_list_response.rb +2 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +106 -107
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +111 -119
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +110 -114
- data/lib/orb/models/customers/credits/ledger_list_response.rb +112 -124
- data/lib/orb/models/invoice.rb +50 -64
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +51 -55
- data/lib/orb/models/invoice_line_item_create_response.rb +54 -57
- data/lib/orb/models/plan.rb +20 -23
- data/lib/orb/models/plan_create_params.rb +635 -670
- data/lib/orb/models/price.rb +1547 -1599
- data/lib/orb/models/subscription.rb +35 -41
- data/lib/orb/models/subscription_cancel_response.rb +33 -36
- data/lib/orb/models/subscription_change_apply_response.rb +31 -32
- data/lib/orb/models/subscription_change_cancel_response.rb +31 -31
- data/lib/orb/models/subscription_change_retrieve_response.rb +31 -31
- data/lib/orb/models/subscription_create_params.rb +1316 -1367
- data/lib/orb/models/subscription_create_response.rb +33 -36
- data/lib/orb/models/subscription_fetch_costs_response.rb +2 -2
- data/lib/orb/models/subscription_price_intervals_params.rb +748 -774
- data/lib/orb/models/subscription_price_intervals_response.rb +32 -35
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +1299 -1354
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +31 -33
- data/lib/orb/models/subscription_trigger_phase_response.rb +32 -35
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +31 -33
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +31 -31
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +31 -31
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +31 -33
- data/lib/orb/models/subscription_update_trial_response.rb +33 -36
- data/lib/orb/models.rb +220 -0
- data/lib/orb/request_options.rb +4 -5
- data/lib/orb/resources/coupons.rb +1 -1
- data/lib/orb/resources/customers/credits/ledger.rb +4 -4
- data/lib/orb/resources/customers.rb +3 -3
- data/lib/orb/resources/plans.rb +1 -1
- data/lib/orb/resources/prices/external_price_id.rb +2 -2
- data/lib/orb/resources/prices.rb +4 -4
- data/lib/orb/version.rb +1 -1
- data/rbi/{lib/orb → orb}/errors.rbi +1 -1
- data/rbi/{lib/orb → orb}/internal/transport/base_client.rbi +2 -2
- data/rbi/{lib/orb → orb}/internal/type/request_parameters.rbi +1 -1
- data/rbi/{lib/orb → orb}/internal/util.rbi +5 -1
- data/rbi/{lib/orb → orb}/models/coupon_create_params.rbi +9 -9
- data/rbi/{lib/orb → orb}/models/customer_create_params.rbi +9 -9
- data/rbi/{lib/orb → orb}/models/customer_update_by_external_id_params.rbi +9 -9
- data/rbi/{lib/orb → orb}/models/customer_update_params.rbi +9 -9
- data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_response.rbi +84 -84
- data/rbi/{lib/orb → orb}/models/customers/cost_list_response.rbi +84 -84
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_response.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi} +122 -114
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi → orb/models/customers/credits/ledger_create_entry_response.rbi} +114 -216
- data/rbi/{lib/orb/models/customers/credits/ledger_list_response.rbi → orb/models/customers/credits/ledger_list_by_external_id_response.rbi} +114 -114
- data/rbi/{lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi → orb/models/customers/credits/ledger_list_response.rbi} +114 -271
- data/rbi/{lib/orb → orb}/models/invoice.rbi +138 -156
- data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_response.rbi +138 -150
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_response.rbi +138 -162
- data/rbi/{lib/orb → orb}/models/plan.rbi +105 -105
- data/rbi/{lib/orb → orb}/models/plan_create_params.rbi +973 -1734
- data/rbi/{lib/orb → orb}/models/price.rbi +1875 -2267
- data/rbi/{lib/orb → orb}/models/subscription.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_cancel_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_change_cancel_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_create_params.rbi +1988 -2733
- data/rbi/{lib/orb → orb}/models/subscription_create_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_response.rbi +84 -84
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_params.rbi +1125 -1455
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_params.rbi +1988 -2210
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_update_trial_response.rbi +118 -118
- 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/internal/util.rbs +2 -0
- 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 +226 -223
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +0 -106
- data/rbi/{lib/orb → orb}/client.rbi +0 -0
- data/rbi/{lib/orb → orb}/file_part.rbi +0 -0
- 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/array_of.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/base_model.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/base_page.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/enum.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/file_input.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/hash_of.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/union.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/unknown.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_create_for_customer_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_create_for_external_customer_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_create_for_subscription_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_disable_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_enable_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_retrieve_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_update_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/amount_discount.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/billable_metric.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/billing_cycle_relative_date.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/coupon.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/coupon_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/coupons/subscription_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/credit_note.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/credit_note_create_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/credit_note_fetch_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/credit_note_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customer.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_list_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/balance_transaction_create_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/cost_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_response.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/customers/credits/top_up_list_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_group.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_create_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_list_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/evaluate_price_group.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_deprecate_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_deprecate_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_ingest_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_ingest_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_search_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_search_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_update_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_update_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_close_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_close_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_create_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_create_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_fetch_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_fetch_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_list_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_revert_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_revert_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/event_volumes.rbi +2 -2
- /data/rbi/{lib/orb → orb}/models/events/volume_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_create_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_issue_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_level_discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_line_item_create_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_mark_paid_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_pay_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_void_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item_create_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/metric_create_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/metric_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/metric_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/metric_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/pagination_metadata.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/percentage_discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plan_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plan_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plan_update_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/plans/external_plan_id_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_create_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_evaluate_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/price_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_update_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/prices/external_price_id_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_cancel_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_change_apply_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_costs_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_response.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_usage_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_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_fixed_fee_quantity_updates_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/subscription_update_fixed_fee_quantity_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_update_trial_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_usage.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}/models/trial_discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/usage_discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/version.rbi +0 -0
@@ -4,13 +4,7 @@ module Orb
|
|
4
4
|
module Resources
|
5
5
|
class Alerts
|
6
6
|
# This endpoint retrieves an alert by its ID.
|
7
|
-
sig
|
8
|
-
params(
|
9
|
-
alert_id: String,
|
10
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
11
|
-
)
|
12
|
-
.returns(Orb::Models::Alert)
|
13
|
-
end
|
7
|
+
sig { params(alert_id: String, request_options: Orb::RequestOpts).returns(Orb::Models::Alert) }
|
14
8
|
def retrieve(alert_id, request_options: {}); end
|
15
9
|
|
16
10
|
# This endpoint updates the thresholds of an alert.
|
@@ -18,7 +12,7 @@ module Orb
|
|
18
12
|
params(
|
19
13
|
alert_configuration_id: String,
|
20
14
|
thresholds: T::Array[T.any(Orb::Models::AlertUpdateParams::Threshold, Orb::Internal::AnyHash)],
|
21
|
-
request_options:
|
15
|
+
request_options: Orb::RequestOpts
|
22
16
|
)
|
23
17
|
.returns(Orb::Models::Alert)
|
24
18
|
end
|
@@ -50,7 +44,7 @@ module Orb
|
|
50
44
|
external_customer_id: T.nilable(String),
|
51
45
|
limit: Integer,
|
52
46
|
subscription_id: T.nilable(String),
|
53
|
-
request_options:
|
47
|
+
request_options: Orb::RequestOpts
|
54
48
|
)
|
55
49
|
.returns(Orb::Internal::Page[Orb::Models::Alert])
|
56
50
|
end
|
@@ -86,7 +80,7 @@ module Orb
|
|
86
80
|
currency: String,
|
87
81
|
type: Orb::Models::AlertCreateForCustomerParams::Type::OrSymbol,
|
88
82
|
thresholds: T.nilable(T::Array[T.any(Orb::Models::AlertCreateForCustomerParams::Threshold, Orb::Internal::AnyHash)]),
|
89
|
-
request_options:
|
83
|
+
request_options: Orb::RequestOpts
|
90
84
|
)
|
91
85
|
.returns(Orb::Models::Alert)
|
92
86
|
end
|
@@ -116,7 +110,7 @@ module Orb
|
|
116
110
|
thresholds: T.nilable(
|
117
111
|
T::Array[T.any(Orb::Models::AlertCreateForExternalCustomerParams::Threshold, Orb::Internal::AnyHash)]
|
118
112
|
),
|
119
|
-
request_options:
|
113
|
+
request_options: Orb::RequestOpts
|
120
114
|
)
|
121
115
|
.returns(Orb::Models::Alert)
|
122
116
|
end
|
@@ -147,7 +141,7 @@ module Orb
|
|
147
141
|
thresholds: T::Array[T.any(Orb::Models::AlertCreateForSubscriptionParams::Threshold, Orb::Internal::AnyHash)],
|
148
142
|
type: Orb::Models::AlertCreateForSubscriptionParams::Type::OrSymbol,
|
149
143
|
metric_id: T.nilable(String),
|
150
|
-
request_options:
|
144
|
+
request_options: Orb::RequestOpts
|
151
145
|
)
|
152
146
|
.returns(Orb::Models::Alert)
|
153
147
|
end
|
@@ -168,7 +162,7 @@ module Orb
|
|
168
162
|
params(
|
169
163
|
alert_configuration_id: String,
|
170
164
|
subscription_id: T.nilable(String),
|
171
|
-
request_options:
|
165
|
+
request_options: Orb::RequestOpts
|
172
166
|
)
|
173
167
|
.returns(Orb::Models::Alert)
|
174
168
|
end
|
@@ -185,7 +179,7 @@ module Orb
|
|
185
179
|
params(
|
186
180
|
alert_configuration_id: String,
|
187
181
|
subscription_id: T.nilable(String),
|
188
|
-
request_options:
|
182
|
+
request_options: Orb::RequestOpts
|
189
183
|
)
|
190
184
|
.returns(Orb::Models::Alert)
|
191
185
|
end
|
@@ -13,7 +13,7 @@ module Orb
|
|
13
13
|
coupon_id: String,
|
14
14
|
cursor: T.nilable(String),
|
15
15
|
limit: Integer,
|
16
|
-
request_options:
|
16
|
+
request_options: Orb::RequestOpts
|
17
17
|
)
|
18
18
|
.returns(Orb::Internal::Page[Orb::Models::Subscription])
|
19
19
|
end
|
@@ -11,14 +11,14 @@ module Orb
|
|
11
11
|
sig do
|
12
12
|
params(
|
13
13
|
discount: T.any(
|
14
|
-
Orb::Models::CouponCreateParams::Discount::
|
14
|
+
Orb::Models::CouponCreateParams::Discount::Percentage,
|
15
15
|
Orb::Internal::AnyHash,
|
16
|
-
Orb::Models::CouponCreateParams::Discount::
|
16
|
+
Orb::Models::CouponCreateParams::Discount::Amount
|
17
17
|
),
|
18
18
|
redemption_code: String,
|
19
19
|
duration_in_months: T.nilable(Integer),
|
20
20
|
max_redemptions: T.nilable(Integer),
|
21
|
-
request_options:
|
21
|
+
request_options: Orb::RequestOpts
|
22
22
|
)
|
23
23
|
.returns(Orb::Models::Coupon)
|
24
24
|
end
|
@@ -46,7 +46,7 @@ module Orb
|
|
46
46
|
limit: Integer,
|
47
47
|
redemption_code: T.nilable(String),
|
48
48
|
show_archived: T.nilable(T::Boolean),
|
49
|
-
request_options:
|
49
|
+
request_options: Orb::RequestOpts
|
50
50
|
)
|
51
51
|
.returns(Orb::Internal::Page[Orb::Models::Coupon])
|
52
52
|
end
|
@@ -66,25 +66,13 @@ module Orb
|
|
66
66
|
# This endpoint allows a coupon to be archived. Archived coupons can no longer be
|
67
67
|
# redeemed, and will be hidden from lists of active coupons. Additionally, once a
|
68
68
|
# coupon is archived, its redemption code can be reused for a different coupon.
|
69
|
-
sig
|
70
|
-
params(
|
71
|
-
coupon_id: String,
|
72
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
73
|
-
)
|
74
|
-
.returns(Orb::Models::Coupon)
|
75
|
-
end
|
69
|
+
sig { params(coupon_id: String, request_options: Orb::RequestOpts).returns(Orb::Models::Coupon) }
|
76
70
|
def archive(coupon_id, request_options: {}); end
|
77
71
|
|
78
72
|
# This endpoint retrieves a coupon by its ID. To fetch coupons by their redemption
|
79
73
|
# code, use the [List coupons](list-coupons) endpoint with the redemption_code
|
80
74
|
# parameter.
|
81
|
-
sig
|
82
|
-
params(
|
83
|
-
coupon_id: String,
|
84
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
85
|
-
)
|
86
|
-
.returns(Orb::Models::Coupon)
|
87
|
-
end
|
75
|
+
sig { params(coupon_id: String, request_options: Orb::RequestOpts).returns(Orb::Models::Coupon) }
|
88
76
|
def fetch(coupon_id, request_options: {}); end
|
89
77
|
|
90
78
|
# @api private
|
@@ -10,7 +10,7 @@ module Orb
|
|
10
10
|
line_items: T::Array[T.any(Orb::Models::CreditNoteCreateParams::LineItem, Orb::Internal::AnyHash)],
|
11
11
|
memo: T.nilable(String),
|
12
12
|
reason: T.nilable(Orb::Models::CreditNoteCreateParams::Reason::OrSymbol),
|
13
|
-
request_options:
|
13
|
+
request_options: Orb::RequestOpts
|
14
14
|
)
|
15
15
|
.returns(Orb::Models::CreditNote)
|
16
16
|
end
|
@@ -33,7 +33,7 @@ module Orb
|
|
33
33
|
created_at_lte: T.nilable(Time),
|
34
34
|
cursor: T.nilable(String),
|
35
35
|
limit: Integer,
|
36
|
-
request_options:
|
36
|
+
request_options: Orb::RequestOpts
|
37
37
|
)
|
38
38
|
.returns(Orb::Internal::Page[Orb::Models::CreditNote])
|
39
39
|
end
|
@@ -51,13 +51,7 @@ module Orb
|
|
51
51
|
); end
|
52
52
|
# This endpoint is used to fetch a single [`Credit Note`](/invoicing/credit-notes)
|
53
53
|
# given an identifier.
|
54
|
-
sig
|
55
|
-
params(
|
56
|
-
credit_note_id: String,
|
57
|
-
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
58
|
-
)
|
59
|
-
.returns(Orb::Models::CreditNote)
|
60
|
-
end
|
54
|
+
sig { params(credit_note_id: String, request_options: Orb::RequestOpts).returns(Orb::Models::CreditNote) }
|
61
55
|
def fetch(credit_note_id, request_options: {}); end
|
62
56
|
|
63
57
|
# @api private
|
@@ -12,7 +12,7 @@ module Orb
|
|
12
12
|
amount: String,
|
13
13
|
type: Orb::Models::Customers::BalanceTransactionCreateParams::Type::OrSymbol,
|
14
14
|
description: T.nilable(String),
|
15
|
-
request_options:
|
15
|
+
request_options: Orb::RequestOpts
|
16
16
|
)
|
17
17
|
.returns(Orb::Models::Customers::BalanceTransactionCreateResponse)
|
18
18
|
end
|
@@ -61,7 +61,7 @@ module Orb
|
|
61
61
|
operation_time_gte: T.nilable(Time),
|
62
62
|
operation_time_lt: T.nilable(Time),
|
63
63
|
operation_time_lte: T.nilable(Time),
|
64
|
-
request_options:
|
64
|
+
request_options: Orb::RequestOpts
|
65
65
|
)
|
66
66
|
.returns(Orb::Internal::Page[Orb::Models::Customers::BalanceTransactionListResponse])
|
67
67
|
end
|
@@ -128,7 +128,7 @@ module Orb
|
|
128
128
|
timeframe_end: T.nilable(Time),
|
129
129
|
timeframe_start: T.nilable(Time),
|
130
130
|
view_mode: T.nilable(Orb::Models::Customers::CostListParams::ViewMode::OrSymbol),
|
131
|
-
request_options:
|
131
|
+
request_options: Orb::RequestOpts
|
132
132
|
)
|
133
133
|
.returns(Orb::Models::Customers::CostListResponse)
|
134
134
|
end
|
@@ -271,7 +271,7 @@ module Orb
|
|
271
271
|
timeframe_end: T.nilable(Time),
|
272
272
|
timeframe_start: T.nilable(Time),
|
273
273
|
view_mode: T.nilable(Orb::Models::Customers::CostListByExternalIDParams::ViewMode::OrSymbol),
|
274
|
-
request_options:
|
274
|
+
request_options: Orb::RequestOpts
|
275
275
|
)
|
276
276
|
.returns(Orb::Models::Customers::CostListByExternalIDResponse)
|
277
277
|
end
|
@@ -99,18 +99,18 @@ module Orb
|
|
99
99
|
entry_type: T.nilable(Orb::Models::Customers::Credits::LedgerListParams::EntryType::OrSymbol),
|
100
100
|
limit: Integer,
|
101
101
|
minimum_amount: T.nilable(String),
|
102
|
-
request_options:
|
102
|
+
request_options: Orb::RequestOpts
|
103
103
|
)
|
104
104
|
.returns(
|
105
105
|
Orb::Internal::Page[
|
106
106
|
T.any(
|
107
|
-
Orb::Models::Customers::Credits::LedgerListResponse::
|
108
|
-
Orb::Models::Customers::Credits::LedgerListResponse::
|
109
|
-
Orb::Models::Customers::Credits::LedgerListResponse::
|
110
|
-
Orb::Models::Customers::Credits::LedgerListResponse::
|
111
|
-
Orb::Models::Customers::Credits::LedgerListResponse::
|
112
|
-
Orb::Models::Customers::Credits::LedgerListResponse::
|
113
|
-
Orb::Models::Customers::Credits::LedgerListResponse::
|
107
|
+
Orb::Models::Customers::Credits::LedgerListResponse::Increment,
|
108
|
+
Orb::Models::Customers::Credits::LedgerListResponse::Decrement,
|
109
|
+
Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChange,
|
110
|
+
Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiry,
|
111
|
+
Orb::Models::Customers::Credits::LedgerListResponse::Void,
|
112
|
+
Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiated,
|
113
|
+
Orb::Models::Customers::Credits::LedgerListResponse::Amendment
|
114
114
|
)
|
115
115
|
]
|
116
116
|
)
|
@@ -260,17 +260,17 @@ module Orb
|
|
260
260
|
metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
|
261
261
|
per_unit_cost_basis: T.nilable(String),
|
262
262
|
void_reason: T.nilable(Orb::Models::Customers::Credits::LedgerCreateEntryParams::VoidReason::OrSymbol),
|
263
|
-
request_options:
|
263
|
+
request_options: Orb::RequestOpts
|
264
264
|
)
|
265
265
|
.returns(
|
266
266
|
T.any(
|
267
|
-
Orb::Models::Customers::Credits::LedgerCreateEntryResponse::
|
268
|
-
Orb::Models::Customers::Credits::LedgerCreateEntryResponse::
|
269
|
-
Orb::Models::Customers::Credits::LedgerCreateEntryResponse::
|
270
|
-
Orb::Models::Customers::Credits::LedgerCreateEntryResponse::
|
271
|
-
Orb::Models::Customers::Credits::LedgerCreateEntryResponse::
|
272
|
-
Orb::Models::Customers::Credits::LedgerCreateEntryResponse::
|
273
|
-
Orb::Models::Customers::Credits::LedgerCreateEntryResponse::
|
267
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Increment,
|
268
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Decrement,
|
269
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChange,
|
270
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiry,
|
271
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Void,
|
272
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiated,
|
273
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Amendment
|
274
274
|
)
|
275
275
|
)
|
276
276
|
end
|
@@ -444,17 +444,17 @@ module Orb
|
|
444
444
|
metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
|
445
445
|
per_unit_cost_basis: T.nilable(String),
|
446
446
|
void_reason: T.nilable(Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason::OrSymbol),
|
447
|
-
request_options:
|
447
|
+
request_options: Orb::RequestOpts
|
448
448
|
)
|
449
449
|
.returns(
|
450
450
|
T.any(
|
451
|
-
Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
452
|
-
Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
453
|
-
Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
454
|
-
Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
455
|
-
Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
456
|
-
Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
457
|
-
Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
451
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Increment,
|
452
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Decrement,
|
453
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChange,
|
454
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiry,
|
455
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Void,
|
456
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiated,
|
457
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Amendment
|
458
458
|
)
|
459
459
|
)
|
460
460
|
end
|
@@ -592,18 +592,18 @@ module Orb
|
|
592
592
|
entry_type: T.nilable(Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryType::OrSymbol),
|
593
593
|
limit: Integer,
|
594
594
|
minimum_amount: T.nilable(String),
|
595
|
-
request_options:
|
595
|
+
request_options: Orb::RequestOpts
|
596
596
|
)
|
597
597
|
.returns(
|
598
598
|
Orb::Internal::Page[
|
599
599
|
T.any(
|
600
|
-
Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
601
|
-
Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
602
|
-
Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
603
|
-
Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
604
|
-
Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
605
|
-
Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
606
|
-
Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
600
|
+
Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Increment,
|
601
|
+
Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Decrement,
|
602
|
+
Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChange,
|
603
|
+
Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiry,
|
604
|
+
Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Void,
|
605
|
+
Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiated,
|
606
|
+
Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Amendment
|
607
607
|
)
|
608
608
|
]
|
609
609
|
)
|
@@ -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
|