@wix/bex-utils 1.28.0

package/@wix/ambassador-os-tags-v1-tag/build/es/rpc.impl.js

@@ -0,0 +1,68 @@
+import * as wrapper from './proto/proto-generated';
+var TagsService = wrapper.wix.os.v1.TagsService;
+/** Creates a Tag. */
+export function createTag(payload) {
+    var serviceArtifactId = 'com.wixpress.os.tags-service';
+    var serviceProtoClass = TagsService;
+    var methodName = 'createTag';
+    var requestData = payload;
+    return {
+        serviceProtoClass: serviceProtoClass,
+        serviceArtifactId: serviceArtifactId,
+        methodName: methodName,
+        requestData: requestData,
+    };
+}
+/** Retrieves a Tag. */
+export function getTag(payload) {
+    var serviceArtifactId = 'com.wixpress.os.tags-service';
+    var serviceProtoClass = TagsService;
+    var methodName = 'getTag';
+    var requestData = payload;
+    return {
+        serviceProtoClass: serviceProtoClass,
+        serviceArtifactId: serviceArtifactId,
+        methodName: methodName,
+        requestData: requestData,
+    };
+}
+/** Updates a Tag. */
+export function updateTag(payload) {
+    var serviceArtifactId = 'com.wixpress.os.tags-service';
+    var serviceProtoClass = TagsService;
+    var methodName = 'updateTag';
+    var requestData = payload;
+    return {
+        serviceProtoClass: serviceProtoClass,
+        serviceArtifactId: serviceArtifactId,
+        methodName: methodName,
+        requestData: requestData,
+    };
+}
+/** Deletes a Tag. */
+export function deleteTag(payload) {
+    var serviceArtifactId = 'com.wixpress.os.tags-service';
+    var serviceProtoClass = TagsService;
+    var methodName = 'deleteTag';
+    var requestData = payload;
+    return {
+        serviceProtoClass: serviceProtoClass,
+        serviceArtifactId: serviceArtifactId,
+        methodName: methodName,
+        requestData: requestData,
+    };
+}
+/** Retrieves a list of Tags */
+export function listTags(payload) {
+    var serviceArtifactId = 'com.wixpress.os.tags-service';
+    var serviceProtoClass = TagsService;
+    var methodName = 'listTags';
+    var requestData = payload;
+    return {
+        serviceProtoClass: serviceProtoClass,
+        serviceArtifactId: serviceArtifactId,
+        methodName: methodName,
+        requestData: requestData,
+    };
+}
+//# sourceMappingURL=rpc.impl.js.map

