Class: SunshineConversationsClient::SwitchboardsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SwitchboardsApi

Returns a new instance of SwitchboardsApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_switchboard(app_id, opts = {}) ⇒ SwitchboardResponse

Create Switchboard Create a switchboard.

Parameters:

  • app_id (String) —

    Identifies the app.

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

    the optional parameters

Returns:



24
25
26
27
 
# File 'lib/sunshine-conversations-client/api/switchboards_api.rb', line 24

def create_switchboard(app_id, opts = {})
  data, _status_code, _headers = create_switchboard_with_http_info(app_id, opts)
  data
end

#create_switchboard_with_http_info(app_id, opts = {}) ⇒ Array<(SwitchboardResponse, Integer, Hash)>

Create Switchboard Create a switchboard.

Parameters:

  • app_id (String) —

    Identifies the app.

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

    the optional parameters

Returns:

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

    SwitchboardResponse data, response status code and response headers



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/sunshine-conversations-client/api/switchboards_api.rb', line 34

def create_switchboard_with_http_info(app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SwitchboardsApi.create_switchboard ...'
  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 SwitchboardsApi.create_switchboard"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/switchboards'.sub('{' + 'appId' + '}', CGI.escape(app_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] || 'SwitchboardResponse' 

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

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

Delete Switchboard Deletes the switchboard and all its switchboard integrations. The integrations linked to these switchboard integrations are not deleted and will start receiving all conversation events.

Parameters:

  • app_id (String) —

    Identifies the app.

  • switchboard_id (String) —

    Identifies the switchboard.

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

    the optional parameters

Returns:

  • (Object) 


87
88
89
90
 
# File 'lib/sunshine-conversations-client/api/switchboards_api.rb', line 87

def delete_switchboard(app_id, switchboard_id, opts = {})
  data, _status_code, _headers = delete_switchboard_with_http_info(app_id, switchboard_id, opts)
  data
end

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

Delete Switchboard Deletes the switchboard and all its switchboard integrations. The integrations linked to these switchboard integrations are not deleted and will start receiving all conversation events.

Parameters:

  • app_id (String) —

    Identifies the app.

  • switchboard_id (String) —

    Identifies the switchboard.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
143
144
145
146
147
 
# File 'lib/sunshine-conversations-client/api/switchboards_api.rb', line 98

def delete_switchboard_with_http_info(app_id, switchboard_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SwitchboardsApi.delete_switchboard ...'
  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 SwitchboardsApi.delete_switchboard"
  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 SwitchboardsApi.delete_switchboard"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/switchboards/{switchboardId}'.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] || '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: SwitchboardsApi#delete_switchboard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_switchboards(app_id, opts = {}) ⇒ SwitchboardListResponse

List Switchboards Lists all switchboards belonging to the app.

Parameters:

  • app_id (String) —

    Identifies the app.

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

    the optional parameters

Returns:



154
155
156
157
 
# File 'lib/sunshine-conversations-client/api/switchboards_api.rb', line 154

def list_switchboards(app_id, opts = {})
  data, _status_code, _headers = list_switchboards_with_http_info(app_id, opts)
  data
end

#list_switchboards_with_http_info(app_id, opts = {}) ⇒ Array<(SwitchboardListResponse, Integer, Hash)>

List Switchboards Lists all switchboards belonging to the app.

Parameters:

  • app_id (String) —

    Identifies the app.

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

    the optional parameters

Returns:

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

    SwitchboardListResponse data, response status code and response headers



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
203
204
205
206
207
208
209
 
# File 'lib/sunshine-conversations-client/api/switchboards_api.rb', line 164

def list_switchboards_with_http_info(app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SwitchboardsApi.list_switchboards ...'
  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 SwitchboardsApi.list_switchboards"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/switchboards'.sub('{' + 'appId' + '}', CGI.escape(app_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] || 'SwitchboardListResponse' 

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

#update_switchboard(app_id, switchboard_id, switchboard_update_body, opts = {}) ⇒ SwitchboardResponse

Update Switchboard Updates a switchboard record.

Parameters:

  • app_id (String) —

    Identifies the app.

  • switchboard_id (String) —

    Identifies the switchboard.

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

    the optional parameters

Returns:



218
219
220
221
 
# File 'lib/sunshine-conversations-client/api/switchboards_api.rb', line 218

def update_switchboard(app_id, switchboard_id, switchboard_update_body, opts = {})
  data, _status_code, _headers = update_switchboard_with_http_info(app_id, switchboard_id, switchboard_update_body, opts)
  data
end

#update_switchboard_with_http_info(app_id, switchboard_id, switchboard_update_body, opts = {}) ⇒ Array<(SwitchboardResponse, Integer, Hash)>

Update Switchboard Updates a switchboard record.

Parameters:

  • app_id (String) —

    Identifies the app.

  • switchboard_id (String) —

    Identifies the switchboard.

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

    the optional parameters

Returns:

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

    SwitchboardResponse data, response status code and response headers



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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/sunshine-conversations-client/api/switchboards_api.rb', line 230

def update_switchboard_with_http_info(app_id, switchboard_id, switchboard_update_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SwitchboardsApi.update_switchboard ...'
  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 SwitchboardsApi.update_switchboard"
  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 SwitchboardsApi.update_switchboard"
  end
  # verify the required parameter 'switchboard_update_body' is set
  if @api_client.config.client_side_validation && switchboard_update_body.nil?
    fail ArgumentError, "Missing the required parameter 'switchboard_update_body' when calling SwitchboardsApi.update_switchboard"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/switchboards/{switchboardId}'.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_update_body) 

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

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