docusign_esign 3.12.0 → 3.19.0

data/lib/docusign_esign/models/bulk_send_batch_error.rb

@@ -0,0 +1,194 @@
+=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 BulkSendBatchError
+    # 
+    attr_accessor :error
+
+    # 
+    attr_accessor :error_detail
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'error' => :'error',
+        :'error_detail' => :'errorDetail'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'error' => :'String',
+        :'error_detail' => :'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?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.has_key?(:'errorDetail')
+        self.error_detail = attributes[:'errorDetail']
+      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 &&
+          error == o.error &&
+          error_detail == o.error_detail
+    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
+      [error, error_detail].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_status.rb

@@ -12,7 +12,14 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Result of `getBulkSendBatchStatus`
   class BulkSendBatchStatus
+    # 
+    attr_accessor :action
+
+    # 
+    attr_accessor :action_status
+
     # 
     attr_accessor :batch_id
 
@@ -28,6 +35,9 @@ module DocuSign_eSign
     # 
     attr_accessor :envelope_id_or_template_id
 
+    # 
+    attr_accessor :envelopes_info
+
     # 
     attr_accessor :envelopes_uri
 
@@ -46,6 +56,9 @@ module DocuSign_eSign
     # 
     attr_accessor :queued
 
+    # 
+    attr_accessor :resends_remaining
+
     # 
     attr_accessor :sender_user_id
 
@@ -58,17 +71,21 @@ module DocuSign_eSign
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'action' => :'action',
+        :'action_status' => :'actionStatus',
         :'batch_id' => :'batchId',
         :'batch_name' => :'batchName',
         :'batch_size' => :'batchSize',
         :'bulk_errors' => :'bulkErrors',
         :'envelope_id_or_template_id' => :'envelopeIdOrTemplateId',
+        :'envelopes_info' => :'envelopesInfo',
         :'envelopes_uri' => :'envelopesUri',
         :'failed' => :'failed',
         :'mailing_list_id' => :'mailingListId',
         :'mailing_list_name' => :'mailingListName',
         :'owner_user_id' => :'ownerUserId',
         :'queued' => :'queued',
+        :'resends_remaining' => :'resendsRemaining',
         :'sender_user_id' => :'senderUserId',
         :'sent' => :'sent',
         :'submitted_date' => :'submittedDate'
@@ -78,17 +95,21 @@ module DocuSign_eSign
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'action' => :'String',
+        :'action_status' => :'String',
         :'batch_id' => :'String',
         :'batch_name' => :'String',
         :'batch_size' => :'String',
         :'bulk_errors' => :'Array<BulkSendErrorStatus>',
         :'envelope_id_or_template_id' => :'String',
+        :'envelopes_info' => :'BulkSendEnvelopesInfo',
         :'envelopes_uri' => :'String',
         :'failed' => :'String',
         :'mailing_list_id' => :'String',
         :'mailing_list_name' => :'String',
         :'owner_user_id' => :'String',
         :'queued' => :'String',
+        :'resends_remaining' => :'String',
         :'sender_user_id' => :'String',
         :'sent' => :'String',
         :'submitted_date' => :'String'
@@ -103,6 +124,14 @@ module DocuSign_eSign
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
+      if attributes.has_key?(:'action')
+        self.action = attributes[:'action']
+      end
+
+      if attributes.has_key?(:'actionStatus')
+        self.action_status = attributes[:'actionStatus']
+      end
+
       if attributes.has_key?(:'batchId')
         self.batch_id = attributes[:'batchId']
       end
@@ -125,6 +154,10 @@ module DocuSign_eSign
         self.envelope_id_or_template_id = attributes[:'envelopeIdOrTemplateId']
       end
 
+      if attributes.has_key?(:'envelopesInfo')
+        self.envelopes_info = attributes[:'envelopesInfo']
+      end
+
       if attributes.has_key?(:'envelopesUri')
         self.envelopes_uri = attributes[:'envelopesUri']
       end
@@ -149,6 +182,10 @@ module DocuSign_eSign
         self.queued = attributes[:'queued']
       end
 
+      if attributes.has_key?(:'resendsRemaining')
+        self.resends_remaining = attributes[:'resendsRemaining']
+      end
+
       if attributes.has_key?(:'senderUserId')
         self.sender_user_id = attributes[:'senderUserId']
       end
