Class ApiParser

This class to parse api response

Hierarchy

ApiParser

Index

Constructors

constructor

Methods

Constructors

constructor

new ApiParser(): ApiParser

Returns ApiParser

Methods

parseAgentSettings

parseAgentSettings(settings: HttpResponse): AgentSettings

Method to parse Agent settings response
example
```
parseAgentSettings(settings)
```
Parameters
- settings: HttpResponse
  
  AgentSettings response
Returns AgentSettings
- parsed Agent settings

parseBrandingProfile

parseBrandingProfile(brandingProfileResponse: HttpResponse): BrandingProfile

Method to parse CXone Branding Profile response
example
```
parseBrandingProfile(brandingProfileResponse)
```
Parameters
- brandingProfileResponse: HttpResponse
Returns BrandingProfile
- parsed CXone Branding Profile

parseBusinessUnit

parseBusinessUnit(businessUnitResponse: HttpResponse): BusinessUnit

Method to parse Business Unit response
example
```
parseBusinessUnit(businessUnitResponse)
```
Parameters
- businessUnitResponse: HttpResponse
Returns BusinessUnit
- parsed Business Unit

parseCentralBrandingProfile

parseCentralBrandingProfile(centralBrandingProfileResponse: HttpResponse): CentralBrandingProfile

Method to parse Central Branding Profile response
example
```
parseCentralBrandingProfile(centralBrandingProfileResponse)
```
Parameters
- centralBrandingProfileResponse: HttpResponse
Returns CentralBrandingProfile
- parsed Central Branding Profile

parsePermissions

parsePermissions(response: HttpResponse): Permissions[]

Method to parse agent permissions response
example
```
parsePermissions(permissions)
```
Parameters
- response: HttpResponse
Returns Permissions[]
- parsed permissions

Generated using TypeDoc