Class: GongAPI::SettingsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SettingsApi

Returns a new instance of SettingsApi.



16
17
18
 
# File 'lib/gong_api/api/settings_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/settings_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#list_scorecards_using_get(opts = {}) ⇒ Scorecards

Retrieve scorecards details (/v2/settings/scorecards) Retrieve all the scorecards within the Gong system. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:settings:scorecards:read’.

Parameters:

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

    the optional parameters

Returns:



23
24
25
26
 
# File 'lib/gong_api/api/settings_api.rb', line 23

def list_scorecards_using_get(opts = {})
  data, _status_code, _headers = list_scorecards_using_get_with_http_info(opts)
  data
end

#list_scorecards_using_get_with_http_info(opts = {}) ⇒ Array<(Scorecards, Integer, Hash)>

Retrieve scorecards details (/v2/settings/scorecards) Retrieve all the scorecards within the Gong system. When accessed through a Bearer token authorization method, this endpoint requires the scope &#x27;api:settings:scorecards:read&#x27;.

Parameters:

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

    the optional parameters

Returns:

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

    Scorecards data, response status code and response headers



32
33
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
 
# File 'lib/gong_api/api/settings_api.rb', line 32

def list_scorecards_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.list_scorecards_using_get ...'
  end
  # resource path
  local_var_path = '/v2/settings/scorecards'

  # query parameters
  query_params = opts[:query_params] || {}

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

  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: SettingsApi#list_scorecards_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_workspaces_using_get(opts = {}) ⇒ WorkspacesMetadata

List all company workspaces (/v2/workspaces) Returns a list of all workspaces including their details. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:workspaces:read’.

Parameters:

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

    the optional parameters

Returns:



73
74
75
76
 
# File 'lib/gong_api/api/settings_api.rb', line 73

def list_workspaces_using_get(opts = {})
  data, _status_code, _headers = list_workspaces_using_get_with_http_info(opts)
  data
end

#list_workspaces_using_get_with_http_info(opts = {}) ⇒ Array<(WorkspacesMetadata, Integer, Hash)>

List all company workspaces (/v2/workspaces) Returns a list of all workspaces including their details. When accessed through a Bearer token authorization method, this endpoint requires the scope &#x27;api:workspaces:read&#x27;.

Parameters:

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

    the optional parameters

Returns:

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

    WorkspacesMetadata data, response status code and response headers



82
83
84
85
86
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
 
# File 'lib/gong_api/api/settings_api.rb', line 82

def list_workspaces_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.list_workspaces_using_get ...'
  end
  # resource path
  local_var_path = '/v2/workspaces'

  # query parameters
  query_params = opts[:query_params] || {}

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

  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: SettingsApi#list_workspaces_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end