@mamindom/contracts 1.0.50 → 1.0.52

package/proto/post.proto

@@ -0,0 +1,193 @@
+syntax = "proto3";
+
+package content.v1;
+
+import "common_post.proto";
+
+
+service PostService {
+
+  rpc GetPosts    (GetPostsRequest)    returns (GetPostsResponse);
+  rpc GetPost     (GetPostRequest)     returns (PostResponse);
+  rpc CreatePost  (CreatePostRequest)  returns (PostResponse);
+  rpc UpdatePost  (UpdatePostRequest)  returns (PostResponse);
+  rpc DeletePost  (DeletePostRequest)  returns (DeleteResponse);
+
+ 
+  rpc PublishPost  (PostIdRequest) returns (PostResponse);  
+  rpc SchedulePost (SchedulePostRequest) returns (PostResponse); 
+  rpc ArchivePost  (PostIdRequest) returns (PostResponse);
+
+  
+  rpc IncrementViews (PostIdRequest) returns (SuccessResponse);
+}
+
+
+enum PostType {
+  POST_TYPE_UNSPECIFIED = 0;
+  POST_TYPE_ARTICLE     = 1; 
+  POST_TYPE_NEWS        = 2; 
+  POST_TYPE_PAGE        = 3; 
+}
+
+enum PostStatus {
+  POST_STATUS_UNSPECIFIED = 0;
+  POST_STATUS_DRAFT       = 1;
+  POST_STATUS_SCHEDULED   = 2;
+  POST_STATUS_PUBLISHED   = 3;
+  POST_STATUS_ARCHIVED    = 4;
+}
+
+message PostResponse {
+  string id     = 1;
+  string slug   = 2;
+  PostType   type   = 3;
+  PostStatus status = 4;
+
+  map<string, string> title       = 5;
+  map<string, string> excerpt     = 6;
+  map<string, string> content     = 7;
+
+  optional string cover_image    = 8;
+  optional string cover_image_id = 9;
+
+  optional string published_at = 10; 
+  int32           read_time    = 11; 
+  int32           views_count  = 12;
+  int32           comments_count = 13;
+
+  map<string, string> seo_title       = 14;
+  map<string, string> seo_description = 15;
+  map<string, string> seo_keywords    = 16;
+  map<string, string> seo_h1          = 17;
+
+  string created_by_id = 18;
+  string created_at    = 19;
+  string updated_at    = 20;
+
+  repeated PostCategoryItem categories = 21;
+  repeated PostTagItem       tags       = 22;
+}
+
+
+message PostCategoryItem {
+  string id   = 1;
+  string slug = 2;
+  map<string, string> name = 3;
+}
+
+message PostTagItem {
+  string id   = 1;
+  string slug = 2;
+  map<string, string> name = 3;
+}
+
+
+message PostListItem {
+  string id     = 1;
+  string slug   = 2;
+  PostType   type   = 3;
+  PostStatus status = 4;
+
+  map<string, string> title   = 5;
+  map<string, string> excerpt = 6;
+
+  optional string cover_image  = 7;
+  optional string published_at = 8;
+  int32           read_time    = 9;
+  int32           views_count  = 10;
+  int32           comments_count = 11;
+
+  repeated PostCategoryItem categories = 12;
+  repeated PostTagItem       tags       = 13;
+}
+
+
+message GetPostsRequest {
+  PaginationRequest pagination = 1;
+
+  optional PostType   type        = 2;
+  optional PostStatus status      = 3;
+  optional string     search      = 4; 
+  optional string     category_id = 5;
+  optional string     tag_id      = 6;
+  optional string     date_from   = 7; 
+  optional string     date_to     = 8;
+  optional string     sort_by     = 9; 
+}
+
+message GetPostsResponse {
+  repeated PostListItem items = 1;
+  PaginationMeta        meta  = 2;
+}
+
+
+message GetPostRequest {
+  string id = 1;
+  optional string slug = 2;
+}
+
+
+message CreatePostRequest {
+  PostType type = 1;
+
+  optional string slug = 2; 
+
+  map<string, string> title   = 3;
+  map<string, string> excerpt = 4;
+  map<string, string> content = 5;
+
+  optional string cover_image    = 6;
+  optional string cover_image_id = 7;
+
+  map<string, string> seo_title       = 8;
+  map<string, string> seo_description = 9;
+  map<string, string> seo_keywords    = 10;
+  map<string, string> seo_h1          = 11;
+
+  repeated string category_ids = 12;
+  repeated string tag_ids      = 13;
+
+  string created_by_id = 14;
+}
+
+
+message UpdatePostRequest {
+  string id = 1;
+
+  optional string slug = 2;
+
+  map<string, string> title   = 3;
+  map<string, string> excerpt = 4;
+  map<string, string> content = 5;
+
+  optional string cover_image    = 6;
+  optional string cover_image_id = 7;
+
+  map<string, string> seo_title       = 8;
+  map<string, string> seo_description = 9;
+  map<string, string> seo_keywords    = 10;
+  map<string, string> seo_h1          = 11;
+
+  repeated string category_ids = 12;
+  repeated string tag_ids      = 13;
+
+  string updated_by_id = 14;
+}
+
+
+message DeletePostRequest {
+  string id = 1;
+}
+
+
+message PostIdRequest {
+  string id = 1;
+}
+
+
+message SchedulePostRequest {
+  string id           = 1;
+  string publish_at   = 2; 
+  string updated_by_id = 3;
+}

package/proto/post_category.proto

@@ -0,0 +1,84 @@
+syntax = "proto3";
+
+package content.v1;
+
+import "common_post.proto";
+
+
+service PostCategoryService {
+  rpc GetPostCategories (GetPostCategoriesRequest) returns (GetPostCategoriesResponse);
+  rpc GetPostCategory   (GetPostCategoryRequest)   returns (PostCategoryResponse);
+  rpc CreatePostCategory (CreatePostCategoryRequest) returns (PostCategoryResponse);
+  rpc UpdatePostCategory (UpdatePostCategoryRequest) returns (PostCategoryResponse);
+  rpc DeletePostCategory (DeletePostCategoryRequest) returns (DeleteResponse);
+}
+
+
+enum PostCategoryType {
+  POST_CATEGORY_TYPE_UNSPECIFIED = 0;
+  POST_CATEGORY_TYPE_ARTICLE     = 1;
+  POST_CATEGORY_TYPE_NEWS        = 2;
+  POST_CATEGORY_TYPE_PAGE        = 3;
+  POST_CATEGORY_TYPE_ALL         = 4;
+}
+
+
+message PostCategoryResponse {
+  string id   = 1;
+  string slug = 2;
+
+  map<string, string> name        = 3;
+  map<string, string> description = 4;
+
+  int32            sort_order = 5;
+  PostCategoryType post_type  = 6;
+
+  string created_at = 7;
+  string updated_at = 8;
+}
+
+
+message GetPostCategoriesRequest {
+  PaginationRequest pagination = 1;
+  optional PostCategoryType post_type = 2; 
+}
+
+message GetPostCategoriesResponse {
+  repeated PostCategoryResponse items = 1;
+  PaginationMeta                meta  = 2;
+}
+
+
+message GetPostCategoryRequest {
+  string id = 1;
+  optional string slug = 2;
+}
+
+
+message CreatePostCategoryRequest {
+  string slug = 1;
+
+  map<string, string> name        = 2;
+  map<string, string> description = 3;
+
+  int32            sort_order = 4;
+  PostCategoryType post_type  = 5;
+}
+
+
+message UpdatePostCategoryRequest {
+  string id = 1;
+
+  optional string slug = 2;
+
+  map<string, string> name        = 3;
+  map<string, string> description = 4;
+
+  optional int32           sort_order = 5;
+  optional PostCategoryType post_type = 6;
+}
+
+
+message DeletePostCategoryRequest {
+  string id = 1;
+}

package/proto/post_comment.proto

@@ -0,0 +1,66 @@
+syntax = "proto3";
+
+package content.v1;
+
+import "common_post.proto";
+
+
+service PostCommentService {
+  
+  rpc GetComments    (GetCommentsRequest)    returns (GetCommentsResponse);
+  
+  rpc CreateComment  (CreateCommentRequest)  returns (CommentResponse);
+
+  rpc ApproveComment (CommentIdRequest) returns (CommentResponse);
+  rpc RejectComment  (CommentIdRequest) returns (CommentResponse);
+  rpc DeleteComment  (CommentIdRequest) returns (DeleteResponse);
+}
+
+
+enum CommentStatus {
+  COMMENT_STATUS_UNSPECIFIED = 0;
+  COMMENT_STATUS_PENDING     = 1;
+  COMMENT_STATUS_APPROVED    = 2;
+  COMMENT_STATUS_REJECTED    = 3;
+}
+
+
+message CommentResponse {
+  string id      = 1;
+  string post_id = 2;
+
+  string author_name  = 3;
+  string author_email = 4;
+  string body         = 5;
+
+  CommentStatus status = 6;
+
+  string created_at = 7;
+}
+
+
+message GetCommentsRequest {
+  PaginationRequest pagination = 1;
+
+  optional string        post_id = 2; 
+  optional CommentStatus status  = 3; 
+}
+
+message GetCommentsResponse {
+  repeated CommentResponse items = 1;
+  PaginationMeta           meta  = 2;
+}
+
+
+message CreateCommentRequest {
+  string post_id = 1;
+
+  string author_name  = 2;
+  string author_email = 3;
+  string body         = 4;
+}
+
+
+message CommentIdRequest {
+  string id = 1;
+}

package/proto/post_tag.proto

@@ -0,0 +1,57 @@
+syntax = "proto3";
+
+package content.v1;
+
+import "common_post.proto";
+
+
+service PostTagService {
+  rpc GetPostTags   (GetPostTagsRequest)   returns (GetPostTagsResponse);
+  rpc GetPostTag    (GetPostTagRequest)    returns (PostTagResponse);
+  rpc CreatePostTag (CreatePostTagRequest) returns (PostTagResponse);
+  rpc UpdatePostTag (UpdatePostTagRequest) returns (PostTagResponse);
+  rpc DeletePostTag (DeletePostTagRequest) returns (DeleteResponse);
+}
+
+
+message PostTagResponse {
+  string id   = 1;
+  string slug = 2;
+  map<string, string> name = 3;
+  string created_at = 4;
+}
+
+
+message GetPostTagsRequest {
+  PaginationRequest pagination = 1;
+  optional string   search     = 2; 
+}
+
+message GetPostTagsResponse {
+  repeated PostTagResponse items = 1;
+  PaginationMeta           meta  = 2;
+}
+
+
+message GetPostTagRequest {
+  string id = 1;
+  optional string slug = 2;
+}
+
+
+message CreatePostTagRequest {
+  string slug = 1;
+  map<string, string> name = 2;
+}
+
+
+message UpdatePostTagRequest {
+  string id = 1;
+  optional string slug = 2;
+  map<string, string> name = 3;
+}
+
+
+message DeletePostTagRequest {
+  string id = 1;
+}

package/proto/post_version.proto

@@ -0,0 +1,61 @@
+syntax = "proto3";
+
+package content.v1;
+
+import "common_post.proto";
+
+
+service PostVersionService {
+  
+  rpc GetPostVersions   (GetPostVersionsRequest)   returns (GetPostVersionsResponse);
+  
+  rpc GetPostVersion    (GetPostVersionRequest)    returns (PostVersionResponse);
+  
+  rpc RestorePostVersion (RestorePostVersionRequest) returns (SuccessResponse);
+}
+
+
+message PostVersionResponse {
+  string id      = 1;
+  string post_id = 2;
+
+  map<string, string> title   = 3;
+  map<string, string> excerpt = 4;
+  map<string, string> content = 5;
+
+  int32  version     = 6;
+  string saved_by_id = 7;
+  string created_at  = 8;
+}
+
+
+message PostVersionListItem {
+  string id         = 1;
+  string post_id    = 2;
+  int32  version    = 3;
+  string saved_by_id = 4;
+  string created_at = 5;
+  map<string, string> title = 6; 
+}
+
+
+message GetPostVersionsRequest {
+  string            post_id    = 1;
+  PaginationRequest pagination = 2;
+}
+
+message GetPostVersionsResponse {
+  repeated PostVersionListItem items = 1;
+  PaginationMeta               meta  = 2;
+}
+
+
+message GetPostVersionRequest {
+  string id = 1; 
+}
+
+
+message RestorePostVersionRequest {
+  string version_id    = 1;
+  string restored_by_id = 2;
+}

package/proto/promotion.proto

@@ -0,0 +1,257 @@
+syntax = "proto3";
+
+package promo.v1;
+
+import "common_promo.proto";
+
+
+service PromotionService {
+  
+  rpc GetPromotions       (GetPromotionsRequest)       returns (GetPromotionsResponse);
+  rpc GetPromotion        (GetPromotionRequest)        returns (PromotionResponse);
+  rpc CreatePromotion     (CreatePromotionRequest)     returns (PromotionResponse);
+  rpc UpdatePromotion     (UpdatePromotionRequest)     returns (PromotionResponse);
+  rpc DeletePromotion     (DeletePromotionRequest)     returns (DeleteResponse);
+
+ 
+  rpc BulkApplyToCategories (BulkApplyToCategoriesRequest) returns (SuccessResponse);
+
+  
+  rpc GetActivePromotions (GetActivePromotionsRequest) returns (GetActivePromotionsResponse);
+}
+
+
+enum PromotionType {
+  PROMOTION_TYPE_UNSPECIFIED  = 0;
+  PROMOTION_TYPE_FIXED        = 1; 
+  PROMOTION_TYPE_PERCENTAGE   = 2; 
+  PROMOTION_TYPE_COUPON       = 3;
+  PROMOTION_TYPE_BUY_N_GET_M  = 4; 
+  PROMOTION_TYPE_FIRST_ORDER  = 5; 
+  PROMOTION_TYPE_LOYALTY      = 6;
+  PROMOTION_TYPE_PROMO_PERIOD = 7; 
+}
+
+enum DiscountType {
+  DISCOUNT_TYPE_UNSPECIFIED = 0;
+  DISCOUNT_TYPE_FIXED       = 1; 
+  DISCOUNT_TYPE_PERCENTAGE  = 2; 
+}
+
+enum PromotionStatus {
+  PROMOTION_STATUS_UNSPECIFIED = 0;
+  PROMOTION_STATUS_DRAFT       = 1;
+  PROMOTION_STATUS_ACTIVE      = 2;
+  PROMOTION_STATUS_INACTIVE    = 3;
+  PROMOTION_STATUS_EXPIRED     = 4;
+}
+
+enum ConditionLogic {
+  CONDITION_LOGIC_UNSPECIFIED = 0;
+  CONDITION_LOGIC_AND         = 1;
+  CONDITION_LOGIC_OR          = 2;
+}
+
+enum ConditionType {
+  CONDITION_TYPE_UNSPECIFIED      = 0;
+  CONDITION_TYPE_PRODUCT          = 1;
+  CONDITION_TYPE_CATEGORY         = 2;
+  CONDITION_TYPE_BRAND            = 3;
+  CONDITION_TYPE_USER_GROUP       = 4;
+  CONDITION_TYPE_FIRST_ORDER      = 5;
+  CONDITION_TYPE_MIN_ORDER_COUNT  = 6;
+  CONDITION_TYPE_MIN_AMOUNT       = 7;
+}
+
+enum ExclusionEntityType {
+  EXCLUSION_ENTITY_UNSPECIFIED = 0;
+  EXCLUSION_ENTITY_PRODUCT     = 1;
+  EXCLUSION_ENTITY_CATEGORY    = 2;
+  EXCLUSION_ENTITY_BRAND       = 3;
+}
+
+
+message PromotionConditionPayload {
+  ConditionLogic logic_type     = 1;
+  ConditionType  condition_type = 2;
+  string         value          = 3; 
+}
+
+message PromotionExclusionPayload {
+  ExclusionEntityType entity_type = 1;
+  string              entity_id   = 2;
+}
+
+message PromotionConditionResponse {
+  string         id             = 1;
+  ConditionLogic logic_type     = 2;
+  ConditionType  condition_type = 3;
+  string         value          = 4;
+}
+
+message PromotionExclusionResponse {
+  string              id          = 1;
+  ExclusionEntityType entity_type = 2;
+  string              entity_id   = 3;
+}
+
+
+message PromotionResponse {
+  string          id           = 1;
+  map<string, string> name     = 2;
+  map<string, string> description = 3;
+
+  PromotionType   type         = 4;
+  DiscountType    discount_type = 5;
+  PromotionStatus status       = 6;
+
+  double discount_value        = 7;
+
+  optional string starts_at    = 8;  
+  optional string ends_at      = 9;
+
+  optional double min_order_amount     = 10;
+  optional int32  usage_limit_total    = 11;
+  optional int32  usage_limit_per_user = 12;
+  int32           usage_count          = 13;
+
+  bool is_active    = 14;
+  bool is_exclusive = 15;
+
+ 
+  optional int32 buy_quantity = 16;
+  optional int32 get_quantity = 17;
+
+
+  optional string             seo_slug        = 18;
+  map<string, string>         seo_title       = 19;
+  map<string, string>         seo_description = 20;
+
+  string created_by_id = 21;
+  string created_at    = 22;
+  string updated_at    = 23;
+
+  repeated PromotionConditionResponse conditions = 24;
+  repeated PromotionExclusionResponse exclusions = 25;
+}
+
+
+message GetPromotionsRequest {
+  PaginationRequest pagination = 1;
+
+  optional PromotionType   type       = 2;
+  optional PromotionStatus status     = 3;
+  optional string          search     = 4;
+  optional string          category_id = 5;
+  optional string          date_from  = 6; 
+  optional string          date_to    = 7;
+}
+
+message GetPromotionsResponse {
+  repeated PromotionListItem items = 1;
+  PaginationMeta             meta  = 2;
+}
+
+message PromotionListItem {
+  string          id           = 1;
+  map<string, string> name     = 2;
+  PromotionType   type         = 3;
+  PromotionStatus status       = 4;
+  optional string starts_at    = 5;
+  optional string ends_at      = 6;
+  int32           usage_count  = 7;
+  bool            is_active    = 8;
+  string          created_at   = 9;
+}
+
+
+message GetPromotionRequest {
+  string id = 1;
+}
+
+
+message CreatePromotionRequest {
+  map<string, string> name        = 1;
+  map<string, string> description = 2;
+
+  PromotionType  type          = 3;
+  DiscountType   discount_type = 4;
+  double         discount_value = 5;
+
+  optional string starts_at = 6;
+  optional string ends_at   = 7;
+
+  optional double min_order_amount     = 8;
+  optional int32  usage_limit_total    = 9;
+  optional int32  usage_limit_per_user = 10;
+
+  bool is_active    = 11;
+  bool is_exclusive = 12;
+
+  optional int32 buy_quantity = 13;
+  optional int32 get_quantity = 14;
+
+  optional string     seo_slug        = 15;
+  map<string, string> seo_title       = 16;
+  map<string, string> seo_description = 17;
+
+  string created_by_id = 18;
+
+  repeated PromotionConditionPayload conditions = 19;
+  repeated PromotionExclusionPayload exclusions = 20;
+}
+
+
+message UpdatePromotionRequest {
+  string id = 1;
+
+  map<string, string> name        = 2;
+  map<string, string> description = 3;
+
+  optional PromotionType   type          = 4;
+  optional DiscountType    discount_type = 5;
+  optional double          discount_value = 6;
+
+  optional string starts_at = 7;
+  optional string ends_at   = 8;
+
+  optional double min_order_amount     = 9;
+  optional int32  usage_limit_total    = 10;
+  optional int32  usage_limit_per_user = 11;
+
+  optional bool is_active    = 12;
+  optional bool is_exclusive = 13;
+
+  optional int32 buy_quantity = 14;
+  optional int32 get_quantity = 15;
+
+  optional string     seo_slug        = 16;
+  map<string, string> seo_title       = 17;
+  map<string, string> seo_description = 18;
+
+  
+  repeated PromotionConditionPayload conditions = 19;
+  repeated PromotionExclusionPayload exclusions = 20;
+}
+
+
+message DeletePromotionRequest {
+  string id = 1;
+}
+
+
+message BulkApplyToCategoriesRequest {
+  string          promotion_id = 1;
+  repeated string category_ids = 2;
+}
+
+
+message GetActivePromotionsRequest {
+  PaginationRequest pagination = 1;
+  optional string   lang       = 2;
+}
+
+message GetActivePromotionsResponse {
+  repeated PromotionListItem items = 1;
+  PaginationMeta             meta  = 2;
+}