Class: Sentdm::Models::UserInviteParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/sentdm/models/user_invite_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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(email: nil, name: nil, role: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Sentdm::Models::UserInviteParams for more details.

Parameters:

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

    User email address (required)

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

    User full name (required)

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

    User role: admin, billing, or developer (required)

  • sandbox (Boolean) (defaults to: nil) —

    Sandbox flag - when true, the operation is simulated without side effects

  • idempotency_key (String) (defaults to: nil)
  • x_profile_id (String) (defaults to: nil)
  • request_options (Sentdm::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/sentdm/models/user_invite_params.rb', line 45

Instance Attribute Details

#email ⇒ String?

User email address (required)

Returns:

  • (String, nil) 


14
 
# File 'lib/sentdm/models/user_invite_params.rb', line 14

optional :email, String

#idempotency_key ⇒ String?

Returns:

  • (String, nil) 


38
 
# File 'lib/sentdm/models/user_invite_params.rb', line 38

optional :idempotency_key, String

#name ⇒ String?

User full name (required)

Returns:

  • (String, nil) 


20
 
# File 'lib/sentdm/models/user_invite_params.rb', line 20

optional :name, String

#role ⇒ String?

User role: admin, billing, or developer (required)

Returns:

  • (String, nil) 


26
 
# File 'lib/sentdm/models/user_invite_params.rb', line 26

optional :role, String

#sandbox ⇒ Boolean?

Sandbox flag - when true, the operation is simulated without side effects Useful for testing integrations without actual execution

Returns:

  • (Boolean, nil) 


33
 
# File 'lib/sentdm/models/user_invite_params.rb', line 33

optional :sandbox, Sentdm::Internal::Type::Boolean

#x_profile_id ⇒ String?

Returns:

  • (String, nil) 


43
 
# File 'lib/sentdm/models/user_invite_params.rb', line 43

optional :x_profile_id, String