@restorecommerce/protos 4.0.1 → 4.1.1

package/CHANGELOG.md

@@ -3,6 +3,33 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [4.1.1](https://github.com/restorecommerce/libs/compare/@restorecommerce/protos@4.1.0...@restorecommerce/protos@4.1.1) (2023-07-12)
+
+
+### Bug Fixes
+
+* **fulfillment, invoice, organization.proto:** fix typos in invoice, fulfillment and organization ([8d64222](https://github.com/restorecommerce/libs/commit/8d64222d3cbca44a0c9d4e265431d26aaac20223))
+
+
+
+
+
+# [4.1.0](https://github.com/restorecommerce/libs/compare/@restorecommerce/protos@4.0.1...@restorecommerce/protos@4.1.0) (2023-07-11)
+
+
+### Bug Fixes
+
+* **timestamps:** fix invoice date type by timestamp, add payment_details to invoice trigger request ([139ab69](https://github.com/restorecommerce/libs/commit/139ab69ba1d4739386ac2844d1e1f98c2046b98e))
+
+
+### Features
+
+* **invoicing:** invoicing supports FulfillmentProducts ([d0684cf](https://github.com/restorecommerce/libs/commit/d0684cf4773ecc2aa0f807bb8c4be1a21a62caab))
+
+
+
+
+
 ## [4.0.1](https://github.com/restorecommerce/libs/compare/@restorecommerce/protos@4.0.0...@restorecommerce/protos@4.0.1) (2023-06-29)
 
 

package/io/restorecommerce/auth.proto

@@ -2,6 +2,7 @@ syntax = "proto3";
 
 package io.restorecommerce.auth;
 import "io/restorecommerce/attribute.proto";
+import "google/protobuf/timestamp.proto";
 
 /**
  * Subject of creating User
@@ -15,12 +16,12 @@ message Subject {
 
 message Tokens {
   optional string name = 1; // token name
-  optional double expires_in = 2; // expiration date for token
+  optional google.protobuf.Timestamp expires_in = 2; // expiration date for token
   optional string token = 3; // token
   repeated string scopes = 4; // identifier for role_association
   optional string type = 5; // type of token eg: access_token, refresh_token
   optional bool interactive = 6;
-  optional double last_login = 7;
+  optional google.protobuf.Timestamp last_login = 7;
 }
 
 message HierarchicalScope {
@@ -33,7 +34,7 @@ message RoleAssociation {
   optional string role = 1;  // role ID
   repeated io.restorecommerce.attribute.Attribute attributes = 2;  // useful attributes for RBAC/ABAC like organizational scope
   optional string id = 3; // identifier for role_association
-  optional double created = 4; // timestamp when the role was created
+  optional google.protobuf.Timestamp created = 4; // timestamp when the role was created
 }
 
 message HierarchicalScopesRequest {

package/io/restorecommerce/authentication_log.proto

@@ -2,6 +2,7 @@ syntax = "proto3";
 
 package io.restorecommerce.authentication_log;
 
+import "google/protobuf/timestamp.proto";
 import "io/restorecommerce/resource_base.proto";
 import "io/restorecommerce/meta.proto";
 import "io/restorecommerce/auth.proto";
@@ -47,7 +48,7 @@ message AuthenticationLog {
   optional string ipv6_address = 3;
   optional string operating_system = 4;
   optional string user_agent = 5;
-  optional double date = 6; // time stamp of login, logout or token update
+  optional google.protobuf.Timestamp date = 6; // time stamp of login, logout or token update
   optional string activity = 7; // login, logout
   optional io.restorecommerce.meta.Meta meta = 8; // meta info
   optional string subject_id = 9; // subject id

package/io/restorecommerce/code.proto

@@ -38,7 +38,7 @@ message CodeResponse {
 message Code {
   optional string id = 1;
   optional io.restorecommerce.meta.Meta meta = 2;
-  optional Status status = 3;
+  optional StatusCode status = 3;
   optional string common_code = 4;
   optional string name = 5;
   optional string description = 6;
@@ -51,7 +51,7 @@ message Code {
   optional string quantity = 13;
 }
 
-enum Status {
+enum StatusCode {
   ADDED = 0;
   CHANGED_NAME = 1;
   CHANGED_CHARACTERISTIC = 2;

package/io/restorecommerce/currency.proto

@@ -7,6 +7,7 @@ import "io/restorecommerce/meta.proto";
 import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
 import "io/restorecommerce/options.proto";
+import "google/protobuf/timestamp.proto";
 
 /*
 * Microservice definition.
@@ -66,7 +67,7 @@ message ExchangeRate {
 message ExchangeRateQuery {
   optional string from_currency_id = 1;
   optional string to_currency_id = 2;
-  optional double datetime = 3; // now in general case
+  optional google.protobuf.Timestamp datetime = 3; // now in general case
   optional double amount = 4; // leave empty == 1.0
 }
 
@@ -79,7 +80,7 @@ message ExchangeRateQueryList {
 message ExchangeRateResponse {
   optional string from_currency_id = 1;
   ExchangeRate payload = 3;
-  optional double timestamp = 2;
+  optional google.protobuf.Timestamp timestamp = 2;
   io.restorecommerce.status.Status status = 4;
 }
 

package/io/restorecommerce/fulfillment.proto

@@ -12,8 +12,10 @@ import "io/restorecommerce/address.proto";
 import "io/restorecommerce/country.proto";
 import "io/restorecommerce/product.proto";
 import "io/restorecommerce/options.proto";
+import "io/restorecommerce/price.proto";
 import "io/restorecommerce/amount.proto";
 import "io/restorecommerce/invoice.proto";
+import "google/protobuf/timestamp.proto";
 
 /**
 Microservice definition.
@@ -112,9 +114,10 @@ message Parcel {
     }
   ];
   optional string variant_id = 3;
-  optional Item item = 4;
-  optional io.restorecommerce.amount.Amount amount = 5;
-  optional io.restorecommerce.product.Package package = 6;
+  repeated Item items = 4;
+  optional io.restorecommerce.price.Price price = 5;
+  optional io.restorecommerce.amount.Amount amount = 6;
+  optional io.restorecommerce.product.Package package = 8;
 }
 
 message Label {
@@ -141,7 +144,7 @@ message Packaging {
 }
 
 message Event {
-  optional int64 timestamp = 1;
+  optional google.protobuf.Timestamp timestamp = 1;
   optional string location = 2;
   optional google.protobuf.Any details = 3;
   optional io.restorecommerce.status.Status status = 4;
@@ -209,10 +212,15 @@ message Deleted {
   string id = 1;
 }
 
+message InvoiceSection {
+  optional string fulfillment_id = 1;
+  repeated string selected_parcels = 2; // selects all on empty
+}
+
 message InvoiceRequest {
   optional string invoice_number = 1; // if given
-  optional string fulfillment_id = 2;
-  repeated string included_parcels = 3; // includes all on empty
+  repeated string payment_hints = 2;
+  repeated InvoiceSection sections = 3;
 }
 
 message InvoiceRequestList {

package/io/restorecommerce/invoice.proto

@@ -14,11 +14,14 @@ import "io/restorecommerce/amount.proto";
 import "io/restorecommerce/price.proto";
 import "io/restorecommerce/file.proto";
 import "io/restorecommerce/reference.proto";
+import "io/restorecommerce/attribute.proto";
 
 // Used by resolvers
 import "io/restorecommerce/user.proto";
 import "io/restorecommerce/customer.proto";
 import "io/restorecommerce/shop.proto";
+import "google/protobuf/timestamp.proto";
+import "io/restorecommerce/product.proto";
 
 /*
 * Microservice definition.
@@ -33,7 +36,7 @@ service InvoiceService {
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
 
   /*
-  * Render invoices as PDF to ostorage. (creates if not exist, updates if id is given)
+  * Evaluates and (re-)Renders invoices as PDF to ostorage. (creates if not exist, updates if id is given)
   */
   rpc Render (InvoiceList) returns (InvoiceListResponse);
   
@@ -130,7 +133,7 @@ message Invoice {
   optional string customer_id = 6 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.customer.Customer",
-      target_service: "resource",
+      target_service: "master_data",
       target_sub_service: "customer",
       target_method: "Read",
       field_name: "customer",
@@ -139,43 +142,45 @@ message Invoice {
   optional string shop_id = 7 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.shop.Shop",
-      target_service: "resource",
+      target_service: "master_data",
       target_sub_service: "shop",
       target_method: "Read",
       field_name: "shop",
     }
   ]; // shop_number --- ref. to sender orga
-  optional double timestamp = 8;
+  optional google.protobuf.Timestamp timestamp = 8;
   optional PaymentState payment_state = 9;
   optional io.restorecommerce.address.BillingAddress sender = 10;
   optional io.restorecommerce.address.BillingAddress recipient = 11;
-  repeated Position positions = 12;
+  repeated Section sections = 12;
   repeated io.restorecommerce.amount.Amount total_amounts = 13;
-  repeated string payment_hints = 14; // is there no better type for that?
+  repeated string payment_hints = 14;
   repeated io.restorecommerce.file.File documents = 15; // url to rendered PDFs
-  optional string customer_remark = 16;
-  optional double from_date = 17; // value performance from date
-  optional double to_date = 18; // value performance to date
-  optional bool sent = 19;
-  optional bool withdrawn = 20;
+  optional google.protobuf.Timestamp from_date = 16; // value performance from date
+  optional google.protobuf.Timestamp to_date = 17; // value performance to date
+  optional bool sent = 18;
+  optional bool withdrawn = 19;
 }
 
-message Position {
+message Section {
   optional string id = 1;
-  repeated Row rows = 3;
+  optional string customer_remark = 2;
+  repeated Position positions = 3;
   repeated io.restorecommerce.amount.Amount amounts = 5; // repeated in case of multiple currencies?
 }
 
-message Row {
+message Position {
   optional string id = 1;
   oneof item_type {
     ProductItem product_item = 2;
-    ManualItem manual_item = 3;
+    FulfillmentItem fulfillment_item = 3;
+    ManualItem manual_item = 4;
   }
-  optional io.restorecommerce.price.Price unit_price = 4;
-  optional uint32 quantity = 5;
-  optional io.restorecommerce.amount.Amount amount = 6;
-  optional double contract_start_date = 7; // if there is any contract associated with product
+  optional io.restorecommerce.price.Price unit_price = 5;
+  optional uint32 quantity = 6;
+  optional io.restorecommerce.amount.Amount amount = 7;
+  optional double contract_start_date = 8; // if there is any contract associated with product
+  repeated io.restorecommerce.attribute.Attribute attributes = 9;
 }
 
 message ProductItem {
@@ -191,6 +196,19 @@ message ProductItem {
   optional string variant_id = 2;
 }
 
+message FulfillmentItem {
+  optional string product_id = 1 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.fulfillment_product.FulfillmentProduct",
+      target_service: "fulfillment",
+      target_sub_service: "fulfillment_product",
+      target_method: "Read",
+      field_name: "product",
+    }
+  ];
+  optional string variant_id = 2;
+}
+
 message ManualItem {
   optional string stock_keeping_unit = 1;
   optional string name = 2;

package/io/restorecommerce/meta.proto

@@ -3,12 +3,13 @@ syntax = "proto3";
 package io.restorecommerce.meta;
 
 import "io/restorecommerce/attribute.proto";
+import "google/protobuf/timestamp.proto";
 
 // meta properties common to all resources
 
 message Meta {
-    optional double created = 1; // timestamp
-    optional double modified = 2; // timestamp
+    optional google.protobuf.Timestamp created = 1; // timestamp
+    optional google.protobuf.Timestamp modified = 2; // timestamp
     optional string modified_by = 3; // ID from last User who modified it
     repeated io.restorecommerce.attribute.Attribute owners = 4;
     repeated io.restorecommerce.attribute.AttributeObj acls = 5;

package/io/restorecommerce/order.proto

@@ -47,7 +47,7 @@ service OrderService {
   rpc TriggerInvoice (InvoiceRequestList) returns (io.restorecommerce.status.StatusListResponse);
 }
 
-enum State {
+enum OrderState {
   FAILED = 0;
   INVALID = 1;
   CREATED = 2;
@@ -58,6 +58,11 @@ enum State {
   CANCELLED = 7;
 }
 
+enum FulfillmentInvoiceMode {
+  INCLUDE = 0;
+  EXCLUDE = 1;
+}
+
 message Item {
   optional string id = 1;
   optional string product_id = 2 [
@@ -92,7 +97,7 @@ message Order {
   optional string user_id = 3 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.customer.Customer",
-      target_service: "resource",
+      target_service: "master_data",
       target_sub_service: "customer",
       target_method: "Read",
       field_name: "customer",
@@ -101,7 +106,7 @@ message Order {
   optional string customer_id = 4 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.customer.Customer",
-      target_service: "resource",
+      target_service: "master_data",
       target_sub_service: "customer",
       target_method: "Read",
       field_name: "customer",
@@ -110,14 +115,14 @@ message Order {
   optional string shop_id = 5 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.shop.Shop",
-      target_service: "resource",
+      target_service: "master_data",
       target_sub_service: "shop",
       target_method: "Read",
       field_name: "shop",
     }
   ];
   repeated Item items = 6;
-  optional State order_state = 7;                                         // Set by service
+  optional OrderState order_state = 7;                                         // Set by service
   optional io.restorecommerce.fulfillment.State fulfillment_state = 8;    // Set by kafka
   optional io.restorecommerce.invoice.PaymentState payment_state = 9;            // Set by kafka
   repeated io.restorecommerce.amount.Amount total_amounts = 10;                // Set by service --- repeated in case of variant currency?
@@ -161,7 +166,7 @@ message FulfillmentRequest {
   optional string export_description = 3; // @TODO: not used!
   optional string invoice_number = 4; // @TODO: not used!
   optional io.restorecommerce.address.ShippingAddress sender_address = 5;
-  repeated string include_items = 6; // includes all if empty
+  repeated string selected_items = 6; // select all on empty
   google.protobuf.Any data = 7;
 }
 
@@ -171,15 +176,17 @@ message FulfillmentRequestList {
   io.restorecommerce.auth.Subject subject = 3;
 }
 
-message InvoicePosition {
-  optional string order_id = 2;
-  repeated string included_items = 3; // includes all on empty
-  repeated string included_fulfillments = 4; // includes all on empty
+message InvoiceSection {
+  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
 }
 
 message InvoiceRequest {
   optional string invoice_number = 1; // if given
-  repeated InvoicePosition positions = 2;
+  repeated string payment_hints = 2;
+  repeated InvoiceSection sections = 3;
 }
 
 message InvoiceRequestList {

package/io/restorecommerce/organization.proto

@@ -2,16 +2,19 @@ syntax = "proto3";
 
 package io.restorecommerce.organization;
 
-import "io/restorecommerce/resource_base.proto";
 import "google/protobuf/any.proto";
+
+import "io/restorecommerce/resource_base.proto";
 import "io/restorecommerce/meta.proto";
 import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
+import "io/restorecommerce/image.proto";
 import "io/restorecommerce/options.proto";
 
 // Used by resolvers
 import "io/restorecommerce/address.proto";
 import "io/restorecommerce/contact_point.proto";
+import "io/restorecommerce/payment_method.proto";
 
 service OrganizationService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (OrganizationListResponse) {
@@ -73,12 +76,20 @@ message Organization {
   ]; // list of possible legal addresses of different types
   optional string website = 5;
   optional string email = 6;
-  optional string logo = 7; // base64; arangoDB does not support blob storage
+  optional io.restorecommerce.image.Image logo = 7; // base64; arangoDB does not support blob storage
   optional string vat_id = 8;
   optional string isic_v4 = 9;
   optional string registration = 10;
   optional string registration_court = 11;
   optional string name = 12;
-  repeated string payment_method_ids = 13;
+  repeated string payment_method_ids = 13 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.payment_method.PaymentMethod",
+      target_service: "payment",
+      target_sub_service: "payment_method",
+      target_method: "Read",
+      field_name: "paymentMethods",
+    }
+  ];
   optional google.protobuf.Any data = 14; /// additional data
 }

package/io/restorecommerce/product.proto

@@ -67,7 +67,7 @@ message Product {
   optional string shop_id = 5 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.shop.Shop",
-      target_service: "resource",
+      target_service: "master_data",
       target_sub_service: "shop",
       target_method: "Read",
       field_name: "shop",
@@ -91,9 +91,18 @@ message IndividualProduct {
       field_name: "manufacturer",
     }
   ];
-  optional string taric_code = 4;
+  optional string origin_country_id = 4 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.country.Country",
+      target_service: "master_data",
+      target_sub_service: "country",
+      target_method: "Read",
+      field_name: "origin_country",
+    }
+  ];
+  optional string taric_code = 5;
   oneof classification {
-    string prototype_id = 5 [
+    string prototype_id = 6 [
       (io.restorecommerce.options.resolver) = {
         target_type: ".io.restorecommerce.product_prototype.ProductPrototype",
         target_service: "catalog",
@@ -102,7 +111,7 @@ message IndividualProduct {
         field_name: "prototype",
       }
     ];
-    string category_id = 6 [
+    string category_id = 7 [
       (io.restorecommerce.options.resolver) = {
         target_type: ".io.restorecommerce.product_category.ProductCategory",
         target_service: "catalog",
@@ -112,12 +121,12 @@ message IndividualProduct {
       }
     ];
   }
-  repeated string tax_ids = 7;
-  optional string currency_id = 8;
-  optional string gtin = 9;
+  repeated string tax_ids = 8;
+  optional string gtin = 10;
   oneof nature {
-    PhysicalProduct physical = 10;
-    VirtualProduct virtual = 11;
+    PhysicalProduct physical = 11;
+    ServiceProduct service = 12;
+    VirtualProduct virtual = 13;
   };
 }
 
@@ -125,6 +134,10 @@ message PhysicalProduct {
   repeated PhysicalVariant variants = 1;
 }
 
+message ServiceProduct {
+  repeated ServiceVariant variants = 1;
+}
+
 message VirtualProduct {
   repeated VirtualVariant variants = 1;
 }
@@ -166,6 +179,19 @@ message PhysicalVariant {
   repeated io.restorecommerce.attribute.Attribute attributes = 11;
 }
 
+message ServiceVariant {
+  optional string id = 1;
+  optional string name = 2;
+  optional string description = 3;
+  optional int32 stock_level = 4;
+  optional io.restorecommerce.price.Price price = 5;
+  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;
+  repeated io.restorecommerce.attribute.Attribute attributes = 10;
+}
+
 message VirtualVariant {
   optional string id = 1;
   optional string name = 2;

package/io/restorecommerce/shop.proto

@@ -54,7 +54,7 @@ message Shop {
   optional string organization_id = 7 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.organization.Organization",
-      target_service: "resource",
+      target_service: "master_data",
       target_sub_service: "organization",
       target_method: "Read",
       field_name: "organization",

package/io/restorecommerce/status.proto

@@ -3,9 +3,9 @@ syntax = "proto3";
 package io.restorecommerce.status;
 
 message Status {
-  optional string id = 1;
-  optional uint32 code = 2;
-  optional string message = 3;
+  string id = 1;
+  uint32 code = 2;
+  string message = 3;
 }
 
 message StatusArray {
@@ -13,19 +13,19 @@ message StatusArray {
 }
 
 message StatusObj {
-  optional Status status = 1;
+  Status status = 1;
 }
 
 message OperationStatusObj {
-  optional OperationStatus operation_status = 1;
+  OperationStatus operation_status = 1;
 }
 
 message OperationStatus {
-  optional uint32 code = 1;
-  optional string message = 2;
+  uint32 code = 1;
+  string message = 2;
 }
 
 message StatusListResponse {
   repeated Status status = 1;
-  optional OperationStatus operation_status = 2;
+  OperationStatus operation_status = 2;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@restorecommerce/protos",
-  "version": "4.0.1",
+  "version": "4.1.1",
   "description": "Protobuf descriptors for Restorecommerce services",
   "author": "n-fuse GmbH",
   "repository": {
@@ -15,5 +15,5 @@
     "protobufs"
   ],
   "scripts": {},
-  "gitHead": "47e9cd820ed04044a952713d3c8c895c045bc702"
+  "gitHead": "0b69448ada6429205437ec5642fded8495695360"
 }

package/test/test.proto

@@ -6,6 +6,7 @@ import "io/restorecommerce/resource_base.proto";
 import "io/restorecommerce/meta.proto";
 import "io/restorecommerce/status.proto";
 import "io/restorecommerce/auth.proto";
+import "google/protobuf/timestamp.proto";
 
 service Test {
   rpc Test (TestRequest) returns (TestResponse);
@@ -103,7 +104,7 @@ message Resource {
   int32 value = 3;
   string text = 4;
   bool active = 5;
-  double created = 6;
+  google.protobuf.Timestamp created = 6;
   string status = 7;
   optional google.protobuf.Any data = 8;
 }