@restorecommerce/protos 0.4.5

package/io/restorecommerce/fulfillment_product.proto

@@ -0,0 +1,49 @@
+syntax = "proto3";
+
+package io.restorecommerce.fulfillment_courier;
+
+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";
+
+/**
+Microservice defination   
+*/
+
+service Service {
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (ProductResponseList);
+  rpc Create (ProductList) returns (ProductResponseList);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc Update (ProductList) returns (ProductResponseList);
+  rpc Upsert (ProductList) returns (ProductResponseList);
+}
+
+message Product {
+  string id = 1;
+  string uks_id = 2;
+  string courier_id = 3;
+  string name = 4;
+  string description = 5;
+  string account_number = 6;
+  io.restorecommerce.meta.Meta meta = 7;
+  google.protobuf.Any options = 8;
+}
+
+message ProductList {
+  repeated Product items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message ProductResponse {
+  Product payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+message ProductResponseList {
+  repeated ProductResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}

package/io/restorecommerce/graph.proto

@@ -0,0 +1,76 @@
+syntax = "proto3";
+package io.restorecommerce.graph;
+import "google/protobuf/any.proto";
+import "io/restorecommerce/auth.proto";
+
+// Service provides the CRUD operations
+service Service {
+  rpc Traversal (TraversalRequest) returns (stream TraversalResponse);
+}
+
+message TraversalRequest {
+  message StartVertices {
+    repeated string vertices = 1;
+  }
+
+  // Document handle either _id or _key value
+  oneof vertex {
+    string start_vertex = 1;
+    StartVertices start_vertices = 2;
+  }
+
+  // Filter based on fieldName|operation, value|list
+  Options opts = 3;
+  string collection_name = 4;
+  string edge_name = 5;
+  bool data = 6;
+  bool path = 7;
+  bool aql = 8;
+  io.restorecommerce.auth.Subject subject = 9;
+}
+
+message TraversalResponse {
+  repeated VertexFields vertex_fields = 1;
+  google.protobuf.Any paths = 2;
+  google.protobuf.Any data = 3;
+}
+
+message VertexFields {
+  string id = 1;
+  string key = 2;
+  string rev = 3;
+}
+
+message Options {
+ string sort = 1; // JS code
+ string direction = 2; // either inbound or outbound
+ uint32 min_depth = 3; // ANDed with any existing filters): visits only nodes in at least the given depth
+ string start_vertex = 4; // id of the startVertex
+ string visitor = 5; // JS code
+ string item_order = 6; // item iteration order can be "forward" or "backward"
+ string strategy = 7; // traversal strategy can be "depthfirst" or "breadthfirst"
+ repeated Filter filter = 8; // JS code
+ string init = 9; // JS code
+ uint32 max_iterations = 10; // maximum number of iterations in each traversal
+ uint32 max_depth = 11; // ANDed with any existing filters visits only nodes in at most the given depth
+ Uniqueness uniqueness = 12; // specifies uniqueness for vertices and edges visited
+ string order = 13; //  "preorder", "postorder" or "preorder-expander"
+ string graph_name = 14; // name of graph that contains the edges
+ repeated Expander expander = 15; // JS code
+ string edge_collection = 16; // name of the collection that contains the edges
+ bool lowest_common_ancestor = 17;
+}
+
+message Filter {
+  string vertex = 1; // exclude these vertices
+}
+
+message Expander {
+  string edge = 1; // expand these edges
+  string direction = 2;
+}
+
+message Uniqueness {
+  string vertices = 1; // "none"|"global"|"path" for unique vertices
+  string edges = 2; // "none"|"global"|"path" for unique edges
+}

package/io/restorecommerce/image.proto

@@ -0,0 +1,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;
+}
+
+message ImageList {
+    repeated Image items = 1;
+    uint32 total_count = 2;
+}
+
+message Deleted {
+    string id = 1;
+}

package/io/restorecommerce/invoice.proto

@@ -0,0 +1,121 @@
+syntax = "proto3";
+
+package io.restorecommerce.invoice;
+
+import "io/restorecommerce/resource_base.proto";
+import "io/restorecommerce/meta.proto";
+import "io/restorecommerce/organization.proto";
+import "io/restorecommerce/auth.proto";
+import "google/protobuf/any.proto";
+import "io/restorecommerce/status.proto";
+
+/*
+* Microservice definition.
+*/
+service Service {
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (InvoiceListResponse);
+  rpc Create (InvoiceList) returns (InvoiceListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc Update (InvoiceList) returns (InvoiceListResponse);
+  rpc Upsert (InvoiceList) returns (InvoiceListResponse);
+}
+
+message Deleted {
+  string id = 1;
+}
+
+/*
+* For multiple invoices
+*/
+message InvoiceList {
+  repeated Invoice items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message InvoiceListResponse {
+  repeated InvoiceResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message InvoiceResponse {
+  Invoice payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+/*
+* A simple invoice.
+*/
+message Invoice {
+  string id = 1;
+  io.restorecommerce.meta.Meta meta = 2;
+  string timestamp = 4;
+  string customer_id = 5;
+  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;
+}
+
+/**
+* List of Invoice Positions data
+*/
+message InvoicesPositionsData {
+  repeated InvoicePositions invoices_positions_data = 1;
+}
+
+message InvoicePositions {
+  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;
+}
+
+message RecipientCustomer {
+  string id = 1; // customer id - used to store the resource in DB
+  string customer_number = 2; // displayed in invoice - auto generated per customer
+}
+
+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;
+}
+
+message InvoicePosition {
+  string currency = 1;
+  repeated InvoiceRow tableList = 2;
+  InvoicePrice totalPrice = 3;
+}
+
+message InvoiceRow {
+  string product = 1;
+  uint32 pricePerUnit = 2;
+  uint32 quantity = 3;
+  string vat = 4;
+  uint32 amount = 5;
+}
+
+message InvoicePrice {
+  uint32 gross = 1;
+  uint32 net = 2;
+}
+
+message TriggerInvoices {
+  repeated string ids = 1; // list of id referring to contract_ids or customer_ids
+}

package/io/restorecommerce/job.proto

@@ -0,0 +1,173 @@
+syntax = "proto3";
+
+package io.restorecommerce.job;
+
+import "io/restorecommerce/resource_base.proto";
+import "google/protobuf/any.proto";
+import "io/restorecommerce/meta.proto";
+import "io/restorecommerce/auth.proto";
+import "io/restorecommerce/status.proto";
+
+/**
+ * The microservice for scheduling jobs.
+ * Provides CRUD operations.
+ */
+service Service {
+  rpc Read (JobReadRequest) returns (JobListResponse);
+  rpc Create (JobList) returns (JobListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc Update (JobList) returns (JobListResponse);
+  rpc Upsert (JobList) returns (JobListResponse);
+}
+
+/**
+ * A Kafka event.
+ * Send when a job resource got deleted.
+ */
+message Deleted {
+  string id = 1;
+}
+
+/**
+ * A list of jobs.
+ */
+message JobList {
+  repeated Job items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message JobListResponse {
+  repeated JobResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message JobResponse {
+  Job payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+/**
+ * A Job resource
+ */
+message Job {
+  string id = 1; // Job ID
+
+  string type = 11; // Job type
+  Data data = 12; // Job-specific data with variable payload
+
+  string when = 21; // Used to specify the time at which the job is run
+
+  JobOptions options = 30; // The job options
+}
+
+/**
+ * Job Options
+ */
+message JobOptions {
+  enum Priority {
+    NORMAL = 0;
+    LOW = 10;
+    MEDIUM = -5;
+    HIGH = -10;
+    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
+
+  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
+}
+
+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
+}
+
+// Data which is stored within a job instance
+message Data {
+  string timezone = 1;
+  google.protobuf.Any payload = 2; // optional variable payload
+  io.restorecommerce.meta.Meta meta = 3;
+  string subject_id = 4; // id of job creator
+}
+
+/**
+ * A scheduled Job.
+ * 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)
+}
+
+/**
+ * A finished scheduled Job.
+ * 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;
+}
+
+/**
+ * A failed scheduled Job event from the Job Service.
+ * 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
+}
+
+/**
+ * Delay between retries.
+ */
+message Backoff {
+  enum Type {
+    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
+}
+
+// Job-specific read request
+message JobReadRequest {
+  uint32 limit = 1;
+  // only possible to sort jobs by creation date
+  enum SortOrder {
+    UNSORTED = 0;
+    ASCENDING = 1;
+    DESCENDING = 2;
+  }
+  SortOrder sort = 2;
+
+  // Filter based on fieldName|operation, value|list
+  JobFilter filter = 4;
+
+  // Fields selector
+  repeated io.restorecommerce.resourcebase.FieldFilter field = 3;
+  io.restorecommerce.auth.Subject subject = 5;
+}
+
+// filter
+message JobFilter {
+  repeated string job_ids = 1;
+  string type = 2;
+}

package/io/restorecommerce/locale.proto

@@ -0,0 +1,47 @@
+syntax = "proto3";
+
+package io.restorecommerce.locale;
+
+import "io/restorecommerce/resource_base.proto";
+import "io/restorecommerce/meta.proto";
+import "io/restorecommerce/auth.proto";
+import "io/restorecommerce/status.proto";
+
+/*
+* Microservice definition.
+*/
+service Service {
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (LocaleListResponse);
+  rpc Create (LocaleList) returns (LocaleListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc Update (LocaleList) returns (LocaleListResponse);
+  rpc Upsert (LocaleList) returns (LocaleListResponse);
+}
+
+message Deleted {
+  string id = 1;
+}
+
+message LocaleList {
+  repeated Locale items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message LocaleListResponse {
+  repeated LocaleResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message LocaleResponse {
+  Locale payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+message Locale {
+  string id = 1;
+  io.restorecommerce.meta.Meta meta = 2;
+  string value = 3;
+  string description = 4;
+}

package/io/restorecommerce/location.proto

@@ -0,0 +1,53 @@
+syntax = "proto3";
+
+package io.restorecommerce.location;
+
+import "io/restorecommerce/resource_base.proto";
+import "google/protobuf/any.proto";
+import "io/restorecommerce/meta.proto";
+import "io/restorecommerce/auth.proto";
+import "io/restorecommerce/status.proto";
+
+/*
+* Microservice definition.
+*/
+service Service {
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (LocationListResponse);
+  rpc Create (LocationList) returns (LocationListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc Update (LocationList) returns (LocationListResponse);
+  rpc Upsert (LocationList) returns (LocationListResponse);
+}
+
+message Deleted {
+  string id = 1;
+}
+
+message LocationList {
+  repeated Location items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message LocationListResponse {
+  repeated LocationResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message LocationResponse {
+  Location payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+message Location {
+  string id = 1; // Location ID, unique, key
+  io.restorecommerce.meta.Meta meta = 2;
+  string name = 3; // Location name
+  string description = 4; 
+  string organization_id = 5; // Organization to which this location is linked
+  string parent_id = 6;  //  Location which may contain this location; may be null
+  repeated string children_ids = 7;  // Locations contained in this location
+  string address_id = 8;
+  google.protobuf.Any data = 9; /// additional data
+}

package/io/restorecommerce/manufacturer.proto

@@ -0,0 +1,45 @@
+syntax = "proto3";
+
+package io.restorecommerce.manufacturer;
+
+import "io/restorecommerce/resource_base.proto";
+import "io/restorecommerce/meta.proto";
+import "io/restorecommerce/auth.proto";
+import "io/restorecommerce/status.proto";
+
+// Manufacturer resource
+message Manufacturer {
+  string id = 1;
+  io.restorecommerce.meta.Meta meta = 2;
+  string name = 3; 
+  string description = 4;
+}
+
+message ManufacturerList {
+  repeated Manufacturer items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message ManufacturerListResponse {
+  repeated ManufacturerResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message ManufacturerResponse {
+  Manufacturer payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+message Deleted {
+  string id = 1;
+}
+
+service Service {
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (ManufacturerListResponse);
+  rpc Create (ManufacturerList) returns (ManufacturerListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc Update (ManufacturerList) returns (ManufacturerListResponse);
+  rpc Upsert (ManufacturerList) returns (ManufacturerListResponse);
+}

package/io/restorecommerce/meta.proto

@@ -0,0 +1,15 @@
+syntax = "proto3";
+
+package io.restorecommerce.meta;
+
+import "io/restorecommerce/attribute.proto";
+
+// meta properties common to all resources
+
+message Meta {
+    double created = 1; // timestamp
+    double modified = 2; // timestamp
+    string modified_by = 3; // ID from last User who modified it
+    repeated io.restorecommerce.attribute.Attribute owner = 4;
+    repeated io.restorecommerce.attribute.AttributeObj acl = 5;
+}

package/io/restorecommerce/notification.proto

@@ -0,0 +1,52 @@
+syntax = "proto3";
+
+package io.restorecommerce.notification;
+
+import "io/restorecommerce/resource_base.proto";
+import "io/restorecommerce/meta.proto";
+import "io/restorecommerce/auth.proto";
+import "io/restorecommerce/status.proto";
+
+// Message structure for Notification
+service Service {
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (NotificationListResponse);
+  rpc Create (NotificationList) returns (NotificationListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc Update (NotificationList) returns (NotificationListResponse);
+  rpc Upsert (NotificationList) returns (NotificationListResponse);
+}
+
+message Deleted {
+  string id = 1;
+}
+
+message NotificationList {
+  repeated Notification items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message NotificationListResponse {
+  repeated NotificationResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message NotificationResponse {
+  Notification items = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+message Notification {
+  string id = 1;
+  io.restorecommerce.meta.Meta meta = 2;
+  string name = 3;
+  string description = 4;
+  repeated string notification_channel_ids = 5;
+  oneof address_type {
+    string email = 6;
+    string telephone_number = 7;
+  }
+  string subject_template = 8;
+  string body_template = 9;
+}