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
data/lib/orb/models/customer.rb
CHANGED
@@ -27,8 +27,8 @@ module Orb
|
|
27
27
|
|
28
28
|
# @!attribute billing_address
|
29
29
|
#
|
30
|
-
# @return [Orb::
|
31
|
-
required :billing_address, -> { Orb::
|
30
|
+
# @return [Orb::Customer::BillingAddress, nil]
|
31
|
+
required :billing_address, -> { Orb::Customer::BillingAddress }, nil?: true
|
32
32
|
|
33
33
|
# @!attribute created_at
|
34
34
|
#
|
@@ -69,8 +69,8 @@ module Orb
|
|
69
69
|
# @!attribute hierarchy
|
70
70
|
# The hierarchical relationships for this customer.
|
71
71
|
#
|
72
|
-
# @return [Orb::
|
73
|
-
required :hierarchy, -> { Orb::
|
72
|
+
# @return [Orb::Customer::Hierarchy]
|
73
|
+
required :hierarchy, -> { Orb::Customer::Hierarchy }
|
74
74
|
|
75
75
|
# @!attribute metadata
|
76
76
|
# User specified key-value pairs for the resource. If not present, this defaults
|
@@ -92,8 +92,8 @@ module Orb
|
|
92
92
|
# When not in test mode, the connection must first be configured in the Orb
|
93
93
|
# webapp.
|
94
94
|
#
|
95
|
-
# @return [Symbol, Orb::
|
96
|
-
required :payment_provider, enum: -> { Orb::
|
95
|
+
# @return [Symbol, Orb::Customer::PaymentProvider, nil]
|
96
|
+
required :payment_provider, enum: -> { Orb::Customer::PaymentProvider }, nil?: true
|
97
97
|
|
98
98
|
# @!attribute payment_provider_id
|
99
99
|
# The ID of this customer in an external payments solution, such as Stripe. This
|
@@ -109,8 +109,8 @@ module Orb
|
|
109
109
|
|
110
110
|
# @!attribute shipping_address
|
111
111
|
#
|
112
|
-
# @return [Orb::
|
113
|
-
required :shipping_address, -> { Orb::
|
112
|
+
# @return [Orb::Customer::ShippingAddress, nil]
|
113
|
+
required :shipping_address, -> { Orb::Customer::ShippingAddress }, nil?: true
|
114
114
|
|
115
115
|
# @!attribute tax_id
|
116
116
|
# Tax IDs are commonly required to be displayed on customer invoices, which are
|
@@ -219,8 +219,8 @@ module Orb
|
|
219
219
|
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
220
220
|
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
221
221
|
#
|
222
|
-
# @return [Orb::
|
223
|
-
required :tax_id, -> { Orb::
|
222
|
+
# @return [Orb::Customer::TaxID, nil]
|
223
|
+
required :tax_id, -> { Orb::Customer::TaxID }, nil?: true
|
224
224
|
|
225
225
|
# @!attribute timezone
|
226
226
|
# A timezone identifier from the IANA timezone database, such as
|
@@ -232,19 +232,17 @@ module Orb
|
|
232
232
|
|
233
233
|
# @!attribute accounting_sync_configuration
|
234
234
|
#
|
235
|
-
# @return [Orb::
|
236
|
-
optional :accounting_sync_configuration,
|
237
|
-
-> { Orb::Models::Customer::AccountingSyncConfiguration },
|
238
|
-
nil?: true
|
235
|
+
# @return [Orb::Customer::AccountingSyncConfiguration, nil]
|
236
|
+
optional :accounting_sync_configuration, -> { Orb::Customer::AccountingSyncConfiguration }, nil?: true
|
239
237
|
|
240
238
|
# @!attribute reporting_configuration
|
241
239
|
#
|
242
|
-
# @return [Orb::
|
243
|
-
optional :reporting_configuration, -> { Orb::
|
240
|
+
# @return [Orb::Customer::ReportingConfiguration, nil]
|
241
|
+
optional :reporting_configuration, -> { Orb::Customer::ReportingConfiguration }, nil?: true
|
244
242
|
|
245
243
|
# @!method initialize(id:, additional_emails:, auto_collection:, balance:, billing_address:, created_at:, currency:, email:, email_delivery:, exempt_from_automated_tax:, external_customer_id:, hierarchy:, metadata:, name:, payment_provider:, payment_provider_id:, portal_url:, shipping_address:, tax_id:, timezone:, accounting_sync_configuration: nil, reporting_configuration: nil)
|
246
|
-
# Some parameter documentations has been truncated, see {Orb::
|
247
|
-
#
|
244
|
+
# Some parameter documentations has been truncated, see {Orb::Customer} for more
|
245
|
+
# details.
|
248
246
|
#
|
249
247
|
# A customer is a buyer of your products, and the other party to the billing
|
250
248
|
# relationship.
|
@@ -273,50 +271,43 @@ module Orb
|
|
273
271
|
#
|
274
272
|
# @param balance [String] The customer's current balance in their currency.
|
275
273
|
#
|
276
|
-
# @param billing_address [Orb::
|
274
|
+
# @param billing_address [Orb::Customer::BillingAddress, nil]
|
277
275
|
#
|
278
276
|
# @param created_at [Time]
|
279
277
|
#
|
280
278
|
# @param currency [String, nil]
|
281
279
|
#
|
282
280
|
# @param email [String] A valid customer email, to be used for notifications. When Orb triggers payment
|
283
|
-
# ...
|
284
281
|
#
|
285
282
|
# @param email_delivery [Boolean]
|
286
283
|
#
|
287
284
|
# @param exempt_from_automated_tax [Boolean, nil]
|
288
285
|
#
|
289
286
|
# @param external_customer_id [String, nil] An optional user-defined ID for this customer resource, used throughout the syst
|
290
|
-
# ...
|
291
287
|
#
|
292
|
-
# @param hierarchy [Orb::
|
288
|
+
# @param hierarchy [Orb::Customer::Hierarchy] The hierarchical relationships for this customer.
|
293
289
|
#
|
294
290
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
295
|
-
# ...
|
296
291
|
#
|
297
292
|
# @param name [String] The full name of the customer
|
298
293
|
#
|
299
|
-
# @param payment_provider [Symbol, Orb::
|
300
|
-
# ...
|
294
|
+
# @param payment_provider [Symbol, Orb::Customer::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
|
301
295
|
#
|
302
296
|
# @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
|
303
|
-
# ...
|
304
297
|
#
|
305
298
|
# @param portal_url [String, nil]
|
306
299
|
#
|
307
|
-
# @param shipping_address [Orb::
|
300
|
+
# @param shipping_address [Orb::Customer::ShippingAddress, nil]
|
308
301
|
#
|
309
|
-
# @param tax_id [Orb::
|
310
|
-
# ...
|
302
|
+
# @param tax_id [Orb::Customer::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
|
311
303
|
#
|
312
304
|
# @param timezone [String] A timezone identifier from the IANA timezone database, such as "America/Los_Ange
|
313
|
-
# ...
|
314
305
|
#
|
315
|
-
# @param accounting_sync_configuration [Orb::
|
306
|
+
# @param accounting_sync_configuration [Orb::Customer::AccountingSyncConfiguration, nil]
|
316
307
|
#
|
317
|
-
# @param reporting_configuration [Orb::
|
308
|
+
# @param reporting_configuration [Orb::Customer::ReportingConfiguration, nil]
|
318
309
|
|
319
|
-
# @see Orb::
|
310
|
+
# @see Orb::Customer#billing_address
|
320
311
|
class BillingAddress < Orb::Internal::Type::BaseModel
|
321
312
|
# @!attribute city
|
322
313
|
#
|
@@ -357,23 +348,23 @@ module Orb
|
|
357
348
|
# @param state [String, nil]
|
358
349
|
end
|
359
350
|
|
360
|
-
# @see Orb::
|
351
|
+
# @see Orb::Customer#hierarchy
|
361
352
|
class Hierarchy < Orb::Internal::Type::BaseModel
|
362
353
|
# @!attribute children
|
363
354
|
#
|
364
|
-
# @return [Array<Orb::
|
365
|
-
required :children, -> { Orb::Internal::Type::ArrayOf[Orb::
|
355
|
+
# @return [Array<Orb::Customer::Hierarchy::Child>]
|
356
|
+
required :children, -> { Orb::Internal::Type::ArrayOf[Orb::Customer::Hierarchy::Child] }
|
366
357
|
|
367
358
|
# @!attribute parent
|
368
359
|
#
|
369
|
-
# @return [Orb::
|
370
|
-
required :parent, -> { Orb::
|
360
|
+
# @return [Orb::Customer::Hierarchy::Parent, nil]
|
361
|
+
required :parent, -> { Orb::Customer::Hierarchy::Parent }, nil?: true
|
371
362
|
|
372
363
|
# @!method initialize(children:, parent:)
|
373
364
|
# The hierarchical relationships for this customer.
|
374
365
|
#
|
375
|
-
# @param children [Array<Orb::
|
376
|
-
# @param parent [Orb::
|
366
|
+
# @param children [Array<Orb::Customer::Hierarchy::Child>]
|
367
|
+
# @param parent [Orb::Customer::Hierarchy::Parent, nil]
|
377
368
|
|
378
369
|
class Child < Orb::Internal::Type::BaseModel
|
379
370
|
# @!attribute id
|
@@ -391,7 +382,7 @@ module Orb
|
|
391
382
|
# @param external_customer_id [String, nil]
|
392
383
|
end
|
393
384
|
|
394
|
-
# @see Orb::
|
385
|
+
# @see Orb::Customer::Hierarchy#parent
|
395
386
|
class Parent < Orb::Internal::Type::BaseModel
|
396
387
|
# @!attribute id
|
397
388
|
#
|
@@ -413,7 +404,7 @@ module Orb
|
|
413
404
|
# When not in test mode, the connection must first be configured in the Orb
|
414
405
|
# webapp.
|
415
406
|
#
|
416
|
-
# @see Orb::
|
407
|
+
# @see Orb::Customer#payment_provider
|
417
408
|
module PaymentProvider
|
418
409
|
extend Orb::Internal::Type::Enum
|
419
410
|
|
@@ -427,7 +418,7 @@ module Orb
|
|
427
418
|
# @return [Array<Symbol>]
|
428
419
|
end
|
429
420
|
|
430
|
-
# @see Orb::
|
421
|
+
# @see Orb::Customer#shipping_address
|
431
422
|
class ShippingAddress < Orb::Internal::Type::BaseModel
|
432
423
|
# @!attribute city
|
433
424
|
#
|
@@ -468,17 +459,17 @@ module Orb
|
|
468
459
|
# @param state [String, nil]
|
469
460
|
end
|
470
461
|
|
471
|
-
# @see Orb::
|
462
|
+
# @see Orb::Customer#tax_id
|
472
463
|
class TaxID < Orb::Internal::Type::BaseModel
|
473
464
|
# @!attribute country
|
474
465
|
#
|
475
|
-
# @return [Symbol, Orb::
|
476
|
-
required :country, enum: -> { Orb::
|
466
|
+
# @return [Symbol, Orb::Customer::TaxID::Country]
|
467
|
+
required :country, enum: -> { Orb::Customer::TaxID::Country }
|
477
468
|
|
478
469
|
# @!attribute type
|
479
470
|
#
|
480
|
-
# @return [Symbol, Orb::
|
481
|
-
required :type, enum: -> { Orb::
|
471
|
+
# @return [Symbol, Orb::Customer::TaxID::Type]
|
472
|
+
required :type, enum: -> { Orb::Customer::TaxID::Type }
|
482
473
|
|
483
474
|
# @!attribute value
|
484
475
|
#
|
@@ -592,11 +583,11 @@ module Orb
|
|
592
583
|
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
593
584
|
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
594
585
|
#
|
595
|
-
# @param country [Symbol, Orb::
|
596
|
-
# @param type [Symbol, Orb::
|
586
|
+
# @param country [Symbol, Orb::Customer::TaxID::Country]
|
587
|
+
# @param type [Symbol, Orb::Customer::TaxID::Type]
|
597
588
|
# @param value [String]
|
598
589
|
|
599
|
-
# @see Orb::
|
590
|
+
# @see Orb::Customer::TaxID#country
|
600
591
|
module Country
|
601
592
|
extend Orb::Internal::Type::Enum
|
602
593
|
|
@@ -683,7 +674,7 @@ module Orb
|
|
683
674
|
# @return [Array<Symbol>]
|
684
675
|
end
|
685
676
|
|
686
|
-
# @see Orb::
|
677
|
+
# @see Orb::Customer::TaxID#type
|
687
678
|
module Type
|
688
679
|
extend Orb::Internal::Type::Enum
|
689
680
|
|
@@ -764,13 +755,15 @@ module Orb
|
|
764
755
|
end
|
765
756
|
end
|
766
757
|
|
767
|
-
# @see Orb::
|
758
|
+
# @see Orb::Customer#accounting_sync_configuration
|
768
759
|
class AccountingSyncConfiguration < Orb::Internal::Type::BaseModel
|
769
760
|
# @!attribute accounting_providers
|
770
761
|
#
|
771
|
-
# @return [Array<Orb::
|
762
|
+
# @return [Array<Orb::Customer::AccountingSyncConfiguration::AccountingProvider>]
|
772
763
|
required :accounting_providers,
|
773
|
-
-> {
|
764
|
+
-> {
|
765
|
+
Orb::Internal::Type::ArrayOf[Orb::Customer::AccountingSyncConfiguration::AccountingProvider]
|
766
|
+
}
|
774
767
|
|
775
768
|
# @!attribute excluded
|
776
769
|
#
|
@@ -778,7 +771,7 @@ module Orb
|
|
778
771
|
required :excluded, Orb::Internal::Type::Boolean
|
779
772
|
|
780
773
|
# @!method initialize(accounting_providers:, excluded:)
|
781
|
-
# @param accounting_providers [Array<Orb::
|
774
|
+
# @param accounting_providers [Array<Orb::Customer::AccountingSyncConfiguration::AccountingProvider>]
|
782
775
|
# @param excluded [Boolean]
|
783
776
|
|
784
777
|
class AccountingProvider < Orb::Internal::Type::BaseModel
|
@@ -789,15 +782,15 @@ module Orb
|
|
789
782
|
|
790
783
|
# @!attribute provider_type
|
791
784
|
#
|
792
|
-
# @return [Symbol, Orb::
|
785
|
+
# @return [Symbol, Orb::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType]
|
793
786
|
required :provider_type,
|
794
|
-
enum: -> { Orb::
|
787
|
+
enum: -> { Orb::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType }
|
795
788
|
|
796
789
|
# @!method initialize(external_provider_id:, provider_type:)
|
797
790
|
# @param external_provider_id [String, nil]
|
798
|
-
# @param provider_type [Symbol, Orb::
|
791
|
+
# @param provider_type [Symbol, Orb::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType]
|
799
792
|
|
800
|
-
# @see Orb::
|
793
|
+
# @see Orb::Customer::AccountingSyncConfiguration::AccountingProvider#provider_type
|
801
794
|
module ProviderType
|
802
795
|
extend Orb::Internal::Type::Enum
|
803
796
|
|
@@ -810,7 +803,7 @@ module Orb
|
|
810
803
|
end
|
811
804
|
end
|
812
805
|
|
813
|
-
# @see Orb::
|
806
|
+
# @see Orb::Customer#reporting_configuration
|
814
807
|
class ReportingConfiguration < Orb::Internal::Type::BaseModel
|
815
808
|
# @!attribute exempt
|
816
809
|
#
|
@@ -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,19 @@ 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)]
|
504
492
|
end
|
505
493
|
|
506
494
|
class TaxID < Orb::Internal::Type::BaseModel
|
507
495
|
# @!attribute country
|
508
496
|
#
|
509
|
-
# @return [Symbol, Orb::
|
510
|
-
required :country, enum: -> { Orb::
|
497
|
+
# @return [Symbol, Orb::CustomerCreateParams::TaxID::Country]
|
498
|
+
required :country, enum: -> { Orb::CustomerCreateParams::TaxID::Country }
|
511
499
|
|
512
500
|
# @!attribute type
|
513
501
|
#
|
514
|
-
# @return [Symbol, Orb::
|
515
|
-
required :type, enum: -> { Orb::
|
502
|
+
# @return [Symbol, Orb::CustomerCreateParams::TaxID::Type]
|
503
|
+
required :type, enum: -> { Orb::CustomerCreateParams::TaxID::Type }
|
516
504
|
|
517
505
|
# @!attribute value
|
518
506
|
#
|
@@ -626,11 +614,11 @@ module Orb
|
|
626
614
|
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
627
615
|
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
628
616
|
#
|
629
|
-
# @param country [Symbol, Orb::
|
630
|
-
# @param type [Symbol, Orb::
|
617
|
+
# @param country [Symbol, Orb::CustomerCreateParams::TaxID::Country]
|
618
|
+
# @param type [Symbol, Orb::CustomerCreateParams::TaxID::Type]
|
631
619
|
# @param value [String]
|
632
620
|
|
633
|
-
# @see Orb::
|
621
|
+
# @see Orb::CustomerCreateParams::TaxID#country
|
634
622
|
module Country
|
635
623
|
extend Orb::Internal::Type::Enum
|
636
624
|
|
@@ -717,7 +705,7 @@ module Orb
|
|
717
705
|
# @return [Array<Symbol>]
|
718
706
|
end
|
719
707
|
|
720
|
-
# @see Orb::
|
708
|
+
# @see Orb::CustomerCreateParams::TaxID#type
|
721
709
|
module Type
|
722
710
|
extend Orb::Internal::Type::Enum
|
723
711
|
|