@paakd/api 0.0.1

package/src/proto/files/v1/service.proto

@@ -0,0 +1,19 @@
+syntax = "proto3";
+
+package apps.enterprise.interfaces.rpc.files.v1;
+
+option go_package = "paakd.com/packages/api/gen/files/v1;filesv1";
+
+import "src/proto/files/v1/entities/file.proto";
+
+
+service FileService {
+    rpc UpdateFile(UpdateFileRequest) returns (UpdateFileResponse) {};
+    rpc DeleteFile(DeleteFileRequest) returns (DeleteFileResponse){};
+    rpc ListFiles(ListFilesRequest) returns (ListFilesResponse){
+         option idempotency_level = NO_SIDE_EFFECTS;
+    };
+    rpc GetFile(GetFileRequest) returns (GetFileResponse){
+         option idempotency_level = NO_SIDE_EFFECTS;
+    };
+}

package/src/proto/products/v1/entities/category.proto

@@ -0,0 +1,98 @@
+syntax = "proto3";
+
+
+import "buf/validate/validate.proto";
+
+
+message CreateProductCategoryRequest {
+  string name = 1 [
+    (buf.validate.field).string.min_len = 1,
+    (buf.validate.field).string.max_len = 100
+  ];
+  optional string description = 2 [
+    (buf.validate.field).string.max_len = 500
+  ];
+
+  optional string parent_category_id = 3 [
+    (buf.validate.field).string.min_len = 1,
+    (buf.validate.field).string.max_len = 100
+  ];
+
+  string category_taxonomy_id = 4 [
+    (buf.validate.field).string.min_len = 1,
+    (buf.validate.field).string.max_len = 100
+  ];
+
+ repeated string tags = 5;
+
+  optional bool is_internal = 6;
+  optional bool is_active = 7;
+  optional int32 rank = 8;
+}
+
+message CreateProductCategoryResponse {
+  string id = 1;
+}
+
+message UpdateProductCategoryRequest {
+  string id = 1 [
+    (buf.validate.field).string.min_len = 1,
+    (buf.validate.field).string.max_len = 100
+  ];
+  string name = 2 [
+    (buf.validate.field).string.min_len = 1,
+    (buf.validate.field).string.max_len = 100
+  ];
+  optional string description = 3 [
+    (buf.validate.field).string.max_len = 500
+  ];
+
+  repeated string tags = 4;
+  optional bool is_internal = 5;
+  optional bool is_active = 6;
+  optional int32 rank = 7;
+}
+
+message UpdateProductCategoryResponse {}
+
+message DeleteProductCategoryByIDRequest {
+  string id = 1 [
+    (buf.validate.field).string.min_len = 1,
+    (buf.validate.field).string.max_len = 100
+  ];
+}
+message DeleteProductCategoryByIDResponse {}
+
+message GetProductCategoryByIDRequest {
+  string id = 1 [
+    (buf.validate.field).string.min_len = 1,
+    (buf.validate.field).string.max_len = 100
+  ];
+}
+
+message GetProductCategoryByIDResponse {
+  string id = 1;          // ID of the category
+  string name = 2;        // Name of the category
+  string description = 3; // Description of the category
+  repeated string tags = 4;        // Tags associated with the category
+  string category_taxonomy_id = 5; // Name of the category taxonomy
+  string parent_category_id = 6;
+  bool is_internal = 7;
+  bool is_active = 8;
+  int32 rank = 9;
+  string taxonomy_fullname = 10;
+}
+
+message UpdateProductCategoryTaxonomyRequest {
+  string id = 1 [
+    (buf.validate.field).string.min_len = 1,
+    (buf.validate.field).string.max_len = 100
+  ];
+  string taxonomy_id = 2 [
+    (buf.validate.field).string.min_len = 1,
+    (buf.validate.field).string.max_len = 100
+  ];
+}
+
+message UpdateProductCategoryTaxonomyResponse {
+}

package/src/proto/products/v1/entities/collection.proto

