orb-billing 0.2.0 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +34 -0
- data/README.md +59 -49
- data/lib/orb/client.rb +4 -4
- data/lib/orb/file_part.rb +55 -0
- data/lib/orb/internal/page.rb +4 -8
- data/lib/orb/internal/transport/base_client.rb +7 -7
- data/lib/orb/internal/transport/pooled_net_requester.rb +2 -2
- data/lib/orb/internal/type/array_of.rb +11 -0
- data/lib/orb/internal/type/base_model.rb +32 -14
- data/lib/orb/internal/type/base_page.rb +9 -1
- data/lib/orb/internal/type/boolean.rb +4 -0
- data/lib/orb/internal/type/converter.rb +4 -1
- data/lib/orb/internal/type/enum.rb +9 -5
- data/lib/orb/internal/type/{io_like.rb → file_input.rb} +33 -15
- data/lib/orb/internal/type/hash_of.rb +11 -0
- data/lib/orb/internal/type/request_parameters.rb +1 -2
- data/lib/orb/internal/type/union.rb +10 -1
- data/lib/orb/internal/type/unknown.rb +4 -0
- data/lib/orb/internal/util.rb +69 -61
- data/lib/orb/internal.rb +0 -1
- data/lib/orb/models/alert.rb +68 -71
- data/lib/orb/models/alert_create_for_customer_params.rb +20 -25
- data/lib/orb/models/alert_create_for_external_customer_params.rb +20 -25
- data/lib/orb/models/alert_create_for_subscription_params.rb +20 -25
- data/lib/orb/models/alert_disable_params.rb +5 -9
- data/lib/orb/models/alert_enable_params.rb +5 -9
- data/lib/orb/models/alert_list_params.rb +26 -36
- data/lib/orb/models/alert_retrieve_params.rb +3 -8
- data/lib/orb/models/alert_update_params.rb +14 -18
- data/lib/orb/models/amount_discount.rb +14 -14
- data/lib/orb/models/billable_metric.rb +23 -20
- data/lib/orb/models/billing_cycle_relative_date.rb +2 -5
- data/lib/orb/models/coupon.rb +28 -21
- data/lib/orb/models/coupon_archive_params.rb +3 -8
- data/lib/orb/models/coupon_create_params.rb +24 -29
- data/lib/orb/models/coupon_fetch_params.rb +3 -8
- data/lib/orb/models/coupon_list_params.rb +17 -17
- data/lib/orb/models/coupons/subscription_list_params.rb +12 -15
- data/lib/orb/models/credit_note.rb +100 -166
- data/lib/orb/models/credit_note_create_params.rb +15 -23
- data/lib/orb/models/credit_note_fetch_params.rb +3 -8
- data/lib/orb/models/credit_note_list_params.rb +20 -30
- data/lib/orb/models/customer.rb +224 -271
- data/lib/orb/models/customer_create_params.rb +211 -252
- data/lib/orb/models/customer_delete_params.rb +3 -8
- data/lib/orb/models/customer_fetch_by_external_id_params.rb +3 -8
- data/lib/orb/models/customer_fetch_params.rb +3 -8
- data/lib/orb/models/customer_list_params.rb +20 -30
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +3 -8
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +3 -8
- data/lib/orb/models/customer_update_by_external_id_params.rb +207 -250
- data/lib/orb/models/customer_update_params.rb +207 -250
- data/lib/orb/models/customers/balance_transaction_create_params.rb +11 -16
- data/lib/orb/models/customers/balance_transaction_create_response.rb +33 -51
- data/lib/orb/models/customers/balance_transaction_list_params.rb +20 -30
- data/lib/orb/models/customers/balance_transaction_list_response.rb +33 -51
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +22 -26
- data/lib/orb/models/customers/cost_list_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_response.rb +22 -26
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +18 -22
- data/lib/orb/models/customers/credit_list_by_external_id_response.rb +10 -17
- data/lib/orb/models/customers/credit_list_params.rb +18 -22
- data/lib/orb/models/customers/credit_list_response.rb +10 -17
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +64 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +300 -406
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +63 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +300 -406
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +33 -48
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +300 -406
- data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
- data/lib/orb/models/customers/credits/ledger_list_response.rb +300 -406
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +47 -50
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +43 -46
- data/lib/orb/models/customers/credits/top_up_create_params.rb +46 -50
- data/lib/orb/models/customers/credits/top_up_create_response.rb +42 -46
- data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +4 -9
- data/lib/orb/models/customers/credits/top_up_delete_params.rb +4 -9
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +12 -15
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +43 -46
- data/lib/orb/models/customers/credits/top_up_list_params.rb +12 -15
- data/lib/orb/models/customers/credits/top_up_list_response.rb +42 -46
- data/lib/orb/models/dimensional_price_group.rb +21 -15
- data/lib/orb/models/dimensional_price_group_create_params.rb +17 -23
- data/lib/orb/models/dimensional_price_group_list_params.rb +12 -15
- data/lib/orb/models/dimensional_price_group_retrieve_params.rb +3 -8
- data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +3 -8
- data/lib/orb/models/dimensional_price_groups.rb +3 -7
- data/lib/orb/models/discount.rb +2 -3
- data/lib/orb/models/evaluate_price_group.rb +8 -11
- data/lib/orb/models/event_deprecate_params.rb +3 -8
- data/lib/orb/models/event_deprecate_response.rb +2 -6
- data/lib/orb/models/event_ingest_params.rb +33 -27
- data/lib/orb/models/event_ingest_response.rb +23 -24
- data/lib/orb/models/event_search_params.rb +15 -11
- data/lib/orb/models/event_search_response.rb +27 -22
- data/lib/orb/models/event_update_params.rb +19 -13
- data/lib/orb/models/event_update_response.rb +2 -6
- data/lib/orb/models/events/backfill_close_params.rb +3 -8
- data/lib/orb/models/events/backfill_close_response.rb +34 -39
- data/lib/orb/models/events/backfill_create_params.rb +28 -32
- data/lib/orb/models/events/backfill_create_response.rb +34 -39
- data/lib/orb/models/events/backfill_fetch_params.rb +3 -8
- data/lib/orb/models/events/backfill_fetch_response.rb +34 -39
- data/lib/orb/models/events/backfill_list_params.rb +12 -15
- data/lib/orb/models/events/backfill_list_response.rb +34 -39
- data/lib/orb/models/events/backfill_revert_params.rb +3 -8
- data/lib/orb/models/events/backfill_revert_response.rb +34 -39
- data/lib/orb/models/events/event_volumes.rb +11 -17
- data/lib/orb/models/events/volume_list_params.rb +19 -22
- data/lib/orb/models/invoice.rb +589 -637
- data/lib/orb/models/invoice_create_params.rb +52 -61
- data/lib/orb/models/invoice_fetch_params.rb +3 -8
- data/lib/orb/models/invoice_fetch_upcoming_params.rb +4 -9
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +584 -631
- data/lib/orb/models/invoice_issue_params.rb +10 -14
- data/lib/orb/models/invoice_level_discount.rb +2 -3
- data/lib/orb/models/invoice_line_item_create_params.rb +19 -14
- data/lib/orb/models/invoice_line_item_create_response.rb +247 -269
- data/lib/orb/models/invoice_list_params.rb +51 -66
- data/lib/orb/models/invoice_mark_paid_params.rb +9 -11
- data/lib/orb/models/invoice_pay_params.rb +3 -8
- data/lib/orb/models/invoice_update_params.rb +9 -9
- data/lib/orb/models/invoice_void_params.rb +3 -8
- data/lib/orb/models/item.rb +14 -25
- data/lib/orb/models/item_create_params.rb +5 -9
- data/lib/orb/models/item_fetch_params.rb +3 -8
- data/lib/orb/models/item_list_params.rb +12 -15
- data/lib/orb/models/item_update_params.rb +10 -22
- data/lib/orb/models/metric_create_params.rb +17 -13
- data/lib/orb/models/metric_fetch_params.rb +3 -8
- data/lib/orb/models/metric_list_params.rb +20 -30
- data/lib/orb/models/metric_update_params.rb +9 -9
- data/lib/orb/models/pagination_metadata.rb +3 -7
- data/lib/orb/models/percentage_discount.rb +15 -14
- data/lib/orb/models/plan.rb +250 -279
- data/lib/orb/models/plan_create_params.rb +1623 -1984
- data/lib/orb/models/plan_fetch_params.rb +3 -8
- data/lib/orb/models/plan_list_params.rb +25 -42
- data/lib/orb/models/plan_update_params.rb +12 -10
- data/lib/orb/models/plans/external_plan_id_fetch_params.rb +3 -8
- data/lib/orb/models/plans/external_plan_id_update_params.rb +12 -10
- data/lib/orb/models/price.rb +2709 -3820
- data/lib/orb/models/price_create_params.rb +203 -244
- data/lib/orb/models/price_evaluate_params.rb +21 -30
- data/lib/orb/models/price_evaluate_response.rb +2 -6
- data/lib/orb/models/price_fetch_params.rb +3 -8
- data/lib/orb/models/price_list_params.rb +12 -15
- data/lib/orb/models/price_update_params.rb +9 -9
- data/lib/orb/models/prices/external_price_id_fetch_params.rb +3 -8
- data/lib/orb/models/prices/external_price_id_update_params.rb +9 -9
- data/lib/orb/models/subscription.rb +343 -382
- data/lib/orb/models/subscription_cancel_params.rb +16 -16
- data/lib/orb/models/subscription_cancel_response.rb +339 -377
- data/lib/orb/models/subscription_change_apply_params.rb +7 -10
- data/lib/orb/models/subscription_change_apply_response.rb +365 -398
- data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
- data/lib/orb/models/subscription_change_cancel_response.rb +365 -398
- data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
- data/lib/orb/models/subscription_change_retrieve_response.rb +366 -398
- data/lib/orb/models/subscription_create_params.rb +3771 -4402
- data/lib/orb/models/subscription_create_response.rb +339 -377
- data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
- data/lib/orb/models/subscription_fetch_costs_response.rb +22 -26
- data/lib/orb/models/subscription_fetch_params.rb +3 -8
- data/lib/orb/models/subscription_fetch_schedule_params.rb +20 -30
- data/lib/orb/models/subscription_fetch_schedule_response.rb +15 -17
- data/lib/orb/models/subscription_fetch_usage_params.rb +32 -43
- data/lib/orb/models/subscription_list_params.rb +28 -41
- data/lib/orb/models/subscription_price_intervals_params.rb +2018 -2472
- data/lib/orb/models/subscription_price_intervals_response.rb +342 -377
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +3764 -4392
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +342 -377
- data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
- data/lib/orb/models/subscription_trigger_phase_response.rb +341 -377
- data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +342 -377
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +5 -9
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +343 -377
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +343 -377
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +22 -33
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +342 -377
- data/lib/orb/models/subscription_update_params.rb +21 -23
- data/lib/orb/models/subscription_update_trial_params.rb +15 -18
- data/lib/orb/models/subscription_update_trial_response.rb +341 -377
- data/lib/orb/models/subscription_usage.rb +37 -80
- data/lib/orb/models/subscriptions.rb +3 -7
- data/lib/orb/models/top_level_ping_params.rb +3 -8
- data/lib/orb/models/top_level_ping_response.rb +2 -6
- data/lib/orb/models/trial_discount.rb +16 -24
- data/lib/orb/models/usage_discount.rb +15 -14
- data/lib/orb/request_options.rb +3 -4
- data/lib/orb/resources/alerts.rb +48 -17
- data/lib/orb/resources/coupons/subscriptions.rb +9 -2
- data/lib/orb/resources/coupons.rb +25 -7
- data/lib/orb/resources/credit_notes.rb +17 -4
- data/lib/orb/resources/customers/balance_transactions.rb +18 -3
- data/lib/orb/resources/customers/costs.rb +26 -8
- data/lib/orb/resources/customers/credits/ledger.rb +108 -28
- data/lib/orb/resources/customers/credits/top_ups.rb +67 -20
- data/lib/orb/resources/customers/credits.rb +28 -8
- data/lib/orb/resources/customers.rb +135 -36
- data/lib/orb/resources/dimensional_price_groups.rb +19 -4
- data/lib/orb/resources/events/backfills.rb +32 -9
- data/lib/orb/resources/events/volume.rb +14 -4
- data/lib/orb/resources/events.rb +40 -11
- data/lib/orb/resources/invoice_line_items.rb +16 -6
- data/lib/orb/resources/invoices.rb +77 -17
- data/lib/orb/resources/items.rb +10 -3
- data/lib/orb/resources/metrics.rb +33 -8
- data/lib/orb/resources/plans/external_plan_id.rb +10 -2
- data/lib/orb/resources/plans.rb +47 -11
- data/lib/orb/resources/prices/external_price_id.rb +7 -1
- data/lib/orb/resources/prices.rb +97 -22
- data/lib/orb/resources/subscription_changes.rb +5 -2
- data/lib/orb/resources/subscriptions.rb +292 -78
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +2 -10
- data/rbi/lib/orb/client.rbi +4 -4
- data/rbi/lib/orb/file_part.rbi +34 -0
- data/rbi/lib/orb/internal/transport/base_client.rbi +17 -3
- data/rbi/lib/orb/internal/type/array_of.rbi +3 -0
- data/rbi/lib/orb/internal/type/base_model.rbi +7 -1
- data/rbi/lib/orb/internal/type/base_page.rbi +2 -0
- data/rbi/lib/orb/internal/type/enum.rbi +3 -6
- data/rbi/lib/orb/internal/type/{io_like.rbi → file_input.rbi} +5 -2
- data/rbi/lib/orb/internal/type/hash_of.rbi +3 -0
- data/rbi/lib/orb/internal/type/union.rbi +3 -0
- data/rbi/lib/orb/internal/util.rbi +24 -19
- data/rbi/lib/orb/internal.rbi +0 -1
- data/rbi/lib/orb/models/alert.rbi +28 -8
- data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_disable_params.rbi +5 -2
- data/rbi/lib/orb/models/alert_enable_params.rbi +5 -2
- data/rbi/lib/orb/models/alert_list_params.rbi +6 -0
- data/rbi/lib/orb/models/alert_update_params.rbi +11 -4
- data/rbi/lib/orb/models/amount_discount.rbi +10 -4
- data/rbi/lib/orb/models/billable_metric.rbi +16 -3
- data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -1
- data/rbi/lib/orb/models/coupon.rbi +10 -3
- data/rbi/lib/orb/models/coupon_create_params.rbi +6 -3
- data/rbi/lib/orb/models/coupon_list_params.rbi +13 -3
- data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +8 -2
- data/rbi/lib/orb/models/credit_note.rbi +44 -12
- data/rbi/lib/orb/models/credit_note_create_params.rbi +15 -6
- data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customer.rbi +130 -11
- data/rbi/lib/orb/models/customer_create_params.rbi +142 -8
- data/rbi/lib/orb/models/customer_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +140 -8
- data/rbi/lib/orb/models/customer_update_params.rbi +140 -8
- data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +8 -4
- data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +18 -8
- data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +18 -8
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +9 -5
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +21 -4
- data/rbi/lib/orb/models/customers/cost_list_params.rbi +9 -5
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +21 -4
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +13 -3
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +1 -2
- data/rbi/lib/orb/models/customers/credit_list_params.rbi +13 -3
- data/rbi/lib/orb/models/customers/credit_list_response.rbi +1 -2
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +40 -6
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +6 -4
- data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +27 -4
- data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +8 -2
- data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +25 -4
- data/rbi/lib/orb/models/dimensional_price_group.rbi +11 -3
- data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -0
- data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +8 -2
- data/rbi/lib/orb/models/evaluate_price_group.rbi +8 -2
- data/rbi/lib/orb/models/event_deprecate_response.rbi +4 -2
- data/rbi/lib/orb/models/event_ingest_params.rbi +22 -5
- data/rbi/lib/orb/models/event_ingest_response.rbi +15 -4
- data/rbi/lib/orb/models/event_search_params.rbi +14 -2
- data/rbi/lib/orb/models/event_search_response.rbi +14 -3
- data/rbi/lib/orb/models/event_update_params.rbi +10 -3
- data/rbi/lib/orb/models/event_update_response.rbi +4 -2
- data/rbi/lib/orb/models/events/backfill_close_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_create_params.rbi +18 -0
- data/rbi/lib/orb/models/events/backfill_create_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_list_params.rbi +8 -2
- data/rbi/lib/orb/models/events/backfill_list_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_revert_response.rbi +14 -2
- data/rbi/lib/orb/models/events/event_volumes.rbi +6 -2
- data/rbi/lib/orb/models/events/volume_list_params.rbi +18 -2
- data/rbi/lib/orb/models/invoice.rbi +375 -46
- data/rbi/lib/orb/models/invoice_create_params.rbi +38 -6
- data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +375 -66
- data/rbi/lib/orb/models/invoice_issue_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +16 -2
- data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +141 -20
- data/rbi/lib/orb/models/invoice_list_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_update_params.rbi +7 -2
- data/rbi/lib/orb/models/item.rbi +1 -2
- data/rbi/lib/orb/models/item_create_params.rbi +5 -2
- data/rbi/lib/orb/models/item_list_params.rbi +8 -2
- data/rbi/lib/orb/models/item_update_params.rbi +1 -8
- data/rbi/lib/orb/models/metric_create_params.rbi +15 -2
- data/rbi/lib/orb/models/metric_list_params.rbi +3 -0
- data/rbi/lib/orb/models/metric_update_params.rbi +7 -2
- data/rbi/lib/orb/models/percentage_discount.rbi +11 -4
- data/rbi/lib/orb/models/plan.rbi +102 -15
- data/rbi/lib/orb/models/plan_create_params.rbi +997 -679
- data/rbi/lib/orb/models/plan_list_params.rbi +5 -1
- data/rbi/lib/orb/models/plan_update_params.rbi +11 -2
- data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +11 -2
- data/rbi/lib/orb/models/price.rbi +717 -688
- data/rbi/lib/orb/models/price_create_params.rbi +137 -53
- data/rbi/lib/orb/models/price_evaluate_params.rbi +10 -0
- data/rbi/lib/orb/models/price_list_params.rbi +8 -2
- data/rbi/lib/orb/models/price_update_params.rbi +7 -2
- data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +7 -2
- data/rbi/lib/orb/models/subscription.rbi +174 -11
- data/rbi/lib/orb/models/subscription_cancel_params.rbi +8 -5
- data/rbi/lib/orb/models/subscription_cancel_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_change_apply_params.rbi +7 -2
- data/rbi/lib/orb/models/subscription_change_apply_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_create_params.rbi +2282 -1536
- data/rbi/lib/orb/models/subscription_create_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +9 -5
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +21 -4
- data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -0
- data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +8 -2
- data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +13 -4
- data/rbi/lib/orb/models/subscription_list_params.rbi +4 -2
- data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +1228 -861
- data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +2288 -1544
- data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +10 -2
- data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +187 -20
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_update_params.rbi +15 -0
- data/rbi/lib/orb/models/subscription_update_trial_params.rbi +11 -5
- data/rbi/lib/orb/models/subscription_update_trial_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_usage.rbi +2 -16
- data/rbi/lib/orb/models/trial_discount.rbi +5 -1
- data/rbi/lib/orb/models/usage_discount.rbi +11 -3
- data/sig/orb/file_part.rbs +21 -0
- data/sig/orb/internal/transport/base_client.rbs +9 -3
- data/sig/orb/internal/type/array_of.rbs +2 -0
- data/sig/orb/internal/type/base_model.rbs +4 -0
- data/sig/orb/internal/type/enum.rbs +2 -2
- data/sig/orb/internal/type/{io_like.rbs → file_input.rbs} +1 -1
- data/sig/orb/internal/type/hash_of.rbs +2 -0
- data/sig/orb/internal/type/union.rbs +2 -0
- data/sig/orb/internal/util.rbs +14 -12
- metadata +8 -5
@@ -4,8 +4,7 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
# @see Orb::Resources::Alerts#create_for_external_customer
|
6
6
|
class AlertCreateForExternalCustomerParams < Orb::Internal::Type::BaseModel
|
7
|
-
|
8
|
-
# extend Orb::Internal::Type::RequestParameters::Converter
|
7
|
+
extend Orb::Internal::Type::RequestParameters::Converter
|
9
8
|
include Orb::Internal::Type::RequestParameters
|
10
9
|
|
11
10
|
# @!attribute currency
|
@@ -28,15 +27,14 @@ module Orb
|
|
28
27
|
-> { Orb::Internal::Type::ArrayOf[Orb::Models::AlertCreateForExternalCustomerParams::Threshold] },
|
29
28
|
nil?: true
|
30
29
|
|
31
|
-
# @!
|
32
|
-
#
|
33
|
-
#
|
34
|
-
#
|
35
|
-
#
|
36
|
-
#
|
37
|
-
#
|
38
|
-
|
39
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
30
|
+
# @!method initialize(currency:, type:, thresholds: nil, request_options: {})
|
31
|
+
# @param currency [String] The case sensitive currency or custom pricing unit to use for this alert.
|
32
|
+
#
|
33
|
+
# @param type [Symbol, Orb::Models::AlertCreateForExternalCustomerParams::Type] The type of alert to create. This must be a valid alert type.
|
34
|
+
#
|
35
|
+
# @param thresholds [Array<Orb::Models::AlertCreateForExternalCustomerParams::Threshold>, nil] The thresholds that define the values at which the alert will be triggered.
|
36
|
+
#
|
37
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
40
38
|
|
41
39
|
# The type of alert to create. This must be a valid alert type.
|
42
40
|
module Type
|
@@ -46,11 +44,8 @@ module Orb
|
|
46
44
|
CREDIT_BALANCE_DROPPED = :credit_balance_dropped
|
47
45
|
CREDIT_BALANCE_RECOVERED = :credit_balance_recovered
|
48
46
|
|
49
|
-
|
50
|
-
|
51
|
-
# @!parse
|
52
|
-
# # @return [Array<Symbol>]
|
53
|
-
# def self.values; end
|
47
|
+
# @!method self.values
|
48
|
+
# @return [Array<Symbol>]
|
54
49
|
end
|
55
50
|
|
56
51
|
class Threshold < Orb::Internal::Type::BaseModel
|
@@ -62,15 +57,15 @@ module Orb
|
|
62
57
|
# @return [Float]
|
63
58
|
required :value, Float
|
64
59
|
|
65
|
-
# @!
|
66
|
-
#
|
67
|
-
#
|
68
|
-
#
|
69
|
-
#
|
70
|
-
#
|
71
|
-
#
|
72
|
-
|
73
|
-
#
|
60
|
+
# @!method initialize(value:)
|
61
|
+
# Some parameter documentations has been truncated, see
|
62
|
+
# {Orb::Models::AlertCreateForExternalCustomerParams::Threshold} for more details.
|
63
|
+
#
|
64
|
+
# Thresholds are used to define the conditions under which an alert will be
|
65
|
+
# triggered.
|
66
|
+
#
|
67
|
+
# @param value [Float] The value at which an alert will fire. For credit balance alerts, the alert will
|
68
|
+
# ...
|
74
69
|
end
|
75
70
|
end
|
76
71
|
end
|
@@ -4,8 +4,7 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
# @see Orb::Resources::Alerts#create_for_subscription
|
6
6
|
class AlertCreateForSubscriptionParams < Orb::Internal::Type::BaseModel
|
7
|
-
|
8
|
-
# extend Orb::Internal::Type::RequestParameters::Converter
|
7
|
+
extend Orb::Internal::Type::RequestParameters::Converter
|
9
8
|
include Orb::Internal::Type::RequestParameters
|
10
9
|
|
11
10
|
# @!attribute thresholds
|
@@ -27,15 +26,14 @@ module Orb
|
|
27
26
|
# @return [String, nil]
|
28
27
|
optional :metric_id, String, nil?: true
|
29
28
|
|
30
|
-
# @!
|
31
|
-
#
|
32
|
-
#
|
33
|
-
#
|
34
|
-
#
|
35
|
-
#
|
36
|
-
#
|
37
|
-
|
38
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
29
|
+
# @!method initialize(thresholds:, type:, metric_id: nil, request_options: {})
|
30
|
+
# @param thresholds [Array<Orb::Models::AlertCreateForSubscriptionParams::Threshold>] The thresholds that define the values at which the alert will be triggered.
|
31
|
+
#
|
32
|
+
# @param type [Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type] The type of alert to create. This must be a valid alert type.
|
33
|
+
#
|
34
|
+
# @param metric_id [String, nil] The metric to track usage for.
|
35
|
+
#
|
36
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
39
37
|
|
40
38
|
class Threshold < Orb::Internal::Type::BaseModel
|
41
39
|
# @!attribute value
|
@@ -46,15 +44,15 @@ module Orb
|
|
46
44
|
# @return [Float]
|
47
45
|
required :value, Float
|
48
46
|
|
49
|
-
# @!
|
50
|
-
#
|
51
|
-
#
|
52
|
-
#
|
53
|
-
#
|
54
|
-
#
|
55
|
-
#
|
56
|
-
|
57
|
-
#
|
47
|
+
# @!method initialize(value:)
|
48
|
+
# Some parameter documentations has been truncated, see
|
49
|
+
# {Orb::Models::AlertCreateForSubscriptionParams::Threshold} for more details.
|
50
|
+
#
|
51
|
+
# Thresholds are used to define the conditions under which an alert will be
|
52
|
+
# triggered.
|
53
|
+
#
|
54
|
+
# @param value [Float] The value at which an alert will fire. For credit balance alerts, the alert will
|
55
|
+
# ...
|
58
56
|
end
|
59
57
|
|
60
58
|
# The type of alert to create. This must be a valid alert type.
|
@@ -64,11 +62,8 @@ module Orb
|
|
64
62
|
USAGE_EXCEEDED = :usage_exceeded
|
65
63
|
COST_EXCEEDED = :cost_exceeded
|
66
64
|
|
67
|
-
|
68
|
-
|
69
|
-
# @!parse
|
70
|
-
# # @return [Array<Symbol>]
|
71
|
-
# def self.values; end
|
65
|
+
# @!method self.values
|
66
|
+
# @return [Array<Symbol>]
|
72
67
|
end
|
73
68
|
end
|
74
69
|
end
|
@@ -4,8 +4,7 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
# @see Orb::Resources::Alerts#disable
|
6
6
|
class AlertDisableParams < Orb::Internal::Type::BaseModel
|
7
|
-
|
8
|
-
# extend Orb::Internal::Type::RequestParameters::Converter
|
7
|
+
extend Orb::Internal::Type::RequestParameters::Converter
|
9
8
|
include Orb::Internal::Type::RequestParameters
|
10
9
|
|
11
10
|
# @!attribute subscription_id
|
@@ -14,13 +13,10 @@ module Orb
|
|
14
13
|
# @return [String, nil]
|
15
14
|
optional :subscription_id, String, nil?: true
|
16
15
|
|
17
|
-
# @!
|
18
|
-
#
|
19
|
-
#
|
20
|
-
#
|
21
|
-
# def initialize(subscription_id: nil, request_options: {}, **) = super
|
22
|
-
|
23
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
16
|
+
# @!method initialize(subscription_id: nil, request_options: {})
|
17
|
+
# @param subscription_id [String, nil] Used to update the status of a plan alert scoped to this subscription_id
|
18
|
+
#
|
19
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
24
20
|
end
|
25
21
|
end
|
26
22
|
end
|
@@ -4,8 +4,7 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
# @see Orb::Resources::Alerts#enable
|
6
6
|
class AlertEnableParams < Orb::Internal::Type::BaseModel
|
7
|
-
|
8
|
-
# extend Orb::Internal::Type::RequestParameters::Converter
|
7
|
+
extend Orb::Internal::Type::RequestParameters::Converter
|
9
8
|
include Orb::Internal::Type::RequestParameters
|
10
9
|
|
11
10
|
# @!attribute subscription_id
|
@@ -14,13 +13,10 @@ module Orb
|
|
14
13
|
# @return [String, nil]
|
15
14
|
optional :subscription_id, String, nil?: true
|
16
15
|
|
17
|
-
# @!
|
18
|
-
#
|
19
|
-
#
|
20
|
-
#
|
21
|
-
# def initialize(subscription_id: nil, request_options: {}, **) = super
|
22
|
-
|
23
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
16
|
+
# @!method initialize(subscription_id: nil, request_options: {})
|
17
|
+
# @param subscription_id [String, nil] Used to update the status of a plan alert scoped to this subscription_id
|
18
|
+
#
|
19
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
24
20
|
end
|
25
21
|
end
|
26
22
|
end
|
@@ -4,8 +4,7 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
# @see Orb::Resources::Alerts#list
|
6
6
|
class AlertListParams < Orb::Internal::Type::BaseModel
|
7
|
-
|
8
|
-
# extend Orb::Internal::Type::RequestParameters::Converter
|
7
|
+
extend Orb::Internal::Type::RequestParameters::Converter
|
9
8
|
include Orb::Internal::Type::RequestParameters
|
10
9
|
|
11
10
|
# @!attribute created_at_gt
|
@@ -47,51 +46,42 @@ module Orb
|
|
47
46
|
# @return [String, nil]
|
48
47
|
optional :external_customer_id, String, nil?: true
|
49
48
|
|
50
|
-
# @!attribute
|
49
|
+
# @!attribute limit
|
51
50
|
# The number of items to fetch. Defaults to 20.
|
52
51
|
#
|
53
52
|
# @return [Integer, nil]
|
54
53
|
optional :limit, Integer
|
55
54
|
|
56
|
-
# @!parse
|
57
|
-
# # @return [Integer]
|
58
|
-
# attr_writer :limit
|
59
|
-
|
60
55
|
# @!attribute subscription_id
|
61
56
|
# Fetch alerts scoped to this subscription_id
|
62
57
|
#
|
63
58
|
# @return [String, nil]
|
64
59
|
optional :subscription_id, String, nil?: true
|
65
60
|
|
66
|
-
# @!
|
67
|
-
#
|
68
|
-
#
|
69
|
-
#
|
70
|
-
#
|
71
|
-
#
|
72
|
-
#
|
73
|
-
#
|
74
|
-
#
|
75
|
-
#
|
76
|
-
#
|
77
|
-
#
|
78
|
-
#
|
79
|
-
#
|
80
|
-
#
|
81
|
-
#
|
82
|
-
#
|
83
|
-
#
|
84
|
-
#
|
85
|
-
#
|
86
|
-
#
|
87
|
-
#
|
88
|
-
#
|
89
|
-
#
|
90
|
-
# )
|
91
|
-
# super
|
92
|
-
# end
|
93
|
-
|
94
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
61
|
+
# @!method initialize(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, customer_id: nil, external_customer_id: nil, limit: nil, subscription_id: nil, request_options: {})
|
62
|
+
# Some parameter documentations has been truncated, see
|
63
|
+
# {Orb::Models::AlertListParams} for more details.
|
64
|
+
#
|
65
|
+
# @param created_at_gt [Time, nil]
|
66
|
+
#
|
67
|
+
# @param created_at_gte [Time, nil]
|
68
|
+
#
|
69
|
+
# @param created_at_lt [Time, nil]
|
70
|
+
#
|
71
|
+
# @param created_at_lte [Time, nil]
|
72
|
+
#
|
73
|
+
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
74
|
+
# ...
|
75
|
+
#
|
76
|
+
# @param customer_id [String, nil] Fetch alerts scoped to this customer_id
|
77
|
+
#
|
78
|
+
# @param external_customer_id [String, nil] Fetch alerts scoped to this external_customer_id
|
79
|
+
#
|
80
|
+
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
81
|
+
#
|
82
|
+
# @param subscription_id [String, nil] Fetch alerts scoped to this subscription_id
|
83
|
+
#
|
84
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
95
85
|
end
|
96
86
|
end
|
97
87
|
end
|
@@ -4,16 +4,11 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
# @see Orb::Resources::Alerts#retrieve
|
6
6
|
class AlertRetrieveParams < Orb::Internal::Type::BaseModel
|
7
|
-
|
8
|
-
# extend Orb::Internal::Type::RequestParameters::Converter
|
7
|
+
extend Orb::Internal::Type::RequestParameters::Converter
|
9
8
|
include Orb::Internal::Type::RequestParameters
|
10
9
|
|
11
|
-
# @!
|
12
|
-
#
|
13
|
-
# #
|
14
|
-
# def initialize(request_options: {}, **) = super
|
15
|
-
|
16
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
10
|
+
# @!method initialize(request_options: {})
|
11
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
17
12
|
end
|
18
13
|
end
|
19
14
|
end
|
@@ -4,8 +4,7 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
# @see Orb::Resources::Alerts#update
|
6
6
|
class AlertUpdateParams < Orb::Internal::Type::BaseModel
|
7
|
-
|
8
|
-
# extend Orb::Internal::Type::RequestParameters::Converter
|
7
|
+
extend Orb::Internal::Type::RequestParameters::Converter
|
9
8
|
include Orb::Internal::Type::RequestParameters
|
10
9
|
|
11
10
|
# @!attribute thresholds
|
@@ -14,13 +13,10 @@ module Orb
|
|
14
13
|
# @return [Array<Orb::Models::AlertUpdateParams::Threshold>]
|
15
14
|
required :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Models::AlertUpdateParams::Threshold] }
|
16
15
|
|
17
|
-
# @!
|
18
|
-
#
|
19
|
-
#
|
20
|
-
#
|
21
|
-
# def initialize(thresholds:, request_options: {}, **) = super
|
22
|
-
|
23
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
16
|
+
# @!method initialize(thresholds:, request_options: {})
|
17
|
+
# @param thresholds [Array<Orb::Models::AlertUpdateParams::Threshold>] The thresholds that define the values at which the alert will be triggered.
|
18
|
+
#
|
19
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
24
20
|
|
25
21
|
class Threshold < Orb::Internal::Type::BaseModel
|
26
22
|
# @!attribute value
|
@@ -31,15 +27,15 @@ module Orb
|
|
31
27
|
# @return [Float]
|
32
28
|
required :value, Float
|
33
29
|
|
34
|
-
# @!
|
35
|
-
#
|
36
|
-
#
|
37
|
-
#
|
38
|
-
#
|
39
|
-
#
|
40
|
-
#
|
41
|
-
|
42
|
-
#
|
30
|
+
# @!method initialize(value:)
|
31
|
+
# Some parameter documentations has been truncated, see
|
32
|
+
# {Orb::Models::AlertUpdateParams::Threshold} for more details.
|
33
|
+
#
|
34
|
+
# Thresholds are used to define the conditions under which an alert will be
|
35
|
+
# triggered.
|
36
|
+
#
|
37
|
+
# @param value [Float] The value at which an alert will fire. For credit balance alerts, the alert will
|
38
|
+
# ...
|
43
39
|
end
|
44
40
|
end
|
45
41
|
end
|
@@ -26,15 +26,18 @@ module Orb
|
|
26
26
|
# @return [String, nil]
|
27
27
|
optional :reason, String, nil?: true
|
28
28
|
|
29
|
-
# @!
|
30
|
-
#
|
31
|
-
#
|
32
|
-
#
|
33
|
-
#
|
34
|
-
#
|
35
|
-
#
|
36
|
-
|
37
|
-
#
|
29
|
+
# @!method initialize(amount_discount:, applies_to_price_ids:, discount_type:, reason: nil)
|
30
|
+
# Some parameter documentations has been truncated, see
|
31
|
+
# {Orb::Models::AmountDiscount} for more details.
|
32
|
+
#
|
33
|
+
# @param amount_discount [String] Only available if discount_type is `amount`.
|
34
|
+
#
|
35
|
+
# @param applies_to_price_ids [Array<String>] List of price_ids that this discount applies to. For plan/plan phase discounts,
|
36
|
+
# ...
|
37
|
+
#
|
38
|
+
# @param discount_type [Symbol, Orb::Models::AmountDiscount::DiscountType]
|
39
|
+
#
|
40
|
+
# @param reason [String, nil]
|
38
41
|
|
39
42
|
# @see Orb::Models::AmountDiscount#discount_type
|
40
43
|
module DiscountType
|
@@ -42,11 +45,8 @@ module Orb
|
|
42
45
|
|
43
46
|
AMOUNT = :amount
|
44
47
|
|
45
|
-
|
46
|
-
|
47
|
-
# @!parse
|
48
|
-
# # @return [Array<Symbol>]
|
49
|
-
# def self.values; end
|
48
|
+
# @!method self.values
|
49
|
+
# @return [Array<Symbol>]
|
50
50
|
end
|
51
51
|
end
|
52
52
|
end
|
@@ -41,21 +41,27 @@ module Orb
|
|
41
41
|
# @return [Symbol, Orb::Models::BillableMetric::Status]
|
42
42
|
required :status, enum: -> { Orb::Models::BillableMetric::Status }
|
43
43
|
|
44
|
-
# @!
|
45
|
-
#
|
46
|
-
#
|
47
|
-
#
|
48
|
-
#
|
49
|
-
#
|
50
|
-
#
|
51
|
-
#
|
52
|
-
#
|
53
|
-
#
|
54
|
-
#
|
55
|
-
#
|
56
|
-
#
|
57
|
-
|
58
|
-
#
|
44
|
+
# @!method initialize(id:, description:, item:, metadata:, name:, status:)
|
45
|
+
# Some parameter documentations has been truncated, see
|
46
|
+
# {Orb::Models::BillableMetric} for more details.
|
47
|
+
#
|
48
|
+
# The Metric resource represents a calculation of a quantity based on events.
|
49
|
+
# Metrics are defined by the query that transforms raw usage events into
|
50
|
+
# meaningful values for your customers.
|
51
|
+
#
|
52
|
+
# @param id [String]
|
53
|
+
#
|
54
|
+
# @param description [String, nil]
|
55
|
+
#
|
56
|
+
# @param item [Orb::Models::Item] The Item resource represents a sellable product or good. Items are associated wi
|
57
|
+
# ...
|
58
|
+
#
|
59
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
60
|
+
# ...
|
61
|
+
#
|
62
|
+
# @param name [String]
|
63
|
+
#
|
64
|
+
# @param status [Symbol, Orb::Models::BillableMetric::Status]
|
59
65
|
|
60
66
|
# @see Orb::Models::BillableMetric#status
|
61
67
|
module Status
|
@@ -65,11 +71,8 @@ module Orb
|
|
65
71
|
DRAFT = :draft
|
66
72
|
ARCHIVED = :archived
|
67
73
|
|
68
|
-
|
69
|
-
|
70
|
-
# @!parse
|
71
|
-
# # @return [Array<Symbol>]
|
72
|
-
# def self.values; end
|
74
|
+
# @!method self.values
|
75
|
+
# @return [Array<Symbol>]
|
73
76
|
end
|
74
77
|
end
|
75
78
|
end
|
data/lib/orb/models/coupon.rb
CHANGED
@@ -48,24 +48,32 @@ module Orb
|
|
48
48
|
# @return [Integer]
|
49
49
|
required :times_redeemed, Integer
|
50
50
|
|
51
|
-
# @!
|
52
|
-
#
|
53
|
-
#
|
54
|
-
#
|
55
|
-
#
|
56
|
-
#
|
57
|
-
#
|
58
|
-
#
|
59
|
-
#
|
60
|
-
#
|
61
|
-
#
|
62
|
-
#
|
63
|
-
#
|
64
|
-
#
|
65
|
-
#
|
66
|
-
#
|
67
|
-
|
68
|
-
#
|
51
|
+
# @!method initialize(id:, archived_at:, discount:, duration_in_months:, max_redemptions:, redemption_code:, times_redeemed:)
|
52
|
+
# Some parameter documentations has been truncated, see {Orb::Models::Coupon} for
|
53
|
+
# more details.
|
54
|
+
#
|
55
|
+
# A coupon represents a reusable discount configuration that can be applied either
|
56
|
+
# as a fixed or percentage amount to an invoice or subscription. Coupons are
|
57
|
+
# activated using a redemption code, which applies the discount to a subscription
|
58
|
+
# or invoice. The duration of a coupon determines how long it remains available
|
59
|
+
# for use by end users.
|
60
|
+
#
|
61
|
+
# @param id [String] Also referred to as coupon_id in this documentation.
|
62
|
+
#
|
63
|
+
# @param archived_at [Time, nil] An archived coupon can no longer be redeemed. Active coupons will have a value o
|
64
|
+
# ...
|
65
|
+
#
|
66
|
+
# @param discount [Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount]
|
67
|
+
#
|
68
|
+
# @param duration_in_months [Integer, nil] This allows for a coupon's discount to apply for a limited time (determined in m
|
69
|
+
# ...
|
70
|
+
#
|
71
|
+
# @param max_redemptions [Integer, nil] The maximum number of redemptions allowed for this coupon before it is exhausted
|
72
|
+
# ...
|
73
|
+
#
|
74
|
+
# @param redemption_code [String] This string can be used to redeem this coupon for a given subscription.
|
75
|
+
#
|
76
|
+
# @param times_redeemed [Integer] The number of times this coupon has been redeemed.
|
69
77
|
|
70
78
|
# @see Orb::Models::Coupon#discount
|
71
79
|
module Discount
|
@@ -77,9 +85,8 @@ module Orb
|
|
77
85
|
|
78
86
|
variant :amount, -> { Orb::Models::AmountDiscount }
|
79
87
|
|
80
|
-
# @!
|
81
|
-
#
|
82
|
-
# def self.variants; end
|
88
|
+
# @!method self.variants
|
89
|
+
# @return [Array(Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount)]
|
83
90
|
end
|
84
91
|
end
|
85
92
|
end
|
@@ -4,16 +4,11 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
# @see Orb::Resources::Coupons#archive
|
6
6
|
class CouponArchiveParams < Orb::Internal::Type::BaseModel
|
7
|
-
|
8
|
-
# extend Orb::Internal::Type::RequestParameters::Converter
|
7
|
+
extend Orb::Internal::Type::RequestParameters::Converter
|
9
8
|
include Orb::Internal::Type::RequestParameters
|
10
9
|
|
11
|
-
# @!
|
12
|
-
#
|
13
|
-
# #
|
14
|
-
# def initialize(request_options: {}, **) = super
|
15
|
-
|
16
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
10
|
+
# @!method initialize(request_options: {})
|
11
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
17
12
|
end
|
18
13
|
end
|
19
14
|
end
|
@@ -4,8 +4,7 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
# @see Orb::Resources::Coupons#create
|
6
6
|
class CouponCreateParams < Orb::Internal::Type::BaseModel
|
7
|
-
|
8
|
-
# extend Orb::Internal::Type::RequestParameters::Converter
|
7
|
+
extend Orb::Internal::Type::RequestParameters::Converter
|
9
8
|
include Orb::Internal::Type::RequestParameters
|
10
9
|
|
11
10
|
# @!attribute discount
|
@@ -33,16 +32,21 @@ module Orb
|
|
33
32
|
# @return [Integer, nil]
|
34
33
|
optional :max_redemptions, Integer, nil?: true
|
35
34
|
|
36
|
-
# @!
|
37
|
-
#
|
38
|
-
#
|
39
|
-
#
|
40
|
-
#
|
41
|
-
#
|
42
|
-
#
|
43
|
-
#
|
44
|
-
|
45
|
-
#
|
35
|
+
# @!method initialize(discount:, redemption_code:, duration_in_months: nil, max_redemptions: nil, request_options: {})
|
36
|
+
# Some parameter documentations has been truncated, see
|
37
|
+
# {Orb::Models::CouponCreateParams} for more details.
|
38
|
+
#
|
39
|
+
# @param discount [Orb::Models::CouponCreateParams::Discount::NewCouponPercentageDiscount, Orb::Models::CouponCreateParams::Discount::NewCouponAmountDiscount]
|
40
|
+
#
|
41
|
+
# @param redemption_code [String] This string can be used to redeem this coupon for a given subscription.
|
42
|
+
#
|
43
|
+
# @param duration_in_months [Integer, nil] This allows for a coupon's discount to apply for a limited time (determined in m
|
44
|
+
# ...
|
45
|
+
#
|
46
|
+
# @param max_redemptions [Integer, nil] The maximum number of redemptions allowed for this coupon before it is exhausted
|
47
|
+
# ...
|
48
|
+
#
|
49
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
46
50
|
|
47
51
|
module Discount
|
48
52
|
extend Orb::Internal::Type::Union
|
@@ -64,13 +68,9 @@ module Orb
|
|
64
68
|
# @return [Float]
|
65
69
|
required :percentage_discount, Float
|
66
70
|
|
67
|
-
# @!
|
68
|
-
#
|
69
|
-
#
|
70
|
-
# #
|
71
|
-
# def initialize(percentage_discount:, discount_type: :percentage, **) = super
|
72
|
-
|
73
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
71
|
+
# @!method initialize(percentage_discount:, discount_type: :percentage)
|
72
|
+
# @param percentage_discount [Float]
|
73
|
+
# @param discount_type [Symbol, :percentage]
|
74
74
|
end
|
75
75
|
|
76
76
|
class NewCouponAmountDiscount < Orb::Internal::Type::BaseModel
|
@@ -84,18 +84,13 @@ module Orb
|
|
84
84
|
# @return [Symbol, :amount]
|
85
85
|
required :discount_type, const: :amount
|
86
86
|
|
87
|
-
# @!
|
88
|
-
#
|
89
|
-
#
|
90
|
-
# #
|
91
|
-
# def initialize(amount_discount:, discount_type: :amount, **) = super
|
92
|
-
|
93
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
87
|
+
# @!method initialize(amount_discount:, discount_type: :amount)
|
88
|
+
# @param amount_discount [String]
|
89
|
+
# @param discount_type [Symbol, :amount]
|
94
90
|
end
|
95
91
|
|
96
|
-
# @!
|
97
|
-
#
|
98
|
-
# def self.variants; end
|
92
|
+
# @!method self.variants
|
93
|
+
# @return [Array(Orb::Models::CouponCreateParams::Discount::NewCouponPercentageDiscount, Orb::Models::CouponCreateParams::Discount::NewCouponAmountDiscount)]
|
99
94
|
end
|
100
95
|
end
|
101
96
|
end
|