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
@@ -25,8 +25,8 @@ module Orb
|
|
25
25
|
# @!attribute invoice_settings
|
26
26
|
# Settings for invoices generated by triggered top-ups.
|
27
27
|
#
|
28
|
-
# @return [Orb::
|
29
|
-
required :invoice_settings, -> { Orb::
|
28
|
+
# @return [Orb::Customers::Credits::TopUpCreateParams::InvoiceSettings]
|
29
|
+
required :invoice_settings, -> { Orb::Customers::Credits::TopUpCreateParams::InvoiceSettings }
|
30
30
|
|
31
31
|
# @!attribute per_unit_cost_basis
|
32
32
|
# How much, in the customer's currency, to charge for each unit.
|
@@ -58,9 +58,9 @@ module Orb
|
|
58
58
|
# @!attribute expires_after_unit
|
59
59
|
# The unit of expires_after.
|
60
60
|
#
|
61
|
-
# @return [Symbol, Orb::
|
61
|
+
# @return [Symbol, Orb::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit, nil]
|
62
62
|
optional :expires_after_unit,
|
63
|
-
enum: -> { Orb::
|
63
|
+
enum: -> { Orb::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit },
|
64
64
|
nil?: true
|
65
65
|
|
66
66
|
# @!method initialize(amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, active_from: nil, expires_after: nil, expires_after_unit: nil, request_options: {})
|
@@ -70,22 +70,18 @@ module Orb
|
|
70
70
|
# @param amount [String] The amount to increment when the threshold is reached.
|
71
71
|
#
|
72
72
|
# @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo
|
73
|
-
# ...
|
74
73
|
#
|
75
|
-
# @param invoice_settings [Orb::
|
74
|
+
# @param invoice_settings [Orb::Customers::Credits::TopUpCreateParams::InvoiceSettings] Settings for invoices generated by triggered top-ups.
|
76
75
|
#
|
77
76
|
# @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit.
|
78
77
|
#
|
79
78
|
# @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this
|
80
|
-
# ...
|
81
79
|
#
|
82
80
|
# @param active_from [Time, nil] The date from which the top-up is active. If unspecified, the top-up is active i
|
83
|
-
# ...
|
84
81
|
#
|
85
82
|
# @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it
|
86
|
-
# ...
|
87
83
|
#
|
88
|
-
# @param expires_after_unit [Symbol, Orb::
|
84
|
+
# @param expires_after_unit [Symbol, Orb::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit, nil] The unit of expires_after.
|
89
85
|
#
|
90
86
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
91
87
|
|
@@ -120,21 +116,17 @@ module Orb
|
|
120
116
|
|
121
117
|
# @!method initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil)
|
122
118
|
# Some parameter documentations has been truncated, see
|
123
|
-
# {Orb::
|
124
|
-
# details.
|
119
|
+
# {Orb::Customers::Credits::TopUpCreateParams::InvoiceSettings} for more details.
|
125
120
|
#
|
126
121
|
# Settings for invoices generated by triggered top-ups.
|
127
122
|
#
|
128
123
|
# @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav
|
129
|
-
# ...
|
130
124
|
#
|
131
125
|
# @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d
|
132
|
-
# ...
|
133
126
|
#
|
134
127
|
# @param memo [String, nil] An optional memo to display on the invoice.
|
135
128
|
#
|
136
129
|
# @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo
|
137
|
-
# ...
|
138
130
|
end
|
139
131
|
|
140
132
|
# The unit of expires_after.
|
@@ -67,17 +67,14 @@ module Orb
|
|
67
67
|
# @param amount [String] The amount to increment when the threshold is reached.
|
68
68
|
#
|
69
69
|
# @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo
|
70
|
-
# ...
|
71
70
|
#
|
72
71
|
# @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateResponse::InvoiceSettings] Settings for invoices generated by triggered top-ups.
|
73
72
|
#
|
74
73
|
# @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit.
|
75
74
|
#
|
76
75
|
# @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this
|
77
|
-
# ...
|
78
76
|
#
|
79
77
|
# @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it
|
80
|
-
# ...
|
81
78
|
#
|
82
79
|
# @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateResponse::ExpiresAfterUnit, nil] The unit of expires_after.
|
83
80
|
|
@@ -119,15 +116,12 @@ module Orb
|
|
119
116
|
# Settings for invoices generated by triggered top-ups.
|
120
117
|
#
|
121
118
|
# @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav
|
122
|
-
# ...
|
123
119
|
#
|
124
120
|
# @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d
|
125
|
-
# ...
|
126
121
|
#
|
127
122
|
# @param memo [String, nil] An optional memo to display on the invoice.
|
128
123
|
#
|
129
124
|
# @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo
|
130
|
-
# ...
|
131
125
|
end
|
132
126
|
|
133
127
|
# The unit of expires_after.
|
@@ -27,7 +27,6 @@ module Orb
|
|
27
27
|
# {Orb::Models::Customers::Credits::TopUpListByExternalIDParams} for more details.
|
28
28
|
#
|
29
29
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
30
|
-
# ...
|
31
30
|
#
|
32
31
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
33
32
|
#
|
@@ -69,17 +69,14 @@ module Orb
|
|
69
69
|
# @param amount [String] The amount to increment when the threshold is reached.
|
70
70
|
#
|
71
71
|
# @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo
|
72
|
-
# ...
|
73
72
|
#
|
74
73
|
# @param invoice_settings [Orb::Models::Customers::Credits::TopUpListByExternalIDResponse::InvoiceSettings] Settings for invoices generated by triggered top-ups.
|
75
74
|
#
|
76
75
|
# @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit.
|
77
76
|
#
|
78
77
|
# @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this
|
79
|
-
# ...
|
80
78
|
#
|
81
79
|
# @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it
|
82
|
-
# ...
|
83
80
|
#
|
84
81
|
# @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpListByExternalIDResponse::ExpiresAfterUnit, nil] The unit of expires_after.
|
85
82
|
|
@@ -121,15 +118,12 @@ module Orb
|
|
121
118
|
# Settings for invoices generated by triggered top-ups.
|
122
119
|
#
|
123
120
|
# @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav
|
124
|
-
# ...
|
125
121
|
#
|
126
122
|
# @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d
|
127
|
-
# ...
|
128
123
|
#
|
129
124
|
# @param memo [String, nil] An optional memo to display on the invoice.
|
130
125
|
#
|
131
126
|
# @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo
|
132
|
-
# ...
|
133
127
|
end
|
134
128
|
|
135
129
|
# The unit of expires_after.
|
@@ -27,7 +27,6 @@ module Orb
|
|
27
27
|
# {Orb::Models::Customers::Credits::TopUpListParams} for more details.
|
28
28
|
#
|
29
29
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
30
|
-
# ...
|
31
30
|
#
|
32
31
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
33
32
|
#
|
@@ -67,17 +67,14 @@ module Orb
|
|
67
67
|
# @param amount [String] The amount to increment when the threshold is reached.
|
68
68
|
#
|
69
69
|
# @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo
|
70
|
-
# ...
|
71
70
|
#
|
72
71
|
# @param invoice_settings [Orb::Models::Customers::Credits::TopUpListResponse::InvoiceSettings] Settings for invoices generated by triggered top-ups.
|
73
72
|
#
|
74
73
|
# @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit.
|
75
74
|
#
|
76
75
|
# @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this
|
77
|
-
# ...
|
78
76
|
#
|
79
77
|
# @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it
|
80
|
-
# ...
|
81
78
|
#
|
82
79
|
# @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpListResponse::ExpiresAfterUnit, nil] The unit of expires_after.
|
83
80
|
|
@@ -119,15 +116,12 @@ module Orb
|
|
119
116
|
# Settings for invoices generated by triggered top-ups.
|
120
117
|
#
|
121
118
|
# @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav
|
122
|
-
# ...
|
123
119
|
#
|
124
120
|
# @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d
|
125
|
-
# ...
|
126
121
|
#
|
127
122
|
# @param memo [String, nil] An optional memo to display on the invoice.
|
128
123
|
#
|
129
124
|
# @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo
|
130
|
-
# ...
|
131
125
|
end
|
132
126
|
|
133
127
|
# The unit of expires_after.
|
@@ -46,7 +46,7 @@ module Orb
|
|
46
46
|
|
47
47
|
# @!method initialize(id:, billable_metric_id:, dimensions:, external_dimensional_price_group_id:, metadata:, name:)
|
48
48
|
# Some parameter documentations has been truncated, see
|
49
|
-
# {Orb::
|
49
|
+
# {Orb::DimensionalPriceGroup} for more details.
|
50
50
|
#
|
51
51
|
# A dimensional price group is used to partition the result of a billable metric
|
52
52
|
# by a set of dimensions. Prices in a price group must specify the parition used
|
@@ -55,14 +55,12 @@ module Orb
|
|
55
55
|
# @param id [String]
|
56
56
|
#
|
57
57
|
# @param billable_metric_id [String] The billable metric associated with this dimensional price group. All prices ass
|
58
|
-
# ...
|
59
58
|
#
|
60
59
|
# @param dimensions [Array<String>] The dimensions that this dimensional price group is defined over
|
61
60
|
#
|
62
61
|
# @param external_dimensional_price_group_id [String, nil] An alias for the dimensional price group
|
63
62
|
#
|
64
63
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
65
|
-
# ...
|
66
64
|
#
|
67
65
|
# @param name [String] The name of the dimensional price group
|
68
66
|
end
|
@@ -49,7 +49,6 @@ module Orb
|
|
49
49
|
# @param external_dimensional_price_group_id [String, nil]
|
50
50
|
#
|
51
51
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
52
|
-
# ...
|
53
52
|
#
|
54
53
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
55
54
|
end
|
@@ -25,7 +25,6 @@ module Orb
|
|
25
25
|
# {Orb::Models::DimensionalPriceGroupListParams} for more details.
|
26
26
|
#
|
27
27
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
28
|
-
# ...
|
29
28
|
#
|
30
29
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
31
30
|
#
|
@@ -5,17 +5,17 @@ module Orb
|
|
5
5
|
class DimensionalPriceGroupsAPI < Orb::Internal::Type::BaseModel
|
6
6
|
# @!attribute data
|
7
7
|
#
|
8
|
-
# @return [Array<Orb::
|
9
|
-
required :data, -> { Orb::Internal::Type::ArrayOf[Orb::
|
8
|
+
# @return [Array<Orb::DimensionalPriceGroup>]
|
9
|
+
required :data, -> { Orb::Internal::Type::ArrayOf[Orb::DimensionalPriceGroup] }
|
10
10
|
|
11
11
|
# @!attribute pagination_metadata
|
12
12
|
#
|
13
|
-
# @return [Orb::
|
14
|
-
required :pagination_metadata, -> { Orb::
|
13
|
+
# @return [Orb::PaginationMetadata]
|
14
|
+
required :pagination_metadata, -> { Orb::PaginationMetadata }
|
15
15
|
|
16
16
|
# @!method initialize(data:, pagination_metadata:)
|
17
|
-
# @param data [Array<Orb::
|
18
|
-
# @param pagination_metadata [Orb::
|
17
|
+
# @param data [Array<Orb::DimensionalPriceGroup>]
|
18
|
+
# @param pagination_metadata [Orb::PaginationMetadata]
|
19
19
|
end
|
20
20
|
end
|
21
21
|
end
|
data/lib/orb/models/discount.rb
CHANGED
@@ -7,16 +7,16 @@ module Orb
|
|
7
7
|
|
8
8
|
discriminator :discount_type
|
9
9
|
|
10
|
-
variant :percentage, -> { Orb::
|
10
|
+
variant :percentage, -> { Orb::PercentageDiscount }
|
11
11
|
|
12
|
-
variant :trial, -> { Orb::
|
12
|
+
variant :trial, -> { Orb::TrialDiscount }
|
13
13
|
|
14
|
-
variant :usage, -> { Orb::
|
14
|
+
variant :usage, -> { Orb::UsageDiscount }
|
15
15
|
|
16
|
-
variant :amount, -> { Orb::
|
16
|
+
variant :amount, -> { Orb::AmountDiscount }
|
17
17
|
|
18
18
|
# @!method self.variants
|
19
|
-
# @return [Array(Orb::
|
19
|
+
# @return [Array(Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount)]
|
20
20
|
end
|
21
21
|
end
|
22
22
|
end
|
@@ -14,7 +14,7 @@ module Orb
|
|
14
14
|
#
|
15
15
|
# @return [Array<String, Float, Boolean>]
|
16
16
|
required :grouping_values,
|
17
|
-
-> { Orb::Internal::Type::ArrayOf[union: Orb::
|
17
|
+
-> { Orb::Internal::Type::ArrayOf[union: Orb::EvaluatePriceGroup::GroupingValue] }
|
18
18
|
|
19
19
|
# @!attribute quantity
|
20
20
|
# The price's usage quantity for the group
|
@@ -9,8 +9,8 @@ module Orb
|
|
9
9
|
|
10
10
|
# @!attribute events
|
11
11
|
#
|
12
|
-
# @return [Array<Orb::
|
13
|
-
required :events, -> { Orb::Internal::Type::ArrayOf[Orb::
|
12
|
+
# @return [Array<Orb::EventIngestParams::Event>]
|
13
|
+
required :events, -> { Orb::Internal::Type::ArrayOf[Orb::EventIngestParams::Event] }
|
14
14
|
|
15
15
|
# @!attribute backfill_id
|
16
16
|
# If this ingestion request is part of a backfill, this parameter ties the
|
@@ -29,10 +29,9 @@ module Orb
|
|
29
29
|
# Some parameter documentations has been truncated, see
|
30
30
|
# {Orb::Models::EventIngestParams} for more details.
|
31
31
|
#
|
32
|
-
# @param events [Array<Orb::
|
32
|
+
# @param events [Array<Orb::EventIngestParams::Event>]
|
33
33
|
#
|
34
34
|
# @param backfill_id [String, nil] If this ingestion request is part of a backfill, this parameter ties the ingeste
|
35
|
-
# ...
|
36
35
|
#
|
37
36
|
# @param debug [Boolean] Flag to enable additional debug information in the endpoint response
|
38
37
|
#
|
@@ -83,23 +82,19 @@ module Orb
|
|
83
82
|
|
84
83
|
# @!method initialize(event_name:, idempotency_key:, properties:, timestamp:, customer_id: nil, external_customer_id: nil)
|
85
84
|
# Some parameter documentations has been truncated, see
|
86
|
-
# {Orb::
|
85
|
+
# {Orb::EventIngestParams::Event} for more details.
|
87
86
|
#
|
88
87
|
# @param event_name [String] A name to meaningfully identify the action or event type.
|
89
88
|
#
|
90
89
|
# @param idempotency_key [String] A unique value, generated by the client, that is used to de-duplicate events. Ex
|
91
|
-
# ...
|
92
90
|
#
|
93
91
|
# @param properties [Object] A dictionary of custom properties. Values in this dictionary must be numeric, bo
|
94
|
-
# ...
|
95
92
|
#
|
96
93
|
# @param timestamp [Time] An ISO 8601 format date with no timezone offset (i.e. UTC). This should represen
|
97
|
-
# ...
|
98
94
|
#
|
99
95
|
# @param customer_id [String, nil] The Orb Customer identifier
|
100
96
|
#
|
101
97
|
# @param external_customer_id [String, nil] An alias for the Orb customer, whose mapping is specified when creating the cust
|
102
|
-
# ...
|
103
98
|
end
|
104
99
|
end
|
105
100
|
end
|
@@ -24,10 +24,8 @@ module Orb
|
|
24
24
|
# {Orb::Models::EventIngestResponse} for more details.
|
25
25
|
#
|
26
26
|
# @param validation_failed [Array<Orb::Models::EventIngestResponse::ValidationFailed>] Contains all failing validation events. In the case of a 200, this array will al
|
27
|
-
# ...
|
28
27
|
#
|
29
28
|
# @param debug [Orb::Models::EventIngestResponse::Debug, nil] Optional debug information (only present when debug=true is passed to the endpoi
|
30
|
-
# ...
|
31
29
|
|
32
30
|
class ValidationFailed < Orb::Internal::Type::BaseModel
|
33
31
|
# @!attribute idempotency_key
|
@@ -50,7 +48,6 @@ module Orb
|
|
50
48
|
# @param idempotency_key [String] The passed idempotency_key corresponding to the validation_errors
|
51
49
|
#
|
52
50
|
# @param validation_errors [Array<String>] An array of strings corresponding to validation failures for this idempotency_ke
|
53
|
-
# ...
|
54
51
|
end
|
55
52
|
|
56
53
|
# @see Orb::Models::EventIngestResponse#debug
|
@@ -35,13 +35,10 @@ module Orb
|
|
35
35
|
# {Orb::Models::EventSearchParams} for more details.
|
36
36
|
#
|
37
37
|
# @param event_ids [Array<String>] This is an explicit array of IDs to filter by. Note that an event's ID is the id
|
38
|
-
# ...
|
39
38
|
#
|
40
39
|
# @param timeframe_end [Time, nil] The end of the timeframe, exclusive, in which to search events. If not specified
|
41
|
-
# ...
|
42
40
|
#
|
43
41
|
# @param timeframe_start [Time, nil] The start of the timeframe, inclusive, in which to search events. If not specifi
|
44
|
-
# ...
|
45
42
|
#
|
46
43
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
47
44
|
end
|
@@ -70,7 +70,6 @@ module Orb
|
|
70
70
|
# model, and are used to calculate the usage charges for a given billing period.
|
71
71
|
#
|
72
72
|
# @param id [String] A unique value, generated by the client, that is used to de-duplicate events. Ex
|
73
|
-
# ...
|
74
73
|
#
|
75
74
|
# @param customer_id [String, nil] The Orb Customer identifier
|
76
75
|
#
|
@@ -79,13 +78,10 @@ module Orb
|
|
79
78
|
# @param event_name [String] A name to meaningfully identify the action or event type.
|
80
79
|
#
|
81
80
|
# @param external_customer_id [String, nil] An alias for the Orb customer, whose mapping is specified when creating the cust
|
82
|
-
# ...
|
83
81
|
#
|
84
82
|
# @param properties [Object] A dictionary of custom properties. Values in this dictionary must be numeric, bo
|
85
|
-
# ...
|
86
83
|
#
|
87
84
|
# @param timestamp [Time] An ISO 8601 format date with no timezone offset (i.e. UTC). This should represen
|
88
|
-
# ...
|
89
85
|
end
|
90
86
|
end
|
91
87
|
end
|
@@ -48,15 +48,12 @@ module Orb
|
|
48
48
|
# @param event_name [String] A name to meaningfully identify the action or event type.
|
49
49
|
#
|
50
50
|
# @param properties [Object] A dictionary of custom properties. Values in this dictionary must be numeric, bo
|
51
|
-
# ...
|
52
51
|
#
|
53
52
|
# @param timestamp [Time] An ISO 8601 format date with no timezone offset (i.e. UTC). This should represen
|
54
|
-
# ...
|
55
53
|
#
|
56
54
|
# @param customer_id [String, nil] The Orb Customer identifier
|
57
55
|
#
|
58
56
|
# @param external_customer_id [String, nil] An alias for the Orb customer, whose mapping is specified when creating the cust
|
59
|
-
# ...
|
60
57
|
#
|
61
58
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
62
59
|
end
|
@@ -83,17 +83,14 @@ module Orb
|
|
83
83
|
# @param id [String]
|
84
84
|
#
|
85
85
|
# @param close_time [Time, nil] If in the future, the time at which the backfill will automatically close. If in
|
86
|
-
# ...
|
87
86
|
#
|
88
87
|
# @param created_at [Time]
|
89
88
|
#
|
90
89
|
# @param customer_id [String, nil] The Orb-generated ID of the customer to which this backfill is scoped. If `null`
|
91
|
-
# ...
|
92
90
|
#
|
93
91
|
# @param events_ingested [Integer] The number of events ingested in this backfill.
|
94
92
|
#
|
95
93
|
# @param replace_existing_events [Boolean] If `true`, existing events in the backfill's timeframe will be replaced with the
|
96
|
-
# ...
|
97
94
|
#
|
98
95
|
# @param reverted_at [Time, nil] The time at which this backfill was reverted.
|
99
96
|
#
|
@@ -104,7 +101,6 @@ module Orb
|
|
104
101
|
# @param timeframe_start [Time]
|
105
102
|
#
|
106
103
|
# @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
|
107
|
-
# ...
|
108
104
|
|
109
105
|
# The status of the backfill.
|
110
106
|
#
|
@@ -66,25 +66,18 @@ module Orb
|
|
66
66
|
# {Orb::Models::Events::BackfillCreateParams} for more details.
|
67
67
|
#
|
68
68
|
# @param timeframe_end [Time] The (exclusive) end of the usage timeframe affected by this backfill. By default
|
69
|
-
# ...
|
70
69
|
#
|
71
70
|
# @param timeframe_start [Time] The (inclusive) start of the usage timeframe affected by this backfill. By defau
|
72
|
-
# ...
|
73
71
|
#
|
74
72
|
# @param close_time [Time, nil] The time at which no more events will be accepted for this backfill. The backfil
|
75
|
-
# ...
|
76
73
|
#
|
77
74
|
# @param customer_id [String, nil] The Orb-generated ID of the customer to which this backfill is scoped. Omitting
|
78
|
-
# ...
|
79
75
|
#
|
80
76
|
# @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
|
81
|
-
# ...
|
82
77
|
#
|
83
78
|
# @param external_customer_id [String, nil] The external customer ID of the customer to which this backfill is scoped. Omitt
|
84
|
-
# ...
|
85
79
|
#
|
86
80
|
# @param replace_existing_events [Boolean] If true, replaces all existing events in the timeframe with the newly ingested e
|
87
|
-
# ...
|
88
81
|
#
|
89
82
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
90
83
|
end
|
@@ -83,17 +83,14 @@ module Orb
|
|
83
83
|
# @param id [String]
|
84
84
|
#
|
85
85
|
# @param close_time [Time, nil] If in the future, the time at which the backfill will automatically close. If in
|
86
|
-
# ...
|
87
86
|
#
|
88
87
|
# @param created_at [Time]
|
89
88
|
#
|
90
89
|
# @param customer_id [String, nil] The Orb-generated ID of the customer to which this backfill is scoped. If `null`
|
91
|
-
# ...
|
92
90
|
#
|
93
91
|
# @param events_ingested [Integer] The number of events ingested in this backfill.
|
94
92
|
#
|
95
93
|
# @param replace_existing_events [Boolean] If `true`, existing events in the backfill's timeframe will be replaced with the
|
96
|
-
# ...
|
97
94
|
#
|
98
95
|
# @param reverted_at [Time, nil] The time at which this backfill was reverted.
|
99
96
|
#
|
@@ -104,7 +101,6 @@ module Orb
|
|
104
101
|
# @param timeframe_start [Time]
|
105
102
|
#
|
106
103
|
# @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
|
107
|
-
# ...
|
108
104
|
|
109
105
|
# The status of the backfill.
|
110
106
|
#
|
@@ -83,17 +83,14 @@ module Orb
|
|
83
83
|
# @param id [String]
|
84
84
|
#
|
85
85
|
# @param close_time [Time, nil] If in the future, the time at which the backfill will automatically close. If in
|
86
|
-
# ...
|
87
86
|
#
|
88
87
|
# @param created_at [Time]
|
89
88
|
#
|
90
89
|
# @param customer_id [String, nil] The Orb-generated ID of the customer to which this backfill is scoped. If `null`
|
91
|
-
# ...
|
92
90
|
#
|
93
91
|
# @param events_ingested [Integer] The number of events ingested in this backfill.
|
94
92
|
#
|
95
93
|
# @param replace_existing_events [Boolean] If `true`, existing events in the backfill's timeframe will be replaced with the
|
96
|
-
# ...
|
97
94
|
#
|
98
95
|
# @param reverted_at [Time, nil] The time at which this backfill was reverted.
|
99
96
|
#
|
@@ -104,7 +101,6 @@ module Orb
|
|
104
101
|
# @param timeframe_start [Time]
|
105
102
|
#
|
106
103
|
# @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
|
107
|
-
# ...
|
108
104
|
|
109
105
|
# The status of the backfill.
|
110
106
|
#
|
@@ -26,7 +26,6 @@ module Orb
|
|
26
26
|
# {Orb::Models::Events::BackfillListParams} for more details.
|
27
27
|
#
|
28
28
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
29
|
-
# ...
|
30
29
|
#
|
31
30
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
32
31
|
#
|
@@ -83,17 +83,14 @@ module Orb
|
|
83
83
|
# @param id [String]
|
84
84
|
#
|
85
85
|
# @param close_time [Time, nil] If in the future, the time at which the backfill will automatically close. If in
|
86
|
-
# ...
|
87
86
|
#
|
88
87
|
# @param created_at [Time]
|
89
88
|
#
|
90
89
|
# @param customer_id [String, nil] The Orb-generated ID of the customer to which this backfill is scoped. If `null`
|
91
|
-
# ...
|
92
90
|
#
|
93
91
|
# @param events_ingested [Integer] The number of events ingested in this backfill.
|
94
92
|
#
|
95
93
|
# @param replace_existing_events [Boolean] If `true`, existing events in the backfill's timeframe will be replaced with the
|
96
|
-
# ...
|
97
94
|
#
|
98
95
|
# @param reverted_at [Time, nil] The time at which this backfill was reverted.
|
99
96
|
#
|
@@ -104,7 +101,6 @@ module Orb
|
|
104
101
|
# @param timeframe_start [Time]
|
105
102
|
#
|
106
103
|
# @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
|
107
|
-
# ...
|
108
104
|
|
109
105
|
# The status of the backfill.
|
110
106
|
#
|
@@ -83,17 +83,14 @@ module Orb
|
|
83
83
|
# @param id [String]
|
84
84
|
#
|
85
85
|
# @param close_time [Time, nil] If in the future, the time at which the backfill will automatically close. If in
|
86
|
-
# ...
|
87
86
|
#
|
88
87
|
# @param created_at [Time]
|
89
88
|
#
|
90
89
|
# @param customer_id [String, nil] The Orb-generated ID of the customer to which this backfill is scoped. If `null`
|
91
|
-
# ...
|
92
90
|
#
|
93
91
|
# @param events_ingested [Integer] The number of events ingested in this backfill.
|
94
92
|
#
|
95
93
|
# @param replace_existing_events [Boolean] If `true`, existing events in the backfill's timeframe will be replaced with the
|
96
|
-
# ...
|
97
94
|
#
|
98
95
|
# @param reverted_at [Time, nil] The time at which this backfill was reverted.
|
99
96
|
#
|
@@ -104,7 +101,6 @@ module Orb
|
|
104
101
|
# @param timeframe_start [Time]
|
105
102
|
#
|
106
103
|
# @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
|
107
|
-
# ...
|
108
104
|
|
109
105
|
# The status of the backfill.
|
110
106
|
#
|
@@ -7,11 +7,11 @@ module Orb
|
|
7
7
|
class EventVolumes < Orb::Internal::Type::BaseModel
|
8
8
|
# @!attribute data
|
9
9
|
#
|
10
|
-
# @return [Array<Orb::
|
11
|
-
required :data, -> { Orb::Internal::Type::ArrayOf[Orb::
|
10
|
+
# @return [Array<Orb::Events::EventVolumes::Data>]
|
11
|
+
required :data, -> { Orb::Internal::Type::ArrayOf[Orb::Events::EventVolumes::Data] }
|
12
12
|
|
13
13
|
# @!method initialize(data:)
|
14
|
-
# @param data [Array<Orb::
|
14
|
+
# @param data [Array<Orb::Events::EventVolumes::Data>]
|
15
15
|
|
16
16
|
class Data < Orb::Internal::Type::BaseModel
|
17
17
|
# @!attribute count
|
@@ -44,15 +44,12 @@ module Orb
|
|
44
44
|
# {Orb::Models::Events::VolumeListParams} for more details.
|
45
45
|
#
|
46
46
|
# @param timeframe_start [Time] The start of the timeframe, inclusive, in which to return event volume. All date
|
47
|
-
# ...
|
48
47
|
#
|
49
48
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
50
|
-
# ...
|
51
49
|
#
|
52
50
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
53
51
|
#
|
54
52
|
# @param timeframe_end [Time] The end of the timeframe, exclusive, in which to return event volume. If not spe
|
55
|
-
# ...
|
56
53
|
#
|
57
54
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
58
55
|
end
|