Class ProductsClient

Hierarchy

GhlClient
- ProductsClient

Index

Constructors

Methods

findById remove update create find createPrice findPrices findPriceById updatePrice removePrice

Constructors

constructor

new ProductsClient(accessToken: string): ProductsClient
Parameters
- accessToken: string
Returns ProductsClient
Overrides GhlClient.constructor
- Defined in products/products.client.ts:15

Methods

findById

findById(productId: string, locationId: string): Promise<Product>
Parameters
- productId: string
- locationId: string
Returns Promise<Product>
- Defined in products/products.client.ts:19

remove

remove(productId: string, locationId: string): Promise<ProductsDeleteResponse>
Parameters
- productId: string
- locationId: string
Returns Promise<ProductsDeleteResponse>
- Defined in products/products.client.ts:28

update

update(productId: string, dto: ProductDto): Promise<Product>
Parameters
- productId: string
- dto: ProductDto
Returns Promise<Product>
- Defined in products/products.client.ts:37

create

create(dto: ProductDto): Promise<Product>
Parameters
- dto: ProductDto
Returns Promise<Product>
- Defined in products/products.client.ts:41

find

find(params: ProductSearchParams): Promise<ListProductsResponse>
Parameters
- params: ProductSearchParams
Returns Promise<ListProductsResponse>
- Defined in products/products.client.ts:45

createPrice

createPrice(productId: string, dto: ProductPriceDto): Promise<ProductPrice>
Parameters
- productId: string
- dto: ProductPriceDto
Returns Promise<ProductPrice>
- Defined in products/products.client.ts:51

findPrices

findPrices(
productId: string,
params: ProductPriceSearchParams,
): Promise<ListProductPricesResponse>
Parameters
- productId: string
- params: ProductPriceSearchParams
Returns Promise<ListProductPricesResponse>
- Defined in products/products.client.ts:58

findPriceById

findPriceById(
    productId: string,
    priceId: string,
    locationId: string,
): Promise<ProductPrice>
Parameters
- productId: string
- priceId: string
- locationId: string
Returns Promise<ProductPrice>
- Defined in products/products.client.ts:67

updatePrice

updatePrice(
    productId: string,
    priceId: string,
    dto: ProductPriceDto,
): Promise<ProductPrice>
Parameters
- productId: string
- priceId: string
- dto: ProductPriceDto
Returns Promise<ProductPrice>
- Defined in products/products.client.ts:77

removePrice

removePrice(
    productId: string,
    priceId: string,
    locationId: string,
): Promise<ProductsDeleteResponse>
Parameters
- productId: string
- priceId: string
- locationId: string
Returns Promise<ProductsDeleteResponse>
- Defined in products/products.client.ts:88