orb-billing 0.3.0 → 0.3.2
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 +47 -0
- data/README.md +7 -7
- data/lib/orb/errors.rb +9 -9
- data/lib/orb/file_part.rb +2 -2
- 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 +13 -14
- data/lib/orb/internal/type/request_parameters.rb +6 -12
- data/lib/orb/internal/type/union.rb +4 -4
- data/lib/orb/internal/type/unknown.rb +10 -11
- data/lib/orb/internal/util.rb +21 -5
- 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 +9 -12
- data/lib/orb/models/coupon_create_params.rb +8 -10
- 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 +43 -55
- data/lib/orb/models/customer_list_params.rb +0 -1
- data/lib/orb/models/customer_update_by_external_id_params.rb +43 -57
- data/lib/orb/models/customer_update_params.rb +43 -53
- 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 +106 -114
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +11 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +111 -126
- 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 +110 -121
- data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
- data/lib/orb/models/customers/credits/ledger_list_response.rb +112 -131
- 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 +5 -5
- data/lib/orb/models/evaluate_price_group.rb +1 -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 +165 -224
- data/lib/orb/models/invoice_create_params.rb +14 -21
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +58 -107
- data/lib/orb/models/invoice_issue_params.rb +0 -1
- data/lib/orb/models/invoice_level_discount.rb +4 -4
- data/lib/orb/models/invoice_line_item_create_params.rb +0 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +58 -81
- 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 +83 -111
- data/lib/orb/models/plan_create_params.rb +753 -861
- 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 +1699 -1804
- 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 +94 -136
- data/lib/orb/models/subscription_cancel_params.rb +3 -5
- data/lib/orb/models/subscription_cancel_response.rb +52 -91
- data/lib/orb/models/subscription_change_apply_response.rb +50 -88
- data/lib/orb/models/subscription_change_cancel_response.rb +50 -87
- data/lib/orb/models/subscription_change_retrieve_response.rb +50 -87
- data/lib/orb/models/subscription_create_params.rb +1927 -1928
- data/lib/orb/models/subscription_create_response.rb +52 -91
- 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 +1141 -1079
- data/lib/orb/models/subscription_price_intervals_response.rb +51 -90
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +1966 -1906
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +50 -88
- data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
- data/lib/orb/models/subscription_trigger_phase_response.rb +51 -90
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +50 -88
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +50 -86
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +50 -86
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +3 -6
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +50 -88
- data/lib/orb/models/subscription_update_params.rb +0 -5
- data/lib/orb/models/subscription_update_trial_params.rb +4 -6
- data/lib/orb/models/subscription_update_trial_response.rb +52 -91
- data/lib/orb/models/subscription_usage.rb +46 -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 +220 -0
- data/lib/orb/request_options.rb +4 -5
- 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 +18 -37
- 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 +1 -0
- data/rbi/{lib/orb → orb}/client.rbi +5 -4
- data/rbi/{lib/orb → orb}/errors.rbi +58 -27
- data/rbi/{lib/orb → orb}/file_part.rbi +9 -6
- data/rbi/{lib/orb → orb}/internal/page.rbi +19 -6
- data/rbi/{lib/orb → orb}/internal/transport/base_client.rbi +131 -73
- data/rbi/{lib/orb → orb}/internal/transport/pooled_net_requester.rbi +25 -12
- data/rbi/orb/internal/type/array_of.rbi +98 -0
- data/rbi/{lib/orb → orb}/internal/type/base_model.rbi +124 -65
- data/rbi/{lib/orb → orb}/internal/type/base_page.rbi +11 -7
- data/rbi/{lib/orb → orb}/internal/type/boolean.rbi +16 -10
- data/rbi/{lib/orb → orb}/internal/type/converter.rbi +66 -31
- data/rbi/{lib/orb → orb}/internal/type/enum.rbi +27 -15
- data/rbi/{lib/orb → orb}/internal/type/file_input.rbi +12 -10
- data/rbi/{lib/orb → orb}/internal/type/hash_of.rbi +34 -24
- data/rbi/orb/internal/type/request_parameters.rbi +29 -0
- data/rbi/orb/internal/type/union.rbi +110 -0
- data/rbi/orb/internal/type/unknown.rbi +50 -0
- data/rbi/orb/internal/util.rbi +424 -0
- data/rbi/{lib/orb → orb}/models/alert.rbi +107 -70
- data/rbi/{lib/orb → orb}/models/alert_create_for_customer_params.rbi +60 -27
- data/rbi/{lib/orb → orb}/models/alert_create_for_external_customer_params.rbi +68 -29
- data/rbi/{lib/orb → orb}/models/alert_create_for_subscription_params.rbi +53 -26
- data/rbi/{lib/orb → orb}/models/alert_disable_params.rbi +17 -6
- data/rbi/{lib/orb → orb}/models/alert_enable_params.rbi +17 -6
- data/rbi/{lib/orb → orb}/models/alert_list_params.rbi +23 -20
- data/rbi/orb/models/alert_retrieve_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/alert_update_params.rbi +25 -14
- data/rbi/{lib/orb → orb}/models/amount_discount.rbi +28 -19
- data/rbi/{lib/orb → orb}/models/billable_metric.rbi +33 -26
- data/rbi/orb/models/billing_cycle_relative_date.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/coupon.rbi +28 -20
- data/rbi/orb/models/coupon_archive_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/coupon_create_params.rbi +74 -40
- data/rbi/orb/models/coupon_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/coupon_list_params.rbi +18 -15
- data/rbi/{lib/orb → orb}/models/coupons/subscription_list_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/credit_note.rbi +293 -158
- data/rbi/orb/models/credit_note_create_params.rbi +117 -0
- data/rbi/orb/models/credit_note_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/credit_note_list_params.rbi +20 -17
- data/rbi/{lib/orb → orb}/models/customer.rbi +430 -329
- data/rbi/{lib/orb → orb}/models/customer_create_params.rbi +664 -327
- data/rbi/orb/models/customer_delete_params.rbi +24 -0
- data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +24 -0
- data/rbi/orb/models/customer_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/customer_list_params.rbi +20 -17
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +24 -0
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/customer_update_by_external_id_params.rbi +1138 -338
- data/rbi/{lib/orb → orb}/models/customer_update_params.rbi +663 -326
- data/rbi/orb/models/customers/balance_transaction_create_params.rbi +94 -0
- data/rbi/orb/models/customers/balance_transaction_create_response.rbi +301 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_params.rbi +20 -17
- data/rbi/orb/models/customers/balance_transaction_list_response.rbi +301 -0
- data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_params.rbi +56 -22
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +263 -0
- data/rbi/{lib/orb → orb}/models/customers/cost_list_params.rbi +45 -22
- data/rbi/orb/models/customers/cost_list_response.rbi +254 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_params.rbi +18 -15
- data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +110 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_params.rbi +18 -15
- data/rbi/{lib/orb → orb}/models/customers/credit_list_response.rbi +44 -21
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_params.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi} +118 -60
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_response.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi} +685 -468
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi → orb/models/customers/credits/ledger_create_entry_params.rbi} +107 -69
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi → orb/models/customers/credits/ledger_create_entry_response.rbi} +643 -470
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +224 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_response.rbi +658 -469
- data/rbi/orb/models/customers/credits/ledger_list_params.rbi +224 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_response.rbi +708 -459
- data/rbi/{lib/orb/models/customers/credits/top_up_create_params.rbi → orb/models/customers/credits/top_up_create_by_external_id_params.rbi} +87 -46
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_response.rbi +65 -48
- data/rbi/{lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi → orb/models/customers/credits/top_up_create_params.rbi} +73 -54
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_response.rbi +83 -43
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_by_external_id_params.rbi +16 -6
- data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +36 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_params.rbi +9 -5
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_response.rbi +70 -49
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_params.rbi +9 -5
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_response.rbi +84 -43
- data/rbi/{lib/orb → orb}/models/dimensional_price_group.rbi +18 -15
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_create_params.rbi +19 -16
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_list_params.rbi +16 -6
- data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +24 -0
- data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +26 -0
- data/rbi/orb/models/dimensional_price_groups.rbi +38 -0
- data/rbi/orb/models/discount.rbi +23 -0
- data/rbi/{lib/orb → orb}/models/evaluate_price_group.rbi +28 -12
- data/rbi/orb/models/event_deprecate_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/event_deprecate_response.rbi +8 -3
- data/rbi/{lib/orb → orb}/models/event_ingest_params.rbi +37 -31
- data/rbi/{lib/orb → orb}/models/event_ingest_response.rbi +63 -23
- data/rbi/{lib/orb → orb}/models/event_search_params.rbi +17 -14
- data/rbi/{lib/orb → orb}/models/event_search_response.rbi +33 -21
- data/rbi/{lib/orb → orb}/models/event_update_params.rbi +19 -16
- data/rbi/{lib/orb → orb}/models/event_update_response.rbi +8 -3
- data/rbi/orb/models/events/backfill_close_params.rbi +26 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_close_response.rbi +64 -29
- data/rbi/{lib/orb → orb}/models/events/backfill_create_params.rbi +21 -18
- data/rbi/{lib/orb → orb}/models/events/backfill_create_response.rbi +63 -29
- data/rbi/orb/models/events/backfill_fetch_params.rbi +26 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_fetch_response.rbi +64 -29
- data/rbi/{lib/orb → orb}/models/events/backfill_list_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/events/backfill_list_response.rbi +62 -28
- data/rbi/orb/models/events/backfill_revert_params.rbi +26 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_revert_response.rbi +63 -29
- data/rbi/{lib/orb → orb}/models/events/event_volumes.rbi +34 -12
- data/rbi/{lib/orb → orb}/models/events/volume_list_params.rbi +18 -15
- data/rbi/{lib/orb → orb}/models/invoice.rbi +1294 -831
- data/rbi/{lib/orb → orb}/models/invoice_create_params.rbi +97 -69
- data/rbi/orb/models/invoice_fetch_params.rbi +24 -0
- data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +32 -0
- data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_response.rbi +2003 -885
- data/rbi/{lib/orb → orb}/models/invoice_issue_params.rbi +16 -5
- data/rbi/orb/models/invoice_level_discount.rbi +22 -0
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_params.rbi +20 -17
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_response.rbi +594 -421
- data/rbi/{lib/orb → orb}/models/invoice_list_params.rbi +67 -47
- data/rbi/{lib/orb → orb}/models/invoice_mark_paid_params.rbi +17 -14
- data/rbi/orb/models/invoice_pay_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/invoice_update_params.rbi +15 -10
- data/rbi/orb/models/invoice_void_params.rbi +24 -0
- data/rbi/orb/models/item.rbi +143 -0
- data/rbi/{lib/orb → orb}/models/item_create_params.rbi +14 -5
- data/rbi/orb/models/item_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/item_list_params.rbi +16 -6
- data/rbi/orb/models/item_update_params.rbi +141 -0
- data/rbi/{lib/orb → orb}/models/metric_create_params.rbi +19 -16
- data/rbi/orb/models/metric_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/metric_list_params.rbi +20 -17
- data/rbi/{lib/orb → orb}/models/metric_update_params.rbi +15 -10
- data/rbi/orb/models/pagination_metadata.rbi +31 -0
- data/rbi/{lib/orb → orb}/models/percentage_discount.rbi +32 -19
- data/rbi/{lib/orb → orb}/models/plan.rbi +501 -370
- data/rbi/{lib/orb → orb}/models/plan_create_params.rbi +4243 -3094
- data/rbi/orb/models/plan_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/plan_list_params.rbi +34 -27
- data/rbi/{lib/orb → orb}/models/plan_update_params.rbi +16 -13
- data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +26 -0
- data/rbi/{lib/orb → orb}/models/plans/external_plan_id_update_params.rbi +16 -13
- data/rbi/orb/models/price.rbi +19414 -0
- data/rbi/{lib/orb → orb}/models/price_create_params.rbi +501 -245
- data/rbi/{lib/orb → orb}/models/price_evaluate_params.rbi +20 -17
- data/rbi/orb/models/price_evaluate_response.rbi +24 -0
- data/rbi/orb/models/price_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/price_list_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/price_update_params.rbi +15 -10
- data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +26 -0
- data/rbi/{lib/orb → orb}/models/prices/external_price_id_update_params.rbi +15 -10
- data/rbi/{lib/orb → orb}/models/subscription.rbi +586 -428
- data/rbi/{lib/orb → orb}/models/subscription_cancel_params.rbi +44 -22
- data/rbi/{lib/orb → orb}/models/subscription_cancel_response.rbi +724 -462
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_params.rbi +16 -13
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_response.rbi +808 -528
- data/rbi/orb/models/subscription_change_cancel_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/subscription_change_cancel_response.rbi +807 -538
- data/rbi/orb/models/subscription_change_retrieve_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_response.rbi +806 -548
- data/rbi/{lib/orb/models/subscription_schedule_plan_change_params.rbi → orb/models/subscription_create_params.rbi} +8466 -7080
- data/rbi/{lib/orb → orb}/models/subscription_create_response.rbi +724 -462
- data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_params.rbi +47 -22
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +252 -0
- data/rbi/orb/models/subscription_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_params.rbi +20 -17
- data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_response.rbi +33 -19
- data/rbi/{lib/orb → orb}/models/subscription_fetch_usage_params.rbi +81 -34
- data/rbi/{lib/orb → orb}/models/subscription_list_params.rbi +39 -28
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_params.rbi +4973 -3944
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_response.rbi +744 -477
- data/rbi/{lib/orb/models/subscription_create_params.rbi → orb/models/subscription_schedule_plan_change_params.rbi} +8649 -7019
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_response.rbi +742 -491
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_params.rbi +16 -13
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_response.rbi +736 -472
- data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_response.rbi +743 -491
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +16 -5
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +717 -526
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_response.rbi +732 -521
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_params.rbi +57 -26
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_response.rbi +743 -491
- data/rbi/{lib/orb → orb}/models/subscription_update_params.rbi +19 -16
- data/rbi/orb/models/subscription_update_trial_params.rbi +104 -0
- data/rbi/{lib/orb → orb}/models/subscription_update_trial_response.rbi +736 -471
- data/rbi/orb/models/subscription_usage.rbi +446 -0
- data/rbi/orb/models/subscriptions.rbi +38 -0
- data/rbi/orb/models/top_level_ping_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/top_level_ping_response.rbi +7 -3
- data/rbi/{lib/orb → orb}/models/trial_discount.rbi +29 -20
- data/rbi/{lib/orb → orb}/models/usage_discount.rbi +28 -19
- data/rbi/orb/models.rbi +231 -0
- data/rbi/{lib/orb → orb}/request_options.rbi +12 -4
- data/rbi/{lib/orb → orb}/resources/alerts.rbi +57 -42
- data/rbi/{lib/orb → orb}/resources/coupons/subscriptions.rbi +7 -5
- data/rbi/{lib/orb → orb}/resources/coupons.rbi +25 -22
- data/rbi/{lib/orb → orb}/resources/credit_notes.rbi +18 -15
- data/rbi/{lib/orb → orb}/resources/customers/balance_transactions.rbi +17 -9
- data/rbi/{lib/orb → orb}/resources/customers/costs.rbi +18 -11
- data/rbi/{lib/orb → orb}/resources/customers/credits/ledger.rbi +98 -74
- data/rbi/{lib/orb → orb}/resources/customers/credits/top_ups.rbi +53 -29
- data/rbi/{lib/orb → orb}/resources/customers/credits.rbi +16 -7
- data/rbi/{lib/orb → orb}/resources/customers.rbi +117 -82
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +6 -5
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups.rbi +21 -14
- data/rbi/{lib/orb → orb}/resources/events/backfills.rbi +25 -20
- data/rbi/{lib/orb → orb}/resources/events/volume.rbi +7 -5
- data/rbi/{lib/orb → orb}/resources/events.rbi +22 -18
- data/rbi/{lib/orb → orb}/resources/invoice_line_items.rbi +7 -5
- data/rbi/{lib/orb → orb}/resources/invoices.rbi +55 -49
- data/rbi/{lib/orb → orb}/resources/items.rbi +31 -17
- data/rbi/{lib/orb → orb}/resources/metrics.rbi +21 -17
- data/rbi/{lib/orb → orb}/resources/plans/external_plan_id.rbi +11 -9
- data/rbi/{lib/orb → orb}/resources/plans.rbi +53 -49
- data/rbi/orb/resources/prices/external_price_id.rbi +108 -0
- data/rbi/{lib/orb → orb}/resources/prices.rbi +170 -157
- data/rbi/{lib/orb → orb}/resources/subscription_changes.rbi +15 -13
- data/rbi/{lib/orb → orb}/resources/subscriptions.rbi +188 -118
- data/rbi/{lib/orb → orb}/resources/top_level.rbi +7 -4
- data/sig/orb/internal/page.rbs +0 -2
- data/sig/orb/internal/type/request_parameters.rbs +3 -1
- data/sig/orb/internal/util.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 +7 -14
- 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 +36 -57
- 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 +36 -57
- data/sig/orb/models/customer_update_params.rbs +36 -57
- 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 +92 -134
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +92 -134
- 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 +92 -134
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +92 -134
- 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 +126 -188
- 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 +41 -103
- 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 +41 -75
- 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 +55 -83
- data/sig/orb/models/plan_create_params.rbs +568 -746
- 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 +1250 -1790
- 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 +72 -110
- data/sig/orb/models/subscription_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_cancel_response.rbs +44 -84
- data/sig/orb/models/subscription_change_apply_params.rbs +0 -2
- data/sig/orb/models/subscription_change_apply_response.rbs +44 -86
- data/sig/orb/models/subscription_change_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_change_cancel_response.rbs +44 -86
- data/sig/orb/models/subscription_change_retrieve_params.rbs +0 -2
- data/sig/orb/models/subscription_change_retrieve_response.rbs +44 -86
- data/sig/orb/models/subscription_create_params.rbs +1223 -1619
- data/sig/orb/models/subscription_create_response.rbs +44 -84
- 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 +738 -970
- data/sig/orb/models/subscription_price_intervals_response.rbs +44 -84
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1223 -1619
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +44 -84
- data/sig/orb/models/subscription_trigger_phase_params.rbs +0 -2
- data/sig/orb/models/subscription_trigger_phase_response.rbs +44 -84
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +44 -84
- 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 +44 -84
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +44 -84
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +0 -2
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +44 -84
- 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 +44 -84
- 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/models.rbs +215 -0
- 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 +226 -223
- data/rbi/lib/orb/internal/type/array_of.rbi +0 -90
- data/rbi/lib/orb/internal/type/request_parameters.rbi +0 -21
- data/rbi/lib/orb/internal/type/union.rbi +0 -75
- data/rbi/lib/orb/internal/type/unknown.rbi +0 -42
- data/rbi/lib/orb/internal/util.rbi +0 -299
- data/rbi/lib/orb/models/alert_retrieve_params.rbi +0 -18
- data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +0 -18
- data/rbi/lib/orb/models/coupon_archive_params.rbi +0 -18
- data/rbi/lib/orb/models/coupon_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/credit_note_create_params.rbi +0 -88
- data/rbi/lib/orb/models/credit_note_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/customer_delete_params.rbi +0 -18
- data/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi +0 -18
- data/rbi/lib/orb/models/customer_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +0 -18
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +0 -18
- data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +0 -65
- data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +0 -208
- data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +0 -196
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +0 -225
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +0 -223
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +0 -84
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +0 -166
- data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +0 -141
- data/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi +0 -26
- data/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi +0 -18
- data/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +0 -25
- data/rbi/lib/orb/models/dimensional_price_groups.rbi +0 -33
- data/rbi/lib/orb/models/discount.rbi +0 -17
- data/rbi/lib/orb/models/event_deprecate_params.rbi +0 -18
- data/rbi/lib/orb/models/events/backfill_close_params.rbi +0 -25
- data/rbi/lib/orb/models/events/backfill_fetch_params.rbi +0 -25
- data/rbi/lib/orb/models/events/backfill_revert_params.rbi +0 -25
- data/rbi/lib/orb/models/invoice_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi +0 -22
- data/rbi/lib/orb/models/invoice_level_discount.rbi +0 -15
- data/rbi/lib/orb/models/invoice_pay_params.rbi +0 -18
- data/rbi/lib/orb/models/invoice_void_params.rbi +0 -18
- data/rbi/lib/orb/models/item.rbi +0 -95
- data/rbi/lib/orb/models/item_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/item_update_params.rbi +0 -101
- data/rbi/lib/orb/models/metric_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/pagination_metadata.rbi +0 -19
- data/rbi/lib/orb/models/plan_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi +0 -25
- data/rbi/lib/orb/models/price.rbi +0 -14861
- data/rbi/lib/orb/models/price_evaluate_response.rbi +0 -19
- data/rbi/lib/orb/models/price_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi +0 -25
- data/rbi/lib/orb/models/subscription_change_cancel_params.rbi +0 -18
- data/rbi/lib/orb/models/subscription_change_retrieve_params.rbi +0 -18
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +0 -221
- data/rbi/lib/orb/models/subscription_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi +0 -18
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +0 -18
- data/rbi/lib/orb/models/subscription_update_trial_params.rbi +0 -66
- data/rbi/lib/orb/models/subscription_usage.rbi +0 -296
- data/rbi/lib/orb/models/subscriptions.rbi +0 -31
- data/rbi/lib/orb/models/top_level_ping_params.rbi +0 -18
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +0 -106
- /data/rbi/{lib/orb → orb}/internal.rbi +0 -0
- /data/rbi/{lib/orb → orb}/version.rbi +0 -0
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1a8aab7ea27e9f429fb79d85663cb238393ef06c60acb43e7c1f4285658cdd2f
|
4
|
+
data.tar.gz: b48c4f83c56e09e04e50e10bb89c865c5fb72143f4a42dbd96e83cc183975fa8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a5e2ba15a48f4b458f9758393a6f421d4b795e44b3ecf5f7f7e7dfdba71c139b26a229cd4956d2d4269d1f5df689e9fc583ced8da055ab59403f0372b24ed1d4
|
7
|
+
data.tar.gz: ca4923f45449e5f4187ad9bd4cabf2abbdea4c2e593f2f294607e1e2cf8ce5efe3e2f311ee2371a85cbf4ceba724fa2de98d30d9521fa8f10f9262214fd52a54
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,52 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## 0.3.2 (2025-05-07)
|
4
|
+
|
5
|
+
Full Changelog: [v0.3.1...v0.3.2](https://github.com/orbcorp/orb-ruby/compare/v0.3.1...v0.3.2)
|
6
|
+
|
7
|
+
### Bug Fixes
|
8
|
+
|
9
|
+
* **internal:** ensure formatting always uses c.utf-8 locale ([c4cc44a](https://github.com/orbcorp/orb-ruby/commit/c4cc44a8e280089938586de353b08e8091056ca0))
|
10
|
+
|
11
|
+
|
12
|
+
### Chores
|
13
|
+
|
14
|
+
* **internal:** version bump ([fede0e6](https://github.com/orbcorp/orb-ruby/commit/fede0e64ca4753cc961e8308ddcef2b39dcb6f24))
|
15
|
+
* revert ignoring Gemfile.lock ([e572719](https://github.com/orbcorp/orb-ruby/commit/e572719854490cfa7735dcc70d9cfd1dc4d4a122))
|
16
|
+
|
17
|
+
## 0.3.1 (2025-05-06)
|
18
|
+
|
19
|
+
Full Changelog: [v0.3.0...v0.3.1](https://github.com/orbcorp/orb-ruby/compare/v0.3.0...v0.3.1)
|
20
|
+
|
21
|
+
### Bug Fixes
|
22
|
+
|
23
|
+
* **internal:** fix formatting script for macos ([3d4e166](https://github.com/orbcorp/orb-ruby/commit/3d4e166f77e3e15037d1bd000f249fcb73cd216e))
|
24
|
+
|
25
|
+
|
26
|
+
### Chores
|
27
|
+
|
28
|
+
* add generator safe directory ([dc351bd](https://github.com/orbcorp/orb-ruby/commit/dc351bdabe5a44981c8461a5cf8249df075c513f))
|
29
|
+
* always check if current page is empty in `next_page?` ([eca7722](https://github.com/orbcorp/orb-ruby/commit/eca772296d3bae2ca18fb60afdb7e3b66a8ae6a8))
|
30
|
+
* **internal:** annotate request options with type aliases in sorbet ([85ddf12](https://github.com/orbcorp/orb-ruby/commit/85ddf1253cab3253c621fe5da2715c4332c88f22))
|
31
|
+
* **internal:** codegen related update ([43622bc](https://github.com/orbcorp/orb-ruby/commit/43622bc6158b0409520ddafb16b3348b04f133e4))
|
32
|
+
* **internal:** codegen related update ([4b21f9a](https://github.com/orbcorp/orb-ruby/commit/4b21f9ae7e8b1d36342b6f4e9e01901b6ea662d5))
|
33
|
+
* **internal:** codegen related update ([143f9a8](https://github.com/orbcorp/orb-ruby/commit/143f9a890045832dc6a4690b098a6f54c3d61cb1))
|
34
|
+
* **internal:** codegen related update ([25413e1](https://github.com/orbcorp/orb-ruby/commit/25413e1323f09ed82730671f199b7c4b81277230))
|
35
|
+
* **internal:** codegen related update ([6d43598](https://github.com/orbcorp/orb-ruby/commit/6d43598c8ffca3220257f5cd6c5e0cbaf78a8322))
|
36
|
+
* loosen rubocop rules that don't always make sense ([5a71c5b](https://github.com/orbcorp/orb-ruby/commit/5a71c5b9dce0d43b9ba5016cdcd0a1fe00c62ee6))
|
37
|
+
* migrate away from deprecated `JSON#fast_generate` ([6207686](https://github.com/orbcorp/orb-ruby/commit/6207686bfea6cd2504a4a2cc74ca766bc916cb95))
|
38
|
+
* more accurate type annotations and aliases ([5528e59](https://github.com/orbcorp/orb-ruby/commit/5528e59e7f77d948dcc3942efd7f0dbc1a167215))
|
39
|
+
* re-export top level models under library namespace ([95cbfd9](https://github.com/orbcorp/orb-ruby/commit/95cbfd9241828bee0e537b69d3a014a5394f8ba3))
|
40
|
+
* remove Gemfile.lock during bootstrap ([a369d56](https://github.com/orbcorp/orb-ruby/commit/a369d5679a808b24fa88d986898ad0168af90202))
|
41
|
+
* reorganize type aliases ([22b91f9](https://github.com/orbcorp/orb-ruby/commit/22b91f9837bb3fd5677cb1325f3c221ae80c8663))
|
42
|
+
* validate request option coercion correctness ([2ba6032](https://github.com/orbcorp/orb-ruby/commit/2ba6032243950cdef75e63ea75dd3865d79bca02))
|
43
|
+
|
44
|
+
|
45
|
+
### Documentation
|
46
|
+
|
47
|
+
* illustrate environmental defaults for auth variables ([34613d7](https://github.com/orbcorp/orb-ruby/commit/34613d75cd3baab105f5dc5f0d4f4c7bb1fe1e3e))
|
48
|
+
* **readme:** fix typo ([9229774](https://github.com/orbcorp/orb-ruby/commit/9229774479cb18ea70941da9652094d4f4b7bfe6))
|
49
|
+
|
3
50
|
## 0.3.0 (2025-04-25)
|
4
51
|
|
5
52
|
Full Changelog: [v0.2.0...v0.3.0](https://github.com/orbcorp/orb-ruby/compare/v0.2.0...v0.3.0)
|
data/README.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# Orb Ruby API library
|
2
2
|
|
3
|
-
The Orb Ruby library provides convenient access to the Orb REST API from any Ruby 3.
|
3
|
+
The Orb Ruby library provides convenient access to the Orb REST API from any Ruby 3.2.0+ application.
|
4
4
|
|
5
5
|
## Documentation
|
6
6
|
|
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
|
|
15
15
|
<!-- x-release-please-start-version -->
|
16
16
|
|
17
17
|
```ruby
|
18
|
-
gem "orb-billing", "~> 0.3.
|
18
|
+
gem "orb-billing", "~> 0.3.2"
|
19
19
|
```
|
20
20
|
|
21
21
|
<!-- x-release-please-end -->
|
@@ -27,7 +27,7 @@ require "bundler/setup"
|
|
27
27
|
require "orb"
|
28
28
|
|
29
29
|
orb = Orb::Client.new(
|
30
|
-
api_key: "
|
30
|
+
api_key: ENV["ORB_API_KEY"] # This is the default and can be omitted
|
31
31
|
)
|
32
32
|
|
33
33
|
customer = orb.customers.create(email: "example-customer@withorb.com", name: "My Customer")
|
@@ -76,7 +76,7 @@ rescue Orb::Errors::APIError => e
|
|
76
76
|
end
|
77
77
|
```
|
78
78
|
|
79
|
-
Error codes are as
|
79
|
+
Error codes are as follows:
|
80
80
|
|
81
81
|
| Cause | Error Type |
|
82
82
|
| ---------------- | -------------------------- |
|
@@ -200,9 +200,9 @@ Sorbet's typed enums require sub-classing of the [`T::Enum` class](https://sorbe
|
|
200
200
|
Since this library does not depend on `sorbet-runtime`, it uses a [`T.all` intersection type](https://sorbet.org/docs/intersection-types) with a ruby primitive type to construct a "tagged alias" instead.
|
201
201
|
|
202
202
|
```ruby
|
203
|
-
module Orb::
|
203
|
+
module Orb::BillingCycleRelativeDate
|
204
204
|
# This alias aids language service driven navigation.
|
205
|
-
TaggedSymbol = T.type_alias { T.all(Symbol, Orb::
|
205
|
+
TaggedSymbol = T.type_alias { T.all(Symbol, Orb::BillingCycleRelativeDate) }
|
206
206
|
end
|
207
207
|
```
|
208
208
|
|
@@ -223,7 +223,7 @@ This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` typ
|
|
223
223
|
|
224
224
|
## Requirements
|
225
225
|
|
226
|
-
Ruby 3.
|
226
|
+
Ruby 3.2.0 or higher.
|
227
227
|
|
228
228
|
## Contributing
|
229
229
|
|
data/lib/orb/errors.rb
CHANGED
@@ -3,9 +3,9 @@
|
|
3
3
|
module Orb
|
4
4
|
module Errors
|
5
5
|
class Error < StandardError
|
6
|
-
# @!
|
7
|
-
#
|
8
|
-
#
|
6
|
+
# @!attribute cause
|
7
|
+
#
|
8
|
+
# @return [StandardError, nil]
|
9
9
|
end
|
10
10
|
|
11
11
|
class ConversionError < Orb::Errors::Error
|
@@ -40,13 +40,13 @@ module Orb
|
|
40
40
|
end
|
41
41
|
|
42
42
|
class APIConnectionError < Orb::Errors::APIError
|
43
|
-
# @!
|
44
|
-
#
|
45
|
-
#
|
43
|
+
# @!attribute status
|
44
|
+
#
|
45
|
+
# @return [nil]
|
46
46
|
|
47
|
-
# @!
|
48
|
-
#
|
49
|
-
#
|
47
|
+
# @!attribute body
|
48
|
+
#
|
49
|
+
# @return [nil]
|
50
50
|
|
51
51
|
# @api private
|
52
52
|
#
|
data/lib/orb/file_part.rb
CHANGED
@@ -45,9 +45,9 @@ module Orb
|
|
45
45
|
@filename =
|
46
46
|
case content
|
47
47
|
in Pathname
|
48
|
-
filename.nil? ? content.basename.to_path : File.basename(filename)
|
48
|
+
filename.nil? ? content.basename.to_path : ::File.basename(filename)
|
49
49
|
else
|
50
|
-
filename.nil? ? nil : File.basename(filename)
|
50
|
+
filename.nil? ? nil : ::File.basename(filename)
|
51
51
|
end
|
52
52
|
@content_type = content_type
|
53
53
|
end
|
data/lib/orb/internal/page.rb
CHANGED
@@ -24,7 +24,7 @@ module Orb
|
|
24
24
|
|
25
25
|
# @return [Boolean]
|
26
26
|
def next_page?
|
27
|
-
!pagination_metadata&.next_cursor.
|
27
|
+
!data.to_a.empty? && !pagination_metadata&.next_cursor.to_s.empty?
|
28
28
|
end
|
29
29
|
|
30
30
|
# @raise [Orb::HTTP::Error]
|
@@ -66,8 +66,8 @@ module Orb
|
|
66
66
|
super
|
67
67
|
|
68
68
|
case page_data
|
69
|
-
in {data: Array
|
70
|
-
@data = data
|
69
|
+
in {data: Array => data}
|
70
|
+
@data = data.map { Orb::Internal::Type::Converter.coerce(@model, _1) }
|
71
71
|
else
|
72
72
|
end
|
73
73
|
case page_data
|
@@ -261,7 +261,7 @@ module Orb
|
|
261
261
|
headers["x-stainless-retry-count"] = "0"
|
262
262
|
end
|
263
263
|
|
264
|
-
timeout = opts.fetch(:timeout, @timeout).to_f.clamp(
|
264
|
+
timeout = opts.fetch(:timeout, @timeout).to_f.clamp(0..)
|
265
265
|
unless headers.key?("x-stainless-timeout") || timeout.zero?
|
266
266
|
headers["x-stainless-timeout"] = timeout.to_s
|
267
267
|
end
|
@@ -458,9 +458,9 @@ module Orb
|
|
458
458
|
|
459
459
|
decoded = Orb::Internal::Util.decode_content(response, stream: stream)
|
460
460
|
case req
|
461
|
-
in {
|
461
|
+
in {stream: Class => st}
|
462
462
|
st.new(model: model, url: url, status: status, response: response, stream: decoded)
|
463
|
-
in {
|
463
|
+
in {page: Class => page}
|
464
464
|
page.new(client: self, req: req, headers: response, page_data: decoded)
|
465
465
|
else
|
466
466
|
unwrapped = Orb::Internal::Util.dig(decoded, req[:unwrap])
|
@@ -390,15 +390,7 @@ module Orb
|
|
390
390
|
# Create a new instance of a model.
|
391
391
|
#
|
392
392
|
# @param data [Hash{Symbol=>Object}, self]
|
393
|
-
def initialize(data = {})
|
394
|
-
case Orb::Internal::Util.coerce_hash(data)
|
395
|
-
in Hash => coerced
|
396
|
-
@data = coerced
|
397
|
-
else
|
398
|
-
message = "Expected a #{Hash} or #{Orb::Internal::Type::BaseModel}, got #{data.inspect}"
|
399
|
-
raise ArgumentError.new(message)
|
400
|
-
end
|
401
|
-
end
|
393
|
+
def initialize(data = {}) = (@data = Orb::Internal::Util.coerce_hash!(data).to_h)
|
402
394
|
|
403
395
|
class << self
|
404
396
|
# @api private
|
@@ -46,17 +46,16 @@ module Orb
|
|
46
46
|
value
|
47
47
|
end
|
48
48
|
|
49
|
-
# @!
|
50
|
-
#
|
51
|
-
#
|
52
|
-
#
|
53
|
-
#
|
54
|
-
#
|
55
|
-
#
|
56
|
-
#
|
57
|
-
#
|
58
|
-
#
|
59
|
-
# def dump(value, state:) = super
|
49
|
+
# @!method dump(value, state:)
|
50
|
+
# @api private
|
51
|
+
#
|
52
|
+
# @param value [Boolean, Object]
|
53
|
+
#
|
54
|
+
# @param state [Hash{Symbol=>Object}] .
|
55
|
+
#
|
56
|
+
# @option state [Boolean] :can_retry
|
57
|
+
#
|
58
|
+
# @return [Boolean, Object]
|
60
59
|
end
|
61
60
|
end
|
62
61
|
end
|
@@ -17,11 +17,11 @@ module Orb
|
|
17
17
|
# values safely.
|
18
18
|
#
|
19
19
|
# @example
|
20
|
-
# # `billing_cycle_relative_date` is a `Orb::
|
20
|
+
# # `billing_cycle_relative_date` is a `Orb::BillingCycleRelativeDate`
|
21
21
|
# case billing_cycle_relative_date
|
22
|
-
# when Orb::
|
22
|
+
# when Orb::BillingCycleRelativeDate::START_OF_TERM
|
23
23
|
# # ...
|
24
|
-
# when Orb::
|
24
|
+
# when Orb::BillingCycleRelativeDate::END_OF_TERM
|
25
25
|
# # ...
|
26
26
|
# else
|
27
27
|
# puts(billing_cycle_relative_date)
|
@@ -96,17 +96,16 @@ module Orb
|
|
96
96
|
end
|
97
97
|
end
|
98
98
|
|
99
|
-
# @!
|
100
|
-
#
|
101
|
-
#
|
102
|
-
#
|
103
|
-
#
|
104
|
-
#
|
105
|
-
#
|
106
|
-
#
|
107
|
-
#
|
108
|
-
#
|
109
|
-
# def dump(value, state:) = super
|
99
|
+
# @!method dump(value, state:)
|
100
|
+
# @api private
|
101
|
+
#
|
102
|
+
# @param value [Symbol, Object]
|
103
|
+
#
|
104
|
+
# @param state [Hash{Symbol=>Object}] .
|
105
|
+
#
|
106
|
+
# @option state [Boolean] :can_retry
|
107
|
+
#
|
108
|
+
# @return [Symbol, Object]
|
110
109
|
|
111
110
|
# @api private
|
112
111
|
#
|
@@ -5,10 +5,10 @@ module Orb
|
|
5
5
|
module Type
|
6
6
|
# @api private
|
7
7
|
module RequestParameters
|
8
|
-
# @!
|
9
|
-
#
|
10
|
-
#
|
11
|
-
#
|
8
|
+
# @!attribute request_options
|
9
|
+
# Options to specify HTTP behaviour for this request.
|
10
|
+
#
|
11
|
+
# @return [Orb::RequestOptions, Hash{Symbol=>Object}]
|
12
12
|
|
13
13
|
# @param mod [Module]
|
14
14
|
def self.included(mod)
|
@@ -28,14 +28,8 @@ module Orb
|
|
28
28
|
state = {can_retry: true}
|
29
29
|
case (dumped = dump(params, state: state))
|
30
30
|
in Hash
|
31
|
-
options = Orb::Internal::Util.coerce_hash(dumped[:request_options])
|
32
|
-
request_options =
|
33
|
-
case [options, state.fetch(:can_retry)]
|
34
|
-
in [Hash | nil, false]
|
35
|
-
{**options.to_h, max_retries: 0}
|
36
|
-
else
|
37
|
-
options
|
38
|
-
end
|
31
|
+
options = Orb::Internal::Util.coerce_hash!(dumped[:request_options]).to_h
|
32
|
+
request_options = state.fetch(:can_retry) ? options : {**options, max_retries: 0}
|
39
33
|
[dumped.except(:request_options), request_options]
|
40
34
|
else
|
41
35
|
[dumped, nil]
|
@@ -6,13 +6,13 @@ module Orb
|
|
6
6
|
# @api private
|
7
7
|
#
|
8
8
|
# @example
|
9
|
-
# # `discount` is a `Orb::
|
9
|
+
# # `discount` is a `Orb::Discount`
|
10
10
|
# case discount
|
11
|
-
# when Orb::
|
11
|
+
# when Orb::PercentageDiscount
|
12
12
|
# puts(discount.applies_to_price_ids)
|
13
|
-
# when Orb::
|
13
|
+
# when Orb::TrialDiscount
|
14
14
|
# puts(discount.discount_type)
|
15
|
-
# when Orb::
|
15
|
+
# when Orb::UsageDiscount
|
16
16
|
# puts(discount.usage_discount)
|
17
17
|
# else
|
18
18
|
# puts(discount)
|
@@ -48,17 +48,16 @@ module Orb
|
|
48
48
|
value
|
49
49
|
end
|
50
50
|
|
51
|
-
# @!
|
52
|
-
#
|
53
|
-
#
|
54
|
-
#
|
55
|
-
#
|
56
|
-
#
|
57
|
-
#
|
58
|
-
#
|
59
|
-
#
|
60
|
-
#
|
61
|
-
# def dump(value, state:) = super
|
51
|
+
# @!method dump(value, state:)
|
52
|
+
# @api private
|
53
|
+
#
|
54
|
+
# @param value [Object]
|
55
|
+
#
|
56
|
+
# @param state [Hash{Symbol=>Object}] .
|
57
|
+
#
|
58
|
+
# @option state [Boolean] :can_retry
|
59
|
+
#
|
60
|
+
# @return [Object]
|
62
61
|
end
|
63
62
|
|
64
63
|
# rubocop:enable Lint/UnusedMethodArgument
|
data/lib/orb/internal/util.rb
CHANGED
@@ -128,6 +128,22 @@ module Orb
|
|
128
128
|
input.respond_to?(:to_h) ? input.to_h : input
|
129
129
|
end
|
130
130
|
end
|
131
|
+
|
132
|
+
# @api private
|
133
|
+
#
|
134
|
+
# @param input [Object]
|
135
|
+
#
|
136
|
+
# @raise [ArgumentError]
|
137
|
+
# @return [Hash{Object=>Object}, nil]
|
138
|
+
def coerce_hash!(input)
|
139
|
+
case coerce_hash(input)
|
140
|
+
in Hash | nil => coerced
|
141
|
+
coerced
|
142
|
+
else
|
143
|
+
message = "Expected a #{Hash} or #{Orb::Internal::Type::BaseModel}, got #{data.inspect}"
|
144
|
+
raise ArgumentError.new(message)
|
145
|
+
end
|
146
|
+
end
|
131
147
|
end
|
132
148
|
|
133
149
|
class << self
|
@@ -454,7 +470,7 @@ module Orb
|
|
454
470
|
# @type [Regexp]
|
455
471
|
JSON_CONTENT = %r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}
|
456
472
|
# @type [Regexp]
|
457
|
-
JSONL_CONTENT = %r{^application/(?:x-)?jsonl}
|
473
|
+
JSONL_CONTENT = %r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}
|
458
474
|
|
459
475
|
class << self
|
460
476
|
# @api private
|
@@ -493,7 +509,7 @@ module Orb
|
|
493
509
|
y << val.to_s
|
494
510
|
else
|
495
511
|
y << "Content-Type: application/json\r\n\r\n"
|
496
|
-
y << JSON.
|
512
|
+
y << JSON.generate(val)
|
497
513
|
end
|
498
514
|
y << "\r\n"
|
499
515
|
end
|
@@ -519,7 +535,7 @@ module Orb
|
|
519
535
|
filename = ERB::Util.url_encode(val.filename)
|
520
536
|
y << "; filename=\"#{filename}\""
|
521
537
|
in Pathname | IO
|
522
|
-
filename = ERB::Util.url_encode(File.basename(val.to_path))
|
538
|
+
filename = ERB::Util.url_encode(::File.basename(val.to_path))
|
523
539
|
y << "; filename=\"#{filename}\""
|
524
540
|
else
|
525
541
|
end
|
@@ -570,9 +586,9 @@ module Orb
|
|
570
586
|
content_type = headers["content-type"]
|
571
587
|
case [content_type, body]
|
572
588
|
in [Orb::Internal::Util::JSON_CONTENT, Hash | Array | -> { primitive?(_1) }]
|
573
|
-
[headers, JSON.
|
589
|
+
[headers, JSON.generate(body)]
|
574
590
|
in [Orb::Internal::Util::JSONL_CONTENT, Enumerable] unless body.is_a?(Orb::Internal::Type::FileInput)
|
575
|
-
[headers, body.lazy.map { JSON.
|
591
|
+
[headers, body.lazy.map { JSON.generate(_1) }]
|
576
592
|
in [%r{^multipart/form-data}, Hash | Orb::Internal::Type::FileInput]
|
577
593
|
boundary, strio = encode_multipart_streaming(body)
|
578
594
|
headers = {**headers, "content-type" => "#{content_type}; boundary=#{boundary}"}
|
data/lib/orb/models/alert.rb
CHANGED
@@ -25,8 +25,8 @@ module Orb
|
|
25
25
|
# @!attribute customer
|
26
26
|
# The customer the alert applies to.
|
27
27
|
#
|
28
|
-
# @return [Orb::
|
29
|
-
required :customer, -> { Orb::
|
28
|
+
# @return [Orb::Alert::Customer, nil]
|
29
|
+
required :customer, -> { Orb::Alert::Customer }, nil?: true
|
30
30
|
|
31
31
|
# @!attribute enabled
|
32
32
|
# Whether the alert is enabled or disabled.
|
@@ -37,37 +37,37 @@ module Orb
|
|
37
37
|
# @!attribute metric
|
38
38
|
# The metric the alert applies to.
|
39
39
|
#
|
40
|
-
# @return [Orb::
|
41
|
-
required :metric, -> { Orb::
|
40
|
+
# @return [Orb::Alert::Metric, nil]
|
41
|
+
required :metric, -> { Orb::Alert::Metric }, nil?: true
|
42
42
|
|
43
43
|
# @!attribute plan
|
44
44
|
# The plan the alert applies to.
|
45
45
|
#
|
46
|
-
# @return [Orb::
|
47
|
-
required :plan, -> { Orb::
|
46
|
+
# @return [Orb::Alert::Plan, nil]
|
47
|
+
required :plan, -> { Orb::Alert::Plan }, nil?: true
|
48
48
|
|
49
49
|
# @!attribute subscription
|
50
50
|
# The subscription the alert applies to.
|
51
51
|
#
|
52
|
-
# @return [Orb::
|
53
|
-
required :subscription, -> { Orb::
|
52
|
+
# @return [Orb::Alert::Subscription, nil]
|
53
|
+
required :subscription, -> { Orb::Alert::Subscription }, nil?: true
|
54
54
|
|
55
55
|
# @!attribute thresholds
|
56
56
|
# The thresholds that define the conditions under which the alert will be
|
57
57
|
# triggered.
|
58
58
|
#
|
59
|
-
# @return [Array<Orb::
|
60
|
-
required :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::
|
59
|
+
# @return [Array<Orb::Alert::Threshold>, nil]
|
60
|
+
required :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Alert::Threshold] }, nil?: true
|
61
61
|
|
62
62
|
# @!attribute type
|
63
63
|
# The type of alert. This must be a valid alert type.
|
64
64
|
#
|
65
|
-
# @return [Symbol, Orb::
|
66
|
-
required :type, enum: -> { Orb::
|
65
|
+
# @return [Symbol, Orb::Alert::Type]
|
66
|
+
required :type, enum: -> { Orb::Alert::Type }
|
67
67
|
|
68
68
|
# @!method initialize(id:, created_at:, currency:, customer:, enabled:, metric:, plan:, subscription:, thresholds:, type:)
|
69
|
-
# Some parameter documentations has been truncated, see {Orb::
|
70
|
-
#
|
69
|
+
# Some parameter documentations has been truncated, see {Orb::Alert} for more
|
70
|
+
# details.
|
71
71
|
#
|
72
72
|
# [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
|
73
73
|
# usage, or credit balance and trigger webhooks when a threshold is exceeded.
|
@@ -81,22 +81,21 @@ module Orb
|
|
81
81
|
#
|
82
82
|
# @param currency [String, nil] The name of the currency the credit balance or invoice cost is denominated in.
|
83
83
|
#
|
84
|
-
# @param customer [Orb::
|
84
|
+
# @param customer [Orb::Alert::Customer, nil] The customer the alert applies to.
|
85
85
|
#
|
86
86
|
# @param enabled [Boolean] Whether the alert is enabled or disabled.
|
87
87
|
#
|
88
|
-
# @param metric [Orb::
|
88
|
+
# @param metric [Orb::Alert::Metric, nil] The metric the alert applies to.
|
89
89
|
#
|
90
|
-
# @param plan [Orb::
|
90
|
+
# @param plan [Orb::Alert::Plan, nil] The plan the alert applies to.
|
91
91
|
#
|
92
|
-
# @param subscription [Orb::
|
92
|
+
# @param subscription [Orb::Alert::Subscription, nil] The subscription the alert applies to.
|
93
93
|
#
|
94
|
-
# @param thresholds [Array<Orb::
|
95
|
-
# ...
|
94
|
+
# @param thresholds [Array<Orb::Alert::Threshold>, nil] The thresholds that define the conditions under which the alert will be triggere
|
96
95
|
#
|
97
|
-
# @param type [Symbol, Orb::
|
96
|
+
# @param type [Symbol, Orb::Alert::Type] The type of alert. This must be a valid alert type.
|
98
97
|
|
99
|
-
# @see Orb::
|
98
|
+
# @see Orb::Alert#customer
|
100
99
|
class Customer < Orb::Internal::Type::BaseModel
|
101
100
|
# @!attribute id
|
102
101
|
#
|
@@ -115,7 +114,7 @@ module Orb
|
|
115
114
|
# @param external_customer_id [String, nil]
|
116
115
|
end
|
117
116
|
|
118
|
-
# @see Orb::
|
117
|
+
# @see Orb::Alert#metric
|
119
118
|
class Metric < Orb::Internal::Type::BaseModel
|
120
119
|
# @!attribute id
|
121
120
|
#
|
@@ -128,7 +127,7 @@ module Orb
|
|
128
127
|
# @param id [String]
|
129
128
|
end
|
130
129
|
|
131
|
-
# @see Orb::
|
130
|
+
# @see Orb::Alert#plan
|
132
131
|
class Plan < Orb::Internal::Type::BaseModel
|
133
132
|
# @!attribute id
|
134
133
|
#
|
@@ -154,22 +153,21 @@ module Orb
|
|
154
153
|
required :plan_version, String
|
155
154
|
|
156
155
|
# @!method initialize(id:, external_plan_id:, name:, plan_version:)
|
157
|
-
# Some parameter documentations has been truncated, see {Orb::
|
158
|
-
#
|
156
|
+
# Some parameter documentations has been truncated, see {Orb::Alert::Plan} for
|
157
|
+
# more details.
|
159
158
|
#
|
160
159
|
# The plan the alert applies to.
|
161
160
|
#
|
162
161
|
# @param id [String, nil]
|
163
162
|
#
|
164
163
|
# @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
|
165
|
-
# ...
|
166
164
|
#
|
167
165
|
# @param name [String, nil]
|
168
166
|
#
|
169
167
|
# @param plan_version [String]
|
170
168
|
end
|
171
169
|
|
172
|
-
# @see Orb::
|
170
|
+
# @see Orb::Alert#subscription
|
173
171
|
class Subscription < Orb::Internal::Type::BaseModel
|
174
172
|
# @!attribute id
|
175
173
|
#
|
@@ -192,19 +190,18 @@ module Orb
|
|
192
190
|
required :value, Float
|
193
191
|
|
194
192
|
# @!method initialize(value:)
|
195
|
-
# Some parameter documentations has been truncated, see
|
196
|
-
#
|
193
|
+
# Some parameter documentations has been truncated, see {Orb::Alert::Threshold}
|
194
|
+
# for more details.
|
197
195
|
#
|
198
196
|
# Thresholds are used to define the conditions under which an alert will be
|
199
197
|
# triggered.
|
200
198
|
#
|
201
199
|
# @param value [Float] The value at which an alert will fire. For credit balance alerts, the alert will
|
202
|
-
# ...
|
203
200
|
end
|
204
201
|
|
205
202
|
# The type of alert. This must be a valid alert type.
|
206
203
|
#
|
207
|
-
# @see Orb::
|
204
|
+
# @see Orb::Alert#type
|
208
205
|
module Type
|
209
206
|
extend Orb::Internal::Type::Enum
|
210
207
|
|
@@ -16,23 +16,23 @@ module Orb
|
|
16
16
|
# @!attribute type
|
17
17
|
# The type of alert to create. This must be a valid alert type.
|
18
18
|
#
|
19
|
-
# @return [Symbol, Orb::
|
20
|
-
required :type, enum: -> { Orb::
|
19
|
+
# @return [Symbol, Orb::AlertCreateForCustomerParams::Type]
|
20
|
+
required :type, enum: -> { Orb::AlertCreateForCustomerParams::Type }
|
21
21
|
|
22
22
|
# @!attribute thresholds
|
23
23
|
# The thresholds that define the values at which the alert will be triggered.
|
24
24
|
#
|
25
|
-
# @return [Array<Orb::
|
25
|
+
# @return [Array<Orb::AlertCreateForCustomerParams::Threshold>, nil]
|
26
26
|
optional :thresholds,
|
27
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::
|
27
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::AlertCreateForCustomerParams::Threshold] },
|
28
28
|
nil?: true
|
29
29
|
|
30
30
|
# @!method initialize(currency:, type:, thresholds: nil, request_options: {})
|
31
31
|
# @param currency [String] The case sensitive currency or custom pricing unit to use for this alert.
|
32
32
|
#
|
33
|
-
# @param type [Symbol, Orb::
|
33
|
+
# @param type [Symbol, Orb::AlertCreateForCustomerParams::Type] The type of alert to create. This must be a valid alert type.
|
34
34
|
#
|
35
|
-
# @param thresholds [Array<Orb::
|
35
|
+
# @param thresholds [Array<Orb::AlertCreateForCustomerParams::Threshold>, nil] The thresholds that define the values at which the alert will be triggered.
|
36
36
|
#
|
37
37
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
38
38
|
|
@@ -59,13 +59,12 @@ module Orb
|
|
59
59
|
|
60
60
|
# @!method initialize(value:)
|
61
61
|
# Some parameter documentations has been truncated, see
|
62
|
-
# {Orb::
|
62
|
+
# {Orb::AlertCreateForCustomerParams::Threshold} for more details.
|
63
63
|
#
|
64
64
|
# Thresholds are used to define the conditions under which an alert will be
|
65
65
|
# triggered.
|
66
66
|
#
|
67
67
|
# @param value [Float] The value at which an alert will fire. For credit balance alerts, the alert will
|
68
|
-
# ...
|
69
68
|
end
|
70
69
|
end
|
71
70
|
end
|