@restorecommerce/protos 2.0.1 → 3.0.0

package/io/restorecommerce/locale.proto

@@ -11,9 +11,7 @@ import "io/restorecommerce/options.proto";
 /*
 * Microservice definition.
 */
-service Service {
-  option (io.restorecommerce.options.service_name) = "locale";
-
+service LocaleService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (LocaleListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
@@ -29,7 +27,7 @@ message Deleted {
 
 message LocaleList {
   repeated Locale items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -45,8 +43,8 @@ message LocaleResponse {
 }
 
 message Locale {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string value = 3;
-  string description = 4;
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string value = 3;
+  optional string description = 4;
 }

package/io/restorecommerce/location.proto

@@ -16,9 +16,7 @@ import "io/restorecommerce/address.proto";
 /*
 * Microservice definition.
 */
-service Service {
-  option (io.restorecommerce.options.service_name) = "location";
-
+service LocationService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (LocationListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
@@ -34,7 +32,7 @@ message Deleted {
 
 message LocationList {
   repeated Location items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -50,11 +48,11 @@ message LocationResponse {
 }
 
 message Location {
-  string id = 1; // Location ID, unique, key
-  io.restorecommerce.meta.Meta meta = 2;
-  string name = 3; // Location name
-  string description = 4;
-  string organization_id = 5 [
+  optional string id = 1; // Location ID, unique, key
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string name = 3; // Location name
+  optional string description = 4;
+  optional string organization_id = 5 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.organization.Organization",
       target_service: "resource",
@@ -63,7 +61,7 @@ message Location {
       field_name: "organization",
     }
   ]; // Organization to which this location is linked
-  string parent_id = 6 [
+  optional string parent_id = 6 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.location.Location",
       target_service: "resource",
@@ -72,7 +70,7 @@ message Location {
       field_name: "parent",
     }
   ];  //  Location which may contain this location; may be null
-  string address_id = 8 [
+  optional string address_id = 8 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.address.Address",
       target_service: "resource",
@@ -81,6 +79,6 @@ message Location {
       field_name: "address",
     }
   ];
-  google.protobuf.Any data = 9; /// additional data
-  string type = 10; // location type
+  optional google.protobuf.Any data = 9; /// additional data
+  optional string type = 10; // location type
 }

package/io/restorecommerce/manufacturer.proto

@@ -10,15 +10,15 @@ import "io/restorecommerce/options.proto";
 
 // Manufacturer resource
 message Manufacturer {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string name = 3;
-  string description = 4;
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string name = 3;
+  optional string description = 4;
 }
 
 message ManufacturerList {
   repeated Manufacturer items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -37,9 +37,7 @@ message Deleted {
   string id = 1;
 }
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "manufacturer";
-
+service ManufacturerService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (ManufacturerListResponse)  {
     option (io.restorecommerce.options.is_query) = true;
   };

package/io/restorecommerce/meta.proto

@@ -7,9 +7,9 @@ import "io/restorecommerce/attribute.proto";
 // meta properties common to all resources
 
 message Meta {
-    double created = 1; // timestamp
-    double modified = 2; // timestamp
-    string modified_by = 3; // ID from last User who modified it
+    optional double created = 1; // timestamp
+    optional double modified = 2; // timestamp
+    optional string modified_by = 3; // ID from last User who modified it
     repeated io.restorecommerce.attribute.Attribute owner = 4;
     repeated io.restorecommerce.attribute.AttributeObj acl = 5;
 }

package/io/restorecommerce/notification.proto

@@ -9,9 +9,7 @@ import "io/restorecommerce/status.proto";
 import "io/restorecommerce/options.proto";
 
 // Message structure for Notification
-service Service {
-  option (io.restorecommerce.options.service_name) = "notification";
-
+service NotificationService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (NotificationListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
@@ -27,7 +25,7 @@ message Deleted {
 
 message NotificationList {
   repeated Notification items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -43,15 +41,15 @@ message NotificationResponse {
 }
 
 message Notification {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string name = 3;
-  string description = 4;
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string name = 3;
+  optional string description = 4;
   repeated string notification_channel_ids = 5;
   oneof address_type {
     string email = 6;
     string telephone_number = 7;
   }
-  string subject_template = 8;
-  string body_template = 9;
+  optional string subject_template = 8;
+  optional string body_template = 9;
 }

package/io/restorecommerce/notification_channel.proto

@@ -8,7 +8,7 @@ import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
 
 // Message structure for Notification Channel
-service Service {
+service NotificationChannelService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (NotificationChannelListResponse);
   rpc Create (NotificationChannelList) returns (NotificationChannelListResponse);
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
@@ -22,7 +22,7 @@ message Deleted {
 
 message NotificationChannelList {
   repeated NotificationChannel items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -38,10 +38,10 @@ message NotificationChannelResponse {
 }
 
 message NotificationChannel {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string name = 3;
-  string description = 4;
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string name = 3;
+  optional string description = 4;
   oneof configuration_type {
     string email = 5;
     string sms = 6;

package/io/restorecommerce/notification_req.proto

@@ -4,24 +4,24 @@ package io.restorecommerce.notification_req;
 
 import "io/restorecommerce/status.proto";
 
-service Service {
+service NotificationReqService {
   // direct notifications
   rpc Send (NotificationReq) returns (io.restorecommerce.status.OperationStatusObj); /// generic fallback
 }
 
 // mimics nodemailer properties for easy configuration
 message Attachment {
-  string filename = 1;
+  optional string filename = 1;
 
   // the "content" may be on of the following:
-  string text = 2; // for textual data
-  bytes buffer = 3; // for binary data, eg.: images
-
-  string path = 4;
-  string content_type = 5;
-  string content_disposition = 6;
-  string cid = 7;
-  string encoding = 8;
+  optional string text = 2; // for textual data
+  optional bytes buffer = 3; // for binary data, eg.: images
+
+  optional string path = 4;
+  optional string content_type = 5;
+  optional string content_disposition = 6;
+  optional string cid = 7;
+  optional string encoding = 8;
 }
 
 // sendEmail NotificationReq event
@@ -30,10 +30,10 @@ message NotificationReq {
     Email email = 1;
     Log log = 2;
   }
-  string subject = 3;
-  string body = 4;  // text/HTML content
-  string transport = 5; /// 'email', 'log', ... default == 'log'
-  string provider = 6; /// specific transport provider, eg: 'console' for transport == 'log'
+  optional string subject = 3;
+  optional string body = 4;  // text/HTML content
+  optional string transport = 5; /// 'email', 'log', ... default == 'log'
+  optional string provider = 6; /// specific transport provider, eg: 'console' for transport == 'log'
   repeated Attachment attachments = 7;
 }
 
@@ -41,9 +41,9 @@ message Email {
   repeated string to = 1; // array of to email list
   repeated string cc = 2 ;// array of cc email list
   repeated string bcc = 3;  // array of bcc email list
-  string replyto = 4; // if set, the outgoing mail will have this replyTo header set
+  optional string replyto = 4; // if set, the outgoing mail will have this replyTo header set
 }
 
 message Log {
-  string level = 1;
+  optional string level = 1;
 }

package/io/restorecommerce/oauth.proto

@@ -7,7 +7,7 @@ import "io/restorecommerce/user.proto";
 import "io/restorecommerce/status.proto";
 import "google/protobuf/empty.proto";
 
-service Service {
+service OAuthService {
   rpc AvailableServices(google.protobuf.Empty) returns (ServicesResponse);
   rpc GenerateLinks(google.protobuf.Empty) returns (GenerateLinksResponse);
   rpc ExchangeCode(ExchangeCodeRequest) returns (ExchangeCodeResponse);

package/io/restorecommerce/order.proto

@@ -8,55 +8,52 @@ import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
 import "io/restorecommerce/options.proto";
 import "io/restorecommerce/address.proto";
+import "io/restorecommerce/tax.proto";
+import "io/restorecommerce/country.proto";
 import "io/restorecommerce/fulfillment.proto";
+import "io/restorecommerce/fulfillment_product.proto";
 
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "order";
-
+service OrderService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (OrderListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
   rpc Create (OrderList) returns (OrderListResponse);
   rpc Update (OrderList) returns (OrderListResponse);
   rpc Upsert (OrderList) returns (OrderListResponse);
+  rpc Evaluate (OrderList) returns (OrderListResponse);
   rpc Submit (OrderList) returns (OrderListResponse);
-  rpc Cancel (CancelRequestList) returns (OrderListResponse);
+  rpc Withdraw (OrderIdList) returns (OrderListResponse);
+  rpc Cancel (OrderIdList) returns (OrderListResponse);
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
-  rpc TriggerFulfillment (TriggerFulfillmentRequestList) returns (io.restorecommerce.status.Status);
+  
+  // Requires Fulfillment Service
+  rpc QueryPackingSolution (FulfillmentRequestList) returns (io.restorecommerce.fulfillment_product.PackingSolutionListResponse);
+  // Requires Fulfillment Service
+  rpc CreateFulfillment (FulfillmentRequestList) returns (io.restorecommerce.fulfillment.FulfillmentListResponse);
+  // Requires Fulfillment Service
+  rpc TriggerFulfillment (FulfillmentRequestList) returns (io.restorecommerce.status.StatusListResponse);
 }
 
-enum State {
-  Undefined = 0;
-  Invalid = 1;
-  Failed = 2;
-  Cancelled = 3;
-  Created = 4;
-  Submitted = 5;
-  Shipping = 6;
-  Done = 7;
+enum OrderState {
+  Created = 0;
+  Submitted = 1;
+  Confirmed = 2;
+  Invalid = 3;
+  Shipping = 4;
+  Failed = 5;
+  Done = 6;
+  Withdrawn = 7;
+  Cancelled = 8;
 }
 
-message Item {
-  // below identifier is id of product, variant or bundle
-  string product_variant_bundle_id = 1;
-  string product_name = 2;
-  string product_description = 3;
-  string manufacturer_name = 4;
-  string manufacturer_description = 5;
-  string prototype_name = 6;
-  string prototype_description = 7;
-  int32 quantity = 8;
-  int32 vat = 9;
-  double price = 10;
-  double quantity_price = 11;
-  string item_type = 12;
-  double taric_code = 13;
-  string stock_keeping_unit = 14;
-  double weight_in_kg = 15;
-  int32 length_in_cm = 16;
-  int32 width_in_cm = 17;
-  int32 height_in_cm = 18;
+message OrderItem {
+  optional string product_id = 1;
+  optional string variant_id = 2;
+  optional int32 quantity = 3;
+  optional double unit_price = 4; //Set by service
+  optional double price = 5; //Set by service
+  repeated io.restorecommerce.tax.VAT vats = 6; //Set by service
 }
 
 /**
@@ -71,45 +68,28 @@ message Order {
     deleted: "orderDeleted"
   };
 
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string name = 3;
-  string description = 4;
-  State state = 5;
-  string customer_reference = 6;
-  repeated Item items = 7;
-  double total_price = 8;
-  io.restorecommerce.address.Address shipping_address = 11;
-  io.restorecommerce.address.Address billing_address = 13;
-  string billing_email = 14;
-  io.restorecommerce.address.ContactPerson contact_person = 15;
-  string notification_email = 16;
-  repeated string fulfillment_ids = 17;
-}
-
-message ShippingDetails {
-  string export_type = 1;
-  string export_description = 2;
-  string invoice_number = 3;
-  io.restorecommerce.address.Address sender_address = 5;
-  io.restorecommerce.address.ContactPerson contact_person = 15;
-}
-
-message TriggerFulfillmentRequest {
-  Order order = 1;
-  ShippingDetails shipping_details = 2;
-  repeated io.restorecommerce.fulfillment.Parcel parcels = 3;
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional OrderState state = 3;
+  optional string customer_reference = 4;
+  repeated OrderItem items = 5;
+  optional double total_price = 6; //Set by service
+  optional double total_vat = 7; //Set by service
+  optional io.restorecommerce.address.ShippingAddress shipping_address = 8;
+  optional io.restorecommerce.address.ShippingAddress billing_address = 9;
+  optional string billing_email = 10;
+  optional string notification_email = 11;
+  optional io.restorecommerce.fulfillment_product.Preferences packing_preferences = 12;
 }
 
-message TriggerFulfillmentRequestList {
-  repeated TriggerFulfillmentRequest items = 1;
-  uint32 total_count = 2;
-  io.restorecommerce.auth.Subject subject = 3;
+message OrderIdList {
+  repeated string ids = 1;
+  io.restorecommerce.auth.Subject subject = 2;
 }
 
 message OrderList {
   repeated Order items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -124,11 +104,24 @@ message OrderResponse {
   io.restorecommerce.status.Status status = 2;
 }
 
-message CancelRequestList {
-  repeated string ids = 1;
-  io.restorecommerce.auth.Subject subject = 2;
-}
-
 message Deleted {
   string id = 1;
+}
+
+message ShippingDetails {
+  optional string export_type = 1;
+  optional string export_description = 2;
+  optional string invoice_number = 3;
+  optional io.restorecommerce.address.ShippingAddress sender_address = 4;
+}
+
+message FulfillmentRequest {
+  optional string reference_id = 1;
+  optional ShippingDetails shipping_details = 2;
+}
+
+message FulfillmentRequestList {
+  repeated FulfillmentRequest items = 1;
+  optional uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
 }

package/io/restorecommerce/organization.proto

@@ -13,9 +13,7 @@ import "io/restorecommerce/options.proto";
 import "io/restorecommerce/address.proto";
 import "io/restorecommerce/contact_point.proto";
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "organization";
-
+service OrganizationService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (OrganizationListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
@@ -37,7 +35,7 @@ message DeleteOrgData {
 
 message OrganizationList {
   repeated Organization items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -53,9 +51,9 @@ message OrganizationResponse {
 }
 
 message Organization {
-  string id = 1; /// Organization ID, unique, key
-  io.restorecommerce.meta.Meta meta = 2;
-  string address_id = 3 [
+  optional string id = 1; /// Organization ID, unique, key
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string address_id = 3 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.address.Address",
       target_service: "resource",
@@ -64,7 +62,7 @@ message Organization {
       field_name: "address",
     }
   ]; /// Address for the organization
-  string parent_id = 4 [
+  optional string parent_id = 4 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.organization.Organization",
       target_service: "resource",
@@ -82,14 +80,14 @@ message Organization {
       field_name: "contactPoints",
     }
   ]; // list of possible legal addresses of different types
-  string website = 7;
-  string email = 8;
-  string logo = 9; // base64; arangoDB does not support blob storage
-  string vat_id = 10;
-  string isic_v4 = 11;
-  string registration = 12;
-  string registration_court = 13;
-  string name = 14;
+  optional string website = 7;
+  optional string email = 8;
+  optional string logo = 9; // base64; arangoDB does not support blob storage
+  optional string vat_id = 10;
+  optional string isic_v4 = 11;
+  optional string registration = 12;
+  optional string registration_court = 13;
+  optional string name = 14;
   repeated string payment_method_ids = 15;
-  google.protobuf.Any data = 16; /// additional data
+  optional google.protobuf.Any data = 16; /// additional data
 }

package/io/restorecommerce/ostorage.proto

@@ -11,9 +11,7 @@ import "io/restorecommerce/status.proto";
 import "io/restorecommerce/resource_base.proto";
 import "io/restorecommerce/options.proto";
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "object";
-
+service ObjectService {
   rpc Get (GetRequest) returns (stream ObjectResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
@@ -45,8 +43,8 @@ message CopyRequestItem {
   string bucket = 1;
   string copySource = 2;
   string key = 3;
-  io.restorecommerce.meta.Meta meta = 4;
-  Options options = 5;
+  optional io.restorecommerce.meta.Meta meta = 4;
+  optional Options options = 5;
 }
 
 message CopyResponseItem {
@@ -58,24 +56,24 @@ message CopyResponseItem {
 }
 
 message Options {
-  string encoding = 1;
-  string content_type = 2;
-  string content_language = 3;
-  string content_disposition = 4;
-  int32 length = 5;
-  string version = 6;
-  string md5 = 7;
+  optional string encoding = 1;
+  optional string content_type = 2;
+  optional string content_language = 3;
+  optional string content_disposition = 4;
+  optional int32 length = 5;
+  optional string version = 6;
+  optional string md5 = 7;
   repeated io.restorecommerce.attribute.Attribute tags = 8;
-  google.protobuf.Any data = 9; // optional meta data ex: from and to dates
+  optional google.protobuf.Any data = 9; // optional meta data ex: from and to dates
 }
 
 message Object {
   string key = 1;
   string bucket = 2;
-  bytes object = 3;
-  io.restorecommerce.meta.Meta meta = 4;
-  string url = 5;
-  Options options = 6;
+  optional bytes object = 3;
+  optional io.restorecommerce.meta.Meta meta = 4;
+  optional string url = 5;
+  optional Options options = 6;
   io.restorecommerce.auth.Subject subject = 7;
 }
 
@@ -101,7 +99,7 @@ message ObjectResponsePayload {
 message GetRequest {
   string key = 1;
   string bucket = 2;
-  bool download = 3;
+  optional bool download = 3;
   io.restorecommerce.auth.Subject subject = 4;
 }
 
@@ -148,19 +146,19 @@ message Response {
 
 message ListRequest {
   string bucket = 1;
-  io.restorecommerce.filter.FilterOp filters = 2; /// Filter based on fieldName|operation, value|list
+  optional io.restorecommerce.filter.FilterOp filters = 2; /// Filter based on fieldName|operation, value|list
   io.restorecommerce.auth.Subject subject = 3;
-  int32 max_keys = 4;
-  string prefix = 5;
+  optional int32 max_keys = 4;
+  optional string prefix = 5;
 }
 
 // OstorageMessage is used for emitting
 // objectUploaded and objectDownloaded events
 message OstorageMessage {
-  string key = 1;
-  string bucket = 2;
-  google.protobuf.Any metadata = 3;
-  io.restorecommerce.auth.Subject subject = 4;
+  optional string key = 1;
+  optional string bucket = 2;
+  optional google.protobuf.Any metadata = 3;
+  optional io.restorecommerce.auth.Subject subject = 4;
 }
 
 message MoveRequestList {
@@ -169,11 +167,11 @@ message MoveRequestList {
 }
 
 message MoveRequestItem {
-  string bucket = 1; // destination bucket name
-  string sourceObject = 2; // source object with bucket name
-  string key = 3; // destination key name
-  io.restorecommerce.meta.Meta meta = 4;
-  Options options = 5;
+  optional string bucket = 1; // destination bucket name
+  optional string sourceObject = 2; // source object with bucket name
+  optional string key = 3; // destination key name
+  optional io.restorecommerce.meta.Meta meta = 4;
+  optional Options options = 5;
 }
 
 message MoveResponseList {