Class: FunctionsManager
Manages serverless functions (settings, runtime, and CRUD) for a project.
Constructors
new FunctionsManager()
Internal
Parameters
| Parameter | Type |
|---|---|
ctx | ClientContext |
projectId | string |
Returns
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/functions.ts:46
Methods
activate()
Activate Functions for this project (async)
Parameters
| Parameter | Type | Description |
|---|---|---|
body | object | Activation payload |
body.locationCity | string | Description Deployment location city Example frankfurt |
body.locationCityDisplay? | string | Description Deployment location city display name Example Frankfurt, Germany |
body.locationContinent | string | Description Deployment location continent Example europe |
body.locationCountry | string | Description Deployment location country Example de |
body.locationIsProtected? | boolean | Description Whether location is DDoS protected. Defaults to false when omitted. |
body.resourcePackage? | string | Description Resource package slug. Defaults to "fleet-s1" when omitted. Example fleet-s1 |
Returns
Promise<object>
Activation confirmation
| Name | Type | Description | Defined in |
|---|---|---|---|
message | string | Description Status message Example Activation started | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4942 |
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/functions.ts:124
create()
Create a new serverless function
Parameters
| Parameter | Type | Description |
|---|---|---|
body | object | Function creation payload |
body.authMode? | "api_key" | "public" | "signed" | "participant" | Description Authentication mode. Defaults to "api_key" when omitted. Use participant to let game clients call this function directly with a participant token; the verified identity arrives as event.auth. |
body.code | string | Description Initial source code Example exports.handler = async (event, ctx) => { return { statusCode: 200, body: "Hello" }; }; |
body.description? | string | Description Function description |
body.entrypoint? | string | Description Entrypoint function name. Defaults to "handler" when omitted. |
body.envVars? | object[] | Description Initial environment variables |
body.memory? | number | Description Memory limit in MB (128-1024). Defaults to 256 when omitted. |
body.name | string | Description Function name Example process-webhook |
body.runtime? | "nodejs20" | "nodejs22" | Description Runtime environment. Defaults to "nodejs20" when omitted. |
body.slug? | string | Description URL-friendly slug (auto-generated if not provided) Example process-webhook |
body.timeout? | number | Description Execution timeout in ms (1000-300000). Defaults to 30000 when omitted. |
Returns
Promise<CortexFunctionInstance>
Live CortexFunctionInstance object
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/functions.ts:277
get()
Get a function by ID
Parameters
| Parameter | Type | Description |
|---|---|---|
functionId | string | Function ID |
Returns
Promise<CortexFunctionInstance>
Live CortexFunctionInstance object
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/functions.ts:291
getDeploymentLocations()
Get available deployment locations
Returns
Promise<object[]>
Array of locations
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/functions.ts:110
getNpmPackageInfo()
Lookup npm package versions
Parameters
| Parameter | Type | Description |
|---|---|---|
packageName | string | NPM package name |
Returns
Promise<object>
Package info with available versions
| Name | Type | Description | Defined in |
|---|---|---|---|
distTags | object | Description Dist tags (latest, next, beta, etc.) Example { * "latest": "6.0.6", * "next": "7.0.0-beta.1" * } | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:5014 |
name | string | Description Package name Example node-mailjet | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4997 |
versions | string[] | Description All available versions (sorted newest first) Example [ "6.0.6", "6.0.5", "6.0.4" ] | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:5006 |
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/functions.ts:166
getResourcePackages()
Get available resource packages for function deployment
Returns
Promise<object[]>
Array of resource packages
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/functions.ts:97
getRuntimeStatus()
Get function runtime status
Returns
Promise<object>
Runtime status
| Name | Type | Description | Defined in |
|---|---|---|---|
fleetDeploymentId? | number | Description Fleet deployment ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:5027 |
latestVersion? | string | Description The latest available runtime version Example v1 | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:5039 |
message | string | Description Status message | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:5029 |
runtimeVersion? | null | string | Description Runtime version this deployment is pinned to (null = legacy/unpinned) Example v1 | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:5034 |
serverCount? | number | Description Number of running servers | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:5025 |
status | | "running" | "stopped" | "starting" | "stopping" | "unknown" | Description Runtime status | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:5023 |
upgradeAvailable? | boolean | Description Whether a newer runtime version is available to upgrade to | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:5041 |
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/functions.ts:181
getRuntimeVersions()
List the available function-runtime versions and the project's current pin.
Returns
Promise<object>
Runtime version catalog (current, latest, upgradeAvailable, versions)
| Name | Type | Description | Defined in |
|---|---|---|---|
current | null | string | Description Version the project is currently pinned to (null = legacy/unpinned) Example v1 | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:5093 |
latest | string | Description The latest available runtime version Example v1 | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:5098 |
upgradeAvailable | boolean | Description Whether a newer runtime version is available | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:5100 |
versions | object[] | Description All published runtime versions (oldest first) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:5102 |
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/functions.ts:233
getSettings()
Get function settings
Returns
Promise<object>
Function settings
| Name | Type | Description | Defined in |
|---|---|---|---|
activationError? | string | Description Error message if activation failed | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4804 |
activationStep? | | "pending" | "registry" | "image" | "config" | "deployment" | "server" | "complete" | "error" | Description Current activation step (for async progress tracking) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4802 |
dependencies? | object[] | Description NPM dependencies shared by all functions | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4841 |
envVars? | object[] | Description Environment variables shared by all functions (secrets masked) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4843 |
fleetAppId? | number | Description Fleet app ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4806 |
fleetDeploymentId? | number | Description Fleet deployment ID (app location setting) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4814 |
fleetImageId? | string | Description Fleet binary/image ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4810 |
fleetRegion? | string | Description Fleet region (deprecated, use locationCity) Example eu-west | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4829 |
fleetRegistryId? | number | Description Fleet Docker registry ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4808 |
fleetServerConfigId? | string | Description Fleet server config ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4812 |
isActivated | boolean | Description Whether Functions feature is activated | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4797 |
locationCity? | string | Description Deployment location city Example frankfurt | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4824 |
maxFunctions | number | Description Maximum functions allowed Example 10 | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4834 |
maxMemoryPerFunction | number | Description Maximum memory per function (MB) Example 512 | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4839 |
resourcePackageSlug? | string | Description Resource package slug Example fleet-s1 | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4819 |
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/functions.ts:57
list()
List functions for this project
Returns
Promise<object[]>
Array of functions
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/functions.ts:263
restartRuntime()
Restart the function runtime
Returns
Promise<object>
Restart confirmation
| Name | Type | Description | Defined in |
|---|---|---|---|
message | string | Description Status message Example Runtime started successfully | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:5048 |
status | | "running" | "stopped" | "starting" | "stopping" | "unknown" | Description New runtime status | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:5053 |
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/functions.ts:220
startRuntime()
Start the function runtime
Returns
Promise<object>
Start confirmation
| Name | Type | Description | Defined in |
|---|---|---|---|
message | string | Description Status message Example Runtime started successfully | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:5048 |
status | | "running" | "stopped" | "starting" | "stopping" | "unknown" | Description New runtime status | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:5053 |
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/functions.ts:194
stopRuntime()
Stop the function runtime
Returns
Promise<object>
Stop confirmation
| Name | Type | Description | Defined in |
|---|---|---|---|
message | string | Description Status message Example Runtime stopped successfully | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:5060 |
status | | "running" | "stopped" | "starting" | "stopping" | "unknown" | Description New runtime status | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:5065 |
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/functions.ts:207
updateDependencies()
Update project-wide function dependencies
Parameters
| Parameter | Type | Description |
|---|---|---|
body | object | Dependencies payload |
body.dependencies | object[] | Description NPM dependencies for the project |
Returns
Promise<object>
Updated settings with message
| Name | Type | Description | Defined in |
|---|---|---|---|
message | string | Description Status message Example Dependencies updated. Runtime restarting... | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4963 |
settings | object | Description Updated settings | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4958 |
settings.activationError? | string | Description Error message if activation failed | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4804 |
settings.activationStep? | | "pending" | "registry" | "image" | "config" | "deployment" | "server" | "complete" | "error" | Description Current activation step (for async progress tracking) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4802 |
settings.dependencies? | object[] | Description NPM dependencies shared by all functions | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4841 |
settings.envVars? | object[] | Description Environment variables shared by all functions (secrets masked) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4843 |
settings.fleetAppId? | number | Description Fleet app ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4806 |
settings.fleetDeploymentId? | number | Description Fleet deployment ID (app location setting) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4814 |
settings.fleetImageId? | string | Description Fleet binary/image ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4810 |
settings.fleetRegion? | string | Description Fleet region (deprecated, use locationCity) Example eu-west | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4829 |
settings.fleetRegistryId? | number | Description Fleet Docker registry ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4808 |
settings.fleetServerConfigId? | string | Description Fleet server config ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4812 |
settings.isActivated | boolean | Description Whether Functions feature is activated | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4797 |
settings.locationCity? | string | Description Deployment location city Example frankfurt | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4824 |
settings.maxFunctions | number | Description Maximum functions allowed Example 10 | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4834 |
settings.maxMemoryPerFunction | number | Description Maximum memory per function (MB) Example 512 | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4839 |
settings.resourcePackageSlug? | string | Description Resource package slug Example fleet-s1 | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4819 |
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/functions.ts:138
updateEnvVars()
Update project-wide environment variables
Parameters
| Parameter | Type | Description |
|---|---|---|
body | object | Environment variables payload |
body.envVars | object[] | Description Environment variables for the project |
Returns
Promise<object>
Updated settings with message
| Name | Type | Description | Defined in |
|---|---|---|---|
message | string | Description Status message Example Environment variables updated. Runtime restarting... | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4990 |
settings | object | Description Updated settings | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4985 |
settings.activationError? | string | Description Error message if activation failed | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4804 |
settings.activationStep? | | "pending" | "registry" | "image" | "config" | "deployment" | "server" | "complete" | "error" | Description Current activation step (for async progress tracking) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4802 |
settings.dependencies? | object[] | Description NPM dependencies shared by all functions | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4841 |
settings.envVars? | object[] | Description Environment variables shared by all functions (secrets masked) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4843 |
settings.fleetAppId? | number | Description Fleet app ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4806 |
settings.fleetDeploymentId? | number | Description Fleet deployment ID (app location setting) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4814 |
settings.fleetImageId? | string | Description Fleet binary/image ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4810 |
settings.fleetRegion? | string | Description Fleet region (deprecated, use locationCity) Example eu-west | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4829 |
settings.fleetRegistryId? | number | Description Fleet Docker registry ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4808 |
settings.fleetServerConfigId? | string | Description Fleet server config ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4812 |
settings.isActivated | boolean | Description Whether Functions feature is activated | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4797 |
settings.locationCity? | string | Description Deployment location city Example frankfurt | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4824 |
settings.maxFunctions | number | Description Maximum functions allowed Example 10 | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4834 |
settings.maxMemoryPerFunction | number | Description Maximum memory per function (MB) Example 512 | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4839 |
settings.resourcePackageSlug? | string | Description Resource package slug Example fleet-s1 | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4819 |
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/functions.ts:152
updateSettings()
Update function settings
Parameters
| Parameter | Type | Description |
|---|---|---|
body | object | Updated settings |
body.fleetRegion? | string | Description Fleet region |
body.maxFunctions? | number | Description Maximum functions allowed (requires upgrade) |
body.maxMemoryPerFunction? | number | Description Maximum memory per function (MB) |
Returns
Promise<object>
Updated function settings
| Name | Type | Description | Defined in |
|---|---|---|---|
activationError? | string | Description Error message if activation failed | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4804 |
activationStep? | | "pending" | "registry" | "image" | "config" | "deployment" | "server" | "complete" | "error" | Description Current activation step (for async progress tracking) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4802 |
dependencies? | object[] | Description NPM dependencies shared by all functions | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4841 |
envVars? | object[] | Description Environment variables shared by all functions (secrets masked) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4843 |
fleetAppId? | number | Description Fleet app ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4806 |
fleetDeploymentId? | number | Description Fleet deployment ID (app location setting) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4814 |
fleetImageId? | string | Description Fleet binary/image ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4810 |
fleetRegion? | string | Description Fleet region (deprecated, use locationCity) Example eu-west | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4829 |
fleetRegistryId? | number | Description Fleet Docker registry ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4808 |
fleetServerConfigId? | string | Description Fleet server config ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4812 |
isActivated | boolean | Description Whether Functions feature is activated | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4797 |
locationCity? | string | Description Deployment location city Example frankfurt | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4824 |
maxFunctions | number | Description Maximum functions allowed Example 10 | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4834 |
maxMemoryPerFunction | number | Description Maximum memory per function (MB) Example 512 | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4839 |
resourcePackageSlug? | string | Description Resource package slug Example fleet-s1 | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4819 |
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/functions.ts:71
upgradeRuntime()
Upgrade (or change) the pinned runtime version. Swaps the Fleet binary image and restarts the runtime so the new image is pulled.
Parameters
| Parameter | Type | Description |
|---|---|---|
version | string | The runtime version to deploy (e.g. "v1") |
Returns
Promise<object>
Runtime status after triggering the upgrade
| Name | Type | Description | Defined in |
|---|---|---|---|
fleetDeploymentId? | number | Description Fleet deployment ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:5027 |
latestVersion? | string | Description The latest available runtime version Example v1 | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:5039 |
message | string | Description Status message | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:5029 |
runtimeVersion? | null | string | Description Runtime version this deployment is pinned to (null = legacy/unpinned) Example v1 | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:5034 |
serverCount? | number | Description Number of running servers | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:5025 |
status | | "running" | "stopped" | "starting" | "stopping" | "unknown" | Description Runtime status | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:5023 |
upgradeAvailable? | boolean | Description Whether a newer runtime version is available to upgrade to | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:5041 |
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/functions.ts:248
verifyFleetCredentials()
Verify Fleet credentials for function activation
Returns
Promise<object>
Verification result
| Name | Type | Description | Defined in |
|---|---|---|---|
email | string | Description User email | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4849 |
valid | boolean | Description Whether credentials are valid | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4847 |
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/functions.ts:84