docusign_esign 3.1.0.rc2 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df1c345205c78fd730fa640dbcb0eb88fbdf25ff
-  data.tar.gz: 5a3dd7712ae4a06beaaa5e84a6a891e758b2b058
+  metadata.gz: e87257bb4a84ae2922a605a704adc2a0060310d2
+  data.tar.gz: b2be51897d35bc214e9c645b75c3de8b0b9fab90
 SHA512:
-  metadata.gz: 740d9fb095e01832bc5761bfaf1036790dbd09327e9c6b98f6b490f79557aeb84983db57adff24291455a99d1e48a06962080fdaa901fc60df4ac41c64cc462f
-  data.tar.gz: 26112c3c60b6667ec7c44f66e6144af61902b1e39fdb4daa5559dc52cedac93ba0727a58624909e8a2e95146b0067e1d3d6805e608216fcab7c8a01c5ae5e9af
+  metadata.gz: 9ea59614b4536e25ce26fd47a3f5f8f1433fd3aee17e2ff51eb9bc068f63343b43f0154d75cde9d53bb007cc770f029ba1bd602794d23c132867e0f63dc45e40
+  data.tar.gz: 4cd6dbae184f3bb1022d5e96b87d98a56614f81cc0dc3e725801afb8a7e13a9248be0fb5520122ed7b7e1230b9e1b28c06705ff19609b5e430db58e6c9a554c8

data/CHANGELOG.md

@@ -3,6 +3,25 @@ All notable changes to this project will be documented in this file.
 
 See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
 
+## [v3.3.0] - eSignature API v2.1-20.1.02 - 2020-05-31
+### Changed
+- Added support for version v2.1-20.1.02 of the DocuSign eSignature API.
+- Updated the SDK release version.
+
+## [v3.2.1] - eSignature API v2.1-20.1.00 - 2020-04-15
+### Changed
+- Updated jwt to version 2.2.1.
+
+## [v3.2.0] - eSignature API v2.1-20.1.00 - 2020-03-30
+### Changed
+- Added support for version v2.1-20.1.00 of the DocuSign eSignature API.
+- Updated rake to version 12.3.3.
+- Updated the SDK release version.
+### Added
+- Added the new property `copy_recipient_data` to envelopes. When set to **true**, the information that recipients enter is retained when you clone an envelope. For example, if you resend an envelope that was declined or voided after one or more recipients entered data, that data is retained. Note that the account setting `enable_envelope_copy_with_data` must be set to **true**.
+- Added a new object, `RecipientIdentityInputOption`: Reserved for DocuSign.
+- Added a new parameter, `input_options`, to `AccountIdentityVerificationWorkflow`: Reserved for DocuSign.
+
 ## [v3.0.0] - eSignature API v2.1-19.2.02 - 2019-10-08
 ### BREAKING
 - The SDK now supports version 19.2.02 of the DocuSign eSignature v2.1 API.

data/Gemfile

@@ -3,5 +3,5 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'rake', '~> 12.0.0'
+  gem 'rake', '~> 12.3.3'
 end

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    docusign_esign (3.3.0.pre.rc)
+      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.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    ffi (1.12.2)
+    hashdiff (1.0.1)
+    json (2.3.0)
+    jwt (2.2.1)
+    public_suffix (4.0.5)
+    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.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      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.3)
+    safe_yaml (1.0.5)
+    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.11)
+  autotest-growl (~> 0.2, >= 0.2.16)
+  autotest-rails-pure (~> 4.1, >= 4.1.2)
+  docusign_esign!
+  rake (~> 12.3.3)
+  rspec (~> 3.4, >= 3.4.0)
+  rspec-expectations (~> 3.8, >= 3.8.0)
+  rspec-mocks (~> 3.8, >= 3.8.0)
+  vcr (~> 3.0, >= 3.0.1)
+  webmock (~> 1.24, >= 1.24.3)
+
+BUNDLED WITH
+   2.0.2

data/docusign_esign.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
   s.license     = "MIT"
   s.required_ruby_version = ">= 1.9"
 
-  s.add_runtime_dependency 'jwt', '~> 1.0', '>= 1.5.2'
+  s.add_runtime_dependency 'jwt', '~> 2.2', '>= 2.2.1'
   s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
   s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
 

data/lib/docusign_esign.rb

