@restorecommerce/protos 6.9.0 → 6.9.1

package/CHANGELOG.md

@@ -3,6 +3,21 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [6.9.1](https://github.com/restorecommerce/libs/compare/@restorecommerce/protos@6.9.0...@restorecommerce/protos@6.9.1) (2024-11-06)
+
+
+### Bug Fixes
+
+* **proto:** fulfillment_product, set correct field number ([70b6fb5](https://github.com/restorecommerce/libs/commit/70b6fb585439e54b28756d2eefe0a5bd0edd5131))
+* **protos:** add customer_order_nr to invoicing ([19a14f9](https://github.com/restorecommerce/libs/commit/19a14f983ada1f5fd5146fc4814a7a437ac97237))
+* **protos:** add setting resource, enrich templates ([63fe572](https://github.com/restorecommerce/libs/commit/63fe572c3a52581591aed5ff96faee23fb73e459))
+* **protos:** selectable document_ids for send ([bcb2910](https://github.com/restorecommerce/libs/commit/bcb2910fe67bcd2142a86a4a41647bc4b8a28585))
+* **protos:** shop settings intermediate ([1ddefcc](https://github.com/restorecommerce/libs/commit/1ddefcc5e7594cefbc9b97694715f76e85718704))
+
+
+
+
+
 # [6.9.0](https://github.com/restorecommerce/libs/compare/@restorecommerce/protos@6.8.12...@restorecommerce/protos@6.9.0) (2024-11-05)
 
 

package/io/restorecommerce/customer.proto

@@ -7,6 +7,7 @@ import "io/restorecommerce/meta.proto";
 import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/attribute.proto";
 import "io/restorecommerce/status.proto";
+import "io/restorecommerce/setting.proto";
 import "io/restorecommerce/options.proto";
 
 // Used by resolvers
@@ -58,7 +59,15 @@ message Customer {
     Commercial commercial = 4;
     PublicSector public_sector = 5;
   };
-  repeated io.restorecommerce.attribute.Attribute settings = 6;
+  string setting_id = 6 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.setting.Setting",
+      target_service: "master_data",
+      target_sub_service: "setting",
+      target_method: "Read",
+      field_name: "setting",
+    }
+  ];
 }
 
 message Private {
@@ -92,6 +101,15 @@ message Commercial {
       field_name: "organization",
     }
   ];
+  repeated string template_ids = 2 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.template.Template",
+      target_service: "master_data",
+      target_sub_service: "template",
+      target_method: "Read",
+      field_name: "templates",
+    }
+  ]; // list of active templates
 }
 
 message PublicSector {
@@ -104,4 +122,13 @@ message PublicSector {
       field_name: "organization",
     }
   ];
+  repeated string template_ids = 2 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.template.Template",
+      target_service: "master_data",
+      target_sub_service: "template",
+      target_method: "Read",
+      field_name: "templates",
+    }
+  ]; // list of active templates
 }

package/io/restorecommerce/file.proto

@@ -6,7 +6,7 @@ import "io/restorecommerce/image.proto";
 
 message File {
   optional string id = 1;
-  optional int64 index = 2;
+  optional uint32 ordinal = 2;
   optional string caption = 3;
   optional string filename = 4;
   optional string content_type = 5;
@@ -19,8 +19,4 @@ message File {
 message FileList {
   repeated File items = 1;
   optional uint32 total_count = 2;
-}
-
-message Deleted {
-  optional string id = 1;
 }

package/io/restorecommerce/fulfillment.proto

@@ -239,10 +239,6 @@ message FulfillmentIdList {
   optional io.restorecommerce.auth.Subject subject = 3;
 }
 
-message Deleted {
-  optional string id = 1;
-}
-
 message FulfillmentInvoiceSection {
   optional string fulfillment_id = 1;
   repeated string selected_parcels = 2; // selects all on empty

package/io/restorecommerce/fulfillment_courier.proto

@@ -50,9 +50,10 @@ message FulfillmentCourier {
   optional string description = 5;
   optional string logo = 6;
   optional string website = 7;
-  optional string stub_type = 8;
+  optional string stub_type = 8; // obsolete, use api
   optional string credential_id = 9;
   optional google.protobuf.Any configuration = 10;
+  optional string api = 11;
 }
 
 message FulfillmentCourierList {
@@ -72,7 +73,3 @@ message FulfillmentCourierListResponse {
   optional io.restorecommerce.status.OperationStatus operation_status = 3;
 }
 
-message Deleted {
-  optional string id = 1;
-}
-

package/io/restorecommerce/fulfillment_product.proto

@@ -34,9 +34,10 @@ service FulfillmentProductService {
 }
 
 message Preferences {
-  optional bool partial_filfillment_allowed = 1;
-  repeated string couriers = 2; // ID of courier
-  repeated io.restorecommerce.attribute.Attribute options = 3; // Courier specific options such as C02 neutral delivery etc.
+  optional bool partial_fulfillment_allowed = 1;
+  repeated string courier_ids = 2; // Narrows search to certain couriers, leave empty for open search
+  repeated string fulfillment_product_ids = 3; // Narrows search to certain tariffs, leave empty for open search
+  repeated io.restorecommerce.attribute.Attribute options = 4; // Courier specific options such as CO2 neutral delivery etc.
 }
 
 message FulfillmentSolutionQuery {
@@ -128,11 +129,9 @@ message FulfillmentProductListResponse {
 }
 
 message FulfillmentSolution {
-  repeated io.restorecommerce.amount.Amount amounts = 1;
-  optional double compactness = 2;
-  optional double homogeneity = 3;
-  optional double score = 4;
-  repeated io.restorecommerce.fulfillment.Parcel parcels = 5;
+  repeated string courier_ids = 1;
+  repeated io.restorecommerce.fulfillment.Parcel parcels = 2;
+  repeated io.restorecommerce.amount.Amount amounts = 3;
 }
 
 message FulfillmentSolutionResponse {
@@ -146,7 +145,3 @@ message FulfillmentSolutionListResponse {
   optional uint32 total_count = 2;
   optional io.restorecommerce.status.OperationStatus operation_status = 3;
 }
-
-message Deleted {
-  optional string id = 1;
-}

package/io/restorecommerce/invoice.proto

@@ -96,9 +96,10 @@ message InvoiceResponse {
 
 message InvoiceId {
   optional string id = 1;
-  repeated string channel_ids = 2;
-  optional google.protobuf.Any options = 3;
-  optional io.restorecommerce.auth.Subject subject = 4;
+  repeated string document_ids = 2; // empty takes latest
+  repeated string notification_channel_ids = 3;
+  optional google.protobuf.Any options = 4;
+  optional io.restorecommerce.auth.Subject subject = 5;
 }
 
 message InvoiceIdList {
@@ -162,6 +163,7 @@ message Invoice {
   optional google.protobuf.Timestamp to_date = 17; // value performance to date
   optional bool sent = 18;
   optional bool withdrawn = 19;
+  optional string customer_order_number = 20;
 }
 
 message Section {

package/io/restorecommerce/order.proto

@@ -39,6 +39,9 @@ service OrderService {
   rpc Cancel (OrderIdList) returns (OrderListResponse);
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
 
+  // Requires Fulfillment Service
+  // Evaluates plausibility of the Fulfillment that would result from given order.
+  rpc EvaluateFulfillment (OrderList) returns (io.restorecommerce.status.StatusListResponse);
   // Requires Fulfillment Service
   rpc QueryFulfillmentSolution (FulfillmentRequestList) returns (io.restorecommerce.fulfillment_product.FulfillmentSolutionListResponse);
   // Requires Fulfillment Service

package/io/restorecommerce/setting.proto

@@ -0,0 +1,45 @@
+syntax = "proto3";
+
+package io.restorecommerce.setting;
+
+import "io/restorecommerce/meta.proto";
+import "io/restorecommerce/attribute.proto";
+import "io/restorecommerce/resource_base.proto";
+import "io/restorecommerce/auth.proto";
+import "io/restorecommerce/status.proto";
+import "io/restorecommerce/options.proto";
+
+service SettingService {
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (SettingListResponse) {
+    option (io.restorecommerce.options.is_query) = true;
+  };
+  rpc Create (SettingList) returns (SettingListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc Update (SettingList) returns (SettingListResponse);
+  rpc Upsert (SettingList) returns (SettingListResponse);
+}
+
+message Setting {
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string name = 3;
+  optional string description = 4;
+  repeated io.restorecommerce.attribute.Attribute settings = 5;
+}
+
+message SettingList {
+  repeated Setting items = 1;
+  optional uint32 total_count = 2;
+  optional io.restorecommerce.auth.Subject subject = 3;
+}
+
+message SettingListResponse {
+  repeated SettingResponse items = 1;
+  optional uint32 total_count = 2;
+  optional io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message SettingResponse {
+  optional Setting payload = 1;
+  optional io.restorecommerce.status.Status status = 3;
+}

package/io/restorecommerce/shop.proto

@@ -7,6 +7,7 @@ import "io/restorecommerce/meta.proto";
 import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/attribute.proto";
 import "io/restorecommerce/status.proto";
+import "io/restorecommerce/setting.proto";
 import "io/restorecommerce/options.proto";
 
 // Used by resolvers
@@ -60,5 +61,22 @@ message Shop {
       field_name: "organization",
     }
   ];
-  repeated io.restorecommerce.attribute.Attribute settings = 8;
+  repeated string template_ids = 8 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.template.Template",
+      target_service: "master_data",
+      target_sub_service: "template",
+      target_method: "Read",
+      field_name: "templates",
+    }
+  ]; // list of active templates
+  string setting_id = 9 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.setting.Setting",
+      target_service: "master_data",
+      target_sub_service: "setting",
+      target_method: "Read",
+      field_name: "setting",
+    }
+  ];
 }

package/io/restorecommerce/template.proto

@@ -9,7 +9,6 @@ import "io/restorecommerce/file.proto";
 import "io/restorecommerce/meta.proto";
 import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
-import "io/restorecommerce/reference.proto";
 import "io/restorecommerce/options.proto";
 
 /*
@@ -25,6 +24,15 @@ service TemplateService {
   rpc Upsert (TemplateList) returns (TemplateListResponse);
 }
 
+enum TemplateUseCase {
+  MISCELLANEOUS = 0;
+  INVOICE_PDF = 1;
+  INVOICE_EMAIL = 2;
+  INVITATION_EMAIL = 3;
+  REGISTRATION_EMAIL = 4;
+  CHANGE_PASSWORD_EMAIL = 5;
+}
+
 message Deleted {
   optional string id = 1;
 }
@@ -46,13 +54,23 @@ message TemplateResponse {
   optional io.restorecommerce.status.Status status = 2;
 }
 
+message Localization {
+  repeated string local_codes = 1; // e.g. en, en_US, en_UK, ...
+  optional io.restorecommerce.file.File l10n = 2; // JSON expected
+}
+
 message Template {
   optional string id = 1;
   optional io.restorecommerce.meta.Meta meta = 2;
   optional string name = 3;
   optional string description = 4;
-  optional io.restorecommerce.reference.Reference reference = 5;
-  repeated io.restorecommerce.file.File files = 6;
-  repeated io.restorecommerce.image.Image images = 7;
-  repeated io.restorecommerce.attribute.Attribute attributes = 8;
+  optional TemplateUseCase use_case = 5;
+  optional uint32 ordinal = 6; // sort number
+  optional string section = 7; // e.g. header, body, footer
+  optional io.restorecommerce.file.File body = 8; // e.g. text/html
+  optional io.restorecommerce.file.File layout = 9;
+  repeated io.restorecommerce.file.File styles = 10; // e.g. application/css
+  repeated io.restorecommerce.image.Image images = 11;
+  repeated Localization localization = 12;
+  repeated io.restorecommerce.attribute.Attribute attributes = 14;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@restorecommerce/protos",
-  "version": "6.9.0",
+  "version": "6.9.1",
   "description": "Protobuf descriptors for Restorecommerce services",
   "author": "n-fuse GmbH",
   "repository": {
@@ -15,5 +15,5 @@
     "protobufs"
   ],
   "scripts": {},
-  "gitHead": "a8e0e2e2417dd3cb4045286494fb1f58115a41ba"
+  "gitHead": "82e454f58534b5adbf50eb4b2c0a6797fd1a4f9b"
 }