Skip to content

pdax-manmai/baas-api

BranchesTags

Repository files navigation

baas_api (EXPERIMENTAL)

This is the API that serves the account service for baas.

This Dart package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0
  • Build package: org.openapitools.codegen.languages.DartDioClientCodegen For more information, please visit http://www.swagger.io/support

Requirements

  • Dart 2.12.0 or later OR Flutter 1.26.0 or later
  • Dio 4.0.0+

Installation & Usage

pub.dev

To use the package from pub.dev, please include the following in pubspec.yaml

dependencies:
  baas_api: 1.0.0

Github

If this Dart package is published to Github, please include the following in pubspec.yaml

dependencies:
  baas_api:
    git:
      url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
      #ref: main

Local development

To use the package from your local drive, please include the following in pubspec.yaml

dependencies:
  baas_api:
    path: /path/to/baas_api

Getting Started

Please follow the installation procedure and then run the following:

import 'package:baas_api/baas_api.dart';


final api = BaasApi().getAccountsApi();

try {
    final response = await api.accountsRegisterGet();
    print(response);
} catch on DioError (e) {
    print("Exception when calling AccountsApi->accountsRegisterGet: $e\n");
}

Documentation for API Endpoints

All URIs are relative to http://localhost:8080/api/baas/v1

Class Method HTTP request Description
AccountsApi accountsRegisterGet GET /accounts/register registers an account
AccountsApi partnersPartneridClientsAgreementsPost POST /partners/{partnerid}/clients/agreements stores the legal agreements during user onboarding
AccountsApi partnersPartneridClientsClientidGet GET /partners/{partnerid}/clients/{clientid} gets an account
AccountsApi partnersPartneridClientsClientidPost POST /partners/{partnerid}/clients/{clientid} creates a baas account with existing caas user
AccountsApi partnersPartneridClientsPost POST /partners/{partnerid}/clients creates a new account in baas
AdminApi adminAccountsApprovePut PUT /admin/accounts/approve approve account with nross number
AdminApi adminAccountsGet GET /admin/accounts retrieves accounts with filters and paginated
AdminApi adminAccountsPartnerPartnerIDClientClientIDGet GET /admin/accounts/partner/{partnerID}/client/{clientID} get user baas account data
AdminApi adminAccountsRejectPut PUT /admin/accounts/reject reject account with nross number
AdminApi adminAccountsStatusMapGet GET /admin/accounts/status/map get account status mapping
AdminApi adminAccountsStatusPartnerPartnerIDClientClientIDGet GET /admin/accounts/status/partner/{partnerID}/client/{clientID} get user account status
AdminApi adminAccountsStatusPut PUT /admin/accounts/status update account status
AdminApi adminNrossFilePost POST /admin/nross/file get nross file presigned url
AdminApi adminNrossGenerateGet GET /admin/nross/generate create nross file
AdminApi adminNrossGet GET /admin/nross get nross files
AdminApi adminNrossUploadPost POST /admin/nross/upload upload nross account document
AdminApi adminSettingsGet GET /admin/settings get service settings
AdminApi adminSettingsPut PUT /admin/settings update service settings
BalanceCorrectionApi adminBalancesCorrectionBalanceCorrectionIdStatusPut PUT /admin/balances/correction/{balanceCorrectionId}/status Update Balance correction
BalanceCorrectionApi adminBalancesCorrectionGet GET /admin/balances/correction Get balance correction with filters
BalanceCorrectionApi adminBalancesCorrectionPost POST /admin/balances/correction Create balance correction request
BalancesApi partnersPartnerIdClientsClientIdBalancesGet GET /partners/{partnerId}/clients/{clientId}/balances Get user balances
BalancesApi partnersPartnerIdClientsClientIdBalancesPut PUT /partners/{partnerId}/clients/{clientId}/balances Update user balances [DEV ONLY/STAGE FOR TESTING ONLY. REMOVE ON PROD.]
BondsApi adminBondsBondIdFeesGet GET /admin/bonds/{bondId}/fees Get bonds' prices and fees
BondsApi adminBondsBondIdFeesPut PUT /admin/bonds/{bondId}/fees Update bonds' prices and fees
BondsApi adminBondsBondIdGet GET /admin/bonds/{bondId} Retrieves Bonds by UUID
BondsApi adminBondsBondIdPartnersGet GET /admin/bonds/{bondId}/partners Get bonds' partners
BondsApi adminBondsBondIdPartnersPartnerIdGet GET /admin/bonds/{bondId}/partners/{partnerId} Get Bonds Partner Config
BondsApi adminBondsBondIdPartnersPartnerIdPut PUT /admin/bonds/{bondId}/partners/{partnerId} Updates Bonds Partner Config
BondsApi adminBondsBondIdPut PUT /admin/bonds/{bondId} Updates Bonds Config
BondsApi adminBondsBondIdStatusGet GET /admin/bonds/{bondId}/status Get bond status
BondsApi adminBondsBondIdStatusPut PUT /admin/bonds/{bondId}/status Update bond settings
BondsApi adminBondsGet GET /admin/bonds Retrieves Bonds with Pagination
BondsApi adminBondsPartnersPartnerIdGet GET /admin/bonds/partners/{partnerId} Get partner's bonds
BondsApi adminBondsPost POST /admin/bonds Creates Bonds Config
LedgerApi adminLedgerDownloadGet GET /admin/ledger/download Obtains ledger entries for downloading
LedgerApi adminLedgerFeesGet GET /admin/ledger/fees Obtains fee subledger entries
LedgerApi adminLedgerGet GET /admin/ledger Obtains ledger entries
LedgerApi adminLedgerReportsGet GET /admin/ledger/reports Obtains report data from ledger
LedgerApi adminLedgerTransactionsGet GET /admin/ledger/transactions Obtains transaction subledger entries
LedgerApi adminLedgerViewGet GET /admin/ledger/view Obtains ledger entries from table view

Documentation For Models

Documentation For Authorization

BasicAuth

  • Type: HTTP basic authentication

Author

support@swagger.io

About

No description, website, or topics provided.

Resources

Readme
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages