@stack-spot/portal-network 0.208.3 → 0.210.0

package/src/api/accountAssetManager.ts

@@ -0,0 +1,655 @@
+/**
+ * EDP Backend for StackSpot Asset Management
+ * 0.0.1
+ * DO NOT MODIFY - This file has been generated using oazapfts.
+ * See https://www.npmjs.com/package/oazapfts
+ */
+import * as Oazapfts from "@oazapfts/runtime";
+import * as QS from "@oazapfts/runtime/query";
+export const defaults: Oazapfts.Defaults<Oazapfts.CustomHeaders> = {
+    headers: {},
+    baseUrl: "https://account-asset-manager.dev.stackspot.com",
+};
+const oazapfts = Oazapfts.runtime(defaults);
+export const servers = {
+    generatedServerUrl: "https://account-asset-manager.dev.stackspot.com"
+};
+export type CreateProjectRequest = {
+    /** Project name */
+    name: string;
+    /** Project unique slug */
+    slug: string;
+    /** Project description */
+    description: string;
+    /** Folder ULID where the project will be created. Required. */
+    folderId: string;
+};
+export type ApiIdResponse = {
+    id: string;
+};
+export type ValidationDetail = {
+    code: string;
+    values: string[];
+};
+export type ErrorBody = {
+    code: string;
+    details: string;
+    status: string;
+    validationDetails?: ValidationDetail[];
+};
+export type CreateAssetRequest = {
+    /** New asset's name */
+    name: string;
+    /** New asset's name */
+    slug: string;
+    /** New asset's description */
+    description: string;
+    /** New asset's type */
+    "type": string;
+    /** Asset's createdBy user. Required only for Service Token. */
+    createdBy?: string;
+};
+export type FolderResponse = {
+    /** Folder ID */
+    id: string;
+    /** Folder name */
+    name: string;
+    /** Folder slug */
+    slug: string;
+    /** Folder description */
+    description: string;
+    /** Folder creation date */
+    createdAt: string;
+    /** Folder creator */
+    createdBy: string;
+    /** Sub folders */
+    folders: any[];
+};
+export type CreateFolderRequest = {
+    /** New folder's name */
+    name: string;
+    /** New folder's unique slug */
+    slug: string;
+    /** New folder's description */
+    description: string;
+    /** Parent folder's api id, null if creating root folder. ULID Format */
+    parentFolderId?: string;
+};
+export type AssetTypeResponse = {
+    apiId: string;
+    name: string;
+    description: string;
+};
+export type CreateAssetTypeRequest = {
+    /** New asset type's name */
+    name: string;
+    /** New asset type's description */
+    description: string;
+    /** Asset type's createdBy user. Required only for Service Token. */
+    createdBy?: string;
+};
+export type ProjectAssetsResponse = {
+    /** Asset's id */
+    id: string;
+    /** Asset's name */
+    name: string;
+    /** Asset's type */
+    "type": string;
+};
+export type ProjectDetailsResponse = {
+    /** Projects's id */
+    id: string;
+    /** Projects's name */
+    name: string;
+    /** Projects's unique slug */
+    slug: string;
+    /** Projects's description */
+    description: string;
+    /** Creation date of the project */
+    createdAt: string;
+    /** Creator of the project */
+    createdBy: string;
+    /** Folder's id */
+    folderId: string;
+    /** Assets linked to a project */
+    assets: ProjectAssetsResponse[];
+};
+export type UpdateProjectRequest = {
+    /** Project name */
+    name?: string;
+    /** Project description */
+    description?: string;
+};
+export type ProjectResponse = {
+    /** Project id */
+    id: string;
+    /** Project name */
+    name: string;
+    /** Project description */
+    description: string;
+    /** Project slug */
+    slug: string;
+    /** Project status */
+    status: "ACTIVE" | "DRAFT";
+};
+export type UpdateAssetRequest = {
+    /** Asset's name */
+    name: string;
+    /** Asset's description */
+    description: string;
+    /** Asset's updatedBy user. Required only for Service Token. */
+    updatedBy?: string;
+};
+export type FolderProjectResponse = {
+    /** Project's id */
+    id: string;
+    /** Project's name */
+    name: string;
+    /** Project's created by */
+    createdBy: string;
+};
+export type FoldersDetailsResponse = {
+    /** Folder's id */
+    id: string;
+    /** Folder's name */
+    name: string;
+    /** Folder's unique slug */
+    slug: string;
+    /** Folder's description */
+    description: string;
+    /** Creator of the folder */
+    createdBy: string;
+    /** Creator of the folder */
+    createdAt: string;
+    /** Projects linked to a folder */
+    projects?: FolderProjectResponse[];
+    /** Folder linked to a folder */
+    folders?: FoldersDetailsResponse[];
+};
+export type UpdateFolderRequest = {
+    /** Folder name */
+    name: string;
+    /** Folder description */
+    description: string;
+};
+export type UpdateAssetTypeRequest = {
+    /** Asset type's name */
+    name: string;
+    /** Asset type's description */
+    description: string;
+    /** Asset type's updatedBy user. Required only for Service Token. */
+    updatedBy?: string;
+};
+/**
+ * Create project
+ */
+export function saveProject({ createProjectRequest }: {
+    createProjectRequest: CreateProjectRequest;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 201;
+        data: ApiIdResponse;
+    } | {
+        status: 400;
+        data: ErrorBody;
+    } | {
+        status: 401;
+    } | {
+        status: 403;
+        data: ApiIdResponse;
+    } | {
+        status: 404;
+    } | {
+        status: 422;
+        data: ErrorBody;
+    } | {
+        status: 500;
+    }>("/v1/account/projects", oazapfts.json({
+        ...opts,
+        method: "POST",
+        body: createProjectRequest
+    })));
+}
+/**
+ * Create asset
+ */
+export function saveAsset({ projectId, createAssetRequest }: {
+    projectId: string;
+    createAssetRequest: CreateAssetRequest;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 201;
+        data: ApiIdResponse;
+    } | {
+        status: 400;
+        data: ErrorBody;
+    } | {
+        status: 401;
+    } | {
+        status: 403;
+        data: ApiIdResponse;
+    } | {
+        status: 404;
+        data: ErrorBody;
+    } | {
+        status: 422;
+        data: ErrorBody;
+    } | {
+        status: 500;
+    }>(`/v1/account/projects/${encodeURIComponent(projectId)}/assets`, oazapfts.json({
+        ...opts,
+        method: "POST",
+        body: createAssetRequest
+    })));
+}
+/**
+ * List folders
+ */
+export function listFolders(opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: FolderResponse[];
+    } | {
+        status: 400;
+        data: ErrorBody;
+    } | {
+        status: 401;
+    } | {
+        status: 403;
+        data: FolderResponse[];
+    } | {
+        status: 404;
+        data: ErrorBody;
+    } | {
+        status: 422;
+        data: ErrorBody;
+    } | {
+        status: 500;
+    }>("/v1/account/folders", {
+        ...opts
+    }));
+}
+/**
+ * Create folder
+ */
+export function saveFolder({ createFolderRequest }: {
+    createFolderRequest: CreateFolderRequest;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: ApiIdResponse;
+    } | {
+        status: 201;
+        data: ApiIdResponse;
+    } | {
+        status: 400;
+        data: ErrorBody;
+    } | {
+        status: 401;
+    } | {
+        status: 403;
+        data: ApiIdResponse;
+    } | {
+        status: 404;
+        data: ErrorBody;
+    } | {
+        status: 422;
+        data: ErrorBody;
+    } | {
+        status: 500;
+    }>("/v1/account/folders", oazapfts.json({
+        ...opts,
+        method: "POST",
+        body: createFolderRequest
+    })));
+}
+/**
+ * List assets type
+ */
+export function listAssetTypes({ name }: {
+    name?: string;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: AssetTypeResponse[];
+    } | {
+        status: 400;
+        data: ErrorBody;
+    } | {
+        status: 401;
+    } | {
+        status: 403;
+        data: AssetTypeResponse[];
+    } | {
+        status: 404;
+        data: ErrorBody;
+    } | {
+        status: 422;
+        data: ErrorBody;
+    } | {
+        status: 500;
+    }>(`/v1/account/assets/types${QS.query(QS.explode({
+        name
+    }))}`, {
+        ...opts
+    }));
+}
+/**
+ * Create asset type
+ */
+export function saveAssetType({ createAssetTypeRequest }: {
+    createAssetTypeRequest: CreateAssetTypeRequest;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 201;
+        data: ApiIdResponse;
+    } | {
+        status: 400;
+        data: ErrorBody;
+    } | {
+        status: 401;
+    } | {
+        status: 403;
+        data: ApiIdResponse;
+    } | {
+        status: 404;
+        data: ErrorBody;
+    } | {
+        status: 422;
+        data: ErrorBody;
+    } | {
+        status: 500;
+    }>("/v1/account/assets/types", oazapfts.json({
+        ...opts,
+        method: "POST",
+        body: createAssetTypeRequest
+    })));
+}
+/**
+ * Get project details
+ */
+export function getProjectDetails({ projectId }: {
+    projectId: string;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: ProjectDetailsResponse;
+    } | {
+        status: 400;
+        data: ErrorBody;
+    } | {
+        status: 401;
+    } | {
+        status: 403;
+        data: ProjectDetailsResponse;
+    } | {
+        status: 404;
+    } | {
+        status: 422;
+        data: ErrorBody;
+    } | {
+        status: 500;
+    }>(`/v1/account/projects/${encodeURIComponent(projectId)}`, {
+        ...opts
+    }));
+}
+/**
+ * Delete project
+ */
+export function deleteProject({ projectId }: {
+    projectId: string;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 204;
+    } | {
+        status: 400;
+        data: ErrorBody;
+    } | {
+        status: 401;
+    } | {
+        status: 403;
+    } | {
+        status: 404;
+    } | {
+        status: 422;
+    } | {
+        status: 500;
+    }>(`/v1/account/projects/${encodeURIComponent(projectId)}`, {
+        ...opts,
+        method: "DELETE"
+    }));
+}
+/**
+ * Update project
+ */
+export function updateProject({ projectId, updateProjectRequest }: {
+    projectId: string;
+    updateProjectRequest: UpdateProjectRequest;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: ProjectResponse;
+    } | {
+        status: 400;
+        data: ErrorBody;
+    } | {
+        status: 401;
+    } | {
+        status: 403;
+        data: ProjectResponse;
+    } | {
+        status: 404;
+    } | {
+        status: 422;
+        data: ErrorBody;
+    } | {
+        status: 500;
+    }>(`/v1/account/projects/${encodeURIComponent(projectId)}`, oazapfts.json({
+        ...opts,
+        method: "PATCH",
+        body: updateProjectRequest
+    })));
+}
+/**
+ * Disassociate asset from project
+ */
+export function disassociateProjectAsset({ projectId, assetId }: {
+    projectId: string;
+    assetId: string;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 204;
+    } | {
+        status: 400;
+        data: ErrorBody;
+    } | {
+        status: 401;
+    } | {
+        status: 403;
+    } | {
+        status: 404;
+    } | {
+        status: 422;
+        data: ErrorBody;
+    } | {
+        status: 500;
+    }>(`/v1/account/projects/${encodeURIComponent(projectId)}/assets/${encodeURIComponent(assetId)}`, {
+        ...opts,
+        method: "DELETE"
+    }));
+}
+/**
+ * Update asset
+ */
+export function updateAsset({ projectId, assetId, updateAssetRequest }: {
+    projectId: string;
+    assetId: string;
+    updateAssetRequest: UpdateAssetRequest;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: ApiIdResponse;
+    } | {
+        status: 400;
+        data: ErrorBody;
+    } | {
+        status: 401;
+    } | {
+        status: 403;
+        data: ApiIdResponse;
+    } | {
+        status: 404;
+        data: ErrorBody;
+    } | {
+        status: 422;
+        data: ErrorBody;
+    } | {
+        status: 500;
+    }>(`/v1/account/projects/${encodeURIComponent(projectId)}/assets/${encodeURIComponent(assetId)}`, oazapfts.json({
+        ...opts,
+        method: "PATCH",
+        body: updateAssetRequest
+    })));
+}
+/**
+ * Get folder details
+ */
+export function getFolderDetails({ folderId }: {
+    folderId: string;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: FoldersDetailsResponse;
+    } | {
+        status: 400;
+        data: ErrorBody;
+    } | {
+        status: 401;
+    } | {
+        status: 403;
+        data: FoldersDetailsResponse;
+    } | {
+        status: 404;
+    } | {
+        status: 422;
+        data: ErrorBody;
+    } | {
+        status: 500;
+    }>(`/v1/account/folders/${encodeURIComponent(folderId)}`, {
+        ...opts
+    }));
+}
+/**
+ * Delete folder
+ */
+export function deleteFolder({ folderId }: {
+    folderId: string;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 204;
+    } | {
+        status: 400;
+        data: ErrorBody;
+    } | {
+        status: 401;
+    } | {
+        status: 403;
+    } | {
+        status: 404;
+    } | {
+        status: 422;
+    } | {
+        status: 500;
+    }>(`/v1/account/folders/${encodeURIComponent(folderId)}`, {
+        ...opts,
+        method: "DELETE"
+    }));
+}
+/**
+ * Update folder
+ */
+export function updateFolders({ folderId, updateFolderRequest }: {
+    folderId: string;
+    updateFolderRequest: UpdateFolderRequest;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: ApiIdResponse;
+    } | {
+        status: 400;
+        data: ErrorBody;
+    } | {
+        status: 401;
+    } | {
+        status: 403;
+        data: ApiIdResponse;
+    } | {
+        status: 404;
+    } | {
+        status: 422;
+        data: ErrorBody;
+    } | {
+        status: 500;
+    }>(`/v1/account/folders/${encodeURIComponent(folderId)}`, oazapfts.json({
+        ...opts,
+        method: "PATCH",
+        body: updateFolderRequest
+    })));
+}
+/**
+ * Delete asset type
+ */
+export function deleteAssetType({ assetTypeId }: {
+    assetTypeId: string;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 204;
+    } | {
+        status: 400;
+        data: ErrorBody;
+    } | {
+        status: 401;
+    } | {
+        status: 403;
+    } | {
+        status: 404;
+    } | {
+        status: 422;
+    } | {
+        status: 500;
+    }>(`/v1/account/assets/types/${encodeURIComponent(assetTypeId)}`, {
+        ...opts,
+        method: "DELETE"
+    }));
+}
+/**
+ * Update asset type
+ */
+export function updateAssetType({ assetTypeId, updateAssetTypeRequest }: {
+    assetTypeId: string;
+    updateAssetTypeRequest: UpdateAssetTypeRequest;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: ApiIdResponse;
+    } | {
+        status: 400;
+        data: ErrorBody;
+    } | {
+        status: 401;
+    } | {
+        status: 403;
+        data: ApiIdResponse;
+    } | {
+        status: 404;
+    } | {
+        status: 422;
+        data: ErrorBody;
+    } | {
+        status: 500;
+    }>(`/v1/account/assets/types/${encodeURIComponent(assetTypeId)}`, oazapfts.json({
+        ...opts,
+        method: "PATCH",
+        body: updateAssetTypeRequest
+    })));
+}