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
@@ -28,31 +28,39 @@ module Orb
|
|
28
28
|
params(
|
29
29
|
email: String,
|
30
30
|
name: String,
|
31
|
-
accounting_sync_configuration:
|
31
|
+
accounting_sync_configuration:
|
32
|
+
T.nilable(
|
33
|
+
Orb::CustomerCreateParams::AccountingSyncConfiguration::OrHash
|
34
|
+
),
|
32
35
|
additional_emails: T.nilable(T::Array[String]),
|
33
36
|
auto_collection: T.nilable(T::Boolean),
|
34
|
-
billing_address:
|
37
|
+
billing_address:
|
38
|
+
T.nilable(Orb::CustomerCreateParams::BillingAddress::OrHash),
|
35
39
|
currency: T.nilable(String),
|
36
40
|
email_delivery: T.nilable(T::Boolean),
|
37
41
|
external_customer_id: T.nilable(String),
|
38
|
-
hierarchy: T.nilable(
|
42
|
+
hierarchy: T.nilable(Orb::CustomerCreateParams::Hierarchy::OrHash),
|
39
43
|
metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
|
40
|
-
payment_provider:
|
44
|
+
payment_provider:
|
45
|
+
T.nilable(Orb::CustomerCreateParams::PaymentProvider::OrSymbol),
|
41
46
|
payment_provider_id: T.nilable(String),
|
42
|
-
reporting_configuration:
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
47
|
+
reporting_configuration:
|
48
|
+
T.nilable(
|
49
|
+
Orb::CustomerCreateParams::ReportingConfiguration::OrHash
|
50
|
+
),
|
51
|
+
shipping_address:
|
52
|
+
T.nilable(Orb::CustomerCreateParams::ShippingAddress::OrHash),
|
53
|
+
tax_configuration:
|
54
|
+
T.nilable(
|
55
|
+
T.any(
|
56
|
+
Orb::CustomerCreateParams::TaxConfiguration::Avalara::OrHash,
|
57
|
+
Orb::CustomerCreateParams::TaxConfiguration::Taxjar::OrHash
|
58
|
+
)
|
59
|
+
),
|
60
|
+
tax_id: T.nilable(Orb::CustomerCreateParams::TaxID::OrHash),
|
52
61
|
timezone: T.nilable(String),
|
53
|
-
request_options: Orb::
|
54
|
-
)
|
55
|
-
.returns(Orb::Models::Customer)
|
62
|
+
request_options: Orb::RequestOptions::OrHash
|
63
|
+
).returns(Orb::Customer)
|
56
64
|
end
|
57
65
|
def create(
|
58
66
|
# A valid customer email, to be used for notifications. When Orb triggers payment
|
@@ -205,7 +213,9 @@ module Orb
|
|
205
213
|
# This cannot be changed after customer creation.
|
206
214
|
timezone: nil,
|
207
215
|
request_options: {}
|
208
|
-
)
|
216
|
+
)
|
217
|
+
end
|
218
|
+
|
209
219
|
# This endpoint can be used to update the `payment_provider`,
|
210
220
|
# `payment_provider_id`, `name`, `email`, `email_delivery`, `tax_id`,
|
211
221
|
# `auto_collection`, `metadata`, `shipping_address`, `billing_address`, and
|
@@ -214,32 +224,40 @@ module Orb
|
|
214
224
|
sig do
|
215
225
|
params(
|
216
226
|
customer_id: String,
|
217
|
-
accounting_sync_configuration:
|
227
|
+
accounting_sync_configuration:
|
228
|
+
T.nilable(
|
229
|
+
Orb::CustomerUpdateParams::AccountingSyncConfiguration::OrHash
|
230
|
+
),
|
218
231
|
additional_emails: T.nilable(T::Array[String]),
|
219
232
|
auto_collection: T.nilable(T::Boolean),
|
220
|
-
billing_address:
|
233
|
+
billing_address:
|
234
|
+
T.nilable(Orb::CustomerUpdateParams::BillingAddress::OrHash),
|
221
235
|
currency: T.nilable(String),
|
222
236
|
email: T.nilable(String),
|
223
237
|
email_delivery: T.nilable(T::Boolean),
|
224
238
|
external_customer_id: T.nilable(String),
|
225
|
-
hierarchy: T.nilable(
|
239
|
+
hierarchy: T.nilable(Orb::CustomerUpdateParams::Hierarchy::OrHash),
|
226
240
|
metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
|
227
241
|
name: T.nilable(String),
|
228
|
-
payment_provider:
|
242
|
+
payment_provider:
|
243
|
+
T.nilable(Orb::CustomerUpdateParams::PaymentProvider::OrSymbol),
|
229
244
|
payment_provider_id: T.nilable(String),
|
230
|
-
reporting_configuration:
|
231
|
-
|
232
|
-
|
233
|
-
|
234
|
-
|
235
|
-
|
236
|
-
|
237
|
-
|
238
|
-
|
239
|
-
|
240
|
-
|
241
|
-
|
242
|
-
|
245
|
+
reporting_configuration:
|
246
|
+
T.nilable(
|
247
|
+
Orb::CustomerUpdateParams::ReportingConfiguration::OrHash
|
248
|
+
),
|
249
|
+
shipping_address:
|
250
|
+
T.nilable(Orb::CustomerUpdateParams::ShippingAddress::OrHash),
|
251
|
+
tax_configuration:
|
252
|
+
T.nilable(
|
253
|
+
T.any(
|
254
|
+
Orb::CustomerUpdateParams::TaxConfiguration::Avalara::OrHash,
|
255
|
+
Orb::CustomerUpdateParams::TaxConfiguration::Taxjar::OrHash
|
256
|
+
)
|
257
|
+
),
|
258
|
+
tax_id: T.nilable(Orb::CustomerUpdateParams::TaxID::OrHash),
|
259
|
+
request_options: Orb::RequestOptions::OrHash
|
260
|
+
).returns(Orb::Customer)
|
243
261
|
end
|
244
262
|
def update(
|
245
263
|
customer_id,
|
@@ -390,7 +408,9 @@ module Orb
|
|
390
408
|
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
391
409
|
tax_id: nil,
|
392
410
|
request_options: {}
|
393
|
-
)
|
411
|
+
)
|
412
|
+
end
|
413
|
+
|
394
414
|
# This endpoint returns a list of all customers for an account. The list of
|
395
415
|
# customers is ordered starting from the most recently created customer. This
|
396
416
|
# endpoint follows Orb's
|
@@ -405,9 +425,8 @@ module Orb
|
|
405
425
|
created_at_lte: T.nilable(Time),
|
406
426
|
cursor: T.nilable(String),
|
407
427
|
limit: Integer,
|
408
|
-
request_options: Orb::
|
409
|
-
)
|
410
|
-
.returns(Orb::Internal::Page[Orb::Models::Customer])
|
428
|
+
request_options: Orb::RequestOptions::OrHash
|
429
|
+
).returns(Orb::Internal::Page[Orb::Customer])
|
411
430
|
end
|
412
431
|
def list(
|
413
432
|
created_at_gt: nil,
|
@@ -420,7 +439,9 @@ module Orb
|
|
420
439
|
# The number of items to fetch. Defaults to 20.
|
421
440
|
limit: nil,
|
422
441
|
request_options: {}
|
423
|
-
)
|
442
|
+
)
|
443
|
+
end
|
444
|
+
|
424
445
|
# This performs a deletion of this customer, its subscriptions, and its invoices,
|
425
446
|
# provided the customer does not have any issued invoices. Customers with issued
|
426
447
|
# invoices cannot be deleted. This operation is irreversible. Note that this is a
|
@@ -436,8 +457,14 @@ module Orb
|
|
436
457
|
# been fully processed, the customer will not be returned in the API.
|
437
458
|
#
|
438
459
|
# On successful processing, this returns an empty dictionary (`{}`) in the API.
|
439
|
-
sig
|
440
|
-
|
460
|
+
sig do
|
461
|
+
params(
|
462
|
+
customer_id: String,
|
463
|
+
request_options: Orb::RequestOptions::OrHash
|
464
|
+
).void
|
465
|
+
end
|
466
|
+
def delete(customer_id, request_options: {})
|
467
|
+
end
|
441
468
|
|
442
469
|
# This endpoint is used to fetch customer details given an identifier. If the
|
443
470
|
# `Customer` is in the process of being deleted, only the properties `id` and
|
@@ -445,16 +472,28 @@ module Orb
|
|
445
472
|
#
|
446
473
|
# See the [Customer resource](/core-concepts#customer) for a full discussion of
|
447
474
|
# the Customer model.
|
448
|
-
sig
|
449
|
-
|
475
|
+
sig do
|
476
|
+
params(
|
477
|
+
customer_id: String,
|
478
|
+
request_options: Orb::RequestOptions::OrHash
|
479
|
+
).returns(Orb::Customer)
|
480
|
+
end
|
481
|
+
def fetch(customer_id, request_options: {})
|
482
|
+
end
|
450
483
|
|
451
484
|
# This endpoint is used to fetch customer details given an `external_customer_id`
|
452
485
|
# (see [Customer ID Aliases](/events-and-metrics/customer-aliases)).
|
453
486
|
#
|
454
487
|
# Note that the resource and semantics of this endpoint exactly mirror
|
455
488
|
# [Get Customer](fetch-customer).
|
456
|
-
sig
|
457
|
-
|
489
|
+
sig do
|
490
|
+
params(
|
491
|
+
external_customer_id: String,
|
492
|
+
request_options: Orb::RequestOptions::OrHash
|
493
|
+
).returns(Orb::Customer)
|
494
|
+
end
|
495
|
+
def fetch_by_external_id(external_customer_id, request_options: {})
|
496
|
+
end
|
458
497
|
|
459
498
|
# Sync Orb's payment methods for the customer with their gateway.
|
460
499
|
#
|
@@ -462,8 +501,14 @@ module Orb
|
|
462
501
|
# be charged, ensuring that the most up-to-date payment method is charged.
|
463
502
|
#
|
464
503
|
# **Note**: This functionality is currently only available for Stripe.
|
465
|
-
sig
|
466
|
-
|
504
|
+
sig do
|
505
|
+
params(
|
506
|
+
customer_id: String,
|
507
|
+
request_options: Orb::RequestOptions::OrHash
|
508
|
+
).void
|
509
|
+
end
|
510
|
+
def sync_payment_methods_from_gateway(customer_id, request_options: {})
|
511
|
+
end
|
467
512
|
|
468
513
|
# Sync Orb's payment methods for the customer with their gateway.
|
469
514
|
#
|
@@ -471,7 +516,12 @@ module Orb
|
|
471
516
|
# be charged, ensuring that the most up-to-date payment method is charged.
|
472
517
|
#
|
473
518
|
# **Note**: This functionality is currently only available for Stripe.
|
474
|
-
sig
|
519
|
+
sig do
|
520
|
+
params(
|
521
|
+
external_customer_id: String,
|
522
|
+
request_options: Orb::RequestOptions::OrHash
|
523
|
+
).void
|
524
|
+
end
|
475
525
|
def sync_payment_methods_from_gateway_by_external_customer_id(
|
476
526
|
external_customer_id,
|
477
527
|
request_options: {}
|
@@ -485,36 +535,48 @@ module Orb
|
|
485
535
|
sig do
|
486
536
|
params(
|
487
537
|
id: String,
|
488
|
-
accounting_sync_configuration:
|
489
|
-
T.
|
490
|
-
|
538
|
+
accounting_sync_configuration:
|
539
|
+
T.nilable(
|
540
|
+
Orb::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration::OrHash
|
541
|
+
),
|
491
542
|
additional_emails: T.nilable(T::Array[String]),
|
492
543
|
auto_collection: T.nilable(T::Boolean),
|
493
|
-
billing_address:
|
544
|
+
billing_address:
|
545
|
+
T.nilable(
|
546
|
+
Orb::CustomerUpdateByExternalIDParams::BillingAddress::OrHash
|
547
|
+
),
|
494
548
|
currency: T.nilable(String),
|
495
549
|
email: T.nilable(String),
|
496
550
|
email_delivery: T.nilable(T::Boolean),
|
497
551
|
external_customer_id: T.nilable(String),
|
498
|
-
hierarchy:
|
552
|
+
hierarchy:
|
553
|
+
T.nilable(Orb::CustomerUpdateByExternalIDParams::Hierarchy::OrHash),
|
499
554
|
metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
|
500
555
|
name: T.nilable(String),
|
501
|
-
payment_provider:
|
556
|
+
payment_provider:
|
557
|
+
T.nilable(
|
558
|
+
Orb::CustomerUpdateByExternalIDParams::PaymentProvider::OrSymbol
|
559
|
+
),
|
502
560
|
payment_provider_id: T.nilable(String),
|
503
|
-
reporting_configuration:
|
504
|
-
T.
|
505
|
-
|
506
|
-
|
507
|
-
|
508
|
-
T.
|
509
|
-
Orb::
|
510
|
-
|
511
|
-
|
512
|
-
|
513
|
-
|
514
|
-
|
515
|
-
|
516
|
-
|
517
|
-
|
561
|
+
reporting_configuration:
|
562
|
+
T.nilable(
|
563
|
+
Orb::CustomerUpdateByExternalIDParams::ReportingConfiguration::OrHash
|
564
|
+
),
|
565
|
+
shipping_address:
|
566
|
+
T.nilable(
|
567
|
+
Orb::CustomerUpdateByExternalIDParams::ShippingAddress::OrHash
|
568
|
+
),
|
569
|
+
tax_configuration:
|
570
|
+
T.nilable(
|
571
|
+
T.any(
|
572
|
+
Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara::OrHash,
|
573
|
+
Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar::OrHash
|
574
|
+
)
|
575
|
+
),
|
576
|
+
tax_id:
|
577
|
+
T.nilable(Orb::CustomerUpdateByExternalIDParams::TaxID::OrHash),
|
578
|
+
request_options: Orb::RequestOptions::OrHash
|
579
|
+
).returns(Orb::Customer)
|
518
580
|
end
|
519
581
|
def update_by_external_id(
|
520
582
|
id,
|
@@ -665,10 +727,13 @@ module Orb
|
|
665
727
|
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
666
728
|
tax_id: nil,
|
667
729
|
request_options: {}
|
668
|
-
)
|
730
|
+
)
|
731
|
+
end
|
732
|
+
|
669
733
|
# @api private
|
670
734
|
sig { params(client: Orb::Client).returns(T.attached_class) }
|
671
|
-
def self.new(client:)
|
735
|
+
def self.new(client:)
|
736
|
+
end
|
672
737
|
end
|
673
738
|
end
|
674
739
|
end
|
@@ -6,14 +6,18 @@ module Orb
|
|
6
6
|
class ExternalDimensionalPriceGroupID
|
7
7
|
# Fetch dimensional price group by external ID
|
8
8
|
sig do
|
9
|
-
params(
|
10
|
-
|
9
|
+
params(
|
10
|
+
external_dimensional_price_group_id: String,
|
11
|
+
request_options: Orb::RequestOptions::OrHash
|
12
|
+
).returns(Orb::DimensionalPriceGroup)
|
13
|
+
end
|
14
|
+
def retrieve(external_dimensional_price_group_id, request_options: {})
|
11
15
|
end
|
12
|
-
def retrieve(external_dimensional_price_group_id, request_options: {}); end
|
13
16
|
|
14
17
|
# @api private
|
15
18
|
sig { params(client: Orb::Client).returns(T.attached_class) }
|
16
|
-
def self.new(client:)
|
19
|
+
def self.new(client:)
|
20
|
+
end
|
17
21
|
end
|
18
22
|
end
|
19
23
|
end
|
@@ -3,7 +3,11 @@
|
|
3
3
|
module Orb
|
4
4
|
module Resources
|
5
5
|
class DimensionalPriceGroups
|
6
|
-
sig
|
6
|
+
sig do
|
7
|
+
returns(
|
8
|
+
Orb::Resources::DimensionalPriceGroups::ExternalDimensionalPriceGroupID
|
9
|
+
)
|
10
|
+
end
|
7
11
|
attr_reader :external_dimensional_price_group_id
|
8
12
|
|
9
13
|
# A dimensional price group is used to partition the result of a billable metric
|
@@ -21,9 +25,8 @@ module Orb
|
|
21
25
|
name: String,
|
22
26
|
external_dimensional_price_group_id: T.nilable(String),
|
23
27
|
metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
|
24
|
-
request_options: Orb::
|
25
|
-
)
|
26
|
-
.returns(Orb::Models::DimensionalPriceGroup)
|
28
|
+
request_options: Orb::RequestOptions::OrHash
|
29
|
+
).returns(Orb::DimensionalPriceGroup)
|
27
30
|
end
|
28
31
|
def create(
|
29
32
|
billable_metric_id:,
|
@@ -36,18 +39,26 @@ module Orb
|
|
36
39
|
# by setting `metadata` to `null`.
|
37
40
|
metadata: nil,
|
38
41
|
request_options: {}
|
39
|
-
)
|
42
|
+
)
|
43
|
+
end
|
44
|
+
|
40
45
|
# Fetch dimensional price group
|
41
46
|
sig do
|
42
|
-
params(
|
43
|
-
|
47
|
+
params(
|
48
|
+
dimensional_price_group_id: String,
|
49
|
+
request_options: Orb::RequestOptions::OrHash
|
50
|
+
).returns(Orb::DimensionalPriceGroup)
|
51
|
+
end
|
52
|
+
def retrieve(dimensional_price_group_id, request_options: {})
|
44
53
|
end
|
45
|
-
def retrieve(dimensional_price_group_id, request_options: {}); end
|
46
54
|
|
47
55
|
# List dimensional price groups
|
48
56
|
sig do
|
49
|
-
params(
|
50
|
-
.
|
57
|
+
params(
|
58
|
+
cursor: T.nilable(String),
|
59
|
+
limit: Integer,
|
60
|
+
request_options: Orb::RequestOptions::OrHash
|
61
|
+
).returns(Orb::Internal::Page[Orb::DimensionalPriceGroup])
|
51
62
|
end
|
52
63
|
def list(
|
53
64
|
# Cursor for pagination. This can be populated by the `next_cursor` value returned
|
@@ -56,10 +67,13 @@ module Orb
|
|
56
67
|
# The number of items to fetch. Defaults to 20.
|
57
68
|
limit: nil,
|
58
69
|
request_options: {}
|
59
|
-
)
|
70
|
+
)
|
71
|
+
end
|
72
|
+
|
60
73
|
# @api private
|
61
74
|
sig { params(client: Orb::Client).returns(T.attached_class) }
|
62
|
-
def self.new(client:)
|
75
|
+
def self.new(client:)
|
76
|
+
end
|
63
77
|
end
|
64
78
|
end
|
65
79
|
end
|
@@ -50,9 +50,8 @@ module Orb
|
|
50
50
|
deprecation_filter: T.nilable(String),
|
51
51
|
external_customer_id: T.nilable(String),
|
52
52
|
replace_existing_events: T::Boolean,
|
53
|
-
request_options: Orb::
|
54
|
-
)
|
55
|
-
.returns(Orb::Models::Events::BackfillCreateResponse)
|
53
|
+
request_options: Orb::RequestOptions::OrHash
|
54
|
+
).returns(Orb::Models::Events::BackfillCreateResponse)
|
56
55
|
end
|
57
56
|
def create(
|
58
57
|
# The (exclusive) end of the usage timeframe affected by this backfill. By
|
@@ -81,7 +80,9 @@ module Orb
|
|
81
80
|
# events. If false, adds the newly ingested events to the existing events.
|
82
81
|
replace_existing_events: nil,
|
83
82
|
request_options: {}
|
84
|
-
)
|
83
|
+
)
|
84
|
+
end
|
85
|
+
|
85
86
|
# This endpoint returns a list of all backfills in a list format.
|
86
87
|
#
|
87
88
|
# The list of backfills is ordered starting from the most recently created
|
@@ -90,8 +91,13 @@ module Orb
|
|
90
91
|
# retrieve the next page of results if they exist. More information about
|
91
92
|
# pagination can be found in the [Pagination-metadata schema](pagination).
|
92
93
|
sig do
|
93
|
-
params(
|
94
|
-
.
|
94
|
+
params(
|
95
|
+
cursor: T.nilable(String),
|
96
|
+
limit: Integer,
|
97
|
+
request_options: Orb::RequestOptions::OrHash
|
98
|
+
).returns(
|
99
|
+
Orb::Internal::Page[Orb::Models::Events::BackfillListResponse]
|
100
|
+
)
|
95
101
|
end
|
96
102
|
def list(
|
97
103
|
# Cursor for pagination. This can be populated by the `next_cursor` value returned
|
@@ -100,23 +106,31 @@ module Orb
|
|
100
106
|
# The number of items to fetch. Defaults to 20.
|
101
107
|
limit: nil,
|
102
108
|
request_options: {}
|
103
|
-
)
|
109
|
+
)
|
110
|
+
end
|
111
|
+
|
104
112
|
# Closing a backfill makes the updated usage visible in Orb. Upon closing a
|
105
113
|
# backfill, Orb will asynchronously reflect the updated usage in invoice amounts
|
106
114
|
# and usage graphs. Once all of the updates are complete, the backfill's status
|
107
115
|
# will transition to `reflected`.
|
108
116
|
sig do
|
109
|
-
params(
|
110
|
-
|
117
|
+
params(
|
118
|
+
backfill_id: String,
|
119
|
+
request_options: Orb::RequestOptions::OrHash
|
120
|
+
).returns(Orb::Models::Events::BackfillCloseResponse)
|
121
|
+
end
|
122
|
+
def close(backfill_id, request_options: {})
|
111
123
|
end
|
112
|
-
def close(backfill_id, request_options: {}); end
|
113
124
|
|
114
125
|
# This endpoint is used to fetch a backfill given an identifier.
|
115
126
|
sig do
|
116
|
-
params(
|
117
|
-
|
127
|
+
params(
|
128
|
+
backfill_id: String,
|
129
|
+
request_options: Orb::RequestOptions::OrHash
|
130
|
+
).returns(Orb::Models::Events::BackfillFetchResponse)
|
131
|
+
end
|
132
|
+
def fetch(backfill_id, request_options: {})
|
118
133
|
end
|
119
|
-
def fetch(backfill_id, request_options: {}); end
|
120
134
|
|
121
135
|
# Reverting a backfill undoes all the effects of closing the backfill. If the
|
122
136
|
# backfill is reflected, the status will transition to `pending_revert` while the
|
@@ -126,14 +140,18 @@ module Orb
|
|
126
140
|
# If a backfill is reverted before its closed, no usage will be updated as a
|
127
141
|
# result of the backfill and it will immediately transition to `reverted`.
|
128
142
|
sig do
|
129
|
-
params(
|
130
|
-
|
143
|
+
params(
|
144
|
+
backfill_id: String,
|
145
|
+
request_options: Orb::RequestOptions::OrHash
|
146
|
+
).returns(Orb::Models::Events::BackfillRevertResponse)
|
147
|
+
end
|
148
|
+
def revert(backfill_id, request_options: {})
|
131
149
|
end
|
132
|
-
def revert(backfill_id, request_options: {}); end
|
133
150
|
|
134
151
|
# @api private
|
135
152
|
sig { params(client: Orb::Client).returns(T.attached_class) }
|
136
|
-
def self.new(client:)
|
153
|
+
def self.new(client:)
|
154
|
+
end
|
137
155
|
end
|
138
156
|
end
|
139
157
|
end
|
@@ -23,9 +23,8 @@ module Orb
|
|
23
23
|
cursor: T.nilable(String),
|
24
24
|
limit: Integer,
|
25
25
|
timeframe_end: Time,
|
26
|
-
request_options: Orb::
|
27
|
-
)
|
28
|
-
.returns(Orb::Models::Events::EventVolumes)
|
26
|
+
request_options: Orb::RequestOptions::OrHash
|
27
|
+
).returns(Orb::Events::EventVolumes)
|
29
28
|
end
|
30
29
|
def list(
|
31
30
|
# The start of the timeframe, inclusive, in which to return event volume. All
|
@@ -44,10 +43,13 @@ module Orb
|
|
44
43
|
# volumecount for the hour the time falls in.
|
45
44
|
timeframe_end: nil,
|
46
45
|
request_options: {}
|
47
|
-
)
|
46
|
+
)
|
47
|
+
end
|
48
|
+
|
48
49
|
# @api private
|
49
50
|
sig { params(client: Orb::Client).returns(T.attached_class) }
|
50
|
-
def self.new(client:)
|
51
|
+
def self.new(client:)
|
52
|
+
end
|
51
53
|
end
|
52
54
|
end
|
53
55
|
end
|
@@ -62,9 +62,8 @@ module Orb
|
|
62
62
|
timestamp: Time,
|
63
63
|
customer_id: T.nilable(String),
|
64
64
|
external_customer_id: T.nilable(String),
|
65
|
-
request_options: Orb::
|
66
|
-
)
|
67
|
-
.returns(Orb::Models::EventUpdateResponse)
|
65
|
+
request_options: Orb::RequestOptions::OrHash
|
66
|
+
).returns(Orb::Models::EventUpdateResponse)
|
68
67
|
end
|
69
68
|
def update(
|
70
69
|
event_id,
|
@@ -83,7 +82,9 @@ module Orb
|
|
83
82
|
# customer
|
84
83
|
external_customer_id: nil,
|
85
84
|
request_options: {}
|
86
|
-
)
|
85
|
+
)
|
86
|
+
end
|
87
|
+
|
87
88
|
# This endpoint is used to deprecate a single usage event with a given `event_id`.
|
88
89
|
# `event_id` refers to the `idempotency_key` passed in during ingestion.
|
89
90
|
#
|
@@ -124,8 +125,14 @@ module Orb
|
|
124
125
|
# - By default, no more than 100 events can be deprecated for a single customer in
|
125
126
|
# a 100 day period. For higher volume updates, consider using the
|
126
127
|
# [event backfill](create-backfill) endpoint.
|
127
|
-
sig
|
128
|
-
|
128
|
+
sig do
|
129
|
+
params(
|
130
|
+
event_id: String,
|
131
|
+
request_options: Orb::RequestOptions::OrHash
|
132
|
+
).returns(Orb::Models::EventDeprecateResponse)
|
133
|
+
end
|
134
|
+
def deprecate(event_id, request_options: {})
|
135
|
+
end
|
129
136
|
|
130
137
|
# Orb's event ingestion model and API is designed around two core principles:
|
131
138
|
#
|
@@ -333,12 +340,11 @@ module Orb
|
|
333
340
|
# ```
|
334
341
|
sig do
|
335
342
|
params(
|
336
|
-
events: T::Array[
|
343
|
+
events: T::Array[Orb::EventIngestParams::Event::OrHash],
|
337
344
|
backfill_id: T.nilable(String),
|
338
345
|
debug: T::Boolean,
|
339
|
-
request_options: Orb::
|
340
|
-
)
|
341
|
-
.returns(Orb::Models::EventIngestResponse)
|
346
|
+
request_options: Orb::RequestOptions::OrHash
|
347
|
+
).returns(Orb::Models::EventIngestResponse)
|
342
348
|
end
|
343
349
|
def ingest(
|
344
350
|
# Body param:
|
@@ -350,7 +356,9 @@ module Orb
|
|
350
356
|
# response
|
351
357
|
debug: nil,
|
352
358
|
request_options: {}
|
353
|
-
)
|
359
|
+
)
|
360
|
+
end
|
361
|
+
|
354
362
|
# This endpoint returns a filtered set of events for an account in a
|
355
363
|
# [paginated list format](/api-reference/pagination).
|
356
364
|
#
|
@@ -371,9 +379,8 @@ module Orb
|
|
371
379
|
event_ids: T::Array[String],
|
372
380
|
timeframe_end: T.nilable(Time),
|
373
381
|
timeframe_start: T.nilable(Time),
|
374
|
-
request_options: Orb::
|
375
|
-
)
|
376
|
-
.returns(Orb::Models::EventSearchResponse)
|
382
|
+
request_options: Orb::RequestOptions::OrHash
|
383
|
+
).returns(Orb::Models::EventSearchResponse)
|
377
384
|
end
|
378
385
|
def search(
|
379
386
|
# This is an explicit array of IDs to filter by. Note that an event's ID is the
|
@@ -388,10 +395,13 @@ module Orb
|
|
388
395
|
# specified, the one week ago is used.
|
389
396
|
timeframe_start: nil,
|
390
397
|
request_options: {}
|
391
|
-
)
|
398
|
+
)
|
399
|
+
end
|
400
|
+
|
392
401
|
# @api private
|
393
402
|
sig { params(client: Orb::Client).returns(T.attached_class) }
|
394
|
-
def self.new(client:)
|
403
|
+
def self.new(client:)
|
404
|
+
end
|
395
405
|
end
|
396
406
|
end
|
397
407
|
end
|
@@ -13,9 +13,8 @@ module Orb
|
|
13
13
|
name: String,
|
14
14
|
quantity: Float,
|
15
15
|
start_date: Date,
|
16
|
-
request_options: Orb::
|
17
|
-
)
|
18
|
-
.returns(Orb::Models::InvoiceLineItemCreateResponse)
|
16
|
+
request_options: Orb::RequestOptions::OrHash
|
17
|
+
).returns(Orb::Models::InvoiceLineItemCreateResponse)
|
19
18
|
end
|
20
19
|
def create(
|
21
20
|
# The total amount in the invoice's currency to add to the line item.
|
@@ -32,10 +31,13 @@ module Orb
|
|
32
31
|
# A date string to specify the line item's start date in the customer's timezone.
|
33
32
|
start_date:,
|
34
33
|
request_options: {}
|
35
|
-
)
|
34
|
+
)
|
35
|
+
end
|
36
|
+
|
36
37
|
# @api private
|
37
38
|
sig { params(client: Orb::Client).returns(T.attached_class) }
|
38
|
-
def self.new(client:)
|
39
|
+
def self.new(client:)
|
40
|
+
end
|
39
41
|
end
|
40
42
|
end
|
41
43
|
end
|