Class: MessenteApi::GroupsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/messente_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/messente_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/messente_api/api/groups_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_group(group_name, opts = {}) ⇒ GroupEnvelope

Creates a new group with the provided name

Parameters:

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

    the optional parameters

Returns:



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

def create_group(group_name, opts = {})
  data, _status_code, _headers = create_group_with_http_info(group_name, opts)
  data
end

#create_group_with_http_info(group_name, opts = {}) ⇒ Array<(GroupEnvelope, Integer, Hash)>

Creates a new group with the provided name

Parameters:

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

    the optional parameters

Returns:

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

    GroupEnvelope 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/messente_api/api/groups_api.rb', line 35

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

  # 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(group_name) 

  # return_type
  return_type = opts[:return_type] || 'GroupEnvelope' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth']

  new_options = opts.merge(
    :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_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_group(group_id, opts = {}) ⇒ nil

Deletes a group

Parameters:

  • group_id (String) —

    String in UUID format

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

    the optional parameters

Returns:

  • (nil) 


88
89
90
91
 
# File 'lib/messente_api/api/groups_api.rb', line 88

def delete_group(group_id, opts = {})
  delete_group_with_http_info(group_id, opts)
  nil
end

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

Deletes a group

Parameters:

  • group_id (String) —

    String in UUID format

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/messente_api/api/groups_api.rb', line 97

def delete_group_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.delete_group ...'
  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_group"
  end
  # resource path
  local_var_path = '/phonebook/groups/{groupId}'.sub('{' + 'groupId' + '}', CGI.escape(group_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
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth']

  new_options = opts.merge(
    :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_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#fetch_group(group_id, opts = {}) ⇒ GroupEnvelope

Lists a group

Parameters:

  • group_id (String) —

    String in UUID format

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

    the optional parameters

Returns:



148
149
150
151
 
# File 'lib/messente_api/api/groups_api.rb', line 148

def fetch_group(group_id, opts = {})
  data, _status_code, _headers = fetch_group_with_http_info(group_id, opts)
  data
end

#fetch_group_with_http_info(group_id, opts = {}) ⇒ Array<(GroupEnvelope, Integer, Hash)>

Lists a group

Parameters:

  • group_id (String) —

    String in UUID format

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

    the optional parameters

Returns:

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

    GroupEnvelope data, response status code and response headers



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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/messente_api/api/groups_api.rb', line 157

def fetch_group_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.fetch_group ...'
  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.fetch_group"
  end
  # resource path
  local_var_path = '/phonebook/groups/{groupId}'.sub('{' + 'groupId' + '}', CGI.escape(group_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
  return_type = opts[:return_type] || 'GroupEnvelope' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth']

  new_options = opts.merge(
    :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#fetch_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#fetch_groups(opts = {}) ⇒ GroupListEnvelope

Returns all groups

Parameters:

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

    the optional parameters

Returns:



207
208
209
210
 
# File 'lib/messente_api/api/groups_api.rb', line 207

def fetch_groups(opts = {})
  data, _status_code, _headers = fetch_groups_with_http_info(opts)
  data
end

#fetch_groups_with_http_info(opts = {}) ⇒ Array<(GroupListEnvelope, Integer, Hash)>

Returns all groups

Parameters:

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

    the optional parameters

Returns:

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

    GroupListEnvelope data, response status code and response headers



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
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/messente_api/api/groups_api.rb', line 215

def fetch_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.fetch_groups ...'
  end
  # resource path
  local_var_path = '/phonebook/groups'

  # 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
  return_type = opts[:return_type] || 'GroupListEnvelope' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth']

  new_options = opts.merge(
    :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#fetch_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_group(group_id, group_name, opts = {}) ⇒ GroupEnvelope

Updates a group with the provided name

Parameters:

  • group_id (String) —

    String in UUID format

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

    the optional parameters

Returns:



263
264
265
266
 
# File 'lib/messente_api/api/groups_api.rb', line 263

def update_group(group_id, group_name, opts = {})
  data, _status_code, _headers = update_group_with_http_info(group_id, group_name, opts)
  data
end

#update_group_with_http_info(group_id, group_name, opts = {}) ⇒ Array<(GroupEnvelope, Integer, Hash)>

Updates a group with the provided name

Parameters:

  • group_id (String) —

    String in UUID format

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

    the optional parameters

Returns:

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

    GroupEnvelope data, response status code and response headers



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/messente_api/api/groups_api.rb', line 273

def update_group_with_http_info(group_id, group_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.update_group ...'
  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.update_group"
  end
  # verify the required parameter 'group_name' is set
  if @api_client.config.client_side_validation && group_name.nil?
    fail ArgumentError, "Missing the required parameter 'group_name' when calling GroupsApi.update_group"
  end
  # resource path
  local_var_path = '/phonebook/groups/{groupId}'.sub('{' + 'groupId' + '}', CGI.escape(group_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'])
  # 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(group_name) 

  # return_type
  return_type = opts[:return_type] || 'GroupEnvelope' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth']

  new_options = opts.merge(
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#update_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end