orb-billing 0.3.1 → 0.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +14 -0
- data/README.md +3 -3
- data/lib/orb/file_part.rb +2 -2
- data/lib/orb/internal/type/enum.rb +3 -3
- data/lib/orb/internal/type/request_parameters.rb +4 -4
- data/lib/orb/internal/type/union.rb +4 -4
- data/lib/orb/internal/util.rb +1 -1
- data/lib/orb/models/alert.rb +29 -32
- data/lib/orb/models/alert_create_for_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_external_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_subscription_params.rb +7 -8
- data/lib/orb/models/alert_list_params.rb +0 -1
- data/lib/orb/models/alert_update_params.rb +4 -5
- data/lib/orb/models/amount_discount.rb +6 -7
- data/lib/orb/models/billable_metric.rb +9 -11
- data/lib/orb/models/coupon.rb +9 -12
- data/lib/orb/models/coupon_create_params.rb +6 -8
- data/lib/orb/models/coupon_list_params.rb +0 -2
- data/lib/orb/models/coupons/subscription_list_params.rb +0 -1
- data/lib/orb/models/credit_note.rb +48 -46
- data/lib/orb/models/credit_note_create_params.rb +6 -6
- data/lib/orb/models/credit_note_list_params.rb +0 -1
- data/lib/orb/models/customer.rb +54 -61
- data/lib/orb/models/customer_create_params.rb +41 -53
- data/lib/orb/models/customer_list_params.rb +0 -1
- data/lib/orb/models/customer_update_by_external_id_params.rb +41 -53
- data/lib/orb/models/customer_update_params.rb +41 -51
- data/lib/orb/models/customers/balance_transaction_create_params.rb +3 -3
- data/lib/orb/models/customers/balance_transaction_create_response.rb +0 -2
- data/lib/orb/models/customers/balance_transaction_list_params.rb +0 -1
- data/lib/orb/models/customers/balance_transaction_list_response.rb +0 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -3
- data/lib/orb/models/customers/cost_list_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_response.rb +3 -3
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +0 -2
- data/lib/orb/models/customers/credit_list_params.rb +0 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +12 -21
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +0 -7
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +11 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +0 -7
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +6 -7
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +0 -7
- data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
- data/lib/orb/models/customers/credits/ledger_list_response.rb +0 -7
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +10 -15
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_create_params.rb +7 -15
- data/lib/orb/models/customers/credits/top_up_create_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_response.rb +0 -6
- data/lib/orb/models/dimensional_price_group.rb +1 -3
- data/lib/orb/models/dimensional_price_group_create_params.rb +0 -1
- data/lib/orb/models/dimensional_price_group_list_params.rb +0 -1
- data/lib/orb/models/dimensional_price_groups.rb +6 -6
- data/lib/orb/models/discount.rb +5 -5
- data/lib/orb/models/evaluate_price_group.rb +1 -1
- data/lib/orb/models/event_ingest_params.rb +4 -9
- data/lib/orb/models/event_ingest_response.rb +0 -3
- data/lib/orb/models/event_search_params.rb +0 -3
- data/lib/orb/models/event_search_response.rb +0 -4
- data/lib/orb/models/event_update_params.rb +0 -3
- data/lib/orb/models/events/backfill_close_response.rb +0 -4
- data/lib/orb/models/events/backfill_create_params.rb +0 -7
- data/lib/orb/models/events/backfill_create_response.rb +0 -4
- data/lib/orb/models/events/backfill_fetch_response.rb +0 -4
- data/lib/orb/models/events/backfill_list_params.rb +0 -1
- data/lib/orb/models/events/backfill_list_response.rb +0 -4
- data/lib/orb/models/events/backfill_revert_response.rb +0 -4
- data/lib/orb/models/events/event_volumes.rb +3 -3
- data/lib/orb/models/events/volume_list_params.rb +0 -3
- data/lib/orb/models/invoice.rb +157 -202
- data/lib/orb/models/invoice_create_params.rb +14 -21
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +9 -54
- data/lib/orb/models/invoice_issue_params.rb +0 -1
- data/lib/orb/models/invoice_level_discount.rb +4 -4
- data/lib/orb/models/invoice_line_item_create_params.rb +0 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +6 -26
- data/lib/orb/models/invoice_list_params.rb +6 -10
- data/lib/orb/models/invoice_update_params.rb +0 -1
- data/lib/orb/models/item.rb +7 -8
- data/lib/orb/models/item_list_params.rb +0 -1
- data/lib/orb/models/item_update_params.rb +7 -7
- data/lib/orb/models/metric_create_params.rb +0 -1
- data/lib/orb/models/metric_list_params.rb +0 -1
- data/lib/orb/models/metric_update_params.rb +0 -1
- data/lib/orb/models/percentage_discount.rb +6 -8
- data/lib/orb/models/plan.rb +78 -103
- data/lib/orb/models/plan_create_params.rb +727 -800
- data/lib/orb/models/plan_list_params.rb +3 -4
- data/lib/orb/models/plan_update_params.rb +0 -2
- data/lib/orb/models/plans/external_plan_id_update_params.rb +0 -2
- data/lib/orb/models/price.rb +1671 -1724
- data/lib/orb/models/price_create_params.rb +75 -84
- data/lib/orb/models/price_evaluate_params.rb +0 -2
- data/lib/orb/models/price_evaluate_response.rb +3 -3
- data/lib/orb/models/price_list_params.rb +0 -1
- data/lib/orb/models/price_update_params.rb +0 -1
- data/lib/orb/models/prices/external_price_id_update_params.rb +0 -1
- data/lib/orb/models/subscription.rb +86 -122
- data/lib/orb/models/subscription_cancel_params.rb +3 -5
- data/lib/orb/models/subscription_cancel_response.rb +21 -57
- data/lib/orb/models/subscription_change_apply_response.rb +21 -58
- data/lib/orb/models/subscription_change_cancel_response.rb +21 -58
- data/lib/orb/models/subscription_change_retrieve_response.rb +21 -58
- data/lib/orb/models/subscription_create_params.rb +1865 -1815
- data/lib/orb/models/subscription_create_response.rb +21 -57
- data/lib/orb/models/subscription_fetch_costs_params.rb +3 -4
- data/lib/orb/models/subscription_fetch_costs_response.rb +3 -3
- data/lib/orb/models/subscription_fetch_schedule_params.rb +0 -1
- data/lib/orb/models/subscription_fetch_schedule_response.rb +0 -1
- data/lib/orb/models/subscription_fetch_usage_params.rb +6 -8
- data/lib/orb/models/subscription_list_params.rb +3 -4
- data/lib/orb/models/subscription_price_intervals_params.rb +1105 -1017
- data/lib/orb/models/subscription_price_intervals_response.rb +21 -57
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +1906 -1791
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +21 -57
- data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
- data/lib/orb/models/subscription_trigger_phase_response.rb +21 -57
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +21 -57
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +21 -57
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +21 -57
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +3 -6
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +21 -57
- data/lib/orb/models/subscription_update_params.rb +0 -5
- data/lib/orb/models/subscription_update_trial_params.rb +4 -6
- data/lib/orb/models/subscription_update_trial_response.rb +21 -57
- data/lib/orb/models/subscription_usage.rb +46 -39
- data/lib/orb/models/subscriptions.rb +6 -6
- data/lib/orb/models/trial_discount.rb +6 -7
- data/lib/orb/models/usage_discount.rb +6 -8
- data/lib/orb/resources/alerts.rb +30 -31
- data/lib/orb/resources/coupons/subscriptions.rb +3 -4
- data/lib/orb/resources/coupons.rb +11 -21
- data/lib/orb/resources/credit_notes.rb +10 -11
- data/lib/orb/resources/customers/balance_transactions.rb +3 -4
- data/lib/orb/resources/customers/costs.rb +4 -6
- data/lib/orb/resources/customers/credits/ledger.rb +14 -33
- data/lib/orb/resources/customers/credits/top_ups.rb +10 -20
- data/lib/orb/resources/customers/credits.rb +2 -6
- data/lib/orb/resources/customers.rb +40 -67
- data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +2 -2
- data/lib/orb/resources/dimensional_price_groups.rb +8 -10
- data/lib/orb/resources/events/backfills.rb +2 -10
- data/lib/orb/resources/events/volume.rb +3 -6
- data/lib/orb/resources/events.rb +4 -12
- data/lib/orb/resources/invoice_line_items.rb +1 -2
- data/lib/orb/resources/invoices.rb +26 -43
- data/lib/orb/resources/items.rb +12 -13
- data/lib/orb/resources/metrics.rb +11 -14
- data/lib/orb/resources/plans/external_plan_id.rb +5 -7
- data/lib/orb/resources/plans.rb +14 -23
- data/lib/orb/resources/prices/external_price_id.rb +5 -6
- data/lib/orb/resources/prices.rb +25 -35
- data/lib/orb/resources/subscription_changes.rb +1 -1
- data/lib/orb/resources/subscriptions.rb +49 -107
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +1 -0
- data/rbi/orb/client.rbi +5 -4
- data/rbi/orb/errors.rbi +59 -28
- data/rbi/orb/file_part.rbi +9 -6
- data/rbi/orb/internal/page.rbi +19 -6
- data/rbi/orb/internal/transport/base_client.rbi +131 -73
- data/rbi/orb/internal/transport/pooled_net_requester.rbi +25 -12
- data/rbi/orb/internal/type/array_of.rbi +42 -34
- data/rbi/orb/internal/type/base_model.rbi +124 -65
- data/rbi/orb/internal/type/base_page.rbi +11 -7
- data/rbi/orb/internal/type/boolean.rbi +16 -10
- data/rbi/orb/internal/type/converter.rbi +66 -31
- data/rbi/orb/internal/type/enum.rbi +27 -15
- data/rbi/orb/internal/type/file_input.rbi +12 -10
- data/rbi/orb/internal/type/hash_of.rbi +34 -24
- data/rbi/orb/internal/type/request_parameters.rbi +12 -4
- data/rbi/orb/internal/type/union.rbi +60 -25
- data/rbi/orb/internal/type/unknown.rbi +20 -12
- data/rbi/orb/internal/util.rbi +210 -89
- data/rbi/orb/models/alert.rbi +107 -70
- data/rbi/orb/models/alert_create_for_customer_params.rbi +60 -27
- data/rbi/orb/models/alert_create_for_external_customer_params.rbi +68 -29
- data/rbi/orb/models/alert_create_for_subscription_params.rbi +53 -26
- data/rbi/orb/models/alert_disable_params.rbi +17 -6
- data/rbi/orb/models/alert_enable_params.rbi +17 -6
- data/rbi/orb/models/alert_list_params.rbi +23 -20
- data/rbi/orb/models/alert_retrieve_params.rbi +10 -4
- data/rbi/orb/models/alert_update_params.rbi +25 -14
- data/rbi/orb/models/amount_discount.rbi +28 -19
- data/rbi/orb/models/billable_metric.rbi +33 -26
- data/rbi/orb/models/billing_cycle_relative_date.rbi +11 -5
- data/rbi/orb/models/coupon.rbi +28 -20
- data/rbi/orb/models/coupon_archive_params.rbi +10 -4
- data/rbi/orb/models/coupon_create_params.rbi +72 -38
- data/rbi/orb/models/coupon_fetch_params.rbi +10 -4
- data/rbi/orb/models/coupon_list_params.rbi +18 -15
- data/rbi/orb/models/coupons/subscription_list_params.rbi +16 -6
- data/rbi/orb/models/credit_note.rbi +293 -158
- data/rbi/orb/models/credit_note_create_params.rbi +58 -29
- data/rbi/orb/models/credit_note_fetch_params.rbi +10 -4
- data/rbi/orb/models/credit_note_list_params.rbi +20 -17
- data/rbi/orb/models/customer.rbi +430 -329
- data/rbi/orb/models/customer_create_params.rbi +662 -325
- data/rbi/orb/models/customer_delete_params.rbi +10 -4
- data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +10 -4
- data/rbi/orb/models/customer_fetch_params.rbi +10 -4
- data/rbi/orb/models/customer_list_params.rbi +20 -17
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +10 -4
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +10 -4
- data/rbi/orb/models/customer_update_by_external_id_params.rbi +1136 -336
- data/rbi/orb/models/customer_update_params.rbi +661 -324
- data/rbi/orb/models/customers/balance_transaction_create_params.rbi +50 -21
- data/rbi/orb/models/customers/balance_transaction_create_response.rbi +154 -61
- data/rbi/orb/models/customers/balance_transaction_list_params.rbi +20 -17
- data/rbi/orb/models/customers/balance_transaction_list_response.rbi +164 -59
- data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +56 -22
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +162 -124
- data/rbi/orb/models/customers/cost_list_params.rbi +45 -22
- data/rbi/orb/models/customers/cost_list_response.rbi +154 -123
- data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi +18 -15
- data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +48 -22
- data/rbi/orb/models/customers/credit_list_params.rbi +18 -15
- data/rbi/orb/models/customers/credit_list_response.rbi +44 -21
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +106 -68
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +643 -434
- data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +117 -59
- data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +700 -425
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +102 -44
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +681 -432
- data/rbi/orb/models/customers/credits/ledger_list_params.rbi +123 -40
- data/rbi/orb/models/customers/credits/ledger_list_response.rbi +735 -389
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +74 -53
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +65 -48
- data/rbi/orb/models/customers/credits/top_up_create_params.rbi +84 -45
- data/rbi/orb/models/customers/credits/top_up_create_response.rbi +83 -43
- data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +16 -6
- data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +15 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +9 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +70 -49
- data/rbi/orb/models/customers/credits/top_up_list_params.rbi +9 -5
- data/rbi/orb/models/customers/credits/top_up_list_response.rbi +84 -43
- data/rbi/orb/models/dimensional_price_group.rbi +18 -15
- data/rbi/orb/models/dimensional_price_group_create_params.rbi +19 -16
- data/rbi/orb/models/dimensional_price_group_list_params.rbi +16 -6
- data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +10 -4
- data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +10 -9
- data/rbi/orb/models/dimensional_price_groups.rbi +18 -13
- data/rbi/orb/models/discount.rbi +11 -5
- data/rbi/orb/models/evaluate_price_group.rbi +28 -12
- data/rbi/orb/models/event_deprecate_params.rbi +10 -4
- data/rbi/orb/models/event_deprecate_response.rbi +8 -3
- data/rbi/orb/models/event_ingest_params.rbi +37 -31
- data/rbi/orb/models/event_ingest_response.rbi +63 -23
- data/rbi/orb/models/event_search_params.rbi +17 -14
- data/rbi/orb/models/event_search_response.rbi +33 -21
- data/rbi/orb/models/event_update_params.rbi +19 -16
- data/rbi/orb/models/event_update_response.rbi +8 -3
- data/rbi/orb/models/events/backfill_close_params.rbi +10 -9
- data/rbi/orb/models/events/backfill_close_response.rbi +64 -29
- data/rbi/orb/models/events/backfill_create_params.rbi +21 -18
- data/rbi/orb/models/events/backfill_create_response.rbi +63 -29
- data/rbi/orb/models/events/backfill_fetch_params.rbi +10 -9
- data/rbi/orb/models/events/backfill_fetch_response.rbi +64 -29
- data/rbi/orb/models/events/backfill_list_params.rbi +16 -6
- data/rbi/orb/models/events/backfill_list_response.rbi +62 -28
- data/rbi/orb/models/events/backfill_revert_params.rbi +10 -9
- data/rbi/orb/models/events/backfill_revert_response.rbi +63 -29
- data/rbi/orb/models/events/event_volumes.rbi +32 -10
- data/rbi/orb/models/events/volume_list_params.rbi +18 -15
- data/rbi/orb/models/invoice.rbi +1286 -805
- data/rbi/orb/models/invoice_create_params.rbi +97 -69
- data/rbi/orb/models/invoice_fetch_params.rbi +10 -4
- data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +15 -5
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +1991 -861
- data/rbi/orb/models/invoice_issue_params.rbi +16 -5
- data/rbi/orb/models/invoice_level_discount.rbi +11 -4
- data/rbi/orb/models/invoice_line_item_create_params.rbi +20 -17
- data/rbi/orb/models/invoice_line_item_create_response.rbi +573 -376
- data/rbi/orb/models/invoice_list_params.rbi +67 -47
- data/rbi/orb/models/invoice_mark_paid_params.rbi +17 -14
- data/rbi/orb/models/invoice_pay_params.rbi +10 -4
- data/rbi/orb/models/invoice_update_params.rbi +15 -10
- data/rbi/orb/models/invoice_void_params.rbi +10 -4
- data/rbi/orb/models/item.rbi +87 -39
- data/rbi/orb/models/item_create_params.rbi +14 -5
- data/rbi/orb/models/item_fetch_params.rbi +10 -4
- data/rbi/orb/models/item_list_params.rbi +16 -6
- data/rbi/orb/models/item_update_params.rbi +79 -39
- data/rbi/orb/models/metric_create_params.rbi +19 -16
- data/rbi/orb/models/metric_fetch_params.rbi +10 -4
- data/rbi/orb/models/metric_list_params.rbi +20 -17
- data/rbi/orb/models/metric_update_params.rbi +15 -10
- data/rbi/orb/models/pagination_metadata.rbi +16 -4
- data/rbi/orb/models/percentage_discount.rbi +32 -19
- data/rbi/orb/models/plan.rbi +496 -365
- data/rbi/orb/models/plan_create_params.rbi +4785 -2875
- data/rbi/orb/models/plan_fetch_params.rbi +10 -4
- data/rbi/orb/models/plan_list_params.rbi +34 -27
- data/rbi/orb/models/plan_update_params.rbi +16 -13
- data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +10 -9
- data/rbi/orb/models/plans/external_plan_id_update_params.rbi +16 -13
- data/rbi/orb/models/price.rbi +9969 -5024
- data/rbi/orb/models/price_create_params.rbi +501 -245
- data/rbi/orb/models/price_evaluate_params.rbi +20 -17
- data/rbi/orb/models/price_evaluate_response.rbi +11 -6
- data/rbi/orb/models/price_fetch_params.rbi +10 -4
- data/rbi/orb/models/price_list_params.rbi +16 -6
- data/rbi/orb/models/price_update_params.rbi +15 -10
- data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +10 -9
- data/rbi/orb/models/prices/external_price_id_update_params.rbi +15 -10
- data/rbi/orb/models/subscription.rbi +578 -420
- data/rbi/orb/models/subscription_cancel_params.rbi +44 -22
- data/rbi/orb/models/subscription_cancel_response.rbi +700 -438
- data/rbi/orb/models/subscription_change_apply_params.rbi +16 -13
- data/rbi/orb/models/subscription_change_apply_response.rbi +784 -504
- data/rbi/orb/models/subscription_change_cancel_params.rbi +10 -4
- data/rbi/orb/models/subscription_change_cancel_response.rbi +783 -514
- data/rbi/orb/models/subscription_change_retrieve_params.rbi +10 -4
- data/rbi/orb/models/subscription_change_retrieve_response.rbi +782 -524
- data/rbi/orb/models/subscription_create_params.rbi +9021 -6730
- data/rbi/orb/models/subscription_create_response.rbi +700 -438
- data/rbi/orb/models/subscription_fetch_costs_params.rbi +47 -22
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +154 -123
- data/rbi/orb/models/subscription_fetch_params.rbi +10 -4
- data/rbi/orb/models/subscription_fetch_schedule_params.rbi +20 -17
- data/rbi/orb/models/subscription_fetch_schedule_response.rbi +33 -19
- data/rbi/orb/models/subscription_fetch_usage_params.rbi +81 -34
- data/rbi/orb/models/subscription_list_params.rbi +39 -28
- data/rbi/orb/models/subscription_price_intervals_params.rbi +5181 -3822
- data/rbi/orb/models/subscription_price_intervals_response.rbi +720 -453
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +8602 -6910
- data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +718 -467
- data/rbi/orb/models/subscription_trigger_phase_params.rbi +16 -13
- data/rbi/orb/models/subscription_trigger_phase_response.rbi +712 -448
- data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +10 -4
- data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +719 -467
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +16 -5
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +693 -502
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +10 -4
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +708 -497
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +57 -26
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +719 -467
- data/rbi/orb/models/subscription_update_params.rbi +19 -16
- data/rbi/orb/models/subscription_update_trial_params.rbi +57 -19
- data/rbi/orb/models/subscription_update_trial_response.rbi +712 -447
- data/rbi/orb/models/subscription_usage.rbi +271 -121
- data/rbi/orb/models/subscriptions.rbi +18 -11
- data/rbi/orb/models/top_level_ping_params.rbi +10 -4
- data/rbi/orb/models/top_level_ping_response.rbi +7 -3
- data/rbi/orb/models/trial_discount.rbi +29 -20
- data/rbi/orb/models/usage_discount.rbi +28 -19
- data/rbi/orb/models.rbi +22 -11
- data/rbi/orb/request_options.rbi +12 -6
- data/rbi/orb/resources/alerts.rbi +61 -40
- data/rbi/orb/resources/coupons/subscriptions.rbi +7 -5
- data/rbi/orb/resources/coupons.rbi +33 -18
- data/rbi/orb/resources/credit_notes.rbi +22 -13
- data/rbi/orb/resources/customers/balance_transactions.rbi +17 -9
- data/rbi/orb/resources/customers/costs.rbi +18 -11
- data/rbi/orb/resources/customers/credits/ledger.rbi +98 -74
- data/rbi/orb/resources/customers/credits/top_ups.rbi +61 -25
- data/rbi/orb/resources/customers/credits.rbi +16 -7
- data/rbi/orb/resources/customers.rbi +137 -72
- data/rbi/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +8 -4
- data/rbi/orb/resources/dimensional_price_groups.rbi +26 -12
- data/rbi/orb/resources/events/backfills.rbi +35 -17
- data/rbi/orb/resources/events/volume.rbi +7 -5
- data/rbi/orb/resources/events.rbi +26 -16
- data/rbi/orb/resources/invoice_line_items.rbi +7 -5
- data/rbi/orb/resources/invoices.rbi +72 -41
- data/rbi/orb/resources/items.rbi +40 -13
- data/rbi/orb/resources/metrics.rbi +25 -15
- data/rbi/orb/resources/plans/external_plan_id.rbi +15 -7
- data/rbi/orb/resources/plans.rbi +57 -47
- data/rbi/orb/resources/prices/external_price_id.rbi +73 -68
- data/rbi/orb/resources/prices.rbi +176 -156
- data/rbi/orb/resources/subscription_changes.rbi +19 -11
- data/rbi/orb/resources/subscriptions.rbi +200 -114
- data/rbi/orb/resources/top_level.rbi +9 -3
- data/sig/orb/internal/page.rbs +0 -2
- data/sig/orb/internal/type/request_parameters.rbs +3 -1
- data/sig/orb/models/alert.rbs +19 -31
- data/sig/orb/models/alert_create_for_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_subscription_params.rbs +3 -7
- data/sig/orb/models/alert_disable_params.rbs +0 -2
- data/sig/orb/models/alert_enable_params.rbs +0 -2
- data/sig/orb/models/alert_list_params.rbs +0 -2
- data/sig/orb/models/alert_retrieve_params.rbs +0 -2
- data/sig/orb/models/alert_update_params.rbs +3 -7
- data/sig/orb/models/amount_discount.rbs +4 -6
- data/sig/orb/models/billable_metric.rbs +7 -9
- data/sig/orb/models/coupon.rbs +5 -8
- data/sig/orb/models/coupon_archive_params.rbs +0 -2
- data/sig/orb/models/coupon_create_params.rbs +3 -9
- data/sig/orb/models/coupon_fetch_params.rbs +0 -2
- data/sig/orb/models/coupon_list_params.rbs +0 -2
- data/sig/orb/models/coupons/subscription_list_params.rbs +0 -2
- data/sig/orb/models/credit_note.rbs +48 -66
- data/sig/orb/models/credit_note_create_params.rbs +3 -7
- data/sig/orb/models/credit_note_fetch_params.rbs +0 -2
- data/sig/orb/models/credit_note_list_params.rbs +0 -2
- data/sig/orb/models/customer.rbs +43 -63
- data/sig/orb/models/customer_create_params.rbs +32 -52
- data/sig/orb/models/customer_delete_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_params.rbs +0 -2
- data/sig/orb/models/customer_list_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +0 -2
- data/sig/orb/models/customer_update_by_external_id_params.rbs +32 -52
- data/sig/orb/models/customer_update_params.rbs +32 -52
- data/sig/orb/models/customers/balance_transaction_create_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_create_response.rbs +0 -6
- data/sig/orb/models/customers/balance_transaction_list_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_list_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_response.rbs +0 -6
- data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +0 -2
- data/sig/orb/models/customers/credit_list_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_response.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +1 -43
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_create_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_delete_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_response.rbs +0 -4
- data/sig/orb/models/dimensional_price_group.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_create_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_list_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups.rbs +6 -8
- data/sig/orb/models/discount.rbs +5 -5
- data/sig/orb/models/evaluate_price_group.rbs +4 -6
- data/sig/orb/models/event_deprecate_params.rbs +0 -2
- data/sig/orb/models/event_deprecate_response.rbs +0 -2
- data/sig/orb/models/event_ingest_params.rbs +3 -7
- data/sig/orb/models/event_ingest_response.rbs +0 -6
- data/sig/orb/models/event_search_params.rbs +0 -2
- data/sig/orb/models/event_search_response.rbs +0 -4
- data/sig/orb/models/event_update_params.rbs +0 -2
- data/sig/orb/models/event_update_response.rbs +0 -2
- data/sig/orb/models/events/backfill_close_params.rbs +0 -2
- data/sig/orb/models/events/backfill_close_response.rbs +0 -2
- data/sig/orb/models/events/backfill_create_params.rbs +0 -2
- data/sig/orb/models/events/backfill_create_response.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_params.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_response.rbs +0 -2
- data/sig/orb/models/events/backfill_list_params.rbs +0 -2
- data/sig/orb/models/events/backfill_list_response.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_params.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_response.rbs +0 -2
- data/sig/orb/models/events/event_volumes.rbs +3 -10
- data/sig/orb/models/events/volume_list_params.rbs +0 -2
- data/sig/orb/models/invoice.rbs +110 -172
- data/sig/orb/models/invoice_create_params.rbs +10 -16
- data/sig/orb/models/invoice_fetch_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +2 -64
- data/sig/orb/models/invoice_issue_params.rbs +0 -2
- data/sig/orb/models/invoice_level_discount.rbs +2 -4
- data/sig/orb/models/invoice_line_item_create_params.rbs +0 -2
- data/sig/orb/models/invoice_line_item_create_response.rbs +2 -36
- data/sig/orb/models/invoice_list_params.rbs +4 -6
- data/sig/orb/models/invoice_mark_paid_params.rbs +0 -2
- data/sig/orb/models/invoice_pay_params.rbs +0 -2
- data/sig/orb/models/invoice_update_params.rbs +0 -2
- data/sig/orb/models/invoice_void_params.rbs +0 -2
- data/sig/orb/models/item.rbs +7 -11
- data/sig/orb/models/item_create_params.rbs +0 -2
- data/sig/orb/models/item_fetch_params.rbs +0 -2
- data/sig/orb/models/item_list_params.rbs +0 -2
- data/sig/orb/models/item_update_params.rbs +7 -11
- data/sig/orb/models/metric_create_params.rbs +0 -2
- data/sig/orb/models/metric_fetch_params.rbs +0 -2
- data/sig/orb/models/metric_list_params.rbs +0 -2
- data/sig/orb/models/metric_update_params.rbs +0 -2
- data/sig/orb/models/pagination_metadata.rbs +0 -2
- data/sig/orb/models/percentage_discount.rbs +4 -6
- data/sig/orb/models/plan.rbs +45 -73
- data/sig/orb/models/plan_create_params.rbs +518 -696
- data/sig/orb/models/plan_fetch_params.rbs +0 -2
- data/sig/orb/models/plan_list_params.rbs +0 -2
- data/sig/orb/models/plan_update_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +0 -2
- data/sig/orb/models/price.rbs +1194 -1730
- data/sig/orb/models/price_create_params.rbs +59 -97
- data/sig/orb/models/price_evaluate_params.rbs +0 -2
- data/sig/orb/models/price_evaluate_response.rbs +3 -6
- data/sig/orb/models/price_fetch_params.rbs +0 -2
- data/sig/orb/models/price_list_params.rbs +0 -2
- data/sig/orb/models/price_update_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_fetch_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_update_params.rbs +0 -2
- data/sig/orb/models/subscription.rbs +56 -94
- data/sig/orb/models/subscription_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_cancel_response.rbs +20 -60
- data/sig/orb/models/subscription_change_apply_params.rbs +0 -2
- data/sig/orb/models/subscription_change_apply_response.rbs +20 -62
- data/sig/orb/models/subscription_change_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_change_cancel_response.rbs +20 -62
- data/sig/orb/models/subscription_change_retrieve_params.rbs +0 -2
- data/sig/orb/models/subscription_change_retrieve_response.rbs +20 -62
- data/sig/orb/models/subscription_create_params.rbs +1103 -1499
- data/sig/orb/models/subscription_create_response.rbs +20 -60
- data/sig/orb/models/subscription_fetch_costs_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_costs_response.rbs +0 -6
- data/sig/orb/models/subscription_fetch_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_response.rbs +0 -4
- data/sig/orb/models/subscription_fetch_usage_params.rbs +0 -2
- data/sig/orb/models/subscription_list_params.rbs +0 -2
- data/sig/orb/models/subscription_price_intervals_params.rbs +666 -896
- data/sig/orb/models/subscription_price_intervals_response.rbs +20 -60
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1103 -1499
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +20 -60
- data/sig/orb/models/subscription_trigger_phase_params.rbs +0 -2
- data/sig/orb/models/subscription_trigger_phase_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +20 -60
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +0 -2
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +20 -60
- data/sig/orb/models/subscription_update_params.rbs +0 -2
- data/sig/orb/models/subscription_update_trial_params.rbs +1 -3
- data/sig/orb/models/subscription_update_trial_response.rbs +20 -60
- data/sig/orb/models/subscription_usage.rbs +35 -53
- data/sig/orb/models/subscriptions.rbs +6 -8
- data/sig/orb/models/top_level_ping_params.rbs +0 -2
- data/sig/orb/models/top_level_ping_response.rbs +0 -2
- data/sig/orb/models/trial_discount.rbs +4 -6
- data/sig/orb/models/usage_discount.rbs +4 -6
- data/sig/orb/request_options.rbs +1 -1
- data/sig/orb/resources/alerts.rbs +12 -12
- data/sig/orb/resources/coupons/subscriptions.rbs +1 -1
- data/sig/orb/resources/coupons.rbs +4 -4
- data/sig/orb/resources/credit_notes.rbs +4 -4
- data/sig/orb/resources/customers/credits/ledger.rbs +2 -2
- data/sig/orb/resources/customers/credits/top_ups.rbs +2 -2
- data/sig/orb/resources/customers.rbs +24 -24
- data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +1 -1
- data/sig/orb/resources/dimensional_price_groups.rbs +3 -3
- data/sig/orb/resources/events/volume.rbs +1 -1
- data/sig/orb/resources/events.rbs +1 -1
- data/sig/orb/resources/invoices.rbs +10 -10
- data/sig/orb/resources/items.rbs +5 -5
- data/sig/orb/resources/metrics.rbs +4 -4
- data/sig/orb/resources/plans/external_plan_id.rbs +2 -2
- data/sig/orb/resources/plans.rbs +5 -5
- data/sig/orb/resources/prices.rbs +11 -11
- data/sig/orb/resources/subscriptions.rbs +21 -21
- metadata +2 -2
@@ -6,7 +6,9 @@ module Orb
|
|
6
6
|
extend Orb::Internal::Type::RequestParameters::Converter
|
7
7
|
include Orb::Internal::Type::RequestParameters
|
8
8
|
|
9
|
-
|
9
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
10
|
+
|
11
|
+
sig { returns(T::Array[Orb::EventIngestParams::Event]) }
|
10
12
|
attr_accessor :events
|
11
13
|
|
12
14
|
# If this ingestion request is part of a backfill, this parameter ties the
|
@@ -23,12 +25,11 @@ module Orb
|
|
23
25
|
|
24
26
|
sig do
|
25
27
|
params(
|
26
|
-
events: T::Array[
|
28
|
+
events: T::Array[Orb::EventIngestParams::Event::OrHash],
|
27
29
|
backfill_id: T.nilable(String),
|
28
30
|
debug: T::Boolean,
|
29
|
-
request_options:
|
30
|
-
)
|
31
|
-
.returns(T.attached_class)
|
31
|
+
request_options: Orb::RequestOptions::OrHash
|
32
|
+
).returns(T.attached_class)
|
32
33
|
end
|
33
34
|
def self.new(
|
34
35
|
events:,
|
@@ -38,21 +39,25 @@ module Orb
|
|
38
39
|
# Flag to enable additional debug information in the endpoint response
|
39
40
|
debug: nil,
|
40
41
|
request_options: {}
|
41
|
-
)
|
42
|
+
)
|
43
|
+
end
|
44
|
+
|
42
45
|
sig do
|
43
|
-
override
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
46
|
+
override.returns(
|
47
|
+
{
|
48
|
+
events: T::Array[Orb::EventIngestParams::Event],
|
49
|
+
backfill_id: T.nilable(String),
|
50
|
+
debug: T::Boolean,
|
51
|
+
request_options: Orb::RequestOptions
|
52
|
+
}
|
53
|
+
)
|
54
|
+
end
|
55
|
+
def to_hash
|
52
56
|
end
|
53
|
-
def to_hash; end
|
54
57
|
|
55
58
|
class Event < Orb::Internal::Type::BaseModel
|
59
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
60
|
+
|
56
61
|
# A name to meaningfully identify the action or event type.
|
57
62
|
sig { returns(String) }
|
58
63
|
attr_accessor :event_name
|
@@ -91,8 +96,7 @@ module Orb
|
|
91
96
|
timestamp: Time,
|
92
97
|
customer_id: T.nilable(String),
|
93
98
|
external_customer_id: T.nilable(String)
|
94
|
-
)
|
95
|
-
.returns(T.attached_class)
|
99
|
+
).returns(T.attached_class)
|
96
100
|
end
|
97
101
|
def self.new(
|
98
102
|
# A name to meaningfully identify the action or event type.
|
@@ -113,21 +117,23 @@ module Orb
|
|
113
117
|
# An alias for the Orb customer, whose mapping is specified when creating the
|
114
118
|
# customer
|
115
119
|
external_customer_id: nil
|
116
|
-
)
|
120
|
+
)
|
121
|
+
end
|
122
|
+
|
117
123
|
sig do
|
118
|
-
override
|
119
|
-
|
120
|
-
|
121
|
-
|
122
|
-
|
123
|
-
|
124
|
-
|
125
|
-
|
126
|
-
|
127
|
-
|
128
|
-
|
124
|
+
override.returns(
|
125
|
+
{
|
126
|
+
event_name: String,
|
127
|
+
idempotency_key: String,
|
128
|
+
properties: T.anything,
|
129
|
+
timestamp: Time,
|
130
|
+
customer_id: T.nilable(String),
|
131
|
+
external_customer_id: T.nilable(String)
|
132
|
+
}
|
133
|
+
)
|
134
|
+
end
|
135
|
+
def to_hash
|
129
136
|
end
|
130
|
-
def to_hash; end
|
131
137
|
end
|
132
138
|
end
|
133
139
|
end
|
@@ -3,9 +3,13 @@
|
|
3
3
|
module Orb
|
4
4
|
module Models
|
5
5
|
class EventIngestResponse < Orb::Internal::Type::BaseModel
|
6
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
7
|
+
|
6
8
|
# Contains all failing validation events. In the case of a 200, this array will
|
7
9
|
# always be empty. This field will always be present.
|
8
|
-
sig
|
10
|
+
sig do
|
11
|
+
returns(T::Array[Orb::Models::EventIngestResponse::ValidationFailed])
|
12
|
+
end
|
9
13
|
attr_accessor :validation_failed
|
10
14
|
|
11
15
|
# Optional debug information (only present when debug=true is passed to the
|
@@ -13,15 +17,21 @@ module Orb
|
|
13
17
|
sig { returns(T.nilable(Orb::Models::EventIngestResponse::Debug)) }
|
14
18
|
attr_reader :debug
|
15
19
|
|
16
|
-
sig
|
20
|
+
sig do
|
21
|
+
params(
|
22
|
+
debug: T.nilable(Orb::Models::EventIngestResponse::Debug::OrHash)
|
23
|
+
).void
|
24
|
+
end
|
17
25
|
attr_writer :debug
|
18
26
|
|
19
27
|
sig do
|
20
28
|
params(
|
21
|
-
validation_failed:
|
22
|
-
|
23
|
-
|
24
|
-
|
29
|
+
validation_failed:
|
30
|
+
T::Array[
|
31
|
+
Orb::Models::EventIngestResponse::ValidationFailed::OrHash
|
32
|
+
],
|
33
|
+
debug: T.nilable(Orb::Models::EventIngestResponse::Debug::OrHash)
|
34
|
+
).returns(T.attached_class)
|
25
35
|
end
|
26
36
|
def self.new(
|
27
37
|
# Contains all failing validation events. In the case of a 200, this array will
|
@@ -30,19 +40,24 @@ module Orb
|
|
30
40
|
# Optional debug information (only present when debug=true is passed to the
|
31
41
|
# endpoint). Contains ingested and duplicate event idempotency keys.
|
32
42
|
debug: nil
|
33
|
-
)
|
43
|
+
)
|
44
|
+
end
|
45
|
+
|
34
46
|
sig do
|
35
|
-
override
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
47
|
+
override.returns(
|
48
|
+
{
|
49
|
+
validation_failed:
|
50
|
+
T::Array[Orb::Models::EventIngestResponse::ValidationFailed],
|
51
|
+
debug: T.nilable(Orb::Models::EventIngestResponse::Debug)
|
52
|
+
}
|
53
|
+
)
|
54
|
+
end
|
55
|
+
def to_hash
|
42
56
|
end
|
43
|
-
def to_hash; end
|
44
57
|
|
45
58
|
class ValidationFailed < Orb::Internal::Type::BaseModel
|
59
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
60
|
+
|
46
61
|
# The passed idempotency_key corresponding to the validation_errors
|
47
62
|
sig { returns(String) }
|
48
63
|
attr_accessor :idempotency_key
|
@@ -52,19 +67,33 @@ module Orb
|
|
52
67
|
sig { returns(T::Array[String]) }
|
53
68
|
attr_accessor :validation_errors
|
54
69
|
|
55
|
-
sig
|
70
|
+
sig do
|
71
|
+
params(
|
72
|
+
idempotency_key: String,
|
73
|
+
validation_errors: T::Array[String]
|
74
|
+
).returns(T.attached_class)
|
75
|
+
end
|
56
76
|
def self.new(
|
57
77
|
# The passed idempotency_key corresponding to the validation_errors
|
58
78
|
idempotency_key:,
|
59
79
|
# An array of strings corresponding to validation failures for this
|
60
80
|
# idempotency_key.
|
61
81
|
validation_errors:
|
62
|
-
)
|
63
|
-
|
64
|
-
|
82
|
+
)
|
83
|
+
end
|
84
|
+
|
85
|
+
sig do
|
86
|
+
override.returns(
|
87
|
+
{ idempotency_key: String, validation_errors: T::Array[String] }
|
88
|
+
)
|
89
|
+
end
|
90
|
+
def to_hash
|
91
|
+
end
|
65
92
|
end
|
66
93
|
|
67
94
|
class Debug < Orb::Internal::Type::BaseModel
|
95
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
96
|
+
|
68
97
|
sig { returns(T::Array[String]) }
|
69
98
|
attr_accessor :duplicate
|
70
99
|
|
@@ -73,11 +102,22 @@ module Orb
|
|
73
102
|
|
74
103
|
# Optional debug information (only present when debug=true is passed to the
|
75
104
|
# endpoint). Contains ingested and duplicate event idempotency keys.
|
76
|
-
sig
|
77
|
-
|
105
|
+
sig do
|
106
|
+
params(
|
107
|
+
duplicate: T::Array[String],
|
108
|
+
ingested: T::Array[String]
|
109
|
+
).returns(T.attached_class)
|
110
|
+
end
|
111
|
+
def self.new(duplicate:, ingested:)
|
112
|
+
end
|
78
113
|
|
79
|
-
sig
|
80
|
-
|
114
|
+
sig do
|
115
|
+
override.returns(
|
116
|
+
{ duplicate: T::Array[String], ingested: T::Array[String] }
|
117
|
+
)
|
118
|
+
end
|
119
|
+
def to_hash
|
120
|
+
end
|
81
121
|
end
|
82
122
|
end
|
83
123
|
end
|
@@ -6,6 +6,8 @@ module Orb
|
|
6
6
|
extend Orb::Internal::Type::RequestParameters::Converter
|
7
7
|
include Orb::Internal::Type::RequestParameters
|
8
8
|
|
9
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
10
|
+
|
9
11
|
# This is an explicit array of IDs to filter by. Note that an event's ID is the
|
10
12
|
# idempotency_key that was originally used for ingestion, and this only supports
|
11
13
|
# events that have not been amended. Values in this array will be treated case
|
@@ -28,9 +30,8 @@ module Orb
|
|
28
30
|
event_ids: T::Array[String],
|
29
31
|
timeframe_end: T.nilable(Time),
|
30
32
|
timeframe_start: T.nilable(Time),
|
31
|
-
request_options:
|
32
|
-
)
|
33
|
-
.returns(T.attached_class)
|
33
|
+
request_options: Orb::RequestOptions::OrHash
|
34
|
+
).returns(T.attached_class)
|
34
35
|
end
|
35
36
|
def self.new(
|
36
37
|
# This is an explicit array of IDs to filter by. Note that an event's ID is the
|
@@ -45,19 +46,21 @@ module Orb
|
|
45
46
|
# specified, the one week ago is used.
|
46
47
|
timeframe_start: nil,
|
47
48
|
request_options: {}
|
48
|
-
)
|
49
|
+
)
|
50
|
+
end
|
51
|
+
|
49
52
|
sig do
|
50
|
-
override
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
|
55
|
-
|
56
|
-
|
57
|
-
|
58
|
-
|
53
|
+
override.returns(
|
54
|
+
{
|
55
|
+
event_ids: T::Array[String],
|
56
|
+
timeframe_end: T.nilable(Time),
|
57
|
+
timeframe_start: T.nilable(Time),
|
58
|
+
request_options: Orb::RequestOptions
|
59
|
+
}
|
60
|
+
)
|
61
|
+
end
|
62
|
+
def to_hash
|
59
63
|
end
|
60
|
-
def to_hash; end
|
61
64
|
end
|
62
65
|
end
|
63
66
|
end
|
@@ -3,19 +3,30 @@
|
|
3
3
|
module Orb
|
4
4
|
module Models
|
5
5
|
class EventSearchResponse < Orb::Internal::Type::BaseModel
|
6
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
7
|
+
|
6
8
|
sig { returns(T::Array[Orb::Models::EventSearchResponse::Data]) }
|
7
9
|
attr_accessor :data
|
8
10
|
|
9
11
|
sig do
|
10
|
-
params(
|
11
|
-
|
12
|
+
params(
|
13
|
+
data: T::Array[Orb::Models::EventSearchResponse::Data::OrHash]
|
14
|
+
).returns(T.attached_class)
|
15
|
+
end
|
16
|
+
def self.new(data:)
|
12
17
|
end
|
13
|
-
def self.new(data:); end
|
14
18
|
|
15
|
-
sig
|
16
|
-
|
19
|
+
sig do
|
20
|
+
override.returns(
|
21
|
+
{ data: T::Array[Orb::Models::EventSearchResponse::Data] }
|
22
|
+
)
|
23
|
+
end
|
24
|
+
def to_hash
|
25
|
+
end
|
17
26
|
|
18
27
|
class Data < Orb::Internal::Type::BaseModel
|
28
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
29
|
+
|
19
30
|
# A unique value, generated by the client, that is used to de-duplicate events.
|
20
31
|
# Exactly one event with a given idempotency key will be ingested, which allows
|
21
32
|
# for safe request retries.
|
@@ -62,8 +73,7 @@ module Orb
|
|
62
73
|
external_customer_id: T.nilable(String),
|
63
74
|
properties: T.anything,
|
64
75
|
timestamp: Time
|
65
|
-
)
|
66
|
-
.returns(T.attached_class)
|
76
|
+
).returns(T.attached_class)
|
67
77
|
end
|
68
78
|
def self.new(
|
69
79
|
# A unique value, generated by the client, that is used to de-duplicate events.
|
@@ -86,22 +96,24 @@ module Orb
|
|
86
96
|
# represent the time that usage was recorded, and is particularly important to
|
87
97
|
# attribute usage to a given billing period.
|
88
98
|
timestamp:
|
89
|
-
)
|
99
|
+
)
|
100
|
+
end
|
101
|
+
|
90
102
|
sig do
|
91
|
-
override
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
|
98
|
-
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
|
103
|
+
override.returns(
|
104
|
+
{
|
105
|
+
id: String,
|
106
|
+
customer_id: T.nilable(String),
|
107
|
+
deprecated: T::Boolean,
|
108
|
+
event_name: String,
|
109
|
+
external_customer_id: T.nilable(String),
|
110
|
+
properties: T.anything,
|
111
|
+
timestamp: Time
|
112
|
+
}
|
113
|
+
)
|
114
|
+
end
|
115
|
+
def to_hash
|
103
116
|
end
|
104
|
-
def to_hash; end
|
105
117
|
end
|
106
118
|
end
|
107
119
|
end
|
@@ -6,6 +6,8 @@ module Orb
|
|
6
6
|
extend Orb::Internal::Type::RequestParameters::Converter
|
7
7
|
include Orb::Internal::Type::RequestParameters
|
8
8
|
|
9
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
10
|
+
|
9
11
|
# A name to meaningfully identify the action or event type.
|
10
12
|
sig { returns(String) }
|
11
13
|
attr_accessor :event_name
|
@@ -37,9 +39,8 @@ module Orb
|
|
37
39
|
timestamp: Time,
|
38
40
|
customer_id: T.nilable(String),
|
39
41
|
external_customer_id: T.nilable(String),
|
40
|
-
request_options:
|
41
|
-
)
|
42
|
-
.returns(T.attached_class)
|
42
|
+
request_options: Orb::RequestOptions::OrHash
|
43
|
+
).returns(T.attached_class)
|
43
44
|
end
|
44
45
|
def self.new(
|
45
46
|
# A name to meaningfully identify the action or event type.
|
@@ -57,21 +58,23 @@ module Orb
|
|
57
58
|
# customer
|
58
59
|
external_customer_id: nil,
|
59
60
|
request_options: {}
|
60
|
-
)
|
61
|
+
)
|
62
|
+
end
|
63
|
+
|
61
64
|
sig do
|
62
|
-
override
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
|
68
|
-
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
65
|
+
override.returns(
|
66
|
+
{
|
67
|
+
event_name: String,
|
68
|
+
properties: T.anything,
|
69
|
+
timestamp: Time,
|
70
|
+
customer_id: T.nilable(String),
|
71
|
+
external_customer_id: T.nilable(String),
|
72
|
+
request_options: Orb::RequestOptions
|
73
|
+
}
|
74
|
+
)
|
75
|
+
end
|
76
|
+
def to_hash
|
73
77
|
end
|
74
|
-
def to_hash; end
|
75
78
|
end
|
76
79
|
end
|
77
80
|
end
|
@@ -3,6 +3,8 @@
|
|
3
3
|
module Orb
|
4
4
|
module Models
|
5
5
|
class EventUpdateResponse < Orb::Internal::Type::BaseModel
|
6
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
7
|
+
|
6
8
|
# event_id of the amended event, if successfully ingested
|
7
9
|
sig { returns(String) }
|
8
10
|
attr_accessor :amended
|
@@ -11,9 +13,12 @@ module Orb
|
|
11
13
|
def self.new(
|
12
14
|
# event_id of the amended event, if successfully ingested
|
13
15
|
amended:
|
14
|
-
)
|
15
|
-
|
16
|
-
|
16
|
+
)
|
17
|
+
end
|
18
|
+
|
19
|
+
sig { override.returns({ amended: String }) }
|
20
|
+
def to_hash
|
21
|
+
end
|
17
22
|
end
|
18
23
|
end
|
19
24
|
end
|
@@ -7,18 +7,19 @@ module Orb
|
|
7
7
|
extend Orb::Internal::Type::RequestParameters::Converter
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
9
9
|
|
10
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
11
|
+
|
10
12
|
sig do
|
11
|
-
params(
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
).returns(T.attached_class)
|
13
|
+
params(request_options: Orb::RequestOptions::OrHash).returns(
|
14
|
+
T.attached_class
|
15
|
+
)
|
16
|
+
end
|
17
|
+
def self.new(request_options: {})
|
17
18
|
end
|
18
|
-
def self.new(request_options: {}); end
|
19
19
|
|
20
|
-
sig { override.returns({request_options: Orb::RequestOptions}) }
|
21
|
-
def to_hash
|
20
|
+
sig { override.returns({ request_options: Orb::RequestOptions }) }
|
21
|
+
def to_hash
|
22
|
+
end
|
22
23
|
end
|
23
24
|
end
|
24
25
|
end
|
@@ -4,6 +4,8 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
module Events
|
6
6
|
class BackfillCloseResponse < Orb::Internal::Type::BaseModel
|
7
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
8
|
+
|
7
9
|
sig { returns(String) }
|
8
10
|
attr_accessor :id
|
9
11
|
|
@@ -35,7 +37,11 @@ module Orb
|
|
35
37
|
attr_accessor :reverted_at
|
36
38
|
|
37
39
|
# The status of the backfill.
|
38
|
-
sig
|
40
|
+
sig do
|
41
|
+
returns(
|
42
|
+
Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol
|
43
|
+
)
|
44
|
+
end
|
39
45
|
attr_accessor :status
|
40
46
|
|
41
47
|
sig { returns(Time) }
|
@@ -61,12 +67,12 @@ module Orb
|
|
61
67
|
events_ingested: Integer,
|
62
68
|
replace_existing_events: T::Boolean,
|
63
69
|
reverted_at: T.nilable(Time),
|
64
|
-
status:
|
70
|
+
status:
|
71
|
+
Orb::Models::Events::BackfillCloseResponse::Status::OrSymbol,
|
65
72
|
timeframe_end: Time,
|
66
73
|
timeframe_start: Time,
|
67
74
|
deprecation_filter: T.nilable(String)
|
68
|
-
)
|
69
|
-
.returns(T.attached_class)
|
75
|
+
).returns(T.attached_class)
|
70
76
|
end
|
71
77
|
def self.new(
|
72
78
|
id:,
|
@@ -93,41 +99,70 @@ module Orb
|
|
93
99
|
# [computed property](/extensibility/advanced-metrics#computed-properties) used to
|
94
100
|
# filter the set of events to deprecate
|
95
101
|
deprecation_filter: nil
|
96
|
-
)
|
102
|
+
)
|
103
|
+
end
|
104
|
+
|
97
105
|
sig do
|
98
|
-
override
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
|
103
|
-
|
104
|
-
|
105
|
-
|
106
|
-
|
107
|
-
|
108
|
-
|
109
|
-
|
110
|
-
|
111
|
-
|
112
|
-
|
113
|
-
|
106
|
+
override.returns(
|
107
|
+
{
|
108
|
+
id: String,
|
109
|
+
close_time: T.nilable(Time),
|
110
|
+
created_at: Time,
|
111
|
+
customer_id: T.nilable(String),
|
112
|
+
events_ingested: Integer,
|
113
|
+
replace_existing_events: T::Boolean,
|
114
|
+
reverted_at: T.nilable(Time),
|
115
|
+
status:
|
116
|
+
Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol,
|
117
|
+
timeframe_end: Time,
|
118
|
+
timeframe_start: Time,
|
119
|
+
deprecation_filter: T.nilable(String)
|
120
|
+
}
|
121
|
+
)
|
122
|
+
end
|
123
|
+
def to_hash
|
114
124
|
end
|
115
|
-
def to_hash; end
|
116
125
|
|
117
126
|
# The status of the backfill.
|
118
127
|
module Status
|
119
128
|
extend Orb::Internal::Type::Enum
|
120
129
|
|
121
|
-
TaggedSymbol =
|
130
|
+
TaggedSymbol =
|
131
|
+
T.type_alias do
|
132
|
+
T.all(Symbol, Orb::Models::Events::BackfillCloseResponse::Status)
|
133
|
+
end
|
122
134
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
123
135
|
|
124
|
-
PENDING =
|
125
|
-
|
126
|
-
|
127
|
-
|
136
|
+
PENDING =
|
137
|
+
T.let(
|
138
|
+
:pending,
|
139
|
+
Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol
|
140
|
+
)
|
141
|
+
REFLECTED =
|
142
|
+
T.let(
|
143
|
+
:reflected,
|
144
|
+
Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol
|
145
|
+
)
|
146
|
+
PENDING_REVERT =
|
147
|
+
T.let(
|
148
|
+
:pending_revert,
|
149
|
+
Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol
|
150
|
+
)
|
151
|
+
REVERTED =
|
152
|
+
T.let(
|
153
|
+
:reverted,
|
154
|
+
Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol
|
155
|
+
)
|
128
156
|
|
129
|
-
sig
|
130
|
-
|
157
|
+
sig do
|
158
|
+
override.returns(
|
159
|
+
T::Array[
|
160
|
+
Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol
|
161
|
+
]
|
162
|
+
)
|
163
|
+
end
|
164
|
+
def self.values
|
165
|
+
end
|
131
166
|
end
|
132
167
|
end
|
133
168
|
end
|