package/@wix/ambassador-os-tags-v1-tag/build/es/rpc.impl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc.impl.js","sourceRoot":"","sources":["../../rpc.impl.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,OAAO,MAAM,yBAAyB,CAAC;AAEnD,IAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,WAAW,CAAC;AAUlD,qBAAqB;AACrB,MAAM,UAAU,SAAS,CACvB,OAAyB;IAEzB,IAAM,iBAAiB,GAAW,8BAA8B,CAAC;IACjE,IAAM,iBAAiB,GAAuB,WAAW,CAAC;IAC1D,IAAM,UAAU,GAAW,WAAW,CAAC;IACvC,IAAM,WAAW,GAAqB,OAAO,CAAC;IAC9C,OAAO;QACL,iBAAiB,mBAAA;QACjB,iBAAiB,mBAAA;QACjB,UAAU,YAAA;QACV,WAAW,aAAA;KACZ,CAAC;AACJ,CAAC;AAED,uBAAuB;AACvB,MAAM,UAAU,MAAM,CACpB,OAAsB;IAEtB,IAAM,iBAAiB,GAAW,8BAA8B,CAAC;IACjE,IAAM,iBAAiB,GAAuB,WAAW,CAAC;IAC1D,IAAM,UAAU,GAAW,QAAQ,CAAC;IACpC,IAAM,WAAW,GAAkB,OAAO,CAAC;IAC3C,OAAO;QACL,iBAAiB,mBAAA;QACjB,iBAAiB,mBAAA;QACjB,UAAU,YAAA;QACV,WAAW,aAAA;KACZ,CAAC;AACJ,CAAC;AAED,qBAAqB;AACrB,MAAM,UAAU,SAAS,CACvB,OAAyB;IAEzB,IAAM,iBAAiB,GAAW,8BAA8B,CAAC;IACjE,IAAM,iBAAiB,GAAuB,WAAW,CAAC;IAC1D,IAAM,UAAU,GAAW,WAAW,CAAC;IACvC,IAAM,WAAW,GAAqB,OAAO,CAAC;IAC9C,OAAO;QACL,iBAAiB,mBAAA;QACjB,iBAAiB,mBAAA;QACjB,UAAU,YAAA;QACV,WAAW,aAAA;KACZ,CAAC;AACJ,CAAC;AAED,qBAAqB;AACrB,MAAM,UAAU,SAAS,CACvB,OAAyB;IAEzB,IAAM,iBAAiB,GAAW,8BAA8B,CAAC;IACjE,IAAM,iBAAiB,GAAuB,WAAW,CAAC;IAC1D,IAAM,UAAU,GAAW,WAAW,CAAC;IACvC,IAAM,WAAW,GAAqB,OAAO,CAAC;IAC9C,OAAO;QACL,iBAAiB,mBAAA;QACjB,iBAAiB,mBAAA;QACjB,UAAU,YAAA;QACV,WAAW,aAAA;KACZ,CAAC;AACJ,CAAC;AAED,+BAA+B;AAC/B,MAAM,UAAU,QAAQ,CACtB,OAAwB;IAExB,IAAM,iBAAiB,GAAW,8BAA8B,CAAC;IACjE,IAAM,iBAAiB,GAAuB,WAAW,CAAC;IAC1D,IAAM,UAAU,GAAW,UAAU,CAAC;IACtC,IAAM,WAAW,GAAoB,OAAO,CAAC;IAC7C,OAAO;QACL,iBAAiB,mBAAA;QACjB,iBAAiB,mBAAA;QACjB,UAAU,YAAA;QACV,WAAW,aAAA;KACZ,CAAC;AACJ,CAAC"}

package/@wix/ambassador-os-tags-v1-tag/build/es/types.impl.d.ts

@@ -0,0 +1,73 @@
+export interface Tag {
+    /**
+     * Tag ID.
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Revision number.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the Tag was created.
+     * @readonly
+     */
+    createdDate?: Date;
+    /**
+     * Date and time the Tag was last updated.
+     * @readonly
+     */
+    updatedDate?: Date;
+    /** Tag name */
+    name?: string | null;
+    /** FQDN of the entity that belongs to this tag */
+    fqdn?: string | null;
+    /** Tag exposure */
+    exposure?: TagExposure;
+}
+export declare enum TagExposure {
+    UNKNOWN = "UNKNOWN",
+    PRIVATE = "PRIVATE",
+    PUBLIC = "PUBLIC"
+}
+export interface CreateTagRequest {
+    /** Tag to be created. */
+    tag: Tag;
+}
+export interface CreateTagResponse {
+    /** The created Tag. */
+    tag?: Tag;
+}
+export interface GetTagRequest {
+    /** ID of the Tag to retrieve. */
+    tagId: string;
+}
+export interface GetTagResponse {
+    /** The requested Tag. */
+    tag?: Tag;
+}
+export interface UpdateTagRequest {
+    /** Tag to be updated, may be partial. */
+    tag: Tag;
+}
+export interface UpdateTagResponse {
+    /** Updated Tag. */
+    tag?: Tag;
+}
+export interface DeleteTagRequest {
+    /** Id of the Tag to delete. */
+    tagId: string;
+}
+export interface DeleteTagResponse {
+}
+export interface ListTagsRequest {
+    /** FQDN */
+    fqdn: string;
+    /** Exposure */
+    exposure?: TagExposure;
+}
+export interface ListTagsResponse {
+    /** List of Tags. */
+    tags?: Tag[];
+}

