mtlx-sdk

Functions

createFrontendTokenInstance()

function createFrontendTokenInstance(__namedParameters): ApiClient;

Parameters

Parameter	Type
__namedParameters	CreateFrontendTokenInstanceParams

Returns

ApiClient

---

createSecretTokenInstance()

function createSecretTokenInstance(__namedParameters): ApiClient;

Parameters

Parameter	Type
__namedParameters	CreateSecretTokenInstanceParams

Returns

ApiClient

---

createSessionInstance()

function createSessionInstance(__namedParameters): ApiClient;

Parameters

Parameter	Type
__namedParameters	CreateSessionInstanceParams

Returns

ApiClient

---

createAnonymousClient()

function createAnonymousClient(__namedParameters): ApiClient;

Parameters

Parameter	Type
__namedParameters	CreateInstanceParams

Returns

ApiClient

---

clientFetchUrl()

function clientFetchUrl(client, request): URL;

Parameters

Parameter	Type
client	ApiClient
request	ApiRequest

Returns

URL

---

clientFetch()

function clientFetch(client, request): Promise<AxiosResponse<any, any, {
}, Record<string, string | number | boolean | undefined>>>;

Parameters

Parameter	Type
client	ApiClient
request	ApiRequest

Returns

Promise<AxiosResponse<any, any, { }, Record<string, string | number | boolean | undefined>>>

---

parseResult()

function parseResult<T>(
   client, 
   schema, 
   data
): output<T>;

Conditionally parses API response data using a zod schema. If client.validateResults is true, validates and parses the data. Otherwise, returns the data with a type assertion based on the schema's inferred type.

Type Parameters

Type Parameter
T extends ZodTypeAny<unknown, unknown, $ZodTypeInternals<unknown, unknown>>

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance (unused, kept for backward compatibility)
schema	T	The zod schema to use for validation/type inference
data	unknown	The raw response data to parse

Returns

output<T>

The parsed or type-asserted data matching the schema's inferred type

---

buildPath()

function buildPath(path, params): string;

Builds a path by replacing path parameters with their values. The params object is type-checked to match the parameters in the path string.

Parameters

Parameter	Type	Description
path	string	Path template with parameters like /api/$orgId/test
params	Record<string, string | number>	Object containing parameter values matching the path template

Returns

string

Resolved path with parameters substituted

Example

buildPath('/users/$userName', { userName: 'john-doe' })
// Returns: '/users/john-doe'

// Type error if parameter is missing:
buildPath('/users/$userName', {}) // Error: Property 'userName' is missing

---

dashboardUserLink()

function dashboardUserLink(__namedParameters): string;

Parameters

Parameter	Type
__namedParameters	{ userName: string; }
__namedParameters.userName	string

Returns

string

---

dashboardAssetLink()

function dashboardAssetLink(__namedParameters): string;

Parameters

Parameter	Type
__namedParameters	{ userName: string; assetName: string; }
__namedParameters.userName	string
__namedParameters.assetName	string

Returns

string

---

dashboardAssetCommentLink()

function dashboardAssetCommentLink(__namedParameters): string;

Parameters

Parameter	Type
__namedParameters	{ userName: string; assetName: string; commentHash: string; }
__namedParameters.userName	string
__namedParameters.assetName	string
__namedParameters.commentHash	string

Returns

string

---

dashboardSettingsInvitesLink()

function dashboardSettingsInvitesLink(): string;

Returns

string

---

createEventRouter()

function createEventRouter(options): object;

Creates a transport-agnostic event router that parses { type, data } against the canonical schema registry and dispatches to typed handlers.

Works for both SSE events and webhook payloads. Use for consistent parse-and-dispatch logic across consumers.

Parameters

Parameter	Type
options	CreateEventRouterOptions

Returns

object

Name	Type
handle()	(input) => void

Example

const router = createEventRouter({
  handlers: {
    'asset.updated': (data) => { /* data is typed */ },
    'notification.new': () => { /* ... */ },
  },
  onUnknown: (type) => console.warn('Unknown event:', type),
  onParseError: (type, err) => console.error('Parse failed:', type, err),
});
router.handle({ type: 'asset.updated', data: rawData });

---

getFileFormatInfos()

function getFileFormatInfos(formats): FileFormatInfo[];

Parameters

Parameter	Type
formats	readonly ("jpg" | "png" | "webp" | "gif" | "mtlx" | "mtlxzip")[]

Returns

FileFormatInfo[]

---

getFileFormatMimeTypes()

function getFileFormatMimeTypes(fileFormats): (
  | "image/gif"
  | "image/jpeg"
  | "application/xml"
  | "application/zip"
  | "image/png"
  | "image/webp")[];

Parameters

Parameter	Type
fileFormats	readonly ("jpg" | "png" | "webp" | "gif" | "mtlx" | "mtlxzip")[]

Returns

( | "image/gif" | "image/jpeg" | "application/xml" | "application/zip" | "image/png" | "image/webp")[]

---

getFileFormatExtensions()

function getFileFormatExtensions(fileFormats): string[];

Parameters

Parameter	Type
fileFormats	readonly ("jpg" | "png" | "webp" | "gif" | "mtlx" | "mtlxzip")[]

Returns

string[]

---

getFileFormatInfoAcceptObject()

function getFileFormatInfoAcceptObject(fileFormats): Record<string, string[]>;

Parameters

Parameter	Type
fileFormats	readonly ("jpg" | "png" | "webp" | "gif" | "mtlx" | "mtlxzip")[]

Returns

Record<string, string[]>

---

getFileFormatInfoFromMimeType()

function getFileFormatInfoFromMimeType(mimeType, fileFormats): FileFormatInfo | undefined;

Parameters

Parameter	Type
mimeType	string
fileFormats	readonly ("jpg" | "png" | "webp" | "gif" | "mtlx" | "mtlxzip")[]

Returns

FileFormatInfo | undefined

---

getFileFormatInfoFromExtension()

function getFileFormatInfoFromExtension(ext, fileFormats): FileFormatInfo | undefined;

Parameters

Parameter	Type
ext	string
fileFormats	readonly ("jpg" | "png" | "webp" | "gif" | "mtlx" | "mtlxzip")[]

Returns

FileFormatInfo | undefined

---

getMimeFileFormat()

function getMimeFileFormat<T>(mimeType, formats): T[number] | undefined;

Given a MIME type, return the matching format key from the allowed set, or undefined if not found.

Type Parameters

Type Parameter
T extends readonly ("jpg" | "png" | "webp" | "gif" | "mtlx" | "mtlxzip")[]

Parameters

Parameter	Type
mimeType	string
formats	T

Returns

T[number] | undefined

---

getAssetTypeFromFileFormat()

function getAssetTypeFromFileFormat(fileFormat): "MATERIAL" | undefined;

Parameters

Parameter	Type
fileFormat	"jpg" | "png" | "webp" | "gif" | "mtlx" | "mtlxzip"

Returns

"MATERIAL" | undefined

---

listResultSchema()

function listResultSchema<T>(item): ZodObject<{
  rows: ZodArray<T>;
  rowCount: ZodInt;
}, $strict>;

Type Parameters

Type Parameter
T extends ZodTypeAny<unknown, unknown, $ZodTypeInternals<unknown, unknown>>

Parameters

Parameter	Type
item	T

Returns

ZodObject<{ rows: ZodArray<T>; rowCount: ZodInt; }, $strict>

---

createSortingSchema()

function createSortingSchema<TField>(fields): ZodObject<{
  sortBy: ZodEnum<{ [k in string]: { [k in string]: k }[k] }>;
  sortDir: ZodDefault<ZodEnum<{
     asc: "asc";
     desc: "desc";
  }>>;
}, $strip>;

Type Parameters

Type Parameter
TField extends string

Parameters

Parameter	Type
fields	readonly [TField, TField]

Returns

ZodObject<{ sortBy: ZodEnum<{ [k in string]: { [k in string]: k }[k] }>; sortDir: ZodDefault<ZodEnum<{ asc: "asc"; desc: "desc"; }>>; }, $strip>

---

createSortingOptionalSchema()

function createSortingOptionalSchema<TField>(fields): ZodObject<{
  sortBy: ZodOptional<ZodEnum<{ [k in string]: { [k in string]: k }[k] }>>;
  sortDir: ZodOptional<ZodEnum<{
     asc: "asc";
     desc: "desc";
  }>>;
}, $strip>;

Type Parameters

Type Parameter
TField extends string

Parameters

Parameter	Type
fields	readonly [TField, TField]

Returns

ZodObject<{ sortBy: ZodOptional<ZodEnum<{ [k in string]: { [k in string]: k }[k] }>>; sortDir: ZodOptional<ZodEnum<{ asc: "asc"; desc: "desc"; }>>; }, $strip>

---

entityNameSchema()

function entityNameSchema(description): ZodString;

Parameters

Parameter	Type
description	string

Returns

ZodString

---

defaultBinaryResponse()

function defaultBinaryResponse<T>(): T;

Type Parameters

Type Parameter
T extends BinaryResponse

Returns

T

---

uploadFileToUploadUrl()

function uploadFileToUploadUrl(
   uploadUrl, 
   file, 
   mimetype?
): Promise<void>;

Parameters

Parameter	Type
uploadUrl	string
file	File | Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>
mimetype?	string

Returns

Promise<void>

---

uploadFile()

function uploadFile(client, props): Promise<string>;

Uploads a file and returns the upload token. This helper function infers the MIME type from the file extension, prepares the upload, and uploads the file to the signed URL.

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance
props	UploadFileProps	The upload properties

Returns

Promise<string>

Promise resolving to the upload token

Example

import { readFile } from 'node:fs/promises';
import { basename } from 'node:path';

const fileData = await readFile('model.glb');
const filename = basename('model.glb');
const uploadToken = await uploadFile(client, {
  params: { userName: 'my-user' },
  fileData,
  filename,
});

---

validateUrl()

function validateUrl(url): boolean;

Returns true if the given string is a valid URL, false otherwise. Uses the same semantics as the URL constructor (no throw).

Parameters

Parameter	Type
url	string

Returns

boolean

---

makeUrl()

function makeUrl(
   host, 
   path, 
   query?
): URL;

Parameters

Parameter	Type
host	string
path	string
query?	Record<string, string | number | boolean | undefined>

Returns

URL

---

listAPITokens()

function listAPITokens(client, props): Promise<{
  rows: object[];
  rowCount: number;
}>;

Lists API tokens for an organization or project.

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance
props	{ query: { pageOffset?: number; pageSize?: number; sortBy?: "name" | "createdAt" | "updatedAt" | "lastUsedAt" | "usedCount"; sortDir?: "asc" | "desc"; userName: string; tokenType?: "SECRET" | "FRONTEND"; }; }	The request properties
props.query?	{ pageOffset?: number; pageSize?: number; sortBy?: "name" | "createdAt" | "updatedAt" | "lastUsedAt" | "usedCount"; sortDir?: "asc" | "desc"; userName: string; tokenType?: "SECRET" | "FRONTEND"; }	Query parameters including userName, pagination, sorting, and optional tokenType filter
props.query.pageOffset?	number	-
props.query.pageSize?	number	-
props.query.sortBy?	"name" | "createdAt" | "updatedAt" | "lastUsedAt" | "usedCount"	-
props.query.sortDir?	"asc" | "desc"	-
props.query.userName?	string	-
props.query.tokenType?	"SECRET" | "FRONTEND"	-

Returns

Promise<{ rows: object[]; rowCount: number; }>

Promise resolving to a paginated list of API tokens

Operation Id

list-api-tokens

---

createAPIToken()

function createAPIToken(client, props): Promise<{
  id: number;
  name: string;
  description: string;
  token: string;
  type: "SECRET" | "FRONTEND";
  domainWhitelist: string | null;
  lastUsedAt: string | null;
  usedCount: number;
  createdAt: string;
  updatedAt: string;
  userId: number;
  userName: string;
}>;

Creates a new API token.

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance
props	{ query: { userName: string; }; body: { name: string; description?: string; type: "SECRET" | "FRONTEND"; domainWhitelist?: string; }; }	The request properties
props.query?	{ userName: string; }	Query parameters (userName)
props.query.userName?	string	-
props.body?	{ name: string; description?: string; type: "SECRET" | "FRONTEND"; domainWhitelist?: string; }	Request body with token details
props.body.name?	string	-
props.body.description?	string	-
props.body.type?	"SECRET" | "FRONTEND"	-
props.body.domainWhitelist?	string	-

Returns

Promise<{ id: number; name: string; description: string; token: string; type: "SECRET" | "FRONTEND"; domainWhitelist: string | null; lastUsedAt: string | null; usedCount: number; createdAt: string; updatedAt: string; userId: number; userName: string; }>

Promise resolving to the created API token (includes the token value)

Operation Id

create-api-token

---

deleteAPIToken()

function deleteAPIToken(client, props): Promise<void>;

Deletes an API token by name.

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance
props	{ params: { apiTokenName: string; }; query: { userName: string; }; }	The request properties
props.params?	{ apiTokenName: string; }	Path parameters (apiTokenName)
props.params.apiTokenName?	string	-
props.query?	{ userName: string; }	Query parameters (userName)
props.query.userName?	string	-

Returns

Promise<void>

Promise that resolves when the token is deleted

Operation Id

delete-api-token

---

listAssets()

function listAssets(client, props): Promise<{
  rows: object[];
  rowCount: number;
}>;

Lists assets with optional filtering and pagination.

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance
props	{ query: { pageOffset?: number; pageSize?: number; sortBy?: "name" | "likeCount" | "shareCount" | "createdAt" | "updatedAt"; sortDir?: "asc" | "desc"; visibility?: "PRIVATE" | "UNLISTED" | "PUBLIC"; searchText?: string; type?: "MATERIAL"; userName?: string; archived?: boolean; }; }	The request properties
props.query?	{ pageOffset?: number; pageSize?: number; sortBy?: "name" | "likeCount" | "shareCount" | "createdAt" | "updatedAt"; sortDir?: "asc" | "desc"; visibility?: "PRIVATE" | "UNLISTED" | "PUBLIC"; searchText?: string; type?: "MATERIAL"; userName?: string; archived?: boolean; }	Query parameters for filtering, pagination, and sorting
props.query.pageOffset?	number	-
props.query.pageSize?	number	-
props.query.sortBy?	"name" | "likeCount" | "shareCount" | "createdAt" | "updatedAt"	-
props.query.sortDir?	"asc" | "desc"	-
props.query.visibility?	"PRIVATE" | "UNLISTED" | "PUBLIC"	-
props.query.searchText?	string	-
props.query.type?	"MATERIAL"	-
props.query.userName?	string	-
props.query.archived?	boolean	-

Returns

Promise<{ rows: object[]; rowCount: number; }>

Promise resolving to a paginated list of assets

Operation Id

list-assets

Example

const assets = await listAssets(client, {
  query: { visibility: 'PUBLIC', pageOffset: 0, pageSize: 20 }
});

---

createAsset()

function createAsset(client, props): Promise<{
  id: number;
  name: string;
  type: "MATERIAL";
  visibility: "PRIVATE" | "UNLISTED" | "PUBLIC";
  userId: number;
  userName: string;
  description: string;
  keywords: string;
  shareLicense:   | "NONE"
     | "CC_0"
     | "CC_BY"
     | "CC_BY_SA"
     | "CC_BY_NC"
     | "CC_BY_NC_SA"
     | "CC_BY_ND"
     | "CC_BY_NC_ND";
  aiUsage: "UNDISCLOSED" | "AI_USED" | "AI_FREE";
  commentMode: "NONE" | "ENABLED" | "MEMBERS_ONLY";
  reported: boolean;
  likeCount: number;
  shareCount: number;
  createdAt: string;
  updatedAt: string;
  archived: boolean;
  metadata: string;
  versionOriginalSize?: number | null;
  width?: number | null;
  height?: number | null;
  depth?: number | null;
  fileOid: string;
  thumbnailOid?: string | null;
  materialInfo?: {
     version?: string;
     colorspace?: string;
     materials: object[];
     nodeGraphCount: number;
     topLevelNodeCount: number;
     referencedTextures: string[];
     warnings: string[];
  };
}>;

Creates a new asset for a user.

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance
props	{ params: { userName: string; }; body: { name: string; description?: string; type: "MATERIAL"; uploadToken: string; visibility: "PRIVATE" | "UNLISTED" | "PUBLIC"; shareLicense: | "NONE" | "CC_0" | "CC_BY" | "CC_BY_SA" | "CC_BY_NC" | "CC_BY_NC_SA" | "CC_BY_ND" | "CC_BY_NC_ND"; aiUsage?: "UNDISCLOSED" | "AI_USED" | "AI_FREE"; commentMode?: "NONE" | "ENABLED" | "MEMBERS_ONLY"; metadata?: string; }; }	The request properties
props.params?	{ userName: string; }	Path parameters (userName)
props.params.userName?	string	-
props.body?	{ name: string; description?: string; type: "MATERIAL"; uploadToken: string; visibility: "PRIVATE" | "UNLISTED" | "PUBLIC"; shareLicense: | "NONE" | "CC_0" | "CC_BY" | "CC_BY_SA" | "CC_BY_NC" | "CC_BY_NC_SA" | "CC_BY_ND" | "CC_BY_NC_ND"; aiUsage?: "UNDISCLOSED" | "AI_USED" | "AI_FREE"; commentMode?: "NONE" | "ENABLED" | "MEMBERS_ONLY"; metadata?: string; }	Request body with asset details
props.body.name?	string	-
props.body.description?	string	-
props.body.type?	"MATERIAL"	-
props.body.uploadToken?	string	-
props.body.visibility?	"PRIVATE" | "UNLISTED" | "PUBLIC"	-
props.body.shareLicense?	| "NONE" | "CC_0" | "CC_BY" | "CC_BY_SA" | "CC_BY_NC" | "CC_BY_NC_SA" | "CC_BY_ND" | "CC_BY_NC_ND"	-
props.body.aiUsage?	"UNDISCLOSED" | "AI_USED" | "AI_FREE"	-
props.body.commentMode?	"NONE" | "ENABLED" | "MEMBERS_ONLY"	-
props.body.metadata?	string	-

Returns

Promise<{ id: number; name: string; type: "MATERIAL"; visibility: "PRIVATE" | "UNLISTED" | "PUBLIC"; userId: number; userName: string; description: string; keywords: string; shareLicense: | "NONE" | "CC_0" | "CC_BY" | "CC_BY_SA" | "CC_BY_NC" | "CC_BY_NC_SA" | "CC_BY_ND" | "CC_BY_NC_ND"; aiUsage: "UNDISCLOSED" | "AI_USED" | "AI_FREE"; commentMode: "NONE" | "ENABLED" | "MEMBERS_ONLY"; reported: boolean; likeCount: number; shareCount: number; createdAt: string; updatedAt: string; archived: boolean; metadata: string; versionOriginalSize?: number | null; width?: number | null; height?: number | null; depth?: number | null; fileOid: string; thumbnailOid?: string | null; materialInfo?: { version?: string; colorspace?: string; materials: object[]; nodeGraphCount: number; topLevelNodeCount: number; referencedTextures: string[]; warnings: string[]; }; }>

Promise resolving to the created asset

Operation Id

create-asset

Example

const asset = await createAsset(client, {
  params: { userName: 'my-user' },
  body: {
    name: 'my-asset',
    type: 'MATERIAL',
    uploadToken: '...',
    visibility: 'PUBLIC',
    shareLicense: 'CC_BY'
  }
});

---

getAsset()

function getAsset(client, props): Promise<{
  id: number;
  name: string;
  type: "MATERIAL";
  visibility: "PRIVATE" | "UNLISTED" | "PUBLIC";
  userId: number;
  userName: string;
  description: string;
  keywords: string;
  shareLicense:   | "NONE"
     | "CC_0"
     | "CC_BY"
     | "CC_BY_SA"
     | "CC_BY_NC"
     | "CC_BY_NC_SA"
     | "CC_BY_ND"
     | "CC_BY_NC_ND";
  aiUsage: "UNDISCLOSED" | "AI_USED" | "AI_FREE";
  commentMode: "NONE" | "ENABLED" | "MEMBERS_ONLY";
  reported: boolean;
  likeCount: number;
  shareCount: number;
  createdAt: string;
  updatedAt: string;
  archived: boolean;
  metadata: string;
  versionOriginalSize?: number | null;
  width?: number | null;
  height?: number | null;
  depth?: number | null;
  fileOid: string;
  thumbnailOid?: string | null;
  materialInfo?: {
     version?: string;
     colorspace?: string;
     materials: object[];
     nodeGraphCount: number;
     topLevelNodeCount: number;
     referencedTextures: string[];
     warnings: string[];
  };
}>;

Gets asset metadata by user and asset names.

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance
props	{ params: { userName: string; assetName: string; }; }	The request properties
props.params?	{ userName: string; assetName: string; }	Path parameters (userName, assetName)
props.params.userName?	string	-
props.params.assetName?	string	-

Returns

Promise<{ id: number; name: string; type: "MATERIAL"; visibility: "PRIVATE" | "UNLISTED" | "PUBLIC"; userId: number; userName: string; description: string; keywords: string; shareLicense: | "NONE" | "CC_0" | "CC_BY" | "CC_BY_SA" | "CC_BY_NC" | "CC_BY_NC_SA" | "CC_BY_ND" | "CC_BY_NC_ND"; aiUsage: "UNDISCLOSED" | "AI_USED" | "AI_FREE"; commentMode: "NONE" | "ENABLED" | "MEMBERS_ONLY"; reported: boolean; likeCount: number; shareCount: number; createdAt: string; updatedAt: string; archived: boolean; metadata: string; versionOriginalSize?: number | null; width?: number | null; height?: number | null; depth?: number | null; fileOid: string; thumbnailOid?: string | null; materialInfo?: { version?: string; colorspace?: string; materials: object[]; nodeGraphCount: number; topLevelNodeCount: number; referencedTextures: string[]; warnings: string[]; }; }>

Promise resolving to the asset metadata

Operation Id

get-asset-metadata

Example

const asset = await getAsset(client, {
  params: { userName: 'my-user', assetName: 'my-asset' }
});

---

assetExists()

function assetExists(client, props): Promise<boolean>;

Parameters

Parameter	Type
client	ApiClient
props	{ params: { userName: string; assetName: string; }; }
props.params?	{ userName: string; assetName: string; }
props.params.userName?	string
props.params.assetName?	string

Returns

Promise<boolean>

---

updateAsset()

