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
@@ -106,41 +106,37 @@ module Orb
|
|
106
106
|
# @return [Float]
|
107
107
|
required :starting_balance, Float
|
108
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
|
-
#
|
138
|
-
#
|
139
|
-
#
|
140
|
-
# super
|
141
|
-
# end
|
142
|
-
|
143
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
109
|
+
# @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :increment)
|
110
|
+
# Some parameter documentations has been truncated, see
|
111
|
+
# {Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry}
|
112
|
+
# for more details.
|
113
|
+
#
|
114
|
+
# @param id [String]
|
115
|
+
#
|
116
|
+
# @param amount [Float]
|
117
|
+
#
|
118
|
+
# @param created_at [Time]
|
119
|
+
#
|
120
|
+
# @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry::CreditBlock]
|
121
|
+
#
|
122
|
+
# @param currency [String]
|
123
|
+
#
|
124
|
+
# @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry::Customer]
|
125
|
+
#
|
126
|
+
# @param description [String, nil]
|
127
|
+
#
|
128
|
+
# @param ending_balance [Float]
|
129
|
+
#
|
130
|
+
# @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry::EntryStatus]
|
131
|
+
#
|
132
|
+
# @param ledger_sequence_number [Integer]
|
133
|
+
#
|
134
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
135
|
+
# ...
|
136
|
+
#
|
137
|
+
# @param starting_balance [Float]
|
138
|
+
#
|
139
|
+
# @param entry_type [Symbol, :increment]
|
144
140
|
|
145
141
|
# @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry#credit_block
|
146
142
|
class CreditBlock < Orb::Internal::Type::BaseModel
|
@@ -159,14 +155,10 @@ module Orb
|
|
159
155
|
# @return [String, nil]
|
160
156
|
required :per_unit_cost_basis, String, nil?: true
|
161
157
|
|
162
|
-
# @!
|
163
|
-
#
|
164
|
-
#
|
165
|
-
#
|
166
|
-
# #
|
167
|
-
# def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
|
168
|
-
|
169
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
158
|
+
# @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
|
159
|
+
# @param id [String]
|
160
|
+
# @param expiry_date [Time, nil]
|
161
|
+
# @param per_unit_cost_basis [String, nil]
|
170
162
|
end
|
171
163
|
|
172
164
|
# @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry#customer
|
@@ -181,13 +173,9 @@ module Orb
|
|
181
173
|
# @return [String, nil]
|
182
174
|
required :external_customer_id, String, nil?: true
|
183
175
|
|
184
|
-
# @!
|
185
|
-
#
|
186
|
-
#
|
187
|
-
# #
|
188
|
-
# def initialize(id:, external_customer_id:, **) = super
|
189
|
-
|
190
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
176
|
+
# @!method initialize(id:, external_customer_id:)
|
177
|
+
# @param id [String]
|
178
|
+
# @param external_customer_id [String, nil]
|
191
179
|
end
|
192
180
|
|
193
181
|
# @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry#entry_status
|
@@ -197,11 +185,8 @@ module Orb
|
|
197
185
|
COMMITTED = :committed
|
198
186
|
PENDING = :pending
|
199
187
|
|
200
|
-
|
201
|
-
|
202
|
-
# @!parse
|
203
|
-
# # @return [Array<Symbol>]
|
204
|
-
# def self.values; end
|
188
|
+
# @!method self.values
|
189
|
+
# @return [Array<Symbol>]
|
205
190
|
end
|
206
191
|
end
|
207
192
|
|
@@ -293,47 +278,43 @@ module Orb
|
|
293
278
|
# @return [String, nil]
|
294
279
|
optional :price_id, String, nil?: true
|
295
280
|
|
296
|
-
# @!
|
297
|
-
#
|
298
|
-
#
|
299
|
-
#
|
300
|
-
#
|
301
|
-
#
|
302
|
-
#
|
303
|
-
#
|
304
|
-
#
|
305
|
-
#
|
306
|
-
#
|
307
|
-
#
|
308
|
-
#
|
309
|
-
#
|
310
|
-
#
|
311
|
-
#
|
312
|
-
#
|
313
|
-
#
|
314
|
-
#
|
315
|
-
#
|
316
|
-
#
|
317
|
-
#
|
318
|
-
#
|
319
|
-
#
|
320
|
-
#
|
321
|
-
#
|
322
|
-
#
|
323
|
-
#
|
324
|
-
#
|
325
|
-
#
|
326
|
-
#
|
327
|
-
#
|
328
|
-
#
|
329
|
-
#
|
330
|
-
#
|
331
|
-
#
|
332
|
-
#
|
333
|
-
# super
|
334
|
-
# end
|
335
|
-
|
336
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
281
|
+
# @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, event_id: nil, invoice_id: nil, price_id: nil, entry_type: :decrement)
|
282
|
+
# Some parameter documentations has been truncated, see
|
283
|
+
# {Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry}
|
284
|
+
# for more details.
|
285
|
+
#
|
286
|
+
# @param id [String]
|
287
|
+
#
|
288
|
+
# @param amount [Float]
|
289
|
+
#
|
290
|
+
# @param created_at [Time]
|
291
|
+
#
|
292
|
+
# @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry::CreditBlock]
|
293
|
+
#
|
294
|
+
# @param currency [String]
|
295
|
+
#
|
296
|
+
# @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry::Customer]
|
297
|
+
#
|
298
|
+
# @param description [String, nil]
|
299
|
+
#
|
300
|
+
# @param ending_balance [Float]
|
301
|
+
#
|
302
|
+
# @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry::EntryStatus]
|
303
|
+
#
|
304
|
+
# @param ledger_sequence_number [Integer]
|
305
|
+
#
|
306
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
307
|
+
# ...
|
308
|
+
#
|
309
|
+
# @param starting_balance [Float]
|
310
|
+
#
|
311
|
+
# @param event_id [String, nil]
|
312
|
+
#
|
313
|
+
# @param invoice_id [String, nil]
|
314
|
+
#
|
315
|
+
# @param price_id [String, nil]
|
316
|
+
#
|
317
|
+
# @param entry_type [Symbol, :decrement]
|
337
318
|
|
338
319
|
# @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry#credit_block
|
339
320
|
class CreditBlock < Orb::Internal::Type::BaseModel
|
@@ -352,14 +333,10 @@ module Orb
|
|
352
333
|
# @return [String, nil]
|
353
334
|
required :per_unit_cost_basis, String, nil?: true
|
354
335
|
|
355
|
-
# @!
|
356
|
-
#
|
357
|
-
#
|
358
|
-
#
|
359
|
-
# #
|
360
|
-
# def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
|
361
|
-
|
362
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
336
|
+
# @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
|
337
|
+
# @param id [String]
|
338
|
+
# @param expiry_date [Time, nil]
|
339
|
+
# @param per_unit_cost_basis [String, nil]
|
363
340
|
end
|
364
341
|
|
365
342
|
# @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry#customer
|
@@ -374,13 +351,9 @@ module Orb
|
|
374
351
|
# @return [String, nil]
|
375
352
|
required :external_customer_id, String, nil?: true
|
376
353
|
|
377
|
-
# @!
|
378
|
-
#
|
379
|
-
#
|
380
|
-
# #
|
381
|
-
# def initialize(id:, external_customer_id:, **) = super
|
382
|
-
|
383
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
354
|
+
# @!method initialize(id:, external_customer_id:)
|
355
|
+
# @param id [String]
|
356
|
+
# @param external_customer_id [String, nil]
|
384
357
|
end
|
385
358
|
|
386
359
|
# @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry#entry_status
|
@@ -390,11 +363,8 @@ module Orb
|
|
390
363
|
COMMITTED = :committed
|
391
364
|
PENDING = :pending
|
392
365
|
|
393
|
-
|
394
|
-
|
395
|
-
# @!parse
|
396
|
-
# # @return [Array<Symbol>]
|
397
|
-
# def self.values; end
|
366
|
+
# @!method self.values
|
367
|
+
# @return [Array<Symbol>]
|
398
368
|
end
|
399
369
|
end
|
400
370
|
|
@@ -476,43 +446,39 @@ module Orb
|
|
476
446
|
# @return [Float]
|
477
447
|
required :starting_balance, Float
|
478
448
|
|
479
|
-
# @!
|
480
|
-
#
|
481
|
-
#
|
482
|
-
#
|
483
|
-
#
|
484
|
-
#
|
485
|
-
#
|
486
|
-
#
|
487
|
-
#
|
488
|
-
#
|
489
|
-
#
|
490
|
-
#
|
491
|
-
#
|
492
|
-
#
|
493
|
-
#
|
494
|
-
#
|
495
|
-
#
|
496
|
-
#
|
497
|
-
#
|
498
|
-
#
|
499
|
-
#
|
500
|
-
#
|
501
|
-
#
|
502
|
-
#
|
503
|
-
#
|
504
|
-
#
|
505
|
-
#
|
506
|
-
#
|
507
|
-
#
|
508
|
-
#
|
509
|
-
#
|
510
|
-
#
|
511
|
-
#
|
512
|
-
# super
|
513
|
-
# end
|
514
|
-
|
515
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
449
|
+
# @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, new_block_expiry_date:, starting_balance:, entry_type: :expiration_change)
|
450
|
+
# Some parameter documentations has been truncated, see
|
451
|
+
# {Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry}
|
452
|
+
# for more details.
|
453
|
+
#
|
454
|
+
# @param id [String]
|
455
|
+
#
|
456
|
+
# @param amount [Float]
|
457
|
+
#
|
458
|
+
# @param created_at [Time]
|
459
|
+
#
|
460
|
+
# @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry::CreditBlock]
|
461
|
+
#
|
462
|
+
# @param currency [String]
|
463
|
+
#
|
464
|
+
# @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry::Customer]
|
465
|
+
#
|
466
|
+
# @param description [String, nil]
|
467
|
+
#
|
468
|
+
# @param ending_balance [Float]
|
469
|
+
#
|
470
|
+
# @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry::EntryStatus]
|
471
|
+
#
|
472
|
+
# @param ledger_sequence_number [Integer]
|
473
|
+
#
|
474
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
475
|
+
# ...
|
476
|
+
#
|
477
|
+
# @param new_block_expiry_date [Time, nil]
|
478
|
+
#
|
479
|
+
# @param starting_balance [Float]
|
480
|
+
#
|
481
|
+
# @param entry_type [Symbol, :expiration_change]
|
516
482
|
|
517
483
|
# @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry#credit_block
|
518
484
|
class CreditBlock < Orb::Internal::Type::BaseModel
|
@@ -531,14 +497,10 @@ module Orb
|
|
531
497
|
# @return [String, nil]
|
532
498
|
required :per_unit_cost_basis, String, nil?: true
|
533
499
|
|
534
|
-
# @!
|
535
|
-
#
|
536
|
-
#
|
537
|
-
#
|
538
|
-
# #
|
539
|
-
# def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
|
540
|
-
|
541
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
500
|
+
# @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
|
501
|
+
# @param id [String]
|
502
|
+
# @param expiry_date [Time, nil]
|
503
|
+
# @param per_unit_cost_basis [String, nil]
|
542
504
|
end
|
543
505
|
|
544
506
|
# @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry#customer
|
@@ -553,13 +515,9 @@ module Orb
|
|
553
515
|
# @return [String, nil]
|
554
516
|
required :external_customer_id, String, nil?: true
|
555
517
|
|
556
|
-
# @!
|
557
|
-
#
|
558
|
-
#
|
559
|
-
# #
|
560
|
-
# def initialize(id:, external_customer_id:, **) = super
|
561
|
-
|
562
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
518
|
+
# @!method initialize(id:, external_customer_id:)
|
519
|
+
# @param id [String]
|
520
|
+
# @param external_customer_id [String, nil]
|
563
521
|
end
|
564
522
|
|
565
523
|
# @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry#entry_status
|
@@ -569,11 +527,8 @@ module Orb
|
|
569
527
|
COMMITTED = :committed
|
570
528
|
PENDING = :pending
|
571
529
|
|
572
|
-
|
573
|
-
|
574
|
-
# @!parse
|
575
|
-
# # @return [Array<Symbol>]
|
576
|
-
# def self.values; end
|
530
|
+
# @!method self.values
|
531
|
+
# @return [Array<Symbol>]
|
577
532
|
end
|
578
533
|
end
|
579
534
|
|
@@ -650,41 +605,37 @@ module Orb
|
|
650
605
|
# @return [Float]
|
651
606
|
required :starting_balance, Float
|
652
607
|
|
653
|
-
# @!
|
654
|
-
#
|
655
|
-
#
|
656
|
-
#
|
657
|
-
#
|
658
|
-
#
|
659
|
-
#
|
660
|
-
#
|
661
|
-
#
|
662
|
-
#
|
663
|
-
#
|
664
|
-
#
|
665
|
-
#
|
666
|
-
#
|
667
|
-
#
|
668
|
-
#
|
669
|
-
#
|
670
|
-
#
|
671
|
-
#
|
672
|
-
#
|
673
|
-
#
|
674
|
-
#
|
675
|
-
#
|
676
|
-
#
|
677
|
-
#
|
678
|
-
#
|
679
|
-
#
|
680
|
-
#
|
681
|
-
#
|
682
|
-
#
|
683
|
-
#
|
684
|
-
# super
|
685
|
-
# end
|
686
|
-
|
687
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
608
|
+
# @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :credit_block_expiry)
|
609
|
+
# Some parameter documentations has been truncated, see
|
610
|
+
# {Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry}
|
611
|
+
# for more details.
|
612
|
+
#
|
613
|
+
# @param id [String]
|
614
|
+
#
|
615
|
+
# @param amount [Float]
|
616
|
+
#
|
617
|
+
# @param created_at [Time]
|
618
|
+
#
|
619
|
+
# @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry::CreditBlock]
|
620
|
+
#
|
621
|
+
# @param currency [String]
|
622
|
+
#
|
623
|
+
# @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry::Customer]
|
624
|
+
#
|
625
|
+
# @param description [String, nil]
|
626
|
+
#
|
627
|
+
# @param ending_balance [Float]
|
628
|
+
#
|
629
|
+
# @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry::EntryStatus]
|
630
|
+
#
|
631
|
+
# @param ledger_sequence_number [Integer]
|
632
|
+
#
|
633
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
634
|
+
# ...
|
635
|
+
#
|
636
|
+
# @param starting_balance [Float]
|
637
|
+
#
|
638
|
+
# @param entry_type [Symbol, :credit_block_expiry]
|
688
639
|
|
689
640
|
# @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry#credit_block
|
690
641
|
class CreditBlock < Orb::Internal::Type::BaseModel
|
@@ -703,14 +654,10 @@ module Orb
|
|
703
654
|
# @return [String, nil]
|
704
655
|
required :per_unit_cost_basis, String, nil?: true
|
705
656
|
|
706
|
-
# @!
|
707
|
-
#
|
708
|
-
#
|
709
|
-
#
|
710
|
-
# #
|
711
|
-
# def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
|
712
|
-
|
713
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
657
|
+
# @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
|
658
|
+
# @param id [String]
|
659
|
+
# @param expiry_date [Time, nil]
|
660
|
+
# @param per_unit_cost_basis [String, nil]
|
714
661
|
end
|
715
662
|
|
716
663
|
# @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry#customer
|
@@ -725,13 +672,9 @@ module Orb
|
|
725
672
|
# @return [String, nil]
|
726
673
|
required :external_customer_id, String, nil?: true
|
727
674
|
|
728
|
-
# @!
|
729
|
-
#
|
730
|
-
#
|
731
|
-
# #
|
732
|
-
# def initialize(id:, external_customer_id:, **) = super
|
733
|
-
|
734
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
675
|
+
# @!method initialize(id:, external_customer_id:)
|
676
|
+
# @param id [String]
|
677
|
+
# @param external_customer_id [String, nil]
|
735
678
|
end
|
736
679
|
|
737
680
|
# @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry#entry_status
|
@@ -741,11 +684,8 @@ module Orb
|
|
741
684
|
COMMITTED = :committed
|
742
685
|
PENDING = :pending
|
743
686
|
|
744
|
-
|
745
|
-
|
746
|
-
# @!parse
|
747
|
-
# # @return [Array<Symbol>]
|
748
|
-
# def self.values; end
|
687
|
+
# @!method self.values
|
688
|
+
# @return [Array<Symbol>]
|
749
689
|
end
|
750
690
|
end
|
751
691
|
|
@@ -832,45 +772,41 @@ module Orb
|
|
832
772
|
# @return [String, nil]
|
833
773
|
required :void_reason, String, nil?: true
|
834
774
|
|
835
|
-
# @!
|
836
|
-
#
|
837
|
-
#
|
838
|
-
#
|
839
|
-
#
|
840
|
-
#
|
841
|
-
#
|
842
|
-
#
|
843
|
-
#
|
844
|
-
#
|
845
|
-
#
|
846
|
-
#
|
847
|
-
#
|
848
|
-
#
|
849
|
-
#
|
850
|
-
#
|
851
|
-
#
|
852
|
-
#
|
853
|
-
#
|
854
|
-
#
|
855
|
-
#
|
856
|
-
#
|
857
|
-
#
|
858
|
-
#
|
859
|
-
#
|
860
|
-
#
|
861
|
-
#
|
862
|
-
#
|
863
|
-
#
|
864
|
-
#
|
865
|
-
#
|
866
|
-
#
|
867
|
-
#
|
868
|
-
#
|
869
|
-
#
|
870
|
-
# super
|
871
|
-
# end
|
872
|
-
|
873
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
775
|
+
# @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, void_amount:, void_reason:, entry_type: :void)
|
776
|
+
# Some parameter documentations has been truncated, see
|
777
|
+
# {Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry}
|
778
|
+
# for more details.
|
779
|
+
#
|
780
|
+
# @param id [String]
|
781
|
+
#
|
782
|
+
# @param amount [Float]
|
783
|
+
#
|
784
|
+
# @param created_at [Time]
|
785
|
+
#
|
786
|
+
# @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry::CreditBlock]
|
787
|
+
#
|
788
|
+
# @param currency [String]
|
789
|
+
#
|
790
|
+
# @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry::Customer]
|
791
|
+
#
|
792
|
+
# @param description [String, nil]
|
793
|
+
#
|
794
|
+
# @param ending_balance [Float]
|
795
|
+
#
|
796
|
+
# @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry::EntryStatus]
|
797
|
+
#
|
798
|
+
# @param ledger_sequence_number [Integer]
|
799
|
+
#
|
800
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
801
|
+
# ...
|
802
|
+
#
|
803
|
+
# @param starting_balance [Float]
|
804
|
+
#
|
805
|
+
# @param void_amount [Float]
|
806
|
+
#
|
807
|
+
# @param void_reason [String, nil]
|
808
|
+
#
|
809
|
+
# @param entry_type [Symbol, :void]
|
874
810
|
|
875
811
|
# @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry#credit_block
|
876
812
|
class CreditBlock < Orb::Internal::Type::BaseModel
|
@@ -889,14 +825,10 @@ module Orb
|
|
889
825
|
# @return [String, nil]
|
890
826
|
required :per_unit_cost_basis, String, nil?: true
|
891
827
|
|
892
|
-
# @!
|
893
|
-
#
|
894
|
-
#
|
895
|
-
#
|
896
|
-
# #
|
897
|
-
# def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
|
898
|
-
|
899
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
828
|
+
# @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
|
829
|
+
# @param id [String]
|
830
|
+
# @param expiry_date [Time, nil]
|
831
|
+
# @param per_unit_cost_basis [String, nil]
|
900
832
|
end
|
901
833
|
|
902
834
|
# @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry#customer
|
@@ -911,13 +843,9 @@ module Orb
|
|
911
843
|
# @return [String, nil]
|
912
844
|
required :external_customer_id, String, nil?: true
|
913
845
|
|
914
|
-
# @!
|
915
|
-
#
|
916
|
-
#
|
917
|
-
# #
|
918
|
-
# def initialize(id:, external_customer_id:, **) = super
|
919
|
-
|
920
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
846
|
+
# @!method initialize(id:, external_customer_id:)
|
847
|
+
# @param id [String]
|
848
|
+
# @param external_customer_id [String, nil]
|
921
849
|
end
|
922
850
|
|
923
851
|
# @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry#entry_status
|
@@ -927,11 +855,8 @@ module Orb
|
|
927
855
|
COMMITTED = :committed
|
928
856
|
PENDING = :pending
|
929
857
|
|
930
|
-
|
931
|
-
|
932
|
-
# @!parse
|
933
|
-
# # @return [Array<Symbol>]
|
934
|
-
# def self.values; end
|
858
|
+
# @!method self.values
|
859
|
+
# @return [Array<Symbol>]
|
935
860
|
end
|
936
861
|
end
|
937
862
|
|
@@ -1023,47 +948,43 @@ module Orb
|
|
1023
948
|
# @return [String, nil]
|
1024
949
|
required :void_reason, String, nil?: true
|
1025
950
|
|
1026
|
-
# @!
|
1027
|
-
#
|
1028
|
-
#
|
1029
|
-
#
|
1030
|
-
#
|
1031
|
-
#
|
1032
|
-
#
|
1033
|
-
#
|
1034
|
-
#
|
1035
|
-
#
|
1036
|
-
#
|
1037
|
-
#
|
1038
|
-
#
|
1039
|
-
#
|
1040
|
-
#
|
1041
|
-
#
|
1042
|
-
#
|
1043
|
-
#
|
1044
|
-
#
|
1045
|
-
#
|
1046
|
-
#
|
1047
|
-
#
|
1048
|
-
#
|
1049
|
-
#
|
1050
|
-
#
|
1051
|
-
#
|
1052
|
-
#
|
1053
|
-
#
|
1054
|
-
#
|
1055
|
-
#
|
1056
|
-
#
|
1057
|
-
#
|
1058
|
-
#
|
1059
|
-
#
|
1060
|
-
#
|
1061
|
-
#
|
1062
|
-
#
|
1063
|
-
# super
|
1064
|
-
# end
|
1065
|
-
|
1066
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
951
|
+
# @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, new_block_expiry_date:, starting_balance:, void_amount:, void_reason:, entry_type: :void_initiated)
|
952
|
+
# Some parameter documentations has been truncated, see
|
953
|
+
# {Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry}
|
954
|
+
# for more details.
|
955
|
+
#
|
956
|
+
# @param id [String]
|
957
|
+
#
|
958
|
+
# @param amount [Float]
|
959
|
+
#
|
960
|
+
# @param created_at [Time]
|
961
|
+
#
|
962
|
+
# @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry::CreditBlock]
|
963
|
+
#
|
964
|
+
# @param currency [String]
|
965
|
+
#
|
966
|
+
# @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry::Customer]
|
967
|
+
#
|
968
|
+
# @param description [String, nil]
|
969
|
+
#
|
970
|
+
# @param ending_balance [Float]
|
971
|
+
#
|
972
|
+
# @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry::EntryStatus]
|
973
|
+
#
|
974
|
+
# @param ledger_sequence_number [Integer]
|
975
|
+
#
|
976
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
977
|
+
# ...
|
978
|
+
#
|
979
|
+
# @param new_block_expiry_date [Time]
|
980
|
+
#
|
981
|
+
# @param starting_balance [Float]
|
982
|
+
#
|
983
|
+
# @param void_amount [Float]
|
984
|
+
#
|
985
|
+
# @param void_reason [String, nil]
|
986
|
+
#
|
987
|
+
# @param entry_type [Symbol, :void_initiated]
|
1067
988
|
|
1068
989
|
# @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry#credit_block
|
1069
990
|
class CreditBlock < Orb::Internal::Type::BaseModel
|
@@ -1082,14 +1003,10 @@ module Orb
|
|
1082
1003
|
# @return [String, nil]
|
1083
1004
|
required :per_unit_cost_basis, String, nil?: true
|
1084
1005
|
|
1085
|
-
# @!
|
1086
|
-
#
|
1087
|
-
#
|
1088
|
-
#
|
1089
|
-
# #
|
1090
|
-
# def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
|
1091
|
-
|
1092
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1006
|
+
# @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
|
1007
|
+
# @param id [String]
|
1008
|
+
# @param expiry_date [Time, nil]
|
1009
|
+
# @param per_unit_cost_basis [String, nil]
|
1093
1010
|
end
|
1094
1011
|
|
1095
1012
|
# @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry#customer
|
@@ -1104,13 +1021,9 @@ module Orb
|
|
1104
1021
|
# @return [String, nil]
|
1105
1022
|
required :external_customer_id, String, nil?: true
|
1106
1023
|
|
1107
|
-
# @!
|
1108
|
-
#
|
1109
|
-
#
|
1110
|
-
# #
|
1111
|
-
# def initialize(id:, external_customer_id:, **) = super
|
1112
|
-
|
1113
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1024
|
+
# @!method initialize(id:, external_customer_id:)
|
1025
|
+
# @param id [String]
|
1026
|
+
# @param external_customer_id [String, nil]
|
1114
1027
|
end
|
1115
1028
|
|
1116
1029
|
# @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry#entry_status
|
@@ -1120,11 +1033,8 @@ module Orb
|
|
1120
1033
|
COMMITTED = :committed
|
1121
1034
|
PENDING = :pending
|
1122
1035
|
|
1123
|
-
|
1124
|
-
|
1125
|
-
# @!parse
|
1126
|
-
# # @return [Array<Symbol>]
|
1127
|
-
# def self.values; end
|
1036
|
+
# @!method self.values
|
1037
|
+
# @return [Array<Symbol>]
|
1128
1038
|
end
|
1129
1039
|
end
|
1130
1040
|
|
@@ -1201,41 +1111,37 @@ module Orb
|
|
1201
1111
|
# @return [Float]
|
1202
1112
|
required :starting_balance, Float
|
1203
1113
|
|
1204
|
-
# @!
|
1205
|
-
#
|
1206
|
-
#
|
1207
|
-
#
|
1208
|
-
#
|
1209
|
-
#
|
1210
|
-
#
|
1211
|
-
#
|
1212
|
-
#
|
1213
|
-
#
|
1214
|
-
#
|
1215
|
-
#
|
1216
|
-
#
|
1217
|
-
#
|
1218
|
-
#
|
1219
|
-
#
|
1220
|
-
#
|
1221
|
-
#
|
1222
|
-
#
|
1223
|
-
#
|
1224
|
-
#
|
1225
|
-
#
|
1226
|
-
#
|
1227
|
-
#
|
1228
|
-
#
|
1229
|
-
#
|
1230
|
-
#
|
1231
|
-
#
|
1232
|
-
#
|
1233
|
-
#
|
1234
|
-
#
|
1235
|
-
# super
|
1236
|
-
# end
|
1237
|
-
|
1238
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1114
|
+
# @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :amendment)
|
1115
|
+
# Some parameter documentations has been truncated, see
|
1116
|
+
# {Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry}
|
1117
|
+
# for more details.
|
1118
|
+
#
|
1119
|
+
# @param id [String]
|
1120
|
+
#
|
1121
|
+
# @param amount [Float]
|
1122
|
+
#
|
1123
|
+
# @param created_at [Time]
|
1124
|
+
#
|
1125
|
+
# @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry::CreditBlock]
|
1126
|
+
#
|
1127
|
+
# @param currency [String]
|
1128
|
+
#
|
1129
|
+
# @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry::Customer]
|
1130
|
+
#
|
1131
|
+
# @param description [String, nil]
|
1132
|
+
#
|
1133
|
+
# @param ending_balance [Float]
|
1134
|
+
#
|
1135
|
+
# @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry::EntryStatus]
|
1136
|
+
#
|
1137
|
+
# @param ledger_sequence_number [Integer]
|
1138
|
+
#
|
1139
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
1140
|
+
# ...
|
1141
|
+
#
|
1142
|
+
# @param starting_balance [Float]
|
1143
|
+
#
|
1144
|
+
# @param entry_type [Symbol, :amendment]
|
1239
1145
|
|
1240
1146
|
# @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry#credit_block
|
1241
1147
|
class CreditBlock < Orb::Internal::Type::BaseModel
|
@@ -1254,14 +1160,10 @@ module Orb
|
|
1254
1160
|
# @return [String, nil]
|
1255
1161
|
required :per_unit_cost_basis, String, nil?: true
|
1256
1162
|
|
1257
|
-
# @!
|
1258
|
-
#
|
1259
|
-
#
|
1260
|
-
#
|
1261
|
-
# #
|
1262
|
-
# def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
|
1263
|
-
|
1264
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1163
|
+
# @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
|
1164
|
+
# @param id [String]
|
1165
|
+
# @param expiry_date [Time, nil]
|
1166
|
+
# @param per_unit_cost_basis [String, nil]
|
1265
1167
|
end
|
1266
1168
|
|
1267
1169
|
# @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry#customer
|
@@ -1276,13 +1178,9 @@ module Orb
|
|
1276
1178
|
# @return [String, nil]
|
1277
1179
|
required :external_customer_id, String, nil?: true
|
1278
1180
|
|
1279
|
-
# @!
|
1280
|
-
#
|
1281
|
-
#
|
1282
|
-
# #
|
1283
|
-
# def initialize(id:, external_customer_id:, **) = super
|
1284
|
-
|
1285
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1181
|
+
# @!method initialize(id:, external_customer_id:)
|
1182
|
+
# @param id [String]
|
1183
|
+
# @param external_customer_id [String, nil]
|
1286
1184
|
end
|
1287
1185
|
|
1288
1186
|
# @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry#entry_status
|
@@ -1292,17 +1190,13 @@ module Orb
|
|
1292
1190
|
COMMITTED = :committed
|
1293
1191
|
PENDING = :pending
|
1294
1192
|
|
1295
|
-
|
1296
|
-
|
1297
|
-
# @!parse
|
1298
|
-
# # @return [Array<Symbol>]
|
1299
|
-
# def self.values; end
|
1193
|
+
# @!method self.values
|
1194
|
+
# @return [Array<Symbol>]
|
1300
1195
|
end
|
1301
1196
|
end
|
1302
1197
|
|
1303
|
-
# @!
|
1304
|
-
#
|
1305
|
-
# def self.variants; end
|
1198
|
+
# @!method self.variants
|
1199
|
+
# @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)]
|
1306
1200
|
end
|
1307
1201
|
end
|
1308
1202
|
end
|