Class: LaunchDarklyApi::IntegrationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/launchdarkly_api/api/integrations_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IntegrationsApi

Returns a new instance of IntegrationsApi.



19
20
21
 
# File 'lib/launchdarkly_api/api/integrations_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/launchdarkly_api/api/integrations_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_integration_subscription(integration_key, integration_id, opts = {}) ⇒ nil

Delete an integration subscription by ID.

Parameters:

  • integration_key —

    The key used to specify the integration kind.

  • integration_id —

    The integration ID.

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

    the optional parameters

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/launchdarkly_api/api/integrations_api.rb', line 27

def delete_integration_subscription(integration_key, integration_id, opts = {})
  delete_integration_subscription_with_http_info(integration_key, integration_id, opts)
  nil
end

#delete_integration_subscription_with_http_info(integration_key, integration_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an integration subscription by ID.

Parameters:

  • integration_key —

    The key used to specify the integration kind.

  • integration_id —

    The integration ID.

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



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
 
# File 'lib/launchdarkly_api/api/integrations_api.rb', line 37

def delete_integration_subscription_with_http_info(integration_key, integration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.delete_integration_subscription ...'
  end
  # verify the required parameter 'integration_key' is set
  if @api_client.config.client_side_validation && integration_key.nil?
    fail ArgumentError, "Missing the required parameter 'integration_key' when calling IntegrationsApi.delete_integration_subscription"
  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 IntegrationsApi.delete_integration_subscription"
  end
  # resource path
  local_var_path = '/integrations/{integrationKey}/{integrationId}'.sub('{' + 'integrationKey' + '}', integration_key.to_s).sub('{' + 'integrationId' + '}', integration_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['Token']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#delete_integration_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_integration_subscription(integration_key, integration_id, opts = {}) ⇒ IntegrationSubscription

Get a single integration subscription by ID.

Parameters:

  • integration_key —

    The key used to specify the integration kind.

  • integration_id —

    The integration ID.

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

    the optional parameters

Returns:



84
85
86
87
 
# File 'lib/launchdarkly_api/api/integrations_api.rb', line 84

def get_integration_subscription(integration_key, integration_id, opts = {})
  data, _status_code, _headers = get_integration_subscription_with_http_info(integration_key, integration_id, opts)
  data
end

#get_integration_subscription_with_http_info(integration_key, integration_id, opts = {}) ⇒ Array<(IntegrationSubscription, Fixnum, Hash)>

Get a single integration subscription by ID.

Parameters:

  • integration_key —

    The key used to specify the integration kind.

  • integration_id —

    The integration ID.

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

    the optional parameters

Returns:

  • (Array<(IntegrationSubscription, Fixnum, Hash)>) —

    IntegrationSubscription data, response status code and response headers



94
95
96
97
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
 
# File 'lib/launchdarkly_api/api/integrations_api.rb', line 94

def get_integration_subscription_with_http_info(integration_key, integration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.get_integration_subscription ...'
  end
  # verify the required parameter 'integration_key' is set
  if @api_client.config.client_side_validation && integration_key.nil?
    fail ArgumentError, "Missing the required parameter 'integration_key' when calling IntegrationsApi.get_integration_subscription"
  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 IntegrationsApi.get_integration_subscription"
  end
  # resource path
  local_var_path = '/integrations/{integrationKey}/{integrationId}'.sub('{' + 'integrationKey' + '}', integration_key.to_s).sub('{' + 'integrationId' + '}', integration_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['Token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'IntegrationSubscription')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integration_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_integration_subscriptions(integration_key, opts = {}) ⇒ Integration

Get a list of all configured integrations of a given kind.

Parameters:

  • integration_key —

    The key used to specify the integration kind.

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

    the optional parameters

Returns:



141
142
143
144
 
# File 'lib/launchdarkly_api/api/integrations_api.rb', line 141

def get_integration_subscriptions(integration_key, opts = {})
  data, _status_code, _headers = get_integration_subscriptions_with_http_info(integration_key, opts)
  data
end

#get_integration_subscriptions_with_http_info(integration_key, opts = {}) ⇒ Array<(Integration, Fixnum, Hash)>

Get a list of all configured integrations of a given kind.

Parameters:

  • integration_key —

    The key used to specify the integration kind.

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

    the optional parameters

Returns:

  • (Array<(Integration, Fixnum, Hash)>) —

    Integration data, response status code and response headers



150
151
152
153
154
155
156
157
158
159
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
 
# File 'lib/launchdarkly_api/api/integrations_api.rb', line 150

def get_integration_subscriptions_with_http_info(integration_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.get_integration_subscriptions ...'
  end
  # verify the required parameter 'integration_key' is set
  if @api_client.config.client_side_validation && integration_key.nil?
    fail ArgumentError, "Missing the required parameter 'integration_key' when calling IntegrationsApi.get_integration_subscriptions"
  end
  # resource path
  local_var_path = '/integrations/{integrationKey}'.sub('{' + 'integrationKey' + '}', integration_key.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['Token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Integration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integration_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_integrations(opts = {}) ⇒ Integrations

Get a list of all configured audit log event integrations associated with this account.

Parameters:

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

    the optional parameters

Returns:



192
193
194
195
 
# File 'lib/launchdarkly_api/api/integrations_api.rb', line 192

def get_integrations(opts = {})
  data, _status_code, _headers = get_integrations_with_http_info(opts)
  data
end

#get_integrations_with_http_info(opts = {}) ⇒ Array<(Integrations, Fixnum, Hash)>

Get a list of all configured audit log event integrations associated with this account.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Integrations, Fixnum, Hash)>) —

    Integrations data, response status code and response headers



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
 
# File 'lib/launchdarkly_api/api/integrations_api.rb', line 200

def get_integrations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.get_integrations ...'
  end
  # resource path
  local_var_path = '/integrations'

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['Token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Integrations')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_integration_subscription(integration_key, integration_id, patch_delta, opts = {}) ⇒ IntegrationSubscription

Modify an integration subscription by ID.

Parameters:

  • integration_key —

    The key used to specify the integration kind.

  • integration_id —

    The integration ID.

  • patch_delta —

    Requires a JSON Patch representation of the desired changes to the project. &#39;jsonpatch.com/&#39;

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

    the optional parameters

Returns:



241
242
243
244
 
# File 'lib/launchdarkly_api/api/integrations_api.rb', line 241

def patch_integration_subscription(integration_key, integration_id, patch_delta, opts = {})
  data, _status_code, _headers = patch_integration_subscription_with_http_info(integration_key, integration_id, patch_delta, opts)
  data
end

#patch_integration_subscription_with_http_info(integration_key, integration_id, patch_delta, opts = {}) ⇒ Array<(IntegrationSubscription, Fixnum, Hash)>

Modify an integration subscription by ID.

Parameters:

  • integration_key —

    The key used to specify the integration kind.

  • integration_id —

    The integration ID.

  • patch_delta —

    Requires a JSON Patch representation of the desired changes to the project. &#39;jsonpatch.com/&#39;

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

    the optional parameters

Returns:

  • (Array<(IntegrationSubscription, Fixnum, Hash)>) —

    IntegrationSubscription data, response status code and response headers



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
293
294
295
296
297
298
 
# File 'lib/launchdarkly_api/api/integrations_api.rb', line 252

def patch_integration_subscription_with_http_info(integration_key, integration_id, patch_delta, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.patch_integration_subscription ...'
  end
  # verify the required parameter 'integration_key' is set
  if @api_client.config.client_side_validation && integration_key.nil?
    fail ArgumentError, "Missing the required parameter 'integration_key' when calling IntegrationsApi.patch_integration_subscription"
  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 IntegrationsApi.patch_integration_subscription"
  end
  # verify the required parameter 'patch_delta' is set
  if @api_client.config.client_side_validation && patch_delta.nil?
    fail ArgumentError, "Missing the required parameter 'patch_delta' when calling IntegrationsApi.patch_integration_subscription"
  end
  # resource path
  local_var_path = '/integrations/{integrationKey}/{integrationId}'.sub('{' + 'integrationKey' + '}', integration_key.to_s).sub('{' + 'integrationId' + '}', integration_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(patch_delta)
  auth_names = ['Token']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'IntegrationSubscription')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#patch_integration_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_integration_subscription(integration_key, subscription_body, opts = {}) ⇒ IntegrationSubscription

Create a new integration subscription of a given kind.

Parameters:

  • integration_key —

    The key used to specify the integration kind.

  • subscription_body —

    Create a new integration subscription.

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

    the optional parameters

Returns:



304
305
306
307
 
# File 'lib/launchdarkly_api/api/integrations_api.rb', line 304

def post_integration_subscription(integration_key, subscription_body, opts = {})
  data, _status_code, _headers = post_integration_subscription_with_http_info(integration_key, subscription_body, opts)
  data
end

#post_integration_subscription_with_http_info(integration_key, subscription_body, opts = {}) ⇒ Array<(IntegrationSubscription, Fixnum, Hash)>

Create a new integration subscription of a given kind.

Parameters:

  • integration_key —

    The key used to specify the integration kind.

  • subscription_body —

    Create a new integration subscription.

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

    the optional parameters

Returns:

  • (Array<(IntegrationSubscription, Fixnum, Hash)>) —

    IntegrationSubscription data, response status code and response headers



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/launchdarkly_api/api/integrations_api.rb', line 314

def post_integration_subscription_with_http_info(integration_key, subscription_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.post_integration_subscription ...'
  end
  # verify the required parameter 'integration_key' is set
  if @api_client.config.client_side_validation && integration_key.nil?
    fail ArgumentError, "Missing the required parameter 'integration_key' when calling IntegrationsApi.post_integration_subscription"
  end
  # verify the required parameter 'subscription_body' is set
  if @api_client.config.client_side_validation && subscription_body.nil?
    fail ArgumentError, "Missing the required parameter 'subscription_body' when calling IntegrationsApi.post_integration_subscription"
  end
  # resource path
  local_var_path = '/integrations/{integrationKey}'.sub('{' + 'integrationKey' + '}', integration_key.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(subscription_body)
  auth_names = ['Token']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'IntegrationSubscription')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#post_integration_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end