@restorecommerce/protos 2.0.2 → 3.0.1

package/io/restorecommerce/fulfillment.proto

@@ -8,52 +8,61 @@ import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
 import "io/restorecommerce/meta.proto";
 import "io/restorecommerce/address.proto";
+import "io/restorecommerce/country.proto";
+import "io/restorecommerce/product.proto";
 import "io/restorecommerce/options.proto";
+import "io/restorecommerce/tax.proto";
 
 /**
 Microservice definition.
 */
-service Service {
-  option (io.restorecommerce.options.service_name) = "fulfillment";
-
+service FulfillmentService {
   /**
    Returns a list of shipment IDs.
    */
-  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (FulfillmentResponseList) {
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (FulfillmentListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
 
   /**
   Creates fulfillment orders
   */
-  rpc Create (FulfillmentList) returns (FulfillmentResponseList);
+  rpc Create (FulfillmentList) returns (FulfillmentListResponse);
 
   /**
-  Updates fulfillment orders unless Status is beyond Ordered
+  Updates fulfillment orders unless Status is beyond Submit
   */
-  rpc Update (FulfillmentList) returns (FulfillmentResponseList);
+  rpc Update (FulfillmentList) returns (FulfillmentListResponse);
 
   /**
-  Creates or Updates fulfillment orders unless Status is beyond Ordered
+  Creates or Updates fulfillment orders unless Status is beyond Submit
   */
-  rpc Upsert (FulfillmentList) returns (FulfillmentResponseList);
+  rpc Upsert (FulfillmentList) returns (FulfillmentListResponse);
 
   /**
-  Creates, Executes and Updates fulfillment orders against API
+  Evaluate fulfillment for correctness
   */
-  rpc Submit (FulfillmentList) returns (FulfillmentResponseList);
+  rpc Evaluate (FulfillmentList) returns (FulfillmentListResponse);
 
   /**
-  Track a batch of fulfillment orders
+  Creates, Submits and Updates fulfillment orders against API
   */
-  rpc Track (TrackingRequestList) returns (TrackingResultList) {
-    option (io.restorecommerce.options.is_query) = true;
-  };
+  rpc Submit (FulfillmentList) returns (FulfillmentListResponse);
+
+  /**
+  Track a batch of fulfillments
+  */
+  rpc Track (FulfillmentIdList) returns (FulfillmentListResponse);
 
   /**
-  Cancel a batch of fulfillment orders
+  Withdraw a batch of fulfillments and request for cancelation
   */
-  rpc Cancel (CancelRequestList) returns (FulfillmentResponseList);
+  rpc Withdraw (FulfillmentIdList) returns (FulfillmentListResponse);
+
+  /**
+  Cancel a batch of fulfillments
+  */
+  rpc Cancel (FulfillmentIdList) returns (FulfillmentListResponse);
 
   /**
   Delete a batch of fulfillments from the database
@@ -62,32 +71,26 @@ service Service {
 }
 
 enum State {
-  Undefined = 0;
+  Created = 0;
   Invalid = 1;
   Failed = 2;
-  Cancelled = 3;
-  Created = 4;
-  Submitted = 5;
-  Shipping = 6;
-  Done = 7;
-}
-
-message ShippingAddress {
-  io.restorecommerce.address.Address address = 1;
-  io.restorecommerce.address.ContactPerson contact_person = 2;
+  Submitted = 3;
+  InTransit = 4;
+  Fulfilled = 5;
+  Withdrawn = 6;
+  Cancelled = 7;
 }
 
-message Item {
-  //Catalog item!
-  string item_id = 1;
-  string name = 2;
-  string description = 3;
-  string taric_code = 4;
-  int32 quantity = 5;
+message FulfillmentItem {
+  optional string product_id = 1;
+  optional string variant_id = 2;
+  optional int32 quantity = 3;
+  optional io.restorecommerce.product.Package package = 4;
 }
 
 message Parcel {
-  string product_id = 1 [
+  optional string id = 1;
+  optional string product_id = 2 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.fulfillment_product.FulfillmentProduct",
       target_service: "resource",
@@ -96,12 +99,11 @@ message Parcel {
       field_name: "product",
     }
   ];
-  string product_variant_id = 2;
-  repeated Item items = 3;
-  float weight_in_kg = 4;
-  float height_in_cm = 5;
-  float width_in_cm = 6;
-  float length_in_cm = 7;
+  optional string variant_id = 3;
+  optional FulfillmentItem item = 4;
+  optional double price = 5;
+  repeated io.restorecommerce.tax.VAT vats = 6; //Set by service
+  optional io.restorecommerce.product.Package package = 7;
 }
 
 message Label {
@@ -110,41 +112,59 @@ message Label {
     string pdf = 2;
     string png = 3;
   }
-  string shipment_number = 4; //filled on Order
-  State state = 5; //update by Track
-  io.restorecommerce.status.Status status = 6; //API status
+  optional string parcel_id = 4;
+  optional string shipment_number = 5; //filled on Order
+  optional State state = 6; //update by Track
+  optional io.restorecommerce.status.Status status = 7; //API status
 }
 
-message Order {
-  string reference_id = 1;
+message Packaging {
+  optional string reference_id = 1;
   repeated Parcel parcels = 2;
-  ShippingAddress sender = 3;
-  ShippingAddress receiver = 4;
-  string notify = 5;
+  optional io.restorecommerce.address.ShippingAddress sender = 3;
+  optional io.restorecommerce.address.ShippingAddress receiver = 4;
+  optional string notify = 5;
+}
+
+message Event {
+  optional int64 timestamp = 1;
+  optional string location = 2;
+  optional google.protobuf.Any details = 3;
+  optional io.restorecommerce.status.Status status = 4;
+}
+
+message Tracking {
+  optional string shipment_number = 1;
+  repeated Event events = 3;
+  optional google.protobuf.Any details = 4;
+  optional io.restorecommerce.status.Status status = 5;
 }
 
 /**
-This is the message how it get stored to the database
+This is the message of how it get stored to the database
 */
 message Fulfillment {
   option (restorecommerce.options.kafka_subscriber) = {
-    plural: "fulfillment"
+    plural: "fulfillments"
     topic: "io.restorecommerce.fulfillment.resource"
     created: "fulfillmentCreated"
     updated: "fulfillmentUpdated"
     deleted: "fulfillmentDeleted"
   };
 
-  string id = 1;
-  Order order = 2;
-  io.restorecommerce.meta.Meta meta = 3;
+  optional string id = 1;
+  optional Packaging packaging = 2; //filled by user
+  optional io.restorecommerce.meta.Meta meta = 3;
   repeated Label labels = 4; //filled by service
-  State state = 5;
+  repeated Tracking trackings = 5; //filled by service
+  optional State state = 6; //filled by service
+  optional double total_price = 7;
+  optional double total_vat = 8;
 }
 
 message FulfillmentList {
   repeated Fulfillment items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -153,62 +173,25 @@ message FulfillmentResponse {
   io.restorecommerce.status.Status status = 2;
 }
 
-message FulfillmentResponseList {
+message FulfillmentListResponse {
   repeated FulfillmentResponse items = 1;
   uint32 total_count = 2;
   io.restorecommerce.status.OperationStatus operation_status = 3;
 }
 
-message TrackingRequest {
-  string fulfillment_id = 1;
+message FulfillmentId {
+  optional string id = 1;
   repeated string shipment_numbers = 2; //optional
-  google.protobuf.Any options = 3;
+  optional google.protobuf.Any options = 3;
+  optional io.restorecommerce.auth.Subject subject = 4;
 }
 
-message TrackingRequestList {
-  repeated TrackingRequest items = 1;
-  io.restorecommerce.auth.Subject subject = 2;
-}
-
-message Event {
-  int64 timestamp = 1;
-  string location = 2;
-  google.protobuf.Any details = 3;
-  io.restorecommerce.status.Status status = 4;
-}
-
-message Tracking {
-  string shipment_number = 1;
-  repeated Event events = 3;
-  google.protobuf.Any details = 4;
-  io.restorecommerce.status.Status status = 5;
-}
-
-message TrackingResult {
-  Fulfillment fulfillment = 1 [
-    (io.restorecommerce.options.resolver) = {
-      target_type: ".io.restorecommerce.fulfillment.Fulfillment",
-      target_service: "resource",
-      target_sub_service: "fulfillment",
-      target_method: "Read",
-      field_name: "fulfillment",
-    }
-  ];
-  repeated Tracking tracks = 2;
-  io.restorecommerce.status.Status status = 3;
-}
-
-message TrackingResultList {
-  repeated TrackingResult items = 1;
-  io.restorecommerce.status.OperationStatus operation_status = 2;
-}
-
-message CancelRequestList {
-  repeated string ids = 1;
-  io.restorecommerce.auth.Subject subject = 2;
+message FulfillmentIdList {
+  repeated FulfillmentId items = 1;
+  optional uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
 }
 
 message Deleted {
   string id = 1;
-}
-
+}

package/io/restorecommerce/fulfillment_courier.proto

@@ -13,15 +13,13 @@ import "io/restorecommerce/options.proto";
 Microservice defination
 */
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "fulfillment_courier";
-
-  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (FulfillmentCourierResponseList) {
+service FulfillmentCourierService {
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (FulfillmentCourierListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
-  rpc Create (FulfillmentCourierList) returns (FulfillmentCourierResponseList);
-  rpc Update (FulfillmentCourierList) returns (FulfillmentCourierResponseList);
-  rpc Upsert (FulfillmentCourierList) returns (FulfillmentCourierResponseList);
+  rpc Create (FulfillmentCourierList) returns (FulfillmentCourierListResponse);
+  rpc Update (FulfillmentCourierList) returns (FulfillmentCourierListResponse);
+  rpc Upsert (FulfillmentCourierList) returns (FulfillmentCourierListResponse);
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
 }
 
@@ -34,19 +32,19 @@ message FulfillmentCourier {
     deleted: "fulfillmentCourierDeleted"
   };
 
-  string id = 1;
-  string name = 4;
-  string description = 5;
-  string logo = 6;
-  string website = 7;
-  string stub_type = 8;
-  google.protobuf.Any configuration = 10;
-  io.restorecommerce.meta.Meta meta = 11;
+  optional string id = 1;
+  optional string name = 4;
+  optional string description = 5;
+  optional string logo = 6;
+  optional string website = 7;
+  optional string stub_type = 8;
+  optional google.protobuf.Any configuration = 10;
+  optional io.restorecommerce.meta.Meta meta = 11;
 }
 
 message FulfillmentCourierList {
   repeated FulfillmentCourier items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -55,7 +53,7 @@ message FulfillmentCourierResponse {
   io.restorecommerce.status.Status status = 2;
 }
 
-message FulfillmentCourierResponseList {
+message FulfillmentCourierListResponse {
   repeated FulfillmentCourierResponse items = 1;
   uint32 total_count = 2;
   io.restorecommerce.status.OperationStatus operation_status = 3;

package/io/restorecommerce/fulfillment_product.proto

@@ -7,6 +7,9 @@ import "io/restorecommerce/meta.proto";
 import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
 import "io/restorecommerce/attribute.proto";
+import "io/restorecommerce/address.proto";
+import "io/restorecommerce/tax.proto";
+import "io/restorecommerce/geometry.proto";
 import "io/restorecommerce/fulfillment_courier.proto";
 import "io/restorecommerce/fulfillment.proto";
 import "io/restorecommerce/options.proto";
@@ -15,55 +18,51 @@ import "io/restorecommerce/options.proto";
 Microservice defination
 */
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "fulfillment_product";
-
-  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (FulfillmentProductResponseList) {
+service FulfillmentProductService {
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (FulfillmentProductListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
-  rpc Find (QueryList) returns (PackingSolutionResponseList) {
+  rpc Find (ProductQueryList) returns (PackingSolutionListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
-  rpc Create (FulfillmentProductList) returns (FulfillmentProductResponseList);
-  rpc Update (FulfillmentProductList) returns (FulfillmentProductResponseList);
-  rpc Upsert (FulfillmentProductList) returns (FulfillmentProductResponseList);
+  rpc Create (FulfillmentProductList) returns (FulfillmentProductListResponse);
+  rpc Update (FulfillmentProductList) returns (FulfillmentProductListResponse);
+  rpc Upsert (FulfillmentProductList) returns (FulfillmentProductListResponse);
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
 }
 
 message Preferences {
   repeated io.restorecommerce.attribute.Attribute couriers = 1; //ID, name or type
-  float pricing = 2;
-  float compactness = 3;
-  float homogeneity = 4;
+  repeated io.restorecommerce.attribute.Attribute options = 2;
 }
 
-message Query {
-  // io.restorecommerce.fulfillment.Address sender = 1;
-  // io.restorecommerce.fulfillment.Address receiver = 2;
-  repeated io.restorecommerce.fulfillment.Item goods = 3;
-  Preferences preferences = 4;
-  string reference_id = 5;
+message ProductQuery {
+  optional io.restorecommerce.address.ShippingAddress sender = 1;
+  optional io.restorecommerce.address.ShippingAddress receiver = 2;
+  repeated io.restorecommerce.fulfillment.FulfillmentItem items = 3;
+  optional Preferences preferences = 4;
+  optional string reference_id = 5;
 }
 
-message QueryList {
-  repeated Query items = 1;
-  uint32 total_count = 2;
+message ProductQueryList {
+  repeated ProductQuery items = 1;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
 message FulfillmentProduct {
   option (restorecommerce.options.kafka_subscriber) = {
-    plural: "fulfillmentProduct"
+    plural: "fulfillment_products"
     topic: "io.restorecommerce.fulfillment_product.resource"
     created: "fulfillmentProductCreated"
     updated: "fulfillmentProductUpdated"
     deleted: "fulfillmentProductDeleted"
   };
 
-  string id = 1;
-  string name = 2;
-  string description = 3;
-  string courier_id = 4 [
+  optional string id = 1;
+  optional string name = 2;
+  optional string description = 3;
+  optional string courier_id = 4 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.fulfillment_courier.FulfillmentCourier",
       target_service: "resource",
@@ -77,24 +76,21 @@ message FulfillmentProduct {
   repeated string tax_ids = 9;
   repeated io.restorecommerce.attribute.Attribute attributes = 10;
   repeated Variant variants = 11;
-  io.restorecommerce.meta.Meta meta = 12;
+  optional io.restorecommerce.meta.Meta meta = 12;
 }
 
 message Variant {
-  string id = 1;
-  string name = 2;
-  string description = 3;
-  double price = 4;
-  double max_weight = 5;
-  double max_width = 6;
-  double max_height = 7;
-  double max_length = 8;
-  double max_volume = 9;
+  optional string id = 1;
+  optional string name = 2;
+  optional string description = 3;
+  optional double price = 4;
+  optional io.restorecommerce.geometry.BoundingBox3D max_size = 6;
+  optional double max_weight = 7;
 }
 
 message FulfillmentProductList {
   repeated FulfillmentProduct items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -103,29 +99,30 @@ message FulfillmentProductResponse {
   io.restorecommerce.status.Status status = 2;
 }
 
-message FulfillmentProductResponseList {
+message FulfillmentProductListResponse {
   repeated FulfillmentProductResponse items = 1;
   uint32 total_count = 2;
   io.restorecommerce.status.OperationStatus operation_status = 3;
 }
 
 message PackingSolution {
-  string reference_id = 1;
-  float price = 2;
-  float compactness = 3;
-  float homogeneity = 4;
-  float score = 5;
-  repeated io.restorecommerce.fulfillment.Parcel parcels = 6;
+  optional double price = 1;
+  optional double compactness = 2;
+  optional double homogeneity = 3;
+  optional double score = 4;
+  repeated io.restorecommerce.fulfillment.Parcel parcels = 5;
+  repeated io.restorecommerce.tax.VAT vats = 6;
 }
 
 message PackingSolutionResponse {
-  repeated PackingSolution solutions = 1;
-  io.restorecommerce.status.Status status = 2;
+  optional string reference_id = 1;
+  repeated PackingSolution solutions = 2;
+  optional io.restorecommerce.status.Status status = 3;
 }
 
-message PackingSolutionResponseList {
+message PackingSolutionListResponse {
   repeated PackingSolutionResponse items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.status.OperationStatus operation_status = 3;
 }
 

package/io/restorecommerce/geometry.proto

@@ -0,0 +1,23 @@
+syntax = "proto3";
+
+package io.restorecommerce.geometry;
+
+import "io/restorecommerce/options.proto";
+
+
+message Vector3D {
+  optional double x = 1;
+  optional double y = 2;
+  optional double z = 3;
+}
+
+message BoundingBox3D {
+  optional double width = 1;
+  optional double height = 2;
+  optional double length = 3;
+}
+
+message OriginBoundingBox {
+  optional Vector3D origin = 1;
+  optional BoundingBox3D bbox = 2;
+}

package/io/restorecommerce/graph.proto

@@ -7,7 +7,7 @@ import "io/restorecommerce/status.proto";
 import "io/restorecommerce/resource_base.proto";
 
 // Service provides the CRUD operations
-service Service {
+service GraphService {
   rpc Traversal (TraversalRequest) returns (stream TraversalResponse);
 }
 
@@ -17,29 +17,29 @@ message TraversalRequest {
     Vertices vertices = 1;
     Collection collection = 2;
   }
-  Options opts = 3;
-  bool path = 4;
+  optional Options opts = 3;
+  optional bool path = 4;
   io.restorecommerce.auth.Subject subject = 5;
   repeated Filters filters = 6;
 }
 
 message Vertices {
   string collection_name = 1;
-  repeated string start_vertex_id = 2;
+  repeated string start_vertex_ids = 2;
 }
 
 message Collection {
   string collection_name = 1;
   uint32 limit = 2;
   uint32 offset = 3;
-  repeated io.restorecommerce.resourcebase.Sort sort = 4;
+  repeated io.restorecommerce.resourcebase.Sort sorts = 4;
 }
 
 message Options {
- repeated string include_vertex = 1; // to include vertices
- repeated string exclude_vertex = 2; // to exclude vertices
- repeated string include_edge = 3; // to include vertices
- repeated string exclude_edge = 4; // to exclude vertices
+ repeated string include_vertexs = 1; // to include vertices
+ repeated string exclude_vertexs = 2; // to exclude vertices
+ repeated string include_edges = 3; // to include vertices
+ repeated string exclude_edges = 4; // to exclude vertices
  Direction direction = 5; // either inbound or outbound, defaults to outbound direction
  enum Direction {
    OUTBOUND = 0;
@@ -49,18 +49,18 @@ message Options {
 
 
 message Filters {
-  string entity = 1; // entity on which the filters are applied
-  string edge = 2; // if edge is specified depending on the direction filter are applied only for those entities
-  repeated Filter filter = 3;
+  optional string entity = 1; // entity on which the filters are applied
+  optional string edge = 2; // if edge is specified depending on the direction filter are applied only for those entities
+  repeated Filter filters = 3;
   enum Operator {
     and = 0;
     or = 1;
   }
-  Operator operator = 4;
+  optional Operator operator = 4;
 }
 
 message Filter {
-  string field = 1;
+  optional string field = 1;
   enum Operation {
     eq = 0;
     lt = 1;
@@ -72,8 +72,8 @@ message Filter {
     in = 7;
     neq = 8;
   }
-  Operation operation = 2;
-  string value = 3;
+  optional Operation operation = 2;
+  optional string value = 3;
   enum ValueType {
     STRING = 0; // default value type if not specified
     NUMBER = 1;
@@ -81,7 +81,7 @@ message Filter {
     DATE = 3;
     ARRAY = 4;
   }
-  ValueType type = 4;
+  optional ValueType type = 4;
   repeated Filters filters = 5;
 }
 

package/io/restorecommerce/image.proto

@@ -2,23 +2,24 @@ syntax = "proto3";
 
 package io.restorecommerce.image;
 
-// ProductCategory resource
 message Image {
-    string id = 1;
-    string caption = 2;
-    string filename = 3;
-    string content_type = 4;
-    string url = 5;
-    double width = 6;
-    double height = 7;
-    double length = 8;
+  optional string id = 1;
+  optional string caption = 2;
+  optional string filename = 3;
+  optional string content_type = 4;
+  optional string url = 5;
+  optional double width = 6;
+  optional double height = 7;
+  optional double length = 8;
+  repeated string tags = 9;
+  optional int64 index = 10;
 }
 
 message ImageList {
-    repeated Image items = 1;
-    uint32 total_count = 2;
+  repeated Image items = 1;
+  optional uint32 total_count = 2;
 }
 
 message Deleted {
-    string id = 1;
+  string id = 1;
 }