@caraer/client 2.0.486 → 2.0.487

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.
@@ -0,0 +1,28 @@
1
+ # CalendarBootstrapDTO
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **defaultCalendar** | [**CalendarRecordDTO**](CalendarRecordDTO.md) | | [optional] [default to undefined]
9
+ **calendars** | [**Array<CalendarRecordDTO>**](CalendarRecordDTO.md) | | [optional] [default to undefined]
10
+ **backfilled** | **number** | | [optional] [default to undefined]
11
+ **teamCalendarsCreated** | **number** | | [optional] [default to undefined]
12
+ **companyCalendarCreated** | **boolean** | | [optional] [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { CalendarBootstrapDTO } from '@caraer/client';
18
+
19
+ const instance: CalendarBootstrapDTO = {
20
+ defaultCalendar,
21
+ calendars,
22
+ backfilled,
23
+ teamCalendarsCreated,
24
+ companyCalendarCreated,
25
+ };
26
+ ```
27
+
28
+ [[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,26 @@
1
+ # CalendarCreateRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **title** | **string** | | [optional] [default to undefined]
9
+ **color** | **string** | | [optional] [default to undefined]
10
+ **teamUuid** | **string** | | [optional] [default to undefined]
11
+ **company** | **boolean** | | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { CalendarCreateRequest } from '@caraer/client';
17
+
18
+ const instance: CalendarCreateRequest = {
19
+ title,
20
+ color,
21
+ teamUuid,
22
+ company,
23
+ };
24
+ ```
25
+
26
+ [[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,46 @@
1
+ # CalendarRecordDTO
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **_default** | **boolean** | | [optional] [default to undefined]
9
+ **uuid** | **string** | | [optional] [default to undefined]
10
+ **title** | **string** | | [optional] [default to undefined]
11
+ **color** | **string** | | [optional] [default to undefined]
12
+ **colorHex** | **string** | | [optional] [default to undefined]
13
+ **isDefault** | **boolean** | | [optional] [default to undefined]
14
+ **ownerUuid** | **string** | | [optional] [default to undefined]
15
+ **ownerName** | **string** | | [optional] [default to undefined]
16
+ **ownedByCurrentUser** | **boolean** | | [optional] [default to undefined]
17
+ **teamUuid** | **string** | | [optional] [default to undefined]
18
+ **teamName** | **string** | | [optional] [default to undefined]
19
+ **companyCalendar** | **boolean** | | [optional] [default to undefined]
20
+ **companyName** | **string** | | [optional] [default to undefined]
21
+ **members** | [**Array<CalendarTeamMemberDTO>**](CalendarTeamMemberDTO.md) | | [optional] [default to undefined]
22
+
23
+ ## Example
24
+
25
+ ```typescript
26
+ import { CalendarRecordDTO } from '@caraer/client';
27
+
28
+ const instance: CalendarRecordDTO = {
29
+ _default,
30
+ uuid,
31
+ title,
32
+ color,
33
+ colorHex,
34
+ isDefault,
35
+ ownerUuid,
36
+ ownerName,
37
+ ownedByCurrentUser,
38
+ teamUuid,
39
+ teamName,
40
+ companyCalendar,
41
+ companyName,
42
+ members,
43
+ };
44
+ ```
45
+
46
+ [[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,26 @@
1
+ # CalendarTeamMemberDTO
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **uuid** | **string** | | [optional] [default to undefined]
9
+ **label** | **string** | | [optional] [default to undefined]
10
+ **objectName** | **string** | | [optional] [default to undefined]
11
+ **hasUserTrait** | **boolean** | | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { CalendarTeamMemberDTO } from '@caraer/client';
17
+
18
+ const instance: CalendarTeamMemberDTO = {
19
+ uuid,
20
+ label,
21
+ objectName,
22
+ hasUserTrait,
23
+ };
24
+ ```
25
+
26
+ [[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,24 @@
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)
@@ -0,0 +1,209 @@
1
+ # CalendarsApi
2
+
3
+ All URIs are relative to *https://v2.api.caraer.com*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**bootstrap**](#bootstrap) | **POST** /api/v2/calendars/bootstrap | Ensure calendar schema, default calendar, and event backfill|
8
+ |[**create3**](#create3) | **POST** /api/v2/calendars | Create a calendar owned by the current user|
9
+ |[**list1**](#list1) | **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
+
12
+ # **bootstrap**
13
+ > SuccessResponseCalendarBootstrapDTO bootstrap()
14
+
15
+
16
+ ### Example
17
+
18
+ ```typescript
19
+ import {
20
+ CalendarsApi,
21
+ Configuration
22
+ } from '@caraer/client';
23
+
24
+ const configuration = new Configuration();
25
+ const apiInstance = new CalendarsApi(configuration);
26
+
27
+ const { status, data } = await apiInstance.bootstrap();
28
+ ```
29
+
30
+ ### Parameters
31
+ This endpoint does not have any parameters.
32
+
33
+
34
+ ### Return type
35
+
36
+ **SuccessResponseCalendarBootstrapDTO**
37
+
38
+ ### Authorization
39
+
40
+ [bearerAuth](../README.md#bearerAuth)
41
+
42
+ ### HTTP request headers
43
+
44
+ - **Content-Type**: Not defined
45
+ - **Accept**: application/json
46
+
47
+
48
+ ### HTTP response details
49
+ | Status code | Description | Response headers |
50
+ |-------------|-------------|------------------|
51
+ |**200** | Calendars ready | - |
52
+ |**400** | Invalid request | - |
53
+ |**401** | Authentication is required or the token is invalid. | - |
54
+ |**403** | The caller is missing a required role or scope. | - |
55
+ |**404** | The requested resource was not found. | - |
56
+ |**500** | An internal server error occurred. | - |
57
+
58
+ [[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)
59
+
60
+ # **create3**
61
+ > CreateResponseCalendarRecordDTO create3(calendarCreateRequest)
62
+
63
+
64
+ ### Example
65
+
66
+ ```typescript
67
+ import {
68
+ CalendarsApi,
69
+ Configuration,
70
+ CalendarCreateRequest
71
+ } from '@caraer/client';
72
+
73
+ const configuration = new Configuration();
74
+ const apiInstance = new CalendarsApi(configuration);
75
+
76
+ let calendarCreateRequest: CalendarCreateRequest; //
77
+
78
+ const { status, data } = await apiInstance.create3(
79
+ calendarCreateRequest
80
+ );
81
+ ```
82
+
83
+ ### Parameters
84
+
85
+ |Name | Type | Description | Notes|
86
+ |------------- | ------------- | ------------- | -------------|
87
+ | **calendarCreateRequest** | **CalendarCreateRequest**| | |
88
+
89
+
90
+ ### Return type
91
+
92
+ **CreateResponseCalendarRecordDTO**
93
+
94
+ ### Authorization
95
+
96
+ [bearerAuth](../README.md#bearerAuth)
97
+
98
+ ### HTTP request headers
99
+
100
+ - **Content-Type**: application/json
101
+ - **Accept**: application/json
102
+
103
+
104
+ ### HTTP response details
105
+ | Status code | Description | Response headers |
106
+ |-------------|-------------|------------------|
107
+ |**200** | Calendar created | - |
108
+ |**400** | Invalid request | - |
109
+ |**401** | Authentication is required or the token is invalid. | - |
110
+ |**403** | The caller is missing a required role or scope. | - |
111
+ |**404** | The requested resource was not found. | - |
112
+ |**500** | An internal server error occurred. | - |
113
+
114
+ [[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)
115
+
116
+ # **list1**
117
+ > SuccessResponseListCalendarRecordDTO list1()
118
+
119
+
120
+ ### Example
121
+
122
+ ```typescript
123
+ import {
124
+ CalendarsApi,
125
+ Configuration
126
+ } from '@caraer/client';
127
+
128
+ const configuration = new Configuration();
129
+ const apiInstance = new CalendarsApi(configuration);
130
+
131
+ const { status, data } = await apiInstance.list1();
132
+ ```
133
+
134
+ ### Parameters
135
+ This endpoint does not have any parameters.
136
+
137
+
138
+ ### Return type
139
+
140
+ **SuccessResponseListCalendarRecordDTO**
141
+
142
+ ### Authorization
143
+
144
+ [bearerAuth](../README.md#bearerAuth)
145
+
146
+ ### HTTP request headers
147
+
148
+ - **Content-Type**: Not defined
149
+ - **Accept**: application/json
150
+
151
+
152
+ ### HTTP response details
153
+ | Status code | Description | Response headers |
154
+ |-------------|-------------|------------------|
155
+ |**200** | OK | - |
156
+ |**401** | Authentication is required or the token is invalid. | - |
157
+ |**403** | The caller is missing a required role or scope. | - |
158
+ |**404** | The requested resource was not found. | - |
159
+ |**500** | An internal server error occurred. | - |
160
+
161
+ [[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
+
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
+
@@ -0,0 +1,23 @@
1
+ # CreateResponseCalendarRecordDTO
2
+
3
+ Response for a successful resource creation operation.
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** | [**CalendarRecordDTO**](CalendarRecordDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { CreateResponseCalendarRecordDTO } from '@caraer/client';
16
+
17
+ const instance: CreateResponseCalendarRecordDTO = {
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/Record.md CHANGED
@@ -17,9 +17,9 @@ Name | Type | Description | Notes
17
17
  **deleted** | **boolean** | | [optional] [default to undefined]
18
18
  **complete** | **boolean** | | [optional] [default to undefined]
19
19
  **uuid** | **string** | | [default to undefined]
20
+ **user** | [**PublicUserDTO**](PublicUserDTO.md) | | [optional] [default to undefined]
20
21
  **properties** | [**Array<FilledProperty>**](FilledProperty.md) | | [optional] [default to undefined]
21
22
  **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
  deleted,
40
40
  complete,
41
41
  uuid,
42
+ user,
42
43
  properties,
43
44
  objects,
44
- user,
45
45
  };
46
46
  ```
47
47
 
@@ -4,7 +4,7 @@ All URIs are relative to *https://v2.api.caraer.com*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**create3**](#create3) | **POST** /api/v2/apps/{appUuid}/serverless-functions | Create a serverless function|
7
+ |[**create4**](#create4) | **POST** /api/v2/apps/{appUuid}/serverless-functions | Create a serverless function|
8
8
  |[**delete1**](#delete1) | **DELETE** /api/v2/apps/{appUuid}/serverless-functions/{uuid} | Delete a serverless function|
9
9
  |[**index2**](#index2) | **POST** /api/v2/apps/{appUuid}/serverless-functions/index | List serverless functions for an app|
10
10
  |[**logs**](#logs) | **GET** /api/v2/apps/{appUuid}/serverless-functions/{uuid}/logs | Get serverless function logs|
@@ -13,8 +13,8 @@ All URIs are relative to *https://v2.api.caraer.com*
13
13
  |[**testServerlessFunction**](#testserverlessfunction) | **POST** /api/v2/apps/{appUuid}/serverless-functions/{uuid}/test | Test a serverless function|
14
14
  |[**update1**](#update1) | **PUT** /api/v2/apps/{appUuid}/serverless-functions/{uuid} | Update a serverless function|
15
15
 
16
- # **create3**
17
- > CreateResponse create3(serverlessFunctionDTO)
16
+ # **create4**
17
+ > CreateResponse create4(serverlessFunctionDTO)
18
18
 
19
19
  Creates a new serverless function attached to the specified app.
20
20
 
@@ -33,7 +33,7 @@ const apiInstance = new ServerlessFunctionsApi(configuration);
33
33
  let appUuid: string; //UUID of the app to attach the serverless function to (default to undefined)
34
34
  let serverlessFunctionDTO: ServerlessFunctionDTO; //Serverless function payload (runtime and code)
35
35
 
36
- const { status, data } = await apiInstance.create3(
36
+ const { status, data } = await apiInstance.create4(
37
37
  appUuid,
38
38
  serverlessFunctionDTO
39
39
  );
@@ -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
 
@@ -0,0 +1,23 @@
1
+ # SuccessResponseCalendarBootstrapDTO
2
+
3
+ Represents a standard successful response with a message and optional data.
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** | [**CalendarBootstrapDTO**](CalendarBootstrapDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { SuccessResponseCalendarBootstrapDTO } from '@caraer/client';
16
+
17
+ const instance: SuccessResponseCalendarBootstrapDTO = {
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
+ # SuccessResponseListCalendarRecordDTO
2
+
3
+ Represents a standard successful response with a message and optional data.
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<CalendarRecordDTO>**](CalendarRecordDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { SuccessResponseListCalendarRecordDTO } from '@caraer/client';
16
+
17
+ const instance: SuccessResponseListCalendarRecordDTO = {
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
+ # SuccessResponseListCalendarTeamOptionDTO
2
+
3
+ Represents a standard successful response with a message and optional data.
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<CalendarTeamOptionDTO>**](CalendarTeamOptionDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { SuccessResponseListCalendarTeamOptionDTO } from '@caraer/client';
16
+
17
+ const instance: SuccessResponseListCalendarTeamOptionDTO = {
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/ViewDTO.md CHANGED
@@ -35,6 +35,10 @@ Name | Type | Description | Notes
35
35
  **taskExpandSubtasks** | **boolean** | | [optional] [default to undefined]
36
36
  **taskCollapsedGroupKeys** | **Array<string>** | | [optional] [default to undefined]
37
37
  **taskExpandedTaskUuids** | **Array<string>** | | [optional] [default to undefined]
38
+ **calendarOverlay** | **string** | | [optional] [default to undefined]
39
+ **visibleCalendarUuids** | **Array<string>** | | [optional] [default to undefined]
40
+ **selectedCalendarUuid** | **string** | | [optional] [default to undefined]
41
+ **calendarColorBy** | **string** | | [optional] [default to undefined]
38
42
  **defaultView** | **boolean** | | [optional] [default to undefined]
39
43
  **isInternallyPublic** | **boolean** | | [optional] [default to undefined]
40
44
  **analytics** | [**AnalyticsDashboardConfig**](AnalyticsDashboardConfig.md) | | [optional] [default to undefined]
@@ -75,6 +79,10 @@ const instance: ViewDTO = {
75
79
  taskExpandSubtasks,
76
80
  taskCollapsedGroupKeys,
77
81
  taskExpandedTaskUuids,
82
+ calendarOverlay,
83
+ visibleCalendarUuids,
84
+ selectedCalendarUuid,
85
+ calendarColorBy,
78
86
  defaultView,
79
87
  isInternallyPublic,
80
88
  analytics,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@caraer/client",
3
- "version": "2.0.486",
3
+ "version": "2.0.487",
4
4
  "description": "Generated TypeScript client for the Caraer API",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {