@prodoctors/contracts 1.0.2 → 1.0.4

package/proto/inventory.proto

@@ -0,0 +1,302 @@
+syntax = "proto3";
+
+package inventory.v1;
+
+import "google/protobuf/timestamp.proto";
+import "common.proto";
+import "catalog.proto";
+
+enum ProductStatus {
+  PRODUCT_STATUS_UNSPECIFIED = 0;
+  PRODUCT_STATUS_ACTIVE = 1;
+  PRODUCT_STATUS_INACTIVE = 2;
+}
+
+enum UnitType {
+  UNIT_TYPE_UNSPECIFIED = 0;
+  UNIT_TYPE_PIECE = 1;
+  UNIT_TYPE_BOX = 2;
+  UNIT_TYPE_BOTTLE = 3;
+  UNIT_TYPE_PACK = 4;
+  UNIT_TYPE_BLISTER = 5;
+  UNIT_TYPE_TUBE = 6;
+  UNIT_TYPE_AMPULE = 7;
+  UNIT_TYPE_VIAL = 8;
+}
+
+enum ProductForm {
+  PRODUCT_FORM_UNSPECIFIED = 0;
+  PRODUCT_FORM_TABLET = 1;
+  PRODUCT_FORM_CAPSULE = 2;
+  PRODUCT_FORM_SYRUP = 3;
+  PRODUCT_FORM_INJECTION = 4;
+  PRODUCT_FORM_OINTMENT = 5;
+  PRODUCT_FORM_CREAM = 6;
+  PRODUCT_FORM_GEL = 7;
+  PRODUCT_FORM_DROPS = 8;
+  PRODUCT_FORM_SPRAY = 9;
+  PRODUCT_FORM_POWDER = 10;
+  PRODUCT_FORM_SOLUTION = 11;
+  PRODUCT_FORM_SUPPOSITORY = 12;
+  PRODUCT_FORM_OTHER = 13;
+}
+
+enum BatchStatus {
+  BATCH_STATUS_UNSPECIFIED = 0;
+  BATCH_STATUS_ACTIVE = 1;
+  BATCH_STATUS_EXPIRED = 2;
+  BATCH_STATUS_DEPLETED = 3;
+  BATCH_STATUS_BLOCKED = 4;
+}
+
+enum StockMovementType {
+  STOCK_MOVEMENT_TYPE_UNSPECIFIED = 0;
+  STOCK_MOVEMENT_TYPE_IN = 1;
+  STOCK_MOVEMENT_TYPE_OUT = 2;
+  STOCK_MOVEMENT_TYPE_RETURN_IN = 3;
+  STOCK_MOVEMENT_TYPE_RETURN_OUT = 4;
+  STOCK_MOVEMENT_TYPE_WRITE_OFF = 5;
+  STOCK_MOVEMENT_TYPE_ADJUSTMENT = 6;
+  STOCK_MOVEMENT_TYPE_TRANSFER_OUT = 7;
+  STOCK_MOVEMENT_TYPE_TRANSFER_IN = 8;
+}
+
+message Product {
+  string id = 1;
+  string name = 2;
+  string sku = 3;
+  optional string barcode = 4;
+  optional string dosage = 5;
+  optional string description = 6;
+  ProductForm form = 7;
+  UnitType unit = 8;
+  bool requires_prescription = 9;
+  ProductStatus status = 10;
+  optional string brand_id = 11;
+  optional string category_id = 12;
+  optional string international_name_id = 13;
+  optional string manufacturer_id = 14;
+  string price = 15;
+  optional string cost_price = 16;
+  optional catalog.v1.Brand brand = 17;
+  optional catalog.v1.Category category = 18;
+  optional catalog.v1.InternationalName international_name = 19;
+  optional catalog.v1.Manufacturer manufacturer = 20;
+  google.protobuf.Timestamp created_at = 21;
+  google.protobuf.Timestamp updated_at = 22;
+}
+
+message ProductBarcode {
+  string id = 1;
+  string product_id = 2;
+  string barcode = 3;
+  bool is_primary = 4;
+  optional string package_type = 5;
+  optional string note = 6;
+  google.protobuf.Timestamp created_at = 7;
+  google.protobuf.Timestamp updated_at = 8;
+}
+
+message ProductBatch {
+  string id = 1;
+  string product_id = 2;
+  string branch_id = 3;
+  string batch_number = 4;
+  google.protobuf.Timestamp expiry_date = 5;
+  optional google.protobuf.Timestamp manufacture_date = 6;
+  string purchase_price = 7;
+  string selling_price = 8;
+  int32 initial_quantity = 9;
+  int32 remaining_quantity = 10;
+  BatchStatus status = 11;
+  optional string purchase_item_id = 12;
+  optional Product product = 13;
+  google.protobuf.Timestamp created_at = 14;
+  google.protobuf.Timestamp updated_at = 15;
+}
+
+message StockMovement {
+  string id = 1;
+  string branch_id = 2;
+  string product_id = 3;
+  string product_batch_id = 4;
+  StockMovementType type = 5;
+  int32 quantity = 6;
+  int32 balance_before = 7;
+  int32 balance_after = 8;
+  optional string reference_type = 9;
+  optional string reference_id = 10;
+  optional string performed_by_id = 11;
+  optional string note = 12;
+  google.protobuf.Timestamp created_at = 13;
+}
+
+message CreateProductRequest {
+  string name = 1;
+  string sku = 2;
+  optional string barcode = 3;
+  optional string dosage = 4;
+  optional string description = 5;
+  ProductForm form = 6;
+  UnitType unit = 7;
+  optional bool requires_prescription = 8;
+  optional ProductStatus status = 9;
+  optional string brand_id = 10;
+  optional string category_id = 11;
+  optional string international_name_id = 12;
+  optional string manufacturer_id = 13;
+  string price = 14;
+  optional string cost_price = 15;
+}
+
+message UpdateProductRequest {
+  string id = 1;
+  optional string name = 2;
+  optional string sku = 3;
+  optional string barcode = 4;
+  optional string dosage = 5;
+  optional string description = 6;
+  optional ProductForm form = 7;
+  optional UnitType unit = 8;
+  optional bool requires_prescription = 9;
+  optional ProductStatus status = 10;
+  optional string brand_id = 11;
+  optional string category_id = 12;
+  optional string international_name_id = 13;
+  optional string manufacturer_id = 14;
+  optional string price = 15;
+  optional string cost_price = 16;
+}
+
+message ListProductsRequest {
+  common.v1.PaginationRequest pagination = 1;
+  optional string search = 2;
+  optional string brand_id = 3;
+  optional string category_id = 4;
+  optional string international_name_id = 5;
+  optional string manufacturer_id = 6;
+  optional ProductStatus status = 7;
+}
+
+message ListProductsResponse {
+  repeated Product items = 1;
+  common.v1.PaginationMeta meta = 2;
+}
+
+message CreateProductBarcodeRequest {
+  string product_id = 1;
+  string barcode = 2;
+  optional bool is_primary = 3;
+  optional string package_type = 4;
+  optional string note = 5;
+}
+
+message UpdateProductBarcodeRequest {
+  string id = 1;
+  optional string barcode = 2;
+  optional bool is_primary = 3;
+  optional string package_type = 4;
+  optional string note = 5;
+}
+
+message ListProductBarcodesResponse {
+  repeated ProductBarcode items = 1;
+}
+
+message CreateProductBatchRequest {
+  string product_id = 1;
+  string branch_id = 2;
+  string batch_number = 3;
+  google.protobuf.Timestamp expiry_date = 4;
+  optional google.protobuf.Timestamp manufacture_date = 5;
+  string purchase_price = 6;
+  string selling_price = 7;
+  int32 initial_quantity = 8;
+  optional int32 remaining_quantity = 9;
+  optional BatchStatus status = 10;
+  optional string purchase_item_id = 11;
+}
+
+message UpdateProductBatchRequest {
+  string id = 1;
+  optional string batch_number = 2;
+  optional google.protobuf.Timestamp expiry_date = 3;
+  optional google.protobuf.Timestamp manufacture_date = 4;
+  optional string purchase_price = 5;
+  optional string selling_price = 6;
+  optional int32 initial_quantity = 7;
+  optional int32 remaining_quantity = 8;
+  optional BatchStatus status = 9;
+}
+
+message ListProductBatchesRequest {
+  common.v1.PaginationRequest pagination = 1;
+  optional string branch_id = 2;
+  optional string product_id = 3;
+  optional string batch_number = 4;
+  optional BatchStatus status = 5;
+  optional bool low_stock_only = 6;
+  optional bool expiring_soon_only = 7;
+}
+
+message ListProductBatchesResponse {
+  repeated ProductBatch items = 1;
+  common.v1.PaginationMeta meta = 2;
+}
+
+message CreateStockMovementRequest {
+  string branch_id = 1;
+  string product_id = 2;
+  string product_batch_id = 3;
+  StockMovementType type = 4;
+  int32 quantity = 5;
+  int32 balance_before = 6;
+  int32 balance_after = 7;
+  optional string reference_type = 8;
+  optional string reference_id = 9;
+  optional string performed_by_id = 10;
+  optional string note = 11;
+}
+
+message ListStockMovementsRequest {
+  common.v1.PaginationRequest pagination = 1;
+  optional string branch_id = 2;
+  optional string product_id = 3;
+  optional string product_batch_id = 4;
+  optional StockMovementType type = 5;
+}
+
+message ListStockMovementsResponse {
+  repeated StockMovement items = 1;
+  common.v1.PaginationMeta meta = 2;
+}
+
+service ProductService {
+  rpc CreateProduct(CreateProductRequest) returns (Product);
+  rpc UpdateProduct(UpdateProductRequest) returns (Product);
+  rpc GetProductById(common.v1.IdRequest) returns (Product);
+  rpc ListProducts(ListProductsRequest) returns (ListProductsResponse);
+  rpc DeleteProduct(common.v1.IdRequest) returns (common.v1.BoolResponse);
+}
+
+service ProductBarcodeService {
+  rpc CreateProductBarcode(CreateProductBarcodeRequest) returns (ProductBarcode);
+  rpc UpdateProductBarcode(UpdateProductBarcodeRequest) returns (ProductBarcode);
+  rpc GetProductBarcodeById(common.v1.IdRequest) returns (ProductBarcode);
+  rpc ListProductBarcodes(common.v1.IdRequest) returns (ListProductBarcodesResponse);
+  rpc DeleteProductBarcode(common.v1.IdRequest) returns (common.v1.BoolResponse);
+}
+
+service ProductBatchService {
+  rpc CreateProductBatch(CreateProductBatchRequest) returns (ProductBatch);
+  rpc UpdateProductBatch(UpdateProductBatchRequest) returns (ProductBatch);
+  rpc GetProductBatchById(common.v1.IdRequest) returns (ProductBatch);
+  rpc ListProductBatches(ListProductBatchesRequest) returns (ListProductBatchesResponse);
+  rpc DeleteProductBatch(common.v1.IdRequest) returns (common.v1.BoolResponse);
+}
+
+service StockMovementService {
+  rpc CreateStockMovement(CreateStockMovementRequest) returns (StockMovement);
+  rpc GetStockMovementById(common.v1.IdRequest) returns (StockMovement);
+  rpc ListStockMovements(ListStockMovementsRequest) returns (ListStockMovementsResponse);
+}

