# shakirullah41/five9restapiloginsample architecture

> Architecture diagram of the GitHub repository shakirullah41/five9restapiloginsample, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/shakirullah41/five9restapiloginsample
- Repository: https://github.com/shakirullah41/five9restapiloginsample

## Overview

This browser sample demonstrates logging in to the Five9 Freedom REST API, retaining UI parameters and session cookies, requesting metadata or logging out, and displaying service messages. The controller owns the user actions; the REST helper handles API requests and starts the WebSocket after login or metadata retrieval. Source excerpts show these calls, but the page markup is unsampled, so the graph does not detail its layout.

Main entry points: [`js/five9restapi.js`](https://github.com/shakirullah41/five9restapiloginsample/blob/master/js/five9restapi.js) (REST helper), [`js/wschannel.js`](https://github.com/shakirullah41/five9restapiloginsample/blob/master/js/wschannel.js) (WebSocket channel), [`js/apisample-controller.js`](https://github.com/shakirullah41/five9restapiloginsample/blob/master/js/apisample-controller.js) (UI controller), [`js/jquery.cookie.js`](https://github.com/shakirullah41/five9restapiloginsample/blob/master/js/jquery.cookie.js) (Cookie plugin)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_ui["Browser UI"]
  node_controller["UI controller"]
  node_preferences["UI preferences"]
end

subgraph group_session["Session and API"]
  node_rest["REST helper<br/>[five9restapi.js]"]
  node_cookie_plugin["Cookie plugin<br/>[jquery.cookie.js]"]
  node_browser_cookies[("Browser cookies")]
  node_freedom_api["Freedom REST API"]
end

subgraph group_events["Live Events"]
  node_websocket["WebSocket channel<br/>[wschannel.js]"]
  node_freedom_events["Five9 event service"]
  node_message_log["Page message log<br/>[wschannel.js]"]
end

node_user(("User"))

node_user -->|"triggers actions"| node_controller
node_controller -->|"loads and saves"| node_preferences
node_preferences -->|"reads and writes"| node_cookie_plugin
node_controller -->|"requests login, metadata, logout"| node_rest
node_rest -->|"sends API requests"| node_freedom_api
node_rest -->|"sets session cookies"| node_cookie_plugin
node_cookie_plugin -->|"reads and writes"| node_browser_cookies
node_rest -->|"starts channel"| node_websocket
node_websocket -->|"opens connection"| node_freedom_events
node_websocket -->|"displays messages"| node_message_log
node_rest -->|"forwards API responses"| node_websocket

click node_controller "https://github.com/shakirullah41/five9restapiloginsample/blob/master/js/apisample-controller.js"
click node_preferences "https://github.com/shakirullah41/five9restapiloginsample/blob/master/js/apisample-controller.js"
click node_rest "https://github.com/shakirullah41/five9restapiloginsample/blob/master/js/five9restapi.js"
click node_cookie_plugin "https://github.com/shakirullah41/five9restapiloginsample/blob/master/js/jquery.cookie.js"
click node_websocket "https://github.com/shakirullah41/five9restapiloginsample/blob/master/js/wschannel.js"
click node_message_log "https://github.com/shakirullah41/five9restapiloginsample/blob/master/js/wschannel.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_controller,node_preferences,node_user toneBlue
class node_rest,node_cookie_plugin,node_browser_cookies,node_freedom_api toneAmber
class node_websocket,node_freedom_events,node_message_log toneMint
```

## Components

### Browser UI

- [UI controller](https://github.com/shakirullah41/five9restapiloginsample/blob/master/js/apisample-controller.js): `js/apisample-controller.js`
- [UI preferences](https://github.com/shakirullah41/five9restapiloginsample/blob/master/js/apisample-controller.js): `js/apisample-controller.js`

### Session and API

- [REST helper](https://github.com/shakirullah41/five9restapiloginsample/blob/master/js/five9restapi.js): `js/five9restapi.js`
- [Cookie plugin](https://github.com/shakirullah41/five9restapiloginsample/blob/master/js/jquery.cookie.js): `js/jquery.cookie.js`
- **Browser cookies**
- **Freedom REST API**

### Live Events

- [WebSocket channel](https://github.com/shakirullah41/five9restapiloginsample/blob/master/js/wschannel.js): `js/wschannel.js`
- **Five9 event service**
- [Page message log](https://github.com/shakirullah41/five9restapiloginsample/blob/master/js/wschannel.js): `js/wschannel.js`

### Other components

- **User**

## Connections

- User → UI controller: triggers actions (evidence: `js/apisample-controller.js`)
- UI controller → UI preferences: loads and saves (evidence: `js/apisample-controller.js`)
- UI preferences → Cookie plugin: reads and writes (evidence: `js/apisample-controller.js`)
- UI controller → REST helper: requests login, metadata, logout (evidence: `js/apisample-controller.js`)
- REST helper → Freedom REST API: sends API requests (evidence: `js/five9restapi.js`)
- REST helper → Cookie plugin: sets session cookies (evidence: `js/five9restapi.js`)
- Cookie plugin → Browser cookies: reads and writes (evidence: `js/jquery.cookie.js`)
- REST helper → WebSocket channel: starts channel (evidence: `js/five9restapi.js`)
- WebSocket channel → Five9 event service: opens connection (evidence: `js/wschannel.js`)
- WebSocket channel → Page message log: displays messages (evidence: `js/wschannel.js`)
- REST helper → WebSocket channel: forwards API responses (evidence: `js/five9restapi.js`)
