@wix/metro 1.0.64

package/build/es/src/metroinspector-v1-product.universal.d.ts

@@ -0,0 +1,348 @@
+export declare const __debug: {
+    verboseLogging: {
+        on: () => boolean;
+        off: () => boolean;
+    };
+};
+/** Physical address */
+export interface Address extends AddressStreetOneOf {
+    /** Street name and number. */
+    streetAddress?: StreetAddress;
+    /** Main address line, usually street and number as free text. */
+    addressLine1?: string | null;
+    /** Country code. */
+    country?: string | null;
+    /** Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
+    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 */
+export interface AddressStreetOneOf {
+    /** Street name and number. */
+    streetAddress?: StreetAddress;
+    /** Main address line, usually street and number as free text. */
+    addressLine?: string | null;
+}
+export interface StreetAddress {
+    /** Street number. */
+    number?: string;
+    /** Street name. */
+    name?: string;
+}
+export interface AddressLocation {
+    /** Address latitude. */
+    latitude?: number | null;
+    /** Address longitude. */
+    longitude?: number | null;
+}
+export interface Subdivision {
+    /** Short subdivision code. */
+    code?: string;
+    /** Subdivision full name. */
+    name?: string;
+}
+export declare enum SubdivisionType {
+    UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
+    /** State */
+    ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
+    /** County */
+    ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
+    /** City/town */
+    ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
+    /** Neighborhood/quarter */
+    ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
+    /** Street/block */
+    ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
+    /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
+    COUNTRY = "COUNTRY"
+}
+export interface VideoResolution {
+    /** Video URL. */
+    url?: string;
+    /** Video height. */
+    height?: number;
+    /** Video width. */
+    width?: number;
+    /** Video format for example, mp4, hls. */
+    format?: string;
+}
+export 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;
+}
+export interface Variant {
+    name?: string;
+    value?: string;
+    image?: string;
+}
+export interface MyAddress {
+    country?: string | null;
+    subdivision?: string | null;
+    city?: string | null;
+    postalCode?: string | null;
+    streetAddress?: StreetAddress;
+}
+export interface CreateProductRequest {
+    product?: Product;
+}
+export interface CreateProductResponse {
+    product?: Product;
+}
+export interface DeleteProductRequest {
+    productId: string;
+}
+export interface DeleteProductResponse {
+}
+export interface UpdateProductRequest {
+    productId: string;
+    product?: Product;
+    /** Explicit list of fields to update. */
+    mask?: string[];
+}
+export interface UpdateProductResponse {
+    product?: Product;
+}
+export interface GetProductRequest {
+    productId: string;
+}
+export interface GetProductResponse {
+    product?: Product;
+}
+export interface GetProductsStartWithRequest {
+    title: string;
+    addressLine2?: string | null;
+}
+export interface GetProductsStartWithResponse {
+    products?: Product[];
+}
+export 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;
+}
+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 {
+    /** 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 QueryProductsResponse {
+    products?: Product[];
+    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 declare type Product = {
+    _id: string;
+    name: string | null;
+    collectionId: string;
+    _createdDate: Date;
+    modifiedDate: Date;
+    image: string;
+    address: Address;
+    document: string;
+    video: string;
+    pageLink: PageLink;
+    audio: string;
+    color: string | null;
+    localDate: string | null;
+    localTime: string | null;
+    localDateTime: string | null;
+    variants: Variant[];
+    mainVariant: Variant;
+    customAddress: MyAddress;
+    guid: string;
+};
+/**
+ * Creating a product
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.product.title
+ */
+export declare function createProduct(options?: CreateProductOptions): Promise<Product>;
+export interface CreateProductOptions {
+    product?: Product;
+}
+/** @public
+ * @documentationMaturity preview
+ * @requiredField productId
+ */
+export declare function deleteProduct(productId: string): Promise<void>;
+/** @public
+ * @documentationMaturity preview
+ * @requiredField options.product._id
+ * @requiredField productId
+ */
+export declare function updateProduct(productId: string, options?: UpdateProductOptions): Promise<Product>;
+export interface UpdateProductOptions {
+    product?: Product;
+    /** Explicit list of fields to update. */
+    mask?: string[];
+}
+/**
+ * override description
+ * @public
+ * @documentationMaturity preview
+ * @requiredField productId
+ * @param arg1 - ## new override param 1
+ * @returns ## override return
+ */
+export declare function getProduct(productId: string): Promise<Product>;
+/** @public
+ * @documentationMaturity preview
+ * @requiredField title
+ */
+export declare function getProductsStartWith(title: string, options?: GetProductsStartWithOptions): Promise<GetProductsStartWithResponse>;
+export interface GetProductsStartWithOptions {
+    addressLine2?: string | null;
+}
+/** @public
+ * @documentationMaturity preview
+ */
+export declare function queryProducts(options?: QueryProductsOptions): ProductsQueryBuilder;
+export interface QueryProductsOptions {
+    /** Whether variants should be included in the response. */
+    includeVariants?: boolean | undefined;
+    /** Whether hidden products should be included in the response. Requires permissions to manage products. */
+    includeHiddenProducts?: boolean | undefined;
+    /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */
+    includeMerchantSpecificData?: boolean | undefined;
+}
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+export interface ProductsQueryResult extends QueryCursorResult {
+    items: Product[];
+    query: ProductsQueryBuilder;
+    next: () => Promise<ProductsQueryResult>;
+    prev: () => Promise<ProductsQueryResult>;
+}
+export interface ProductsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: 'title' | 'collectionId' | 'guid', value: any) => ProductsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: 'title' | 'guid', value: any) => ProductsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: 'title' | 'guid', value: string) => ProductsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     * @documentationMaturity preview
+     */
+    hasSome: (propertyName: 'title' | 'guid', value: any[]) => ProductsQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: 'title' | 'guid', value: any) => ProductsQueryBuilder;
+    /** @documentationMaturity preview */
+    exists: (propertyName: 'title' | 'guid', value: boolean) => ProductsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'title' | 'collectionId' | 'guid'>) => ProductsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'title' | 'collectionId' | 'guid'>) => ProductsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => ProductsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => ProductsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<ProductsQueryResult>;
+}
+export {};