@wix/portfolio 1.0.48 → 1.0.50

package/build/es/src/portfolio-projects-v1-project-in-collection.universal.d.ts

@@ -1,574 +0,0 @@
-export declare const __debug: {
-    verboseLogging: {
-        on: () => boolean;
-        off: () => boolean;
-    };
-};
-export interface ProjectInCollection {
-    /** Collection ID */
-    collectionId?: string;
-    /** Project */
-    project?: Project;
-    /** The sort order of the project in the given Collection */
-    sortOrder?: number | null;
-}
-/** Project is the main entity of ProjectsService */
-export interface Project extends ProjectCoverOneOf {
-    /** project's cover photo */
-    coverImage?: Image;
-    /** project's cover video */
-    coverVideo?: Video;
-    /**
-     * Project ID
-     * @readonly
-     */
-    _id?: string | null;
-    /**
-     * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision
-     * @readonly
-     */
-    revision?: string | null;
-    title?: string | null;
-    description?: string | null;
-    /** indicates if the project should be hidden from Portfolio */
-    hidden?: boolean | null;
-    /** Collections must exist to be added to a project. can be created/updated/deleted using this //TODO */
-    collectionIds?: string[];
-    /** Custom project details */
-    details?: ProjectDetail[];
-    slug?: string | null;
-    /**
-     * Represents the time this Project was created
-     * @readonly
-     */
-    _createdDate?: Date;
-    /**
-     * Represents the time this Project was last updated
-     * @readonly
-     */
-    _updatedDate?: Date;
-    /**
-     * Url and relative url of Project - in order to receive this field in READ requests you will need to pass the `include_page_url` field as part of request
-     * @readonly
-     */
-    url?: string;
-    seoData?: SeoSchema;
-    /**
-     * indicates if the project is synced from external platform (via integration page) and therefore will be updated from the external platform on daily basis
-     * @readonly
-     */
-    syncedProject?: boolean | null;
-}
-/** @oneof */
-export interface ProjectCoverOneOf {
-    /** project's cover photo */
-    coverImage?: Image;
-    /** project's cover video */
-    coverVideo?: Video;
-}
-export interface Image {
-    /** Image info - Wix Media Image. */
-    imageInfo?: string;
-    /** Focal point of the image. */
-    focalPoint?: Point;
-}
-export declare enum ImageType {
-    UNDEFINED = "UNDEFINED",
-    WIX_MEDIA = "WIX_MEDIA",
-    EXTERNAL = "EXTERNAL"
-}
-export interface Point {
-    /** X-coordinate of the focal point. */
-    x?: number;
-    /** Y-coordinate of the focal point. */
-    y?: number;
-}
-export interface UnsharpMasking {
-    /**
-     * Unsharp masking amount. Controls the sharpening strength. <br />
-     *
-     * Min: `0` <br />
-     * Max: `5`
-     */
-    amount?: number | null;
-    /** Unsharp masking radius in pixels. Controls the sharpening width. */
-    radius?: number | null;
-    /**
-     * Unsharp masking threshold. Controls how different neighboring pixels must be for shapening to apply. <br />
-     *
-     * Min: `0` <br />
-     * Max: `1`
-     */
-    threshold?: number | null;
-}
-export interface Video {
-    /** Video info - Wix Media Image. */
-    videoInfo?: string;
-    /** Manually defined Video duration in milliseconds. */
-    durationInMillis?: number | null;
-}
-export 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;
-}
-export interface ProjectDetail extends ProjectDetailValueOneOf {
-    text?: string;
-    link?: DetailsLink;
-    label?: string;
-}
-/** @oneof */
-export interface ProjectDetailValueOneOf {
-    text?: string;
-    link?: DetailsLink;
-}
-export interface DetailsLink {
-    text?: string | null;
-    /** link to external source */
-    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;
-}
-export interface ProjectSource {
-    appDefId?: string;
-    externalId?: string;
-    sourceName?: string;
-    description?: string | null;
-    /** link to external source */
-    link?: string | null;
-    syncStatus?: SyncStatus;
-    /** fields that are synced from external source, should be blocked to update in UI */
-    notEditableFields?: string[];
-    /** last date the project was synced */
-    lastSync?: Date;
-}
-export declare enum SyncStatus {
-    SYNCED = "SYNCED",
-    SYNCING = "SYNCING",
-    NOT_SYNCED = "NOT_SYNCED"
-}
-/**
- * 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.
- */
-export interface SeoSchema {
-    /** SEO tag information. */
-    tags?: Tag[];
-    /** SEO general settings. */
-    settings?: Settings;
-}
-export interface Keyword {
-    /** Keyword value. */
-    term?: string;
-    /** Whether the keyword is the main focus keyword. */
-    isMain?: boolean;
-}
-export 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;
-}
-export 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. */
-    keywords?: Keyword[];
-}
-export interface QueryProjectInCollectionsRequest {
-    /** WQL expression */
-    query: QueryV2;
-    includePageUrl?: boolean | null;
-}
-export 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 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"}]`
-     */
-    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 */
-export 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;
-}
-export interface Sorting {
-    /** Name of the field to sort by. */
-    fieldName?: string;
-    /** Sort order. */
-    order?: SortOrder;
-}
-export declare enum SortOrder {
-    ASC = "ASC",
-    DESC = "DESC"
-}
-export interface Paging {
-    /** Number of items to load. */
-    limit?: number | null;
-    /** Number of items to skip in the current sort order. */
-    offset?: number | null;
-}
-export interface CursorPaging {
-    /** Maximum number of items to return in the results. */
-    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.
-     */
-    cursor?: string | null;
-}
-export interface QueryProjectInCollectionsResponse {
-    /** The retrieved Projects in Collections context */
-    projectInCollections?: ProjectInCollection[];
-    /** Paging metadata */
-    metadata?: PagingMetadataV2;
-}
-export 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;
-}
-export interface Cursors {
-    /** Cursor string pointing to the next page in the list of results. */
-    next?: string | null;
-    /** Cursor pointing to the previous page in the list of results. */
-    prev?: string | null;
-}
-export interface UpdateProjectOrderInCollectionRequest {
-    /** Id of the Project to update its order */
-    projectId: string;
-    /** Id of the collection in which the project will be re-ordered */
-    collectionId: string;
-    /** The new sort order of the project in the given collection */
-    sortOrder: number | null;
-}
-export interface UpdateProjectOrderInCollectionResponse {
-    /** project with new sort order set */
-    projectInCollection?: ProjectInCollection;
-}
-export interface ProjectOrderInCollectionUpdatedEvent {
-    /** Id of the Project to update its order */
-    projectId?: string;
-    /** Id of the collection in which the project will be re-ordered */
-    collectionId?: string;
-    /** The new sort order of the project in the given collection */
-    sortOrder?: number | null;
-}
-export interface DomainEvent extends DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-    /**
-     * Unique event ID.
-     * Allows clients to ignore duplicate webhooks.
-     */
-    _id?: string;
-    /**
-     * Assumes actions are also always typed to an entity_type
-     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
-     */
-    entityFqdn?: string;
-    /**
-     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
-     * This is although the created/updated/deleted notion is duplication of the oneof types
-     * Example: created/updated/deleted/started/completed/email_opened
-     */
-    slug?: string;
-    /** ID of the entity associated with the event. */
-    entityId?: string;
-    /** Event timestamp. */
-    eventTime?: Date;
-    /**
-     * Whether the event was triggered as a result of a privacy regulation application
-     * (for example, GDPR).
-     */
-    triggeredByAnonymizeRequest?: boolean | null;
-    /** If present, indicates the action that triggered the event. */
-    originatedFrom?: string | null;
-    /**
-     * A sequence number defining the order of updates to the underlying entity.
-     * For example, given that some entity was updated at 16:00 and than again at 16:01,
-     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
-     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
-     * To do so, you will need to persist this number on your end, and compare the sequence number from the
-     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
-     */
-    entityEventSequence?: string | null;
-}
-/** @oneof */
-export interface DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-}
-export interface EntityCreatedEvent {
-    entityAsJson?: string;
-}
-export interface EntityUpdatedEvent {
-    /**
-     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
-     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
-     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
-     */
-    currentEntityAsJson?: string;
-}
-export interface EntityDeletedEvent {
-    /** Entity that was deleted */
-    deletedEntityAsJson?: string | null;
-}
-export interface ActionEvent {
-    bodyAsJson?: string;
-}
-export interface QueryProjectInCollectionsResponseNonNullableFields {
-    projectInCollections: {
-        collectionId: string;
-        project?: {
-            coverImage?: {
-                imageInfo: string;
-                focalPoint?: {
-                    x: number;
-                    y: number;
-                };
-            };
-            coverVideo?: {
-                videoInfo: string;
-            };
-            collectionIds: string[];
-            details: {
-                text: string;
-                label: string;
-            }[];
-            url: string;
-            seoData?: {
-                tags: {
-                    type: string;
-                    children: string;
-                    custom: boolean;
-                    disabled: boolean;
-                }[];
-                settings?: {
-                    preventAutoRedirect: boolean;
-                    keywords: {
-                        term: string;
-                        isMain: boolean;
-                    }[];
-                };
-            };
-        };
-    }[];
-}
-export interface UpdateProjectOrderInCollectionResponseNonNullableFields {
-    projectInCollection?: {
-        collectionId: string;
-        project?: {
-            coverImage?: {
-                imageInfo: string;
-                focalPoint?: {
-                    x: number;
-                    y: number;
-                };
-            };
-            coverVideo?: {
-                videoInfo: string;
-            };
-            collectionIds: string[];
-            details: {
-                text: string;
-                label: string;
-            }[];
-            url: string;
-            seoData?: {
-                tags: {
-                    type: string;
-                    children: string;
-                    custom: boolean;
-                    disabled: boolean;
-                }[];
-                settings?: {
-                    preventAutoRedirect: boolean;
-                    keywords: {
-                        term: string;
-                        isMain: boolean;
-                    }[];
-                };
-            };
-        };
-    };
-}
-/**
- * Query project in collection context using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
- *
- * Because project can be ordered different in each collection, use this when want to query the projects in a Collection ordered by the order in given collection
- *
- * Supported Fields for query and ordering: collectionId, project.id, sortOrder, project.hidden, project.slug
- *
- * If you want to Query project by Project properties please use ProjectsService.Query method - link //TODO
- * @public
- * @documentationMaturity preview
- * @applicableIdentity MEMBER
- * @applicableIdentity VISITOR
- */
-export declare function queryProjectInCollections(options?: QueryProjectInCollectionsOptions): ProjectInCollectionsQueryBuilder;
-export interface QueryProjectInCollectionsOptions {
-    includePageUrl?: boolean | null | undefined;
-}
-interface QueryCursorResult {
-    cursors: Cursors;
-    hasNext: () => boolean;
-    hasPrev: () => boolean;
-    length: number;
-    pageSize: number;
-}
-export interface ProjectInCollectionsQueryResult extends QueryCursorResult {
-    items: ProjectInCollection[];
-    query: ProjectInCollectionsQueryBuilder;
-    next: () => Promise<ProjectInCollectionsQueryResult>;
-    prev: () => Promise<ProjectInCollectionsQueryResult>;
-}
-export interface ProjectInCollectionsQueryBuilder {
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    eq: (propertyName: 'collectionId' | 'project.id' | 'project.hidden' | 'project.slug' | 'sortOrder', value: any) => ProjectInCollectionsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    ne: (propertyName: 'collectionId' | 'project.id' | 'project.hidden' | 'project.slug' | 'sortOrder', value: any) => ProjectInCollectionsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    ge: (propertyName: 'sortOrder', value: any) => ProjectInCollectionsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    gt: (propertyName: 'sortOrder', value: any) => ProjectInCollectionsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    le: (propertyName: 'sortOrder', value: any) => ProjectInCollectionsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    lt: (propertyName: 'sortOrder', value: any) => ProjectInCollectionsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `string`.
-     * @param string - String to compare against. Case-insensitive.
-     * @documentationMaturity preview
-     */
-    startsWith: (propertyName: 'collectionId' | 'project.id' | 'project.slug', value: string) => ProjectInCollectionsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `values`.
-     * @param values - List of values to compare against.
-     * @documentationMaturity preview
-     */
-    hasSome: (propertyName: 'collectionId' | 'project.id' | 'project.hidden' | 'project.slug' | 'sortOrder', value: any[]) => ProjectInCollectionsQueryBuilder;
-    /** @documentationMaturity preview */
-    in: (propertyName: 'collectionId' | 'project.id' | 'project.hidden' | 'project.slug' | 'sortOrder', value: any) => ProjectInCollectionsQueryBuilder;
-    /** @documentationMaturity preview */
-    exists: (propertyName: 'collectionId' | 'project.id' | 'project.hidden' | 'project.slug' | 'sortOrder', value: boolean) => ProjectInCollectionsQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
-     * @documentationMaturity preview
-     */
-    ascending: (...propertyNames: Array<'collectionId' | 'project.id' | 'project.slug' | 'sortOrder'>) => ProjectInCollectionsQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
-     * @documentationMaturity preview
-     */
-    descending: (...propertyNames: Array<'collectionId' | 'project.id' | 'project.slug' | 'sortOrder'>) => ProjectInCollectionsQueryBuilder;
-    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
-     * @documentationMaturity preview
-     */
-    limit: (limit: number) => ProjectInCollectionsQueryBuilder;
-    /** @param cursor - A pointer to specific record
-     * @documentationMaturity preview
-     */
-    skipTo: (cursor: string) => ProjectInCollectionsQueryBuilder;
-    /** @documentationMaturity preview */
-    find: () => Promise<ProjectInCollectionsQueryResult>;
-}
-/**
- * Updates Project's order in a given Collection
- * @param sortOrder - The new sort order of the project in the given collection
- * @public
- * @documentationMaturity preview
- * @requiredField identifiers
- * @requiredField identifiers.collectionId
- * @requiredField identifiers.projectId
- * @requiredField sortOrder
- */
-export declare function updateProjectOrderInCollection(identifiers: UpdateProjectOrderInCollectionIdentifiers, sortOrder: number | null): Promise<UpdateProjectOrderInCollectionResponse & UpdateProjectOrderInCollectionResponseNonNullableFields>;
-export interface UpdateProjectOrderInCollectionIdentifiers {
-    /** Id of the Project to update its order */
-    projectId: string;
-    /** Id of the collection in which the project will be re-ordered */
-    collectionId: string;
-}
-export {};