package/@wix/ambassador-os-tags-v1-tag/build/es/types.impl.js

@@ -0,0 +1,7 @@
+export var TagExposure;
+(function (TagExposure) {
+    TagExposure["UNKNOWN"] = "UNKNOWN";
+    TagExposure["PRIVATE"] = "PRIVATE";
+    TagExposure["PUBLIC"] = "PUBLIC";
+})(TagExposure || (TagExposure = {}));
+//# sourceMappingURL=types.impl.js.map

package/@wix/ambassador-os-tags-v1-tag/build/es/types.impl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.impl.js","sourceRoot":"","sources":["../../types.impl.ts"],"names":[],"mappings":"AA6BA,MAAM,CAAN,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,kCAAmB,CAAA;IACnB,gCAAiB,CAAA;AACnB,CAAC,EAJW,WAAW,KAAX,WAAW,QAItB"}

package/@wix/ambassador-os-tags-v1-tag/builders/package.json

@@ -0,0 +1,7 @@
+{
+  "private": true,
+  "main": "../build/cjs/builders.impl",
+  "types": "../build/cjs/builders.impl.d.ts",
+  "sideEffects": false,
+  "module": "../build/es/builders.impl"
+}

package/@wix/ambassador-os-tags-v1-tag/crud/http/package.json

@@ -0,0 +1,7 @@
+{
+  "private": true,
+  "main": "../../build/cjs/crud/http.impl",
+  "types": "../../build/cjs/crud/http.impl.d.ts",
+  "sideEffects": false,
+  "module": "../../build/es/crud/http.impl"
+}

package/@wix/ambassador-os-tags-v1-tag/crud/rpc/package.json

@@ -0,0 +1,6 @@
+{
+  "private": true,
+  "main": "../../build/cjs/crud/rpc.impl",
+  "types": "../../build/cjs/crud/rpc.impl.d.ts",
+  "sideEffects": false
+}

package/@wix/ambassador-os-tags-v1-tag/http/package.json

@@ -0,0 +1,7 @@
+{
+  "private": true,
+  "main": "../build/cjs/http.impl",
+  "types": "../build/cjs/http.impl.d.ts",
+  "sideEffects": false,
+  "module": "../build/es/http.impl"
+}

package/@wix/ambassador-os-tags-v1-tag/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@wix/ambassador-os-tags-v1-tag",
+  "version": "1.0.3",
+  "publishConfig": {
+    "registry": "https://npm.dev.wixpress.com/",
+    "access": "restricted"
+  },
+  "files": [
+    "build",
+    "http",
+    "rpc",
+    "builders",
+    "types",
+    "validators",
+    "crud/!(*.ts)",
+    "src/main/proto"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "yarn proto && yarn tsc && cp -r proto build/cjs",
+    "proto": "wix-proto-codegen --module . --dir proto --stringEnums --tsClasses --stringLongs",
+    "tsc": "tsc -b tsconfig.json tsconfig.esm.json",
+    "test": ":"
+  },
+  "dependencies": {
+    "@wix/metro-common-builders": "^1.0.0",
+    "@wix/metro-runtime": "^1.0.0",
+    "joi": "^17.0.0",
+    "callsite": "^1.0.0",
+    "@wix/auto-crud": "^1.0.0"
+  },
+  "devDependencies": {
+    "@wix/http-client": "^1.0.0",
+    "@types/callsite": "^1.0.0"
+  },
+  "wix": {
+    "artifact": {
+      "artifactId": "os-tags-v1-tag",
+      "groupId": "com.wixpress.metro-packages"
+    },
+    "ambassador": {
+      "fqdn": "wix.os.tags.v1.tag",
+      "protoArtifactId": "com.wixpress.os:tags-service"
+    }
+  },
+  "falconPackageHash": "88ff0e294fbd53286b75e35e3467d842cfb3521ebd2b6472a3918c19",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/wix-private/metro-packages.git",
+    "directory": "packages/ambassador/os-tags-v1-tag"
+  }
+}

