@restorecommerce/protos 2.0.2 → 3.0.1

package/io/restorecommerce/order.proto

@@ -8,55 +8,52 @@ import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
 import "io/restorecommerce/options.proto";
 import "io/restorecommerce/address.proto";
+import "io/restorecommerce/tax.proto";
+import "io/restorecommerce/country.proto";
 import "io/restorecommerce/fulfillment.proto";
+import "io/restorecommerce/fulfillment_product.proto";
 
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "order";
-
+service OrderService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (OrderListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
   rpc Create (OrderList) returns (OrderListResponse);
   rpc Update (OrderList) returns (OrderListResponse);
   rpc Upsert (OrderList) returns (OrderListResponse);
+  rpc Evaluate (OrderList) returns (OrderListResponse);
   rpc Submit (OrderList) returns (OrderListResponse);
-  rpc Cancel (CancelRequestList) returns (OrderListResponse);
+  rpc Withdraw (OrderIdList) returns (OrderListResponse);
+  rpc Cancel (OrderIdList) returns (OrderListResponse);
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
-  rpc TriggerFulfillment (TriggerFulfillmentRequestList) returns (io.restorecommerce.status.Status);
+  
+  // Requires Fulfillment Service
+  rpc QueryPackingSolution (FulfillmentRequestList) returns (io.restorecommerce.fulfillment_product.PackingSolutionListResponse);
+  // Requires Fulfillment Service
+  rpc CreateFulfillment (FulfillmentRequestList) returns (io.restorecommerce.fulfillment.FulfillmentListResponse);
+  // Requires Fulfillment Service
+  rpc TriggerFulfillment (FulfillmentRequestList) returns (io.restorecommerce.status.StatusListResponse);
 }
 
