orb-billing 0.1.0.pre.alpha.38 → 0.1.0.pre.alpha.39
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/README.md +1 -1
- data/lib/orb/client.rb +4 -0
- data/lib/orb/internal/transport/base_client.rb +1 -1
- data/lib/orb/internal/transport/pooled_net_requester.rb +1 -1
- data/lib/orb/internal/type/base_model.rb +14 -17
- data/lib/orb/internal/type/converter.rb +20 -22
- data/lib/orb/internal/type/enum.rb +8 -8
- data/lib/orb/internal/util.rb +1 -5
- data/lib/orb/models/alert.rb +9 -9
- data/lib/orb/models/alert_create_for_customer_params.rb +3 -3
- data/lib/orb/models/alert_create_for_external_customer_params.rb +3 -3
- data/lib/orb/models/alert_create_for_subscription_params.rb +3 -3
- data/lib/orb/models/alert_list_params.rb +5 -5
- data/lib/orb/models/alert_update_params.rb +3 -3
- data/lib/orb/models/amount_discount.rb +1 -1
- data/lib/orb/models/billable_metric.rb +7 -7
- data/lib/orb/models/coupon.rb +7 -7
- data/lib/orb/models/coupon_create_params.rb +2 -2
- data/lib/orb/models/coupon_list_params.rb +2 -2
- data/lib/orb/models/coupons/subscription_list_params.rb +1 -1
- data/lib/orb/models/credit_note.rb +1 -1
- data/lib/orb/models/credit_note_list_params.rb +5 -5
- data/lib/orb/models/customer.rb +232 -232
- data/lib/orb/models/customer_create_params.rb +223 -223
- data/lib/orb/models/customer_list_params.rb +5 -5
- data/lib/orb/models/customer_update_by_external_id_params.rb +224 -224
- data/lib/orb/models/customer_update_params.rb +224 -224
- data/lib/orb/models/customers/balance_transaction_create_response.rb +2 -2
- data/lib/orb/models/customers/balance_transaction_list_params.rb +5 -5
- data/lib/orb/models/customers/balance_transaction_list_response.rb +2 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +6 -6
- data/lib/orb/models/customers/cost_list_params.rb +6 -6
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +2 -2
- data/lib/orb/models/customers/credit_list_params.rb +2 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +20 -20
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +20 -20
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +5 -5
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_list_params.rb +5 -5
- data/lib/orb/models/customers/credits/ledger_list_response.rb +22 -22
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +8 -8
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +7 -7
- data/lib/orb/models/customers/credits/top_up_create_params.rb +8 -8
- data/lib/orb/models/customers/credits/top_up_create_response.rb +7 -7
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +1 -1
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +7 -7
- data/lib/orb/models/customers/credits/top_up_list_params.rb +1 -1
- data/lib/orb/models/customers/credits/top_up_list_response.rb +7 -7
- data/lib/orb/models/dimensional_price_group.rb +7 -7
- data/lib/orb/models/dimensional_price_group_create_params.rb +2 -2
- data/lib/orb/models/dimensional_price_group_list_params.rb +1 -1
- data/lib/orb/models/event_ingest_params.rb +7 -7
- data/lib/orb/models/event_ingest_response.rb +4 -4
- data/lib/orb/models/event_search_params.rb +5 -5
- data/lib/orb/models/event_search_response.rb +8 -8
- data/lib/orb/models/event_update_params.rb +4 -4
- data/lib/orb/models/events/backfill_close_response.rb +7 -7
- data/lib/orb/models/events/backfill_create_params.rb +11 -11
- data/lib/orb/models/events/backfill_create_response.rb +7 -7
- data/lib/orb/models/events/backfill_fetch_response.rb +7 -7
- data/lib/orb/models/events/backfill_list_params.rb +1 -1
- data/lib/orb/models/events/backfill_list_response.rb +7 -7
- data/lib/orb/models/events/backfill_revert_response.rb +7 -7
- data/lib/orb/models/events/event_volumes.rb +1 -1
- data/lib/orb/models/events/volume_list_params.rb +7 -7
- data/lib/orb/models/invoice.rb +270 -270
- data/lib/orb/models/invoice_create_params.rb +12 -11
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +266 -266
- data/lib/orb/models/invoice_issue_params.rb +4 -4
- data/lib/orb/models/invoice_line_item_create_params.rb +1 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +27 -27
- data/lib/orb/models/invoice_list_params.rb +12 -12
- data/lib/orb/models/invoice_update_params.rb +2 -2
- data/lib/orb/models/item.rb +2 -2
- data/lib/orb/models/item_list_params.rb +1 -1
- data/lib/orb/models/metric_create_params.rb +2 -2
- data/lib/orb/models/metric_list_params.rb +5 -5
- data/lib/orb/models/metric_update_params.rb +2 -2
- data/lib/orb/models/percentage_discount.rb +2 -2
- data/lib/orb/models/plan.rb +35 -35
- data/lib/orb/models/plan_create_params.rb +267 -267
- data/lib/orb/models/plan_list_params.rb +5 -5
- data/lib/orb/models/plan_update_params.rb +4 -4
- data/lib/orb/models/plans/external_plan_id_update_params.rb +4 -4
- data/lib/orb/models/price.rb +158 -158
- data/lib/orb/models/price_create_params.rb +20 -20
- data/lib/orb/models/price_evaluate_params.rb +4 -4
- data/lib/orb/models/price_list_params.rb +1 -1
- data/lib/orb/models/price_update_params.rb +2 -2
- data/lib/orb/models/prices/external_price_id_update_params.rb +2 -2
- data/lib/orb/models/subscription.rb +114 -87
- data/lib/orb/models/subscription_cancel_params.rb +3 -3
- data/lib/orb/models/subscription_cancel_response.rb +150 -72
- data/lib/orb/models/subscription_change_apply_params.rb +33 -0
- data/lib/orb/models/subscription_change_apply_response.rb +1372 -0
- data/lib/orb/models/subscription_change_cancel_params.rb +19 -0
- data/lib/orb/models/subscription_change_cancel_response.rb +1372 -0
- data/lib/orb/models/subscription_change_retrieve_params.rb +19 -0
- data/lib/orb/models/subscription_change_retrieve_response.rb +1372 -0
- data/lib/orb/models/subscription_create_params.rb +641 -641
- data/lib/orb/models/subscription_create_response.rb +150 -72
- data/lib/orb/models/subscription_fetch_costs_params.rb +6 -6
- data/lib/orb/models/subscription_fetch_schedule_params.rb +5 -5
- data/lib/orb/models/subscription_fetch_schedule_response.rb +2 -2
- data/lib/orb/models/subscription_fetch_usage_params.rb +8 -8
- data/lib/orb/models/subscription_list_params.rb +5 -5
- data/lib/orb/models/subscription_price_intervals_params.rb +323 -323
- data/lib/orb/models/subscription_price_intervals_response.rb +152 -72
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +651 -651
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +152 -72
- data/lib/orb/models/subscription_trigger_phase_params.rb +3 -3
- data/lib/orb/models/subscription_trigger_phase_response.rb +152 -72
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +152 -72
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +153 -73
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +152 -72
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +8 -8
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +152 -72
- data/lib/orb/models/subscription_update_params.rb +10 -10
- data/lib/orb/models/subscription_update_trial_params.rb +3 -3
- data/lib/orb/models/subscription_update_trial_response.rb +152 -72
- data/lib/orb/models/trial_discount.rb +1 -1
- data/lib/orb/models/usage_discount.rb +2 -2
- data/lib/orb/request_options.rb +7 -7
- data/lib/orb/resources/alerts.rb +38 -38
- data/lib/orb/resources/coupons/subscriptions.rb +3 -3
- data/lib/orb/resources/coupons.rb +9 -9
- data/lib/orb/resources/credit_notes.rb +8 -8
- data/lib/orb/resources/customers/balance_transactions.rb +26 -26
- data/lib/orb/resources/customers/costs.rb +232 -232
- data/lib/orb/resources/customers/credits/ledger.rb +344 -344
- data/lib/orb/resources/customers/credits/top_ups.rb +12 -12
- data/lib/orb/resources/customers/credits.rb +8 -8
- data/lib/orb/resources/customers.rb +59 -59
- data/lib/orb/resources/dimensional_price_groups.rb +6 -6
- data/lib/orb/resources/events/backfills.rb +49 -49
- data/lib/orb/resources/events/volume.rb +10 -10
- data/lib/orb/resources/events.rb +295 -295
- data/lib/orb/resources/invoice_line_items.rb +1 -1
- data/lib/orb/resources/invoices.rb +38 -38
- data/lib/orb/resources/items.rb +1 -1
- data/lib/orb/resources/metrics.rb +11 -11
- data/lib/orb/resources/plans/external_plan_id.rb +14 -14
- data/lib/orb/resources/plans.rb +22 -22
- data/lib/orb/resources/prices/external_price_id.rb +4 -4
- data/lib/orb/resources/prices.rb +30 -30
- data/lib/orb/resources/subscription_changes.rb +87 -0
- data/lib/orb/resources/subscriptions.rb +813 -813
- data/lib/orb/resources/top_level.rb +4 -4
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +7 -0
- data/rbi/lib/orb/client.rbi +5 -4
- data/rbi/lib/orb/errors.rbi +3 -6
- data/rbi/lib/orb/internal/page.rbi +3 -6
- data/rbi/lib/orb/internal/transport/base_client.rbi +13 -27
- data/rbi/lib/orb/internal/transport/pooled_net_requester.rbi +7 -13
- data/rbi/lib/orb/internal/type/array_of.rbi +8 -16
- data/rbi/lib/orb/internal/type/base_model.rbi +45 -64
- data/rbi/lib/orb/internal/type/base_page.rbi +5 -10
- data/rbi/lib/orb/internal/type/boolean.rbi +4 -8
- data/rbi/lib/orb/internal/type/converter.rbi +25 -31
- data/rbi/lib/orb/internal/type/enum.rbi +14 -20
- data/rbi/lib/orb/internal/type/hash_of.rbi +8 -16
- data/rbi/lib/orb/internal/type/request_parameters.rbi +1 -2
- data/rbi/lib/orb/internal/type/union.rbi +10 -20
- data/rbi/lib/orb/internal/type/unknown.rbi +4 -8
- data/rbi/lib/orb/internal/util.rbi +34 -68
- data/rbi/lib/orb/internal.rbi +1 -1
- data/rbi/lib/orb/models/alert.rbi +21 -33
- data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +8 -13
- data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +8 -13
- data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +8 -13
- data/rbi/lib/orb/models/alert_disable_params.rbi +2 -4
- data/rbi/lib/orb/models/alert_enable_params.rbi +2 -4
- data/rbi/lib/orb/models/alert_list_params.rbi +3 -6
- data/rbi/lib/orb/models/alert_retrieve_params.rbi +2 -4
- data/rbi/lib/orb/models/alert_update_params.rbi +7 -11
- data/rbi/lib/orb/models/amount_discount.rbi +4 -7
- data/rbi/lib/orb/models/billable_metric.rbi +10 -13
- data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -2
- data/rbi/lib/orb/models/coupon.rbi +9 -11
- data/rbi/lib/orb/models/coupon_archive_params.rbi +2 -4
- data/rbi/lib/orb/models/coupon_create_params.rbi +8 -14
- data/rbi/lib/orb/models/coupon_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/coupon_list_params.rbi +3 -4
- data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +3 -5
- data/rbi/lib/orb/models/credit_note.rbi +22 -45
- data/rbi/lib/orb/models/credit_note_create_params.rbi +5 -10
- data/rbi/lib/orb/models/credit_note_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -6
- data/rbi/lib/orb/models/customer.rbi +256 -281
- data/rbi/lib/orb/models/customer_create_params.rbi +251 -276
- data/rbi/lib/orb/models/customer_delete_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_list_params.rbi +3 -6
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +252 -277
- data/rbi/lib/orb/models/customer_update_params.rbi +252 -277
- data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +3 -6
- data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +10 -19
- data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -6
- data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +10 -19
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +8 -10
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +6 -12
- data/rbi/lib/orb/models/customers/cost_list_params.rbi +8 -10
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +6 -12
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +3 -4
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +2 -4
- data/rbi/lib/orb/models/customers/credit_list_params.rbi +3 -4
- data/rbi/lib/orb/models/customers/credit_list_response.rbi +2 -4
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +26 -33
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +79 -136
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +26 -33
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +78 -135
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +5 -10
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +79 -136
- data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +5 -10
- data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +74 -131
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +13 -19
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +12 -18
- data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +13 -19
- data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +12 -18
- data/rbi/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +2 -4
- data/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi +2 -4
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +3 -5
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +12 -18
- data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +3 -5
- data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +12 -18
- data/rbi/lib/orb/models/dimensional_price_group.rbi +8 -9
- data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -7
- data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +3 -5
- data/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi +2 -4
- data/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +2 -4
- data/rbi/lib/orb/models/dimensional_price_groups.rbi +2 -4
- data/rbi/lib/orb/models/discount.rbi +1 -2
- data/rbi/lib/orb/models/evaluate_price_group.rbi +3 -6
- data/rbi/lib/orb/models/event_deprecate_params.rbi +2 -4
- data/rbi/lib/orb/models/event_deprecate_response.rbi +2 -4
- data/rbi/lib/orb/models/event_ingest_params.rbi +10 -13
- data/rbi/lib/orb/models/event_ingest_response.rbi +10 -16
- data/rbi/lib/orb/models/event_search_params.rbi +7 -9
- data/rbi/lib/orb/models/event_search_response.rbi +11 -14
- data/rbi/lib/orb/models/event_update_params.rbi +5 -6
- data/rbi/lib/orb/models/event_update_response.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_close_params.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_close_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_create_params.rbi +13 -16
- data/rbi/lib/orb/models/events/backfill_create_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_list_params.rbi +3 -5
- data/rbi/lib/orb/models/events/backfill_list_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_revert_params.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_revert_response.rbi +10 -14
- data/rbi/lib/orb/models/events/event_volumes.rbi +5 -9
- data/rbi/lib/orb/models/events/volume_list_params.rbi +9 -11
- data/rbi/lib/orb/models/invoice.rbi +388 -465
- data/rbi/lib/orb/models/invoice_create_params.rbi +19 -26
- data/rbi/lib/orb/models/invoice_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +381 -460
- data/rbi/lib/orb/models/invoice_issue_params.rbi +6 -8
- data/rbi/lib/orb/models/invoice_level_discount.rbi +1 -2
- data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +3 -5
- data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +101 -143
- data/rbi/lib/orb/models/invoice_list_params.rbi +8 -13
- data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_pay_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_update_params.rbi +4 -6
- data/rbi/lib/orb/models/invoice_void_params.rbi +2 -4
- data/rbi/lib/orb/models/item.rbi +7 -12
- data/rbi/lib/orb/models/item_create_params.rbi +2 -4
- data/rbi/lib/orb/models/item_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/item_list_params.rbi +3 -5
- data/rbi/lib/orb/models/item_update_params.rbi +5 -10
- data/rbi/lib/orb/models/metric_create_params.rbi +4 -6
- data/rbi/lib/orb/models/metric_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/metric_list_params.rbi +3 -6
- data/rbi/lib/orb/models/metric_update_params.rbi +4 -6
- data/rbi/lib/orb/models/pagination_metadata.rbi +2 -4
- data/rbi/lib/orb/models/percentage_discount.rbi +5 -8
- data/rbi/lib/orb/models/plan.rbi +180 -219
- data/rbi/lib/orb/models/plan_create_params.rbi +670 -951
- data/rbi/lib/orb/models/plan_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/plan_list_params.rbi +4 -8
- data/rbi/lib/orb/models/plan_update_params.rbi +6 -8
- data/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +6 -8
- data/rbi/lib/orb/models/price.rbi +827 -1494
- data/rbi/lib/orb/models/price_create_params.rbi +60 -101
- data/rbi/lib/orb/models/price_evaluate_params.rbi +6 -9
- data/rbi/lib/orb/models/price_evaluate_response.rbi +2 -4
- data/rbi/lib/orb/models/price_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/price_list_params.rbi +3 -5
- data/rbi/lib/orb/models/price_update_params.rbi +4 -6
- data/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +4 -6
- data/rbi/lib/orb/models/subscription.rbi +167 -187
- data/rbi/lib/orb/models/subscription_cancel_params.rbi +5 -7
- data/rbi/lib/orb/models/subscription_cancel_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_change_apply_params.rbi +40 -0
- data/rbi/lib/orb/models/subscription_change_apply_response.rbi +1554 -0
- data/rbi/lib/orb/models/subscription_change_cancel_params.rbi +18 -0
- data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +1565 -0
- data/rbi/lib/orb/models/subscription_change_retrieve_params.rbi +18 -0
- data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +1581 -0
- data/rbi/lib/orb/models/subscription_create_params.rbi +1372 -1968
- data/rbi/lib/orb/models/subscription_create_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +8 -10
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +6 -12
- data/rbi/lib/orb/models/subscription_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -6
- data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +6 -10
- data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +12 -17
- data/rbi/lib/orb/models/subscription_list_params.rbi +4 -8
- data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +772 -1124
- data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +228 -178
- data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +1396 -1993
- data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +238 -182
- data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +5 -7
- data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +238 -182
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +265 -199
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +264 -198
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -15
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +238 -182
- data/rbi/lib/orb/models/subscription_update_params.rbi +12 -15
- data/rbi/lib/orb/models/subscription_update_trial_params.rbi +6 -9
- data/rbi/lib/orb/models/subscription_update_trial_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_usage.rbi +24 -43
- data/rbi/lib/orb/models/subscriptions.rbi +2 -4
- data/rbi/lib/orb/models/top_level_ping_params.rbi +2 -4
- data/rbi/lib/orb/models/top_level_ping_response.rbi +2 -4
- data/rbi/lib/orb/models/trial_discount.rbi +4 -8
- data/rbi/lib/orb/models/usage_discount.rbi +5 -8
- data/rbi/lib/orb/request_options.rbi +9 -11
- data/rbi/lib/orb/resources/alerts.rbi +44 -60
- data/rbi/lib/orb/resources/coupons/subscriptions.rbi +6 -9
- data/rbi/lib/orb/resources/coupons.rbi +18 -25
- data/rbi/lib/orb/resources/credit_notes.rbi +9 -15
- data/rbi/lib/orb/resources/customers/balance_transactions.rbi +26 -31
- data/rbi/lib/orb/resources/customers/costs.rbi +241 -246
- data/rbi/lib/orb/resources/customers/credits/ledger.rbi +387 -396
- data/rbi/lib/orb/resources/customers/credits/top_ups.rbi +29 -40
- data/rbi/lib/orb/resources/customers/credits.rbi +15 -20
- data/rbi/lib/orb/resources/customers.rbi +407 -417
- data/rbi/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +2 -4
- data/rbi/lib/orb/resources/dimensional_price_groups.rbi +13 -19
- data/rbi/lib/orb/resources/events/backfills.rbi +61 -69
- data/rbi/lib/orb/resources/events/volume.rbi +19 -22
- data/rbi/lib/orb/resources/events.rbi +311 -319
- data/rbi/lib/orb/resources/invoice_line_items.rbi +4 -7
- data/rbi/lib/orb/resources/invoices.rbi +62 -76
- data/rbi/lib/orb/resources/items.rbi +7 -14
- data/rbi/lib/orb/resources/metrics.rbi +17 -25
- data/rbi/lib/orb/resources/plans/external_plan_id.rbi +21 -25
- data/rbi/lib/orb/resources/plans.rbi +63 -71
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +9 -13
- data/rbi/lib/orb/resources/prices.rbi +77 -87
- data/rbi/lib/orb/resources/subscription_changes.rbi +61 -0
- data/rbi/lib/orb/resources/subscriptions.rbi +933 -963
- data/rbi/lib/orb/resources/top_level.rbi +6 -8
- data/sig/orb/client.rbs +2 -0
- data/sig/orb/models/subscription.rbs +14 -0
- data/sig/orb/models/subscription_cancel_response.rbs +47 -2
- data/sig/orb/models/subscription_change_apply_params.rbs +24 -0
- data/sig/orb/models/subscription_change_apply_response.rbs +784 -0
- data/sig/orb/models/subscription_change_cancel_params.rbs +15 -0
- data/sig/orb/models/subscription_change_cancel_response.rbs +784 -0
- data/sig/orb/models/subscription_change_retrieve_params.rbs +15 -0
- data/sig/orb/models/subscription_change_retrieve_response.rbs +784 -0
- data/sig/orb/models/subscription_create_response.rbs +47 -2
- data/sig/orb/models/subscription_price_intervals_response.rbs +47 -2
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +47 -2
- data/sig/orb/models/subscription_trigger_phase_response.rbs +47 -2
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +47 -2
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +47 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +47 -2
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +47 -2
- data/sig/orb/models/subscription_update_trial_response.rbs +47 -2
- data/sig/orb/resources/customers.rbs +2 -2
- data/sig/orb/resources/subscription_changes.rbs +24 -0
- metadata +23 -2
@@ -48,7 +48,7 @@ module Orb
|
|
48
48
|
attr_writer :subscription
|
49
49
|
|
50
50
|
# The thresholds that define the conditions under which the alert will be
|
51
|
-
#
|
51
|
+
# triggered.
|
52
52
|
sig { returns(T.nilable(T::Array[Orb::Models::Alert::Threshold])) }
|
53
53
|
attr_accessor :thresholds
|
54
54
|
|
@@ -57,10 +57,10 @@ module Orb
|
|
57
57
|
attr_accessor :type
|
58
58
|
|
59
59
|
# [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
|
60
|
-
#
|
60
|
+
# usage, or credit balance and trigger webhooks when a threshold is exceeded.
|
61
61
|
#
|
62
|
-
#
|
63
|
-
#
|
62
|
+
# Alerts created through the API can be scoped to either customers or
|
63
|
+
# subscriptions.
|
64
64
|
sig do
|
65
65
|
params(
|
66
66
|
id: String,
|
@@ -107,8 +107,7 @@ module Orb
|
|
107
107
|
}
|
108
108
|
)
|
109
109
|
end
|
110
|
-
def to_hash
|
111
|
-
end
|
110
|
+
def to_hash; end
|
112
111
|
|
113
112
|
class Customer < Orb::Internal::Type::BaseModel
|
114
113
|
sig { returns(String) }
|
@@ -119,12 +118,10 @@ module Orb
|
|
119
118
|
|
120
119
|
# The customer the alert applies to.
|
121
120
|
sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) }
|
122
|
-
def self.new(id:, external_customer_id:)
|
123
|
-
end
|
121
|
+
def self.new(id:, external_customer_id:); end
|
124
122
|
|
125
123
|
sig { override.returns({id: String, external_customer_id: T.nilable(String)}) }
|
126
|
-
def to_hash
|
127
|
-
end
|
124
|
+
def to_hash; end
|
128
125
|
end
|
129
126
|
|
130
127
|
class Metric < Orb::Internal::Type::BaseModel
|
@@ -133,12 +130,10 @@ module Orb
|
|
133
130
|
|
134
131
|
# The metric the alert applies to.
|
135
132
|
sig { params(id: String).returns(T.attached_class) }
|
136
|
-
def self.new(id:)
|
137
|
-
end
|
133
|
+
def self.new(id:); end
|
138
134
|
|
139
135
|
sig { override.returns({id: String}) }
|
140
|
-
def to_hash
|
141
|
-
end
|
136
|
+
def to_hash; end
|
142
137
|
end
|
143
138
|
|
144
139
|
class Plan < Orb::Internal::Type::BaseModel
|
@@ -146,8 +141,8 @@ module Orb
|
|
146
141
|
attr_accessor :id
|
147
142
|
|
148
143
|
# An optional user-defined ID for this plan resource, used throughout the system
|
149
|
-
#
|
150
|
-
#
|
144
|
+
# as an alias for this Plan. Use this field to identify a plan by an existing
|
145
|
+
# identifier in your system.
|
151
146
|
sig { returns(T.nilable(String)) }
|
152
147
|
attr_accessor :external_plan_id
|
153
148
|
|
@@ -167,8 +162,7 @@ module Orb
|
|
167
162
|
)
|
168
163
|
.returns(T.attached_class)
|
169
164
|
end
|
170
|
-
def self.new(id:, external_plan_id:, name:, plan_version:)
|
171
|
-
end
|
165
|
+
def self.new(id:, external_plan_id:, name:, plan_version:); end
|
172
166
|
|
173
167
|
sig do
|
174
168
|
override
|
@@ -181,8 +175,7 @@ module Orb
|
|
181
175
|
}
|
182
176
|
)
|
183
177
|
end
|
184
|
-
def to_hash
|
185
|
-
end
|
178
|
+
def to_hash; end
|
186
179
|
end
|
187
180
|
|
188
181
|
class Subscription < Orb::Internal::Type::BaseModel
|
@@ -191,30 +184,26 @@ module Orb
|
|
191
184
|
|
192
185
|
# The subscription the alert applies to.
|
193
186
|
sig { params(id: String).returns(T.attached_class) }
|
194
|
-
def self.new(id:)
|
195
|
-
end
|
187
|
+
def self.new(id:); end
|
196
188
|
|
197
189
|
sig { override.returns({id: String}) }
|
198
|
-
def to_hash
|
199
|
-
end
|
190
|
+
def to_hash; end
|
200
191
|
end
|
201
192
|
|
202
193
|
class Threshold < Orb::Internal::Type::BaseModel
|
203
194
|
# The value at which an alert will fire. For credit balance alerts, the alert will
|
204
|
-
#
|
205
|
-
#
|
195
|
+
# fire at or below this value. For usage and cost alerts, the alert will fire at
|
196
|
+
# or above this value.
|
206
197
|
sig { returns(Float) }
|
207
198
|
attr_accessor :value
|
208
199
|
|
209
200
|
# Thresholds are used to define the conditions under which an alert will be
|
210
|
-
#
|
201
|
+
# triggered.
|
211
202
|
sig { params(value: Float).returns(T.attached_class) }
|
212
|
-
def self.new(value:)
|
213
|
-
end
|
203
|
+
def self.new(value:); end
|
214
204
|
|
215
205
|
sig { override.returns({value: Float}) }
|
216
|
-
def to_hash
|
217
|
-
end
|
206
|
+
def to_hash; end
|
218
207
|
end
|
219
208
|
|
220
209
|
# The type of alert. This must be a valid alert type.
|
@@ -231,8 +220,7 @@ module Orb
|
|
231
220
|
COST_EXCEEDED = T.let(:cost_exceeded, Orb::Models::Alert::Type::TaggedSymbol)
|
232
221
|
|
233
222
|
sig { override.returns(T::Array[Orb::Models::Alert::Type::TaggedSymbol]) }
|
234
|
-
def self.values
|
235
|
-
end
|
223
|
+
def self.values; end
|
236
224
|
end
|
237
225
|
end
|
238
226
|
end
|
@@ -27,8 +27,7 @@ module Orb
|
|
27
27
|
)
|
28
28
|
.returns(T.attached_class)
|
29
29
|
end
|
30
|
-
def self.new(currency:, type:, thresholds: nil, request_options: {})
|
31
|
-
end
|
30
|
+
def self.new(currency:, type:, thresholds: nil, request_options: {}); end
|
32
31
|
|
33
32
|
sig do
|
34
33
|
override
|
@@ -41,8 +40,7 @@ module Orb
|
|
41
40
|
}
|
42
41
|
)
|
43
42
|
end
|
44
|
-
def to_hash
|
45
|
-
end
|
43
|
+
def to_hash; end
|
46
44
|
|
47
45
|
# The type of alert to create. This must be a valid alert type.
|
48
46
|
module Type
|
@@ -60,26 +58,23 @@ module Orb
|
|
60
58
|
T.let(:credit_balance_recovered, Orb::Models::AlertCreateForCustomerParams::Type::TaggedSymbol)
|
61
59
|
|
62
60
|
sig { override.returns(T::Array[Orb::Models::AlertCreateForCustomerParams::Type::TaggedSymbol]) }
|
63
|
-
def self.values
|
64
|
-
end
|
61
|
+
def self.values; end
|
65
62
|
end
|
66
63
|
|
67
64
|
class Threshold < Orb::Internal::Type::BaseModel
|
68
65
|
# The value at which an alert will fire. For credit balance alerts, the alert will
|
69
|
-
#
|
70
|
-
#
|
66
|
+
# fire at or below this value. For usage and cost alerts, the alert will fire at
|
67
|
+
# or above this value.
|
71
68
|
sig { returns(Float) }
|
72
69
|
attr_accessor :value
|
73
70
|
|
74
71
|
# Thresholds are used to define the conditions under which an alert will be
|
75
|
-
#
|
72
|
+
# triggered.
|
76
73
|
sig { params(value: Float).returns(T.attached_class) }
|
77
|
-
def self.new(value:)
|
78
|
-
end
|
74
|
+
def self.new(value:); end
|
79
75
|
|
80
76
|
sig { override.returns({value: Float}) }
|
81
|
-
def to_hash
|
82
|
-
end
|
77
|
+
def to_hash; end
|
83
78
|
end
|
84
79
|
end
|
85
80
|
end
|
@@ -29,8 +29,7 @@ module Orb
|
|
29
29
|
)
|
30
30
|
.returns(T.attached_class)
|
31
31
|
end
|
32
|
-
def self.new(currency:, type:, thresholds: nil, request_options: {})
|
33
|
-
end
|
32
|
+
def self.new(currency:, type:, thresholds: nil, request_options: {}); end
|
34
33
|
|
35
34
|
sig do
|
36
35
|
override
|
@@ -43,8 +42,7 @@ module Orb
|
|
43
42
|
}
|
44
43
|
)
|
45
44
|
end
|
46
|
-
def to_hash
|
47
|
-
end
|
45
|
+
def to_hash; end
|
48
46
|
|
49
47
|
# The type of alert to create. This must be a valid alert type.
|
50
48
|
module Type
|
@@ -62,26 +60,23 @@ module Orb
|
|
62
60
|
T.let(:credit_balance_recovered, Orb::Models::AlertCreateForExternalCustomerParams::Type::TaggedSymbol)
|
63
61
|
|
64
62
|
sig { override.returns(T::Array[Orb::Models::AlertCreateForExternalCustomerParams::Type::TaggedSymbol]) }
|
65
|
-
def self.values
|
66
|
-
end
|
63
|
+
def self.values; end
|
67
64
|
end
|
68
65
|
|
69
66
|
class Threshold < Orb::Internal::Type::BaseModel
|
70
67
|
# The value at which an alert will fire. For credit balance alerts, the alert will
|
71
|
-
#
|
72
|
-
#
|
68
|
+
# fire at or below this value. For usage and cost alerts, the alert will fire at
|
69
|
+
# or above this value.
|
73
70
|
sig { returns(Float) }
|
74
71
|
attr_accessor :value
|
75
72
|
|
76
73
|
# Thresholds are used to define the conditions under which an alert will be
|
77
|
-
#
|
74
|
+
# triggered.
|
78
75
|
sig { params(value: Float).returns(T.attached_class) }
|
79
|
-
def self.new(value:)
|
80
|
-
end
|
76
|
+
def self.new(value:); end
|
81
77
|
|
82
78
|
sig { override.returns({value: Float}) }
|
83
|
-
def to_hash
|
84
|
-
end
|
79
|
+
def to_hash; end
|
85
80
|
end
|
86
81
|
end
|
87
82
|
end
|
@@ -27,8 +27,7 @@ module Orb
|
|
27
27
|
)
|
28
28
|
.returns(T.attached_class)
|
29
29
|
end
|
30
|
-
def self.new(thresholds:, type:, metric_id: nil, request_options: {})
|
31
|
-
end
|
30
|
+
def self.new(thresholds:, type:, metric_id: nil, request_options: {}); end
|
32
31
|
|
33
32
|
sig do
|
34
33
|
override
|
@@ -41,25 +40,22 @@ module Orb
|
|
41
40
|
}
|
42
41
|
)
|
43
42
|
end
|
44
|
-
def to_hash
|
45
|
-
end
|
43
|
+
def to_hash; end
|
46
44
|
|
47
45
|
class Threshold < Orb::Internal::Type::BaseModel
|
48
46
|
# The value at which an alert will fire. For credit balance alerts, the alert will
|
49
|
-
#
|
50
|
-
#
|
47
|
+
# fire at or below this value. For usage and cost alerts, the alert will fire at
|
48
|
+
# or above this value.
|
51
49
|
sig { returns(Float) }
|
52
50
|
attr_accessor :value
|
53
51
|
|
54
52
|
# Thresholds are used to define the conditions under which an alert will be
|
55
|
-
#
|
53
|
+
# triggered.
|
56
54
|
sig { params(value: Float).returns(T.attached_class) }
|
57
|
-
def self.new(value:)
|
58
|
-
end
|
55
|
+
def self.new(value:); end
|
59
56
|
|
60
57
|
sig { override.returns({value: Float}) }
|
61
|
-
def to_hash
|
62
|
-
end
|
58
|
+
def to_hash; end
|
63
59
|
end
|
64
60
|
|
65
61
|
# The type of alert to create. This must be a valid alert type.
|
@@ -75,8 +71,7 @@ module Orb
|
|
75
71
|
COST_EXCEEDED = T.let(:cost_exceeded, Orb::Models::AlertCreateForSubscriptionParams::Type::TaggedSymbol)
|
76
72
|
|
77
73
|
sig { override.returns(T::Array[Orb::Models::AlertCreateForSubscriptionParams::Type::TaggedSymbol]) }
|
78
|
-
def self.values
|
79
|
-
end
|
74
|
+
def self.values; end
|
80
75
|
end
|
81
76
|
end
|
82
77
|
end
|
@@ -17,12 +17,10 @@ module Orb
|
|
17
17
|
)
|
18
18
|
.returns(T.attached_class)
|
19
19
|
end
|
20
|
-
def self.new(subscription_id: nil, request_options: {})
|
21
|
-
end
|
20
|
+
def self.new(subscription_id: nil, request_options: {}); end
|
22
21
|
|
23
22
|
sig { override.returns({subscription_id: T.nilable(String), request_options: Orb::RequestOptions}) }
|
24
|
-
def to_hash
|
25
|
-
end
|
23
|
+
def to_hash; end
|
26
24
|
end
|
27
25
|
end
|
28
26
|
end
|
@@ -17,12 +17,10 @@ module Orb
|
|
17
17
|
)
|
18
18
|
.returns(T.attached_class)
|
19
19
|
end
|
20
|
-
def self.new(subscription_id: nil, request_options: {})
|
21
|
-
end
|
20
|
+
def self.new(subscription_id: nil, request_options: {}); end
|
22
21
|
|
23
22
|
sig { override.returns({subscription_id: T.nilable(String), request_options: Orb::RequestOptions}) }
|
24
|
-
def to_hash
|
25
|
-
end
|
23
|
+
def to_hash; end
|
26
24
|
end
|
27
25
|
end
|
28
26
|
end
|
@@ -19,7 +19,7 @@ module Orb
|
|
19
19
|
attr_accessor :created_at_lte
|
20
20
|
|
21
21
|
# Cursor for pagination. This can be populated by the `next_cursor` value returned
|
22
|
-
#
|
22
|
+
# from the initial request.
|
23
23
|
sig { returns(T.nilable(String)) }
|
24
24
|
attr_accessor :cursor
|
25
25
|
|
@@ -68,9 +68,7 @@ module Orb
|
|
68
68
|
limit: nil,
|
69
69
|
subscription_id: nil,
|
70
70
|
request_options: {}
|
71
|
-
)
|
72
|
-
end
|
73
|
-
|
71
|
+
); end
|
74
72
|
sig do
|
75
73
|
override
|
76
74
|
.returns(
|
@@ -88,8 +86,7 @@ module Orb
|
|
88
86
|
}
|
89
87
|
)
|
90
88
|
end
|
91
|
-
def to_hash
|
92
|
-
end
|
89
|
+
def to_hash; end
|
93
90
|
end
|
94
91
|
end
|
95
92
|
end
|
@@ -9,12 +9,10 @@ module Orb
|
|
9
9
|
sig do
|
10
10
|
params(request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)).returns(T.attached_class)
|
11
11
|
end
|
12
|
-
def self.new(request_options: {})
|
13
|
-
end
|
12
|
+
def self.new(request_options: {}); end
|
14
13
|
|
15
14
|
sig { override.returns({request_options: Orb::RequestOptions}) }
|
16
|
-
def to_hash
|
17
|
-
end
|
15
|
+
def to_hash; end
|
18
16
|
end
|
19
17
|
end
|
20
18
|
end
|
@@ -17,8 +17,7 @@ module Orb
|
|
17
17
|
)
|
18
18
|
.returns(T.attached_class)
|
19
19
|
end
|
20
|
-
def self.new(thresholds:, request_options: {})
|
21
|
-
end
|
20
|
+
def self.new(thresholds:, request_options: {}); end
|
22
21
|
|
23
22
|
sig do
|
24
23
|
override
|
@@ -26,25 +25,22 @@ module Orb
|
|
26
25
|
{thresholds: T::Array[Orb::Models::AlertUpdateParams::Threshold], request_options: Orb::RequestOptions}
|
27
26
|
)
|
28
27
|
end
|
29
|
-
def to_hash
|
30
|
-
end
|
28
|
+
def to_hash; end
|
31
29
|
|
32
30
|
class Threshold < Orb::Internal::Type::BaseModel
|
33
31
|
# The value at which an alert will fire. For credit balance alerts, the alert will
|
34
|
-
#
|
35
|
-
#
|
32
|
+
# fire at or below this value. For usage and cost alerts, the alert will fire at
|
33
|
+
# or above this value.
|
36
34
|
sig { returns(Float) }
|
37
35
|
attr_accessor :value
|
38
36
|
|
39
37
|
# Thresholds are used to define the conditions under which an alert will be
|
40
|
-
#
|
38
|
+
# triggered.
|
41
39
|
sig { params(value: Float).returns(T.attached_class) }
|
42
|
-
def self.new(value:)
|
43
|
-
end
|
40
|
+
def self.new(value:); end
|
44
41
|
|
45
42
|
sig { override.returns({value: Float}) }
|
46
|
-
def to_hash
|
47
|
-
end
|
43
|
+
def to_hash; end
|
48
44
|
end
|
49
45
|
end
|
50
46
|
end
|
@@ -8,7 +8,7 @@ module Orb
|
|
8
8
|
attr_accessor :amount_discount
|
9
9
|
|
10
10
|
# List of price_ids that this discount applies to. For plan/plan phase discounts,
|
11
|
-
#
|
11
|
+
# this can be a subset of prices.
|
12
12
|
sig { returns(T::Array[String]) }
|
13
13
|
attr_accessor :applies_to_price_ids
|
14
14
|
|
@@ -27,8 +27,7 @@ module Orb
|
|
27
27
|
)
|
28
28
|
.returns(T.attached_class)
|
29
29
|
end
|
30
|
-
def self.new(amount_discount:, applies_to_price_ids:, discount_type:, reason: nil)
|
31
|
-
end
|
30
|
+
def self.new(amount_discount:, applies_to_price_ids:, discount_type:, reason: nil); end
|
32
31
|
|
33
32
|
sig do
|
34
33
|
override
|
@@ -41,8 +40,7 @@ module Orb
|
|
41
40
|
}
|
42
41
|
)
|
43
42
|
end
|
44
|
-
def to_hash
|
45
|
-
end
|
43
|
+
def to_hash; end
|
46
44
|
|
47
45
|
module DiscountType
|
48
46
|
extend Orb::Internal::Type::Enum
|
@@ -54,8 +52,7 @@ module Orb
|
|
54
52
|
AMOUNT = T.let(:amount, Orb::Models::AmountDiscount::DiscountType::TaggedSymbol)
|
55
53
|
|
56
54
|
sig { override.returns(T::Array[Orb::Models::AmountDiscount::DiscountType::TaggedSymbol]) }
|
57
|
-
def self.values
|
58
|
-
end
|
55
|
+
def self.values; end
|
59
56
|
end
|
60
57
|
end
|
61
58
|
end
|
@@ -10,8 +10,8 @@ module Orb
|
|
10
10
|
attr_accessor :description
|
11
11
|
|
12
12
|
# The Item resource represents a sellable product or good. Items are associated
|
13
|
-
#
|
14
|
-
#
|
13
|
+
# with all line items, billable metrics, and prices and are used for defining
|
14
|
+
# external sync behavior for invoices and tax calculation purposes.
|
15
15
|
sig { returns(Orb::Models::Item) }
|
16
16
|
attr_reader :item
|
17
17
|
|
@@ -19,9 +19,9 @@ module Orb
|
|
19
19
|
attr_writer :item
|
20
20
|
|
21
21
|
# User specified key-value pairs for the resource. If not present, this defaults
|
22
|
-
#
|
23
|
-
#
|
24
|
-
#
|
22
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
23
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
24
|
+
# `null`.
|
25
25
|
sig { returns(T::Hash[Symbol, String]) }
|
26
26
|
attr_accessor :metadata
|
27
27
|
|
@@ -32,8 +32,8 @@ module Orb
|
|
32
32
|
attr_accessor :status
|
33
33
|
|
34
34
|
# The Metric resource represents a calculation of a quantity based on events.
|
35
|
-
#
|
36
|
-
#
|
35
|
+
# Metrics are defined by the query that transforms raw usage events into
|
36
|
+
# meaningful values for your customers.
|
37
37
|
sig do
|
38
38
|
params(
|
39
39
|
id: String,
|
@@ -45,8 +45,7 @@ module Orb
|
|
45
45
|
)
|
46
46
|
.returns(T.attached_class)
|
47
47
|
end
|
48
|
-
def self.new(id:, description:, item:, metadata:, name:, status:)
|
49
|
-
end
|
48
|
+
def self.new(id:, description:, item:, metadata:, name:, status:); end
|
50
49
|
|
51
50
|
sig do
|
52
51
|
override
|
@@ -61,8 +60,7 @@ module Orb
|
|
61
60
|
}
|
62
61
|
)
|
63
62
|
end
|
64
|
-
def to_hash
|
65
|
-
end
|
63
|
+
def to_hash; end
|
66
64
|
|
67
65
|
module Status
|
68
66
|
extend Orb::Internal::Type::Enum
|
@@ -75,8 +73,7 @@ module Orb
|
|
75
73
|
ARCHIVED = T.let(:archived, Orb::Models::BillableMetric::Status::TaggedSymbol)
|
76
74
|
|
77
75
|
sig { override.returns(T::Array[Orb::Models::BillableMetric::Status::TaggedSymbol]) }
|
78
|
-
def self.values
|
79
|
-
end
|
76
|
+
def self.values; end
|
80
77
|
end
|
81
78
|
end
|
82
79
|
end
|
@@ -12,8 +12,7 @@ module Orb
|
|
12
12
|
END_OF_TERM = T.let(:end_of_term, Orb::Models::BillingCycleRelativeDate::TaggedSymbol)
|
13
13
|
|
14
14
|
sig { override.returns(T::Array[Orb::Models::BillingCycleRelativeDate::TaggedSymbol]) }
|
15
|
-
def self.values
|
16
|
-
end
|
15
|
+
def self.values; end
|
17
16
|
end
|
18
17
|
end
|
19
18
|
end
|
@@ -8,7 +8,7 @@ module Orb
|
|
8
8
|
attr_accessor :id
|
9
9
|
|
10
10
|
# An archived coupon can no longer be redeemed. Active coupons will have a value
|
11
|
-
#
|
11
|
+
# of null for `archived_at`; this field will be non-null for archived coupons.
|
12
12
|
sig { returns(T.nilable(Time)) }
|
13
13
|
attr_accessor :archived_at
|
14
14
|
|
@@ -16,12 +16,12 @@ module Orb
|
|
16
16
|
attr_accessor :discount
|
17
17
|
|
18
18
|
# This allows for a coupon's discount to apply for a limited time (determined in
|
19
|
-
#
|
19
|
+
# months); a `null` value here means "unlimited time".
|
20
20
|
sig { returns(T.nilable(Integer)) }
|
21
21
|
attr_accessor :duration_in_months
|
22
22
|
|
23
23
|
# The maximum number of redemptions allowed for this coupon before it is
|
24
|
-
#
|
24
|
+
# exhausted; `null` here means "unlimited".
|
25
25
|
sig { returns(T.nilable(Integer)) }
|
26
26
|
attr_accessor :max_redemptions
|
27
27
|
|
@@ -34,10 +34,10 @@ module Orb
|
|
34
34
|
attr_accessor :times_redeemed
|
35
35
|
|
36
36
|
# A coupon represents a reusable discount configuration that can be applied either
|
37
|
-
#
|
38
|
-
#
|
39
|
-
#
|
40
|
-
#
|
37
|
+
# as a fixed or percentage amount to an invoice or subscription. Coupons are
|
38
|
+
# activated using a redemption code, which applies the discount to a subscription
|
39
|
+
# or invoice. The duration of a coupon determines how long it remains available
|
40
|
+
# for use by end users.
|
41
41
|
sig do
|
42
42
|
params(
|
43
43
|
id: String,
|
@@ -75,15 +75,13 @@ module Orb
|
|
75
75
|
}
|
76
76
|
)
|
77
77
|
end
|
78
|
-
def to_hash
|
79
|
-
end
|
78
|
+
def to_hash; end
|
80
79
|
|
81
80
|
module Discount
|
82
81
|
extend Orb::Internal::Type::Union
|
83
82
|
|
84
83
|
sig { override.returns([Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount]) }
|
85
|
-
def self.variants
|
86
|
-
end
|
84
|
+
def self.variants; end
|
87
85
|
end
|
88
86
|
end
|
89
87
|
end
|
@@ -9,12 +9,10 @@ module Orb
|
|
9
9
|
sig do
|
10
10
|
params(request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)).returns(T.attached_class)
|
11
11
|
end
|
12
|
-
def self.new(request_options: {})
|
13
|
-
end
|
12
|
+
def self.new(request_options: {}); end
|
14
13
|
|
15
14
|
sig { override.returns({request_options: Orb::RequestOptions}) }
|
16
|
-
def to_hash
|
17
|
-
end
|
15
|
+
def to_hash; end
|
18
16
|
end
|
19
17
|
end
|
20
18
|
end
|
@@ -21,12 +21,12 @@ module Orb
|
|
21
21
|
attr_accessor :redemption_code
|
22
22
|
|
23
23
|
# This allows for a coupon's discount to apply for a limited time (determined in
|
24
|
-
#
|
24
|
+
# months); a `null` value here means "unlimited time".
|
25
25
|
sig { returns(T.nilable(Integer)) }
|
26
26
|
attr_accessor :duration_in_months
|
27
27
|
|
28
28
|
# The maximum number of redemptions allowed for this coupon before it is
|
29
|
-
#
|
29
|
+
# exhausted;`null` here means "unlimited".
|
30
30
|
sig { returns(T.nilable(Integer)) }
|
31
31
|
attr_accessor :max_redemptions
|
32
32
|
|
@@ -68,8 +68,7 @@ module Orb
|
|
68
68
|
}
|
69
69
|
)
|
70
70
|
end
|
71
|
-
def to_hash
|
72
|
-
end
|
71
|
+
def to_hash; end
|
73
72
|
|
74
73
|
module Discount
|
75
74
|
extend Orb::Internal::Type::Union
|
@@ -82,12 +81,10 @@ module Orb
|
|
82
81
|
attr_accessor :percentage_discount
|
83
82
|
|
84
83
|
sig { params(percentage_discount: Float, discount_type: Symbol).returns(T.attached_class) }
|
85
|
-
def self.new(percentage_discount:, discount_type: :percentage)
|
86
|
-
end
|
84
|
+
def self.new(percentage_discount:, discount_type: :percentage); end
|
87
85
|
|
88
86
|
sig { override.returns({discount_type: Symbol, percentage_discount: Float}) }
|
89
|
-
def to_hash
|
90
|
-
end
|
87
|
+
def to_hash; end
|
91
88
|
end
|
92
89
|
|
93
90
|
class NewCouponAmountDiscount < Orb::Internal::Type::BaseModel
|
@@ -98,12 +95,10 @@ module Orb
|
|
98
95
|
attr_accessor :discount_type
|
99
96
|
|
100
97
|
sig { params(amount_discount: String, discount_type: Symbol).returns(T.attached_class) }
|
101
|
-
def self.new(amount_discount:, discount_type: :amount)
|
102
|
-
end
|
98
|
+
def self.new(amount_discount:, discount_type: :amount); end
|
103
99
|
|
104
100
|
sig { override.returns({amount_discount: String, discount_type: Symbol}) }
|
105
|
-
def to_hash
|
106
|
-
end
|
101
|
+
def to_hash; end
|
107
102
|
end
|
108
103
|
|
109
104
|
sig do
|
@@ -112,8 +107,7 @@ module Orb
|
|
112
107
|
[Orb::Models::CouponCreateParams::Discount::NewCouponPercentageDiscount, Orb::Models::CouponCreateParams::Discount::NewCouponAmountDiscount]
|
113
108
|
)
|
114
109
|
end
|
115
|
-
def self.variants
|
116
|
-
end
|
110
|
+
def self.variants; end
|
117
111
|
end
|
118
112
|
end
|
119
113
|
end
|
@@ -9,12 +9,10 @@ module Orb
|
|
9
9
|
sig do
|
10
10
|
params(request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)).returns(T.attached_class)
|
11
11
|
end
|
12
|
-
def self.new(request_options: {})
|
13
|
-
end
|
12
|
+
def self.new(request_options: {}); end
|
14
13
|
|
15
14
|
sig { override.returns({request_options: Orb::RequestOptions}) }
|
16
|
-
def to_hash
|
17
|
-
end
|
15
|
+
def to_hash; end
|
18
16
|
end
|
19
17
|
end
|
20
18
|
end
|