@caraer/client 2.0.695 → 2.0.696

package/.openapi-generator/FILES

@@ -52,6 +52,7 @@ docs/AppSettingsSection.md
 docs/AppSubcategoryDTO.md
 docs/ApplicationsApi.md
 docs/ArchivedRecordObjectDTO.md
+docs/Audience.md
 docs/AutomationsApi.md
 docs/BillingApi.md
 docs/BillingSettingsDTO.md
@@ -110,6 +111,7 @@ docs/CreateResponseSignedUrlResultDTO.md
 docs/CreateSignedUrlRequest.md
 docs/CriterionScore.md
 docs/CrossObjectRecordSearchRequest.md
+docs/CrudAccessContext.md
 docs/Currency.md
 docs/CurrencyRange.md
 docs/CursorLocation.md
@@ -213,6 +215,7 @@ docs/PaginationResponseTraitDTO.md
 docs/PaginationResponseViewDTO.md
 docs/PaginationResponseWebMenuDTO.md
 docs/PaginationResponseWebpageAccessGrantDTO.md
+docs/Permissions.md
 docs/Phone.md
 docs/PreviewDTO.md
 docs/PreviewItemDTO.md

package/api.ts

@@ -1026,8 +1026,8 @@ export interface AppSettingFieldSchema {
     'clearValue'?: boolean;
     'mappingValue'?: AppSettingFieldMappingStructure;
     'valueScope'?: string;
-    'settingsGroup'?: boolean;
     'action'?: boolean;
+    'settingsGroup'?: boolean;
     'filterPropertyTypes'?: Array<string>;
     'filterPropertyFormats'?: Array<string>;
 }
@@ -1064,6 +1064,17 @@ export interface ArchivedRecordObjectDTO {
     'icon'?: string;
     'index'?: number;
 }
+export interface Audience {
+    'authentication'?: any;
+    'principal'?: any;
+    'authenticated'?: boolean;
+    'database'?: string;
+    'principalDatabase'?: string;
+    'companyUuid'?: string;
+    'principalUuid'?: string;
+    'authorities'?: Array<string>;
+    'roles'?: Array<string>;
+}
 /**
  * The billing settings of the company.
  */
@@ -1269,6 +1280,7 @@ export interface BulkEditRecordsResponse {
 export interface CRUD {
     'httpSessionId'?: string;
     'turnOffMetaRelationships'?: boolean;
+    'httpAccessContext'?: CrudAccessContext;
 }
 export interface CalendarBootstrapDTO {
     'defaultCalendar'?: CalendarRecordDTO;
@@ -2187,6 +2199,10 @@ export interface CrossObjectRecordSearchRequest {
      */
     'excludeRecordUuid'?: string;
 }
+export interface CrudAccessContext {
+    'audience'?: Audience;
+    'permissions'?: Permissions;
+}
 export interface Currency extends PropertyFormat {
 }
 export interface CurrencyRange extends PropertyFormat {
@@ -3740,9 +3756,9 @@ export interface ModelRecord {
     'complete'?: boolean;
     'deleted'?: boolean;
     'uuid': string;
+    'user'?: PublicUserDTO;
     'properties'?: Array<FilledProperty>;
     'objects'?: { [key: string]: any | null; };
-    'user'?: PublicUserDTO;
 }
 export interface MultiFile extends PropertyFormat {
 }
@@ -4637,6 +4653,10 @@ export interface PaginationResponseWebpageAccessGrantDTO {
      */
     'lastPage'?: number;
 }
+export interface Permissions {
+    'scopes'?: Array<string>;
+    'filters'?: any;
+}
 export interface Phone extends PropertyFormat {
 }
 /**
@@ -5986,8 +6006,8 @@ export interface SettingField {
     'hidden'?: boolean;
     'disabled'?: boolean;
     'options'?: Array<SettingOption>;
-    'value'?: any;
     'defaultValue'?: any;
+    'value'?: any;
 }
 
 export const SettingFieldTypeEnum = {

package/dist/api.d.ts

@@ -1017,8 +1017,8 @@ export interface AppSettingFieldSchema {
     'clearValue'?: boolean;
     'mappingValue'?: AppSettingFieldMappingStructure;
     'valueScope'?: string;
-    'settingsGroup'?: boolean;
     'action'?: boolean;
+    'settingsGroup'?: boolean;
     'filterPropertyTypes'?: Array<string>;
     'filterPropertyFormats'?: Array<string>;
 }
@@ -1055,6 +1055,17 @@ export interface ArchivedRecordObjectDTO {
     'icon'?: string;
     'index'?: number;
 }
+export interface Audience {
+    'authentication'?: any;
+    'principal'?: any;
+    'authenticated'?: boolean;
+    'database'?: string;
+    'principalDatabase'?: string;
+    'companyUuid'?: string;
+    'principalUuid'?: string;
+    'authorities'?: Array<string>;
+    'roles'?: Array<string>;
+}
 /**
  * The billing settings of the company.
  */
@@ -1262,6 +1273,7 @@ export interface BulkEditRecordsResponse {
 export interface CRUD {
     'httpSessionId'?: string;
     'turnOffMetaRelationships'?: boolean;
+    'httpAccessContext'?: CrudAccessContext;
 }
 export interface CalendarBootstrapDTO {
     'defaultCalendar'?: CalendarRecordDTO;
@@ -2190,6 +2202,10 @@ export interface CrossObjectRecordSearchRequest {
      */
     'excludeRecordUuid'?: string;
 }
+export interface CrudAccessContext {
+    'audience'?: Audience;
+    'permissions'?: Permissions;
+}
 export interface Currency extends PropertyFormat {
 }
 export interface CurrencyRange extends PropertyFormat {
@@ -3754,11 +3770,11 @@ export interface ModelRecord {
     'complete'?: boolean;
     'deleted'?: boolean;
     'uuid': string;
+    'user'?: PublicUserDTO;
     'properties'?: Array<FilledProperty>;
     'objects'?: {
         [key: string]: any | null;
     };
-    'user'?: PublicUserDTO;
 }
 export interface MultiFile extends PropertyFormat {
 }
@@ -4664,6 +4680,10 @@ export interface PaginationResponseWebpageAccessGrantDTO {
      */
     'lastPage'?: number;
 }
+export interface Permissions {
+    'scopes'?: Array<string>;
+    'filters'?: any;
+}
 export interface Phone extends PropertyFormat {
 }
 /**
@@ -6038,8 +6058,8 @@ export interface SettingField {
     'hidden'?: boolean;
     'disabled'?: boolean;
     'options'?: Array<SettingOption>;
-    'value'?: any;
     'defaultValue'?: any;
+    'value'?: any;
 }
 export declare const SettingFieldTypeEnum: {
     readonly String: "STRING";

package/dist/esm/api.d.ts

@@ -1016,8 +1016,8 @@ export interface AppSettingFieldSchema {
     'clearValue'?: boolean;
     'mappingValue'?: AppSettingFieldMappingStructure;
     'valueScope'?: string;
-    'settingsGroup'?: boolean;
     'action'?: boolean;
+    'settingsGroup'?: boolean;
     'filterPropertyTypes'?: Array<string>;
     'filterPropertyFormats'?: Array<string>;
 }
@@ -1054,6 +1054,17 @@ export interface ArchivedRecordObjectDTO {
     'icon'?: string;
     'index'?: number;
 }
+export interface Audience {
+    'authentication'?: any;
+    'principal'?: any;
+    'authenticated'?: boolean;
+    'database'?: string;
+    'principalDatabase'?: string;
+    'companyUuid'?: string;
+    'principalUuid'?: string;
+    'authorities'?: Array<string>;
+    'roles'?: Array<string>;
+}
 /**
  * The billing settings of the company.
  */
@@ -1261,6 +1272,7 @@ export interface BulkEditRecordsResponse {
 export interface CRUD {
     'httpSessionId'?: string;
     'turnOffMetaRelationships'?: boolean;
+    'httpAccessContext'?: CrudAccessContext;
 }
 export interface CalendarBootstrapDTO {
     'defaultCalendar'?: CalendarRecordDTO;
@@ -2189,6 +2201,10 @@ export interface CrossObjectRecordSearchRequest {
      */
     'excludeRecordUuid'?: string;
 }
+export interface CrudAccessContext {
+    'audience'?: Audience;
+    'permissions'?: Permissions;
+}
 export interface Currency extends PropertyFormat {
 }
 export interface CurrencyRange extends PropertyFormat {
@@ -3753,11 +3769,11 @@ export interface ModelRecord {
     'complete'?: boolean;
     'deleted'?: boolean;
     'uuid': string;
+    'user'?: PublicUserDTO;
     'properties'?: Array<FilledProperty>;
     'objects'?: {
         [key: string]: any | null;
     };
-    'user'?: PublicUserDTO;
 }
 export interface MultiFile extends PropertyFormat {
 }
@@ -4663,6 +4679,10 @@ export interface PaginationResponseWebpageAccessGrantDTO {
      */
     'lastPage'?: number;
 }
+export interface Permissions {
+    'scopes'?: Array<string>;
+    'filters'?: any;
+}
 export interface Phone extends PropertyFormat {
 }
 /**
@@ -6037,8 +6057,8 @@ export interface SettingField {
     'hidden'?: boolean;
     'disabled'?: boolean;
     'options'?: Array<SettingOption>;
-    'value'?: any;
     'defaultValue'?: any;
+    'value'?: any;
 }
 export declare const SettingFieldTypeEnum: {
     readonly String: "STRING";

package/docs/AppSettingFieldSchema.md

@@ -33,8 +33,8 @@ Name | Type | Description | Notes
 **clearValue** | **boolean** |  | [optional] [default to undefined]
 **mappingValue** | [**AppSettingFieldMappingStructure**](AppSettingFieldMappingStructure.md) |  | [optional] [default to undefined]
 **valueScope** | **string** |  | [optional] [default to undefined]
-**settingsGroup** | **boolean** |  | [optional] [default to undefined]
 **action** | **boolean** |  | [optional] [default to undefined]
+**settingsGroup** | **boolean** |  | [optional] [default to undefined]
 **filterPropertyTypes** | **Array<string>** |  | [optional] [default to undefined]
 **filterPropertyFormats** | **Array<string>** |  | [optional] [default to undefined]
 
@@ -72,8 +72,8 @@ const instance: AppSettingFieldSchema = {
     clearValue,
     mappingValue,
     valueScope,
-    settingsGroup,
     action,
+    settingsGroup,
     filterPropertyTypes,
     filterPropertyFormats,
 };

package/docs/Audience.md

@@ -0,0 +1,36 @@
+# Audience
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**authentication** | **any** |  | [optional] [default to undefined]
+**principal** | **any** |  | [optional] [default to undefined]
+**authenticated** | **boolean** |  | [optional] [default to undefined]
+**database** | **string** |  | [optional] [default to undefined]
+**principalDatabase** | **string** |  | [optional] [default to undefined]
+**companyUuid** | **string** |  | [optional] [default to undefined]
+**principalUuid** | **string** |  | [optional] [default to undefined]
+**authorities** | **Array<string>** |  | [optional] [default to undefined]
+**roles** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Audience } from '@caraer/client';
+
+const instance: Audience = {
+    authentication,
+    principal,
+    authenticated,
+    database,
+    principalDatabase,
+    companyUuid,
+    principalUuid,
+    authorities,
+    roles,
+};
+```
+
+[[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/CRUD.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **httpSessionId** | **string** |  | [optional] [default to undefined]
 **turnOffMetaRelationships** | **boolean** |  | [optional] [default to undefined]
+**httpAccessContext** | [**CrudAccessContext**](CrudAccessContext.md) |  | [optional] [default to undefined]
 
 ## Example
 
@@ -16,6 +17,7 @@ import { CRUD } from '@caraer/client';
 const instance: CRUD = {
     httpSessionId,
     turnOffMetaRelationships,
+    httpAccessContext,
 };
 ```
 

package/docs/CrudAccessContext.md

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

@@ -0,0 +1,22 @@
+# Permissions
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**scopes** | **Array<string>** |  | [optional] [default to undefined]
+**filters** | **any** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Permissions } from '@caraer/client';
+
+const instance: Permissions = {
+    scopes,
+    filters,
+};
+```
+
+[[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

@@ -17,9 +17,9 @@ Name | Type | Description | Notes
 **complete** | **boolean** |  | [optional] [default to undefined]
 **deleted** | **boolean** |  | [optional] [default to undefined]
 **uuid** | **string** |  | [default to undefined]
+**user** | [**PublicUserDTO**](PublicUserDTO.md) |  | [optional] [default to undefined]
 **properties** | [**Array<FilledProperty>**](FilledProperty.md) |  | [optional] [default to undefined]
 **objects** | **{ [key: string]: any | null; }** |  | [optional] [default to undefined]
-**user** | [**PublicUserDTO**](PublicUserDTO.md) |  | [optional] [default to undefined]
 
 ## Example
 
@@ -39,9 +39,9 @@ const instance: ModelRecord = {
     complete,
     deleted,
     uuid,
+    user,
     properties,
     objects,
-    user,
 };
 ```
 

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]
-**value** | **any** |  | [optional] [default to undefined]
 **defaultValue** | **any** |  | [optional] [default to undefined]
+**value** | **any** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -32,8 +32,8 @@ const instance: SettingField = {
     hidden,
     disabled,
     _options,
-    value,
     defaultValue,
+    value,
 };
 ```
 

package/package.json

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