@restorecommerce/protos 2.0.2 → 3.0.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,74 +76,74 @@ 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;
 }
 
 /**
 * List of Invoice Positions data
 */
 message InvoicesPositionsData {
-  repeated InvoicePositions invoices_positions_data = 1;
+  repeated InvoicePositions invoice_positions = 1;
 }
 
 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;
-  repeated InvoiceRow tableList = 2;
-  InvoicePrice totalPrice = 3;
+  optional string currency = 1;
+  repeated InvoiceRow invoiceRows = 2;
+  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,31 +146,31 @@ 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;
+  repeated io.restorecommerce.resourcebase.FieldFilter fields = 3;
   io.restorecommerce.auth.Subject subject = 5;
 }
 
 // filter
 message JobFilter {
   repeated string job_ids = 1;
-  string type = 2;
+  optional string type = 2;
 }

package/io/restorecommerce/locale.proto

@@ -11,9 +11,7 @@ import "io/restorecommerce/options.proto";
 /*
 * Microservice definition.
 */
-service Service {
-  option (io.restorecommerce.options.service_name) = "locale";
-
+service LocaleService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (LocaleListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
@@ -29,7 +27,7 @@ message Deleted {
 
 message LocaleList {
   repeated Locale items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -45,8 +43,8 @@ message LocaleResponse {
 }
 
 message Locale {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string value = 3;
-  string description = 4;
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string value = 3;
+  optional string description = 4;
 }

package/io/restorecommerce/location.proto

@@ -16,9 +16,7 @@ import "io/restorecommerce/address.proto";
 /*
 * Microservice definition.
 */
-service Service {
-  option (io.restorecommerce.options.service_name) = "location";
-
+service LocationService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (LocationListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
@@ -34,7 +32,7 @@ message Deleted {
 
 message LocationList {
   repeated Location items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -50,11 +48,11 @@ message LocationResponse {
 }
 
 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 [
+  optional string id = 1; // Location ID, unique, key
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string name = 3; // Location name
+  optional string description = 4;
+  optional string organization_id = 5 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.organization.Organization",
       target_service: "resource",
@@ -63,7 +61,7 @@ message Location {
       field_name: "organization",
     }
   ]; // Organization to which this location is linked
-  string parent_id = 6 [
+  optional string parent_id = 6 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.location.Location",
       target_service: "resource",
@@ -72,7 +70,7 @@ message Location {
       field_name: "parent",
     }
   ];  //  Location which may contain this location; may be null
-  string address_id = 8 [
+  optional string address_id = 8 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.address.Address",
       target_service: "resource",
@@ -81,6 +79,6 @@ message Location {
       field_name: "address",
     }
   ];
-  google.protobuf.Any data = 9; /// additional data
-  string type = 10; // location type
+  optional google.protobuf.Any data = 9; /// additional data
+  optional string type = 10; // location type
 }

package/io/restorecommerce/manufacturer.proto

@@ -10,15 +10,15 @@ import "io/restorecommerce/options.proto";
 
 // Manufacturer resource
 message Manufacturer {
-  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 ManufacturerList {
   repeated Manufacturer 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) = "manufacturer";
-
+service ManufacturerService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (ManufacturerListResponse)  {
     option (io.restorecommerce.options.is_query) = true;
   };

package/io/restorecommerce/meta.proto

@@ -7,9 +7,9 @@ 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;
+    optional double created = 1; // timestamp
+    optional double modified = 2; // timestamp
+    optional string modified_by = 3; // ID from last User who modified it
+    repeated io.restorecommerce.attribute.Attribute owners = 4;
+    repeated io.restorecommerce.attribute.AttributeObj acls = 5;
 }

package/io/restorecommerce/notification.proto

@@ -9,9 +9,7 @@ import "io/restorecommerce/status.proto";
 import "io/restorecommerce/options.proto";
 
 // Message structure for Notification
-service Service {
-  option (io.restorecommerce.options.service_name) = "notification";
-
+service NotificationService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (NotificationListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
@@ -27,7 +25,7 @@ message Deleted {
 
 message NotificationList {
   repeated Notification items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -43,15 +41,15 @@ message NotificationResponse {
 }
 
 message Notification {
-  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 notification_channel_ids = 5;
   oneof address_type {
     string email = 6;
     string telephone_number = 7;
   }
-  string subject_template = 8;
-  string body_template = 9;
+  optional string subject_template = 8;
+  optional string body_template = 9;
 }

package/io/restorecommerce/notification_channel.proto

@@ -8,7 +8,7 @@ import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
 
 // Message structure for Notification Channel
-service Service {
+service NotificationChannelService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (NotificationChannelListResponse);
   rpc Create (NotificationChannelList) returns (NotificationChannelListResponse);
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
@@ -22,7 +22,7 @@ message Deleted {
 
 message NotificationChannelList {
   repeated NotificationChannel items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -38,10 +38,10 @@ message NotificationChannelResponse {
 }
 
 message NotificationChannel {
-  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;
   oneof configuration_type {
     string email = 5;
     string sms = 6;

package/io/restorecommerce/notification_req.proto

@@ -4,24 +4,24 @@ package io.restorecommerce.notification_req;
 
 import "io/restorecommerce/status.proto";
 
-service Service {
+service NotificationReqService {
   // direct notifications
   rpc Send (NotificationReq) returns (io.restorecommerce.status.OperationStatusObj); /// generic fallback
 }
 
 // mimics nodemailer properties for easy configuration
 message Attachment {
-  string filename = 1;
+  optional 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;
+  optional string text = 2; // for textual data
+  optional bytes buffer = 3; // for binary data, eg.: images
+
+  optional string path = 4;
+  optional string content_type = 5;
+  optional string content_disposition = 6;
+  optional string cid = 7;
+  optional string encoding = 8;
 }
 
 // sendEmail NotificationReq event
@@ -30,10 +30,10 @@ message NotificationReq {
     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'
+  optional string subject = 3;
+  optional string body = 4;  // text/HTML content
+  optional string transport = 5; /// 'email', 'log', ... default == 'log'
+  optional string provider = 6; /// specific transport provider, eg: 'console' for transport == 'log'
   repeated Attachment attachments = 7;
 }
 
@@ -41,9 +41,9 @@ 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
+  optional string replyto = 4; // if set, the outgoing mail will have this replyTo header set
 }
 
 message Log {
-  string level = 1;
+  optional string level = 1;
 }

package/io/restorecommerce/oauth.proto

@@ -7,7 +7,7 @@ import "io/restorecommerce/user.proto";
 import "io/restorecommerce/status.proto";
 import "google/protobuf/empty.proto";
 
-service Service {
+service OAuthService {
   rpc AvailableServices(google.protobuf.Empty) returns (ServicesResponse);
   rpc GenerateLinks(google.protobuf.Empty) returns (GenerateLinksResponse);
   rpc ExchangeCode(ExchangeCodeRequest) returns (ExchangeCodeResponse);