Class: Falcon::IntegrationBuilder

Inherits:
Object
  • Object
show all
Defined in:
lib/crimson-falcon/api/integration_builder.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IntegrationBuilder

Returns a new instance of IntegrationBuilder.



36
37
38
 
# File 'lib/crimson-falcon/api/integration_builder.rb', line 36

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



34
35
36
 
# File 'lib/crimson-falcon/api/integration_builder.rb', line 34

def api_client
  @api_client
end

Instance Method Details

#integration_builder_end_transaction_v3(id, opts = {}) ⇒ GetEndTransaction

POST Data Upload Transaction Completion Make a close transaction call after uploading the data

Parameters:

  • id (String) —

    Integration ID

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

    the optional parameters

Returns:



44
45
46
47
 
# File 'lib/crimson-falcon/api/integration_builder.rb', line 44

def integration_builder_end_transaction_v3(id, opts = {})
  data, _status_code, _headers = integration_builder_end_transaction_v3_with_http_info(id, opts)
  data
end

#integration_builder_end_transaction_v3_with_http_info(id, opts = {}) ⇒ Array<(GetEndTransaction, Integer, Hash)>

POST Data Upload Transaction Completion Make a close transaction call after uploading the data

Parameters:

  • id (String) —

    Integration ID

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

    the optional parameters

Returns:

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

    GetEndTransaction data, response status code and response headers



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
98
99
100
101
 
# File 'lib/crimson-falcon/api/integration_builder.rb', line 54

def integration_builder_end_transaction_v3_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationBuilder.integration_builder_end_transaction_v3 ...'
  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 IntegrationBuilder.integration_builder_end_transaction_v3"
  end
  # resource path
  local_var_path = '/saas-security/entities/custom-integration-close/v3'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'id'] = id

  # 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] || 'GetEndTransaction'

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

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

#integration_builder_get_status_v3(id, opts = {}) ⇒ GetTransactionStatus

GET Status Get transaction status for a custom integration

Parameters:

  • id (String) —

    Integration ID

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

    the optional parameters

Returns:



108
109
110
111
 
# File 'lib/crimson-falcon/api/integration_builder.rb', line 108

def integration_builder_get_status_v3(id, opts = {})
  data, _status_code, _headers = integration_builder_get_status_v3_with_http_info(id, opts)
  data
end

#integration_builder_get_status_v3_with_http_info(id, opts = {}) ⇒ Array<(GetTransactionStatus, Integer, Hash)>

GET Status Get transaction status for a custom integration

Parameters:

  • id (String) —

    Integration ID

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

    the optional parameters

Returns:

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

    GetTransactionStatus 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
 
# File 'lib/crimson-falcon/api/integration_builder.rb', line 118

def integration_builder_get_status_v3_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationBuilder.integration_builder_get_status_v3 ...'
  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 IntegrationBuilder.integration_builder_get_status_v3"
  end
  # resource path
  local_var_path = '/saas-security/entities/custom-integration-status/v3'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'id'] = id

  # 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] || 'GetTransactionStatus'

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

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

#integration_builder_reset_v3(id, opts = {}) ⇒ GetTransactionStatus

Reset Make a reset call to a custom integration

Parameters:

  • id (String) —

    Integration ID

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

    the optional parameters

Returns:



172
173
174
175
 
# File 'lib/crimson-falcon/api/integration_builder.rb', line 172

def integration_builder_reset_v3(id, opts = {})
  data, _status_code, _headers = integration_builder_reset_v3_with_http_info(id, opts)
  data
end

#integration_builder_reset_v3_with_http_info(id, opts = {}) ⇒ Array<(GetTransactionStatus, Integer, Hash)>

Reset Make a reset call to a custom integration

Parameters:

  • id (String) —

    Integration ID

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

    the optional parameters

Returns:

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

    GetTransactionStatus 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
 
# File 'lib/crimson-falcon/api/integration_builder.rb', line 182

def integration_builder_reset_v3_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationBuilder.integration_builder_reset_v3 ...'
  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 IntegrationBuilder.integration_builder_reset_v3"
  end
  # resource path
  local_var_path = '/saas-security/entities/custom-integration-reset/v3'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'id'] = id

  # 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] || 'GetTransactionStatus'

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

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

#integration_builder_upload_v3(id, source_id, data, opts = {}) ⇒ UploadDataResponse

POST Upload Send data to a specific source in a custom integration

Parameters:

  • id (String) —

    Integration ID

  • source_id (String) —

    Source ID

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

    the optional parameters

Returns:



238
239
240
241
 
# File 'lib/crimson-falcon/api/integration_builder.rb', line 238

def integration_builder_upload_v3(id, source_id, data, opts = {})
  data, _status_code, _headers = integration_builder_upload_v3_with_http_info(id, source_id, data, opts)
  data
end

#integration_builder_upload_v3_with_http_info(id, source_id, data, opts = {}) ⇒ Array<(UploadDataResponse, Integer, Hash)>

POST Upload Send data to a specific source in a custom integration

Parameters:

  • id (String) —

    Integration ID

  • source_id (String) —

    Source ID

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

    the optional parameters

Returns:

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

    UploadDataResponse data, response status code and response headers



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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/crimson-falcon/api/integration_builder.rb', line 250

def integration_builder_upload_v3_with_http_info(id, source_id, data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationBuilder.integration_builder_upload_v3 ...'
  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 IntegrationBuilder.integration_builder_upload_v3"
  end
  # verify the required parameter 'source_id' is set
  if @api_client.config.client_side_validation && source_id.nil?
    fail ArgumentError, "Missing the required parameter 'source_id' when calling IntegrationBuilder.integration_builder_upload_v3"
  end
  # verify the required parameter 'data' is set
  if @api_client.config.client_side_validation && data.nil?
    fail ArgumentError, "Missing the required parameter 'data' when calling IntegrationBuilder.integration_builder_upload_v3"
  end
  # resource path
  local_var_path = '/saas-security/entities/custom-integration-upload/v3'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'id'] = id
  query_params[:'source_id'] = source_id

  # 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(data)

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

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

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