Client Frontend — Auto-generated Reference (`client-alta`)

This page is auto-generated from the Vue 3 source code by scripts/generate-frontend-docs.js. Do not edit the content between the AUTO markers by hand — run npm run generate-frontend-docs instead.

Last generated: 2026-07-01T14:07:11.055Z

Application Architecture

Views (pages)

views/
  Account.vue
  AccountSetup.vue
  Base.vue
  Downloads.vue
  Feedback.vue
  GetStarted.vue
  Home.vue
  Login.vue
  NotFound.vue
  Onboarding.vue
  PasswordReset.vue
  PrivacyPolicy.vue
  dashboard/Abtests.vue
  dashboard/AbtestsRequest.vue
  dashboard/Base.vue
  dashboard/GroupManage.vue
  dashboard/Home.vue
  dashboard/Issues.vue
  dashboard/Labels.vue
  dashboard/Machines.vue
  dashboard/OutdatedMachines.vue
  dashboard/Users.vue
  help/Api.vue
  help/Base.vue
  help/Docs.vue
  help/DocsWeb.vue
  help/Faq.vue
  help/Home.vue
  help/Setup.vue
  help/SoftwareOverview.vue
  organization/Accounts.vue
  organization/Base.vue
  organization/Groups.vue
  organization/Settings.vue

Routes

Path	Name	Auth required	Component
`/`	—	—	`views/Home.vue`
`/login`	login	—	`views/Login.vue`
`/password-reset`	password-reset	—	`views/PasswordReset.vue`
`/account-setup`	AccountSetup	No	`views/AccountSetup.vue`
`/account`	account	Yes	`views/Account.vue`
`/onboarding`	—	Yes	`views/Onboarding.vue`
`/dashboard`	—	Yes	`views/dashboard/Base.vue`
`users`	—	—	—
`/dashboard/group/:group?`	—	Yes	`views/dashboard/Base.vue`
`/`	dashboard	—	`views/dashboard/Home.vue`
`manage`	dashboard.group	—	`views/dashboard/GroupManage.vue`
`users`	dashboard.users	—	`views/dashboard/Users.vue`
`labels`	dashboard.labels	—	`views/dashboard/Labels.vue`
`users/:id`	dashboard.users.detail	—	`views/dashboard/Users.vue`
`machines`	dashboard.machines	—	`views/dashboard/Machines.vue`
`machines/:id`	dashboard.machines.detail	—	`views/dashboard/Machines.vue`
`issues`	dashboard.issues	—	`views/dashboard/Issues.vue`
`outdated-machines`	dashboard.outdated-machines	—	`views/dashboard/OutdatedMachines.vue`
`abtests`	dashboard.abtests	—	`views/dashboard/Abtests.vue`
`abtests/request`	dashboard.requests	—	`views/dashboard/AbtestsRequest.vue`
`abtests/:id/edit`	dashboard.abtests.edit	—	`views/dashboard/AbtestsRequest.vue`
`/help`	—	No	`views/help/Base.vue`
`/`	—	Yes	`views/help/Home.vue`
`docs`	—	Yes	`views/help/Docs.vue`
`docs/web`	—	Yes	`views/help/DocsWeb.vue`
`faq`	—	Yes	`views/help/Faq.vue`
`setup`	—	No	`views/help/Setup.vue`
`software-overview`	—	No	`views/help/SoftwareOverview.vue`
`api`	—	No	`views/help/Api.vue`
`/organization`	—	Yes	`views/organization/Base.vue`
`/`	—	—	—
`settings`	—	—	`views/organization/Settings.vue`
`accounts`	—	—	`views/organization/Accounts.vue`
`groups`	—	—	`views/organization/Groups.vue`
`/downloads`	—	Yes	`views/Downloads.vue`
`/privacy`	—	Yes	`views/PrivacyPolicy.vue`
`/get-started`	—	No	`views/GetStarted.vue`
`/feedback`	—	Yes	`views/Feedback.vue`
`/:pathMatch(.)`	NotFound	No	`views/NotFound.vue`

Vuex Store — State

Top-level reactive state keys managed by Vuex 4:

currentLanguage
helpScoutBeaconId
apiUrl
authenticated
supportEmail
auth
user
impersonation
groups
selectedGroup
selectedGroupId
version
organization
downloadsUrl

Components Reference

`AbtestCard`

Props

Prop	Type	Required	Default	Description
`test`	undefined	No	—	—

Events

Event	Description
`refresh`	—

Slots

None.

`AbtestForm`

Props

Prop	Type	Required	Default	Description
`obj`	—	No	—	—
`group`	—	Yes	—	—

Events

Event	Description
`save`	—

Slots

None.

`ApiForm`

Rôle : Composant de formulaire générique pour créer/mettre à jour des ressources via l'API.

Fonctionnalités :

Gestion de l'état de chargement
Affichage des erreurs de validation backend
Slots personnalisables pour l'en-tête, le corps du formulaire et les boutons
Préparation des données avant envoi (prepareSave)
Réinitialisation du formulaire après sauvegarde

Routes API appelées :

POST {endpoint} : Création d'une nouvelle ressource
PATCH/PUT {endpoint}/{id} : Mise à jour d'une ressource existante

Props

Prop	Type	Required	Default	Description
`endpoint`	—	Yes	—	—
`idField`	string	No	`'id'`	—
`obj`	—	No	—	—
`additionalData`	func	No	`() => {return {}}`	—
`defaultData`	func	No	`() => {return {}}`	—
`updateMethod`	string	No	`"patch"`	—
`createMethod`	string	No	`"post"`	—
`showSuccessMessage`	boolean	No	`true`	—
`resetOnSave`	boolean	No	`false`	—
`prepareSave`	func	No	`() => {return (d) => {return d}}`	—
`submitProps`	func	No	`() => {return {}}`	—
`responseAttr`	string	No	`null`	—

Events

Event	Description
`save`	—

Slots

Slot	Description
`header`	—
`success-message`	—
`form-body`	—
`form-controls-before`	—
`form-submit`	—
`form-controls-after`	—

`AppButton`

Props

Prop	Type	Required	Default	Description
`isLoading`	boolean	No	`false`	—

Events

None.

Slots

Slot	Description
`default`	—

`AppFooter`

Props

None.

Events

None.

Slots

None.

`AppIcon`

Props

Prop	Type	Required	Default	Description
`name`	string	No	—	—
`size`	string	No	—	—
`color`	string	No	—	—
`title`	string	No	—	—
`desc`	string	No	—	—

Events

None.

Slots

None.

`AppMenu`

Props

None.

Events

None.

Slots

None.

`AppModal`

Props

Prop	Type	Required	Default	Description
`submitAction`	—	No	—	—
`validateAction`	—	No	—	—

Events

Event	Description
`close`	—

Slots

Slot	Description
`header`	—
`default`	—
`footer`	—
`action-button`	—

`AudioInfo`

Props

None.

Events

None.

Slots

None.

`CaptionedImage`

Props

Prop	Type	Required	Default	Description
`url`	undefined	No	—	—
`alt`	undefined	No	—	—

Events

None.

Slots

Slot	Description
`default`	—

`DataTable`

Props

Prop	Type	Required	Default	Description
`tableProps`	object	No	`{ itemsPerPage: 0, isPaginated: false, isSelectable: false, rowActions: [], hasGlobalSearch: false }`	—
`model`	array	Yes	—	—
`columnDefs`	array	Yes	—	—

Events

None.

Slots

None.

`DeviceInfo`

Props

Prop	Type	Required	Default	Description
`machine`	undefined	No	—	—
`hide`	undefined	No	—	—

Events

None.

Slots

None.

`DownloadLink`

Props

Prop	Type	Required	Default	Description
`apiUrl`	undefined	No	—	—
`filename`	undefined	No	—	—

Events

None.

Slots

Slot	Description
`default`	—

`EmptyState`

Props

None.

Events

None.

Slots

Slot	Description
`default`	—
`controls`	—

`FieldErrors`

Props

Prop	Type	Required	Default	Description
`errors`	object	No	`{}`	—
`field`	string	No	`null`	—

Events

None.

Slots

None.

`ImpersonateWidget`

Props

None.

Events

None.

Slots

None.

`IssueMessage`

Props

Prop	Type	Required	Default	Description
`issue`	undefined	No	—	—

Events

None.

Slots

None.

`ListField`

Props

Prop	Type	Required	Default	Description
`modelValue`	—	No	—	—
`type`	string	No	`'text'`	—
`delimiters`	func	No	`() => {return /,\| /;}`	—

Events

Event	Description
`update:modelValue`	—

Slots

None.

`LoadingArea`

Rôle : Composant de chargement générique pour afficher un indicateur de progression et potentiellement charger des données depuis l'API.

Fonctionnalités :

Affichage d'un indicateur de chargement (icône tournante)
Gestion des erreurs de chargement
Événements déclenchés au début et à la fin du chargement

