Merge pull request #7 from docusign/1.2.2-v1-22.3.01.00

Version 1.2.2 release
docusign · Oct 29, 2022 · f6328ba · f6328ba
2 parents ec0dcd9 + e989c5b
commit f6328ba
Show file tree

Hide file tree

Showing 16 changed files with 443 additions and 25 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,7 +1,12 @@
 # DocuSign Click Ruby Client Changelog
 See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
 
-## [1.1.0] - Click API v1-21.4.01 - 2021-12-08
+## [v1.2.2] - Click API v1-22.3.01.00 - 2022-10-28
+### Changed
+- Added support for version v1-22.3.01.00 of the DocuSign Click API.
+- Updated the SDK release version.
+
+## [1.1.0] - Click API v1-21.4.01 - 2021-12-09
 ### Changed
 - Added support for version v1-21.4.01 of the DocuSign Click API.
 - Updated the SDK release version.

diff --git a/docusign_click.gemspec b/docusign_click.gemspec
@@ -18,30 +18,31 @@ Gem::Specification.new do |s|
   s.name        = "docusign_click"
   s.version     = DocuSign_Click::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Swagger-Codegen"]
+  s.authors     = ["DocuSign"]
   s.email       = ["devcenter@docusign.com"]
-  s.homepage    = "https://github.com/swagger-api/swagger-codegen"
+  s.homepage    = "https://github.com/docusign/docusign-click-ruby-client"
   s.summary     = "DocuSign Click API Ruby Gem"
   s.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."
-  s.license     = "Unlicense"
+  s.license     = "MIT"
   s.required_ruby_version = ">= 1.9"
 
   s.add_runtime_dependency 'jwt', '~> 2.2', '>= 2.2.1'
+  s.add_runtime_dependency 'addressable', '~> 2.7', '>= 2.7.0'
   s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
   s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
-  s.add_runtime_dependency 'addressable', '~> 2.7', '>= 2.7.0'
 
-  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'rspec-mocks', '~> 3.8', '>= 3.8.0'
+  s.add_development_dependency 'rspec-expectations', '~> 3.8', '>= 3.8.0'
+  s.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
   s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
   s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
   s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
   s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
   s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
-  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
-  s.add_development_dependency 'rubocop', '~> 1.18', '>= 1.18.4'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.11'
 
-  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.files         = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
   s.test_files    = `find spec/*`.split("\n")
   s.executables   = []
   s.require_paths = ["lib"]
-end
+end
diff --git a/lib/docusign_click.rb b/lib/docusign_click.rb
@@ -32,6 +32,7 @@
 require 'docusign_click/models/clickwrap_versions_paged_response'
 require 'docusign_click/models/clickwrap_versions_response'
 require 'docusign_click/models/clickwraps_delete_response'
+require 'docusign_click/models/data_field'
 require 'docusign_click/models/display_settings'
 require 'docusign_click/models/document'
 require 'docusign_click/models/error_details'

diff --git a/lib/docusign_click/api/accounts_api.rb b/lib/docusign_click/api/accounts_api.rb
@@ -565,6 +565,67 @@ def get_agreement_with_http_info(account_id, agreement_id, clickwrap_id)
       return data, status_code, headers
     end
 
+    # Downloads a document at an order within the agreement.
+    # 
+    # @param account_id 
+    # @param clickwrap_id 
+    # @param order_or_disclosure 
+    # @param version_id 
+    # @return [Document]
+    def get_agreement_document(account_id, clickwrap_id, order_or_disclosure, version_id)
+      data, _status_code, _headers = get_agreement_document_with_http_info(account_id, clickwrap_id, order_or_disclosure, version_id)
+      return data
+    end
+
+    # Downloads a document at an order within the agreement.
+    # 
+    # @param account_id 
+    # @param clickwrap_id 
+    # @param order_or_disclosure 
+    # @param version_id 
+    # @return [Array<(Document, Fixnum, Hash)>] Document data, response status code and response headers
+    def get_agreement_document_with_http_info(account_id, clickwrap_id, order_or_disclosure, version_id)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AccountsApi.get_agreement_document ..."
+      end
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_agreement_document" if account_id.nil?
+      # verify the required parameter 'clickwrap_id' is set
+      fail ArgumentError, "Missing the required parameter 'clickwrap_id' when calling AccountsApi.get_agreement_document" if clickwrap_id.nil?
+      # verify the required parameter 'order_or_disclosure' is set
+      fail ArgumentError, "Missing the required parameter 'order_or_disclosure' when calling AccountsApi.get_agreement_document" if order_or_disclosure.nil?
+      # verify the required parameter 'version_id' is set
+      fail ArgumentError, "Missing the required parameter 'version_id' when calling AccountsApi.get_agreement_document" if version_id.nil?
+      # resource path
+      local_var_path = "/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionId}/documents/{orderOrDisclosure}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'clickwrapId' + '}', clickwrap_id.to_s).sub('{' + 'orderOrDisclosure' + '}', order_or_disclosure.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Document')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountsApi#get_agreement_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Downloads the agreement PDF and optionally certificate of completion.
     # 
     # @param account_id 

