@caraer/client 2.0.381 → 2.0.382

package/docs/DeveloperProjectsApi.md

@@ -0,0 +1,387 @@
+# DeveloperProjectsApi
+
+All URIs are relative to *https://v2.api.caraer.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**create2**](#create2) | **POST** /api/v2/developer-projects | Create or fetch a developer project|
+|[**createBuild**](#createbuild) | **POST** /api/v2/developer-projects/{projectUuid}/builds | Upload a project build|
+|[**deploy**](#deploy) | **POST** /api/v2/developer-projects/{projectUuid}/builds/{buildUuid}/deploy | Deploy a project build|
+|[**getBuild**](#getbuild) | **GET** /api/v2/developer-projects/{projectUuid}/builds/{buildUuid} | Get a project build|
+|[**listBuilds**](#listbuilds) | **GET** /api/v2/developer-projects/{projectUuid}/builds | List project builds|
+|[**listDeploys**](#listdeploys) | **GET** /api/v2/developer-projects/{projectUuid}/deploys | List project deploys|
+|[**show3**](#show3) | **GET** /api/v2/developer-projects/{uuid} | Get a developer project|
+
+# **create2**
+> CreateResponse create2(createDeveloperProjectRequest)
+
+Creates a developer project linked to the given app, or returns the existing one if already linked. Creator company only.
+
+### Example
+
+```typescript
+import {
+    DeveloperProjectsApi,
+    Configuration,
+    CreateDeveloperProjectRequest
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new DeveloperProjectsApi(configuration);
+
+let createDeveloperProjectRequest: CreateDeveloperProjectRequest; //
+
+const { status, data } = await apiInstance.create2(
+    createDeveloperProjectRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createDeveloperProjectRequest** | **CreateDeveloperProjectRequest**|  | |
+
+
+### Return type
+
+**CreateResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Project created or fetched |  -  |
+|**400** | appUuid is required |  -  |
+|**403** | Caller is not the app creator |  -  |
+
+[[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)
+
+# **createBuild**
+> CreateResponse createBuild(createProjectBuildRequest)
+
+Decodes a base64-encoded project archive, parses its manifest, uploads it to Cloud Storage, and records an immutable build.
+
+### Example
+
+```typescript
+import {
+    DeveloperProjectsApi,
+    Configuration,
+    CreateProjectBuildRequest
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new DeveloperProjectsApi(configuration);
+
+let projectUuid: string; //UUID of the developer project (default to undefined)
+let createProjectBuildRequest: CreateProjectBuildRequest; //
+
+const { status, data } = await apiInstance.createBuild(
+    projectUuid,
+    createProjectBuildRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createProjectBuildRequest** | **CreateProjectBuildRequest**|  | |
+| **projectUuid** | [**string**] | UUID of the developer project | defaults to undefined|
+
+
+### Return type
+
+**CreateResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Build recorded (may still have status FAILED if parsing/upload failed) |  -  |
+|**400** | archiveBase64 is required |  -  |
+
+[[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)
+
+# **deploy**
+> CreateResponse deploy()
+
+Reconciles the build\'s manifest (app details, serverless functions, webhooks, schedules, inbound routes, external OAuth providers) against the linked app. Set prune=true to soft-delete remote resources absent from the archive.
+
+### Example
+
+```typescript
+import {
+    DeveloperProjectsApi,
+    Configuration,
+    DeployBuildRequest
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new DeveloperProjectsApi(configuration);
+
+let projectUuid: string; //UUID of the developer project (default to undefined)
+let buildUuid: string; //UUID of the build to deploy (default to undefined)
+let deployBuildRequest: DeployBuildRequest; // (optional)
+
+const { status, data } = await apiInstance.deploy(
+    projectUuid,
+    buildUuid,
+    deployBuildRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **deployBuildRequest** | **DeployBuildRequest**|  | |
+| **projectUuid** | [**string**] | UUID of the developer project | defaults to undefined|
+| **buildUuid** | [**string**] | UUID of the build to deploy | defaults to undefined|
+
+
+### Return type
+
+**CreateResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Deploy recorded |  -  |
+|**400** | Build is not ready to deploy |  -  |
+
+[[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)
+
+# **getBuild**
+> getBuild()
+
+
+### Example
+
+```typescript
+import {
+    DeveloperProjectsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new DeveloperProjectsApi(configuration);
+
+let projectUuid: string; //UUID of the developer project (default to undefined)
+let buildUuid: string; //UUID of the build (default to undefined)
+
+const { status, data } = await apiInstance.getBuild(
+    projectUuid,
+    buildUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **projectUuid** | [**string**] | UUID of the developer project | defaults to undefined|
+| **buildUuid** | [**string**] | UUID of the build | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**404** | Build not found for this project |  -  |
+
+[[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)
+
+# **listBuilds**
+> any listBuilds()
+
+
+### Example
+
+```typescript
+import {
+    DeveloperProjectsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new DeveloperProjectsApi(configuration);
+
+let projectUuid: string; //UUID of the developer project (default to undefined)
+
+const { status, data } = await apiInstance.listBuilds(
+    projectUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **projectUuid** | [**string**] | UUID of the developer project | defaults to undefined|
+
+
+### Return type
+
+**any**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[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)
+
+# **listDeploys**
+> any listDeploys()
+
+
+### Example
+
+```typescript
+import {
+    DeveloperProjectsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new DeveloperProjectsApi(configuration);
+
+let projectUuid: string; //UUID of the developer project (default to undefined)
+
+const { status, data } = await apiInstance.listDeploys(
+    projectUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **projectUuid** | [**string**] | UUID of the developer project | defaults to undefined|
+
+
+### Return type
+
+**any**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[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)
+
+# **show3**
+> ShowResponse show3()
+
+
+### Example
+
+```typescript
+import {
+    DeveloperProjectsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new DeveloperProjectsApi(configuration);
+
+let uuid: string; //UUID of the developer project (default to undefined)
+
+const { status, data } = await apiInstance.show3(
+    uuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **uuid** | [**string**] | UUID of the developer project | 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** | Project retrieved |  -  |
+|**404** | Project 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)
+

package/docs/DeveloperSandboxesApi.md

@@ -0,0 +1,158 @@
+# DeveloperSandboxesApi
+
+All URIs are relative to *https://v2.api.caraer.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**create1**](#create1) | **POST** /api/v2/developer-sandboxes | Create a developer sandbox|
+|[**list**](#list) | **GET** /api/v2/developer-sandboxes | List developer sandboxes|
+|[**show2**](#show2) | **GET** /api/v2/developer-sandboxes/{uuid} | Get a developer sandbox|
+
+# **create1**
+> CreateResponse create1(createDeveloperSandboxRequest)
+
+Clones the selected company\'s Neo4j database (no new Company node). Activate with X-Caraer-Sandbox-Uuid; company identity stays the owner.
+
+### Example
+
+```typescript
+import {
+    DeveloperSandboxesApi,
+    Configuration,
+    CreateDeveloperSandboxRequest
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new DeveloperSandboxesApi(configuration);
+
+let createDeveloperSandboxRequest: CreateDeveloperSandboxRequest; //
+
+const { status, data } = await apiInstance.create1(
+    createDeveloperSandboxRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createDeveloperSandboxRequest** | **CreateDeveloperSandboxRequest**|  | |
+
+
+### Return type
+
+**CreateResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Sandbox created |  -  |
+|**400** | name is required |  -  |
+
+[[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)
+
+# **list**
+> any list()
+
+Lists sandboxes owned by the caller\'s selected company.
+
+### Example
+
+```typescript
+import {
+    DeveloperSandboxesApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new DeveloperSandboxesApi(configuration);
+
+const { status, data } = await apiInstance.list();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**any**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[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)
+
+# **show2**
+> show2()
+
+
+### Example
+
+```typescript
+import {
+    DeveloperSandboxesApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new DeveloperSandboxesApi(configuration);
+
+let uuid: string; //UUID of the sandbox (default to undefined)
+
+const { status, data } = await apiInstance.show2(
+    uuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **uuid** | [**string**] | UUID of the sandbox | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**403** | Caller does not own this sandbox |  -  |
+|**404** | Sandbox 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)
+

package/docs/DeviceApproveRequest.md

@@ -0,0 +1,21 @@
+# DeviceApproveRequest
+
+Approve a pending device-code login (authenticated browser session)
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**userCode** | **string** | User-facing code shown by the CLI | [default to undefined]
+
+## Example
+
+```typescript
+import { DeviceApproveRequest } from '@caraer/client';
+
+const instance: DeviceApproveRequest = {
+    userCode,
+};
+```
+
+[[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/DevicePollRequest.md

@@ -0,0 +1,21 @@
+# DevicePollRequest
+
+Poll a device-code login session
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**deviceCode** | **string** | Device code returned by /auth/device/start | [default to undefined]
+
+## Example
+
+```typescript
+import { DevicePollRequest } from '@caraer/client';
+
+const instance: DevicePollRequest = {
+    deviceCode,
+};
+```
+
+[[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/ErrorResponse.md

@@ -12,6 +12,7 @@ Name | Type | Description | Notes
 **stackTrace** | **string** |  | [optional] [default to undefined]
 **roles** | **Array<string>** |  | [optional] [default to undefined]
 **scopes** | **Array<string>** |  | [optional] [default to undefined]
+**requestId** | **string** | Request correlation ID for support and log tracing. | [optional] [default to undefined]
 
 ## Example
 
@@ -25,6 +26,7 @@ const instance: ErrorResponse = {
     stackTrace,
     roles,
     scopes,
+    requestId,
 };
 ```
 

package/docs/EventRsvpRequest.md

@@ -0,0 +1,22 @@
+# EventRsvpRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**partstat** | **string** | Participation status on the attendees edge | [default to undefined]
+**scope** | **string** | Series scope for recurring events. Defaults to this. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { EventRsvpRequest } from '@caraer/client';
+
+const instance: EventRsvpRequest = {
+    partstat,
+    scope,
+};
+```
+
+[[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/ExistingWidgetSummary.md

@@ -0,0 +1,34 @@
+# ExistingWidgetSummary
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**xproperty** | **string** |  | [optional] [default to undefined]
+**ymetric** | **string** |  | [optional] [default to undefined]
+**yproperty** | **string** |  | [optional] [default to undefined]
+**title** | **string** |  | [optional] [default to undefined]
+**chartType** | **string** |  | [optional] [default to undefined]
+**xProperty** | **string** |  | [optional] [default to undefined]
+**yMetric** | **string** |  | [optional] [default to undefined]
+**yProperty** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ExistingWidgetSummary } from '@caraer/client';
+
+const instance: ExistingWidgetSummary = {
+    xproperty,
+    ymetric,
+    yproperty,
+    title,
+    chartType,
+    xProperty,
+    yMetric,
+    yProperty,
+};
+```
+
+[[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/{MorphRecordRequest.md → ExtendRecordRequest.md}

@@ -1,19 +1,19 @@
-# MorphRecordRequest
+# ExtendRecordRequest
 
-Request to morph a record
+Request to extend a record
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**objects** | [**Set<CaraerObjectDTO>**](CaraerObjectDTO.md) | The objects to morph the record into | [optional] [default to undefined]
+**objects** | [**Set<CaraerObjectDTO>**](CaraerObjectDTO.md) | The objects to extend the record into | [optional] [default to undefined]
 
 ## Example
 
 ```typescript
-import { MorphRecordRequest } from '@caraer/client';
+import { ExtendRecordRequest } from '@caraer/client';
 
-const instance: MorphRecordRequest = {
+const instance: ExtendRecordRequest = {
     objects,
 };
 ```