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