@caraer/client 2.0.703 → 2.0.706

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/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
 
@@ -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
@@ -14,8 +14,8 @@ Name | Type | Description | Notes
14
14
  **updatedByUuid** | **string** | | [optional] [default to undefined]
15
15
  **deletedByUuid** | **string** | | [optional] [default to undefined]
16
16
  **index** | **number** | | [optional] [default to undefined]
17
- **deleted** | **boolean** | | [optional] [default to undefined]
18
17
  **complete** | **boolean** | | [optional] [default to undefined]
18
+ **deleted** | **boolean** | | [optional] [default to undefined]
19
19
  **uuid** | **string** | | [default to undefined]
20
20
  **user** | [**PublicUserDTO**](PublicUserDTO.md) | | [optional] [default to undefined]
21
21
  **properties** | [**Array<FilledProperty>**](FilledProperty.md) | | [optional] [default to undefined]
@@ -36,8 +36,8 @@ const instance: ModelRecord = {
36
36
  updatedByUuid,
37
37
  deletedByUuid,
38
38
  index,
39
- deleted,
40
39
  complete,
40
+ deleted,
41
41
  uuid,
42
42
  user,
43
43
  properties,
@@ -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)
@@ -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
- **defaultValue** | **any** | | [optional] [default to undefined]
18
17
  **value** | **any** | | [optional] [default to undefined]
18
+ **defaultValue** | **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
- defaultValue,
36
35
  value,
36
+ defaultValue,
37
37
  };
38
38
  ```
39
39
 
@@ -1,20 +1,20 @@
1
- # SuccessResponseListCalendarTeamOptionDTO
1
+ # ShowResponseUserRecordResponseDTO
2
2
 
3
- Represents a standard successful response with a message and optional data.
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** | [**Array<CalendarTeamOptionDTO>**](CalendarTeamOptionDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
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 { SuccessResponseListCalendarTeamOptionDTO } from '@caraer/client';
15
+ import { ShowResponseUserRecordResponseDTO } from '@caraer/client';
16
16
 
17
- const instance: SuccessResponseListCalendarTeamOptionDTO = {
17
+ const instance: ShowResponseUserRecordResponseDTO = {
18
18
  message,
19
19
  data,
20
20
  };
@@ -1,13 +1,13 @@
1
1
  # SuccessResponseObject
2
2
 
3
- Success response (SuccessResponseObject).
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** | | [optional] [default to undefined]
10
- **data** | **{ [key: string]: any; }** | | [optional] [default to undefined]
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/Team.md CHANGED
@@ -19,8 +19,8 @@ Name | Type | Description | Notes
19
19
  **filtersString** | **string** | | [optional] [default to undefined]
20
20
  **filters** | [**{ [key: string]: Filter; }**](Filter.md) | | [optional] [default to undefined]
21
21
  **memberCount** | **number** | | [optional] [default to undefined]
22
- **deleted** | **boolean** | | [optional] [default to undefined]
23
22
  **complete** | **boolean** | | [optional] [default to undefined]
23
+ **deleted** | **boolean** | | [optional] [default to undefined]
24
24
  **uuid** | **string** | | [default to undefined]
25
25
 
26
26
  ## Example
@@ -43,8 +43,8 @@ const instance: Team = {
43
43
  filtersString,
44
44
  filters,
45
45
  memberCount,
46
- deleted,
47
46
  complete,
47
+ deleted,
48
48
  uuid,
49
49
  };
50
50
  ```
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,6 +1,6 @@
1
1
  {
2
2
  "name": "@caraer/client",
3
- "version": "2.0.703",
3
+ "version": "2.0.706",
4
4
  "description": "Generated TypeScript client for the Caraer API",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {
@@ -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)