Class ApiParser

This class to parse api response

Hierarchy

ApiParser

Index

Constructors

constructor

Methods

Constructors

constructor

new ApiParser(): ApiParser

Returns ApiParser

Methods

parseAgentConfiguration

parseAgentConfiguration(AgentProfileResponse: HttpResponse): AgentProfileSettings

- Defined in core-sdk/src/util/api-parser.ts:148
This method to check Agent Profile Data and get desired configuration
example
```
parseAgentConfiguration(AgentProfileResponse)
```
Parameters
- AgentProfileResponse: HttpResponse
Returns AgentProfileSettings
- configuration data

parseAgentSettings

parseAgentSettings(settings: HttpResponse): AgentSettings

- Defined in core-sdk/src/util/api-parser.ts:90
Method to parse Agent settings response
example
```
parseAgentSettings(settings)
```
Parameters
- settings: HttpResponse
  
  AgentSettings response
Returns AgentSettings
- parsed Agent settings

parseBrandingProfile

parseBrandingProfile(brandingProfileResponse: HttpResponse): BrandingProfile

- Defined in core-sdk/src/util/api-parser.ts:368
Method to parse CXone Branding Profile response
example
```
parseBrandingProfile(brandingProfileResponse)
```
Parameters
- brandingProfileResponse: HttpResponse
Returns BrandingProfile
- parsed CXone Branding Profile

parseBusinessUnit

parseBusinessUnit(businessUnitResponse: HttpResponse): BusinessUnit

- Defined in core-sdk/src/util/api-parser.ts:125
Method to parse Business Unit response
example
```
parseBusinessUnit(businessUnitResponse)
```
Parameters
- businessUnitResponse: HttpResponse
Returns BusinessUnit
- parsed Business Unit

parseCentralBrandingProfile

parseCentralBrandingProfile(centralBrandingProfileResponse: HttpResponse): CentralBrandingProfile

- Defined in core-sdk/src/util/api-parser.ts:331
Method to parse Central Branding Profile response
example
```
parseCentralBrandingProfile(centralBrandingProfileResponse)
```
Parameters
- centralBrandingProfileResponse: HttpResponse
Returns CentralBrandingProfile
- parsed Central Branding Profile

parseDesktopProfileConfiguration

parseDesktopProfileConfiguration(desktopProfileResponse: HttpResponse): AgentProfileSettings

- Defined in core-sdk/src/util/api-parser.ts:215
This method to parse Desktop Profile Response and return configuration
example
```
parseDesktopProfileConfiguration(desktopProfileResponse)
```
Parameters
- desktopProfileResponse: HttpResponse
  
  Desktop Profile Response
Returns AgentProfileSettings
- configuration data

parsePermissions

parsePermissions(response: HttpResponse): Permissions[]

- Defined in core-sdk/src/util/api-parser.ts:27
Method to parse agent permissions response
example
```
parsePermissions(permissions)
```
Parameters
- response: HttpResponse
Returns Permissions[]
- parsed permissions

parseTenantData

parseTenantData(tenantDataRepsonse: HttpResponse): Tenant

- Defined in core-sdk/src/util/api-parser.ts:410
Method to parse Tenant Data response
example
```
parseTeneantData(tenantDataRepsonse)
```
Parameters
- tenantDataRepsonse: HttpResponse
  
  Tenant Data response
Returns Tenant
- parsed Tenant Data

Generated using TypeDoc