package/proto/partner.proto

@@ -0,0 +1,103 @@
+syntax = "proto3";
+
+package partner.v1;
+
+import "google/protobuf/timestamp.proto";
+import "common.proto";
+
+message Supplier {
+  string id = 1;
+  string name = 2;
+  optional string phone = 3;
+  optional string email = 4;
+  optional string address = 5;
+  optional string tax_number = 6;
+  bool is_active = 7;
+  optional string note = 8;
+  google.protobuf.Timestamp created_at = 9;
+  google.protobuf.Timestamp updated_at = 10;
+}
+
+message Customer {
+  string id = 1;
+  optional string full_name = 2;
+  optional string phone = 3;
+  optional string code = 4;
+  optional string branch_id = 5;
+  google.protobuf.Timestamp created_at = 6;
+  google.protobuf.Timestamp updated_at = 7;
+}
+
+message CreateSupplierRequest {
+  string name = 1;
+  optional string phone = 2;
+  optional string email = 3;
+  optional string address = 4;
+  optional string tax_number = 5;
+  optional bool is_active = 6;
+  optional string note = 7;
+}
+
+message UpdateSupplierRequest {
+  string id = 1;
+  optional string name = 2;
+  optional string phone = 3;
+  optional string email = 4;
+  optional string address = 5;
+  optional string tax_number = 6;
+  optional bool is_active = 7;
+  optional string note = 8;
+}
+
+message ListSuppliersRequest {
+  common.v1.PaginationRequest pagination = 1;
+  optional bool is_active = 2;
+  optional string search = 3;
+}
+
+message ListSuppliersResponse {
+  repeated Supplier items = 1;
+  common.v1.PaginationMeta meta = 2;
+}
+
+message CreateCustomerRequest {
+  optional string full_name = 1;
+  optional string phone = 2;
+  optional string code = 3;
+  optional string branch_id = 4;
+}
+
+message UpdateCustomerRequest {
+  string id = 1;
+  optional string full_name = 2;
+  optional string phone = 3;
+  optional string code = 4;
+  optional string branch_id = 5;
+}
+
+message ListCustomersRequest {
+  common.v1.PaginationRequest pagination = 1;
+  optional string branch_id = 2;
+  optional string search = 3;
+}
+
+message ListCustomersResponse {
+  repeated Customer items = 1;
+  common.v1.PaginationMeta meta = 2;
+}
+
+service SupplierService {
+  rpc CreateSupplier(CreateSupplierRequest) returns (Supplier);
+  rpc UpdateSupplier(UpdateSupplierRequest) returns (Supplier);
+  rpc GetSupplierById(common.v1.IdRequest) returns (Supplier);
+  rpc ListSuppliers(ListSuppliersRequest) returns (ListSuppliersResponse);
+  rpc DeleteSupplier(common.v1.IdRequest) returns (common.v1.BoolResponse);
+}
+
+service CustomerService {
+  rpc CreateCustomer(CreateCustomerRequest) returns (Customer);
+  rpc UpdateCustomer(UpdateCustomerRequest) returns (Customer);
+  rpc GetCustomerById(common.v1.IdRequest) returns (Customer);
+  rpc ListCustomers(ListCustomersRequest) returns (ListCustomersResponse);
+  rpc DeleteCustomer(common.v1.IdRequest) returns (common.v1.BoolResponse);
+}

