@restorecommerce/protos 5.0.1 → 6.1.0

package/io/restorecommerce/ostorage.proto

@@ -26,33 +26,33 @@ service ObjectService {
 
 message CopyRequestList {
   repeated CopyRequestItem items = 1;
-  io.restorecommerce.auth.Subject subject = 2;
+  optional io.restorecommerce.auth.Subject subject = 2;
 }
 
 message CopyResponseList {
   repeated copyResponsePayloadWithStatus responses = 1;
-  io.restorecommerce.status.OperationStatus operation_status = 2;
+  optional io.restorecommerce.status.OperationStatus operation_status = 2;
 }
 
 message copyResponsePayloadWithStatus {
-  CopyResponseItem payload = 1;
-  io.restorecommerce.status.Status status = 2;
+  optional CopyResponseItem payload = 1;
+  optional io.restorecommerce.status.Status status = 2;
 }
 
 message CopyRequestItem {
-  string bucket = 1;
-  string copySource = 2;
-  string key = 3;
+  optional string bucket = 1;
+  optional string copySource = 2;
+  optional string key = 3;
   optional io.restorecommerce.meta.Meta meta = 4;
   optional Options options = 5;
 }
 
 message CopyResponseItem {
-  string bucket = 1;
-  string copySource = 2;
-  string key = 3;
-  io.restorecommerce.meta.Meta meta = 4;
-  Options options = 5;
+  optional string bucket = 1;
+  optional string copySource = 2;
+  optional string key = 3;
+  optional io.restorecommerce.meta.Meta meta = 4;
+  optional Options options = 5;
 }
 
 message Options {
@@ -68,86 +68,86 @@ message Options {
 }
 
 message Object {
-  string key = 1;
-  string bucket = 2;
+  optional string key = 1;
+  optional string bucket = 2;
   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;
+  optional io.restorecommerce.auth.Subject subject = 7;
 }
 
 message ObjectResponse {
-  ObjectResponsePayloadWithStatus response = 1;
-  io.restorecommerce.status.OperationStatus operation_status = 2;
+  optional ObjectResponsePayloadWithStatus response = 1;
+  optional io.restorecommerce.status.OperationStatus operation_status = 2;
 }
 
 message ObjectResponsePayloadWithStatus {
-  ObjectResponsePayload payload = 1;
-  io.restorecommerce.status.Status status = 3;
+  optional ObjectResponsePayload payload = 1;
+  optional io.restorecommerce.status.Status status = 3;
 }
 
 message ObjectResponsePayload {
-  string key = 1;
-  string bucket = 2;
-  bytes object = 3;
-  io.restorecommerce.meta.Meta meta = 4;
-  string url = 5;
-  Options options = 6;
+  optional string key = 1;
+  optional string bucket = 2;
+  optional bytes object = 3;
+  optional io.restorecommerce.meta.Meta meta = 4;
+  optional string url = 5;
+  optional Options options = 6;
 }
 
 message GetRequest {
-  string key = 1;
-  string bucket = 2;
+  optional string key = 1;
+  optional string bucket = 2;
   optional bool download = 3;
-  io.restorecommerce.auth.Subject subject = 4;
+  optional io.restorecommerce.auth.Subject subject = 4;
 }
 
 message ListResponse {
   repeated ObjectsDataWithPayloadStatus responses = 1;
-  io.restorecommerce.status.OperationStatus operation_status = 2;
+  optional io.restorecommerce.status.OperationStatus operation_status = 2;
 }
 
 message ObjectsDataWithPayloadStatus {
- ObjectData payload = 1;
- io.restorecommerce.status.Status status = 2;
+ optional ObjectData payload = 1;
+ optional io.restorecommerce.status.Status status = 2;
 }
 
 message ObjectData {
-  string object_name = 1;
-  string url = 2;
-  io.restorecommerce.meta.Meta meta = 3;
+  optional string object_name = 1;
+  optional string url = 2;
+  optional io.restorecommerce.meta.Meta meta = 3;
 }
 
 message DeleteRequest {
-  string key = 1;
-  string bucket = 2;
-  io.restorecommerce.auth.Subject subject = 3;
+  optional string key = 1;
+  optional string bucket = 2;
+  optional io.restorecommerce.auth.Subject subject = 3;
 }
 
 message PutResponse {
-  PutResponseWithPayloadStatus response = 1;
-  io.restorecommerce.status.OperationStatus operation_status = 2;
+  optional PutResponseWithPayloadStatus response = 1;
+  optional io.restorecommerce.status.OperationStatus operation_status = 2;
 }
 
 message PutResponseWithPayloadStatus {
-  Response payload = 1;
-  io.restorecommerce.status.Status status = 2;
+  optional Response payload = 1;
+  optional io.restorecommerce.status.Status status = 2;
 }
 
 message Response {
-  string url = 1;
-  string bucket = 2 ;
-  string key = 3;
-  io.restorecommerce.meta.Meta meta = 4;
+  optional string url = 1;
+  optional string bucket = 2 ;
+  optional string key = 3;
+  optional io.restorecommerce.meta.Meta meta = 4;
   repeated io.restorecommerce.attribute.Attribute tags = 5;
-  int32 length = 6; // file size of uploaded object
+  optional int32 length = 6; // file size of uploaded object
 }
 
 message ListRequest {
-  string bucket = 1;
+  optional string bucket = 1;
   optional io.restorecommerce.filter.FilterOp filters = 2; /// Filter based on fieldName|operation, value|list
-  io.restorecommerce.auth.Subject subject = 3;
+  optional io.restorecommerce.auth.Subject subject = 3;
   optional int32 max_keys = 4;
   optional string prefix = 5;
 }
@@ -163,7 +163,7 @@ message OstorageMessage {
 
 message MoveRequestList {
   repeated MoveRequestItem items = 1;
-  io.restorecommerce.auth.Subject subject = 2;
+  optional io.restorecommerce.auth.Subject subject = 2;
 }
 
 message MoveRequestItem {
@@ -176,18 +176,18 @@ message MoveRequestItem {
 
 message MoveResponseList {
   repeated MoveResponsePayloadWithStatus responses = 1;
-  io.restorecommerce.status.OperationStatus operation_status = 2;
+  optional io.restorecommerce.status.OperationStatus operation_status = 2;
 }
 
 message MoveResponsePayloadWithStatus {
-  MoveResponseItem payload = 1;
-  io.restorecommerce.status.Status status = 2;
+  optional MoveResponseItem payload = 1;
+  optional io.restorecommerce.status.Status status = 2;
 }
 
 message MoveResponseItem {
-  string bucket = 1;
-  string sourceObject = 2;
-  string key = 3;
-  io.restorecommerce.meta.Meta meta = 4;
-  Options options = 5;
+  optional string bucket = 1;
+  optional string sourceObject = 2;
+  optional string key = 3;
+  optional io.restorecommerce.meta.Meta meta = 4;
+  optional Options options = 5;
 }

package/io/restorecommerce/payment.proto

@@ -38,20 +38,20 @@ message SetupRequest {
 }
 
 message SetupPayload {
-  string token = 1;
-  string confirm_initiation_url = 2;
-  string initiated_on = 3;
+  optional string token = 1;
+  optional string confirm_initiation_url = 2;
+  optional string initiated_on = 3;
 }
 
 message SetupPayloadStatus {
-  SetupPayload payload = 1;
-  io.restorecommerce.status.Status status = 2;
+  optional SetupPayload payload = 1;
+  optional io.restorecommerce.status.Status status = 2;
 }
 
 // Response object for setup calls.
 message SetupResponse {
-  SetupPayloadStatus item = 1;
-  io.restorecommerce.status.OperationStatus operation_status = 2;
+  optional SetupPayloadStatus item = 1;
+  optional io.restorecommerce.status.OperationStatus operation_status = 2;
 }
 
 // Request object for authorization or purchase call for cardless payment.
@@ -62,7 +62,7 @@ message PaymentRequest {
   optional string payment_id = 4;
   optional string payer_id = 5;
   optional string token = 6;
-  io.restorecommerce.auth.Subject subject = 7;
+  optional io.restorecommerce.auth.Subject subject = 7;
 }
 
 // Request object for capture call for both standard and cardless payments.
@@ -71,24 +71,24 @@ message CaptureRequest {
   optional int32 payment_sum = 2;
   optional string currency = 3;
   optional string payment_id = 4;
-  io.restorecommerce.auth.Subject subject = 5;
+  optional io.restorecommerce.auth.Subject subject = 5;
 }
 
 message PaymentPayload {
-  string payment_id = 1;
-  string executed_on = 2;
+  optional string payment_id = 1;
+  optional string executed_on = 2;
 }
 
 message PaymentPayloadStatus {
-  PaymentPayload payload = 1;
-  io.restorecommerce.status.Status status = 2;
+  optional PaymentPayload payload = 1;
+  optional io.restorecommerce.status.Status status = 2;
 }
 
 // Unified response object for authorization, purchase and capture calls
 // for both standard and cardless payments.
 message PaymentResponse {
-  PaymentPayloadStatus item = 1;
-  io.restorecommerce.status.OperationStatus operation_status = 2;
+  optional PaymentPayloadStatus item = 1;
+  optional io.restorecommerce.status.OperationStatus operation_status = 2;
 }
 
 // Used for building ActiveMerchant::Billing::CreditCard instance.

package/io/restorecommerce/payment_method.proto

@@ -20,24 +20,24 @@ service PaymentMethodService {
 }
 
 message Deleted {
-  string id = 1;
+  optional string id = 1;
 }
 
 message PaymentMethodList {
   repeated PaymentMethod items = 1;
   optional uint32 total_count = 2;
-  io.restorecommerce.auth.Subject subject = 3;
+  optional io.restorecommerce.auth.Subject subject = 3;
 }
 
 message PaymentMethodListResponse {
   repeated PaymentMethodResponse items = 1;
-  uint32 total_count = 2;
-  io.restorecommerce.status.OperationStatus operation_status = 3;
+  optional uint32 total_count = 2;
+  optional io.restorecommerce.status.OperationStatus operation_status = 3;
 }
 
 message PaymentMethodResponse {
-  PaymentMethod payload = 1;
-  io.restorecommerce.status.Status status = 2;
+  optional PaymentMethod payload = 1;
+  optional io.restorecommerce.status.Status status = 2;
 }
 
 enum PaymentMethodEnum {

package/io/restorecommerce/policy.proto

@@ -37,18 +37,18 @@ message PolicyRQ {
 message PolicyList {
   repeated Policy items = 1;
   optional uint32 total_count = 2;
-  io.restorecommerce.auth.Subject subject = 3;
+  optional io.restorecommerce.auth.Subject subject = 3;
 }
 
 message PolicyListResponse {
   repeated PolicyResponse items = 1;
-  uint32 total_count = 2;
-  io.restorecommerce.status.OperationStatus operation_status = 3;
+  optional uint32 total_count = 2;
+  optional io.restorecommerce.status.OperationStatus operation_status = 3;
 }
 
 message PolicyResponse {
-  Policy payload = 1;
-  io.restorecommerce.status.Status status = 2;
+  optional Policy payload = 1;
+  optional io.restorecommerce.status.Status status = 2;
 }
 
 service PolicyService {

package/io/restorecommerce/policy_set.proto

@@ -23,18 +23,18 @@ message PolicySet {
 message PolicySetList {
   repeated PolicySet items = 1;
   optional uint32 total_count = 2;
-  io.restorecommerce.auth.Subject subject = 3;
+  optional io.restorecommerce.auth.Subject subject = 3;
 }
 
 message PolicySetListResponse {
   repeated PolicySetResponse items = 1;
-  uint32 total_count = 2;
-  io.restorecommerce.status.OperationStatus operation_status = 3;
+  optional uint32 total_count = 2;
+  optional io.restorecommerce.status.OperationStatus operation_status = 3;
 }
 
 message PolicySetResponse {
-  PolicySet payload = 1;
-  io.restorecommerce.status.Status status = 2;
+  optional PolicySet payload = 1;
+  optional io.restorecommerce.status.Status status = 2;
 }
 
 message PolicySetRQ {

package/io/restorecommerce/price.proto

@@ -4,7 +4,6 @@ package io.restorecommerce.price;
 
 // Used by resolvers
 import "io/restorecommerce/options.proto";
-import "io/restorecommerce/tax.proto";
 import "io/restorecommerce/currency.proto";
 
 message Price {
@@ -20,13 +19,4 @@ message Price {
       field_name: "currency",
     }
   ];
-  repeated string tax_ids = 5 [
-    (io.restorecommerce.options.resolver) = {
-      target_type: ".io.restorecommerce.tax.Tax",
-      target_service: "master_data",
-      target_sub_service: "tax",
-      target_method: "Read",
-      field_name: "taxes",
-    }
-  ];
 }

package/io/restorecommerce/price_group.proto

@@ -19,22 +19,22 @@ message PriceGroup {
 message PriceGroupList {
   repeated PriceGroup items = 1;
   optional uint32 total_count = 2;
-  io.restorecommerce.auth.Subject subject = 3;
+  optional io.restorecommerce.auth.Subject subject = 3;
 }
 
 message PriceGroupListResponse {
   repeated PriceGroupResponse items = 1;
-  uint32 total_count = 2;
-  io.restorecommerce.status.OperationStatus operation_status = 3;
+  optional uint32 total_count = 2;
+  optional io.restorecommerce.status.OperationStatus operation_status = 3;
 }
 
 message PriceGroupResponse {
-  PriceGroup payload = 1;
-  io.restorecommerce.status.Status status = 3;
+  optional PriceGroup payload = 1;
+  optional io.restorecommerce.status.Status status = 3;
 }
 
 message Deleted {
-  string id = 1;
+  optional string id = 1;
 }
 
 service PriceGroupService {

package/io/restorecommerce/product.proto

@@ -12,11 +12,13 @@ import "io/restorecommerce/status.proto";
 import "io/restorecommerce/attribute.proto";
 import "io/restorecommerce/geometry.proto";
 import "io/restorecommerce/price.proto";
-import "io/restorecommerce/property.proto";
 import "io/restorecommerce/options.proto";
 
 // Used by resolvers
 import "io/restorecommerce/manufacturer.proto";
+import "io/restorecommerce/property.proto";
+import "io/restorecommerce/shop.proto";
+import "io/restorecommerce/tax.proto";
 
 service ProductService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (ProductListResponse) {
@@ -29,9 +31,9 @@ service ProductService {
 }
 
 enum AssociationType {
-  Miscellaneous = 0;
-  Accessory = 1;
-  Recommendation = 2;
+  MISCELLANEOUS = 0;
+  ACCESSORY = 1;
+  RECOMMENDATION = 2;
 }
 
 message Association {
@@ -44,9 +46,9 @@ message Association {
       field_name: "product",
     }
   ];
-  AssociationType type = 2;
+  optional AssociationType type = 2;
   repeated string tags = 3;
-  google.protobuf.Any data = 4;
+  optional google.protobuf.Any data = 4;
 }
 
 // Product resource entity
@@ -60,7 +62,7 @@ message Product {
   };
 
   optional string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
+  optional io.restorecommerce.meta.Meta meta = 2;
   oneof product_type {
     IndividualProduct product = 3;
     Bundle bundle = 4;
@@ -77,7 +79,7 @@ message Product {
   optional bool active = 6;
   repeated string tags = 7;
   repeated Association associations = 8;
-  google.protobuf.Any data = 9;
+  optional google.protobuf.Any data = 9;
 }
 
 message IndividualProduct {
@@ -122,7 +124,15 @@ message IndividualProduct {
       }
     ];
   }
-  repeated string tax_ids = 8;
+  repeated string tax_ids = 8 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.tax.Tax",
+      target_service: "master_data",
+      target_sub_service: "tax",
+      target_method: "Read",
+      field_name: "tax",
+    }
+  ];
   optional string gtin = 10;
   oneof nature {
     PhysicalProduct physical = 11;
@@ -151,13 +161,13 @@ message ProductList {
 
 message ProductListResponse {
   repeated ProductResponse items = 1;
-  uint32 total_count = 2;
-  io.restorecommerce.status.OperationStatus operation_status = 3;
+  optional uint32 total_count = 2;
+  optional io.restorecommerce.status.OperationStatus operation_status = 3;
 }
 
 message ProductResponse {
-  Product payload = 1;
-  io.restorecommerce.status.Status status = 3;
+  optional Product payload = 1;
+  optional io.restorecommerce.status.Status status = 3;
 }
 
 message Package {
@@ -175,7 +185,7 @@ message PhysicalVariant {
   repeated io.restorecommerce.image.Image images = 6;
   repeated io.restorecommerce.file.File files = 7;
   optional string stock_keeping_unit = 8;
-  optional string template_variant = 9;
+  optional string parent_variant_id = 9;
   optional Package package = 10;
   repeated io.restorecommerce.property.Property properties = 11;
 }
@@ -189,7 +199,7 @@ message ServiceVariant {
   repeated io.restorecommerce.image.Image images = 6;
   repeated io.restorecommerce.file.File files = 7;
   optional string stock_keeping_unit = 8;
-  optional string template_variant = 9;
+  optional string parent_variant_id = 9;
   repeated io.restorecommerce.property.Property properties = 10;
 }
 
@@ -202,7 +212,7 @@ message VirtualVariant {
   repeated io.restorecommerce.image.Image images = 6;
   repeated io.restorecommerce.file.File files = 7;
   optional string stock_keeping_unit = 8;
-  optional string template_variant = 9;
+  optional string parent_variant_id = 9;
   repeated io.restorecommerce.property.Property properties = 10;
 }
 

package/io/restorecommerce/product_category.proto

@@ -34,22 +34,22 @@ message ProductCategory {
 message ProductCategoryList {
   repeated ProductCategory items = 1;
   optional uint32 total_count = 2;
-  io.restorecommerce.auth.Subject subject = 3;
+  optional io.restorecommerce.auth.Subject subject = 3;
 }
 
 message ProductCategoryListResponse {
   repeated ProductCategoryResponse items = 1;
-  uint32 total_count = 2;
-  io.restorecommerce.status.OperationStatus operation_status = 3;
+  optional uint32 total_count = 2;
+  optional io.restorecommerce.status.OperationStatus operation_status = 3;
 }
 
 message ProductCategoryResponse {
-  ProductCategory payload = 1;
-  io.restorecommerce.status.Status status = 2;
+  optional ProductCategory payload = 1;
+  optional io.restorecommerce.status.Status status = 2;
 }
 
 message Deleted {
-  string id = 1;
+  optional string id = 1;
 }
 
 message Parent {

package/io/restorecommerce/product_prototype.proto

@@ -32,22 +32,22 @@ message ProductPrototype {
 message ProductPrototypeList {
   repeated ProductPrototype items = 1;
   optional uint32 total_count = 2;
-  io.restorecommerce.auth.Subject subject = 3;
+  optional io.restorecommerce.auth.Subject subject = 3;
 }
 
 message ProductPrototypeListResponse {
   repeated ProductPrototypeResponse items = 1;
-  uint32 total_count = 2;
-  io.restorecommerce.status.OperationStatus operation_status = 3;
+  optional uint32 total_count = 2;
+  optional io.restorecommerce.status.OperationStatus operation_status = 3;
 }
 
 message ProductPrototypeResponse {
-  ProductPrototype payload = 1;
-  io.restorecommerce.status.Status status = 2;
+  optional ProductPrototype payload = 1;
+  optional io.restorecommerce.status.Status status = 2;
 }
 
 message Deleted {
-  string id = 1;
+  optional string id = 1;
 }
 
 service ProductPrototypeService {

package/io/restorecommerce/rendering.proto

@@ -7,28 +7,28 @@ import "google/protobuf/any.proto";
 message Payload {
   // json with <key, template> pairs
   // e.g. { 'subject': ..., 'message':....}
-  google.protobuf.Any templates = 1;
-  google.protobuf.Any data = 2;  // data to fill template with
-  string style_url = 3; // stylesheet URL
+  optional google.protobuf.Any templates = 1;
+  optional google.protobuf.Any data = 2;  // data to fill template with
+  optional string style_url = 3; // stylesheet URL
 
   enum Strategy { // style-applying 'strategy'
     INLINE = 0;
     COPY = 1;
   }
-  Strategy strategy = 4;  // inlining, copying CSS into <style>, etc...
+  optional Strategy strategy = 4;  // inlining, copying CSS into <style>, etc...
   // rendering options JSON object
-  google.protobuf.Any options = 5;
+  optional google.protobuf.Any options = 5;
   // content type for rendering such as 'application/html' or 'application/text'
-  string content_type = 6;
+  optional string content_type = 6;
 }
 
 message RenderRequest {
-  string id = 1; // identifies the render request payload
+  optional string id = 1; // identifies the render request payload
   // List of templates with associated data and rendering options
   repeated Payload payloads = 2;
 }
 
 message RenderResponse {
-  string id = 1;
+  optional string id = 1;
   repeated google.protobuf.Any responses = 2;  // error or HTML contents
 }