Class SeamHttpAccessCodesUnmanaged

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAccessCodesUnmanaged

client

Readonlydefaults

convertToManaged

• convertToManaged(
      parameters: AccessCodesUnmanagedConvertToManagedParameters,
      options?: AccessCodesUnmanagedConvertToManagedOptions,
  ): AccessCodesUnmanagedConvertToManagedRequest

  Converts an unmanaged access code to an access code managed through Seam.

  An unmanaged access code has a limited set of operations that you can perform on it. Once you convert an unmanaged access code to a managed access code, the full set of access code operations and lifecycle events becomes available for it.

  Note that not all device providers support converting an unmanaged access code to a managed access code.

  Parameters

  • parameters: AccessCodesUnmanagedConvertToManagedParameters
  • options: AccessCodesUnmanagedConvertToManagedOptions = {}

  Returns AccessCodesUnmanagedConvertToManagedRequest

createPaginator

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

  Creates a new SeamPaginator to iterate over the paginated results of the request.

  Type Parameters

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

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

delete

• delete(
      parameters: AccessCodesUnmanagedDeleteParameters,
      options?: AccessCodesUnmanagedDeleteOptions,
  ): AccessCodesUnmanagedDeleteRequest

  Deletes an unmanaged access code.

  Parameters

  • parameters: AccessCodesUnmanagedDeleteParameters
  • options: AccessCodesUnmanagedDeleteOptions = {}

  Returns AccessCodesUnmanagedDeleteRequest

get

• get(
      parameters?: AccessCodesUnmanagedGetParameters,
      options?: AccessCodesUnmanagedGetOptions,
  ): AccessCodesUnmanagedGetRequest

  Returns a specified unmanaged access code.

  You must specify either access_code_id or both device_id and code.

  Parameters

  • Optionalparameters: AccessCodesUnmanagedGetParameters
  • options: AccessCodesUnmanagedGetOptions = {}

  Returns AccessCodesUnmanagedGetRequest

list

• list(
      parameters: AccessCodesUnmanagedListParameters,
      options?: AccessCodesUnmanagedListOptions,
  ): AccessCodesUnmanagedListRequest

  Returns a list of all unmanaged access codes.

  Parameters

  • parameters: AccessCodesUnmanagedListParameters
  • options: AccessCodesUnmanagedListOptions = {}

  Returns AccessCodesUnmanagedListRequest

update

• update(
      parameters: AccessCodesUnmanagedUpdateParameters,
      options?: AccessCodesUnmanagedUpdateOptions,
  ): AccessCodesUnmanagedUpdateRequest

  Updates a specified unmanaged access code.

  Parameters

  • parameters: AccessCodesUnmanagedUpdateParameters
  • options: AccessCodesUnmanagedUpdateOptions = {}

  Returns AccessCodesUnmanagedUpdateRequest

updateClientSessionToken

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

  Updates the client session token used by this client for authentication.

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

  Throws

  If this client was not created with a client session token.

StaticfromApiKey

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

  Creates a new SeamHttpAccessCodesUnmanaged authenticated with an API key.

  Parameters

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

  Returns SeamHttpAccessCodesUnmanaged

StaticfromClient

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

  Creates a new SeamHttpAccessCodesUnmanaged from an existing HTTP client.

  Parameters

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

  Returns SeamHttpAccessCodesUnmanaged

StaticfromClientSessionToken

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

  Creates a new SeamHttpAccessCodesUnmanaged authenticated with a client session token.

  Parameters

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

  Returns SeamHttpAccessCodesUnmanaged

StaticfromConsoleSessionToken

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

  Creates a new SeamHttpAccessCodesUnmanaged authenticated with a console session token and scoped to a workspace.

  Parameters

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

  Returns SeamHttpAccessCodesUnmanaged

StaticfromPersonalAccessToken

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

  Creates a new SeamHttpAccessCodesUnmanaged authenticated with a personal access token and scoped to a workspace.

  Parameters

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

  Returns SeamHttpAccessCodesUnmanaged

StaticfromPublishableKey

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

  Creates a new SeamHttpAccessCodesUnmanaged authenticated with a client session token for the user identified by the user identifier key. The client session is created with the publishable key if it does not exist.

  Parameters

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

  Returns Promise<SeamHttpAccessCodesUnmanaged>