lib/purecloud/api/content_management_api.rb in purecloud-0.50.1 vs lib/purecloud/api/content_management_api.rb in purecloud-0.51.1
- old
+ new
@@ -397,11 +397,11 @@
# Get a list of documents.
#
# @param workspace_id Workspace ID
# @param [Hash] opts the optional parameters
# @option opts [String] :name Name
- # @option opts [String] :expand Expand some document fields
+ # @option opts [Array<String>] :expand Which fields, if any, to expand.
# @option opts [Integer] :page_size Page size (default to 25)
# @option opts [Integer] :page_number Page number (default to 1)
# @option opts [String] :sort_by name or dateCreated
# @option opts [String] :sort_order ascending or descending (default to ascending)
# @return [DocumentEntityListing]
@@ -413,11 +413,11 @@
# Get a list of documents.
#
# @param workspace_id Workspace ID
# @param [Hash] opts the optional parameters
# @option opts [String] :name Name
- # @option opts [String] :expand Expand some document fields
+ # @option opts [Array<String>] :expand Which fields, if any, to expand.
# @option opts [Integer] :page_size Page size
# @option opts [Integer] :page_number Page number
# @option opts [String] :sort_by name or dateCreated
# @option opts [String] :sort_order ascending or descending
# @return [Array<(DocumentEntityListing, Fixnum, Hash)>] DocumentEntityListing data, response status code and response headers
@@ -427,22 +427,18 @@
end
# verify the required parameter 'workspace_id' is set
fail "Missing the required parameter 'workspace_id' when calling get_documents" if workspace_id.nil?
- if opts[:'expand'] && !['acl', 'workspace'].include?(opts[:'expand'])
- fail 'invalid value for "expand", must be one of acl, workspace'
- end
-
# resource path
local_var_path = "/api/v2/contentmanagement/documents".sub('{format}','json')
# query parameters
query_params = {}
query_params[:'workspaceId'] = workspace_id
query_params[:'name'] = opts[:'name'] if opts[:'name']
- query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
@@ -479,41 +475,37 @@
# Get a document.
#
# @param document_id Document ID
# @param [Hash] opts the optional parameters
- # @option opts [String] :expand Expand some document fields
+ # @option opts [Array<String>] :expand Which fields, if any, to expand.
# @return [Document]
def get_documents_document_id(document_id, opts = {})
data, status_code, headers = get_documents_document_id_with_http_info(document_id, opts)
return data
end
# Get a document.
#
# @param document_id Document ID
# @param [Hash] opts the optional parameters
- # @option opts [String] :expand Expand some document fields
+ # @option opts [Array<String>] :expand Which fields, if any, to expand.
# @return [Array<(Document, Fixnum, Hash)>] Document data, response status code and response headers
def get_documents_document_id_with_http_info(document_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug "Calling API: ContentManagementApi#get_documents_document_id ..."
end
# verify the required parameter 'document_id' is set
fail "Missing the required parameter 'document_id' when calling get_documents_document_id" if document_id.nil?
- if opts[:'expand'] && !['lockInfo', 'acl', 'workspace'].include?(opts[:'expand'])
- fail 'invalid value for "expand", must be one of lockInfo, acl, workspace'
- end
-
# resource path
local_var_path = "/api/v2/contentmanagement/documents/{documentId}".sub('{format}','json').sub('{' + 'documentId' + '}', document_id.to_s)
# query parameters
query_params = {}
- query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
# header parameters
header_params = {}
# HTTP header 'Accept' (if needed)
@@ -624,25 +616,25 @@
# Download a document.
#
# @param document_id Document ID
# @param [Hash] opts the optional parameters
- # @option opts [String] :disposition Request how the content will be downloaded: attached as a file or inline. Default is attachment.
+ # @option opts [String] :disposition Request how the content will be downloaded: a file attachment or inline. Default is attachment.
# @option opts [String] :content_type The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav
- # @return [nil]
+ # @return [DownloadResponse]
def get_documents_document_id_content(document_id, opts = {})
- get_documents_document_id_content_with_http_info(document_id, opts)
- return nil
+ data, status_code, headers = get_documents_document_id_content_with_http_info(document_id, opts)
+ return data
end
# Download a document.
#
# @param document_id Document ID
# @param [Hash] opts the optional parameters
- # @option opts [String] :disposition Request how the content will be downloaded: attached as a file or inline. Default is attachment.
+ # @option opts [String] :disposition Request how the content will be downloaded: a file attachment or inline. Default is attachment.
# @option opts [String] :content_type The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+ # @return [Array<(DownloadResponse, Fixnum, Hash)>] DownloadResponse data, response status code and response headers
def get_documents_document_id_content_with_http_info(document_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug "Calling API: ContentManagementApi#get_documents_document_id_content ..."
end
@@ -682,11 +674,12 @@
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)
+ :auth_names => auth_names,
+ :return_type => 'DownloadResponse')
if @api_client.config.debugging
@api_client.config.logger.debug "API called: ContentManagementApi#get_documents_document_id_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
@@ -697,11 +690,11 @@
# @param [Hash] opts the optional parameters
# @option opts [Integer] :page_size Page size (default to 25)
# @option opts [Integer] :page_number Page number (default to 1)
# @option opts [String] :sort_by name or dateCreated (default to name)
# @option opts [String] :sort_order ascending or descending (default to ascending)
- # @option opts [String] :expand Expand some document fields
+ # @option opts [Array<String>] :expand Which fields, if any, to expand.
# @return [QueryResults]
def get_query(query_phrase, opts = {})
data, status_code, headers = get_query_with_http_info(query_phrase, opts)
return data
end
@@ -712,35 +705,31 @@
# @param [Hash] opts the optional parameters
# @option opts [Integer] :page_size Page size
# @option opts [Integer] :page_number Page number
# @option opts [String] :sort_by name or dateCreated
# @option opts [String] :sort_order ascending or descending
- # @option opts [String] :expand Expand some document fields
+ # @option opts [Array<String>] :expand Which fields, if any, to expand.
# @return [Array<(QueryResults, Fixnum, Hash)>] QueryResults data, response status code and response headers
def get_query_with_http_info(query_phrase, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug "Calling API: ContentManagementApi#get_query ..."
end
# verify the required parameter 'query_phrase' is set
fail "Missing the required parameter 'query_phrase' when calling get_query" if query_phrase.nil?
- if opts[:'expand'] && !['acl', 'workspace'].include?(opts[:'expand'])
- fail 'invalid value for "expand", must be one of acl, workspace'
- end
-
# resource path
local_var_path = "/api/v2/contentmanagement/query".sub('{format}','json')
# query parameters
query_params = {}
query_params[:'queryPhrase'] = query_phrase
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
- query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
# header parameters
header_params = {}
# HTTP header 'Accept' (if needed)
@@ -967,11 +956,11 @@
# Gets a list of shares. You must specify at least one filter (e.g. entityId).
# Failing to specify a filter will return 400.
# @param [Hash] opts the optional parameters
# @option opts [String] :entity_id Filters the shares returned to only the entity specified by the value of this parameter.
- # @option opts [String] :expand Expand share fields
+ # @option opts [Array<String>] :expand Which fields, if any, to expand.
# @option opts [Integer] :page_size Page size (default to 25)
# @option opts [Integer] :page_number Page number (default to 1)
# @return [ShareEntityListing]
def get_shares(opts = {})
data, status_code, headers = get_shares_with_http_info(opts)
@@ -980,30 +969,26 @@
# Gets a list of shares. You must specify at least one filter (e.g. entityId).
# Failing to specify a filter will return 400.
# @param [Hash] opts the optional parameters
# @option opts [String] :entity_id Filters the shares returned to only the entity specified by the value of this parameter.
- # @option opts [String] :expand Expand share fields
+ # @option opts [Array<String>] :expand Which fields, if any, to expand.
# @option opts [Integer] :page_size Page size
# @option opts [Integer] :page_number Page number
# @return [Array<(ShareEntityListing, Fixnum, Hash)>] ShareEntityListing data, response status code and response headers
def get_shares_with_http_info(opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug "Calling API: ContentManagementApi#get_shares ..."
end
- if opts[:'expand'] && !['member'].include?(opts[:'expand'])
- fail 'invalid value for "expand", must be one of member'
- end
-
# resource path
local_var_path = "/api/v2/contentmanagement/shares".sub('{format}','json')
# query parameters
query_params = {}
query_params[:'entityId'] = opts[:'entity_id'] if opts[:'entity_id']
- query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
# header parameters
header_params = {}
@@ -1038,41 +1023,37 @@
# Retrieve details about an existing share.
#
# @param share_id Share ID
# @param [Hash] opts the optional parameters
- # @option opts [String] :expand Expand share fields
+ # @option opts [Array<String>] :expand Which fields, if any, to expand.
# @return [Share]
def get_shares_share_id(share_id, opts = {})
data, status_code, headers = get_shares_share_id_with_http_info(share_id, opts)
return data
end
# Retrieve details about an existing share.
#
# @param share_id Share ID
# @param [Hash] opts the optional parameters
- # @option opts [String] :expand Expand share fields
+ # @option opts [Array<String>] :expand Which fields, if any, to expand.
# @return [Array<(Share, Fixnum, Hash)>] Share data, response status code and response headers
def get_shares_share_id_with_http_info(share_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug "Calling API: ContentManagementApi#get_shares_share_id ..."
end
# verify the required parameter 'share_id' is set
fail "Missing the required parameter 'share_id' when calling get_shares_share_id" if share_id.nil?
- if opts[:'expand'] && !['member'].include?(opts[:'expand'])
- fail 'invalid value for "expand", must be one of member'
- end
-
# resource path
local_var_path = "/api/v2/contentmanagement/shares/{shareId}".sub('{format}','json').sub('{' + 'shareId' + '}', share_id.to_s)
# query parameters
query_params = {}
- query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
# header parameters
header_params = {}
# HTTP header 'Accept' (if needed)
@@ -1282,12 +1263,12 @@
# Get a list of workspaces.
# Specifying 'content' access will return all workspaces the user has document access to, while 'admin' access will return all group workspaces the user has administrative rights to.
# @param [Hash] opts the optional parameters
# @option opts [Integer] :page_size Page size (default to 25)
# @option opts [Integer] :page_number Page number (default to 1)
- # @option opts [String] :access Requested access level (default to document:viewmetadata)
- # @option opts [String] :expand Expand some workspace fields
+ # @option opts [Array<String>] :access Requested access level.
+ # @option opts [Array<String>] :expand Which fields, if any, to expand.
# @return [WorkspaceEntityListing]
def get_workspaces(opts = {})
data, status_code, headers = get_workspaces_with_http_info(opts)
return data
end
@@ -1295,35 +1276,27 @@
# Get a list of workspaces.
# Specifying 'content' access will return all workspaces the user has document access to, while 'admin' access will return all group workspaces the user has administrative rights to.
# @param [Hash] opts the optional parameters
# @option opts [Integer] :page_size Page size
# @option opts [Integer] :page_number Page number
- # @option opts [String] :access Requested access level
- # @option opts [String] :expand Expand some workspace fields
+ # @option opts [Array<String>] :access Requested access level.
+ # @option opts [Array<String>] :expand Which fields, if any, to expand.
# @return [Array<(WorkspaceEntityListing, Fixnum, Hash)>] WorkspaceEntityListing data, response status code and response headers
def get_workspaces_with_http_info(opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug "Calling API: ContentManagementApi#get_workspaces ..."
end
- if opts[:'access'] && !['content', 'admin', 'document:create', 'document:viewContent', 'document:viewMetadata', 'document:download', 'document:delete', 'document:update', 'document:share', 'document:shareView', 'document:email', 'document:print', 'document:auditView', 'document:replace', 'document:tag', 'tag:create', 'tag:view', 'tag:update', 'tag:apply', 'tag:remove', 'tag:delete'].include?(opts[:'access'])
- fail 'invalid value for "access", must be one of content, admin, document:create, document:viewContent, document:viewMetadata, document:download, document:delete, document:update, document:share, document:shareView, document:email, document:print, document:auditView, document:replace, document:tag, tag:create, tag:view, tag:update, tag:apply, tag:remove, tag:delete'
- end
-
- if opts[:'expand'] && !['summary', 'acl'].include?(opts[:'expand'])
- fail 'invalid value for "expand", must be one of summary, acl'
- end
-
# resource path
local_var_path = "/api/v2/contentmanagement/workspaces".sub('{format}','json')
# query parameters
query_params = {}
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
- query_params[:'access'] = opts[:'access'] if opts[:'access']
- query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
+ query_params[:'access'] = @api_client.build_collection_param(opts[:'access'], :multi) if opts[:'access']
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
# header parameters
header_params = {}
# HTTP header 'Accept' (if needed)
@@ -1356,41 +1329,37 @@
# Get a workspace.
#
# @param workspace_id Workspace ID
# @param [Hash] opts the optional parameters
- # @option opts [String] :expand Expand some workspace fields
+ # @option opts [Array<String>] :expand Which fields, if any, to expand.
# @return [Workspace]
def get_workspaces_workspace_id(workspace_id, opts = {})
data, status_code, headers = get_workspaces_workspace_id_with_http_info(workspace_id, opts)
return data
end
# Get a workspace.
#
# @param workspace_id Workspace ID
# @param [Hash] opts the optional parameters
- # @option opts [String] :expand Expand some workspace fields
+ # @option opts [Array<String>] :expand Which fields, if any, to expand.
# @return [Array<(Workspace, Fixnum, Hash)>] Workspace data, response status code and response headers
def get_workspaces_workspace_id_with_http_info(workspace_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug "Calling API: ContentManagementApi#get_workspaces_workspace_id ..."
end
# verify the required parameter 'workspace_id' is set
fail "Missing the required parameter 'workspace_id' when calling get_workspaces_workspace_id" if workspace_id.nil?
- if opts[:'expand'] && !['summary', 'acl'].include?(opts[:'expand'])
- fail 'invalid value for "expand", must be one of summary, acl'
- end
-
# resource path
local_var_path = "/api/v2/contentmanagement/workspaces/{workspaceId}".sub('{format}','json').sub('{' + 'workspaceId' + '}', workspace_id.to_s)
# query parameters
query_params = {}
- query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
# header parameters
header_params = {}
# HTTP header 'Accept' (if needed)
@@ -1425,11 +1394,11 @@
#
# @param workspace_id Workspace ID
# @param [Hash] opts the optional parameters
# @option opts [Integer] :page_size Page size (default to 25)
# @option opts [Integer] :page_number Page number (default to 1)
- # @option opts [String] :expand Expand workspace member fields
+ # @option opts [Array<String>] :expand Which fields, if any, to expand.
# @return [WorkspaceMemberEntityListing]
def get_workspaces_workspace_id_members(workspace_id, opts = {})
data, status_code, headers = get_workspaces_workspace_id_members_with_http_info(workspace_id, opts)
return data
end
@@ -1438,32 +1407,28 @@
#
# @param workspace_id Workspace ID
# @param [Hash] opts the optional parameters
# @option opts [Integer] :page_size Page size
# @option opts [Integer] :page_number Page number
- # @option opts [String] :expand Expand workspace member fields
+ # @option opts [Array<String>] :expand Which fields, if any, to expand.
# @return [Array<(WorkspaceMemberEntityListing, Fixnum, Hash)>] WorkspaceMemberEntityListing data, response status code and response headers
def get_workspaces_workspace_id_members_with_http_info(workspace_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug "Calling API: ContentManagementApi#get_workspaces_workspace_id_members ..."
end
# verify the required parameter 'workspace_id' is set
fail "Missing the required parameter 'workspace_id' when calling get_workspaces_workspace_id_members" if workspace_id.nil?
- if opts[:'expand'] && !['member'].include?(opts[:'expand'])
- fail 'invalid value for "expand", must be one of member'
- end
-
# resource path
local_var_path = "/api/v2/contentmanagement/workspaces/{workspaceId}/members".sub('{format}','json').sub('{' + 'workspaceId' + '}', workspace_id.to_s)
# query parameters
query_params = {}
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
- query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
# header parameters
header_params = {}
# HTTP header 'Accept' (if needed)
@@ -1497,11 +1462,11 @@
# Get a workspace member
#
# @param workspace_id Workspace ID
# @param member_id Member ID
# @param [Hash] opts the optional parameters
- # @option opts [String] :expand Expand workspace member fields
+ # @option opts [Array<String>] :expand Which fields, if any, to expand.
# @return [WorkspaceMember]
def get_workspaces_workspace_id_members_member_id(workspace_id, member_id, opts = {})
data, status_code, headers = get_workspaces_workspace_id_members_member_id_with_http_info(workspace_id, member_id, opts)
return data
end
@@ -1509,11 +1474,11 @@
# Get a workspace member
#
# @param workspace_id Workspace ID
# @param member_id Member ID
# @param [Hash] opts the optional parameters
- # @option opts [String] :expand Expand workspace member fields
+ # @option opts [Array<String>] :expand Which fields, if any, to expand.
# @return [Array<(WorkspaceMember, Fixnum, Hash)>] WorkspaceMember data, response status code and response headers
def get_workspaces_workspace_id_members_member_id_with_http_info(workspace_id, member_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug "Calling API: ContentManagementApi#get_workspaces_workspace_id_members_member_id ..."
end
@@ -1522,20 +1487,16 @@
fail "Missing the required parameter 'workspace_id' when calling get_workspaces_workspace_id_members_member_id" if workspace_id.nil?
# verify the required parameter 'member_id' is set
fail "Missing the required parameter 'member_id' when calling get_workspaces_workspace_id_members_member_id" if member_id.nil?
- if opts[:'expand'] && !['member'].include?(opts[:'expand'])
- fail 'invalid value for "expand", must be one of member'
- end
-
# resource path
local_var_path = "/api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}".sub('{format}','json').sub('{' + 'workspaceId' + '}', workspace_id.to_s).sub('{' + 'memberId' + '}', member_id.to_s)
# query parameters
query_params = {}
- query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
# header parameters
header_params = {}
# HTTP header 'Accept' (if needed)
@@ -1571,11 +1532,11 @@
# @param workspace_id Workspace ID
# @param [Hash] opts the optional parameters
# @option opts [String] :value filter the list of tags returned
# @option opts [Integer] :page_size Page size (default to 25)
# @option opts [Integer] :page_number Page number (default to 1)
- # @option opts [String] :expand Expand some document fields
+ # @option opts [Array<String>] :expand Which fields, if any, to expand.
# @return [TagValueEntityListing]
def get_workspaces_workspace_id_tagvalues(workspace_id, opts = {})
data, status_code, headers = get_workspaces_workspace_id_tagvalues_with_http_info(workspace_id, opts)
return data
end
@@ -1585,33 +1546,29 @@
# @param workspace_id Workspace ID
# @param [Hash] opts the optional parameters
# @option opts [String] :value filter the list of tags returned
# @option opts [Integer] :page_size Page size
# @option opts [Integer] :page_number Page number
- # @option opts [String] :expand Expand some document fields
+ # @option opts [Array<String>] :expand Which fields, if any, to expand.
# @return [Array<(TagValueEntityListing, Fixnum, Hash)>] TagValueEntityListing data, response status code and response headers
def get_workspaces_workspace_id_tagvalues_with_http_info(workspace_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug "Calling API: ContentManagementApi#get_workspaces_workspace_id_tagvalues ..."
end
# verify the required parameter 'workspace_id' is set
fail "Missing the required parameter 'workspace_id' when calling get_workspaces_workspace_id_tagvalues" if workspace_id.nil?
- if opts[:'expand'] && !['acl'].include?(opts[:'expand'])
- fail 'invalid value for "expand", must be one of acl'
- end
-
# resource path
local_var_path = "/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues".sub('{format}','json').sub('{' + 'workspaceId' + '}', workspace_id.to_s)
# query parameters
query_params = {}
query_params[:'value'] = opts[:'value'] if opts[:'value']
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
- query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
# header parameters
header_params = {}
# HTTP header 'Accept' (if needed)
@@ -1645,11 +1602,11 @@
# Get a workspace tag
#
# @param workspace_id Workspace ID
# @param tag_id Tag ID
# @param [Hash] opts the optional parameters
- # @option opts [String] :expand Expand some document fields
+ # @option opts [Array<String>] :expand Which fields, if any, to expand.
# @return [TagValue]
def get_workspaces_workspace_id_tagvalues_tag_id(workspace_id, tag_id, opts = {})
data, status_code, headers = get_workspaces_workspace_id_tagvalues_tag_id_with_http_info(workspace_id, tag_id, opts)
return data
end
@@ -1657,11 +1614,11 @@
# Get a workspace tag
#
# @param workspace_id Workspace ID
# @param tag_id Tag ID
# @param [Hash] opts the optional parameters
- # @option opts [String] :expand Expand some document fields
+ # @option opts [Array<String>] :expand Which fields, if any, to expand.
# @return [Array<(TagValue, Fixnum, Hash)>] TagValue data, response status code and response headers
def get_workspaces_workspace_id_tagvalues_tag_id_with_http_info(workspace_id, tag_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug "Calling API: ContentManagementApi#get_workspaces_workspace_id_tagvalues_tag_id ..."
end
@@ -1670,20 +1627,16 @@
fail "Missing the required parameter 'workspace_id' when calling get_workspaces_workspace_id_tagvalues_tag_id" if workspace_id.nil?
# verify the required parameter 'tag_id' is set
fail "Missing the required parameter 'tag_id' when calling get_workspaces_workspace_id_tagvalues_tag_id" if tag_id.nil?
- if opts[:'expand'] && !['acl'].include?(opts[:'expand'])
- fail 'invalid value for "expand", must be one of acl'
- end
-
# resource path
local_var_path = "/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}".sub('{format}','json').sub('{' + 'workspaceId' + '}', workspace_id.to_s).sub('{' + 'tagId' + '}', tag_id.to_s)
# query parameters
query_params = {}
- query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
# header parameters
header_params = {}
# HTTP header 'Accept' (if needed)
@@ -2241,11 +2194,11 @@
# Perform a prefix query on tags in the workspace
#
# @param workspace_id Workspace ID
# @param body query
# @param [Hash] opts the optional parameters
- # @option opts [String] :expand Expand some document fields
+ # @option opts [Array<String>] :expand Which fields, if any, to expand.
# @return [TagValueEntityListing]
def post_workspaces_workspace_id_tagvalues_query(workspace_id, body, opts = {})
data, status_code, headers = post_workspaces_workspace_id_tagvalues_query_with_http_info(workspace_id, body, opts)
return data
end
@@ -2253,11 +2206,11 @@
# Perform a prefix query on tags in the workspace
#
# @param workspace_id Workspace ID
# @param body query
# @param [Hash] opts the optional parameters
- # @option opts [String] :expand Expand some document fields
+ # @option opts [Array<String>] :expand Which fields, if any, to expand.
# @return [Array<(TagValueEntityListing, Fixnum, Hash)>] TagValueEntityListing data, response status code and response headers
def post_workspaces_workspace_id_tagvalues_query_with_http_info(workspace_id, body, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug "Calling API: ContentManagementApi#post_workspaces_workspace_id_tagvalues_query ..."
end
@@ -2266,20 +2219,16 @@
fail "Missing the required parameter 'workspace_id' when calling post_workspaces_workspace_id_tagvalues_query" if workspace_id.nil?
# verify the required parameter 'body' is set
fail "Missing the required parameter 'body' when calling post_workspaces_workspace_id_tagvalues_query" if body.nil?
- if opts[:'expand'] && !['acl'].include?(opts[:'expand'])
- fail 'invalid value for "expand", must be one of acl'
- end
-
# resource path
local_var_path = "/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/query".sub('{format}','json').sub('{' + 'workspaceId' + '}', workspace_id.to_s)
# query parameters
query_params = {}
- query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
# header parameters
header_params = {}
# HTTP header 'Accept' (if needed)
@@ -2377,11 +2326,11 @@
# Add a member to a workspace
#
# @param workspace_id Workspace ID
# @param member_id Member ID
- # @param body Workspace
+ # @param body Workspace Member
# @param [Hash] opts the optional parameters
# @return [WorkspaceMember]
def put_workspaces_workspace_id_members_member_id(workspace_id, member_id, body, opts = {})
data, status_code, headers = put_workspaces_workspace_id_members_member_id_with_http_info(workspace_id, member_id, body, opts)
return data
@@ -2389,10 +2338,10 @@
# Add a member to a workspace
#
# @param workspace_id Workspace ID
# @param member_id Member ID
- # @param body Workspace
+ # @param body Workspace Member
# @param [Hash] opts the optional parameters
# @return [Array<(WorkspaceMember, Fixnum, Hash)>] WorkspaceMember data, response status code and response headers
def put_workspaces_workspace_id_members_member_id_with_http_info(workspace_id, member_id, body, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug "Calling API: ContentManagementApi#put_workspaces_workspace_id_members_member_id ..."