orb-billing 0.3.1 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +35 -0
- data/README.md +3 -3
- data/lib/orb/errors.rb +1 -1
- data/lib/orb/file_part.rb +2 -2
- data/lib/orb/internal/transport/base_client.rb +74 -5
- data/lib/orb/internal/transport/pooled_net_requester.rb +14 -0
- data/lib/orb/internal/type/array_of.rb +1 -1
- data/lib/orb/internal/type/base_model.rb +62 -30
- data/lib/orb/internal/type/converter.rb +18 -0
- data/lib/orb/internal/type/enum.rb +4 -3
- data/lib/orb/internal/type/hash_of.rb +1 -1
- data/lib/orb/internal/type/request_parameters.rb +4 -4
- data/lib/orb/internal/type/union.rb +5 -4
- data/lib/orb/internal/util.rb +57 -1
- data/lib/orb/internal.rb +6 -0
- data/lib/orb/models/alert.rb +29 -32
- data/lib/orb/models/alert_create_for_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_external_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_subscription_params.rb +7 -8
- data/lib/orb/models/alert_list_params.rb +0 -1
- data/lib/orb/models/alert_update_params.rb +4 -5
- data/lib/orb/models/amount_discount.rb +6 -7
- data/lib/orb/models/billable_metric.rb +9 -11
- data/lib/orb/models/coupon.rb +13 -12
- data/lib/orb/models/coupon_create_params.rb +12 -8
- data/lib/orb/models/coupon_list_params.rb +0 -2
- data/lib/orb/models/coupons/subscription_list_params.rb +0 -1
- data/lib/orb/models/credit_note.rb +48 -46
- data/lib/orb/models/credit_note_create_params.rb +6 -6
- data/lib/orb/models/credit_note_list_params.rb +0 -1
- data/lib/orb/models/customer.rb +54 -61
- data/lib/orb/models/customer_create_params.rb +50 -53
- data/lib/orb/models/customer_list_params.rb +0 -1
- data/lib/orb/models/customer_update_by_external_id_params.rb +50 -53
- data/lib/orb/models/customer_update_params.rb +50 -51
- data/lib/orb/models/customers/balance_transaction_create_params.rb +3 -3
- data/lib/orb/models/customers/balance_transaction_create_response.rb +0 -2
- data/lib/orb/models/customers/balance_transaction_list_params.rb +0 -1
- data/lib/orb/models/customers/balance_transaction_list_response.rb +0 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -3
- data/lib/orb/models/customers/cost_list_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_response.rb +3 -3
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +0 -2
- data/lib/orb/models/customers/credit_list_params.rb +0 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +12 -21
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +14 -7
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +11 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +14 -7
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +6 -7
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +14 -7
- data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
- data/lib/orb/models/customers/credits/ledger_list_response.rb +14 -7
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +10 -15
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_create_params.rb +7 -15
- data/lib/orb/models/customers/credits/top_up_create_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_response.rb +0 -6
- data/lib/orb/models/dimensional_price_group.rb +1 -3
- data/lib/orb/models/dimensional_price_group_create_params.rb +0 -1
- data/lib/orb/models/dimensional_price_group_list_params.rb +0 -1
- data/lib/orb/models/dimensional_price_groups.rb +6 -6
- data/lib/orb/models/discount.rb +11 -5
- data/lib/orb/models/evaluate_price_group.rb +5 -1
- data/lib/orb/models/event_ingest_params.rb +4 -9
- data/lib/orb/models/event_ingest_response.rb +0 -3
- data/lib/orb/models/event_search_params.rb +0 -3
- data/lib/orb/models/event_search_response.rb +0 -4
- data/lib/orb/models/event_update_params.rb +0 -3
- data/lib/orb/models/events/backfill_close_response.rb +0 -4
- data/lib/orb/models/events/backfill_create_params.rb +0 -7
- data/lib/orb/models/events/backfill_create_response.rb +0 -4
- data/lib/orb/models/events/backfill_fetch_response.rb +0 -4
- data/lib/orb/models/events/backfill_list_params.rb +0 -1
- data/lib/orb/models/events/backfill_list_response.rb +0 -4
- data/lib/orb/models/events/backfill_revert_response.rb +0 -4
- data/lib/orb/models/events/event_volumes.rb +3 -3
- data/lib/orb/models/events/volume_list_params.rb +0 -3
- data/lib/orb/models/invoice.rb +179 -202
- data/lib/orb/models/invoice_create_params.rb +14 -21
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +31 -54
- data/lib/orb/models/invoice_issue_params.rb +0 -1
- data/lib/orb/models/invoice_level_discount.rb +8 -4
- data/lib/orb/models/invoice_line_item_create_params.rb +0 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +28 -26
- data/lib/orb/models/invoice_list_params.rb +6 -10
- data/lib/orb/models/invoice_update_params.rb +0 -1
- data/lib/orb/models/item.rb +7 -8
- data/lib/orb/models/item_list_params.rb +0 -1
- data/lib/orb/models/item_update_params.rb +7 -7
- data/lib/orb/models/metric_create_params.rb +0 -1
- data/lib/orb/models/metric_list_params.rb +0 -1
- data/lib/orb/models/metric_update_params.rb +0 -1
- data/lib/orb/models/percentage_discount.rb +6 -8
- data/lib/orb/models/plan.rb +90 -103
- data/lib/orb/models/plan_create_params.rb +759 -800
- data/lib/orb/models/plan_list_params.rb +3 -4
- data/lib/orb/models/plan_update_params.rb +0 -2
- data/lib/orb/models/plans/external_plan_id_update_params.rb +0 -2
- data/lib/orb/models/price.rb +1706 -1724
- data/lib/orb/models/price_create_params.rb +75 -84
- data/lib/orb/models/price_evaluate_params.rb +0 -2
- data/lib/orb/models/price_evaluate_response.rb +3 -3
- data/lib/orb/models/price_list_params.rb +0 -1
- data/lib/orb/models/price_update_params.rb +0 -1
- data/lib/orb/models/prices/external_price_id_update_params.rb +0 -1
- data/lib/orb/models/subscription.rb +108 -122
- data/lib/orb/models/subscription_cancel_params.rb +3 -5
- data/lib/orb/models/subscription_cancel_response.rb +43 -57
- data/lib/orb/models/subscription_change_apply_response.rb +43 -58
- data/lib/orb/models/subscription_change_cancel_response.rb +43 -58
- data/lib/orb/models/subscription_change_retrieve_response.rb +43 -58
- data/lib/orb/models/subscription_create_params.rb +1953 -1815
- data/lib/orb/models/subscription_create_response.rb +43 -57
- data/lib/orb/models/subscription_fetch_costs_params.rb +3 -4
- data/lib/orb/models/subscription_fetch_costs_response.rb +3 -3
- data/lib/orb/models/subscription_fetch_schedule_params.rb +0 -1
- data/lib/orb/models/subscription_fetch_schedule_response.rb +0 -1
- data/lib/orb/models/subscription_fetch_usage_params.rb +6 -8
- data/lib/orb/models/subscription_list_params.rb +3 -4
- data/lib/orb/models/subscription_price_intervals_params.rb +1194 -1017
- data/lib/orb/models/subscription_price_intervals_response.rb +43 -57
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +1994 -1791
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +43 -57
- data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
- data/lib/orb/models/subscription_trigger_phase_response.rb +43 -57
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +43 -57
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +43 -57
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +43 -57
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +3 -6
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +43 -57
- data/lib/orb/models/subscription_update_params.rb +0 -5
- data/lib/orb/models/subscription_update_trial_params.rb +8 -6
- data/lib/orb/models/subscription_update_trial_response.rb +43 -57
- data/lib/orb/models/subscription_usage.rb +55 -39
- data/lib/orb/models/subscriptions.rb +6 -6
- data/lib/orb/models/trial_discount.rb +6 -7
- data/lib/orb/models/usage_discount.rb +6 -8
- data/lib/orb/models.rb +24 -0
- data/lib/orb/request_options.rb +4 -0
- data/lib/orb/resources/alerts.rb +30 -31
- data/lib/orb/resources/coupons/subscriptions.rb +3 -4
- data/lib/orb/resources/coupons.rb +11 -21
- data/lib/orb/resources/credit_notes.rb +10 -11
- data/lib/orb/resources/customers/balance_transactions.rb +3 -4
- data/lib/orb/resources/customers/costs.rb +4 -6
- data/lib/orb/resources/customers/credits/ledger.rb +14 -33
- data/lib/orb/resources/customers/credits/top_ups.rb +10 -20
- data/lib/orb/resources/customers/credits.rb +2 -6
- data/lib/orb/resources/customers.rb +40 -67
- data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +2 -2
- data/lib/orb/resources/dimensional_price_groups.rb +8 -10
- data/lib/orb/resources/events/backfills.rb +2 -10
- data/lib/orb/resources/events/volume.rb +3 -6
- data/lib/orb/resources/events.rb +4 -12
- data/lib/orb/resources/invoice_line_items.rb +1 -2
- data/lib/orb/resources/invoices.rb +26 -43
- data/lib/orb/resources/items.rb +12 -13
- data/lib/orb/resources/metrics.rb +11 -14
- data/lib/orb/resources/plans/external_plan_id.rb +5 -7
- data/lib/orb/resources/plans.rb +14 -23
- data/lib/orb/resources/prices/external_price_id.rb +5 -6
- data/lib/orb/resources/prices.rb +25 -35
- data/lib/orb/resources/subscription_changes.rb +1 -1
- data/lib/orb/resources/subscriptions.rb +49 -107
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +3 -0
- data/rbi/orb/client.rbi +5 -4
- data/rbi/orb/errors.rbi +59 -28
- data/rbi/orb/file_part.rbi +9 -6
- data/rbi/orb/internal/page.rbi +20 -6
- data/rbi/orb/internal/transport/base_client.rbi +159 -78
- data/rbi/orb/internal/transport/pooled_net_requester.rbi +27 -13
- data/rbi/orb/internal/type/array_of.rbi +42 -34
- data/rbi/orb/internal/type/base_model.rbi +144 -69
- data/rbi/orb/internal/type/base_page.rbi +12 -8
- data/rbi/orb/internal/type/boolean.rbi +16 -10
- data/rbi/orb/internal/type/converter.rbi +68 -31
- data/rbi/orb/internal/type/enum.rbi +28 -15
- data/rbi/orb/internal/type/file_input.rbi +12 -10
- data/rbi/orb/internal/type/hash_of.rbi +34 -24
- data/rbi/orb/internal/type/request_parameters.rbi +12 -4
- data/rbi/orb/internal/type/union.rbi +61 -25
- data/rbi/orb/internal/type/unknown.rbi +20 -12
- data/rbi/orb/internal/util.rbi +232 -90
- data/rbi/orb/internal.rbi +2 -0
- data/rbi/orb/models/alert.rbi +114 -70
- data/rbi/orb/models/alert_create_for_customer_params.rbi +69 -27
- data/rbi/orb/models/alert_create_for_external_customer_params.rbi +80 -29
- data/rbi/orb/models/alert_create_for_subscription_params.rbi +62 -26
- data/rbi/orb/models/alert_disable_params.rbi +18 -6
- data/rbi/orb/models/alert_enable_params.rbi +18 -6
- data/rbi/orb/models/alert_list_params.rbi +24 -20
- data/rbi/orb/models/alert_retrieve_params.rbi +11 -4
- data/rbi/orb/models/alert_update_params.rbi +29 -14
- data/rbi/orb/models/amount_discount.rbi +29 -19
- data/rbi/orb/models/billable_metric.rbi +34 -26
- data/rbi/orb/models/billing_cycle_relative_date.rbi +11 -5
- data/rbi/orb/models/coupon.rbi +28 -20
- data/rbi/orb/models/coupon_archive_params.rbi +11 -4
- data/rbi/orb/models/coupon_create_params.rbi +85 -38
- data/rbi/orb/models/coupon_fetch_params.rbi +11 -4
- data/rbi/orb/models/coupon_list_params.rbi +19 -15
- data/rbi/orb/models/coupons/subscription_list_params.rbi +19 -6
- data/rbi/orb/models/credit_note.rbi +329 -158
- data/rbi/orb/models/credit_note_create_params.rbi +64 -29
- data/rbi/orb/models/credit_note_fetch_params.rbi +13 -4
- data/rbi/orb/models/credit_note_list_params.rbi +23 -17
- data/rbi/orb/models/customer.rbi +461 -329
- data/rbi/orb/models/customer_create_params.rbi +713 -325
- data/rbi/orb/models/customer_delete_params.rbi +13 -4
- data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +13 -4
- data/rbi/orb/models/customer_fetch_params.rbi +11 -4
- data/rbi/orb/models/customer_list_params.rbi +21 -17
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +16 -4
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +16 -4
- data/rbi/orb/models/customer_update_by_external_id_params.rbi +1193 -336
- data/rbi/orb/models/customer_update_params.rbi +712 -324
- data/rbi/orb/models/customers/balance_transaction_create_params.rbi +56 -21
- data/rbi/orb/models/customers/balance_transaction_create_response.rbi +172 -61
- data/rbi/orb/models/customers/balance_transaction_list_params.rbi +26 -17
- data/rbi/orb/models/customers/balance_transaction_list_response.rbi +182 -59
- data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +62 -22
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +180 -124
- data/rbi/orb/models/customers/cost_list_params.rbi +48 -22
- data/rbi/orb/models/customers/cost_list_response.rbi +172 -123
- data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi +24 -15
- data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +54 -22
- data/rbi/orb/models/customers/credit_list_params.rbi +21 -15
- data/rbi/orb/models/customers/credit_list_response.rbi +50 -21
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +118 -68
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +755 -434
- data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +129 -59
- data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +812 -425
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +108 -44
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +793 -432
- data/rbi/orb/models/customers/credits/ledger_list_params.rbi +129 -40
- data/rbi/orb/models/customers/credits/ledger_list_response.rbi +847 -389
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +86 -53
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +77 -48
- data/rbi/orb/models/customers/credits/top_up_create_params.rbi +96 -45
- data/rbi/orb/models/customers/credits/top_up_create_response.rbi +95 -43
- data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +22 -6
- data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +21 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +15 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +82 -49
- data/rbi/orb/models/customers/credits/top_up_list_params.rbi +15 -5
- data/rbi/orb/models/customers/credits/top_up_list_response.rbi +96 -43
- data/rbi/orb/models/dimensional_price_group.rbi +21 -15
- data/rbi/orb/models/dimensional_price_group_create_params.rbi +22 -16
- data/rbi/orb/models/dimensional_price_group_list_params.rbi +19 -6
- data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +16 -4
- data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +15 -8
- data/rbi/orb/models/dimensional_price_groups.rbi +21 -13
- data/rbi/orb/models/discount.rbi +11 -5
- data/rbi/orb/models/evaluate_price_group.rbi +29 -12
- data/rbi/orb/models/event_deprecate_params.rbi +13 -4
- data/rbi/orb/models/event_deprecate_response.rbi +11 -3
- data/rbi/orb/models/event_ingest_params.rbi +41 -31
- data/rbi/orb/models/event_ingest_response.rbi +78 -23
- data/rbi/orb/models/event_search_params.rbi +18 -14
- data/rbi/orb/models/event_search_response.rbi +42 -21
- data/rbi/orb/models/event_update_params.rbi +20 -16
- data/rbi/orb/models/event_update_response.rbi +11 -3
- data/rbi/orb/models/events/backfill_close_params.rbi +13 -9
- data/rbi/orb/models/events/backfill_close_response.rbi +70 -29
- data/rbi/orb/models/events/backfill_create_params.rbi +24 -18
- data/rbi/orb/models/events/backfill_create_response.rbi +69 -29
- data/rbi/orb/models/events/backfill_fetch_params.rbi +13 -9
- data/rbi/orb/models/events/backfill_fetch_response.rbi +70 -29
- data/rbi/orb/models/events/backfill_list_params.rbi +19 -6
- data/rbi/orb/models/events/backfill_list_response.rbi +68 -28
- data/rbi/orb/models/events/backfill_revert_params.rbi +13 -9
- data/rbi/orb/models/events/backfill_revert_response.rbi +69 -29
- data/rbi/orb/models/events/event_volumes.rbi +38 -10
- data/rbi/orb/models/events/volume_list_params.rbi +21 -15
- data/rbi/orb/models/invoice.rbi +1411 -805
- data/rbi/orb/models/invoice_create_params.rbi +107 -69
- data/rbi/orb/models/invoice_fetch_params.rbi +11 -4
- data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +18 -5
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +2187 -876
- data/rbi/orb/models/invoice_issue_params.rbi +17 -5
- data/rbi/orb/models/invoice_level_discount.rbi +11 -4
- data/rbi/orb/models/invoice_line_item_create_params.rbi +23 -17
- data/rbi/orb/models/invoice_line_item_create_response.rbi +675 -376
- data/rbi/orb/models/invoice_list_params.rbi +68 -47
- data/rbi/orb/models/invoice_mark_paid_params.rbi +20 -14
- data/rbi/orb/models/invoice_pay_params.rbi +11 -4
- data/rbi/orb/models/invoice_update_params.rbi +16 -10
- data/rbi/orb/models/invoice_void_params.rbi +11 -4
- data/rbi/orb/models/item.rbi +90 -39
- data/rbi/orb/models/item_create_params.rbi +15 -5
- data/rbi/orb/models/item_fetch_params.rbi +11 -4
- data/rbi/orb/models/item_list_params.rbi +17 -6
- data/rbi/orb/models/item_update_params.rbi +86 -39
- data/rbi/orb/models/metric_create_params.rbi +20 -16
- data/rbi/orb/models/metric_fetch_params.rbi +11 -4
- data/rbi/orb/models/metric_list_params.rbi +21 -17
- data/rbi/orb/models/metric_update_params.rbi +16 -10
- data/rbi/orb/models/pagination_metadata.rbi +17 -4
- data/rbi/orb/models/percentage_discount.rbi +33 -19
- data/rbi/orb/models/plan.rbi +532 -365
- data/rbi/orb/models/plan_create_params.rbi +5295 -2870
- data/rbi/orb/models/plan_fetch_params.rbi +11 -4
- data/rbi/orb/models/plan_list_params.rbi +35 -27
- data/rbi/orb/models/plan_update_params.rbi +17 -13
- data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +13 -9
- data/rbi/orb/models/plans/external_plan_id_update_params.rbi +22 -13
- data/rbi/orb/models/price.rbi +11332 -5033
- data/rbi/orb/models/price_create_params.rbi +583 -245
- data/rbi/orb/models/price_evaluate_params.rbi +21 -17
- data/rbi/orb/models/price_evaluate_response.rbi +14 -6
- data/rbi/orb/models/price_fetch_params.rbi +11 -4
- data/rbi/orb/models/price_list_params.rbi +17 -6
- data/rbi/orb/models/price_update_params.rbi +16 -10
- data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +15 -8
- data/rbi/orb/models/prices/external_price_id_update_params.rbi +21 -10
- data/rbi/orb/models/subscription.rbi +668 -420
- data/rbi/orb/models/subscription_cancel_params.rbi +47 -22
- data/rbi/orb/models/subscription_cancel_response.rbi +817 -438
- data/rbi/orb/models/subscription_change_apply_params.rbi +19 -13
- data/rbi/orb/models/subscription_change_apply_response.rbi +906 -505
- data/rbi/orb/models/subscription_change_cancel_params.rbi +13 -4
- data/rbi/orb/models/subscription_change_cancel_response.rbi +906 -516
- data/rbi/orb/models/subscription_change_retrieve_params.rbi +13 -4
- data/rbi/orb/models/subscription_change_retrieve_response.rbi +903 -524
- data/rbi/orb/models/subscription_create_params.rbi +10096 -6746
- data/rbi/orb/models/subscription_create_response.rbi +817 -438
- data/rbi/orb/models/subscription_fetch_costs_params.rbi +50 -22
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +172 -123
- data/rbi/orb/models/subscription_fetch_params.rbi +13 -4
- data/rbi/orb/models/subscription_fetch_schedule_params.rbi +23 -17
- data/rbi/orb/models/subscription_fetch_schedule_response.rbi +45 -19
- data/rbi/orb/models/subscription_fetch_usage_params.rbi +84 -34
- data/rbi/orb/models/subscription_list_params.rbi +42 -28
- data/rbi/orb/models/subscription_price_intervals_params.rbi +5798 -3823
- data/rbi/orb/models/subscription_price_intervals_response.rbi +840 -453
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +9676 -6922
- data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +838 -467
- data/rbi/orb/models/subscription_trigger_phase_params.rbi +19 -13
- data/rbi/orb/models/subscription_trigger_phase_response.rbi +832 -448
- data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +16 -4
- data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +839 -467
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +22 -5
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +815 -504
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +16 -4
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +828 -497
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +63 -26
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +839 -467
- data/rbi/orb/models/subscription_update_params.rbi +22 -16
- data/rbi/orb/models/subscription_update_trial_params.rbi +60 -19
- data/rbi/orb/models/subscription_update_trial_response.rbi +832 -447
- data/rbi/orb/models/subscription_usage.rbi +325 -121
- data/rbi/orb/models/subscriptions.rbi +19 -11
- data/rbi/orb/models/top_level_ping_params.rbi +11 -4
- data/rbi/orb/models/top_level_ping_response.rbi +10 -3
- data/rbi/orb/models/trial_discount.rbi +30 -20
- data/rbi/orb/models/usage_discount.rbi +29 -19
- data/rbi/orb/models.rbi +22 -11
- data/rbi/orb/request_options.rbi +12 -6
- data/rbi/orb/resources/alerts.rbi +61 -40
- data/rbi/orb/resources/coupons/subscriptions.rbi +7 -5
- data/rbi/orb/resources/coupons.rbi +33 -18
- data/rbi/orb/resources/credit_notes.rbi +22 -13
- data/rbi/orb/resources/customers/balance_transactions.rbi +17 -9
- data/rbi/orb/resources/customers/costs.rbi +18 -11
- data/rbi/orb/resources/customers/credits/ledger.rbi +98 -74
- data/rbi/orb/resources/customers/credits/top_ups.rbi +61 -25
- data/rbi/orb/resources/customers/credits.rbi +16 -7
- data/rbi/orb/resources/customers.rbi +137 -72
- data/rbi/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +8 -4
- data/rbi/orb/resources/dimensional_price_groups.rbi +26 -12
- data/rbi/orb/resources/events/backfills.rbi +35 -17
- data/rbi/orb/resources/events/volume.rbi +7 -5
- data/rbi/orb/resources/events.rbi +26 -16
- data/rbi/orb/resources/invoice_line_items.rbi +7 -5
- data/rbi/orb/resources/invoices.rbi +72 -41
- data/rbi/orb/resources/items.rbi +40 -13
- data/rbi/orb/resources/metrics.rbi +25 -15
- data/rbi/orb/resources/plans/external_plan_id.rbi +15 -7
- data/rbi/orb/resources/plans.rbi +57 -47
- data/rbi/orb/resources/prices/external_price_id.rbi +73 -68
- data/rbi/orb/resources/prices.rbi +176 -156
- data/rbi/orb/resources/subscription_changes.rbi +19 -11
- data/rbi/orb/resources/subscriptions.rbi +200 -114
- data/rbi/orb/resources/top_level.rbi +9 -3
- data/sig/orb/internal/page.rbs +0 -2
- data/sig/orb/internal/transport/base_client.rbs +16 -1
- data/sig/orb/internal/transport/pooled_net_requester.rbs +2 -0
- data/sig/orb/internal/type/base_model.rbs +11 -5
- data/sig/orb/internal/type/base_page.rbs +1 -1
- data/sig/orb/internal/type/converter.rbs +2 -0
- data/sig/orb/internal/type/enum.rbs +1 -0
- data/sig/orb/internal/type/request_parameters.rbs +3 -1
- data/sig/orb/internal/type/union.rbs +1 -0
- data/sig/orb/internal/util.rbs +13 -0
- data/sig/orb/internal.rbs +2 -0
- data/sig/orb/models/alert.rbs +19 -31
- data/sig/orb/models/alert_create_for_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_subscription_params.rbs +3 -7
- data/sig/orb/models/alert_disable_params.rbs +0 -2
- data/sig/orb/models/alert_enable_params.rbs +0 -2
- data/sig/orb/models/alert_list_params.rbs +0 -2
- data/sig/orb/models/alert_retrieve_params.rbs +0 -2
- data/sig/orb/models/alert_update_params.rbs +3 -7
- data/sig/orb/models/amount_discount.rbs +4 -6
- data/sig/orb/models/billable_metric.rbs +7 -9
- data/sig/orb/models/coupon.rbs +5 -8
- data/sig/orb/models/coupon_archive_params.rbs +0 -2
- data/sig/orb/models/coupon_create_params.rbs +3 -9
- data/sig/orb/models/coupon_fetch_params.rbs +0 -2
- data/sig/orb/models/coupon_list_params.rbs +0 -2
- data/sig/orb/models/coupons/subscription_list_params.rbs +0 -2
- data/sig/orb/models/credit_note.rbs +48 -66
- data/sig/orb/models/credit_note_create_params.rbs +3 -7
- data/sig/orb/models/credit_note_fetch_params.rbs +0 -2
- data/sig/orb/models/credit_note_list_params.rbs +0 -2
- data/sig/orb/models/customer.rbs +43 -63
- data/sig/orb/models/customer_create_params.rbs +32 -52
- data/sig/orb/models/customer_delete_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_params.rbs +0 -2
- data/sig/orb/models/customer_list_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +0 -2
- data/sig/orb/models/customer_update_by_external_id_params.rbs +32 -52
- data/sig/orb/models/customer_update_params.rbs +32 -52
- data/sig/orb/models/customers/balance_transaction_create_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_create_response.rbs +0 -6
- data/sig/orb/models/customers/balance_transaction_list_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_list_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_response.rbs +0 -6
- data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +0 -2
- data/sig/orb/models/customers/credit_list_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_response.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +1 -43
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_create_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_delete_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_response.rbs +0 -4
- data/sig/orb/models/dimensional_price_group.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_create_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_list_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups.rbs +6 -8
- data/sig/orb/models/discount.rbs +5 -5
- data/sig/orb/models/evaluate_price_group.rbs +4 -6
- data/sig/orb/models/event_deprecate_params.rbs +0 -2
- data/sig/orb/models/event_deprecate_response.rbs +0 -2
- data/sig/orb/models/event_ingest_params.rbs +3 -7
- data/sig/orb/models/event_ingest_response.rbs +0 -6
- data/sig/orb/models/event_search_params.rbs +0 -2
- data/sig/orb/models/event_search_response.rbs +0 -4
- data/sig/orb/models/event_update_params.rbs +0 -2
- data/sig/orb/models/event_update_response.rbs +0 -2
- data/sig/orb/models/events/backfill_close_params.rbs +0 -2
- data/sig/orb/models/events/backfill_close_response.rbs +0 -2
- data/sig/orb/models/events/backfill_create_params.rbs +0 -2
- data/sig/orb/models/events/backfill_create_response.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_params.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_response.rbs +0 -2
- data/sig/orb/models/events/backfill_list_params.rbs +0 -2
- data/sig/orb/models/events/backfill_list_response.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_params.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_response.rbs +0 -2
- data/sig/orb/models/events/event_volumes.rbs +3 -10
- data/sig/orb/models/events/volume_list_params.rbs +0 -2
- data/sig/orb/models/invoice.rbs +110 -172
- data/sig/orb/models/invoice_create_params.rbs +10 -16
- data/sig/orb/models/invoice_fetch_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +2 -64
- data/sig/orb/models/invoice_issue_params.rbs +0 -2
- data/sig/orb/models/invoice_level_discount.rbs +2 -4
- data/sig/orb/models/invoice_line_item_create_params.rbs +0 -2
- data/sig/orb/models/invoice_line_item_create_response.rbs +2 -36
- data/sig/orb/models/invoice_list_params.rbs +4 -6
- data/sig/orb/models/invoice_mark_paid_params.rbs +0 -2
- data/sig/orb/models/invoice_pay_params.rbs +0 -2
- data/sig/orb/models/invoice_update_params.rbs +0 -2
- data/sig/orb/models/invoice_void_params.rbs +0 -2
- data/sig/orb/models/item.rbs +7 -11
- data/sig/orb/models/item_create_params.rbs +0 -2
- data/sig/orb/models/item_fetch_params.rbs +0 -2
- data/sig/orb/models/item_list_params.rbs +0 -2
- data/sig/orb/models/item_update_params.rbs +7 -11
- data/sig/orb/models/metric_create_params.rbs +0 -2
- data/sig/orb/models/metric_fetch_params.rbs +0 -2
- data/sig/orb/models/metric_list_params.rbs +0 -2
- data/sig/orb/models/metric_update_params.rbs +0 -2
- data/sig/orb/models/pagination_metadata.rbs +0 -2
- data/sig/orb/models/percentage_discount.rbs +4 -6
- data/sig/orb/models/plan.rbs +45 -73
- data/sig/orb/models/plan_create_params.rbs +518 -696
- data/sig/orb/models/plan_fetch_params.rbs +0 -2
- data/sig/orb/models/plan_list_params.rbs +0 -2
- data/sig/orb/models/plan_update_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +0 -2
- data/sig/orb/models/price.rbs +1194 -1730
- data/sig/orb/models/price_create_params.rbs +59 -97
- data/sig/orb/models/price_evaluate_params.rbs +0 -2
- data/sig/orb/models/price_evaluate_response.rbs +3 -6
- data/sig/orb/models/price_fetch_params.rbs +0 -2
- data/sig/orb/models/price_list_params.rbs +0 -2
- data/sig/orb/models/price_update_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_fetch_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_update_params.rbs +0 -2
- data/sig/orb/models/subscription.rbs +56 -94
- data/sig/orb/models/subscription_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_cancel_response.rbs +20 -60
- data/sig/orb/models/subscription_change_apply_params.rbs +0 -2
- data/sig/orb/models/subscription_change_apply_response.rbs +20 -62
- data/sig/orb/models/subscription_change_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_change_cancel_response.rbs +20 -62
- data/sig/orb/models/subscription_change_retrieve_params.rbs +0 -2
- data/sig/orb/models/subscription_change_retrieve_response.rbs +20 -62
- data/sig/orb/models/subscription_create_params.rbs +1103 -1499
- data/sig/orb/models/subscription_create_response.rbs +20 -60
- data/sig/orb/models/subscription_fetch_costs_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_costs_response.rbs +0 -6
- data/sig/orb/models/subscription_fetch_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_response.rbs +0 -4
- data/sig/orb/models/subscription_fetch_usage_params.rbs +0 -2
- data/sig/orb/models/subscription_list_params.rbs +0 -2
- data/sig/orb/models/subscription_price_intervals_params.rbs +666 -896
- data/sig/orb/models/subscription_price_intervals_response.rbs +20 -60
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1103 -1499
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +20 -60
- data/sig/orb/models/subscription_trigger_phase_params.rbs +0 -2
- data/sig/orb/models/subscription_trigger_phase_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +20 -60
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +0 -2
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +20 -60
- data/sig/orb/models/subscription_update_params.rbs +0 -2
- data/sig/orb/models/subscription_update_trial_params.rbs +1 -3
- data/sig/orb/models/subscription_update_trial_response.rbs +20 -60
- data/sig/orb/models/subscription_usage.rbs +35 -53
- data/sig/orb/models/subscriptions.rbs +6 -8
- data/sig/orb/models/top_level_ping_params.rbs +0 -2
- data/sig/orb/models/top_level_ping_response.rbs +0 -2
- data/sig/orb/models/trial_discount.rbs +4 -6
- data/sig/orb/models/usage_discount.rbs +4 -6
- data/sig/orb/request_options.rbs +1 -1
- data/sig/orb/resources/alerts.rbs +12 -12
- data/sig/orb/resources/coupons/subscriptions.rbs +1 -1
- data/sig/orb/resources/coupons.rbs +4 -4
- data/sig/orb/resources/credit_notes.rbs +4 -4
- data/sig/orb/resources/customers/credits/ledger.rbs +2 -2
- data/sig/orb/resources/customers/credits/top_ups.rbs +2 -2
- data/sig/orb/resources/customers.rbs +24 -24
- data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +1 -1
- data/sig/orb/resources/dimensional_price_groups.rbs +3 -3
- data/sig/orb/resources/events/volume.rbs +1 -1
- data/sig/orb/resources/events.rbs +1 -1
- data/sig/orb/resources/invoices.rbs +10 -10
- data/sig/orb/resources/items.rbs +5 -5
- data/sig/orb/resources/metrics.rbs +4 -4
- data/sig/orb/resources/plans/external_plan_id.rbs +2 -2
- data/sig/orb/resources/plans.rbs +5 -5
- data/sig/orb/resources/prices.rbs +11 -11
- data/sig/orb/resources/subscriptions.rbs +21 -21
- metadata +2 -2
data/rbi/orb/errors.rbi
CHANGED
@@ -29,10 +29,17 @@ module Orb
|
|
29
29
|
request: NilClass,
|
30
30
|
response: NilClass,
|
31
31
|
message: T.nilable(String)
|
32
|
-
)
|
33
|
-
|
32
|
+
).returns(T.attached_class)
|
33
|
+
end
|
34
|
+
def self.new(
|
35
|
+
url:,
|
36
|
+
status: nil,
|
37
|
+
body: nil,
|
38
|
+
request: nil,
|
39
|
+
response: nil,
|
40
|
+
message: nil
|
41
|
+
)
|
34
42
|
end
|
35
|
-
def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: nil); end
|
36
43
|
end
|
37
44
|
|
38
45
|
class APIConnectionError < Orb::Errors::APIError
|
@@ -51,10 +58,16 @@ module Orb
|
|
51
58
|
request: NilClass,
|
52
59
|
response: NilClass,
|
53
60
|
message: T.nilable(String)
|
54
|
-
)
|
55
|
-
.returns(T.attached_class)
|
61
|
+
).returns(T.attached_class)
|
56
62
|
end
|
57
|
-
def self.new(
|
63
|
+
def self.new(
|
64
|
+
url:,
|
65
|
+
status: nil,
|
66
|
+
body: nil,
|
67
|
+
request: nil,
|
68
|
+
response: nil,
|
69
|
+
message: "Connection error."
|
70
|
+
)
|
58
71
|
end
|
59
72
|
end
|
60
73
|
|
@@ -68,10 +81,16 @@ module Orb
|
|
68
81
|
request: NilClass,
|
69
82
|
response: NilClass,
|
70
83
|
message: T.nilable(String)
|
71
|
-
)
|
72
|
-
.returns(T.attached_class)
|
84
|
+
).returns(T.attached_class)
|
73
85
|
end
|
74
|
-
def self.new(
|
86
|
+
def self.new(
|
87
|
+
url:,
|
88
|
+
status: nil,
|
89
|
+
body: nil,
|
90
|
+
request: nil,
|
91
|
+
response: nil,
|
92
|
+
message: "Request timed out."
|
93
|
+
)
|
75
94
|
end
|
76
95
|
end
|
77
96
|
|
@@ -85,10 +104,10 @@ module Orb
|
|
85
104
|
request: NilClass,
|
86
105
|
response: NilClass,
|
87
106
|
message: T.nilable(String)
|
88
|
-
)
|
89
|
-
|
107
|
+
).returns(T.attached_class)
|
108
|
+
end
|
109
|
+
def self.for(url:, status:, body:, request:, response:, message: nil)
|
90
110
|
end
|
91
|
-
def self.for(url:, status:, body:, request:, response:, message: nil); end
|
92
111
|
|
93
112
|
sig { returns(Integer) }
|
94
113
|
attr_accessor :status
|
@@ -102,10 +121,10 @@ module Orb
|
|
102
121
|
request: NilClass,
|
103
122
|
response: NilClass,
|
104
123
|
message: T.nilable(String)
|
105
|
-
)
|
106
|
-
|
124
|
+
).returns(T.attached_class)
|
125
|
+
end
|
126
|
+
def self.new(url:, status:, body:, request:, response:, message: nil)
|
107
127
|
end
|
108
|
-
def self.new(url:, status:, body:, request:, response:, message: nil); end
|
109
128
|
end
|
110
129
|
|
111
130
|
class BadRequestError < Orb::Errors::APIStatusError
|
@@ -137,55 +156,67 @@ module Orb
|
|
137
156
|
end
|
138
157
|
|
139
158
|
class InternalServerError < Orb::Errors::APIStatusError
|
140
|
-
HTTP_STATUS = T.let(500
|
159
|
+
HTTP_STATUS = T.let((500..), T::Range[Integer])
|
141
160
|
end
|
142
161
|
|
143
162
|
class ConstraintViolation < Orb::Errors::BadRequestError
|
144
|
-
TYPE =
|
163
|
+
TYPE =
|
164
|
+
"https://docs.withorb.com/reference/error-responses#400-constraint-violation"
|
145
165
|
end
|
146
166
|
|
147
167
|
class DuplicateResourceCreation < Orb::Errors::BadRequestError
|
148
|
-
TYPE =
|
168
|
+
TYPE =
|
169
|
+
"https://docs.withorb.com/reference/error-responses#400-duplicate-resource-creation"
|
149
170
|
end
|
150
171
|
|
151
172
|
class FeatureNotAvailable < Orb::Errors::BadRequestError
|
152
|
-
TYPE =
|
173
|
+
TYPE =
|
174
|
+
"https://docs.withorb.com/reference/error-responses#404-feature-not-available"
|
153
175
|
end
|
154
176
|
|
155
177
|
class RequestValidationError < Orb::Errors::BadRequestError
|
156
|
-
TYPE =
|
178
|
+
TYPE =
|
179
|
+
"https://docs.withorb.com/reference/error-responses#400-request-validation-errors"
|
157
180
|
end
|
158
181
|
|
159
182
|
class OrbAuthenticationError < Orb::Errors::AuthenticationError
|
160
|
-
TYPE =
|
183
|
+
TYPE =
|
184
|
+
"https://docs.withorb.com/reference/error-responses#401-authentication-error"
|
161
185
|
end
|
162
186
|
|
163
187
|
class ResourceNotFound < Orb::Errors::NotFoundError
|
164
|
-
TYPE =
|
188
|
+
TYPE =
|
189
|
+
"https://docs.withorb.com/reference/error-responses#404-resource-not-found"
|
165
190
|
end
|
166
191
|
|
167
192
|
class URLNotFound < Orb::Errors::NotFoundError
|
168
|
-
TYPE =
|
193
|
+
TYPE =
|
194
|
+
"https://docs.withorb.com/reference/error-responses#404-url-not-found"
|
169
195
|
end
|
170
196
|
|
171
197
|
class ResourceConflict < Orb::Errors::ConflictError
|
172
|
-
TYPE =
|
198
|
+
TYPE =
|
199
|
+
"https://docs.withorb.com/reference/error-responses#409-resource-conflict"
|
173
200
|
end
|
174
201
|
|
175
202
|
class RequestTooLarge < Orb::Errors::APIStatusError
|
176
|
-
TYPE =
|
203
|
+
TYPE =
|
204
|
+
"https://docs.withorb.com/reference/error-responses#413-request-too-large"
|
177
205
|
end
|
178
206
|
|
179
207
|
class ResourceTooLarge < Orb::Errors::APIStatusError
|
180
|
-
TYPE =
|
208
|
+
TYPE =
|
209
|
+
"https://docs.withorb.com/reference/error-responses#413-resource-too-large"
|
181
210
|
end
|
182
211
|
|
183
212
|
class TooManyRequests < Orb::Errors::RateLimitError
|
184
|
-
TYPE =
|
213
|
+
TYPE =
|
214
|
+
"https://docs.withorb.com/reference/error-responses#429-too-many-requests"
|
185
215
|
end
|
186
216
|
|
187
217
|
class OrbInternalServerError < Orb::Errors::InternalServerError
|
188
|
-
TYPE =
|
218
|
+
TYPE =
|
219
|
+
"https://docs.withorb.com/reference/error-responses#500-internal-server-error"
|
189
220
|
end
|
190
221
|
end
|
191
222
|
end
|
data/rbi/orb/file_part.rbi
CHANGED
@@ -13,22 +13,25 @@ module Orb
|
|
13
13
|
|
14
14
|
# @api private
|
15
15
|
sig { returns(String) }
|
16
|
-
private def read
|
16
|
+
private def read
|
17
|
+
end
|
17
18
|
|
18
19
|
sig { params(a: T.anything).returns(String) }
|
19
|
-
def to_json(*a)
|
20
|
+
def to_json(*a)
|
21
|
+
end
|
20
22
|
|
21
23
|
sig { params(a: T.anything).returns(String) }
|
22
|
-
def to_yaml(*a)
|
24
|
+
def to_yaml(*a)
|
25
|
+
end
|
23
26
|
|
24
27
|
sig do
|
25
28
|
params(
|
26
29
|
content: T.any(Pathname, StringIO, IO, String),
|
27
30
|
filename: T.nilable(String),
|
28
31
|
content_type: T.nilable(String)
|
29
|
-
)
|
30
|
-
|
32
|
+
).returns(T.attached_class)
|
33
|
+
end
|
34
|
+
def self.new(content, filename: nil, content_type: nil)
|
31
35
|
end
|
32
|
-
def self.new(content, filename: nil, content_type: nil); end
|
33
36
|
end
|
34
37
|
end
|
data/rbi/orb/internal/page.rbi
CHANGED
@@ -15,20 +15,34 @@ module Orb
|
|
15
15
|
|
16
16
|
# @api private
|
17
17
|
sig { returns(String) }
|
18
|
-
def inspect
|
18
|
+
def inspect
|
19
|
+
end
|
19
20
|
|
20
21
|
class PaginationMetadata < Orb::Internal::Type::BaseModel
|
22
|
+
OrHash =
|
23
|
+
T.type_alias { T.any(PaginationMetadata, Orb::Internal::AnyHash) }
|
24
|
+
|
21
25
|
sig { returns(T::Boolean) }
|
22
26
|
attr_accessor :has_more
|
23
27
|
|
24
28
|
sig { returns(T.nilable(String)) }
|
25
29
|
attr_accessor :next_cursor
|
26
30
|
|
27
|
-
sig
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
31
|
+
sig do
|
32
|
+
params(has_more: T::Boolean, next_cursor: T.nilable(String)).returns(
|
33
|
+
T.attached_class
|
34
|
+
)
|
35
|
+
end
|
36
|
+
def self.new(has_more:, next_cursor:)
|
37
|
+
end
|
38
|
+
|
39
|
+
sig do
|
40
|
+
override.returns(
|
41
|
+
{ has_more: T::Boolean, next_cursor: T.nilable(String) }
|
42
|
+
)
|
43
|
+
end
|
44
|
+
def to_hash
|
45
|
+
end
|
32
46
|
end
|
33
47
|
end
|
34
48
|
end
|
@@ -5,41 +5,57 @@ module Orb
|
|
5
5
|
module Transport
|
6
6
|
# @api private
|
7
7
|
class BaseClient
|
8
|
+
extend Orb::Internal::Util::SorbetRuntimeSupport
|
9
|
+
|
8
10
|
abstract!
|
9
11
|
|
10
|
-
|
12
|
+
RequestComponents =
|
11
13
|
T.type_alias do
|
12
14
|
{
|
13
15
|
method: Symbol,
|
14
16
|
path: T.any(String, T::Array[String]),
|
15
|
-
query:
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
17
|
+
query:
|
18
|
+
T.nilable(
|
19
|
+
T::Hash[String, T.nilable(T.any(T::Array[String], String))]
|
20
|
+
),
|
21
|
+
headers:
|
22
|
+
T.nilable(
|
23
|
+
T::Hash[
|
24
|
+
String,
|
25
|
+
T.nilable(
|
26
|
+
T.any(
|
27
|
+
String,
|
28
|
+
Integer,
|
29
|
+
T::Array[T.nilable(T.any(String, Integer))]
|
30
|
+
)
|
31
|
+
)
|
32
|
+
]
|
33
|
+
),
|
26
34
|
body: T.nilable(T.anything),
|
27
|
-
unwrap:
|
28
|
-
T.
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
35
|
+
unwrap:
|
36
|
+
T.nilable(
|
37
|
+
T.any(
|
38
|
+
Symbol,
|
39
|
+
Integer,
|
40
|
+
T::Array[T.any(Symbol, Integer)],
|
41
|
+
T.proc.params(arg0: T.anything).returns(T.anything)
|
42
|
+
)
|
43
|
+
),
|
44
|
+
page:
|
45
|
+
T.nilable(
|
46
|
+
T::Class[
|
47
|
+
Orb::Internal::Type::BasePage[
|
48
|
+
Orb::Internal::Type::BaseModel
|
49
|
+
]
|
50
|
+
]
|
51
|
+
),
|
36
52
|
stream: T.nilable(T::Class[T.anything]),
|
37
53
|
model: T.nilable(Orb::Internal::Type::Converter::Input),
|
38
|
-
options: T.nilable(Orb::
|
54
|
+
options: T.nilable(Orb::RequestOptions::OrHash)
|
39
55
|
}
|
40
56
|
end
|
41
57
|
|
42
|
-
|
58
|
+
RequestInput =
|
43
59
|
T.type_alias do
|
44
60
|
{
|
45
61
|
method: Symbol,
|
@@ -58,43 +74,67 @@ module Orb
|
|
58
74
|
|
59
75
|
class << self
|
60
76
|
# @api private
|
61
|
-
sig
|
62
|
-
|
77
|
+
sig do
|
78
|
+
params(
|
79
|
+
req: Orb::Internal::Transport::BaseClient::RequestComponents
|
80
|
+
).void
|
81
|
+
end
|
82
|
+
def validate!(req)
|
83
|
+
end
|
63
84
|
|
64
85
|
# @api private
|
65
86
|
sig do
|
66
87
|
params(
|
67
88
|
status: Integer,
|
68
|
-
headers: T.any(
|
69
|
-
T::Hash[String, String],
|
70
|
-
Net::HTTPHeader
|
71
|
-
)
|
89
|
+
headers: T.any(T::Hash[String, String], Net::HTTPHeader)
|
72
90
|
).returns(T::Boolean)
|
73
91
|
end
|
74
|
-
def should_retry?(status, headers:)
|
92
|
+
def should_retry?(status, headers:)
|
93
|
+
end
|
75
94
|
|
76
95
|
# @api private
|
77
96
|
sig do
|
78
97
|
params(
|
79
|
-
request: Orb::Internal::Transport::BaseClient::
|
98
|
+
request: Orb::Internal::Transport::BaseClient::RequestInput,
|
80
99
|
status: Integer,
|
81
100
|
response_headers: T.any(T::Hash[String, String], Net::HTTPHeader)
|
82
|
-
)
|
83
|
-
|
101
|
+
).returns(Orb::Internal::Transport::BaseClient::RequestInput)
|
102
|
+
end
|
103
|
+
def follow_redirect(request, status:, response_headers:)
|
84
104
|
end
|
85
|
-
def follow_redirect(request, status:, response_headers:); end
|
86
105
|
|
87
106
|
# @api private
|
88
107
|
sig do
|
89
108
|
params(
|
90
109
|
status: T.any(Integer, Orb::Errors::APIConnectionError),
|
91
110
|
stream: T.nilable(T::Enumerable[String])
|
92
|
-
)
|
93
|
-
|
111
|
+
).void
|
112
|
+
end
|
113
|
+
def reap_connection!(status, stream:)
|
94
114
|
end
|
95
|
-
def reap_connection!(status, stream:); end
|
96
115
|
end
|
97
116
|
|
117
|
+
sig { returns(URI::Generic) }
|
118
|
+
attr_reader :base_url
|
119
|
+
|
120
|
+
sig { returns(Float) }
|
121
|
+
attr_reader :timeout
|
122
|
+
|
123
|
+
sig { returns(Integer) }
|
124
|
+
attr_reader :max_retries
|
125
|
+
|
126
|
+
sig { returns(Float) }
|
127
|
+
attr_reader :initial_retry_delay
|
128
|
+
|
129
|
+
sig { returns(Float) }
|
130
|
+
attr_reader :max_retry_delay
|
131
|
+
|
132
|
+
sig { returns(T::Hash[String, String]) }
|
133
|
+
attr_reader :headers
|
134
|
+
|
135
|
+
sig { returns(T.nilable(String)) }
|
136
|
+
attr_reader :idempotency_header
|
137
|
+
|
98
138
|
# @api private
|
99
139
|
sig { returns(Orb::Internal::Transport::PooledNetRequester) }
|
100
140
|
attr_reader :requester
|
@@ -107,11 +147,19 @@ module Orb
|
|
107
147
|
max_retries: Integer,
|
108
148
|
initial_retry_delay: Float,
|
109
149
|
max_retry_delay: Float,
|
110
|
-
headers:
|
111
|
-
|
150
|
+
headers:
|
151
|
+
T::Hash[
|
152
|
+
String,
|
153
|
+
T.nilable(
|
154
|
+
T.any(
|
155
|
+
String,
|
156
|
+
Integer,
|
157
|
+
T::Array[T.nilable(T.any(String, Integer))]
|
158
|
+
)
|
159
|
+
)
|
160
|
+
],
|
112
161
|
idempotency_header: T.nilable(String)
|
113
|
-
)
|
114
|
-
.returns(T.attached_class)
|
162
|
+
).returns(T.attached_class)
|
115
163
|
end
|
116
164
|
def self.new(
|
117
165
|
base_url:,
|
@@ -121,38 +169,57 @@ module Orb
|
|
121
169
|
max_retry_delay: 0.0,
|
122
170
|
headers: {},
|
123
171
|
idempotency_header: nil
|
124
|
-
)
|
172
|
+
)
|
173
|
+
end
|
174
|
+
|
125
175
|
# @api private
|
126
176
|
sig { overridable.returns(T::Hash[String, String]) }
|
127
|
-
private def auth_headers
|
177
|
+
private def auth_headers
|
178
|
+
end
|
128
179
|
|
129
180
|
# @api private
|
130
181
|
sig { returns(String) }
|
131
|
-
private def generate_idempotency_key
|
182
|
+
private def generate_idempotency_key
|
183
|
+
end
|
132
184
|
|
133
185
|
# @api private
|
134
186
|
sig do
|
135
187
|
overridable
|
136
|
-
.params(
|
137
|
-
|
188
|
+
.params(
|
189
|
+
req: Orb::Internal::Transport::BaseClient::RequestComponents,
|
190
|
+
opts: Orb::Internal::AnyHash
|
191
|
+
)
|
192
|
+
.returns(Orb::Internal::Transport::BaseClient::RequestInput)
|
193
|
+
end
|
194
|
+
private def build_request(req, opts)
|
138
195
|
end
|
139
|
-
private def build_request(req, opts); end
|
140
196
|
|
141
197
|
# @api private
|
142
|
-
sig
|
143
|
-
|
198
|
+
sig do
|
199
|
+
params(
|
200
|
+
headers: T::Hash[String, String],
|
201
|
+
retry_count: Integer
|
202
|
+
).returns(Float)
|
203
|
+
end
|
204
|
+
private def retry_delay(headers, retry_count:)
|
205
|
+
end
|
144
206
|
|
145
207
|
# @api private
|
146
208
|
sig do
|
147
209
|
params(
|
148
|
-
request: Orb::Internal::Transport::BaseClient::
|
210
|
+
request: Orb::Internal::Transport::BaseClient::RequestInput,
|
149
211
|
redirect_count: Integer,
|
150
212
|
retry_count: Integer,
|
151
213
|
send_retry_header: T::Boolean
|
152
|
-
)
|
153
|
-
|
214
|
+
).returns([Integer, Net::HTTPResponse, T::Enumerable[String]])
|
215
|
+
end
|
216
|
+
private def send_request(
|
217
|
+
request,
|
218
|
+
redirect_count:,
|
219
|
+
retry_count:,
|
220
|
+
send_retry_header:
|
221
|
+
)
|
154
222
|
end
|
155
|
-
private def send_request(request, redirect_count:, retry_count:, send_retry_header:); end
|
156
223
|
|
157
224
|
# Execute the request specified by `req`. This is the method that all resource
|
158
225
|
# methods call into.
|
@@ -162,32 +229,43 @@ module Orb
|
|
162
229
|
params(
|
163
230
|
method: Symbol,
|
164
231
|
path: T.any(String, T::Array[String]),
|
165
|
-
query:
|
166
|
-
|
167
|
-
|
168
|
-
|
169
|
-
|
170
|
-
|
171
|
-
|
172
|
-
|
173
|
-
|
174
|
-
|
175
|
-
|
232
|
+
query:
|
233
|
+
T.nilable(
|
234
|
+
T::Hash[String, T.nilable(T.any(T::Array[String], String))]
|
235
|
+
),
|
236
|
+
headers:
|
237
|
+
T.nilable(
|
238
|
+
T::Hash[
|
239
|
+
String,
|
240
|
+
T.nilable(
|
241
|
+
T.any(
|
242
|
+
String,
|
243
|
+
Integer,
|
244
|
+
T::Array[T.nilable(T.any(String, Integer))]
|
245
|
+
)
|
246
|
+
)
|
247
|
+
]
|
248
|
+
),
|
176
249
|
body: T.nilable(T.anything),
|
177
|
-
unwrap:
|
178
|
-
T.
|
179
|
-
|
180
|
-
|
181
|
-
|
182
|
-
|
183
|
-
|
184
|
-
|
185
|
-
|
250
|
+
unwrap:
|
251
|
+
T.nilable(
|
252
|
+
T.any(
|
253
|
+
Symbol,
|
254
|
+
Integer,
|
255
|
+
T::Array[T.any(Symbol, Integer)],
|
256
|
+
T.proc.params(arg0: T.anything).returns(T.anything)
|
257
|
+
)
|
258
|
+
),
|
259
|
+
page:
|
260
|
+
T.nilable(
|
261
|
+
T::Class[
|
262
|
+
Orb::Internal::Type::BasePage[Orb::Internal::Type::BaseModel]
|
263
|
+
]
|
264
|
+
),
|
186
265
|
stream: T.nilable(T::Class[T.anything]),
|
187
266
|
model: T.nilable(Orb::Internal::Type::Converter::Input),
|
188
|
-
options: T.nilable(Orb::
|
189
|
-
)
|
190
|
-
.returns(T.anything)
|
267
|
+
options: T.nilable(Orb::RequestOptions::OrHash)
|
268
|
+
).returns(T.anything)
|
191
269
|
end
|
192
270
|
def request(
|
193
271
|
method,
|
@@ -200,10 +278,13 @@ module Orb
|
|
200
278
|
stream: nil,
|
201
279
|
model: Orb::Internal::Type::Unknown,
|
202
280
|
options: {}
|
203
|
-
)
|
281
|
+
)
|
282
|
+
end
|
283
|
+
|
204
284
|
# @api private
|
205
285
|
sig { returns(String) }
|
206
|
-
def inspect
|
286
|
+
def inspect
|
287
|
+
end
|
207
288
|
end
|
208
289
|
end
|
209
290
|
end
|
@@ -5,7 +5,9 @@ module Orb
|
|
5
5
|
module Transport
|
6
6
|
# @api private
|
7
7
|
class PooledNetRequester
|
8
|
-
|
8
|
+
extend Orb::Internal::Util::SorbetRuntimeSupport
|
9
|
+
|
10
|
+
Request =
|
9
11
|
T.type_alias do
|
10
12
|
{
|
11
13
|
method: Symbol,
|
@@ -23,37 +25,49 @@ module Orb
|
|
23
25
|
class << self
|
24
26
|
# @api private
|
25
27
|
sig { params(url: URI::Generic).returns(Net::HTTP) }
|
26
|
-
def connect(url)
|
28
|
+
def connect(url)
|
29
|
+
end
|
27
30
|
|
28
31
|
# @api private
|
29
32
|
sig { params(conn: Net::HTTP, deadline: Float).void }
|
30
|
-
def calibrate_socket_timeout(conn, deadline)
|
33
|
+
def calibrate_socket_timeout(conn, deadline)
|
34
|
+
end
|
31
35
|
|
32
36
|
# @api private
|
33
37
|
sig do
|
34
38
|
params(
|
35
|
-
request: Orb::Internal::Transport::PooledNetRequester::
|
39
|
+
request: Orb::Internal::Transport::PooledNetRequester::Request,
|
36
40
|
blk: T.proc.params(arg0: String).void
|
37
|
-
)
|
38
|
-
|
41
|
+
).returns([Net::HTTPGenericRequest, T.proc.void])
|
42
|
+
end
|
43
|
+
def build_request(request, &blk)
|
39
44
|
end
|
40
|
-
def build_request(request, &blk); end
|
41
45
|
end
|
42
46
|
|
43
47
|
# @api private
|
44
|
-
sig
|
45
|
-
|
48
|
+
sig do
|
49
|
+
params(
|
50
|
+
url: URI::Generic,
|
51
|
+
deadline: Float,
|
52
|
+
blk: T.proc.params(arg0: Net::HTTP).void
|
53
|
+
).void
|
54
|
+
end
|
55
|
+
private def with_pool(url, deadline:, &blk)
|
56
|
+
end
|
46
57
|
|
47
58
|
# @api private
|
48
59
|
sig do
|
49
|
-
params(
|
50
|
-
|
60
|
+
params(
|
61
|
+
request: Orb::Internal::Transport::PooledNetRequester::Request
|
62
|
+
).returns([Integer, Net::HTTPResponse, T::Enumerable[String]])
|
63
|
+
end
|
64
|
+
def execute(request)
|
51
65
|
end
|
52
|
-
def execute(request); end
|
53
66
|
|
54
67
|
# @api private
|
55
68
|
sig { params(size: Integer).returns(T.attached_class) }
|
56
|
-
def self.new(size: Etc.nprocessors)
|
69
|
+
def self.new(size: Etc.nprocessors)
|
70
|
+
end
|
57
71
|
end
|
58
72
|
end
|
59
73
|
end
|