Class AdminAddresses

Hierarchy

  • AdminAddresses

Properties

impersonating

Methods

As Create Delete Get List Patch Save

Properties

Private impersonating

impersonating: boolean = false

Methods

As

  • Description

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

    Example

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

    Returns AdminAddresses

Create

  • Create a new admin address. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. Check out the docs for more info

    Type Parameters

    • TAddress extends Address<any, TAddress>

    Parameters

    • address: Address<any>

      Required fields: Street1, City, State, Zip, Country

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredDeep<TAddress>>

Delete

Get

List

  • Get a list of admin addresses. Check out the docs for more info

    Type Parameters

    • TAddress extends Address<any, TAddress>

    Parameters

    • listOptions: {
          filters?: Filters;
          page?: number;
          pageSize?: number;
          search?: string;
          searchOn?: ("ID" | "AddressName" | "CompanyName" | "City" | "Street1" | "Street2" | "LastName" | "FirstName" | "State" | "Zip")[];
          sortBy?: ("ID" | "AddressName" | "CompanyName" | "City" | "Street1" | "Street2" | "LastName" | "FirstName" | "State" | "Zip" | "DateCreated" | "Country" | "Phone" | "!AddressName" | "!ID" | "!DateCreated" | "!CompanyName" | "!FirstName" | "!LastName" | "!Street1" | "!Street2" | "!City" | "!State" | "!Zip" | "!Country" | "!Phone")[];
      } = {}
      • 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" | "AddressName" | "CompanyName" | "City" | "Street1" | "Street2" | "LastName" | "FirstName" | "State" | "Zip")[]

        Comma-delimited list of fields to search on.

      • Optional sortBy?: ("ID" | "AddressName" | "CompanyName" | "City" | "Street1" | "Street2" | "LastName" | "FirstName" | "State" | "Zip" | "DateCreated" | "Country" | "Phone" | "!AddressName" | "!ID" | "!DateCreated" | "!CompanyName" | "!FirstName" | "!LastName" | "!Street1" | "!Street2" | "!City" | "!State" | "!Zip" | "!Country" | "!Phone")[]

        Comma-delimited list of fields to sort by.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredObjectDeep<ListPage<TAddress>>>

Patch

Save

  • Create or update an admin address. If an object with the same ID already exists, it will be overwritten. Check out the docs for more info

    Type Parameters

    • TAddress extends Address<any, TAddress>

    Parameters

    • addressID: string

      ID of the address.

    • address: Address<any>

      Required fields: Street1, City, State, Zip, Country

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredDeep<TAddress>>

Settings

Member Visibility

Theme

Generated using TypeDoc