orb-billing 0.2.0 → 0.3.1
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 +67 -0
- data/README.md +63 -53
- data/lib/orb/client.rb +4 -4
- data/lib/orb/errors.rb +9 -9
- data/lib/orb/file_part.rb +55 -0
- data/lib/orb/internal/page.rb +7 -11
- data/lib/orb/internal/transport/base_client.rb +10 -10
- data/lib/orb/internal/transport/pooled_net_requester.rb +2 -2
- data/lib/orb/internal/type/array_of.rb +11 -0
- data/lib/orb/internal/type/base_model.rb +33 -23
- data/lib/orb/internal/type/base_page.rb +9 -1
- data/lib/orb/internal/type/boolean.rb +14 -11
- data/lib/orb/internal/type/converter.rb +4 -1
- data/lib/orb/internal/type/enum.rb +19 -16
- data/lib/orb/internal/type/{io_like.rb → file_input.rb} +33 -15
- data/lib/orb/internal/type/hash_of.rb +11 -0
- data/lib/orb/internal/type/request_parameters.rb +3 -10
- data/lib/orb/internal/type/union.rb +10 -1
- data/lib/orb/internal/type/unknown.rb +14 -11
- data/lib/orb/internal/util.rb +88 -64
- data/lib/orb/internal.rb +0 -1
- data/lib/orb/models/alert.rb +68 -71
- data/lib/orb/models/alert_create_for_customer_params.rb +20 -25
- data/lib/orb/models/alert_create_for_external_customer_params.rb +20 -25
- data/lib/orb/models/alert_create_for_subscription_params.rb +20 -25
- data/lib/orb/models/alert_disable_params.rb +5 -9
- data/lib/orb/models/alert_enable_params.rb +5 -9
- data/lib/orb/models/alert_list_params.rb +26 -36
- data/lib/orb/models/alert_retrieve_params.rb +3 -8
- data/lib/orb/models/alert_update_params.rb +14 -18
- data/lib/orb/models/amount_discount.rb +14 -14
- data/lib/orb/models/billable_metric.rb +23 -20
- data/lib/orb/models/billing_cycle_relative_date.rb +2 -5
- data/lib/orb/models/coupon.rb +28 -21
- data/lib/orb/models/coupon_archive_params.rb +3 -8
- data/lib/orb/models/coupon_create_params.rb +29 -34
- data/lib/orb/models/coupon_fetch_params.rb +3 -8
- data/lib/orb/models/coupon_list_params.rb +17 -17
- data/lib/orb/models/coupons/subscription_list_params.rb +12 -15
- data/lib/orb/models/credit_note.rb +100 -166
- data/lib/orb/models/credit_note_create_params.rb +15 -23
- data/lib/orb/models/credit_note_fetch_params.rb +3 -8
- data/lib/orb/models/credit_note_list_params.rb +20 -30
- data/lib/orb/models/customer.rb +224 -271
- data/lib/orb/models/customer_create_params.rb +216 -257
- data/lib/orb/models/customer_delete_params.rb +3 -8
- data/lib/orb/models/customer_fetch_by_external_id_params.rb +3 -8
- data/lib/orb/models/customer_fetch_params.rb +3 -8
- data/lib/orb/models/customer_list_params.rb +20 -30
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +3 -8
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +3 -8
- data/lib/orb/models/customer_update_by_external_id_params.rb +212 -257
- data/lib/orb/models/customer_update_params.rb +212 -255
- data/lib/orb/models/customers/balance_transaction_create_params.rb +11 -16
- data/lib/orb/models/customers/balance_transaction_create_response.rb +33 -51
- data/lib/orb/models/customers/balance_transaction_list_params.rb +20 -30
- data/lib/orb/models/customers/balance_transaction_list_response.rb +33 -51
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +23 -27
- data/lib/orb/models/customers/cost_list_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_response.rb +23 -27
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +18 -22
- data/lib/orb/models/customers/credit_list_by_external_id_response.rb +10 -17
- data/lib/orb/models/customers/credit_list_params.rb +18 -22
- data/lib/orb/models/customers/credit_list_response.rb +10 -17
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +64 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +384 -491
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +63 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +384 -498
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +33 -48
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +384 -494
- data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
- data/lib/orb/models/customers/credits/ledger_list_response.rb +383 -501
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +47 -50
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +43 -46
- data/lib/orb/models/customers/credits/top_up_create_params.rb +46 -50
- data/lib/orb/models/customers/credits/top_up_create_response.rb +42 -46
- data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +4 -9
- data/lib/orb/models/customers/credits/top_up_delete_params.rb +4 -9
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +12 -15
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +43 -46
- data/lib/orb/models/customers/credits/top_up_list_params.rb +12 -15
- data/lib/orb/models/customers/credits/top_up_list_response.rb +42 -46
- data/lib/orb/models/dimensional_price_group.rb +21 -15
- data/lib/orb/models/dimensional_price_group_create_params.rb +17 -23
- data/lib/orb/models/dimensional_price_group_list_params.rb +12 -15
- data/lib/orb/models/dimensional_price_group_retrieve_params.rb +3 -8
- data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +3 -8
- data/lib/orb/models/dimensional_price_groups.rb +3 -7
- data/lib/orb/models/discount.rb +2 -3
- data/lib/orb/models/evaluate_price_group.rb +8 -11
- data/lib/orb/models/event_deprecate_params.rb +3 -8
- data/lib/orb/models/event_deprecate_response.rb +2 -6
- data/lib/orb/models/event_ingest_params.rb +33 -27
- data/lib/orb/models/event_ingest_response.rb +23 -24
- data/lib/orb/models/event_search_params.rb +15 -11
- data/lib/orb/models/event_search_response.rb +27 -22
- data/lib/orb/models/event_update_params.rb +19 -13
- data/lib/orb/models/event_update_response.rb +2 -6
- data/lib/orb/models/events/backfill_close_params.rb +3 -8
- data/lib/orb/models/events/backfill_close_response.rb +34 -39
- data/lib/orb/models/events/backfill_create_params.rb +28 -32
- data/lib/orb/models/events/backfill_create_response.rb +34 -39
- data/lib/orb/models/events/backfill_fetch_params.rb +3 -8
- data/lib/orb/models/events/backfill_fetch_response.rb +34 -39
- data/lib/orb/models/events/backfill_list_params.rb +12 -15
- data/lib/orb/models/events/backfill_list_response.rb +34 -39
- data/lib/orb/models/events/backfill_revert_params.rb +3 -8
- data/lib/orb/models/events/backfill_revert_response.rb +34 -39
- data/lib/orb/models/events/event_volumes.rb +11 -17
- data/lib/orb/models/events/volume_list_params.rb +19 -22
- data/lib/orb/models/invoice.rb +619 -681
- data/lib/orb/models/invoice_create_params.rb +52 -61
- data/lib/orb/models/invoice_fetch_params.rb +3 -8
- data/lib/orb/models/invoice_fetch_upcoming_params.rb +4 -9
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +618 -669
- data/lib/orb/models/invoice_issue_params.rb +10 -14
- data/lib/orb/models/invoice_level_discount.rb +2 -3
- data/lib/orb/models/invoice_line_item_create_params.rb +19 -14
- data/lib/orb/models/invoice_line_item_create_response.rb +281 -306
- data/lib/orb/models/invoice_list_params.rb +51 -66
- data/lib/orb/models/invoice_mark_paid_params.rb +9 -11
- data/lib/orb/models/invoice_pay_params.rb +3 -8
- data/lib/orb/models/invoice_update_params.rb +9 -9
- data/lib/orb/models/invoice_void_params.rb +3 -8
- data/lib/orb/models/item.rb +14 -25
- data/lib/orb/models/item_create_params.rb +5 -9
- data/lib/orb/models/item_fetch_params.rb +3 -8
- data/lib/orb/models/item_list_params.rb +12 -15
- data/lib/orb/models/item_update_params.rb +10 -22
- data/lib/orb/models/metric_create_params.rb +17 -13
- data/lib/orb/models/metric_fetch_params.rb +3 -8
- data/lib/orb/models/metric_list_params.rb +20 -30
- data/lib/orb/models/metric_update_params.rb +9 -9
- data/lib/orb/models/pagination_metadata.rb +3 -7
- data/lib/orb/models/percentage_discount.rb +15 -14
- data/lib/orb/models/plan.rb +259 -291
- data/lib/orb/models/plan_create_params.rb +2070 -2466
- data/lib/orb/models/plan_fetch_params.rb +3 -8
- data/lib/orb/models/plan_list_params.rb +25 -42
- data/lib/orb/models/plan_update_params.rb +12 -10
- data/lib/orb/models/plans/external_plan_id_fetch_params.rb +3 -8
- data/lib/orb/models/plans/external_plan_id_update_params.rb +12 -10
- data/lib/orb/models/price.rb +3842 -5005
- data/lib/orb/models/price_create_params.rb +203 -244
- data/lib/orb/models/price_evaluate_params.rb +21 -30
- data/lib/orb/models/price_evaluate_response.rb +2 -6
- data/lib/orb/models/price_fetch_params.rb +3 -8
- data/lib/orb/models/price_list_params.rb +12 -15
- data/lib/orb/models/price_update_params.rb +9 -9
- data/lib/orb/models/prices/external_price_id_fetch_params.rb +3 -8
- data/lib/orb/models/prices/external_price_id_update_params.rb +9 -9
- data/lib/orb/models/subscription.rb +360 -405
- data/lib/orb/models/subscription_cancel_params.rb +16 -16
- data/lib/orb/models/subscription_cancel_response.rb +358 -399
- data/lib/orb/models/subscription_change_apply_params.rb +7 -10
- data/lib/orb/models/subscription_change_apply_response.rb +384 -418
- data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
- data/lib/orb/models/subscription_change_cancel_response.rb +384 -417
- data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
- data/lib/orb/models/subscription_change_retrieve_response.rb +385 -417
- data/lib/orb/models/subscription_create_params.rb +4735 -5417
- data/lib/orb/models/subscription_create_response.rb +358 -399
- data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
- data/lib/orb/models/subscription_fetch_costs_response.rb +23 -27
- data/lib/orb/models/subscription_fetch_params.rb +3 -8
- data/lib/orb/models/subscription_fetch_schedule_params.rb +20 -30
- data/lib/orb/models/subscription_fetch_schedule_response.rb +15 -17
- data/lib/orb/models/subscription_fetch_usage_params.rb +32 -43
- data/lib/orb/models/subscription_list_params.rb +28 -41
- data/lib/orb/models/subscription_price_intervals_params.rb +2560 -3040
- data/lib/orb/models/subscription_price_intervals_response.rb +361 -399
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +4728 -5411
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +361 -398
- data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
- data/lib/orb/models/subscription_trigger_phase_response.rb +360 -399
- data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +361 -398
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +5 -9
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +362 -396
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +362 -396
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +22 -33
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +361 -398
- data/lib/orb/models/subscription_update_params.rb +21 -23
- data/lib/orb/models/subscription_update_trial_params.rb +15 -18
- data/lib/orb/models/subscription_update_trial_response.rb +360 -399
- data/lib/orb/models/subscription_usage.rb +37 -80
- data/lib/orb/models/subscriptions.rb +3 -7
- data/lib/orb/models/top_level_ping_params.rb +3 -8
- data/lib/orb/models/top_level_ping_response.rb +2 -6
- data/lib/orb/models/trial_discount.rb +16 -24
- data/lib/orb/models/usage_discount.rb +15 -14
- data/lib/orb/models.rb +220 -0
- data/lib/orb/request_options.rb +4 -6
- data/lib/orb/resources/alerts.rb +48 -17
- data/lib/orb/resources/coupons/subscriptions.rb +9 -2
- data/lib/orb/resources/coupons.rb +26 -8
- data/lib/orb/resources/credit_notes.rb +17 -4
- data/lib/orb/resources/customers/balance_transactions.rb +18 -3
- data/lib/orb/resources/customers/costs.rb +26 -8
- data/lib/orb/resources/customers/credits/ledger.rb +112 -32
- data/lib/orb/resources/customers/credits/top_ups.rb +67 -20
- data/lib/orb/resources/customers/credits.rb +28 -8
- data/lib/orb/resources/customers.rb +138 -39
- data/lib/orb/resources/dimensional_price_groups.rb +19 -4
- data/lib/orb/resources/events/backfills.rb +32 -9
- data/lib/orb/resources/events/volume.rb +14 -4
- data/lib/orb/resources/events.rb +40 -11
- data/lib/orb/resources/invoice_line_items.rb +16 -6
- data/lib/orb/resources/invoices.rb +77 -17
- data/lib/orb/resources/items.rb +10 -3
- data/lib/orb/resources/metrics.rb +33 -8
- data/lib/orb/resources/plans/external_plan_id.rb +10 -2
- data/lib/orb/resources/plans.rb +47 -11
- data/lib/orb/resources/prices/external_price_id.rb +9 -3
- data/lib/orb/resources/prices.rb +101 -26
- data/lib/orb/resources/subscription_changes.rb +5 -2
- data/lib/orb/resources/subscriptions.rb +292 -78
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +2 -10
- data/rbi/{lib/orb → orb}/client.rbi +4 -4
- data/rbi/{lib/orb → orb}/errors.rbi +1 -1
- data/rbi/orb/file_part.rbi +34 -0
- data/rbi/{lib/orb → orb}/internal/transport/base_client.rbi +19 -5
- data/rbi/{lib/orb → orb}/internal/type/array_of.rbi +3 -0
- data/rbi/{lib/orb → orb}/internal/type/base_model.rbi +7 -1
- data/rbi/{lib/orb → orb}/internal/type/base_page.rbi +2 -0
- data/rbi/{lib/orb → orb}/internal/type/enum.rbi +3 -6
- data/rbi/{lib/orb/internal/type/io_like.rbi → orb/internal/type/file_input.rbi} +5 -2
- data/rbi/{lib/orb → orb}/internal/type/hash_of.rbi +3 -0
- data/rbi/{lib/orb → orb}/internal/type/request_parameters.rbi +1 -1
- data/rbi/{lib/orb → orb}/internal/type/union.rbi +3 -0
- data/rbi/{lib/orb → orb}/internal/util.rbi +28 -19
- data/rbi/{lib/orb → orb}/internal.rbi +0 -1
- data/rbi/{lib/orb → orb}/models/alert.rbi +28 -8
- data/rbi/{lib/orb → orb}/models/alert_create_for_customer_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/alert_create_for_external_customer_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/alert_create_for_subscription_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/alert_disable_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/alert_enable_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/alert_list_params.rbi +6 -0
- data/rbi/{lib/orb → orb}/models/alert_update_params.rbi +11 -4
- data/rbi/{lib/orb → orb}/models/amount_discount.rbi +10 -4
- data/rbi/{lib/orb → orb}/models/billable_metric.rbi +16 -3
- data/rbi/{lib/orb → orb}/models/billing_cycle_relative_date.rbi +1 -1
- data/rbi/{lib/orb → orb}/models/coupon.rbi +10 -3
- data/rbi/{lib/orb → orb}/models/coupon_create_params.rbi +15 -12
- data/rbi/{lib/orb → orb}/models/coupon_list_params.rbi +13 -3
- data/rbi/{lib/orb → orb}/models/coupons/subscription_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/credit_note.rbi +44 -12
- data/rbi/{lib/orb → orb}/models/credit_note_create_params.rbi +15 -6
- data/rbi/{lib/orb → orb}/models/credit_note_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/customer.rbi +130 -11
- data/rbi/{lib/orb → orb}/models/customer_create_params.rbi +151 -17
- data/rbi/{lib/orb → orb}/models/customer_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/customer_update_by_external_id_params.rbi +149 -17
- data/rbi/{lib/orb → orb}/models/customer_update_params.rbi +149 -17
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_params.rbi +8 -4
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_response.rbi +18 -8
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_response.rbi +18 -8
- data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_params.rbi +9 -5
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +225 -0
- data/rbi/{lib/orb → orb}/models/customers/cost_list_params.rbi +9 -5
- data/rbi/orb/models/customers/cost_list_response.rbi +223 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_params.rbi +13 -3
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_response.rbi +1 -2
- data/rbi/{lib/orb → orb}/models/customers/credit_list_params.rbi +13 -3
- data/rbi/{lib/orb → orb}/models/customers/credit_list_response.rbi +1 -2
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_response.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi} +157 -170
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_params.rbi +40 -6
- data/rbi/{lib/orb/models/customers/credits/ledger_list_response.rbi → orb/models/customers/credits/ledger_create_entry_response.rbi} +149 -196
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_response.rbi +148 -229
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_params.rbi +6 -4
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi → orb/models/customers/credits/ledger_list_response.rbi} +149 -343
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_params.rbi +27 -4
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_response.rbi +25 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_response.rbi +25 -4
- data/rbi/{lib/orb → orb}/models/dimensional_price_group.rbi +11 -3
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_create_params.rbi +4 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/evaluate_price_group.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/event_deprecate_response.rbi +4 -2
- data/rbi/{lib/orb → orb}/models/event_ingest_params.rbi +22 -5
- data/rbi/{lib/orb → orb}/models/event_ingest_response.rbi +15 -4
- data/rbi/{lib/orb → orb}/models/event_search_params.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/event_search_response.rbi +14 -3
- data/rbi/{lib/orb → orb}/models/event_update_params.rbi +10 -3
- data/rbi/{lib/orb → orb}/models/event_update_response.rbi +4 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_close_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_create_params.rbi +18 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_create_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_fetch_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_list_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_revert_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/event_volumes.rbi +8 -4
- data/rbi/{lib/orb → orb}/models/events/volume_list_params.rbi +18 -2
- data/rbi/{lib/orb → orb}/models/invoice.rbi +513 -202
- data/rbi/{lib/orb → orb}/models/invoice_create_params.rbi +38 -6
- data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_response.rbi +513 -216
- data/rbi/{lib/orb → orb}/models/invoice_issue_params.rbi +9 -2
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_params.rbi +16 -2
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_response.rbi +279 -182
- data/rbi/{lib/orb → orb}/models/invoice_list_params.rbi +9 -2
- data/rbi/{lib/orb → orb}/models/invoice_mark_paid_params.rbi +9 -2
- data/rbi/{lib/orb → orb}/models/invoice_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/item.rbi +1 -2
- data/rbi/{lib/orb → orb}/models/item_create_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/item_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/item_update_params.rbi +1 -8
- data/rbi/{lib/orb → orb}/models/metric_create_params.rbi +15 -2
- data/rbi/{lib/orb → orb}/models/metric_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/metric_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/percentage_discount.rbi +11 -4
- data/rbi/{lib/orb → orb}/models/plan.rbi +207 -120
- data/rbi/{lib/orb → orb}/models/plan_create_params.rbi +1971 -2414
- data/rbi/{lib/orb → orb}/models/plan_list_params.rbi +5 -1
- data/rbi/{lib/orb → orb}/models/plan_update_params.rbi +11 -2
- data/rbi/{lib/orb → orb}/models/plans/external_plan_id_update_params.rbi +11 -2
- data/rbi/{lib/orb → orb}/models/price.rbi +2594 -2957
- data/rbi/{lib/orb → orb}/models/price_create_params.rbi +137 -53
- data/rbi/{lib/orb → orb}/models/price_evaluate_params.rbi +10 -0
- data/rbi/{lib/orb → orb}/models/price_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/price_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/prices/external_price_id_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/subscription.rbi +292 -129
- data/rbi/{lib/orb → orb}/models/subscription_cancel_params.rbi +8 -5
- data/rbi/{lib/orb → orb}/models/subscription_cancel_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_response.rbi +317 -136
- data/rbi/{lib/orb → orb}/models/subscription_change_cancel_response.rbi +317 -136
- data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_response.rbi +317 -136
- data/rbi/{lib/orb → orb}/models/subscription_create_params.rbi +4271 -4270
- data/rbi/{lib/orb → orb}/models/subscription_create_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_params.rbi +9 -5
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +221 -0
- data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_response.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/subscription_fetch_usage_params.rbi +13 -4
- data/rbi/{lib/orb → orb}/models/subscription_list_params.rbi +4 -2
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_params.rbi +2354 -2317
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_params.rbi +4280 -3758
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_params.rbi +10 -2
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +305 -138
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_update_params.rbi +15 -0
- data/rbi/{lib/orb → orb}/models/subscription_update_trial_params.rbi +11 -5
- data/rbi/{lib/orb → orb}/models/subscription_update_trial_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_usage.rbi +2 -16
- data/rbi/{lib/orb → orb}/models/trial_discount.rbi +5 -1
- data/rbi/{lib/orb → orb}/models/usage_discount.rbi +11 -3
- data/rbi/orb/models.rbi +220 -0
- data/rbi/{lib/orb → orb}/request_options.rbi +2 -0
- data/rbi/{lib/orb → orb}/resources/alerts.rbi +8 -14
- data/rbi/{lib/orb → orb}/resources/coupons/subscriptions.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/coupons.rbi +6 -18
- data/rbi/{lib/orb → orb}/resources/credit_notes.rbi +3 -9
- data/rbi/{lib/orb → orb}/resources/customers/balance_transactions.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers/costs.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers/credits/ledger.rbi +32 -32
- data/rbi/{lib/orb → orb}/resources/customers/credits/top_ups.rbi +6 -18
- data/rbi/{lib/orb → orb}/resources/customers/credits.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers.rbi +15 -45
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +1 -4
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups.rbi +3 -10
- data/rbi/{lib/orb → orb}/resources/events/backfills.rbi +5 -18
- data/rbi/{lib/orb → orb}/resources/events/volume.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/events.rbi +4 -10
- data/rbi/{lib/orb → orb}/resources/invoice_line_items.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/invoices.rbi +9 -34
- data/rbi/{lib/orb → orb}/resources/items.rbi +4 -17
- data/rbi/{lib/orb → orb}/resources/metrics.rbi +4 -10
- data/rbi/{lib/orb → orb}/resources/plans/external_plan_id.rbi +2 -8
- data/rbi/{lib/orb → orb}/resources/plans.rbi +29 -35
- data/rbi/orb/resources/prices/external_price_id.rbi +103 -0
- data/rbi/{lib/orb → orb}/resources/prices.rbi +117 -124
- data/rbi/{lib/orb → orb}/resources/subscription_changes.rbi +3 -9
- data/rbi/{lib/orb → orb}/resources/subscriptions.rbi +16 -32
- data/rbi/{lib/orb → orb}/resources/top_level.rbi +1 -4
- data/sig/orb/file_part.rbs +21 -0
- data/sig/orb/internal/transport/base_client.rbs +9 -3
- data/sig/orb/internal/type/array_of.rbs +2 -0
- data/sig/orb/internal/type/base_model.rbs +4 -0
- data/sig/orb/internal/type/enum.rbs +2 -2
- data/sig/orb/internal/type/{io_like.rbs → file_input.rbs} +1 -1
- data/sig/orb/internal/type/hash_of.rbs +2 -0
- data/sig/orb/internal/type/union.rbs +2 -0
- data/sig/orb/internal/util.rbs +16 -12
- data/sig/orb/models/coupon_create_params.rbs +9 -10
- data/sig/orb/models/customer_create_params.rbs +9 -10
- data/sig/orb/models/customer_update_by_external_id_params.rbs +9 -10
- data/sig/orb/models/customer_update_params.rbs +9 -10
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +113 -113
- data/sig/orb/models/invoice.rbs +54 -54
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +54 -54
- data/sig/orb/models/invoice_line_item_create_response.rbs +54 -54
- data/sig/orb/models/plan.rbs +21 -21
- data/sig/orb/models/plan_create_params.rbs +653 -653
- data/sig/orb/models/price.rbs +1517 -1521
- data/sig/orb/models/subscription.rbs +34 -34
- data/sig/orb/models/subscription_cancel_response.rbs +34 -34
- data/sig/orb/models/subscription_change_apply_response.rbs +34 -34
- data/sig/orb/models/subscription_change_cancel_response.rbs +34 -34
- data/sig/orb/models/subscription_change_retrieve_response.rbs +34 -34
- data/sig/orb/models/subscription_create_params.rbs +1348 -1348
- data/sig/orb/models/subscription_create_response.rbs +34 -34
- data/sig/orb/models/subscription_price_intervals_params.rbs +767 -769
- data/sig/orb/models/subscription_price_intervals_response.rbs +34 -34
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1348 -1348
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +34 -34
- data/sig/orb/models/subscription_trigger_phase_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +34 -34
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +34 -34
- data/sig/orb/models/subscription_update_trial_response.rbs +34 -34
- data/sig/orb/models.rbs +215 -0
- metadata +230 -224
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +0 -208
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +0 -206
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +0 -204
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +0 -106
- /data/rbi/{lib/orb → orb}/internal/page.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/transport/pooled_net_requester.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/type/boolean.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/type/converter.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/type/unknown.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/alert_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/coupon_archive_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/coupon_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/credit_note_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_delete_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_fetch_by_external_id_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_by_external_id_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/dimensional_price_group_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/dimensional_price_groups.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/event_deprecate_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/events/backfill_close_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/events/backfill_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/events/backfill_revert_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_level_discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_pay_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_void_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/metric_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/pagination_metadata.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plan_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plans/external_plan_id_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_evaluate_response.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/prices/external_price_id_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_change_cancel_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscriptions.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/top_level_ping_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/top_level_ping_response.rbi +0 -0
- /data/rbi/{lib/orb → orb}/version.rbi +0 -0
@@ -5,6 +5,9 @@ module Orb
|
|
5
5
|
class Customers
|
6
6
|
class Credits
|
7
7
|
class TopUps
|
8
|
+
# Some parameter documentations has been truncated, see
|
9
|
+
# {Orb::Models::Customers::Credits::TopUpCreateParams} for more details.
|
10
|
+
#
|
8
11
|
# This endpoint allows you to create a new top-up for a specified customer's
|
9
12
|
# balance. While this top-up is active, the customer's balance will added in
|
10
13
|
# increments of the specified amount whenever the balance reaches the specified
|
@@ -16,14 +19,27 @@ module Orb
|
|
16
19
|
# @overload create(customer_id, amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, active_from: nil, expires_after: nil, expires_after_unit: nil, request_options: {})
|
17
20
|
#
|
18
21
|
# @param customer_id [String]
|
19
|
-
#
|
20
|
-
# @param
|
21
|
-
#
|
22
|
-
# @param
|
23
|
-
#
|
24
|
-
#
|
25
|
-
# @param
|
26
|
-
#
|
22
|
+
#
|
23
|
+
# @param amount [String] The amount to increment when the threshold is reached.
|
24
|
+
#
|
25
|
+
# @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo
|
26
|
+
# ...
|
27
|
+
#
|
28
|
+
# @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateParams::InvoiceSettings] Settings for invoices generated by triggered top-ups.
|
29
|
+
#
|
30
|
+
# @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit.
|
31
|
+
#
|
32
|
+
# @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this
|
33
|
+
# ...
|
34
|
+
#
|
35
|
+
# @param active_from [Time, nil] The date from which the top-up is active. If unspecified, the top-up is active i
|
36
|
+
# ...
|
37
|
+
#
|
38
|
+
# @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it
|
39
|
+
# ...
|
40
|
+
#
|
41
|
+
# @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit, nil] The unit of expires_after.
|
42
|
+
#
|
27
43
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
28
44
|
#
|
29
45
|
# @return [Orb::Models::Customers::Credits::TopUpCreateResponse]
|
@@ -40,13 +56,20 @@ module Orb
|
|
40
56
|
)
|
41
57
|
end
|
42
58
|
|
59
|
+
# Some parameter documentations has been truncated, see
|
60
|
+
# {Orb::Models::Customers::Credits::TopUpListParams} for more details.
|
61
|
+
#
|
43
62
|
# List top-ups
|
44
63
|
#
|
45
64
|
# @overload list(customer_id, cursor: nil, limit: nil, request_options: {})
|
46
65
|
#
|
47
66
|
# @param customer_id [String]
|
48
|
-
#
|
49
|
-
# @param
|
67
|
+
#
|
68
|
+
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
69
|
+
# ...
|
70
|
+
#
|
71
|
+
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
72
|
+
#
|
50
73
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
51
74
|
#
|
52
75
|
# @return [Orb::Internal::Page<Orb::Models::Customers::Credits::TopUpListResponse>]
|
@@ -90,6 +113,10 @@ module Orb
|
|
90
113
|
)
|
91
114
|
end
|
92
115
|
|
116
|
+
# Some parameter documentations has been truncated, see
|
117
|
+
# {Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams} for more
|
118
|
+
# details.
|
119
|
+
#
|
93
120
|
# This endpoint allows you to create a new top-up for a specified customer's
|
94
121
|
# balance. While this top-up is active, the customer's balance will added in
|
95
122
|
# increments of the specified amount whenever the balance reaches the specified
|
@@ -101,14 +128,27 @@ module Orb
|
|
101
128
|
# @overload create_by_external_id(external_customer_id, amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, active_from: nil, expires_after: nil, expires_after_unit: nil, request_options: {})
|
102
129
|
#
|
103
130
|
# @param external_customer_id [String]
|
104
|
-
#
|
105
|
-
# @param
|
106
|
-
#
|
107
|
-
# @param
|
108
|
-
#
|
109
|
-
#
|
110
|
-
# @param
|
111
|
-
#
|
131
|
+
#
|
132
|
+
# @param amount [String] The amount to increment when the threshold is reached.
|
133
|
+
#
|
134
|
+
# @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo
|
135
|
+
# ...
|
136
|
+
#
|
137
|
+
# @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings] Settings for invoices generated by triggered top-ups.
|
138
|
+
#
|
139
|
+
# @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit.
|
140
|
+
#
|
141
|
+
# @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this
|
142
|
+
# ...
|
143
|
+
#
|
144
|
+
# @param active_from [Time, nil] The date from which the top-up is active. If unspecified, the top-up is active i
|
145
|
+
# ...
|
146
|
+
#
|
147
|
+
# @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it
|
148
|
+
# ...
|
149
|
+
#
|
150
|
+
# @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit, nil] The unit of expires_after.
|
151
|
+
#
|
112
152
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
113
153
|
#
|
114
154
|
# @return [Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse]
|
@@ -155,13 +195,20 @@ module Orb
|
|
155
195
|
)
|
156
196
|
end
|
157
197
|
|
198
|
+
# Some parameter documentations has been truncated, see
|
199
|
+
# {Orb::Models::Customers::Credits::TopUpListByExternalIDParams} for more details.
|
200
|
+
#
|
158
201
|
# List top-ups by external ID
|
159
202
|
#
|
160
203
|
# @overload list_by_external_id(external_customer_id, cursor: nil, limit: nil, request_options: {})
|
161
204
|
#
|
162
205
|
# @param external_customer_id [String]
|
163
|
-
#
|
164
|
-
# @param
|
206
|
+
#
|
207
|
+
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
208
|
+
# ...
|
209
|
+
#
|
210
|
+
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
211
|
+
#
|
165
212
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
166
213
|
#
|
167
214
|
# @return [Orb::Internal::Page<Orb::Models::Customers::Credits::TopUpListByExternalIDResponse>]
|
@@ -10,6 +10,9 @@ module Orb
|
|
10
10
|
# @return [Orb::Resources::Customers::Credits::TopUps]
|
11
11
|
attr_reader :top_ups
|
12
12
|
|
13
|
+
# Some parameter documentations has been truncated, see
|
14
|
+
# {Orb::Models::Customers::CreditListParams} for more details.
|
15
|
+
#
|
13
16
|
# Returns a paginated list of unexpired, non-zero credit blocks for a customer.
|
14
17
|
#
|
15
18
|
# If `include_all_blocks` is set to `true`, all credit blocks (including expired
|
@@ -21,10 +24,17 @@ module Orb
|
|
21
24
|
# @overload list(customer_id, currency: nil, cursor: nil, include_all_blocks: nil, limit: nil, request_options: {})
|
22
25
|
#
|
23
26
|
# @param customer_id [String]
|
24
|
-
#
|
25
|
-
# @param
|
26
|
-
#
|
27
|
-
# @param
|
27
|
+
#
|
28
|
+
# @param currency [String, nil] The ledger currency or custom pricing unit to use.
|
29
|
+
#
|
30
|
+
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
31
|
+
# ...
|
32
|
+
#
|
33
|
+
# @param include_all_blocks [Boolean] If set to True, all expired and depleted blocks, as well as active block will be
|
34
|
+
# ...
|
35
|
+
#
|
36
|
+
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
37
|
+
#
|
28
38
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
29
39
|
#
|
30
40
|
# @return [Orb::Internal::Page<Orb::Models::Customers::CreditListResponse>]
|
@@ -42,6 +52,9 @@ module Orb
|
|
42
52
|
)
|
43
53
|
end
|
44
54
|
|
55
|
+
# Some parameter documentations has been truncated, see
|
56
|
+
# {Orb::Models::Customers::CreditListByExternalIDParams} for more details.
|
57
|
+
#
|
45
58
|
# Returns a paginated list of unexpired, non-zero credit blocks for a customer.
|
46
59
|
#
|
47
60
|
# If `include_all_blocks` is set to `true`, all credit blocks (including expired
|
@@ -53,10 +66,17 @@ module Orb
|
|
53
66
|
# @overload list_by_external_id(external_customer_id, currency: nil, cursor: nil, include_all_blocks: nil, limit: nil, request_options: {})
|
54
67
|
#
|
55
68
|
# @param external_customer_id [String]
|
56
|
-
#
|
57
|
-
# @param
|
58
|
-
#
|
59
|
-
# @param
|
69
|
+
#
|
70
|
+
# @param currency [String, nil] The ledger currency or custom pricing unit to use.
|
71
|
+
#
|
72
|
+
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
73
|
+
# ...
|
74
|
+
#
|
75
|
+
# @param include_all_blocks [Boolean] If set to True, all expired and depleted blocks, as well as active block will be
|
76
|
+
# ...
|
77
|
+
#
|
78
|
+
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
79
|
+
#
|
60
80
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
61
81
|
#
|
62
82
|
# @return [Orb::Internal::Page<Orb::Models::Customers::CreditListByExternalIDResponse>]
|
@@ -12,6 +12,9 @@ module Orb
|
|
12
12
|
# @return [Orb::Resources::Customers::BalanceTransactions]
|
13
13
|
attr_reader :balance_transactions
|
14
14
|
|
15
|
+
# Some parameter documentations has been truncated, see
|
16
|
+
# {Orb::Models::CustomerCreateParams} for more details.
|
17
|
+
#
|
15
18
|
# This operation is used to create an Orb customer, who is party to the core
|
16
19
|
# billing relationship. See [Customer](/core-concepts##customer) for an overview
|
17
20
|
# of the customer resource.
|
@@ -27,24 +30,52 @@ module Orb
|
|
27
30
|
#
|
28
31
|
# @overload create(email:, name:, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, timezone: nil, request_options: {})
|
29
32
|
#
|
30
|
-
# @param email [String]
|
31
|
-
#
|
33
|
+
# @param email [String] A valid customer email, to be used for notifications. When Orb triggers payment
|
34
|
+
# ...
|
35
|
+
#
|
36
|
+
# @param name [String] The full name of the customer
|
37
|
+
#
|
32
38
|
# @param accounting_sync_configuration [Orb::Models::CustomerCreateParams::AccountingSyncConfiguration, nil]
|
33
|
-
#
|
34
|
-
# @param
|
39
|
+
#
|
40
|
+
# @param additional_emails [Array<String>, nil] Additional email addresses for this customer. If populated, these email addresse
|
41
|
+
# ...
|
42
|
+
#
|
43
|
+
# @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch
|
44
|
+
# ...
|
45
|
+
#
|
35
46
|
# @param billing_address [Orb::Models::CustomerCreateParams::BillingAddress, nil]
|
36
|
-
#
|
47
|
+
#
|
48
|
+
# @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
|
49
|
+
# ...
|
50
|
+
#
|
37
51
|
# @param email_delivery [Boolean, nil]
|
38
|
-
#
|
39
|
-
# @param
|
40
|
-
#
|
41
|
-
#
|
42
|
-
# @param
|
52
|
+
#
|
53
|
+
# @param external_customer_id [String, nil] An optional user-defined ID for this customer resource, used throughout the syst
|
54
|
+
# ...
|
55
|
+
#
|
56
|
+
# @param hierarchy [Orb::Models::CustomerCreateParams::Hierarchy, nil] The hierarchical relationships for this customer.
|
57
|
+
#
|
58
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
59
|
+
# ...
|
60
|
+
#
|
61
|
+
# @param payment_provider [Symbol, Orb::Models::CustomerCreateParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
|
62
|
+
# ...
|
63
|
+
#
|
64
|
+
# @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
|
65
|
+
# ...
|
66
|
+
#
|
43
67
|
# @param reporting_configuration [Orb::Models::CustomerCreateParams::ReportingConfiguration, nil]
|
68
|
+
#
|
44
69
|
# @param shipping_address [Orb::Models::CustomerCreateParams::ShippingAddress, nil]
|
45
|
-
#
|
46
|
-
# @param
|
47
|
-
#
|
70
|
+
#
|
71
|
+
# @param tax_configuration [Orb::Models::CustomerCreateParams::TaxConfiguration::Avalara, Orb::Models::CustomerCreateParams::TaxConfiguration::Taxjar, nil]
|
72
|
+
#
|
73
|
+
# @param tax_id [Orb::Models::CustomerCreateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
|
74
|
+
# ...
|
75
|
+
#
|
76
|
+
# @param timezone [String, nil] A timezone identifier from the IANA timezone database, such as `"America/Los_Ang
|
77
|
+
# ...
|
78
|
+
#
|
48
79
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
49
80
|
#
|
50
81
|
# @return [Orb::Models::Customer]
|
@@ -61,6 +92,9 @@ module Orb
|
|
61
92
|
)
|
62
93
|
end
|
63
94
|
|
95
|
+
# Some parameter documentations has been truncated, see
|
96
|
+
# {Orb::Models::CustomerUpdateParams} for more details.
|
97
|
+
#
|
64
98
|
# This endpoint can be used to update the `payment_provider`,
|
65
99
|
# `payment_provider_id`, `name`, `email`, `email_delivery`, `tax_id`,
|
66
100
|
# `auto_collection`, `metadata`, `shipping_address`, `billing_address`, and
|
@@ -70,23 +104,49 @@ module Orb
|
|
70
104
|
# @overload update(customer_id, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {})
|
71
105
|
#
|
72
106
|
# @param customer_id [String]
|
107
|
+
#
|
73
108
|
# @param accounting_sync_configuration [Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration, nil]
|
74
|
-
#
|
75
|
-
# @param
|
109
|
+
#
|
110
|
+
# @param additional_emails [Array<String>, nil] Additional email addresses for this customer. If populated, these email addresse
|
111
|
+
# ...
|
112
|
+
#
|
113
|
+
# @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch
|
114
|
+
# ...
|
115
|
+
#
|
76
116
|
# @param billing_address [Orb::Models::CustomerUpdateParams::BillingAddress, nil]
|
77
|
-
#
|
78
|
-
# @param
|
117
|
+
#
|
118
|
+
# @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
|
119
|
+
# ...
|
120
|
+
#
|
121
|
+
# @param email [String, nil] A valid customer email, to be used for invoicing and notifications.
|
122
|
+
#
|
79
123
|
# @param email_delivery [Boolean, nil]
|
80
|
-
#
|
81
|
-
# @param
|
82
|
-
#
|
83
|
-
#
|
84
|
-
# @param
|
85
|
-
#
|
124
|
+
#
|
125
|
+
# @param external_customer_id [String, nil] The external customer ID. This can only be set if empty and the customer has no
|
126
|
+
# ...
|
127
|
+
#
|
128
|
+
# @param hierarchy [Orb::Models::CustomerUpdateParams::Hierarchy, nil] The hierarchical relationships for this customer.
|
129
|
+
#
|
130
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
131
|
+
# ...
|
132
|
+
#
|
133
|
+
# @param name [String, nil] The full name of the customer
|
134
|
+
#
|
135
|
+
# @param payment_provider [Symbol, Orb::Models::CustomerUpdateParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
|
136
|
+
# ...
|
137
|
+
#
|
138
|
+
# @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
|
139
|
+
# ...
|
140
|
+
#
|
86
141
|
# @param reporting_configuration [Orb::Models::CustomerUpdateParams::ReportingConfiguration, nil]
|
142
|
+
#
|
87
143
|
# @param shipping_address [Orb::Models::CustomerUpdateParams::ShippingAddress, nil]
|
88
|
-
#
|
89
|
-
# @param
|
144
|
+
#
|
145
|
+
# @param tax_configuration [Orb::Models::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateParams::TaxConfiguration::Taxjar, nil]
|
146
|
+
#
|
147
|
+
# @param tax_id [Orb::Models::CustomerUpdateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
|
148
|
+
# ...
|
149
|
+
#
|
90
150
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
91
151
|
#
|
92
152
|
# @return [Orb::Models::Customer]
|
@@ -103,6 +163,9 @@ module Orb
|
|
103
163
|
)
|
104
164
|
end
|
105
165
|
|
166
|
+
# Some parameter documentations has been truncated, see
|
167
|
+
# {Orb::Models::CustomerListParams} for more details.
|
168
|
+
#
|
106
169
|
# This endpoint returns a list of all customers for an account. The list of
|
107
170
|
# customers is ordered starting from the most recently created customer. This
|
108
171
|
# endpoint follows Orb's
|
@@ -113,11 +176,18 @@ module Orb
|
|
113
176
|
# @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, request_options: {})
|
114
177
|
#
|
115
178
|
# @param created_at_gt [Time, nil]
|
179
|
+
#
|
116
180
|
# @param created_at_gte [Time, nil]
|
181
|
+
#
|
117
182
|
# @param created_at_lt [Time, nil]
|
183
|
+
#
|
118
184
|
# @param created_at_lte [Time, nil]
|
119
|
-
#
|
120
|
-
# @param
|
185
|
+
#
|
186
|
+
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
187
|
+
# ...
|
188
|
+
#
|
189
|
+
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
190
|
+
#
|
121
191
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
122
192
|
#
|
123
193
|
# @return [Orb::Internal::Page<Orb::Models::Customer>]
|
@@ -271,6 +341,9 @@ module Orb
|
|
271
341
|
)
|
272
342
|
end
|
273
343
|
|
344
|
+
# Some parameter documentations has been truncated, see
|
345
|
+
# {Orb::Models::CustomerUpdateByExternalIDParams} for more details.
|
346
|
+
#
|
274
347
|
# This endpoint is used to update customer details given an `external_customer_id`
|
275
348
|
# (see [Customer ID Aliases](/events-and-metrics/customer-aliases)). Note that the
|
276
349
|
# resource and semantics of this endpoint exactly mirror
|
@@ -279,23 +352,49 @@ module Orb
|
|
279
352
|
# @overload update_by_external_id(id, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {})
|
280
353
|
#
|
281
354
|
# @param id [String]
|
355
|
+
#
|
282
356
|
# @param accounting_sync_configuration [Orb::Models::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration, nil]
|
283
|
-
#
|
284
|
-
# @param
|
357
|
+
#
|
358
|
+
# @param additional_emails [Array<String>, nil] Additional email addresses for this customer. If populated, these email addresse
|
359
|
+
# ...
|
360
|
+
#
|
361
|
+
# @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch
|
362
|
+
# ...
|
363
|
+
#
|
285
364
|
# @param billing_address [Orb::Models::CustomerUpdateByExternalIDParams::BillingAddress, nil]
|
286
|
-
#
|
287
|
-
# @param
|
365
|
+
#
|
366
|
+
# @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
|
367
|
+
# ...
|
368
|
+
#
|
369
|
+
# @param email [String, nil] A valid customer email, to be used for invoicing and notifications.
|
370
|
+
#
|
288
371
|
# @param email_delivery [Boolean, nil]
|
289
|
-
#
|
290
|
-
# @param
|
291
|
-
#
|
292
|
-
#
|
293
|
-
# @param
|
294
|
-
#
|
372
|
+
#
|
373
|
+
# @param external_customer_id [String, nil] The external customer ID. This can only be set if empty and the customer has no
|
374
|
+
# ...
|
375
|
+
#
|
376
|
+
# @param hierarchy [Orb::Models::CustomerUpdateByExternalIDParams::Hierarchy, nil] The hierarchical relationships for this customer.
|
377
|
+
#
|
378
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
379
|
+
# ...
|
380
|
+
#
|
381
|
+
# @param name [String, nil] The full name of the customer
|
382
|
+
#
|
383
|
+
# @param payment_provider [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
|
384
|
+
# ...
|
385
|
+
#
|
386
|
+
# @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
|
387
|
+
# ...
|
388
|
+
#
|
295
389
|
# @param reporting_configuration [Orb::Models::CustomerUpdateByExternalIDParams::ReportingConfiguration, nil]
|
390
|
+
#
|
296
391
|
# @param shipping_address [Orb::Models::CustomerUpdateByExternalIDParams::ShippingAddress, nil]
|
297
|
-
#
|
298
|
-
# @param
|
392
|
+
#
|
393
|
+
# @param tax_configuration [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar, nil]
|
394
|
+
#
|
395
|
+
# @param tax_id [Orb::Models::CustomerUpdateByExternalIDParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
|
396
|
+
# ...
|
397
|
+
#
|
299
398
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
300
399
|
#
|
301
400
|
# @return [Orb::Models::Customer]
|
@@ -6,6 +6,9 @@ module Orb
|
|
6
6
|
# @return [Orb::Resources::DimensionalPriceGroups::ExternalDimensionalPriceGroupID]
|
7
7
|
attr_reader :external_dimensional_price_group_id
|
8
8
|
|
9
|
+
# Some parameter documentations has been truncated, see
|
10
|
+
# {Orb::Models::DimensionalPriceGroupCreateParams} for more details.
|
11
|
+
#
|
9
12
|
# A dimensional price group is used to partition the result of a billable metric
|
10
13
|
# by a set of dimensions. Prices in a price group must specify the parition used
|
11
14
|
# to derive their usage.
|
@@ -18,10 +21,16 @@ module Orb
|
|
18
21
|
# @overload create(billable_metric_id:, dimensions:, name:, external_dimensional_price_group_id: nil, metadata: nil, request_options: {})
|
19
22
|
#
|
20
23
|
# @param billable_metric_id [String]
|
21
|
-
#
|
24
|
+
#
|
25
|
+
# @param dimensions [Array<String>] The set of keys (in order) used to disambiguate prices in the group.
|
26
|
+
#
|
22
27
|
# @param name [String]
|
28
|
+
#
|
23
29
|
# @param external_dimensional_price_group_id [String, nil]
|
24
|
-
#
|
30
|
+
#
|
31
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
32
|
+
# ...
|
33
|
+
#
|
25
34
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
26
35
|
#
|
27
36
|
# @return [Orb::Models::DimensionalPriceGroup]
|
@@ -57,12 +66,18 @@ module Orb
|
|
57
66
|
)
|
58
67
|
end
|
59
68
|
|
69
|
+
# Some parameter documentations has been truncated, see
|
70
|
+
# {Orb::Models::DimensionalPriceGroupListParams} for more details.
|
71
|
+
#
|
60
72
|
# List dimensional price groups
|
61
73
|
#
|
62
74
|
# @overload list(cursor: nil, limit: nil, request_options: {})
|
63
75
|
#
|
64
|
-
# @param cursor [String, nil]
|
65
|
-
#
|
76
|
+
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
77
|
+
# ...
|
78
|
+
#
|
79
|
+
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
80
|
+
#
|
66
81
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
67
82
|
#
|
68
83
|
# @return [Orb::Internal::Page<Orb::Models::DimensionalPriceGroup>]
|
@@ -4,6 +4,9 @@ module Orb
|
|
4
4
|
module Resources
|
5
5
|
class Events
|
6
6
|
class Backfills
|
7
|
+
# Some parameter documentations has been truncated, see
|
8
|
+
# {Orb::Models::Events::BackfillCreateParams} for more details.
|
9
|
+
#
|
7
10
|
# Creating the backfill enables adding or replacing past events, even those that
|
8
11
|
# are older than the ingestion grace period. Performing a backfill in Orb involves
|
9
12
|
# 3 steps:
|
@@ -44,13 +47,27 @@ module Orb
|
|
44
47
|
#
|
45
48
|
# @overload create(timeframe_end:, timeframe_start:, close_time: nil, customer_id: nil, deprecation_filter: nil, external_customer_id: nil, replace_existing_events: nil, request_options: {})
|
46
49
|
#
|
47
|
-
# @param timeframe_end [Time]
|
48
|
-
#
|
49
|
-
#
|
50
|
-
# @param
|
51
|
-
#
|
52
|
-
#
|
53
|
-
# @param
|
50
|
+
# @param timeframe_end [Time] The (exclusive) end of the usage timeframe affected by this backfill. By default
|
51
|
+
# ...
|
52
|
+
#
|
53
|
+
# @param timeframe_start [Time] The (inclusive) start of the usage timeframe affected by this backfill. By defau
|
54
|
+
# ...
|
55
|
+
#
|
56
|
+
# @param close_time [Time, nil] The time at which no more events will be accepted for this backfill. The backfil
|
57
|
+
# ...
|
58
|
+
#
|
59
|
+
# @param customer_id [String, nil] The Orb-generated ID of the customer to which this backfill is scoped. Omitting
|
60
|
+
# ...
|
61
|
+
#
|
62
|
+
# @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
|
63
|
+
# ...
|
64
|
+
#
|
65
|
+
# @param external_customer_id [String, nil] The external customer ID of the customer to which this backfill is scoped. Omitt
|
66
|
+
# ...
|
67
|
+
#
|
68
|
+
# @param replace_existing_events [Boolean] If true, replaces all existing events in the timeframe with the newly ingested e
|
69
|
+
# ...
|
70
|
+
#
|
54
71
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
55
72
|
#
|
56
73
|
# @return [Orb::Models::Events::BackfillCreateResponse]
|
@@ -67,6 +84,9 @@ module Orb
|
|
67
84
|
)
|
68
85
|
end
|
69
86
|
|
87
|
+
# Some parameter documentations has been truncated, see
|
88
|
+
# {Orb::Models::Events::BackfillListParams} for more details.
|
89
|
+
#
|
70
90
|
# This endpoint returns a list of all backfills in a list format.
|
71
91
|
#
|
72
92
|
# The list of backfills is ordered starting from the most recently created
|
@@ -77,8 +97,11 @@ module Orb
|
|
77
97
|
#
|
78
98
|
# @overload list(cursor: nil, limit: nil, request_options: {})
|
79
99
|
#
|
80
|
-
# @param cursor [String, nil]
|
81
|
-
#
|
100
|
+
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
101
|
+
# ...
|
102
|
+
#
|
103
|
+
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
104
|
+
#
|
82
105
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
83
106
|
#
|
84
107
|
# @return [Orb::Internal::Page<Orb::Models::Events::BackfillListResponse>]
|
@@ -4,6 +4,9 @@ module Orb
|
|
4
4
|
module Resources
|
5
5
|
class Events
|
6
6
|
class Volume
|
7
|
+
# Some parameter documentations has been truncated, see
|
8
|
+
# {Orb::Models::Events::VolumeListParams} for more details.
|
9
|
+
#
|
7
10
|
# This endpoint returns the event volume for an account in a
|
8
11
|
# [paginated list format](/api-reference/pagination).
|
9
12
|
#
|
@@ -20,10 +23,17 @@ module Orb
|
|
20
23
|
#
|
21
24
|
# @overload list(timeframe_start:, cursor: nil, limit: nil, timeframe_end: nil, request_options: {})
|
22
25
|
#
|
23
|
-
# @param timeframe_start [Time]
|
24
|
-
#
|
25
|
-
#
|
26
|
-
# @param
|
26
|
+
# @param timeframe_start [Time] The start of the timeframe, inclusive, in which to return event volume. All date
|
27
|
+
# ...
|
28
|
+
#
|
29
|
+
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
30
|
+
# ...
|
31
|
+
#
|
32
|
+
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
33
|
+
#
|
34
|
+
# @param timeframe_end [Time] The end of the timeframe, exclusive, in which to return event volume. If not spe
|
35
|
+
# ...
|
36
|
+
#
|
27
37
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
28
38
|
#
|
29
39
|
# @return [Orb::Models::Events::EventVolumes]
|