Hierarchy

  • DeliveryConfigurations

Properties

impersonating: boolean = false

Methods

  • Get a list of delivery configurations. Check out the docs for more info

    Type Parameters

    Parameters

    • listOptions: {
          filters?: Filters;
          page?: number;
          pageSize?: number;
          search?: string;
          searchOn?: ("ID" | "Name")[];
          sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
      } = {}
      • 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. Default: 1. 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. Default: 20, max: 100.

      • Optional search?: string

        Word or phrase to search for.

      • Optional searchOn?: ("ID" | "Name")[]

        Comma-delimited list of fields to search on.

      • Optional sortBy?: ("ID" | "Name" | "!ID" | "!Name")[]

        Comma-delimited list of fields to sort by.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredObjectDeep<ListPage<TDeliveryConfig>>>

Generated using TypeDoc