orb-billing 0.3.1 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +35 -0
- data/README.md +3 -3
- data/lib/orb/errors.rb +1 -1
- data/lib/orb/file_part.rb +2 -2
- data/lib/orb/internal/transport/base_client.rb +74 -5
- data/lib/orb/internal/transport/pooled_net_requester.rb +14 -0
- data/lib/orb/internal/type/array_of.rb +1 -1
- data/lib/orb/internal/type/base_model.rb +62 -30
- data/lib/orb/internal/type/converter.rb +18 -0
- data/lib/orb/internal/type/enum.rb +4 -3
- data/lib/orb/internal/type/hash_of.rb +1 -1
- data/lib/orb/internal/type/request_parameters.rb +4 -4
- data/lib/orb/internal/type/union.rb +5 -4
- data/lib/orb/internal/util.rb +57 -1
- data/lib/orb/internal.rb +6 -0
- data/lib/orb/models/alert.rb +29 -32
- data/lib/orb/models/alert_create_for_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_external_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_subscription_params.rb +7 -8
- data/lib/orb/models/alert_list_params.rb +0 -1
- data/lib/orb/models/alert_update_params.rb +4 -5
- data/lib/orb/models/amount_discount.rb +6 -7
- data/lib/orb/models/billable_metric.rb +9 -11
- data/lib/orb/models/coupon.rb +13 -12
- data/lib/orb/models/coupon_create_params.rb +12 -8
- data/lib/orb/models/coupon_list_params.rb +0 -2
- data/lib/orb/models/coupons/subscription_list_params.rb +0 -1
- data/lib/orb/models/credit_note.rb +48 -46
- data/lib/orb/models/credit_note_create_params.rb +6 -6
- data/lib/orb/models/credit_note_list_params.rb +0 -1
- data/lib/orb/models/customer.rb +54 -61
- data/lib/orb/models/customer_create_params.rb +50 -53
- data/lib/orb/models/customer_list_params.rb +0 -1
- data/lib/orb/models/customer_update_by_external_id_params.rb +50 -53
- data/lib/orb/models/customer_update_params.rb +50 -51
- data/lib/orb/models/customers/balance_transaction_create_params.rb +3 -3
- data/lib/orb/models/customers/balance_transaction_create_response.rb +0 -2
- data/lib/orb/models/customers/balance_transaction_list_params.rb +0 -1
- data/lib/orb/models/customers/balance_transaction_list_response.rb +0 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -3
- data/lib/orb/models/customers/cost_list_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_response.rb +3 -3
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +0 -2
- data/lib/orb/models/customers/credit_list_params.rb +0 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +12 -21
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +14 -7
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +11 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +14 -7
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +6 -7
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +14 -7
- data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
- data/lib/orb/models/customers/credits/ledger_list_response.rb +14 -7
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +10 -15
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_create_params.rb +7 -15
- data/lib/orb/models/customers/credits/top_up_create_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_response.rb +0 -6
- data/lib/orb/models/dimensional_price_group.rb +1 -3
- data/lib/orb/models/dimensional_price_group_create_params.rb +0 -1
- data/lib/orb/models/dimensional_price_group_list_params.rb +0 -1
- data/lib/orb/models/dimensional_price_groups.rb +6 -6
- data/lib/orb/models/discount.rb +11 -5
- data/lib/orb/models/evaluate_price_group.rb +5 -1
- data/lib/orb/models/event_ingest_params.rb +4 -9
- data/lib/orb/models/event_ingest_response.rb +0 -3
- data/lib/orb/models/event_search_params.rb +0 -3
- data/lib/orb/models/event_search_response.rb +0 -4
- data/lib/orb/models/event_update_params.rb +0 -3
- data/lib/orb/models/events/backfill_close_response.rb +0 -4
- data/lib/orb/models/events/backfill_create_params.rb +0 -7
- data/lib/orb/models/events/backfill_create_response.rb +0 -4
- data/lib/orb/models/events/backfill_fetch_response.rb +0 -4
- data/lib/orb/models/events/backfill_list_params.rb +0 -1
- data/lib/orb/models/events/backfill_list_response.rb +0 -4
- data/lib/orb/models/events/backfill_revert_response.rb +0 -4
- data/lib/orb/models/events/event_volumes.rb +3 -3
- data/lib/orb/models/events/volume_list_params.rb +0 -3
- data/lib/orb/models/invoice.rb +179 -202
- data/lib/orb/models/invoice_create_params.rb +14 -21
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +31 -54
- data/lib/orb/models/invoice_issue_params.rb +0 -1
- data/lib/orb/models/invoice_level_discount.rb +8 -4
- data/lib/orb/models/invoice_line_item_create_params.rb +0 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +28 -26
- data/lib/orb/models/invoice_list_params.rb +6 -10
- data/lib/orb/models/invoice_update_params.rb +0 -1
- data/lib/orb/models/item.rb +7 -8
- data/lib/orb/models/item_list_params.rb +0 -1
- data/lib/orb/models/item_update_params.rb +7 -7
- data/lib/orb/models/metric_create_params.rb +0 -1
- data/lib/orb/models/metric_list_params.rb +0 -1
- data/lib/orb/models/metric_update_params.rb +0 -1
- data/lib/orb/models/percentage_discount.rb +6 -8
- data/lib/orb/models/plan.rb +90 -103
- data/lib/orb/models/plan_create_params.rb +759 -800
- data/lib/orb/models/plan_list_params.rb +3 -4
- data/lib/orb/models/plan_update_params.rb +0 -2
- data/lib/orb/models/plans/external_plan_id_update_params.rb +0 -2
- data/lib/orb/models/price.rb +1706 -1724
- data/lib/orb/models/price_create_params.rb +75 -84
- data/lib/orb/models/price_evaluate_params.rb +0 -2
- data/lib/orb/models/price_evaluate_response.rb +3 -3
- data/lib/orb/models/price_list_params.rb +0 -1
- data/lib/orb/models/price_update_params.rb +0 -1
- data/lib/orb/models/prices/external_price_id_update_params.rb +0 -1
- data/lib/orb/models/subscription.rb +108 -122
- data/lib/orb/models/subscription_cancel_params.rb +3 -5
- data/lib/orb/models/subscription_cancel_response.rb +43 -57
- data/lib/orb/models/subscription_change_apply_response.rb +43 -58
- data/lib/orb/models/subscription_change_cancel_response.rb +43 -58
- data/lib/orb/models/subscription_change_retrieve_response.rb +43 -58
- data/lib/orb/models/subscription_create_params.rb +1953 -1815
- data/lib/orb/models/subscription_create_response.rb +43 -57
- data/lib/orb/models/subscription_fetch_costs_params.rb +3 -4
- data/lib/orb/models/subscription_fetch_costs_response.rb +3 -3
- data/lib/orb/models/subscription_fetch_schedule_params.rb +0 -1
- data/lib/orb/models/subscription_fetch_schedule_response.rb +0 -1
- data/lib/orb/models/subscription_fetch_usage_params.rb +6 -8
- data/lib/orb/models/subscription_list_params.rb +3 -4
- data/lib/orb/models/subscription_price_intervals_params.rb +1194 -1017
- data/lib/orb/models/subscription_price_intervals_response.rb +43 -57
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +1994 -1791
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +43 -57
- data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
- data/lib/orb/models/subscription_trigger_phase_response.rb +43 -57
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +43 -57
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +43 -57
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +43 -57
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +3 -6
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +43 -57
- data/lib/orb/models/subscription_update_params.rb +0 -5
- data/lib/orb/models/subscription_update_trial_params.rb +8 -6
- data/lib/orb/models/subscription_update_trial_response.rb +43 -57
- data/lib/orb/models/subscription_usage.rb +55 -39
- data/lib/orb/models/subscriptions.rb +6 -6
- data/lib/orb/models/trial_discount.rb +6 -7
- data/lib/orb/models/usage_discount.rb +6 -8
- data/lib/orb/models.rb +24 -0
- data/lib/orb/request_options.rb +4 -0
- data/lib/orb/resources/alerts.rb +30 -31
- data/lib/orb/resources/coupons/subscriptions.rb +3 -4
- data/lib/orb/resources/coupons.rb +11 -21
- data/lib/orb/resources/credit_notes.rb +10 -11
- data/lib/orb/resources/customers/balance_transactions.rb +3 -4
- data/lib/orb/resources/customers/costs.rb +4 -6
- data/lib/orb/resources/customers/credits/ledger.rb +14 -33
- data/lib/orb/resources/customers/credits/top_ups.rb +10 -20
- data/lib/orb/resources/customers/credits.rb +2 -6
- data/lib/orb/resources/customers.rb +40 -67
- data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +2 -2
- data/lib/orb/resources/dimensional_price_groups.rb +8 -10
- data/lib/orb/resources/events/backfills.rb +2 -10
- data/lib/orb/resources/events/volume.rb +3 -6
- data/lib/orb/resources/events.rb +4 -12
- data/lib/orb/resources/invoice_line_items.rb +1 -2
- data/lib/orb/resources/invoices.rb +26 -43
- data/lib/orb/resources/items.rb +12 -13
- data/lib/orb/resources/metrics.rb +11 -14
- data/lib/orb/resources/plans/external_plan_id.rb +5 -7
- data/lib/orb/resources/plans.rb +14 -23
- data/lib/orb/resources/prices/external_price_id.rb +5 -6
- data/lib/orb/resources/prices.rb +25 -35
- data/lib/orb/resources/subscription_changes.rb +1 -1
- data/lib/orb/resources/subscriptions.rb +49 -107
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +3 -0
- data/rbi/orb/client.rbi +5 -4
- data/rbi/orb/errors.rbi +59 -28
- data/rbi/orb/file_part.rbi +9 -6
- data/rbi/orb/internal/page.rbi +20 -6
- data/rbi/orb/internal/transport/base_client.rbi +159 -78
- data/rbi/orb/internal/transport/pooled_net_requester.rbi +27 -13
- data/rbi/orb/internal/type/array_of.rbi +42 -34
- data/rbi/orb/internal/type/base_model.rbi +144 -69
- data/rbi/orb/internal/type/base_page.rbi +12 -8
- data/rbi/orb/internal/type/boolean.rbi +16 -10
- data/rbi/orb/internal/type/converter.rbi +68 -31
- data/rbi/orb/internal/type/enum.rbi +28 -15
- data/rbi/orb/internal/type/file_input.rbi +12 -10
- data/rbi/orb/internal/type/hash_of.rbi +34 -24
- data/rbi/orb/internal/type/request_parameters.rbi +12 -4
- data/rbi/orb/internal/type/union.rbi +61 -25
- data/rbi/orb/internal/type/unknown.rbi +20 -12
- data/rbi/orb/internal/util.rbi +232 -90
- data/rbi/orb/internal.rbi +2 -0
- data/rbi/orb/models/alert.rbi +114 -70
- data/rbi/orb/models/alert_create_for_customer_params.rbi +69 -27
- data/rbi/orb/models/alert_create_for_external_customer_params.rbi +80 -29
- data/rbi/orb/models/alert_create_for_subscription_params.rbi +62 -26
- data/rbi/orb/models/alert_disable_params.rbi +18 -6
- data/rbi/orb/models/alert_enable_params.rbi +18 -6
- data/rbi/orb/models/alert_list_params.rbi +24 -20
- data/rbi/orb/models/alert_retrieve_params.rbi +11 -4
- data/rbi/orb/models/alert_update_params.rbi +29 -14
- data/rbi/orb/models/amount_discount.rbi +29 -19
- data/rbi/orb/models/billable_metric.rbi +34 -26
- data/rbi/orb/models/billing_cycle_relative_date.rbi +11 -5
- data/rbi/orb/models/coupon.rbi +28 -20
- data/rbi/orb/models/coupon_archive_params.rbi +11 -4
- data/rbi/orb/models/coupon_create_params.rbi +85 -38
- data/rbi/orb/models/coupon_fetch_params.rbi +11 -4
- data/rbi/orb/models/coupon_list_params.rbi +19 -15
- data/rbi/orb/models/coupons/subscription_list_params.rbi +19 -6
- data/rbi/orb/models/credit_note.rbi +329 -158
- data/rbi/orb/models/credit_note_create_params.rbi +64 -29
- data/rbi/orb/models/credit_note_fetch_params.rbi +13 -4
- data/rbi/orb/models/credit_note_list_params.rbi +23 -17
- data/rbi/orb/models/customer.rbi +461 -329
- data/rbi/orb/models/customer_create_params.rbi +713 -325
- data/rbi/orb/models/customer_delete_params.rbi +13 -4
- data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +13 -4
- data/rbi/orb/models/customer_fetch_params.rbi +11 -4
- data/rbi/orb/models/customer_list_params.rbi +21 -17
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +16 -4
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +16 -4
- data/rbi/orb/models/customer_update_by_external_id_params.rbi +1193 -336
- data/rbi/orb/models/customer_update_params.rbi +712 -324
- data/rbi/orb/models/customers/balance_transaction_create_params.rbi +56 -21
- data/rbi/orb/models/customers/balance_transaction_create_response.rbi +172 -61
- data/rbi/orb/models/customers/balance_transaction_list_params.rbi +26 -17
- data/rbi/orb/models/customers/balance_transaction_list_response.rbi +182 -59
- data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +62 -22
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +180 -124
- data/rbi/orb/models/customers/cost_list_params.rbi +48 -22
- data/rbi/orb/models/customers/cost_list_response.rbi +172 -123
- data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi +24 -15
- data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +54 -22
- data/rbi/orb/models/customers/credit_list_params.rbi +21 -15
- data/rbi/orb/models/customers/credit_list_response.rbi +50 -21
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +118 -68
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +755 -434
- data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +129 -59
- data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +812 -425
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +108 -44
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +793 -432
- data/rbi/orb/models/customers/credits/ledger_list_params.rbi +129 -40
- data/rbi/orb/models/customers/credits/ledger_list_response.rbi +847 -389
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +86 -53
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +77 -48
- data/rbi/orb/models/customers/credits/top_up_create_params.rbi +96 -45
- data/rbi/orb/models/customers/credits/top_up_create_response.rbi +95 -43
- data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +22 -6
- data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +21 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +15 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +82 -49
- data/rbi/orb/models/customers/credits/top_up_list_params.rbi +15 -5
- data/rbi/orb/models/customers/credits/top_up_list_response.rbi +96 -43
- data/rbi/orb/models/dimensional_price_group.rbi +21 -15
- data/rbi/orb/models/dimensional_price_group_create_params.rbi +22 -16
- data/rbi/orb/models/dimensional_price_group_list_params.rbi +19 -6
- data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +16 -4
- data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +15 -8
- data/rbi/orb/models/dimensional_price_groups.rbi +21 -13
- data/rbi/orb/models/discount.rbi +11 -5
- data/rbi/orb/models/evaluate_price_group.rbi +29 -12
- data/rbi/orb/models/event_deprecate_params.rbi +13 -4
- data/rbi/orb/models/event_deprecate_response.rbi +11 -3
- data/rbi/orb/models/event_ingest_params.rbi +41 -31
- data/rbi/orb/models/event_ingest_response.rbi +78 -23
- data/rbi/orb/models/event_search_params.rbi +18 -14
- data/rbi/orb/models/event_search_response.rbi +42 -21
- data/rbi/orb/models/event_update_params.rbi +20 -16
- data/rbi/orb/models/event_update_response.rbi +11 -3
- data/rbi/orb/models/events/backfill_close_params.rbi +13 -9
- data/rbi/orb/models/events/backfill_close_response.rbi +70 -29
- data/rbi/orb/models/events/backfill_create_params.rbi +24 -18
- data/rbi/orb/models/events/backfill_create_response.rbi +69 -29
- data/rbi/orb/models/events/backfill_fetch_params.rbi +13 -9
- data/rbi/orb/models/events/backfill_fetch_response.rbi +70 -29
- data/rbi/orb/models/events/backfill_list_params.rbi +19 -6
- data/rbi/orb/models/events/backfill_list_response.rbi +68 -28
- data/rbi/orb/models/events/backfill_revert_params.rbi +13 -9
- data/rbi/orb/models/events/backfill_revert_response.rbi +69 -29
- data/rbi/orb/models/events/event_volumes.rbi +38 -10
- data/rbi/orb/models/events/volume_list_params.rbi +21 -15
- data/rbi/orb/models/invoice.rbi +1411 -805
- data/rbi/orb/models/invoice_create_params.rbi +107 -69
- data/rbi/orb/models/invoice_fetch_params.rbi +11 -4
- data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +18 -5
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +2187 -876
- data/rbi/orb/models/invoice_issue_params.rbi +17 -5
- data/rbi/orb/models/invoice_level_discount.rbi +11 -4
- data/rbi/orb/models/invoice_line_item_create_params.rbi +23 -17
- data/rbi/orb/models/invoice_line_item_create_response.rbi +675 -376
- data/rbi/orb/models/invoice_list_params.rbi +68 -47
- data/rbi/orb/models/invoice_mark_paid_params.rbi +20 -14
- data/rbi/orb/models/invoice_pay_params.rbi +11 -4
- data/rbi/orb/models/invoice_update_params.rbi +16 -10
- data/rbi/orb/models/invoice_void_params.rbi +11 -4
- data/rbi/orb/models/item.rbi +90 -39
- data/rbi/orb/models/item_create_params.rbi +15 -5
- data/rbi/orb/models/item_fetch_params.rbi +11 -4
- data/rbi/orb/models/item_list_params.rbi +17 -6
- data/rbi/orb/models/item_update_params.rbi +86 -39
- data/rbi/orb/models/metric_create_params.rbi +20 -16
- data/rbi/orb/models/metric_fetch_params.rbi +11 -4
- data/rbi/orb/models/metric_list_params.rbi +21 -17
- data/rbi/orb/models/metric_update_params.rbi +16 -10
- data/rbi/orb/models/pagination_metadata.rbi +17 -4
- data/rbi/orb/models/percentage_discount.rbi +33 -19
- data/rbi/orb/models/plan.rbi +532 -365
- data/rbi/orb/models/plan_create_params.rbi +5295 -2870
- data/rbi/orb/models/plan_fetch_params.rbi +11 -4
- data/rbi/orb/models/plan_list_params.rbi +35 -27
- data/rbi/orb/models/plan_update_params.rbi +17 -13
- data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +13 -9
- data/rbi/orb/models/plans/external_plan_id_update_params.rbi +22 -13
- data/rbi/orb/models/price.rbi +11332 -5033
- data/rbi/orb/models/price_create_params.rbi +583 -245
- data/rbi/orb/models/price_evaluate_params.rbi +21 -17
- data/rbi/orb/models/price_evaluate_response.rbi +14 -6
- data/rbi/orb/models/price_fetch_params.rbi +11 -4
- data/rbi/orb/models/price_list_params.rbi +17 -6
- data/rbi/orb/models/price_update_params.rbi +16 -10
- data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +15 -8
- data/rbi/orb/models/prices/external_price_id_update_params.rbi +21 -10
- data/rbi/orb/models/subscription.rbi +668 -420
- data/rbi/orb/models/subscription_cancel_params.rbi +47 -22
- data/rbi/orb/models/subscription_cancel_response.rbi +817 -438
- data/rbi/orb/models/subscription_change_apply_params.rbi +19 -13
- data/rbi/orb/models/subscription_change_apply_response.rbi +906 -505
- data/rbi/orb/models/subscription_change_cancel_params.rbi +13 -4
- data/rbi/orb/models/subscription_change_cancel_response.rbi +906 -516
- data/rbi/orb/models/subscription_change_retrieve_params.rbi +13 -4
- data/rbi/orb/models/subscription_change_retrieve_response.rbi +903 -524
- data/rbi/orb/models/subscription_create_params.rbi +10096 -6746
- data/rbi/orb/models/subscription_create_response.rbi +817 -438
- data/rbi/orb/models/subscription_fetch_costs_params.rbi +50 -22
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +172 -123
- data/rbi/orb/models/subscription_fetch_params.rbi +13 -4
- data/rbi/orb/models/subscription_fetch_schedule_params.rbi +23 -17
- data/rbi/orb/models/subscription_fetch_schedule_response.rbi +45 -19
- data/rbi/orb/models/subscription_fetch_usage_params.rbi +84 -34
- data/rbi/orb/models/subscription_list_params.rbi +42 -28
- data/rbi/orb/models/subscription_price_intervals_params.rbi +5798 -3823
- data/rbi/orb/models/subscription_price_intervals_response.rbi +840 -453
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +9676 -6922
- data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +838 -467
- data/rbi/orb/models/subscription_trigger_phase_params.rbi +19 -13
- data/rbi/orb/models/subscription_trigger_phase_response.rbi +832 -448
- data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +16 -4
- data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +839 -467
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +22 -5
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +815 -504
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +16 -4
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +828 -497
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +63 -26
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +839 -467
- data/rbi/orb/models/subscription_update_params.rbi +22 -16
- data/rbi/orb/models/subscription_update_trial_params.rbi +60 -19
- data/rbi/orb/models/subscription_update_trial_response.rbi +832 -447
- data/rbi/orb/models/subscription_usage.rbi +325 -121
- data/rbi/orb/models/subscriptions.rbi +19 -11
- data/rbi/orb/models/top_level_ping_params.rbi +11 -4
- data/rbi/orb/models/top_level_ping_response.rbi +10 -3
- data/rbi/orb/models/trial_discount.rbi +30 -20
- data/rbi/orb/models/usage_discount.rbi +29 -19
- data/rbi/orb/models.rbi +22 -11
- data/rbi/orb/request_options.rbi +12 -6
- data/rbi/orb/resources/alerts.rbi +61 -40
- data/rbi/orb/resources/coupons/subscriptions.rbi +7 -5
- data/rbi/orb/resources/coupons.rbi +33 -18
- data/rbi/orb/resources/credit_notes.rbi +22 -13
- data/rbi/orb/resources/customers/balance_transactions.rbi +17 -9
- data/rbi/orb/resources/customers/costs.rbi +18 -11
- data/rbi/orb/resources/customers/credits/ledger.rbi +98 -74
- data/rbi/orb/resources/customers/credits/top_ups.rbi +61 -25
- data/rbi/orb/resources/customers/credits.rbi +16 -7
- data/rbi/orb/resources/customers.rbi +137 -72
- data/rbi/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +8 -4
- data/rbi/orb/resources/dimensional_price_groups.rbi +26 -12
- data/rbi/orb/resources/events/backfills.rbi +35 -17
- data/rbi/orb/resources/events/volume.rbi +7 -5
- data/rbi/orb/resources/events.rbi +26 -16
- data/rbi/orb/resources/invoice_line_items.rbi +7 -5
- data/rbi/orb/resources/invoices.rbi +72 -41
- data/rbi/orb/resources/items.rbi +40 -13
- data/rbi/orb/resources/metrics.rbi +25 -15
- data/rbi/orb/resources/plans/external_plan_id.rbi +15 -7
- data/rbi/orb/resources/plans.rbi +57 -47
- data/rbi/orb/resources/prices/external_price_id.rbi +73 -68
- data/rbi/orb/resources/prices.rbi +176 -156
- data/rbi/orb/resources/subscription_changes.rbi +19 -11
- data/rbi/orb/resources/subscriptions.rbi +200 -114
- data/rbi/orb/resources/top_level.rbi +9 -3
- data/sig/orb/internal/page.rbs +0 -2
- data/sig/orb/internal/transport/base_client.rbs +16 -1
- data/sig/orb/internal/transport/pooled_net_requester.rbs +2 -0
- data/sig/orb/internal/type/base_model.rbs +11 -5
- data/sig/orb/internal/type/base_page.rbs +1 -1
- data/sig/orb/internal/type/converter.rbs +2 -0
- data/sig/orb/internal/type/enum.rbs +1 -0
- data/sig/orb/internal/type/request_parameters.rbs +3 -1
- data/sig/orb/internal/type/union.rbs +1 -0
- data/sig/orb/internal/util.rbs +13 -0
- data/sig/orb/internal.rbs +2 -0
- data/sig/orb/models/alert.rbs +19 -31
- data/sig/orb/models/alert_create_for_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_subscription_params.rbs +3 -7
- data/sig/orb/models/alert_disable_params.rbs +0 -2
- data/sig/orb/models/alert_enable_params.rbs +0 -2
- data/sig/orb/models/alert_list_params.rbs +0 -2
- data/sig/orb/models/alert_retrieve_params.rbs +0 -2
- data/sig/orb/models/alert_update_params.rbs +3 -7
- data/sig/orb/models/amount_discount.rbs +4 -6
- data/sig/orb/models/billable_metric.rbs +7 -9
- data/sig/orb/models/coupon.rbs +5 -8
- data/sig/orb/models/coupon_archive_params.rbs +0 -2
- data/sig/orb/models/coupon_create_params.rbs +3 -9
- data/sig/orb/models/coupon_fetch_params.rbs +0 -2
- data/sig/orb/models/coupon_list_params.rbs +0 -2
- data/sig/orb/models/coupons/subscription_list_params.rbs +0 -2
- data/sig/orb/models/credit_note.rbs +48 -66
- data/sig/orb/models/credit_note_create_params.rbs +3 -7
- data/sig/orb/models/credit_note_fetch_params.rbs +0 -2
- data/sig/orb/models/credit_note_list_params.rbs +0 -2
- data/sig/orb/models/customer.rbs +43 -63
- data/sig/orb/models/customer_create_params.rbs +32 -52
- data/sig/orb/models/customer_delete_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_params.rbs +0 -2
- data/sig/orb/models/customer_list_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +0 -2
- data/sig/orb/models/customer_update_by_external_id_params.rbs +32 -52
- data/sig/orb/models/customer_update_params.rbs +32 -52
- data/sig/orb/models/customers/balance_transaction_create_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_create_response.rbs +0 -6
- data/sig/orb/models/customers/balance_transaction_list_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_list_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_response.rbs +0 -6
- data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +0 -2
- data/sig/orb/models/customers/credit_list_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_response.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +1 -43
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_create_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_delete_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_response.rbs +0 -4
- data/sig/orb/models/dimensional_price_group.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_create_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_list_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups.rbs +6 -8
- data/sig/orb/models/discount.rbs +5 -5
- data/sig/orb/models/evaluate_price_group.rbs +4 -6
- data/sig/orb/models/event_deprecate_params.rbs +0 -2
- data/sig/orb/models/event_deprecate_response.rbs +0 -2
- data/sig/orb/models/event_ingest_params.rbs +3 -7
- data/sig/orb/models/event_ingest_response.rbs +0 -6
- data/sig/orb/models/event_search_params.rbs +0 -2
- data/sig/orb/models/event_search_response.rbs +0 -4
- data/sig/orb/models/event_update_params.rbs +0 -2
- data/sig/orb/models/event_update_response.rbs +0 -2
- data/sig/orb/models/events/backfill_close_params.rbs +0 -2
- data/sig/orb/models/events/backfill_close_response.rbs +0 -2
- data/sig/orb/models/events/backfill_create_params.rbs +0 -2
- data/sig/orb/models/events/backfill_create_response.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_params.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_response.rbs +0 -2
- data/sig/orb/models/events/backfill_list_params.rbs +0 -2
- data/sig/orb/models/events/backfill_list_response.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_params.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_response.rbs +0 -2
- data/sig/orb/models/events/event_volumes.rbs +3 -10
- data/sig/orb/models/events/volume_list_params.rbs +0 -2
- data/sig/orb/models/invoice.rbs +110 -172
- data/sig/orb/models/invoice_create_params.rbs +10 -16
- data/sig/orb/models/invoice_fetch_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +2 -64
- data/sig/orb/models/invoice_issue_params.rbs +0 -2
- data/sig/orb/models/invoice_level_discount.rbs +2 -4
- data/sig/orb/models/invoice_line_item_create_params.rbs +0 -2
- data/sig/orb/models/invoice_line_item_create_response.rbs +2 -36
- data/sig/orb/models/invoice_list_params.rbs +4 -6
- data/sig/orb/models/invoice_mark_paid_params.rbs +0 -2
- data/sig/orb/models/invoice_pay_params.rbs +0 -2
- data/sig/orb/models/invoice_update_params.rbs +0 -2
- data/sig/orb/models/invoice_void_params.rbs +0 -2
- data/sig/orb/models/item.rbs +7 -11
- data/sig/orb/models/item_create_params.rbs +0 -2
- data/sig/orb/models/item_fetch_params.rbs +0 -2
- data/sig/orb/models/item_list_params.rbs +0 -2
- data/sig/orb/models/item_update_params.rbs +7 -11
- data/sig/orb/models/metric_create_params.rbs +0 -2
- data/sig/orb/models/metric_fetch_params.rbs +0 -2
- data/sig/orb/models/metric_list_params.rbs +0 -2
- data/sig/orb/models/metric_update_params.rbs +0 -2
- data/sig/orb/models/pagination_metadata.rbs +0 -2
- data/sig/orb/models/percentage_discount.rbs +4 -6
- data/sig/orb/models/plan.rbs +45 -73
- data/sig/orb/models/plan_create_params.rbs +518 -696
- data/sig/orb/models/plan_fetch_params.rbs +0 -2
- data/sig/orb/models/plan_list_params.rbs +0 -2
- data/sig/orb/models/plan_update_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +0 -2
- data/sig/orb/models/price.rbs +1194 -1730
- data/sig/orb/models/price_create_params.rbs +59 -97
- data/sig/orb/models/price_evaluate_params.rbs +0 -2
- data/sig/orb/models/price_evaluate_response.rbs +3 -6
- data/sig/orb/models/price_fetch_params.rbs +0 -2
- data/sig/orb/models/price_list_params.rbs +0 -2
- data/sig/orb/models/price_update_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_fetch_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_update_params.rbs +0 -2
- data/sig/orb/models/subscription.rbs +56 -94
- data/sig/orb/models/subscription_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_cancel_response.rbs +20 -60
- data/sig/orb/models/subscription_change_apply_params.rbs +0 -2
- data/sig/orb/models/subscription_change_apply_response.rbs +20 -62
- data/sig/orb/models/subscription_change_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_change_cancel_response.rbs +20 -62
- data/sig/orb/models/subscription_change_retrieve_params.rbs +0 -2
- data/sig/orb/models/subscription_change_retrieve_response.rbs +20 -62
- data/sig/orb/models/subscription_create_params.rbs +1103 -1499
- data/sig/orb/models/subscription_create_response.rbs +20 -60
- data/sig/orb/models/subscription_fetch_costs_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_costs_response.rbs +0 -6
- data/sig/orb/models/subscription_fetch_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_response.rbs +0 -4
- data/sig/orb/models/subscription_fetch_usage_params.rbs +0 -2
- data/sig/orb/models/subscription_list_params.rbs +0 -2
- data/sig/orb/models/subscription_price_intervals_params.rbs +666 -896
- data/sig/orb/models/subscription_price_intervals_response.rbs +20 -60
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1103 -1499
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +20 -60
- data/sig/orb/models/subscription_trigger_phase_params.rbs +0 -2
- data/sig/orb/models/subscription_trigger_phase_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +20 -60
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +0 -2
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +20 -60
- data/sig/orb/models/subscription_update_params.rbs +0 -2
- data/sig/orb/models/subscription_update_trial_params.rbs +1 -3
- data/sig/orb/models/subscription_update_trial_response.rbs +20 -60
- data/sig/orb/models/subscription_usage.rbs +35 -53
- data/sig/orb/models/subscriptions.rbs +6 -8
- data/sig/orb/models/top_level_ping_params.rbs +0 -2
- data/sig/orb/models/top_level_ping_response.rbs +0 -2
- data/sig/orb/models/trial_discount.rbs +4 -6
- data/sig/orb/models/usage_discount.rbs +4 -6
- data/sig/orb/request_options.rbs +1 -1
- data/sig/orb/resources/alerts.rbs +12 -12
- data/sig/orb/resources/coupons/subscriptions.rbs +1 -1
- data/sig/orb/resources/coupons.rbs +4 -4
- data/sig/orb/resources/credit_notes.rbs +4 -4
- data/sig/orb/resources/customers/credits/ledger.rbs +2 -2
- data/sig/orb/resources/customers/credits/top_ups.rbs +2 -2
- data/sig/orb/resources/customers.rbs +24 -24
- data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +1 -1
- data/sig/orb/resources/dimensional_price_groups.rbs +3 -3
- data/sig/orb/resources/events/volume.rbs +1 -1
- data/sig/orb/resources/events.rbs +1 -1
- data/sig/orb/resources/invoices.rbs +10 -10
- data/sig/orb/resources/items.rbs +5 -5
- data/sig/orb/resources/metrics.rbs +4 -4
- data/sig/orb/resources/plans/external_plan_id.rbs +2 -2
- data/sig/orb/resources/plans.rbs +5 -5
- data/sig/orb/resources/prices.rbs +11 -11
- data/sig/orb/resources/subscriptions.rbs +21 -21
- metadata +2 -2
@@ -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,28 @@ 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)]
|
487
|
+
|
488
|
+
define_sorbet_constant!(:Variants) do
|
489
|
+
T.type_alias do
|
490
|
+
T.any(
|
491
|
+
Orb::CustomerUpdateParams::TaxConfiguration::Avalara,
|
492
|
+
Orb::CustomerUpdateParams::TaxConfiguration::Taxjar
|
493
|
+
)
|
494
|
+
end
|
495
|
+
end
|
497
496
|
end
|
498
497
|
|
499
498
|
class TaxID < Orb::Internal::Type::BaseModel
|
500
499
|
# @!attribute country
|
501
500
|
#
|
502
|
-
# @return [Symbol, Orb::
|
503
|
-
required :country, enum: -> { Orb::
|
501
|
+
# @return [Symbol, Orb::CustomerUpdateParams::TaxID::Country]
|
502
|
+
required :country, enum: -> { Orb::CustomerUpdateParams::TaxID::Country }
|
504
503
|
|
505
504
|
# @!attribute type
|
506
505
|
#
|
507
|
-
# @return [Symbol, Orb::
|
508
|
-
required :type, enum: -> { Orb::
|
506
|
+
# @return [Symbol, Orb::CustomerUpdateParams::TaxID::Type]
|
507
|
+
required :type, enum: -> { Orb::CustomerUpdateParams::TaxID::Type }
|
509
508
|
|
510
509
|
# @!attribute value
|
511
510
|
#
|
@@ -619,11 +618,11 @@ module Orb
|
|
619
618
|
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
620
619
|
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
621
620
|
#
|
622
|
-
# @param country [Symbol, Orb::
|
623
|
-
# @param type [Symbol, Orb::
|
621
|
+
# @param country [Symbol, Orb::CustomerUpdateParams::TaxID::Country]
|
622
|
+
# @param type [Symbol, Orb::CustomerUpdateParams::TaxID::Type]
|
624
623
|
# @param value [String]
|
625
624
|
|
626
|
-
# @see Orb::
|
625
|
+
# @see Orb::CustomerUpdateParams::TaxID#country
|
627
626
|
module Country
|
628
627
|
extend Orb::Internal::Type::Enum
|
629
628
|
|
@@ -710,7 +709,7 @@ module Orb
|
|
710
709
|
# @return [Array<Symbol>]
|
711
710
|
end
|
712
711
|
|
713
|
-
# @see Orb::
|
712
|
+
# @see Orb::CustomerUpdateParams::TaxID#type
|
714
713
|
module Type
|
715
714
|
extend Orb::Internal::Type::Enum
|
716
715
|
|
@@ -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
|
#
|
@@ -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
|
#
|
@@ -18,9 +18,11 @@ module Orb
|
|
18
18
|
|
19
19
|
# @!attribute entry_type
|
20
20
|
#
|
21
|
-
# @return [Symbol, Orb::
|
21
|
+
# @return [Symbol, Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType]
|
22
22
|
required :entry_type,
|
23
|
-
enum: -> {
|
23
|
+
enum: -> {
|
24
|
+
Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType
|
25
|
+
}
|
24
26
|
|
25
27
|
# @!attribute currency
|
26
28
|
# The currency or custom pricing unit to use for this ledger entry. If this is a
|
@@ -56,9 +58,9 @@ module Orb
|
|
56
58
|
# per_unit_cost_basis, as the calculation of the invoice total is done on that
|
57
59
|
# basis.
|
58
60
|
#
|
59
|
-
# @return [Orb::
|
61
|
+
# @return [Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings, nil]
|
60
62
|
optional :invoice_settings,
|
61
|
-
-> { Orb::
|
63
|
+
-> { Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings },
|
62
64
|
nil?: true
|
63
65
|
|
64
66
|
# @!attribute metadata
|
@@ -93,9 +95,9 @@ module Orb
|
|
93
95
|
# @!attribute void_reason
|
94
96
|
# Can only be specified when `entry_type=void`. The reason for the void.
|
95
97
|
#
|
96
|
-
# @return [Symbol, Orb::
|
98
|
+
# @return [Symbol, Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason, nil]
|
97
99
|
optional :void_reason,
|
98
|
-
enum: -> { Orb::
|
100
|
+
enum: -> { Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason },
|
99
101
|
nil?: true
|
100
102
|
|
101
103
|
# @!method initialize(amount:, entry_type:, expiry_date:, target_expiry_date:, block_id:, currency: nil, description: nil, effective_date: nil, invoice_settings: nil, metadata: nil, per_unit_cost_basis: nil, void_reason: nil, request_options: {})
|
@@ -104,36 +106,28 @@ module Orb
|
|
104
106
|
# details.
|
105
107
|
#
|
106
108
|
# @param amount [Float] The number of credits to effect. Note that this is required for increment, decre
|
107
|
-
# ...
|
108
109
|
#
|
109
|
-
# @param entry_type [Symbol, Orb::
|
110
|
+
# @param entry_type [Symbol, Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType]
|
110
111
|
#
|
111
112
|
# @param expiry_date [Time, nil] An ISO 8601 format date that identifies the origination credit block to expire
|
112
113
|
#
|
113
114
|
# @param target_expiry_date [Date] A future date (specified in YYYY-MM-DD format) used for expiration change, denot
|
114
|
-
# ...
|
115
115
|
#
|
116
116
|
# @param block_id [String] The ID of the block to reverse a decrement from.
|
117
117
|
#
|
118
118
|
# @param currency [String, nil] The currency or custom pricing unit to use for this ledger entry. If this is a r
|
119
|
-
# ...
|
120
119
|
#
|
121
120
|
# @param description [String, nil] Optional metadata that can be specified when adding ledger results via the API.
|
122
|
-
# ...
|
123
121
|
#
|
124
122
|
# @param effective_date [Time, nil] An ISO 8601 format date that denotes when this credit balance should become avai
|
125
|
-
# ...
|
126
123
|
#
|
127
|
-
# @param invoice_settings [Orb::
|
128
|
-
# ...
|
124
|
+
# @param invoice_settings [Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings, nil] Passing `invoice_settings` automatically generates an invoice for the newly adde
|
129
125
|
#
|
130
126
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
131
|
-
# ...
|
132
127
|
#
|
133
128
|
# @param per_unit_cost_basis [String, nil] Can only be specified when entry_type=increment. How much, in the customer's cur
|
134
|
-
# ...
|
135
129
|
#
|
136
|
-
# @param void_reason [Symbol, Orb::
|
130
|
+
# @param void_reason [Symbol, Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason, nil] Can only be specified when `entry_type=void`. The reason for the void.
|
137
131
|
#
|
138
132
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
139
133
|
|
@@ -177,7 +171,7 @@ module Orb
|
|
177
171
|
|
178
172
|
# @!method initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil)
|
179
173
|
# Some parameter documentations has been truncated, see
|
180
|
-
# {Orb::
|
174
|
+
# {Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings}
|
181
175
|
# for more details.
|
182
176
|
#
|
183
177
|
# Passing `invoice_settings` automatically generates an invoice for the newly
|
@@ -186,15 +180,12 @@ module Orb
|
|
186
180
|
# basis.
|
187
181
|
#
|
188
182
|
# @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav
|
189
|
-
# ...
|
190
183
|
#
|
191
184
|
# @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d
|
192
|
-
# ...
|
193
185
|
#
|
194
186
|
# @param memo [String, nil] An optional memo to display on the invoice.
|
195
187
|
#
|
196
188
|
# @param require_successful_payment [Boolean] If true, the new credit block will require that the corresponding invoice is pai
|
197
|
-
# ...
|
198
189
|
end
|
199
190
|
|
200
191
|
# Can only be specified when `entry_type=void`. The reason for the void.
|
@@ -132,7 +132,6 @@ module Orb
|
|
132
132
|
# @param ledger_sequence_number [Integer]
|
133
133
|
#
|
134
134
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
135
|
-
# ...
|
136
135
|
#
|
137
136
|
# @param starting_balance [Float]
|
138
137
|
#
|
@@ -304,7 +303,6 @@ module Orb
|
|
304
303
|
# @param ledger_sequence_number [Integer]
|
305
304
|
#
|
306
305
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
307
|
-
# ...
|
308
306
|
#
|
309
307
|
# @param starting_balance [Float]
|
310
308
|
#
|
@@ -472,7 +470,6 @@ module Orb
|
|
472
470
|
# @param ledger_sequence_number [Integer]
|
473
471
|
#
|
474
472
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
475
|
-
# ...
|
476
473
|
#
|
477
474
|
# @param new_block_expiry_date [Time, nil]
|
478
475
|
#
|
@@ -631,7 +628,6 @@ module Orb
|
|
631
628
|
# @param ledger_sequence_number [Integer]
|
632
629
|
#
|
633
630
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
634
|
-
# ...
|
635
631
|
#
|
636
632
|
# @param starting_balance [Float]
|
637
633
|
#
|
@@ -798,7 +794,6 @@ module Orb
|
|
798
794
|
# @param ledger_sequence_number [Integer]
|
799
795
|
#
|
800
796
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
801
|
-
# ...
|
802
797
|
#
|
803
798
|
# @param starting_balance [Float]
|
804
799
|
#
|
@@ -974,7 +969,6 @@ module Orb
|
|
974
969
|
# @param ledger_sequence_number [Integer]
|
975
970
|
#
|
976
971
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
977
|
-
# ...
|
978
972
|
#
|
979
973
|
# @param new_block_expiry_date [Time]
|
980
974
|
#
|
@@ -1137,7 +1131,6 @@ module Orb
|
|
1137
1131
|
# @param ledger_sequence_number [Integer]
|
1138
1132
|
#
|
1139
1133
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
1140
|
-
# ...
|
1141
1134
|
#
|
1142
1135
|
# @param starting_balance [Float]
|
1143
1136
|
#
|
@@ -1197,6 +1190,20 @@ module Orb
|
|
1197
1190
|
|
1198
1191
|
# @!method self.variants
|
1199
1192
|
# @return [Array(Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Increment, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Decrement, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChange, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Void, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiated, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Amendment)]
|
1193
|
+
|
1194
|
+
define_sorbet_constant!(:Variants) do
|
1195
|
+
T.type_alias do
|
1196
|
+
T.any(
|
1197
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Increment,
|
1198
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Decrement,
|
1199
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChange,
|
1200
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiry,
|
1201
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Void,
|
1202
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiated,
|
1203
|
+
Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Amendment
|
1204
|
+
)
|
1205
|
+
end
|
1206
|
+
end
|
1200
1207
|
end
|
1201
1208
|
end
|
1202
1209
|
end
|