diff --git a/lib/docusign_click/client/api_client.rb b/lib/docusign_click/client/api_client.rb
@@ -35,7 +35,7 @@ class ApiClient
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "Swagger-Codegen/1.1.0.rc1/ruby"
+      @user_agent = "Swagger-Codegen/1.2.2/ruby"
       @default_headers = {
         'Content-Type' => "application/json",
         'User-Agent' => @user_agent

diff --git a/lib/docusign_click/models/clickwrap_request.rb b/lib/docusign_click/models/clickwrap_request.rb
@@ -16,6 +16,9 @@ class ClickwrapRequest
     # 
     attr_accessor :clickwrap_name
 
+    # 
+    attr_accessor :data_fields
+
     attr_accessor :display_settings
 
     # 
@@ -54,6 +57,7 @@ class ClickwrapRequest
     def self.attribute_map
       {
         :'clickwrap_name' => :'clickwrapName',
+        :'data_fields' => :'dataFields',
         :'display_settings' => :'displaySettings',
         :'documents' => :'documents',
         :'fields_to_null' => :'fieldsToNull',
@@ -73,6 +77,7 @@ def self.attribute_map
     def self.swagger_types
       {
         :'clickwrap_name' => :'String',
+        :'data_fields' => :'Array<DataField>',
         :'display_settings' => :'DisplaySettings',
         :'documents' => :'Array<Document>',
         :'fields_to_null' => :'String',
@@ -82,7 +87,7 @@ def self.swagger_types
         :'require_reacceptance' => :'BOOLEAN',
         :'scheduled_date' => :'Object',
         :'scheduled_reacceptance' => :'ClickwrapScheduledReacceptance',
-        :'status' => :'Object',
+        :'status' => :'String',
         :'transfer_from_user_id' => :'String',
         :'transfer_to_user_id' => :'String'
       }
@@ -100,6 +105,12 @@ def initialize(attributes = {})
         self.clickwrap_name = attributes[:'clickwrapName']
       end
 
+      if attributes.has_key?(:'dataFields')
+        if (value = attributes[:'dataFields']).is_a?(Array)
+          self.data_fields = value
+        end
+      end
+
       if attributes.has_key?(:'displaySettings')
         self.display_settings = attributes[:'displaySettings']
       end
@@ -170,6 +181,7 @@ def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
           clickwrap_name == o.clickwrap_name &&
+          data_fields == o.data_fields &&
           display_settings == o.display_settings &&
           documents == o.documents &&
           fields_to_null == o.fields_to_null &&
@@ -193,7 +205,7 @@ def eql?(o)
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [clickwrap_name, display_settings, documents, fields_to_null, is_major_version, is_shared, name, require_reacceptance, scheduled_date, scheduled_reacceptance, status, transfer_from_user_id, transfer_to_user_id].hash
+      [clickwrap_name, data_fields, display_settings, documents, fields_to_null, is_major_version, is_shared, name, require_reacceptance, scheduled_date, scheduled_reacceptance, status, transfer_from_user_id, transfer_to_user_id].hash
     end
 
     # Builds the object from hash

diff --git a/lib/docusign_click/models/clickwrap_version.rb b/lib/docusign_click/models/clickwrap_version.rb
@@ -19,6 +19,9 @@ class ClickwrapVersion
     # 
     attr_accessor :created_time
 
+    # 
+    attr_accessor :data_fields
+
     # 
     attr_accessor :last_modified
 
@@ -50,6 +53,7 @@ def self.attribute_map
       {
         :'clickwrap_version_id' => :'clickwrapVersionId',
         :'created_time' => :'createdTime',
+        :'data_fields' => :'dataFields',
         :'last_modified' => :'lastModified',
         :'last_modified_by' => :'lastModifiedBy',
         :'owner_user_id' => :'ownerUserId',
@@ -67,6 +71,7 @@ def self.swagger_types
       {
         :'clickwrap_version_id' => :'String',
         :'created_time' => :'Object',
+        :'data_fields' => :'Array<DataField>',
         :'last_modified' => :'Object',
         :'last_modified_by' => :'String',
         :'owner_user_id' => :'String',
@@ -95,6 +100,12 @@ def initialize(attributes = {})
         self.created_time = attributes[:'createdTime']
       end
 
+      if attributes.has_key?(:'dataFields')
+        if (value = attributes[:'dataFields']).is_a?(Array)
+          self.data_fields = value
+        end
+      end
+
       if attributes.has_key?(:'lastModified')
         self.last_modified = attributes[:'lastModified']
       end
@@ -152,6 +163,7 @@ def ==(o)
       self.class == o.class &&
           clickwrap_version_id == o.clickwrap_version_id &&
           created_time == o.created_time &&
+          data_fields == o.data_fields &&
           last_modified == o.last_modified &&
           last_modified_by == o.last_modified_by &&
           owner_user_id == o.owner_user_id &&
@@ -172,7 +184,7 @@ def eql?(o)
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [clickwrap_version_id, created_time, last_modified, last_modified_by, owner_user_id, require_reacceptance, scheduled_date, scheduled_reacceptance, status, version_id, version_number].hash
+      [clickwrap_version_id, created_time, data_fields, last_modified, last_modified_by, owner_user_id, require_reacceptance, scheduled_date, scheduled_reacceptance, status, version_id, version_number].hash
     end
 
     # Builds the object from hash

diff --git a/lib/docusign_click/models/clickwrap_version_delete_response.rb b/lib/docusign_click/models/clickwrap_version_delete_response.rb
@@ -19,6 +19,9 @@ class ClickwrapVersionDeleteResponse
     # 
     attr_accessor :created_time
 
+    # 
+    attr_accessor :data_fields
+
     # 
     attr_accessor :deletion_message
 
@@ -56,6 +59,7 @@ def self.attribute_map
       {
         :'clickwrap_version_id' => :'clickwrapVersionId',
         :'created_time' => :'createdTime',
+        :'data_fields' => :'dataFields',
         :'deletion_message' => :'deletionMessage',
         :'deletion_success' => :'deletionSuccess',
         :'last_modified' => :'lastModified',
@@ -75,6 +79,7 @@ def self.swagger_types
       {
         :'clickwrap_version_id' => :'String',
         :'created_time' => :'Object',
+        :'data_fields' => :'Array<DataField>',
         :'deletion_message' => :'String',
         :'deletion_success' => :'BOOLEAN',
         :'last_modified' => :'Object',
@@ -105,6 +110,12 @@ def initialize(attributes = {})
         self.created_time = attributes[:'createdTime']
       end
 
+      if attributes.has_key?(:'dataFields')
+        if (value = attributes[:'dataFields']).is_a?(Array)
+          self.data_fields = value
+        end
+      end
+
       if attributes.has_key?(:'deletionMessage')
         self.deletion_message = attributes[:'deletionMessage']
       end
@@ -170,6 +181,7 @@ def ==(o)
       self.class == o.class &&
           clickwrap_version_id == o.clickwrap_version_id &&
           created_time == o.created_time &&
+          data_fields == o.data_fields &&
           deletion_message == o.deletion_message &&
           deletion_success == o.deletion_success &&
           last_modified == o.last_modified &&
@@ -192,7 +204,7 @@ def eql?(o)
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [clickwrap_version_id, created_time, deletion_message, deletion_success, last_modified, last_modified_by, owner_user_id, require_reacceptance, scheduled_date, scheduled_reacceptance, status, version_id, version_number].hash
+      [clickwrap_version_id, created_time, data_fields, deletion_message, deletion_success, last_modified, last_modified_by, owner_user_id, require_reacceptance, scheduled_date, scheduled_reacceptance, status, version_id, version_number].hash
     end
 
     # Builds the object from hash

diff --git a/lib/docusign_click/models/clickwrap_version_response.rb b/lib/docusign_click/models/clickwrap_version_response.rb
@@ -28,6 +28,9 @@ class ClickwrapVersionResponse
     # 
     attr_accessor :created_time
 
+    # 
+    attr_accessor :data_fields
+
     attr_accessor :display_settings
 
     # 
@@ -67,6 +70,7 @@ def self.attribute_map
         :'clickwrap_name' => :'clickwrapName',
         :'clickwrap_version_id' => :'clickwrapVersionId',
         :'created_time' => :'createdTime',
+        :'data_fields' => :'dataFields',
         :'display_settings' => :'displaySettings',
         :'documents' => :'documents',
         :'last_modified' => :'lastModified',
@@ -89,6 +93,7 @@ def self.swagger_types
         :'clickwrap_name' => :'String',
         :'clickwrap_version_id' => :'String',
         :'created_time' => :'Object',
+        :'data_fields' => :'Array<DataField>',
         :'display_settings' => :'DisplaySettings',
         :'documents' => :'Array<Document>',
         :'last_modified' => :'Object',
@@ -131,6 +136,12 @@ def initialize(attributes = {})
         self.created_time = attributes[:'createdTime']
       end
 
+      if attributes.has_key?(:'dataFields')
+        if (value = attributes[:'dataFields']).is_a?(Array)
+          self.data_fields = value
+        end
+      end
+
       if attributes.has_key?(:'displaySettings')
         self.display_settings = attributes[:'displaySettings']
       end
@@ -201,6 +212,7 @@ def ==(o)
           clickwrap_name == o.clickwrap_name &&
           clickwrap_version_id == o.clickwrap_version_id &&
           created_time == o.created_time &&
+          data_fields == o.data_fields &&
           display_settings == o.display_settings &&
           documents == o.documents &&
           last_modified == o.last_modified &&
@@ -223,7 +235,7 @@ def eql?(o)
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [account_id, clickwrap_id, clickwrap_name, clickwrap_version_id, created_time, display_settings, documents, last_modified, last_modified_by, owner_user_id, require_reacceptance, scheduled_date, scheduled_reacceptance, status, version_id, version_number].hash
+      [account_id, clickwrap_id, clickwrap_name, clickwrap_version_id, created_time, data_fields, display_settings, documents, last_modified, last_modified_by, owner_user_id, require_reacceptance, scheduled_date, scheduled_reacceptance, status, version_id, version_number].hash
     end
 
     # Builds the object from hash