docusign_esign 3.0.0 → 3.1.0.pre.rc1

data/lib/docusign_esign/api/organizations_api.rb

@@ -0,0 +1,232 @@
+=begin
+#DocuSign REST API
+
+#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+
+OpenAPI spec version: v2.1
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require "uri"
+
+module DocuSign_eSign
+
+
+  class OrganizationsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = OrganizationsApi.default)
+      @api_client = api_client
+    end
+
+    # Retrieves org level report by correlation id and site.
+    # 
+    # @param organization_id 
+    # @param report_correlation_id 
+    # @return [nil]
+    def delete_report(organization_id, report_correlation_id)
+      delete_report_with_http_info(organization_id, report_correlation_id)
+      return nil
+    end
+
+    # Retrieves org level report by correlation id and site.
+    # 
+    # @param organization_id 
+    # @param report_correlation_id 
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_report_with_http_info(organization_id, report_correlation_id)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: OrganizationsApi.delete_report ..."
+      end
+      # verify the required parameter 'organization_id' is set
+      fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.delete_report" if organization_id.nil?
+      # verify the required parameter 'report_correlation_id' is set
+      fail ArgumentError, "Missing the required parameter 'report_correlation_id' when calling OrganizationsApi.delete_report" if report_correlation_id.nil?
+      # resource path
+      local_var_path = "/v2.1/organization_reporting/{organizationId}/reports/{reportCorrelationId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'reportCorrelationId' + '}', report_correlation_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(:DELETE, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OrganizationsApi#delete_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieves an account settings comparison.
+    # 
+    # @param organization_id 
+    # @param result_id 
+    # @return [nil]
+    def get_account_settings_export(organization_id, result_id)
+      get_account_settings_export_with_http_info(organization_id, result_id)
+      return nil
+    end
+
+    # Retrieves an account settings comparison.
+    # 
+    # @param organization_id 
+    # @param result_id 
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def get_account_settings_export_with_http_info(organization_id, result_id)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: OrganizationsApi.get_account_settings_export ..."
+      end
+      # verify the required parameter 'organization_id' is set
+      fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.get_account_settings_export" if organization_id.nil?
+      # verify the required parameter 'result_id' is set
+      fail ArgumentError, "Missing the required parameter 'result_id' when calling OrganizationsApi.get_account_settings_export" if result_id.nil?
+      # resource path
+      local_var_path = "/v2.1/organization_exports/{organizationId}/account_settings/{resultId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'resultId' + '}', result_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)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OrganizationsApi#get_account_settings_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieves org level report by correlation id and site.
+    # 
+    # @param organization_id 
+    # @param report_correlation_id 
+    # @return [nil]
+    def get_report(organization_id, report_correlation_id)
+      get_report_with_http_info(organization_id, report_correlation_id)
+      return nil
+    end
+
+    # Retrieves org level report by correlation id and site.
+    # 
+    # @param organization_id 
+    # @param report_correlation_id 
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def get_report_with_http_info(organization_id, report_correlation_id)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: OrganizationsApi.get_report ..."
+      end
+      # verify the required parameter 'organization_id' is set
+      fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.get_report" if organization_id.nil?
+      # verify the required parameter 'report_correlation_id' is set
+      fail ArgumentError, "Missing the required parameter 'report_correlation_id' when calling OrganizationsApi.get_report" if report_correlation_id.nil?
+      # resource path
+      local_var_path = "/v2.1/organization_reporting/{organizationId}/reports/{reportCorrelationId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'reportCorrelationId' + '}', report_correlation_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)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OrganizationsApi#get_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieves UserList Export Results data.
+    # 
+    # @param organization_id 
+    # @param result_id 
+    # @return [nil]
+    def get_user_list_export(organization_id, result_id)
+      get_user_list_export_with_http_info(organization_id, result_id)
+      return nil
+    end
+
+    # Retrieves UserList Export Results data.
+    # 
+    # @param organization_id 
+    # @param result_id 
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def get_user_list_export_with_http_info(organization_id, result_id)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: OrganizationsApi.get_user_list_export ..."
+      end
+      # verify the required parameter 'organization_id' is set
+      fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.get_user_list_export" if organization_id.nil?
+      # verify the required parameter 'result_id' is set
+      fail ArgumentError, "Missing the required parameter 'result_id' when calling OrganizationsApi.get_user_list_export" if result_id.nil?
+      # resource path
+      local_var_path = "/v2.1/organization_exports/{organizationId}/user_list/{resultId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'resultId' + '}', result_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)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OrganizationsApi#get_user_list_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/docusign_esign/api/tsps_api.rb

