Class: OneMsgChatApi::GroupsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/one_msg_chat_api/api/groups_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ GroupsApi

Returns a new instance of GroupsApi.



19
20
21
 
# File 'lib/one_msg_chat_api/api/groups_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/one_msg_chat_api/api/groups_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_groups(token, opts = {}) ⇒ CreateGroups200Response

Create Group

Parameters:

  • token (String) —

    JWT token or API key for authorization

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/one_msg_chat_api/api/groups_api.rb', line 26

def create_groups(token, opts = {})
  data, _status_code, _headers = create_groups_with_http_info(token, opts)
  data
end

#create_groups_group_id(group_id, token, opts = {}) ⇒ Hash<String, Object>

Update Group Info

Parameters:

  • group_id (String)
  • token (String) —

    JWT token or API key for authorization

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


89
90
91
92
 
# File 'lib/one_msg_chat_api/api/groups_api.rb', line 89

def create_groups_group_id(group_id, token, opts = {})
  data, _status_code, _headers = create_groups_group_id_with_http_info(group_id, token, opts)
  data
end

#create_groups_group_id_invitelink(group_id, token, opts = {}) ⇒ Hash<String, Object>

Reset Invite Link

Parameters:

  • group_id (String)
  • token (String) —

    JWT token or API key for authorization

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


157
158
159
160
 
# File 'lib/one_msg_chat_api/api/groups_api.rb', line 157

def create_groups_group_id_invitelink(group_id, token, opts = {})
  data, _status_code, _headers = create_groups_group_id_invitelink_with_http_info(group_id, token, opts)
  data
end

#create_groups_group_id_invitelink_with_http_info(group_id, token, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Reset Invite Link

Parameters:

  • group_id (String)
  • token (String) —

    JWT token or API key for authorization

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



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
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/one_msg_chat_api/api/groups_api.rb', line 167

