Module: Orb::Models::SubscriptionRedeemCouponParams::ChangeOption

Extended by:
Internal::Type::Enum
Defined in:
lib/orb/models/subscription_redeem_coupon_params.rb,
sig/orb/models/subscription_redeem_coupon_params.rbs

Constant Summary collapse

REQUESTED_DATE =

Returns:

  • (:requested_date) 
:requested_date
END_OF_SUBSCRIPTION_TERM =

Returns:

  • (:end_of_subscription_term) 
:end_of_subscription_term
IMMEDIATE =

Returns:

  • (:immediate) 
:immediate

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::Enum

==, ===, coerce, dump, hash, inspect, to_sorbet_type, values

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/orb/models/subscription_redeem_coupon_params.rb', line 72

Instance Method Details

#initialize(subscription_id:, change_option:, allow_invoice_credit_or_void: nil, change_date: nil, coupon_id: nil, coupon_redemption_code: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Orb::Models::SubscriptionRedeemCouponParams for more details.

Parameters:

  • subscription_id (String)
  • change_option (Symbol, Orb::Models::SubscriptionRedeemCouponParams::ChangeOption)
  • allow_invoice_credit_or_void (Boolean, nil) (defaults to: nil) —

    If false, this request will fail if it would void an issued invoice or create a

  • change_date (Time, nil) (defaults to: nil) —

    The date that the coupon discount should take effect. This parameter can only be

  • coupon_id (String, nil) (defaults to: nil) —

    Coupon ID to be redeemed for this subscription.

  • coupon_redemption_code (String, nil) (defaults to: nil) —

    Redemption code of the coupon to be redeemed for this subscription.

  • request_options (Orb::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 


65
66
67
68
69
70
71
72
73
74
 
# File 'lib/orb/models/subscription_redeem_coupon_params.rb', line 65

module ChangeOption
  extend Orb::Internal::Type::Enum

  REQUESTED_DATE = :requested_date
  END_OF_SUBSCRIPTION_TERM = :end_of_subscription_term
  IMMEDIATE = :immediate

  # @!method self.values
  #   @return [Array<Symbol>]
end

#self?.values ⇒ ::Array[Orb::Models::SubscriptionRedeemCouponParams::change_option]

Returns:

  • (::Array[Orb::Models::SubscriptionRedeemCouponParams::change_option]) 


60
 
# File 'sig/orb/models/subscription_redeem_coupon_params.rbs', line 60

def self?.values: -> ::Array[Orb::Models::SubscriptionRedeemCouponParams::change_option]