@@ -0,0 +1,72 @@
+syntax = "proto3";
+
+
+import "buf/validate/validate.proto";
+
+
+message CreateCollectionRequest {
+  string title = 1 [
+    (buf.validate.field).string.min_len = 1,
+    (buf.validate.field).string.max_len = 100
+  ];
+  optional string description = 2 [
+    (buf.validate.field).string.max_len = 500
+  ];
+
+  string slug = 3 [
+    (buf.validate.field).string.min_len = 3,
+    (buf.validate.field).string.max_len = 50,
+    (buf.validate.field).string.pattern = "^[a-z0-9]+(?:-[a-z0-9]+)*$"
+  ];
+}
+
+message CreateCollectionResponse {
+  string id = 1;
+}
+
+message GetCollectionByIDRequest {
+  string id = 1 [
+    (buf.validate.field).string.min_len = 1,
+    (buf.validate.field).string.max_len = 100
+  ];
+}
+
+message GetCollectionByIDResponse {
+  string id = 1;          // ID of the collection
+  string title = 2;        // Name of the collection
+  string description = 3; // Description of the collection
+  string slug = 4;    // URL slug of the collection
+  repeated string tags = 5;        // Tags associated with the collection
+}
+
+message UpdateCollectionRequest {
+  string id = 1 [
+    (buf.validate.field).string.min_len = 1,
+    (buf.validate.field).string.max_len = 100
+  ];
+  string title = 2 [
+    (buf.validate.field).string.min_len = 1,
+    (buf.validate.field).string.max_len = 100
+  ];
+  optional string description = 3 [
+    (buf.validate.field).string.max_len = 500
+  ];
+
+  string slug = 4 [
+    (buf.validate.field).string.min_len = 3,
+    (buf.validate.field).string.max_len = 50,
+    (buf.validate.field).string.pattern = "^[a-z0-9]+(?:-[a-z0-9]+)*$"
+  ];
+
+  repeated string tags = 5;
+}
+message UpdateCollectionResponse {}
+
+message DeleteCollectionByIDRequest {
+  string id = 1 [
+    (buf.validate.field).string.min_len = 1,
+    (buf.validate.field).string.max_len = 100
+  ];
+}
+
+message DeleteCollectionByIDResponse {}

package/src/proto/products/v1/entities/product/create.proto

@@ -0,0 +1,41 @@
+syntax = "proto3";
+
+import "buf/validate/validate.proto";
+import "src/proto/products/v1/entities/product/shared.proto";
+
+
+message CreateProductRequest {
+  string title = 1;
+  optional string subtitle = 2;
+  optional string description = 3;
+  optional string slug = 4;
+  optional bool is_published = 5;
+  optional bool is_giftcard = 6;
+  optional string thumbnail = 7;
+  optional ProductStatus status = 8;
+  optional string product_type_id = 9;
+  repeated string collection_id = 10;
+  repeated string category_ids = 11;
+  repeated string image_ids = 12;
+  repeated string tag_ids = 13;
+  repeated Variant variants = 14;
+  repeated ProductOption options = 15;
+  map<string, string> metadata = 16;
+  optional float weight = 17;
+  optional float length = 18;
+  optional float width = 19;
+  optional float height = 20;
+  optional string hs_code = 21;
+  optional string origin_country = 22;
+  optional string manufacturer_id = 23;
+  optional bool returnable = 24;
+  repeated string sales_channel_ids = 25;
+  repeated string attribute_ids = 26;
+  string external_id = 27;
+  string shipping_profile_id = 28;
+}
+
+
+message CreateProductResponse {
+    ProductResponse product = 1;
+}

package/src/proto/products/v1/entities/product/option.proto

@@ -0,0 +1,17 @@
+syntax = "proto3";
+
+
+import "buf/validate/validate.proto";
+
+import "src/proto/products/v1/entities/product/shared.proto";
+
+message CreateOptionRequest {
+    string product_id = 1;
+    string title = 2;
+    repeated string values = 3;
+    map<string, string> metadata = 4;
+}
+
+message CreateOptionResponse {
+    ProductResponse product = 1;
+}

package/src/proto/products/v1/entities/product/shared.proto