package/@wix/ambassador-os-tags-v1-tag/rpc/package.json

@@ -0,0 +1,6 @@
+{
+  "private": true,
+  "main": "../build/cjs/rpc.impl",
+  "types": "../build/cjs/rpc.impl.d.ts",
+  "sideEffects": false
+}

package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/api/action_payload.proto

@@ -0,0 +1,33 @@
+syntax = "proto2";
+
+package wix.api;
+
+import "google/protobuf/descriptor.proto";
+
+option java_multiple_files = true;
+option java_outer_classname = "ActionPayloadProto";
+option java_package = "com.wix.api";
+
+/*
+action_payload option is used to configure custom slugs for the payload type of a DomainEvent Action:
+service BlooperService {
+   option (wix.api.service_entity).message = "com.wixpress.examples.Blooper"; //the "main" entity
+   rpc MissedBlooper (MissedBlooperRequest) returns (MissedBlooperResponse) {
+       option (wix.api.callback) = {
+           event_type: Action
+           payload: "com.wixpress.examples.BlooperWasMissed"
+       };
+   };
+}
+message BlooperWasMissed {
+   option (wix.api.action_payload).custom_slug = "super_custom_slug"; // only define if the default slug value (snake case of the message name) is out of the question
+    int32 how_funny_it_could_have_been = 1;
+}
+*/
+extend google.protobuf.MessageOptions {
+    optional ActionPayload action_payload = 50600;
+}
+
+message ActionPayload {
+    optional string custom_slug = 1;
+}

package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/api/annotations.proto

