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