Skip to content

Commit 349ad63

Browse files
brettmortensenbrettmortensen
committed
Add credit card product and rewards beta endpoints
1 parent c587646 commit 349ad63

10 files changed

Lines changed: 796 additions & 1 deletion

‎atrium.ts‎

Lines changed: 574 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/Account.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,13 @@ Name | Type | Description | Notes
1212
**cashBalance** | **number** | | [optional]
1313
**cashSurrenderValue** | **number** | | [optional]
1414
**createdAt** | **string** | | [optional]
15+
**creditCardProductGuid** | **string** | | [optional]
1516
**creditLimit** | **number** | | [optional]
1617
**currencyCode** | **string** | | [optional]
18+
**currentRewardLevel** | **string** | | [optional]
1719
**dayPaymentIsDue** | **number** | | [optional]
1820
**deathBenefit** | **number** | | [optional]
21+
**enrolledInRewardsOn** | **string** | | [optional]
1922
**guid** | **string** | | [optional]
2023
**holdingsValue** | **number** | | [optional]
2124
**institutionCode** | **string** | | [optional]
@@ -28,9 +31,11 @@ Name | Type | Description | Notes
2831
**minimumBalance** | **number** | | [optional]
2932
**minimumPayment** | **number** | | [optional]
3033
**name** | **string** | | [optional]
34+
**nextRewardLevel** | **string** | | [optional]
3135
**originalBalance** | **number** | | [optional]
3236
**paymentDueAt** | **string** | | [optional]
3337
**payoffBalance** | **number** | | [optional]
38+
**primaryRewardUnit** | **string** | | [optional]
3439
**startedOn** | **string** | | [optional]
3540
**subtype** | **string** | | [optional]
3641
**totalAccountValue** | **number** | | [optional]

‎docs/CreditCardProduct.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# CreditCardProduct
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**guid** | **string** | | [optional]
7+
**name** | **string** | | [optional]
8+
**annualFee** | **number** | | [optional]
9+
**hasCashbackRewards** | **boolean** | | [optional]
10+
**hasTravelRewards** | **boolean** | | [optional]
11+
**isSmallBusinessCard** | **boolean** | | [optional]
12+
**hasZeroPercentIntroductoryRate** | **boolean** | | [optional]
13+
14+

‎docs/CreditCardProductResponseBody.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CreditCardProductResponseBody
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**creditCardProduct** | [**CreditCardProduct**](CreditCardProduct.md) | | [optional]
7+
8+

