yapstone-so

Yapstone - the Ruby gem for the Yapstone Staged On-Boarding Services

Set of API's that allow clients to onboard with Yapstone.

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 2.0.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build yapstone-so.gemspec

Then either install the gem locally:

gem install ./yapstone-so-1.0.0.gem

(for development, run gem install --dev ./yapstone-so-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'yapstone-so', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'yapstone-so', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'yapstone-so'

# Setup authorization
Yapstone.configure do |config|
  # Configure Bearer authorization (JWT): Bearer
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Yapstone::AssetsApi.new
asset_request = Yapstone::AssetRequest.new # AssetRequest | The Asset Request Resource to be created.

begin
  result = api_instance.create_asset(asset_request)
  p result
rescue Yapstone::ApiError => e
  puts "Exception when calling AssetsApi->create_asset: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api-prod-sandbox.yapstone.com/v2/onboarding

Class Method HTTP request Description
Yapstone::AssetsApi create_asset POST /assets
Yapstone::AssetsApi deactivate_asset DELETE /assets/assetId
Yapstone::AssetsApi get_asset GET /assets/assetId
Yapstone::AssetsApi get_assets GET /assets
Yapstone::AssetsApi update_asset PUT /assets/assetId
Yapstone::AuthenticationApi authenticate_partner POST /v1/oauth2/client_credential/accesstoken Authenticate Partner
Yapstone::BusinessApplicantsApi create_business_applicant POST /business-applicants
Yapstone::BusinessApplicantsApi deactivate_business_applicant DELETE /business-applicants/applicantId
Yapstone::BusinessApplicantsApi get_business_applicant GET /business-applicants/applicantId
Yapstone::BusinessApplicantsApi get_business_applicants GET /business-applicants
Yapstone::BusinessApplicantsApi update_business_applicant PUT /business-applicants/applicantId
Yapstone::ContractsApi create_contract POST /contracts
Yapstone::ContractsApi get_all_contracts GET /contracts Retrieves all of contracts
Yapstone::ContractsApi get_contract GET /contracts/contractId
Yapstone::ContractsApi update_contract PUT /contracts/contractId
Yapstone::IndividualApplicantsApi create_individual_applicant POST /individual-applicants
Yapstone::IndividualApplicantsApi deactivate_applicant DELETE /individual-applicants/applicantId
Yapstone::IndividualApplicantsApi get_individual_applicant GET /individual-applicants/applicantId
Yapstone::IndividualApplicantsApi get_individual_applicants GET /individual-applicants
Yapstone::IndividualApplicantsApi update_individual_applicant PUT /individual-applicants/applicantId
Yapstone::InstrumentsApi create_instrument POST /instruments
Yapstone::InstrumentsApi deactivate_instrument DELETE /instruments/instrumentId
Yapstone::InstrumentsApi get_instrument GET /instruments/instrumentId
Yapstone::InstrumentsApi get_instruments GET /instruments
Yapstone::InstrumentsApi update_instrument PUT /instruments/instrumentId
Yapstone::MarketplaceProductsApi get_marketplace_product GET /marketplace-products/productId Retrieves a MarketPlace Product
Yapstone::MarketplaceProductsApi update_marketplace_product PUT /marketplace-products/productId Update selctive MarketPlace Product details
Yapstone::MarketplacesApi add_marketplace_product POST /contracts/contractId/marketplaces
Yapstone::MarketplacesApi deactivate_marketplace_product DELETE /contracts/contractId/marketplaces/assetId
Yapstone::MarketplacesApi get_marketplace_product_by_asset_id GET /contracts/contractId/marketplaces/assetId
Yapstone::MarketplacesApi update_marketplace_product_by_contract_id PUT /contracts/contractId/marketplaces/assetId
Yapstone::PayoutInstrumentsApi create_payout_instrument POST /payout-instruments
Yapstone::PayoutInstrumentsApi deactivate_payout_instrument DELETE /payout-instruments/payoutInstrumentId
Yapstone::PayoutInstrumentsApi get_payout_instrument GET /payout-instruments/payoutInstrumentId
Yapstone::PayoutInstrumentsApi get_payout_instruments GET /payout-instruments
Yapstone::PayoutInstrumentsApi update_payout_instrument PUT /payout-instruments/payoutInstrumentId
Yapstone::PayoutProductsApi get_payout_product GET /payout-products/productId Retrieves a Payout Product
Yapstone::PayoutsApi add_payout_product POST /contracts/contractId/payouts
Yapstone::PayoutsApi deactivate_payout_product DELETE /contracts/contractId/payouts/payoutInstrumentId
Yapstone::PayoutsApi get_payout_product_by_instrument_id GET /contracts/contractId/payouts/payoutInstrumentId
Yapstone::PayoutsApi update_payout_product PUT /contracts/contractId/payouts/payoutInstrumentId

Documentation for Models

Documentation for Authorization

Bearer

  • Type: Bearer authentication (JWT)