@caraer/client 2.0.702 → 2.0.705
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 +5 -2
- package/api.ts +326 -100
- package/dist/api.d.ts +189 -62
- package/dist/api.js +261 -73
- package/dist/esm/api.d.ts +189 -62
- package/dist/esm/api.js +261 -73
- package/docs/CMSV2PagesApi.md +180 -0
- package/docs/CalendarRecordDTO.md +4 -0
- package/docs/CalendarsApi.md +1 -49
- package/docs/CmsPagePatch.md +2 -0
- package/docs/ConnectionState.md +20 -0
- package/docs/EventRsvpRequest.md +2 -0
- package/docs/ExistingWidgetSummary.md +2 -2
- package/docs/FilledProperty.md +2 -2
- package/docs/Filter.md +2 -0
- package/docs/Outcome.md +24 -0
- package/docs/Record.md +2 -2
- package/docs/RecordRelationRequestDTO.md +2 -0
- package/docs/ResolveRequest.md +20 -0
- package/docs/SendRequest.md +22 -0
- package/docs/SettingField.md +2 -2
- package/docs/{SuccessResponseListCalendarTeamOptionDTO.md → ShowResponseUserRecordResponseDTO.md} +5 -5
- package/docs/SuccessResponseObject.md +3 -3
- package/docs/TraitsApi.md +4 -1
- package/docs/ViewDTO.md +2 -0
- package/package.json +1 -1
- package/docs/CalendarTeamOptionDTO.md +0 -24
package/docs/CMSV2PagesApi.md
CHANGED
|
@@ -14,10 +14,13 @@ All URIs are relative to *https://v2.api.caraer.com*
|
|
|
14
14
|
|[**history**](#history) | **GET** /api/v2/webpages/v2/pages/{recordUuid}/history | Draft snapshots for one locale|
|
|
15
15
|
|[**hostOnEnvironment**](#hostonenvironment) | **POST** /api/v2/webpages/v2/pages/{recordUuid}/environments/{key}/host | Host this page on another environment|
|
|
16
16
|
|[**library**](#library) | **GET** /api/v2/webpages/v2/pages/library/modules | Modules available to this company|
|
|
17
|
+
|[**moduleReplacementAction**](#modulereplacementaction) | **POST** /api/v2/webpages/v2/pages/{recordUuid}/module-replacements/{replacementId}/{action} | Cancel or retry a module replacement|
|
|
18
|
+
|[**moduleReplacements**](#modulereplacements) | **GET** /api/v2/webpages/v2/pages/{recordUuid}/module-replacements | Check durable module replacements and apply ready builds to the draft|
|
|
17
19
|
|[**patch**](#patch) | **POST** /api/v2/webpages/v2/pages/{recordUuid}/patch | Apply patches to a page draft|
|
|
18
20
|
|[**previewLink**](#previewlink) | **GET** /api/v2/webpages/v2/pages/{recordUuid}/preview-link | Signed preview URL for the builder iframe|
|
|
19
21
|
|[**promptModuleFork**](#promptmodulefork) | **POST** /api/v2/webpages/v2/pages/{recordUuid}/ai/module-fork/sessions/{sessionId}/prompt | Rewrite forked module source from a prompt|
|
|
20
22
|
|[**publish**](#publish) | **PUT** /api/v2/webpages/v2/pages/{recordUuid}/publish | Publish one locale, or all of them|
|
|
23
|
+
|[**publishTemplate**](#publishtemplate) | **PUT** /api/v2/webpages/v2/pages/templates/{objectUuid}/publish | Publish a template draft and update linked live pages|
|
|
21
24
|
|[**restoreHistory**](#restorehistory) | **POST** /api/v2/webpages/v2/pages/{recordUuid}/history/{index}/restore | Restore a draft snapshot|
|
|
22
25
|
|[**save**](#save) | **PUT** /api/v2/webpages/v2/pages/{recordUuid} | Replace a page draft|
|
|
23
26
|
|[**saveMeta**](#savemeta) | **PUT** /api/v2/webpages/v2/pages/{recordUuid}/meta | Update slug, title, excerpt, SEO and page scripts|
|
|
@@ -571,6 +574,123 @@ This endpoint does not have any parameters.
|
|
|
571
574
|
- **Accept**: application/json
|
|
572
575
|
|
|
573
576
|
|
|
577
|
+
### HTTP response details
|
|
578
|
+
| Status code | Description | Response headers |
|
|
579
|
+
|-------------|-------------|------------------|
|
|
580
|
+
|**200** | OK | - |
|
|
581
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
582
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
583
|
+
|**404** | The requested resource was not found. | - |
|
|
584
|
+
|**500** | An internal server error occurred. | - |
|
|
585
|
+
|
|
586
|
+
[[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)
|
|
587
|
+
|
|
588
|
+
# **moduleReplacementAction**
|
|
589
|
+
> ShowResponseMapStringObject moduleReplacementAction()
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
### Example
|
|
593
|
+
|
|
594
|
+
```typescript
|
|
595
|
+
import {
|
|
596
|
+
CMSV2PagesApi,
|
|
597
|
+
Configuration
|
|
598
|
+
} from '@caraer/client';
|
|
599
|
+
|
|
600
|
+
const configuration = new Configuration();
|
|
601
|
+
const apiInstance = new CMSV2PagesApi(configuration);
|
|
602
|
+
|
|
603
|
+
let recordUuid: string; // (default to undefined)
|
|
604
|
+
let replacementId: string; // (default to undefined)
|
|
605
|
+
let action: string; // (default to undefined)
|
|
606
|
+
|
|
607
|
+
const { status, data } = await apiInstance.moduleReplacementAction(
|
|
608
|
+
recordUuid,
|
|
609
|
+
replacementId,
|
|
610
|
+
action
|
|
611
|
+
);
|
|
612
|
+
```
|
|
613
|
+
|
|
614
|
+
### Parameters
|
|
615
|
+
|
|
616
|
+
|Name | Type | Description | Notes|
|
|
617
|
+
|------------- | ------------- | ------------- | -------------|
|
|
618
|
+
| **recordUuid** | [**string**] | | defaults to undefined|
|
|
619
|
+
| **replacementId** | [**string**] | | defaults to undefined|
|
|
620
|
+
| **action** | [**string**] | | defaults to undefined|
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
### Return type
|
|
624
|
+
|
|
625
|
+
**ShowResponseMapStringObject**
|
|
626
|
+
|
|
627
|
+
### Authorization
|
|
628
|
+
|
|
629
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
630
|
+
|
|
631
|
+
### HTTP request headers
|
|
632
|
+
|
|
633
|
+
- **Content-Type**: Not defined
|
|
634
|
+
- **Accept**: application/json
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
### HTTP response details
|
|
638
|
+
| Status code | Description | Response headers |
|
|
639
|
+
|-------------|-------------|------------------|
|
|
640
|
+
|**200** | OK | - |
|
|
641
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
642
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
643
|
+
|**404** | The requested resource was not found. | - |
|
|
644
|
+
|**500** | An internal server error occurred. | - |
|
|
645
|
+
|
|
646
|
+
[[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)
|
|
647
|
+
|
|
648
|
+
# **moduleReplacements**
|
|
649
|
+
> ShowResponseMapStringObject moduleReplacements()
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
### Example
|
|
653
|
+
|
|
654
|
+
```typescript
|
|
655
|
+
import {
|
|
656
|
+
CMSV2PagesApi,
|
|
657
|
+
Configuration
|
|
658
|
+
} from '@caraer/client';
|
|
659
|
+
|
|
660
|
+
const configuration = new Configuration();
|
|
661
|
+
const apiInstance = new CMSV2PagesApi(configuration);
|
|
662
|
+
|
|
663
|
+
let recordUuid: string; // (default to undefined)
|
|
664
|
+
let locale: string; // (optional) (default to undefined)
|
|
665
|
+
|
|
666
|
+
const { status, data } = await apiInstance.moduleReplacements(
|
|
667
|
+
recordUuid,
|
|
668
|
+
locale
|
|
669
|
+
);
|
|
670
|
+
```
|
|
671
|
+
|
|
672
|
+
### Parameters
|
|
673
|
+
|
|
674
|
+
|Name | Type | Description | Notes|
|
|
675
|
+
|------------- | ------------- | ------------- | -------------|
|
|
676
|
+
| **recordUuid** | [**string**] | | defaults to undefined|
|
|
677
|
+
| **locale** | [**string**] | | (optional) defaults to undefined|
|
|
678
|
+
|
|
679
|
+
|
|
680
|
+
### Return type
|
|
681
|
+
|
|
682
|
+
**ShowResponseMapStringObject**
|
|
683
|
+
|
|
684
|
+
### Authorization
|
|
685
|
+
|
|
686
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
687
|
+
|
|
688
|
+
### HTTP request headers
|
|
689
|
+
|
|
690
|
+
- **Content-Type**: Not defined
|
|
691
|
+
- **Accept**: application/json
|
|
692
|
+
|
|
693
|
+
|
|
574
694
|
### HTTP response details
|
|
575
695
|
| Status code | Description | Response headers |
|
|
576
696
|
|-------------|-------------|------------------|
|
|
@@ -812,6 +932,66 @@ const { status, data } = await apiInstance.publish(
|
|
|
812
932
|
- **Accept**: application/json
|
|
813
933
|
|
|
814
934
|
|
|
935
|
+
### HTTP response details
|
|
936
|
+
| Status code | Description | Response headers |
|
|
937
|
+
|-------------|-------------|------------------|
|
|
938
|
+
|**200** | OK | - |
|
|
939
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
940
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
941
|
+
|**404** | The requested resource was not found. | - |
|
|
942
|
+
|**500** | An internal server error occurred. | - |
|
|
943
|
+
|
|
944
|
+
[[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)
|
|
945
|
+
|
|
946
|
+
# **publishTemplate**
|
|
947
|
+
> ShowResponseCmsPageDTO publishTemplate(requestBody)
|
|
948
|
+
|
|
949
|
+
|
|
950
|
+
### Example
|
|
951
|
+
|
|
952
|
+
```typescript
|
|
953
|
+
import {
|
|
954
|
+
CMSV2PagesApi,
|
|
955
|
+
Configuration
|
|
956
|
+
} from '@caraer/client';
|
|
957
|
+
|
|
958
|
+
const configuration = new Configuration();
|
|
959
|
+
const apiInstance = new CMSV2PagesApi(configuration);
|
|
960
|
+
|
|
961
|
+
let objectUuid: string; // (default to undefined)
|
|
962
|
+
let requestBody: { [key: string]: any | null; }; //
|
|
963
|
+
let locale: string; // (optional) (default to undefined)
|
|
964
|
+
|
|
965
|
+
const { status, data } = await apiInstance.publishTemplate(
|
|
966
|
+
objectUuid,
|
|
967
|
+
requestBody,
|
|
968
|
+
locale
|
|
969
|
+
);
|
|
970
|
+
```
|
|
971
|
+
|
|
972
|
+
### Parameters
|
|
973
|
+
|
|
974
|
+
|Name | Type | Description | Notes|
|
|
975
|
+
|------------- | ------------- | ------------- | -------------|
|
|
976
|
+
| **requestBody** | **{ [key: string]: any | null; }**| | |
|
|
977
|
+
| **objectUuid** | [**string**] | | defaults to undefined|
|
|
978
|
+
| **locale** | [**string**] | | (optional) defaults to undefined|
|
|
979
|
+
|
|
980
|
+
|
|
981
|
+
### Return type
|
|
982
|
+
|
|
983
|
+
**ShowResponseCmsPageDTO**
|
|
984
|
+
|
|
985
|
+
### Authorization
|
|
986
|
+
|
|
987
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
988
|
+
|
|
989
|
+
### HTTP request headers
|
|
990
|
+
|
|
991
|
+
- **Content-Type**: application/json
|
|
992
|
+
- **Accept**: application/json
|
|
993
|
+
|
|
994
|
+
|
|
815
995
|
### HTTP response details
|
|
816
996
|
| Status code | Description | Response headers |
|
|
817
997
|
|-------------|-------------|------------------|
|
|
@@ -14,6 +14,8 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**ownerUuid** | **string** | | [optional] [default to undefined]
|
|
15
15
|
**ownerName** | **string** | | [optional] [default to undefined]
|
|
16
16
|
**ownedByCurrentUser** | **boolean** | | [optional] [default to undefined]
|
|
17
|
+
**canEdit** | **boolean** | | [optional] [default to undefined]
|
|
18
|
+
**shared** | **boolean** | | [optional] [default to undefined]
|
|
17
19
|
**teamUuid** | **string** | | [optional] [default to undefined]
|
|
18
20
|
**teamName** | **string** | | [optional] [default to undefined]
|
|
19
21
|
**companyCalendar** | **boolean** | | [optional] [default to undefined]
|
|
@@ -35,6 +37,8 @@ const instance: CalendarRecordDTO = {
|
|
|
35
37
|
ownerUuid,
|
|
36
38
|
ownerName,
|
|
37
39
|
ownedByCurrentUser,
|
|
40
|
+
canEdit,
|
|
41
|
+
shared,
|
|
38
42
|
teamUuid,
|
|
39
43
|
teamName,
|
|
40
44
|
companyCalendar,
|
package/docs/CalendarsApi.md
CHANGED
|
@@ -4,10 +4,9 @@ All URIs are relative to *https://v2.api.caraer.com*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**bootstrap**](#bootstrap) | **POST** /api/v2/calendars/bootstrap | Ensure calendar schema
|
|
7
|
+
|[**bootstrap**](#bootstrap) | **POST** /api/v2/calendars/bootstrap | Ensure calendar schema and personal default; never assigns existing events|
|
|
8
8
|
|[**create4**](#create4) | **POST** /api/v2/calendars | Create a calendar owned by the current user|
|
|
9
9
|
|[**list3**](#list3) | **GET** /api/v2/calendars | List calendars visible to the current company|
|
|
10
|
-
|[**listTeams**](#listteams) | **GET** /api/v2/calendars/teams | List teams that can be linked to a calendar|
|
|
11
10
|
|
|
12
11
|
# **bootstrap**
|
|
13
12
|
> SuccessResponseCalendarBootstrapDTO bootstrap()
|
|
@@ -160,50 +159,3 @@ This endpoint does not have any parameters.
|
|
|
160
159
|
|
|
161
160
|
[[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)
|
|
162
161
|
|
|
163
|
-
# **listTeams**
|
|
164
|
-
> SuccessResponseListCalendarTeamOptionDTO listTeams()
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
### Example
|
|
168
|
-
|
|
169
|
-
```typescript
|
|
170
|
-
import {
|
|
171
|
-
CalendarsApi,
|
|
172
|
-
Configuration
|
|
173
|
-
} from '@caraer/client';
|
|
174
|
-
|
|
175
|
-
const configuration = new Configuration();
|
|
176
|
-
const apiInstance = new CalendarsApi(configuration);
|
|
177
|
-
|
|
178
|
-
const { status, data } = await apiInstance.listTeams();
|
|
179
|
-
```
|
|
180
|
-
|
|
181
|
-
### Parameters
|
|
182
|
-
This endpoint does not have any parameters.
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
### Return type
|
|
186
|
-
|
|
187
|
-
**SuccessResponseListCalendarTeamOptionDTO**
|
|
188
|
-
|
|
189
|
-
### Authorization
|
|
190
|
-
|
|
191
|
-
[bearerAuth](../README.md#bearerAuth)
|
|
192
|
-
|
|
193
|
-
### HTTP request headers
|
|
194
|
-
|
|
195
|
-
- **Content-Type**: Not defined
|
|
196
|
-
- **Accept**: application/json
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
### HTTP response details
|
|
200
|
-
| Status code | Description | Response headers |
|
|
201
|
-
|-------------|-------------|------------------|
|
|
202
|
-
|**200** | OK | - |
|
|
203
|
-
|**401** | Authentication is required or the token is invalid. | - |
|
|
204
|
-
|**403** | The caller is missing a required role or scope. | - |
|
|
205
|
-
|**404** | The requested resource was not found. | - |
|
|
206
|
-
|**500** | An internal server error occurred. | - |
|
|
207
|
-
|
|
208
|
-
[[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)
|
|
209
|
-
|
package/docs/CmsPagePatch.md
CHANGED
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**op** | **string** | | [optional] [default to undefined]
|
|
9
9
|
**moduleId** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**expectedModule** | **string** | | [optional] [default to undefined]
|
|
10
11
|
**ref** | **string** | | [optional] [default to undefined]
|
|
11
12
|
**field** | **string** | | [optional] [default to undefined]
|
|
12
13
|
**value** | **any** | | [optional] [default to undefined]
|
|
@@ -26,6 +27,7 @@ import { CmsPagePatch } from '@caraer/client';
|
|
|
26
27
|
const instance: CmsPagePatch = {
|
|
27
28
|
op,
|
|
28
29
|
moduleId,
|
|
30
|
+
expectedModule,
|
|
29
31
|
ref,
|
|
30
32
|
field,
|
|
31
33
|
value,
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# ConnectionState
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**connected** | **boolean** | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { ConnectionState } from '@caraer/client';
|
|
14
|
+
|
|
15
|
+
const instance: ConnectionState = {
|
|
16
|
+
connected,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[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/EventRsvpRequest.md
CHANGED
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**partstat** | **string** | Participation status on the attendees edge | [default to undefined]
|
|
9
9
|
**scope** | **string** | Series scope for recurring events. Defaults to this. | [optional] [default to undefined]
|
|
10
|
+
**invitationToken** | **string** | | [optional] [default to undefined]
|
|
10
11
|
|
|
11
12
|
## Example
|
|
12
13
|
|
|
@@ -16,6 +17,7 @@ import { EventRsvpRequest } from '@caraer/client';
|
|
|
16
17
|
const instance: EventRsvpRequest = {
|
|
17
18
|
partstat,
|
|
18
19
|
scope,
|
|
20
|
+
invitationToken,
|
|
19
21
|
};
|
|
20
22
|
```
|
|
21
23
|
|
|
@@ -6,8 +6,8 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**xproperty** | **string** | | [optional] [default to undefined]
|
|
9
|
-
**ymetric** | **string** | | [optional] [default to undefined]
|
|
10
9
|
**yproperty** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**ymetric** | **string** | | [optional] [default to undefined]
|
|
11
11
|
**title** | **string** | | [optional] [default to undefined]
|
|
12
12
|
**chartType** | **string** | | [optional] [default to undefined]
|
|
13
13
|
**xProperty** | **string** | | [optional] [default to undefined]
|
|
@@ -21,8 +21,8 @@ import { ExistingWidgetSummary } from '@caraer/client';
|
|
|
21
21
|
|
|
22
22
|
const instance: ExistingWidgetSummary = {
|
|
23
23
|
xproperty,
|
|
24
|
-
ymetric,
|
|
25
24
|
yproperty,
|
|
25
|
+
ymetric,
|
|
26
26
|
title,
|
|
27
27
|
chartType,
|
|
28
28
|
xProperty,
|
package/docs/FilledProperty.md
CHANGED
|
@@ -5,10 +5,10 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**icon** | **string** | | [optional] [default to undefined]
|
|
9
8
|
**name** | **string** | | [optional] [default to undefined]
|
|
10
9
|
**value** | **any** | | [optional] [default to undefined]
|
|
11
10
|
**type** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**icon** | **string** | | [optional] [default to undefined]
|
|
12
12
|
**label** | **string** | | [optional] [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
@@ -17,10 +17,10 @@ Name | Type | Description | Notes
|
|
|
17
17
|
import { FilledProperty } from '@caraer/client';
|
|
18
18
|
|
|
19
19
|
const instance: FilledProperty = {
|
|
20
|
-
icon,
|
|
21
20
|
name,
|
|
22
21
|
value,
|
|
23
22
|
type,
|
|
23
|
+
icon,
|
|
24
24
|
label,
|
|
25
25
|
};
|
|
26
26
|
```
|
package/docs/Filter.md
CHANGED
|
@@ -7,6 +7,7 @@ DTO representing a filter composed of filter groups for querying records. The fi
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**groups** | [**Set<FilterGroup>**](FilterGroup.md) | A collection of filter groups. | [optional] [default to undefined]
|
|
10
|
+
**eventParticipantUuids** | **Array<string>** | Optional participant UUIDs for event records, intersected with the ordinary filter before paging. Omit for all; an empty list matches none. Uses organiser plus the effective Event trait attendee relations. | [optional] [default to undefined]
|
|
10
11
|
|
|
11
12
|
## Example
|
|
12
13
|
|
|
@@ -15,6 +16,7 @@ import { Filter } from '@caraer/client';
|
|
|
15
16
|
|
|
16
17
|
const instance: Filter = {
|
|
17
18
|
groups,
|
|
19
|
+
eventParticipantUuids,
|
|
18
20
|
};
|
|
19
21
|
```
|
|
20
22
|
|
package/docs/Outcome.md
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Outcome
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**claimToken** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**status** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { Outcome } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: Outcome = {
|
|
18
|
+
claimToken,
|
|
19
|
+
status,
|
|
20
|
+
message,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[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/Record.md
CHANGED
|
@@ -17,9 +17,9 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**complete** | **boolean** | | [optional] [default to undefined]
|
|
18
18
|
**deleted** | **boolean** | | [optional] [default to undefined]
|
|
19
19
|
**uuid** | **string** | | [default to undefined]
|
|
20
|
-
**user** | [**PublicUserDTO**](PublicUserDTO.md) | | [optional] [default to undefined]
|
|
21
20
|
**properties** | [**Array<FilledProperty>**](FilledProperty.md) | | [optional] [default to undefined]
|
|
22
21
|
**objects** | **{ [key: string]: any | null; }** | | [optional] [default to undefined]
|
|
22
|
+
**user** | [**PublicUserDTO**](PublicUserDTO.md) | | [optional] [default to undefined]
|
|
23
23
|
|
|
24
24
|
## Example
|
|
25
25
|
|
|
@@ -39,9 +39,9 @@ const instance: ModelRecord = {
|
|
|
39
39
|
complete,
|
|
40
40
|
deleted,
|
|
41
41
|
uuid,
|
|
42
|
-
user,
|
|
43
42
|
properties,
|
|
44
43
|
objects,
|
|
44
|
+
user,
|
|
45
45
|
};
|
|
46
46
|
```
|
|
47
47
|
|
|
@@ -6,6 +6,7 @@ Relation to create when saving a record
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**remove** | **boolean** | When true, remove this existing UUID relation atomically with the record mutation. Nested records and property writes are not allowed. | [optional] [default to undefined]
|
|
9
10
|
**relationName** | **string** | Name of the relation type | [default to undefined]
|
|
10
11
|
**uuid** | **string** | UUID of an existing record to link to | [optional] [default to undefined]
|
|
11
12
|
**properties** | **{ [key: string]: any | null; }** | With uuid: patch the existing target before linking. Without uuid or record: create-or-update the target using its unique properties, then link. Use objectName when ambiguous. | [optional] [default to undefined]
|
|
@@ -21,6 +22,7 @@ Name | Type | Description | Notes
|
|
|
21
22
|
import { RecordRelationRequestDTO } from '@caraer/client';
|
|
22
23
|
|
|
23
24
|
const instance: RecordRelationRequestDTO = {
|
|
25
|
+
remove,
|
|
24
26
|
relationName,
|
|
25
27
|
uuid,
|
|
26
28
|
properties,
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# ResolveRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**email** | **string** | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { ResolveRequest } from '@caraer/client';
|
|
14
|
+
|
|
15
|
+
const instance: ResolveRequest = {
|
|
16
|
+
email,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[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,22 @@
|
|
|
1
|
+
# SendRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**requestId** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**scope** | **string** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { SendRequest } from '@caraer/client';
|
|
15
|
+
|
|
16
|
+
const instance: SendRequest = {
|
|
17
|
+
requestId,
|
|
18
|
+
scope,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[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/SettingField.md
CHANGED
|
@@ -14,8 +14,8 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**hidden** | **boolean** | | [optional] [default to undefined]
|
|
15
15
|
**disabled** | **boolean** | | [optional] [default to undefined]
|
|
16
16
|
**_options** | [**Array<SettingOption>**](SettingOption.md) | | [optional] [default to undefined]
|
|
17
|
-
**value** | **any** | | [optional] [default to undefined]
|
|
18
17
|
**defaultValue** | **any** | | [optional] [default to undefined]
|
|
18
|
+
**value** | **any** | | [optional] [default to undefined]
|
|
19
19
|
|
|
20
20
|
## Example
|
|
21
21
|
|
|
@@ -32,8 +32,8 @@ const instance: SettingField = {
|
|
|
32
32
|
hidden,
|
|
33
33
|
disabled,
|
|
34
34
|
_options,
|
|
35
|
-
value,
|
|
36
35
|
defaultValue,
|
|
36
|
+
value,
|
|
37
37
|
};
|
|
38
38
|
```
|
|
39
39
|
|
package/docs/{SuccessResponseListCalendarTeamOptionDTO.md → ShowResponseUserRecordResponseDTO.md}
RENAMED
|
@@ -1,20 +1,20 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ShowResponseUserRecordResponseDTO
|
|
2
2
|
|
|
3
|
-
Represents
|
|
3
|
+
Represents the response for viewing or showing a specific resource.
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
|
|
10
|
-
**data** | [**
|
|
10
|
+
**data** | [**UserRecordResponseDTO**](UserRecordResponseDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
14
14
|
```typescript
|
|
15
|
-
import {
|
|
15
|
+
import { ShowResponseUserRecordResponseDTO } from '@caraer/client';
|
|
16
16
|
|
|
17
|
-
const instance:
|
|
17
|
+
const instance: ShowResponseUserRecordResponseDTO = {
|
|
18
18
|
message,
|
|
19
19
|
data,
|
|
20
20
|
};
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
# SuccessResponseObject
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Represents a standard successful response with a message and optional data.
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**message** | **string** |
|
|
10
|
-
**data** | **
|
|
9
|
+
**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
|
|
10
|
+
**data** | **any** | The data payload of the response, if any. | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
package/docs/TraitsApi.md
CHANGED
|
@@ -268,6 +268,7 @@ let attendeeUuid: string; // (default to undefined)
|
|
|
268
268
|
let partstat: string; // (optional) (default to undefined)
|
|
269
269
|
let scope: string; // (optional) (default to undefined)
|
|
270
270
|
let switchAccount: string; // (optional) (default to undefined)
|
|
271
|
+
let token: string; // (optional) (default to undefined)
|
|
271
272
|
|
|
272
273
|
const { status, data } = await apiInstance.rsvpBrowserGet(
|
|
273
274
|
companyUuid,
|
|
@@ -275,7 +276,8 @@ const { status, data } = await apiInstance.rsvpBrowserGet(
|
|
|
275
276
|
attendeeUuid,
|
|
276
277
|
partstat,
|
|
277
278
|
scope,
|
|
278
|
-
switchAccount
|
|
279
|
+
switchAccount,
|
|
280
|
+
token
|
|
279
281
|
);
|
|
280
282
|
```
|
|
281
283
|
|
|
@@ -289,6 +291,7 @@ const { status, data } = await apiInstance.rsvpBrowserGet(
|
|
|
289
291
|
| **partstat** | [**string**] | | (optional) defaults to undefined|
|
|
290
292
|
| **scope** | [**string**] | | (optional) defaults to undefined|
|
|
291
293
|
| **switchAccount** | [**string**] | | (optional) defaults to undefined|
|
|
294
|
+
| **token** | [**string**] | | (optional) defaults to undefined|
|
|
292
295
|
|
|
293
296
|
|
|
294
297
|
### Return type
|
package/docs/ViewDTO.md
CHANGED
|
@@ -36,6 +36,7 @@ Name | Type | Description | Notes
|
|
|
36
36
|
**taskCollapsedGroupKeys** | **Array<string>** | | [optional] [default to undefined]
|
|
37
37
|
**taskExpandedTaskUuids** | **Array<string>** | | [optional] [default to undefined]
|
|
38
38
|
**calendarOverlay** | **string** | | [optional] [default to undefined]
|
|
39
|
+
**eventUserUuids** | **Array<string>** | | [optional] [default to undefined]
|
|
39
40
|
**visibleCalendarUuids** | **Array<string>** | | [optional] [default to undefined]
|
|
40
41
|
**selectedCalendarUuid** | **string** | | [optional] [default to undefined]
|
|
41
42
|
**calendarColorBy** | **string** | | [optional] [default to undefined]
|
|
@@ -80,6 +81,7 @@ const instance: ViewDTO = {
|
|
|
80
81
|
taskCollapsedGroupKeys,
|
|
81
82
|
taskExpandedTaskUuids,
|
|
82
83
|
calendarOverlay,
|
|
84
|
+
eventUserUuids,
|
|
83
85
|
visibleCalendarUuids,
|
|
84
86
|
selectedCalendarUuid,
|
|
85
87
|
calendarColorBy,
|
package/package.json
CHANGED
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
# CalendarTeamOptionDTO
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**uuid** | **string** | | [optional] [default to undefined]
|
|
9
|
-
**name** | **string** | | [optional] [default to undefined]
|
|
10
|
-
**members** | [**Array<CalendarTeamMemberDTO>**](CalendarTeamMemberDTO.md) | | [optional] [default to undefined]
|
|
11
|
-
|
|
12
|
-
## Example
|
|
13
|
-
|
|
14
|
-
```typescript
|
|
15
|
-
import { CalendarTeamOptionDTO } from '@caraer/client';
|
|
16
|
-
|
|
17
|
-
const instance: CalendarTeamOptionDTO = {
|
|
18
|
-
uuid,
|
|
19
|
-
name,
|
|
20
|
-
members,
|
|
21
|
-
};
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|