Class SeamHttpWebhooks

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpWebhooks

client

Readonlydefaults

create

• create(
      parameters: WebhooksCreateParameters,
      options?: WebhooksCreateOptions,
  ): WebhooksCreateRequest

  Creates a new webhook.

  Parameters

  • parameters: WebhooksCreateParameters
  • options: WebhooksCreateOptions = {}

  Returns WebhooksCreateRequest

createPaginator

• createPaginator<
      const TResponse,
      const TResponseKey extends string | number | symbol,
  >(
      request: SeamHttpRequest<TResponse, TResponseKey>,
  ): SeamPaginator<TResponse, TResponseKey>

  Creates a new SeamPaginator to iterate over the paginated results of the request.

  Type Parameters

  • const TResponse
  • const TResponseKey extends string | number | symbol

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

delete

• delete(
      parameters: WebhooksDeleteParameters,
      options?: WebhooksDeleteOptions,
  ): WebhooksDeleteRequest

  Deletes a specified webhook.

  Parameters

  • parameters: WebhooksDeleteParameters
  • options: WebhooksDeleteOptions = {}

  Returns WebhooksDeleteRequest

get

• get(
      parameters: WebhooksGetParameters,
      options?: WebhooksGetOptions,
  ): WebhooksGetRequest

  Gets a specified webhook.

  Parameters

  • parameters: WebhooksGetParameters
  • options: WebhooksGetOptions = {}

  Returns WebhooksGetRequest

list

• list(
      parameters?: WebhooksListParameters,
      options?: WebhooksListOptions,
  ): WebhooksListRequest

  Returns a list of all webhooks.

  Parameters

  • Optionalparameters: WebhooksListParameters
  • options: WebhooksListOptions = {}

  Returns WebhooksListRequest

update

• update(
      parameters: WebhooksUpdateParameters,
      options?: WebhooksUpdateOptions,
  ): WebhooksUpdateRequest

  Updates a specified webhook.

  Parameters

  • parameters: WebhooksUpdateParameters
  • options: WebhooksUpdateOptions = {}

  Returns WebhooksUpdateRequest

updateClientSessionToken

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

  Updates the client session token used by this client for authentication.

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

  Throws

  If this client was not created with a client session token.

StaticfromApiKey

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

  Creates a new SeamHttpWebhooks authenticated with an API key.

  Parameters

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

  Returns SeamHttpWebhooks

StaticfromClient

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

  Creates a new SeamHttpWebhooks from an existing HTTP client.

  Parameters

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

  Returns SeamHttpWebhooks

StaticfromClientSessionToken

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

  Creates a new SeamHttpWebhooks authenticated with a client session token.

  Parameters

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

  Returns SeamHttpWebhooks

StaticfromConsoleSessionToken

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

  Creates a new SeamHttpWebhooks authenticated with a console session token and scoped to a workspace.

  Parameters

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

  Returns SeamHttpWebhooks

StaticfromPersonalAccessToken

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

  Creates a new SeamHttpWebhooks authenticated with a personal access token and scoped to a workspace.

  Parameters

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

  Returns SeamHttpWebhooks

StaticfromPublishableKey

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

  Creates a new SeamHttpWebhooks authenticated with a client session token for the user identified by the user identifier key. The client session is created with the publishable key if it does not exist.

  Parameters

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

  Returns Promise<SeamHttpWebhooks>