Class: TrinsicApi::CreateSessionRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/trinsic_api/models/create_session_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateSessionRequest

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
 
# File 'lib/trinsic_api/models/create_session_request.rb', line 68

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TrinsicApi::CreateSessionRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `TrinsicApi::CreateSessionRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'launch_provider_directly')
    self.launch_provider_directly = attributes[:'launch_provider_directly']
  end

  if attributes.key?(:'enable_remember_me')
    self.enable_remember_me = attributes[:'enable_remember_me']
  end

  if attributes.key?(:'providers')
    if (value = attributes[:'providers']).is_a?(Array)
      self.providers = value
    end
  end

  if attributes.key?(:'known_identity_data')
    self.known_identity_data = attributes[:'known_identity_data']
  end

  if attributes.key?(:'disclosed_fields')
    self.disclosed_fields = attributes[:'disclosed_fields']
  end
end

Instance Attribute Details

#disclosed_fields ⇒ Object

Specific identity attributes to request. If not provided, all available attributes will be requested.



31
32
33
 
# File 'lib/trinsic_api/models/create_session_request.rb', line 31

def disclosed_fields
  @disclosed_fields
end

#enable_remember_me ⇒ Object

Whether to enable Trinsic’s "Remember Me" feature, which allows users to save their credentials for future use. This option is only relevant when ‘LaunchProviderDirectly` is unspecified or set to `false`. If `LaunchProviderDirectly` is `true`, this field must be unspecified or set to `false`. If this field is set to `true`, then: - The user will be prompted to authenticate with their phone number at the start of the flow - If the user has previously saved a verification for reuse with Trinsic, they will be offered the ability to reuse it - After the user has verified their identity (and if the identity provider in question supports it), they will be prompted to save their credentials for future use If this field is set to `false`, then: - The user will not be prompted to authenticate with their phone number at the start of the flow. - Instead, the user will be immediately shown the list of available providers - The user will not be offered the ability to reuse a previously-saved Trinsic credential - After the user has verified their identity, they will not be prompted to save their credentials for future use - Instead, they will immediately return to your product



22
23
24
 
# File 'lib/trinsic_api/models/create_session_request.rb', line 22

def enable_remember_me
  @enable_remember_me
end

#known_identity_data ⇒ Object

Known identity data of an individual being verified. Provide this to Trinsic during Session creation to enable improved identity provider selection recommendations.



28
29
30
 
# File 'lib/trinsic_api/models/create_session_request.rb', line 28

def known_identity_data
  @known_identity_data
end

#launch_provider_directly ⇒ Object

Whether to immediately launch the identity provider, without invoking the Trinsic Widget UI. Users will not be shown the Widget; therefore, reuse of credentials, selection of an identity provider, and saving a verification for future reuse are not available to the end user in this mode. Sessions created with this option enabled must be created with a ‘RedirectUrl` specified, and cannot be invoked using the frontend SDK at this time.



19
20
21
 
# File 'lib/trinsic_api/models/create_session_request.rb', line 19

def launch_provider_directly
  @launch_provider_directly
end

#providers ⇒ Object

The list of allowed identity providers. If not specified, all available providers will be allowed. If ‘LaunchMethodDirectly` is `true`, this field must be set, and must have only a single entry. If `LaunchMethodDirectly` is not specified or is `false`, this field may have any number of entries.



25
26
27
 
# File 'lib/trinsic_api/models/create_session_request.rb', line 25

def providers
  @providers
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/trinsic_api/models/create_session_request.rb', line 170

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = TrinsicApi.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



45
46
47
 
# File 'lib/trinsic_api/models/create_session_request.rb', line 45

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



34
35
36
37
38
39
40
41
42
 
# File 'lib/trinsic_api/models/create_session_request.rb', line 34

def self.attribute_map
  {
    :'launch_provider_directly' => :'launchProviderDirectly',
    :'enable_remember_me' => :'enableRememberMe',
    :'providers' => :'providers',
    :'known_identity_data' => :'knownIdentityData',
    :'disclosed_fields' => :'disclosedFields'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/trinsic_api/models/create_session_request.rb', line 146

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



61
62
63
64
 
# File 'lib/trinsic_api/models/create_session_request.rb', line 61

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
 
# File 'lib/trinsic_api/models/create_session_request.rb', line 50

def self.openapi_types
  {
    :'launch_provider_directly' => :'Boolean',
    :'enable_remember_me' => :'Boolean',
    :'providers' => :'Array<String>',
    :'known_identity_data' => :'KnownIdentityData',
    :'disclosed_fields' => :'DisclosedFieldsRequest'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



121
122
123
124
125
126
127
128
129
 
# File 'lib/trinsic_api/models/create_session_request.rb', line 121

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      launch_provider_directly == o.launch_provider_directly &&
      enable_remember_me == o.enable_remember_me &&
      providers == o.providers &&
      known_identity_data == o.known_identity_data &&
      disclosed_fields == o.disclosed_fields
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/trinsic_api/models/create_session_request.rb', line 241

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


133
134
135
 
# File 'lib/trinsic_api/models/create_session_request.rb', line 133

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



139
140
141
 
# File 'lib/trinsic_api/models/create_session_request.rb', line 139

def hash
  [launch_provider_directly, enable_remember_me, providers, known_identity_data, disclosed_fields].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



106
107
108
109
110
 
# File 'lib/trinsic_api/models/create_session_request.rb', line 106

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



217
218
219
 
# File 'lib/trinsic_api/models/create_session_request.rb', line 217

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/trinsic_api/models/create_session_request.rb', line 223

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



211
212
213
 
# File 'lib/trinsic_api/models/create_session_request.rb', line 211

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



114
115
116
117
 
# File 'lib/trinsic_api/models/create_session_request.rb', line 114

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end