Class: SunshineConversationsClient::Instagram

Inherits:
Integration
  • Object
show all
Defined in:
lib/sunshine-conversations-client/models/instagram.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 = {}) ⇒ Instagram

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/sunshine-conversations-client/models/instagram.rb', line 104

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'user_id')
    self.user_id = attributes[:'user_id']
  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

#app_id ⇒ Object

Your Facebook App ID.



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

def app_id
  @app_id
end

#app_secret ⇒ Object

Your Facebook App secret.



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

def app_secret
  @app_secret
end

#business_id ⇒ Object

The ID of the Instagram Business account



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

def business_id
  @business_id
end

#business_name ⇒ Object

Your Instagram Business account name



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

def business_name
  @business_name
end

#business_username ⇒ Object

Your Instagram Business unique username



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

def business_username
  @business_username
end

#default_responder ⇒ Object

Returns the value of attribute default_responder.



47
48
49
 
# File 'lib/sunshine-conversations-client/models/instagram.rb', line 47

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.



45
46
47
 
# File 'lib/sunshine-conversations-client/models/instagram.rb', line 45

def default_responder_id
  @default_responder_id
end

#page_access_token ⇒ Object

The Facebook Page Access Token of the Facebook page that is linked to your Instagram account.



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

def page_access_token
  @page_access_token
end

#page_id ⇒ Object

The ID of the Facebook Page linked to your Instagram Business account



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

def page_id
  @page_id
end

#type ⇒ Object

Instagram Direct setup steps: - Take note of your Facebook app ID and secret (apps can be created at [developer.facebook.com](developer.facebook.com)); - The Facebook app must have been submitted to Meta for app review with the "pages_manage_metadata" (to retrieve Page Access Tokens for the Pages and apps that the app user administers and to set a webhook), "instagram_basic", and "instagram_manage_messages" (to retrieve basic Instagram account information and send messages) permissions. - In order to integrate an Instagram Direct app, you must acquire a Page Access Token from your user. Once you have acquired a page access token from your user, call the Create Integration endpoint with your app secret and ID and the user’s page access token.



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

def type
  @type
end

#user_id ⇒ Object

The Facebook user’s user ID. This is returned when integrating through the Dashboard



42
43
44
 
# File 'lib/sunshine-conversations-client/models/instagram.rb', line 42

def user_id
  @user_id
end

#username ⇒ Object

The Facebook user’s username. This is returned when integrating through the Dashboard



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

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/sunshine-conversations-client/models/instagram.rb', line 50

def self.attribute_map
  {
    :'type' => :'type',
    :'page_access_token' => :'pageAccessToken',
    :'app_id' => :'appId',
    :'app_secret' => :'appSecret',
    :'business_name' => :'businessName',
    :'business_username' => :'businessUsername',
    :'page_id' => :'pageId',
    :'business_id' => :'businessId',
    :'username' => :'username',
    :'user_id' => :'userId',
    :'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



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

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



86
87
88
89
90
 
# File 'lib/sunshine-conversations-client/models/instagram.rb', line 86

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

.openapi_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/sunshine-conversations-client/models/instagram.rb', line 68

def self.openapi_types
  {
    :'type' => :'String',
    :'page_access_token' => :'String',
    :'app_id' => :'String',
    :'app_secret' => :'String',
    :'business_name' => :'String',
    :'business_username' => :'String',
    :'page_id' => :'String',
    :'business_id' => :'String',
    :'username' => :'String',
    :'user_id' => :'String',
    :'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



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/sunshine-conversations-client/models/instagram.rb', line 201

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      page_access_token == o.page_access_token &&
      app_id == o.app_id &&
      app_secret == o.app_secret &&
      business_name == o.business_name &&
      business_username == o.business_username &&
      page_id == o.page_id &&
      business_id == o.business_id &&
      username == o.username &&
      user_id == o.user_id &&
      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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/sunshine-conversations-client/models/instagram.rb', line 262

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



331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/sunshine-conversations-client/models/instagram.rb', line 331

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



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/sunshine-conversations-client/models/instagram.rb', line 240

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


220
221
222
 
# File 'lib/sunshine-conversations-client/models/instagram.rb', line 220

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



226
227
228
 
# File 'lib/sunshine-conversations-client/models/instagram.rb', line 226

def hash
  [type, page_access_token, app_id, app_secret, business_name, business_username, page_id, business_id, username, user_id, 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



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

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

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

  if @app_secret.nil?
    invalid_properties.push('invalid value for "app_secret", app_secret cannot be nil.')
  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



307
308
309
 
# File 'lib/sunshine-conversations-client/models/instagram.rb', line 307

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



313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/sunshine-conversations-client/models/instagram.rb', line 313

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



301
302
303
 
# File 'lib/sunshine-conversations-client/models/instagram.rb', line 301

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



192
193
194
195
196
197
 
# File 'lib/sunshine-conversations-client/models/instagram.rb', line 192

def valid?
  return false if @page_access_token.nil?
  return false if @app_id.nil?
  return false if @app_secret.nil?
  true && super
end