Class: GongAPI::UsersApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UsersApi

Returns a new instance of UsersApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_user_history_using_get(id, opts = {}) ⇒ SettingsHistory

Retrieve user history (/v2/users/id/settings-history) Retrieve a specific user’s history. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:users:read’.

Parameters:

  • id —

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

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

    the optional parameters

Returns:



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

def get_user_history_using_get(id, opts = {})
  data, _status_code, _headers = get_user_history_using_get_with_http_info(id, opts)
  data
end

#get_user_history_using_get_with_http_info(id, opts = {}) ⇒ Array<(SettingsHistory, Integer, Hash)>

Retrieve user history (/v2/users/id/settings-history) Retrieve a specific user&#x27;s history. When accessed through a Bearer token authorization method, this endpoint requires the scope &#x27;api:users:read&#x27;.

Parameters:

  • id —

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

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

    the optional parameters

Returns:

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

    SettingsHistory data, response status code and response headers



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
72
73
74
 
# File 'lib/gong_api/api/users_api.rb', line 34

def get_user_history_using_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.get_user_history_using_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling UsersApi.get_user_history_using_get"
  end
  # resource path
  local_var_path = '/v2/users/{id}/settings-history'.sub('{' + 'id' + '}', id.to_s)

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

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

#get_user_using_get(id, opts = {}) ⇒ User

Retrieve user (/v2/users/id) Retrieve a specific user. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:users:read’.

Parameters:

  • id —

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

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

    the optional parameters

Returns:



80
81
82
83
 
# File 'lib/gong_api/api/users_api.rb', line 80

def get_user_using_get(id, opts = {})
  data, _status_code, _headers = get_user_using_get_with_http_info(id, opts)
  data
end

#get_user_using_get_with_http_info(id, opts = {}) ⇒ Array<(User, Integer, Hash)>

Retrieve user (/v2/users/id) Retrieve a specific user. When accessed through a Bearer token authorization method, this endpoint requires the scope &#x27;api:users:read&#x27;.

Parameters:

  • id —

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

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

    the optional parameters

Returns:

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

    User data, response status code and response headers



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
125
126
127
128
129
130
 
# File 'lib/gong_api/api/users_api.rb', line 90

def get_user_using_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.get_user_using_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling UsersApi.get_user_using_get"
  end
  # resource path
  local_var_path = '/v2/users/{id}'.sub('{' + 'id' + '}', id.to_s)

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

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

#list_multiple_users_using_post(body, opts = {}) ⇒ UsersMetadata

List users by filter (/v2/users/extensive) List multiple Users. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:users:read’.

Parameters:

  • body —

    multipleUsersRequest

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

    the optional parameters

Returns:



136
137
138
139
 
# File 'lib/gong_api/api/users_api.rb', line 136

def list_multiple_users_using_post(body, opts = {})
  data, _status_code, _headers = list_multiple_users_using_post_with_http_info(body, opts)
  data
end

#list_multiple_users_using_post_with_http_info(body, opts = {}) ⇒ Array<(UsersMetadata, Integer, Hash)>

List users by filter (/v2/users/extensive) List multiple Users. When accessed through a Bearer token authorization method, this endpoint requires the scope &#x27;api:users:read&#x27;.

Parameters:

  • body —

    multipleUsersRequest

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

    the optional parameters

Returns:

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

    UsersMetadata data, response status code and response headers



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
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
 
# File 'lib/gong_api/api/users_api.rb', line 146

def list_multiple_users_using_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.list_multiple_users_using_post ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.list_multiple_users_using_post"
  end
  # resource path
  local_var_path = '/v2/users/extensive'

  # 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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

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

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

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

#list_users_using_get1(opts = {}) ⇒ UsersMetadata

List all users (/v2/users) List all of the company’s users. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:users:read’.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cursor (String) —

    When paging is needed, provide the value supplied by the previous API call to bring the following page of records.

  • :include_avatars (BOOLEAN) —

    Avatars are synthetic users representing Gong employees (CSMs and support providers) when they access your instance. References to avatars&#x27; IDs may be found in the outputs of other API endpoints. This parameter is optional, if not provided avatars will not be included in the results.

Returns:



195
196
197
198
 
# File 'lib/gong_api/api/users_api.rb', line 195

def list_users_using_get1(opts = {})
  data, _status_code, _headers = list_users_using_get1_with_http_info(opts)
  data
end

#list_users_using_get1_with_http_info(opts = {}) ⇒ Array<(UsersMetadata, Integer, Hash)>

List all users (/v2/users) List all of the company&#x27;s users. When accessed through a Bearer token authorization method, this endpoint requires the scope &#x27;api:users:read&#x27;.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cursor (String) —

    When paging is needed, provide the value supplied by the previous API call to bring the following page of records.

  • :include_avatars (BOOLEAN) —

    Avatars are synthetic users representing Gong employees (CSMs and support providers) when they access your instance. References to avatars&#x27; IDs may be found in the outputs of other API endpoints. This parameter is optional, if not provided avatars will not be included in the results.

Returns:

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

    UsersMetadata data, response status code and response headers



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/gong_api/api/users_api.rb', line 206

def list_users_using_get1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.list_users_using_get1 ...'
  end
  # resource path
  local_var_path = '/v2/users'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'includeAvatars'] = opts[:'include_avatars'] if !opts[:'include_avatars'].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] || 'UsersMetadata' 

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