Class SeamHttpAccessMethods

constructor

• new SeamHttpAccessMethods(apiKeyOrOptions?): SeamHttpAccessMethods

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAccessMethods

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>

delete

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

• Parameters

  • Optionalbody: {
        access_method_id: string;
    }

    • access_method_id: string

      ID of access method to get.

  Returns SeamHttpRequest<void, undefined>

get

• get(body?): SeamHttpRequest<SetNonNullable<Required<{
      access_method: {
          access_method_id: string;
          created_at: string;
          display_name: string;
          instant_key_url?: string;
          is_card_encoding_required?: boolean;
          issued_at?: string;
          mode: "code" | "card" | "mobile_key";
          workspace_id: string;
      };
  }>, "access_method">, "access_method">

• Parameters

  • Optionalbody: {
        access_method_id: string;
    }

    • access_method_id: string

      ID of access method to get.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      access_method: {
          access_method_id: string;
          created_at: string;
          display_name: string;
          instant_key_url?: string;
          is_card_encoding_required?: boolean;
          issued_at?: string;
          mode: "code" | "card" | "mobile_key";
          workspace_id: string;
      };
  }>, "access_method">, "access_method">

list

• list(body?): SeamHttpRequest<SetNonNullable<Required<{
      access_methods: {
          access_method_id: string;
          created_at: string;
          display_name: string;
          instant_key_url?: string;
          is_card_encoding_required?: boolean;
          issued_at?: string;
          mode: "code" | "card" | "mobile_key";
          workspace_id: string;
      }[];
  }>, "access_methods">, "access_methods">

• Parameters

  • Optionalbody: {
        access_grant_id: string;
    }

    • access_grant_id: string

      ID of access grant to list access methods for.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      access_methods: {
          access_method_id: string;
          created_at: string;
          display_name: string;
          instant_key_url?: string;
          is_card_encoding_required?: boolean;
          issued_at?: string;
          mode: "code" | "card" | "mobile_key";
          workspace_id: string;
      }[];
  }>, "access_methods">, "access_methods">

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpAccessMethods

• Parameters

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

  Returns SeamHttpAccessMethods

StaticfromClient

• fromClient(client, options?): SeamHttpAccessMethods

• Parameters

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

  Returns SeamHttpAccessMethods

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpAccessMethods

• Parameters

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

  Returns SeamHttpAccessMethods

StaticfromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpAccessMethods

StaticfromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpAccessMethods

StaticfromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpAccessMethods>