pointpos_api 0.0.8

  • Readme
  • Changelog
  • Installing
  • 55

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 #

0.0.7 (2020-06-06) #

  • update using openapi dart-jaguar generator

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  pointpos_api: ^0.0.8

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:pointpos_api/api.dart';
import 'package:pointpos_api/api/customer_api.dart';
import 'package:pointpos_api/api/customer_api.jretro.dart';
import 'package:pointpos_api/api/discount_api.dart';
import 'package:pointpos_api/api/discount_api.jretro.dart';
import 'package:pointpos_api/api/employee_api.dart';
import 'package:pointpos_api/api/employee_api.jretro.dart';
import 'package:pointpos_api/api/gratuity_api.dart';
import 'package:pointpos_api/api/gratuity_api.jretro.dart';
import 'package:pointpos_api/api/ingredient_api.dart';
import 'package:pointpos_api/api/ingredient_api.jretro.dart';
import 'package:pointpos_api/api/ingredient_category_api.dart';
import 'package:pointpos_api/api/ingredient_category_api.jretro.dart';
import 'package:pointpos_api/api/item_api.dart';
import 'package:pointpos_api/api/item_api.jretro.dart';
import 'package:pointpos_api/api/item_category_api.dart';
import 'package:pointpos_api/api/item_category_api.jretro.dart';
import 'package:pointpos_api/api/loyalty_program_api.dart';
import 'package:pointpos_api/api/loyalty_program_api.jretro.dart';
import 'package:pointpos_api/api/merchant_account_api.dart';
import 'package:pointpos_api/api/merchant_account_api.jretro.dart';
import 'package:pointpos_api/api/merchant_api.dart';
import 'package:pointpos_api/api/merchant_api.jretro.dart';
import 'package:pointpos_api/api/modifier_api.dart';
import 'package:pointpos_api/api/modifier_api.jretro.dart';
import 'package:pointpos_api/api/order_api.dart';
import 'package:pointpos_api/api/order_api.jretro.dart';
import 'package:pointpos_api/api/outlet_api.dart';
import 'package:pointpos_api/api/outlet_api.jretro.dart';
import 'package:pointpos_api/api/promo_api.dart';
import 'package:pointpos_api/api/promo_api.jretro.dart';
import 'package:pointpos_api/api/purchase_order_api.dart';
import 'package:pointpos_api/api/purchase_order_api.jretro.dart';
import 'package:pointpos_api/api/recipe_api.dart';
import 'package:pointpos_api/api/recipe_api.jretro.dart';
import 'package:pointpos_api/api/role_api.dart';
import 'package:pointpos_api/api/role_api.jretro.dart';
import 'package:pointpos_api/api/role_permission_api.dart';
import 'package:pointpos_api/api/role_permission_api.jretro.dart';
import 'package:pointpos_api/api/sales_type_api.dart';
import 'package:pointpos_api/api/sales_type_api.jretro.dart';
import 'package:pointpos_api/api/supplier_api.dart';
import 'package:pointpos_api/api/supplier_api.jretro.dart';
import 'package:pointpos_api/api/table_api.dart';
import 'package:pointpos_api/api/table_api.jretro.dart';
import 'package:pointpos_api/api/table_group_api.dart';
import 'package:pointpos_api/api/table_group_api.jretro.dart';
import 'package:pointpos_api/api/tax_api.dart';
import 'package:pointpos_api/api/tax_api.jretro.dart';
import 'package:pointpos_api/api/unit_api.dart';
import 'package:pointpos_api/api/unit_api.jretro.dart';
import 'package:pointpos_api/auth/api_key_auth.dart';
import 'package:pointpos_api/auth/auth.dart';
import 'package:pointpos_api/auth/basic_auth.dart';
import 'package:pointpos_api/auth/oauth.dart';
import 'package:pointpos_api/model/change_password.dart';
import 'package:pointpos_api/model/change_password.jser.dart';
import 'package:pointpos_api/model/customer.dart';
import 'package:pointpos_api/model/customer.jser.dart';
import 'package:pointpos_api/model/discount.dart';
import 'package:pointpos_api/model/discount.jser.dart';
import 'package:pointpos_api/model/employee.dart';
import 'package:pointpos_api/model/employee.jser.dart';
import 'package:pointpos_api/model/exception.dart';
import 'package:pointpos_api/model/exception.jser.dart';
import 'package:pointpos_api/model/forbidden_exception.dart';
import 'package:pointpos_api/model/forbidden_exception.jser.dart';
import 'package:pointpos_api/model/forgot_password.dart';
import 'package:pointpos_api/model/forgot_password.jser.dart';
import 'package:pointpos_api/model/gratuity.dart';
import 'package:pointpos_api/model/gratuity.jser.dart';
import 'package:pointpos_api/model/ingredient.dart';
import 'package:pointpos_api/model/ingredient.jser.dart';
import 'package:pointpos_api/model/ingredient_category.dart';
import 'package:pointpos_api/model/ingredient_category.jser.dart';
import 'package:pointpos_api/model/ingredient_cost_of_goods_sold.dart';
import 'package:pointpos_api/model/ingredient_cost_of_goods_sold.jser.dart';
import 'package:pointpos_api/model/ingredient_inventory.dart';
import 'package:pointpos_api/model/ingredient_inventory.jser.dart';
import 'package:pointpos_api/model/internal_server_error_exception.dart';
import 'package:pointpos_api/model/internal_server_error_exception.jser.dart';
import 'package:pointpos_api/model/item.dart';
import 'package:pointpos_api/model/item.jser.dart';
import 'package:pointpos_api/model/item_category.dart';
import 'package:pointpos_api/model/item_category.jser.dart';
import 'package:pointpos_api/model/item_cost_of_goods_sold.dart';
import 'package:pointpos_api/model/item_cost_of_goods_sold.jser.dart';
import 'package:pointpos_api/model/item_inventory.dart';
import 'package:pointpos_api/model/item_inventory.jser.dart';
import 'package:pointpos_api/model/item_variants.dart';
import 'package:pointpos_api/model/item_variants.jser.dart';
import 'package:pointpos_api/model/login.dart';
import 'package:pointpos_api/model/login.jser.dart';
import 'package:pointpos_api/model/loyalty_program.dart';
import 'package:pointpos_api/model/loyalty_program.jser.dart';
import 'package:pointpos_api/model/loyalty_program_point_from_buy_item.dart';
import 'package:pointpos_api/model/loyalty_program_point_from_buy_item.jser.dart';
import 'package:pointpos_api/model/loyalty_program_point_from_buy_item_eligible_categories.dart';
import 'package:pointpos_api/model/loyalty_program_point_from_buy_item_eligible_categories.jser.dart';
import 'package:pointpos_api/model/loyalty_program_point_from_buy_item_eligible_items.dart';
import 'package:pointpos_api/model/loyalty_program_point_from_buy_item_eligible_items.jser.dart';
import 'package:pointpos_api/model/loyalty_program_point_from_total_spent.dart';
import 'package:pointpos_api/model/loyalty_program_point_from_total_spent.jser.dart';
import 'package:pointpos_api/model/loyalty_program_redeem_rules.dart';
import 'package:pointpos_api/model/loyalty_program_redeem_rules.jser.dart';
import 'package:pointpos_api/model/merchant_account.dart';
import 'package:pointpos_api/model/merchant_account.jser.dart';
import 'package:pointpos_api/model/merchant_account_business_info.dart';
import 'package:pointpos_api/model/merchant_account_business_info.jser.dart';
import 'package:pointpos_api/model/merchant_account_identification.dart';
import 'package:pointpos_api/model/merchant_account_identification.jser.dart';
import 'package:pointpos_api/model/merchant_account_personal_details.dart';
import 'package:pointpos_api/model/merchant_account_personal_details.jser.dart';
import 'package:pointpos_api/model/merchant_account_personal_details_email.dart';
import 'package:pointpos_api/model/merchant_account_personal_details_email.jser.dart';
import 'package:pointpos_api/model/merchant_account_personal_details_phone.dart';
import 'package:pointpos_api/model/merchant_account_personal_details_phone.jser.dart';
import 'package:pointpos_api/model/merchant_account_public_profile.dart';
import 'package:pointpos_api/model/merchant_account_public_profile.jser.dart';
import 'package:pointpos_api/model/modifier.dart';
import 'package:pointpos_api/model/modifier.jser.dart';
import 'package:pointpos_api/model/modifier_options.dart';
import 'package:pointpos_api/model/modifier_options.jser.dart';
import 'package:pointpos_api/model/not_found_exception.dart';
import 'package:pointpos_api/model/not_found_exception.jser.dart';
import 'package:pointpos_api/model/order.dart';
import 'package:pointpos_api/model/order.jser.dart';
import 'package:pointpos_api/model/order_cash.dart';
import 'package:pointpos_api/model/order_cash.jser.dart';
import 'package:pointpos_api/model/order_discounts.dart';
import 'package:pointpos_api/model/order_discounts.jser.dart';
import 'package:pointpos_api/model/order_items.dart';
import 'package:pointpos_api/model/order_items.jser.dart';
import 'package:pointpos_api/model/order_modifiers.dart';
import 'package:pointpos_api/model/order_modifiers.jser.dart';
import 'package:pointpos_api/model/order_payments.dart';
import 'package:pointpos_api/model/order_payments.jser.dart';
import 'package:pointpos_api/model/order_sent_receipts.dart';
import 'package:pointpos_api/model/order_sent_receipts.jser.dart';
import 'package:pointpos_api/model/outlet.dart';
import 'package:pointpos_api/model/outlet.jser.dart';
import 'package:pointpos_api/model/outlet_receipt_settings.dart';
import 'package:pointpos_api/model/outlet_receipt_settings.jser.dart';
import 'package:pointpos_api/model/outlet_receipt_settings_outlet_info.dart';
import 'package:pointpos_api/model/outlet_receipt_settings_outlet_info.jser.dart';
import 'package:pointpos_api/model/profile.dart';
import 'package:pointpos_api/model/profile.jser.dart';
import 'package:pointpos_api/model/profile_all_of.dart';
import 'package:pointpos_api/model/profile_all_of.jser.dart';
import 'package:pointpos_api/model/promo.dart';
import 'package:pointpos_api/model/promo.jser.dart';
import 'package:pointpos_api/model/promo_promo_period.dart';
import 'package:pointpos_api/model/promo_promo_period.jser.dart';
import 'package:pointpos_api/model/promo_promo_period_date_range.dart';
import 'package:pointpos_api/model/promo_promo_period_date_range.jser.dart';
import 'package:pointpos_api/model/promo_promo_period_time_range.dart';
import 'package:pointpos_api/model/promo_promo_period_time_range.jser.dart';
import 'package:pointpos_api/model/promo_promo_period_week_day.dart';
import 'package:pointpos_api/model/promo_promo_period_week_day.jser.dart';
import 'package:pointpos_api/model/promo_requirement.dart';
import 'package:pointpos_api/model/promo_requirement.jser.dart';
import 'package:pointpos_api/model/promo_requirement_eligible_categories.dart';
import 'package:pointpos_api/model/promo_requirement_eligible_categories.jser.dart';
import 'package:pointpos_api/model/promo_requirement_eligible_items.dart';
import 'package:pointpos_api/model/promo_requirement_eligible_items.jser.dart';
import 'package:pointpos_api/model/promo_reward.dart';
import 'package:pointpos_api/model/promo_reward.jser.dart';
import 'package:pointpos_api/model/promo_reward_discount.dart';
import 'package:pointpos_api/model/promo_reward_discount.jser.dart';
import 'package:pointpos_api/model/purchase_order.dart';
import 'package:pointpos_api/model/purchase_order.jser.dart';
import 'package:pointpos_api/model/purchase_order_ingredients.dart';
import 'package:pointpos_api/model/purchase_order_ingredients.jser.dart';
import 'package:pointpos_api/model/recipe.dart';
import 'package:pointpos_api/model/recipe.jser.dart';
import 'package:pointpos_api/model/recipe_ingredients.dart';
import 'package:pointpos_api/model/recipe_ingredients.jser.dart';
import 'package:pointpos_api/model/reset_password.dart';
import 'package:pointpos_api/model/reset_password.jser.dart';
import 'package:pointpos_api/model/role.dart';
import 'package:pointpos_api/model/role.jser.dart';
import 'package:pointpos_api/model/role_permission.dart';
import 'package:pointpos_api/model/role_permission.jser.dart';
import 'package:pointpos_api/model/sales_type.dart';
import 'package:pointpos_api/model/sales_type.jser.dart';
import 'package:pointpos_api/model/signup.dart';
import 'package:pointpos_api/model/signup.jser.dart';
import 'package:pointpos_api/model/signup_all_of.dart';
import 'package:pointpos_api/model/signup_all_of.jser.dart';
import 'package:pointpos_api/model/supplier.dart';
import 'package:pointpos_api/model/supplier.jser.dart';
import 'package:pointpos_api/model/table.dart';
import 'package:pointpos_api/model/table.jser.dart';
import 'package:pointpos_api/model/table_group.dart';
import 'package:pointpos_api/model/table_group.jser.dart';
import 'package:pointpos_api/model/table_location.dart';
import 'package:pointpos_api/model/table_location.jser.dart';
import 'package:pointpos_api/model/tax.dart';
import 'package:pointpos_api/model/tax.jser.dart';
import 'package:pointpos_api/model/token.dart';
import 'package:pointpos_api/model/token.jser.dart';
import 'package:pointpos_api/model/unauthorized_exception.dart';
import 'package:pointpos_api/model/unauthorized_exception.jser.dart';
import 'package:pointpos_api/model/unit.dart';
import 'package:pointpos_api/model/unit.jser.dart';
import 'package:pointpos_api/model/update_profile.dart';
import 'package:pointpos_api/model/update_profile.jser.dart';
import 'package:pointpos_api/model/validation_exception.dart';
import 'package:pointpos_api/model/validation_exception.jser.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
40
Health:
Code health derived from static analysis. [more]
75
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
60
Overall:
Weighted score of the above. [more]
55
Learn more about scoring.

