Class SeamHttpConnectedAccounts

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpConnectedAccounts

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

createPaginator

• createPaginator<
      const TResponse,
      const TResponseKey extends string | number | symbol,
  >(
      request: SeamHttpRequest<TResponse, TResponseKey>,
  ): 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?: { connected_account_id: string; sync?: boolean },
      options?: ConnectedAccountsDeleteOptions,
  ): ConnectedAccountsDeleteRequest

  Parameters

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

    • connected_account_id: string

      ID of the connected account that you want to delete.

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

  Returns ConnectedAccountsDeleteRequest

get

• get(
      parameters?: ConnectedAccountsGetParameters,
      options?: ConnectedAccountsGetOptions,
  ): ConnectedAccountsGetRequest

  Parameters

  • Optionalparameters: ConnectedAccountsGetParameters
  • options: ConnectedAccountsGetOptions = {}

  Returns ConnectedAccountsGetRequest

list

• list(
      parameters?: {
          custom_metadata_has?: { [x: string]: string | boolean };
          customer_key?: string;
          limit?: number;
          page_cursor?: null | string;
          search?: string;
          user_identifier_key?: string;
      },
      options?: ConnectedAccountsListOptions,
  ): ConnectedAccountsListRequest

  Parameters

  • Optionalparameters: {
        custom_metadata_has?: { [x: string]: string | boolean };
        customer_key?: string;
        limit?: number;
        page_cursor?: null | string;
        search?: string;
        user_identifier_key?: string;
    }

    • Optionalcustom_metadata_has?: { [x: string]: string | boolean }

      Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with custom_metadata that contains all of the provided key:value pairs.

    • Optionalcustomer_key?: string

      Customer key by which you want to filter connected accounts.

    • Optionallimit?: number

      Maximum number of records to return per page.

    • Optionalpage_cursor?: null | string

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

    • Optionalsearch?: string

      String for which to search. Filters returned connected accounts to include all records that satisfy a partial match using connected_account_id, account_type, customer_key, custom_metadata, user_identifier.username, user_identifier.email or user_identifier.phone.

    • Optionaluser_identifier_key?: string

      Your user ID for the user by which you want to filter connected accounts.
  • options: ConnectedAccountsListOptions = {}

  Returns ConnectedAccountsListRequest

sync

• sync(
      parameters?: { connected_account_id: string },
      options?: ConnectedAccountsSyncOptions,
  ): ConnectedAccountsSyncRequest

  Parameters

  • Optionalparameters: { connected_account_id: string }

    • connected_account_id: string

      ID of the connected account that you want to sync.
  • options: ConnectedAccountsSyncOptions = {}

  Returns ConnectedAccountsSyncRequest

update

• update(
      parameters?: {
          accepted_capabilities?: (
              "lock"
              | "thermostat"
              | "noise_sensor"
              | "access_control"
          )[];
          automatically_manage_new_devices?: boolean;
          connected_account_id: string;
          custom_metadata?: { [x: string]: null | string | boolean };
          customer_key?: string;
      },
      options?: ConnectedAccountsUpdateOptions,
  ): ConnectedAccountsUpdateRequest

  Parameters

  • Optionalparameters: {
        accepted_capabilities?: (
            "lock"
            | "thermostat"
            | "noise_sensor"
            | "access_control"
        )[];
        automatically_manage_new_devices?: boolean;
        connected_account_id: string;
        custom_metadata?: { [x: string]: null | string | boolean };
        customer_key?: string;
    }

    • Optionalaccepted_capabilities?: ("lock" | "thermostat" | "noise_sensor" | "access_control")[]

      List of accepted device capabilities that restrict the types of devices that can be connected through this connected account. Valid values are lock, thermostat, noise_sensor, and access_control.

    • Optionalautomatically_manage_new_devices?: boolean

      Indicates whether newly-added devices should appear as managed devices.

    • connected_account_id: string

      ID of the connected account that you want to update.

    • Optionalcustom_metadata?: { [x: string]: null | string | boolean }

      Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. Supports up to 50 JSON key:value pairs. Adding custom metadata to a connected account enables you to store custom information, like customer details or internal IDs from your application. Then, you can filter connected accounts by the desired metadata.

    • Optionalcustomer_key?: string

      The customer key to associate with this connected account. If provided, the connected account and all resources under the connected account will be moved to this customer. May only be provided if the connected account is not already associated with a customer.
  • options: ConnectedAccountsUpdateOptions = {}

  Returns ConnectedAccountsUpdateRequest

updateClientSessionToken

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

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

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

  Parameters

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

  Returns SeamHttpConnectedAccounts

StaticfromClient

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

  Parameters

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

  Returns SeamHttpConnectedAccounts

StaticfromClientSessionToken

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

  Parameters

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

  Returns SeamHttpConnectedAccounts

StaticfromConsoleSessionToken

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

  Parameters

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

  Returns SeamHttpConnectedAccounts

StaticfromPersonalAccessToken

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

  Parameters

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

  Returns SeamHttpConnectedAccounts

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpConnectedAccounts>