orb-billing 0.3.1 → 0.4.0
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 +35 -0
- data/README.md +3 -3
- data/lib/orb/errors.rb +1 -1
- data/lib/orb/file_part.rb +2 -2
- data/lib/orb/internal/transport/base_client.rb +74 -5
- data/lib/orb/internal/transport/pooled_net_requester.rb +14 -0
- data/lib/orb/internal/type/array_of.rb +1 -1
- data/lib/orb/internal/type/base_model.rb +62 -30
- data/lib/orb/internal/type/converter.rb +18 -0
- data/lib/orb/internal/type/enum.rb +4 -3
- data/lib/orb/internal/type/hash_of.rb +1 -1
- data/lib/orb/internal/type/request_parameters.rb +4 -4
- data/lib/orb/internal/type/union.rb +5 -4
- data/lib/orb/internal/util.rb +57 -1
- data/lib/orb/internal.rb +6 -0
- 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 +13 -12
- data/lib/orb/models/coupon_create_params.rb +12 -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 +50 -53
- data/lib/orb/models/customer_list_params.rb +0 -1
- data/lib/orb/models/customer_update_by_external_id_params.rb +50 -53
- data/lib/orb/models/customer_update_params.rb +50 -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 +14 -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 +14 -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 +14 -7
- data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
- data/lib/orb/models/customers/credits/ledger_list_response.rb +14 -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 +11 -5
- data/lib/orb/models/evaluate_price_group.rb +5 -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 +179 -202
- data/lib/orb/models/invoice_create_params.rb +14 -21
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +31 -54
- data/lib/orb/models/invoice_issue_params.rb +0 -1
- data/lib/orb/models/invoice_level_discount.rb +8 -4
- data/lib/orb/models/invoice_line_item_create_params.rb +0 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +28 -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 +90 -103
- data/lib/orb/models/plan_create_params.rb +759 -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 +1706 -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 +108 -122
- data/lib/orb/models/subscription_cancel_params.rb +3 -5
- data/lib/orb/models/subscription_cancel_response.rb +43 -57
- data/lib/orb/models/subscription_change_apply_response.rb +43 -58
- data/lib/orb/models/subscription_change_cancel_response.rb +43 -58
- data/lib/orb/models/subscription_change_retrieve_response.rb +43 -58
- data/lib/orb/models/subscription_create_params.rb +1953 -1815
- data/lib/orb/models/subscription_create_response.rb +43 -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 +1194 -1017
- data/lib/orb/models/subscription_price_intervals_response.rb +43 -57
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +1994 -1791
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +43 -57
- data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
- data/lib/orb/models/subscription_trigger_phase_response.rb +43 -57
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +43 -57
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +43 -57
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +43 -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 +43 -57
- data/lib/orb/models/subscription_update_params.rb +0 -5
- data/lib/orb/models/subscription_update_trial_params.rb +8 -6
- data/lib/orb/models/subscription_update_trial_response.rb +43 -57
- data/lib/orb/models/subscription_usage.rb +55 -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/models.rb +24 -0
- data/lib/orb/request_options.rb +4 -0
- 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 +3 -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 +20 -6
- data/rbi/orb/internal/transport/base_client.rbi +159 -78
- data/rbi/orb/internal/transport/pooled_net_requester.rbi +27 -13
- data/rbi/orb/internal/type/array_of.rbi +42 -34
- data/rbi/orb/internal/type/base_model.rbi +144 -69
- data/rbi/orb/internal/type/base_page.rbi +12 -8
- data/rbi/orb/internal/type/boolean.rbi +16 -10
- data/rbi/orb/internal/type/converter.rbi +68 -31
- data/rbi/orb/internal/type/enum.rbi +28 -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 +61 -25
- data/rbi/orb/internal/type/unknown.rbi +20 -12
- data/rbi/orb/internal/util.rbi +232 -90
- data/rbi/orb/internal.rbi +2 -0
- data/rbi/orb/models/alert.rbi +114 -70
- data/rbi/orb/models/alert_create_for_customer_params.rbi +69 -27
- data/rbi/orb/models/alert_create_for_external_customer_params.rbi +80 -29
- data/rbi/orb/models/alert_create_for_subscription_params.rbi +62 -26
- data/rbi/orb/models/alert_disable_params.rbi +18 -6
- data/rbi/orb/models/alert_enable_params.rbi +18 -6
- data/rbi/orb/models/alert_list_params.rbi +24 -20
- data/rbi/orb/models/alert_retrieve_params.rbi +11 -4
- data/rbi/orb/models/alert_update_params.rbi +29 -14
- data/rbi/orb/models/amount_discount.rbi +29 -19
- data/rbi/orb/models/billable_metric.rbi +34 -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 +11 -4
- data/rbi/orb/models/coupon_create_params.rbi +85 -38
- data/rbi/orb/models/coupon_fetch_params.rbi +11 -4
- data/rbi/orb/models/coupon_list_params.rbi +19 -15
- data/rbi/orb/models/coupons/subscription_list_params.rbi +19 -6
- data/rbi/orb/models/credit_note.rbi +329 -158
- data/rbi/orb/models/credit_note_create_params.rbi +64 -29
- data/rbi/orb/models/credit_note_fetch_params.rbi +13 -4
- data/rbi/orb/models/credit_note_list_params.rbi +23 -17
- data/rbi/orb/models/customer.rbi +461 -329
- data/rbi/orb/models/customer_create_params.rbi +713 -325
- data/rbi/orb/models/customer_delete_params.rbi +13 -4
- data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +13 -4
- data/rbi/orb/models/customer_fetch_params.rbi +11 -4
- data/rbi/orb/models/customer_list_params.rbi +21 -17
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +16 -4
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +16 -4
- data/rbi/orb/models/customer_update_by_external_id_params.rbi +1193 -336
- data/rbi/orb/models/customer_update_params.rbi +712 -324
- data/rbi/orb/models/customers/balance_transaction_create_params.rbi +56 -21
- data/rbi/orb/models/customers/balance_transaction_create_response.rbi +172 -61
- data/rbi/orb/models/customers/balance_transaction_list_params.rbi +26 -17
- data/rbi/orb/models/customers/balance_transaction_list_response.rbi +182 -59
- data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +62 -22
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +180 -124
- data/rbi/orb/models/customers/cost_list_params.rbi +48 -22
- data/rbi/orb/models/customers/cost_list_response.rbi +172 -123
- data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi +24 -15
- data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +54 -22
- data/rbi/orb/models/customers/credit_list_params.rbi +21 -15
- data/rbi/orb/models/customers/credit_list_response.rbi +50 -21
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +118 -68
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +755 -434
- data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +129 -59
- data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +812 -425
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +108 -44
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +793 -432
- data/rbi/orb/models/customers/credits/ledger_list_params.rbi +129 -40
- data/rbi/orb/models/customers/credits/ledger_list_response.rbi +847 -389
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +86 -53
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +77 -48
- data/rbi/orb/models/customers/credits/top_up_create_params.rbi +96 -45
- data/rbi/orb/models/customers/credits/top_up_create_response.rbi +95 -43
- data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +22 -6
- data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +21 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +15 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +82 -49
- data/rbi/orb/models/customers/credits/top_up_list_params.rbi +15 -5
- data/rbi/orb/models/customers/credits/top_up_list_response.rbi +96 -43
- data/rbi/orb/models/dimensional_price_group.rbi +21 -15
- data/rbi/orb/models/dimensional_price_group_create_params.rbi +22 -16
- data/rbi/orb/models/dimensional_price_group_list_params.rbi +19 -6
- data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +16 -4
- data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +15 -8
- data/rbi/orb/models/dimensional_price_groups.rbi +21 -13
- data/rbi/orb/models/discount.rbi +11 -5
- data/rbi/orb/models/evaluate_price_group.rbi +29 -12
- data/rbi/orb/models/event_deprecate_params.rbi +13 -4
- data/rbi/orb/models/event_deprecate_response.rbi +11 -3
- data/rbi/orb/models/event_ingest_params.rbi +41 -31
- data/rbi/orb/models/event_ingest_response.rbi +78 -23
- data/rbi/orb/models/event_search_params.rbi +18 -14
- data/rbi/orb/models/event_search_response.rbi +42 -21
- data/rbi/orb/models/event_update_params.rbi +20 -16
- data/rbi/orb/models/event_update_response.rbi +11 -3
- data/rbi/orb/models/events/backfill_close_params.rbi +13 -9
- data/rbi/orb/models/events/backfill_close_response.rbi +70 -29
- data/rbi/orb/models/events/backfill_create_params.rbi +24 -18
- data/rbi/orb/models/events/backfill_create_response.rbi +69 -29
- data/rbi/orb/models/events/backfill_fetch_params.rbi +13 -9
- data/rbi/orb/models/events/backfill_fetch_response.rbi +70 -29
- data/rbi/orb/models/events/backfill_list_params.rbi +19 -6
- data/rbi/orb/models/events/backfill_list_response.rbi +68 -28
- data/rbi/orb/models/events/backfill_revert_params.rbi +13 -9
- data/rbi/orb/models/events/backfill_revert_response.rbi +69 -29
- data/rbi/orb/models/events/event_volumes.rbi +38 -10
- data/rbi/orb/models/events/volume_list_params.rbi +21 -15
- data/rbi/orb/models/invoice.rbi +1411 -805
- data/rbi/orb/models/invoice_create_params.rbi +107 -69
- data/rbi/orb/models/invoice_fetch_params.rbi +11 -4
- data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +18 -5
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +2187 -876
- data/rbi/orb/models/invoice_issue_params.rbi +17 -5
- data/rbi/orb/models/invoice_level_discount.rbi +11 -4
- data/rbi/orb/models/invoice_line_item_create_params.rbi +23 -17
- data/rbi/orb/models/invoice_line_item_create_response.rbi +675 -376
- data/rbi/orb/models/invoice_list_params.rbi +68 -47
- data/rbi/orb/models/invoice_mark_paid_params.rbi +20 -14
- data/rbi/orb/models/invoice_pay_params.rbi +11 -4
- data/rbi/orb/models/invoice_update_params.rbi +16 -10
- data/rbi/orb/models/invoice_void_params.rbi +11 -4
- data/rbi/orb/models/item.rbi +90 -39
- data/rbi/orb/models/item_create_params.rbi +15 -5
- data/rbi/orb/models/item_fetch_params.rbi +11 -4
- data/rbi/orb/models/item_list_params.rbi +17 -6
- data/rbi/orb/models/item_update_params.rbi +86 -39
- data/rbi/orb/models/metric_create_params.rbi +20 -16
- data/rbi/orb/models/metric_fetch_params.rbi +11 -4
- data/rbi/orb/models/metric_list_params.rbi +21 -17
- data/rbi/orb/models/metric_update_params.rbi +16 -10
- data/rbi/orb/models/pagination_metadata.rbi +17 -4
- data/rbi/orb/models/percentage_discount.rbi +33 -19
- data/rbi/orb/models/plan.rbi +532 -365
- data/rbi/orb/models/plan_create_params.rbi +5295 -2870
- data/rbi/orb/models/plan_fetch_params.rbi +11 -4
- data/rbi/orb/models/plan_list_params.rbi +35 -27
- data/rbi/orb/models/plan_update_params.rbi +17 -13
- data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +13 -9
- data/rbi/orb/models/plans/external_plan_id_update_params.rbi +22 -13
- data/rbi/orb/models/price.rbi +11332 -5033
- data/rbi/orb/models/price_create_params.rbi +583 -245
- data/rbi/orb/models/price_evaluate_params.rbi +21 -17
- data/rbi/orb/models/price_evaluate_response.rbi +14 -6
- data/rbi/orb/models/price_fetch_params.rbi +11 -4
- data/rbi/orb/models/price_list_params.rbi +17 -6
- data/rbi/orb/models/price_update_params.rbi +16 -10
- data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +15 -8
- data/rbi/orb/models/prices/external_price_id_update_params.rbi +21 -10
- data/rbi/orb/models/subscription.rbi +668 -420
- data/rbi/orb/models/subscription_cancel_params.rbi +47 -22
- data/rbi/orb/models/subscription_cancel_response.rbi +817 -438
- data/rbi/orb/models/subscription_change_apply_params.rbi +19 -13
- data/rbi/orb/models/subscription_change_apply_response.rbi +906 -505
- data/rbi/orb/models/subscription_change_cancel_params.rbi +13 -4
- data/rbi/orb/models/subscription_change_cancel_response.rbi +906 -516
- data/rbi/orb/models/subscription_change_retrieve_params.rbi +13 -4
- data/rbi/orb/models/subscription_change_retrieve_response.rbi +903 -524
- data/rbi/orb/models/subscription_create_params.rbi +10096 -6746
- data/rbi/orb/models/subscription_create_response.rbi +817 -438
- data/rbi/orb/models/subscription_fetch_costs_params.rbi +50 -22
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +172 -123
- data/rbi/orb/models/subscription_fetch_params.rbi +13 -4
- data/rbi/orb/models/subscription_fetch_schedule_params.rbi +23 -17
- data/rbi/orb/models/subscription_fetch_schedule_response.rbi +45 -19
- data/rbi/orb/models/subscription_fetch_usage_params.rbi +84 -34
- data/rbi/orb/models/subscription_list_params.rbi +42 -28
- data/rbi/orb/models/subscription_price_intervals_params.rbi +5798 -3823
- data/rbi/orb/models/subscription_price_intervals_response.rbi +840 -453
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +9676 -6922
- data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +838 -467
- data/rbi/orb/models/subscription_trigger_phase_params.rbi +19 -13
- data/rbi/orb/models/subscription_trigger_phase_response.rbi +832 -448
- data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +16 -4
- data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +839 -467
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +22 -5
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +815 -504
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +16 -4
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +828 -497
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +63 -26
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +839 -467
- data/rbi/orb/models/subscription_update_params.rbi +22 -16
- data/rbi/orb/models/subscription_update_trial_params.rbi +60 -19
- data/rbi/orb/models/subscription_update_trial_response.rbi +832 -447
- data/rbi/orb/models/subscription_usage.rbi +325 -121
- data/rbi/orb/models/subscriptions.rbi +19 -11
- data/rbi/orb/models/top_level_ping_params.rbi +11 -4
- data/rbi/orb/models/top_level_ping_response.rbi +10 -3
- data/rbi/orb/models/trial_discount.rbi +30 -20
- data/rbi/orb/models/usage_discount.rbi +29 -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/transport/base_client.rbs +16 -1
- data/sig/orb/internal/transport/pooled_net_requester.rbs +2 -0
- data/sig/orb/internal/type/base_model.rbs +11 -5
- data/sig/orb/internal/type/base_page.rbs +1 -1
- data/sig/orb/internal/type/converter.rbs +2 -0
- data/sig/orb/internal/type/enum.rbs +1 -0
- data/sig/orb/internal/type/request_parameters.rbs +3 -1
- data/sig/orb/internal/type/union.rbs +1 -0
- data/sig/orb/internal/util.rbs +13 -0
- data/sig/orb/internal.rbs +2 -0
- 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,9 +23,9 @@ module Orb
|
|
23
23
|
|
24
24
|
# @!attribute accounting_sync_configuration
|
25
25
|
#
|
26
|
-
# @return [Orb::
|
26
|
+
# @return [Orb::CustomerCreateParams::AccountingSyncConfiguration, nil]
|
27
27
|
optional :accounting_sync_configuration,
|
28
|
-
-> { Orb::
|
28
|
+
-> { Orb::CustomerCreateParams::AccountingSyncConfiguration },
|
29
29
|
nil?: true
|
30
30
|
|
31
31
|
# @!attribute additional_emails
|
@@ -45,8 +45,8 @@ module Orb
|
|
45
45
|
|
46
46
|
# @!attribute billing_address
|
47
47
|
#
|
48
|
-
# @return [Orb::
|
49
|
-
optional :billing_address, -> { Orb::
|
48
|
+
# @return [Orb::CustomerCreateParams::BillingAddress, nil]
|
49
|
+
optional :billing_address, -> { Orb::CustomerCreateParams::BillingAddress }, nil?: true
|
50
50
|
|
51
51
|
# @!attribute currency
|
52
52
|
# An ISO 4217 currency string used for the customer's invoices and balance. If not
|
@@ -71,8 +71,8 @@ module Orb
|
|
71
71
|
# @!attribute hierarchy
|
72
72
|
# The hierarchical relationships for this customer.
|
73
73
|
#
|
74
|
-
# @return [Orb::
|
75
|
-
optional :hierarchy, -> { Orb::
|
74
|
+
# @return [Orb::CustomerCreateParams::Hierarchy, nil]
|
75
|
+
optional :hierarchy, -> { Orb::CustomerCreateParams::Hierarchy }, nil?: true
|
76
76
|
|
77
77
|
# @!attribute metadata
|
78
78
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
@@ -87,8 +87,8 @@ module Orb
|
|
87
87
|
# When not in test mode, the connection must first be configured in the Orb
|
88
88
|
# webapp.
|
89
89
|
#
|
90
|
-
# @return [Symbol, Orb::
|
91
|
-
optional :payment_provider, enum: -> { Orb::
|
90
|
+
# @return [Symbol, Orb::CustomerCreateParams::PaymentProvider, nil]
|
91
|
+
optional :payment_provider, enum: -> { Orb::CustomerCreateParams::PaymentProvider }, nil?: true
|
92
92
|
|
93
93
|
# @!attribute payment_provider_id
|
94
94
|
# The ID of this customer in an external payments solution, such as Stripe. This
|
@@ -99,20 +99,18 @@ module Orb
|
|
99
99
|
|
100
100
|
# @!attribute reporting_configuration
|
101
101
|
#
|
102
|
-
# @return [Orb::
|
103
|
-
optional :reporting_configuration,
|
104
|
-
-> { Orb::Models::CustomerCreateParams::ReportingConfiguration },
|
105
|
-
nil?: true
|
102
|
+
# @return [Orb::CustomerCreateParams::ReportingConfiguration, nil]
|
103
|
+
optional :reporting_configuration, -> { Orb::CustomerCreateParams::ReportingConfiguration }, nil?: true
|
106
104
|
|
107
105
|
# @!attribute shipping_address
|
108
106
|
#
|
109
|
-
# @return [Orb::
|
110
|
-
optional :shipping_address, -> { Orb::
|
107
|
+
# @return [Orb::CustomerCreateParams::ShippingAddress, nil]
|
108
|
+
optional :shipping_address, -> { Orb::CustomerCreateParams::ShippingAddress }, nil?: true
|
111
109
|
|
112
110
|
# @!attribute tax_configuration
|
113
111
|
#
|
114
|
-
# @return [Orb::
|
115
|
-
optional :tax_configuration, union: -> { Orb::
|
112
|
+
# @return [Orb::CustomerCreateParams::TaxConfiguration::Avalara, Orb::CustomerCreateParams::TaxConfiguration::Taxjar, nil]
|
113
|
+
optional :tax_configuration, union: -> { Orb::CustomerCreateParams::TaxConfiguration }, nil?: true
|
116
114
|
|
117
115
|
# @!attribute tax_id
|
118
116
|
# Tax IDs are commonly required to be displayed on customer invoices, which are
|
@@ -221,8 +219,8 @@ module Orb
|
|
221
219
|
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
222
220
|
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
223
221
|
#
|
224
|
-
# @return [Orb::
|
225
|
-
optional :tax_id, -> { Orb::
|
222
|
+
# @return [Orb::CustomerCreateParams::TaxID, nil]
|
223
|
+
optional :tax_id, -> { Orb::CustomerCreateParams::TaxID }, nil?: true
|
226
224
|
|
227
225
|
# @!attribute timezone
|
228
226
|
# A timezone identifier from the IANA timezone database, such as
|
@@ -237,59 +235,51 @@ module Orb
|
|
237
235
|
# {Orb::Models::CustomerCreateParams} for more details.
|
238
236
|
#
|
239
237
|
# @param email [String] A valid customer email, to be used for notifications. When Orb triggers payment
|
240
|
-
# ...
|
241
238
|
#
|
242
239
|
# @param name [String] The full name of the customer
|
243
240
|
#
|
244
|
-
# @param accounting_sync_configuration [Orb::
|
241
|
+
# @param accounting_sync_configuration [Orb::CustomerCreateParams::AccountingSyncConfiguration, nil]
|
245
242
|
#
|
246
243
|
# @param additional_emails [Array<String>, nil] Additional email addresses for this customer. If populated, these email addresse
|
247
|
-
# ...
|
248
244
|
#
|
249
245
|
# @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch
|
250
|
-
# ...
|
251
246
|
#
|
252
|
-
# @param billing_address [Orb::
|
247
|
+
# @param billing_address [Orb::CustomerCreateParams::BillingAddress, nil]
|
253
248
|
#
|
254
249
|
# @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
|
255
|
-
# ...
|
256
250
|
#
|
257
251
|
# @param email_delivery [Boolean, nil]
|
258
252
|
#
|
259
253
|
# @param external_customer_id [String, nil] An optional user-defined ID for this customer resource, used throughout the syst
|
260
|
-
# ...
|
261
254
|
#
|
262
|
-
# @param hierarchy [Orb::
|
255
|
+
# @param hierarchy [Orb::CustomerCreateParams::Hierarchy, nil] The hierarchical relationships for this customer.
|
263
256
|
#
|
264
257
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
265
|
-
# ...
|
266
258
|
#
|
267
|
-
# @param payment_provider [Symbol, Orb::
|
268
|
-
# ...
|
259
|
+
# @param payment_provider [Symbol, Orb::CustomerCreateParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
|
269
260
|
#
|
270
261
|
# @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
|
271
|
-
# ...
|
272
262
|
#
|
273
|
-
# @param reporting_configuration [Orb::
|
263
|
+
# @param reporting_configuration [Orb::CustomerCreateParams::ReportingConfiguration, nil]
|
274
264
|
#
|
275
|
-
# @param shipping_address [Orb::
|
265
|
+
# @param shipping_address [Orb::CustomerCreateParams::ShippingAddress, nil]
|
276
266
|
#
|
277
|
-
# @param tax_configuration [Orb::
|
267
|
+
# @param tax_configuration [Orb::CustomerCreateParams::TaxConfiguration::Avalara, Orb::CustomerCreateParams::TaxConfiguration::Taxjar, nil]
|
278
268
|
#
|
279
|
-
# @param tax_id [Orb::
|
280
|
-
# ...
|
269
|
+
# @param tax_id [Orb::CustomerCreateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
|
281
270
|
#
|
282
271
|
# @param timezone [String, nil] A timezone identifier from the IANA timezone database, such as `"America/Los_Ang
|
283
|
-
# ...
|
284
272
|
#
|
285
273
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
286
274
|
|
287
275
|
class AccountingSyncConfiguration < Orb::Internal::Type::BaseModel
|
288
276
|
# @!attribute accounting_providers
|
289
277
|
#
|
290
|
-
# @return [Array<Orb::
|
278
|
+
# @return [Array<Orb::CustomerCreateParams::AccountingSyncConfiguration::AccountingProvider>, nil]
|
291
279
|
optional :accounting_providers,
|
292
|
-
-> {
|
280
|
+
-> {
|
281
|
+
Orb::Internal::Type::ArrayOf[Orb::CustomerCreateParams::AccountingSyncConfiguration::AccountingProvider]
|
282
|
+
},
|
293
283
|
nil?: true
|
294
284
|
|
295
285
|
# @!attribute excluded
|
@@ -298,7 +288,7 @@ module Orb
|
|
298
288
|
optional :excluded, Orb::Internal::Type::Boolean, nil?: true
|
299
289
|
|
300
290
|
# @!method initialize(accounting_providers: nil, excluded: nil)
|
301
|
-
# @param accounting_providers [Array<Orb::
|
291
|
+
# @param accounting_providers [Array<Orb::CustomerCreateParams::AccountingSyncConfiguration::AccountingProvider>, nil]
|
302
292
|
# @param excluded [Boolean, nil]
|
303
293
|
|
304
294
|
class AccountingProvider < Orb::Internal::Type::BaseModel
|
@@ -375,15 +365,13 @@ module Orb
|
|
375
365
|
|
376
366
|
# @!method initialize(child_customer_ids: nil, parent_customer_id: nil)
|
377
367
|
# Some parameter documentations has been truncated, see
|
378
|
-
# {Orb::
|
368
|
+
# {Orb::CustomerCreateParams::Hierarchy} for more details.
|
379
369
|
#
|
380
370
|
# The hierarchical relationships for this customer.
|
381
371
|
#
|
382
372
|
# @param child_customer_ids [Array<String>] A list of child customer IDs to add to the hierarchy. The desired child customer
|
383
|
-
# ...
|
384
373
|
#
|
385
374
|
# @param parent_customer_id [String, nil] The ID of the parent customer in the hierarchy. The desired parent customer must
|
386
|
-
# ...
|
387
375
|
end
|
388
376
|
|
389
377
|
# This is used for creating charges or invoices in an external system via Orb.
|
@@ -457,9 +445,9 @@ module Orb
|
|
457
445
|
|
458
446
|
discriminator :tax_provider
|
459
447
|
|
460
|
-
variant :avalara, -> { Orb::
|
448
|
+
variant :avalara, -> { Orb::CustomerCreateParams::TaxConfiguration::Avalara }
|
461
449
|
|
462
|
-
variant :taxjar, -> { Orb::
|
450
|
+
variant :taxjar, -> { Orb::CustomerCreateParams::TaxConfiguration::Taxjar }
|
463
451
|
|
464
452
|
class Avalara < Orb::Internal::Type::BaseModel
|
465
453
|
# @!attribute tax_exempt
|
@@ -500,19 +488,28 @@ module Orb
|
|
500
488
|
end
|
501
489
|
|
502
490
|
# @!method self.variants
|
503
|
-
# @return [Array(Orb::
|
491
|
+
# @return [Array(Orb::CustomerCreateParams::TaxConfiguration::Avalara, Orb::CustomerCreateParams::TaxConfiguration::Taxjar)]
|
492
|
+
|
493
|
+
define_sorbet_constant!(:Variants) do
|
494
|
+
T.type_alias do
|
495
|
+
T.any(
|
496
|
+
Orb::CustomerCreateParams::TaxConfiguration::Avalara,
|
497
|
+
Orb::CustomerCreateParams::TaxConfiguration::Taxjar
|
498
|
+
)
|
499
|
+
end
|
500
|
+
end
|
504
501
|
end
|
505
502
|
|
506
503
|
class TaxID < Orb::Internal::Type::BaseModel
|
507
504
|
# @!attribute country
|
508
505
|
#
|
509
|
-
# @return [Symbol, Orb::
|
510
|
-
required :country, enum: -> { Orb::
|
506
|
+
# @return [Symbol, Orb::CustomerCreateParams::TaxID::Country]
|
507
|
+
required :country, enum: -> { Orb::CustomerCreateParams::TaxID::Country }
|
511
508
|
|
512
509
|
# @!attribute type
|
513
510
|
#
|
514
|
-
# @return [Symbol, Orb::
|
515
|
-
required :type, enum: -> { Orb::
|
511
|
+
# @return [Symbol, Orb::CustomerCreateParams::TaxID::Type]
|
512
|
+
required :type, enum: -> { Orb::CustomerCreateParams::TaxID::Type }
|
516
513
|
|
517
514
|
# @!attribute value
|
518
515
|
#
|
@@ -626,11 +623,11 @@ module Orb
|
|
626
623
|
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
627
624
|
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
628
625
|
#
|
629
|
-
# @param country [Symbol, Orb::
|
630
|
-
# @param type [Symbol, Orb::
|
626
|
+
# @param country [Symbol, Orb::CustomerCreateParams::TaxID::Country]
|
627
|
+
# @param type [Symbol, Orb::CustomerCreateParams::TaxID::Type]
|
631
628
|
# @param value [String]
|
632
629
|
|
633
|
-
# @see Orb::
|
630
|
+
# @see Orb::CustomerCreateParams::TaxID#country
|
634
631
|
module Country
|
635
632
|
extend Orb::Internal::Type::Enum
|
636
633
|
|
@@ -717,7 +714,7 @@ module Orb
|
|
717
714
|
# @return [Array<Symbol>]
|
718
715
|
end
|
719
716
|
|
720
|
-
# @see Orb::
|
717
|
+
# @see Orb::CustomerCreateParams::TaxID#type
|
721
718
|
module Type
|
722
719
|
extend Orb::Internal::Type::Enum
|
723
720
|
|
@@ -9,9 +9,9 @@ module Orb
|
|
9
9
|
|
10
10
|
# @!attribute accounting_sync_configuration
|
11
11
|
#
|
12
|
-
# @return [Orb::
|
12
|
+
# @return [Orb::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration, nil]
|
13
13
|
optional :accounting_sync_configuration,
|
14
|
-
-> { Orb::
|
14
|
+
-> { Orb::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration },
|
15
15
|
nil?: true
|
16
16
|
|
17
17
|
# @!attribute additional_emails
|
@@ -31,10 +31,8 @@ module Orb
|
|
31
31
|
|
32
32
|
# @!attribute billing_address
|
33
33
|
#
|
34
|
-
# @return [Orb::
|
35
|
-
optional :billing_address,
|
36
|
-
-> { Orb::Models::CustomerUpdateByExternalIDParams::BillingAddress },
|
37
|
-
nil?: true
|
34
|
+
# @return [Orb::CustomerUpdateByExternalIDParams::BillingAddress, nil]
|
35
|
+
optional :billing_address, -> { Orb::CustomerUpdateByExternalIDParams::BillingAddress }, nil?: true
|
38
36
|
|
39
37
|
# @!attribute currency
|
40
38
|
# An ISO 4217 currency string used for the customer's invoices and balance. If not
|
@@ -64,8 +62,8 @@ module Orb
|
|
64
62
|
# @!attribute hierarchy
|
65
63
|
# The hierarchical relationships for this customer.
|
66
64
|
#
|
67
|
-
# @return [Orb::
|
68
|
-
optional :hierarchy, -> { Orb::
|
65
|
+
# @return [Orb::CustomerUpdateByExternalIDParams::Hierarchy, nil]
|
66
|
+
optional :hierarchy, -> { Orb::CustomerUpdateByExternalIDParams::Hierarchy }, nil?: true
|
69
67
|
|
70
68
|
# @!attribute metadata
|
71
69
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
@@ -90,9 +88,9 @@ module Orb
|
|
90
88
|
# `bill.com`, `netsuite`), any product mappings must first be configured with
|
91
89
|
# the Orb team.
|
92
90
|
#
|
93
|
-
# @return [Symbol, Orb::
|
91
|
+
# @return [Symbol, Orb::CustomerUpdateByExternalIDParams::PaymentProvider, nil]
|
94
92
|
optional :payment_provider,
|
95
|
-
enum: -> { Orb::
|
93
|
+
enum: -> { Orb::CustomerUpdateByExternalIDParams::PaymentProvider },
|
96
94
|
nil?: true
|
97
95
|
|
98
96
|
# @!attribute payment_provider_id
|
@@ -104,23 +102,21 @@ module Orb
|
|
104
102
|
|
105
103
|
# @!attribute reporting_configuration
|
106
104
|
#
|
107
|
-
# @return [Orb::
|
105
|
+
# @return [Orb::CustomerUpdateByExternalIDParams::ReportingConfiguration, nil]
|
108
106
|
optional :reporting_configuration,
|
109
|
-
-> { Orb::
|
107
|
+
-> { Orb::CustomerUpdateByExternalIDParams::ReportingConfiguration },
|
110
108
|
nil?: true
|
111
109
|
|
112
110
|
# @!attribute shipping_address
|
113
111
|
#
|
114
|
-
# @return [Orb::
|
115
|
-
optional :shipping_address,
|
116
|
-
-> { Orb::Models::CustomerUpdateByExternalIDParams::ShippingAddress },
|
117
|
-
nil?: true
|
112
|
+
# @return [Orb::CustomerUpdateByExternalIDParams::ShippingAddress, nil]
|
113
|
+
optional :shipping_address, -> { Orb::CustomerUpdateByExternalIDParams::ShippingAddress }, nil?: true
|
118
114
|
|
119
115
|
# @!attribute tax_configuration
|
120
116
|
#
|
121
|
-
# @return [Orb::
|
117
|
+
# @return [Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar, nil]
|
122
118
|
optional :tax_configuration,
|
123
|
-
union: -> { Orb::
|
119
|
+
union: -> { Orb::CustomerUpdateByExternalIDParams::TaxConfiguration },
|
124
120
|
nil?: true
|
125
121
|
|
126
122
|
# @!attribute tax_id
|
@@ -230,63 +226,57 @@ module Orb
|
|
230
226
|
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
231
227
|
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
232
228
|
#
|
233
|
-
# @return [Orb::
|
234
|
-
optional :tax_id, -> { Orb::
|
229
|
+
# @return [Orb::CustomerUpdateByExternalIDParams::TaxID, nil]
|
230
|
+
optional :tax_id, -> { Orb::CustomerUpdateByExternalIDParams::TaxID }, nil?: true
|
235
231
|
|
236
232
|
# @!method initialize(accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {})
|
237
233
|
# Some parameter documentations has been truncated, see
|
238
234
|
# {Orb::Models::CustomerUpdateByExternalIDParams} for more details.
|
239
235
|
#
|
240
|
-
# @param accounting_sync_configuration [Orb::
|
236
|
+
# @param accounting_sync_configuration [Orb::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration, nil]
|
241
237
|
#
|
242
238
|
# @param additional_emails [Array<String>, nil] Additional email addresses for this customer. If populated, these email addresse
|
243
|
-
# ...
|
244
239
|
#
|
245
240
|
# @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch
|
246
|
-
# ...
|
247
241
|
#
|
248
|
-
# @param billing_address [Orb::
|
242
|
+
# @param billing_address [Orb::CustomerUpdateByExternalIDParams::BillingAddress, nil]
|
249
243
|
#
|
250
244
|
# @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
|
251
|
-
# ...
|
252
245
|
#
|
253
246
|
# @param email [String, nil] A valid customer email, to be used for invoicing and notifications.
|
254
247
|
#
|
255
248
|
# @param email_delivery [Boolean, nil]
|
256
249
|
#
|
257
250
|
# @param external_customer_id [String, nil] The external customer ID. This can only be set if empty and the customer has no
|
258
|
-
# ...
|
259
251
|
#
|
260
|
-
# @param hierarchy [Orb::
|
252
|
+
# @param hierarchy [Orb::CustomerUpdateByExternalIDParams::Hierarchy, nil] The hierarchical relationships for this customer.
|
261
253
|
#
|
262
254
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
263
|
-
# ...
|
264
255
|
#
|
265
256
|
# @param name [String, nil] The full name of the customer
|
266
257
|
#
|
267
|
-
# @param payment_provider [Symbol, Orb::
|
268
|
-
# ...
|
258
|
+
# @param payment_provider [Symbol, Orb::CustomerUpdateByExternalIDParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
|
269
259
|
#
|
270
260
|
# @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
|
271
|
-
# ...
|
272
261
|
#
|
273
|
-
# @param reporting_configuration [Orb::
|
262
|
+
# @param reporting_configuration [Orb::CustomerUpdateByExternalIDParams::ReportingConfiguration, nil]
|
274
263
|
#
|
275
|
-
# @param shipping_address [Orb::
|
264
|
+
# @param shipping_address [Orb::CustomerUpdateByExternalIDParams::ShippingAddress, nil]
|
276
265
|
#
|
277
|
-
# @param tax_configuration [Orb::
|
266
|
+
# @param tax_configuration [Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar, nil]
|
278
267
|
#
|
279
|
-
# @param tax_id [Orb::
|
280
|
-
# ...
|
268
|
+
# @param tax_id [Orb::CustomerUpdateByExternalIDParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
|
281
269
|
#
|
282
270
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
283
271
|
|
284
272
|
class AccountingSyncConfiguration < Orb::Internal::Type::BaseModel
|
285
273
|
# @!attribute accounting_providers
|
286
274
|
#
|
287
|
-
# @return [Array<Orb::
|
275
|
+
# @return [Array<Orb::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration::AccountingProvider>, nil]
|
288
276
|
optional :accounting_providers,
|
289
|
-
-> {
|
277
|
+
-> {
|
278
|
+
Orb::Internal::Type::ArrayOf[Orb::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration::AccountingProvider]
|
279
|
+
},
|
290
280
|
nil?: true
|
291
281
|
|
292
282
|
# @!attribute excluded
|
@@ -295,7 +285,7 @@ module Orb
|
|
295
285
|
optional :excluded, Orb::Internal::Type::Boolean, nil?: true
|
296
286
|
|
297
287
|
# @!method initialize(accounting_providers: nil, excluded: nil)
|
298
|
-
# @param accounting_providers [Array<Orb::
|
288
|
+
# @param accounting_providers [Array<Orb::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration::AccountingProvider>, nil]
|
299
289
|
# @param excluded [Boolean, nil]
|
300
290
|
|
301
291
|
class AccountingProvider < Orb::Internal::Type::BaseModel
|
@@ -372,15 +362,13 @@ module Orb
|
|
372
362
|
|
373
363
|
# @!method initialize(child_customer_ids: nil, parent_customer_id: nil)
|
374
364
|
# Some parameter documentations has been truncated, see
|
375
|
-
# {Orb::
|
365
|
+
# {Orb::CustomerUpdateByExternalIDParams::Hierarchy} for more details.
|
376
366
|
#
|
377
367
|
# The hierarchical relationships for this customer.
|
378
368
|
#
|
379
369
|
# @param child_customer_ids [Array<String>] A list of child customer IDs to add to the hierarchy. The desired child customer
|
380
|
-
# ...
|
381
370
|
#
|
382
371
|
# @param parent_customer_id [String, nil] The ID of the parent customer in the hierarchy. The desired parent customer must
|
383
|
-
# ...
|
384
372
|
end
|
385
373
|
|
386
374
|
# This is used for creating charges or invoices in an external system via Orb.
|
@@ -458,9 +446,9 @@ module Orb
|
|
458
446
|
|
459
447
|
discriminator :tax_provider
|
460
448
|
|
461
|
-
variant :avalara, -> { Orb::
|
449
|
+
variant :avalara, -> { Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara }
|
462
450
|
|
463
|
-
variant :taxjar, -> { Orb::
|
451
|
+
variant :taxjar, -> { Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar }
|
464
452
|
|
465
453
|
class Avalara < Orb::Internal::Type::BaseModel
|
466
454
|
# @!attribute tax_exempt
|
@@ -501,19 +489,28 @@ module Orb
|
|
501
489
|
end
|
502
490
|
|
503
491
|
# @!method self.variants
|
504
|
-
# @return [Array(Orb::
|
492
|
+
# @return [Array(Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar)]
|
493
|
+
|
494
|
+
define_sorbet_constant!(:Variants) do
|
495
|
+
T.type_alias do
|
496
|
+
T.any(
|
497
|
+
Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara,
|
498
|
+
Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar
|
499
|
+
)
|
500
|
+
end
|
501
|
+
end
|
505
502
|
end
|
506
503
|
|
507
504
|
class TaxID < Orb::Internal::Type::BaseModel
|
508
505
|
# @!attribute country
|
509
506
|
#
|
510
|
-
# @return [Symbol, Orb::
|
511
|
-
required :country, enum: -> { Orb::
|
507
|
+
# @return [Symbol, Orb::CustomerUpdateByExternalIDParams::TaxID::Country]
|
508
|
+
required :country, enum: -> { Orb::CustomerUpdateByExternalIDParams::TaxID::Country }
|
512
509
|
|
513
510
|
# @!attribute type
|
514
511
|
#
|
515
|
-
# @return [Symbol, Orb::
|
516
|
-
required :type, enum: -> { Orb::
|
512
|
+
# @return [Symbol, Orb::CustomerUpdateByExternalIDParams::TaxID::Type]
|
513
|
+
required :type, enum: -> { Orb::CustomerUpdateByExternalIDParams::TaxID::Type }
|
517
514
|
|
518
515
|
# @!attribute value
|
519
516
|
#
|
@@ -627,11 +624,11 @@ module Orb
|
|
627
624
|
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
628
625
|
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
629
626
|
#
|
630
|
-
# @param country [Symbol, Orb::
|
631
|
-
# @param type [Symbol, Orb::
|
627
|
+
# @param country [Symbol, Orb::CustomerUpdateByExternalIDParams::TaxID::Country]
|
628
|
+
# @param type [Symbol, Orb::CustomerUpdateByExternalIDParams::TaxID::Type]
|
632
629
|
# @param value [String]
|
633
630
|
|
634
|
-
# @see Orb::
|
631
|
+
# @see Orb::CustomerUpdateByExternalIDParams::TaxID#country
|
635
632
|
module Country
|
636
633
|
extend Orb::Internal::Type::Enum
|
637
634
|
|
@@ -718,7 +715,7 @@ module Orb
|
|
718
715
|
# @return [Array<Symbol>]
|
719
716
|
end
|
720
717
|
|
721
|
-
# @see Orb::
|
718
|
+
# @see Orb::CustomerUpdateByExternalIDParams::TaxID#type
|
722
719
|
module Type
|
723
720
|
extend Orb::Internal::Type::Enum
|
724
721
|
|