Class: SurveyMonkeySwaggerClient::UsersAndGroupsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/survey_monkey_swagger_client/api/users_and_groups_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UsersAndGroupsApi

Returns a new instance of UsersAndGroupsApi.



16
17
18
 
# File 'lib/survey_monkey_swagger_client/api/users_and_groups_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/survey_monkey_swagger_client/api/users_and_groups_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#get_a_group_member(opts = {}) ⇒ nil

Get a group member Return a group memeber’s details including their role and status

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


23
24
25
26
 
# File 'lib/survey_monkey_swagger_client/api/users_and_groups_api.rb', line 23

def get_a_group_member(opts = {})
  get_a_group_member_with_http_info(opts)
  nil
end

#get_a_group_member_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get a group member Return a group memeber&#x27;s details including their role and status

Parameters:

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/survey_monkey_swagger_client/api/users_and_groups_api.rb', line 32

def get_a_group_member_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersAndGroupsApi.get_a_group_member ...'
  end
  # resource path
  local_var_path = '/v3/groups/GROUP_ID/members/MEMBER_ID'

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  return_type = opts[:return_type]

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

#get_group_members(opts = {}) ⇒ nil

Get group members Returns a list of users who have been added as members of the specified group

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


71
72
73
74
 
# File 'lib/survey_monkey_swagger_client/api/users_and_groups_api.rb', line 71

def get_group_members(opts = {})
  get_group_members_with_http_info(opts)
  nil
end

#get_group_members_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get group members Returns a list of users who have been added as members of the specified group

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



80
81
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
 
# File 'lib/survey_monkey_swagger_client/api/users_and_groups_api.rb', line 80

def get_group_members_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersAndGroupsApi.get_group_members ...'
  end
  # resource path
  local_var_path = '/v3/groups/GROUP_ID/members'

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  return_type = opts[:return_type]

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

#get_user_details(opts = {}) ⇒ nil

Get user details Returns the current user’s account details including their plan

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


119
120
121
122
 
# File 'lib/survey_monkey_swagger_client/api/users_and_groups_api.rb', line 119

def get_user_details(opts = {})
  get_user_details_with_http_info(opts)
  nil
end

#get_user_details_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get user details Returns the current user&#x27;s account details including their plan

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/survey_monkey_swagger_client/api/users_and_groups_api.rb', line 128

def get_user_details_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersAndGroupsApi.get_user_details ...'
  end
  # resource path
  local_var_path = '/v3/users/me'

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  return_type = opts[:return_type]

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

#get_user_group(opts = {}) ⇒ nil

Get user group Return a group if the user account belongs to a group (users can only belong to one group)

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


167
168
169
170
 
# File 'lib/survey_monkey_swagger_client/api/users_and_groups_api.rb', line 167

def get_user_group(opts = {})
  get_user_group_with_http_info(opts)
  nil
end

#get_user_group_by_id(opts = {}) ⇒ nil

Get user group by id Returns a group’s details including the group’s owner and email address

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


215
216
217
218
 
# File 'lib/survey_monkey_swagger_client/api/users_and_groups_api.rb', line 215

def get_user_group_by_id(opts = {})
  get_user_group_by_id_with_http_info(opts)
  nil
end

#get_user_group_by_id_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get user group by id Returns a group’s details including the group’s owner and email address

Parameters:

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, 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
 
# File 'lib/survey_monkey_swagger_client/api/users_and_groups_api.rb', line 224

def get_user_group_by_id_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersAndGroupsApi.get_user_group_by_id ...'
  end
  # resource path
  local_var_path = '/v3/groups/GROUP_ID'

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  return_type = opts[:return_type]

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

#get_user_group_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get user group Return a group if the user account belongs to a group (users can only belong to one group)

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
206
207
208
209
210
 
# File 'lib/survey_monkey_swagger_client/api/users_and_groups_api.rb', line 176

def get_user_group_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersAndGroupsApi.get_user_group ...'
  end
  # resource path
  local_var_path = '/v3/groups'

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  return_type = opts[:return_type]

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