Class: SunshineConversationsClient::SwitchboardIntegrationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/sunshine-conversations-client/api/switchboard_integrations_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SwitchboardIntegrationsApi

Returns a new instance of SwitchboardIntegrationsApi.



16
17
18
 
# File 'lib/sunshine-conversations-client/api/switchboard_integrations_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/sunshine-conversations-client/api/switchboard_integrations_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#create_switchboard_integration(app_id, switchboard_id, switchboard_integration_create_body, opts = {}) ⇒ SwitchboardIntegrationResponse

Create Switchboard Integration Create a switchboard integration.

Parameters:

  • app_id (String) —

    Identifies the app.

  • switchboard_id (String) —

    Identifies the switchboard.

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/sunshine-conversations-client/api/switchboard_integrations_api.rb', line 26

def create_switchboard_integration(app_id, switchboard_id, switchboard_integration_create_body, opts = {})
  data, _status_code, _headers = create_switchboard_integration_with_http_info(app_id, switchboard_id, switchboard_integration_create_body, opts)
  data
end

#create_switchboard_integration_with_http_info(app_id, switchboard_id, switchboard_integration_create_body, opts = {}) ⇒ Array<(SwitchboardIntegrationResponse, Integer, Hash)>

Create Switchboard Integration Create a switchboard integration.

Parameters:

  • app_id (String) —

    Identifies the app.

  • switchboard_id (String) —

    Identifies the switchboard.

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

    the optional parameters

Returns:



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
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/sunshine-conversations-client/api/switchboard_integrations_api.rb', line 38

def create_switchboard_integration_with_http_info(app_id, switchboard_id, switchboard_integration_create_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SwitchboardIntegrationsApi.create_switchboard_integration ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling SwitchboardIntegrationsApi.create_switchboard_integration"
  end
  # verify the required parameter 'switchboard_id' is set
  if @api_client.config.client_side_validation && switchboard_id.nil?
    fail ArgumentError, "Missing the required parameter 'switchboard_id' when calling SwitchboardIntegrationsApi.create_switchboard_integration"
  end
  # verify the required parameter 'switchboard_integration_create_body' is set
  if @api_client.config.client_side_validation && switchboard_integration_create_body.nil?
    fail ArgumentError, "Missing the required parameter 'switchboard_integration_create_body' when calling SwitchboardIntegrationsApi.create_switchboard_integration"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/switchboards/{switchboardId}/switchboardIntegrations'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'switchboardId' + '}', CGI.escape(switchboard_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(switchboard_integration_create_body) 

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

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

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

#delete_switchboard_integration(app_id, switchboard_id, switchboard_integration_id, opts = {}) ⇒ Object

