Class: LaunchDarklyApi::IntegrationsBetaApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IntegrationsBetaApi

Returns a new instance of IntegrationsBetaApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_integration_configuration(integration_key, integration_configuration_post, opts = {}) ⇒ IntegrationConfigurationsRep

Create integration configuration Create a new integration configuration. (Excludes persistent store and flag import configurations.)

Parameters:

  • integration_key (String) —

    The integration key

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

    the optional parameters

Returns:



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

def create_integration_configuration(integration_key, integration_configuration_post, opts = {})
  data, _status_code, _headers = create_integration_configuration_with_http_info(integration_key, integration_configuration_post, opts)
  data
end

#create_integration_configuration_with_http_info(integration_key, integration_configuration_post, opts = {}) ⇒ Array<(IntegrationConfigurationsRep, Integer, Hash)>

Create integration configuration Create a new integration configuration. (Excludes persistent store and flag import configurations.)

Parameters:

  • integration_key (String) —

    The integration key

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

    the optional parameters

Returns:



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/integrations_beta_api.rb', line 39

def create_integration_configuration_with_http_info(integration_key, integration_configuration_post, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsBetaApi.create_integration_configuration ...'
  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 IntegrationsBetaApi.create_integration_configuration"
  end
  # verify the required parameter 'integration_configuration_post' is set
  if @api_client.config.client_side_validation && integration_configuration_post.nil?
    fail ArgumentError, "Missing the required parameter 'integration_configuration_post' when calling IntegrationsBetaApi.create_integration_configuration"
  end
  # resource path
  local_var_path = '/api/v2/integration-configurations/keys/{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']) 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_configuration_post)

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

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

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

#delete_integration_configuration(integration_configuration_id, opts = {}) ⇒ nil

Delete integration configuration Delete an integration configuration by ID. (Excludes persistent store and flag import configurations.)

Parameters:

  • integration_configuration_id (String) —

    The ID of the integration configuration to be deleted

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

    the optional parameters

Returns:

  • (nil) 


101
102
103
104
 
# File 'lib/launchdarkly_api/api/integrations_beta_api.rb', line 101

def delete_integration_configuration(integration_configuration_id, opts = {})
  delete_integration_configuration_with_http_info(integration_configuration_id, opts)
  nil
end

#delete_integration_configuration_with_http_info(integration_configuration_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete integration configuration Delete an integration configuration by ID. (Excludes persistent store and flag import configurations.)

Parameters:

  • integration_configuration_id (String) —

    The ID of the integration configuration to be deleted

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def delete_integration_configuration_with_http_info(integration_configuration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsBetaApi.delete_integration_configuration ...'
  end
  # verify the required parameter 'integration_configuration_id' is set
  if @api_client.config.client_side_validation && integration_configuration_id.nil?
    fail ArgumentError, "Missing the required parameter 'integration_configuration_id' when calling IntegrationsBetaApi.delete_integration_configuration"
  end
  # resource path
  local_var_path = '/api/v2/integration-configurations/{integrationConfigurationId}'.sub('{' + 'integrationConfigurationId' + '}', CGI.escape(integration_configuration_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]

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

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

#get_all_integration_configurations(integration_key, opts = {}) ⇒ IntegrationConfigurationCollectionRep

Get all configurations for the integration Get all integration configurations with the specified integration key. (Excludes persistent store and flag import configurations.).

Parameters:

  • integration_key (String) —

    Integration key

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

    the optional parameters

Returns:



164
165
166
167
 
# File 'lib/launchdarkly_api/api/integrations_beta_api.rb', line 164

def get_all_integration_configurations(integration_key, opts = {})
  data, _status_code, _headers = get_all_integration_configurations_with_http_info(integration_key, opts)
  data
end

#get_all_integration_configurations_with_http_info(integration_key, opts = {}) ⇒ Array<(IntegrationConfigurationCollectionRep, Integer, Hash)>

Get all configurations for the integration Get all integration configurations with the specified integration key. (Excludes persistent store and flag import configurations.).

Parameters:

  • integration_key (String) —

    Integration key

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

    the optional parameters

Returns:



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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/launchdarkly_api/api/integrations_beta_api.rb', line 174

def get_all_integration_configurations_with_http_info(integration_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsBetaApi.get_all_integration_configurations ...'
  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 IntegrationsBetaApi.get_all_integration_configurations"
  end
  # resource path
  local_var_path = '/api/v2/integration-configurations/keys/{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']) 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] || 'IntegrationConfigurationCollectionRep'

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

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

