orb-billing 0.1.0.pre.alpha.37 → 0.1.0.pre.alpha.39
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/README.md +29 -5
- data/lib/orb/client.rb +4 -0
- data/lib/orb/internal/page.rb +6 -2
- data/lib/orb/internal/transport/base_client.rb +3 -3
- data/lib/orb/internal/transport/pooled_net_requester.rb +2 -2
- data/lib/orb/internal/type/array_of.rb +5 -3
- data/lib/orb/internal/type/base_model.rb +19 -16
- data/lib/orb/internal/type/base_page.rb +4 -1
- data/lib/orb/internal/type/{boolean_model.rb → boolean.rb} +2 -2
- data/lib/orb/internal/type/converter.rb +26 -23
- data/lib/orb/internal/type/enum.rb +10 -8
- data/lib/orb/internal/type/hash_of.rb +3 -1
- data/lib/orb/internal/util.rb +29 -50
- data/lib/orb/models/alert.rb +10 -10
- data/lib/orb/models/alert_create_for_customer_params.rb +3 -3
- data/lib/orb/models/alert_create_for_external_customer_params.rb +3 -3
- data/lib/orb/models/alert_create_for_subscription_params.rb +3 -3
- data/lib/orb/models/alert_list_params.rb +5 -5
- data/lib/orb/models/alert_update_params.rb +3 -3
- data/lib/orb/models/amount_discount.rb +1 -1
- data/lib/orb/models/billable_metric.rb +7 -7
- data/lib/orb/models/coupon.rb +7 -7
- data/lib/orb/models/coupon_create_params.rb +2 -2
- data/lib/orb/models/coupon_list_params.rb +3 -3
- data/lib/orb/models/coupons/subscription_list_params.rb +1 -1
- data/lib/orb/models/credit_note.rb +1 -1
- data/lib/orb/models/credit_note_list_params.rb +5 -5
- data/lib/orb/models/customer.rb +237 -237
- data/lib/orb/models/customer_create_params.rb +229 -229
- data/lib/orb/models/customer_list_params.rb +5 -5
- data/lib/orb/models/customer_update_by_external_id_params.rb +230 -230
- data/lib/orb/models/customer_update_params.rb +230 -230
- data/lib/orb/models/customers/balance_transaction_create_response.rb +2 -2
- data/lib/orb/models/customers/balance_transaction_list_params.rb +5 -5
- data/lib/orb/models/customers/balance_transaction_list_response.rb +2 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +6 -6
- data/lib/orb/models/customers/cost_list_params.rb +6 -6
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +3 -3
- data/lib/orb/models/customers/credit_list_params.rb +3 -3
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +5 -5
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_list_params.rb +5 -5
- data/lib/orb/models/customers/credits/ledger_list_response.rb +22 -22
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +10 -10
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +9 -9
- data/lib/orb/models/customers/credits/top_up_create_params.rb +10 -10
- data/lib/orb/models/customers/credits/top_up_create_response.rb +9 -9
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +1 -1
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +9 -9
- data/lib/orb/models/customers/credits/top_up_list_params.rb +1 -1
- data/lib/orb/models/customers/credits/top_up_list_response.rb +9 -9
- data/lib/orb/models/dimensional_price_group.rb +7 -7
- data/lib/orb/models/dimensional_price_group_create_params.rb +2 -2
- data/lib/orb/models/dimensional_price_group_list_params.rb +1 -1
- data/lib/orb/models/evaluate_price_group.rb +1 -1
- data/lib/orb/models/event_ingest_params.rb +8 -8
- data/lib/orb/models/event_ingest_response.rb +4 -4
- data/lib/orb/models/event_search_params.rb +5 -5
- data/lib/orb/models/event_search_response.rb +9 -9
- data/lib/orb/models/event_update_params.rb +4 -4
- data/lib/orb/models/events/backfill_close_response.rb +8 -8
- data/lib/orb/models/events/backfill_create_params.rb +12 -12
- data/lib/orb/models/events/backfill_create_response.rb +8 -8
- data/lib/orb/models/events/backfill_fetch_response.rb +8 -8
- data/lib/orb/models/events/backfill_list_params.rb +1 -1
- data/lib/orb/models/events/backfill_list_response.rb +8 -8
- data/lib/orb/models/events/backfill_revert_response.rb +8 -8
- data/lib/orb/models/events/event_volumes.rb +1 -1
- data/lib/orb/models/events/volume_list_params.rb +7 -7
- data/lib/orb/models/invoice.rb +278 -278
- data/lib/orb/models/invoice_create_params.rb +13 -12
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +274 -274
- data/lib/orb/models/invoice_issue_params.rb +5 -5
- data/lib/orb/models/invoice_line_item_create_params.rb +1 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +32 -32
- data/lib/orb/models/invoice_list_params.rb +13 -13
- data/lib/orb/models/invoice_update_params.rb +2 -2
- data/lib/orb/models/item.rb +2 -2
- data/lib/orb/models/item_list_params.rb +1 -1
- data/lib/orb/models/metric_create_params.rb +2 -2
- data/lib/orb/models/metric_list_params.rb +5 -5
- data/lib/orb/models/metric_update_params.rb +2 -2
- data/lib/orb/models/pagination_metadata.rb +1 -1
- data/lib/orb/models/percentage_discount.rb +2 -2
- data/lib/orb/models/plan.rb +40 -40
- data/lib/orb/models/plan_create_params.rb +292 -292
- data/lib/orb/models/plan_list_params.rb +5 -5
- data/lib/orb/models/plan_update_params.rb +4 -4
- data/lib/orb/models/plans/external_plan_id_update_params.rb +4 -4
- data/lib/orb/models/price.rb +186 -186
- data/lib/orb/models/price_create_params.rb +21 -21
- data/lib/orb/models/price_evaluate_params.rb +4 -4
- data/lib/orb/models/price_list_params.rb +1 -1
- data/lib/orb/models/price_update_params.rb +2 -2
- data/lib/orb/models/prices/external_price_id_update_params.rb +2 -2
- data/lib/orb/models/subscription.rb +120 -93
- data/lib/orb/models/subscription_cancel_params.rb +4 -4
- data/lib/orb/models/subscription_cancel_response.rb +156 -78
- data/lib/orb/models/subscription_change_apply_params.rb +33 -0
- data/lib/orb/models/subscription_change_apply_response.rb +1372 -0
- data/lib/orb/models/subscription_change_cancel_params.rb +19 -0
- data/lib/orb/models/subscription_change_cancel_response.rb +1372 -0
- data/lib/orb/models/subscription_change_retrieve_params.rb +19 -0
- data/lib/orb/models/subscription_change_retrieve_response.rb +1372 -0
- data/lib/orb/models/subscription_create_params.rb +705 -705
- data/lib/orb/models/subscription_create_response.rb +156 -78
- data/lib/orb/models/subscription_fetch_costs_params.rb +6 -6
- data/lib/orb/models/subscription_fetch_schedule_params.rb +5 -5
- data/lib/orb/models/subscription_fetch_schedule_response.rb +2 -2
- data/lib/orb/models/subscription_fetch_usage_params.rb +8 -8
- data/lib/orb/models/subscription_list_params.rb +5 -5
- data/lib/orb/models/subscription_price_intervals_params.rb +358 -358
- data/lib/orb/models/subscription_price_intervals_response.rb +158 -78
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +715 -715
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +158 -78
- data/lib/orb/models/subscription_trigger_phase_params.rb +4 -4
- data/lib/orb/models/subscription_trigger_phase_response.rb +158 -78
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +158 -78
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +159 -79
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +158 -78
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +9 -9
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +158 -78
- data/lib/orb/models/subscription_update_params.rb +11 -11
- data/lib/orb/models/subscription_update_trial_params.rb +4 -4
- data/lib/orb/models/subscription_update_trial_response.rb +158 -78
- data/lib/orb/models/trial_discount.rb +1 -1
- data/lib/orb/models/usage_discount.rb +2 -2
- data/lib/orb/request_options.rb +7 -7
- data/lib/orb/resources/alerts.rb +40 -35
- data/lib/orb/resources/coupons/subscriptions.rb +3 -3
- data/lib/orb/resources/coupons.rb +9 -9
- data/lib/orb/resources/credit_notes.rb +10 -5
- data/lib/orb/resources/customers/balance_transactions.rb +28 -23
- data/lib/orb/resources/customers/costs.rb +232 -232
- data/lib/orb/resources/customers/credits/ledger.rb +348 -338
- data/lib/orb/resources/customers/credits/top_ups.rb +12 -12
- data/lib/orb/resources/customers/credits.rb +8 -8
- data/lib/orb/resources/customers.rb +61 -56
- data/lib/orb/resources/dimensional_price_groups.rb +6 -6
- data/lib/orb/resources/events/backfills.rb +49 -49
- data/lib/orb/resources/events/volume.rb +10 -10
- data/lib/orb/resources/events.rb +295 -295
- data/lib/orb/resources/invoice_line_items.rb +1 -1
- data/lib/orb/resources/invoices.rb +40 -31
- data/lib/orb/resources/items.rb +1 -1
- data/lib/orb/resources/metrics.rb +13 -8
- data/lib/orb/resources/plans/external_plan_id.rb +14 -14
- data/lib/orb/resources/plans.rb +24 -19
- data/lib/orb/resources/prices/external_price_id.rb +4 -4
- data/lib/orb/resources/prices.rb +30 -30
- data/lib/orb/resources/subscription_changes.rb +87 -0
- data/lib/orb/resources/subscriptions.rb +817 -807
- data/lib/orb/resources/top_level.rb +4 -4
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +8 -1
- data/rbi/lib/orb/client.rbi +5 -4
- data/rbi/lib/orb/errors.rbi +3 -6
- data/rbi/lib/orb/internal/page.rbi +3 -6
- data/rbi/lib/orb/internal/transport/base_client.rbi +13 -27
- data/rbi/lib/orb/internal/transport/pooled_net_requester.rbi +7 -13
- data/rbi/lib/orb/internal/type/array_of.rbi +10 -18
- data/rbi/lib/orb/internal/type/base_model.rbi +45 -64
- data/rbi/lib/orb/internal/type/base_page.rbi +5 -10
- data/rbi/lib/orb/internal/type/{boolean_model.rbi → boolean.rbi} +5 -9
- data/rbi/lib/orb/internal/type/converter.rbi +25 -31
- data/rbi/lib/orb/internal/type/enum.rbi +14 -20
- data/rbi/lib/orb/internal/type/hash_of.rbi +8 -16
- data/rbi/lib/orb/internal/type/request_parameters.rbi +1 -2
- data/rbi/lib/orb/internal/type/union.rbi +10 -20
- data/rbi/lib/orb/internal/type/unknown.rbi +4 -8
- data/rbi/lib/orb/internal/util.rbi +40 -72
- data/rbi/lib/orb/internal.rbi +1 -1
- data/rbi/lib/orb/models/alert.rbi +21 -33
- data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +8 -13
- data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +8 -13
- data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +8 -13
- data/rbi/lib/orb/models/alert_disable_params.rbi +2 -4
- data/rbi/lib/orb/models/alert_enable_params.rbi +2 -4
- data/rbi/lib/orb/models/alert_list_params.rbi +3 -6
- data/rbi/lib/orb/models/alert_retrieve_params.rbi +2 -4
- data/rbi/lib/orb/models/alert_update_params.rbi +7 -11
- data/rbi/lib/orb/models/amount_discount.rbi +4 -7
- data/rbi/lib/orb/models/billable_metric.rbi +10 -13
- data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -2
- data/rbi/lib/orb/models/coupon.rbi +9 -11
- data/rbi/lib/orb/models/coupon_archive_params.rbi +2 -4
- data/rbi/lib/orb/models/coupon_create_params.rbi +8 -14
- data/rbi/lib/orb/models/coupon_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/coupon_list_params.rbi +3 -4
- data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +3 -5
- data/rbi/lib/orb/models/credit_note.rbi +22 -45
- data/rbi/lib/orb/models/credit_note_create_params.rbi +5 -10
- data/rbi/lib/orb/models/credit_note_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -6
- data/rbi/lib/orb/models/customer.rbi +256 -281
- data/rbi/lib/orb/models/customer_create_params.rbi +251 -276
- data/rbi/lib/orb/models/customer_delete_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_list_params.rbi +3 -6
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +252 -277
- data/rbi/lib/orb/models/customer_update_params.rbi +252 -277
- data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +3 -6
- data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +10 -19
- data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -6
- data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +10 -19
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +8 -10
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +6 -12
- data/rbi/lib/orb/models/customers/cost_list_params.rbi +8 -10
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +6 -12
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +3 -4
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +2 -4
- data/rbi/lib/orb/models/customers/credit_list_params.rbi +3 -4
- data/rbi/lib/orb/models/customers/credit_list_response.rbi +2 -4
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +26 -33
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +79 -136
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +26 -33
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +78 -135
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +5 -10
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +79 -136
- data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +5 -10
- data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +74 -131
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +13 -19
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +12 -18
- data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +13 -19
- data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +12 -18
- data/rbi/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +2 -4
- data/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi +2 -4
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +3 -5
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +12 -18
- data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +3 -5
- data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +12 -18
- data/rbi/lib/orb/models/dimensional_price_group.rbi +8 -9
- data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -7
- data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +3 -5
- data/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi +2 -4
- data/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +2 -4
- data/rbi/lib/orb/models/dimensional_price_groups.rbi +2 -4
- data/rbi/lib/orb/models/discount.rbi +1 -2
- data/rbi/lib/orb/models/evaluate_price_group.rbi +3 -6
- data/rbi/lib/orb/models/event_deprecate_params.rbi +2 -4
- data/rbi/lib/orb/models/event_deprecate_response.rbi +2 -4
- data/rbi/lib/orb/models/event_ingest_params.rbi +10 -13
- data/rbi/lib/orb/models/event_ingest_response.rbi +10 -16
- data/rbi/lib/orb/models/event_search_params.rbi +7 -9
- data/rbi/lib/orb/models/event_search_response.rbi +11 -14
- data/rbi/lib/orb/models/event_update_params.rbi +5 -6
- data/rbi/lib/orb/models/event_update_response.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_close_params.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_close_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_create_params.rbi +13 -16
- data/rbi/lib/orb/models/events/backfill_create_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_list_params.rbi +3 -5
- data/rbi/lib/orb/models/events/backfill_list_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_revert_params.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_revert_response.rbi +10 -14
- data/rbi/lib/orb/models/events/event_volumes.rbi +5 -9
- data/rbi/lib/orb/models/events/volume_list_params.rbi +9 -11
- data/rbi/lib/orb/models/invoice.rbi +388 -465
- data/rbi/lib/orb/models/invoice_create_params.rbi +19 -26
- data/rbi/lib/orb/models/invoice_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +381 -460
- data/rbi/lib/orb/models/invoice_issue_params.rbi +6 -8
- data/rbi/lib/orb/models/invoice_level_discount.rbi +1 -2
- data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +3 -5
- data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +101 -143
- data/rbi/lib/orb/models/invoice_list_params.rbi +8 -13
- data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_pay_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_update_params.rbi +4 -6
- data/rbi/lib/orb/models/invoice_void_params.rbi +2 -4
- data/rbi/lib/orb/models/item.rbi +7 -12
- data/rbi/lib/orb/models/item_create_params.rbi +2 -4
- data/rbi/lib/orb/models/item_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/item_list_params.rbi +3 -5
- data/rbi/lib/orb/models/item_update_params.rbi +5 -10
- data/rbi/lib/orb/models/metric_create_params.rbi +4 -6
- data/rbi/lib/orb/models/metric_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/metric_list_params.rbi +3 -6
- data/rbi/lib/orb/models/metric_update_params.rbi +4 -6
- data/rbi/lib/orb/models/pagination_metadata.rbi +2 -4
- data/rbi/lib/orb/models/percentage_discount.rbi +5 -8
- data/rbi/lib/orb/models/plan.rbi +180 -219
- data/rbi/lib/orb/models/plan_create_params.rbi +670 -951
- data/rbi/lib/orb/models/plan_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/plan_list_params.rbi +4 -8
- data/rbi/lib/orb/models/plan_update_params.rbi +6 -8
- data/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +6 -8
- data/rbi/lib/orb/models/price.rbi +827 -1494
- data/rbi/lib/orb/models/price_create_params.rbi +60 -101
- data/rbi/lib/orb/models/price_evaluate_params.rbi +6 -9
- data/rbi/lib/orb/models/price_evaluate_response.rbi +2 -4
- data/rbi/lib/orb/models/price_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/price_list_params.rbi +3 -5
- data/rbi/lib/orb/models/price_update_params.rbi +4 -6
- data/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +4 -6
- data/rbi/lib/orb/models/subscription.rbi +167 -187
- data/rbi/lib/orb/models/subscription_cancel_params.rbi +5 -7
- data/rbi/lib/orb/models/subscription_cancel_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_change_apply_params.rbi +40 -0
- data/rbi/lib/orb/models/subscription_change_apply_response.rbi +1554 -0
- data/rbi/lib/orb/models/subscription_change_cancel_params.rbi +18 -0
- data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +1565 -0
- data/rbi/lib/orb/models/subscription_change_retrieve_params.rbi +18 -0
- data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +1581 -0
- data/rbi/lib/orb/models/subscription_create_params.rbi +1372 -1968
- data/rbi/lib/orb/models/subscription_create_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +8 -10
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +6 -12
- data/rbi/lib/orb/models/subscription_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -6
- data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +6 -10
- data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +12 -17
- data/rbi/lib/orb/models/subscription_list_params.rbi +4 -8
- data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +772 -1124
- data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +228 -178
- data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +1396 -1993
- data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +238 -182
- data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +5 -7
- data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +238 -182
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +265 -199
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +264 -198
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -15
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +238 -182
- data/rbi/lib/orb/models/subscription_update_params.rbi +12 -15
- data/rbi/lib/orb/models/subscription_update_trial_params.rbi +6 -9
- data/rbi/lib/orb/models/subscription_update_trial_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_usage.rbi +24 -43
- data/rbi/lib/orb/models/subscriptions.rbi +2 -4
- data/rbi/lib/orb/models/top_level_ping_params.rbi +2 -4
- data/rbi/lib/orb/models/top_level_ping_response.rbi +2 -4
- data/rbi/lib/orb/models/trial_discount.rbi +4 -8
- data/rbi/lib/orb/models/usage_discount.rbi +5 -8
- data/rbi/lib/orb/request_options.rbi +9 -11
- data/rbi/lib/orb/resources/alerts.rbi +44 -60
- data/rbi/lib/orb/resources/coupons/subscriptions.rbi +6 -9
- data/rbi/lib/orb/resources/coupons.rbi +18 -25
- data/rbi/lib/orb/resources/credit_notes.rbi +9 -15
- data/rbi/lib/orb/resources/customers/balance_transactions.rbi +26 -31
- data/rbi/lib/orb/resources/customers/costs.rbi +241 -246
- data/rbi/lib/orb/resources/customers/credits/ledger.rbi +387 -396
- data/rbi/lib/orb/resources/customers/credits/top_ups.rbi +29 -40
- data/rbi/lib/orb/resources/customers/credits.rbi +15 -20
- data/rbi/lib/orb/resources/customers.rbi +407 -417
- data/rbi/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +2 -4
- data/rbi/lib/orb/resources/dimensional_price_groups.rbi +13 -19
- data/rbi/lib/orb/resources/events/backfills.rbi +61 -69
- data/rbi/lib/orb/resources/events/volume.rbi +19 -22
- data/rbi/lib/orb/resources/events.rbi +311 -319
- data/rbi/lib/orb/resources/invoice_line_items.rbi +4 -7
- data/rbi/lib/orb/resources/invoices.rbi +62 -76
- data/rbi/lib/orb/resources/items.rbi +7 -14
- data/rbi/lib/orb/resources/metrics.rbi +17 -25
- data/rbi/lib/orb/resources/plans/external_plan_id.rbi +21 -25
- data/rbi/lib/orb/resources/plans.rbi +63 -71
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +9 -13
- data/rbi/lib/orb/resources/prices.rbi +77 -87
- data/rbi/lib/orb/resources/subscription_changes.rbi +61 -0
- data/rbi/lib/orb/resources/subscriptions.rbi +933 -963
- data/rbi/lib/orb/resources/top_level.rbi +6 -8
- data/rbi/lib/orb/version.rbi +1 -1
- data/sig/orb/client.rbs +2 -0
- data/sig/orb/internal/type/array_of.rbs +2 -2
- data/sig/orb/internal/type/{boolean_model.rbs → boolean.rbs} +1 -1
- data/sig/orb/internal/util.rbs +5 -5
- data/sig/orb/models/subscription.rbs +14 -0
- data/sig/orb/models/subscription_cancel_response.rbs +47 -2
- data/sig/orb/models/subscription_change_apply_params.rbs +24 -0
- data/sig/orb/models/subscription_change_apply_response.rbs +784 -0
- data/sig/orb/models/subscription_change_cancel_params.rbs +15 -0
- data/sig/orb/models/subscription_change_cancel_response.rbs +784 -0
- data/sig/orb/models/subscription_change_retrieve_params.rbs +15 -0
- data/sig/orb/models/subscription_change_retrieve_response.rbs +784 -0
- data/sig/orb/models/subscription_create_response.rbs +47 -2
- data/sig/orb/models/subscription_price_intervals_response.rbs +47 -2
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +47 -2
- data/sig/orb/models/subscription_trigger_phase_response.rbs +47 -2
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +47 -2
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +47 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +47 -2
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +47 -2
- data/sig/orb/models/subscription_update_trial_response.rbs +47 -2
- data/sig/orb/resources/customers.rbs +2 -2
- data/sig/orb/resources/subscription_changes.rbs +24 -0
- data/sig/orb/version.rbs +1 -1
- metadata +26 -5
@@ -7,18 +7,18 @@ module Orb
|
|
7
7
|
attr_accessor :id
|
8
8
|
|
9
9
|
# The current plan phase that is active, only if the subscription's plan has
|
10
|
-
#
|
10
|
+
# phases.
|
11
11
|
sig { returns(T.nilable(Integer)) }
|
12
12
|
attr_accessor :active_plan_phase_order
|
13
13
|
|
14
14
|
# The adjustment intervals for this subscription sorted by the start_date of the
|
15
|
-
#
|
15
|
+
# adjustment interval.
|
16
16
|
sig { returns(T::Array[Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval]) }
|
17
17
|
attr_accessor :adjustment_intervals
|
18
18
|
|
19
19
|
# Determines whether issued invoices for this subscription will automatically be
|
20
|
-
#
|
21
|
-
#
|
20
|
+
# charged with the saved payment method on the due date. This property defaults to
|
21
|
+
# the plan's behavior. If null, defaults to the customer's setting.
|
22
22
|
sig { returns(T.nilable(T::Boolean)) }
|
23
23
|
attr_accessor :auto_collection
|
24
24
|
|
@@ -37,9 +37,9 @@ module Orb
|
|
37
37
|
attr_writer :billing_cycle_anchor_configuration
|
38
38
|
|
39
39
|
# The day of the month on which the billing cycle is anchored. If the maximum
|
40
|
-
#
|
41
|
-
#
|
42
|
-
#
|
40
|
+
# number of days in a month is greater than this value, the last day of the month
|
41
|
+
# is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
|
42
|
+
# period begins on the 30th.
|
43
43
|
sig { returns(Integer) }
|
44
44
|
attr_accessor :billing_cycle_day
|
45
45
|
|
@@ -47,35 +47,35 @@ module Orb
|
|
47
47
|
attr_accessor :created_at
|
48
48
|
|
49
49
|
# The end of the current billing period. This is an exclusive timestamp, such that
|
50
|
-
#
|
51
|
-
#
|
50
|
+
# the instant returned is not part of the billing period. Set to null for
|
51
|
+
# subscriptions that are not currently active.
|
52
52
|
sig { returns(T.nilable(Time)) }
|
53
53
|
attr_accessor :current_billing_period_end_date
|
54
54
|
|
55
55
|
# The start date of the current billing period. This is an inclusive timestamp;
|
56
|
-
#
|
57
|
-
#
|
56
|
+
# the instant returned is exactly the beginning of the billing period. Set to null
|
57
|
+
# if the subscription is not currently active.
|
58
58
|
sig { returns(T.nilable(Time)) }
|
59
59
|
attr_accessor :current_billing_period_start_date
|
60
60
|
|
61
61
|
# A customer is a buyer of your products, and the other party to the billing
|
62
|
-
#
|
62
|
+
# relationship.
|
63
63
|
#
|
64
|
-
#
|
65
|
-
#
|
66
|
-
#
|
67
|
-
#
|
68
|
-
#
|
69
|
-
#
|
64
|
+
# In Orb, customers are assigned system generated identifiers automatically, but
|
65
|
+
# it's often desirable to have these match existing identifiers in your system. To
|
66
|
+
# avoid having to denormalize Orb ID information, you can pass in an
|
67
|
+
# `external_customer_id` with your own identifier. See
|
68
|
+
# [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
|
69
|
+
# information about how these aliases work in Orb.
|
70
70
|
#
|
71
|
-
#
|
72
|
-
#
|
73
|
-
#
|
71
|
+
# In addition to having an identifier in your system, a customer may exist in a
|
72
|
+
# payment provider solution like Stripe. Use the `payment_provider_id` and the
|
73
|
+
# `payment_provider` enum field to express this mapping.
|
74
74
|
#
|
75
|
-
#
|
76
|
-
#
|
77
|
-
#
|
78
|
-
#
|
75
|
+
# A customer also has a timezone (from the standard
|
76
|
+
# [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
|
77
|
+
# your account's timezone. See [Timezone localization](/essentials/timezones) for
|
78
|
+
# information on what this timezone parameter influences within Orb.
|
79
79
|
sig { returns(Orb::Models::Customer) }
|
80
80
|
attr_reader :customer
|
81
81
|
|
@@ -83,7 +83,7 @@ module Orb
|
|
83
83
|
attr_writer :customer
|
84
84
|
|
85
85
|
# Determines the default memo on this subscriptions' invoices. Note that if this
|
86
|
-
#
|
86
|
+
# is not provided, it is determined by the plan configuration.
|
87
87
|
sig { returns(T.nilable(String)) }
|
88
88
|
attr_accessor :default_invoice_memo
|
89
89
|
|
@@ -91,11 +91,11 @@ module Orb
|
|
91
91
|
sig do
|
92
92
|
returns(
|
93
93
|
T::Array[
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
|
98
|
-
|
94
|
+
T.any(
|
95
|
+
Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::AmountDiscountInterval,
|
96
|
+
Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::PercentageDiscountInterval,
|
97
|
+
Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::UsageDiscountInterval
|
98
|
+
)
|
99
99
|
]
|
100
100
|
)
|
101
101
|
end
|
@@ -116,9 +116,9 @@ module Orb
|
|
116
116
|
attr_accessor :maximum_intervals
|
117
117
|
|
118
118
|
# User specified key-value pairs for the resource. If not present, this defaults
|
119
|
-
#
|
120
|
-
#
|
121
|
-
#
|
119
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
120
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
121
|
+
# `null`.
|
122
122
|
sig { returns(T::Hash[Symbol, String]) }
|
123
123
|
attr_accessor :metadata
|
124
124
|
|
@@ -127,16 +127,30 @@ module Orb
|
|
127
127
|
attr_accessor :minimum_intervals
|
128
128
|
|
129
129
|
# Determines the difference between the invoice issue date for subscription
|
130
|
-
#
|
131
|
-
#
|
132
|
-
#
|
130
|
+
# invoices as the date that they are due. A value of `0` here represents that the
|
131
|
+
# invoice is due on issue, whereas a value of `30` represents that the customer
|
132
|
+
# has a month to pay the invoice.
|
133
133
|
sig { returns(Integer) }
|
134
134
|
attr_accessor :net_terms
|
135
135
|
|
136
|
+
# A pending subscription change if one exists on this subscription.
|
137
|
+
sig { returns(T.nilable(Orb::Models::SubscriptionUpdateTrialResponse::PendingSubscriptionChange)) }
|
138
|
+
attr_reader :pending_subscription_change
|
139
|
+
|
140
|
+
sig do
|
141
|
+
params(
|
142
|
+
pending_subscription_change: T.nilable(
|
143
|
+
T.any(Orb::Models::SubscriptionUpdateTrialResponse::PendingSubscriptionChange, Orb::Internal::AnyHash)
|
144
|
+
)
|
145
|
+
)
|
146
|
+
.void
|
147
|
+
end
|
148
|
+
attr_writer :pending_subscription_change
|
149
|
+
|
136
150
|
# The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
137
|
-
#
|
138
|
-
#
|
139
|
-
#
|
151
|
+
# subscribed to by a customer. Plans define the billing behavior of the
|
152
|
+
# subscription. You can see more about how to configure prices in the
|
153
|
+
# [Price resource](/reference/price).
|
140
154
|
sig { returns(Orb::Models::Plan) }
|
141
155
|
attr_reader :plan
|
142
156
|
|
@@ -174,6 +188,20 @@ module Orb
|
|
174
188
|
end
|
175
189
|
attr_writer :trial_info
|
176
190
|
|
191
|
+
# The resources that were changed as part of this operation. Only present when
|
192
|
+
# fetched through the subscription changes API or if the
|
193
|
+
# `include_changed_resources` parameter was passed in the request.
|
194
|
+
sig { returns(T.nilable(Orb::Models::SubscriptionUpdateTrialResponse::ChangedResources)) }
|
195
|
+
attr_reader :changed_resources
|
196
|
+
|
197
|
+
sig do
|
198
|
+
params(
|
199
|
+
changed_resources: T.nilable(T.any(Orb::Models::SubscriptionUpdateTrialResponse::ChangedResources, Orb::Internal::AnyHash))
|
200
|
+
)
|
201
|
+
.void
|
202
|
+
end
|
203
|
+
attr_writer :changed_resources
|
204
|
+
|
177
205
|
sig do
|
178
206
|
params(
|
179
207
|
id: String,
|
@@ -191,12 +219,12 @@ module Orb
|
|
191
219
|
customer: T.any(Orb::Models::Customer, Orb::Internal::AnyHash),
|
192
220
|
default_invoice_memo: T.nilable(String),
|
193
221
|
discount_intervals: T::Array[
|
194
|
-
|
195
|
-
|
196
|
-
|
197
|
-
|
198
|
-
|
199
|
-
|
222
|
+
T.any(
|
223
|
+
Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::AmountDiscountInterval,
|
224
|
+
Orb::Internal::AnyHash,
|
225
|
+
Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::PercentageDiscountInterval,
|
226
|
+
Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::UsageDiscountInterval
|
227
|
+
)
|
200
228
|
],
|
201
229
|
end_date: T.nilable(Time),
|
202
230
|
fixed_fee_quantity_schedule: T::Array[T.any(Orb::Models::SubscriptionUpdateTrialResponse::FixedFeeQuantitySchedule, Orb::Internal::AnyHash)],
|
@@ -205,12 +233,16 @@ module Orb
|
|
205
233
|
metadata: T::Hash[Symbol, String],
|
206
234
|
minimum_intervals: T::Array[T.any(Orb::Models::SubscriptionUpdateTrialResponse::MinimumInterval, Orb::Internal::AnyHash)],
|
207
235
|
net_terms: Integer,
|
236
|
+
pending_subscription_change: T.nilable(
|
237
|
+
T.any(Orb::Models::SubscriptionUpdateTrialResponse::PendingSubscriptionChange, Orb::Internal::AnyHash)
|
238
|
+
),
|
208
239
|
plan: T.any(Orb::Models::Plan, Orb::Internal::AnyHash),
|
209
240
|
price_intervals: T::Array[T.any(Orb::Models::SubscriptionUpdateTrialResponse::PriceInterval, Orb::Internal::AnyHash)],
|
210
241
|
redeemed_coupon: T.nilable(T.any(Orb::Models::SubscriptionUpdateTrialResponse::RedeemedCoupon, Orb::Internal::AnyHash)),
|
211
242
|
start_date: Time,
|
212
243
|
status: Orb::Models::SubscriptionUpdateTrialResponse::Status::OrSymbol,
|
213
|
-
trial_info: T.any(Orb::Models::SubscriptionUpdateTrialResponse::TrialInfo, Orb::Internal::AnyHash)
|
244
|
+
trial_info: T.any(Orb::Models::SubscriptionUpdateTrialResponse::TrialInfo, Orb::Internal::AnyHash),
|
245
|
+
changed_resources: T.nilable(T.any(Orb::Models::SubscriptionUpdateTrialResponse::ChangedResources, Orb::Internal::AnyHash))
|
214
246
|
)
|
215
247
|
.returns(T.attached_class)
|
216
248
|
end
|
@@ -234,15 +266,15 @@ module Orb
|
|
234
266
|
metadata:,
|
235
267
|
minimum_intervals:,
|
236
268
|
net_terms:,
|
269
|
+
pending_subscription_change:,
|
237
270
|
plan:,
|
238
271
|
price_intervals:,
|
239
272
|
redeemed_coupon:,
|
240
273
|
start_date:,
|
241
274
|
status:,
|
242
|
-
trial_info
|
243
|
-
|
244
|
-
end
|
245
|
-
|
275
|
+
trial_info:,
|
276
|
+
changed_resources: nil
|
277
|
+
); end
|
246
278
|
sig do
|
247
279
|
override
|
248
280
|
.returns(
|
@@ -259,11 +291,11 @@ module Orb
|
|
259
291
|
customer: Orb::Models::Customer,
|
260
292
|
default_invoice_memo: T.nilable(String),
|
261
293
|
discount_intervals: T::Array[
|
262
|
-
|
263
|
-
|
264
|
-
|
265
|
-
|
266
|
-
|
294
|
+
T.any(
|
295
|
+
Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::AmountDiscountInterval,
|
296
|
+
Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::PercentageDiscountInterval,
|
297
|
+
Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::UsageDiscountInterval
|
298
|
+
)
|
267
299
|
],
|
268
300
|
end_date: T.nilable(Time),
|
269
301
|
fixed_fee_quantity_schedule: T::Array[Orb::Models::SubscriptionUpdateTrialResponse::FixedFeeQuantitySchedule],
|
@@ -272,17 +304,18 @@ module Orb
|
|
272
304
|
metadata: T::Hash[Symbol, String],
|
273
305
|
minimum_intervals: T::Array[Orb::Models::SubscriptionUpdateTrialResponse::MinimumInterval],
|
274
306
|
net_terms: Integer,
|
307
|
+
pending_subscription_change: T.nilable(Orb::Models::SubscriptionUpdateTrialResponse::PendingSubscriptionChange),
|
275
308
|
plan: Orb::Models::Plan,
|
276
309
|
price_intervals: T::Array[Orb::Models::SubscriptionUpdateTrialResponse::PriceInterval],
|
277
310
|
redeemed_coupon: T.nilable(Orb::Models::SubscriptionUpdateTrialResponse::RedeemedCoupon),
|
278
311
|
start_date: Time,
|
279
312
|
status: Orb::Models::SubscriptionUpdateTrialResponse::Status::TaggedSymbol,
|
280
|
-
trial_info: Orb::Models::SubscriptionUpdateTrialResponse::TrialInfo
|
313
|
+
trial_info: Orb::Models::SubscriptionUpdateTrialResponse::TrialInfo,
|
314
|
+
changed_resources: T.nilable(Orb::Models::SubscriptionUpdateTrialResponse::ChangedResources)
|
281
315
|
}
|
282
316
|
)
|
283
317
|
end
|
284
|
-
def to_hash
|
285
|
-
end
|
318
|
+
def to_hash; end
|
286
319
|
|
287
320
|
class AdjustmentInterval < Orb::Internal::Type::BaseModel
|
288
321
|
sig { returns(String) }
|
@@ -330,8 +363,7 @@ module Orb
|
|
330
363
|
)
|
331
364
|
.returns(T.attached_class)
|
332
365
|
end
|
333
|
-
def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:)
|
334
|
-
end
|
366
|
+
def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end
|
335
367
|
|
336
368
|
sig do
|
337
369
|
override
|
@@ -351,8 +383,7 @@ module Orb
|
|
351
383
|
}
|
352
384
|
)
|
353
385
|
end
|
354
|
-
def to_hash
|
355
|
-
end
|
386
|
+
def to_hash; end
|
356
387
|
|
357
388
|
module Adjustment
|
358
389
|
extend Orb::Internal::Type::Union
|
@@ -369,7 +400,7 @@ module Orb
|
|
369
400
|
attr_accessor :applies_to_price_ids
|
370
401
|
|
371
402
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
372
|
-
#
|
403
|
+
# that apply to only one price.
|
373
404
|
sig { returns(T::Boolean) }
|
374
405
|
attr_accessor :is_invoice_level
|
375
406
|
|
@@ -382,7 +413,7 @@ module Orb
|
|
382
413
|
attr_accessor :reason
|
383
414
|
|
384
415
|
# The number of usage units by which to discount the price this adjustment applies
|
385
|
-
#
|
416
|
+
# to in a given billing period.
|
386
417
|
sig { returns(Float) }
|
387
418
|
attr_accessor :usage_discount
|
388
419
|
|
@@ -406,9 +437,7 @@ module Orb
|
|
406
437
|
reason:,
|
407
438
|
usage_discount:,
|
408
439
|
adjustment_type: :usage_discount
|
409
|
-
)
|
410
|
-
end
|
411
|
-
|
440
|
+
); end
|
412
441
|
sig do
|
413
442
|
override
|
414
443
|
.returns(
|
@@ -423,8 +452,7 @@ module Orb
|
|
423
452
|
}
|
424
453
|
)
|
425
454
|
end
|
426
|
-
def to_hash
|
427
|
-
end
|
455
|
+
def to_hash; end
|
428
456
|
end
|
429
457
|
|
430
458
|
class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
|
@@ -435,7 +463,7 @@ module Orb
|
|
435
463
|
attr_accessor :adjustment_type
|
436
464
|
|
437
465
|
# The amount by which to discount the prices this adjustment applies to in a given
|
438
|
-
#
|
466
|
+
# billing period.
|
439
467
|
sig { returns(String) }
|
440
468
|
attr_accessor :amount_discount
|
441
469
|
|
@@ -444,7 +472,7 @@ module Orb
|
|
444
472
|
attr_accessor :applies_to_price_ids
|
445
473
|
|
446
474
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
447
|
-
#
|
475
|
+
# that apply to only one price.
|
448
476
|
sig { returns(T::Boolean) }
|
449
477
|
attr_accessor :is_invoice_level
|
450
478
|
|
@@ -476,9 +504,7 @@ module Orb
|
|
476
504
|
plan_phase_order:,
|
477
505
|
reason:,
|
478
506
|
adjustment_type: :amount_discount
|
479
|
-
)
|
480
|
-
end
|
481
|
-
|
507
|
+
); end
|
482
508
|
sig do
|
483
509
|
override
|
484
510
|
.returns(
|
@@ -493,8 +519,7 @@ module Orb
|
|
493
519
|
}
|
494
520
|
)
|
495
521
|
end
|
496
|
-
def to_hash
|
497
|
-
end
|
522
|
+
def to_hash; end
|
498
523
|
end
|
499
524
|
|
500
525
|
class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
|
@@ -509,12 +534,12 @@ module Orb
|
|
509
534
|
attr_accessor :applies_to_price_ids
|
510
535
|
|
511
536
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
512
|
-
#
|
537
|
+
# that apply to only one price.
|
513
538
|
sig { returns(T::Boolean) }
|
514
539
|
attr_accessor :is_invoice_level
|
515
540
|
|
516
541
|
# The percentage (as a value between 0 and 1) by which to discount the price
|
517
|
-
#
|
542
|
+
# intervals this adjustment applies to in a given billing period.
|
518
543
|
sig { returns(Float) }
|
519
544
|
attr_accessor :percentage_discount
|
520
545
|
|
@@ -546,9 +571,7 @@ module Orb
|
|
546
571
|
plan_phase_order:,
|
547
572
|
reason:,
|
548
573
|
adjustment_type: :percentage_discount
|
549
|
-
)
|
550
|
-
end
|
551
|
-
|
574
|
+
); end
|
552
575
|
sig do
|
553
576
|
override
|
554
577
|
.returns(
|
@@ -563,8 +586,7 @@ module Orb
|
|
563
586
|
}
|
564
587
|
)
|
565
588
|
end
|
566
|
-
def to_hash
|
567
|
-
end
|
589
|
+
def to_hash; end
|
568
590
|
end
|
569
591
|
|
570
592
|
class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel
|
@@ -579,7 +601,7 @@ module Orb
|
|
579
601
|
attr_accessor :applies_to_price_ids
|
580
602
|
|
581
603
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
582
|
-
#
|
604
|
+
# that apply to only one price.
|
583
605
|
sig { returns(T::Boolean) }
|
584
606
|
attr_accessor :is_invoice_level
|
585
607
|
|
@@ -588,7 +610,7 @@ module Orb
|
|
588
610
|
attr_accessor :item_id
|
589
611
|
|
590
612
|
# The minimum amount to charge in a given billing period for the prices this
|
591
|
-
#
|
613
|
+
# adjustment applies to.
|
592
614
|
sig { returns(String) }
|
593
615
|
attr_accessor :minimum_amount
|
594
616
|
|
@@ -622,9 +644,7 @@ module Orb
|
|
622
644
|
plan_phase_order:,
|
623
645
|
reason:,
|
624
646
|
adjustment_type: :minimum
|
625
|
-
)
|
626
|
-
end
|
627
|
-
|
647
|
+
); end
|
628
648
|
sig do
|
629
649
|
override
|
630
650
|
.returns(
|
@@ -640,8 +660,7 @@ module Orb
|
|
640
660
|
}
|
641
661
|
)
|
642
662
|
end
|
643
|
-
def to_hash
|
644
|
-
end
|
663
|
+
def to_hash; end
|
645
664
|
end
|
646
665
|
|
647
666
|
class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel
|
@@ -656,12 +675,12 @@ module Orb
|
|
656
675
|
attr_accessor :applies_to_price_ids
|
657
676
|
|
658
677
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
659
|
-
#
|
678
|
+
# that apply to only one price.
|
660
679
|
sig { returns(T::Boolean) }
|
661
680
|
attr_accessor :is_invoice_level
|
662
681
|
|
663
682
|
# The maximum amount to charge in a given billing period for the prices this
|
664
|
-
#
|
683
|
+
# adjustment applies to.
|
665
684
|
sig { returns(String) }
|
666
685
|
attr_accessor :maximum_amount
|
667
686
|
|
@@ -693,9 +712,7 @@ module Orb
|
|
693
712
|
plan_phase_order:,
|
694
713
|
reason:,
|
695
714
|
adjustment_type: :maximum
|
696
|
-
)
|
697
|
-
end
|
698
|
-
|
715
|
+
); end
|
699
716
|
sig do
|
700
717
|
override
|
701
718
|
.returns(
|
@@ -710,8 +727,7 @@ module Orb
|
|
710
727
|
}
|
711
728
|
)
|
712
729
|
end
|
713
|
-
def to_hash
|
714
|
-
end
|
730
|
+
def to_hash; end
|
715
731
|
end
|
716
732
|
|
717
733
|
sig do
|
@@ -720,39 +736,36 @@ module Orb
|
|
720
736
|
[Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment]
|
721
737
|
)
|
722
738
|
end
|
723
|
-
def self.variants
|
724
|
-
end
|
739
|
+
def self.variants; end
|
725
740
|
end
|
726
741
|
end
|
727
742
|
|
728
743
|
class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel
|
729
744
|
# The day of the month on which the billing cycle is anchored. If the maximum
|
730
|
-
#
|
731
|
-
#
|
732
|
-
#
|
745
|
+
# number of days in a month is greater than this value, the last day of the month
|
746
|
+
# is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
|
747
|
+
# period begins on the 30th.
|
733
748
|
sig { returns(Integer) }
|
734
749
|
attr_accessor :day
|
735
750
|
|
736
751
|
# The month on which the billing cycle is anchored (e.g. a quarterly price
|
737
|
-
#
|
738
|
-
#
|
752
|
+
# anchored in February would have cycles starting February, May, August, and
|
753
|
+
# November).
|
739
754
|
sig { returns(T.nilable(Integer)) }
|
740
755
|
attr_accessor :month
|
741
756
|
|
742
757
|
# The year on which the billing cycle is anchored (e.g. a 2 year billing cycle
|
743
|
-
#
|
758
|
+
# anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.).
|
744
759
|
sig { returns(T.nilable(Integer)) }
|
745
760
|
attr_accessor :year
|
746
761
|
|
747
762
|
sig do
|
748
763
|
params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class)
|
749
764
|
end
|
750
|
-
def self.new(day:, month: nil, year: nil)
|
751
|
-
end
|
765
|
+
def self.new(day:, month: nil, year: nil); end
|
752
766
|
|
753
767
|
sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) }
|
754
|
-
def to_hash
|
755
|
-
end
|
768
|
+
def to_hash; end
|
756
769
|
end
|
757
770
|
|
758
771
|
module DiscountInterval
|
@@ -800,9 +813,7 @@ module Orb
|
|
800
813
|
end_date:,
|
801
814
|
start_date:,
|
802
815
|
discount_type: :amount
|
803
|
-
)
|
804
|
-
end
|
805
|
-
|
816
|
+
); end
|
806
817
|
sig do
|
807
818
|
override
|
808
819
|
.returns(
|
@@ -816,8 +827,7 @@ module Orb
|
|
816
827
|
}
|
817
828
|
)
|
818
829
|
end
|
819
|
-
def to_hash
|
820
|
-
end
|
830
|
+
def to_hash; end
|
821
831
|
end
|
822
832
|
|
823
833
|
class PercentageDiscountInterval < Orb::Internal::Type::BaseModel
|
@@ -837,7 +847,7 @@ module Orb
|
|
837
847
|
attr_accessor :end_date
|
838
848
|
|
839
849
|
# Only available if discount_type is `percentage`.This is a number between 0
|
840
|
-
#
|
850
|
+
# and 1.
|
841
851
|
sig { returns(Float) }
|
842
852
|
attr_accessor :percentage_discount
|
843
853
|
|
@@ -863,9 +873,7 @@ module Orb
|
|
863
873
|
percentage_discount:,
|
864
874
|
start_date:,
|
865
875
|
discount_type: :percentage
|
866
|
-
)
|
867
|
-
end
|
868
|
-
|
876
|
+
); end
|
869
877
|
sig do
|
870
878
|
override
|
871
879
|
.returns(
|
@@ -879,8 +887,7 @@ module Orb
|
|
879
887
|
}
|
880
888
|
)
|
881
889
|
end
|
882
|
-
def to_hash
|
883
|
-
end
|
890
|
+
def to_hash; end
|
884
891
|
end
|
885
892
|
|
886
893
|
class UsageDiscountInterval < Orb::Internal::Type::BaseModel
|
@@ -904,7 +911,7 @@ module Orb
|
|
904
911
|
attr_accessor :start_date
|
905
912
|
|
906
913
|
# Only available if discount_type is `usage`. Number of usage units that this
|
907
|
-
#
|
914
|
+
# discount is for
|
908
915
|
sig { returns(Float) }
|
909
916
|
attr_accessor :usage_discount
|
910
917
|
|
@@ -926,9 +933,7 @@ module Orb
|
|
926
933
|
start_date:,
|
927
934
|
usage_discount:,
|
928
935
|
discount_type: :usage
|
929
|
-
)
|
930
|
-
end
|
931
|
-
|
936
|
+
); end
|
932
937
|
sig do
|
933
938
|
override
|
934
939
|
.returns(
|
@@ -942,8 +947,7 @@ module Orb
|
|
942
947
|
}
|
943
948
|
)
|
944
949
|
end
|
945
|
-
def to_hash
|
946
|
-
end
|
950
|
+
def to_hash; end
|
947
951
|
end
|
948
952
|
|
949
953
|
sig do
|
@@ -952,8 +956,7 @@ module Orb
|
|
952
956
|
[Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::UsageDiscountInterval]
|
953
957
|
)
|
954
958
|
end
|
955
|
-
def self.variants
|
956
|
-
end
|
959
|
+
def self.variants; end
|
957
960
|
end
|
958
961
|
|
959
962
|
class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
|
@@ -973,14 +976,12 @@ module Orb
|
|
973
976
|
params(end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time)
|
974
977
|
.returns(T.attached_class)
|
975
978
|
end
|
976
|
-
def self.new(end_date:, price_id:, quantity:, start_date:)
|
977
|
-
end
|
979
|
+
def self.new(end_date:, price_id:, quantity:, start_date:); end
|
978
980
|
|
979
981
|
sig do
|
980
982
|
override.returns({end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time})
|
981
983
|
end
|
982
|
-
def to_hash
|
983
|
-
end
|
984
|
+
def to_hash; end
|
984
985
|
end
|
985
986
|
|
986
987
|
class MaximumInterval < Orb::Internal::Type::BaseModel
|
@@ -997,7 +998,7 @@ module Orb
|
|
997
998
|
attr_accessor :end_date
|
998
999
|
|
999
1000
|
# The maximum amount to charge in a given billing period for the price intervals
|
1000
|
-
#
|
1001
|
+
# this transform applies to.
|
1001
1002
|
sig { returns(String) }
|
1002
1003
|
attr_accessor :maximum_amount
|
1003
1004
|
|
@@ -1036,8 +1037,7 @@ module Orb
|
|
1036
1037
|
}
|
1037
1038
|
)
|
1038
1039
|
end
|
1039
|
-
def to_hash
|
1040
|
-
end
|
1040
|
+
def to_hash; end
|
1041
1041
|
end
|
1042
1042
|
|
1043
1043
|
class MinimumInterval < Orb::Internal::Type::BaseModel
|
@@ -1054,7 +1054,7 @@ module Orb
|
|
1054
1054
|
attr_accessor :end_date
|
1055
1055
|
|
1056
1056
|
# The minimum amount to charge in a given billing period for the price intervals
|
1057
|
-
#
|
1057
|
+
# this minimum applies to.
|
1058
1058
|
sig { returns(String) }
|
1059
1059
|
attr_accessor :minimum_amount
|
1060
1060
|
|
@@ -1093,8 +1093,19 @@ module Orb
|
|
1093
1093
|
}
|
1094
1094
|
)
|
1095
1095
|
end
|
1096
|
-
def to_hash
|
1097
|
-
|
1096
|
+
def to_hash; end
|
1097
|
+
end
|
1098
|
+
|
1099
|
+
class PendingSubscriptionChange < Orb::Internal::Type::BaseModel
|
1100
|
+
sig { returns(String) }
|
1101
|
+
attr_accessor :id
|
1102
|
+
|
1103
|
+
# A pending subscription change if one exists on this subscription.
|
1104
|
+
sig { params(id: String).returns(T.attached_class) }
|
1105
|
+
def self.new(id:); end
|
1106
|
+
|
1107
|
+
sig { override.returns({id: String}) }
|
1108
|
+
def to_hash; end
|
1098
1109
|
end
|
1099
1110
|
|
1100
1111
|
class PriceInterval < Orb::Internal::Type::BaseModel
|
@@ -1106,19 +1117,19 @@ module Orb
|
|
1106
1117
|
attr_accessor :billing_cycle_day
|
1107
1118
|
|
1108
1119
|
# The end of the current billing period. This is an exclusive timestamp, such that
|
1109
|
-
#
|
1110
|
-
#
|
1120
|
+
# the instant returned is exactly the end of the billing period. Set to null if
|
1121
|
+
# this price interval is not currently active.
|
1111
1122
|
sig { returns(T.nilable(Time)) }
|
1112
1123
|
attr_accessor :current_billing_period_end_date
|
1113
1124
|
|
1114
1125
|
# The start date of the current billing period. This is an inclusive timestamp;
|
1115
|
-
#
|
1116
|
-
#
|
1126
|
+
# the instant returned is exactly the beginning of the billing period. Set to null
|
1127
|
+
# if this price interval is not currently active.
|
1117
1128
|
sig { returns(T.nilable(Time)) }
|
1118
1129
|
attr_accessor :current_billing_period_start_date
|
1119
1130
|
|
1120
1131
|
# The end date of the price interval. This is the date that Orb stops billing for
|
1121
|
-
#
|
1132
|
+
# this price.
|
1122
1133
|
sig { returns(T.nilable(Time)) }
|
1123
1134
|
attr_accessor :end_date
|
1124
1135
|
|
@@ -1127,7 +1138,7 @@ module Orb
|
|
1127
1138
|
attr_accessor :filter
|
1128
1139
|
|
1129
1140
|
# The fixed fee quantity transitions for this price interval. This is only
|
1130
|
-
#
|
1141
|
+
# relevant for fixed fees.
|
1131
1142
|
sig do
|
1132
1143
|
returns(
|
1133
1144
|
T.nilable(
|
@@ -1138,15 +1149,15 @@ module Orb
|
|
1138
1149
|
attr_accessor :fixed_fee_quantity_transitions
|
1139
1150
|
|
1140
1151
|
# The Price resource represents a price that can be billed on a subscription,
|
1141
|
-
#
|
1142
|
-
#
|
1152
|
+
# resulting in a charge on an invoice in the form of an invoice line item. Prices
|
1153
|
+
# take a quantity and determine an amount to bill.
|
1143
1154
|
#
|
1144
|
-
#
|
1145
|
-
#
|
1146
|
-
#
|
1155
|
+
# Orb supports a few different pricing models out of the box. Each of these models
|
1156
|
+
# is serialized differently in a given Price object. The model_type field
|
1157
|
+
# determines the key for the configuration object that is present.
|
1147
1158
|
#
|
1148
|
-
#
|
1149
|
-
#
|
1159
|
+
# For more on the types of prices, see
|
1160
|
+
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1150
1161
|
sig do
|
1151
1162
|
returns(
|
1152
1163
|
T.any(
|
@@ -1184,18 +1195,18 @@ module Orb
|
|
1184
1195
|
attr_accessor :price
|
1185
1196
|
|
1186
1197
|
# The start date of the price interval. This is the date that Orb starts billing
|
1187
|
-
#
|
1198
|
+
# for this price.
|
1188
1199
|
sig { returns(Time) }
|
1189
1200
|
attr_accessor :start_date
|
1190
1201
|
|
1191
1202
|
# A list of customer IDs whose usage events will be aggregated and billed under
|
1192
|
-
#
|
1203
|
+
# this price interval.
|
1193
1204
|
sig { returns(T.nilable(T::Array[String])) }
|
1194
1205
|
attr_accessor :usage_customer_ids
|
1195
1206
|
|
1196
1207
|
# The Price Interval resource represents a period of time for which a price will
|
1197
|
-
#
|
1198
|
-
#
|
1208
|
+
# bill on a subscription. A subscription’s price intervals define its billing
|
1209
|
+
# behavior.
|
1199
1210
|
sig do
|
1200
1211
|
params(
|
1201
1212
|
id: String,
|
@@ -1206,10 +1217,10 @@ module Orb
|
|
1206
1217
|
filter: T.nilable(String),
|
1207
1218
|
fixed_fee_quantity_transitions: T.nilable(
|
1208
1219
|
T::Array[
|
1209
|
-
|
1210
|
-
|
1211
|
-
|
1212
|
-
|
1220
|
+
T.any(
|
1221
|
+
Orb::Models::SubscriptionUpdateTrialResponse::PriceInterval::FixedFeeQuantityTransition,
|
1222
|
+
Orb::Internal::AnyHash
|
1223
|
+
)
|
1213
1224
|
]
|
1214
1225
|
),
|
1215
1226
|
price: T.any(
|
@@ -1259,9 +1270,7 @@ module Orb
|
|
1259
1270
|
price:,
|
1260
1271
|
start_date:,
|
1261
1272
|
usage_customer_ids:
|
1262
|
-
)
|
1263
|
-
end
|
1264
|
-
|
1273
|
+
); end
|
1265
1274
|
sig do
|
1266
1275
|
override
|
1267
1276
|
.returns(
|
@@ -1310,8 +1319,7 @@ module Orb
|
|
1310
1319
|
}
|
1311
1320
|
)
|
1312
1321
|
end
|
1313
|
-
def to_hash
|
1314
|
-
end
|
1322
|
+
def to_hash; end
|
1315
1323
|
|
1316
1324
|
class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
|
1317
1325
|
sig { returns(Time) }
|
@@ -1324,12 +1332,10 @@ module Orb
|
|
1324
1332
|
attr_accessor :quantity
|
1325
1333
|
|
1326
1334
|
sig { params(effective_date: Time, price_id: String, quantity: Integer).returns(T.attached_class) }
|
1327
|
-
def self.new(effective_date:, price_id:, quantity:)
|
1328
|
-
end
|
1335
|
+
def self.new(effective_date:, price_id:, quantity:); end
|
1329
1336
|
|
1330
1337
|
sig { override.returns({effective_date: Time, price_id: String, quantity: Integer}) }
|
1331
|
-
def to_hash
|
1332
|
-
end
|
1338
|
+
def to_hash; end
|
1333
1339
|
end
|
1334
1340
|
end
|
1335
1341
|
|
@@ -1346,12 +1352,10 @@ module Orb
|
|
1346
1352
|
sig do
|
1347
1353
|
params(coupon_id: String, end_date: T.nilable(Time), start_date: Time).returns(T.attached_class)
|
1348
1354
|
end
|
1349
|
-
def self.new(coupon_id:, end_date:, start_date:)
|
1350
|
-
end
|
1355
|
+
def self.new(coupon_id:, end_date:, start_date:); end
|
1351
1356
|
|
1352
1357
|
sig { override.returns({coupon_id: String, end_date: T.nilable(Time), start_date: Time}) }
|
1353
|
-
def to_hash
|
1354
|
-
end
|
1358
|
+
def to_hash; end
|
1355
1359
|
end
|
1356
1360
|
|
1357
1361
|
module Status
|
@@ -1366,8 +1370,7 @@ module Orb
|
|
1366
1370
|
UPCOMING = T.let(:upcoming, Orb::Models::SubscriptionUpdateTrialResponse::Status::TaggedSymbol)
|
1367
1371
|
|
1368
1372
|
sig { override.returns(T::Array[Orb::Models::SubscriptionUpdateTrialResponse::Status::TaggedSymbol]) }
|
1369
|
-
def self.values
|
1370
|
-
end
|
1373
|
+
def self.values; end
|
1371
1374
|
end
|
1372
1375
|
|
1373
1376
|
class TrialInfo < Orb::Internal::Type::BaseModel
|
@@ -1375,12 +1378,55 @@ module Orb
|
|
1375
1378
|
attr_accessor :end_date
|
1376
1379
|
|
1377
1380
|
sig { params(end_date: T.nilable(Time)).returns(T.attached_class) }
|
1378
|
-
def self.new(end_date:)
|
1379
|
-
end
|
1381
|
+
def self.new(end_date:); end
|
1380
1382
|
|
1381
1383
|
sig { override.returns({end_date: T.nilable(Time)}) }
|
1382
|
-
def to_hash
|
1384
|
+
def to_hash; end
|
1385
|
+
end
|
1386
|
+
|
1387
|
+
class ChangedResources < Orb::Internal::Type::BaseModel
|
1388
|
+
# The credit notes that were created as part of this operation.
|
1389
|
+
sig { returns(T::Array[Orb::Models::CreditNote]) }
|
1390
|
+
attr_accessor :created_credit_notes
|
1391
|
+
|
1392
|
+
# The invoices that were created as part of this operation.
|
1393
|
+
sig { returns(T::Array[Orb::Models::Invoice]) }
|
1394
|
+
attr_accessor :created_invoices
|
1395
|
+
|
1396
|
+
# The credit notes that were voided as part of this operation.
|
1397
|
+
sig { returns(T::Array[Orb::Models::CreditNote]) }
|
1398
|
+
attr_accessor :voided_credit_notes
|
1399
|
+
|
1400
|
+
# The invoices that were voided as part of this operation.
|
1401
|
+
sig { returns(T::Array[Orb::Models::Invoice]) }
|
1402
|
+
attr_accessor :voided_invoices
|
1403
|
+
|
1404
|
+
# The resources that were changed as part of this operation. Only present when
|
1405
|
+
# fetched through the subscription changes API or if the
|
1406
|
+
# `include_changed_resources` parameter was passed in the request.
|
1407
|
+
sig do
|
1408
|
+
params(
|
1409
|
+
created_credit_notes: T::Array[T.any(Orb::Models::CreditNote, Orb::Internal::AnyHash)],
|
1410
|
+
created_invoices: T::Array[T.any(Orb::Models::Invoice, Orb::Internal::AnyHash)],
|
1411
|
+
voided_credit_notes: T::Array[T.any(Orb::Models::CreditNote, Orb::Internal::AnyHash)],
|
1412
|
+
voided_invoices: T::Array[T.any(Orb::Models::Invoice, Orb::Internal::AnyHash)]
|
1413
|
+
)
|
1414
|
+
.returns(T.attached_class)
|
1415
|
+
end
|
1416
|
+
def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end
|
1417
|
+
|
1418
|
+
sig do
|
1419
|
+
override
|
1420
|
+
.returns(
|
1421
|
+
{
|
1422
|
+
created_credit_notes: T::Array[Orb::Models::CreditNote],
|
1423
|
+
created_invoices: T::Array[Orb::Models::Invoice],
|
1424
|
+
voided_credit_notes: T::Array[Orb::Models::CreditNote],
|
1425
|
+
voided_invoices: T::Array[Orb::Models::Invoice]
|
1426
|
+
}
|
1427
|
+
)
|
1383
1428
|
end
|
1429
|
+
def to_hash; end
|
1384
1430
|
end
|
1385
1431
|
end
|
1386
1432
|
end
|