orb-billing 0.2.0 → 0.3.1
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 +67 -0
- data/README.md +63 -53
- data/lib/orb/client.rb +4 -4
- data/lib/orb/errors.rb +9 -9
- data/lib/orb/file_part.rb +55 -0
- data/lib/orb/internal/page.rb +7 -11
- data/lib/orb/internal/transport/base_client.rb +10 -10
- data/lib/orb/internal/transport/pooled_net_requester.rb +2 -2
- data/lib/orb/internal/type/array_of.rb +11 -0
- data/lib/orb/internal/type/base_model.rb +33 -23
- data/lib/orb/internal/type/base_page.rb +9 -1
- data/lib/orb/internal/type/boolean.rb +14 -11
- data/lib/orb/internal/type/converter.rb +4 -1
- data/lib/orb/internal/type/enum.rb +19 -16
- data/lib/orb/internal/type/{io_like.rb → file_input.rb} +33 -15
- data/lib/orb/internal/type/hash_of.rb +11 -0
- data/lib/orb/internal/type/request_parameters.rb +3 -10
- data/lib/orb/internal/type/union.rb +10 -1
- data/lib/orb/internal/type/unknown.rb +14 -11
- data/lib/orb/internal/util.rb +88 -64
- data/lib/orb/internal.rb +0 -1
- data/lib/orb/models/alert.rb +68 -71
- data/lib/orb/models/alert_create_for_customer_params.rb +20 -25
- data/lib/orb/models/alert_create_for_external_customer_params.rb +20 -25
- data/lib/orb/models/alert_create_for_subscription_params.rb +20 -25
- data/lib/orb/models/alert_disable_params.rb +5 -9
- data/lib/orb/models/alert_enable_params.rb +5 -9
- data/lib/orb/models/alert_list_params.rb +26 -36
- data/lib/orb/models/alert_retrieve_params.rb +3 -8
- data/lib/orb/models/alert_update_params.rb +14 -18
- data/lib/orb/models/amount_discount.rb +14 -14
- data/lib/orb/models/billable_metric.rb +23 -20
- data/lib/orb/models/billing_cycle_relative_date.rb +2 -5
- data/lib/orb/models/coupon.rb +28 -21
- data/lib/orb/models/coupon_archive_params.rb +3 -8
- data/lib/orb/models/coupon_create_params.rb +29 -34
- data/lib/orb/models/coupon_fetch_params.rb +3 -8
- data/lib/orb/models/coupon_list_params.rb +17 -17
- data/lib/orb/models/coupons/subscription_list_params.rb +12 -15
- data/lib/orb/models/credit_note.rb +100 -166
- data/lib/orb/models/credit_note_create_params.rb +15 -23
- data/lib/orb/models/credit_note_fetch_params.rb +3 -8
- data/lib/orb/models/credit_note_list_params.rb +20 -30
- data/lib/orb/models/customer.rb +224 -271
- data/lib/orb/models/customer_create_params.rb +216 -257
- data/lib/orb/models/customer_delete_params.rb +3 -8
- data/lib/orb/models/customer_fetch_by_external_id_params.rb +3 -8
- data/lib/orb/models/customer_fetch_params.rb +3 -8
- data/lib/orb/models/customer_list_params.rb +20 -30
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +3 -8
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +3 -8
- data/lib/orb/models/customer_update_by_external_id_params.rb +212 -257
- data/lib/orb/models/customer_update_params.rb +212 -255
- data/lib/orb/models/customers/balance_transaction_create_params.rb +11 -16
- data/lib/orb/models/customers/balance_transaction_create_response.rb +33 -51
- data/lib/orb/models/customers/balance_transaction_list_params.rb +20 -30
- data/lib/orb/models/customers/balance_transaction_list_response.rb +33 -51
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +23 -27
- data/lib/orb/models/customers/cost_list_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_response.rb +23 -27
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +18 -22
- data/lib/orb/models/customers/credit_list_by_external_id_response.rb +10 -17
- data/lib/orb/models/customers/credit_list_params.rb +18 -22
- data/lib/orb/models/customers/credit_list_response.rb +10 -17
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +64 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +384 -491
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +63 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +384 -498
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +33 -48
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +384 -494
- data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
- data/lib/orb/models/customers/credits/ledger_list_response.rb +383 -501
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +47 -50
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +43 -46
- data/lib/orb/models/customers/credits/top_up_create_params.rb +46 -50
- data/lib/orb/models/customers/credits/top_up_create_response.rb +42 -46
- data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +4 -9
- data/lib/orb/models/customers/credits/top_up_delete_params.rb +4 -9
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +12 -15
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +43 -46
- data/lib/orb/models/customers/credits/top_up_list_params.rb +12 -15
- data/lib/orb/models/customers/credits/top_up_list_response.rb +42 -46
- data/lib/orb/models/dimensional_price_group.rb +21 -15
- data/lib/orb/models/dimensional_price_group_create_params.rb +17 -23
- data/lib/orb/models/dimensional_price_group_list_params.rb +12 -15
- data/lib/orb/models/dimensional_price_group_retrieve_params.rb +3 -8
- data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +3 -8
- data/lib/orb/models/dimensional_price_groups.rb +3 -7
- data/lib/orb/models/discount.rb +2 -3
- data/lib/orb/models/evaluate_price_group.rb +8 -11
- data/lib/orb/models/event_deprecate_params.rb +3 -8
- data/lib/orb/models/event_deprecate_response.rb +2 -6
- data/lib/orb/models/event_ingest_params.rb +33 -27
- data/lib/orb/models/event_ingest_response.rb +23 -24
- data/lib/orb/models/event_search_params.rb +15 -11
- data/lib/orb/models/event_search_response.rb +27 -22
- data/lib/orb/models/event_update_params.rb +19 -13
- data/lib/orb/models/event_update_response.rb +2 -6
- data/lib/orb/models/events/backfill_close_params.rb +3 -8
- data/lib/orb/models/events/backfill_close_response.rb +34 -39
- data/lib/orb/models/events/backfill_create_params.rb +28 -32
- data/lib/orb/models/events/backfill_create_response.rb +34 -39
- data/lib/orb/models/events/backfill_fetch_params.rb +3 -8
- data/lib/orb/models/events/backfill_fetch_response.rb +34 -39
- data/lib/orb/models/events/backfill_list_params.rb +12 -15
- data/lib/orb/models/events/backfill_list_response.rb +34 -39
- data/lib/orb/models/events/backfill_revert_params.rb +3 -8
- data/lib/orb/models/events/backfill_revert_response.rb +34 -39
- data/lib/orb/models/events/event_volumes.rb +11 -17
- data/lib/orb/models/events/volume_list_params.rb +19 -22
- data/lib/orb/models/invoice.rb +619 -681
- data/lib/orb/models/invoice_create_params.rb +52 -61
- data/lib/orb/models/invoice_fetch_params.rb +3 -8
- data/lib/orb/models/invoice_fetch_upcoming_params.rb +4 -9
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +618 -669
- data/lib/orb/models/invoice_issue_params.rb +10 -14
- data/lib/orb/models/invoice_level_discount.rb +2 -3
- data/lib/orb/models/invoice_line_item_create_params.rb +19 -14
- data/lib/orb/models/invoice_line_item_create_response.rb +281 -306
- data/lib/orb/models/invoice_list_params.rb +51 -66
- data/lib/orb/models/invoice_mark_paid_params.rb +9 -11
- data/lib/orb/models/invoice_pay_params.rb +3 -8
- data/lib/orb/models/invoice_update_params.rb +9 -9
- data/lib/orb/models/invoice_void_params.rb +3 -8
- data/lib/orb/models/item.rb +14 -25
- data/lib/orb/models/item_create_params.rb +5 -9
- data/lib/orb/models/item_fetch_params.rb +3 -8
- data/lib/orb/models/item_list_params.rb +12 -15
- data/lib/orb/models/item_update_params.rb +10 -22
- data/lib/orb/models/metric_create_params.rb +17 -13
- data/lib/orb/models/metric_fetch_params.rb +3 -8
- data/lib/orb/models/metric_list_params.rb +20 -30
- data/lib/orb/models/metric_update_params.rb +9 -9
- data/lib/orb/models/pagination_metadata.rb +3 -7
- data/lib/orb/models/percentage_discount.rb +15 -14
- data/lib/orb/models/plan.rb +259 -291
- data/lib/orb/models/plan_create_params.rb +2070 -2466
- data/lib/orb/models/plan_fetch_params.rb +3 -8
- data/lib/orb/models/plan_list_params.rb +25 -42
- data/lib/orb/models/plan_update_params.rb +12 -10
- data/lib/orb/models/plans/external_plan_id_fetch_params.rb +3 -8
- data/lib/orb/models/plans/external_plan_id_update_params.rb +12 -10
- data/lib/orb/models/price.rb +3842 -5005
- data/lib/orb/models/price_create_params.rb +203 -244
- data/lib/orb/models/price_evaluate_params.rb +21 -30
- data/lib/orb/models/price_evaluate_response.rb +2 -6
- data/lib/orb/models/price_fetch_params.rb +3 -8
- data/lib/orb/models/price_list_params.rb +12 -15
- data/lib/orb/models/price_update_params.rb +9 -9
- data/lib/orb/models/prices/external_price_id_fetch_params.rb +3 -8
- data/lib/orb/models/prices/external_price_id_update_params.rb +9 -9
- data/lib/orb/models/subscription.rb +360 -405
- data/lib/orb/models/subscription_cancel_params.rb +16 -16
- data/lib/orb/models/subscription_cancel_response.rb +358 -399
- data/lib/orb/models/subscription_change_apply_params.rb +7 -10
- data/lib/orb/models/subscription_change_apply_response.rb +384 -418
- data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
- data/lib/orb/models/subscription_change_cancel_response.rb +384 -417
- data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
- data/lib/orb/models/subscription_change_retrieve_response.rb +385 -417
- data/lib/orb/models/subscription_create_params.rb +4735 -5417
- data/lib/orb/models/subscription_create_response.rb +358 -399
- data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
- data/lib/orb/models/subscription_fetch_costs_response.rb +23 -27
- data/lib/orb/models/subscription_fetch_params.rb +3 -8
- data/lib/orb/models/subscription_fetch_schedule_params.rb +20 -30
- data/lib/orb/models/subscription_fetch_schedule_response.rb +15 -17
- data/lib/orb/models/subscription_fetch_usage_params.rb +32 -43
- data/lib/orb/models/subscription_list_params.rb +28 -41
- data/lib/orb/models/subscription_price_intervals_params.rb +2560 -3040
- data/lib/orb/models/subscription_price_intervals_response.rb +361 -399
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +4728 -5411
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +361 -398
- data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
- data/lib/orb/models/subscription_trigger_phase_response.rb +360 -399
- data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +361 -398
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +5 -9
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +362 -396
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +362 -396
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +22 -33
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +361 -398
- data/lib/orb/models/subscription_update_params.rb +21 -23
- data/lib/orb/models/subscription_update_trial_params.rb +15 -18
- data/lib/orb/models/subscription_update_trial_response.rb +360 -399
- data/lib/orb/models/subscription_usage.rb +37 -80
- data/lib/orb/models/subscriptions.rb +3 -7
- data/lib/orb/models/top_level_ping_params.rb +3 -8
- data/lib/orb/models/top_level_ping_response.rb +2 -6
- data/lib/orb/models/trial_discount.rb +16 -24
- data/lib/orb/models/usage_discount.rb +15 -14
- data/lib/orb/models.rb +220 -0
- data/lib/orb/request_options.rb +4 -6
- data/lib/orb/resources/alerts.rb +48 -17
- data/lib/orb/resources/coupons/subscriptions.rb +9 -2
- data/lib/orb/resources/coupons.rb +26 -8
- data/lib/orb/resources/credit_notes.rb +17 -4
- data/lib/orb/resources/customers/balance_transactions.rb +18 -3
- data/lib/orb/resources/customers/costs.rb +26 -8
- data/lib/orb/resources/customers/credits/ledger.rb +112 -32
- data/lib/orb/resources/customers/credits/top_ups.rb +67 -20
- data/lib/orb/resources/customers/credits.rb +28 -8
- data/lib/orb/resources/customers.rb +138 -39
- data/lib/orb/resources/dimensional_price_groups.rb +19 -4
- data/lib/orb/resources/events/backfills.rb +32 -9
- data/lib/orb/resources/events/volume.rb +14 -4
- data/lib/orb/resources/events.rb +40 -11
- data/lib/orb/resources/invoice_line_items.rb +16 -6
- data/lib/orb/resources/invoices.rb +77 -17
- data/lib/orb/resources/items.rb +10 -3
- data/lib/orb/resources/metrics.rb +33 -8
- data/lib/orb/resources/plans/external_plan_id.rb +10 -2
- data/lib/orb/resources/plans.rb +47 -11
- data/lib/orb/resources/prices/external_price_id.rb +9 -3
- data/lib/orb/resources/prices.rb +101 -26
- data/lib/orb/resources/subscription_changes.rb +5 -2
- data/lib/orb/resources/subscriptions.rb +292 -78
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +2 -10
- data/rbi/{lib/orb → orb}/client.rbi +4 -4
- data/rbi/{lib/orb → orb}/errors.rbi +1 -1
- data/rbi/orb/file_part.rbi +34 -0
- data/rbi/{lib/orb → orb}/internal/transport/base_client.rbi +19 -5
- data/rbi/{lib/orb → orb}/internal/type/array_of.rbi +3 -0
- data/rbi/{lib/orb → orb}/internal/type/base_model.rbi +7 -1
- data/rbi/{lib/orb → orb}/internal/type/base_page.rbi +2 -0
- data/rbi/{lib/orb → orb}/internal/type/enum.rbi +3 -6
- data/rbi/{lib/orb/internal/type/io_like.rbi → orb/internal/type/file_input.rbi} +5 -2
- data/rbi/{lib/orb → orb}/internal/type/hash_of.rbi +3 -0
- data/rbi/{lib/orb → orb}/internal/type/request_parameters.rbi +1 -1
- data/rbi/{lib/orb → orb}/internal/type/union.rbi +3 -0
- data/rbi/{lib/orb → orb}/internal/util.rbi +28 -19
- data/rbi/{lib/orb → orb}/internal.rbi +0 -1
- data/rbi/{lib/orb → orb}/models/alert.rbi +28 -8
- data/rbi/{lib/orb → orb}/models/alert_create_for_customer_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/alert_create_for_external_customer_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/alert_create_for_subscription_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/alert_disable_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/alert_enable_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/alert_list_params.rbi +6 -0
- data/rbi/{lib/orb → orb}/models/alert_update_params.rbi +11 -4
- data/rbi/{lib/orb → orb}/models/amount_discount.rbi +10 -4
- data/rbi/{lib/orb → orb}/models/billable_metric.rbi +16 -3
- data/rbi/{lib/orb → orb}/models/billing_cycle_relative_date.rbi +1 -1
- data/rbi/{lib/orb → orb}/models/coupon.rbi +10 -3
- data/rbi/{lib/orb → orb}/models/coupon_create_params.rbi +15 -12
- data/rbi/{lib/orb → orb}/models/coupon_list_params.rbi +13 -3
- data/rbi/{lib/orb → orb}/models/coupons/subscription_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/credit_note.rbi +44 -12
- data/rbi/{lib/orb → orb}/models/credit_note_create_params.rbi +15 -6
- data/rbi/{lib/orb → orb}/models/credit_note_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/customer.rbi +130 -11
- data/rbi/{lib/orb → orb}/models/customer_create_params.rbi +151 -17
- data/rbi/{lib/orb → orb}/models/customer_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/customer_update_by_external_id_params.rbi +149 -17
- data/rbi/{lib/orb → orb}/models/customer_update_params.rbi +149 -17
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_params.rbi +8 -4
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_response.rbi +18 -8
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_response.rbi +18 -8
- data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_params.rbi +9 -5
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +225 -0
- data/rbi/{lib/orb → orb}/models/customers/cost_list_params.rbi +9 -5
- data/rbi/orb/models/customers/cost_list_response.rbi +223 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_params.rbi +13 -3
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_response.rbi +1 -2
- data/rbi/{lib/orb → orb}/models/customers/credit_list_params.rbi +13 -3
- data/rbi/{lib/orb → orb}/models/customers/credit_list_response.rbi +1 -2
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_response.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi} +157 -170
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_params.rbi +40 -6
- data/rbi/{lib/orb/models/customers/credits/ledger_list_response.rbi → orb/models/customers/credits/ledger_create_entry_response.rbi} +149 -196
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_response.rbi +148 -229
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_params.rbi +6 -4
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi → orb/models/customers/credits/ledger_list_response.rbi} +149 -343
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_params.rbi +27 -4
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_response.rbi +25 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_response.rbi +25 -4
- data/rbi/{lib/orb → orb}/models/dimensional_price_group.rbi +11 -3
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_create_params.rbi +4 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/evaluate_price_group.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/event_deprecate_response.rbi +4 -2
- data/rbi/{lib/orb → orb}/models/event_ingest_params.rbi +22 -5
- data/rbi/{lib/orb → orb}/models/event_ingest_response.rbi +15 -4
- data/rbi/{lib/orb → orb}/models/event_search_params.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/event_search_response.rbi +14 -3
- data/rbi/{lib/orb → orb}/models/event_update_params.rbi +10 -3
- data/rbi/{lib/orb → orb}/models/event_update_response.rbi +4 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_close_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_create_params.rbi +18 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_create_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_fetch_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_list_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_revert_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/event_volumes.rbi +8 -4
- data/rbi/{lib/orb → orb}/models/events/volume_list_params.rbi +18 -2
- data/rbi/{lib/orb → orb}/models/invoice.rbi +513 -202
- data/rbi/{lib/orb → orb}/models/invoice_create_params.rbi +38 -6
- data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_response.rbi +513 -216
- data/rbi/{lib/orb → orb}/models/invoice_issue_params.rbi +9 -2
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_params.rbi +16 -2
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_response.rbi +279 -182
- data/rbi/{lib/orb → orb}/models/invoice_list_params.rbi +9 -2
- data/rbi/{lib/orb → orb}/models/invoice_mark_paid_params.rbi +9 -2
- data/rbi/{lib/orb → orb}/models/invoice_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/item.rbi +1 -2
- data/rbi/{lib/orb → orb}/models/item_create_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/item_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/item_update_params.rbi +1 -8
- data/rbi/{lib/orb → orb}/models/metric_create_params.rbi +15 -2
- data/rbi/{lib/orb → orb}/models/metric_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/metric_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/percentage_discount.rbi +11 -4
- data/rbi/{lib/orb → orb}/models/plan.rbi +207 -120
- data/rbi/{lib/orb → orb}/models/plan_create_params.rbi +1971 -2414
- data/rbi/{lib/orb → orb}/models/plan_list_params.rbi +5 -1
- data/rbi/{lib/orb → orb}/models/plan_update_params.rbi +11 -2
- data/rbi/{lib/orb → orb}/models/plans/external_plan_id_update_params.rbi +11 -2
- data/rbi/{lib/orb → orb}/models/price.rbi +2594 -2957
- data/rbi/{lib/orb → orb}/models/price_create_params.rbi +137 -53
- data/rbi/{lib/orb → orb}/models/price_evaluate_params.rbi +10 -0
- data/rbi/{lib/orb → orb}/models/price_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/price_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/prices/external_price_id_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/subscription.rbi +292 -129
- data/rbi/{lib/orb → orb}/models/subscription_cancel_params.rbi +8 -5
- data/rbi/{lib/orb → orb}/models/subscription_cancel_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_response.rbi +317 -136
- data/rbi/{lib/orb → orb}/models/subscription_change_cancel_response.rbi +317 -136
- data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_response.rbi +317 -136
- data/rbi/{lib/orb → orb}/models/subscription_create_params.rbi +4271 -4270
- data/rbi/{lib/orb → orb}/models/subscription_create_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_params.rbi +9 -5
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +221 -0
- data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_response.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/subscription_fetch_usage_params.rbi +13 -4
- data/rbi/{lib/orb → orb}/models/subscription_list_params.rbi +4 -2
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_params.rbi +2354 -2317
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_params.rbi +4280 -3758
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_params.rbi +10 -2
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +305 -138
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_update_params.rbi +15 -0
- data/rbi/{lib/orb → orb}/models/subscription_update_trial_params.rbi +11 -5
- data/rbi/{lib/orb → orb}/models/subscription_update_trial_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_usage.rbi +2 -16
- data/rbi/{lib/orb → orb}/models/trial_discount.rbi +5 -1
- data/rbi/{lib/orb → orb}/models/usage_discount.rbi +11 -3
- data/rbi/orb/models.rbi +220 -0
- data/rbi/{lib/orb → orb}/request_options.rbi +2 -0
- data/rbi/{lib/orb → orb}/resources/alerts.rbi +8 -14
- data/rbi/{lib/orb → orb}/resources/coupons/subscriptions.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/coupons.rbi +6 -18
- data/rbi/{lib/orb → orb}/resources/credit_notes.rbi +3 -9
- data/rbi/{lib/orb → orb}/resources/customers/balance_transactions.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers/costs.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers/credits/ledger.rbi +32 -32
- data/rbi/{lib/orb → orb}/resources/customers/credits/top_ups.rbi +6 -18
- data/rbi/{lib/orb → orb}/resources/customers/credits.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers.rbi +15 -45
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +1 -4
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups.rbi +3 -10
- data/rbi/{lib/orb → orb}/resources/events/backfills.rbi +5 -18
- data/rbi/{lib/orb → orb}/resources/events/volume.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/events.rbi +4 -10
- data/rbi/{lib/orb → orb}/resources/invoice_line_items.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/invoices.rbi +9 -34
- data/rbi/{lib/orb → orb}/resources/items.rbi +4 -17
- data/rbi/{lib/orb → orb}/resources/metrics.rbi +4 -10
- data/rbi/{lib/orb → orb}/resources/plans/external_plan_id.rbi +2 -8
- data/rbi/{lib/orb → orb}/resources/plans.rbi +29 -35
- data/rbi/orb/resources/prices/external_price_id.rbi +103 -0
- data/rbi/{lib/orb → orb}/resources/prices.rbi +117 -124
- data/rbi/{lib/orb → orb}/resources/subscription_changes.rbi +3 -9
- data/rbi/{lib/orb → orb}/resources/subscriptions.rbi +16 -32
- data/rbi/{lib/orb → orb}/resources/top_level.rbi +1 -4
- data/sig/orb/file_part.rbs +21 -0
- data/sig/orb/internal/transport/base_client.rbs +9 -3
- data/sig/orb/internal/type/array_of.rbs +2 -0
- data/sig/orb/internal/type/base_model.rbs +4 -0
- data/sig/orb/internal/type/enum.rbs +2 -2
- data/sig/orb/internal/type/{io_like.rbs → file_input.rbs} +1 -1
- data/sig/orb/internal/type/hash_of.rbs +2 -0
- data/sig/orb/internal/type/union.rbs +2 -0
- data/sig/orb/internal/util.rbs +16 -12
- data/sig/orb/models/coupon_create_params.rbs +9 -10
- data/sig/orb/models/customer_create_params.rbs +9 -10
- data/sig/orb/models/customer_update_by_external_id_params.rbs +9 -10
- data/sig/orb/models/customer_update_params.rbs +9 -10
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +113 -113
- data/sig/orb/models/invoice.rbs +54 -54
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +54 -54
- data/sig/orb/models/invoice_line_item_create_response.rbs +54 -54
- data/sig/orb/models/plan.rbs +21 -21
- data/sig/orb/models/plan_create_params.rbs +653 -653
- data/sig/orb/models/price.rbs +1517 -1521
- data/sig/orb/models/subscription.rbs +34 -34
- data/sig/orb/models/subscription_cancel_response.rbs +34 -34
- data/sig/orb/models/subscription_change_apply_response.rbs +34 -34
- data/sig/orb/models/subscription_change_cancel_response.rbs +34 -34
- data/sig/orb/models/subscription_change_retrieve_response.rbs +34 -34
- data/sig/orb/models/subscription_create_params.rbs +1348 -1348
- data/sig/orb/models/subscription_create_response.rbs +34 -34
- data/sig/orb/models/subscription_price_intervals_params.rbs +767 -769
- data/sig/orb/models/subscription_price_intervals_response.rbs +34 -34
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1348 -1348
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +34 -34
- data/sig/orb/models/subscription_trigger_phase_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +34 -34
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +34 -34
- data/sig/orb/models/subscription_update_trial_response.rbs +34 -34
- data/sig/orb/models.rbs +215 -0
- metadata +230 -224
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +0 -208
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +0 -206
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +0 -204
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +0 -106
- /data/rbi/{lib/orb → orb}/internal/page.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/transport/pooled_net_requester.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/type/boolean.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/type/converter.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/type/unknown.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/alert_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/coupon_archive_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/coupon_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/credit_note_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_delete_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_fetch_by_external_id_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_by_external_id_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/dimensional_price_group_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/dimensional_price_groups.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/event_deprecate_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/events/backfill_close_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/events/backfill_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/events/backfill_revert_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_level_discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_pay_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_void_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/metric_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/pagination_metadata.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plan_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plans/external_plan_id_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_evaluate_response.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/prices/external_price_id_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_change_cancel_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscriptions.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/top_level_ping_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/top_level_ping_response.rbi +0 -0
- /data/rbi/{lib/orb → orb}/version.rbi +0 -0
@@ -14,27 +14,26 @@ module Orb
|
|
14
14
|
discriminator :entry_type
|
15
15
|
|
16
16
|
variant :increment,
|
17
|
-
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
17
|
+
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Increment }
|
18
18
|
|
19
19
|
variant :decrement,
|
20
|
-
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
20
|
+
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Decrement }
|
21
21
|
|
22
22
|
variant :expiration_change,
|
23
|
-
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
23
|
+
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChange }
|
24
24
|
|
25
25
|
variant :credit_block_expiry,
|
26
|
-
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
26
|
+
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiry }
|
27
27
|
|
28
|
-
variant :void,
|
29
|
-
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry }
|
28
|
+
variant :void, -> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Void }
|
30
29
|
|
31
30
|
variant :void_initiated,
|
32
|
-
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
31
|
+
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiated }
|
33
32
|
|
34
33
|
variant :amendment,
|
35
|
-
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
34
|
+
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Amendment }
|
36
35
|
|
37
|
-
class
|
36
|
+
class Increment < Orb::Internal::Type::BaseModel
|
38
37
|
# @!attribute id
|
39
38
|
#
|
40
39
|
# @return [String]
|
@@ -52,9 +51,9 @@ module Orb
|
|
52
51
|
|
53
52
|
# @!attribute credit_block
|
54
53
|
#
|
55
|
-
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
54
|
+
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Increment::CreditBlock]
|
56
55
|
required :credit_block,
|
57
|
-
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
56
|
+
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Increment::CreditBlock }
|
58
57
|
|
59
58
|
# @!attribute currency
|
60
59
|
#
|
@@ -63,9 +62,9 @@ module Orb
|
|
63
62
|
|
64
63
|
# @!attribute customer
|
65
64
|
#
|
66
|
-
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
65
|
+
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Increment::Customer]
|
67
66
|
required :customer,
|
68
|
-
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
67
|
+
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Increment::Customer }
|
69
68
|
|
70
69
|
# @!attribute description
|
71
70
|
#
|
@@ -79,9 +78,9 @@ module Orb
|
|
79
78
|
|
80
79
|
# @!attribute entry_status
|
81
80
|
#
|
82
|
-
# @return [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
81
|
+
# @return [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Increment::EntryStatus]
|
83
82
|
required :entry_status,
|
84
|
-
enum: -> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
83
|
+
enum: -> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Increment::EntryStatus }
|
85
84
|
|
86
85
|
# @!attribute entry_type
|
87
86
|
#
|
@@ -107,43 +106,39 @@ module Orb
|
|
107
106
|
# @return [Float]
|
108
107
|
required :starting_balance, Float
|
109
108
|
|
110
|
-
# @!
|
111
|
-
#
|
112
|
-
#
|
113
|
-
#
|
114
|
-
#
|
115
|
-
#
|
116
|
-
#
|
117
|
-
#
|
118
|
-
#
|
119
|
-
#
|
120
|
-
#
|
121
|
-
#
|
122
|
-
#
|
123
|
-
#
|
124
|
-
#
|
125
|
-
#
|
126
|
-
#
|
127
|
-
#
|
128
|
-
#
|
129
|
-
#
|
130
|
-
#
|
131
|
-
#
|
132
|
-
#
|
133
|
-
#
|
134
|
-
#
|
135
|
-
#
|
136
|
-
#
|
137
|
-
#
|
138
|
-
#
|
139
|
-
#
|
140
|
-
#
|
141
|
-
|
142
|
-
#
|
143
|
-
|
144
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
145
|
-
|
146
|
-
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry#credit_block
|
109
|
+
# @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :increment)
|
110
|
+
# Some parameter documentations has been truncated, see
|
111
|
+
# {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Increment}
|
112
|
+
# for more details.
|
113
|
+
#
|
114
|
+
# @param id [String]
|
115
|
+
#
|
116
|
+
# @param amount [Float]
|
117
|
+
#
|
118
|
+
# @param created_at [Time]
|
119
|
+
#
|
120
|
+
# @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Increment::CreditBlock]
|
121
|
+
#
|
122
|
+
# @param currency [String]
|
123
|
+
#
|
124
|
+
# @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Increment::Customer]
|
125
|
+
#
|
126
|
+
# @param description [String, nil]
|
127
|
+
#
|
128
|
+
# @param ending_balance [Float]
|
129
|
+
#
|
130
|
+
# @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Increment::EntryStatus]
|
131
|
+
#
|
132
|
+
# @param ledger_sequence_number [Integer]
|
133
|
+
#
|
134
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
135
|
+
# ...
|
136
|
+
#
|
137
|
+
# @param starting_balance [Float]
|
138
|
+
#
|
139
|
+
# @param entry_type [Symbol, :increment]
|
140
|
+
|
141
|
+
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Increment#credit_block
|
147
142
|
class CreditBlock < Orb::Internal::Type::BaseModel
|
148
143
|
# @!attribute id
|
149
144
|
#
|
@@ -160,17 +155,13 @@ module Orb
|
|
160
155
|
# @return [String, nil]
|
161
156
|
required :per_unit_cost_basis, String, nil?: true
|
162
157
|
|
163
|
-
# @!
|
164
|
-
#
|
165
|
-
#
|
166
|
-
#
|
167
|
-
# #
|
168
|
-
# def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
|
169
|
-
|
170
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
158
|
+
# @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
|
159
|
+
# @param id [String]
|
160
|
+
# @param expiry_date [Time, nil]
|
161
|
+
# @param per_unit_cost_basis [String, nil]
|
171
162
|
end
|
172
163
|
|
173
|
-
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
164
|
+
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Increment#customer
|
174
165
|
class Customer < Orb::Internal::Type::BaseModel
|
175
166
|
# @!attribute id
|
176
167
|
#
|
@@ -182,31 +173,24 @@ module Orb
|
|
182
173
|
# @return [String, nil]
|
183
174
|
required :external_customer_id, String, nil?: true
|
184
175
|
|
185
|
-
# @!
|
186
|
-
#
|
187
|
-
#
|
188
|
-
# #
|
189
|
-
# def initialize(id:, external_customer_id:, **) = super
|
190
|
-
|
191
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
176
|
+
# @!method initialize(id:, external_customer_id:)
|
177
|
+
# @param id [String]
|
178
|
+
# @param external_customer_id [String, nil]
|
192
179
|
end
|
193
180
|
|
194
|
-
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
181
|
+
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Increment#entry_status
|
195
182
|
module EntryStatus
|
196
183
|
extend Orb::Internal::Type::Enum
|
197
184
|
|
198
185
|
COMMITTED = :committed
|
199
186
|
PENDING = :pending
|
200
187
|
|
201
|
-
|
202
|
-
|
203
|
-
# @!parse
|
204
|
-
# # @return [Array<Symbol>]
|
205
|
-
# def self.values; end
|
188
|
+
# @!method self.values
|
189
|
+
# @return [Array<Symbol>]
|
206
190
|
end
|
207
191
|
end
|
208
192
|
|
209
|
-
class
|
193
|
+
class Decrement < Orb::Internal::Type::BaseModel
|
210
194
|
# @!attribute id
|
211
195
|
#
|
212
196
|
# @return [String]
|
@@ -224,9 +208,9 @@ module Orb
|
|
224
208
|
|
225
209
|
# @!attribute credit_block
|
226
210
|
#
|
227
|
-
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
211
|
+
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Decrement::CreditBlock]
|
228
212
|
required :credit_block,
|
229
|
-
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
213
|
+
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Decrement::CreditBlock }
|
230
214
|
|
231
215
|
# @!attribute currency
|
232
216
|
#
|
@@ -235,9 +219,9 @@ module Orb
|
|
235
219
|
|
236
220
|
# @!attribute customer
|
237
221
|
#
|
238
|
-
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
222
|
+
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Decrement::Customer]
|
239
223
|
required :customer,
|
240
|
-
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
224
|
+
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Decrement::Customer }
|
241
225
|
|
242
226
|
# @!attribute description
|
243
227
|
#
|
@@ -251,9 +235,9 @@ module Orb
|
|
251
235
|
|
252
236
|
# @!attribute entry_status
|
253
237
|
#
|
254
|
-
# @return [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
238
|
+
# @return [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Decrement::EntryStatus]
|
255
239
|
required :entry_status,
|
256
|
-
enum: -> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
240
|
+
enum: -> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Decrement::EntryStatus }
|
257
241
|
|
258
242
|
# @!attribute entry_type
|
259
243
|
#
|
@@ -294,49 +278,45 @@ module Orb
|
|
294
278
|
# @return [String, nil]
|
295
279
|
optional :price_id, String, nil?: true
|
296
280
|
|
297
|
-
# @!
|
298
|
-
#
|
299
|
-
#
|
300
|
-
#
|
301
|
-
#
|
302
|
-
#
|
303
|
-
#
|
304
|
-
#
|
305
|
-
#
|
306
|
-
#
|
307
|
-
#
|
308
|
-
#
|
309
|
-
#
|
310
|
-
#
|
311
|
-
#
|
312
|
-
#
|
313
|
-
#
|
314
|
-
#
|
315
|
-
#
|
316
|
-
#
|
317
|
-
#
|
318
|
-
#
|
319
|
-
#
|
320
|
-
#
|
321
|
-
#
|
322
|
-
#
|
323
|
-
#
|
324
|
-
#
|
325
|
-
#
|
326
|
-
#
|
327
|
-
#
|
328
|
-
#
|
329
|
-
#
|
330
|
-
#
|
331
|
-
#
|
332
|
-
#
|
333
|
-
#
|
334
|
-
|
335
|
-
#
|
336
|
-
|
337
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
338
|
-
|
339
|
-
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry#credit_block
|
281
|
+
# @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, event_id: nil, invoice_id: nil, price_id: nil, entry_type: :decrement)
|
282
|
+
# Some parameter documentations has been truncated, see
|
283
|
+
# {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Decrement}
|
284
|
+
# for more details.
|
285
|
+
#
|
286
|
+
# @param id [String]
|
287
|
+
#
|
288
|
+
# @param amount [Float]
|
289
|
+
#
|
290
|
+
# @param created_at [Time]
|
291
|
+
#
|
292
|
+
# @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Decrement::CreditBlock]
|
293
|
+
#
|
294
|
+
# @param currency [String]
|
295
|
+
#
|
296
|
+
# @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Decrement::Customer]
|
297
|
+
#
|
298
|
+
# @param description [String, nil]
|
299
|
+
#
|
300
|
+
# @param ending_balance [Float]
|
301
|
+
#
|
302
|
+
# @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Decrement::EntryStatus]
|
303
|
+
#
|
304
|
+
# @param ledger_sequence_number [Integer]
|
305
|
+
#
|
306
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
307
|
+
# ...
|
308
|
+
#
|
309
|
+
# @param starting_balance [Float]
|
310
|
+
#
|
311
|
+
# @param event_id [String, nil]
|
312
|
+
#
|
313
|
+
# @param invoice_id [String, nil]
|
314
|
+
#
|
315
|
+
# @param price_id [String, nil]
|
316
|
+
#
|
317
|
+
# @param entry_type [Symbol, :decrement]
|
318
|
+
|
319
|
+
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Decrement#credit_block
|
340
320
|
class CreditBlock < Orb::Internal::Type::BaseModel
|
341
321
|
# @!attribute id
|
342
322
|
#
|
@@ -353,17 +333,13 @@ module Orb
|
|
353
333
|
# @return [String, nil]
|
354
334
|
required :per_unit_cost_basis, String, nil?: true
|
355
335
|
|
356
|
-
# @!
|
357
|
-
#
|
358
|
-
#
|
359
|
-
#
|
360
|
-
# #
|
361
|
-
# def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
|
362
|
-
|
363
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
336
|
+
# @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
|
337
|
+
# @param id [String]
|
338
|
+
# @param expiry_date [Time, nil]
|
339
|
+
# @param per_unit_cost_basis [String, nil]
|
364
340
|
end
|
365
341
|
|
366
|
-
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
342
|
+
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Decrement#customer
|
367
343
|
class Customer < Orb::Internal::Type::BaseModel
|
368
344
|
# @!attribute id
|
369
345
|
#
|
@@ -375,31 +351,24 @@ module Orb
|
|
375
351
|
# @return [String, nil]
|
376
352
|
required :external_customer_id, String, nil?: true
|
377
353
|
|
378
|
-
# @!
|
379
|
-
#
|
380
|
-
#
|
381
|
-
# #
|
382
|
-
# def initialize(id:, external_customer_id:, **) = super
|
383
|
-
|
384
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
354
|
+
# @!method initialize(id:, external_customer_id:)
|
355
|
+
# @param id [String]
|
356
|
+
# @param external_customer_id [String, nil]
|
385
357
|
end
|
386
358
|
|
387
|
-
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
359
|
+
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Decrement#entry_status
|
388
360
|
module EntryStatus
|
389
361
|
extend Orb::Internal::Type::Enum
|
390
362
|
|
391
363
|
COMMITTED = :committed
|
392
364
|
PENDING = :pending
|
393
365
|
|
394
|
-
|
395
|
-
|
396
|
-
# @!parse
|
397
|
-
# # @return [Array<Symbol>]
|
398
|
-
# def self.values; end
|
366
|
+
# @!method self.values
|
367
|
+
# @return [Array<Symbol>]
|
399
368
|
end
|
400
369
|
end
|
401
370
|
|
402
|
-
class
|
371
|
+
class ExpirationChange < Orb::Internal::Type::BaseModel
|
403
372
|
# @!attribute id
|
404
373
|
#
|
405
374
|
# @return [String]
|
@@ -417,9 +386,9 @@ module Orb
|
|
417
386
|
|
418
387
|
# @!attribute credit_block
|
419
388
|
#
|
420
|
-
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
389
|
+
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChange::CreditBlock]
|
421
390
|
required :credit_block,
|
422
|
-
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
391
|
+
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChange::CreditBlock }
|
423
392
|
|
424
393
|
# @!attribute currency
|
425
394
|
#
|
@@ -428,9 +397,9 @@ module Orb
|
|
428
397
|
|
429
398
|
# @!attribute customer
|
430
399
|
#
|
431
|
-
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
400
|
+
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChange::Customer]
|
432
401
|
required :customer,
|
433
|
-
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
402
|
+
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChange::Customer }
|
434
403
|
|
435
404
|
# @!attribute description
|
436
405
|
#
|
@@ -444,9 +413,9 @@ module Orb
|
|
444
413
|
|
445
414
|
# @!attribute entry_status
|
446
415
|
#
|
447
|
-
# @return [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
416
|
+
# @return [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChange::EntryStatus]
|
448
417
|
required :entry_status,
|
449
|
-
enum: -> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
418
|
+
enum: -> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChange::EntryStatus }
|
450
419
|
|
451
420
|
# @!attribute entry_type
|
452
421
|
#
|
@@ -477,45 +446,41 @@ module Orb
|
|
477
446
|
# @return [Float]
|
478
447
|
required :starting_balance, Float
|
479
448
|
|
480
|
-
# @!
|
481
|
-
#
|
482
|
-
#
|
483
|
-
#
|
484
|
-
#
|
485
|
-
#
|
486
|
-
#
|
487
|
-
#
|
488
|
-
#
|
489
|
-
#
|
490
|
-
#
|
491
|
-
#
|
492
|
-
#
|
493
|
-
#
|
494
|
-
#
|
495
|
-
#
|
496
|
-
#
|
497
|
-
#
|
498
|
-
#
|
499
|
-
#
|
500
|
-
#
|
501
|
-
#
|
502
|
-
#
|
503
|
-
#
|
504
|
-
#
|
505
|
-
#
|
506
|
-
#
|
507
|
-
#
|
508
|
-
#
|
509
|
-
#
|
510
|
-
#
|
511
|
-
#
|
512
|
-
#
|
513
|
-
|
514
|
-
#
|
515
|
-
|
516
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
517
|
-
|
518
|
-
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry#credit_block
|
449
|
+
# @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, new_block_expiry_date:, starting_balance:, entry_type: :expiration_change)
|
450
|
+
# Some parameter documentations has been truncated, see
|
451
|
+
# {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChange}
|
452
|
+
# for more details.
|
453
|
+
#
|
454
|
+
# @param id [String]
|
455
|
+
#
|
456
|
+
# @param amount [Float]
|
457
|
+
#
|
458
|
+
# @param created_at [Time]
|
459
|
+
#
|
460
|
+
# @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChange::CreditBlock]
|
461
|
+
#
|
462
|
+
# @param currency [String]
|
463
|
+
#
|
464
|
+
# @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChange::Customer]
|
465
|
+
#
|
466
|
+
# @param description [String, nil]
|
467
|
+
#
|
468
|
+
# @param ending_balance [Float]
|
469
|
+
#
|
470
|
+
# @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChange::EntryStatus]
|
471
|
+
#
|
472
|
+
# @param ledger_sequence_number [Integer]
|
473
|
+
#
|
474
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
475
|
+
# ...
|
476
|
+
#
|
477
|
+
# @param new_block_expiry_date [Time, nil]
|
478
|
+
#
|
479
|
+
# @param starting_balance [Float]
|
480
|
+
#
|
481
|
+
# @param entry_type [Symbol, :expiration_change]
|
482
|
+
|
483
|
+
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChange#credit_block
|
519
484
|
class CreditBlock < Orb::Internal::Type::BaseModel
|
520
485
|
# @!attribute id
|
521
486
|
#
|
@@ -532,17 +497,13 @@ module Orb
|
|
532
497
|
# @return [String, nil]
|
533
498
|
required :per_unit_cost_basis, String, nil?: true
|
534
499
|
|
535
|
-
# @!
|
536
|
-
#
|
537
|
-
#
|
538
|
-
#
|
539
|
-
# #
|
540
|
-
# def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
|
541
|
-
|
542
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
500
|
+
# @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
|
501
|
+
# @param id [String]
|
502
|
+
# @param expiry_date [Time, nil]
|
503
|
+
# @param per_unit_cost_basis [String, nil]
|
543
504
|
end
|
544
505
|
|
545
|
-
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
506
|
+
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChange#customer
|
546
507
|
class Customer < Orb::Internal::Type::BaseModel
|
547
508
|
# @!attribute id
|
548
509
|
#
|
@@ -554,31 +515,24 @@ module Orb
|
|
554
515
|
# @return [String, nil]
|
555
516
|
required :external_customer_id, String, nil?: true
|
556
517
|
|
557
|
-
# @!
|
558
|
-
#
|
559
|
-
#
|
560
|
-
# #
|
561
|
-
# def initialize(id:, external_customer_id:, **) = super
|
562
|
-
|
563
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
518
|
+
# @!method initialize(id:, external_customer_id:)
|
519
|
+
# @param id [String]
|
520
|
+
# @param external_customer_id [String, nil]
|
564
521
|
end
|
565
522
|
|
566
|
-
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
523
|
+
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChange#entry_status
|
567
524
|
module EntryStatus
|
568
525
|
extend Orb::Internal::Type::Enum
|
569
526
|
|
570
527
|
COMMITTED = :committed
|
571
528
|
PENDING = :pending
|
572
529
|
|
573
|
-
|
574
|
-
|
575
|
-
# @!parse
|
576
|
-
# # @return [Array<Symbol>]
|
577
|
-
# def self.values; end
|
530
|
+
# @!method self.values
|
531
|
+
# @return [Array<Symbol>]
|
578
532
|
end
|
579
533
|
end
|
580
534
|
|
581
|
-
class
|
535
|
+
class CreditBlockExpiry < Orb::Internal::Type::BaseModel
|
582
536
|
# @!attribute id
|
583
537
|
#
|
584
538
|
# @return [String]
|
@@ -596,9 +550,9 @@ module Orb
|
|
596
550
|
|
597
551
|
# @!attribute credit_block
|
598
552
|
#
|
599
|
-
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
553
|
+
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiry::CreditBlock]
|
600
554
|
required :credit_block,
|
601
|
-
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
555
|
+
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiry::CreditBlock }
|
602
556
|
|
603
557
|
# @!attribute currency
|
604
558
|
#
|
@@ -607,9 +561,9 @@ module Orb
|
|
607
561
|
|
608
562
|
# @!attribute customer
|
609
563
|
#
|
610
|
-
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
564
|
+
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiry::Customer]
|
611
565
|
required :customer,
|
612
|
-
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
566
|
+
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiry::Customer }
|
613
567
|
|
614
568
|
# @!attribute description
|
615
569
|
#
|
@@ -623,9 +577,9 @@ module Orb
|
|
623
577
|
|
624
578
|
# @!attribute entry_status
|
625
579
|
#
|
626
|
-
# @return [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
580
|
+
# @return [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiry::EntryStatus]
|
627
581
|
required :entry_status,
|
628
|
-
enum: -> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
582
|
+
enum: -> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiry::EntryStatus }
|
629
583
|
|
630
584
|
# @!attribute entry_type
|
631
585
|
#
|
@@ -651,43 +605,39 @@ module Orb
|
|
651
605
|
# @return [Float]
|
652
606
|
required :starting_balance, Float
|
653
607
|
|
654
|
-
# @!
|
655
|
-
#
|
656
|
-
#
|
657
|
-
#
|
658
|
-
#
|
659
|
-
#
|
660
|
-
#
|
661
|
-
#
|
662
|
-
#
|
663
|
-
#
|
664
|
-
#
|
665
|
-
#
|
666
|
-
#
|
667
|
-
#
|
668
|
-
#
|
669
|
-
#
|
670
|
-
#
|
671
|
-
#
|
672
|
-
#
|
673
|
-
#
|
674
|
-
#
|
675
|
-
#
|
676
|
-
#
|
677
|
-
#
|
678
|
-
#
|
679
|
-
#
|
680
|
-
#
|
681
|
-
#
|
682
|
-
#
|
683
|
-
#
|
684
|
-
#
|
685
|
-
|
686
|
-
#
|
687
|
-
|
688
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
689
|
-
|
690
|
-
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry#credit_block
|
608
|
+
# @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :credit_block_expiry)
|
609
|
+
# Some parameter documentations has been truncated, see
|
610
|
+
# {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiry}
|
611
|
+
# for more details.
|
612
|
+
#
|
613
|
+
# @param id [String]
|
614
|
+
#
|
615
|
+
# @param amount [Float]
|
616
|
+
#
|
617
|
+
# @param created_at [Time]
|
618
|
+
#
|
619
|
+
# @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiry::CreditBlock]
|
620
|
+
#
|
621
|
+
# @param currency [String]
|
622
|
+
#
|
623
|
+
# @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiry::Customer]
|
624
|
+
#
|
625
|
+
# @param description [String, nil]
|
626
|
+
#
|
627
|
+
# @param ending_balance [Float]
|
628
|
+
#
|
629
|
+
# @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiry::EntryStatus]
|
630
|
+
#
|
631
|
+
# @param ledger_sequence_number [Integer]
|
632
|
+
#
|
633
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
634
|
+
# ...
|
635
|
+
#
|
636
|
+
# @param starting_balance [Float]
|
637
|
+
#
|
638
|
+
# @param entry_type [Symbol, :credit_block_expiry]
|
639
|
+
|
640
|
+
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiry#credit_block
|
691
641
|
class CreditBlock < Orb::Internal::Type::BaseModel
|
692
642
|
# @!attribute id
|
693
643
|
#
|
@@ -704,17 +654,13 @@ module Orb
|
|
704
654
|
# @return [String, nil]
|
705
655
|
required :per_unit_cost_basis, String, nil?: true
|
706
656
|
|
707
|
-
# @!
|
708
|
-
#
|
709
|
-
#
|
710
|
-
#
|
711
|
-
# #
|
712
|
-
# def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
|
713
|
-
|
714
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
657
|
+
# @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
|
658
|
+
# @param id [String]
|
659
|
+
# @param expiry_date [Time, nil]
|
660
|
+
# @param per_unit_cost_basis [String, nil]
|
715
661
|
end
|
716
662
|
|
717
|
-
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
663
|
+
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiry#customer
|
718
664
|
class Customer < Orb::Internal::Type::BaseModel
|
719
665
|
# @!attribute id
|
720
666
|
#
|
@@ -726,31 +672,24 @@ module Orb
|
|
726
672
|
# @return [String, nil]
|
727
673
|
required :external_customer_id, String, nil?: true
|
728
674
|
|
729
|
-
# @!
|
730
|
-
#
|
731
|
-
#
|
732
|
-
# #
|
733
|
-
# def initialize(id:, external_customer_id:, **) = super
|
734
|
-
|
735
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
675
|
+
# @!method initialize(id:, external_customer_id:)
|
676
|
+
# @param id [String]
|
677
|
+
# @param external_customer_id [String, nil]
|
736
678
|
end
|
737
679
|
|
738
|
-
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
680
|
+
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiry#entry_status
|
739
681
|
module EntryStatus
|
740
682
|
extend Orb::Internal::Type::Enum
|
741
683
|
|
742
684
|
COMMITTED = :committed
|
743
685
|
PENDING = :pending
|
744
686
|
|
745
|
-
|
746
|
-
|
747
|
-
# @!parse
|
748
|
-
# # @return [Array<Symbol>]
|
749
|
-
# def self.values; end
|
687
|
+
# @!method self.values
|
688
|
+
# @return [Array<Symbol>]
|
750
689
|
end
|
751
690
|
end
|
752
691
|
|
753
|
-
class
|
692
|
+
class Void < Orb::Internal::Type::BaseModel
|
754
693
|
# @!attribute id
|
755
694
|
#
|
756
695
|
# @return [String]
|
@@ -768,9 +707,9 @@ module Orb
|
|
768
707
|
|
769
708
|
# @!attribute credit_block
|
770
709
|
#
|
771
|
-
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
710
|
+
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Void::CreditBlock]
|
772
711
|
required :credit_block,
|
773
|
-
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
712
|
+
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Void::CreditBlock }
|
774
713
|
|
775
714
|
# @!attribute currency
|
776
715
|
#
|
@@ -779,9 +718,9 @@ module Orb
|
|
779
718
|
|
780
719
|
# @!attribute customer
|
781
720
|
#
|
782
|
-
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
721
|
+
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Void::Customer]
|
783
722
|
required :customer,
|
784
|
-
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
723
|
+
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Void::Customer }
|
785
724
|
|
786
725
|
# @!attribute description
|
787
726
|
#
|
@@ -795,9 +734,9 @@ module Orb
|
|
795
734
|
|
796
735
|
# @!attribute entry_status
|
797
736
|
#
|
798
|
-
# @return [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
737
|
+
# @return [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Void::EntryStatus]
|
799
738
|
required :entry_status,
|
800
|
-
enum: -> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
739
|
+
enum: -> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Void::EntryStatus }
|
801
740
|
|
802
741
|
# @!attribute entry_type
|
803
742
|
#
|
@@ -833,47 +772,43 @@ module Orb
|
|
833
772
|
# @return [String, nil]
|
834
773
|
required :void_reason, String, nil?: true
|
835
774
|
|
836
|
-
# @!
|
837
|
-
#
|
838
|
-
#
|
839
|
-
#
|
840
|
-
#
|
841
|
-
#
|
842
|
-
#
|
843
|
-
#
|
844
|
-
#
|
845
|
-
#
|
846
|
-
#
|
847
|
-
#
|
848
|
-
#
|
849
|
-
#
|
850
|
-
#
|
851
|
-
#
|
852
|
-
#
|
853
|
-
#
|
854
|
-
#
|
855
|
-
#
|
856
|
-
#
|
857
|
-
#
|
858
|
-
#
|
859
|
-
#
|
860
|
-
#
|
861
|
-
#
|
862
|
-
#
|
863
|
-
#
|
864
|
-
#
|
865
|
-
#
|
866
|
-
#
|
867
|
-
#
|
868
|
-
#
|
869
|
-
#
|
870
|
-
#
|
871
|
-
|
872
|
-
#
|
873
|
-
|
874
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
875
|
-
|
876
|
-
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry#credit_block
|
775
|
+
# @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, void_amount:, void_reason:, entry_type: :void)
|
776
|
+
# Some parameter documentations has been truncated, see
|
777
|
+
# {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Void}
|
778
|
+
# for more details.
|
779
|
+
#
|
780
|
+
# @param id [String]
|
781
|
+
#
|
782
|
+
# @param amount [Float]
|
783
|
+
#
|
784
|
+
# @param created_at [Time]
|
785
|
+
#
|
786
|
+
# @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Void::CreditBlock]
|
787
|
+
#
|
788
|
+
# @param currency [String]
|
789
|
+
#
|
790
|
+
# @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Void::Customer]
|
791
|
+
#
|
792
|
+
# @param description [String, nil]
|
793
|
+
#
|
794
|
+
# @param ending_balance [Float]
|
795
|
+
#
|
796
|
+
# @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Void::EntryStatus]
|
797
|
+
#
|
798
|
+
# @param ledger_sequence_number [Integer]
|
799
|
+
#
|
800
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
801
|
+
# ...
|
802
|
+
#
|
803
|
+
# @param starting_balance [Float]
|
804
|
+
#
|
805
|
+
# @param void_amount [Float]
|
806
|
+
#
|
807
|
+
# @param void_reason [String, nil]
|
808
|
+
#
|
809
|
+
# @param entry_type [Symbol, :void]
|
810
|
+
|
811
|
+
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Void#credit_block
|
877
812
|
class CreditBlock < Orb::Internal::Type::BaseModel
|
878
813
|
# @!attribute id
|
879
814
|
#
|
@@ -890,17 +825,13 @@ module Orb
|
|
890
825
|
# @return [String, nil]
|
891
826
|
required :per_unit_cost_basis, String, nil?: true
|
892
827
|
|
893
|
-
# @!
|
894
|
-
#
|
895
|
-
#
|
896
|
-
#
|
897
|
-
# #
|
898
|
-
# def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
|
899
|
-
|
900
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
828
|
+
# @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
|
829
|
+
# @param id [String]
|
830
|
+
# @param expiry_date [Time, nil]
|
831
|
+
# @param per_unit_cost_basis [String, nil]
|
901
832
|
end
|
902
833
|
|
903
|
-
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
834
|
+
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Void#customer
|
904
835
|
class Customer < Orb::Internal::Type::BaseModel
|
905
836
|
# @!attribute id
|
906
837
|
#
|
@@ -912,31 +843,24 @@ module Orb
|
|
912
843
|
# @return [String, nil]
|
913
844
|
required :external_customer_id, String, nil?: true
|
914
845
|
|
915
|
-
# @!
|
916
|
-
#
|
917
|
-
#
|
918
|
-
# #
|
919
|
-
# def initialize(id:, external_customer_id:, **) = super
|
920
|
-
|
921
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
846
|
+
# @!method initialize(id:, external_customer_id:)
|
847
|
+
# @param id [String]
|
848
|
+
# @param external_customer_id [String, nil]
|
922
849
|
end
|
923
850
|
|
924
|
-
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
851
|
+
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Void#entry_status
|
925
852
|
module EntryStatus
|
926
853
|
extend Orb::Internal::Type::Enum
|
927
854
|
|
928
855
|
COMMITTED = :committed
|
929
856
|
PENDING = :pending
|
930
857
|
|
931
|
-
|
932
|
-
|
933
|
-
# @!parse
|
934
|
-
# # @return [Array<Symbol>]
|
935
|
-
# def self.values; end
|
858
|
+
# @!method self.values
|
859
|
+
# @return [Array<Symbol>]
|
936
860
|
end
|
937
861
|
end
|
938
862
|
|
939
|
-
class
|
863
|
+
class VoidInitiated < Orb::Internal::Type::BaseModel
|
940
864
|
# @!attribute id
|
941
865
|
#
|
942
866
|
# @return [String]
|
@@ -954,9 +878,9 @@ module Orb
|
|
954
878
|
|
955
879
|
# @!attribute credit_block
|
956
880
|
#
|
957
|
-
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
881
|
+
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiated::CreditBlock]
|
958
882
|
required :credit_block,
|
959
|
-
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
883
|
+
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiated::CreditBlock }
|
960
884
|
|
961
885
|
# @!attribute currency
|
962
886
|
#
|
@@ -965,9 +889,9 @@ module Orb
|
|
965
889
|
|
966
890
|
# @!attribute customer
|
967
891
|
#
|
968
|
-
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
892
|
+
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiated::Customer]
|
969
893
|
required :customer,
|
970
|
-
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
894
|
+
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiated::Customer }
|
971
895
|
|
972
896
|
# @!attribute description
|
973
897
|
#
|
@@ -981,9 +905,9 @@ module Orb
|
|
981
905
|
|
982
906
|
# @!attribute entry_status
|
983
907
|
#
|
984
|
-
# @return [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
908
|
+
# @return [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiated::EntryStatus]
|
985
909
|
required :entry_status,
|
986
|
-
enum: -> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
910
|
+
enum: -> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiated::EntryStatus }
|
987
911
|
|
988
912
|
# @!attribute entry_type
|
989
913
|
#
|
@@ -1024,49 +948,45 @@ module Orb
|
|
1024
948
|
# @return [String, nil]
|
1025
949
|
required :void_reason, String, nil?: true
|
1026
950
|
|
1027
|
-
# @!
|
1028
|
-
#
|
1029
|
-
#
|
1030
|
-
#
|
1031
|
-
#
|
1032
|
-
#
|
1033
|
-
#
|
1034
|
-
#
|
1035
|
-
#
|
1036
|
-
#
|
1037
|
-
#
|
1038
|
-
#
|
1039
|
-
#
|
1040
|
-
#
|
1041
|
-
#
|
1042
|
-
#
|
1043
|
-
#
|
1044
|
-
#
|
1045
|
-
#
|
1046
|
-
#
|
1047
|
-
#
|
1048
|
-
#
|
1049
|
-
#
|
1050
|
-
#
|
1051
|
-
#
|
1052
|
-
#
|
1053
|
-
#
|
1054
|
-
#
|
1055
|
-
#
|
1056
|
-
#
|
1057
|
-
#
|
1058
|
-
#
|
1059
|
-
#
|
1060
|
-
#
|
1061
|
-
#
|
1062
|
-
#
|
1063
|
-
#
|
1064
|
-
|
1065
|
-
#
|
1066
|
-
|
1067
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1068
|
-
|
1069
|
-
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry#credit_block
|
951
|
+
# @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, new_block_expiry_date:, starting_balance:, void_amount:, void_reason:, entry_type: :void_initiated)
|
952
|
+
# Some parameter documentations has been truncated, see
|
953
|
+
# {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiated}
|
954
|
+
# for more details.
|
955
|
+
#
|
956
|
+
# @param id [String]
|
957
|
+
#
|
958
|
+
# @param amount [Float]
|
959
|
+
#
|
960
|
+
# @param created_at [Time]
|
961
|
+
#
|
962
|
+
# @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiated::CreditBlock]
|
963
|
+
#
|
964
|
+
# @param currency [String]
|
965
|
+
#
|
966
|
+
# @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiated::Customer]
|
967
|
+
#
|
968
|
+
# @param description [String, nil]
|
969
|
+
#
|
970
|
+
# @param ending_balance [Float]
|
971
|
+
#
|
972
|
+
# @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiated::EntryStatus]
|
973
|
+
#
|
974
|
+
# @param ledger_sequence_number [Integer]
|
975
|
+
#
|
976
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
977
|
+
# ...
|
978
|
+
#
|
979
|
+
# @param new_block_expiry_date [Time]
|
980
|
+
#
|
981
|
+
# @param starting_balance [Float]
|
982
|
+
#
|
983
|
+
# @param void_amount [Float]
|
984
|
+
#
|
985
|
+
# @param void_reason [String, nil]
|
986
|
+
#
|
987
|
+
# @param entry_type [Symbol, :void_initiated]
|
988
|
+
|
989
|
+
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiated#credit_block
|
1070
990
|
class CreditBlock < Orb::Internal::Type::BaseModel
|
1071
991
|
# @!attribute id
|
1072
992
|
#
|
@@ -1083,17 +1003,13 @@ module Orb
|
|
1083
1003
|
# @return [String, nil]
|
1084
1004
|
required :per_unit_cost_basis, String, nil?: true
|
1085
1005
|
|
1086
|
-
# @!
|
1087
|
-
#
|
1088
|
-
#
|
1089
|
-
#
|
1090
|
-
# #
|
1091
|
-
# def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
|
1092
|
-
|
1093
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1006
|
+
# @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
|
1007
|
+
# @param id [String]
|
1008
|
+
# @param expiry_date [Time, nil]
|
1009
|
+
# @param per_unit_cost_basis [String, nil]
|
1094
1010
|
end
|
1095
1011
|
|
1096
|
-
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
1012
|
+
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiated#customer
|
1097
1013
|
class Customer < Orb::Internal::Type::BaseModel
|
1098
1014
|
# @!attribute id
|
1099
1015
|
#
|
@@ -1105,31 +1021,24 @@ module Orb
|
|
1105
1021
|
# @return [String, nil]
|
1106
1022
|
required :external_customer_id, String, nil?: true
|
1107
1023
|
|
1108
|
-
# @!
|
1109
|
-
#
|
1110
|
-
#
|
1111
|
-
# #
|
1112
|
-
# def initialize(id:, external_customer_id:, **) = super
|
1113
|
-
|
1114
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1024
|
+
# @!method initialize(id:, external_customer_id:)
|
1025
|
+
# @param id [String]
|
1026
|
+
# @param external_customer_id [String, nil]
|
1115
1027
|
end
|
1116
1028
|
|
1117
|
-
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
1029
|
+
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiated#entry_status
|
1118
1030
|
module EntryStatus
|
1119
1031
|
extend Orb::Internal::Type::Enum
|
1120
1032
|
|
1121
1033
|
COMMITTED = :committed
|
1122
1034
|
PENDING = :pending
|
1123
1035
|
|
1124
|
-
|
1125
|
-
|
1126
|
-
# @!parse
|
1127
|
-
# # @return [Array<Symbol>]
|
1128
|
-
# def self.values; end
|
1036
|
+
# @!method self.values
|
1037
|
+
# @return [Array<Symbol>]
|
1129
1038
|
end
|
1130
1039
|
end
|
1131
1040
|
|
1132
|
-
class
|
1041
|
+
class Amendment < Orb::Internal::Type::BaseModel
|
1133
1042
|
# @!attribute id
|
1134
1043
|
#
|
1135
1044
|
# @return [String]
|
@@ -1147,9 +1056,9 @@ module Orb
|
|
1147
1056
|
|
1148
1057
|
# @!attribute credit_block
|
1149
1058
|
#
|
1150
|
-
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
1059
|
+
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Amendment::CreditBlock]
|
1151
1060
|
required :credit_block,
|
1152
|
-
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
1061
|
+
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Amendment::CreditBlock }
|
1153
1062
|
|
1154
1063
|
# @!attribute currency
|
1155
1064
|
#
|
@@ -1158,9 +1067,9 @@ module Orb
|
|
1158
1067
|
|
1159
1068
|
# @!attribute customer
|
1160
1069
|
#
|
1161
|
-
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
1070
|
+
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Amendment::Customer]
|
1162
1071
|
required :customer,
|
1163
|
-
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
1072
|
+
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Amendment::Customer }
|
1164
1073
|
|
1165
1074
|
# @!attribute description
|
1166
1075
|
#
|
@@ -1174,9 +1083,9 @@ module Orb
|
|
1174
1083
|
|
1175
1084
|
# @!attribute entry_status
|
1176
1085
|
#
|
1177
|
-
# @return [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
1086
|
+
# @return [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Amendment::EntryStatus]
|
1178
1087
|
required :entry_status,
|
1179
|
-
enum: -> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
1088
|
+
enum: -> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Amendment::EntryStatus }
|
1180
1089
|
|
1181
1090
|
# @!attribute entry_type
|
1182
1091
|
#
|
@@ -1202,43 +1111,39 @@ module Orb
|
|
1202
1111
|
# @return [Float]
|
1203
1112
|
required :starting_balance, Float
|
1204
1113
|
|
1205
|
-
# @!
|
1206
|
-
#
|
1207
|
-
#
|
1208
|
-
#
|
1209
|
-
#
|
1210
|
-
#
|
1211
|
-
#
|
1212
|
-
#
|
1213
|
-
#
|
1214
|
-
#
|
1215
|
-
#
|
1216
|
-
#
|
1217
|
-
#
|
1218
|
-
#
|
1219
|
-
#
|
1220
|
-
#
|
1221
|
-
#
|
1222
|
-
#
|
1223
|
-
#
|
1224
|
-
#
|
1225
|
-
#
|
1226
|
-
#
|
1227
|
-
#
|
1228
|
-
#
|
1229
|
-
#
|
1230
|
-
#
|
1231
|
-
#
|
1232
|
-
#
|
1233
|
-
#
|
1234
|
-
#
|
1235
|
-
#
|
1236
|
-
|
1237
|
-
#
|
1238
|
-
|
1239
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1240
|
-
|
1241
|
-
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry#credit_block
|
1114
|
+
# @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :amendment)
|
1115
|
+
# Some parameter documentations has been truncated, see
|
1116
|
+
# {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Amendment}
|
1117
|
+
# for more details.
|
1118
|
+
#
|
1119
|
+
# @param id [String]
|
1120
|
+
#
|
1121
|
+
# @param amount [Float]
|
1122
|
+
#
|
1123
|
+
# @param created_at [Time]
|
1124
|
+
#
|
1125
|
+
# @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Amendment::CreditBlock]
|
1126
|
+
#
|
1127
|
+
# @param currency [String]
|
1128
|
+
#
|
1129
|
+
# @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Amendment::Customer]
|
1130
|
+
#
|
1131
|
+
# @param description [String, nil]
|
1132
|
+
#
|
1133
|
+
# @param ending_balance [Float]
|
1134
|
+
#
|
1135
|
+
# @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Amendment::EntryStatus]
|
1136
|
+
#
|
1137
|
+
# @param ledger_sequence_number [Integer]
|
1138
|
+
#
|
1139
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
1140
|
+
# ...
|
1141
|
+
#
|
1142
|
+
# @param starting_balance [Float]
|
1143
|
+
#
|
1144
|
+
# @param entry_type [Symbol, :amendment]
|
1145
|
+
|
1146
|
+
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Amendment#credit_block
|
1242
1147
|
class CreditBlock < Orb::Internal::Type::BaseModel
|
1243
1148
|
# @!attribute id
|
1244
1149
|
#
|
@@ -1255,17 +1160,13 @@ module Orb
|
|
1255
1160
|
# @return [String, nil]
|
1256
1161
|
required :per_unit_cost_basis, String, nil?: true
|
1257
1162
|
|
1258
|
-
# @!
|
1259
|
-
#
|
1260
|
-
#
|
1261
|
-
#
|
1262
|
-
# #
|
1263
|
-
# def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
|
1264
|
-
|
1265
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1163
|
+
# @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
|
1164
|
+
# @param id [String]
|
1165
|
+
# @param expiry_date [Time, nil]
|
1166
|
+
# @param per_unit_cost_basis [String, nil]
|
1266
1167
|
end
|
1267
1168
|
|
1268
|
-
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
1169
|
+
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Amendment#customer
|
1269
1170
|
class Customer < Orb::Internal::Type::BaseModel
|
1270
1171
|
# @!attribute id
|
1271
1172
|
#
|
@@ -1277,33 +1178,25 @@ module Orb
|
|
1277
1178
|
# @return [String, nil]
|
1278
1179
|
required :external_customer_id, String, nil?: true
|
1279
1180
|
|
1280
|
-
# @!
|
1281
|
-
#
|
1282
|
-
#
|
1283
|
-
# #
|
1284
|
-
# def initialize(id:, external_customer_id:, **) = super
|
1285
|
-
|
1286
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1181
|
+
# @!method initialize(id:, external_customer_id:)
|
1182
|
+
# @param id [String]
|
1183
|
+
# @param external_customer_id [String, nil]
|
1287
1184
|
end
|
1288
1185
|
|
1289
|
-
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
1186
|
+
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Amendment#entry_status
|
1290
1187
|
module EntryStatus
|
1291
1188
|
extend Orb::Internal::Type::Enum
|
1292
1189
|
|
1293
1190
|
COMMITTED = :committed
|
1294
1191
|
PENDING = :pending
|
1295
1192
|
|
1296
|
-
|
1297
|
-
|
1298
|
-
# @!parse
|
1299
|
-
# # @return [Array<Symbol>]
|
1300
|
-
# def self.values; end
|
1193
|
+
# @!method self.values
|
1194
|
+
# @return [Array<Symbol>]
|
1301
1195
|
end
|
1302
1196
|
end
|
1303
1197
|
|
1304
|
-
# @!
|
1305
|
-
#
|
1306
|
-
# def self.variants; end
|
1198
|
+
# @!method self.variants
|
1199
|
+
# @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)]
|
1307
1200
|
end
|
1308
1201
|
end
|
1309
1202
|
end
|