pointpos_api 0.0.5

PointPOS API client

pointpos_api

PointByte API Specification

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

• API version: 0.0.1
• Build package: org.openapitools.codegen.languages.DartClientCodegen

Requirements

Dart 2.0 or later

Installation & Usage

dependencies:
  pointpos_api: ^0.0.3

Tests

TODO

Getting Started

Please follow the installation procedure and then run the following:

import 'package:pointpos_api/api.dart';

// TODO Configure API key authorization: JWT
//defaultApiClient.getAuthentication<ApiKeyAuth>('JWT').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('JWT').apiKeyPrefix = 'Bearer';

var api_instance = CustomerApi();
var authorization = authorization_example; // String | JWT Authorization
var xAPIKey = xAPIKey_example; // String | API Key
var body = Customer(); // Customer | 

try {
    var result = api_instance.createCustomer(authorization, xAPIKey, body);
    print(result);
} catch (e) {
    print("Exception when calling CustomerApi->createCustomer: $e\n");
}

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
CustomerApi	createCustomer	POST /customer	Create Customer
CustomerApi	deleteCustomerByID	DELETE /customer/{id}	Delete Customer By ID
CustomerApi	findCustomer	GET /customer	Get Customer List
CustomerApi	getCustomerByID	GET /customer/{id}	Get Customer By ID
CustomerApi	updateCustomerByID	PUT /customer/{id}	Update Customer By ID
DiscountApi	createDiscount	POST /discount	Create Discount
DiscountApi	deleteDiscountByID	DELETE /discount/{id}	Delete Discount By ID
DiscountApi	findDiscount	GET /discount	Get Discount List
DiscountApi	getDiscountByID	GET /discount/{id}	Get Discount By ID
DiscountApi	updateDiscountByID	PUT /discount/{id}	Update Discount By ID
EmployeeApi	createEmployee	POST /employee	Create Employee
EmployeeApi	deleteEmployeeByID	DELETE /employee/{id}	Delete Employee By ID
EmployeeApi	findEmployee	GET /employee	Get Employee List
EmployeeApi	getEmployeeByID	GET /employee/{id}	Get Employee By ID
EmployeeApi	updateEmployeeByID	PUT /employee/{id}	Update Employee By ID
GratuityApi	createGratuity	POST /gratuity	Create Gratuity
GratuityApi	deleteGratuityByID	DELETE /gratuity/{id}	Delete Gratuity By ID
GratuityApi	findGratuity	GET /gratuity	Get Gratuity List
GratuityApi	getGratuityByID	GET /gratuity/{id}	Get Gratuity By ID
GratuityApi	updateGratuityByID	PUT /gratuity/{id}	Update Gratuity By ID
IngredientApi	createIngredient	POST /ingredient	Create Ingredient
IngredientApi	deleteIngredientByID	DELETE /ingredient/{id}	Delete Ingredient By ID
IngredientApi	findIngredient	GET /ingredient	Get Ingredient List
IngredientApi	getIngredientByID	GET /ingredient/{id}	Get Ingredient By ID
IngredientApi	updateIngredientByID	PUT /ingredient/{id}	Update Ingredient By ID
IngredientCategoryApi	createIngredientcategory	POST /ingredient-category	Create Ingredientcategory
IngredientCategoryApi	deleteIngredientcategoryByID	DELETE /ingredient-category/{id}	Delete Ingredientcategory By ID
IngredientCategoryApi	findIngredientcategory	GET /ingredient-category	Get Ingredientcategory List
IngredientCategoryApi	getIngredientcategoryByID	GET /ingredient-category/{id}	Get Ingredientcategory By ID
IngredientCategoryApi	updateIngredientcategoryByID	PUT /ingredient-category/{id}	Update Ingredientcategory By ID
ItemApi	createItem	POST /item	Create Item
ItemApi	deleteItemByID	DELETE /item/{id}	Delete Item By ID
ItemApi	findItem	GET /item	Get Item List
ItemApi	getItemByID	GET /item/{id}	Get Item By ID
ItemApi	updateItemByID	PUT /item/{id}	Update Item By ID
ItemCategoryApi	createItemcategory	POST /item-category	Create Itemcategory
ItemCategoryApi	deleteItemcategoryByID	DELETE /item-category/{id}	Delete Itemcategory By ID
ItemCategoryApi	findItemcategory	GET /item-category	Get Itemcategory List
ItemCategoryApi	getItemcategoryByID	GET /item-category/{id}	Get Itemcategory By ID
ItemCategoryApi	updateItemcategoryByID	PUT /item-category/{id}	Update Itemcategory By ID
LoyaltyProgramApi	createLoyaltyprogram	POST /loyalty-program	Create Loyaltyprogram
LoyaltyProgramApi	deleteLoyaltyprogramByID	DELETE /loyalty-program/{id}	Delete Loyaltyprogram By ID
LoyaltyProgramApi	findLoyaltyprogram	GET /loyalty-program	Get Loyaltyprogram List
LoyaltyProgramApi	getLoyaltyprogramByID	GET /loyalty-program/{id}	Get Loyaltyprogram By ID
LoyaltyProgramApi	updateLoyaltyprogramByID	PUT /loyalty-program/{id}	Update Loyaltyprogram By ID
MerchantApi	login	POST /merchant/login	Merchant Login
MerchantApi	signup	POST /merchant/signup	Merchant Signup
MerchantAccountApi	createMerchantaccount	POST /merchant	Create Merchantaccount
MerchantAccountApi	deleteMerchantaccountByID	DELETE /merchant/{id}	Delete Merchantaccount By ID
MerchantAccountApi	findMerchantaccount	GET /merchant	Get Merchantaccount List
MerchantAccountApi	getMerchantaccountByID	GET /merchant/{id}	Get Merchantaccount By ID
MerchantAccountApi	updateMerchantaccountByID	PUT /merchant/{id}	Update Merchantaccount By ID
ModifierApi	createModifier	POST /modifier	Create Modifier
ModifierApi	deleteModifierByID	DELETE /modifier/{id}	Delete Modifier By ID
ModifierApi	findModifier	GET /modifier	Get Modifier List
ModifierApi	getModifierByID	GET /modifier/{id}	Get Modifier By ID
ModifierApi	updateModifierByID	PUT /modifier/{id}	Update Modifier By ID
OrderApi	createOrder	POST /order	Create Order
OrderApi	deleteOrderByID	DELETE /order/{id}	Delete Order By ID
OrderApi	findOrder	GET /order	Get Order List
OrderApi	getOrderByID	GET /order/{id}	Get Order By ID
OrderApi	updateOrderByID	PUT /order/{id}	Update Order By ID
OutletApi	createOutlet	POST /outlet	Create Outlet
OutletApi	deleteOutletByID	DELETE /outlet/{id}	Delete Outlet By ID
OutletApi	findOutlet	GET /outlet	Get Outlet List
OutletApi	getOutletByID	GET /outlet/{id}	Get Outlet By ID
OutletApi	updateOutletByID	PUT /outlet/{id}	Update Outlet By ID
PromoApi	createPromo	POST /promo	Create Promo
PromoApi	deletePromoByID	DELETE /promo/{id}	Delete Promo By ID
PromoApi	findPromo	GET /promo	Get Promo List
PromoApi	getPromoByID	GET /promo/{id}	Get Promo By ID
PromoApi	updatePromoByID	PUT /promo/{id}	Update Promo By ID
PurchaseOrderApi	createPurchaseorder	POST /purchase-order	Create Purchaseorder
PurchaseOrderApi	deletePurchaseorderByID	DELETE /purchase-order/{outletId}	Delete Purchaseorder By ID
PurchaseOrderApi	findPurchaseorder	GET /purchase-order	Get Purchaseorder List
PurchaseOrderApi	getPurchaseorderByID	GET /purchase-order/{outletId}	Get Purchaseorder By ID
PurchaseOrderApi	updatePurchaseorderByID	PUT /purchase-order/{outletId}	Update Purchaseorder By ID
RecipeApi	createRecipe	POST /recipe	Create Recipe
RecipeApi	deleteRecipeByID	DELETE /recipe/{itemId}	Delete Recipe By ID
RecipeApi	findRecipe	GET /recipe	Get Recipe List
RecipeApi	getRecipeByID	GET /recipe/{itemId}	Get Recipe By ID
RecipeApi	updateRecipeByID	PUT /recipe/{itemId}	Update Recipe By ID
RoleApi	createRole	POST /role	Create Role
RoleApi	deleteRoleByID	DELETE /role/{id}	Delete Role By ID
RoleApi	findRole	GET /role	Get Role List
RoleApi	getRoleByID	GET /role/{id}	Get Role By ID
RoleApi	updateRoleByID	PUT /role/{id}	Update Role By ID
RolePermissionApi	createRolepermission	POST /role-permission	Create Rolepermission
RolePermissionApi	deleteRolepermissionByID	DELETE /role-permission/{id}	Delete Rolepermission By ID
RolePermissionApi	findRolepermission	GET /role-permission	Get Rolepermission List
RolePermissionApi	getRolepermissionByID	GET /role-permission/{id}	Get Rolepermission By ID
RolePermissionApi	updateRolepermissionByID	PUT /role-permission/{id}	Update Rolepermission By ID
SalesTypeApi	createSalestype	POST /sales-type	Create Salestype
SalesTypeApi	deleteSalestypeByID	DELETE /sales-type/{name}	Delete Salestype By ID
SalesTypeApi	findSalestype	GET /sales-type	Get Salestype List
SalesTypeApi	getSalestypeByID	GET /sales-type/{name}	Get Salestype By ID
SalesTypeApi	updateSalestypeByID	PUT /sales-type/{name}	Update Salestype By ID
SupplierApi	createSupplier	POST /supplier	Create Supplier
SupplierApi	deleteSupplierByID	DELETE /supplier/{id}	Delete Supplier By ID
SupplierApi	findSupplier	GET /supplier	Get Supplier List
SupplierApi	getSupplierByID	GET /supplier/{id}	Get Supplier By ID
SupplierApi	updateSupplierByID	PUT /supplier/{id}	Update Supplier By ID
TableApi	createTable	POST /table	Create Table
TableApi	deleteTableByID	DELETE /table/{id}	Delete Table By ID
TableApi	findTable	GET /table	Get Table List
TableApi	getTableByID	GET /table/{id}	Get Table By ID
TableApi	updateTableByID	PUT /table/{id}	Update Table By ID
TableGroupApi	createTablegroup	POST /table-group	Create Tablegroup
TableGroupApi	deleteTablegroupByID	DELETE /table-group/{id}	Delete Tablegroup By ID
TableGroupApi	findTablegroup	GET /table-group	Get Tablegroup List
TableGroupApi	getTablegroupByID	GET /table-group/{id}	Get Tablegroup By ID
TableGroupApi	updateTablegroupByID	PUT /table-group/{id}	Update Tablegroup By ID
TaxApi	createTax	POST /tax	Create Tax
TaxApi	deleteTaxByID	DELETE /tax/{id}	Delete Tax By ID
TaxApi	findTax	GET /tax	Get Tax List
TaxApi	getTaxByID	GET /tax/{id}	Get Tax By ID
TaxApi	updateTaxByID	PUT /tax/{id}	Update Tax By ID
UnitApi	createUnit	POST /unit	Create Unit
UnitApi	deleteUnitByID	DELETE /unit/{id}	Delete Unit By ID
UnitApi	findUnit	GET /unit	Get Unit List
UnitApi	getUnitByID	GET /unit/{id}	Get Unit By ID
UnitApi	updateUnitByID	PUT /unit/{id}	Update Unit By ID

Documentation For Models

• Customer
• Discount
• Employee
• Exception
• ForbiddenException
• Gratuity
• Ingredient
• IngredientCategory
• IngredientCostOfGoodsSold
• IngredientInventory
• InlineResponse200
• InternalServerErrorException
• Item
• ItemCategory
• ItemCostOfGoodsSold
• ItemInventory
• ItemVariants
• Login
• LoyaltyProgram
• LoyaltyProgramPointFromBuyItem
• LoyaltyProgramPointFromBuyItemEligibleCategories
• LoyaltyProgramPointFromBuyItemEligibleItems
• LoyaltyProgramPointFromTotalSpent
• LoyaltyProgramRedeemRules
• MerchantAccount
• MerchantAccountBusinessInfo
• MerchantAccountIdentification
• MerchantAccountPersonalDetails
• MerchantAccountPersonalDetailsEmail
• MerchantAccountPersonalDetailsPhone
• MerchantAccountPublicProfile
• Modifier
• ModifierOptions
• NotFoundException
• Order
• OrderCash
• OrderDiscounts
• OrderItems
• OrderModifiers
• OrderPayments
• OrderSentReceipts
• Outlet
• OutletReceiptSettings
• OutletReceiptSettingsOutletInfo
• Promo
• PromoPromoPeriod
• PromoPromoPeriodDateRange
• PromoPromoPeriodTimeRange
• PromoPromoPeriodWeekDay
• PromoRequirement
• PromoRequirementEligibleCategories
• PromoRequirementEligibleItems
• PromoReward
• PromoRewardDiscount
• PurchaseOrder
• PurchaseOrderIngredients
• Recipe
• RecipeIngredients
• Role
• RolePermission
• SalesType
• Signup
• Supplier
• Table
• TableGroup
• TableLocation
• Tax
• UnauthorizedException
• Unit
• ValidationException

Documentation For Authorization

APIKey

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

JWT

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Author