Routes API appelées :

GET {apiUrl} : Chargement de données depuis l'API (optionnel)

Props

Prop	Type	Required	Default	Description
`isLoading`	boolean	No	`false`	—
`showErrors`	boolean	No	`true`	—
`apiUrl`	string	No	`null`	—
`apiParams`	func	No	`() => {return {}}`	—

Events

Event	Description
`loading`	—
`loaded`	—
`error`	—

Slots

Slot	Description
`default`	—

`Logo`

Props

None.

Events

None.

Slots

None.

`MachineRow`

Props

Prop	Type	Required	Default	Description
`obj`	—	No	—	—
`meta`	—	No	—	—
`expand`	boolean	No	`false`	—

Events

Event	Description
`expanded`	—
`filter`	—
`updated`	—

Slots

None.

`Pagination`

Props

Prop	Type	Required	Default	Description
`current`	number	No	`1`	—
`paginateBy`	number	No	`25`	—
`total`	number	Yes	—	—
`compact`	boolean	No	`false`	—

Events

Event	Description
`page-changed`	—

Slots

None.

`SortLink`

Props

Prop	Type	Required	Default	Description
`value`	string	No	—	—
`currentSort`	string	No	—	—

Events

Event	Description
`updated`	—

Slots

Slot	Description
`default`	—

`TOC`

Props

Prop	Type	Required	Default	Description
`contentElement`	undefined	No	—	—
`level`	undefined	No	—	—

Events

None.

Slots

None.

`UserRow`

Props

Prop	Type	Required	Default	Description
`obj`	—	No	—	—
`meta`	—	No	—	—
`expand`	boolean	No	`false`	—

Events

Event	Description
`expanded`	—
`filter`	—
`updated`	—

Slots

Slot	Description
`checkbox`	—

`VersionCard`

Props

Prop	Type	Required	Default	Description
`version`	—	Yes	—	—
`showChanges`	boolean	No	`true`	—

Prop	Type	Required	Default	Description
`group`	—	No	—	—

Events

None.

Slots

None.

`Downloads.vue`

Props

None.

Events

None.

Slots

None.

`Feedback.vue`

Props

None.

Events

None.

Slots

None.

`GetStarted.vue`

Props

None.

Events

None.

Slots

None.

`Home.vue`

Props

None.

Events

None.

Slots

None.

Rôle : Page de connexion permettant aux utilisateurs d'accéder à leur espace client Alta Call.

Fonctionnalités :

Formulaire de connexion avec email et mot de passe
Préremplissage du champ email si fourni en query
Redirection vers la page d'accueil ou la page demandée après connexion réussie
Déconnexion immédiate si prop logout=true

Routes API appelées :

POST api/login : Authentification utilisateur et récupération du token

Props

Prop	Type	Required	Default	Description
`next`	undefined	No	—	—
`logout`	undefined	No	—	—

Events

None.

Slots

None.

`NotFound.vue`

Props

None.

Events

None.

Slots

None.

`Onboarding.vue`

Rôle : Processus d'intégration pour les nouveaux utilisateurs, les guidant à travers les étapes essentielles.

Fonctionnalités :

Étape 1 : Vérification et mise à jour des informations du compte
Étape 2 : Téléchargement et installation du logiciel Alta Call
Étape 3 : Génération et gestion des clés de licence
Étape 4 : Finalisation et accès aux ressources
Sauvegarde de l'état de progression via la query string
Marquage de l'onboarding comme terminé à la fin

Routes API appelées :

PUT api/accounts/{id} : Mise à jour des informations du compte
POST api/license : Génération d'une nouvelle clé de licence
GET api/license : Récupération de la liste des clés de licence

Props

None.

Events

None.

Slots

None.

`PasswordReset.vue`

Props

Prop	Type	Required	Default	Description
`next`	string	No	`''`	—
`logout`	string	No	`''`	—

Events

None.

Slots

None.

`PrivacyPolicy.vue`

Props

None.

Events

None.

Slots

None.

`dashboard/Abtests.vue`

Rôle : Page de gestion des tests A/B, affichant les tests en cours et terminés.

Fonctionnalités :

Liste des tests A/B avec filtre "en cours" / "tous les tests"
Pagination des résultats
Lien vers la page de demande de nouveau test A/B
Actualisation automatique des tests

Routes API appelées :

GET api/abtests : Récupération de la liste des tests A/B avec filtres et pagination

Props

Prop	Type	Required	Default	Description
`id`	—	No	—	—
`group`	—	No	—	—

Events

None.

Slots

None.

`dashboard/AbtestsRequest.vue`

Props

Prop	Type	Required	Default	Description
`id`	—	No	—	—
`group`	—	No	—	—

Events

Event	Description
`update:abtest`	—

Slots

None.

`dashboard/Base.vue`

Props

Prop	Type	Required	Default	Description
`group`	—	No	—	—

Events

None.

Slots

None.

`dashboard/GroupManage.vue`

Props

Prop	Type	Required	Default	Description
`group`	—	Yes	—	—

Events

None.

Slots

None.

`dashboard/Home.vue`

Rôle : Page d'accueil du tableau de bord, affichant les statistiques clés pour le groupe sélectionné.

Fonctionnalités :

Sélecteur de groupe si l'utilisateur appartient à plusieurs groupes
Statistiques des utilisateurs en ligne et avec erreurs
Statistiques des machines en ligne et avec erreurs
Liste des tests A/B en cours
Polling automatique des statistiques toutes les 5 minutes

Routes API appelées :

GET api/users : Récupération des utilisateurs avec filtres
GET api/machines : Récupération des machines avec filtres
GET api/abtests : Récupération des tests A/B en cours
GET api/software-versions : Récupération des versions de logiciel disponibles
GET api/outdated-machine : Récupération des machines avec version obsolète

Props

Prop	Type	Required	Default	Description
`group`	—	No	—	—

Events

None.

Slots

None.

`dashboard/Issues.vue`

Rôle : Page de suivi des problèmes rencontrés sur les machines, avec solutions proposées.

Fonctionnalités :

Filtres multiples : recherche, statut en ligne/hors ligne, version, erreur spécifique, labels, tests A/B, délai
Pagination des résultats
Tri des colonnes
Modal détaillé pour chaque problème avec description, solutions et astuces
Lien direct vers la page de configuration de l'utilisateur/machine concerné
Export CSV des résultats filtrés

Routes API appelées :

GET api/machine-issue : Récupération de la liste des problèmes avec filtres et pagination
GET api/meta : Récupération des métadonnées (versions, erreurs, labels, tests A/B)
GET api/machine-issue/export : Export CSV des problèmes filtrés

Props

Prop	Type	Required	Default	Description
`id`	—	No	—	—
`group`	—	No	—	—

Events

None.

Slots

None.

`dashboard/Labels.vue`

Props

Prop	Type	Required	Default	Description
`group`	—	Yes	—	—

Events

None.

Slots

None.

`dashboard/Machines.vue`

Rôle : Page de gestion des machines, permettant de visualiser, filtrer et consulter les détails des postes de travail.

Fonctionnalités :

Filtres multiples : recherche, statut en ligne/hors ligne, pays, version, erreurs, application connectée
Pagination des résultats
Tri des colonnes
Export CSV des résultats filtrés
Affichage détaillé d'une machine via son ID

Routes API appelées :

GET api/machines : Récupération de la liste des machines avec filtres et pagination
GET api/meta : Récupération des métadonnées (pays, versions, erreurs, applications connectées)
GET api/machines/export : Export CSV des machines filtrées

Props

Prop	Type	Required	Default	Description
`id`	—	No	—	—
`group`	—	No	—	—

Events

None.

Slots

None.

`dashboard/OutdatedMachines.vue`

Props

Prop	Type	Required	Default	Description
`group`	—	Yes	—	—

Events

None.

Slots

None.

`dashboard/Users.vue`

Rôle : Page de gestion des utilisateurs, permettant de visualiser, filtrer et modifier les profils.

Fonctionnalités :

Filtres multiples : recherche, statut en ligne/hors ligne, pays, transformation, erreurs, labels, tests A/B, audio tuné, consentement enregistrement
Pagination des résultats
Tri des colonnes
Actions en masse : appliquer transformation, ajouter/supprimer labels, définir test A/B, verrouiller/déverrouiller UI
Export CSV des résultats filtrés
Mise à jour en temps réel des informations utilisateur

Routes API appelées :

GET api/users-machines : Récupération de la liste des utilisateurs avec filtres et pagination
GET api/meta : Récupération des métadonnées (pays, transformations, labels, tests A/B)
POST api/users/action : Exécution d'actions en masse sur les utilisateurs
GET api/users/export : Export CSV des utilisateurs filtrés

Props

Prop	Type	Required	Default	Description
`id`	—	No	—	—
`group`	—	No	—	—

Events

None.

Slots

None.