def create_groups_group_id_invitelink_with_http_info(group_id, token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.create_groups_group_id_invitelink ...'
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.create_groups_group_id_invitelink"
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling GroupsApi.create_groups_group_id_invitelink"
  end
  # resource path
  local_var_path = '/groups/{groupId}/inviteLink'.sub('{groupId}', CGI.escape(group_id.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Hash<String, Object>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"GroupsApi.create_groups_group_id_invitelink",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#create_groups_group_id_invitelink\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_groups_group_id_with_http_info(group_id, token, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Update Group Info

Parameters:

  • group_id (String)
  • token (String) —

    JWT token or API key for authorization

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/one_msg_chat_api/api/groups_api.rb', line 99

def create_groups_group_id_with_http_info(group_id, token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.create_groups_group_id ...'
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.create_groups_group_id"
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling GroupsApi.create_groups_group_id"
  end
  # resource path
  local_var_path = '/groups/{groupId}'.sub('{groupId}', CGI.escape(group_id.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Hash<String, Object>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"GroupsApi.create_groups_group_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#create_groups_group_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_groups_with_http_info(token, opts = {}) ⇒ Array<(CreateGroups200Response, Integer, Hash)>

Create Group

Parameters:

  • token (String) —

    JWT token or API key for authorization

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

    the optional parameters

Returns:

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

    CreateGroups200Response data, response status code and response headers



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
75
76
77
78
79
80
81
82
 
# File 'lib/one_msg_chat_api/api/groups_api.rb', line 35

def create_groups_with_http_info(token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.create_groups ...'
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling GroupsApi.create_groups"
  end
  # resource path
  local_var_path = '/groups'

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'CreateGroups200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"GroupsApi.create_groups",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#create_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_groups_group_id(group_id, token, opts = {}) ⇒ DeleteGroupsGroupId200Response

Delete Group

Parameters:

  • group_id (String)
  • token (String) —

    JWT token or API key for authorization

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

    the optional parameters

Returns:



225
226
227
228
 
# File 'lib/one_msg_chat_api/api/groups_api.rb', line 225

def delete_groups_group_id(group_id, token, opts = {})
  data, _status_code, _headers = delete_groups_group_id_with_http_info(group_id, token, opts)
  data
end

#delete_groups_group_id_with_http_info(group_id, token, opts = {}) ⇒ Array<(DeleteGroupsGroupId200Response, Integer, Hash)>

Delete Group

Parameters:

  • group_id (String)
  • token (String) —

    JWT token or API key for authorization

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

    the optional parameters

Returns:



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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/one_msg_chat_api/api/groups_api.rb', line 235

def delete_groups_group_id_with_http_info(group_id, token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.delete_groups_group_id ...'
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.delete_groups_group_id"
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling GroupsApi.delete_groups_group_id"
  end
  # resource path
  local_var_path = '/groups/{groupId}'.sub('{groupId}', CGI.escape(group_id.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'DeleteGroupsGroupId200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"GroupsApi.delete_groups_group_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#delete_groups_group_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_groups_group_id(group_id, token, opts = {}) ⇒ Hash<String, Object>

Get Group Info

Parameters:

  • group_id (String)
  • token (String) —

    JWT token or API key for authorization

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


293
294
295
296
 
# File 'lib/one_msg_chat_api/api/groups_api.rb', line 293

def get_groups_group_id(group_id, token, opts = {})
  data, _status_code, _headers = get_groups_group_id_with_http_info(group_id, token, opts)
  data
end

#get_groups_group_id_invitelink(group_id, token, opts = {}) ⇒ Hash<String, Object>

Get Invite Link

Parameters:

  • group_id (String)
  • token (String) —

    JWT token or API key for authorization

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


361
362
363
364
 
# File 'lib/one_msg_chat_api/api/groups_api.rb', line 361

def get_groups_group_id_invitelink(group_id, token, opts = {})
  data, _status_code, _headers = get_groups_group_id_invitelink_with_http_info(group_id, token, opts)
  data
end

#get_groups_group_id_invitelink_with_http_info(group_id, token, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Get Invite Link

Parameters:

  • group_id (String)
  • token (String) —

    JWT token or API key for authorization

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



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
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/one_msg_chat_api/api/groups_api.rb', line 371

def get_groups_group_id_invitelink_with_http_info(group_id, token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.get_groups_group_id_invitelink ...'
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.get_groups_group_id_invitelink"
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling GroupsApi.get_groups_group_id_invitelink"
  end
  # resource path
  local_var_path = '/groups/{groupId}/inviteLink'.sub('{groupId}', CGI.escape(group_id.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Hash<String, Object>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"GroupsApi.get_groups_group_id_invitelink",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#get_groups_group_id_invitelink\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_groups_group_id_with_http_info(group_id, token, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Get Group Info

Parameters:

  • group_id (String)
  • token (String) —

    JWT token or API key for authorization

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



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
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/one_msg_chat_api/api/groups_api.rb', line 303

def get_groups_group_id_with_http_info(group_id, token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.get_groups_group_id ...'
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.get_groups_group_id"
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling GroupsApi.get_groups_group_id"
  end
  # resource path
  local_var_path = '/groups/{groupId}'.sub('{groupId}', CGI.escape(group_id.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Hash<String, Object>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"GroupsApi.get_groups_group_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#get_groups_group_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_groups(token, opts = {}) ⇒ Hash<String, Object>

Get Groups List

Parameters:

  • token (String) —

    JWT token or API key for authorization

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


428
429
430
431
 
# File 'lib/one_msg_chat_api/api/groups_api.rb', line 428

def list_groups(token, opts = {})
  data, _status_code, _headers = list_groups_with_http_info(token, opts)
  data
end

#list_groups_with_http_info(token, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Get Groups List

Parameters:

  • token (String) —

    JWT token or API key for authorization

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



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
479
480
481
482
483
484
 
# File 'lib/one_msg_chat_api/api/groups_api.rb', line 437

def list_groups_with_http_info(token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.list_groups ...'
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling GroupsApi.list_groups"
  end
  # resource path
  local_var_path = '/groups'

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Hash<String, Object>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"GroupsApi.list_groups",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#list_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end