Class SeamHttpAccessCodesUnmanaged

constructor

• new SeamHttpAccessCodesUnmanaged(apiKeyOrOptions?): SeamHttpAccessCodesUnmanaged

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAccessCodesUnmanaged

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

convertToManaged

• convertToManaged(parameters?, options?): AccessCodesUnmanagedConvertToManagedRequest

• Parameters

  • Optionalparameters: {
        access_code_id: string;
        allow_external_modification?: boolean;
        force?: boolean;
        is_external_modification_allowed?: boolean;
        sync?: boolean;
    }

    • access_code_id: string

      ID of the unmanaged access code that you want to convert to a managed access code.

    • Optionalallow_external_modification?: boolean

      Indicates whether external modification of the access code is allowed.

    • Optionalforce?: boolean

      Indicates whether to force the access code conversion. To switch management of an access code from one Seam workspace to another, set force to true.

    • Optionalis_external_modification_allowed?: boolean

      Indicates whether external modification of the access code is allowed.

    • Optionalsync?: boolean
  • options: AccessCodesUnmanagedConvertToManagedOptions = {}

  Returns AccessCodesUnmanagedConvertToManagedRequest

createPaginator

• createPaginator<const TResponse, const TResponseKey>(request): SeamPaginator<TResponse, TResponseKey>

• Type Parameters

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

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

delete

• delete(parameters?, options?): AccessCodesUnmanagedDeleteRequest

• Parameters

  • Optionalparameters: {
        access_code_id: string;
        sync?: boolean;
    }

    • access_code_id: string

      ID of the unmanaged access code that you want to delete.

    • Optionalsync?: boolean
  • options: AccessCodesUnmanagedDeleteOptions = {}

  Returns AccessCodesUnmanagedDeleteRequest

get

• get(parameters?, options?): AccessCodesUnmanagedGetRequest

• Parameters

  • Optionalparameters: {
        access_code_id?: string;
        code?: string;
        device_id?: string;
    }

    • Optionalaccess_code_id?: string

      ID of the unmanaged access code that you want to get. You must specify either access_code_id or both device_id and code.

    • Optionalcode?: string

      Code of the unmanaged access code that you want to get. You must specify either access_code_id or both device_id and code.

    • Optionaldevice_id?: string

      ID of the device containing the unmanaged access code that you want to get. You must specify either access_code_id or both device_id and code.
  • options: AccessCodesUnmanagedGetOptions = {}

  Returns AccessCodesUnmanagedGetRequest

list

• list(parameters?, options?): AccessCodesUnmanagedListRequest

• Parameters

  • Optionalparameters: {
        device_id: string;
        limit?: number;
        page_cursor?: null | string;
        user_identifier_key?: string;
    }

    • device_id: string

      ID of the device for which you want to list unmanaged access codes.

    • Optionallimit?: number

      Numerical limit on the number of unmanaged access codes to return.

    • Optionalpage_cursor?: null | string

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

    • Optionaluser_identifier_key?: string

      Your user ID for the user by which to filter unmanaged access codes.
  • options: AccessCodesUnmanagedListOptions = {}

  Returns AccessCodesUnmanagedListRequest

update

• update(parameters?, options?): AccessCodesUnmanagedUpdateRequest

• Parameters

  • Optionalparameters: {
        access_code_id: string;
        allow_external_modification?: boolean;
        force?: boolean;
        is_external_modification_allowed?: boolean;
        is_managed: boolean;
    }

    • access_code_id: string

      ID of the unmanaged access code that you want to update.

    • Optionalallow_external_modification?: boolean

      Indicates whether external modification of the code is allowed.

    • Optionalforce?: boolean

      Indicates whether to force the unmanaged access code update.

    • Optionalis_external_modification_allowed?: boolean

      Indicates whether external modification of the code is allowed.

    • is_managed: boolean

  • options: AccessCodesUnmanagedUpdateOptions = {}

  Returns AccessCodesUnmanagedUpdateRequest

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpAccessCodesUnmanaged

• Parameters

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

  Returns SeamHttpAccessCodesUnmanaged

StaticfromClient

• fromClient(client, options?): SeamHttpAccessCodesUnmanaged

• Parameters

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

  Returns SeamHttpAccessCodesUnmanaged

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpAccessCodesUnmanaged

• Parameters

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

  Returns SeamHttpAccessCodesUnmanaged

StaticfromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpAccessCodesUnmanaged

StaticfromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpAccessCodesUnmanaged

StaticfromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpAccessCodesUnmanaged>