pointpos_api

PointByte API Specification

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

  • API version: 0.0.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: 1.0.0
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.getCustomerApi();
var authorization = authorization_example; // String | JWT Authorization
var xAPIKey = xAPIKey_example; // String | API Key
var body = new 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

ClassMethodHTTP requestDescription
CustomerApicreateCustomerPost /customerCreate Customer
CustomerApideleteCustomerByIDDelete /customer/:idDelete Customer By ID
CustomerApifindCustomerGet /customerGet Customer List
CustomerApigetCustomerByIDGet /customer/:idGet Customer By ID
CustomerApiupdateCustomerByIDPut /customer/:idUpdate Customer By ID
DiscountApicreateDiscountPost /discountCreate Discount
DiscountApideleteDiscountByIDDelete /discount/:idDelete Discount By ID
DiscountApifindDiscountGet /discountGet Discount List
DiscountApigetDiscountByIDGet /discount/:idGet Discount By ID
DiscountApiupdateDiscountByIDPut /discount/:idUpdate Discount By ID
EmployeeApicreateEmployeePost /employeeCreate Employee
EmployeeApideleteEmployeeByIDDelete /employee/:idDelete Employee By ID
EmployeeApifindEmployeeGet /employeeGet Employee List
EmployeeApigetEmployeeByIDGet /employee/:idGet Employee By ID
EmployeeApiupdateEmployeeByIDPut /employee/:idUpdate Employee By ID
GratuityApicreateGratuityPost /gratuityCreate Gratuity
GratuityApideleteGratuityByIDDelete /gratuity/:idDelete Gratuity By ID
GratuityApifindGratuityGet /gratuityGet Gratuity List
GratuityApigetGratuityByIDGet /gratuity/:idGet Gratuity By ID
GratuityApiupdateGratuityByIDPut /gratuity/:idUpdate Gratuity By ID
IngredientApicreateIngredientPost /ingredientCreate Ingredient
IngredientApideleteIngredientByIDDelete /ingredient/:idDelete Ingredient By ID
IngredientApifindIngredientGet /ingredientGet Ingredient List
IngredientApigetIngredientByIDGet /ingredient/:idGet Ingredient By ID
IngredientApiupdateIngredientByIDPut /ingredient/:idUpdate Ingredient By ID
IngredientCategoryApicreateIngredientcategoryPost /ingredient-categoryCreate Ingredientcategory
IngredientCategoryApideleteIngredientcategoryByIDDelete /ingredient-category/:idDelete Ingredientcategory By ID
IngredientCategoryApifindIngredientcategoryGet /ingredient-categoryGet Ingredientcategory List
IngredientCategoryApigetIngredientcategoryByIDGet /ingredient-category/:idGet Ingredientcategory By ID
IngredientCategoryApiupdateIngredientcategoryByIDPut /ingredient-category/:idUpdate Ingredientcategory By ID
ItemApicreateItemPost /itemCreate Item
ItemApideleteItemByIDDelete /item/:idDelete Item By ID
ItemApifindItemGet /itemGet Item List
ItemApigetItemByIDGet /item/:idGet Item By ID
ItemApiupdateItemByIDPut /item/:idUpdate Item By ID
ItemCategoryApicreateItemcategoryPost /item-categoryCreate Itemcategory
ItemCategoryApideleteItemcategoryByIDDelete /item-category/:idDelete Itemcategory By ID
ItemCategoryApifindItemcategoryGet /item-categoryGet Itemcategory List
ItemCategoryApigetItemcategoryByIDGet /item-category/:idGet Itemcategory By ID
ItemCategoryApiupdateItemcategoryByIDPut /item-category/:idUpdate Itemcategory By ID
LoyaltyProgramApicreateLoyaltyprogramPost /loyalty-programCreate Loyaltyprogram
LoyaltyProgramApideleteLoyaltyprogramByIDDelete /loyalty-program/:idDelete Loyaltyprogram By ID
LoyaltyProgramApifindLoyaltyprogramGet /loyalty-programGet Loyaltyprogram List
LoyaltyProgramApigetLoyaltyprogramByIDGet /loyalty-program/:idGet Loyaltyprogram By ID
LoyaltyProgramApiupdateLoyaltyprogramByIDPut /loyalty-program/:idUpdate Loyaltyprogram By ID
MerchantApichangePasswordPost /merchant/change-passwordMerchant Change Password
MerchantApicheckResetTokenGet /merchant/reset-password/:resetTokenCheck Reset Token
MerchantApiforgotPasswordPost /merchant/forgot-passwordMerchant Forgot Password
MerchantApigetProfileGet /merchant/profileMerchant Get Profile
MerchantApiloginPost /merchant/loginMerchant Login
MerchantApirefreshTokenPost /merchant/refresh-tokenRefresh Session
MerchantApiresetPasswordPost /merchant/reset-passwordMerchant Reset Password
MerchantApisignupPost /merchant/signupMerchant Signup
MerchantApiupdateProfilePost /merchant/profileMerchant Update Profile
MerchantAccountApicreateMerchantaccountPost /merchantCreate Merchantaccount
MerchantAccountApideleteMerchantaccountByIDDelete /merchant/:idDelete Merchantaccount By ID
MerchantAccountApifindMerchantaccountGet /merchantGet Merchantaccount List
MerchantAccountApigetMerchantaccountByIDGet /merchant/:idGet Merchantaccount By ID
MerchantAccountApiupdateMerchantaccountByIDPut /merchant/:idUpdate Merchantaccount By ID
ModifierApicreateModifierPost /modifierCreate Modifier
ModifierApideleteModifierByIDDelete /modifier/:idDelete Modifier By ID
ModifierApifindModifierGet /modifierGet Modifier List
ModifierApigetModifierByIDGet /modifier/:idGet Modifier By ID
ModifierApiupdateModifierByIDPut /modifier/:idUpdate Modifier By ID
OrderApicreateOrderPost /orderCreate Order
OrderApideleteOrderByIDDelete /order/:idDelete Order By ID
OrderApifindOrderGet /orderGet Order List
OrderApigetOrderByIDGet /order/:idGet Order By ID
OrderApiupdateOrderByIDPut /order/:idUpdate Order By ID
OutletApicreateOutletPost /outletCreate Outlet
OutletApideleteOutletByIDDelete /outlet/:idDelete Outlet By ID
OutletApifindOutletGet /outletGet Outlet List
OutletApigetOutletByIDGet /outlet/:idGet Outlet By ID
OutletApiupdateOutletByIDPut /outlet/:idUpdate Outlet By ID
PromoApicreatePromoPost /promoCreate Promo
PromoApideletePromoByIDDelete /promo/:idDelete Promo By ID
PromoApifindPromoGet /promoGet Promo List
PromoApigetPromoByIDGet /promo/:idGet Promo By ID
PromoApiupdatePromoByIDPut /promo/:idUpdate Promo By ID
PurchaseOrderApicreatePurchaseorderPost /purchase-orderCreate Purchaseorder
PurchaseOrderApideletePurchaseorderByIDDelete /purchase-order/:outletIdDelete Purchaseorder By ID
PurchaseOrderApifindPurchaseorderGet /purchase-orderGet Purchaseorder List
PurchaseOrderApigetPurchaseorderByIDGet /purchase-order/:outletIdGet Purchaseorder By ID
PurchaseOrderApiupdatePurchaseorderByIDPut /purchase-order/:outletIdUpdate Purchaseorder By ID
RecipeApicreateRecipePost /recipeCreate Recipe
RecipeApideleteRecipeByIDDelete /recipe/:itemIdDelete Recipe By ID
RecipeApifindRecipeGet /recipeGet Recipe List
RecipeApigetRecipeByIDGet /recipe/:itemIdGet Recipe By ID
RecipeApiupdateRecipeByIDPut /recipe/:itemIdUpdate Recipe By ID
RoleApicreateRolePost /roleCreate Role
RoleApideleteRoleByIDDelete /role/:idDelete Role By ID
RoleApifindRoleGet /roleGet Role List
RoleApigetRoleByIDGet /role/:idGet Role By ID
RoleApiupdateRoleByIDPut /role/:idUpdate Role By ID
RolePermissionApicreateRolepermissionPost /role-permissionCreate Rolepermission
RolePermissionApideleteRolepermissionByIDDelete /role-permission/:idDelete Rolepermission By ID
RolePermissionApifindRolepermissionGet /role-permissionGet Rolepermission List
RolePermissionApigetRolepermissionByIDGet /role-permission/:idGet Rolepermission By ID
RolePermissionApiupdateRolepermissionByIDPut /role-permission/:idUpdate Rolepermission By ID
SalesTypeApicreateSalestypePost /sales-typeCreate Salestype
SalesTypeApideleteSalestypeByIDDelete /sales-type/:nameDelete Salestype By ID
SalesTypeApifindSalestypeGet /sales-typeGet Salestype List
SalesTypeApigetSalestypeByIDGet /sales-type/:nameGet Salestype By ID
SalesTypeApiupdateSalestypeByIDPut /sales-type/:nameUpdate Salestype By ID
SupplierApicreateSupplierPost /supplierCreate Supplier
SupplierApideleteSupplierByIDDelete /supplier/:idDelete Supplier By ID
SupplierApifindSupplierGet /supplierGet Supplier List
SupplierApigetSupplierByIDGet /supplier/:idGet Supplier By ID
SupplierApiupdateSupplierByIDPut /supplier/:idUpdate Supplier By ID
TableApicreateTablePost /tableCreate Table
TableApideleteTableByIDDelete /table/:idDelete Table By ID
TableApifindTableGet /tableGet Table List
TableApigetTableByIDGet /table/:idGet Table By ID
TableApiupdateTableByIDPut /table/:idUpdate Table By ID
TableGroupApicreateTablegroupPost /table-groupCreate Tablegroup
TableGroupApideleteTablegroupByIDDelete /table-group/:idDelete Tablegroup By ID
TableGroupApifindTablegroupGet /table-groupGet Tablegroup List
TableGroupApigetTablegroupByIDGet /table-group/:idGet Tablegroup By ID
TableGroupApiupdateTablegroupByIDPut /table-group/:idUpdate Tablegroup By ID
TaxApicreateTaxPost /taxCreate Tax
TaxApideleteTaxByIDDelete /tax/:idDelete Tax By ID
TaxApifindTaxGet /taxGet Tax List
TaxApigetTaxByIDGet /tax/:idGet Tax By ID
TaxApiupdateTaxByIDPut /tax/:idUpdate Tax By ID
UnitApicreateUnitPost /unitCreate Unit
UnitApideleteUnitByIDDelete /unit/:idDelete Unit By ID
UnitApifindUnitGet /unitGet Unit List
UnitApigetUnitByIDGet /unit/:idGet Unit By ID
UnitApiupdateUnitByIDPut /unit/:idUpdate 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

