@restorecommerce/protos 5.0.1 → 6.1.0

package/io/restorecommerce/fulfillment_courier.proto

@@ -9,6 +9,9 @@ import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
 import "io/restorecommerce/options.proto";
 
+// Used by resolvers
+import "io/restorecommerce/shop.proto";
+
 /**
 Microservice defination
 */
@@ -33,33 +36,42 @@ message FulfillmentCourier {
   };
 
   optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  repeated string shop_ids = 3 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.shop.Shop",
+      target_service: "master_data",
+      target_sub_service: "shop",
+      target_method: "Read",
+      field_name: "shops",
+    }
+  ];
   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;
+  optional google.protobuf.Any configuration = 9;
 }
 
 message FulfillmentCourierList {
   repeated FulfillmentCourier items = 1;
   optional uint32 total_count = 2;
-  io.restorecommerce.auth.Subject subject = 3;
+  optional io.restorecommerce.auth.Subject subject = 3;
 }
 
 message FulfillmentCourierResponse {
-  FulfillmentCourier payload = 1;
-  io.restorecommerce.status.Status status = 2;
+  optional FulfillmentCourier payload = 1;
+  optional io.restorecommerce.status.Status status = 2;
 }
 
 message FulfillmentCourierListResponse {
   repeated FulfillmentCourierResponse 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 Deleted {
-  string id = 1;
+  optional string id = 1;
 }
 

package/io/restorecommerce/fulfillment_product.proto

@@ -24,7 +24,7 @@ service FulfillmentProductService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (FulfillmentProductListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
-  rpc Find (ProductQueryList) returns (PackingSolutionListResponse) {
+  rpc Find (PackingSolutionQueryList) returns (PackingSolutionListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
   rpc Create (FulfillmentProductList) returns (FulfillmentProductListResponse);
@@ -38,19 +38,36 @@ message Preferences {
   repeated io.restorecommerce.attribute.Attribute options = 2;
 }
 
-message ProductQuery {
-  optional io.restorecommerce.address.ShippingAddress sender = 1;
-  optional io.restorecommerce.address.ShippingAddress receiver = 2;
-  repeated io.restorecommerce.fulfillment.Item items = 3;
-  optional Preferences preferences = 4;
-  optional string reference = 5;
+message PackingSolutionQuery {
+  optional string customer_id = 1 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.customer.Customer",
+      target_service: "master_data",
+      target_sub_service: "customer",
+      target_method: "Read",
+      field_name: "customer",
+    }
+  ];
+  optional string shop_id = 2 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.shop.Shop",
+      target_service: "master_data",
+      target_sub_service: "shop",
+      target_method: "Read",
+      field_name: "shop",
+    }
+  ];
+  optional io.restorecommerce.address.ShippingAddress sender = 3;
+  optional io.restorecommerce.address.ShippingAddress recipient = 4;
+  repeated io.restorecommerce.fulfillment.Item items = 5;
+  optional Preferences preferences = 6;
+  optional io.restorecommerce.reference.Reference reference = 7;
 }
 
-message ProductQueryList {
-  repeated ProductQuery items = 1;
+message PackingSolutionQueryList {
+  repeated PackingSolutionQuery items = 1;
   optional uint32 total_count = 2;
-  io.restorecommerce.auth.Subject subject = 3;
-  optional io.restorecommerce.reference.Reference reference = 4;
+  optional io.restorecommerce.auth.Subject subject = 3;
 }
 
 message FulfillmentProduct {
@@ -89,23 +106,24 @@ message Variant {
   optional io.restorecommerce.price.Price price = 4;
   optional io.restorecommerce.geometry.BoundingBox3D max_size = 6;
   optional double max_weight = 7;
+  repeated io.restorecommerce.attribute.Attribute attributes = 8;
 }
 
 message FulfillmentProductList {
   repeated FulfillmentProduct items = 1;
   optional uint32 total_count = 2;
-  io.restorecommerce.auth.Subject subject = 3;
+  optional io.restorecommerce.auth.Subject subject = 3;
 }
 
 message FulfillmentProductResponse {
-  FulfillmentProduct payload = 1;
-  io.restorecommerce.status.Status status = 2;
+  optional FulfillmentProduct payload = 1;
+  optional io.restorecommerce.status.Status status = 2;
 }
 
 message FulfillmentProductListResponse {
   repeated FulfillmentProductResponse 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 PackingSolution {
@@ -125,9 +143,9 @@ message PackingSolutionResponse {
 message PackingSolutionListResponse {
   repeated PackingSolutionResponse items = 1;
   optional uint32 total_count = 2;
-  io.restorecommerce.status.OperationStatus operation_status = 3;
+  optional io.restorecommerce.status.OperationStatus operation_status = 3;
 }
 
 message Deleted {
-  string id = 1;
+  optional string id = 1;
 }

package/io/restorecommerce/graph.proto

@@ -19,19 +19,19 @@ message TraversalRequest {
   }
   optional Options opts = 3;
   optional bool path = 4;
-  io.restorecommerce.auth.Subject subject = 5;
+  optional io.restorecommerce.auth.Subject subject = 5;
   repeated Filters filters = 6;
 }
 
 message Vertices {
-  string collection_name = 1;
+  optional string collection_name = 1;
   repeated string start_vertex_ids = 2;
 }
 
 message Collection {
-  string collection_name = 1;
-  uint32 limit = 2;
-  uint32 offset = 3;
+  optional string collection_name = 1;
+  optional uint32 limit = 2;
+  optional uint32 offset = 3;
   repeated io.restorecommerce.resourcebase.Sort sorts = 4;
 }
 
@@ -40,7 +40,7 @@ message Options {
  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
+ optional Direction direction = 5; // either inbound or outbound, defaults to outbound direction
  enum Direction {
    OUTBOUND = 0;
    INBOUND = 1;
@@ -86,7 +86,7 @@ message Filter {
 }
 
 message TraversalResponse {
-  google.protobuf.Any data = 1; // vertices
-  google.protobuf.Any paths = 2; // traversed vertices paths
-  io.restorecommerce.status.OperationStatus operation_status = 3;
+  optional google.protobuf.Any data = 1; // vertices
+  optional google.protobuf.Any paths = 2; // traversed vertices paths
+  optional io.restorecommerce.status.OperationStatus operation_status = 3;
 }

package/io/restorecommerce/image.proto

@@ -21,5 +21,5 @@ message ImageList {
 }
 
 message Deleted {
-  string id = 1;
+  optional string id = 1;
 }

package/io/restorecommerce/invoice.proto

@@ -64,33 +64,33 @@ enum PaymentState {
 
 message RequestInvoiceNumber {
   optional string shop_id = 1;
-  google.protobuf.Any context = 2;
-  io.restorecommerce.auth.Subject subject = 3;
+  optional google.protobuf.Any context = 2;
+  optional io.restorecommerce.auth.Subject subject = 3;
 }
 
 message InvoiceNumberResponse {
- string invoice_number = 1;
+ optional string invoice_number = 1;
 }
 
 message Deleted {
-  string id = 1;
+  optional string id = 1;
 }
 
 message InvoiceList {
   repeated Invoice items = 1;
   optional uint32 total_count = 2;
-  io.restorecommerce.auth.Subject subject = 3;
+  optional io.restorecommerce.auth.Subject subject = 3;
 }
 
 message InvoiceListResponse {
   repeated InvoiceResponse 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 InvoiceResponse {
-  Invoice payload = 1;
-  io.restorecommerce.status.Status status = 2;
+  optional Invoice payload = 1;
+  optional io.restorecommerce.status.Status status = 2;
 }
 
 message InvoiceId {
@@ -103,7 +103,7 @@ message InvoiceId {
 message InvoiceIdList {
   repeated InvoiceId items = 1;
   optional uint32 total_count = 2;
-  io.restorecommerce.auth.Subject subject = 3;
+  optional io.restorecommerce.auth.Subject subject = 3;
 }
 
 /*

package/io/restorecommerce/job.proto

@@ -28,7 +28,7 @@ service JobService {
  * Send when a job resource got deleted.
  */
 message Deleted {
-  string id = 1;
+  optional string id = 1;
 }
 
 /**
@@ -37,18 +37,18 @@ message Deleted {
 message JobList {
   repeated Job items = 1;
   optional uint32 total_count = 2;
-  io.restorecommerce.auth.Subject subject = 3;
+  optional io.restorecommerce.auth.Subject subject = 3;
 }
 
 message JobListResponse {
   repeated JobResponse 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 JobResponse {
-  Job payload = 1;
-  io.restorecommerce.status.Status status = 2;
+  optional Job payload = 1;
+  optional io.restorecommerce.status.Status status = 2;
 }
 
 /**
@@ -166,7 +166,7 @@ message JobReadRequest {
 
   // Fields selector
   repeated io.restorecommerce.resourcebase.FieldFilter fields = 3;
-  io.restorecommerce.auth.Subject subject = 5;
+  optional io.restorecommerce.auth.Subject subject = 5;
 }
 
 // filter

package/io/restorecommerce/locale.proto

@@ -22,24 +22,24 @@ service LocaleService {
 }
 
 message Deleted {
-  string id = 1;
+  optional string id = 1;
 }
 
 message LocaleList {
   repeated Locale items = 1;
   optional uint32 total_count = 2;
-  io.restorecommerce.auth.Subject subject = 3;
+  optional io.restorecommerce.auth.Subject subject = 3;
 }
 
 message LocaleListResponse {
   repeated LocaleResponse 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 LocaleResponse {
-  Locale payload = 1;
-  io.restorecommerce.status.Status status = 2;
+  optional Locale payload = 1;
+  optional io.restorecommerce.status.Status status = 2;
 }
 
 message Locale {

package/io/restorecommerce/location.proto

@@ -27,24 +27,24 @@ service LocationService {
 }
 
 message Deleted {
-  string id = 1;
+  optional string id = 1;
 }
 
 message LocationList {
   repeated Location items = 1;
   optional uint32 total_count = 2;
-  io.restorecommerce.auth.Subject subject = 3;
+  optional io.restorecommerce.auth.Subject subject = 3;
 }
 
 message LocationListResponse {
   repeated LocationResponse 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 LocationResponse {
-  Location payload = 1;
-  io.restorecommerce.status.Status status = 2;
+  optional Location payload = 1;
+  optional io.restorecommerce.status.Status status = 2;
 }
 
 message Location {

package/io/restorecommerce/manufacturer.proto

@@ -19,22 +19,22 @@ message Manufacturer {
 message ManufacturerList {
   repeated Manufacturer items = 1;
   optional uint32 total_count = 2;
-  io.restorecommerce.auth.Subject subject = 3;
+  optional io.restorecommerce.auth.Subject subject = 3;
 }
 
 message ManufacturerListResponse {
   repeated ManufacturerResponse 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 ManufacturerResponse {
-  Manufacturer payload = 1;
-  io.restorecommerce.status.Status status = 2;
+  optional Manufacturer payload = 1;
+  optional io.restorecommerce.status.Status status = 2;
 }
 
 message Deleted {
-  string id = 1;
+  optional string id = 1;
 }
 
 service ManufacturerService {

package/io/restorecommerce/notification.proto

@@ -20,24 +20,24 @@ service NotificationService {
 }
 
 message Deleted {
-  string id = 1;
+  optional string id = 1;
 }
 
 message NotificationList {
   repeated Notification items = 1;
   optional uint32 total_count = 2;
-  io.restorecommerce.auth.Subject subject = 3;
+  optional io.restorecommerce.auth.Subject subject = 3;
 }
 
 message NotificationListResponse {
   repeated NotificationResponse 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 NotificationResponse {
-  Notification items = 1;
-  io.restorecommerce.status.Status status = 2;
+  optional Notification items = 1;
+  optional io.restorecommerce.status.Status status = 2;
 }
 
 message Notification {

package/io/restorecommerce/notification_channel.proto

@@ -17,24 +17,24 @@ service NotificationChannelService {
 }
 
 message Deleted {
-  string id = 1;
+  optional string id = 1;
 }
 
 message NotificationChannelList {
   repeated NotificationChannel items = 1;
   optional uint32 total_count = 2;
-  io.restorecommerce.auth.Subject subject = 3;
+  optional io.restorecommerce.auth.Subject subject = 3;
 }
 
 message NotificationChannelListResponse {
   repeated NotificationChannelResponse 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 NotificationChannelResponse {
-  NotificationChannel items = 1;
-  io.restorecommerce.status.Status status = 2;
+  optional NotificationChannel items = 1;
+  optional io.restorecommerce.status.Status status = 2;
 }
 
 message NotificationChannel {

package/io/restorecommerce/oauth.proto

@@ -23,23 +23,23 @@ message GenerateLinksResponse {
 }
 
 message ExchangeCodeRequest {
-  string service = 1;
-  string code = 2;
-  string state = 3;
+  optional string service = 1;
+  optional string code = 2;
+  optional string state = 3;
 }
 
 message ExchangeCodeResponse {
-  io.restorecommerce.user.UserResponse user = 1;
-  string email = 2;
-  io.restorecommerce.auth.Tokens token = 3;
+  optional io.restorecommerce.user.UserResponse user = 1;
+  optional string email = 2;
+  optional io.restorecommerce.auth.Tokens token = 3;
 }
 
 message GetTokenRequest {
-  io.restorecommerce.auth.Subject subject = 1;
-  string service = 2;
+  optional io.restorecommerce.auth.Subject subject = 1;
+  optional string service = 2;
 }
 
 message GetTokenResponse {
-  io.restorecommerce.status.Status status = 1;
+  optional io.restorecommerce.status.Status status = 1;
   optional string token = 2;
 }

package/io/restorecommerce/order.proto

@@ -18,6 +18,8 @@ import "io/restorecommerce/fulfillment_product.proto";
 import "io/restorecommerce/invoice.proto";
 
 // Used by resolvers
+import "io/restorecommerce/user.proto";
+import "io/restorecommerce/customer.proto";
 import "io/restorecommerce/shop.proto";
 
 
@@ -42,9 +44,9 @@ service OrderService {
   rpc TriggerFulfillment (FulfillmentRequestList) returns (io.restorecommerce.status.StatusListResponse);
 
   // Requires Invoice Service
-  rpc CreateInvoice (InvoiceRequestList) returns (io.restorecommerce.invoice.InvoiceListResponse);
+  rpc CreateInvoice (OrderingInvoiceRequestList) returns (io.restorecommerce.invoice.InvoiceListResponse);
   // Requires Invoice Service
-  rpc TriggerInvoice (InvoiceRequestList) returns (io.restorecommerce.status.StatusListResponse);
+  rpc TriggerInvoice (OrderingInvoiceRequestList) returns (io.restorecommerce.status.StatusListResponse);
 }
 
 enum OrderState {
@@ -96,11 +98,11 @@ message Order {
   optional io.restorecommerce.meta.Meta meta = 2;
   optional string user_id = 3 [
     (io.restorecommerce.options.resolver) = {
-      target_type: ".io.restorecommerce.customer.Customer",
-      target_service: "master_data",
-      target_sub_service: "customer",
+      target_type: ".io.restorecommerce.user.User",
+      target_service: "identity",
+      target_sub_service: "user",
       target_method: "Read",
-      field_name: "customer",
+      field_name: "user",
     }
   ];
   optional string customer_id = 4 [
@@ -136,28 +138,28 @@ message Order {
 
 message OrderIdList {
   repeated string ids = 1;
-  io.restorecommerce.auth.Subject subject = 2;
+  optional io.restorecommerce.auth.Subject subject = 2;
 }
 
 message OrderList {
   repeated Order items = 1;
   optional uint32 total_count = 2;
-  io.restorecommerce.auth.Subject subject = 3;
+  optional io.restorecommerce.auth.Subject subject = 3;
 }
 
 message OrderListResponse {
   repeated OrderResponse 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 OrderResponse {
-  Order payload = 1;
-  io.restorecommerce.status.Status status = 2;
+  optional Order payload = 1;
+  optional io.restorecommerce.status.Status status = 2;
 }
 
 message Deleted {
-  string id = 1;
+  optional string id = 1;
 }
 
 message FulfillmentRequest {
@@ -167,30 +169,30 @@ message FulfillmentRequest {
   optional string invoice_number = 4; // @TODO: not used!
   optional io.restorecommerce.address.ShippingAddress sender_address = 5;
   repeated string selected_items = 6; // select all on empty
-  google.protobuf.Any data = 7;
+  optional google.protobuf.Any data = 7;
 }
 
 message FulfillmentRequestList {
   repeated FulfillmentRequest items = 1;
   optional uint32 total_count = 2;
-  io.restorecommerce.auth.Subject subject = 3;
+  optional io.restorecommerce.auth.Subject subject = 3;
 }
 
-message InvoiceSection {
+message OrderingInvoiceSection {
   optional string order_id = 1;
   repeated string selected_items = 2; // select all on empty
   optional FulfillmentInvoiceMode fulfillment_mode = 3;
-  repeated io.restorecommerce.fulfillment.InvoiceSection selected_fulfillments = 4; // includes all on empty
+  repeated io.restorecommerce.fulfillment.FulfillmentInvoiceSection selected_fulfillments = 4; // includes all on empty
 }
 
-message InvoiceRequest {
+message OrderingInvoiceRequest {
   optional string invoice_number = 1; // if given
   repeated string payment_hints = 2;
-  repeated InvoiceSection sections = 3;
+  repeated OrderingInvoiceSection sections = 3;
 }
 
-message InvoiceRequestList {
-  repeated InvoiceRequest items = 1;
+message OrderingInvoiceRequestList {
+  repeated OrderingInvoiceRequest items = 1;
   optional uint32 total_count = 2;
-  io.restorecommerce.auth.Subject subject = 3;
+  optional io.restorecommerce.auth.Subject subject = 3;
 }

package/io/restorecommerce/organization.proto

@@ -27,30 +27,30 @@ service OrganizationService {
 }
 
 message Deleted {
-  string id = 1;
+  optional string id = 1;
 }
 
 message DeleteOrgData {
   repeated string org_ids = 1;
   repeated string user_ids = 2;
-  io.restorecommerce.auth.Subject subject = 3;
+  optional io.restorecommerce.auth.Subject subject = 3;
 }
 
 message OrganizationList {
   repeated Organization items = 1;
   optional uint32 total_count = 2;
-  io.restorecommerce.auth.Subject subject = 3;
+  optional io.restorecommerce.auth.Subject subject = 3;
 }
 
 message OrganizationListResponse {
   repeated OrganizationResponse 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 OrganizationResponse {
-  Organization payload = 1;
-  io.restorecommerce.status.Status status = 2;
+  optional Organization payload = 1;
+  optional io.restorecommerce.status.Status status = 2;
 }
 
 message Organization {