@wix/auto_sdk_portfolio_projects 1.0.17 → 1.0.19

package/build/internal/meta.d.mts

@@ -0,0 +1,515 @@
+import { au as CreateProjectRequest$1, av as CreateProjectResponse$1, aw as GetProjectRequest$1, ax as GetProjectResponse$1, ay as ListProjectsRequest$1, a as ListProjectsResponse$1, aC as UpdateProjectRequest$1, aD as UpdateProjectResponse$1, aE as BulkUpdateProjectsRequest$1, b as BulkUpdateProjectsResponse$1, aK as DeleteProjectRequest$1, D as DeleteProjectResponse$1, aL as QueryProjectsRequest$1, aP as QueryProjectsResponse$1, aQ as UpdateProjectOrderInCollectionRequest$1, e as UpdateProjectOrderInCollectionResponse$1, aS as QueryProjectWithCollectionInfoRequest$1, h as QueryProjectWithCollectionInfoResponse$1 } from './portfolio-projects-v1-project-projects.universal-D18FmjD0.mjs';
+
+interface Project extends ProjectCoverOneOf {
+    /** Project cover image. */
+    coverImage?: Image;
+    /** Project cover video. */
+    coverVideo?: Video;
+    /**
+     * Project ID.
+     * @readonly
+     * @format GUID
+     */
+    id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the project is updated. To prevent conflicting changes, the existing revision must be passed when updating the project object.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Project title.
+     * @maxLength 100
+     */
+    title?: string | null;
+    /** Project description. */
+    description?: string | null;
+    /** Whether the project is hidden from the portfolio. Default: `false` */
+    hidden?: boolean | null;
+    /**
+     * IDs of the collections that include the project.
+     * @format GUID
+     * @maxSize 1000
+     */
+    collectionIds?: string[];
+    /** Project details. */
+    details?: ProjectDetail[];
+    /** Project slug. */
+    slug?: string | null;
+    /**
+     * Date and time the project was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the project was updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /**
+     * Project page URL and relative path. Returned when `includePageUrl` is `true` in the request.
+     * @readonly
+     */
+    url?: PageUrlV2;
+    /** Project SEO data. */
+    seoData?: SeoSchema;
+}
+/** @oneof */
+interface ProjectCoverOneOf {
+    /** Project cover image. */
+    coverImage?: Image;
+    /** Project cover video. */
+    coverVideo?: Video;
+}
+interface Image {
+    /** Information about the Wix Media image. */
+    imageInfo?: CommonImage;
+    /** Focal point of the image. */
+    focalPoint?: Point;
+}
+interface CommonImage {
+    /** WixMedia image ID. Required. */
+    id?: string;
+    /**
+     * Image URL.
+     * @readonly
+     */
+    url?: string;
+    /** Original image height. Required. */
+    height?: number;
+    /** Original image width. Required. */
+    width?: number;
+    /** Image alt text. */
+    altText?: string | null;
+    /** Image filename. */
+    filename?: string | null;
+}
+interface Point {
+    /** X-coordinate of the focal point. */
+    x?: number;
+    /** Y-coordinate of the focal point. */
+    y?: number;
+}
+interface Video {
+    /** Information about the Wix Media video. */
+    videoInfo?: VideoV2;
+    /** Manually defined Video duration in milliseconds. */
+    durationInMillis?: number | null;
+}
+interface VideoV2 {
+    /** WixMedia ID. Required. */
+    id?: string;
+    /** Video URL. */
+    url?: string;
+    /**
+     * Available resolutions for the video, starting with the optimal resolution.
+     * @maxSize 100
+     */
+    resolutions?: VideoResolution[];
+    /** Video filename. */
+    filename?: string | null;
+    /** Video posters. */
+    posters?: CommonImage[];
+}
+interface VideoResolution {
+    /** Video URL.  Required. */
+    url?: string;
+    /** Video height. Required. */
+    height?: number;
+    /** Video width.  Required. */
+    width?: number;
+    /** Video format for example, mp4, hls.  Required. */
+    format?: string;
+    /** Video quality for example 480p, 720p. */
+    quality?: string | null;
+    /** Video filename. */
+    filename?: string | null;
+}
+/**
+ * Project label.
+ * One of:
+ * + `text`
+ * + `link`
+ */
+interface ProjectDetail extends ProjectDetailValueOneOf {
+    /** Project label in plain text format. */
+    text?: string;
+    /** Project label in link format. */
+    link?: DetailsLink;
+    /** Project label. */
+    label?: string;
+}
+/** @oneof */
+interface ProjectDetailValueOneOf {
+    /** Project label in plain text format. */
+    text?: string;
+    /** Project label in link format. */
+    link?: DetailsLink;
+}
+interface DetailsLink {
+    /** Display text of the link. */
+    text?: string | null;
+    /**
+     * Target URL of the link.
+     * @format WEB_URL
+     */
+    url?: string | null;
+    /**
+     * Whether the link opens in a new tab or window. One of:
+     * * `'_blank'`: The link opens in a new tab or window.
+     * * `'_self'`: The link opens in the same tab or window.
+     */
+    target?: string | null;
+}
+interface PageUrlV2 {
+    /** The relative path for the page within the site. For example, `/product-page/a-product`. */
+    relativePath?: string;
+    /** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
+    url?: string | null;
+}
+/**
+ * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
+ * The search engines use this information for ranking purposes, or to display snippets in the search results.
+ * This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
+ */
+interface SeoSchema {
+    /** SEO tag information. */
+    tags?: Tag[];
+    /** SEO general settings. */
+    settings?: Settings;
+}
+interface Keyword {
+    /** Keyword value. */
+    term?: string;
+    /** Whether the keyword is the main focus keyword. */
+    isMain?: boolean;
+    /**
+     * The source that added the keyword terms to the SEO settings.
+     * @maxLength 1000
+     */
+    origin?: string | null;
+}
+interface Tag {
+    /**
+     * SEO tag type.
+     *
+     *
+     * Supported values: `title`, `meta`, `script`, `link`.
+     */
+    type?: string;
+    /**
+     * A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.
+     * For example: `{"name": "description", "content": "the description itself"}`.
+     */
+    props?: Record<string, any> | null;
+    /** SEO tag meta data. For example, `{"height": 300, "width": 240}`. */
+    meta?: Record<string, any> | null;
+    /** SEO tag inner content. For example, `<title> inner content </title>`. */
+    children?: string;
+    /** Whether the tag is a custom tag. */
+    custom?: boolean;
+    /** Whether the tag is disabled. */
+    disabled?: boolean;
+}
+interface Settings {
+    /**
+     * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
+     *
+     *
+     * Default: `false` (Auto Redirect is enabled.)
+     */
+    preventAutoRedirect?: boolean;
+    /**
+     * User-selected keyword terms for a specific page.
+     * @maxSize 5
+     */
+    keywords?: Keyword[];
+}
+interface CreateProjectRequest {
+    /** Project to create. */
+    project: Project;
+}
+interface CreateProjectResponse {
+    /** Created project. */
+    project?: Project;
+}
+interface GetProjectRequest {
+    /**
+     * ID of the project to retrieve.
+     * @format GUID
+     */
+    projectId: string;
+    /** Whether to include the project's relative path and full URL in the response. Default: `false` */
+    includePageUrl?: boolean | null;
+}
+interface GetProjectResponse {
+    /** The requested project. */
+    project?: Project;
+}
+interface ListProjectsRequest {
+    /** Projects limit per response is maximum 100, In the first request the cursor is None ? */
+    paging?: CursorPaging;
+    /** Whether to include the project's relative path and full URL in the response. Default: `false` */
+    includePageUrl?: boolean | null;
+}
+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 ListProjectsResponse {
+    /** List of projects. */
+    projects?: Project[];
+    /** Paging metadata. */
+    metadata?: PagingMetadataV2;
+}
+interface PagingMetadataV2 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
+}
+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 UpdateProjectRequest {
+    /** Project to update. */
+    project: Project;
+}
+interface UpdateProjectResponse {
+    /** Updated project. */
+    project?: Project;
+}
+interface BulkUpdateProjectsRequest {
+    /**
+     * Projects to update.
+     * @maxSize 100
+     */
+    projects?: MaskedProject[];
+    /** Whether to include the updated projects in the response. Set to `true` to receive the projects in the response. Default: `false` */
+    returnFullEntity?: boolean | null;
+}
+interface MaskedProject {
+    /** Project to update. */
+    project?: Project;
+}
+interface BulkUpdateProjectsResponse {
+    /** Items created by bulk action. */
+    results?: BulkUpdateProjectsResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkUpdateProjectsResult {
+    /** Item metadata. */
+    itemMetadata?: ItemMetadata;
+    /** Updated project. */
+    project?: Project;
+}
+interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    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 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 DeleteProjectRequest {
+    /**
+     * ID of the project to delete.
+     * @format GUID
+     */
+    projectId: string;
+}
+interface DeleteProjectResponse {
+    /**
+     * ID of the deleted project.
+     * @format GUID
+     */
+    projectId?: string;
+}
+interface QueryProjectsRequest {
+    /** Query options. */
+    query: QueryV2;
+    /** Whether to include the project's relative path and full URL in the response. Default: `false` */
+    includePageUrl?: boolean | null;
+}
+interface QueryV2 extends QueryV2PagingMethodOneOf {
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging;
+    /** 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.
+     *
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object.
+     *
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+     */
+    sort?: Sorting[];
+    /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
+    fields?: string[];
+    /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
+    fieldsets?: string[];
+}
+/** @oneof */
+interface QueryV2PagingMethodOneOf {
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging;
+    /** 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 Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+interface QueryProjectsResponse {
+    /** List of projects. */
+    projects?: Project[];
+    /** Paging metadata. */
+    metadata?: PagingMetadataV2;
+}
+interface UpdateProjectOrderInCollectionRequest {
+    /**
+     * ID of the project to update.
+     * @format GUID
+     */
+    projectId: string;
+    /**
+     * Collection ID.
+     * @format GUID
+     */
+    collectionId: string;
+    /** Index that determines the placement of a project within the collection. */
+    sortOrder: number | null;
+}
+interface UpdateProjectOrderInCollectionResponse {
+    /** Updated project placement within the specified collection. */
+    projectInCollection?: ProjectsInCollections;
+}
+interface ProjectsInCollections {
+    /**
+     * Collection ID.
+     * @format GUID
+     */
+    collectionId?: string;
+    /** Project object. */
+    project?: Project;
+    /**
+     * Index that determines the placement of a project within the collection.  <br />
+     *
+     * Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
+     */
+    sortOrder?: number | null;
+    /**
+     * Project placement ID.
+     * @readonly
+     * @format GUID
+     */
+    id?: string | null;
+}
+interface QueryProjectWithCollectionInfoRequest {
+    /** WQL expression */
+    query: QueryV2;
+    /** Include page url */
+    includePageUrl?: boolean | null;
+}
+interface QueryProjectWithCollectionInfoResponse {
+    /** The retrieved Projects in Collection */
+    projects?: ProjectsInCollections[];
+    /** Paging metadata */
+    metadata?: PagingMetadataV2;
+}
+
+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 createProject(): __PublicMethodMetaInfo<'POST', {}, CreateProjectRequest$1, CreateProjectRequest, CreateProjectResponse$1, CreateProjectResponse>;
+declare function getProject(): __PublicMethodMetaInfo<'GET', {
+    projectId: string;
+}, GetProjectRequest$1, GetProjectRequest, GetProjectResponse$1, GetProjectResponse>;
+declare function listProjects(): __PublicMethodMetaInfo<'GET', {}, ListProjectsRequest$1, ListProjectsRequest, ListProjectsResponse$1, ListProjectsResponse>;
+declare function updateProject(): __PublicMethodMetaInfo<'PATCH', {
+    projectId: string;
+}, UpdateProjectRequest$1, UpdateProjectRequest, UpdateProjectResponse$1, UpdateProjectResponse>;
+declare function bulkUpdateProjects(): __PublicMethodMetaInfo<'PATCH', {}, BulkUpdateProjectsRequest$1, BulkUpdateProjectsRequest, BulkUpdateProjectsResponse$1, BulkUpdateProjectsResponse>;
+declare function deleteProject(): __PublicMethodMetaInfo<'DELETE', {
+    projectId: string;
+}, DeleteProjectRequest$1, DeleteProjectRequest, DeleteProjectResponse$1, DeleteProjectResponse>;
+declare function queryProjects(): __PublicMethodMetaInfo<'POST', {}, QueryProjectsRequest$1, QueryProjectsRequest, QueryProjectsResponse$1, QueryProjectsResponse>;
+declare function updateProjectOrderInCollection(): __PublicMethodMetaInfo<'PATCH', {
+    projectId: string;
+    collectionId: string;
+}, UpdateProjectOrderInCollectionRequest$1, UpdateProjectOrderInCollectionRequest, UpdateProjectOrderInCollectionResponse$1, UpdateProjectOrderInCollectionResponse>;
+declare function queryProjectsWithCollectionInfo(): __PublicMethodMetaInfo<'POST', {}, QueryProjectWithCollectionInfoRequest$1, QueryProjectWithCollectionInfoRequest, QueryProjectWithCollectionInfoResponse$1, QueryProjectWithCollectionInfoResponse>;
+
+export { type __PublicMethodMetaInfo, bulkUpdateProjects, createProject, deleteProject, getProject, listProjects, queryProjects, queryProjectsWithCollectionInfo, updateProject, updateProjectOrderInCollection };