Class SeamHttpAcsCredentials

constructor

• new SeamHttpAcsCredentials(apiKeyOrOptions?): SeamHttpAcsCredentials

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAcsCredentials

client

assign

• assign(body?): Promise<void>

• Parameters

  • Optional body: {
        acs_credential_id: string;
        acs_user_id: string;
    }

    • acs_credential_id: string

    • acs_user_id: string

  Returns Promise<void>

create

• create(body?): Promise<{
      acs_credential_id: string;
      acs_system_id: string;
      acs_user_id?: string;
      code: null | string;
      created_at: string;
      external_type: "pti_card" | "brivo_credential";
      external_type_display_name: string;
      workspace_id: string;
  }>

• Parameters

  • Optional body: {
        acs_user_id: string;
        code: string;
    }

    • acs_user_id: string

    • code: string

  Returns Promise<{
      acs_credential_id: string;
      acs_system_id: string;
      acs_user_id?: string;
      code: null | string;
      created_at: string;
      external_type: "pti_card" | "brivo_credential";
      external_type_display_name: string;
      workspace_id: string;
  }>

delete

• delete(body?): Promise<void>

• Parameters

  • Optional body: {
        acs_credential_id: string;
    }

    • acs_credential_id: string

  Returns Promise<void>

get

• get(body?): Promise<{
      acs_credential_id: string;
      acs_system_id: string;
      acs_user_id?: string;
      code: null | string;
      created_at: string;
      external_type: "pti_card" | "brivo_credential";
      external_type_display_name: string;
      workspace_id: string;
  }>

• Parameters

  • Optional body: {
        acs_credential_id: string;
    }

    • acs_credential_id: string

  Returns Promise<{
      acs_credential_id: string;
      acs_system_id: string;
      acs_user_id?: string;
      code: null | string;
      created_at: string;
      external_type: "pti_card" | "brivo_credential";
      external_type_display_name: string;
      workspace_id: string;
  }>

list

• list(body?): Promise<{
      acs_credential_id: string;
      acs_system_id: string;
      acs_user_id?: string;
      code: null | string;
      created_at: string;
      external_type: "pti_card" | "brivo_credential";
      external_type_display_name: string;
      workspace_id: string;
  }[]>

• Parameters

  • Optional body: AcsCredentialsListParams

  Returns Promise<{
      acs_credential_id: string;
      acs_system_id: string;
      acs_user_id?: string;
      code: null | string;
      created_at: string;
      external_type: "pti_card" | "brivo_credential";
      external_type_display_name: string;
      workspace_id: string;
  }[]>

unassign

• unassign(body?): Promise<void>

• Parameters

  • Optional body: {
        acs_credential_id: string;
        acs_user_id: string;
    }

    • acs_credential_id: string

    • acs_user_id: string

  Returns Promise<void>

Static fromApiKey

• fromApiKey(apiKey, options?): SeamHttpAcsCredentials

• Parameters

  • apiKey: string

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

  Returns SeamHttpAcsCredentials

Static fromClient

• fromClient(client, options?): SeamHttpAcsCredentials

• Parameters

  • client: AxiosInstance

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

  Returns SeamHttpAcsCredentials

Static fromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpAcsCredentials

• Parameters

  • clientSessionToken: string

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

  Returns SeamHttpAcsCredentials

Static fromConsoleSessionToken

• fromConsoleSessionToken(consoleSessionToken, workspaceId, options?): SeamHttpAcsCredentials

• Parameters

  • consoleSessionToken: string

  • workspaceId: string

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

  Returns SeamHttpAcsCredentials

Static fromPersonalAccessToken

• fromPersonalAccessToken(personalAccessToken, workspaceId, options?): SeamHttpAcsCredentials

• Parameters

  • personalAccessToken: string

  • workspaceId: string

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

  Returns SeamHttpAcsCredentials

Static fromPublishableKey

• fromPublishableKey(publishableKey, userIdentifierKey, options?): Promise<SeamHttpAcsCredentials>

• Parameters

  • publishableKey: string

  • userIdentifierKey: string

  • options: SeamHttpFromPublishableKeyOptions = {}

  Returns Promise<SeamHttpAcsCredentials>