Class: Trycourier::Models::Tenant

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/trycourier/models/tenant.rb

Overview

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

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: , name: , brand_id: nil, default_preferences: nil, parent_tenant_id: nil, properties: nil, user_profile: nil) ⇒ Object

Some parameter documentations has been truncated, see Trycourier::Models::Tenant for more details.

Parameters:

  • id (String) (defaults to: ) —

    Id of the tenant.

  • name (String) (defaults to: ) —

    Name of the tenant.

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

    Brand to be used for the account when one is not specified by the send call.

  • default_preferences (Trycourier::Models::DefaultPreferences, nil) (defaults to: nil) —

    Defines the preferences used for the account when the user hasn’t specified thei

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

    Tenant’s parent id (if any).

  • properties (Hash{Symbol=>Object}, nil) (defaults to: nil) —

    Arbitrary properties accessible to a template.

  • user_profile (Hash{Symbol=>Object}, nil) (defaults to: nil) —

    A user profile object merged with user profile on send.




# File 'lib/trycourier/models/tenant.rb', line 54

Instance Attribute Details

#brand_id ⇒ String?

Brand to be used for the account when one is not specified by the send call.

Returns:

  • (String, nil) 


23
 
# File 'lib/trycourier/models/tenant.rb', line 23

optional :brand_id, String, nil?: true

#default_preferences ⇒ Trycourier::Models::DefaultPreferences?

Defines the preferences used for the account when the user hasn’t specified their own.

Returns:



30
 
# File 'lib/trycourier/models/tenant.rb', line 30

optional :default_preferences, -> { Trycourier::DefaultPreferences }, nil?: true

#id ⇒ String

Id of the tenant.

Returns:

  • (String) 


11
 
# File 'lib/trycourier/models/tenant.rb', line 11

required :id, String

#name ⇒ String

Name of the tenant.

Returns:

  • (String) 


17
 
# File 'lib/trycourier/models/tenant.rb', line 17

required :name, String

#parent_tenant_id ⇒ String?

Tenant’s parent id (if any).

Returns:

  • (String, nil) 


36
 
# File 'lib/trycourier/models/tenant.rb', line 36

optional :parent_tenant_id, String, nil?: true

#properties ⇒ Hash{Symbol=>Object}?

Arbitrary properties accessible to a template.

Returns:

  • (Hash{Symbol=>Object}, nil) 


42
43
44
 
# File 'lib/trycourier/models/tenant.rb', line 42

optional :properties,
Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown],
nil?: true

#user_profile ⇒ Hash{Symbol=>Object}?

A user profile object merged with user profile on send.

Returns:

  • (Hash{Symbol=>Object}, nil) 


50
51
52
 
# File 'lib/trycourier/models/tenant.rb', line 50

optional :user_profile,
Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown],
nil?: true