@@ -6,6 +6,7 @@
 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
 
@@ -23,6 +24,7 @@ require 'docusign_esign/models/access_code_format'
 require 'docusign_esign/models/account_address'
 require 'docusign_esign/models/account_billing_plan'
 require 'docusign_esign/models/account_billing_plan_response'
+require 'docusign_esign/models/account_identity_input_option'
 require 'docusign_esign/models/account_identity_verification_response'
 require 'docusign_esign/models/account_identity_verification_step'
 require 'docusign_esign/models/account_identity_verification_workflow'
@@ -129,12 +131,11 @@ require 'docusign_esign/models/comment_publish'
 require 'docusign_esign/models/comment_thread'
 require 'docusign_esign/models/comments_publish'
 require 'docusign_esign/models/company'
-require 'docusign_esign/models/complete_sign_hash_response'
-require 'docusign_esign/models/complete_sign_request'
 require 'docusign_esign/models/composite_template'
 require 'docusign_esign/models/connect_config_results'
 require 'docusign_esign/models/connect_custom_configuration'
 require 'docusign_esign/models/connect_debug_log'
+require 'docusign_esign/models/connect_event_data'
 require 'docusign_esign/models/connect_failure_filter'
 require 'docusign_esign/models/connect_failure_result'
 require 'docusign_esign/models/connect_failure_results'
@@ -152,7 +153,6 @@ require 'docusign_esign/models/contact_phone_number'
 require 'docusign_esign/models/contact_update_response'
 require 'docusign_esign/models/correct_view_request'
 require 'docusign_esign/models/country'
-require 'docusign_esign/models/credential'
 require 'docusign_esign/models/credit_card_information'
 require 'docusign_esign/models/credit_card_types'
 require 'docusign_esign/models/currency_feature_set_price'
@@ -177,12 +177,14 @@ require 'docusign_esign/models/document_html_definition_originals'
 require 'docusign_esign/models/document_html_definitions'
 require 'docusign_esign/models/document_html_display_anchor'
 require 'docusign_esign/models/document_html_display_settings'
-require 'docusign_esign/models/document_security_store'
 require 'docusign_esign/models/document_template'
 require 'docusign_esign/models/document_template_list'
-require 'docusign_esign/models/document_update_info'
 require 'docusign_esign/models/document_visibility'
 require 'docusign_esign/models/document_visibility_list'
+require 'docusign_esign/models/downgrad_request_billing_info_response'
+require 'docusign_esign/models/downgrade_billing_plan_information'
+require 'docusign_esign/models/downgrade_plan_update_response'
+require 'docusign_esign/models/draw'
 require 'docusign_esign/models/e_note_configuration'
 require 'docusign_esign/models/editor'
 require 'docusign_esign/models/email'
@@ -217,7 +219,6 @@ require 'docusign_esign/models/error_details'
 require 'docusign_esign/models/event_notification'
 require 'docusign_esign/models/event_result'
 require 'docusign_esign/models/expirations'
-require 'docusign_esign/models/external_claim'
 require 'docusign_esign/models/external_doc_service_error_details'
 require 'docusign_esign/models/external_document_sources'
 require 'docusign_esign/models/external_file'
@@ -292,12 +293,10 @@ require 'docusign_esign/models/notification_default_settings'
 require 'docusign_esign/models/notification_defaults'
 require 'docusign_esign/models/number'
 require 'docusign_esign/models/oauth_access'
-require 'docusign_esign/models/ocr_request'
 require 'docusign_esign/models/offline_attributes'
 require 'docusign_esign/models/page'
 require 'docusign_esign/models/page_images'
 require 'docusign_esign/models/page_request'
-require 'docusign_esign/models/page_size'
 require 'docusign_esign/models/path_extended_element'
 require 'docusign_esign/models/pay_pal_legacy_settings'
 require 'docusign_esign/models/payment_details'
@@ -328,14 +327,18 @@ require 'docusign_esign/models/provisioning_information'
 require 'docusign_esign/models/purchased_envelopes_information'
 require 'docusign_esign/models/radio'
 require 'docusign_esign/models/radio_group'
+require 'docusign_esign/models/recipient_additional_notification'
 require 'docusign_esign/models/recipient_attachment'
 require 'docusign_esign/models/recipient_domain'
 require 'docusign_esign/models/recipient_email_notification'
 require 'docusign_esign/models/recipient_event'
 require 'docusign_esign/models/recipient_form_data'
