mx-platform-ruby 0.37.0 → 0.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e61ce34a55ed0d664c22683e962fdebae5358f36b39fbf36c48a5baa349ccb9
-  data.tar.gz: 0d446a827078ea5746c151491f67e073bcab1fa8aea5be6aae220ec28472d80b
+  metadata.gz: 6bf2ee8d33a12c9e3ef9030d7bebbfbb9963c273fcf9d507f939cc9cb1d578c4
+  data.tar.gz: 4e8219c3e0c723031723e8481f90c9ab07cc827c740b9de2dc449308a91ec5aa
 SHA512:
-  metadata.gz: 4b8e7e314ac2711dd14c64b57167b2168f7d041bf4f49133c090611a34c0636a29409052a36aa0be520508c6fb1390d7e82244c451d5ca72f6ab7435c1998b57
-  data.tar.gz: 61279a900e222a7ed1a0ee5198e7c4b6708f62657c8c29fa9a3bc605ae888a143cc851acc2f1004c5d5bb4a4b8839312a7313f62327670d6aa26332ac575cfc0
+  metadata.gz: 58212249d179d7367a5d399a03447d07e15f925481a1ba083cc9e6748fc577d00e56ea1199779acc40df7cea8db095ff9c7c5e9906fbec1fb13603b3c2f3aade
+  data.tar.gz: 332d28ca5c156163a905825530ad858190cb4f34938001bfc3eda614e0da8ef0cda65be434e03883c3f76769afb8b87a274391a7204a653c9a8d6f780d0783c9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mx-platform-ruby (0.37.0)
+    mx-platform-ruby (0.38.0)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart
 
@@ -24,7 +24,7 @@ GEM
     method_source (1.1.0)
     multipart-post (2.4.1)
     parallel (1.24.0)
-    parser (3.3.4.0)
+    parser (3.3.4.2)
       ast (~> 2.4.1)
       racc
     pry (0.13.1)
@@ -35,7 +35,7 @@ GEM
       pry (~> 0.13.0)
     psych (5.1.2)
       stringio
-    racc (1.8.0)
+    racc (1.8.1)
     rainbow (3.1.1)
     rake (13.0.6)
     rspec (3.13.0)

data/docs/CreditCardProduct.md

@@ -0,0 +1,44 @@
+# MxPlatformRuby::CreditCardProduct
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **annual_fee** | **Object** |  | [optional] |
+| **duration_of_introductory_rate_on_balance_transfer** | **Object** |  | [optional] |
+| **duration_of_introductory_rate_on_purchases** | **Object** |  | [optional] |
+| **guid** | **Object** |  | [optional] |
+| **has_cashback_rewards** | **Boolean** |  | [optional] |
+| **has_other_rewards** | **Boolean** |  | [optional] |
+| **has_travel_rewards** | **Boolean** |  | [optional] |
+| **has_zero_introductory_annual_fee** | **Boolean** |  | [optional] |
+| **has_zero_percent_introductory_rate** | **Boolean** |  | [optional] |
+| **has_zero_percent_introductory_rate_on_balance_transfer** | **Boolean** |  | [optional] |
+| **financial_institution** | **Boolean** |  | [optional] |
+| **is_accepting_applications** | **Boolean** |  | [optional] |
+| **is_small_business_card** | **Boolean** |  | [optional] |
+| **name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::CreditCardProduct.new(
+  annual_fee: 45.0,
+  duration_of_introductory_rate_on_balance_transfer: null,
+  duration_of_introductory_rate_on_purchases: null,
+  guid: CCA-b5bcd822-6d01-4e23-b8d6-846a225e714a,
+  has_cashback_rewards: false,
+  has_other_rewards: true,
+  has_travel_rewards: true,
+  has_zero_introductory_annual_fee: true,
+  has_zero_percent_introductory_rate: false,
+  has_zero_percent_introductory_rate_on_balance_transfer: true,
+  financial_institution: true,
+  is_accepting_applications: true,
+  is_small_business_card: true,
+  name: Chase Credit Card
+)
+```
+

data/docs/CreditCardProductResponse.md

@@ -0,0 +1,18 @@
+# MxPlatformRuby::CreditCardProductResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **reward** | [**CreditCardProduct**](CreditCardProduct.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::CreditCardProductResponse.new(
+  reward: null
+)
+```
+

data/docs/MxPlatformApi.md

