Class: VitableConnect::Models::OrganizationCreateResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/vitable_connect/models/organization_create_response.rb,
sig/vitable_connect/models/organization_create_response.rbs

Overview

See Also:

  • VitableConnect::Resources::Organizations#create

Defined Under Namespace

Modules: IdpProvider, Type

Instance Attribute Summary collapse

Class Method 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:, idp_org_id:, idp_provider:, name:, super_in:, type:) ⇒ Object

Some parameter documentations has been truncated, see VitableConnect::Models::OrganizationCreateResponse for more details.

Parameters:




# File 'lib/vitable_connect/models/organization_create_response.rb', line 51

Instance Attribute Details

#id ⇒ String

Prefixed organization identifier (org_<base64-encoded-uuid>).

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/vitable_connect/models/organization_create_response.rb', line 11

required :id, String

#idp_org_id ⇒ String?

IdP-issued tenant id (WorkOS org id).

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


17
 
# File 'lib/vitable_connect/models/organization_create_response.rb', line 17

required :idp_org_id, String, nil?: true

#idp_provider ⇒ Symbol, ...

  • workos - WorkOS
  • vitable - Vitable

Parameters:

  • value (VitableConnect::Models::OrganizationCreateResponse::idp_provider, nil)

Returns:



24
25
26
 
# File 'lib/vitable_connect/models/organization_create_response.rb', line 24

required :idp_provider,
enum: -> { VitableConnect::Models::OrganizationCreateResponse::IdpProvider },
nil?: true

#name ⇒ String

Human-readable organization name.

Parameters:

  • value (String)

Returns:

  • (String) 


32
 
# File 'lib/vitable_connect/models/organization_create_response.rb', line 32

required :name, String

#super_in ⇒ Boolean

Whether this organization reads across every organization.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


38
 
# File 'lib/vitable_connect/models/organization_create_response.rb', line 38

required :super_in, VitableConnect::Internal::Type::Boolean

#type ⇒ Symbol, ...

  • BROKERAGE - Brokerage
  • TPA - TPA
  • GENERAL_AGENT - General Agent
  • CHANNEL_PARTNER - Channel Partner
  • CONSULTING_FIRM - Consulting Firm
  • API_PLATFORM - API Platform

Parameters:

  • value (VitableConnect::Models::OrganizationCreateResponse::type_, nil)

Returns:



49
 
# File 'lib/vitable_connect/models/organization_create_response.rb', line 49

required :type, enum: -> { VitableConnect::Models::OrganizationCreateResponse::Type }, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/vitable_connect/models/organization_create_response.rb', line 77

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


35
 
# File 'sig/vitable_connect/models/organization_create_response.rbs', line 35

def to_hash: -> {