@stack-spot/portal-network 0.43.0 → 0.45.0

package/src/api/workspaceManager.ts

@@ -8,11 +8,29 @@ import * as Oazapfts from "@oazapfts/runtime";
 import * as QS from "@oazapfts/runtime/query";
 export const defaults: Oazapfts.Defaults<Oazapfts.CustomHeaders> = {
     headers: {},
-    baseUrl: "https://workspace-workspace-manager.stg.stackspot.com",
+    baseUrl: "https://workspace-workspace-manager.dev.stackspot.com",
 };
 const oazapfts = Oazapfts.runtime(defaults);
 export const servers = {
-    generatedServerUrl: "https://workspace-workspace-manager.stg.stackspot.com"
+    generatedServerUrl: "https://workspace-workspace-manager.dev.stackspot.com"
+};
+export type WorkspaceVariableResponse = {
+    /** Workspace variable name. */
+    name: string;
+    /** Workspace variable value. */
+    value?: string;
+    /** Workspace variable description. */
+    description: string;
+    /** Workspace variable mandate flag. */
+    mandate: boolean;
+    /** Variable value source. */
+    source: string;
+    /** Workspace variable creation data */
+    createdAt: string;
+};
+export type UpsertWorkspaceVariableRequest = {
+    /** Workspace variable value. */
+    value: string;
 };
 export type ExternalItemsResponse = {
     source: string;
@@ -211,6 +229,26 @@ export type WorkflowActionsRequest = {
     actionsBefore: WorkflowActionSimpleRequest[];
     actionsAfter: WorkflowActionSimpleRequest[];
 };
+export type AccountVariableResponse = {
+    /** Account variable name */
+    name: string;
+    /** Account variable value stored */
+    value?: string;
+    /** Account variable description */
+    description: string;
+    /** Account variable mandatory flag */
+    mandate: boolean;
+    /** Account variable creation data */
+    createdAt: string;
+};
+export type UpdateAccountVariableRequest = {
+    /** New account variable value */
+    value?: string;
+    /** New account variable description */
+    description: string;
+    /** New account variable mandatory flag */
+    mandate: boolean;
+};
 export type RequiresRequest = {
     /** Connections requires name. */
     selected: string;
@@ -428,6 +466,28 @@ export type AccountWorkflowCreateRequest = {
 export type IdResponseString = {
     id: string;
 };
+export type PaginatedAccountVariableResponse = {
+    /** Current page requested */
+    currentPage: number;
+    /** Last page available */
+    lastPage: number;
+    /** Page size requested */
+    pageSize: number;
+    /** Total items found */
+    totalItems: number;
+    /** Account variables for current page */
+    items: AccountVariableResponse[];
+};
+export type CreateAccountVariableRequest = {
+    /** Account variable name */
+    name: string;
+    /** Account variable value */
+    value?: string;
+    /** Account variable description */
+    description: string;
+    /** Account variable mandatory flag */
+    mandate: boolean;
+};
 export type ManagerRunResponse = {
     environmentName?: string;
     runId: string;
@@ -671,6 +731,23 @@ export type FullInputContextResponse = {
     computedInputs: ComputedInputResponse[];
     globalComputedInputs: ComputedInputResponse[];
 };
+export type WorkspaceResponse = {
+    /** Workspace id. */
+    id: string;
+    /** Workspace name */
+    name: string;
+    /** Workspace description */
+    description?: string;
+    /** Workspace image */
+    imageUrl?: string;
+};
+export type WorkspacePageResponse = {
+    currentPage: number;
+    pageSize: number;
+    lastPage: number;
+    totalItems: number;
+    items: WorkspaceResponse[];
+};
 export type SimpleStackWithImageResponse = {
     stackId: string;
     name: string;
@@ -678,6 +755,13 @@ export type SimpleStackWithImageResponse = {
     imageUrl?: string;
     studio: StudioResponse;
 };
+export type PaginatedWorkspaceVariableResponse = {
+    currentPage: number;
+    pageSize: number;
+    lastPage: number;
+    totalItems: number;
+    items: WorkspaceVariableResponse[];
+};
 export type WorkflowCompleteResponse = {
     workflowId: string;
     name: string;
@@ -893,6 +977,14 @@ export type StackActionInputValuesByEnvInAccountContextResponse = {
     input?: object;
     inputs: object[];
 };
+export type AccountVariableUsageResponse = {
+    /** How many plugins are using this account variable */
+    pluginsInUse: number;
+    /** How many actions are using this account variable */
+    actionsInUse: number;
+    /** How many contexts are using this account variable */
+    contextsInUse: number;
+};
 export type StackResponse = {
     stackId: string;
     slug: string;
@@ -952,6 +1044,32 @@ export type AccountContextStackResponse = {
     hasVersionsWithContext: boolean;
     versions: StackVersionWksResponse[];
 };
+export function workspaceVariableControllerV2FindByName({ accountId, workspaceId, name }: {
+    accountId?: string;
+    workspaceId: string;
+    name: string;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: WorkspaceVariableResponse;
+    }>(`/v1/workspaces/${encodeURIComponent(workspaceId)}/variables/${encodeURIComponent(name)}`, {
+        ...opts,
+        headers: oazapfts.mergeHeaders(opts?.headers, {
+            accountId
+        })
+    }));
+}
+export function workspaceVariableControllerV2Upsert({ workspaceId, name, upsertWorkspaceVariableRequest }: {
+    workspaceId: string;
+    name: string;
+    upsertWorkspaceVariableRequest: UpsertWorkspaceVariableRequest;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchText(`/v1/workspaces/${encodeURIComponent(workspaceId)}/variables/${encodeURIComponent(name)}`, oazapfts.json({
+        ...opts,
+        method: "PUT",
+        body: upsertWorkspaceVariableRequest
+    })));
+}
 export function workflowWorkspaceControllerfindWorkflowStackContext({ workspaceId, stackId, workflowId }: {
     workspaceId: string;
     stackId: string;
@@ -1132,6 +1250,38 @@ export function workflowAccountControllerupdateWorkflowActions({ workflowId, wor
         body: workflowActionsRequest
     })));
 }
+export function accountVariableControllerfindByName({ accountId, name }: {
+    accountId?: string;
+    name: string;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: AccountVariableResponse;
+    }>(`/v1/account/variables/${encodeURIComponent(name)}`, {
+        ...opts,
+        headers: oazapfts.mergeHeaders(opts?.headers, {
+            accountId
+        })
+    }));
+}
+export function accountVariableControllerupdate({ name, updateAccountVariableRequest }: {
+    name: string;
+    updateAccountVariableRequest: UpdateAccountVariableRequest;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchText(`/v1/account/variables/${encodeURIComponent(name)}`, oazapfts.json({
+        ...opts,
+        method: "PUT",
+        body: updateAccountVariableRequest
+    })));
+}
+export function accountVariableControllerdelete({ name }: {
+    name: string;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchText(`/v1/account/variables/${encodeURIComponent(name)}`, {
+        ...opts,
+        method: "DELETE"
+    }));
+}
 export function workflowStackControllerfindWorkflowStackContext({ stackId, workflowId }: {
     stackId: string;
     workflowId: string;
@@ -1200,19 +1350,6 @@ export function workspaceStackControlleraddStacksInWorkspace({ workspaceId, addS
         body: addStackInWorkspaceRequest
     })));
 }
-export function sharedInfraControllercreateSharedInfra({ workspaceId, createSharedRequest }: {
-    workspaceId: string;
-    createSharedRequest: CreateSharedRequest;
-}, opts?: Oazapfts.RequestOpts) {
-    return oazapfts.ok(oazapfts.fetchJson<{
-        status: 200;
-        data: CreateShareInfraResponse;
-    }>(`/v1/workspaces/${encodeURIComponent(workspaceId)}/shared-infra`, oazapfts.json({
-        ...opts,
-        method: "POST",
-        body: createSharedRequest
-    })));
-}
 export function connectionInterfaceControllercreateConnectionInterface({ workspaceId, createConnectionInterfaceRequest }: {
     workspaceId: string;
     createConnectionInterfaceRequest: CreateConnectionInterfaceRequest;
@@ -1226,19 +1363,6 @@ export function connectionInterfaceControllercreateConnectionInterface({ workspa
         body: createConnectionInterfaceRequest
     })));
 }
-export function applicationControllercreateApp({ workspaceId, createAppRequest }: {
-    workspaceId: string;
-    createAppRequest: CreateAppRequest;
-}, opts?: Oazapfts.RequestOpts) {
-    return oazapfts.ok(oazapfts.fetchJson<{
-        status: 200;
-        data: CreateApplicationResponse;
-    }>(`/v1/workspaces/${encodeURIComponent(workspaceId)}/applications`, oazapfts.json({
-        ...opts,
-        method: "POST",
-        body: createAppRequest
-    })));
-}
 export function contextControllerimportContextInWorkspace({ workspaceId, body }: {
     workspaceId: string;
     body: ImportContextRequest[];
@@ -1270,6 +1394,39 @@ export function workflowAccountControllercreateAccountWorkflow({ accountWorkflow
         body: accountWorkflowCreateRequest
     })));
 }
+export function accountVariableControllerfindAll({ accountId, name, page, size, sortBy, sortDir }: {
+    accountId?: string;
+    name?: string;
+    page?: number;
+    size?: number;
+    sortBy?: "NAME" | "VALUE" | "CREATED_AT";
+    sortDir?: "ASC" | "DESC";
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: PaginatedAccountVariableResponse;
+    }>(`/v1/account/variables${QS.query(QS.explode({
+        name,
+        page,
+        size,
+        sortBy,
+        sortDir
+    }))}`, {
+        ...opts,
+        headers: oazapfts.mergeHeaders(opts?.headers, {
+            accountId
+        })
+    }));
+}
+export function accountVariableControllercreate({ createAccountVariableRequest }: {
+    createAccountVariableRequest: CreateAccountVariableRequest;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchText("/v1/account/variables", oazapfts.json({
+        ...opts,
+        method: "POST",
+        body: createAccountVariableRequest
+    })));
+}
 export function managerRunControllerarchiveApplication({ workspaceId, applicationId }: {
     workspaceId: string;
     applicationId: string;
@@ -1368,7 +1525,7 @@ export function contextStackControllergetWorkspaceContext({ workspaceId, stackVe
         ...opts
     }));
 }
