Class: Cadenya::Models::WorkspaceAdmin::MemberAddParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Cadenya::Models::WorkspaceAdmin::MemberAddParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/cadenya/models/workspace_admin/member_add_params.rb

Overview

See Also:

• Resources::WorkspaceAdmin::Members#add

Instance Attribute Summary

• #email ⇒ String^?

  Email address to add (resolve-or-invite).

• #profile_id ⇒ String^?

  An existing account profile to add.

• #workspace_id ⇒ String

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(workspace_id:, email: nil, profile_id: 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:, email: nil, profile_id: nil, request_options: {}) ⇒ Object

Parameters:

• workspace_id (String)
• email (String) (defaults to: nil) —

  Email address to add (resolve-or-invite). Mutually exclusive with profile_id.

• profile_id (String) (defaults to: nil) —

  An existing account profile to add. Mutually exclusive with email.

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

# File 'lib/cadenya/models/workspace_admin/member_add_params.rb', line 28

Instance Attribute Details

#email ⇒ String^?

Email address to add (resolve-or-invite). Mutually exclusive with profile_id.

Returns:

• (String, nil)

# File 'lib/cadenya/models/workspace_admin/member_add_params.rb', line 20

optional :email, String

#profile_id ⇒ String^?

An existing account profile to add. Mutually exclusive with email.

Returns:

• (String, nil)

# File 'lib/cadenya/models/workspace_admin/member_add_params.rb', line 26

optional :profile_id, String, api_name: :profileId

#workspace_id ⇒ String

Returns:

• (String)

# File 'lib/cadenya/models/workspace_admin/member_add_params.rb', line 14

required :workspace_id, String