Class SeamHttpConnectedAccounts

constructor

• new SeamHttpConnectedAccounts(apiKeyOrOptions?): SeamHttpConnectedAccounts

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpConnectedAccounts

client

Readonly defaults

delete

• delete(body?): Promise<void>

• Parameters

  • Optional body: {
        connected_account_id: string;
        sync?: boolean;
    }

    • connected_account_id: string

    • Optional sync?: boolean

  Returns Promise<void>

get

• get(body?): Promise<{
      account_type?: string;
      account_type_display_name: string;
      automatically_manage_new_devices: boolean;
      connected_account_id?: string;
      created_at?: string;
      custom_metadata?: Record<string, null | string | boolean>;
      errors?: any;
      user_identifier?: {
          api_url?: string;
          email?: string;
          exclusive?: boolean;
          phone?: string;
          username?: string;
      };
      warnings?: any;
  }>

• Parameters

  • Optional body: ConnectedAccountsGetParams

  Returns Promise<{
      account_type?: string;
      account_type_display_name: string;
      automatically_manage_new_devices: boolean;
      connected_account_id?: string;
      created_at?: string;
      custom_metadata?: Record<string, null | string | boolean>;
      errors?: any;
      user_identifier?: {
          api_url?: string;
          email?: string;
          exclusive?: boolean;
          phone?: string;
          username?: string;
      };
      warnings?: any;
  }>

list

• list(body?): Promise<{
      account_type?: string;
      account_type_display_name: string;
      automatically_manage_new_devices: boolean;
      connected_account_id?: string;
      created_at?: string;
      custom_metadata?: Record<string, null | string | boolean>;
      errors?: any;
      user_identifier?: {
          api_url?: string;
          email?: string;
          exclusive?: boolean;
          phone?: string;
          username?: string;
      };
      warnings?: any;
  }[]>

• Parameters

  • Optional body: {
        custom_metadata_has?: Record<string, null | string | boolean>;
    }

    • Optional custom_metadata_has?: Record<string, null | string | boolean>

      Returns devices where the account's custom_metadata contains all of the provided key/value pairs.

  Returns Promise<{
      account_type?: string;
      account_type_display_name: string;
      automatically_manage_new_devices: boolean;
      connected_account_id?: string;
      created_at?: string;
      custom_metadata?: Record<string, null | string | boolean>;
      errors?: any;
      user_identifier?: {
          api_url?: string;
          email?: string;
          exclusive?: boolean;
          phone?: string;
          username?: string;
      };
      warnings?: any;
  }[]>

update

• update(body?): Promise<{
      account_type?: string;
      account_type_display_name: string;
      automatically_manage_new_devices: boolean;
      connected_account_id?: string;
      created_at?: string;
      custom_metadata?: Record<string, null | string | boolean>;
      errors?: any;
      user_identifier?: {
          api_url?: string;
          email?: string;
          exclusive?: boolean;
          phone?: string;
          username?: string;
      };
      warnings?: any;
  }>

• Parameters

  • Optional body: {
        automatically_manage_new_devices?: boolean;
        connected_account_id: string;
        custom_metadata?: Record<string, null | string | boolean>;
    }

    • Optional automatically_manage_new_devices?: boolean

    • connected_account_id: string

    • Optional custom_metadata?: Record<string, null | string | boolean>

  Returns Promise<{
      account_type?: string;
      account_type_display_name: string;
      automatically_manage_new_devices: boolean;
      connected_account_id?: string;
      created_at?: string;
      custom_metadata?: Record<string, null | string | boolean>;
      errors?: any;
      user_identifier?: {
          api_url?: string;
          email?: string;
          exclusive?: boolean;
          phone?: string;
          username?: string;
      };
      warnings?: any;
  }>

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

Static fromApiKey

• fromApiKey(apiKey, options?): SeamHttpConnectedAccounts

• Parameters

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

  Returns SeamHttpConnectedAccounts

Static fromClient

• fromClient(client, options?): SeamHttpConnectedAccounts

• Parameters

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

  Returns SeamHttpConnectedAccounts

Static fromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpConnectedAccounts

• Parameters

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

  Returns SeamHttpConnectedAccounts

Static fromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpConnectedAccounts

Static fromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpConnectedAccounts

Static fromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpConnectedAccounts>