orb-billing 0.3.1 → 0.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +14 -0
- data/README.md +3 -3
- data/lib/orb/file_part.rb +2 -2
- data/lib/orb/internal/type/enum.rb +3 -3
- data/lib/orb/internal/type/request_parameters.rb +4 -4
- data/lib/orb/internal/type/union.rb +4 -4
- data/lib/orb/internal/util.rb +1 -1
- data/lib/orb/models/alert.rb +29 -32
- data/lib/orb/models/alert_create_for_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_external_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_subscription_params.rb +7 -8
- data/lib/orb/models/alert_list_params.rb +0 -1
- data/lib/orb/models/alert_update_params.rb +4 -5
- data/lib/orb/models/amount_discount.rb +6 -7
- data/lib/orb/models/billable_metric.rb +9 -11
- data/lib/orb/models/coupon.rb +9 -12
- data/lib/orb/models/coupon_create_params.rb +6 -8
- data/lib/orb/models/coupon_list_params.rb +0 -2
- data/lib/orb/models/coupons/subscription_list_params.rb +0 -1
- data/lib/orb/models/credit_note.rb +48 -46
- data/lib/orb/models/credit_note_create_params.rb +6 -6
- data/lib/orb/models/credit_note_list_params.rb +0 -1
- data/lib/orb/models/customer.rb +54 -61
- data/lib/orb/models/customer_create_params.rb +41 -53
- data/lib/orb/models/customer_list_params.rb +0 -1
- data/lib/orb/models/customer_update_by_external_id_params.rb +41 -53
- data/lib/orb/models/customer_update_params.rb +41 -51
- data/lib/orb/models/customers/balance_transaction_create_params.rb +3 -3
- data/lib/orb/models/customers/balance_transaction_create_response.rb +0 -2
- data/lib/orb/models/customers/balance_transaction_list_params.rb +0 -1
- data/lib/orb/models/customers/balance_transaction_list_response.rb +0 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -3
- data/lib/orb/models/customers/cost_list_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_response.rb +3 -3
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +0 -2
- data/lib/orb/models/customers/credit_list_params.rb +0 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +12 -21
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +0 -7
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +11 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +0 -7
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +6 -7
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +0 -7
- data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
- data/lib/orb/models/customers/credits/ledger_list_response.rb +0 -7
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +10 -15
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_create_params.rb +7 -15
- data/lib/orb/models/customers/credits/top_up_create_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_response.rb +0 -6
- data/lib/orb/models/dimensional_price_group.rb +1 -3
- data/lib/orb/models/dimensional_price_group_create_params.rb +0 -1
- data/lib/orb/models/dimensional_price_group_list_params.rb +0 -1
- data/lib/orb/models/dimensional_price_groups.rb +6 -6
- data/lib/orb/models/discount.rb +5 -5
- data/lib/orb/models/evaluate_price_group.rb +1 -1
- data/lib/orb/models/event_ingest_params.rb +4 -9
- data/lib/orb/models/event_ingest_response.rb +0 -3
- data/lib/orb/models/event_search_params.rb +0 -3
- data/lib/orb/models/event_search_response.rb +0 -4
- data/lib/orb/models/event_update_params.rb +0 -3
- data/lib/orb/models/events/backfill_close_response.rb +0 -4
- data/lib/orb/models/events/backfill_create_params.rb +0 -7
- data/lib/orb/models/events/backfill_create_response.rb +0 -4
- data/lib/orb/models/events/backfill_fetch_response.rb +0 -4
- data/lib/orb/models/events/backfill_list_params.rb +0 -1
- data/lib/orb/models/events/backfill_list_response.rb +0 -4
- data/lib/orb/models/events/backfill_revert_response.rb +0 -4
- data/lib/orb/models/events/event_volumes.rb +3 -3
- data/lib/orb/models/events/volume_list_params.rb +0 -3
- data/lib/orb/models/invoice.rb +157 -202
- data/lib/orb/models/invoice_create_params.rb +14 -21
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +9 -54
- data/lib/orb/models/invoice_issue_params.rb +0 -1
- data/lib/orb/models/invoice_level_discount.rb +4 -4
- data/lib/orb/models/invoice_line_item_create_params.rb +0 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +6 -26
- data/lib/orb/models/invoice_list_params.rb +6 -10
- data/lib/orb/models/invoice_update_params.rb +0 -1
- data/lib/orb/models/item.rb +7 -8
- data/lib/orb/models/item_list_params.rb +0 -1
- data/lib/orb/models/item_update_params.rb +7 -7
- data/lib/orb/models/metric_create_params.rb +0 -1
- data/lib/orb/models/metric_list_params.rb +0 -1
- data/lib/orb/models/metric_update_params.rb +0 -1
- data/lib/orb/models/percentage_discount.rb +6 -8
- data/lib/orb/models/plan.rb +78 -103
- data/lib/orb/models/plan_create_params.rb +727 -800
- data/lib/orb/models/plan_list_params.rb +3 -4
- data/lib/orb/models/plan_update_params.rb +0 -2
- data/lib/orb/models/plans/external_plan_id_update_params.rb +0 -2
- data/lib/orb/models/price.rb +1671 -1724
- data/lib/orb/models/price_create_params.rb +75 -84
- data/lib/orb/models/price_evaluate_params.rb +0 -2
- data/lib/orb/models/price_evaluate_response.rb +3 -3
- data/lib/orb/models/price_list_params.rb +0 -1
- data/lib/orb/models/price_update_params.rb +0 -1
- data/lib/orb/models/prices/external_price_id_update_params.rb +0 -1
- data/lib/orb/models/subscription.rb +86 -122
- data/lib/orb/models/subscription_cancel_params.rb +3 -5
- data/lib/orb/models/subscription_cancel_response.rb +21 -57
- data/lib/orb/models/subscription_change_apply_response.rb +21 -58
- data/lib/orb/models/subscription_change_cancel_response.rb +21 -58
- data/lib/orb/models/subscription_change_retrieve_response.rb +21 -58
- data/lib/orb/models/subscription_create_params.rb +1865 -1815
- data/lib/orb/models/subscription_create_response.rb +21 -57
- data/lib/orb/models/subscription_fetch_costs_params.rb +3 -4
- data/lib/orb/models/subscription_fetch_costs_response.rb +3 -3
- data/lib/orb/models/subscription_fetch_schedule_params.rb +0 -1
- data/lib/orb/models/subscription_fetch_schedule_response.rb +0 -1
- data/lib/orb/models/subscription_fetch_usage_params.rb +6 -8
- data/lib/orb/models/subscription_list_params.rb +3 -4
- data/lib/orb/models/subscription_price_intervals_params.rb +1105 -1017
- data/lib/orb/models/subscription_price_intervals_response.rb +21 -57
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +1906 -1791
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +21 -57
- data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
- data/lib/orb/models/subscription_trigger_phase_response.rb +21 -57
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +21 -57
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +21 -57
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +21 -57
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +3 -6
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +21 -57
- data/lib/orb/models/subscription_update_params.rb +0 -5
- data/lib/orb/models/subscription_update_trial_params.rb +4 -6
- data/lib/orb/models/subscription_update_trial_response.rb +21 -57
- data/lib/orb/models/subscription_usage.rb +46 -39
- data/lib/orb/models/subscriptions.rb +6 -6
- data/lib/orb/models/trial_discount.rb +6 -7
- data/lib/orb/models/usage_discount.rb +6 -8
- data/lib/orb/resources/alerts.rb +30 -31
- data/lib/orb/resources/coupons/subscriptions.rb +3 -4
- data/lib/orb/resources/coupons.rb +11 -21
- data/lib/orb/resources/credit_notes.rb +10 -11
- data/lib/orb/resources/customers/balance_transactions.rb +3 -4
- data/lib/orb/resources/customers/costs.rb +4 -6
- data/lib/orb/resources/customers/credits/ledger.rb +14 -33
- data/lib/orb/resources/customers/credits/top_ups.rb +10 -20
- data/lib/orb/resources/customers/credits.rb +2 -6
- data/lib/orb/resources/customers.rb +40 -67
- data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +2 -2
- data/lib/orb/resources/dimensional_price_groups.rb +8 -10
- data/lib/orb/resources/events/backfills.rb +2 -10
- data/lib/orb/resources/events/volume.rb +3 -6
- data/lib/orb/resources/events.rb +4 -12
- data/lib/orb/resources/invoice_line_items.rb +1 -2
- data/lib/orb/resources/invoices.rb +26 -43
- data/lib/orb/resources/items.rb +12 -13
- data/lib/orb/resources/metrics.rb +11 -14
- data/lib/orb/resources/plans/external_plan_id.rb +5 -7
- data/lib/orb/resources/plans.rb +14 -23
- data/lib/orb/resources/prices/external_price_id.rb +5 -6
- data/lib/orb/resources/prices.rb +25 -35
- data/lib/orb/resources/subscription_changes.rb +1 -1
- data/lib/orb/resources/subscriptions.rb +49 -107
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +1 -0
- data/rbi/orb/client.rbi +5 -4
- data/rbi/orb/errors.rbi +59 -28
- data/rbi/orb/file_part.rbi +9 -6
- data/rbi/orb/internal/page.rbi +19 -6
- data/rbi/orb/internal/transport/base_client.rbi +131 -73
- data/rbi/orb/internal/transport/pooled_net_requester.rbi +25 -12
- data/rbi/orb/internal/type/array_of.rbi +42 -34
- data/rbi/orb/internal/type/base_model.rbi +124 -65
- data/rbi/orb/internal/type/base_page.rbi +11 -7
- data/rbi/orb/internal/type/boolean.rbi +16 -10
- data/rbi/orb/internal/type/converter.rbi +66 -31
- data/rbi/orb/internal/type/enum.rbi +27 -15
- data/rbi/orb/internal/type/file_input.rbi +12 -10
- data/rbi/orb/internal/type/hash_of.rbi +34 -24
- data/rbi/orb/internal/type/request_parameters.rbi +12 -4
- data/rbi/orb/internal/type/union.rbi +60 -25
- data/rbi/orb/internal/type/unknown.rbi +20 -12
- data/rbi/orb/internal/util.rbi +210 -89
- data/rbi/orb/models/alert.rbi +107 -70
- data/rbi/orb/models/alert_create_for_customer_params.rbi +60 -27
- data/rbi/orb/models/alert_create_for_external_customer_params.rbi +68 -29
- data/rbi/orb/models/alert_create_for_subscription_params.rbi +53 -26
- data/rbi/orb/models/alert_disable_params.rbi +17 -6
- data/rbi/orb/models/alert_enable_params.rbi +17 -6
- data/rbi/orb/models/alert_list_params.rbi +23 -20
- data/rbi/orb/models/alert_retrieve_params.rbi +10 -4
- data/rbi/orb/models/alert_update_params.rbi +25 -14
- data/rbi/orb/models/amount_discount.rbi +28 -19
- data/rbi/orb/models/billable_metric.rbi +33 -26
- data/rbi/orb/models/billing_cycle_relative_date.rbi +11 -5
- data/rbi/orb/models/coupon.rbi +28 -20
- data/rbi/orb/models/coupon_archive_params.rbi +10 -4
- data/rbi/orb/models/coupon_create_params.rbi +72 -38
- data/rbi/orb/models/coupon_fetch_params.rbi +10 -4
- data/rbi/orb/models/coupon_list_params.rbi +18 -15
- data/rbi/orb/models/coupons/subscription_list_params.rbi +16 -6
- data/rbi/orb/models/credit_note.rbi +293 -158
- data/rbi/orb/models/credit_note_create_params.rbi +58 -29
- data/rbi/orb/models/credit_note_fetch_params.rbi +10 -4
- data/rbi/orb/models/credit_note_list_params.rbi +20 -17
- data/rbi/orb/models/customer.rbi +430 -329
- data/rbi/orb/models/customer_create_params.rbi +662 -325
- data/rbi/orb/models/customer_delete_params.rbi +10 -4
- data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +10 -4
- data/rbi/orb/models/customer_fetch_params.rbi +10 -4
- data/rbi/orb/models/customer_list_params.rbi +20 -17
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +10 -4
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +10 -4
- data/rbi/orb/models/customer_update_by_external_id_params.rbi +1136 -336
- data/rbi/orb/models/customer_update_params.rbi +661 -324
- data/rbi/orb/models/customers/balance_transaction_create_params.rbi +50 -21
- data/rbi/orb/models/customers/balance_transaction_create_response.rbi +154 -61
- data/rbi/orb/models/customers/balance_transaction_list_params.rbi +20 -17
- data/rbi/orb/models/customers/balance_transaction_list_response.rbi +164 -59
- data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +56 -22
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +162 -124
- data/rbi/orb/models/customers/cost_list_params.rbi +45 -22
- data/rbi/orb/models/customers/cost_list_response.rbi +154 -123
- data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi +18 -15
- data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +48 -22
- data/rbi/orb/models/customers/credit_list_params.rbi +18 -15
- data/rbi/orb/models/customers/credit_list_response.rbi +44 -21
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +106 -68
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +643 -434
- data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +117 -59
- data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +700 -425
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +102 -44
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +681 -432
- data/rbi/orb/models/customers/credits/ledger_list_params.rbi +123 -40
- data/rbi/orb/models/customers/credits/ledger_list_response.rbi +735 -389
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +74 -53
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +65 -48
- data/rbi/orb/models/customers/credits/top_up_create_params.rbi +84 -45
- data/rbi/orb/models/customers/credits/top_up_create_response.rbi +83 -43
- data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +16 -6
- data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +15 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +9 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +70 -49
- data/rbi/orb/models/customers/credits/top_up_list_params.rbi +9 -5
- data/rbi/orb/models/customers/credits/top_up_list_response.rbi +84 -43
- data/rbi/orb/models/dimensional_price_group.rbi +18 -15
- data/rbi/orb/models/dimensional_price_group_create_params.rbi +19 -16
- data/rbi/orb/models/dimensional_price_group_list_params.rbi +16 -6
- data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +10 -4
- data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +10 -9
- data/rbi/orb/models/dimensional_price_groups.rbi +18 -13
- data/rbi/orb/models/discount.rbi +11 -5
- data/rbi/orb/models/evaluate_price_group.rbi +28 -12
- data/rbi/orb/models/event_deprecate_params.rbi +10 -4
- data/rbi/orb/models/event_deprecate_response.rbi +8 -3
- data/rbi/orb/models/event_ingest_params.rbi +37 -31
- data/rbi/orb/models/event_ingest_response.rbi +63 -23
- data/rbi/orb/models/event_search_params.rbi +17 -14
- data/rbi/orb/models/event_search_response.rbi +33 -21
- data/rbi/orb/models/event_update_params.rbi +19 -16
- data/rbi/orb/models/event_update_response.rbi +8 -3
- data/rbi/orb/models/events/backfill_close_params.rbi +10 -9
- data/rbi/orb/models/events/backfill_close_response.rbi +64 -29
- data/rbi/orb/models/events/backfill_create_params.rbi +21 -18
- data/rbi/orb/models/events/backfill_create_response.rbi +63 -29
- data/rbi/orb/models/events/backfill_fetch_params.rbi +10 -9
- data/rbi/orb/models/events/backfill_fetch_response.rbi +64 -29
- data/rbi/orb/models/events/backfill_list_params.rbi +16 -6
- data/rbi/orb/models/events/backfill_list_response.rbi +62 -28
- data/rbi/orb/models/events/backfill_revert_params.rbi +10 -9
- data/rbi/orb/models/events/backfill_revert_response.rbi +63 -29
- data/rbi/orb/models/events/event_volumes.rbi +32 -10
- data/rbi/orb/models/events/volume_list_params.rbi +18 -15
- data/rbi/orb/models/invoice.rbi +1286 -805
- data/rbi/orb/models/invoice_create_params.rbi +97 -69
- data/rbi/orb/models/invoice_fetch_params.rbi +10 -4
- data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +15 -5
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +1991 -861
- data/rbi/orb/models/invoice_issue_params.rbi +16 -5
- data/rbi/orb/models/invoice_level_discount.rbi +11 -4
- data/rbi/orb/models/invoice_line_item_create_params.rbi +20 -17
- data/rbi/orb/models/invoice_line_item_create_response.rbi +573 -376
- data/rbi/orb/models/invoice_list_params.rbi +67 -47
- data/rbi/orb/models/invoice_mark_paid_params.rbi +17 -14
- data/rbi/orb/models/invoice_pay_params.rbi +10 -4
- data/rbi/orb/models/invoice_update_params.rbi +15 -10
- data/rbi/orb/models/invoice_void_params.rbi +10 -4
- data/rbi/orb/models/item.rbi +87 -39
- data/rbi/orb/models/item_create_params.rbi +14 -5
- data/rbi/orb/models/item_fetch_params.rbi +10 -4
- data/rbi/orb/models/item_list_params.rbi +16 -6
- data/rbi/orb/models/item_update_params.rbi +79 -39
- data/rbi/orb/models/metric_create_params.rbi +19 -16
- data/rbi/orb/models/metric_fetch_params.rbi +10 -4
- data/rbi/orb/models/metric_list_params.rbi +20 -17
- data/rbi/orb/models/metric_update_params.rbi +15 -10
- data/rbi/orb/models/pagination_metadata.rbi +16 -4
- data/rbi/orb/models/percentage_discount.rbi +32 -19
- data/rbi/orb/models/plan.rbi +496 -365
- data/rbi/orb/models/plan_create_params.rbi +4785 -2875
- data/rbi/orb/models/plan_fetch_params.rbi +10 -4
- data/rbi/orb/models/plan_list_params.rbi +34 -27
- data/rbi/orb/models/plan_update_params.rbi +16 -13
- data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +10 -9
- data/rbi/orb/models/plans/external_plan_id_update_params.rbi +16 -13
- data/rbi/orb/models/price.rbi +9969 -5024
- data/rbi/orb/models/price_create_params.rbi +501 -245
- data/rbi/orb/models/price_evaluate_params.rbi +20 -17
- data/rbi/orb/models/price_evaluate_response.rbi +11 -6
- data/rbi/orb/models/price_fetch_params.rbi +10 -4
- data/rbi/orb/models/price_list_params.rbi +16 -6
- data/rbi/orb/models/price_update_params.rbi +15 -10
- data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +10 -9
- data/rbi/orb/models/prices/external_price_id_update_params.rbi +15 -10
- data/rbi/orb/models/subscription.rbi +578 -420
- data/rbi/orb/models/subscription_cancel_params.rbi +44 -22
- data/rbi/orb/models/subscription_cancel_response.rbi +700 -438
- data/rbi/orb/models/subscription_change_apply_params.rbi +16 -13
- data/rbi/orb/models/subscription_change_apply_response.rbi +784 -504
- data/rbi/orb/models/subscription_change_cancel_params.rbi +10 -4
- data/rbi/orb/models/subscription_change_cancel_response.rbi +783 -514
- data/rbi/orb/models/subscription_change_retrieve_params.rbi +10 -4
- data/rbi/orb/models/subscription_change_retrieve_response.rbi +782 -524
- data/rbi/orb/models/subscription_create_params.rbi +9021 -6730
- data/rbi/orb/models/subscription_create_response.rbi +700 -438
- data/rbi/orb/models/subscription_fetch_costs_params.rbi +47 -22
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +154 -123
- data/rbi/orb/models/subscription_fetch_params.rbi +10 -4
- data/rbi/orb/models/subscription_fetch_schedule_params.rbi +20 -17
- data/rbi/orb/models/subscription_fetch_schedule_response.rbi +33 -19
- data/rbi/orb/models/subscription_fetch_usage_params.rbi +81 -34
- data/rbi/orb/models/subscription_list_params.rbi +39 -28
- data/rbi/orb/models/subscription_price_intervals_params.rbi +5181 -3822
- data/rbi/orb/models/subscription_price_intervals_response.rbi +720 -453
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +8602 -6910
- data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +718 -467
- data/rbi/orb/models/subscription_trigger_phase_params.rbi +16 -13
- data/rbi/orb/models/subscription_trigger_phase_response.rbi +712 -448
- data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +10 -4
- data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +719 -467
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +16 -5
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +693 -502
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +10 -4
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +708 -497
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +57 -26
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +719 -467
- data/rbi/orb/models/subscription_update_params.rbi +19 -16
- data/rbi/orb/models/subscription_update_trial_params.rbi +57 -19
- data/rbi/orb/models/subscription_update_trial_response.rbi +712 -447
- data/rbi/orb/models/subscription_usage.rbi +271 -121
- data/rbi/orb/models/subscriptions.rbi +18 -11
- data/rbi/orb/models/top_level_ping_params.rbi +10 -4
- data/rbi/orb/models/top_level_ping_response.rbi +7 -3
- data/rbi/orb/models/trial_discount.rbi +29 -20
- data/rbi/orb/models/usage_discount.rbi +28 -19
- data/rbi/orb/models.rbi +22 -11
- data/rbi/orb/request_options.rbi +12 -6
- data/rbi/orb/resources/alerts.rbi +61 -40
- data/rbi/orb/resources/coupons/subscriptions.rbi +7 -5
- data/rbi/orb/resources/coupons.rbi +33 -18
- data/rbi/orb/resources/credit_notes.rbi +22 -13
- data/rbi/orb/resources/customers/balance_transactions.rbi +17 -9
- data/rbi/orb/resources/customers/costs.rbi +18 -11
- data/rbi/orb/resources/customers/credits/ledger.rbi +98 -74
- data/rbi/orb/resources/customers/credits/top_ups.rbi +61 -25
- data/rbi/orb/resources/customers/credits.rbi +16 -7
- data/rbi/orb/resources/customers.rbi +137 -72
- data/rbi/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +8 -4
- data/rbi/orb/resources/dimensional_price_groups.rbi +26 -12
- data/rbi/orb/resources/events/backfills.rbi +35 -17
- data/rbi/orb/resources/events/volume.rbi +7 -5
- data/rbi/orb/resources/events.rbi +26 -16
- data/rbi/orb/resources/invoice_line_items.rbi +7 -5
- data/rbi/orb/resources/invoices.rbi +72 -41
- data/rbi/orb/resources/items.rbi +40 -13
- data/rbi/orb/resources/metrics.rbi +25 -15
- data/rbi/orb/resources/plans/external_plan_id.rbi +15 -7
- data/rbi/orb/resources/plans.rbi +57 -47
- data/rbi/orb/resources/prices/external_price_id.rbi +73 -68
- data/rbi/orb/resources/prices.rbi +176 -156
- data/rbi/orb/resources/subscription_changes.rbi +19 -11
- data/rbi/orb/resources/subscriptions.rbi +200 -114
- data/rbi/orb/resources/top_level.rbi +9 -3
- data/sig/orb/internal/page.rbs +0 -2
- data/sig/orb/internal/type/request_parameters.rbs +3 -1
- data/sig/orb/models/alert.rbs +19 -31
- data/sig/orb/models/alert_create_for_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_subscription_params.rbs +3 -7
- data/sig/orb/models/alert_disable_params.rbs +0 -2
- data/sig/orb/models/alert_enable_params.rbs +0 -2
- data/sig/orb/models/alert_list_params.rbs +0 -2
- data/sig/orb/models/alert_retrieve_params.rbs +0 -2
- data/sig/orb/models/alert_update_params.rbs +3 -7
- data/sig/orb/models/amount_discount.rbs +4 -6
- data/sig/orb/models/billable_metric.rbs +7 -9
- data/sig/orb/models/coupon.rbs +5 -8
- data/sig/orb/models/coupon_archive_params.rbs +0 -2
- data/sig/orb/models/coupon_create_params.rbs +3 -9
- data/sig/orb/models/coupon_fetch_params.rbs +0 -2
- data/sig/orb/models/coupon_list_params.rbs +0 -2
- data/sig/orb/models/coupons/subscription_list_params.rbs +0 -2
- data/sig/orb/models/credit_note.rbs +48 -66
- data/sig/orb/models/credit_note_create_params.rbs +3 -7
- data/sig/orb/models/credit_note_fetch_params.rbs +0 -2
- data/sig/orb/models/credit_note_list_params.rbs +0 -2
- data/sig/orb/models/customer.rbs +43 -63
- data/sig/orb/models/customer_create_params.rbs +32 -52
- data/sig/orb/models/customer_delete_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_params.rbs +0 -2
- data/sig/orb/models/customer_list_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +0 -2
- data/sig/orb/models/customer_update_by_external_id_params.rbs +32 -52
- data/sig/orb/models/customer_update_params.rbs +32 -52
- data/sig/orb/models/customers/balance_transaction_create_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_create_response.rbs +0 -6
- data/sig/orb/models/customers/balance_transaction_list_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_list_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_response.rbs +0 -6
- data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +0 -2
- data/sig/orb/models/customers/credit_list_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_response.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +1 -43
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_create_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_delete_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_response.rbs +0 -4
- data/sig/orb/models/dimensional_price_group.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_create_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_list_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups.rbs +6 -8
- data/sig/orb/models/discount.rbs +5 -5
- data/sig/orb/models/evaluate_price_group.rbs +4 -6
- data/sig/orb/models/event_deprecate_params.rbs +0 -2
- data/sig/orb/models/event_deprecate_response.rbs +0 -2
- data/sig/orb/models/event_ingest_params.rbs +3 -7
- data/sig/orb/models/event_ingest_response.rbs +0 -6
- data/sig/orb/models/event_search_params.rbs +0 -2
- data/sig/orb/models/event_search_response.rbs +0 -4
- data/sig/orb/models/event_update_params.rbs +0 -2
- data/sig/orb/models/event_update_response.rbs +0 -2
- data/sig/orb/models/events/backfill_close_params.rbs +0 -2
- data/sig/orb/models/events/backfill_close_response.rbs +0 -2
- data/sig/orb/models/events/backfill_create_params.rbs +0 -2
- data/sig/orb/models/events/backfill_create_response.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_params.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_response.rbs +0 -2
- data/sig/orb/models/events/backfill_list_params.rbs +0 -2
- data/sig/orb/models/events/backfill_list_response.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_params.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_response.rbs +0 -2
- data/sig/orb/models/events/event_volumes.rbs +3 -10
- data/sig/orb/models/events/volume_list_params.rbs +0 -2
- data/sig/orb/models/invoice.rbs +110 -172
- data/sig/orb/models/invoice_create_params.rbs +10 -16
- data/sig/orb/models/invoice_fetch_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +2 -64
- data/sig/orb/models/invoice_issue_params.rbs +0 -2
- data/sig/orb/models/invoice_level_discount.rbs +2 -4
- data/sig/orb/models/invoice_line_item_create_params.rbs +0 -2
- data/sig/orb/models/invoice_line_item_create_response.rbs +2 -36
- data/sig/orb/models/invoice_list_params.rbs +4 -6
- data/sig/orb/models/invoice_mark_paid_params.rbs +0 -2
- data/sig/orb/models/invoice_pay_params.rbs +0 -2
- data/sig/orb/models/invoice_update_params.rbs +0 -2
- data/sig/orb/models/invoice_void_params.rbs +0 -2
- data/sig/orb/models/item.rbs +7 -11
- data/sig/orb/models/item_create_params.rbs +0 -2
- data/sig/orb/models/item_fetch_params.rbs +0 -2
- data/sig/orb/models/item_list_params.rbs +0 -2
- data/sig/orb/models/item_update_params.rbs +7 -11
- data/sig/orb/models/metric_create_params.rbs +0 -2
- data/sig/orb/models/metric_fetch_params.rbs +0 -2
- data/sig/orb/models/metric_list_params.rbs +0 -2
- data/sig/orb/models/metric_update_params.rbs +0 -2
- data/sig/orb/models/pagination_metadata.rbs +0 -2
- data/sig/orb/models/percentage_discount.rbs +4 -6
- data/sig/orb/models/plan.rbs +45 -73
- data/sig/orb/models/plan_create_params.rbs +518 -696
- data/sig/orb/models/plan_fetch_params.rbs +0 -2
- data/sig/orb/models/plan_list_params.rbs +0 -2
- data/sig/orb/models/plan_update_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +0 -2
- data/sig/orb/models/price.rbs +1194 -1730
- data/sig/orb/models/price_create_params.rbs +59 -97
- data/sig/orb/models/price_evaluate_params.rbs +0 -2
- data/sig/orb/models/price_evaluate_response.rbs +3 -6
- data/sig/orb/models/price_fetch_params.rbs +0 -2
- data/sig/orb/models/price_list_params.rbs +0 -2
- data/sig/orb/models/price_update_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_fetch_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_update_params.rbs +0 -2
- data/sig/orb/models/subscription.rbs +56 -94
- data/sig/orb/models/subscription_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_cancel_response.rbs +20 -60
- data/sig/orb/models/subscription_change_apply_params.rbs +0 -2
- data/sig/orb/models/subscription_change_apply_response.rbs +20 -62
- data/sig/orb/models/subscription_change_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_change_cancel_response.rbs +20 -62
- data/sig/orb/models/subscription_change_retrieve_params.rbs +0 -2
- data/sig/orb/models/subscription_change_retrieve_response.rbs +20 -62
- data/sig/orb/models/subscription_create_params.rbs +1103 -1499
- data/sig/orb/models/subscription_create_response.rbs +20 -60
- data/sig/orb/models/subscription_fetch_costs_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_costs_response.rbs +0 -6
- data/sig/orb/models/subscription_fetch_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_response.rbs +0 -4
- data/sig/orb/models/subscription_fetch_usage_params.rbs +0 -2
- data/sig/orb/models/subscription_list_params.rbs +0 -2
- data/sig/orb/models/subscription_price_intervals_params.rbs +666 -896
- data/sig/orb/models/subscription_price_intervals_response.rbs +20 -60
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1103 -1499
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +20 -60
- data/sig/orb/models/subscription_trigger_phase_params.rbs +0 -2
- data/sig/orb/models/subscription_trigger_phase_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +20 -60
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +0 -2
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +20 -60
- data/sig/orb/models/subscription_update_params.rbs +0 -2
- data/sig/orb/models/subscription_update_trial_params.rbs +1 -3
- data/sig/orb/models/subscription_update_trial_response.rbs +20 -60
- data/sig/orb/models/subscription_usage.rbs +35 -53
- data/sig/orb/models/subscriptions.rbs +6 -8
- data/sig/orb/models/top_level_ping_params.rbs +0 -2
- data/sig/orb/models/top_level_ping_response.rbs +0 -2
- data/sig/orb/models/trial_discount.rbs +4 -6
- data/sig/orb/models/usage_discount.rbs +4 -6
- data/sig/orb/request_options.rbs +1 -1
- data/sig/orb/resources/alerts.rbs +12 -12
- data/sig/orb/resources/coupons/subscriptions.rbs +1 -1
- data/sig/orb/resources/coupons.rbs +4 -4
- data/sig/orb/resources/credit_notes.rbs +4 -4
- data/sig/orb/resources/customers/credits/ledger.rbs +2 -2
- data/sig/orb/resources/customers/credits/top_ups.rbs +2 -2
- data/sig/orb/resources/customers.rbs +24 -24
- data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +1 -1
- data/sig/orb/resources/dimensional_price_groups.rbs +3 -3
- data/sig/orb/resources/events/volume.rbs +1 -1
- data/sig/orb/resources/events.rbs +1 -1
- data/sig/orb/resources/invoices.rbs +10 -10
- data/sig/orb/resources/items.rbs +5 -5
- data/sig/orb/resources/metrics.rbs +4 -4
- data/sig/orb/resources/plans/external_plan_id.rbs +2 -2
- data/sig/orb/resources/plans.rbs +5 -5
- data/sig/orb/resources/prices.rbs +11 -11
- data/sig/orb/resources/subscriptions.rbs +21 -21
- metadata +2 -2
@@ -8,6 +8,8 @@ module Orb
|
|
8
8
|
extend Orb::Internal::Type::RequestParameters::Converter
|
9
9
|
include Orb::Internal::Type::RequestParameters
|
10
10
|
|
11
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
12
|
+
|
11
13
|
# The amount to increment when the threshold is reached.
|
12
14
|
sig { returns(String) }
|
13
15
|
attr_accessor :amount
|
@@ -18,17 +20,18 @@ module Orb
|
|
18
20
|
attr_accessor :currency
|
19
21
|
|
20
22
|
# Settings for invoices generated by triggered top-ups.
|
21
|
-
sig
|
23
|
+
sig do
|
24
|
+
returns(
|
25
|
+
Orb::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings
|
26
|
+
)
|
27
|
+
end
|
22
28
|
attr_reader :invoice_settings
|
23
29
|
|
24
30
|
sig do
|
25
31
|
params(
|
26
|
-
invoice_settings:
|
27
|
-
Orb::
|
28
|
-
|
29
|
-
)
|
30
|
-
)
|
31
|
-
.void
|
32
|
+
invoice_settings:
|
33
|
+
Orb::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings::OrHash
|
34
|
+
).void
|
32
35
|
end
|
33
36
|
attr_writer :invoice_settings
|
34
37
|
|
@@ -54,7 +57,9 @@ module Orb
|
|
54
57
|
# The unit of expires_after.
|
55
58
|
sig do
|
56
59
|
returns(
|
57
|
-
T.nilable(
|
60
|
+
T.nilable(
|
61
|
+
Orb::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit::OrSymbol
|
62
|
+
)
|
58
63
|
)
|
59
64
|
end
|
60
65
|
attr_accessor :expires_after_unit
|
@@ -63,18 +68,18 @@ module Orb
|
|
63
68
|
params(
|
64
69
|
amount: String,
|
65
70
|
currency: String,
|
66
|
-
invoice_settings:
|
67
|
-
Orb::
|
68
|
-
Orb::Internal::AnyHash
|
69
|
-
),
|
71
|
+
invoice_settings:
|
72
|
+
Orb::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings::OrHash,
|
70
73
|
per_unit_cost_basis: String,
|
71
74
|
threshold: String,
|
72
75
|
active_from: T.nilable(Time),
|
73
76
|
expires_after: T.nilable(Integer),
|
74
|
-
expires_after_unit:
|
75
|
-
|
76
|
-
|
77
|
-
|
77
|
+
expires_after_unit:
|
78
|
+
T.nilable(
|
79
|
+
Orb::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit::OrSymbol
|
80
|
+
),
|
81
|
+
request_options: Orb::RequestOptions::OrHash
|
82
|
+
).returns(T.attached_class)
|
78
83
|
end
|
79
84
|
def self.new(
|
80
85
|
# The amount to increment when the threshold is reached.
|
@@ -98,26 +103,34 @@ module Orb
|
|
98
103
|
# The unit of expires_after.
|
99
104
|
expires_after_unit: nil,
|
100
105
|
request_options: {}
|
101
|
-
)
|
106
|
+
)
|
107
|
+
end
|
108
|
+
|
102
109
|
sig do
|
103
|
-
override
|
104
|
-
|
105
|
-
|
106
|
-
|
107
|
-
|
108
|
-
|
109
|
-
|
110
|
-
|
111
|
-
|
112
|
-
|
113
|
-
|
114
|
-
|
115
|
-
|
116
|
-
|
110
|
+
override.returns(
|
111
|
+
{
|
112
|
+
amount: String,
|
113
|
+
currency: String,
|
114
|
+
invoice_settings:
|
115
|
+
Orb::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings,
|
116
|
+
per_unit_cost_basis: String,
|
117
|
+
threshold: String,
|
118
|
+
active_from: T.nilable(Time),
|
119
|
+
expires_after: T.nilable(Integer),
|
120
|
+
expires_after_unit:
|
121
|
+
T.nilable(
|
122
|
+
Orb::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit::OrSymbol
|
123
|
+
),
|
124
|
+
request_options: Orb::RequestOptions
|
125
|
+
}
|
126
|
+
)
|
127
|
+
end
|
128
|
+
def to_hash
|
117
129
|
end
|
118
|
-
def to_hash; end
|
119
130
|
|
120
131
|
class InvoiceSettings < Orb::Internal::Type::BaseModel
|
132
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
133
|
+
|
121
134
|
# Whether the credits purchase invoice should auto collect with the customer's
|
122
135
|
# saved payment method.
|
123
136
|
sig { returns(T::Boolean) }
|
@@ -148,8 +161,7 @@ module Orb
|
|
148
161
|
net_terms: Integer,
|
149
162
|
memo: T.nilable(String),
|
150
163
|
require_successful_payment: T::Boolean
|
151
|
-
)
|
152
|
-
.returns(T.attached_class)
|
164
|
+
).returns(T.attached_class)
|
153
165
|
end
|
154
166
|
def self.new(
|
155
167
|
# Whether the credits purchase invoice should auto collect with the customer's
|
@@ -164,19 +176,21 @@ module Orb
|
|
164
176
|
# If true, new credit blocks created by this top-up will require that the
|
165
177
|
# corresponding invoice is paid before they can be drawn down from.
|
166
178
|
require_successful_payment: nil
|
167
|
-
)
|
179
|
+
)
|
180
|
+
end
|
181
|
+
|
168
182
|
sig do
|
169
|
-
override
|
170
|
-
|
171
|
-
|
172
|
-
|
173
|
-
|
174
|
-
|
175
|
-
|
176
|
-
|
177
|
-
|
183
|
+
override.returns(
|
184
|
+
{
|
185
|
+
auto_collection: T::Boolean,
|
186
|
+
net_terms: Integer,
|
187
|
+
memo: T.nilable(String),
|
188
|
+
require_successful_payment: T::Boolean
|
189
|
+
}
|
190
|
+
)
|
191
|
+
end
|
192
|
+
def to_hash
|
178
193
|
end
|
179
|
-
def to_hash; end
|
180
194
|
end
|
181
195
|
|
182
196
|
# The unit of expires_after.
|
@@ -184,27 +198,34 @@ module Orb
|
|
184
198
|
extend Orb::Internal::Type::Enum
|
185
199
|
|
186
200
|
TaggedSymbol =
|
187
|
-
T.type_alias
|
201
|
+
T.type_alias do
|
202
|
+
T.all(
|
203
|
+
Symbol,
|
204
|
+
Orb::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit
|
205
|
+
)
|
206
|
+
end
|
188
207
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
189
208
|
|
190
209
|
DAY =
|
191
210
|
T.let(
|
192
211
|
:day,
|
193
|
-
Orb::
|
212
|
+
Orb::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit::TaggedSymbol
|
194
213
|
)
|
195
214
|
MONTH =
|
196
215
|
T.let(
|
197
216
|
:month,
|
198
|
-
Orb::
|
217
|
+
Orb::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit::TaggedSymbol
|
199
218
|
)
|
200
219
|
|
201
220
|
sig do
|
202
|
-
override
|
203
|
-
|
204
|
-
|
205
|
-
|
221
|
+
override.returns(
|
222
|
+
T::Array[
|
223
|
+
Orb::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit::TaggedSymbol
|
224
|
+
]
|
225
|
+
)
|
226
|
+
end
|
227
|
+
def self.values
|
206
228
|
end
|
207
|
-
def self.values; end
|
208
229
|
end
|
209
230
|
end
|
210
231
|
end
|
@@ -5,6 +5,8 @@ module Orb
|
|
5
5
|
module Customers
|
6
6
|
module Credits
|
7
7
|
class TopUpCreateByExternalIDResponse < Orb::Internal::Type::BaseModel
|
8
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
9
|
+
|
8
10
|
sig { returns(String) }
|
9
11
|
attr_accessor :id
|
10
12
|
|
@@ -18,17 +20,18 @@ module Orb
|
|
18
20
|
attr_accessor :currency
|
19
21
|
|
20
22
|
# Settings for invoices generated by triggered top-ups.
|
21
|
-
sig
|
23
|
+
sig do
|
24
|
+
returns(
|
25
|
+
Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::InvoiceSettings
|
26
|
+
)
|
27
|
+
end
|
22
28
|
attr_reader :invoice_settings
|
23
29
|
|
24
30
|
sig do
|
25
31
|
params(
|
26
|
-
invoice_settings:
|
27
|
-
Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::InvoiceSettings
|
28
|
-
|
29
|
-
)
|
30
|
-
)
|
31
|
-
.void
|
32
|
+
invoice_settings:
|
33
|
+
Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::InvoiceSettings::OrHash
|
34
|
+
).void
|
32
35
|
end
|
33
36
|
attr_writer :invoice_settings
|
34
37
|
|
@@ -61,16 +64,16 @@ module Orb
|
|
61
64
|
id: String,
|
62
65
|
amount: String,
|
63
66
|
currency: String,
|
64
|
-
invoice_settings:
|
65
|
-
Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::InvoiceSettings,
|
66
|
-
Orb::Internal::AnyHash
|
67
|
-
),
|
67
|
+
invoice_settings:
|
68
|
+
Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::InvoiceSettings::OrHash,
|
68
69
|
per_unit_cost_basis: String,
|
69
70
|
threshold: String,
|
70
71
|
expires_after: T.nilable(Integer),
|
71
|
-
expires_after_unit:
|
72
|
-
|
73
|
-
|
72
|
+
expires_after_unit:
|
73
|
+
T.nilable(
|
74
|
+
Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::ExpiresAfterUnit::OrSymbol
|
75
|
+
)
|
76
|
+
).returns(T.attached_class)
|
74
77
|
end
|
75
78
|
def self.new(
|
76
79
|
id:,
|
@@ -91,27 +94,33 @@ module Orb
|
|
91
94
|
expires_after: nil,
|
92
95
|
# The unit of expires_after.
|
93
96
|
expires_after_unit: nil
|
94
|
-
)
|
97
|
+
)
|
98
|
+
end
|
99
|
+
|
95
100
|
sig do
|
96
|
-
override
|
97
|
-
|
98
|
-
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
|
103
|
-
|
104
|
-
|
105
|
-
|
106
|
-
|
101
|
+
override.returns(
|
102
|
+
{
|
103
|
+
id: String,
|
104
|
+
amount: String,
|
105
|
+
currency: String,
|
106
|
+
invoice_settings:
|
107
|
+
Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::InvoiceSettings,
|
108
|
+
per_unit_cost_basis: String,
|
109
|
+
threshold: String,
|
110
|
+
expires_after: T.nilable(Integer),
|
111
|
+
expires_after_unit:
|
112
|
+
T.nilable(
|
107
113
|
Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::ExpiresAfterUnit::TaggedSymbol
|
108
114
|
)
|
109
|
-
|
110
|
-
|
115
|
+
}
|
116
|
+
)
|
117
|
+
end
|
118
|
+
def to_hash
|
111
119
|
end
|
112
|
-
def to_hash; end
|
113
120
|
|
114
121
|
class InvoiceSettings < Orb::Internal::Type::BaseModel
|
122
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
123
|
+
|
115
124
|
# Whether the credits purchase invoice should auto collect with the customer's
|
116
125
|
# saved payment method.
|
117
126
|
sig { returns(T::Boolean) }
|
@@ -142,8 +151,7 @@ module Orb
|
|
142
151
|
net_terms: Integer,
|
143
152
|
memo: T.nilable(String),
|
144
153
|
require_successful_payment: T::Boolean
|
145
|
-
)
|
146
|
-
.returns(T.attached_class)
|
154
|
+
).returns(T.attached_class)
|
147
155
|
end
|
148
156
|
def self.new(
|
149
157
|
# Whether the credits purchase invoice should auto collect with the customer's
|
@@ -158,19 +166,21 @@ module Orb
|
|
158
166
|
# If true, new credit blocks created by this top-up will require that the
|
159
167
|
# corresponding invoice is paid before they can be drawn down from.
|
160
168
|
require_successful_payment: nil
|
161
|
-
)
|
169
|
+
)
|
170
|
+
end
|
171
|
+
|
162
172
|
sig do
|
163
|
-
override
|
164
|
-
|
165
|
-
|
166
|
-
|
167
|
-
|
168
|
-
|
169
|
-
|
170
|
-
|
171
|
-
|
173
|
+
override.returns(
|
174
|
+
{
|
175
|
+
auto_collection: T::Boolean,
|
176
|
+
net_terms: Integer,
|
177
|
+
memo: T.nilable(String),
|
178
|
+
require_successful_payment: T::Boolean
|
179
|
+
}
|
180
|
+
)
|
181
|
+
end
|
182
|
+
def to_hash
|
172
183
|
end
|
173
|
-
def to_hash; end
|
174
184
|
end
|
175
185
|
|
176
186
|
# The unit of expires_after.
|
@@ -178,7 +188,12 @@ module Orb
|
|
178
188
|
extend Orb::Internal::Type::Enum
|
179
189
|
|
180
190
|
TaggedSymbol =
|
181
|
-
T.type_alias
|
191
|
+
T.type_alias do
|
192
|
+
T.all(
|
193
|
+
Symbol,
|
194
|
+
Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::ExpiresAfterUnit
|
195
|
+
)
|
196
|
+
end
|
182
197
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
183
198
|
|
184
199
|
DAY =
|
@@ -193,12 +208,14 @@ module Orb
|
|
193
208
|
)
|
194
209
|
|
195
210
|
sig do
|
196
|
-
override
|
197
|
-
|
198
|
-
|
199
|
-
|
211
|
+
override.returns(
|
212
|
+
T::Array[
|
213
|
+
Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::ExpiresAfterUnit::TaggedSymbol
|
214
|
+
]
|
215
|
+
)
|
216
|
+
end
|
217
|
+
def self.values
|
200
218
|
end
|
201
|
-
def self.values; end
|
202
219
|
end
|
203
220
|
end
|
204
221
|
end
|
@@ -8,6 +8,8 @@ module Orb
|
|
8
8
|
extend Orb::Internal::Type::RequestParameters::Converter
|
9
9
|
include Orb::Internal::Type::RequestParameters
|
10
10
|
|
11
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
12
|
+
|
11
13
|
# The amount to increment when the threshold is reached.
|
12
14
|
sig { returns(String) }
|
13
15
|
attr_accessor :amount
|
@@ -18,14 +20,16 @@ module Orb
|
|
18
20
|
attr_accessor :currency
|
19
21
|
|
20
22
|
# Settings for invoices generated by triggered top-ups.
|
21
|
-
sig
|
23
|
+
sig do
|
24
|
+
returns(Orb::Customers::Credits::TopUpCreateParams::InvoiceSettings)
|
25
|
+
end
|
22
26
|
attr_reader :invoice_settings
|
23
27
|
|
24
28
|
sig do
|
25
29
|
params(
|
26
|
-
invoice_settings:
|
27
|
-
|
28
|
-
|
30
|
+
invoice_settings:
|
31
|
+
Orb::Customers::Credits::TopUpCreateParams::InvoiceSettings::OrHash
|
32
|
+
).void
|
29
33
|
end
|
30
34
|
attr_writer :invoice_settings
|
31
35
|
|
@@ -49,22 +53,31 @@ module Orb
|
|
49
53
|
attr_accessor :expires_after
|
50
54
|
|
51
55
|
# The unit of expires_after.
|
52
|
-
sig
|
56
|
+
sig do
|
57
|
+
returns(
|
58
|
+
T.nilable(
|
59
|
+
Orb::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit::OrSymbol
|
60
|
+
)
|
61
|
+
)
|
62
|
+
end
|
53
63
|
attr_accessor :expires_after_unit
|
54
64
|
|
55
65
|
sig do
|
56
66
|
params(
|
57
67
|
amount: String,
|
58
68
|
currency: String,
|
59
|
-
invoice_settings:
|
69
|
+
invoice_settings:
|
70
|
+
Orb::Customers::Credits::TopUpCreateParams::InvoiceSettings::OrHash,
|
60
71
|
per_unit_cost_basis: String,
|
61
72
|
threshold: String,
|
62
73
|
active_from: T.nilable(Time),
|
63
74
|
expires_after: T.nilable(Integer),
|
64
|
-
expires_after_unit:
|
65
|
-
|
66
|
-
|
67
|
-
|
75
|
+
expires_after_unit:
|
76
|
+
T.nilable(
|
77
|
+
Orb::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit::OrSymbol
|
78
|
+
),
|
79
|
+
request_options: Orb::RequestOptions::OrHash
|
80
|
+
).returns(T.attached_class)
|
68
81
|
end
|
69
82
|
def self.new(
|
70
83
|
# The amount to increment when the threshold is reached.
|
@@ -88,26 +101,34 @@ module Orb
|
|
88
101
|
# The unit of expires_after.
|
89
102
|
expires_after_unit: nil,
|
90
103
|
request_options: {}
|
91
|
-
)
|
104
|
+
)
|
105
|
+
end
|
106
|
+
|
92
107
|
sig do
|
93
|
-
override
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
|
98
|
-
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
|
103
|
-
|
104
|
-
|
105
|
-
|
106
|
-
|
108
|
+
override.returns(
|
109
|
+
{
|
110
|
+
amount: String,
|
111
|
+
currency: String,
|
112
|
+
invoice_settings:
|
113
|
+
Orb::Customers::Credits::TopUpCreateParams::InvoiceSettings,
|
114
|
+
per_unit_cost_basis: String,
|
115
|
+
threshold: String,
|
116
|
+
active_from: T.nilable(Time),
|
117
|
+
expires_after: T.nilable(Integer),
|
118
|
+
expires_after_unit:
|
119
|
+
T.nilable(
|
120
|
+
Orb::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit::OrSymbol
|
121
|
+
),
|
122
|
+
request_options: Orb::RequestOptions
|
123
|
+
}
|
124
|
+
)
|
125
|
+
end
|
126
|
+
def to_hash
|
107
127
|
end
|
108
|
-
def to_hash; end
|
109
128
|
|
110
129
|
class InvoiceSettings < Orb::Internal::Type::BaseModel
|
130
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
131
|
+
|
111
132
|
# Whether the credits purchase invoice should auto collect with the customer's
|
112
133
|
# saved payment method.
|
113
134
|
sig { returns(T::Boolean) }
|
@@ -138,8 +159,7 @@ module Orb
|
|
138
159
|
net_terms: Integer,
|
139
160
|
memo: T.nilable(String),
|
140
161
|
require_successful_payment: T::Boolean
|
141
|
-
)
|
142
|
-
.returns(T.attached_class)
|
162
|
+
).returns(T.attached_class)
|
143
163
|
end
|
144
164
|
def self.new(
|
145
165
|
# Whether the credits purchase invoice should auto collect with the customer's
|
@@ -154,19 +174,21 @@ module Orb
|
|
154
174
|
# If true, new credit blocks created by this top-up will require that the
|
155
175
|
# corresponding invoice is paid before they can be drawn down from.
|
156
176
|
require_successful_payment: nil
|
157
|
-
)
|
177
|
+
)
|
178
|
+
end
|
179
|
+
|
158
180
|
sig do
|
159
|
-
override
|
160
|
-
|
161
|
-
|
162
|
-
|
163
|
-
|
164
|
-
|
165
|
-
|
166
|
-
|
167
|
-
|
181
|
+
override.returns(
|
182
|
+
{
|
183
|
+
auto_collection: T::Boolean,
|
184
|
+
net_terms: Integer,
|
185
|
+
memo: T.nilable(String),
|
186
|
+
require_successful_payment: T::Boolean
|
187
|
+
}
|
188
|
+
)
|
189
|
+
end
|
190
|
+
def to_hash
|
168
191
|
end
|
169
|
-
def to_hash; end
|
170
192
|
end
|
171
193
|
|
172
194
|
# The unit of expires_after.
|
@@ -174,17 +196,34 @@ module Orb
|
|
174
196
|
extend Orb::Internal::Type::Enum
|
175
197
|
|
176
198
|
TaggedSymbol =
|
177
|
-
T.type_alias
|
199
|
+
T.type_alias do
|
200
|
+
T.all(
|
201
|
+
Symbol,
|
202
|
+
Orb::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit
|
203
|
+
)
|
204
|
+
end
|
178
205
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
179
206
|
|
180
|
-
DAY =
|
181
|
-
|
207
|
+
DAY =
|
208
|
+
T.let(
|
209
|
+
:day,
|
210
|
+
Orb::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit::TaggedSymbol
|
211
|
+
)
|
212
|
+
MONTH =
|
213
|
+
T.let(
|
214
|
+
:month,
|
215
|
+
Orb::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit::TaggedSymbol
|
216
|
+
)
|
182
217
|
|
183
218
|
sig do
|
184
|
-
override
|
185
|
-
|
219
|
+
override.returns(
|
220
|
+
T::Array[
|
221
|
+
Orb::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit::TaggedSymbol
|
222
|
+
]
|
223
|
+
)
|
224
|
+
end
|
225
|
+
def self.values
|
186
226
|
end
|
187
|
-
def self.values; end
|
188
227
|
end
|
189
228
|
end
|
190
229
|
end
|