ThirdService | Koban | Node API Library

Hierarchy

BaseService
- ThirdService

Index

Constructors

constructor

Properties

Accessors

serviceUrl

Methods

Constructors

constructor

new ThirdService(config: IConfigService): ThirdService

Overrides BaseService.constructor
- Defined in services/third.service.ts:20
Creates an instance of ThirdService.

memberof

ThirdService

Parameters
- config: IConfigService
Returns ThirdService

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

getByLabel

getByLabel(search: string): Promise<KobanResultList<KobanThird>>

- Defined in services/third.service.ts:242
Renvoie la liste des comptes dont le label contient le terme recherché

memberof

ThirdService

Parameters
- search: string
  
  String recherché
Returns Promise<KobanResultList<KobanThird>>

getClosedUpdated

getClosedUpdated(__namedParameters?: { length: undefined | number; start: undefined | number; structcode: undefined | string; updated: Date }): Promise<KobanResultList<KobanThird>>

- Defined in services/third.service.ts:201
memberof

ThirdService

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

getOne

getOne(id: string): Promise<KobanThird>

- Defined in services/third.service.ts:321
Renvoie un compte à partir de son identifiant

memberof

ThirdService

Parameters
- id: string
  
  Identifiant (Guid) du compte
Returns Promise<KobanThird>

getOneByExtcode

getOneByExtcode(extcode: string): Promise<KobanThird>

- Defined in services/third.service.ts:349
Renvoie un compte à partir de son identifiant externe

memberof

ThirdService

Parameters
- extcode: string
  
  Identifiant externe du compte
Returns Promise<KobanThird>

getStatus

getStatus(__namedParameters?: { length: undefined | number; start: undefined | number; status: undefined | string; structcode: undefined | string; updated: Date }): Promise<KobanResultList<KobanThird>>

- Defined in services/third.service.ts:278
Renvoie la liste des comptes modifiés ou créés depuis une date de référence et correspondant à un statut

memberof

ThirdService

Parameters
- Default value __namedParameters: { length: undefined | number; start: undefined | number; status: undefined | string; structcode: undefined | string; updated: Date } = {length: 20,start: 0,updated: new Date(),structcode: '',status: ''}
  
  Options object
  - length: undefined | number
    
    Longueur de la liste renvoyée (pagination).
  - start: undefined | number
    
    Index de départ (pagination).
  - status: undefined | string
    
    Code du statut paramétré dans Koban (Ex. : CLI pour client, PRO pour prospect)
  - structcode: undefined | string
    
    Code de la structure.
  - updated: Date
    
    date de référence.
Returns Promise<KobanResultList<KobanThird>>

getUpdated

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

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

memberof

ThirdService

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

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(thirds: KobanThird[], uniqueproperty: KobanThirdUniqueProperty): Promise<string[]>

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

memberof

ThirdService

Parameters
- thirds: KobanThird[]
  
  Liste d'object KobanThird sous forme de tableau
- uniqueproperty: KobanThirdUniqueProperty
  
  Propriété sélectionnée pour vérifier si le compte doit être créé ou modifié. L'API vérifie qu'un compte correspondant à cette clé existe. Si il existe, il effectue une modification, sinon il effectue une création
Returns Promise<string[]>

postOne

postOne(third: KobanThird, uniqueproperty: KobanThirdUniqueProperty): Promise<string>

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

memberof

ThirdService

Parameters
- third: KobanThird
  
  Le compte
- uniqueproperty: KobanThirdUniqueProperty
  
  Propriété sélectionnée pour vérifier si le compte doit être créé ou modifié. L'API vérifie qu'un compte correspondant à cette clé existe. Si il existe, il effectue une modification, sinon il effectue une création
Returns Promise<string>

postOneFromEMail

postOneFromEMail(third: KobanThird, creationtype: string): Promise<string>

- Defined in services/third.service.ts:121
Crée ou modifie un compte.

memberof

ThirdService

Parameters
- third: KobanThird
  
  Le compte
- creationtype: string
Returns Promise<string>

removeTagsFromThird

removeTagsFromThird(tags: KobanTag[], id: string): Promise<boolean>

- Defined in services/third.service.ts:378
Remove Tags from a Third

memberof

ThirdService

Parameters
- tags: KobanTag[]
  
  Liste des Tag a supprimer
- id: string
  
  Identifiant du Compte
Returns Promise<boolean>

Generated using TypeDoc

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

config: IConfigService

Returns ThirdService

Properties

Private baseUrl

Private key

Private urlService

Private user

Accessors

Protected serviceUrl

Returns string

Methods

getByLabel

Parameters

search: string

Returns Promise<KobanResultList<KobanThird>>

getClosedUpdated

Parameters

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

length: undefined | number

start: undefined | number

structcode: undefined | string

updated: Date

Returns Promise<KobanResultList<KobanThird>>

getOne

Parameters

id: string

Returns Promise<KobanThird>

getOneByExtcode

Parameters

extcode: string

Returns Promise<KobanThird>

getStatus

Parameters

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

length: undefined | number

start: undefined | number

status: undefined | string

structcode: undefined | string

updated: Date

Returns Promise<KobanResultList<KobanThird>>

getUpdated

Parameters

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

length: undefined | number

start: undefined | number

structcode: undefined | string

updated: Date

Returns Promise<KobanResultList<KobanThird>>

handleApiError

Parameters

payload: KobanAPIResponse

Returns Error

postMany

Parameters

thirds: KobanThird[]

uniqueproperty: KobanThirdUniqueProperty

Returns Promise<string[]>

postOne

Parameters

third: KobanThird

uniqueproperty: KobanThirdUniqueProperty

Returns Promise<string>

postOneFromEMail

Parameters

third: KobanThird

creationtype: string

Returns Promise<string>

removeTagsFromThird

Parameters

tags: KobanTag[]

id: string