Class: Increase::Models::Simulations::PhysicalCardCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/increase/models/simulations/physical_card_create_params.rb

Overview

See Also:

Defined Under Namespace

Modules: Category

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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(physical_card_id:, category:, carrier_estimated_delivery_at: nil, city: nil, postal_code: nil, state: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::Simulations::PhysicalCardCreateParams for more details.

Parameters:

  • physical_card_id (String) —

    The Physical Card you would like to action.

  • category (Symbol, Increase::Models::Simulations::PhysicalCardCreateParams::Category) —

    The type of tracking event.

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

    The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time when the ca

  • city (String) (defaults to: nil) —

    The city where the event took place.

  • postal_code (String) (defaults to: nil) —

    The postal code where the event took place.

  • state (String) (defaults to: nil) —

    The state where the event took place.

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



# File 'lib/increase/models/simulations/physical_card_create_params.rb', line 48

Instance Attribute Details

#carrier_estimated_delivery_at ⇒ Time?

The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time when the carrier expects the card to be delivered.

Returns:

  • (Time, nil) 


28
 
# File 'lib/increase/models/simulations/physical_card_create_params.rb', line 28

optional :carrier_estimated_delivery_at, Time

#category ⇒ Symbol, Increase::Models::Simulations::PhysicalCardCreateParams::Category

The type of tracking event.

Returns:



21
 
# File 'lib/increase/models/simulations/physical_card_create_params.rb', line 21

required :category, enum: -> { Increase::Simulations::PhysicalCardCreateParams::Category }

#city ⇒ String?

The city where the event took place.

Returns:

  • (String, nil) 


34
 
# File 'lib/increase/models/simulations/physical_card_create_params.rb', line 34

optional :city, String

#physical_card_id ⇒ String

The Physical Card you would like to action.

Returns:

  • (String) 


15
 
# File 'lib/increase/models/simulations/physical_card_create_params.rb', line 15

required :physical_card_id, String

#postal_code ⇒ String?

The postal code where the event took place.

Returns:

  • (String, nil) 


40
 
# File 'lib/increase/models/simulations/physical_card_create_params.rb', line 40

optional :postal_code, String

#state ⇒ String?

The state where the event took place.

Returns:

  • (String, nil) 


46
 
# File 'lib/increase/models/simulations/physical_card_create_params.rb', line 46

optional :state, String