dropbox-sign 1.0.0.pre.beta2301

data/examples/TemplateRemoveUser.rb

@@ -0,0 +1,23 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+template_api = Dropbox::Sign::TemplateApi.new
+
+data = Dropbox::Sign::TemplateRemoveUserRequest.new
+data.email_address = "george@dropboxsign.com"
+
+template_id = "21f920ec2b7f4b6bb64d3ed79f26303843046536"
+
+begin
+  result = template_api.template_remove_user(template_id, data)
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/TemplateUpdateFiles.rb

@@ -0,0 +1,23 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+template_api = Dropbox::Sign::TemplateApi.new
+
+data = Dropbox::Sign::TemplateUpdateFilesRequest.new
+data.files = [File.new("example_signature_request.pdf", "r")]
+
+template_id = "5de8179668f2033afac48da1868d0093bf133266"
+
+begin
+  result = template_api.template_update_files(template_id, data)
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/UnclaimedDraftCreate.rb

@@ -0,0 +1,56 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+unclaimed_draft_api = Dropbox::Sign::UnclaimedDraftApi.new
+
+signer_1 = Dropbox::Sign::SubUnclaimedDraftSigner.new
+signer_1.email_address = "jack@example.com"
+signer_1.name = "Jack"
+signer_1.order = 0
+
+signer_2 = Dropbox::Sign::SubUnclaimedDraftSigner.new
+signer_2.email_address = "jill@example.com"
+signer_2.name = "Jill"
+signer_2.order = 1
+
+signing_options = Dropbox::Sign::SubSigningOptions.new
+signing_options.draw = true
+signing_options.type = true
+signing_options.upload = true
+signing_options.phone = false
+signing_options.default_type = "draw"
+
+field_options = Dropbox::Sign::SubFieldOptions.new
+field_options.date_format = "DD - MM - YYYY"
+
+data = Dropbox::Sign::UnclaimedDraftCreateRequest.new
+data.subject = "The NDA we talked about"
+data.type = "request_signature"
+data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions."
+data.signers = [signer_1, signer_2]
+data.cc_email_addresses = [
+  "lawyer@dropboxsign.com",
+  "lawyer@dropboxsign.com",
+]
+data.files = [File.new("example_signature_request.pdf", "r")]
+data.metadata = {
+  custom_id: 1234,
+  custom_text: "NDA #9",
+}
+data.signing_options = signing_options
+data.field_options = field_options
+data.test_mode = true
+
+begin
+  result = unclaimed_draft_api.unclaimed_draft_create(data)
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/UnclaimedDraftCreateEmbedded.rb

@@ -0,0 +1,24 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+unclaimed_draft_api = Dropbox::Sign::UnclaimedDraftApi.new
+
+data = Dropbox::Sign::UnclaimedDraftCreateEmbeddedRequest.new
+data.client_id = "ec64a202072370a737edf4a0eb7f4437"
+data.files = [File.new("example_signature_request.pdf", "r")]
+data.requester_email_address = "jack@dropboxsign.com"
+data.test_mode = true
+
+begin
+  result = unclaimed_draft_api.unclaimed_draft_create_embedded(data)
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb

@@ -0,0 +1,35 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+unclaimed_draft_api = Dropbox::Sign::UnclaimedDraftApi.new
+
+signer_1 = Dropbox::Sign::SubUnclaimedDraftTemplateSigner.new
+signer_1.role = "Client"
+signer_1.name = "George"
+signer_1.email_address = "george@example.com"
+
+cc_1 = Dropbox::Sign::SubCC.new
+cc_1.role = "Accounting"
+cc_1.email_address = "accounting@example.com"
+
+data = Dropbox::Sign::UnclaimedDraftCreateEmbeddedWithTemplateRequest.new
+data.client_id = "ec64a202072370a737edf4a0eb7f4437"
+data.template_ids = ["61a832ff0d8423f91d503e76bfbcc750f7417c78"]
+data.requester_email_address = "jack@dropboxsign.com"
+data.signers = [signer_1]
+data.ccs = [cc_1]
+data.test_mode = true
+
+begin
+  result = unclaimed_draft_api.unclaimed_draft_create_embedded_with_template(data)
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/UnclaimedDraftEditAndResend.rb

@@ -0,0 +1,24 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+unclaimed_draft_api = Dropbox::Sign::UnclaimedDraftApi.new
+
+data = Dropbox::Sign::UnclaimedDraftEditAndResendRequest.new
+data.client_id = "ec64a202072370a737edf4a0eb7f4437"
+data.test_mode = true
+
+signature_request_id = "2f9781e1a83jdja934d808c153c2e1d3df6f8f2f"
+
+begin
+  result = unclaimed_draft_api.unclaimed_draft_edit_and_resend(signature_request_id, data)
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/lib/dropbox-sign/api/account_api.rb

