orb-billing 0.1.0.pre.alpha.37 → 0.1.0.pre.alpha.39
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 +29 -5
- data/lib/orb/client.rb +4 -0
- data/lib/orb/internal/page.rb +6 -2
- data/lib/orb/internal/transport/base_client.rb +3 -3
- data/lib/orb/internal/transport/pooled_net_requester.rb +2 -2
- data/lib/orb/internal/type/array_of.rb +5 -3
- data/lib/orb/internal/type/base_model.rb +19 -16
- data/lib/orb/internal/type/base_page.rb +4 -1
- data/lib/orb/internal/type/{boolean_model.rb → boolean.rb} +2 -2
- data/lib/orb/internal/type/converter.rb +26 -23
- data/lib/orb/internal/type/enum.rb +10 -8
- data/lib/orb/internal/type/hash_of.rb +3 -1
- data/lib/orb/internal/util.rb +29 -50
- data/lib/orb/models/alert.rb +10 -10
- 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 +3 -3
- 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 +237 -237
- data/lib/orb/models/customer_create_params.rb +229 -229
- data/lib/orb/models/customer_list_params.rb +5 -5
- data/lib/orb/models/customer_update_by_external_id_params.rb +230 -230
- data/lib/orb/models/customer_update_params.rb +230 -230
- 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 +3 -3
- data/lib/orb/models/customers/credit_list_params.rb +3 -3
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +22 -22
- 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 +22 -22
- 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 +10 -10
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +9 -9
- data/lib/orb/models/customers/credits/top_up_create_params.rb +10 -10
- data/lib/orb/models/customers/credits/top_up_create_response.rb +9 -9
- 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 +9 -9
- data/lib/orb/models/customers/credits/top_up_list_params.rb +1 -1
- data/lib/orb/models/customers/credits/top_up_list_response.rb +9 -9
- 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/evaluate_price_group.rb +1 -1
- data/lib/orb/models/event_ingest_params.rb +8 -8
- 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 +9 -9
- data/lib/orb/models/event_update_params.rb +4 -4
- data/lib/orb/models/events/backfill_close_response.rb +8 -8
- data/lib/orb/models/events/backfill_create_params.rb +12 -12
- data/lib/orb/models/events/backfill_create_response.rb +8 -8
- data/lib/orb/models/events/backfill_fetch_response.rb +8 -8
- data/lib/orb/models/events/backfill_list_params.rb +1 -1
- data/lib/orb/models/events/backfill_list_response.rb +8 -8
- data/lib/orb/models/events/backfill_revert_response.rb +8 -8
- 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 +278 -278
- data/lib/orb/models/invoice_create_params.rb +13 -12
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +274 -274
- data/lib/orb/models/invoice_issue_params.rb +5 -5
- data/lib/orb/models/invoice_line_item_create_params.rb +1 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +32 -32
- data/lib/orb/models/invoice_list_params.rb +13 -13
- 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/pagination_metadata.rb +1 -1
- data/lib/orb/models/percentage_discount.rb +2 -2
- data/lib/orb/models/plan.rb +40 -40
- data/lib/orb/models/plan_create_params.rb +292 -292
- 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 +186 -186
- data/lib/orb/models/price_create_params.rb +21 -21
- 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 +120 -93
- data/lib/orb/models/subscription_cancel_params.rb +4 -4
- data/lib/orb/models/subscription_cancel_response.rb +156 -78
- 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 +705 -705
- data/lib/orb/models/subscription_create_response.rb +156 -78
- 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 +358 -358
- data/lib/orb/models/subscription_price_intervals_response.rb +158 -78
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +715 -715
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +158 -78
- data/lib/orb/models/subscription_trigger_phase_params.rb +4 -4
- data/lib/orb/models/subscription_trigger_phase_response.rb +158 -78
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +158 -78
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +159 -79
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +158 -78
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +9 -9
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +158 -78
- data/lib/orb/models/subscription_update_params.rb +11 -11
- data/lib/orb/models/subscription_update_trial_params.rb +4 -4
- data/lib/orb/models/subscription_update_trial_response.rb +158 -78
- 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 +40 -35
- data/lib/orb/resources/coupons/subscriptions.rb +3 -3
- data/lib/orb/resources/coupons.rb +9 -9
- data/lib/orb/resources/credit_notes.rb +10 -5
- data/lib/orb/resources/customers/balance_transactions.rb +28 -23
- data/lib/orb/resources/customers/costs.rb +232 -232
- data/lib/orb/resources/customers/credits/ledger.rb +348 -338
- 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 +61 -56
- 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 +40 -31
- data/lib/orb/resources/items.rb +1 -1
- data/lib/orb/resources/metrics.rb +13 -8
- data/lib/orb/resources/plans/external_plan_id.rb +14 -14
- data/lib/orb/resources/plans.rb +24 -19
- 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 +817 -807
- data/lib/orb/resources/top_level.rb +4 -4
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +8 -1
- 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 +7 -13
- data/rbi/lib/orb/internal/type/array_of.rbi +10 -18
- data/rbi/lib/orb/internal/type/base_model.rbi +45 -64
- data/rbi/lib/orb/internal/type/base_page.rbi +5 -10
- data/rbi/lib/orb/internal/type/{boolean_model.rbi → boolean.rbi} +5 -9
- data/rbi/lib/orb/internal/type/converter.rbi +25 -31
- data/rbi/lib/orb/internal/type/enum.rbi +14 -20
- data/rbi/lib/orb/internal/type/hash_of.rbi +8 -16
- data/rbi/lib/orb/internal/type/request_parameters.rbi +1 -2
- data/rbi/lib/orb/internal/type/union.rbi +10 -20
- data/rbi/lib/orb/internal/type/unknown.rbi +4 -8
- data/rbi/lib/orb/internal/util.rbi +40 -72
- 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/rbi/lib/orb/version.rbi +1 -1
- data/sig/orb/client.rbs +2 -0
- data/sig/orb/internal/type/array_of.rbs +2 -2
- data/sig/orb/internal/type/{boolean_model.rbs → boolean.rbs} +1 -1
- data/sig/orb/internal/util.rbs +5 -5
- 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
- data/sig/orb/version.rbs +1 -1
- metadata +26 -5
@@ -31,8 +31,8 @@ module Orb
|
|
31
31
|
|
32
32
|
# @!attribute metadata
|
33
33
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
34
|
-
#
|
35
|
-
#
|
34
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
35
|
+
# by setting `metadata` to `null`.
|
36
36
|
#
|
37
37
|
# @return [Hash{Symbol=>String, nil}, nil]
|
38
38
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
@@ -15,7 +15,7 @@ module Orb
|
|
15
15
|
|
16
16
|
# @!attribute backfill_id
|
17
17
|
# If this ingestion request is part of a backfill, this parameter ties the
|
18
|
-
#
|
18
|
+
# ingested events to the backfill
|
19
19
|
#
|
20
20
|
# @return [String, nil]
|
21
21
|
optional :backfill_id, String, nil?: true
|
@@ -24,7 +24,7 @@ module Orb
|
|
24
24
|
# Flag to enable additional debug information in the endpoint response
|
25
25
|
#
|
26
26
|
# @return [Boolean, nil]
|
27
|
-
optional :debug, Orb::Internal::Type::
|
27
|
+
optional :debug, Orb::Internal::Type::Boolean
|
28
28
|
|
29
29
|
# @!parse
|
30
30
|
# # @return [Boolean]
|
@@ -49,23 +49,23 @@ module Orb
|
|
49
49
|
|
50
50
|
# @!attribute idempotency_key
|
51
51
|
# A unique value, generated by the client, that is used to de-duplicate events.
|
52
|
-
#
|
53
|
-
#
|
52
|
+
# Exactly one event with a given idempotency key will be ingested, which allows
|
53
|
+
# for safe request retries.
|
54
54
|
#
|
55
55
|
# @return [String]
|
56
56
|
required :idempotency_key, String
|
57
57
|
|
58
58
|
# @!attribute properties
|
59
59
|
# A dictionary of custom properties. Values in this dictionary must be numeric,
|
60
|
-
#
|
60
|
+
# boolean, or strings. Nested dictionaries are disallowed.
|
61
61
|
#
|
62
62
|
# @return [Object]
|
63
63
|
required :properties, Orb::Internal::Type::Unknown
|
64
64
|
|
65
65
|
# @!attribute timestamp
|
66
66
|
# An ISO 8601 format date with no timezone offset (i.e. UTC). This should
|
67
|
-
#
|
68
|
-
#
|
67
|
+
# represent the time that usage was recorded, and is particularly important to
|
68
|
+
# attribute usage to a given billing period.
|
69
69
|
#
|
70
70
|
# @return [Time]
|
71
71
|
required :timestamp, Time
|
@@ -78,7 +78,7 @@ module Orb
|
|
78
78
|
|
79
79
|
# @!attribute external_customer_id
|
80
80
|
# An alias for the Orb customer, whose mapping is specified when creating the
|
81
|
-
#
|
81
|
+
# customer
|
82
82
|
#
|
83
83
|
# @return [String, nil]
|
84
84
|
optional :external_customer_id, String, nil?: true
|
@@ -6,7 +6,7 @@ module Orb
|
|
6
6
|
class EventIngestResponse < Orb::Internal::Type::BaseModel
|
7
7
|
# @!attribute validation_failed
|
8
8
|
# Contains all failing validation events. In the case of a 200, this array will
|
9
|
-
#
|
9
|
+
# always be empty. This field will always be present.
|
10
10
|
#
|
11
11
|
# @return [Array<Orb::Models::EventIngestResponse::ValidationFailed>]
|
12
12
|
required :validation_failed,
|
@@ -14,7 +14,7 @@ module Orb
|
|
14
14
|
|
15
15
|
# @!attribute debug
|
16
16
|
# Optional debug information (only present when debug=true is passed to the
|
17
|
-
#
|
17
|
+
# endpoint). Contains ingested and duplicate event idempotency keys.
|
18
18
|
#
|
19
19
|
# @return [Orb::Models::EventIngestResponse::Debug, nil]
|
20
20
|
optional :debug, -> { Orb::Models::EventIngestResponse::Debug }, nil?: true
|
@@ -36,7 +36,7 @@ module Orb
|
|
36
36
|
|
37
37
|
# @!attribute validation_errors
|
38
38
|
# An array of strings corresponding to validation failures for this
|
39
|
-
#
|
39
|
+
# idempotency_key.
|
40
40
|
#
|
41
41
|
# @return [Array<String>]
|
42
42
|
required :validation_errors, Orb::Internal::Type::ArrayOf[String]
|
@@ -64,7 +64,7 @@ module Orb
|
|
64
64
|
|
65
65
|
# @!parse
|
66
66
|
# # Optional debug information (only present when debug=true is passed to the
|
67
|
-
# #
|
67
|
+
# # endpoint). Contains ingested and duplicate event idempotency keys.
|
68
68
|
# #
|
69
69
|
# # @param duplicate [Array<String>]
|
70
70
|
# # @param ingested [Array<String>]
|
@@ -10,23 +10,23 @@ module Orb
|
|
10
10
|
|
11
11
|
# @!attribute event_ids
|
12
12
|
# This is an explicit array of IDs to filter by. Note that an event's ID is the
|
13
|
-
#
|
14
|
-
#
|
15
|
-
#
|
13
|
+
# idempotency_key that was originally used for ingestion, and this only supports
|
14
|
+
# events that have not been amended. Values in this array will be treated case
|
15
|
+
# sensitively.
|
16
16
|
#
|
17
17
|
# @return [Array<String>]
|
18
18
|
required :event_ids, Orb::Internal::Type::ArrayOf[String]
|
19
19
|
|
20
20
|
# @!attribute timeframe_end
|
21
21
|
# The end of the timeframe, exclusive, in which to search events. If not
|
22
|
-
#
|
22
|
+
# specified, the current time is used.
|
23
23
|
#
|
24
24
|
# @return [Time, nil]
|
25
25
|
optional :timeframe_end, Time, nil?: true
|
26
26
|
|
27
27
|
# @!attribute timeframe_start
|
28
28
|
# The start of the timeframe, inclusive, in which to search events. If not
|
29
|
-
#
|
29
|
+
# specified, the one week ago is used.
|
30
30
|
#
|
31
31
|
# @return [Time, nil]
|
32
32
|
optional :timeframe_start, Time, nil?: true
|
@@ -19,8 +19,8 @@ module Orb
|
|
19
19
|
class Data < Orb::Internal::Type::BaseModel
|
20
20
|
# @!attribute id
|
21
21
|
# A unique value, generated by the client, that is used to de-duplicate events.
|
22
|
-
#
|
23
|
-
#
|
22
|
+
# Exactly one event with a given idempotency key will be ingested, which allows
|
23
|
+
# for safe request retries.
|
24
24
|
#
|
25
25
|
# @return [String]
|
26
26
|
required :id, String
|
@@ -35,7 +35,7 @@ module Orb
|
|
35
35
|
# A boolean indicating whether the event is currently deprecated.
|
36
36
|
#
|
37
37
|
# @return [Boolean]
|
38
|
-
required :deprecated, Orb::Internal::Type::
|
38
|
+
required :deprecated, Orb::Internal::Type::Boolean
|
39
39
|
|
40
40
|
# @!attribute event_name
|
41
41
|
# A name to meaningfully identify the action or event type.
|
@@ -45,30 +45,30 @@ module Orb
|
|
45
45
|
|
46
46
|
# @!attribute external_customer_id
|
47
47
|
# An alias for the Orb customer, whose mapping is specified when creating the
|
48
|
-
#
|
48
|
+
# customer
|
49
49
|
#
|
50
50
|
# @return [String, nil]
|
51
51
|
required :external_customer_id, String, nil?: true
|
52
52
|
|
53
53
|
# @!attribute properties
|
54
54
|
# A dictionary of custom properties. Values in this dictionary must be numeric,
|
55
|
-
#
|
55
|
+
# boolean, or strings. Nested dictionaries are disallowed.
|
56
56
|
#
|
57
57
|
# @return [Object]
|
58
58
|
required :properties, Orb::Internal::Type::Unknown
|
59
59
|
|
60
60
|
# @!attribute timestamp
|
61
61
|
# An ISO 8601 format date with no timezone offset (i.e. UTC). This should
|
62
|
-
#
|
63
|
-
#
|
62
|
+
# represent the time that usage was recorded, and is particularly important to
|
63
|
+
# attribute usage to a given billing period.
|
64
64
|
#
|
65
65
|
# @return [Time]
|
66
66
|
required :timestamp, Time
|
67
67
|
|
68
68
|
# @!parse
|
69
69
|
# # The [Event](/core-concepts#event) resource represents a usage event that has
|
70
|
-
# #
|
71
|
-
# #
|
70
|
+
# # been created for a customer. Events are the core of Orb's usage-based billing
|
71
|
+
# # model, and are used to calculate the usage charges for a given billing period.
|
72
72
|
# #
|
73
73
|
# # @param id [String]
|
74
74
|
# # @param customer_id [String, nil]
|
@@ -16,15 +16,15 @@ module Orb
|
|
16
16
|
|
17
17
|
# @!attribute properties
|
18
18
|
# A dictionary of custom properties. Values in this dictionary must be numeric,
|
19
|
-
#
|
19
|
+
# boolean, or strings. Nested dictionaries are disallowed.
|
20
20
|
#
|
21
21
|
# @return [Object]
|
22
22
|
required :properties, Orb::Internal::Type::Unknown
|
23
23
|
|
24
24
|
# @!attribute timestamp
|
25
25
|
# An ISO 8601 format date with no timezone offset (i.e. UTC). This should
|
26
|
-
#
|
27
|
-
#
|
26
|
+
# represent the time that usage was recorded, and is particularly important to
|
27
|
+
# attribute usage to a given billing period.
|
28
28
|
#
|
29
29
|
# @return [Time]
|
30
30
|
required :timestamp, Time
|
@@ -37,7 +37,7 @@ module Orb
|
|
37
37
|
|
38
38
|
# @!attribute external_customer_id
|
39
39
|
# An alias for the Orb customer, whose mapping is specified when creating the
|
40
|
-
#
|
40
|
+
# customer
|
41
41
|
#
|
42
42
|
# @return [String, nil]
|
43
43
|
optional :external_customer_id, String, nil?: true
|
@@ -12,7 +12,7 @@ module Orb
|
|
12
12
|
|
13
13
|
# @!attribute close_time
|
14
14
|
# If in the future, the time at which the backfill will automatically close. If in
|
15
|
-
#
|
15
|
+
# the past, the time at which the backfill was closed.
|
16
16
|
#
|
17
17
|
# @return [Time, nil]
|
18
18
|
required :close_time, Time, nil?: true
|
@@ -24,7 +24,7 @@ module Orb
|
|
24
24
|
|
25
25
|
# @!attribute customer_id
|
26
26
|
# The Orb-generated ID of the customer to which this backfill is scoped. If
|
27
|
-
#
|
27
|
+
# `null`, this backfill is scoped to all customers.
|
28
28
|
#
|
29
29
|
# @return [String, nil]
|
30
30
|
required :customer_id, String, nil?: true
|
@@ -37,11 +37,11 @@ module Orb
|
|
37
37
|
|
38
38
|
# @!attribute replace_existing_events
|
39
39
|
# If `true`, existing events in the backfill's timeframe will be replaced with the
|
40
|
-
#
|
41
|
-
#
|
40
|
+
# newly ingested events associated with the backfill. If `false`, newly ingested
|
41
|
+
# events will be added to the existing events.
|
42
42
|
#
|
43
43
|
# @return [Boolean]
|
44
|
-
required :replace_existing_events, Orb::Internal::Type::
|
44
|
+
required :replace_existing_events, Orb::Internal::Type::Boolean
|
45
45
|
|
46
46
|
# @!attribute reverted_at
|
47
47
|
# The time at which this backfill was reverted.
|
@@ -67,15 +67,15 @@ module Orb
|
|
67
67
|
|
68
68
|
# @!attribute deprecation_filter
|
69
69
|
# A boolean
|
70
|
-
#
|
71
|
-
#
|
70
|
+
# [computed property](/extensibility/advanced-metrics#computed-properties) used to
|
71
|
+
# filter the set of events to deprecate
|
72
72
|
#
|
73
73
|
# @return [String, nil]
|
74
74
|
optional :deprecation_filter, String, nil?: true
|
75
75
|
|
76
76
|
# @!parse
|
77
77
|
# # A backfill represents an update to historical usage data, adding or replacing
|
78
|
-
# #
|
78
|
+
# # events in a timeframe.
|
79
79
|
# #
|
80
80
|
# # @param id [String]
|
81
81
|
# # @param close_time [Time, nil]
|
@@ -11,56 +11,56 @@ module Orb
|
|
11
11
|
|
12
12
|
# @!attribute timeframe_end
|
13
13
|
# The (exclusive) end of the usage timeframe affected by this backfill. By
|
14
|
-
#
|
15
|
-
#
|
14
|
+
# default, Orb allows backfills up to 10 days in duration at a time. Reach out to
|
15
|
+
# discuss extending this limit and your use case.
|
16
16
|
#
|
17
17
|
# @return [Time]
|
18
18
|
required :timeframe_end, Time
|
19
19
|
|
20
20
|
# @!attribute timeframe_start
|
21
21
|
# The (inclusive) start of the usage timeframe affected by this backfill. By
|
22
|
-
#
|
23
|
-
#
|
22
|
+
# default, Orb allows backfills up to 10 days in duration at a time. Reach out to
|
23
|
+
# discuss extending this limit and your use case.
|
24
24
|
#
|
25
25
|
# @return [Time]
|
26
26
|
required :timeframe_start, Time
|
27
27
|
|
28
28
|
# @!attribute close_time
|
29
29
|
# The time at which no more events will be accepted for this backfill. The
|
30
|
-
#
|
31
|
-
#
|
30
|
+
# backfill will automatically begin reflecting throughout Orb at the close time.
|
31
|
+
# If not specified, it will default to 1 day after the creation of the backfill.
|
32
32
|
#
|
33
33
|
# @return [Time, nil]
|
34
34
|
optional :close_time, Time, nil?: true
|
35
35
|
|
36
36
|
# @!attribute customer_id
|
37
37
|
# The Orb-generated ID of the customer to which this backfill is scoped. Omitting
|
38
|
-
#
|
38
|
+
# this field will scope the backfill to all customers.
|
39
39
|
#
|
40
40
|
# @return [String, nil]
|
41
41
|
optional :customer_id, String, nil?: true
|
42
42
|
|
43
43
|
# @!attribute deprecation_filter
|
44
44
|
# A boolean
|
45
|
-
#
|
46
|
-
#
|
45
|
+
# [computed property](/extensibility/advanced-metrics#computed-properties) used to
|
46
|
+
# filter the set of events to deprecate
|
47
47
|
#
|
48
48
|
# @return [String, nil]
|
49
49
|
optional :deprecation_filter, String, nil?: true
|
50
50
|
|
51
51
|
# @!attribute external_customer_id
|
52
52
|
# The external customer ID of the customer to which this backfill is scoped.
|
53
|
-
#
|
53
|
+
# Omitting this field will scope the backfill to all customers.
|
54
54
|
#
|
55
55
|
# @return [String, nil]
|
56
56
|
optional :external_customer_id, String, nil?: true
|
57
57
|
|
58
58
|
# @!attribute [r] replace_existing_events
|
59
59
|
# If true, replaces all existing events in the timeframe with the newly ingested
|
60
|
-
#
|
60
|
+
# events. If false, adds the newly ingested events to the existing events.
|
61
61
|
#
|
62
62
|
# @return [Boolean, nil]
|
63
|
-
optional :replace_existing_events, Orb::Internal::Type::
|
63
|
+
optional :replace_existing_events, Orb::Internal::Type::Boolean
|
64
64
|
|
65
65
|
# @!parse
|
66
66
|
# # @return [Boolean]
|
@@ -12,7 +12,7 @@ module Orb
|
|
12
12
|
|
13
13
|
# @!attribute close_time
|
14
14
|
# If in the future, the time at which the backfill will automatically close. If in
|
15
|
-
#
|
15
|
+
# the past, the time at which the backfill was closed.
|
16
16
|
#
|
17
17
|
# @return [Time, nil]
|
18
18
|
required :close_time, Time, nil?: true
|
@@ -24,7 +24,7 @@ module Orb
|
|
24
24
|
|
25
25
|
# @!attribute customer_id
|
26
26
|
# The Orb-generated ID of the customer to which this backfill is scoped. If
|
27
|
-
#
|
27
|
+
# `null`, this backfill is scoped to all customers.
|
28
28
|
#
|
29
29
|
# @return [String, nil]
|
30
30
|
required :customer_id, String, nil?: true
|
@@ -37,11 +37,11 @@ module Orb
|
|
37
37
|
|
38
38
|
# @!attribute replace_existing_events
|
39
39
|
# If `true`, existing events in the backfill's timeframe will be replaced with the
|
40
|
-
#
|
41
|
-
#
|
40
|
+
# newly ingested events associated with the backfill. If `false`, newly ingested
|
41
|
+
# events will be added to the existing events.
|
42
42
|
#
|
43
43
|
# @return [Boolean]
|
44
|
-
required :replace_existing_events, Orb::Internal::Type::
|
44
|
+
required :replace_existing_events, Orb::Internal::Type::Boolean
|
45
45
|
|
46
46
|
# @!attribute reverted_at
|
47
47
|
# The time at which this backfill was reverted.
|
@@ -67,15 +67,15 @@ module Orb
|
|
67
67
|
|
68
68
|
# @!attribute deprecation_filter
|
69
69
|
# A boolean
|
70
|
-
#
|
71
|
-
#
|
70
|
+
# [computed property](/extensibility/advanced-metrics#computed-properties) used to
|
71
|
+
# filter the set of events to deprecate
|
72
72
|
#
|
73
73
|
# @return [String, nil]
|
74
74
|
optional :deprecation_filter, String, nil?: true
|
75
75
|
|
76
76
|
# @!parse
|
77
77
|
# # A backfill represents an update to historical usage data, adding or replacing
|
78
|
-
# #
|
78
|
+
# # events in a timeframe.
|
79
79
|
# #
|
80
80
|
# # @param id [String]
|
81
81
|
# # @param close_time [Time, nil]
|
@@ -12,7 +12,7 @@ module Orb
|
|
12
12
|
|
13
13
|
# @!attribute close_time
|
14
14
|
# If in the future, the time at which the backfill will automatically close. If in
|
15
|
-
#
|
15
|
+
# the past, the time at which the backfill was closed.
|
16
16
|
#
|
17
17
|
# @return [Time, nil]
|
18
18
|
required :close_time, Time, nil?: true
|
@@ -24,7 +24,7 @@ module Orb
|
|
24
24
|
|
25
25
|
# @!attribute customer_id
|
26
26
|
# The Orb-generated ID of the customer to which this backfill is scoped. If
|
27
|
-
#
|
27
|
+
# `null`, this backfill is scoped to all customers.
|
28
28
|
#
|
29
29
|
# @return [String, nil]
|
30
30
|
required :customer_id, String, nil?: true
|
@@ -37,11 +37,11 @@ module Orb
|
|
37
37
|
|
38
38
|
# @!attribute replace_existing_events
|
39
39
|
# If `true`, existing events in the backfill's timeframe will be replaced with the
|
40
|
-
#
|
41
|
-
#
|
40
|
+
# newly ingested events associated with the backfill. If `false`, newly ingested
|
41
|
+
# events will be added to the existing events.
|
42
42
|
#
|
43
43
|
# @return [Boolean]
|
44
|
-
required :replace_existing_events, Orb::Internal::Type::
|
44
|
+
required :replace_existing_events, Orb::Internal::Type::Boolean
|
45
45
|
|
46
46
|
# @!attribute reverted_at
|
47
47
|
# The time at which this backfill was reverted.
|
@@ -67,15 +67,15 @@ module Orb
|
|
67
67
|
|
68
68
|
# @!attribute deprecation_filter
|
69
69
|
# A boolean
|
70
|
-
#
|
71
|
-
#
|
70
|
+
# [computed property](/extensibility/advanced-metrics#computed-properties) used to
|
71
|
+
# filter the set of events to deprecate
|
72
72
|
#
|
73
73
|
# @return [String, nil]
|
74
74
|
optional :deprecation_filter, String, nil?: true
|
75
75
|
|
76
76
|
# @!parse
|
77
77
|
# # A backfill represents an update to historical usage data, adding or replacing
|
78
|
-
# #
|
78
|
+
# # events in a timeframe.
|
79
79
|
# #
|
80
80
|
# # @param id [String]
|
81
81
|
# # @param close_time [Time, nil]
|
@@ -12,7 +12,7 @@ module Orb
|
|
12
12
|
|
13
13
|
# @!attribute close_time
|
14
14
|
# If in the future, the time at which the backfill will automatically close. If in
|
15
|
-
#
|
15
|
+
# the past, the time at which the backfill was closed.
|
16
16
|
#
|
17
17
|
# @return [Time, nil]
|
18
18
|
required :close_time, Time, nil?: true
|
@@ -24,7 +24,7 @@ module Orb
|
|
24
24
|
|
25
25
|
# @!attribute customer_id
|
26
26
|
# The Orb-generated ID of the customer to which this backfill is scoped. If
|
27
|
-
#
|
27
|
+
# `null`, this backfill is scoped to all customers.
|
28
28
|
#
|
29
29
|
# @return [String, nil]
|
30
30
|
required :customer_id, String, nil?: true
|
@@ -37,11 +37,11 @@ module Orb
|
|
37
37
|
|
38
38
|
# @!attribute replace_existing_events
|
39
39
|
# If `true`, existing events in the backfill's timeframe will be replaced with the
|
40
|
-
#
|
41
|
-
#
|
40
|
+
# newly ingested events associated with the backfill. If `false`, newly ingested
|
41
|
+
# events will be added to the existing events.
|
42
42
|
#
|
43
43
|
# @return [Boolean]
|
44
|
-
required :replace_existing_events, Orb::Internal::Type::
|
44
|
+
required :replace_existing_events, Orb::Internal::Type::Boolean
|
45
45
|
|
46
46
|
# @!attribute reverted_at
|
47
47
|
# The time at which this backfill was reverted.
|
@@ -67,15 +67,15 @@ module Orb
|
|
67
67
|
|
68
68
|
# @!attribute deprecation_filter
|
69
69
|
# A boolean
|
70
|
-
#
|
71
|
-
#
|
70
|
+
# [computed property](/extensibility/advanced-metrics#computed-properties) used to
|
71
|
+
# filter the set of events to deprecate
|
72
72
|
#
|
73
73
|
# @return [String, nil]
|
74
74
|
optional :deprecation_filter, String, nil?: true
|
75
75
|
|
76
76
|
# @!parse
|
77
77
|
# # A backfill represents an update to historical usage data, adding or replacing
|
78
|
-
# #
|
78
|
+
# # events in a timeframe.
|
79
79
|
# #
|
80
80
|
# # @param id [String]
|
81
81
|
# # @param close_time [Time, nil]
|
@@ -12,7 +12,7 @@ module Orb
|
|
12
12
|
|
13
13
|
# @!attribute close_time
|
14
14
|
# If in the future, the time at which the backfill will automatically close. If in
|
15
|
-
#
|
15
|
+
# the past, the time at which the backfill was closed.
|
16
16
|
#
|
17
17
|
# @return [Time, nil]
|
18
18
|
required :close_time, Time, nil?: true
|
@@ -24,7 +24,7 @@ module Orb
|
|
24
24
|
|
25
25
|
# @!attribute customer_id
|
26
26
|
# The Orb-generated ID of the customer to which this backfill is scoped. If
|
27
|
-
#
|
27
|
+
# `null`, this backfill is scoped to all customers.
|
28
28
|
#
|
29
29
|
# @return [String, nil]
|
30
30
|
required :customer_id, String, nil?: true
|
@@ -37,11 +37,11 @@ module Orb
|
|
37
37
|
|
38
38
|
# @!attribute replace_existing_events
|
39
39
|
# If `true`, existing events in the backfill's timeframe will be replaced with the
|
40
|
-
#
|
41
|
-
#
|
40
|
+
# newly ingested events associated with the backfill. If `false`, newly ingested
|
41
|
+
# events will be added to the existing events.
|
42
42
|
#
|
43
43
|
# @return [Boolean]
|
44
|
-
required :replace_existing_events, Orb::Internal::Type::
|
44
|
+
required :replace_existing_events, Orb::Internal::Type::Boolean
|
45
45
|
|
46
46
|
# @!attribute reverted_at
|
47
47
|
# The time at which this backfill was reverted.
|
@@ -67,15 +67,15 @@ module Orb
|
|
67
67
|
|
68
68
|
# @!attribute deprecation_filter
|
69
69
|
# A boolean
|
70
|
-
#
|
71
|
-
#
|
70
|
+
# [computed property](/extensibility/advanced-metrics#computed-properties) used to
|
71
|
+
# filter the set of events to deprecate
|
72
72
|
#
|
73
73
|
# @return [String, nil]
|
74
74
|
optional :deprecation_filter, String, nil?: true
|
75
75
|
|
76
76
|
# @!parse
|
77
77
|
# # A backfill represents an update to historical usage data, adding or replacing
|
78
|
-
# #
|
78
|
+
# # events in a timeframe.
|
79
79
|
# #
|
80
80
|
# # @param id [String]
|
81
81
|
# # @param close_time [Time, nil]
|
@@ -36,7 +36,7 @@ module Orb
|
|
36
36
|
|
37
37
|
# @!parse
|
38
38
|
# # An EventVolume contains the event volume ingested in an hourly window. The
|
39
|
-
# #
|
39
|
+
# # timestamp used for the aggregation is the `timestamp` datetime field on events.
|
40
40
|
# #
|
41
41
|
# # @param count [Integer]
|
42
42
|
# # @param timeframe_end [Time]
|
@@ -11,16 +11,16 @@ module Orb
|
|
11
11
|
|
12
12
|
# @!attribute timeframe_start
|
13
13
|
# The start of the timeframe, inclusive, in which to return event volume. All
|
14
|
-
#
|
15
|
-
#
|
16
|
-
#
|
14
|
+
# datetime values are converted to UTC time. If the specified time isn't
|
15
|
+
# hour-aligned, the response includes the event volume count for the hour the time
|
16
|
+
# falls in.
|
17
17
|
#
|
18
18
|
# @return [Time]
|
19
19
|
required :timeframe_start, Time
|
20
20
|
|
21
21
|
# @!attribute cursor
|
22
22
|
# Cursor for pagination. This can be populated by the `next_cursor` value returned
|
23
|
-
#
|
23
|
+
# from the initial request.
|
24
24
|
#
|
25
25
|
# @return [String, nil]
|
26
26
|
optional :cursor, String, nil?: true
|
@@ -37,9 +37,9 @@ module Orb
|
|
37
37
|
|
38
38
|
# @!attribute [r] timeframe_end
|
39
39
|
# The end of the timeframe, exclusive, in which to return event volume. If not
|
40
|
-
#
|
41
|
-
#
|
42
|
-
#
|
40
|
+
# specified, the current time is used. All datetime values are converted to UTC
|
41
|
+
# time.If the specified time isn't hour-aligned, the response includes the event
|
42
|
+
# volumecount for the hour the time falls in.
|
43
43
|
#
|
44
44
|
# @return [Time, nil]
|
45
45
|
optional :timeframe_end, Time
|