Class XpIndices

Hierarchy

  • XpIndices

Properties

impersonating

Methods

As Delete List Put

Properties

Private impersonating

impersonating: boolean = false

Methods

As

  • Description

    enables impersonation by calling the subsequent method with the stored impersonation token

    Example

    XpIndices.As().List() // lists XpIndices using the impersonated users' token

    Returns XpIndices

Delete

  • Delete a XP index Check out the docs for more info

    Parameters

    • thingType: XpThingType

      Thing type of the xp index. Possible values: Address, Variant, Order, OrderReturn, LineItem, CostCenter, CreditCard, Payment, Spec, SpecOption, UserGroup, Company, Category, PriceSchedule, Shipment, SpendingAccount, User, Promotion, ApprovalRule, SellerApprovalRule, Catalog, ProductFacet, MessageSender, InventoryRecord, ProductCollection, Subscription, GroupOrderInvitation.

    • key: string

      Key of the xp index.

    • requestOptions: RequestOptions = {}

    Returns Promise<void>

List

  • List XP indices Check out the docs for more info

    Type Parameters

    Parameters

    • listOptions: {
          filters?: Filters;
          page?: number;
          pageSize?: number;
          search?: string;
          searchOn?: ("ThingType" | "Key")[];
          sortBy?: ("ThingType" | "Key" | "!ThingType" | "!Key")[];
      } = {}
      • Optional filters?: Filters

        An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'

      • Optional page?: number

        Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.

      • Optional pageSize?: number

        Number of results to return per page.

      • Optional search?: string

        Word or phrase to search for.

      • Optional searchOn?: ("ThingType" | "Key")[]

        Comma-delimited list of fields to search on.

      • Optional sortBy?: ("ThingType" | "Key" | "!ThingType" | "!Key")[]

        Comma-delimited list of fields to sort by.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredObjectDeep<ListPage<TXpIndex>>>

Put

Settings

Member Visibility

Theme

Generated using TypeDoc