@@ -0,0 +1,446 @@
+=begin
+#Dropbox Sign API
+
+#Dropbox Sign v3 API
+
+The version of the OpenAPI document: 3.0.0
+Contact: apisupport@hellosign.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.3.0
+
+=end
+
+require 'cgi'
+
+module Dropbox
+end
+
+module Dropbox::Sign
+  class AccountApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create Account
+    # Creates a new Dropbox Sign Account that is associated with the specified `email_address`.
+    # @param account_create_request [AccountCreateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [AccountCreateResponse]
+    def account_create(account_create_request, opts = {})
+      data, _status_code, _headers = account_create_with_http_info(account_create_request, opts)
+      data
+    end
+
+    # Create Account
+    # Creates a new Dropbox Sign Account that is associated with the specified `email_address`.
+    # @param account_create_request [AccountCreateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AccountCreateResponse, Integer, Hash)>] AccountCreateResponse data, response status code and response headers
+    def account_create_with_http_info(account_create_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountApi.account_create ...'
+      end
+      # verify the required parameter 'account_create_request' is set
+      if @api_client.config.client_side_validation && account_create_request.nil?
+        fail ArgumentError, "Missing the required parameter 'account_create_request' when calling AccountApi.account_create"
+      end
+      # resource path
+      local_var_path = '/account/create'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      post_body = {}
+      form_params = opts[:form_params] || {}
+      result = @api_client.generate_form_data(
+        account_create_request,
+        Dropbox::Sign::AccountCreateRequest.openapi_types
+      )
+
+      # form parameters
+      if result[:has_file]
+        form_params = opts[:form_params] || result[:params]
+        header_params['Content-Type'] = 'multipart/form-data'
+      else
+        # http body (model)
+        post_body = opts[:debug_body] || result[:params]
+      end
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AccountCreateResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
+
+      new_options = opts.merge(
+        :operation => :"AccountApi.account_create",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      begin
+        data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      rescue Dropbox::Sign::ApiError => e
+        if e.code === 200
+          body = @api_client.convert_to_type(
+            JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
+            "Dropbox::Sign::AccountCreateResponse"
+          )
+
+          fail ApiError.new(:code => e.code,
+                            :response_headers => e.response_headers,
+                            :response_body => body),
+               e.message
+        end
+
+        range_code = "4XX".split('').first
+        range_code_left = "#{range_code}00".to_i
+        range_code_right = "#{range_code}99".to_i
+        if e.code >= range_code_left && e.code <= range_code_right
+          body = @api_client.convert_to_type(
+            JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
+            "Dropbox::Sign::ErrorResponse"
+          )
+
+          fail ApiError.new(:code => e.code,
+                            :response_headers => e.response_headers,
+                            :response_body => body),
+               e.message
+        end
+
+      end
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountApi#account_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Account
+    # Returns the properties and settings of your Account.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :account_id &#x60;account_id&#x60; or &#x60;email_address&#x60; is required. If both are provided, the account id prevails.  The ID of the Account.
+    # @option opts [String] :email_address &#x60;account_id&#x60; or &#x60;email_address&#x60; is required, If both are provided, the account id prevails.  The email address of the Account.
+    # @return [AccountGetResponse]
+    def account_get(opts = {})
+      data, _status_code, _headers = account_get_with_http_info(opts)
+      data
+    end
+
+    # Get Account
+    # Returns the properties and settings of your Account.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :account_id &#x60;account_id&#x60; or &#x60;email_address&#x60; is required. If both are provided, the account id prevails.  The ID of the Account.
+    # @option opts [String] :email_address &#x60;account_id&#x60; or &#x60;email_address&#x60; is required, If both are provided, the account id prevails.  The email address of the Account.
+    # @return [Array<(AccountGetResponse, Integer, Hash)>] AccountGetResponse data, response status code and response headers
+    def account_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountApi.account_get ...'
+      end
+      # resource path
+      local_var_path = '/account'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'account_id'] = opts[:'account_id'] if !opts[:'account_id'].nil?
+      query_params[:'email_address'] = opts[:'email_address'] if !opts[:'email_address'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      post_body = {}
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AccountGetResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
+
+      new_options = opts.merge(
+        :operation => :"AccountApi.account_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      begin
+        data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      rescue Dropbox::Sign::ApiError => e
+        if e.code === 200
+          body = @api_client.convert_to_type(
+            JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
+            "Dropbox::Sign::AccountGetResponse"
+          )
+
+          fail ApiError.new(:code => e.code,
+                            :response_headers => e.response_headers,
+                            :response_body => body),
+               e.message
+        end
+
+        range_code = "4XX".split('').first
+        range_code_left = "#{range_code}00".to_i
+        range_code_right = "#{range_code}99".to_i
+        if e.code >= range_code_left && e.code <= range_code_right
+          body = @api_client.convert_to_type(
+            JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
+            "Dropbox::Sign::ErrorResponse"
+          )
+
+          fail ApiError.new(:code => e.code,
+                            :response_headers => e.response_headers,
+                            :response_body => body),
+               e.message
+        end
+
+      end
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountApi#account_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update Account
+    # Updates the properties and settings of your Account. Currently only allows for updates to the [Callback URL](/api/reference/tag/Callbacks-and-Events) and locale.
+    # @param account_update_request [AccountUpdateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [AccountGetResponse]
+    def account_update(account_update_request, opts = {})
+      data, _status_code, _headers = account_update_with_http_info(account_update_request, opts)
+      data
+    end
+
+    # Update Account
+    # Updates the properties and settings of your Account. Currently only allows for updates to the [Callback URL](/api/reference/tag/Callbacks-and-Events) and locale.
+    # @param account_update_request [AccountUpdateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AccountGetResponse, Integer, Hash)>] AccountGetResponse data, response status code and response headers
+    def account_update_with_http_info(account_update_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountApi.account_update ...'
+      end
+      # verify the required parameter 'account_update_request' is set
+      if @api_client.config.client_side_validation && account_update_request.nil?
+        fail ArgumentError, "Missing the required parameter 'account_update_request' when calling AccountApi.account_update"
+      end
+      # resource path
+      local_var_path = '/account'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      post_body = {}
+      form_params = opts[:form_params] || {}
+      result = @api_client.generate_form_data(
+        account_update_request,
+        Dropbox::Sign::AccountUpdateRequest.openapi_types
+      )
+
+      # form parameters
+      if result[:has_file]
+        form_params = opts[:form_params] || result[:params]
+        header_params['Content-Type'] = 'multipart/form-data'
+      else
+        # http body (model)
+        post_body = opts[:debug_body] || result[:params]
+      end
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AccountGetResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
+
+      new_options = opts.merge(
+        :operation => :"AccountApi.account_update",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      begin
+        data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      rescue Dropbox::Sign::ApiError => e
+        if e.code === 200
+          body = @api_client.convert_to_type(
+            JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
+            "Dropbox::Sign::AccountGetResponse"
+          )
+
+          fail ApiError.new(:code => e.code,
+                            :response_headers => e.response_headers,
+                            :response_body => body),
+               e.message
+        end
+
+        range_code = "4XX".split('').first
+        range_code_left = "#{range_code}00".to_i
+        range_code_right = "#{range_code}99".to_i
+        if e.code >= range_code_left && e.code <= range_code_right
+          body = @api_client.convert_to_type(
+            JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
+            "Dropbox::Sign::ErrorResponse"
+          )
+
+          fail ApiError.new(:code => e.code,
+                            :response_headers => e.response_headers,
+                            :response_body => body),
+               e.message
+        end
+
+      end
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountApi#account_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Verify Account
+    # Verifies whether an Dropbox Sign Account exists for the given email address.
+    # @param account_verify_request [AccountVerifyRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [AccountVerifyResponse]
+    def account_verify(account_verify_request, opts = {})
+      data, _status_code, _headers = account_verify_with_http_info(account_verify_request, opts)
+      data
+    end
+
+    # Verify Account
+    # Verifies whether an Dropbox Sign Account exists for the given email address.
+    # @param account_verify_request [AccountVerifyRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AccountVerifyResponse, Integer, Hash)>] AccountVerifyResponse data, response status code and response headers
+    def account_verify_with_http_info(account_verify_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountApi.account_verify ...'
+      end
+      # verify the required parameter 'account_verify_request' is set
+      if @api_client.config.client_side_validation && account_verify_request.nil?
+        fail ArgumentError, "Missing the required parameter 'account_verify_request' when calling AccountApi.account_verify"
+      end
+      # resource path
+      local_var_path = '/account/verify'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      post_body = {}
+      form_params = opts[:form_params] || {}
+      result = @api_client.generate_form_data(
+        account_verify_request,
+        Dropbox::Sign::AccountVerifyRequest.openapi_types
+      )
+
+      # form parameters
+      if result[:has_file]
+        form_params = opts[:form_params] || result[:params]
+        header_params['Content-Type'] = 'multipart/form-data'
+      else
+        # http body (model)
+        post_body = opts[:debug_body] || result[:params]
+      end
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AccountVerifyResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
+
+      new_options = opts.merge(
+        :operation => :"AccountApi.account_verify",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      begin
+        data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      rescue Dropbox::Sign::ApiError => e
+        if e.code === 200
+          body = @api_client.convert_to_type(
+            JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
+            "Dropbox::Sign::AccountVerifyResponse"
+          )
+
+          fail ApiError.new(:code => e.code,
+                            :response_headers => e.response_headers,
+                            :response_body => body),
+               e.message
+        end
+
+        range_code = "4XX".split('').first
+        range_code_left = "#{range_code}00".to_i
+        range_code_right = "#{range_code}99".to_i
+        if e.code >= range_code_left && e.code <= range_code_right
+          body = @api_client.convert_to_type(
+            JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
+            "Dropbox::Sign::ErrorResponse"
+          )
+
+          fail ApiError.new(:code => e.code,
+                            :response_headers => e.response_headers,
+                            :response_body => body),
+               e.message
+        end
+
+      end
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountApi#account_verify\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end