Class GetOrders

The get order api is a retrieves the list of orders created for the provided person.

Hierarchy

Executable<GetOrdersResponse>
- GetOrders

Index

Constructors

Properties

email? orderId? personId?

Methods

getBody getMethod getResponse getRootPath getURLPath prepareRequest

Constructors

constructor

new GetOrders(input?): GetOrders
Parameters
- Optional input: GetOrdersInput
Returns GetOrders
Overrides Executable.constructor
- Defined in src/get-order.ts:83

Properties

`Optional` email

email?: string

`Optional` orderId

orderId?: number

`Optional` personId

personId?: string

Methods

getBody

getBody(): any
getBody is used by the BambuClient to properly construct the request object body.

Returns any
Returns the expected body of the request utilizing the defined request attributes.
Overrides Executable.getBody
- Defined in src/get-order.ts:94

getMethod

getMethod(): Method
getMethod is used by the BambuClient to properly construct the request call.

Returns Method
request method
Overrides Executable.getMethod
- Defined in src/get-order.ts:51

getResponse

getResponse(apiResponse): GetOrdersResponse
getResponse is used by the BambuClient to propery return the response object type.
Parameters
- apiResponse: any
  
  the api response object returned by the BambuMeta client before being converted to the GetOrderResponse
Returns GetOrdersResponse
GetOrderResponse
Overrides Executable.getResponse
- Defined in src/get-order.ts:60

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/get-order.ts:102

getURLPath

getURLPath(tenantId?): string
getURLPath is used by the BambuClient to properly construct the request call.
Parameters
- Optional tenantId: string
  
  the tenant id defined in the BambuClient
Returns string
request url
Overrides Executable.getURLPath
- Defined in src/get-order.ts:71

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

Generated using TypeDoc