@restorecommerce/protos 0.4.5

package/io/restorecommerce/authentication_log.proto

@@ -0,0 +1,56 @@
+syntax = "proto3";
+
+package io.restorecommerce.authentication_log;
+
+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 (AuthenticationLogListResponse);
+  rpc Create (AuthenticationLogList) returns (AuthenticationLogListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc Update (AuthenticationLogList) returns (AuthenticationLogListResponse);
+  rpc Upsert (AuthenticationLogList) returns (AuthenticationLogListResponse);
+}
+
+message AuthenticationLogList {
+  repeated AuthenticationLog items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message AuthenticationLogListResponse {
+  repeated AuthenticationLogResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message AuthenticationLogResponse {
+  AuthenticationLog payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+/**
+ * Authentication Log
+ */
+message AuthenticationLog {
+  string id = 1; // log id
+  string ipv4_address = 2;
+  string ipv6_address = 3;
+  string operating_system = 4;
+  string user_agent = 5;
+  double date = 6; // time stamp of login, logout or token update
+  string activity = 7; // login, logout
+  io.restorecommerce.meta.Meta meta = 8; // meta info
+  string subject_id = 9; // subject id
+  string token_name = 10; // token name associated with io.restorecommerce.auth.Token.token_name
+}
+
+message Deleted {
+  string id = 1;
+}

package/io/restorecommerce/command.proto

@@ -0,0 +1,57 @@
+syntax = "proto3";
+
+package io.restorecommerce.command;
+
+import "io/restorecommerce/resource_base.proto";
+import "io/restorecommerce/meta.proto";
+import "io/restorecommerce/auth.proto";
+import "io/restorecommerce/status.proto";
+
+// command resource
+message Command {
+  string id = 1;
+  io.restorecommerce.meta.Meta meta = 2;
+  string name = 3;  // command name
+  repeated CommandParameter parameters = 4; // all possible parameters
+  string description = 5; // command description
+}
+
+message CommandParameter {
+  enum ParameterType {
+    boolean_value = 0;
+    object_value = 1;
+    array_value = 2;
+    number_value = 3;
+    string_value = 4;
+  }
+
+  string field = 1; //  field name
+  string description = 2; // field description
+  ParameterType type = 3; // field's type
+  string properties = 4; // dump properties in case of `object_value``
+}
+
+message CommandList {
+  repeated Command items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message CommandListResponse {
+  repeated CommandResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message CommandResponse {
+  Command payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+service Service {
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (CommandListResponse);
+  rpc Create (CommandList) returns (CommandListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc Update (CommandList) returns (CommandListResponse);
+  rpc Upsert (CommandList) returns (CommandListResponse);
+}

package/io/restorecommerce/commandinterface.proto

@@ -0,0 +1,30 @@
+syntax = "proto3";
+
+package io.restorecommerce.commandinterface;
+
+import "google/protobuf/any.proto";
+import "io/restorecommerce/auth.proto";
+
+// used to send requests through Kafka or gRPC
+message CommandRequest {
+  //  command identifier (used to demultiplex operation in the command implementation)
+  string name = 1;
+  google.protobuf.Any payload = 2;  // variable payload
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+// used to push responses to Kafka
+message CommandResponse {
+  // service identifiers
+  // (multiple services may reply to one system command)
+  // (multiple service names can be bound to one microservice)
+  repeated string services = 1;
+  google.protobuf.Any payload = 2;  // variable payload
+}
+
+/**
+* RPC service for executing commands
+*/
+service Service {
+  rpc Command(CommandRequest) returns (google.protobuf.Any);
+}

package/io/restorecommerce/contact_point.proto

@@ -0,0 +1,49 @@
+syntax = "proto3";
+
+package io.restorecommerce.contact_point;
+
+import "io/restorecommerce/resource_base.proto";
+import "io/restorecommerce/meta.proto";
+import "io/restorecommerce/auth.proto";
+import "io/restorecommerce/status.proto";
+
+service Service {
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (ContactPointListResponse);
+  rpc Create (ContactPointList) returns (ContactPointListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc Update (ContactPointList) returns (ContactPointListResponse);
+  rpc Upsert (ContactPointList) returns (ContactPointListResponse);
+}
+
+message Deleted {
+  string id = 1;
+}
+
+message ContactPointList {
+  repeated ContactPoint items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message ContactPointListResponse {
+  repeated ContactPointResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message ContactPointResponse {
+  ContactPoint payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+message ContactPoint {
+  string id = 1;
+  io.restorecommerce.meta.Meta meta = 2;
+  string physical_address_id = 3;
+  string website = 4;
+  string email = 5;
+  string contact_point_type_id = 6;
+  string telephone = 8;
+  string timezone_id = 9;
+  string locale_id = 10;
+}

package/io/restorecommerce/contact_point_type.proto

@@ -0,0 +1,46 @@
+syntax = "proto3";
+
+package io.restorecommerce.contact_point_type;
+
+import "io/restorecommerce/resource_base.proto";
+import "io/restorecommerce/auth.proto";
+import "io/restorecommerce/meta.proto";
+import "io/restorecommerce/status.proto";
+
+/*
+* Microservice definition.
+*/
+service Service {
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (ContactPointTypeListResponse);
+  rpc Create (ContactPointTypeList) returns (ContactPointTypeListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc Update (ContactPointTypeList) returns (ContactPointTypeListResponse);
+  rpc Upsert (ContactPointTypeList) returns (ContactPointTypeListResponse);
+}
+
+message Deleted {
+  string id = 1;
+}
+
+message ContactPointTypeList {
+  repeated ContactPointType items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message ContactPointType {
+  string id = 1;
+  io.restorecommerce.meta.Meta meta = 2;
+  string type = 3;
+}
+
+message ContactPointTypeListResponse {
+  repeated ContactPointTypeResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message ContactPointTypeResponse {
+  ContactPointType payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}

package/io/restorecommerce/country.proto

@@ -0,0 +1,49 @@
+syntax = "proto3";
+
+package io.restorecommerce.country;
+
+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 (CountryListResponse);
+  rpc Create (CountryList) returns (CountryListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc Update (CountryList) returns (CountryListResponse);
+  rpc Upsert (CountryList) returns (CountryListResponse);
+}
+
+message Deleted {
+  string id = 1;
+}
+
+message CountryList {
+  repeated Country items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message CountryListResponse {
+  repeated CountryResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message CountryResponse {
+  Country payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+message Country {
+  string id = 1;
+  io.restorecommerce.meta.Meta meta = 2;
+  string name = 3;
+  string country_code = 4;
+  string geographical_name = 5;
+  repeated string economic_areas = 6; 
+}

package/io/restorecommerce/credential.proto

@@ -0,0 +1,51 @@
+syntax = "proto3";
+
+package io.restorecommerce.credential;
+
+import "io/restorecommerce/resource_base.proto";
+import "io/restorecommerce/meta.proto";
+import "google/protobuf/any.proto";
+import "io/restorecommerce/auth.proto";
+import "io/restorecommerce/status.proto";
+
+/*
+* Microservice definition.
+*/
+service Service {
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (CredentialListResponse);
+  rpc Create (CredentialList) returns (CredentialListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc Update (CredentialList) returns (CredentialListResponse);
+  rpc Upsert (CredentialList) returns (CredentialListResponse);
+}
+
+message Deleted {
+  string id = 1;
+}
+
+message CredentialList {
+  repeated Credential items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message CredentialListResponse {
+  repeated CredentialResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message CredentialResponse {
+  Credential payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+message Credential {
+  string id = 1;
+  io.restorecommerce.meta.Meta meta = 2;
+  string name = 3;
+  string description = 4;
+  string user = 5;
+  string pass = 6;
+  google.protobuf.Any credentials = 7; /// additional credentials as auth key or certificates etc
+}

package/io/restorecommerce/customer.proto

@@ -0,0 +1,63 @@
+syntax = "proto3";
+
+package io.restorecommerce.customer;
+
+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 (CustomerListResponse);
+  rpc Create (CustomerList) returns (CustomerListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc Update (CustomerList) returns (CustomerListResponse);
+  rpc Upsert (CustomerList) returns (CustomerListResponse);
+}
+
+message CustomerList {
+  repeated Customer items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message CustomerListResponse {
+  repeated CustomerResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message CustomerResponse {
+  Customer payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+message Customer {
+  string id = 1;
+  io.restorecommerce.meta.Meta meta = 2;
+  oneof customer {
+    IndividualUser individual_user = 3;
+    OrgUser org_user = 4;
+    Guest guest = 5;
+  }
+}
+
+message IndividualUser {
+  string user_id = 1;
+  string address_id = 2;
+  repeated string contact_point_ids = 3;
+}
+
+message OrgUser {
+  string user_id = 1;
+  string organization_id = 2;
+}
+
+message Guest {
+  bool guest = 1;
+  string address_id = 2;
+  repeated string contact_point_ids = 3;
+}

package/io/restorecommerce/filter.proto

@@ -0,0 +1,38 @@
+syntax = "proto3";
+
+package io.restorecommerce.filter;
+
+message Filter {
+  string field = 1;
+  enum Operation {
+    eq = 0;
+    lt = 1;
+    lte = 2;
+    gt = 3;
+    gte = 4;
+    isEmpty = 5;
+    iLike = 6;
+    in = 7;
+    neq = 8;
+  }
+  Operation operation = 2;
+  string value = 3;
+  enum ValueType {
+    STRING = 0; // default value type if not specified
+    NUMBER = 1;
+    BOOLEAN = 2;
+    DATE = 3;
+    ARRAY = 4;
+  }
+  ValueType type = 4;
+  repeated FilterOp filters = 6;
+}
+
+message FilterOp {
+  repeated Filter filter = 1;
+  enum Operator {
+    and = 0;
+    or = 1;
+  }
+  Operator operator = 2;
+}

package/io/restorecommerce/fulfillment.proto

@@ -0,0 +1,199 @@
+syntax = "proto3";
+
+package io.restorecommerce.fulfillment;
+
+import "google/protobuf/any.proto";
+import "io/restorecommerce/resource_base.proto";
+import "io/restorecommerce/auth.proto";
+import "io/restorecommerce/status.proto";
+import "io/restorecommerce/fulfillment_courier";
+import "io/restorecommerce/fulfillment_product";
+import "io/restorecommerce/attribute";
+
+/**
+Microservice definition.
+*/
+service Service {
+  /**
+  Returns a list of shipment IDs.
+  */
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (FulfillmentResponseList);
+
+  /**
+  Creates but does not execute fulfillment orders
+  */
+  rpc Create (FulfillmentRequest) returns (FulfillmentResponseList);
+
+  /**
+  Updates but does not execute fulfillment orders
+  */
+  rpc Update (FulfillmentRequest) returns (FulfillmentResponseList);
+
+  /**
+  Upserts but does not execute fulfillment orders
+  */
+  rpc Upsert (FulfillmentRequest) returns (FulfillmentResponseList);
+
+  /**
+  Executes and Upserts fulfillment orders
+  */
+  rpc Order (FulfillmentRequest) returns (FulfillmentResponseList);
+
+  /**
+  Track a batch of fulfillment orders
+  */
+  rpc Track (TrackingRequest) returns (TrackingResults);
+
+  /**
+  Cancel a batch of fulfillment orders
+  */
+  rpc Cancel (CancelRequest) returns (CancelResults);
+
+  /**
+  Delete a batch of fulfillments from the database
+  */
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+}
+
+enum AddressType {
+  Standard = 0;
+  DHL_Packstation = 1;
+  DHL_Postfiliale = 2;
+  //UPS_Whatever
+}
+
+enum LabelTypes {
+  Default = 0;
+  URL = 1;
+  PDF = 2;
+  Image = 3;
+}
+
+enum State {
+  Incomplete = 0;
+  Ordered = 1;
+  Processing = 2;
+  Done=3;
+  Cancelled = 4;
+  Failed = 5;
+}
+
+message Origin {
+  string country = 1;
+  string iso_code = 2;
+}
+
+message Contact {
+  string name = 1;
+  string email = 2;
+  string phone = 3;
+}
+
+message Address {
+  AddressType address_type = 1;
+  repeated string name = 2;
+  string street = 3;
+  string number = 4;
+  string addition = 5;
+  string zip = 6;
+  string city = 7;
+  Origin origin = 8;
+  Contact contact = 9;
+  google.protobuf.Any optionals = 10;
+}
+
+message Parcel {
+  float weight = 1;
+  float width = 2;
+  float length = 3;
+  float height = 4;
+}
+
+message Order {
+  string uks_id = 1; //id from external services for reference
+  repeated Parcel parcels = 4;
+  Address sender = 6;
+  Address receiver = 7;
+  string notify = 8;
+  google.protobuf.Any options = 9;
+}
+
+message Label {
+  LabelType type = 1;
+  string data = 2; //Could be an URL, base64 or bytes of i.e. a PDF or PNG...
+}
+
+message Event {
+  io.restorecommerce.status.Status status = 1;
+  string timestamp = 2;
+  string location = 3;
+  google.protobuf.Any details = 4;
+}
+
+message FulfillmentOrder {
+  string id = 1;
+  string product_id = 3;
+  Order order = 2;
+  io.restorecommerce.meta.Meta meta = 3;
+}
+
+message FulfillmentOrderList {
+  repeated FulfillmentOrder items = 1;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+/**
+This is the message how it get stored to the database
+*/
+message Fulfillment {
+  string id = 1;
+  string product_id = 2;
+  Order order = 3;
+  io.restorecommerce.meta.Meta meta = 4;
+  string shipment_id = 5; //filled on Order
+  Label label = 6; //filled on Order
+  State state = 7; //update by Track
+}
+
+message FulfillmentResponse {
+  Fulfillment payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+message FulfillmentResponseList {
+  repeated Fulfillment items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message TrackingQuery {
+  string order_id = 1;
+  google.protobuf.Any options = 4;
+}
+
+message TrackingQueryList {
+  repeated TrackingQuery items = 1;
+  io.restorecommerce.auth.Subject subject = 2;
+}
+
+message Tracking {
+  string fulfillment_id = 1;
+  repeated Event events = 2;
+  google.protobuf.Any details = 3;
+  io.restorecommerce.status.Status status = 4;
+}
+
+message TrackingResults {
+  repeated Tracking items = 1;
+  io.restorecommerce.status.OperationStatus operation_status = 2;
+}
+
+message CancelRequest {
+  repeated string ids = 1;
+  io.restorecommerce.auth.Subject subject = 2;
+}
+
+message CancelResults {
+  repeated io.restorecommerce.status.Status items = 1;
+  io.restorecommerce.status.OperationStatus operation_status = 2;
+}

package/io/restorecommerce/fulfillment_courier.proto

@@ -0,0 +1,54 @@
+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 (CourierResponseList);
+  rpc Create (CourierList) returns (CourierResponseList);
+  rpc Update (CourierList) returns (CourierResponseList);
+  rpc Upsert (CourierList) returns (CourierResponseList);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+}
+
+enum CourierType {
+  DHL = 0;
+}
+
+message Courier {
+  string id = 1;
+  string uks_id = 2;
+  CourierType type = 3;
+  string name = 4;
+  string description = 5;
+  string logo = 6;
+  string website = 7;
+  google.protobuf.Any optionals = 8;
+  io.restorecommerce.meta.Meta meta = 9;
+}
+
+message CourierList  {
+  repeated Courier items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message CourierResponse  {
+  Courier payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+message CourierResponseList  {
+  repeated CourierResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}