Class ExecuteWorkflow

Abstract class that defines the required functions to properly invoke a BambuMeta request from a client application.

Hierarchy (view full)

Executable<IExecuteWorkflowResponse>
- ExecuteWorkflow

Implements

Partial<IWorkflow>

Index

Constructors

constructor

new ExecuteWorkflow(input?): ExecuteWorkflow
Parameters
- Optional input: Partial<IWorkflow> & {
  brandId: number;
  programId: number;
  }
Returns ExecuteWorkflow
Overrides Executable.constructor
- Defined in src/execute-workflow.ts:60

Properties

`Optional` brandId

brandId?: number

The brand identifier.

`Optional` passId

passId?: number

The pass identifier - provide either this, passSerialNo or uniqueId.

`Optional` passSerialNo

passSerialNo?: string

The pass serial number - provide either this, passId or uniqueId.

`Optional` programId

programId?: number

The program identifier.

`Optional` uniqueId

uniqueId?: string

The pass unique identifier - provide either this, passId or passSerialNo.

`Optional` workflowId

workflowId?: string

The workflow identifier.

Methods

getBody

getBody(): Partial<IWorkflow>
getBody is used by the BambuClient to properly construct the request object body.

Returns Partial<IWorkflow>
Returns the expected body of the request utilizing the defined request attributes.
Overrides Executable.getBody
- Defined in src/execute-workflow.ts:71

getMethod

getMethod(): Method
The rest function method to invoke the api with.

Returns Method
Overrides Executable.getMethod
- Defined in src/execute-workflow.ts:43

getResponse

getResponse(apiResponse): IExecuteWorkflowResponse
This returns the proper response type for the execute function.
Parameters
- apiResponse: any
  The response from the API request.
Returns IExecuteWorkflowResponse
Overrides Executable.getResponse
- Defined in src/execute-workflow.ts:47

getRootPath

getRootPath(): undefined | string
getRootPath is used by the BambuClient to properly construct the request call.

Returns undefined | string
The root path of the request
Overrides Executable.getRootPath
- Defined in src/execute-workflow.ts:83

getURLPath

getURLPath(tenantId?): string
The URL path to invoke.
Parameters
- Optional tenantId: string
  The tenantId provided by the BambuMeta client.
Returns string
Overrides Executable.getURLPath
- Defined in src/execute-workflow.ts:51

prepareRequest

prepareRequest(options): Promise<any>
Parameters
- options: {
  execute: ((executable) => Promise<any>);
  }
  - execute: ((executable) => Promise<any>)
    - (executable): Promise<any>
      Parameters
      executable: Executable<any>
      Returns Promise<any>
Returns Promise<any>
Inherited from Executable.prepareRequest
- Defined in src/executable.ts:9

Class ExecuteWorkflow

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ExecuteWorkflow

Properties

Optional brandId

Optional passId

Optional passSerialNo

Optional programId

Optional uniqueId

Optional workflowId

Methods

getBody

Returns Partial<IWorkflow>

getMethod

Returns Method

getResponse

Parameters

Returns IExecuteWorkflowResponse

getRootPath

Returns undefined | string

getURLPath

Parameters

Returns string

prepareRequest

Parameters

execute: ((executable) => Promise<any>)

Parameters

Returns Promise<any>

Returns Promise<any>

Settings

Member Visibility

Theme

On This Page

`Optional` brandId

`Optional` passId

`Optional` passSerialNo

`Optional` programId

`Optional` uniqueId

`Optional` workflowId