class DocuSign_eSign::WorkspacesApi

create_workspace(account_id, workspace) click to toggle source

Create a Workspace Creates a new workspace. @param account_id The external account number (int) or account ID Guid. @param workspace (optional parameter) @return [Workspace]

# File lib/docusign_esign/api/workspaces_api.rb, line 89
def create_workspace(account_id, workspace)
  data, _status_code, _headers = create_workspace_with_http_info(account_id,  workspace)
  return data
end

create_workspace_file(account_id, folder_id, workspace_id) click to toggle source

Creates a workspace file. This method adds a file to a workspace. @param account_id The external account number (int) or account ID Guid. @param folder_id The ID of the folder being accessed. @param workspace_id Specifies the workspace ID GUID. @return [WorkspaceItem]

# File lib/docusign_esign/api/workspaces_api.rb, line 141
def create_workspace_file(account_id, folder_id, workspace_id)
  data, _status_code, _headers = create_workspace_file_with_http_info(account_id, folder_id, workspace_id)
  return data
end

create_workspace_file_with_http_info(account_id, folder_id, workspace_id) click to toggle source

Creates a workspace file. This method adds a file to a workspace. @param account_id The external account number (int) or account ID Guid. @param folder_id The ID of the folder being accessed. @param workspace_id Specifies the workspace ID GUID. @return [Array<(WorkspaceItem, Fixnum, Hash)>] WorkspaceItem data, response status code and response headers

# File lib/docusign_esign/api/workspaces_api.rb, line 152
def create_workspace_file_with_http_info(account_id, folder_id, workspace_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkspacesApi.create_workspace_file ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling WorkspacesApi.create_workspace_file" if account_id.nil?
  # verify the required parameter 'folder_id' is set
  fail ArgumentError, "Missing the required parameter 'folder_id' when calling WorkspacesApi.create_workspace_file" if folder_id.nil?
  # verify the required parameter 'workspace_id' is set
  fail ArgumentError, "Missing the required parameter 'workspace_id' when calling WorkspacesApi.create_workspace_file" if workspace_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'folderId' + '}', folder_id.to_s).sub('{' + 'workspaceId' + '}', workspace_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(: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 => 'WorkspaceItem')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkspacesApi#create_workspace_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

create_workspace_with_http_info(account_id, workspace) click to toggle source

Create a Workspace Creates a new workspace. @param account_id The external account number (int) or account ID Guid. @param workspace (optional parameter) @return [Array<(Workspace, Fixnum, Hash)>] Workspace data, response status code and response headers

# File lib/docusign_esign/api/workspaces_api.rb, line 99
def create_workspace_with_http_info(account_id, workspace)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkspacesApi.create_workspace ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling WorkspacesApi.create_workspace" if account_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/workspaces".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(workspace)
  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 => 'Workspace')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkspacesApi#create_workspace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

delete_workspace(account_id, workspace_id) click to toggle source

Delete Workspace Deletes an existing workspace (logically). @param account_id The external account number (int) or account ID Guid. @param workspace_id Specifies the workspace ID GUID. @return [Workspace]

# File lib/docusign_esign/api/workspaces_api.rb, line 197
def delete_workspace(account_id, workspace_id)
  data, _status_code, _headers = delete_workspace_with_http_info(account_id, workspace_id)
  return data
end

delete_workspace_folder_items(account_id, folder_id, workspace_id, workspace_item_list) click to toggle source

Deletes workspace one or more specific files/folders from the given folder or root. This method deletes one or more files or sub-folders from a workspace folder or root. Note: To delete items from a workspace, the `status` of the workspace must be `active`. @param account_id The external account number (int) or account ID Guid. @param folder_id The ID of the folder being accessed. @param workspace_id Specifies the workspace ID GUID. @param workspace_item_list (optional parameter) @return [nil]

# File lib/docusign_esign/api/workspaces_api.rb, line 252
def delete_workspace_folder_items(account_id, folder_id, workspace_id, workspace_item_list)
  delete_workspace_folder_items_with_http_info(account_id, folder_id, workspace_id,  workspace_item_list)
  return nil
end

delete_workspace_folder_items_with_http_info(account_id, folder_id, workspace_id, workspace_item_list) click to toggle source