function updateAsset(client, props): Promise<{
  id: number;
  name: string;
  type: "MATERIAL";
  visibility: "PRIVATE" | "UNLISTED" | "PUBLIC";
  userId: number;
  userName: string;
  description: string;
  keywords: string;
  shareLicense:   | "NONE"
     | "CC_0"
     | "CC_BY"
     | "CC_BY_SA"
     | "CC_BY_NC"
     | "CC_BY_NC_SA"
     | "CC_BY_ND"
     | "CC_BY_NC_ND";
  aiUsage: "UNDISCLOSED" | "AI_USED" | "AI_FREE";
  commentMode: "NONE" | "ENABLED" | "MEMBERS_ONLY";
  reported: boolean;
  likeCount: number;
  shareCount: number;
  createdAt: string;
  updatedAt: string;
  archived: boolean;
  metadata: string;
  versionOriginalSize?: number | null;
  width?: number | null;
  height?: number | null;
  depth?: number | null;
  fileOid: string;
  thumbnailOid?: string | null;
  materialInfo?: {
     version?: string;
     colorspace?: string;
     materials: object[];
     nodeGraphCount: number;
     topLevelNodeCount: number;
     referencedTextures: string[];
     warnings: string[];
  };
}>;

Updates an asset's metadata.

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance
props	{ params: { userName: string; assetName: string; }; body: { name?: string; description?: string; keywords?: string; visibility?: "PRIVATE" | "UNLISTED" | "PUBLIC"; shareLicense?: | "NONE" | "CC_0" | "CC_BY" | "CC_BY_SA" | "CC_BY_NC" | "CC_BY_NC_SA" | "CC_BY_ND" | "CC_BY_NC_ND"; aiUsage?: "UNDISCLOSED" | "AI_USED" | "AI_FREE"; commentMode?: "NONE" | "ENABLED" | "MEMBERS_ONLY"; archived?: boolean; metadata?: string; uploadToken?: string; }; }	The request properties
props.params?	{ userName: string; assetName: string; }	Path parameters (userName, assetName)
props.params.userName?	string	-
props.params.assetName?	string	-
props.body?	{ name?: string; description?: string; keywords?: string; visibility?: "PRIVATE" | "UNLISTED" | "PUBLIC"; shareLicense?: | "NONE" | "CC_0" | "CC_BY" | "CC_BY_SA" | "CC_BY_NC" | "CC_BY_NC_SA" | "CC_BY_ND" | "CC_BY_NC_ND"; aiUsage?: "UNDISCLOSED" | "AI_USED" | "AI_FREE"; commentMode?: "NONE" | "ENABLED" | "MEMBERS_ONLY"; archived?: boolean; metadata?: string; uploadToken?: string; }	Request body with fields to update
props.body.name?	string	-
props.body.description?	string	-
props.body.keywords?	string	-
props.body.visibility?	"PRIVATE" | "UNLISTED" | "PUBLIC"	-
props.body.shareLicense?	| "NONE" | "CC_0" | "CC_BY" | "CC_BY_SA" | "CC_BY_NC" | "CC_BY_NC_SA" | "CC_BY_ND" | "CC_BY_NC_ND"	-
props.body.aiUsage?	"UNDISCLOSED" | "AI_USED" | "AI_FREE"	-
props.body.commentMode?	"NONE" | "ENABLED" | "MEMBERS_ONLY"	-
props.body.archived?	boolean	-
props.body.metadata?	string	-
props.body.uploadToken?	string	-

Returns

Promise<{ id: number; name: string; type: "MATERIAL"; visibility: "PRIVATE" | "UNLISTED" | "PUBLIC"; userId: number; userName: string; description: string; keywords: string; shareLicense: | "NONE" | "CC_0" | "CC_BY" | "CC_BY_SA" | "CC_BY_NC" | "CC_BY_NC_SA" | "CC_BY_ND" | "CC_BY_NC_ND"; aiUsage: "UNDISCLOSED" | "AI_USED" | "AI_FREE"; commentMode: "NONE" | "ENABLED" | "MEMBERS_ONLY"; reported: boolean; likeCount: number; shareCount: number; createdAt: string; updatedAt: string; archived: boolean; metadata: string; versionOriginalSize?: number | null; width?: number | null; height?: number | null; depth?: number | null; fileOid: string; thumbnailOid?: string | null; materialInfo?: { version?: string; colorspace?: string; materials: object[]; nodeGraphCount: number; topLevelNodeCount: number; referencedTextures: string[]; warnings: string[]; }; }>

Promise resolving to the updated asset

Operation Id

update-asset

Example

const asset = await updateAsset(client, {
  params: { userName: 'my-user', assetName: 'my-asset' },
  body: { description: 'Updated description' }
});

---

deleteAsset()

function deleteAsset(client, props): Promise<void>;

Deletes an asset.

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance
props	{ params: { userName: string; assetName: string; }; }	The request properties
props.params?	{ userName: string; assetName: string; }	Path parameters (userName, assetName)
props.params.userName?	string	-
props.params.assetName?	string	-

Returns

Promise<void>

Promise that resolves when the asset is deleted

Operation Id

delete-asset

Example

await deleteAsset(client, {
  params: { userName: 'my-user', assetName: 'my-asset' }
});

---

prepareAssetUpload()

function prepareAssetUpload(client, props): Promise<{
  uploadUrl: string;
  uploadToken: string;
}>;

Prepares an asset upload by generating an upload URL and token.

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance
props	{ params: { userName: string; }; body: { filename: string; contentType: string; size: number; }; }	The request properties
props.params?	{ userName: string; }	Path parameters (userName)
props.params.userName?	string	-
props.body?	{ filename: string; contentType: string; size: number; }	Request body with file information
props.body.filename?	string	-
props.body.contentType?	string	-
props.body.size?	number	-

Returns

Promise<{ uploadUrl: string; uploadToken: string; }>

Promise resolving to upload URL, token, and user upload ID

Operation Id

prepare-asset-upload

Example

const upload = await prepareAssetUpload(client, {
  params: { userName: 'my-user' },
  body: { filename: 'copper.mtlx.zip', contentType: 'application/zip', size: 1024000 }
});

---

refreshAccessToken()

function refreshAccessToken(
   host, 
   props, 
   validateResults?
): Promise<{
  accessToken: string;
}>;

Refreshes an access token using a refresh token. The token type is automatically inferred from the token prefix:

• ut_ prefix for session tokens
• st_ prefix for API tokens

Parameters

Parameter	Type	Default value	Description
host	string	undefined	The API host URL
props	{ body: { refreshToken: string; }; }	undefined	The request properties
props.body?	{ refreshToken: string; }	refreshAccessTokenBodySchema	Request body with refresh token (type is inferred from prefix)
props.body.refreshToken?	string	...	-
validateResults?	boolean	false	-

Returns

Promise<{ accessToken: string; }>

Promise resolving to a new access token

Operation Id

refresh-access-token

---

exchangeAuthorizationCode()

function exchangeAuthorizationCode(
   host, 
   props, 
   validateResults?
): Promise<{
  access_token: string;
  refresh_token: string;
  token_type: "Bearer";
  expires_in: number;
}>;

Exchange an authorization code for access and refresh tokens (OAuth 2.0).

Parameters

Parameter	Type	Default value	Description
host	string	undefined	The API host URL
props	{ body: { grant_type: "authorization_code"; code: string; client_id: string; code_verifier: string; redirect_uri: string; client_secret?: string; }; }	undefined	The request properties
props.body?	{ grant_type: "authorization_code"; code: string; client_id: string; code_verifier: string; redirect_uri: string; client_secret?: string; }	oauthTokenRequestBodySchema	Request body with grant_type, code, client_id, code_verifier, and redirect_uri
props.body.grant_type?	"authorization_code"	...	-
props.body.code?	string	...	-
props.body.client_id?	string	...	-
props.body.code_verifier?	string	...	-
props.body.redirect_uri?	string	...	-
props.body.client_secret?	string	...	-
validateResults?	boolean	false	-

Returns

Promise<{ access_token: string; refresh_token: string; token_type: "Bearer"; expires_in: number; }>

Promise resolving to access_token, refresh_token, token_type, and expires_in

Operation Id

oauth-token

---

deleteRefreshToken()

function deleteRefreshToken(client, props): Promise<void>;

Deletes a refresh token (session) by invalidating it.

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance
props	{ params: { token: string; }; }	The request properties
props.params?	{ token: string; }	Path parameters (token)
props.params.token?	string	-

Returns

Promise<void>

Promise that resolves when the refresh token is deleted

Operation Id

delete-refresh-token

---

uploadAvatar()

function uploadAvatar(client, props): Promise<void>;

Uploads an avatar for a user.

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance
props	{ query: { userName: string; }; body: { file: File; }; }	The request properties
props.query?	{ userName: string; }	Query parameters (userName)
props.query.userName?	string	-
props.body?	{ file: File; }	Request body containing the file to upload
props.body.file?	File	-

Returns

Promise<void>

Promise that resolves when the avatar is uploaded

Operation Id

upload-avatar

Example

await uploadAvatar(client, {
  query: { userName: 'my-user' },
  body: { file: avatarFile }
});

---

getAvatarUrl()

function getAvatarUrl(client, props): URL;

Gets the URL for an avatar.

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance
props	{ query: { width?: number; height?: number; quality?: number; format?: "jpg" | "png" | "webp" | "avif"; redirectOnNotFound?: string; cacheKey?: string; userName: string; }; }	The request properties
props.query?	{ width?: number; height?: number; quality?: number; format?: "jpg" | "png" | "webp" | "avif"; redirectOnNotFound?: string; cacheKey?: string; userName: string; }	Query parameters (userName, image transform options)
props.query.width?	number	-
props.query.height?	number	-
props.query.quality?	number	-
props.query.format?	"jpg" | "png" | "webp" | "avif"	-
props.query.redirectOnNotFound?	string	-
props.query.cacheKey?	string	-
props.query.userName?	string	-

Returns

URL

URL object for the avatar

Operation Id

get-avatar

Example

const avatarUrl = getAvatarUrl(client, {
  query: { userName: 'my-user', width: 200, height: 200 }
});

---

getAvatar()

function getAvatar<T>(
   client, 
   props, 
   binaryResponse?
): Promise<BinaryResponseType<T>>;

Gets avatar binary data.

Type Parameters

Type Parameter
T extends BinaryResponse

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance
props	{ query: { width?: number; height?: number; quality?: number; format?: "jpg" | "png" | "webp" | "avif"; redirectOnNotFound?: string; cacheKey?: string; userName: string; }; }	The request properties
props.query?	{ width?: number; height?: number; quality?: number; format?: "jpg" | "png" | "webp" | "avif"; redirectOnNotFound?: string; cacheKey?: string; userName: string; }	Query parameters (userName, image transform options)
props.query.width?	number	-
props.query.height?	number	-
props.query.quality?	number	-
props.query.format?	"jpg" | "png" | "webp" | "avif"	-
props.query.redirectOnNotFound?	string	-
props.query.cacheKey?	string	-
props.query.userName?	string	-
binaryResponse?	T	Optional binary response type configuration

Returns

Promise<BinaryResponseType<T>>

Promise resolving to the avatar binary data

Operation Id

get-avatar

Example

const avatarData = await getAvatar(client, {
  query: { userName: 'my-user', width: 200, height: 200 }
});

---

deleteAvatar()

function deleteAvatar(client, props): Promise<void>;

Deletes a user's avatar.

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance
props	{ query: { userName: string; }; }	The request properties
props.query?	{ userName: string; }	Query parameters (userName)
props.query.userName?	string	-

Returns

Promise<void>

Promise that resolves when the avatar is deleted

Operation Id

delete-avatar

Example

await deleteAvatar(client, {
  query: { userName: 'my-user' }
});

---

createComment()

function createComment(client, props): Promise<{
  id: number;
  text: string;
  likeCount: number;
  createdAt: string;
  moderatedAt: string | null;
  moderationReason: string | null;
  createdByUserId: number;
  createdByName: string;
  likeId: number | null;
}>;

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance
props	{ params: { userName: string; assetName: string; }; body: { text: string; }; }	The request properties
props.params?	{ userName: string; assetName: string; }	Path parameters (userName, assetName)
props.params.userName?	string	-
props.params.assetName?	string	-
props.body?	{ text: string; }	Request body with comment text
props.body.text?	string	-

Returns

Promise<{ id: number; text: string; likeCount: number; createdAt: string; moderatedAt: string | null; moderationReason: string | null; createdByUserId: number; createdByName: string; likeId: number | null; }>

Promise resolving to the created comment

Operation Id

create-comment

---

listComments()

function listComments(client, props): Promise<{
  rows: object[];
  rowCount: number;
}>;

Lists comments for an asset.

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance
props	{ params: { userName: string; assetName: string; }; query: { pageOffset?: number; pageSize?: number; sortBy?: "createdAt"; sortDir?: "asc" | "desc"; }; }	The request properties
props.params?	{ userName: string; assetName: string; }	Path parameters (userName, assetName)
props.params.userName?	string	-
props.params.assetName?	string	-
props.query?	{ pageOffset?: number; pageSize?: number; sortBy?: "createdAt"; sortDir?: "asc" | "desc"; }	Query parameters (pagination, sorting)
props.query.pageOffset?	number	-
props.query.pageSize?	number	-
props.query.sortBy?	"createdAt"	-
props.query.sortDir?	"asc" | "desc"	-

Returns

Promise<{ rows: object[]; rowCount: number; }>

Promise resolving to a paginated list of comments

Operation Id

list-comments

---

editComment()

function editComment(client, props): Promise<{
  id: number;
  text: string;
  likeCount: number;
  createdAt: string;
  moderatedAt: string | null;
  moderationReason: string | null;
  createdByUserId: number;
  createdByName: string;
  likeId: number | null;
}>;

Edits an existing comment.

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance
props	{ params: { userName: string; assetName: string; commentId: number; }; body: { text: string; }; }	The request properties
props.params?	{ userName: string; assetName: string; commentId: number; }	Path parameters (userName, assetName, commentId)
props.params.userName?	string	-
props.params.assetName?	string	-
props.params.commentId?	number	-
props.body?	{ text: string; }	Request body with updated comment text
props.body.text?	string	-

Returns

Promise<{ id: number; text: string; likeCount: number; createdAt: string; moderatedAt: string | null; moderationReason: string | null; createdByUserId: number; createdByName: string; likeId: number | null; }>

Promise resolving to the updated comment

Operation Id

edit-comment

---

deleteComment()

function deleteComment(client, props): Promise<void>;

Deletes a comment.

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance
props	{ params: { userName: string; assetName: string; commentId: number; }; }	The request properties
props.params?	{ userName: string; assetName: string; commentId: number; }	Path parameters (userName, assetName, commentId)
props.params.userName?	string	-
props.params.assetName?	string	-
props.params.commentId?	number	-

Returns

Promise<void>

Promise that resolves when the comment is deleted

Operation Id

delete-comment

---

errorCheck()

function errorCheck(client): Promise<void>;

Throws a test error for error handling testing.

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance

Returns

Promise<void>

Promise resolving to void

Operation Id

health-error

---

getLocalFileUrl()

function getLocalFileUrl(props): string;

Gets the path + search string for a storage file by OID (no host). Use for same-origin redirects (e.g. in API handlers) or to build a full URL by prefixing with a host.

Parameters

Parameter	Type	Description
props	{ params: { oid: string; }; query?: { name?: string; }; }	The request properties
props.params?	{ oid: string; }	Path parameters (oid)
props.params.oid?	string	-
props.query?	{ name?: string; }	Query parameters (name)
props.query.name?	string	-

Returns

string

Path and query string, e.g. /files/{oid} or /files/{oid}?name=...

---

getFileUrl()

function getFileUrl(client, props): URL;

Gets the URL for a storage file by OID.

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance
props	{ params: { oid: string; }; query?: { name?: string; }; }	The request properties
props.params?	{ oid: string; }	Path parameters (oid)
props.params.oid?	string	-
props.query?	{ name?: string; }	Query parameters (name)
props.query.name?	string	-

Returns

URL

URL object for the storage file

Example

const fileUrl = getFileUrl(client, {
  params: { oid: 'abc123...' },
  query: { name: 'my-asset' }
});

---

getFile()

function getFile<T>(
   client, 
   props, 
   binaryResponse?
): Promise<BinaryResponseType<T>>;

Gets a storage file as binary data.

Type Parameters

Type Parameter
T extends BinaryResponse

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance
props	{ params: { oid: string; }; query?: { name?: string; }; }	The request properties
props.params?	{ oid: string; }	Path parameters (oid)
props.params.oid?	string	-
props.query?	{ name?: string; }	Query parameters (name)
props.query.name?	string	-
binaryResponse?	T	Optional binary response type configuration

Returns

Promise<BinaryResponseType<T>>

Promise resolving to the file binary data

Operation Id

get-file

Example

const file = await getFile(client, {
  params: { oid: 'abc123...' },
  query: { name: 'my-asset' }
});

---

healthCheck()

function healthCheck(client): Promise<void>;

Performs a health check on the API.

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance

Returns

Promise<void>

Promise resolving to void

Operation Id

health

---

getMediaOriginalUrl()

function getMediaOriginalUrl(client, props): URL;

GET /media/:userName/:assetName/original - original uploaded file

Parameters

Parameter	Type
client	ApiClient
props	{ params: { userName: string; assetName: string; }; query?: { download?: boolean; }; }
props.params	{ userName: string; assetName: string; }
props.params.userName?	string
props.params.assetName?	string
props.query?	{ download?: boolean; }
props.query.download?	boolean

Returns

URL

---

listNotifications()

function listNotifications(client, props): Promise<{
  rows: object[];
  rowCount: number;
}>;

Lists notifications for the authenticated user.

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance
props	{ query: { pageOffset?: number; pageSize?: number; sortBy?: "createdAt" | "status"; sortDir?: "asc" | "desc"; status?: "UNREAD" | "READ"; }; }	The request properties
props.query?	{ pageOffset?: number; pageSize?: number; sortBy?: "createdAt" | "status"; sortDir?: "asc" | "desc"; status?: "UNREAD" | "READ"; }	Query parameters for filtering, pagination, and sorting
props.query.pageOffset?	number	-
props.query.pageSize?	number	-
props.query.sortBy?	"createdAt" | "status"	-
props.query.sortDir?	"asc" | "desc"	-
props.query.status?	"UNREAD" | "READ"	-

Returns

Promise<{ rows: object[]; rowCount: number; }>

Promise resolving to a paginated list of notifications

Operation Id

list-notifications

---

markNotificationAsRead()

function markNotificationAsRead(client, props): Promise<void>;

Marks a specific notification as read.

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance
props	{ params: { notificationId: number; }; body: { status: "READ"; }; }	The request properties
props.params?	{ notificationId: number; }	Path parameters (notificationId)
props.params.notificationId?	number	-
props.body?	{ status: "READ"; }	Request body with status
props.body.status?	"READ"	-

Returns

Promise<void>

Promise that resolves when the notification is marked as read

Operation Id

mark-notification-as-read

---

markAllNotificationsAsRead()

function markAllNotificationsAsRead(client, props): Promise<{
  success: boolean;
}>;

Marks all notifications as read for the authenticated user.

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance
props	{ body: { status: "READ"; }; }	The request properties
props.body?	{ status: "READ"; }	Request body with status
props.body.status?	"READ"	-

Returns

Promise<{ success: boolean; }>

Promise resolving to a success indicator

Operation Id

mark-all-notifications-as-read

---

getOEmbedUrl()

function getOEmbedUrl(client, props): URL;

Gets the URL for the oEmbed endpoint.

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance
props	{ query: { url: string; format: "json" | "xml"; maxwidth?: number; maxheight?: number; }; }	The request properties
props.query?	{ url: string; format: "json" | "xml"; maxwidth?: number; maxheight?: number; }	Query parameters (url, format, maxwidth, maxheight)
props.query.url?	string	-
props.query.format?	"json" | "xml"	-
props.query.maxwidth?	number	-
props.query.maxheight?	number	-

Returns

URL

URL object for the oEmbed endpoint

Example

const oembedUrl = getOEmbedUrl(client, {
  query: { url: 'https://example.com/org/my-org', format: 'json' }
});

---

getOEmbed()

function getOEmbed(client, props): Promise<{
  version: "1.0";
  type: "link" | "photo" | "video" | "rich";
  provider_name: string;
  provider_url: string;
  url?: string;
  width?: number;
  height?: number;
  title?: string;
  author_name?: string;
  author_url?: string;
  thumbnail_url?: string;
  thumbnail_width?: number;
  thumbnail_height?: number;
  html?: string;
}>;

Gets oEmbed data for a URL. Returns structured metadata about the resource following the oEmbed specification.

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance
props	{ query: { url: string; format: "json" | "xml"; maxwidth?: number; maxheight?: number; }; }	The request properties
props.query?	{ url: string; format: "json" | "xml"; maxwidth?: number; maxheight?: number; }	Query parameters (url, format, maxwidth, maxheight)
props.query.url?	string	-
props.query.format?	"json" | "xml"	-
props.query.maxwidth?	number	-
props.query.maxheight?	number	-

Returns

Promise<{ version: "1.0"; type: "link" | "photo" | "video" | "rich"; provider_name: string; provider_url: string; url?: string; width?: number; height?: number; title?: string; author_name?: string; author_url?: string; thumbnail_url?: string; thumbnail_width?: number; thumbnail_height?: number; html?: string; }>

Promise resolving to oEmbed response data

Operation Id

get-oembed

Example

const oembed = await getOEmbed(client, {
  query: { url: 'https://example.com/org/my-org', format: 'json' }
});

---

subscribeToServerEvents()

function subscribeToServerEvents(client, options?): ServerEventsSubscription;

Subscribe to the API server's SSE events stream. Uses the ApiClient for authentication — JWT, session tokens, and API keys are all handled automatically via the client's axios interceptors. Returns an object with addEventListener(type, handler) for typed event handling and close().

Parameters

Parameter	Type
client	ApiClient
options?	SubscribeToServerEventsOptions

Returns

ServerEventsSubscription

Example

const sub = subscribeToServerEvents(client);
sub.addEventListener('notification.new', (data) => { ... });
sub.addEventListener('asset.updated', (data) => { ... });
// on unmount: sub.close();

---

getTask()

function getTask(client, props): Promise<{
  id: number;
  taskType: string;
  runner: string;
  parameters: string | null;
  createdAt: string;
  name: string;
  targetUrl: string | null;
  userName: string;
  assetName?: string | null;
  createdByName: string;
  latestRunStatus: "RUNNING" | "SUCCESS" | "FAILED" | null;
  latestRunDuration: number | null;
  latestRunResults: unknown;
}>;

Parameters

Parameter	Type
client	ApiClient
props	GetTaskProps

Returns

Promise<{ id: number; taskType: string; runner: string; parameters: string | null; createdAt: string; name: string; targetUrl: string | null; userName: string; assetName?: string | null; createdByName: string; latestRunStatus: "RUNNING" | "SUCCESS" | "FAILED" | null; latestRunDuration: number | null; latestRunResults: unknown; }>

---

subscribeToTaskEvents()

function subscribeToTaskEvents(client, props): TaskEventsSubscription;

Parameters

Parameter	Type
client	ApiClient
props	SubscribeToTaskEventsProps

Returns

TaskEventsSubscription

---

waitForTaskCompletion()

function waitForTaskCompletion(client, props): Promise<{
  taskId: number;
  run: {
     taskRunId: number;
     taskId: number;
     status: "RUNNING" | "SUCCESS" | "FAILED";
     startedAt: string;
     finishedAt: string | null;
     duration: number | null;
     workerName: string;
     results?: unknown;
     errors?: string | null;
  };
}>;

Parameters

Parameter	Type
client	ApiClient
props	WaitForTaskCompletionProps

Returns

Promise<{ taskId: number; run: { taskRunId: number; taskId: number; status: "RUNNING" | "SUCCESS" | "FAILED"; startedAt: string; finishedAt: string | null; duration: number | null; workerName: string; results?: unknown; errors?: string | null; }; }>

---

listUsers()

function listUsers(client, props): Promise<{
  rows: object[];
  rowCount: number;
}>;

Lists users with optional search and pagination.

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance
props	{ query: { pageOffset?: number; pageSize?: number; sortBy?: "email" | "name" | "createdAt" | "fullName"; sortDir?: "asc" | "desc"; searchText?: string; }; }	The request properties
props.query?	{ pageOffset?: number; pageSize?: number; sortBy?: "email" | "name" | "createdAt" | "fullName"; sortDir?: "asc" | "desc"; searchText?: string; }	Query parameters for filtering, pagination, and sorting
props.query.pageOffset?	number	-
props.query.pageSize?	number	-
props.query.sortBy?	"email" | "name" | "createdAt" | "fullName"	-
props.query.sortDir?	"asc" | "desc"	-
props.query.searchText?	string	-

Returns

Promise<{ rows: object[]; rowCount: number; }>

Promise resolving to a paginated list of users

Operation Id

list-users

Example

const users = await listUsers(client, {
  query: { searchText: 'john', pageOffset: 0, pageSize: 20 }
});

---

getUser()

function getUser(client, props): Promise<{
  id: number;
  name: string;
}>;

Gets user information by username.

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance
props	{ params: { userName: string; }; }	The request properties
props.params?	{ userName: string; }	Path parameters (userName)
props.params.userName?	string	-

Returns

Promise<{ id: number; name: string; }>

Promise resolving to the user information

Operation Id

get-user

Example

const user = await getUser(client, {
  params: { userName: 'john-doe' }
});

---

userExists()

function userExists(client, props): Promise<boolean>;

Parameters

Parameter	Type
client	ApiClient
props	{ params: { userName: string; }; }
props.params?	{ userName: string; }
props.params.userName?	string

Returns

Promise<boolean>

---

getUserPrivate()

function getUserPrivate(client, props): Promise<{
  id: number;
  name: string;
  createdAt: string;
  updatedAt: string;
  email: string;
  fullName: string;
  country:   | "~"
     | "AD"
     | "AE"
     | "AF"
     | "AG"
     | "AI"
     | "AL"
     | "AM"
     | "AO"
     | "AQ"
     | "AR"
     | "AS"
     | "AT"
     | "AU"
     | "AW"
     | "AX"
     | "AZ"
     | "BA"
     | "BB"
     | "BD"
     | "BE"
     | "BF"
     | "BG"
     | "BH"
     | "BI"
     | "BJ"
     | "BL"
     | "BM"
     | "BN"
     | "BO"
     | "BQ"
     | "BR"
     | "BS"
     | "BT"
     | "BV"
     | "BW"
     | "BY"
     | "BZ"
     | "CA"
     | "CC"
     | "CD"
     | "CF"
     | "CG"
     | "CH"
     | "CI"
     | "CK"
     | "CL"
     | "CM"
     | "CN"
     | "CO"
     | "CR"
     | "CU"
     | "CV"
     | "CW"
     | "CX"
     | "CY"
     | "CZ"
     | "DE"
     | "DJ"
     | "DK"
     | "DM"
     | "DO"
     | "DZ"
     | "EC"
     | "EE"
     | "EG"
     | "EH"
     | "ER"
     | "ES"
     | "ET"
     | "FI"
     | "FJ"
     | "FK"
     | "FM"
     | "FO"
     | "FR"
     | "GA"
     | "GB"
     | "GD"
     | "GE"
     | "GF"
     | "GG"
     | "GH"
     | "GI"
     | "GL"
     | "GM"
     | "GN"
     | "GP"
     | "GQ"
     | "GR"
     | "GS"
     | "GT"
     | "GU"
     | "GW"
     | "GY"
     | "HK"
     | "HM"
     | "HN"
     | "HR"
     | "HT"
     | "HU"
     | "ID"
     | "IE"
     | "IL"
     | "IM"
     | "IN"
     | "IO"
     | "IQ"
     | "IR"
     | "IS"
     | "IT"
     | "JE"
     | "JM"
     | "JO"
     | "JP"
     | "KE"
     | "KG"
     | "KH"
     | "KI"
     | "KM"
     | "KN"
     | "KP"
     | "KR"
     | "KW"
     | "KY"
     | "KZ"
     | "LA"
     | "LB"
     | "LC"
     | "LI"
     | "LK"
     | "LR"
     | "LS"
     | "LT"
     | "LU"
     | "LV"
     | "LY"
     | "MA"
     | "MC"
     | "MD"
     | "ME"
     | "MF"
     | "MG"
     | "MH"
     | "MK"
     | "ML"
     | "MM"
     | "MN"
     | "MO"
     | "MP"
     | "MQ"
     | "MR"
     | "MS"
     | "MT"
     | "MU"
     | "MV"
     | "MW"
     | "MX"
     | "MY"
     | "MZ"
     | "NA"
     | "NC"
     | "NE"
     | "NF"
     | "NG"
     | "NI"
     | "NL"
     | "NO"
     | "NP"
     | "NR"
     | "NU"
     | "NZ"
     | "OM"
     | "PA"
     | "PE"
     | "PF"
     | "PG"
     | "PH"
     | "PK"
     | "PL"
     | "PM"
     | "PN"
     | "PR"
     | "PS"
     | "PT"
     | "PW"
     | "PY"
     | "QA"
     | "RE"
     | "RO"
     | "RS"
     | "RU"
     | "RW"
     | "SA"
     | "SB"
     | "SC"
     | "SD"
     | "SE"
     | "SG"
     | "SH"
     | "SI"
     | "SJ"
     | "SK"
     | "SL"
     | "SM"
     | "SN"
     | "SO"
     | "SR"
     | "SS"
     | "ST"
     | "SV"
     | "SY"
     | "SZ"
     | "TC"
     | "TD"
     | "TF"
     | "TG"
     | "TH"
     | "TJ"
     | "TK"
     | "TL"
     | "TM"
     | "TN"
     | "TO"
     | "TR"
     | "TT"
     | "TV"
     | "TW"
     | "TZ"
     | "UA"
     | "UG"
     | "UM"
     | "US"
     | "UY"
     | "UZ"
     | "VA"
     | "VC"
     | "VE"
     | "VG"
     | "VI"
     | "VN"
     | "VU"
     | "WF"
     | "WS"
     | "YE"
     | "ZM"
     | "ZW"
     | null;
  company: string;
  city: string;
  role: string;
  phoneNumber: string;
  type: "STANDARD";
  emailNotifications: boolean;
  emailNewsletterUpdates: boolean;
  emailAssetLikeNotifications: boolean;
  emailCommentLikeNotifications: boolean;
}>;

Gets private user information by username.

Parameters

Parameter	Type
client	ApiClient
props	{ params: { userName: string; }; }
props.params?	{ userName: string; }
props.params.userName?	string

Returns

