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
@@ -23,22 +23,18 @@ module Orb
|
|
23
23
|
# @param amount [String] The amount to increment when the threshold is reached.
|
24
24
|
#
|
25
25
|
# @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo
|
26
|
-
# ...
|
27
26
|
#
|
28
|
-
# @param invoice_settings [Orb::
|
27
|
+
# @param invoice_settings [Orb::Customers::Credits::TopUpCreateParams::InvoiceSettings] Settings for invoices generated by triggered top-ups.
|
29
28
|
#
|
30
29
|
# @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit.
|
31
30
|
#
|
32
31
|
# @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this
|
33
|
-
# ...
|
34
32
|
#
|
35
33
|
# @param active_from [Time, nil] The date from which the top-up is active. If unspecified, the top-up is active i
|
36
|
-
# ...
|
37
34
|
#
|
38
35
|
# @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it
|
39
|
-
# ...
|
40
36
|
#
|
41
|
-
# @param expires_after_unit [Symbol, Orb::
|
37
|
+
# @param expires_after_unit [Symbol, Orb::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit, nil] The unit of expires_after.
|
42
38
|
#
|
43
39
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
44
40
|
#
|
@@ -46,7 +42,7 @@ module Orb
|
|
46
42
|
#
|
47
43
|
# @see Orb::Models::Customers::Credits::TopUpCreateParams
|
48
44
|
def create(customer_id, params)
|
49
|
-
parsed, options = Orb::
|
45
|
+
parsed, options = Orb::Customers::Credits::TopUpCreateParams.dump_request(params)
|
50
46
|
@client.request(
|
51
47
|
method: :post,
|
52
48
|
path: ["customers/%1$s/credits/top_ups", customer_id],
|
@@ -66,7 +62,6 @@ module Orb
|
|
66
62
|
# @param customer_id [String]
|
67
63
|
#
|
68
64
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
69
|
-
# ...
|
70
65
|
#
|
71
66
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
72
67
|
#
|
@@ -76,7 +71,7 @@ module Orb
|
|
76
71
|
#
|
77
72
|
# @see Orb::Models::Customers::Credits::TopUpListParams
|
78
73
|
def list(customer_id, params = {})
|
79
|
-
parsed, options = Orb::
|
74
|
+
parsed, options = Orb::Customers::Credits::TopUpListParams.dump_request(params)
|
80
75
|
@client.request(
|
81
76
|
method: :get,
|
82
77
|
path: ["customers/%1$s/credits/top_ups", customer_id],
|
@@ -100,7 +95,7 @@ module Orb
|
|
100
95
|
#
|
101
96
|
# @see Orb::Models::Customers::Credits::TopUpDeleteParams
|
102
97
|
def delete(top_up_id, params)
|
103
|
-
parsed, options = Orb::
|
98
|
+
parsed, options = Orb::Customers::Credits::TopUpDeleteParams.dump_request(params)
|
104
99
|
customer_id =
|
105
100
|
parsed.delete(:customer_id) do
|
106
101
|
raise ArgumentError.new("missing required path argument #{_1}")
|
@@ -132,22 +127,18 @@ module Orb
|
|
132
127
|
# @param amount [String] The amount to increment when the threshold is reached.
|
133
128
|
#
|
134
129
|
# @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo
|
135
|
-
# ...
|
136
130
|
#
|
137
|
-
# @param invoice_settings [Orb::
|
131
|
+
# @param invoice_settings [Orb::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings] Settings for invoices generated by triggered top-ups.
|
138
132
|
#
|
139
133
|
# @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit.
|
140
134
|
#
|
141
135
|
# @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this
|
142
|
-
# ...
|
143
136
|
#
|
144
137
|
# @param active_from [Time, nil] The date from which the top-up is active. If unspecified, the top-up is active i
|
145
|
-
# ...
|
146
138
|
#
|
147
139
|
# @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it
|
148
|
-
# ...
|
149
140
|
#
|
150
|
-
# @param expires_after_unit [Symbol, Orb::
|
141
|
+
# @param expires_after_unit [Symbol, Orb::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit, nil] The unit of expires_after.
|
151
142
|
#
|
152
143
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
153
144
|
#
|
@@ -155,7 +146,7 @@ module Orb
|
|
155
146
|
#
|
156
147
|
# @see Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams
|
157
148
|
def create_by_external_id(external_customer_id, params)
|
158
|
-
parsed, options = Orb::
|
149
|
+
parsed, options = Orb::Customers::Credits::TopUpCreateByExternalIDParams.dump_request(params)
|
159
150
|
@client.request(
|
160
151
|
method: :post,
|
161
152
|
path: ["customers/external_customer_id/%1$s/credits/top_ups", external_customer_id],
|
@@ -178,7 +169,7 @@ module Orb
|
|
178
169
|
#
|
179
170
|
# @see Orb::Models::Customers::Credits::TopUpDeleteByExternalIDParams
|
180
171
|
def delete_by_external_id(top_up_id, params)
|
181
|
-
parsed, options = Orb::
|
172
|
+
parsed, options = Orb::Customers::Credits::TopUpDeleteByExternalIDParams.dump_request(params)
|
182
173
|
external_customer_id =
|
183
174
|
parsed.delete(:external_customer_id) do
|
184
175
|
raise ArgumentError.new("missing required path argument #{_1}")
|
@@ -205,7 +196,6 @@ module Orb
|
|
205
196
|
# @param external_customer_id [String]
|
206
197
|
#
|
207
198
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
208
|
-
# ...
|
209
199
|
#
|
210
200
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
211
201
|
#
|
@@ -215,7 +205,7 @@ module Orb
|
|
215
205
|
#
|
216
206
|
# @see Orb::Models::Customers::Credits::TopUpListByExternalIDParams
|
217
207
|
def list_by_external_id(external_customer_id, params = {})
|
218
|
-
parsed, options = Orb::
|
208
|
+
parsed, options = Orb::Customers::Credits::TopUpListByExternalIDParams.dump_request(params)
|
219
209
|
@client.request(
|
220
210
|
method: :get,
|
221
211
|
path: ["customers/external_customer_id/%1$s/credits/top_ups", external_customer_id],
|
@@ -28,10 +28,8 @@ module Orb
|
|
28
28
|
# @param currency [String, nil] The ledger currency or custom pricing unit to use.
|
29
29
|
#
|
30
30
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
31
|
-
# ...
|
32
31
|
#
|
33
32
|
# @param include_all_blocks [Boolean] If set to True, all expired and depleted blocks, as well as active block will be
|
34
|
-
# ...
|
35
33
|
#
|
36
34
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
37
35
|
#
|
@@ -41,7 +39,7 @@ module Orb
|
|
41
39
|
#
|
42
40
|
# @see Orb::Models::Customers::CreditListParams
|
43
41
|
def list(customer_id, params = {})
|
44
|
-
parsed, options = Orb::
|
42
|
+
parsed, options = Orb::Customers::CreditListParams.dump_request(params)
|
45
43
|
@client.request(
|
46
44
|
method: :get,
|
47
45
|
path: ["customers/%1$s/credits", customer_id],
|
@@ -70,10 +68,8 @@ module Orb
|
|
70
68
|
# @param currency [String, nil] The ledger currency or custom pricing unit to use.
|
71
69
|
#
|
72
70
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
73
|
-
# ...
|
74
71
|
#
|
75
72
|
# @param include_all_blocks [Boolean] If set to True, all expired and depleted blocks, as well as active block will be
|
76
|
-
# ...
|
77
73
|
#
|
78
74
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
79
75
|
#
|
@@ -83,7 +79,7 @@ module Orb
|
|
83
79
|
#
|
84
80
|
# @see Orb::Models::Customers::CreditListByExternalIDParams
|
85
81
|
def list_by_external_id(external_customer_id, params = {})
|
86
|
-
parsed, options = Orb::
|
82
|
+
parsed, options = Orb::Customers::CreditListByExternalIDParams.dump_request(params)
|
87
83
|
@client.request(
|
88
84
|
method: :get,
|
89
85
|
path: ["customers/external_customer_id/%1$s/credits", external_customer_id],
|
@@ -31,63 +31,53 @@ module Orb
|
|
31
31
|
# @overload create(email:, name:, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, timezone: nil, request_options: {})
|
32
32
|
#
|
33
33
|
# @param email [String] A valid customer email, to be used for notifications. When Orb triggers payment
|
34
|
-
# ...
|
35
34
|
#
|
36
35
|
# @param name [String] The full name of the customer
|
37
36
|
#
|
38
|
-
# @param accounting_sync_configuration [Orb::
|
37
|
+
# @param accounting_sync_configuration [Orb::CustomerCreateParams::AccountingSyncConfiguration, nil]
|
39
38
|
#
|
40
39
|
# @param additional_emails [Array<String>, nil] Additional email addresses for this customer. If populated, these email addresse
|
41
|
-
# ...
|
42
40
|
#
|
43
41
|
# @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch
|
44
|
-
# ...
|
45
42
|
#
|
46
|
-
# @param billing_address [Orb::
|
43
|
+
# @param billing_address [Orb::CustomerCreateParams::BillingAddress, nil]
|
47
44
|
#
|
48
45
|
# @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
|
49
|
-
# ...
|
50
46
|
#
|
51
47
|
# @param email_delivery [Boolean, nil]
|
52
48
|
#
|
53
49
|
# @param external_customer_id [String, nil] An optional user-defined ID for this customer resource, used throughout the syst
|
54
|
-
# ...
|
55
50
|
#
|
56
|
-
# @param hierarchy [Orb::
|
51
|
+
# @param hierarchy [Orb::CustomerCreateParams::Hierarchy, nil] The hierarchical relationships for this customer.
|
57
52
|
#
|
58
53
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
59
|
-
# ...
|
60
54
|
#
|
61
|
-
# @param payment_provider [Symbol, Orb::
|
62
|
-
# ...
|
55
|
+
# @param payment_provider [Symbol, Orb::CustomerCreateParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
|
63
56
|
#
|
64
57
|
# @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
|
65
|
-
# ...
|
66
58
|
#
|
67
|
-
# @param reporting_configuration [Orb::
|
59
|
+
# @param reporting_configuration [Orb::CustomerCreateParams::ReportingConfiguration, nil]
|
68
60
|
#
|
69
|
-
# @param shipping_address [Orb::
|
61
|
+
# @param shipping_address [Orb::CustomerCreateParams::ShippingAddress, nil]
|
70
62
|
#
|
71
|
-
# @param tax_configuration [Orb::
|
63
|
+
# @param tax_configuration [Orb::CustomerCreateParams::TaxConfiguration::Avalara, Orb::CustomerCreateParams::TaxConfiguration::Taxjar, nil]
|
72
64
|
#
|
73
|
-
# @param tax_id [Orb::
|
74
|
-
# ...
|
65
|
+
# @param tax_id [Orb::CustomerCreateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
|
75
66
|
#
|
76
67
|
# @param timezone [String, nil] A timezone identifier from the IANA timezone database, such as `"America/Los_Ang
|
77
|
-
# ...
|
78
68
|
#
|
79
69
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
80
70
|
#
|
81
|
-
# @return [Orb::
|
71
|
+
# @return [Orb::Customer]
|
82
72
|
#
|
83
73
|
# @see Orb::Models::CustomerCreateParams
|
84
74
|
def create(params)
|
85
|
-
parsed, options = Orb::
|
75
|
+
parsed, options = Orb::CustomerCreateParams.dump_request(params)
|
86
76
|
@client.request(
|
87
77
|
method: :post,
|
88
78
|
path: "customers",
|
89
79
|
body: parsed,
|
90
|
-
model: Orb::
|
80
|
+
model: Orb::Customer,
|
91
81
|
options: options
|
92
82
|
)
|
93
83
|
end
|
@@ -105,60 +95,52 @@ module Orb
|
|
105
95
|
#
|
106
96
|
# @param customer_id [String]
|
107
97
|
#
|
108
|
-
# @param accounting_sync_configuration [Orb::
|
98
|
+
# @param accounting_sync_configuration [Orb::CustomerUpdateParams::AccountingSyncConfiguration, nil]
|
109
99
|
#
|
110
100
|
# @param additional_emails [Array<String>, nil] Additional email addresses for this customer. If populated, these email addresse
|
111
|
-
# ...
|
112
101
|
#
|
113
102
|
# @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch
|
114
|
-
# ...
|
115
103
|
#
|
116
|
-
# @param billing_address [Orb::
|
104
|
+
# @param billing_address [Orb::CustomerUpdateParams::BillingAddress, nil]
|
117
105
|
#
|
118
106
|
# @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
|
119
|
-
# ...
|
120
107
|
#
|
121
108
|
# @param email [String, nil] A valid customer email, to be used for invoicing and notifications.
|
122
109
|
#
|
123
110
|
# @param email_delivery [Boolean, nil]
|
124
111
|
#
|
125
112
|
# @param external_customer_id [String, nil] The external customer ID. This can only be set if empty and the customer has no
|
126
|
-
# ...
|
127
113
|
#
|
128
|
-
# @param hierarchy [Orb::
|
114
|
+
# @param hierarchy [Orb::CustomerUpdateParams::Hierarchy, nil] The hierarchical relationships for this customer.
|
129
115
|
#
|
130
116
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
131
|
-
# ...
|
132
117
|
#
|
133
118
|
# @param name [String, nil] The full name of the customer
|
134
119
|
#
|
135
|
-
# @param payment_provider [Symbol, Orb::
|
136
|
-
# ...
|
120
|
+
# @param payment_provider [Symbol, Orb::CustomerUpdateParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
|
137
121
|
#
|
138
122
|
# @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
|
139
|
-
# ...
|
140
123
|
#
|
141
|
-
# @param reporting_configuration [Orb::
|
124
|
+
# @param reporting_configuration [Orb::CustomerUpdateParams::ReportingConfiguration, nil]
|
142
125
|
#
|
143
|
-
# @param shipping_address [Orb::
|
126
|
+
# @param shipping_address [Orb::CustomerUpdateParams::ShippingAddress, nil]
|
144
127
|
#
|
145
|
-
# @param tax_configuration [Orb::
|
128
|
+
# @param tax_configuration [Orb::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::CustomerUpdateParams::TaxConfiguration::Taxjar, nil]
|
146
129
|
#
|
147
|
-
# @param tax_id [Orb::
|
148
|
-
# ...
|
130
|
+
# @param tax_id [Orb::CustomerUpdateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
|
149
131
|
#
|
150
132
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
151
133
|
#
|
152
|
-
# @return [Orb::
|
134
|
+
# @return [Orb::Customer]
|
153
135
|
#
|
154
136
|
# @see Orb::Models::CustomerUpdateParams
|
155
137
|
def update(customer_id, params = {})
|
156
|
-
parsed, options = Orb::
|
138
|
+
parsed, options = Orb::CustomerUpdateParams.dump_request(params)
|
157
139
|
@client.request(
|
158
140
|
method: :put,
|
159
141
|
path: ["customers/%1$s", customer_id],
|
160
142
|
body: parsed,
|
161
|
-
model: Orb::
|
143
|
+
model: Orb::Customer,
|
162
144
|
options: options
|
163
145
|
)
|
164
146
|
end
|
@@ -184,17 +166,16 @@ module Orb
|
|
184
166
|
# @param created_at_lte [Time, nil]
|
185
167
|
#
|
186
168
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
187
|
-
# ...
|
188
169
|
#
|
189
170
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
190
171
|
#
|
191
172
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
192
173
|
#
|
193
|
-
# @return [Orb::Internal::Page<Orb::
|
174
|
+
# @return [Orb::Internal::Page<Orb::Customer>]
|
194
175
|
#
|
195
176
|
# @see Orb::Models::CustomerListParams
|
196
177
|
def list(params = {})
|
197
|
-
parsed, options = Orb::
|
178
|
+
parsed, options = Orb::CustomerListParams.dump_request(params)
|
198
179
|
@client.request(
|
199
180
|
method: :get,
|
200
181
|
path: "customers",
|
@@ -205,7 +186,7 @@ module Orb
|
|
205
186
|
created_at_lte: "created_at[lte]"
|
206
187
|
),
|
207
188
|
page: Orb::Internal::Page,
|
208
|
-
model: Orb::
|
189
|
+
model: Orb::Customer,
|
209
190
|
options: options
|
210
191
|
)
|
211
192
|
end
|
@@ -255,14 +236,14 @@ module Orb
|
|
255
236
|
# @param customer_id [String]
|
256
237
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
257
238
|
#
|
258
|
-
# @return [Orb::
|
239
|
+
# @return [Orb::Customer]
|
259
240
|
#
|
260
241
|
# @see Orb::Models::CustomerFetchParams
|
261
242
|
def fetch(customer_id, params = {})
|
262
243
|
@client.request(
|
263
244
|
method: :get,
|
264
245
|
path: ["customers/%1$s", customer_id],
|
265
|
-
model: Orb::
|
246
|
+
model: Orb::Customer,
|
266
247
|
options: params[:request_options]
|
267
248
|
)
|
268
249
|
end
|
@@ -278,14 +259,14 @@ module Orb
|
|
278
259
|
# @param external_customer_id [String]
|
279
260
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
280
261
|
#
|
281
|
-
# @return [Orb::
|
262
|
+
# @return [Orb::Customer]
|
282
263
|
#
|
283
264
|
# @see Orb::Models::CustomerFetchByExternalIDParams
|
284
265
|
def fetch_by_external_id(external_customer_id, params = {})
|
285
266
|
@client.request(
|
286
267
|
method: :get,
|
287
268
|
path: ["customers/external_customer_id/%1$s", external_customer_id],
|
288
|
-
model: Orb::
|
269
|
+
model: Orb::Customer,
|
289
270
|
options: params[:request_options]
|
290
271
|
)
|
291
272
|
end
|
@@ -353,60 +334,52 @@ module Orb
|
|
353
334
|
#
|
354
335
|
# @param id [String]
|
355
336
|
#
|
356
|
-
# @param accounting_sync_configuration [Orb::
|
337
|
+
# @param accounting_sync_configuration [Orb::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration, nil]
|
357
338
|
#
|
358
339
|
# @param additional_emails [Array<String>, nil] Additional email addresses for this customer. If populated, these email addresse
|
359
|
-
# ...
|
360
340
|
#
|
361
341
|
# @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch
|
362
|
-
# ...
|
363
342
|
#
|
364
|
-
# @param billing_address [Orb::
|
343
|
+
# @param billing_address [Orb::CustomerUpdateByExternalIDParams::BillingAddress, nil]
|
365
344
|
#
|
366
345
|
# @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
|
367
|
-
# ...
|
368
346
|
#
|
369
347
|
# @param email [String, nil] A valid customer email, to be used for invoicing and notifications.
|
370
348
|
#
|
371
349
|
# @param email_delivery [Boolean, nil]
|
372
350
|
#
|
373
351
|
# @param external_customer_id [String, nil] The external customer ID. This can only be set if empty and the customer has no
|
374
|
-
# ...
|
375
352
|
#
|
376
|
-
# @param hierarchy [Orb::
|
353
|
+
# @param hierarchy [Orb::CustomerUpdateByExternalIDParams::Hierarchy, nil] The hierarchical relationships for this customer.
|
377
354
|
#
|
378
355
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
379
|
-
# ...
|
380
356
|
#
|
381
357
|
# @param name [String, nil] The full name of the customer
|
382
358
|
#
|
383
|
-
# @param payment_provider [Symbol, Orb::
|
384
|
-
# ...
|
359
|
+
# @param payment_provider [Symbol, Orb::CustomerUpdateByExternalIDParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
|
385
360
|
#
|
386
361
|
# @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
|
387
|
-
# ...
|
388
362
|
#
|
389
|
-
# @param reporting_configuration [Orb::
|
363
|
+
# @param reporting_configuration [Orb::CustomerUpdateByExternalIDParams::ReportingConfiguration, nil]
|
390
364
|
#
|
391
|
-
# @param shipping_address [Orb::
|
365
|
+
# @param shipping_address [Orb::CustomerUpdateByExternalIDParams::ShippingAddress, nil]
|
392
366
|
#
|
393
|
-
# @param tax_configuration [Orb::
|
367
|
+
# @param tax_configuration [Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar, nil]
|
394
368
|
#
|
395
|
-
# @param tax_id [Orb::
|
396
|
-
# ...
|
369
|
+
# @param tax_id [Orb::CustomerUpdateByExternalIDParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
|
397
370
|
#
|
398
371
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
399
372
|
#
|
400
|
-
# @return [Orb::
|
373
|
+
# @return [Orb::Customer]
|
401
374
|
#
|
402
375
|
# @see Orb::Models::CustomerUpdateByExternalIDParams
|
403
376
|
def update_by_external_id(id, params = {})
|
404
|
-
parsed, options = Orb::
|
377
|
+
parsed, options = Orb::CustomerUpdateByExternalIDParams.dump_request(params)
|
405
378
|
@client.request(
|
406
379
|
method: :put,
|
407
380
|
path: ["customers/external_customer_id/%1$s", id],
|
408
381
|
body: parsed,
|
409
|
-
model: Orb::
|
382
|
+
model: Orb::Customer,
|
410
383
|
options: options
|
411
384
|
)
|
412
385
|
end
|
@@ -11,7 +11,7 @@ module Orb
|
|
11
11
|
# @param external_dimensional_price_group_id [String]
|
12
12
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
13
13
|
#
|
14
|
-
# @return [Orb::
|
14
|
+
# @return [Orb::DimensionalPriceGroup]
|
15
15
|
#
|
16
16
|
# @see Orb::Models::DimensionalPriceGroups::ExternalDimensionalPriceGroupIDRetrieveParams
|
17
17
|
def retrieve(external_dimensional_price_group_id, params = {})
|
@@ -21,7 +21,7 @@ module Orb
|
|
21
21
|
"dimensional_price_groups/external_dimensional_price_group_id/%1$s",
|
22
22
|
external_dimensional_price_group_id
|
23
23
|
],
|
24
|
-
model: Orb::
|
24
|
+
model: Orb::DimensionalPriceGroup,
|
25
25
|
options: params[:request_options]
|
26
26
|
)
|
27
27
|
end
|
@@ -29,20 +29,19 @@ module Orb
|
|
29
29
|
# @param external_dimensional_price_group_id [String, nil]
|
30
30
|
#
|
31
31
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
32
|
-
# ...
|
33
32
|
#
|
34
33
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
35
34
|
#
|
36
|
-
# @return [Orb::
|
35
|
+
# @return [Orb::DimensionalPriceGroup]
|
37
36
|
#
|
38
37
|
# @see Orb::Models::DimensionalPriceGroupCreateParams
|
39
38
|
def create(params)
|
40
|
-
parsed, options = Orb::
|
39
|
+
parsed, options = Orb::DimensionalPriceGroupCreateParams.dump_request(params)
|
41
40
|
@client.request(
|
42
41
|
method: :post,
|
43
42
|
path: "dimensional_price_groups",
|
44
43
|
body: parsed,
|
45
|
-
model: Orb::
|
44
|
+
model: Orb::DimensionalPriceGroup,
|
46
45
|
options: options
|
47
46
|
)
|
48
47
|
end
|
@@ -54,14 +53,14 @@ module Orb
|
|
54
53
|
# @param dimensional_price_group_id [String]
|
55
54
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
56
55
|
#
|
57
|
-
# @return [Orb::
|
56
|
+
# @return [Orb::DimensionalPriceGroup]
|
58
57
|
#
|
59
58
|
# @see Orb::Models::DimensionalPriceGroupRetrieveParams
|
60
59
|
def retrieve(dimensional_price_group_id, params = {})
|
61
60
|
@client.request(
|
62
61
|
method: :get,
|
63
62
|
path: ["dimensional_price_groups/%1$s", dimensional_price_group_id],
|
64
|
-
model: Orb::
|
63
|
+
model: Orb::DimensionalPriceGroup,
|
65
64
|
options: params[:request_options]
|
66
65
|
)
|
67
66
|
end
|
@@ -74,23 +73,22 @@ module Orb
|
|
74
73
|
# @overload list(cursor: nil, limit: nil, request_options: {})
|
75
74
|
#
|
76
75
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
77
|
-
# ...
|
78
76
|
#
|
79
77
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
80
78
|
#
|
81
79
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
82
80
|
#
|
83
|
-
# @return [Orb::Internal::Page<Orb::
|
81
|
+
# @return [Orb::Internal::Page<Orb::DimensionalPriceGroup>]
|
84
82
|
#
|
85
83
|
# @see Orb::Models::DimensionalPriceGroupListParams
|
86
84
|
def list(params = {})
|
87
|
-
parsed, options = Orb::
|
85
|
+
parsed, options = Orb::DimensionalPriceGroupListParams.dump_request(params)
|
88
86
|
@client.request(
|
89
87
|
method: :get,
|
90
88
|
path: "dimensional_price_groups",
|
91
89
|
query: parsed,
|
92
90
|
page: Orb::Internal::Page,
|
93
|
-
model: Orb::
|
91
|
+
model: Orb::DimensionalPriceGroup,
|
94
92
|
options: options
|
95
93
|
)
|
96
94
|
end
|
@@ -48,25 +48,18 @@ module Orb
|
|
48
48
|
# @overload create(timeframe_end:, timeframe_start:, close_time: nil, customer_id: nil, deprecation_filter: nil, external_customer_id: nil, replace_existing_events: nil, request_options: {})
|
49
49
|
#
|
50
50
|
# @param timeframe_end [Time] The (exclusive) end of the usage timeframe affected by this backfill. By default
|
51
|
-
# ...
|
52
51
|
#
|
53
52
|
# @param timeframe_start [Time] The (inclusive) start of the usage timeframe affected by this backfill. By defau
|
54
|
-
# ...
|
55
53
|
#
|
56
54
|
# @param close_time [Time, nil] The time at which no more events will be accepted for this backfill. The backfil
|
57
|
-
# ...
|
58
55
|
#
|
59
56
|
# @param customer_id [String, nil] The Orb-generated ID of the customer to which this backfill is scoped. Omitting
|
60
|
-
# ...
|
61
57
|
#
|
62
58
|
# @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
|
63
|
-
# ...
|
64
59
|
#
|
65
60
|
# @param external_customer_id [String, nil] The external customer ID of the customer to which this backfill is scoped. Omitt
|
66
|
-
# ...
|
67
61
|
#
|
68
62
|
# @param replace_existing_events [Boolean] If true, replaces all existing events in the timeframe with the newly ingested e
|
69
|
-
# ...
|
70
63
|
#
|
71
64
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
72
65
|
#
|
@@ -74,7 +67,7 @@ module Orb
|
|
74
67
|
#
|
75
68
|
# @see Orb::Models::Events::BackfillCreateParams
|
76
69
|
def create(params)
|
77
|
-
parsed, options = Orb::
|
70
|
+
parsed, options = Orb::Events::BackfillCreateParams.dump_request(params)
|
78
71
|
@client.request(
|
79
72
|
method: :post,
|
80
73
|
path: "events/backfills",
|
@@ -98,7 +91,6 @@ module Orb
|
|
98
91
|
# @overload list(cursor: nil, limit: nil, request_options: {})
|
99
92
|
#
|
100
93
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
101
|
-
# ...
|
102
94
|
#
|
103
95
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
104
96
|
#
|
@@ -108,7 +100,7 @@ module Orb
|
|
108
100
|
#
|
109
101
|
# @see Orb::Models::Events::BackfillListParams
|
110
102
|
def list(params = {})
|
111
|
-
parsed, options = Orb::
|
103
|
+
parsed, options = Orb::Events::BackfillListParams.dump_request(params)
|
112
104
|
@client.request(
|
113
105
|
method: :get,
|
114
106
|
path: "events/backfills",
|
@@ -24,28 +24,25 @@ module Orb
|
|
24
24
|
# @overload list(timeframe_start:, cursor: nil, limit: nil, timeframe_end: nil, request_options: {})
|
25
25
|
#
|
26
26
|
# @param timeframe_start [Time] The start of the timeframe, inclusive, in which to return event volume. All date
|
27
|
-
# ...
|
28
27
|
#
|
29
28
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
30
|
-
# ...
|
31
29
|
#
|
32
30
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
33
31
|
#
|
34
32
|
# @param timeframe_end [Time] The end of the timeframe, exclusive, in which to return event volume. If not spe
|
35
|
-
# ...
|
36
33
|
#
|
37
34
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
38
35
|
#
|
39
|
-
# @return [Orb::
|
36
|
+
# @return [Orb::Events::EventVolumes]
|
40
37
|
#
|
41
38
|
# @see Orb::Models::Events::VolumeListParams
|
42
39
|
def list(params)
|
43
|
-
parsed, options = Orb::
|
40
|
+
parsed, options = Orb::Events::VolumeListParams.dump_request(params)
|
44
41
|
@client.request(
|
45
42
|
method: :get,
|
46
43
|
path: "events/volume",
|
47
44
|
query: parsed,
|
48
|
-
model: Orb::
|
45
|
+
model: Orb::Events::EventVolumes,
|
49
46
|
options: options
|
50
47
|
)
|
51
48
|
end
|