@wix/auto_sdk_quick-pages_pages 1.0.0

package/build/internal/es/meta.d.mts

@@ -0,0 +1,533 @@
+import { CreatePageRequest as CreatePageRequest$1, CreatePageResponse as CreatePageResponse$1, GetPageRequest as GetPageRequest$1, GetPageResponse as GetPageResponse$1, UpdatePageRequest as UpdatePageRequest$1, UpdatePageResponse as UpdatePageResponse$1, SetPageRouteRequest as SetPageRouteRequest$1, SetPageRouteResponse as SetPageRouteResponse$1, RemovePageRouteRequest as RemovePageRouteRequest$1, RemovePageRouteResponse as RemovePageRouteResponse$1, PublishPageRequest as PublishPageRequest$1, PublishPageResponse as PublishPageResponse$1, UnpublishPageRequest as UnpublishPageRequest$1, UnpublishPageResponse as UnpublishPageResponse$1, ArchivePageRequest as ArchivePageRequest$1, ArchivePageResponse as ArchivePageResponse$1, UnarchivePageRequest as UnarchivePageRequest$1, UnarchivePageResponse as UnarchivePageResponse$1, SchedulePageRequest as SchedulePageRequest$1, SchedulePageResponse as SchedulePageResponse$1, DeletePageRequest as DeletePageRequest$1, DeletePageResponse as DeletePageResponse$1, QueryPagesRequest as QueryPagesRequest$1, QueryPagesResponse as QueryPagesResponse$1, BulkUpdatePageTagsRequest as BulkUpdatePageTagsRequest$1, BulkUpdatePageTagsResponse as BulkUpdatePageTagsResponse$1, BulkUpdatePageTagsByFilterRequest as BulkUpdatePageTagsByFilterRequest$1, BulkUpdatePageTagsByFilterResponse as BulkUpdatePageTagsByFilterResponse$1 } from './index.typings.mjs';
+import '@wix/sdk-types';
+
+/** QuickPage Page */
+interface Page extends PageOriginOneOf {
+    /**
+     * The ID of a page from which the page was created.
+     * @format GUID
+     * @immutable
+     */
+    originPageId?: string;
+    /**
+     * The ID of a template from which the page was created.
+     * @format GUID
+     * @immutable
+     */
+    templateId?: string;
+    /**
+     * Page ID.
+     * @format GUID
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Revision number. Incremented on every update.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the Page was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the Page was last updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /**
+     * Date and time the Page was published or scheduled to be published depending on the status.
+     * @readonly
+     */
+    publishedDate?: Date | null;
+    /**
+     * Date and time the Page was unpublished or scheduled to be unpublished depending on the status.
+     * @readonly
+     */
+    unpublishedDate?: Date | null;
+    /**
+     * Page display name.
+     * @minLength 5
+     * @maxLength 100
+     */
+    name?: string | null;
+    /**
+     * The status of the Page.
+     * @readonly
+     */
+    status?: StatusWithLiterals;
+    /** An image specifically designated for display when the page URL is shared on social media platforms. */
+    socialPreviewImage?: Image;
+    /** The small icon displayed in the browser tab, bookmarks, and potentially other areas. */
+    favicon?: Image;
+    /**
+     * The title of the page, visible in the browser tab and used as the primary clickable link in search engine results.
+     * @maxLength 100
+     */
+    title?: string | null;
+    /**
+     * A brief summary of the page's content, often displayed below the title in search engine results.
+     * @maxLength 300
+     */
+    description?: string | null;
+    /** A flag to indicate whether search engines should be allowed to index this page and include it in their search results. */
+    searchEngineIndexingEnabled?: boolean;
+    /**
+     * The route information for the page.
+     * @readonly
+     */
+    pageRoute?: PageRoute;
+    /** Data Extensions */
+    extendedFields?: ExtendedFields;
+    /** Tags */
+    tags?: Tags;
+}
+/** @oneof */
+interface PageOriginOneOf {
+    /**
+     * The ID of a page from which the page was created.
+     * @format GUID
+     * @immutable
+     */
+    originPageId?: string;
+    /**
+     * The ID of a template from which the page was created.
+     * @format GUID
+     * @immutable
+     */
+    templateId?: string;
+}
+declare enum Status {
+    /** Unknown status. */
+    UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    /** The Page is draft. */
+    DRAFT = "DRAFT",
+    /** The Page is published. */
+    PUBLISHED = "PUBLISHED",
+    /** The Page is scheduled to be published. */
+    SCHEDULED = "SCHEDULED",
+    /** The Page is archived. */
+    ARCHIVED = "ARCHIVED"
+}
+/** @enumType */
+type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'DRAFT' | 'PUBLISHED' | 'SCHEDULED' | 'ARCHIVED';
+interface Image {
+    /**
+     * WixMedia image ID.
+     * @maxLength 100
+     */
+    id?: string;
+    /**
+     * Image URL.
+     * @format WEB_URL
+     * @readonly
+     */
+    url?: string;
+    /**
+     * Original image height.
+     * @readonly
+     */
+    height?: number;
+    /**
+     * Original image width.
+     * @readonly
+     */
+    width?: number;
+    /**
+     * Image alt text.
+     * @maxLength 1000
+     */
+    altText?: string | null;
+}
+interface PageRoute {
+    /**
+     * Page slug used in the URL.
+     * @minLength 3
+     * @maxLength 100
+     */
+    slug?: string;
+    /** The URL type for the page, determining how it's accessed (subdomain or path). */
+    urlType?: TypeWithLiterals;
+}
+declare enum Type {
+    /** Unknown URL type. */
+    UNKNOWN_TYPE = "UNKNOWN_TYPE",
+    /** The page is accessed via a subdomain. */
+    SUBDOMAIN = "SUBDOMAIN",
+    /** The page is accessed via a path. */
+    PATH = "PATH"
+}
+/** @enumType */
+type TypeWithLiterals = Type | 'UNKNOWN_TYPE' | 'SUBDOMAIN' | 'PATH';
+interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+/**
+ * Common object for tags.
+ * Should be use as in this example:
+ * message Foo {
+ * string id = 1;
+ * ...
+ * Tags tags = 5
+ * }
+ *
+ * example of taggable entity
+ * {
+ * id: "123"
+ * tags: {
+ * tags: {
+ * tag_ids:["11","22"]
+ * },
+ * private_tags: {
+ * tag_ids: ["33", "44"]
+ * }
+ * }
+ * }
+ */
+interface Tags {
+    /** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
+    privateTags?: TagList;
+    /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
+    tags?: TagList;
+}
+interface TagList {
+    /**
+     * List of tag IDs
+     * @maxSize 100
+     * @maxLength 5
+     */
+    tagIds?: string[];
+}
+interface CreatePageRequest {
+    /** Page to be created. */
+    page: Page;
+}
+interface CreatePageResponse {
+    /** The created Page. */
+    page?: Page;
+}
+interface GetPageRequest {
+    /**
+     * ID of the Page to retrieve.
+     * @format GUID
+     */
+    pageId: string;
+}
+interface GetPageResponse {
+    /** The requested Page. */
+    page?: Page;
+}
+interface UpdatePageRequest {
+    /** Page to be updated, may be partial. */
+    page: Page;
+}
+interface UpdatePageResponse {
+    /** Updated Page. */
+    page?: Page;
+}
+interface SetPageRouteRequest {
+    /**
+     * ID of the Page.
+     * @format GUID
+     */
+    pageId: string;
+    /** Route to add. */
+    pageRoute: PageRoute;
+}
+interface SetPageRouteResponse {
+}
+interface RemovePageRouteRequest {
+    /**
+     * ID of the Page.
+     * @format GUID
+     */
+    pageId: string;
+}
+interface RemovePageRouteResponse {
+}
+interface PublishPageRequest {
+    /**
+     * ID of the Page to publish.
+     * @format GUID
+     */
+    pageId: string;
+    /** Date and time when the page should be unpublished. */
+    unpublishedDate?: Date | null;
+}
+interface PublishPageResponse {
+    /** Published Page. */
+    page?: Page;
+}
+interface UnpublishPageRequest {
+    /**
+     * ID of the Page to unpublish.
+     * @format GUID
+     */
+    pageId: string;
+}
+interface UnpublishPageResponse {
+    /** Unpublished Page. */
+    page?: Page;
+}
+interface ArchivePageRequest {
+    /**
+     * ID of the Page to archive.
+     * @format GUID
+     */
+    pageId: string;
+}
+interface ArchivePageResponse {
+    /** Archived Page. */
+    page?: Page;
+}
+interface UnarchivePageRequest {
+    /**
+     * ID of the Page to archive.
+     * @format GUID
+     */
+    pageId: string;
+}
+interface UnarchivePageResponse {
+    /** Archived Page. */
+    page?: Page;
+}
+interface SchedulePageRequest {
+    /**
+     * ID of the Page to schedule.
+     * @format GUID
+     */
+    pageId: string;
+    /** Date and time when the page should be published. */
+    publishedDate?: Date | null;
+    /** Date and time when the page should be unpublished. */
+    unpublishedDate?: Date | null;
+}
+interface SchedulePageResponse {
+    /** Scheduled Page. */
+    page?: Page;
+}
+interface DeletePageRequest {
+    /**
+     * Id of the Page to delete.
+     * @format GUID
+     */
+    pageId: string;
+}
+interface DeletePageResponse {
+}
+interface QueryPagesRequest {
+    /** WQL expression. */
+    query?: CursorQuery;
+}
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * @maxSize 5
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface CursorPaging {
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+interface QueryPagesResponse {
+    /** List of Pages. */
+    pages?: Page[];
+    /** Paging metadata */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface BulkUpdatePageTagsRequest {
+    /**
+     * List of NileProtoTagsEntities that their tags will update.
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
+     */
+    pageIds: string[];
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+interface BulkUpdatePageTagsResponse {
+    /**
+     * Results
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkUpdatePageTagsResult[];
+    /** Metadata regarding the bulk update operation */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface ItemMetadata {
+    /**
+     * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
+     * @format GUID
+     */
+    id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+interface BulkUpdatePageTagsResult {
+    /** Metadata regarding the specific single update operation */
+    itemMetadata?: ItemMetadata;
+}
+interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+interface BulkUpdatePageTagsByFilterRequest {
+    /** Filter */
+    filter: Record<string, any> | null;
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+interface BulkUpdatePageTagsByFilterResponse {
+    /**
+     * Job ID
+     * @format GUID
+     */
+    jobId?: string;
+}
+
+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 createPage(): __PublicMethodMetaInfo<'POST', {}, CreatePageRequest$1, CreatePageRequest, CreatePageResponse$1, CreatePageResponse>;
+declare function getPage(): __PublicMethodMetaInfo<'GET', {
+    pageId: string;
+}, GetPageRequest$1, GetPageRequest, GetPageResponse$1, GetPageResponse>;
+declare function updatePage(): __PublicMethodMetaInfo<'PATCH', {
+    pageId: string;
+}, UpdatePageRequest$1, UpdatePageRequest, UpdatePageResponse$1, UpdatePageResponse>;
+declare function setPageRoute(): __PublicMethodMetaInfo<'PATCH', {
+    pageId: string;
+}, SetPageRouteRequest$1, SetPageRouteRequest, SetPageRouteResponse$1, SetPageRouteResponse>;
+declare function removePageRoute(): __PublicMethodMetaInfo<'DELETE', {
+    pageId: string;
+}, RemovePageRouteRequest$1, RemovePageRouteRequest, RemovePageRouteResponse$1, RemovePageRouteResponse>;
+declare function publishPage(): __PublicMethodMetaInfo<'POST', {
+    pageId: string;
+}, PublishPageRequest$1, PublishPageRequest, PublishPageResponse$1, PublishPageResponse>;
+declare function unpublishPage(): __PublicMethodMetaInfo<'POST', {
+    pageId: string;
+}, UnpublishPageRequest$1, UnpublishPageRequest, UnpublishPageResponse$1, UnpublishPageResponse>;
+declare function archivePage(): __PublicMethodMetaInfo<'POST', {
+    pageId: string;
+}, ArchivePageRequest$1, ArchivePageRequest, ArchivePageResponse$1, ArchivePageResponse>;
+declare function unarchivePage(): __PublicMethodMetaInfo<'POST', {
+    pageId: string;
+}, UnarchivePageRequest$1, UnarchivePageRequest, UnarchivePageResponse$1, UnarchivePageResponse>;
+declare function schedulePage(): __PublicMethodMetaInfo<'POST', {
+    pageId: string;
+}, SchedulePageRequest$1, SchedulePageRequest, SchedulePageResponse$1, SchedulePageResponse>;
+declare function deletePage(): __PublicMethodMetaInfo<'DELETE', {
+    pageId: string;
+}, DeletePageRequest$1, DeletePageRequest, DeletePageResponse$1, DeletePageResponse>;
+declare function queryPages(): __PublicMethodMetaInfo<'GET', {}, QueryPagesRequest$1, QueryPagesRequest, QueryPagesResponse$1, QueryPagesResponse>;
+declare function bulkUpdatePageTags(): __PublicMethodMetaInfo<'POST', {}, BulkUpdatePageTagsRequest$1, BulkUpdatePageTagsRequest, BulkUpdatePageTagsResponse$1, BulkUpdatePageTagsResponse>;
+declare function bulkUpdatePageTagsByFilter(): __PublicMethodMetaInfo<'POST', {}, BulkUpdatePageTagsByFilterRequest$1, BulkUpdatePageTagsByFilterRequest, BulkUpdatePageTagsByFilterResponse$1, BulkUpdatePageTagsByFilterResponse>;
+
+export { type __PublicMethodMetaInfo, archivePage, bulkUpdatePageTags, bulkUpdatePageTagsByFilter, createPage, deletePage, getPage, publishPage, queryPages, removePageRoute, schedulePage, setPageRoute, unarchivePage, unpublishPage, updatePage };