‎docs/CreditCardProductsApi.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# .CreditCardProductsApi
2+
3+
Method | HTTP request | Description
4+
------------- | ------------- | -------------
5+
[**readCreditCardProduct**](CreditCardProductsApi.md#readCreditCardProduct) | **GET** /credit_card_products/{credit_card_product_guid} | Read credit card product
6+
7+
8+
# **readCreditCardProduct**
9+
> CreditCardProductResponseBody readCreditCardProduct(creditCardProductGuid)
10+
11+
Read credit card product
12+
13+
Use this endpoint to read the attributes of a credit card product.
14+
15+
### Example
16+
```javascript
17+
var atrium = require('./atrium.js');
18+
19+
var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID", "https://vestibule.mx.com");
20+
21+
var creditCardProductGuid = "CCA-123"; // string | The unique identifier for a `credit card product`.
22+
23+
var response = client.creditCardProducts.readCreditCardProduct(creditCardProductGuid);
24+
25+
response.then(function(value) {
26+
console.log(value);
27+
});
28+
```
29+
30+
### Parameters
31+
32+
Name | Type | Description | Notes
33+
------------- | ------------- | ------------- | -------------
34+
**creditCardProductGuid** | **string**| The unique identifier for a `credit card product`. |
35+
36+
### Return type
37+
38+
[**CreditCardProductResponseBody**](CreditCardProductResponseBody.md)
39+
40+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
41+

‎docs/Reward.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Reward
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**accountGuid** | **string** | | [optional]
7+
**balance** | **number** | | [optional]
8+
**balanceType** | **string** | | [optional]
9+
**createdAt** | **string** | | [optional]
10+
**description** | **string** | | [optional]
11+
**expiresOn** | **string** | | [optional]
12+
**guid** | **string** | | [optional]
13+
**memberGuid** | **string** | | [optional]
14+
**unitType** | **string** | | [optional]
15+
**updatedAt** | **string** | | [optional]
16+
**userGuid** | **string** | | [optional]
17+
18+

‎docs/RewardResponseBody.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# RewardResponseBody
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**reward** | [**Reward**](Reward.md) | | [optional]
7+
8+

‎docs/RewardsApi.md‎

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
# .RewardsApi
2+
3+
Method | HTTP request | Description
4+
------------- | ------------- | -------------
5+
[**fetchRewards**](RewardsApi.md#fetchRewards) | **POST** /users/{user_guid}/members/{member_guid}/fetch_rewards | Fetch rewards
6+
[**listRewards**](RewardsApi.md#listRewards) | **GET** /users/{user_guid}/members/{member_guid}/rewards | List rewards
7+
[**readReward**](RewardsApi.md#readReward) | **GET** /users/{user_guid}/members/{member_guid}/rewards/{reward_guid} | Read reward
8+
9+
10+
# **fetchRewards**
11+
> MemberResponseBody fetchRewards(memberGuid, userGuid)
12+
13+
Fetch rewards
14+
15+
The fetch rewards endpoint begins fetching rewards for a member.
16+
17+
### Example
18+
```javascript
19+
var atrium = require('./atrium.js');
20+
21+
var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID", "https://vestibule.mx.com");
22+
23+
var memberGuid = "MBR-123"; // string | The unique identifier for a `member`.
24+
var userGuid = "USR-123"; // string | The unique identifier for a `user`.
25+
26+
var response = client.rewards.fetchRewards(memberGuid, userGuid);
27+
28+
response.then(function(value) {
29+
console.log(value);
30+
});
31+
```
32+
33+
### Parameters
34+
35+
Name | Type | Description | Notes
36+
------------- | ------------- | ------------- | -------------
37+
**memberGuid** | **string**| The unique identifier for a `member`. |
38+
**userGuid** | **string**| The unique identifier for a `user`. |
39+
40+
### Return type
41+
42+
[**MemberResponseBody**](MemberResponseBody.md)
43+
44+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
45+
46+
# **listRewards**
47+
> RewardsResponseBody listRewards(memberGuid, userGuid)
48+
49+
List rewards
50+
51+
List rewards for a given account.
52+
53+
### Example
54+
```javascript
55+
var atrium = require('./atrium.js');
56+
57+
var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID", "https://vestibule.mx.com");
58+
59+
var memberGuid = "MBR-123"; // string | The unique identifier for a `member`.
60+
var userGuid = "USR-123"; // string | The unique identifier for a `user`.
61+
62+
var response = client.rewards.listRewards(memberGuid, userGuid);
63+
64+
response.then(function(value) {
65+
console.log(value);
66+
});
67+
```
68+
69+
### Parameters
70+
71+
Name | Type | Description | Notes
72+
------------- | ------------- | ------------- | -------------
73+
**memberGuid** | **string**| The unique identifier for a `member`. |
74+
**userGuid** | **string**| The unique identifier for a `user`. |
75+
76+
### Return type
77+
78+
[**RewardsResponseBody**](RewardsResponseBody.md)
79+
80+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
81+
82+
# **readReward**
83+
> RewardResponseBody readReward(memberGuid, rewardGuid, userGuid)
84+
85+
Read reward
86+
87+
Read a reward.
88+
89+
### Example
90+
```javascript
91+
var atrium = require('./atrium.js');
92+
93+
var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID", "https://vestibule.mx.com");
94+
95+
var memberGuid = "MBR-123"; // string | The unique identifier for a `member`.
96+
var rewardGuid = "RWD-123"; // string | The unique identifier for a `reward`.
97+
var userGuid = "USR-123"; // string | The unique identifier for a `user`.
98+
99+
var response = client.rewards.readReward(memberGuid, rewardGuid, userGuid);
100+
101+
response.then(function(value) {
102+
console.log(value);
103+
});
104+
```
105+
106+
### Parameters
107+
108+
Name | Type | Description | Notes
109+
------------- | ------------- | ------------- | -------------
110+
**memberGuid** | **string**| The unique identifier for a `member`. |
111+
**rewardGuid** | **string**| The unique identifier for a `reward`. |
112+
**userGuid** | **string**| The unique identifier for a `user`. |
113+
114+
### Return type
115+
116+
[**RewardResponseBody**](RewardResponseBody.md)
117+
118+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
119+

‎docs/RewardsResponseBody.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# RewardsResponseBody
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**rewards** | [**Array<Reward>**](Reward.md) | | [optional]
7+
8+

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "mx-atrium",
3-
"version": "2.9.7",
3+
"version": "2.9.7-beta.0",
44
"description": "NodeJS client for mx-atrium-node",
55
"repository": "mxenabled/mx-atrium-node",
66
"main": "atrium.js",

0 commit comments

Comments
 (0)