Variables
Resource for operations related to variables.
Class: Variables
Resource for operations related to variables.
Extends
Constructors
Constructor
new Variables(
api):Variables
Create a new resource.
Parameters
api
API
API client instance used to communicate with WriftAI's API.
Returns
Variables
Inherited from
Methods
create()
create(
params,signal?):Promise<Variable>
Create a new variable.
Parameters
params
Parameters for creating the variable.
signal?
AbortSignal
Optional abort signal.
Returns
Promise<Variable>
The created variable.
delete()
delete(
key,signal?):Promise<void>
Delete a variable.
Parameters
key
string
The unique key that identifies the variable to be deleted.
signal?
AbortSignal
Optional abort signal.
Returns
Promise<void>
list()
list(
options?,signal?):Promise<PaginatedResponse<Variable>>
List variables.
Parameters
options?
Optional settings to control pagination behavior.
signal?
AbortSignal
Optional abort signal.
Returns
Promise<PaginatedResponse<Variable>>
Paginated response containing variables and navigation metadata.
update()
update(
key,params,signal?):Promise<Variable>
Update a variable.
Parameters
key
string
The unique key that identifies the variable to be updated.
params
The parameters for updating the variable.
signal?
AbortSignal
Optional abort signal.
Returns
Promise<Variable>
The updated variable.