Class: PureCloud::ContentManagementApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/api/content_management_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContentManagementApi

Returns a new instance of ContentManagementApi.



23
24
25
 
# File 'lib/purecloud/api/content_management_api.rb', line 23

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



21
22
23
 
# File 'lib/purecloud/api/content_management_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#delete_documents_document_id(document_id, opts = {}) ⇒ nil

Delete a document.

Parameters:

  • document_id —

    Document ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :override (BOOLEAN) —

    Override any lock on the document

Returns:

  • (nil) 


33
34
35
36
 
# File 'lib/purecloud/api/content_management_api.rb', line 33

def delete_documents_document_id(document_id, opts = {})
  delete_documents_document_id_with_http_info(document_id, opts)
  return nil
end

#delete_documents_document_id_with_http_info(document_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a document.

Parameters:

  • document_id —

    Document ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :override (BOOLEAN) —

    Override any lock on the document

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/purecloud/api/content_management_api.rb', line 44

def delete_documents_document_id_with_http_info(document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContentManagementApi#delete_documents_document_id ..."
  end
  
  # verify the required parameter 'document_id' is set
  fail "Missing the required parameter 'document_id' when calling delete_documents_document_id" if document_id.nil?
  
  # 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[:'override'] = opts[:'override'] if opts[:'override']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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: ContentManagementApi#delete_documents_document_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_shares_share_id(share_id, opts = {}) ⇒ nil

Deletes an existing share. This revokes sharing rights specified in the share record

Parameters:

  • share_id —

    Share ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


94
95
96
97
 
# File 'lib/purecloud/api/content_management_api.rb', line 94

def delete_shares_share_id(share_id, opts = {})
  delete_shares_share_id_with_http_info(share_id, opts)
  return nil
end

#delete_shares_share_id_with_http_info(share_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Deletes an existing share. This revokes sharing rights specified in the share record

Parameters:

  • share_id —

    Share ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/purecloud/api/content_management_api.rb', line 104

def delete_shares_share_id_with_http_info(share_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContentManagementApi#delete_shares_share_id ..."
  end
  
  # verify the required parameter 'share_id' is set
  fail "Missing the required parameter 'share_id' when calling delete_shares_share_id" if share_id.nil?
  
  # resource path
  local_var_path = "/api/v2/contentmanagement/shares/{shareId}".sub('{format}','json').sub('{' + 'shareId' + '}', share_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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: ContentManagementApi#delete_shares_share_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_status_status_id(status_id, opts = {}) ⇒ nil

Cancel the command for this status

Parameters:

  • status_id —

    Status ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


153
154
155
156
 
# File 'lib/purecloud/api/content_management_api.rb', line 153

def delete_status_status_id(status_id, opts = {})
  delete_status_status_id_with_http_info(status_id, opts)
  return nil
end

#delete_status_status_id_with_http_info(status_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Cancel the command for this status

Parameters:

  • status_id —

    Status ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/purecloud/api/content_management_api.rb', line 163

def delete_status_status_id_with_http_info(status_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContentManagementApi#delete_status_status_id ..."
  end
  
  # verify the required parameter 'status_id' is set
  fail "Missing the required parameter 'status_id' when calling delete_status_status_id" if status_id.nil?
  
  # resource path
  local_var_path = "/api/v2/contentmanagement/status/{statusId}".sub('{format}','json').sub('{' + 'statusId' + '}', status_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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: ContentManagementApi#delete_status_status_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_workspaces_workspace_id(workspace_id, opts = {}) ⇒ nil

Delete a workspace

Parameters:

  • workspace_id —

    Workspace ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :move_children_to_workspace_id (String) —

    New location for objects in deleted workspace.

Returns:

  • (nil) 


213
214
215
216
 
# File 'lib/purecloud/api/content_management_api.rb', line 213

def delete_workspaces_workspace_id(workspace_id, opts = {})
  delete_workspaces_workspace_id_with_http_info(workspace_id, opts)
  return nil
end

#delete_workspaces_workspace_id_members_member_id(workspace_id, member_id, opts = {}) ⇒ nil

Delete a member from a workspace

Parameters:

  • workspace_id —

    Workspace ID

  • member_id —

    Member ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


275
276
277
278
 
# File 'lib/purecloud/api/content_management_api.rb', line 275

def delete_workspaces_workspace_id_members_member_id(workspace_id, member_id, opts = {})
  delete_workspaces_workspace_id_members_member_id_with_http_info(workspace_id, member_id, opts)
  return nil
end

#delete_workspaces_workspace_id_members_member_id_with_http_info(workspace_id, member_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a member from a workspace

Parameters:

  • workspace_id —

    Workspace ID

  • member_id —

    Member ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/purecloud/api/content_management_api.rb', line 286

def delete_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#delete_workspaces_workspace_id_members_member_id ..."
  end
  
  # verify the required parameter 'workspace_id' is set
  fail "Missing the required parameter 'workspace_id' when calling delete_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 delete_workspaces_workspace_id_members_member_id" if member_id.nil?
  
  # 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 = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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: ContentManagementApi#delete_workspaces_workspace_id_members_member_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_workspaces_workspace_id_tagvalues_tag_id(workspace_id, tag_id, opts = {}) ⇒ nil

Delete workspace tag Delete a tag from a workspace. Will remove this tag from all documents.

Parameters:

  • workspace_id —

    Workspace ID

  • tag_id —

    Tag ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


339
340
341
342
 
# File 'lib/purecloud/api/content_management_api.rb', line 339

def delete_workspaces_workspace_id_tagvalues_tag_id(workspace_id, tag_id, opts = {})
  delete_workspaces_workspace_id_tagvalues_tag_id_with_http_info(workspace_id, tag_id, opts)
  return nil
end

#delete_workspaces_workspace_id_tagvalues_tag_id_with_http_info(workspace_id, tag_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete workspace tag Delete a tag from a workspace. Will remove this tag from all documents.

Parameters:

  • workspace_id —

    Workspace ID

  • tag_id —

    Tag ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/purecloud/api/content_management_api.rb', line 350

def delete_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#delete_workspaces_workspace_id_tagvalues_tag_id ..."
  end
  
  # verify the required parameter 'workspace_id' is set
  fail "Missing the required parameter 'workspace_id' when calling delete_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 delete_workspaces_workspace_id_tagvalues_tag_id" if tag_id.nil?
  
  # 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 = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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: ContentManagementApi#delete_workspaces_workspace_id_tagvalues_tag_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_workspaces_workspace_id_with_http_info(workspace_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a workspace

Parameters:

  • workspace_id —

    Workspace ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :move_children_to_workspace_id (String) —

    New location for objects in deleted workspace.

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/purecloud/api/content_management_api.rb', line 224

def delete_workspaces_workspace_id_with_http_info(workspace_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContentManagementApi#delete_workspaces_workspace_id ..."
  end
  
  # verify the required parameter 'workspace_id' is set
  fail "Missing the required parameter 'workspace_id' when calling delete_workspaces_workspace_id" if workspace_id.nil?
  
  # 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[:'moveChildrenToWorkspaceId'] = opts[:'move_children_to_workspace_id'] if opts[:'move_children_to_workspace_id']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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: ContentManagementApi#delete_workspaces_workspace_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_documents(workspace_id, opts = {}) ⇒ DocumentEntityListing

Get a list of documents.

Parameters:

  • workspace_id —

    Workspace ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Name

  • :expand (String) —

    Expand some document fields

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :sort_by (String) —

    name or dateCreated

  • :sort_order (String) —

    ascending or descending (default to ascending)

Returns:



408
409
410
411
 
# File 'lib/purecloud/api/content_management_api.rb', line 408

def get_documents(workspace_id, opts = {})
  data, status_code, headers = get_documents_with_http_info(workspace_id, opts)
  return data
end

#get_documents_document_id(document_id, opts = {}) ⇒ Document

Get a document.

Parameters:

  • document_id —

    Document ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expand some document fields

Returns:



486
487
488
489
 
# File 'lib/purecloud/api/content_management_api.rb', line 486

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_documents_document_id_audits(document_id, opts = {}) ⇒ DocumentAuditEntityListing

Get a list of audits for a document.

Parameters:

  • document_id —

    Document ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :transaction_filter (String) —

    Transaction filter

  • :level (String) —

    level (default to USER)

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order (default to ascending)

Returns:



558
559
560
561
 
# File 'lib/purecloud/api/content_management_api.rb', line 558

def get_documents_document_id_audits(document_id, opts = {})
  data, status_code, headers = get_documents_document_id_audits_with_http_info(document_id, opts)
  return data
end

#get_documents_document_id_audits_with_http_info(document_id, opts = {}) ⇒ Array<(DocumentAuditEntityListing, Fixnum, Hash)>

Get a list of audits for a document.

Parameters:

  • document_id —

    Document ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :transaction_filter (String) —

    Transaction filter

  • :level (String) —

    level

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:

  • (Array<(DocumentAuditEntityListing, Fixnum, Hash)>) —

    DocumentAuditEntityListing data, response status code and response headers



574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
 
# File 'lib/purecloud/api/content_management_api.rb', line 574

def get_documents_document_id_audits_with_http_info(document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContentManagementApi#get_documents_document_id_audits ..."
  end
  
  # verify the required parameter 'document_id' is set
  fail "Missing the required parameter 'document_id' when calling get_documents_document_id_audits" if document_id.nil?
  
  # resource path
  local_var_path = "/api/v2/contentmanagement/documents/{documentId}/audits".sub('{format}','json').sub('{' + 'documentId' + '}', document_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[:'transactionFilter'] = opts[:'transaction_filter'] if opts[:'transaction_filter']
  query_params[:'level'] = opts[:'level'] if opts[:'level']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'DocumentAuditEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentManagementApi#get_documents_document_id_audits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_documents_document_id_content(document_id, opts = {}) ⇒ nil

Download a document.

Parameters:

  • document_id —

    Document ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :disposition (String) —

    Request how the content will be downloaded: attached as a file or inline. Default is attachment.

  • :content_type (String) —

    The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav

Returns:

  • (nil) 


632
633
634
635
 
# File 'lib/purecloud/api/content_management_api.rb', line 632

def get_documents_document_id_content(document_id, opts = {})
  get_documents_document_id_content_with_http_info(document_id, opts)
  return nil
end

#get_documents_document_id_content_with_http_info(document_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Download a document.

Parameters:

  • document_id —

    Document ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :disposition (String) —

    Request how the content will be downloaded: attached as a file or inline. Default is attachment.

  • :content_type (String) —

    The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'lib/purecloud/api/content_management_api.rb', line 644

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
  
  # verify the required parameter 'document_id' is set
  fail "Missing the required parameter 'document_id' when calling get_documents_document_id_content" if document_id.nil?
  
  if opts[:'disposition'] && !['attachment', 'inline'].include?(opts[:'disposition'])
    fail 'invalid value for "disposition", must be one of attachment, inline'
  end
  
  # resource path
  local_var_path = "/api/v2/contentmanagement/documents/{documentId}/content".sub('{format}','json').sub('{' + 'documentId' + '}', document_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'disposition'] = opts[:'disposition'] if opts[:'disposition']
  query_params[:'contentType'] = opts[:'content_type'] if opts[:'content_type']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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: ContentManagementApi#get_documents_document_id_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_documents_document_id_with_http_info(document_id, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Get a document.

Parameters:

  • document_id —

    Document ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expand some document fields

Returns:

  • (Array<(Document, Fixnum, Hash)>) —

    Document data, response status code and response headers



497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
 
# File 'lib/purecloud/api/content_management_api.rb', line 497

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']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentManagementApi#get_documents_document_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_documents_with_http_info(workspace_id, opts = {}) ⇒ Array<(DocumentEntityListing, Fixnum, Hash)>

Get a list of documents.

Parameters:

  • workspace_id —

    Workspace ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Name

  • :expand (String) —

    Expand some document fields

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :sort_by (String) —

    name or dateCreated

  • :sort_order (String) —

    ascending or descending

Returns:

  • (Array<(DocumentEntityListing, Fixnum, Hash)>) —

    DocumentEntityListing data, response status code and response headers



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/purecloud/api/content_management_api.rb', line 424

def get_documents_with_http_info(workspace_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContentManagementApi#get_documents ..."
  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[:'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']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'DocumentEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentManagementApi#get_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_query(query_phrase, opts = {}) ⇒ QueryResults

Query content

Parameters:

  • query_phrase —

    Phrase tokens are ANDed together over all searchable fields

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :sort_by (String) —

    name or dateCreated (default to name)

  • :sort_order (String) —

    ascending or descending (default to ascending)

  • :expand (String) —

    Expand some document fields

Returns:



704
705
706
707
 
# File 'lib/purecloud/api/content_management_api.rb', line 704

def get_query(query_phrase, opts = {})
  data, status_code, headers = get_query_with_http_info(query_phrase, opts)
  return data
end

#get_query_with_http_info(query_phrase, opts = {}) ⇒ Array<(QueryResults, Fixnum, Hash)>

Query content

Parameters:

  • query_phrase —

    Phrase tokens are ANDed together over all searchable fields

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :sort_by (String) —

    name or dateCreated

  • :sort_order (String) —

    ascending or descending

  • :expand (String) —

    Expand some document fields

Returns:

  • (Array<(QueryResults, Fixnum, Hash)>) —

    QueryResults data, response status code and response headers



719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
 
# File 'lib/purecloud/api/content_management_api.rb', line 719

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']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'QueryResults')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentManagementApi#get_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_securityprofiles(opts = {}) ⇒ SecurityProfileEntityListing

Get a List of Security Profiles

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



778
779
780
781
 
# File 'lib/purecloud/api/content_management_api.rb', line 778

def get_securityprofiles(opts = {})
  data, status_code, headers = get_securityprofiles_with_http_info(opts)
  return data
end

#get_securityprofiles_securityprofile_id(security_profile_id, opts = {}) ⇒ SecurityProfile

Get a Security Profile

Parameters:

  • security_profile_id —

    Security Profile Id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



834
835
836
837
 
# File 'lib/purecloud/api/content_management_api.rb', line 834

def get_securityprofiles_securityprofile_id(security_profile_id, opts = {})
  data, status_code, headers = get_securityprofiles_securityprofile_id_with_http_info(security_profile_id, opts)
  return data
end

#get_securityprofiles_securityprofile_id_with_http_info(security_profile_id, opts = {}) ⇒ Array<(SecurityProfile, Fixnum, Hash)>

Get a Security Profile

Parameters:

  • security_profile_id —

    Security Profile Id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SecurityProfile, Fixnum, Hash)>) —

    SecurityProfile data, response status code and response headers



844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
 
# File 'lib/purecloud/api/content_management_api.rb', line 844

def get_securityprofiles_securityprofile_id_with_http_info(security_profile_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContentManagementApi#get_securityprofiles_securityprofile_id ..."
  end
  
  # verify the required parameter 'security_profile_id' is set
  fail "Missing the required parameter 'security_profile_id' when calling get_securityprofiles_securityprofile_id" if security_profile_id.nil?
  
  # resource path
  local_var_path = "/api/v2/contentmanagement/securityprofiles/{securityProfileId}".sub('{format}','json').sub('{' + 'securityProfileId' + '}', security_profile_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'SecurityProfile')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentManagementApi#get_securityprofiles_securityprofile_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_securityprofiles_with_http_info(opts = {}) ⇒ Array<(SecurityProfileEntityListing, Fixnum, Hash)>

Get a List of Security Profiles

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'lib/purecloud/api/content_management_api.rb', line 787

def get_securityprofiles_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContentManagementApi#get_securityprofiles ..."
  end
  
  # resource path
  local_var_path = "/api/v2/contentmanagement/securityprofiles".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'SecurityProfileEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentManagementApi#get_securityprofiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_shared_shared_id(shared_id, opts = {}) ⇒ nil

Get shared documents. Securely download a shared document. This method requires the download sharing URI obtained in the get document response (downloadSharingUri). Documents may be shared between users in the same workspace. Documents may also be shared between any user by creating a content management share.

Parameters:

  • shared_id —

    Shared ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :redirect (BOOLEAN) —

    Turn on or off redirect (default to true)

  • :disposition (String) —

    Request how the share content will be downloaded: attached as a file or inline. Default is attachment. (default to attachment)

  • :content_type (String) —

    The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav

  • :expand (String) —

    Expand some document fields

Returns:

  • (nil) 


898
899
900
901
 
# File 'lib/purecloud/api/content_management_api.rb', line 898

def get_shared_shared_id(shared_id, opts = {})
  get_shared_shared_id_with_http_info(shared_id, opts)
  return nil
end

#get_shared_shared_id_with_http_info(shared_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Get shared documents. Securely download a shared document. This method requires the download sharing URI obtained in the get document response (downloadSharingUri). Documents may be shared between users in the same workspace. Documents may also be shared between any user by creating a content management share.

Parameters:

  • shared_id —

    Shared ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :redirect (BOOLEAN) —

    Turn on or off redirect

  • :disposition (String) —

    Request how the share content will be downloaded: attached as a file or inline. Default is attachment.

  • :content_type (String) —

    The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav

  • :expand (String) —

    Expand some document fields

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/purecloud/api/content_management_api.rb', line 912

def get_shared_shared_id_with_http_info(shared_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContentManagementApi#get_shared_shared_id ..."
  end
  
  # verify the required parameter 'shared_id' is set
  fail "Missing the required parameter 'shared_id' when calling get_shared_shared_id" if shared_id.nil?
  
  if opts[:'disposition'] && !['attachment', 'inline', 'none'].include?(opts[:'disposition'])
    fail 'invalid value for "disposition", must be one of attachment, inline, none'
  end
  
  if opts[:'expand'] && !['document.acl'].include?(opts[:'expand'])
    fail 'invalid value for "expand", must be one of document.acl'
  end
  
  # resource path
  local_var_path = "/api/v2/contentmanagement/shared/{sharedId}".sub('{format}','json').sub('{' + 'sharedId' + '}', shared_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'redirect'] = opts[:'redirect'] if opts[:'redirect']
  query_params[:'disposition'] = opts[:'disposition'] if opts[:'disposition']
  query_params[:'contentType'] = opts[:'content_type'] if opts[:'content_type']
  query_params[:'expand'] = opts[:'expand'] if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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: ContentManagementApi#get_shared_shared_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_shares(opts = {}) ⇒ ShareEntityListing

Gets a list of shares. You must specify at least one filter (e.g. entityId). Failing to specify a filter will return 400.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :entity_id (String) —

    Filters the shares returned to only the entity specified by the value of this parameter.

  • :expand (String) —

    Expand share fields

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

Returns:



976
977
978
979
 
# File 'lib/purecloud/api/content_management_api.rb', line 976

def get_shares(opts = {})
  data, status_code, headers = get_shares_with_http_info(opts)
  return data
end

#get_shares_share_id(share_id, opts = {}) ⇒ Share

Retrieve details about an existing share.

Parameters:

  • share_id —

    Share ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expand share fields

Returns:



1045
1046
1047
1048
 
# File 'lib/purecloud/api/content_management_api.rb', line 1045

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

#get_shares_share_id_with_http_info(share_id, opts = {}) ⇒ Array<(Share, Fixnum, Hash)>

Retrieve details about an existing share.

Parameters:

  • share_id —

    Share ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expand share fields

Returns:

  • (Array<(Share, Fixnum, Hash)>) —

    Share data, response status code and response headers



1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
 
# File 'lib/purecloud/api/content_management_api.rb', line 1056

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']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'Share')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentManagementApi#get_shares_share_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_shares_with_http_info(opts = {}) ⇒ Array<(ShareEntityListing, Fixnum, Hash)>

Gets a list of shares. You must specify at least one filter (e.g. entityId). Failing to specify a filter will return 400.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :entity_id (String) —

    Filters the shares returned to only the entity specified by the value of this parameter.

  • :expand (String) —

    Expand share fields

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:

  • (Array<(ShareEntityListing, Fixnum, Hash)>) —

    ShareEntityListing data, response status code and response headers



989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
 
# File 'lib/purecloud/api/content_management_api.rb', line 989

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[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'ShareEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentManagementApi#get_shares\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_status(opts = {}) ⇒ CommandStatusEntityListing

Get a list of statuses for pending operations

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

Returns:



1112
1113
1114
1115
 
# File 'lib/purecloud/api/content_management_api.rb', line 1112

def get_status(opts = {})
  data, status_code, headers = get_status_with_http_info(opts)
  return data
end

#get_status_status_id(status_id, opts = {}) ⇒ CommandStatus

Get a status.

Parameters:

  • status_id —

    Status ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1172
1173
1174
1175
 
# File 'lib/purecloud/api/content_management_api.rb', line 1172

def get_status_status_id(status_id, opts = {})
  data, status_code, headers = get_status_status_id_with_http_info(status_id, opts)
  return data
end

#get_status_status_id_with_http_info(status_id, opts = {}) ⇒ Array<(CommandStatus, Fixnum, Hash)>

Get a status.

Parameters:

  • status_id —

    Status ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CommandStatus, Fixnum, Hash)>) —

    CommandStatus data, response status code and response headers



1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
 
# File 'lib/purecloud/api/content_management_api.rb', line 1182

def get_status_status_id_with_http_info(status_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContentManagementApi#get_status_status_id ..."
  end
  
  # verify the required parameter 'status_id' is set
  fail "Missing the required parameter 'status_id' when calling get_status_status_id" if status_id.nil?
  
  # resource path
  local_var_path = "/api/v2/contentmanagement/status/{statusId}".sub('{format}','json').sub('{' + 'statusId' + '}', status_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'CommandStatus')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentManagementApi#get_status_status_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_status_with_http_info(opts = {}) ⇒ Array<(CommandStatusEntityListing, Fixnum, Hash)>

Get a list of statuses for pending operations

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:

  • (Array<(CommandStatusEntityListing, Fixnum, Hash)>) —

    CommandStatusEntityListing data, response status code and response headers



1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
 
# File 'lib/purecloud/api/content_management_api.rb', line 1123

def get_status_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContentManagementApi#get_status ..."
  end
  
  # resource path
  local_var_path = "/api/v2/contentmanagement/status".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']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'CommandStatusEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentManagementApi#get_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_usage(opts = {}) ⇒ Usage

Get usage details.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1231
1232
1233
1234
 
# File 'lib/purecloud/api/content_management_api.rb', line 1231

def get_usage(opts = {})
  data, status_code, headers = get_usage_with_http_info(opts)
  return data
end

#get_usage_with_http_info(opts = {}) ⇒ Array<(Usage, Fixnum, Hash)>

Get usage details.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Usage, Fixnum, Hash)>) —

    Usage data, response status code and response headers



1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
 
# File 'lib/purecloud/api/content_management_api.rb', line 1240

def get_usage_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContentManagementApi#get_usage ..."
  end
  
  # resource path
  local_var_path = "/api/v2/contentmanagement/usage".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'Usage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentManagementApi#get_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workspaces(opts = {}) ⇒ WorkspaceEntityListing

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.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :access (String) —

    Requested access level (default to document:viewmetadata)

  • :expand (String) —

    Expand some workspace fields

Returns:



1290
1291
1292
1293
 
# File 'lib/purecloud/api/content_management_api.rb', line 1290

def get_workspaces(opts = {})
  data, status_code, headers = get_workspaces_with_http_info(opts)
  return data
end

#get_workspaces_with_http_info(opts = {}) ⇒ Array<(WorkspaceEntityListing, Fixnum, Hash)>

Get a list of workspaces. Specifying &#39;content&#39; access will return all workspaces the user has document access to, while &#39;admin&#39; access will return all group workspaces the user has administrative rights to.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :access (String) —

    Requested access level

  • :expand (String) —

    Expand some workspace fields

Returns:

  • (Array<(WorkspaceEntityListing, Fixnum, Hash)>) —

    WorkspaceEntityListing data, response status code and response headers



1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'lib/purecloud/api/content_management_api.rb', line 1303

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']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'WorkspaceEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentManagementApi#get_workspaces\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workspaces_workspace_id(workspace_id, opts = {}) ⇒ Workspace

Get a workspace.

Parameters:

  • workspace_id —

    Workspace ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expand some workspace fields

Returns:



1363
1364
1365
1366
 
# File 'lib/purecloud/api/content_management_api.rb', line 1363

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_workspaces_workspace_id_members(workspace_id, opts = {}) ⇒ WorkspaceMemberEntityListing

Get a list workspace members

Parameters:

  • workspace_id —

    Workspace ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :expand (String) —

    Expand workspace member fields

Returns:



1432
1433
1434
1435
 
# File 'lib/purecloud/api/content_management_api.rb', line 1432

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

#get_workspaces_workspace_id_members_member_id(workspace_id, member_id, opts = {}) ⇒ WorkspaceMember

Get a workspace member

Parameters:

  • workspace_id —

    Workspace ID

  • member_id —

    Member ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expand workspace member fields

Returns:



1504
1505
1506
1507
 
# File 'lib/purecloud/api/content_management_api.rb', line 1504

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

#get_workspaces_workspace_id_members_member_id_with_http_info(workspace_id, member_id, opts = {}) ⇒ Array<(WorkspaceMember, Fixnum, Hash)>

Get a workspace member

Parameters:

  • workspace_id —

    Workspace ID

  • member_id —

    Member ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expand workspace member fields

Returns:

  • (Array<(WorkspaceMember, Fixnum, Hash)>) —

    WorkspaceMember data, response status code and response headers



1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
 
# File 'lib/purecloud/api/content_management_api.rb', line 1516

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
  
  # verify the required parameter 'workspace_id' is set
  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']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'WorkspaceMember')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentManagementApi#get_workspaces_workspace_id_members_member_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workspaces_workspace_id_members_with_http_info(workspace_id, opts = {}) ⇒ Array<(WorkspaceMemberEntityListing, Fixnum, Hash)>

Get a list workspace members

Parameters:

  • workspace_id —

    Workspace ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :expand (String) —

    Expand workspace member fields

Returns:



1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
 
# File 'lib/purecloud/api/content_management_api.rb', line 1445

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']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'WorkspaceMemberEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentManagementApi#get_workspaces_workspace_id_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workspaces_workspace_id_tagvalues(workspace_id, opts = {}) ⇒ TagValueEntityListing

Get a list of workspace tags

Parameters:

  • workspace_id —

    Workspace ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :value (String) —

    filter the list of tags returned

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :expand (String) —

    Expand some document fields

Returns:



1578
1579
1580
1581
 
# File 'lib/purecloud/api/content_management_api.rb', line 1578

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

#get_workspaces_workspace_id_tagvalues_tag_id(workspace_id, tag_id, opts = {}) ⇒ TagValue

Get a workspace tag

Parameters:

  • workspace_id —

    Workspace ID

  • tag_id —

    Tag ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expand some document fields

Returns:



1652
1653
1654
1655
 
# File 'lib/purecloud/api/content_management_api.rb', line 1652

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

#get_workspaces_workspace_id_tagvalues_tag_id_with_http_info(workspace_id, tag_id, opts = {}) ⇒ Array<(TagValue, Fixnum, Hash)>

Get a workspace tag

Parameters:

  • workspace_id —

    Workspace ID

  • tag_id —

    Tag ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expand some document fields

Returns:

  • (Array<(TagValue, Fixnum, Hash)>) —

    TagValue data, response status code and response headers



1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
 
# File 'lib/purecloud/api/content_management_api.rb', line 1664

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
  
  # verify the required parameter 'workspace_id' is set
  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']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'TagValue')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentManagementApi#get_workspaces_workspace_id_tagvalues_tag_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workspaces_workspace_id_tagvalues_with_http_info(workspace_id, opts = {}) ⇒ Array<(TagValueEntityListing, Fixnum, Hash)>

Get a list of workspace tags

Parameters:

  • workspace_id —

    Workspace ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :value (String) —

    filter the list of tags returned

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :expand (String) —

    Expand some document fields

Returns:

  • (Array<(TagValueEntityListing, Fixnum, Hash)>) —

    TagValueEntityListing data, response status code and response headers



1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
 
# File 'lib/purecloud/api/content_management_api.rb', line 1592

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']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'TagValueEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentManagementApi#get_workspaces_workspace_id_tagvalues\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workspaces_workspace_id_with_http_info(workspace_id, opts = {}) ⇒ Array<(Workspace, Fixnum, Hash)>

Get a workspace.

Parameters:

  • workspace_id —

    Workspace ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expand some workspace fields

Returns:

  • (Array<(Workspace, Fixnum, Hash)>) —

    Workspace data, response status code and response headers



1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
 
# File 'lib/purecloud/api/content_management_api.rb', line 1374

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']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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: ContentManagementApi#get_workspaces_workspace_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_auditquery(body, opts = {}) ⇒ QueryResults

Query audits

Parameters:

  • body —

    Allows for a filtered query returning facet information

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1722
1723
1724
1725
 
# File 'lib/purecloud/api/content_management_api.rb', line 1722

def post_auditquery(body, opts = {})
  data, status_code, headers = post_auditquery_with_http_info(body, opts)
  return data
end

#post_auditquery_with_http_info(body, opts = {}) ⇒ Array<(QueryResults, Fixnum, Hash)>

Query audits

Parameters:

  • body —

    Allows for a filtered query returning facet information

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(QueryResults, Fixnum, Hash)>) —

    QueryResults data, response status code and response headers



1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
 
# File 'lib/purecloud/api/content_management_api.rb', line 1732

def post_auditquery_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContentManagementApi#post_auditquery ..."
  end
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling post_auditquery" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/contentmanagement/auditquery".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  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 => 'QueryResults')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentManagementApi#post_auditquery\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_documents(opts = {}) ⇒ Document

Add a document.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (DocumentUpload) —

    Document

  • :copy_source (String) —

    Copy a document within a workspace or to a new workspace. Provide a document ID as the copy source.

  • :move_source (String) —

    Move a document to a new workspace. Provide a document ID as the move source.

  • :override (BOOLEAN) —

    Override any lock on the source document

Returns:



1785
1786
1787
1788
 
# File 'lib/purecloud/api/content_management_api.rb', line 1785

def post_documents(opts = {})
  data, status_code, headers = post_documents_with_http_info(opts)
  return data
end

#post_documents_document_id(document_id, opts = {}) ⇒ Document

Update a document.

Parameters:

  • document_id —

    Document ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (DocumentUpdate) —

    Document

  • :expand (String) —

    Expand some document fields

  • :override (BOOLEAN) —

    Override any lock on the document

Returns:



1851
1852
1853
1854
 
# File 'lib/purecloud/api/content_management_api.rb', line 1851

def post_documents_document_id(document_id, opts = {})
  data, status_code, headers = post_documents_document_id_with_http_info(document_id, opts)
  return data
end

#post_documents_document_id_content(document_id, opts = {}) ⇒ ReplaceResponse

Replace the contents of a document.

Parameters:

  • document_id —

    Document ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (ReplaceRequest) —

    Replace Request

  • :override (BOOLEAN) —

    Override any lock on the document

Returns:



1922
1923
1924
1925
 
# File 'lib/purecloud/api/content_management_api.rb', line 1922

def post_documents_document_id_content(document_id, opts = {})
  data, status_code, headers = post_documents_document_id_content_with_http_info(document_id, opts)
  return data
end

#post_documents_document_id_content_with_http_info(document_id, opts = {}) ⇒ Array<(ReplaceResponse, Fixnum, Hash)>

Replace the contents of a document.

Parameters:

  • document_id —

    Document ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (ReplaceRequest) —

    Replace Request

  • :override (BOOLEAN) —

    Override any lock on the document

Returns:

  • (Array<(ReplaceResponse, Fixnum, Hash)>) —

    ReplaceResponse data, response status code and response headers



1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
 
# File 'lib/purecloud/api/content_management_api.rb', line 1934

def post_documents_document_id_content_with_http_info(document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContentManagementApi#post_documents_document_id_content ..."
  end
  
  # verify the required parameter 'document_id' is set
  fail "Missing the required parameter 'document_id' when calling post_documents_document_id_content" if document_id.nil?
  
  # resource path
  local_var_path = "/api/v2/contentmanagement/documents/{documentId}/content".sub('{format}','json').sub('{' + 'documentId' + '}', document_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'override'] = opts[:'override'] if opts[:'override']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  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 => 'ReplaceResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentManagementApi#post_documents_document_id_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_documents_document_id_with_http_info(document_id, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Update a document.

Parameters:

  • document_id —

    Document ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (DocumentUpdate) —

    Document

  • :expand (String) —

    Expand some document fields

  • :override (BOOLEAN) —

    Override any lock on the document

Returns:

  • (Array<(Document, Fixnum, Hash)>) —

    Document data, response status code and response headers



1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
 
# File 'lib/purecloud/api/content_management_api.rb', line 1864

def post_documents_document_id_with_http_info(document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContentManagementApi#post_documents_document_id ..."
  end
  
  # verify the required parameter 'document_id' is set
  fail "Missing the required parameter 'document_id' when calling post_documents_document_id" if document_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/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[:'override'] = opts[:'override'] if opts[:'override']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentManagementApi#post_documents_document_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_documents_with_http_info(opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Add a document.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (DocumentUpload) —

    Document

  • :copy_source (String) —

    Copy a document within a workspace or to a new workspace. Provide a document ID as the copy source.

  • :move_source (String) —

    Move a document to a new workspace. Provide a document ID as the move source.

  • :override (BOOLEAN) —

    Override any lock on the source document

Returns:

  • (Array<(Document, Fixnum, Hash)>) —

    Document data, response status code and response headers



1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
 
# File 'lib/purecloud/api/content_management_api.rb', line 1798

def post_documents_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContentManagementApi#post_documents ..."
  end
  
  # resource path
  local_var_path = "/api/v2/contentmanagement/documents".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'copySource'] = opts[:'copy_source'] if opts[:'copy_source']
  query_params[:'moveSource'] = opts[:'move_source'] if opts[:'move_source']
  query_params[:'override'] = opts[:'override'] if opts[:'override']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentManagementApi#post_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_query(body, opts = {}) ⇒ QueryResults

Query content

Parameters:

  • body —

    Allows for a filtered query returning facet information

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expand some document fields

Returns:



1986
1987
1988
1989
 
# File 'lib/purecloud/api/content_management_api.rb', line 1986

def post_query(body, opts = {})
  data, status_code, headers = post_query_with_http_info(body, opts)
  return data
end

#post_query_with_http_info(body, opts = {}) ⇒ Array<(QueryResults, Fixnum, Hash)>

Query content

Parameters:

  • body —

    Allows for a filtered query returning facet information

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expand some document fields

Returns:

  • (Array<(QueryResults, Fixnum, Hash)>) —

    QueryResults data, response status code and response headers



1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
 
# File 'lib/purecloud/api/content_management_api.rb', line 1997

def post_query_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContentManagementApi#post_query ..."
  end
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling post_query" if body.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[:'expand'] = opts[:'expand'] if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  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 => 'QueryResults')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentManagementApi#post_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_shares(opts = {}) ⇒ CreateShareResponse

Creates a new share or updates an existing share if the entity has already been shared

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (CreateShareRequest) —

    CreateShareRequest - entity id and type and a single member or list of members are required

Returns:



2052
2053
2054
2055
 
# File 'lib/purecloud/api/content_management_api.rb', line 2052

def post_shares(opts = {})
  data, status_code, headers = post_shares_with_http_info(opts)
  return data
end

#post_shares_with_http_info(opts = {}) ⇒ Array<(CreateShareResponse, Fixnum, Hash)>

Creates a new share or updates an existing share if the entity has already been shared

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (CreateShareRequest) —

    CreateShareRequest - entity id and type and a single member or list of members are required

Returns:

  • (Array<(CreateShareResponse, Fixnum, Hash)>) —

    CreateShareResponse data, response status code and response headers



2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
 
# File 'lib/purecloud/api/content_management_api.rb', line 2062

def post_shares_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContentManagementApi#post_shares ..."
  end
  
  # resource path
  local_var_path = "/api/v2/contentmanagement/shares".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  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 => 'CreateShareResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentManagementApi#post_shares\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_workspaces(opts = {}) ⇒ Workspace

Create a group workspace

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



2109
2110
2111
2112
 
# File 'lib/purecloud/api/content_management_api.rb', line 2109

def post_workspaces(opts = {})
  data, status_code, headers = post_workspaces_with_http_info(opts)
  return data
end

#post_workspaces_with_http_info(opts = {}) ⇒ Array<(Workspace, Fixnum, Hash)>

Create a group workspace

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Workspace, Fixnum, Hash)>) —

    Workspace data, response status code and response headers



2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
 
# File 'lib/purecloud/api/content_management_api.rb', line 2119

def post_workspaces_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContentManagementApi#post_workspaces ..."
  end
  
  # resource path
  local_var_path = "/api/v2/contentmanagement/workspaces".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  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: ContentManagementApi#post_workspaces\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_workspaces_workspace_id_tagvalues(workspace_id, opts = {}) ⇒ TagValue

Create a workspace tag

Parameters:

  • workspace_id —

    Workspace ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



2167
2168
2169
2170
 
# File 'lib/purecloud/api/content_management_api.rb', line 2167

def post_workspaces_workspace_id_tagvalues(workspace_id, opts = {})
  data, status_code, headers = post_workspaces_workspace_id_tagvalues_with_http_info(workspace_id, opts)
  return data
end

#post_workspaces_workspace_id_tagvalues_query(workspace_id, opts = {}) ⇒ TagValueEntityListing

Perform a prefix query on tags in the workspace

Parameters:

  • workspace_id —

    Workspace ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (TagQueryRequest) —

    query

  • :expand (String) —

    Expand some document fields

Returns:



2230
2231
2232
2233
 
# File 'lib/purecloud/api/content_management_api.rb', line 2230

def post_workspaces_workspace_id_tagvalues_query(workspace_id, opts = {})
  data, status_code, headers = post_workspaces_workspace_id_tagvalues_query_with_http_info(workspace_id, opts)
  return data
end

#post_workspaces_workspace_id_tagvalues_query_with_http_info(workspace_id, opts = {}) ⇒ Array<(TagValueEntityListing, Fixnum, Hash)>

Perform a prefix query on tags in the workspace

Parameters:

  • workspace_id —

    Workspace ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (TagQueryRequest) —

    query

  • :expand (String) —

    Expand some document fields

Returns:

  • (Array<(TagValueEntityListing, Fixnum, Hash)>) —

    TagValueEntityListing data, response status code and response headers



2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
 
# File 'lib/purecloud/api/content_management_api.rb', line 2242

def post_workspaces_workspace_id_tagvalues_query_with_http_info(workspace_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContentManagementApi#post_workspaces_workspace_id_tagvalues_query ..."
  end
  
  # verify the required parameter 'workspace_id' is set
  fail "Missing the required parameter 'workspace_id' when calling post_workspaces_workspace_id_tagvalues_query" 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/query".sub('{format}','json').sub('{' + 'workspaceId' + '}', workspace_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  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 => 'TagValueEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentManagementApi#post_workspaces_workspace_id_tagvalues_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_workspaces_workspace_id_tagvalues_with_http_info(workspace_id, opts = {}) ⇒ Array<(TagValue, Fixnum, Hash)>

Create a workspace tag

Parameters:

  • workspace_id —

    Workspace ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(TagValue, Fixnum, Hash)>) —

    TagValue data, response status code and response headers



2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
 
# File 'lib/purecloud/api/content_management_api.rb', line 2178

def post_workspaces_workspace_id_tagvalues_with_http_info(workspace_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContentManagementApi#post_workspaces_workspace_id_tagvalues ..."
  end
  
  # verify the required parameter 'workspace_id' is set
  fail "Missing the required parameter 'workspace_id' when calling post_workspaces_workspace_id_tagvalues" if workspace_id.nil?
  
  # resource path
  local_var_path = "/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues".sub('{format}','json').sub('{' + 'workspaceId' + '}', workspace_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  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 => 'TagValue')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentManagementApi#post_workspaces_workspace_id_tagvalues\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_workspaces_workspace_id(workspace_id, opts = {}) ⇒ Workspace

Update a workspace

Parameters:

  • workspace_id —

    Workspace ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



2298
2299
2300
2301
 
# File 'lib/purecloud/api/content_management_api.rb', line 2298

def put_workspaces_workspace_id(workspace_id, opts = {})
  data, status_code, headers = put_workspaces_workspace_id_with_http_info(workspace_id, opts)
  return data
end

#put_workspaces_workspace_id_members_member_id(workspace_id, member_id, opts = {}) ⇒ WorkspaceMember

Add a member to a workspace

Parameters:

  • workspace_id —

    Workspace ID

  • member_id —

    Member ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



2361
2362
2363
2364
 
# File 'lib/purecloud/api/content_management_api.rb', line 2361

def put_workspaces_workspace_id_members_member_id(workspace_id, member_id, opts = {})
  data, status_code, headers = put_workspaces_workspace_id_members_member_id_with_http_info(workspace_id, member_id, opts)
  return data
end

#put_workspaces_workspace_id_members_member_id_with_http_info(workspace_id, member_id, opts = {}) ⇒ Array<(WorkspaceMember, Fixnum, Hash)>

Add a member to a workspace

Parameters:

  • workspace_id —

    Workspace ID

  • member_id —

    Member ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(WorkspaceMember, Fixnum, Hash)>) —

    WorkspaceMember data, response status code and response headers



2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
 
# File 'lib/purecloud/api/content_management_api.rb', line 2373

def put_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#put_workspaces_workspace_id_members_member_id ..."
  end
  
  # verify the required parameter 'workspace_id' is set
  fail "Missing the required parameter 'workspace_id' when calling put_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 put_workspaces_workspace_id_members_member_id" if member_id.nil?
  
  # 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 = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  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 => 'WorkspaceMember')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentManagementApi#put_workspaces_workspace_id_members_member_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_workspaces_workspace_id_tagvalues_tag_id(workspace_id, tag_id, opts = {}) ⇒ TagValue

Update a workspace tag. Will update all documents with the new tag value.

Parameters:

  • workspace_id —

    Workspace ID

  • tag_id —

    Tag ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



2428
2429
2430
2431
 
# File 'lib/purecloud/api/content_management_api.rb', line 2428

def put_workspaces_workspace_id_tagvalues_tag_id(workspace_id, tag_id, opts = {})
  data, status_code, headers = put_workspaces_workspace_id_tagvalues_tag_id_with_http_info(workspace_id, tag_id, opts)
  return data
end

#put_workspaces_workspace_id_tagvalues_tag_id_with_http_info(workspace_id, tag_id, opts = {}) ⇒ Array<(TagValue, Fixnum, Hash)>

Update a workspace tag. Will update all documents with the new tag value.

Parameters:

  • workspace_id —

    Workspace ID

  • tag_id —

    Tag ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(TagValue, Fixnum, Hash)>) —

    TagValue data, response status code and response headers



2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
 
# File 'lib/purecloud/api/content_management_api.rb', line 2440

def put_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#put_workspaces_workspace_id_tagvalues_tag_id ..."
  end
  
  # verify the required parameter 'workspace_id' is set
  fail "Missing the required parameter 'workspace_id' when calling put_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 put_workspaces_workspace_id_tagvalues_tag_id" if tag_id.nil?
  
  # 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 = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  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 => 'TagValue')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentManagementApi#put_workspaces_workspace_id_tagvalues_tag_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_workspaces_workspace_id_with_http_info(workspace_id, opts = {}) ⇒ Array<(Workspace, Fixnum, Hash)>

Update a workspace

Parameters:

  • workspace_id —

    Workspace ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Workspace, Fixnum, Hash)>) —

    Workspace data, response status code and response headers



2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
 
# File 'lib/purecloud/api/content_management_api.rb', line 2309

def put_workspaces_workspace_id_with_http_info(workspace_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContentManagementApi#put_workspaces_workspace_id ..."
  end
  
  # verify the required parameter 'workspace_id' is set
  fail "Missing the required parameter 'workspace_id' when calling put_workspaces_workspace_id" if workspace_id.nil?
  
  # resource path
  local_var_path = "/api/v2/contentmanagement/workspaces/{workspaceId}".sub('{format}','json').sub('{' + 'workspaceId' + '}', workspace_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  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: ContentManagementApi#put_workspaces_workspace_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end