Class: DealMakerAPI::DealApi

Inherits:
Object
  • Object
show all
Defined in:
lib/DealMakerAPI/api/deal_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DealApi

Returns a new instance of DealApi.



19
20
21
 
# File 'lib/DealMakerAPI/api/deal_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/DealMakerAPI/api/deal_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#ach_bank_account_setup_intent(id, investor_id, subscription_id, opts = {}) ⇒ V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent

Prepares an investor for payment Prepare investor for payment

Parameters:

  • id (String) —

    The deal id

  • investor_id (Integer) —

    The investor id

  • subscription_id (Integer) —

    The subscription id

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

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/DealMakerAPI/api/deal_api.rb', line 29

def (id, investor_id, subscription_id, opts = {})
  data, _status_code, _headers = (id, investor_id, subscription_id, opts)
  data
end

#ach_bank_account_setup_intent_with_http_info(id, investor_id, subscription_id, opts = {}) ⇒ Array<(V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent, Integer, Hash)>

Prepares an investor for payment Prepare investor for payment

Parameters:

  • id (String) —

    The deal id

  • investor_id (Integer) —

    The investor id

  • subscription_id (Integer) —

    The subscription id

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

    the optional parameters

Returns:



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
95
 
# File 'lib/DealMakerAPI/api/deal_api.rb', line 41

