Class Scenarios

constructor

• new Scenarios(fetch: FetchFunction): Scenarios

  Create a new Scenarios instance.

  Parameters

  • fetch: FetchFunction

    Function for making API requests

  Returns Scenarios

ReadonlycustomProperties

activate

• activate(scenarioId: number): Promise<boolean>

  Activate a scenario.

  Parameters

  • scenarioId: number

    The scenario ID to activate

  Returns Promise<boolean>

  Promise with a boolean indicating success

create

• create<C extends keyof Scenario = never>(
      scenario: CreateScenarioBody,
      options?: CreateScenarioOptions<C>,
  ): Promise<PickColumns<Scenario, C>>

  Create a new scenario.

  Type Parameters

  • C extends keyof Scenario = never

  Parameters

  • scenario: CreateScenarioBody

    Parameters for the scenario to create
  • Optionaloptions: CreateScenarioOptions<C>

    Options for creating the scenario

  Returns Promise<PickColumns<Scenario, C>>

  Promise with the created scenario

deactivate

• deactivate(scenarioId: number): Promise<boolean>

  Deactivate a scenario.

  Parameters

  • scenarioId: number

    The scenario ID to deactivate

  Returns Promise<boolean>

  Promise with a boolean indicating success

delete

• delete(scenarioId: number): Promise<void>

  Delete a scenario.

  Parameters

  • scenarioId: number

    The scenario ID to delete

  Returns Promise<void>

get

• get<C extends keyof Scenario = never>(
      scenarioId: number,
      options?: GetScenarioOptions<C>,
  ): Promise<PickColumns<Scenario, C>>

  Get scenario details.

  Type Parameters

  • C extends keyof Scenario = never

  Parameters

  • scenarioId: number

    The scenario ID to get details for
  • Optionaloptions: GetScenarioOptions<C>

    Options for filtering the returned fields

  Returns Promise<PickColumns<Scenario, C>>

  Promise with the scenario details

getInterface

• getInterface(scenarioId: number): Promise<ScenarioInterface>

  Get the interface for a scenario.

  Parameters

  • scenarioId: number

    The scenario ID to get the interface for

  Returns Promise<ScenarioInterface>

  Promise with the scenario interface

interface

• interface(scenarioId: number): Promise<ScenarioInterface>

  Get the interface for a scenario.

  Parameters

  • scenarioId: number

    The scenario ID to get the interface for

  Returns Promise<ScenarioInterface>

  Promise with the scenario interface

  Deprecated

  Use getInterface instead

list

• list<C extends keyof Scenario = never>(
      teamId: number,
      options?: ListScenariosOptions<C>,
  ): Promise<PickColumns<Scenario, C>[]>

  List all scenarios for a team.

  Type Parameters

  • C extends keyof Scenario = never

  Parameters

  • teamId: number

    The team ID to filter scenarios by
  • Optionaloptions: ListScenariosOptions<C>

    Optional parameters for filtering and pagination

  Returns Promise<PickColumns<Scenario, C>[]>

  Promise with the list of scenarios

listInOrganization

• listInOrganization<C extends keyof Scenario = never>(
      organizationId: number,
      options?: ListScenariosOptions<C>,
  ): Promise<PickColumns<Scenario, C>[]>

  List all scenarios for an organization.

  Type Parameters

  • C extends keyof Scenario = never

  Parameters

  • organizationId: number

    The organization ID to filter scenarios by
  • Optionaloptions: ListScenariosOptions<C>

    Optional parameters for filtering and pagination

  Returns Promise<PickColumns<Scenario, C>[]>

  Promise with the list of scenarios

replay

• replay(
      scenarioId: number,
      executionIds: string[],
  ): Promise<ReplayScenarioResponse>

  Replay a past execution of a scenario, re-running it with the original trigger data.

  Only executions whose input artifacts are still stored can be replayed; the API answers 422 Execution is not replayable for the rest, and 404 for an unknown execution ID.

  Parameters

  • scenarioId: number

    The scenario ID the execution belongs to
  • executionIds: string[]

    Execution IDs to replay. Currently only the first one is replayed.

  Returns Promise<ReplayScenarioResponse>

  Promise with the ID of the new execution created by the replay

run

• run(
      scenarioId: number,
      body?: Record<string, JSONValue>,
      options?: RunScenarioOptions,
  ): Promise<RunScenarioResponse>

  Execute a scenario with optional input data.

  Parameters

  • scenarioId: number

    The scenario ID to run
  • Optionalbody: Record<string, JSONValue>

    Optional input data for the scenario
  • Optionaloptions: RunScenarioOptions

    Options for running the scenario

  Returns Promise<RunScenarioResponse>

  Promise with the execution result

setInterface

• setInterface(
      scenarioId: number,
      body: UpdateScenarioInterfaceBody,
  ): Promise<ScenarioInterface>

  Update a scenario interface.

  Parameters

  • scenarioId: number

    The scenario ID to update the interface for
  • body: UpdateScenarioInterfaceBody

    The new interface definition

  Returns Promise<ScenarioInterface>

  Promise with the updated scenario interface

update

• update<C extends keyof Scenario = never>(
      scenarioId: number,
      scenario: UpdateScenarioBody,
      options?: UpdateScenarioOptions<C>,
  ): Promise<PickColumns<Scenario, C>>

  Update a scenario.

  Type Parameters

  • C extends keyof Scenario = never

  Parameters

  • scenarioId: number

    The scenario ID to update
  • scenario: UpdateScenarioBody

    Parameters to update in the scenario
  • Optionaloptions: UpdateScenarioOptions<C>

    Options for updating the scenario

  Returns Promise<PickColumns<Scenario, C>>

  Promise with the updated scenario