Class: VitableConnect::Models::OrganizationListResponse::Organization

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

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::OrganizationListResponse::Organization for more details.

Parameters:



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/vitable_connect/models/organization_list_response.rb', line 26

class Organization < VitableConnect::Internal::Type::BaseModel
  # @!attribute id
  #   Prefixed organization identifier (`org_<base64-encoded-uuid>`).
  #
  #   @return [String]
  required :id, String

  # @!attribute idp_org_id
  #   IdP-issued tenant id (WorkOS org id).
  #
  #   @return [String, nil]
  required :idp_org_id, String, nil?: true

  # @!attribute idp_provider
  #   - `workos` - WorkOS
  #   - `vitable` - Vitable
  #
  #   @return [Symbol, VitableConnect::Models::OrganizationListResponse::Organization::IdpProvider, nil]
  required :idp_provider,
           enum: -> { VitableConnect::Models::OrganizationListResponse::Organization::IdpProvider },
           nil?: true

  # @!attribute name
  #   Human-readable organization name.
  #
  #   @return [String]
  required :name, String

  # @!attribute super_in
  #   Whether this organization reads across every organization.
  #
  #   @return [Boolean]
  required :super_in, VitableConnect::Internal::Type::Boolean

  # @!attribute type
  #   - `BROKERAGE` - Brokerage
  #   - `TPA` - TPA
  #   - `GENERAL_AGENT` - General Agent
  #   - `CHANNEL_PARTNER` - Channel Partner
  #   - `CONSULTING_FIRM` - Consulting Firm
  #   - `API_PLATFORM` - API Platform
  #
  #   @return [Symbol, VitableConnect::Models::OrganizationListResponse::Organization::Type, nil]
  required :type,
           enum: -> { VitableConnect::Models::OrganizationListResponse::Organization::Type },
           nil?: true

  # @!method initialize(id:, idp_org_id:, idp_provider:, name:, super_in:, type:)
  #   Some parameter documentations has been truncated, see
  #   {VitableConnect::Models::OrganizationListResponse::Organization} for more
  #   details.
  #
  #   @param id [String] Prefixed organization identifier (`org_<base64-encoded-uuid>`).
  #
  #   @param idp_org_id [String, nil] IdP-issued tenant id (WorkOS org id).
  #
  #   @param idp_provider [Symbol, VitableConnect::Models::OrganizationListResponse::Organization::IdpProvider, nil] - `workos` - WorkOS
  #
  #   @param name [String] Human-readable organization name.
  #
  #   @param super_in [Boolean] Whether this organization reads across every organization.
  #
  #   @param type [Symbol, VitableConnect::Models::OrganizationListResponse::Organization::Type, nil] - `BROKERAGE` - Brokerage

  # - `workos` - WorkOS
  # - `vitable` - Vitable
  #
  # @see VitableConnect::Models::OrganizationListResponse::Organization#idp_provider
  module IdpProvider
    extend VitableConnect::Internal::Type::Enum

    WORKOS = :workos
    VITABLE = :vitable

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

  # - `BROKERAGE` - Brokerage
  # - `TPA` - TPA
  # - `GENERAL_AGENT` - General Agent
  # - `CHANNEL_PARTNER` - Channel Partner
  # - `CONSULTING_FIRM` - Consulting Firm
  # - `API_PLATFORM` - API Platform
  #
  # @see VitableConnect::Models::OrganizationListResponse::Organization#type
  module Type
    extend VitableConnect::Internal::Type::Enum

    BROKERAGE = :BROKERAGE
    TPA = :TPA
    GENERAL_AGENT = :GENERAL_AGENT
    CHANNEL_PARTNER = :CHANNEL_PARTNER
    CONSULTING_FIRM = :CONSULTING_FIRM
    API_PLATFORM = :API_PLATFORM

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

Instance Attribute Details

#id ⇒ String

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

Parameters:

  • value (String)

Returns:

  • (String) 


31
 
# File 'lib/vitable_connect/models/organization_list_response.rb', line 31

required :id, String

#idp_org_id ⇒ String?

IdP-issued tenant id (WorkOS org id).

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


37
 
# File 'lib/vitable_connect/models/organization_list_response.rb', line 37

required :idp_org_id, String, nil?: true

#idp_provider ⇒ Symbol, ...

  • workos - WorkOS
  • vitable - Vitable

Parameters:

  • value (VitableConnect::Models::OrganizationListResponse::Organization::idp_provider, nil)

Returns:



44
45
46
 
# File 'lib/vitable_connect/models/organization_list_response.rb', line 44

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

#name ⇒ String

Human-readable organization name.

Parameters:

  • value (String)

Returns:

  • (String) 


52
 
# File 'lib/vitable_connect/models/organization_list_response.rb', line 52

required :name, String

#super_in ⇒ Boolean

Whether this organization reads across every organization.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


58
 
# File 'lib/vitable_connect/models/organization_list_response.rb', line 58

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::OrganizationListResponse::Organization::type_, nil)

Returns:



69
70
71
 
# File 'lib/vitable_connect/models/organization_list_response.rb', line 69

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/vitable_connect/models/organization_list_response.rb', line 100

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


56
 
# File 'sig/vitable_connect/models/organization_list_response.rbs', line 56

def to_hash: -> {