class SunshineConversationsClient::Apple
Attributes
Your Apple
API secret which is tied to your Messaging Service Provider.
Apple
Business Chat ID.
Your Messaging Service Provider ID.
To configure an Apple
Business Chat integration, acquire the required information and call the Create Integration
endpoint.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/sunshine-conversations-client/models/apple.rb, line 27 def self.attribute_map { :'type' => :'type', :'business_id' => :'businessId', :'api_secret' => :'apiSecret', :'msp_id' => :'mspId' } end
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/apple.rb, line 151 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/sunshine-conversations-client/models/apple.rb, line 62 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?(:'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 end
List of class defined in allOf (OpenAPI v3)
# File lib/sunshine-conversations-client/models/apple.rb, line 53 def self.openapi_all_of [ :'AppleAllOf', :'Integration' ] end
List of attributes with nullable: true
# File lib/sunshine-conversations-client/models/apple.rb, line 47 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/sunshine-conversations-client/models/apple.rb, line 37 def self.openapi_types { :'type' => :'String', :'business_id' => :'String', :'api_secret' => :'String', :'msp_id' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/sunshine-conversations-client/models/apple.rb, line 127 def ==(o) return true if self.equal?(o) self.class == o.class && type == o.type && business_id == o.business_id && api_secret == o.api_secret && msp_id == o.msp_id && super(o) end
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/apple.rb, line 180 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
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/apple.rb, line 249 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
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/apple.rb, line 158 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
@see the `==` method @param [Object] Object to be compared
# File lib/sunshine-conversations-client/models/apple.rb, line 138 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/sunshine-conversations-client/models/apple.rb, line 144 def hash [type, business_id, api_secret, msp_id].hash end
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/apple.rb, line 99 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 invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/sunshine-conversations-client/models/apple.rb, line 231 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/sunshine-conversations-client/models/apple.rb, line 219 def to_s to_hash.to_s end
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/apple.rb, line 118 def valid? return false if @business_id.nil? return false if @api_secret.nil? return false if @msp_id.nil? true && super end