docusign_esign 3.2.1 → 3.5.0.rc1

data/lib/docusign_esign/models/bulk_send_batch_summaries.rb

@@ -0,0 +1,277 @@
+=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
+Swagger Codegen version: 2.4.13-SNAPSHOT
+
+=end
+
+require 'date'
+
+module DocuSign_eSign
+  class BulkSendBatchSummaries
+    # 
+    attr_accessor :batch_size_limit
+
+    # 
+    attr_accessor :bulk_batch_summaries
+
+    # The last position in the result set. 
+    attr_accessor :end_position
+
+    # The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null. 
+    attr_accessor :next_uri
+
+    # The postal code for the billing address.
+    attr_accessor :previous_uri
+
+    # 
+    attr_accessor :queue_limit
+
+    # The number of results returned in this response. 
+    attr_accessor :result_set_size
+
+    # Starting position of the current result set.
+    attr_accessor :start_position
+
+    # 
+    attr_accessor :total_queued
+
+    # The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response.
+    attr_accessor :total_set_size
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'batch_size_limit' => :'batchSizeLimit',
+        :'bulk_batch_summaries' => :'bulkBatchSummaries',
+        :'end_position' => :'endPosition',
+        :'next_uri' => :'nextUri',
+        :'previous_uri' => :'previousUri',
+        :'queue_limit' => :'queueLimit',
+        :'result_set_size' => :'resultSetSize',
+        :'start_position' => :'startPosition',
+        :'total_queued' => :'totalQueued',
+        :'total_set_size' => :'totalSetSize'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'batch_size_limit' => :'String',
+        :'bulk_batch_summaries' => :'Array<BulkSendBatchSummary>',
+        :'end_position' => :'String',
+        :'next_uri' => :'String',
+        :'previous_uri' => :'String',
+        :'queue_limit' => :'String',
+        :'result_set_size' => :'String',
+        :'start_position' => :'String',
+        :'total_queued' => :'String',
+        :'total_set_size' => :'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?(:'batchSizeLimit')
+        self.batch_size_limit = attributes[:'batchSizeLimit']
+      end
+
+      if attributes.has_key?(:'bulkBatchSummaries')
+        if (value = attributes[:'bulkBatchSummaries']).is_a?(Array)
+          self.bulk_batch_summaries = value
+        end
+      end
+
+      if attributes.has_key?(:'endPosition')
+        self.end_position = attributes[:'endPosition']
+      end
+
+      if attributes.has_key?(:'nextUri')
+        self.next_uri = attributes[:'nextUri']
+      end
+
+      if attributes.has_key?(:'previousUri')
+        self.previous_uri = attributes[:'previousUri']
+      end
+
+      if attributes.has_key?(:'queueLimit')
+        self.queue_limit = attributes[:'queueLimit']
+      end
+
+      if attributes.has_key?(:'resultSetSize')
+        self.result_set_size = attributes[:'resultSetSize']
+      end
+
+      if attributes.has_key?(:'startPosition')
+        self.start_position = attributes[:'startPosition']
+      end
+
+      if attributes.has_key?(:'totalQueued')
+        self.total_queued = attributes[:'totalQueued']
+      end
+
+      if attributes.has_key?(:'totalSetSize')
+        self.total_set_size = attributes[:'totalSetSize']
+      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 &&
+          batch_size_limit == o.batch_size_limit &&
+          bulk_batch_summaries == o.bulk_batch_summaries &&
+          end_position == o.end_position &&
+          next_uri == o.next_uri &&
+          previous_uri == o.previous_uri &&
+          queue_limit == o.queue_limit &&
+          result_set_size == o.result_set_size &&
+          start_position == o.start_position &&
+          total_queued == o.total_queued &&
+          total_set_size == o.total_set_size
+    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
+      [batch_size_limit, bulk_batch_summaries, end_position, next_uri, previous_uri, queue_limit, result_set_size, start_position, total_queued, total_set_size].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_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/bulk_send_batch_summary.rb

@@ -0,0 +1,255 @@
+=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
+Swagger Codegen version: 2.4.13-SNAPSHOT
+
+=end
+
+require 'date'
+
+module DocuSign_eSign
+  class BulkSendBatchSummary
+    # 
+    attr_accessor :batch_id
+
+    # 
+    attr_accessor :batch_name
+
+    # 
+    attr_accessor :batch_size
+
+    # 
+    attr_accessor :batch_uri
+
+    # 
+    attr_accessor :failed
+
+    # 
+    attr_accessor :queued
+
+    # 
+    attr_accessor :sent
+
+    # 
+    attr_accessor :submitted_date
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'batch_id' => :'batchId',
+        :'batch_name' => :'batchName',
+        :'batch_size' => :'batchSize',
+        :'batch_uri' => :'batchUri',
+        :'failed' => :'failed',
+        :'queued' => :'queued',
+        :'sent' => :'sent',
+        :'submitted_date' => :'submittedDate'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'batch_id' => :'String',
+        :'batch_name' => :'String',
+        :'batch_size' => :'String',
+        :'batch_uri' => :'String',
+        :'failed' => :'String',
+        :'queued' => :'String',
+        :'sent' => :'String',
+        :'submitted_date' => :'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?(:'batchId')
+        self.batch_id = attributes[:'batchId']
+      end
+
+      if attributes.has_key?(:'batchName')
+        self.batch_name = attributes[:'batchName']
+      end
+
+      if attributes.has_key?(:'batchSize')
+        self.batch_size = attributes[:'batchSize']
+      end
+
+      if attributes.has_key?(:'batchUri')
+        self.batch_uri = attributes[:'batchUri']
+      end
+
+      if attributes.has_key?(:'failed')
+        self.failed = attributes[:'failed']
+      end
+
+      if attributes.has_key?(:'queued')
+        self.queued = attributes[:'queued']
+      end
+
+      if attributes.has_key?(:'sent')
+        self.sent = attributes[:'sent']
+      end
+
+      if attributes.has_key?(:'submittedDate')
+        self.submitted_date = attributes[:'submittedDate']
+      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 &&
+          batch_id == o.batch_id &&
+          batch_name == o.batch_name &&
+          batch_size == o.batch_size &&
+          batch_uri == o.batch_uri &&
+          failed == o.failed &&
+          queued == o.queued &&
+          sent == o.sent &&
+          submitted_date == o.submitted_date
+    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
+      [batch_id, batch_name, batch_size, batch_uri, failed, queued, sent, submitted_date].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_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