atrium-ruby 2.0.0 → 2.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +12 -2
- data/docs/Holding.md +23 -0
- data/docs/HoldingResponseBody.md +8 -0
- data/docs/HoldingsApi.md +156 -0
- data/docs/HoldingsResponseBody.md +9 -0
- data/docs/Merchant.md +13 -0
- data/docs/MerchantResponseBody.md +8 -0
- data/docs/MerchantsApi.md +42 -0
- data/lib/atrium-ruby.rb +7 -0
- data/lib/atrium-ruby/api/atrium_client.rb +4 -0
- data/lib/atrium-ruby/api/holdings_api.rb +248 -0
- data/lib/atrium-ruby/api/merchants_api.rb +74 -0
- data/lib/atrium-ruby/models/holding.rb +314 -0
- data/lib/atrium-ruby/models/holding_response_body.rb +179 -0
- data/lib/atrium-ruby/models/holdings_response_body.rb +190 -0
- data/lib/atrium-ruby/models/merchant.rb +224 -0
- data/lib/atrium-ruby/models/merchant_response_body.rb +179 -0
- data/lib/atrium-ruby/version.rb +1 -1
- data/spec/api/holdings_api_spec.rb +81 -0
- data/spec/api/merchants_api_spec.rb +42 -0
- data/spec/models/holding_response_body_spec.rb +36 -0
- data/spec/models/holding_spec.rb +126 -0
- data/spec/models/holdings_response_body_spec.rb +42 -0
- data/spec/models/merchant_response_body_spec.rb +36 -0
- data/spec/models/merchant_spec.rb +66 -0
- metadata +30 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4c7004943272a2931f455280143a00a6d04a11dd
|
4
|
+
data.tar.gz: 187bf40fa9bbbc128802a56222375dafdc8e9b8f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: aeeb7e641b37ae9f1c93c382095d27b0ebd540641153fcc0675933a6cb83c9cfd8fdc28a74d4a1a73d8954a72b213c0156eb7ee4a7742bf6c38661ce3d710db2
|
7
|
+
data.tar.gz: 044fbf32a967da28b724335fee1d2d0025309367f4b157c3b47e132ede359df33263c079777fe8729ad5f3cfb4d0780930da3d840d8409b9d02f4242d4205140
|
data/README.md
CHANGED
@@ -17,12 +17,12 @@ gem build atrium-ruby.gemspec
|
|
17
17
|
Then either install the gem locally:
|
18
18
|
|
19
19
|
```shell
|
20
|
-
gem install ./atrium-ruby-2.
|
20
|
+
gem install ./atrium-ruby-2.1.0.gem
|
21
21
|
```
|
22
22
|
|
23
23
|
Finally add this to the Gemfile:
|
24
24
|
|
25
|
-
gem 'atrium-ruby', '~> 2.
|
25
|
+
gem 'atrium-ruby', '~> 2.1.0'
|
26
26
|
|
27
27
|
### Install from Git
|
28
28
|
|
@@ -75,6 +75,10 @@ Class | Method | HTTP request | Description
|
|
75
75
|
*Atrium::AccountsApi* | [**read_account**](docs/AccountsApi.md#read_account) | **GET** /users/{user_guid}/accounts/{account_guid} | Read an account
|
76
76
|
*Atrium::AccountsApi* | [**read_account_by_member_guid**](docs/AccountsApi.md#read_account_by_member_guid) | **GET** /users/{user_guid}/members/{member_guid}/accounts/{account_guid} | Read an account
|
77
77
|
*Atrium::ConnectWidgetApi* | [**get_connect_widget**](docs/ConnectWidgetApi.md#get_connect_widget) | **POST** /users/{user_guid}/connect_widget_url | Embedding in a website
|
78
|
+
*Atrium::HoldingsApi* | [**list_holdings**](docs/HoldingsApi.md#list_holdings) | **GET** /users/{user_guid}/holdings | List holdings
|
79
|
+
*Atrium::HoldingsApi* | [**list_holdings_by_account**](docs/HoldingsApi.md#list_holdings_by_account) | **GET** /users/{user_guid}/accounts/{account_guid}/holdings | List holdings by account
|
80
|
+
*Atrium::HoldingsApi* | [**list_holdings_by_member**](docs/HoldingsApi.md#list_holdings_by_member) | **GET** /users/{user_guid}/members/{member_guid}/holdings | List holdings by member
|
81
|
+
*Atrium::HoldingsApi* | [**read_holding**](docs/HoldingsApi.md#read_holding) | **GET** /users/{user_guid}/holdings/{holding_guid} | Read holding
|
78
82
|
*Atrium::IdentityApi* | [**identify_member**](docs/IdentityApi.md#identify_member) | **POST** /users/{user_guid}/members/{member_guid}/identify | Identify
|
79
83
|
*Atrium::IdentityApi* | [**list_account_owners**](docs/IdentityApi.md#list_account_owners) | **GET** /users/{user_guid}/members/{member_guid}/account_owners | List member account owners
|
80
84
|
*Atrium::InstitutionsApi* | [**list_institutions**](docs/InstitutionsApi.md#list_institutions) | **GET** /institutions | List institutions
|
@@ -92,6 +96,7 @@ Class | Method | HTTP request | Description
|
|
92
96
|
*Atrium::MembersApi* | [**read_member_status**](docs/MembersApi.md#read_member_status) | **GET** /users/{user_guid}/members/{member_guid}/status | Read member connection status
|
93
97
|
*Atrium::MembersApi* | [**resume_member**](docs/MembersApi.md#resume_member) | **PUT** /users/{user_guid}/members/{member_guid}/resume | Resume aggregation from MFA
|
94
98
|
*Atrium::MembersApi* | [**update_member**](docs/MembersApi.md#update_member) | **PUT** /users/{user_guid}/members/{member_guid} | Update member
|
99
|
+
*Atrium::MerchantsApi* | [**read_merchant**](docs/MerchantsApi.md#read_merchant) | **GET** /merchants/{merchant_guid} | Read merchant
|
95
100
|
*Atrium::TransactionsApi* | [**cleanse_and_categorize_transactions**](docs/TransactionsApi.md#cleanse_and_categorize_transactions) | **POST** /cleanse_and_categorize | Categorize transactions
|
96
101
|
*Atrium::TransactionsApi* | [**list_user_transactions**](docs/TransactionsApi.md#list_user_transactions) | **GET** /users/{user_guid}/transactions | List transactions for a user
|
97
102
|
*Atrium::TransactionsApi* | [**read_transaction**](docs/TransactionsApi.md#read_transaction) | **GET** /users/{user_guid}/transactions/{transaction_guid} | Read a transaction
|
@@ -124,6 +129,9 @@ Class | Method | HTTP request | Description
|
|
124
129
|
- [Atrium::CredentialRequest](docs/CredentialRequest.md)
|
125
130
|
- [Atrium::CredentialResponse](docs/CredentialResponse.md)
|
126
131
|
- [Atrium::CredentialsResponseBody](docs/CredentialsResponseBody.md)
|
132
|
+
- [Atrium::Holding](docs/Holding.md)
|
133
|
+
- [Atrium::HoldingResponseBody](docs/HoldingResponseBody.md)
|
134
|
+
- [Atrium::HoldingsResponseBody](docs/HoldingsResponseBody.md)
|
127
135
|
- [Atrium::Institution](docs/Institution.md)
|
128
136
|
- [Atrium::InstitutionResponseBody](docs/InstitutionResponseBody.md)
|
129
137
|
- [Atrium::InstitutionsResponseBody](docs/InstitutionsResponseBody.md)
|
@@ -138,6 +146,8 @@ Class | Method | HTTP request | Description
|
|
138
146
|
- [Atrium::MemberUpdateRequest](docs/MemberUpdateRequest.md)
|
139
147
|
- [Atrium::MemberUpdateRequestBody](docs/MemberUpdateRequestBody.md)
|
140
148
|
- [Atrium::MembersResponseBody](docs/MembersResponseBody.md)
|
149
|
+
- [Atrium::Merchant](docs/Merchant.md)
|
150
|
+
- [Atrium::MerchantResponseBody](docs/MerchantResponseBody.md)
|
141
151
|
- [Atrium::Pagination](docs/Pagination.md)
|
142
152
|
- [Atrium::Transaction](docs/Transaction.md)
|
143
153
|
- [Atrium::TransactionCleanseAndCategorizeRequest](docs/TransactionCleanseAndCategorizeRequest.md)
|
data/docs/Holding.md
ADDED
@@ -0,0 +1,23 @@
|
|
1
|
+
# Atrium::Holding
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**account_guid** | **String** | | [optional]
|
7
|
+
**cost_basis** | **Float** | | [optional]
|
8
|
+
**created_at** | **String** | | [optional]
|
9
|
+
**currency_code** | **String** | | [optional]
|
10
|
+
**cusip** | **String** | | [optional]
|
11
|
+
**daily_change** | **Float** | | [optional]
|
12
|
+
**description** | **String** | | [optional]
|
13
|
+
**guid** | **String** | | [optional]
|
14
|
+
**holding_type** | **String** | | [optional]
|
15
|
+
**market_value** | **Float** | | [optional]
|
16
|
+
**member_guid** | **String** | | [optional]
|
17
|
+
**purchase_price** | **Float** | | [optional]
|
18
|
+
**shares** | **Float** | | [optional]
|
19
|
+
**symbol** | **String** | | [optional]
|
20
|
+
**updated_at** | **String** | | [optional]
|
21
|
+
**user_guid** | **String** | | [optional]
|
22
|
+
|
23
|
+
|
data/docs/HoldingsApi.md
ADDED
@@ -0,0 +1,156 @@
|
|
1
|
+
# Atrium::HoldingsApi
|
2
|
+
|
3
|
+
Method | HTTP request | Description
|
4
|
+
------------- | ------------- | -------------
|
5
|
+
[**list_holdings**](HoldingsApi.md#list_holdings) | **GET** /users/{user_guid}/holdings | List holdings
|
6
|
+
[**list_holdings_by_account**](HoldingsApi.md#list_holdings_by_account) | **GET** /users/{user_guid}/accounts/{account_guid}/holdings | List holdings by account
|
7
|
+
[**list_holdings_by_member**](HoldingsApi.md#list_holdings_by_member) | **GET** /users/{user_guid}/members/{member_guid}/holdings | List holdings by member
|
8
|
+
[**read_holding**](HoldingsApi.md#read_holding) | **GET** /users/{user_guid}/holdings/{holding_guid} | Read holding
|
9
|
+
|
10
|
+
|
11
|
+
# **list_holdings**
|
12
|
+
> HoldingsResponseBody list_holdings(user_guid)
|
13
|
+
|
14
|
+
List holdings
|
15
|
+
|
16
|
+
Use this endpoint to read all holdings associated with a specific user.
|
17
|
+
|
18
|
+
### Example
|
19
|
+
```ruby
|
20
|
+
# load the gem
|
21
|
+
require 'atrium-ruby'
|
22
|
+
|
23
|
+
client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
|
24
|
+
|
25
|
+
user_guid = "USR-123" # String | The unique identifier for a `user`.
|
26
|
+
|
27
|
+
begin
|
28
|
+
#List holdings
|
29
|
+
response = client.holdings.list_holdings(user_guid)
|
30
|
+
p response
|
31
|
+
rescue Atrium::ApiError => e
|
32
|
+
puts "Exception when calling HoldingsApi->list_holdings: #{e}"
|
33
|
+
end
|
34
|
+
```
|
35
|
+
|
36
|
+
### Parameters
|
37
|
+
|
38
|
+
Name | Type | Description | Notes
|
39
|
+
------------- | ------------- | ------------- | -------------
|
40
|
+
**user_guid** | **String**| The unique identifier for a `user`. |
|
41
|
+
|
42
|
+
### Return type
|
43
|
+
|
44
|
+
[**HoldingsResponseBody**](HoldingsResponseBody.md)
|
45
|
+
|
46
|
+
# **list_holdings_by_account**
|
47
|
+
> HoldingsResponseBody list_holdings_by_account(account_guid, user_guid)
|
48
|
+
|
49
|
+
List holdings by account
|
50
|
+
|
51
|
+
Use this endpoint to read all holdings associated with a specific account.
|
52
|
+
|
53
|
+
### Example
|
54
|
+
```ruby
|
55
|
+
# load the gem
|
56
|
+
require 'atrium-ruby'
|
57
|
+
|
58
|
+
client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
|
59
|
+
|
60
|
+
account_guid = "ACT-123" # String | The unique identifier for an `account`.
|
61
|
+
user_guid = "USR-123" # String | The unique identifier for a `user`.
|
62
|
+
|
63
|
+
begin
|
64
|
+
#List holdings by account
|
65
|
+
response = client.holdings.list_holdings_by_account(account_guid, user_guid)
|
66
|
+
p response
|
67
|
+
rescue Atrium::ApiError => e
|
68
|
+
puts "Exception when calling HoldingsApi->list_holdings_by_account: #{e}"
|
69
|
+
end
|
70
|
+
```
|
71
|
+
|
72
|
+
### Parameters
|
73
|
+
|
74
|
+
Name | Type | Description | Notes
|
75
|
+
------------- | ------------- | ------------- | -------------
|
76
|
+
**account_guid** | **String**| The unique identifier for an `account`. |
|
77
|
+
**user_guid** | **String**| The unique identifier for a `user`. |
|
78
|
+
|
79
|
+
### Return type
|
80
|
+
|
81
|
+
[**HoldingsResponseBody**](HoldingsResponseBody.md)
|
82
|
+
|
83
|
+
# **list_holdings_by_member**
|
84
|
+
> HoldingsResponseBody list_holdings_by_member(member_guid, user_guid)
|
85
|
+
|
86
|
+
List holdings by member
|
87
|
+
|
88
|
+
Use this endpoint to read all holdings associated with a specific member.
|
89
|
+
|
90
|
+
### Example
|
91
|
+
```ruby
|
92
|
+
# load the gem
|
93
|
+
require 'atrium-ruby'
|
94
|
+
|
95
|
+
client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
|
96
|
+
|
97
|
+
member_guid = "MBR-123" # String | The unique identifier for a `member`.
|
98
|
+
user_guid = "USR-123" # String | The unique identifier for a `user`.
|
99
|
+
|
100
|
+
begin
|
101
|
+
#List holdings by member
|
102
|
+
response = client.holdings.list_holdings_by_member(member_guid, user_guid)
|
103
|
+
p response
|
104
|
+
rescue Atrium::ApiError => e
|
105
|
+
puts "Exception when calling HoldingsApi->list_holdings_by_member: #{e}"
|
106
|
+
end
|
107
|
+
```
|
108
|
+
|
109
|
+
### Parameters
|
110
|
+
|
111
|
+
Name | Type | Description | Notes
|
112
|
+
------------- | ------------- | ------------- | -------------
|
113
|
+
**member_guid** | **String**| The unique identifier for a `member`. |
|
114
|
+
**user_guid** | **String**| The unique identifier for a `user`. |
|
115
|
+
|
116
|
+
### Return type
|
117
|
+
|
118
|
+
[**HoldingsResponseBody**](HoldingsResponseBody.md)
|
119
|
+
|
120
|
+
# **read_holding**
|
121
|
+
> HoldingResponseBody read_holding(holding_guid, user_guid)
|
122
|
+
|
123
|
+
Read holding
|
124
|
+
|
125
|
+
Use this endpoint to read the attributes of a specific holding.
|
126
|
+
|
127
|
+
### Example
|
128
|
+
```ruby
|
129
|
+
# load the gem
|
130
|
+
require 'atrium-ruby'
|
131
|
+
|
132
|
+
client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
|
133
|
+
|
134
|
+
holding_guid = "HOL-123" # String | The unique identifier for a `holding`.
|
135
|
+
user_guid = "USR-123" # String | The unique identifier for a `user`.
|
136
|
+
|
137
|
+
begin
|
138
|
+
#Read holding
|
139
|
+
response = client.holdings.read_holding(holding_guid, user_guid)
|
140
|
+
p response
|
141
|
+
rescue Atrium::ApiError => e
|
142
|
+
puts "Exception when calling HoldingsApi->read_holding: #{e}"
|
143
|
+
end
|
144
|
+
```
|
145
|
+
|
146
|
+
### Parameters
|
147
|
+
|
148
|
+
Name | Type | Description | Notes
|
149
|
+
------------- | ------------- | ------------- | -------------
|
150
|
+
**holding_guid** | **String**| The unique identifier for a `holding`. |
|
151
|
+
**user_guid** | **String**| The unique identifier for a `user`. |
|
152
|
+
|
153
|
+
### Return type
|
154
|
+
|
155
|
+
[**HoldingResponseBody**](HoldingResponseBody.md)
|
156
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# Atrium::HoldingsResponseBody
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**holdings** | [**Array<Holding>**](Holding.md) | | [optional]
|
7
|
+
**pagination** | [**Pagination**](Pagination.md) | | [optional]
|
8
|
+
|
9
|
+
|
data/docs/Merchant.md
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
# Atrium::Merchant
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**created_at** | **String** | | [optional]
|
7
|
+
**guid** | **String** | | [optional]
|
8
|
+
**logo_url** | **String** | | [optional]
|
9
|
+
**name** | **String** | | [optional]
|
10
|
+
**updated_at** | **String** | | [optional]
|
11
|
+
**website_url** | **String** | | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,42 @@
|
|
1
|
+
# Atrium::MerchantsApi
|
2
|
+
|
3
|
+
Method | HTTP request | Description
|
4
|
+
------------- | ------------- | -------------
|
5
|
+
[**read_merchant**](MerchantsApi.md#read_merchant) | **GET** /merchants/{merchant_guid} | Read merchant
|
6
|
+
|
7
|
+
|
8
|
+
# **read_merchant**
|
9
|
+
> MerchantResponseBody read_merchant(merchant_guid)
|
10
|
+
|
11
|
+
Read merchant
|
12
|
+
|
13
|
+
Returns information about a particular merchant, such as a logo, name, and website.
|
14
|
+
|
15
|
+
### Example
|
16
|
+
```ruby
|
17
|
+
# load the gem
|
18
|
+
require 'atrium-ruby'
|
19
|
+
|
20
|
+
client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
|
21
|
+
|
22
|
+
merchant_guid = "MCH-123" # String | The unique identifier for a `merchant`.
|
23
|
+
|
24
|
+
begin
|
25
|
+
#Read merchant
|
26
|
+
response = client.merchants.read_merchant(merchant_guid)
|
27
|
+
p response
|
28
|
+
rescue Atrium::ApiError => e
|
29
|
+
puts "Exception when calling MerchantsApi->read_merchant: #{e}"
|
30
|
+
end
|
31
|
+
```
|
32
|
+
|
33
|
+
### Parameters
|
34
|
+
|
35
|
+
Name | Type | Description | Notes
|
36
|
+
------------- | ------------- | ------------- | -------------
|
37
|
+
**merchant_guid** | **String**| The unique identifier for a `merchant`. |
|
38
|
+
|
39
|
+
### Return type
|
40
|
+
|
41
|
+
[**MerchantResponseBody**](MerchantResponseBody.md)
|
42
|
+
|
data/lib/atrium-ruby.rb
CHANGED
@@ -30,6 +30,9 @@ require 'atrium-ruby/models/credential_option'
|
|
30
30
|
require 'atrium-ruby/models/credential_request'
|
31
31
|
require 'atrium-ruby/models/credential_response'
|
32
32
|
require 'atrium-ruby/models/credentials_response_body'
|
33
|
+
require 'atrium-ruby/models/holding'
|
34
|
+
require 'atrium-ruby/models/holding_response_body'
|
35
|
+
require 'atrium-ruby/models/holdings_response_body'
|
33
36
|
require 'atrium-ruby/models/institution'
|
34
37
|
require 'atrium-ruby/models/institution_response_body'
|
35
38
|
require 'atrium-ruby/models/institutions_response_body'
|
@@ -44,6 +47,8 @@ require 'atrium-ruby/models/member_resume_request_body'
|
|
44
47
|
require 'atrium-ruby/models/member_update_request'
|
45
48
|
require 'atrium-ruby/models/member_update_request_body'
|
46
49
|
require 'atrium-ruby/models/members_response_body'
|
50
|
+
require 'atrium-ruby/models/merchant'
|
51
|
+
require 'atrium-ruby/models/merchant_response_body'
|
47
52
|
require 'atrium-ruby/models/pagination'
|
48
53
|
require 'atrium-ruby/models/transaction'
|
49
54
|
require 'atrium-ruby/models/transaction_cleanse_and_categorize_request'
|
@@ -61,9 +66,11 @@ require 'atrium-ruby/models/users_response_body'
|
|
61
66
|
# APIs
|
62
67
|
require 'atrium-ruby/api/accounts_api'
|
63
68
|
require 'atrium-ruby/api/connect_widget_api'
|
69
|
+
require 'atrium-ruby/api/holdings_api'
|
64
70
|
require 'atrium-ruby/api/identity_api'
|
65
71
|
require 'atrium-ruby/api/institutions_api'
|
66
72
|
require 'atrium-ruby/api/members_api'
|
73
|
+
require 'atrium-ruby/api/merchants_api'
|
67
74
|
require 'atrium-ruby/api/transactions_api'
|
68
75
|
require 'atrium-ruby/api/users_api'
|
69
76
|
require 'atrium-ruby/api/verification_api'
|
@@ -2,9 +2,11 @@ module Atrium
|
|
2
2
|
class AtriumClient
|
3
3
|
attr_accessor :accounts
|
4
4
|
attr_accessor :connectWidget
|
5
|
+
attr_accessor :holdings
|
5
6
|
attr_accessor :identity
|
6
7
|
attr_accessor :institutions
|
7
8
|
attr_accessor :members
|
9
|
+
attr_accessor :merchants
|
8
10
|
attr_accessor :transactions
|
9
11
|
attr_accessor :users
|
10
12
|
attr_accessor :verification
|
@@ -17,9 +19,11 @@ module Atrium
|
|
17
19
|
|
18
20
|
@accounts = Atrium::AccountsApi.new()
|
19
21
|
@connectWidget = Atrium::ConnectWidgetApi.new()
|
22
|
+
@holdings = Atrium::HoldingsApi.new()
|
20
23
|
@identity = Atrium::IdentityApi.new()
|
21
24
|
@institutions = Atrium::InstitutionsApi.new()
|
22
25
|
@members = Atrium::MembersApi.new()
|
26
|
+
@merchants = Atrium::MerchantsApi.new()
|
23
27
|
@transactions = Atrium::TransactionsApi.new()
|
24
28
|
@users = Atrium::UsersApi.new()
|
25
29
|
@verification = Atrium::VerificationApi.new()
|
@@ -0,0 +1,248 @@
|
|
1
|
+
=begin
|
2
|
+
#MX API
|
3
|
+
|
4
|
+
#The MX Atrium API supports over 48,000 data connections to thousands of financial institutions. It provides secure access to your users' accounts and transactions with industry-leading cleansing, categorization, and classification. Atrium is designed according to resource-oriented REST architecture and responds with JSON bodies and HTTP response codes. Use Atrium's development environment, vestibule.mx.com, to quickly get up and running. The development environment limits are 100 users, 25 members per user, and access to the top 15 institutions. Contact MX to purchase production access.
|
5
|
+
|
6
|
+
|
7
|
+
=end
|
8
|
+
|
9
|
+
require 'uri'
|
10
|
+
|
11
|
+
module Atrium
|
12
|
+
class HoldingsApi
|
13
|
+
attr_accessor :api_client
|
14
|
+
|
15
|
+
def initialize(api_client = ApiClient.default)
|
16
|
+
@api_client = api_client
|
17
|
+
end
|
18
|
+
# List holdings
|
19
|
+
# Use this endpoint to read all holdings associated with a specific user.
|
20
|
+
# @param user_guid The unique identifier for a `user`.
|
21
|
+
# @param [Hash] opts the optional parameters
|
22
|
+
# @return [HoldingsResponseBody]
|
23
|
+
def list_holdings(user_guid, opts = {})
|
24
|
+
data, _status_code, _headers = list_holdings_with_http_info(user_guid, opts)
|
25
|
+
data
|
26
|
+
end
|
27
|
+
|
28
|
+
# List holdings by account
|
29
|
+
# Use this endpoint to read all holdings associated with a specific account.
|
30
|
+
# @param account_guid The unique identifier for an `account`.
|
31
|
+
# @param user_guid The unique identifier for a `user`.
|
32
|
+
# @param [Hash] opts the optional parameters
|
33
|
+
# @return [HoldingsResponseBody]
|
34
|
+
def list_holdings_by_account(account_guid, user_guid, opts = {})
|
35
|
+
data, _status_code, _headers = list_holdings_by_account_with_http_info(account_guid, user_guid, opts)
|
36
|
+
data
|
37
|
+
end
|
38
|
+
|
39
|
+
# List holdings by member
|
40
|
+
# Use this endpoint to read all holdings associated with a specific member.
|
41
|
+
# @param member_guid The unique identifier for a `member`.
|
42
|
+
# @param user_guid The unique identifier for a `user`.
|
43
|
+
# @param [Hash] opts the optional parameters
|
44
|
+
# @return [HoldingsResponseBody]
|
45
|
+
def list_holdings_by_member(member_guid, user_guid, opts = {})
|
46
|
+
data, _status_code, _headers = list_holdings_by_member_with_http_info(member_guid, user_guid, opts)
|
47
|
+
data
|
48
|
+
end
|
49
|
+
|
50
|
+
# Read holding
|
51
|
+
# Use this endpoint to read the attributes of a specific holding.
|
52
|
+
# @param holding_guid The unique identifier for a `holding`.
|
53
|
+
# @param user_guid The unique identifier for a `user`.
|
54
|
+
# @param [Hash] opts the optional parameters
|
55
|
+
# @return [HoldingResponseBody]
|
56
|
+
def read_holding(holding_guid, user_guid, opts = {})
|
57
|
+
data, _status_code, _headers = read_holding_with_http_info(holding_guid, user_guid, opts)
|
58
|
+
data
|
59
|
+
end
|
60
|
+
|
61
|
+
|
62
|
+
private
|
63
|
+
|
64
|
+
# List holdings
|
65
|
+
# Use this endpoint to read all holdings associated with a specific user.
|
66
|
+
# @param user_guid The unique identifier for a `user`.
|
67
|
+
# @param [Hash] opts the optional parameters
|
68
|
+
# @return [Array<(HoldingsResponseBody, Fixnum, Hash)>] HoldingsResponseBody data, response status code and response headers
|
69
|
+
def list_holdings_with_http_info(user_guid, opts = {})
|
70
|
+
if @api_client.config.debugging
|
71
|
+
@api_client.config.logger.debug 'Calling API: HoldingsApi.list_holdings ...'
|
72
|
+
end
|
73
|
+
# verify the required parameter 'user_guid' is set
|
74
|
+
if @api_client.config.client_side_validation && user_guid.nil?
|
75
|
+
fail ArgumentError, "Missing the required parameter 'user_guid' when calling HoldingsApi.list_holdings"
|
76
|
+
end
|
77
|
+
# resource path
|
78
|
+
local_var_path = '/users/{user_guid}/holdings'.sub('{' + 'user_guid' + '}', user_guid.to_s)
|
79
|
+
|
80
|
+
# query parameters
|
81
|
+
query_params = {}
|
82
|
+
|
83
|
+
# header parameters
|
84
|
+
header_params = {}
|
85
|
+
# HTTP header 'Accept' (if needed)
|
86
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.atrium.v1+json'])
|
87
|
+
|
88
|
+
# form parameters
|
89
|
+
form_params = {}
|
90
|
+
|
91
|
+
# http body (model)
|
92
|
+
post_body = nil
|
93
|
+
auth_names = ['apiKey', 'clientID']
|
94
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
95
|
+
:header_params => header_params,
|
96
|
+
:query_params => query_params,
|
97
|
+
:form_params => form_params,
|
98
|
+
:body => post_body,
|
99
|
+
:auth_names => auth_names,
|
100
|
+
:return_type => 'HoldingsResponseBody')
|
101
|
+
if @api_client.config.debugging
|
102
|
+
@api_client.config.logger.debug "API called: HoldingsApi#list_holdings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
103
|
+
end
|
104
|
+
return data, status_code, headers
|
105
|
+
end
|
106
|
+
# List holdings by account
|
107
|
+
# Use this endpoint to read all holdings associated with a specific account.
|
108
|
+
# @param account_guid The unique identifier for an `account`.
|
109
|
+
# @param user_guid The unique identifier for a `user`.
|
110
|
+
# @param [Hash] opts the optional parameters
|
111
|
+
# @return [Array<(HoldingsResponseBody, Fixnum, Hash)>] HoldingsResponseBody data, response status code and response headers
|
112
|
+
def list_holdings_by_account_with_http_info(account_guid, user_guid, opts = {})
|
113
|
+
if @api_client.config.debugging
|
114
|
+
@api_client.config.logger.debug 'Calling API: HoldingsApi.list_holdings_by_account ...'
|
115
|
+
end
|
116
|
+
# verify the required parameter 'account_guid' is set
|
117
|
+
if @api_client.config.client_side_validation && account_guid.nil?
|
118
|
+
fail ArgumentError, "Missing the required parameter 'account_guid' when calling HoldingsApi.list_holdings_by_account"
|
119
|
+
end
|
120
|
+
# verify the required parameter 'user_guid' is set
|
121
|
+
if @api_client.config.client_side_validation && user_guid.nil?
|
122
|
+
fail ArgumentError, "Missing the required parameter 'user_guid' when calling HoldingsApi.list_holdings_by_account"
|
123
|
+
end
|
124
|
+
# resource path
|
125
|
+
local_var_path = '/users/{user_guid}/accounts/{account_guid}/holdings'.sub('{' + 'account_guid' + '}', account_guid.to_s).sub('{' + 'user_guid' + '}', user_guid.to_s)
|
126
|
+
|
127
|
+
# query parameters
|
128
|
+
query_params = {}
|
129
|
+
|
130
|
+
# header parameters
|
131
|
+
header_params = {}
|
132
|
+
# HTTP header 'Accept' (if needed)
|
133
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.atrium.v1+json'])
|
134
|
+
|
135
|
+
# form parameters
|
136
|
+
form_params = {}
|
137
|
+
|
138
|
+
# http body (model)
|
139
|
+
post_body = nil
|
140
|
+
auth_names = ['apiKey', 'clientID']
|
141
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
142
|
+
:header_params => header_params,
|
143
|
+
:query_params => query_params,
|
144
|
+
:form_params => form_params,
|
145
|
+
:body => post_body,
|
146
|
+
:auth_names => auth_names,
|
147
|
+
:return_type => 'HoldingsResponseBody')
|
148
|
+
if @api_client.config.debugging
|
149
|
+
@api_client.config.logger.debug "API called: HoldingsApi#list_holdings_by_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
150
|
+
end
|
151
|
+
return data, status_code, headers
|
152
|
+
end
|
153
|
+
# List holdings by member
|
154
|
+
# Use this endpoint to read all holdings associated with a specific member.
|
155
|
+
# @param member_guid The unique identifier for a `member`.
|
156
|
+
# @param user_guid The unique identifier for a `user`.
|
157
|
+
# @param [Hash] opts the optional parameters
|
158
|
+
# @return [Array<(HoldingsResponseBody, Fixnum, Hash)>] HoldingsResponseBody data, response status code and response headers
|
159
|
+
def list_holdings_by_member_with_http_info(member_guid, user_guid, opts = {})
|
160
|
+
if @api_client.config.debugging
|
161
|
+
@api_client.config.logger.debug 'Calling API: HoldingsApi.list_holdings_by_member ...'
|
162
|
+
end
|
163
|
+
# verify the required parameter 'member_guid' is set
|
164
|
+
if @api_client.config.client_side_validation && member_guid.nil?
|
165
|
+
fail ArgumentError, "Missing the required parameter 'member_guid' when calling HoldingsApi.list_holdings_by_member"
|
166
|
+
end
|
167
|
+
# verify the required parameter 'user_guid' is set
|
168
|
+
if @api_client.config.client_side_validation && user_guid.nil?
|
169
|
+
fail ArgumentError, "Missing the required parameter 'user_guid' when calling HoldingsApi.list_holdings_by_member"
|
170
|
+
end
|
171
|
+
# resource path
|
172
|
+
local_var_path = '/users/{user_guid}/members/{member_guid}/holdings'.sub('{' + 'member_guid' + '}', member_guid.to_s).sub('{' + 'user_guid' + '}', user_guid.to_s)
|
173
|
+
|
174
|
+
# query parameters
|
175
|
+
query_params = {}
|
176
|
+
|
177
|
+
# header parameters
|
178
|
+
header_params = {}
|
179
|
+
# HTTP header 'Accept' (if needed)
|
180
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.atrium.v1+json'])
|
181
|
+
|
182
|
+
# form parameters
|
183
|
+
form_params = {}
|
184
|
+
|
185
|
+
# http body (model)
|
186
|
+
post_body = nil
|
187
|
+
auth_names = ['apiKey', 'clientID']
|
188
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
189
|
+
:header_params => header_params,
|
190
|
+
:query_params => query_params,
|
191
|
+
:form_params => form_params,
|
192
|
+
:body => post_body,
|
193
|
+
:auth_names => auth_names,
|
194
|
+
:return_type => 'HoldingsResponseBody')
|
195
|
+
if @api_client.config.debugging
|
196
|
+
@api_client.config.logger.debug "API called: HoldingsApi#list_holdings_by_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
197
|
+
end
|
198
|
+
return data, status_code, headers
|
199
|
+
end
|
200
|
+
# Read holding
|
201
|
+
# Use this endpoint to read the attributes of a specific holding.
|
202
|
+
# @param holding_guid The unique identifier for a `holding`.
|
203
|
+
# @param user_guid The unique identifier for a `user`.
|
204
|
+
# @param [Hash] opts the optional parameters
|
205
|
+
# @return [Array<(HoldingResponseBody, Fixnum, Hash)>] HoldingResponseBody data, response status code and response headers
|
206
|
+
def read_holding_with_http_info(holding_guid, user_guid, opts = {})
|
207
|
+
if @api_client.config.debugging
|
208
|
+
@api_client.config.logger.debug 'Calling API: HoldingsApi.read_holding ...'
|
209
|
+
end
|
210
|
+
# verify the required parameter 'holding_guid' is set
|
211
|
+
if @api_client.config.client_side_validation && holding_guid.nil?
|
212
|
+
fail ArgumentError, "Missing the required parameter 'holding_guid' when calling HoldingsApi.read_holding"
|
213
|
+
end
|
214
|
+
# verify the required parameter 'user_guid' is set
|
215
|
+
if @api_client.config.client_side_validation && user_guid.nil?
|
216
|
+
fail ArgumentError, "Missing the required parameter 'user_guid' when calling HoldingsApi.read_holding"
|
217
|
+
end
|
218
|
+
# resource path
|
219
|
+
local_var_path = '/users/{user_guid}/holdings/{holding_guid}'.sub('{' + 'holding_guid' + '}', holding_guid.to_s).sub('{' + 'user_guid' + '}', user_guid.to_s)
|
220
|
+
|
221
|
+
# query parameters
|
222
|
+
query_params = {}
|
223
|
+
|
224
|
+
# header parameters
|
225
|
+
header_params = {}
|
226
|
+
# HTTP header 'Accept' (if needed)
|
227
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.atrium.v1+json'])
|
228
|
+
|
229
|
+
# form parameters
|
230
|
+
form_params = {}
|
231
|
+
|
232
|
+
# http body (model)
|
233
|
+
post_body = nil
|
234
|
+
auth_names = ['apiKey', 'clientID']
|
235
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
236
|
+
:header_params => header_params,
|
237
|
+
:query_params => query_params,
|
238
|
+
:form_params => form_params,
|
239
|
+
:body => post_body,
|
240
|
+
:auth_names => auth_names,
|
241
|
+
:return_type => 'HoldingResponseBody')
|
242
|
+
if @api_client.config.debugging
|
243
|
+
@api_client.config.logger.debug "API called: HoldingsApi#read_holding\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
244
|
+
end
|
245
|
+
return data, status_code, headers
|
246
|
+
end
|
247
|
+
end
|
248
|
+
end
|