@caraer/client 2.0.381 → 2.0.382
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +72 -1
- package/api.ts +7888 -2480
- package/apps.ts +122 -0
- package/dist/api.d.ts +3806 -637
- package/dist/api.js +6088 -1935
- package/dist/apps.d.ts +111 -0
- package/dist/apps.js +9 -0
- package/dist/esm/api.d.ts +3806 -637
- package/dist/esm/api.js +6019 -1883
- package/dist/esm/apps.d.ts +111 -0
- package/dist/esm/apps.js +8 -0
- package/dist/esm/index.d.ts +1 -0
- package/dist/esm/index.js +1 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +1 -0
- package/docs/AdvancedRecordQueryPlan.md +50 -0
- package/docs/AdvancedRecordQueryRequest.md +43 -0
- package/docs/AdvancedRecordQueryResponse.md +39 -0
- package/docs/AdvancedRecordQueryResultItem.md +32 -0
- package/docs/AggregateBatchRequest.md +21 -0
- package/docs/AggregateRequest.md +43 -0
- package/docs/AnalyticsAxisConfig.md +32 -0
- package/docs/AnalyticsComparisonMetric.md +28 -0
- package/docs/AnalyticsDashboardConfig.md +24 -0
- package/docs/AnalyticsPropertyRef.md +24 -0
- package/docs/AnalyticsReferenceLine.md +24 -0
- package/docs/AnalyticsSeriesConfig.md +20 -0
- package/docs/AnalyticsTrendConfig.md +22 -0
- package/docs/AnalyticsWidgetConfig.md +54 -0
- package/docs/AnalyticsWidgetStyle.md +32 -0
- package/docs/AppConnectionStatusDTO.md +38 -0
- package/docs/AppDTO.md +19 -1
- package/docs/AppExternalOAuthProviderDTO.md +59 -0
- package/docs/AppExternalOAuthProviderSummaryDTO.md +27 -0
- package/docs/AppInboundRouteDTO.md +49 -0
- package/docs/AppInstallationRuntimeApi.md +764 -0
- package/docs/AppOAuthStartResponseDTO.md +20 -0
- package/docs/AppPublishDTO.md +1 -1
- package/docs/AppScheduleDTO.md +47 -0
- package/docs/AppSettingFieldSchema.md +4 -0
- package/docs/AppSettingOptionsSource.md +2 -0
- package/docs/ApplicationsApi.md +228 -0
- package/docs/BillingApi.md +101 -0
- package/docs/BulkDeleteRecordsData.md +21 -0
- package/docs/BulkDeleteRecordsRequest.md +23 -0
- package/docs/BulkDeleteRecordsResponse.md +25 -0
- package/docs/BulkEditRecordErrorItem.md +27 -0
- package/docs/BulkEditRecordItem.md +25 -0
- package/docs/BulkEditRecordResultItem.md +25 -0
- package/docs/BulkEditRecordsData.md +21 -0
- package/docs/BulkEditRecordsRequest.md +21 -0
- package/docs/BulkEditRecordsResponse.md +25 -0
- package/docs/CompanyApi.md +157 -0
- package/docs/CreateDeveloperProjectRequest.md +25 -0
- package/docs/CreateDeveloperSandboxRequest.md +23 -0
- package/docs/CreatePrivateAppRequest.md +4 -0
- package/docs/CreateProjectBuildRequest.md +29 -0
- package/docs/CreateResponseAppExternalOAuthProviderDTO.md +23 -0
- package/docs/CreateResponseAppInboundRouteDTO.md +23 -0
- package/docs/CreateResponseAppScheduleDTO.md +23 -0
- package/docs/CriterionScore.md +30 -0
- package/docs/CrossObjectRecordSearchRequest.md +37 -0
- package/docs/DeleteResponseVoid.md +23 -0
- package/docs/DeployBuildRequest.md +23 -0
- package/docs/DeveloperProjectsApi.md +387 -0
- package/docs/DeveloperSandboxesApi.md +158 -0
- package/docs/DeviceApproveRequest.md +21 -0
- package/docs/DevicePollRequest.md +21 -0
- package/docs/ErrorResponse.md +2 -0
- package/docs/EventRsvpRequest.md +22 -0
- package/docs/ExistingWidgetSummary.md +34 -0
- package/docs/{MorphRecordRequest.md → ExtendRecordRequest.md} +5 -5
- package/docs/FilterItem.md +4 -0
- package/docs/GraphPathEvidence.md +28 -0
- package/docs/GraphTraversalSpec.md +32 -0
- package/docs/Leadscore.md +4 -0
- package/docs/MigrateAppToV2Request.md +21 -0
- package/docs/ObjectsApi.md +6 -6
- package/docs/PreviewDTO.md +2 -0
- package/docs/Progress.md +20 -0
- package/docs/PropertyDTO.md +4 -0
- package/docs/PropertyDTOFormat.md +2 -0
- package/docs/PropertyOption.md +2 -0
- package/docs/QueryEvidence.md +40 -0
- package/docs/Record.md +2 -2
- package/docs/RecordDTO.md +1 -1
- package/docs/RecordRelationRequestDTO.md +2 -0
- package/docs/RecordsApi.md +671 -75
- package/docs/Recurrence.md +18 -0
- package/docs/RefreshTokenRequest.md +21 -0
- package/docs/RelationEdgeRequestDTO.md +23 -0
- package/docs/SamplePayloadRequest.md +23 -0
- package/docs/SavePropertyDTO.md +5 -1
- package/docs/ScoreBreakdown.md +34 -0
- package/docs/ServerlessFunctionDTO.md +2 -0
- package/docs/ServerlessFunctionRefDTO.md +25 -0
- package/docs/ServerlessFunctionsApi.md +184 -8
- package/docs/ShowItem.md +2 -0
- package/docs/ShowResponseAppExternalOAuthProviderDTO.md +23 -0
- package/docs/ShowResponseAppInboundRouteDTO.md +23 -0
- package/docs/ShowResponseAppOAuthStartResponseDTO.md +23 -0
- package/docs/ShowResponseAppScheduleDTO.md +23 -0
- package/docs/ShowResponseListAppConnectionStatusDTO.md +23 -0
- package/docs/ShowResponseListString.md +23 -0
- package/docs/ShowResponseMapStringObject.md +23 -0
- package/docs/ShowResponseObject.md +23 -0
- package/docs/SortItem.md +2 -0
- package/docs/SuccessResponseListAppExternalOAuthProviderDTO.md +23 -0
- package/docs/SuccessResponseListAppInboundRouteDTO.md +23 -0
- package/docs/SuccessResponseListAppScheduleDTO.md +23 -0
- package/docs/SuggestAnalyticsWidgetsRequest.md +24 -0
- package/docs/Team.md +2 -2
- package/docs/TraitsApi.md +272 -0
- package/docs/UserRecordResponseDTO.md +1 -1
- package/docs/ViewDTO.md +12 -0
- package/index.ts +2 -0
- package/package.json +1 -1
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Recurrence
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
import { Recurrence } from '@caraer/client';
|
|
13
|
+
|
|
14
|
+
const instance: Recurrence = {
|
|
15
|
+
};
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# RefreshTokenRequest
|
|
2
|
+
|
|
3
|
+
Exchange a refresh token for a new access token
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**refreshToken** | **string** | Refresh token issued by device poll / refresh | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { RefreshTokenRequest } from '@caraer/client';
|
|
15
|
+
|
|
16
|
+
const instance: RefreshTokenRequest = {
|
|
17
|
+
refreshToken,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# RelationEdgeRequestDTO
|
|
2
|
+
|
|
3
|
+
Optional relation edge payload
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**edgeProperties** | **{ [key: string]: any | null; }** | Values for properties declared on the relation schema, stored on the edge itself. A null value clears that key. | [optional] [default to undefined]
|
|
10
|
+
**primary** | **boolean** | When true, marks this relation edge as primary. Overrides the primary query parameter. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { RelationEdgeRequestDTO } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: RelationEdgeRequestDTO = {
|
|
18
|
+
edgeProperties,
|
|
19
|
+
primary,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# SamplePayloadRequest
|
|
2
|
+
|
|
3
|
+
Request body for generating a sample webhook payload from a record and event type.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**recordUuid** | **string** | UUID of the record to base the sample payload on. | [optional] [default to undefined]
|
|
10
|
+
**eventType** | **string** | Event type to simulate (created, updated, deleted, etc.). | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { SamplePayloadRequest } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: SamplePayloadRequest = {
|
|
18
|
+
recordUuid,
|
|
19
|
+
eventType,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[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/SavePropertyDTO.md
CHANGED
|
@@ -24,6 +24,7 @@ Name | Type | Description | Notes
|
|
|
24
24
|
**rules** | **Array<string>** | Collection of rules applied to the property | [optional] [default to undefined]
|
|
25
25
|
**hidden** | **boolean** | Indicates if the property is hidden by default | [optional] [default to undefined]
|
|
26
26
|
**lifecycleActive** | **boolean** | When true, property value changes are tracked as lifecycle records | [optional] [default to undefined]
|
|
27
|
+
**requiredFilter** | [**Filter**](Filter.md) | When this filter matches the record being saved, the property becomes required | [optional] [default to undefined]
|
|
27
28
|
**nonPublic** | **boolean** | Indicates if the property is not accessible publicly | [optional] [default to undefined]
|
|
28
29
|
**indexed** | **boolean** | Indicates if the property is indexed | [optional] [default to undefined]
|
|
29
30
|
**formatSettings** | **{ [key: string]: any | null; }** | Settings to configure the format of the property | [optional] [default to undefined]
|
|
@@ -31,7 +32,8 @@ Name | Type | Description | Notes
|
|
|
31
32
|
**editable** | **boolean** | Indicates if the property can be edited | [optional] [default to undefined]
|
|
32
33
|
**icon** | **string** | The icon associated with the property | [optional] [default to undefined]
|
|
33
34
|
**webpagePublic** | **boolean** | Indicates if the property is webpage public | [optional] [default to undefined]
|
|
34
|
-
**embeddable** | **boolean** |
|
|
35
|
+
**embeddable** | **boolean** | Deprecated. Use sensitive instead. | [optional] [default to undefined]
|
|
36
|
+
**sensitive** | **boolean** | When true, exclude from advanced query evidence | [optional] [default to undefined]
|
|
35
37
|
|
|
36
38
|
## Example
|
|
37
39
|
|
|
@@ -57,6 +59,7 @@ const instance: SavePropertyDTO = {
|
|
|
57
59
|
rules,
|
|
58
60
|
hidden,
|
|
59
61
|
lifecycleActive,
|
|
62
|
+
requiredFilter,
|
|
60
63
|
nonPublic,
|
|
61
64
|
indexed,
|
|
62
65
|
formatSettings,
|
|
@@ -65,6 +68,7 @@ const instance: SavePropertyDTO = {
|
|
|
65
68
|
icon,
|
|
66
69
|
webpagePublic,
|
|
67
70
|
embeddable,
|
|
71
|
+
sensitive,
|
|
68
72
|
};
|
|
69
73
|
```
|
|
70
74
|
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# ScoreBreakdown
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**overall** | **number** | | [optional] [default to undefined]
|
|
9
|
+
**structured** | **number** | | [optional] [default to undefined]
|
|
10
|
+
**lexical** | **number** | | [optional] [default to undefined]
|
|
11
|
+
**semantic** | **number** | | [optional] [default to undefined]
|
|
12
|
+
**graph** | **number** | | [optional] [default to undefined]
|
|
13
|
+
**evidenceAdjustment** | **number** | | [optional] [default to undefined]
|
|
14
|
+
**confidence** | **number** | | [optional] [default to undefined]
|
|
15
|
+
**components** | **{ [key: string]: number; }** | | [optional] [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { ScoreBreakdown } from '@caraer/client';
|
|
21
|
+
|
|
22
|
+
const instance: ScoreBreakdown = {
|
|
23
|
+
overall,
|
|
24
|
+
structured,
|
|
25
|
+
lexical,
|
|
26
|
+
semantic,
|
|
27
|
+
graph,
|
|
28
|
+
evidenceAdjustment,
|
|
29
|
+
confidence,
|
|
30
|
+
components,
|
|
31
|
+
};
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -18,6 +18,7 @@ Name | Type | Description | Notes
|
|
|
18
18
|
**index** | **number** | Index number for ordering entities | [optional] [default to undefined]
|
|
19
19
|
**runtime** | **string** | Runtime identifier (e.g. javascript, python) | [optional] [default to undefined]
|
|
20
20
|
**code** | **string** | Function source code | [optional] [default to undefined]
|
|
21
|
+
**sourceFiles** | **{ [key: string]: string; }** | Additional source files relative to the function folder (e.g. shared.js) | [optional] [default to undefined]
|
|
21
22
|
**description** | **string** | Optional description of the serverless function | [optional] [default to undefined]
|
|
22
23
|
|
|
23
24
|
## Example
|
|
@@ -38,6 +39,7 @@ const instance: ServerlessFunctionDTO = {
|
|
|
38
39
|
index,
|
|
39
40
|
runtime,
|
|
40
41
|
code,
|
|
42
|
+
sourceFiles,
|
|
41
43
|
description,
|
|
42
44
|
};
|
|
43
45
|
```
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# ServerlessFunctionRefDTO
|
|
2
|
+
|
|
3
|
+
Reference to a serverless function by uuid and/or name
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**uuid** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**label** | **string** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { ServerlessFunctionRefDTO } from '@caraer/client';
|
|
17
|
+
|
|
18
|
+
const instance: ServerlessFunctionRefDTO = {
|
|
19
|
+
uuid,
|
|
20
|
+
name,
|
|
21
|
+
label,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -4,14 +4,17 @@ All URIs are relative to *https://v2.api.caraer.com*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**
|
|
7
|
+
|[**create3**](#create3) | **POST** /api/v2/apps/{appUuid}/serverless-functions | Create a serverless function|
|
|
8
|
+
|[**delete1**](#delete1) | **DELETE** /api/v2/apps/{appUuid}/serverless-functions/{uuid} | Delete a serverless function|
|
|
8
9
|
|[**index2**](#index2) | **POST** /api/v2/apps/{appUuid}/serverless-functions/index | List serverless functions for an app|
|
|
9
|
-
|[**
|
|
10
|
+
|[**logs**](#logs) | **GET** /api/v2/apps/{appUuid}/serverless-functions/{uuid}/logs | Get serverless function logs|
|
|
11
|
+
|[**samplePayload**](#samplepayload) | **POST** /api/v2/apps/{appUuid}/serverless-functions/sample-payload | Generate a sample webhook payload|
|
|
12
|
+
|[**show1**](#show1) | **GET** /api/v2/apps/{appUuid}/serverless-functions/{uuid} | Get a serverless function|
|
|
10
13
|
|[**testServerlessFunction**](#testserverlessfunction) | **POST** /api/v2/apps/{appUuid}/serverless-functions/{uuid}/test | Test a serverless function|
|
|
11
14
|
|[**update1**](#update1) | **PUT** /api/v2/apps/{appUuid}/serverless-functions/{uuid} | Update a serverless function|
|
|
12
15
|
|
|
13
|
-
# **
|
|
14
|
-
> CreateResponse
|
|
16
|
+
# **create3**
|
|
17
|
+
> CreateResponse create3(serverlessFunctionDTO)
|
|
15
18
|
|
|
16
19
|
Creates a new serverless function attached to the specified app.
|
|
17
20
|
|
|
@@ -30,7 +33,7 @@ const apiInstance = new ServerlessFunctionsApi(configuration);
|
|
|
30
33
|
let appUuid: string; //UUID of the app to attach the serverless function to (default to undefined)
|
|
31
34
|
let serverlessFunctionDTO: ServerlessFunctionDTO; //Serverless function payload (runtime and code)
|
|
32
35
|
|
|
33
|
-
const { status, data } = await apiInstance.
|
|
36
|
+
const { status, data } = await apiInstance.create3(
|
|
34
37
|
appUuid,
|
|
35
38
|
serverlessFunctionDTO
|
|
36
39
|
);
|
|
@@ -66,6 +69,61 @@ const { status, data } = await apiInstance.create1(
|
|
|
66
69
|
|
|
67
70
|
[[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)
|
|
68
71
|
|
|
72
|
+
# **delete1**
|
|
73
|
+
> DeleteResponse delete1()
|
|
74
|
+
|
|
75
|
+
Tears down the GCP Cloud Function (if provisioned) and deletes the serverless function entity.
|
|
76
|
+
|
|
77
|
+
### Example
|
|
78
|
+
|
|
79
|
+
```typescript
|
|
80
|
+
import {
|
|
81
|
+
ServerlessFunctionsApi,
|
|
82
|
+
Configuration
|
|
83
|
+
} from '@caraer/client';
|
|
84
|
+
|
|
85
|
+
const configuration = new Configuration();
|
|
86
|
+
const apiInstance = new ServerlessFunctionsApi(configuration);
|
|
87
|
+
|
|
88
|
+
let appUuid: string; //UUID of the app (default to undefined)
|
|
89
|
+
let uuid: string; //UUID of the serverless function to delete (default to undefined)
|
|
90
|
+
|
|
91
|
+
const { status, data } = await apiInstance.delete1(
|
|
92
|
+
appUuid,
|
|
93
|
+
uuid
|
|
94
|
+
);
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### Parameters
|
|
98
|
+
|
|
99
|
+
|Name | Type | Description | Notes|
|
|
100
|
+
|------------- | ------------- | ------------- | -------------|
|
|
101
|
+
| **appUuid** | [**string**] | UUID of the app | defaults to undefined|
|
|
102
|
+
| **uuid** | [**string**] | UUID of the serverless function to delete | defaults to undefined|
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
### Return type
|
|
106
|
+
|
|
107
|
+
**DeleteResponse**
|
|
108
|
+
|
|
109
|
+
### Authorization
|
|
110
|
+
|
|
111
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
112
|
+
|
|
113
|
+
### HTTP request headers
|
|
114
|
+
|
|
115
|
+
- **Content-Type**: Not defined
|
|
116
|
+
- **Accept**: application/json
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
### HTTP response details
|
|
120
|
+
| Status code | Description | Response headers |
|
|
121
|
+
|-------------|-------------|------------------|
|
|
122
|
+
|**200** | Successfully deleted serverless function | - |
|
|
123
|
+
|**404** | Serverless function not found for this app | - |
|
|
124
|
+
|
|
125
|
+
[[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)
|
|
126
|
+
|
|
69
127
|
# **index2**
|
|
70
128
|
> PaginationResponse index2(body)
|
|
71
129
|
|
|
@@ -122,8 +180,126 @@ const { status, data } = await apiInstance.index2(
|
|
|
122
180
|
|
|
123
181
|
[[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)
|
|
124
182
|
|
|
125
|
-
# **
|
|
126
|
-
>
|
|
183
|
+
# **logs**
|
|
184
|
+
> SuccessResponse logs()
|
|
185
|
+
|
|
186
|
+
Queries Cloud Logging for recent log entries emitted by the Cloud Function backing this serverless function.
|
|
187
|
+
|
|
188
|
+
### Example
|
|
189
|
+
|
|
190
|
+
```typescript
|
|
191
|
+
import {
|
|
192
|
+
ServerlessFunctionsApi,
|
|
193
|
+
Configuration
|
|
194
|
+
} from '@caraer/client';
|
|
195
|
+
|
|
196
|
+
const configuration = new Configuration();
|
|
197
|
+
const apiInstance = new ServerlessFunctionsApi(configuration);
|
|
198
|
+
|
|
199
|
+
let appUuid: string; //UUID of the app (default to undefined)
|
|
200
|
+
let uuid: string; //UUID of the serverless function (default to undefined)
|
|
201
|
+
let since: string; //Lookback window, e.g. 15m, 1h, 24h (optional) (default to '1h')
|
|
202
|
+
let limit: number; //Maximum number of log entries to return (optional) (default to 100)
|
|
203
|
+
|
|
204
|
+
const { status, data } = await apiInstance.logs(
|
|
205
|
+
appUuid,
|
|
206
|
+
uuid,
|
|
207
|
+
since,
|
|
208
|
+
limit
|
|
209
|
+
);
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
### Parameters
|
|
213
|
+
|
|
214
|
+
|Name | Type | Description | Notes|
|
|
215
|
+
|------------- | ------------- | ------------- | -------------|
|
|
216
|
+
| **appUuid** | [**string**] | UUID of the app | defaults to undefined|
|
|
217
|
+
| **uuid** | [**string**] | UUID of the serverless function | defaults to undefined|
|
|
218
|
+
| **since** | [**string**] | Lookback window, e.g. 15m, 1h, 24h | (optional) defaults to '1h'|
|
|
219
|
+
| **limit** | [**number**] | Maximum number of log entries to return | (optional) defaults to 100|
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
### Return type
|
|
223
|
+
|
|
224
|
+
**SuccessResponse**
|
|
225
|
+
|
|
226
|
+
### Authorization
|
|
227
|
+
|
|
228
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
229
|
+
|
|
230
|
+
### HTTP request headers
|
|
231
|
+
|
|
232
|
+
- **Content-Type**: Not defined
|
|
233
|
+
- **Accept**: application/json
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
### HTTP response details
|
|
237
|
+
| Status code | Description | Response headers |
|
|
238
|
+
|-------------|-------------|------------------|
|
|
239
|
+
|**200** | Successfully retrieved logs (may be empty if logging is unavailable) | - |
|
|
240
|
+
|**404** | Serverless function not found for this app | - |
|
|
241
|
+
|
|
242
|
+
[[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)
|
|
243
|
+
|
|
244
|
+
# **samplePayload**
|
|
245
|
+
> SuccessResponse samplePayload(samplePayloadRequest)
|
|
246
|
+
|
|
247
|
+
Builds the same payload shape used for serverless invocations and webhook delivery from a record and event type, without invoking anything.
|
|
248
|
+
|
|
249
|
+
### Example
|
|
250
|
+
|
|
251
|
+
```typescript
|
|
252
|
+
import {
|
|
253
|
+
ServerlessFunctionsApi,
|
|
254
|
+
Configuration,
|
|
255
|
+
SamplePayloadRequest
|
|
256
|
+
} from '@caraer/client';
|
|
257
|
+
|
|
258
|
+
const configuration = new Configuration();
|
|
259
|
+
const apiInstance = new ServerlessFunctionsApi(configuration);
|
|
260
|
+
|
|
261
|
+
let appUuid: string; //UUID of the app (default to undefined)
|
|
262
|
+
let samplePayloadRequest: SamplePayloadRequest; //Sample payload request (recordUuid and eventType)
|
|
263
|
+
|
|
264
|
+
const { status, data } = await apiInstance.samplePayload(
|
|
265
|
+
appUuid,
|
|
266
|
+
samplePayloadRequest
|
|
267
|
+
);
|
|
268
|
+
```
|
|
269
|
+
|
|
270
|
+
### Parameters
|
|
271
|
+
|
|
272
|
+
|Name | Type | Description | Notes|
|
|
273
|
+
|------------- | ------------- | ------------- | -------------|
|
|
274
|
+
| **samplePayloadRequest** | **SamplePayloadRequest**| Sample payload request (recordUuid and eventType) | |
|
|
275
|
+
| **appUuid** | [**string**] | UUID of the app | defaults to undefined|
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
### Return type
|
|
279
|
+
|
|
280
|
+
**SuccessResponse**
|
|
281
|
+
|
|
282
|
+
### Authorization
|
|
283
|
+
|
|
284
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
285
|
+
|
|
286
|
+
### HTTP request headers
|
|
287
|
+
|
|
288
|
+
- **Content-Type**: application/json
|
|
289
|
+
- **Accept**: application/json
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
### HTTP response details
|
|
293
|
+
| Status code | Description | Response headers |
|
|
294
|
+
|-------------|-------------|------------------|
|
|
295
|
+
|**200** | Sample payload generated | - |
|
|
296
|
+
|**400** | Invalid input provided | - |
|
|
297
|
+
|**404** | App or record not found | - |
|
|
298
|
+
|
|
299
|
+
[[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)
|
|
300
|
+
|
|
301
|
+
# **show1**
|
|
302
|
+
> ShowResponse show1()
|
|
127
303
|
|
|
128
304
|
Retrieves a serverless function by its UUID, ensuring it belongs to the specified app.
|
|
129
305
|
|
|
@@ -141,7 +317,7 @@ const apiInstance = new ServerlessFunctionsApi(configuration);
|
|
|
141
317
|
let appUuid: string; //UUID of the app (default to undefined)
|
|
142
318
|
let uuid: string; //UUID of the serverless function (default to undefined)
|
|
143
319
|
|
|
144
|
-
const { status, data } = await apiInstance.
|
|
320
|
+
const { status, data } = await apiInstance.show1(
|
|
145
321
|
appUuid,
|
|
146
322
|
uuid
|
|
147
323
|
);
|
package/docs/ShowItem.md
CHANGED
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**object** | **string** | The name of the object to which this pagination item belongs. | [optional] [default to undefined]
|
|
10
10
|
**relation** | **string** | The relationship between objects. | [optional] [default to undefined]
|
|
11
|
+
**relationDirection** | **string** | Optional relation direction: outgoing (related→main), incoming (main→related), or omit for undirected. | [optional] [default to undefined]
|
|
11
12
|
**property** | **string** | The name of the property within the object. | [optional] [default to undefined]
|
|
12
13
|
**separator** | **string** | Separator string used to visually separate this item. | [optional] [default to undefined]
|
|
13
14
|
**sticky** | **boolean** | Flag indicating whether this item is sticky and will stay fixed in the list. | [optional] [default to false]
|
|
@@ -23,6 +24,7 @@ import { ShowItem } from '@caraer/client';
|
|
|
23
24
|
const instance: ShowItem = {
|
|
24
25
|
object,
|
|
25
26
|
relation,
|
|
27
|
+
relationDirection,
|
|
26
28
|
property,
|
|
27
29
|
separator,
|
|
28
30
|
sticky,
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# ShowResponseAppExternalOAuthProviderDTO
|
|
2
|
+
|
|
3
|
+
Represents the response for viewing or showing a specific resource.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
|
|
10
|
+
**data** | [**AppExternalOAuthProviderDTO**](AppExternalOAuthProviderDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ShowResponseAppExternalOAuthProviderDTO } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: ShowResponseAppExternalOAuthProviderDTO = {
|
|
18
|
+
message,
|
|
19
|
+
data,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# ShowResponseAppInboundRouteDTO
|
|
2
|
+
|
|
3
|
+
Represents the response for viewing or showing a specific resource.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
|
|
10
|
+
**data** | [**AppInboundRouteDTO**](AppInboundRouteDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ShowResponseAppInboundRouteDTO } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: ShowResponseAppInboundRouteDTO = {
|
|
18
|
+
message,
|
|
19
|
+
data,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# ShowResponseAppOAuthStartResponseDTO
|
|
2
|
+
|
|
3
|
+
Represents the response for viewing or showing a specific resource.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
|
|
10
|
+
**data** | [**AppOAuthStartResponseDTO**](AppOAuthStartResponseDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ShowResponseAppOAuthStartResponseDTO } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: ShowResponseAppOAuthStartResponseDTO = {
|
|
18
|
+
message,
|
|
19
|
+
data,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# ShowResponseAppScheduleDTO
|
|
2
|
+
|
|
3
|
+
Represents the response for viewing or showing a specific resource.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
|
|
10
|
+
**data** | [**AppScheduleDTO**](AppScheduleDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ShowResponseAppScheduleDTO } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: ShowResponseAppScheduleDTO = {
|
|
18
|
+
message,
|
|
19
|
+
data,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# ShowResponseListAppConnectionStatusDTO
|
|
2
|
+
|
|
3
|
+
Represents the response for viewing or showing a specific resource.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
|
|
10
|
+
**data** | [**Array<AppConnectionStatusDTO>**](AppConnectionStatusDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ShowResponseListAppConnectionStatusDTO } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: ShowResponseListAppConnectionStatusDTO = {
|
|
18
|
+
message,
|
|
19
|
+
data,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# ShowResponseListString
|
|
2
|
+
|
|
3
|
+
Represents the response for viewing or showing a specific resource.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
|
|
10
|
+
**data** | **Array<string>** | The data payload of the response, if any. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ShowResponseListString } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: ShowResponseListString = {
|
|
18
|
+
message,
|
|
19
|
+
data,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# ShowResponseMapStringObject
|
|
2
|
+
|
|
3
|
+
Represents the response for viewing or showing a specific resource.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
|
|
10
|
+
**data** | **{ [key: string]: any | null; }** | The data payload of the response, if any. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ShowResponseMapStringObject } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: ShowResponseMapStringObject = {
|
|
18
|
+
message,
|
|
19
|
+
data,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# ShowResponseObject
|
|
2
|
+
|
|
3
|
+
Represents the response for viewing or showing a specific resource.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
|
|
10
|
+
**data** | **any** | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ShowResponseObject } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: ShowResponseObject = {
|
|
18
|
+
message,
|
|
19
|
+
data,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[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/SortItem.md
CHANGED
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**object** | **string** | The name of the object to which this pagination item belongs. | [optional] [default to undefined]
|
|
10
10
|
**relation** | **string** | The relationship between objects. | [optional] [default to undefined]
|
|
11
|
+
**relationDirection** | **string** | Optional relation direction: outgoing (related→main), incoming (main→related), or omit for undirected. | [optional] [default to undefined]
|
|
11
12
|
**property** | **string** | The name of the property within the object. | [optional] [default to undefined]
|
|
12
13
|
**direction** | **string** | The direction for sorting. Can be ASC (ascending) or DESC (descending). | [optional] [default to undefined]
|
|
13
14
|
|
|
@@ -19,6 +20,7 @@ import { SortItem } from '@caraer/client';
|
|
|
19
20
|
const instance: SortItem = {
|
|
20
21
|
object,
|
|
21
22
|
relation,
|
|
23
|
+
relationDirection,
|
|
22
24
|
property,
|
|
23
25
|
direction,
|
|
24
26
|
};
|