masspay_ruby_sdk 1.0.0

data/docs/AttrsRequirement.md

@@ -0,0 +1,36 @@
+# MassPayRubySdk::AttrsRequirement
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | The token that represents the attribute. |  |
+| **attr_set_token** | **String** | The token that represents the stored attributes for this payer. You would use this token in attr_set_token of `initiatePayout` if you have to specify an account number when paying a transaction out. | [optional] |
+| **label** | **String** | The label that describes that required attribute | [optional] |
+| **validation** | **String** | RegEx that validates that input | [optional] |
+| **is_optional** | **Boolean** | Flag to indicate whether this field is required or not | [optional] |
+| **value** | **String** | The existing value that is stored. 'Null' if no existing value is stored. |  |
+| **expected_value** | **String** | Written explanation of the value that the regex validation requires | [optional] |
+| **type** | **String** | The type of attribute | [optional] |
+| **input_type** | **String** | The type of input field that is suggested for this this attribute | [default to 'text'] |
+| **last_attr_value_used** | **Boolean** | If set to true, it means this was the last value that was used and if no attr_set_token is provided to init payout, this value will be used by default | [optional] |
+
+## Example
+
+```ruby
+require 'masspay_ruby_sdk'
+
+instance = MassPayRubySdk::AttrsRequirement.new(
+  token: attr_e2ca24e9-c546-4c64-90d2-cb8e70e7c9ba,
+  attr_set_token: attr_set_e2ca24e9-c546-4c64-90d2-cb8e70e7c9ba,
+  label: Checking Account Number,
+  validation: [0-9]{50},
+  is_optional: true,
+  value: 432532532,
+  expected_value: Date format MM/DD/YYYY,
+  type: BankAccountNumber,
+  input_type: text,
+  last_attr_value_used: null
+)
+```
+

data/docs/AutopayResp.md

@@ -0,0 +1,22 @@
+# MassPayRubySdk::AutopayResp
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | Autopay token |  |
+| **destination_token** | **String** | The destination_token to autopay (send payout to) |  |
+| **percentage** | **Float** | The percent of incoming load that should be autopaid to the destination_token | [default to 100] |
+
+## Example
+
+```ruby
+require 'masspay_ruby_sdk'
+
+instance = MassPayRubySdk::AutopayResp.new(
+  token: autopay_3684cc43-fe3b-4994-8ca1-7dc0db94430f,
+  destination_token: dest_d2138fd0-00be-45a8-985f-4f5bde500962,
+  percentage: 50
+)
+```
+

data/docs/AutopayRule.md

@@ -0,0 +1,20 @@
+# MassPayRubySdk::AutopayRule
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **destination_token** | **String** | The destination_token to autopay (send payout to) |  |
+| **percentage** | **Float** | The percent of incoming load that should be autopaid to the destination_token | [default to 100] |
+
+## Example
+
+```ruby
+require 'masspay_ruby_sdk'
+
+instance = MassPayRubySdk::AutopayRule.new(
+  destination_token: dest_d2138fd0-00be-45a8-985f-4f5bde500962,
+  percentage: 50
+)
+```
+

data/docs/AvailableBalanceTxnResp.md

