Class SeamHttpSeamCustomerV1StaffMembers

constructor

• new SeamHttpSeamCustomerV1StaffMembers(
      apiKeyOrOptions?: string | SeamHttpOptions,
  ): SeamHttpSeamCustomerV1StaffMembers

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpSeamCustomerV1StaffMembers

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

createPaginator

• createPaginator<
      const TResponse,
      const TResponseKey extends string | number | symbol,
  >(
      request: SeamHttpRequest<TResponse, TResponseKey>,
  ): SeamPaginator<TResponse, TResponseKey>

  Type Parameters

  • const TResponse
  • const TResponseKey extends string | number | symbol

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

get

• get(
      parameters?: { staff_member_key: string },
      options?: SeamCustomerV1StaffMembersGetOptions,
  ): SeamCustomerV1StaffMembersGetRequest

  Parameters

  • Optionalparameters: { staff_member_key: string }

    • staff_member_key: string

      Key of staff member to get.
  • options: SeamCustomerV1StaffMembersGetOptions = {}

  Returns SeamCustomerV1StaffMembersGetRequest

list

• list(
      parameters?: {
          created_before?: Date;
          limit?: number;
          page_cursor?: null | string;
          space_id?: string;
          space_key?: string;
      },
      options?: SeamCustomerV1StaffMembersListOptions,
  ): SeamCustomerV1StaffMembersListRequest

  Parameters

  • Optionalparameters: {
        created_before?: Date;
        limit?: number;
        page_cursor?: null | string;
        space_id?: string;
        space_key?: string;
    }

    • Optionalcreated_before?: Date

      Timestamp by which to limit returned staff members. Returns staff members created before this timestamp.

    • Optionallimit?: number

      Maximum number of records to return per page.

    • Optionalpage_cursor?: null | string

      Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.

    • Optionalspace_id?: string

      Filter staff members by space ID (UUID).

    • Optionalspace_key?: string

      Filter staff members by space key.
  • options: SeamCustomerV1StaffMembersListOptions = {}

  Returns SeamCustomerV1StaffMembersListRequest

updateClientSessionToken

• updateClientSessionToken(clientSessionToken: string): Promise<void>

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(
      apiKey: string,
      options?: Omit<SeamHttpOptionsWithApiKey, "apiKey">,
  ): SeamHttpSeamCustomerV1StaffMembers

  Parameters

  • apiKey: string
  • options: Omit<SeamHttpOptionsWithApiKey, "apiKey"> = {}

  Returns SeamHttpSeamCustomerV1StaffMembers

StaticfromClient

• fromClient(
      client: AxiosInstance,
      options?: Omit<SeamHttpOptionsWithClient, "client">,
  ): SeamHttpSeamCustomerV1StaffMembers

  Parameters

  • client: AxiosInstance
  • options: Omit<SeamHttpOptionsWithClient, "client"> = {}

  Returns SeamHttpSeamCustomerV1StaffMembers

StaticfromClientSessionToken

• fromClientSessionToken(
      clientSessionToken: string,
      options?: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken">,
  ): SeamHttpSeamCustomerV1StaffMembers

  Parameters

  • clientSessionToken: string
  • options: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken"> = {}

  Returns SeamHttpSeamCustomerV1StaffMembers

StaticfromConsoleSessionToken

• fromConsoleSessionToken(
      consoleSessionToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithConsoleSessionToken,
          "consoleSessionToken"
          | "workspaceId",
      >,
  ): SeamHttpSeamCustomerV1StaffMembers

  Parameters

  • consoleSessionToken: string
  • workspaceId: string
  • options: Omit<
        SeamHttpOptionsWithConsoleSessionToken,
        "consoleSessionToken"
        | "workspaceId",
    > = {}

  Returns SeamHttpSeamCustomerV1StaffMembers

StaticfromPersonalAccessToken

• fromPersonalAccessToken(
      personalAccessToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithPersonalAccessToken,
          "personalAccessToken"
          | "workspaceId",
      >,
  ): SeamHttpSeamCustomerV1StaffMembers

  Parameters

  • personalAccessToken: string
  • workspaceId: string
  • options: Omit<
        SeamHttpOptionsWithPersonalAccessToken,
        "personalAccessToken"
        | "workspaceId",
    > = {}

  Returns SeamHttpSeamCustomerV1StaffMembers

StaticfromPublishableKey

• fromPublishableKey(
      publishableKey: string,
      userIdentifierKey: string,
      options?: SeamHttpFromPublishableKeyOptions,
  ): Promise<SeamHttpSeamCustomerV1StaffMembers>

  Parameters

  • publishableKey: string
  • userIdentifierKey: string
  • options: SeamHttpFromPublishableKeyOptions = {}

  Returns Promise<SeamHttpSeamCustomerV1StaffMembers>