Class: NucleusApi::BulkApi

Inherits:
Object
  • Object
show all
Defined in:
lib/nucleus_api/api/bulk_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BulkApi

Returns a new instance of BulkApi.



19
20
21
 
# File 'lib/nucleus_api/api/bulk_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/nucleus_api/api/bulk_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_bulk_using_post(data, entity_uri, opts = {}) ⇒ BulkTransaction

Create a bulk data Create a new bulk data for your firm.

Parameters:

  • data —

    data

  • entity_uri —

    UUID entity_uri

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/nucleus_api/api/bulk_api.rb', line 28

def create_bulk_using_post(data, entity_uri, opts = {})
  data, _status_code, _headers = create_bulk_using_post_with_http_info(data, entity_uri, opts)
  data
end

#create_bulk_using_post_with_http_info(data, entity_uri, opts = {}) ⇒ Array<(BulkTransaction, Fixnum, Hash)>

Create a bulk data Create a new bulk data for your firm.

Parameters:

  • data —

    data

  • entity_uri —

    UUID entity_uri

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

    the optional parameters

Returns:

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

    BulkTransaction 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
 
# File 'lib/nucleus_api/api/bulk_api.rb', line 39

def create_bulk_using_post_with_http_info(data, entity_uri, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BulkApi.create_bulk_using_post ...'
  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 BulkApi.create_bulk_using_post"
  end
  # verify the required parameter 'entity_uri' is set
  if @api_client.config.client_side_validation && entity_uri.nil?
    fail ArgumentError, "Missing the required parameter 'entity_uri' when calling BulkApi.create_bulk_using_post"
  end
  # resource path
  local_var_path = '/nucleus/v1/bulk/{entity_uri}'.sub('{' + 'entity_uri' + '}', entity_uri.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(data)
  auth_names = ['oauth2']
  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 => 'BulkTransaction')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkApi#create_bulk_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_bulk_using_delete(data, entity_uri, opts = {}) ⇒ BulkTransaction

Delete a bulk data Delete a bulk data for your firm.

Parameters:

  • data —

    data

  • entity_uri —

    UUID entity_uri

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

    the optional parameters

Returns:



88
89
90
91
 
# File 'lib/nucleus_api/api/bulk_api.rb', line 88

def delete_bulk_using_delete(data, entity_uri, opts = {})
  data, _status_code, _headers = delete_bulk_using_delete_with_http_info(data, entity_uri, opts)
  data
end

#delete_bulk_using_delete_with_http_info(data, entity_uri, opts = {}) ⇒ Array<(BulkTransaction, Fixnum, Hash)>

Delete a bulk data Delete a bulk data for your firm.

Parameters:

  • data —

    data

  • entity_uri —

    UUID entity_uri

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

    the optional parameters

Returns:

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

    BulkTransaction data, response status code and response headers



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
137
138
139
 
# File 'lib/nucleus_api/api/bulk_api.rb', line 99

def delete_bulk_using_delete_with_http_info(data, entity_uri, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BulkApi.delete_bulk_using_delete ...'
  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 BulkApi.delete_bulk_using_delete"
  end
  # verify the required parameter 'entity_uri' is set
  if @api_client.config.client_side_validation && entity_uri.nil?
    fail ArgumentError, "Missing the required parameter 'entity_uri' when calling BulkApi.delete_bulk_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/bulk/{entity_uri}'.sub('{' + 'entity_uri' + '}', entity_uri.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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(data)
  auth_names = ['oauth2']
  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,
    :return_type => 'BulkTransaction')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkApi#delete_bulk_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_bulk_status_using_get(id, opts = {}) ⇒ BulkTransactionVO

Status of bulk transaction Get the status of bulk transaction.

Parameters:

  • id —

    UUID Bulk Transaction Id

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

    the optional parameters

Returns:



145
146
147
148
 
# File 'lib/nucleus_api/api/bulk_api.rb', line 145

def get_bulk_status_using_get(id, opts = {})
  data, _status_code, _headers = get_bulk_status_using_get_with_http_info(id, opts)
  data
end

#get_bulk_status_using_get_with_http_info(id, opts = {}) ⇒ Array<(BulkTransactionVO, Fixnum, Hash)>

Status of bulk transaction Get the status of bulk transaction.

Parameters:

  • id —

    UUID Bulk Transaction Id

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

    the optional parameters

Returns:

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

    BulkTransactionVO data, response status code and response headers



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
189
190
191
 
# File 'lib/nucleus_api/api/bulk_api.rb', line 155

def get_bulk_status_using_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BulkApi.get_bulk_status_using_get ...'
  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 BulkApi.get_bulk_status_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/bulk/status/{id}'.sub('{' + 'id' + '}', 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'BulkTransactionVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkApi#get_bulk_status_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_bulk_using_put(data, entity_uri, opts = {}) ⇒ BulkTransaction

Update a bulk data Update a bulk data for your firm.

Parameters:

  • data —

    data

  • entity_uri —

    UUID entity_uri

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

    the optional parameters

Returns:



198
199
200
201
 
# File 'lib/nucleus_api/api/bulk_api.rb', line 198

def update_bulk_using_put(data, entity_uri, opts = {})
  data, _status_code, _headers = update_bulk_using_put_with_http_info(data, entity_uri, opts)
  data
end

#update_bulk_using_put_with_http_info(data, entity_uri, opts = {}) ⇒ Array<(BulkTransaction, Fixnum, Hash)>

Update a bulk data Update a bulk data for your firm.

Parameters:

  • data —

    data

  • entity_uri —

    UUID entity_uri

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

    the optional parameters

Returns:

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

    BulkTransaction data, response status code and response headers



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
248
249
250
251
 
# File 'lib/nucleus_api/api/bulk_api.rb', line 209

def update_bulk_using_put_with_http_info(data, entity_uri, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BulkApi.update_bulk_using_put ...'
  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 BulkApi.update_bulk_using_put"
  end
  # verify the required parameter 'entity_uri' is set
  if @api_client.config.client_side_validation && entity_uri.nil?
    fail ArgumentError, "Missing the required parameter 'entity_uri' when calling BulkApi.update_bulk_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/bulk/{entity_uri}'.sub('{' + 'entity_uri' + '}', entity_uri.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(data)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BulkTransaction')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkApi#update_bulk_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end