@@ -0,0 +1,360 @@
+syntax = "proto2";
+
+package wix.api;
+
+import "google/protobuf/descriptor.proto";
+
+option java_multiple_files = true;
+option java_outer_classname = "AnnotationsProto";
+option java_package = "com.wix.api";
+
+extend google.protobuf.ServiceOptions {
+    optional Maturity service_maturity = 50104;
+    optional Exposure service_exposure = 50105;
+    optional Deprecated service_deprecated = 50140; // mark a service as deprecated, optionally place replacing asset
+    repeated ServiceAppendix appendix_files = 50150; // declare external configuration info
+}
+
+extend google.protobuf.MethodOptions {
+    optional Exposure exposure = 50101;
+    optional Maturity maturity = 50102;
+    optional CacheSettings cacheable = 50103; // mark a method as cacheable, optionally pass max cache age
+    optional Deprecated deprecated = 50141; // mark a method as deprecated, optionally place replacing asset
+    optional Crud crud = 50146; // mark crud method type and describe related information about this method
+    optional Hookable hookable = 50147;
+    optional bool accepts_linguist = 50148; // marks that this method accepts `x-wix-linguist` header, MAY return translated/localized responses. without this option, requests that assign this header will get an error. CRUD annotated methods assumed to have this enabled for read ops and disabled for write ops.
+}
+
+extend google.protobuf.MessageOptions {
+    optional string decomposite_of = 50120; // mark it a shard of a message to remove fields
+    repeated FieldSet decomposition_minimum_fields = 50121; // constrain that sharding at the definition
+    optional bool unwrap_array_value = 50122; // mark message as wrapper for arrays
+    optional Deprecated message_deprecated = 50142; // mark a message as deprecated, optionally place replacing asset
+    repeated Unique unique = 50145; // mark unique identifiers for this message
+}
+
+extend google.protobuf.FieldOptions {
+    optional Exposure field_exposure = 50106;
+    optional Maturity field_maturity = 50107;
+    optional bool pii = 50110; // Mark specific field as PII so clients that store the data know it should be encrypted
+    optional string referenced_entity = 50111; // FQDN of foreign keys. For example, an Order message that points to Product message can use it like this: `string product_id = 10 [(wix.api.referenced_entity) = "wix.stores.catalog.v1.product"];`
+    optional ReferenceEntityField referenced_entity_field = 50112; // FQDN and path of a field that is referenced by `referenced_entity`. Should be located at same level or in a nested message with relation to `wix.api.referenced_entity`.
+    optional Deprecated field_deprecated = 50143; // Mark a field as deprecated, optionally place replacing asset
+    optional Translatable translatable = 50144; // Mark this field as translatable using MultiLingual services
+    optional string sample_data = 50149; // Example of data that may be assigned as a value of this field
+    optional Conditional conditional = 50151; // Configure the conditions required for this field to be returned
+}
+
+extend google.protobuf.EnumValueOptions {
+    optional Maturity enum_maturity = 50130;
+    optional Exposure enum_exposure = 50131;
+}
+
+message ReferenceEntityField {
+    required string path = 1; // field path from root of a message annotated with `wix.api.entity` annotation. For example 'item.name'.
+}
+
+message CacheSettings {
+    optional int32 max_age_seconds = 1; // default is 604800 seconds = 1 week
+}
+
+message FieldSet {
+    repeated string field = 1;
+}
+
+message Deprecated {
+    optional string replaced_by = 1; // use relative proto FQN as absolute identifier. e.g. "wix.common.Query"
+    optional string target_removal_date = 2; // a human readable sunset date of the deprecated resource YYYY-MM-DD
+}
+
+message Unique {
+    repeated string field = 1;
+}
+
+message Crud {
+    enum Method {
+        UNKNOWN_METHOD = 0;
+        CREATE = 1;
+        GET_ITEM = 2;
+        UPDATE = 3;
+        DELETE = 4;
+        UPSERT = 12;
+        LIST = 5;
+        QUERY = 6;
+        SEARCH = 18;
+        BULK_CREATE = 7;
+        BULK_UPDATE = 8;
+        BULK_UPDATE_BY_FILTER = 9;
+        BULK_DELETE = 10;
+        BULK_DELETE_BY_FILTER = 11;
+        BULK_UPSERT = 13;
+        LIST_DELETED = 14;
+        GET_DELETED = 15;
+        RESTORE_FROM_TRASHBIN = 16;
+        REMOVE_FROM_TRASHBIN = 17;
+        COUNT = 19;
+    }
+    required Method method = 1; // method type
+    oneof method_options {
+        CreateMethodOptions create_options = 3;
+        GetItemMethodOptions get_options = 4;
+        UpdateMethodOptions update_options = 5;
+        DeleteMethodOptions delete_options = 6;
+        ListMethodOptions list_options = 7;
+        QueryMethodOptions query_options = 8;
+        SearchMethodOptions search_options = 20;
+        BulkCreateMethodOptions bulk_create_options = 9;
+        BulkUpdateMethodOptions bulk_update_options = 10;
+        BulkUpdateByFilterMethodOptions bulk_update_by_filter_options = 11;
+        BulkDeleteMethodOptions bulk_delete_options = 12;
+        BulkDeleteByFilterMethodOptions bulk_delete_by_filter_options = 13;
+        UpsertMethodOptions upsert_options = 14;
+        BulkUpsertMethodOptions bulk_upsert_options = 15;
+        ListDeletedMethodOptions list_deleted_options = 16;
+        GetDeletedMethodOptions get_deleted_options = 17;
+        RestoreFromTrashbinMethodOptions restore_from_trashbin_options = 18;
+        RemoveFromTrashbinMethodOptions remove_from_trashbin_options = 19;
+        CountOptions count_options = 21;
+    }
+}
+
+message Paging {
+    enum Type {
+        UNKNOWN_TYPE = 0;
+        OFFSET = 1;
+        CURSOR = 2;
+    }
+    optional Type type = 1; // paging type
+    optional string paging_metadata_field = 2; // paging field name in response object. default is `metadata`
+}
+
+message CreateMethodOptions {
+    optional string item_field = 1; // item field name in request and response objects. default is `<entity-name>`
+}
+
+message GetItemMethodOptions {
+    optional string item_field = 2; // item field name in response object only. default is `<entity-name>`
+    optional string id_field = 1; // id field name in request object. default is `<entity-name>_id`
+}
+
+message UpdateMethodOptions {
+    optional string item_field = 1; // item field name in request and response objects. default is `<entity-name>`
+    optional string fieldmask_field = 2; // fieldmask field name in request object. default is `fieldmask`, only if it really exists in model
+}
+
+message UpsertMethodOptions {
+    optional string item_field = 1; // item field name in request and response objects. default is `<entity-name>`
+    optional string fieldmask_field = 2; // fieldmask field name in request object. default is `fieldmask`, only if it really exists in model
+}
+
+message DeleteMethodOptions {
+    optional string id_field = 1; // id field name in request object. default is `<entity-name>_id`
+}
+
+message ListMethodOptions {
+    optional string ids_field = 1; // ids field name in request object if such exists. recommended field-name: `<entity-name>_ids`
+    required string items_field = 3; // items field name in response object.
+    optional Paging paging = 2; // present paging mechanism info, default will be of type=`CURSOR`
+    repeated string me_aliasable_field = 4; // collection of FQNs of fields that MAY be aliased with the const `"me"`
+}
+
+message QueryMethodOptions {
+    optional string query_field = 1; // query field name in request object. default is `query`
+    required string items_field = 3; // items field name in response object.
+    optional Paging paging = 2; // present paging mechanism info, default will be of type=`CURSOR`
+    required Wql wql = 4; // mark fields that are available for filtering and sorting via WixQueryLanguage
+    repeated string me_aliasable_field = 5; // collection of FQNs of fields that MAY be aliased with the const `"me"`
+}
+
+message SearchMethodOptions {
+    optional string search_field = 1; // search field name in request object. default is `search`
+    required string items_field = 3; // items field name in response object.
+    optional Paging paging = 2; // present paging mechanism info, default will be of type=`CURSOR`
+    required Wql wql = 4; // mark fields that are available for filtering and sorting via WixQueryLanguage
+    repeated string me_aliasable_field = 5; // collection of FQNs of fields that MAY be aliased with the const `"me"`
+    repeated Search search = 6; // mark fields that are available for search
+    repeated Aggregation aggregation = 7; // mark fields that are available for aggregation
+}
+
+message BulkCreateMethodOptions {
+    optional string item_field = 1; // item field name in request and response objects. default is `<entity-name>`
+}
+
+message BulkUpdateMethodOptions {
+    optional string item_field = 1; // item field name in request and response objects. default is `<entity-name>`
+    optional string fieldmask_field = 2; // fieldmask field name in request object. default is `fieldmask`, only if it really exists in model
+}
+
+message BulkUpdateByFilterMethodOptions {
+    optional string item_field = 1; // item field name in request and response objects. default is `<entity-name>`
+    optional string fieldmask_field = 2; // fieldmask field name in request object. default is `fieldmask`, only if it really exists in model
+    optional string filter_field = 3; // filter field name in request object. default is `filter`
+}
+
+message BulkUpsertMethodOptions {
+    optional string item_field = 1; // item field name in request and response objects. default is `<entity-name>`
+    optional string fieldmask_field = 2; // fieldmask field name in request object. default is `fieldmask`, only if it really exists in model
+}
+
+message BulkDeleteMethodOptions {
+    optional string ids_field = 1; // ids field name in request object. default is `<entity-name>_ids`
+}
+
+message BulkDeleteByFilterMethodOptions {
+    optional string filter_field = 1; // filter field name in request object. default is `filter`
+}
+
+message ListDeletedMethodOptions {
+    optional string ids_field = 1; // ids field name in request object if such exists. recommended field-name: `<entity-name>_ids`
+    required string items_field = 3; // items field name in response object.
+    optional Paging paging = 2; // present paging mechanism info, default will be of type=`CURSOR`
+    repeated string me_aliasable_field = 4; // collection of FQNs of fields that MAY be aliased with the const `"me"`
+}
+
+message GetDeletedMethodOptions {
+    optional string item_field = 2; // item field name in response object only. default is `<entity-name>`
+    optional string id_field = 1; // id field name in request object. default is `<entity-name>_id`
+}
+
+message RestoreFromTrashbinMethodOptions {
+    optional string item_field = 2; // item field name in response object only. default is `<entity-name>`
+    optional string id_field = 1; // id field name in request object. default is `<entity-name>_id`
+}
+
+message RemoveFromTrashbinMethodOptions {
+    optional string id_field = 1; // id field name in request object. default is `<entity-name>_id`
+}
+
+message CountOptions {
+    // The name of the endpoint that the count "copy" the WQL settings from - e.g inherit_wql_from: 'QueryProducts'
+    // Usually, that will be the query endpoint since you want the same filter capbilities for query and count
+    optional string inherit_wql_from = 1; 
+}
+
+message Wql {
+    enum Operator {
+        option allow_alias = true;
+        ALL_APPLICABLE_OPERATORS = 0; // Applicable by type. i.e. if we allow LT/GT for **, it means for numeric fields only.
+        EQ = 1; // [Comparison] Matches values that are equal to a specified value.
+        GT = 2; // [Comparison] Matches values that are greater than a specified value.
+        GTE = 3; // [Comparison] Matches values that are greater than or equal to a specified value.
+        IN = 4; // [Comparison] Matches any of the values specified in an array.
+        LT = 5; // [Comparison] Matches values that are less than a specified value.
+        LTE = 6; // [Comparison] Matches values that are less than or equal to a specified value.
+        NE = 7; // [Comparison] Matches all values that are not equal to a specified value.
+        NIN = 8; // [Comparison] Matches none of the values specified in an array.
+        BEGINS = 9; // [Comparison] Matches strings that begin with a specified value (NOT case sensitive).
+        EXISTS = 10; // [Element] Matches documents that have the specified field.
+        ALL = 11 [deprecated = true]; // [Array] Matches arrays that contain all elements specified in the query.
+        HAS_ALL = 11; // [Array] Matches arrays that contain all elements specified in the query.
+        ANY = 12 [deprecated = true]; // [Array] Matches arrays that contain at least one element specified in the query.
+        HAS_SOME = 12; // [Array] Matches arrays that contain at least one element specified in the query.
+        EMPTY = 13; // [Array] Matches arrays that contain no elements.
+        MATCH_ALL = 14; // [Array] match multiple fields within array with AND operator semantics.
+    }
+    enum Sort {
+        NONE = 0; // no sorting enabled
+        ASC = 1; // ascending sort is supported
+        DESC = 2; // descending sort is supported
+        BOTH = 3; // sort is supported in both directions
+    }
+    message RequiredFields {
+        // this field is deprecated because we need sort direction alongside to field path
+        repeated string field = 1[(.wix.api.field_deprecated) = {
+            replaced_by: "required_field"
+            target_removal_date: "2023-03-31"
+        }];
+        message RequiredField {
+            required string path = 1; // a field path that that accepts this operator
+            optional Sort sort = 2; // sort type enabled for this glob
+        }
+        repeated RequiredField required_field = 2; // all required field configurations to satisfy composite index
+    }
+    message OperatorFieldSupport {
+        repeated Operator operator = 1; // Operators supported for fields that match the glob
+        // this field is deprecated because glob is hard to read. moved to a direct field config approach
+        optional string glob = 2 [(.wix.api.field_deprecated) = {
+            replaced_by: "field"
+            target_removal_date: "2023-03-31"
+        }];
+        repeated string field = 5; // a collection of field paths that that accepts this operator
+        optional Sort sort = 3; // sort type enabled for this glob
+        repeated RequiredFields required_fields = 4; // fields that match this glob, can be used only if the query is also filtered by required_fields
+        optional Maturity maturity = 6;
+    }
+    // this field is deprecated due to a better and shorter naming
+    repeated OperatorFieldSupport operator_field_support = 3 [(.wix.api.field_deprecated) = {
+        replaced_by: "pattern"
+        target_removal_date: "2023-03-31"
+    }];
+    repeated OperatorFieldSupport pattern = 4; // supported operators for subject query method
+}
+
+message Search {
+    repeated string field = 1; // a collection of field paths that supports Free Text Search
+    optional Maturity maturity = 2;
+}
+
+message Aggregation {
+    repeated string field = 1; // a collection of field paths that supports aggregations
+    optional Maturity maturity = 2;
+}
+
+
+message Hookable {
+}
+
+message Translatable {
+    enum Type {
+        UNDEFINED_TYPE = 0 [(.wix.api.enum_maturity) = NOT_IMPLEMENTED];
+        SHORT_TEXT = 1;
+        LONG_TEXT = 2;
+        RICH_TEXT = 3;
+        RICH_CONTENT_EDITOR = 4;
+        SELECTION = 5;
+        MULTI_SELECTION = 6;
+        DOCUMENT = 7;
+        IMAGE = 8;
+        VIDEO = 9;
+        IMAGE_LINK = 10; // Image URI without metadata
+    }
+    optional string name = 1; // a human friendly field name
+    optional bool hidden = 2; // is this translatable field hidden in Multilingual
+    optional string grouping = 3; // fields in schema may be grouped under meaningful topic or category of the source entity
+    required Type type = 4; // translation input component type e.g. "freetext", "dropdown", etc..
+    optional bool display_only = 5; // is this field for preview and not translatable
+}
+
+message Conditional {
+    optional string permission = 1; // field will not be returned by the server, unless the client has this permission. If `requested_field` is also set, and a client explicitly requests this field but does not have permission, server will return 403-Forbidden error
+    optional string requested_field = 2; // field will not be returned by the server, unless the client explicitly requested it using `fields` parameter in the request, with the enum value specified by this annotation
+}
+
+message ServiceAppendix {
+    enum Type {
+        UNKNOWN_APPENDIX_TYPE = 0;
+        NILE = 1; // Nile(tm) FW configuration
+        MESSAGE_BUS = 2; // wix message bus / pub-sub configuration
+    }
+    required Type type = 1; // appendix type
+    required string path = 2; // absolute from module root
+}
+
+// Defines the target audience of your API
+// @see https://bo.wix.com/wix-docs/rnd/p13n-guidelines---aips/guidance-aips/api-lifecycle/[2005]-exposure
+enum Exposure {
+    // This API should only be used by your team. By default, no documentation is generated, but you can generate your own documentation using the Wix Docs Local Preview
+    PRIVATE = 0;
+    // Every Wix developer can use your API. Documentation is exposed automatically to Wix Internal Docs and will be visible to all Wix employees. When first exposing it, contact your API Master to review your API and remove it from the Draft category.
+    INTERNAL = 1;
+    // Anyone using the Wix Ecosystem can use this API. Documentation is exposed automatically to both Wix Internal Docs and to Wix Public Docs.
+    PUBLIC = 2;
+}
+
+enum Maturity {
+    ALPHA = 0;
+    BETA = 1;
+    IA = 2 [deprecated=true];
+    GA = 3;
+    NOT_IMPLEMENTED = 4;
+}