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
@@ -41,10 +41,8 @@ module Orb
|
|
41
41
|
# @param currency [String, nil] The ledger currency or custom pricing unit to use.
|
42
42
|
#
|
43
43
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
44
|
-
# ...
|
45
44
|
#
|
46
45
|
# @param include_all_blocks [Boolean] If set to True, all expired and depleted blocks, as well as active block will be
|
47
|
-
# ...
|
48
46
|
#
|
49
47
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
50
48
|
#
|
@@ -18,9 +18,11 @@ module Orb
|
|
18
18
|
|
19
19
|
# @!attribute entry_type
|
20
20
|
#
|
21
|
-
# @return [Symbol, Orb::
|
21
|
+
# @return [Symbol, Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType]
|
22
22
|
required :entry_type,
|
23
|
-
enum: -> {
|
23
|
+
enum: -> {
|
24
|
+
Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType
|
25
|
+
}
|
24
26
|
|
25
27
|
# @!attribute currency
|
26
28
|
# The currency or custom pricing unit to use for this ledger entry. If this is a
|
@@ -56,9 +58,9 @@ module Orb
|
|
56
58
|
# per_unit_cost_basis, as the calculation of the invoice total is done on that
|
57
59
|
# basis.
|
58
60
|
#
|
59
|
-
# @return [Orb::
|
61
|
+
# @return [Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings, nil]
|
60
62
|
optional :invoice_settings,
|
61
|
-
-> { Orb::
|
63
|
+
-> { Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings },
|
62
64
|
nil?: true
|
63
65
|
|
64
66
|
# @!attribute metadata
|
@@ -93,9 +95,9 @@ module Orb
|
|
93
95
|
# @!attribute void_reason
|
94
96
|
# Can only be specified when `entry_type=void`. The reason for the void.
|
95
97
|
#
|
96
|
-
# @return [Symbol, Orb::
|
98
|
+
# @return [Symbol, Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason, nil]
|
97
99
|
optional :void_reason,
|
98
|
-
enum: -> { Orb::
|
100
|
+
enum: -> { Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason },
|
99
101
|
nil?: true
|
100
102
|
|
101
103
|
# @!method initialize(amount:, entry_type:, expiry_date:, target_expiry_date:, block_id:, currency: nil, description: nil, effective_date: nil, invoice_settings: nil, metadata: nil, per_unit_cost_basis: nil, void_reason: nil, request_options: {})
|
@@ -104,36 +106,28 @@ module Orb
|
|
104
106
|
# details.
|
105
107
|
#
|
106
108
|
# @param amount [Float] The number of credits to effect. Note that this is required for increment, decre
|
107
|
-
# ...
|
108
109
|
#
|
109
|
-
# @param entry_type [Symbol, Orb::
|
110
|
+
# @param entry_type [Symbol, Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType]
|
110
111
|
#
|
111
112
|
# @param expiry_date [Time, nil] An ISO 8601 format date that identifies the origination credit block to expire
|
112
113
|
#
|
113
114
|
# @param target_expiry_date [Date] A future date (specified in YYYY-MM-DD format) used for expiration change, denot
|
114
|
-
# ...
|
115
115
|
#
|
116
116
|
# @param block_id [String] The ID of the block to reverse a decrement from.
|
117
117
|
#
|
118
118
|
# @param currency [String, nil] The currency or custom pricing unit to use for this ledger entry. If this is a r
|
119
|
-
# ...
|
120
119
|
#
|
121
120
|
# @param description [String, nil] Optional metadata that can be specified when adding ledger results via the API.
|
122
|
-
# ...
|
123
121
|
#
|
124
122
|
# @param effective_date [Time, nil] An ISO 8601 format date that denotes when this credit balance should become avai
|
125
|
-
# ...
|
126
123
|
#
|
127
|
-
# @param invoice_settings [Orb::
|
128
|
-
# ...
|
124
|
+
# @param invoice_settings [Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings, nil] Passing `invoice_settings` automatically generates an invoice for the newly adde
|
129
125
|
#
|
130
126
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
131
|
-
# ...
|
132
127
|
#
|
133
128
|
# @param per_unit_cost_basis [String, nil] Can only be specified when entry_type=increment. How much, in the customer's cur
|
134
|
-
# ...
|
135
129
|
#
|
136
|
-
# @param void_reason [Symbol, Orb::
|
130
|
+
# @param void_reason [Symbol, Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason, nil] Can only be specified when `entry_type=void`. The reason for the void.
|
137
131
|
#
|
138
132
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
139
133
|
|
@@ -177,7 +171,7 @@ module Orb
|
|
177
171
|
|
178
172
|
# @!method initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil)
|
179
173
|
# Some parameter documentations has been truncated, see
|
180
|
-
# {Orb::
|
174
|
+
# {Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings}
|
181
175
|
# for more details.
|
182
176
|
#
|
183
177
|
# Passing `invoice_settings` automatically generates an invoice for the newly
|
@@ -186,15 +180,12 @@ module Orb
|
|
186
180
|
# basis.
|
187
181
|
#
|
188
182
|
# @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav
|
189
|
-
# ...
|
190
183
|
#
|
191
184
|
# @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d
|
192
|
-
# ...
|
193
185
|
#
|
194
186
|
# @param memo [String, nil] An optional memo to display on the invoice.
|
195
187
|
#
|
196
188
|
# @param require_successful_payment [Boolean] If true, the new credit block will require that the corresponding invoice is pai
|
197
|
-
# ...
|
198
189
|
end
|
199
190
|
|
200
191
|
# Can only be specified when `entry_type=void`. The reason for the void.
|
@@ -132,7 +132,6 @@ module Orb
|
|
132
132
|
# @param ledger_sequence_number [Integer]
|
133
133
|
#
|
134
134
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
135
|
-
# ...
|
136
135
|
#
|
137
136
|
# @param starting_balance [Float]
|
138
137
|
#
|
@@ -304,7 +303,6 @@ module Orb
|
|
304
303
|
# @param ledger_sequence_number [Integer]
|
305
304
|
#
|
306
305
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
307
|
-
# ...
|
308
306
|
#
|
309
307
|
# @param starting_balance [Float]
|
310
308
|
#
|
@@ -472,7 +470,6 @@ module Orb
|
|
472
470
|
# @param ledger_sequence_number [Integer]
|
473
471
|
#
|
474
472
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
475
|
-
# ...
|
476
473
|
#
|
477
474
|
# @param new_block_expiry_date [Time, nil]
|
478
475
|
#
|
@@ -631,7 +628,6 @@ module Orb
|
|
631
628
|
# @param ledger_sequence_number [Integer]
|
632
629
|
#
|
633
630
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
634
|
-
# ...
|
635
631
|
#
|
636
632
|
# @param starting_balance [Float]
|
637
633
|
#
|
@@ -798,7 +794,6 @@ module Orb
|
|
798
794
|
# @param ledger_sequence_number [Integer]
|
799
795
|
#
|
800
796
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
801
|
-
# ...
|
802
797
|
#
|
803
798
|
# @param starting_balance [Float]
|
804
799
|
#
|
@@ -974,7 +969,6 @@ module Orb
|
|
974
969
|
# @param ledger_sequence_number [Integer]
|
975
970
|
#
|
976
971
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
977
|
-
# ...
|
978
972
|
#
|
979
973
|
# @param new_block_expiry_date [Time]
|
980
974
|
#
|
@@ -1137,7 +1131,6 @@ module Orb
|
|
1137
1131
|
# @param ledger_sequence_number [Integer]
|
1138
1132
|
#
|
1139
1133
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
1140
|
-
# ...
|
1141
1134
|
#
|
1142
1135
|
# @param starting_balance [Float]
|
1143
1136
|
#
|
@@ -18,8 +18,8 @@ module Orb
|
|
18
18
|
|
19
19
|
# @!attribute entry_type
|
20
20
|
#
|
21
|
-
# @return [Symbol, Orb::
|
22
|
-
required :entry_type, enum: -> { Orb::
|
21
|
+
# @return [Symbol, Orb::Customers::Credits::LedgerCreateEntryParams::EntryType]
|
22
|
+
required :entry_type, enum: -> { Orb::Customers::Credits::LedgerCreateEntryParams::EntryType }
|
23
23
|
|
24
24
|
# @!attribute currency
|
25
25
|
# The currency or custom pricing unit to use for this ledger entry. If this is a
|
@@ -55,9 +55,9 @@ module Orb
|
|
55
55
|
# per_unit_cost_basis, as the calculation of the invoice total is done on that
|
56
56
|
# basis.
|
57
57
|
#
|
58
|
-
# @return [Orb::
|
58
|
+
# @return [Orb::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings, nil]
|
59
59
|
optional :invoice_settings,
|
60
|
-
-> { Orb::
|
60
|
+
-> { Orb::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings },
|
61
61
|
nil?: true
|
62
62
|
|
63
63
|
# @!attribute metadata
|
@@ -92,9 +92,9 @@ module Orb
|
|
92
92
|
# @!attribute void_reason
|
93
93
|
# Can only be specified when `entry_type=void`. The reason for the void.
|
94
94
|
#
|
95
|
-
# @return [Symbol, Orb::
|
95
|
+
# @return [Symbol, Orb::Customers::Credits::LedgerCreateEntryParams::VoidReason, nil]
|
96
96
|
optional :void_reason,
|
97
|
-
enum: -> { Orb::
|
97
|
+
enum: -> { Orb::Customers::Credits::LedgerCreateEntryParams::VoidReason },
|
98
98
|
nil?: true
|
99
99
|
|
100
100
|
# @!method initialize(amount:, entry_type:, expiry_date:, target_expiry_date:, block_id:, currency: nil, description: nil, effective_date: nil, invoice_settings: nil, metadata: nil, per_unit_cost_basis: nil, void_reason: nil, request_options: {})
|
@@ -102,36 +102,28 @@ module Orb
|
|
102
102
|
# {Orb::Models::Customers::Credits::LedgerCreateEntryParams} for more details.
|
103
103
|
#
|
104
104
|
# @param amount [Float] The number of credits to effect. Note that this is required for increment, decre
|
105
|
-
# ...
|
106
105
|
#
|
107
|
-
# @param entry_type [Symbol, Orb::
|
106
|
+
# @param entry_type [Symbol, Orb::Customers::Credits::LedgerCreateEntryParams::EntryType]
|
108
107
|
#
|
109
108
|
# @param expiry_date [Time, nil] An ISO 8601 format date that identifies the origination credit block to expire
|
110
109
|
#
|
111
110
|
# @param target_expiry_date [Date] A future date (specified in YYYY-MM-DD format) used for expiration change, denot
|
112
|
-
# ...
|
113
111
|
#
|
114
112
|
# @param block_id [String] The ID of the block to reverse a decrement from.
|
115
113
|
#
|
116
114
|
# @param currency [String, nil] The currency or custom pricing unit to use for this ledger entry. If this is a r
|
117
|
-
# ...
|
118
115
|
#
|
119
116
|
# @param description [String, nil] Optional metadata that can be specified when adding ledger results via the API.
|
120
|
-
# ...
|
121
117
|
#
|
122
118
|
# @param effective_date [Time, nil] An ISO 8601 format date that denotes when this credit balance should become avai
|
123
|
-
# ...
|
124
119
|
#
|
125
|
-
# @param invoice_settings [Orb::
|
126
|
-
# ...
|
120
|
+
# @param invoice_settings [Orb::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings, nil] Passing `invoice_settings` automatically generates an invoice for the newly adde
|
127
121
|
#
|
128
122
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
129
|
-
# ...
|
130
123
|
#
|
131
124
|
# @param per_unit_cost_basis [String, nil] Can only be specified when entry_type=increment. How much, in the customer's cur
|
132
|
-
# ...
|
133
125
|
#
|
134
|
-
# @param void_reason [Symbol, Orb::
|
126
|
+
# @param void_reason [Symbol, Orb::Customers::Credits::LedgerCreateEntryParams::VoidReason, nil] Can only be specified when `entry_type=void`. The reason for the void.
|
135
127
|
#
|
136
128
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
137
129
|
|
@@ -175,8 +167,8 @@ module Orb
|
|
175
167
|
|
176
168
|
# @!method initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil)
|
177
169
|
# Some parameter documentations has been truncated, see
|
178
|
-
# {Orb::
|
179
|
-
#
|
170
|
+
# {Orb::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings} for more
|
171
|
+
# details.
|
180
172
|
#
|
181
173
|
# Passing `invoice_settings` automatically generates an invoice for the newly
|
182
174
|
# added credits. If `invoice_settings` is passed, you must specify
|
@@ -184,15 +176,12 @@ module Orb
|
|
184
176
|
# basis.
|
185
177
|
#
|
186
178
|
# @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav
|
187
|
-
# ...
|
188
179
|
#
|
189
180
|
# @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d
|
190
|
-
# ...
|
191
181
|
#
|
192
182
|
# @param memo [String, nil] An optional memo to display on the invoice.
|
193
183
|
#
|
194
184
|
# @param require_successful_payment [Boolean] If true, the new credit block will require that the corresponding invoice is pai
|
195
|
-
# ...
|
196
185
|
end
|
197
186
|
|
198
187
|
# Can only be specified when `entry_type=void`. The reason for the void.
|
@@ -127,7 +127,6 @@ module Orb
|
|
127
127
|
# @param ledger_sequence_number [Integer]
|
128
128
|
#
|
129
129
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
130
|
-
# ...
|
131
130
|
#
|
132
131
|
# @param starting_balance [Float]
|
133
132
|
#
|
@@ -298,7 +297,6 @@ module Orb
|
|
298
297
|
# @param ledger_sequence_number [Integer]
|
299
298
|
#
|
300
299
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
301
|
-
# ...
|
302
300
|
#
|
303
301
|
# @param starting_balance [Float]
|
304
302
|
#
|
@@ -466,7 +464,6 @@ module Orb
|
|
466
464
|
# @param ledger_sequence_number [Integer]
|
467
465
|
#
|
468
466
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
469
|
-
# ...
|
470
467
|
#
|
471
468
|
# @param new_block_expiry_date [Time, nil]
|
472
469
|
#
|
@@ -625,7 +622,6 @@ module Orb
|
|
625
622
|
# @param ledger_sequence_number [Integer]
|
626
623
|
#
|
627
624
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
628
|
-
# ...
|
629
625
|
#
|
630
626
|
# @param starting_balance [Float]
|
631
627
|
#
|
@@ -791,7 +787,6 @@ module Orb
|
|
791
787
|
# @param ledger_sequence_number [Integer]
|
792
788
|
#
|
793
789
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
794
|
-
# ...
|
795
790
|
#
|
796
791
|
# @param starting_balance [Float]
|
797
792
|
#
|
@@ -967,7 +962,6 @@ module Orb
|
|
967
962
|
# @param ledger_sequence_number [Integer]
|
968
963
|
#
|
969
964
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
970
|
-
# ...
|
971
965
|
#
|
972
966
|
# @param new_block_expiry_date [Time]
|
973
967
|
#
|
@@ -1129,7 +1123,6 @@ module Orb
|
|
1129
1123
|
# @param ledger_sequence_number [Integer]
|
1130
1124
|
#
|
1131
1125
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
1132
|
-
# ...
|
1133
1126
|
#
|
1134
1127
|
# @param starting_balance [Float]
|
1135
1128
|
#
|
@@ -44,16 +44,16 @@ module Orb
|
|
44
44
|
|
45
45
|
# @!attribute entry_status
|
46
46
|
#
|
47
|
-
# @return [Symbol, Orb::
|
47
|
+
# @return [Symbol, Orb::Customers::Credits::LedgerListByExternalIDParams::EntryStatus, nil]
|
48
48
|
optional :entry_status,
|
49
|
-
enum: -> { Orb::
|
49
|
+
enum: -> { Orb::Customers::Credits::LedgerListByExternalIDParams::EntryStatus },
|
50
50
|
nil?: true
|
51
51
|
|
52
52
|
# @!attribute entry_type
|
53
53
|
#
|
54
|
-
# @return [Symbol, Orb::
|
54
|
+
# @return [Symbol, Orb::Customers::Credits::LedgerListByExternalIDParams::EntryType, nil]
|
55
55
|
optional :entry_type,
|
56
|
-
enum: -> { Orb::
|
56
|
+
enum: -> { Orb::Customers::Credits::LedgerListByExternalIDParams::EntryType },
|
57
57
|
nil?: true
|
58
58
|
|
59
59
|
# @!attribute limit
|
@@ -83,11 +83,10 @@ module Orb
|
|
83
83
|
# @param currency [String, nil] The ledger currency or custom pricing unit to use.
|
84
84
|
#
|
85
85
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
86
|
-
# ...
|
87
86
|
#
|
88
|
-
# @param entry_status [Symbol, Orb::
|
87
|
+
# @param entry_status [Symbol, Orb::Customers::Credits::LedgerListByExternalIDParams::EntryStatus, nil]
|
89
88
|
#
|
90
|
-
# @param entry_type [Symbol, Orb::
|
89
|
+
# @param entry_type [Symbol, Orb::Customers::Credits::LedgerListByExternalIDParams::EntryType, nil]
|
91
90
|
#
|
92
91
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
93
92
|
#
|
@@ -129,7 +129,6 @@ module Orb
|
|
129
129
|
# @param ledger_sequence_number [Integer]
|
130
130
|
#
|
131
131
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
132
|
-
# ...
|
133
132
|
#
|
134
133
|
# @param starting_balance [Float]
|
135
134
|
#
|
@@ -301,7 +300,6 @@ module Orb
|
|
301
300
|
# @param ledger_sequence_number [Integer]
|
302
301
|
#
|
303
302
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
304
|
-
# ...
|
305
303
|
#
|
306
304
|
# @param starting_balance [Float]
|
307
305
|
#
|
@@ -469,7 +467,6 @@ module Orb
|
|
469
467
|
# @param ledger_sequence_number [Integer]
|
470
468
|
#
|
471
469
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
472
|
-
# ...
|
473
470
|
#
|
474
471
|
# @param new_block_expiry_date [Time, nil]
|
475
472
|
#
|
@@ -628,7 +625,6 @@ module Orb
|
|
628
625
|
# @param ledger_sequence_number [Integer]
|
629
626
|
#
|
630
627
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
631
|
-
# ...
|
632
628
|
#
|
633
629
|
# @param starting_balance [Float]
|
634
630
|
#
|
@@ -794,7 +790,6 @@ module Orb
|
|
794
790
|
# @param ledger_sequence_number [Integer]
|
795
791
|
#
|
796
792
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
797
|
-
# ...
|
798
793
|
#
|
799
794
|
# @param starting_balance [Float]
|
800
795
|
#
|
@@ -970,7 +965,6 @@ module Orb
|
|
970
965
|
# @param ledger_sequence_number [Integer]
|
971
966
|
#
|
972
967
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
973
|
-
# ...
|
974
968
|
#
|
975
969
|
# @param new_block_expiry_date [Time]
|
976
970
|
#
|
@@ -1133,7 +1127,6 @@ module Orb
|
|
1133
1127
|
# @param ledger_sequence_number [Integer]
|
1134
1128
|
#
|
1135
1129
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
1136
|
-
# ...
|
1137
1130
|
#
|
1138
1131
|
# @param starting_balance [Float]
|
1139
1132
|
#
|
@@ -44,17 +44,17 @@ module Orb
|
|
44
44
|
|
45
45
|
# @!attribute entry_status
|
46
46
|
#
|
47
|
-
# @return [Symbol, Orb::
|
47
|
+
# @return [Symbol, Orb::Customers::Credits::LedgerListParams::EntryStatus, nil]
|
48
48
|
optional :entry_status,
|
49
|
-
enum: -> {
|
49
|
+
enum: -> {
|
50
|
+
Orb::Customers::Credits::LedgerListParams::EntryStatus
|
51
|
+
},
|
50
52
|
nil?: true
|
51
53
|
|
52
54
|
# @!attribute entry_type
|
53
55
|
#
|
54
|
-
# @return [Symbol, Orb::
|
55
|
-
optional :entry_type,
|
56
|
-
enum: -> { Orb::Models::Customers::Credits::LedgerListParams::EntryType },
|
57
|
-
nil?: true
|
56
|
+
# @return [Symbol, Orb::Customers::Credits::LedgerListParams::EntryType, nil]
|
57
|
+
optional :entry_type, enum: -> { Orb::Customers::Credits::LedgerListParams::EntryType }, nil?: true
|
58
58
|
|
59
59
|
# @!attribute limit
|
60
60
|
# The number of items to fetch. Defaults to 20.
|
@@ -82,11 +82,10 @@ module Orb
|
|
82
82
|
# @param currency [String, nil] The ledger currency or custom pricing unit to use.
|
83
83
|
#
|
84
84
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
85
|
-
# ...
|
86
85
|
#
|
87
|
-
# @param entry_status [Symbol, Orb::
|
86
|
+
# @param entry_status [Symbol, Orb::Customers::Credits::LedgerListParams::EntryStatus, nil]
|
88
87
|
#
|
89
|
-
# @param entry_type [Symbol, Orb::
|
88
|
+
# @param entry_type [Symbol, Orb::Customers::Credits::LedgerListParams::EntryType, nil]
|
90
89
|
#
|
91
90
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
92
91
|
#
|
@@ -125,7 +125,6 @@ module Orb
|
|
125
125
|
# @param ledger_sequence_number [Integer]
|
126
126
|
#
|
127
127
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
128
|
-
# ...
|
129
128
|
#
|
130
129
|
# @param starting_balance [Float]
|
131
130
|
#
|
@@ -295,7 +294,6 @@ module Orb
|
|
295
294
|
# @param ledger_sequence_number [Integer]
|
296
295
|
#
|
297
296
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
298
|
-
# ...
|
299
297
|
#
|
300
298
|
# @param starting_balance [Float]
|
301
299
|
#
|
@@ -462,7 +460,6 @@ module Orb
|
|
462
460
|
# @param ledger_sequence_number [Integer]
|
463
461
|
#
|
464
462
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
465
|
-
# ...
|
466
463
|
#
|
467
464
|
# @param new_block_expiry_date [Time, nil]
|
468
465
|
#
|
@@ -621,7 +618,6 @@ module Orb
|
|
621
618
|
# @param ledger_sequence_number [Integer]
|
622
619
|
#
|
623
620
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
624
|
-
# ...
|
625
621
|
#
|
626
622
|
# @param starting_balance [Float]
|
627
623
|
#
|
@@ -785,7 +781,6 @@ module Orb
|
|
785
781
|
# @param ledger_sequence_number [Integer]
|
786
782
|
#
|
787
783
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
788
|
-
# ...
|
789
784
|
#
|
790
785
|
# @param starting_balance [Float]
|
791
786
|
#
|
@@ -960,7 +955,6 @@ module Orb
|
|
960
955
|
# @param ledger_sequence_number [Integer]
|
961
956
|
#
|
962
957
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
963
|
-
# ...
|
964
958
|
#
|
965
959
|
# @param new_block_expiry_date [Time]
|
966
960
|
#
|
@@ -1121,7 +1115,6 @@ module Orb
|
|
1121
1115
|
# @param ledger_sequence_number [Integer]
|
1122
1116
|
#
|
1123
1117
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
1124
|
-
# ...
|
1125
1118
|
#
|
1126
1119
|
# @param starting_balance [Float]
|
1127
1120
|
#
|
@@ -25,9 +25,11 @@ module Orb
|
|
25
25
|
# @!attribute invoice_settings
|
26
26
|
# Settings for invoices generated by triggered top-ups.
|
27
27
|
#
|
28
|
-
# @return [Orb::
|
28
|
+
# @return [Orb::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings]
|
29
29
|
required :invoice_settings,
|
30
|
-
-> {
|
30
|
+
-> {
|
31
|
+
Orb::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings
|
32
|
+
}
|
31
33
|
|
32
34
|
# @!attribute per_unit_cost_basis
|
33
35
|
# How much, in the customer's currency, to charge for each unit.
|
@@ -59,9 +61,9 @@ module Orb
|
|
59
61
|
# @!attribute expires_after_unit
|
60
62
|
# The unit of expires_after.
|
61
63
|
#
|
62
|
-
# @return [Symbol, Orb::
|
64
|
+
# @return [Symbol, Orb::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit, nil]
|
63
65
|
optional :expires_after_unit,
|
64
|
-
enum: -> { Orb::
|
66
|
+
enum: -> { Orb::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit },
|
65
67
|
nil?: true
|
66
68
|
|
67
69
|
# @!method initialize(amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, active_from: nil, expires_after: nil, expires_after_unit: nil, request_options: {})
|
@@ -72,22 +74,18 @@ module Orb
|
|
72
74
|
# @param amount [String] The amount to increment when the threshold is reached.
|
73
75
|
#
|
74
76
|
# @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo
|
75
|
-
# ...
|
76
77
|
#
|
77
|
-
# @param invoice_settings [Orb::
|
78
|
+
# @param invoice_settings [Orb::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings] Settings for invoices generated by triggered top-ups.
|
78
79
|
#
|
79
80
|
# @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit.
|
80
81
|
#
|
81
82
|
# @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this
|
82
|
-
# ...
|
83
83
|
#
|
84
84
|
# @param active_from [Time, nil] The date from which the top-up is active. If unspecified, the top-up is active i
|
85
|
-
# ...
|
86
85
|
#
|
87
86
|
# @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it
|
88
|
-
# ...
|
89
87
|
#
|
90
|
-
# @param expires_after_unit [Symbol, Orb::
|
88
|
+
# @param expires_after_unit [Symbol, Orb::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit, nil] The unit of expires_after.
|
91
89
|
#
|
92
90
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
93
91
|
|
@@ -122,21 +120,18 @@ module Orb
|
|
122
120
|
|
123
121
|
# @!method initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil)
|
124
122
|
# Some parameter documentations has been truncated, see
|
125
|
-
# {Orb::
|
126
|
-
#
|
123
|
+
# {Orb::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings} for
|
124
|
+
# more details.
|
127
125
|
#
|
128
126
|
# Settings for invoices generated by triggered top-ups.
|
129
127
|
#
|
130
128
|
# @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav
|
131
|
-
# ...
|
132
129
|
#
|
133
130
|
# @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d
|
134
|
-
# ...
|
135
131
|
#
|
136
132
|
# @param memo [String, nil] An optional memo to display on the invoice.
|
137
133
|
#
|
138
134
|
# @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo
|
139
|
-
# ...
|
140
135
|
end
|
141
136
|
|
142
137
|
# The unit of expires_after.
|
@@ -69,17 +69,14 @@ module Orb
|
|
69
69
|
# @param amount [String] The amount to increment when the threshold is reached.
|
70
70
|
#
|
71
71
|
# @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo
|
72
|
-
# ...
|
73
72
|
#
|
74
73
|
# @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::InvoiceSettings] Settings for invoices generated by triggered top-ups.
|
75
74
|
#
|
76
75
|
# @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit.
|
77
76
|
#
|
78
77
|
# @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this
|
79
|
-
# ...
|
80
78
|
#
|
81
79
|
# @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it
|
82
|
-
# ...
|
83
80
|
#
|
84
81
|
# @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::ExpiresAfterUnit, nil] The unit of expires_after.
|
85
82
|
|
@@ -121,15 +118,12 @@ module Orb
|
|
121
118
|
# Settings for invoices generated by triggered top-ups.
|
122
119
|
#
|
123
120
|
# @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav
|
124
|
-
# ...
|
125
121
|
#
|
126
122
|
# @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d
|
127
|
-
# ...
|
128
123
|
#
|
129
124
|
# @param memo [String, nil] An optional memo to display on the invoice.
|
130
125
|
#
|
131
126
|
# @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo
|
132
|
-
# ...
|
133
127
|
end
|
134
128
|
|
135
129
|
# The unit of expires_after.
|