+require 'docusign_esign/models/recipient_identity_input_option'
+require 'docusign_esign/models/recipient_identity_phone_number'
 require 'docusign_esign/models/recipient_identity_verification'
 require 'docusign_esign/models/recipient_names_response'
 require 'docusign_esign/models/recipient_phone_authentication'
+require 'docusign_esign/models/recipient_phone_number'
 require 'docusign_esign/models/recipient_preview_request'
 require 'docusign_esign/models/recipient_proof_file'
 require 'docusign_esign/models/recipient_sms_authentication'
@@ -350,24 +353,16 @@ require 'docusign_esign/models/referral_information'
 require 'docusign_esign/models/reminders'
 require 'docusign_esign/models/resource_information'
 require 'docusign_esign/models/return_url_request'
-require 'docusign_esign/models/revision'
-require 'docusign_esign/models/seal'
 require 'docusign_esign/models/seal_identifier'
 require 'docusign_esign/models/seal_sign'
 require 'docusign_esign/models/seat_discount'
-require 'docusign_esign/models/sender'
 require 'docusign_esign/models/sender_email_notifications'
 require 'docusign_esign/models/server_template'
 require 'docusign_esign/models/service_information'
 require 'docusign_esign/models/service_version'
 require 'docusign_esign/models/settings_metadata'
 require 'docusign_esign/models/shared_item'
-require 'docusign_esign/models/sign_hash_document'
-require 'docusign_esign/models/sign_hash_session_info_response'
 require 'docusign_esign/models/sign_here'
-require 'docusign_esign/models/sign_session_info_request'
-require 'docusign_esign/models/signature_data_info'
-require 'docusign_esign/models/signature_properties'
 require 'docusign_esign/models/signature_provider_required_option'
 require 'docusign_esign/models/signature_type'
 require 'docusign_esign/models/signer'
@@ -408,18 +403,11 @@ require 'docusign_esign/models/template_tabs'
 require 'docusign_esign/models/template_update_summary'
 require 'docusign_esign/models/text'
 require 'docusign_esign/models/text_custom_field'
-require 'docusign_esign/models/time_stamp_field'
 require 'docusign_esign/models/title'
-require 'docusign_esign/models/tsp_health_check_request'
-require 'docusign_esign/models/tsp_health_check_status_description'
-require 'docusign_esign/models/update_transaction_request'
-require 'docusign_esign/models/update_transaction_response'
 require 'docusign_esign/models/usage_history'
-require 'docusign_esign/models/user'
 require 'docusign_esign/models/user_account_management_granular_information'
 require 'docusign_esign/models/user_info'
 require 'docusign_esign/models/user_info_list'
-require 'docusign_esign/models/user_info_response'
 require 'docusign_esign/models/user_information'
 require 'docusign_esign/models/user_information_list'
 require 'docusign_esign/models/user_password_information'
@@ -464,7 +452,6 @@ require 'docusign_esign/api/notary_api'
 require 'docusign_esign/api/organizations_api'
 require 'docusign_esign/api/power_forms_api'
 require 'docusign_esign/api/signing_groups_api'
-require 'docusign_esign/api/tsps_api'
 require 'docusign_esign/api/templates_api'
 require 'docusign_esign/api/users_api'
 require 'docusign_esign/api/workspaces_api'
@@ -485,4 +472,4 @@ module DocuSign_eSign
       end
     end
   end
-end
+end

data/lib/docusign_esign/api/accounts_api.rb

@@ -6,6 +6,7 @@
 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
 
@@ -1883,55 +1884,6 @@ module DocuSign_eSign
       return data, status_code, headers
     end
 
-    # Returns Account available seals for specified account.
-    # 
-    # @param account_id The external account number (int) or account ID Guid.
-    # @return [AccountSeals]
-    def get_seal_providers(account_id)
-      data, _status_code, _headers = get_seal_providers_with_http_info(account_id)
-      return data
-    end
-
-    # Returns Account available seals for specified account.
-    # 
-    # @param account_id The external account number (int) or account ID Guid.
-    # @return [Array<(AccountSeals, Fixnum, Hash)>] AccountSeals data, response status code and response headers
-    def get_seal_providers_with_http_info(account_id)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: AccountsApi.get_seal_providers ..."
-      end
-      # verify the required parameter 'account_id' is set
-      fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_seal_providers" if account_id.nil?
-      # resource path
-      local_var_path = "/v2.1/accounts/{accountId}/seals".sub('{format}','json').sub('{' + 'accountId' + '}', account_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 => 'AccountSeals')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AccountsApi#get_seal_providers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Gets list of supported languages for recipient language setting.
     # 
     # @param account_id The external account number (int) or account ID Guid.
