orb-billing 1.13.0 → 1.14.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 +43 -0
- data/README.md +1 -1
- data/lib/orb/client.rb +7 -0
- data/lib/orb/internal/util.rb +22 -7
- data/lib/orb/models/alert.rb +10 -1
- data/lib/orb/models/alert_create_for_customer_params.rb +8 -1
- data/lib/orb/models/alert_create_for_external_customer_params.rb +8 -1
- data/lib/orb/models/alert_create_for_subscription_params.rb +29 -1
- data/lib/orb/models/alert_disable_params.rb +8 -1
- data/lib/orb/models/alert_enable_params.rb +8 -1
- data/lib/orb/models/alert_retrieve_params.rb +7 -1
- data/lib/orb/models/alert_update_params.rb +8 -1
- data/lib/orb/models/beta/external_plan_id_create_plan_version_params.rb +17769 -414
- data/lib/orb/models/beta/external_plan_id_fetch_plan_version_params.rb +7 -1
- data/lib/orb/models/beta/external_plan_id_set_default_plan_version_params.rb +8 -1
- data/lib/orb/models/beta_create_plan_version_params.rb +17633 -406
- data/lib/orb/models/beta_fetch_plan_version_params.rb +7 -1
- data/lib/orb/models/beta_set_default_plan_version_params.rb +8 -1
- data/lib/orb/models/coupon_archive_params.rb +7 -1
- data/lib/orb/models/coupon_fetch_params.rb +7 -1
- data/lib/orb/models/coupons/subscription_list_params.rb +8 -1
- data/lib/orb/models/credit_block_delete_params.rb +7 -1
- data/lib/orb/models/credit_block_list_invoices_params.rb +7 -1
- data/lib/orb/models/credit_block_retrieve_params.rb +7 -1
- data/lib/orb/models/credit_note_fetch_params.rb +7 -1
- data/lib/orb/models/customer.rb +13 -1
- data/lib/orb/models/customer_create_params.rb +12 -1
- data/lib/orb/models/customer_delete_params.rb +7 -1
- data/lib/orb/models/customer_fetch_by_external_id_params.rb +7 -1
- data/lib/orb/models/customer_fetch_params.rb +7 -1
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +7 -1
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +7 -1
- data/lib/orb/models/customer_update_by_external_id_params.rb +25 -5
- data/lib/orb/models/customer_update_params.rb +25 -5
- data/lib/orb/models/customers/balance_transaction_create_params.rb +8 -1
- data/lib/orb/models/customers/balance_transaction_list_params.rb +8 -1
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +8 -1
- data/lib/orb/models/customers/cost_list_params.rb +8 -1
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +8 -1
- data/lib/orb/models/customers/credit_list_params.rb +8 -1
- data/lib/orb/models/customers/credits/decrement_ledger_entry.rb +5 -1
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +582 -315
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +580 -313
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +8 -1
- data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -1
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +8 -1
- data/lib/orb/models/customers/credits/top_up_create_params.rb +8 -1
- data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +7 -1
- data/lib/orb/models/customers/credits/top_up_delete_params.rb +7 -1
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +8 -1
- data/lib/orb/models/customers/credits/top_up_list_params.rb +8 -1
- data/lib/orb/models/dimensional_price_group_retrieve_params.rb +7 -1
- data/lib/orb/models/dimensional_price_group_update_params.rb +8 -1
- data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +7 -1
- data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rb +8 -1
- data/lib/orb/models/event_deprecate_params.rb +7 -1
- data/lib/orb/models/event_update_params.rb +8 -1
- data/lib/orb/models/events/backfill_close_params.rb +7 -1
- data/lib/orb/models/events/backfill_fetch_params.rb +7 -1
- data/lib/orb/models/events/backfill_revert_params.rb +7 -1
- data/lib/orb/models/invoice_delete_line_item_params.rb +7 -1
- data/lib/orb/models/invoice_fetch_params.rb +7 -1
- data/lib/orb/models/invoice_issue_params.rb +8 -1
- data/lib/orb/models/invoice_issue_summary_params.rb +8 -1
- data/lib/orb/models/invoice_mark_paid_params.rb +8 -1
- data/lib/orb/models/invoice_pay_params.rb +16 -1
- data/lib/orb/models/invoice_update_params.rb +8 -1
- data/lib/orb/models/invoice_void_params.rb +7 -1
- data/lib/orb/models/item_archive_params.rb +7 -1
- data/lib/orb/models/item_fetch_params.rb +7 -1
- data/lib/orb/models/item_update_params.rb +8 -1
- data/lib/orb/models/license_deactivate_params.rb +8 -1
- data/lib/orb/models/license_retrieve_by_external_id_params.rb +8 -1
- data/lib/orb/models/license_retrieve_params.rb +7 -1
- data/lib/orb/models/license_type_retrieve_params.rb +7 -1
- data/lib/orb/models/licenses/external_license_get_usage_params.rb +8 -1
- data/lib/orb/models/licenses/usage_get_usage_params.rb +8 -1
- data/lib/orb/models/metric_fetch_params.rb +7 -1
- data/lib/orb/models/metric_update_params.rb +8 -1
- data/lib/orb/models/plan_create_params.rb +8502 -1
- data/lib/orb/models/plan_fetch_params.rb +7 -1
- data/lib/orb/models/plan_update_params.rb +8 -1
- data/lib/orb/models/plans/external_plan_id_fetch_params.rb +7 -1
- data/lib/orb/models/plans/external_plan_id_update_params.rb +8 -1
- data/lib/orb/models/plans/migration_cancel_params.rb +7 -1
- data/lib/orb/models/plans/migration_list_params.rb +8 -1
- data/lib/orb/models/plans/migration_retrieve_params.rb +7 -1
- data/lib/orb/models/price.rb +248 -31
- data/lib/orb/models/price_create_params.rb +949 -1321
- data/lib/orb/models/price_evaluate_params.rb +8 -1
- data/lib/orb/models/price_fetch_params.rb +7 -1
- data/lib/orb/models/price_update_params.rb +8 -1
- data/lib/orb/models/prices/external_price_id_fetch_params.rb +7 -1
- data/lib/orb/models/prices/external_price_id_update_params.rb +8 -1
- data/lib/orb/models/subscription_cancel_params.rb +8 -1
- data/lib/orb/models/subscription_change_apply_params.rb +8 -1
- data/lib/orb/models/subscription_change_cancel_params.rb +7 -1
- data/lib/orb/models/subscription_change_retrieve_params.rb +7 -1
- data/lib/orb/models/subscription_fetch_costs_params.rb +8 -1
- data/lib/orb/models/subscription_fetch_params.rb +7 -1
- data/lib/orb/models/subscription_fetch_schedule_params.rb +8 -1
- data/lib/orb/models/subscription_fetch_usage_params.rb +8 -1
- data/lib/orb/models/subscription_price_intervals_params.rb +8 -1
- data/lib/orb/models/subscription_redeem_coupon_params.rb +8 -1
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +8 -1
- data/lib/orb/models/subscription_trigger_phase_params.rb +8 -1
- data/lib/orb/models/subscription_unschedule_cancellation_params.rb +7 -1
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +8 -1
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +7 -1
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +8 -1
- data/lib/orb/models/subscription_update_params.rb +8 -1
- data/lib/orb/models/subscription_update_trial_params.rb +8 -1
- data/lib/orb/resources/alerts.rb +8 -1
- data/lib/orb/resources/coupons.rb +1 -2
- data/lib/orb/resources/credit_blocks.rb +11 -8
- data/lib/orb/resources/customers/credits/ledger.rb +12 -67
- data/lib/orb/resources/customers.rb +6 -5
- data/lib/orb/resources/events/backfills.rb +3 -4
- data/lib/orb/resources/invoices.rb +12 -5
- data/lib/orb/resources/prices.rb +9 -100
- data/lib/orb/resources/subscriptions.rb +4 -4
- data/lib/orb/version.rb +1 -1
- data/rbi/orb/client.rbi +6 -0
- data/rbi/orb/internal/util.rbi +8 -0
- data/rbi/orb/models/alert.rbi +10 -0
- data/rbi/orb/models/alert_create_for_customer_params.rbi +6 -0
- data/rbi/orb/models/alert_create_for_external_customer_params.rbi +6 -0
- data/rbi/orb/models/alert_create_for_subscription_params.rbi +26 -0
- data/rbi/orb/models/alert_disable_params.rbi +6 -0
- data/rbi/orb/models/alert_enable_params.rbi +6 -0
- data/rbi/orb/models/alert_retrieve_params.rbi +13 -5
- data/rbi/orb/models/alert_update_params.rbi +6 -0
- data/rbi/orb/models/beta/external_plan_id_create_plan_version_params.rbi +30163 -889
- data/rbi/orb/models/beta/external_plan_id_fetch_plan_version_params.rbi +10 -2
- data/rbi/orb/models/beta/external_plan_id_set_default_plan_version_params.rbi +10 -1
- data/rbi/orb/models/beta_create_plan_version_params.rbi +30126 -884
- data/rbi/orb/models/beta_fetch_plan_version_params.rbi +10 -2
- data/rbi/orb/models/beta_set_default_plan_version_params.rbi +10 -1
- data/rbi/orb/models/coupon_archive_params.rbi +13 -5
- data/rbi/orb/models/coupon_fetch_params.rbi +13 -5
- data/rbi/orb/models/coupons/subscription_list_params.rbi +6 -0
- data/rbi/orb/models/credit_block_delete_params.rbi +13 -5
- data/rbi/orb/models/credit_block_list_invoices_params.rbi +13 -5
- data/rbi/orb/models/credit_block_retrieve_params.rbi +13 -5
- data/rbi/orb/models/credit_note_fetch_params.rbi +13 -5
- data/rbi/orb/models/customer.rbi +22 -0
- data/rbi/orb/models/customer_create_params.rbi +17 -0
- data/rbi/orb/models/customer_delete_params.rbi +13 -5
- data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +13 -5
- data/rbi/orb/models/customer_fetch_params.rbi +13 -5
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +13 -5
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +13 -5
- data/rbi/orb/models/customer_update_by_external_id_params.rbi +31 -4
- data/rbi/orb/models/customer_update_params.rbi +31 -4
- data/rbi/orb/models/customers/balance_transaction_create_params.rbi +6 -0
- data/rbi/orb/models/customers/balance_transaction_list_params.rbi +6 -0
- data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +6 -0
- data/rbi/orb/models/customers/cost_list_params.rbi +6 -0
- data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi +6 -0
- data/rbi/orb/models/customers/credit_list_params.rbi +6 -0
- data/rbi/orb/models/customers/credits/decrement_ledger_entry.rbi +4 -0
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +861 -478
- data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +861 -478
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -0
- data/rbi/orb/models/customers/credits/ledger_list_params.rbi +6 -0
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +6 -0
- data/rbi/orb/models/customers/credits/top_up_create_params.rbi +6 -0
- data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +6 -1
- data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +10 -2
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +6 -0
- data/rbi/orb/models/customers/credits/top_up_list_params.rbi +6 -0
- data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +16 -5
- data/rbi/orb/models/dimensional_price_group_update_params.rbi +6 -0
- data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +16 -5
- data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rbi +6 -0
- data/rbi/orb/models/event_deprecate_params.rbi +13 -5
- data/rbi/orb/models/event_update_params.rbi +6 -0
- data/rbi/orb/models/events/backfill_close_params.rbi +13 -5
- data/rbi/orb/models/events/backfill_fetch_params.rbi +13 -5
- data/rbi/orb/models/events/backfill_revert_params.rbi +13 -5
- data/rbi/orb/models/invoice_delete_line_item_params.rbi +10 -2
- data/rbi/orb/models/invoice_fetch_params.rbi +13 -5
- data/rbi/orb/models/invoice_issue_params.rbi +10 -1
- data/rbi/orb/models/invoice_issue_summary_params.rbi +10 -1
- data/rbi/orb/models/invoice_mark_paid_params.rbi +6 -0
- data/rbi/orb/models/invoice_pay_params.rbi +27 -5
- data/rbi/orb/models/invoice_update_params.rbi +6 -0
- data/rbi/orb/models/invoice_void_params.rbi +13 -5
- data/rbi/orb/models/item_archive_params.rbi +13 -5
- data/rbi/orb/models/item_fetch_params.rbi +13 -5
- data/rbi/orb/models/item_update_params.rbi +6 -0
- data/rbi/orb/models/license_deactivate_params.rbi +10 -1
- data/rbi/orb/models/license_retrieve_by_external_id_params.rbi +6 -0
- data/rbi/orb/models/license_retrieve_params.rbi +13 -5
- data/rbi/orb/models/license_type_retrieve_params.rbi +13 -5
- data/rbi/orb/models/licenses/external_license_get_usage_params.rbi +6 -0
- data/rbi/orb/models/licenses/usage_get_usage_params.rbi +6 -0
- data/rbi/orb/models/metric_fetch_params.rbi +13 -5
- data/rbi/orb/models/metric_update_params.rbi +6 -0
- data/rbi/orb/models/plan_create_params.rbi +14618 -0
- data/rbi/orb/models/plan_fetch_params.rbi +13 -5
- data/rbi/orb/models/plan_update_params.rbi +6 -0
- data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +13 -5
- data/rbi/orb/models/plans/external_plan_id_update_params.rbi +6 -0
- data/rbi/orb/models/plans/migration_cancel_params.rbi +10 -2
- data/rbi/orb/models/plans/migration_list_params.rbi +6 -0
- data/rbi/orb/models/plans/migration_retrieve_params.rbi +10 -2
- data/rbi/orb/models/price.rbi +186 -0
- data/rbi/orb/models/price_create_params.rbi +1778 -2590
- data/rbi/orb/models/price_evaluate_params.rbi +6 -0
- data/rbi/orb/models/price_fetch_params.rbi +13 -5
- data/rbi/orb/models/price_update_params.rbi +6 -0
- data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +13 -5
- data/rbi/orb/models/prices/external_price_id_update_params.rbi +6 -0
- data/rbi/orb/models/subscription_cancel_params.rbi +6 -0
- data/rbi/orb/models/subscription_change_apply_params.rbi +6 -0
- data/rbi/orb/models/subscription_change_cancel_params.rbi +16 -5
- data/rbi/orb/models/subscription_change_retrieve_params.rbi +16 -5
- data/rbi/orb/models/subscription_fetch_costs_params.rbi +6 -0
- data/rbi/orb/models/subscription_fetch_params.rbi +13 -5
- data/rbi/orb/models/subscription_fetch_schedule_params.rbi +6 -0
- data/rbi/orb/models/subscription_fetch_usage_params.rbi +6 -0
- data/rbi/orb/models/subscription_price_intervals_params.rbi +6 -0
- data/rbi/orb/models/subscription_redeem_coupon_params.rbi +6 -0
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +6 -0
- data/rbi/orb/models/subscription_trigger_phase_params.rbi +6 -0
- data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +13 -5
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +10 -1
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +13 -5
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +6 -0
- data/rbi/orb/models/subscription_update_params.rbi +6 -0
- data/rbi/orb/models/subscription_update_trial_params.rbi +6 -0
- data/rbi/orb/resources/alerts.rbi +8 -0
- data/rbi/orb/resources/coupons.rbi +1 -2
- data/rbi/orb/resources/credit_blocks.rbi +10 -7
- data/rbi/orb/resources/customers/credits/ledger.rbi +22 -132
- data/rbi/orb/resources/customers.rbi +12 -7
- data/rbi/orb/resources/events/backfills.rbi +3 -4
- data/rbi/orb/resources/invoices.rbi +11 -3
- data/rbi/orb/resources/prices.rbi +35 -184
- data/rbi/orb/resources/subscriptions.rbi +4 -4
- data/sig/orb/client.rbs +3 -0
- data/sig/orb/internal/util.rbs +4 -0
- data/sig/orb/models/alert.rbs +5 -0
- data/sig/orb/models/alert_create_for_customer_params.rbs +5 -0
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +5 -0
- data/sig/orb/models/alert_create_for_subscription_params.rbs +16 -1
- data/sig/orb/models/alert_disable_params.rbs +6 -1
- data/sig/orb/models/alert_enable_params.rbs +6 -1
- data/sig/orb/models/alert_retrieve_params.rbs +9 -3
- data/sig/orb/models/alert_update_params.rbs +5 -1
- data/sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs +12092 -373
- data/sig/orb/models/beta/external_plan_id_fetch_plan_version_params.rbs +6 -1
- data/sig/orb/models/beta/external_plan_id_set_default_plan_version_params.rbs +6 -1
- data/sig/orb/models/beta_create_plan_version_params.rbs +12075 -370
- data/sig/orb/models/beta_fetch_plan_version_params.rbs +10 -2
- data/sig/orb/models/beta_set_default_plan_version_params.rbs +10 -2
- data/sig/orb/models/coupon_archive_params.rbs +12 -3
- data/sig/orb/models/coupon_fetch_params.rbs +12 -3
- data/sig/orb/models/coupons/subscription_list_params.rbs +5 -1
- data/sig/orb/models/credit_block_delete_params.rbs +8 -3
- data/sig/orb/models/credit_block_list_invoices_params.rbs +8 -3
- data/sig/orb/models/credit_block_retrieve_params.rbs +8 -3
- data/sig/orb/models/credit_note_fetch_params.rbs +11 -3
- data/sig/orb/models/customer.rbs +14 -2
- data/sig/orb/models/customer_create_params.rbs +12 -1
- data/sig/orb/models/customer_delete_params.rbs +12 -3
- data/sig/orb/models/customer_fetch_by_external_id_params.rbs +11 -3
- data/sig/orb/models/customer_fetch_params.rbs +12 -3
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +11 -3
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +11 -3
- data/sig/orb/models/customer_update_by_external_id_params.rbs +17 -1
- data/sig/orb/models/customer_update_params.rbs +17 -1
- data/sig/orb/models/customers/balance_transaction_create_params.rbs +5 -0
- data/sig/orb/models/customers/balance_transaction_list_params.rbs +5 -0
- data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +5 -0
- data/sig/orb/models/customers/cost_list_params.rbs +5 -0
- data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +5 -0
- data/sig/orb/models/customers/credit_list_params.rbs +5 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +345 -157
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +345 -157
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +5 -0
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +5 -0
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +5 -0
- data/sig/orb/models/customers/credits/top_up_create_params.rbs +5 -0
- data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +5 -1
- data/sig/orb/models/customers/credits/top_up_delete_params.rbs +6 -1
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +5 -1
- data/sig/orb/models/customers/credits/top_up_list_params.rbs +5 -1
- data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +12 -3
- data/sig/orb/models/dimensional_price_group_update_params.rbs +5 -0
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +12 -3
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rbs +5 -0
- data/sig/orb/models/event_deprecate_params.rbs +9 -3
- data/sig/orb/models/event_update_params.rbs +5 -0
- data/sig/orb/models/events/backfill_close_params.rbs +11 -3
- data/sig/orb/models/events/backfill_fetch_params.rbs +11 -3
- data/sig/orb/models/events/backfill_revert_params.rbs +11 -3
- data/sig/orb/models/invoice_delete_line_item_params.rbs +6 -1
- data/sig/orb/models/invoice_fetch_params.rbs +12 -3
- data/sig/orb/models/invoice_issue_params.rbs +6 -1
- data/sig/orb/models/invoice_issue_summary_params.rbs +6 -1
- data/sig/orb/models/invoice_mark_paid_params.rbs +10 -1
- data/sig/orb/models/invoice_pay_params.rbs +17 -3
- data/sig/orb/models/invoice_update_params.rbs +5 -0
- data/sig/orb/models/invoice_void_params.rbs +12 -3
- data/sig/orb/models/item_archive_params.rbs +9 -3
- data/sig/orb/models/item_fetch_params.rbs +9 -3
- data/sig/orb/models/item_update_params.rbs +5 -0
- data/sig/orb/models/license_deactivate_params.rbs +10 -2
- data/sig/orb/models/license_retrieve_by_external_id_params.rbs +9 -1
- data/sig/orb/models/license_retrieve_params.rbs +11 -3
- data/sig/orb/models/license_type_retrieve_params.rbs +11 -3
- data/sig/orb/models/licenses/external_license_get_usage_params.rbs +5 -0
- data/sig/orb/models/licenses/usage_get_usage_params.rbs +5 -0
- data/sig/orb/models/metric_fetch_params.rbs +12 -3
- data/sig/orb/models/metric_update_params.rbs +5 -1
- data/sig/orb/models/plan_create_params.rbs +5850 -0
- data/sig/orb/models/plan_fetch_params.rbs +9 -3
- data/sig/orb/models/plan_update_params.rbs +9 -1
- data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +11 -3
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +9 -1
- data/sig/orb/models/plans/migration_cancel_params.rbs +6 -1
- data/sig/orb/models/plans/migration_list_params.rbs +5 -1
- data/sig/orb/models/plans/migration_retrieve_params.rbs +6 -1
- data/sig/orb/models/price.rbs +155 -0
- data/sig/orb/models/price_create_params.rbs +616 -1011
- data/sig/orb/models/price_evaluate_params.rbs +5 -0
- data/sig/orb/models/price_fetch_params.rbs +9 -3
- data/sig/orb/models/price_update_params.rbs +5 -1
- data/sig/orb/models/prices/external_price_id_fetch_params.rbs +11 -3
- data/sig/orb/models/prices/external_price_id_update_params.rbs +5 -1
- data/sig/orb/models/subscription_cancel_params.rbs +5 -0
- data/sig/orb/models/subscription_change_apply_params.rbs +5 -0
- data/sig/orb/models/subscription_change_cancel_params.rbs +12 -3
- data/sig/orb/models/subscription_change_retrieve_params.rbs +12 -3
- data/sig/orb/models/subscription_fetch_costs_params.rbs +5 -0
- data/sig/orb/models/subscription_fetch_params.rbs +11 -3
- data/sig/orb/models/subscription_fetch_schedule_params.rbs +5 -0
- data/sig/orb/models/subscription_fetch_usage_params.rbs +5 -0
- data/sig/orb/models/subscription_price_intervals_params.rbs +5 -0
- data/sig/orb/models/subscription_redeem_coupon_params.rbs +5 -0
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +5 -0
- data/sig/orb/models/subscription_trigger_phase_params.rbs +9 -1
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +11 -3
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +10 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +11 -3
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +5 -0
- data/sig/orb/models/subscription_update_params.rbs +5 -0
- data/sig/orb/models/subscription_update_trial_params.rbs +5 -0
- data/sig/orb/resources/alerts.rbs +2 -0
- data/sig/orb/resources/customers/credits/ledger.rbs +2 -26
- data/sig/orb/resources/invoices.rbs +1 -0
- data/sig/orb/resources/prices.rbs +1 -48
- metadata +2 -2
|
@@ -9,6 +9,11 @@ module Orb
|
|
|
9
9
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
10
10
|
include Orb::Internal::Type::RequestParameters
|
|
11
11
|
|
|
12
|
+
# @!attribute external_customer_id
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :external_customer_id, String
|
|
16
|
+
|
|
12
17
|
# @!attribute created_at_gt
|
|
13
18
|
#
|
|
14
19
|
# @return [Time, nil]
|
|
@@ -67,11 +72,13 @@ module Orb
|
|
|
67
72
|
# @return [String, nil]
|
|
68
73
|
optional :minimum_amount, String, nil?: true
|
|
69
74
|
|
|
70
|
-
# @!method initialize(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, currency: nil, cursor: nil, entry_status: nil, entry_type: nil, limit: nil, minimum_amount: nil, request_options: {})
|
|
75
|
+
# @!method initialize(external_customer_id:, created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, currency: nil, cursor: nil, entry_status: nil, entry_type: nil, limit: nil, minimum_amount: nil, request_options: {})
|
|
71
76
|
# Some parameter documentations has been truncated, see
|
|
72
77
|
# {Orb::Models::Customers::Credits::LedgerListByExternalIDParams} for more
|
|
73
78
|
# details.
|
|
74
79
|
#
|
|
80
|
+
# @param external_customer_id [String]
|
|
81
|
+
#
|
|
75
82
|
# @param created_at_gt [Time, nil]
|
|
76
83
|
#
|
|
77
84
|
# @param created_at_gte [Time, nil]
|
|
@@ -9,6 +9,11 @@ module Orb
|
|
|
9
9
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
10
10
|
include Orb::Internal::Type::RequestParameters
|
|
11
11
|
|
|
12
|
+
# @!attribute customer_id
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :customer_id, String
|
|
16
|
+
|
|
12
17
|
# @!attribute created_at_gt
|
|
13
18
|
#
|
|
14
19
|
# @return [Time, nil]
|
|
@@ -67,10 +72,12 @@ module Orb
|
|
|
67
72
|
# @return [String, nil]
|
|
68
73
|
optional :minimum_amount, String, nil?: true
|
|
69
74
|
|
|
70
|
-
# @!method initialize(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, currency: nil, cursor: nil, entry_status: nil, entry_type: nil, limit: nil, minimum_amount: nil, request_options: {})
|
|
75
|
+
# @!method initialize(customer_id:, created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, currency: nil, cursor: nil, entry_status: nil, entry_type: nil, limit: nil, minimum_amount: nil, request_options: {})
|
|
71
76
|
# Some parameter documentations has been truncated, see
|
|
72
77
|
# {Orb::Models::Customers::Credits::LedgerListParams} for more details.
|
|
73
78
|
#
|
|
79
|
+
# @param customer_id [String]
|
|
80
|
+
#
|
|
74
81
|
# @param created_at_gt [Time, nil]
|
|
75
82
|
#
|
|
76
83
|
# @param created_at_gte [Time, nil]
|
|
@@ -9,6 +9,11 @@ module Orb
|
|
|
9
9
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
10
10
|
include Orb::Internal::Type::RequestParameters
|
|
11
11
|
|
|
12
|
+
# @!attribute external_customer_id
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :external_customer_id, String
|
|
16
|
+
|
|
12
17
|
# @!attribute amount
|
|
13
18
|
# The amount to increment when the threshold is reached.
|
|
14
19
|
#
|
|
@@ -63,11 +68,13 @@ module Orb
|
|
|
63
68
|
enum: -> { Orb::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit },
|
|
64
69
|
nil?: true
|
|
65
70
|
|
|
66
|
-
# @!method initialize(amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, active_from: nil, expires_after: nil, expires_after_unit: nil, request_options: {})
|
|
71
|
+
# @!method initialize(external_customer_id:, amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, active_from: nil, expires_after: nil, expires_after_unit: nil, request_options: {})
|
|
67
72
|
# Some parameter documentations has been truncated, see
|
|
68
73
|
# {Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams} for more
|
|
69
74
|
# details.
|
|
70
75
|
#
|
|
76
|
+
# @param external_customer_id [String]
|
|
77
|
+
#
|
|
71
78
|
# @param amount [String] The amount to increment when the threshold is reached.
|
|
72
79
|
#
|
|
73
80
|
# @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo
|
|
@@ -9,6 +9,11 @@ module Orb
|
|
|
9
9
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
10
10
|
include Orb::Internal::Type::RequestParameters
|
|
11
11
|
|
|
12
|
+
# @!attribute customer_id
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :customer_id, String
|
|
16
|
+
|
|
12
17
|
# @!attribute amount
|
|
13
18
|
# The amount to increment when the threshold is reached.
|
|
14
19
|
#
|
|
@@ -63,10 +68,12 @@ module Orb
|
|
|
63
68
|
enum: -> { Orb::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit },
|
|
64
69
|
nil?: true
|
|
65
70
|
|
|
66
|
-
# @!method initialize(amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, active_from: nil, expires_after: nil, expires_after_unit: nil, request_options: {})
|
|
71
|
+
# @!method initialize(customer_id:, amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, active_from: nil, expires_after: nil, expires_after_unit: nil, request_options: {})
|
|
67
72
|
# Some parameter documentations has been truncated, see
|
|
68
73
|
# {Orb::Models::Customers::Credits::TopUpCreateParams} for more details.
|
|
69
74
|
#
|
|
75
|
+
# @param customer_id [String]
|
|
76
|
+
#
|
|
70
77
|
# @param amount [String] The amount to increment when the threshold is reached.
|
|
71
78
|
#
|
|
72
79
|
# @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo
|
|
@@ -14,8 +14,14 @@ module Orb
|
|
|
14
14
|
# @return [String]
|
|
15
15
|
required :external_customer_id, String
|
|
16
16
|
|
|
17
|
-
# @!
|
|
17
|
+
# @!attribute top_up_id
|
|
18
|
+
#
|
|
19
|
+
# @return [String]
|
|
20
|
+
required :top_up_id, String
|
|
21
|
+
|
|
22
|
+
# @!method initialize(external_customer_id:, top_up_id:, request_options: {})
|
|
18
23
|
# @param external_customer_id [String]
|
|
24
|
+
# @param top_up_id [String]
|
|
19
25
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
20
26
|
end
|
|
21
27
|
end
|
|
@@ -14,8 +14,14 @@ module Orb
|
|
|
14
14
|
# @return [String]
|
|
15
15
|
required :customer_id, String
|
|
16
16
|
|
|
17
|
-
# @!
|
|
17
|
+
# @!attribute top_up_id
|
|
18
|
+
#
|
|
19
|
+
# @return [String]
|
|
20
|
+
required :top_up_id, String
|
|
21
|
+
|
|
22
|
+
# @!method initialize(customer_id:, top_up_id:, request_options: {})
|
|
18
23
|
# @param customer_id [String]
|
|
24
|
+
# @param top_up_id [String]
|
|
19
25
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
20
26
|
end
|
|
21
27
|
end
|
|
@@ -9,6 +9,11 @@ module Orb
|
|
|
9
9
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
10
10
|
include Orb::Internal::Type::RequestParameters
|
|
11
11
|
|
|
12
|
+
# @!attribute external_customer_id
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :external_customer_id, String
|
|
16
|
+
|
|
12
17
|
# @!attribute cursor
|
|
13
18
|
# Cursor for pagination. This can be populated by the `next_cursor` value returned
|
|
14
19
|
# from the initial request.
|
|
@@ -22,10 +27,12 @@ module Orb
|
|
|
22
27
|
# @return [Integer, nil]
|
|
23
28
|
optional :limit, Integer
|
|
24
29
|
|
|
25
|
-
# @!method initialize(cursor: nil, limit: nil, request_options: {})
|
|
30
|
+
# @!method initialize(external_customer_id:, cursor: nil, limit: nil, request_options: {})
|
|
26
31
|
# Some parameter documentations has been truncated, see
|
|
27
32
|
# {Orb::Models::Customers::Credits::TopUpListByExternalIDParams} for more details.
|
|
28
33
|
#
|
|
34
|
+
# @param external_customer_id [String]
|
|
35
|
+
#
|
|
29
36
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
|
30
37
|
#
|
|
31
38
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
|
@@ -9,6 +9,11 @@ module Orb
|
|
|
9
9
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
10
10
|
include Orb::Internal::Type::RequestParameters
|
|
11
11
|
|
|
12
|
+
# @!attribute customer_id
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :customer_id, String
|
|
16
|
+
|
|
12
17
|
# @!attribute cursor
|
|
13
18
|
# Cursor for pagination. This can be populated by the `next_cursor` value returned
|
|
14
19
|
# from the initial request.
|
|
@@ -22,10 +27,12 @@ module Orb
|
|
|
22
27
|
# @return [Integer, nil]
|
|
23
28
|
optional :limit, Integer
|
|
24
29
|
|
|
25
|
-
# @!method initialize(cursor: nil, limit: nil, request_options: {})
|
|
30
|
+
# @!method initialize(customer_id:, cursor: nil, limit: nil, request_options: {})
|
|
26
31
|
# Some parameter documentations has been truncated, see
|
|
27
32
|
# {Orb::Models::Customers::Credits::TopUpListParams} for more details.
|
|
28
33
|
#
|
|
34
|
+
# @param customer_id [String]
|
|
35
|
+
#
|
|
29
36
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
|
30
37
|
#
|
|
31
38
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
|
@@ -7,7 +7,13 @@ module Orb
|
|
|
7
7
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
10
|
+
# @!attribute dimensional_price_group_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :dimensional_price_group_id, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(dimensional_price_group_id:, request_options: {})
|
|
16
|
+
# @param dimensional_price_group_id [String]
|
|
11
17
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
12
18
|
end
|
|
13
19
|
end
|
|
@@ -7,6 +7,11 @@ module Orb
|
|
|
7
7
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
+
# @!attribute dimensional_price_group_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :dimensional_price_group_id, String
|
|
14
|
+
|
|
10
15
|
# @!attribute external_dimensional_price_group_id
|
|
11
16
|
# An optional user-defined ID for this dimensional price group resource, used
|
|
12
17
|
# throughout the system as an alias for this dimensional price group. Use this
|
|
@@ -24,10 +29,12 @@ module Orb
|
|
|
24
29
|
# @return [Hash{Symbol=>String, nil}, nil]
|
|
25
30
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
|
26
31
|
|
|
27
|
-
# @!method initialize(external_dimensional_price_group_id: nil, metadata: nil, request_options: {})
|
|
32
|
+
# @!method initialize(dimensional_price_group_id:, external_dimensional_price_group_id: nil, metadata: nil, request_options: {})
|
|
28
33
|
# Some parameter documentations has been truncated, see
|
|
29
34
|
# {Orb::Models::DimensionalPriceGroupUpdateParams} for more details.
|
|
30
35
|
#
|
|
36
|
+
# @param dimensional_price_group_id [String]
|
|
37
|
+
#
|
|
31
38
|
# @param external_dimensional_price_group_id [String, nil] An optional user-defined ID for this dimensional price group resource, used thro
|
|
32
39
|
#
|
|
33
40
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb
CHANGED
|
@@ -8,7 +8,13 @@ module Orb
|
|
|
8
8
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include Orb::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
-
# @!
|
|
11
|
+
# @!attribute external_dimensional_price_group_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :external_dimensional_price_group_id, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(external_dimensional_price_group_id:, request_options: {})
|
|
17
|
+
# @param external_dimensional_price_group_id [String]
|
|
12
18
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
13
19
|
end
|
|
14
20
|
end
|
data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rb
CHANGED
|
@@ -8,6 +8,11 @@ module Orb
|
|
|
8
8
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include Orb::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
+
# @!attribute path_external_dimensional_price_group_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :path_external_dimensional_price_group_id, String
|
|
15
|
+
|
|
11
16
|
# @!attribute body_external_dimensional_price_group_id
|
|
12
17
|
# An optional user-defined ID for this dimensional price group resource, used
|
|
13
18
|
# throughout the system as an alias for this dimensional price group. Use this
|
|
@@ -28,11 +33,13 @@ module Orb
|
|
|
28
33
|
# @return [Hash{Symbol=>String, nil}, nil]
|
|
29
34
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
|
30
35
|
|
|
31
|
-
# @!method initialize(body_external_dimensional_price_group_id: nil, metadata: nil, request_options: {})
|
|
36
|
+
# @!method initialize(path_external_dimensional_price_group_id:, body_external_dimensional_price_group_id: nil, metadata: nil, request_options: {})
|
|
32
37
|
# Some parameter documentations has been truncated, see
|
|
33
38
|
# {Orb::Models::DimensionalPriceGroups::ExternalDimensionalPriceGroupIDUpdateParams}
|
|
34
39
|
# for more details.
|
|
35
40
|
#
|
|
41
|
+
# @param path_external_dimensional_price_group_id [String]
|
|
42
|
+
#
|
|
36
43
|
# @param body_external_dimensional_price_group_id [String, nil] An optional user-defined ID for this dimensional price group resource, used thro
|
|
37
44
|
#
|
|
38
45
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
|
@@ -7,7 +7,13 @@ module Orb
|
|
|
7
7
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
10
|
+
# @!attribute event_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :event_id, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(event_id:, request_options: {})
|
|
16
|
+
# @param event_id [String]
|
|
11
17
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
12
18
|
end
|
|
13
19
|
end
|
|
@@ -7,6 +7,11 @@ module Orb
|
|
|
7
7
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
+
# @!attribute event_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :event_id, String
|
|
14
|
+
|
|
10
15
|
# @!attribute event_name
|
|
11
16
|
# A name to meaningfully identify the action or event type.
|
|
12
17
|
#
|
|
@@ -41,10 +46,12 @@ module Orb
|
|
|
41
46
|
# @return [String, nil]
|
|
42
47
|
optional :external_customer_id, String, nil?: true
|
|
43
48
|
|
|
44
|
-
# @!method initialize(event_name:, properties:, timestamp:, customer_id: nil, external_customer_id: nil, request_options: {})
|
|
49
|
+
# @!method initialize(event_id:, event_name:, properties:, timestamp:, customer_id: nil, external_customer_id: nil, request_options: {})
|
|
45
50
|
# Some parameter documentations has been truncated, see
|
|
46
51
|
# {Orb::Models::EventUpdateParams} for more details.
|
|
47
52
|
#
|
|
53
|
+
# @param event_id [String]
|
|
54
|
+
#
|
|
48
55
|
# @param event_name [String] A name to meaningfully identify the action or event type.
|
|
49
56
|
#
|
|
50
57
|
# @param properties [Hash{Symbol=>Object}] A dictionary of custom properties. Values in this dictionary must be numeric, bo
|
|
@@ -8,7 +8,13 @@ module Orb
|
|
|
8
8
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include Orb::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
-
# @!
|
|
11
|
+
# @!attribute backfill_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :backfill_id, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(backfill_id:, request_options: {})
|
|
17
|
+
# @param backfill_id [String]
|
|
12
18
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
13
19
|
end
|
|
14
20
|
end
|
|
@@ -8,7 +8,13 @@ module Orb
|
|
|
8
8
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include Orb::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
-
# @!
|
|
11
|
+
# @!attribute backfill_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :backfill_id, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(backfill_id:, request_options: {})
|
|
17
|
+
# @param backfill_id [String]
|
|
12
18
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
13
19
|
end
|
|
14
20
|
end
|
|
@@ -8,7 +8,13 @@ module Orb
|
|
|
8
8
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include Orb::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
-
# @!
|
|
11
|
+
# @!attribute backfill_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :backfill_id, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(backfill_id:, request_options: {})
|
|
17
|
+
# @param backfill_id [String]
|
|
12
18
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
13
19
|
end
|
|
14
20
|
end
|
|
@@ -12,8 +12,14 @@ module Orb
|
|
|
12
12
|
# @return [String]
|
|
13
13
|
required :invoice_id, String
|
|
14
14
|
|
|
15
|
-
# @!
|
|
15
|
+
# @!attribute line_item_id
|
|
16
|
+
#
|
|
17
|
+
# @return [String]
|
|
18
|
+
required :line_item_id, String
|
|
19
|
+
|
|
20
|
+
# @!method initialize(invoice_id:, line_item_id:, request_options: {})
|
|
16
21
|
# @param invoice_id [String]
|
|
22
|
+
# @param line_item_id [String]
|
|
17
23
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
18
24
|
end
|
|
19
25
|
end
|
|
@@ -7,7 +7,13 @@ module Orb
|
|
|
7
7
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
10
|
+
# @!attribute invoice_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :invoice_id, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(invoice_id:, request_options: {})
|
|
16
|
+
# @param invoice_id [String]
|
|
11
17
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
12
18
|
end
|
|
13
19
|
end
|
|
@@ -7,6 +7,11 @@ module Orb
|
|
|
7
7
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
+
# @!attribute invoice_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :invoice_id, String
|
|
14
|
+
|
|
10
15
|
# @!attribute synchronous
|
|
11
16
|
# If true, the invoice will be issued synchronously. If false, the invoice will be
|
|
12
17
|
# issued asynchronously. The synchronous option is only available for invoices
|
|
@@ -17,10 +22,12 @@ module Orb
|
|
|
17
22
|
# @return [Boolean, nil]
|
|
18
23
|
optional :synchronous, Orb::Internal::Type::Boolean
|
|
19
24
|
|
|
20
|
-
# @!method initialize(synchronous: nil, request_options: {})
|
|
25
|
+
# @!method initialize(invoice_id:, synchronous: nil, request_options: {})
|
|
21
26
|
# Some parameter documentations has been truncated, see
|
|
22
27
|
# {Orb::Models::InvoiceIssueParams} for more details.
|
|
23
28
|
#
|
|
29
|
+
# @param invoice_id [String]
|
|
30
|
+
#
|
|
24
31
|
# @param synchronous [Boolean] If true, the invoice will be issued synchronously. If false, the invoice will be
|
|
25
32
|
#
|
|
26
33
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
@@ -7,6 +7,11 @@ module Orb
|
|
|
7
7
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
+
# @!attribute invoice_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :invoice_id, String
|
|
14
|
+
|
|
10
15
|
# @!attribute synchronous
|
|
11
16
|
# If true, the invoice will be issued synchronously. If false, the invoice will be
|
|
12
17
|
# issued asynchronously. The synchronous option is only available for invoices
|
|
@@ -17,10 +22,12 @@ module Orb
|
|
|
17
22
|
# @return [Boolean, nil]
|
|
18
23
|
optional :synchronous, Orb::Internal::Type::Boolean
|
|
19
24
|
|
|
20
|
-
# @!method initialize(synchronous: nil, request_options: {})
|
|
25
|
+
# @!method initialize(invoice_id:, synchronous: nil, request_options: {})
|
|
21
26
|
# Some parameter documentations has been truncated, see
|
|
22
27
|
# {Orb::Models::InvoiceIssueSummaryParams} for more details.
|
|
23
28
|
#
|
|
29
|
+
# @param invoice_id [String]
|
|
30
|
+
#
|
|
24
31
|
# @param synchronous [Boolean] If true, the invoice will be issued synchronously. If false, the invoice will be
|
|
25
32
|
#
|
|
26
33
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
@@ -7,6 +7,11 @@ module Orb
|
|
|
7
7
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
+
# @!attribute invoice_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :invoice_id, String
|
|
14
|
+
|
|
10
15
|
# @!attribute payment_received_date
|
|
11
16
|
# A date string to specify the date of the payment.
|
|
12
17
|
#
|
|
@@ -25,7 +30,9 @@ module Orb
|
|
|
25
30
|
# @return [String, nil]
|
|
26
31
|
optional :notes, String, nil?: true
|
|
27
32
|
|
|
28
|
-
# @!method initialize(payment_received_date:, external_id: nil, notes: nil, request_options: {})
|
|
33
|
+
# @!method initialize(invoice_id:, payment_received_date:, external_id: nil, notes: nil, request_options: {})
|
|
34
|
+
# @param invoice_id [String]
|
|
35
|
+
#
|
|
29
36
|
# @param payment_received_date [Date] A date string to specify the date of the payment.
|
|
30
37
|
#
|
|
31
38
|
# @param external_id [String, nil] An optional external ID to associate with the payment.
|
|
@@ -7,7 +7,22 @@ module Orb
|
|
|
7
7
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
10
|
+
# @!attribute invoice_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :invoice_id, String
|
|
14
|
+
|
|
15
|
+
# @!attribute shared_payment_token_id
|
|
16
|
+
# The ID of a shared payment token granted by an agent to use for this payment.
|
|
17
|
+
#
|
|
18
|
+
# @return [String]
|
|
19
|
+
required :shared_payment_token_id, String
|
|
20
|
+
|
|
21
|
+
# @!method initialize(invoice_id:, shared_payment_token_id:, request_options: {})
|
|
22
|
+
# @param invoice_id [String]
|
|
23
|
+
#
|
|
24
|
+
# @param shared_payment_token_id [String] The ID of a shared payment token granted by an agent to use for this payment.
|
|
25
|
+
#
|
|
11
26
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
12
27
|
end
|
|
13
28
|
end
|
|
@@ -7,6 +7,11 @@ module Orb
|
|
|
7
7
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
+
# @!attribute invoice_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :invoice_id, String
|
|
14
|
+
|
|
10
15
|
# @!attribute auto_collection
|
|
11
16
|
# Determines whether this invoice will automatically attempt to charge a saved
|
|
12
17
|
# payment method, if any. Can only be modified on draft invoices. If not
|
|
@@ -46,10 +51,12 @@ module Orb
|
|
|
46
51
|
# @return [Integer, nil]
|
|
47
52
|
optional :net_terms, Integer, nil?: true
|
|
48
53
|
|
|
49
|
-
# @!method initialize(auto_collection: nil, due_date: nil, invoice_date: nil, metadata: nil, net_terms: nil, request_options: {})
|
|
54
|
+
# @!method initialize(invoice_id:, auto_collection: nil, due_date: nil, invoice_date: nil, metadata: nil, net_terms: nil, request_options: {})
|
|
50
55
|
# Some parameter documentations has been truncated, see
|
|
51
56
|
# {Orb::Models::InvoiceUpdateParams} for more details.
|
|
52
57
|
#
|
|
58
|
+
# @param invoice_id [String]
|
|
59
|
+
#
|
|
53
60
|
# @param auto_collection [Boolean, nil] Determines whether this invoice will automatically attempt to charge a saved pay
|
|
54
61
|
#
|
|
55
62
|
# @param due_date [Date, Time, nil] An optional custom due date for the invoice. If not set, the due date will be ca
|
|
@@ -7,7 +7,13 @@ module Orb
|
|
|
7
7
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
10
|
+
# @!attribute invoice_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :invoice_id, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(invoice_id:, request_options: {})
|
|
16
|
+
# @param invoice_id [String]
|
|
11
17
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
12
18
|
end
|
|
13
19
|
end
|
|
@@ -7,7 +7,13 @@ module Orb
|
|
|
7
7
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
10
|
+
# @!attribute item_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :item_id, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(item_id:, request_options: {})
|
|
16
|
+
# @param item_id [String]
|
|
11
17
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
12
18
|
end
|
|
13
19
|
end
|
|
@@ -7,7 +7,13 @@ module Orb
|
|
|
7
7
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
10
|
+
# @!attribute item_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :item_id, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(item_id:, request_options: {})
|
|
16
|
+
# @param item_id [String]
|
|
11
17
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
12
18
|
end
|
|
13
19
|
end
|
|
@@ -7,6 +7,11 @@ module Orb
|
|
|
7
7
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
+
# @!attribute item_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :item_id, String
|
|
14
|
+
|
|
10
15
|
# @!attribute external_connections
|
|
11
16
|
#
|
|
12
17
|
# @return [Array<Orb::Models::ItemUpdateParams::ExternalConnection>, nil]
|
|
@@ -27,10 +32,12 @@ module Orb
|
|
|
27
32
|
# @return [String, nil]
|
|
28
33
|
optional :name, String, nil?: true
|
|
29
34
|
|
|
30
|
-
# @!method initialize(external_connections: nil, metadata: nil, name: nil, request_options: {})
|
|
35
|
+
# @!method initialize(item_id:, external_connections: nil, metadata: nil, name: nil, request_options: {})
|
|
31
36
|
# Some parameter documentations has been truncated, see
|
|
32
37
|
# {Orb::Models::ItemUpdateParams} for more details.
|
|
33
38
|
#
|
|
39
|
+
# @param item_id [String]
|
|
40
|
+
#
|
|
34
41
|
# @param external_connections [Array<Orb::Models::ItemUpdateParams::ExternalConnection>, nil]
|
|
35
42
|
#
|
|
36
43
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
|
@@ -7,6 +7,11 @@ module Orb
|
|
|
7
7
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
+
# @!attribute license_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :license_id, String
|
|
14
|
+
|
|
10
15
|
# @!attribute end_date
|
|
11
16
|
# The date to deactivate the license. If not provided, defaults to end of day
|
|
12
17
|
# today in the customer's timezone.
|
|
@@ -14,10 +19,12 @@ module Orb
|
|
|
14
19
|
# @return [Date, nil]
|
|
15
20
|
optional :end_date, Date, nil?: true
|
|
16
21
|
|
|
17
|
-
# @!method initialize(end_date: nil, request_options: {})
|
|
22
|
+
# @!method initialize(license_id:, end_date: nil, request_options: {})
|
|
18
23
|
# Some parameter documentations has been truncated, see
|
|
19
24
|
# {Orb::Models::LicenseDeactivateParams} for more details.
|
|
20
25
|
#
|
|
26
|
+
# @param license_id [String]
|
|
27
|
+
#
|
|
21
28
|
# @param end_date [Date, nil] The date to deactivate the license. If not provided, defaults to end of day toda
|
|
22
29
|
#
|
|
23
30
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
@@ -7,6 +7,11 @@ module Orb
|
|
|
7
7
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
+
# @!attribute external_license_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :external_license_id, String
|
|
14
|
+
|
|
10
15
|
# @!attribute license_type_id
|
|
11
16
|
# The ID of the license type to fetch the license for.
|
|
12
17
|
#
|
|
@@ -19,7 +24,9 @@ module Orb
|
|
|
19
24
|
# @return [String]
|
|
20
25
|
required :subscription_id, String
|
|
21
26
|
|
|
22
|
-
# @!method initialize(license_type_id:, subscription_id:, request_options: {})
|
|
27
|
+
# @!method initialize(external_license_id:, license_type_id:, subscription_id:, request_options: {})
|
|
28
|
+
# @param external_license_id [String]
|
|
29
|
+
#
|
|
23
30
|
# @param license_type_id [String] The ID of the license type to fetch the license for.
|
|
24
31
|
#
|
|
25
32
|
# @param subscription_id [String] The ID of the subscription to fetch the license for.
|