@wix/auto_sdk_metro_products 1.0.1 → 1.0.3

package/build/cjs/meta.d.ts

@@ -1 +1,447 @@
-export * from './src/metroinspector-v1-product-products.meta.js';
+import { CreateProductRequest as CreateProductRequest$1, CreateProductResponse as CreateProductResponse$1, DeleteProductRequest as DeleteProductRequest$1, DeleteProductResponse as DeleteProductResponse$1, UpdateProductRequest as UpdateProductRequest$1, UpdateProductResponse as UpdateProductResponse$1, GetProductRequest as GetProductRequest$1, GetProductResponse as GetProductResponse$1, CountProductsRequest as CountProductsRequest$1, CountProductsResponse as CountProductsResponse$1, GetProductsStartWithRequest as GetProductsStartWithRequest$1, GetProductsStartWithResponse as GetProductsStartWithResponse$1, QueryProductsRequest as QueryProductsRequest$1, QueryProductsResponse as QueryProductsResponse$1, BulkCreateProductsRequest as BulkCreateProductsRequest$1, BulkCreateProductsResponse as BulkCreateProductsResponse$1, BulkUpdateProductsRequest as BulkUpdateProductsRequest$1, BulkUpdateProductsResponse as BulkUpdateProductsResponse$1, BulkDeleteProductsRequest as BulkDeleteProductsRequest$1, BulkDeleteProductsResponse as BulkDeleteProductsResponse$1 } from './index.typings.js';
+import '@wix/sdk-types';
+
+interface Product {
+    title?: string | null;
+    id?: string;
+    collectionId?: string;
+    createdDate?: Date | null;
+    modifiedDate?: Date | null;
+    image?: Image;
+    address?: Address;
+    document?: Document;
+    video?: VideoV2;
+    pageLink?: PageLink;
+    audio?: Audio;
+    /** @format COLOR_HEX */
+    color?: string | null;
+    /** @format LOCAL_DATE */
+    localDate?: string | null;
+    /** @format LOCAL_TIME */
+    localTime?: string | null;
+    /** @format LOCAL_DATE_TIME */
+    localDateTime?: string | null;
+    variants?: Variant[];
+    mainVariant?: Variant;
+    customAddress?: MyAddress;
+    /**
+     * @readonly
+     * @format GUID
+     */
+    guid?: string;
+}
+interface Image {
+    /** WixMedia image ID. */
+    id?: string;
+    /** Image URL. */
+    url?: string;
+    /**
+     * Original image height.
+     * @readonly
+     */
+    height?: number;
+    /**
+     * Original image width.
+     * @readonly
+     */
+    width?: number;
+    /** Image alt text. */
+    altText?: string | null;
+    /**
+     * Image filename.
+     * @readonly
+     */
+    filename?: string | null;
+}
+/** Physical address */
+interface Address extends AddressStreetOneOf {
+    /** Street name and number. */
+    streetAddress?: StreetAddress;
+    /** Main address line, usually street and number as free text. */
+    addressLine?: string | null;
+    /**
+     * Country code.
+     * @format COUNTRY
+     */
+    country?: string | null;
+    /** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
+    subdivision?: string | null;
+    /** City name. */
+    city?: string | null;
+    /** Zip/postal code. */
+    postalCode?: string | null;
+    /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
+    addressLine2?: string | null;
+}
+/** @oneof */
+interface AddressStreetOneOf {
+    /** Street name and number. */
+    streetAddress?: StreetAddress;
+    /** Main address line, usually street and number as free text. */
+    addressLine?: string | null;
+}
+interface StreetAddress {
+    /** Street number. */
+    number?: string;
+    /** Street name. */
+    name?: string;
+}
+interface Document {
+    /** WixMedia ID. */
+    id?: string;
+    /** Document URL. */
+    url?: string;
+    /** Document filename. */
+    filename?: string | null;
+}
+interface VideoV2 {
+    /** WixMedia ID. */
+    id?: string;
+    /**
+     * Available resolutions for the video, starting with the optimal resolution.
+     * @readonly
+     * @maxSize 100
+     */
+    resolutions?: VideoResolution[];
+    /**
+     * Video filename.
+     * @readonly
+     */
+    filename?: string | null;
+}
+interface VideoResolution {
+    /** Video URL. */
+    url?: string;
+    /** Video height. */
+    height?: number;
+    /** Video width. */
+    width?: number;
+    /** Video format for example, mp4, hls. */
+    format?: string;
+}
+interface PageLink {
+    /** The page id we want from the site */
+    pageId?: string;
+    /** Where this link should open, supports _self and _blank or any name the user chooses. _self means same page, _blank means new page. */
+    target?: string | null;
+    /**
+     * rel of link
+     * @maxSize 20
+     */
+    rel?: LinkRelWithLiterals[];
+}
+/**
+ * The 'rel' attribute of the link. The rel attribute defines the relationship between a linked resource and the current document.
+ * Further reading (also about different possible rel types): https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel
+ * Following are the accepted 'rel' types by Wix applications.
+ */
+declare enum LinkRel {
+    /** default (not implemented) */
+    unknown_link_rel = "unknown_link_rel",
+    /** Indicates that the current document's original author or publisher does not endorse the referenced document. */
+    nofollow = "nofollow",
+    /** Instructs the browser to navigate to the target resource without granting the new browsing context access to the document that opened it. */
+    noopener = "noopener",
+    /** No Referer header will be included. Additionally, has the same effect as noopener. */
+    noreferrer = "noreferrer",
+    /** Indicates a link that resulted from advertisements or paid placements. */
+    sponsored = "sponsored"
+}
+/** @enumType */
+type LinkRelWithLiterals = LinkRel | 'unknown_link_rel' | 'nofollow' | 'noopener' | 'noreferrer' | 'sponsored';
+interface Audio {
+    /** WixMedia ID. */
+    id?: string;
+    /** Audio URL. */
+    url?: string;
+    /**
+     * Audio filename.
+     * @readonly
+     */
+    filename?: string | null;
+}
+interface Variant {
+    name?: string;
+    value?: string;
+    image?: Image;
+}
+interface MyAddress {
+    /** @format COUNTRY */
+    country?: string | null;
+    subdivision?: string | null;
+    city?: string | null;
+    postalCode?: string | null;
+    streetAddress?: StreetAddress;
+}
+interface CreateProductRequest {
+    product?: Product;
+}
+interface CreateProductResponse {
+    product?: Product;
+}
+interface DeleteProductRequest {
+    productId: string;
+}
+interface DeleteProductResponse {
+}
+interface UpdateProductRequest {
+    productId: string;
+    product?: Product;
+    /** Explicit list of fields to update. */
+    mask?: string[];
+}
+interface UpdateProductResponse {
+    product?: Product;
+}
+interface GetProductRequest {
+    productId: string;
+}
+interface GetProductResponse {
+    product?: Product;
+}
+interface CountProductsRequest {
+    filter?: Record<string, any> | null;
+    /** Whether variants should be included in the response. */
+    includeVariants?: boolean;
+    /** Whether hidden products should be included in the response. Requires permissions to manage products. */
+    includeHiddenProducts?: boolean;
+    /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */
+    includeMerchantSpecificData?: boolean;
+}
+interface CountProductsResponse {
+    count?: number;
+}
+interface GetProductsStartWithRequest {
+    title: string;
+    addressLine2?: string | null;
+}
+interface GetProductsStartWithResponse {
+    products?: Product[];
+}
+interface QueryProductsRequest {
+    query?: QueryV2;
+    /** Whether variants should be included in the response. */
+    includeVariants?: boolean;
+    /** Whether hidden products should be included in the response. Requires permissions to manage products. */
+    includeHiddenProducts?: boolean;
+    /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */
+    includeMerchantSpecificData?: boolean;
+}
+interface QueryV2 extends QueryV2PagingMethodOneOf {
+    /** Paging options to limit and offset 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 [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object.
+     *
+     * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
+     */
+    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 offset 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 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 QueryProductsResponse {
+    products?: Product[];
+    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 BulkCreateProductsRequest {
+    /**
+     * @minSize 1
+     * @maxSize 100
+     */
+    products: Product[];
+    /** set to `true` if you wish to receive back the created products in the response */
+    returnEntity?: boolean;
+}
+interface BulkCreateProductsResponse {
+    /**
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkProductResult[];
+    bulkActionMetadata?: BulkActionMetadata;
+}
+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 BulkProductResult {
+    /** Defined in wix.commons */
+    itemMetadata?: ItemMetadata;
+    /** Only exists if `returnEntity` was set to true in the request */
+    item?: Product;
+}
+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 BulkUpdateProductsRequest {
+    /**
+     * @minSize 1
+     * @maxSize 100
+     */
+    products: MaskedProduct[];
+    /** set to `true` if you wish to receive back the updated products in the response */
+    returnEntity?: boolean;
+}
+interface MaskedProduct {
+    /** Product to be updated, may be partial */
+    product?: Product;
+}
+interface BulkUpdateProductsResponse {
+    /**
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkUpdateProductsResponseBulkProductResult[];
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkUpdateProductsResponseBulkProductResult {
+    itemMetadata?: ItemMetadata;
+    /** Only exists if `returnEntity` was set to true in the request */
+    item?: Product;
+}
+interface BulkDeleteProductsRequest {
+    /**
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
+     */
+    productIds: string[];
+}
+interface BulkDeleteProductsResponse {
+    /**
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkDeleteProductsResponseBulkProductResult[];
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkDeleteProductsResponseBulkProductResult {
+    itemMetadata?: ItemMetadata;
+}
+
+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 createProduct(): __PublicMethodMetaInfo<'POST', {}, CreateProductRequest$1, CreateProductRequest, CreateProductResponse$1, CreateProductResponse>;
+declare function deleteProduct(): __PublicMethodMetaInfo<'DELETE', {
+    productId: string;
+}, DeleteProductRequest$1, DeleteProductRequest, DeleteProductResponse$1, DeleteProductResponse>;
+declare function updateProduct(): __PublicMethodMetaInfo<'PUT', {
+    productId: string;
+}, UpdateProductRequest$1, UpdateProductRequest, UpdateProductResponse$1, UpdateProductResponse>;
+declare function getProduct(): __PublicMethodMetaInfo<'GET', {
+    productId: string;
+}, GetProductRequest$1, GetProductRequest, GetProductResponse$1, GetProductResponse>;
+declare function countProducts(): __PublicMethodMetaInfo<'POST', {}, CountProductsRequest$1, CountProductsRequest, CountProductsResponse$1, CountProductsResponse>;
+declare function getProductsStartWith(): __PublicMethodMetaInfo<'GET', {
+    title: string;
+}, GetProductsStartWithRequest$1, GetProductsStartWithRequest, GetProductsStartWithResponse$1, GetProductsStartWithResponse>;
+declare function queryProducts(): __PublicMethodMetaInfo<'GET', {}, QueryProductsRequest$1, QueryProductsRequest, QueryProductsResponse$1, QueryProductsResponse>;
+declare function bulkCreateProducts(): __PublicMethodMetaInfo<'POST', {}, BulkCreateProductsRequest$1, BulkCreateProductsRequest, BulkCreateProductsResponse$1, BulkCreateProductsResponse>;
+declare function bulkUpdateProducts(): __PublicMethodMetaInfo<'PATCH', {}, BulkUpdateProductsRequest$1, BulkUpdateProductsRequest, BulkUpdateProductsResponse$1, BulkUpdateProductsResponse>;
+declare function bulkDeleteProducts(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteProductsRequest$1, BulkDeleteProductsRequest, BulkDeleteProductsResponse$1, BulkDeleteProductsResponse>;
+
+export { type __PublicMethodMetaInfo, bulkCreateProducts, bulkDeleteProducts, bulkUpdateProducts, countProducts, createProduct, deleteProduct, getProduct, getProductsStartWith, queryProducts, updateProduct };