docusign_click 1.2.2 → 1.3.0

data/lib/docusign_click/client/api_client.rb

@@ -1,7 +1,7 @@
 =begin
 #DocuSign Click API
 
-#DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
+#Elastic signing (also known as DocuSign Click)  lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations.
 
 OpenAPI spec version: v1
 Contact: devcenter@docusign.com
@@ -35,7 +35,7 @@ module DocuSign_Click
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "Swagger-Codegen/1.2.2/ruby"
+      @user_agent = "Swagger-Codegen/1.3.0/ruby"
       @default_headers = {
         'Content-Type' => "application/json",
         'User-Agent' => @user_agent

data/lib/docusign_click/client/api_error.rb

@@ -1,7 +1,7 @@
 =begin
 #DocuSign Click API
 
-#DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
+#Elastic signing (also known as DocuSign Click)  lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations.
 
 OpenAPI spec version: v1
 Contact: devcenter@docusign.com

data/lib/docusign_click/configuration.rb

@@ -1,7 +1,7 @@
 =begin
 #DocuSign Click API
 
-#DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
+#Elastic signing (also known as DocuSign Click)  lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations.
 
 OpenAPI spec version: v1
 Contact: devcenter@docusign.com

data/lib/docusign_click/models/bulk_clickwrap_request.rb

@@ -0,0 +1,205 @@
+=begin
+#DocuSign Click API
+
+#Elastic signing (also known as DocuSign Click)  lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations.
+
+OpenAPI spec version: v1
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+module DocuSign_Click
+  # Data used to start a bulk agreements export.
+  class BulkClickwrapRequest
+    # The earliest date to return agreements from.
+    attr_accessor :from_date
+
+    # User agreement status. One of:  - `agreed` - `declined`
+    attr_accessor :status
+
+    # The latest date to return agreements from.
+    attr_accessor :to_date
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'from_date' => :'fromDate',
+        :'status' => :'status',
+        :'to_date' => :'toDate'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'from_date' => :'Object',
+        :'status' => :'String',
+        :'to_date' => :'Object'
+      }
+    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?(:'fromDate')
+        self.from_date = attributes[:'fromDate']
+      end
+
+      if attributes.has_key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.has_key?(:'toDate')
+        self.to_date = attributes[:'toDate']
+      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 &&
+          from_date == o.from_date &&
+          status == o.status &&
+          to_date == o.to_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
+      [from_date, status, to_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_Click.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_click/models/clickwrap_agreements_response.rb

@@ -1,7 +1,7 @@
 =begin
 #DocuSign Click API
 
-#DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
+#Elastic signing (also known as DocuSign Click)  lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations.
 
 OpenAPI spec version: v1
 Contact: devcenter@docusign.com
@@ -13,19 +13,19 @@ require 'date'
 
 module DocuSign_Click
   class ClickwrapAgreementsResponse
-    # 
+    # User agreements from this datetime.
     attr_accessor :begin_created_on
 
-    # 
+    # Number of pages remaining in the response.
     attr_accessor :minimum_pages_remaining
 
-    # 
+    # The number of the current page.
     attr_accessor :page
 
-    # 
+    # The number of items per page.
     attr_accessor :page_size
 
-    # 
+    # An array of user agreements.
     attr_accessor :user_agreements
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_click/models/clickwrap_delete_response.rb

@@ -1,7 +1,7 @@
 =begin
 #DocuSign Click API
 
-#DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
+#Elastic signing (also known as DocuSign Click)  lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations.
 
 OpenAPI spec version: v1
 Contact: devcenter@docusign.com
@@ -12,20 +12,21 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_Click
+  # The result of a clickwrap deletion request.
   class ClickwrapDeleteResponse
-    # 
+    # The ID of the clickwrap.
     attr_accessor :clickwrap_id
 
-    # 
+    # The name of the clickwrap.
     attr_accessor :clickwrap_name
 
-    # 
+    # A message describing the result of deletion request. One of:  - `alreadyDeleted`: Clickwrap is already deleted. - `deletionSuccess`: Successfully deleted the clickwrap. - `deletionFailure`: Failed to delete the clickwrap. - `cannotDelete`: Active clickwrap version cannot be deleted.
     attr_accessor :deletion_message
 
-    # 
+    # **True** if the clickwrap was deleted successfully. **False** otherwise.
     attr_accessor :deletion_success
 
-    # 
+    # Clickwrap status. Possible values:  - `active` - `inactive` - `deleted`
     attr_accessor :status
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_click/models/clickwrap_request.rb

@@ -1,7 +1,7 @@
 =begin
 #DocuSign Click API
 
-#DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
+#Elastic signing (also known as DocuSign Click)  lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations.
 
 OpenAPI spec version: v1
 Contact: devcenter@docusign.com
@@ -12,45 +12,48 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_Click
+  # Request body for working with clickwrap.
   class ClickwrapRequest
-    # 
+    # The name of the clickwrap. This field is required.
     attr_accessor :clickwrap_name
 
-    # 
+    # An array of data fields available to be inserted into the documents.
     attr_accessor :data_fields
 
+    # Display settings for the clickwrap. This object is required.
     attr_accessor :display_settings
 
-    # 
+    # An array of documents. This object is required.
     attr_accessor :documents
 
-    # 
+    # Specifies whether `scheduledReacceptance` and `scheduledDate` should be cleared. May be one of:  - `\"scheduledReacceptance\"` - `\"scheduledDate\"` - `\"scheduledReacceptance,scheduledDate\"` 
     attr_accessor :fields_to_null
 
-    # 
+    # Not used.
     attr_accessor :is_major_version
 
-    # 
+    # When **true,** indicates that the clickwrap is shared with one or more users in the account.
     attr_accessor :is_shared
 
-    # 
+    # Not used.
     attr_accessor :name
 
-    # 
+    # When **true,** requires signers who have previously agreed to this clickwrap to sign again. The version number is incremented.
     attr_accessor :require_reacceptance
 
-    # 
+    # The time and date when this clickwrap is activated.
     attr_accessor :scheduled_date
 
+    # Specifies the interval between reacceptances in days, weeks, months, or years.
     attr_accessor :scheduled_reacceptance
 
-    # 
+    # Clickwrap status. This property is read-only. Possible values:  - `active` - `inactive` - `deleted`
     attr_accessor :status
 
-    # 
+    # Not used. To update the user ID of a clickwrap, use the [updateClickwrap](/docs/click-api/reference/accounts/clickwraps/updateclickwrap/) endpoint.
     attr_accessor :transfer_from_user_id
 
-    # 
+    # Not used. To update the user ID of a clickwrap, use the [updateClickwrap](/docs/click-api/reference/accounts/clickwraps/updateclickwrap/) endpoint.
     attr_accessor :transfer_to_user_id
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_click/models/clickwrap_scheduled_reacceptance.rb

@@ -1,7 +1,7 @@
 =begin
 #DocuSign Click API
 
-#DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
+#Elastic signing (also known as DocuSign Click)  lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations.
 
 OpenAPI spec version: v1
 Contact: devcenter@docusign.com
@@ -13,13 +13,13 @@ require 'date'
 
 module DocuSign_Click
   class ClickwrapScheduledReacceptance
-    # 
+    # The time between recurrences specified in `recurrenceIntervalType` units.  The minimum and maximum values depend on `recurrenceIntervalType`:  - `days`: 1 - 365 - `weeks`: 1 - 52 - `months`: 1 - 12 - `years`: 1
     attr_accessor :recurrence_interval
 
-    # 
+    # The units of the `recurrenceInterval`. Must be one of:  - `days` - `weeks` - `month` - `years` 
     attr_accessor :recurrence_interval_type
 
-    # 
+    # The date when the recurrence interval starts.
     attr_accessor :start_date_time
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_click/models/clickwrap_transfer_request.rb

@@ -1,7 +1,7 @@
 =begin
 #DocuSign Click API
 
-#DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
+#Elastic signing (also known as DocuSign Click)  lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations.
 
 OpenAPI spec version: v1
 Contact: devcenter@docusign.com
@@ -12,11 +12,12 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_Click
+  # Data used to transfer a clickwrap from one user to another.
   class ClickwrapTransferRequest
-    # 
+    # ID of the user to transfer from. This property is required.
     attr_accessor :transfer_from_user_id
 
-    # 
+    # ID of the user to transfer to. This property is required.
     attr_accessor :transfer_to_user_id
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_click/models/clickwrap_version.rb

@@ -1,7 +1,7 @@
 =begin
 #DocuSign Click API
 
-#DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
+#Elastic signing (also known as DocuSign Click)  lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations.
 
 OpenAPI spec version: v1
 Contact: devcenter@docusign.com
@@ -13,39 +13,40 @@ require 'date'
 
 module DocuSign_Click
   class ClickwrapVersion
-    # 
+    # The unique version ID, a GUID, of this clickwrap version.
     attr_accessor :clickwrap_version_id
 
-    # 
+    # The time that the clickwrap was created.
     attr_accessor :created_time
 
-    # 
+    # The list of all the data fields available for the clickwrap (custom fields and standard fields).
     attr_accessor :data_fields
 
-    # 
+    # The time that the clickwrap was last modified.
     attr_accessor :last_modified
 
-    # 
+    # The user ID of the last user who modified this clickwrap.
     attr_accessor :last_modified_by
 
-    # 
+    # The user ID of the owner of this clickwrap.
     attr_accessor :owner_user_id
 
-    # 
+    # When **true,** requires signers who have previously agreed to this clickwrap to sign again. The version number is incremented.
     attr_accessor :require_reacceptance
 
-    # 
+    # The time and date when this clickwrap is activated.
     attr_accessor :scheduled_date
 
+    # Specifies the interval between reacceptances in days, weeks, months, or years.
     attr_accessor :scheduled_reacceptance
 
-    # 
+    # Clickwrap status. Possible values:  - `active` - `inactive` - `deleted`
     attr_accessor :status
 
-    # 
+    # The ID of the version.
     attr_accessor :version_id
 
-    # 
+    # Version of the clickwrap.
     attr_accessor :version_number
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_click/models/clickwrap_version_delete_response.rb

@@ -1,7 +1,7 @@
 =begin
 #DocuSign Click API
 
-#DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
+#Elastic signing (also known as DocuSign Click)  lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations.
 
 OpenAPI spec version: v1
 Contact: devcenter@docusign.com
@@ -13,45 +13,46 @@ require 'date'
 
 module DocuSign_Click
   class ClickwrapVersionDeleteResponse
-    # 
+    # The unique version ID, a GUID, of this clickwrap version.
     attr_accessor :clickwrap_version_id
 
-    # 
+    # The time that the clickwrap was created.
     attr_accessor :created_time
 
-    # 
+    # The list of all the data fields available for the clickwrap (custom fields and standard fields).
     attr_accessor :data_fields
 
-    # 
+    # A message describing the result of deletion request. One of:  - `alreadyDeleted`: Clickwrap is already deleted. - `deletionSuccess`: Successfully deleted the clickwrap. - `deletionFailure`: Failed to delete the clickwrap. - `cannotDelete`: Active clickwrap version cannot be deleted.
     attr_accessor :deletion_message
 
-    # 
+    # **True** if the clickwrap was deleted successfully. **False** otherwise.
     attr_accessor :deletion_success
 
-    # 
+    # The time that the clickwrap was last modified.
     attr_accessor :last_modified
 
-    # 
+    # The user ID of the last user who modified this clickwrap.
     attr_accessor :last_modified_by
 
-    # 
+    # The user ID of the owner of this clickwrap.
     attr_accessor :owner_user_id
 
-    # 
+    # When **true,** requires signers who have previously agreed to this clickwrap to sign again. The version number is incremented.
     attr_accessor :require_reacceptance
 
-    # 
+    # The time and date when this clickwrap is activated.
     attr_accessor :scheduled_date
 
+    # Specifies the interval between reacceptances in days, weeks, months, or years.
     attr_accessor :scheduled_reacceptance
 
-    # 
+    # Clickwrap status. Possible values:  - `active` - `inactive` - `deleted`
     attr_accessor :status
 
-    # 
+    # The ID of the version.
     attr_accessor :version_id
 
-    # 
+    # Version of the clickwrap.
     attr_accessor :version_number
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_click/models/clickwrap_version_response.rb

@@ -1,7 +1,7 @@
 =begin
 #DocuSign Click API
 
-#DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
+#Elastic signing (also known as DocuSign Click)  lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations.
 
 OpenAPI spec version: v1
 Contact: devcenter@docusign.com
@@ -13,53 +13,55 @@ require 'date'
 
 module DocuSign_Click
   class ClickwrapVersionResponse
-    # 
+    # The external account number (int) or account ID GUID.
     attr_accessor :account_id
 
-    # 
+    # The ID of the clickwrap.
     attr_accessor :clickwrap_id
 
-    # 
+    # The name of the clickwrap.
     attr_accessor :clickwrap_name
 
-    # 
+    # The unique version ID, a GUID, of this clickwrap version.
     attr_accessor :clickwrap_version_id
 
-    # 
+    # The time that the clickwrap was created.
     attr_accessor :created_time
 
-    # 
+    # The list of all the data fields available for the clickwrap (custom fields and standard fields).
     attr_accessor :data_fields
 
+    # Display settings for a clickwrap.
     attr_accessor :display_settings
 
-    # 
+    # An array of documents.
     attr_accessor :documents
 
-    # 
+    # The time that the clickwrap was last modified.
     attr_accessor :last_modified
 
-    # 
+    # The user ID of the last user who modified this clickwrap.
     attr_accessor :last_modified_by
 
-    # 
+    # The user ID of the owner of this clickwrap.
     attr_accessor :owner_user_id
 
-    # 
+    # When **true,** requires signers who have previously agreed to this clickwrap to sign again. The version number is incremented.
     attr_accessor :require_reacceptance
 
-    # 
+    # The time and date when this clickwrap is activated.
     attr_accessor :scheduled_date
 
+    # Specifies the interval between reacceptances in days, weeks, months, or years.
     attr_accessor :scheduled_reacceptance
 
-    # 
+    # Clickwrap status. Possible values:  - `active` - `inactive` - `deleted`
     attr_accessor :status
 
-    # 
+    # The ID of the version.
     attr_accessor :version_id
 
-    # 
+    # Version of the clickwrap.
     attr_accessor :version_number
 
     # Attribute mapping from ruby-style variable name to JSON key.