Class UpdateBrand

This class is used to construct the input to update a brand. The inputs can either be provided as part of the constructor, or set after the fact in the public properties.

BrandId is required to update the brand.

Hierarchy

Executable<BambuBrand>
- UpdateBrand

Implements

Partial<BambuBrand>

Index

Constructors

constructor

new UpdateBrand(input?): UpdateBrand
Parameters
- Optional input: Partial<BambuBrand> & {
  brandId: number;
  }
Returns UpdateBrand
Overrides Executable.constructor
- Defined in src/onboarding/update-brand.ts:32

Properties

`Optional` brandId

brandId?: number

`Optional` description

description?: string

`Optional` logo

logo?: string

`Optional` name

name?: string

`Optional` reportSite

reportSite?: string

`Optional` tenantId

tenantId?: number

`Optional` uiConfig

uiConfig?: BambuBrandUIConfig

Methods

getBody

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

Returns Partial<BambuBrand>
Returns the expected body of the request utilizing the defined request attributes.
Overrides Executable.getBody
- Defined in src/onboarding/update-brand.ts:43

getMethod

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

Returns Method
Overrides Executable.getMethod
- Defined in src/onboarding/update-brand.ts:20

getResponse

getResponse(apiResponse): BambuBrand
This returns the proper response type for the execute function.
Parameters
- apiResponse: any
  
  The response from the API request.
Returns BambuBrand
Overrides Executable.getResponse
- Defined in src/onboarding/update-brand.ts:24

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/onboarding/update-brand.ts:59

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/onboarding/update-brand.ts:28

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 UpdateBrand

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional input: Partial<BambuBrand> & { brandId: number; }

Returns UpdateBrand

Properties

Optional brandId

Optional description

Optional logo

Optional name

Optional reportSite

Optional tenantId

Optional uiConfig

Methods

getBody

Returns Partial<BambuBrand>

getMethod

Returns Method

getResponse

Parameters

apiResponse: any

Returns BambuBrand

getRootPath

Returns undefined | string

getURLPath

Parameters

Optional tenantId: string

Returns string

prepareRequest

Parameters

options: { execute: ((executable) => Promise<any>); }

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

Parameters

executable: Executable<any>

Returns Promise<any>

Returns Promise<any>

Settings

Member Visibility

Theme

On This Page

`Optional` input: Partial<BambuBrand> & {
brandId: number;
}

`Optional` brandId

`Optional` description

`Optional` logo

`Optional` name

`Optional` reportSite

`Optional` tenantId

`Optional` uiConfig

`Optional` tenantId: string

options: {
execute: ((executable) => Promise<any>);
}