@caraer/client 2.0.347

package/docs/NotFoundErrorCauseStackTraceInner.md

@@ -0,0 +1,34 @@
+# NotFoundErrorCauseStackTraceInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**classLoaderName** | **string** |  | [optional] [default to undefined]
+**moduleName** | **string** |  | [optional] [default to undefined]
+**moduleVersion** | **string** |  | [optional] [default to undefined]
+**methodName** | **string** |  | [optional] [default to undefined]
+**fileName** | **string** |  | [optional] [default to undefined]
+**lineNumber** | **number** |  | [optional] [default to undefined]
+**className** | **string** |  | [optional] [default to undefined]
+**nativeMethod** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { NotFoundErrorCauseStackTraceInner } from '@caraer/client';
+
+const instance: NotFoundErrorCauseStackTraceInner = {
+    classLoaderName,
+    moduleName,
+    moduleVersion,
+    methodName,
+    fileName,
+    lineNumber,
+    className,
+    nativeMethod,
+};
+```
+
+[[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/NotificationsApi.md

@@ -0,0 +1,211 @@
+# NotificationsApi
+
+All URIs are relative to *https://v2.api.caraer.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**dismissNotification**](#dismissnotification) | **DELETE** /api/v2/notifications/{notificationId} | Dismiss a notification|
+|[**markAllAsRead**](#markallasread) | **PATCH** /api/v2/notifications/read-all | Mark all notifications as read for the current company|
+|[**markAsRead**](#markasread) | **PATCH** /api/v2/notifications/{notificationId}/read | Mark a notification as read|
+|[**sendNotification**](#sendnotification) | **POST** /api/v2/notifications | Send a notification (app token)|
+
+# **dismissNotification**
+> DeleteResponseString dismissNotification()
+
+
+### Example
+
+```typescript
+import {
+    NotificationsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new NotificationsApi(configuration);
+
+let notificationId: string; //Firestore notification document ID (default to undefined)
+
+const { status, data } = await apiInstance.dismissNotification(
+    notificationId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **notificationId** | [**string**] | Firestore notification document ID | defaults to undefined|
+
+
+### Return type
+
+**DeleteResponseString**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Notification dismissed |  -  |
+|**404** | Notification not found |  -  |
+
+[[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)
+
+# **markAllAsRead**
+> SuccessResponseString markAllAsRead()
+
+
+### Example
+
+```typescript
+import {
+    NotificationsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new NotificationsApi(configuration);
+
+const { status, data } = await apiInstance.markAllAsRead();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**SuccessResponseString**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[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)
+
+# **markAsRead**
+> SuccessResponseString markAsRead()
+
+
+### Example
+
+```typescript
+import {
+    NotificationsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new NotificationsApi(configuration);
+
+let notificationId: string; //Firestore notification document ID (default to undefined)
+
+const { status, data } = await apiInstance.markAsRead(
+    notificationId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **notificationId** | [**string**] | Firestore notification document ID | defaults to undefined|
+
+
+### Return type
+
+**SuccessResponseString**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Notification marked as read |  -  |
+|**404** | Notification not found |  -  |
+
+[[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)
+
+# **sendNotification**
+> sendNotification(sendNotificationRequest)
+
+Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). The target user must belong to the app\'s company.
+
+### Example
+
+```typescript
+import {
+    NotificationsApi,
+    Configuration,
+    SendNotificationRequest
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new NotificationsApi(configuration);
+
+let sendNotificationRequest: SendNotificationRequest; //
+
+const { status, data } = await apiInstance.sendNotification(
+    sendNotificationRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **sendNotificationRequest** | **SendNotificationRequest**|  | |
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Notification created |  -  |
+|**400** | Invalid request |  -  |
+|**403** | Forbidden |  -  |
+|**429** | Rate limited |  -  |
+
+[[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)
+

package/docs/Number.md

@@ -0,0 +1,18 @@
+# Number
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Example
+
+```typescript
+import { Number } from '@caraer/client';
+
+const instance: Number = {
+};
+```
+
+[[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/NumberRange.md

@@ -0,0 +1,18 @@
+# NumberRange
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Example
+
+```typescript
+import { NumberRange } from '@caraer/client';
+
+const instance: NumberRange = {
+};
+```
+
+[[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/ObjectAccessGrantCandidatesDTO.md

@@ -0,0 +1,25 @@
+# ObjectAccessGrantCandidatesDTO
+
+Users, teams, and installed apps available for object access grants.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**users** | [**Array<AccessGrantTargetDTO>**](AccessGrantTargetDTO.md) | Company users with HAS_ACCESS_TO | [optional] [default to undefined]
+**teams** | [**Array<AccessGrantTargetDTO>**](AccessGrantTargetDTO.md) | Teams in the tenant | [optional] [default to undefined]
+**apps** | [**Array<AccessGrantTargetDTO>**](AccessGrantTargetDTO.md) | Apps installed for the current company | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ObjectAccessGrantCandidatesDTO } from '@caraer/client';
+
+const instance: ObjectAccessGrantCandidatesDTO = {
+    users,
+    teams,
+    apps,
+};
+```
+
+[[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/ObjectAccessGrantRequestDTO.md

@@ -0,0 +1,25 @@
+# ObjectAccessGrantRequestDTO
+
+Request to grant record-level access on an object to users, teams, and apps.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**users** | [**ObjectAccessGrantSectionDTO**](ObjectAccessGrantSectionDTO.md) | User grants | [optional] [default to undefined]
+**teams** | [**ObjectAccessGrantSectionDTO**](ObjectAccessGrantSectionDTO.md) | Team grants | [optional] [default to undefined]
+**apps** | [**ObjectAccessGrantSectionDTO**](ObjectAccessGrantSectionDTO.md) | Installed app grants | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ObjectAccessGrantRequestDTO } from '@caraer/client';
+
+const instance: ObjectAccessGrantRequestDTO = {
+    users,
+    teams,
+    apps,
+};
+```
+
+[[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/ObjectAccessGrantSectionDTO.md

@@ -0,0 +1,25 @@
+# ObjectAccessGrantSectionDTO
+
+Access grant selection for one principal type (users, teams, or apps).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuids** | **Array<string>** | UUIDs to grant access to | [optional] [default to undefined]
+**globalScopes** | **Array<string>** | Record scopes applied to every selected UUID | [optional] [default to undefined]
+**overrides** | **{ [key: string]: Array<string>; }** | Per-UUID scope overrides merged with globalScopes | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ObjectAccessGrantSectionDTO } from '@caraer/client';
+
+const instance: ObjectAccessGrantSectionDTO = {
+    uuids,
+    globalScopes,
+    overrides,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)