package/proto/purchase.proto

@@ -0,0 +1,105 @@
+syntax = "proto3";
+
+package purchase.v1;
+
+import "google/protobuf/timestamp.proto";
+import "common.proto";
+import "partner.proto";
+import "inventory.proto";
+
+enum PurchaseStatus {
+  PURCHASE_STATUS_UNSPECIFIED = 0;
+  PURCHASE_STATUS_DRAFT = 1;
+  PURCHASE_STATUS_RECEIVED = 2;
+  PURCHASE_STATUS_CANCELLED = 3;
+}
+
+message PurchaseItem {
+  string id = 1;
+  string purchase_id = 2;
+  string product_id = 3;
+  string batch_number = 4;
+  google.protobuf.Timestamp expiry_date = 5;
+  optional google.protobuf.Timestamp manufacture_date = 6;
+  string purchase_price = 7;
+  string selling_price = 8;
+  int32 quantity = 9;
+  string total_amount = 10;
+  optional string batch_id = 11;
+  optional inventory.v1.Product product = 12;
+  google.protobuf.Timestamp created_at = 13;
+  google.protobuf.Timestamp updated_at = 14;
+}
+
+message Purchase {
+  string id = 1;
+  optional string invoice_number = 2;
+  PurchaseStatus status = 3;
+  string branch_id = 4;
+  string supplier_id = 5;
+  optional string received_by_id = 6;
+  google.protobuf.Timestamp purchase_date = 7;
+  string total_amount = 8;
+  optional string note = 9;
+  optional partner.v1.Supplier supplier = 10;
+  repeated PurchaseItem items = 11;
+  google.protobuf.Timestamp created_at = 12;
+  google.protobuf.Timestamp updated_at = 13;
+}
+
+message CreatePurchaseItemInput {
+  string product_id = 1;
+  string batch_number = 2;
+  google.protobuf.Timestamp expiry_date = 3;
+  optional google.protobuf.Timestamp manufacture_date = 4;
+  string purchase_price = 5;
+  string selling_price = 6;
+  int32 quantity = 7;
+  string total_amount = 8;
+}
+
+message CreatePurchaseRequest {
+  optional string invoice_number = 1;
+  optional PurchaseStatus status = 2;
+  string branch_id = 3;
+  string supplier_id = 4;
+  optional string received_by_id = 5;
+  optional google.protobuf.Timestamp purchase_date = 6;
+  optional string total_amount = 7;
+  optional string note = 8;
+  repeated CreatePurchaseItemInput items = 9;
+}
+
+message UpdatePurchaseRequest {
+  string id = 1;
+  optional string invoice_number = 2;
+  optional PurchaseStatus status = 3;
+  optional string branch_id = 4;
+  optional string supplier_id = 5;
+  optional string received_by_id = 6;
+  optional google.protobuf.Timestamp purchase_date = 7;
+  optional string total_amount = 8;
+  optional string note = 9;
+}
+
+message ListPurchasesRequest {
+  common.v1.PaginationRequest pagination = 1;
+  optional string branch_id = 2;
+  optional string supplier_id = 3;
+  optional string received_by_id = 4;
+  optional PurchaseStatus status = 5;
+  optional string search = 6;
+}
+
+message ListPurchasesResponse {
+  repeated Purchase items = 1;
+  common.v1.PaginationMeta meta = 2;
+}
+
+service PurchaseService {
+  rpc CreatePurchase(CreatePurchaseRequest) returns (Purchase);
+  rpc UpdatePurchase(UpdatePurchaseRequest) returns (Purchase);
+  rpc GetPurchaseById(common.v1.IdRequest) returns (Purchase);
+  rpc ListPurchases(ListPurchasesRequest) returns (ListPurchasesResponse);
+  rpc DeletePurchase(common.v1.IdRequest) returns (common.v1.BoolResponse);
+}