Class SeamHttpUnstableLocations

constructor

• new SeamHttpUnstableLocations(apiKeyOrOptions?): SeamHttpUnstableLocations

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpUnstableLocations

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

addAcsEntrances

• addAcsEntrances(parameters?, options?): UnstableLocationsAddAcsEntrancesRequest

• Parameters

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

    • acs_entrance_ids: string[]

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

    • location_id: string

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

  Returns UnstableLocationsAddAcsEntrancesRequest

addDevices

• addDevices(parameters?, options?): UnstableLocationsAddDevicesRequest

• Parameters

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

    • device_ids: string[]

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

    • location_id: string

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

  Returns UnstableLocationsAddDevicesRequest

create

• create(parameters?, options?): UnstableLocationsCreateRequest

• Parameters

  • Optionalparameters: {
        acs_entrance_ids?: string[];
        device_ids?: string[];
        geolocation?: {
            latitude: number;
            longitude: number;
        };
        name: string;
        time_zone?: string;
    }

    • Optionalacs_entrance_ids?: string[]

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

    • Optionaldevice_ids?: string[]

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

    • Optionalgeolocation?: {
          latitude: number;
          longitude: number;
      }

      Geolocation of the new location.

      • latitude: number

      • longitude: number

    • name: string

      Name of the new location.

    • Optionaltime_zone?: string

      Time zone of the new location.
  • options: UnstableLocationsCreateOptions = {}

  Returns UnstableLocationsCreateRequest

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

• Parameters

  • Optionalparameters: {
        location_id: string;
    }

    • location_id: string

      ID of the location that you want to delete.
  • options: UnstableLocationsDeleteOptions = {}

  Returns UnstableLocationsDeleteRequest

get

• get(parameters?, options?): UnstableLocationsGetRequest

• Parameters

  • Optionalparameters: {
        location_id: string;
    }

    • location_id: string

      ID of the location that you want to get.
  • options: UnstableLocationsGetOptions = {}

  Returns UnstableLocationsGetRequest

list

• list(parameters?, options?): UnstableLocationsListRequest

• Parameters

  • Optionalparameters: {}
  • options: UnstableLocationsListOptions = {}

  Returns UnstableLocationsListRequest

removeAcsEntrances

• removeAcsEntrances(parameters?, options?): UnstableLocationsRemoveAcsEntrancesRequest

• Parameters

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

    • acs_entrance_ids: string[]

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

    • location_id: string

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

  Returns UnstableLocationsRemoveAcsEntrancesRequest

removeDevices

• removeDevices(parameters?, options?): UnstableLocationsRemoveDevicesRequest

• Parameters

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

    • device_ids: string[]

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

    • location_id: string

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

  Returns UnstableLocationsRemoveDevicesRequest

update

• update(parameters?, options?): UnstableLocationsUpdateRequest

• Parameters

  • Optionalparameters: {
        geolocation?: {
            latitude: number;
            longitude: number;
        };
        location_id: string;
        name?: string;
        time_zone?: string;
    }

    • Optionalgeolocation?: {
          latitude: number;
          longitude: number;
      }

      Geolocation of the location.

      • latitude: number

      • longitude: number

    • location_id: string

      ID of the location that you want to update.

    • Optionalname?: string

      Name of the location.

    • Optionaltime_zone?: string

      Time zone of the the location.
  • options: UnstableLocationsUpdateOptions = {}

  Returns UnstableLocationsUpdateRequest

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpUnstableLocations

• Parameters

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

  Returns SeamHttpUnstableLocations

StaticfromClient

• fromClient(client, options?): SeamHttpUnstableLocations

• Parameters

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

  Returns SeamHttpUnstableLocations

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpUnstableLocations

• Parameters

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

  Returns SeamHttpUnstableLocations

StaticfromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpUnstableLocations

StaticfromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpUnstableLocations

StaticfromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpUnstableLocations>