Class: SunshineConversationsClient::AppsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AppsApi

Returns a new instance of AppsApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_app(app_create_body, opts = {}) ⇒ AppResponse

Create App Creates a new app. When using [service account](#service-accounts) credentials, the service account is automatically granted access to the app.

Parameters:

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

    the optional parameters

Returns:



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

def create_app(app_create_body, opts = {})
  data, _status_code, _headers = create_app_with_http_info(app_create_body, opts)
  data
end

#create_app_with_http_info(app_create_body, opts = {}) ⇒ Array<(AppResponse, Integer, Hash)>

Create App Creates a new app. When using [service account](#service-accounts) credentials, the service account is automatically granted access to the app.

Parameters:

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

    the optional parameters

Returns:

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

    AppResponse 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
80
81
 
# File 'lib/sunshine-conversations-client/api/apps_api.rb', line 34

def create_app_with_http_info(app_create_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.create_app ...'
  end
  # verify the required parameter 'app_create_body' is set
  if @api_client.config.client_side_validation && app_create_body.nil?
    fail ArgumentError, "Missing the required parameter 'app_create_body' when calling AppsApi.create_app"
  end
  # resource path
  local_var_path = '/v2/apps'

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

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

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

#delete_app(app_id, opts = {}) ⇒ Object

Delete App Removes the specified app, including all its enabled integrations.

Parameters:

  • app_id (String) —

    Identifies the app.

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

    the optional parameters

Returns:

  • (Object) 


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

def delete_app(app_id, opts = {})
  data, _status_code, _headers = delete_app_with_http_info(app_id, opts)
  data
end

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

Delete App Removes the specified app, including all its enabled integrations.

Parameters:

  • app_id (String) —

    Identifies the app.

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

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

#get_app(app_id, opts = {}) ⇒ AppResponse

Get App Fetches an individual app.

Parameters:

  • app_id (String) —

    Identifies the app.

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

    the optional parameters

Returns:



150
151
152
153
 
# File 'lib/sunshine-conversations-client/api/apps_api.rb', line 150

def get_app(app_id, opts = {})
  data, _status_code, _headers = get_app_with_http_info(app_id, opts)
  data
end

#get_app_with_http_info(app_id, opts = {}) ⇒ Array<(AppResponse, Integer, Hash)>

Get App Fetches an individual app.

Parameters:

  • app_id (String) —

    Identifies the app.

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

    the optional parameters

Returns:

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

    AppResponse data, response status code and response headers



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
203
204
205
 
# File 'lib/sunshine-conversations-client/api/apps_api.rb', line 160

def get_app_with_http_info(app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.get_app ...'
  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 AppsApi.get_app"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}'.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] || 'AppResponse' 

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

#list_apps(opts = {}) ⇒ AppListResponse

List Apps Lists all apps that a user is part of. This API is paginated through [cursor pagination](#section/Introduction/API-pagination-and-records-limits). “‘shell /v2/apps?page=5e1606762556d93e9c176f69&page=10 “`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Page) —

    Contains parameters for applying cursor pagination.

  • :filter (AppListFilter) —

    Contains parameters for filtering the results.

Returns:



213
214
215
216
 
# File 'lib/sunshine-conversations-client/api/apps_api.rb', line 213

def list_apps(opts = {})
  data, _status_code, _headers = list_apps_with_http_info(opts)
  data
end

#list_apps_with_http_info(opts = {}) ⇒ Array<(AppListResponse, Integer, Hash)>

List Apps Lists all apps that a user is part of. This API is paginated through [cursor pagination](#section/Introduction/API-pagination-and-records-limits). &#x60;&#x60;&#x60;shell /v2/apps?page&#x3D;5e1606762556d93e9c176f69&amp;page&#x3D;10 &#x60;&#x60;&#x60;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Page) —

    Contains parameters for applying cursor pagination.

  • :filter (AppListFilter) —

    Contains parameters for filtering the results.

Returns:

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

    AppListResponse data, response status code and response headers



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
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/sunshine-conversations-client/api/apps_api.rb', line 224

def list_apps_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.list_apps ...'
  end
  # resource path
  local_var_path = '/v2/apps'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?

  # 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] || 'AppListResponse' 

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

#update_app(app_id, app_update_body, opts = {}) ⇒ AppResponse

Update App Updates an app.

Parameters:

  • app_id (String) —

    Identifies the app.

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

    the optional parameters

Returns:



275
276
277
278
 
# File 'lib/sunshine-conversations-client/api/apps_api.rb', line 275

def update_app(app_id, app_update_body, opts = {})
  data, _status_code, _headers = update_app_with_http_info(app_id, app_update_body, opts)
  data
end

#update_app_with_http_info(app_id, app_update_body, opts = {}) ⇒ Array<(AppResponse, Integer, Hash)>

Update App Updates an app.

Parameters:

  • app_id (String) —

    Identifies the app.

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

    the optional parameters

Returns:

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

    AppResponse data, response status code and response headers



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
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/sunshine-conversations-client/api/apps_api.rb', line 286

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

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

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