Class: SmoochApi::IntegrationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/smooch-api/api/integration_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IntegrationApi

Returns a new instance of IntegrationApi.



19
20
21
 
# File 'lib/smooch-api/api/integration_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/smooch-api/api/integration_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_integration(appId, integrationCreateBody, opts = {}) ⇒ IntegrationResponse

Create an integration for the specified app.

Parameters:

  • appId —

    Identifies the app.

  • integrationCreateBody —

    Body for a createIntegration request. Additional arguments are necessary based on integration type. For detailed instructions, visit our [official docs](docs.smooch.io/rest/#create-integration)

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

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/smooch-api/api/integration_api.rb', line 29

def create_integration(appId, integrationCreateBody, opts = {})
  data, _status_code, _headers = create_integration_with_http_info(appId, integrationCreateBody, opts)
  return data
end

#create_integration_menu(appId, integrationId, menuCreateBody, opts = {}) ⇒ MenuResponse

Create the specified integration’s menu, overriding the app menu if configured.

Parameters:

  • appId —

    Identifies the app.

  • integrationId —

    Identifies the integration.

  • menuCreateBody —

    Body for a createMenu request.

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

    the optional parameters

Returns:



91
92
93
94
 
# File 'lib/smooch-api/api/integration_api.rb', line 91

def create_integration_menu(appId, integrationId, menuCreateBody, opts = {})
  data, _status_code, _headers = create_integration_menu_with_http_info(appId, integrationId, menuCreateBody, opts)
  return data
end

#create_integration_menu_with_http_info(appId, integrationId, menuCreateBody, opts = {}) ⇒ Array<(MenuResponse, Fixnum, Hash)>

Create the specified integration’s menu, overriding the app menu if configured.

Parameters:

  • appId —

    Identifies the app.

  • integrationId —

    Identifies the integration.

  • menuCreateBody —

    Body for a createMenu request.

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

    the optional parameters

Returns:

  • (Array<(MenuResponse, Fixnum, Hash)>) —

    MenuResponse data, response status code and response headers



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
 
# File 'lib/smooch-api/api/integration_api.rb', line 103

def create_integration_menu_with_http_info(appId, integrationId, menuCreateBody, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationApi.create_integration_menu ..."
  end
  # verify the required parameter 'appId' is set
  if @api_client.config.client_side_validation && appId.nil?
    fail ArgumentError, "Missing the required parameter 'appId' when calling IntegrationApi.create_integration_menu"
  end
  # verify the required parameter 'integrationId' is set
  if @api_client.config.client_side_validation && integrationId.nil?
    fail ArgumentError, "Missing the required parameter 'integrationId' when calling IntegrationApi.create_integration_menu"
  end
  # verify the required parameter 'menuCreateBody' is set
  if @api_client.config.client_side_validation && menuCreateBody.nil?
    fail ArgumentError, "Missing the required parameter 'menuCreateBody' when calling IntegrationApi.create_integration_menu"
  end
  # resource path
  local_var_path = "/v1.1/apps/{appId}/integrations/{integrationId}/menu".sub('{' + 'appId' + '}', appId.to_s).sub('{' + 'integrationId' + '}', integrationId.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(menuCreateBody)
  auth_names = ['basicAuth', 'jwt']
  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 => 'MenuResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationApi#create_integration_menu\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_integration_with_http_info(appId, integrationCreateBody, opts = {}) ⇒ Array<(IntegrationResponse, Fixnum, Hash)>

Create an integration for the specified app.

Parameters:

  • appId —

    Identifies the app.

  • integrationCreateBody —

    Body for a createIntegration request. Additional arguments are necessary based on integration type. For detailed instructions, visit our [official docs](docs.smooch.io/rest/#create-integration)

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

    the optional parameters

Returns:

  • (Array<(IntegrationResponse, Fixnum, Hash)>) —

    IntegrationResponse data, response status code and response headers



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/smooch-api/api/integration_api.rb', line 40

def create_integration_with_http_info(appId, integrationCreateBody, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationApi.create_integration ..."
  end
  # verify the required parameter 'appId' is set
  if @api_client.config.client_side_validation && appId.nil?
    fail ArgumentError, "Missing the required parameter 'appId' when calling IntegrationApi.create_integration"
  end
  # verify the required parameter 'integrationCreateBody' is set
  if @api_client.config.client_side_validation && integrationCreateBody.nil?
    fail ArgumentError, "Missing the required parameter 'integrationCreateBody' when calling IntegrationApi.create_integration"
  end
  # resource path
  local_var_path = "/v1.1/apps/{appId}/integrations".sub('{' + 'appId' + '}', appId.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(integrationCreateBody)
  auth_names = ['basicAuth', 'jwt']
  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 => 'IntegrationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationApi#create_integration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_integration(appId, integrationId, opts = {}) ⇒ nil

Delete the specified integration.

Parameters:

  • appId —

    Identifies the app.

  • integrationId —

    Identifies the integration.

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

    the optional parameters

Returns:

  • (nil) 


157
158
159
160
 
# File 'lib/smooch-api/api/integration_api.rb', line 157

def delete_integration(appId, integrationId, opts = {})
  delete_integration_with_http_info(appId, integrationId, opts)
  return nil
end

#delete_integration_menu(appId, integrationId, opts = {}) ⇒ nil

Delete the specified integration’s menu.

Parameters:

  • appId —

    Identifies the app.

  • integrationId —

    Identifies the integration.

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

    the optional parameters

Returns:

  • (nil) 


217
218
219
220
 
# File 'lib/smooch-api/api/integration_api.rb', line 217

def delete_integration_menu(appId, integrationId, opts = {})
  delete_integration_menu_with_http_info(appId, integrationId, opts)
  return nil
end

#delete_integration_menu_with_http_info(appId, integrationId, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete the specified integration’s menu.

Parameters:

  • appId —

    Identifies the app.

  • integrationId —

    Identifies the integration.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/smooch-api/api/integration_api.rb', line 228

def delete_integration_menu_with_http_info(appId, integrationId, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationApi.delete_integration_menu ..."
  end
  # verify the required parameter 'appId' is set
  if @api_client.config.client_side_validation && appId.nil?
    fail ArgumentError, "Missing the required parameter 'appId' when calling IntegrationApi.delete_integration_menu"
  end
  # verify the required parameter 'integrationId' is set
  if @api_client.config.client_side_validation && integrationId.nil?
    fail ArgumentError, "Missing the required parameter 'integrationId' when calling IntegrationApi.delete_integration_menu"
  end
  # resource path
  local_var_path = "/v1.1/apps/{appId}/integrations/{integrationId}/menu".sub('{' + 'appId' + '}', appId.to_s).sub('{' + 'integrationId' + '}', integrationId.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth', 'jwt']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationApi#delete_integration_menu\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_integration_with_http_info(appId, integrationId, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete the specified integration.

Parameters:

  • appId —

    Identifies the app.

  • integrationId —

    Identifies the integration.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/smooch-api/api/integration_api.rb', line 168

def delete_integration_with_http_info(appId, integrationId, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationApi.delete_integration ..."
  end
  # verify the required parameter 'appId' is set
  if @api_client.config.client_side_validation && appId.nil?
    fail ArgumentError, "Missing the required parameter 'appId' when calling IntegrationApi.delete_integration"
  end
  # verify the required parameter 'integrationId' is set
  if @api_client.config.client_side_validation && integrationId.nil?
    fail ArgumentError, "Missing the required parameter 'integrationId' when calling IntegrationApi.delete_integration"
  end
  # resource path
  local_var_path = "/v1.1/apps/{appId}/integrations/{integrationId}".sub('{' + 'appId' + '}', appId.to_s).sub('{' + 'integrationId' + '}', integrationId.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth', 'jwt']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationApi#delete_integration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_integration(appId, integrationId, opts = {}) ⇒ IntegrationResponse

Get the specified integration.

Parameters:

  • appId —

    Identifies the app.

  • integrationId —

    Identifies the integration.

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

    the optional parameters

Returns:



277
278
279
280
 
# File 'lib/smooch-api/api/integration_api.rb', line 277

def get_integration(appId, integrationId, opts = {})
  data, _status_code, _headers = get_integration_with_http_info(appId, integrationId, opts)
  return data
end

#get_integration_menu(appId, integrationId, opts = {}) ⇒ MenuResponse

Get the specified integration’s menu.

Parameters:

  • appId —

    Identifies the app.

  • integrationId —

    Identifies the integration.

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

    the optional parameters

Returns:



338
339
340
341
 
# File 'lib/smooch-api/api/integration_api.rb', line 338

def get_integration_menu(appId, integrationId, opts = {})
  data, _status_code, _headers = get_integration_menu_with_http_info(appId, integrationId, opts)
  return data
end

#get_integration_menu_with_http_info(appId, integrationId, opts = {}) ⇒ Array<(MenuResponse, Fixnum, Hash)>

Get the specified integration&#39;s menu.

Parameters:

  • appId —

    Identifies the app.

  • integrationId —

    Identifies the integration.

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

    the optional parameters

Returns:

  • (Array<(MenuResponse, Fixnum, Hash)>) —

    MenuResponse data, response status code and response headers



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/smooch-api/api/integration_api.rb', line 349

def get_integration_menu_with_http_info(appId, integrationId, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationApi.get_integration_menu ..."
  end
  # verify the required parameter 'appId' is set
  if @api_client.config.client_side_validation && appId.nil?
    fail ArgumentError, "Missing the required parameter 'appId' when calling IntegrationApi.get_integration_menu"
  end
  # verify the required parameter 'integrationId' is set
  if @api_client.config.client_side_validation && integrationId.nil?
    fail ArgumentError, "Missing the required parameter 'integrationId' when calling IntegrationApi.get_integration_menu"
  end
  # resource path
  local_var_path = "/v1.1/apps/{appId}/integrations/{integrationId}/menu".sub('{' + 'appId' + '}', appId.to_s).sub('{' + 'integrationId' + '}', integrationId.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth', 'jwt']
  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 => 'MenuResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationApi#get_integration_menu\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_integration_profile(appId, integrationId, opts = {}) ⇒ GetIntegrationProfileResponse

Get the specified integration’s profile.

Parameters:

  • appId —

    Identifies the app.

  • integrationId —

    Identifies the integration.

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

    the optional parameters

Returns:



399
400
401
402
 
# File 'lib/smooch-api/api/integration_api.rb', line 399

def get_integration_profile(appId, integrationId, opts = {})
  data, _status_code, _headers = get_integration_profile_with_http_info(appId, integrationId, opts)
  return data
end

#get_integration_profile_with_http_info(appId, integrationId, opts = {}) ⇒ Array<(GetIntegrationProfileResponse, Fixnum, Hash)>

Get the specified integration’s profile.

Parameters:

  • appId —

    Identifies the app.

  • integrationId —

    Identifies the integration.

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

    the optional parameters

Returns:



410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/smooch-api/api/integration_api.rb', line 410

def get_integration_profile_with_http_info(appId, integrationId, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationApi.get_integration_profile ..."
  end
  # verify the required parameter 'appId' is set
  if @api_client.config.client_side_validation && appId.nil?
    fail ArgumentError, "Missing the required parameter 'appId' when calling IntegrationApi.get_integration_profile"
  end
  # verify the required parameter 'integrationId' is set
  if @api_client.config.client_side_validation && integrationId.nil?
    fail ArgumentError, "Missing the required parameter 'integrationId' when calling IntegrationApi.get_integration_profile"
  end
  # resource path
  local_var_path = "/v1.1/apps/{appId}/integrations/{integrationId}/profile".sub('{' + 'appId' + '}', appId.to_s).sub('{' + 'integrationId' + '}', integrationId.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth', 'jwt']
  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 => 'GetIntegrationProfileResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationApi#get_integration_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_integration_with_http_info(appId, integrationId, opts = {}) ⇒ Array<(IntegrationResponse, Fixnum, Hash)>

Get the specified integration.

Parameters:

  • appId —

    Identifies the app.

  • integrationId —

    Identifies the integration.

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

    the optional parameters

Returns:

  • (Array<(IntegrationResponse, Fixnum, Hash)>) —

    IntegrationResponse data, response status code and response headers



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
325
326
327
328
329
330
 
# File 'lib/smooch-api/api/integration_api.rb', line 288

def get_integration_with_http_info(appId, integrationId, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationApi.get_integration ..."
  end
  # verify the required parameter 'appId' is set
  if @api_client.config.client_side_validation && appId.nil?
    fail ArgumentError, "Missing the required parameter 'appId' when calling IntegrationApi.get_integration"
  end
  # verify the required parameter 'integrationId' is set
  if @api_client.config.client_side_validation && integrationId.nil?
    fail ArgumentError, "Missing the required parameter 'integrationId' when calling IntegrationApi.get_integration"
  end
  # resource path
  local_var_path = "/v1.1/apps/{appId}/integrations/{integrationId}".sub('{' + 'appId' + '}', appId.to_s).sub('{' + 'integrationId' + '}', integrationId.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth', 'jwt']
  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 => 'IntegrationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationApi#get_integration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_integrations(appId, opts = {}) ⇒ ListIntegrationsResponse

List integrations for the specified app.

Parameters:

  • appId —

    Identifies the app.

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

    the optional parameters

Options Hash (opts):

  • :types (String) —

    List of types to filter the query by. More than one value can be specified through comma separation e.g. ?types&#x3D;twilio,line.

  • :limit (Integer) —

    The number of records to return. (default to 25)

  • :offset (Integer) —

    The number of initial records to skip before picking records to return. (default to 0)

Returns:



462
463
464
465
 
# File 'lib/smooch-api/api/integration_api.rb', line 462

def list_integrations(appId, opts = {})
  data, _status_code, _headers = list_integrations_with_http_info(appId, opts)
  return data
end

#list_integrations_with_http_info(appId, opts = {}) ⇒ Array<(ListIntegrationsResponse, Fixnum, Hash)>

List integrations for the specified app.

Parameters:

  • appId —

    Identifies the app.

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

    the optional parameters

Options Hash (opts):

  • :types (String) —

    List of types to filter the query by. More than one value can be specified through comma separation e.g. ?types&#x3D;twilio,line.

  • :limit (Integer) —

    The number of records to return.

  • :offset (Integer) —

    The number of initial records to skip before picking records to return.

Returns:

  • (Array<(ListIntegrationsResponse, Fixnum, Hash)>) —

    ListIntegrationsResponse data, response status code and response headers



475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
 
# File 'lib/smooch-api/api/integration_api.rb', line 475

def list_integrations_with_http_info(appId, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationApi.list_integrations ..."
  end
  # verify the required parameter 'appId' is set
  if @api_client.config.client_side_validation && appId.nil?
    fail ArgumentError, "Missing the required parameter 'appId' when calling IntegrationApi.list_integrations"
  end
  # resource path
  local_var_path = "/v1.1/apps/{appId}/integrations".sub('{' + 'appId' + '}', appId.to_s)

  # query parameters
  query_params = {}
  query_params[:'types'] = opts[:'types'] if !opts[:'types'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth', 'jwt']
  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 => 'ListIntegrationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationApi#list_integrations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_integration(appId, integrationId, integrationUpdateBody, opts = {}) ⇒ IntegrationResponse

Update the specified integration.

Parameters:

  • appId —

    Identifies the app.

  • integrationId —

    Identifies the integration.

  • integrationUpdateBody —

    Body for a updateIntegration request. Additional arguments are necessary based on integration type. For detailed instructions, visit our [official docs](docs.smooch.io/rest/#update-integration)

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

    the optional parameters

Returns:



525
526
527
528
 
# File 'lib/smooch-api/api/integration_api.rb', line 525

def update_integration(appId, integrationId, integrationUpdateBody, opts = {})
  data, _status_code, _headers = update_integration_with_http_info(appId, integrationId, integrationUpdateBody, opts)
  return data
end

#update_integration_menu(appId, integrationId, menuUpdateBody, opts = {}) ⇒ MenuResponse

Update the specified integration’s menu.

Parameters:

  • appId —

    Identifies the app.

  • integrationId —

    Identifies the integration.

  • menuUpdateBody —

    Body for a updateMenu request.

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

    the optional parameters

Returns:



592
593
594
595
 
# File 'lib/smooch-api/api/integration_api.rb', line 592

def update_integration_menu(appId, integrationId, menuUpdateBody, opts = {})
  data, _status_code, _headers = update_integration_menu_with_http_info(appId, integrationId, menuUpdateBody, opts)
  return data
end

#update_integration_menu_with_http_info(appId, integrationId, menuUpdateBody, opts = {}) ⇒ Array<(MenuResponse, Fixnum, Hash)>

Update the specified integration’s menu.

Parameters:

  • appId —

    Identifies the app.

  • integrationId —

    Identifies the integration.

  • menuUpdateBody —

    Body for a updateMenu request.

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

    the optional parameters

Returns:

  • (Array<(MenuResponse, Fixnum, Hash)>) —

    MenuResponse data, response status code and response headers



604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'lib/smooch-api/api/integration_api.rb', line 604

def update_integration_menu_with_http_info(appId, integrationId, menuUpdateBody, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationApi.update_integration_menu ..."
  end
  # verify the required parameter 'appId' is set
  if @api_client.config.client_side_validation && appId.nil?
    fail ArgumentError, "Missing the required parameter 'appId' when calling IntegrationApi.update_integration_menu"
  end
  # verify the required parameter 'integrationId' is set
  if @api_client.config.client_side_validation && integrationId.nil?
    fail ArgumentError, "Missing the required parameter 'integrationId' when calling IntegrationApi.update_integration_menu"
  end
  # verify the required parameter 'menuUpdateBody' is set
  if @api_client.config.client_side_validation && menuUpdateBody.nil?
    fail ArgumentError, "Missing the required parameter 'menuUpdateBody' when calling IntegrationApi.update_integration_menu"
  end
  # resource path
  local_var_path = "/v1.1/apps/{appId}/integrations/{integrationId}/menu".sub('{' + 'appId' + '}', appId.to_s).sub('{' + 'integrationId' + '}', integrationId.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(menuUpdateBody)
  auth_names = ['basicAuth', 'jwt']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'MenuResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationApi#update_integration_menu\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_integration_profile(appId, integrationId, integrationProfileBody, opts = {}) ⇒ nil

Update the specified integration’s profile.

Parameters:

  • appId —

    Identifies the app.

  • integrationId —

    Identifies the integration.

  • integrationProfileBody —

    Body for a profileUpdate request.

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

    the optional parameters

Returns:

  • (nil) 


659
660
661
662
 
# File 'lib/smooch-api/api/integration_api.rb', line 659

def update_integration_profile(appId, integrationId, integrationProfileBody, opts = {})
  update_integration_profile_with_http_info(appId, integrationId, integrationProfileBody, opts)
  return nil
end

#update_integration_profile_with_http_info(appId, integrationId, integrationProfileBody, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update the specified integration’s profile.

Parameters:

  • appId —

    Identifies the app.

  • integrationId —

    Identifies the integration.

  • integrationProfileBody —

    Body for a profileUpdate request.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'lib/smooch-api/api/integration_api.rb', line 671

def update_integration_profile_with_http_info(appId, integrationId, integrationProfileBody, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationApi.update_integration_profile ..."
  end
  # verify the required parameter 'appId' is set
  if @api_client.config.client_side_validation && appId.nil?
    fail ArgumentError, "Missing the required parameter 'appId' when calling IntegrationApi.update_integration_profile"
  end
  # verify the required parameter 'integrationId' is set
  if @api_client.config.client_side_validation && integrationId.nil?
    fail ArgumentError, "Missing the required parameter 'integrationId' when calling IntegrationApi.update_integration_profile"
  end
  # verify the required parameter 'integrationProfileBody' is set
  if @api_client.config.client_side_validation && integrationProfileBody.nil?
    fail ArgumentError, "Missing the required parameter 'integrationProfileBody' when calling IntegrationApi.update_integration_profile"
  end
  # resource path
  local_var_path = "/v1.1/apps/{appId}/integrations/{integrationId}/profile".sub('{' + 'appId' + '}', appId.to_s).sub('{' + 'integrationId' + '}', integrationId.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(integrationProfileBody)
  auth_names = ['basicAuth', 'jwt']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationApi#update_integration_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_integration_with_http_info(appId, integrationId, integrationUpdateBody, opts = {}) ⇒ Array<(IntegrationResponse, Fixnum, Hash)>

Update the specified integration.

Parameters:

  • appId —

    Identifies the app.

  • integrationId —

    Identifies the integration.

  • integrationUpdateBody —

    Body for a updateIntegration request. Additional arguments are necessary based on integration type. For detailed instructions, visit our [official docs](docs.smooch.io/rest/#update-integration)

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

    the optional parameters

Returns:

  • (Array<(IntegrationResponse, Fixnum, Hash)>) —

    IntegrationResponse data, response status code and response headers



537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
 
# File 'lib/smooch-api/api/integration_api.rb', line 537

def update_integration_with_http_info(appId, integrationId, integrationUpdateBody, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationApi.update_integration ..."
  end
  # verify the required parameter 'appId' is set
  if @api_client.config.client_side_validation && appId.nil?
    fail ArgumentError, "Missing the required parameter 'appId' when calling IntegrationApi.update_integration"
  end
  # verify the required parameter 'integrationId' is set
  if @api_client.config.client_side_validation && integrationId.nil?
    fail ArgumentError, "Missing the required parameter 'integrationId' when calling IntegrationApi.update_integration"
  end
  # verify the required parameter 'integrationUpdateBody' is set
  if @api_client.config.client_side_validation && integrationUpdateBody.nil?
    fail ArgumentError, "Missing the required parameter 'integrationUpdateBody' when calling IntegrationApi.update_integration"
  end
  # resource path
  local_var_path = "/v1.1/apps/{appId}/integrations/{integrationId}".sub('{' + 'appId' + '}', appId.to_s).sub('{' + 'integrationId' + '}', integrationId.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(integrationUpdateBody)
  auth_names = ['basicAuth', 'jwt']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'IntegrationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationApi#update_integration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#upload_integration_profile_photo(appId, integrationId, source, opts = {}) ⇒ UploadIntegrationProfilePhotoResponse

Upload a photo to be used for the the specified integration’s profile.

Parameters:

  • appId —

    Identifies the app.

  • integrationId —

    Identifies the integration.

  • source —

    Photo to be uploaded

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

    the optional parameters

Returns:



725
726
727
728
 
# File 'lib/smooch-api/api/integration_api.rb', line 725

def upload_integration_profile_photo(appId, integrationId, source, opts = {})
  data, _status_code, _headers = upload_integration_profile_photo_with_http_info(appId, integrationId, source, opts)
  return data
end

#upload_integration_profile_photo_with_http_info(appId, integrationId, source, opts = {}) ⇒ Array<(UploadIntegrationProfilePhotoResponse, Fixnum, Hash)>

Upload a photo to be used for the the specified integration’s profile.

Parameters:

  • appId —

    Identifies the app.

  • integrationId —

    Identifies the integration.

  • source —

    Photo to be uploaded

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

    the optional parameters

Returns:



737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
 
# File 'lib/smooch-api/api/integration_api.rb', line 737

def upload_integration_profile_photo_with_http_info(appId, integrationId, source, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationApi.upload_integration_profile_photo ..."
  end
  # verify the required parameter 'appId' is set
  if @api_client.config.client_side_validation && appId.nil?
    fail ArgumentError, "Missing the required parameter 'appId' when calling IntegrationApi.upload_integration_profile_photo"
  end
  # verify the required parameter 'integrationId' is set
  if @api_client.config.client_side_validation && integrationId.nil?
    fail ArgumentError, "Missing the required parameter 'integrationId' when calling IntegrationApi.upload_integration_profile_photo"
  end
  # verify the required parameter 'source' is set
  if @api_client.config.client_side_validation && source.nil?
    fail ArgumentError, "Missing the required parameter 'source' when calling IntegrationApi.upload_integration_profile_photo"
  end
  # resource path
  local_var_path = "/v1.1/apps/{appId}/integrations/{integrationId}/profile/photo".sub('{' + 'appId' + '}', appId.to_s).sub('{' + 'integrationId' + '}', integrationId.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params["source"] = source

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth', 'jwt']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UploadIntegrationProfilePhotoResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationApi#upload_integration_profile_photo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end