Deletes workspace one or more specific files/folders from the given folder or root. This method deletes one or more files or sub-folders from a workspace folder or root. Note: To delete items from a workspace, the `status` of the workspace must be `active`. @param account_id The external account number (int) or account ID Guid. @param folder_id The ID of the folder being accessed. @param workspace_id Specifies the workspace ID GUID. @param workspace_item_list (optional parameter) @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/docusign_esign/api/workspaces_api.rb, line 264
def delete_workspace_folder_items_with_http_info(account_id, folder_id, workspace_id, workspace_item_list)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkspacesApi.delete_workspace_folder_items ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling WorkspacesApi.delete_workspace_folder_items" if account_id.nil?
  # verify the required parameter 'folder_id' is set
  fail ArgumentError, "Missing the required parameter 'folder_id' when calling WorkspacesApi.delete_workspace_folder_items" if folder_id.nil?
  # verify the required parameter 'workspace_id' is set
  fail ArgumentError, "Missing the required parameter 'workspace_id' when calling WorkspacesApi.delete_workspace_folder_items" if workspace_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'folderId' + '}', folder_id.to_s).sub('{' + 'workspaceId' + '}', workspace_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(workspace_item_list)
  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: WorkspacesApi#delete_workspace_folder_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

delete_workspace_with_http_info(account_id, workspace_id) click to toggle source

Delete Workspace Deletes an existing workspace (logically). @param account_id The external account number (int) or account ID Guid. @param workspace_id Specifies the workspace ID GUID. @return [Array<(Workspace, Fixnum, Hash)>] Workspace data, response status code and response headers

# File lib/docusign_esign/api/workspaces_api.rb, line 207
def delete_workspace_with_http_info(account_id, workspace_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkspacesApi.delete_workspace ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling WorkspacesApi.delete_workspace" if account_id.nil?
  # verify the required parameter 'workspace_id' is set
  fail ArgumentError, "Missing the required parameter 'workspace_id' when calling WorkspacesApi.delete_workspace" if workspace_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/workspaces/{workspaceId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'workspaceId' + '}', workspace_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,
    :return_type => 'Workspace')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkspacesApi#delete_workspace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

get_workspace(account_id, workspace_id) click to toggle source

Get Workspace Retrives properties about a workspace given a unique workspaceId. @param account_id The external account number (int) or account ID Guid. @param workspace_id Specifies the workspace ID GUID. @return [Workspace]

# File lib/docusign_esign/api/workspaces_api.rb, line 308
def get_workspace(account_id, workspace_id)
  data, _status_code, _headers = get_workspace_with_http_info(account_id, workspace_id)
  return data
end

get_workspace_file(account_id, file_id, folder_id, workspace_id, options = DocuSign_eSign::GetWorkspaceFileOptions.default) click to toggle source

Get Workspace File Retrieves a workspace file (the binary). @param account_id The external account number (int) or account ID Guid. @param file_id Specifies the room file ID GUID. @param folder_id The ID of the folder being accessed. @param workspace_id Specifies the workspace ID GUID. @param DocuSign_eSign::GetWorkspaceFileOptions Options for modifying the behavior of the function. @return [nil]

# File lib/docusign_esign/api/workspaces_api.rb, line 364
def get_workspace_file(account_id, file_id, folder_id, workspace_id, options = DocuSign_eSign::GetWorkspaceFileOptions.default)
  get_workspace_file_with_http_info(account_id, file_id, folder_id, workspace_id, options)
  return nil
end

get_workspace_file_with_http_info(account_id, file_id, folder_id, workspace_id, options = DocuSign_eSign::GetWorkspaceFileOptions.default) click to toggle source

Get Workspace File Retrieves a workspace file (the binary). @param account_id The external account number (int) or account ID Guid. @param file_id Specifies the room file ID GUID. @param folder_id The ID of the folder being accessed. @param workspace_id Specifies the workspace ID GUID. @param DocuSign_eSign::GetWorkspaceFileOptions Options for modifying the behavior of the function. @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/docusign_esign/api/workspaces_api.rb, line 377
def get_workspace_file_with_http_info(account_id, file_id, folder_id, workspace_id, options = DocuSign_eSign::GetWorkspaceFileOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkspacesApi.get_workspace_file ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling WorkspacesApi.get_workspace_file" if account_id.nil?
  # verify the required parameter 'file_id' is set
  fail ArgumentError, "Missing the required parameter 'file_id' when calling WorkspacesApi.get_workspace_file" if file_id.nil?
  # verify the required parameter 'folder_id' is set
  fail ArgumentError, "Missing the required parameter 'folder_id' when calling WorkspacesApi.get_workspace_file" if folder_id.nil?
  # verify the required parameter 'workspace_id' is set
  fail ArgumentError, "Missing the required parameter 'workspace_id' when calling WorkspacesApi.get_workspace_file" if workspace_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'fileId' + '}', file_id.to_s).sub('{' + 'folderId' + '}', folder_id.to_s).sub('{' + 'workspaceId' + '}', workspace_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'is_download'] = options.is_download if !options.is_download.nil?
  query_params[:'pdf_version'] = options.pdf_version if !options.pdf_version.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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkspacesApi#get_workspace_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

get_workspace_with_http_info(account_id, workspace_id) click to toggle source

Get Workspace Retrives properties about a workspace given a unique workspaceId. @param account_id The external account number (int) or account ID Guid. @param workspace_id Specifies the workspace ID GUID. @return [Array<(Workspace, Fixnum, Hash)>] Workspace data, response status code and response headers

# File lib/docusign_esign/api/workspaces_api.rb, line 318
def get_workspace_with_http_info(account_id, workspace_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkspacesApi.get_workspace ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling WorkspacesApi.get_workspace" if account_id.nil?
  # verify the required parameter 'workspace_id' is set
  fail ArgumentError, "Missing the required parameter 'workspace_id' when calling WorkspacesApi.get_workspace" if workspace_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/workspaces/{workspaceId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'workspaceId' + '}', workspace_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 => 'Workspace')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkspacesApi#get_workspace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

list_workspace_file_pages(account_id, file_id, folder_id, workspace_id, options = DocuSign_eSign::ListWorkspaceFilePagesOptions.default) click to toggle source

List File Pages Retrieves a workspace file as rasterized pages. @param account_id The external account number (int) or account ID Guid. @param file_id Specifies the room file ID GUID. @param folder_id The ID of the folder being accessed. @param workspace_id Specifies the workspace ID GUID. @param DocuSign_eSign::ListWorkspaceFilePagesOptions Options for modifying the behavior of the function. @return [PageImages]

# File lib/docusign_esign/api/workspaces_api.rb, line 428
def list_workspace_file_pages(account_id, file_id, folder_id, workspace_id, options = DocuSign_eSign::ListWorkspaceFilePagesOptions.default)
  data, _status_code, _headers = list_workspace_file_pages_with_http_info(account_id, file_id, folder_id, workspace_id, options)
  return data
end

list_workspace_file_pages_with_http_info(account_id, file_id, folder_id, workspace_id, options = DocuSign_eSign::ListWorkspaceFilePagesOptions.default) click to toggle source

List File Pages Retrieves a workspace file as rasterized pages. @param account_id The external account number (int) or account ID Guid. @param file_id Specifies the room file ID GUID. @param folder_id The ID of the folder being accessed. @param workspace_id Specifies the workspace ID GUID. @param DocuSign_eSign::ListWorkspaceFilePagesOptions Options for modifying the behavior of the function. @return [Array<(PageImages, Fixnum, Hash)>] PageImages data, response status code and response headers

# File lib/docusign_esign/api/workspaces_api.rb, line 441
def list_workspace_file_pages_with_http_info(account_id, file_id, folder_id, workspace_id, options = DocuSign_eSign::ListWorkspaceFilePagesOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkspacesApi.list_workspace_file_pages ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling WorkspacesApi.list_workspace_file_pages" if account_id.nil?
  # verify the required parameter 'file_id' is set
  fail ArgumentError, "Missing the required parameter 'file_id' when calling WorkspacesApi.list_workspace_file_pages" if file_id.nil?
  # verify the required parameter 'folder_id' is set
  fail ArgumentError, "Missing the required parameter 'folder_id' when calling WorkspacesApi.list_workspace_file_pages" if folder_id.nil?
  # verify the required parameter 'workspace_id' is set
  fail ArgumentError, "Missing the required parameter 'workspace_id' when calling WorkspacesApi.list_workspace_file_pages" if workspace_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}/pages".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'fileId' + '}', file_id.to_s).sub('{' + 'folderId' + '}', folder_id.to_s).sub('{' + 'workspaceId' + '}', workspace_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'count'] = options.count if !options.count.nil?
  query_params[:'dpi'] = options.dpi if !options.dpi.nil?
  query_params[:'max_height'] = options.max_height if !options.max_height.nil?
  query_params[:'max_width'] = options.max_width if !options.max_width.nil?
  query_params[:'start_position'] = options.start_position if !options.start_position.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 => 'PageImages')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkspacesApi#list_workspace_file_pages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

list_workspace_folder_items(account_id, folder_id, workspace_id, options = DocuSign_eSign::ListWorkspaceFolderItemsOptions.default) click to toggle source

List Workspace Folder Contents Retrieves workspace folder contents, which can include sub folders and files. @param account_id The external account number (int) or account ID Guid. @param folder_id The ID of the folder being accessed. @param workspace_id Specifies the workspace ID GUID. @param DocuSign_eSign::ListWorkspaceFolderItemsOptions Options for modifying the behavior of the function. @return [WorkspaceFolderContents]

# File lib/docusign_esign/api/workspaces_api.rb, line 495
def list_workspace_folder_items(account_id, folder_id, workspace_id, options = DocuSign_eSign::ListWorkspaceFolderItemsOptions.default)
  data, _status_code, _headers = list_workspace_folder_items_with_http_info(account_id, folder_id, workspace_id, options)
  return data
end

list_workspace_folder_items_with_http_info(account_id, folder_id, workspace_id, options = DocuSign_eSign::ListWorkspaceFolderItemsOptions.default) click to toggle source

List Workspace Folder Contents Retrieves workspace folder contents, which can include sub folders and files. @param account_id The external account number (int) or account ID Guid. @param folder_id The ID of the folder being accessed. @param workspace_id Specifies the workspace ID GUID. @param DocuSign_eSign::ListWorkspaceFolderItemsOptions Options for modifying the behavior of the function. @return [Array<(WorkspaceFolderContents, Fixnum, Hash)>] WorkspaceFolderContents data, response status code and response headers

# File lib/docusign_esign/api/workspaces_api.rb, line 507
def list_workspace_folder_items_with_http_info(account_id, folder_id, workspace_id, options = DocuSign_eSign::ListWorkspaceFolderItemsOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkspacesApi.list_workspace_folder_items ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling WorkspacesApi.list_workspace_folder_items" if account_id.nil?
  # verify the required parameter 'folder_id' is set
  fail ArgumentError, "Missing the required parameter 'folder_id' when calling WorkspacesApi.list_workspace_folder_items" if folder_id.nil?
  # verify the required parameter 'workspace_id' is set
  fail ArgumentError, "Missing the required parameter 'workspace_id' when calling WorkspacesApi.list_workspace_folder_items" if workspace_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'folderId' + '}', folder_id.to_s).sub('{' + 'workspaceId' + '}', workspace_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'count'] = options.count if !options.count.nil?
  query_params[:'include_files'] = options.include_files if !options.include_files.nil?
  query_params[:'include_sub_folders'] = options.include_sub_folders if !options.include_sub_folders.nil?
  query_params[:'include_thumbnails'] = options.include_thumbnails if !options.include_thumbnails.nil?
  query_params[:'include_user_detail'] = options.include_user_detail if !options.include_user_detail.nil?
  query_params[:'start_position'] = options.start_position if !options.start_position.nil?
  query_params[:'workspace_user_id'] = options.workspace_user_id if !options.workspace_user_id.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 => 'WorkspaceFolderContents')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkspacesApi#list_workspace_folder_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

list_workspaces(account_id) click to toggle source

List Workspaces Gets information about the Workspaces that have been created. @param account_id The external account number (int) or account ID Guid. @return [WorkspaceList]

# File lib/docusign_esign/api/workspaces_api.rb, line 558
def list_workspaces(account_id)
  data, _status_code, _headers = list_workspaces_with_http_info(account_id)
  return data
end

list_workspaces_with_http_info(account_id) click to toggle source

List Workspaces Gets information about the Workspaces that have been created. @param account_id The external account number (int) or account ID Guid. @return [Array<(WorkspaceList, Fixnum, Hash)>] WorkspaceList data, response status code and response headers

# File lib/docusign_esign/api/workspaces_api.rb, line 567
def list_workspaces_with_http_info(account_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkspacesApi.list_workspaces ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling WorkspacesApi.list_workspaces" if account_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/workspaces".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 => 'WorkspaceList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkspacesApi#list_workspaces\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

update_workspace(account_id, workspace_id, workspace) click to toggle source

Update Workspace Updates information about a specific workspace. @param account_id The external account number (int) or account ID Guid. @param workspace_id Specifies the workspace ID GUID. @param workspace (optional parameter) @return [Workspace]

# File lib/docusign_esign/api/workspaces_api.rb, line 609
def update_workspace(account_id, workspace_id, workspace)
  data, _status_code, _headers = update_workspace_with_http_info(account_id, workspace_id,  workspace)
  return data
end

update_workspace_file(account_id, file_id, folder_id, workspace_id) click to toggle source

Update Workspace File Metadata Updates workspace item metadata for one or more specific files/folders. @param account_id The external account number (int) or account ID Guid. @param file_id Specifies the room file ID GUID. @param folder_id The ID of the folder being accessed. @param workspace_id Specifies the workspace ID GUID. @return [WorkspaceItem]

# File lib/docusign_esign/api/workspaces_api.rb, line 665
def update_workspace_file(account_id, file_id, folder_id, workspace_id)
  data, _status_code, _headers = update_workspace_file_with_http_info(account_id, file_id, folder_id, workspace_id)
  return data
end

update_workspace_file_with_http_info(account_id, file_id, folder_id, workspace_id) click to toggle source

Update Workspace File Metadata Updates workspace item metadata for one or more specific files/folders. @param account_id The external account number (int) or account ID Guid. @param file_id Specifies the room file ID GUID. @param folder_id The ID of the folder being accessed. @param workspace_id Specifies the workspace ID GUID. @return [Array<(WorkspaceItem, Fixnum, Hash)>] WorkspaceItem data, response status code and response headers

# File lib/docusign_esign/api/workspaces_api.rb, line 677
def update_workspace_file_with_http_info(account_id, file_id, folder_id, workspace_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkspacesApi.update_workspace_file ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling WorkspacesApi.update_workspace_file" if account_id.nil?
  # verify the required parameter 'file_id' is set
  fail ArgumentError, "Missing the required parameter 'file_id' when calling WorkspacesApi.update_workspace_file" if file_id.nil?
  # verify the required parameter 'folder_id' is set
  fail ArgumentError, "Missing the required parameter 'folder_id' when calling WorkspacesApi.update_workspace_file" if folder_id.nil?
  # verify the required parameter 'workspace_id' is set
  fail ArgumentError, "Missing the required parameter 'workspace_id' when calling WorkspacesApi.update_workspace_file" if workspace_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'fileId' + '}', file_id.to_s).sub('{' + 'folderId' + '}', folder_id.to_s).sub('{' + 'workspaceId' + '}', workspace_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(: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 => 'WorkspaceItem')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkspacesApi#update_workspace_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

update_workspace_with_http_info(account_id, workspace_id, workspace) click to toggle source

Update Workspace Updates information about a specific workspace. @param account_id The external account number (int) or account ID Guid. @param workspace_id Specifies the workspace ID GUID. @param workspace (optional parameter) @return [Array<(Workspace, Fixnum, Hash)>] Workspace data, response status code and response headers

# File lib/docusign_esign/api/workspaces_api.rb, line 620
def update_workspace_with_http_info(account_id, workspace_id, workspace)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkspacesApi.update_workspace ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling WorkspacesApi.update_workspace" if account_id.nil?
  # verify the required parameter 'workspace_id' is set
  fail ArgumentError, "Missing the required parameter 'workspace_id' when calling WorkspacesApi.update_workspace" if workspace_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/workspaces/{workspaceId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'workspaceId' + '}', workspace_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(workspace)
  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 => 'Workspace')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkspacesApi#update_workspace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

class DocuSign_eSign::WorkspacesApi

Attributes

Public Class Methods

Public Instance Methods