@restorecommerce/protos 2.0.1 → 3.0.0

package/io/restorecommerce/authentication_log.proto

@@ -11,9 +11,7 @@ import "io/restorecommerce/options.proto";
 /*
 * Microservice definition.
 */
-service Service {
-  option (io.restorecommerce.options.service_name) = "authentication_log";
-
+service AuthenticationLogService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (AuthenticationLogListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
@@ -25,7 +23,7 @@ service Service {
 
 message AuthenticationLogList {
   repeated AuthenticationLog items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -44,16 +42,16 @@ message AuthenticationLogResponse {
  * Authentication Log
  */
 message AuthenticationLog {
-  string id = 1; // log id
-  string ipv4_address = 2;
-  string ipv6_address = 3;
-  string operating_system = 4;
-  string user_agent = 5;
-  double date = 6; // time stamp of login, logout or token update
-  string activity = 7; // login, logout
-  io.restorecommerce.meta.Meta meta = 8; // meta info
-  string subject_id = 9; // subject id
-  string token_name = 10; // token name associated with io.restorecommerce.auth.Token.token_name
+  optional string id = 1; // log id
+  optional string ipv4_address = 2;
+  optional string ipv6_address = 3;
+  optional string operating_system = 4;
+  optional string user_agent = 5;
+  optional double date = 6; // time stamp of login, logout or token update
+  optional string activity = 7; // login, logout
+  optional io.restorecommerce.meta.Meta meta = 8; // meta info
+  optional string subject_id = 9; // subject id
+  optional string token_name = 10; // token name associated with io.restorecommerce.auth.Token.token_name
 }
 
 message Deleted {

package/io/restorecommerce/command.proto

@@ -10,11 +10,11 @@ import "io/restorecommerce/options.proto";
 
 // command resource
 message Command {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string name = 3;  // command name
+  optional  string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string name = 3;  // command name
   repeated CommandParameter parameters = 4; // all possible parameters
-  string description = 5; // command description
+  optional string description = 5; // command description
 }
 
 message CommandParameter {
@@ -26,15 +26,15 @@ message CommandParameter {
     string_value = 4;
   }
 
-  string field = 1; //  field name
-  string description = 2; // field description
-  ParameterType type = 3; // field's type
-  string properties = 4; // dump properties in case of `object_value``
+  optional string field = 1; //  field name
+  optional string description = 2; // field description
+  optional ParameterType type = 3; // field's type
+  optional string properties = 4; // dump properties in case of `object_value``
 }
 
 message CommandList {
   repeated Command items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -49,9 +49,7 @@ message CommandResponse {
   io.restorecommerce.status.Status status = 2;
 }
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "command";
-
+service CommandService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (CommandListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };

package/io/restorecommerce/commandinterface.proto

@@ -4,12 +4,13 @@ package io.restorecommerce.commandinterface;
 
 import "google/protobuf/any.proto";
 import "io/restorecommerce/auth.proto";
+import "io/restorecommerce/options.proto";
 
 // used to send requests through Kafka or gRPC
 message CommandRequest {
   //  command identifier (used to demultiplex operation in the command implementation)
-  string name = 1;
-  google.protobuf.Any payload = 2;  // variable payload
+  optional string name = 1;
+  optional google.protobuf.Any payload = 2;  // variable payload
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -25,6 +26,6 @@ message CommandResponse {
 /**
 * RPC service for executing commands
 */
-service Service {
+service CommandInterfaceService {
   rpc Command(CommandRequest) returns (google.protobuf.Any);
 }

package/io/restorecommerce/contact_point.proto

@@ -14,9 +14,7 @@ import "io/restorecommerce/contact_point_type.proto";
 import "io/restorecommerce/timezone.proto";
 import "io/restorecommerce/locale.proto";
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "contact_point";
-
+service ContactPointService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (ContactPointListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
@@ -32,7 +30,7 @@ message Deleted {
 
 message ContactPointList {
   repeated ContactPoint items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -48,9 +46,9 @@ message ContactPointResponse {
 }
 
 message ContactPoint {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string physical_address_id = 3 [
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string physical_address_id = 3 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.address.Address",
       target_service: "resource",
@@ -59,9 +57,9 @@ message ContactPoint {
       field_name: "physicalAddress",
     }
   ];
-  string website = 5;
-  string email = 6;
-  string contact_point_type_id = 7 [
+  optional string website = 5;
+  optional string email = 6;
+  optional string contact_point_type_id = 7 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.contact_point_type.ContactPointType",
       target_service: "resource",
@@ -70,8 +68,8 @@ message ContactPoint {
       field_name: "contactPointType",
     }
   ];
-  string telephone = 8;
-  string timezone_id = 9 [
+  optional string telephone = 8;
+  optional string timezone_id = 9 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.timezone.Timezone",
       target_service: "resource",
@@ -80,7 +78,7 @@ message ContactPoint {
       field_name: "timezone",
     }
   ];
-  string locale_id = 10 [
+  optional string locale_id = 10 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.locale.Locale",
       target_service: "resource",

package/io/restorecommerce/contact_point_type.proto

@@ -11,9 +11,7 @@ import "io/restorecommerce/options.proto";
 /*
 * Microservice definition.
 */
-service Service {
-  option (io.restorecommerce.options.service_name) = "contact_point_type";
-
+service ContactPointTypeService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (ContactPointTypeListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
@@ -29,14 +27,14 @@ message Deleted {
 
 message ContactPointTypeList {
   repeated ContactPointType items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
 message ContactPointType {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string type = 3;
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string type = 3;
 }
 
 message ContactPointTypeListResponse {

package/io/restorecommerce/country.proto

@@ -11,9 +11,7 @@ import "io/restorecommerce/options.proto";
 /*
 * Microservice definition.
 */
-service Service {
-  option (io.restorecommerce.options.service_name) = "country";
-
+service CountryService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (CountryListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
@@ -29,7 +27,7 @@ message Deleted {
 
 message CountryList {
   repeated Country items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -45,10 +43,10 @@ message CountryResponse {
 }
 
 message Country {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string name = 3;
-  string country_code = 4;
-  string geographical_name = 5;
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string name = 3;
+  optional string country_code = 4;
+  optional string geographical_name = 5;
   repeated string economic_areas = 6;
 }

package/io/restorecommerce/credential.proto

@@ -11,7 +11,7 @@ import "io/restorecommerce/status.proto";
 /*
 * Microservice definition.
 */
-service Service {
+service CredentialService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (CredentialListResponse);
   rpc Create (CredentialList) returns (CredentialListResponse);
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
@@ -25,7 +25,7 @@ message Deleted {
 
 message CredentialList {
   repeated Credential items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -41,11 +41,11 @@ message CredentialResponse {
 }
 
 message Credential {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string name = 3;
-  string description = 4;
-  string user = 5;
-  string pass = 6;
-  google.protobuf.Any credentials = 7; /// additional credentials as auth key or certificates etc
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string name = 3;
+  optional string description = 4;
+  optional string user = 5;
+  optional string pass = 6;
+  optional google.protobuf.Any credentials = 7; /// additional credentials as auth key or certificates etc
 }

package/io/restorecommerce/customer.proto

@@ -17,9 +17,7 @@ import "io/restorecommerce/organization.proto";
 /*
 Microservice definition.
 */
-service Service {
-  option (io.restorecommerce.options.service_name) = "customer";
-
+service CustomerService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (CustomerListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
@@ -31,7 +29,7 @@ service Service {
 
 message CustomerList {
   repeated Customer items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -47,8 +45,8 @@ message CustomerResponse {
 }
 
 message Customer {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
   oneof customer {
     IndividualUser individual_user = 3;
     OrgUser org_user = 4;
@@ -57,7 +55,7 @@ message Customer {
 }
 
 message IndividualUser {
-  string user_id = 1 [
+  optional string user_id = 1 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.user.User",
       target_service: "identity",
@@ -66,7 +64,7 @@ message IndividualUser {
       field_name: "user",
     }
   ];
-  string address_id = 2 [
+  optional string address_id = 2 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.address.Address",
       target_service: "resource",
@@ -87,7 +85,7 @@ message IndividualUser {
 }
 
 message OrgUser {
-  string user_id = 1 [
+  optional string user_id = 1 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.user.User",
       target_service: "identity",
@@ -96,7 +94,7 @@ message OrgUser {
       field_name: "user",
     }
   ];
-  string organization_id = 2 [
+  optional string organization_id = 2 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.organization.Organization",
       target_service: "resource",
@@ -109,7 +107,7 @@ message OrgUser {
 
 message Guest {
   bool guest = 1;
-  string address_id = 2 [
+  optional string address_id = 2 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.address.Address",
       target_service: "resource",

package/io/restorecommerce/file.proto

@@ -0,0 +1,23 @@
+syntax = "proto3";
+
+package io.restorecommerce.file;
+
+message File {
+  optional string id = 1;
+  optional int64 index = 2;
+  optional string caption = 3;
+  optional string filename = 4;
+  optional string content_type = 5;
+  optional string url = 6;
+  optional int64 bytes = 7;
+  repeated string tags = 8;
+}
+
+message FileList {
+  repeated File items = 1;
+  optional uint32 total_count = 2;
+}
+
+message Deleted {
+  string id = 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 tracking = 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;
-}
-
+}