docusign_click 1.0.0 → 1.1.0.rc1

data/lib/docusign_click/models/document_data.rb

@@ -0,0 +1,225 @@
+=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.
+
+OpenAPI spec version: v1
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+module DocuSign_Click
+  # The object of data to be merged with the clickwrap document. A merged document must be created from Click's web editor and supports fullName, email, company, title and date.
+  class DocumentData
+    # The full name of the signer. This field is created in the UI editor for a Clickwrap document. Only required if present in the document.
+    attr_accessor :full_name
+
+    # The email address of the signer. This field is created in the UI editor for a Clickwrap document. Only required if present in the document.
+    attr_accessor :email
+
+    # The company name of the signer. This field is created in the UI editor for a Clickwrap document. Only required if present in the document.
+    attr_accessor :company
+
+    # The job title of the signer. This field is created in the UI editor for a Clickwrap document. Only required if present in the document.
+    attr_accessor :job_title
+
+    # A custom date for the contract. This field is created in the UI editor for a Clickwrap document. Only required if present in the document.
+    attr_accessor :date
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'full_name' => :'fullName',
+        :'email' => :'email',
+        :'company' => :'company',
+        :'job_title' => :'jobTitle',
+        :'date' => :'date'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'full_name' => :'String',
+        :'email' => :'String',
+        :'company' => :'String',
+        :'job_title' => :'String',
+        :'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?(:'fullName')
+        self.full_name = attributes[:'fullName']
+      end
+
+      if attributes.has_key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.has_key?(:'company')
+        self.company = attributes[:'company']
+      end
+
+      if attributes.has_key?(:'jobTitle')
+        self.job_title = attributes[:'jobTitle']
+      end
+
+      if attributes.has_key?(:'date')
+        self.date = attributes[:'date']
+      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 &&
+          full_name == o.full_name &&
+          email == o.email &&
+          company == o.company &&
+          job_title == o.job_title &&
+          date == o.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
+      [full_name, email, company, job_title, 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/user_agreement_request.rb

@@ -16,8 +16,7 @@ module DocuSign_Click
     # 
     attr_accessor :client_user_id
 
-    # 
-    attr_accessor :host_origin
+    attr_accessor :document_data
 
     # 
     attr_accessor :metadata
@@ -26,7 +25,7 @@ module DocuSign_Click
     def self.attribute_map
       {
         :'client_user_id' => :'clientUserId',
-        :'host_origin' => :'hostOrigin',
+        :'document_data' => :'documentData',
         :'metadata' => :'metadata'
       }
     end
@@ -35,7 +34,7 @@ module DocuSign_Click
     def self.swagger_types
       {
         :'client_user_id' => :'String',
-        :'host_origin' => :'String',
+        :'document_data' => :'DocumentData',
         :'metadata' => :'String'
       }
     end
@@ -52,8 +51,8 @@ module DocuSign_Click
         self.client_user_id = attributes[:'clientUserId']
       end
 
-      if attributes.has_key?(:'hostOrigin')
-        self.host_origin = attributes[:'hostOrigin']
+      if attributes.has_key?(:'documentData')
+        self.document_data = attributes[:'documentData']
       end
 
       if attributes.has_key?(:'metadata')
@@ -80,7 +79,7 @@ module DocuSign_Click
       return true if self.equal?(o)
       self.class == o.class &&
           client_user_id == o.client_user_id &&
-          host_origin == o.host_origin &&
+          document_data == o.document_data &&
           metadata == o.metadata
     end
 
@@ -93,7 +92,7 @@ module DocuSign_Click
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [client_user_id, host_origin, metadata].hash
+      [client_user_id, document_data, metadata].hash
     end
 
     # Builds the object from hash

data/lib/docusign_click/models/user_agreement_response.rb

@@ -40,6 +40,8 @@ module DocuSign_Click
     # 
     attr_accessor :declined_on
 
+    attr_accessor :document_data
+
     # 
     attr_accessor :documents
 
@@ -72,6 +74,7 @@ module DocuSign_Click
         :'consumer_disclosure_html' => :'consumerDisclosureHtml',
         :'created_on' => :'createdOn',
         :'declined_on' => :'declinedOn',
+        :'document_data' => :'documentData',
         :'documents' => :'documents',
         :'metadata' => :'metadata',
         :'settings' => :'settings',
@@ -94,6 +97,7 @@ module DocuSign_Click
         :'consumer_disclosure_html' => :'String',
         :'created_on' => :'Object',
         :'declined_on' => :'Object',
+        :'document_data' => :'DocumentData',
         :'documents' => :'Array<Document>',
         :'metadata' => :'String',
         :'settings' => :'DisplaySettings',
@@ -148,6 +152,10 @@ module DocuSign_Click
         self.declined_on = attributes[:'declinedOn']
       end
 
+      if attributes.has_key?(:'documentData')
+        self.document_data = attributes[:'documentData']
+      end
+
       if attributes.has_key?(:'documents')
         if (value = attributes[:'documents']).is_a?(Array)
           self.documents = value
@@ -206,6 +214,7 @@ module DocuSign_Click
           consumer_disclosure_html == o.consumer_disclosure_html &&
           created_on == o.created_on &&
           declined_on == o.declined_on &&
+          document_data == o.document_data &&
           documents == o.documents &&
           metadata == o.metadata &&
           settings == o.settings &&
@@ -224,7 +233,7 @@ module DocuSign_Click
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [account_id, agreed_on, agreement_id, agreement_url, clickwrap_id, client_user_id, consumer_disclosure_html, created_on, declined_on, documents, metadata, settings, status, version, version_id, version_number].hash
+      [account_id, agreed_on, agreement_id, agreement_url, clickwrap_id, client_user_id, consumer_disclosure_html, created_on, declined_on, document_data, documents, metadata, settings, status, version, version_id, version_number].hash
     end
 
     # Builds the object from hash

data/lib/docusign_click/version.rb

@@ -10,5 +10,5 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 =end
 
 module DocuSign_Click
-  VERSION = '1.0.0'
+  VERSION = '1.1.0.rc1'
 end

data/lib/docusign_click.rb

@@ -34,6 +34,7 @@ require 'docusign_click/models/clickwrap_versions_response'
 require 'docusign_click/models/clickwraps_delete_response'
 require 'docusign_click/models/display_settings'
 require 'docusign_click/models/document'
+require 'docusign_click/models/document_data'
 require 'docusign_click/models/error_details'
 require 'docusign_click/models/service_information'
 require 'docusign_click/models/service_version'

data/runLinter.sh

@@ -0,0 +1 @@
+./vendor/bundle/ruby/2.6.0/bin/rubocop -a

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docusign_click
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0.rc1
 platform: ruby
 authors:
 - DocuSign
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-12 00:00:00.000000000 Z
+date: 2021-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -34,22 +34,22 @@ dependencies:
   name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.7.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.7.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.0
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -74,42 +74,82 @@ dependencies:
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.1.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.1.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -219,7 +259,7 @@ dependencies:
         version: '0.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.12
+        version: 0.2.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -229,7 +269,7 @@ dependencies:
         version: '0.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.12
+        version: 0.2.11
 description: The DocuSign package makes integrating DocuSign into your apps and websites
   a super fast and painless process. The library is open sourced on GitHub, look for
   the docusign-click-ruby-client repository.
@@ -241,22 +281,13 @@ extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
-- docusign_click-1.0.0.beta.gem
-- docusign_click-1.0.0.beta2.gem
-- docusign_click-1.0.0.pre.alpha.gem
-- docusign_click-1.0.0.rc1.gem
 - docusign_click.gemspec
 - git_push.sh
-- lib/.DS_Store
 - lib/docusign_click.rb
-- lib/docusign_click/.DS_Store
-- lib/docusign_click/api/.DS_Store
 - lib/docusign_click/api/accounts_api.rb
-- lib/docusign_click/client/.DS_Store
 - lib/docusign_click/client/api_client.rb
 - lib/docusign_click/client/api_error.rb
 - lib/docusign_click/client/auth/oauth.rb
@@ -279,6 +310,7 @@ files:
 - lib/docusign_click/models/document.rb
 - lib/docusign_click/models/document_conversion_request.rb
 - lib/docusign_click/models/document_conversion_response.rb
+- lib/docusign_click/models/document_data.rb
 - lib/docusign_click/models/error_details.rb
 - lib/docusign_click/models/html_result.rb
 - lib/docusign_click/models/recipient_copy_request.rb
@@ -288,10 +320,9 @@ files:
 - lib/docusign_click/models/user_agreement_request.rb
 - lib/docusign_click/models/user_agreement_response.rb
 - lib/docusign_click/version.rb
+- runLinter.sh
 - tests/Gemfile
-- tests/Gemfile.lock
 - tests/docs/Test.pdf
-- tests/docs/private.pem
 - tests/spec/unit_tests_using_jwt_spec.rb
 homepage: https://github.com/docusign/docusign-click-ruby-client
 licenses:
@@ -308,11 +339,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: DocuSign Click API Ruby Gem

data/Gemfile.lock

@@ -1,69 +0,0 @@
-PATH
-  remote: .
-  specs:
-    docusign_click (1.0.0.pre.alpha)
-      json (~> 2.1, >= 2.1.0)
-      jwt (~> 2.2, >= 2.2.1)
-      typhoeus (~> 1.0, >= 1.0.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ZenTest (4.12.0)
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    autotest (4.4.6)
-      ZenTest (>= 4.4.1)
-    autotest-fsevent (0.2.17)
-      sys-uname
-    autotest-growl (0.2.16)
-    autotest-rails-pure (4.1.2)
-    crack (0.4.4)
-    diff-lcs (1.4.4)
-    ethon (0.12.0)
-      ffi (>= 1.3.0)
-    ffi (1.13.1)
-    hashdiff (1.0.1)
-    json (2.3.1)
-    jwt (2.2.2)
-    public_suffix (4.0.6)
-    rake (12.3.3)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.3)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.4)
-    sys-uname (1.2.1)
-      ffi (>= 1.0.0)
-    typhoeus (1.4.0)
-      ethon (>= 0.9.0)
-    vcr (3.0.3)
-    webmock (1.24.6)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
-      hashdiff
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  autotest (~> 4.4, >= 4.4.6)
-  autotest-fsevent (~> 0.2, >= 0.2.12)
-  autotest-growl (~> 0.2, >= 0.2.16)
-  autotest-rails-pure (~> 4.1, >= 4.1.2)
-  docusign_click!
-  rake (~> 12.3.3)
-  rspec (~> 3.6, >= 3.6.0)
-  vcr (~> 3.0, >= 3.0.1)
-  webmock (~> 1.24, >= 1.24.3)
-
-BUNDLED WITH
-   1.17.2