masspay_ruby_sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b6a9546ea765d92fd6152037cafacd6126ed8a13867fea49bed5f19a6c18d614
+  data.tar.gz: 8c843b6d6bbbff4d53486f9173f1f26fefe42569742077d8b91c3bb63c218f28
+SHA512:
+  metadata.gz: aa9b2ad6093a093a6cdc8f0072a058b1017cde4a7416e1e5a29b0a75d4aabf78b22300c1cc08b3687d6af4b29793fda6ccf9a9aa9d723fccd388ff932c56c44b
+  data.tar.gz: 90c7318ec73feaa01bd585b9681f1037d911470ad256838415415540dd10daaaf331b3717ed7cb97f18e2d2403592fa7d98e49d1e1c08b16a9fbc723422616e0

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## 1.0.0 (2023-11-15)
+
+
+### Features
+
+* update SDK according to newest OAS ([84af46c](https://github.com/masspayio/masspay-ruby-sdk/commit/84af46ca1fcf247048e50f6df170cd86f4594184))

data/CONTRIBUTING.md

@@ -0,0 +1,13 @@
+# Contributing
+
+## Release new version
+
+All commit messages have to be in the format of the [conventionalcommits.org](https://conventionalcommits.org) specification.
+
+1. Make sure your are on the `main` branch.
+2. Make sure you have committed everything and your code is working.
+3. Run `npx standard-version`
+4. Push your changes to the repository and the `main` branch.
+5. The Github Action will automatically release a new version to rubygems.org (https://rubygems.org/gems/masspay_ruby_sdk).
+
+For more detailed instructions read [standard-version documentation](https://github.com/conventional-changelog/standard-version).

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,197 @@
+<img src="./docs/logo.webp" width="200" />
+
+# masspay_ruby_sdk ![Gem](https://img.shields.io/gem/v/masspay_ruby_sdk) ![Ruby](https://img.shields.io/badge/ruby->=%202.7-blue)
+
+MassPayRubySdk - the Ruby gem for the MassPay API
+
+MassPay API
+
+- API version: 0.1.4
+- Package version: 1.0.0
+
+For more information, please visit [https://www.masspay.io](https://www.masspay.io)
+
+## Installation
+
+### Bundler
+
+```shell
+bundle add masspay_ruby_sdk
+```
+
+### Global Installation
+
+```shell
+gem install masspay_ruby_sdk
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+### Ruby
+
+```ruby
+# Load the gem
+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::AccountApi.new
+
+begin
+  #Get current available balance
+  result = api_instance.get_account_balance
+  p result
+rescue MassPayRubySdk::ApiError => e
+  puts "Exception when calling AccountApi->get_account_balance: #{e}"
+end
+
+```
+
+### Rails
+
+Create a file `config/initializers/masspay_ruby_sdk.rb` with the following content:
+
+```ruby
+
+# 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
+```
+
+Then call the API:
+
+```ruby
+api_instance = MassPayRubySdk::AccountApi.new
+
+begin
+  #Get current available balance
+  result = api_instance.get_account_balance
+  p result
+rescue MassPayRubySdk::ApiError => e
+  puts "Exception when calling AccountApi->get_account_balance: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.masspay.io/v0.1.4*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*MassPayRubySdk::AccountApi* | [**get_account_balance**](docs/AccountApi.md#get_account_balance) | **GET** /account/balance | Get current available balance
+*MassPayRubySdk::AccountApi* | [**get_account_statement**](docs/AccountApi.md#get_account_statement) | **GET** /account/statement | Get certified account statement
+*MassPayRubySdk::AttributeApi* | [**get_attrs**](docs/AttributeApi.md#get_attrs) | **GET** /attribute/{user_token}/{destination_token}/{currency} | Get user attributes for destination_token
+*MassPayRubySdk::AttributeApi* | [**store_attrs**](docs/AttributeApi.md#store_attrs) | **POST** /attribute/{user_token}/{destination_token}/{currency} | Store user attributes
+*MassPayRubySdk::CardApi* | [**get_wallet_card_info**](docs/CardApi.md#get_wallet_card_info) | **GET** /wallet/{user_token}/{wallet_token}/card | Get MassPay Card Information
+*MassPayRubySdk::CardApi* | [**update_wallet_card_info**](docs/CardApi.md#update_wallet_card_info) | **PUT** /wallet/{user_token}/{wallet_token}/card | Update MassPay Card Information
+*MassPayRubySdk::CatalogApi* | [**get_cheapest_country_services**](docs/CatalogApi.md#get_cheapest_country_services) | **GET** /country/{country_code}/cheapest | Gets a list of Companies and their cheapest service offerings for the given country code.
+*MassPayRubySdk::CatalogApi* | [**get_country_list**](docs/CatalogApi.md#get_country_list) | **GET** /country/list | Gets a list of countries where services offered.
+*MassPayRubySdk::CatalogApi* | [**get_country_services**](docs/CatalogApi.md#get_country_services) | **GET** /country/{country_code} | Gets a list of Companies and their service offerings for the given country code.
+*MassPayRubySdk::CatalogApi* | [**get_destination_token_alternatives**](docs/CatalogApi.md#get_destination_token_alternatives) | **GET** /service/{destination_token}/alternatives | Returns list of alternative service to a provided service
+*MassPayRubySdk::CatalogApi* | [**get_user_agreement**](docs/CatalogApi.md#get_user_agreement) | **GET** /user-agreements | Get User Agreement
+*MassPayRubySdk::CatalogApi* | [**get_user_agreements_names**](docs/CatalogApi.md#get_user_agreements_names) | **OPTIONS** /user-agreements | Get Available User Agreements
+*MassPayRubySdk::KYCApi* | [**find_attributes_velocity**](docs/KYCApi.md#find_attributes_velocity) | **POST** /attribute/{user_token}/velocity | Attributes velocity check
+*MassPayRubySdk::KYCApi* | [**get_user_user_token_kyc_au10tix**](docs/KYCApi.md#get_user_user_token_kyc_au10tix) | **GET** /user/{user_token}/kyc/au10tix | Get an Au10tix session link
+*MassPayRubySdk::KYCApi* | [**get_user_user_token_kyc_veriff**](docs/KYCApi.md#get_user_user_token_kyc_veriff) | **GET** /user/{user_token}/kyc/veriff | Get a Veriff session link
+*MassPayRubySdk::KYCApi* | [**upload_id_photos**](docs/KYCApi.md#upload_id_photos) | **POST** /user/{user_token}/kyc/id | Upload ID Photos
+*MassPayRubySdk::LoadApi* | [**cancel_user_load**](docs/LoadApi.md#cancel_user_load) | **DELETE** /load/{user_token} | Reverse a user load
+*MassPayRubySdk::LoadApi* | [**create_autopay_rule**](docs/LoadApi.md#create_autopay_rule) | **POST** /wallet/{user_token}/{wallet_token}/autopay | Add autopay rule
+*MassPayRubySdk::LoadApi* | [**delete_autopay_rule**](docs/LoadApi.md#delete_autopay_rule) | **DELETE** /wallet/{user_token}/{wallet_token}/autopay | Delete autopay rule
+*MassPayRubySdk::LoadApi* | [**get_autopay_rules**](docs/LoadApi.md#get_autopay_rules) | **GET** /wallet/{user_token}/{wallet_token}/autopay | Get all autopay rules
+*MassPayRubySdk::LoadApi* | [**get_user_loads_by_token**](docs/LoadApi.md#get_user_loads_by_token) | **GET** /load/{user_token} | Get history of loads by user token
+*MassPayRubySdk::LoadApi* | [**load_user**](docs/LoadApi.md#load_user) | **POST** /load/{user_token} | Initiate a load transaction
+*MassPayRubySdk::LoadApi* | [**load_user_token_put**](docs/LoadApi.md#load_user_token_put) | **PUT** /load/{user_token} | Resend Load Notification
+*MassPayRubySdk::LoadApi* | [**resend_balance_notification**](docs/LoadApi.md#resend_balance_notification) | **PUT** /wallet/{user_token} | Resend Balance Notification
+*MassPayRubySdk::PayoutApi* | [**commit_payout_txn**](docs/PayoutApi.md#commit_payout_txn) | **PUT** /payout/{user_token}/{payout_token} | Commit payout transaction
+*MassPayRubySdk::PayoutApi* | [**get_payout_status**](docs/PayoutApi.md#get_payout_status) | **GET** /payout/{user_token}/{payout_token} | Get status of a payout by payout token
+*MassPayRubySdk::PayoutApi* | [**get_transaction_confirmation_details**](docs/PayoutApi.md#get_transaction_confirmation_details) | **PATCH** /payout/{user_token}/{payout_token} | Get transaction confirmation details
+*MassPayRubySdk::PayoutApi* | [**get_user_payouts_by_token**](docs/PayoutApi.md#get_user_payouts_by_token) | **GET** /payout/{user_token} | Get history of payouts by user token
+*MassPayRubySdk::PayoutApi* | [**initiate_payout**](docs/PayoutApi.md#initiate_payout) | **POST** /payout/{user_token} | Initiate a payout transaction
+*MassPayRubySdk::SpendBackApi* | [**get_user_spendbacks_by_token**](docs/SpendBackApi.md#get_user_spendbacks_by_token) | **GET** /spendback/{user_token} | Get history of spend backs by user token
+*MassPayRubySdk::SpendBackApi* | [**initiate_spendback**](docs/SpendBackApi.md#initiate_spendback) | **POST** /spendback/{user_token} | Initiate a spend back transaction
+*MassPayRubySdk::TaxApi* | [**get_tax_users**](docs/TaxApi.md#get_tax_users) | **GET** /tax | Get List Of Users Annual Balance
+*MassPayRubySdk::UserApi* | [**create_user**](docs/UserApi.md#create_user) | **POST** /user | Create a user
+*MassPayRubySdk::UserApi* | [**get_user_by_token**](docs/UserApi.md#get_user_by_token) | **GET** /user/{user_token} | Get user by user token
+*MassPayRubySdk::UserApi* | [**get_user_history**](docs/UserApi.md#get_user_history) | **GET** /user/{user_token}/history | Transactions history
+*MassPayRubySdk::UserApi* | [**update_user**](docs/UserApi.md#update_user) | **PUT** /user/{user_token} | Updated user
+*MassPayRubySdk::UserApi* | [**user_lookup**](docs/UserApi.md#user_lookup) | **GET** /user/lookup | Lookup an existing user
+*MassPayRubySdk::WalletApi* | [**create_autopay_rule**](docs/WalletApi.md#create_autopay_rule) | **POST** /wallet/{user_token}/{wallet_token}/autopay | Add autopay rule
+*MassPayRubySdk::WalletApi* | [**delete_autopay_rule**](docs/WalletApi.md#delete_autopay_rule) | **DELETE** /wallet/{user_token}/{wallet_token}/autopay | Delete autopay rule
+*MassPayRubySdk::WalletApi* | [**get_autopay_rules**](docs/WalletApi.md#get_autopay_rules) | **GET** /wallet/{user_token}/{wallet_token}/autopay | Get all autopay rules
+*MassPayRubySdk::WalletApi* | [**get_wallet**](docs/WalletApi.md#get_wallet) | **GET** /wallet/{user_token} | Retrieve all available wallets for a user
+*MassPayRubySdk::WalletApi* | [**get_wallet_card_info**](docs/WalletApi.md#get_wallet_card_info) | **GET** /wallet/{user_token}/{wallet_token}/card | Get MassPay Card Information
+*MassPayRubySdk::WalletApi* | [**update_wallet_card_info**](docs/WalletApi.md#update_wallet_card_info) | **PUT** /wallet/{user_token}/{wallet_token}/card | Update MassPay Card Information
+
+
+## Documentation for Models
+
+ - [MassPayRubySdk::ApiResponse](docs/ApiResponse.md)
+ - [MassPayRubySdk::AttrTxn](docs/AttrTxn.md)
+ - [MassPayRubySdk::AttrValue](docs/AttrValue.md)
+ - [MassPayRubySdk::AttrVelocityRequestInner](docs/AttrVelocityRequestInner.md)
+ - [MassPayRubySdk::AttrsRequirement](docs/AttrsRequirement.md)
+ - [MassPayRubySdk::AutopayResp](docs/AutopayResp.md)
+ - [MassPayRubySdk::AutopayRule](docs/AutopayRule.md)
+ - [MassPayRubySdk::AvailableBalanceTxnResp](docs/AvailableBalanceTxnResp.md)
+ - [MassPayRubySdk::CompaniesResp](docs/CompaniesResp.md)
+ - [MassPayRubySdk::Company](docs/Company.md)
+ - [MassPayRubySdk::Country](docs/Country.md)
+ - [MassPayRubySdk::Exception](docs/Exception.md)
+ - [MassPayRubySdk::FoundUser](docs/FoundUser.md)
+ - [MassPayRubySdk::GetAccountStatement200Response](docs/GetAccountStatement200Response.md)
+ - [MassPayRubySdk::GetTransactionConfirmationDetails200Response](docs/GetTransactionConfirmationDetails200Response.md)
+ - [MassPayRubySdk::GetUserAgreement200Response](docs/GetUserAgreement200Response.md)
+ - [MassPayRubySdk::GetUserAgreementsNames200ResponseInner](docs/GetUserAgreementsNames200ResponseInner.md)
+ - [MassPayRubySdk::GetUserUserTokenKycAu10tix200Response](docs/GetUserUserTokenKycAu10tix200Response.md)
+ - [MassPayRubySdk::GetUserUserTokenKycVeriff200Response](docs/GetUserUserTokenKycVeriff200Response.md)
+ - [MassPayRubySdk::GetWalletCardInfo200Response](docs/GetWalletCardInfo200Response.md)
+ - [MassPayRubySdk::IDUpload](docs/IDUpload.md)
+ - [MassPayRubySdk::LoadTxn](docs/LoadTxn.md)
+ - [MassPayRubySdk::LoadTxnResp](docs/LoadTxnResp.md)
+ - [MassPayRubySdk::Loads](docs/Loads.md)
+ - [MassPayRubySdk::PayoutTxn](docs/PayoutTxn.md)
+ - [MassPayRubySdk::PayoutTxnCommitResp](docs/PayoutTxnCommitResp.md)
+ - [MassPayRubySdk::PayoutTxnResp](docs/PayoutTxnResp.md)
+ - [MassPayRubySdk::ResendBalanceNotification200Response](docs/ResendBalanceNotification200Response.md)
+ - [MassPayRubySdk::Service](docs/Service.md)
+ - [MassPayRubySdk::ServicePayersInner](docs/ServicePayersInner.md)
+ - [MassPayRubySdk::ServicePayersInnerExchangeRateInner](docs/ServicePayersInnerExchangeRateInner.md)
+ - [MassPayRubySdk::SpendBackTxn](docs/SpendBackTxn.md)
+ - [MassPayRubySdk::SpendBackTxnResp](docs/SpendBackTxnResp.md)
+ - [MassPayRubySdk::SpendBacks](docs/SpendBacks.md)
+ - [MassPayRubySdk::StoredUser](docs/StoredUser.md)
+ - [MassPayRubySdk::TaxYearUserResp](docs/TaxYearUserResp.md)
+ - [MassPayRubySdk::TxnHistoryResp](docs/TxnHistoryResp.md)
+ - [MassPayRubySdk::UpdateUser](docs/UpdateUser.md)
+ - [MassPayRubySdk::User](docs/User.md)
+ - [MassPayRubySdk::WalletTxnResp](docs/WalletTxnResp.md)
+
+
+## Documentation for Authorization
+
+
+### AUTHORIZER_NAME
+
+
+- **Type**: API key
+- **API key parameter name**: Authorization
+- **Location**: HTTP header
+
+
+## Author
+
+info@masspay.io
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/AccountApi.md

@@ -0,0 +1,150 @@
+# MassPayRubySdk::AccountApi
+
+All URIs are relative to *https://api.masspay.io/v0.1.4*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_account_balance**](AccountApi.md#get_account_balance) | **GET** /account/balance | Get current available balance |
+| [**get_account_statement**](AccountApi.md#get_account_statement) | **GET** /account/statement | Get certified account statement |
+
+
+## get_account_balance
+
+> <Array<AvailableBalanceTxnResp>> get_account_balance
+
+Get current available balance
+
+This **GET** endpoint is used to retrieve the current available balance for the MassPay account. <br> You can use this endpoint to obtain information about the current balance in your account. <br> There are no required parameters needed to access this endpoint. <br> The response will include a JSON objects containing details for the current available balance, including the token, balance and `currency_code`.
+
+### 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::AccountApi.new
+
+begin
+  # Get current available balance
+  result = api_instance.get_account_balance
+  p result
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling AccountApi->get_account_balance: #{e}"
+end
+```
+
+#### Using the get_account_balance_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<AvailableBalanceTxnResp>>, Integer, Hash)> get_account_balance_with_http_info
+
+```ruby
+begin
+  # Get current available balance
+  data, status_code, headers = api_instance.get_account_balance_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<AvailableBalanceTxnResp>>
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling AccountApi->get_account_balance_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;AvailableBalanceTxnResp&gt;**](AvailableBalanceTxnResp.md)
+
+### Authorization
+
+[AUTHORIZER_NAME](../README.md#AUTHORIZER_NAME)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_account_statement
+
+> <GetAccountStatement200Response> get_account_statement(start_date, ending_date)
+
+Get certified account statement
+
+This **GET** endpoint is used to retrieve a certified PDF ledger statement for a provided timeframe. <br> You can use this endpoint to obtain a ledger statement for your MassPay account for a specific time period. <br> To use this endpoint, you need to provide the `start_date` and `ending_date` as required parameters in the Query string of the URL. <br> The response will include a certified PDF ledger statement containing transaction details for the specified timeframe.
+
+### 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::AccountApi.new
+start_date = Date.parse('Fri Jan 01 01:00:00 CET 2021') # Date | Starting date of the statement
+ending_date = Date.parse('Mon Feb 01 01:00:00 CET 2021') # Date | Ending date of the statement (not more than 31 days than `start_date`)
+
+begin
+  # Get certified account statement
+  result = api_instance.get_account_statement(start_date, ending_date)
+  p result
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling AccountApi->get_account_statement: #{e}"
+end
+```
+
+#### Using the get_account_statement_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetAccountStatement200Response>, Integer, Hash)> get_account_statement_with_http_info(start_date, ending_date)
+
+```ruby
+begin
+  # Get certified account statement
+  data, status_code, headers = api_instance.get_account_statement_with_http_info(start_date, ending_date)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetAccountStatement200Response>
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling AccountApi->get_account_statement_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **start_date** | **Date** | Starting date of the statement |  |
+| **ending_date** | **Date** | Ending date of the statement (not more than 31 days than &#x60;start_date&#x60;) |  |
+
+### Return type
+
+[**GetAccountStatement200Response**](GetAccountStatement200Response.md)
+
+### Authorization
+
+[AUTHORIZER_NAME](../README.md#AUTHORIZER_NAME)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ApiResponse.md

@@ -0,0 +1,22 @@
+# MassPayRubySdk::ApiResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **Integer** |  | [optional] |
+| **type** | **String** |  | [optional] |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'masspay_ruby_sdk'
+
+instance = MassPayRubySdk::ApiResponse.new(
+  code: null,
+  type: null,
+  message: null
+)
+```
+

data/docs/AttrTxn.md

@@ -0,0 +1,20 @@
+# MassPayRubySdk::AttrTxn
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **values** | [**Array<AttrValue>**](AttrValue.md) |  |  |
+| **attr_set_token** | **String** | The token that represents a set of attributes for a specific payer. Optional, specify the value if you're trying to update a value of a specific attributes set. | [optional] |
+
+## Example
+
+```ruby
+require 'masspay_ruby_sdk'
+
+instance = MassPayRubySdk::AttrTxn.new(
+  values: null,
+  attr_set_token: attr_set_e2ca24e9-c546-4c64-90d2-cb8e70e7c9ba
+)
+```
+

data/docs/AttrValue.md

@@ -0,0 +1,20 @@
+# MassPayRubySdk::AttrValue
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | The token that represents the attribute that needs to be updated. |  |
+| **value** | **String** | The value that needs to be stored for the associated token |  |
+
+## Example
+
+```ruby
+require 'masspay_ruby_sdk'
+
+instance = MassPayRubySdk::AttrValue.new(
+  token: e2ca24e9-c546-4c64-90d2-cb8e70e7c9ba,
+  value: 432532532
+)
+```
+

data/docs/AttrVelocityRequestInner.md

@@ -0,0 +1,20 @@
+# MassPayRubySdk::AttrVelocityRequestInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The type of attribute to look for |  |
+| **value** | **String** | The value to search for |  |
+
+## Example
+
+```ruby
+require 'masspay_ruby_sdk'
+
+instance = MassPayRubySdk::AttrVelocityRequestInner.new(
+  type: null,
+  value: null
+)
+```
+

data/docs/AttributeApi.md

@@ -0,0 +1,168 @@
+# MassPayRubySdk::AttributeApi
+
+All URIs are relative to *https://api.masspay.io/v0.1.4*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_attrs**](AttributeApi.md#get_attrs) | **GET** /attribute/{user_token}/{destination_token}/{currency} | Get user attributes for destination_token |
+| [**store_attrs**](AttributeApi.md#store_attrs) | **POST** /attribute/{user_token}/{destination_token}/{currency} | Store user attributes |
+
+
+## get_attrs
+
+> <Array<AttrsRequirement>> get_attrs(currency, user_token, destination_token, opts)
+
+Get user attributes for destination_token
+
+This **GET** endpoint is used to retrieve user attributes for a specific destination token. <br> You can use this endpoint to retrieve user attributes and provide personalized service to your users based on their preferences, demographic data, or other relevant information. <br> To use this endpoint, you need to provide the `user_token`, `destination_token`, and currency as parameters in the URL Path. <br> The endpoint will then return all the required attributes for the provided user for the specified destination token. If any of the attributes already have a stored value, it will be returned as well.
+
+### 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::AttributeApi.new
+currency = 'BRL' # String | The destination currency sending funds to. Using [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format. 
+user_token = 'user_token_example' # String | Token representing the user to retrieve attributes for
+destination_token = 'destination_token_example' # String | Token that represents the payout destination i.e. Omnex->Brazil->Bank Deposit->Itau. To be retrieved from the #pricing callback.
+opts = {
+  idempotency_key: 'idempotency_key_example' # String | Unique key to prevent duplicate processing
+}
+
+begin
+  # Get user attributes for destination_token
+  result = api_instance.get_attrs(currency, user_token, destination_token, opts)
+  p result
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling AttributeApi->get_attrs: #{e}"
+end
+```
+
+#### Using the get_attrs_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<AttrsRequirement>>, Integer, Hash)> get_attrs_with_http_info(currency, user_token, destination_token, opts)
+
+```ruby
+begin
+  # Get user attributes for destination_token
+  data, status_code, headers = api_instance.get_attrs_with_http_info(currency, user_token, destination_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<AttrsRequirement>>
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling AttributeApi->get_attrs_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **currency** | **String** | The destination currency sending funds to. Using [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format.  |  |
+| **user_token** | **String** | Token representing the user to retrieve attributes for |  |
+| **destination_token** | **String** | Token that represents the payout destination i.e. Omnex-&gt;Brazil-&gt;Bank Deposit-&gt;Itau. To be retrieved from the #pricing callback. |  |
+| **idempotency_key** | **String** | Unique key to prevent duplicate processing | [optional] |
+
+### Return type
+
+[**Array&lt;AttrsRequirement&gt;**](AttrsRequirement.md)
+
+### Authorization
+
+[AUTHORIZER_NAME](../README.md#AUTHORIZER_NAME)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## store_attrs
+
+> store_attrs(currency, user_token, destination_token, attr_txn, opts)
+
+Store user attributes
+
+This **POST** endpoint is used to store user attributes, allowing you to associate additional data with a user token. <br> To use this endpoint, you need to provide the `user_token`, `destination_token`, and currency as parameters in the URL Path. You also need to provide the attribute values as JSON parameters in the Request body. <br> If existing attributes are already stored for the user, this call will override their values.
+
+### 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::AttributeApi.new
+currency = 'BRL' # String | The destination currency sending funds to. Using [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format. 
+user_token = 'user_token_example' # String | Token representing the user to store attributes for
+destination_token = 'destination_token_example' # String | Token that represents the payout destination i.e. Omnex->Brazil->Bank Deposit->Itau. To be retrieved from the #pricing callback. 
+attr_txn = MassPayRubySdk::AttrTxn.new({values: [MassPayRubySdk::AttrValue.new({token: 'e2ca24e9-c546-4c64-90d2-cb8e70e7c9ba', value: '432532532'})]}) # AttrTxn | Attr parameters to store
+opts = {
+  idempotency_key: 'idempotency_key_example' # String | Unique key to prevent duplicate processing
+}
+
+begin
+  # Store user attributes
+  api_instance.store_attrs(currency, user_token, destination_token, attr_txn, opts)
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling AttributeApi->store_attrs: #{e}"
+end
+```
+
+#### Using the store_attrs_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)> store_attrs_with_http_info(currency, user_token, destination_token, attr_txn, opts)
+
+```ruby
+begin
+  # Store user attributes
+  data, status_code, headers = api_instance.store_attrs_with_http_info(currency, user_token, destination_token, attr_txn, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling AttributeApi->store_attrs_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **currency** | **String** | The destination currency sending funds to. Using [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format.  |  |
+| **user_token** | **String** | Token representing the user to store attributes for |  |
+| **destination_token** | **String** | Token that represents the payout destination i.e. Omnex-&gt;Brazil-&gt;Bank Deposit-&gt;Itau. To be retrieved from the #pricing callback.  |  |
+| **attr_txn** | [**AttrTxn**](AttrTxn.md) | Attr parameters to store |  |
+| **idempotency_key** | **String** | Unique key to prevent duplicate processing | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[AUTHORIZER_NAME](../README.md#AUTHORIZER_NAME)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+