Class SeamHttpSpaces

constructor

• new SeamHttpSpaces(apiKeyOrOptions?): SeamHttpSpaces

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpSpaces

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

addAcsEntrances

• addAcsEntrances(parameters?, options?): SpacesAddAcsEntrancesRequest

• Parameters

  • Optionalparameters: {
        acs_entrance_ids: string[];
        space_id: string;
    }

    • acs_entrance_ids: string[]

      IDs of the entrances that you want to add to the space.

    • space_id: string

      ID of the space to which you want to add entrances.
  • options: SpacesAddAcsEntrancesOptions = {}

  Returns SpacesAddAcsEntrancesRequest

addDevices

• addDevices(parameters?, options?): SpacesAddDevicesRequest

• Parameters

  • Optionalparameters: {
        device_ids: string[];
        space_id: string;
    }

    • device_ids: string[]

      IDs of the devices that you want to add to the space.

    • space_id: string

      ID of the space to which you want to add devices.
  • options: SpacesAddDevicesOptions = {}

  Returns SpacesAddDevicesRequest

create

• create(parameters?, options?): SpacesCreateRequest

• Parameters

  • Optionalparameters: {
        acs_entrance_ids?: string[];
        device_ids?: string[];
        name: string;
        space_key?: string;
    }

    • Optionalacs_entrance_ids?: string[]

      IDs of the entrances that you want to add to the new space.

    • Optionaldevice_ids?: string[]

      IDs of the devices that you want to add to the new space.

    • name: string

      Name of the space that you want to create.

    • Optionalspace_key?: string

      Unique key for the space within the workspace.
  • options: SpacesCreateOptions = {}

  Returns SpacesCreateRequest

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?): SpacesDeleteRequest

• Parameters

  • Optionalparameters: {
        space_id: string;
    }

    • space_id: string

      ID of the space that you want to delete.
  • options: SpacesDeleteOptions = {}

  Returns SpacesDeleteRequest

get

• get(parameters?, options?): SpacesGetRequest

• Parameters

  • Optionalparameters: SpacesGetParameters
  • options: SpacesGetOptions = {}

  Returns SpacesGetRequest

getRelated

• getRelated(parameters?, options?): SpacesGetRelatedRequest

• Parameters

  • Optionalparameters: {
        exclude?: (
            | "acs_entrances"
            | "acs_systems"
            | "connected_accounts"
            | "devices"
            | "spaces")[];
        include?: (
            | "acs_entrances"
            | "acs_systems"
            | "connected_accounts"
            | "devices"
            | "spaces")[];
        space_ids?: string[];
        space_keys?: string[];
    }

    • Optionalexclude?: (
          | "acs_entrances"
          | "acs_systems"
          | "connected_accounts"
          | "devices"
          | "spaces")[]

    • Optionalinclude?: (
          | "acs_entrances"
          | "acs_systems"
          | "connected_accounts"
          | "devices"
          | "spaces")[]

    • Optionalspace_ids?: string[]

      IDs of the spaces that you want to get along with their related resources.

    • Optionalspace_keys?: string[]

      Keys of the spaces that you want to get along with their related resources.
  • options: SpacesGetRelatedOptions = {}

  Returns SpacesGetRelatedRequest

list

• list(parameters?, options?): SpacesListRequest

• Parameters

  • Optionalparameters: {
        connected_account_id?: string;
        customer_key?: string;
        search?: string;
        space_key?: string;
    }

    • Optionalconnected_account_id?: string

      Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account.

    • Optionalcustomer_key?: string

      Customer key for which you want to list spaces.

    • Optionalsearch?: string

      String for which to search. Filters returned spaces to include all records that satisfy a partial match using name.

    • Optionalspace_key?: string

      Filter spaces by space_key.
  • options: SpacesListOptions = {}

  Returns SpacesListRequest

removeAcsEntrances

• removeAcsEntrances(parameters?, options?): SpacesRemoveAcsEntrancesRequest

• Parameters

  • Optionalparameters: {
        acs_entrance_ids: string[];
        space_id: string;
    }

    • acs_entrance_ids: string[]

      IDs of the entrances that you want to remove from the space.

    • space_id: string

      ID of the space from which you want to remove entrances.
  • options: SpacesRemoveAcsEntrancesOptions = {}

  Returns SpacesRemoveAcsEntrancesRequest

removeDevices

• removeDevices(parameters?, options?): SpacesRemoveDevicesRequest

• Parameters

  • Optionalparameters: {
        device_ids: string[];
        space_id: string;
    }

    • device_ids: string[]

      IDs of the devices that you want to remove from the space.

    • space_id: string

      ID of the space from which you want to remove devices.
  • options: SpacesRemoveDevicesOptions = {}

  Returns SpacesRemoveDevicesRequest

update

• update(parameters?, options?): SpacesUpdateRequest

• Parameters

  • Optionalparameters: {
        acs_entrance_ids?: string[];
        device_ids?: string[];
        name?: string;
        space_id?: string;
        space_key?: string;
    }

    • Optionalacs_entrance_ids?: string[]

      IDs of the entrances that you want to set for the space. If specified, this will replace all existing entrances.

    • Optionaldevice_ids?: string[]

      IDs of the devices that you want to set for the space. If specified, this will replace all existing devices.

    • Optionalname?: string

      Name of the space.

    • Optionalspace_id?: string

      ID of the space that you want to update.

    • Optionalspace_key?: string

      Unique key of the space that you want to update.
  • options: SpacesUpdateOptions = {}

  Returns SpacesUpdateRequest

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpSpaces

• Parameters

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

  Returns SeamHttpSpaces

StaticfromClient

• fromClient(client, options?): SeamHttpSpaces

• Parameters

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

  Returns SeamHttpSpaces

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpSpaces

• Parameters

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

  Returns SeamHttpSpaces

StaticfromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpSpaces

StaticfromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpSpaces

StaticfromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpSpaces>