open-index/open-npm huggingface dataset:
npm package: @one-view/example-api-types
Description: FORMAT: 1A VERSION: 1.0.0
Latest version: 1.0.3

FORMAT: 1A
VERSION: 1.0.0

# example api

## Order List [/order-list/v1/orders{?page,perPage,orderBy}]

get list of order based on specific parameter

+ Parameters
    + page - order of page
    + perPage - number of record of page
    + orderBy - order record based on selected criteria

+ Attributes (OrderList)

### Get order list [GET]
+ Request

    + Headers

            Authorization: bearer token

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

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

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

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

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



# Data Structures

## int8 (number)
## int64 (number)
## integer (number)
## float (number)
## date (string)

## `Error` (object)
+ errorCode    (number)
+ errorMessage (string)

## `Error_401` (object)
+ errorCode : 401 (number)
+ errorMessage : `not authorize` (string)

## `Error_404` (object)
+ errorCode : 404 (number)
+ errorMessage : `not found` (string)

## `Error_403` (object)
+ errorCode : 403 (number)
+ errorMessage : `forbidden` (string)

## `Error_400` (object)
+ errorCode : 400 (number)
+ errorMessage : `bad request` (string)

## `Error_500` (object)
+ errorCode : 500 (number)
+ errorMessage : `internal server error` (string)

## OrderListEntry
+ code          : `anba-ejsk` (string) - order code
+ itemCount     : 3 (int64) - number of items in the order
+ timestamp     : 1572499999 (int64) - epoch timestamp the order was created
+ amount        : 18.50 (number) - order price
+ status        : `ACTIVE` (string) - order status

## OrderList
+ list (array[OrderListEntry])
npm package: @one-view/fwf-proxy-types
Description: pandacare fwf proxy that support cache and invalidation
Latest version: 0.0.6


FORMAT: 1A
VERSION: 1.0.0
HOST: https://api.pd-oneview.net/fwf-proxy

# fwf-proxy

pandacare fwf proxy that support cache and invalidation




## Feature flag list [/v1/features-list/keys]

List of feature flag keys

### Get feature flag keys [GET]

+ Request

    + Headers

            Authorization: Bearer token

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

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

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

## Personal Feature Variations [/v1/features]

Get personal flag variations

### Put feature flag keys [PUT]

+ Request

    + Headers

            Authorization: Bearer token

+ Attributes (FeatureVariationsParam)

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

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

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

## Personal Feature Variation [/v1/features/{flagKey}]

Get personal flag variation

+ Parameters
    + flagKey (string, required) - flag key

### Put feature flag key [PUT]

+ Request

    + Headers

            Authorization: Bearer token

+ Attributes (FeatureVariationParam)

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

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

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

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

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

## `Error` (object)
+ errors (array[error_object], fixed-type)

## FeatureEnvKeys
+ list (array[FeatureEnvKey], required, fixed-type)

## FeatureEnvKey
+ key (string, required)
+ enabled (boolean, required)
+ kind (string, required)

## FeatureVariationParam
+ user (UserParam, required)

## FeatureVariationsParam
+ user (UserParam, required)
+ keys (array[string], fixed-type, optional)

## UserParam
+ email (string, required)
+ userId (string, optional)
+ customAttributes (object, optional)

## FeatureVariations
+ list (array[FeatureVariation], required, fixed-type)

## FeatureVariation
+ key (string, required)
+ variation (object, required)
+ abTest (boolean, optional)
+ error (string, optional)
+ type (string, required)
+ enabled (boolean, required)
npm package: @one-view/oneview-cs-be-translations-types
Description: A Service which provide with BE side translation
Latest version: 0.0.6


FORMAT: 1A
HOST: https://api.pd-oneview.net/translations

# oneview-cs-be-translations

A Service which provide with BE side translation




## List of Translations [/v1/entity/{type}/{lang}]

Translation list based on ccr

+ Parameters
    + type (required, string, `ccr`)
    + lang (required, string, `en`)

+ Attributes (Translations)

### Bulk upload translations [POST]

+ Request

    + Headers

            x-api-key: secretKey

+ Attributes (UploadTranslationsPayload)

+ Response 204 (application/json)

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

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

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

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

### get translations [GET]

+ Request

    + Headers

            x-api-key: secretKey

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

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

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

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

## Get translation [/v1/entity/{type}/{lang}/{key}]

+ Parameters
    + type (required, string, `ccr`)
    + lang (required, string, `eng`)
    + key (required, string, `1A.1`)

### get translation [GET]

+ Request

    + Headers

            x-api-key: secretKey

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

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

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

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

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

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

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

## `Error` (object)
+ errors (array[error_object], fixed-type)

## UploadTranslationsPayload
+ data (object, required)

## Translations
+ list (array[Translation], fixed-type)

## Translation
+ key       : `1C.1` (string, required) - key to be used to query
+ type      : `ccr` (string, required) - group of translation
+ language  : `en` (string, required) - language that will be queried
+ text      : `example of translation` (string, required) - text that has been translated
npm package: @one-view/pd-oneview-agent-update-types
Description: example delivery project
Latest version: 0.0.7


FORMAT: 1A
HOST: https://api.pd-oneview.net/agent-update

# pd-oneview-agent-update

example delivery project




## start agent bulk upload [/v1/start-upload]

### Post [POST]
+ Request

    + Headers

            Authorization: bearer token

+ Attributes (StartUploadPayload)

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

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

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

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

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

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

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

## Organisations [/v1/organisations]

### Get list of organisations [GET]
+ Request

    + Headers

            Authorization: bearer token

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

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

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

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

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

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

## `Error` (object)
+ errors (array[error_object], fixed-type)

## StartUploadResponse
+ request_id : `9ca60006-8053-4bea-bfaf-82a9c6da050a` (string) - request id for submitted upload task
+ organisation : `ibexpk` (string) - agent organisation

## StartUploadPayload
+ organisation : `ibexpk` (string) - agent organisation

## GetOrganisationsResponse
+ organisations (array[Organisation], fixed-type)

## Organisation
+ name (string)
+ sheet_id (string)
+ sheet_name (string)
npm package: @one-view/pd-oneview-auth-types
Description: Handle the Auth and ACL for One View
Latest version: 0.0.3


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

# pd-oneview-auth

Handle the Auth and ACL for One View




## exchange [/v1/exchange]

Exchange for a valid JWT token using Cloudflare or Google OpenID token

+ Attributes (ExchangeReply)

### Exchange access token [POST]

+ Request (application/json)

    + Attributes (ExchangeRequest)

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

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

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

## refresh [/v1/refresh]

Get refreshed JWT token using refresh_token

+ Attributes (RefreshReply)

### Refresh access token [POST]

+ Request (application/json)

    + Attributes (RefreshRequest)

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

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

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

# Data Structures

## int64 (number)

## integer (number)

## float (number)

## date (string)

## errorObject (object)
+ status (string)
+ title (string)

## Error (object)
+ errors (array[errorObject])

## ExchangeRequest
+ token : `openid.ajskjea` (string)
+ idp: `cloudflare` (string)

## ExchangeReply
+ jwt : `jwt.token.here` (string)
+ refresh_token : `jwt.refresh.token` (string)

## RefreshRequest
+ token : `jwt.refresh.token` (string)
+ idp: `cloudflare` (string)

## RefreshReply
+ jwt : `jwt.token.here` (string)
+ refresh_token : `jwt.refresh.token` (string)
npm package: @one-view/pd-oneview-courier-location-types
Description: backend for oneview pd-oneview-courier-location-view plugin
Latest version: 0.0.10


FORMAT: 1A
VERSION: 1.0.0
HOST: https://api.pd-oneview.net/courier-location

# pd-oneview-courier-location

backend for oneview pd-oneview-courier-location-view plugin




## Delivery Locations [/v1/{orderCode}/locations{?gid}]

Delivery location information

+ Parameters
    + orderCode (required, string, `vsba-nhas`)
    + gid (string, optional) - global entity id
        + Default: `FP_SG`

+ Attributes (DeliveryLocations)

### Get Delivery Locations Information [GET]

+ Request

    + Headers

            Authorization: bearer token
            X-Contact-Id: case-id

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

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

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

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

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

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

## `error_object` (object)
+ status (string) - HTTP status code for this problem, expressed as a string value
+ title (string) - short, human-readable unique summary of the problem (not localized)

## `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)

## Location
+ latitude : 70.4 (number, required) - location latitude
+ longitude : 10.312 (number, required) - location longitude
+ label : `pickup` (string) - location label. might contains timestamp or location event name

## DeliveryLocations
+ pickup           (Location, required) - order pickup location
+ dropOff          (Location, required) - order drop off location
+ courierLocations        (array[Location]) - courier locations
npm package: @one-view/pd-oneview-cs-agent-types
Description: example delivery project
Latest version: 0.0.8


FORMAT: 1A
HOST: https://api.pd-oneview.net/cs-agent

# pd-oneview-cs-agent

example delivery project




## Agent profile [/v1/profile]

Agent profile data for language

### Get [GET]
+ Request

    + Headers

            Authorization: bearer token

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

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

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

## Update agent language [/v1/update-language]

### Post [POST]
+ Request

    + Headers

            Authorization: bearer token

+ Attributes (UpdateLanguage)

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

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

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

## int64 (number)

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

## `Error` (object)
+ errors (array[error_object], fixed-type)

## AgentProfile
+ language          : `en` (string) - agent preferred language
+ id                : `f4b8f8e5-365a-4ed1-a122-0f4ba1afef44` (string, required) - agent id
+ email             : `agent@fooodpanda.com` - agent email
+ name              : `somename` (string) - agent name
+ displayName       : `john doe` (string) - agent display name
+ organisation      : `ssc` (string) - agent organisation

## UpdateLanguage
+ language : `en` (string) - agent preferred language
npm package: @one-view/pd-oneview-order-panel-types
Description: backend for order panel plugin
Latest version: 0.0.5


FORMAT: 1A
VERSION: 1.0.0
HOST: https://api.pd-oneview.net/order-panel

# pd-oneview-order-panel
backend for order panel plugin




## Order List [/v1/orders{?page,perPage,orderBy,GID,filterKey,filterValue}]

get list of order based on specific parameter

+ Parameters
    + page (integer, optional) - order of page
        + Default: 1
    + perPage (integer, optional) - number of record of page
        + Default: 10
    + orderBy (string, optional) - order record based on selected criteria
        + Default: `timestamp-desc`
    + GID (string, optional) - global entity id
        + Default: `FP_SG`
    + filterKey (string, optional) - filter key used for filtering
    + filterValue (string, optional) - filter value used for filter key

+ Attributes (OrderList)

### Get order list [GET]
+ Request

    + Headers

            Authorization: bearer token
            X-Contact-Id: case-id

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

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

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

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

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


# Data Structures

## int8 (number)
## int64 (number)
## integer (number)
## float (number)
## date (string)

## `Error` (object)
+ errorCode    (int64)
+ errorMessage (string)

## `Error_401` (object)
+ errorCode : 401 (int64)
+ errorMessage : `not authorize` (string)

## `Error_404` (object)
+ errorCode : 404 (int64)
+ errorMessage : `not found` (string)

## `Error_403` (object)
+ errorCode : 403 (int64)
+ errorMessage : `forbidden` (string)

## `Error_400` (object)
+ errorCode : 400 (int64)
+ errorMessage : `bad request` (string)

## `Error_500` (object)
+ errorCode : 500 (int64)
+ errorMessage : `internal server error` (string)

## OrderListEntry
+ code          : `anba-ejsk` (string) - order code
+ itemCount     : 3 (int64) - number of items in the order
+ timestamp     : 1572499999 (int64) - epoch timestamp the order was created
+ amount        : 18.50 (number) - order price
+ status        : `ACTIVE` (string) - order status
+ currency      : `sgd` (string) - currency
## OrderList
+ list (array[OrderListEntry])
npm package: @one-view/pd-oneview-order-status-history-types
Description: backend for oneview order-status-history plugin
Latest version: 0.0.5


FORMAT: 1A
VERSION: 1.0.0
HOST: https://api.pd-oneview.net/order-status-history

# pd-oneview-order-status-history

backend for oneview order-status-history plugin




## Delivery Status histories [/v1/{orderCode}/histories{?region}]

Delivery status histories information

+ Parameters
    + orderCode (required, string, `vsba-nhas`)
    + region (string, optional)
        + Default: `FP_SG`


+ Attributes (DeliveryStatusHistories)

### Get delivery histories [GET]

+ Request

    + Headers

            Authorization: bearer token
            X-Contact-Id: case-id

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

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

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

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

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

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

## `Error` (object)
+ errorCode : 401 (int64)
+ errorMessage : `not authorize` (string)

## `Error_401` (object)
+ errorCode : 401 (int64)
+ errorMessage : `not authorize` (string)

## `Error_404` (object)
+ errorCode : 404 (int64)
+ errorMessage : `not found` (string)

## `Error_403` (object)
+ errorCode : 403 (int64)
+ errorMessage : `forbidden` (string)

## `Error_400` (object)
+ errorCode : 400 (int64)
+ errorMessage : `bad request` (string)

## `Error_500` (object)
+ errorCode : 500 (int64)
+ errorMessage : `internal server error` (string)

## DeliveryStatusHistories
+ histories (array[DeliveryStatus])

## DeliveryStatus
+ name              : `DELIVERED` (string, required) - status name
+ timestamp         : 1572499999 (int64) - status timestamp
+ isComplete        : false (boolean) - is this status already complete or not
+ description       : `Just Now` (string, required) - status description