productsapi.md

fiken › ProductsApi

Class: ProductsApi

Hierarchy

• BaseAPI

  ↳ ProductsApi

Index

Constructors

• constructor

Properties

• configuration

Methods

• createProduct
• createProductRaw
• createProductSalesReport
• createProductSalesReportRaw
• deleteProduct
• deleteProductRaw
• getProduct
• getProductRaw
• getProducts
• getProductsRaw
• request
• updateProduct
• updateProductRaw
• withMiddleware
• withPostMiddleware
• withPreMiddleware

Constructors

constructor

+ new ProductsApi(configuration: Configuration‹›): ProductsApi

Inherited from BaseAPI.constructor

Parameters:

Name	Type	Default
configuration	Configuration‹›	new Configuration()

Returns: ProductsApi

Properties

Protected configuration

• configuration: Configuration‹›

Inherited from BaseAPI.configuration

Methods

createProduct

▸ createProduct(requestParameters: CreateProductRequest): Promise‹void›

Creates a new product.

Parameters:

Name	Type
requestParameters	CreateProductRequest

Returns: Promise‹void›

---

createProductRaw

▸ createProductRaw(requestParameters: CreateProductRequest): Promise‹ApiResponse‹void››

Creates a new product.

Parameters:

Name	Type
requestParameters	CreateProductRequest

Returns: Promise‹ApiResponse‹void››

---

createProductSalesReport

▸ createProductSalesReport(requestParameters: CreateProductSalesReportRequest): Promise‹Array‹ProductSalesReportResult››

Creates a report based on provided specifications.

Parameters:

Name	Type
requestParameters	CreateProductSalesReportRequest

Returns: Promise‹Array‹ProductSalesReportResult››

---

createProductSalesReportRaw

▸ createProductSalesReportRaw(requestParameters: CreateProductSalesReportRequest): Promise‹ApiResponse‹Array‹ProductSalesReportResult›››

Creates a report based on provided specifications.

Parameters:

Name	Type
requestParameters	CreateProductSalesReportRequest

Returns: Promise‹ApiResponse‹Array‹ProductSalesReportResult›››

---

deleteProduct

▸ deleteProduct(requestParameters: DeleteProductRequest): Promise‹void›

Delete product with specified id.

Parameters:

Name	Type
requestParameters	DeleteProductRequest

Returns: Promise‹void›

---

deleteProductRaw

▸ deleteProductRaw(requestParameters: DeleteProductRequest): Promise‹ApiResponse‹void››

Delete product with specified id.

Parameters:

Name	Type
requestParameters	DeleteProductRequest

Returns: Promise‹ApiResponse‹void››

---

getProduct

▸ getProduct(requestParameters: GetProductRequest): Promise‹Product›

Returns product with specified id.

Parameters:

Name	Type
requestParameters	GetProductRequest

Returns: Promise‹Product›

---

getProductRaw

▸ getProductRaw(requestParameters: GetProductRequest): Promise‹ApiResponse‹Product››

Returns product with specified id.

Parameters:

Name	Type
requestParameters	GetProductRequest

Returns: Promise‹ApiResponse‹Product››

---

getProducts

▸ getProducts(requestParameters: GetProductsRequest): Promise‹Array‹Product››

Returns all products for given company

Parameters:

Name	Type
requestParameters	GetProductsRequest

Returns: Promise‹Array‹Product››

---

getProductsRaw

▸ getProductsRaw(requestParameters: GetProductsRequest): Promise‹ApiResponse‹Array‹Product›››

Returns all products for given company

Parameters:

Name	Type
requestParameters	GetProductsRequest

Returns: Promise‹ApiResponse‹Array‹Product›››

---

Protected request

▸ request(context: RequestOpts): Promise‹Response›

Inherited from BaseAPI.request

Parameters:

Name	Type
context	RequestOpts

Returns: Promise‹Response›

---

updateProduct

▸ updateProduct(requestParameters: UpdateProductRequest): Promise‹void›

Updates an existing product.

Parameters:

Name	Type
requestParameters	UpdateProductRequest

Returns: Promise‹void›

---

updateProductRaw

▸ updateProductRaw(requestParameters: UpdateProductRequest): Promise‹ApiResponse‹void››

Updates an existing product.

Parameters:

Name	Type
requestParameters	UpdateProductRequest

Returns: Promise‹ApiResponse‹void››

---

withMiddleware

▸ withMiddleware‹T›(this: T, ...middlewares: Middleware[]): T

Inherited from BaseAPI.withMiddleware

Type parameters:

▪ T: BaseAPI

Parameters:

Name	Type
this	T
...middlewares	Middleware[]

Returns: T

---

withPostMiddleware

▸ withPostMiddleware‹T›(this: T, ...postMiddlewares: Array‹Middleware["post"]›): T

Inherited from BaseAPI.withPostMiddleware

Type parameters:

▪ T: BaseAPI

Parameters:

Name	Type
this	T
...postMiddlewares	Array‹Middleware["post"]›

Returns: T

---

withPreMiddleware

▸ withPreMiddleware‹T›(this: T, ...preMiddlewares: Array‹Middleware["pre"]›): T

Inherited from BaseAPI.withPreMiddleware

Type parameters:

▪ T: BaseAPI

Parameters:

Name	Type
this	T
...preMiddlewares	Array‹Middleware["pre"]›

Returns: T