Class SeamHttpActionAttempts

constructor

• new SeamHttpActionAttempts(apiKeyOrOptions?): SeamHttpActionAttempts

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpActionAttempts

client

Readonly defaults

get

• get(body?, options?): SeamHttpRequest<SetNonNullable<Required<{
      action_attempt: {
          action_attempt_id: string;
          action_type: string;
          error: null;
          result?: any;
          status: "success";
      } | {
          action_attempt_id: string;
          action_type: string;
          error: null;
          result: null;
          status: "pending";
      } | {
          action_attempt_id: string;
          action_type: string;
          error: {
              message: string;
              type: string;
          };
          result: null;
          status: "error";
      };
  }>, "action_attempt">, "action_attempt">

• Parameters

  • Optional body: {
        action_attempt_id: string;
    }

    • action_attempt_id: string

  • options: Pick<SeamHttpRequestOptions, "waitForActionAttempt"> = {}

  Returns SeamHttpRequest<SetNonNullable<Required<{
      action_attempt: {
          action_attempt_id: string;
          action_type: string;
          error: null;
          result?: any;
          status: "success";
      } | {
          action_attempt_id: string;
          action_type: string;
          error: null;
          result: null;
          status: "pending";
      } | {
          action_attempt_id: string;
          action_type: string;
          error: {
              message: string;
              type: string;
          };
          result: null;
          status: "error";
      };
  }>, "action_attempt">, "action_attempt">

list

• list(body?): SeamHttpRequest<SetNonNullable<Required<{
      action_attempts: ({
          action_attempt_id: string;
          action_type: string;
          error: null;
          result?: any;
          status: "success";
      } | {
          action_attempt_id: string;
          action_type: string;
          error: null;
          result: null;
          status: "pending";
      } | {
          action_attempt_id: string;
          action_type: string;
          error: {
              message: string;
              type: string;
          };
          result: null;
          status: "error";
      })[];
  }>, "action_attempts">, "action_attempts">

• Parameters

  • Optional body: {
        action_attempt_ids: string[];
    }

    • action_attempt_ids: string[]

  Returns SeamHttpRequest<SetNonNullable<Required<{
      action_attempts: ({
          action_attempt_id: string;
          action_type: string;
          error: null;
          result?: any;
          status: "success";
      } | {
          action_attempt_id: string;
          action_type: string;
          error: null;
          result: null;
          status: "pending";
      } | {
          action_attempt_id: string;
          action_type: string;
          error: {
              message: string;
              type: string;
          };
          result: null;
          status: "error";
      })[];
  }>, "action_attempts">, "action_attempts">

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

Static fromApiKey

• fromApiKey(apiKey, options?): SeamHttpActionAttempts

• Parameters

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

  Returns SeamHttpActionAttempts

Static fromClient

• fromClient(client, options?): SeamHttpActionAttempts

• Parameters

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

  Returns SeamHttpActionAttempts

Static fromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpActionAttempts

• Parameters

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

  Returns SeamHttpActionAttempts

Static fromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpActionAttempts

Static fromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpActionAttempts

Static fromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpActionAttempts>