@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,23 @@
|
|
|
1
|
+
# SuccessResponseListAppExternalOAuthProviderDTO
|
|
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<AppExternalOAuthProviderDTO>**](AppExternalOAuthProviderDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { SuccessResponseListAppExternalOAuthProviderDTO } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: SuccessResponseListAppExternalOAuthProviderDTO = {
|
|
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
|
+
# SuccessResponseListAppInboundRouteDTO
|
|
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<AppInboundRouteDTO>**](AppInboundRouteDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { SuccessResponseListAppInboundRouteDTO } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: SuccessResponseListAppInboundRouteDTO = {
|
|
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
|
+
# SuccessResponseListAppScheduleDTO
|
|
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<AppScheduleDTO>**](AppScheduleDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { SuccessResponseListAppScheduleDTO } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: SuccessResponseListAppScheduleDTO = {
|
|
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,24 @@
|
|
|
1
|
+
# SuggestAnalyticsWidgetsRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**objectName** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**goal** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**existingWidgets** | [**Array<ExistingWidgetSummary>**](ExistingWidgetSummary.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { SuggestAnalyticsWidgetsRequest } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: SuggestAnalyticsWidgetsRequest = {
|
|
18
|
+
objectName,
|
|
19
|
+
goal,
|
|
20
|
+
existingWidgets,
|
|
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/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
|
@@ -8,6 +8,10 @@ All URIs are relative to *https://v2.api.caraer.com*
|
|
|
8
8
|
|[**deleteTrait**](#deletetrait) | **DELETE** /api/v2/traits/{objectUuid}/{traitName} | Delete a trait from an object|
|
|
9
9
|
|[**getTrait**](#gettrait) | **GET** /api/v2/traits/{objectUuid}/{traitName} | Fetch a specific trait for an object|
|
|
10
10
|
|[**getTraits**](#gettraits) | **GET** /api/v2/traits/{objectUuid} | Fetch all traits for an object|
|
|
11
|
+
|[**rsvpBrowserGet**](#rsvpbrowserget) | **GET** /api/v2/traits/event/{companyUuid}/{eventUuid}/rsvp/{attendeeUuid} | Respond to an event invitation (email link)|
|
|
12
|
+
|[**rsvpBrowserLogin**](#rsvpbrowserlogin) | **POST** /api/v2/traits/event/{companyUuid}/{eventUuid}/rsvp/{attendeeUuid}/login | Email/password login for RSVP|
|
|
13
|
+
|[**rsvpBrowserSocial**](#rsvpbrowsersocial) | **GET** /api/v2/traits/event/{companyUuid}/{eventUuid}/rsvp/{attendeeUuid}/social/{provider} | Start social login for RSVP|
|
|
14
|
+
|[**rsvpJson**](#rsvpjson) | **POST** /api/v2/traits/event/{companyUuid}/{eventUuid}/rsvp/{attendeeUuid} | Update event RSVP (JSON)|
|
|
11
15
|
|
|
12
16
|
# **createTrait**
|
|
13
17
|
> CreateResponse createTrait(body)
|
|
@@ -234,3 +238,271 @@ const { status, data } = await apiInstance.getTraits(
|
|
|
234
238
|
|
|
235
239
|
[[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)
|
|
236
240
|
|
|
241
|
+
# **rsvpBrowserGet**
|
|
242
|
+
> rsvpBrowserGet()
|
|
243
|
+
|
|
244
|
+
Public browser RSVP. Without partstat shows a choice page; with partstat applies after login when the attendee has a user trait. Non-user-trait attendees need no login.
|
|
245
|
+
|
|
246
|
+
### Example
|
|
247
|
+
|
|
248
|
+
```typescript
|
|
249
|
+
import {
|
|
250
|
+
TraitsApi,
|
|
251
|
+
Configuration
|
|
252
|
+
} from '@caraer/client';
|
|
253
|
+
|
|
254
|
+
const configuration = new Configuration();
|
|
255
|
+
const apiInstance = new TraitsApi(configuration);
|
|
256
|
+
|
|
257
|
+
let companyUuid: string; // (default to undefined)
|
|
258
|
+
let eventUuid: string; // (default to undefined)
|
|
259
|
+
let attendeeUuid: string; // (default to undefined)
|
|
260
|
+
let partstat: string; // (optional) (default to undefined)
|
|
261
|
+
let scope: string; // (optional) (default to undefined)
|
|
262
|
+
let switchAccount: string; // (optional) (default to undefined)
|
|
263
|
+
|
|
264
|
+
const { status, data } = await apiInstance.rsvpBrowserGet(
|
|
265
|
+
companyUuid,
|
|
266
|
+
eventUuid,
|
|
267
|
+
attendeeUuid,
|
|
268
|
+
partstat,
|
|
269
|
+
scope,
|
|
270
|
+
switchAccount
|
|
271
|
+
);
|
|
272
|
+
```
|
|
273
|
+
|
|
274
|
+
### Parameters
|
|
275
|
+
|
|
276
|
+
|Name | Type | Description | Notes|
|
|
277
|
+
|------------- | ------------- | ------------- | -------------|
|
|
278
|
+
| **companyUuid** | [**string**] | | defaults to undefined|
|
|
279
|
+
| **eventUuid** | [**string**] | | defaults to undefined|
|
|
280
|
+
| **attendeeUuid** | [**string**] | | defaults to undefined|
|
|
281
|
+
| **partstat** | [**string**] | | (optional) defaults to undefined|
|
|
282
|
+
| **scope** | [**string**] | | (optional) defaults to undefined|
|
|
283
|
+
| **switchAccount** | [**string**] | | (optional) defaults to undefined|
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
### Return type
|
|
287
|
+
|
|
288
|
+
void (empty response body)
|
|
289
|
+
|
|
290
|
+
### Authorization
|
|
291
|
+
|
|
292
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
293
|
+
|
|
294
|
+
### HTTP request headers
|
|
295
|
+
|
|
296
|
+
- **Content-Type**: Not defined
|
|
297
|
+
- **Accept**: text/html
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
### HTTP response details
|
|
301
|
+
| Status code | Description | Response headers |
|
|
302
|
+
|-------------|-------------|------------------|
|
|
303
|
+
|**200** | HTML choice, login, success, or error page | - |
|
|
304
|
+
|**400** | Invalid partstat or scope | - |
|
|
305
|
+
|**401** | Login required for JSON clients | - |
|
|
306
|
+
|**403** | Not the invited attendee | - |
|
|
307
|
+
|**404** | Event, attendee, or invitation not found | - |
|
|
308
|
+
|
|
309
|
+
[[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)
|
|
310
|
+
|
|
311
|
+
# **rsvpBrowserLogin**
|
|
312
|
+
> rsvpBrowserLogin()
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
### Example
|
|
316
|
+
|
|
317
|
+
```typescript
|
|
318
|
+
import {
|
|
319
|
+
TraitsApi,
|
|
320
|
+
Configuration
|
|
321
|
+
} from '@caraer/client';
|
|
322
|
+
|
|
323
|
+
const configuration = new Configuration();
|
|
324
|
+
const apiInstance = new TraitsApi(configuration);
|
|
325
|
+
|
|
326
|
+
let companyUuid: string; // (default to undefined)
|
|
327
|
+
let eventUuid: string; // (default to undefined)
|
|
328
|
+
let attendeeUuid: string; // (default to undefined)
|
|
329
|
+
let email: string; // (default to undefined)
|
|
330
|
+
let password: string; // (default to undefined)
|
|
331
|
+
let partstat: string; // (optional) (default to undefined)
|
|
332
|
+
let scope: string; // (optional) (default to undefined)
|
|
333
|
+
|
|
334
|
+
const { status, data } = await apiInstance.rsvpBrowserLogin(
|
|
335
|
+
companyUuid,
|
|
336
|
+
eventUuid,
|
|
337
|
+
attendeeUuid,
|
|
338
|
+
email,
|
|
339
|
+
password,
|
|
340
|
+
partstat,
|
|
341
|
+
scope
|
|
342
|
+
);
|
|
343
|
+
```
|
|
344
|
+
|
|
345
|
+
### Parameters
|
|
346
|
+
|
|
347
|
+
|Name | Type | Description | Notes|
|
|
348
|
+
|------------- | ------------- | ------------- | -------------|
|
|
349
|
+
| **companyUuid** | [**string**] | | defaults to undefined|
|
|
350
|
+
| **eventUuid** | [**string**] | | defaults to undefined|
|
|
351
|
+
| **attendeeUuid** | [**string**] | | defaults to undefined|
|
|
352
|
+
| **email** | [**string**] | | defaults to undefined|
|
|
353
|
+
| **password** | [**string**] | | defaults to undefined|
|
|
354
|
+
| **partstat** | [**string**] | | (optional) defaults to undefined|
|
|
355
|
+
| **scope** | [**string**] | | (optional) defaults to undefined|
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
### Return type
|
|
359
|
+
|
|
360
|
+
void (empty response body)
|
|
361
|
+
|
|
362
|
+
### Authorization
|
|
363
|
+
|
|
364
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
365
|
+
|
|
366
|
+
### HTTP request headers
|
|
367
|
+
|
|
368
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
|
369
|
+
- **Accept**: Not defined
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
### HTTP response details
|
|
373
|
+
| Status code | Description | Response headers |
|
|
374
|
+
|-------------|-------------|------------------|
|
|
375
|
+
|**200** | OK | - |
|
|
376
|
+
|
|
377
|
+
[[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)
|
|
378
|
+
|
|
379
|
+
# **rsvpBrowserSocial**
|
|
380
|
+
> rsvpBrowserSocial()
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
### Example
|
|
384
|
+
|
|
385
|
+
```typescript
|
|
386
|
+
import {
|
|
387
|
+
TraitsApi,
|
|
388
|
+
Configuration
|
|
389
|
+
} from '@caraer/client';
|
|
390
|
+
|
|
391
|
+
const configuration = new Configuration();
|
|
392
|
+
const apiInstance = new TraitsApi(configuration);
|
|
393
|
+
|
|
394
|
+
let companyUuid: string; // (default to undefined)
|
|
395
|
+
let eventUuid: string; // (default to undefined)
|
|
396
|
+
let attendeeUuid: string; // (default to undefined)
|
|
397
|
+
let provider: string; // (default to undefined)
|
|
398
|
+
let partstat: string; // (optional) (default to undefined)
|
|
399
|
+
let scope: string; // (optional) (default to undefined)
|
|
400
|
+
|
|
401
|
+
const { status, data } = await apiInstance.rsvpBrowserSocial(
|
|
402
|
+
companyUuid,
|
|
403
|
+
eventUuid,
|
|
404
|
+
attendeeUuid,
|
|
405
|
+
provider,
|
|
406
|
+
partstat,
|
|
407
|
+
scope
|
|
408
|
+
);
|
|
409
|
+
```
|
|
410
|
+
|
|
411
|
+
### Parameters
|
|
412
|
+
|
|
413
|
+
|Name | Type | Description | Notes|
|
|
414
|
+
|------------- | ------------- | ------------- | -------------|
|
|
415
|
+
| **companyUuid** | [**string**] | | defaults to undefined|
|
|
416
|
+
| **eventUuid** | [**string**] | | defaults to undefined|
|
|
417
|
+
| **attendeeUuid** | [**string**] | | defaults to undefined|
|
|
418
|
+
| **provider** | [**string**] | | defaults to undefined|
|
|
419
|
+
| **partstat** | [**string**] | | (optional) defaults to undefined|
|
|
420
|
+
| **scope** | [**string**] | | (optional) defaults to undefined|
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
### Return type
|
|
424
|
+
|
|
425
|
+
void (empty response body)
|
|
426
|
+
|
|
427
|
+
### Authorization
|
|
428
|
+
|
|
429
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
430
|
+
|
|
431
|
+
### HTTP request headers
|
|
432
|
+
|
|
433
|
+
- **Content-Type**: Not defined
|
|
434
|
+
- **Accept**: Not defined
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
### HTTP response details
|
|
438
|
+
| Status code | Description | Response headers |
|
|
439
|
+
|-------------|-------------|------------------|
|
|
440
|
+
|**200** | OK | - |
|
|
441
|
+
|
|
442
|
+
[[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)
|
|
443
|
+
|
|
444
|
+
# **rsvpJson**
|
|
445
|
+
> UpdateResponse rsvpJson(eventRsvpRequest)
|
|
446
|
+
|
|
447
|
+
Patches partstat on the attendees edge. No tools @AccessControl — auth is bearer/session + self-only / partner login rules.
|
|
448
|
+
|
|
449
|
+
### Example
|
|
450
|
+
|
|
451
|
+
```typescript
|
|
452
|
+
import {
|
|
453
|
+
TraitsApi,
|
|
454
|
+
Configuration,
|
|
455
|
+
EventRsvpRequest
|
|
456
|
+
} from '@caraer/client';
|
|
457
|
+
|
|
458
|
+
const configuration = new Configuration();
|
|
459
|
+
const apiInstance = new TraitsApi(configuration);
|
|
460
|
+
|
|
461
|
+
let companyUuid: string; // (default to undefined)
|
|
462
|
+
let eventUuid: string; // (default to undefined)
|
|
463
|
+
let attendeeUuid: string; // (default to undefined)
|
|
464
|
+
let eventRsvpRequest: EventRsvpRequest; //RSVP payload
|
|
465
|
+
|
|
466
|
+
const { status, data } = await apiInstance.rsvpJson(
|
|
467
|
+
companyUuid,
|
|
468
|
+
eventUuid,
|
|
469
|
+
attendeeUuid,
|
|
470
|
+
eventRsvpRequest
|
|
471
|
+
);
|
|
472
|
+
```
|
|
473
|
+
|
|
474
|
+
### Parameters
|
|
475
|
+
|
|
476
|
+
|Name | Type | Description | Notes|
|
|
477
|
+
|------------- | ------------- | ------------- | -------------|
|
|
478
|
+
| **eventRsvpRequest** | **EventRsvpRequest**| RSVP payload | |
|
|
479
|
+
| **companyUuid** | [**string**] | | defaults to undefined|
|
|
480
|
+
| **eventUuid** | [**string**] | | defaults to undefined|
|
|
481
|
+
| **attendeeUuid** | [**string**] | | defaults to undefined|
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
### Return type
|
|
485
|
+
|
|
486
|
+
**UpdateResponse**
|
|
487
|
+
|
|
488
|
+
### Authorization
|
|
489
|
+
|
|
490
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
491
|
+
|
|
492
|
+
### HTTP request headers
|
|
493
|
+
|
|
494
|
+
- **Content-Type**: application/json
|
|
495
|
+
- **Accept**: application/json
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
### HTTP response details
|
|
499
|
+
| Status code | Description | Response headers |
|
|
500
|
+
|-------------|-------------|------------------|
|
|
501
|
+
|**200** | RSVP updated | - |
|
|
502
|
+
|**400** | Invalid partstat or scope | - |
|
|
503
|
+
|**401** | Login required | - |
|
|
504
|
+
|**403** | Not the invited attendee | - |
|
|
505
|
+
|**404** | Event, attendee, or invitation not found | - |
|
|
506
|
+
|
|
507
|
+
[[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)
|
|
508
|
+
|
|
@@ -18,7 +18,7 @@ Name | Type | Description | Notes
|
|
|
18
18
|
**index** | **number** | Index number for ordering entities | [optional] [default to undefined]
|
|
19
19
|
**deleted** | **boolean** | Whether the record is soft-deleted. | [optional] [default to undefined]
|
|
20
20
|
**properties** | [**Array<FilledProperty>**](FilledProperty.md) | Record properties for display. | [optional] [default to undefined]
|
|
21
|
-
**objects** | **{ [key: string]: any | null; }** | Primary and
|
|
21
|
+
**objects** | **{ [key: string]: any | null; }** | Primary and extended object metadata for this record. | [optional] [default to undefined]
|
|
22
22
|
**user** | [**PublicUserDTO**](PublicUserDTO.md) | The user linked to this record when the user trait is enabled. | [optional] [default to undefined]
|
|
23
23
|
|
|
24
24
|
## Example
|
package/docs/ViewDTO.md
CHANGED
|
@@ -30,8 +30,14 @@ Name | Type | Description | Notes
|
|
|
30
30
|
**icon** | **string** | | [optional] [default to undefined]
|
|
31
31
|
**flowProperty** | **string** | | [optional] [default to undefined]
|
|
32
32
|
**flowPreview** | **string** | | [optional] [default to undefined]
|
|
33
|
+
**taskProgressProperty** | **string** | | [optional] [default to undefined]
|
|
34
|
+
**taskGroupProperty** | **string** | | [optional] [default to undefined]
|
|
35
|
+
**taskExpandSubtasks** | **boolean** | | [optional] [default to undefined]
|
|
36
|
+
**taskCollapsedGroupKeys** | **Array<string>** | | [optional] [default to undefined]
|
|
37
|
+
**taskExpandedTaskUuids** | **Array<string>** | | [optional] [default to undefined]
|
|
33
38
|
**defaultView** | **boolean** | | [optional] [default to undefined]
|
|
34
39
|
**isInternallyPublic** | **boolean** | | [optional] [default to undefined]
|
|
40
|
+
**analytics** | [**AnalyticsDashboardConfig**](AnalyticsDashboardConfig.md) | | [optional] [default to undefined]
|
|
35
41
|
|
|
36
42
|
## Example
|
|
37
43
|
|
|
@@ -64,8 +70,14 @@ const instance: ViewDTO = {
|
|
|
64
70
|
icon,
|
|
65
71
|
flowProperty,
|
|
66
72
|
flowPreview,
|
|
73
|
+
taskProgressProperty,
|
|
74
|
+
taskGroupProperty,
|
|
75
|
+
taskExpandSubtasks,
|
|
76
|
+
taskCollapsedGroupKeys,
|
|
77
|
+
taskExpandedTaskUuids,
|
|
67
78
|
defaultView,
|
|
68
79
|
isInternallyPublic,
|
|
80
|
+
analytics,
|
|
69
81
|
};
|
|
70
82
|
```
|
|
71
83
|
|
package/index.ts
CHANGED