@caraer/client 2.0.454 → 2.0.456

package/docs/AppInstallationRuntimeApi.md

@@ -19,6 +19,7 @@ All URIs are relative to *https://v2.api.caraer.com*
 |[**revokeConnection**](#revokeconnection) | **DELETE** /api/v2/apps/{appUuid}/installation/connections/{providerOrConnectionId} | Revoke external OAuth connection tokens by connection id or provider name|
 |[**saveUserSettings**](#saveusersettings) | **PUT** /api/v2/apps/{appUuid}/installation/settings/user | Save USER-scoped installation settings for the current user|
 |[**startOAuth**](#startoauth) | **POST** /api/v2/apps/{appUuid}/installation/oauth/{provider}/start | Start external OAuth authorize (returns provider authorize URL)|
+|[**triggerSettingAction**](#triggersettingaction) | **POST** /api/v2/apps/{appUuid}/installation/settings/{fieldName}/trigger | Trigger an ACTION setting without saving settings|
 
 # **deleteSecret**
 > DeleteResponseVoid deleteSecret()
@@ -875,3 +876,61 @@ const { status, data } = await apiInstance.startOAuth(
 
 [[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)
 
+# **triggerSettingAction**
+> ShowResponseMapStringObject triggerSettingAction()
+
+
+### Example
+
+```typescript
+import {
+    AppInstallationRuntimeApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new AppInstallationRuntimeApi(configuration);
+
+let appUuid: string; // (default to undefined)
+let fieldName: string; // (default to undefined)
+
+const { status, data } = await apiInstance.triggerSettingAction(
+    appUuid,
+    fieldName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **appUuid** | [**string**] |  | defaults to undefined|
+| **fieldName** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ShowResponseMapStringObject**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**202** | Action started |  -  |
+|**400** | Bad Request |  -  |
+|**404** | Not Found |  -  |
+|**401** | Authentication is required or the token is invalid. |  -  |
+|**403** | The caller is missing a required role or scope. |  -  |
+|**500** | An internal server error occurred. |  -  |
+
+[[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/AppSettingActionSource.md

@@ -0,0 +1,26 @@
+# AppSettingActionSource
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** |  | [optional] [default to undefined]
+**serverlessFunctionUuid** | **string** |  | [optional] [default to undefined]
+**serverlessFunctionName** | **string** |  | [optional] [default to undefined]
+**enqueue** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AppSettingActionSource } from '@caraer/client';
+
+const instance: AppSettingActionSource = {
+    type,
+    serverlessFunctionUuid,
+    serverlessFunctionName,
+    enqueue,
+};
+```
+
+[[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/AppSettingFieldSchema.md

@@ -12,6 +12,7 @@ Name | Type | Description | Notes
 **helpText** | **string** |  | [optional] [default to undefined]
 **_options** | [**Array<SettingOption>**](SettingOption.md) |  | [optional] [default to undefined]
 **optionsSource** | [**AppSettingOptionsSource**](AppSettingOptionsSource.md) |  | [optional] [default to undefined]
+**actionSource** | [**AppSettingActionSource**](AppSettingActionSource.md) |  | [optional] [default to undefined]
 **defaultValue** | **any** |  | [optional] [default to undefined]
 **hidden** | **boolean** |  | [optional] [default to undefined]
 **visibleWhen** | [**Array<AppSettingCondition>**](AppSettingCondition.md) |  | [optional] [default to undefined]
@@ -19,6 +20,7 @@ Name | Type | Description | Notes
 **hasValue** | **boolean** |  | [optional] [default to undefined]
 **mappingValue** | [**AppSettingFieldMappingStructure**](AppSettingFieldMappingStructure.md) |  | [optional] [default to undefined]
 **valueScope** | **string** |  | [optional] [default to undefined]
+**action** | **boolean** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -33,6 +35,7 @@ const instance: AppSettingFieldSchema = {
     helpText,
     _options,
     optionsSource,
+    actionSource,
     defaultValue,
     hidden,
     visibleWhen,
@@ -40,6 +43,7 @@ const instance: AppSettingFieldSchema = {
     hasValue,
     mappingValue,
     valueScope,
+    action,
 };
 ```
 

package/docs/Item.md

@@ -0,0 +1,48 @@
+# Item
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**title** | **string** |  | [optional] [default to undefined]
+**body** | **string** |  | [optional] [default to undefined]
+**type** | **string** |  | [optional] [default to undefined]
+**icon** | **string** |  | [optional] [default to undefined]
+**actionTitle** | **string** |  | [optional] [default to undefined]
+**action** | **string** |  | [optional] [default to undefined]
+**data** | **{ [key: string]: any | null; }** |  | [optional] [default to undefined]
+**sender** | **string** |  | [optional] [default to undefined]
+**company** | **string** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+**updatedAt** | **string** |  | [optional] [default to undefined]
+**readAt** | **string** |  | [optional] [default to undefined]
+**sourceAppUuid** | **string** |  | [optional] [default to undefined]
+**appLogo** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Item } from '@caraer/client';
+
+const instance: Item = {
+    id,
+    title,
+    body,
+    type,
+    icon,
+    actionTitle,
+    action,
+    data,
+    sender,
+    company,
+    createdAt,
+    updatedAt,
+    readAt,
+    sourceAppUuid,
+    appLogo,
+};
+```
+
+[[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/NotificationInboxDTO.md

@@ -0,0 +1,22 @@
+# NotificationInboxDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**notifications** | [**Array<Item>**](Item.md) |  | [optional] [default to undefined]
+**unreadCount** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { NotificationInboxDTO } from '@caraer/client';
+
+const instance: NotificationInboxDTO = {
+    notifications,
+    unreadCount,
+};
+```
+
+[[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

@@ -5,6 +5,7 @@ All URIs are relative to *https://v2.api.caraer.com*
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**dismissNotification**](#dismissnotification) | **DELETE** /api/v2/notifications/{notificationId} | Dismiss a notification|
+|[**listNotifications**](#listnotifications) | **GET** /api/v2/notifications | List in-app notifications for the logged-in user|
 |[**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)|
@@ -63,6 +64,63 @@ const { status, data } = await apiInstance.dismissNotification(
 
 [[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)
 
+# **listNotifications**
+> ShowResponseNotificationInboxDTO listNotifications()
+
+
+### Example
+
+```typescript
+import {
+    NotificationsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new NotificationsApi(configuration);
+
+let company: string; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listNotifications(
+    company,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **company** | [**string**] |  | (optional) defaults to undefined|
+| **limit** | [**number**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**ShowResponseNotificationInboxDTO**
+
+### 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 |  -  |
+|**401** | Authentication is required or the token is invalid. |  -  |
+|**403** | The caller is missing a required role or scope. |  -  |
+|**404** | The requested resource was not found. |  -  |
+|**500** | An internal server error occurred. |  -  |
+
+[[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()
 

package/docs/SettingField.md

@@ -14,8 +14,8 @@ Name | Type | Description | Notes
 **hidden** | **boolean** |  | [optional] [default to undefined]
 **disabled** | **boolean** |  | [optional] [default to undefined]
 **_options** | [**Array<SettingOption>**](SettingOption.md) |  | [optional] [default to undefined]
-**defaultValue** | **any** |  | [optional] [default to undefined]
 **value** | **any** |  | [optional] [default to undefined]
+**defaultValue** | **any** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -32,8 +32,8 @@ const instance: SettingField = {
     hidden,
     disabled,
     _options,
-    defaultValue,
     value,
+    defaultValue,
 };
 ```
 

package/docs/ShowResponseNotificationInboxDTO.md

@@ -0,0 +1,23 @@
+# ShowResponseNotificationInboxDTO
+
+Represents the response for viewing or showing a specific resource.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
+**data** | [**NotificationInboxDTO**](NotificationInboxDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ShowResponseNotificationInboxDTO } from '@caraer/client';
+
+const instance: ShowResponseNotificationInboxDTO = {
+    message,
+    data,
+};
+```
+
+[[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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caraer/client",
-  "version": "2.0.454",
+  "version": "2.0.456",
   "description": "Generated TypeScript client for the Caraer API",
   "author": "OpenAPI-Generator Contributors",
   "repository": {