@caraer/client 2.0.696 → 2.0.701

package/docs/NavigationApi.md

@@ -0,0 +1,280 @@
+# NavigationApi
+
+All URIs are relative to *https://v2.api.caraer.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**favorites**](#favorites) | **GET** /api/v2/navigation/favorites | Read authorized favorite views|
+|[**navigation**](#navigation) | **GET** /api/v2/navigation | Read authorized navigation|
+|[**preferences**](#preferences) | **PUT** /api/v2/navigation/objects/{objectUuid}/view-preferences | Set personal view navigation preferences|
+|[**scopes**](#scopes) | **GET** /api/v2/access/scopes | Read available access scopes|
+|[**views**](#views) | **GET** /api/v2/navigation/objects/{objectUuid}/views | Read authorized view navigation summaries|
+
+# **favorites**
+> SuccessResponseListFavoriteViewDTO favorites()
+
+Selected-company favorites across objects. Archived readable favorites require includeArchived=true. Each result carries only object identity/capability names and view navigation metadata.
+
+### Example
+
+```typescript
+import {
+    NavigationApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new NavigationApi(configuration);
+
+let includeArchived: boolean; // (optional) (default to false)
+
+const { status, data } = await apiInstance.favorites(
+    includeArchived
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **includeArchived** | [**boolean**] |  | (optional) defaults to false|
+
+
+### Return type
+
+**SuccessResponseListFavoriteViewDTO**
+
+### 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)
+
+# **navigation**
+> SuccessResponseNavigationDTO navigation()
+
+Selected-company object and view summaries with permission-gated menus. Does not load schemas, users, scopes, branding or dashboards.
+
+### Example
+
+```typescript
+import {
+    NavigationApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new NavigationApi(configuration);
+
+const { status, data } = await apiInstance.navigation();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**SuccessResponseNavigationDTO**
+
+### 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)
+
+# **preferences**
+> SuccessResponseListNavigationViewDTO preferences(viewNavigationPreferencesRequest)
+
+Atomic user/company-scoped index and favorite overrides for readable views of this object. Omission preserves; null clears to the legacy default. Does not create sharing edges or change authorization. Requires an actual selected-company user record.
+
+### Example
+
+```typescript
+import {
+    NavigationApi,
+    Configuration,
+    ViewNavigationPreferencesRequest
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new NavigationApi(configuration);
+
+let objectUuid: string; // (default to undefined)
+let viewNavigationPreferencesRequest: ViewNavigationPreferencesRequest; //
+
+const { status, data } = await apiInstance.preferences(
+    objectUuid,
+    viewNavigationPreferencesRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **viewNavigationPreferencesRequest** | **ViewNavigationPreferencesRequest**|  | |
+| **objectUuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**SuccessResponseListNavigationViewDTO**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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)
+
+# **scopes**
+> SuccessResponseListString scopes()
+
+Scope catalog for managing selected-company user and team permissions. Requires user-management read or app-management write access. App-only callers discover record scopes only for readable objects. This is not a list of the caller\'s granted scopes.
+
+### Example
+
+```typescript
+import {
+    NavigationApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new NavigationApi(configuration);
+
+const { status, data } = await apiInstance.scopes();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**SuccessResponseListString**
+
+### 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)
+
+# **views**
+> SuccessResponseListNavigationViewDTO views()
+
+Intent-loaded selected-company metadata. Archived readable views are included only with includeArchived=true; no filters, schemas or sharing grants are returned.
+
+### Example
+
+```typescript
+import {
+    NavigationApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new NavigationApi(configuration);
+
+let objectUuid: string; // (default to undefined)
+let includeArchived: boolean; // (optional) (default to false)
+
+const { status, data } = await apiInstance.views(
+    objectUuid,
+    includeArchived
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **objectUuid** | [**string**] |  | defaults to undefined|
+| **includeArchived** | [**boolean**] |  | (optional) defaults to false|
+
+
+### Return type
+
+**SuccessResponseListNavigationViewDTO**
+
+### 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)
+

package/docs/NavigationDTO.md

@@ -0,0 +1,27 @@
+# NavigationDTO
+
+Authorized application navigation for the currently selected company. Contains no record schema or user configuration.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**objects** | [**Array<NavigationObjectDTO>**](NavigationObjectDTO.md) |  | [optional] [default to undefined]
+**suites** | **Array<string>** |  | [optional] [default to undefined]
+**tools** | [**WebMenuDTO**](WebMenuDTO.md) |  | [optional] [default to undefined]
+**settings** | [**WebMenuDTO**](WebMenuDTO.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { NavigationDTO } from '@caraer/client';
+
+const instance: NavigationDTO = {
+    objects,
+    suites,
+    tools,
+    settings,
+};
+```
+
+[[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/NavigationObjectDTO.md

@@ -0,0 +1,38 @@
+# NavigationObjectDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**label** | **string** |  | [optional] [default to undefined]
+**plural** | **string** |  | [optional] [default to undefined]
+**icon** | **string** |  | [optional] [default to undefined]
+**defaultTrait** | **string** |  | [optional] [default to undefined]
+**index** | **number** |  | [optional] [default to undefined]
+**suites** | **Array<string>** |  | [optional] [default to undefined]
+**views** | [**Array<NavigationViewDTO>**](NavigationViewDTO.md) |  | [optional] [default to undefined]
+**traits** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { NavigationObjectDTO } from '@caraer/client';
+
+const instance: NavigationObjectDTO = {
+    uuid,
+    name,
+    label,
+    plural,
+    icon,
+    defaultTrait,
+    index,
+    suites,
+    views,
+    traits,
+};
+```
+
+[[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/NavigationViewDTO.md

@@ -0,0 +1,44 @@
+# NavigationViewDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**label** | **string** |  | [optional] [default to undefined]
+**icon** | **string** |  | [optional] [default to undefined]
+**trait** | **string** |  | [optional] [default to undefined]
+**defaultView** | **boolean** |  | [optional] [default to undefined]
+**index** | **number** |  | [optional] [default to undefined]
+**favorite** | **boolean** |  | [optional] [default to undefined]
+**personal** | **boolean** |  | [optional] [default to undefined]
+**shared** | **boolean** |  | [optional] [default to undefined]
+**team** | **boolean** |  | [optional] [default to undefined]
+**isInternallyPublic** | **boolean** |  | [optional] [default to undefined]
+**deletedAt** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { NavigationViewDTO } from '@caraer/client';
+
+const instance: NavigationViewDTO = {
+    uuid,
+    name,
+    label,
+    icon,
+    trait,
+    defaultView,
+    index,
+    favorite,
+    personal,
+    shared,
+    team,
+    isInternallyPublic,
+    deletedAt,
+};
+```
+
+[[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/NotificationDeviceReceipt.md

@@ -0,0 +1,26 @@
+# NotificationDeviceReceipt
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**installationId** | **string** |  | [optional] [default to undefined]
+**platform** | **string** |  | [optional] [default to undefined]
+**applicationId** | **string** |  | [optional] [default to undefined]
+**permission** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { NotificationDeviceReceipt } from '@caraer/client';
+
+const instance: NotificationDeviceReceipt = {
+    installationId,
+    platform,
+    applicationId,
+    permission,
+};
+```
+
+[[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/NotificationDeviceRegistration.md

@@ -0,0 +1,28 @@
+# NotificationDeviceRegistration
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**platform** | **string** |  | [optional] [default to undefined]
+**applicationId** | **string** |  | [optional] [default to undefined]
+**registrationKind** | **string** |  | [optional] [default to undefined]
+**registration** | **string** |  | [optional] [default to undefined]
+**permission** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { NotificationDeviceRegistration } from '@caraer/client';
+
+const instance: NotificationDeviceRegistration = {
+    platform,
+    applicationId,
+    registrationKind,
+    registration,
+    permission,
+};
+```
+
+[[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

@@ -6,10 +6,13 @@ All URIs are relative to *https://v2.api.caraer.com*
 |------------- | ------------- | -------------|
 |[**dismissNotification**](#dismissnotification) | **DELETE** /api/v2/notifications/{notificationId} | Dismiss a notification|
 |[**firebaseToken**](#firebasetoken) | **GET** /api/v2/notifications/firebase-token | Mint a Firebase custom token so the app can listen to its inbox|
+|[**getNotification**](#getnotification) | **GET** /api/v2/notifications/{notificationId} | Get an authoritative notification by ID|
 |[**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|
 |[**markAsRead**](#markasread) | **PATCH** /api/v2/notifications/{notificationId}/read | Mark a notification as read|
+|[**registerDevice**](#registerdevice) | **PUT** /api/v2/notifications/devices/{deviceInstallationId} | Register this user\'s native notification device|
 |[**sendNotification**](#sendnotification) | **POST** /api/v2/notifications | Send a notification (app token)|
+|[**unregisterDevice**](#unregisterdevice) | **DELETE** /api/v2/notifications/devices/{deviceInstallationId} | Unregister this user\'s native notification device|
 
 # **dismissNotification**
 > DeleteResponseString dismissNotification()
@@ -101,6 +104,61 @@ This endpoint does not have any parameters.
  - **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)
+
+# **getNotification**
+> ShowResponseItem getNotification()
+
+Returns an inbox entry only for its human recipient in the authorized selected company, including entries outside the inbox page.
+
+### Example
+
+```typescript
+import {
+    NotificationsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new NotificationsApi(configuration);
+
+let notificationId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getNotification(
+    notificationId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **notificationId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ShowResponseItem**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
@@ -271,6 +329,65 @@ const { status, data } = await apiInstance.markAsRead(
 
 [[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)
 
+# **registerDevice**
+> ShowResponseNotificationDeviceReceipt registerDevice(notificationDeviceRegistration)
+
+Idempotently registers an allowed native application. Human authentication required. Does not accept a target user or company. Rotate the registration when moving between accounts.
+
+### Example
+
+```typescript
+import {
+    NotificationsApi,
+    Configuration,
+    NotificationDeviceRegistration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new NotificationsApi(configuration);
+
+let deviceInstallationId: string; // (default to undefined)
+let notificationDeviceRegistration: NotificationDeviceRegistration; //
+
+const { status, data } = await apiInstance.registerDevice(
+    deviceInstallationId,
+    notificationDeviceRegistration
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **notificationDeviceRegistration** | **NotificationDeviceRegistration**|  | |
+| **deviceInstallationId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ShowResponseNotificationDeviceReceipt**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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)
+
 # **sendNotification**
 > CreateResponseMapStringString sendNotification(sendNotificationRequest)
 
@@ -329,3 +446,58 @@ const { status, data } = await apiInstance.sendNotification(
 
 [[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)
 
+# **unregisterDevice**
+> SuccessResponseString unregisterDevice()
+
+Idempotent. Call before logout; other users\' device registrations are inaccessible.
+
+### Example
+
+```typescript
+import {
+    NotificationsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new NotificationsApi(configuration);
+
+let deviceInstallationId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.unregisterDevice(
+    deviceInstallationId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **deviceInstallationId** | [**string**] |  | 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** | 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)
+

package/docs/ObjectReferenceDTO.md

@@ -0,0 +1,32 @@
+# ObjectReferenceDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**label** | **string** |  | [optional] [default to undefined]
+**plural** | **string** |  | [optional] [default to undefined]
+**icon** | **string** |  | [optional] [default to undefined]
+**defaultTrait** | **string** |  | [optional] [default to undefined]
+**traits** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ObjectReferenceDTO } from '@caraer/client';
+
+const instance: ObjectReferenceDTO = {
+    uuid,
+    name,
+    label,
+    plural,
+    icon,
+    defaultTrait,
+    traits,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)