Hierarchy

  • UserGroups

Properties

impersonating: boolean = false

Methods

  • Description

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

    Example

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

    Returns UserGroups

  • Create a new user group. 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

    • TUserGroup extends UserGroup<any, TUserGroup>

    Parameters

    • buyerID: string

      ID of the buyer.

    • userGroup: UserGroup<any>

      Required fields: Name

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredDeep<TUserGroup>>

  • Delete a user group. Check out the docs for more info

    Parameters

    • buyerID: string

      ID of the buyer.

    • userGroupID: string

      ID of the user group.

    • requestOptions: RequestOptions = {}

    Returns Promise<void>

  • Delete a user group user assignment. Check out the docs for more info

    Parameters

    • buyerID: string

      ID of the buyer.

    • userGroupID: string

      ID of the user group.

    • userID: string

      ID of the user.

    • requestOptions: RequestOptions = {}

    Returns Promise<void>

  • Get a single user group. Check out the docs for more info

    Type Parameters

    • TUserGroup extends UserGroup<any, TUserGroup>

    Parameters

    • buyerID: string

      ID of the buyer.

    • userGroupID: string

      ID of the user group.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredDeep<TUserGroup>>

  • Get a list of user groups. Check out the docs for more info

    Type Parameters

    • TUserGroup extends UserGroup<any, TUserGroup>

    Parameters

    • buyerID: string

      ID of the buyer.

    • listOptions: {
          filters?: Filters;
          page?: number;
          pageSize?: number;
          search?: string;
          searchOn?: ("ID" | "Name" | "Description")[];
          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" | "Description")[]

        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<TUserGroup>>>

  • Get a list of user group user assignments. Check out the docs for more info

    Type Parameters

    Parameters

    • buyerID: string

      ID of the buyer.

    • listOptions: {
          page?: number;
          pageSize?: number;
          userGroupID?: string;
          userID?: string;
      } = {}
      • 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 userGroupID?: string

        ID of the user group.

      • Optional userID?: string

        ID of the user.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredObjectDeep<ListPage<TUserGroupAssignment>>>

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

    Type Parameters

    • TUserGroup extends UserGroup<any, TUserGroup>

    Parameters

    • buyerID: string

      ID of the buyer.

    • userGroupID: string

      ID of the user group.

    • userGroup: UserGroup<any>

      Required fields: Name

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredDeep<TUserGroup>>

Generated using TypeDoc