npm package: @keugs/keugsapis
Description: A Keugs Javascript Client Library
Latest version: 1.9.0

# @keugs/keugsapis

@KeugsKeugsapis - JavaScript client for @keugs/keugsapis
keugsapis definitions
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

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

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install @keugs/keugsapis --save
```

Finally, you need to build the module:

```shell
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:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
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:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

Finally, you need to build the module:

```shell
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:

```shell
    npm install GIT_USER_ID/GIT_REPO_ID --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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):

```shell
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:

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

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

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


## Documentation for Models

 - [@KeugsKeugsapis.ApiResponse](docs/ApiResponse.md)
 - [@KeugsKeugsapis.AssignedTo](docs/AssignedTo.md)
 - [@KeugsKeugsapis.AuthenticationRequest](docs/AuthenticationRequest.md)
 - [@KeugsKeugsapis.AuthenticationResponse](docs/AuthenticationResponse.md)
 - [@KeugsKeugsapis.AuthenticationResponseAllOf](docs/AuthenticationResponseAllOf.md)
 - [@KeugsKeugsapis.BankContact](docs/BankContact.md)
 - [@KeugsKeugsapis.BankContactResponse](docs/BankContactResponse.md)
 - [@KeugsKeugsapis.BankContactResponseAllOf](docs/BankContactResponseAllOf.md)
 - [@KeugsKeugsapis.BooleanResponse](docs/BooleanResponse.md)
 - [@KeugsKeugsapis.BooleanResponseAllOf](docs/BooleanResponseAllOf.md)
 - [@KeugsKeugsapis.Card](docs/Card.md)
 - [@KeugsKeugsapis.CardResponse](docs/CardResponse.md)
 - [@KeugsKeugsapis.CardResponseAllOf](docs/CardResponseAllOf.md)
 - [@KeugsKeugsapis.CardStatus](docs/CardStatus.md)
 - [@KeugsKeugsapis.CardType](docs/CardType.md)
 - [@KeugsKeugsapis.Category](docs/Category.md)
 - [@KeugsKeugsapis.CategoryResponse](docs/CategoryResponse.md)
 - [@KeugsKeugsapis.CategoryResponseAllOf](docs/CategoryResponseAllOf.md)
 - [@KeugsKeugsapis.CompositeFilter](docs/CompositeFilter.md)
 - [@KeugsKeugsapis.ConfirmVisitorRequest](docs/ConfirmVisitorRequest.md)
 - [@KeugsKeugsapis.ConfirmVisitorResponse](docs/ConfirmVisitorResponse.md)
 - [@KeugsKeugsapis.ConfirmVisitorResponseAllOf](docs/ConfirmVisitorResponseAllOf.md)
 - [@KeugsKeugsapis.ConfirmVisitorResponseAllOfData](docs/ConfirmVisitorResponseAllOfData.md)
 - [@KeugsKeugsapis.Currency](docs/Currency.md)
 - [@KeugsKeugsapis.Customer](docs/Customer.md)
 - [@KeugsKeugsapis.CustomerPaymentMethod](docs/CustomerPaymentMethod.md)
 - [@KeugsKeugsapis.CustomerResponse](docs/CustomerResponse.md)
 - [@KeugsKeugsapis.CustomerResponseAllOf](docs/CustomerResponseAllOf.md)
 - [@KeugsKeugsapis.CustomerSignatureType](docs/CustomerSignatureType.md)
 - [@KeugsKeugsapis.Delivery](docs/Delivery.md)
 - [@KeugsKeugsapis.DeliveryEstimateRequest](docs/DeliveryEstimateRequest.md)
 - [@KeugsKeugsapis.DeliveryResponse](docs/DeliveryResponse.md)
 - [@KeugsKeugsapis.DeliveryResponseAllOf](docs/DeliveryResponseAllOf.md)
 - [@KeugsKeugsapis.DeliveryStatus](docs/DeliveryStatus.md)
 - [@KeugsKeugsapis.DeliveryType](docs/DeliveryType.md)
 - [@KeugsKeugsapis.DepositFundRequest](docs/DepositFundRequest.md)
 - [@KeugsKeugsapis.Device](docs/Device.md)
 - [@KeugsKeugsapis.DeviceRegistrationRequest](docs/DeviceRegistrationRequest.md)
 - [@KeugsKeugsapis.DeviceResponse](docs/DeviceResponse.md)
 - [@KeugsKeugsapis.DeviceResponseAllOf](docs/DeviceResponseAllOf.md)
 - [@KeugsKeugsapis.DeviceStatus](docs/DeviceStatus.md)
 - [@KeugsKeugsapis.DeviceType](docs/DeviceType.md)
 - [@KeugsKeugsapis.Dispatch](docs/Dispatch.md)
 - [@KeugsKeugsapis.DispatchJob](docs/DispatchJob.md)
 - [@KeugsKeugsapis.DispatchJobAssigmentRule](docs/DispatchJobAssigmentRule.md)
 - [@KeugsKeugsapis.DispatchJobType](docs/DispatchJobType.md)
 - [@KeugsKeugsapis.DispatchResponse](docs/DispatchResponse.md)
 - [@KeugsKeugsapis.DispatchResponseAllOf](docs/DispatchResponseAllOf.md)
 - [@KeugsKeugsapis.DispatchStatus](docs/DispatchStatus.md)
 - [@KeugsKeugsapis.DoubleValueResponse](docs/DoubleValueResponse.md)
 - [@KeugsKeugsapis.DoubleValueResponseAllOf](docs/DoubleValueResponseAllOf.md)
 - [@KeugsKeugsapis.Filter](docs/Filter.md)
 - [@KeugsKeugsapis.ForgotPasswordRequest](docs/ForgotPasswordRequest.md)
 - [@KeugsKeugsapis.GenerateInvoiceRequest](docs/GenerateInvoiceRequest.md)
 - [@KeugsKeugsapis.GetBankContactResponse](docs/GetBankContactResponse.md)
 - [@KeugsKeugsapis.GetBankContactResponseAllOf](docs/GetBankContactResponseAllOf.md)
 - [@KeugsKeugsapis.GetCardResponse](docs/GetCardResponse.md)
 - [@KeugsKeugsapis.GetCardResponseAllOf](docs/GetCardResponseAllOf.md)
 - [@KeugsKeugsapis.GetCategoryResponse](docs/GetCategoryResponse.md)
 - [@KeugsKeugsapis.GetCategoryResponseAllOf](docs/GetCategoryResponseAllOf.md)
 - [@KeugsKeugsapis.GetCustomerResponse](docs/GetCustomerResponse.md)
 - [@KeugsKeugsapis.GetCustomerResponseAllOf](docs/GetCustomerResponseAllOf.md)
 - [@KeugsKeugsapis.GetDeliveryResponse](docs/GetDeliveryResponse.md)
 - [@KeugsKeugsapis.GetDeliveryResponseAllOf](docs/GetDeliveryResponseAllOf.md)
 - [@KeugsKeugsapis.GetDeviceResponse](docs/GetDeviceResponse.md)
 - [@KeugsKeugsapis.GetDeviceResponseAllOf](docs/GetDeviceResponseAllOf.md)
 - [@KeugsKeugsapis.GetDispatchResponse](docs/GetDispatchResponse.md)
 - [@KeugsKeugsapis.GetDispatchResponseAllOf](docs/GetDispatchResponseAllOf.md)
 - [@KeugsKeugsapis.GetInvoiceResponse](docs/GetInvoiceResponse.md)
 - [@KeugsKeugsapis.GetInvoiceResponseAllOf](docs/GetInvoiceResponseAllOf.md)
 - [@KeugsKeugsapis.GetItemResponse](docs/GetItemResponse.md)
 - [@KeugsKeugsapis.GetItemResponseAllOf](docs/GetItemResponseAllOf.md)
 - [@KeugsKeugsapis.GetNotificationResponse](docs/GetNotificationResponse.md)
 - [@KeugsKeugsapis.GetNotificationResponseAllOf](docs/GetNotificationResponseAllOf.md)
 - [@KeugsKeugsapis.GetPlanResponse](docs/GetPlanResponse.md)
 - [@KeugsKeugsapis.GetPlanResponseAllOf](docs/GetPlanResponseAllOf.md)
 - [@KeugsKeugsapis.GetPriceConfigurationResponse](docs/GetPriceConfigurationResponse.md)
 - [@KeugsKeugsapis.GetPriceConfigurationResponseAllOf](docs/GetPriceConfigurationResponseAllOf.md)
 - [@KeugsKeugsapis.GetPriceResponse](docs/GetPriceResponse.md)
 - [@KeugsKeugsapis.GetPriceResponseAllOf](docs/GetPriceResponseAllOf.md)
 - [@KeugsKeugsapis.GetPurchaseResponse](docs/GetPurchaseResponse.md)
 - [@KeugsKeugsapis.GetPurchaseResponseAllOf](docs/GetPurchaseResponseAllOf.md)
 - [@KeugsKeugsapis.GetRatingResponse](docs/GetRatingResponse.md)
 - [@KeugsKeugsapis.GetRatingResponseAllOf](docs/GetRatingResponseAllOf.md)
 - [@KeugsKeugsapis.GetRegionResponse](docs/GetRegionResponse.md)
 - [@KeugsKeugsapis.GetRegionResponseAllOf](docs/GetRegionResponseAllOf.md)
 - [@KeugsKeugsapis.GetRoleResponse](docs/GetRoleResponse.md)
 - [@KeugsKeugsapis.GetRoleResponseAllOf](docs/GetRoleResponseAllOf.md)
 - [@KeugsKeugsapis.GetStoreResponse](docs/GetStoreResponse.md)
 - [@KeugsKeugsapis.GetStoreResponseAllOf](docs/GetStoreResponseAllOf.md)
 - [@KeugsKeugsapis.GetSubscriptionResponse](docs/GetSubscriptionResponse.md)
 - [@KeugsKeugsapis.GetSubscriptionResponseAllOf](docs/GetSubscriptionResponseAllOf.md)
 - [@KeugsKeugsapis.GetTransactionResponse](docs/GetTransactionResponse.md)
 - [@KeugsKeugsapis.GetTransactionResponseAllOf](docs/GetTransactionResponseAllOf.md)
 - [@KeugsKeugsapis.GetUserResponse](docs/GetUserResponse.md)
 - [@KeugsKeugsapis.GetUserResponseAllOf](docs/GetUserResponseAllOf.md)
 - [@KeugsKeugsapis.GetVehicleResponse](docs/GetVehicleResponse.md)
 - [@KeugsKeugsapis.GetVehicleResponseAllOf](docs/GetVehicleResponseAllOf.md)
 - [@KeugsKeugsapis.GetWalletResponse](docs/GetWalletResponse.md)
 - [@KeugsKeugsapis.GetWalletResponseAllOf](docs/GetWalletResponseAllOf.md)
 - [@KeugsKeugsapis.GetWorkspaceResponse](docs/GetWorkspaceResponse.md)
 - [@KeugsKeugsapis.GetWorkspaceResponseAllOf](docs/GetWorkspaceResponseAllOf.md)
 - [@KeugsKeugsapis.GetZoneResponse](docs/GetZoneResponse.md)
 - [@KeugsKeugsapis.GetZoneResponseAllOf](docs/GetZoneResponseAllOf.md)
 - [@KeugsKeugsapis.GpsPriceConfiguration](docs/GpsPriceConfiguration.md)
 - [@KeugsKeugsapis.InitializeTransactionRequest](docs/InitializeTransactionRequest.md)
 - [@KeugsKeugsapis.InitializeTransactionResponse](docs/InitializeTransactionResponse.md)
 - [@KeugsKeugsapis.InitializeTransactionResponseAllOf](docs/InitializeTransactionResponseAllOf.md)
 - [@KeugsKeugsapis.InitializedTransaction](docs/InitializedTransaction.md)
 - [@KeugsKeugsapis.InlineObject](docs/InlineObject.md)
 - [@KeugsKeugsapis.Invoice](docs/Invoice.md)
 - [@KeugsKeugsapis.InvoiceResponse](docs/InvoiceResponse.md)
 - [@KeugsKeugsapis.InvoiceResponseAllOf](docs/InvoiceResponseAllOf.md)
 - [@KeugsKeugsapis.InvoiceStatus](docs/InvoiceStatus.md)
 - [@KeugsKeugsapis.Item](docs/Item.md)
 - [@KeugsKeugsapis.ItemResponse](docs/ItemResponse.md)
 - [@KeugsKeugsapis.ItemResponseAllOf](docs/ItemResponseAllOf.md)
 - [@KeugsKeugsapis.KindExpression](docs/KindExpression.md)
 - [@KeugsKeugsapis.LineItem](docs/LineItem.md)
 - [@KeugsKeugsapis.Location](docs/Location.md)
 - [@KeugsKeugsapis.Notification](docs/Notification.md)
 - [@KeugsKeugsapis.NotificationRequest](docs/NotificationRequest.md)
 - [@KeugsKeugsapis.NotificationResponse](docs/NotificationResponse.md)
 - [@KeugsKeugsapis.NotificationResponseAllOf](docs/NotificationResponseAllOf.md)
 - [@KeugsKeugsapis.NotificationSetting](docs/NotificationSetting.md)
 - [@KeugsKeugsapis.NotificationType](docs/NotificationType.md)
 - [@KeugsKeugsapis.PaymentMethod](docs/PaymentMethod.md)
 - [@KeugsKeugsapis.PaymentRequest](docs/PaymentRequest.md)
 - [@KeugsKeugsapis.PaymentServiceType](docs/PaymentServiceType.md)
 - [@KeugsKeugsapis.Permission](docs/Permission.md)
 - [@KeugsKeugsapis.Plan](docs/Plan.md)
 - [@KeugsKeugsapis.PlanResponse](docs/PlanResponse.md)
 - [@KeugsKeugsapis.PlanResponseAllOf](docs/PlanResponseAllOf.md)
 - [@KeugsKeugsapis.Polygon](docs/Polygon.md)
 - [@KeugsKeugsapis.PriceConfiguration](docs/PriceConfiguration.md)
 - [@KeugsKeugsapis.PriceConfigurationResponse](docs/PriceConfigurationResponse.md)
 - [@KeugsKeugsapis.PriceConfigurationResponseAllOf](docs/PriceConfigurationResponseAllOf.md)
 - [@KeugsKeugsapis.PriceEstimate](docs/PriceEstimate.md)
 - [@KeugsKeugsapis.PriceStrategy](docs/PriceStrategy.md)
 - [@KeugsKeugsapis.Projection](docs/Projection.md)
 - [@KeugsKeugsapis.PropertyFilter](docs/PropertyFilter.md)
 - [@KeugsKeugsapis.PropertyOrder](docs/PropertyOrder.md)
 - [@KeugsKeugsapis.PropertyReference](docs/PropertyReference.md)
 - [@KeugsKeugsapis.Purchase](docs/Purchase.md)
 - [@KeugsKeugsapis.PurchaseResponse](docs/PurchaseResponse.md)
 - [@KeugsKeugsapis.PurchaseResponseAllOf](docs/PurchaseResponseAllOf.md)
 - [@KeugsKeugsapis.Query](docs/Query.md)
 - [@KeugsKeugsapis.Rating](docs/Rating.md)
 - [@KeugsKeugsapis.RatingResponse](docs/RatingResponse.md)
 - [@KeugsKeugsapis.RatingResponseAllOf](docs/RatingResponseAllOf.md)
 - [@KeugsKeugsapis.RatingType](docs/RatingType.md)
 - [@KeugsKeugsapis.ReadStatus](docs/ReadStatus.md)
 - [@KeugsKeugsapis.Region](docs/Region.md)
 - [@KeugsKeugsapis.RegionResponse](docs/RegionResponse.md)
 - [@KeugsKeugsapis.RegionResponseAllOf](docs/RegionResponseAllOf.md)
 - [@KeugsKeugsapis.RegionStatus](docs/RegionStatus.md)
 - [@KeugsKeugsapis.ResetPasswordRequest](docs/ResetPasswordRequest.md)
 - [@KeugsKeugsapis.Role](docs/Role.md)
 - [@KeugsKeugsapis.RoleResponse](docs/RoleResponse.md)
 - [@KeugsKeugsapis.RoleResponseAllOf](docs/RoleResponseAllOf.md)
 - [@KeugsKeugsapis.Store](docs/Store.md)
 - [@KeugsKeugsapis.StoreResponse](docs/StoreResponse.md)
 - [@KeugsKeugsapis.StoreResponseAllOf](docs/StoreResponseAllOf.md)
 - [@KeugsKeugsapis.StoreType](docs/StoreType.md)
 - [@KeugsKeugsapis.SubscribeRequest](docs/SubscribeRequest.md)
 - [@KeugsKeugsapis.Subscription](docs/Subscription.md)
 - [@KeugsKeugsapis.SubscriptionResponse](docs/SubscriptionResponse.md)
 - [@KeugsKeugsapis.SubscriptionResponseAllOf](docs/SubscriptionResponseAllOf.md)
 - [@KeugsKeugsapis.SubscriptionStatus](docs/SubscriptionStatus.md)
 - [@KeugsKeugsapis.Transaction](docs/Transaction.md)
 - [@KeugsKeugsapis.TransactionDetails](docs/TransactionDetails.md)
 - [@KeugsKeugsapis.TransactionEntryType](docs/TransactionEntryType.md)
 - [@KeugsKeugsapis.TransactionResponse](docs/TransactionResponse.md)
 - [@KeugsKeugsapis.TransactionResponseAllOf](docs/TransactionResponseAllOf.md)
 - [@KeugsKeugsapis.TransactionStatus](docs/TransactionStatus.md)
 - [@KeugsKeugsapis.TransactionType](docs/TransactionType.md)
 - [@KeugsKeugsapis.TransferFundRequest](docs/TransferFundRequest.md)
 - [@KeugsKeugsapis.UpdateCategory](docs/UpdateCategory.md)
 - [@KeugsKeugsapis.UpdateCustomer](docs/UpdateCustomer.md)
 - [@KeugsKeugsapis.UpdateDelivery](docs/UpdateDelivery.md)
 - [@KeugsKeugsapis.UpdateDispatch](docs/UpdateDispatch.md)
 - [@KeugsKeugsapis.UpdateInvoice](docs/UpdateInvoice.md)
 - [@KeugsKeugsapis.UpdateItem](docs/UpdateItem.md)
 - [@KeugsKeugsapis.UpdatePermission](docs/UpdatePermission.md)
 - [@KeugsKeugsapis.UpdatePriceConfiguration](docs/UpdatePriceConfiguration.md)
 - [@KeugsKeugsapis.UpdateRole](docs/UpdateRole.md)
 - [@KeugsKeugsapis.UpdateStore](docs/UpdateStore.md)
 - [@KeugsKeugsapis.UpdateUser](docs/UpdateUser.md)
 - [@KeugsKeugsapis.UpdateVehicle](docs/UpdateVehicle.md)
 - [@KeugsKeugsapis.UpdateWallet](docs/UpdateWallet.md)
 - [@KeugsKeugsapis.UpdateWorkspace](docs/UpdateWorkspace.md)
 - [@KeugsKeugsapis.Upload](docs/Upload.md)
 - [@KeugsKeugsapis.UploadType](docs/UploadType.md)
 - [@KeugsKeugsapis.User](docs/User.md)
 - [@KeugsKeugsapis.UserResponse](docs/UserResponse.md)
 - [@KeugsKeugsapis.UserResponseAllOf](docs/UserResponseAllOf.md)
 - [@KeugsKeugsapis.UserRole](docs/UserRole.md)
 - [@KeugsKeugsapis.UserRoleResponse](docs/UserRoleResponse.md)
 - [@KeugsKeugsapis.UserRoleResponseAllOf](docs/UserRoleResponseAllOf.md)
 - [@KeugsKeugsapis.UserStatus](docs/UserStatus.md)
 - [@KeugsKeugsapis.UserType](docs/UserType.md)
 - [@KeugsKeugsapis.UserWorkspace](docs/UserWorkspace.md)
 - [@KeugsKeugsapis.Vehicle](docs/Vehicle.md)
 - [@KeugsKeugsapis.VehicleResponse](docs/VehicleResponse.md)
 - [@KeugsKeugsapis.VehicleResponseAllOf](docs/VehicleResponseAllOf.md)
 - [@KeugsKeugsapis.VehicleType](docs/VehicleType.md)
 - [@KeugsKeugsapis.Wallet](docs/Wallet.md)
 - [@KeugsKeugsapis.WalletResponse](docs/WalletResponse.md)
 - [@KeugsKeugsapis.WalletResponseAllOf](docs/WalletResponseAllOf.md)
 - [@KeugsKeugsapis.WalletStatus](docs/WalletStatus.md)
 - [@KeugsKeugsapis.WalletType](docs/WalletType.md)
 - [@KeugsKeugsapis.WithdrawFundRequest](docs/WithdrawFundRequest.md)
 - [@KeugsKeugsapis.Workspace](docs/Workspace.md)
 - [@KeugsKeugsapis.WorkspacePreference](docs/WorkspacePreference.md)
 - [@KeugsKeugsapis.WorkspaceResponse](docs/WorkspaceResponse.md)
 - [@KeugsKeugsapis.WorkspaceResponseAllOf](docs/WorkspaceResponseAllOf.md)
 - [@KeugsKeugsapis.WorkspaceStatus](docs/WorkspaceStatus.md)
 - [@KeugsKeugsapis.WorkspaceType](docs/WorkspaceType.md)
 - [@KeugsKeugsapis.Zone](docs/Zone.md)
 - [@KeugsKeugsapis.ZoneResponse](docs/ZoneResponse.md)
 - [@KeugsKeugsapis.ZoneResponseAllOf](docs/ZoneResponseAllOf.md)
 - [@KeugsKeugsapis.ZoneStatus](docs/ZoneStatus.md)


## Documentation for Authorization



### ApiKeyAuth


- **Type**: API key
- **API key parameter name**: X-KEUGS-KEY
- **Location**: HTTP header



### bearerAuth

- **Type**: Bearer authentication (JWT)