orb-billing 0.2.0 → 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/CHANGELOG.md +34 -0
- data/README.md +59 -49
- data/lib/orb/client.rb +4 -4
- data/lib/orb/file_part.rb +55 -0
- data/lib/orb/internal/page.rb +4 -8
- data/lib/orb/internal/transport/base_client.rb +7 -7
- data/lib/orb/internal/transport/pooled_net_requester.rb +2 -2
- data/lib/orb/internal/type/array_of.rb +11 -0
- data/lib/orb/internal/type/base_model.rb +32 -14
- data/lib/orb/internal/type/base_page.rb +9 -1
- data/lib/orb/internal/type/boolean.rb +4 -0
- data/lib/orb/internal/type/converter.rb +4 -1
- data/lib/orb/internal/type/enum.rb +9 -5
- data/lib/orb/internal/type/{io_like.rb → file_input.rb} +33 -15
- data/lib/orb/internal/type/hash_of.rb +11 -0
- data/lib/orb/internal/type/request_parameters.rb +1 -2
- data/lib/orb/internal/type/union.rb +10 -1
- data/lib/orb/internal/type/unknown.rb +4 -0
- data/lib/orb/internal/util.rb +69 -61
- data/lib/orb/internal.rb +0 -1
- data/lib/orb/models/alert.rb +68 -71
- data/lib/orb/models/alert_create_for_customer_params.rb +20 -25
- data/lib/orb/models/alert_create_for_external_customer_params.rb +20 -25
- data/lib/orb/models/alert_create_for_subscription_params.rb +20 -25
- data/lib/orb/models/alert_disable_params.rb +5 -9
- data/lib/orb/models/alert_enable_params.rb +5 -9
- data/lib/orb/models/alert_list_params.rb +26 -36
- data/lib/orb/models/alert_retrieve_params.rb +3 -8
- data/lib/orb/models/alert_update_params.rb +14 -18
- data/lib/orb/models/amount_discount.rb +14 -14
- data/lib/orb/models/billable_metric.rb +23 -20
- data/lib/orb/models/billing_cycle_relative_date.rb +2 -5
- data/lib/orb/models/coupon.rb +28 -21
- data/lib/orb/models/coupon_archive_params.rb +3 -8
- data/lib/orb/models/coupon_create_params.rb +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 +4 -4
- data/rbi/lib/orb/file_part.rbi +34 -0
- data/rbi/lib/orb/internal/transport/base_client.rbi +17 -3
- data/rbi/lib/orb/internal/type/array_of.rbi +3 -0
- data/rbi/lib/orb/internal/type/base_model.rbi +7 -1
- data/rbi/lib/orb/internal/type/base_page.rbi +2 -0
- data/rbi/lib/orb/internal/type/enum.rbi +3 -6
- data/rbi/lib/orb/internal/type/{io_like.rbi → file_input.rbi} +5 -2
- data/rbi/lib/orb/internal/type/hash_of.rbi +3 -0
- data/rbi/lib/orb/internal/type/union.rbi +3 -0
- data/rbi/lib/orb/internal/util.rbi +24 -19
- data/rbi/lib/orb/internal.rbi +0 -1
- 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 +2 -0
- data/sig/orb/internal/type/base_model.rbs +4 -0
- data/sig/orb/internal/type/enum.rbs +2 -2
- data/sig/orb/internal/type/{io_like.rbs → file_input.rbs} +1 -1
- data/sig/orb/internal/type/hash_of.rbs +2 -0
- data/sig/orb/internal/type/union.rbs +2 -0
- data/sig/orb/internal/util.rbs +14 -12
- metadata +8 -5
@@ -37,22 +37,27 @@ module Orb
|
|
37
37
|
# @return [Time, nil]
|
38
38
|
optional :cancelled_at, Time, nil?: true
|
39
39
|
|
40
|
-
# @!
|
41
|
-
#
|
42
|
-
#
|
43
|
-
#
|
44
|
-
#
|
45
|
-
#
|
46
|
-
#
|
47
|
-
#
|
48
|
-
#
|
49
|
-
#
|
50
|
-
#
|
51
|
-
#
|
52
|
-
#
|
53
|
-
#
|
54
|
-
|
55
|
-
#
|
40
|
+
# @!method initialize(id:, expiration_time:, status:, subscription:, applied_at: nil, cancelled_at: nil)
|
41
|
+
# Some parameter documentations has been truncated, see
|
42
|
+
# {Orb::Models::SubscriptionChangeRetrieveResponse} for more details.
|
43
|
+
#
|
44
|
+
# A subscription change represents a desired new subscription / pending change to
|
45
|
+
# an existing subscription. It is a way to first preview the effects on the
|
46
|
+
# subscription as well as any changes/creation of invoices (see
|
47
|
+
# `subscription.changed_resources`).
|
48
|
+
#
|
49
|
+
# @param id [String]
|
50
|
+
#
|
51
|
+
# @param expiration_time [Time] Subscription change will be cancelled at this time and can no longer be applied.
|
52
|
+
# ...
|
53
|
+
#
|
54
|
+
# @param status [Symbol, Orb::Models::SubscriptionChangeRetrieveResponse::Status]
|
55
|
+
#
|
56
|
+
# @param subscription [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription, nil]
|
57
|
+
#
|
58
|
+
# @param applied_at [Time, nil] When this change was applied.
|
59
|
+
#
|
60
|
+
# @param cancelled_at [Time, nil] When this change was cancelled.
|
56
61
|
|
57
62
|
# @see Orb::Models::SubscriptionChangeRetrieveResponse#status
|
58
63
|
module Status
|
@@ -62,11 +67,8 @@ module Orb
|
|
62
67
|
APPLIED = :applied
|
63
68
|
CANCELLED = :cancelled
|
64
69
|
|
65
|
-
|
66
|
-
|
67
|
-
# @!parse
|
68
|
-
# # @return [Array<Symbol>]
|
69
|
-
# def self.values; end
|
70
|
+
# @!method self.values
|
71
|
+
# @return [Array<Symbol>]
|
70
72
|
end
|
71
73
|
|
72
74
|
# @see Orb::Models::SubscriptionChangeRetrieveResponse#subscription
|
@@ -278,69 +280,76 @@ module Orb
|
|
278
280
|
-> { Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::ChangedResources },
|
279
281
|
nil?: true
|
280
282
|
|
281
|
-
# @!
|
282
|
-
#
|
283
|
-
#
|
284
|
-
#
|
285
|
-
#
|
286
|
-
#
|
287
|
-
#
|
288
|
-
#
|
289
|
-
#
|
290
|
-
#
|
291
|
-
#
|
292
|
-
#
|
293
|
-
#
|
294
|
-
#
|
295
|
-
#
|
296
|
-
#
|
297
|
-
#
|
298
|
-
#
|
299
|
-
#
|
300
|
-
#
|
301
|
-
#
|
302
|
-
#
|
303
|
-
#
|
304
|
-
#
|
305
|
-
#
|
306
|
-
#
|
307
|
-
#
|
308
|
-
#
|
309
|
-
#
|
310
|
-
#
|
311
|
-
#
|
312
|
-
#
|
313
|
-
#
|
314
|
-
#
|
315
|
-
#
|
316
|
-
#
|
317
|
-
#
|
318
|
-
#
|
319
|
-
#
|
320
|
-
#
|
321
|
-
#
|
322
|
-
#
|
323
|
-
#
|
324
|
-
#
|
325
|
-
#
|
326
|
-
#
|
327
|
-
#
|
328
|
-
#
|
329
|
-
#
|
330
|
-
#
|
331
|
-
#
|
332
|
-
#
|
333
|
-
#
|
334
|
-
#
|
335
|
-
#
|
336
|
-
#
|
337
|
-
#
|
338
|
-
#
|
339
|
-
#
|
340
|
-
#
|
341
|
-
#
|
342
|
-
|
343
|
-
#
|
283
|
+
# @!method initialize(id:, active_plan_phase_order:, adjustment_intervals:, auto_collection:, billing_cycle_anchor_configuration:, billing_cycle_day:, created_at:, current_billing_period_end_date:, current_billing_period_start_date:, customer:, default_invoice_memo:, discount_intervals:, end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, maximum_intervals:, metadata:, minimum_intervals:, net_terms:, pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, trial_info:, changed_resources: nil)
|
284
|
+
# Some parameter documentations has been truncated, see
|
285
|
+
# {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription} for more
|
286
|
+
# details.
|
287
|
+
#
|
288
|
+
# @param id [String]
|
289
|
+
#
|
290
|
+
# @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase
|
291
|
+
# ...
|
292
|
+
#
|
293
|
+
# @param adjustment_intervals [Array<Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval>] The adjustment intervals for this subscription sorted by the start_date of the a
|
294
|
+
# ...
|
295
|
+
#
|
296
|
+
# @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c
|
297
|
+
# ...
|
298
|
+
#
|
299
|
+
# @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::BillingCycleAnchorConfiguration]
|
300
|
+
#
|
301
|
+
# @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
|
302
|
+
# ...
|
303
|
+
#
|
304
|
+
# @param created_at [Time]
|
305
|
+
#
|
306
|
+
# @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
|
307
|
+
# ...
|
308
|
+
#
|
309
|
+
# @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
|
310
|
+
# ...
|
311
|
+
#
|
312
|
+
# @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
|
313
|
+
# ...
|
314
|
+
#
|
315
|
+
# @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
|
316
|
+
# ...
|
317
|
+
#
|
318
|
+
# @param discount_intervals [Array<Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::UsageDiscountInterval>] The discount intervals for this subscription sorted by the start_date.
|
319
|
+
#
|
320
|
+
# @param end_date [Time, nil] The date Orb stops billing for this subscription.
|
321
|
+
#
|
322
|
+
# @param fixed_fee_quantity_schedule [Array<Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::FixedFeeQuantitySchedule>]
|
323
|
+
#
|
324
|
+
# @param invoicing_threshold [String, nil]
|
325
|
+
#
|
326
|
+
# @param maximum_intervals [Array<Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MaximumInterval>] The maximum intervals for this subscription sorted by the start_date.
|
327
|
+
#
|
328
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
329
|
+
# ...
|
330
|
+
#
|
331
|
+
# @param minimum_intervals [Array<Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
|
332
|
+
#
|
333
|
+
# @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
|
334
|
+
# ...
|
335
|
+
#
|
336
|
+
# @param pending_subscription_change [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
|
337
|
+
#
|
338
|
+
# @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
339
|
+
# ...
|
340
|
+
#
|
341
|
+
# @param price_intervals [Array<Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval>] The price intervals for this subscription.
|
342
|
+
#
|
343
|
+
# @param redeemed_coupon [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::RedeemedCoupon, nil]
|
344
|
+
#
|
345
|
+
# @param start_date [Time] The date Orb starts billing for this subscription.
|
346
|
+
#
|
347
|
+
# @param status [Symbol, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::Status]
|
348
|
+
#
|
349
|
+
# @param trial_info [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::TrialInfo]
|
350
|
+
#
|
351
|
+
# @param changed_resources [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::ChangedResources, nil] The resources that were changed as part of this operation. Only present when fet
|
352
|
+
# ...
|
344
353
|
|
345
354
|
class AdjustmentInterval < Orb::Internal::Type::BaseModel
|
346
355
|
# @!attribute id
|
@@ -372,16 +381,16 @@ module Orb
|
|
372
381
|
# @return [Time]
|
373
382
|
required :start_date, Time
|
374
383
|
|
375
|
-
# @!
|
376
|
-
#
|
377
|
-
#
|
378
|
-
#
|
379
|
-
#
|
380
|
-
#
|
381
|
-
#
|
382
|
-
#
|
383
|
-
|
384
|
-
#
|
384
|
+
# @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:)
|
385
|
+
# @param id [String]
|
386
|
+
#
|
387
|
+
# @param adjustment [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment]
|
388
|
+
#
|
389
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval IDs that this adjustment applies to.
|
390
|
+
#
|
391
|
+
# @param end_date [Time, nil] The end date of the adjustment interval.
|
392
|
+
#
|
393
|
+
# @param start_date [Time] The start date of the adjustment interval.
|
385
394
|
|
386
395
|
# @see Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval#adjustment
|
387
396
|
module Adjustment
|
@@ -447,29 +456,26 @@ module Orb
|
|
447
456
|
# @return [Float]
|
448
457
|
required :usage_discount, Float
|
449
458
|
|
450
|
-
# @!
|
451
|
-
#
|
452
|
-
#
|
453
|
-
#
|
454
|
-
#
|
455
|
-
#
|
456
|
-
#
|
457
|
-
#
|
458
|
-
#
|
459
|
-
#
|
460
|
-
#
|
461
|
-
#
|
462
|
-
#
|
463
|
-
#
|
464
|
-
#
|
465
|
-
#
|
466
|
-
#
|
467
|
-
#
|
468
|
-
#
|
469
|
-
#
|
470
|
-
# end
|
471
|
-
|
472
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
459
|
+
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
460
|
+
# Some parameter documentations has been truncated, see
|
461
|
+
# {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment}
|
462
|
+
# for more details.
|
463
|
+
#
|
464
|
+
# @param id [String]
|
465
|
+
#
|
466
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
467
|
+
#
|
468
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
469
|
+
# ...
|
470
|
+
#
|
471
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
472
|
+
#
|
473
|
+
# @param reason [String, nil] The reason for the adjustment.
|
474
|
+
#
|
475
|
+
# @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
|
476
|
+
# ...
|
477
|
+
#
|
478
|
+
# @param adjustment_type [Symbol, :usage_discount]
|
473
479
|
end
|
474
480
|
|
475
481
|
class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
|
@@ -515,29 +521,26 @@ module Orb
|
|
515
521
|
# @return [String, nil]
|
516
522
|
required :reason, String, nil?: true
|
517
523
|
|
518
|
-
# @!
|
519
|
-
#
|
520
|
-
#
|
521
|
-
#
|
522
|
-
#
|
523
|
-
#
|
524
|
-
#
|
525
|
-
#
|
526
|
-
#
|
527
|
-
#
|
528
|
-
#
|
529
|
-
#
|
530
|
-
#
|
531
|
-
#
|
532
|
-
#
|
533
|
-
#
|
534
|
-
#
|
535
|
-
#
|
536
|
-
#
|
537
|
-
#
|
538
|
-
# end
|
539
|
-
|
540
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
524
|
+
# @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
|
525
|
+
# Some parameter documentations has been truncated, see
|
526
|
+
# {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment}
|
527
|
+
# for more details.
|
528
|
+
#
|
529
|
+
# @param id [String]
|
530
|
+
#
|
531
|
+
# @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
|
532
|
+
# ...
|
533
|
+
#
|
534
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
535
|
+
#
|
536
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
537
|
+
# ...
|
538
|
+
#
|
539
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
540
|
+
#
|
541
|
+
# @param reason [String, nil] The reason for the adjustment.
|
542
|
+
#
|
543
|
+
# @param adjustment_type [Symbol, :amount_discount]
|
541
544
|
end
|
542
545
|
|
543
546
|
class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
|
@@ -583,29 +586,26 @@ module Orb
|
|
583
586
|
# @return [String, nil]
|
584
587
|
required :reason, String, nil?: true
|
585
588
|
|
586
|
-
# @!
|
587
|
-
#
|
588
|
-
#
|
589
|
-
#
|
590
|
-
#
|
591
|
-
#
|
592
|
-
#
|
593
|
-
#
|
594
|
-
#
|
595
|
-
#
|
596
|
-
#
|
597
|
-
#
|
598
|
-
#
|
599
|
-
#
|
600
|
-
#
|
601
|
-
#
|
602
|
-
#
|
603
|
-
#
|
604
|
-
#
|
605
|
-
#
|
606
|
-
# end
|
607
|
-
|
608
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
589
|
+
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
|
590
|
+
# Some parameter documentations has been truncated, see
|
591
|
+
# {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment}
|
592
|
+
# for more details.
|
593
|
+
#
|
594
|
+
# @param id [String]
|
595
|
+
#
|
596
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
597
|
+
#
|
598
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
599
|
+
# ...
|
600
|
+
#
|
601
|
+
# @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
|
602
|
+
# ...
|
603
|
+
#
|
604
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
605
|
+
#
|
606
|
+
# @param reason [String, nil] The reason for the adjustment.
|
607
|
+
#
|
608
|
+
# @param adjustment_type [Symbol, :percentage_discount]
|
609
609
|
end
|
610
610
|
|
611
611
|
class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel
|
@@ -657,31 +657,28 @@ module Orb
|
|
657
657
|
# @return [String, nil]
|
658
658
|
required :reason, String, nil?: true
|
659
659
|
|
660
|
-
# @!
|
661
|
-
#
|
662
|
-
#
|
663
|
-
#
|
664
|
-
#
|
665
|
-
#
|
666
|
-
#
|
667
|
-
#
|
668
|
-
#
|
669
|
-
#
|
670
|
-
#
|
671
|
-
#
|
672
|
-
#
|
673
|
-
#
|
674
|
-
#
|
675
|
-
#
|
676
|
-
#
|
677
|
-
#
|
678
|
-
#
|
679
|
-
#
|
680
|
-
#
|
681
|
-
#
|
682
|
-
# end
|
683
|
-
|
684
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
660
|
+
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
|
661
|
+
# Some parameter documentations has been truncated, see
|
662
|
+
# {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment}
|
663
|
+
# for more details.
|
664
|
+
#
|
665
|
+
# @param id [String]
|
666
|
+
#
|
667
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
668
|
+
#
|
669
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
670
|
+
# ...
|
671
|
+
#
|
672
|
+
# @param item_id [String] The item ID that revenue from this minimum will be attributed to.
|
673
|
+
#
|
674
|
+
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
|
675
|
+
# ...
|
676
|
+
#
|
677
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
678
|
+
#
|
679
|
+
# @param reason [String, nil] The reason for the adjustment.
|
680
|
+
#
|
681
|
+
# @param adjustment_type [Symbol, :minimum]
|
685
682
|
end
|
686
683
|
|
687
684
|
class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel
|
@@ -727,34 +724,30 @@ module Orb
|
|
727
724
|
# @return [String, nil]
|
728
725
|
required :reason, String, nil?: true
|
729
726
|
|
730
|
-
# @!
|
731
|
-
#
|
732
|
-
#
|
733
|
-
#
|
734
|
-
#
|
735
|
-
#
|
736
|
-
#
|
737
|
-
#
|
738
|
-
#
|
739
|
-
#
|
740
|
-
#
|
741
|
-
#
|
742
|
-
#
|
743
|
-
#
|
744
|
-
#
|
745
|
-
#
|
746
|
-
#
|
747
|
-
#
|
748
|
-
#
|
749
|
-
#
|
750
|
-
# end
|
751
|
-
|
752
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
727
|
+
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
|
728
|
+
# Some parameter documentations has been truncated, see
|
729
|
+
# {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment}
|
730
|
+
# for more details.
|
731
|
+
#
|
732
|
+
# @param id [String]
|
733
|
+
#
|
734
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
735
|
+
#
|
736
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
737
|
+
# ...
|
738
|
+
#
|
739
|
+
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
|
740
|
+
# ...
|
741
|
+
#
|
742
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
743
|
+
#
|
744
|
+
# @param reason [String, nil] The reason for the adjustment.
|
745
|
+
#
|
746
|
+
# @param adjustment_type [Symbol, :maximum]
|
753
747
|
end
|
754
748
|
|
755
|
-
# @!
|
756
|
-
#
|
757
|
-
# def self.variants; end
|
749
|
+
# @!method self.variants
|
750
|
+
# @return [Array(Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)]
|
758
751
|
end
|
759
752
|
end
|
760
753
|
|
@@ -784,14 +777,19 @@ module Orb
|
|
784
777
|
# @return [Integer, nil]
|
785
778
|
optional :year, Integer, nil?: true
|
786
779
|
|
787
|
-
# @!
|
788
|
-
#
|
789
|
-
#
|
790
|
-
#
|
791
|
-
#
|
792
|
-
#
|
793
|
-
|
794
|
-
#
|
780
|
+
# @!method initialize(day:, month: nil, year: nil)
|
781
|
+
# Some parameter documentations has been truncated, see
|
782
|
+
# {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::BillingCycleAnchorConfiguration}
|
783
|
+
# for more details.
|
784
|
+
#
|
785
|
+
# @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
|
786
|
+
# ...
|
787
|
+
#
|
788
|
+
# @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore
|
789
|
+
# ...
|
790
|
+
#
|
791
|
+
# @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc
|
792
|
+
# ...
|
795
793
|
end
|
796
794
|
|
797
795
|
module DiscountInterval
|
@@ -844,27 +842,18 @@ module Orb
|
|
844
842
|
# @return [Time]
|
845
843
|
required :start_date, Time
|
846
844
|
|
847
|
-
# @!
|
848
|
-
#
|
849
|
-
#
|
850
|
-
#
|
851
|
-
#
|
852
|
-
#
|
853
|
-
#
|
854
|
-
#
|
855
|
-
#
|
856
|
-
#
|
857
|
-
#
|
858
|
-
#
|
859
|
-
# end_date:,
|
860
|
-
# start_date:,
|
861
|
-
# discount_type: :amount,
|
862
|
-
# **
|
863
|
-
# )
|
864
|
-
# super
|
865
|
-
# end
|
866
|
-
|
867
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
845
|
+
# @!method initialize(amount_discount:, applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, discount_type: :amount)
|
846
|
+
# @param amount_discount [String] Only available if discount_type is `amount`.
|
847
|
+
#
|
848
|
+
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
849
|
+
#
|
850
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
|
851
|
+
#
|
852
|
+
# @param end_date [Time, nil] The end date of the discount interval.
|
853
|
+
#
|
854
|
+
# @param start_date [Time] The start date of the discount interval.
|
855
|
+
#
|
856
|
+
# @param discount_type [Symbol, :amount]
|
868
857
|
end
|
869
858
|
|
870
859
|
class PercentageDiscountInterval < Orb::Internal::Type::BaseModel
|
@@ -904,27 +893,23 @@ module Orb
|
|
904
893
|
# @return [Time]
|
905
894
|
required :start_date, Time
|
906
895
|
|
907
|
-
# @!
|
908
|
-
#
|
909
|
-
#
|
910
|
-
#
|
911
|
-
#
|
912
|
-
#
|
913
|
-
#
|
914
|
-
#
|
915
|
-
#
|
916
|
-
#
|
917
|
-
#
|
918
|
-
#
|
919
|
-
#
|
920
|
-
#
|
921
|
-
#
|
922
|
-
#
|
923
|
-
#
|
924
|
-
# super
|
925
|
-
# end
|
926
|
-
|
927
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
896
|
+
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage)
|
897
|
+
# Some parameter documentations has been truncated, see
|
898
|
+
# {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::PercentageDiscountInterval}
|
899
|
+
# for more details.
|
900
|
+
#
|
901
|
+
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
902
|
+
#
|
903
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
|
904
|
+
#
|
905
|
+
# @param end_date [Time, nil] The end date of the discount interval.
|
906
|
+
#
|
907
|
+
# @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1
|
908
|
+
# ...
|
909
|
+
#
|
910
|
+
# @param start_date [Time] The start date of the discount interval.
|
911
|
+
#
|
912
|
+
# @param discount_type [Symbol, :percentage]
|
928
913
|
end
|
929
914
|
|
930
915
|
class UsageDiscountInterval < Orb::Internal::Type::BaseModel
|
@@ -964,32 +949,27 @@ module Orb
|
|
964
949
|
# @return [Float]
|
965
950
|
required :usage_discount, Float
|
966
951
|
|
967
|
-
# @!
|
968
|
-
#
|
969
|
-
#
|
970
|
-
#
|
971
|
-
#
|
972
|
-
#
|
973
|
-
#
|
974
|
-
#
|
975
|
-
#
|
976
|
-
#
|
977
|
-
#
|
978
|
-
#
|
979
|
-
#
|
980
|
-
#
|
981
|
-
#
|
982
|
-
#
|
983
|
-
#
|
984
|
-
# super
|
985
|
-
# end
|
986
|
-
|
987
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
952
|
+
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage)
|
953
|
+
# Some parameter documentations has been truncated, see
|
954
|
+
# {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::UsageDiscountInterval}
|
955
|
+
# for more details.
|
956
|
+
#
|
957
|
+
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
958
|
+
#
|
959
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
|
960
|
+
#
|
961
|
+
# @param end_date [Time, nil] The end date of the discount interval.
|
962
|
+
#
|
963
|
+
# @param start_date [Time] The start date of the discount interval.
|
964
|
+
#
|
965
|
+
# @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
|
966
|
+
# ...
|
967
|
+
#
|
968
|
+
# @param discount_type [Symbol, :usage]
|
988
969
|
end
|
989
970
|
|
990
|
-
# @!
|
991
|
-
#
|
992
|
-
# def self.variants; end
|
971
|
+
# @!method self.variants
|
972
|
+
# @return [Array(Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::UsageDiscountInterval)]
|
993
973
|
end
|
994
974
|
|
995
975
|
class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
|
@@ -1013,15 +993,11 @@ module Orb
|
|
1013
993
|
# @return [Time]
|
1014
994
|
required :start_date, Time
|
1015
995
|
|
1016
|
-
# @!
|
1017
|
-
#
|
1018
|
-
#
|
1019
|
-
#
|
1020
|
-
#
|
1021
|
-
# #
|
1022
|
-
# def initialize(end_date:, price_id:, quantity:, start_date:, **) = super
|
1023
|
-
|
1024
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
996
|
+
# @!method initialize(end_date:, price_id:, quantity:, start_date:)
|
997
|
+
# @param end_date [Time, nil]
|
998
|
+
# @param price_id [String]
|
999
|
+
# @param quantity [Float]
|
1000
|
+
# @param start_date [Time]
|
1025
1001
|
end
|
1026
1002
|
|
1027
1003
|
class MaximumInterval < Orb::Internal::Type::BaseModel
|
@@ -1056,16 +1032,21 @@ module Orb
|
|
1056
1032
|
# @return [Time]
|
1057
1033
|
required :start_date, Time
|
1058
1034
|
|
1059
|
-
# @!
|
1060
|
-
#
|
1061
|
-
#
|
1062
|
-
#
|
1063
|
-
#
|
1064
|
-
#
|
1065
|
-
#
|
1066
|
-
#
|
1067
|
-
|
1068
|
-
#
|
1035
|
+
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:)
|
1036
|
+
# Some parameter documentations has been truncated, see
|
1037
|
+
# {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MaximumInterval}
|
1038
|
+
# for more details.
|
1039
|
+
#
|
1040
|
+
# @param applies_to_price_ids [Array<String>] The price ids that this maximum interval applies to.
|
1041
|
+
#
|
1042
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this maximum interval applies to.
|
1043
|
+
#
|
1044
|
+
# @param end_date [Time, nil] The end date of the maximum interval.
|
1045
|
+
#
|
1046
|
+
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t
|
1047
|
+
# ...
|
1048
|
+
#
|
1049
|
+
# @param start_date [Time] The start date of the maximum interval.
|
1069
1050
|
end
|
1070
1051
|
|
1071
1052
|
class MinimumInterval < Orb::Internal::Type::BaseModel
|
@@ -1100,16 +1081,21 @@ module Orb
|
|
1100
1081
|
# @return [Time]
|
1101
1082
|
required :start_date, Time
|
1102
1083
|
|
1103
|
-
# @!
|
1104
|
-
#
|
1105
|
-
#
|
1106
|
-
#
|
1107
|
-
#
|
1108
|
-
#
|
1109
|
-
#
|
1110
|
-
#
|
1111
|
-
|
1112
|
-
#
|
1084
|
+
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:)
|
1085
|
+
# Some parameter documentations has been truncated, see
|
1086
|
+
# {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MinimumInterval}
|
1087
|
+
# for more details.
|
1088
|
+
#
|
1089
|
+
# @param applies_to_price_ids [Array<String>] The price ids that this minimum interval applies to.
|
1090
|
+
#
|
1091
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this minimum interval applies to.
|
1092
|
+
#
|
1093
|
+
# @param end_date [Time, nil] The end date of the minimum interval.
|
1094
|
+
#
|
1095
|
+
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t
|
1096
|
+
# ...
|
1097
|
+
#
|
1098
|
+
# @param start_date [Time] The start date of the minimum interval.
|
1113
1099
|
end
|
1114
1100
|
|
1115
1101
|
# @see Orb::Models::SubscriptionChangeRetrieveResponse::Subscription#pending_subscription_change
|
@@ -1119,14 +1105,10 @@ module Orb
|
|
1119
1105
|
# @return [String]
|
1120
1106
|
required :id, String
|
1121
1107
|
|
1122
|
-
# @!
|
1123
|
-
#
|
1124
|
-
#
|
1125
|
-
#
|
1126
|
-
# #
|
1127
|
-
# def initialize(id:, **) = super
|
1128
|
-
|
1129
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1108
|
+
# @!method initialize(id:)
|
1109
|
+
# A pending subscription change if one exists on this subscription.
|
1110
|
+
#
|
1111
|
+
# @param id [String]
|
1130
1112
|
end
|
1131
1113
|
|
1132
1114
|
class PriceInterval < Orb::Internal::Type::BaseModel
|
@@ -1208,39 +1190,41 @@ module Orb
|
|
1208
1190
|
# @return [Array<String>, nil]
|
1209
1191
|
required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
|
1210
1192
|
|
1211
|
-
# @!
|
1212
|
-
#
|
1213
|
-
#
|
1214
|
-
#
|
1215
|
-
#
|
1216
|
-
#
|
1217
|
-
#
|
1218
|
-
#
|
1219
|
-
#
|
1220
|
-
#
|
1221
|
-
#
|
1222
|
-
#
|
1223
|
-
#
|
1224
|
-
#
|
1225
|
-
#
|
1226
|
-
#
|
1227
|
-
#
|
1228
|
-
#
|
1229
|
-
#
|
1230
|
-
#
|
1231
|
-
#
|
1232
|
-
#
|
1233
|
-
#
|
1234
|
-
#
|
1235
|
-
#
|
1236
|
-
#
|
1237
|
-
#
|
1238
|
-
#
|
1239
|
-
#
|
1240
|
-
#
|
1241
|
-
#
|
1242
|
-
|
1243
|
-
#
|
1193
|
+
# @!method initialize(id:, billing_cycle_day:, current_billing_period_end_date:, current_billing_period_start_date:, end_date:, filter:, fixed_fee_quantity_transitions:, price:, start_date:, usage_customer_ids:)
|
1194
|
+
# Some parameter documentations has been truncated, see
|
1195
|
+
# {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval}
|
1196
|
+
# for more details.
|
1197
|
+
#
|
1198
|
+
# The Price Interval resource represents a period of time for which a price will
|
1199
|
+
# bill on a subscription. A subscription’s price intervals define its billing
|
1200
|
+
# behavior.
|
1201
|
+
#
|
1202
|
+
# @param id [String]
|
1203
|
+
#
|
1204
|
+
# @param billing_cycle_day [Integer] The day of the month that Orb bills for this price
|
1205
|
+
#
|
1206
|
+
# @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
|
1207
|
+
# ...
|
1208
|
+
#
|
1209
|
+
# @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
|
1210
|
+
# ...
|
1211
|
+
#
|
1212
|
+
# @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for
|
1213
|
+
# ...
|
1214
|
+
#
|
1215
|
+
# @param filter [String, nil] An additional filter to apply to usage queries.
|
1216
|
+
#
|
1217
|
+
# @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
|
1218
|
+
# ...
|
1219
|
+
#
|
1220
|
+
# @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] The Price resource represents a price that can be billed on a subscription, resu
|
1221
|
+
# ...
|
1222
|
+
#
|
1223
|
+
# @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
|
1224
|
+
# ...
|
1225
|
+
#
|
1226
|
+
# @param usage_customer_ids [Array<String>, nil] A list of customer IDs whose usage events will be aggregated and billed under th
|
1227
|
+
# ...
|
1244
1228
|
|
1245
1229
|
class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
|
1246
1230
|
# @!attribute effective_date
|
@@ -1258,14 +1242,10 @@ module Orb
|
|
1258
1242
|
# @return [Integer]
|
1259
1243
|
required :quantity, Integer
|
1260
1244
|
|
1261
|
-
# @!
|
1262
|
-
#
|
1263
|
-
#
|
1264
|
-
#
|
1265
|
-
# #
|
1266
|
-
# def initialize(effective_date:, price_id:, quantity:, **) = super
|
1267
|
-
|
1268
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1245
|
+
# @!method initialize(effective_date:, price_id:, quantity:)
|
1246
|
+
# @param effective_date [Time]
|
1247
|
+
# @param price_id [String]
|
1248
|
+
# @param quantity [Integer]
|
1269
1249
|
end
|
1270
1250
|
end
|
1271
1251
|
|
@@ -1286,14 +1266,10 @@ module Orb
|
|
1286
1266
|
# @return [Time]
|
1287
1267
|
required :start_date, Time
|
1288
1268
|
|
1289
|
-
# @!
|
1290
|
-
#
|
1291
|
-
#
|
1292
|
-
#
|
1293
|
-
# #
|
1294
|
-
# def initialize(coupon_id:, end_date:, start_date:, **) = super
|
1295
|
-
|
1296
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1269
|
+
# @!method initialize(coupon_id:, end_date:, start_date:)
|
1270
|
+
# @param coupon_id [String]
|
1271
|
+
# @param end_date [Time, nil]
|
1272
|
+
# @param start_date [Time]
|
1297
1273
|
end
|
1298
1274
|
|
1299
1275
|
# @see Orb::Models::SubscriptionChangeRetrieveResponse::Subscription#status
|
@@ -1304,11 +1280,8 @@ module Orb
|
|
1304
1280
|
ENDED = :ended
|
1305
1281
|
UPCOMING = :upcoming
|
1306
1282
|
|
1307
|
-
|
1308
|
-
|
1309
|
-
# @!parse
|
1310
|
-
# # @return [Array<Symbol>]
|
1311
|
-
# def self.values; end
|
1283
|
+
# @!method self.values
|
1284
|
+
# @return [Array<Symbol>]
|
1312
1285
|
end
|
1313
1286
|
|
1314
1287
|
# @see Orb::Models::SubscriptionChangeRetrieveResponse::Subscription#trial_info
|
@@ -1318,12 +1291,8 @@ module Orb
|
|
1318
1291
|
# @return [Time, nil]
|
1319
1292
|
required :end_date, Time, nil?: true
|
1320
1293
|
|
1321
|
-
# @!
|
1322
|
-
#
|
1323
|
-
# #
|
1324
|
-
# def initialize(end_date:, **) = super
|
1325
|
-
|
1326
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1294
|
+
# @!method initialize(end_date:)
|
1295
|
+
# @param end_date [Time, nil]
|
1327
1296
|
end
|
1328
1297
|
|
1329
1298
|
# @see Orb::Models::SubscriptionChangeRetrieveResponse::Subscription#changed_resources
|
@@ -1352,19 +1321,18 @@ module Orb
|
|
1352
1321
|
# @return [Array<Orb::Models::Invoice>]
|
1353
1322
|
required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] }
|
1354
1323
|
|
1355
|
-
# @!
|
1356
|
-
#
|
1357
|
-
#
|
1358
|
-
#
|
1359
|
-
#
|
1360
|
-
#
|
1361
|
-
#
|
1362
|
-
#
|
1363
|
-
#
|
1364
|
-
#
|
1365
|
-
#
|
1366
|
-
|
1367
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1324
|
+
# @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:)
|
1325
|
+
# The resources that were changed as part of this operation. Only present when
|
1326
|
+
# fetched through the subscription changes API or if the
|
1327
|
+
# `include_changed_resources` parameter was passed in the request.
|
1328
|
+
#
|
1329
|
+
# @param created_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were created as part of this operation.
|
1330
|
+
#
|
1331
|
+
# @param created_invoices [Array<Orb::Models::Invoice>] The invoices that were created as part of this operation.
|
1332
|
+
#
|
1333
|
+
# @param voided_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were voided as part of this operation.
|
1334
|
+
#
|
1335
|
+
# @param voided_invoices [Array<Orb::Models::Invoice>] The invoices that were voided as part of this operation.
|
1368
1336
|
end
|
1369
1337
|
end
|
1370
1338
|
end
|