@wix/portfolio 1.0.0

package/build/cjs/src/portfolio-project-items-v1-project-item.types.d.ts

@@ -0,0 +1,549 @@
+/** ProjectItem is the main entity of ProjectItemsService */
+export interface Item extends ItemMetadataOneOf {
+    /**
+     * Id of the Project the items are part of
+     * Project must exist before adding items to it. project can be created/updated/deleted using this //TODO
+     */
+    projectId?: string;
+    /**
+     * Item ID.
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Item sort order.
+     * Determines which position a media item is displayed in the gallery. <br />
+     *
+     * Min: `1` <br />
+     * Default: [Epoch](https://www.epoch101.com/) timestamp in descending order (end of the gallery items list). <br />
+     *
+     * *Note:** If the same sort order number is assigned to more than one media item in a gallery, the first media item to which it was assigned will come first.
+     */
+    sortOrder?: number | null;
+    /** Item title. */
+    title?: string | null;
+    /** Item description. */
+    description?: string | null;
+    /**
+     * Item data type. One of:
+     * <br />
+     * +`"IMAGE"`
+     * <br />
+     * +`"VIDEO"`
+     * <br />
+     * +`"TEXT"`
+     * @readonly
+     */
+    type?: Type;
+    /**
+     * Date and time the item was created.
+     * @readonly
+     */
+    createdDate?: Date;
+    /**
+     * Date and time the item was last updated.
+     * @readonly
+     */
+    updatedDate?: Date;
+    /** Item tags. */
+    tags?: Tags;
+    /** Information about the image. */
+    image?: Image;
+    /** Information about the video. */
+    video?: Video;
+}
+/** @oneof */
+export interface ItemMetadataOneOf {
+    /** Information about the image. */
+    image?: Image;
+    /** Information about the video. */
+    video?: Video;
+}
+export declare enum Type {
+    UNDEFINED = "UNDEFINED",
+    IMAGE = "IMAGE",
+    VIDEO = "VIDEO"
+}
+export interface Image {
+    /** Image info - Wix Media Image. Required. */
+    imageInfo?: CommonImage;
+    /** Focal point of the image. */
+    focalPoint?: Point;
+    /** Set of key-value pairs describing the media in [Exchangeable Image File format](https://en.wikipedia.org/wiki/Exif). */
+    exif?: Record<string, any> | null;
+    /**
+     * Image compression level. <br />
+     *
+     * Min: `30` <br />
+     * Max: `100`
+     */
+    quality?: number | null;
+    /** [Unsharp masking](https://en.wikipedia.org/wiki/Unsharp_masking) values of the image. */
+    unsharpMasking?: UnsharpMasking;
+}
+export declare enum ImageType {
+    UNDEFINED = "UNDEFINED",
+    WIX_MEDIA = "WIX_MEDIA",
+    EXTERNAL = "EXTERNAL"
+}
+export 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;
+}
+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 {
+    type?: VideoType;
+    /** Video info - can include Wix Media or an external link from YouTube or Vimeo. Required. */
+    videoInfo?: VideoV2;
+    /** Manually defined Video duration in milliseconds. */
+    durationInMillis?: number | null;
+}
+export declare enum VideoType {
+    UNDEFINED = "UNDEFINED",
+    WIX_MEDIA = "WIX_MEDIA",
+    YOUTUBE = "YOUTUBE",
+    VIMEO = "VIMEO"
+}
+export interface VideoV2 {
+    /** WixMedia ID. Required when associating an existing Wix Media video. */
+    id?: string;
+    /** Video URL. Required when associating a video from an external source (YouTube/Vimeo). */
+    url?: string;
+    /** Available resolutions for the video, starting with the optimal resolution. */
+    resolutions?: VideoResolution[];
+    /** Video filename. */
+    filename?: string | null;
+    /** Video posters. */
+    posters?: CommonImage[];
+}
+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 Tags {
+    /** List of tags assigned to the media item. */
+    values?: string[];
+}
+export interface InvalidateCache extends InvalidateCacheGetByOneOf {
+    /** tell us why you're invalidating the cache. You don't need to add your app name */
+    reason?: string | null;
+    /** Is local DS */
+    localDc?: boolean;
+    /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
+    metaSiteId?: string;
+    /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
+    siteId?: string;
+    /** Invalidate by App */
+    app?: App;
+    /** Invalidate by page id */
+    page?: Page;
+    /** Invalidate by URI path */
+    uri?: URI;
+}
+/** @oneof */
+export interface InvalidateCacheGetByOneOf {
+    /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
+    metaSiteId?: string;
+    /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
+    siteId?: string;
+    /** Invalidate by App */
+    app?: App;
+    /** Invalidate by page id */
+    page?: Page;
+    /** Invalidate by URI path */
+    uri?: URI;
+}
+export interface App {
+    /** The AppDefId */
+    appDefId?: string;
+    /** The instance Id */
+    instanceId?: string;
+}
+export interface Page {
+    /** the msid the page is on */
+    metaSiteId?: string;
+    /** Invalidate by Page ID */
+    pageId?: string;
+}
+export interface URI {
+    /** the msid the URI is on */
+    metaSiteId?: string;
+    /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */
+    uriPath?: string;
+}
+export interface CreateProjectItemRequest {
+    projectId: string;
+    /** Item to be created */
+    item: Item;
+}
+export interface CreateProjectItemResponse {
+    projectId?: string;
+    /** The created item */
+    item?: Item;
+}
+export interface BulkCreateProjectItemsRequest {
+    /**
+     * Id of the Project the items are part of
+     * Project must exist before adding items to it. project can be created/updated/deleted using this //TODO
+     */
+    projectId: string;
+    /** items to be created. */
+    items: Item[];
+}
+export interface BulkCreateProjectItemsResponse {
+    /** Id of the Project the item is part of */
+    projectId?: string;
+    /** Array with all created items results. */
+    results?: BulkCreateProjectItemResult[];
+    /** Holds metadata of the entire bulk create operation */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkCreateProjectItemResult {
+    /** Holds information about an item in bulk create - id, index in original request array, action successful, error (if failed) */
+    itemMetadata?: ItemMetadata;
+    item?: Item;
+}
+export 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;
+}
+export interface ApplicationError {
+    code?: string;
+    description?: string;
+    data?: Record<string, any> | null;
+}
+export 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;
+}
+export interface GetProjectItemRequest {
+    /** Id of the Project the item is part of */
+    projectId: string;
+    /** Id of the ProjectItem to retrieve */
+    itemId: string;
+}
+export interface GetProjectItemResponse {
+    /** Id of the Project the item is part of */
+    projectId?: string;
+    /** The retrieved ProjectItem */
+    item?: Item;
+}
+export interface ListProjectItemsRequest {
+    /** Id of the Project the item is part of */
+    projectId: string;
+    /** limit and offset for ProjectItems - maximum limit is 200 per request, default is 50 */
+    paging?: Paging;
+}
+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 ListProjectItemsResponse {
+    /** Id of the Project the item is part of */
+    projectId?: string;
+    /** ProjectItems retrieved */
+    items?: Item[];
+    /** Paging metadata */
+    pagingMetadataV2?: PagingMetadataV2;
+    /** 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 pointing to next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to previous page in the list of results. */
+    prev?: string | null;
+}
+export interface QueryProjectItemsRequest {
+    /** WQL expression */
+    query?: QueryV2;
+    /** limit and offset for ProjectItems - maximum limit is 200 per request, default is 50 */
+    paging?: Paging;
+}
+export interface QueryV2 extends QueryV2PagingMethodOneOf {
+    /**
+     * 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[];
+    /** 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;
+}
+/** @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 CursorPaging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get 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 QueryProjectItemsResponse {
+    /** ProjectItems retrieved */
+    items?: Item[];
+    /** Paging metadata */
+    metadata?: PagingMetadataV2;
+}
+export interface UpdateProjectItemRequest {
+    /** Id of the Project the item is part of */
+    projectId: string;
+    /** ProjectItem to be updated, may be partial */
+    item: Item;
+}
+export interface UpdateProjectItemResponse {
+    /** Id of the Project the item is part of */
+    projectId?: string;
+    /** The updated ProjectItem */
+    item?: Item;
+}
+export interface BulkUpdateProjectItemsRequest {
+    /** Id of the Project the items are part of */
+    projectId: string;
+    /** items to be updated. */
+    items: Item[];
+}
+export interface BulkUpdateProjectItemsResponse {
+    /** Id of the Project the item is part of */
+    projectId?: string;
+    /** Array with all updated items results. */
+    results?: BulkUpdateProjectItemResult[];
+    /** Holds metadata of the entire bulk update operation */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkUpdateProjectItemResult {
+    /** Holds information about an item in bulk update - id, index in original request array, action successful, error (if failed). */
+    itemMetadata?: ItemMetadata;
+    item?: Item;
+}
+export interface DeleteProjectItemRequest {
+    /** Id of the Project the item is part of */
+    projectId: string;
+    /** Id of the Item to delete */
+    itemId: string;
+}
+export interface DeleteProjectItemResponse {
+    /** Id of the Project the item is part of */
+    projectId?: string;
+    /** Id of deleted item */
+    itemId?: string;
+}
+export interface BulkDeleteProjectItemsRequest {
+    /** Id of the project */
+    projectId: string;
+    /** Ids of the items to be deleted */
+    itemIds: string[];
+}
+export interface BulkDeleteProjectItemsResponse {
+    /** Id of the Project the item is part of */
+    projectId?: string;
+    /** Array with all deleted items results */
+    results?: BulkDeleteProjectItemResult[];
+    /** Holds metadata of the entire bulk delete operation */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkDeleteProjectItemResult {
+    /** Holds information about an item in bulk delete - id, index in original request array, action successful, error (if failed) */
+    itemMetadata?: ItemMetadata;
+    /** Id of the ProjectItem */
+    itemId?: string;
+}
+export interface CreateProjectGalleryRequest {
+    /** Id of Project to create */
+    projectId?: string;
+}
+export interface CreateProjectGalleryResponse {
+    /** Id of created Project */
+    projectId?: string;
+    /** Id of created gallery */
+    galleryId?: string;
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    /** random GUID so clients can tell if event was already handled */
+    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;
+    /**
+     * Assuming that all messages including Actions have id
+     * Example: The id of the specific order, the id of a specific campaign
+     */
+    entityId?: string;
+    /** The time of the event. Useful if there was a delay in dispatching */
+    eventTime?: Date;
+    /**
+     * A field that should be set if this event was triggered by an anonymize request.
+     * For example you must set it to true when sending an event as a result of a GDPR right to be forgotten request.
+     * NOTE: This field is not relevant for `EntityCreatedEvent` but is located here for better ergonomics of consumers.
+     */
+    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;
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;
+}
+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 {
+}
+export interface ActionEvent {
+    bodyAsJson?: string;
+}
+export interface ExtendedFieldsUpdatedEvent {
+    currentEntityAsJson?: string;
+}
+export interface Empty {
+}
+export interface DuplicateProjectItemsRequest {
+    /** Id of Project to duplicate */
+    originProjectId?: string;
+    /** Target project ID to duplicate to (same instance as request) */
+    targetProjectId?: string;
+}
+export interface DuplicateProjectItemsResponse {
+    /** Id of target project */
+    projectId?: string;
+    /** Result metadata */
+    bulkActionMetadata?: BulkActionMetadata;
+}

package/build/cjs/src/portfolio-project-items-v1-project-item.types.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SortOrder = exports.VideoType = exports.ImageType = exports.Type = void 0;
+var Type;
+(function (Type) {
+    Type["UNDEFINED"] = "UNDEFINED";
+    Type["IMAGE"] = "IMAGE";
+    Type["VIDEO"] = "VIDEO";
+})(Type = exports.Type || (exports.Type = {}));
+var ImageType;
+(function (ImageType) {
+    ImageType["UNDEFINED"] = "UNDEFINED";
+    ImageType["WIX_MEDIA"] = "WIX_MEDIA";
+    ImageType["EXTERNAL"] = "EXTERNAL";
+})(ImageType = exports.ImageType || (exports.ImageType = {}));
+var VideoType;
+(function (VideoType) {
+    VideoType["UNDEFINED"] = "UNDEFINED";
+    VideoType["WIX_MEDIA"] = "WIX_MEDIA";
+    VideoType["YOUTUBE"] = "YOUTUBE";
+    VideoType["VIMEO"] = "VIMEO";
+})(VideoType = exports.VideoType || (exports.VideoType = {}));
+var SortOrder;
+(function (SortOrder) {
+    SortOrder["ASC"] = "ASC";
+    SortOrder["DESC"] = "DESC";
+})(SortOrder = exports.SortOrder || (exports.SortOrder = {}));
+//# sourceMappingURL=portfolio-project-items-v1-project-item.types.js.map

package/build/cjs/src/portfolio-project-items-v1-project-item.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"portfolio-project-items-v1-project-item.types.js","sourceRoot":"","sources":["../../../src/portfolio-project-items-v1-project-item.types.ts"],"names":[],"mappings":";;;AA+DA,IAAY,IAIX;AAJD,WAAY,IAAI;IACd,+BAAuB,CAAA;IACvB,uBAAe,CAAA;IACf,uBAAe,CAAA;AACjB,CAAC,EAJW,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAIf;AAoBD,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,oCAAuB,CAAA;IACvB,oCAAuB,CAAA;IACvB,kCAAqB,CAAA;AACvB,CAAC,EAJW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAIpB;AAsDD,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,oCAAuB,CAAA;IACvB,oCAAuB,CAAA;IACvB,gCAAmB,CAAA;IACnB,4BAAe,CAAA;AACjB,CAAC,EALW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAKpB;AAgQD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB"}