npm package: @one-view/pd-oneview-queue-monitor-types
Description: queue monitor for supervisor tool service into 1vu integration
Latest version: 0.0.10


FORMAT: 1A
VERSION: 1.0.0
HOST: https://api.pd-oneview.net/queue-monitor

# pd-oneview-queue-monitor

queue monitor for supervisor tool service into 1vu integration




## Obtain Queue list [/v1/queues{?filter.queue.name,filter.channel,orderBy,direction,page,pageSize}]

+ Parameters
    + filter.queue.name (optional, string)
    + filter.channel (optional, string)
    + orderBy (optional, string)
    + direction (optional, SortOrder)
    + page (optional, int64)
        + Default: `1`
    + pageSize (optional, int64)
        + Default: `10`

### List All Queues [GET]

+ Request

    + Headers

            Authorization: bearer token

+ Response 200 (application/json)
    + Attributes (QueuesListResponse)

+ Response 400 (application/json)
    + Attributes (Error)

+ Response 401 (application/json)
    + Attributes (Error)

+ Response 403 (application/json)
    + Attributes (Error)

+ Response 404 (application/json)
    + Attributes (Error)

+ Response 500 (application/json)
    + Attributes (Error)

## Obtain Case List Under a Queue [/v1/queues/{id}/cases{?filter.case.id,filter.customer.email,filter.customer.name,filter.region,direction,orderBy,page,pageSize}]

+ Parameters
    + id (required, string)
    + filter.case.id (optional, string)
    + filter.customer.email (optional, string)
    + filter.customer.name (optional, string)
    + filter.region (optional, string)
    + orderBy (optional, string)
    + direction (optional, SortOrder)
    + page (optional, int64)
        + Default: `1`
    + pageSize (optional, int64)
        + Default: `10`

### List All Cases under a queue [GET]

+ Request

    + Headers

            Authorization: bearer token

+ Response 200 (application/json)
    + Attributes (CasesListResponse)

+ Response 400 (application/json)
    + Attributes (Error)

+ Response 401 (application/json)
    + Attributes (Error)

+ Response 403 (application/json)
    + Attributes (Error)

+ Response 404 (application/json)
    + Attributes (Error)

+ Response 500 (application/json)
    + Attributes (Error)
# Data Structures

## int32 (number)
## int64 (number)
## double (number)

## `error_object` (object)
+ `status` (string)
+ `title` (string)

## `Error` (object)
+ errors (array[error_object])

## `Error_401` (object)
+ errors (array)
    + - (`error_object`)
        + `status`: `401` (string)
        + `title`: `not authorize` (string)

## `Error_404` (object)
+ errors (array)
    + - (`error_object`)
        + `status`: `404` (string)
        + `title`: `not found` (string)

## `Error_403` (object)
+ errors (array)
    + - (`error_object`)
        + `status`: `403` (string)
        + `title`: `forbidden` (string)

## `Error_400` (object)
+ errors (array)
    + - (`error_object`)
        + `status`: `400` (string)
        + `title`: `bad request` (string)

## `Error_500` (object)
+ errors (array)
    + - (`error_object`)
        + `status`: `500` (string)
        + `title`: `internal server error` (string)

## CasesListResponse
+ list (array[Case], fixed-type) - list of cases under a queue
+ page: 1 (int32)
+ pageSize: 10 (int32)

## QueuesListResponse
+ list (array[Queue], fixed-type) - list of queues
+ page: 1 (int32)
+ pageSize: 10 (int32)

## Case
+ id: `123122` (string)
+ platform: `Foodpanda Android` (string)
+ customer (CaseCustomer) - customer data
+ ccr: `Delivery Delay` (string)
+ orderId: `hgjs-9rww` (string)
+ region: `Singapore` (string)

## CaseCustomer
+ email: `foo@example.com` (string)
+ id: `1234567` (string)
+ name: `foo bar` (string)

## Queue
+ id : `123122` (string, required)
+ queueName: `CS Chat English` (string, required)
+ channel: `Chat` (string, required)
+ casesBacklog: 100 (int64, required)
+ longestWaitTime: 10000 (int64, required)
+ avgWaitTime: 10000 (int64, required)
+ avgHandlingTime: 10.0 (double, required)
+ onlineAgentCount: 10 (int64, required)
+ totalAgentCount: 20 (int64, required)

## SortOrder (enum)
+ asc
+ desc