OrderService | Koban | Node API Library

Hierarchy

BaseService
- OrderService

Index

Constructors

constructor

Properties

Accessors

serviceUrl

Methods

Constructors

constructor

new OrderService(config: IConfigService): OrderService

Overrides BaseService.constructor
- Defined in services/order.service.ts:21
Creates an instance of OrderService.

memberof

OrderService

Parameters
- config: IConfigService
Returns OrderService

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

getByDate

getByDate(__namedParameters?: { from: Date; length: number; start: undefined | number; to: Date }): Promise<KobanResultList<KobanOrder>>

- Defined in services/order.service.ts:242
Renvoie la liste des bons de commande entre deux dates

memberof

OrderService

Parameters
- Default value __namedParameters: { from: Date; length: number; start: undefined | number; to: Date } = {length: 20,start: 0,from: new Date(),to: new Date(),}
  
  Options object
  - from: Date
    
    date de début de la plage
  - length: number
    
    Longueur de la liste renvoyée (pagination).
  - start: undefined | number
    
    Index de départ (pagination).
  - to: Date
    
    date de fin de la plage
Returns Promise<KobanResultList<KobanOrder>>

getUpdated

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

- Defined in services/order.service.ts:287
Renvoie la liste des bons de commande créés ou modifiés depuis une date de référence

memberof

OrderService

Parameters
- Default value __namedParameters: { fill: undefined | false | true; length: undefined | number; start: undefined | number; updated: Date } = {length: 20,start: 0,updated: new Date(),fill: false,}
  
  Options object
  - fill: undefined | false | true
    
    Fill children objects.
  - 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<KobanOrder>>

handleApiError

handleApiError(payload: KobanAPIResponse): Error

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

BaseService

Parameters
- payload: KobanAPIResponse
Returns Error

postCancel

postCancel(order: KobanOrder, uniqueproperty: KobanOrderUniqueProperty): Promise<string>

- Defined in services/order.service.ts:89
memberof

OrderService

Parameters
- order: KobanOrder
- uniqueproperty: KobanOrderUniqueProperty
Returns Promise<string>

postMany

postMany(orders: KobanOrder[], uniqueproperty: KobanOrderUniqueProperty, dealuniqueproperty: KobanDealUniqueProperty, thirduniqueproperty: KobanThirdUniqueProperty): Promise<string[]>

- Defined in services/order.service.ts:45
Crée ou modifie un ensemble de bons de commandes. Si un bon de commande correspondant à la clé uniqueproperty existe, alors l'API effectue une création. Sinon l'API met à jour le bon de commande.

memberof

OrderService

Parameters
- orders: KobanOrder[]
  
  Liste des bons de commande en tableau
- uniqueproperty: KobanOrderUniqueProperty
  
  Propriété sélectionnée pour vérifier si le bon de commande doit être créé ou modifié. L'API vérifie qu'un bon de commande correspondant à cette clé existe. Si il existe, il effectue une modification, sinon il effectue une création
- dealuniqueproperty: KobanDealUniqueProperty
  
  Propriété définissant la clé de l'opportunité associée au bon de commande.
- thirduniqueproperty: KobanThirdUniqueProperty
  
  Propriété définissant la clé du compte associé au produit.
Returns Promise<string[]>

postOne

postOne(order: KobanOrder, uniqueproperty: KobanOrderUniqueProperty): Promise<string>

- Defined in services/order.service.ts:124
memberof

OrderService

Parameters
- order: KobanOrder
- uniqueproperty: KobanOrderUniqueProperty
Returns Promise<string>

postOneFromeShop

postOneFromeShop(eShopOrder: KobanEShopOrder, uniqueproperty: KobanOrderUniqueProperty, thirduniqueproperty: KobanThirdUniqueProperty, dealuniqueproperty?: KobanDealUniqueProperty): Promise<string>

- Defined in services/order.service.ts:161
memberof

OrderService

Parameters
- eShopOrder: KobanEShopOrder
- uniqueproperty: KobanOrderUniqueProperty
- thirduniqueproperty: KobanThirdUniqueProperty
- Optional dealuniqueproperty: KobanDealUniqueProperty
Returns Promise<string>

updateTrackingOrderFromShop

updateTrackingOrderFromShop(tracking: KobanEShopTrackingOrder, uniqueproperty: KobanOrderUniqueProperty): Promise<string>

- Defined in services/order.service.ts:200
memberof

OrderService

Parameters
- tracking: KobanEShopTrackingOrder
- uniqueproperty: KobanOrderUniqueProperty
Returns Promise<string>

Generated using TypeDoc

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

config: IConfigService

Returns OrderService

Properties

Private baseUrl

Private key

Private urlService

Private user

Accessors

Protected serviceUrl

Returns string

Methods

getByDate

Parameters

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

from: Date

length: number

start: undefined | number

to: Date

Returns Promise<KobanResultList<KobanOrder>>

getUpdated

Parameters

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

fill: undefined | false | true

length: undefined | number

start: undefined | number

updated: Date

Returns Promise<KobanResultList<KobanOrder>>

handleApiError

Parameters

payload: KobanAPIResponse

Returns Error

postCancel

Parameters

order: KobanOrder

uniqueproperty: KobanOrderUniqueProperty

Returns Promise<string>

postMany

Parameters

orders: KobanOrder[]

uniqueproperty: KobanOrderUniqueProperty

dealuniqueproperty: KobanDealUniqueProperty

thirduniqueproperty: KobanThirdUniqueProperty

Returns Promise<string[]>

postOne

Parameters

order: KobanOrder

uniqueproperty: KobanOrderUniqueProperty

Returns Promise<string>

postOneFromeShop

Parameters

eShopOrder: KobanEShopOrder

uniqueproperty: KobanOrderUniqueProperty

thirduniqueproperty: KobanThirdUniqueProperty

Optional dealuniqueproperty: KobanDealUniqueProperty

Returns Promise<string>

updateTrackingOrderFromShop

Parameters

tracking: KobanEShopTrackingOrder

uniqueproperty: KobanOrderUniqueProperty

Returns Promise<string>