@wix/auto_sdk_metro_products 1.0.2 → 1.0.4

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

@@ -1,626 +0,0 @@
-export interface FocalPoint {
-    /** X-coordinate of the focal point. */
-    x?: number;
-    /** Y-coordinate of the focal point. */
-    y?: number;
-    /** crop by height */
-    height?: number | null;
-    /** crop by width */
-    width?: number | null;
-}
-/** 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.
-     * @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 */
-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"
-}
-/** Subdivision Concordance values */
-export interface StandardDetails {
-    /**
-     * subdivision iso-3166-2 code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). e.g. US-NY, GB-SCT, NO-30
-     * @maxLength 20
-     */
-    iso31662?: string | null;
-}
-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;
-    /**
-     * rel of link
-     * @maxSize 20
-     */
-    rel?: LinkRel[];
-}
-/**
- * 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.
- */
-export 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"
-}
-export interface Variant {
-    name?: string;
-    value?: string;
-    image?: string;
-}
-export interface MyAddress {
-    /** @format COUNTRY */
-    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 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;
-}
-export interface CountProductsResponse {
-    count?: number;
-}
-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.
-     *
-     * 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 */
-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.
-     * @maxLength 512
-     */
-    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.
-     * @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;
-}
-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 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;
-}
-export 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;
-}
-export interface BulkCreateProductsResponse {
-    /**
-     * @minSize 1
-     * @maxSize 100
-     */
-    results?: BulkProductResult[];
-    bulkActionMetadata?: BulkActionMetadata;
-}
-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 {
-    /** Error code. */
-    code?: string;
-    /** Description of the error. */
-    description?: string;
-    /** Data related to the error. */
-    data?: Record<string, any> | null;
-}
-export interface BulkProductResult {
-    /** Defined in wix.commons */
-    itemMetadata?: ItemMetadata;
-    /** Only exists if `returnEntity` was set to true in the request */
-    item?: Product;
-}
-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 BulkUpdateProductsRequest {
-    /**
-     * @minSize 1
-     * @maxSize 100
-     */
-    products: MaskedProduct[];
-    /** set to `true` if you wish to receive back the updated products in the response */
-    returnEntity?: boolean;
-}
-export interface MaskedProduct {
-    /** Product to be updated, may be partial */
-    product?: Product;
-}
-export interface BulkUpdateProductsResponse {
-    /**
-     * @minSize 1
-     * @maxSize 100
-     */
-    results?: BulkUpdateProductsResponseBulkProductResult[];
-    bulkActionMetadata?: BulkActionMetadata;
-}
-export interface BulkUpdateProductsResponseBulkProductResult {
-    itemMetadata?: ItemMetadata;
-    /** Only exists if `returnEntity` was set to true in the request */
-    item?: Product;
-}
-export interface BulkDeleteProductsRequest {
-    /**
-     * @minSize 1
-     * @maxSize 100
-     * @format GUID
-     */
-    productIds: string[];
-}
-export interface BulkDeleteProductsResponse {
-    /**
-     * @minSize 1
-     * @maxSize 100
-     */
-    results?: BulkDeleteProductsResponseBulkProductResult[];
-    bulkActionMetadata?: BulkActionMetadata;
-}
-export interface BulkDeleteProductsResponseBulkProductResult {
-    itemMetadata?: ItemMetadata;
-}
-export interface ResetProductsDbRequest {
-}
-export interface ResetProductsDbResponse {
-}
-interface StreetAddressNonNullableFields {
-    number: string;
-    name: string;
-    apt: string;
-}
-interface SubdivisionNonNullableFields {
-    name: string;
-}
-interface AddressNonNullableFields {
-    streetAddress?: StreetAddressNonNullableFields;
-    subdivisions: SubdivisionNonNullableFields[];
-}
-interface PageLinkNonNullableFields {
-    pageId: string;
-    rel: LinkRel[];
-}
-interface VariantNonNullableFields {
-    name: string;
-    value: string;
-    image: string;
-}
-interface MyAddressNonNullableFields {
-    streetAddress?: StreetAddressNonNullableFields;
-}
-export interface ProductNonNullableFields {
-    _id: string;
-    collectionId: string;
-    image: string;
-    address?: AddressNonNullableFields;
-    document: string;
-    video: string;
-    pageLink?: PageLinkNonNullableFields;
-    audio: string;
-    variants: VariantNonNullableFields[];
-    mainVariant?: VariantNonNullableFields;
-    customAddress?: MyAddressNonNullableFields;
-    guid: string;
-}
-export interface CreateProductResponseNonNullableFields {
-    product?: ProductNonNullableFields;
-}
-export interface UpdateProductResponseNonNullableFields {
-    product?: ProductNonNullableFields;
-}
-export interface GetProductResponseNonNullableFields {
-    product?: ProductNonNullableFields;
-}
-export interface CountProductsResponseNonNullableFields {
-    count: number;
-}
-export interface GetProductsStartWithResponseNonNullableFields {
-    products: ProductNonNullableFields[];
-}
-export interface QueryProductsResponseNonNullableFields {
-    products: ProductNonNullableFields[];
-}
-interface ApplicationErrorNonNullableFields {
-    code: string;
-    description: string;
-}
-interface ItemMetadataNonNullableFields {
-    originalIndex: number;
-    success: boolean;
-    error?: ApplicationErrorNonNullableFields;
-}
-interface BulkProductResultNonNullableFields {
-    itemMetadata?: ItemMetadataNonNullableFields;
-    item?: ProductNonNullableFields;
-}
-interface BulkActionMetadataNonNullableFields {
-    totalSuccesses: number;
-    totalFailures: number;
-    undetailedFailures: number;
-}
-export interface BulkCreateProductsResponseNonNullableFields {
-    results: BulkProductResultNonNullableFields[];
-    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
-}
-interface BulkUpdateProductsResponseBulkProductResultNonNullableFields {
-    itemMetadata?: ItemMetadataNonNullableFields;
-    item?: ProductNonNullableFields;
-}
-export interface BulkUpdateProductsResponseNonNullableFields {
-    results: BulkUpdateProductsResponseBulkProductResultNonNullableFields[];
-    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
-}
-interface BulkDeleteProductsResponseBulkProductResultNonNullableFields {
-    itemMetadata?: ItemMetadataNonNullableFields;
-}
-export interface BulkDeleteProductsResponseNonNullableFields {
-    results: BulkDeleteProductsResponseBulkProductResultNonNullableFields[];
-    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
-}
-export interface Product {
-    _id: string;
-    name: string | null;
-    collectionId: string;
-    _createdDate: Date | null;
-    modifiedDate: Date | null;
-    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
- * @requiredField options.product.title
- * @fqn wix.coreservices.metroinspector.v1.products.ProductsService.CreateProduct
- */
-export declare function createProduct(options?: CreateProductOptions): Promise<Product & ProductNonNullableFields>;
-export interface CreateProductOptions {
-    product?: Product;
-}
-/** @public
- * @requiredField productId
- * @fqn wix.coreservices.metroinspector.v1.products.ProductsService.DeleteProduct
- */
-export declare function deleteProduct(productId: string): Promise<void>;
-/** @public
- * @requiredField options.product._id
- * @requiredField productId
- * @fqn wix.coreservices.metroinspector.v1.products.ProductsService.UpdateProduct
- */
-export declare function updateProduct(productId: string, options?: UpdateProductOptions): Promise<Product & ProductNonNullableFields>;
-export interface UpdateProductOptions {
-    product?: Product;
-    /** Explicit list of fields to update. */
-    mask?: string[];
-}
-/**
- * override description
- * @public
- * @requiredField productId
- * @param arg1 - ## new override param 1
- * @returns ## override return
- * @fqn wix.coreservices.metroinspector.v1.products.ProductsService.GetProduct
- */
-export declare function getProduct(productId: string): Promise<Product & ProductNonNullableFields>;
-/** @public
- * @fqn wix.coreservices.metroinspector.v1.products.ProductsService.CountProducts
- */
-export declare function countProducts(options?: CountProductsOptions): Promise<CountProductsResponse & CountProductsResponseNonNullableFields>;
-export interface CountProductsOptions {
-    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;
-}
-/** @public
- * @requiredField title
- * @fqn wix.coreservices.metroinspector.v1.products.ProductsService.GetProductsStartWith
- */
-export declare function getProductsStartWith(title: string, options?: GetProductsStartWithOptions): Promise<GetProductsStartWithResponse & GetProductsStartWithResponseNonNullableFields>;
-export interface GetProductsStartWithOptions {
-    addressLine2?: string | null;
-}
-/** @public
- * @fqn wix.coreservices.metroinspector.v1.products.ProductsService.QueryProducts
- */
-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.
-     */
-    eq: (propertyName: 'title' | 'collectionId' | 'guid', value: any) => ProductsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     */
-    ne: (propertyName: 'title' | 'guid', value: any) => ProductsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `string`.
-     * @param string - String to compare against. Case-insensitive.
-     */
-    startsWith: (propertyName: 'title' | 'guid', value: string) => ProductsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `values`.
-     * @param values - List of values to compare against.
-     */
-    hasSome: (propertyName: 'title' | 'guid', value: any[]) => ProductsQueryBuilder;
-    in: (propertyName: 'title' | 'guid', value: any) => ProductsQueryBuilder;
-    exists: (propertyName: 'title' | 'guid', value: boolean) => ProductsQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
-    ascending: (...propertyNames: Array<'title' | 'collectionId' | 'guid'>) => ProductsQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
-    descending: (...propertyNames: Array<'title' | 'collectionId' | 'guid'>) => ProductsQueryBuilder;
-    /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
-    limit: (limit: number) => ProductsQueryBuilder;
-    /** @param cursor - A pointer to specific record */
-    skipTo: (cursor: string) => ProductsQueryBuilder;
-    find: () => Promise<ProductsQueryResult>;
-}
-/**
- * create multiple products in a single request. Works synchronously
- * @public
- * @requiredField products
- * @fqn wix.coreservices.metroinspector.v1.products.ProductsService.BulkCreateProducts
- */
-export declare function bulkCreateProducts(products: Product[], options?: BulkCreateProductsOptions): Promise<BulkCreateProductsResponse & BulkCreateProductsResponseNonNullableFields>;
-export interface BulkCreateProductsOptions {
-    /** set to `true` if you wish to receive back the created products in the response */
-    returnEntity?: boolean;
-}
-/**
- * update multiple products in a single request. Works synchronously.
- * @public
- * @requiredField products
- * @fqn wix.coreservices.metroinspector.v1.products.ProductsService.BulkUpdateProducts
- */
-export declare function bulkUpdateProducts(products: MaskedProduct[], options?: BulkUpdateProductsOptions): Promise<BulkUpdateProductsResponse & BulkUpdateProductsResponseNonNullableFields>;
-export interface BulkUpdateProductsOptions {
-    /** set to `true` if you wish to receive back the updated products in the response */
-    returnEntity?: boolean;
-}
-/**
- * deletes multiple products in a single request. Works synchronously.
- * @public
- * @requiredField productIds
- * @fqn wix.coreservices.metroinspector.v1.products.ProductsService.BulkDeleteProducts
- */
-export declare function bulkDeleteProducts(productIds: string[]): Promise<BulkDeleteProductsResponse & BulkDeleteProductsResponseNonNullableFields>;
-export {};