@@ -0,0 +1,255 @@
+syntax = "proto3";
+
+import "buf/validate/validate.proto";
+
+enum ProductStatus {
+  DRAFT = 0;
+  PROPOSED = 1;
+  PUBLISHED = 2;
+  REJECTED = 3;
+}
+
+message ProductOption {
+  string title = 1;
+  repeated string values = 2;
+}
+
+message Variant {
+    message OptionValue {
+      string option_id = 1;
+      string value = 2;
+    }
+    message Price {
+      enum RuleType {
+        RULE_TYPE_UNSPECIFIED = 0;
+        RULE_TYPE_REGION = 1;
+        RULE_TYPE_CUSTOMER_GROUP = 2;
+      }
+      message Rule {
+        string entity_id = 1;
+        RuleType entity_type = 2;
+      }
+      string currency_code = 1;
+      float amount = 3;
+      int32 max_quantity = 4;
+      int32 min_quantity = 5;
+
+      repeated Rule rules = 10;
+    }
+    message InventoryItem {
+        string inventory_item_id = 1;
+    }
+    optional string id = 1;
+    string title = 2;
+    optional string sku = 3;
+    optional string ean = 4;
+    optional string upc = 5;
+    optional string barcode = 6;
+    optional bool track_inventory = 7;
+    optional bool is_manage_inventory = 8;
+    optional float weight = 9;
+    optional float length = 10;
+    optional float width = 11;
+    optional float height = 12;
+    optional string hs_code = 13;
+    optional string origin_country = 14;
+    optional string material = 15;
+    repeated OptionValue option_values = 16;
+    repeated Price prices = 17;
+    repeated InventoryItem inventory_items = 18;
+    map<string, string> metadata = 19;
+    optional string mid_code = 20;
+    optional bool allow_backorder = 21;
+    optional int32 rank = 22;
+}
+
+message ProductResponse {
+  message Tag {
+      string id = 1;
+      string value  = 2;
+  }
+  message SalesChannel {
+      string id = 1;
+      string name  = 2;
+      string description = 3;
+      string is_disabled = 4;
+      map<string, string> metadata = 5;
+  }
+  message Type {
+    string id = 1;
+    string name = 2;
+    map<string, string> metadata = 3;
+  }
+  message Category {
+      string id = 1;
+      string name = 2;
+      string description = 3;
+      string slug = 4;
+      bool is_active = 5;
+      bool is_internal = 6;
+      int32 rank = 7;
+      optional string parent_id = 8;
+      repeated Category children = 9;
+      map<string, string> metadata = 10;
+  }
+  message Collection {
+      string id = 1;
+      string title = 2;
+      string slug = 3;
+      map<string, string> metadata = 4;
+  }
+  message Image {
+    string id = 1;
+    string url = 2;
+    int32 rank = 3;
+    map<string, string> metadata = 4;
+  }
+  message Value {
+      string option_id = 1;
+      string value = 2;
+      optional Option option = 4;
+  }
+  message OptionData {
+      string id = 1;
+      string title = 2;
+      repeated Value option_values = 3;
+      string product_id = 4;
+  }
+  message Option {
+    string id = 1;
+    string value = 2;
+    string product_id = 3;
+    OptionData option = 4;
+    repeated Value values = 5;
+  }
+  message ProductVariant {
+      message Price {
+        message Rule {
+          enum Type {
+              TYPE_UNSPECIFIED = 0;
+              TYPE_REGION = 1;
+             TYPE_CUSTOMER_GROUP = 2;
+          }
+          string entity_id = 1;
+          Type entity_type = 2;
+        }
+        string currency_code = 1;
+        float amount = 3;
+        float raw_amount = 4;
+        string title = 5;
+        string id = 6;
+        int32 max_quantity = 7;
+        int32 min_quantity = 8;
+        string price_set_id = 9;
+        repeated Rule rules = 10;
+      }
+      message Option {
+        string id = 1;
+        string value = 2;
+        string option_id = 3;
+        OptionData option = 4;
+      }
+
+      message InventoryItem {
+          message InventoryItemData {
+              string id = 1;
+              bool requires_shipping = 2;
+              string sku = 3;
+              string origin_country = 4;
+              string hs_code = 5;
+              string mid_code = 6;
+              string material = 7;
+              string title = 8;
+              string description = 9;
+              string thumbnail = 10;
+              float weight = 11;
+              float length = 12;
+              float width = 13;
+              float height = 14;
+          }
+        string id = 1;
+        int32 required_quantity = 2;
+        string variant_id = 3;
+        string inventory_item_id = 4;
+        InventoryItemData inventory = 5;
+      }
+
+      message CalculatedPrice {
+        string id = 1;
+        float calculated_amount = 2;
+        float original_amount = 3;
+        string currency_code = 4;
+        float original_amount_with_tax = 5;
+        float original_amount_without_tax = 6;
+        optional float is_calculated_price_price_list = 7;
+        optional bool is_calculated_price_tax_inclusive = 8;
+        optional float calculated_amount_with_tax = 9;
+        optional float calculated_amount_without_tax = 10;
+        optional bool is_original_price_price_list = 11;
+        optional bool is_original_price_tax_inclusive = 12;
+        optional Price calculated_price = 13;
+        optional Price original_price = 14;
+      }
+
+    string id = 1;
+    string title = 2;
+    string sku = 3;
+    string barcode = 4;
+    string ean = 5;
+    string upc = 6;
+    bool allow_backorder = 7;
+    bool is_managed_inventory = 8;
+    string hs_code = 9;
+    string origin_country = 10;
+    string mid_code = 11;
+    string material = 12;
+    float weight = 13;
+    float length = 14;
+    float height = 15;
+    float width = 16;
+    string thumbnail = 17;
+    string product_id = 18;
+
+    CalculatedPrice calculated_price = 19;
+    repeated InventoryItem inventory_items = 20;
+    repeated Image images = 21;
+    repeated Option options = 22;
+    repeated Price prices = 23;
+  }
+  message ShippingProfile {
+      string id = 1;
+      string name = 2;
+      string type = 3;
+      map<string, string> metadata = 4;
+  }
+  string id = 1;
+  float length = 2;
+  string title = 3;
+  ProductStatus status = 4;
+  string description = 5;
+  string slug = 6;
+  string subtitle = 7;
+  string thumbnail = 8;
+  bool is_giftcard = 9;
+  float weight = 10;
+  float height = 11;
+  float width = 12;
+  string origin_country = 13;
+  string hs_code = 14;
+  string mid_code = 15;
+  string collection_id = 16;
+  string type_id = 17;
+  bool is_discountable = 18;
+  string external_id = 19;
+
+  repeated ProductVariant variants = 20;
+  Type type = 21;
+  Option options = 22;
+  repeated Image images = 23;
+  Collection collection = 24;
+  repeated Category categories = 25;
+  repeated SalesChannel sales_channels = 26;
+  repeated Tag tags = 27;
+  ShippingProfile shipping_profile = 28;
+  map<string, string> metadata = 29;
+}

