Class: GongAPI::LibraryApi

Inherits:
Object
  • Object
show all
Defined in:
lib/gong_api/api/library_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LibraryApi

Returns a new instance of LibraryApi.



16
17
18
 
# File 'lib/gong_api/api/library_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/gong_api/api/library_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#get_calls_in_specific_folder_using_get(opts = {}) ⇒ LibraryFolderListOfCallsResponse

List of calls in a specific folder (/v2/library/folder-content) Given a folder id, this endpoint retrieves a list of calls in it. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:library:read’.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder_id (String) —

    Gong's unique numeric identifier for the folder (up to 20 digits).

Returns:



24
25
26
27
 
# File 'lib/gong_api/api/library_api.rb', line 24

def get_calls_in_specific_folder_using_get(opts = {})
  data, _status_code, _headers = get_calls_in_specific_folder_using_get_with_http_info(opts)
  data
end

#get_calls_in_specific_folder_using_get_with_http_info(opts = {}) ⇒ Array<(LibraryFolderListOfCallsResponse, Integer, Hash)>

List of calls in a specific folder (/v2/library/folder-content) Given a folder id, this endpoint retrieves a list of calls in it. When accessed through a Bearer token authorization method, this endpoint requires the scope &#x27;api:library:read&#x27;.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder_id (String) —

    Gong&#x27;s unique numeric identifier for the folder (up to 20 digits).

Returns:



34
35
36
37
38
39
40
41
42
43
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
 
# File 'lib/gong_api/api/library_api.rb', line 34

def get_calls_in_specific_folder_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LibraryApi.get_calls_in_specific_folder_using_get ...'
  end
  # resource path
  local_var_path = '/v2/library/folder-content'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'folderId'] = opts[:'folder_id'] if !opts[:'folder_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'LibraryFolderListOfCallsResponse' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LibraryApi#get_calls_in_specific_folder_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_library_structure_using_get(opts = {}) ⇒ LibraryResponse

Retrieve Library folders (/v2/library/folders) Use this endpoint to retrieve a list of public library folders. We do not allow retrieval of either private or archived folders. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:library:read’.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :workspace_id (String) —

    Workspace identifier. We will retrieve folders which are related to this specific workspace.

Returns:



77
78
79
80
 
# File 'lib/gong_api/api/library_api.rb', line 77

def get_library_structure_using_get(opts = {})
  data, _status_code, _headers = get_library_structure_using_get_with_http_info(opts)
  data
end

#get_library_structure_using_get_with_http_info(opts = {}) ⇒ Array<(LibraryResponse, Integer, Hash)>

Retrieve Library folders (/v2/library/folders) Use this endpoint to retrieve a list of public library folders. We do not allow retrieval of either private or archived folders. When accessed through a Bearer token authorization method, this endpoint requires the scope &#x27;api:library:read&#x27;.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :workspace_id (String) —

    Workspace identifier. We will retrieve folders which are related to this specific workspace.

Returns:

  • (Array<(LibraryResponse, Integer, Hash)>) —

    LibraryResponse data, response status code and response headers



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/gong_api/api/library_api.rb', line 87

def get_library_structure_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LibraryApi.get_library_structure_using_get ...'
  end
  # resource path
  local_var_path = '/v2/library/folders'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'workspaceId'] = opts[:'workspace_id'] if !opts[:'workspace_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'LibraryResponse' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LibraryApi#get_library_structure_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end