Class: Atrium::HoldingsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/atrium-ruby/api/holdings_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ HoldingsApi

Returns a new instance of HoldingsApi.



15
16
17
 
# File 'lib/atrium-ruby/api/holdings_api.rb', line 15

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



13
14
15
 
# File 'lib/atrium-ruby/api/holdings_api.rb', line 13

def api_client
  @api_client
end

Instance Method Details

#list_holdings(user_guid, opts = {}) ⇒ HoldingsResponseBody

List holdings Use this endpoint to read all holdings associated with a specific user.

Parameters:

  • user_guid —

    The unique identifier for a `user`.

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

    the optional parameters

Returns:



23
24
25
26
 
# File 'lib/atrium-ruby/api/holdings_api.rb', line 23

def list_holdings(user_guid, opts = {})
  data, _status_code, _headers = list_holdings_with_http_info(user_guid, opts)
  data
end

#list_holdings_by_account(account_guid, user_guid, opts = {}) ⇒ HoldingsResponseBody

List holdings by account Use this endpoint to read all holdings associated with a specific account.

Parameters:

  • account_guid —

    The unique identifier for an `account`.

  • user_guid —

    The unique identifier for a `user`.

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

    the optional parameters

Returns:



34
35
36
37
 
# File 'lib/atrium-ruby/api/holdings_api.rb', line 34

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

#list_holdings_by_member(member_guid, user_guid, opts = {}) ⇒ HoldingsResponseBody

List holdings by member Use this endpoint to read all holdings associated with a specific member.

Parameters:

  • member_guid —

    The unique identifier for a `member`.

  • user_guid —

    The unique identifier for a `user`.

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

    the optional parameters

Returns:



45
46
47
48
 
# File 'lib/atrium-ruby/api/holdings_api.rb', line 45

def list_holdings_by_member(member_guid, user_guid, opts = {})
  data, _status_code, _headers = list_holdings_by_member_with_http_info(member_guid, user_guid, opts)
  data
end

#read_holding(holding_guid, user_guid, opts = {}) ⇒ HoldingResponseBody

Read holding Use this endpoint to read the attributes of a specific holding.

Parameters:

  • holding_guid —

    The unique identifier for a `holding`.

  • user_guid —

    The unique identifier for a `user`.

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

    the optional parameters

Returns:



56
57
58
59
 
# File 'lib/atrium-ruby/api/holdings_api.rb', line 56

def read_holding(holding_guid, user_guid, opts = {})
  data, _status_code, _headers = read_holding_with_http_info(holding_guid, user_guid, opts)
  data
end