package/src/proto/products/v1/entities/product/update.proto

@@ -0,0 +1,66 @@
+syntax = "proto3";
+
+import "buf/validate/validate.proto";
+import "src/proto/products/v1/entities/product/shared.proto";
+
+message UpdateProductRequest {
+
+    string id = 1;
+    optional string title = 2;
+    optional string subtitle = 3;
+    optional string description = 4;
+    optional bool is_giftcard = 5;
+    optional bool is_discountable = 6;
+    optional string thumbnail = 7;
+    optional string slug = 8;
+    optional ProductStatus status = 9;
+    optional float weight = 10;
+    optional float height = 11;
+    optional float width = 12;
+    optional float length = 13;
+    optional string hs_code = 14;
+    optional string mid_code = 15;
+    optional string origin_country = 16;
+    optional string material = 17;
+    optional string external_id = 18;
+    repeated string images = 19;
+    repeated string tags = 20;
+    repeated string categories = 21;
+    repeated string sales_channels = 22;
+    repeated ProductOption options = 23;
+    repeated Variant variants = 24;
+}
+
+
+message UpdateProductResponse {
+    ProductResponse product = 1;
+}
+
+
+message DeleteProductRequest {
+    string product_id = 1;
+}
+
+message DeleteProductResponse {}
+
+message DeleteVariantRequest {
+    string variant_id = 1;
+    string product_id = 2;
+}
+
+message DeleteVariantResponse {}
+
+message DeleteOptionRequest {
+    string option_id = 1;
+    string product_id = 2;
+}
+
+message DeleteOptionResponse {}
+
+message RemoveInventoryItemRequest {
+    string inventory_item_id = 1;
+    string product_id = 2;
+    string variant_id = 3;
+}
+
+message RemoveInventoryItemResponse {}

package/src/proto/products/v1/entities/tag.proto

@@ -0,0 +1,73 @@
+syntax = "proto3";
+
+
+import "buf/validate/validate.proto";
+
+
+
+message CreateTagRequest {
+  string value = 1 [
+    (buf.validate.field).string.min_len = 1,
+    (buf.validate.field).string.max_len = 100
+  ];
+}
+
+message CreateTagResponse {
+  string id = 1;
+}
+
+message GetTagByIDRequest {
+  string id = 1 [
+    (buf.validate.field).string.min_len = 1,
+    (buf.validate.field).string.max_len = 100
+  ];
+}
+
+message GetTagByIDResponse {
+  string id = 1;
+  string value = 2;
+}
+
+message ListTagsRequest {
+  int32 offset = 1 [
+    (buf.validate.field).int32.gte = 1
+  ];
+  uint32 limit = 2 [
+    (buf.validate.field).int32.gte = 1,
+    (buf.validate.field).int32.lte = 100
+  ];
+  string order_by = 3;
+  string filter = 4;
+  bool ascending = 5;
+  string request_path = 6;
+}
+
+message ListTagsResponse {
+  repeated GetTagByIDResponse tags = 1;
+}
+
+message UpdateTagRequest {
+  string id = 1 [
+    (buf.validate.field).string.min_len = 1,
+    (buf.validate.field).string.max_len = 100
+  ];
+  string value = 2 [
+    (buf.validate.field).string.min_len = 1,
+    (buf.validate.field).string.max_len = 100
+  ];
+}
+
+message UpdateTagResponse {
+  string id = 1;
+}
+
+message DeleteTagByIDRequest {
+  string id = 1 [
+    (buf.validate.field).string.min_len = 1,
+    (buf.validate.field).string.max_len = 100
+  ];
+}
+
+message DeleteTagByIDResponse {
+  string id = 1;
+}