@stack-spot/portal-network 0.35.0 → 0.37.0

package/src/api/content.ts

@@ -8,11 +8,11 @@ import * as Oazapfts from "@oazapfts/runtime";
 import * as QS from "@oazapfts/runtime/query";
 export const defaults: Oazapfts.Defaults<Oazapfts.CustomHeaders> = {
     headers: {},
-    baseUrl: "https://content-content-api.dev.stackspot.com",
+    baseUrl: "https://content-content-api.stg.stackspot.com",
 };
 const oazapfts = Oazapfts.runtime(defaults);
 export const servers = {
-    generatedServerUrl: "https://content-content-api.dev.stackspot.com"
+    generatedServerUrl: "https://content-content-api.stg.stackspot.com"
 };
 export type ValidationDetails = {
     code?: string;
@@ -358,14 +358,14 @@ export type SortObject = {
 export type PageableObject = {
     offset?: number;
     sort?: SortObject[];
-    pageSize?: number;
-    pageNumber?: number;
     paged?: boolean;
     unpaged?: boolean;
+    pageSize?: number;
+    pageNumber?: number;
 };
 export type PageGetStackStudioResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -502,8 +502,8 @@ export type PluginVersionResponse = {
     stkProjectsOnly: boolean;
 };
 export type PagePluginVersionResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -643,8 +643,8 @@ export type ActionResponse = {
     hasRequiredConnection: boolean;
 };
 export type PageActionResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -704,8 +704,8 @@ export type FilterStarterRequest = {
     "type"?: "INFRA" | "APP";
 };
 export type PageStarterResponseWithRange = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -722,8 +722,8 @@ export type FilterStackVersionPluginRequest = {
     text?: string;
 };
 export type PageStackPluginResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -821,8 +821,8 @@ export type FilterStackActionRequest = {
     filter?: string;
 };
 export type PageGetStackActionResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1004,8 +1004,8 @@ export type UpdateDocRequest = {
     publish: boolean;
 };
 export type PageStudioResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1031,8 +1031,8 @@ export type PluginVersionDto = {
     governance?: GovernanceDto;
 };
 export type PagePluginVersionDto = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1058,8 +1058,8 @@ export type ActionVersionDto = {
     governance?: GovernanceDto;
 };
 export type PageActionVersionDto = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1171,9 +1171,11 @@ export type GetWorkflowsByStudioLatestVersionDataResponse = {
     id: string;
     displayName: string;
     label: string;
+    description: string;
     semanticVersion: string;
     targetApp: boolean;
     targetInfra: boolean;
+    createdAt: string;
 };
 export type GetWorkflowsByStudioResponse = {
     id: string;
@@ -1183,8 +1185,8 @@ export type GetWorkflowsByStudioResponse = {
     latestVersion?: GetWorkflowsByStudioLatestVersionDataResponse;
 };
 export type PageGetWorkflowsByStudioResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1200,13 +1202,63 @@ export type DownloadWorkflowBase64Response = {
     file_name: string;
     workflowVersionId: string;
 };
+export type WorkflowStudioResponse = {
+    slug: string;
+    name: string;
+    imageUrl?: string;
+    description?: string;
+};
+export type GetWorkflowCommandResponse = {
+    "default": string;
+    workspace: string;
+};
+export type WorkflowVersionJobStepsResponse = {
+    id: string;
+    identifier: string;
+    name: string;
+    label?: string;
+    ordination: number;
+    optional: boolean;
+    workdir?: string;
+    "type": string;
+    alias?: string;
+};
+export type WorkflowVersionJobsResponse = {
+    id: string;
+    identifier: string;
+    label: string;
+    ordination: number;
+    optional: boolean;
+    steps?: WorkflowVersionJobStepsResponse[];
+};
+export type GetWorkflowResponse = {
+    id: string;
+    studio: WorkflowStudioResponse;
+    workflowVersionId: string;
+    "type": string;
+    version: string;
+    slug: string;
+    displayName?: string;
+    description?: string;
+    commands?: GetWorkflowCommandResponse;
+    createdAt: string;
+    createdBy: string;
+    updatedAt?: string;
+    qualifier: string;
+    accountSlug?: string;
+    studioSlug: string;
+    status: string;
+    isDocumented: boolean;
+    documentation?: DocumentationContentResponse;
+    jobs?: WorkflowVersionJobsResponse[];
+};
 export type GetAvailableWorkflowVersionsResponse = {
     workflowVersionId: string;
     version: string;
 };
 export type PageGetAvailableWorkflowVersionsResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1225,8 +1277,8 @@ export type StackWorkspaceViewResponse = {
     totalLinkedVersions: number;
 };
 export type PageStackWorkspaceViewResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1253,8 +1305,8 @@ export type StackWorkspaceDetailViewResponse = {
     environment?: StackWorkspaceDetailViewEnvironmentResponse;
 };
 export type PageStackWorkspaceDetailViewResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1272,8 +1324,8 @@ export type GetUnusedStackVersionsResponse = {
     status?: string;
 };
 export type PageGetUnusedStackVersionsResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1423,8 +1475,8 @@ export type PluginStarterResponse = {
     stack: StackResponse;
 };
 export type PagePluginStarterResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1449,8 +1501,8 @@ export type GetPluginStackStarterUsageResponse = {
     pluginVersion: GetPluginStackStarterUsagePluginResponse;
 };
 export type PageGetPluginStackStarterUsageResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1471,8 +1523,8 @@ export type PluginStacksResponse = {
     studio: PluginStudioResponse;
 };
 export type PagePluginStacksResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1497,8 +1549,8 @@ export type GetPluginStackUsageResponse = {
     pluginVersion: GetPluginStackUsagePluginResponse;
 };
 export type PageGetPluginStackUsageResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1523,8 +1575,8 @@ export type PluginInfrastructureViewResponse = {
     workspace: PluginInfrastructureWorkspaceResponse;
 };
 export type PagePluginInfrastructureViewResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1549,8 +1601,8 @@ export type InfrastructureEnvironmentsUsesPluginResponse = {
     pluginVersion: GetInfrastructureEnvironmentsUsagePluginVersionResponse;
 };
 export type PageInfrastructureEnvironmentsUsesPluginResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1569,8 +1621,8 @@ export type PluginViewUsageMonitorResponse = {
     studio: PluginStudioResponse;
 };
 export type PagePluginViewUsageMonitorResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1590,8 +1642,8 @@ export type GetDependentPluginsVersionsResponse = {
     pluginVersion: DependentPluginVersionResponse;
 };
 export type PageGetDependentPluginsVersionsResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1608,8 +1660,8 @@ export type GetPluginVersionsNotInUseResponse = {
     status: "DRAFT" | "PUBLISHED" | "DEPRECATED" | "REPROVED";
 };
 export type PageGetPluginVersionsNotInUseResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1642,8 +1694,8 @@ export type PluginApplicationsResponse = {
     workspace: PluginApplicationsWorkspaceResponse;
 };
 export type PagePluginApplicationsResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1668,8 +1720,8 @@ export type PluginUsageMonitorApplicationViewResponse = {
     environment: PluginUsageMonitorApplicationViewEnvironmentResponse;
 };
 export type PagePluginUsageMonitorApplicationViewResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1791,8 +1843,8 @@ export type ContentEvaluationResponse = {
     pendingDiscussionReading: boolean;
 };
 export type PageContentEvaluationResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -2271,8 +2323,7 @@ export function createConnectionInterfaceType({ createConnectionInterfaceTypeReq
 /**
  * Validate and return info from a workflow
  */
-export function validateWorkflow({ studioSlug, body }: {
-    studioSlug?: string;
+export function validateWorkflow({ body }: {
     body?: {
         file: Blob;
     };
@@ -2296,9 +2347,7 @@ export function validateWorkflow({ studioSlug, body }: {
             details: string;
             validationDetails?: ValidationDetails[];
         };
-    }>(`/v1/workflows/validate${QS.query(QS.explode({
-        studioSlug
-    }))}`, oazapfts.json({
+    }>("/v1/workflows/validate", oazapfts.json({
         ...opts,
         method: "POST",
         body
@@ -3023,9 +3072,8 @@ export function listStudios({ xWorkspaceId, filterStudioRequest }: {
 /**
  * Validate and return info from a starter
  */
-export function validateStack({ starterPath, studioSlug, body }: {
+export function validateStack({ starterPath, body }: {
     starterPath: string;
-    studioSlug?: string;
     body?: {
         file: Blob;
     };
@@ -3050,8 +3098,7 @@ export function validateStack({ starterPath, studioSlug, body }: {
             validationDetails?: ValidationDetails[];
         };
     }>(`/v1/starters/validate${QS.query(QS.explode({
-        starterPath,
-        studioSlug
+        starterPath
     }))}`, oazapfts.json({
         ...opts,
         method: "POST",
@@ -3696,8 +3743,7 @@ export function getStackVersionListByIds({ xWorkspaceId, filterStackVersionReque
 /**
  * Validate and return info from a stack
  */
-export function validateStack1({ studioSlug, body }: {
-    studioSlug?: string;
+export function validateStack1({ body }: {
     body?: {
         file: Blob;
     };
@@ -3721,9 +3767,7 @@ export function validateStack1({ studioSlug, body }: {
             details: string;
             validationDetails?: ValidationDetails[];
         };
-    }>(`/v1/stacks/validate${QS.query(QS.explode({
-        studioSlug
-    }))}`, oazapfts.json({
+    }>("/v1/stacks/validate", oazapfts.json({
         ...opts,
         method: "POST",
         body
@@ -3829,8 +3873,7 @@ export function deprecatePluginVersion({ pluginVersionId, deprecateContentReques
 /**
  * Validate and return info from a plugin
  */
-export function validatePlugin({ studioSlug, body }: {
-    studioSlug?: string;
+export function validatePlugin({ body }: {
     body?: {
         file: Blob;
     };
@@ -3854,9 +3897,7 @@ export function validatePlugin({ studioSlug, body }: {
             details: string;
             validationDetails?: ValidationDetails[];
         };
-    }>(`/v1/plugins/validate${QS.query(QS.explode({
-        studioSlug
-    }))}`, oazapfts.json({
+    }>("/v1/plugins/validate", oazapfts.json({
         ...opts,
         method: "POST",
         body
@@ -4101,8 +4142,7 @@ export function deprecateActionVersion({ actionVersionId, deprecateContentReques
 /**
  * Validate and return info from a action
  */
-export function validateAction({ studioSlug, body }: {
-    studioSlug?: string;
+export function validateAction({ body }: {
     body?: {
         file: Blob;
     };
@@ -4126,9 +4166,7 @@ export function validateAction({ studioSlug, body }: {
             details: string;
             validationDetails?: ValidationDetails[];
         };
-    }>(`/v1/actions/validate${QS.query(QS.explode({
-        studioSlug
-    }))}`, oazapfts.json({
+    }>("/v1/actions/validate", oazapfts.json({
         ...opts,
         method: "POST",
         body
@@ -5169,6 +5207,43 @@ export function downloadWorkflowBase64({ studioSlug, workflowSlug, version, xWor
         })
     }));
 }
+/**
+ * Get workflow version
+ */
+export function getWorkflow({ studioSlug, workflowSlug, version, xWorkspaceId }: {
+    studioSlug: string;
+    workflowSlug: string;
+    version?: string;
+    xWorkspaceId?: string;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: GetWorkflowResponse;
+    } | {
+        status: 422;
+        data: {
+            code: string;
+            status: number;
+            details: string;
+            validationDetails?: ValidationDetails[];
+        };
+    } | {
+        status: 500;
+        data: {
+            code: string;
+            status: number;
+            details: string;
+            validationDetails?: ValidationDetails[];
+        };
+    }>(`/v1/studios/${encodeURIComponent(studioSlug)}/workflows/${encodeURIComponent(workflowSlug)}/version${QS.query(QS.explode({
+        version
+    }))}`, {
+        ...opts,
+        headers: oazapfts.mergeHeaders(opts?.headers, {
+            "x-workspace-id": xWorkspaceId
+        })
+    }));
+}
 /**
  * Get available workflow versions by workflow slug
  */
@@ -5206,6 +5281,46 @@ export function getAvailableWorkflowVersionsByWorkflowSlug({ studioSlug, workflo
         ...opts
     }));
 }
+/**
+ * Get an workflow documentation
+ */
+export function getWorkflowDoc({ studioSlug, documentationId, language, status }: {
+    studioSlug: string;
+    documentationId: string;
+    language: string;
+    status?: string;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: DocumentationResponse;
+    } | {
+        status: 400;
+    } | {
+        status: 403;
+    } | {
+        status: 404;
+    } | {
+        status: 422;
+        data: {
+            code: string;
+            status: number;
+            details: string;
+            validationDetails?: ValidationDetails[];
+        };
+    } | {
+        status: 500;
+        data: {
+            code: string;
+            status: number;
+            details: string;
+            validationDetails?: ValidationDetails[];
+        };
+    }>(`/v1/studios/${encodeURIComponent(studioSlug)}/workflows/docs/${encodeURIComponent(documentationId)}/language/${encodeURIComponent(language)}${QS.query(QS.explode({
+        status
+    }))}`, {
+        ...opts
+    }));
+}
 /**
  * Get a starter documentation
  */