docusign_webforms 1.0.0

data/lib/docusign_webforms/models/web_form.rb

@@ -0,0 +1,268 @@
+=begin
+#Web Forms API version 1.1
+
+#The Web Forms API facilitates generating semantic HTML forms around everyday contracts. 
+
+OpenAPI spec version: 1.1.0
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+module DocuSign_WebForms
+  # An object that fully describes an instance of a form
+  class WebForm
+    attr_accessor :id
+
+    attr_accessor :account_id
+
+    # Has the form been published
+    attr_accessor :is_published
+
+    # Is the form currently enabled and available for data collection
+    attr_accessor :is_enabled
+
+    # Does the form have draft changes that need to be published?
+    attr_accessor :has_draft_changes
+
+    attr_accessor :form_state
+
+    attr_accessor :form_properties
+
+    attr_accessor :form_metadata
+
+    attr_accessor :version_id
+
+    attr_accessor :form_content
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'account_id' => :'accountId',
+        :'is_published' => :'isPublished',
+        :'is_enabled' => :'isEnabled',
+        :'has_draft_changes' => :'hasDraftChanges',
+        :'form_state' => :'formState',
+        :'form_properties' => :'formProperties',
+        :'form_metadata' => :'formMetadata',
+        :'version_id' => :'versionId',
+        :'form_content' => :'formContent'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'id' => :'String',
+        :'account_id' => :'String',
+        :'is_published' => :'BOOLEAN',
+        :'is_enabled' => :'BOOLEAN',
+        :'has_draft_changes' => :'BOOLEAN',
+        :'form_state' => :'WebFormState',
+        :'form_properties' => :'WebFormProperties',
+        :'form_metadata' => :'WebFormMetadata',
+        :'version_id' => :'Integer',
+        :'form_content' => :'WebFormContent'
+      }
+    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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.has_key?(:'accountId')
+        self.account_id = attributes[:'accountId']
+      end
+
+      if attributes.has_key?(:'isPublished')
+        self.is_published = attributes[:'isPublished']
+      end
+
+      if attributes.has_key?(:'isEnabled')
+        self.is_enabled = attributes[:'isEnabled']
+      end
+
+      if attributes.has_key?(:'hasDraftChanges')
+        self.has_draft_changes = attributes[:'hasDraftChanges']
+      end
+
+      if attributes.has_key?(:'formState')
+        self.form_state = attributes[:'formState']
+      end
+
+      if attributes.has_key?(:'formProperties')
+        self.form_properties = attributes[:'formProperties']
+      end
+
+      if attributes.has_key?(:'formMetadata')
+        self.form_metadata = attributes[:'formMetadata']
+      end
+
+      if attributes.has_key?(:'versionId')
+        self.version_id = attributes[:'versionId']
+      end
+
+      if attributes.has_key?(:'formContent')
+        self.form_content = attributes[:'formContent']
+      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 &&
+          id == o.id &&
+          account_id == o.account_id &&
+          is_published == o.is_published &&
+          is_enabled == o.is_enabled &&
+          has_draft_changes == o.has_draft_changes &&
+          form_state == o.form_state &&
+          form_properties == o.form_properties &&
+          form_metadata == o.form_metadata &&
+          version_id == o.version_id &&
+          form_content == o.form_content
+    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
+      [id, account_id, is_published, is_enabled, has_draft_changes, form_state, form_properties, form_metadata, version_id, form_content].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<(?<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_WebForms.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_webforms/models/web_form_adm_type.rb

@@ -0,0 +1,39 @@
+=begin
+#Web Forms API version 1.1
+
+#The Web Forms API facilitates generating semantic HTML forms around everyday contracts. 
+
+OpenAPI spec version: 1.1.0
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+module DocuSign_WebForms
+  class WebFormAdmType
+    
+    STRING = 'String'.freeze
+    BOOLEAN = 'Boolean'.freeze
+    DOUBLE = 'Double'.freeze
+    DATE_TIME = 'DateTime'.freeze
+    ARRAY_OF_STRING = 'ArrayOfString'.freeze
+    CHECKBOX_GROUP = 'CheckboxGroup'.freeze
+    DATE = 'Date'.freeze
+    EMAIL = 'Email'.freeze
+    NUMBER = 'Number'.freeze
+    RADIO_BUTTON_GROUP = 'RadioButtonGroup'.freeze
+    SELECT = 'Select'.freeze
+    TEXT_BOX = 'TextBox'.freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      constantValues = WebFormAdmType.constants.select { |c| WebFormAdmType::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #WebFormAdmType" if constantValues.empty?
+      value
+    end
+  end
+end

data/lib/docusign_webforms/models/web_form_component.rb

@@ -0,0 +1,248 @@
+=begin
+#Web Forms API version 1.1
+
+#The Web Forms API facilitates generating semantic HTML forms around everyday contracts. 
+
+OpenAPI spec version: 1.1.0
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+module DocuSign_WebForms
+  # Each component type contains additional properties
+  class WebFormComponent
+    attr_accessor :component_key
+
+    # The type of component this object represents
+    attr_accessor :component_type
+
+    # Name value that is used for mapping components to external sources
+    attr_accessor :component_name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'component_key' => :'componentKey',
+        :'component_type' => :'componentType',
+        :'component_name' => :'componentName'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'component_key' => :'String',
+        :'component_type' => :'String',
+        :'component_name' => :'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?(:'componentKey')
+        self.component_key = attributes[:'componentKey']
+      end
+
+      if attributes.has_key?(:'componentType')
+        self.component_type = attributes[:'componentType']
+      end
+
+      if attributes.has_key?(:'componentName')
+        self.component_name = attributes[:'componentName']
+      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
+      if @component_key.nil?
+        invalid_properties.push('invalid value for "component_key", component_key cannot be nil.')
+      end
+
+      if @component_type.nil?
+        invalid_properties.push('invalid value for "component_type", component_type cannot be nil.')
+      end
+
+      if @component_type.to_s.length > 100
+        invalid_properties.push('invalid value for "component_type", the character length must be smaller than or equal to 100.')
+      end
+
+      if !@component_name.nil? && @component_name.to_s.length > 100
+        invalid_properties.push('invalid value for "component_name", the character length must be smaller than or equal to 100.')
+      end
+
+      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 false if @component_key.nil?
+      return false if @component_type.nil?
+      return false if @component_type.to_s.length > 100
+      return false if !@component_name.nil? && @component_name.to_s.length > 100
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] component_type Value to be assigned
+    def component_type=(component_type)
+      if component_type.nil?
+        fail ArgumentError, 'component_type cannot be nil'
+      end
+
+      if component_type.to_s.length > 100
+        fail ArgumentError, 'invalid value for "component_type", the character length must be smaller than or equal to 100.'
+      end
+
+      @component_type = component_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] component_name Value to be assigned
+    def component_name=(component_name)
+      if !component_name.nil? && component_name.to_s.length > 100
+        fail ArgumentError, 'invalid value for "component_name", the character length must be smaller than or equal to 100.'
+      end
+
+      @component_name = component_name
+    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 &&
+          component_key == o.component_key &&
+          component_type == o.component_type &&
+          component_name == o.component_name
+    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
+      [component_key, component_type, component_name].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<(?<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_WebForms.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_webforms/models/web_form_component_type.rb

@@ -0,0 +1,34 @@
+=begin
+#Web Forms API version 1.1
+
+#The Web Forms API facilitates generating semantic HTML forms around everyday contracts. 
+
+OpenAPI spec version: 1.1.0
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+module DocuSign_WebForms
+  class WebFormComponentType
+    
+    CHECKBOX_GROUP = 'CheckboxGroup'.freeze
+    DATE = 'Date'.freeze
+    EMAIL = 'Email'.freeze
+    NUMBER = 'Number'.freeze
+    RADIO_BUTTON_GROUP = 'RadioButtonGroup'.freeze
+    SELECT = 'Select'.freeze
+    TEXT_BOX = 'TextBox'.freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      constantValues = WebFormComponentType.constants.select { |c| WebFormComponentType::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #WebFormComponentType" if constantValues.empty?
+      value
+    end
+  end
+end