Class: SunshineConversationsClient::Ios

Inherits:
Integration show all
Defined in:
lib/sunshine-conversations-client/models/ios.rb

Instance Attribute Summary collapse

Attributes inherited from Integration

#display_name, #id, #status

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Integration

openapi_discriminator_name

Constructor Details

#initialize(attributes = {}) ⇒ Ios

Initializes the object

Parameters:

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

    Model attributes in the form of hash



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/sunshine-conversations-client/models/ios.rb', line 90

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

  # call parent's initialize
  super(attributes)

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = 'ios'
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#attachments_enabled ⇒ Object

Allows users to send attachments. By default, the setting is set to true. This setting can only be configured in Zendesk Admin Center.



33
34
35
 
# File 'lib/sunshine-conversations-client/models/ios.rb', line 33

def attachments_enabled
  @attachments_enabled
end

#auto_update_badge ⇒ Object

Use the unread count of the conversation as the application badge.



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

def auto_update_badge
  @auto_update_badge
end

#can_user_create_more_conversations ⇒ Object

Allows users to create more than one conversation on the iOS integration.



30
31
32
 
# File 'lib/sunshine-conversations-client/models/ios.rb', line 30

def can_user_create_more_conversations
  @can_user_create_more_conversations
end

#certificate ⇒ Object

The binary of your APN certificate base64 encoded. To base64 encode your certificate you can use this command in the terminal: ‘openssl base64 -in YOUR_CERTIFICATE.p12 | tr -d ’\n’‘



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

def certificate
  @certificate
end

#default_responder ⇒ Object

Returns the value of attribute default_responder.



38
39
40
 
# File 'lib/sunshine-conversations-client/models/ios.rb', line 38

def default_responder
  @default_responder
end

#default_responder_id ⇒ Object

The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to <a href="docs.smooch.io/guide/switchboard/#per-channel-default-responder">Per-channel default responder</a> guide.



36
37
38
 
# File 'lib/sunshine-conversations-client/models/ios.rb', line 36

def default_responder_id
  @default_responder_id
end

#password ⇒ Object

The password for your APN certificate.



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

def password
  @password
end

#production ⇒ Object

The APN environment to connect to (Production, if true, or Sandbox). Defaults to value inferred from certificate if not specified.



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

def production
  @production
end

#type ⇒ Object

To configure an ios integration, call the create integration endpoint with a base64 encoded Apple Push Notification certificate from the [Apple Developer Portal](developer.apple.com/).



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/sunshine-conversations-client/models/ios.rb', line 41

def self.attribute_map
  {
    :'type' => :'type',
    :'certificate' => :'certificate',
    :'password' => :'password',
    :'production' => :'production',
    :'auto_update_badge' => :'autoUpdateBadge',
    :'can_user_create_more_conversations' => :'canUserCreateMoreConversations',
    :'attachments_enabled' => :'attachmentsEnabled',
    :'default_responder_id' => :'defaultResponderId',
    :'default_responder' => :'defaultResponder'
  }
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



204
205
206
 
# File 'lib/sunshine-conversations-client/models/ios.rb', line 204

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



79
80
81
82
83
84
85
86
 
# File 'lib/sunshine-conversations-client/models/ios.rb', line 79

def self.openapi_all_of
  [
  :'DefaultResponder',
  :'DefaultResponderId',
  :'Integration',
  :'IosAllOf'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



71
72
73
74
75
76
 
# File 'lib/sunshine-conversations-client/models/ios.rb', line 71

def self.openapi_nullable
  Set.new([
    :'certificate',
    :'default_responder_id',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/sunshine-conversations-client/models/ios.rb', line 56

def self.openapi_types
  {
    :'type' => :'String',
    :'certificate' => :'String',
    :'password' => :'String',
    :'production' => :'Boolean',
    :'auto_update_badge' => :'Boolean',
    :'can_user_create_more_conversations' => :'Boolean',
    :'attachments_enabled' => :'Boolean',
    :'default_responder_id' => :'String',
    :'default_responder' => :'DefaultResponderDefaultResponder'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/sunshine-conversations-client/models/ios.rb', line 175

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      certificate == o.certificate &&
      password == o.password &&
      production == o.production &&
      auto_update_badge == o.auto_update_badge &&
      can_user_create_more_conversations == o.can_user_create_more_conversations &&
      attachments_enabled == o.attachments_enabled &&
      default_responder_id == o.default_responder_id &&
      default_responder == o.default_responder && super(o)
end

#_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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/sunshine-conversations-client/models/ios.rb', line 233

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    SunshineConversationsClient.const_get(type).build_from_hash(value)
  end
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



302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/sunshine-conversations-client/models/ios.rb', line 302

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

#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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/sunshine-conversations-client/models/ios.rb', line 211

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  self.class.openapi_types.each_pair do |key, type|
    if 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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


191
192
193
 
# File 'lib/sunshine-conversations-client/models/ios.rb', line 191

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



197
198
199
 
# File 'lib/sunshine-conversations-client/models/ios.rb', line 197

def hash
  [type, certificate, password, production, auto_update_badge, can_user_create_more_conversations, attachments_enabled, default_responder_id, default_responder].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



147
148
149
150
151
152
153
154
 
# File 'lib/sunshine-conversations-client/models/ios.rb', line 147

def list_invalid_properties
  invalid_properties = super
  if !@certificate.nil? && @certificate.to_s.length < 1
    invalid_properties.push('invalid value for "certificate", 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



278
279
280
 
# File 'lib/sunshine-conversations-client/models/ios.rb', line 278

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



284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/sunshine-conversations-client/models/ios.rb', line 284

def to_hash
  hash = super
  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



272
273
274
 
# File 'lib/sunshine-conversations-client/models/ios.rb', line 272

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



158
159
160
161
 
# File 'lib/sunshine-conversations-client/models/ios.rb', line 158

def valid?
  return false if !@certificate.nil? && @certificate.to_s.length < 1
  true && super
end