def (id, investor_id, subscription_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DealApi.ach_bank_account_setup_intent ...'
  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 DealApi.ach_bank_account_setup_intent"
  end
  # verify the required parameter 'investor_id' is set
  if @api_client.config.client_side_validation && investor_id.nil?
    fail ArgumentError, "Missing the required parameter 'investor_id' when calling DealApi.ach_bank_account_setup_intent"
  end
  # verify the required parameter 'subscription_id' is set
  if @api_client.config.client_side_validation && subscription_id.nil?
    fail ArgumentError, "Missing the required parameter 'subscription_id' when calling DealApi.ach_bank_account_setup_intent"
  end
  # resource path
  local_var_path = '/deals/{id}/investor/{investor_id}/subscription/{subscription_id}/payments/ach/bank_account_setup_intent'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'investor_id' + '}', CGI.escape(investor_id.to_s)).sub('{' + 'subscription_id' + '}', CGI.escape(subscription_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] || 'V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent'

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

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

#acss_bank_account_setup_intent(id, investor_id, subscription_id, opts = {}) ⇒ V1EntitiesDealsInvestorsPaymentAcssBankAccountSetupIntent

Prepares an investor for payment Prepare investor for payment

Parameters:

  • id (String) —

    The deal id

  • investor_id (Integer) —

    The investor id

  • subscription_id (Integer) —

    The subscription id

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

    the optional parameters

Returns:



104
105
106
107
 
# File 'lib/DealMakerAPI/api/deal_api.rb', line 104

def (id, investor_id, subscription_id, opts = {})
  data, _status_code, _headers = (id, investor_id, subscription_id, opts)
  data
end

#acss_bank_account_setup_intent_with_http_info(id, investor_id, subscription_id, opts = {}) ⇒ Array<(V1EntitiesDealsInvestorsPaymentAcssBankAccountSetupIntent, Integer, Hash)>

Prepares an investor for payment Prepare investor for payment

Parameters:

  • id (String) —

    The deal id

  • investor_id (Integer) —

    The investor id

  • subscription_id (Integer) —

    The subscription id

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

    the optional parameters

Returns:



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
164
165
166
167
168
169
170
 
# File 'lib/DealMakerAPI/api/deal_api.rb', line 116

def (id, investor_id, subscription_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DealApi.acss_bank_account_setup_intent ...'
  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 DealApi.acss_bank_account_setup_intent"
  end
  # verify the required parameter 'investor_id' is set
  if @api_client.config.client_side_validation && investor_id.nil?
    fail ArgumentError, "Missing the required parameter 'investor_id' when calling DealApi.acss_bank_account_setup_intent"
  end
  # verify the required parameter 'subscription_id' is set
  if @api_client.config.client_side_validation && subscription_id.nil?
    fail ArgumentError, "Missing the required parameter 'subscription_id' when calling DealApi.acss_bank_account_setup_intent"
  end
  # resource path
  local_var_path = '/deals/{id}/investor/{investor_id}/subscription/{subscription_id}/payments/acss/bank_account_setup_intent'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'investor_id' + '}', CGI.escape(investor_id.to_s)).sub('{' + 'subscription_id' + '}', CGI.escape(subscription_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] || 'V1EntitiesDealsInvestorsPaymentAcssBankAccountSetupIntent'

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

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

#create_deal_setup(create_deal_setup_request, opts = {}) ⇒ V1EntitiesDealSetup

Create deal setup Create deal setup

Parameters:

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

    the optional parameters

Returns:



177
178
179
180
 
# File 'lib/DealMakerAPI/api/deal_api.rb', line 177

def create_deal_setup(create_deal_setup_request, opts = {})
  data, _status_code, _headers = create_deal_setup_with_http_info(create_deal_setup_request, opts)
  data
end

#create_deal_setup_with_http_info(create_deal_setup_request, opts = {}) ⇒ Array<(V1EntitiesDealSetup, Integer, Hash)>

Create deal setup Create deal setup

Parameters:

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

    the optional parameters

Returns:

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

    V1EntitiesDealSetup data, response status code and response headers



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
233
234
235
236
237
238
 
# File 'lib/DealMakerAPI/api/deal_api.rb', line 187

def create_deal_setup_with_http_info(create_deal_setup_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DealApi.create_deal_setup ...'
  end
  # verify the required parameter 'create_deal_setup_request' is set
  if @api_client.config.client_side_validation && create_deal_setup_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_deal_setup_request' when calling DealApi.create_deal_setup"
  end
  # resource path
  local_var_path = '/deal_setups'

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

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

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

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

#get_deal(id, opts = {}) ⇒ V1EntitiesDeal

Get deal by Deal ID Gets a single deal using the Deal ID

Parameters:

  • id (Integer) —

    The deal id.

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

    the optional parameters

Returns:



245
246
247
248
 
# File 'lib/DealMakerAPI/api/deal_api.rb', line 245

def get_deal(id, opts = {})
  data, _status_code, _headers = get_deal_with_http_info(id, opts)
  data
end

#get_deal_incentive_plan(id, opts = {}) ⇒ V1EntitiesDealsPriceDetails

Get incentive plan by deal id Gets the current active incentive plan for the given deal id.

Parameters:

  • id (Integer) —

    The deal id.

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

    the optional parameters

Options Hash (opts):

  • :investment_amount (Float) —

    The investment amount to get the security price for.

Returns:



309
310
311
312
 
# File 'lib/DealMakerAPI/api/deal_api.rb', line 309

def get_deal_incentive_plan(id, opts = {})
  data, _status_code, _headers = get_deal_incentive_plan_with_http_info(id, opts)
  data
end

#get_deal_incentive_plan_with_http_info(id, opts = {}) ⇒ Array<(V1EntitiesDealsPriceDetails, Integer, Hash)>

Get incentive plan by deal id Gets the current active incentive plan for the given deal id.

Parameters:

  • id (Integer) —

    The deal id.

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

    the optional parameters

Options Hash (opts):

  • :investment_amount (Float) —

    The investment amount to get the security price for.

Returns:

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

    V1EntitiesDealsPriceDetails data, response status code and response headers



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
 
# File 'lib/DealMakerAPI/api/deal_api.rb', line 320

def get_deal_incentive_plan_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DealApi.get_deal_incentive_plan ...'
  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 DealApi.get_deal_incentive_plan"
  end
  # resource path
  local_var_path = '/deals/{id}/incentive_plan'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'investment_amount'] = opts[:'investment_amount'] if !opts[:'investment_amount'].nil?

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

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

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

#get_deal_with_http_info(id, opts = {}) ⇒ Array<(V1EntitiesDeal, Integer, Hash)>

Get deal by Deal ID Gets a single deal using the Deal ID

Parameters:

  • id (Integer) —

    The deal id.

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

    the optional parameters

Returns:

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

    V1EntitiesDeal data, response status code and response headers



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
 
# File 'lib/DealMakerAPI/api/deal_api.rb', line 255

def get_deal_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DealApi.get_deal ...'
  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 DealApi.get_deal"
  end
  # resource path
  local_var_path = '/deals/{id}'.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] || 'V1EntitiesDeal'

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

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

#list_deals(opts = {}) ⇒ V1EntitiesDeals

List available deals List available deals

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page offset to fetch. (default to 1)

  • :per_page (Integer) —

    Number of results to return per page. (default to 25)

  • :offset (Integer) —

    Pad a number of results. (default to 0)

Returns:



376
377
378
379
 
# File 'lib/DealMakerAPI/api/deal_api.rb', line 376

def list_deals(opts = {})
  data, _status_code, _headers = list_deals_with_http_info(opts)
  data
end

#list_deals_with_http_info(opts = {}) ⇒ Array<(V1EntitiesDeals, Integer, Hash)>

List available deals List available deals

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page offset to fetch. (default to 1)

  • :per_page (Integer) —

    Number of results to return per page. (default to 25)

  • :offset (Integer) —

    Pad a number of results. (default to 0)

Returns:

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

    V1EntitiesDeals data, response status code and response headers



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/DealMakerAPI/api/deal_api.rb', line 388

def list_deals_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DealApi.list_deals ...'
  end
  # resource path
  local_var_path = '/deals'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?

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

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

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