-export function contextgetConsolidatedPluginInputsWithConnectionInterfaces({ workspaceId, stackVersionId, pluginVersionId }: {
+export function contextPluginControllergetConsolidatedPluginInputsWithConnectionInterfaces({ workspaceId, stackVersionId, pluginVersionId }: {
     workspaceId: string;
     stackVersionId: string;
     pluginVersionId: string;
@@ -1380,7 +1537,7 @@ export function contextgetConsolidatedPluginInputsWithConnectionInterfaces({ wor
         ...opts
     }));
 }
-export function contextgetConsolidatedPluginInputs({ workspaceId, stackVersionId, pluginVersionId, envName }: {
+export function contextPluginControllergetConsolidatedPluginInputs({ workspaceId, stackVersionId, pluginVersionId, envName }: {
     workspaceId: string;
     stackVersionId: string;
     pluginVersionId: string;
@@ -1410,7 +1567,7 @@ export function contextActionControllergetStackActionInputsInWorkspaceContext({
         ...opts
     }));
 }
-export function contextgetAccountPluginInputs({ stackVersionId, pluginVersionId, envName }: {
+export function contextPluginControllergetAccountPluginInputs({ stackVersionId, pluginVersionId, envName }: {
     stackVersionId: string;
     pluginVersionId: string;
     envName?: string;
@@ -1438,6 +1595,32 @@ export function contextActionControllergetStackActionInputsInAccountContext({ st
         ...opts
     }));
 }
+export function workspaceControllergetWorkspaces({ name, aclOnly, accountId, page, size, sortBy, sortDir }: {
+    name?: string;
+    aclOnly?: boolean;
+    accountId?: string;
+    page?: number;
+    size?: number;
+    sortBy?: "NAME" | "DESCRIPTION";
+    sortDir?: "ASC" | "DESC";
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: WorkspacePageResponse;
+    }>(`/v1/workspaces${QS.query(QS.explode({
+        name,
+        aclOnly,
+        page,
+        size,
+        sortBy,
+        sortDir
+    }))}`, {
+        ...opts,
+        headers: oazapfts.mergeHeaders(opts?.headers, {
+            accountId
+        })
+    }));
+}
 export function workflowWorkspaceControllerlistStacks({ workspaceId, workflowId }: {
     workspaceId: string;
     workflowId: string;
@@ -1449,6 +1632,35 @@ export function workflowWorkspaceControllerlistStacks({ workspaceId, workflowId
         ...opts
     }));
 }
+export function workspaceVariableControllerV2FindAll({ workspaceId, accountId, page, size, sortBy, sortDir, mandate, name, showEmptyValues }: {
+    workspaceId: string;
+    accountId?: string;
+    page?: number;
+    size?: number;
+    sortBy?: "NAME" | "VALUE" | "CREATED_AT";
+    sortDir?: "ASC" | "DESC";
+    mandate?: boolean;
+    name?: string;
+    showEmptyValues?: boolean;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: PaginatedWorkspaceVariableResponse;
+    }>(`/v1/workspaces/${encodeURIComponent(workspaceId)}/variables${QS.query(QS.explode({
+        page,
+        size,
+        sortBy,
+        sortDir,
+        mandate,
+        name,
+        showEmptyValues
+    }))}`, {
+        ...opts,
+        headers: oazapfts.mergeHeaders(opts?.headers, {
+            accountId
+        })
+    }));
+}
 export function workflowWorkspaceControllerlistWorkflowByStackIdAndWorkflowType({ workspaceId, stackId, workflowType }: {
     workspaceId: string;
     stackId: string;
@@ -1617,6 +1829,20 @@ export function contextControllergetStackActionInputsInAccountContext({ stackVer
         ...opts
     }));
 }
+export function accountVariableControllerusage({ accountId, name }: {
+    accountId?: string;
+    name: string;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: AccountVariableUsageResponse;
+    }>(`/v1/account/variables/${encodeURIComponent(name)}/usage`, {
+        ...opts,
+        headers: oazapfts.mergeHeaders(opts?.headers, {
+            accountId
+        })
+    }));
+}
 export function accountStackControllerlistStacksByAccountWithWorkflow({ workspaceId }: {
     workspaceId?: string;
 }, opts?: Oazapfts.RequestOpts) {

package/src/client/content.ts

@@ -1,19 +1,21 @@
 import { HttpError } from '@oazapfts/runtime'
-import { addAction, addLink, addWorkspace, associateActionToPlugin, changeVisibility, createStudio, defaults, 
+import {
+  addAction, addLink, addWorkspace, associateActionToPlugin, changeVisibility, createStudio, defaults,
   deleteAction, deleteActionVersion, deleteLink, deletePluginVersion, deleteStudio, deleteV1StacksVersionsByStackVersionId,
-  delWorkspace, deprecateActionVersion, deprecatePluginVersion, deprecateStackVersionBy, downloadAction, getActionBySlug, 
-  getActionsVersions, getActionVersionById, getAllActionVersions, getApplicationDetailsView, getApplicationsUsesPlugin, 
-  getAvailableActionVersionsByActionSlug, getDependentPluginsVersions, 
-  getGetPluginView, getInfrastructureEnvironmentsUsesPlugin, 
-  getListOfInputs, getPluginInfrastructureView, getPluginModalView, getPluginVersions, getPluginVersionsNotInUse, 
+  delWorkspace, deprecateActionVersion, deprecatePluginVersion, deprecateStackVersionBy, downloadAction, getActionBySlug,
+  getActionsVersions, getActionVersionById, getAllActionVersions, getApplicationDetailsView, getApplicationsUsesPlugin,
+  getAvailableActionVersionsByActionSlug, getDependentPluginsVersions,
+  getGetPluginView, getInfrastructureEnvironmentsUsesPlugin,
+  getListOfInputs, getPluginInfrastructureView, getPluginModalView, getPluginVersions, getPluginVersionsNotInUse,
   getPluginVersionUsageSummary, getStackUsesPlugin, getStackVersionById, getStackVersionListByIds, getStackWorkspaceDetailView,
-  getStackWorkspaces, getStarterStackVersionsAndPluginsVersions, getStarterUsesPlugin, getStudioByIdOrSlug, getStudios1, 
-  getStudiosToCreateButton, getStudioTabs, getUnusedStackVersions, getWorkflow, getWorkflowByStudioSlug, getWorkflowDoc, 
-  listActions, listActions1, 
+  getStackWorkspaces, getStarterStackVersionsAndPluginsVersions, getStarterUsesPlugin, getStudioByIdOrSlug, getStudios, getStudios1,
+  getStudiosToCreateButton, getStudioTabs, getUnusedStackVersions, getWorkflow, getWorkflowByStudioSlug, getWorkflowDoc,
+  listActions, listActions1,
   listActionsByFilters1, listConnectionInterfaceTypes, listLinksByStackVersion, listPlugins, listPluginVersionByIdsController,
-  listReasons, listStacksByFilters, listStarters, listWorkflowVersion, 
+  listReasons, listStacksByFilters, listStarters, listWorkflowVersion,
   listWorkspaces, patchStarterV2, removeActionFromPlugin, stackModalViewSummary,
-  stackVersionUsageSummary, updateStudio, updateStudioTabs } from '../api/content'
+  stackVersionUsageSummary, updateStudio, updateStudioTabs,
+} from '../api/content'
 import apis from '../apis.json'
 import { DefaultAPIError } from '../error/DefaultAPIError'
 import { cntDictionary } from '../error/dictionary/cnt'
@@ -50,6 +52,10 @@ class ContentClient extends ReactQueryNetworkClient {
    * Gets all studios
    */
   studios = this.query(removeAuthorizationParam(getStudios1))
+  /**
+   * Gets all studios
+   */
+  studiosWithPagination = this.query(removeAuthorizationParam(getStudios))
   /**
    * Gets all studios
    */
@@ -102,7 +108,7 @@ class ContentClient extends ReactQueryNetworkClient {
    * Gets stacks from a given studio
    */
   stacksFromStudios = this.query(listStacksByFilters)
-  
+
   //Workflow
   /**
    * Gets workflows from a given studio
@@ -283,7 +289,7 @@ class ContentClient extends ReactQueryNetworkClient {
   /**
    * Gets the inputs of a specific Action. This fn is only used for permission purposes.
    */
-  actionInputs = this.query(getListOfInputs) as 
+  actionInputs = this.query(getListOfInputs) as
     OperationObject<Parameters<typeof getListOfInputs>[0]>
   /**
    * Gets action versions by ids

package/src/client/workspace-manager.ts

@@ -10,9 +10,9 @@ import {
   contextControllerupsertPluginAccountContext,
   contextControllerupsertPluginWorkspaceContext,
   contextControllerupsertWorkspaceActionsInputContext,
-  contextgetAccountPluginInputs,
-  contextgetConsolidatedPluginInputs,
-  contextgetConsolidatedPluginInputsWithConnectionInterfaces,
+  contextPluginControllergetAccountPluginInputs,
+  contextPluginControllergetConsolidatedPluginInputs,
+  contextPluginControllergetConsolidatedPluginInputsWithConnectionInterfaces,
   defaults,
   managerRunControllerdeleteApplication,
   managerRunControllerdeleteSharedInfra,
@@ -21,6 +21,7 @@ import {
   sharedInfraControllergetSharedInfraAppliedPlugins,
   workflowWorkspaceControllerlistWorkflowByStackIdAndWorkflowType,
   workspaceControllerdelete,
+  workspaceControllergetWorkspaces,
   workspaceStackControlleraddStacksInWorkspace,
   workspaceStackControllerdeleteStacksInWorkspace,
   workspaceStackControllerlistStacks,
@@ -91,11 +92,11 @@ class WorkspaceManagerClient extends ReactQueryNetworkClient {
    */
   pluginInputsInWorkspace = this.query({
     name: 'pluginInputsInWorkspace',
-    request: async (signal, variables: Parameters<typeof contextgetConsolidatedPluginInputs>[0]) => {
-      const data = await contextgetConsolidatedPluginInputs(variables, { signal })
+    request: async (signal, variables: Parameters<typeof contextPluginControllergetConsolidatedPluginInputs>[0]) => {
+      const data = await contextPluginControllergetConsolidatedPluginInputs(variables, { signal })
       return data as FixedFullInputContextResponse
     },
-    permission: async ({ workspaceId, stackVersionId }: Parameters<typeof contextgetConsolidatedPluginInputs>[0]) => {
+    permission: async ({ workspaceId, stackVersionId }: Parameters<typeof contextPluginControllergetConsolidatedPluginInputs>[0]) => {
       const canViewContext = await workspaceClient.listConsolidatedWorkspaceContext.isAllowed({ $type: 'plugin', workspaceId, stackVersionId })
       const canGetConnectionInterfaceTypes = await contentClient.connectionInterfaceTypes.isAllowed()
       const canGetPluginVersions = await contentClient.pluginVersionsByIds.isAllowed({})
@@ -107,11 +108,11 @@ class WorkspaceManagerClient extends ReactQueryNetworkClient {
    */
   pluginInputsAccount = this.query({
     name: 'pluginInputsAccount',
-    request: async (signal, variables: Parameters<typeof contextgetAccountPluginInputs>[0]) => {
-      const data = await contextgetAccountPluginInputs(variables, { signal })
+    request: async (signal, variables: Parameters<typeof contextPluginControllergetAccountPluginInputs>[0]) => {
+      const data = await contextPluginControllergetAccountPluginInputs(variables, { signal })
       return data as FixedFullInputContextResponse
     },
-    permission: async ({ stackVersionId }: Parameters<typeof contextgetAccountPluginInputs>[0]) => {
+    permission: async ({ stackVersionId }: Parameters<typeof contextPluginControllergetAccountPluginInputs>[0]) => {
       const canViewContext = await workspaceClient.listConsolidatedContext.isAllowed({ $type: 'plugin', stackVersionId })
       const canGetConnectionInterfaceTypes = await contentClient.connectionInterfaceTypes.isAllowed()
       const canGetPluginVersions = await contentClient.pluginVersionsByIds.isAllowed({})
@@ -157,7 +158,7 @@ class WorkspaceManagerClient extends ReactQueryNetworkClient {
   /**
    * Gets plugin inputs and connection interface from a plugin in a stack version in workspace
    */
-  pluginInputsWithConnectionInterfaces = this.query(contextgetConsolidatedPluginInputsWithConnectionInterfaces as unknown as ReplaceResult<typeof contextgetConsolidatedPluginInputsWithConnectionInterfaces, FixedPluginForAppCreationV2Response>)
+  pluginInputsWithConnectionInterfaces = this.query(contextPluginControllergetConsolidatedPluginInputsWithConnectionInterfaces as unknown as ReplaceResult<typeof contextPluginControllergetConsolidatedPluginInputsWithConnectionInterfaces, FixedPluginForAppCreationV2Response>)
   /**
    * Gets workflows from a given stack and workflow type 
    */
@@ -253,6 +254,10 @@ class WorkspaceManagerClient extends ReactQueryNetworkClient {
    * Updates Stacks To Latest Version By Workspace
    */
   updateStacksToLatestVersionByWorkspace = this.mutation(workspaceStackControllerrefreshStacksInWorkspace)
+  /**
+   * Get all workspaces with pagination
+   */
+  workspacesWithPagination = this.query(workspaceControllergetWorkspaces)
 }
 
 export const workspaceManagerClient = new WorkspaceManagerClient()

package/src/error/DefaultAPIError.ts

@@ -1,10 +1,12 @@
 import { Dictionary, Language } from '@stack-spot/portal-translate'
 import { every, isString } from 'lodash'
 import { ErrorResponse, ValidationDetails } from '../api/account'
-import { StackspotAPIError } from './StackspotAPIError'
+import { ErrorDetailsProperties, StackspotAPIError } from './StackspotAPIError'
 import { baseDictionary } from './dictionary/base'
 import { cntFields } from './dictionary/cnt-fields'
 import { workspaceFields } from './dictionary/workspace-fields'
+import { workspaceDetails } from './dictionary/workspace-details'
+import { actionDetails } from './dictionary/action-details'
 
 // these details don't say anything the status already doesn't and we'd better use local translations for them.
 const ignoredDescriptions = [
@@ -16,6 +18,11 @@ const fieldDictionary = {
   wks: workspaceFields,
 }
 
+const detailsDictionary = {
+  wks: workspaceDetails,
+  actionapi: actionDetails,
+}
+
 function getTitle(status: number, raw: ErrorResponse, dictionary: Dictionary, language: Language) {
   if (dictionary[language][raw.code]) return dictionary[language][raw.code]
   if (raw.details && !ignoredDescriptions.includes(raw.details)) return raw.details
@@ -26,16 +33,22 @@ function getValues(detail: ValidationDetails) {
   return detail.values && every(detail.values, isString) ? `\n${detail.values.join('\n')}` : ''
 }
 
-function createMessage(status: number, raw: ErrorResponse, dictionary: Dictionary, language: Language) {
-  const title = getTitle(status, raw, dictionary, language)
-  if (!raw.validationDetails?.length) return title
+function createMessage(status: number, raw: ErrorResponse, dictionary: Dictionary, language?: Language): ErrorDetailsProperties  {
+  const title = getTitle(status, raw, dictionary, language || 'en')
   const api = raw.code?.split(/[-_]/)[0]
+  const dictDetails = (detailsDictionary[api?.toLowerCase() as keyof typeof detailsDictionary] ?? {})[language || 'en']
+  const dictionaryDetails = raw.code && dictDetails ? dictDetails[raw.code] : {}
+
+  if (!raw.validationDetails?.length) return { description : title, ...dictionaryDetails }
+  
   const details = raw.validationDetails?.map((detail) => {
-    const dict: Record<string, string> = (fieldDictionary[api?.toLowerCase() as keyof typeof fieldDictionary] ?? {})[language] ?? {}
-    const name = dict[detail.code] || detail.field || (raw.code !== detail.code && dictionary[language][detail.code]) || detail.details || ''
+    const dict: Record<string, string> = (fieldDictionary[api?.toLowerCase() as keyof typeof fieldDictionary] ?? {})[language || 'en'] ?? {}
+    const name = dict[detail.code] || detail.field || 
+    (raw.code !== detail.code && dictionary[language || 'en'][detail.code]) || detail.details || ''
     return `${name}${getValues(detail)}`
   })?.filter(d => !!d)
-  return details ? `${title}\n${details?.join('\n')}` : title
+
+  return { description: details ? `${title}\n${details?.join('\n')}` : title, ...dictionaryDetails }
 }
 
 /**

package/src/error/StackspotAPIError.ts

@@ -1,6 +1,25 @@
 import { Language, getLanguage } from '@stack-spot/portal-translate'
 
-export type InternationalizedMessage = (language: Language) => string
+export type InternationalizedMessage = (language: Language) => string | ErrorDetailsProperties
+
+export interface ErrorDetailsProperties {
+  /**
+   * The error title
+   */
+  title?: string,
+  /**
+   * The error description
+   */
+  description?: string,
+  /**
+   * Label for link
+   */
+  linkLabel?: string,
+  /**
+   * Text for href of link 
+   */
+  linkHref?: string,
+}
 
 interface ErrorProperties {
   /**
@@ -20,11 +39,17 @@ interface ErrorProperties {
    * 
    * If not provided, will attempt to use the error code or 'unknown'.
    */
-  message?: InternationalizedMessage | string,
+  message?: InternationalizedMessage | string | ErrorDetailsProperties,
   /**
    * The error's stack trace, if any.
    */
   stack?: string,
+  
+}
+
+function getMessage(error: ErrorProperties['message']) {
+  const message = typeof error === 'function' ? error('en') : error
+  return typeof message === 'string' ? message : message?.description
 }
 
 export class StackspotAPIError extends Error {
@@ -43,12 +68,12 @@ export class StackspotAPIError extends Error {
   private intl?: InternationalizedMessage
 
   constructor({ status, code, headers, message, stack }: ErrorProperties) {
-    super(`Stackspot API error (network ${status}): ${typeof message === 'string' ? message : message?.('en') || message?.('pt') || code || 'unknown'}`)
+    super(`Stackspot API error (network ${status}): ${getMessage(message)}`)
     this.status = status
     this.code = code
     this.headers = headers
     this.stack = stack
-    this.intl = typeof message === 'string' ? () => message : message
+    this.intl = typeof message === 'string' || typeof message === 'object' ?  () => message : message
   }
 
   /**
@@ -56,8 +81,21 @@ export class StackspotAPIError extends Error {
    * @param language 
    * @returns an error message
    */
-  translate(language: Language = getLanguage()) {
+  translate(language: Language = getLanguage()): string {
+    const unknown = language === 'en' ? 'unknown error' : 'erro desconhecido'
+    
+    const error = this.intl?.(language) 
+    const message = typeof error === 'string' ? error : error?.description
+    return message ?? this.message ?? this.code ?? (this.status === 0 ? unknown : `${this.status}`)
+  }
+
+  translateDetails(language: Language = getLanguage()): ErrorDetailsProperties {
     const unknown = language === 'en' ? 'unknown error' : 'erro desconhecido'
-    return this.intl?.(language) ?? this.message ?? this.code ?? (this.status === 0 ? unknown : `${this.status}`)
+    const errorMessage = this.intl?.(language)
+    if (typeof errorMessage === 'string')
+      return { description: errorMessage }
+    if (typeof errorMessage === 'object')
+      return errorMessage
+    return { description: this.message ?? this.code ?? (this.status === 0 ? unknown : `${this.status}`) }
   }
 }