class PureCloud::WhatsAppIntegration
Attributes
The error information of WhatsApp Integration
activation process
The status code of WhatsApp Integration
activation process
User
reference that created this Integration
Date this Integration
was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
Date this Integration
was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
A unique Integration
Id.
User
reference that last modified this Integration
The name of the WhatsApp integration.
The phone number associated to the whatsApp integration.
The recipient associated to the WhatsApp Integration
. This recipient is used to associate a flow to an integration
The URI for this object
The status of the WhatsApp Integration
Version number required for updates.
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/whats_app_integration.rb, line 61 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'phone_number' => :'phoneNumber', :'status' => :'status', :'recipient' => :'recipient', :'date_created' => :'dateCreated', :'date_modified' => :'dateModified', :'created_by' => :'createdBy', :'modified_by' => :'modifiedBy', :'version' => :'version', :'activation_status_code' => :'activationStatusCode', :'activation_error_info' => :'activationErrorInfo', :'self_uri' => :'selfUri' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/whats_app_integration.rb, line 128 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} if attributes.has_key?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'phoneNumber') self.phone_number = attributes[:'phoneNumber'] end if attributes.has_key?(:'status') self.status = attributes[:'status'] end if attributes.has_key?(:'recipient') self.recipient = attributes[:'recipient'] end if attributes.has_key?(:'dateCreated') self.date_created = attributes[:'dateCreated'] end if attributes.has_key?(:'dateModified') self.date_modified = attributes[:'dateModified'] end if attributes.has_key?(:'createdBy') self.created_by = attributes[:'createdBy'] end if attributes.has_key?(:'modifiedBy') self.modified_by = attributes[:'modifiedBy'] end if attributes.has_key?(:'version') self.version = attributes[:'version'] end if attributes.has_key?(:'activationStatusCode') self.activation_status_code = attributes[:'activationStatusCode'] end if attributes.has_key?(:'activationErrorInfo') self.activation_error_info = attributes[:'activationErrorInfo'] end if attributes.has_key?(:'selfUri') self.self_uri = attributes[:'selfUri'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/whats_app_integration.rb, line 94 def self.swagger_types { :'id' => :'String', :'name' => :'String', :'phone_number' => :'String', :'status' => :'String', :'recipient' => :'DomainEntityRef', :'date_created' => :'DateTime', :'date_modified' => :'DateTime', :'created_by' => :'DomainEntityRef', :'modified_by' => :'DomainEntityRef', :'version' => :'Integer', :'activation_status_code' => :'String', :'activation_error_info' => :'ErrorBody', :'self_uri' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/whats_app_integration.rb, line 437 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && phone_number == o.phone_number && status == o.status && recipient == o.recipient && date_created == o.date_created && date_modified == o.date_modified && created_by == o.created_by && modified_by == o.modified_by && version == o.version && activation_status_code == o.activation_status_code && activation_error_info == o.activation_error_info && self_uri == o.self_uri end
# File lib/purecloudplatformclientv2/models/whats_app_integration.rb, line 487 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 =~ /^(true|t|yes|y|1)$/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 _model = Object.const_get("PureCloud").const_get(type).new _model.build_from_hash(value) end end
Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
# File lib/purecloudplatformclientv2/models/whats_app_integration.rb, line 547 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
Custom attribute writer method checking allowed values (enum). @param [Object] activation_status_code
Object to be assigned
# File lib/purecloudplatformclientv2/models/whats_app_integration.rb, line 414 def activation_status_code=(activation_status_code) allowed_values = ["CodeSent", "WaitRequired", "ActivationFailed", "CodeConfirmed", "ConfirmationFailed", "ResendCode"] if activation_status_code && !allowed_values.include?(activation_status_code) fail ArgumentError, "invalid value for 'activation_status_code', must be one of #{allowed_values}." end @activation_status_code = activation_status_code end
build the object from hash
# File lib/purecloudplatformclientv2/models/whats_app_integration.rb, line 468 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) else #TODO show warning in debug mode end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) else # data not found in attributes(hash), not an issue as the data can be optional end end self end
@see the `==` method @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/whats_app_integration.rb, line 457 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/whats_app_integration.rb, line 463 def hash [id, name, phone_number, status, recipient, date_created, date_modified, created_by, modified_by, version, activation_status_code, activation_error_info, self_uri].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/purecloudplatformclientv2/models/whats_app_integration.rb, line 256 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned
# File lib/purecloudplatformclientv2/models/whats_app_integration.rb, line 370 def status=(status) allowed_values = ["Active", "Inactive", "Error", "Starting", "Incomplete", "Deleting", "DeletionFailed"] if status && !allowed_values.include?(status) fail ArgumentError, "invalid value for 'status', must be one of #{allowed_values}." end @status = status end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/whats_app_integration.rb, line 535 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end
# File lib/purecloudplatformclientv2/models/whats_app_integration.rb, line 525 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/purecloudplatformclientv2/models/whats_app_integration.rb, line 265 def valid? if @id.nil? return false end if @name.nil? return false end if @phone_number.nil? return false end allowed_values = ["Active", "Inactive", "Error", "Starting", "Incomplete", "Deleting", "DeletionFailed"] if @status && !allowed_values.include?(@status) return false end if @version.nil? return false end allowed_values = ["CodeSent", "WaitRequired", "ActivationFailed", "CodeConfirmed", "ConfirmationFailed", "ResendCode"] if @activation_status_code && !allowed_values.include?(@activation_status_code) return false end end