@wix/data-extension-schema 1.0.0

package/type-bundles/meta.bundle.d.ts

@@ -0,0 +1,371 @@
+interface DataExtensionSchema$1 {
+    /**
+     * Schema ID.
+     * @readonly
+     */
+    id?: string | null;
+    /** FQDN of the entity this schema extends. */
+    fqdn?: string | null;
+    /**
+     * Namespace for this schema. For example, an app creating schemas might use their app name as a namespace.
+     * When a site owner creates a user-defined schema, the namespace is: `_user_fields`.
+     */
+    namespace?: string | null;
+    /**
+     * Schema definition in [JSON schema format](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/the-json-schema) with the following [vocab](https://docs.json-everything.net/schema/vocabs/) extension:
+     * ```
+     * {
+     * "$schema": "https://json-schema.org/draft/2020-12/schema",
+     * "$id": "https://wixapis.com/v1/json-schema/extensions",
+     * "$vocabulary": {
+     * "https://wixapis.com/v1/json-schema/extensions/vocab/data-extensions": true
+     * },
+     * "$dynamicAnchor": "meta",
+     * "title": "Wix' data-extensions vocabulary meta schema",
+     * "type": [
+     * "object",
+     * "boolean"
+     * ],
+     * "properties": {
+     * "x-wix-permissions": {
+     * "type": "object",
+     * "description": "list of identity types that are allowed reading schema properties",
+     * "properties": {
+     * "read": {
+     * "type": "array",
+     * "items": {
+     * "type": "string",
+     * "enum": [
+     * "apps",
+     * "owning-app",
+     * "users",
+     * "users-of-users"
+     * ]
+     * }
+     * },
+     * "write": {
+     * "type": "array",
+     * "items": {
+     * "type": "string",
+     * "enum": [
+     * "apps",
+     * "owning-app",
+     * "users",
+     * "users-of-users"
+     * ]
+     * }
+     * }
+     * }
+     * },
+     * "x-wix-display": {
+     * "type": "object",
+     * "description": "field display properties",
+     * "schema": {
+     * "properties": {
+     * "placeholder": {
+     * "type": "string",
+     * "maxLength": 255,
+     * "description": "placeholder text for input fields"
+     * },
+     * "label": {
+     * "type": "string",
+     * "maxLength": 255,
+     * "description": "label of the input fields"
+     * },
+     * "hint": {
+     * "type": "string",
+     * "maxLength": 255,
+     * "description": "a short explanation that appears next to the input field"
+     * }
+     * }
+     * }
+     * }
+     * }
+     * }
+     * ```
+     */
+    jsonSchema?: Record<string, any> | null;
+    /**
+     * Date and time the schema was last updated.
+     * @readonly
+     */
+    updatedDate?: Date;
+    /**
+     * Date and time the schema was created.
+     * @readonly
+     */
+    createdDate?: Date;
+    /**
+     * Revision number, which increments by 1 each time the schema is updated. To prevent conflicting changes, the existing revision must be used when updating a schema.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Maximum allowed schema size in bytes.
+     * @readonly
+     */
+    maxLimitBytes?: number | null;
+    /**
+     * Current schema size in bytes.
+     * @readonly
+     */
+    currentSizeBytes?: number | null;
+    /** Name of the specific entity field this schema is extending, or `"ROOT"` for extensions for the entire entity. Default: `"ROOT"`. */
+    extensionPoint?: string;
+}
+interface CreateDataExtensionSchemaRequest$1 {
+    /** Schema to create. */
+    dataExtensionSchema: DataExtensionSchema$1;
+}
+interface CreateDataExtensionSchemaResponse$1 {
+    /** Created schema. */
+    dataExtensionSchema?: DataExtensionSchema$1;
+}
+interface UpdateDataExtensionSchemaRequest$1 {
+    /** Schema to update. */
+    dataExtensionSchema?: DataExtensionSchema$1;
+}
+interface UpdateDataExtensionSchemaResponse$1 {
+    /** Updated schema. */
+    dataExtensionSchema?: DataExtensionSchema$1;
+}
+interface ListDataExtensionSchemasRequest$1 {
+    /** [Fully qualified domain name](https://dev.wix.com/docs/rest/articles/getting-started/fqdns). */
+    fqdn: string;
+    /** Namespaces within the given entity. */
+    namespaces?: string[];
+    /** Additional fields that are hidden by default. For example, fields with `"x-wix-archived": true`. */
+    fields?: RequestedField$1[];
+}
+declare enum RequestedField$1 {
+    /** Doesn't do anything */
+    UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
+    /** Returns `x-wix-archived` fields in `DataExtensionSchema.json_schema`. */
+    ARCHIVED = "ARCHIVED"
+}
+interface ListDataExtensionSchemasResponse$1 {
+    /** Requested schemas. */
+    dataExtensionSchemas?: DataExtensionSchema$1[];
+}
+interface DeleteByWhiteListedMetaSiteRequest$1 {
+    /** Meta site id */
+    metaSiteId: string;
+}
+interface DeleteByWhiteListedMetaSiteResponse$1 {
+    /** has more */
+    hasMore?: boolean;
+}
+interface DataExtensionSchemaNonNullableFields$1 {
+    extensionPoint: string;
+}
+interface CreateDataExtensionSchemaResponseNonNullableFields$1 {
+    dataExtensionSchema?: DataExtensionSchemaNonNullableFields$1;
+}
+interface UpdateDataExtensionSchemaResponseNonNullableFields$1 {
+    dataExtensionSchema?: DataExtensionSchemaNonNullableFields$1;
+}
+interface ListDataExtensionSchemasResponseNonNullableFields$1 {
+    dataExtensionSchemas: DataExtensionSchemaNonNullableFields$1[];
+}
+interface DeleteByWhiteListedMetaSiteResponseNonNullableFields$1 {
+    hasMore: boolean;
+}
+
+interface DataExtensionSchema {
+    /**
+     * Schema ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /** FQDN of the entity this schema extends. */
+    fqdn?: string | null;
+    /**
+     * Namespace for this schema. For example, an app creating schemas might use their app name as a namespace.
+     * When a site owner creates a user-defined schema, the namespace is: `_user_fields`.
+     */
+    namespace?: string | null;
+    /**
+     * Schema definition in [JSON schema format](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/the-json-schema) with the following [vocab](https://docs.json-everything.net/schema/vocabs/) extension:
+     * ```
+     * {
+     * "$schema": "https://json-schema.org/draft/2020-12/schema",
+     * "$id": "https://wixapis.com/v1/json-schema/extensions",
+     * "$vocabulary": {
+     * "https://wixapis.com/v1/json-schema/extensions/vocab/data-extensions": true
+     * },
+     * "$dynamicAnchor": "meta",
+     * "title": "Wix' data-extensions vocabulary meta schema",
+     * "type": [
+     * "object",
+     * "boolean"
+     * ],
+     * "properties": {
+     * "x-wix-permissions": {
+     * "type": "object",
+     * "description": "list of identity types that are allowed reading schema properties",
+     * "properties": {
+     * "read": {
+     * "type": "array",
+     * "items": {
+     * "type": "string",
+     * "enum": [
+     * "apps",
+     * "owning-app",
+     * "users",
+     * "users-of-users"
+     * ]
+     * }
+     * },
+     * "write": {
+     * "type": "array",
+     * "items": {
+     * "type": "string",
+     * "enum": [
+     * "apps",
+     * "owning-app",
+     * "users",
+     * "users-of-users"
+     * ]
+     * }
+     * }
+     * }
+     * },
+     * "x-wix-display": {
+     * "type": "object",
+     * "description": "field display properties",
+     * "schema": {
+     * "properties": {
+     * "placeholder": {
+     * "type": "string",
+     * "maxLength": 255,
+     * "description": "placeholder text for input fields"
+     * },
+     * "label": {
+     * "type": "string",
+     * "maxLength": 255,
+     * "description": "label of the input fields"
+     * },
+     * "hint": {
+     * "type": "string",
+     * "maxLength": 255,
+     * "description": "a short explanation that appears next to the input field"
+     * }
+     * }
+     * }
+     * }
+     * }
+     * }
+     * ```
+     */
+    jsonSchema?: Record<string, any> | null;
+    /**
+     * Date and time the schema was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+    /**
+     * Date and time the schema was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Revision number, which increments by 1 each time the schema is updated. To prevent conflicting changes, the existing revision must be used when updating a schema.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Maximum allowed schema size in bytes.
+     * @readonly
+     */
+    maxLimitBytes?: number | null;
+    /**
+     * Current schema size in bytes.
+     * @readonly
+     */
+    currentSizeBytes?: number | null;
+    /** Name of the specific entity field this schema is extending, or `"ROOT"` for extensions for the entire entity. Default: `"ROOT"`. */
+    extensionPoint?: string;
+}
+interface CreateDataExtensionSchemaRequest {
+    /** Schema to create. */
+    dataExtensionSchema: DataExtensionSchema;
+}
+interface CreateDataExtensionSchemaResponse {
+    /** Created schema. */
+    dataExtensionSchema?: DataExtensionSchema;
+}
+interface UpdateDataExtensionSchemaRequest {
+    /** Schema to update. */
+    dataExtensionSchema?: DataExtensionSchema;
+}
+interface UpdateDataExtensionSchemaResponse {
+    /** Updated schema. */
+    dataExtensionSchema?: DataExtensionSchema;
+}
+interface ListDataExtensionSchemasRequest {
+    /** [Fully qualified domain name](https://dev.wix.com/docs/rest/articles/getting-started/fqdns). */
+    fqdn: string;
+    /** Namespaces within the given entity. */
+    namespaces?: string[];
+    /** Additional fields that are hidden by default. For example, fields with `"x-wix-archived": true`. */
+    fields?: RequestedField[];
+}
+declare enum RequestedField {
+    /** Doesn't do anything */
+    UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
+    /** Returns `x-wix-archived` fields in `DataExtensionSchema.json_schema`. */
+    ARCHIVED = "ARCHIVED"
+}
+interface ListDataExtensionSchemasResponse {
+    /** Requested schemas. */
+    dataExtensionSchemas?: DataExtensionSchema[];
+}
+interface DeleteByWhiteListedMetaSiteRequest {
+    /** Meta site id */
+    metaSiteId: string;
+}
+interface DeleteByWhiteListedMetaSiteResponse {
+    /** has more */
+    hasMore?: boolean;
+}
+interface DataExtensionSchemaNonNullableFields {
+    extensionPoint: string;
+}
+interface CreateDataExtensionSchemaResponseNonNullableFields {
+    dataExtensionSchema?: DataExtensionSchemaNonNullableFields;
+}
+interface UpdateDataExtensionSchemaResponseNonNullableFields {
+    dataExtensionSchema?: DataExtensionSchemaNonNullableFields;
+}
+interface ListDataExtensionSchemasResponseNonNullableFields {
+    dataExtensionSchemas: DataExtensionSchemaNonNullableFields[];
+}
+interface DeleteByWhiteListedMetaSiteResponseNonNullableFields {
+    hasMore: boolean;
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function createDataExtensionSchema(): __PublicMethodMetaInfo<'POST', {}, CreateDataExtensionSchemaRequest, CreateDataExtensionSchemaRequest$1, CreateDataExtensionSchemaResponse & CreateDataExtensionSchemaResponseNonNullableFields, CreateDataExtensionSchemaResponse$1 & CreateDataExtensionSchemaResponseNonNullableFields$1>;
+declare function updateDataExtensionSchema(): __PublicMethodMetaInfo<'PUT', {}, UpdateDataExtensionSchemaRequest, UpdateDataExtensionSchemaRequest$1, UpdateDataExtensionSchemaResponse & UpdateDataExtensionSchemaResponseNonNullableFields, UpdateDataExtensionSchemaResponse$1 & UpdateDataExtensionSchemaResponseNonNullableFields$1>;
+declare function listDataExtensionSchemas(): __PublicMethodMetaInfo<'GET', {}, ListDataExtensionSchemasRequest, ListDataExtensionSchemasRequest$1, ListDataExtensionSchemasResponse & ListDataExtensionSchemasResponseNonNullableFields, ListDataExtensionSchemasResponse$1 & ListDataExtensionSchemasResponseNonNullableFields$1>;
+declare function deleteByWhiteListedMetaSite(): __PublicMethodMetaInfo<'POST', {}, DeleteByWhiteListedMetaSiteRequest, DeleteByWhiteListedMetaSiteRequest$1, DeleteByWhiteListedMetaSiteResponse & DeleteByWhiteListedMetaSiteResponseNonNullableFields, DeleteByWhiteListedMetaSiteResponse$1 & DeleteByWhiteListedMetaSiteResponseNonNullableFields$1>;
+
+type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
+declare const meta_createDataExtensionSchema: typeof createDataExtensionSchema;
+declare const meta_deleteByWhiteListedMetaSite: typeof deleteByWhiteListedMetaSite;
+declare const meta_listDataExtensionSchemas: typeof listDataExtensionSchemas;
+declare const meta_updateDataExtensionSchema: typeof updateDataExtensionSchema;
+declare namespace meta {
+  export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_createDataExtensionSchema as createDataExtensionSchema, meta_deleteByWhiteListedMetaSite as deleteByWhiteListedMetaSite, meta_listDataExtensionSchemas as listDataExtensionSchemas, meta_updateDataExtensionSchema as updateDataExtensionSchema };
+}
+
+export { meta as schemas };