Class: LaunchDarklyApi::IntegrationAuditLogSubscriptionsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IntegrationAuditLogSubscriptionsApi

Returns a new instance of IntegrationAuditLogSubscriptionsApi.



19
20
21
 
# File 'lib/launchdarkly_api/api/integration_audit_log_subscriptions_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/integration_audit_log_subscriptions_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_subscription(integration_key, subscription_post, opts = {}) ⇒ Integration

Create audit log subscription Create an audit log subscription.<br /><br />For each subscription, you must specify the set of resources you wish to subscribe to audit log notifications for. You can describe these resources using a custom role policy. To learn more, read [Custom role concepts](docs.launchdarkly.com/home/members/role-concepts).

Parameters:

  • integration_key (String) —

    The integration key

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/launchdarkly_api/api/integration_audit_log_subscriptions_api.rb', line 28

def create_subscription(integration_key, subscription_post, opts = {})
  data, _status_code, _headers = create_subscription_with_http_info(integration_key, subscription_post, opts)
  data
end

#create_subscription_with_http_info(integration_key, subscription_post, opts = {}) ⇒ Array<(Integration, Integer, Hash)>

Create audit log subscription Create an audit log subscription.&lt;br /&gt;&lt;br /&gt;For each subscription, you must specify the set of resources you wish to subscribe to audit log notifications for. You can describe these resources using a custom role policy. To learn more, read [Custom role concepts](docs.launchdarkly.com/home/members/role-concepts).

Parameters:

  • integration_key (String) —

    The integration key

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

    the optional parameters

Returns:

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

    Integration data, response status code and response headers



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

