Class Triggers

constructor

• new Triggers(options?: SDKOptions): Triggers

  Parameters

  • options: SDKOptions = {}

  Returns Triggers

Readonly_baseURL

Readonly_hooks

Readonly_httpClient

Optional Readonly_logger

Readonly_options

_createRequest

• _createRequest(
      context: HookContext,
      conf: RequestConfig,
      options?: RequestOptions,
  ): Result<Request, UnexpectedClientError | InvalidRequestError>

  Parameters

  • context: HookContext
  • conf: RequestConfig
  • Optionaloptions: RequestOptions

  Returns Result<Request, UnexpectedClientError | InvalidRequestError>

_do

• _do(
      request: Request,
      options: {
          context: HookContext;
          isErrorStatusCode: (statusCode: number) => boolean;
          retryCodes: string[];
          retryConfig: RetryConfig;
      },
  ): Promise<
      Result<
          Response,
          | UnexpectedClientError
          | RequestAbortedError
          | RequestTimeoutError
          | ConnectionError,
      >,
  >

  Parameters

  • request: Request
  • options: {
        context: HookContext;
        isErrorStatusCode: (statusCode: number) => boolean;
        retryCodes: string[];
        retryConfig: RetryConfig;
    }

  Returns Promise<
      Result<
          Response,
          | UnexpectedClientError
          | RequestAbortedError
          | RequestTimeoutError
          | ConnectionError,
      >,
  >

create

• create(
      params: CreateTriggerParams,
      options?: RequestOptions,
  ): APIPromise<Trigger>

  Creates a new trigger that will invoke the specified agent on the given cron schedule.

  Parameters

  • params: CreateTriggerParams
  • Optionaloptions: RequestOptions

  Returns APIPromise<Trigger>

delete

• delete(
      id: string,
      params?: DeleteTriggerParams,
      options?: Omit<RequestOptions, "extra_body">,
  ): APIPromise<Empty>

  Deletes a trigger.

  Parameters

  • id: string
  • Optionalparams: DeleteTriggerParams
  • Optionaloptions: Omit<RequestOptions, "extra_body">

  Returns APIPromise<Empty>

get

• get(
      id: string,
      params?: GetTriggerParams,
      options?: Omit<RequestOptions, "extra_body">,
  ): APIPromise<Trigger>

  Gets details of a single trigger.

  Parameters

  • id: string
  • Optionalparams: GetTriggerParams
  • Optionaloptions: Omit<RequestOptions, "extra_body">

  Returns APIPromise<Trigger>

list

• list(
      params?: ListTriggersRequest,
      options?: Omit<RequestOptions, "extra_body">,
  ): APIPromise<ListTriggersResponse>

  Lists triggers for a project.

  Parameters

  • Optionalparams: ListTriggersRequest
  • Optionaloptions: Omit<RequestOptions, "extra_body">

  Returns APIPromise<ListTriggersResponse>

listExecutions

• listExecutions(
      trigger_id: string,
      params?: ListTriggerExecutionsParams,
      options?: Omit<RequestOptions, "extra_body">,
  ): APIPromise<ListTriggerExecutionsResponse>

  Lists executions for a trigger.

  Parameters

  • trigger_id: string
  • Optionalparams: ListTriggerExecutionsParams
  • Optionaloptions: Omit<RequestOptions, "extra_body">

  Returns APIPromise<ListTriggerExecutionsResponse>

run

• run(
      trigger_id: string,
      params?: RunTriggerParams,
      options?: Omit<RequestOptions, "extra_body">,
  ): APIPromise<TriggerExecution>

  Runs a trigger immediately.

  Parameters

  • trigger_id: string
  • Optionalparams: RunTriggerParams
  • Optionaloptions: Omit<RequestOptions, "extra_body">

  Returns APIPromise<TriggerExecution>

update

• update(
      id: string,
      params: UpdateTriggerParams,
      options?: RequestOptions,
  ): APIPromise<Trigger>

  Updates a trigger.

  Parameters

  • id: string
  • params: UpdateTriggerParams
  • Optionaloptions: RequestOptions

  Returns APIPromise<Trigger>