Class: SunshineConversationsClient::AppKeysApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AppKeysApi

Returns a new instance of AppKeysApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_app_key(app_id, app_key_create_body, opts = {}) ⇒ AppKeyResponse

Create App Key Creates an API key for the specified app. The response body will include a secret as well as its corresponding id, which you can use to generate JSON Web Tokens to securely make API calls on behalf of the app.

Parameters:

  • app_id (String) —

    Identifies the app.

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

    the optional parameters

Returns:



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

def create_app_key(app_id, app_key_create_body, opts = {})
  data, _status_code, _headers = create_app_key_with_http_info(app_id, app_key_create_body, opts)
  data
end

#create_app_key_with_http_info(app_id, app_key_create_body, opts = {}) ⇒ Array<(AppKeyResponse, Integer, Hash)>

Create App Key Creates an API key for the specified app. The response body will include a secret as well as its corresponding id, which you can use to generate JSON Web Tokens to securely make API calls on behalf of the app.

Parameters:

  • app_id (String) —

    Identifies the app.

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

    the optional parameters

Returns:

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

    AppKeyResponse data, response status code and response headers



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

def create_app_key_with_http_info(app_id, app_key_create_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppKeysApi.create_app_key ...'
  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 AppKeysApi.create_app_key"
  end
  # verify the required parameter 'app_key_create_body' is set
  if @api_client.config.client_side_validation && app_key_create_body.nil?
    fail ArgumentError, "Missing the required parameter 'app_key_create_body' when calling AppKeysApi.create_app_key"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/keys'.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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(app_key_create_body)

  # return_type
  return_type = opts[:debug_return_type] || 'AppKeyResponse'

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

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

#delete_app_key(app_id, key_id, opts = {}) ⇒ Object

Delete App Key Removes an API key.

Parameters:

  • app_id (String) —

    Identifies the app.

  • key_id (String) —

    The id of the key.

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

    the optional parameters

Returns:

  • (Object) 


99
100
101
102
 
# File 'lib/sunshine-conversations-client/api/app_keys_api.rb', line 99

def delete_app_key(app_id, key_id, opts = {})
  data, _status_code, _headers = delete_app_key_with_http_info(app_id, key_id, opts)
  data
end

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

Delete App Key Removes an API key.

Parameters:

  • app_id (String) —

    Identifies the app.

  • key_id (String) —

    The id of the key.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/sunshine-conversations-client/api/app_keys_api.rb', line 110

def delete_app_key_with_http_info(app_id, key_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppKeysApi.delete_app_key ...'
  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 AppKeysApi.delete_app_key"
  end
  # verify the required parameter 'key_id' is set
  if @api_client.config.client_side_validation && key_id.nil?
    fail ArgumentError, "Missing the required parameter 'key_id' when calling AppKeysApi.delete_app_key"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/keys/{keyId}'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'keyId' + '}', CGI.escape(key_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']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

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

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

#get_app_key(app_id, key_id, opts = {}) ⇒ AppKeyResponse

Get App Key Returns an API key.

Parameters:

  • app_id (String) —

    Identifies the app.

  • key_id (String) —

    The id of the key.

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

    the optional parameters

Returns:



168
169
170
171
 
# File 'lib/sunshine-conversations-client/api/app_keys_api.rb', line 168

def get_app_key(app_id, key_id, opts = {})
  data, _status_code, _headers = get_app_key_with_http_info(app_id, key_id, opts)
  data
end

#get_app_key_with_http_info(app_id, key_id, opts = {}) ⇒ Array<(AppKeyResponse, Integer, Hash)>

Get App Key Returns an API key.

Parameters:

  • app_id (String) —

    Identifies the app.

  • key_id (String) —

    The id of the key.

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

    the optional parameters

Returns:

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

    AppKeyResponse data, response status code and response headers



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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/sunshine-conversations-client/api/app_keys_api.rb', line 179

def get_app_key_with_http_info(app_id, key_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppKeysApi.get_app_key ...'
  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 AppKeysApi.get_app_key"
  end
  # verify the required parameter 'key_id' is set
  if @api_client.config.client_side_validation && key_id.nil?
    fail ArgumentError, "Missing the required parameter 'key_id' when calling AppKeysApi.get_app_key"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/keys/{keyId}'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'keyId' + '}', CGI.escape(key_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']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'AppKeyResponse'

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

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

#list_app_keys(app_id, opts = {}) ⇒ AppKeyListResponse

List App Keys Lists all API keys for a given app.

Parameters:

  • app_id (String) —

    Identifies the app.

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

    the optional parameters

Returns:



236
237
238
239
 
# File 'lib/sunshine-conversations-client/api/app_keys_api.rb', line 236

def list_app_keys(app_id, opts = {})
  data, _status_code, _headers = list_app_keys_with_http_info(app_id, opts)
  data
end

#list_app_keys_with_http_info(app_id, opts = {}) ⇒ Array<(AppKeyListResponse, Integer, Hash)>

List App Keys Lists all API keys for a given app.

Parameters:

  • app_id (String) —

    Identifies the app.

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

    the optional parameters

Returns:

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

    AppKeyListResponse data, response status code and response headers



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
286
287
288
289
290
291
292
 
# File 'lib/sunshine-conversations-client/api/app_keys_api.rb', line 246

def list_app_keys_with_http_info(app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppKeysApi.list_app_keys ...'
  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 AppKeysApi.list_app_keys"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/keys'.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']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'AppKeyListResponse'

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

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