ProductService | Koban | Node API Library

Hierarchy

BaseService
- ProductService

Index

Constructors

constructor

Properties

Accessors

serviceUrl

Methods

Constructors

constructor

new ProductService(config: IConfigService): ProductService

Overrides BaseService.constructor
- Defined in services/product.service.ts:17
Creates an instance of ProductService.

memberof

ProductService

Parameters
- config: IConfigService
Returns ProductService

Properties

Private baseUrl

baseUrl: string

memberof: BaseService

Private key

key: string

memberof: BaseService

Private urlService

urlService: string

Base Url of the Service API

memberof: BaseService

Private user

user: string

memberof: BaseService

Accessors

Protected serviceUrl

get serviceUrl(): string

Inherited from BaseService.serviceUrl
- Defined in services/base.service.ts:61
readonly

memberof

BaseService

Returns string

Methods

getOne

getOne(id: string): Promise<KobanProduct>

- Defined in services/product.service.ts:138
Renvoie la définition d'un produit

memberof

ProductService

Parameters
- id: string
  
  Guid du produit
Returns Promise<KobanProduct>

getSearch

getSearch(search: string): Promise<KobanResultList<KobanProduct>>

- Defined in services/product.service.ts:34
Renvoie la liste des produits correspondant à un paramètre de recherche

memberof

ProductService

Parameters
- search: string
  
  Valeur de recherche
Returns Promise<KobanResultList<KobanProduct>>

getSearchForStock

getSearchForStock(search: string): Promise<KobanResultList<KobanProduct>>

- Defined in services/product.service.ts:65
Renvoie la liste des produits gérés en stock et correspondant à un paramètre de recherche

memberof

ProductService

Parameters
- search: string
  
  Valeur de recherche
Returns Promise<KobanResultList<KobanProduct>>

getUpdated

getUpdated(__namedParameters?: { length: undefined | number; start: undefined | number; updated: Date }): Promise<KobanResultList<KobanProduct>>

- Defined in services/product.service.ts:99
Renvoie la liste des produits créés ou modifiés depuis une date de référence

memberof

ProductService

Parameters
- Default value __namedParameters: { length: undefined | number; start: undefined | number; updated: Date } = {length: 20,start: 0,updated: new Date()}
  
  Options object
  - length: undefined | number
    
    Longueur de la liste renvoyée (pagination).
  - start: undefined | number
    
    Index de départ (pagination).
  - updated: Date
    
    date de référence.
Returns Promise<KobanResultList<KobanProduct>>

handleApiError

handleApiError(payload: KobanAPIResponse): Error

Inherited from BaseService.handleApiError
- Defined in services/base.service.ts:83
memberof

BaseService

Parameters
- payload: KobanAPIResponse
Returns Error

postMany

postMany(products: KobanProduct[], uniqueproperty: KobanProductUniqueProperty, catproductuniqueproperty: KobanProductCategoryUniqueProperty): Promise<string[]>

- Defined in services/product.service.ts:172
Crée ou modifie un ensemble de produits. Si un produit correspondant à la clé uniqueproperty existe, alors l'API effectue une création. Sinon l'API met à jour le produit.

memberof

ProductService

Parameters
- products: KobanProduct[]
  
  Tableau de Produits
- uniqueproperty: KobanProductUniqueProperty
  
  Propriété sélectionnée pour vérifier si le produit doit être créé ou modifié. L'API vérifie qu'un produit correspondant à cette clé existe. Si il existe, il effectue une modification, sinon il effectue une création
- catproductuniqueproperty: KobanProductCategoryUniqueProperty
  
  Propriété définissant la clé de la catégorie de produit associée au produit.
Returns Promise<string[]>

postOne

postOne(product: KobanProduct, uniqueproperty: KobanProductUniqueProperty, catproductuniqueproperty: KobanProductCategoryUniqueProperty): Promise<string>

- Defined in services/product.service.ts:219
Crée ou modifie un produit. Si un produit correspondant à la clé uniqueproperty existe, alors l'API effectue une création. Sinon l'API met à jour le produit.

memberof

ProductService

Parameters
- product: KobanProduct
  
  Le produit
- uniqueproperty: KobanProductUniqueProperty
  
  Propriété sélectionnée pour vérifier si le produit doit être créé ou modifié. L'API vérifie qu'un produit correspondant à cette clé existe. Si il existe, il effectue une modification, sinon il effectue une création
- catproductuniqueproperty: KobanProductCategoryUniqueProperty
  
  Propriété définissant la clé de la catégorie de produit associée au produit.
Returns Promise<string>

Generated using TypeDoc

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

config: IConfigService

Returns ProductService

Properties

Private baseUrl

Private key

Private urlService

Private user

Accessors

Protected serviceUrl

Returns string

Methods

getOne

Parameters

id: string

Returns Promise<KobanProduct>

getSearch

Parameters

search: string

Returns Promise<KobanResultList<KobanProduct>>

getSearchForStock

Parameters

search: string

Returns Promise<KobanResultList<KobanProduct>>

getUpdated

Parameters

Default value __namedParameters: { length: undefined | number; start: undefined | number; updated: Date } = {length: 20,start: 0,updated: new Date()}

length: undefined | number

start: undefined | number

updated: Date

Returns Promise<KobanResultList<KobanProduct>>

handleApiError

Parameters

payload: KobanAPIResponse

Returns Error

postMany

Parameters

products: KobanProduct[]

uniqueproperty: KobanProductUniqueProperty

catproductuniqueproperty: KobanProductCategoryUniqueProperty

Returns Promise<string[]>

postOne

Parameters

product: KobanProduct

uniqueproperty: KobanProductUniqueProperty

catproductuniqueproperty: KobanProductCategoryUniqueProperty

Returns Promise<string>