=begin #DocuSign REST API #The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. OpenAPI spec version: v2.1 Contact: devcenter@docusign.com Generated by: https://github.com/swagger-api/swagger-codegen.git =end require 'date' module DocuSign_eSign class UserSignature # The date and time the user adopted their signature. attr_accessor :adopted_date_time # Indicates the date and time the item was created. attr_accessor :created_date_time # attr_accessor :custom_field # Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area. This property contains the following information about the central rectangle: - `DateAreaX`: The X axis position of the top-left corner. - `DateAreaY`: The Y axis position of the top-left corner. - `DateAreaWidth`: The width of the rectangle. - `DateAreaHeight`: The height of the rectangle. attr_accessor :date_stamp_properties # attr_accessor :disallow_user_resize_stamp # This object describes errors that occur. It is only valid for responses and ignored in requests. attr_accessor :error_details # attr_accessor :external_id # attr_accessor :image_base64 # attr_accessor :image_type # attr_accessor :initials150_image_id # Contains the URI for an endpoint that you can use to retrieve the initials image. attr_accessor :initials_image_uri # attr_accessor :is_default # The date and time the item was last modified. attr_accessor :last_modified_date_time # attr_accessor :nrds_id # attr_accessor :nrds_last_name # attr_accessor :nrds_status # attr_accessor :phonetic_name # attr_accessor :signature150_image_id # The font type for the signature, if the signature is not drawn. The supported font types are: \"7_DocuSign\", \"1_DocuSign\", \"6_DocuSign\", \"8_DocuSign\", \"3_DocuSign\", \"Mistral\", \"4_DocuSign\", \"2_DocuSign\", \"5_DocuSign\", \"Rage Italic\" attr_accessor :signature_font # Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as \"&\", \"<\", \">\") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID. attr_accessor :signature_id # Contains the URI for an endpoint that you can use to retrieve the signature image. attr_accessor :signature_image_uri # The initials associated with the signature. attr_accessor :signature_initials # Specifies the user signature name. attr_accessor :signature_name # attr_accessor :signature_rights # attr_accessor :signature_type # attr_accessor :stamp_format # attr_accessor :stamp_image_uri # attr_accessor :stamp_size_mm # attr_accessor :stamp_type # Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. attr_accessor :status # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { :'adopted_date_time' => :'adoptedDateTime', :'created_date_time' => :'createdDateTime', :'custom_field' => :'customField', :'date_stamp_properties' => :'dateStampProperties', :'disallow_user_resize_stamp' => :'disallowUserResizeStamp', :'error_details' => :'errorDetails', :'external_id' => :'externalID', :'image_base64' => :'imageBase64', :'image_type' => :'imageType', :'initials150_image_id' => :'initials150ImageId', :'initials_image_uri' => :'initialsImageUri', :'is_default' => :'isDefault', :'last_modified_date_time' => :'lastModifiedDateTime', :'nrds_id' => :'nrdsId', :'nrds_last_name' => :'nrdsLastName', :'nrds_status' => :'nrdsStatus', :'phonetic_name' => :'phoneticName', :'signature150_image_id' => :'signature150ImageId', :'signature_font' => :'signatureFont', :'signature_id' => :'signatureId', :'signature_image_uri' => :'signatureImageUri', :'signature_initials' => :'signatureInitials', :'signature_name' => :'signatureName', :'signature_rights' => :'signatureRights', :'signature_type' => :'signatureType', :'stamp_format' => :'stampFormat', :'stamp_image_uri' => :'stampImageUri', :'stamp_size_mm' => :'stampSizeMM', :'stamp_type' => :'stampType', :'status' => :'status' } end # Attribute type mapping. def self.swagger_types { :'adopted_date_time' => :'String', :'created_date_time' => :'String', :'custom_field' => :'String', :'date_stamp_properties' => :'DateStampProperties', :'disallow_user_resize_stamp' => :'String', :'error_details' => :'ErrorDetails', :'external_id' => :'String', :'image_base64' => :'String', :'image_type' => :'String', :'initials150_image_id' => :'String', :'initials_image_uri' => :'String', :'is_default' => :'String', :'last_modified_date_time' => :'String', :'nrds_id' => :'String', :'nrds_last_name' => :'String', :'nrds_status' => :'String', :'phonetic_name' => :'String', :'signature150_image_id' => :'String', :'signature_font' => :'String', :'signature_id' => :'String', :'signature_image_uri' => :'String', :'signature_initials' => :'String', :'signature_name' => :'String', :'signature_rights' => :'String', :'signature_type' => :'String', :'stamp_format' => :'String', :'stamp_image_uri' => :'String', :'stamp_size_mm' => :'String', :'stamp_type' => :'String', :'status' => :'String' } end # Initializes the object # @param [Hash] attributes Model attributes in the form of hash 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?(:'adoptedDateTime') self.adopted_date_time = attributes[:'adoptedDateTime'] end if attributes.has_key?(:'createdDateTime') self.created_date_time = attributes[:'createdDateTime'] end if attributes.has_key?(:'customField') self.custom_field = attributes[:'customField'] end if attributes.has_key?(:'dateStampProperties') self.date_stamp_properties = attributes[:'dateStampProperties'] end if attributes.has_key?(:'disallowUserResizeStamp') self.disallow_user_resize_stamp = attributes[:'disallowUserResizeStamp'] end if attributes.has_key?(:'errorDetails') self.error_details = attributes[:'errorDetails'] end if attributes.has_key?(:'externalID') self.external_id = attributes[:'externalID'] end if attributes.has_key?(:'imageBase64') self.image_base64 = attributes[:'imageBase64'] end if attributes.has_key?(:'imageType') self.image_type = attributes[:'imageType'] end if attributes.has_key?(:'initials150ImageId') self.initials150_image_id = attributes[:'initials150ImageId'] end if attributes.has_key?(:'initialsImageUri') self.initials_image_uri = attributes[:'initialsImageUri'] end if attributes.has_key?(:'isDefault') self.is_default = attributes[:'isDefault'] end if attributes.has_key?(:'lastModifiedDateTime') self.last_modified_date_time = attributes[:'lastModifiedDateTime'] end if attributes.has_key?(:'nrdsId') self.nrds_id = attributes[:'nrdsId'] end if attributes.has_key?(:'nrdsLastName') self.nrds_last_name = attributes[:'nrdsLastName'] end if attributes.has_key?(:'nrdsStatus') self.nrds_status = attributes[:'nrdsStatus'] end if attributes.has_key?(:'phoneticName') self.phonetic_name = attributes[:'phoneticName'] end if attributes.has_key?(:'signature150ImageId') self.signature150_image_id = attributes[:'signature150ImageId'] end if attributes.has_key?(:'signatureFont') self.signature_font = attributes[:'signatureFont'] end if attributes.has_key?(:'signatureId') self.signature_id = attributes[:'signatureId'] end if attributes.has_key?(:'signatureImageUri') self.signature_image_uri = attributes[:'signatureImageUri'] end if attributes.has_key?(:'signatureInitials') self.signature_initials = attributes[:'signatureInitials'] end if attributes.has_key?(:'signatureName') self.signature_name = attributes[:'signatureName'] end if attributes.has_key?(:'signatureRights') self.signature_rights = attributes[:'signatureRights'] end if attributes.has_key?(:'signatureType') self.signature_type = attributes[:'signatureType'] end if attributes.has_key?(:'stampFormat') self.stamp_format = attributes[:'stampFormat'] end if attributes.has_key?(:'stampImageUri') self.stamp_image_uri = attributes[:'stampImageUri'] end if attributes.has_key?(:'stampSizeMM') self.stamp_size_mm = attributes[:'stampSizeMM'] end if attributes.has_key?(:'stampType') self.stamp_type = attributes[:'stampType'] end if attributes.has_key?(:'status') self.status = attributes[:'status'] end end # Show invalid properties with the reasons. Usually used together with valid? # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new invalid_properties end # Check to see if the all the properties in the model are valid # @return true if the model is valid def valid? true end # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) return true if self.equal?(o) self.class == o.class && adopted_date_time == o.adopted_date_time && created_date_time == o.created_date_time && custom_field == o.custom_field && date_stamp_properties == o.date_stamp_properties && disallow_user_resize_stamp == o.disallow_user_resize_stamp && error_details == o.error_details && external_id == o.external_id && image_base64 == o.image_base64 && image_type == o.image_type && initials150_image_id == o.initials150_image_id && initials_image_uri == o.initials_image_uri && is_default == o.is_default && last_modified_date_time == o.last_modified_date_time && nrds_id == o.nrds_id && nrds_last_name == o.nrds_last_name && nrds_status == o.nrds_status && phonetic_name == o.phonetic_name && signature150_image_id == o.signature150_image_id && signature_font == o.signature_font && signature_id == o.signature_id && signature_image_uri == o.signature_image_uri && signature_initials == o.signature_initials && signature_name == o.signature_name && signature_rights == o.signature_rights && signature_type == o.signature_type && stamp_format == o.stamp_format && stamp_image_uri == o.stamp_image_uri && stamp_size_mm == o.stamp_size_mm && stamp_type == o.stamp_type && status == o.status end # @see the `==` method # @param [Object] Object to be compared def eql?(o) self == o end # Calculates hash code according to all attributes. # @return [Fixnum] Hash code def hash [adopted_date_time, created_date_time, custom_field, date_stamp_properties, disallow_user_resize_stamp, error_details, external_id, image_base64, image_type, initials150_image_id, initials_image_uri, is_default, last_modified_date_time, nrds_id, nrds_last_name, nrds_status, phonetic_name, signature150_image_id, signature_font, signature_id, signature_image_uri, signature_initials, signature_name, signature_rights, signature_type, stamp_format, stamp_image_uri, stamp_size_mm, stamp_type, status].hash end # Builds the object from hash # @param [Hash] attributes Model attributes in the form of hash # @return [Object] Returns the model itself def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_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 # Deserializes the data based on type # @param string type Data type # @param string value Value to be deserialized # @return [Object] Deserialized data 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<(?.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?.+?), (?.+)>\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 temp_model = DocuSign_eSign.const_get(type).new temp_model.build_from_hash(value) end end # Returns the string representation of the object # @return [String] String presentation of the object def to_s to_hash.to_s end # to_body is an alias to to_hash (backward compatibility) # @return [Hash] Returns the object in the form of hash def to_body to_hash end # Returns the object in the form of hash # @return [Hash] Returns the object in the form of hash 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 # 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 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 end end