orb-billing 0.5.1 → 0.5.3
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 +26 -0
- data/README.md +4 -4
- data/SECURITY.md +2 -2
- data/lib/orb/internal/type/array_of.rb +8 -0
- data/lib/orb/internal/type/base_model.rb +7 -0
- data/lib/orb/internal/type/boolean.rb +8 -0
- data/lib/orb/internal/type/enum.rb +12 -0
- data/lib/orb/internal/type/file_input.rb +7 -0
- data/lib/orb/internal/type/hash_of.rb +8 -0
- data/lib/orb/internal/type/union.rb +12 -0
- data/lib/orb/internal/type/unknown.rb +8 -0
- data/lib/orb/internal/util.rb +45 -0
- data/lib/orb/internal.rb +3 -0
- data/lib/orb/models/alert.rb +23 -23
- data/lib/orb/models/alert_create_for_customer_params.rb +5 -5
- data/lib/orb/models/alert_create_for_external_customer_params.rb +5 -5
- data/lib/orb/models/alert_create_for_subscription_params.rb +5 -5
- data/lib/orb/models/alert_update_params.rb +3 -3
- data/lib/orb/models/amount_discount.rb +5 -5
- data/lib/orb/models/billable_metric.rb +7 -7
- data/lib/orb/models/coupon.rb +6 -10
- data/lib/orb/models/coupon_create_params.rb +3 -9
- data/lib/orb/models/credit_note.rb +33 -33
- data/lib/orb/models/credit_note_create_params.rb +4 -4
- data/lib/orb/models/customer.rb +39 -39
- data/lib/orb/models/customer_create_params.rb +26 -35
- data/lib/orb/models/customer_update_by_external_id_params.rb +26 -35
- data/lib/orb/models/customer_update_params.rb +26 -35
- data/lib/orb/models/customers/balance_transaction_create_params.rb +2 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +2 -2
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +2 -2
- data/lib/orb/models/customers/cost_list_params.rb +2 -2
- data/lib/orb/models/customers/cost_list_response.rb +2 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +7 -7
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +0 -14
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +8 -8
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +0 -14
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +4 -4
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +0 -14
- data/lib/orb/models/customers/credits/ledger_list_params.rb +4 -4
- data/lib/orb/models/customers/credits/ledger_list_response.rb +0 -14
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +6 -6
- data/lib/orb/models/customers/credits/top_up_create_params.rb +6 -5
- data/lib/orb/models/dimensional_price_group.rb +1 -1
- data/lib/orb/models/dimensional_price_groups.rb +4 -4
- data/lib/orb/models/discount.rb +1 -7
- data/lib/orb/models/evaluate_price_group.rb +0 -4
- data/lib/orb/models/event_ingest_params.rb +3 -3
- data/lib/orb/models/events/event_volumes.rb +2 -2
- data/lib/orb/models/invoice.rb +114 -135
- data/lib/orb/models/invoice_create_params.rb +10 -10
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +6 -28
- data/lib/orb/models/invoice_level_discount.rb +1 -5
- data/lib/orb/models/invoice_line_item_create_response.rb +4 -26
- data/lib/orb/models/invoice_list_params.rb +4 -4
- data/lib/orb/models/item.rb +5 -5
- data/lib/orb/models/item_update_params.rb +5 -5
- data/lib/orb/models/percentage_discount.rb +5 -5
- data/lib/orb/models/plan.rb +58 -70
- data/lib/orb/models/plan_create_params.rb +448 -476
- data/lib/orb/models/plan_list_params.rb +2 -2
- data/lib/orb/models/price.rb +1204 -1239
- data/lib/orb/models/price_create_params.rb +50 -50
- data/lib/orb/models/price_evaluate_response.rb +2 -2
- data/lib/orb/models/subscription.rb +58 -78
- data/lib/orb/models/subscription_cancel_params.rb +2 -2
- data/lib/orb/models/subscription_cancel_response.rb +14 -36
- data/lib/orb/models/subscription_change_apply_response.rb +14 -36
- data/lib/orb/models/subscription_change_cancel_response.rb +14 -36
- data/lib/orb/models/subscription_change_retrieve_response.rb +14 -36
- data/lib/orb/models/subscription_create_params.rb +1002 -1075
- data/lib/orb/models/subscription_create_response.rb +14 -36
- data/lib/orb/models/subscription_fetch_costs_params.rb +2 -2
- data/lib/orb/models/subscription_fetch_costs_response.rb +2 -2
- data/lib/orb/models/subscription_fetch_usage_params.rb +4 -4
- data/lib/orb/models/subscription_list_params.rb +2 -2
- data/lib/orb/models/subscription_price_intervals_params.rb +596 -674
- data/lib/orb/models/subscription_price_intervals_response.rb +14 -36
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +973 -1059
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +14 -36
- data/lib/orb/models/subscription_trigger_phase_response.rb +14 -36
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +14 -36
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +14 -36
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +14 -36
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +2 -2
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +14 -36
- data/lib/orb/models/subscription_update_trial_params.rb +3 -3
- data/lib/orb/models/subscription_update_trial_response.rb +14 -36
- data/lib/orb/models/subscription_usage.rb +26 -35
- data/lib/orb/models/subscriptions.rb +4 -4
- data/lib/orb/models/trial_discount.rb +5 -5
- data/lib/orb/models/usage_discount.rb +5 -5
- data/lib/orb/models.rb +30 -16
- data/lib/orb/resources/alerts.rb +15 -15
- data/lib/orb/resources/coupons/subscriptions.rb +1 -1
- data/lib/orb/resources/coupons.rb +5 -5
- data/lib/orb/resources/credit_notes.rb +5 -5
- data/lib/orb/resources/customers/balance_transactions.rb +1 -1
- data/lib/orb/resources/customers/costs.rb +2 -2
- data/lib/orb/resources/customers/credits/ledger.rb +10 -10
- data/lib/orb/resources/customers/credits/top_ups.rb +4 -4
- data/lib/orb/resources/customers.rb +30 -30
- data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +1 -1
- data/lib/orb/resources/dimensional_price_groups.rb +3 -3
- data/lib/orb/resources/events/volume.rb +1 -1
- data/lib/orb/resources/events.rb +1 -1
- data/lib/orb/resources/invoices.rb +12 -12
- data/lib/orb/resources/items.rb +5 -5
- data/lib/orb/resources/metrics.rb +4 -4
- data/lib/orb/resources/plans/external_plan_id.rb +2 -2
- data/lib/orb/resources/plans.rb +7 -7
- data/lib/orb/resources/prices/external_price_id.rb +2 -2
- data/lib/orb/resources/prices.rb +17 -17
- data/lib/orb/resources/subscriptions.rb +32 -32
- data/lib/orb/version.rb +1 -1
- data/rbi/orb/internal/type/array_of.rbi +6 -0
- data/rbi/orb/internal/type/base_model.rbi +5 -0
- data/rbi/orb/internal/type/boolean.rbi +6 -0
- data/rbi/orb/internal/type/enum.rbi +5 -0
- data/rbi/orb/internal/type/file_input.rbi +5 -0
- data/rbi/orb/internal/type/hash_of.rbi +6 -0
- data/rbi/orb/internal/type/union.rbi +5 -0
- data/rbi/orb/internal/type/unknown.rbi +6 -0
- data/rbi/orb/internal/util.rbi +30 -0
- data/rbi/orb/internal.rbi +3 -0
- data/rbi/orb/models/coupon.rbi +2 -2
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +2 -65
- data/rbi/orb/models/customers/cost_list_response.rbi +2 -65
- data/rbi/orb/models/evaluate_price_group.rbi +7 -3
- data/rbi/orb/models/invoice.rbi +10 -149
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +10 -133
- data/rbi/orb/models/invoice_line_item_create_response.rbi +8 -114
- data/rbi/orb/models/plan.rbi +8 -134
- data/rbi/orb/models/price.rbi +56 -588
- data/rbi/orb/models/subscription.rbi +6 -99
- data/rbi/orb/models/subscription_cancel_response.rbi +6 -89
- data/rbi/orb/models/subscription_change_apply_response.rbi +6 -89
- data/rbi/orb/models/subscription_change_cancel_response.rbi +6 -89
- data/rbi/orb/models/subscription_change_retrieve_response.rbi +6 -89
- data/rbi/orb/models/subscription_create_response.rbi +6 -89
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +2 -65
- data/rbi/orb/models/subscription_price_intervals_response.rbi +6 -89
- data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +6 -89
- data/rbi/orb/models/subscription_trigger_phase_response.rbi +6 -89
- data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +6 -89
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +6 -89
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +6 -89
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +6 -89
- data/rbi/orb/models/subscription_update_trial_response.rbi +6 -89
- data/rbi/orb/resources/customers/credits/ledger.rbi +4 -36
- data/rbi/orb/resources/prices/external_price_id.rbi +2 -64
- data/rbi/orb/resources/prices.rbi +4 -130
- data/rbi/orb/resources/subscriptions.rbi +1 -6
- data/sig/orb/internal/page.rbs +2 -0
- data/sig/orb/internal/type/array_of.rbs +3 -0
- data/sig/orb/internal/type/base_model.rbs +2 -0
- data/sig/orb/internal/type/boolean.rbs +3 -0
- data/sig/orb/internal/type/enum.rbs +2 -0
- data/sig/orb/internal/type/file_input.rbs +2 -0
- data/sig/orb/internal/type/hash_of.rbs +3 -0
- data/sig/orb/internal/type/union.rbs +2 -0
- data/sig/orb/internal/type/unknown.rbs +3 -0
- data/sig/orb/internal/util.rbs +12 -0
- data/sig/orb/internal.rbs +2 -0
- data/sig/orb/models/alert.rbs +32 -4
- data/sig/orb/models/alert_create_for_customer_params.rbs +9 -0
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +9 -0
- data/sig/orb/models/alert_create_for_subscription_params.rbs +9 -0
- data/sig/orb/models/alert_disable_params.rbs +5 -0
- data/sig/orb/models/alert_enable_params.rbs +5 -0
- data/sig/orb/models/alert_list_params.rbs +13 -0
- data/sig/orb/models/alert_retrieve_params.rbs +2 -0
- data/sig/orb/models/alert_update_params.rbs +7 -0
- data/sig/orb/models/amount_discount.rbs +11 -4
- data/sig/orb/models/billable_metric.rbs +13 -4
- data/sig/orb/models/coupon.rbs +14 -4
- data/sig/orb/models/coupon_archive_params.rbs +2 -0
- data/sig/orb/models/coupon_create_params.rbs +15 -0
- data/sig/orb/models/coupon_fetch_params.rbs +2 -0
- data/sig/orb/models/coupon_list_params.rbs +8 -0
- data/sig/orb/models/coupons/subscription_list_params.rbs +6 -0
- data/sig/orb/models/credit_note.rbs +88 -20
- data/sig/orb/models/credit_note_create_params.rbs +9 -0
- data/sig/orb/models/credit_note_fetch_params.rbs +2 -0
- data/sig/orb/models/credit_note_list_params.rbs +10 -0
- data/sig/orb/models/customer.rbs +86 -16
- data/sig/orb/models/customer_create_params.rbs +79 -8
- data/sig/orb/models/customer_delete_params.rbs +2 -0
- data/sig/orb/models/customer_fetch_by_external_id_params.rbs +2 -0
- data/sig/orb/models/customer_fetch_params.rbs +2 -0
- data/sig/orb/models/customer_list_params.rbs +10 -0
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +2 -0
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +2 -0
- data/sig/orb/models/customer_update_by_external_id_params.rbs +78 -8
- data/sig/orb/models/customer_update_params.rbs +78 -8
- data/sig/orb/models/customers/balance_transaction_create_params.rbs +7 -0
- data/sig/orb/models/customers/balance_transaction_create_response.rbs +17 -0
- data/sig/orb/models/customers/balance_transaction_list_params.rbs +10 -0
- data/sig/orb/models/customers/balance_transaction_list_response.rbs +17 -0
- data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +8 -0
- data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +20 -0
- data/sig/orb/models/customers/cost_list_params.rbs +8 -0
- data/sig/orb/models/customers/cost_list_response.rbs +20 -0
- data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +8 -0
- data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +10 -0
- data/sig/orb/models/customers/credit_list_params.rbs +8 -0
- data/sig/orb/models/customers/credit_list_response.rbs +10 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +23 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +177 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +23 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +177 -0
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +14 -0
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +177 -0
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +14 -0
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +177 -0
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +19 -0
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +18 -0
- data/sig/orb/models/customers/credits/top_up_create_params.rbs +19 -0
- data/sig/orb/models/customers/credits/top_up_create_response.rbs +18 -0
- data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +5 -0
- data/sig/orb/models/customers/credits/top_up_delete_params.rbs +5 -0
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +6 -0
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +18 -0
- data/sig/orb/models/customers/credits/top_up_list_params.rbs +6 -0
- data/sig/orb/models/customers/credits/top_up_list_response.rbs +18 -0
- data/sig/orb/models/dimensional_price_group.rbs +9 -0
- data/sig/orb/models/dimensional_price_group_create_params.rbs +9 -0
- data/sig/orb/models/dimensional_price_group_list_params.rbs +6 -0
- data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +2 -0
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +2 -0
- data/sig/orb/models/dimensional_price_groups.rbs +5 -0
- data/sig/orb/models/evaluate_price_group.rbs +10 -4
- data/sig/orb/models/event_deprecate_params.rbs +2 -0
- data/sig/orb/models/event_deprecate_response.rbs +2 -0
- data/sig/orb/models/event_ingest_params.rbs +16 -0
- data/sig/orb/models/event_ingest_response.rbs +15 -0
- data/sig/orb/models/event_search_params.rbs +7 -0
- data/sig/orb/models/event_search_response.rbs +12 -0
- data/sig/orb/models/event_update_params.rbs +9 -0
- data/sig/orb/models/event_update_response.rbs +2 -0
- data/sig/orb/models/events/backfill_close_params.rbs +2 -0
- data/sig/orb/models/events/backfill_close_response.rbs +14 -0
- data/sig/orb/models/events/backfill_create_params.rbs +11 -0
- data/sig/orb/models/events/backfill_create_response.rbs +14 -0
- data/sig/orb/models/events/backfill_fetch_params.rbs +2 -0
- data/sig/orb/models/events/backfill_fetch_response.rbs +14 -0
- data/sig/orb/models/events/backfill_list_params.rbs +6 -0
- data/sig/orb/models/events/backfill_list_response.rbs +14 -0
- data/sig/orb/models/events/backfill_revert_params.rbs +2 -0
- data/sig/orb/models/events/backfill_revert_response.rbs +14 -0
- data/sig/orb/models/events/event_volumes.rbs +8 -0
- data/sig/orb/models/events/volume_list_params.rbs +8 -0
- data/sig/orb/models/invoice.rbs +293 -36
- data/sig/orb/models/invoice_create_params.rbs +30 -4
- data/sig/orb/models/invoice_fetch_params.rbs +2 -0
- data/sig/orb/models/invoice_fetch_upcoming_params.rbs +5 -0
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +257 -0
- data/sig/orb/models/invoice_issue_params.rbs +5 -0
- data/sig/orb/models/invoice_line_item_create_params.rbs +10 -0
- data/sig/orb/models/invoice_line_item_create_response.rbs +132 -0
- data/sig/orb/models/invoice_list_params.rbs +27 -4
- data/sig/orb/models/invoice_mark_paid_params.rbs +7 -0
- data/sig/orb/models/invoice_pay_params.rbs +2 -0
- data/sig/orb/models/invoice_update_params.rbs +5 -0
- data/sig/orb/models/invoice_void_params.rbs +2 -0
- data/sig/orb/models/item.rbs +16 -4
- data/sig/orb/models/item_create_params.rbs +2 -0
- data/sig/orb/models/item_fetch_params.rbs +2 -0
- data/sig/orb/models/item_list_params.rbs +6 -0
- data/sig/orb/models/item_update_params.rbs +15 -4
- data/sig/orb/models/metric_create_params.rbs +9 -0
- data/sig/orb/models/metric_fetch_params.rbs +2 -0
- data/sig/orb/models/metric_list_params.rbs +10 -0
- data/sig/orb/models/metric_update_params.rbs +5 -0
- data/sig/orb/models/pagination_metadata.rbs +2 -0
- data/sig/orb/models/percentage_discount.rbs +11 -4
- data/sig/orb/models/plan.rbs +141 -16
- data/sig/orb/models/plan_create_params.rbs +1070 -304
- data/sig/orb/models/plan_fetch_params.rbs +2 -0
- data/sig/orb/models/plan_list_params.rbs +11 -0
- data/sig/orb/models/plan_update_params.rbs +6 -0
- data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +2 -0
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +6 -0
- data/sig/orb/models/price.rbs +2148 -460
- data/sig/orb/models/price_create_params.rbs +130 -8
- data/sig/orb/models/price_evaluate_params.rbs +10 -0
- data/sig/orb/models/price_evaluate_response.rbs +2 -0
- data/sig/orb/models/price_fetch_params.rbs +2 -0
- data/sig/orb/models/price_list_params.rbs +6 -0
- data/sig/orb/models/price_update_params.rbs +5 -0
- data/sig/orb/models/prices/external_price_id_fetch_params.rbs +2 -0
- data/sig/orb/models/prices/external_price_id_update_params.rbs +5 -0
- data/sig/orb/models/subscription.rbs +177 -12
- data/sig/orb/models/subscription_cancel_params.rbs +7 -0
- data/sig/orb/models/subscription_cancel_response.rbs +173 -0
- data/sig/orb/models/subscription_change_apply_params.rbs +6 -0
- data/sig/orb/models/subscription_change_apply_response.rbs +186 -0
- data/sig/orb/models/subscription_change_cancel_params.rbs +2 -0
- data/sig/orb/models/subscription_change_cancel_response.rbs +186 -0
- data/sig/orb/models/subscription_change_retrieve_params.rbs +2 -0
- data/sig/orb/models/subscription_change_retrieve_response.rbs +186 -0
- data/sig/orb/models/subscription_create_params.rbs +2368 -632
- data/sig/orb/models/subscription_create_response.rbs +173 -0
- data/sig/orb/models/subscription_fetch_costs_params.rbs +8 -0
- data/sig/orb/models/subscription_fetch_costs_response.rbs +20 -0
- data/sig/orb/models/subscription_fetch_params.rbs +2 -0
- data/sig/orb/models/subscription_fetch_schedule_params.rbs +10 -0
- data/sig/orb/models/subscription_fetch_schedule_response.rbs +13 -0
- data/sig/orb/models/subscription_fetch_usage_params.rbs +14 -0
- data/sig/orb/models/subscription_list_params.rbs +13 -0
- data/sig/orb/models/subscription_price_intervals_params.rbs +1348 -396
- data/sig/orb/models/subscription_price_intervals_response.rbs +173 -0
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +2363 -632
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +173 -0
- data/sig/orb/models/subscription_trigger_phase_params.rbs +6 -0
- data/sig/orb/models/subscription_trigger_phase_response.rbs +173 -0
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +2 -0
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +173 -0
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +2 -0
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +173 -0
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +2 -0
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +173 -0
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +9 -0
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +173 -0
- data/sig/orb/models/subscription_update_params.rbs +9 -0
- data/sig/orb/models/subscription_update_trial_params.rbs +6 -0
- data/sig/orb/models/subscription_update_trial_response.rbs +173 -0
- data/sig/orb/models/subscription_usage.rbs +48 -8
- data/sig/orb/models/subscriptions.rbs +5 -0
- data/sig/orb/models/top_level_ping_params.rbs +2 -0
- data/sig/orb/models/top_level_ping_response.rbs +2 -0
- data/sig/orb/models/trial_discount.rbs +12 -4
- data/sig/orb/models/usage_discount.rbs +11 -4
- data/sig/orb/resources/invoices.rbs +1 -1
- data/sig/orb/resources/plans.rbs +1 -1
- metadata +2 -2
@@ -5,17 +5,17 @@ module Orb
|
|
5
5
|
class SubscriptionsAPI < Orb::Internal::Type::BaseModel
|
6
6
|
# @!attribute data
|
7
7
|
#
|
8
|
-
# @return [Array<Orb::Subscription>]
|
8
|
+
# @return [Array<Orb::Models::Subscription>]
|
9
9
|
required :data, -> { Orb::Internal::Type::ArrayOf[Orb::Subscription] }
|
10
10
|
|
11
11
|
# @!attribute pagination_metadata
|
12
12
|
#
|
13
|
-
# @return [Orb::PaginationMetadata]
|
13
|
+
# @return [Orb::Models::PaginationMetadata]
|
14
14
|
required :pagination_metadata, -> { Orb::PaginationMetadata }
|
15
15
|
|
16
16
|
# @!method initialize(data:, pagination_metadata:)
|
17
|
-
# @param data [Array<Orb::Subscription>]
|
18
|
-
# @param pagination_metadata [Orb::PaginationMetadata]
|
17
|
+
# @param data [Array<Orb::Models::Subscription>]
|
18
|
+
# @param pagination_metadata [Orb::Models::PaginationMetadata]
|
19
19
|
end
|
20
20
|
end
|
21
21
|
end
|
@@ -12,7 +12,7 @@ module Orb
|
|
12
12
|
|
13
13
|
# @!attribute discount_type
|
14
14
|
#
|
15
|
-
# @return [Symbol, Orb::TrialDiscount::DiscountType]
|
15
|
+
# @return [Symbol, Orb::Models::TrialDiscount::DiscountType]
|
16
16
|
required :discount_type, enum: -> { Orb::TrialDiscount::DiscountType }
|
17
17
|
|
18
18
|
# @!attribute reason
|
@@ -33,12 +33,12 @@ module Orb
|
|
33
33
|
optional :trial_percentage_discount, Float, nil?: true
|
34
34
|
|
35
35
|
# @!method initialize(applies_to_price_ids:, discount_type:, reason: nil, trial_amount_discount: nil, trial_percentage_discount: nil)
|
36
|
-
# Some parameter documentations has been truncated, see
|
37
|
-
# more details.
|
36
|
+
# Some parameter documentations has been truncated, see
|
37
|
+
# {Orb::Models::TrialDiscount} for more details.
|
38
38
|
#
|
39
39
|
# @param applies_to_price_ids [Array<String>] List of price_ids that this discount applies to. For plan/plan phase discounts,
|
40
40
|
#
|
41
|
-
# @param discount_type [Symbol, Orb::TrialDiscount::DiscountType]
|
41
|
+
# @param discount_type [Symbol, Orb::Models::TrialDiscount::DiscountType]
|
42
42
|
#
|
43
43
|
# @param reason [String, nil]
|
44
44
|
#
|
@@ -46,7 +46,7 @@ module Orb
|
|
46
46
|
#
|
47
47
|
# @param trial_percentage_discount [Float, nil] Only available if discount_type is `trial`
|
48
48
|
|
49
|
-
# @see Orb::TrialDiscount#discount_type
|
49
|
+
# @see Orb::Models::TrialDiscount#discount_type
|
50
50
|
module DiscountType
|
51
51
|
extend Orb::Internal::Type::Enum
|
52
52
|
|
@@ -12,7 +12,7 @@ module Orb
|
|
12
12
|
|
13
13
|
# @!attribute discount_type
|
14
14
|
#
|
15
|
-
# @return [Symbol, Orb::UsageDiscount::DiscountType]
|
15
|
+
# @return [Symbol, Orb::Models::UsageDiscount::DiscountType]
|
16
16
|
required :discount_type, enum: -> { Orb::UsageDiscount::DiscountType }
|
17
17
|
|
18
18
|
# @!attribute usage_discount
|
@@ -28,18 +28,18 @@ module Orb
|
|
28
28
|
optional :reason, String, nil?: true
|
29
29
|
|
30
30
|
# @!method initialize(applies_to_price_ids:, discount_type:, usage_discount:, reason: nil)
|
31
|
-
# Some parameter documentations has been truncated, see
|
32
|
-
# more details.
|
31
|
+
# Some parameter documentations has been truncated, see
|
32
|
+
# {Orb::Models::UsageDiscount} for more details.
|
33
33
|
#
|
34
34
|
# @param applies_to_price_ids [Array<String>] List of price_ids that this discount applies to. For plan/plan phase discounts,
|
35
35
|
#
|
36
|
-
# @param discount_type [Symbol, Orb::UsageDiscount::DiscountType]
|
36
|
+
# @param discount_type [Symbol, Orb::Models::UsageDiscount::DiscountType]
|
37
37
|
#
|
38
38
|
# @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
|
39
39
|
#
|
40
40
|
# @param reason [String, nil]
|
41
41
|
|
42
|
-
# @see Orb::UsageDiscount#discount_type
|
42
|
+
# @see Orb::Models::UsageDiscount#discount_type
|
43
43
|
module DiscountType
|
44
44
|
extend Orb::Internal::Type::Enum
|
45
45
|
|
data/lib/orb/models.rb
CHANGED
@@ -5,26 +5,40 @@ module Orb
|
|
5
5
|
cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, Orb::Internal::AnyHash) } }
|
6
6
|
end
|
7
7
|
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
8
|
+
Orb::Internal::Util.walk_namespaces(Orb::Models).each do |mod|
|
9
|
+
case mod
|
10
|
+
in Orb::Internal::Type::Enum | Orb::Internal::Type::Union
|
11
|
+
mod.constants.each do |name|
|
12
|
+
case mod.const_get(name)
|
13
|
+
in true | false
|
14
|
+
mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T.all(T::Boolean, mod) } }
|
15
|
+
mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
|
16
|
+
in Integer
|
17
|
+
mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { T.all(Integer, mod) } }
|
18
|
+
mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
|
19
|
+
in Float
|
20
|
+
mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { T.all(Float, mod) } }
|
21
|
+
mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
|
22
|
+
in Symbol
|
23
|
+
mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { T.all(Symbol, mod) } }
|
24
|
+
mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
|
25
|
+
else
|
26
|
+
end
|
24
27
|
end
|
28
|
+
else
|
25
29
|
end
|
26
30
|
end
|
27
31
|
|
32
|
+
Orb::Internal::Util.walk_namespaces(Orb::Models)
|
33
|
+
.lazy
|
34
|
+
.grep(Orb::Internal::Type::Union)
|
35
|
+
.each do |mod|
|
36
|
+
const = :Variants
|
37
|
+
next if mod.sorbet_constant_defined?(const)
|
38
|
+
|
39
|
+
mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
|
40
|
+
end
|
41
|
+
|
28
42
|
Alert = Orb::Models::Alert
|
29
43
|
|
30
44
|
AlertCreateForCustomerParams = Orb::Models::AlertCreateForCustomerParams
|
data/lib/orb/resources/alerts.rb
CHANGED
@@ -10,7 +10,7 @@ module Orb
|
|
10
10
|
# @param alert_id [String]
|
11
11
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
12
12
|
#
|
13
|
-
# @return [Orb::Alert]
|
13
|
+
# @return [Orb::Models::Alert]
|
14
14
|
#
|
15
15
|
# @see Orb::Models::AlertRetrieveParams
|
16
16
|
def retrieve(alert_id, params = {})
|
@@ -28,11 +28,11 @@ module Orb
|
|
28
28
|
#
|
29
29
|
# @param alert_configuration_id [String]
|
30
30
|
#
|
31
|
-
# @param thresholds [Array<Orb::AlertUpdateParams::Threshold>] The thresholds that define the values at which the alert will be triggered.
|
31
|
+
# @param thresholds [Array<Orb::Models::AlertUpdateParams::Threshold>] The thresholds that define the values at which the alert will be triggered.
|
32
32
|
#
|
33
33
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
34
34
|
#
|
35
|
-
# @return [Orb::Alert]
|
35
|
+
# @return [Orb::Models::Alert]
|
36
36
|
#
|
37
37
|
# @see Orb::Models::AlertUpdateParams
|
38
38
|
def update(alert_configuration_id, params)
|
@@ -83,7 +83,7 @@ module Orb
|
|
83
83
|
#
|
84
84
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
85
85
|
#
|
86
|
-
# @return [Orb::Internal::Page<Orb::Alert>]
|
86
|
+
# @return [Orb::Internal::Page<Orb::Models::Alert>]
|
87
87
|
#
|
88
88
|
# @see Orb::Models::AlertListParams
|
89
89
|
def list(params = {})
|
@@ -118,13 +118,13 @@ module Orb
|
|
118
118
|
#
|
119
119
|
# @param currency [String] The case sensitive currency or custom pricing unit to use for this alert.
|
120
120
|
#
|
121
|
-
# @param type [Symbol, Orb::AlertCreateForCustomerParams::Type] The type of alert to create. This must be a valid alert type.
|
121
|
+
# @param type [Symbol, Orb::Models::AlertCreateForCustomerParams::Type] The type of alert to create. This must be a valid alert type.
|
122
122
|
#
|
123
|
-
# @param thresholds [Array<Orb::AlertCreateForCustomerParams::Threshold>, nil] The thresholds that define the values at which the alert will be triggered.
|
123
|
+
# @param thresholds [Array<Orb::Models::AlertCreateForCustomerParams::Threshold>, nil] The thresholds that define the values at which the alert will be triggered.
|
124
124
|
#
|
125
125
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
126
126
|
#
|
127
|
-
# @return [Orb::Alert]
|
127
|
+
# @return [Orb::Models::Alert]
|
128
128
|
#
|
129
129
|
# @see Orb::Models::AlertCreateForCustomerParams
|
130
130
|
def create_for_customer(customer_id, params)
|
@@ -153,13 +153,13 @@ module Orb
|
|
153
153
|
#
|
154
154
|
# @param currency [String] The case sensitive currency or custom pricing unit to use for this alert.
|
155
155
|
#
|
156
|
-
# @param type [Symbol, Orb::AlertCreateForExternalCustomerParams::Type] The type of alert to create. This must be a valid alert type.
|
156
|
+
# @param type [Symbol, Orb::Models::AlertCreateForExternalCustomerParams::Type] The type of alert to create. This must be a valid alert type.
|
157
157
|
#
|
158
|
-
# @param thresholds [Array<Orb::AlertCreateForExternalCustomerParams::Threshold>, nil] The thresholds that define the values at which the alert will be triggered.
|
158
|
+
# @param thresholds [Array<Orb::Models::AlertCreateForExternalCustomerParams::Threshold>, nil] The thresholds that define the values at which the alert will be triggered.
|
159
159
|
#
|
160
160
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
161
161
|
#
|
162
|
-
# @return [Orb::Alert]
|
162
|
+
# @return [Orb::Models::Alert]
|
163
163
|
#
|
164
164
|
# @see Orb::Models::AlertCreateForExternalCustomerParams
|
165
165
|
def create_for_external_customer(external_customer_id, params)
|
@@ -189,15 +189,15 @@ module Orb
|
|
189
189
|
#
|
190
190
|
# @param subscription_id [String]
|
191
191
|
#
|
192
|
-
# @param thresholds [Array<Orb::AlertCreateForSubscriptionParams::Threshold>] The thresholds that define the values at which the alert will be triggered.
|
192
|
+
# @param thresholds [Array<Orb::Models::AlertCreateForSubscriptionParams::Threshold>] The thresholds that define the values at which the alert will be triggered.
|
193
193
|
#
|
194
|
-
# @param type [Symbol, Orb::AlertCreateForSubscriptionParams::Type] The type of alert to create. This must be a valid alert type.
|
194
|
+
# @param type [Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type] The type of alert to create. This must be a valid alert type.
|
195
195
|
#
|
196
196
|
# @param metric_id [String, nil] The metric to track usage for.
|
197
197
|
#
|
198
198
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
199
199
|
#
|
200
|
-
# @return [Orb::Alert]
|
200
|
+
# @return [Orb::Models::Alert]
|
201
201
|
#
|
202
202
|
# @see Orb::Models::AlertCreateForSubscriptionParams
|
203
203
|
def create_for_subscription(subscription_id, params)
|
@@ -223,7 +223,7 @@ module Orb
|
|
223
223
|
#
|
224
224
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
225
225
|
#
|
226
|
-
# @return [Orb::Alert]
|
226
|
+
# @return [Orb::Models::Alert]
|
227
227
|
#
|
228
228
|
# @see Orb::Models::AlertDisableParams
|
229
229
|
def disable(alert_configuration_id, params = {})
|
@@ -249,7 +249,7 @@ module Orb
|
|
249
249
|
#
|
250
250
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
251
251
|
#
|
252
|
-
# @return [Orb::Alert]
|
252
|
+
# @return [Orb::Models::Alert]
|
253
253
|
#
|
254
254
|
# @see Orb::Models::AlertEnableParams
|
255
255
|
def enable(alert_configuration_id, params = {})
|
@@ -22,7 +22,7 @@ module Orb
|
|
22
22
|
#
|
23
23
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
24
24
|
#
|
25
|
-
# @return [Orb::Internal::Page<Orb::Subscription>]
|
25
|
+
# @return [Orb::Internal::Page<Orb::Models::Subscription>]
|
26
26
|
#
|
27
27
|
# @see Orb::Models::Coupons::SubscriptionListParams
|
28
28
|
def list(coupon_id, params = {})
|
@@ -14,7 +14,7 @@ module Orb
|
|
14
14
|
#
|
15
15
|
# @overload create(discount:, redemption_code:, duration_in_months: nil, max_redemptions: nil, request_options: {})
|
16
16
|
#
|
17
|
-
# @param discount [Orb::CouponCreateParams::Discount::Percentage, Orb::CouponCreateParams::Discount::Amount]
|
17
|
+
# @param discount [Orb::Models::CouponCreateParams::Discount::Percentage, Orb::Models::CouponCreateParams::Discount::Amount]
|
18
18
|
#
|
19
19
|
# @param redemption_code [String] This string can be used to redeem this coupon for a given subscription.
|
20
20
|
#
|
@@ -24,7 +24,7 @@ module Orb
|
|
24
24
|
#
|
25
25
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
26
26
|
#
|
27
|
-
# @return [Orb::Coupon]
|
27
|
+
# @return [Orb::Models::Coupon]
|
28
28
|
#
|
29
29
|
# @see Orb::Models::CouponCreateParams
|
30
30
|
def create(params)
|
@@ -54,7 +54,7 @@ module Orb
|
|
54
54
|
#
|
55
55
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
56
56
|
#
|
57
|
-
# @return [Orb::Internal::Page<Orb::Coupon>]
|
57
|
+
# @return [Orb::Internal::Page<Orb::Models::Coupon>]
|
58
58
|
#
|
59
59
|
# @see Orb::Models::CouponListParams
|
60
60
|
def list(params = {})
|
@@ -78,7 +78,7 @@ module Orb
|
|
78
78
|
# @param coupon_id [String]
|
79
79
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
80
80
|
#
|
81
|
-
# @return [Orb::Coupon]
|
81
|
+
# @return [Orb::Models::Coupon]
|
82
82
|
#
|
83
83
|
# @see Orb::Models::CouponArchiveParams
|
84
84
|
def archive(coupon_id, params = {})
|
@@ -99,7 +99,7 @@ module Orb
|
|
99
99
|
# @param coupon_id [String]
|
100
100
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
101
101
|
#
|
102
|
-
# @return [Orb::Coupon]
|
102
|
+
# @return [Orb::Models::Coupon]
|
103
103
|
#
|
104
104
|
# @see Orb::Models::CouponFetchParams
|
105
105
|
def fetch(coupon_id, params = {})
|
@@ -8,15 +8,15 @@ module Orb
|
|
8
8
|
#
|
9
9
|
# @overload create(line_items:, memo: nil, reason: nil, request_options: {})
|
10
10
|
#
|
11
|
-
# @param line_items [Array<Orb::CreditNoteCreateParams::LineItem>]
|
11
|
+
# @param line_items [Array<Orb::Models::CreditNoteCreateParams::LineItem>]
|
12
12
|
#
|
13
13
|
# @param memo [String, nil] An optional memo to attach to the credit note.
|
14
14
|
#
|
15
|
-
# @param reason [Symbol, Orb::CreditNoteCreateParams::Reason, nil] An optional reason for the credit note.
|
15
|
+
# @param reason [Symbol, Orb::Models::CreditNoteCreateParams::Reason, nil] An optional reason for the credit note.
|
16
16
|
#
|
17
17
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
18
18
|
#
|
19
|
-
# @return [Orb::CreditNote]
|
19
|
+
# @return [Orb::Models::CreditNote]
|
20
20
|
#
|
21
21
|
# @see Orb::Models::CreditNoteCreateParams
|
22
22
|
def create(params)
|
@@ -53,7 +53,7 @@ module Orb
|
|
53
53
|
#
|
54
54
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
55
55
|
#
|
56
|
-
# @return [Orb::Internal::Page<Orb::CreditNote>]
|
56
|
+
# @return [Orb::Internal::Page<Orb::Models::CreditNote>]
|
57
57
|
#
|
58
58
|
# @see Orb::Models::CreditNoteListParams
|
59
59
|
def list(params = {})
|
@@ -81,7 +81,7 @@ module Orb
|
|
81
81
|
# @param credit_note_id [String]
|
82
82
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
83
83
|
#
|
84
|
-
# @return [Orb::CreditNote]
|
84
|
+
# @return [Orb::Models::CreditNote]
|
85
85
|
#
|
86
86
|
# @see Orb::Models::CreditNoteFetchParams
|
87
87
|
def fetch(credit_note_id, params = {})
|
@@ -13,7 +13,7 @@ module Orb
|
|
13
13
|
#
|
14
14
|
# @param amount [String]
|
15
15
|
#
|
16
|
-
# @param type [Symbol, Orb::Customers::BalanceTransactionCreateParams::Type]
|
16
|
+
# @param type [Symbol, Orb::Models::Customers::BalanceTransactionCreateParams::Type]
|
17
17
|
#
|
18
18
|
# @param description [String, nil] An optional description that can be specified around this entry.
|
19
19
|
#
|
@@ -135,7 +135,7 @@ module Orb
|
|
135
135
|
#
|
136
136
|
# @param timeframe_start [Time, nil] Costs returned are inclusive of `timeframe_start`.
|
137
137
|
#
|
138
|
-
# @param view_mode [Symbol, Orb::Customers::CostListParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per
|
138
|
+
# @param view_mode [Symbol, Orb::Models::Customers::CostListParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per
|
139
139
|
#
|
140
140
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
141
141
|
#
|
@@ -284,7 +284,7 @@ module Orb
|
|
284
284
|
#
|
285
285
|
# @param timeframe_start [Time, nil] Costs returned are inclusive of `timeframe_start`.
|
286
286
|
#
|
287
|
-
# @param view_mode [Symbol, Orb::Customers::CostListByExternalIDParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per
|
287
|
+
# @param view_mode [Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per
|
288
288
|
#
|
289
289
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
290
290
|
#
|
@@ -106,9 +106,9 @@ module Orb
|
|
106
106
|
#
|
107
107
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
108
108
|
#
|
109
|
-
# @param entry_status [Symbol, Orb::Customers::Credits::LedgerListParams::EntryStatus, nil]
|
109
|
+
# @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryStatus, nil]
|
110
110
|
#
|
111
|
-
# @param entry_type [Symbol, Orb::Customers::Credits::LedgerListParams::EntryType, nil]
|
111
|
+
# @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryType, nil]
|
112
112
|
#
|
113
113
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
114
114
|
#
|
@@ -256,7 +256,7 @@ module Orb
|
|
256
256
|
#
|
257
257
|
# @param amount [Float] The number of credits to effect. Note that this is required for increment, decre
|
258
258
|
#
|
259
|
-
# @param entry_type [Symbol, Orb::Customers::Credits::LedgerCreateEntryParams::EntryType]
|
259
|
+
# @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::EntryType]
|
260
260
|
#
|
261
261
|
# @param expiry_date [Time, nil] An ISO 8601 format date that identifies the origination credit block to expire
|
262
262
|
#
|
@@ -270,13 +270,13 @@ module Orb
|
|
270
270
|
#
|
271
271
|
# @param effective_date [Time, nil] An ISO 8601 format date that denotes when this credit balance should become avai
|
272
272
|
#
|
273
|
-
# @param invoice_settings [Orb::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings, nil] Passing `invoice_settings` automatically generates an invoice for the newly adde
|
273
|
+
# @param invoice_settings [Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings, nil] Passing `invoice_settings` automatically generates an invoice for the newly adde
|
274
274
|
#
|
275
275
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
276
276
|
#
|
277
277
|
# @param per_unit_cost_basis [String, nil] Can only be specified when entry_type=increment. How much, in the customer's cur
|
278
278
|
#
|
279
|
-
# @param void_reason [Symbol, Orb::Customers::Credits::LedgerCreateEntryParams::VoidReason, nil] Can only be specified when `entry_type=void`. The reason for the void.
|
279
|
+
# @param void_reason [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::VoidReason, nil] Can only be specified when `entry_type=void`. The reason for the void.
|
280
280
|
#
|
281
281
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
282
282
|
#
|
@@ -415,7 +415,7 @@ module Orb
|
|
415
415
|
#
|
416
416
|
# @param amount [Float] The number of credits to effect. Note that this is required for increment, decre
|
417
417
|
#
|
418
|
-
# @param entry_type [Symbol, Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType]
|
418
|
+
# @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType]
|
419
419
|
#
|
420
420
|
# @param expiry_date [Time, nil] An ISO 8601 format date that identifies the origination credit block to expire
|
421
421
|
#
|
@@ -429,13 +429,13 @@ module Orb
|
|
429
429
|
#
|
430
430
|
# @param effective_date [Time, nil] An ISO 8601 format date that denotes when this credit balance should become avai
|
431
431
|
#
|
432
|
-
# @param invoice_settings [Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings, nil] Passing `invoice_settings` automatically generates an invoice for the newly adde
|
432
|
+
# @param invoice_settings [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings, nil] Passing `invoice_settings` automatically generates an invoice for the newly adde
|
433
433
|
#
|
434
434
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
435
435
|
#
|
436
436
|
# @param per_unit_cost_basis [String, nil] Can only be specified when entry_type=increment. How much, in the customer's cur
|
437
437
|
#
|
438
|
-
# @param void_reason [Symbol, Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason, nil] Can only be specified when `entry_type=void`. The reason for the void.
|
438
|
+
# @param void_reason [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason, nil] Can only be specified when `entry_type=void`. The reason for the void.
|
439
439
|
#
|
440
440
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
441
441
|
#
|
@@ -555,9 +555,9 @@ module Orb
|
|
555
555
|
#
|
556
556
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
557
557
|
#
|
558
|
-
# @param entry_status [Symbol, Orb::Customers::Credits::LedgerListByExternalIDParams::EntryStatus, nil]
|
558
|
+
# @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryStatus, nil]
|
559
559
|
#
|
560
|
-
# @param entry_type [Symbol, Orb::Customers::Credits::LedgerListByExternalIDParams::EntryType, nil]
|
560
|
+
# @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryType, nil]
|
561
561
|
#
|
562
562
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
563
563
|
#
|
@@ -24,7 +24,7 @@ module Orb
|
|
24
24
|
#
|
25
25
|
# @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo
|
26
26
|
#
|
27
|
-
# @param invoice_settings [Orb::Customers::Credits::TopUpCreateParams::InvoiceSettings] Settings for invoices generated by triggered top-ups.
|
27
|
+
# @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateParams::InvoiceSettings] Settings for invoices generated by triggered top-ups.
|
28
28
|
#
|
29
29
|
# @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit.
|
30
30
|
#
|
@@ -34,7 +34,7 @@ module Orb
|
|
34
34
|
#
|
35
35
|
# @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it
|
36
36
|
#
|
37
|
-
# @param expires_after_unit [Symbol, Orb::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit, nil] The unit of expires_after.
|
37
|
+
# @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit, nil] The unit of expires_after.
|
38
38
|
#
|
39
39
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
40
40
|
#
|
@@ -128,7 +128,7 @@ module Orb
|
|
128
128
|
#
|
129
129
|
# @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo
|
130
130
|
#
|
131
|
-
# @param invoice_settings [Orb::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings] Settings for invoices generated by triggered top-ups.
|
131
|
+
# @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings] Settings for invoices generated by triggered top-ups.
|
132
132
|
#
|
133
133
|
# @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit.
|
134
134
|
#
|
@@ -138,7 +138,7 @@ module Orb
|
|
138
138
|
#
|
139
139
|
# @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it
|
140
140
|
#
|
141
|
-
# @param expires_after_unit [Symbol, Orb::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit, nil] The unit of expires_after.
|
141
|
+
# @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit, nil] The unit of expires_after.
|
142
142
|
#
|
143
143
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
144
144
|
#
|