Class: SunshineConversationsClient::Apple

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

Defined Under Namespace

Classes: EnumAttributeValidator

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 = {}) ⇒ Apple

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
144
145
146
147
 
# File 'lib/sunshine-conversations-client/models/apple.rb', line 102

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

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

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

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

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

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

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

Instance Attribute Details

#api_secret ⇒ Object

Your Apple API secret which is tied to your Messaging Service Provider.



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

def api_secret
  @api_secret
end

#authentication_message_secret ⇒ Object

A secret used to create the state value when sending Apple authentication 2.0 messages



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

def authentication_message_secret
  @authentication_message_secret
end

#business_id ⇒ Object

Apple Messages for Business ID.



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

def business_id
  @business_id
end

#default_responder ⇒ Object

Returns the value of attribute default_responder.



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

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 the <a href="developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/switchboard/#default-integration-assignment">Switchboard guide</a>.



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

def default_responder_id
  @default_responder_id
end

#msp_id ⇒ Object

Your Messaging Service Provider ID.



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

def msp_id
  @msp_id
end

#type ⇒ Object

To configure an Apple Messages for Business integration, acquire the required information and call the Create Integration endpoint.



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

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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/sunshine-conversations-client/models/apple.rb', line 246

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.



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

def self.attribute_map
  {
    :'default_responder_id' => :'defaultResponderId',
    :'default_responder' => :'defaultResponder',
    :'type' => :'type',
    :'business_id' => :'businessId',
    :'api_secret' => :'apiSecret',
    :'msp_id' => :'mspId',
    :'authentication_message_secret' => :'authenticationMessageSecret'
  }
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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/sunshine-conversations-client/models/apple.rb', line 221

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



92
93
94
95
96
97
98
 
# File 'lib/sunshine-conversations-client/models/apple.rb', line 92

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



84
85
86
87
88
89
 
# File 'lib/sunshine-conversations-client/models/apple.rb', line 84

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

.openapi_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/sunshine-conversations-client/models/apple.rb', line 71

def self.openapi_types
  {
    :'default_responder_id' => :'String',
    :'default_responder' => :'DefaultResponderDefaultResponder',
    :'type' => :'String',
    :'business_id' => :'String',
    :'api_secret' => :'String',
    :'msp_id' => :'String',
    :'authentication_message_secret' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/sunshine-conversations-client/models/apple.rb', line 194

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      default_responder_id == o.default_responder_id &&
      default_responder == o.default_responder &&
      type == o.type &&
      business_id == o.business_id &&
      api_secret == o.api_secret &&
      msp_id == o.msp_id &&
      authentication_message_secret == o.authentication_message_secret && super(o)
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



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/sunshine-conversations-client/models/apple.rb', line 317

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


208
209
210
 
# File 'lib/sunshine-conversations-client/models/apple.rb', line 208

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



214
215
216
 
# File 'lib/sunshine-conversations-client/models/apple.rb', line 214

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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/sunshine-conversations-client/models/apple.rb', line 151

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

  if @api_secret.nil?
    invalid_properties.push('invalid value for "api_secret", api_secret cannot be nil.')
  end

  if @msp_id.nil?
    invalid_properties.push('invalid value for "msp_id", msp_id cannot be nil.')
  end

  if !@authentication_message_secret.nil? && @authentication_message_secret.to_s.length < 88
    invalid_properties.push('invalid value for "authentication_message_secret", the character length must be great than or equal to 88.')
  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



293
294
295
 
# File 'lib/sunshine-conversations-client/models/apple.rb', line 293

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



299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/sunshine-conversations-client/models/apple.rb', line 299

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



287
288
289
 
# File 'lib/sunshine-conversations-client/models/apple.rb', line 287

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



174
175
176
177
178
179
180
 
# File 'lib/sunshine-conversations-client/models/apple.rb', line 174

def valid?
  return false if @business_id.nil?
  return false if @api_secret.nil?
  return false if @msp_id.nil?
  return false if !@authentication_message_secret.nil? && @authentication_message_secret.to_s.length < 88
  true && super
end