Class SeamHttpNetworks

constructor

• new SeamHttpNetworks(apiKeyOrOptions?): SeamHttpNetworks

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpNetworks

client

Readonlydefaults

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>

get

• get(body?): SeamHttpRequest<SetNonNullable<Required<{
      network: {
          created_at: string;
          display_name: string;
          network_id: string;
          workspace_id: string;
      };
  }>, "network">, "network">

• Parameters

  • Optionalbody: {
        network_id: string;
    }

    • network_id: string

  Returns SeamHttpRequest<SetNonNullable<Required<{
      network: {
          created_at: string;
          display_name: string;
          network_id: string;
          workspace_id: string;
      };
  }>, "network">, "network">

list

• list(body?): SeamHttpRequest<SetNonNullable<Required<{
      networks: {
          created_at: string;
          display_name: string;
          network_id: string;
          workspace_id: string;
      }[];
  }>, "networks">, "networks">

• Parameters

  • Optionalbody: {}

  Returns SeamHttpRequest<SetNonNullable<Required<{
      networks: {
          created_at: string;
          display_name: string;
          network_id: string;
          workspace_id: string;
      }[];
  }>, "networks">, "networks">

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpNetworks

• Parameters

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

  Returns SeamHttpNetworks

StaticfromClient

• fromClient(client, options?): SeamHttpNetworks

• Parameters

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

  Returns SeamHttpNetworks

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpNetworks

• Parameters

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

  Returns SeamHttpNetworks

StaticfromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpNetworks

StaticfromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpNetworks

StaticfromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpNetworks>