@caraer/client 2.0.381 → 2.0.382

package/docs/BulkEditRecordsRequest.md

@@ -0,0 +1,21 @@
+# BulkEditRecordsRequest
+
+Request to create or update multiple records in one operation.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**records** | [**Array<BulkEditRecordItem>**](BulkEditRecordItem.md) | Records to create or update. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BulkEditRecordsRequest } from '@caraer/client';
+
+const instance: BulkEditRecordsRequest = {
+    records,
+};
+```
+
+[[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/BulkEditRecordsResponse.md

@@ -0,0 +1,25 @@
+# BulkEditRecordsResponse
+
+Response for a bulk create/update records operation.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | Result message. | [optional] [default to undefined]
+**data** | [**BulkEditRecordsData**](BulkEditRecordsData.md) | Successfully saved records. | [optional] [default to undefined]
+**errors** | [**Array<BulkEditRecordErrorItem>**](BulkEditRecordErrorItem.md) | Per-record errors when one or more items failed validation. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BulkEditRecordsResponse } from '@caraer/client';
+
+const instance: BulkEditRecordsResponse = {
+    message,
+    data,
+    errors,
+};
+```
+
+[[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/CompanyApi.md

@@ -8,10 +8,13 @@ All URIs are relative to *https://v2.api.caraer.com*
 |[**getCompany**](#getcompany) | **GET** /api/v2/company/ | Get current company|
 |[**getCompanyByUuid**](#getcompanybyuuid) | **GET** /api/v2/company/{uuid} | Get company by UUID|
 |[**getDigitalIdentity**](#getdigitalidentity) | **GET** /api/v2/company/digital-identity | Get digital identity|
+|[**getSuiteDashboard**](#getsuitedashboard) | **GET** /api/v2/company/suite-dashboards/{suiteName} | Get suite dashboard|
+|[**getSuiteDashboards**](#getsuitedashboards) | **GET** /api/v2/company/suite-dashboards | List suite dashboards|
 |[**getWebsiteSettings**](#getwebsitesettings) | **GET** /api/v2/company/website-settings | Get website settings|
 |[**resumeWebhookDispatch**](#resumewebhookdispatch) | **POST** /api/v2/company/{companyUuid}/webhooks/resume | Resume webhook dispatch|
 |[**updateCompany**](#updatecompany) | **PUT** /api/v2/company/{uuid} | Update company|
 |[**updateDigitalIdentity**](#updatedigitalidentity) | **PUT** /api/v2/company/digital-identity | Update digital identity|
+|[**updateSuiteDashboard**](#updatesuitedashboard) | **PUT** /api/v2/company/suite-dashboards/{suiteName} | Update suite dashboard|
 |[**updateWebsiteSettings**](#updatewebsitesettings) | **PUT** /api/v2/company/website-settings | Update website settings|
 |[**uploadFont**](#uploadfont) | **POST** /api/v2/company/uploadFont | Upload a font file|
 
@@ -216,6 +219,103 @@ This endpoint does not have any parameters.
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **getSuiteDashboard**
+> ShowResponse getSuiteDashboard()
+
+Returns the home analytics dashboard for a suite. Empty dashboard when none is saved.
+
+### Example
+
+```typescript
+import {
+    CompanyApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new CompanyApi(configuration);
+
+let suiteName: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getSuiteDashboard(
+    suiteName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **suiteName** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ShowResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Suite dashboard returned |  -  |
+|**401** | Unauthorized |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getSuiteDashboards**
+> ShowResponse getSuiteDashboards()
+
+Returns all home analytics dashboards keyed by suite name for the selected company.
+
+### Example
+
+```typescript
+import {
+    CompanyApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new CompanyApi(configuration);
+
+const { status, data } = await apiInstance.getSuiteDashboards();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**ShowResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Suite dashboards returned |  -  |
+|**401** | Unauthorized |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **getWebsiteSettings**
 > ShowResponse getWebsiteSettings()
 
@@ -428,6 +528,63 @@ const { status, data } = await apiInstance.updateDigitalIdentity(
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **updateSuiteDashboard**
+> UpdateResponse updateSuiteDashboard(analyticsDashboardConfig)
+
+Creates or replaces the home analytics dashboard for a suite.
+
+### Example
+
+```typescript
+import {
+    CompanyApi,
+    Configuration,
+    AnalyticsDashboardConfig
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new CompanyApi(configuration);
+
+let suiteName: string; // (default to undefined)
+let analyticsDashboardConfig: AnalyticsDashboardConfig; //
+
+const { status, data } = await apiInstance.updateSuiteDashboard(
+    suiteName,
+    analyticsDashboardConfig
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **analyticsDashboardConfig** | **AnalyticsDashboardConfig**|  | |
+| **suiteName** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**UpdateResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Suite dashboard saved |  -  |
+|**400** | Invalid dashboard config |  -  |
+|**401** | Unauthorized |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **updateWebsiteSettings**
 > UpdateResponse updateWebsiteSettings(websiteSettingsDTO)
 

package/docs/CreateDeveloperProjectRequest.md

@@ -0,0 +1,25 @@
+# CreateDeveloperProjectRequest
+
+Request body for creating (or fetching an existing) developer project for an app.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**appUuid** | **string** | UUID of the app to link this project to. | [optional] [default to undefined]
+**name** | **string** | Project name. | [optional] [default to undefined]
+**label** | **string** | Optional human-readable label for the project. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateDeveloperProjectRequest } from '@caraer/client';
+
+const instance: CreateDeveloperProjectRequest = {
+    appUuid,
+    name,
+    label,
+};
+```
+
+[[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/CreateDeveloperSandboxRequest.md

@@ -0,0 +1,23 @@
+# CreateDeveloperSandboxRequest
+
+Request body for creating a developer sandbox.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Sandbox name. | [optional] [default to undefined]
+**label** | **string** | Optional human-readable label for the sandbox. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateDeveloperSandboxRequest } from '@caraer/client';
+
+const instance: CreateDeveloperSandboxRequest = {
+    name,
+    label,
+};
+```
+
+[[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/CreatePrivateAppRequest.md

@@ -10,6 +10,8 @@ Name | Type | Description | Notes
 **description** | **string** | Optional description text for the app. | [optional] [default to undefined]
 **authMethod** | **string** | Authentication method (API_KEY default, OAUTH2 for OAuth 2.0) | [optional] [default to undefined]
 **oauthRedirectUris** | **Array<string>** | Registered OAuth redirect URIs (required when authMethod is OAUTH2) | [optional] [default to undefined]
+**platformVersion** | **number** | Ignored; new private apps are always platform version 2 (async container runtime). | [optional] [default to undefined]
+**runtime** | **string** | Serverless runtime for the app: nodejs22 or python312. Defaults to nodejs22. | [optional] [default to undefined]
 
 ## Example
 
@@ -21,6 +23,8 @@ const instance: CreatePrivateAppRequest = {
     description,
     authMethod,
     oauthRedirectUris,
+    platformVersion,
+    runtime,
 };
 ```
 

package/docs/CreateProjectBuildRequest.md

@@ -0,0 +1,29 @@
+# CreateProjectBuildRequest
+
+Request body for uploading a developer project build archive.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**archiveBase64** | **string** | Base64-encoded zip archive containing caraer.project.json and src/app. | [optional] [default to undefined]
+**filename** | **string** | Original archive filename, for traceability. | [optional] [default to undefined]
+**target** | **string** | Deploy target: production or sandbox. | [optional] [default to undefined]
+**version** | **string** | Semantic version for this build (MAJOR.MINOR.PATCH). Auto-bumped when omitted. | [optional] [default to undefined]
+**releaseNotes** | **string** | Release notes for this build. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateProjectBuildRequest } from '@caraer/client';
+
+const instance: CreateProjectBuildRequest = {
+    archiveBase64,
+    filename,
+    target,
+    version,
+    releaseNotes,
+};
+```
+
+[[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/CreateResponseAppExternalOAuthProviderDTO.md

@@ -0,0 +1,23 @@
+# CreateResponseAppExternalOAuthProviderDTO
+
+Response for a successful resource creation operation.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
+**data** | [**AppExternalOAuthProviderDTO**](AppExternalOAuthProviderDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateResponseAppExternalOAuthProviderDTO } from '@caraer/client';
+
+const instance: CreateResponseAppExternalOAuthProviderDTO = {
+    message,
+    data,
+};
+```
+
+[[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/CreateResponseAppInboundRouteDTO.md

@@ -0,0 +1,23 @@
+# CreateResponseAppInboundRouteDTO
+
+Response for a successful resource creation operation.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
+**data** | [**AppInboundRouteDTO**](AppInboundRouteDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateResponseAppInboundRouteDTO } from '@caraer/client';
+
+const instance: CreateResponseAppInboundRouteDTO = {
+    message,
+    data,
+};
+```
+
+[[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/CreateResponseAppScheduleDTO.md

@@ -0,0 +1,23 @@
+# CreateResponseAppScheduleDTO
+
+Response for a successful resource creation operation.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
+**data** | [**AppScheduleDTO**](AppScheduleDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateResponseAppScheduleDTO } from '@caraer/client';
+
+const instance: CreateResponseAppScheduleDTO = {
+    message,
+    data,
+};
+```
+
+[[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/CriterionScore.md

@@ -0,0 +1,30 @@
+# CriterionScore
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**criterion** | **string** |  | [optional] [default to undefined]
+**score** | **number** |  | [optional] [default to undefined]
+**weight** | **number** |  | [optional] [default to undefined]
+**rationale** | **string** |  | [optional] [default to undefined]
+**supportingEvidence** | [**Array<QueryEvidence>**](QueryEvidence.md) |  | [optional] [default to undefined]
+**contradictingEvidence** | [**Array<QueryEvidence>**](QueryEvidence.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CriterionScore } from '@caraer/client';
+
+const instance: CriterionScore = {
+    criterion,
+    score,
+    weight,
+    rationale,
+    supportingEvidence,
+    contradictingEvidence,
+};
+```
+
+[[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/CrossObjectRecordSearchRequest.md

@@ -0,0 +1,37 @@
+# CrossObjectRecordSearchRequest
+
+Request DTO for searching records across multiple objects.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**query** | **string** | Free-text search query. | [optional] [default to undefined]
+**fromObjectUuid** | **string** | Event (or source) object UUID used with relationName to resolve target objects. | [optional] [default to undefined]
+**relationName** | **string** | Relation name whose connected target objects are searched (e.g. attendees). | [optional] [default to undefined]
+**objectUuids** | **Array<string>** | Object UUIDs to search. Used on their own when relationName is omitted; combined with relationName they narrow the relation\'s target objects. | [optional] [default to undefined]
+**objectNames** | **Array<string>** | Object internal names to search. Behaves like objectUuids and may be combined with it. | [optional] [default to undefined]
+**preview** | **string** | Preview template name. | [optional] [default to undefined]
+**page** | **number** | Page number (1-based). | [optional] [default to undefined]
+**limit** | **number** | Maximum records returned. | [optional] [default to undefined]
+**excludeRecordUuid** | **string** | Optional record UUID to exclude from results. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CrossObjectRecordSearchRequest } from '@caraer/client';
+
+const instance: CrossObjectRecordSearchRequest = {
+    query,
+    fromObjectUuid,
+    relationName,
+    objectUuids,
+    objectNames,
+    preview,
+    page,
+    limit,
+    excludeRecordUuid,
+};
+```
+
+[[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/DeleteResponseVoid.md

@@ -0,0 +1,23 @@
+# DeleteResponseVoid
+
+Response class representing the result of a delete operation.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
+**data** | **any** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DeleteResponseVoid } from '@caraer/client';
+
+const instance: DeleteResponseVoid = {
+    message,
+    data,
+};
+```
+
+[[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/DeployBuildRequest.md

@@ -0,0 +1,23 @@
+# DeployBuildRequest
+
+Request body for deploying a developer project build.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**target** | **string** | Deploy target: production or sandbox. Defaults to the build\'s target. | [optional] [default to undefined]
+**prune** | **boolean** | When true, soft-delete remote functions/webhooks/schedules/inbound routes/OAuth providers that are absent from the build archive. Defaults to false. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DeployBuildRequest } from '@caraer/client';
+
+const instance: DeployBuildRequest = {
+    target,
+    prune,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)