@f-wallet/typescript

v0.1.0

Published

24 days ago

OpenAPI client for @f-wallet/typescript

Downloads

114

0High
0Medium
0Low

_codebender828

jonas_fwallet

@f-wallet/[email protected]

A TypeScript SDK client for the api.fwallet.co.ug API.

Usage

First, install the SDK from npm.

npm install @f-wallet/typescript --save

Next, try it out.

import {
  Configuration,
  AdminApi,
} from '@f-wallet/typescript';
import type { AdminGetAdminDashboardRequest } from '@f-wallet/typescript';

async function example() {
  console.log("🚀 Testing @f-wallet/typescript SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: hmacNonce
    apiKey: "YOUR API KEY",
    // To configure API key authorization: apiKey
    apiKey: "YOUR API KEY",
    // To configure API key authorization: hmacContentSha256
    apiKey: "YOUR API KEY",
    // To configure API key authorization: hmacTimestamp
    apiKey: "YOUR API KEY",
    // To configure API key authorization: hmacKeyId
    apiKey: "YOUR API KEY",
    // To configure API key authorization: hmacSignature
    apiKey: "YOUR API KEY",
  });
  const api = new AdminApi(config);

  try {
    const data = await api.adminGetAdminDashboard();
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

All URIs are relative to https://api.fwallet.co.ug

| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- AdminApi | adminGetAdminDashboard | GET /v1/admin/dashboard | Get Admin AdminApi | adminGetAdminFeeSchedules | GET /v1/admin/fee-schedules | Get Admin AdminApi | adminPostAdminFeeSchedulesByIdRules | POST /v1/admin/fee-schedules/{id}/rules | Create Admin AuthApi | authGetAuthMe | GET /v1/auth/me | Get Auth DepositsApi | depositsPostDepositsBankSlipVerify | POST /v1/deposits/bank-slip/verify | Create Deposits DepositsApi | depositsPostDepositsBankStatements | POST /v1/deposits/bank-statements | Create Deposits DepositsApi | depositsPostDepositsMomoWebhook | POST /v1/deposits/momo-webhook | Create Deposits DeveloperApi | developerGetDeveloperApiKeys | GET /v1/developer/api-keys | Get Developer DeveloperApi | developerGetDeveloperApps | GET /v1/developer/apps | Get Developer DeveloperApi | developerGetDeveloperRequestLogs | GET /v1/developer/request-logs | Get Developer DeveloperApi | developerPatchDeveloperApiKeysByIdRestrictions | PATCH /v1/developer/api-keys/{id}/restrictions | Update Developer DeveloperApi | developerPatchDeveloperAppsById | PATCH /v1/developer/apps/{id} | Update Developer DeveloperApi | developerPostDeveloperApiKeys | POST /v1/developer/api-keys | Create Developer DeveloperApi | developerPostDeveloperApiKeysByIdRevoke | POST /v1/developer/api-keys/{id}/revoke | Create Developer DeveloperApi | developerPostDeveloperApiKeysByIdRotate | POST /v1/developer/api-keys/{id}/rotate | Create Developer DeveloperApi | developerPostDeveloperApps | POST /v1/developer/apps | Create Developer HealthApi | healthGetHealth | GET /v1/health | Get Health JournalApi | journalGetJournal | GET /v1/journal | Get Journal JournalApi | journalGetJournalById | GET /v1/journal/{id} | Get Journal PayoutsApi | payoutsGetPayoutsCases | GET /v1/payouts/cases | Get Payouts PayoutsApi | payoutsPostPayouts | POST /v1/payouts | Create Payouts PayoutsApi | payoutsPostPayoutsByCaseIdApprove | POST /v1/payouts/{caseId}/approve | Create Payouts PayoutsApi | payoutsPostPayoutsByCaseIdReject | POST /v1/payouts/{caseId}/reject | Create Payouts SystemApi | systemGetSystemOrganizations | GET /v1/system/organizations | Get System SystemApi | systemGetSystemOverview | GET /v1/system/overview | Get System SystemApi | systemGetSystemTransactions | GET /v1/system/transactions | Get System SystemApi | systemGetSystemWallets | GET /v1/system/wallets | Get System SystemApi | systemPostSystemOrganizations | POST /v1/system/organizations | Create System TeamApi | teamGetTeam | GET /v1/team | Get Team TeamApi | teamPostTeam | POST /v1/team | Create Team TenantsApi | tenantsGetTenantsById | GET /v1/tenants/{id} | Get Tenants TenantsApi | tenantsPostTenants | POST /v1/tenants | Create Tenants TenantsApi | tenantsPostTenantsByIdApiKeys | POST /v1/tenants/{id}/api-keys | Create Tenants TransfersApi | transfersPostTransfers | POST /v1/transfers | Create Transfers TransfersApi | transfersPostTransfersSimulateFee | POST /v1/transfers/simulate-fee | Create Transfers WalletsApi | walletsGetWallets | GET /v1/wallets | Get Wallets WalletsApi | walletsGetWalletsById | GET /v1/wallets/{id} | Get Wallets WalletsApi | walletsGetWalletsLookup | GET /v1/wallets/lookup | Get Wallets WalletsApi | walletsPostWallets | POST /v1/wallets | Create Wallets

Models

Authorization

Authentication schemes defined for the API:

apiKey

Type: API key
API key parameter name: X-API-Key
Location: HTTP header

systemKey

Type: API key
API key parameter name: X-System-Key
Location: HTTP header

hmacKeyId

Type: API key
API key parameter name: X-FWallet-Key-Id
Location: HTTP header

hmacTimestamp

Type: API key
API key parameter name: X-FWallet-Timestamp
Location: HTTP header

hmacNonce

Type: API key
API key parameter name: X-FWallet-Nonce
Location: HTTP header

hmacContentSha256

Type: API key
API key parameter name: X-FWallet-Content-SHA256
Location: HTTP header

hmacSignature

Type: API key
API key parameter name: X-FWallet-Signature
Location: HTTP header

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:

API version: 0.1.0
Package version: 0.1.0
Generator version: 7.21.0
Build package: org.openapitools.codegen.languages.TypeScriptFetchClientCodegen

The generated npm module supports the following:

Environments
- Node.js
- Webpack
- Browserify
Language levels
- ES5 - you must have a Promises/A+ library installed
- ES6
Module systems
- CommonJS
- ES6 module system

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish