Class SeamHttpSeamConsoleV1Timelines

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpSeamConsoleV1Timelines

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>

get

• get(
      parameters?: {
          context_type?: "request" | "job";
          created_after?: Date;
          created_before?: Date;
          created_between?: [Date, Date];
          entry_types?: (
              | "event"
              | "resource_created"
              | "resource_updated"
              | "resource_deleted"
              | "provider_call"
              | "automation_run"
              | "webhook_processed"
          )[];
          limit?: number;
          page_cursor?: string;
          resource_id: string;
      },
      options?: SeamConsoleV1TimelinesGetOptions,
  ): SeamConsoleV1TimelinesGetRequest

  Parameters

  • Optionalparameters: {
        context_type?: "request" | "job";
        created_after?: Date;
        created_before?: Date;
        created_between?: [Date, Date];
        entry_types?: (
            | "event"
            | "resource_created"
            | "resource_updated"
            | "resource_deleted"
            | "provider_call"
            | "automation_run"
            | "webhook_processed"
        )[];
        limit?: number;
        page_cursor?: string;
        resource_id: string;
    }

    • Optionalcontext_type?: "request" | "job"

      Filter timeline entries by context type. 'request' for API requests, 'job' for background jobs.

    • Optionalcreated_after?: Date

      Timestamp by which to limit returned timeline entries. Returns entries created after this timestamp.

    • Optionalcreated_before?: Date

      Timestamp by which to limit returned timeline entries. Returns entries created before this timestamp.

    • Optionalcreated_between?: [Date, Date]

      Time range to filter timeline entries. Returns entries created between the two timestamps [start, end].

    • Optionalentry_types?: (
          | "event"
          | "resource_created"
          | "resource_updated"
          | "resource_deleted"
          | "provider_call"
          | "automation_run"
          | "webhook_processed"
      )[]

      Filter timeline entries by entry type. If not specified, all entry types are returned.

    • Optionallimit?: number

      Maximum number of timeline entry groups to return per page. Maximum 100.

    • Optionalpage_cursor?: string

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

    • resource_id: string

      ID of the resource to get timelines for.

  • options: SeamConsoleV1TimelinesGetOptions = {}

  Returns SeamConsoleV1TimelinesGetRequest

updateClientSessionToken

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

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

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

  Parameters

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

  Returns SeamHttpSeamConsoleV1Timelines

StaticfromClient

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

  Parameters

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

  Returns SeamHttpSeamConsoleV1Timelines

StaticfromClientSessionToken

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

  Parameters

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

  Returns SeamHttpSeamConsoleV1Timelines

StaticfromConsoleSessionToken

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

  Parameters

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

  Returns SeamHttpSeamConsoleV1Timelines

StaticfromPersonalAccessToken

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

  Parameters

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

  Returns SeamHttpSeamConsoleV1Timelines

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpSeamConsoleV1Timelines>