docusign_esign 3.12.0 → 3.19.0

data/lib/docusign_esign/api/connect_api.rb

@@ -13,6 +13,30 @@ require "uri"
 
 module DocuSign_eSign
 
+  class GetConnectAllUsersOptions
+    # 
+    attr_accessor :count
+
+    # 
+    attr_accessor :domain_users_only
+
+    # 
+    attr_accessor :email_substring
+
+    # 
+    attr_accessor :start_position
+
+    # 
+    attr_accessor :status
+
+    # 
+    attr_accessor :user_name_substring
+
+    def self.default
+      @@default ||= GetConnectAllUsersOptions.new
+    end
+  end
+
   class GetEventLogOptions
     # When true, the connectDebugLog information is included in the response.
     attr_accessor :additional_info
@@ -129,6 +153,57 @@ module DocuSign_eSign
       return data, status_code, headers
     end
 
+    # Sets the Connect OAuth Config for the account.
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param connect_o_auth_config  (optional parameter)
+    # @return [ConnectOAuthConfig]
+    def create_connect_o_auth_config(account_id, connect_o_auth_config)
+      data, _status_code, _headers = create_connect_o_auth_config_with_http_info(account_id,  connect_o_auth_config)
+      return data
+    end
+
+    # Sets the Connect OAuth Config for the account.
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param connect_o_auth_config  (optional parameter)
+    # @return [Array<(ConnectOAuthConfig, Fixnum, Hash)>] ConnectOAuthConfig data, response status code and response headers
+    def create_connect_o_auth_config_with_http_info(account_id, connect_o_auth_config)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ConnectApi.create_connect_o_auth_config ..."
+      end
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.create_connect_o_auth_config" if account_id.nil?
+      # resource path
+      local_var_path = "/v2.1/accounts/{accountId}/connect/oauth".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(connect_o_auth_config)
+      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 => 'ConnectOAuthConfig')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConnectApi#create_connect_o_auth_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Deletes the specified connect configuration.
     # Deletes the specified DocuSign Connect configuration.  ###### Note: Connect must be enabled for your account to use this function.    
     # @param account_id The external account number (int) or account ID Guid.
@@ -181,21 +256,69 @@ module DocuSign_eSign
       return data, status_code, headers
     end
 
+    # Sets the Connect OAuth Config for the account.
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @return [nil]
+    def delete_connect_o_auth_config(account_id)
+      delete_connect_o_auth_config_with_http_info(account_id)
+      return nil
+    end
+
+    # Sets the Connect OAuth Config for the account.
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_connect_o_auth_config_with_http_info(account_id)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ConnectApi.delete_connect_o_auth_config ..."
+      end
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.delete_connect_o_auth_config" if account_id.nil?
+      # resource path
+      local_var_path = "/v2.1/accounts/{accountId}/connect/oauth".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(: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: ConnectApi#delete_connect_o_auth_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Deletes a Connect failure log entry.
     # Deletes the Connect failure log information for the specified entry.
     # @param account_id The external account number (int) or account ID Guid.
     # @param failure_id The ID of the failed connect log entry.
-    # @return [nil]
+    # @return [ConnectDeleteFailureResult]
     def delete_event_failure_log(account_id, failure_id)
-      delete_event_failure_log_with_http_info(account_id, failure_id)
-      return nil
+      data, _status_code, _headers = delete_event_failure_log_with_http_info(account_id, failure_id)
+      return data
     end
 
     # Deletes a Connect failure log entry.
     # Deletes the Connect failure log information for the specified entry.
     # @param account_id The external account number (int) or account ID Guid.
     # @param failure_id The ID of the failed connect log entry.
-    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    # @return [Array<(ConnectDeleteFailureResult, Fixnum, Hash)>] ConnectDeleteFailureResult data, response status code and response headers
     def delete_event_failure_log_with_http_info(account_id, failure_id)
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: ConnectApi.delete_event_failure_log ..."
@@ -226,7 +349,8 @@ module DocuSign_eSign
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
-        :auth_names => auth_names)
+        :auth_names => auth_names,
+        :return_type => 'ConnectDeleteFailureResult')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: ConnectApi#delete_event_failure_log\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -437,6 +561,116 @@ module DocuSign_eSign
       return data, status_code, headers
     end
 
+    # Returns all users from the configured Connect service.
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param connect_id The ID of the custom Connect configuration being accessed.
+    # @param DocuSign_eSign::GetConnectAllUsersOptions Options for modifying the behavior of the function.
+    # @return [IntegratedConnectUserInfoList]
+    def get_connect_all_users(account_id, connect_id, options = DocuSign_eSign::GetConnectAllUsersOptions.default)
+      data, _status_code, _headers = get_connect_all_users_with_http_info(account_id, connect_id, options)
+      return data
+    end
+
+    # Returns all users from the configured Connect service.
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param connect_id The ID of the custom Connect configuration being accessed.
+    # @param DocuSign_eSign::GetConnectAllUsersOptions Options for modifying the behavior of the function.
+    # @return [Array<(IntegratedConnectUserInfoList, Fixnum, Hash)>] IntegratedConnectUserInfoList data, response status code and response headers
+    def get_connect_all_users_with_http_info(account_id, connect_id, options = DocuSign_eSign::GetConnectAllUsersOptions.default)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ConnectApi.get_connect_all_users ..."
+      end
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.get_connect_all_users" if account_id.nil?
+      # verify the required parameter 'connect_id' is set
+      fail ArgumentError, "Missing the required parameter 'connect_id' when calling ConnectApi.get_connect_all_users" if connect_id.nil?
+      # resource path
+      local_var_path = "/v2.1/accounts/{accountId}/connect/{connectId}/all/users".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'connectId' + '}', connect_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'count'] = options.count if !options.count.nil?
+      query_params[:'domain_users_only'] = options.domain_users_only if !options.domain_users_only.nil?
+      query_params[:'email_substring'] = options.email_substring if !options.email_substring.nil?
+      query_params[:'start_position'] = options.start_position if !options.start_position.nil?
+      query_params[:'status'] = options.status if !options.status.nil?
+      query_params[:'user_name_substring'] = options.user_name_substring if !options.user_name_substring.nil?
+
+      # 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 => 'IntegratedConnectUserInfoList')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConnectApi#get_connect_all_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Sets the Connect OAuth Config for the account.
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @return [ConnectOAuthConfig]
+    def get_connect_o_auth_config(account_id)
+      data, _status_code, _headers = get_connect_o_auth_config_with_http_info(account_id)
+      return data
+    end
+
+    # Sets the Connect OAuth Config for the account.
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @return [Array<(ConnectOAuthConfig, Fixnum, Hash)>] ConnectOAuthConfig data, response status code and response headers
+    def get_connect_o_auth_config_with_http_info(account_id)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ConnectApi.get_connect_o_auth_config ..."
+      end
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.get_connect_o_auth_config" if account_id.nil?
+      # resource path
+      local_var_path = "/v2.1/accounts/{accountId}/connect/oauth".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 => 'ConnectOAuthConfig')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConnectApi#get_connect_o_auth_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get the specified Connect log entry.
     # Retrieves the specified Connect log entry for your account.  ###### Note: The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded. 
     # @param account_id The external account number (int) or account ID Guid.

data/lib/docusign_esign/api/email_archive_api.rb

@@ -46,7 +46,7 @@ module DocuSign_eSign
     end
 
     # Creates a blind carbon copy email archive entry
-    # 
+    # This method creates a BCC email archive configuration for an account (adds a BCC email address to the account for archiving the emails that DocuSign generates).  The only property that you must set in the request body is the BCC email address that you want to use.  **Note:** An account can have up to five active and pending email archive addresses combined, but you must use this method to add them to the account one at a time. Each email address is considered a separate BCC email archive configuration. 
     # @param account_id The external account number (int) or account ID Guid.
     # @param bcc_email_archive  (optional parameter)
     # @return [BccEmailArchive]
@@ -56,7 +56,7 @@ module DocuSign_eSign
     end
 
     # Creates a blind carbon copy email archive entry
-    # 
+    # This method creates a BCC email archive configuration for an account (adds a BCC email address to the account for archiving the emails that DocuSign generates).  The only property that you must set in the request body is the BCC email address that you want to use.  **Note:** An account can have up to five active and pending email archive addresses combined, but you must use this method to add them to the account one at a time. Each email address is considered a separate BCC email archive configuration. 
     # @param account_id The external account number (int) or account ID Guid.
     # @param bcc_email_archive  (optional parameter)
     # @return [Array<(BccEmailArchive, Fixnum, Hash)>] BccEmailArchive data, response status code and response headers
@@ -97,7 +97,7 @@ module DocuSign_eSign
     end
 
     # Delete a blind carbon copy email archive for an account.
-    # 
+    # This method deletes a BCC email archive configuration from an account.  When you use this method, the status of the BCC email archive configuration switches to `closed` and the BCC email address is no longer used to archive DocuSign-generated email messages. 
     # @param account_id The external account number (int) or account ID Guid.
     # @param bcc_email_archive_id 
     # @return [nil]
@@ -107,7 +107,7 @@ module DocuSign_eSign
     end
 
     # Delete a blind carbon copy email archive for an account.
-    # 
+    # This method deletes a BCC email archive configuration from an account.  When you use this method, the status of the BCC email archive configuration switches to &#x60;closed&#x60; and the BCC email address is no longer used to archive DocuSign-generated email messages. 
     # @param account_id The external account number (int) or account ID Guid.
     # @param bcc_email_archive_id 
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -149,7 +149,7 @@ module DocuSign_eSign
     end
 
     # Get the blind carbon copy email archive history entries for the specified archive
-    # 
+    # This method returns a specific BCC email archive configuration for an account, as well as the history of changes to the email address.
     # @param account_id The external account number (int) or account ID Guid.
     # @param bcc_email_archive_id 
     # @param DocuSign_eSign::GetBCCEmailArchiveHistoryListOptions Options for modifying the behavior of the function.
@@ -160,7 +160,7 @@ module DocuSign_eSign
     end
 
     # Get the blind carbon copy email archive history entries for the specified archive
-    # 
+    # This method returns a specific BCC email archive configuration for an account, as well as the history of changes to the email address.
     # @param account_id The external account number (int) or account ID Guid.
     # @param bcc_email_archive_id 
     # @param DocuSign_eSign::GetBCCEmailArchiveHistoryListOptions Options for modifying the behavior of the function.
@@ -206,7 +206,7 @@ module DocuSign_eSign
     end
 
     # Get the blind carbon copy email archive entries owned by the specified account
-    # 
+    # This method retrieves all of the BCC email archive configurations associated with an account.
     # @param account_id The external account number (int) or account ID Guid.
     # @param DocuSign_eSign::GetBCCEmailArchiveListOptions Options for modifying the behavior of the function.
     # @return [BccEmailArchiveList]
@@ -216,7 +216,7 @@ module DocuSign_eSign
     end
 
     # Get the blind carbon copy email archive entries owned by the specified account
-    # 
+    # This method retrieves all of the BCC email archive configurations associated with an account.
     # @param account_id The external account number (int) or account ID Guid.
     # @param DocuSign_eSign::GetBCCEmailArchiveListOptions Options for modifying the behavior of the function.
     # @return [Array<(BccEmailArchiveList, Fixnum, Hash)>] BccEmailArchiveList data, response status code and response headers