@@ -16,6 +16,7 @@ All URIs are relative to *https://api.mx.com*
 | [**create_tagging**](MxPlatformApi.md#create_tagging) | **POST** /users/{user_guid}/taggings | Create tagging |
 | [**create_transaction_rule**](MxPlatformApi.md#create_transaction_rule) | **POST** /users/{user_guid}/transaction_rules | Create transaction rule |
 | [**create_user**](MxPlatformApi.md#create_user) | **POST** /users | Create user |
+| [**credit_card**](MxPlatformApi.md#credit_card) | **GET** /credit_card_products/{credit_card_product_guid} | Read a Credit Card Product |
 | [**delete_category**](MxPlatformApi.md#delete_category) | **DELETE** /users/{user_guid}/categories/{category_guid} | Delete category |
 | [**delete_managed_account**](MxPlatformApi.md#delete_managed_account) | **DELETE** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid} | Delete managed account |
 | [**delete_managed_member**](MxPlatformApi.md#delete_managed_member) | **DELETE** /users/{user_guid}/managed_members/{member_guid} | Delete managed member |
@@ -31,6 +32,7 @@ All URIs are relative to *https://api.mx.com*
 | [**download_tax_document**](MxPlatformApi.md#download_tax_document) | **GET** /users/{user_guid}/members/{member_guid}/tax_documents/{tax_document_guid}.pdf | Download a Tax Document PDF |
 | [**enhance_transactions**](MxPlatformApi.md#enhance_transactions) | **POST** /transactions/enhance | Enhance transactions |
 | [**extend_history**](MxPlatformApi.md#extend_history) | **POST** /users/{user_guid}/members/{member_guid}/extend_history | Extend history |
+| [**fetch_rewards**](MxPlatformApi.md#fetch_rewards) | **POST** /users/{user_guid}/members/{member_guid}/fetch_rewards | Fetch Rewards |
 | [**fetch_statements**](MxPlatformApi.md#fetch_statements) | **POST** /users/{user_guid}/members/{member_guid}/fetch_statements | Fetch statements |
 | [**fetch_tax_documents**](MxPlatformApi.md#fetch_tax_documents) | **POST** /users/{user_guid}/members/{member_guid}/fetch_tax_documents | Fetch Tax Documents |
 | [**identify_member**](MxPlatformApi.md#identify_member) | **POST** /users/{user_guid}/members/{member_guid}/identify | Identify member |
@@ -55,6 +57,7 @@ All URIs are relative to *https://api.mx.com*
 | [**list_member_credentials**](MxPlatformApi.md#list_member_credentials) | **GET** /users/{user_guid}/members/{member_guid}/credentials | List member credentials |
 | [**list_members**](MxPlatformApi.md#list_members) | **GET** /users/{user_guid}/members | List members |
 | [**list_merchants**](MxPlatformApi.md#list_merchants) | **GET** /merchants | List merchants |
+| [**list_rewards**](MxPlatformApi.md#list_rewards) | **GET** /users/{user_guid}/members/{member_guid}/rewards | List Rewards |
 | [**list_statements_by_member**](MxPlatformApi.md#list_statements_by_member) | **GET** /users/{user_guid}/members/{member_guid}/statements | List statements by member |
 | [**list_taggings**](MxPlatformApi.md#list_taggings) | **GET** /users/{user_guid}/taggings | List taggings |
 | [**list_tags**](MxPlatformApi.md#list_tags) | **GET** /users/{user_guid}/tags | List tags |
@@ -79,6 +82,7 @@ All URIs are relative to *https://api.mx.com*
 | [**read_member_status**](MxPlatformApi.md#read_member_status) | **GET** /users/{user_guid}/members/{member_guid}/status | Read member status |
 | [**read_merchant**](MxPlatformApi.md#read_merchant) | **GET** /merchants/{merchant_guid} | Read merchant |
 | [**read_merchant_location**](MxPlatformApi.md#read_merchant_location) | **GET** /merchant_locations/{merchant_location_guid} | Read merchant location |
+| [**read_rewards**](MxPlatformApi.md#read_rewards) | **GET** /users/{user_guid}/members/{member_guid}/rewards/{reward_guid} | Read Reward |
 | [**read_statement_by_member**](MxPlatformApi.md#read_statement_by_member) | **GET** /users/{user_guid}/members/{member_guid}/statements/{statement_guid} | Read statement by member |
 | [**read_tag**](MxPlatformApi.md#read_tag) | **GET** /users/{user_guid}/tags/{tag_guid} | Read tag |
 | [**read_tagging**](MxPlatformApi.md#read_tagging) | **GET** /users/{user_guid}/taggings/{tagging_guid} | Read tagging |
@@ -973,6 +977,76 @@ end
 - **Accept**: application/vnd.mx.api.v1+json
 
 
+## credit_card
+
+> <CreditCardProductResponse> credit_card(credit_card_product_guid)
+
+Read a Credit Card Product
+
+This endpoint returns the specified `credit_card_product` according to the unique GUID.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mx-platform-ruby'
+# setup authorization
+MxPlatformRuby.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MxPlatformRuby::MxPlatformApi.new
+credit_card_product_guid = 'credit_card_product_guid' # String | The required `credit_card_product_guid` can be found on the `account` object.
+
+begin
+  # Read a Credit Card Product
+  result = api_instance.credit_card(credit_card_product_guid)
+  p result
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->credit_card: #{e}"
+end
+```
+
+#### Using the credit_card_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreditCardProductResponse>, Integer, Hash)> credit_card_with_http_info(credit_card_product_guid)
+
+```ruby
+begin
+  # Read a Credit Card Product
+  data, status_code, headers = api_instance.credit_card_with_http_info(credit_card_product_guid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreditCardProductResponse>
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->credit_card_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **credit_card_product_guid** | **String** | The required &#x60;credit_card_product_guid&#x60; can be found on the &#x60;account&#x60; object. |  |
+
+### Return type
+
+[**CreditCardProductResponse**](CreditCardProductResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.mx.api.v1+json
+
+
 ## delete_category
 
 > delete_category(category_guid, user_guid)
@@ -2047,6 +2121,78 @@ end
 - **Accept**: application/vnd.mx.api.v1+json
 
 
+## fetch_rewards
+
+> <MemberResponseBody> fetch_rewards(user_guid, member_guid)
+
+Fetch Rewards
+
+Calling this endpoint initiates an aggregation-type event which will gather the member's rewards information, as well as account and transaction information. Rewards data is also gathered with daily background aggregations.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mx-platform-ruby'
+# setup authorization
+MxPlatformRuby.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MxPlatformRuby::MxPlatformApi.new
+user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
+member_guid = 'MBR-fa7537f3-48aa-a683-a02a-b18345562f54' # String | The unique identifier for the member. Defined by MX.
+
+begin
+  # Fetch Rewards
+  result = api_instance.fetch_rewards(user_guid, member_guid)
+  p result
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->fetch_rewards: #{e}"
+end
+```
+
+#### Using the fetch_rewards_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MemberResponseBody>, Integer, Hash)> fetch_rewards_with_http_info(user_guid, member_guid)
+
+```ruby
+begin
+  # Fetch Rewards
+  data, status_code, headers = api_instance.fetch_rewards_with_http_info(user_guid, member_guid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MemberResponseBody>
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->fetch_rewards_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_guid** | **String** | The unique id for a &#x60;user&#x60;. |  |
+| **member_guid** | **String** | The unique identifier for the member. Defined by MX. |  |
+
+### Return type
+
+[**MemberResponseBody**](MemberResponseBody.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.mx.api.v1+json
+
+
 ## fetch_statements
 
 > <MemberResponseBody> fetch_statements(member_guid, user_guid)
@@ -3895,6 +4041,78 @@ end
 - **Accept**: application/vnd.mx.api.v1+json
 
 
+## list_rewards
+
+> <RewardsResponseBody> list_rewards(user_guid, member_guid)
+
+List Rewards
+
+Use this endpoint to list all the `rewards` associated with a specified `member`.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mx-platform-ruby'
+# setup authorization
+MxPlatformRuby.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MxPlatformRuby::MxPlatformApi.new
+user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
+member_guid = 'MBR-fa7537f3-48aa-a683-a02a-b18345562f54' # String | The unique identifier for the member. Defined by MX.
+
+begin
+  # List Rewards
+  result = api_instance.list_rewards(user_guid, member_guid)
+  p result
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->list_rewards: #{e}"
+end
+```
+
+#### Using the list_rewards_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RewardsResponseBody>, Integer, Hash)> list_rewards_with_http_info(user_guid, member_guid)
+
+```ruby
+begin
+  # List Rewards
+  data, status_code, headers = api_instance.list_rewards_with_http_info(user_guid, member_guid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RewardsResponseBody>
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->list_rewards_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_guid** | **String** | The unique id for a &#x60;user&#x60;. |  |
+| **member_guid** | **String** | The unique identifier for the member. Defined by MX. |  |
+
+### Return type
+
+[**RewardsResponseBody**](RewardsResponseBody.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.mx.api.v1+json
+
+
 ## list_statements_by_member
 
 > <StatementsResponseBody> list_statements_by_member(member_guid, user_guid, opts)
@@ -5701,6 +5919,80 @@ end
 - **Accept**: application/vnd.mx.api.v1+json
 
 
+## read_rewards
+
+> <RewardResponseBody> read_rewards(user_guid, member_guid, reward_guid)
+
+Read Reward
+
+Use this endpoint to read a specific `reward` based on its unique GUID..
+
+### Examples
+
+```ruby
+require 'time'
+require 'mx-platform-ruby'
+# setup authorization
+MxPlatformRuby.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MxPlatformRuby::MxPlatformApi.new
+user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
+member_guid = 'MBR-fa7537f3-48aa-a683-a02a-b18345562f54' # String | The unique identifier for the member. Defined by MX.
+reward_guid = 'RWD-fa7537f3-48aa-a683-a02a-b324322f54' # String | The unique identifier for the rewards. Defined by MX.
+
+begin
+  # Read Reward
+  result = api_instance.read_rewards(user_guid, member_guid, reward_guid)
+  p result
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->read_rewards: #{e}"
+end
+```
+
+#### Using the read_rewards_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RewardResponseBody>, Integer, Hash)> read_rewards_with_http_info(user_guid, member_guid, reward_guid)
+
+```ruby
+begin
+  # Read Reward
+  data, status_code, headers = api_instance.read_rewards_with_http_info(user_guid, member_guid, reward_guid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RewardResponseBody>
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->read_rewards_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_guid** | **String** | The unique id for a &#x60;user&#x60;. |  |
+| **member_guid** | **String** | The unique identifier for the member. Defined by MX. |  |
+| **reward_guid** | **String** | The unique identifier for the rewards. Defined by MX. |  |
+
+### Return type
+
+[**RewardResponseBody**](RewardResponseBody.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.mx.api.v1+json
+
+
 ## read_statement_by_member
 
 > <StatementResponseBody> read_statement_by_member(member_guid, statement_guid, user_guid)

data/docs/RewardResponse.md

@@ -0,0 +1,36 @@
+# MxPlatformRuby::RewardResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_guid** | **String** |  | [optional] |
+| **balance_type** | **String** |  | [optional] |
+| **balance** | **Integer** |  | [optional] |
+| **created_at** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **expires_on** | **String** |  | [optional] |
+| **guid** | **String** |  | [optional] |
+| **member_guid** | **String** |  | [optional] |
+| **unit_type** | **String** |  | [optional] |
+| **user_guid** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::RewardResponse.new(
+  account_guid: ACT-1234,
+  balance_type: EXPIRING_BALANCE,
+  balance: 102,
+  created_at: 2020-01-28T21:09:01+0000,
+  description: A description of the reward.,
+  expires_on: 2020-02-28,
+  guid: RWD-1234,
+  member_guid: MBR-4567,
+  unit_type: POINTS,
+  user_guid: USR-1234
+)
+```
+

data/docs/RewardResponseBody.md

@@ -0,0 +1,18 @@
+# MxPlatformRuby::RewardResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **reward** | [**RewardResponse**](RewardResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::RewardResponseBody.new(
+  reward: null
+)
+```
+

data/docs/RewardsResponse.md

@@ -0,0 +1,36 @@
+# MxPlatformRuby::RewardsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_guid** | **String** |  | [optional] |
+| **balance_type** | **String** |  | [optional] |
+| **balance** | **Integer** |  | [optional] |
+| **created_at** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **expires_on** | **String** |  | [optional] |
+| **guid** | **String** |  | [optional] |
+| **member_guid** | **String** |  | [optional] |
+| **unit_type** | **String** |  | [optional] |
+| **user_guid** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::RewardsResponse.new(
+  account_guid: ACT-1234,
+  balance_type: EXPIRING_BALANCE,
+  balance: 102,
+  created_at: 2020-01-28T21:09:01+0000,
+  description: A description of the reward.,
+  expires_on: 2020-02-28,
+  guid: RWD-1234,
+  member_guid: MBR-4567,
+  unit_type: POINTS,
+  user_guid: USR-1234
+)
+```
+

data/docs/RewardsResponseBody.md

@@ -0,0 +1,20 @@
+# MxPlatformRuby::RewardsResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **rewards** | [**Array<RewardsResponse>**](RewardsResponse.md) |  | [optional] |
+| **pagination** | [**PaginationResponse**](PaginationResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::RewardsResponseBody.new(
+  rewards: null,
+  pagination: null
+)
+```
+