Class SeamHttpWebhooks

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpWebhooks

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

create

• create(
      parameters?: { event_types?: string[]; url: string },
      options?: WebhooksCreateOptions,
  ): WebhooksCreateRequest

  Parameters

  • Optionalparameters: { event_types?: string[]; url: string }

    • Optionalevent_types?: string[]

      Types of events that you want the new webhook to receive.

    • url: string

      URL for the new webhook.
  • options: WebhooksCreateOptions = {}

  Returns WebhooksCreateRequest

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>

delete

• delete(
      parameters?: { webhook_id: string },
      options?: WebhooksDeleteOptions,
  ): WebhooksDeleteRequest

  Parameters

  • Optionalparameters: { webhook_id: string }

    • webhook_id: string

      ID of the webhook that you want to delete.
  • options: WebhooksDeleteOptions = {}

  Returns WebhooksDeleteRequest

get

• get(
      parameters?: { webhook_id: string },
      options?: WebhooksGetOptions,
  ): WebhooksGetRequest

  Parameters

  • Optionalparameters: { webhook_id: string }

    • webhook_id: string

      ID of the webhook that you want to get.
  • options: WebhooksGetOptions = {}

  Returns WebhooksGetRequest

list

• list(parameters?: {}, options?: WebhooksListOptions): WebhooksListRequest

  Parameters

  • Optionalparameters: {}
  • options: WebhooksListOptions = {}

  Returns WebhooksListRequest

update

• update(
      parameters?: { event_types: string[]; webhook_id: string },
      options?: WebhooksUpdateOptions,
  ): WebhooksUpdateRequest

  Parameters

  • Optionalparameters: { event_types: string[]; webhook_id: string }

    • event_types: string[]

      Types of events that you want the webhook to receive.

    • webhook_id: string

      ID of the webhook that you want to update.
  • options: WebhooksUpdateOptions = {}

  Returns WebhooksUpdateRequest

updateClientSessionToken

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

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

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

  Parameters

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

  Returns SeamHttpWebhooks

StaticfromClient

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

  Parameters

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

  Returns SeamHttpWebhooks

StaticfromClientSessionToken

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

  Parameters

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

  Returns SeamHttpWebhooks

StaticfromConsoleSessionToken

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

  Parameters

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

  Returns SeamHttpWebhooks

StaticfromPersonalAccessToken

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

  Parameters

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

  Returns SeamHttpWebhooks

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpWebhooks>