masspay_ruby_sdk 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6a9546ea765d92fd6152037cafacd6126ed8a13867fea49bed5f19a6c18d614
-  data.tar.gz: 8c843b6d6bbbff4d53486f9173f1f26fefe42569742077d8b91c3bb63c218f28
+  metadata.gz: a5f9fbf20daf1b90af82c5a9a52677812fafc0ff003d526794b4ecaec8340038
+  data.tar.gz: 401cfc228b0e4bbb5b5778749cc0cb60b3d0087ae386495079dfca25b66cce2e
 SHA512:
-  metadata.gz: aa9b2ad6093a093a6cdc8f0072a058b1017cde4a7416e1e5a29b0a75d4aabf78b22300c1cc08b3687d6af4b29793fda6ccf9a9aa9d723fccd388ff932c56c44b
-  data.tar.gz: 90c7318ec73feaa01bd585b9681f1037d911470ad256838415415540dd10daaaf331b3717ed7cb97f18e2d2403592fa7d98e49d1e1c08b16a9fbc723422616e0
+  metadata.gz: 0466c493f9a6084648d58133e50ddf33f70fa39f1a9d9a5b38440814369ac278e2864abb71a5c4e6fd39d8cba16712ffa7bf9b7146b235d9724aa3fddbdb2673
+  data.tar.gz: 741a599da95aac3c94d45e6e0311b469115e5df67d573316d45bf36772c37fb1f05d0af399a9c524d67b4fef63e8d8880acdf393dc8d9551447896a7f8e06dff

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## [2.0.0](https://github.com/masspayio/masspay-ruby-sdk/compare/v1.0.0...v2.0.0) (2024-07-19)
+
+
+### ⚠ BREAKING CHANGES
+
+* new version of Ruby SDK with new OAS endpoints
+
+### Features
+
+* new version of Ruby SDK with new OAS endpoints ([573281d](https://github.com/masspayio/masspay-ruby-sdk/commit/573281db7ef6f357bd4427b3af70bc74bb8a7170))
+* upgrade to OAS v1.0.0 ([4ba1edb](https://github.com/masspayio/masspay-ruby-sdk/commit/4ba1edb7574fa29d45cae363474074f3e9451f30))
+
+## 2.0.0 (2024-04-15)
+
+* BREAKING CHANGE: update SDK according to newest OAS and completetly new architecture that suits better for developers
+
 ## 1.0.0 (2023-11-15)
 
 

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,43 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include using an official project email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [info@masspay.io](mailto:info@masspay.io). All complaints will be reviewed and investigated promptly and fairly.
+
+All project team members are obligated to respect the privacy and security of the reporter of any incident.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.0, available at [https://www.contributor-covenant.org/version/2/0/code_of_conduct.html](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).

data/CONTRIBUTING.md

@@ -1,13 +1,52 @@
-# Contributing
+# Contributing to masspay_ruby_sdk
 
-## Release new version
+Thank you for considering contributing to masspay_ruby_sdk! We appreciate your efforts in helping to improve our project. Please take a moment to review this document for guidelines on how to contribute.
 
-All commit messages have to be in the format of the [conventionalcommits.org](https://conventionalcommits.org) specification.
+## Ways to Contribute
 
-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).
+There are several ways you can contribute to this project:
 
-For more detailed instructions read [standard-version documentation](https://github.com/conventional-changelog/standard-version).
+- Reporting issues
+- Suggesting enhancements
+- Submitting pull requests for bug fixes or new features
+
+## How to Contribute
+
+### Reporting Issues
+
+If you encounter any issues or bugs, please use the GitHub issue tracker to report them. When reporting issues, please provide as much detail as possible, including:
+
+- A clear and descriptive title
+- A detailed description of the issue
+- Steps to reproduce the issue, if applicable
+- Any relevant error messages or screenshots
+
+### Suggesting Enhancements
+
+If you have suggestions for enhancements or new features, please feel free to open an issue on GitHub. Please provide a clear and detailed description of your suggestion, including why you think it would be beneficial for the project.
+
+### Submitting Pull Requests
+
+We welcome pull requests for bug fixes, improvements, and new features. Before submitting a pull request, please ensure the following:
+
+- Fork the repository and create a new branch for your changes.
+- Make your changes, and provide clear and descriptive commit messages.
+- Test your changes thoroughly.
+- Ensure that your code follows the existing coding style and guidelines.
+- Update any relevant documentation or examples to reflect your changes.
+
+## Testing
+
+Run the IRB console to test the SDK:
+
+```bash
+irb -I lib -r masspay_ruby_sdk
+```
+
+Now you can use the MasspayRubySdk class to interact with the API in the console.
+
+## Contact
+
+If you have any further questions or need assistance, please feel free to reach out to us at [info@masspay.io](mailto:info@masspay.io).
+
+Thank you again for your interest in contributing to masspay_ruby_sdk

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 MassPay Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,197 +1,162 @@
-<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)
+<div align='center' class='text-center'>
+  <img alt='' src='./assets/logo.webp' width='200' />
+  <h1 align='center' class='text-center'>masspay_ruby_sdk</h1>
+</div>
+
+<div align='center' class='text-center'>
+  <a aria-label='Version' href='#'>
+    <img alt='' src='https://img.shields.io/badge/version-2.0.0-blue' />
+  </a>
+  <a aria-label='License' href='https://opensource.org/licenses/MIT'>
+    <img alt='' src='https://img.shields.io/badge/License-MIT-blue.svg' />
+  </a>
+</div>
+
+<!---
+Repository badges to consider: (https://github.com/aleen42/badges)
+  a. [![Build Status](https://travis-ci.com/username/repository.svg?branch=master)](https://travis-ci.com/)
+  b. [![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+  c. [![Version](https://img.shields.io/badge/version-1.0.0-blue.svg)]()
+  d. [![Downloads](https://img.shields.io/badge/downloads-1000%2Fmonth-brightgreen.svg)]()
+  e. [![Contributors](https://img.shields.io/github/contributors/username/repository.svg)]()
+--->
+
+Welcome to our masspay_ruby_sdk. We are committed to providing you with the best SDK services experience possible. Please use our step-by-step instructions to become familiar with how to use our SDK.
+
+- Current API version: 1.0.0
+- Current package version: 2.0.0
+
+## Table of Contents
+
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Features](#features)
+- [Contributing](#contributing)
+- [License](#license)
+- [Contact](#contact)
+- [Frequently Asked Questions (FAQ)](#frequently-asked-questions-faq)
+
+## Requirements
+
+<!--- Instructions on what the user must do before using the SDK. --->
+
+- Ruby version >= 2.7.
+- MassPay.io API credentials.
 
 ## Installation
 
-### Bundler
+<!--- Instructions on how to install and set up the SDK.--->
 
-```shell
-bundle add masspay_ruby_sdk
-```
+Use this command to install masspay_ruby_sdk in your terminal.
 
-### Global Installation
-
-```shell
+```bash
 gem install masspay_ruby_sdk
 ```
 
-## Getting Started
+## Usage
 
-Please follow the [installation](#installation) procedure and then run the following code:
+<!--- Description how users can use the SDK.--->
 
-### Ruby
+In case that you successfully installed our masspay_ruby_sdk please execute this code:
 
 ```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
-
+client = MasspayRubySdk.client({ bearer_auth: 'YOUR_BEARER_TOKEN' })
+client.account_service.get_account_balance
 ```
 
-### Rails
+## Features
 
-Create a file `config/initializers/masspay_ruby_sdk.rb` with the following content:
+<!--- Highlighting the key features and capabilities of the SDK. --->
 
-```ruby
+Kindly note that every URI is relative to _https://api.masspay.io/v1.0.0_.
 
-# 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*
+The table displays all features categorized based on their specific purposes.
 
 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
-
+------------ | ------------- | ------------- | ------------- 
+_MasspayRubySdk.account_service_ | **get_account_balance** | **GET** /payout/account/balance | Get current available balance
+_MasspayRubySdk.account_service_ | **get_account_statement** | **GET** /payout/account/statement | Get certified account statement
+_MasspayRubySdk.attribute_service_ | **get_all_attrs** | **GET** /payout/attribute/{user_token} | Get all stored user attributes
+_MasspayRubySdk.attribute_service_ | **store_attrs** | **POST** /payout/attribute/{user_token}/{destination_token}/{currency} | Store user attributes
+_MasspayRubySdk.attribute_service_ | **get_attrs** | **GET** /payout/attribute/{user_token}/{destination_token}/{currency} | Get user attributes for destination_token
+_MasspayRubySdk.card_service_ | **get_wallet_card_info** | **GET** /payout/wallet/{user_token}/{wallet_token}/card | Get MassPay card information
+_MasspayRubySdk.card_service_ | **update_wallet_card_info** | **PUT** /payout/wallet/{user_token}/{wallet_token}/card | Update MassPay card information
+_MasspayRubySdk.catalog_service_ | **get_country_list** | **GET** /payout/country/list | Gets a list of countries where services offered.
+_MasspayRubySdk.catalog_service_ | **get_country_services** | **GET** /payout/country/{country_code} | Gets a list of Companies and their service offerings for the given country code.
+_MasspayRubySdk.catalog_service_ | **get_cheapest_country_services** | **GET** /payout/country/{country_code}/cheapest | Gets a list of Companies and their cheapest service offerings for the given country code.
+_MasspayRubySdk.catalog_service_ | **get_destination_token_alternatives** | **GET** /payout/service/{destination_token}/alternatives | Returns list of alternative service to a provided service
+_MasspayRubySdk.catalog_service_ | **get_destination_token** | **GET** /payout/service/{destination_token} | Returns provided service
+_MasspayRubySdk.catalog_service_ | **get_user_agreement** | **GET** /payout/user-agreements | Get user agreement
+_MasspayRubySdk.catalog_service_ | **get_user_agreements_names** | **OPTIONS** /payout/user-agreements | Get available user agreements
+_MasspayRubySdk.kyc_service_ | **find_attributes_velocity** | **POST** /payout/attribute/{user_token}/velocity | Attributes velocity check
+_MasspayRubySdk.kyc_service_ | **get_user_user_token_kyc_au_10_tix** | **GET** /payout/user/{user_token}/kyc/au10tix | Get an Au10tix session link
+_MasspayRubySdk.kyc_service_ | **upload_id_photos** | **POST** /payout/user/{user_token}/kyc/id | Upload ID photos
+_MasspayRubySdk.kyc_service_ | **get_user_user_token_kyc_attempts** | **GET** /payout/user/{user_token}/kyc/id | Get all KYC sessions
+_MasspayRubySdk.kyc_service_ | **get_user_user_token_kyc_veriff** | **GET** /payout/user/{user_token}/kyc/veriff | Get a Veriff session link
+_MasspayRubySdk.load_service_ | **resend_balance_notification** | **PUT** /payout/wallet/{user_token} | Resend balance notification
+_MasspayRubySdk.load_service_ | **load_user** | **POST** /payout/load/{user_token} | Initiate a load transaction
+_MasspayRubySdk.load_service_ | **get_user_loads_by_token** | **GET** /payout/load/{user_token} | Get history of loads by user token
+_MasspayRubySdk.load_service_ | **resend_load_notification** | **PUT** /payout/load/{user_token} | Resend load notification
+_MasspayRubySdk.load_service_ | **cancel_user_load** | **DELETE** /payout/load/{user_token} | Reverse a user load
+_MasspayRubySdk.payout_service_ | **initiate_payout** | **POST** /payout/{user_token} | Initiate a payout transaction
+_MasspayRubySdk.payout_service_ | **get_user_payouts_by_token** | **GET** /payout/{user_token} | Get history of payouts by user token
+_MasspayRubySdk.payout_service_ | **commit_payout_txn** | **PUT** /payout/{user_token}/{payout_token} | Commit payout transaction
+_MasspayRubySdk.payout_service_ | **get_payout_status** | **GET** /payout/{user_token}/{payout_token} | Get status of a payout by payout token
+_MasspayRubySdk.payout_service_ | **get_transaction_confirmation_details** | **PATCH** /payout/{user_token}/{payout_token} | Get transaction confirmation details
+_MasspayRubySdk.spend_back_service_ | **get_user_spendbacks_by_token** | **GET** /payout/spendback/{user_token} | Get history of spend backs by user token
+_MasspayRubySdk.spend_back_service_ | **initiate_spendback** | **POST** /payout/spendback/{user_token} | Initiate a spend back transaction
+_MasspayRubySdk.subaccount_service_ | **create_subaccount** | **POST** /subaccount | Create a subaccount
+_MasspayRubySdk.subaccount_service_ | **get_subaccount_subaccount_token_ubo** | **POST** /subaccount/{subaccount_token}/ubo | Add UBOs to subaccount
+_MasspayRubySdk.subaccount_service_ | **upload_subaccount_ubo_id** | **POST** /subaccount/{subaccount_token}/ubo/{ubo_token}/id | Upload UBO ID photos
+_MasspayRubySdk.tax_service_ | **get_tax_users** | **GET** /payout/tax | Get list of users' annual balance
+_MasspayRubySdk.tax_service_ | **get_tax_interview_link** | **GET** /payout/{user_token}/tax | Get link for tax interview
+_MasspayRubySdk.user_service_ | **create_user** | **POST** /payout/user | Create a user
+_MasspayRubySdk.user_service_ | **get_user_by_token** | **GET** /payout/user/{user_token} | Get user by user token
+_MasspayRubySdk.user_service_ | **update_user** | **PUT** /payout/user/{user_token} | Updated user
+_MasspayRubySdk.user_service_ | **user_lookup** | **GET** /payout/user/lookup | Lookup an existing user
+_MasspayRubySdk.user_service_ | **get_user_history** | **GET** /payout/user/{user_token}/history | Transactions history
+_MasspayRubySdk.user_service_ | **get_all_users_history** | **GET** /payout/user/history | All Users' Transactions history
+_MasspayRubySdk.wallet_service_ | **get_wallet** | **GET** /payout/wallet/{user_token} | Retrieve all available wallets for a user
+_MasspayRubySdk.wallet_service_ | **get_autopayout_rules** | **GET** /payout/wallet/{user_token}/{wallet_token}/autopayout | Get all AutoPayout rules
+_MasspayRubySdk.wallet_service_ | **create_autopayout_rule** | **POST** /payout/wallet/{user_token}/{wallet_token}/autopayout | Add AutoPayout rule
+_MasspayRubySdk.wallet_service_ | **delete_autopayout_rule** | **DELETE** /payout/wallet/{user_token}/{wallet_token}/autopayout | Delete AutoPayout rule
+
+
+## Contributing
+
+<!--- Explaining how users can contribute to the project. Include guidelines for bug reports, feature requests, and pull requests.--->
+
+To learn more about the possibility of contributing to the subsequent development of this SDK, please visit our [contributing page](./CONTRIBUTING.md). Kindly note that contributions are limited by a unique set of rules in order to ensure clarity.
+
+## License
+
+<!--- Including the license information for your project and the specification of the license type (e.g., MIT, Apache 2.0). --->
+
+Please refer to the [license page](./LICENSE) for more information about the license type and the corresponding terms of use.
+
+## Contact
+
+<!--- Providing contact information or links to relevant communication channels (e.g., email, Slack, Gitter).--->
+
+We kindly request that you direct all questions to our support email:
+
+- [info@masspay.io](mailto:info@masspay.io)
+
+## Frequently Asked Questions (FAQ)
+
+<!--- Including a section addressing frequently asked questions about the SDK.--->
+
+**Q: Where may I obtain an API key?**
+A: Please visit our [registration page](https://developers.masspay.io/) if you do not have your unique API key.
+
+<!---  Questions that can be prefilled
+What are the main functions or features supported by the SDK?
+Are there any examples or tutorials to help me understand how to use the SDK effectively?
+How can I get help or assistance if I encounter issues while using the SDK?
+How often is the SDK updated, and how can users stay informed about updates?
+Are there any best practices recommended for maintaining security while using the SDK?
+What are the licensing terms for using the SDK?
+--->

data/lib/masspay_ruby_sdk/api/account_service.rb

@@ -0,0 +1,35 @@
+=begin
+MassPay API
+
+The version of the OpenAPI document: 1.0.0
+Contact: info@masspay.io
+
+NOTE: This file is auto generated. Do not edit the file manually.
+=end
+
+require 'cgi'
+
+module MasspayRubySdk
+  class AccountService
+
+    def initialize(client)
+      @client = client ||= Client.new
+    end
+
+    # Get current available balance
+    # GET /payout/account/balance
+    def get_account_balance 
+      @client.get("payout/account/balance") 
+    end
+
+    # Get certified account statement
+    # GET /payout/account/statement
+    # @param query_params The query parameters
+    def get_account_statement query_params={}
+      @client.get("payout/account/statement") do |req|
+        req.params = query_params
+      end
+    end
+
+  end
+end

data/lib/masspay_ruby_sdk/api/attribute_service.rb

@@ -0,0 +1,41 @@
+=begin
+MassPay API
+
+The version of the OpenAPI document: 1.0.0
+Contact: info@masspay.io
+
+NOTE: This file is auto generated. Do not edit the file manually.
+=end
+
+require 'cgi'
+
+module MasspayRubySdk
+  class AttributeService
+
+    def initialize(client)
+      @client = client ||= Client.new
+    end
+
+    # Get all stored user attributes
+    # GET /payout/attribute/{user_token}
+    def get_all_attrs user_token
+      @client.get("payout/attribute/#{user_token}") 
+    end
+
+    # Store user attributes
+    # POST /payout/attribute/{user_token}/{destination_token}/{currency}
+    # @param body The body of the request
+    def store_attrs user_token, destination_token, currency, body
+      @client.post("payout/attribute/#{user_token}/#{destination_token}/#{currency}") do |req|
+        req.body = body
+      end
+    end
+
+    # Get user attributes for destination_token
+    # GET /payout/attribute/{user_token}/{destination_token}/{currency}
+    def get_attrs user_token, destination_token, currency
+      @client.get("payout/attribute/#{user_token}/#{destination_token}/#{currency}") 
+    end
+
+  end
+end