Class: SunshineConversationsClient::UserCreateBody

Inherits:
Object
  • Object
show all
Defined in:
lib/sunshine-conversations-client/models/user_create_body.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserCreateBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash



60
61
62
63
64
65
66
67
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
 
# File 'lib/sunshine-conversations-client/models/user_create_body.rb', line 60

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SunshineConversationsClient::UserCreateBody` 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 `SunshineConversationsClient::UserCreateBody`. 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?(:'external_id')
    self.external_id = attributes[:'external_id']
  end

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

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

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

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

Instance Attribute Details

#external_id ⇒ Object

A unique identifier for the user. The ‘externalId` can be used to link a user to the same conversation [across multiple devices](developer.zendesk.com/documentation/conversations/messaging-platform/users/authenticating-users/).



16
17
18
 
# File 'lib/sunshine-conversations-client/models/user_create_body.rb', line 16

def external_id
  @external_id
end

#metadata ⇒ Object

Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size.



27
28
29
 
# File 'lib/sunshine-conversations-client/models/user_create_body.rb', line 27

def metadata
  @metadata
end

#profile ⇒ Object

Returns the value of attribute profile.



24
25
26
 
# File 'lib/sunshine-conversations-client/models/user_create_body.rb', line 24

def profile
  @profile
end

#signed_up_at ⇒ Object

The date at which the user signed up. Must be ISO 8601 time format ‘YYYY-MM-DDThh:mm:ss.sssZ`.



19
20
21
 
# File 'lib/sunshine-conversations-client/models/user_create_body.rb', line 19

def signed_up_at
  @signed_up_at
end

#to_be_retained ⇒ Object

Flag indicating whether a user should be retained after they have passed their inactive expiry. See [creating deletion schedules for bot-only conversations](support.zendesk.com/hc/en-us/articles/8499219792154) for more information.



22
23
24
 
# File 'lib/sunshine-conversations-client/models/user_create_body.rb', line 22

def to_be_retained
  @to_be_retained
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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/sunshine-conversations-client/models/user_create_body.rb', line 193

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 = SunshineConversationsClient.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

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
38
 
# File 'lib/sunshine-conversations-client/models/user_create_body.rb', line 30

def self.attribute_map
  {
    :'external_id' => :'externalId',
    :'signed_up_at' => :'signedUpAt',
    :'to_be_retained' => :'toBeRetained',
    :'profile' => :'profile',
    :'metadata' => :'metadata'
  }
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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/sunshine-conversations-client/models/user_create_body.rb', line 169

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



52
53
54
55
56
 
# File 'lib/sunshine-conversations-client/models/user_create_body.rb', line 52

def self.openapi_nullable
  Set.new([
    :'metadata'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
49
 
# File 'lib/sunshine-conversations-client/models/user_create_body.rb', line 41

def self.openapi_types
  {
    :'external_id' => :'String',
    :'signed_up_at' => :'String',
    :'to_be_retained' => :'Boolean',
    :'profile' => :'Profile',
    :'metadata' => :'Hash<String, Object>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



144
145
146
147
148
149
150
151
152
 
# File 'lib/sunshine-conversations-client/models/user_create_body.rb', line 144

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      external_id == o.external_id &&
      signed_up_at == o.signed_up_at &&
      to_be_retained == o.to_be_retained &&
      profile == o.profile &&
      metadata == o.metadata
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



264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/sunshine-conversations-client/models/user_create_body.rb', line 264

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


156
157
158
 
# File 'lib/sunshine-conversations-client/models/user_create_body.rb', line 156

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



162
163
164
 
# File 'lib/sunshine-conversations-client/models/user_create_body.rb', line 162

def hash
  [external_idsigned_up_atto_be_retainedprofilemetadata].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



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/sunshine-conversations-client/models/user_create_body.rb', line 98

def list_invalid_properties
  invalid_properties = Array.new
  if @external_id.nil?
    invalid_properties.push('invalid value for "external_id", external_id cannot be nil.')
  end

  if @external_id.to_s.length > 1024
    invalid_properties.push('invalid value for "external_id", the character length must be smaller than or equal to 1024.')
  end

  if @external_id.to_s.length < 1
    invalid_properties.push('invalid value for "external_id", the character length must be great than or equal to 1.')
  end

  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



240
241
242
 
# File 'lib/sunshine-conversations-client/models/user_create_body.rb', line 240

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



246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/sunshine-conversations-client/models/user_create_body.rb', line 246

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



234
235
236
 
# File 'lib/sunshine-conversations-client/models/user_create_body.rb', line 234

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



117
118
119
120
121
122
 
# File 'lib/sunshine-conversations-client/models/user_create_body.rb', line 117

def valid?
  return false if @external_id.nil?
  return false if @external_id.to_s.length > 1024
  return false if @external_id.to_s.length < 1
  true
end