Class: SunshineConversationsClient::CustomIntegrationApiKeysApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CustomIntegrationApiKeysApi

Returns a new instance of CustomIntegrationApiKeysApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_custom_integration_key(app_id, integration_id, integration_api_key, opts = {}) ⇒ IntegrationApiKeyResponse

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

Parameters:

  • app_id (String) —

    Identifies the app.

  • integration_id (String) —

    The id of the integration.

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

    the optional parameters

Returns:



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

def create_custom_integration_key(app_id, integration_id, integration_api_key, opts = {})
  data, _status_code, _headers = create_custom_integration_key_with_http_info(app_id, integration_id, integration_api_key, opts)
  data
end

#create_custom_integration_key_with_http_info(app_id, integration_id, integration_api_key, opts = {}) ⇒ Array<(IntegrationApiKeyResponse, Integer, Hash)>

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

Parameters:

  • app_id (String) —

    Identifies the app.

  • integration_id (String) —

    The id of the integration.

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

    the optional parameters

Returns:

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

    IntegrationApiKeyResponse data, response status code and response headers



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
94
95
96
97
 
# File 'lib/sunshine-conversations-client/api/custom_integration_api_keys_api.rb', line 38

def create_custom_integration_key_with_http_info(app_id, integration_id, integration_api_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomIntegrationApiKeysApi.create_custom_integration_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 CustomIntegrationApiKeysApi.create_custom_integration_key"
  end
  # verify the required parameter 'integration_id' is set
  if @api_client.config.client_side_validation && integration_id.nil?
    fail ArgumentError, "Missing the required parameter 'integration_id' when calling CustomIntegrationApiKeysApi.create_custom_integration_key"
  end
  # verify the required parameter 'integration_api_key' is set
  if @api_client.config.client_side_validation && integration_api_key.nil?
    fail ArgumentError, "Missing the required parameter 'integration_api_key' when calling CustomIntegrationApiKeysApi.create_custom_integration_key"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/integrations/{integrationId}/keys'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'integrationId' + '}', CGI.escape(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']) 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(integration_api_key)

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

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

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

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

Delete Integration Key Removes an API key.

Parameters:

  • app_id (String) —

    Identifies the app.

  • integration_id (String) —

    The id of the integration.

  • key_id (String) —

    The id of the key.

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

    the optional parameters

Returns:

  • (Object) 


106
107
108
109
 
# File 'lib/sunshine-conversations-client/api/custom_integration_api_keys_api.rb', line 106

def delete_custom_integration_key(app_id, integration_id, key_id, opts = {})
  data, _status_code, _headers = delete_custom_integration_key_with_http_info(app_id, integration_id, key_id, opts)
  data
end

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

Delete Integration Key Removes an API key.

Parameters:

  • app_id (String) —

    Identifies the app.

  • integration_id (String) —

    The id of the integration.

  • 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



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
168
169
170
171
172
 
# File 'lib/sunshine-conversations-client/api/custom_integration_api_keys_api.rb', line 118

def delete_custom_integration_key_with_http_info(app_id, integration_id, key_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomIntegrationApiKeysApi.delete_custom_integration_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 CustomIntegrationApiKeysApi.delete_custom_integration_key"
  end
  # verify the required parameter 'integration_id' is set
  if @api_client.config.client_side_validation && integration_id.nil?
    fail ArgumentError, "Missing the required parameter 'integration_id' when calling CustomIntegrationApiKeysApi.delete_custom_integration_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 CustomIntegrationApiKeysApi.delete_custom_integration_key"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/integrations/{integrationId}/keys/{keyId}'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'integrationId' + '}', CGI.escape(integration_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 => :"CustomIntegrationApiKeysApi.delete_custom_integration_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: CustomIntegrationApiKeysApi#delete_custom_integration_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_custom_integration_key(app_id, integration_id, key_id, opts = {}) ⇒ IntegrationApiKeyResponse

Get Integration Key Get the specified API key.

Parameters:

  • app_id (String) —

    Identifies the app.

  • integration_id (String) —

    The id of the integration.

  • key_id (String) —

    The id of the key.

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

    the optional parameters

Returns:



181
182
183
184
 
# File 'lib/sunshine-conversations-client/api/custom_integration_api_keys_api.rb', line 181

def get_custom_integration_key(app_id, integration_id, key_id, opts = {})
  data, _status_code, _headers = get_custom_integration_key_with_http_info(app_id, integration_id, key_id, opts)
  data
end

#get_custom_integration_key_with_http_info(app_id, integration_id, key_id, opts = {}) ⇒ Array<(IntegrationApiKeyResponse, Integer, Hash)>

Get Integration Key Get the specified API key.

Parameters:

  • app_id (String) —

    Identifies the app.

  • integration_id (String) —

    The id of the integration.

  • key_id (String) —

    The id of the key.

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

    the optional parameters

Returns:

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

    IntegrationApiKeyResponse data, response status code and response headers



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
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/sunshine-conversations-client/api/custom_integration_api_keys_api.rb', line 193

def get_custom_integration_key_with_http_info(app_id, integration_id, key_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomIntegrationApiKeysApi.get_custom_integration_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 CustomIntegrationApiKeysApi.get_custom_integration_key"
  end
  # verify the required parameter 'integration_id' is set
  if @api_client.config.client_side_validation && integration_id.nil?
    fail ArgumentError, "Missing the required parameter 'integration_id' when calling CustomIntegrationApiKeysApi.get_custom_integration_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 CustomIntegrationApiKeysApi.get_custom_integration_key"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/integrations/{integrationId}/keys/{keyId}'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'integrationId' + '}', CGI.escape(integration_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] || 'IntegrationApiKeyResponse'

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

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

#list_custom_integration_keys(app_id, integration_id, opts = {}) ⇒ IntegrationApiKeyListResponse

List Integration Keys Lists all API keys for a given integration.

Parameters:

  • app_id (String) —

    Identifies the app.

  • integration_id (String) —

    The id of the integration.

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

    the optional parameters

Returns:



255
256
257
258
 
# File 'lib/sunshine-conversations-client/api/custom_integration_api_keys_api.rb', line 255

def list_custom_integration_keys(app_id, integration_id, opts = {})
  data, _status_code, _headers = list_custom_integration_keys_with_http_info(app_id, integration_id, opts)
  data
end

#list_custom_integration_keys_with_http_info(app_id, integration_id, opts = {}) ⇒ Array<(IntegrationApiKeyListResponse, Integer, Hash)>

List Integration Keys Lists all API keys for a given integration.

Parameters:

  • app_id (String) —

    Identifies the app.

  • integration_id (String) —

    The id of the integration.

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

    the optional parameters

Returns:



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

def list_custom_integration_keys_with_http_info(app_id, integration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomIntegrationApiKeysApi.list_custom_integration_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 CustomIntegrationApiKeysApi.list_custom_integration_keys"
  end
  # verify the required parameter 'integration_id' is set
  if @api_client.config.client_side_validation && integration_id.nil?
    fail ArgumentError, "Missing the required parameter 'integration_id' when calling CustomIntegrationApiKeysApi.list_custom_integration_keys"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/integrations/{integrationId}/keys'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'integrationId' + '}', CGI.escape(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']) 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] || 'IntegrationApiKeyListResponse'

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

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