@restorecommerce/protos 0.4.5

package/io/restorecommerce/notification_channel.proto

@@ -0,0 +1,50 @@
+syntax = "proto3";
+
+package io.restorecommerce.notification_channel;
+
+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 Channel
+service Service {
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (NotificationChannelListResponse);
+  rpc Create (NotificationChannelList) returns (NotificationChannelListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc Update (NotificationChannelList) returns (NotificationChannelListResponse);
+  rpc Upsert (NotificationChannelList) returns (NotificationChannelListResponse);
+}
+
+message Deleted {
+  string id = 1;
+}
+
+message NotificationChannelList {
+  repeated NotificationChannel items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message NotificationChannelListResponse {
+  repeated NotificationChannelResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message NotificationChannelResponse {
+  NotificationChannel items = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+message NotificationChannel {
+  string id = 1;
+  io.restorecommerce.meta.Meta meta = 2;
+  string name = 3;
+  string description = 4;
+  oneof configuration_type {
+    string email = 5;
+    string sms = 6;
+    string webhook = 7;
+  }
+}

package/io/restorecommerce/notification_req.proto

@@ -0,0 +1,49 @@
+syntax = "proto3";
+
+package io.restorecommerce.notification_req;
+
+import "io/restorecommerce/status.proto";
+
+service Service {
+  // direct notifications
+  rpc Send (NotificationReq) returns (io.restorecommerce.status.OperationStatusObj); /// generic fallback
+}
+
+// mimics nodemailer properties for easy configuration
+message Attachment {
+  string filename = 1;
+
+  // the "content" may be on of the following:
+  string text = 2; // for textual data
+  bytes buffer = 3; // for binary data, eg.: images
+
+  string path = 4;
+  string content_type = 5;
+  string content_disposition = 6;
+  string cid = 7;
+  string encoding = 8;
+}
+
+// sendEmail NotificationReq event
+message NotificationReq {
+  oneof channel {
+    Email email = 1;
+    Log log = 2;
+  }
+  string subject = 3;
+  string body = 4;  // text/HTML content
+  string transport = 5; /// 'email', 'log', ... default == 'log'
+  string provider = 6; /// specific transport provider, eg: 'console' for transport == 'log'
+  repeated Attachment attachments = 7;
+}
+
+message Email {
+  repeated string to = 1; // array of to email list
+  repeated string cc = 2 ;// array of cc email list
+  repeated string bcc = 3;  // array of bcc email list
+  string replyto = 4; // if set, the outgoing mail will have this replyTo header set
+}
+
+message Log {
+  string level = 1;
+}

package/io/restorecommerce/order.proto

@@ -0,0 +1,121 @@
+syntax = "proto3";
+
+package io.restorecommerce.order;
+
+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 (OrderListResponse);
+  rpc Create (OrderList) returns (OrderListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc Update (OrderList) returns (OrderListResponse);
+  rpc Upsert (OrderList) returns (OrderListResponse);
+  rpc TriggerFulfillment (OrderDataList) returns (FulfillmentResults);
+}
+
+
+message OrderList {
+  repeated Order items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message OrderListResponse {
+  repeated OrderResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message OrderResponse {
+  Order payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+message Order {
+  string id = 1;
+  io.restorecommerce.meta.Meta meta = 2;
+  string name = 3;
+  string description = 4;
+  string status = 5;
+  repeated Items items = 6;
+  // sum of all the quantity_price will be total_price
+  double total_price = 7;
+  // shipping address
+  string shipping_contact_point_id = 8;
+  string billing_contact_point_id = 9;
+  double total_weight_in_kg = 10;
+}
+
+message Items {
+  double quantity_price = 1;
+  Item item = 2;
+}
+
+message Item {
+  // below identifier is id of product, variant or bundle
+  string product_variant_bundle_id = 1;
+  string product_name = 2;
+  string product_description = 3;
+  string manufacturer_name = 4;
+  string manufacturer_description = 5;
+  string prototype_name = 6;
+  string prototype_description = 7;
+  int32 quantity = 8;
+  int32 vat = 9;
+  double price = 10;
+  string item_type = 11;
+  double taric_code = 12;
+  string stock_keeping_unit = 13;
+  double weight_in_kg = 14;
+  int32 length_in_cm = 15;
+  int32 width_in_cm = 16;
+  int32 height_in_cm = 17;
+}
+
+message Deleted {
+  string id = 1;
+}
+
+message OrderDataList {
+  repeated OrderData order_data = 1;
+  io.restorecommerce.meta.Meta meta = 2;
+}
+
+message OrderData {
+  string order_id = 1;
+  repeated Shipments shipments = 2;
+}
+
+message Shipments {
+  double total_weight_in_kg = 1;
+  // below properties are used for international packaging
+  double individual_weight_in_kg = 2; // each items weight
+  int32 amount = 3; // number of items
+  string export_type = 4;
+  string export_description = 5;
+  string customs_tariff_number = 6;
+  string invoice_number = 7;
+  double customs_value = 8;
+}
+
+message FulfillmentResults {
+  repeated ResponseDetailsList fulfillmentResults =1;
+}
+
+message ResponseDetailsList {
+  OrderStatus Status = 1;
+  ErrorList error = 2;
+}
+
+message OrderStatus {
+  string OrderId = 1;
+  string OrderStatus =2;
+}
+
+message ErrorList {
+  repeated string code = 1;
+  repeated string message = 2;
+}

package/io/restorecommerce/organization.proto

@@ -0,0 +1,63 @@
+syntax = "proto3";
+
+package io.restorecommerce.organization;
+
+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";
+
+service Service {
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (OrganizationListResponse);
+  rpc Create (OrganizationList) returns (OrganizationListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc Update (OrganizationList) returns (OrganizationListResponse);
+  rpc Upsert (OrganizationList) returns (OrganizationListResponse);
+}
+
+message Deleted {
+  string id = 1;
+}
+
+message DeleteOrgData {
+  repeated string org_ids = 1;
+  repeated string user_ids = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message OrganizationList {
+  repeated Organization items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message OrganizationListResponse {
+  repeated OrganizationResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message OrganizationResponse {
+  Organization payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+message Organization {
+  string id = 1; /// Organization ID, unique, key
+  io.restorecommerce.meta.Meta meta = 2;
+  string address_id = 3; /// Address for the organization
+  string parent_id = 4; //  Hierarchically superior organization; may be null
+  repeated string children_ids = 5; // Hierarchically inferior organizations; may be null/empty
+  repeated string contact_point_ids = 6; // list of possible legal addresses of different types
+  string website = 7;
+  string email = 8;
+  string logo = 9; // base64; arangoDB does not support blob storage
+  string vat_id = 10;
+  string isic_v4 = 11;
+  string registration = 12;
+  string registration_court = 13;
+  string name = 14;
+  repeated string payment_method_ids = 15;
+  google.protobuf.Any data = 16; /// additional data
+}

package/io/restorecommerce/ostorage.proto

@@ -0,0 +1,154 @@
+syntax = "proto3";
+
+package io.restorecommerce.ostorage;
+
+import "io/restorecommerce/filter.proto";
+import "google/protobuf/any.proto";
+import "io/restorecommerce/meta.proto";
+import "io/restorecommerce/auth.proto";
+import "io/restorecommerce/attribute.proto";
+import "io/restorecommerce/status.proto";
+import "io/restorecommerce/resource_base.proto";
+
+service Service {
+  rpc Get (GetRequest) returns (stream ObjectResponse);
+  rpc Put (stream Object) returns (PutResponse);
+  rpc Delete (DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc List (ListRequest) returns (ListResponse);
+  rpc Copy (CopyRequest) returns (CopyResponse);
+}
+
+message CopyRequest {
+  repeated CopyRequestItem items = 1;
+  io.restorecommerce.auth.Subject subject = 2;
+}
+
+message CopyResponse {
+  repeated copyResponsePayloadWithStatus response = 1;
+  io.restorecommerce.status.OperationStatus operation_status = 2;
+}
+
+message copyResponsePayloadWithStatus {
+  CopyResponseItem payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+message CopyRequestItem {
+  string bucket = 1;
+  string copySource = 2;
+  string key = 3;
+  io.restorecommerce.meta.Meta meta = 4;
+  Options options = 5;
+}
+
+message CopyResponseItem {
+  string bucket = 1;
+  string copySource = 2;
+  string key = 3;
+  io.restorecommerce.meta.Meta meta = 4;
+  Options options = 5;
+}
+
+message Options {
+  string encoding = 1;
+  string content_type = 2;
+  string content_language = 3;
+  string content_disposition = 4;
+  int32 length = 5;
+  string version = 6;
+  string md5 = 7;
+  repeated io.restorecommerce.attribute.Attribute tags = 8;
+  google.protobuf.Any data = 9; // optional meta data ex: from and to dates
+}
+
+message Object {
+  string key = 1;
+  string bucket = 2;
+  bytes object = 3;
+  io.restorecommerce.meta.Meta meta = 4;
+  string url = 5;
+  Options options = 6;
+  io.restorecommerce.auth.Subject subject = 7;
+}
+
+message ObjectResponse {
+  ObjectResponsePayloadWithStatus response = 1;
+  io.restorecommerce.status.OperationStatus operation_status = 2;
+}
+
+message ObjectResponsePayloadWithStatus {
+  ObjectResponsePayload payload = 1;
+  io.restorecommerce.status.Status status = 3;
+}
+
+message ObjectResponsePayload {
+  string key = 1;
+  string bucket = 2;
+  bytes object = 3;
+  io.restorecommerce.meta.Meta meta = 4;
+  string url = 5;
+  Options options = 6;
+}
+
+message GetRequest {
+  string key = 1;
+  string bucket = 2;
+  bool download = 3;
+  io.restorecommerce.auth.Subject subject = 4;
+}
+
+message ListResponse {
+  repeated ObjectsDataWithPayloadStatus response = 1;
+  io.restorecommerce.status.OperationStatus operation_status = 2;
+}
+
+message ObjectsDataWithPayloadStatus {
+ ObjectData payload = 1;
+ io.restorecommerce.status.Status status = 2;
+}
+
+message ObjectData {
+  string object_name = 1;
+  string url = 2;
+  io.restorecommerce.meta.Meta meta = 3;
+}
+
+message DeleteRequest {
+  string key = 1;
+  string bucket = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message PutResponse {
+  PutResponseWithPayloadStatus response = 1;
+  io.restorecommerce.status.OperationStatus operation_status = 2;
+}
+
+message PutResponseWithPayloadStatus {
+  Response payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+message Response {
+  string url = 1;
+  string bucket = 2 ;
+  string key = 3;
+  io.restorecommerce.meta.Meta meta = 4;
+  repeated io.restorecommerce.attribute.Attribute tags = 5;
+  int32 length = 6; // file size of uploaded object
+}
+
+message ListRequest {
+  string bucket = 1;
+  io.restorecommerce.filter.FilterOp filters = 2; /// Filter based on fieldName|operation, value|list
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+// OstorageMessage is used for emitting
+// objectUploaded and objectDownloaded events
+message OstorageMessage {
+  string key = 1;
+  string bucket = 2;
+  google.protobuf.Any metadata = 3;
+  io.restorecommerce.auth.Subject subject = 4;
+}

package/io/restorecommerce/payment.proto

@@ -0,0 +1,115 @@
+syntax = "proto3";
+package io.restorecommerce.payment;
+import "google/protobuf/wrappers.proto";
+import "io/restorecommerce/auth.proto";
+ 
+service Service {
+  // Wrapper for setup_authorization in ActiveMerchant
+  rpc SetupAuthorization (SetupRequest) returns (SetupResponse);
+
+  // Wrapper for setup_purchase in ActiveMerchant
+  rpc SetupPurchase (SetupRequest) returns (SetupResponse);
+
+  // Gets payment details by token or transaction. Only supported by PayPal Express Checkout.
+  rpc Authorize (PaymentRequest) returns (PaymentResponse);
+
+  // Gets payment details by token or transaction. Only supported by PayPal Express Checkout.
+  rpc Purchase (PaymentRequest) returns (PaymentResponse);
+
+  // Can capture both cardless and standard authorization.
+  rpc Capture (CaptureRequest) returns (PaymentResponse);
+}
+
+// Request object for setup calls
+message SetupRequest {
+  string ip = 1;
+  repeated Item items = 2;
+  int32 subtotal = 3;
+  int32 shipping = 4;
+  int32 handling = 5;
+  int32 tax = 6;
+  string currency = 7;
+  string return_url = 8;
+  string cancel_return_url = 9;
+  bool allow_guest_checkout = 10;
+  Provider provider = 11;
+  io.restorecommerce.auth.Subject subject = 12;
+}
+
+// Response object for setup calls.
+message SetupResponse {
+  repeated PaymentError payment_errors = 1;
+  string token = 2;
+  string confirm_initiation_url = 3;
+  string initiated_on = 4;
+}
+
+// Request object for authorization or purchase call for cardless payment.
+message PaymentRequest {
+  Provider provider = 1;
+  int32 payment_sum = 2;
+  string currency = 3;
+  string payment_id = 4;
+  string payer_id = 5;
+  string token = 6;
+  io.restorecommerce.auth.Subject subject = 7;
+}
+
+// Request object for capture call for both standard and cardless payments.
+message CaptureRequest {
+  Provider provider = 1;
+  int32 payment_sum = 2;
+  string currency = 3;
+  string payment_id = 4;
+  io.restorecommerce.auth.Subject subject = 5;
+}
+
+// Unified response object for authorization, purchase and capture calls
+// for both standard and cardless payments.
+message PaymentResponse {
+  repeated PaymentError payment_errors = 1;
+  string payment_id = 2;
+  string executed_on = 3;
+}
+
+// Used for building ActiveMerchant::Billing::CreditCard instance.
+message PaymentCard {
+  string primary_number = 1;
+  string first_name = 2;
+  string last_name = 3;
+  string month = 4;
+  int32 year = 5;
+  string verification_value = 6;
+}
+
+// Represents purchased item. Not all providers support this.
+message Item {
+  string name = 1;
+  string description = 2;
+  int32 quantity = 3;
+  int32 amount = 4;
+}
+
+// Error details.
+message PaymentError {
+  bool killed = 1;
+  int32 code = 2;
+  google.protobuf.StringValue signal = 3;
+  string cmd = 4;
+  string stdout = 5;
+  string stderr = 6;
+}
+
+// Possible service providers. Provider names must be exactly as in config.yml.
+enum Provider {
+  NO_PROVIDER = 0;
+  PaypalExpressGateway = 1;
+  AuthorizeNetGateway = 2;
+}
+
+// Possible payment identifiers.
+enum PaymentIdType {
+  NO_IDENTIFIER_TYPE = 0;
+  TOKEN = 1;
+  TRANSACTION_ID = 2;
+}

package/io/restorecommerce/payment_method.proto

@@ -0,0 +1,60 @@
+syntax = "proto3";
+
+package io.restorecommerce.payment_method;
+
+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 (PaymentMethodListResponse);
+  rpc Create (PaymentMethodList) returns (PaymentMethodListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc Update (PaymentMethodList) returns (PaymentMethodListResponse);
+  rpc Upsert (PaymentMethodList) returns (PaymentMethodListResponse);
+}
+
+message Deleted {
+  string id = 1;
+}
+
+message PaymentMethodList {
+  repeated PaymentMethod items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message PaymentMethodListResponse {
+  repeated PaymentMethodResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message PaymentMethodResponse {
+  PaymentMethod payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+enum PaymentMethodEnum {
+  WIRE_TRANSFER = 0;
+  DIRECT_DEBIT = 1;
+  PAYPAL = 2;
+}
+enum TransferTypeEnum {
+  RECEIVE = 0;
+  SEND = 1;
+  BOTH = 2;
+}
+
+message PaymentMethod {
+  string id = 1;
+  io.restorecommerce.meta.Meta meta = 2;
+  PaymentMethodEnum payment_method = 3;
+  TransferTypeEnum transfer_type = 4;
+  google.protobuf.Any data = 5;
+}

package/io/restorecommerce/policy.proto

@@ -0,0 +1,59 @@
+syntax = "proto3";
+
+package io.restorecommerce.policy;
+
+import "io/restorecommerce/resource_base.proto";
+import "io/restorecommerce/meta.proto";
+import "io/restorecommerce/rule.proto";
+import "io/restorecommerce/auth.proto";
+import "io/restorecommerce/status.proto";
+
+/**
+* A Policy is defined by a set of Rules.
+*/
+message Policy {
+  string id = 1;
+  io.restorecommerce.meta.Meta meta = 2;
+  string name = 3;
+  string description = 4;
+  repeated string rules = 5;  // rule IDs
+  io.restorecommerce.rule.Target target = 6;  // general policy target
+  io.restorecommerce.rule.Effect effect = 7;
+  string combining_algorithm = 8;
+  bool evaluation_cacheable = 9;
+}
+
+message PolicyRQ {
+  string id = 1;
+  io.restorecommerce.rule.Target target = 2;
+  string combining_algorithm = 3;
+  repeated io.restorecommerce.rule.RuleRQ rules = 4;
+  io.restorecommerce.rule.Effect effect = 5;
+  bool has_rules = 6;
+  bool evaluation_cacheable = 7;
+}
+
+message PolicyList {
+  repeated Policy items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message PolicyListResponse {
+  repeated PolicyResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message PolicyResponse {
+  Policy payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+service Service {
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (PolicyListResponse);
+  rpc Create (PolicyList) returns (PolicyListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc Update (PolicyList) returns (PolicyListResponse);
+  rpc Upsert (PolicyList) returns (PolicyListResponse);
+}