@@ -180,17 +217,21 @@ module DocuSign_eSign
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          action == o.action &&
+          action_status == o.action_status &&
           batch_id == o.batch_id &&
           batch_name == o.batch_name &&
           batch_size == o.batch_size &&
           bulk_errors == o.bulk_errors &&
           envelope_id_or_template_id == o.envelope_id_or_template_id &&
+          envelopes_info == o.envelopes_info &&
           envelopes_uri == o.envelopes_uri &&
           failed == o.failed &&
           mailing_list_id == o.mailing_list_id &&
           mailing_list_name == o.mailing_list_name &&
           owner_user_id == o.owner_user_id &&
           queued == o.queued &&
+          resends_remaining == o.resends_remaining &&
           sender_user_id == o.sender_user_id &&
           sent == o.sent &&
           submitted_date == o.submitted_date
@@ -205,7 +246,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [batch_id, batch_name, batch_size, bulk_errors, envelope_id_or_template_id, envelopes_uri, failed, mailing_list_id, mailing_list_name, owner_user_id, queued, sender_user_id, sent, submitted_date].hash
+      [action, action_status, batch_id, batch_name, batch_size, bulk_errors, envelope_id_or_template_id, envelopes_info, envelopes_uri, failed, mailing_list_id, mailing_list_name, owner_user_id, queued, resends_remaining, sender_user_id, sent, submitted_date].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/bulk_send_batch_summaries.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # A list of bulk send batch summaries. 
   class BulkSendBatchSummaries
     # 
     attr_accessor :batch_size_limit
@@ -19,6 +20,12 @@ module DocuSign_eSign
     # 
     attr_accessor :bulk_batch_summaries
 
+    # 
+    attr_accessor :bulk_process_queue_limit
+
+    # 
+    attr_accessor :bulk_process_total_queued
+
     # The last position in the result set. 
     attr_accessor :end_position
 
@@ -48,6 +55,8 @@ module DocuSign_eSign
       {
         :'batch_size_limit' => :'batchSizeLimit',
         :'bulk_batch_summaries' => :'bulkBatchSummaries',
+        :'bulk_process_queue_limit' => :'bulkProcessQueueLimit',
+        :'bulk_process_total_queued' => :'bulkProcessTotalQueued',
         :'end_position' => :'endPosition',
         :'next_uri' => :'nextUri',
         :'previous_uri' => :'previousUri',
@@ -64,6 +73,8 @@ module DocuSign_eSign
       {
         :'batch_size_limit' => :'String',
         :'bulk_batch_summaries' => :'Array<BulkSendBatchSummary>',
+        :'bulk_process_queue_limit' => :'String',
+        :'bulk_process_total_queued' => :'String',
         :'end_position' => :'String',
         :'next_uri' => :'String',
         :'previous_uri' => :'String',
@@ -93,6 +104,14 @@ module DocuSign_eSign
         end
       end
 
+      if attributes.has_key?(:'bulkProcessQueueLimit')
+        self.bulk_process_queue_limit = attributes[:'bulkProcessQueueLimit']
+      end
+
+      if attributes.has_key?(:'bulkProcessTotalQueued')
+        self.bulk_process_total_queued = attributes[:'bulkProcessTotalQueued']
+      end
+
       if attributes.has_key?(:'endPosition')
         self.end_position = attributes[:'endPosition']
       end
@@ -146,6 +165,8 @@ module DocuSign_eSign
       self.class == o.class &&
           batch_size_limit == o.batch_size_limit &&
           bulk_batch_summaries == o.bulk_batch_summaries &&
+          bulk_process_queue_limit == o.bulk_process_queue_limit &&
+          bulk_process_total_queued == o.bulk_process_total_queued &&
           end_position == o.end_position &&
           next_uri == o.next_uri &&
           previous_uri == o.previous_uri &&
@@ -165,7 +186,7 @@ module DocuSign_eSign
     # 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
+      [batch_size_limit, bulk_batch_summaries, bulk_process_queue_limit, bulk_process_total_queued, 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

data/lib/docusign_esign/models/bulk_send_batch_summary.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Summary status of a single batch.
   class BulkSendBatchSummary
     # 
     attr_accessor :batch_id