#get_integration_configuration(integration_configuration_id, opts = {}) ⇒ IntegrationConfigurationsRep

Get an integration configuration Get integration configuration with the specified ID. (Excludes persistent store and flag import configurations.)

Parameters:

  • integration_configuration_id (String) —

    Integration configuration ID

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

    the optional parameters

Returns:



227
228
229
230
 
# File 'lib/launchdarkly_api/api/integrations_beta_api.rb', line 227

def get_integration_configuration(integration_configuration_id, opts = {})
  data, _status_code, _headers = get_integration_configuration_with_http_info(integration_configuration_id, opts)
  data
end

#get_integration_configuration_with_http_info(integration_configuration_id, opts = {}) ⇒ Array<(IntegrationConfigurationsRep, Integer, Hash)>

Get an integration configuration Get integration configuration with the specified ID. (Excludes persistent store and flag import configurations.)

Parameters:

  • integration_configuration_id (String) —

    Integration configuration ID

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

    the optional parameters

Returns:



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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/launchdarkly_api/api/integrations_beta_api.rb', line 237

def get_integration_configuration_with_http_info(integration_configuration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsBetaApi.get_integration_configuration ...'
  end
  # verify the required parameter 'integration_configuration_id' is set
  if @api_client.config.client_side_validation && integration_configuration_id.nil?
    fail ArgumentError, "Missing the required parameter 'integration_configuration_id' when calling IntegrationsBetaApi.get_integration_configuration"
  end
  # resource path
  local_var_path = '/api/v2/integration-configurations/{integrationConfigurationId}'.sub('{' + 'integrationConfigurationId' + '}', CGI.escape(integration_configuration_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] || 'IntegrationConfigurationsRep'

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

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

#update_integration_configuration(integration_configuration_id, patch_operation, opts = {}) ⇒ IntegrationConfigurationsRep

Update integration configuration Update an integration configuration. Updating an integration configuration uses a JSON patch representation of the desired changes. To learn more, read Updates.

Parameters:

  • integration_configuration_id (String) —

    The ID of the integration configuration

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

    the optional parameters

Returns:



291
292
293
294
 
# File 'lib/launchdarkly_api/api/integrations_beta_api.rb', line 291

def update_integration_configuration(integration_configuration_id, patch_operation, opts = {})
  data, _status_code, _headers = update_integration_configuration_with_http_info(integration_configuration_id, patch_operation, opts)
  data
end

#update_integration_configuration_with_http_info(integration_configuration_id, patch_operation, opts = {}) ⇒ Array<(IntegrationConfigurationsRep, Integer, Hash)>

Update integration configuration Update an integration configuration. Updating an integration configuration uses a JSON patch representation of the desired changes. To learn more, read Updates.

Parameters:

  • integration_configuration_id (String) —

    The ID of the integration configuration

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

    the optional parameters

Returns:



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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/launchdarkly_api/api/integrations_beta_api.rb', line 302

def update_integration_configuration_with_http_info(integration_configuration_id, patch_operation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsBetaApi.update_integration_configuration ...'
  end
  # verify the required parameter 'integration_configuration_id' is set
  if @api_client.config.client_side_validation && integration_configuration_id.nil?
    fail ArgumentError, "Missing the required parameter 'integration_configuration_id' when calling IntegrationsBetaApi.update_integration_configuration"
  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 IntegrationsBetaApi.update_integration_configuration"
  end
  # resource path
  local_var_path = '/api/v2/integration-configurations/{integrationConfigurationId}'.sub('{' + 'integrationConfigurationId' + '}', CGI.escape(integration_configuration_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(patch_operation)

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

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

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