class SunshineConversationsClient::IosAllOf

Attributes

auto_update_badge[RW]

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

can_user_create_more_conversations[RW]

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

certificate[RW]

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'`

password[RW]

The password for your APN certificate.

production[RW]

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

type[RW]

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/).

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/ios_all_of.rb, line 33
def self.attribute_map
  {
    :'type' => :'type',
    :'certificate' => :'certificate',
    :'password' => :'password',
    :'production' => :'production',
    :'auto_update_badge' => :'autoUpdateBadge',
    :'can_user_create_more_conversations' => :'canUserCreateMoreConversations'
  }
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/ios_all_of.rb, line 161
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/ios_all_of.rb, line 65
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SunshineConversationsClient::IosAllOf` 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::IosAllOf`. 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 = '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
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/sunshine-conversations-client/models/ios_all_of.rb, line 45
def self.openapi_types
  {
    :'type' => :'String',
    :'certificate' => :'String',
    :'password' => :'String',
    :'production' => :'Boolean',
    :'auto_update_badge' => :'Boolean',
    :'can_user_create_more_conversations' => :'Boolean'
  }
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/ios_all_of.rb, line 135
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
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/ios_all_of.rb, line 189
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/ios_all_of.rb, line 258
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/ios_all_of.rb, line 168
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
certificate=(certificate) click to toggle source

Custom attribute writer method with validation @param [Object] certificate Value to be assigned

# File lib/sunshine-conversations-client/models/ios_all_of.rb, line 125
def certificate=(certificate)
  if !certificate.nil? && certificate.to_s.length < 1
    fail ArgumentError, 'invalid value for "certificate", the character length must be great than or equal to 1.'
  end

  @certificate = certificate
end
eql?(o) click to toggle source

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

# File lib/sunshine-conversations-client/models/ios_all_of.rb, line 148
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/ios_all_of.rb, line 154
def hash
  [type, certificate, password, production, auto_update_badge, can_user_create_more_conversations].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/ios_all_of.rb, line 107
def list_invalid_properties
  invalid_properties = Array.new
  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() 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/ios_all_of.rb, line 234
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/ios_all_of.rb, line 240
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/ios_all_of.rb, line 228
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/ios_all_of.rb, line 118
def valid?
  return false if !@certificate.nil? && @certificate.to_s.length < 1
  true
end