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
@@ -13,27 +13,24 @@ module Orb
|
|
13
13
|
|
14
14
|
discriminator :entry_type
|
15
15
|
|
16
|
-
variant :increment,
|
17
|
-
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry }
|
16
|
+
variant :increment, -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Increment }
|
18
17
|
|
19
|
-
variant :decrement,
|
20
|
-
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry }
|
18
|
+
variant :decrement, -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Decrement }
|
21
19
|
|
22
20
|
variant :expiration_change,
|
23
|
-
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
21
|
+
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChange }
|
24
22
|
|
25
23
|
variant :credit_block_expiry,
|
26
|
-
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
24
|
+
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiry }
|
27
25
|
|
28
|
-
variant :void, -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
26
|
+
variant :void, -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Void }
|
29
27
|
|
30
28
|
variant :void_initiated,
|
31
|
-
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
29
|
+
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiated }
|
32
30
|
|
33
|
-
variant :amendment,
|
34
|
-
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry }
|
31
|
+
variant :amendment, -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Amendment }
|
35
32
|
|
36
|
-
class
|
33
|
+
class Increment < Orb::Internal::Type::BaseModel
|
37
34
|
# @!attribute id
|
38
35
|
#
|
39
36
|
# @return [String]
|
@@ -51,9 +48,9 @@ module Orb
|
|
51
48
|
|
52
49
|
# @!attribute credit_block
|
53
50
|
#
|
54
|
-
# @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
51
|
+
# @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Increment::CreditBlock]
|
55
52
|
required :credit_block,
|
56
|
-
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
53
|
+
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Increment::CreditBlock }
|
57
54
|
|
58
55
|
# @!attribute currency
|
59
56
|
#
|
@@ -62,9 +59,9 @@ module Orb
|
|
62
59
|
|
63
60
|
# @!attribute customer
|
64
61
|
#
|
65
|
-
# @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
62
|
+
# @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Increment::Customer]
|
66
63
|
required :customer,
|
67
|
-
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
64
|
+
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Increment::Customer }
|
68
65
|
|
69
66
|
# @!attribute description
|
70
67
|
#
|
@@ -78,9 +75,9 @@ module Orb
|
|
78
75
|
|
79
76
|
# @!attribute entry_status
|
80
77
|
#
|
81
|
-
# @return [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
78
|
+
# @return [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Increment::EntryStatus]
|
82
79
|
required :entry_status,
|
83
|
-
enum: -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
80
|
+
enum: -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Increment::EntryStatus }
|
84
81
|
|
85
82
|
# @!attribute entry_type
|
86
83
|
#
|
@@ -106,43 +103,39 @@ module Orb
|
|
106
103
|
# @return [Float]
|
107
104
|
required :starting_balance, Float
|
108
105
|
|
109
|
-
# @!
|
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
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
144
|
-
|
145
|
-
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry#credit_block
|
106
|
+
# @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :increment)
|
107
|
+
# Some parameter documentations has been truncated, see
|
108
|
+
# {Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Increment} for
|
109
|
+
# more details.
|
110
|
+
#
|
111
|
+
# @param id [String]
|
112
|
+
#
|
113
|
+
# @param amount [Float]
|
114
|
+
#
|
115
|
+
# @param created_at [Time]
|
116
|
+
#
|
117
|
+
# @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Increment::CreditBlock]
|
118
|
+
#
|
119
|
+
# @param currency [String]
|
120
|
+
#
|
121
|
+
# @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Increment::Customer]
|
122
|
+
#
|
123
|
+
# @param description [String, nil]
|
124
|
+
#
|
125
|
+
# @param ending_balance [Float]
|
126
|
+
#
|
127
|
+
# @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Increment::EntryStatus]
|
128
|
+
#
|
129
|
+
# @param ledger_sequence_number [Integer]
|
130
|
+
#
|
131
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
132
|
+
# ...
|
133
|
+
#
|
134
|
+
# @param starting_balance [Float]
|
135
|
+
#
|
136
|
+
# @param entry_type [Symbol, :increment]
|
137
|
+
|
138
|
+
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Increment#credit_block
|
146
139
|
class CreditBlock < Orb::Internal::Type::BaseModel
|
147
140
|
# @!attribute id
|
148
141
|
#
|
@@ -159,17 +152,13 @@ module Orb
|
|
159
152
|
# @return [String, nil]
|
160
153
|
required :per_unit_cost_basis, String, nil?: true
|
161
154
|
|
162
|
-
# @!
|
163
|
-
#
|
164
|
-
#
|
165
|
-
#
|
166
|
-
# #
|
167
|
-
# def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
|
168
|
-
|
169
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
155
|
+
# @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
|
156
|
+
# @param id [String]
|
157
|
+
# @param expiry_date [Time, nil]
|
158
|
+
# @param per_unit_cost_basis [String, nil]
|
170
159
|
end
|
171
160
|
|
172
|
-
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
161
|
+
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Increment#customer
|
173
162
|
class Customer < Orb::Internal::Type::BaseModel
|
174
163
|
# @!attribute id
|
175
164
|
#
|
@@ -181,31 +170,24 @@ module Orb
|
|
181
170
|
# @return [String, nil]
|
182
171
|
required :external_customer_id, String, nil?: true
|
183
172
|
|
184
|
-
# @!
|
185
|
-
#
|
186
|
-
#
|
187
|
-
# #
|
188
|
-
# def initialize(id:, external_customer_id:, **) = super
|
189
|
-
|
190
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
173
|
+
# @!method initialize(id:, external_customer_id:)
|
174
|
+
# @param id [String]
|
175
|
+
# @param external_customer_id [String, nil]
|
191
176
|
end
|
192
177
|
|
193
|
-
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
178
|
+
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Increment#entry_status
|
194
179
|
module EntryStatus
|
195
180
|
extend Orb::Internal::Type::Enum
|
196
181
|
|
197
182
|
COMMITTED = :committed
|
198
183
|
PENDING = :pending
|
199
184
|
|
200
|
-
|
201
|
-
|
202
|
-
# @!parse
|
203
|
-
# # @return [Array<Symbol>]
|
204
|
-
# def self.values; end
|
185
|
+
# @!method self.values
|
186
|
+
# @return [Array<Symbol>]
|
205
187
|
end
|
206
188
|
end
|
207
189
|
|
208
|
-
class
|
190
|
+
class Decrement < Orb::Internal::Type::BaseModel
|
209
191
|
# @!attribute id
|
210
192
|
#
|
211
193
|
# @return [String]
|
@@ -223,9 +205,9 @@ module Orb
|
|
223
205
|
|
224
206
|
# @!attribute credit_block
|
225
207
|
#
|
226
|
-
# @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
208
|
+
# @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Decrement::CreditBlock]
|
227
209
|
required :credit_block,
|
228
|
-
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
210
|
+
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Decrement::CreditBlock }
|
229
211
|
|
230
212
|
# @!attribute currency
|
231
213
|
#
|
@@ -234,9 +216,9 @@ module Orb
|
|
234
216
|
|
235
217
|
# @!attribute customer
|
236
218
|
#
|
237
|
-
# @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
219
|
+
# @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Decrement::Customer]
|
238
220
|
required :customer,
|
239
|
-
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
221
|
+
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Decrement::Customer }
|
240
222
|
|
241
223
|
# @!attribute description
|
242
224
|
#
|
@@ -250,9 +232,9 @@ module Orb
|
|
250
232
|
|
251
233
|
# @!attribute entry_status
|
252
234
|
#
|
253
|
-
# @return [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
235
|
+
# @return [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Decrement::EntryStatus]
|
254
236
|
required :entry_status,
|
255
|
-
enum: -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
237
|
+
enum: -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Decrement::EntryStatus }
|
256
238
|
|
257
239
|
# @!attribute entry_type
|
258
240
|
#
|
@@ -293,49 +275,45 @@ module Orb
|
|
293
275
|
# @return [String, nil]
|
294
276
|
optional :price_id, String, nil?: true
|
295
277
|
|
296
|
-
# @!
|
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
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
337
|
-
|
338
|
-
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry#credit_block
|
278
|
+
# @!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)
|
279
|
+
# Some parameter documentations has been truncated, see
|
280
|
+
# {Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Decrement} for
|
281
|
+
# more details.
|
282
|
+
#
|
283
|
+
# @param id [String]
|
284
|
+
#
|
285
|
+
# @param amount [Float]
|
286
|
+
#
|
287
|
+
# @param created_at [Time]
|
288
|
+
#
|
289
|
+
# @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Decrement::CreditBlock]
|
290
|
+
#
|
291
|
+
# @param currency [String]
|
292
|
+
#
|
293
|
+
# @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Decrement::Customer]
|
294
|
+
#
|
295
|
+
# @param description [String, nil]
|
296
|
+
#
|
297
|
+
# @param ending_balance [Float]
|
298
|
+
#
|
299
|
+
# @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Decrement::EntryStatus]
|
300
|
+
#
|
301
|
+
# @param ledger_sequence_number [Integer]
|
302
|
+
#
|
303
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
304
|
+
# ...
|
305
|
+
#
|
306
|
+
# @param starting_balance [Float]
|
307
|
+
#
|
308
|
+
# @param event_id [String, nil]
|
309
|
+
#
|
310
|
+
# @param invoice_id [String, nil]
|
311
|
+
#
|
312
|
+
# @param price_id [String, nil]
|
313
|
+
#
|
314
|
+
# @param entry_type [Symbol, :decrement]
|
315
|
+
|
316
|
+
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Decrement#credit_block
|
339
317
|
class CreditBlock < Orb::Internal::Type::BaseModel
|
340
318
|
# @!attribute id
|
341
319
|
#
|
@@ -352,17 +330,13 @@ module Orb
|
|
352
330
|
# @return [String, nil]
|
353
331
|
required :per_unit_cost_basis, String, nil?: true
|
354
332
|
|
355
|
-
# @!
|
356
|
-
#
|
357
|
-
#
|
358
|
-
#
|
359
|
-
# #
|
360
|
-
# def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
|
361
|
-
|
362
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
333
|
+
# @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
|
334
|
+
# @param id [String]
|
335
|
+
# @param expiry_date [Time, nil]
|
336
|
+
# @param per_unit_cost_basis [String, nil]
|
363
337
|
end
|
364
338
|
|
365
|
-
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
339
|
+
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Decrement#customer
|
366
340
|
class Customer < Orb::Internal::Type::BaseModel
|
367
341
|
# @!attribute id
|
368
342
|
#
|
@@ -374,31 +348,24 @@ module Orb
|
|
374
348
|
# @return [String, nil]
|
375
349
|
required :external_customer_id, String, nil?: true
|
376
350
|
|
377
|
-
# @!
|
378
|
-
#
|
379
|
-
#
|
380
|
-
# #
|
381
|
-
# def initialize(id:, external_customer_id:, **) = super
|
382
|
-
|
383
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
351
|
+
# @!method initialize(id:, external_customer_id:)
|
352
|
+
# @param id [String]
|
353
|
+
# @param external_customer_id [String, nil]
|
384
354
|
end
|
385
355
|
|
386
|
-
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
356
|
+
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Decrement#entry_status
|
387
357
|
module EntryStatus
|
388
358
|
extend Orb::Internal::Type::Enum
|
389
359
|
|
390
360
|
COMMITTED = :committed
|
391
361
|
PENDING = :pending
|
392
362
|
|
393
|
-
|
394
|
-
|
395
|
-
# @!parse
|
396
|
-
# # @return [Array<Symbol>]
|
397
|
-
# def self.values; end
|
363
|
+
# @!method self.values
|
364
|
+
# @return [Array<Symbol>]
|
398
365
|
end
|
399
366
|
end
|
400
367
|
|
401
|
-
class
|
368
|
+
class ExpirationChange < Orb::Internal::Type::BaseModel
|
402
369
|
# @!attribute id
|
403
370
|
#
|
404
371
|
# @return [String]
|
@@ -416,9 +383,9 @@ module Orb
|
|
416
383
|
|
417
384
|
# @!attribute credit_block
|
418
385
|
#
|
419
|
-
# @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
386
|
+
# @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChange::CreditBlock]
|
420
387
|
required :credit_block,
|
421
|
-
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
388
|
+
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChange::CreditBlock }
|
422
389
|
|
423
390
|
# @!attribute currency
|
424
391
|
#
|
@@ -427,9 +394,9 @@ module Orb
|
|
427
394
|
|
428
395
|
# @!attribute customer
|
429
396
|
#
|
430
|
-
# @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
397
|
+
# @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChange::Customer]
|
431
398
|
required :customer,
|
432
|
-
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
399
|
+
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChange::Customer }
|
433
400
|
|
434
401
|
# @!attribute description
|
435
402
|
#
|
@@ -443,9 +410,9 @@ module Orb
|
|
443
410
|
|
444
411
|
# @!attribute entry_status
|
445
412
|
#
|
446
|
-
# @return [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
413
|
+
# @return [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChange::EntryStatus]
|
447
414
|
required :entry_status,
|
448
|
-
enum: -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
415
|
+
enum: -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChange::EntryStatus }
|
449
416
|
|
450
417
|
# @!attribute entry_type
|
451
418
|
#
|
@@ -476,45 +443,41 @@ module Orb
|
|
476
443
|
# @return [Float]
|
477
444
|
required :starting_balance, Float
|
478
445
|
|
479
|
-
# @!
|
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
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
516
|
-
|
517
|
-
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry#credit_block
|
446
|
+
# @!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)
|
447
|
+
# Some parameter documentations has been truncated, see
|
448
|
+
# {Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChange}
|
449
|
+
# for more details.
|
450
|
+
#
|
451
|
+
# @param id [String]
|
452
|
+
#
|
453
|
+
# @param amount [Float]
|
454
|
+
#
|
455
|
+
# @param created_at [Time]
|
456
|
+
#
|
457
|
+
# @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChange::CreditBlock]
|
458
|
+
#
|
459
|
+
# @param currency [String]
|
460
|
+
#
|
461
|
+
# @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChange::Customer]
|
462
|
+
#
|
463
|
+
# @param description [String, nil]
|
464
|
+
#
|
465
|
+
# @param ending_balance [Float]
|
466
|
+
#
|
467
|
+
# @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChange::EntryStatus]
|
468
|
+
#
|
469
|
+
# @param ledger_sequence_number [Integer]
|
470
|
+
#
|
471
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
472
|
+
# ...
|
473
|
+
#
|
474
|
+
# @param new_block_expiry_date [Time, nil]
|
475
|
+
#
|
476
|
+
# @param starting_balance [Float]
|
477
|
+
#
|
478
|
+
# @param entry_type [Symbol, :expiration_change]
|
479
|
+
|
480
|
+
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChange#credit_block
|
518
481
|
class CreditBlock < Orb::Internal::Type::BaseModel
|
519
482
|
# @!attribute id
|
520
483
|
#
|
@@ -531,17 +494,13 @@ module Orb
|
|
531
494
|
# @return [String, nil]
|
532
495
|
required :per_unit_cost_basis, String, nil?: true
|
533
496
|
|
534
|
-
# @!
|
535
|
-
#
|
536
|
-
#
|
537
|
-
#
|
538
|
-
# #
|
539
|
-
# def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
|
540
|
-
|
541
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
497
|
+
# @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
|
498
|
+
# @param id [String]
|
499
|
+
# @param expiry_date [Time, nil]
|
500
|
+
# @param per_unit_cost_basis [String, nil]
|
542
501
|
end
|
543
502
|
|
544
|
-
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
503
|
+
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChange#customer
|
545
504
|
class Customer < Orb::Internal::Type::BaseModel
|
546
505
|
# @!attribute id
|
547
506
|
#
|
@@ -553,31 +512,24 @@ module Orb
|
|
553
512
|
# @return [String, nil]
|
554
513
|
required :external_customer_id, String, nil?: true
|
555
514
|
|
556
|
-
# @!
|
557
|
-
#
|
558
|
-
#
|
559
|
-
# #
|
560
|
-
# def initialize(id:, external_customer_id:, **) = super
|
561
|
-
|
562
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
515
|
+
# @!method initialize(id:, external_customer_id:)
|
516
|
+
# @param id [String]
|
517
|
+
# @param external_customer_id [String, nil]
|
563
518
|
end
|
564
519
|
|
565
|
-
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
520
|
+
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChange#entry_status
|
566
521
|
module EntryStatus
|
567
522
|
extend Orb::Internal::Type::Enum
|
568
523
|
|
569
524
|
COMMITTED = :committed
|
570
525
|
PENDING = :pending
|
571
526
|
|
572
|
-
|
573
|
-
|
574
|
-
# @!parse
|
575
|
-
# # @return [Array<Symbol>]
|
576
|
-
# def self.values; end
|
527
|
+
# @!method self.values
|
528
|
+
# @return [Array<Symbol>]
|
577
529
|
end
|
578
530
|
end
|
579
531
|
|
580
|
-
class
|
532
|
+
class CreditBlockExpiry < Orb::Internal::Type::BaseModel
|
581
533
|
# @!attribute id
|
582
534
|
#
|
583
535
|
# @return [String]
|
@@ -595,9 +547,9 @@ module Orb
|
|
595
547
|
|
596
548
|
# @!attribute credit_block
|
597
549
|
#
|
598
|
-
# @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
550
|
+
# @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiry::CreditBlock]
|
599
551
|
required :credit_block,
|
600
|
-
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
552
|
+
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiry::CreditBlock }
|
601
553
|
|
602
554
|
# @!attribute currency
|
603
555
|
#
|
@@ -606,9 +558,9 @@ module Orb
|
|
606
558
|
|
607
559
|
# @!attribute customer
|
608
560
|
#
|
609
|
-
# @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
561
|
+
# @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiry::Customer]
|
610
562
|
required :customer,
|
611
|
-
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
563
|
+
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiry::Customer }
|
612
564
|
|
613
565
|
# @!attribute description
|
614
566
|
#
|
@@ -622,9 +574,9 @@ module Orb
|
|
622
574
|
|
623
575
|
# @!attribute entry_status
|
624
576
|
#
|
625
|
-
# @return [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
577
|
+
# @return [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiry::EntryStatus]
|
626
578
|
required :entry_status,
|
627
|
-
enum: -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
579
|
+
enum: -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiry::EntryStatus }
|
628
580
|
|
629
581
|
# @!attribute entry_type
|
630
582
|
#
|
@@ -650,43 +602,39 @@ module Orb
|
|
650
602
|
# @return [Float]
|
651
603
|
required :starting_balance, Float
|
652
604
|
|
653
|
-
# @!
|
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
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
688
|
-
|
689
|
-
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry#credit_block
|
605
|
+
# @!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)
|
606
|
+
# Some parameter documentations has been truncated, see
|
607
|
+
# {Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiry}
|
608
|
+
# for more details.
|
609
|
+
#
|
610
|
+
# @param id [String]
|
611
|
+
#
|
612
|
+
# @param amount [Float]
|
613
|
+
#
|
614
|
+
# @param created_at [Time]
|
615
|
+
#
|
616
|
+
# @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiry::CreditBlock]
|
617
|
+
#
|
618
|
+
# @param currency [String]
|
619
|
+
#
|
620
|
+
# @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiry::Customer]
|
621
|
+
#
|
622
|
+
# @param description [String, nil]
|
623
|
+
#
|
624
|
+
# @param ending_balance [Float]
|
625
|
+
#
|
626
|
+
# @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiry::EntryStatus]
|
627
|
+
#
|
628
|
+
# @param ledger_sequence_number [Integer]
|
629
|
+
#
|
630
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
631
|
+
# ...
|
632
|
+
#
|
633
|
+
# @param starting_balance [Float]
|
634
|
+
#
|
635
|
+
# @param entry_type [Symbol, :credit_block_expiry]
|
636
|
+
|
637
|
+
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiry#credit_block
|
690
638
|
class CreditBlock < Orb::Internal::Type::BaseModel
|
691
639
|
# @!attribute id
|
692
640
|
#
|
@@ -703,17 +651,13 @@ module Orb
|
|
703
651
|
# @return [String, nil]
|
704
652
|
required :per_unit_cost_basis, String, nil?: true
|
705
653
|
|
706
|
-
# @!
|
707
|
-
#
|
708
|
-
#
|
709
|
-
#
|
710
|
-
# #
|
711
|
-
# def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
|
712
|
-
|
713
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
654
|
+
# @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
|
655
|
+
# @param id [String]
|
656
|
+
# @param expiry_date [Time, nil]
|
657
|
+
# @param per_unit_cost_basis [String, nil]
|
714
658
|
end
|
715
659
|
|
716
|
-
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
660
|
+
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiry#customer
|
717
661
|
class Customer < Orb::Internal::Type::BaseModel
|
718
662
|
# @!attribute id
|
719
663
|
#
|
@@ -725,31 +669,24 @@ module Orb
|
|
725
669
|
# @return [String, nil]
|
726
670
|
required :external_customer_id, String, nil?: true
|
727
671
|
|
728
|
-
# @!
|
729
|
-
#
|
730
|
-
#
|
731
|
-
# #
|
732
|
-
# def initialize(id:, external_customer_id:, **) = super
|
733
|
-
|
734
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
672
|
+
# @!method initialize(id:, external_customer_id:)
|
673
|
+
# @param id [String]
|
674
|
+
# @param external_customer_id [String, nil]
|
735
675
|
end
|
736
676
|
|
737
|
-
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
677
|
+
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiry#entry_status
|
738
678
|
module EntryStatus
|
739
679
|
extend Orb::Internal::Type::Enum
|
740
680
|
|
741
681
|
COMMITTED = :committed
|
742
682
|
PENDING = :pending
|
743
683
|
|
744
|
-
|
745
|
-
|
746
|
-
# @!parse
|
747
|
-
# # @return [Array<Symbol>]
|
748
|
-
# def self.values; end
|
684
|
+
# @!method self.values
|
685
|
+
# @return [Array<Symbol>]
|
749
686
|
end
|
750
687
|
end
|
751
688
|
|
752
|
-
class
|
689
|
+
class Void < Orb::Internal::Type::BaseModel
|
753
690
|
# @!attribute id
|
754
691
|
#
|
755
692
|
# @return [String]
|
@@ -767,9 +704,9 @@ module Orb
|
|
767
704
|
|
768
705
|
# @!attribute credit_block
|
769
706
|
#
|
770
|
-
# @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
707
|
+
# @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Void::CreditBlock]
|
771
708
|
required :credit_block,
|
772
|
-
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
709
|
+
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Void::CreditBlock }
|
773
710
|
|
774
711
|
# @!attribute currency
|
775
712
|
#
|
@@ -778,9 +715,8 @@ module Orb
|
|
778
715
|
|
779
716
|
# @!attribute customer
|
780
717
|
#
|
781
|
-
# @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
782
|
-
required :customer,
|
783
|
-
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::Customer }
|
718
|
+
# @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Void::Customer]
|
719
|
+
required :customer, -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Void::Customer }
|
784
720
|
|
785
721
|
# @!attribute description
|
786
722
|
#
|
@@ -794,9 +730,9 @@ module Orb
|
|
794
730
|
|
795
731
|
# @!attribute entry_status
|
796
732
|
#
|
797
|
-
# @return [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
733
|
+
# @return [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Void::EntryStatus]
|
798
734
|
required :entry_status,
|
799
|
-
enum: -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
735
|
+
enum: -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Void::EntryStatus }
|
800
736
|
|
801
737
|
# @!attribute entry_type
|
802
738
|
#
|
@@ -832,47 +768,43 @@ module Orb
|
|
832
768
|
# @return [String, nil]
|
833
769
|
required :void_reason, String, nil?: true
|
834
770
|
|
835
|
-
# @!
|
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
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
874
|
-
|
875
|
-
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry#credit_block
|
771
|
+
# @!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)
|
772
|
+
# Some parameter documentations has been truncated, see
|
773
|
+
# {Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Void} for more
|
774
|
+
# details.
|
775
|
+
#
|
776
|
+
# @param id [String]
|
777
|
+
#
|
778
|
+
# @param amount [Float]
|
779
|
+
#
|
780
|
+
# @param created_at [Time]
|
781
|
+
#
|
782
|
+
# @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Void::CreditBlock]
|
783
|
+
#
|
784
|
+
# @param currency [String]
|
785
|
+
#
|
786
|
+
# @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Void::Customer]
|
787
|
+
#
|
788
|
+
# @param description [String, nil]
|
789
|
+
#
|
790
|
+
# @param ending_balance [Float]
|
791
|
+
#
|
792
|
+
# @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Void::EntryStatus]
|
793
|
+
#
|
794
|
+
# @param ledger_sequence_number [Integer]
|
795
|
+
#
|
796
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
797
|
+
# ...
|
798
|
+
#
|
799
|
+
# @param starting_balance [Float]
|
800
|
+
#
|
801
|
+
# @param void_amount [Float]
|
802
|
+
#
|
803
|
+
# @param void_reason [String, nil]
|
804
|
+
#
|
805
|
+
# @param entry_type [Symbol, :void]
|
806
|
+
|
807
|
+
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Void#credit_block
|
876
808
|
class CreditBlock < Orb::Internal::Type::BaseModel
|
877
809
|
# @!attribute id
|
878
810
|
#
|
@@ -889,17 +821,13 @@ module Orb
|
|
889
821
|
# @return [String, nil]
|
890
822
|
required :per_unit_cost_basis, String, nil?: true
|
891
823
|
|
892
|
-
# @!
|
893
|
-
#
|
894
|
-
#
|
895
|
-
#
|
896
|
-
# #
|
897
|
-
# def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
|
898
|
-
|
899
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
824
|
+
# @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
|
825
|
+
# @param id [String]
|
826
|
+
# @param expiry_date [Time, nil]
|
827
|
+
# @param per_unit_cost_basis [String, nil]
|
900
828
|
end
|
901
829
|
|
902
|
-
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
830
|
+
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Void#customer
|
903
831
|
class Customer < Orb::Internal::Type::BaseModel
|
904
832
|
# @!attribute id
|
905
833
|
#
|
@@ -911,31 +839,24 @@ module Orb
|
|
911
839
|
# @return [String, nil]
|
912
840
|
required :external_customer_id, String, nil?: true
|
913
841
|
|
914
|
-
# @!
|
915
|
-
#
|
916
|
-
#
|
917
|
-
# #
|
918
|
-
# def initialize(id:, external_customer_id:, **) = super
|
919
|
-
|
920
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
842
|
+
# @!method initialize(id:, external_customer_id:)
|
843
|
+
# @param id [String]
|
844
|
+
# @param external_customer_id [String, nil]
|
921
845
|
end
|
922
846
|
|
923
|
-
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
847
|
+
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Void#entry_status
|
924
848
|
module EntryStatus
|
925
849
|
extend Orb::Internal::Type::Enum
|
926
850
|
|
927
851
|
COMMITTED = :committed
|
928
852
|
PENDING = :pending
|
929
853
|
|
930
|
-
|
931
|
-
|
932
|
-
# @!parse
|
933
|
-
# # @return [Array<Symbol>]
|
934
|
-
# def self.values; end
|
854
|
+
# @!method self.values
|
855
|
+
# @return [Array<Symbol>]
|
935
856
|
end
|
936
857
|
end
|
937
858
|
|
938
|
-
class
|
859
|
+
class VoidInitiated < Orb::Internal::Type::BaseModel
|
939
860
|
# @!attribute id
|
940
861
|
#
|
941
862
|
# @return [String]
|
@@ -953,9 +874,9 @@ module Orb
|
|
953
874
|
|
954
875
|
# @!attribute credit_block
|
955
876
|
#
|
956
|
-
# @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
877
|
+
# @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiated::CreditBlock]
|
957
878
|
required :credit_block,
|
958
|
-
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
879
|
+
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiated::CreditBlock }
|
959
880
|
|
960
881
|
# @!attribute currency
|
961
882
|
#
|
@@ -964,9 +885,9 @@ module Orb
|
|
964
885
|
|
965
886
|
# @!attribute customer
|
966
887
|
#
|
967
|
-
# @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
888
|
+
# @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiated::Customer]
|
968
889
|
required :customer,
|
969
|
-
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
890
|
+
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiated::Customer }
|
970
891
|
|
971
892
|
# @!attribute description
|
972
893
|
#
|
@@ -980,9 +901,9 @@ module Orb
|
|
980
901
|
|
981
902
|
# @!attribute entry_status
|
982
903
|
#
|
983
|
-
# @return [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
904
|
+
# @return [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiated::EntryStatus]
|
984
905
|
required :entry_status,
|
985
|
-
enum: -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
906
|
+
enum: -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiated::EntryStatus }
|
986
907
|
|
987
908
|
# @!attribute entry_type
|
988
909
|
#
|
@@ -1023,49 +944,45 @@ module Orb
|
|
1023
944
|
# @return [String, nil]
|
1024
945
|
required :void_reason, String, nil?: true
|
1025
946
|
|
1026
|
-
# @!
|
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
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1067
|
-
|
1068
|
-
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry#credit_block
|
947
|
+
# @!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)
|
948
|
+
# Some parameter documentations has been truncated, see
|
949
|
+
# {Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiated}
|
950
|
+
# for more details.
|
951
|
+
#
|
952
|
+
# @param id [String]
|
953
|
+
#
|
954
|
+
# @param amount [Float]
|
955
|
+
#
|
956
|
+
# @param created_at [Time]
|
957
|
+
#
|
958
|
+
# @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiated::CreditBlock]
|
959
|
+
#
|
960
|
+
# @param currency [String]
|
961
|
+
#
|
962
|
+
# @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiated::Customer]
|
963
|
+
#
|
964
|
+
# @param description [String, nil]
|
965
|
+
#
|
966
|
+
# @param ending_balance [Float]
|
967
|
+
#
|
968
|
+
# @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiated::EntryStatus]
|
969
|
+
#
|
970
|
+
# @param ledger_sequence_number [Integer]
|
971
|
+
#
|
972
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
973
|
+
# ...
|
974
|
+
#
|
975
|
+
# @param new_block_expiry_date [Time]
|
976
|
+
#
|
977
|
+
# @param starting_balance [Float]
|
978
|
+
#
|
979
|
+
# @param void_amount [Float]
|
980
|
+
#
|
981
|
+
# @param void_reason [String, nil]
|
982
|
+
#
|
983
|
+
# @param entry_type [Symbol, :void_initiated]
|
984
|
+
|
985
|
+
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiated#credit_block
|
1069
986
|
class CreditBlock < Orb::Internal::Type::BaseModel
|
1070
987
|
# @!attribute id
|
1071
988
|
#
|
@@ -1082,17 +999,13 @@ module Orb
|
|
1082
999
|
# @return [String, nil]
|
1083
1000
|
required :per_unit_cost_basis, String, nil?: true
|
1084
1001
|
|
1085
|
-
# @!
|
1086
|
-
#
|
1087
|
-
#
|
1088
|
-
#
|
1089
|
-
# #
|
1090
|
-
# def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
|
1091
|
-
|
1092
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1002
|
+
# @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
|
1003
|
+
# @param id [String]
|
1004
|
+
# @param expiry_date [Time, nil]
|
1005
|
+
# @param per_unit_cost_basis [String, nil]
|
1093
1006
|
end
|
1094
1007
|
|
1095
|
-
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
1008
|
+
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiated#customer
|
1096
1009
|
class Customer < Orb::Internal::Type::BaseModel
|
1097
1010
|
# @!attribute id
|
1098
1011
|
#
|
@@ -1104,31 +1017,24 @@ module Orb
|
|
1104
1017
|
# @return [String, nil]
|
1105
1018
|
required :external_customer_id, String, nil?: true
|
1106
1019
|
|
1107
|
-
# @!
|
1108
|
-
#
|
1109
|
-
#
|
1110
|
-
# #
|
1111
|
-
# def initialize(id:, external_customer_id:, **) = super
|
1112
|
-
|
1113
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1020
|
+
# @!method initialize(id:, external_customer_id:)
|
1021
|
+
# @param id [String]
|
1022
|
+
# @param external_customer_id [String, nil]
|
1114
1023
|
end
|
1115
1024
|
|
1116
|
-
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
1025
|
+
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiated#entry_status
|
1117
1026
|
module EntryStatus
|
1118
1027
|
extend Orb::Internal::Type::Enum
|
1119
1028
|
|
1120
1029
|
COMMITTED = :committed
|
1121
1030
|
PENDING = :pending
|
1122
1031
|
|
1123
|
-
|
1124
|
-
|
1125
|
-
# @!parse
|
1126
|
-
# # @return [Array<Symbol>]
|
1127
|
-
# def self.values; end
|
1032
|
+
# @!method self.values
|
1033
|
+
# @return [Array<Symbol>]
|
1128
1034
|
end
|
1129
1035
|
end
|
1130
1036
|
|
1131
|
-
class
|
1037
|
+
class Amendment < Orb::Internal::Type::BaseModel
|
1132
1038
|
# @!attribute id
|
1133
1039
|
#
|
1134
1040
|
# @return [String]
|
@@ -1146,9 +1052,9 @@ module Orb
|
|
1146
1052
|
|
1147
1053
|
# @!attribute credit_block
|
1148
1054
|
#
|
1149
|
-
# @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
1055
|
+
# @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Amendment::CreditBlock]
|
1150
1056
|
required :credit_block,
|
1151
|
-
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
1057
|
+
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Amendment::CreditBlock }
|
1152
1058
|
|
1153
1059
|
# @!attribute currency
|
1154
1060
|
#
|
@@ -1157,9 +1063,9 @@ module Orb
|
|
1157
1063
|
|
1158
1064
|
# @!attribute customer
|
1159
1065
|
#
|
1160
|
-
# @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
1066
|
+
# @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Amendment::Customer]
|
1161
1067
|
required :customer,
|
1162
|
-
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
1068
|
+
-> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Amendment::Customer }
|
1163
1069
|
|
1164
1070
|
# @!attribute description
|
1165
1071
|
#
|
@@ -1173,9 +1079,9 @@ module Orb
|
|
1173
1079
|
|
1174
1080
|
# @!attribute entry_status
|
1175
1081
|
#
|
1176
|
-
# @return [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
1082
|
+
# @return [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Amendment::EntryStatus]
|
1177
1083
|
required :entry_status,
|
1178
|
-
enum: -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
1084
|
+
enum: -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Amendment::EntryStatus }
|
1179
1085
|
|
1180
1086
|
# @!attribute entry_type
|
1181
1087
|
#
|
@@ -1201,43 +1107,39 @@ module Orb
|
|
1201
1107
|
# @return [Float]
|
1202
1108
|
required :starting_balance, Float
|
1203
1109
|
|
1204
|
-
# @!
|
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
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1239
|
-
|
1240
|
-
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry#credit_block
|
1110
|
+
# @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :amendment)
|
1111
|
+
# Some parameter documentations has been truncated, see
|
1112
|
+
# {Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Amendment} for
|
1113
|
+
# more details.
|
1114
|
+
#
|
1115
|
+
# @param id [String]
|
1116
|
+
#
|
1117
|
+
# @param amount [Float]
|
1118
|
+
#
|
1119
|
+
# @param created_at [Time]
|
1120
|
+
#
|
1121
|
+
# @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Amendment::CreditBlock]
|
1122
|
+
#
|
1123
|
+
# @param currency [String]
|
1124
|
+
#
|
1125
|
+
# @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Amendment::Customer]
|
1126
|
+
#
|
1127
|
+
# @param description [String, nil]
|
1128
|
+
#
|
1129
|
+
# @param ending_balance [Float]
|
1130
|
+
#
|
1131
|
+
# @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Amendment::EntryStatus]
|
1132
|
+
#
|
1133
|
+
# @param ledger_sequence_number [Integer]
|
1134
|
+
#
|
1135
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
1136
|
+
# ...
|
1137
|
+
#
|
1138
|
+
# @param starting_balance [Float]
|
1139
|
+
#
|
1140
|
+
# @param entry_type [Symbol, :amendment]
|
1141
|
+
|
1142
|
+
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Amendment#credit_block
|
1241
1143
|
class CreditBlock < Orb::Internal::Type::BaseModel
|
1242
1144
|
# @!attribute id
|
1243
1145
|
#
|
@@ -1254,17 +1156,13 @@ module Orb
|
|
1254
1156
|
# @return [String, nil]
|
1255
1157
|
required :per_unit_cost_basis, String, nil?: true
|
1256
1158
|
|
1257
|
-
# @!
|
1258
|
-
#
|
1259
|
-
#
|
1260
|
-
#
|
1261
|
-
# #
|
1262
|
-
# def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
|
1263
|
-
|
1264
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1159
|
+
# @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
|
1160
|
+
# @param id [String]
|
1161
|
+
# @param expiry_date [Time, nil]
|
1162
|
+
# @param per_unit_cost_basis [String, nil]
|
1265
1163
|
end
|
1266
1164
|
|
1267
|
-
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
1165
|
+
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Amendment#customer
|
1268
1166
|
class Customer < Orb::Internal::Type::BaseModel
|
1269
1167
|
# @!attribute id
|
1270
1168
|
#
|
@@ -1276,33 +1174,25 @@ module Orb
|
|
1276
1174
|
# @return [String, nil]
|
1277
1175
|
required :external_customer_id, String, nil?: true
|
1278
1176
|
|
1279
|
-
# @!
|
1280
|
-
#
|
1281
|
-
#
|
1282
|
-
# #
|
1283
|
-
# def initialize(id:, external_customer_id:, **) = super
|
1284
|
-
|
1285
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1177
|
+
# @!method initialize(id:, external_customer_id:)
|
1178
|
+
# @param id [String]
|
1179
|
+
# @param external_customer_id [String, nil]
|
1286
1180
|
end
|
1287
1181
|
|
1288
|
-
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
1182
|
+
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Amendment#entry_status
|
1289
1183
|
module EntryStatus
|
1290
1184
|
extend Orb::Internal::Type::Enum
|
1291
1185
|
|
1292
1186
|
COMMITTED = :committed
|
1293
1187
|
PENDING = :pending
|
1294
1188
|
|
1295
|
-
|
1296
|
-
|
1297
|
-
# @!parse
|
1298
|
-
# # @return [Array<Symbol>]
|
1299
|
-
# def self.values; end
|
1189
|
+
# @!method self.values
|
1190
|
+
# @return [Array<Symbol>]
|
1300
1191
|
end
|
1301
1192
|
end
|
1302
1193
|
|
1303
|
-
# @!
|
1304
|
-
#
|
1305
|
-
# def self.variants; end
|
1194
|
+
# @!method self.variants
|
1195
|
+
# @return [Array(Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Increment, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Decrement, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChange, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Void, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiated, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Amendment)]
|
1306
1196
|
end
|
1307
1197
|
end
|
1308
1198
|
end
|