Class: VitableConnect::Models::OrganizationCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• VitableConnect::Models::OrganizationCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/vitable_connect/models/organization_create_params.rb,
sig/vitable_connect/models/organization_create_params.rbs

Overview

See Also:

• VitableConnect::Resources::Organizations#create

Defined Under Namespace

Modules: Type

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::VitableConnect

Instance Attribute Summary

• #name ⇒ String
• #type ⇒ Symbol, ...
  • BROKERAGE - BROKERAGE - TPA - TPA - GENERAL_AGENT - GENERAL_AGENT - CHANNEL_PARTNER - CHANNEL_PARTNER - CONSULTING_FIRM - CONSULTING_FIRM - API_PLATFORM - API_PLATFORM.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(name:, type: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see OrganizationCreateParams for more details.

• #to_hash ⇒ {

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(name:, type: nil, request_options: {}) ⇒ Object

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

Parameters:

• name (String)
• type (Symbol, VitableConnect::Models::OrganizationCreateParams::Type, nil) (defaults to: nil) —
  • BROKERAGE - BROKERAGE
• request_options (VitableConnect::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/vitable_connect/models/organization_create_params.rb', line 26

Instance Attribute Details

#name ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/vitable_connect/models/organization_create_params.rb', line 13

required :name, String

#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::OrganizationCreateParams::type_, nil)

Returns:

• (Symbol, VitableConnect::Models::OrganizationCreateParams::Type, nil)

# File 'lib/vitable_connect/models/organization_create_params.rb', line 24

optional :type, enum: -> { VitableConnect::OrganizationCreateParams::Type }, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/vitable_connect/models/organization_create_params.rbs', line 24

def to_hash: -> {