@restorecommerce/protos 2.0.2 → 3.0.0

package/io/restorecommerce/payment.proto

@@ -4,9 +4,7 @@ import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
 import "io/restorecommerce/options.proto";
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "payment";
-
+service PaymentService {
   // Wrapper for setup_authorization in ActiveMerchant
   rpc SetupAuthorization (SetupRequest) returns (SetupResponse);
 
@@ -25,18 +23,18 @@ service Service {
 
 // Request object for setup calls
 message SetupRequest {
-  string ip = 1;
+  optional string ip = 1;
   repeated Item items = 2;
-  int32 subtotal = 3;
-  int32 shipping = 4;
-  int32 handling = 5;
-  int32 tax = 6;
-  string currency = 7;
-  string return_url = 8;
-  string cancel_return_url = 9;
-  bool allow_guest_checkout = 10;
-  Provider provider = 11;
-  io.restorecommerce.auth.Subject subject = 12;
+  optional int32 subtotal = 3;
+  optional int32 shipping = 4;
+  optional int32 handling = 5;
+  optional int32 tax = 6;
+  optional string currency = 7;
+  optional string return_url = 8;
+  optional string cancel_return_url = 9;
+  optional bool allow_guest_checkout = 10;
+  optional Provider provider = 11;
+  optional io.restorecommerce.auth.Subject subject = 12;
 }
 
 message SetupPayload {
@@ -58,21 +56,21 @@ message SetupResponse {
 
 // Request object for authorization or purchase call for cardless payment.
 message PaymentRequest {
-  Provider provider = 1;
-  int32 payment_sum = 2;
-  string currency = 3;
-  string payment_id = 4;
-  string payer_id = 5;
-  string token = 6;
+  optional Provider provider = 1;
+  optional int32 payment_sum = 2;
+  optional string currency = 3;
+  optional string payment_id = 4;
+  optional string payer_id = 5;
+  optional string token = 6;
   io.restorecommerce.auth.Subject subject = 7;
 }
 
 // Request object for capture call for both standard and cardless payments.
 message CaptureRequest {
-  Provider provider = 1;
-  int32 payment_sum = 2;
-  string currency = 3;
-  string payment_id = 4;
+  optional Provider provider = 1;
+  optional int32 payment_sum = 2;
+  optional string currency = 3;
+  optional string payment_id = 4;
   io.restorecommerce.auth.Subject subject = 5;
 }
 
@@ -95,20 +93,20 @@ message PaymentResponse {
 
 // Used for building ActiveMerchant::Billing::CreditCard instance.
 message PaymentCard {
-  string primary_number = 1;
-  string first_name = 2;
-  string last_name = 3;
-  string month = 4;
-  int32 year = 5;
-  string verification_value = 6;
+  optional string primary_number = 1;
+  optional string first_name = 2;
+  optional string last_name = 3;
+  optional string month = 4;
+  optional int32 year = 5;
+  optional string verification_value = 6;
 }
 
 // Represents purchased item. Not all providers support this.
 message Item {
-  string name = 1;
-  string description = 2;
-  int32 quantity = 3;
-  int32 amount = 4;
+  optional string name = 1;
+  optional string description = 2;
+  optional int32 quantity = 3;
+  optional int32 amount = 4;
 }
 
 // Possible service providers. Provider names must be exactly as in config.yml.

package/io/restorecommerce/payment_method.proto

@@ -11,7 +11,7 @@ import "io/restorecommerce/status.proto";
 /*
 * Microservice definition.
 */
-service Service {
+service PaymentMethodService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (PaymentMethodListResponse);
   rpc Create (PaymentMethodList) returns (PaymentMethodListResponse);
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
@@ -25,7 +25,7 @@ message Deleted {
 
 message PaymentMethodList {
   repeated PaymentMethod items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -52,9 +52,9 @@ enum TransferTypeEnum {
 }
 
 message PaymentMethod {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  PaymentMethodEnum payment_method = 3;
-  TransferTypeEnum transfer_type = 4;
-  google.protobuf.Any data = 5;
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional PaymentMethodEnum payment_method = 3;
+  optional TransferTypeEnum transfer_type = 4;
+  optional google.protobuf.Any data = 5;
 }

package/io/restorecommerce/policy.proto

@@ -13,30 +13,30 @@ import "io/restorecommerce/options.proto";
 * A Policy is defined by a set of Rules.
 */
 message Policy {
-  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 rules = 5;  // rule IDs
-  io.restorecommerce.rule.Target target = 6;  // general policy target
-  io.restorecommerce.rule.Effect effect = 7;
-  string combining_algorithm = 8;
-  bool evaluation_cacheable = 9;
+  optional io.restorecommerce.rule.Target target = 6;  // general policy target
+  optional io.restorecommerce.rule.Effect effect = 7;
+  optional string combining_algorithm = 8;
+  optional bool evaluation_cacheable = 9;
 }
 
 message PolicyRQ {
-  string id = 1;
-  io.restorecommerce.rule.Target target = 2;
-  string combining_algorithm = 3;
+  optional string id = 1;
+  optional io.restorecommerce.rule.Target target = 2;
+  optional string combining_algorithm = 3;
   repeated io.restorecommerce.rule.RuleRQ rules = 4;
-  io.restorecommerce.rule.Effect effect = 5;
-  bool has_rules = 6;
-  bool evaluation_cacheable = 7;
+  optional io.restorecommerce.rule.Effect effect = 5;
+  optional bool has_rules = 6;
+  optional bool evaluation_cacheable = 7;
 }
 
 message PolicyList {
   repeated Policy items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -51,9 +51,7 @@ message PolicyResponse {
   io.restorecommerce.status.Status status = 2;
 }
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "policy";
-
+service PolicyService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (PolicyListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };

package/io/restorecommerce/policy_set.proto

@@ -11,18 +11,18 @@ import "io/restorecommerce/status.proto";
 import "io/restorecommerce/options.proto";
 
 message PolicySet {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string name = 3;
-  string description = 4;
-  io.restorecommerce.rule.Target target = 5;
-  string combining_algorithm = 6;
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string name = 3;
+  optional string description = 4;
+  optional io.restorecommerce.rule.Target target = 5;
+  optional string combining_algorithm = 6;
   repeated string policies = 7; // policy IDs
 }
 
 message PolicySetList {
   repeated PolicySet items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -38,16 +38,14 @@ message PolicySetResponse {
 }
 
 message PolicySetRQ {
-  string id = 1;
-  io.restorecommerce.rule.Target target = 2;
-  string combining_algorithm = 3;
+  optional string id = 1;
+  optional io.restorecommerce.rule.Target target = 2;
+  optional string combining_algorithm = 3;
   repeated io.restorecommerce.policy.PolicyRQ policies = 4;
-  io.restorecommerce.rule.Effect effect = 5;
+  optional io.restorecommerce.rule.Effect effect = 5;
 }
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "policy_set";
-
+service PolicySetService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (PolicySetListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };

package/io/restorecommerce/price_group.proto

@@ -10,15 +10,15 @@ import "io/restorecommerce/options.proto";
 
 // PriceGroup resource
 message PriceGroup {
-  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 PriceGroupList {
   repeated PriceGroup 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) = "price_group";
-
+service PriceGroupService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (PriceGroupListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };

package/io/restorecommerce/product.proto

@@ -2,20 +2,21 @@ syntax = "proto3";
 
 package io.restorecommerce.product;
 
+import "google/protobuf/any.proto";
 import "io/restorecommerce/resource_base.proto";
 import "io/restorecommerce/meta.proto";
 import "io/restorecommerce/image.proto";
+import "io/restorecommerce/file.proto";
 import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
 import "io/restorecommerce/attribute.proto";
+import "io/restorecommerce/geometry.proto";
 import "io/restorecommerce/options.proto";
 
 // Used by resolvers
 import "io/restorecommerce/manufacturer.proto";
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "product";
-
+service ProductService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (ProductListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
@@ -25,22 +26,63 @@ service Service {
   rpc Upsert (ProductList) returns (ProductListResponse);
 }
 
-// Product resource
-message MainProduct {
-  string id = 1;
+enum AssociationType {
+  Miscellaneous = 0;
+  Accessory = 1;
+  Recommendation = 2;
+}
+
+message Association {
+  optional string product_id = 1 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.product.Product",
+      target_service: "catalog",
+      target_sub_service: "product",
+      target_method: "Read",
+      field_name: "product",
+    }
+  ];
+  AssociationType type = 2;
+  repeated string tags = 3;
+  google.protobuf.Any data = 4;
+}
+
+message Appendix {
+  optional int64 index = 1;
+  optional string name = 2;
+  optional string description = 3;
+  repeated string tags = 4;
+  optional string url = 5;
+  optional string content_type = 6;
+  optional io.restorecommerce.image.Image thumbnail = 7;
+}
+
+// Product resource entity
+message Product {
+  option (restorecommerce.options.kafka_subscriber) = {
+    plural: "products"
+    topic: "io.restorecommerce.product.resource"
+    created: "productCreated"
+    updated: "productUpdated"
+    deleted: "productDeleted"
+  };
+
+  optional string id = 1;
+  io.restorecommerce.meta.Meta meta = 2;
   oneof product_type {
-    Product product = 2;
-    Bundle bundle = 3;
+    IndividualProduct product = 3;
+    Bundle bundle = 4;
   }
-  bool active = 4;
-  io.restorecommerce.meta.Meta meta = 5;
+  optional bool active = 5;
+  repeated string tags = 6;
+  repeated Association associations = 7;
+  google.protobuf.Any data = 8;
 }
 
-message Product {
-  string id = 1;
-  string name = 2;
-  string description = 3;
-  string manufacturer_id = 4 [
+message IndividualProduct {
+  optional string name = 1;
+  optional string description = 2;
+  optional string manufacturer_id = 3 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.manufacturer.Manufacturer",
       target_service: "catalog",
@@ -49,24 +91,47 @@ message Product {
       field_name: "manufacturer",
     }
   ];
-  string taric_code = 5;
+  optional string taric_code = 4;
   oneof classification {
-    Identifier prototype = 6;
-    Identifier category = 7;
+    string prototype_id = 5 [
+      (io.restorecommerce.options.resolver) = {
+        target_type: ".io.restorecommerce.product_prototype.ProductPrototype",
+        target_service: "catalog",
+        target_sub_service: "product_prototype",
+        target_method: "Read",
+        field_name: "prototype",
+      }
+    ];
+    string category_id = 6 [
+      (io.restorecommerce.options.resolver) = {
+        target_type: ".io.restorecommerce.product_category.ProductCategory",
+        target_service: "catalog",
+        target_sub_service: "product_category",
+        target_method: "Read",
+        field_name: "category",
+      }
+    ];
   }
-  repeated string tax_id = 8;
-  repeated Variant variants = 9;
-  string gtin = 10;
+  repeated string tax_ids = 7;
+  optional string gtin = 8;
+  oneof nature {
+    PhysicalProduct physical = 9;
+    VirtualProduct virtual = 10;
+  };
+}
+
+message PhysicalProduct {
+  repeated PhysicalVariant variants = 1;
 }
 
-message Identifier {
-  string id = 1;
+message VirtualProduct {
+  repeated VirtualVariant variants = 1;
 }
 
 message ProductList {
-  repeated MainProduct items = 1;
-  uint32 total_count = 2;
-  io.restorecommerce.auth.Subject subject = 3;
+  repeated Product items = 1;
+  optional uint32 total_count = 2;
+  optional io.restorecommerce.auth.Subject subject = 3;
 }
 
 message ProductListResponse {
@@ -76,38 +141,71 @@ message ProductListResponse {
 }
 
 message ProductResponse {
-  MainProduct payload = 1;
+  Product payload = 1;
   io.restorecommerce.status.Status status = 3;
 }
 
-message Variant {
-  string id = 1;
-  string name = 2;
-  string description = 3;
-  int32 stock_level = 4;
-  double price = 5;
-  bool sale = 6;
-  double sale_price = 7;
-  repeated io.restorecommerce.image.Image image = 8;
-  string stock_keeping_unit = 9;
-  string template_variant = 10;
-  repeated io.restorecommerce.attribute.Attribute attributes = 11;
+message Package {
+  optional io.restorecommerce.geometry.BoundingBox3D size_in_cm = 1;
+  optional double weight_in_kg = 2;
+  optional bool rotatable = 3;
+}
+
+message PhysicalVariant {
+  optional string id = 1;
+  optional string name = 2;
+  optional string description = 3;
+  optional int32 stock_level = 4;
+  optional double price = 5;
+  optional bool sale = 6;
+  optional double sale_price = 7;
+  repeated io.restorecommerce.image.Image images = 8;
+  repeated io.restorecommerce.file.File files = 9;
+  optional string stock_keeping_unit = 10;
+  optional string template_variant = 11;
+  optional Package package = 12;
+  repeated io.restorecommerce.attribute.Attribute attributes = 13;
+}
+
+message VirtualVariant {
+  optional string id = 1;
+  optional string name = 2;
+  optional string description = 3;
+  optional int32 stock_level = 4;
+  optional double price = 5;
+  optional bool sale = 6;
+  optional double sale_price = 7;
+  repeated io.restorecommerce.image.Image images = 8;
+  repeated io.restorecommerce.file.File files = 9;
+  optional string stock_keeping_unit = 10;
+  optional string template_variant = 11;
+  repeated io.restorecommerce.attribute.Attribute attributes = 12;
 }
 
 message Bundle {
-  string id = 1;
-  string name = 3;
-  string description = 4;
-  repeated io.restorecommerce.image.Image image = 5;
-  repeated BundleProduct product = 6;
-  double price = 7;
+  optional string name = 1;
+  optional string description = 2;
+  repeated io.restorecommerce.image.Image image = 3;
+  repeated BundleProduct products = 4;
+  optional double price = 5;
+  optional Package pre_packaged = 6;
 }
 
 message BundleProduct {
-  string product_id = 1;
-  uint32 quantity = 2;
+  optional string product_id = 1 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.product.Product",
+      target_service: "catalog",
+      target_sub_service: "product",
+      target_method: "Read",
+      field_name: "product",
+    }
+  ];
+  optional string variant_id = 2;
+  optional uint32 quantity = 3;
+  optional double tax_ratio = 4; //Discount in relation to the bundle price
 }
 
 message Deleted {
-  string id = 1;
+  optional string id = 1;
 }

package/io/restorecommerce/product_category.proto

@@ -14,11 +14,11 @@ import "io/restorecommerce/price_group.proto";
 
 // ProductCategory resource
 message ProductCategory {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string name = 3;
-  string description = 4;
-  string price_group_id = 5 [
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string name = 3;
+  optional string description = 4;
+  optional string price_group_id = 5 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.price_group.PriceGroup",
       target_service: "catalog",
@@ -27,13 +27,13 @@ message ProductCategory {
       field_name: "priceGroup",
     }
   ];
-  io.restorecommerce.image.Image image = 6;
-  Parent parent = 7;
+  optional io.restorecommerce.image.Image image = 6;
+  optional Parent parent = 7;
 }
 
 message ProductCategoryList {
   repeated ProductCategory items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -53,12 +53,10 @@ message Deleted {
 }
 
 message Parent {
-  string parent_id = 1;
+  optional string parent_id = 1;
 }
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "product_category";
-
+service ProductCategoryService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (ProductCategoryListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };

package/io/restorecommerce/product_prototype.proto

@@ -10,17 +10,17 @@ import "io/restorecommerce/options.proto";
 
 // ProductPrototype resource
 message ProductPrototype {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string name = 3;
-  string version = 4;
-  string description = 5;
-  string category_id = 6;
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string name = 3;
+  optional string version = 4;
+  optional string description = 5;
+  optional string category_id = 6;
 }
 
 message ProductPrototypeList {
   repeated ProductPrototype items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -39,9 +39,7 @@ message Deleted {
   string id = 1;
 }
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "product_prototype";
-
+service ProductPrototypeService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (ProductPrototypeListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };