Class SeamHttpSpaces

constructor

• new SeamHttpSpaces(apiKeyOrOptions?): SeamHttpSpaces

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpSpaces

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

addAcsEntrances

• addAcsEntrances(body?): SeamHttpRequest<void, undefined>

• Parameters

  • Optionalbody: {
        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.

  Returns SeamHttpRequest<void, undefined>

addDevices

• addDevices(body?): SeamHttpRequest<void, undefined>

• Parameters

  • Optionalbody: {
        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.

  Returns SeamHttpRequest<void, undefined>

create

• create(body?): SeamHttpRequest<SetNonNullable<Required<{
      space: {
          created_at: string;
          display_name: string;
          name: string;
          space_id: string;
          workspace_id: string;
      };
  }>, "space">, "space">

• Parameters

  • Optionalbody: {
        acs_entrance_ids?: string[];
        device_ids?: string[];
        name: 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.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      space: {
          created_at: string;
          display_name: string;
          name: string;
          space_id: string;
          workspace_id: string;
      };
  }>, "space">, "space">

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(params?): SeamHttpRequest<void, undefined>

• Parameters

  • Optionalparams: {}

  Returns SeamHttpRequest<void, undefined>

get

• get(params?): SeamHttpRequest<SetNonNullable<Required<{
      space: {
          created_at: string;
          display_name: string;
          name: string;
          space_id: string;
          workspace_id: string;
      };
  }>, "space">, "space">

• Parameters

  • Optionalparams: {
        space_id: string;
    }

    • space_id: string

      ID of the space that you want to get.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      space: {
          created_at: string;
          display_name: string;
          name: string;
          space_id: string;
          workspace_id: string;
      };
  }>, "space">, "space">

list

• list(params?): SeamHttpRequest<SetNonNullable<Required<{
      spaces: {
          created_at: string;
          display_name: string;
          name: string;
          space_id: string;
          workspace_id: string;
      }[];
  }>, "spaces">, "spaces">

• Parameters

  • Optionalparams: {}

  Returns SeamHttpRequest<SetNonNullable<Required<{
      spaces: {
          created_at: string;
          display_name: string;
          name: string;
          space_id: string;
          workspace_id: string;
      }[];
  }>, "spaces">, "spaces">

removeAcsEntrances

• removeAcsEntrances(params?): SeamHttpRequest<void, undefined>

• Parameters

  • Optionalparams: {
        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.

  Returns SeamHttpRequest<void, undefined>

removeDevices

• removeDevices(params?): SeamHttpRequest<void, undefined>

• Parameters

  • Optionalparams: {
        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.

  Returns SeamHttpRequest<void, undefined>

update

• update(body?): SeamHttpRequest<SetNonNullable<Required<{
      space: {
          created_at: string;
          display_name: string;
          name: string;
          space_id: string;
          workspace_id: string;
      };
  }>, "space">, "space">

• Parameters

  • Optionalbody: {
        name?: string;
        space_id: string;
    }

    • Optionalname?: string

      Name of the space.

    • space_id: string

      ID of the space that you want to update.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      space: {
          created_at: string;
          display_name: string;
          name: string;
          space_id: string;
          workspace_id: string;
      };
  }>, "space">, "space">

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>