orb-billing 0.1.0.pre.alpha.38 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +10 -2
- data/lib/orb/client.rb +4 -0
- data/lib/orb/internal/transport/base_client.rb +2 -2
- data/lib/orb/internal/transport/pooled_net_requester.rb +15 -6
- data/lib/orb/internal/type/array_of.rb +12 -2
- data/lib/orb/internal/type/base_model.rb +23 -22
- data/lib/orb/internal/type/boolean.rb +5 -1
- data/lib/orb/internal/type/converter.rb +62 -39
- data/lib/orb/internal/type/enum.rb +13 -9
- data/lib/orb/internal/type/hash_of.rb +6 -2
- data/lib/orb/internal/type/io_like.rb +75 -0
- data/lib/orb/internal/type/request_parameters.rb +11 -2
- data/lib/orb/internal/type/union.rb +7 -3
- data/lib/orb/internal/type/unknown.rb +5 -1
- data/lib/orb/internal/util.rb +81 -26
- data/lib/orb/models/alert.rb +9 -9
- data/lib/orb/models/alert_create_for_customer_params.rb +3 -3
- data/lib/orb/models/alert_create_for_external_customer_params.rb +3 -3
- data/lib/orb/models/alert_create_for_subscription_params.rb +3 -3
- data/lib/orb/models/alert_list_params.rb +5 -5
- data/lib/orb/models/alert_update_params.rb +3 -3
- data/lib/orb/models/amount_discount.rb +1 -1
- data/lib/orb/models/billable_metric.rb +7 -7
- data/lib/orb/models/coupon.rb +7 -7
- data/lib/orb/models/coupon_create_params.rb +2 -2
- data/lib/orb/models/coupon_list_params.rb +2 -2
- data/lib/orb/models/coupons/subscription_list_params.rb +1 -1
- data/lib/orb/models/credit_note.rb +1 -1
- data/lib/orb/models/credit_note_list_params.rb +5 -5
- data/lib/orb/models/customer.rb +232 -232
- data/lib/orb/models/customer_create_params.rb +223 -223
- data/lib/orb/models/customer_list_params.rb +5 -5
- data/lib/orb/models/customer_update_by_external_id_params.rb +224 -224
- data/lib/orb/models/customer_update_params.rb +224 -224
- data/lib/orb/models/customers/balance_transaction_create_response.rb +2 -2
- data/lib/orb/models/customers/balance_transaction_list_params.rb +5 -5
- data/lib/orb/models/customers/balance_transaction_list_response.rb +2 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +6 -6
- data/lib/orb/models/customers/cost_list_params.rb +6 -6
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +2 -2
- data/lib/orb/models/customers/credit_list_params.rb +2 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +20 -20
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +20 -20
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +5 -5
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_list_params.rb +5 -5
- data/lib/orb/models/customers/credits/ledger_list_response.rb +22 -22
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +8 -8
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +7 -7
- data/lib/orb/models/customers/credits/top_up_create_params.rb +8 -8
- data/lib/orb/models/customers/credits/top_up_create_response.rb +7 -7
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +1 -1
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +7 -7
- data/lib/orb/models/customers/credits/top_up_list_params.rb +1 -1
- data/lib/orb/models/customers/credits/top_up_list_response.rb +7 -7
- data/lib/orb/models/dimensional_price_group.rb +7 -7
- data/lib/orb/models/dimensional_price_group_create_params.rb +2 -2
- data/lib/orb/models/dimensional_price_group_list_params.rb +1 -1
- data/lib/orb/models/event_ingest_params.rb +7 -7
- data/lib/orb/models/event_ingest_response.rb +4 -4
- data/lib/orb/models/event_search_params.rb +5 -5
- data/lib/orb/models/event_search_response.rb +8 -8
- data/lib/orb/models/event_update_params.rb +4 -4
- data/lib/orb/models/events/backfill_close_response.rb +7 -7
- data/lib/orb/models/events/backfill_create_params.rb +11 -11
- data/lib/orb/models/events/backfill_create_response.rb +7 -7
- data/lib/orb/models/events/backfill_fetch_response.rb +7 -7
- data/lib/orb/models/events/backfill_list_params.rb +1 -1
- data/lib/orb/models/events/backfill_list_response.rb +7 -7
- data/lib/orb/models/events/backfill_revert_response.rb +7 -7
- data/lib/orb/models/events/event_volumes.rb +1 -1
- data/lib/orb/models/events/volume_list_params.rb +7 -7
- data/lib/orb/models/invoice.rb +270 -270
- data/lib/orb/models/invoice_create_params.rb +12 -11
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +266 -266
- data/lib/orb/models/invoice_issue_params.rb +4 -4
- data/lib/orb/models/invoice_line_item_create_params.rb +1 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +27 -27
- data/lib/orb/models/invoice_list_params.rb +12 -12
- data/lib/orb/models/invoice_update_params.rb +2 -2
- data/lib/orb/models/item.rb +2 -2
- data/lib/orb/models/item_list_params.rb +1 -1
- data/lib/orb/models/metric_create_params.rb +2 -2
- data/lib/orb/models/metric_list_params.rb +5 -5
- data/lib/orb/models/metric_update_params.rb +2 -2
- data/lib/orb/models/percentage_discount.rb +2 -2
- data/lib/orb/models/plan.rb +35 -35
- data/lib/orb/models/plan_create_params.rb +267 -267
- data/lib/orb/models/plan_list_params.rb +5 -5
- data/lib/orb/models/plan_update_params.rb +4 -4
- data/lib/orb/models/plans/external_plan_id_update_params.rb +4 -4
- data/lib/orb/models/price.rb +158 -158
- data/lib/orb/models/price_create_params.rb +20 -20
- data/lib/orb/models/price_evaluate_params.rb +4 -4
- data/lib/orb/models/price_list_params.rb +1 -1
- data/lib/orb/models/price_update_params.rb +2 -2
- data/lib/orb/models/prices/external_price_id_update_params.rb +2 -2
- data/lib/orb/models/subscription.rb +114 -87
- data/lib/orb/models/subscription_cancel_params.rb +3 -3
- data/lib/orb/models/subscription_cancel_response.rb +150 -72
- data/lib/orb/models/subscription_change_apply_params.rb +33 -0
- data/lib/orb/models/subscription_change_apply_response.rb +1372 -0
- data/lib/orb/models/subscription_change_cancel_params.rb +19 -0
- data/lib/orb/models/subscription_change_cancel_response.rb +1372 -0
- data/lib/orb/models/subscription_change_retrieve_params.rb +19 -0
- data/lib/orb/models/subscription_change_retrieve_response.rb +1372 -0
- data/lib/orb/models/subscription_create_params.rb +641 -641
- data/lib/orb/models/subscription_create_response.rb +150 -72
- data/lib/orb/models/subscription_fetch_costs_params.rb +6 -6
- data/lib/orb/models/subscription_fetch_schedule_params.rb +5 -5
- data/lib/orb/models/subscription_fetch_schedule_response.rb +2 -2
- data/lib/orb/models/subscription_fetch_usage_params.rb +8 -8
- data/lib/orb/models/subscription_list_params.rb +5 -5
- data/lib/orb/models/subscription_price_intervals_params.rb +323 -323
- data/lib/orb/models/subscription_price_intervals_response.rb +152 -72
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +651 -651
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +152 -72
- data/lib/orb/models/subscription_trigger_phase_params.rb +3 -3
- data/lib/orb/models/subscription_trigger_phase_response.rb +152 -72
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +152 -72
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +153 -73
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +152 -72
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +8 -8
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +152 -72
- data/lib/orb/models/subscription_update_params.rb +10 -10
- data/lib/orb/models/subscription_update_trial_params.rb +3 -3
- data/lib/orb/models/subscription_update_trial_response.rb +152 -72
- data/lib/orb/models/trial_discount.rb +1 -1
- data/lib/orb/models/usage_discount.rb +2 -2
- data/lib/orb/request_options.rb +7 -7
- data/lib/orb/resources/alerts.rb +38 -38
- data/lib/orb/resources/coupons/subscriptions.rb +3 -3
- data/lib/orb/resources/coupons.rb +9 -9
- data/lib/orb/resources/credit_notes.rb +8 -8
- data/lib/orb/resources/customers/balance_transactions.rb +26 -26
- data/lib/orb/resources/customers/costs.rb +232 -232
- data/lib/orb/resources/customers/credits/ledger.rb +344 -344
- data/lib/orb/resources/customers/credits/top_ups.rb +12 -12
- data/lib/orb/resources/customers/credits.rb +8 -8
- data/lib/orb/resources/customers.rb +59 -59
- data/lib/orb/resources/dimensional_price_groups.rb +6 -6
- data/lib/orb/resources/events/backfills.rb +49 -49
- data/lib/orb/resources/events/volume.rb +10 -10
- data/lib/orb/resources/events.rb +295 -295
- data/lib/orb/resources/invoice_line_items.rb +1 -1
- data/lib/orb/resources/invoices.rb +38 -38
- data/lib/orb/resources/items.rb +1 -1
- data/lib/orb/resources/metrics.rb +11 -11
- data/lib/orb/resources/plans/external_plan_id.rb +14 -14
- data/lib/orb/resources/plans.rb +22 -22
- data/lib/orb/resources/prices/external_price_id.rb +4 -4
- data/lib/orb/resources/prices.rb +30 -30
- data/lib/orb/resources/subscription_changes.rb +87 -0
- data/lib/orb/resources/subscriptions.rb +813 -813
- data/lib/orb/resources/top_level.rb +4 -4
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +8 -0
- data/rbi/lib/orb/client.rbi +5 -4
- data/rbi/lib/orb/errors.rbi +3 -6
- data/rbi/lib/orb/internal/page.rbi +3 -6
- data/rbi/lib/orb/internal/transport/base_client.rbi +13 -27
- data/rbi/lib/orb/internal/transport/pooled_net_requester.rbi +8 -14
- data/rbi/lib/orb/internal/type/array_of.rbi +14 -18
- data/rbi/lib/orb/internal/type/base_model.rbi +51 -66
- data/rbi/lib/orb/internal/type/base_page.rbi +5 -10
- data/rbi/lib/orb/internal/type/boolean.rbi +12 -10
- data/rbi/lib/orb/internal/type/converter.rbi +44 -37
- data/rbi/lib/orb/internal/type/enum.rbi +24 -21
- data/rbi/lib/orb/internal/type/hash_of.rbi +13 -18
- data/rbi/lib/orb/internal/type/io_like.rbi +49 -0
- data/rbi/lib/orb/internal/type/request_parameters.rbi +1 -2
- data/rbi/lib/orb/internal/type/union.rbi +19 -21
- data/rbi/lib/orb/internal/type/unknown.rbi +10 -9
- data/rbi/lib/orb/internal/util.rbi +67 -70
- data/rbi/lib/orb/internal.rbi +1 -1
- data/rbi/lib/orb/models/alert.rbi +21 -33
- data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +8 -13
- data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +8 -13
- data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +8 -13
- data/rbi/lib/orb/models/alert_disable_params.rbi +2 -4
- data/rbi/lib/orb/models/alert_enable_params.rbi +2 -4
- data/rbi/lib/orb/models/alert_list_params.rbi +3 -6
- data/rbi/lib/orb/models/alert_retrieve_params.rbi +2 -4
- data/rbi/lib/orb/models/alert_update_params.rbi +7 -11
- data/rbi/lib/orb/models/amount_discount.rbi +4 -7
- data/rbi/lib/orb/models/billable_metric.rbi +10 -13
- data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -2
- data/rbi/lib/orb/models/coupon.rbi +9 -11
- data/rbi/lib/orb/models/coupon_archive_params.rbi +2 -4
- data/rbi/lib/orb/models/coupon_create_params.rbi +8 -14
- data/rbi/lib/orb/models/coupon_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/coupon_list_params.rbi +3 -4
- data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +3 -5
- data/rbi/lib/orb/models/credit_note.rbi +22 -45
- data/rbi/lib/orb/models/credit_note_create_params.rbi +5 -10
- data/rbi/lib/orb/models/credit_note_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -6
- data/rbi/lib/orb/models/customer.rbi +256 -281
- data/rbi/lib/orb/models/customer_create_params.rbi +251 -276
- data/rbi/lib/orb/models/customer_delete_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_list_params.rbi +3 -6
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +252 -277
- data/rbi/lib/orb/models/customer_update_params.rbi +252 -277
- data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +3 -6
- data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +10 -19
- data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -6
- data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +10 -19
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +8 -10
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +6 -12
- data/rbi/lib/orb/models/customers/cost_list_params.rbi +8 -10
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +6 -12
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +3 -4
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +2 -4
- data/rbi/lib/orb/models/customers/credit_list_params.rbi +3 -4
- data/rbi/lib/orb/models/customers/credit_list_response.rbi +2 -4
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +26 -33
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +79 -136
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +26 -33
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +78 -135
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +5 -10
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +79 -136
- data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +5 -10
- data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +74 -131
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +13 -19
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +12 -18
- data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +13 -19
- data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +12 -18
- data/rbi/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +2 -4
- data/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi +2 -4
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +3 -5
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +12 -18
- data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +3 -5
- data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +12 -18
- data/rbi/lib/orb/models/dimensional_price_group.rbi +8 -9
- data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -7
- data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +3 -5
- data/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi +2 -4
- data/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +2 -4
- data/rbi/lib/orb/models/dimensional_price_groups.rbi +2 -4
- data/rbi/lib/orb/models/discount.rbi +1 -2
- data/rbi/lib/orb/models/evaluate_price_group.rbi +3 -6
- data/rbi/lib/orb/models/event_deprecate_params.rbi +2 -4
- data/rbi/lib/orb/models/event_deprecate_response.rbi +2 -4
- data/rbi/lib/orb/models/event_ingest_params.rbi +10 -13
- data/rbi/lib/orb/models/event_ingest_response.rbi +10 -16
- data/rbi/lib/orb/models/event_search_params.rbi +7 -9
- data/rbi/lib/orb/models/event_search_response.rbi +11 -14
- data/rbi/lib/orb/models/event_update_params.rbi +5 -6
- data/rbi/lib/orb/models/event_update_response.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_close_params.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_close_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_create_params.rbi +13 -16
- data/rbi/lib/orb/models/events/backfill_create_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_list_params.rbi +3 -5
- data/rbi/lib/orb/models/events/backfill_list_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_revert_params.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_revert_response.rbi +10 -14
- data/rbi/lib/orb/models/events/event_volumes.rbi +5 -9
- data/rbi/lib/orb/models/events/volume_list_params.rbi +9 -11
- data/rbi/lib/orb/models/invoice.rbi +388 -465
- data/rbi/lib/orb/models/invoice_create_params.rbi +19 -26
- data/rbi/lib/orb/models/invoice_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +381 -460
- data/rbi/lib/orb/models/invoice_issue_params.rbi +6 -8
- data/rbi/lib/orb/models/invoice_level_discount.rbi +1 -2
- data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +3 -5
- data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +101 -143
- data/rbi/lib/orb/models/invoice_list_params.rbi +8 -13
- data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_pay_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_update_params.rbi +4 -6
- data/rbi/lib/orb/models/invoice_void_params.rbi +2 -4
- data/rbi/lib/orb/models/item.rbi +7 -12
- data/rbi/lib/orb/models/item_create_params.rbi +2 -4
- data/rbi/lib/orb/models/item_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/item_list_params.rbi +3 -5
- data/rbi/lib/orb/models/item_update_params.rbi +5 -10
- data/rbi/lib/orb/models/metric_create_params.rbi +4 -6
- data/rbi/lib/orb/models/metric_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/metric_list_params.rbi +3 -6
- data/rbi/lib/orb/models/metric_update_params.rbi +4 -6
- data/rbi/lib/orb/models/pagination_metadata.rbi +2 -4
- data/rbi/lib/orb/models/percentage_discount.rbi +5 -8
- data/rbi/lib/orb/models/plan.rbi +180 -219
- data/rbi/lib/orb/models/plan_create_params.rbi +670 -951
- data/rbi/lib/orb/models/plan_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/plan_list_params.rbi +4 -8
- data/rbi/lib/orb/models/plan_update_params.rbi +6 -8
- data/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +6 -8
- data/rbi/lib/orb/models/price.rbi +827 -1494
- data/rbi/lib/orb/models/price_create_params.rbi +60 -101
- data/rbi/lib/orb/models/price_evaluate_params.rbi +6 -9
- data/rbi/lib/orb/models/price_evaluate_response.rbi +2 -4
- data/rbi/lib/orb/models/price_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/price_list_params.rbi +3 -5
- data/rbi/lib/orb/models/price_update_params.rbi +4 -6
- data/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +4 -6
- data/rbi/lib/orb/models/subscription.rbi +167 -187
- data/rbi/lib/orb/models/subscription_cancel_params.rbi +5 -7
- data/rbi/lib/orb/models/subscription_cancel_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_change_apply_params.rbi +40 -0
- data/rbi/lib/orb/models/subscription_change_apply_response.rbi +1554 -0
- data/rbi/lib/orb/models/subscription_change_cancel_params.rbi +18 -0
- data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +1565 -0
- data/rbi/lib/orb/models/subscription_change_retrieve_params.rbi +18 -0
- data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +1581 -0
- data/rbi/lib/orb/models/subscription_create_params.rbi +1372 -1968
- data/rbi/lib/orb/models/subscription_create_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +8 -10
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +6 -12
- data/rbi/lib/orb/models/subscription_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -6
- data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +6 -10
- data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +12 -17
- data/rbi/lib/orb/models/subscription_list_params.rbi +4 -8
- data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +772 -1124
- data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +228 -178
- data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +1396 -1993
- data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +238 -182
- data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +5 -7
- data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +238 -182
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +265 -199
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +264 -198
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -15
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +238 -182
- data/rbi/lib/orb/models/subscription_update_params.rbi +12 -15
- data/rbi/lib/orb/models/subscription_update_trial_params.rbi +6 -9
- data/rbi/lib/orb/models/subscription_update_trial_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_usage.rbi +24 -43
- data/rbi/lib/orb/models/subscriptions.rbi +2 -4
- data/rbi/lib/orb/models/top_level_ping_params.rbi +2 -4
- data/rbi/lib/orb/models/top_level_ping_response.rbi +2 -4
- data/rbi/lib/orb/models/trial_discount.rbi +4 -8
- data/rbi/lib/orb/models/usage_discount.rbi +5 -8
- data/rbi/lib/orb/request_options.rbi +9 -11
- data/rbi/lib/orb/resources/alerts.rbi +44 -60
- data/rbi/lib/orb/resources/coupons/subscriptions.rbi +6 -9
- data/rbi/lib/orb/resources/coupons.rbi +18 -25
- data/rbi/lib/orb/resources/credit_notes.rbi +9 -15
- data/rbi/lib/orb/resources/customers/balance_transactions.rbi +26 -31
- data/rbi/lib/orb/resources/customers/costs.rbi +241 -246
- data/rbi/lib/orb/resources/customers/credits/ledger.rbi +387 -396
- data/rbi/lib/orb/resources/customers/credits/top_ups.rbi +29 -40
- data/rbi/lib/orb/resources/customers/credits.rbi +15 -20
- data/rbi/lib/orb/resources/customers.rbi +407 -417
- data/rbi/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +2 -4
- data/rbi/lib/orb/resources/dimensional_price_groups.rbi +13 -19
- data/rbi/lib/orb/resources/events/backfills.rbi +61 -69
- data/rbi/lib/orb/resources/events/volume.rbi +19 -22
- data/rbi/lib/orb/resources/events.rbi +311 -319
- data/rbi/lib/orb/resources/invoice_line_items.rbi +4 -7
- data/rbi/lib/orb/resources/invoices.rbi +62 -76
- data/rbi/lib/orb/resources/items.rbi +7 -14
- data/rbi/lib/orb/resources/metrics.rbi +17 -25
- data/rbi/lib/orb/resources/plans/external_plan_id.rbi +21 -25
- data/rbi/lib/orb/resources/plans.rbi +63 -71
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +9 -13
- data/rbi/lib/orb/resources/prices.rbi +77 -87
- data/rbi/lib/orb/resources/subscription_changes.rbi +61 -0
- data/rbi/lib/orb/resources/subscriptions.rbi +933 -963
- data/rbi/lib/orb/resources/top_level.rbi +6 -8
- data/sig/orb/client.rbs +2 -0
- data/sig/orb/internal/transport/pooled_net_requester.rbs +1 -1
- data/sig/orb/internal/type/array_of.rbs +5 -2
- data/sig/orb/internal/type/base_model.rbs +5 -2
- data/sig/orb/internal/type/boolean.rbs +5 -2
- data/sig/orb/internal/type/converter.rbs +11 -5
- data/sig/orb/internal/type/enum.rbs +5 -2
- data/sig/orb/internal/type/hash_of.rbs +5 -2
- data/sig/orb/internal/type/io_like.rbs +23 -0
- data/sig/orb/internal/type/union.rbs +5 -2
- data/sig/orb/internal/type/unknown.rbs +5 -2
- data/sig/orb/internal/util.rbs +17 -2
- data/sig/orb/models/subscription.rbs +14 -0
- data/sig/orb/models/subscription_cancel_response.rbs +47 -2
- data/sig/orb/models/subscription_change_apply_params.rbs +24 -0
- data/sig/orb/models/subscription_change_apply_response.rbs +784 -0
- data/sig/orb/models/subscription_change_cancel_params.rbs +15 -0
- data/sig/orb/models/subscription_change_cancel_response.rbs +784 -0
- data/sig/orb/models/subscription_change_retrieve_params.rbs +15 -0
- data/sig/orb/models/subscription_change_retrieve_response.rbs +784 -0
- data/sig/orb/models/subscription_create_response.rbs +47 -2
- data/sig/orb/models/subscription_price_intervals_response.rbs +47 -2
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +47 -2
- data/sig/orb/models/subscription_trigger_phase_response.rbs +47 -2
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +47 -2
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +47 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +47 -2
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +47 -2
- data/sig/orb/models/subscription_update_trial_response.rbs +47 -2
- data/sig/orb/resources/customers.rbs +2 -2
- data/sig/orb/resources/subscription_changes.rbs +24 -0
- metadata +28 -4
@@ -9,12 +9,10 @@ module Orb
|
|
9
9
|
sig do
|
10
10
|
params(request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)).returns(T.attached_class)
|
11
11
|
end
|
12
|
-
def self.new(request_options: {})
|
13
|
-
end
|
12
|
+
def self.new(request_options: {}); end
|
14
13
|
|
15
14
|
sig { override.returns({request_options: Orb::RequestOptions}) }
|
16
|
-
def to_hash
|
17
|
-
end
|
15
|
+
def to_hash; end
|
18
16
|
end
|
19
17
|
end
|
20
18
|
end
|
@@ -15,12 +15,10 @@ module Orb
|
|
15
15
|
)
|
16
16
|
).returns(T.attached_class)
|
17
17
|
end
|
18
|
-
def self.new(request_options: {})
|
19
|
-
end
|
18
|
+
def self.new(request_options: {}); end
|
20
19
|
|
21
20
|
sig { override.returns({request_options: Orb::RequestOptions}) }
|
22
|
-
def to_hash
|
23
|
-
end
|
21
|
+
def to_hash; end
|
24
22
|
end
|
25
23
|
end
|
26
24
|
end
|
@@ -19,8 +19,7 @@ module Orb
|
|
19
19
|
)
|
20
20
|
.returns(T.attached_class)
|
21
21
|
end
|
22
|
-
def self.new(data:, pagination_metadata:)
|
23
|
-
end
|
22
|
+
def self.new(data:, pagination_metadata:); end
|
24
23
|
|
25
24
|
sig do
|
26
25
|
override
|
@@ -28,8 +27,7 @@ module Orb
|
|
28
27
|
{data: T::Array[Orb::Models::DimensionalPriceGroup], pagination_metadata: Orb::Models::PaginationMetadata}
|
29
28
|
)
|
30
29
|
end
|
31
|
-
def to_hash
|
32
|
-
end
|
30
|
+
def to_hash; end
|
33
31
|
end
|
34
32
|
end
|
35
33
|
end
|
@@ -19,8 +19,7 @@ module Orb
|
|
19
19
|
params(amount: String, grouping_values: T::Array[T.any(String, Float, T::Boolean)], quantity: Float)
|
20
20
|
.returns(T.attached_class)
|
21
21
|
end
|
22
|
-
def self.new(amount:, grouping_values:, quantity:)
|
23
|
-
end
|
22
|
+
def self.new(amount:, grouping_values:, quantity:); end
|
24
23
|
|
25
24
|
sig do
|
26
25
|
override
|
@@ -30,15 +29,13 @@ module Orb
|
|
30
29
|
quantity: Float
|
31
30
|
})
|
32
31
|
end
|
33
|
-
def to_hash
|
34
|
-
end
|
32
|
+
def to_hash; end
|
35
33
|
|
36
34
|
module GroupingValue
|
37
35
|
extend Orb::Internal::Type::Union
|
38
36
|
|
39
37
|
sig { override.returns([String, Float, T::Boolean]) }
|
40
|
-
def self.variants
|
41
|
-
end
|
38
|
+
def self.variants; end
|
42
39
|
end
|
43
40
|
end
|
44
41
|
end
|
@@ -9,12 +9,10 @@ module Orb
|
|
9
9
|
sig do
|
10
10
|
params(request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)).returns(T.attached_class)
|
11
11
|
end
|
12
|
-
def self.new(request_options: {})
|
13
|
-
end
|
12
|
+
def self.new(request_options: {}); end
|
14
13
|
|
15
14
|
sig { override.returns({request_options: Orb::RequestOptions}) }
|
16
|
-
def to_hash
|
17
|
-
end
|
15
|
+
def to_hash; end
|
18
16
|
end
|
19
17
|
end
|
20
18
|
end
|
@@ -8,12 +8,10 @@ module Orb
|
|
8
8
|
attr_accessor :deprecated
|
9
9
|
|
10
10
|
sig { params(deprecated: String).returns(T.attached_class) }
|
11
|
-
def self.new(deprecated:)
|
12
|
-
end
|
11
|
+
def self.new(deprecated:); end
|
13
12
|
|
14
13
|
sig { override.returns({deprecated: String}) }
|
15
|
-
def to_hash
|
16
|
-
end
|
14
|
+
def to_hash; end
|
17
15
|
end
|
18
16
|
end
|
19
17
|
end
|
@@ -10,7 +10,7 @@ module Orb
|
|
10
10
|
attr_accessor :events
|
11
11
|
|
12
12
|
# If this ingestion request is part of a backfill, this parameter ties the
|
13
|
-
#
|
13
|
+
# ingested events to the backfill
|
14
14
|
sig { returns(T.nilable(String)) }
|
15
15
|
attr_accessor :backfill_id
|
16
16
|
|
@@ -30,8 +30,7 @@ module Orb
|
|
30
30
|
)
|
31
31
|
.returns(T.attached_class)
|
32
32
|
end
|
33
|
-
def self.new(events:, backfill_id: nil, debug: nil, request_options: {})
|
34
|
-
end
|
33
|
+
def self.new(events:, backfill_id: nil, debug: nil, request_options: {}); end
|
35
34
|
|
36
35
|
sig do
|
37
36
|
override
|
@@ -44,8 +43,7 @@ module Orb
|
|
44
43
|
}
|
45
44
|
)
|
46
45
|
end
|
47
|
-
def to_hash
|
48
|
-
end
|
46
|
+
def to_hash; end
|
49
47
|
|
50
48
|
class Event < Orb::Internal::Type::BaseModel
|
51
49
|
# A name to meaningfully identify the action or event type.
|
@@ -53,19 +51,19 @@ module Orb
|
|
53
51
|
attr_accessor :event_name
|
54
52
|
|
55
53
|
# A unique value, generated by the client, that is used to de-duplicate events.
|
56
|
-
#
|
57
|
-
#
|
54
|
+
# Exactly one event with a given idempotency key will be ingested, which allows
|
55
|
+
# for safe request retries.
|
58
56
|
sig { returns(String) }
|
59
57
|
attr_accessor :idempotency_key
|
60
58
|
|
61
59
|
# A dictionary of custom properties. Values in this dictionary must be numeric,
|
62
|
-
#
|
60
|
+
# boolean, or strings. Nested dictionaries are disallowed.
|
63
61
|
sig { returns(T.anything) }
|
64
62
|
attr_accessor :properties
|
65
63
|
|
66
64
|
# An ISO 8601 format date with no timezone offset (i.e. UTC). This should
|
67
|
-
#
|
68
|
-
#
|
65
|
+
# represent the time that usage was recorded, and is particularly important to
|
66
|
+
# attribute usage to a given billing period.
|
69
67
|
sig { returns(Time) }
|
70
68
|
attr_accessor :timestamp
|
71
69
|
|
@@ -74,7 +72,7 @@ module Orb
|
|
74
72
|
attr_accessor :customer_id
|
75
73
|
|
76
74
|
# An alias for the Orb customer, whose mapping is specified when creating the
|
77
|
-
#
|
75
|
+
# customer
|
78
76
|
sig { returns(T.nilable(String)) }
|
79
77
|
attr_accessor :external_customer_id
|
80
78
|
|
@@ -112,8 +110,7 @@ module Orb
|
|
112
110
|
}
|
113
111
|
)
|
114
112
|
end
|
115
|
-
def to_hash
|
116
|
-
end
|
113
|
+
def to_hash; end
|
117
114
|
end
|
118
115
|
end
|
119
116
|
end
|
@@ -4,12 +4,12 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
class EventIngestResponse < Orb::Internal::Type::BaseModel
|
6
6
|
# Contains all failing validation events. In the case of a 200, this array will
|
7
|
-
#
|
7
|
+
# always be empty. This field will always be present.
|
8
8
|
sig { returns(T::Array[Orb::Models::EventIngestResponse::ValidationFailed]) }
|
9
9
|
attr_accessor :validation_failed
|
10
10
|
|
11
11
|
# Optional debug information (only present when debug=true is passed to the
|
12
|
-
#
|
12
|
+
# endpoint). Contains ingested and duplicate event idempotency keys.
|
13
13
|
sig { returns(T.nilable(Orb::Models::EventIngestResponse::Debug)) }
|
14
14
|
attr_reader :debug
|
15
15
|
|
@@ -23,8 +23,7 @@ module Orb
|
|
23
23
|
)
|
24
24
|
.returns(T.attached_class)
|
25
25
|
end
|
26
|
-
def self.new(validation_failed:, debug: nil)
|
27
|
-
end
|
26
|
+
def self.new(validation_failed:, debug: nil); end
|
28
27
|
|
29
28
|
sig do
|
30
29
|
override
|
@@ -35,8 +34,7 @@ module Orb
|
|
35
34
|
}
|
36
35
|
)
|
37
36
|
end
|
38
|
-
def to_hash
|
39
|
-
end
|
37
|
+
def to_hash; end
|
40
38
|
|
41
39
|
class ValidationFailed < Orb::Internal::Type::BaseModel
|
42
40
|
# The passed idempotency_key corresponding to the validation_errors
|
@@ -44,17 +42,15 @@ module Orb
|
|
44
42
|
attr_accessor :idempotency_key
|
45
43
|
|
46
44
|
# An array of strings corresponding to validation failures for this
|
47
|
-
#
|
45
|
+
# idempotency_key.
|
48
46
|
sig { returns(T::Array[String]) }
|
49
47
|
attr_accessor :validation_errors
|
50
48
|
|
51
49
|
sig { params(idempotency_key: String, validation_errors: T::Array[String]).returns(T.attached_class) }
|
52
|
-
def self.new(idempotency_key:, validation_errors:)
|
53
|
-
end
|
50
|
+
def self.new(idempotency_key:, validation_errors:); end
|
54
51
|
|
55
52
|
sig { override.returns({idempotency_key: String, validation_errors: T::Array[String]}) }
|
56
|
-
def to_hash
|
57
|
-
end
|
53
|
+
def to_hash; end
|
58
54
|
end
|
59
55
|
|
60
56
|
class Debug < Orb::Internal::Type::BaseModel
|
@@ -65,14 +61,12 @@ module Orb
|
|
65
61
|
attr_accessor :ingested
|
66
62
|
|
67
63
|
# Optional debug information (only present when debug=true is passed to the
|
68
|
-
#
|
64
|
+
# endpoint). Contains ingested and duplicate event idempotency keys.
|
69
65
|
sig { params(duplicate: T::Array[String], ingested: T::Array[String]).returns(T.attached_class) }
|
70
|
-
def self.new(duplicate:, ingested:)
|
71
|
-
end
|
66
|
+
def self.new(duplicate:, ingested:); end
|
72
67
|
|
73
68
|
sig { override.returns({duplicate: T::Array[String], ingested: T::Array[String]}) }
|
74
|
-
def to_hash
|
75
|
-
end
|
69
|
+
def to_hash; end
|
76
70
|
end
|
77
71
|
end
|
78
72
|
end
|
@@ -7,19 +7,19 @@ module Orb
|
|
7
7
|
include Orb::Internal::Type::RequestParameters
|
8
8
|
|
9
9
|
# This is an explicit array of IDs to filter by. Note that an event's ID is the
|
10
|
-
#
|
11
|
-
#
|
12
|
-
#
|
10
|
+
# idempotency_key that was originally used for ingestion, and this only supports
|
11
|
+
# events that have not been amended. Values in this array will be treated case
|
12
|
+
# sensitively.
|
13
13
|
sig { returns(T::Array[String]) }
|
14
14
|
attr_accessor :event_ids
|
15
15
|
|
16
16
|
# The end of the timeframe, exclusive, in which to search events. If not
|
17
|
-
#
|
17
|
+
# specified, the current time is used.
|
18
18
|
sig { returns(T.nilable(Time)) }
|
19
19
|
attr_accessor :timeframe_end
|
20
20
|
|
21
21
|
# The start of the timeframe, inclusive, in which to search events. If not
|
22
|
-
#
|
22
|
+
# specified, the one week ago is used.
|
23
23
|
sig { returns(T.nilable(Time)) }
|
24
24
|
attr_accessor :timeframe_start
|
25
25
|
|
@@ -32,8 +32,7 @@ module Orb
|
|
32
32
|
)
|
33
33
|
.returns(T.attached_class)
|
34
34
|
end
|
35
|
-
def self.new(event_ids:, timeframe_end: nil, timeframe_start: nil, request_options: {})
|
36
|
-
end
|
35
|
+
def self.new(event_ids:, timeframe_end: nil, timeframe_start: nil, request_options: {}); end
|
37
36
|
|
38
37
|
sig do
|
39
38
|
override
|
@@ -46,8 +45,7 @@ module Orb
|
|
46
45
|
}
|
47
46
|
)
|
48
47
|
end
|
49
|
-
def to_hash
|
50
|
-
end
|
48
|
+
def to_hash; end
|
51
49
|
end
|
52
50
|
end
|
53
51
|
end
|
@@ -10,17 +10,15 @@ module Orb
|
|
10
10
|
params(data: T::Array[T.any(Orb::Models::EventSearchResponse::Data, Orb::Internal::AnyHash)])
|
11
11
|
.returns(T.attached_class)
|
12
12
|
end
|
13
|
-
def self.new(data:)
|
14
|
-
end
|
13
|
+
def self.new(data:); end
|
15
14
|
|
16
15
|
sig { override.returns({data: T::Array[Orb::Models::EventSearchResponse::Data]}) }
|
17
|
-
def to_hash
|
18
|
-
end
|
16
|
+
def to_hash; end
|
19
17
|
|
20
18
|
class Data < Orb::Internal::Type::BaseModel
|
21
19
|
# A unique value, generated by the client, that is used to de-duplicate events.
|
22
|
-
#
|
23
|
-
#
|
20
|
+
# Exactly one event with a given idempotency key will be ingested, which allows
|
21
|
+
# for safe request retries.
|
24
22
|
sig { returns(String) }
|
25
23
|
attr_accessor :id
|
26
24
|
|
@@ -37,24 +35,24 @@ module Orb
|
|
37
35
|
attr_accessor :event_name
|
38
36
|
|
39
37
|
# An alias for the Orb customer, whose mapping is specified when creating the
|
40
|
-
#
|
38
|
+
# customer
|
41
39
|
sig { returns(T.nilable(String)) }
|
42
40
|
attr_accessor :external_customer_id
|
43
41
|
|
44
42
|
# A dictionary of custom properties. Values in this dictionary must be numeric,
|
45
|
-
#
|
43
|
+
# boolean, or strings. Nested dictionaries are disallowed.
|
46
44
|
sig { returns(T.anything) }
|
47
45
|
attr_accessor :properties
|
48
46
|
|
49
47
|
# An ISO 8601 format date with no timezone offset (i.e. UTC). This should
|
50
|
-
#
|
51
|
-
#
|
48
|
+
# represent the time that usage was recorded, and is particularly important to
|
49
|
+
# attribute usage to a given billing period.
|
52
50
|
sig { returns(Time) }
|
53
51
|
attr_accessor :timestamp
|
54
52
|
|
55
53
|
# The [Event](/core-concepts#event) resource represents a usage event that has
|
56
|
-
#
|
57
|
-
#
|
54
|
+
# been created for a customer. Events are the core of Orb's usage-based billing
|
55
|
+
# model, and are used to calculate the usage charges for a given billing period.
|
58
56
|
sig do
|
59
57
|
params(
|
60
58
|
id: String,
|
@@ -92,8 +90,7 @@ module Orb
|
|
92
90
|
}
|
93
91
|
)
|
94
92
|
end
|
95
|
-
def to_hash
|
96
|
-
end
|
93
|
+
def to_hash; end
|
97
94
|
end
|
98
95
|
end
|
99
96
|
end
|
@@ -11,13 +11,13 @@ module Orb
|
|
11
11
|
attr_accessor :event_name
|
12
12
|
|
13
13
|
# A dictionary of custom properties. Values in this dictionary must be numeric,
|
14
|
-
#
|
14
|
+
# boolean, or strings. Nested dictionaries are disallowed.
|
15
15
|
sig { returns(T.anything) }
|
16
16
|
attr_accessor :properties
|
17
17
|
|
18
18
|
# An ISO 8601 format date with no timezone offset (i.e. UTC). This should
|
19
|
-
#
|
20
|
-
#
|
19
|
+
# represent the time that usage was recorded, and is particularly important to
|
20
|
+
# attribute usage to a given billing period.
|
21
21
|
sig { returns(Time) }
|
22
22
|
attr_accessor :timestamp
|
23
23
|
|
@@ -26,7 +26,7 @@ module Orb
|
|
26
26
|
attr_accessor :customer_id
|
27
27
|
|
28
28
|
# An alias for the Orb customer, whose mapping is specified when creating the
|
29
|
-
#
|
29
|
+
# customer
|
30
30
|
sig { returns(T.nilable(String)) }
|
31
31
|
attr_accessor :external_customer_id
|
32
32
|
|
@@ -64,8 +64,7 @@ module Orb
|
|
64
64
|
}
|
65
65
|
)
|
66
66
|
end
|
67
|
-
def to_hash
|
68
|
-
end
|
67
|
+
def to_hash; end
|
69
68
|
end
|
70
69
|
end
|
71
70
|
end
|
@@ -8,12 +8,10 @@ module Orb
|
|
8
8
|
attr_accessor :amended
|
9
9
|
|
10
10
|
sig { params(amended: String).returns(T.attached_class) }
|
11
|
-
def self.new(amended:)
|
12
|
-
end
|
11
|
+
def self.new(amended:); end
|
13
12
|
|
14
13
|
sig { override.returns({amended: String}) }
|
15
|
-
def to_hash
|
16
|
-
end
|
14
|
+
def to_hash; end
|
17
15
|
end
|
18
16
|
end
|
19
17
|
end
|
@@ -15,12 +15,10 @@ module Orb
|
|
15
15
|
)
|
16
16
|
).returns(T.attached_class)
|
17
17
|
end
|
18
|
-
def self.new(request_options: {})
|
19
|
-
end
|
18
|
+
def self.new(request_options: {}); end
|
20
19
|
|
21
20
|
sig { override.returns({request_options: Orb::RequestOptions}) }
|
22
|
-
def to_hash
|
23
|
-
end
|
21
|
+
def to_hash; end
|
24
22
|
end
|
25
23
|
end
|
26
24
|
end
|
@@ -8,7 +8,7 @@ module Orb
|
|
8
8
|
attr_accessor :id
|
9
9
|
|
10
10
|
# If in the future, the time at which the backfill will automatically close. If in
|
11
|
-
#
|
11
|
+
# the past, the time at which the backfill was closed.
|
12
12
|
sig { returns(T.nilable(Time)) }
|
13
13
|
attr_accessor :close_time
|
14
14
|
|
@@ -16,7 +16,7 @@ module Orb
|
|
16
16
|
attr_accessor :created_at
|
17
17
|
|
18
18
|
# The Orb-generated ID of the customer to which this backfill is scoped. If
|
19
|
-
#
|
19
|
+
# `null`, this backfill is scoped to all customers.
|
20
20
|
sig { returns(T.nilable(String)) }
|
21
21
|
attr_accessor :customer_id
|
22
22
|
|
@@ -25,8 +25,8 @@ module Orb
|
|
25
25
|
attr_accessor :events_ingested
|
26
26
|
|
27
27
|
# If `true`, existing events in the backfill's timeframe will be replaced with the
|
28
|
-
#
|
29
|
-
#
|
28
|
+
# newly ingested events associated with the backfill. If `false`, newly ingested
|
29
|
+
# events will be added to the existing events.
|
30
30
|
sig { returns(T::Boolean) }
|
31
31
|
attr_accessor :replace_existing_events
|
32
32
|
|
@@ -45,13 +45,13 @@ module Orb
|
|
45
45
|
attr_accessor :timeframe_start
|
46
46
|
|
47
47
|
# A boolean
|
48
|
-
#
|
49
|
-
#
|
48
|
+
# [computed property](/extensibility/advanced-metrics#computed-properties) used to
|
49
|
+
# filter the set of events to deprecate
|
50
50
|
sig { returns(T.nilable(String)) }
|
51
51
|
attr_accessor :deprecation_filter
|
52
52
|
|
53
53
|
# A backfill represents an update to historical usage data, adding or replacing
|
54
|
-
#
|
54
|
+
# events in a timeframe.
|
55
55
|
sig do
|
56
56
|
params(
|
57
57
|
id: String,
|
@@ -80,9 +80,7 @@ module Orb
|
|
80
80
|
timeframe_end:,
|
81
81
|
timeframe_start:,
|
82
82
|
deprecation_filter: nil
|
83
|
-
)
|
84
|
-
end
|
85
|
-
|
83
|
+
); end
|
86
84
|
sig do
|
87
85
|
override
|
88
86
|
.returns(
|
@@ -101,8 +99,7 @@ module Orb
|
|
101
99
|
}
|
102
100
|
)
|
103
101
|
end
|
104
|
-
def to_hash
|
105
|
-
end
|
102
|
+
def to_hash; end
|
106
103
|
|
107
104
|
# The status of the backfill.
|
108
105
|
module Status
|
@@ -118,8 +115,7 @@ module Orb
|
|
118
115
|
REVERTED = T.let(:reverted, Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol)
|
119
116
|
|
120
117
|
sig { override.returns(T::Array[Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol]) }
|
121
|
-
def self.values
|
122
|
-
end
|
118
|
+
def self.values; end
|
123
119
|
end
|
124
120
|
end
|
125
121
|
end
|
@@ -8,41 +8,41 @@ module Orb
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
9
9
|
|
10
10
|
# The (exclusive) end of the usage timeframe affected by this backfill. By
|
11
|
-
#
|
12
|
-
#
|
11
|
+
# default, Orb allows backfills up to 10 days in duration at a time. Reach out to
|
12
|
+
# discuss extending this limit and your use case.
|
13
13
|
sig { returns(Time) }
|
14
14
|
attr_accessor :timeframe_end
|
15
15
|
|
16
16
|
# The (inclusive) start of the usage timeframe affected by this backfill. By
|
17
|
-
#
|
18
|
-
#
|
17
|
+
# default, Orb allows backfills up to 10 days in duration at a time. Reach out to
|
18
|
+
# discuss extending this limit and your use case.
|
19
19
|
sig { returns(Time) }
|
20
20
|
attr_accessor :timeframe_start
|
21
21
|
|
22
22
|
# The time at which no more events will be accepted for this backfill. The
|
23
|
-
#
|
24
|
-
#
|
23
|
+
# backfill will automatically begin reflecting throughout Orb at the close time.
|
24
|
+
# If not specified, it will default to 1 day after the creation of the backfill.
|
25
25
|
sig { returns(T.nilable(Time)) }
|
26
26
|
attr_accessor :close_time
|
27
27
|
|
28
28
|
# The Orb-generated ID of the customer to which this backfill is scoped. Omitting
|
29
|
-
#
|
29
|
+
# this field will scope the backfill to all customers.
|
30
30
|
sig { returns(T.nilable(String)) }
|
31
31
|
attr_accessor :customer_id
|
32
32
|
|
33
33
|
# A boolean
|
34
|
-
#
|
35
|
-
#
|
34
|
+
# [computed property](/extensibility/advanced-metrics#computed-properties) used to
|
35
|
+
# filter the set of events to deprecate
|
36
36
|
sig { returns(T.nilable(String)) }
|
37
37
|
attr_accessor :deprecation_filter
|
38
38
|
|
39
39
|
# The external customer ID of the customer to which this backfill is scoped.
|
40
|
-
#
|
40
|
+
# Omitting this field will scope the backfill to all customers.
|
41
41
|
sig { returns(T.nilable(String)) }
|
42
42
|
attr_accessor :external_customer_id
|
43
43
|
|
44
44
|
# If true, replaces all existing events in the timeframe with the newly ingested
|
45
|
-
#
|
45
|
+
# events. If false, adds the newly ingested events to the existing events.
|
46
46
|
sig { returns(T.nilable(T::Boolean)) }
|
47
47
|
attr_reader :replace_existing_events
|
48
48
|
|
@@ -71,9 +71,7 @@ module Orb
|
|
71
71
|
external_customer_id: nil,
|
72
72
|
replace_existing_events: nil,
|
73
73
|
request_options: {}
|
74
|
-
)
|
75
|
-
end
|
76
|
-
|
74
|
+
); end
|
77
75
|
sig do
|
78
76
|
override
|
79
77
|
.returns(
|
@@ -89,8 +87,7 @@ module Orb
|
|
89
87
|
}
|
90
88
|
)
|
91
89
|
end
|
92
|
-
def to_hash
|
93
|
-
end
|
90
|
+
def to_hash; end
|
94
91
|
end
|
95
92
|
end
|
96
93
|
end
|
@@ -8,7 +8,7 @@ module Orb
|
|
8
8
|
attr_accessor :id
|
9
9
|
|
10
10
|
# If in the future, the time at which the backfill will automatically close. If in
|
11
|
-
#
|
11
|
+
# the past, the time at which the backfill was closed.
|
12
12
|
sig { returns(T.nilable(Time)) }
|
13
13
|
attr_accessor :close_time
|
14
14
|
|
@@ -16,7 +16,7 @@ module Orb
|
|
16
16
|
attr_accessor :created_at
|
17
17
|
|
18
18
|
# The Orb-generated ID of the customer to which this backfill is scoped. If
|
19
|
-
#
|
19
|
+
# `null`, this backfill is scoped to all customers.
|
20
20
|
sig { returns(T.nilable(String)) }
|
21
21
|
attr_accessor :customer_id
|
22
22
|
|
@@ -25,8 +25,8 @@ module Orb
|
|
25
25
|
attr_accessor :events_ingested
|
26
26
|
|
27
27
|
# If `true`, existing events in the backfill's timeframe will be replaced with the
|
28
|
-
#
|
29
|
-
#
|
28
|
+
# newly ingested events associated with the backfill. If `false`, newly ingested
|
29
|
+
# events will be added to the existing events.
|
30
30
|
sig { returns(T::Boolean) }
|
31
31
|
attr_accessor :replace_existing_events
|
32
32
|
|
@@ -45,13 +45,13 @@ module Orb
|
|
45
45
|
attr_accessor :timeframe_start
|
46
46
|
|
47
47
|
# A boolean
|
48
|
-
#
|
49
|
-
#
|
48
|
+
# [computed property](/extensibility/advanced-metrics#computed-properties) used to
|
49
|
+
# filter the set of events to deprecate
|
50
50
|
sig { returns(T.nilable(String)) }
|
51
51
|
attr_accessor :deprecation_filter
|
52
52
|
|
53
53
|
# A backfill represents an update to historical usage data, adding or replacing
|
54
|
-
#
|
54
|
+
# events in a timeframe.
|
55
55
|
sig do
|
56
56
|
params(
|
57
57
|
id: String,
|
@@ -80,9 +80,7 @@ module Orb
|
|
80
80
|
timeframe_end:,
|
81
81
|
timeframe_start:,
|
82
82
|
deprecation_filter: nil
|
83
|
-
)
|
84
|
-
end
|
85
|
-
|
83
|
+
); end
|
86
84
|
sig do
|
87
85
|
override
|
88
86
|
.returns(
|
@@ -101,8 +99,7 @@ module Orb
|
|
101
99
|
}
|
102
100
|
)
|
103
101
|
end
|
104
|
-
def to_hash
|
105
|
-
end
|
102
|
+
def to_hash; end
|
106
103
|
|
107
104
|
# The status of the backfill.
|
108
105
|
module Status
|
@@ -119,8 +116,7 @@ module Orb
|
|
119
116
|
REVERTED = T.let(:reverted, Orb::Models::Events::BackfillCreateResponse::Status::TaggedSymbol)
|
120
117
|
|
121
118
|
sig { override.returns(T::Array[Orb::Models::Events::BackfillCreateResponse::Status::TaggedSymbol]) }
|
122
|
-
def self.values
|
123
|
-
end
|
119
|
+
def self.values; end
|
124
120
|
end
|
125
121
|
end
|
126
122
|
end
|