@@ -3355,4 +3307,4 @@ module DocuSign_eSign
       return data, status_code, headers
     end
   end
-end
+end

data/lib/docusign_esign/api/authentication_api.rb

@@ -6,6 +6,7 @@
 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
 
@@ -390,4 +391,4 @@ module DocuSign_eSign
       return data, status_code, headers
     end
   end
-end
+end

data/lib/docusign_esign/api/billing_api.rb

@@ -6,6 +6,7 @@
 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
 
@@ -167,6 +168,55 @@ module DocuSign_eSign
       return data, status_code, headers
     end
 
+    # Returns downgrade plan information for the specified account.
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @return [DowngradRequestBillingInfoResponse]
+    def get_downgrade_request_billing_info(account_id)
+      data, _status_code, _headers = get_downgrade_request_billing_info_with_http_info(account_id)
+      return data
+    end
+
+    # Returns downgrade plan information for the specified account.
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @return [Array<(DowngradRequestBillingInfoResponse, Fixnum, Hash)>] DowngradRequestBillingInfoResponse data, response status code and response headers
+    def get_downgrade_request_billing_info_with_http_info(account_id)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: BillingApi.get_downgrade_request_billing_info ..."
+      end
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.get_downgrade_request_billing_info" if account_id.nil?
+      # resource path
+      local_var_path = "/v2.1/accounts/{accountId}/billing_plan/downgrade".sub('{format}','json').sub('{' + 'accountId' + '}', account_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 => 'DowngradRequestBillingInfoResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BillingApi#get_downgrade_request_billing_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Retrieves a billing invoice.
     # Retrieves the specified invoice.   ###### Note: If the `pdfAvailable` property in the response is set to *true*, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the `Accept` property in the header to `Accept: application/pdf`.  Privileges required: account administrator  The response returns a list of charges and information about the charges. Quantities are usually shown as 'unlimited' or an integer. Amounts are shown in the currency set for the account.  **Response** The following table provides a description of the different `chargeName` property values. The information will grow as more chargeable items are added to the system.  | chargeName | Description | | --- | --- | | id_check | ID Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | DocuSign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge | 
     # @param account_id The external account number (int) or account ID Guid.
@@ -628,6 +678,57 @@ module DocuSign_eSign
       return data, status_code, headers
     end
 
+    # Queues downgrade billing plan request for an account.
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param downgrade_billing_plan_information  (optional parameter)
+    # @return [DowngradePlanUpdateResponse]
+    def update_downgrade_account_billing_plan(account_id, downgrade_billing_plan_information)
+      data, _status_code, _headers = update_downgrade_account_billing_plan_with_http_info(account_id,  downgrade_billing_plan_information)
+      return data
+    end
+
+    # Queues downgrade billing plan request for an account.
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param downgrade_billing_plan_information  (optional parameter)
+    # @return [Array<(DowngradePlanUpdateResponse, Fixnum, Hash)>] DowngradePlanUpdateResponse data, response status code and response headers
+    def update_downgrade_account_billing_plan_with_http_info(account_id, downgrade_billing_plan_information)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: BillingApi.update_downgrade_account_billing_plan ..."
+      end
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.update_downgrade_account_billing_plan" if account_id.nil?
+      # resource path
+      local_var_path = "/v2.1/accounts/{accountId}/billing_plan/downgrade".sub('{format}','json').sub('{' + 'accountId' + '}', account_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 = @api_client.object_to_http_body(downgrade_billing_plan_information)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'DowngradePlanUpdateResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BillingApi#update_downgrade_account_billing_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Updates the account billing plan.
     # Updates the billing plan information, billing address, and credit card information for the specified account.
     # @param account_id The external account number (int) or account ID Guid.
@@ -682,4 +783,4 @@ module DocuSign_eSign
       return data, status_code, headers
     end
   end
-end
+end