Promise<{ id: number; name: string; createdAt: string; updatedAt: string; email: string; fullName: string; country: | "~" | "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "YE" | "ZM" | "ZW" | null; company: string; city: string; role: string; phoneNumber: string; type: "STANDARD"; emailNotifications: boolean; emailNewsletterUpdates: boolean; emailAssetLikeNotifications: boolean; emailCommentLikeNotifications: boolean; }>

---

updateUser()

function updateUser(client, props): Promise<{
  id: number;
  name: string;
  createdAt: string;
  updatedAt: string;
  email: string;
  fullName: string;
  country:   | "~"
     | "AD"
     | "AE"
     | "AF"
     | "AG"
     | "AI"
     | "AL"
     | "AM"
     | "AO"
     | "AQ"
     | "AR"
     | "AS"
     | "AT"
     | "AU"
     | "AW"
     | "AX"
     | "AZ"
     | "BA"
     | "BB"
     | "BD"
     | "BE"
     | "BF"
     | "BG"
     | "BH"
     | "BI"
     | "BJ"
     | "BL"
     | "BM"
     | "BN"
     | "BO"
     | "BQ"
     | "BR"
     | "BS"
     | "BT"
     | "BV"
     | "BW"
     | "BY"
     | "BZ"
     | "CA"
     | "CC"
     | "CD"
     | "CF"
     | "CG"
     | "CH"
     | "CI"
     | "CK"
     | "CL"
     | "CM"
     | "CN"
     | "CO"
     | "CR"
     | "CU"
     | "CV"
     | "CW"
     | "CX"
     | "CY"
     | "CZ"
     | "DE"
     | "DJ"
     | "DK"
     | "DM"
     | "DO"
     | "DZ"
     | "EC"
     | "EE"
     | "EG"
     | "EH"
     | "ER"
     | "ES"
     | "ET"
     | "FI"
     | "FJ"
     | "FK"
     | "FM"
     | "FO"
     | "FR"
     | "GA"
     | "GB"
     | "GD"
     | "GE"
     | "GF"
     | "GG"
     | "GH"
     | "GI"
     | "GL"
     | "GM"
     | "GN"
     | "GP"
     | "GQ"
     | "GR"
     | "GS"
     | "GT"
     | "GU"
     | "GW"
     | "GY"
     | "HK"
     | "HM"
     | "HN"
     | "HR"
     | "HT"
     | "HU"
     | "ID"
     | "IE"
     | "IL"
     | "IM"
     | "IN"
     | "IO"
     | "IQ"
     | "IR"
     | "IS"
     | "IT"
     | "JE"
     | "JM"
     | "JO"
     | "JP"
     | "KE"
     | "KG"
     | "KH"
     | "KI"
     | "KM"
     | "KN"
     | "KP"
     | "KR"
     | "KW"
     | "KY"
     | "KZ"
     | "LA"
     | "LB"
     | "LC"
     | "LI"
     | "LK"
     | "LR"
     | "LS"
     | "LT"
     | "LU"
     | "LV"
     | "LY"
     | "MA"
     | "MC"
     | "MD"
     | "ME"
     | "MF"
     | "MG"
     | "MH"
     | "MK"
     | "ML"
     | "MM"
     | "MN"
     | "MO"
     | "MP"
     | "MQ"
     | "MR"
     | "MS"
     | "MT"
     | "MU"
     | "MV"
     | "MW"
     | "MX"
     | "MY"
     | "MZ"
     | "NA"
     | "NC"
     | "NE"
     | "NF"
     | "NG"
     | "NI"
     | "NL"
     | "NO"
     | "NP"
     | "NR"
     | "NU"
     | "NZ"
     | "OM"
     | "PA"
     | "PE"
     | "PF"
     | "PG"
     | "PH"
     | "PK"
     | "PL"
     | "PM"
     | "PN"
     | "PR"
     | "PS"
     | "PT"
     | "PW"
     | "PY"
     | "QA"
     | "RE"
     | "RO"
     | "RS"
     | "RU"
     | "RW"
     | "SA"
     | "SB"
     | "SC"
     | "SD"
     | "SE"
     | "SG"
     | "SH"
     | "SI"
     | "SJ"
     | "SK"
     | "SL"
     | "SM"
     | "SN"
     | "SO"
     | "SR"
     | "SS"
     | "ST"
     | "SV"
     | "SY"
     | "SZ"
     | "TC"
     | "TD"
     | "TF"
     | "TG"
     | "TH"
     | "TJ"
     | "TK"
     | "TL"
     | "TM"
     | "TN"
     | "TO"
     | "TR"
     | "TT"
     | "TV"
     | "TW"
     | "TZ"
     | "UA"
     | "UG"
     | "UM"
     | "US"
     | "UY"
     | "UZ"
     | "VA"
     | "VC"
     | "VE"
     | "VG"
     | "VI"
     | "VN"
     | "VU"
     | "WF"
     | "WS"
     | "YE"
     | "ZM"
     | "ZW"
     | null;
  company: string;
  city: string;
  role: string;
  phoneNumber: string;
  type: "STANDARD";
  emailNotifications: boolean;
  emailNewsletterUpdates: boolean;
  emailAssetLikeNotifications: boolean;
  emailCommentLikeNotifications: boolean;
}>;

Updates a user.

Parameters

Parameter	Type
client	ApiClient
props	{ params: { userName: string; }; body: { name?: string; fullName?: string; country?: | "~" | "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "YE" | "ZM" | "ZW" | null; city?: string; role?: string; company?: string; phoneNumber?: string; emailNotifications?: boolean; emailNewsletterUpdates?: boolean; emailAssetLikeNotifications?: boolean; emailCommentLikeNotifications?: boolean; }; }
props.params?	{ userName: string; }
props.params.userName?	string
props.body?	{ name?: string; fullName?: string; country?: | "~" | "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "YE" | "ZM" | "ZW" | null; city?: string; role?: string; company?: string; phoneNumber?: string; emailNotifications?: boolean; emailNewsletterUpdates?: boolean; emailAssetLikeNotifications?: boolean; emailCommentLikeNotifications?: boolean; }
props.body.name?	string
props.body.fullName?	string
props.body.country?	| "~" | "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "YE" | "ZM" | "ZW" | null
props.body.city?	string
props.body.role?	string
props.body.company?	string
props.body.phoneNumber?	string
props.body.emailNotifications?	boolean
props.body.emailNewsletterUpdates?	boolean
props.body.emailAssetLikeNotifications?	boolean
props.body.emailCommentLikeNotifications?	boolean

Returns

Promise<{ id: number; name: string; createdAt: string; updatedAt: string; email: string; fullName: string; country: | "~" | "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "YE" | "ZM" | "ZW" | null; company: string; city: string; role: string; phoneNumber: string; type: "STANDARD"; emailNotifications: boolean; emailNewsletterUpdates: boolean; emailAssetLikeNotifications: boolean; emailCommentLikeNotifications: boolean; }>

---

deleteUser()

function deleteUser(client, props): Promise<void>;

Deletes a user.

Parameters

Parameter	Type
client	ApiClient
props	{ params: { userName: string; }; }
props.params?	{ userName: string; }
props.params.userName?	string

Returns

Promise<void>

---

listUserSessions()

function listUserSessions(client, props): Promise<{
  rows: object[];
  rowCount: number;
}>;

Lists active user sessions for a user with pagination and sorting. SECURITY: Does NOT return userSessionToken - only public session data.

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance
props	{ params: { userName: string; }; query: { pageOffset?: number; pageSize?: number; sortBy?: "createdAt" | "lastUsedAt" | "ipAddress" | "expiresAt"; sortDir?: "asc" | "desc"; }; }	The request properties
props.params?	{ userName: string; }	Path parameters (userName)
props.params.userName?	string	-
props.query?	{ pageOffset?: number; pageSize?: number; sortBy?: "createdAt" | "lastUsedAt" | "ipAddress" | "expiresAt"; sortDir?: "asc" | "desc"; }	Query parameters for pagination and sorting
props.query.pageOffset?	number	-
props.query.pageSize?	number	-
props.query.sortBy?	"createdAt" | "lastUsedAt" | "ipAddress" | "expiresAt"	-
props.query.sortDir?	"asc" | "desc"	-

Returns

Promise<{ rows: object[]; rowCount: number; }>

Promise resolving to a paginated list of user sessions

Operation Id

list-user-sessions

Example

const sessions = await listUserSessions(client, {
  params: { userName: 'john-doe' },
  query: { pageOffset: 0, pageSize: 20 }
});

---

endUserSession()

function endUserSession(client, props): Promise<void>;

Ends a user session by marking it as deleted.

Parameters

Parameter	Type	Description
client	ApiClient	The API client instance
props	{ params: { userName: string; sessionId: number; }; }	The request properties
props.params?	{ userName: string; sessionId: number; }	Path parameters (userName, sessionId)
props.params.userName?	string	-
props.params.sessionId?	number	-

Returns

Promise<void>

Promise resolving when the session is ended

Operation Id

end-user-session

Example

await endUserSession(client, {
  params: { userName: 'john-doe', sessionId: '...' }
});

Classes

ClientFetchError

Extends

• Error

Constructors

Constructor

new ClientFetchError(message, status): ClientFetchError;

Parameters

Parameter	Type
message	string
status	number

Returns

ClientFetchError

Overrides

Error.constructor

Properties

status

status: number;

Enumerations

RefreshTokenType

Enumeration Members

SESSION

SESSION: "SESSION";

API_TOKEN

API_TOKEN: "API_TOKEN";

Namespaces

• Enums

Type Aliases

ApiAuthType

type ApiAuthType = "frontendToken" | "access-token" | "session" | "anonymous";

---

ApiAuthFrontendToken

type ApiAuthFrontendToken = object;

Properties

authType

authType: "frontendToken";

frontendToken

frontendToken: string;

---

ApiAuthSecretToken

type ApiAuthSecretToken = object;

Properties

authType

authType: "secretToken";

secretToken

secretToken: string;

---

ApiAuthUserSession

type ApiAuthUserSession = object;

Properties

authType

authType: "userSession";

userSessionToken

userSessionToken: string;

---

ApiAuthAnonymous

type ApiAuthAnonymous = object;

Properties

authType

authType: "anonymous";

---

ApiAuth

type ApiAuth = 
  | ApiAuthFrontendToken
  | ApiAuthSecretToken
  | ApiAuthUserSession
  | ApiAuthAnonymous;

---

ApiClient

type ApiClient = object;

Properties

axios

axios: AxiosInstance;

host

host: string;

auth

auth: ApiAuth;

validateResults?

validateResults?: boolean;

---

ApiRequest

type ApiRequest = object;

Properties

path

path: string;

params?

params?: Record<string, string | number | boolean | undefined>;

init?

init?: Omit<AxiosRequestConfig, "url" | "params">;

---

CreateInstanceParams

type CreateInstanceParams = object;

Properties

host

host: string;

---

CreateFrontendTokenInstanceParams

type CreateFrontendTokenInstanceParams = CreateInstanceParams & object;

Type Declaration

Name	Type
frontendToken	string

---

CreateSecretTokenInstanceParams

type CreateSecretTokenInstanceParams = CreateInstanceParams & object;

Type Declaration

Name	Type
secretToken	string
accessToken?	string

---

CreateSessionInstanceParams

type CreateSessionInstanceParams = CreateInstanceParams & object;

Type Declaration

Name	Type
userSessionToken	string
accessToken?	string

---

CreateAnonymousClientParams

type CreateAnonymousClientParams = CreateInstanceParams;

---

EventRouterInput

type EventRouterInput = object;

Input shape for routing: type + data (works for SSE events and webhook payloads).

Properties

type

type: string;

data

data: unknown;

---

EventRouterHandlers

type EventRouterHandlers = { [K in ServerEventType]?: (data: Extract<ServerEvent, { type: K }>["data"]) => void };

Handler map: one handler per event type, receives parsed data.

---

CreateEventRouterOptions

type CreateEventRouterOptions = object;

Properties

handlers

handlers: EventRouterHandlers;

onUnknown?

onUnknown?: (type) => void;

Parameters

Parameter	Type
type	string

Returns

void

onParseError?

onParseError?: (type, error) => void;

Parameters

Parameter	Type
type	string
error	z.ZodError

Returns

void

---

EventRouter

type EventRouter = ReturnType<typeof createEventRouter>;

---

FileFormat

type FileFormat = keyof typeof FILE_FORMAT_DEFINITIONS;

---

MimeType

type MimeType = typeof MimeType[number];

---

FileFormatInfo

type FileFormatInfo = object;

Properties

format

format: FileFormat;

name

name: string;

mimeType

mimeType: MimeType;

extension

extension: string;

alternativeExtensions

alternativeExtensions: readonly string[];

alternativeMimeTypes

alternativeMimeTypes: readonly string[];

---

AssetTypeFileMapping

type AssetTypeFileMapping = object;

Properties

fileFormats

fileFormats: readonly FileFormat[];

description

description: string;

---

ListResult

type ListResult<T> = object;

Type Parameters

Type Parameter
T

Properties

rows

rows: T[];

rowCount

rowCount: number;

---

Pagination

type Pagination = z.infer<typeof paginationSchema>;

---

PaginationOptional

type PaginationOptional = z.infer<typeof paginationOptionalSchema>;

---

SortDir

type SortDir = z.infer<typeof sortDirEnum>;

---

Sorting

type Sorting<TField> = object;

Type Parameters

Type Parameter	Default type
TField extends string	string

Properties

sortBy

sortBy: TField;

sortDir

sortDir: SortDir;

---

SortingOptional

type SortingOptional = z.infer<typeof sortingOptionalSchema>;

---

SortingFromFields

type SortingFromFields<TFields> = Sorting<TFields[number]>;

Type Parameters

Type Parameter
TFields extends readonly string[]

---

UserNameParams

type UserNameParams = z.infer<typeof userNameParamsSchema>;

---

AssetParams

type AssetParams = z.infer<typeof assetParamsSchema>;

---

CommentParams

type CommentParams = z.infer<typeof commentParamsSchema>;

---

TaskParams

type TaskParams = z.infer<typeof taskParamsSchema>;

---

BinaryResponse

type BinaryResponse = "arraybuffer" | "stream" | "blob";

---

BinaryResponseType

type BinaryResponseType<T> = T extends "stream" ? Stream : T extends "arraybuffer" ? ArrayBuffer : Blob;

Type Parameters

Type Parameter
T extends BinaryResponse

---

ImageResizeOptions

type ImageResizeOptions = z.infer<typeof ImageResizeOptionsSchema>;

---

ImageTransformFormat

type ImageTransformFormat = z.infer<typeof ImageTransformFormatSchema>;

---

UploadFileProps

type UploadFileProps = object;

Properties

params

params: object;

userName

userName: string;

fileData

fileData: Buffer | Uint8Array;

filename

filename: string;

---

APIToken

type APIToken = z.infer<typeof apiTokenSchema>;

---

ListAPITokenQuery

type ListAPITokenQuery = z.infer<typeof listApiTokensQuerySchema>;

---

ListAPITokenResult

type ListAPITokenResult = z.infer<typeof listApiTokensResultSchema>;

---

ListAPITokenProps

type ListAPITokenProps = z.infer<typeof listApiTokenPropsSchema>;

---

ListAPITokenSortField

type ListAPITokenSortField = typeof listApiSortFields[number];

---

CreateAPITokenQuery

type CreateAPITokenQuery = z.infer<typeof createApiTokenQuerySchema>;

---

CreateAPITokenBody

type CreateAPITokenBody = z.infer<typeof createApiTokenBodySchema>;

---

CreateAPITokenResult

type CreateAPITokenResult = z.infer<typeof apiTokenSchema>;

---

CreateAPITokenProps

type CreateAPITokenProps = z.infer<typeof createApiTokenPropsSchema>;

---

DeleteAPITokenParams

type DeleteAPITokenParams = z.infer<typeof deleteApiTokenParamsSchema>;

---

DeleteAPITokenQuery

type DeleteAPITokenQuery = z.infer<typeof deleteApiTokenQuerySchema>;

---

DeleteAPITokenProps

type DeleteAPITokenProps = z.infer<typeof deleteApiTokenPropsSchema>;

---

MaterialInfo

type MaterialInfo = z.infer<typeof materialInfoSchema>;

---

Asset

type Asset = z.infer<typeof assetSchema>;

---

GetAssetThumbnailParams

type GetAssetThumbnailParams = z.infer<typeof getAssetThumbnailParamsSchema>;

---

GetAssetThumbnailQuery

type GetAssetThumbnailQuery = z.infer<typeof getAssetThumbnailQuerySchema>;

---

ListAssetQuery

type ListAssetQuery = z.infer<typeof listAssetsQuerySchema>;

---

ListAssetResult

type ListAssetResult = z.infer<typeof listAssetsResultSchema>;

---

ListAssetProps

type ListAssetProps = z.infer<typeof listAssetPropsSchema>;

---

ListAssetSortField

type ListAssetSortField = typeof listAssetSortFields[number];

---

CreateAssetParams

type CreateAssetParams = z.infer<typeof createAssetParamsSchema>;

---

CreateAssetBody

type CreateAssetBody = z.infer<typeof createAssetBodySchema>;

---

CreateAssetResult

type CreateAssetResult = z.infer<typeof assetSchema>;

---

CreateAssetProps

type CreateAssetProps = z.infer<typeof createAssetPropsSchema>;

---

GetAssetParams

type GetAssetParams = z.infer<typeof getAssetParamsSchema>;

---

GetAssetResult

type GetAssetResult = z.infer<typeof assetSchema>;

---

GetAssetProps

type GetAssetProps = z.infer<typeof getAssetPropsSchema>;

---

UpdateAssetParams

type UpdateAssetParams = z.infer<typeof updateAssetParamsSchema>;

---

UpdateAssetBody

type UpdateAssetBody = z.infer<typeof updateAssetBodySchema>;

---

UpdateAssetResult

type UpdateAssetResult = z.infer<typeof assetSchema>;

---

UpdateAssetProps

type UpdateAssetProps = z.infer<typeof updateAssetPropsSchema>;

---

DeleteAssetParams

type DeleteAssetParams = z.infer<typeof deleteAssetParamsSchema>;

---

DeleteAssetProps

type DeleteAssetProps = z.infer<typeof deleteAssetPropsSchema>;

---

PrepareAssetUploadParams

type PrepareAssetUploadParams = z.infer<typeof prepareAssetUploadParamsSchema>;

---

PrepareAssetUploadBody

type PrepareAssetUploadBody = z.infer<typeof prepareAssetUploadBodySchema>;

---

PrepareAssetUploadResult

type PrepareAssetUploadResult = z.infer<typeof prepareAssetUploadResultSchema>;

---

PrepareAssetUploadProps

type PrepareAssetUploadProps = z.infer<typeof prepareAssetUploadPropsSchema>;

---

RefreshAccessTokenBody

type RefreshAccessTokenBody = z.infer<typeof refreshAccessTokenBodySchema>;

---

RefreshAccessTokenResult

type RefreshAccessTokenResult = z.infer<typeof refreshAccessTokenResultSchema>;

---

RefreshAccessTokenProps

type RefreshAccessTokenProps = z.infer<typeof refreshAccessTokenPropsSchema>;

---

OAuthTokenRequestBody

type OAuthTokenRequestBody = z.infer<typeof oauthTokenRequestBodySchema>;

---

OAuthTokenResult

type OAuthTokenResult = z.infer<typeof oauthTokenResultSchema>;

---

ExchangeAuthorizationCodeProps

type ExchangeAuthorizationCodeProps = z.infer<typeof exchangeAuthorizationCodePropsSchema>;

---

OAuthConsentBody

type OAuthConsentBody = z.infer<typeof oauthConsentBodySchema>;

---

DeleteRefreshTokenParams

type DeleteRefreshTokenParams = z.infer<typeof deleteRefreshTokenParamsSchema>;

---

DeleteRefreshTokenProps

type DeleteRefreshTokenProps = z.infer<typeof deleteRefreshTokenPropsSchema>;

---

UploadAvatarQuery

type UploadAvatarQuery = z.infer<typeof uploadAvatarQuerySchema>;

---

UploadAvatarBody

type UploadAvatarBody = z.infer<typeof uploadAvatarBodySchema>;

---

UploadAvatarProps

type UploadAvatarProps = z.infer<typeof uploadAvatarPropsSchema>;

---

GetAvatarQuery

type GetAvatarQuery = z.infer<typeof getAvatarQuerySchema>;

---

GetAvatarProps

type GetAvatarProps = z.infer<typeof getAvatarPropsSchema>;

---

DeleteAvatarQuery

type DeleteAvatarQuery = z.infer<typeof deleteAvatarQuerySchema>;

---

DeleteAvatarProps

type DeleteAvatarProps = z.infer<typeof deleteAvatarPropsSchema>;

---

Comment

type Comment = z.infer<typeof commentSchema>;

---

CreateCommentParams

type CreateCommentParams = AssetParams;

---

CreateCommentBody

type CreateCommentBody = z.infer<typeof createCommentBodySchema>;

---

CreateCommentResult

type CreateCommentResult = z.infer<typeof commentSchema>;

---

CreateCommentProps

type CreateCommentProps = z.infer<typeof createCommentPropsSchema>;

---

ListCommentQuery

type ListCommentQuery = z.infer<typeof listCommentsQuerySchema>;

---

ListCommentResult

type ListCommentResult = z.infer<typeof listCommentsResultSchema>;

---

ListCommentProps

type ListCommentProps = z.infer<typeof listCommentPropsSchema>;

---

ListCommentSortField

type ListCommentSortField = typeof listCommentSortFields[number];

---

EditCommentParams

type EditCommentParams = CommentParams;

---

EditCommentBody

type EditCommentBody = z.infer<typeof editCommentBodySchema>;

---

EditCommentResult

type EditCommentResult = z.infer<typeof commentSchema>;

---

EditCommentProps

type EditCommentProps = z.infer<typeof editCommentPropsSchema>;

---

DeleteCommentParams

type DeleteCommentParams = CommentParams;

---

DeleteCommentProps

type DeleteCommentProps = z.infer<typeof deleteCommentPropsSchema>;

---

FileParams

type FileParams = z.infer<typeof fileParamsSchema>;

---

FileQuery

type FileQuery = z.infer<typeof fileQuerySchema>;

---

GetFileProps

type GetFileProps = z.infer<typeof getFilePropsSchema>;

---

GetAssetMediaParams

type GetAssetMediaParams = z.infer<typeof getAssetMediaParamsSchema>;

---

MediaParams

type MediaParams = z.infer<typeof mediaParamsSchema>;

---

MediaOriginalQuery

type MediaOriginalQuery = z.infer<typeof mediaOriginalQuerySchema>;

---

Notification

type Notification = z.infer<typeof notificationSchema>;

---

ListNotificationQuery

type ListNotificationQuery = z.infer<typeof listNotificationsQuerySchema>;

---

ListNotificationResult

type ListNotificationResult = z.infer<typeof listNotificationsResultSchema>;

---

ListNotificationProps

type ListNotificationProps = z.infer<typeof listNotificationPropsSchema>;

---

ListNotificationSortField

type ListNotificationSortField = typeof listNotificationSortFields[number];

---

MarkNotificationAsReadParams

type MarkNotificationAsReadParams = z.infer<typeof markNotificationAsReadParamsSchema>;

---

MarkNotificationAsReadBody

type MarkNotificationAsReadBody = z.infer<typeof markNotificationAsReadBodySchema>;

---

MarkNotificationAsReadProps

type MarkNotificationAsReadProps = z.infer<typeof markNotificationAsReadPropsSchema>;

---

MarkAllNotificationsAsReadBody

type MarkAllNotificationsAsReadBody = z.infer<typeof markAllNotificationsAsReadBodySchema>;

---

MarkAllNotificationsAsReadResult

type MarkAllNotificationsAsReadResult = z.infer<typeof markAllNotificationsAsReadResultSchema>;

---

MarkAllNotificationsAsReadProps

type MarkAllNotificationsAsReadProps = z.infer<typeof markAllNotificationsAsReadPropsSchema>;

---

GetOEmbedQuery

type GetOEmbedQuery = z.infer<typeof getOEmbedQuerySchema>;

---

OEmbedResponse

type OEmbedResponse = z.infer<typeof oEmbedResponseSchema>;

---

GetOEmbedResult

type GetOEmbedResult = OEmbedResponse;

---

GetOEmbedProps

type GetOEmbedProps = z.infer<typeof getOEmbedPropsSchema>;

---

ServerEventType

type ServerEventType = keyof typeof serverEventDataSchemas;

---

ServerEvent

type ServerEvent = { [K in ServerEventType]: { type: K; userId: number; data: z.infer<typeof serverEventDataSchemas[K]> } }[ServerEventType];

---

SubscribeToServerEventsOptions

type SubscribeToServerEventsOptions = object;

Properties

path?

path?: string;

---

ServerEventsSubscription

type ServerEventsSubscription = object;

Methods

addEventListener()

addEventListener<K>(type, handler): void;

Type Parameters

Type Parameter
K extends | "asset.created" | "asset.deleted" | "asset.liked" | "asset.moderated" | "asset.updated" | "comment.liked" | "comment.moderated" | "comment.new" | "comment.updated" | "external-auth.approved" | "notification.new"

Parameters

Parameter	Type
type	K
handler	(data) => void

Returns

void

close()

close(): void;

Returns

void

---

TaskWithStatusAndResults

type TaskWithStatusAndResults = z.infer<typeof taskWithStatusAndResultsSchema>;

---

GetTaskParams

type GetTaskParams = z.infer<typeof getTaskParamsSchema>;

---

GetTaskResult

type GetTaskResult = z.infer<typeof getTaskResultSchema>;

---

TaskEventType

type TaskEventType = keyof typeof taskEventDataSchemas;

---

TaskEvent

type TaskEvent = { [K in TaskEventType]: { sequence: number; type: K; data: z.infer<typeof taskEventDataSchemas[K]> } }[TaskEventType];

---

GetTaskEventsQuery

type GetTaskEventsQuery = z.infer<typeof getTaskEventsQuerySchema>;

---

GetTaskProps

type GetTaskProps = object;

Properties

params

params: GetTaskParams;

---

SubscribeToTaskEventsProps

type SubscribeToTaskEventsProps = object;

Properties

params

params: object;

userName

userName: string;

taskId

taskId: number;

query?

query?: GetTaskEventsQuery;

---

TaskEventsSubscription

type TaskEventsSubscription = object;

Methods

addEventListener()

addEventListener<K>(type, handler): void;

Type Parameters

Type Parameter
K extends "task.queued" | "task.running" | "task.success" | "task.failure"

Parameters

Parameter	Type
type	K
handler	(data) => void

Returns

void

close()

close(): void;

Returns

void

---

WaitForTaskCompletionProps

type WaitForTaskCompletionProps = object;

Properties

params

params: object;

userName

userName: string;

taskId

taskId: number;

timeoutMs?

timeoutMs?: number;

---

User

type User = z.infer<typeof userSchema>;

---

PrivateUser

type PrivateUser = z.infer<typeof privateUserSchema>;

---

ListUserQuery

type ListUserQuery = z.infer<typeof listUsersQuerySchema>;

---

ListUserResult

type ListUserResult = z.infer<typeof listUsersResultSchema>;

---

ListUserProps

type ListUserProps = z.infer<typeof listUserPropsSchema>;

---

ListUserSortField

type ListUserSortField = typeof listUserSortFields[number];

---

GetUserParams

type GetUserParams = z.infer<typeof getUserParamsSchema>;

---

GetUserResult

type GetUserResult = z.infer<typeof userSchema>;

---

GetUserProps

type GetUserProps = z.infer<typeof getUserPropsSchema>;

---

GetUserPrivateParams

type GetUserPrivateParams = z.infer<typeof getUserPrivateParamsSchema>;

---

GetUserPrivateResult

type GetUserPrivateResult = z.infer<typeof privateUserSchema>;

---

GetUserPrivateProps

type GetUserPrivateProps = z.infer<typeof getUserPrivatePropsSchema>;

---

UpdateUserParams

type UpdateUserParams = z.infer<typeof updateUserParamsSchema>;

---

UpdateUserBody

type UpdateUserBody = z.infer<typeof updateUserBodySchema>;

---

UpdateUserResult

type UpdateUserResult = z.infer<typeof privateUserSchema>;

---

UpdateUserProps

type UpdateUserProps = z.infer<typeof updateUserPropsSchema>;

---

DeleteUserParams

type DeleteUserParams = z.infer<typeof deleteUserParamsSchema>;

---

DeleteUserProps

type DeleteUserProps = z.infer<typeof deleteUserPropsSchema>;

---

UserSession

type UserSession = z.infer<typeof userSessionSchema>;

---

ListUserSessionsQuery

type ListUserSessionsQuery = z.infer<typeof listUserSessionsQuerySchema>;

---

ListUserSessionsResult

type ListUserSessionsResult = z.infer<typeof listUserSessionsResultSchema>;

---

ListUserSessionsParams

type ListUserSessionsParams = z.infer<typeof listUserSessionsParamsSchema>;

---

ListUserSessionsProps

type ListUserSessionsProps = z.infer<typeof listUserSessionsPropsSchema>;

---

ListUserSessionsSortField

type ListUserSessionsSortField = typeof listUserSessionsSortFieldsExport[number];

---

EndUserSessionParams

type EndUserSessionParams = z.infer<typeof endUserSessionParamsSchema>;

---

EndUserSessionProps

type EndUserSessionProps = z.infer<typeof endUserSessionPropsSchema>;

Variables

dashboardUserLinkRegex

const dashboardUserLinkRegex: RegExp;

---

dashboardAssetLinkRegex

const dashboardAssetLinkRegex: RegExp;

---

dashboardAssetCommentLinkRegex

const dashboardAssetCommentLinkRegex: RegExp;

---

dashboardSettingsInvitesLinkRegex

const dashboardSettingsInvitesLinkRegex: RegExp;

---

validDashboardLinkTargets

const validDashboardLinkTargets: RegExp[];

---

FileFormat

FileFormat: ("jpg" | "png" | "webp" | "gif" | "mtlx" | "mtlxzip")[];

---

MimeType

const MimeType: readonly (
  | "image/gif"
  | "image/jpeg"
  | "application/xml"
  | "application/zip"
  | "image/png"
  | "image/webp")[];

---

FileFormatToFileFormatInfo

const FileFormatToFileFormatInfo: Record<FileFormat, FileFormatInfo>;

---

MATERIAL_ASSET_FILE_FORMATS

const MATERIAL_ASSET_FILE_FORMATS: readonly ["mtlx", "mtlxzip"];

---

ASSET_TYPE_FILE_MAPPINGS

const ASSET_TYPE_FILE_MAPPINGS: Record<AssetType, AssetTypeFileMapping>;

---

AVATAR_FILE_FORMATS

const AVATAR_FILE_FORMATS: readonly ["png", "jpg", "gif", "webp"];

---

paginationSchema

const paginationSchema: ZodObject<{
  pageOffset: ZodDefault<ZodCoercedNumber<unknown>>;
  pageSize: ZodDefault<ZodCoercedNumber<unknown>>;
}, $strip>;

---

paginationOptionalSchema

const paginationOptionalSchema: ZodObject<{
  pageOffset: ZodOptional<ZodCoercedNumber<unknown>>;
  pageSize: ZodOptional<ZodCoercedNumber<unknown>>;
}, $strip>;

---

sortDirEnum

const sortDirEnum: ZodEnum<{
  asc: "asc";
  desc: "desc";
}>;

---

sortingSchema

const sortingSchema: ZodObject<{
  sortBy: ZodString;
  sortDir: ZodDefault<ZodEnum<{
     asc: "asc";
     desc: "desc";
  }>>;
}, $strip>;

---

sortingOptionalSchema

const sortingOptionalSchema: ZodObject<{
  sortBy: ZodOptional<ZodString>;
  sortDir: ZodOptional<ZodEnum<{
     asc: "asc";
     desc: "desc";
  }>>;
}, $strip>;

---

descriptionSchema

const descriptionSchema: ZodString;

---

shortDescriptionSchema

const shortDescriptionSchema: ZodString;

---

nullableDescriptionSchema

const nullableDescriptionSchema: ZodNullable<ZodString>;

---

assetVisibilitySchema

const assetVisibilitySchema: ZodEnum<{
  PRIVATE: "PRIVATE";
  UNLISTED: "UNLISTED";
  PUBLIC: "PUBLIC";
}>;

---

aiUsageSchema

const aiUsageSchema: ZodEnum<{
  UNDISCLOSED: "UNDISCLOSED";
  AI_USED: "AI_USED";
  AI_FREE: "AI_FREE";
}>;

---

commentTextSchema

const commentTextSchema: ZodString;

---

jwtSchema

const jwtSchema: ZodString;

---

booleanPropSchema

const booleanPropSchema: ZodUnion<readonly [ZodBoolean, ZodCodec<ZodString, ZodBoolean>]>;

Accepts either a boolean or a stringbool (e.g. "true"/"false", "1"/"0") for use in params and query schemas. Use consistently so callers can pass either from query strings or programmatically.

---

coreEntityNameRegex

const coreEntityNameRegex: "[a-zA-Z][a-zA-Z0-9]*(?:-[a-zA-Z0-9]+)*" = '[a-zA-Z][a-zA-Z0-9]*(?:-[a-zA-Z0-9]+)*';

---

entityNameRegex

const entityNameRegex: RegExp;

---

userNameSchema

const userNameSchema: ZodString;

---

userNameParamsSchema

const userNameParamsSchema: ZodObject<{
  userName: ZodString;
}, $strict>;

---

standardUserNameSchema

const standardUserNameSchema: ZodString;

---

assetNameSchema

const assetNameSchema: ZodString;

---

assetParamsSchema

const assetParamsSchema: ZodObject<{
  userName: ZodString;
  assetName: ZodString;
}, $strict>;

---

commentParamsSchema

const commentParamsSchema: ZodObject<{
  userName: ZodString;
  assetName: ZodString;
  commentId: ZodCoercedNumber<unknown>;
}, $strict>;

---

taskParamsSchema

const taskParamsSchema: ZodObject<{
  userName: ZodString;
}, $strict>;

---

apiTokenNameSchema

const apiTokenNameSchema: ZodString;

---

imageResizeOptionsSchemaProps

const imageResizeOptionsSchemaProps: object;

Type Declaration

Name	Type
width	ZodOptional<ZodCoercedNumber<unknown>>
height	ZodOptional<ZodCoercedNumber<unknown>>
quality	ZodOptional<ZodCoercedNumber<unknown>>

---

ImageResizeOptionsSchema

const ImageResizeOptionsSchema: ZodObject<{
  width: ZodOptional<ZodCoercedNumber<unknown>>;
  height: ZodOptional<ZodCoercedNumber<unknown>>;
  quality: ZodOptional<ZodCoercedNumber<unknown>>;
}, $strict>;

---

ImageTransformFormatSchema

const ImageTransformFormatSchema: ZodEnum<{
  jpg: "jpg";
  png: "png";
  webp: "webp";
  avif: "avif";
}>;

---

imageTransformOptionsSchemaProps

const imageTransformOptionsSchemaProps: object;

Type Declaration

Name	Type
width	ZodOptional<ZodCoercedNumber<unknown>>
height	ZodOptional<ZodCoercedNumber<unknown>>
quality	ZodOptional<ZodCoercedNumber<unknown>>
format	ZodOptional<ZodEnum<{ jpg: "jpg"; png: "png"; webp: "webp"; avif: "avif"; }>>

---

ImageTransformOptionsSchema

const ImageTransformOptionsSchema: ZodObject<{
  width: ZodOptional<ZodCoercedNumber<unknown>>;
  height: ZodOptional<ZodCoercedNumber<unknown>>;
  quality: ZodOptional<ZodCoercedNumber<unknown>>;
  format: ZodOptional<ZodEnum<{
     jpg: "jpg";
     png: "png";
     webp: "webp";
     avif: "avif";
  }>>;
}, $strict>;

---

apiTokenSchema

const apiTokenSchema: ZodObject<{
  id: ZodNumber;
  name: ZodString;
  description: ZodString;
  token: ZodDefault<ZodString>;
  type: ZodEnum<{
     SECRET: "SECRET";
     FRONTEND: "FRONTEND";
  }>;
  domainWhitelist: ZodNullable<ZodString>;
  lastUsedAt: ZodNullable<ZodISODateTime>;
  usedCount: ZodNumber;
  createdAt: ZodISODateTime;
  updatedAt: ZodISODateTime;
  userId: ZodNumber;
  userName: ZodString;
}, $strip>;

---

listApiTokensSortFields

const listApiTokensSortFields: readonly ["createdAt", "updatedAt", "name", "lastUsedAt", "usedCount"];

---

listApiTokensQuerySchema

const listApiTokensQuerySchema: ZodObject<{
  pageOffset: ZodOptional<ZodCoercedNumber<unknown>>;
  pageSize: ZodOptional<ZodCoercedNumber<unknown>>;
  sortBy: ZodOptional<ZodEnum<{
     name: "name";
     createdAt: "createdAt";
     updatedAt: "updatedAt";
     lastUsedAt: "lastUsedAt";
     usedCount: "usedCount";
  }>>;
  sortDir: ZodOptional<ZodEnum<{
     asc: "asc";
     desc: "desc";
  }>>;
  userName: ZodString;
  tokenType: ZodOptional<ZodEnum<{
     SECRET: "SECRET";
     FRONTEND: "FRONTEND";
  }>>;
}, $strict>;

---

listApiTokensResultSchema

const listApiTokensResultSchema: ZodObject<{
  rows: ZodArray<ZodObject<{
     id: ZodNumber;
     name: ZodString;
     description: ZodString;
     token: ZodDefault<ZodString>;
     type: ZodEnum<{
        SECRET: "SECRET";
        FRONTEND: "FRONTEND";
     }>;
     domainWhitelist: ZodNullable<ZodString>;
     lastUsedAt: ZodNullable<ZodISODateTime>;
     usedCount: ZodNumber;
     createdAt: ZodISODateTime;
     updatedAt: ZodISODateTime;
     userId: ZodNumber;
     userName: ZodString;
  }, $strip>>;
  rowCount: ZodInt;
}, $strict>;

---

listApiTokenPropsSchema

const listApiTokenPropsSchema: ZodObject<{
  query: ZodObject<{
     pageOffset: ZodOptional<ZodCoercedNumber<unknown>>;
     pageSize: ZodOptional<ZodCoercedNumber<unknown>>;
     sortBy: ZodOptional<ZodEnum<{
        name: "name";
        createdAt: "createdAt";
        updatedAt: "updatedAt";
        lastUsedAt: "lastUsedAt";
        usedCount: "usedCount";
     }>>;
     sortDir: ZodOptional<ZodEnum<{
        asc: "asc";
        desc: "desc";
     }>>;
     userName: ZodString;
     tokenType: ZodOptional<ZodEnum<{
        SECRET: "SECRET";
        FRONTEND: "FRONTEND";
     }>>;
  }, $strict>;
}, $strict>;

---

createApiTokenQuerySchema

const createApiTokenQuerySchema: ZodObject<{
  userName: ZodString;
}, $strict>;

---

createApiTokenBodySchema

const createApiTokenBodySchema: ZodObject<{
  name: ZodString;
  description: ZodOptional<ZodString>;
  type: ZodEnum<{
     SECRET: "SECRET";
     FRONTEND: "FRONTEND";
  }>;
  domainWhitelist: ZodOptional<ZodString>;
}, $strict>;

---

createApiTokenPropsSchema

const createApiTokenPropsSchema: ZodObject<{
  query: ZodObject<{
     userName: ZodString;
  }, $strict>;
  body: ZodObject<{
     name: ZodString;
     description: ZodOptional<ZodString>;
     type: ZodEnum<{
        SECRET: "SECRET";
        FRONTEND: "FRONTEND";
     }>;
     domainWhitelist: ZodOptional<ZodString>;
  }, $strict>;
}, $strict>;

---

deleteApiTokenParamsSchema

const deleteApiTokenParamsSchema: ZodObject<{
  apiTokenName: ZodString;
}, $strict>;

---

deleteApiTokenQuerySchema

const deleteApiTokenQuerySchema: ZodObject<{
  userName: ZodString;
}, $strict>;

---

deleteApiTokenPropsSchema

const deleteApiTokenPropsSchema: ZodObject<{
  params: ZodObject<{
     apiTokenName: ZodString;
  }, $strict>;
  query: ZodObject<{
     userName: ZodString;
  }, $strict>;
}, $strict>;

---

materialInfoSchema

const materialInfoSchema: ZodObject<{
  version: ZodOptional<ZodString>;
  colorspace: ZodOptional<ZodString>;
  materials: ZodArray<ZodObject<{
     name: ZodOptional<ZodString>;
     category: ZodString;
  }, $strip>>;
  nodeGraphCount: ZodNumber;
  topLevelNodeCount: ZodNumber;
  referencedTextures: ZodArray<ZodString>;
  warnings: ZodArray<ZodString>;
}, $strip>;

---

assetSchema

const assetSchema: ZodObject<{
  id: ZodNumber;
  name: ZodString;
  type: ZodEnum<{
     MATERIAL: "MATERIAL";
  }>;
  visibility: ZodEnum<{
     PRIVATE: "PRIVATE";
     UNLISTED: "UNLISTED";
     PUBLIC: "PUBLIC";
  }>;
  userId: ZodNumber;
  userName: ZodString;
  description: ZodString;
  keywords: ZodString;
  shareLicense: ZodEnum<{
     NONE: "NONE";
     CC_0: "CC_0";
     CC_BY: "CC_BY";
     CC_BY_SA: "CC_BY_SA";
     CC_BY_NC: "CC_BY_NC";
     CC_BY_NC_SA: "CC_BY_NC_SA";
     CC_BY_ND: "CC_BY_ND";
     CC_BY_NC_ND: "CC_BY_NC_ND";
  }>;
  aiUsage: ZodEnum<{
     UNDISCLOSED: "UNDISCLOSED";
     AI_USED: "AI_USED";
     AI_FREE: "AI_FREE";
  }>;
  commentMode: ZodEnum<{
     NONE: "NONE";
     ENABLED: "ENABLED";
     MEMBERS_ONLY: "MEMBERS_ONLY";
  }>;
  reported: ZodBoolean;
  likeCount: ZodInt;
  shareCount: ZodInt;
  createdAt: ZodISODateTime;
  updatedAt: ZodISODateTime;
  archived: ZodBoolean;
  metadata: ZodString;
  versionOriginalSize: ZodOptional<ZodNullable<ZodNumber>>;
  width: ZodOptional<ZodNullable<ZodNumber>>;
  height: ZodOptional<ZodNullable<ZodNumber>>;
  depth: ZodOptional<ZodNullable<ZodNumber>>;
  fileOid: ZodString;
  thumbnailOid: ZodOptional<ZodNullable<ZodString>>;
  materialInfo: ZodOptional<ZodObject<{
     version: ZodOptional<ZodString>;
     colorspace: ZodOptional<ZodString>;
     materials: ZodArray<ZodObject<{
        name: ZodOptional<ZodString>;
        category: ZodString;
     }, $strip>>;
     nodeGraphCount: ZodNumber;
     topLevelNodeCount: ZodNumber;
     referencedTextures: ZodArray<ZodString>;
     warnings: ZodArray<ZodString>;
  }, $strip>>;
}, $strip>;

---

getAssetThumbnailParamsSchema

const getAssetThumbnailParamsSchema: ZodObject<{
  userName: ZodString;
  assetName: ZodString;
}, $strict> = assetParamsSchema;

---

getAssetThumbnailQuerySchema

const getAssetThumbnailQuerySchema: ZodObject<{
  width: ZodOptional<ZodCoercedNumber<unknown>>;
  height: ZodOptional<ZodCoercedNumber<unknown>>;
  quality: ZodOptional<ZodCoercedNumber<unknown>>;
  format: ZodOptional<ZodEnum<{
     jpg: "jpg";
     png: "png";
     webp: "webp";
     avif: "avif";
  }>>;
  redirectOnNotFound: ZodOptional<ZodURL>;
}, $strict>;

---

listAssetsSortFields

const listAssetsSortFields: readonly ["createdAt", "updatedAt", "name", "likeCount", "shareCount"];

---

listAssetsQuerySchema

const listAssetsQuerySchema: ZodObject<{
  pageOffset: ZodOptional<ZodCoercedNumber<unknown>>;
  pageSize: ZodOptional<ZodCoercedNumber<unknown>>;
  sortBy: ZodOptional<ZodEnum<{
     name: "name";
     likeCount: "likeCount";
     shareCount: "shareCount";
     createdAt: "createdAt";
     updatedAt: "updatedAt";
  }>>;
  sortDir: ZodOptional<ZodEnum<{
     asc: "asc";
     desc: "desc";
  }>>;
  visibility: ZodOptional<ZodEnum<{
     PRIVATE: "PRIVATE";
     UNLISTED: "UNLISTED";
     PUBLIC: "PUBLIC";
  }>>;
  searchText: ZodOptional<ZodString>;
  type: ZodOptional<ZodEnum<{
     MATERIAL: "MATERIAL";
  }>>;
  userName: ZodOptional<ZodString>;
  archived: ZodOptional<ZodUnion<readonly [ZodBoolean, ZodCodec<ZodString, ZodBoolean>]>>;
}, $strict>;

---

listAssetsResultSchema

const listAssetsResultSchema: ZodObject<{
  rows: ZodArray<ZodObject<{
     id: ZodNumber;
     name: ZodString;
     type: ZodEnum<{
        MATERIAL: "MATERIAL";
     }>;
     visibility: ZodEnum<{
        PRIVATE: "PRIVATE";
        UNLISTED: "UNLISTED";
        PUBLIC: "PUBLIC";
     }>;
     userId: ZodNumber;
     userName: ZodString;
     description: ZodString;
     keywords: ZodString;
     shareLicense: ZodEnum<{
        NONE: "NONE";
        CC_0: "CC_0";
        CC_BY: "CC_BY";
        CC_BY_SA: "CC_BY_SA";
        CC_BY_NC: "CC_BY_NC";
        CC_BY_NC_SA: "CC_BY_NC_SA";
        CC_BY_ND: "CC_BY_ND";
        CC_BY_NC_ND: "CC_BY_NC_ND";
     }>;
     aiUsage: ZodEnum<{
        UNDISCLOSED: "UNDISCLOSED";
        AI_USED: "AI_USED";
        AI_FREE: "AI_FREE";
     }>;
     commentMode: ZodEnum<{
        NONE: "NONE";
        ENABLED: "ENABLED";
        MEMBERS_ONLY: "MEMBERS_ONLY";
     }>;
     reported: ZodBoolean;
     likeCount: ZodInt;
     shareCount: ZodInt;
     createdAt: ZodISODateTime;
     updatedAt: ZodISODateTime;
     archived: ZodBoolean;
     metadata: ZodString;
     versionOriginalSize: ZodOptional<ZodNullable<ZodNumber>>;
     width: ZodOptional<ZodNullable<ZodNumber>>;
     height: ZodOptional<ZodNullable<ZodNumber>>;
     depth: ZodOptional<ZodNullable<ZodNumber>>;
     fileOid: ZodString;
     thumbnailOid: ZodOptional<ZodNullable<ZodString>>;
     materialInfo: ZodOptional<ZodObject<{
        version: ZodOptional<ZodString>;
        colorspace: ZodOptional<ZodString>;
        materials: ZodArray<ZodObject<{
           name: ...;
           category: ...;
        }, $strip>>;
        nodeGraphCount: ZodNumber;
        topLevelNodeCount: ZodNumber;
        referencedTextures: ZodArray<ZodString>;
        warnings: ZodArray<ZodString>;
     }, $strip>>;
  }, $strip>>;
  rowCount: ZodInt;
}, $strict>;

---

listAssetPropsSchema

const listAssetPropsSchema: ZodObject<{
  query: ZodObject<{
     pageOffset: ZodOptional<ZodCoercedNumber<unknown>>;
     pageSize: ZodOptional<ZodCoercedNumber<unknown>>;
     sortBy: ZodOptional<ZodEnum<{
        name: "name";
        likeCount: "likeCount";
        shareCount: "shareCount";
        createdAt: "createdAt";
        updatedAt: "updatedAt";
     }>>;
     sortDir: ZodOptional<ZodEnum<{
        asc: "asc";
        desc: "desc";
     }>>;
     visibility: ZodOptional<ZodEnum<{
        PRIVATE: "PRIVATE";
        UNLISTED: "UNLISTED";
        PUBLIC: "PUBLIC";
     }>>;
     searchText: ZodOptional<ZodString>;
     type: ZodOptional<ZodEnum<{
        MATERIAL: "MATERIAL";
     }>>;
     userName: ZodOptional<ZodString>;
     archived: ZodOptional<ZodUnion<readonly [ZodBoolean, ZodCodec<ZodString, ZodBoolean>]>>;
  }, $strict>;
}, $strict>;

---

createAssetParamsSchema

const createAssetParamsSchema: ZodObject<{
  userName: ZodString;
}, $strict> = userNameParamsSchema;

---

createAssetBodySchema

const createAssetBodySchema: ZodObject<{
  name: ZodString;
  description: ZodOptional<ZodString>;
  type: ZodEnum<{
     MATERIAL: "MATERIAL";
  }>;
  uploadToken: ZodString;
  visibility: ZodEnum<{
     PRIVATE: "PRIVATE";
     UNLISTED: "UNLISTED";
     PUBLIC: "PUBLIC";
  }>;
  shareLicense: ZodEnum<{
     NONE: "NONE";
     CC_0: "CC_0";
     CC_BY: "CC_BY";
     CC_BY_SA: "CC_BY_SA";
     CC_BY_NC: "CC_BY_NC";
     CC_BY_NC_SA: "CC_BY_NC_SA";
     CC_BY_ND: "CC_BY_ND";
     CC_BY_NC_ND: "CC_BY_NC_ND";
  }>;
  aiUsage: ZodOptional<ZodEnum<{
     UNDISCLOSED: "UNDISCLOSED";
     AI_USED: "AI_USED";
     AI_FREE: "AI_FREE";
  }>>;
  commentMode: ZodOptional<ZodEnum<{
     NONE: "NONE";
     ENABLED: "ENABLED";
     MEMBERS_ONLY: "MEMBERS_ONLY";
  }>>;
  metadata: ZodOptional<ZodString>;
}, $strict>;

---

createAssetPropsSchema

const createAssetPropsSchema: ZodObject<{
  params: ZodObject<{
     userName: ZodString;
  }, $strict>;
  body: ZodObject<{
     name: ZodString;
     description: ZodOptional<ZodString>;
     type: ZodEnum<{
        MATERIAL: "MATERIAL";
     }>;
     uploadToken: ZodString;
     visibility: ZodEnum<{
        PRIVATE: "PRIVATE";
        UNLISTED: "UNLISTED";
        PUBLIC: "PUBLIC";
     }>;
     shareLicense: ZodEnum<{
        NONE: "NONE";
        CC_0: "CC_0";
        CC_BY: "CC_BY";
        CC_BY_SA: "CC_BY_SA";
        CC_BY_NC: "CC_BY_NC";
        CC_BY_NC_SA: "CC_BY_NC_SA";
        CC_BY_ND: "CC_BY_ND";
        CC_BY_NC_ND: "CC_BY_NC_ND";
     }>;
     aiUsage: ZodOptional<ZodEnum<{
        UNDISCLOSED: "UNDISCLOSED";
        AI_USED: "AI_USED";
        AI_FREE: "AI_FREE";
     }>>;
     commentMode: ZodOptional<ZodEnum<{
        NONE: "NONE";
        ENABLED: "ENABLED";
        MEMBERS_ONLY: "MEMBERS_ONLY";
     }>>;
     metadata: ZodOptional<ZodString>;
  }, $strict>;
}, $strict>;

---

getAssetParamsSchema

const getAssetParamsSchema: ZodObject<{
  userName: ZodString;
  assetName: ZodString;
}, $strict> = assetParamsSchema;

---

getAssetPropsSchema

const getAssetPropsSchema: ZodObject<{
  params: ZodObject<{
     userName: ZodString;
     assetName: ZodString;
  }, $strict>;
}, $strict>;

---

updateAssetParamsSchema

const updateAssetParamsSchema: ZodObject<{
  userName: ZodString;
  assetName: ZodString;
}, $strict> = assetParamsSchema;

---

updateAssetBodySchema

const updateAssetBodySchema: ZodObject<{
  name: ZodOptional<ZodString>;
  description: ZodOptional<ZodString>;
  keywords: ZodOptional<ZodString>;
  visibility: ZodOptional<ZodEnum<{
     PRIVATE: "PRIVATE";
     UNLISTED: "UNLISTED";
     PUBLIC: "PUBLIC";
  }>>;
  shareLicense: ZodOptional<ZodEnum<{
     NONE: "NONE";
     CC_0: "CC_0";
     CC_BY: "CC_BY";
     CC_BY_SA: "CC_BY_SA";
     CC_BY_NC: "CC_BY_NC";
     CC_BY_NC_SA: "CC_BY_NC_SA";
     CC_BY_ND: "CC_BY_ND";
     CC_BY_NC_ND: "CC_BY_NC_ND";
  }>>;
  aiUsage: ZodOptional<ZodEnum<{
     UNDISCLOSED: "UNDISCLOSED";
     AI_USED: "AI_USED";
     AI_FREE: "AI_FREE";
  }>>;
  commentMode: ZodOptional<ZodEnum<{
     NONE: "NONE";
     ENABLED: "ENABLED";
     MEMBERS_ONLY: "MEMBERS_ONLY";
  }>>;
  archived: ZodOptional<ZodBoolean>;
  metadata: ZodOptional<ZodString>;
  uploadToken: ZodOptional<ZodString>;
}, $strict>;

---

updateAssetPropsSchema

const updateAssetPropsSchema: ZodObject<{
  params: ZodObject<{
     userName: ZodString;
     assetName: ZodString;
  }, $strict>;
  body: ZodObject<{
     name: ZodOptional<ZodString>;
     description: ZodOptional<ZodString>;
     keywords: ZodOptional<ZodString>;
     visibility: ZodOptional<ZodEnum<{
        PRIVATE: "PRIVATE";
        UNLISTED: "UNLISTED";
        PUBLIC: "PUBLIC";
     }>>;
     shareLicense: ZodOptional<ZodEnum<{
        NONE: "NONE";
        CC_0: "CC_0";
        CC_BY: "CC_BY";
        CC_BY_SA: "CC_BY_SA";
        CC_BY_NC: "CC_BY_NC";
        CC_BY_NC_SA: "CC_BY_NC_SA";
        CC_BY_ND: "CC_BY_ND";
        CC_BY_NC_ND: "CC_BY_NC_ND";
     }>>;
     aiUsage: ZodOptional<ZodEnum<{
        UNDISCLOSED: "UNDISCLOSED";
        AI_USED: "AI_USED";
        AI_FREE: "AI_FREE";
     }>>;
     commentMode: ZodOptional<ZodEnum<{
        NONE: "NONE";
        ENABLED: "ENABLED";
        MEMBERS_ONLY: "MEMBERS_ONLY";
     }>>;
     archived: ZodOptional<ZodBoolean>;
     metadata: ZodOptional<ZodString>;
     uploadToken: ZodOptional<ZodString>;
  }, $strict>;
}, $strict>;

---

deleteAssetParamsSchema

const deleteAssetParamsSchema: ZodObject<{
  userName: ZodString;
  assetName: ZodString;
}, $strict> = assetParamsSchema;

---

deleteAssetResultSchema

const deleteAssetResultSchema: ZodVoid;

---

deleteAssetPropsSchema

const deleteAssetPropsSchema: ZodObject<{
  params: ZodObject<{
     userName: ZodString;
     assetName: ZodString;
  }, $strict>;
}, $strict>;

---

prepareAssetUploadParamsSchema

const prepareAssetUploadParamsSchema: ZodObject<{
  userName: ZodString;
}, $strict> = userNameParamsSchema;

---

prepareAssetUploadBodySchema

const prepareAssetUploadBodySchema: ZodObject<{
  filename: ZodString;
  contentType: ZodString;
  size: ZodNumber;
}, $strict>;

---

prepareAssetUploadResultSchema

const prepareAssetUploadResultSchema: ZodObject<{
  uploadUrl: ZodURL;
  uploadToken: ZodString;
}, $strict>;

---

prepareAssetUploadPropsSchema

const prepareAssetUploadPropsSchema: ZodObject<{
  params: ZodObject<{
     userName: ZodString;
  }, $strict>;
  body: ZodObject<{
     filename: ZodString;
     contentType: ZodString;
     size: ZodNumber;
  }, $strict>;
}, $strict>;

---

refreshAccessTokenBodySchema

const refreshAccessTokenBodySchema: ZodObject<{
  refreshToken: ZodString;
}, $strict>;

---

refreshAccessTokenResultSchema

const refreshAccessTokenResultSchema: ZodObject<{
  accessToken: ZodString;
}, $strict>;

---

refreshAccessTokenPropsSchema

const refreshAccessTokenPropsSchema: ZodObject<{
  body: ZodObject<{
     refreshToken: ZodString;
  }, $strict>;
}, $strict>;

---

oauthTokenRequestBodySchema

const oauthTokenRequestBodySchema: ZodObject<{
  grant_type: ZodLiteral<"authorization_code">;
  code: ZodString;
  client_id: ZodString;
  code_verifier: ZodString;
  redirect_uri: ZodURL;
  client_secret: ZodOptional<ZodString>;
}, $strict>;

---

oauthTokenResultSchema

const oauthTokenResultSchema: ZodObject<{
  access_token: ZodString;
  refresh_token: ZodString;
  token_type: ZodLiteral<"Bearer">;
  expires_in: ZodNumber;
}, $strict>;

---

exchangeAuthorizationCodePropsSchema

const exchangeAuthorizationCodePropsSchema: ZodObject<{
  body: ZodObject<{
     grant_type: ZodLiteral<"authorization_code">;
     code: ZodString;
     client_id: ZodString;
     code_verifier: ZodString;
     redirect_uri: ZodURL;
     client_secret: ZodOptional<ZodString>;
  }, $strict>;
}, $strict>;

---

oauthConsentBodySchema

const oauthConsentBodySchema: ZodObject<{
  client_id: ZodString;
  redirect_uri: ZodURL;
  response_type: ZodLiteral<"code">;
  scope: ZodString;
  state: ZodString;
  code_challenge: ZodString;
  code_challenge_method: ZodLiteral<"S256">;
  action: ZodEnum<{
     APPROVE: "APPROVE";
     DENY: "DENY";
  }>;
  session_token: ZodString;
}, $strict>;

---

deleteRefreshTokenParamsSchema

const deleteRefreshTokenParamsSchema: ZodObject<{
  token: ZodString;
}, $strict>;

---

deleteRefreshTokenPropsSchema

const deleteRefreshTokenPropsSchema: ZodObject<{
  params: ZodObject<{
     token: ZodString;
  }, $strict>;
}, $strict>;

---

uploadAvatarQuerySchema

const uploadAvatarQuerySchema: ZodObject<{
  userName: ZodString;
}, $strict>;

---

uploadAvatarBodySchema

const uploadAvatarBodySchema: ZodObject<{
  file: ZodInstanceOf<File>;
}, $strict>;

---

uploadAvatarPropsSchema

const uploadAvatarPropsSchema: ZodObject<{
  query: ZodObject<{
     userName: ZodString;
  }, $strict>;
  body: ZodObject<{
     file: ZodInstanceOf<File>;
  }, $strict>;
}, $strict>;

---

getAvatarQuerySchema

const getAvatarQuerySchema: ZodObject<{
  width: ZodOptional<ZodCoercedNumber<unknown>>;
  height: ZodOptional<ZodCoercedNumber<unknown>>;
  quality: ZodOptional<ZodCoercedNumber<unknown>>;
  format: ZodOptional<ZodEnum<{
     jpg: "jpg";
     png: "png";
     webp: "webp";
     avif: "avif";
  }>>;
  redirectOnNotFound: ZodOptional<ZodURL>;
  cacheKey: ZodOptional<ZodString>;
  userName: ZodString;
}, $strict>;

---

getAvatarPropsSchema

const getAvatarPropsSchema: ZodObject<{
  query: ZodObject<{
     width: ZodOptional<ZodCoercedNumber<unknown>>;
     height: ZodOptional<ZodCoercedNumber<unknown>>;
     quality: ZodOptional<ZodCoercedNumber<unknown>>;
     format: ZodOptional<ZodEnum<{
        jpg: "jpg";
        png: "png";
        webp: "webp";
        avif: "avif";
     }>>;
     redirectOnNotFound: ZodOptional<ZodURL>;
     cacheKey: ZodOptional<ZodString>;
     userName: ZodString;
  }, $strict>;
}, $strict>;

---

deleteAvatarQuerySchema

const deleteAvatarQuerySchema: ZodObject<{
  userName: ZodString;
}, $strict>;

---

deleteAvatarPropsSchema

const deleteAvatarPropsSchema: ZodObject<{
  query: ZodObject<{
     userName: ZodString;
  }, $strict>;
}, $strict>;

---

commentSchema

const commentSchema: ZodObject<{
  id: ZodNumber;
  text: ZodString;
  likeCount: ZodNumber;
  createdAt: ZodISODateTime;
  moderatedAt: ZodNullable<ZodISODateTime>;
  moderationReason: ZodNullable<ZodString>;
  createdByUserId: ZodNumber;
  createdByName: ZodString;
  likeId: ZodNullable<ZodNumber>;
}, $strip>;

---

createCommentParamsSchema

const createCommentParamsSchema: ZodObject<{
  userName: ZodString;
  assetName: ZodString;
}, $strict> = assetParamsSchema;

---

createCommentBodySchema

const createCommentBodySchema: ZodObject<{
  text: ZodString;
}, $strict>;

---

createCommentPropsSchema

const createCommentPropsSchema: ZodObject<{
  params: ZodObject<{
     userName: ZodString;
     assetName: ZodString;
  }, $strict>;
  body: ZodObject<{
     text: ZodString;
  }, $strict>;
}, $strict>;

---

listCommentsSortFields

const listCommentsSortFields: readonly ["createdAt"];

---

listCommentsQuerySchema

const listCommentsQuerySchema: ZodObject<{
  pageOffset: ZodOptional<ZodCoercedNumber<unknown>>;
  pageSize: ZodOptional<ZodCoercedNumber<unknown>>;
  sortBy: ZodOptional<ZodEnum<{
     createdAt: "createdAt";
  }>>;
  sortDir: ZodOptional<ZodEnum<{
     asc: "asc";
     desc: "desc";
  }>>;
}, $strip>;

---

listCommentsResultSchema

const listCommentsResultSchema: ZodObject<{
  rows: ZodArray<ZodObject<{
     id: ZodNumber;
     text: ZodString;
     likeCount: ZodNumber;
     createdAt: ZodISODateTime;
     moderatedAt: ZodNullable<ZodISODateTime>;
     moderationReason: ZodNullable<ZodString>;
     createdByUserId: ZodNumber;
     createdByName: ZodString;
     likeId: ZodNullable<ZodNumber>;
  }, $strip>>;
  rowCount: ZodInt;
}, $strict>;

---

listCommentPropsSchema

const listCommentPropsSchema: ZodObject<{
  params: ZodObject<{
     userName: ZodString;
     assetName: ZodString;
  }, $strict>;
  query: ZodObject<{
     pageOffset: ZodOptional<ZodCoercedNumber<unknown>>;
     pageSize: ZodOptional<ZodCoercedNumber<unknown>>;
     sortBy: ZodOptional<ZodEnum<{
        createdAt: "createdAt";
     }>>;
     sortDir: ZodOptional<ZodEnum<{
        asc: "asc";
        desc: "desc";
     }>>;
  }, $strip>;
}, $strict>;

---

editCommentParamsSchema

const editCommentParamsSchema: ZodObject<{
  userName: ZodString;
  assetName: ZodString;
  commentId: ZodCoercedNumber<unknown>;
}, $strict> = commentParamsSchema;

---

editCommentBodySchema

const editCommentBodySchema: ZodObject<{
  text: ZodString;
}, $strict>;

---

editCommentPropsSchema

const editCommentPropsSchema: ZodObject<{
  params: ZodObject<{
     userName: ZodString;
     assetName: ZodString;
     commentId: ZodCoercedNumber<unknown>;
  }, $strict>;
  body: ZodObject<{
     text: ZodString;
  }, $strict>;
}, $strict>;

---

deleteCommentParamsSchema

const deleteCommentParamsSchema: ZodObject<{
  userName: ZodString;
  assetName: ZodString;
  commentId: ZodCoercedNumber<unknown>;
}, $strict> = commentParamsSchema;

---

deleteCommentPropsSchema

const deleteCommentPropsSchema: ZodObject<{
  params: ZodObject<{
     userName: ZodString;
     assetName: ZodString;
     commentId: ZodCoercedNumber<unknown>;
  }, $strict>;
}, $strict>;

---

fileParamsSchema

const fileParamsSchema: ZodObject<{
  oid: ZodString;
}, $strict>;

File path parameter schema

---

fileQuerySchema

const fileQuerySchema: ZodObject<{
  name: ZodOptional<ZodString>;
}, $strict>;

---

getFilePropsSchema

const getFilePropsSchema: ZodObject<{
  params: ZodObject<{
     oid: ZodString;
  }, $strict>;
  query: ZodOptional<ZodObject<{
     name: ZodOptional<ZodString>;
  }, $strict>>;
}, $strict>;

---

getAssetMediaParamsSchema

const getAssetMediaParamsSchema: ZodObject<{
  userName: ZodString;
  assetName: ZodString;
}, $strict> = assetParamsSchema;

---

mediaParamsSchema

const mediaParamsSchema: ZodObject<{
  userName: ZodString;
  assetName: ZodString;
}, $strict> = assetParamsSchema;

---

mediaOriginalQuerySchema

const mediaOriginalQuerySchema: ZodObject<{
  download: ZodOptional<ZodUnion<readonly [ZodBoolean, ZodCodec<ZodString, ZodBoolean>]>>;
}, $strip>;

---

notificationSchema

const notificationSchema: ZodObject<{
  id: ZodNumber;
  title: ZodString;
  body: ZodString;
  createdAt: ZodISODateTime;
  status: ZodEnum<{
     UNREAD: "UNREAD";
     READ: "READ";
  }>;
  topic: ZodEnum<{
     NEW_COMMENT: "NEW_COMMENT";
     COMMENT_MODERATED: "COMMENT_MODERATED";
     ASSET_MODERATED: "ASSET_MODERATED";
     ASSET_LIKED: "ASSET_LIKED";
     COMMENT_LIKED: "COMMENT_LIKED";
     COMMENT_MENTIONED: "COMMENT_MENTIONED";
     EXTERNAL_AUTH_APPROVED: "EXTERNAL_AUTH_APPROVED";
     NEW_ASSET: "NEW_ASSET";
     NEW_ASSET_VERSION: "NEW_ASSET_VERSION";
  }>;
  imageUrl: ZodNullable<ZodString>;
  link: ZodNullable<ZodString>;
  userId: ZodNumber;
  userName: ZodString;
}, $strip>;

---

listNotificationsSortFields

const listNotificationsSortFields: readonly ["createdAt", "status"];

---

listNotificationsQuerySchema

const listNotificationsQuerySchema: ZodObject<{
  pageOffset: ZodOptional<ZodCoercedNumber<unknown>>;
  pageSize: ZodOptional<ZodCoercedNumber<unknown>>;
  sortBy: ZodOptional<ZodEnum<{
     createdAt: "createdAt";
     status: "status";
  }>>;
  sortDir: ZodOptional<ZodEnum<{
     asc: "asc";
     desc: "desc";
  }>>;
  status: ZodOptional<ZodEnum<{
     UNREAD: "UNREAD";
     READ: "READ";
  }>>;
}, $strip>;

---

listNotificationsResultSchema

const listNotificationsResultSchema: ZodObject<{
  rows: ZodArray<ZodObject<{
     id: ZodNumber;
     title: ZodString;
     body: ZodString;
     createdAt: ZodISODateTime;
     status: ZodEnum<{
        UNREAD: "UNREAD";
        READ: "READ";
     }>;
     topic: ZodEnum<{
        NEW_COMMENT: "NEW_COMMENT";
        COMMENT_MODERATED: "COMMENT_MODERATED";
        ASSET_MODERATED: "ASSET_MODERATED";
        ASSET_LIKED: "ASSET_LIKED";
        COMMENT_LIKED: "COMMENT_LIKED";
        COMMENT_MENTIONED: "COMMENT_MENTIONED";
        EXTERNAL_AUTH_APPROVED: "EXTERNAL_AUTH_APPROVED";
        NEW_ASSET: "NEW_ASSET";
        NEW_ASSET_VERSION: "NEW_ASSET_VERSION";
     }>;
     imageUrl: ZodNullable<ZodString>;
     link: ZodNullable<ZodString>;
     userId: ZodNumber;
     userName: ZodString;
  }, $strip>>;
  rowCount: ZodInt;
}, $strict>;

---

listNotificationPropsSchema

const listNotificationPropsSchema: ZodObject<{
  query: ZodObject<{
     pageOffset: ZodOptional<ZodCoercedNumber<unknown>>;
     pageSize: ZodOptional<ZodCoercedNumber<unknown>>;
     sortBy: ZodOptional<ZodEnum<{
        createdAt: "createdAt";
        status: "status";
     }>>;
     sortDir: ZodOptional<ZodEnum<{
        asc: "asc";
        desc: "desc";
     }>>;
     status: ZodOptional<ZodEnum<{
        UNREAD: "UNREAD";
        READ: "READ";
     }>>;
  }, $strip>;
}, $strict>;

---

markNotificationAsReadParamsSchema

const markNotificationAsReadParamsSchema: ZodObject<{
  notificationId: ZodCoercedNumber<unknown>;
}, $strict>;

---

markNotificationAsReadBodySchema

const markNotificationAsReadBodySchema: ZodObject<{
  status: ZodLiteral<"READ">;
}, $strict>;

---

markNotificationAsReadResultSchema

const markNotificationAsReadResultSchema: ZodVoid;

---

markNotificationAsReadPropsSchema

const markNotificationAsReadPropsSchema: ZodObject<{
  params: ZodObject<{
     notificationId: ZodCoercedNumber<unknown>;
  }, $strict>;
  body: ZodObject<{
     status: ZodLiteral<"READ">;
  }, $strict>;
}, $strict>;

---

markAllNotificationsAsReadBodySchema

const markAllNotificationsAsReadBodySchema: ZodObject<{
  status: ZodLiteral<"READ">;
}, $strict>;

---

markAllNotificationsAsReadResultSchema

const markAllNotificationsAsReadResultSchema: ZodObject<{
  success: ZodBoolean;
}, $strict>;

---

markAllNotificationsAsReadPropsSchema

const markAllNotificationsAsReadPropsSchema: ZodObject<{
  body: ZodObject<{
     status: ZodLiteral<"READ">;
  }, $strict>;
}, $strict>;

---

getOEmbedQuerySchema

const getOEmbedQuerySchema: ZodObject<{
  url: ZodURL;
  format: ZodDefault<ZodOptional<ZodEnum<{
     json: "json";
     xml: "xml";
  }>>>;
  maxwidth: ZodOptional<ZodCoercedNumber<unknown>>;
  maxheight: ZodOptional<ZodCoercedNumber<unknown>>;
}, $strict>;

---

oEmbedResponseSchema

const oEmbedResponseSchema: ZodObject<{
  version: ZodLiteral<"1.0">;
  type: ZodEnum<{
     link: "link";
     photo: "photo";
     video: "video";
     rich: "rich";
  }>;
  provider_name: ZodString;
  provider_url: ZodURL;
  url: ZodOptional<ZodURL>;
  width: ZodOptional<ZodNumber>;
  height: ZodOptional<ZodNumber>;
  title: ZodOptional<ZodString>;
  author_name: ZodOptional<ZodString>;
  author_url: ZodOptional<ZodURL>;
  thumbnail_url: ZodOptional<ZodURL>;
  thumbnail_width: ZodOptional<ZodNumber>;
  thumbnail_height: ZodOptional<ZodNumber>;
  html: ZodOptional<ZodString>;
}, $strip>;

---

getOEmbedPropsSchema

const getOEmbedPropsSchema: ZodObject<{
  query: ZodObject<{
     url: ZodURL;
     format: ZodDefault<ZodOptional<ZodEnum<{
        json: "json";
        xml: "xml";
     }>>>;
     maxwidth: ZodOptional<ZodCoercedNumber<unknown>>;
     maxheight: ZodOptional<ZodCoercedNumber<unknown>>;
  }, $strict>;
}, $strict>;

---

serverEventNotificationNewDataSchema

const serverEventNotificationNewDataSchema: ZodOptional<ZodObject<{
  count: ZodOptional<ZodNumber>;
  topic: ZodOptional<ZodEnum<{
     NEW_COMMENT: "NEW_COMMENT";
     COMMENT_MODERATED: "COMMENT_MODERATED";
     ASSET_MODERATED: "ASSET_MODERATED";
     ASSET_LIKED: "ASSET_LIKED";
     COMMENT_LIKED: "COMMENT_LIKED";
     COMMENT_MENTIONED: "COMMENT_MENTIONED";
     EXTERNAL_AUTH_APPROVED: "EXTERNAL_AUTH_APPROVED";
     NEW_ASSET: "NEW_ASSET";
     NEW_ASSET_VERSION: "NEW_ASSET_VERSION";
  }>>;
}, $strip>>;

---

serverEventNotificationTopicDataSchema

const serverEventNotificationTopicDataSchema: ZodObject<{
  topic: ZodEnum<{
     NEW_COMMENT: "NEW_COMMENT";
     COMMENT_MODERATED: "COMMENT_MODERATED";
     ASSET_MODERATED: "ASSET_MODERATED";
     ASSET_LIKED: "ASSET_LIKED";
     COMMENT_LIKED: "COMMENT_LIKED";
     COMMENT_MENTIONED: "COMMENT_MENTIONED";
     EXTERNAL_AUTH_APPROVED: "EXTERNAL_AUTH_APPROVED";
     NEW_ASSET: "NEW_ASSET";
     NEW_ASSET_VERSION: "NEW_ASSET_VERSION";
  }>;
  title: ZodOptional<ZodString>;
  link: ZodOptional<ZodString>;
}, $strip>;

---

serverEventAssetModeratedDataSchema

const serverEventAssetModeratedDataSchema: ZodObject<{
  topic: ZodEnum<{
     NEW_COMMENT: "NEW_COMMENT";
     COMMENT_MODERATED: "COMMENT_MODERATED";
     ASSET_MODERATED: "ASSET_MODERATED";
     ASSET_LIKED: "ASSET_LIKED";
     COMMENT_LIKED: "COMMENT_LIKED";
     COMMENT_MENTIONED: "COMMENT_MENTIONED";
     EXTERNAL_AUTH_APPROVED: "EXTERNAL_AUTH_APPROVED";
     NEW_ASSET: "NEW_ASSET";
     NEW_ASSET_VERSION: "NEW_ASSET_VERSION";
  }>;
  title: ZodOptional<ZodString>;
  link: ZodOptional<ZodString>;
  userName: ZodString;
  assetName: ZodString;
  reason: ZodString;
}, $strip>;

---

serverEventCommentModeratedDataSchema

const serverEventCommentModeratedDataSchema: ZodObject<{
  topic: ZodEnum<{
     NEW_COMMENT: "NEW_COMMENT";
     COMMENT_MODERATED: "COMMENT_MODERATED";
     ASSET_MODERATED: "ASSET_MODERATED";
     ASSET_LIKED: "ASSET_LIKED";
     COMMENT_LIKED: "COMMENT_LIKED";
     COMMENT_MENTIONED: "COMMENT_MENTIONED";
     EXTERNAL_AUTH_APPROVED: "EXTERNAL_AUTH_APPROVED";
     NEW_ASSET: "NEW_ASSET";
     NEW_ASSET_VERSION: "NEW_ASSET_VERSION";
  }>;
  title: ZodOptional<ZodString>;
  link: ZodOptional<ZodString>;
  userName: ZodString;
  assetName: ZodString;
  commentId: ZodNumber;
  commentText: ZodString;
  reason: ZodString;
  targetUserId: ZodNumber;
}, $strip>;

---

serverEventAssetLikedDataSchema

const serverEventAssetLikedDataSchema: ZodObject<{
  topic: ZodEnum<{
     NEW_COMMENT: "NEW_COMMENT";
     COMMENT_MODERATED: "COMMENT_MODERATED";
     ASSET_MODERATED: "ASSET_MODERATED";
     ASSET_LIKED: "ASSET_LIKED";
     COMMENT_LIKED: "COMMENT_LIKED";
     COMMENT_MENTIONED: "COMMENT_MENTIONED";
     EXTERNAL_AUTH_APPROVED: "EXTERNAL_AUTH_APPROVED";
     NEW_ASSET: "NEW_ASSET";
     NEW_ASSET_VERSION: "NEW_ASSET_VERSION";
  }>;
  title: ZodOptional<ZodString>;
  link: ZodOptional<ZodString>;
  userName: ZodString;
  assetName: ZodString;
  actorName: ZodString;
}, $strip>;

---

serverEventCommentLikedDataSchema

const serverEventCommentLikedDataSchema: ZodObject<{
  topic: ZodEnum<{
     NEW_COMMENT: "NEW_COMMENT";
     COMMENT_MODERATED: "COMMENT_MODERATED";
     ASSET_MODERATED: "ASSET_MODERATED";
     ASSET_LIKED: "ASSET_LIKED";
     COMMENT_LIKED: "COMMENT_LIKED";
     COMMENT_MENTIONED: "COMMENT_MENTIONED";
     EXTERNAL_AUTH_APPROVED: "EXTERNAL_AUTH_APPROVED";
     NEW_ASSET: "NEW_ASSET";
     NEW_ASSET_VERSION: "NEW_ASSET_VERSION";
  }>;
  title: ZodOptional<ZodString>;
  link: ZodOptional<ZodString>;
  userName: ZodString;
  assetName: ZodString;
  commentId: ZodNumber;
  commentText: ZodString;
  actorName: ZodString;
  targetUserId: ZodNumber;
}, $strip>;

---

serverEventAssetCreatedUpdatedDataSchema

const serverEventAssetCreatedUpdatedDataSchema: ZodObject<{
  asset: ZodObject<{
     id: ZodNumber;
     name: ZodString;
     type: ZodEnum<{
        MATERIAL: "MATERIAL";
     }>;
     visibility: ZodEnum<{
        PRIVATE: "PRIVATE";
        UNLISTED: "UNLISTED";
        PUBLIC: "PUBLIC";
     }>;
     userId: ZodNumber;
     userName: ZodString;
     description: ZodString;
     keywords: ZodString;
     shareLicense: ZodEnum<{
        NONE: "NONE";
        CC_0: "CC_0";
        CC_BY: "CC_BY";
        CC_BY_SA: "CC_BY_SA";
        CC_BY_NC: "CC_BY_NC";
        CC_BY_NC_SA: "CC_BY_NC_SA";
        CC_BY_ND: "CC_BY_ND";
        CC_BY_NC_ND: "CC_BY_NC_ND";
     }>;
     aiUsage: ZodEnum<{
        UNDISCLOSED: "UNDISCLOSED";
        AI_USED: "AI_USED";
        AI_FREE: "AI_FREE";
     }>;
     commentMode: ZodEnum<{
        NONE: "NONE";
        ENABLED: "ENABLED";
        MEMBERS_ONLY: "MEMBERS_ONLY";
     }>;
     reported: ZodBoolean;
     likeCount: ZodInt;
     shareCount: ZodInt;
     createdAt: ZodISODateTime;
     updatedAt: ZodISODateTime;
     archived: ZodBoolean;
     metadata: ZodString;
     versionOriginalSize: ZodOptional<ZodNullable<ZodNumber>>;
     width: ZodOptional<ZodNullable<ZodNumber>>;
     height: ZodOptional<ZodNullable<ZodNumber>>;
     depth: ZodOptional<ZodNullable<ZodNumber>>;
     fileOid: ZodString;
     thumbnailOid: ZodOptional<ZodNullable<ZodString>>;
     materialInfo: ZodOptional<ZodObject<{
        version: ZodOptional<ZodString>;
        colorspace: ZodOptional<ZodString>;
        materials: ZodArray<ZodObject<{
           name: ZodOptional<...>;
           category: ZodString;
        }, $strip>>;
        nodeGraphCount: ZodNumber;
        topLevelNodeCount: ZodNumber;
        referencedTextures: ZodArray<ZodString>;
        warnings: ZodArray<ZodString>;
     }, $strip>>;
  }, $strip>;
  actorName: ZodOptional<ZodString>;
}, $strip>;

---

serverEventAssetDeletedDataSchema

const serverEventAssetDeletedDataSchema: ZodObject<{
  assetId: ZodNumber;
  userName: ZodString;
  assetName: ZodString;
}, $strip>;

---

serverEventCommentDataSchema

const serverEventCommentDataSchema: ZodObject<{
  comment: ZodObject<{
     id: ZodNumber;
     text: ZodString;
     likeCount: ZodNumber;
     createdAt: ZodISODateTime;
     moderatedAt: ZodNullable<ZodISODateTime>;
     moderationReason: ZodNullable<ZodString>;
     createdByUserId: ZodNumber;
     createdByName: ZodString;
     likeId: ZodNullable<ZodNumber>;
  }, $strip>;
  assetId: ZodNumber;
  userName: ZodString;
  assetName: ZodString;
  mentionedUserIds: ZodOptional<ZodArray<ZodNumber>>;
}, $strip>;

---

serverEventDataSchemas

const serverEventDataSchemas: object;

Type Declaration

Name	Type	Default value
asset.created	ZodObject<{ asset: ZodObject<{ id: ZodNumber; name: ZodString; type: ZodEnum<{ MATERIAL: "MATERIAL"; }>; visibility: ZodEnum<{ PRIVATE: "PRIVATE"; UNLISTED: "UNLISTED"; PUBLIC: "PUBLIC"; }>; userId: ZodNumber; userName: ZodString; description: ZodString; keywords: ZodString; shareLicense: ZodEnum<{ NONE: "NONE"; CC_0: "CC_0"; CC_BY: "CC_BY"; CC_BY_SA: "CC_BY_SA"; CC_BY_NC: "CC_BY_NC"; CC_BY_NC_SA: "CC_BY_NC_SA"; CC_BY_ND: "CC_BY_ND"; CC_BY_NC_ND: "CC_BY_NC_ND"; }>; aiUsage: ZodEnum<{ UNDISCLOSED: "UNDISCLOSED"; AI_USED: "AI_USED"; AI_FREE: "AI_FREE"; }>; commentMode: ZodEnum<{ NONE: "NONE"; ENABLED: "ENABLED"; MEMBERS_ONLY: "MEMBERS_ONLY"; }>; reported: ZodBoolean; likeCount: ZodInt; shareCount: ZodInt; createdAt: ZodISODateTime; updatedAt: ZodISODateTime; archived: ZodBoolean; metadata: ZodString; versionOriginalSize: ZodOptional<ZodNullable<ZodNumber>>; width: ZodOptional<ZodNullable<ZodNumber>>; height: ZodOptional<ZodNullable<ZodNumber>>; depth: ZodOptional<ZodNullable<ZodNumber>>; fileOid: ZodString; thumbnailOid: ZodOptional<ZodNullable<ZodString>>; materialInfo: ZodOptional<ZodObject<{ version: ZodOptional<ZodString>; colorspace: ZodOptional<ZodString>; materials: ZodArray<ZodObject<{ name: ...; category: ...; }, $strip>>; nodeGraphCount: ZodNumber; topLevelNodeCount: ZodNumber; referencedTextures: ZodArray<ZodString>; warnings: ZodArray<ZodString>; }, $strip>>; }, $strip>; actorName: ZodOptional<ZodString>; }, $strip>	serverEventAssetCreatedUpdatedDataSchema
asset.deleted	ZodObject<{ assetId: ZodNumber; userName: ZodString; assetName: ZodString; }, $strip>	serverEventAssetDeletedDataSchema
asset.liked	ZodObject<{ topic: ZodEnum<{ NEW_COMMENT: "NEW_COMMENT"; COMMENT_MODERATED: "COMMENT_MODERATED"; ASSET_MODERATED: "ASSET_MODERATED"; ASSET_LIKED: "ASSET_LIKED"; COMMENT_LIKED: "COMMENT_LIKED"; COMMENT_MENTIONED: "COMMENT_MENTIONED"; EXTERNAL_AUTH_APPROVED: "EXTERNAL_AUTH_APPROVED"; NEW_ASSET: "NEW_ASSET"; NEW_ASSET_VERSION: "NEW_ASSET_VERSION"; }>; title: ZodOptional<ZodString>; link: ZodOptional<ZodString>; userName: ZodString; assetName: ZodString; actorName: ZodString; }, $strip>	serverEventAssetLikedDataSchema
asset.moderated	ZodObject<{ topic: ZodEnum<{ NEW_COMMENT: "NEW_COMMENT"; COMMENT_MODERATED: "COMMENT_MODERATED"; ASSET_MODERATED: "ASSET_MODERATED"; ASSET_LIKED: "ASSET_LIKED"; COMMENT_LIKED: "COMMENT_LIKED"; COMMENT_MENTIONED: "COMMENT_MENTIONED"; EXTERNAL_AUTH_APPROVED: "EXTERNAL_AUTH_APPROVED"; NEW_ASSET: "NEW_ASSET"; NEW_ASSET_VERSION: "NEW_ASSET_VERSION"; }>; title: ZodOptional<ZodString>; link: ZodOptional<ZodString>; userName: ZodString; assetName: ZodString; reason: ZodString; }, $strip>	serverEventAssetModeratedDataSchema
asset.updated	ZodObject<{ asset: ZodObject<{ id: ZodNumber; name: ZodString; type: ZodEnum<{ MATERIAL: "MATERIAL"; }>; visibility: ZodEnum<{ PRIVATE: "PRIVATE"; UNLISTED: "UNLISTED"; PUBLIC: "PUBLIC"; }>; userId: ZodNumber; userName: ZodString; description: ZodString; keywords: ZodString; shareLicense: ZodEnum<{ NONE: "NONE"; CC_0: "CC_0"; CC_BY: "CC_BY"; CC_BY_SA: "CC_BY_SA"; CC_BY_NC: "CC_BY_NC"; CC_BY_NC_SA: "CC_BY_NC_SA"; CC_BY_ND: "CC_BY_ND"; CC_BY_NC_ND: "CC_BY_NC_ND"; }>; aiUsage: ZodEnum<{ UNDISCLOSED: "UNDISCLOSED"; AI_USED: "AI_USED"; AI_FREE: "AI_FREE"; }>; commentMode: ZodEnum<{ NONE: "NONE"; ENABLED: "ENABLED"; MEMBERS_ONLY: "MEMBERS_ONLY"; }>; reported: ZodBoolean; likeCount: ZodInt; shareCount: ZodInt; createdAt: ZodISODateTime; updatedAt: ZodISODateTime; archived: ZodBoolean; metadata: ZodString; versionOriginalSize: ZodOptional<ZodNullable<ZodNumber>>; width: ZodOptional<ZodNullable<ZodNumber>>; height: ZodOptional<ZodNullable<ZodNumber>>; depth: ZodOptional<ZodNullable<ZodNumber>>; fileOid: ZodString; thumbnailOid: ZodOptional<ZodNullable<ZodString>>; materialInfo: ZodOptional<ZodObject<{ version: ZodOptional<ZodString>; colorspace: ZodOptional<ZodString>; materials: ZodArray<ZodObject<{ name: ...; category: ...; }, $strip>>; nodeGraphCount: ZodNumber; topLevelNodeCount: ZodNumber; referencedTextures: ZodArray<ZodString>; warnings: ZodArray<ZodString>; }, $strip>>; }, $strip>; actorName: ZodOptional<ZodString>; }, $strip>	serverEventAssetCreatedUpdatedDataSchema
comment.liked	ZodObject<{ topic: ZodEnum<{ NEW_COMMENT: "NEW_COMMENT"; COMMENT_MODERATED: "COMMENT_MODERATED"; ASSET_MODERATED: "ASSET_MODERATED"; ASSET_LIKED: "ASSET_LIKED"; COMMENT_LIKED: "COMMENT_LIKED"; COMMENT_MENTIONED: "COMMENT_MENTIONED"; EXTERNAL_AUTH_APPROVED: "EXTERNAL_AUTH_APPROVED"; NEW_ASSET: "NEW_ASSET"; NEW_ASSET_VERSION: "NEW_ASSET_VERSION"; }>; title: ZodOptional<ZodString>; link: ZodOptional<ZodString>; userName: ZodString; assetName: ZodString; commentId: ZodNumber; commentText: ZodString; actorName: ZodString; targetUserId: ZodNumber; }, $strip>	serverEventCommentLikedDataSchema
comment.moderated	ZodObject<{ topic: ZodEnum<{ NEW_COMMENT: "NEW_COMMENT"; COMMENT_MODERATED: "COMMENT_MODERATED"; ASSET_MODERATED: "ASSET_MODERATED"; ASSET_LIKED: "ASSET_LIKED"; COMMENT_LIKED: "COMMENT_LIKED"; COMMENT_MENTIONED: "COMMENT_MENTIONED"; EXTERNAL_AUTH_APPROVED: "EXTERNAL_AUTH_APPROVED"; NEW_ASSET: "NEW_ASSET"; NEW_ASSET_VERSION: "NEW_ASSET_VERSION"; }>; title: ZodOptional<ZodString>; link: ZodOptional<ZodString>; userName: ZodString; assetName: ZodString; commentId: ZodNumber; commentText: ZodString; reason: ZodString; targetUserId: ZodNumber; }, $strip>	serverEventCommentModeratedDataSchema
comment.new	ZodObject<{ comment: ZodObject<{ id: ZodNumber; text: ZodString; likeCount: ZodNumber; createdAt: ZodISODateTime; moderatedAt: ZodNullable<ZodISODateTime>; moderationReason: ZodNullable<ZodString>; createdByUserId: ZodNumber; createdByName: ZodString; likeId: ZodNullable<ZodNumber>; }, $strip>; assetId: ZodNumber; userName: ZodString; assetName: ZodString; mentionedUserIds: ZodOptional<ZodArray<ZodNumber>>; }, $strip>	serverEventCommentDataSchema
comment.updated	ZodObject<{ comment: ZodObject<{ id: ZodNumber; text: ZodString; likeCount: ZodNumber; createdAt: ZodISODateTime; moderatedAt: ZodNullable<ZodISODateTime>; moderationReason: ZodNullable<ZodString>; createdByUserId: ZodNumber; createdByName: ZodString; likeId: ZodNullable<ZodNumber>; }, $strip>; assetId: ZodNumber; userName: ZodString; assetName: ZodString; mentionedUserIds: ZodOptional<ZodArray<ZodNumber>>; }, $strip>	serverEventCommentDataSchema
external-auth.approved	ZodObject<{ topic: ZodEnum<{ NEW_COMMENT: "NEW_COMMENT"; COMMENT_MODERATED: "COMMENT_MODERATED"; ASSET_MODERATED: "ASSET_MODERATED"; ASSET_LIKED: "ASSET_LIKED"; COMMENT_LIKED: "COMMENT_LIKED"; COMMENT_MENTIONED: "COMMENT_MENTIONED"; EXTERNAL_AUTH_APPROVED: "EXTERNAL_AUTH_APPROVED"; NEW_ASSET: "NEW_ASSET"; NEW_ASSET_VERSION: "NEW_ASSET_VERSION"; }>; title: ZodOptional<ZodString>; link: ZodOptional<ZodString>; }, $strip>	serverEventNotificationTopicDataSchema
notification.new	ZodOptional<ZodObject<{ count: ZodOptional<ZodNumber>; topic: ZodOptional<ZodEnum<{ NEW_COMMENT: "NEW_COMMENT"; COMMENT_MODERATED: "COMMENT_MODERATED"; ASSET_MODERATED: "ASSET_MODERATED"; ASSET_LIKED: "ASSET_LIKED"; COMMENT_LIKED: "COMMENT_LIKED"; COMMENT_MENTIONED: "COMMENT_MENTIONED"; EXTERNAL_AUTH_APPROVED: "EXTERNAL_AUTH_APPROVED"; NEW_ASSET: "NEW_ASSET"; NEW_ASSET_VERSION: "NEW_ASSET_VERSION"; }>>; }, $strip>>	serverEventNotificationNewDataSchema

---

SERVER_EVENT_TYPES

const SERVER_EVENT_TYPES: [
  | "asset.created"
  | "asset.deleted"
  | "asset.liked"
  | "asset.moderated"
  | "asset.updated"
  | "comment.liked"
  | "comment.moderated"
  | "comment.new"
  | "comment.updated"
  | "external-auth.approved"
  | "notification.new", ...("asset.created" | "asset.deleted" | "asset.liked" | "asset.moderated" | "asset.updated" | "comment.liked" | "comment.moderated" | "comment.new" | "comment.updated" | "external-auth.approved" | "notification.new")[]];

---

serverEventTypeSchema

const serverEventTypeSchema: ZodEnum<{
  "asset.created": "asset.created";
  "asset.deleted": "asset.deleted";
  "asset.liked": "asset.liked";
  "asset.moderated": "asset.moderated";
  "asset.updated": "asset.updated";
  "comment.liked": "comment.liked";
  "comment.moderated": "comment.moderated";
  "comment.new": "comment.new";
  "comment.updated": "comment.updated";
  "external-auth.approved": "external-auth.approved";
  "notification.new": "notification.new";
}>;

---

serverEventSchema

const serverEventSchema: ZodDiscriminatedUnion<[ZodObject<Readonly<{
[k: string]: $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>;
}>, $strip>, ...ZodObject<Readonly<{ [k: string]: $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>> }>, $strip>[]], "type">;

---

taskSchema

const taskSchema: ZodObject<{
  id: ZodNumber;
  taskType: ZodString;
  runner: ZodString;
  parameters: ZodNullable<ZodString>;
  createdAt: ZodISODateTime;
  name: ZodString;
  targetUrl: ZodNullable<ZodString>;
  userName: ZodString;
  assetName: ZodOptional<ZodNullable<ZodString>>;
  createdByName: ZodString;
  latestRunStatus: ZodNullable<ZodEnum<{
     RUNNING: "RUNNING";
     SUCCESS: "SUCCESS";
     FAILED: "FAILED";
  }>>;
  latestRunDuration: ZodNullable<ZodNumber>;
}, $strip>;

---

taskWithStatusAndResultsSchema

const taskWithStatusAndResultsSchema: ZodObject<{
  id: ZodNumber;
  taskType: ZodString;
  runner: ZodString;
  parameters: ZodNullable<ZodString>;
  createdAt: ZodISODateTime;
  name: ZodString;
  targetUrl: ZodNullable<ZodString>;
  userName: ZodString;
  assetName: ZodOptional<ZodNullable<ZodString>>;
  createdByName: ZodString;
  latestRunStatus: ZodNullable<ZodEnum<{
     RUNNING: "RUNNING";
     SUCCESS: "SUCCESS";
     FAILED: "FAILED";
  }>>;
  latestRunDuration: ZodNullable<ZodNumber>;
  latestRunResults: ZodNullable<ZodUnknown>;
}, $strip>;

---

getTaskParamsSchema

const getTaskParamsSchema: ZodObject<{
  userName: ZodString;
  taskId: ZodCoercedNumber<unknown>;
}, $strict>;

---

getTaskResultSchema

const getTaskResultSchema: ZodObject<{
  id: ZodNumber;
  taskType: ZodString;
  runner: ZodString;
  parameters: ZodNullable<ZodString>;
  createdAt: ZodISODateTime;
  name: ZodString;
  targetUrl: ZodNullable<ZodString>;
  userName: ZodString;
  assetName: ZodOptional<ZodNullable<ZodString>>;
  createdByName: ZodString;
  latestRunStatus: ZodNullable<ZodEnum<{
     RUNNING: "RUNNING";
     SUCCESS: "SUCCESS";
     FAILED: "FAILED";
  }>>;
  latestRunDuration: ZodNullable<ZodNumber>;
  latestRunResults: ZodNullable<ZodUnknown>;
}, $strip> = taskWithStatusAndResultsSchema;

---

taskEventRunSchema

const taskEventRunSchema: ZodObject<{
  taskRunId: ZodNumber;
  taskId: ZodNumber;
  status: ZodEnum<{
     RUNNING: "RUNNING";
     SUCCESS: "SUCCESS";
     FAILED: "FAILED";
  }>;
  startedAt: ZodString;
  finishedAt: ZodNullable<ZodString>;
  duration: ZodNullable<ZodNumber>;
  workerName: ZodString;
  results: ZodOptional<ZodNullable<ZodUnknown>>;
  errors: ZodOptional<ZodNullable<ZodString>>;
}, $strip>;

---

taskEventQueuedDataSchema

const taskEventQueuedDataSchema: ZodObject<{
  taskId: ZodNumber;
}, $strip>;

---

taskEventRunningDataSchema

const taskEventRunningDataSchema: ZodObject<{
  taskId: ZodNumber;
  run: ZodObject<{
     taskRunId: ZodNumber;
     taskId: ZodNumber;
     status: ZodEnum<{
        RUNNING: "RUNNING";
        SUCCESS: "SUCCESS";
        FAILED: "FAILED";
     }>;
     startedAt: ZodString;
     finishedAt: ZodNullable<ZodString>;
     duration: ZodNullable<ZodNumber>;
     workerName: ZodString;
     results: ZodOptional<ZodNullable<ZodUnknown>>;
     errors: ZodOptional<ZodNullable<ZodString>>;
  }, $strip>;
}, $strip>;

---

taskEventSuccessDataSchema

const taskEventSuccessDataSchema: ZodObject<{
  taskId: ZodNumber;
  run: ZodObject<{
     taskRunId: ZodNumber;
     taskId: ZodNumber;
     status: ZodEnum<{
        RUNNING: "RUNNING";
        SUCCESS: "SUCCESS";
        FAILED: "FAILED";
     }>;
     startedAt: ZodString;
     finishedAt: ZodNullable<ZodString>;
     duration: ZodNullable<ZodNumber>;
     workerName: ZodString;
     results: ZodOptional<ZodNullable<ZodUnknown>>;
     errors: ZodOptional<ZodNullable<ZodString>>;
  }, $strip>;
}, $strip>;

---

taskEventFailureDataSchema

const taskEventFailureDataSchema: ZodObject<{
  taskId: ZodNumber;
  run: ZodObject<{
     taskRunId: ZodNumber;
     taskId: ZodNumber;
     status: ZodEnum<{
        RUNNING: "RUNNING";
        SUCCESS: "SUCCESS";
        FAILED: "FAILED";
     }>;
     startedAt: ZodString;
     finishedAt: ZodNullable<ZodString>;
     duration: ZodNullable<ZodNumber>;
     workerName: ZodString;
     results: ZodOptional<ZodNullable<ZodUnknown>>;
     errors: ZodOptional<ZodNullable<ZodString>>;
  }, $strip>;
}, $strip>;

---

taskEventDataSchemas

const taskEventDataSchemas: object;

Type Declaration

Name	Type	Default value
task.queued	ZodObject<{ taskId: ZodNumber; }, $strip>	taskEventQueuedDataSchema
task.running	ZodObject<{ taskId: ZodNumber; run: ZodObject<{ taskRunId: ZodNumber; taskId: ZodNumber; status: ZodEnum<{ RUNNING: "RUNNING"; SUCCESS: "SUCCESS"; FAILED: "FAILED"; }>; startedAt: ZodString; finishedAt: ZodNullable<ZodString>; duration: ZodNullable<ZodNumber>; workerName: ZodString; results: ZodOptional<ZodNullable<ZodUnknown>>; errors: ZodOptional<ZodNullable<ZodString>>; }, $strip>; }, $strip>	taskEventRunningDataSchema
task.success	ZodObject<{ taskId: ZodNumber; run: ZodObject<{ taskRunId: ZodNumber; taskId: ZodNumber; status: ZodEnum<{ RUNNING: "RUNNING"; SUCCESS: "SUCCESS"; FAILED: "FAILED"; }>; startedAt: ZodString; finishedAt: ZodNullable<ZodString>; duration: ZodNullable<ZodNumber>; workerName: ZodString; results: ZodOptional<ZodNullable<ZodUnknown>>; errors: ZodOptional<ZodNullable<ZodString>>; }, $strip>; }, $strip>	taskEventSuccessDataSchema
task.failure	ZodObject<{ taskId: ZodNumber; run: ZodObject<{ taskRunId: ZodNumber; taskId: ZodNumber; status: ZodEnum<{ RUNNING: "RUNNING"; SUCCESS: "SUCCESS"; FAILED: "FAILED"; }>; startedAt: ZodString; finishedAt: ZodNullable<ZodString>; duration: ZodNullable<ZodNumber>; workerName: ZodString; results: ZodOptional<ZodNullable<ZodUnknown>>; errors: ZodOptional<ZodNullable<ZodString>>; }, $strip>; }, $strip>	taskEventFailureDataSchema

---

taskEventSchema

const taskEventSchema: ZodDiscriminatedUnion<[ZodObject<Readonly<{
[k: string]: $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>;
}>, $strip>, ...ZodObject<Readonly<{ [k: string]: $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>> }>, $strip>[]], "type">;

---

getTaskEventsQuerySchema

const getTaskEventsQuerySchema: ZodObject<{
  sinceSequence: ZodOptional<ZodCoercedNumber<unknown>>;
}, $strip>;

---

userSchema

const userSchema: ZodObject<{
  id: ZodNumber;
  name: ZodString;
}, $strip>;

---

privateUserSchema

const privateUserSchema: ZodObject<{
  id: ZodNumber;
  name: ZodString;
  createdAt: ZodISODateTime;
  updatedAt: ZodISODateTime;
  email: ZodString;
  fullName: ZodString;
  country: ZodNullable<ZodEnum<{
     "~": "~";
     AD: "AD";
     AE: "AE";
     AF: "AF";
     AG: "AG";
     AI: "AI";
     AL: "AL";
     AM: "AM";
     AO: "AO";
     AQ: "AQ";
     AR: "AR";
     AS: "AS";
     AT: "AT";
     AU: "AU";
     AW: "AW";
     AX: "AX";
     AZ: "AZ";
     BA: "BA";
     BB: "BB";
     BD: "BD";
     BE: "BE";
     BF: "BF";
     BG: "BG";
     BH: "BH";
     BI: "BI";
     BJ: "BJ";
     BL: "BL";
     BM: "BM";
     BN: "BN";
     BO: "BO";
     BQ: "BQ";
     BR: "BR";
     BS: "BS";
     BT: "BT";
     BV: "BV";
     BW: "BW";
     BY: "BY";
     BZ: "BZ";
     CA: "CA";
     CC: "CC";
     CD: "CD";
     CF: "CF";
     CG: "CG";
     CH: "CH";
     CI: "CI";
     CK: "CK";
     CL: "CL";
     CM: "CM";
     CN: "CN";
     CO: "CO";
     CR: "CR";
     CU: "CU";
     CV: "CV";
     CW: "CW";
     CX: "CX";
     CY: "CY";
     CZ: "CZ";
     DE: "DE";
     DJ: "DJ";
     DK: "DK";
     DM: "DM";
     DO: "DO";
     DZ: "DZ";
     EC: "EC";
     EE: "EE";
     EG: "EG";
     EH: "EH";
     ER: "ER";
     ES: "ES";
     ET: "ET";
     FI: "FI";
     FJ: "FJ";
     FK: "FK";
     FM: "FM";
     FO: "FO";
     FR: "FR";
     GA: "GA";
     GB: "GB";
     GD: "GD";
     GE: "GE";
     GF: "GF";
     GG: "GG";
     GH: "GH";
     GI: "GI";
     GL: "GL";
     GM: "GM";
     GN: "GN";
     GP: "GP";
     GQ: "GQ";
     GR: "GR";
     GS: "GS";
     GT: "GT";
     GU: "GU";
     GW: "GW";
     GY: "GY";
     HK: "HK";
     HM: "HM";
     HN: "HN";
     HR: "HR";
     HT: "HT";
     HU: "HU";
     ID: "ID";
     IE: "IE";
     IL: "IL";
     IM: "IM";
     IN: "IN";
     IO: "IO";
     IQ: "IQ";
     IR: "IR";
     IS: "IS";
     IT: "IT";
     JE: "JE";
     JM: "JM";
     JO: "JO";
     JP: "JP";
     KE: "KE";
     KG: "KG";
     KH: "KH";
     KI: "KI";
     KM: "KM";
     KN: "KN";
     KP: "KP";
     KR: "KR";
     KW: "KW";
     KY: "KY";
     KZ: "KZ";
     LA: "LA";
     LB: "LB";
     LC: "LC";
     LI: "LI";
     LK: "LK";
     LR: "LR";
     LS: "LS";
     LT: "LT";
     LU: "LU";
     LV: "LV";
     LY: "LY";
     MA: "MA";
     MC: "MC";
     MD: "MD";
     ME: "ME";
     MF: "MF";
     MG: "MG";
     MH: "MH";
     MK: "MK";
     ML: "ML";
     MM: "MM";
     MN: "MN";
     MO: "MO";
     MP: "MP";
     MQ: "MQ";
     MR: "MR";
     MS: "MS";
     MT: "MT";
     MU: "MU";
     MV: "MV";
     MW: "MW";
     MX: "MX";
     MY: "MY";
     MZ: "MZ";
     NA: "NA";
     NC: "NC";
     NE: "NE";
     NF: "NF";
     NG: "NG";
     NI: "NI";
     NL: "NL";
     NO: "NO";
     NP: "NP";
     NR: "NR";
     NU: "NU";
     NZ: "NZ";
     OM: "OM";
     PA: "PA";
     PE: "PE";
     PF: "PF";
     PG: "PG";
     PH: "PH";
     PK: "PK";
     PL: "PL";
     PM: "PM";
     PN: "PN";
     PR: "PR";
     PS: "PS";
     PT: "PT";
     PW: "PW";
     PY: "PY";
     QA: "QA";
     RE: "RE";
     RO: "RO";
     RS: "RS";
     RU: "RU";
     RW: "RW";
     SA: "SA";
     SB: "SB";
     SC: "SC";
     SD: "SD";
     SE: "SE";
     SG: "SG";
     SH: "SH";
     SI: "SI";
     SJ: "SJ";
     SK: "SK";
     SL: "SL";
     SM: "SM";
     SN: "SN";
     SO: "SO";
     SR: "SR";
     SS: "SS";
     ST: "ST";
     SV: "SV";
     SY: "SY";
     SZ: "SZ";
     TC: "TC";
     TD: "TD";
     TF: "TF";
     TG: "TG";
     TH: "TH";
     TJ: "TJ";
     TK: "TK";
     TL: "TL";
     TM: "TM";
     TN: "TN";
     TO: "TO";
     TR: "TR";
     TT: "TT";
     TV: "TV";
     TW: "TW";
     TZ: "TZ";
     UA: "UA";
     UG: "UG";
     UM: "UM";
     US: "US";
     UY: "UY";
     UZ: "UZ";
     VA: "VA";
     VC: "VC";
     VE: "VE";
     VG: "VG";
     VI: "VI";
     VN: "VN";
     VU: "VU";
     WF: "WF";
     WS: "WS";
     YE: "YE";
     ZM: "ZM";
     ZW: "ZW";
  }>>;
  company: ZodString;
  city: ZodString;
  role: ZodString;
  phoneNumber: ZodString;
  type: ZodEnum<{
     STANDARD: "STANDARD";
  }>;
  emailNotifications: ZodBoolean;
  emailNewsletterUpdates: ZodBoolean;
  emailAssetLikeNotifications: ZodBoolean;
  emailCommentLikeNotifications: ZodBoolean;
}, $strip>;

---

listUsersSortFields

const listUsersSortFields: readonly ["createdAt", "email", "name", "fullName"];

---

listUsersQuerySchema

const listUsersQuerySchema: ZodObject<{
  pageOffset: ZodOptional<ZodCoercedNumber<unknown>>;
  pageSize: ZodOptional<ZodCoercedNumber<unknown>>;
  sortBy: ZodOptional<ZodEnum<{
     email: "email";
     name: "name";
     createdAt: "createdAt";
     fullName: "fullName";
  }>>;
  sortDir: ZodOptional<ZodEnum<{
     asc: "asc";
     desc: "desc";
  }>>;
  searchText: ZodOptional<ZodString>;
}, $strict>;

---

listUsersResultSchema

const listUsersResultSchema: ZodObject<{
  rows: ZodArray<ZodObject<{
     id: ZodNumber;
     name: ZodString;
  }, $strip>>;
  rowCount: ZodInt;
}, $strict>;

---

listUserPropsSchema

const listUserPropsSchema: ZodObject<{
  query: ZodObject<{
     pageOffset: ZodOptional<ZodCoercedNumber<unknown>>;
     pageSize: ZodOptional<ZodCoercedNumber<unknown>>;
     sortBy: ZodOptional<ZodEnum<{
        email: "email";
        name: "name";
        createdAt: "createdAt";
        fullName: "fullName";
     }>>;
     sortDir: ZodOptional<ZodEnum<{
        asc: "asc";
        desc: "desc";
     }>>;
     searchText: ZodOptional<ZodString>;
  }, $strict>;
}, $strict>;

---

getUserParamsSchema

const getUserParamsSchema: ZodObject<{
  userName: ZodString;
}, $strict> = userNameParamsSchema;

---

getUserPropsSchema

const getUserPropsSchema: ZodObject<{
  params: ZodObject<{
     userName: ZodString;
  }, $strict>;
}, $strict>;

---

getUserPrivateParamsSchema

const getUserPrivateParamsSchema: ZodObject<{
  userName: ZodString;
}, $strict> = userNameParamsSchema;

---

getUserPrivatePropsSchema

const getUserPrivatePropsSchema: ZodObject<{
  params: ZodObject<{
     userName: ZodString;
  }, $strict>;
}, $strict>;

---

updateUserParamsSchema

const updateUserParamsSchema: ZodObject<{
  userName: ZodString;
}, $strict> = userNameParamsSchema;

---

updateUserBodySchema

const updateUserBodySchema: ZodObject<{
  name: ZodOptional<ZodString>;
  fullName: ZodOptional<ZodString>;
  country: ZodOptional<ZodNullable<ZodEnum<{
     "~": "~";
     AD: "AD";
     AE: "AE";
     AF: "AF";
     AG: "AG";
     AI: "AI";
     AL: "AL";
     AM: "AM";
     AO: "AO";
     AQ: "AQ";
     AR: "AR";
     AS: "AS";
     AT: "AT";
     AU: "AU";
     AW: "AW";
     AX: "AX";
     AZ: "AZ";
     BA: "BA";
     BB: "BB";
     BD: "BD";
     BE: "BE";
     BF: "BF";
     BG: "BG";
     BH: "BH";
     BI: "BI";
     BJ: "BJ";
     BL: "BL";
     BM: "BM";
     BN: "BN";
     BO: "BO";
     BQ: "BQ";
     BR: "BR";
     BS: "BS";
     BT: "BT";
     BV: "BV";
     BW: "BW";
     BY: "BY";
     BZ: "BZ";
     CA: "CA";
     CC: "CC";
     CD: "CD";
     CF: "CF";
     CG: "CG";
     CH: "CH";
     CI: "CI";
     CK: "CK";
     CL: "CL";
     CM: "CM";
     CN: "CN";
     CO: "CO";
     CR: "CR";
     CU: "CU";
     CV: "CV";
     CW: "CW";
     CX: "CX";
     CY: "CY";
     CZ: "CZ";
     DE: "DE";
     DJ: "DJ";
     DK: "DK";
     DM: "DM";
     DO: "DO";
     DZ: "DZ";
     EC: "EC";
     EE: "EE";
     EG: "EG";
     EH: "EH";
     ER: "ER";
     ES: "ES";
     ET: "ET";
     FI: "FI";
     FJ: "FJ";
     FK: "FK";
     FM: "FM";
     FO: "FO";
     FR: "FR";
     GA: "GA";
     GB: "GB";
     GD: "GD";
     GE: "GE";
     GF: "GF";
     GG: "GG";
     GH: "GH";
     GI: "GI";
     GL: "GL";
     GM: "GM";
     GN: "GN";
     GP: "GP";
     GQ: "GQ";
     GR: "GR";
     GS: "GS";
     GT: "GT";
     GU: "GU";
     GW: "GW";
     GY: "GY";
     HK: "HK";
     HM: "HM";
     HN: "HN";
     HR: "HR";
     HT: "HT";
     HU: "HU";
     ID: "ID";
     IE: "IE";
     IL: "IL";
     IM: "IM";
     IN: "IN";
     IO: "IO";
     IQ: "IQ";
     IR: "IR";
     IS: "IS";
     IT: "IT";
     JE: "JE";
     JM: "JM";
     JO: "JO";
     JP: "JP";
     KE: "KE";
     KG: "KG";
     KH: "KH";
     KI: "KI";
     KM: "KM";
     KN: "KN";
     KP: "KP";
     KR: "KR";
     KW: "KW";
     KY: "KY";
     KZ: "KZ";
     LA: "LA";
     LB: "LB";
     LC: "LC";
     LI: "LI";
     LK: "LK";
     LR: "LR";
     LS: "LS";
     LT: "LT";
     LU: "LU";
     LV: "LV";
     LY: "LY";
     MA: "MA";
     MC: "MC";
     MD: "MD";
     ME: "ME";
     MF: "MF";
     MG: "MG";
     MH: "MH";
     MK: "MK";
     ML: "ML";
     MM: "MM";
     MN: "MN";
     MO: "MO";
     MP: "MP";
     MQ: "MQ";
     MR: "MR";
     MS: "MS";
     MT: "MT";
     MU: "MU";
     MV: "MV";
     MW: "MW";
     MX: "MX";
     MY: "MY";
     MZ: "MZ";
     NA: "NA";
     NC: "NC";
     NE: "NE";
     NF: "NF";
     NG: "NG";
     NI: "NI";
     NL: "NL";
     NO: "NO";
     NP: "NP";
     NR: "NR";
     NU: "NU";
     NZ: "NZ";
     OM: "OM";
     PA: "PA";
     PE: "PE";
     PF: "PF";
     PG: "PG";
     PH: "PH";
     PK: "PK";
     PL: "PL";
     PM: "PM";
     PN: "PN";
     PR: "PR";
     PS: "PS";
     PT: "PT";
     PW: "PW";
     PY: "PY";
     QA: "QA";
     RE: "RE";
     RO: "RO";
     RS: "RS";
     RU: "RU";
     RW: "RW";
     SA: "SA";
     SB: "SB";
     SC: "SC";
     SD: "SD";
     SE: "SE";
     SG: "SG";
     SH: "SH";
     SI: "SI";
     SJ: "SJ";
     SK: "SK";
     SL: "SL";
     SM: "SM";
     SN: "SN";
     SO: "SO";
     SR: "SR";
     SS: "SS";
     ST: "ST";
     SV: "SV";
     SY: "SY";
     SZ: "SZ";
     TC: "TC";
     TD: "TD";
     TF: "TF";
     TG: "TG";
     TH: "TH";
     TJ: "TJ";
     TK: "TK";
     TL: "TL";
     TM: "TM";
     TN: "TN";
     TO: "TO";
     TR: "TR";
     TT: "TT";
     TV: "TV";
     TW: "TW";
     TZ: "TZ";
     UA: "UA";
     UG: "UG";
     UM: "UM";
     US: "US";
     UY: "UY";
     UZ: "UZ";
     VA: "VA";
     VC: "VC";
     VE: "VE";
     VG: "VG";
     VI: "VI";
     VN: "VN";
     VU: "VU";
     WF: "WF";
     WS: "WS";
     YE: "YE";
     ZM: "ZM";
     ZW: "ZW";
  }>>>;
  city: ZodOptional<ZodString>;
  role: ZodOptional<ZodString>;
  company: ZodOptional<ZodString>;
  phoneNumber: ZodOptional<ZodString>;
  emailNotifications: ZodOptional<ZodBoolean>;
  emailNewsletterUpdates: ZodOptional<ZodBoolean>;
  emailAssetLikeNotifications: ZodOptional<ZodBoolean>;
  emailCommentLikeNotifications: ZodOptional<ZodBoolean>;
}, $strict>;

---

updateUserPropsSchema

const updateUserPropsSchema: ZodObject<{
  params: ZodObject<{
     userName: ZodString;
  }, $strict>;
  body: ZodObject<{
     name: ZodOptional<ZodString>;
     fullName: ZodOptional<ZodString>;
     country: ZodOptional<ZodNullable<ZodEnum<{
        "~": "~";
        AD: "AD";
        AE: "AE";
        AF: "AF";
        AG: "AG";
        AI: "AI";
        AL: "AL";
        AM: "AM";
        AO: "AO";
        AQ: "AQ";
        AR: "AR";
        AS: "AS";
        AT: "AT";
        AU: "AU";
        AW: "AW";
        AX: "AX";
        AZ: "AZ";
        BA: "BA";
        BB: "BB";
        BD: "BD";
        BE: "BE";
        BF: "BF";
        BG: "BG";
        BH: "BH";
        BI: "BI";
        BJ: "BJ";
        BL: "BL";
        BM: "BM";
        BN: "BN";
        BO: "BO";
        BQ: "BQ";
        BR: "BR";
        BS: "BS";
        BT: "BT";
        BV: "BV";
        BW: "BW";
        BY: "BY";
        BZ: "BZ";
        CA: "CA";
        CC: "CC";
        CD: "CD";
        CF: "CF";
        CG: "CG";
        CH: "CH";
        CI: "CI";
        CK: "CK";
        CL: "CL";
        CM: "CM";
        CN: "CN";
        CO: "CO";
        CR: "CR";
        CU: "CU";
        CV: "CV";
        CW: "CW";
        CX: "CX";
        CY: "CY";
        CZ: "CZ";
        DE: "DE";
        DJ: "DJ";
        DK: "DK";
        DM: "DM";
        DO: "DO";
        DZ: "DZ";
        EC: "EC";
        EE: "EE";
        EG: "EG";
        EH: "EH";
        ER: "ER";
        ES: "ES";
        ET: "ET";
        FI: "FI";
        FJ: "FJ";
        FK: "FK";
        FM: "FM";
        FO: "FO";
        FR: "FR";
        GA: "GA";
        GB: "GB";
        GD: "GD";
        GE: "GE";
        GF: "GF";
        GG: "GG";
        GH: "GH";
        GI: "GI";
        GL: "GL";
        GM: "GM";
        GN: "GN";
        GP: "GP";
        GQ: "GQ";
        GR: "GR";
        GS: "GS";
        GT: "GT";
        GU: "GU";
        GW: "GW";
        GY: "GY";
        HK: "HK";
        HM: "HM";
        HN: "HN";
        HR: "HR";
        HT: "HT";
        HU: "HU";
        ID: "ID";
        IE: "IE";
        IL: "IL";
        IM: "IM";
        IN: "IN";
        IO: "IO";
        IQ: "IQ";
        IR: "IR";
        IS: "IS";
        IT: "IT";
        JE: "JE";
        JM: "JM";
        JO: "JO";
        JP: "JP";
        KE: "KE";
        KG: "KG";
        KH: "KH";
        KI: "KI";
        KM: "KM";
        KN: "KN";
        KP: "KP";
        KR: "KR";
        KW: "KW";
        KY: "KY";
        KZ: "KZ";
        LA: "LA";
        LB: "LB";
        LC: "LC";
        LI: "LI";
        LK: "LK";
        LR: "LR";
        LS: "LS";
        LT: "LT";
        LU: "LU";
        LV: "LV";
        LY: "LY";
        MA: "MA";
        MC: "MC";
        MD: "MD";
        ME: "ME";
        MF: "MF";
        MG: "MG";
        MH: "MH";
        MK: "MK";
        ML: "ML";
        MM: "MM";
        MN: "MN";
        MO: "MO";
        MP: "MP";
        MQ: "MQ";
        MR: "MR";
        MS: "MS";
        MT: "MT";
        MU: "MU";
        MV: "MV";
        MW: "MW";
        MX: "MX";
        MY: "MY";
        MZ: "MZ";
        NA: "NA";
        NC: "NC";
        NE: "NE";
        NF: "NF";
        NG: "NG";
        NI: "NI";
        NL: "NL";
        NO: "NO";
        NP: "NP";
        NR: "NR";
        NU: "NU";
        NZ: "NZ";
        OM: "OM";
        PA: "PA";
        PE: "PE";
        PF: "PF";
        PG: "PG";
        PH: "PH";
        PK: "PK";
        PL: "PL";
        PM: "PM";
        PN: "PN";
        PR: "PR";
        PS: "PS";
        PT: "PT";
        PW: "PW";
        PY: "PY";
        QA: "QA";
        RE: "RE";
        RO: "RO";
        RS: "RS";
        RU: "RU";
        RW: "RW";
        SA: "SA";
        SB: "SB";
        SC: "SC";
        SD: "SD";
        SE: "SE";
        SG: "SG";
        SH: "SH";
        SI: "SI";
        SJ: "SJ";
        SK: "SK";
        SL: "SL";
        SM: "SM";
        SN: "SN";
        SO: "SO";
        SR: "SR";
        SS: "SS";
        ST: "ST";
        SV: "SV";
        SY: "SY";
        SZ: "SZ";
        TC: "TC";
        TD: "TD";
        TF: "TF";
        TG: "TG";
        TH: "TH";
        TJ: "TJ";
        TK: "TK";
        TL: "TL";
        TM: "TM";
        TN: "TN";
        TO: "TO";
        TR: "TR";
        TT: "TT";
        TV: "TV";
        TW: "TW";
        TZ: "TZ";
        UA: "UA";
        UG: "UG";
        UM: "UM";
        US: "US";
        UY: "UY";
        UZ: "UZ";
        VA: "VA";
        VC: "VC";
        VE: "VE";
        VG: "VG";
        VI: "VI";
        VN: "VN";
        VU: "VU";
        WF: "WF";
        WS: "WS";
        YE: "YE";
        ZM: "ZM";
        ZW: "ZW";
     }>>>;
     city: ZodOptional<ZodString>;
     role: ZodOptional<ZodString>;
     company: ZodOptional<ZodString>;
     phoneNumber: ZodOptional<ZodString>;
     emailNotifications: ZodOptional<ZodBoolean>;
     emailNewsletterUpdates: ZodOptional<ZodBoolean>;
     emailAssetLikeNotifications: ZodOptional<ZodBoolean>;
     emailCommentLikeNotifications: ZodOptional<ZodBoolean>;
  }, $strict>;
}, $strict>;

---

deleteUserParamsSchema

const deleteUserParamsSchema: ZodObject<{
  userName: ZodString;
}, $strict> = userNameParamsSchema;

---

deleteUserResultSchema

const deleteUserResultSchema: ZodVoid;

---

deleteUserPropsSchema

const deleteUserPropsSchema: ZodObject<{
  params: ZodObject<{
     userName: ZodString;
  }, $strict>;
}, $strict>;

---

userSessionSchema

const userSessionSchema: ZodObject<{
  id: ZodNumber;
  ipAddress: ZodString;
  browser: ZodNullable<ZodString>;
  os: ZodNullable<ZodString>;
  client: ZodNullable<ZodString>;
  createdAt: ZodISODateTime;
  lastUsedAt: ZodISODateTime;
  expiresAt: ZodISODateTime;
}, $strict>;

---

listUserSessionsSortFields

const listUserSessionsSortFields: readonly ["createdAt", "lastUsedAt", "expiresAt", "ipAddress"];

---

listUserSessionsQuerySchema

const listUserSessionsQuerySchema: ZodObject<{
  pageOffset: ZodOptional<ZodCoercedNumber<unknown>>;
  pageSize: ZodOptional<ZodCoercedNumber<unknown>>;
  sortBy: ZodOptional<ZodEnum<{
     createdAt: "createdAt";
     lastUsedAt: "lastUsedAt";
     ipAddress: "ipAddress";
     expiresAt: "expiresAt";
  }>>;
  sortDir: ZodOptional<ZodEnum<{
     asc: "asc";
     desc: "desc";
  }>>;
}, $strip>;

---

listUserSessionsResultSchema

const listUserSessionsResultSchema: ZodObject<{
  rows: ZodArray<ZodObject<{
     id: ZodNumber;
     ipAddress: ZodString;
     browser: ZodNullable<ZodString>;
     os: ZodNullable<ZodString>;
     client: ZodNullable<ZodString>;
     createdAt: ZodISODateTime;
     lastUsedAt: ZodISODateTime;
     expiresAt: ZodISODateTime;
  }, $strict>>;
  rowCount: ZodInt;
}, $strict>;

---

listUserSessionsParamsSchema

const listUserSessionsParamsSchema: ZodObject<{
  userName: ZodString;
}, $strict> = userNameParamsSchema;

---

listUserSessionsPropsSchema

const listUserSessionsPropsSchema: ZodObject<{
  params: ZodObject<{
     userName: ZodString;
  }, $strict>;
  query: ZodObject<{
     pageOffset: ZodOptional<ZodCoercedNumber<unknown>>;
     pageSize: ZodOptional<ZodCoercedNumber<unknown>>;
     sortBy: ZodOptional<ZodEnum<{
        createdAt: "createdAt";
        lastUsedAt: "lastUsedAt";
        ipAddress: "ipAddress";
        expiresAt: "expiresAt";
     }>>;
     sortDir: ZodOptional<ZodEnum<{
        asc: "asc";
        desc: "desc";
     }>>;
  }, $strip>;
}, $strict>;

---

endUserSessionParamsSchema

const endUserSessionParamsSchema: ZodObject<{
  userName: ZodString;
  sessionId: ZodCoercedNumber<unknown>;
}, $strict>;

---

endUserSessionPropsSchema

const endUserSessionPropsSchema: ZodObject<{
  params: ZodObject<{
     userName: ZodString;
     sessionId: ZodCoercedNumber<unknown>;
  }, $strict>;
}, $strict>;