We analyzed this package on Jul 11, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.8.4
  • pana: 0.13.14

Health suggestions

Fix lib/api.dart. (-12.22 points)

Analysis of lib/api.dart reported 26 hints, including:

line 210 col 5: Prefer using /// for doc comments.

line 244 col 5: Prefer using /// for doc comments.

line 259 col 5: Prefer using /// for doc comments.

line 274 col 5: Prefer using /// for doc comments.

line 289 col 5: Prefer using /// for doc comments.

Fix lib/model/role_permission.dart. (-5.36 points)

Analysis of lib/model/role_permission.dart reported 11 hints, including:

line 49 col 6: Don't explicitly initialize variables to null.

line 51 col 6: Don't explicitly initialize variables to null.

line 52 col 6: Don't explicitly initialize variables to null.

line 53 col 6: Don't explicitly initialize variables to null.

line 54 col 6: Don't explicitly initialize variables to null.

Fix lib/model/customer.dart. (-4.89 points)

Analysis of lib/model/customer.dart reported 10 hints, including:

line 43 col 6: Don't explicitly initialize variables to null.

line 45 col 6: Don't explicitly initialize variables to null.

line 46 col 6: Don't explicitly initialize variables to null.

line 47 col 6: Don't explicitly initialize variables to null.

line 48 col 6: Don't explicitly initialize variables to null.

Fix additional 104 files with analysis or formatting issues. (-149.92 points)

Additional issues in the following files:

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

Maintenance suggestions

The package description is too short. (-20 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and pointpos_api.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0 <3.0.0
http ^0.12.1 0.12.1
jaguar_mimetype ^1.0.1 1.0.1
jaguar_retrofit ^2.8.8 2.8.8
jaguar_serializer ^2.2.12 2.2.12
Transitive dependencies
async 2.4.2
auth_header 2.1.4
charcode 1.1.3
client_cookie 2.2.1
collection 1.14.13 1.15.0-nullsafety
http_parser 3.1.4
jaguar_resty 2.10.15
meta 1.2.2 1.3.0-nullsafety
path 1.7.0
pedantic 1.9.2
source_span 1.7.0
string_scanner 1.0.5
term_glyph 1.1.0
typed_data 1.2.0 1.3.0-nullsafety
Dev dependencies
build_runner ^1.6.5
jaguar_retrofit_gen ^2.8.10
jaguar_serializer_cli ^2.2.8
test ^1.14.7