-enum State {
-  Undefined = 0;
-  Invalid = 1;
-  Failed = 2;
-  Cancelled = 3;
-  Created = 4;
-  Submitted = 5;
-  Shipping = 6;
-  Done = 7;
+enum OrderState {
+  Created = 0;
+  Submitted = 1;
+  Confirmed = 2;
+  Invalid = 3;
+  Shipping = 4;
+  Failed = 5;
+  Done = 6;
+  Withdrawn = 7;
+  Cancelled = 8;
 }
 
-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;
-  double quantity_price = 11;
-  string item_type = 12;
-  double taric_code = 13;
-  string stock_keeping_unit = 14;
-  double weight_in_kg = 15;
-  int32 length_in_cm = 16;
-  int32 width_in_cm = 17;
-  int32 height_in_cm = 18;
+message OrderItem {
+  optional string product_id = 1;
+  optional string variant_id = 2;
+  optional int32 quantity = 3;
+  optional double unit_price = 4; //Set by service
+  optional double price = 5; //Set by service
+  repeated io.restorecommerce.tax.VAT vats = 6; //Set by service
 }
 
 /**
@@ -71,45 +68,28 @@ message Order {
     deleted: "orderDeleted"
   };
 
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string name = 3;
-  string description = 4;
-  State state = 5;
-  string customer_reference = 6;
-  repeated Item items = 7;
-  double total_price = 8;
-  io.restorecommerce.address.Address shipping_address = 11;
-  io.restorecommerce.address.Address billing_address = 13;
-  string billing_email = 14;
-  io.restorecommerce.address.ContactPerson contact_person = 15;
-  string notification_email = 16;
-  repeated string fulfillment_ids = 17;
-}
-
-message ShippingDetails {
-  string export_type = 1;
-  string export_description = 2;
-  string invoice_number = 3;
-  io.restorecommerce.address.Address sender_address = 5;
-  io.restorecommerce.address.ContactPerson contact_person = 15;
-}
-
-message TriggerFulfillmentRequest {
-  Order order = 1;
-  ShippingDetails shipping_details = 2;
-  repeated io.restorecommerce.fulfillment.Parcel parcels = 3;
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional OrderState state = 3;
+  optional string customer_reference = 4;
+  repeated OrderItem items = 5;
+  optional double total_price = 6; //Set by service
+  optional double total_vat = 7; //Set by service
+  optional io.restorecommerce.address.ShippingAddress shipping_address = 8;
+  optional io.restorecommerce.address.ShippingAddress billing_address = 9;
+  optional string billing_email = 10;
+  optional string notification_email = 11;
+  optional io.restorecommerce.fulfillment_product.Preferences packing_preferences = 12;
 }
 
-message TriggerFulfillmentRequestList {
-  repeated TriggerFulfillmentRequest items = 1;
-  uint32 total_count = 2;
-  io.restorecommerce.auth.Subject subject = 3;
+message OrderIdList {
+  repeated string ids = 1;
+  io.restorecommerce.auth.Subject subject = 2;
 }
 
 message OrderList {
   repeated Order items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -124,11 +104,24 @@ message OrderResponse {
   io.restorecommerce.status.Status status = 2;
 }
 
-message CancelRequestList {
-  repeated string ids = 1;
-  io.restorecommerce.auth.Subject subject = 2;
-}
-
 message Deleted {
   string id = 1;
+}
+
+message ShippingDetails {
+  optional string export_type = 1;
+  optional string export_description = 2;
+  optional string invoice_number = 3;
+  optional io.restorecommerce.address.ShippingAddress sender_address = 4;
+}
+
+message FulfillmentRequest {
+  optional string reference_id = 1;
+  optional ShippingDetails shipping_details = 2;
+}
+
+message FulfillmentRequestList {
+  repeated FulfillmentRequest items = 1;
+  optional uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
 }

package/io/restorecommerce/organization.proto

@@ -13,9 +13,7 @@ import "io/restorecommerce/options.proto";
 import "io/restorecommerce/address.proto";
 import "io/restorecommerce/contact_point.proto";
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "organization";
-
+service OrganizationService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (OrganizationListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
@@ -37,7 +35,7 @@ message DeleteOrgData {
 
 message OrganizationList {
   repeated Organization items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -53,9 +51,9 @@ message OrganizationResponse {
 }
 
 message Organization {
-  string id = 1; /// Organization ID, unique, key
-  io.restorecommerce.meta.Meta meta = 2;
-  string address_id = 3 [
+  optional string id = 1; /// Organization ID, unique, key
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string address_id = 3 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.address.Address",
       target_service: "resource",
@@ -64,7 +62,7 @@ message Organization {
       field_name: "address",
     }
   ]; /// Address for the organization
-  string parent_id = 4 [
+  optional string parent_id = 4 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.organization.Organization",
       target_service: "resource",
@@ -82,14 +80,14 @@ message Organization {
       field_name: "contactPoints",
     }
   ]; // 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;
+  optional string website = 7;
+  optional string email = 8;
+  optional string logo = 9; // base64; arangoDB does not support blob storage
+  optional string vat_id = 10;
+  optional string isic_v4 = 11;
+  optional string registration = 12;
+  optional string registration_court = 13;
+  optional string name = 14;
   repeated string payment_method_ids = 15;
-  google.protobuf.Any data = 16; /// additional data
+  optional google.protobuf.Any data = 16; /// additional data
 }

package/io/restorecommerce/ostorage.proto

@@ -11,9 +11,7 @@ import "io/restorecommerce/status.proto";
 import "io/restorecommerce/resource_base.proto";
 import "io/restorecommerce/options.proto";
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "object";
-
+service ObjectService {
   rpc Get (GetRequest) returns (stream ObjectResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
@@ -32,7 +30,7 @@ message CopyRequestList {
 }
 
 message CopyResponseList {
-  repeated copyResponsePayloadWithStatus response = 1;
+  repeated copyResponsePayloadWithStatus responses = 1;
   io.restorecommerce.status.OperationStatus operation_status = 2;
 }
 
@@ -45,8 +43,8 @@ message CopyRequestItem {
   string bucket = 1;
   string copySource = 2;
   string key = 3;
-  io.restorecommerce.meta.Meta meta = 4;
-  Options options = 5;
+  optional io.restorecommerce.meta.Meta meta = 4;
+  optional Options options = 5;
 }
 
 message CopyResponseItem {
@@ -58,24 +56,24 @@ message CopyResponseItem {
 }
 
 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;
+  optional string encoding = 1;
+  optional string content_type = 2;
+  optional string content_language = 3;
+  optional string content_disposition = 4;
+  optional int32 length = 5;
+  optional string version = 6;
+  optional string md5 = 7;
   repeated io.restorecommerce.attribute.Attribute tags = 8;
-  google.protobuf.Any data = 9; // optional meta data ex: from and to dates
+  optional 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;
+  optional bytes object = 3;
+  optional io.restorecommerce.meta.Meta meta = 4;
+  optional string url = 5;
+  optional Options options = 6;
   io.restorecommerce.auth.Subject subject = 7;
 }
 
@@ -101,12 +99,12 @@ message ObjectResponsePayload {
 message GetRequest {
   string key = 1;
   string bucket = 2;
-  bool download = 3;
+  optional bool download = 3;
   io.restorecommerce.auth.Subject subject = 4;
 }
 
 message ListResponse {
-  repeated ObjectsDataWithPayloadStatus response = 1;
+  repeated ObjectsDataWithPayloadStatus responses = 1;
   io.restorecommerce.status.OperationStatus operation_status = 2;
 }
 
@@ -148,19 +146,19 @@ message Response {
 
 message ListRequest {
   string bucket = 1;
-  io.restorecommerce.filter.FilterOp filters = 2; /// Filter based on fieldName|operation, value|list
+  optional io.restorecommerce.filter.FilterOp filters = 2; /// Filter based on fieldName|operation, value|list
   io.restorecommerce.auth.Subject subject = 3;
-  int32 max_keys = 4;
-  string prefix = 5;
+  optional int32 max_keys = 4;
+  optional string prefix = 5;
 }
 
 // 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;
+  optional string key = 1;
+  optional string bucket = 2;
+  optional google.protobuf.Any metadata = 3;
+  optional io.restorecommerce.auth.Subject subject = 4;
 }
 
 message MoveRequestList {
@@ -169,15 +167,15 @@ message MoveRequestList {
 }
 
 message MoveRequestItem {
-  string bucket = 1; // destination bucket name
-  string sourceObject = 2; // source object with bucket name
-  string key = 3; // destination key name
-  io.restorecommerce.meta.Meta meta = 4;
-  Options options = 5;
+  optional string bucket = 1; // destination bucket name
+  optional string sourceObject = 2; // source object with bucket name
+  optional string key = 3; // destination key name
+  optional io.restorecommerce.meta.Meta meta = 4;
+  optional Options options = 5;
 }
 
 message MoveResponseList {
-  repeated MoveResponsePayloadWithStatus response = 1;
+  repeated MoveResponsePayloadWithStatus responses = 1;
   io.restorecommerce.status.OperationStatus operation_status = 2;
 }
 

package/io/restorecommerce/payment.proto

@@ -4,9 +4,7 @@ import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
 import "io/restorecommerce/options.proto";
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "payment";
-
+service PaymentService {
   // Wrapper for setup_authorization in ActiveMerchant
   rpc SetupAuthorization (SetupRequest) returns (SetupResponse);
 
@@ -25,18 +23,18 @@ service Service {
 
 // Request object for setup calls
 message SetupRequest {
-  string ip = 1;
+  optional 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;
+  optional int32 subtotal = 3;
+  optional int32 shipping = 4;
+  optional int32 handling = 5;
+  optional int32 tax = 6;
+  optional string currency = 7;
+  optional string return_url = 8;
+  optional string cancel_return_url = 9;
+  optional bool allow_guest_checkout = 10;
+  optional Provider provider = 11;
+  optional io.restorecommerce.auth.Subject subject = 12;
 }
 
 message SetupPayload {
@@ -58,21 +56,21 @@ message SetupResponse {
 
 // 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;
+  optional Provider provider = 1;
+  optional int32 payment_sum = 2;
+  optional string currency = 3;
+  optional string payment_id = 4;
+  optional string payer_id = 5;
+  optional 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;
+  optional Provider provider = 1;
+  optional int32 payment_sum = 2;
+  optional string currency = 3;
+  optional string payment_id = 4;
   io.restorecommerce.auth.Subject subject = 5;
 }
 
@@ -95,20 +93,20 @@ message PaymentResponse {
 
 // 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;
+  optional string primary_number = 1;
+  optional string first_name = 2;
+  optional string last_name = 3;
+  optional string month = 4;
+  optional int32 year = 5;
+  optional 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;
+  optional string name = 1;
+  optional string description = 2;
+  optional int32 quantity = 3;
+  optional int32 amount = 4;
 }
 
 // Possible service providers. Provider names must be exactly as in config.yml.

package/io/restorecommerce/payment_method.proto

@@ -11,7 +11,7 @@ import "io/restorecommerce/status.proto";
 /*
 * Microservice definition.
 */
-service Service {
+service PaymentMethodService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (PaymentMethodListResponse);
   rpc Create (PaymentMethodList) returns (PaymentMethodListResponse);
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
@@ -25,7 +25,7 @@ message Deleted {
 
 message PaymentMethodList {
   repeated PaymentMethod items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -52,9 +52,9 @@ enum TransferTypeEnum {
 }
 
 message PaymentMethod {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  PaymentMethodEnum payment_method = 3;
-  TransferTypeEnum transfer_type = 4;
-  google.protobuf.Any data = 5;
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional PaymentMethodEnum payment_method = 3;
+  optional TransferTypeEnum transfer_type = 4;
+  optional google.protobuf.Any data = 5;
 }

package/io/restorecommerce/policy.proto

@@ -13,30 +13,30 @@ import "io/restorecommerce/options.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;
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string name = 3;
+  optional 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;
+  optional io.restorecommerce.rule.Target target = 6;  // general policy target
+  optional io.restorecommerce.rule.Effect effect = 7;
+  optional string combining_algorithm = 8;
+  optional bool evaluation_cacheable = 9;
 }
 
 message PolicyRQ {
-  string id = 1;
-  io.restorecommerce.rule.Target target = 2;
-  string combining_algorithm = 3;
+  optional string id = 1;
+  optional io.restorecommerce.rule.Target target = 2;
+  optional 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;
+  optional io.restorecommerce.rule.Effect effect = 5;
+  optional bool has_rules = 6;
+  optional bool evaluation_cacheable = 7;
 }
 
 message PolicyList {
   repeated Policy items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -51,9 +51,7 @@ message PolicyResponse {
   io.restorecommerce.status.Status status = 2;
 }
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "policy";
-
+service PolicyService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (PolicyListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };

package/io/restorecommerce/policy_set.proto

@@ -11,18 +11,18 @@ import "io/restorecommerce/status.proto";
 import "io/restorecommerce/options.proto";
 
 message PolicySet {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string name = 3;
-  string description = 4;
-  io.restorecommerce.rule.Target target = 5;
-  string combining_algorithm = 6;
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string name = 3;
+  optional string description = 4;
+  optional io.restorecommerce.rule.Target target = 5;
+  optional string combining_algorithm = 6;
   repeated string policies = 7; // policy IDs
 }
 
 message PolicySetList {
   repeated PolicySet items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -38,16 +38,14 @@ message PolicySetResponse {
 }
 
 message PolicySetRQ {
-  string id = 1;
-  io.restorecommerce.rule.Target target = 2;
-  string combining_algorithm = 3;
+  optional string id = 1;
+  optional io.restorecommerce.rule.Target target = 2;
+  optional string combining_algorithm = 3;
   repeated io.restorecommerce.policy.PolicyRQ policies = 4;
-  io.restorecommerce.rule.Effect effect = 5;
+  optional io.restorecommerce.rule.Effect effect = 5;
 }
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "policy_set";
-
+service PolicySetService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (PolicySetListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };

package/io/restorecommerce/price_group.proto

@@ -10,15 +10,15 @@ import "io/restorecommerce/options.proto";
 
 // PriceGroup resource
 message PriceGroup {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string name = 3;
-  string description = 4;
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string name = 3;
+  optional string description = 4;
 }
 
 message PriceGroupList {
   repeated PriceGroup items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -37,9 +37,7 @@ message Deleted {
   string id = 1;
 }
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "price_group";
-
+service PriceGroupService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (PriceGroupListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };