@paakd/api 0.0.1 → 0.0.2

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

@@ -1,146 +0,0 @@
-syntax = "proto3";
-
-
-import "buf/validate/validate.proto";
-
-
-  enum SearchType {
-    SEARCH_TYPE_UNSPECIFIED = 0; // Default value, not specified
-    SEARCH_TYPE_EXACT = 1;       // Exact match search
-    SEARCH_TYPE_FUZZY = 2;       // Fuzzy match search
-    SEARCH_TYPE_PREFIX = 3;      // Prefix match search
-    SEARCH_TYPE_WILDCARD = 4;    // Wildcard match search
-    SEARCH_TYPE_RANGE = 5;       // Range search
-    SEARCH_TYPE_TERM = 6;        // Term search
-  }
-
-  enum Locale {
-    LOCALE_UNSPECIFIED = 0; // Default value, not specified
-    LOCALE_EN = 1;          // English
-    LOCALE_ES = 2;          // Spanish
-    LOCALE_FR = 3;          // French
-    LOCALE_DE = 4;          // German
-    LOCALE_NL = 5;          // Dutch
-  }
-
-  message Vertical {
-    string name = 1;
-    string prefix = 2;
-  }
-
-  message Category {
-    string id = 1;
-    string name = 2;
-    string full_name = 3;
-    string parent_id = 4;
-    uint32 level = 5;
-    string vertical_name = 6;
-    repeated string attributes = 7;
-    repeated string children = 8;
-    repeated string ancestors = 9;
-  }
-
-  message AttributeValue {
-    string id = 1;
-    string name = 2;
-    string handle = 3;
-  }
-  message ExtendedAttributeValue {
-    string name = 1;
-    string handle = 2;
-  }
-
-  message Attribute {
-    string id = 1;
-    string name = 2;
-    string handle = 3;
-    string description = 4;
-    repeated AttributeValue values = 5;
-    repeated ExtendedAttributeValue extended_values = 6;
-  }
-
-
-message SearchVerticalsRequest {
-  string query = 1 [(buf.validate.field).string = {
-    min_len: 1,
-    max_len: 100
-    }];
-  SearchType search_type = 2 [(buf.validate.field).enum = {
-      defined_only: true
-  }];
-  uint32 size = 3 [(buf.validate.field).uint32 = {gte: 1, lte: 1000}];
-  Locale locale = 4 [(buf.validate.field).enum = {
-      defined_only: true
-  }];
-
-  map<string, string> extra_params = 5;
-}
-
-message SearchVerticalsResponse {
-  repeated Vertical verticals = 1;
-}
-
-
-message SearchCategoryRequest {
-  string vertical_name = 1 [(buf.validate.field).string = {min_len: 1}];
-  uint32 level = 2 [(buf.validate.field).uint32 = {gte: 1, lte: 5}];
-  string query = 3 [(buf.validate.field).string = {
-      min_len: 1,
-      max_len: 100
-  }];
-  SearchType search_type = 4 [(buf.validate.field).enum = {
-      defined_only: true
-  }];
-  uint32 size = 5 [(buf.validate.field).uint32 = {gte: 1, lte: 1000}];
-  Locale locale = 6 [(buf.validate.field).enum = {
-      defined_only: true
-  }];
-
-  map<string, string> extra_params = 7;
-}
-message SearchCategoryResponse {
-  repeated Category categories = 1;
-}
-
-message GetCategoryRequest {
-  string category_id = 1 [(buf.validate.field).string = {min_len: 1}];
-  Locale locale = 2 [(buf.validate.field).enum = {
-      defined_only: true
-  }];
-}
-message GetCategoryResponse {
-  Category category = 1;
-}
-
-message GetAttributeRequest {
-  string attribute_id = 1 [(buf.validate.field).string = {min_len: 1}];
-  Locale locale = 2 [(buf.validate.field).enum = {
-      defined_only: true
-  }];
-  bool include_values = 3;
-}
-
-message GetAttributeResponse {
-  Attribute attribute = 1;
-}
-
-message GetCategoryAttributesRequest {
-  string category_id = 1 [(buf.validate.field).string = {min_len: 1}];
-  Locale locale = 2 [(buf.validate.field).enum = {
-        defined_only: true
-    }];
-}
-message GetCategoryAttributesResponse {
-  string category_id = 1;
-  repeated Attribute attributes = 2;
-}
-
-message GetVerticalRequest {
-  string vertical_name = 1 [(buf.validate.field).string = {min_len: 1}];
-  Locale locale = 2 [(buf.validate.field).enum = {
-      defined_only: true
-  }];
-}
-message GetVerticalResponse {
-  Vertical vertical = 1;
-}

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

@@ -1,98 +0,0 @@
-syntax = "proto3";
-
-
-import "buf/validate/validate.proto";
-
-message CreateProductTypeRequest {
-    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.min_len = 1,
-      (buf.validate.field).string.max_len = 1000
-    ];
-
-    optional string tax_rate_id = 3 [
-      (buf.validate.field).string.min_len = 1,
-      (buf.validate.field).string.max_len = 100
-    ];
-
-    string vertical_name = 4 [
-      (buf.validate.field).string.min_len = 1,
-      (buf.validate.field).string.max_len = 100
-    ];
-}
-
-message CreateProductTypeResponse {
-    string id = 1;
-}
-
-message UpdateProductTypeRequest {
-    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.min_len = 1,
-      (buf.validate.field).string.max_len = 1000
-    ];
-
-    optional string tax_rate_id = 4 [
-      (buf.validate.field).string.min_len = 1,
-      (buf.validate.field).string.max_len = 100
-    ];
-
-    string vertical_name = 5 [
-      (buf.validate.field).string.min_len = 1,
-      (buf.validate.field).string.max_len = 100
-    ];
-}
-
-message UpdateProductTypeResponse {
-    string id = 1;
-}
-
-message DeleteProductTypeByIDRequest {
-    string id = 1 [
-      (buf.validate.field).string.min_len = 1,
-      (buf.validate.field).string.max_len = 100
-    ];
-}
-
-message DeleteProductTypeByIDResponse {}
-
-message GetProductTypeByIDRequest {
-    string id = 1 [
-      (buf.validate.field).string.min_len = 1,
-      (buf.validate.field).string.max_len = 100
-    ];
-}
-
-
-message GetProductTypeByIDResponse {
-    string id = 1;
-    string name = 2 [
-      (buf.validate.field).string.min_len = 1,
-      (buf.validate.field).string.max_len = 100
-    ];
-    string description = 3 [
-      (buf.validate.field).string.min_len = 1,
-      (buf.validate.field).string.max_len = 1000
-    ];
-    optional string tax_rate_id = 4 [
-      (buf.validate.field).string.min_len = 1,
-      (buf.validate.field).string.max_len = 100
-    ];
-    string vertical_name = 5 [
-      (buf.validate.field).string.min_len = 1,
-      (buf.validate.field).string.max_len = 100
-    ];
-}

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

@@ -1,127 +0,0 @@
-syntax = "proto3";
-
-
-import "buf/validate/validate.proto";
-import "src/proto/products/v1/entities/product/shared.proto";
-
-message AssociateVariantToInventoryRequest {
-    string variant_id = 1;
-    string inventory_id = 2;
-    string product_id = 3;
-    int32 required_quantity = 4;
-}
-
-message AssociateVariantToInventoryResponse {
-    Variant variant = 1;
-}
-
-message CreateVariantRequest {
-    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 = 2;
-        optional int32 min_quantity = 3;
-        optional int32 max_quantity = 4;
-        repeated Rule rules = 5;
-    }
-    message InventoryItem {
-        string inventory_item_id = 1;
-        optional int32 required_quantity = 2;
-    }
-    string product_id = 1;
-    optional string sku = 2;
-    string title = 3;
-    optional string ean = 4;
-    optional string upc = 5;
-    optional string barcode = 6;
-    optional string hs_code = 7;
-    optional string mid_code = 8;
-    optional bool allow_backorder = 9;
-    optional bool is_managed_inventory = 10;
-    optional int32 rank = 11;
-    optional float weight = 12;
-    optional float length = 13;
-    optional float height = 14;
-    optional float width = 15;
-    optional string origin_country = 16;
-    optional string material = 17;
-    map<string, string> options = 18;
-    map<string, string> metadata = 19;
-    repeated Price prices = 20;
-    repeated InventoryItem inventory_items = 21;
-}
-
-message CreateVariantResponse {
-    ProductResponse product = 1;
-}
-
-message PatchVariantImageRequest {
-    string product_id = 1;
-    string variant_id = 2;
-    repeated string saved_images = 3;
-    repeated string deleted_images = 4;
-}
-
-message PatchVariantImageResponse {
-    repeated string saved_images = 3;
-    repeated string deleted_images = 4;
-}
-
-message UpdateProductOptionRequest {
-    string product_id = 1;
-    string option_id = 2;
-    string title = 3;
-    repeated string values = 4;
-    map<string, string> metadata = 5;
-}
-
-message UpdateProductOptionResponse {
-    ProductResponse product = 1;
-}
-
-message UpdateVariantInventoryRequest {
-    string product_id = 1;
-    string variant_id = 2;
-    string inventory_item_id = 3;
-    int32 required_quantity = 4;
-}
-
-message UpdateVariantInventoryResponse {
-     Variant product_variant = 1;
-}
-
-message UpdateVariantRequest {
-    optional string product_id = 1;
-    optional string variant_id = 2;
-    optional string title = 3;
-    optional string ean = 4;
-    optional string upc = 5;
-    optional string barcode = 6;
-    optional string hs_code = 7;
-    optional string mid_code = 8;
-    optional bool allow_backorder = 9;
-    optional bool is_managed_inventory = 10;
-    optional int32 rank = 11;
-    optional float weight = 12;
-    optional float length = 13;
-    optional float height = 14;
-    optional float width = 15;
-    optional string origin_country = 16;
-    optional string material = 17;
-    map<string, string> options = 18;
-    map<string, string> metadata = 19;
-    repeated CreateVariantRequest.Price prices = 20;
-    repeated CreateVariantRequest.InventoryItem inventory_items = 21;
-}
-
-message UpdateVariantResponse {
-    ProductResponse product = 1;
-}

package/src/proto/products/v1/service.proto

@@ -1,78 +0,0 @@
-syntax = "proto3";
-
-package apps.enterprise.interfaces.rpc.products.v1;
-
-option go_package = "paakd.com/packages/api/gen/products/v1;productsv1";
-
-import "src/proto/products/v1/entities/category.proto";
-import "src/proto/products/v1/entities/tag.proto";
-import "src/proto/products/v1/entities/type.proto";
-import "src/proto/products/v1/entities/collection.proto";
-import "src/proto/products/v1/entities/taxonomy.proto";
-import "src/proto/products/v1/entities/product/create.proto";
-import "src/proto/products/v1/entities/product/update.proto";
-import "src/proto/products/v1/entities/product/option.proto";
-import "src/proto/products/v1/entities/variant.proto";
-
-service ProductsService {
-  rpc CreateCollection(CreateCollectionRequest) returns (CreateCollectionResponse) {}
-  rpc GetCollectionByID(GetCollectionByIDRequest) returns (GetCollectionByIDResponse) {
-       option idempotency_level = NO_SIDE_EFFECTS;
-  }
-  rpc UpdateCollection(UpdateCollectionRequest) returns (UpdateCollectionResponse) {}
-  rpc DeleteCollectionByID(DeleteCollectionByIDRequest) returns (DeleteCollectionByIDResponse) {}
-
-  rpc CreateProductType(CreateProductTypeRequest) returns (CreateProductTypeResponse) {}
-  rpc GetProductTypeByID(GetProductTypeByIDRequest) returns (GetProductTypeByIDResponse) {
-       option idempotency_level = NO_SIDE_EFFECTS;
-  }
-  rpc UpdateProductType(UpdateProductTypeRequest) returns (UpdateProductTypeResponse) {}
-  rpc DeleteProductTypeByID(DeleteProductTypeByIDRequest) returns (DeleteProductTypeByIDResponse) {}
-
-  rpc CreateProductCategory(CreateProductCategoryRequest) returns (CreateProductCategoryResponse) {}
-  rpc GetProductCategoryByID(GetProductCategoryByIDRequest) returns (GetProductCategoryByIDResponse) {
-       option idempotency_level = NO_SIDE_EFFECTS;
-  }
-  rpc UpdateProductCategory(UpdateProductCategoryRequest) returns (UpdateProductCategoryResponse) {}
-  rpc DeleteProductCategoryByID(DeleteProductCategoryByIDRequest) returns (DeleteProductCategoryByIDResponse) {}
-  rpc UpdateProductCategoryTaxonomy(UpdateProductCategoryTaxonomyRequest) returns (UpdateProductCategoryTaxonomyResponse) {}
-
-  rpc CreateTag(CreateTagRequest) returns (CreateTagResponse) {}
-  rpc GetTagByID(GetTagByIDRequest) returns (GetTagByIDResponse) {
-       option idempotency_level = NO_SIDE_EFFECTS;
-  }
-  rpc UpdateTag(UpdateTagRequest) returns (UpdateTagResponse) {}
-  rpc DeleteTagByID(DeleteTagByIDRequest) returns (DeleteTagByIDResponse) {}
-  rpc ListTags(ListTagsRequest) returns (ListTagsResponse) {
-       option idempotency_level = NO_SIDE_EFFECTS;
-  }
-
-  rpc SearchVerticals(SearchVerticalsRequest) returns (SearchVerticalsResponse) {}
-  rpc SearchCategory(SearchCategoryRequest) returns (SearchCategoryResponse) {}
-  rpc GetVertical(GetVerticalRequest) returns (GetVerticalResponse) {
-       option idempotency_level = NO_SIDE_EFFECTS;
-  }
-  rpc GetCategory(GetCategoryRequest) returns (GetCategoryResponse) {
-       option idempotency_level = NO_SIDE_EFFECTS;
-  }
-  rpc GetAttribute(GetAttributeRequest) returns (GetAttributeResponse) {
-       option idempotency_level = NO_SIDE_EFFECTS;
-  }
-  rpc GetCategoryAttributes(GetCategoryAttributesRequest) returns (GetCategoryAttributesResponse) {
-       option idempotency_level = NO_SIDE_EFFECTS;
-  }
-
-  rpc CreateProduct(CreateProductRequest) returns (CreateProductResponse) {}
-  rpc UpdateProduct(UpdateProductRequest) returns (UpdateProductResponse) {}
-  rpc AssociateVariantToInventory(AssociateVariantToInventoryRequest) returns (AssociateVariantToInventoryResponse) {}
-  rpc CreateOption(CreateOptionRequest) returns (CreateOptionResponse) {}
-  rpc CreateVariant(CreateVariantRequest) returns (CreateVariantResponse) {}
-  rpc PatchVariantImage(PatchVariantImageRequest) returns (PatchVariantImageResponse) {}
-  rpc UpdateProductOption(UpdateProductOptionRequest) returns (UpdateProductOptionResponse) {}
-  rpc UpdateVariantInventory(UpdateVariantInventoryRequest) returns (UpdateVariantInventoryResponse) {}
-  rpc UpdateVariant(UpdateVariantRequest) returns (UpdateVariantResponse) {}
-  rpc DeleteProduct(DeleteProductRequest) returns (DeleteProductResponse) {}
-  rpc DeleteVariant(DeleteVariantRequest) returns (DeleteVariantResponse) {}
-  rpc DeleteOption(DeleteOptionRequest) returns (DeleteOptionResponse) {}
-  rpc RemoveInventoryItem(RemoveInventoryItemRequest) returns (RemoveInventoryItemResponse) {}
-}

package/src/proto/promotions/v1/entities/campaign.proto

@@ -1,145 +0,0 @@
-syntax = "proto3";
-
-
-import "buf/validate/validate.proto";
-import "google/protobuf/timestamp.proto";
-
-enum CampaignBudgetType {
-    BUDGET_TYPE_SPEND = 0;
-    BUDGET_TYPE_USAGE = 1;
-}
-
-message CampaignBudget {
-    optional string id = 1;
-    int32 limit = 2 [
-      (buf.validate.field).required = true
-    ];
-    string currency_code = 3 [
-      (buf.validate.field).required = true
-    ];
-    CampaignBudgetType type = 4;
-    string attribute = 5;
-}
-
-message CreateCampaignRequest {
-    string name = 1 [
-      (buf.validate.field).required = true
-    ];
-    optional string campaign_identifier = 2;
-    optional string description = 3;
-    google.protobuf.Timestamp starts_at  = 4 [
-      (buf.validate.field).required = true
-    ];
-    google.protobuf.Timestamp ends_at = 5 [
-      (buf.validate.field).required = true
-    ];
-    CampaignBudget budget = 6;
-    repeated string promotion_ids = 7;
-}
-
-
-message CreateCampaignResponse {
-    string id = 1;
-    string name = 2;
-    string campaign_identifier = 3;
-    string description = 4;
-    google.protobuf.Timestamp starts_at  = 5;
-    google.protobuf.Timestamp ends_at = 6;
-    CampaignBudget budget = 7;
-    string currency_id = 8;
-}
-
-
-message ListCampaignsRequest {
-    int32 offset = 1 [
-      (buf.validate.field).int32.gte = 0
-    ];
-    uint32 limit = 2 [
-      (buf.validate.field).uint32.gte = 1,
-      (buf.validate.field).uint32.lte = 100
-    ];
-   optional string order_by = 3;
-   optional string filter = 4;
-   optional bool ascending = 5;
-   optional string request_path = 6;
-}
-
-message ListCampaignsResponse {
-  repeated CreateCampaignResponse campaigns = 1;
-}
-
-message GetCampaignRequest {
-    string id = 1 [
-      (buf.validate.field).required = true,
-      (buf.validate.field).string.pattern = "^[a-z]{3}[_][0-9a-hjkmnp-tv-z]{26}$"
-    ];
-}
-
-message GetCampaignResponse {
-    CreateCampaignResponse campaign = 1;
-}
-
-message AddPromotionsToCampaignRequest {
-    string campaign_id = 1 [
-      (buf.validate.field).required = true,
-      (buf.validate.field).string.pattern = "^[a-z]{3}[_][0-9a-hjkmnp-tv-z]{26}$"
-    ];
-    repeated string promotion_ids = 2 [
-      (buf.validate.field).required = true
-    ];
-}
-
-message AddPromotionsToCampaignResponse {
-    CreateCampaignResponse campaign = 1;
-}
-
-message RemovePromotionsFromCampaignRequest {
-    string campaign_id = 1 [
-      (buf.validate.field).required = true,
-      (buf.validate.field).string.pattern = "^[a-z]{3}[_][0-9a-hjkmnp-tv-z]{26}$"
-    ];
-    repeated string promotion_ids = 2 [
-      (buf.validate.field).required = true
-    ];
-}
-
-message RemovePromotionsFromCampaignResponse {
-    CreateCampaignResponse campaign = 1;
-}
-
-message DeleteCampaignRequest {
-    string id = 1 [
-      (buf.validate.field).required = true,
-      (buf.validate.field).string.pattern = "^[a-z]{3}[_][0-9a-hjkmnp-tv-z]{26}$"
-    ];
-}
-
-message DeleteCampaignResponse {
-    string id = 1;
-}
-
-message UpdateCampaignRequest {
-    string id = 1 [
-      (buf.validate.field).required = true,
-      (buf.validate.field).string.pattern = "^[a-z]{3}[_][0-9a-hjkmnp-tv-z]{26}$"
-    ];
-    optional string name = 2;
-    optional string campaign_identifier = 3;
-    optional string description = 4;
-    optional google.protobuf.Timestamp starts_at  = 5;
-    optional google.protobuf.Timestamp ends_at = 6;
-    optional CampaignBudget budget = 7;
-    optional string currency_id = 8;
-    repeated string promotion_ids = 9;
-}
-
-message UpdateCampaignResponse {
-    string id = 1;
-    string name = 2;
-    string campaign_identifier = 3;
-    string description = 4;
-    google.protobuf.Timestamp starts_at  = 5;
-    google.protobuf.Timestamp ends_at = 6;
-    CampaignBudget budget = 7;
-    string currency_id = 8;
-}

package/src/proto/promotions/v1/service.proto

@@ -1,17 +0,0 @@
-syntax = "proto3";
-
-package apps.enterprise.interfaces.rpc.promotions.v1;
-
-option go_package = "paakd.com/packages/api/gen/promotions/v1;promotionsv1";
-
-import "src/proto/promotions/v1/entities/campaign.proto";
-
-service CampaignService {
-    rpc CreateCampaign(CreateCampaignRequest) returns (CreateCampaignResponse);
-    rpc DeleteCampaign(DeleteCampaignRequest) returns (DeleteCampaignResponse);
-    rpc AddPromotionsToCampaign(AddPromotionsToCampaignRequest) returns (AddPromotionsToCampaignResponse);
-    rpc RemovePromotionsFromCampaign(RemovePromotionsFromCampaignRequest) returns (RemovePromotionsFromCampaignResponse);
-    rpc UpdateCampaign(UpdateCampaignRequest) returns (UpdateCampaignResponse);
-    rpc GetCampaign(GetCampaignRequest) returns (GetCampaignResponse);
-    rpc ListCampaigns(ListCampaignsRequest) returns (ListCampaignsResponse);
-}