@@ -0,0 +1,22 @@
+# MassPayRubySdk::AvailableBalanceTxnResp
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | Token representing your funding account. You should use this as source_token when paying out transactions. |  |
+| **balance** | **Float** | Your account's current available balance in USD |  |
+| **currency_code** | **String** | The currency the balance is stored in. Using [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format. In most cases this value will be USD |  |
+
+## Example
+
+```ruby
+require 'masspay_ruby_sdk'
+
+instance = MassPayRubySdk::AvailableBalanceTxnResp.new(
+  token: 8bb3693f-2f98-43dd-a990-615b6a21596d,
+  balance: 100.5,
+  currency_code: USD
+)
+```
+

data/docs/CardApi.md

@@ -0,0 +1,160 @@
+# MassPayRubySdk::CardApi
+
+All URIs are relative to *https://api.masspay.io/v0.1.4*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_wallet_card_info**](CardApi.md#get_wallet_card_info) | **GET** /wallet/{user_token}/{wallet_token}/card | Get MassPay Card Information |
+| [**update_wallet_card_info**](CardApi.md#update_wallet_card_info) | **PUT** /wallet/{user_token}/{wallet_token}/card | Update MassPay Card Information |
+
+
+## get_wallet_card_info
+
+> <GetWalletCardInfo200Response> get_wallet_card_info(user_token, wallet_token)
+
+Get MassPay Card Information
+
+This **GET** endpoint is used to retrieve MassPay card information associated with the provided wallet token. <br> You can use this endpoint to obtain information about the MassPay card associated with the wallet. <br> To use this endpoint, you need to provide the `user_token` and `wallet_token` as required parameters in the URL Path. <br> The response will include a JSON object containing details for the MassPay card, including the card number, balance, status.
+
+### Examples
+
+```ruby
+require 'time'
+require 'masspay_ruby_sdk'
+# setup authorization
+MassPayRubySdk.configure do |config|
+  # Configure API key authorization: AUTHORIZER_NAME
+  config.api_key['AUTHORIZER_NAME'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['AUTHORIZER_NAME'] = 'Bearer'
+end
+
+api_instance = MassPayRubySdk::CardApi.new
+user_token = 'usr_62727c1f-38a3-4a98-b7c9-e84093a106cd' # String | Token representing the user who owns the wallet
+wallet_token = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Token representing the wallet
+
+begin
+  # Get MassPay Card Information
+  result = api_instance.get_wallet_card_info(user_token, wallet_token)
+  p result
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling CardApi->get_wallet_card_info: #{e}"
+end
+```
+
+#### Using the get_wallet_card_info_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetWalletCardInfo200Response>, Integer, Hash)> get_wallet_card_info_with_http_info(user_token, wallet_token)
+
+```ruby
+begin
+  # Get MassPay Card Information
+  data, status_code, headers = api_instance.get_wallet_card_info_with_http_info(user_token, wallet_token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetWalletCardInfo200Response>
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling CardApi->get_wallet_card_info_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_token** | **String** | Token representing the user who owns the wallet |  |
+| **wallet_token** | **String** | Token representing the wallet |  |
+
+### Return type
+
+[**GetWalletCardInfo200Response**](GetWalletCardInfo200Response.md)
+
+### Authorization
+
+[AUTHORIZER_NAME](../README.md#AUTHORIZER_NAME)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_wallet_card_info
+
+> update_wallet_card_info(user_token, wallet_token, opts)
+
+Update MassPay Card Information
+
+This **PUT** endpoint is used to update the MassPay card information for a provided user token and wallet token. <br> You can use this endpoint to help your users manage their MassPay card information, including updating their card PIN number or status. <br> To use this endpoint, you need to provide the `user_token` and `wallet_token` as parameters in the URL Path, along with the parameters in the request Query, including the card pin number or(and) status. <br> The endpoint will then update the card information for the provided user and wallet token.
+
+### Examples
+
+```ruby
+require 'time'
+require 'masspay_ruby_sdk'
+# setup authorization
+MassPayRubySdk.configure do |config|
+  # Configure API key authorization: AUTHORIZER_NAME
+  config.api_key['AUTHORIZER_NAME'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['AUTHORIZER_NAME'] = 'Bearer'
+end
+
+api_instance = MassPayRubySdk::CardApi.new
+user_token = 'usr_62727c1f-38a3-4a98-b7c9-e84093a106cd' # String | Token representing the user who owns the wallet
+wallet_token = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Token representing the wallet
+opts = {
+  pin: '0123', # String | New 4 digit pin number for the card (To be used in ATM machines)
+  status: 'SUSPEND' # String | New status for the card
+}
+
+begin
+  # Update MassPay Card Information
+  api_instance.update_wallet_card_info(user_token, wallet_token, opts)
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling CardApi->update_wallet_card_info: #{e}"
+end
+```
+
+#### Using the update_wallet_card_info_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> update_wallet_card_info_with_http_info(user_token, wallet_token, opts)
+
+```ruby
+begin
+  # Update MassPay Card Information
+  data, status_code, headers = api_instance.update_wallet_card_info_with_http_info(user_token, wallet_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling CardApi->update_wallet_card_info_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_token** | **String** | Token representing the user who owns the wallet |  |
+| **wallet_token** | **String** | Token representing the wallet |  |
+| **pin** | **String** | New 4 digit pin number for the card (To be used in ATM machines) | [optional] |
+| **status** | **String** | New status for the card | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[AUTHORIZER_NAME](../README.md#AUTHORIZER_NAME)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+