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
@@ -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,19 @@ 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)]
|
505
493
|
end
|
506
494
|
|
507
495
|
class TaxID < Orb::Internal::Type::BaseModel
|
508
496
|
# @!attribute country
|
509
497
|
#
|
510
|
-
# @return [Symbol, Orb::
|
511
|
-
required :country, enum: -> { Orb::
|
498
|
+
# @return [Symbol, Orb::CustomerUpdateByExternalIDParams::TaxID::Country]
|
499
|
+
required :country, enum: -> { Orb::CustomerUpdateByExternalIDParams::TaxID::Country }
|
512
500
|
|
513
501
|
# @!attribute type
|
514
502
|
#
|
515
|
-
# @return [Symbol, Orb::
|
516
|
-
required :type, enum: -> { Orb::
|
503
|
+
# @return [Symbol, Orb::CustomerUpdateByExternalIDParams::TaxID::Type]
|
504
|
+
required :type, enum: -> { Orb::CustomerUpdateByExternalIDParams::TaxID::Type }
|
517
505
|
|
518
506
|
# @!attribute value
|
519
507
|
#
|
@@ -627,11 +615,11 @@ module Orb
|
|
627
615
|
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
628
616
|
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
629
617
|
#
|
630
|
-
# @param country [Symbol, Orb::
|
631
|
-
# @param type [Symbol, Orb::
|
618
|
+
# @param country [Symbol, Orb::CustomerUpdateByExternalIDParams::TaxID::Country]
|
619
|
+
# @param type [Symbol, Orb::CustomerUpdateByExternalIDParams::TaxID::Type]
|
632
620
|
# @param value [String]
|
633
621
|
|
634
|
-
# @see Orb::
|
622
|
+
# @see Orb::CustomerUpdateByExternalIDParams::TaxID#country
|
635
623
|
module Country
|
636
624
|
extend Orb::Internal::Type::Enum
|
637
625
|
|
@@ -718,7 +706,7 @@ module Orb
|
|
718
706
|
# @return [Array<Symbol>]
|
719
707
|
end
|
720
708
|
|
721
|
-
# @see Orb::
|
709
|
+
# @see Orb::CustomerUpdateByExternalIDParams::TaxID#type
|
722
710
|
module Type
|
723
711
|
extend Orb::Internal::Type::Enum
|
724
712
|
|
@@ -9,9 +9,9 @@ module Orb
|
|
9
9
|
|
10
10
|
# @!attribute accounting_sync_configuration
|
11
11
|
#
|
12
|
-
# @return [Orb::
|
12
|
+
# @return [Orb::CustomerUpdateParams::AccountingSyncConfiguration, nil]
|
13
13
|
optional :accounting_sync_configuration,
|
14
|
-
-> { Orb::
|
14
|
+
-> { Orb::CustomerUpdateParams::AccountingSyncConfiguration },
|
15
15
|
nil?: true
|
16
16
|
|
17
17
|
# @!attribute additional_emails
|
@@ -31,8 +31,8 @@ module Orb
|
|
31
31
|
|
32
32
|
# @!attribute billing_address
|
33
33
|
#
|
34
|
-
# @return [Orb::
|
35
|
-
optional :billing_address, -> { Orb::
|
34
|
+
# @return [Orb::CustomerUpdateParams::BillingAddress, nil]
|
35
|
+
optional :billing_address, -> { Orb::CustomerUpdateParams::BillingAddress }, nil?: true
|
36
36
|
|
37
37
|
# @!attribute currency
|
38
38
|
# An ISO 4217 currency string used for the customer's invoices and balance. If not
|
@@ -62,8 +62,8 @@ module Orb
|
|
62
62
|
# @!attribute hierarchy
|
63
63
|
# The hierarchical relationships for this customer.
|
64
64
|
#
|
65
|
-
# @return [Orb::
|
66
|
-
optional :hierarchy, -> { Orb::
|
65
|
+
# @return [Orb::CustomerUpdateParams::Hierarchy, nil]
|
66
|
+
optional :hierarchy, -> { Orb::CustomerUpdateParams::Hierarchy }, nil?: true
|
67
67
|
|
68
68
|
# @!attribute metadata
|
69
69
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
@@ -88,8 +88,8 @@ module Orb
|
|
88
88
|
# `bill.com`, `netsuite`), any product mappings must first be configured with
|
89
89
|
# the Orb team.
|
90
90
|
#
|
91
|
-
# @return [Symbol, Orb::
|
92
|
-
optional :payment_provider, enum: -> { Orb::
|
91
|
+
# @return [Symbol, Orb::CustomerUpdateParams::PaymentProvider, nil]
|
92
|
+
optional :payment_provider, enum: -> { Orb::CustomerUpdateParams::PaymentProvider }, nil?: true
|
93
93
|
|
94
94
|
# @!attribute payment_provider_id
|
95
95
|
# The ID of this customer in an external payments solution, such as Stripe. This
|
@@ -100,20 +100,18 @@ module Orb
|
|
100
100
|
|
101
101
|
# @!attribute reporting_configuration
|
102
102
|
#
|
103
|
-
# @return [Orb::
|
104
|
-
optional :reporting_configuration,
|
105
|
-
-> { Orb::Models::CustomerUpdateParams::ReportingConfiguration },
|
106
|
-
nil?: true
|
103
|
+
# @return [Orb::CustomerUpdateParams::ReportingConfiguration, nil]
|
104
|
+
optional :reporting_configuration, -> { Orb::CustomerUpdateParams::ReportingConfiguration }, nil?: true
|
107
105
|
|
108
106
|
# @!attribute shipping_address
|
109
107
|
#
|
110
|
-
# @return [Orb::
|
111
|
-
optional :shipping_address, -> { Orb::
|
108
|
+
# @return [Orb::CustomerUpdateParams::ShippingAddress, nil]
|
109
|
+
optional :shipping_address, -> { Orb::CustomerUpdateParams::ShippingAddress }, nil?: true
|
112
110
|
|
113
111
|
# @!attribute tax_configuration
|
114
112
|
#
|
115
|
-
# @return [Orb::
|
116
|
-
optional :tax_configuration, union: -> { Orb::
|
113
|
+
# @return [Orb::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::CustomerUpdateParams::TaxConfiguration::Taxjar, nil]
|
114
|
+
optional :tax_configuration, union: -> { Orb::CustomerUpdateParams::TaxConfiguration }, nil?: true
|
117
115
|
|
118
116
|
# @!attribute tax_id
|
119
117
|
# Tax IDs are commonly required to be displayed on customer invoices, which are
|
@@ -222,63 +220,57 @@ module Orb
|
|
222
220
|
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
223
221
|
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
224
222
|
#
|
225
|
-
# @return [Orb::
|
226
|
-
optional :tax_id, -> { Orb::
|
223
|
+
# @return [Orb::CustomerUpdateParams::TaxID, nil]
|
224
|
+
optional :tax_id, -> { Orb::CustomerUpdateParams::TaxID }, nil?: true
|
227
225
|
|
228
226
|
# @!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: {})
|
229
227
|
# Some parameter documentations has been truncated, see
|
230
228
|
# {Orb::Models::CustomerUpdateParams} for more details.
|
231
229
|
#
|
232
|
-
# @param accounting_sync_configuration [Orb::
|
230
|
+
# @param accounting_sync_configuration [Orb::CustomerUpdateParams::AccountingSyncConfiguration, nil]
|
233
231
|
#
|
234
232
|
# @param additional_emails [Array<String>, nil] Additional email addresses for this customer. If populated, these email addresse
|
235
|
-
# ...
|
236
233
|
#
|
237
234
|
# @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch
|
238
|
-
# ...
|
239
235
|
#
|
240
|
-
# @param billing_address [Orb::
|
236
|
+
# @param billing_address [Orb::CustomerUpdateParams::BillingAddress, nil]
|
241
237
|
#
|
242
238
|
# @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
|
243
|
-
# ...
|
244
239
|
#
|
245
240
|
# @param email [String, nil] A valid customer email, to be used for invoicing and notifications.
|
246
241
|
#
|
247
242
|
# @param email_delivery [Boolean, nil]
|
248
243
|
#
|
249
244
|
# @param external_customer_id [String, nil] The external customer ID. This can only be set if empty and the customer has no
|
250
|
-
# ...
|
251
245
|
#
|
252
|
-
# @param hierarchy [Orb::
|
246
|
+
# @param hierarchy [Orb::CustomerUpdateParams::Hierarchy, nil] The hierarchical relationships for this customer.
|
253
247
|
#
|
254
248
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
255
|
-
# ...
|
256
249
|
#
|
257
250
|
# @param name [String, nil] The full name of the customer
|
258
251
|
#
|
259
|
-
# @param payment_provider [Symbol, Orb::
|
260
|
-
# ...
|
252
|
+
# @param payment_provider [Symbol, Orb::CustomerUpdateParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
|
261
253
|
#
|
262
254
|
# @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
|
263
|
-
# ...
|
264
255
|
#
|
265
|
-
# @param reporting_configuration [Orb::
|
256
|
+
# @param reporting_configuration [Orb::CustomerUpdateParams::ReportingConfiguration, nil]
|
266
257
|
#
|
267
|
-
# @param shipping_address [Orb::
|
258
|
+
# @param shipping_address [Orb::CustomerUpdateParams::ShippingAddress, nil]
|
268
259
|
#
|
269
|
-
# @param tax_configuration [Orb::
|
260
|
+
# @param tax_configuration [Orb::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::CustomerUpdateParams::TaxConfiguration::Taxjar, nil]
|
270
261
|
#
|
271
|
-
# @param tax_id [Orb::
|
272
|
-
# ...
|
262
|
+
# @param tax_id [Orb::CustomerUpdateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
|
273
263
|
#
|
274
264
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
275
265
|
|
276
266
|
class AccountingSyncConfiguration < Orb::Internal::Type::BaseModel
|
277
267
|
# @!attribute accounting_providers
|
278
268
|
#
|
279
|
-
# @return [Array<Orb::
|
269
|
+
# @return [Array<Orb::CustomerUpdateParams::AccountingSyncConfiguration::AccountingProvider>, nil]
|
280
270
|
optional :accounting_providers,
|
281
|
-
-> {
|
271
|
+
-> {
|
272
|
+
Orb::Internal::Type::ArrayOf[Orb::CustomerUpdateParams::AccountingSyncConfiguration::AccountingProvider]
|
273
|
+
},
|
282
274
|
nil?: true
|
283
275
|
|
284
276
|
# @!attribute excluded
|
@@ -287,7 +279,7 @@ module Orb
|
|
287
279
|
optional :excluded, Orb::Internal::Type::Boolean, nil?: true
|
288
280
|
|
289
281
|
# @!method initialize(accounting_providers: nil, excluded: nil)
|
290
|
-
# @param accounting_providers [Array<Orb::
|
282
|
+
# @param accounting_providers [Array<Orb::CustomerUpdateParams::AccountingSyncConfiguration::AccountingProvider>, nil]
|
291
283
|
# @param excluded [Boolean, nil]
|
292
284
|
|
293
285
|
class AccountingProvider < Orb::Internal::Type::BaseModel
|
@@ -364,15 +356,13 @@ module Orb
|
|
364
356
|
|
365
357
|
# @!method initialize(child_customer_ids: nil, parent_customer_id: nil)
|
366
358
|
# Some parameter documentations has been truncated, see
|
367
|
-
# {Orb::
|
359
|
+
# {Orb::CustomerUpdateParams::Hierarchy} for more details.
|
368
360
|
#
|
369
361
|
# The hierarchical relationships for this customer.
|
370
362
|
#
|
371
363
|
# @param child_customer_ids [Array<String>] A list of child customer IDs to add to the hierarchy. The desired child customer
|
372
|
-
# ...
|
373
364
|
#
|
374
365
|
# @param parent_customer_id [String, nil] The ID of the parent customer in the hierarchy. The desired parent customer must
|
375
|
-
# ...
|
376
366
|
end
|
377
367
|
|
378
368
|
# This is used for creating charges or invoices in an external system via Orb.
|
@@ -450,9 +440,9 @@ module Orb
|
|
450
440
|
|
451
441
|
discriminator :tax_provider
|
452
442
|
|
453
|
-
variant :avalara, -> { Orb::
|
443
|
+
variant :avalara, -> { Orb::CustomerUpdateParams::TaxConfiguration::Avalara }
|
454
444
|
|
455
|
-
variant :taxjar, -> { Orb::
|
445
|
+
variant :taxjar, -> { Orb::CustomerUpdateParams::TaxConfiguration::Taxjar }
|
456
446
|
|
457
447
|
class Avalara < Orb::Internal::Type::BaseModel
|
458
448
|
# @!attribute tax_exempt
|
@@ -493,19 +483,19 @@ module Orb
|
|
493
483
|
end
|
494
484
|
|
495
485
|
# @!method self.variants
|
496
|
-
# @return [Array(Orb::
|
486
|
+
# @return [Array(Orb::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::CustomerUpdateParams::TaxConfiguration::Taxjar)]
|
497
487
|
end
|
498
488
|
|
499
489
|
class TaxID < Orb::Internal::Type::BaseModel
|
500
490
|
# @!attribute country
|
501
491
|
#
|
502
|
-
# @return [Symbol, Orb::
|
503
|
-
required :country, enum: -> { Orb::
|
492
|
+
# @return [Symbol, Orb::CustomerUpdateParams::TaxID::Country]
|
493
|
+
required :country, enum: -> { Orb::CustomerUpdateParams::TaxID::Country }
|
504
494
|
|
505
495
|
# @!attribute type
|
506
496
|
#
|
507
|
-
# @return [Symbol, Orb::
|
508
|
-
required :type, enum: -> { Orb::
|
497
|
+
# @return [Symbol, Orb::CustomerUpdateParams::TaxID::Type]
|
498
|
+
required :type, enum: -> { Orb::CustomerUpdateParams::TaxID::Type }
|
509
499
|
|
510
500
|
# @!attribute value
|
511
501
|
#
|
@@ -619,11 +609,11 @@ module Orb
|
|
619
609
|
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
620
610
|
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
621
611
|
#
|
622
|
-
# @param country [Symbol, Orb::
|
623
|
-
# @param type [Symbol, Orb::
|
612
|
+
# @param country [Symbol, Orb::CustomerUpdateParams::TaxID::Country]
|
613
|
+
# @param type [Symbol, Orb::CustomerUpdateParams::TaxID::Type]
|
624
614
|
# @param value [String]
|
625
615
|
|
626
|
-
# @see Orb::
|
616
|
+
# @see Orb::CustomerUpdateParams::TaxID#country
|
627
617
|
module Country
|
628
618
|
extend Orb::Internal::Type::Enum
|
629
619
|
|
@@ -710,7 +700,7 @@ module Orb
|
|
710
700
|
# @return [Array<Symbol>]
|
711
701
|
end
|
712
702
|
|
713
|
-
# @see Orb::
|
703
|
+
# @see Orb::CustomerUpdateParams::TaxID#type
|
714
704
|
module Type
|
715
705
|
extend Orb::Internal::Type::Enum
|
716
706
|
|
@@ -15,8 +15,8 @@ module Orb
|
|
15
15
|
|
16
16
|
# @!attribute type
|
17
17
|
#
|
18
|
-
# @return [Symbol, Orb::
|
19
|
-
required :type, enum: -> { Orb::
|
18
|
+
# @return [Symbol, Orb::Customers::BalanceTransactionCreateParams::Type]
|
19
|
+
required :type, enum: -> { Orb::Customers::BalanceTransactionCreateParams::Type }
|
20
20
|
|
21
21
|
# @!attribute description
|
22
22
|
# An optional description that can be specified around this entry.
|
@@ -27,7 +27,7 @@ module Orb
|
|
27
27
|
# @!method initialize(amount:, type:, description: nil, request_options: {})
|
28
28
|
# @param amount [String]
|
29
29
|
#
|
30
|
-
# @param type [Symbol, Orb::
|
30
|
+
# @param type [Symbol, Orb::Customers::BalanceTransactionCreateParams::Type]
|
31
31
|
#
|
32
32
|
# @param description [String, nil] An optional description that can be specified around this entry.
|
33
33
|
#
|
@@ -82,12 +82,10 @@ module Orb
|
|
82
82
|
# @param description [String, nil] An optional description provided for manual customer balance adjustments.
|
83
83
|
#
|
84
84
|
# @param ending_balance [String] The new value of the customer's balance prior to the transaction, in the custome
|
85
|
-
# ...
|
86
85
|
#
|
87
86
|
# @param invoice [Orb::Models::Customers::BalanceTransactionCreateResponse::Invoice, nil]
|
88
87
|
#
|
89
88
|
# @param starting_balance [String] The original value of the customer's balance prior to the transaction, in the cu
|
90
|
-
# ...
|
91
89
|
#
|
92
90
|
# @param type [Symbol, Orb::Models::Customers::BalanceTransactionCreateResponse::Type]
|
93
91
|
|
@@ -46,7 +46,6 @@ module Orb
|
|
46
46
|
# {Orb::Models::Customers::BalanceTransactionListParams} for more details.
|
47
47
|
#
|
48
48
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
49
|
-
# ...
|
50
49
|
#
|
51
50
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
52
51
|
#
|
@@ -82,12 +82,10 @@ module Orb
|
|
82
82
|
# @param description [String, nil] An optional description provided for manual customer balance adjustments.
|
83
83
|
#
|
84
84
|
# @param ending_balance [String] The new value of the customer's balance prior to the transaction, in the custome
|
85
|
-
# ...
|
86
85
|
#
|
87
86
|
# @param invoice [Orb::Models::Customers::BalanceTransactionListResponse::Invoice, nil]
|
88
87
|
#
|
89
88
|
# @param starting_balance [String] The original value of the customer's balance prior to the transaction, in the cu
|
90
|
-
# ...
|
91
89
|
#
|
92
90
|
# @param type [Symbol, Orb::Models::Customers::BalanceTransactionListResponse::Type]
|
93
91
|
|
@@ -32,8 +32,8 @@ module Orb
|
|
32
32
|
# discounts, it's strongly recommended that you use the default cumulative
|
33
33
|
# behavior.
|
34
34
|
#
|
35
|
-
# @return [Symbol, Orb::
|
36
|
-
optional :view_mode, enum: -> { Orb::
|
35
|
+
# @return [Symbol, Orb::Customers::CostListByExternalIDParams::ViewMode, nil]
|
36
|
+
optional :view_mode, enum: -> { Orb::Customers::CostListByExternalIDParams::ViewMode }, nil?: true
|
37
37
|
|
38
38
|
# @!method initialize(currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {})
|
39
39
|
# Some parameter documentations has been truncated, see
|
@@ -45,8 +45,7 @@ module Orb
|
|
45
45
|
#
|
46
46
|
# @param timeframe_start [Time, nil] Costs returned are inclusive of `timeframe_start`.
|
47
47
|
#
|
48
|
-
# @param view_mode [Symbol, Orb::
|
49
|
-
# ...
|
48
|
+
# @param view_mode [Symbol, Orb::Customers::CostListByExternalIDParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per
|
50
49
|
#
|
51
50
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
52
51
|
|
@@ -58,8 +58,8 @@ module Orb
|
|
58
58
|
# @!attribute price
|
59
59
|
# The price object
|
60
60
|
#
|
61
|
-
# @return [Orb::
|
62
|
-
required :price, union: -> { Orb::
|
61
|
+
# @return [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk]
|
62
|
+
required :price, union: -> { Orb::Price }
|
63
63
|
|
64
64
|
# @!attribute price_id
|
65
65
|
# The price the cost is associated with
|
@@ -86,7 +86,7 @@ module Orb
|
|
86
86
|
optional :quantity, Float, nil?: true
|
87
87
|
|
88
88
|
# @!method initialize(price:, price_id:, subtotal:, total:, quantity: nil)
|
89
|
-
# @param price [Orb::
|
89
|
+
# @param price [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk] The price object
|
90
90
|
#
|
91
91
|
# @param price_id [String] The price the cost is associated with
|
92
92
|
#
|
@@ -32,8 +32,8 @@ module Orb
|
|
32
32
|
# discounts, it's strongly recommended that you use the default cumulative
|
33
33
|
# behavior.
|
34
34
|
#
|
35
|
-
# @return [Symbol, Orb::
|
36
|
-
optional :view_mode, enum: -> { Orb::
|
35
|
+
# @return [Symbol, Orb::Customers::CostListParams::ViewMode, nil]
|
36
|
+
optional :view_mode, enum: -> { Orb::Customers::CostListParams::ViewMode }, nil?: true
|
37
37
|
|
38
38
|
# @!method initialize(currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {})
|
39
39
|
# Some parameter documentations has been truncated, see
|
@@ -45,8 +45,7 @@ module Orb
|
|
45
45
|
#
|
46
46
|
# @param timeframe_start [Time, nil] Costs returned are inclusive of `timeframe_start`.
|
47
47
|
#
|
48
|
-
# @param view_mode [Symbol, Orb::
|
49
|
-
# ...
|
48
|
+
# @param view_mode [Symbol, Orb::Customers::CostListParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per
|
50
49
|
#
|
51
50
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
52
51
|
|
@@ -57,8 +57,8 @@ module Orb
|
|
57
57
|
# @!attribute price
|
58
58
|
# The price object
|
59
59
|
#
|
60
|
-
# @return [Orb::
|
61
|
-
required :price, union: -> { Orb::
|
60
|
+
# @return [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk]
|
61
|
+
required :price, union: -> { Orb::Price }
|
62
62
|
|
63
63
|
# @!attribute price_id
|
64
64
|
# The price the cost is associated with
|
@@ -85,7 +85,7 @@ module Orb
|
|
85
85
|
optional :quantity, Float, nil?: true
|
86
86
|
|
87
87
|
# @!method initialize(price:, price_id:, subtotal:, total:, quantity: nil)
|
88
|
-
# @param price [Orb::
|
88
|
+
# @param price [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk] The price object
|
89
89
|
#
|
90
90
|
# @param price_id [String] The price the cost is associated with
|
91
91
|
#
|
@@ -41,10 +41,8 @@ module Orb
|
|
41
41
|
# @param currency [String, nil] The ledger currency or custom pricing unit to use.
|
42
42
|
#
|
43
43
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
44
|
-
# ...
|
45
44
|
#
|
46
45
|
# @param include_all_blocks [Boolean] If set to True, all expired and depleted blocks, as well as active block will be
|
47
|
-
# ...
|
48
46
|
#
|
49
47
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
50
48
|
#
|