Class UpdatePlanRequest

Represents a request to update an existing plan. Contains optional parameters to modify the plan's period time, failure retries, and hooks.

Constructors

constructor

Properties

hooks? max_failure_retry? period_time? plan_id

Constructors

constructor

  • new UpdatePlanRequest(
        plan_id: string,
        period_time?: string,
        max_failure_retry?: number,
        hooks?: Hook[],
    ): UpdatePlanRequest

  • Creates an instance of the UpdatePlanRequest class.

    Parameters

    • plan_id: string

      The ID of the plan to be updated.

    • Optionalperiod_time: string

      The new period time for the plan. Optional.

    • Optionalmax_failure_retry: number

      The new maximum number of failure retries. Optional.

    • Optionalhooks: Hook[]

      The new list of hooks for the plan. Optional.

    Returns UpdatePlanRequest

Properties

Optionalhooks

hooks?: Hook[]

The new list of hooks to be associated with the plan. Optional.

Optionalmax_failure_retry

max_failure_retry?: number

The new maximum number of failure retries for the plan. Optional.

Optionalperiod_time

period_time?: string

The new period time for the plan (e.g., "daily", "weekly"). Optional.

plan_id

plan_id: string

The unique ID of the plan to be updated.

Settings

Member Visibility

On This Page

Constructors
Properties