class SunshineConversationsClient::InstagramAllOf

Attributes

app_id[RW]

Your Facebook App ID.

app_secret[RW]

Your Facebook App secret.

business_id[RW]

The ID of the Instagram Business account

business_name[RW]

Your Instagram Business account name

business_username[RW]

Your Instagram Business unique username

page_access_token[RW]

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

page_id[RW]

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

type[RW]

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 Facebook for app review with the "manage_pages" (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.

user_id[RW]

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

username[RW]

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

Public Class Methods

attribute_map() click to toggle source

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

# File lib/sunshine-conversations-client/models/instagram_all_of.rb, line 45
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'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/sunshine-conversations-client/models/instagram_all_of.rb, line 200
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/sunshine-conversations-client/models/instagram_all_of.rb, line 84
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SunshineConversationsClient::InstagramAllOf` 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::InstagramAllOf`. 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?(:'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
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/sunshine-conversations-client/models/instagram_all_of.rb, line 77
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/sunshine-conversations-client/models/instagram_all_of.rb, line 61
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'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/sunshine-conversations-client/models/instagram_all_of.rb, line 170
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
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/sunshine-conversations-client/models/instagram_all_of.rb, line 228
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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/sunshine-conversations-client/models/instagram_all_of.rb, line 297
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/sunshine-conversations-client/models/instagram_all_of.rb, line 207
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/sunshine-conversations-client/models/instagram_all_of.rb, line 187
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/sunshine-conversations-client/models/instagram_all_of.rb, line 193
def hash
  [type, page_access_token, app_id, app_secret, business_name, business_username, page_id, business_id, username, user_id].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/sunshine-conversations-client/models/instagram_all_of.rb, line 142
def list_invalid_properties
  invalid_properties = Array.new
  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() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/sunshine-conversations-client/models/instagram_all_of.rb, line 273
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/sunshine-conversations-client/models/instagram_all_of.rb, line 279
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/sunshine-conversations-client/models/instagram_all_of.rb, line 267
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/sunshine-conversations-client/models/instagram_all_of.rb, line 161
def valid?
  return false if @page_access_token.nil?
  return false if @app_id.nil?
  return false if @app_secret.nil?
  true
end