Class SeamHttpSeamConsoleV1Timelines

constructor

• new SeamHttpSeamConsoleV1Timelines(apiKeyOrOptions?): SeamHttpSeamConsoleV1Timelines

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpSeamConsoleV1Timelines

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

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(parameters?, options?): SeamConsoleV1TimelinesGetRequest

• Parameters

  • Optionalparameters: {
        created_before?: Date;
        limit?: number;
        page_cursor?: string;
        resource_id: string;
    }

    • Optionalcreated_before?: Date

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

    • Optionallimit?: number

      Maximum number of timeline entry groups to return per page.

    • 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): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpSeamConsoleV1Timelines

• Parameters

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

  Returns SeamHttpSeamConsoleV1Timelines

StaticfromClient

• fromClient(client, options?): SeamHttpSeamConsoleV1Timelines

• Parameters

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

  Returns SeamHttpSeamConsoleV1Timelines

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpSeamConsoleV1Timelines

• Parameters

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

  Returns SeamHttpSeamConsoleV1Timelines

StaticfromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpSeamConsoleV1Timelines

StaticfromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpSeamConsoleV1Timelines

StaticfromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpSeamConsoleV1Timelines>