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