@caraer/client 2.0.381 → 2.0.382

package/docs/AppConnectionStatusDTO.md

@@ -0,0 +1,38 @@
+# AppConnectionStatusDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**label** | **string** |  | [optional] [default to undefined]
+**preset** | **string** |  | [optional] [default to undefined]
+**logo** | **string** |  | [optional] [default to undefined]
+**connected** | **boolean** |  | [optional] [default to undefined]
+**ownerType** | **string** |  | [optional] [default to undefined]
+**ownerUserUuid** | **string** |  | [optional] [default to undefined]
+**accountLabel** | **string** |  | [optional] [default to undefined]
+**connectedAt** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AppConnectionStatusDTO } from '@caraer/client';
+
+const instance: AppConnectionStatusDTO = {
+    id,
+    name,
+    label,
+    preset,
+    logo,
+    connected,
+    ownerType,
+    ownerUserUuid,
+    accountLabel,
+    connectedAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AppDTO.md

@@ -17,7 +17,7 @@ Name | Type | Description | Notes
 **deletedBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who deleted the entity | [optional] [default to undefined]
 **index** | **number** | Index number for ordering entities | [optional] [default to undefined]
 **privateApp** | **boolean** | Indicates whether this app is private (only available to the creator\'s company) | [optional] [default to undefined]
-**hideApiKeyField** | **boolean** | Whether to hide the API token field in app settings UI | [optional] [default to undefined]
+**hideApiKeyField** | **boolean** | Whether to hide the API token field in app settings UI. Defaults to true when omitted. | [optional] [default to undefined]
 **details** | [**AppDetailsDTO**](AppDetailsDTO.md) | Additional details and specifications about the application | [optional] [default to undefined]
 **pricingPlans** | [**Array<AppPricingDTO>**](AppPricingDTO.md) | Pricing information for the application | [optional] [default to undefined]
 **appBars** | [**Array<AppBarDTO>**](AppBarDTO.md) | App bars (location-specific configuration and actions) | [optional] [default to undefined]
@@ -27,7 +27,9 @@ Name | Type | Description | Notes
 **rotateWebhook** | [**SubscribeWebhookDTO**](SubscribeWebhookDTO.md) | Webhook triggered when the app installation token is rotated | [optional] [default to undefined]
 **updateWebhook** | [**SubscribeWebhookDTO**](SubscribeWebhookDTO.md) | Webhook triggered when an already installed app is saved again | [optional] [default to undefined]
 **settingsSchema** | [**Array<AppSettingFieldSchema>**](AppSettingFieldSchema.md) | JSON array of AppSettingFieldSchema (app-level setting field definitions) | [optional] [default to undefined]
+**externalOAuthProviders** | [**Array<AppExternalOAuthProviderSummaryDTO>**](AppExternalOAuthProviderSummaryDTO.md) | External OAuth providers installers can Connect (name/logo only; no secrets) | [optional] [default to undefined]
 **webhookRateLimitPerMinute** | **number** | Webhook rate limit per minute | [optional] [default to undefined]
+**jobRateLimitPerMinute** | **number** | App job enqueue rate limit per minute per installation | [optional] [default to undefined]
 **billFailedWebhookRequests** | **boolean** | Whether failed webhook requests are considered billable for this app | [optional] [default to undefined]
 **appPublish** | [**AppPublishDTO**](AppPublishDTO.md) | Publish and review state for the app in the marketplace (creator view) | [optional] [default to undefined]
 **hasApp** | [**HasAppDTO**](HasAppDTO.md) | Installation link (company–app) with token, scopes, and per-installation settingsValues; present when includeSettings is true | [optional] [default to undefined]
@@ -47,6 +49,13 @@ Name | Type | Description | Notes
 **installUrl** | **string** | External URL where end users install this app (e.g. ChatGPT connector page) | [optional] [default to undefined]
 **brandmark** | **string** | Square brandmark URL used in compact app surfaces | [optional] [default to undefined]
 **description** | **string** | Internal app description used in Caraer admin views | [optional] [default to undefined]
+**platformVersion** | **number** | App platform version: 1 = legacy per-function Cloud Functions; 2 = one container per app | [optional] [default to undefined]
+**runtime** | **string** | Serverless runtime for platform V2 apps (nodejs22 or python312) | [optional] [default to undefined]
+**runtimeBaseUrl** | **string** | Base HTTPS URL of the V2 app container runtime | [optional] [default to undefined]
+**runtimeRevision** | **string** | Last deployed runtime revision id | [optional] [default to undefined]
+**runtimeStatus** | **string** | V2 runtime status: PENDING, PROVISIONING, READY, FAILED | [optional] [default to undefined]
+**runtimeError** | **string** | Last V2 runtime error message when FAILED | [optional] [default to undefined]
+**runtimeGeneration** | **number** | Monotonic generation for async runtime jobs | [optional] [default to undefined]
 
 ## Example
 
@@ -75,7 +84,9 @@ const instance: AppDTO = {
     rotateWebhook,
     updateWebhook,
     settingsSchema,
+    externalOAuthProviders,
     webhookRateLimitPerMinute,
+    jobRateLimitPerMinute,
     billFailedWebhookRequests,
     appPublish,
     hasApp,
@@ -95,6 +106,13 @@ const instance: AppDTO = {
     installUrl,
     brandmark,
     description,
+    platformVersion,
+    runtime,
+    runtimeBaseUrl,
+    runtimeRevision,
+    runtimeStatus,
+    runtimeError,
+    runtimeGeneration,
 };
 ```
 

package/docs/AppExternalOAuthProviderDTO.md

@@ -0,0 +1,59 @@
+# AppExternalOAuthProviderDTO
+
+Third-party OAuth provider declared on an app
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** | Unique identifier for the entity | [default to undefined]
+**name** | **string** | The name of the entity | [default to undefined]
+**label** | **string** | Display label for the entity, can be different from name | [optional] [default to undefined]
+**createdAt** | **number** | Unix timestamp when the entity was created | [optional] [default to undefined]
+**createdBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who created the entity | [optional] [default to undefined]
+**updatedAt** | **number** | Unix timestamp when the entity was last updated | [optional] [default to undefined]
+**updatedBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who last updated the entity | [optional] [default to undefined]
+**deletedAt** | **number** | Unix timestamp when the entity was deleted (null if not deleted) | [optional] [default to undefined]
+**deletedBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who deleted the entity | [optional] [default to undefined]
+**index** | **number** | Index number for ordering entities | [optional] [default to undefined]
+**preset** | **string** | Ignored. Set authorizeUrl and tokenUrl explicitly. | [optional] [default to undefined]
+**logo** | **string** | Optional logo URL shown on the Connect button | [optional] [default to undefined]
+**authorizeUrl** | **string** |  | [optional] [default to undefined]
+**tokenUrl** | **string** |  | [optional] [default to undefined]
+**clientId** | **string** |  | [optional] [default to undefined]
+**clientSecret** | **string** |  | [optional] [default to undefined]
+**hasClientSecret** | **boolean** |  | [optional] [default to undefined]
+**scopes** | **Array<string>** |  | [optional] [default to undefined]
+**pkce** | **boolean** |  | [optional] [default to undefined]
+**connectionOwner** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AppExternalOAuthProviderDTO } from '@caraer/client';
+
+const instance: AppExternalOAuthProviderDTO = {
+    uuid,
+    name,
+    label,
+    createdAt,
+    createdBy,
+    updatedAt,
+    updatedBy,
+    deletedAt,
+    deletedBy,
+    index,
+    preset,
+    logo,
+    authorizeUrl,
+    tokenUrl,
+    clientId,
+    clientSecret,
+    hasClientSecret,
+    scopes,
+    pkce,
+    connectionOwner,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AppExternalOAuthProviderSummaryDTO.md

@@ -0,0 +1,27 @@
+# AppExternalOAuthProviderSummaryDTO
+
+Lightweight external OAuth provider summary (no secrets)
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**label** | **string** |  | [optional] [default to undefined]
+**logo** | **string** |  | [optional] [default to undefined]
+**connectionOwner** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AppExternalOAuthProviderSummaryDTO } from '@caraer/client';
+
+const instance: AppExternalOAuthProviderSummaryDTO = {
+    name,
+    label,
+    logo,
+    connectionOwner,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AppInboundRouteDTO.md

@@ -0,0 +1,49 @@
+# AppInboundRouteDTO
+
+Public inbound route into an app function
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** | Unique identifier for the entity | [default to undefined]
+**name** | **string** | The name of the entity | [default to undefined]
+**label** | **string** | Display label for the entity, can be different from name | [optional] [default to undefined]
+**createdAt** | **number** | Unix timestamp when the entity was created | [optional] [default to undefined]
+**createdBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who created the entity | [optional] [default to undefined]
+**updatedAt** | **number** | Unix timestamp when the entity was last updated | [optional] [default to undefined]
+**updatedBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who last updated the entity | [optional] [default to undefined]
+**deletedAt** | **number** | Unix timestamp when the entity was deleted (null if not deleted) | [optional] [default to undefined]
+**deletedBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who deleted the entity | [optional] [default to undefined]
+**index** | **number** | Index number for ordering entities | [optional] [default to undefined]
+**authMode** | **string** |  | [optional] [default to undefined]
+**enqueue** | **boolean** |  | [optional] [default to undefined]
+**hasSharedSecret** | **boolean** |  | [optional] [default to undefined]
+**sharedSecret** | **string** |  | [optional] [default to undefined]
+**serverlessFunction** | [**ServerlessFunctionRefDTO**](ServerlessFunctionRefDTO.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AppInboundRouteDTO } from '@caraer/client';
+
+const instance: AppInboundRouteDTO = {
+    uuid,
+    name,
+    label,
+    createdAt,
+    createdBy,
+    updatedAt,
+    updatedBy,
+    deletedAt,
+    deletedBy,
+    index,
+    authMode,
+    enqueue,
+    hasSharedSecret,
+    sharedSecret,
+    serverlessFunction,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)