@@ -0,0 +1,256 @@
+=begin
+#DocuSign REST API
+
+#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+
+OpenAPI spec version: v2.1
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require "uri"
+
+module DocuSign_eSign
+
+
+  class TSPsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = TSPsApi.default)
+      @api_client = api_client
+    end
+
+    # Complete Sign Hash
+    # 
+    # @param complete_sign_request  (optional parameter)
+    # @return [CompleteSignHashResponse]
+    def complete_sign_hash(complete_sign_request)
+      data, _status_code, _headers = complete_sign_hash_with_http_info( complete_sign_request)
+      return data
+    end
+
+    # Complete Sign Hash
+    # 
+    # @param complete_sign_request  (optional parameter)
+    # @return [Array<(CompleteSignHashResponse, Fixnum, Hash)>] CompleteSignHashResponse data, response status code and response headers
+    def complete_sign_hash_with_http_info(complete_sign_request)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: TSPsApi.complete_sign_hash ..."
+      end
+      # resource path
+      local_var_path = "/v2.1/signature/completesignhash".sub('{format}','json')
+
+      # 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(complete_sign_request)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'CompleteSignHashResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TSPsApi#complete_sign_hash\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get User Info To Sign Document
+    # 
+    # @return [UserInfoResponse]
+    def get_user_info()
+      data, _status_code, _headers = get_user_info_with_http_info()
+      return data
+    end
+
+    # Get User Info To Sign Document
+    # 
+    # @return [Array<(UserInfoResponse, Fixnum, Hash)>] UserInfoResponse data, response status code and response headers
+    def get_user_info_with_http_info()
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: TSPsApi.get_user_info ..."
+      end
+      # resource path
+      local_var_path = "/v2.1/signature/userInfo".sub('{format}','json')
+
+      # 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 => 'UserInfoResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TSPsApi#get_user_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Report status from the TSP to DocuSign
+    # 
+    # @param tsp_health_check_request  (optional parameter)
+    # @return [nil]
+    def health_check(tsp_health_check_request)
+      health_check_with_http_info( tsp_health_check_request)
+      return nil
+    end
+
+    # Report status from the TSP to DocuSign
+    # 
+    # @param tsp_health_check_request  (optional parameter)
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def health_check_with_http_info(tsp_health_check_request)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: TSPsApi.health_check ..."
+      end
+      # resource path
+      local_var_path = "/v2.1/signature/healthcheck".sub('{format}','json')
+
+      # 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(tsp_health_check_request)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TSPsApi#health_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Signature Session Info To Sign Document Hash
+    # 
+    # @param sign_session_info_request  (optional parameter)
+    # @return [SignHashSessionInfoResponse]
+    def sign_hash_session_info(sign_session_info_request)
+      data, _status_code, _headers = sign_hash_session_info_with_http_info( sign_session_info_request)
+      return data
+    end
+
+    # Get Signature Session Info To Sign Document Hash
+    # 
+    # @param sign_session_info_request  (optional parameter)
+    # @return [Array<(SignHashSessionInfoResponse, Fixnum, Hash)>] SignHashSessionInfoResponse data, response status code and response headers
+    def sign_hash_session_info_with_http_info(sign_session_info_request)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: TSPsApi.sign_hash_session_info ..."
+      end
+      # resource path
+      local_var_path = "/v2.1/signature/signhashsessioninfo".sub('{format}','json')
+
+      # 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(sign_session_info_request)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'SignHashSessionInfoResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TSPsApi#sign_hash_session_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Report an error from the tsp to docusign
+    # 
+    # @param update_transaction_request  (optional parameter)
+    # @return [UpdateTransactionResponse]
+    def update_transaction(update_transaction_request)
+      data, _status_code, _headers = update_transaction_with_http_info( update_transaction_request)
+      return data
+    end
+
+    # Report an error from the tsp to docusign
+    # 
+    # @param update_transaction_request  (optional parameter)
+    # @return [Array<(UpdateTransactionResponse, Fixnum, Hash)>] UpdateTransactionResponse data, response status code and response headers
+    def update_transaction_with_http_info(update_transaction_request)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: TSPsApi.update_transaction ..."
+      end
+      # resource path
+      local_var_path = "/v2.1/signature/updatetransaction".sub('{format}','json')
+
+      # 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(update_transaction_request)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'UpdateTransactionResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TSPsApi#update_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end