docusign_esign 2.11.0 → 3.0.0.rc1

data/lib/docusign_esign/models/display_appliance_info.rb

@@ -0,0 +1,235 @@
+=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 DisplayApplianceInfo
+    # 
+    attr_accessor :document_data
+
+    # 
+    attr_accessor :document_pages
+
+    attr_accessor :envelope_data
+
+    # 
+    attr_accessor :page_data
+
+    # 
+    attr_accessor :recipient_data
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'document_data' => :'documentData',
+        :'document_pages' => :'documentPages',
+        :'envelope_data' => :'envelopeData',
+        :'page_data' => :'pageData',
+        :'recipient_data' => :'recipientData'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'document_data' => :'Array<DisplayApplianceDocument>',
+        :'document_pages' => :'Array<DisplayApplianceDocumentPage>',
+        :'envelope_data' => :'DisplayApplianceEnvelope',
+        :'page_data' => :'Array<DisplayAppliancePage>',
+        :'recipient_data' => :'Array<DisplayApplianceRecipient>'
+      }
+    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?(:'documentData')
+        if (value = attributes[:'documentData']).is_a?(Array)
+          self.document_data = value
+        end
+      end
+
+      if attributes.has_key?(:'documentPages')
+        if (value = attributes[:'documentPages']).is_a?(Array)
+          self.document_pages = value
+        end
+      end
+
+      if attributes.has_key?(:'envelopeData')
+        self.envelope_data = attributes[:'envelopeData']
+      end
+
+      if attributes.has_key?(:'pageData')
+        if (value = attributes[:'pageData']).is_a?(Array)
+          self.page_data = value
+        end
+      end
+
+      if attributes.has_key?(:'recipientData')
+        if (value = attributes[:'recipientData']).is_a?(Array)
+          self.recipient_data = value
+        end
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return 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?
+      return 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 &&
+          document_data == o.document_data &&
+          document_pages == o.document_pages &&
+          envelope_data == o.envelope_data &&
+          page_data == o.page_data &&
+          recipient_data == o.recipient_data
+    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
+      [document_data, document_pages, envelope_data, page_data, recipient_data].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 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<(?<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
+        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

data/lib/docusign_esign/models/display_appliance_page.rb

@@ -0,0 +1,278 @@
+=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 DisplayAppliancePage
+    # Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
+    attr_accessor :document_id
+
+    # 
+    attr_accessor :document_name
+
+    # 
+    attr_accessor :external_document_id
+
+    # Height of the tab in pixels.
+    attr_accessor :height
+
+    # 
+    attr_accessor :is_first_page
+
+    # 
+    attr_accessor :page_id
+
+    # 
+    attr_accessor :page_no
+
+    # 
+    attr_accessor :page_status
+
+    # 
+    attr_accessor :page_type
+
+    # Width of the tab in pixels.
+    attr_accessor :width
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'document_id' => :'documentId',
+        :'document_name' => :'documentName',
+        :'external_document_id' => :'externalDocumentId',
+        :'height' => :'height',
+        :'is_first_page' => :'isFirstPage',
+        :'page_id' => :'pageId',
+        :'page_no' => :'pageNo',
+        :'page_status' => :'pageStatus',
+        :'page_type' => :'pageType',
+        :'width' => :'width'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'document_id' => :'String',
+        :'document_name' => :'String',
+        :'external_document_id' => :'String',
+        :'height' => :'Integer',
+        :'is_first_page' => :'BOOLEAN',
+        :'page_id' => :'String',
+        :'page_no' => :'Integer',
+        :'page_status' => :'String',
+        :'page_type' => :'String',
+        :'width' => :'Integer'
+      }
+    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?(:'documentId')
+        self.document_id = attributes[:'documentId']
+      end
+
+      if attributes.has_key?(:'documentName')
+        self.document_name = attributes[:'documentName']
+      end
+
+      if attributes.has_key?(:'externalDocumentId')
+        self.external_document_id = attributes[:'externalDocumentId']
+      end
+
+      if attributes.has_key?(:'height')
+        self.height = attributes[:'height']
+      end
+
+      if attributes.has_key?(:'isFirstPage')
+        self.is_first_page = attributes[:'isFirstPage']
+      end
+
+      if attributes.has_key?(:'pageId')
+        self.page_id = attributes[:'pageId']
+      end
+
+      if attributes.has_key?(:'pageNo')
+        self.page_no = attributes[:'pageNo']
+      end
+
+      if attributes.has_key?(:'pageStatus')
+        self.page_status = attributes[:'pageStatus']
+      end
+
+      if attributes.has_key?(:'pageType')
+        self.page_type = attributes[:'pageType']
+      end
+
+      if attributes.has_key?(:'width')
+        self.width = attributes[:'width']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return 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?
+      return 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 &&
+          document_id == o.document_id &&
+          document_name == o.document_name &&
+          external_document_id == o.external_document_id &&
+          height == o.height &&
+          is_first_page == o.is_first_page &&
+          page_id == o.page_id &&
+          page_no == o.page_no &&
+          page_status == o.page_status &&
+          page_type == o.page_type &&
+          width == o.width
+    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
+      [document_id, document_name, external_document_id, height, is_first_page, page_id, page_no, page_status, page_type, width].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 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<(?<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
+        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