orb-billing 0.1.3 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.ignore +2 -0
- data/CHANGELOG.md +65 -0
- data/README.md +61 -51
- data/lib/orb/client.rb +7 -6
- data/lib/orb/file_part.rb +55 -0
- data/lib/orb/internal/page.rb +37 -39
- data/lib/orb/internal/transport/base_client.rb +21 -11
- data/lib/orb/internal/transport/pooled_net_requester.rb +3 -3
- data/lib/orb/internal/type/array_of.rb +28 -2
- data/lib/orb/internal/type/base_model.rb +83 -21
- data/lib/orb/internal/type/base_page.rb +10 -1
- data/lib/orb/internal/type/boolean.rb +6 -0
- data/lib/orb/internal/type/converter.rb +28 -1
- data/lib/orb/internal/type/enum.rb +28 -8
- data/lib/orb/internal/type/{io_like.rb → file_input.rb} +35 -15
- data/lib/orb/internal/type/hash_of.rb +28 -2
- data/lib/orb/internal/type/request_parameters.rb +1 -2
- data/lib/orb/internal/type/union.rb +27 -4
- data/lib/orb/internal/type/unknown.rb +6 -0
- data/lib/orb/internal/util.rb +105 -70
- data/lib/orb/internal.rb +5 -2
- 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 +24 -29
- 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 +211 -252
- 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 +207 -250
- data/lib/orb/models/customer_update_params.rb +207 -250
- 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 +22 -26
- data/lib/orb/models/customers/cost_list_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_response.rb +22 -26
- 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 +300 -406
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +63 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +300 -406
- 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 +300 -406
- data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
- data/lib/orb/models/customers/credits/ledger_list_response.rb +300 -406
- 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 +589 -637
- 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 +584 -631
- 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 +247 -269
- 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 +250 -279
- data/lib/orb/models/plan_create_params.rb +1623 -1984
- 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 +2709 -3820
- 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 +343 -382
- data/lib/orb/models/subscription_cancel_params.rb +16 -16
- data/lib/orb/models/subscription_cancel_response.rb +339 -377
- data/lib/orb/models/subscription_change_apply_params.rb +7 -10
- data/lib/orb/models/subscription_change_apply_response.rb +365 -398
- data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
- data/lib/orb/models/subscription_change_cancel_response.rb +365 -398
- data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
- data/lib/orb/models/subscription_change_retrieve_response.rb +366 -398
- data/lib/orb/models/subscription_create_params.rb +3771 -4402
- data/lib/orb/models/subscription_create_response.rb +339 -377
- data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
- data/lib/orb/models/subscription_fetch_costs_response.rb +22 -26
- 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 +2018 -2472
- data/lib/orb/models/subscription_price_intervals_response.rb +342 -377
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +3764 -4392
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +342 -377
- data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
- data/lib/orb/models/subscription_trigger_phase_response.rb +341 -377
- data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +342 -377
- 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 +343 -377
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +343 -377
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +22 -33
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +342 -377
- 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 +341 -377
- 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/request_options.rb +3 -4
- data/lib/orb/resources/alerts.rb +48 -17
- data/lib/orb/resources/coupons/subscriptions.rb +9 -2
- data/lib/orb/resources/coupons.rb +25 -7
- 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 +108 -28
- 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 +135 -36
- 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 +7 -1
- data/lib/orb/resources/prices.rb +97 -22
- 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/client.rbi +7 -6
- data/rbi/lib/orb/file_part.rbi +34 -0
- data/rbi/lib/orb/internal/page.rbi +1 -0
- data/rbi/lib/orb/internal/transport/base_client.rbi +18 -3
- data/rbi/lib/orb/internal/type/array_of.rbi +15 -9
- data/rbi/lib/orb/internal/type/base_model.rbi +22 -0
- data/rbi/lib/orb/internal/type/base_page.rbi +2 -0
- data/rbi/lib/orb/internal/type/boolean.rbi +4 -5
- data/rbi/lib/orb/internal/type/converter.rbi +8 -0
- data/rbi/lib/orb/internal/type/enum.rbi +7 -6
- data/rbi/lib/orb/internal/type/{io_like.rbi → file_input.rbi} +9 -7
- data/rbi/lib/orb/internal/type/hash_of.rbi +15 -9
- data/rbi/lib/orb/internal/type/union.rbi +7 -0
- data/rbi/lib/orb/internal/type/unknown.rbi +4 -5
- data/rbi/lib/orb/internal/util.rbi +39 -19
- data/rbi/lib/orb/internal.rbi +1 -2
- data/rbi/lib/orb/models/alert.rbi +28 -8
- data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_disable_params.rbi +5 -2
- data/rbi/lib/orb/models/alert_enable_params.rbi +5 -2
- data/rbi/lib/orb/models/alert_list_params.rbi +6 -0
- data/rbi/lib/orb/models/alert_update_params.rbi +11 -4
- data/rbi/lib/orb/models/amount_discount.rbi +10 -4
- data/rbi/lib/orb/models/billable_metric.rbi +16 -3
- data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -1
- data/rbi/lib/orb/models/coupon.rbi +10 -3
- data/rbi/lib/orb/models/coupon_create_params.rbi +6 -3
- data/rbi/lib/orb/models/coupon_list_params.rbi +13 -3
- data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +8 -2
- data/rbi/lib/orb/models/credit_note.rbi +44 -12
- data/rbi/lib/orb/models/credit_note_create_params.rbi +15 -6
- data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customer.rbi +130 -11
- data/rbi/lib/orb/models/customer_create_params.rbi +142 -8
- data/rbi/lib/orb/models/customer_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +140 -8
- data/rbi/lib/orb/models/customer_update_params.rbi +140 -8
- data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +8 -4
- data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +18 -8
- data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +18 -8
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +9 -5
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +21 -4
- data/rbi/lib/orb/models/customers/cost_list_params.rbi +9 -5
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +21 -4
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +13 -3
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +1 -2
- data/rbi/lib/orb/models/customers/credit_list_params.rbi +13 -3
- data/rbi/lib/orb/models/customers/credit_list_response.rbi +1 -2
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +40 -6
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +6 -4
- data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +27 -4
- data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +8 -2
- data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +25 -4
- data/rbi/lib/orb/models/dimensional_price_group.rbi +11 -3
- data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -0
- data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +8 -2
- data/rbi/lib/orb/models/evaluate_price_group.rbi +8 -2
- data/rbi/lib/orb/models/event_deprecate_response.rbi +4 -2
- data/rbi/lib/orb/models/event_ingest_params.rbi +22 -5
- data/rbi/lib/orb/models/event_ingest_response.rbi +15 -4
- data/rbi/lib/orb/models/event_search_params.rbi +14 -2
- data/rbi/lib/orb/models/event_search_response.rbi +14 -3
- data/rbi/lib/orb/models/event_update_params.rbi +10 -3
- data/rbi/lib/orb/models/event_update_response.rbi +4 -2
- data/rbi/lib/orb/models/events/backfill_close_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_create_params.rbi +18 -0
- data/rbi/lib/orb/models/events/backfill_create_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_list_params.rbi +8 -2
- data/rbi/lib/orb/models/events/backfill_list_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_revert_response.rbi +14 -2
- data/rbi/lib/orb/models/events/event_volumes.rbi +6 -2
- data/rbi/lib/orb/models/events/volume_list_params.rbi +18 -2
- data/rbi/lib/orb/models/invoice.rbi +375 -46
- data/rbi/lib/orb/models/invoice_create_params.rbi +38 -6
- data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +375 -66
- data/rbi/lib/orb/models/invoice_issue_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +16 -2
- data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +141 -20
- data/rbi/lib/orb/models/invoice_list_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_update_params.rbi +7 -2
- data/rbi/lib/orb/models/item.rbi +1 -2
- data/rbi/lib/orb/models/item_create_params.rbi +5 -2
- data/rbi/lib/orb/models/item_list_params.rbi +8 -2
- data/rbi/lib/orb/models/item_update_params.rbi +1 -8
- data/rbi/lib/orb/models/metric_create_params.rbi +15 -2
- data/rbi/lib/orb/models/metric_list_params.rbi +3 -0
- data/rbi/lib/orb/models/metric_update_params.rbi +7 -2
- data/rbi/lib/orb/models/percentage_discount.rbi +11 -4
- data/rbi/lib/orb/models/plan.rbi +102 -15
- data/rbi/lib/orb/models/plan_create_params.rbi +997 -679
- data/rbi/lib/orb/models/plan_list_params.rbi +5 -1
- data/rbi/lib/orb/models/plan_update_params.rbi +11 -2
- data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +11 -2
- data/rbi/lib/orb/models/price.rbi +717 -688
- data/rbi/lib/orb/models/price_create_params.rbi +137 -53
- data/rbi/lib/orb/models/price_evaluate_params.rbi +10 -0
- data/rbi/lib/orb/models/price_list_params.rbi +8 -2
- data/rbi/lib/orb/models/price_update_params.rbi +7 -2
- data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +7 -2
- data/rbi/lib/orb/models/subscription.rbi +174 -11
- data/rbi/lib/orb/models/subscription_cancel_params.rbi +8 -5
- data/rbi/lib/orb/models/subscription_cancel_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_change_apply_params.rbi +7 -2
- data/rbi/lib/orb/models/subscription_change_apply_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_create_params.rbi +2282 -1536
- data/rbi/lib/orb/models/subscription_create_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +9 -5
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +21 -4
- data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -0
- data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +8 -2
- data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +13 -4
- data/rbi/lib/orb/models/subscription_list_params.rbi +4 -2
- data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +1228 -861
- data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +2288 -1544
- data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +10 -2
- data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +187 -20
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_update_params.rbi +15 -0
- data/rbi/lib/orb/models/subscription_update_trial_params.rbi +11 -5
- data/rbi/lib/orb/models/subscription_update_trial_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_usage.rbi +2 -16
- data/rbi/lib/orb/models/trial_discount.rbi +5 -1
- data/rbi/lib/orb/models/usage_discount.rbi +11 -3
- 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 +4 -0
- data/sig/orb/internal/type/base_model.rbs +12 -0
- data/sig/orb/internal/type/converter.rbs +4 -0
- data/sig/orb/internal/type/enum.rbs +4 -2
- data/sig/orb/internal/type/{io_like.rbs → file_input.rbs} +1 -1
- data/sig/orb/internal/type/hash_of.rbs +4 -0
- data/sig/orb/internal/type/union.rbs +4 -0
- data/sig/orb/internal/util.rbs +16 -12
- data/sig/orb/internal.rbs +1 -1
- metadata +9 -5
@@ -103,41 +103,37 @@ module Orb
|
|
103
103
|
# @return [Float]
|
104
104
|
required :starting_balance, Float
|
105
105
|
|
106
|
-
# @!
|
107
|
-
#
|
108
|
-
#
|
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
|
-
# super
|
138
|
-
# end
|
139
|
-
|
140
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
106
|
+
# @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :increment)
|
107
|
+
# Some parameter documentations has been truncated, see
|
108
|
+
# {Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry} for
|
109
|
+
# more details.
|
110
|
+
#
|
111
|
+
# @param id [String]
|
112
|
+
#
|
113
|
+
# @param amount [Float]
|
114
|
+
#
|
115
|
+
# @param created_at [Time]
|
116
|
+
#
|
117
|
+
# @param credit_block [Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry::CreditBlock]
|
118
|
+
#
|
119
|
+
# @param currency [String]
|
120
|
+
#
|
121
|
+
# @param customer [Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry::Customer]
|
122
|
+
#
|
123
|
+
# @param description [String, nil]
|
124
|
+
#
|
125
|
+
# @param ending_balance [Float]
|
126
|
+
#
|
127
|
+
# @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry::EntryStatus]
|
128
|
+
#
|
129
|
+
# @param ledger_sequence_number [Integer]
|
130
|
+
#
|
131
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
132
|
+
# ...
|
133
|
+
#
|
134
|
+
# @param starting_balance [Float]
|
135
|
+
#
|
136
|
+
# @param entry_type [Symbol, :increment]
|
141
137
|
|
142
138
|
# @see Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry#credit_block
|
143
139
|
class CreditBlock < Orb::Internal::Type::BaseModel
|
@@ -156,14 +152,10 @@ module Orb
|
|
156
152
|
# @return [String, nil]
|
157
153
|
required :per_unit_cost_basis, String, nil?: true
|
158
154
|
|
159
|
-
# @!
|
160
|
-
#
|
161
|
-
#
|
162
|
-
#
|
163
|
-
# #
|
164
|
-
# def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
|
165
|
-
|
166
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
155
|
+
# @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
|
156
|
+
# @param id [String]
|
157
|
+
# @param expiry_date [Time, nil]
|
158
|
+
# @param per_unit_cost_basis [String, nil]
|
167
159
|
end
|
168
160
|
|
169
161
|
# @see Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry#customer
|
@@ -178,13 +170,9 @@ module Orb
|
|
178
170
|
# @return [String, nil]
|
179
171
|
required :external_customer_id, String, nil?: true
|
180
172
|
|
181
|
-
# @!
|
182
|
-
#
|
183
|
-
#
|
184
|
-
# #
|
185
|
-
# def initialize(id:, external_customer_id:, **) = super
|
186
|
-
|
187
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
173
|
+
# @!method initialize(id:, external_customer_id:)
|
174
|
+
# @param id [String]
|
175
|
+
# @param external_customer_id [String, nil]
|
188
176
|
end
|
189
177
|
|
190
178
|
# @see Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry#entry_status
|
@@ -194,11 +182,8 @@ module Orb
|
|
194
182
|
COMMITTED = :committed
|
195
183
|
PENDING = :pending
|
196
184
|
|
197
|
-
|
198
|
-
|
199
|
-
# @!parse
|
200
|
-
# # @return [Array<Symbol>]
|
201
|
-
# def self.values; end
|
185
|
+
# @!method self.values
|
186
|
+
# @return [Array<Symbol>]
|
202
187
|
end
|
203
188
|
end
|
204
189
|
|
@@ -290,47 +275,43 @@ module Orb
|
|
290
275
|
# @return [String, nil]
|
291
276
|
optional :price_id, String, nil?: true
|
292
277
|
|
293
|
-
# @!
|
294
|
-
#
|
295
|
-
#
|
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
|
-
# super
|
331
|
-
# end
|
332
|
-
|
333
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
278
|
+
# @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, event_id: nil, invoice_id: nil, price_id: nil, entry_type: :decrement)
|
279
|
+
# Some parameter documentations has been truncated, see
|
280
|
+
# {Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry} for
|
281
|
+
# more details.
|
282
|
+
#
|
283
|
+
# @param id [String]
|
284
|
+
#
|
285
|
+
# @param amount [Float]
|
286
|
+
#
|
287
|
+
# @param created_at [Time]
|
288
|
+
#
|
289
|
+
# @param credit_block [Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry::CreditBlock]
|
290
|
+
#
|
291
|
+
# @param currency [String]
|
292
|
+
#
|
293
|
+
# @param customer [Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry::Customer]
|
294
|
+
#
|
295
|
+
# @param description [String, nil]
|
296
|
+
#
|
297
|
+
# @param ending_balance [Float]
|
298
|
+
#
|
299
|
+
# @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry::EntryStatus]
|
300
|
+
#
|
301
|
+
# @param ledger_sequence_number [Integer]
|
302
|
+
#
|
303
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
304
|
+
# ...
|
305
|
+
#
|
306
|
+
# @param starting_balance [Float]
|
307
|
+
#
|
308
|
+
# @param event_id [String, nil]
|
309
|
+
#
|
310
|
+
# @param invoice_id [String, nil]
|
311
|
+
#
|
312
|
+
# @param price_id [String, nil]
|
313
|
+
#
|
314
|
+
# @param entry_type [Symbol, :decrement]
|
334
315
|
|
335
316
|
# @see Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry#credit_block
|
336
317
|
class CreditBlock < Orb::Internal::Type::BaseModel
|
@@ -349,14 +330,10 @@ module Orb
|
|
349
330
|
# @return [String, nil]
|
350
331
|
required :per_unit_cost_basis, String, nil?: true
|
351
332
|
|
352
|
-
# @!
|
353
|
-
#
|
354
|
-
#
|
355
|
-
#
|
356
|
-
# #
|
357
|
-
# def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
|
358
|
-
|
359
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
333
|
+
# @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
|
334
|
+
# @param id [String]
|
335
|
+
# @param expiry_date [Time, nil]
|
336
|
+
# @param per_unit_cost_basis [String, nil]
|
360
337
|
end
|
361
338
|
|
362
339
|
# @see Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry#customer
|
@@ -371,13 +348,9 @@ module Orb
|
|
371
348
|
# @return [String, nil]
|
372
349
|
required :external_customer_id, String, nil?: true
|
373
350
|
|
374
|
-
# @!
|
375
|
-
#
|
376
|
-
#
|
377
|
-
# #
|
378
|
-
# def initialize(id:, external_customer_id:, **) = super
|
379
|
-
|
380
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
351
|
+
# @!method initialize(id:, external_customer_id:)
|
352
|
+
# @param id [String]
|
353
|
+
# @param external_customer_id [String, nil]
|
381
354
|
end
|
382
355
|
|
383
356
|
# @see Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry#entry_status
|
@@ -387,11 +360,8 @@ module Orb
|
|
387
360
|
COMMITTED = :committed
|
388
361
|
PENDING = :pending
|
389
362
|
|
390
|
-
|
391
|
-
|
392
|
-
# @!parse
|
393
|
-
# # @return [Array<Symbol>]
|
394
|
-
# def self.values; end
|
363
|
+
# @!method self.values
|
364
|
+
# @return [Array<Symbol>]
|
395
365
|
end
|
396
366
|
end
|
397
367
|
|
@@ -473,43 +443,39 @@ module Orb
|
|
473
443
|
# @return [Float]
|
474
444
|
required :starting_balance, Float
|
475
445
|
|
476
|
-
# @!
|
477
|
-
#
|
478
|
-
#
|
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
|
-
# super
|
510
|
-
# end
|
511
|
-
|
512
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
446
|
+
# @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, new_block_expiry_date:, starting_balance:, entry_type: :expiration_change)
|
447
|
+
# Some parameter documentations has been truncated, see
|
448
|
+
# {Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry}
|
449
|
+
# for more details.
|
450
|
+
#
|
451
|
+
# @param id [String]
|
452
|
+
#
|
453
|
+
# @param amount [Float]
|
454
|
+
#
|
455
|
+
# @param created_at [Time]
|
456
|
+
#
|
457
|
+
# @param credit_block [Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry::CreditBlock]
|
458
|
+
#
|
459
|
+
# @param currency [String]
|
460
|
+
#
|
461
|
+
# @param customer [Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry::Customer]
|
462
|
+
#
|
463
|
+
# @param description [String, nil]
|
464
|
+
#
|
465
|
+
# @param ending_balance [Float]
|
466
|
+
#
|
467
|
+
# @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry::EntryStatus]
|
468
|
+
#
|
469
|
+
# @param ledger_sequence_number [Integer]
|
470
|
+
#
|
471
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
472
|
+
# ...
|
473
|
+
#
|
474
|
+
# @param new_block_expiry_date [Time, nil]
|
475
|
+
#
|
476
|
+
# @param starting_balance [Float]
|
477
|
+
#
|
478
|
+
# @param entry_type [Symbol, :expiration_change]
|
513
479
|
|
514
480
|
# @see Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry#credit_block
|
515
481
|
class CreditBlock < Orb::Internal::Type::BaseModel
|
@@ -528,14 +494,10 @@ module Orb
|
|
528
494
|
# @return [String, nil]
|
529
495
|
required :per_unit_cost_basis, String, nil?: true
|
530
496
|
|
531
|
-
# @!
|
532
|
-
#
|
533
|
-
#
|
534
|
-
#
|
535
|
-
# #
|
536
|
-
# def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
|
537
|
-
|
538
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
497
|
+
# @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
|
498
|
+
# @param id [String]
|
499
|
+
# @param expiry_date [Time, nil]
|
500
|
+
# @param per_unit_cost_basis [String, nil]
|
539
501
|
end
|
540
502
|
|
541
503
|
# @see Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry#customer
|
@@ -550,13 +512,9 @@ module Orb
|
|
550
512
|
# @return [String, nil]
|
551
513
|
required :external_customer_id, String, nil?: true
|
552
514
|
|
553
|
-
# @!
|
554
|
-
#
|
555
|
-
#
|
556
|
-
# #
|
557
|
-
# def initialize(id:, external_customer_id:, **) = super
|
558
|
-
|
559
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
515
|
+
# @!method initialize(id:, external_customer_id:)
|
516
|
+
# @param id [String]
|
517
|
+
# @param external_customer_id [String, nil]
|
560
518
|
end
|
561
519
|
|
562
520
|
# @see Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry#entry_status
|
@@ -566,11 +524,8 @@ module Orb
|
|
566
524
|
COMMITTED = :committed
|
567
525
|
PENDING = :pending
|
568
526
|
|
569
|
-
|
570
|
-
|
571
|
-
# @!parse
|
572
|
-
# # @return [Array<Symbol>]
|
573
|
-
# def self.values; end
|
527
|
+
# @!method self.values
|
528
|
+
# @return [Array<Symbol>]
|
574
529
|
end
|
575
530
|
end
|
576
531
|
|
@@ -647,41 +602,37 @@ module Orb
|
|
647
602
|
# @return [Float]
|
648
603
|
required :starting_balance, Float
|
649
604
|
|
650
|
-
# @!
|
651
|
-
#
|
652
|
-
#
|
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
|
-
# super
|
682
|
-
# end
|
683
|
-
|
684
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
605
|
+
# @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :credit_block_expiry)
|
606
|
+
# Some parameter documentations has been truncated, see
|
607
|
+
# {Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry}
|
608
|
+
# for more details.
|
609
|
+
#
|
610
|
+
# @param id [String]
|
611
|
+
#
|
612
|
+
# @param amount [Float]
|
613
|
+
#
|
614
|
+
# @param created_at [Time]
|
615
|
+
#
|
616
|
+
# @param credit_block [Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry::CreditBlock]
|
617
|
+
#
|
618
|
+
# @param currency [String]
|
619
|
+
#
|
620
|
+
# @param customer [Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry::Customer]
|
621
|
+
#
|
622
|
+
# @param description [String, nil]
|
623
|
+
#
|
624
|
+
# @param ending_balance [Float]
|
625
|
+
#
|
626
|
+
# @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry::EntryStatus]
|
627
|
+
#
|
628
|
+
# @param ledger_sequence_number [Integer]
|
629
|
+
#
|
630
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
631
|
+
# ...
|
632
|
+
#
|
633
|
+
# @param starting_balance [Float]
|
634
|
+
#
|
635
|
+
# @param entry_type [Symbol, :credit_block_expiry]
|
685
636
|
|
686
637
|
# @see Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry#credit_block
|
687
638
|
class CreditBlock < Orb::Internal::Type::BaseModel
|
@@ -700,14 +651,10 @@ module Orb
|
|
700
651
|
# @return [String, nil]
|
701
652
|
required :per_unit_cost_basis, String, nil?: true
|
702
653
|
|
703
|
-
# @!
|
704
|
-
#
|
705
|
-
#
|
706
|
-
#
|
707
|
-
# #
|
708
|
-
# def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
|
709
|
-
|
710
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
654
|
+
# @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
|
655
|
+
# @param id [String]
|
656
|
+
# @param expiry_date [Time, nil]
|
657
|
+
# @param per_unit_cost_basis [String, nil]
|
711
658
|
end
|
712
659
|
|
713
660
|
# @see Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry#customer
|
@@ -722,13 +669,9 @@ module Orb
|
|
722
669
|
# @return [String, nil]
|
723
670
|
required :external_customer_id, String, nil?: true
|
724
671
|
|
725
|
-
# @!
|
726
|
-
#
|
727
|
-
#
|
728
|
-
# #
|
729
|
-
# def initialize(id:, external_customer_id:, **) = super
|
730
|
-
|
731
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
672
|
+
# @!method initialize(id:, external_customer_id:)
|
673
|
+
# @param id [String]
|
674
|
+
# @param external_customer_id [String, nil]
|
732
675
|
end
|
733
676
|
|
734
677
|
# @see Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry#entry_status
|
@@ -738,11 +681,8 @@ module Orb
|
|
738
681
|
COMMITTED = :committed
|
739
682
|
PENDING = :pending
|
740
683
|
|
741
|
-
|
742
|
-
|
743
|
-
# @!parse
|
744
|
-
# # @return [Array<Symbol>]
|
745
|
-
# def self.values; end
|
684
|
+
# @!method self.values
|
685
|
+
# @return [Array<Symbol>]
|
746
686
|
end
|
747
687
|
end
|
748
688
|
|
@@ -828,45 +768,41 @@ module Orb
|
|
828
768
|
# @return [String, nil]
|
829
769
|
required :void_reason, String, nil?: true
|
830
770
|
|
831
|
-
# @!
|
832
|
-
#
|
833
|
-
#
|
834
|
-
#
|
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
|
-
# super
|
867
|
-
# end
|
868
|
-
|
869
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
771
|
+
# @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, void_amount:, void_reason:, entry_type: :void)
|
772
|
+
# Some parameter documentations has been truncated, see
|
773
|
+
# {Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry} for more
|
774
|
+
# details.
|
775
|
+
#
|
776
|
+
# @param id [String]
|
777
|
+
#
|
778
|
+
# @param amount [Float]
|
779
|
+
#
|
780
|
+
# @param created_at [Time]
|
781
|
+
#
|
782
|
+
# @param credit_block [Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry::CreditBlock]
|
783
|
+
#
|
784
|
+
# @param currency [String]
|
785
|
+
#
|
786
|
+
# @param customer [Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry::Customer]
|
787
|
+
#
|
788
|
+
# @param description [String, nil]
|
789
|
+
#
|
790
|
+
# @param ending_balance [Float]
|
791
|
+
#
|
792
|
+
# @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry::EntryStatus]
|
793
|
+
#
|
794
|
+
# @param ledger_sequence_number [Integer]
|
795
|
+
#
|
796
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
797
|
+
# ...
|
798
|
+
#
|
799
|
+
# @param starting_balance [Float]
|
800
|
+
#
|
801
|
+
# @param void_amount [Float]
|
802
|
+
#
|
803
|
+
# @param void_reason [String, nil]
|
804
|
+
#
|
805
|
+
# @param entry_type [Symbol, :void]
|
870
806
|
|
871
807
|
# @see Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry#credit_block
|
872
808
|
class CreditBlock < Orb::Internal::Type::BaseModel
|
@@ -885,14 +821,10 @@ module Orb
|
|
885
821
|
# @return [String, nil]
|
886
822
|
required :per_unit_cost_basis, String, nil?: true
|
887
823
|
|
888
|
-
# @!
|
889
|
-
#
|
890
|
-
#
|
891
|
-
#
|
892
|
-
# #
|
893
|
-
# def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
|
894
|
-
|
895
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
824
|
+
# @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
|
825
|
+
# @param id [String]
|
826
|
+
# @param expiry_date [Time, nil]
|
827
|
+
# @param per_unit_cost_basis [String, nil]
|
896
828
|
end
|
897
829
|
|
898
830
|
# @see Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry#customer
|
@@ -907,13 +839,9 @@ module Orb
|
|
907
839
|
# @return [String, nil]
|
908
840
|
required :external_customer_id, String, nil?: true
|
909
841
|
|
910
|
-
# @!
|
911
|
-
#
|
912
|
-
#
|
913
|
-
# #
|
914
|
-
# def initialize(id:, external_customer_id:, **) = super
|
915
|
-
|
916
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
842
|
+
# @!method initialize(id:, external_customer_id:)
|
843
|
+
# @param id [String]
|
844
|
+
# @param external_customer_id [String, nil]
|
917
845
|
end
|
918
846
|
|
919
847
|
# @see Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry#entry_status
|
@@ -923,11 +851,8 @@ module Orb
|
|
923
851
|
COMMITTED = :committed
|
924
852
|
PENDING = :pending
|
925
853
|
|
926
|
-
|
927
|
-
|
928
|
-
# @!parse
|
929
|
-
# # @return [Array<Symbol>]
|
930
|
-
# def self.values; end
|
854
|
+
# @!method self.values
|
855
|
+
# @return [Array<Symbol>]
|
931
856
|
end
|
932
857
|
end
|
933
858
|
|
@@ -1019,47 +944,43 @@ module Orb
|
|
1019
944
|
# @return [String, nil]
|
1020
945
|
required :void_reason, String, nil?: true
|
1021
946
|
|
1022
|
-
# @!
|
1023
|
-
#
|
1024
|
-
#
|
1025
|
-
#
|
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
|
-
# super
|
1060
|
-
# end
|
1061
|
-
|
1062
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
947
|
+
# @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, new_block_expiry_date:, starting_balance:, void_amount:, void_reason:, entry_type: :void_initiated)
|
948
|
+
# Some parameter documentations has been truncated, see
|
949
|
+
# {Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry}
|
950
|
+
# for more details.
|
951
|
+
#
|
952
|
+
# @param id [String]
|
953
|
+
#
|
954
|
+
# @param amount [Float]
|
955
|
+
#
|
956
|
+
# @param created_at [Time]
|
957
|
+
#
|
958
|
+
# @param credit_block [Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry::CreditBlock]
|
959
|
+
#
|
960
|
+
# @param currency [String]
|
961
|
+
#
|
962
|
+
# @param customer [Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry::Customer]
|
963
|
+
#
|
964
|
+
# @param description [String, nil]
|
965
|
+
#
|
966
|
+
# @param ending_balance [Float]
|
967
|
+
#
|
968
|
+
# @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry::EntryStatus]
|
969
|
+
#
|
970
|
+
# @param ledger_sequence_number [Integer]
|
971
|
+
#
|
972
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
973
|
+
# ...
|
974
|
+
#
|
975
|
+
# @param new_block_expiry_date [Time]
|
976
|
+
#
|
977
|
+
# @param starting_balance [Float]
|
978
|
+
#
|
979
|
+
# @param void_amount [Float]
|
980
|
+
#
|
981
|
+
# @param void_reason [String, nil]
|
982
|
+
#
|
983
|
+
# @param entry_type [Symbol, :void_initiated]
|
1063
984
|
|
1064
985
|
# @see Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry#credit_block
|
1065
986
|
class CreditBlock < Orb::Internal::Type::BaseModel
|
@@ -1078,14 +999,10 @@ module Orb
|
|
1078
999
|
# @return [String, nil]
|
1079
1000
|
required :per_unit_cost_basis, String, nil?: true
|
1080
1001
|
|
1081
|
-
# @!
|
1082
|
-
#
|
1083
|
-
#
|
1084
|
-
#
|
1085
|
-
# #
|
1086
|
-
# def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
|
1087
|
-
|
1088
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1002
|
+
# @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
|
1003
|
+
# @param id [String]
|
1004
|
+
# @param expiry_date [Time, nil]
|
1005
|
+
# @param per_unit_cost_basis [String, nil]
|
1089
1006
|
end
|
1090
1007
|
|
1091
1008
|
# @see Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry#customer
|
@@ -1100,13 +1017,9 @@ module Orb
|
|
1100
1017
|
# @return [String, nil]
|
1101
1018
|
required :external_customer_id, String, nil?: true
|
1102
1019
|
|
1103
|
-
# @!
|
1104
|
-
#
|
1105
|
-
#
|
1106
|
-
# #
|
1107
|
-
# def initialize(id:, external_customer_id:, **) = super
|
1108
|
-
|
1109
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1020
|
+
# @!method initialize(id:, external_customer_id:)
|
1021
|
+
# @param id [String]
|
1022
|
+
# @param external_customer_id [String, nil]
|
1110
1023
|
end
|
1111
1024
|
|
1112
1025
|
# @see Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry#entry_status
|
@@ -1116,11 +1029,8 @@ module Orb
|
|
1116
1029
|
COMMITTED = :committed
|
1117
1030
|
PENDING = :pending
|
1118
1031
|
|
1119
|
-
|
1120
|
-
|
1121
|
-
# @!parse
|
1122
|
-
# # @return [Array<Symbol>]
|
1123
|
-
# def self.values; end
|
1032
|
+
# @!method self.values
|
1033
|
+
# @return [Array<Symbol>]
|
1124
1034
|
end
|
1125
1035
|
end
|
1126
1036
|
|
@@ -1197,41 +1107,37 @@ module Orb
|
|
1197
1107
|
# @return [Float]
|
1198
1108
|
required :starting_balance, Float
|
1199
1109
|
|
1200
|
-
# @!
|
1201
|
-
#
|
1202
|
-
#
|
1203
|
-
#
|
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
|
-
# super
|
1232
|
-
# end
|
1233
|
-
|
1234
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1110
|
+
# @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :amendment)
|
1111
|
+
# Some parameter documentations has been truncated, see
|
1112
|
+
# {Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry} for
|
1113
|
+
# more details.
|
1114
|
+
#
|
1115
|
+
# @param id [String]
|
1116
|
+
#
|
1117
|
+
# @param amount [Float]
|
1118
|
+
#
|
1119
|
+
# @param created_at [Time]
|
1120
|
+
#
|
1121
|
+
# @param credit_block [Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry::CreditBlock]
|
1122
|
+
#
|
1123
|
+
# @param currency [String]
|
1124
|
+
#
|
1125
|
+
# @param customer [Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry::Customer]
|
1126
|
+
#
|
1127
|
+
# @param description [String, nil]
|
1128
|
+
#
|
1129
|
+
# @param ending_balance [Float]
|
1130
|
+
#
|
1131
|
+
# @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry::EntryStatus]
|
1132
|
+
#
|
1133
|
+
# @param ledger_sequence_number [Integer]
|
1134
|
+
#
|
1135
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
1136
|
+
# ...
|
1137
|
+
#
|
1138
|
+
# @param starting_balance [Float]
|
1139
|
+
#
|
1140
|
+
# @param entry_type [Symbol, :amendment]
|
1235
1141
|
|
1236
1142
|
# @see Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry#credit_block
|
1237
1143
|
class CreditBlock < Orb::Internal::Type::BaseModel
|
@@ -1250,14 +1156,10 @@ module Orb
|
|
1250
1156
|
# @return [String, nil]
|
1251
1157
|
required :per_unit_cost_basis, String, nil?: true
|
1252
1158
|
|
1253
|
-
# @!
|
1254
|
-
#
|
1255
|
-
#
|
1256
|
-
#
|
1257
|
-
# #
|
1258
|
-
# def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
|
1259
|
-
|
1260
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1159
|
+
# @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
|
1160
|
+
# @param id [String]
|
1161
|
+
# @param expiry_date [Time, nil]
|
1162
|
+
# @param per_unit_cost_basis [String, nil]
|
1261
1163
|
end
|
1262
1164
|
|
1263
1165
|
# @see Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry#customer
|
@@ -1272,13 +1174,9 @@ module Orb
|
|
1272
1174
|
# @return [String, nil]
|
1273
1175
|
required :external_customer_id, String, nil?: true
|
1274
1176
|
|
1275
|
-
# @!
|
1276
|
-
#
|
1277
|
-
#
|
1278
|
-
# #
|
1279
|
-
# def initialize(id:, external_customer_id:, **) = super
|
1280
|
-
|
1281
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1177
|
+
# @!method initialize(id:, external_customer_id:)
|
1178
|
+
# @param id [String]
|
1179
|
+
# @param external_customer_id [String, nil]
|
1282
1180
|
end
|
1283
1181
|
|
1284
1182
|
# @see Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry#entry_status
|
@@ -1288,17 +1186,13 @@ module Orb
|
|
1288
1186
|
COMMITTED = :committed
|
1289
1187
|
PENDING = :pending
|
1290
1188
|
|
1291
|
-
|
1292
|
-
|
1293
|
-
# @!parse
|
1294
|
-
# # @return [Array<Symbol>]
|
1295
|
-
# def self.values; end
|
1189
|
+
# @!method self.values
|
1190
|
+
# @return [Array<Symbol>]
|
1296
1191
|
end
|
1297
1192
|
end
|
1298
1193
|
|
1299
|
-
# @!
|
1300
|
-
#
|
1301
|
-
# def self.variants; end
|
1194
|
+
# @!method self.variants
|
1195
|
+
# @return [Array(Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry)]
|
1302
1196
|
end
|
1303
1197
|
end
|
1304
1198
|
end
|