Class: Openlayer::Models::Workspaces::InviteCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Openlayer::Models::Workspaces::InviteCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/openlayer/models/workspaces/invite_create_params.rb

Overview

See Also:

• Resources::Workspaces::Invites#create

Defined Under Namespace

Modules: Role

Instance Attribute Summary

• #emails ⇒ Array<String>^?
• #role ⇒ Symbol, ...

  The member role.

• #workspace_id ⇒ String

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(workspace_id:, emails: nil, role: nil, request_options: {}) ⇒ Object constructor

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(workspace_id:, emails: nil, role: nil, request_options: {}) ⇒ Object

Parameters:

• workspace_id (String)
• emails (Array<String>) (defaults to: nil)
• role (Symbol, Openlayer::Models::Workspaces::InviteCreateParams::Role) (defaults to: nil) —

  The member role.

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

# File 'lib/openlayer/models/workspaces/invite_create_params.rb', line 27

Instance Attribute Details

#emails ⇒ Array<String>^?

Returns:

• (Array<String>, nil)

# File 'lib/openlayer/models/workspaces/invite_create_params.rb', line 19

optional :emails, Openlayer::Internal::Type::ArrayOf[String]

#role ⇒ Symbol, ...

The member role.

Returns:

• (Symbol, Openlayer::Models::Workspaces::InviteCreateParams::Role, nil)

# File 'lib/openlayer/models/workspaces/invite_create_params.rb', line 25

optional :role, enum: -> { Openlayer::Workspaces::InviteCreateParams::Role }

#workspace_id ⇒ String

Returns:

• (String)

# File 'lib/openlayer/models/workspaces/invite_create_params.rb', line 14

required :workspace_id, String