Class SeamHttpWebhooks

constructor

• new SeamHttpWebhooks(apiKeyOrOptions?): SeamHttpWebhooks

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpWebhooks

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

create

• create(body?): SeamHttpRequest<SetNonNullable<Required<{
      webhook: {
          event_types?: string[];
          secret?: string;
          url: string;
          webhook_id: string;
      };
  }>, "webhook">, "webhook">

• Parameters

  • Optionalbody: {
        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.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      webhook: {
          event_types?: string[];
          secret?: string;
          url: string;
          webhook_id: string;
      };
  }>, "webhook">, "webhook">

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>

delete

• delete(params?): SeamHttpRequest<void, undefined>

• Parameters

  • Optionalparams: {
        webhook_id: string;
    }

    • webhook_id: string

      ID of the webhook that you want to delete.

  Returns SeamHttpRequest<void, undefined>

get

• get(params?): SeamHttpRequest<SetNonNullable<Required<{
      webhook: {
          event_types?: string[];
          secret?: string;
          url: string;
          webhook_id: string;
      };
  }>, "webhook">, "webhook">

• Parameters

  • Optionalparams: {
        webhook_id: string;
    }

    • webhook_id: string

      ID of the webhook that you want to get.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      webhook: {
          event_types?: string[];
          secret?: string;
          url: string;
          webhook_id: string;
      };
  }>, "webhook">, "webhook">

list

• list(params?): SeamHttpRequest<SetNonNullable<Required<{
      webhooks: {
          event_types?: string[];
          secret?: string;
          url: string;
          webhook_id: string;
      }[];
  }>, "webhooks">, "webhooks">

• Parameters

  • Optionalparams: {}

  Returns SeamHttpRequest<SetNonNullable<Required<{
      webhooks: {
          event_types?: string[];
          secret?: string;
          url: string;
          webhook_id: string;
      }[];
  }>, "webhooks">, "webhooks">

update

• update(body?): SeamHttpRequest<void, undefined>

• Parameters

  • Optionalbody: {
        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.

  Returns SeamHttpRequest<void, undefined>

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpWebhooks

• Parameters

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

  Returns SeamHttpWebhooks

StaticfromClient

• fromClient(client, options?): SeamHttpWebhooks

• Parameters

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

  Returns SeamHttpWebhooks

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpWebhooks

• Parameters

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

  Returns SeamHttpWebhooks

StaticfromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpWebhooks

StaticfromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpWebhooks

StaticfromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpWebhooks>