pointpos_api 0.2.2 copy "pointpos_api: ^0.2.2" to clipboard
pointpos_api: ^0.2.2 copied to clipboard

unlisted

PointPOS API client

pointpos_api #

PointByte API Specification

This Dart package is automatically generated by the Open API Codegen project:

  • API version: 0.2.2
  • Build package: org.openapitools.codegen.languages.DartJaguarClientCodegen

Requirements #

Dart 2 or later OR Flutter 0.7.0 or later.

Once your code is generated, you need to run the build_runner command to let Jaguar implement your API:

flutter packages pub run build_runner build
or
pub run build_runner build

Installation & Usage #

Github #

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

name: pointpos_api
version: 0.2.2
description: OpenAPI API client
dependencies:
  pointpos_api:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
      version: 'any'

Local #

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

dependencies:
  pointpos_api:
    path: /path/to/pointpos_api

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
//pointpos_api.api.Configuration.apiKey{'Authorization'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//pointpos_api.api.Configuration.apiKeyPrefix{'Authorization'} = "Bearer";

final jaguarApiGen = PointposApi();
var api_instance = jaguarApiGen.getAdjustmentStockApi();
var authorization = authorization_example; // String | JWT Authorization
var xAPIKey = xAPIKey_example; // String | API Key
var body = new AdjustmentStock(); // AdjustmentStock | 
var xPin = xPin_example; // String | PIN Number

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

Documentation for API Endpoints #

All URIs are relative to http://localhost

Class Method HTTP request Description
AdjustmentStockApi createAdjustmentStock Post /adjustment-stock Create AdjustmentStock
AdjustmentStockApi findAdjustmentStock Get /adjustment-stock Get AdjustmentStock List
AdjustmentStockApi getAdjustmentStockByID Get /adjustment-stock/:id Get AdjustmentStock By ID
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
DocumentApi uploadDocument Post /document Upload Document
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 createItemImage Post /item/:id/image Create Item Image
ItemApi deleteItemByID Delete /item/:id Delete Item By ID
ItemApi deleteItemImageByID Delete /item/:id/image/:imageId Delete Item Image 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
ItemApi updateItemImageByID Put /item/:id/image/:imageId Update Item Image 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 changePassword Post /merchant/change-password Merchant Change Password
MerchantApi checkResetToken Get /merchant/reset-password/:resetToken Check Reset Token
MerchantApi forgotPassword Post /merchant/forgot-password Merchant Forgot Password
MerchantApi getProfile Get /merchant/profile Merchant Get Profile
MerchantApi login Post /merchant/login Merchant Login
MerchantApi refreshToken Post /merchant/refresh-token Refresh Session
MerchantApi resendEmailVerification Post /merchant/verification Resend Email Verification
MerchantApi resetPassword Post /merchant/reset-password Merchant Reset Password
MerchantApi signup Post /merchant/signup Merchant Signup
MerchantApi updateProfile Post /merchant/profile Merchant Update Profile
MerchantApi verification Post /merchant/verification/:token Email Verification
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 createFeedback Post /order/:id/feedback Create Feedback
OrderApi createOrder Post /order Create Order
OrderApi createRefundByOrderID Post /order/:id/refund Create Refund By Order ID
OrderApi createSendReceiptByOrderID Post /order/:id/send-receipt Create Send Receipt By Order ID
OrderApi deleteOrderByID Delete /order/:id Delete Order By ID
OrderApi findFeedback Get /order/feedback Get Feedback List
OrderApi findOrder Get /order Get Order List
OrderApi getFeedbackByID Get /order/:id/feedback Get Feedback By ID
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
PaymentConfigurationApi createPaymentConfiguration Post /payment-configuration Create PaymentConfiguration
PaymentConfigurationApi deletePaymentConfigurationByID Delete /payment-configuration/:id Delete PaymentConfiguration By ID
PaymentConfigurationApi findPaymentConfiguration Get /payment-configuration Get PaymentConfiguration List
PaymentConfigurationApi getPaymentConfigurationByID Get /payment-configuration/:id Get PaymentConfiguration By ID
PaymentConfigurationApi updatePaymentConfigurationByID Put /payment-configuration/:id Update PaymentConfiguration 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/:id Delete Purchaseorder By ID
PurchaseOrderApi findPurchaseorder Get /purchase-order Get Purchaseorder List
PurchaseOrderApi getPurchaseorderByID Get /purchase-order/:id Get Purchaseorder By ID
PurchaseOrderApi updatePurchaseorderByID Put /purchase-order/:id 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
ReportsApi getReportsSales Get /reports/:grouping Get Reports Sales Summary
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/:id Delete Salestype By ID
SalesTypeApi findSalestype Get /sales-type Get Salestype List
SalesTypeApi getSalestypeByID Get /sales-type/:id Get Salestype By ID
SalesTypeApi updateSalestypeByID Put /sales-type/:id Update Salestype By ID
ShiftApi endCurrentShift Post /shift/end End current shift
ShiftApi getCurrentShift Get /shift/current Get current shift
ShiftApi getShiftById Get /shift/:id Get Shift By Id
ShiftApi getShifts Get /shift Get Shift List
ShiftApi startShift Post /shift Start Shift
SplashScreenApi createSplashScreen Post /splash-screen Create Splash Screen
SplashScreenApi deleteSplashScreentByID Delete /splash-screen/:id Delete Splash Screen By ID
SplashScreenApi findSplashScreen Get /splash-screen Get Splash Screen List
SplashScreenApi getSplashScreenByID Get /splash-screen/:id Get Splash Screen By ID
SplashScreenApi updateSplashScreenByID Put /splash-screen/:id Update Splash Screen 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 #

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 #