def create_subscription_with_http_info(integration_key, subscription_post, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationAuditLogSubscriptionsApi.create_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 IntegrationAuditLogSubscriptionsApi.create_subscription"
  end
  # verify the required parameter 'subscription_post' is set
  if @api_client.config.client_side_validation && subscription_post.nil?
    fail ArgumentError, "Missing the required parameter 'subscription_post' when calling IntegrationAuditLogSubscriptionsApi.create_subscription"
  end
  # resource path
  local_var_path = '/api/v2/integrations/{integrationKey}'.sub('{' + 'integrationKey' + '}', CGI.escape(integration_key.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'
  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(subscription_post)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

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

#delete_subscription(integration_key, id, opts = {}) ⇒ nil

Delete audit log subscription Delete an audit log subscription.

Parameters:

  • integration_key (String) —

    The integration key

  • id (String) —

    The subscription ID

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

    the optional parameters

Returns:

  • (nil) 


102
103
104
105
 
# File 'lib/launchdarkly_api/api/integration_audit_log_subscriptions_api.rb', line 102

def delete_subscription(integration_key, id, opts = {})
  delete_subscription_with_http_info(integration_key, id, opts)
  nil
end

#delete_subscription_with_http_info(integration_key, id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete audit log subscription Delete an audit log subscription.

Parameters:

  • integration_key (String) —

    The integration key

  • id (String) —

    The subscription ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
161
162
163
 
# File 'lib/launchdarkly_api/api/integration_audit_log_subscriptions_api.rb', line 113

def delete_subscription_with_http_info(integration_key, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationAuditLogSubscriptionsApi.delete_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 IntegrationAuditLogSubscriptionsApi.delete_subscription"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IntegrationAuditLogSubscriptionsApi.delete_subscription"
  end
  # resource path
  local_var_path = '/api/v2/integrations/{integrationKey}/{id}'.sub('{' + 'integrationKey' + '}', CGI.escape(integration_key.to_s)).sub('{' + 'id' + '}', CGI.escape(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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

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

#get_subscription_by_id(integration_key, id, opts = {}) ⇒ Integration

Get audit log subscription by ID Get an audit log subscription by ID.

Parameters:

  • integration_key (String) —

    The integration key

  • id (String) —

    The subscription ID

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

    the optional parameters

Returns:



171
172
173
174
 
# File 'lib/launchdarkly_api/api/integration_audit_log_subscriptions_api.rb', line 171

def get_subscription_by_id(integration_key, id, opts = {})
  data, _status_code, _headers = get_subscription_by_id_with_http_info(integration_key, id, opts)
  data
end

#get_subscription_by_id_with_http_info(integration_key, id, opts = {}) ⇒ Array<(Integration, Integer, Hash)>

Get audit log subscription by ID Get an audit log subscription by ID.

Parameters:

  • integration_key (String) —

    The integration key

  • id (String) —

    The subscription ID

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

    the optional parameters

Returns:

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

    Integration data, response status code and response headers



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
230
231
232
 
# File 'lib/launchdarkly_api/api/integration_audit_log_subscriptions_api.rb', line 182

def get_subscription_by_id_with_http_info(integration_key, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationAuditLogSubscriptionsApi.get_subscription_by_id ...'
  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 IntegrationAuditLogSubscriptionsApi.get_subscription_by_id"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IntegrationAuditLogSubscriptionsApi.get_subscription_by_id"
  end
  # resource path
  local_var_path = '/api/v2/integrations/{integrationKey}/{id}'.sub('{' + 'integrationKey' + '}', CGI.escape(integration_key.to_s)).sub('{' + 'id' + '}', CGI.escape(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[:debug_body]

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

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

#get_subscriptions(integration_key, opts = {}) ⇒ Integrations

Get audit log subscriptions by integration Get all audit log subscriptions associated with a given integration.

Parameters:

  • integration_key (String) —

    The integration key

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

    the optional parameters

Returns:



239
240
241
242
 
# File 'lib/launchdarkly_api/api/integration_audit_log_subscriptions_api.rb', line 239

def get_subscriptions(integration_key, opts = {})
  data, _status_code, _headers = get_subscriptions_with_http_info(integration_key, opts)
  data
end

#get_subscriptions_with_http_info(integration_key, opts = {}) ⇒ Array<(Integrations, Integer, Hash)>

Get audit log subscriptions by integration Get all audit log subscriptions associated with a given integration.

Parameters:

  • integration_key (String) —

    The integration key

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

    the optional parameters

Returns:

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

    Integrations data, response status code and response headers



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
293
294
295
 
# File 'lib/launchdarkly_api/api/integration_audit_log_subscriptions_api.rb', line 249

def get_subscriptions_with_http_info(integration_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationAuditLogSubscriptionsApi.get_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 IntegrationAuditLogSubscriptionsApi.get_subscriptions"
  end
  # resource path
  local_var_path = '/api/v2/integrations/{integrationKey}'.sub('{' + 'integrationKey' + '}', CGI.escape(integration_key.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[:debug_body]

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

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

#update_subscription(integration_key, id, patch_operation, opts = {}) ⇒ Integration

Update audit log subscription Update an audit log subscription configuration. Updating an audit log subscription uses a [JSON patch](datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](/#section/Overview/Updates).

Parameters:

  • integration_key (String) —

    The integration key

  • id (String) —

    The ID of the audit log subscription

  • patch_operation (Array<PatchOperation>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



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

def update_subscription(integration_key, id, patch_operation, opts = {})
  data, _status_code, _headers = update_subscription_with_http_info(integration_key, id, patch_operation, opts)
  data
end

#update_subscription_with_http_info(integration_key, id, patch_operation, opts = {}) ⇒ Array<(Integration, Integer, Hash)>

Update audit log subscription Update an audit log subscription configuration. Updating an audit log subscription uses a [JSON patch](datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](/#section/Overview/Updates).

Parameters:

  • integration_key (String) —

    The integration key

  • id (String) —

    The ID of the audit log subscription

  • patch_operation (Array<PatchOperation>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    Integration data, response status code and response headers



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
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/launchdarkly_api/api/integration_audit_log_subscriptions_api.rb', line 316

def update_subscription_with_http_info(integration_key, id, patch_operation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationAuditLogSubscriptionsApi.update_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 IntegrationAuditLogSubscriptionsApi.update_subscription"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IntegrationAuditLogSubscriptionsApi.update_subscription"
  end
  # verify the required parameter 'patch_operation' is set
  if @api_client.config.client_side_validation && patch_operation.nil?
    fail ArgumentError, "Missing the required parameter 'patch_operation' when calling IntegrationAuditLogSubscriptionsApi.update_subscription"
  end
  # resource path
  local_var_path = '/api/v2/integrations/{integrationKey}/{id}'.sub('{' + 'integrationKey' + '}', CGI.escape(integration_key.to_s)).sub('{' + 'id' + '}', CGI.escape(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'
  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(patch_operation)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

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