@keugs/keugsapis NPM

@keugs/keugsapis

@KeugsKeugsapis - JavaScript client for @keugs/keugsapis keugsapis definitions This SDK is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
Package version: 1.0.1
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install @keugs/keugsapis --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your @keugs/keugsapis from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var @KeugsKeugsapis = require('@keugs/keugsapis');

var defaultClient = @KeugsKeugsapis.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-KEUGS-KEY'] = "Token"

var api = new @KeugsKeugsapis.AuthApi()
var opts = {
  'confirmVisitorRequest': new @KeugsKeugsapis.ConfirmVisitorRequest() // {ConfirmVisitorRequest} 
};
api.confirmVisitor(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://keugs.cloud.tyk.io/api/v1

Class	Method	HTTP request	Description
@KeugsKeugsapis.AuthApi	confirmVisitor	POST /auth/register/confirm	Confirms if the email and code is valid
@KeugsKeugsapis.AuthApi	findMyWorkspace	GET /auth/workspace/{workspaceName}	searches for a workspace by name
@KeugsKeugsapis.AuthApi	forgotPassword	POST /auth/forgot_password	Request for a password reset
@KeugsKeugsapis.AuthApi	login	POST /auth	Authorize login request
@KeugsKeugsapis.AuthApi	registerUserWorkspace	POST /auth/register/workspace	Creates a new workspace associated with a user
@KeugsKeugsapis.AuthApi	verifyVisitor	POST /auth/register/verify	Sends a code to the email/mobile no for verification
@KeugsKeugsapis.BankContactApi	addBankContact	POST /bank_contacts	Add a new bankContact
@KeugsKeugsapis.BankContactApi	findBankContacts	POST /bank_contacts/query	Find bankcontact based on query
@KeugsKeugsapis.CardApi	deleteCard	DELETE /card/{cardId}	Delete card by ID
@KeugsKeugsapis.CardApi	findCard	POST /card/query	Find Cards based on query
@KeugsKeugsapis.CardApi	getCardById	GET /card/{cardId}	Find card by ID
@KeugsKeugsapis.CardApi	setDefaultCard	GET /card/{cardId}/default	Set the specified card as the default card
@KeugsKeugsapis.CategoryApi	addCategory	POST /category	Add a new category
@KeugsKeugsapis.CategoryApi	deleteCategory	DELETE /category/{categoryId}	Delete category by ID
@KeugsKeugsapis.CategoryApi	findCategories	POST /category/query	Find Customers based on query
@KeugsKeugsapis.CategoryApi	getCategoryById	GET /category/{categoryId}	Find category by ID
@KeugsKeugsapis.CategoryApi	updateCategory	PUT /category/{categoryId}	Update an existing category
@KeugsKeugsapis.CustomerApi	addCustomer	POST /customer	Add a new customer to the database
@KeugsKeugsapis.CustomerApi	deleteCustomer	DELETE /customer/{customerId}	Delete customer by ID
@KeugsKeugsapis.CustomerApi	findCustomers	POST /customer/query	Find Customers based on query
@KeugsKeugsapis.CustomerApi	getCustomerById	GET /customer/{customerId}	Find customer by ID
@KeugsKeugsapis.CustomerApi	updateCustomer	PUT /customer/{customerId}	Update an existing customer
@KeugsKeugsapis.DeliveryApi	addDelivery	POST /delivery	Add a new delivery to the database
@KeugsKeugsapis.DeliveryApi	cancelDelivery	DELETE /delivery/{deliveryId}	Cancel delivery by ID
@KeugsKeugsapis.DeliveryApi	findDeliveries	POST /delivery/query	Find Deliveries based on query
@KeugsKeugsapis.DeliveryApi	getDeliveryById	GET /delivery/{deliveryId}	Find delivery by ID
@KeugsKeugsapis.DeliveryApi	trackDelivery	GET /delivery/track/{referenceNo}	Tracks a particular delivery. This operation returns a stream
@KeugsKeugsapis.DeliveryApi	updateDelivery	PUT /delivery/{deliveryId}	Update an existing delivery
@KeugsKeugsapis.DeviceApi	findDevices	POST /device/query	Find Devices based on query
@KeugsKeugsapis.DeviceApi	getDevice	GET /device/{userId}	get all devices
@KeugsKeugsapis.DeviceApi	register	POST /device/register	Register a device to a user
@KeugsKeugsapis.DeviceApi	unregister	POST /device/unregister	Unregister a device from a user
@KeugsKeugsapis.DispatchApi	findDispatches	POST /dispatch/query	retrieves multiple dispatch depending on the query given.
@KeugsKeugsapis.DispatchApi	getDispatch	GET /dispatch/{dispatchId}	retrieves a particular dispatch
@KeugsKeugsapis.DispatchApi	updateDispatch	PUT /dispatch/{dispatchId}	Update an existing dispatch
@KeugsKeugsapis.InvoiceApi	findInvoice	POST /invoice/query	Find Invoice based on query
@KeugsKeugsapis.InvoiceApi	generateInvoice	POST /invoice/generate	generates a new invoice
@KeugsKeugsapis.InvoiceApi	getInvoiceById	GET /invoice/{invoiceId}	Find invoice by ID
@KeugsKeugsapis.ItemApi	addItem	POST /item	Add a new item
@KeugsKeugsapis.ItemApi	deleteItem	DELETE /item/{itemId}	Delete item by ID
@KeugsKeugsapis.ItemApi	findItems	POST /item/query	Find Items based on query
@KeugsKeugsapis.ItemApi	getItemById	GET /item/{itemId}	Find item by ID
@KeugsKeugsapis.ItemApi	updateItem	PUT /item/{itemId}	Update an existing Item
@KeugsKeugsapis.NotificationApi	findNotifications	POST /notification/query	Find Notification based on query
@KeugsKeugsapis.NotificationApi	getNotificationById	GET /notification/{notificationId}	Find notification by ID
@KeugsKeugsapis.NotificationApi	readNotification	GET /notification/read/{notificationId}	read notification
@KeugsKeugsapis.NotificationApi	sendNotification	POST /notification	sends notification(s)
@KeugsKeugsapis.NotificationApi	subscribe	POST /subscribe	Subscribe to a notification event
@KeugsKeugsapis.NotificationApi	unsubscribe	POST /unsubscribe	Unsubscribe from receiving a specific notification
@KeugsKeugsapis.PaymentApi	addPayment	POST /payments	make a new payment
@KeugsKeugsapis.PlanApi	findPlans	POST /plan/query	Find Plan based on query
@KeugsKeugsapis.PlanApi	getPlanById	GET /plan/{planId}	Find plan by ID
@KeugsKeugsapis.PricingApi	addPriceConfiguration	POST /pricing/configuration	Adds a new price configuration
@KeugsKeugsapis.PricingApi	deletePricingConfiguration	DELETE /pricing/configuration/{configurationId}	Delete price configuration by ID
@KeugsKeugsapis.PricingApi	fetchDeliveryEstimate	POST /pricing/delivery_estimate	Gets price estimate for a delivery
@KeugsKeugsapis.PricingApi	getPriceConfiguration	POST /pricing/configuration/query	Retrieves a list of price configuration
@KeugsKeugsapis.PricingApi	getPriceConfigurationById	GET /pricing/configuration/{configurationId}	Find price configuration by ID
@KeugsKeugsapis.PricingApi	updatePriceConfiguration	PUT /pricing/configuration/{configurationId}	Update an existing price configuration
@KeugsKeugsapis.PurchaseApi	findPurchase	POST /purchase/query	Find Purchase based on query
@KeugsKeugsapis.PurchaseApi	getPurchaseById	GET /purchase/{purchaseId}	Find purchase by ID
@KeugsKeugsapis.RatingsApi	addRating	POST /ratings	Adds a new ratings
@KeugsKeugsapis.RatingsApi	getRatings	POST /ratings/query	Retrieves a list of rating
@KeugsKeugsapis.RegionApi	getRegionById	GET /region/{regionId}	Find region by ID
@KeugsKeugsapis.RegionApi	getRegions	POST /region/query	Retrieves a list of regions
@KeugsKeugsapis.RoleApi	addRole	POST /role	Add a new role to the database
@KeugsKeugsapis.RoleApi	addUserToRole	GET /role/{roleId}/add/{userId}	Adds a user to a role
@KeugsKeugsapis.RoleApi	deleteRole	DELETE /role/{roleId}	Delete role by ID
@KeugsKeugsapis.RoleApi	findRoles	POST /role/query	Find Roles based on query
@KeugsKeugsapis.RoleApi	getRoleById	GET /role/{roleId}	Find role by ID
@KeugsKeugsapis.RoleApi	setRolePermission	POST /role/set_permission	Updates a particular permission
@KeugsKeugsapis.RoleApi	updateRole	PUT /role/{roleId}	Update an existing role
@KeugsKeugsapis.StoreApi	addStore	POST /store	Add a new store
@KeugsKeugsapis.StoreApi	deleteStore	DELETE /store/{storeId}	Delete store by ID
@KeugsKeugsapis.StoreApi	findStores	POST /store/query	Find Stores based on query
@KeugsKeugsapis.StoreApi	getStoreById	GET /store/{storeId}	Find store by ID
@KeugsKeugsapis.StoreApi	updateStore	PUT /store/{storeId}	Update an existing store
@KeugsKeugsapis.SubscriptionApi	addSubscription	POST /subscription	Add a new subscription
@KeugsKeugsapis.SubscriptionApi	deleteSubscription	DELETE /subscription/{subscriptionId}	Delete subscription by ID
@KeugsKeugsapis.SubscriptionApi	findSubscriptions	POST /subscription/query	Find Subscription based on query
@KeugsKeugsapis.SubscriptionApi	getSubscriptionById	GET /subscription/{subscriptionId}	Find subscription by ID
@KeugsKeugsapis.TransactionApi	deposit	POST /transaction/deposit	Initiate a deposit
@KeugsKeugsapis.TransactionApi	findTransaction	POST /transaction/query	Find Transaction based on query
@KeugsKeugsapis.TransactionApi	getTotalAmount	POST /transaction/total_amount	Get the sum of transaction amount
@KeugsKeugsapis.TransactionApi	getTransactionById	GET /transaction/{transactionId}	Find transaction by id
@KeugsKeugsapis.TransactionApi	initializeTransaction	POST /transaction	Initialize a new transaction
@KeugsKeugsapis.TransactionApi	transfer	POST /transaction/transfer	Initiate a new transfer
@KeugsKeugsapis.TransactionApi	withdraw	POST /transaction/withdraw	Withdraw funds to a bank account
@KeugsKeugsapis.UploadApi	uploadFile	POST /upload	Upload a file to storage
@KeugsKeugsapis.UserApi	addUser	POST /user	Add a new user to the database
@KeugsKeugsapis.UserApi	deleteUser	DELETE /user/{userId}	Delete user by ID
@KeugsKeugsapis.UserApi	findUsers	POST /user/query	Find Users based on query
@KeugsKeugsapis.UserApi	getUserById	GET /user/{userId}	Find user by ID
@KeugsKeugsapis.UserApi	getUserRole	GET /user/{userId}/role	Get user's role by ID
@KeugsKeugsapis.UserApi	updateUser	PUT /user/{userId}	Update an existing user
@KeugsKeugsapis.VehicleApi	addVehicle	POST /vehicle	Add a new vehicle
@KeugsKeugsapis.VehicleApi	deleteVehicle	DELETE /vehicle/{vehicleId}	Delete vehicle by ID
@KeugsKeugsapis.VehicleApi	findVehicles	POST /vehicle/query	Find Vehicles based on query
@KeugsKeugsapis.VehicleApi	getVehicleById	GET /vehicle/{vehicleId}	Find vehicle by ID
@KeugsKeugsapis.VehicleApi	updateVehicle	PUT /vehicle/{vehicleId}	Update an existing vehicle
@KeugsKeugsapis.WalletApi	addWallet	POST /wallet	add a new wallet to the database
@KeugsKeugsapis.WalletApi	findWallets	POST /wallet/query	Find Wallets based on query
@KeugsKeugsapis.WalletApi	getWalletById	GET /wallet/{walletId}	Find wallet by ID
@KeugsKeugsapis.WalletApi	getWalletTotalDeposit	GET /wallet/{userId}/total_deposits	Sum Total deposits
@KeugsKeugsapis.WalletApi	getWalletTotalExpense	GET /wallet/{userId}/total_expenses	Sum total expenses
@KeugsKeugsapis.WalletApi	updateWallet	PUT /wallet/{walletId}	Update an existing wallet
@KeugsKeugsapis.WebhookApi	triggerWebHook	POST /webhook	Trigger the webhook
@KeugsKeugsapis.WorkspaceApi	createWorkspace	POST /workspace	create workspace
@KeugsKeugsapis.WorkspaceApi	findWorkspaces	POST /workspace/query	Find Workspace based on query
@KeugsKeugsapis.WorkspaceApi	getWorkspaceById	GET /workspace/{workspaceId}	Find workspace by ID
@KeugsKeugsapis.WorkspaceApi	updateWorkspace	PUT /workspace/{workspaceId}	Update an existing workspace
@KeugsKeugsapis.WorkspaceApi	workspaceExist	GET /workspace/{name}/exist	Find workspace by ID
@KeugsKeugsapis.ZoneApi	getZoneById	GET /zone/{zoneId}	Find zone by ID
@KeugsKeugsapis.ZoneApi	getZones	POST /zone/query	Retrieves a list of zones