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
@@ -7,12 +7,11 @@ module Orb
|
|
7
7
|
# [`Credit Note`](/invoicing/credit-notes).
|
8
8
|
sig do
|
9
9
|
params(
|
10
|
-
line_items: T::Array[
|
10
|
+
line_items: T::Array[Orb::CreditNoteCreateParams::LineItem::OrHash],
|
11
11
|
memo: T.nilable(String),
|
12
|
-
reason: T.nilable(Orb::
|
13
|
-
request_options: Orb::
|
14
|
-
)
|
15
|
-
.returns(Orb::Models::CreditNote)
|
12
|
+
reason: T.nilable(Orb::CreditNoteCreateParams::Reason::OrSymbol),
|
13
|
+
request_options: Orb::RequestOptions::OrHash
|
14
|
+
).returns(Orb::CreditNote)
|
16
15
|
end
|
17
16
|
def create(
|
18
17
|
line_items:,
|
@@ -21,7 +20,9 @@ module Orb
|
|
21
20
|
# An optional reason for the credit note.
|
22
21
|
reason: nil,
|
23
22
|
request_options: {}
|
24
|
-
)
|
23
|
+
)
|
24
|
+
end
|
25
|
+
|
25
26
|
# Get a paginated list of CreditNotes. Users can also filter by customer_id,
|
26
27
|
# subscription_id, or external_customer_id. The credit notes will be returned in
|
27
28
|
# reverse chronological order by `creation_time`.
|
@@ -33,9 +34,8 @@ module Orb
|
|
33
34
|
created_at_lte: T.nilable(Time),
|
34
35
|
cursor: T.nilable(String),
|
35
36
|
limit: Integer,
|
36
|
-
request_options: Orb::
|
37
|
-
)
|
38
|
-
.returns(Orb::Internal::Page[Orb::Models::CreditNote])
|
37
|
+
request_options: Orb::RequestOptions::OrHash
|
38
|
+
).returns(Orb::Internal::Page[Orb::CreditNote])
|
39
39
|
end
|
40
40
|
def list(
|
41
41
|
created_at_gt: nil,
|
@@ -48,15 +48,24 @@ module Orb
|
|
48
48
|
# The number of items to fetch. Defaults to 20.
|
49
49
|
limit: nil,
|
50
50
|
request_options: {}
|
51
|
-
)
|
51
|
+
)
|
52
|
+
end
|
53
|
+
|
52
54
|
# This endpoint is used to fetch a single [`Credit Note`](/invoicing/credit-notes)
|
53
55
|
# given an identifier.
|
54
|
-
sig
|
55
|
-
|
56
|
+
sig do
|
57
|
+
params(
|
58
|
+
credit_note_id: String,
|
59
|
+
request_options: Orb::RequestOptions::OrHash
|
60
|
+
).returns(Orb::CreditNote)
|
61
|
+
end
|
62
|
+
def fetch(credit_note_id, request_options: {})
|
63
|
+
end
|
56
64
|
|
57
65
|
# @api private
|
58
66
|
sig { params(client: Orb::Client).returns(T.attached_class) }
|
59
|
-
def self.new(client:)
|
67
|
+
def self.new(client:)
|
68
|
+
end
|
60
69
|
end
|
61
70
|
end
|
62
71
|
end
|
@@ -10,11 +10,11 @@ module Orb
|
|
10
10
|
params(
|
11
11
|
customer_id: String,
|
12
12
|
amount: String,
|
13
|
-
type:
|
13
|
+
type:
|
14
|
+
Orb::Customers::BalanceTransactionCreateParams::Type::OrSymbol,
|
14
15
|
description: T.nilable(String),
|
15
|
-
request_options: Orb::
|
16
|
-
)
|
17
|
-
.returns(Orb::Models::Customers::BalanceTransactionCreateResponse)
|
16
|
+
request_options: Orb::RequestOptions::OrHash
|
17
|
+
).returns(Orb::Models::Customers::BalanceTransactionCreateResponse)
|
18
18
|
end
|
19
19
|
def create(
|
20
20
|
customer_id,
|
@@ -23,7 +23,9 @@ module Orb
|
|
23
23
|
# An optional description that can be specified around this entry.
|
24
24
|
description: nil,
|
25
25
|
request_options: {}
|
26
|
-
)
|
26
|
+
)
|
27
|
+
end
|
28
|
+
|
27
29
|
# ## The customer balance
|
28
30
|
#
|
29
31
|
# The customer balance is an amount in the customer's currency, which Orb
|
@@ -61,9 +63,12 @@ module Orb
|
|
61
63
|
operation_time_gte: T.nilable(Time),
|
62
64
|
operation_time_lt: T.nilable(Time),
|
63
65
|
operation_time_lte: T.nilable(Time),
|
64
|
-
request_options: Orb::
|
66
|
+
request_options: Orb::RequestOptions::OrHash
|
67
|
+
).returns(
|
68
|
+
Orb::Internal::Page[
|
69
|
+
Orb::Models::Customers::BalanceTransactionListResponse
|
70
|
+
]
|
65
71
|
)
|
66
|
-
.returns(Orb::Internal::Page[Orb::Models::Customers::BalanceTransactionListResponse])
|
67
72
|
end
|
68
73
|
def list(
|
69
74
|
customer_id,
|
@@ -77,10 +82,13 @@ module Orb
|
|
77
82
|
operation_time_lt: nil,
|
78
83
|
operation_time_lte: nil,
|
79
84
|
request_options: {}
|
80
|
-
)
|
85
|
+
)
|
86
|
+
end
|
87
|
+
|
81
88
|
# @api private
|
82
89
|
sig { params(client: Orb::Client).returns(T.attached_class) }
|
83
|
-
def self.new(client:)
|
90
|
+
def self.new(client:)
|
91
|
+
end
|
84
92
|
end
|
85
93
|
end
|
86
94
|
end
|
@@ -127,10 +127,10 @@ module Orb
|
|
127
127
|
currency: T.nilable(String),
|
128
128
|
timeframe_end: T.nilable(Time),
|
129
129
|
timeframe_start: T.nilable(Time),
|
130
|
-
view_mode:
|
131
|
-
|
132
|
-
|
133
|
-
|
130
|
+
view_mode:
|
131
|
+
T.nilable(Orb::Customers::CostListParams::ViewMode::OrSymbol),
|
132
|
+
request_options: Orb::RequestOptions::OrHash
|
133
|
+
).returns(Orb::Models::Customers::CostListResponse)
|
134
134
|
end
|
135
135
|
def list(
|
136
136
|
customer_id,
|
@@ -146,7 +146,9 @@ module Orb
|
|
146
146
|
# behavior.
|
147
147
|
view_mode: nil,
|
148
148
|
request_options: {}
|
149
|
-
)
|
149
|
+
)
|
150
|
+
end
|
151
|
+
|
150
152
|
# This endpoint is used to fetch a day-by-day snapshot of a customer's costs in
|
151
153
|
# Orb, calculated by applying pricing information to the underlying usage (see the
|
152
154
|
# [subscription usage endpoint](/api-reference/subscription/fetch-subscription-usage)
|
@@ -270,10 +272,12 @@ module Orb
|
|
270
272
|
currency: T.nilable(String),
|
271
273
|
timeframe_end: T.nilable(Time),
|
272
274
|
timeframe_start: T.nilable(Time),
|
273
|
-
view_mode:
|
274
|
-
|
275
|
-
|
276
|
-
|
275
|
+
view_mode:
|
276
|
+
T.nilable(
|
277
|
+
Orb::Customers::CostListByExternalIDParams::ViewMode::OrSymbol
|
278
|
+
),
|
279
|
+
request_options: Orb::RequestOptions::OrHash
|
280
|
+
).returns(Orb::Models::Customers::CostListByExternalIDResponse)
|
277
281
|
end
|
278
282
|
def list_by_external_id(
|
279
283
|
external_customer_id,
|
@@ -289,10 +293,13 @@ module Orb
|
|
289
293
|
# behavior.
|
290
294
|
view_mode: nil,
|
291
295
|
request_options: {}
|
292
|
-
)
|
296
|
+
)
|
297
|
+
end
|
298
|
+
|
293
299
|
# @api private
|
294
300
|
sig { params(client: Orb::Client).returns(T.attached_class) }
|
295
|
-
def self.new(client:)
|
301
|
+
def self.new(client:)
|
302
|
+
end
|
296
303
|
end
|
297
304
|
end
|
298
305
|
end
|
@@ -95,25 +95,30 @@ module Orb
|
|
95
95
|
created_at_lte: T.nilable(Time),
|
96
96
|
currency: T.nilable(String),
|
97
97
|
cursor: T.nilable(String),
|
98
|
-
entry_status:
|
99
|
-
|
98
|
+
entry_status:
|
99
|
+
T.nilable(
|
100
|
+
Orb::Customers::Credits::LedgerListParams::EntryStatus::OrSymbol
|
101
|
+
),
|
102
|
+
entry_type:
|
103
|
+
T.nilable(
|
104
|
+
Orb::Customers::Credits::LedgerListParams::EntryType::OrSymbol
|
105
|
+
),
|
100
106
|
limit: Integer,
|
101
107
|
minimum_amount: T.nilable(String),
|
102
|
-
request_options: Orb::
|
108
|
+
request_options: Orb::RequestOptions::OrHash
|
109
|
+
).returns(
|
110
|
+
Orb::Internal::Page[
|
111
|
+
T.any(
|
112
|
+
Orb::Models::Customers::Credits::LedgerListResponse::Increment,
|
113
|
+
Orb::Models::Customers::Credits::LedgerListResponse::Decrement,
|
114
|
+
Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChange,
|
115
|
+
Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiry,
|
116
|
+
Orb::Models::Customers::Credits::LedgerListResponse::Void,
|
117
|
+
Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiated,
|
118
|
+
Orb::Models::Customers::Credits::LedgerListResponse::Amendment
|
119
|
+
)
|
120
|
+
]
|
103
121
|
)
|
104
|
-
.returns(
|
105
|
-
Orb::Internal::Page[
|
106
|
-
T.any(
|
107
|
-
Orb::Models::Customers::Credits::LedgerListResponse::Increment,
|
108
|
-
Orb::Models::Customers::Credits::LedgerListResponse::Decrement,
|
109
|
-
Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChange,
|
110
|
-
Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiry,
|
111
|
-
Orb::Models::Customers::Credits::LedgerListResponse::Void,
|
112
|
-
Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiated,
|
113
|
-
Orb::Models::Customers::Credits::LedgerListResponse::Amendment
|
114
|
-
)
|
115
|
-
]
|
116
|
-
)
|
117
122
|
end
|
118
123
|
def list(
|
119
124
|
customer_id,
|
@@ -132,7 +137,9 @@ module Orb
|
|
132
137
|
limit: nil,
|
133
138
|
minimum_amount: nil,
|
134
139
|
request_options: {}
|
135
|
-
)
|
140
|
+
)
|
141
|
+
end
|
142
|
+
|
136
143
|
# This endpoint allows you to create a new ledger entry for a specified customer's
|
137
144
|
# balance. This can be used to increment balance, deduct credits, and change the
|
138
145
|
# expiry date of existing credits.
|
@@ -247,32 +254,36 @@ module Orb
|
|
247
254
|
params(
|
248
255
|
customer_id: String,
|
249
256
|
amount: Float,
|
250
|
-
entry_type:
|
257
|
+
entry_type:
|
258
|
+
Orb::Customers::Credits::LedgerCreateEntryParams::EntryType::OrSymbol,
|
251
259
|
expiry_date: T.nilable(Time),
|
252
260
|
target_expiry_date: Date,
|
253
261
|
block_id: String,
|
254
262
|
currency: T.nilable(String),
|
255
263
|
description: T.nilable(String),
|
256
264
|
effective_date: T.nilable(Time),
|
257
|
-
invoice_settings:
|
258
|
-
T.
|
259
|
-
|
265
|
+
invoice_settings:
|
266
|
+
T.nilable(
|
267
|
+
Orb::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings::OrHash
|
268
|
+
),
|
260
269
|
metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
|
261
270
|
per_unit_cost_basis: T.nilable(String),
|
262
|
-
void_reason:
|
263
|
-
|
264
|
-
|
265
|
-
|
266
|
-
|
267
|
-
|
268
|
-
|
269
|
-
|
270
|
-
|
271
|
-
|
272
|
-
|
273
|
-
|
274
|
-
|
271
|
+
void_reason:
|
272
|
+
T.nilable(
|
273
|
+
Orb::Customers::Credits::LedgerCreateEntryParams::VoidReason::OrSymbol
|
274
|
+
),
|
275
|
+
request_options: Orb::RequestOptions::OrHash
|
276
|
+
).returns(
|
277
|
+
T.any(
|
278
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Increment,
|
279
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Decrement,
|
280
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChange,
|
281
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiry,
|
282
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Void,
|
283
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiated,
|
284
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Amendment
|
275
285
|
)
|
286
|
+
)
|
276
287
|
end
|
277
288
|
def create_entry(
|
278
289
|
customer_id,
|
@@ -313,7 +324,9 @@ module Orb
|
|
313
324
|
# Can only be specified when `entry_type=void`. The reason for the void.
|
314
325
|
void_reason: nil,
|
315
326
|
request_options: {}
|
316
|
-
)
|
327
|
+
)
|
328
|
+
end
|
329
|
+
|
317
330
|
# This endpoint allows you to create a new ledger entry for a specified customer's
|
318
331
|
# balance. This can be used to increment balance, deduct credits, and change the
|
319
332
|
# expiry date of existing credits.
|
@@ -428,35 +441,36 @@ module Orb
|
|
428
441
|
params(
|
429
442
|
external_customer_id: String,
|
430
443
|
amount: Float,
|
431
|
-
entry_type:
|
444
|
+
entry_type:
|
445
|
+
Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType::OrSymbol,
|
432
446
|
expiry_date: T.nilable(Time),
|
433
447
|
target_expiry_date: Date,
|
434
448
|
block_id: String,
|
435
449
|
currency: T.nilable(String),
|
436
450
|
description: T.nilable(String),
|
437
451
|
effective_date: T.nilable(Time),
|
438
|
-
invoice_settings:
|
439
|
-
T.
|
440
|
-
Orb::
|
441
|
-
|
442
|
-
)
|
443
|
-
),
|
452
|
+
invoice_settings:
|
453
|
+
T.nilable(
|
454
|
+
Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings::OrHash
|
455
|
+
),
|
444
456
|
metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
|
445
457
|
per_unit_cost_basis: T.nilable(String),
|
446
|
-
void_reason:
|
447
|
-
|
448
|
-
|
449
|
-
|
450
|
-
|
451
|
-
|
452
|
-
|
453
|
-
|
454
|
-
|
455
|
-
|
456
|
-
|
457
|
-
|
458
|
-
|
458
|
+
void_reason:
|
459
|
+
T.nilable(
|
460
|
+
Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason::OrSymbol
|
461
|
+
),
|
462
|
+
request_options: Orb::RequestOptions::OrHash
|
463
|
+
).returns(
|
464
|
+
T.any(
|
465
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Increment,
|
466
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Decrement,
|
467
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChange,
|
468
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiry,
|
469
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Void,
|
470
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiated,
|
471
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Amendment
|
459
472
|
)
|
473
|
+
)
|
460
474
|
end
|
461
475
|
def create_entry_by_external_id(
|
462
476
|
external_customer_id,
|
@@ -497,7 +511,9 @@ module Orb
|
|
497
511
|
# Can only be specified when `entry_type=void`. The reason for the void.
|
498
512
|
void_reason: nil,
|
499
513
|
request_options: {}
|
500
|
-
)
|
514
|
+
)
|
515
|
+
end
|
516
|
+
|
501
517
|
# The credits ledger provides _auditing_ functionality over Orb's credits system
|
502
518
|
# with a list of actions that have taken place to modify a customer's credit
|
503
519
|
# balance. This [paginated endpoint](/api-reference/pagination) lists these
|
@@ -588,25 +604,30 @@ module Orb
|
|
588
604
|
created_at_lte: T.nilable(Time),
|
589
605
|
currency: T.nilable(String),
|
590
606
|
cursor: T.nilable(String),
|
591
|
-
entry_status:
|
592
|
-
|
607
|
+
entry_status:
|
608
|
+
T.nilable(
|
609
|
+
Orb::Customers::Credits::LedgerListByExternalIDParams::EntryStatus::OrSymbol
|
610
|
+
),
|
611
|
+
entry_type:
|
612
|
+
T.nilable(
|
613
|
+
Orb::Customers::Credits::LedgerListByExternalIDParams::EntryType::OrSymbol
|
614
|
+
),
|
593
615
|
limit: Integer,
|
594
616
|
minimum_amount: T.nilable(String),
|
595
|
-
request_options: Orb::
|
617
|
+
request_options: Orb::RequestOptions::OrHash
|
618
|
+
).returns(
|
619
|
+
Orb::Internal::Page[
|
620
|
+
T.any(
|
621
|
+
Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Increment,
|
622
|
+
Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Decrement,
|
623
|
+
Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChange,
|
624
|
+
Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiry,
|
625
|
+
Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Void,
|
626
|
+
Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiated,
|
627
|
+
Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Amendment
|
628
|
+
)
|
629
|
+
]
|
596
630
|
)
|
597
|
-
.returns(
|
598
|
-
Orb::Internal::Page[
|
599
|
-
T.any(
|
600
|
-
Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Increment,
|
601
|
-
Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Decrement,
|
602
|
-
Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChange,
|
603
|
-
Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiry,
|
604
|
-
Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Void,
|
605
|
-
Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiated,
|
606
|
-
Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Amendment
|
607
|
-
)
|
608
|
-
]
|
609
|
-
)
|
610
631
|
end
|
611
632
|
def list_by_external_id(
|
612
633
|
external_customer_id,
|
@@ -625,10 +646,13 @@ module Orb
|
|
625
646
|
limit: nil,
|
626
647
|
minimum_amount: nil,
|
627
648
|
request_options: {}
|
628
|
-
)
|
649
|
+
)
|
650
|
+
end
|
651
|
+
|
629
652
|
# @api private
|
630
653
|
sig { params(client: Orb::Client).returns(T.attached_class) }
|
631
|
-
def self.new(client:)
|
654
|
+
def self.new(client:)
|
655
|
+
end
|
632
656
|
end
|
633
657
|
end
|
634
658
|
end
|
@@ -17,15 +17,18 @@ module Orb
|
|
17
17
|
customer_id: String,
|
18
18
|
amount: String,
|
19
19
|
currency: String,
|
20
|
-
invoice_settings:
|
20
|
+
invoice_settings:
|
21
|
+
Orb::Customers::Credits::TopUpCreateParams::InvoiceSettings::OrHash,
|
21
22
|
per_unit_cost_basis: String,
|
22
23
|
threshold: String,
|
23
24
|
active_from: T.nilable(Time),
|
24
25
|
expires_after: T.nilable(Integer),
|
25
|
-
expires_after_unit:
|
26
|
-
|
27
|
-
|
28
|
-
|
26
|
+
expires_after_unit:
|
27
|
+
T.nilable(
|
28
|
+
Orb::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit::OrSymbol
|
29
|
+
),
|
30
|
+
request_options: Orb::RequestOptions::OrHash
|
31
|
+
).returns(Orb::Models::Customers::Credits::TopUpCreateResponse)
|
29
32
|
end
|
30
33
|
def create(
|
31
34
|
customer_id,
|
@@ -50,16 +53,21 @@ module Orb
|
|
50
53
|
# The unit of expires_after.
|
51
54
|
expires_after_unit: nil,
|
52
55
|
request_options: {}
|
53
|
-
)
|
56
|
+
)
|
57
|
+
end
|
58
|
+
|
54
59
|
# List top-ups
|
55
60
|
sig do
|
56
61
|
params(
|
57
62
|
customer_id: String,
|
58
63
|
cursor: T.nilable(String),
|
59
64
|
limit: Integer,
|
60
|
-
request_options: Orb::
|
65
|
+
request_options: Orb::RequestOptions::OrHash
|
66
|
+
).returns(
|
67
|
+
Orb::Internal::Page[
|
68
|
+
Orb::Models::Customers::Credits::TopUpListResponse
|
69
|
+
]
|
61
70
|
)
|
62
|
-
.returns(Orb::Internal::Page[Orb::Models::Customers::Credits::TopUpListResponse])
|
63
71
|
end
|
64
72
|
def list(
|
65
73
|
customer_id,
|
@@ -69,11 +77,20 @@ module Orb
|
|
69
77
|
# The number of items to fetch. Defaults to 20.
|
70
78
|
limit: nil,
|
71
79
|
request_options: {}
|
72
|
-
)
|
80
|
+
)
|
81
|
+
end
|
82
|
+
|
73
83
|
# This deactivates the top-up and voids any invoices associated with pending
|
74
84
|
# credit blocks purchased through the top-up.
|
75
|
-
sig
|
76
|
-
|
85
|
+
sig do
|
86
|
+
params(
|
87
|
+
top_up_id: String,
|
88
|
+
customer_id: String,
|
89
|
+
request_options: Orb::RequestOptions::OrHash
|
90
|
+
).void
|
91
|
+
end
|
92
|
+
def delete(top_up_id, customer_id:, request_options: {})
|
93
|
+
end
|
77
94
|
|
78
95
|
# This endpoint allows you to create a new top-up for a specified customer's
|
79
96
|
# balance. While this top-up is active, the customer's balance will added in
|
@@ -87,18 +104,20 @@ module Orb
|
|
87
104
|
external_customer_id: String,
|
88
105
|
amount: String,
|
89
106
|
currency: String,
|
90
|
-
invoice_settings:
|
91
|
-
Orb::
|
92
|
-
Orb::Internal::AnyHash
|
93
|
-
),
|
107
|
+
invoice_settings:
|
108
|
+
Orb::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings::OrHash,
|
94
109
|
per_unit_cost_basis: String,
|
95
110
|
threshold: String,
|
96
111
|
active_from: T.nilable(Time),
|
97
112
|
expires_after: T.nilable(Integer),
|
98
|
-
expires_after_unit:
|
99
|
-
|
113
|
+
expires_after_unit:
|
114
|
+
T.nilable(
|
115
|
+
Orb::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit::OrSymbol
|
116
|
+
),
|
117
|
+
request_options: Orb::RequestOptions::OrHash
|
118
|
+
).returns(
|
119
|
+
Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse
|
100
120
|
)
|
101
|
-
.returns(Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse)
|
102
121
|
end
|
103
122
|
def create_by_external_id(
|
104
123
|
external_customer_id,
|
@@ -123,13 +142,24 @@ module Orb
|
|
123
142
|
# The unit of expires_after.
|
124
143
|
expires_after_unit: nil,
|
125
144
|
request_options: {}
|
126
|
-
)
|
145
|
+
)
|
146
|
+
end
|
147
|
+
|
127
148
|
# This deactivates the top-up and voids any invoices associated with pending
|
128
149
|
# credit blocks purchased through the top-up.
|
129
150
|
sig do
|
130
|
-
params(
|
151
|
+
params(
|
152
|
+
top_up_id: String,
|
153
|
+
external_customer_id: String,
|
154
|
+
request_options: Orb::RequestOptions::OrHash
|
155
|
+
).void
|
156
|
+
end
|
157
|
+
def delete_by_external_id(
|
158
|
+
top_up_id,
|
159
|
+
external_customer_id:,
|
160
|
+
request_options: {}
|
161
|
+
)
|
131
162
|
end
|
132
|
-
def delete_by_external_id(top_up_id, external_customer_id:, request_options: {}); end
|
133
163
|
|
134
164
|
# List top-ups by external ID
|
135
165
|
sig do
|
@@ -137,9 +167,12 @@ module Orb
|
|
137
167
|
external_customer_id: String,
|
138
168
|
cursor: T.nilable(String),
|
139
169
|
limit: Integer,
|
140
|
-
request_options: Orb::
|
170
|
+
request_options: Orb::RequestOptions::OrHash
|
171
|
+
).returns(
|
172
|
+
Orb::Internal::Page[
|
173
|
+
Orb::Models::Customers::Credits::TopUpListByExternalIDResponse
|
174
|
+
]
|
141
175
|
)
|
142
|
-
.returns(Orb::Internal::Page[Orb::Models::Customers::Credits::TopUpListByExternalIDResponse])
|
143
176
|
end
|
144
177
|
def list_by_external_id(
|
145
178
|
external_customer_id,
|
@@ -149,10 +182,13 @@ module Orb
|
|
149
182
|
# The number of items to fetch. Defaults to 20.
|
150
183
|
limit: nil,
|
151
184
|
request_options: {}
|
152
|
-
)
|
185
|
+
)
|
186
|
+
end
|
187
|
+
|
153
188
|
# @api private
|
154
189
|
sig { params(client: Orb::Client).returns(T.attached_class) }
|
155
|
-
def self.new(client:)
|
190
|
+
def self.new(client:)
|
191
|
+
end
|
156
192
|
end
|
157
193
|
end
|
158
194
|
end
|
@@ -24,9 +24,10 @@ module Orb
|
|
24
24
|
cursor: T.nilable(String),
|
25
25
|
include_all_blocks: T::Boolean,
|
26
26
|
limit: Integer,
|
27
|
-
request_options: Orb::
|
27
|
+
request_options: Orb::RequestOptions::OrHash
|
28
|
+
).returns(
|
29
|
+
Orb::Internal::Page[Orb::Models::Customers::CreditListResponse]
|
28
30
|
)
|
29
|
-
.returns(Orb::Internal::Page[Orb::Models::Customers::CreditListResponse])
|
30
31
|
end
|
31
32
|
def list(
|
32
33
|
customer_id,
|
@@ -41,7 +42,9 @@ module Orb
|
|
41
42
|
# The number of items to fetch. Defaults to 20.
|
42
43
|
limit: nil,
|
43
44
|
request_options: {}
|
44
|
-
)
|
45
|
+
)
|
46
|
+
end
|
47
|
+
|
45
48
|
# Returns a paginated list of unexpired, non-zero credit blocks for a customer.
|
46
49
|
#
|
47
50
|
# If `include_all_blocks` is set to `true`, all credit blocks (including expired
|
@@ -56,9 +59,12 @@ module Orb
|
|
56
59
|
cursor: T.nilable(String),
|
57
60
|
include_all_blocks: T::Boolean,
|
58
61
|
limit: Integer,
|
59
|
-
request_options: Orb::
|
62
|
+
request_options: Orb::RequestOptions::OrHash
|
63
|
+
).returns(
|
64
|
+
Orb::Internal::Page[
|
65
|
+
Orb::Models::Customers::CreditListByExternalIDResponse
|
66
|
+
]
|
60
67
|
)
|
61
|
-
.returns(Orb::Internal::Page[Orb::Models::Customers::CreditListByExternalIDResponse])
|
62
68
|
end
|
63
69
|
def list_by_external_id(
|
64
70
|
external_customer_id,
|
@@ -73,10 +79,13 @@ module Orb
|
|
73
79
|
# The number of items to fetch. Defaults to 20.
|
74
80
|
limit: nil,
|
75
81
|
request_options: {}
|
76
|
-
)
|
82
|
+
)
|
83
|
+
end
|
84
|
+
|
77
85
|
# @api private
|
78
86
|
sig { params(client: Orb::Client).returns(T.attached_class) }
|
79
|
-
def self.new(client:)
|
87
|
+
def self.new(client:)
|
88
|
+
end
|
80
89
|
end
|
81
90
|
end
|
82
91
|
end
|