@caraer/client 2.0.437 → 2.0.441

package/docs/PaginationResponsePropertyCalculationTypeDTO.md

@@ -0,0 +1,31 @@
+# PaginationResponsePropertyCalculationTypeDTO
+
+Paginated response (PaginationResponsePropertyCalculationTypeDTO).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [optional] [default to undefined]
+**data** | **Array<object>** |  | [optional] [default to undefined]
+**total** | **number** |  | [optional] [default to undefined]
+**page** | **number** |  | [optional] [default to undefined]
+**perPage** | **number** |  | [optional] [default to undefined]
+**lastPage** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PaginationResponsePropertyCalculationTypeDTO } from '@caraer/client';
+
+const instance: PaginationResponsePropertyCalculationTypeDTO = {
+    message,
+    data,
+    total,
+    page,
+    perPage,
+    lastPage,
+};
+```
+
+[[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/PaginationResponsePropertyDTO.md

@@ -0,0 +1,31 @@
+# PaginationResponsePropertyDTO
+
+Paginated response (PaginationResponsePropertyDTO).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [optional] [default to undefined]
+**data** | **Array<object>** |  | [optional] [default to undefined]
+**total** | **number** |  | [optional] [default to undefined]
+**page** | **number** |  | [optional] [default to undefined]
+**perPage** | **number** |  | [optional] [default to undefined]
+**lastPage** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PaginationResponsePropertyDTO } from '@caraer/client';
+
+const instance: PaginationResponsePropertyDTO = {
+    message,
+    data,
+    total,
+    page,
+    perPage,
+    lastPage,
+};
+```
+
+[[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/PaginationResponsePropertyFormat.md

@@ -0,0 +1,31 @@
+# PaginationResponsePropertyFormat
+
+Paginated response (PaginationResponsePropertyFormat).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [optional] [default to undefined]
+**data** | **Array<object>** |  | [optional] [default to undefined]
+**total** | **number** |  | [optional] [default to undefined]
+**page** | **number** |  | [optional] [default to undefined]
+**perPage** | **number** |  | [optional] [default to undefined]
+**lastPage** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PaginationResponsePropertyFormat } from '@caraer/client';
+
+const instance: PaginationResponsePropertyFormat = {
+    message,
+    data,
+    total,
+    page,
+    perPage,
+    lastPage,
+};
+```
+
+[[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/PaginationResponsePropertyOption.md

@@ -0,0 +1,31 @@
+# PaginationResponsePropertyOption
+
+Response object for paginated data.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
+**data** | [**Array<PropertyOption>**](PropertyOption.md) | The data returned in the current page of the pagination. | [optional] [default to undefined]
+**total** | **number** | The total number of items available. | [optional] [default to undefined]
+**page** | **number** | The current page number (starts from 1). | [optional] [default to undefined]
+**perPage** | **number** | The number of items displayed per page. | [optional] [default to undefined]
+**lastPage** | **number** | The last page number available for the pagination. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PaginationResponsePropertyOption } from '@caraer/client';
+
+const instance: PaginationResponsePropertyOption = {
+    message,
+    data,
+    total,
+    page,
+    perPage,
+    lastPage,
+};
+```
+
+[[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/PaginationResponsePublicEnvironmentDTO.md

@@ -0,0 +1,31 @@
+# PaginationResponsePublicEnvironmentDTO
+
+Paginated response (PaginationResponsePublicEnvironmentDTO).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [optional] [default to undefined]
+**data** | **Array<object>** |  | [optional] [default to undefined]
+**total** | **number** |  | [optional] [default to undefined]
+**page** | **number** |  | [optional] [default to undefined]
+**perPage** | **number** |  | [optional] [default to undefined]
+**lastPage** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PaginationResponsePublicEnvironmentDTO } from '@caraer/client';
+
+const instance: PaginationResponsePublicEnvironmentDTO = {
+    message,
+    data,
+    total,
+    page,
+    perPage,
+    lastPage,
+};
+```
+
+[[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/PaginationResponsePublicFormDTO.md

@@ -0,0 +1,31 @@
+# PaginationResponsePublicFormDTO
+
+Response object for paginated data.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
+**data** | [**Array<PublicFormDTO>**](PublicFormDTO.md) | The data returned in the current page of the pagination. | [optional] [default to undefined]
+**total** | **number** | The total number of items available. | [optional] [default to undefined]
+**page** | **number** | The current page number (starts from 1). | [optional] [default to undefined]
+**perPage** | **number** | The number of items displayed per page. | [optional] [default to undefined]
+**lastPage** | **number** | The last page number available for the pagination. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PaginationResponsePublicFormDTO } from '@caraer/client';
+
+const instance: PaginationResponsePublicFormDTO = {
+    message,
+    data,
+    total,
+    page,
+    perPage,
+    lastPage,
+};
+```
+
+[[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/PaginationResponseRelationDTO.md

@@ -0,0 +1,31 @@
+# PaginationResponseRelationDTO
+
+Paginated response (PaginationResponseRelationDTO).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [optional] [default to undefined]
+**data** | **Array<object>** |  | [optional] [default to undefined]
+**total** | **number** |  | [optional] [default to undefined]
+**page** | **number** |  | [optional] [default to undefined]
+**perPage** | **number** |  | [optional] [default to undefined]
+**lastPage** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PaginationResponseRelationDTO } from '@caraer/client';
+
+const instance: PaginationResponseRelationDTO = {
+    message,
+    data,
+    total,
+    page,
+    perPage,
+    lastPage,
+};
+```
+
+[[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/PaginationResponseSavedFilterDTO.md

@@ -0,0 +1,31 @@
+# PaginationResponseSavedFilterDTO
+
+Paginated response (PaginationResponseSavedFilterDTO).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [optional] [default to undefined]
+**data** | **Array<object>** |  | [optional] [default to undefined]
+**total** | **number** |  | [optional] [default to undefined]
+**page** | **number** |  | [optional] [default to undefined]
+**perPage** | **number** |  | [optional] [default to undefined]
+**lastPage** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PaginationResponseSavedFilterDTO } from '@caraer/client';
+
+const instance: PaginationResponseSavedFilterDTO = {
+    message,
+    data,
+    total,
+    page,
+    perPage,
+    lastPage,
+};
+```
+
+[[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/PaginationResponseServerlessFunctionDTO.md

@@ -0,0 +1,31 @@
+# PaginationResponseServerlessFunctionDTO
+
+Paginated response (PaginationResponseServerlessFunctionDTO).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [optional] [default to undefined]
+**data** | **Array<object>** |  | [optional] [default to undefined]
+**total** | **number** |  | [optional] [default to undefined]
+**page** | **number** |  | [optional] [default to undefined]
+**perPage** | **number** |  | [optional] [default to undefined]
+**lastPage** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PaginationResponseServerlessFunctionDTO } from '@caraer/client';
+
+const instance: PaginationResponseServerlessFunctionDTO = {
+    message,
+    data,
+    total,
+    page,
+    perPage,
+    lastPage,
+};
+```
+
+[[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/PaginationResponseSubscribeWebhookDTO.md

@@ -0,0 +1,31 @@
+# PaginationResponseSubscribeWebhookDTO
+
+Paginated response (PaginationResponseSubscribeWebhookDTO).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [optional] [default to undefined]
+**data** | **Array<object>** |  | [optional] [default to undefined]
+**total** | **number** |  | [optional] [default to undefined]
+**page** | **number** |  | [optional] [default to undefined]
+**perPage** | **number** |  | [optional] [default to undefined]
+**lastPage** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PaginationResponseSubscribeWebhookDTO } from '@caraer/client';
+
+const instance: PaginationResponseSubscribeWebhookDTO = {
+    message,
+    data,
+    total,
+    page,
+    perPage,
+    lastPage,
+};
+```
+
+[[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/PaginationResponseSyncDTO.md

@@ -0,0 +1,31 @@
+# PaginationResponseSyncDTO
+
+Paginated response (PaginationResponseSyncDTO).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [optional] [default to undefined]
+**data** | **Array<object>** |  | [optional] [default to undefined]
+**total** | **number** |  | [optional] [default to undefined]
+**page** | **number** |  | [optional] [default to undefined]
+**perPage** | **number** |  | [optional] [default to undefined]
+**lastPage** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PaginationResponseSyncDTO } from '@caraer/client';
+
+const instance: PaginationResponseSyncDTO = {
+    message,
+    data,
+    total,
+    page,
+    perPage,
+    lastPage,
+};
+```
+
+[[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/PaginationResponseTraitDTO.md

@@ -0,0 +1,31 @@
+# PaginationResponseTraitDTO
+
+Paginated response (PaginationResponseTraitDTO).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [optional] [default to undefined]
+**data** | **Array<object>** |  | [optional] [default to undefined]
+**total** | **number** |  | [optional] [default to undefined]
+**page** | **number** |  | [optional] [default to undefined]
+**perPage** | **number** |  | [optional] [default to undefined]
+**lastPage** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PaginationResponseTraitDTO } from '@caraer/client';
+
+const instance: PaginationResponseTraitDTO = {
+    message,
+    data,
+    total,
+    page,
+    perPage,
+    lastPage,
+};
+```
+
+[[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/PaginationResponseViewDTO.md

@@ -0,0 +1,31 @@
+# PaginationResponseViewDTO
+
+Paginated response (PaginationResponseViewDTO).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [optional] [default to undefined]
+**data** | **Array<object>** |  | [optional] [default to undefined]
+**total** | **number** |  | [optional] [default to undefined]
+**page** | **number** |  | [optional] [default to undefined]
+**perPage** | **number** |  | [optional] [default to undefined]
+**lastPage** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PaginationResponseViewDTO } from '@caraer/client';
+
+const instance: PaginationResponseViewDTO = {
+    message,
+    data,
+    total,
+    page,
+    perPage,
+    lastPage,
+};
+```
+
+[[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/PaginationResponseWebMenuDTO.md

@@ -0,0 +1,31 @@
+# PaginationResponseWebMenuDTO
+
+Paginated response (PaginationResponseWebMenuDTO).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [optional] [default to undefined]
+**data** | **Array<object>** |  | [optional] [default to undefined]
+**total** | **number** |  | [optional] [default to undefined]
+**page** | **number** |  | [optional] [default to undefined]
+**perPage** | **number** |  | [optional] [default to undefined]
+**lastPage** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PaginationResponseWebMenuDTO } from '@caraer/client';
+
+const instance: PaginationResponseWebMenuDTO = {
+    message,
+    data,
+    total,
+    page,
+    perPage,
+    lastPage,
+};
+```
+
+[[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/ProjectBuildDTO.md

@@ -0,0 +1,55 @@
+# ProjectBuildDTO
+
+Data transfer object for a developer project build artifact.
+
+## 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]
+**projectUuid** | **string** | UUID of the owning developer project | [optional] [default to undefined]
+**status** | **string** | PENDING, READY, or FAILED | [optional] [default to undefined]
+**target** | **string** | production or sandbox | [optional] [default to undefined]
+**artifactGcsPath** | **string** | GCS object path of the uploaded build archive | [optional] [default to undefined]
+**manifestJson** | **string** | Parsed build manifest (functions, webhooks, app fields), serialized as JSON | [optional] [default to undefined]
+**errorMessage** | **string** | Error message if the build failed | [optional] [default to undefined]
+**version** | **string** | Semantic version for this build | [optional] [default to undefined]
+**releaseNotes** | **string** | Release notes for this build | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProjectBuildDTO } from '@caraer/client';
+
+const instance: ProjectBuildDTO = {
+    uuid,
+    name,
+    label,
+    createdAt,
+    createdBy,
+    updatedAt,
+    updatedBy,
+    deletedAt,
+    deletedBy,
+    index,
+    projectUuid,
+    status,
+    target,
+    artifactGcsPath,
+    manifestJson,
+    errorMessage,
+    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/ProjectDeployDTO.md

@@ -0,0 +1,53 @@
+# ProjectDeployDTO
+
+Data transfer object for a developer project deploy.
+
+## 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]
+**projectUuid** | **string** | UUID of the owning developer project | [optional] [default to undefined]
+**buildUuid** | **string** | UUID of the build that was deployed | [optional] [default to undefined]
+**version** | **string** | Semantic version of the deployed build | [optional] [default to undefined]
+**status** | **string** | PENDING, SUCCEEDED, FAILED, or PARTIAL | [optional] [default to undefined]
+**target** | **string** | production or sandbox | [optional] [default to undefined]
+**resultsJson** | **string** | Per-component reconciliation results (app, functions, webhooks), serialized as JSON | [optional] [default to undefined]
+**activatedAt** | **number** | Unix timestamp (ms) when this deploy was activated | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProjectDeployDTO } from '@caraer/client';
+
+const instance: ProjectDeployDTO = {
+    uuid,
+    name,
+    label,
+    createdAt,
+    createdBy,
+    updatedAt,
+    updatedBy,
+    deletedAt,
+    deletedBy,
+    index,
+    projectUuid,
+    buildUuid,
+    version,
+    status,
+    target,
+    resultsJson,
+    activatedAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)