@restorecommerce/protos 2.0.1 → 3.0.0

package/io/restorecommerce/fulfillment_courier.proto

@@ -13,15 +13,13 @@ import "io/restorecommerce/options.proto";
 Microservice defination
 */
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "fulfillment_courier";
-
-  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (FulfillmentCourierResponseList) {
+service FulfillmentCourierService {
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (FulfillmentCourierListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
-  rpc Create (FulfillmentCourierList) returns (FulfillmentCourierResponseList);
-  rpc Update (FulfillmentCourierList) returns (FulfillmentCourierResponseList);
-  rpc Upsert (FulfillmentCourierList) returns (FulfillmentCourierResponseList);
+  rpc Create (FulfillmentCourierList) returns (FulfillmentCourierListResponse);
+  rpc Update (FulfillmentCourierList) returns (FulfillmentCourierListResponse);
+  rpc Upsert (FulfillmentCourierList) returns (FulfillmentCourierListResponse);
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
 }
 
@@ -34,19 +32,19 @@ message FulfillmentCourier {
     deleted: "fulfillmentCourierDeleted"
   };
 
-  string id = 1;
-  string name = 4;
-  string description = 5;
-  string logo = 6;
-  string website = 7;
-  string stub_type = 8;
-  google.protobuf.Any configuration = 10;
-  io.restorecommerce.meta.Meta meta = 11;
+  optional string id = 1;
+  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;
 }
 
 message FulfillmentCourierList {
   repeated FulfillmentCourier items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -55,7 +53,7 @@ message FulfillmentCourierResponse {
   io.restorecommerce.status.Status status = 2;
 }
 
-message FulfillmentCourierResponseList {
+message FulfillmentCourierListResponse {
   repeated FulfillmentCourierResponse items = 1;
   uint32 total_count = 2;
   io.restorecommerce.status.OperationStatus operation_status = 3;

package/io/restorecommerce/fulfillment_product.proto

@@ -7,6 +7,9 @@ import "io/restorecommerce/meta.proto";
 import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
 import "io/restorecommerce/attribute.proto";
+import "io/restorecommerce/address.proto";
+import "io/restorecommerce/tax.proto";
+import "io/restorecommerce/geometry.proto";
 import "io/restorecommerce/fulfillment_courier.proto";
 import "io/restorecommerce/fulfillment.proto";
 import "io/restorecommerce/options.proto";
@@ -15,55 +18,51 @@ import "io/restorecommerce/options.proto";
 Microservice defination
 */
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "fulfillment_product";
-
-  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (FulfillmentProductResponseList) {
+service FulfillmentProductService {
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (FulfillmentProductListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
-  rpc Find (QueryList) returns (PackingSolutionResponseList) {
+  rpc Find (ProductQueryList) returns (PackingSolutionListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
-  rpc Create (FulfillmentProductList) returns (FulfillmentProductResponseList);
-  rpc Update (FulfillmentProductList) returns (FulfillmentProductResponseList);
-  rpc Upsert (FulfillmentProductList) returns (FulfillmentProductResponseList);
+  rpc Create (FulfillmentProductList) returns (FulfillmentProductListResponse);
+  rpc Update (FulfillmentProductList) returns (FulfillmentProductListResponse);
+  rpc Upsert (FulfillmentProductList) returns (FulfillmentProductListResponse);
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
 }
 
 message Preferences {
   repeated io.restorecommerce.attribute.Attribute couriers = 1; //ID, name or type
-  float pricing = 2;
-  float compactness = 3;
-  float homogeneity = 4;
+  repeated io.restorecommerce.attribute.Attribute options = 2;
 }
 
-message Query {
-  // io.restorecommerce.fulfillment.Address sender = 1;
-  // io.restorecommerce.fulfillment.Address receiver = 2;
-  repeated io.restorecommerce.fulfillment.Item goods = 3;
-  Preferences preferences = 4;
-  string reference_id = 5;
+message ProductQuery {
+  optional io.restorecommerce.address.ShippingAddress sender = 1;
+  optional io.restorecommerce.address.ShippingAddress receiver = 2;
+  repeated io.restorecommerce.fulfillment.FulfillmentItem items = 3;
+  optional Preferences preferences = 4;
+  optional string reference_id = 5;
 }
 
-message QueryList {
-  repeated Query items = 1;
-  uint32 total_count = 2;
+message ProductQueryList {
+  repeated ProductQuery items = 1;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
 message FulfillmentProduct {
   option (restorecommerce.options.kafka_subscriber) = {
-    plural: "fulfillmentProduct"
+    plural: "fulfillment_products"
     topic: "io.restorecommerce.fulfillment_product.resource"
     created: "fulfillmentProductCreated"
     updated: "fulfillmentProductUpdated"
     deleted: "fulfillmentProductDeleted"
   };
 
-  string id = 1;
-  string name = 2;
-  string description = 3;
-  string courier_id = 4 [
+  optional string id = 1;
+  optional string name = 2;
+  optional string description = 3;
+  optional string courier_id = 4 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.fulfillment_courier.FulfillmentCourier",
       target_service: "resource",
@@ -77,24 +76,21 @@ message FulfillmentProduct {
   repeated string tax_ids = 9;
   repeated io.restorecommerce.attribute.Attribute attributes = 10;
   repeated Variant variants = 11;
-  io.restorecommerce.meta.Meta meta = 12;
+  optional io.restorecommerce.meta.Meta meta = 12;
 }
 
 message Variant {
-  string id = 1;
-  string name = 2;
-  string description = 3;
-  double price = 4;
-  double max_weight = 5;
-  double max_width = 6;
-  double max_height = 7;
-  double max_length = 8;
-  double max_volume = 9;
+  optional string id = 1;
+  optional string name = 2;
+  optional string description = 3;
+  optional double price = 4;
+  optional io.restorecommerce.geometry.BoundingBox3D max_size = 6;
+  optional double max_weight = 7;
 }
 
 message FulfillmentProductList {
   repeated FulfillmentProduct items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -103,29 +99,30 @@ message FulfillmentProductResponse {
   io.restorecommerce.status.Status status = 2;
 }
 
-message FulfillmentProductResponseList {
+message FulfillmentProductListResponse {
   repeated FulfillmentProductResponse items = 1;
   uint32 total_count = 2;
   io.restorecommerce.status.OperationStatus operation_status = 3;
 }
 
 message PackingSolution {
-  string reference_id = 1;
-  float price = 2;
-  float compactness = 3;
-  float homogeneity = 4;
-  float score = 5;
-  repeated io.restorecommerce.fulfillment.Parcel parcels = 6;
+  optional double price = 1;
+  optional double compactness = 2;
+  optional double homogeneity = 3;
+  optional double score = 4;
+  repeated io.restorecommerce.fulfillment.Parcel parcels = 5;
+  repeated io.restorecommerce.tax.VAT vats = 6;
 }
 
 message PackingSolutionResponse {
-  repeated PackingSolution solutions = 1;
-  io.restorecommerce.status.Status status = 2;
+  optional string reference_id = 1;
+  repeated PackingSolution solutions = 2;
+  optional io.restorecommerce.status.Status status = 3;
 }
 
-message PackingSolutionResponseList {
+message PackingSolutionListResponse {
   repeated PackingSolutionResponse items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.status.OperationStatus operation_status = 3;
 }
 

package/io/restorecommerce/geometry.proto

@@ -0,0 +1,23 @@
+syntax = "proto3";
+
+package io.restorecommerce.geometry;
+
+import "io/restorecommerce/options.proto";
+
+
+message Vector3D {
+  optional double x = 1;
+  optional double y = 2;
+  optional double z = 3;
+}
+
+message BoundingBox3D {
+  optional double width = 1;
+  optional double height = 2;
+  optional double length = 3;
+}
+
+message OriginBoundingBox {
+  optional Vector3D origin = 1;
+  optional BoundingBox3D bbox = 2;
+}

package/io/restorecommerce/graph.proto

@@ -7,7 +7,7 @@ import "io/restorecommerce/status.proto";
 import "io/restorecommerce/resource_base.proto";
 
 // Service provides the CRUD operations
-service Service {
+service GraphService {
   rpc Traversal (TraversalRequest) returns (stream TraversalResponse);
 }
 
@@ -17,8 +17,8 @@ message TraversalRequest {
     Vertices vertices = 1;
     Collection collection = 2;
   }
-  Options opts = 3;
-  bool path = 4;
+  optional Options opts = 3;
+  optional bool path = 4;
   io.restorecommerce.auth.Subject subject = 5;
   repeated Filters filters = 6;
 }
@@ -49,18 +49,18 @@ message Options {
 
 
 message Filters {
-  string entity = 1; // entity on which the filters are applied
-  string edge = 2; // if edge is specified depending on the direction filter are applied only for those entities
+  optional string entity = 1; // entity on which the filters are applied
+  optional string edge = 2; // if edge is specified depending on the direction filter are applied only for those entities
   repeated Filter filter = 3;
   enum Operator {
     and = 0;
     or = 1;
   }
-  Operator operator = 4;
+  optional Operator operator = 4;
 }
 
 message Filter {
-  string field = 1;
+  optional string field = 1;
   enum Operation {
     eq = 0;
     lt = 1;
@@ -72,8 +72,8 @@ message Filter {
     in = 7;
     neq = 8;
   }
-  Operation operation = 2;
-  string value = 3;
+  optional Operation operation = 2;
+  optional string value = 3;
   enum ValueType {
     STRING = 0; // default value type if not specified
     NUMBER = 1;
@@ -81,7 +81,7 @@ message Filter {
     DATE = 3;
     ARRAY = 4;
   }
-  ValueType type = 4;
+  optional ValueType type = 4;
   repeated Filters filters = 5;
 }
 

package/io/restorecommerce/image.proto

@@ -2,23 +2,24 @@ syntax = "proto3";
 
 package io.restorecommerce.image;
 
-// ProductCategory resource
 message Image {
-    string id = 1;
-    string caption = 2;
-    string filename = 3;
-    string content_type = 4;
-    string url = 5;
-    double width = 6;
-    double height = 7;
-    double length = 8;
+  optional string id = 1;
+  optional string caption = 2;
+  optional string filename = 3;
+  optional string content_type = 4;
+  optional string url = 5;
+  optional double width = 6;
+  optional double height = 7;
+  optional double length = 8;
+  repeated string tags = 9;
+  optional int64 index = 10;
 }
 
 message ImageList {
-    repeated Image items = 1;
-    uint32 total_count = 2;
+  repeated Image items = 1;
+  optional uint32 total_count = 2;
 }
 
 message Deleted {
-    string id = 1;
+  string id = 1;
 }

package/io/restorecommerce/invoice.proto

@@ -16,9 +16,7 @@ import "io/restorecommerce/customer.proto";
 /*
 * Microservice definition.
 */
-service Service {
-  option (io.restorecommerce.options.service_name) = "invoice";
-
+service InvoiceService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (InvoiceListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
@@ -47,7 +45,7 @@ message Deleted {
 */
 message InvoiceList {
   repeated Invoice items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -66,10 +64,10 @@ message InvoiceResponse {
 * A simple invoice.
 */
 message Invoice {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string timestamp = 4;
-  string customer_id = 5 [
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string timestamp = 4;
+  optional string customer_id = 5 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.customer.Customer",
       target_service: "resource",
@@ -78,13 +76,13 @@ message Invoice {
       field_name: "customer",
     }
   ];
-  string payment_status = 6;
-  double total_amount = 7;
-  double net_amount = 8;
-  double vat_amount = 9; // difference between net and total
-  string document = 10;
-  string invoice_number = 11;
-  string customer_remark = 12;
+  optional string payment_status = 6;
+  optional double total_amount = 7;
+  optional double net_amount = 8;
+  optional double vat_amount = 9; // difference between net and total
+  optional string document = 10;
+  optional string invoice_number = 11;
+  optional string customer_remark = 12;
 }
 
 /**
@@ -95,57 +93,57 @@ message InvoicesPositionsData {
 }
 
 message InvoicePositions {
-  string id = 1; // contract or customer identifier
+  optional string id = 1; // contract or customer identifier
   repeated InvoicePosition invoice_positions = 2;
-  RecipientCustomer recipient_customer = 3;
-  BillingAddress recipient_billing_address = 4;
-  BillingAddress sender_billing_address = 5;
-  io.restorecommerce.organization.Organization recipient_organization = 6;
-  io.restorecommerce.organization.Organization sender_organization = 7;
-  google.protobuf.Any payment_method_details = 8;
-  string invoice_no = 9; // optional invoice number if not it will be generated by service
-  double from_date = 10; // value performance from date
-  double to_date = 11; // value performance to date
+  optional RecipientCustomer recipient_customer = 3;
+  optional BillingAddress recipient_billing_address = 4;
+  optional BillingAddress sender_billing_address = 5;
+  optional io.restorecommerce.organization.Organization recipient_organization = 6;
+  optional io.restorecommerce.organization.Organization sender_organization = 7;
+  optional google.protobuf.Any payment_method_details = 8;
+  optional string invoice_no = 9; // optional invoice number if not it will be generated by service
+  optional double from_date = 10; // value performance from date
+  optional double to_date = 11; // value performance to date
 }
 
 message RecipientCustomer {
-  string id = 1; // customer id - used to store the resource in DB
-  string customer_number = 2; // displayed in invoice
+  optional string id = 1; // customer id - used to store the resource in DB
+  optional string customer_number = 2; // displayed in invoice
 }
 
 message BillingAddress {
-  string email = 1;
-  string website = 2;
-  string street = 3;
-  string building_number = 4;
-  string postcode = 5;
-  string region = 6;
-  string country_name = 7;
-  string telephone = 9;
-  string timezone = 10;
-  string economic_area = 11;
-  string locality = 12;
-  string organization_name = 13;
+  optional string email = 1;
+  optional string website = 2;
+  optional string street = 3;
+  optional string building_number = 4;
+  optional string postcode = 5;
+  optional string region = 6;
+  optional string country_name = 7;
+  optional string telephone = 9;
+  optional string timezone = 10;
+  optional string economic_area = 11;
+  optional string locality = 12;
+  optional string organization_name = 13;
 }
 
 message InvoicePosition {
-  string currency = 1;
+  optional string currency = 1;
   repeated InvoiceRow tableList = 2;
-  InvoicePrice totalPrice = 3;
+  optional InvoicePrice totalPrice = 3;
 }
 
 message InvoiceRow {
-  string product = 1;
-  double pricePerUnit = 2;
-  uint32 quantity = 3;
-  string vat = 4;
-  double amount = 5;
-  double contract_start_date = 6; // if there is any contract associated with product
+  optional string product = 1;
+  optional double pricePerUnit = 2;
+  optional uint32 quantity = 3;
+  optional string vat = 4;
+  optional double amount = 5;
+  optional double contract_start_date = 6; // if there is any contract associated with product
 }
 
 message InvoicePrice {
-  double gross = 1;
-  double net = 2;
+  optional double gross = 1;
+  optional double net = 2;
 }
 
 message TriggerInvoices {

package/io/restorecommerce/job.proto

@@ -13,9 +13,7 @@ import "io/restorecommerce/options.proto";
  * The microservice for scheduling jobs.
  * Provides CRUD operations.
  */
-service Service {
-  option (io.restorecommerce.options.service_name) = "job";
-
+service JobService {
   rpc Read (JobReadRequest) returns (JobListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
@@ -38,7 +36,7 @@ message Deleted {
  */
 message JobList {
   repeated Job items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -57,14 +55,14 @@ message JobResponse {
  * A Job resource
  */
 message Job {
-  string id = 1; // Job ID
+  optional string id = 1; // Job ID
 
-  string type = 11; // Job type
-  Data data = 12; // Job-specific data with variable payload
+  optional string type = 11; // Job type
+  optional Data data = 12; // Job-specific data with variable payload
 
-  string when = 21; // Used to specify the time at which the job is run
+  optional string when = 21; // Used to specify the time at which the job is run
 
-  JobOptions options = 30; // The job options
+  optional JobOptions options = 30; // The job options
 }
 
 /**
@@ -79,31 +77,31 @@ message JobOptions {
     CRITICAL = -15;
   }
 
-  Priority priority = 13; // Job priority
-  uint32 attempts = 14; // Amount of possible failing runs until job fails
-  Backoff backoff = 15; // Delay settings between failed job runs
-  uint32 timeout = 16; // The number of milliseconds after which the job should be fail with a timeout error
+  optional Priority priority = 13; // Job priority
+  optional uint32 attempts = 14; // Amount of possible failing runs until job fails
+  optional Backoff backoff = 15; // Delay settings between failed job runs
+  optional uint32 timeout = 16; // The number of milliseconds after which the job should be fail with a timeout error
 
-  Repeat repeat = 20; // Used for periodic jobs
-  string jobId = 21; // To override the job ID - by default, the job ID is a unique generated by bull
-  bool removeOnComplete = 22; // If true, removes the job when it successfully completes
+  optional Repeat repeat = 20; // Used for periodic jobs
+  optional string jobId = 21; // To override the job ID - by default, the job ID is a unique generated by bull
+  optional bool removeOnComplete = 22; // If true, removes the job when it successfully completes
 }
 
 message Repeat {
-  uint32 every = 1;
-  string cron = 2;
-  string startDate = 3;
-  string endDate = 4;
-  uint32 count = 5;
-  string jobId = 6; // To override the job ID - by default, the job ID is a unique generated by bull
-  string tz = 7; // time zone
+  optional uint32 every = 1;
+  optional string cron = 2;
+  optional string startDate = 3;
+  optional string endDate = 4;
+  optional uint32 count = 5;
+  optional string jobId = 6; // To override the job ID - by default, the job ID is a unique generated by bull
+  optional string tz = 7; // time zone
 }
 
 // Data which is stored within a job instance
 message Data {
-  google.protobuf.Any payload = 2; // optional variable payload
-  io.restorecommerce.meta.Meta meta = 3;
-  string subject_id = 4; // id of job creator
+  optional google.protobuf.Any payload = 2; // optional variable payload
+  optional io.restorecommerce.meta.Meta meta = 3;
+  optional string subject_id = 4; // id of job creator
 }
 
 /**
@@ -111,10 +109,10 @@ message Data {
  * Emitted to Kafka by the scheduling service with event name 'queuedJob' and retreived by a service which processes this job.
  */
 message ScheduledJob {
-  string id = 1; // Job instance ID
-  string type = 2;
-  Data data = 3; // Job-specific data with variable payload
-  string schedule_type = 4; // Type of schedule (ONCE, RECURR, etc)
+  optional string id = 1; // Job instance ID
+  optional string type = 2;
+  optional Data data = 3; // Job-specific data with variable payload
+  optional string schedule_type = 4; // Type of schedule (ONCE, RECURR, etc)
 }
 
 /**
@@ -122,11 +120,11 @@ message ScheduledJob {
  * Emitted to Kafka by the service which processed the job with event name 'done' and retrieved by the scheduling service.
  */
 message JobDone {
-  string id = 1; // Job instance ID
-  string schedule_type = 2; // Type of schedule (ONCE, RECURR, etc)
-  bool delete_scheduled = 3; // Whether to delete scheduled job
-  string type = 4; // Job type
-  google.protobuf.Any result = 5;
+  optional string id = 1; // Job instance ID
+  optional string schedule_type = 2; // Type of schedule (ONCE, RECURR, etc)
+  optional bool delete_scheduled = 3; // Whether to delete scheduled job
+  optional string type = 4; // Job type
+  optional google.protobuf.Any result = 5;
 }
 
 /**
@@ -134,10 +132,10 @@ message JobDone {
  * Emitted to Kafka by the service which processed the Job and retrieved by the scheduling service.
  */
 message JobFailed {
-  string id = 1; // Job instance ID
-  string error = 2; // Error message
-  string schedule_type = 3; // Type of job ex: ONCE, RECURR etc.
-  string type = 4; // Job type
+  optional string id = 1; // Job instance ID
+  optional string error = 2; // Error message
+  optional string schedule_type = 3; // Type of job ex: ONCE, RECURR etc.
+  optional string type = 4; // Job type
 }
 
 /**
@@ -148,23 +146,23 @@ message Backoff {
     FIXED = 0; // Retry with the same delay
     EXPONENTIAL = 1; // Exponential delay increase between retries
   }
-  double delay = 1; // Time until retry in milliseconds
-  Type type = 2; // Calculation of the delay
+  optional double delay = 1; // Time until retry in milliseconds
+  optional Type type = 2; // Calculation of the delay
 }
 
 // Job-specific read request
 message JobReadRequest {
-  uint32 limit = 1;
+  optional uint32 limit = 1;
   // only possible to sort jobs by creation date
   enum SortOrder {
     UNSORTED = 0;
     ASCENDING = 1;
     DESCENDING = 2;
   }
-  SortOrder sort = 2;
+  optional SortOrder sort = 2;
 
   // Filter based on fieldName|operation, value|list
-  JobFilter filter = 4;
+  optional JobFilter filter = 4;
 
   // Fields selector
   repeated io.restorecommerce.resourcebase.FieldFilter field = 3;
@@ -174,5 +172,5 @@ message JobReadRequest {
 // filter
 message JobFilter {
   repeated string job_ids = 1;
-  string type = 2;
+  optional string type = 2;
 }