orb-billing 0.2.0 → 0.3.0
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 +34 -0
- data/README.md +59 -49
- data/lib/orb/client.rb +4 -4
- data/lib/orb/file_part.rb +55 -0
- data/lib/orb/internal/page.rb +4 -8
- data/lib/orb/internal/transport/base_client.rb +7 -7
- 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 +32 -14
- data/lib/orb/internal/type/base_page.rb +9 -1
- data/lib/orb/internal/type/boolean.rb +4 -0
- data/lib/orb/internal/type/converter.rb +4 -1
- data/lib/orb/internal/type/enum.rb +9 -5
- 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 +1 -2
- data/lib/orb/internal/type/union.rb +10 -1
- data/lib/orb/internal/type/unknown.rb +4 -0
- data/lib/orb/internal/util.rb +69 -61
- 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 +24 -29
- 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 +211 -252
- 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 +207 -250
- data/lib/orb/models/customer_update_params.rb +207 -250
- 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 +22 -26
- data/lib/orb/models/customers/cost_list_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_response.rb +22 -26
- 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 +300 -406
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +63 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +300 -406
- 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 +300 -406
- data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
- data/lib/orb/models/customers/credits/ledger_list_response.rb +300 -406
- 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 +589 -637
- 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 +584 -631
- 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 +247 -269
- 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 +250 -279
- data/lib/orb/models/plan_create_params.rb +1623 -1984
- 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 +2709 -3820
- 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 +343 -382
- data/lib/orb/models/subscription_cancel_params.rb +16 -16
- data/lib/orb/models/subscription_cancel_response.rb +339 -377
- data/lib/orb/models/subscription_change_apply_params.rb +7 -10
- data/lib/orb/models/subscription_change_apply_response.rb +365 -398
- data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
- data/lib/orb/models/subscription_change_cancel_response.rb +365 -398
- data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
- data/lib/orb/models/subscription_change_retrieve_response.rb +366 -398
- data/lib/orb/models/subscription_create_params.rb +3771 -4402
- data/lib/orb/models/subscription_create_response.rb +339 -377
- data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
- data/lib/orb/models/subscription_fetch_costs_response.rb +22 -26
- 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 +2018 -2472
- data/lib/orb/models/subscription_price_intervals_response.rb +342 -377
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +3764 -4392
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +342 -377
- data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
- data/lib/orb/models/subscription_trigger_phase_response.rb +341 -377
- data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +342 -377
- 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 +343 -377
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +343 -377
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +22 -33
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +342 -377
- 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 +341 -377
- 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/request_options.rb +3 -4
- data/lib/orb/resources/alerts.rb +48 -17
- data/lib/orb/resources/coupons/subscriptions.rb +9 -2
- data/lib/orb/resources/coupons.rb +25 -7
- 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 +108 -28
- 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 +135 -36
- 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 +7 -1
- data/lib/orb/resources/prices.rb +97 -22
- 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/client.rbi +4 -4
- data/rbi/lib/orb/file_part.rbi +34 -0
- data/rbi/lib/orb/internal/transport/base_client.rbi +17 -3
- data/rbi/lib/orb/internal/type/array_of.rbi +3 -0
- data/rbi/lib/orb/internal/type/base_model.rbi +7 -1
- data/rbi/lib/orb/internal/type/base_page.rbi +2 -0
- data/rbi/lib/orb/internal/type/enum.rbi +3 -6
- data/rbi/lib/orb/internal/type/{io_like.rbi → file_input.rbi} +5 -2
- data/rbi/lib/orb/internal/type/hash_of.rbi +3 -0
- data/rbi/lib/orb/internal/type/union.rbi +3 -0
- data/rbi/lib/orb/internal/util.rbi +24 -19
- data/rbi/lib/orb/internal.rbi +0 -1
- data/rbi/lib/orb/models/alert.rbi +28 -8
- data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_disable_params.rbi +5 -2
- data/rbi/lib/orb/models/alert_enable_params.rbi +5 -2
- data/rbi/lib/orb/models/alert_list_params.rbi +6 -0
- data/rbi/lib/orb/models/alert_update_params.rbi +11 -4
- data/rbi/lib/orb/models/amount_discount.rbi +10 -4
- data/rbi/lib/orb/models/billable_metric.rbi +16 -3
- data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -1
- data/rbi/lib/orb/models/coupon.rbi +10 -3
- data/rbi/lib/orb/models/coupon_create_params.rbi +6 -3
- data/rbi/lib/orb/models/coupon_list_params.rbi +13 -3
- data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +8 -2
- data/rbi/lib/orb/models/credit_note.rbi +44 -12
- data/rbi/lib/orb/models/credit_note_create_params.rbi +15 -6
- data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customer.rbi +130 -11
- data/rbi/lib/orb/models/customer_create_params.rbi +142 -8
- data/rbi/lib/orb/models/customer_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +140 -8
- data/rbi/lib/orb/models/customer_update_params.rbi +140 -8
- data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +8 -4
- data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +18 -8
- data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +18 -8
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +9 -5
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +21 -4
- data/rbi/lib/orb/models/customers/cost_list_params.rbi +9 -5
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +21 -4
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +13 -3
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +1 -2
- data/rbi/lib/orb/models/customers/credit_list_params.rbi +13 -3
- data/rbi/lib/orb/models/customers/credit_list_response.rbi +1 -2
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +40 -6
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +6 -4
- data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +27 -4
- data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +8 -2
- data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +25 -4
- data/rbi/lib/orb/models/dimensional_price_group.rbi +11 -3
- data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -0
- data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +8 -2
- data/rbi/lib/orb/models/evaluate_price_group.rbi +8 -2
- data/rbi/lib/orb/models/event_deprecate_response.rbi +4 -2
- data/rbi/lib/orb/models/event_ingest_params.rbi +22 -5
- data/rbi/lib/orb/models/event_ingest_response.rbi +15 -4
- data/rbi/lib/orb/models/event_search_params.rbi +14 -2
- data/rbi/lib/orb/models/event_search_response.rbi +14 -3
- data/rbi/lib/orb/models/event_update_params.rbi +10 -3
- data/rbi/lib/orb/models/event_update_response.rbi +4 -2
- data/rbi/lib/orb/models/events/backfill_close_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_create_params.rbi +18 -0
- data/rbi/lib/orb/models/events/backfill_create_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_list_params.rbi +8 -2
- data/rbi/lib/orb/models/events/backfill_list_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_revert_response.rbi +14 -2
- data/rbi/lib/orb/models/events/event_volumes.rbi +6 -2
- data/rbi/lib/orb/models/events/volume_list_params.rbi +18 -2
- data/rbi/lib/orb/models/invoice.rbi +375 -46
- data/rbi/lib/orb/models/invoice_create_params.rbi +38 -6
- data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +375 -66
- data/rbi/lib/orb/models/invoice_issue_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +16 -2
- data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +141 -20
- data/rbi/lib/orb/models/invoice_list_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_update_params.rbi +7 -2
- data/rbi/lib/orb/models/item.rbi +1 -2
- data/rbi/lib/orb/models/item_create_params.rbi +5 -2
- data/rbi/lib/orb/models/item_list_params.rbi +8 -2
- data/rbi/lib/orb/models/item_update_params.rbi +1 -8
- data/rbi/lib/orb/models/metric_create_params.rbi +15 -2
- data/rbi/lib/orb/models/metric_list_params.rbi +3 -0
- data/rbi/lib/orb/models/metric_update_params.rbi +7 -2
- data/rbi/lib/orb/models/percentage_discount.rbi +11 -4
- data/rbi/lib/orb/models/plan.rbi +102 -15
- data/rbi/lib/orb/models/plan_create_params.rbi +997 -679
- data/rbi/lib/orb/models/plan_list_params.rbi +5 -1
- data/rbi/lib/orb/models/plan_update_params.rbi +11 -2
- data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +11 -2
- data/rbi/lib/orb/models/price.rbi +717 -688
- data/rbi/lib/orb/models/price_create_params.rbi +137 -53
- data/rbi/lib/orb/models/price_evaluate_params.rbi +10 -0
- data/rbi/lib/orb/models/price_list_params.rbi +8 -2
- data/rbi/lib/orb/models/price_update_params.rbi +7 -2
- data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +7 -2
- data/rbi/lib/orb/models/subscription.rbi +174 -11
- data/rbi/lib/orb/models/subscription_cancel_params.rbi +8 -5
- data/rbi/lib/orb/models/subscription_cancel_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_change_apply_params.rbi +7 -2
- data/rbi/lib/orb/models/subscription_change_apply_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_create_params.rbi +2282 -1536
- data/rbi/lib/orb/models/subscription_create_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +9 -5
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +21 -4
- data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -0
- data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +8 -2
- data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +13 -4
- data/rbi/lib/orb/models/subscription_list_params.rbi +4 -2
- data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +1228 -861
- data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +2288 -1544
- data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +10 -2
- data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +187 -20
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_update_params.rbi +15 -0
- data/rbi/lib/orb/models/subscription_update_trial_params.rbi +11 -5
- data/rbi/lib/orb/models/subscription_update_trial_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_usage.rbi +2 -16
- data/rbi/lib/orb/models/trial_discount.rbi +5 -1
- data/rbi/lib/orb/models/usage_discount.rbi +11 -3
- 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 +14 -12
- metadata +8 -5
@@ -4,8 +4,7 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
# @see Orb::Resources::Events#ingest
|
6
6
|
class EventIngestParams < Orb::Internal::Type::BaseModel
|
7
|
-
|
8
|
-
# extend Orb::Internal::Type::RequestParameters::Converter
|
7
|
+
extend Orb::Internal::Type::RequestParameters::Converter
|
9
8
|
include Orb::Internal::Type::RequestParameters
|
10
9
|
|
11
10
|
# @!attribute events
|
@@ -20,25 +19,24 @@ module Orb
|
|
20
19
|
# @return [String, nil]
|
21
20
|
optional :backfill_id, String, nil?: true
|
22
21
|
|
23
|
-
# @!attribute
|
22
|
+
# @!attribute debug
|
24
23
|
# Flag to enable additional debug information in the endpoint response
|
25
24
|
#
|
26
25
|
# @return [Boolean, nil]
|
27
26
|
optional :debug, Orb::Internal::Type::Boolean
|
28
27
|
|
29
|
-
# @!
|
30
|
-
#
|
31
|
-
#
|
32
|
-
|
33
|
-
#
|
34
|
-
#
|
35
|
-
#
|
36
|
-
#
|
37
|
-
#
|
38
|
-
#
|
39
|
-
#
|
40
|
-
|
41
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
28
|
+
# @!method initialize(events:, backfill_id: nil, debug: nil, request_options: {})
|
29
|
+
# Some parameter documentations has been truncated, see
|
30
|
+
# {Orb::Models::EventIngestParams} for more details.
|
31
|
+
#
|
32
|
+
# @param events [Array<Orb::Models::EventIngestParams::Event>]
|
33
|
+
#
|
34
|
+
# @param backfill_id [String, nil] If this ingestion request is part of a backfill, this parameter ties the ingeste
|
35
|
+
# ...
|
36
|
+
#
|
37
|
+
# @param debug [Boolean] Flag to enable additional debug information in the endpoint response
|
38
|
+
#
|
39
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
42
40
|
|
43
41
|
class Event < Orb::Internal::Type::BaseModel
|
44
42
|
# @!attribute event_name
|
@@ -83,17 +81,25 @@ module Orb
|
|
83
81
|
# @return [String, nil]
|
84
82
|
optional :external_customer_id, String, nil?: true
|
85
83
|
|
86
|
-
# @!
|
87
|
-
#
|
88
|
-
#
|
89
|
-
#
|
90
|
-
#
|
91
|
-
#
|
92
|
-
#
|
93
|
-
#
|
94
|
-
#
|
95
|
-
|
96
|
-
#
|
84
|
+
# @!method initialize(event_name:, idempotency_key:, properties:, timestamp:, customer_id: nil, external_customer_id: nil)
|
85
|
+
# Some parameter documentations has been truncated, see
|
86
|
+
# {Orb::Models::EventIngestParams::Event} for more details.
|
87
|
+
#
|
88
|
+
# @param event_name [String] A name to meaningfully identify the action or event type.
|
89
|
+
#
|
90
|
+
# @param idempotency_key [String] A unique value, generated by the client, that is used to de-duplicate events. Ex
|
91
|
+
# ...
|
92
|
+
#
|
93
|
+
# @param properties [Object] A dictionary of custom properties. Values in this dictionary must be numeric, bo
|
94
|
+
# ...
|
95
|
+
#
|
96
|
+
# @param timestamp [Time] An ISO 8601 format date with no timezone offset (i.e. UTC). This should represen
|
97
|
+
# ...
|
98
|
+
#
|
99
|
+
# @param customer_id [String, nil] The Orb Customer identifier
|
100
|
+
#
|
101
|
+
# @param external_customer_id [String, nil] An alias for the Orb customer, whose mapping is specified when creating the cust
|
102
|
+
# ...
|
97
103
|
end
|
98
104
|
end
|
99
105
|
end
|
@@ -19,13 +19,15 @@ module Orb
|
|
19
19
|
# @return [Orb::Models::EventIngestResponse::Debug, nil]
|
20
20
|
optional :debug, -> { Orb::Models::EventIngestResponse::Debug }, nil?: true
|
21
21
|
|
22
|
-
# @!
|
23
|
-
#
|
24
|
-
#
|
25
|
-
#
|
26
|
-
#
|
27
|
-
|
28
|
-
#
|
22
|
+
# @!method initialize(validation_failed:, debug: nil)
|
23
|
+
# Some parameter documentations has been truncated, see
|
24
|
+
# {Orb::Models::EventIngestResponse} for more details.
|
25
|
+
#
|
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
|
+
#
|
29
|
+
# @param debug [Orb::Models::EventIngestResponse::Debug, nil] Optional debug information (only present when debug=true is passed to the endpoi
|
30
|
+
# ...
|
29
31
|
|
30
32
|
class ValidationFailed < Orb::Internal::Type::BaseModel
|
31
33
|
# @!attribute idempotency_key
|
@@ -41,13 +43,14 @@ module Orb
|
|
41
43
|
# @return [Array<String>]
|
42
44
|
required :validation_errors, Orb::Internal::Type::ArrayOf[String]
|
43
45
|
|
44
|
-
# @!
|
45
|
-
#
|
46
|
-
#
|
47
|
-
#
|
48
|
-
#
|
49
|
-
|
50
|
-
#
|
46
|
+
# @!method initialize(idempotency_key:, validation_errors:)
|
47
|
+
# Some parameter documentations has been truncated, see
|
48
|
+
# {Orb::Models::EventIngestResponse::ValidationFailed} for more details.
|
49
|
+
#
|
50
|
+
# @param idempotency_key [String] The passed idempotency_key corresponding to the validation_errors
|
51
|
+
#
|
52
|
+
# @param validation_errors [Array<String>] An array of strings corresponding to validation failures for this idempotency_ke
|
53
|
+
# ...
|
51
54
|
end
|
52
55
|
|
53
56
|
# @see Orb::Models::EventIngestResponse#debug
|
@@ -62,16 +65,12 @@ module Orb
|
|
62
65
|
# @return [Array<String>]
|
63
66
|
required :ingested, Orb::Internal::Type::ArrayOf[String]
|
64
67
|
|
65
|
-
# @!
|
66
|
-
#
|
67
|
-
#
|
68
|
-
#
|
69
|
-
#
|
70
|
-
#
|
71
|
-
# #
|
72
|
-
# def initialize(duplicate:, ingested:, **) = super
|
73
|
-
|
74
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
68
|
+
# @!method initialize(duplicate:, ingested:)
|
69
|
+
# Optional debug information (only present when debug=true is passed to the
|
70
|
+
# endpoint). Contains ingested and duplicate event idempotency keys.
|
71
|
+
#
|
72
|
+
# @param duplicate [Array<String>]
|
73
|
+
# @param ingested [Array<String>]
|
75
74
|
end
|
76
75
|
end
|
77
76
|
end
|
@@ -4,8 +4,7 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
# @see Orb::Resources::Events#search
|
6
6
|
class EventSearchParams < Orb::Internal::Type::BaseModel
|
7
|
-
|
8
|
-
# extend Orb::Internal::Type::RequestParameters::Converter
|
7
|
+
extend Orb::Internal::Type::RequestParameters::Converter
|
9
8
|
include Orb::Internal::Type::RequestParameters
|
10
9
|
|
11
10
|
# @!attribute event_ids
|
@@ -31,15 +30,20 @@ module Orb
|
|
31
30
|
# @return [Time, nil]
|
32
31
|
optional :timeframe_start, Time, nil?: true
|
33
32
|
|
34
|
-
# @!
|
35
|
-
#
|
36
|
-
#
|
37
|
-
#
|
38
|
-
#
|
39
|
-
#
|
40
|
-
#
|
41
|
-
|
42
|
-
#
|
33
|
+
# @!method initialize(event_ids:, timeframe_end: nil, timeframe_start: nil, request_options: {})
|
34
|
+
# Some parameter documentations has been truncated, see
|
35
|
+
# {Orb::Models::EventSearchParams} for more details.
|
36
|
+
#
|
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
|
+
#
|
40
|
+
# @param timeframe_end [Time, nil] The end of the timeframe, exclusive, in which to search events. If not specified
|
41
|
+
# ...
|
42
|
+
#
|
43
|
+
# @param timeframe_start [Time, nil] The start of the timeframe, inclusive, in which to search events. If not specifi
|
44
|
+
# ...
|
45
|
+
#
|
46
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
43
47
|
end
|
44
48
|
end
|
45
49
|
end
|
@@ -9,12 +9,8 @@ module Orb
|
|
9
9
|
# @return [Array<Orb::Models::EventSearchResponse::Data>]
|
10
10
|
required :data, -> { Orb::Internal::Type::ArrayOf[Orb::Models::EventSearchResponse::Data] }
|
11
11
|
|
12
|
-
# @!
|
13
|
-
#
|
14
|
-
# #
|
15
|
-
# def initialize(data:, **) = super
|
16
|
-
|
17
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
12
|
+
# @!method initialize(data:)
|
13
|
+
# @param data [Array<Orb::Models::EventSearchResponse::Data>]
|
18
14
|
|
19
15
|
class Data < Orb::Internal::Type::BaseModel
|
20
16
|
# @!attribute id
|
@@ -65,22 +61,31 @@ module Orb
|
|
65
61
|
# @return [Time]
|
66
62
|
required :timestamp, Time
|
67
63
|
|
68
|
-
# @!
|
69
|
-
#
|
70
|
-
#
|
71
|
-
#
|
72
|
-
# #
|
73
|
-
#
|
74
|
-
#
|
75
|
-
#
|
76
|
-
#
|
77
|
-
#
|
78
|
-
#
|
79
|
-
#
|
80
|
-
#
|
81
|
-
#
|
82
|
-
|
83
|
-
#
|
64
|
+
# @!method initialize(id:, customer_id:, deprecated:, event_name:, external_customer_id:, properties:, timestamp:)
|
65
|
+
# Some parameter documentations has been truncated, see
|
66
|
+
# {Orb::Models::EventSearchResponse::Data} for more details.
|
67
|
+
#
|
68
|
+
# The [Event](/core-concepts#event) resource represents a usage event that has
|
69
|
+
# been created for a customer. Events are the core of Orb's usage-based billing
|
70
|
+
# model, and are used to calculate the usage charges for a given billing period.
|
71
|
+
#
|
72
|
+
# @param id [String] A unique value, generated by the client, that is used to de-duplicate events. Ex
|
73
|
+
# ...
|
74
|
+
#
|
75
|
+
# @param customer_id [String, nil] The Orb Customer identifier
|
76
|
+
#
|
77
|
+
# @param deprecated [Boolean] A boolean indicating whether the event is currently deprecated.
|
78
|
+
#
|
79
|
+
# @param event_name [String] A name to meaningfully identify the action or event type.
|
80
|
+
#
|
81
|
+
# @param external_customer_id [String, nil] An alias for the Orb customer, whose mapping is specified when creating the cust
|
82
|
+
# ...
|
83
|
+
#
|
84
|
+
# @param properties [Object] A dictionary of custom properties. Values in this dictionary must be numeric, bo
|
85
|
+
# ...
|
86
|
+
#
|
87
|
+
# @param timestamp [Time] An ISO 8601 format date with no timezone offset (i.e. UTC). This should represen
|
88
|
+
# ...
|
84
89
|
end
|
85
90
|
end
|
86
91
|
end
|
@@ -4,8 +4,7 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
# @see Orb::Resources::Events#update
|
6
6
|
class EventUpdateParams < Orb::Internal::Type::BaseModel
|
7
|
-
|
8
|
-
# extend Orb::Internal::Type::RequestParameters::Converter
|
7
|
+
extend Orb::Internal::Type::RequestParameters::Converter
|
9
8
|
include Orb::Internal::Type::RequestParameters
|
10
9
|
|
11
10
|
# @!attribute event_name
|
@@ -42,17 +41,24 @@ module Orb
|
|
42
41
|
# @return [String, nil]
|
43
42
|
optional :external_customer_id, String, nil?: true
|
44
43
|
|
45
|
-
# @!
|
46
|
-
#
|
47
|
-
#
|
48
|
-
#
|
49
|
-
#
|
50
|
-
#
|
51
|
-
#
|
52
|
-
#
|
53
|
-
#
|
54
|
-
|
55
|
-
#
|
44
|
+
# @!method initialize(event_name:, properties:, timestamp:, customer_id: nil, external_customer_id: nil, request_options: {})
|
45
|
+
# Some parameter documentations has been truncated, see
|
46
|
+
# {Orb::Models::EventUpdateParams} for more details.
|
47
|
+
#
|
48
|
+
# @param event_name [String] A name to meaningfully identify the action or event type.
|
49
|
+
#
|
50
|
+
# @param properties [Object] A dictionary of custom properties. Values in this dictionary must be numeric, bo
|
51
|
+
# ...
|
52
|
+
#
|
53
|
+
# @param timestamp [Time] An ISO 8601 format date with no timezone offset (i.e. UTC). This should represen
|
54
|
+
# ...
|
55
|
+
#
|
56
|
+
# @param customer_id [String, nil] The Orb Customer identifier
|
57
|
+
#
|
58
|
+
# @param external_customer_id [String, nil] An alias for the Orb customer, whose mapping is specified when creating the cust
|
59
|
+
# ...
|
60
|
+
#
|
61
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
56
62
|
end
|
57
63
|
end
|
58
64
|
end
|
@@ -10,12 +10,8 @@ module Orb
|
|
10
10
|
# @return [String]
|
11
11
|
required :amended, String
|
12
12
|
|
13
|
-
# @!
|
14
|
-
#
|
15
|
-
# #
|
16
|
-
# def initialize(amended:, **) = super
|
17
|
-
|
18
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
13
|
+
# @!method initialize(amended:)
|
14
|
+
# @param amended [String] event_id of the amended event, if successfully ingested
|
19
15
|
end
|
20
16
|
end
|
21
17
|
end
|
@@ -5,16 +5,11 @@ module Orb
|
|
5
5
|
module Events
|
6
6
|
# @see Orb::Resources::Events::Backfills#close
|
7
7
|
class BackfillCloseParams < Orb::Internal::Type::BaseModel
|
8
|
-
|
9
|
-
# extend Orb::Internal::Type::RequestParameters::Converter
|
8
|
+
extend Orb::Internal::Type::RequestParameters::Converter
|
10
9
|
include Orb::Internal::Type::RequestParameters
|
11
10
|
|
12
|
-
# @!
|
13
|
-
#
|
14
|
-
# #
|
15
|
-
# def initialize(request_options: {}, **) = super
|
16
|
-
|
17
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
11
|
+
# @!method initialize(request_options: {})
|
12
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
18
13
|
end
|
19
14
|
end
|
20
15
|
end
|
@@ -73,40 +73,38 @@ module Orb
|
|
73
73
|
# @return [String, nil]
|
74
74
|
optional :deprecation_filter, String, nil?: true
|
75
75
|
|
76
|
-
# @!
|
77
|
-
#
|
78
|
-
#
|
79
|
-
#
|
80
|
-
#
|
81
|
-
#
|
82
|
-
#
|
83
|
-
#
|
84
|
-
#
|
85
|
-
#
|
86
|
-
#
|
87
|
-
#
|
88
|
-
#
|
89
|
-
#
|
90
|
-
#
|
91
|
-
#
|
92
|
-
#
|
93
|
-
#
|
94
|
-
#
|
95
|
-
#
|
96
|
-
#
|
97
|
-
#
|
98
|
-
#
|
99
|
-
#
|
100
|
-
#
|
101
|
-
#
|
102
|
-
#
|
103
|
-
#
|
104
|
-
#
|
105
|
-
#
|
106
|
-
#
|
107
|
-
#
|
108
|
-
|
109
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
76
|
+
# @!method initialize(id:, close_time:, created_at:, customer_id:, events_ingested:, replace_existing_events:, reverted_at:, status:, timeframe_end:, timeframe_start:, deprecation_filter: nil)
|
77
|
+
# Some parameter documentations has been truncated, see
|
78
|
+
# {Orb::Models::Events::BackfillCloseResponse} for more details.
|
79
|
+
#
|
80
|
+
# A backfill represents an update to historical usage data, adding or replacing
|
81
|
+
# events in a timeframe.
|
82
|
+
#
|
83
|
+
# @param id [String]
|
84
|
+
#
|
85
|
+
# @param close_time [Time, nil] If in the future, the time at which the backfill will automatically close. If in
|
86
|
+
# ...
|
87
|
+
#
|
88
|
+
# @param created_at [Time]
|
89
|
+
#
|
90
|
+
# @param customer_id [String, nil] The Orb-generated ID of the customer to which this backfill is scoped. If `null`
|
91
|
+
# ...
|
92
|
+
#
|
93
|
+
# @param events_ingested [Integer] The number of events ingested in this backfill.
|
94
|
+
#
|
95
|
+
# @param replace_existing_events [Boolean] If `true`, existing events in the backfill's timeframe will be replaced with the
|
96
|
+
# ...
|
97
|
+
#
|
98
|
+
# @param reverted_at [Time, nil] The time at which this backfill was reverted.
|
99
|
+
#
|
100
|
+
# @param status [Symbol, Orb::Models::Events::BackfillCloseResponse::Status] The status of the backfill.
|
101
|
+
#
|
102
|
+
# @param timeframe_end [Time]
|
103
|
+
#
|
104
|
+
# @param timeframe_start [Time]
|
105
|
+
#
|
106
|
+
# @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
|
107
|
+
# ...
|
110
108
|
|
111
109
|
# The status of the backfill.
|
112
110
|
#
|
@@ -119,11 +117,8 @@ module Orb
|
|
119
117
|
PENDING_REVERT = :pending_revert
|
120
118
|
REVERTED = :reverted
|
121
119
|
|
122
|
-
|
123
|
-
|
124
|
-
# @!parse
|
125
|
-
# # @return [Array<Symbol>]
|
126
|
-
# def self.values; end
|
120
|
+
# @!method self.values
|
121
|
+
# @return [Array<Symbol>]
|
127
122
|
end
|
128
123
|
end
|
129
124
|
end
|
@@ -5,8 +5,7 @@ module Orb
|
|
5
5
|
module Events
|
6
6
|
# @see Orb::Resources::Events::Backfills#create
|
7
7
|
class BackfillCreateParams < Orb::Internal::Type::BaseModel
|
8
|
-
|
9
|
-
# extend Orb::Internal::Type::RequestParameters::Converter
|
8
|
+
extend Orb::Internal::Type::RequestParameters::Converter
|
10
9
|
include Orb::Internal::Type::RequestParameters
|
11
10
|
|
12
11
|
# @!attribute timeframe_end
|
@@ -55,42 +54,39 @@ module Orb
|
|
55
54
|
# @return [String, nil]
|
56
55
|
optional :external_customer_id, String, nil?: true
|
57
56
|
|
58
|
-
# @!attribute
|
57
|
+
# @!attribute replace_existing_events
|
59
58
|
# If true, replaces all existing events in the timeframe with the newly ingested
|
60
59
|
# events. If false, adds the newly ingested events to the existing events.
|
61
60
|
#
|
62
61
|
# @return [Boolean, nil]
|
63
62
|
optional :replace_existing_events, Orb::Internal::Type::Boolean
|
64
63
|
|
65
|
-
# @!
|
66
|
-
#
|
67
|
-
#
|
68
|
-
|
69
|
-
#
|
70
|
-
#
|
71
|
-
#
|
72
|
-
#
|
73
|
-
#
|
74
|
-
#
|
75
|
-
#
|
76
|
-
#
|
77
|
-
#
|
78
|
-
#
|
79
|
-
#
|
80
|
-
#
|
81
|
-
#
|
82
|
-
#
|
83
|
-
#
|
84
|
-
#
|
85
|
-
#
|
86
|
-
#
|
87
|
-
#
|
88
|
-
#
|
89
|
-
#
|
90
|
-
#
|
91
|
-
# end
|
92
|
-
|
93
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
64
|
+
# @!method initialize(timeframe_end:, timeframe_start:, close_time: nil, customer_id: nil, deprecation_filter: nil, external_customer_id: nil, replace_existing_events: nil, request_options: {})
|
65
|
+
# Some parameter documentations has been truncated, see
|
66
|
+
# {Orb::Models::Events::BackfillCreateParams} for more details.
|
67
|
+
#
|
68
|
+
# @param timeframe_end [Time] The (exclusive) end of the usage timeframe affected by this backfill. By default
|
69
|
+
# ...
|
70
|
+
#
|
71
|
+
# @param timeframe_start [Time] The (inclusive) start of the usage timeframe affected by this backfill. By defau
|
72
|
+
# ...
|
73
|
+
#
|
74
|
+
# @param close_time [Time, nil] The time at which no more events will be accepted for this backfill. The backfil
|
75
|
+
# ...
|
76
|
+
#
|
77
|
+
# @param customer_id [String, nil] The Orb-generated ID of the customer to which this backfill is scoped. Omitting
|
78
|
+
# ...
|
79
|
+
#
|
80
|
+
# @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
|
81
|
+
# ...
|
82
|
+
#
|
83
|
+
# @param external_customer_id [String, nil] The external customer ID of the customer to which this backfill is scoped. Omitt
|
84
|
+
# ...
|
85
|
+
#
|
86
|
+
# @param replace_existing_events [Boolean] If true, replaces all existing events in the timeframe with the newly ingested e
|
87
|
+
# ...
|
88
|
+
#
|
89
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
94
90
|
end
|
95
91
|
end
|
96
92
|
end
|
@@ -73,40 +73,38 @@ module Orb
|
|
73
73
|
# @return [String, nil]
|
74
74
|
optional :deprecation_filter, String, nil?: true
|
75
75
|
|
76
|
-
# @!
|
77
|
-
#
|
78
|
-
#
|
79
|
-
#
|
80
|
-
#
|
81
|
-
#
|
82
|
-
#
|
83
|
-
#
|
84
|
-
#
|
85
|
-
#
|
86
|
-
#
|
87
|
-
#
|
88
|
-
#
|
89
|
-
#
|
90
|
-
#
|
91
|
-
#
|
92
|
-
#
|
93
|
-
#
|
94
|
-
#
|
95
|
-
#
|
96
|
-
#
|
97
|
-
#
|
98
|
-
#
|
99
|
-
#
|
100
|
-
#
|
101
|
-
#
|
102
|
-
#
|
103
|
-
#
|
104
|
-
#
|
105
|
-
#
|
106
|
-
#
|
107
|
-
#
|
108
|
-
|
109
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
76
|
+
# @!method initialize(id:, close_time:, created_at:, customer_id:, events_ingested:, replace_existing_events:, reverted_at:, status:, timeframe_end:, timeframe_start:, deprecation_filter: nil)
|
77
|
+
# Some parameter documentations has been truncated, see
|
78
|
+
# {Orb::Models::Events::BackfillCreateResponse} for more details.
|
79
|
+
#
|
80
|
+
# A backfill represents an update to historical usage data, adding or replacing
|
81
|
+
# events in a timeframe.
|
82
|
+
#
|
83
|
+
# @param id [String]
|
84
|
+
#
|
85
|
+
# @param close_time [Time, nil] If in the future, the time at which the backfill will automatically close. If in
|
86
|
+
# ...
|
87
|
+
#
|
88
|
+
# @param created_at [Time]
|
89
|
+
#
|
90
|
+
# @param customer_id [String, nil] The Orb-generated ID of the customer to which this backfill is scoped. If `null`
|
91
|
+
# ...
|
92
|
+
#
|
93
|
+
# @param events_ingested [Integer] The number of events ingested in this backfill.
|
94
|
+
#
|
95
|
+
# @param replace_existing_events [Boolean] If `true`, existing events in the backfill's timeframe will be replaced with the
|
96
|
+
# ...
|
97
|
+
#
|
98
|
+
# @param reverted_at [Time, nil] The time at which this backfill was reverted.
|
99
|
+
#
|
100
|
+
# @param status [Symbol, Orb::Models::Events::BackfillCreateResponse::Status] The status of the backfill.
|
101
|
+
#
|
102
|
+
# @param timeframe_end [Time]
|
103
|
+
#
|
104
|
+
# @param timeframe_start [Time]
|
105
|
+
#
|
106
|
+
# @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
|
107
|
+
# ...
|
110
108
|
|
111
109
|
# The status of the backfill.
|
112
110
|
#
|
@@ -119,11 +117,8 @@ module Orb
|
|
119
117
|
PENDING_REVERT = :pending_revert
|
120
118
|
REVERTED = :reverted
|
121
119
|
|
122
|
-
|
123
|
-
|
124
|
-
# @!parse
|
125
|
-
# # @return [Array<Symbol>]
|
126
|
-
# def self.values; end
|
120
|
+
# @!method self.values
|
121
|
+
# @return [Array<Symbol>]
|
127
122
|
end
|
128
123
|
end
|
129
124
|
end
|
@@ -5,16 +5,11 @@ module Orb
|
|
5
5
|
module Events
|
6
6
|
# @see Orb::Resources::Events::Backfills#fetch
|
7
7
|
class BackfillFetchParams < Orb::Internal::Type::BaseModel
|
8
|
-
|
9
|
-
# extend Orb::Internal::Type::RequestParameters::Converter
|
8
|
+
extend Orb::Internal::Type::RequestParameters::Converter
|
10
9
|
include Orb::Internal::Type::RequestParameters
|
11
10
|
|
12
|
-
# @!
|
13
|
-
#
|
14
|
-
# #
|
15
|
-
# def initialize(request_options: {}, **) = super
|
16
|
-
|
17
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
11
|
+
# @!method initialize(request_options: {})
|
12
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
18
13
|
end
|
19
14
|
end
|
20
15
|
end
|