Class: Stigg::Models::V1::SubscriptionCancelParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Stigg::Models::V1::SubscriptionCancelParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/stigg/models/v1/subscription_cancel_params.rb

Overview

See Also:

• Resources::V1::Subscriptions#cancel

Defined Under Namespace

Modules: CancellationAction, CancellationTime

Instance Attribute Summary

• #cancellation_action ⇒ Symbol, ...

  Action on cancellation (downgrade or revoke).

• #cancellation_time ⇒ Symbol, ...

  When to cancel (immediate, period end, or date).

• #end_date ⇒ Time^?

  Subscription end date.

• #id ⇒ String
• #prorate ⇒ Boolean^?

  If set, enables or disables prorating of credits on subscription cancellation.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(id:, cancellation_action: nil, cancellation_time: nil, end_date: nil, prorate: nil, request_options: {}) ⇒ Object constructor

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

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

Methods included from Internal::Util::SorbetRuntimeSupport

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

Constructor Details

#initialize(id:, cancellation_action: nil, cancellation_time: nil, end_date: nil, prorate: nil, request_options: {}) ⇒ Object

Parameters:

• id (String)
• cancellation_action (Symbol, Stigg::Models::V1::SubscriptionCancelParams::CancellationAction) (defaults to: nil) —

  Action on cancellation (downgrade or revoke)

• cancellation_time (Symbol, Stigg::Models::V1::SubscriptionCancelParams::CancellationTime) (defaults to: nil) —

  When to cancel (immediate, period end, or date)

• end_date (Time) (defaults to: nil) —

  Subscription end date

• prorate (Boolean) (defaults to: nil) —

  If set, enables or disables prorating of credits on subscription cancellation.

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

# File 'lib/stigg/models/v1/subscription_cancel_params.rb', line 44

Instance Attribute Details

#cancellation_action ⇒ Symbol, ...

Action on cancellation (downgrade or revoke)

Returns:

• (Symbol, Stigg::Models::V1::SubscriptionCancelParams::CancellationAction, nil)

# File 'lib/stigg/models/v1/subscription_cancel_params.rb', line 20

optional :cancellation_action,
enum: -> { Stigg::V1::SubscriptionCancelParams::CancellationAction },
api_name: :cancellationAction

#cancellation_time ⇒ Symbol, ...

When to cancel (immediate, period end, or date)

Returns:

• (Symbol, Stigg::Models::V1::SubscriptionCancelParams::CancellationTime, nil)

# File 'lib/stigg/models/v1/subscription_cancel_params.rb', line 28

optional :cancellation_time,
enum: -> { Stigg::V1::SubscriptionCancelParams::CancellationTime },
api_name: :cancellationTime

#end_date ⇒ Time^?

Subscription end date

Returns:

• (Time, nil)

# File 'lib/stigg/models/v1/subscription_cancel_params.rb', line 36

optional :end_date, Time, api_name: :endDate

#id ⇒ String

Returns:

• (String)

# File 'lib/stigg/models/v1/subscription_cancel_params.rb', line 14

required :id, String

#prorate ⇒ Boolean^?

If set, enables or disables prorating of credits on subscription cancellation.

Returns:

• (Boolean, nil)

# File 'lib/stigg/models/v1/subscription_cancel_params.rb', line 42

optional :prorate, Stigg::Internal::Type::Boolean

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/stigg/models/v1/subscription_cancel_params.rb', line 64