Delete Switchboard Integration Deletes the switchboard integration. If the deleted switchboard integration had an active status for some conversations, the default switchboard integration will replace it. Note that it is forbidden to delete a switchboard integration if it’s the default one (a new one must be chosen first) or if another switchboard integration’s ‘nextSwitchboardIntegrationId` refers to it. The integration that was linked to the deleted switchboard integration will start receiving all conversation events, regardless of the switchboard status.

Parameters:

  • app_id (String) —

    Identifies the app.

  • switchboard_id (String) —

    Identifies the switchboard.

  • switchboard_integration_id (String) —

    Identifies the switchboard integration.

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

    the optional parameters

Returns:

  • (Object) 


102
103
104
105
 
# File 'lib/sunshine-conversations-client/api/switchboard_integrations_api.rb', line 102

def delete_switchboard_integration(app_id, switchboard_id, switchboard_integration_id, opts = {})
  data, _status_code, _headers = delete_switchboard_integration_with_http_info(app_id, switchboard_id, switchboard_integration_id, opts)
  data
end

#delete_switchboard_integration_with_http_info(app_id, switchboard_id, switchboard_integration_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Delete Switchboard Integration Deletes the switchboard integration. If the deleted switchboard integration had an active status for some conversations, the default switchboard integration will replace it. Note that it is forbidden to delete a switchboard integration if it&#39;s the default one (a new one must be chosen first) or if another switchboard integration&#39;s &#x60;nextSwitchboardIntegrationId&#x60; refers to it. The integration that was linked to the deleted switchboard integration will start receiving all conversation events, regardless of the switchboard status.

Parameters:

  • app_id (String) —

    Identifies the app.

  • switchboard_id (String) —

    Identifies the switchboard.

  • switchboard_integration_id (String) —

    Identifies the switchboard integration.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/sunshine-conversations-client/api/switchboard_integrations_api.rb', line 114

def delete_switchboard_integration_with_http_info(app_id, switchboard_id, switchboard_integration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SwitchboardIntegrationsApi.delete_switchboard_integration ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling SwitchboardIntegrationsApi.delete_switchboard_integration"
  end
  # verify the required parameter 'switchboard_id' is set
  if @api_client.config.client_side_validation && switchboard_id.nil?
    fail ArgumentError, "Missing the required parameter 'switchboard_id' when calling SwitchboardIntegrationsApi.delete_switchboard_integration"
  end
  # verify the required parameter 'switchboard_integration_id' is set
  if @api_client.config.client_side_validation && switchboard_integration_id.nil?
    fail ArgumentError, "Missing the required parameter 'switchboard_integration_id' when calling SwitchboardIntegrationsApi.delete_switchboard_integration"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/switchboards/{switchboardId}/switchboardIntegrations/{switchboardIntegrationId}'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'switchboardId' + '}', CGI.escape(switchboard_id.to_s)).sub('{' + 'switchboardIntegrationId' + '}', CGI.escape(switchboard_integration_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] || 'Object' 

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

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

#list_switchboard_integrations(app_id, switchboard_id, opts = {}) ⇒ SwitchboardIntegrationListResponse

List Switchboard Integrations Lists all switchboard integrations linked to the switchboard.

Parameters:

  • app_id (String) —

    Identifies the app.

  • switchboard_id (String) —

    Identifies the switchboard.

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

    the optional parameters

Returns:



175
176
177
178
 
# File 'lib/sunshine-conversations-client/api/switchboard_integrations_api.rb', line 175

def list_switchboard_integrations(app_id, switchboard_id, opts = {})
  data, _status_code, _headers = list_switchboard_integrations_with_http_info(app_id, switchboard_id, opts)
  data
end

#list_switchboard_integrations_with_http_info(app_id, switchboard_id, opts = {}) ⇒ Array<(SwitchboardIntegrationListResponse, Integer, Hash)>

List Switchboard Integrations Lists all switchboard integrations linked to the switchboard.

Parameters:

  • app_id (String) —

    Identifies the app.

  • switchboard_id (String) —

    Identifies the switchboard.

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

    the optional parameters

Returns:



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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/sunshine-conversations-client/api/switchboard_integrations_api.rb', line 186

def list_switchboard_integrations_with_http_info(app_id, switchboard_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SwitchboardIntegrationsApi.list_switchboard_integrations ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling SwitchboardIntegrationsApi.list_switchboard_integrations"
  end
  # verify the required parameter 'switchboard_id' is set
  if @api_client.config.client_side_validation && switchboard_id.nil?
    fail ArgumentError, "Missing the required parameter 'switchboard_id' when calling SwitchboardIntegrationsApi.list_switchboard_integrations"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/switchboards/{switchboardId}/switchboardIntegrations'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'switchboardId' + '}', CGI.escape(switchboard_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] || 'SwitchboardIntegrationListResponse' 

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

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

#update_switchboard_integration(app_id, switchboard_id, switchboard_integration_id, switchboard_integration_update_body, opts = {}) ⇒ SwitchboardIntegrationResponse

Update Switchboard Integration Updates a switchboard integration record.

Parameters:

  • app_id (String) —

    Identifies the app.

  • switchboard_id (String) —

    Identifies the switchboard.

  • switchboard_integration_id (String) —

    Identifies the switchboard integration.

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

    the optional parameters

Returns:



245
246
247
248
 
# File 'lib/sunshine-conversations-client/api/switchboard_integrations_api.rb', line 245

def update_switchboard_integration(app_id, switchboard_id, switchboard_integration_id, switchboard_integration_update_body, opts = {})
  data, _status_code, _headers = update_switchboard_integration_with_http_info(app_id, switchboard_id, switchboard_integration_id, switchboard_integration_update_body, opts)
  data
end

#update_switchboard_integration_with_http_info(app_id, switchboard_id, switchboard_integration_id, switchboard_integration_update_body, opts = {}) ⇒ Array<(SwitchboardIntegrationResponse, Integer, Hash)>

Update Switchboard Integration Updates a switchboard integration record.

Parameters:

  • app_id (String) —

    Identifies the app.

  • switchboard_id (String) —

    Identifies the switchboard.

  • switchboard_integration_id (String) —

    Identifies the switchboard integration.

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

    the optional parameters

Returns:



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
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
 
# File 'lib/sunshine-conversations-client/api/switchboard_integrations_api.rb', line 258

def update_switchboard_integration_with_http_info(app_id, switchboard_id, switchboard_integration_id, switchboard_integration_update_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SwitchboardIntegrationsApi.update_switchboard_integration ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling SwitchboardIntegrationsApi.update_switchboard_integration"
  end
  # verify the required parameter 'switchboard_id' is set
  if @api_client.config.client_side_validation && switchboard_id.nil?
    fail ArgumentError, "Missing the required parameter 'switchboard_id' when calling SwitchboardIntegrationsApi.update_switchboard_integration"
  end
  # verify the required parameter 'switchboard_integration_id' is set
  if @api_client.config.client_side_validation && switchboard_integration_id.nil?
    fail ArgumentError, "Missing the required parameter 'switchboard_integration_id' when calling SwitchboardIntegrationsApi.update_switchboard_integration"
  end
  # verify the required parameter 'switchboard_integration_update_body' is set
  if @api_client.config.client_side_validation && switchboard_integration_update_body.nil?
    fail ArgumentError, "Missing the required parameter 'switchboard_integration_update_body' when calling SwitchboardIntegrationsApi.update_switchboard_integration"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/switchboards/{switchboardId}/switchboardIntegrations/{switchboardIntegrationId}'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'switchboardId' + '}', CGI.escape(switchboard_id.to_s)).sub('{' + 'switchboardIntegrationId' + '}', CGI.escape(switchboard_integration_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(switchboard_integration_update_body) 

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

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

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