@caraer/client 2.0.381 → 2.0.382

package/docs/AppOAuthStartResponseDTO.md

@@ -0,0 +1,20 @@
+# AppOAuthStartResponseDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**authorizeUrl** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AppOAuthStartResponseDTO } from '@caraer/client';
+
+const instance: AppOAuthStartResponseDTO = {
+    authorizeUrl,
+};
+```
+
+[[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/AppPublishDTO.md

@@ -21,7 +21,7 @@ Name | Type | Description | Notes
 **reviewedAt** | **number** | Timestamp when review was completed | [optional] [default to undefined]
 **publishedAt** | **number** | Timestamp when app went live in marketplace | [optional] [default to undefined]
 **feedback** | **string** | Feedback shown to developer (e.g. rejection reason) | [optional] [default to undefined]
-**reviewerNotes** | **string** | Internal reviewer notes (admin only, not exposed to developer) | [optional] [default to undefined]
+**reviewerNotes** | **string** | Internal reviewer notes. Only returned for SUPER_ADMIN callers; never exposed to app creators. | [optional] [default to undefined]
 
 ## Example
 

package/docs/AppScheduleDTO.md

@@ -0,0 +1,47 @@
+# AppScheduleDTO
+
+App schedule definition (cron → 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]
+**schedule** | **string** |  | [optional] [default to undefined]
+**enabled** | **boolean** |  | [optional] [default to undefined]
+**payloadTemplate** | **string** |  | [optional] [default to undefined]
+**serverlessFunction** | [**ServerlessFunctionRefDTO**](ServerlessFunctionRefDTO.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AppScheduleDTO } from '@caraer/client';
+
+const instance: AppScheduleDTO = {
+    uuid,
+    name,
+    label,
+    createdAt,
+    createdBy,
+    updatedAt,
+    updatedBy,
+    deletedAt,
+    deletedBy,
+    index,
+    schedule,
+    enabled,
+    payloadTemplate,
+    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)

package/docs/AppSettingFieldSchema.md

@@ -15,7 +15,9 @@ Name | Type | Description | Notes
 **defaultValue** | **any** |  | [optional] [default to undefined]
 **hidden** | **boolean** |  | [optional] [default to undefined]
 **value** | **any** |  | [optional] [default to undefined]
+**hasValue** | **boolean** |  | [optional] [default to undefined]
 **mappingValue** | [**AppSettingFieldMappingStructure**](AppSettingFieldMappingStructure.md) |  | [optional] [default to undefined]
+**valueScope** | **string** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -33,7 +35,9 @@ const instance: AppSettingFieldSchema = {
     defaultValue,
     hidden,
     value,
+    hasValue,
     mappingValue,
+    valueScope,
 };
 ```
 

package/docs/AppSettingOptionsSource.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **string** |  | [optional] [default to undefined]
 **serverlessFunctionUuid** | **string** |  | [optional] [default to undefined]
+**serverlessFunctionName** | **string** |  | [optional] [default to undefined]
 **dependsOn** | **Array<string>** |  | [optional] [default to undefined]
 **searchable** | **boolean** |  | [optional] [default to undefined]
 **minQueryLength** | **number** |  | [optional] [default to undefined]
@@ -19,6 +20,7 @@ import { AppSettingOptionsSource } from '@caraer/client';
 const instance: AppSettingOptionsSource = {
     type,
     serverlessFunctionUuid,
+    serverlessFunctionName,
     dependsOn,
     searchable,
     minQueryLength,

package/docs/ApplicationsApi.md

@@ -9,19 +9,23 @@ All URIs are relative to *https://v2.api.caraer.com*
 |[**createPublicApp**](#createpublicapp) | **POST** /api/v2/apps/public | Create a public app|
 |[**deleteAppWebhook**](#deleteappwebhook) | **DELETE** /api/v2/apps/{appUuid}/webhooks/{webhookUuid} | Delete a webhook for an app|
 |[**getApp**](#getapp) | **GET** /api/v2/apps/{uuid} | Retrieve application details by UUID|
+|[**getAppWebhook**](#getappwebhook) | **GET** /api/v2/apps/{appUuid}/webhooks/{webhookUuid} | Get a webhook for an app|
 |[**getAppWebhooks**](#getappwebhooks) | **POST** /api/v2/apps/{appUuid}/webhooks/index | Retrieve a paginated list of webhooks for an app|
 |[**getApps**](#getapps) | **POST** /api/v2/apps/index | Retrieve a paginated list of applications|
 |[**getCompanyInformation**](#getcompanyinformation) | **GET** /api/v2/apps/{appUuid}/me | Get current user\'s company information|
 |[**getMyCreatedApps**](#getmycreatedapps) | **POST** /api/v2/apps/my/index | Retrieve apps created by the logged-in user\'s selected company|
 |[**getPublicApp**](#getpublicapp) | **GET** /api/v2/apps/public/{uuid} | Get a public app (creator view)|
+|[**getRuntimeLogs**](#getruntimelogs) | **GET** /api/v2/apps/{appUuid}/runtime/logs | Get app runtime logs|
 |[**getWebhookEvents**](#getwebhookevents) | **GET** /api/v2/apps/{appUuid}/webhooks/events | Get available webhook record events|
 |[**getWebhookFormats**](#getwebhookformats) | **GET** /api/v2/apps/{appUuid}/webhooks/formats | Get available webhook formats|
 |[**getWebhookPropertyTopics**](#getwebhookpropertytopics) | **GET** /api/v2/apps/{appUuid}/webhooks/property-topics | Get webhook property topic options|
 |[**installApp**](#installapp) | **POST** /api/v2/apps/{uuid}/install | Install an application|
 |[**listAppCategories**](#listappcategories) | **GET** /api/v2/apps/categories | List predefined marketplace app categories|
 |[**loadSettingOptions**](#loadsettingoptions) | **POST** /api/v2/apps/{uuid}/settings-schema/options | Load dynamic options for a setting select field|
+|[**migrateToV2**](#migratetov2) | **POST** /api/v2/apps/{uuid}/migrate-v2 | Migrate an app from platform V1 to V2|
 |[**reviewPublicApp**](#reviewpublicapp) | **POST** /api/v2/apps/public/{uuid}/review | Review a public app|
 |[**rotateApp**](#rotateapp) | **POST** /api/v2/apps/{uuid}/rotate | Rotate application configurations|
+|[**streamRuntimeLogs**](#streamruntimelogs) | **GET** /api/v2/apps/{appUuid}/runtime/logs/stream | Stream app runtime logs (SSE)|
 |[**submitPublicApp**](#submitpublicapp) | **POST** /api/v2/apps/public/{uuid}/submit | Submit a public app for review|
 |[**testAppWebhook**](#testappwebhook) | **POST** /api/v2/apps/{appUuid}/webhooks/test/{webhookUuid}/{recordUuid}/{eventType} | Test a webhook for an app|
 |[**testAppWebhookAuto**](#testappwebhookauto) | **POST** /api/v2/apps/{appUuid}/webhooks/test/{webhookUuid} | Test a webhook for an app (auto-resolve)|
@@ -307,6 +311,62 @@ const { status, data } = await apiInstance.getApp(
 
 [[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)
 
+# **getAppWebhook**
+> ShowResponse getAppWebhook()
+
+Fetches a single webhook that belongs to the specified app.
+
+### Example
+
+```typescript
+import {
+    ApplicationsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new ApplicationsApi(configuration);
+
+let appUuid: string; //UUID of the app that owns the webhook (default to undefined)
+let webhookUuid: string; //UUID of the webhook to fetch (default to undefined)
+
+const { status, data } = await apiInstance.getAppWebhook(
+    appUuid,
+    webhookUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **appUuid** | [**string**] | UUID of the app that owns the webhook | defaults to undefined|
+| **webhookUuid** | [**string**] | UUID of the webhook to fetch | 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** | Webhook retrieved successfully |  -  |
+|**404** | Webhook not found for the specified app or company |  -  |
+|**500** | Internal server error |  -  |
+
+[[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)
+
 # **getAppWebhooks**
 > PaginationResponse getAppWebhooks(body)
 
@@ -584,6 +644,64 @@ const { status, data } = await apiInstance.getPublicApp(
 
 [[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)
 
+# **getRuntimeLogs**
+> SuccessResponse getRuntimeLogs()
+
+Queries Cloud Logging for the shared V2 app container (app-{uuid}) without filtering to a single function.
+
+### Example
+
+```typescript
+import {
+    ApplicationsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new ApplicationsApi(configuration);
+
+let appUuid: string; //UUID of the app (default to undefined)
+let since: string; //Lookback window, e.g. 15m, 1h, 24h (optional) (default to '1h')
+let limit: number; //Maximum number of log entries to return (optional) (default to 100)
+
+const { status, data } = await apiInstance.getRuntimeLogs(
+    appUuid,
+    since,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **appUuid** | [**string**] | UUID of the app | defaults to undefined|
+| **since** | [**string**] | Lookback window, e.g. 15m, 1h, 24h | (optional) defaults to '1h'|
+| **limit** | [**number**] | Maximum number of log entries to return | (optional) defaults to 100|
+
+
+### Return type
+
+**SuccessResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved logs (may be empty if logging is unavailable) |  -  |
+|**404** | App not found |  -  |
+
+[[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)
+
 # **getWebhookEvents**
 > getWebhookEvents()
 
@@ -900,6 +1018,64 @@ const { status, data } = await apiInstance.loadSettingOptions(
 
 [[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)
 
+# **migrateToV2**
+> SuccessResponse migrateToV2()
+
+Opt-in in-place migration to the shared container runtime. Validates a single runtime, sets platformVersion=2, schedules an async rebuild, and keeps invoking via legacy gcpReference until runtimeStatus is READY.
+
+### Example
+
+```typescript
+import {
+    ApplicationsApi,
+    Configuration,
+    MigrateAppToV2Request
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new ApplicationsApi(configuration);
+
+let uuid: string; //UUID of the app to migrate (default to undefined)
+let migrateAppToV2Request: MigrateAppToV2Request; // (optional)
+
+const { status, data } = await apiInstance.migrateToV2(
+    uuid,
+    migrateAppToV2Request
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **migrateAppToV2Request** | **MigrateAppToV2Request**|  | |
+| **uuid** | [**string**] | UUID of the app to migrate | defaults to undefined|
+
+
+### Return type
+
+**SuccessResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Migration started or already in progress |  -  |
+|**400** | Mixed/missing runtimes or invalid request |  -  |
+|**403** | Not allowed to migrate this app |  -  |
+|**404** | App not found |  -  |
+
+[[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)
+
 # **reviewPublicApp**
 > ShowResponse reviewPublicApp(reviewRequest)
 
@@ -1010,6 +1186,58 @@ const { status, data } = await apiInstance.rotateApp(
 
 [[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)
 
+# **streamRuntimeLogs**
+> SseEmitter streamRuntimeLogs()
+
+Server-Sent Events stream of Cloud Logging entries for the shared V2 app container. Polls every ~2.5s and stops after 5 minutes or client disconnect.
+
+### Example
+
+```typescript
+import {
+    ApplicationsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new ApplicationsApi(configuration);
+
+let appUuid: string; //UUID of the app (default to undefined)
+
+const { status, data } = await apiInstance.streamRuntimeLogs(
+    appUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **appUuid** | [**string**] | UUID of the app | defaults to undefined|
+
+
+### Return type
+
+**SseEmitter**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/event-stream
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | SSE stream of log entries |  -  |
+|**404** | App not found |  -  |
+
+[[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)
+
 # **submitPublicApp**
 > ShowResponse submitPublicApp()
 

package/docs/BillingApi.md

@@ -0,0 +1,101 @@
+# BillingApi
+
+All URIs are relative to *https://v2.api.caraer.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getStatus**](#getstatus) | **GET** /api/v2/billing/status | Get billing enforcement status|
+|[**sendSetupEmail**](#sendsetupemail) | **POST** /api/v2/billing/setup-email | Send billing setup email|
+
+# **getStatus**
+> ShowResponse getStatus()
+
+Returns whether the selected company should see no UI, a billing banner, or a non-dismissible lockout, based on Caraer BV CRM billing fields.
+
+### Example
+
+```typescript
+import {
+    BillingApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new BillingApi(configuration);
+
+const { status, data } = await apiInstance.getStatus();
+```
+
+### 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** | Billing status |  -  |
+|**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)
+
+# **sendSetupEmail**
+> ShowResponse sendSetupEmail()
+
+Triggers Jortt to email the linked customer a direct-debit authorization payment link.
+
+### Example
+
+```typescript
+import {
+    BillingApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new BillingApi(configuration);
+
+const { status, data } = await apiInstance.sendSetupEmail();
+```
+
+### 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** | Email requested |  -  |
+|**400** | Missing CRM link, Jortt customer id, or already accepted |  -  |
+|**401** | Unauthorized |  -  |
+|**503** | Jortt or CRM not configured |  -  |
+
+[[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)
+

package/docs/BulkDeleteRecordsData.md

@@ -0,0 +1,21 @@
+# BulkDeleteRecordsData
+
+Payload of a bulk delete records response.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuids** | **Array<string>** | UUIDs that were successfully deleted. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BulkDeleteRecordsData } from '@caraer/client';
+
+const instance: BulkDeleteRecordsData = {
+    uuids,
+};
+```
+
+[[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/BulkDeleteRecordsRequest.md

@@ -0,0 +1,23 @@
+# BulkDeleteRecordsRequest
+
+Request to archive, anonymize, or permanently delete multiple records.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuids** | **Array<string>** | Record UUIDs to delete. | [default to undefined]
+**mode** | **string** | Deletion mode: \'archive\', \'anonymize\', or \'delete\'. | [default to undefined]
+
+## Example
+
+```typescript
+import { BulkDeleteRecordsRequest } from '@caraer/client';
+
+const instance: BulkDeleteRecordsRequest = {
+    uuids,
+    mode,
+};
+```
+
+[[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/BulkDeleteRecordsResponse.md

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

@@ -0,0 +1,27 @@
+# BulkEditRecordErrorItem
+
+Validation or processing errors for a single record in a bulk edit operation.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** | UUID of the record that failed, if known. | [optional] [default to undefined]
+**clientRef** | **string** | Client reference echoed from the request, if provided. | [optional] [default to undefined]
+**message** | **string** | Summary message for this record\'s failure. | [optional] [default to undefined]
+**errors** | [**Array<CaraerErrorType>**](CaraerErrorType.md) | Field-level validation errors. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BulkEditRecordErrorItem } from '@caraer/client';
+
+const instance: BulkEditRecordErrorItem = {
+    uuid,
+    clientRef,
+    message,
+    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/BulkEditRecordItem.md

@@ -0,0 +1,25 @@
+# BulkEditRecordItem
+
+A single record to create or update in a bulk edit request.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** | UUID of an existing record to update. Omit to create a new record. | [optional] [default to undefined]
+**clientRef** | **string** | Client-side reference for matching the item back after create (e.g. row-3). | [optional] [default to undefined]
+**properties** | **{ [key: string]: any | null; }** | Property values to set on the record. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BulkEditRecordItem } from '@caraer/client';
+
+const instance: BulkEditRecordItem = {
+    uuid,
+    clientRef,
+    properties,
+};
+```
+
+[[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/BulkEditRecordResultItem.md

@@ -0,0 +1,25 @@
+# BulkEditRecordResultItem
+
+A successfully saved record from a bulk edit operation.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** | UUID of the saved record. | [optional] [default to undefined]
+**clientRef** | **string** | Client reference echoed from the request, if provided. | [optional] [default to undefined]
+**created** | **boolean** | True when the record was created; false when updated. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BulkEditRecordResultItem } from '@caraer/client';
+
+const instance: BulkEditRecordResultItem = {
+    uuid,
+    clientRef,
+    created,
+};
+```
+
+[[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/BulkEditRecordsData.md

@@ -0,0 +1,21 @@
+# BulkEditRecordsData
+
+Payload of a bulk edit records response.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**records** | [**Array<BulkEditRecordResultItem>**](BulkEditRecordResultItem.md) | Successfully saved records. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BulkEditRecordsData } from '@caraer/client';
+
+const instance: BulkEditRecordsData = {
+    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)