Libraries

api_key_auth
auth
basic_auth
change_password
customer
customer_api
discount
discount_api
employee
employee_api
exception
forbidden_exception
forgot_password
gratuity
gratuity_api
ingredient
ingredient_api
ingredient_category
ingredient_category_api
ingredient_cost_of_goods_sold
ingredient_inventory
internal_server_error_exception
item
item_api
item_category
item_category_api
item_cost_of_goods_sold
item_inventory
item_variants
login
loyalty_program
loyalty_program_api
loyalty_program_point_from_buy_item
loyalty_program_point_from_buy_item_eligible_categories
loyalty_program_point_from_buy_item_eligible_items
loyalty_program_point_from_total_spent
loyalty_program_redeem_rules
merchant_account
merchant_account_api
merchant_account_business_info
merchant_account_identification
merchant_account_personal_details
merchant_account_personal_details_email
merchant_account_personal_details_phone
merchant_account_public_profile
merchant_api
modifier
modifier_api
modifier_options
not_found_exception
oauth
order
order_api
order_cash
order_discounts
order_items
order_modifiers
order_payments
order_sent_receipts
outlet
outlet_api
outlet_receipt_settings
outlet_receipt_settings_outlet_info
pointpos_api.api
profile
profile_all_of
promo
promo_api
promo_promo_period
promo_promo_period_date_range
promo_promo_period_time_range
promo_promo_period_week_day
promo_requirement
promo_requirement_eligible_categories
promo_requirement_eligible_items
promo_reward
promo_reward_discount
purchase_order
purchase_order_api
purchase_order_ingredients
recipe
recipe_api
recipe_ingredients
reset_password
role
role_api
role_permission
role_permission_api
sales_type
sales_type_api
signup
signup_all_of
supplier
supplier_api
table
table_api
table_group
table_group_api
table_location
tax
tax_api
token
unauthorized_exception
unit
unit_api
update_profile
validation_exception