@caraer/client 2.0.696 → 2.0.702
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 +38 -0
- package/api.ts +1837 -202
- package/dist/api.d.ts +999 -33
- package/dist/api.js +1280 -84
- package/dist/esm/api.d.ts +999 -33
- package/dist/esm/api.js +1268 -80
- package/docs/ApiTokenDTO.md +22 -0
- package/docs/AppBarDTO.md +6 -0
- package/docs/AppBarIframeSessionRequest.md +4 -0
- package/docs/AppBarsApi.md +4 -1
- package/docs/AppDTO.md +4 -0
- package/docs/AppDetailsDTO.md +2 -0
- package/docs/AppSettingFieldSchema.md +2 -2
- package/docs/BrowserAuthExchangeRequest.md +24 -0
- package/docs/BrowserAuthSessionResponse.md +28 -0
- package/docs/BrowserAuthStartRequest.md +28 -0
- package/docs/BrowserAuthStartResponse.md +22 -0
- package/docs/BrowserAuthenticationApi.md +176 -0
- package/docs/BulkEditRecordErrorItem.md +2 -0
- package/docs/CreatePrivateAppRequest.md +4 -0
- package/docs/EnsureRelationDTO.md +27 -0
- package/docs/ErrorResponse.md +2 -0
- package/docs/FavoriteViewDTO.md +22 -0
- package/docs/NavigationApi.md +280 -0
- package/docs/NavigationDTO.md +27 -0
- package/docs/NavigationObjectDTO.md +38 -0
- package/docs/NavigationViewDTO.md +44 -0
- package/docs/NotificationDeviceReceipt.md +26 -0
- package/docs/NotificationDeviceRegistration.md +28 -0
- package/docs/NotificationsApi.md +172 -0
- package/docs/ObjectReferenceDTO.md +32 -0
- package/docs/ObjectsApi.md +5 -2
- package/docs/Palette.md +22 -0
- package/docs/RecordsApi.md +119 -0
- package/docs/RelationCapabilities.md +26 -0
- package/docs/RelationCapabilityEdge.md +22 -0
- package/docs/RelationCapabilityEdges.md +22 -0
- package/docs/RelationCapabilityOperation.md +22 -0
- package/docs/RelationCapabilityPair.md +22 -0
- package/docs/RelationCapabilityPairCapability.md +34 -0
- package/docs/RelationCapabilityPrimary.md +22 -0
- package/docs/RelationCapabilityRequest.md +22 -0
- package/docs/SettingField.md +2 -2
- package/docs/ShowResponseBrowserAuthSessionResponse.md +23 -0
- package/docs/ShowResponseBrowserAuthStartResponse.md +23 -0
- package/docs/ShowResponseItem.md +23 -0
- package/docs/ShowResponseNotificationDeviceReceipt.md +23 -0
- package/docs/ShowResponseRelationCapabilities.md +23 -0
- package/docs/ShowResponseWebpageEditorDefaultsDTO.md +23 -0
- package/docs/SimpleCompanyDTO.md +22 -0
- package/docs/SuccessResponseEnsureRelationDTO.md +23 -0
- package/docs/SuccessResponseListFavoriteViewDTO.md +23 -0
- package/docs/SuccessResponseListNavigationViewDTO.md +23 -0
- package/docs/SuccessResponseNavigationDTO.md +23 -0
- package/docs/UserDTO.md +46 -0
- package/docs/ViewNavigationPreferencesRequest.md +23 -0
- package/docs/WebpageEditorDefaultsDTO.md +25 -0
- package/docs/WebpagesApi.md +118 -0
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -228,10 +228,26 @@ export interface AnalyticsWidgetStyle {
|
|
|
228
228
|
};
|
|
229
229
|
'referenceLines'?: Array<AnalyticsReferenceLine>;
|
|
230
230
|
}
|
|
231
|
+
export interface ApiTokenDTO {
|
|
232
|
+
'token'?: string;
|
|
233
|
+
'expiresAt'?: number;
|
|
234
|
+
}
|
|
231
235
|
/**
|
|
232
236
|
* Data transfer object for an app bar (location-specific settings and action config)
|
|
233
237
|
*/
|
|
234
238
|
export interface AppBarDTO {
|
|
239
|
+
/**
|
|
240
|
+
* TOOL_BAR navigation: SUITE (legacy default) or suite-independent SETTINGS. Omission preserves an existing value.
|
|
241
|
+
*/
|
|
242
|
+
'navigationPlacement'?: AppBarDTONavigationPlacementEnum;
|
|
243
|
+
/**
|
|
244
|
+
* Literal human caller scopes required for TOOL_BAR discovery and iframe access. Omission preserves; [] clears.
|
|
245
|
+
*/
|
|
246
|
+
'requiredUserScopes'?: Array<string>;
|
|
247
|
+
/**
|
|
248
|
+
* Unique unreserved settings-relative route slugs for a SETTINGS tool. Omission preserves; [] clears.
|
|
249
|
+
*/
|
|
250
|
+
'routeAliases'?: Array<string>;
|
|
235
251
|
/**
|
|
236
252
|
* Unique identifier for the entity
|
|
237
253
|
*/
|
|
@@ -305,6 +321,11 @@ export interface AppBarDTO {
|
|
|
305
321
|
*/
|
|
306
322
|
'webhook'?: SubscribeWebhookDTO;
|
|
307
323
|
}
|
|
324
|
+
export declare const AppBarDTONavigationPlacementEnum: {
|
|
325
|
+
readonly Suite: "SUITE";
|
|
326
|
+
readonly Settings: "SETTINGS";
|
|
327
|
+
};
|
|
328
|
+
export type AppBarDTONavigationPlacementEnum = typeof AppBarDTONavigationPlacementEnum[keyof typeof AppBarDTONavigationPlacementEnum];
|
|
308
329
|
export declare const AppBarDTOLocationEnum: {
|
|
309
330
|
readonly RecordPreview: "RECORD_PREVIEW";
|
|
310
331
|
readonly RecordOverview: "RECORD_OVERVIEW";
|
|
@@ -318,6 +339,14 @@ export type AppBarDTOLocationEnum = typeof AppBarDTOLocationEnum[keyof typeof Ap
|
|
|
318
339
|
* Request body for creating an iframe session token
|
|
319
340
|
*/
|
|
320
341
|
export interface AppBarIframeSessionRequest {
|
|
342
|
+
/**
|
|
343
|
+
* Selected suite for explicit SUITE tool requests; omitted legacy requests retain configured-suite behavior
|
|
344
|
+
*/
|
|
345
|
+
'suite'?: string;
|
|
346
|
+
/**
|
|
347
|
+
* Explicit TOOL_BAR placement; must match the stored descriptor
|
|
348
|
+
*/
|
|
349
|
+
'navigationPlacement'?: AppBarIframeSessionRequestNavigationPlacementEnum;
|
|
321
350
|
/**
|
|
322
351
|
* Object name in context
|
|
323
352
|
*/
|
|
@@ -341,6 +370,11 @@ export interface AppBarIframeSessionRequest {
|
|
|
341
370
|
[key: string]: any | null;
|
|
342
371
|
};
|
|
343
372
|
}
|
|
373
|
+
export declare const AppBarIframeSessionRequestNavigationPlacementEnum: {
|
|
374
|
+
readonly Suite: "SUITE";
|
|
375
|
+
readonly Settings: "SETTINGS";
|
|
376
|
+
};
|
|
377
|
+
export type AppBarIframeSessionRequestNavigationPlacementEnum = typeof AppBarIframeSessionRequestNavigationPlacementEnum[keyof typeof AppBarIframeSessionRequestNavigationPlacementEnum];
|
|
344
378
|
/**
|
|
345
379
|
* Request body for validating an iframe session token
|
|
346
380
|
*/
|
|
@@ -425,6 +459,14 @@ export interface AppConnectionStatusDTO {
|
|
|
425
459
|
* Full app payload (AppCreatorDTO) to apply
|
|
426
460
|
*/
|
|
427
461
|
export interface AppDTO {
|
|
462
|
+
/**
|
|
463
|
+
* Stable creator input for brandmark; display uses brandmark URL
|
|
464
|
+
*/
|
|
465
|
+
'brandmarkReference'?: string;
|
|
466
|
+
/**
|
|
467
|
+
* Stable creator input for details.image; display uses image URL
|
|
468
|
+
*/
|
|
469
|
+
'imageReference'?: string;
|
|
428
470
|
/**
|
|
429
471
|
* Unique identifier for the entity
|
|
430
472
|
*/
|
|
@@ -638,6 +680,10 @@ export interface AppDetailsDTO {
|
|
|
638
680
|
*/
|
|
639
681
|
'description'?: string;
|
|
640
682
|
'image'?: string;
|
|
683
|
+
/**
|
|
684
|
+
* Stable creator input for image; never persist a signed display URL
|
|
685
|
+
*/
|
|
686
|
+
'imageReference'?: string;
|
|
641
687
|
/**
|
|
642
688
|
* Hex accent color (#RRGGBB) for installed app-bar action buttons and toolbar icons
|
|
643
689
|
*/
|
|
@@ -1017,8 +1063,8 @@ export interface AppSettingFieldSchema {
|
|
|
1017
1063
|
'clearValue'?: boolean;
|
|
1018
1064
|
'mappingValue'?: AppSettingFieldMappingStructure;
|
|
1019
1065
|
'valueScope'?: string;
|
|
1020
|
-
'action'?: boolean;
|
|
1021
1066
|
'settingsGroup'?: boolean;
|
|
1067
|
+
'action'?: boolean;
|
|
1022
1068
|
'filterPropertyTypes'?: Array<string>;
|
|
1023
1069
|
'filterPropertyFormats'?: Array<string>;
|
|
1024
1070
|
}
|
|
@@ -1135,6 +1181,29 @@ export interface BillingSettingsDTO {
|
|
|
1135
1181
|
*/
|
|
1136
1182
|
'country'?: string;
|
|
1137
1183
|
}
|
|
1184
|
+
export interface BrowserAuthExchangeRequest {
|
|
1185
|
+
'code'?: string;
|
|
1186
|
+
'codeVerifier'?: string;
|
|
1187
|
+
'redirectUri'?: string;
|
|
1188
|
+
}
|
|
1189
|
+
export interface BrowserAuthSessionResponse {
|
|
1190
|
+
'accessToken'?: string;
|
|
1191
|
+
'refreshToken'?: string;
|
|
1192
|
+
'tokenType'?: string;
|
|
1193
|
+
'user'?: UserDTO;
|
|
1194
|
+
'companyUuid'?: string;
|
|
1195
|
+
}
|
|
1196
|
+
export interface BrowserAuthStartRequest {
|
|
1197
|
+
'provider'?: string;
|
|
1198
|
+
'redirectUri'?: string;
|
|
1199
|
+
'codeChallenge'?: string;
|
|
1200
|
+
'codeChallengeMethod'?: string;
|
|
1201
|
+
'state'?: string;
|
|
1202
|
+
}
|
|
1203
|
+
export interface BrowserAuthStartResponse {
|
|
1204
|
+
'authorizationUrl'?: string;
|
|
1205
|
+
'expiresIn'?: number;
|
|
1206
|
+
}
|
|
1138
1207
|
/**
|
|
1139
1208
|
* Payload of a bulk delete records response.
|
|
1140
1209
|
*/
|
|
@@ -1194,7 +1263,15 @@ export interface BulkEditRecordErrorItem {
|
|
|
1194
1263
|
* Field-level validation errors.
|
|
1195
1264
|
*/
|
|
1196
1265
|
'errors'?: Array<CaraerErrorType>;
|
|
1266
|
+
/**
|
|
1267
|
+
* Proof for this item only that its owning record command did not start record/relationship persistence. Other bulk items may have persisted; ancillary file ingestion is not covered.
|
|
1268
|
+
*/
|
|
1269
|
+
'recordWriteOutcome'?: BulkEditRecordErrorItemRecordWriteOutcomeEnum;
|
|
1197
1270
|
}
|
|
1271
|
+
export declare const BulkEditRecordErrorItemRecordWriteOutcomeEnum: {
|
|
1272
|
+
readonly NotStarted: "NOT_STARTED";
|
|
1273
|
+
};
|
|
1274
|
+
export type BulkEditRecordErrorItemRecordWriteOutcomeEnum = typeof BulkEditRecordErrorItemRecordWriteOutcomeEnum[keyof typeof BulkEditRecordErrorItemRecordWriteOutcomeEnum];
|
|
1198
1275
|
/**
|
|
1199
1276
|
* A single record to create or update in a bulk edit request.
|
|
1200
1277
|
*/
|
|
@@ -1822,6 +1899,14 @@ export interface CreateOrUpdateEnvironmentRequest {
|
|
|
1822
1899
|
* Private app creator manifest; label is required and internal name is optional
|
|
1823
1900
|
*/
|
|
1824
1901
|
export interface CreatePrivateAppRequest {
|
|
1902
|
+
/**
|
|
1903
|
+
* Stable creator input for brandmark; display uses brandmark URL
|
|
1904
|
+
*/
|
|
1905
|
+
'brandmarkReference'?: string;
|
|
1906
|
+
/**
|
|
1907
|
+
* Stable creator input for details.image; display uses image URL
|
|
1908
|
+
*/
|
|
1909
|
+
'imageReference'?: string;
|
|
1825
1910
|
/**
|
|
1826
1911
|
* Unique identifier for the entity
|
|
1827
1912
|
*/
|
|
@@ -2774,6 +2859,20 @@ export interface EngagementBatchRequest {
|
|
|
2774
2859
|
'sessionId'?: string;
|
|
2775
2860
|
'events'?: Array<TrackingEventRequest>;
|
|
2776
2861
|
}
|
|
2862
|
+
/**
|
|
2863
|
+
* Atomic ensure-link receipt. UNCHANGED leaves every existing edge property untouched.
|
|
2864
|
+
*/
|
|
2865
|
+
export interface EnsureRelationDTO {
|
|
2866
|
+
'fromUuid'?: string;
|
|
2867
|
+
'toUuid'?: string;
|
|
2868
|
+
'relationName'?: string;
|
|
2869
|
+
'outcome'?: EnsureRelationDTOOutcomeEnum;
|
|
2870
|
+
}
|
|
2871
|
+
export declare const EnsureRelationDTOOutcomeEnum: {
|
|
2872
|
+
readonly Created: "CREATED";
|
|
2873
|
+
readonly Unchanged: "UNCHANGED";
|
|
2874
|
+
};
|
|
2875
|
+
export type EnsureRelationDTOOutcomeEnum = typeof EnsureRelationDTOOutcomeEnum[keyof typeof EnsureRelationDTOOutcomeEnum];
|
|
2777
2876
|
/**
|
|
2778
2877
|
* Defines the structure of error responses returned by the API.
|
|
2779
2878
|
*/
|
|
@@ -2790,6 +2889,10 @@ export interface ErrorResponse {
|
|
|
2790
2889
|
* The HTTP status code associated with the error.
|
|
2791
2890
|
*/
|
|
2792
2891
|
'status'?: number;
|
|
2892
|
+
/**
|
|
2893
|
+
* Present only when the owning direct-record command proves record/relationship persistence did not start. Does not imply no file-ingestion side effects or whole-request idempotency.
|
|
2894
|
+
*/
|
|
2895
|
+
'recordWriteOutcome'?: ErrorResponseRecordWriteOutcomeEnum;
|
|
2793
2896
|
'stackTrace'?: string;
|
|
2794
2897
|
/**
|
|
2795
2898
|
* Roles the caller is missing when the failure is an authorization error.
|
|
@@ -2804,6 +2907,10 @@ export interface ErrorResponse {
|
|
|
2804
2907
|
*/
|
|
2805
2908
|
'requestId'?: string;
|
|
2806
2909
|
}
|
|
2910
|
+
export declare const ErrorResponseRecordWriteOutcomeEnum: {
|
|
2911
|
+
readonly NotStarted: "NOT_STARTED";
|
|
2912
|
+
};
|
|
2913
|
+
export type ErrorResponseRecordWriteOutcomeEnum = typeof ErrorResponseRecordWriteOutcomeEnum[keyof typeof ErrorResponseRecordWriteOutcomeEnum];
|
|
2807
2914
|
export declare const ErrorResponseRolesEnum: {
|
|
2808
2915
|
readonly User: "USER";
|
|
2809
2916
|
readonly Admin: "ADMIN";
|
|
@@ -2854,6 +2961,10 @@ export interface ExtendRecordRequest {
|
|
|
2854
2961
|
*/
|
|
2855
2962
|
'objects'?: Set<CaraerObjectDTO>;
|
|
2856
2963
|
}
|
|
2964
|
+
export interface FavoriteViewDTO {
|
|
2965
|
+
'object'?: ObjectReferenceDTO;
|
|
2966
|
+
'view'?: NavigationViewDTO;
|
|
2967
|
+
}
|
|
2857
2968
|
export interface FeedDTO {
|
|
2858
2969
|
/**
|
|
2859
2970
|
* Unique identifier for the entity
|
|
@@ -3789,6 +3900,42 @@ export interface MultiValueMapStringString {
|
|
|
3789
3900
|
};
|
|
3790
3901
|
'empty'?: boolean;
|
|
3791
3902
|
}
|
|
3903
|
+
/**
|
|
3904
|
+
* Authorized application navigation for the currently selected company. Contains no record schema or user configuration.
|
|
3905
|
+
*/
|
|
3906
|
+
export interface NavigationDTO {
|
|
3907
|
+
'objects'?: Array<NavigationObjectDTO>;
|
|
3908
|
+
'suites'?: Array<string>;
|
|
3909
|
+
'tools'?: WebMenuDTO;
|
|
3910
|
+
'settings'?: WebMenuDTO;
|
|
3911
|
+
}
|
|
3912
|
+
export interface NavigationObjectDTO {
|
|
3913
|
+
'uuid'?: string;
|
|
3914
|
+
'name'?: string;
|
|
3915
|
+
'label'?: string;
|
|
3916
|
+
'plural'?: string;
|
|
3917
|
+
'icon'?: string;
|
|
3918
|
+
'defaultTrait'?: string;
|
|
3919
|
+
'index'?: number;
|
|
3920
|
+
'suites'?: Array<string>;
|
|
3921
|
+
'views'?: Array<NavigationViewDTO>;
|
|
3922
|
+
'traits'?: Array<string>;
|
|
3923
|
+
}
|
|
3924
|
+
export interface NavigationViewDTO {
|
|
3925
|
+
'uuid'?: string;
|
|
3926
|
+
'name'?: string;
|
|
3927
|
+
'label'?: string;
|
|
3928
|
+
'icon'?: string;
|
|
3929
|
+
'trait'?: string;
|
|
3930
|
+
'defaultView'?: boolean;
|
|
3931
|
+
'index'?: number;
|
|
3932
|
+
'favorite'?: boolean;
|
|
3933
|
+
'personal'?: boolean;
|
|
3934
|
+
'shared'?: boolean;
|
|
3935
|
+
'team'?: boolean;
|
|
3936
|
+
'isInternallyPublic'?: boolean;
|
|
3937
|
+
'deletedAt'?: number;
|
|
3938
|
+
}
|
|
3792
3939
|
export interface NotFoundError {
|
|
3793
3940
|
'cause'?: NotFoundErrorCause;
|
|
3794
3941
|
'stackTrace'?: Array<NotFoundErrorCauseStackTraceInner>;
|
|
@@ -3830,6 +3977,19 @@ export interface NotFoundErrorCauseStackTraceInner {
|
|
|
3830
3977
|
'className'?: string;
|
|
3831
3978
|
'nativeMethod'?: boolean;
|
|
3832
3979
|
}
|
|
3980
|
+
export interface NotificationDeviceReceipt {
|
|
3981
|
+
'installationId'?: string;
|
|
3982
|
+
'platform'?: string;
|
|
3983
|
+
'applicationId'?: string;
|
|
3984
|
+
'permission'?: string;
|
|
3985
|
+
}
|
|
3986
|
+
export interface NotificationDeviceRegistration {
|
|
3987
|
+
'platform'?: string;
|
|
3988
|
+
'applicationId'?: string;
|
|
3989
|
+
'registrationKind'?: string;
|
|
3990
|
+
'registration'?: string;
|
|
3991
|
+
'permission'?: string;
|
|
3992
|
+
}
|
|
3833
3993
|
export interface NotificationInboxDTO {
|
|
3834
3994
|
'notifications'?: Array<Item>;
|
|
3835
3995
|
'unreadCount'?: number;
|
|
@@ -3897,6 +4057,15 @@ export interface ObjectAccessGrantSectionDTO {
|
|
|
3897
4057
|
[key: string]: Array<string>;
|
|
3898
4058
|
};
|
|
3899
4059
|
}
|
|
4060
|
+
export interface ObjectReferenceDTO {
|
|
4061
|
+
'uuid'?: string;
|
|
4062
|
+
'name'?: string;
|
|
4063
|
+
'label'?: string;
|
|
4064
|
+
'plural'?: string;
|
|
4065
|
+
'icon'?: string;
|
|
4066
|
+
'defaultTrait'?: string;
|
|
4067
|
+
'traits'?: Array<string>;
|
|
4068
|
+
}
|
|
3900
4069
|
/**
|
|
3901
4070
|
* Data transfer object representing a webpage content
|
|
3902
4071
|
*/
|
|
@@ -4680,6 +4849,14 @@ export interface PaginationResponseWebpageAccessGrantDTO {
|
|
|
4680
4849
|
*/
|
|
4681
4850
|
'lastPage'?: number;
|
|
4682
4851
|
}
|
|
4852
|
+
export interface Palette {
|
|
4853
|
+
'light'?: {
|
|
4854
|
+
[key: string]: string;
|
|
4855
|
+
};
|
|
4856
|
+
'dark'?: {
|
|
4857
|
+
[key: string]: string;
|
|
4858
|
+
};
|
|
4859
|
+
}
|
|
4683
4860
|
export interface Permissions {
|
|
4684
4861
|
'scopes'?: Array<string>;
|
|
4685
4862
|
'filters'?: any;
|
|
@@ -5536,6 +5713,69 @@ export interface RegisterRequest {
|
|
|
5536
5713
|
'firstname': string;
|
|
5537
5714
|
'lastname': string;
|
|
5538
5715
|
}
|
|
5716
|
+
export interface RelationCapabilities {
|
|
5717
|
+
'unlinkMatch'?: string;
|
|
5718
|
+
'primaryReset'?: string;
|
|
5719
|
+
'pairs'?: Array<RelationCapabilityPairCapability>;
|
|
5720
|
+
'ensureLink'?: boolean;
|
|
5721
|
+
}
|
|
5722
|
+
export interface RelationCapabilityEdge {
|
|
5723
|
+
'exists'?: boolean;
|
|
5724
|
+
'primary'?: RelationCapabilityEdgePrimaryEnum;
|
|
5725
|
+
}
|
|
5726
|
+
export declare const RelationCapabilityEdgePrimaryEnum: {
|
|
5727
|
+
readonly Absent: "ABSENT";
|
|
5728
|
+
readonly False: "FALSE";
|
|
5729
|
+
readonly True: "TRUE";
|
|
5730
|
+
readonly Mixed: "MIXED";
|
|
5731
|
+
};
|
|
5732
|
+
export type RelationCapabilityEdgePrimaryEnum = typeof RelationCapabilityEdgePrimaryEnum[keyof typeof RelationCapabilityEdgePrimaryEnum];
|
|
5733
|
+
export interface RelationCapabilityEdges {
|
|
5734
|
+
'sourceToTarget'?: RelationCapabilityEdge;
|
|
5735
|
+
'targetToSource'?: RelationCapabilityEdge;
|
|
5736
|
+
}
|
|
5737
|
+
export interface RelationCapabilityOperation {
|
|
5738
|
+
'allowed'?: boolean;
|
|
5739
|
+
'from'?: RelationCapabilityOperationFromEnum;
|
|
5740
|
+
}
|
|
5741
|
+
export declare const RelationCapabilityOperationFromEnum: {
|
|
5742
|
+
readonly Source: "SOURCE";
|
|
5743
|
+
readonly Target: "TARGET";
|
|
5744
|
+
};
|
|
5745
|
+
export type RelationCapabilityOperationFromEnum = typeof RelationCapabilityOperationFromEnum[keyof typeof RelationCapabilityOperationFromEnum];
|
|
5746
|
+
export interface RelationCapabilityPair {
|
|
5747
|
+
'targetUuid'?: string;
|
|
5748
|
+
'relationName'?: string;
|
|
5749
|
+
}
|
|
5750
|
+
export interface RelationCapabilityPairCapability {
|
|
5751
|
+
'index'?: number;
|
|
5752
|
+
'status'?: RelationCapabilityPairCapabilityStatusEnum;
|
|
5753
|
+
'link'?: RelationCapabilityOperation;
|
|
5754
|
+
'unlink'?: RelationCapabilityOperation;
|
|
5755
|
+
'primary'?: RelationCapabilityPrimary;
|
|
5756
|
+
'edges'?: RelationCapabilityEdges;
|
|
5757
|
+
'reason'?: RelationCapabilityPairCapabilityReasonEnum;
|
|
5758
|
+
'linkAttemptPermitted'?: boolean;
|
|
5759
|
+
}
|
|
5760
|
+
export declare const RelationCapabilityPairCapabilityStatusEnum: {
|
|
5761
|
+
readonly Available: "AVAILABLE";
|
|
5762
|
+
readonly Unavailable: "UNAVAILABLE";
|
|
5763
|
+
readonly Unresolved: "UNRESOLVED";
|
|
5764
|
+
};
|
|
5765
|
+
export type RelationCapabilityPairCapabilityStatusEnum = typeof RelationCapabilityPairCapabilityStatusEnum[keyof typeof RelationCapabilityPairCapabilityStatusEnum];
|
|
5766
|
+
export declare const RelationCapabilityPairCapabilityReasonEnum: {
|
|
5767
|
+
readonly OrientationAmbiguous: "ORIENTATION_AMBIGUOUS";
|
|
5768
|
+
readonly UnsupportedRelationName: "UNSUPPORTED_RELATION_NAME";
|
|
5769
|
+
};
|
|
5770
|
+
export type RelationCapabilityPairCapabilityReasonEnum = typeof RelationCapabilityPairCapabilityReasonEnum[keyof typeof RelationCapabilityPairCapabilityReasonEnum];
|
|
5771
|
+
export interface RelationCapabilityPrimary {
|
|
5772
|
+
'canSet'?: boolean;
|
|
5773
|
+
'canClear'?: boolean;
|
|
5774
|
+
}
|
|
5775
|
+
export interface RelationCapabilityRequest {
|
|
5776
|
+
'sourceUuid'?: string;
|
|
5777
|
+
'pairs'?: Array<RelationCapabilityPair>;
|
|
5778
|
+
}
|
|
5539
5779
|
/**
|
|
5540
5780
|
* Data transfer object representing a relation between Caraer objects
|
|
5541
5781
|
*/
|
|
@@ -6058,8 +6298,8 @@ export interface SettingField {
|
|
|
6058
6298
|
'hidden'?: boolean;
|
|
6059
6299
|
'disabled'?: boolean;
|
|
6060
6300
|
'options'?: Array<SettingOption>;
|
|
6061
|
-
'defaultValue'?: any;
|
|
6062
6301
|
'value'?: any;
|
|
6302
|
+
'defaultValue'?: any;
|
|
6063
6303
|
}
|
|
6064
6304
|
export declare const SettingFieldTypeEnum: {
|
|
6065
6305
|
readonly String: "STRING";
|
|
@@ -6231,6 +6471,32 @@ export interface ShowResponseBillingStatusDTO {
|
|
|
6231
6471
|
[key: string]: any;
|
|
6232
6472
|
};
|
|
6233
6473
|
}
|
|
6474
|
+
/**
|
|
6475
|
+
* Represents the response for viewing or showing a specific resource.
|
|
6476
|
+
*/
|
|
6477
|
+
export interface ShowResponseBrowserAuthSessionResponse {
|
|
6478
|
+
/**
|
|
6479
|
+
* A message detailing the result of the operation.
|
|
6480
|
+
*/
|
|
6481
|
+
'message'?: string;
|
|
6482
|
+
/**
|
|
6483
|
+
* The data payload of the response, if any.
|
|
6484
|
+
*/
|
|
6485
|
+
'data'?: BrowserAuthSessionResponse;
|
|
6486
|
+
}
|
|
6487
|
+
/**
|
|
6488
|
+
* Represents the response for viewing or showing a specific resource.
|
|
6489
|
+
*/
|
|
6490
|
+
export interface ShowResponseBrowserAuthStartResponse {
|
|
6491
|
+
/**
|
|
6492
|
+
* A message detailing the result of the operation.
|
|
6493
|
+
*/
|
|
6494
|
+
'message'?: string;
|
|
6495
|
+
/**
|
|
6496
|
+
* The data payload of the response, if any.
|
|
6497
|
+
*/
|
|
6498
|
+
'data'?: BrowserAuthStartResponse;
|
|
6499
|
+
}
|
|
6234
6500
|
/**
|
|
6235
6501
|
* Success response (ShowResponseCaraerObjectDTO).
|
|
6236
6502
|
*/
|
|
@@ -6332,6 +6598,19 @@ export interface ShowResponseFormDTO {
|
|
|
6332
6598
|
[key: string]: any;
|
|
6333
6599
|
};
|
|
6334
6600
|
}
|
|
6601
|
+
/**
|
|
6602
|
+
* Represents the response for viewing or showing a specific resource.
|
|
6603
|
+
*/
|
|
6604
|
+
export interface ShowResponseItem {
|
|
6605
|
+
/**
|
|
6606
|
+
* A message detailing the result of the operation.
|
|
6607
|
+
*/
|
|
6608
|
+
'message'?: string;
|
|
6609
|
+
/**
|
|
6610
|
+
* The data payload of the response, if any.
|
|
6611
|
+
*/
|
|
6612
|
+
'data'?: Item;
|
|
6613
|
+
}
|
|
6335
6614
|
/**
|
|
6336
6615
|
* Represents the response for viewing or showing a specific resource.
|
|
6337
6616
|
*/
|
|
@@ -6537,6 +6816,19 @@ export interface ShowResponseMapStringString {
|
|
|
6537
6816
|
[key: string]: string;
|
|
6538
6817
|
};
|
|
6539
6818
|
}
|
|
6819
|
+
/**
|
|
6820
|
+
* Represents the response for viewing or showing a specific resource.
|
|
6821
|
+
*/
|
|
6822
|
+
export interface ShowResponseNotificationDeviceReceipt {
|
|
6823
|
+
/**
|
|
6824
|
+
* A message detailing the result of the operation.
|
|
6825
|
+
*/
|
|
6826
|
+
'message'?: string;
|
|
6827
|
+
/**
|
|
6828
|
+
* The data payload of the response, if any.
|
|
6829
|
+
*/
|
|
6830
|
+
'data'?: NotificationDeviceReceipt;
|
|
6831
|
+
}
|
|
6540
6832
|
/**
|
|
6541
6833
|
* Represents the response for viewing or showing a specific resource.
|
|
6542
6834
|
*/
|
|
@@ -6616,6 +6908,19 @@ export interface ShowResponsePublicFormDTO {
|
|
|
6616
6908
|
[key: string]: any;
|
|
6617
6909
|
};
|
|
6618
6910
|
}
|
|
6911
|
+
/**
|
|
6912
|
+
* Represents the response for viewing or showing a specific resource.
|
|
6913
|
+
*/
|
|
6914
|
+
export interface ShowResponseRelationCapabilities {
|
|
6915
|
+
/**
|
|
6916
|
+
* A message detailing the result of the operation.
|
|
6917
|
+
*/
|
|
6918
|
+
'message'?: string;
|
|
6919
|
+
/**
|
|
6920
|
+
* The data payload of the response, if any.
|
|
6921
|
+
*/
|
|
6922
|
+
'data'?: RelationCapabilities;
|
|
6923
|
+
}
|
|
6619
6924
|
/**
|
|
6620
6925
|
* Success response (ShowResponseRelationDTO).
|
|
6621
6926
|
*/
|
|
@@ -6716,6 +7021,19 @@ export interface ShowResponseWebMenuDTO {
|
|
|
6716
7021
|
[key: string]: any;
|
|
6717
7022
|
};
|
|
6718
7023
|
}
|
|
7024
|
+
/**
|
|
7025
|
+
* Represents the response for viewing or showing a specific resource.
|
|
7026
|
+
*/
|
|
7027
|
+
export interface ShowResponseWebpageEditorDefaultsDTO {
|
|
7028
|
+
/**
|
|
7029
|
+
* A message detailing the result of the operation.
|
|
7030
|
+
*/
|
|
7031
|
+
'message'?: string;
|
|
7032
|
+
/**
|
|
7033
|
+
* The data payload of the response, if any.
|
|
7034
|
+
*/
|
|
7035
|
+
'data'?: WebpageEditorDefaultsDTO;
|
|
7036
|
+
}
|
|
6719
7037
|
/**
|
|
6720
7038
|
* Represents the response for viewing or showing a specific resource.
|
|
6721
7039
|
*/
|
|
@@ -6760,6 +7078,10 @@ export interface SignedUrlResultDTO {
|
|
|
6760
7078
|
'expiresAt'?: number;
|
|
6761
7079
|
'queryParams'?: string;
|
|
6762
7080
|
}
|
|
7081
|
+
export interface SimpleCompanyDTO {
|
|
7082
|
+
'uuid'?: string;
|
|
7083
|
+
'name'?: string;
|
|
7084
|
+
}
|
|
6763
7085
|
/**
|
|
6764
7086
|
* Data Transfer Object representing a public-facing view of a company
|
|
6765
7087
|
*/
|
|
@@ -7351,6 +7673,19 @@ export interface SuccessResponseCompanyDTO {
|
|
|
7351
7673
|
*/
|
|
7352
7674
|
'data'?: CompanyDTO;
|
|
7353
7675
|
}
|
|
7676
|
+
/**
|
|
7677
|
+
* Represents a standard successful response with a message and optional data.
|
|
7678
|
+
*/
|
|
7679
|
+
export interface SuccessResponseEnsureRelationDTO {
|
|
7680
|
+
/**
|
|
7681
|
+
* A message detailing the result of the operation.
|
|
7682
|
+
*/
|
|
7683
|
+
'message'?: string;
|
|
7684
|
+
/**
|
|
7685
|
+
* The data payload of the response, if any.
|
|
7686
|
+
*/
|
|
7687
|
+
'data'?: EnsureRelationDTO;
|
|
7688
|
+
}
|
|
7354
7689
|
/**
|
|
7355
7690
|
* Represents a standard successful response with a message and optional data.
|
|
7356
7691
|
*/
|
|
@@ -7478,6 +7813,19 @@ export interface SuccessResponseListDeveloperSandboxDTO {
|
|
|
7478
7813
|
*/
|
|
7479
7814
|
'data'?: Array<DeveloperSandboxDTO>;
|
|
7480
7815
|
}
|
|
7816
|
+
/**
|
|
7817
|
+
* Represents a standard successful response with a message and optional data.
|
|
7818
|
+
*/
|
|
7819
|
+
export interface SuccessResponseListFavoriteViewDTO {
|
|
7820
|
+
/**
|
|
7821
|
+
* A message detailing the result of the operation.
|
|
7822
|
+
*/
|
|
7823
|
+
'message'?: string;
|
|
7824
|
+
/**
|
|
7825
|
+
* The data payload of the response, if any.
|
|
7826
|
+
*/
|
|
7827
|
+
'data'?: Array<FavoriteViewDTO>;
|
|
7828
|
+
}
|
|
7481
7829
|
/**
|
|
7482
7830
|
* Represents a standard successful response with a message and optional data.
|
|
7483
7831
|
*/
|
|
@@ -7506,6 +7854,19 @@ export interface SuccessResponseListMapStringObject {
|
|
|
7506
7854
|
[key: string]: any | null;
|
|
7507
7855
|
}>;
|
|
7508
7856
|
}
|
|
7857
|
+
/**
|
|
7858
|
+
* Represents a standard successful response with a message and optional data.
|
|
7859
|
+
*/
|
|
7860
|
+
export interface SuccessResponseListNavigationViewDTO {
|
|
7861
|
+
/**
|
|
7862
|
+
* A message detailing the result of the operation.
|
|
7863
|
+
*/
|
|
7864
|
+
'message'?: string;
|
|
7865
|
+
/**
|
|
7866
|
+
* The data payload of the response, if any.
|
|
7867
|
+
*/
|
|
7868
|
+
'data'?: Array<NavigationViewDTO>;
|
|
7869
|
+
}
|
|
7509
7870
|
/**
|
|
7510
7871
|
* Represents a standard successful response with a message and optional data.
|
|
7511
7872
|
*/
|
|
@@ -7570,6 +7931,19 @@ export interface SuccessResponseMapStringObject {
|
|
|
7570
7931
|
[key: string]: any;
|
|
7571
7932
|
};
|
|
7572
7933
|
}
|
|
7934
|
+
/**
|
|
7935
|
+
* Represents a standard successful response with a message and optional data.
|
|
7936
|
+
*/
|
|
7937
|
+
export interface SuccessResponseNavigationDTO {
|
|
7938
|
+
/**
|
|
7939
|
+
* A message detailing the result of the operation.
|
|
7940
|
+
*/
|
|
7941
|
+
'message'?: string;
|
|
7942
|
+
/**
|
|
7943
|
+
* The data payload of the response, if any.
|
|
7944
|
+
*/
|
|
7945
|
+
'data'?: NavigationDTO;
|
|
7946
|
+
}
|
|
7573
7947
|
/**
|
|
7574
7948
|
* Success response (SuccessResponseObject).
|
|
7575
7949
|
*/
|
|
@@ -7969,6 +8343,24 @@ export interface UsedInResult {
|
|
|
7969
8343
|
'recordUuids'?: Array<string>;
|
|
7970
8344
|
'count'?: number;
|
|
7971
8345
|
}
|
|
8346
|
+
export interface UserDTO {
|
|
8347
|
+
'uuid'?: string;
|
|
8348
|
+
'email'?: string;
|
|
8349
|
+
'firstname'?: string;
|
|
8350
|
+
'lastname'?: string;
|
|
8351
|
+
'initials'?: string;
|
|
8352
|
+
'selectedCompany'?: CompanyDTO;
|
|
8353
|
+
'companies'?: Array<SimpleCompanyDTO>;
|
|
8354
|
+
'scopes'?: Array<string>;
|
|
8355
|
+
'filters'?: {
|
|
8356
|
+
[key: string]: Filter;
|
|
8357
|
+
};
|
|
8358
|
+
'role'?: string;
|
|
8359
|
+
'roles'?: Array<string>;
|
|
8360
|
+
'token'?: ApiTokenDTO;
|
|
8361
|
+
'record'?: ModelRecord;
|
|
8362
|
+
'easterEggs'?: Array<string>;
|
|
8363
|
+
}
|
|
7972
8364
|
/**
|
|
7973
8365
|
* Record response for user API endpoints, including linked user data.
|
|
7974
8366
|
*/
|
|
@@ -8144,6 +8536,17 @@ export interface ViewDTO {
|
|
|
8144
8536
|
'isInternallyPublic'?: boolean;
|
|
8145
8537
|
'analytics'?: AnalyticsDashboardConfig;
|
|
8146
8538
|
}
|
|
8539
|
+
/**
|
|
8540
|
+
* Personal view navigation overrides. Omitted entries preserve their values; a null entry clears that override and restores the legacy sharing default. Does not change sharing or record access.
|
|
8541
|
+
*/
|
|
8542
|
+
export interface ViewNavigationPreferencesRequest {
|
|
8543
|
+
'indices'?: {
|
|
8544
|
+
[key: string]: number;
|
|
8545
|
+
};
|
|
8546
|
+
'favorites'?: {
|
|
8547
|
+
[key: string]: boolean;
|
|
8548
|
+
};
|
|
8549
|
+
}
|
|
8147
8550
|
export interface ViewShareRequest {
|
|
8148
8551
|
'users'?: Array<ModelRecord>;
|
|
8149
8552
|
'teams'?: Array<ModelRecord>;
|
|
@@ -8409,6 +8812,16 @@ export interface WebpageEditingStatusDTO {
|
|
|
8409
8812
|
*/
|
|
8410
8813
|
'message'?: string;
|
|
8411
8814
|
}
|
|
8815
|
+
/**
|
|
8816
|
+
* Read-only style, color and font defaults for an authorized webpage editor. Contains no company administration or executable script configuration.
|
|
8817
|
+
*/
|
|
8818
|
+
export interface WebpageEditorDefaultsDTO {
|
|
8819
|
+
'componentStyles'?: {
|
|
8820
|
+
[key: string]: PageContentStylingDTO;
|
|
8821
|
+
};
|
|
8822
|
+
'palette'?: Palette;
|
|
8823
|
+
'fonts'?: Array<CustomFontDTO>;
|
|
8824
|
+
}
|
|
8412
8825
|
/**
|
|
8413
8826
|
* Resolved public map markers for a webpage map block
|
|
8414
8827
|
*/
|
|
@@ -8795,10 +9208,11 @@ export declare const AppBarsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8795
9208
|
* @param {string} [viewId] View ID in context
|
|
8796
9209
|
* @param {string} [trait] Trait name in context
|
|
8797
9210
|
* @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
|
|
9211
|
+
* @param {ListAppBarsNavigationPlacementEnum} [navigationPlacement] TOOL_BAR placement. Omitted means legacy SUITE; SETTINGS is suite-independent.
|
|
8798
9212
|
* @param {*} [options] Override http request option.
|
|
8799
9213
|
* @throws {RequiredError}
|
|
8800
9214
|
*/
|
|
8801
|
-
listAppBars: (location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, suite?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9215
|
+
listAppBars: (location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, suite?: string, navigationPlacement?: ListAppBarsNavigationPlacementEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8802
9216
|
/**
|
|
8803
9217
|
* Fires the app bar webhook with optional settings values and record/view context.
|
|
8804
9218
|
* @summary Trigger an action-based app bar
|
|
@@ -8822,10 +9236,11 @@ export declare const AppBarsApiFp: (configuration?: Configuration) => {
|
|
|
8822
9236
|
* @param {string} [viewId] View ID in context
|
|
8823
9237
|
* @param {string} [trait] Trait name in context
|
|
8824
9238
|
* @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
|
|
9239
|
+
* @param {ListAppBarsNavigationPlacementEnum} [navigationPlacement] TOOL_BAR placement. Omitted means legacy SUITE; SETTINGS is suite-independent.
|
|
8825
9240
|
* @param {*} [options] Override http request option.
|
|
8826
9241
|
* @throws {RequiredError}
|
|
8827
9242
|
*/
|
|
8828
|
-
listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, suite?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseListInstalledAppBarDTO>>;
|
|
9243
|
+
listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, suite?: string, navigationPlacement?: ListAppBarsNavigationPlacementEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseListInstalledAppBarDTO>>;
|
|
8829
9244
|
/**
|
|
8830
9245
|
* Fires the app bar webhook with optional settings values and record/view context.
|
|
8831
9246
|
* @summary Trigger an action-based app bar
|
|
@@ -8849,10 +9264,11 @@ export declare const AppBarsApiFactory: (configuration?: Configuration, basePath
|
|
|
8849
9264
|
* @param {string} [viewId] View ID in context
|
|
8850
9265
|
* @param {string} [trait] Trait name in context
|
|
8851
9266
|
* @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
|
|
9267
|
+
* @param {ListAppBarsNavigationPlacementEnum} [navigationPlacement] TOOL_BAR placement. Omitted means legacy SUITE; SETTINGS is suite-independent.
|
|
8852
9268
|
* @param {*} [options] Override http request option.
|
|
8853
9269
|
* @throws {RequiredError}
|
|
8854
9270
|
*/
|
|
8855
|
-
listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, suite?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseListInstalledAppBarDTO>;
|
|
9271
|
+
listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, suite?: string, navigationPlacement?: ListAppBarsNavigationPlacementEnum, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseListInstalledAppBarDTO>;
|
|
8856
9272
|
/**
|
|
8857
9273
|
* Fires the app bar webhook with optional settings values and record/view context.
|
|
8858
9274
|
* @summary Trigger an action-based app bar
|
|
@@ -8876,10 +9292,11 @@ export declare class AppBarsApi extends BaseAPI {
|
|
|
8876
9292
|
* @param {string} [viewId] View ID in context
|
|
8877
9293
|
* @param {string} [trait] Trait name in context
|
|
8878
9294
|
* @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
|
|
9295
|
+
* @param {ListAppBarsNavigationPlacementEnum} [navigationPlacement] TOOL_BAR placement. Omitted means legacy SUITE; SETTINGS is suite-independent.
|
|
8879
9296
|
* @param {*} [options] Override http request option.
|
|
8880
9297
|
* @throws {RequiredError}
|
|
8881
9298
|
*/
|
|
8882
|
-
listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, suite?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseListInstalledAppBarDTO, any, {}>>;
|
|
9299
|
+
listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, suite?: string, navigationPlacement?: ListAppBarsNavigationPlacementEnum, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseListInstalledAppBarDTO, any, {}>>;
|
|
8883
9300
|
/**
|
|
8884
9301
|
* Fires the app bar webhook with optional settings values and record/view context.
|
|
8885
9302
|
* @summary Trigger an action-based app bar
|
|
@@ -8899,6 +9316,11 @@ export declare const ListAppBarsLocationEnum: {
|
|
|
8899
9316
|
readonly RecordTrait: "RECORD_TRAIT";
|
|
8900
9317
|
};
|
|
8901
9318
|
export type ListAppBarsLocationEnum = typeof ListAppBarsLocationEnum[keyof typeof ListAppBarsLocationEnum];
|
|
9319
|
+
export declare const ListAppBarsNavigationPlacementEnum: {
|
|
9320
|
+
readonly Suite: "SUITE";
|
|
9321
|
+
readonly Settings: "SETTINGS";
|
|
9322
|
+
};
|
|
9323
|
+
export type ListAppBarsNavigationPlacementEnum = typeof ListAppBarsNavigationPlacementEnum[keyof typeof ListAppBarsNavigationPlacementEnum];
|
|
8902
9324
|
/**
|
|
8903
9325
|
* AppInstallationRuntimeApi - axios parameter creator
|
|
8904
9326
|
*/
|
|
@@ -10978,38 +11400,154 @@ export declare class BillingApi extends BaseAPI {
|
|
|
10978
11400
|
sendSetupEmail(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringBoolean, any, {}>>;
|
|
10979
11401
|
}
|
|
10980
11402
|
/**
|
|
10981
|
-
*
|
|
11403
|
+
* BrowserAuthenticationApi - axios parameter creator
|
|
10982
11404
|
*/
|
|
10983
|
-
export declare const
|
|
11405
|
+
export declare const BrowserAuthenticationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
10984
11406
|
/**
|
|
10985
|
-
*
|
|
10986
|
-
* @summary
|
|
10987
|
-
* @param {string}
|
|
11407
|
+
*
|
|
11408
|
+
* @summary Open the browser-owned provider session
|
|
11409
|
+
* @param {string} flow
|
|
10988
11410
|
* @param {*} [options] Override http request option.
|
|
10989
11411
|
* @throws {RequiredError}
|
|
10990
11412
|
*/
|
|
10991
|
-
|
|
11413
|
+
authorize: (flow: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10992
11414
|
/**
|
|
10993
|
-
*
|
|
10994
|
-
* @summary
|
|
10995
|
-
* @param {
|
|
10996
|
-
* @param {{ [key: string]: any | null; }} requestBody
|
|
11415
|
+
* Exchanges an unexpired single-use code only after exact redirect and PKCE verifier checks. Access/refresh tokens are returned in JSON and never in callback URLs.
|
|
11416
|
+
* @summary Exchange a native callback code
|
|
11417
|
+
* @param {BrowserAuthExchangeRequest} browserAuthExchangeRequest
|
|
10997
11418
|
* @param {*} [options] Override http request option.
|
|
10998
11419
|
* @throws {RequiredError}
|
|
10999
11420
|
*/
|
|
11000
|
-
|
|
11001
|
-
[key: string]: any | null;
|
|
11002
|
-
}, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11421
|
+
exchange: (browserAuthExchangeRequest: BrowserAuthExchangeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11003
11422
|
/**
|
|
11004
|
-
*
|
|
11005
|
-
* @summary
|
|
11006
|
-
* @param {
|
|
11007
|
-
* @param {{ [key: string]: any | null; }} requestBody
|
|
11423
|
+
* Requires an exact configured redirect URI, random client state and S256 PKCE challenge. Open the returned URL in the system browser.
|
|
11424
|
+
* @summary Start browser sign-in
|
|
11425
|
+
* @param {BrowserAuthStartRequest} browserAuthStartRequest
|
|
11008
11426
|
* @param {*} [options] Override http request option.
|
|
11009
11427
|
* @throws {RequiredError}
|
|
11010
11428
|
*/
|
|
11011
|
-
|
|
11012
|
-
|
|
11429
|
+
start: (browserAuthStartRequest: BrowserAuthStartRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11430
|
+
};
|
|
11431
|
+
/**
|
|
11432
|
+
* BrowserAuthenticationApi - functional programming interface
|
|
11433
|
+
*/
|
|
11434
|
+
export declare const BrowserAuthenticationApiFp: (configuration?: Configuration) => {
|
|
11435
|
+
/**
|
|
11436
|
+
*
|
|
11437
|
+
* @summary Open the browser-owned provider session
|
|
11438
|
+
* @param {string} flow
|
|
11439
|
+
* @param {*} [options] Override http request option.
|
|
11440
|
+
* @throws {RequiredError}
|
|
11441
|
+
*/
|
|
11442
|
+
authorize(flow: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
11443
|
+
/**
|
|
11444
|
+
* Exchanges an unexpired single-use code only after exact redirect and PKCE verifier checks. Access/refresh tokens are returned in JSON and never in callback URLs.
|
|
11445
|
+
* @summary Exchange a native callback code
|
|
11446
|
+
* @param {BrowserAuthExchangeRequest} browserAuthExchangeRequest
|
|
11447
|
+
* @param {*} [options] Override http request option.
|
|
11448
|
+
* @throws {RequiredError}
|
|
11449
|
+
*/
|
|
11450
|
+
exchange(browserAuthExchangeRequest: BrowserAuthExchangeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseBrowserAuthSessionResponse>>;
|
|
11451
|
+
/**
|
|
11452
|
+
* Requires an exact configured redirect URI, random client state and S256 PKCE challenge. Open the returned URL in the system browser.
|
|
11453
|
+
* @summary Start browser sign-in
|
|
11454
|
+
* @param {BrowserAuthStartRequest} browserAuthStartRequest
|
|
11455
|
+
* @param {*} [options] Override http request option.
|
|
11456
|
+
* @throws {RequiredError}
|
|
11457
|
+
*/
|
|
11458
|
+
start(browserAuthStartRequest: BrowserAuthStartRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseBrowserAuthStartResponse>>;
|
|
11459
|
+
};
|
|
11460
|
+
/**
|
|
11461
|
+
* BrowserAuthenticationApi - factory interface
|
|
11462
|
+
*/
|
|
11463
|
+
export declare const BrowserAuthenticationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
11464
|
+
/**
|
|
11465
|
+
*
|
|
11466
|
+
* @summary Open the browser-owned provider session
|
|
11467
|
+
* @param {string} flow
|
|
11468
|
+
* @param {*} [options] Override http request option.
|
|
11469
|
+
* @throws {RequiredError}
|
|
11470
|
+
*/
|
|
11471
|
+
authorize(flow: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
11472
|
+
/**
|
|
11473
|
+
* Exchanges an unexpired single-use code only after exact redirect and PKCE verifier checks. Access/refresh tokens are returned in JSON and never in callback URLs.
|
|
11474
|
+
* @summary Exchange a native callback code
|
|
11475
|
+
* @param {BrowserAuthExchangeRequest} browserAuthExchangeRequest
|
|
11476
|
+
* @param {*} [options] Override http request option.
|
|
11477
|
+
* @throws {RequiredError}
|
|
11478
|
+
*/
|
|
11479
|
+
exchange(browserAuthExchangeRequest: BrowserAuthExchangeRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseBrowserAuthSessionResponse>;
|
|
11480
|
+
/**
|
|
11481
|
+
* Requires an exact configured redirect URI, random client state and S256 PKCE challenge. Open the returned URL in the system browser.
|
|
11482
|
+
* @summary Start browser sign-in
|
|
11483
|
+
* @param {BrowserAuthStartRequest} browserAuthStartRequest
|
|
11484
|
+
* @param {*} [options] Override http request option.
|
|
11485
|
+
* @throws {RequiredError}
|
|
11486
|
+
*/
|
|
11487
|
+
start(browserAuthStartRequest: BrowserAuthStartRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseBrowserAuthStartResponse>;
|
|
11488
|
+
};
|
|
11489
|
+
/**
|
|
11490
|
+
* BrowserAuthenticationApi - object-oriented interface
|
|
11491
|
+
*/
|
|
11492
|
+
export declare class BrowserAuthenticationApi extends BaseAPI {
|
|
11493
|
+
/**
|
|
11494
|
+
*
|
|
11495
|
+
* @summary Open the browser-owned provider session
|
|
11496
|
+
* @param {string} flow
|
|
11497
|
+
* @param {*} [options] Override http request option.
|
|
11498
|
+
* @throws {RequiredError}
|
|
11499
|
+
*/
|
|
11500
|
+
authorize(flow: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}>>;
|
|
11501
|
+
/**
|
|
11502
|
+
* Exchanges an unexpired single-use code only after exact redirect and PKCE verifier checks. Access/refresh tokens are returned in JSON and never in callback URLs.
|
|
11503
|
+
* @summary Exchange a native callback code
|
|
11504
|
+
* @param {BrowserAuthExchangeRequest} browserAuthExchangeRequest
|
|
11505
|
+
* @param {*} [options] Override http request option.
|
|
11506
|
+
* @throws {RequiredError}
|
|
11507
|
+
*/
|
|
11508
|
+
exchange(browserAuthExchangeRequest: BrowserAuthExchangeRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseBrowserAuthSessionResponse, any, {}>>;
|
|
11509
|
+
/**
|
|
11510
|
+
* Requires an exact configured redirect URI, random client state and S256 PKCE challenge. Open the returned URL in the system browser.
|
|
11511
|
+
* @summary Start browser sign-in
|
|
11512
|
+
* @param {BrowserAuthStartRequest} browserAuthStartRequest
|
|
11513
|
+
* @param {*} [options] Override http request option.
|
|
11514
|
+
* @throws {RequiredError}
|
|
11515
|
+
*/
|
|
11516
|
+
start(browserAuthStartRequest: BrowserAuthStartRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseBrowserAuthStartResponse, any, {}>>;
|
|
11517
|
+
}
|
|
11518
|
+
/**
|
|
11519
|
+
* CMSModulesApi - axios parameter creator
|
|
11520
|
+
*/
|
|
11521
|
+
export declare const CMSModulesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
11522
|
+
/**
|
|
11523
|
+
* Includes retired modules, so a developer can see what a push removed.
|
|
11524
|
+
* @summary List an app\'s CMS modules
|
|
11525
|
+
* @param {string} appUuid
|
|
11526
|
+
* @param {*} [options] Override http request option.
|
|
11527
|
+
* @throws {RequiredError}
|
|
11528
|
+
*/
|
|
11529
|
+
list: (appUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11530
|
+
/**
|
|
11531
|
+
* Accepts a staged npm tarball (base64) and module manifests. Publishes to the platform registry with the host token, then replaces the catalog.
|
|
11532
|
+
* @summary Publish an app\'s CMS module package
|
|
11533
|
+
* @param {string} appUuid
|
|
11534
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
11535
|
+
* @param {*} [options] Override http request option.
|
|
11536
|
+
* @throws {RequiredError}
|
|
11537
|
+
*/
|
|
11538
|
+
publishPackage: (appUuid: string, requestBody: {
|
|
11539
|
+
[key: string]: any | null;
|
|
11540
|
+
}, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11541
|
+
/**
|
|
11542
|
+
* Registers the modules shipped by a published package version. Modules missing from the payload are retired rather than deleted, because pages may still reference them.
|
|
11543
|
+
* @summary Replace an app\'s CMS module catalog
|
|
11544
|
+
* @param {string} appUuid
|
|
11545
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
11546
|
+
* @param {*} [options] Override http request option.
|
|
11547
|
+
* @throws {RequiredError}
|
|
11548
|
+
*/
|
|
11549
|
+
upsert: (appUuid: string, requestBody: {
|
|
11550
|
+
[key: string]: any | null;
|
|
11013
11551
|
}, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11014
11552
|
};
|
|
11015
11553
|
/**
|
|
@@ -15509,6 +16047,186 @@ export declare class ModuleApi extends BaseAPI {
|
|
|
15509
16047
|
*/
|
|
15510
16048
|
updatePersonalModule(moduleId: string, pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
15511
16049
|
}
|
|
16050
|
+
/**
|
|
16051
|
+
* NavigationApi - axios parameter creator
|
|
16052
|
+
*/
|
|
16053
|
+
export declare const NavigationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
16054
|
+
/**
|
|
16055
|
+
* Selected-company favorites across objects. Archived readable favorites require includeArchived=true. Each result carries only object identity/capability names and view navigation metadata.
|
|
16056
|
+
* @summary Read authorized favorite views
|
|
16057
|
+
* @param {boolean} [includeArchived]
|
|
16058
|
+
* @param {*} [options] Override http request option.
|
|
16059
|
+
* @throws {RequiredError}
|
|
16060
|
+
*/
|
|
16061
|
+
favorites: (includeArchived?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16062
|
+
/**
|
|
16063
|
+
* Selected-company object and view summaries with permission-gated menus. Does not load schemas, users, scopes, branding or dashboards.
|
|
16064
|
+
* @summary Read authorized navigation
|
|
16065
|
+
* @param {*} [options] Override http request option.
|
|
16066
|
+
* @throws {RequiredError}
|
|
16067
|
+
*/
|
|
16068
|
+
navigation: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16069
|
+
/**
|
|
16070
|
+
* 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.
|
|
16071
|
+
* @summary Set personal view navigation preferences
|
|
16072
|
+
* @param {string} objectUuid
|
|
16073
|
+
* @param {ViewNavigationPreferencesRequest} viewNavigationPreferencesRequest
|
|
16074
|
+
* @param {*} [options] Override http request option.
|
|
16075
|
+
* @throws {RequiredError}
|
|
16076
|
+
*/
|
|
16077
|
+
preferences: (objectUuid: string, viewNavigationPreferencesRequest: ViewNavigationPreferencesRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16078
|
+
/**
|
|
16079
|
+
* 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.
|
|
16080
|
+
* @summary Read available access scopes
|
|
16081
|
+
* @param {*} [options] Override http request option.
|
|
16082
|
+
* @throws {RequiredError}
|
|
16083
|
+
*/
|
|
16084
|
+
scopes: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16085
|
+
/**
|
|
16086
|
+
* Intent-loaded selected-company metadata. Archived readable views are included only with includeArchived=true; no filters, schemas or sharing grants are returned.
|
|
16087
|
+
* @summary Read authorized view navigation summaries
|
|
16088
|
+
* @param {string} objectUuid
|
|
16089
|
+
* @param {boolean} [includeArchived]
|
|
16090
|
+
* @param {*} [options] Override http request option.
|
|
16091
|
+
* @throws {RequiredError}
|
|
16092
|
+
*/
|
|
16093
|
+
views: (objectUuid: string, includeArchived?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16094
|
+
};
|
|
16095
|
+
/**
|
|
16096
|
+
* NavigationApi - functional programming interface
|
|
16097
|
+
*/
|
|
16098
|
+
export declare const NavigationApiFp: (configuration?: Configuration) => {
|
|
16099
|
+
/**
|
|
16100
|
+
* Selected-company favorites across objects. Archived readable favorites require includeArchived=true. Each result carries only object identity/capability names and view navigation metadata.
|
|
16101
|
+
* @summary Read authorized favorite views
|
|
16102
|
+
* @param {boolean} [includeArchived]
|
|
16103
|
+
* @param {*} [options] Override http request option.
|
|
16104
|
+
* @throws {RequiredError}
|
|
16105
|
+
*/
|
|
16106
|
+
favorites(includeArchived?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseListFavoriteViewDTO>>;
|
|
16107
|
+
/**
|
|
16108
|
+
* Selected-company object and view summaries with permission-gated menus. Does not load schemas, users, scopes, branding or dashboards.
|
|
16109
|
+
* @summary Read authorized navigation
|
|
16110
|
+
* @param {*} [options] Override http request option.
|
|
16111
|
+
* @throws {RequiredError}
|
|
16112
|
+
*/
|
|
16113
|
+
navigation(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseNavigationDTO>>;
|
|
16114
|
+
/**
|
|
16115
|
+
* 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.
|
|
16116
|
+
* @summary Set personal view navigation preferences
|
|
16117
|
+
* @param {string} objectUuid
|
|
16118
|
+
* @param {ViewNavigationPreferencesRequest} viewNavigationPreferencesRequest
|
|
16119
|
+
* @param {*} [options] Override http request option.
|
|
16120
|
+
* @throws {RequiredError}
|
|
16121
|
+
*/
|
|
16122
|
+
preferences(objectUuid: string, viewNavigationPreferencesRequest: ViewNavigationPreferencesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseListNavigationViewDTO>>;
|
|
16123
|
+
/**
|
|
16124
|
+
* 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.
|
|
16125
|
+
* @summary Read available access scopes
|
|
16126
|
+
* @param {*} [options] Override http request option.
|
|
16127
|
+
* @throws {RequiredError}
|
|
16128
|
+
*/
|
|
16129
|
+
scopes(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseListString>>;
|
|
16130
|
+
/**
|
|
16131
|
+
* Intent-loaded selected-company metadata. Archived readable views are included only with includeArchived=true; no filters, schemas or sharing grants are returned.
|
|
16132
|
+
* @summary Read authorized view navigation summaries
|
|
16133
|
+
* @param {string} objectUuid
|
|
16134
|
+
* @param {boolean} [includeArchived]
|
|
16135
|
+
* @param {*} [options] Override http request option.
|
|
16136
|
+
* @throws {RequiredError}
|
|
16137
|
+
*/
|
|
16138
|
+
views(objectUuid: string, includeArchived?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseListNavigationViewDTO>>;
|
|
16139
|
+
};
|
|
16140
|
+
/**
|
|
16141
|
+
* NavigationApi - factory interface
|
|
16142
|
+
*/
|
|
16143
|
+
export declare const NavigationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
16144
|
+
/**
|
|
16145
|
+
* Selected-company favorites across objects. Archived readable favorites require includeArchived=true. Each result carries only object identity/capability names and view navigation metadata.
|
|
16146
|
+
* @summary Read authorized favorite views
|
|
16147
|
+
* @param {boolean} [includeArchived]
|
|
16148
|
+
* @param {*} [options] Override http request option.
|
|
16149
|
+
* @throws {RequiredError}
|
|
16150
|
+
*/
|
|
16151
|
+
favorites(includeArchived?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseListFavoriteViewDTO>;
|
|
16152
|
+
/**
|
|
16153
|
+
* Selected-company object and view summaries with permission-gated menus. Does not load schemas, users, scopes, branding or dashboards.
|
|
16154
|
+
* @summary Read authorized navigation
|
|
16155
|
+
* @param {*} [options] Override http request option.
|
|
16156
|
+
* @throws {RequiredError}
|
|
16157
|
+
*/
|
|
16158
|
+
navigation(options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseNavigationDTO>;
|
|
16159
|
+
/**
|
|
16160
|
+
* 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.
|
|
16161
|
+
* @summary Set personal view navigation preferences
|
|
16162
|
+
* @param {string} objectUuid
|
|
16163
|
+
* @param {ViewNavigationPreferencesRequest} viewNavigationPreferencesRequest
|
|
16164
|
+
* @param {*} [options] Override http request option.
|
|
16165
|
+
* @throws {RequiredError}
|
|
16166
|
+
*/
|
|
16167
|
+
preferences(objectUuid: string, viewNavigationPreferencesRequest: ViewNavigationPreferencesRequest, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseListNavigationViewDTO>;
|
|
16168
|
+
/**
|
|
16169
|
+
* 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.
|
|
16170
|
+
* @summary Read available access scopes
|
|
16171
|
+
* @param {*} [options] Override http request option.
|
|
16172
|
+
* @throws {RequiredError}
|
|
16173
|
+
*/
|
|
16174
|
+
scopes(options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseListString>;
|
|
16175
|
+
/**
|
|
16176
|
+
* Intent-loaded selected-company metadata. Archived readable views are included only with includeArchived=true; no filters, schemas or sharing grants are returned.
|
|
16177
|
+
* @summary Read authorized view navigation summaries
|
|
16178
|
+
* @param {string} objectUuid
|
|
16179
|
+
* @param {boolean} [includeArchived]
|
|
16180
|
+
* @param {*} [options] Override http request option.
|
|
16181
|
+
* @throws {RequiredError}
|
|
16182
|
+
*/
|
|
16183
|
+
views(objectUuid: string, includeArchived?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseListNavigationViewDTO>;
|
|
16184
|
+
};
|
|
16185
|
+
/**
|
|
16186
|
+
* NavigationApi - object-oriented interface
|
|
16187
|
+
*/
|
|
16188
|
+
export declare class NavigationApi extends BaseAPI {
|
|
16189
|
+
/**
|
|
16190
|
+
* Selected-company favorites across objects. Archived readable favorites require includeArchived=true. Each result carries only object identity/capability names and view navigation metadata.
|
|
16191
|
+
* @summary Read authorized favorite views
|
|
16192
|
+
* @param {boolean} [includeArchived]
|
|
16193
|
+
* @param {*} [options] Override http request option.
|
|
16194
|
+
* @throws {RequiredError}
|
|
16195
|
+
*/
|
|
16196
|
+
favorites(includeArchived?: boolean, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListFavoriteViewDTO, any, {}>>;
|
|
16197
|
+
/**
|
|
16198
|
+
* Selected-company object and view summaries with permission-gated menus. Does not load schemas, users, scopes, branding or dashboards.
|
|
16199
|
+
* @summary Read authorized navigation
|
|
16200
|
+
* @param {*} [options] Override http request option.
|
|
16201
|
+
* @throws {RequiredError}
|
|
16202
|
+
*/
|
|
16203
|
+
navigation(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseNavigationDTO, any, {}>>;
|
|
16204
|
+
/**
|
|
16205
|
+
* 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.
|
|
16206
|
+
* @summary Set personal view navigation preferences
|
|
16207
|
+
* @param {string} objectUuid
|
|
16208
|
+
* @param {ViewNavigationPreferencesRequest} viewNavigationPreferencesRequest
|
|
16209
|
+
* @param {*} [options] Override http request option.
|
|
16210
|
+
* @throws {RequiredError}
|
|
16211
|
+
*/
|
|
16212
|
+
preferences(objectUuid: string, viewNavigationPreferencesRequest: ViewNavigationPreferencesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListNavigationViewDTO, any, {}>>;
|
|
16213
|
+
/**
|
|
16214
|
+
* 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.
|
|
16215
|
+
* @summary Read available access scopes
|
|
16216
|
+
* @param {*} [options] Override http request option.
|
|
16217
|
+
* @throws {RequiredError}
|
|
16218
|
+
*/
|
|
16219
|
+
scopes(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListString, any, {}>>;
|
|
16220
|
+
/**
|
|
16221
|
+
* Intent-loaded selected-company metadata. Archived readable views are included only with includeArchived=true; no filters, schemas or sharing grants are returned.
|
|
16222
|
+
* @summary Read authorized view navigation summaries
|
|
16223
|
+
* @param {string} objectUuid
|
|
16224
|
+
* @param {boolean} [includeArchived]
|
|
16225
|
+
* @param {*} [options] Override http request option.
|
|
16226
|
+
* @throws {RequiredError}
|
|
16227
|
+
*/
|
|
16228
|
+
views(objectUuid: string, includeArchived?: boolean, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseListNavigationViewDTO, any, {}>>;
|
|
16229
|
+
}
|
|
15512
16230
|
/**
|
|
15513
16231
|
* NotificationsApi - axios parameter creator
|
|
15514
16232
|
*/
|
|
@@ -15528,6 +16246,14 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
15528
16246
|
* @throws {RequiredError}
|
|
15529
16247
|
*/
|
|
15530
16248
|
firebaseToken: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16249
|
+
/**
|
|
16250
|
+
* Returns an inbox entry only for its human recipient in the authorized selected company, including entries outside the inbox page.
|
|
16251
|
+
* @summary Get an authoritative notification by ID
|
|
16252
|
+
* @param {string} notificationId
|
|
16253
|
+
* @param {*} [options] Override http request option.
|
|
16254
|
+
* @throws {RequiredError}
|
|
16255
|
+
*/
|
|
16256
|
+
getNotification: (notificationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15531
16257
|
/**
|
|
15532
16258
|
* Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
|
|
15533
16259
|
* @summary List in-app notifications for the logged-in user
|
|
@@ -15552,6 +16278,15 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
15552
16278
|
* @throws {RequiredError}
|
|
15553
16279
|
*/
|
|
15554
16280
|
markAsRead: (notificationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16281
|
+
/**
|
|
16282
|
+
* Idempotently registers an allowed native application. Human authentication required. Does not accept a target user or company. Rotate the registration when moving between accounts.
|
|
16283
|
+
* @summary Register this user\'s native notification device
|
|
16284
|
+
* @param {string} deviceInstallationId
|
|
16285
|
+
* @param {NotificationDeviceRegistration} notificationDeviceRegistration
|
|
16286
|
+
* @param {*} [options] Override http request option.
|
|
16287
|
+
* @throws {RequiredError}
|
|
16288
|
+
*/
|
|
16289
|
+
registerDevice: (deviceInstallationId: string, notificationDeviceRegistration: NotificationDeviceRegistration, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15555
16290
|
/**
|
|
15556
16291
|
* Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member.
|
|
15557
16292
|
* @summary Send a notification (app token)
|
|
@@ -15560,6 +16295,14 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
15560
16295
|
* @throws {RequiredError}
|
|
15561
16296
|
*/
|
|
15562
16297
|
sendNotification: (sendNotificationRequest: SendNotificationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16298
|
+
/**
|
|
16299
|
+
* Idempotent. Call before logout; other users\' device registrations are inaccessible.
|
|
16300
|
+
* @summary Unregister this user\'s native notification device
|
|
16301
|
+
* @param {string} deviceInstallationId
|
|
16302
|
+
* @param {*} [options] Override http request option.
|
|
16303
|
+
* @throws {RequiredError}
|
|
16304
|
+
*/
|
|
16305
|
+
unregisterDevice: (deviceInstallationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15563
16306
|
};
|
|
15564
16307
|
/**
|
|
15565
16308
|
* NotificationsApi - functional programming interface
|
|
@@ -15580,6 +16323,14 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
|
|
|
15580
16323
|
* @throws {RequiredError}
|
|
15581
16324
|
*/
|
|
15582
16325
|
firebaseToken(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringString>>;
|
|
16326
|
+
/**
|
|
16327
|
+
* Returns an inbox entry only for its human recipient in the authorized selected company, including entries outside the inbox page.
|
|
16328
|
+
* @summary Get an authoritative notification by ID
|
|
16329
|
+
* @param {string} notificationId
|
|
16330
|
+
* @param {*} [options] Override http request option.
|
|
16331
|
+
* @throws {RequiredError}
|
|
16332
|
+
*/
|
|
16333
|
+
getNotification(notificationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseItem>>;
|
|
15583
16334
|
/**
|
|
15584
16335
|
* Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
|
|
15585
16336
|
* @summary List in-app notifications for the logged-in user
|
|
@@ -15604,6 +16355,15 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
|
|
|
15604
16355
|
* @throws {RequiredError}
|
|
15605
16356
|
*/
|
|
15606
16357
|
markAsRead(notificationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseString>>;
|
|
16358
|
+
/**
|
|
16359
|
+
* Idempotently registers an allowed native application. Human authentication required. Does not accept a target user or company. Rotate the registration when moving between accounts.
|
|
16360
|
+
* @summary Register this user\'s native notification device
|
|
16361
|
+
* @param {string} deviceInstallationId
|
|
16362
|
+
* @param {NotificationDeviceRegistration} notificationDeviceRegistration
|
|
16363
|
+
* @param {*} [options] Override http request option.
|
|
16364
|
+
* @throws {RequiredError}
|
|
16365
|
+
*/
|
|
16366
|
+
registerDevice(deviceInstallationId: string, notificationDeviceRegistration: NotificationDeviceRegistration, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseNotificationDeviceReceipt>>;
|
|
15607
16367
|
/**
|
|
15608
16368
|
* Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member.
|
|
15609
16369
|
* @summary Send a notification (app token)
|
|
@@ -15612,6 +16372,14 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
|
|
|
15612
16372
|
* @throws {RequiredError}
|
|
15613
16373
|
*/
|
|
15614
16374
|
sendNotification(sendNotificationRequest: SendNotificationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateResponseMapStringString>>;
|
|
16375
|
+
/**
|
|
16376
|
+
* Idempotent. Call before logout; other users\' device registrations are inaccessible.
|
|
16377
|
+
* @summary Unregister this user\'s native notification device
|
|
16378
|
+
* @param {string} deviceInstallationId
|
|
16379
|
+
* @param {*} [options] Override http request option.
|
|
16380
|
+
* @throws {RequiredError}
|
|
16381
|
+
*/
|
|
16382
|
+
unregisterDevice(deviceInstallationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseString>>;
|
|
15615
16383
|
};
|
|
15616
16384
|
/**
|
|
15617
16385
|
* NotificationsApi - factory interface
|
|
@@ -15632,6 +16400,14 @@ export declare const NotificationsApiFactory: (configuration?: Configuration, ba
|
|
|
15632
16400
|
* @throws {RequiredError}
|
|
15633
16401
|
*/
|
|
15634
16402
|
firebaseToken(options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringString>;
|
|
16403
|
+
/**
|
|
16404
|
+
* Returns an inbox entry only for its human recipient in the authorized selected company, including entries outside the inbox page.
|
|
16405
|
+
* @summary Get an authoritative notification by ID
|
|
16406
|
+
* @param {string} notificationId
|
|
16407
|
+
* @param {*} [options] Override http request option.
|
|
16408
|
+
* @throws {RequiredError}
|
|
16409
|
+
*/
|
|
16410
|
+
getNotification(notificationId: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseItem>;
|
|
15635
16411
|
/**
|
|
15636
16412
|
* Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
|
|
15637
16413
|
* @summary List in-app notifications for the logged-in user
|
|
@@ -15656,6 +16432,15 @@ export declare const NotificationsApiFactory: (configuration?: Configuration, ba
|
|
|
15656
16432
|
* @throws {RequiredError}
|
|
15657
16433
|
*/
|
|
15658
16434
|
markAsRead(notificationId: string, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseString>;
|
|
16435
|
+
/**
|
|
16436
|
+
* Idempotently registers an allowed native application. Human authentication required. Does not accept a target user or company. Rotate the registration when moving between accounts.
|
|
16437
|
+
* @summary Register this user\'s native notification device
|
|
16438
|
+
* @param {string} deviceInstallationId
|
|
16439
|
+
* @param {NotificationDeviceRegistration} notificationDeviceRegistration
|
|
16440
|
+
* @param {*} [options] Override http request option.
|
|
16441
|
+
* @throws {RequiredError}
|
|
16442
|
+
*/
|
|
16443
|
+
registerDevice(deviceInstallationId: string, notificationDeviceRegistration: NotificationDeviceRegistration, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseNotificationDeviceReceipt>;
|
|
15659
16444
|
/**
|
|
15660
16445
|
* Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member.
|
|
15661
16446
|
* @summary Send a notification (app token)
|
|
@@ -15664,6 +16449,14 @@ export declare const NotificationsApiFactory: (configuration?: Configuration, ba
|
|
|
15664
16449
|
* @throws {RequiredError}
|
|
15665
16450
|
*/
|
|
15666
16451
|
sendNotification(sendNotificationRequest: SendNotificationRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateResponseMapStringString>;
|
|
16452
|
+
/**
|
|
16453
|
+
* Idempotent. Call before logout; other users\' device registrations are inaccessible.
|
|
16454
|
+
* @summary Unregister this user\'s native notification device
|
|
16455
|
+
* @param {string} deviceInstallationId
|
|
16456
|
+
* @param {*} [options] Override http request option.
|
|
16457
|
+
* @throws {RequiredError}
|
|
16458
|
+
*/
|
|
16459
|
+
unregisterDevice(deviceInstallationId: string, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseString>;
|
|
15667
16460
|
};
|
|
15668
16461
|
/**
|
|
15669
16462
|
* NotificationsApi - object-oriented interface
|
|
@@ -15684,6 +16477,14 @@ export declare class NotificationsApi extends BaseAPI {
|
|
|
15684
16477
|
* @throws {RequiredError}
|
|
15685
16478
|
*/
|
|
15686
16479
|
firebaseToken(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringString, any, {}>>;
|
|
16480
|
+
/**
|
|
16481
|
+
* Returns an inbox entry only for its human recipient in the authorized selected company, including entries outside the inbox page.
|
|
16482
|
+
* @summary Get an authoritative notification by ID
|
|
16483
|
+
* @param {string} notificationId
|
|
16484
|
+
* @param {*} [options] Override http request option.
|
|
16485
|
+
* @throws {RequiredError}
|
|
16486
|
+
*/
|
|
16487
|
+
getNotification(notificationId: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseItem, any, {}>>;
|
|
15687
16488
|
/**
|
|
15688
16489
|
* Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
|
|
15689
16490
|
* @summary List in-app notifications for the logged-in user
|
|
@@ -15708,6 +16509,15 @@ export declare class NotificationsApi extends BaseAPI {
|
|
|
15708
16509
|
* @throws {RequiredError}
|
|
15709
16510
|
*/
|
|
15710
16511
|
markAsRead(notificationId: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
16512
|
+
/**
|
|
16513
|
+
* Idempotently registers an allowed native application. Human authentication required. Does not accept a target user or company. Rotate the registration when moving between accounts.
|
|
16514
|
+
* @summary Register this user\'s native notification device
|
|
16515
|
+
* @param {string} deviceInstallationId
|
|
16516
|
+
* @param {NotificationDeviceRegistration} notificationDeviceRegistration
|
|
16517
|
+
* @param {*} [options] Override http request option.
|
|
16518
|
+
* @throws {RequiredError}
|
|
16519
|
+
*/
|
|
16520
|
+
registerDevice(deviceInstallationId: string, notificationDeviceRegistration: NotificationDeviceRegistration, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseNotificationDeviceReceipt, any, {}>>;
|
|
15711
16521
|
/**
|
|
15712
16522
|
* Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member.
|
|
15713
16523
|
* @summary Send a notification (app token)
|
|
@@ -15716,6 +16526,14 @@ export declare class NotificationsApi extends BaseAPI {
|
|
|
15716
16526
|
* @throws {RequiredError}
|
|
15717
16527
|
*/
|
|
15718
16528
|
sendNotification(sendNotificationRequest: SendNotificationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateResponseMapStringString, any, {}>>;
|
|
16529
|
+
/**
|
|
16530
|
+
* Idempotent. Call before logout; other users\' device registrations are inaccessible.
|
|
16531
|
+
* @summary Unregister this user\'s native notification device
|
|
16532
|
+
* @param {string} deviceInstallationId
|
|
16533
|
+
* @param {*} [options] Override http request option.
|
|
16534
|
+
* @throws {RequiredError}
|
|
16535
|
+
*/
|
|
16536
|
+
unregisterDevice(deviceInstallationId: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
15719
16537
|
}
|
|
15720
16538
|
/**
|
|
15721
16539
|
* ObjectsApi - axios parameter creator
|
|
@@ -15748,16 +16566,17 @@ export declare const ObjectsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
15748
16566
|
*/
|
|
15749
16567
|
getAccessGrantCandidates: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15750
16568
|
/**
|
|
15751
|
-
* Fetches a single object by its UUID. Optional parameters determine whether to include views, properties, and relations in the response.
|
|
16569
|
+
* Fetches a single object by its UUID. Optional parameters determine whether to include views, properties, and relations in the response. Hidden property definitions require includeHiddenProperties=true together with properties=true; property read authorization still applies and archived definitions remain excluded.
|
|
15752
16570
|
* @summary Get object by UUID
|
|
15753
16571
|
* @param {string} uuid
|
|
15754
16572
|
* @param {string} [views]
|
|
15755
16573
|
* @param {string} [properties]
|
|
15756
16574
|
* @param {string} [relations]
|
|
16575
|
+
* @param {boolean} [includeHiddenProperties]
|
|
15757
16576
|
* @param {*} [options] Override http request option.
|
|
15758
16577
|
* @throws {RequiredError}
|
|
15759
16578
|
*/
|
|
15760
|
-
getObject: (uuid: string, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16579
|
+
getObject: (uuid: string, views?: string, properties?: string, relations?: string, includeHiddenProperties?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15761
16580
|
/**
|
|
15762
16581
|
* Fetches a paginated list of objects, optionally including views, properties, and/or relations. The request body should contain pagination details such as limit, page, filters, sort, and query.
|
|
15763
16582
|
* @summary Fetch paginated objects
|
|
@@ -15896,16 +16715,17 @@ export declare const ObjectsApiFp: (configuration?: Configuration) => {
|
|
|
15896
16715
|
*/
|
|
15897
16716
|
getAccessGrantCandidates(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseObjectAccessGrantCandidatesDTO>>;
|
|
15898
16717
|
/**
|
|
15899
|
-
* Fetches a single object by its UUID. Optional parameters determine whether to include views, properties, and relations in the response.
|
|
16718
|
+
* Fetches a single object by its UUID. Optional parameters determine whether to include views, properties, and relations in the response. Hidden property definitions require includeHiddenProperties=true together with properties=true; property read authorization still applies and archived definitions remain excluded.
|
|
15900
16719
|
* @summary Get object by UUID
|
|
15901
16720
|
* @param {string} uuid
|
|
15902
16721
|
* @param {string} [views]
|
|
15903
16722
|
* @param {string} [properties]
|
|
15904
16723
|
* @param {string} [relations]
|
|
16724
|
+
* @param {boolean} [includeHiddenProperties]
|
|
15905
16725
|
* @param {*} [options] Override http request option.
|
|
15906
16726
|
* @throws {RequiredError}
|
|
15907
16727
|
*/
|
|
15908
|
-
getObject(uuid: string, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseCaraerObjectDTO>>;
|
|
16728
|
+
getObject(uuid: string, views?: string, properties?: string, relations?: string, includeHiddenProperties?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseCaraerObjectDTO>>;
|
|
15909
16729
|
/**
|
|
15910
16730
|
* Fetches a paginated list of objects, optionally including views, properties, and/or relations. The request body should contain pagination details such as limit, page, filters, sort, and query.
|
|
15911
16731
|
* @summary Fetch paginated objects
|
|
@@ -16044,16 +16864,17 @@ export declare const ObjectsApiFactory: (configuration?: Configuration, basePath
|
|
|
16044
16864
|
*/
|
|
16045
16865
|
getAccessGrantCandidates(options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseObjectAccessGrantCandidatesDTO>;
|
|
16046
16866
|
/**
|
|
16047
|
-
* Fetches a single object by its UUID. Optional parameters determine whether to include views, properties, and relations in the response.
|
|
16867
|
+
* Fetches a single object by its UUID. Optional parameters determine whether to include views, properties, and relations in the response. Hidden property definitions require includeHiddenProperties=true together with properties=true; property read authorization still applies and archived definitions remain excluded.
|
|
16048
16868
|
* @summary Get object by UUID
|
|
16049
16869
|
* @param {string} uuid
|
|
16050
16870
|
* @param {string} [views]
|
|
16051
16871
|
* @param {string} [properties]
|
|
16052
16872
|
* @param {string} [relations]
|
|
16873
|
+
* @param {boolean} [includeHiddenProperties]
|
|
16053
16874
|
* @param {*} [options] Override http request option.
|
|
16054
16875
|
* @throws {RequiredError}
|
|
16055
16876
|
*/
|
|
16056
|
-
getObject(uuid: string, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseCaraerObjectDTO>;
|
|
16877
|
+
getObject(uuid: string, views?: string, properties?: string, relations?: string, includeHiddenProperties?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseCaraerObjectDTO>;
|
|
16057
16878
|
/**
|
|
16058
16879
|
* Fetches a paginated list of objects, optionally including views, properties, and/or relations. The request body should contain pagination details such as limit, page, filters, sort, and query.
|
|
16059
16880
|
* @summary Fetch paginated objects
|
|
@@ -16192,16 +17013,17 @@ export declare class ObjectsApi extends BaseAPI {
|
|
|
16192
17013
|
*/
|
|
16193
17014
|
getAccessGrantCandidates(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseObjectAccessGrantCandidatesDTO, any, {}>>;
|
|
16194
17015
|
/**
|
|
16195
|
-
* Fetches a single object by its UUID. Optional parameters determine whether to include views, properties, and relations in the response.
|
|
17016
|
+
* Fetches a single object by its UUID. Optional parameters determine whether to include views, properties, and relations in the response. Hidden property definitions require includeHiddenProperties=true together with properties=true; property read authorization still applies and archived definitions remain excluded.
|
|
16196
17017
|
* @summary Get object by UUID
|
|
16197
17018
|
* @param {string} uuid
|
|
16198
17019
|
* @param {string} [views]
|
|
16199
17020
|
* @param {string} [properties]
|
|
16200
17021
|
* @param {string} [relations]
|
|
17022
|
+
* @param {boolean} [includeHiddenProperties]
|
|
16201
17023
|
* @param {*} [options] Override http request option.
|
|
16202
17024
|
* @throws {RequiredError}
|
|
16203
17025
|
*/
|
|
16204
|
-
getObject(uuid: string, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCaraerObjectDTO, any, {}>>;
|
|
17026
|
+
getObject(uuid: string, views?: string, properties?: string, relations?: string, includeHiddenProperties?: boolean, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseCaraerObjectDTO, any, {}>>;
|
|
16205
17027
|
/**
|
|
16206
17028
|
* Fetches a paginated list of objects, optionally including views, properties, and/or relations. The request body should contain pagination details such as limit, page, filters, sort, and query.
|
|
16207
17029
|
* @summary Fetch paginated objects
|
|
@@ -16892,6 +17714,14 @@ export declare const RecordsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
16892
17714
|
* @throws {RequiredError}
|
|
16893
17715
|
*/
|
|
16894
17716
|
bulkEdit: (objectName: string, bulkEditRecordsRequest: BulkEditRecordsRequest, ignoreErrors?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
17717
|
+
/**
|
|
17718
|
+
* Read-only current eligibility for up to 50 explicit pairs. Uses ordinary record visibility and named-relation scopes; never a mutation grant. Unavailable items disclose no edge state.
|
|
17719
|
+
* @summary Inspect bounded record relation operations
|
|
17720
|
+
* @param {RelationCapabilityRequest} relationCapabilityRequest
|
|
17721
|
+
* @param {*} [options] Override http request option.
|
|
17722
|
+
* @throws {RequiredError}
|
|
17723
|
+
*/
|
|
17724
|
+
capabilities: (relationCapabilityRequest: RelationCapabilityRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16895
17725
|
/**
|
|
16896
17726
|
* Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
16897
17727
|
* @summary Create a new record
|
|
@@ -16938,6 +17768,16 @@ export declare const RecordsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
16938
17768
|
* @throws {RequiredError}
|
|
16939
17769
|
*/
|
|
16940
17770
|
deleteRelation: (fromUuid: string, relationName: string, toUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
17771
|
+
/**
|
|
17772
|
+
* Bodyless atomic ensure-link using ordinary record reads, relation normalization, immutability and exact relation-write scopes. Existing edges retain all properties and primary flags. New edges are non-primary. No edge-property/primary settings are accepted by this operation; use the existing POST/PATCH operations to change edge values. Receipt identities echo request endpoints.
|
|
17773
|
+
* @summary Ensure a relation without changing an existing edge
|
|
17774
|
+
* @param {string} fromUuid
|
|
17775
|
+
* @param {string} relationName
|
|
17776
|
+
* @param {string} toUuid
|
|
17777
|
+
* @param {*} [options] Override http request option.
|
|
17778
|
+
* @throws {RequiredError}
|
|
17779
|
+
*/
|
|
17780
|
+
ensure: (fromUuid: string, relationName: string, toUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16941
17781
|
/**
|
|
16942
17782
|
* Extends a record identified by its UUID to one or more objects. You can use this to move a record or add it to another object so it\'ll be visible in the new object.Returns a SuccessResponse confirming that the record has been extended.
|
|
16943
17783
|
* @summary Extend a record
|
|
@@ -17165,6 +18005,14 @@ export declare const RecordsApiFp: (configuration?: Configuration) => {
|
|
|
17165
18005
|
* @throws {RequiredError}
|
|
17166
18006
|
*/
|
|
17167
18007
|
bulkEdit(objectName: string, bulkEditRecordsRequest: BulkEditRecordsRequest, ignoreErrors?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BulkEditRecordsResponse>>;
|
|
18008
|
+
/**
|
|
18009
|
+
* Read-only current eligibility for up to 50 explicit pairs. Uses ordinary record visibility and named-relation scopes; never a mutation grant. Unavailable items disclose no edge state.
|
|
18010
|
+
* @summary Inspect bounded record relation operations
|
|
18011
|
+
* @param {RelationCapabilityRequest} relationCapabilityRequest
|
|
18012
|
+
* @param {*} [options] Override http request option.
|
|
18013
|
+
* @throws {RequiredError}
|
|
18014
|
+
*/
|
|
18015
|
+
capabilities(relationCapabilityRequest: RelationCapabilityRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseRelationCapabilities>>;
|
|
17168
18016
|
/**
|
|
17169
18017
|
* Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
17170
18018
|
* @summary Create a new record
|
|
@@ -17211,6 +18059,16 @@ export declare const RecordsApiFp: (configuration?: Configuration) => {
|
|
|
17211
18059
|
* @throws {RequiredError}
|
|
17212
18060
|
*/
|
|
17213
18061
|
deleteRelation(fromUuid: string, relationName: string, toUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseString>>;
|
|
18062
|
+
/**
|
|
18063
|
+
* Bodyless atomic ensure-link using ordinary record reads, relation normalization, immutability and exact relation-write scopes. Existing edges retain all properties and primary flags. New edges are non-primary. No edge-property/primary settings are accepted by this operation; use the existing POST/PATCH operations to change edge values. Receipt identities echo request endpoints.
|
|
18064
|
+
* @summary Ensure a relation without changing an existing edge
|
|
18065
|
+
* @param {string} fromUuid
|
|
18066
|
+
* @param {string} relationName
|
|
18067
|
+
* @param {string} toUuid
|
|
18068
|
+
* @param {*} [options] Override http request option.
|
|
18069
|
+
* @throws {RequiredError}
|
|
18070
|
+
*/
|
|
18071
|
+
ensure(fromUuid: string, relationName: string, toUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseEnsureRelationDTO>>;
|
|
17214
18072
|
/**
|
|
17215
18073
|
* Extends a record identified by its UUID to one or more objects. You can use this to move a record or add it to another object so it\'ll be visible in the new object.Returns a SuccessResponse confirming that the record has been extended.
|
|
17216
18074
|
* @summary Extend a record
|
|
@@ -17438,6 +18296,14 @@ export declare const RecordsApiFactory: (configuration?: Configuration, basePath
|
|
|
17438
18296
|
* @throws {RequiredError}
|
|
17439
18297
|
*/
|
|
17440
18298
|
bulkEdit(objectName: string, bulkEditRecordsRequest: BulkEditRecordsRequest, ignoreErrors?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<BulkEditRecordsResponse>;
|
|
18299
|
+
/**
|
|
18300
|
+
* Read-only current eligibility for up to 50 explicit pairs. Uses ordinary record visibility and named-relation scopes; never a mutation grant. Unavailable items disclose no edge state.
|
|
18301
|
+
* @summary Inspect bounded record relation operations
|
|
18302
|
+
* @param {RelationCapabilityRequest} relationCapabilityRequest
|
|
18303
|
+
* @param {*} [options] Override http request option.
|
|
18304
|
+
* @throws {RequiredError}
|
|
18305
|
+
*/
|
|
18306
|
+
capabilities(relationCapabilityRequest: RelationCapabilityRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseRelationCapabilities>;
|
|
17441
18307
|
/**
|
|
17442
18308
|
* Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
17443
18309
|
* @summary Create a new record
|
|
@@ -17484,6 +18350,16 @@ export declare const RecordsApiFactory: (configuration?: Configuration, basePath
|
|
|
17484
18350
|
* @throws {RequiredError}
|
|
17485
18351
|
*/
|
|
17486
18352
|
deleteRelation(fromUuid: string, relationName: string, toUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseString>;
|
|
18353
|
+
/**
|
|
18354
|
+
* Bodyless atomic ensure-link using ordinary record reads, relation normalization, immutability and exact relation-write scopes. Existing edges retain all properties and primary flags. New edges are non-primary. No edge-property/primary settings are accepted by this operation; use the existing POST/PATCH operations to change edge values. Receipt identities echo request endpoints.
|
|
18355
|
+
* @summary Ensure a relation without changing an existing edge
|
|
18356
|
+
* @param {string} fromUuid
|
|
18357
|
+
* @param {string} relationName
|
|
18358
|
+
* @param {string} toUuid
|
|
18359
|
+
* @param {*} [options] Override http request option.
|
|
18360
|
+
* @throws {RequiredError}
|
|
18361
|
+
*/
|
|
18362
|
+
ensure(fromUuid: string, relationName: string, toUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseEnsureRelationDTO>;
|
|
17487
18363
|
/**
|
|
17488
18364
|
* Extends a record identified by its UUID to one or more objects. You can use this to move a record or add it to another object so it\'ll be visible in the new object.Returns a SuccessResponse confirming that the record has been extended.
|
|
17489
18365
|
* @summary Extend a record
|
|
@@ -17711,6 +18587,14 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17711
18587
|
* @throws {RequiredError}
|
|
17712
18588
|
*/
|
|
17713
18589
|
bulkEdit(objectName: string, bulkEditRecordsRequest: BulkEditRecordsRequest, ignoreErrors?: boolean, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<BulkEditRecordsResponse, any, {}>>;
|
|
18590
|
+
/**
|
|
18591
|
+
* Read-only current eligibility for up to 50 explicit pairs. Uses ordinary record visibility and named-relation scopes; never a mutation grant. Unavailable items disclose no edge state.
|
|
18592
|
+
* @summary Inspect bounded record relation operations
|
|
18593
|
+
* @param {RelationCapabilityRequest} relationCapabilityRequest
|
|
18594
|
+
* @param {*} [options] Override http request option.
|
|
18595
|
+
* @throws {RequiredError}
|
|
18596
|
+
*/
|
|
18597
|
+
capabilities(relationCapabilityRequest: RelationCapabilityRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseRelationCapabilities, any, {}>>;
|
|
17714
18598
|
/**
|
|
17715
18599
|
* Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
17716
18600
|
* @summary Create a new record
|
|
@@ -17757,6 +18641,16 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17757
18641
|
* @throws {RequiredError}
|
|
17758
18642
|
*/
|
|
17759
18643
|
deleteRelation(fromUuid: string, relationName: string, toUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
18644
|
+
/**
|
|
18645
|
+
* Bodyless atomic ensure-link using ordinary record reads, relation normalization, immutability and exact relation-write scopes. Existing edges retain all properties and primary flags. New edges are non-primary. No edge-property/primary settings are accepted by this operation; use the existing POST/PATCH operations to change edge values. Receipt identities echo request endpoints.
|
|
18646
|
+
* @summary Ensure a relation without changing an existing edge
|
|
18647
|
+
* @param {string} fromUuid
|
|
18648
|
+
* @param {string} relationName
|
|
18649
|
+
* @param {string} toUuid
|
|
18650
|
+
* @param {*} [options] Override http request option.
|
|
18651
|
+
* @throws {RequiredError}
|
|
18652
|
+
*/
|
|
18653
|
+
ensure(fromUuid: string, relationName: string, toUuid: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseEnsureRelationDTO, any, {}>>;
|
|
17760
18654
|
/**
|
|
17761
18655
|
* Extends a record identified by its UUID to one or more objects. You can use this to move a record or add it to another object so it\'ll be visible in the new object.Returns a SuccessResponse confirming that the record has been extended.
|
|
17762
18656
|
* @summary Extend a record
|
|
@@ -20218,6 +21112,15 @@ export declare const WebpagesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
20218
21112
|
* @throws {RequiredError}
|
|
20219
21113
|
*/
|
|
20220
21114
|
listProtectionGrants: (uuid: string, environment?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
21115
|
+
/**
|
|
21116
|
+
* Returns only public component styling, color tokens and custom fonts for the selected company. Uses the same page, record and environment-property read checks as reading this webpage; company administration access is not required.
|
|
21117
|
+
* @summary Get authorized webpage editor defaults
|
|
21118
|
+
* @param {string} uuid
|
|
21119
|
+
* @param {string} [environment]
|
|
21120
|
+
* @param {*} [options] Override http request option.
|
|
21121
|
+
* @throws {RequiredError}
|
|
21122
|
+
*/
|
|
21123
|
+
page: (uuid: string, environment?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
20221
21124
|
/**
|
|
20222
21125
|
* Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
|
|
20223
21126
|
* @summary Public URL for a library file
|
|
@@ -20263,6 +21166,15 @@ export declare const WebpagesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
20263
21166
|
* @throws {RequiredError}
|
|
20264
21167
|
*/
|
|
20265
21168
|
revokeProtectionGrant: (uuid: string, grantUuid: string, environment?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
21169
|
+
/**
|
|
21170
|
+
* Returns only public component styling, color tokens and custom fonts for the selected company after its ordinary template-read and tenant object/template resolution checks. No template, lease, company setting or publication is changed.
|
|
21171
|
+
* @summary Get authorized template editor defaults
|
|
21172
|
+
* @param {string} objectName
|
|
21173
|
+
* @param {string} environment
|
|
21174
|
+
* @param {*} [options] Override http request option.
|
|
21175
|
+
* @throws {RequiredError}
|
|
21176
|
+
*/
|
|
21177
|
+
template: (objectName: string, environment: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
20266
21178
|
/**
|
|
20267
21179
|
* Validates password and returns a short-lived access token.
|
|
20268
21180
|
* @summary Unlock password-protected webpage
|
|
@@ -20602,6 +21514,15 @@ export declare const WebpagesApiFp: (configuration?: Configuration) => {
|
|
|
20602
21514
|
* @throws {RequiredError}
|
|
20603
21515
|
*/
|
|
20604
21516
|
listProtectionGrants(uuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginationResponseWebpageAccessGrantDTO>>;
|
|
21517
|
+
/**
|
|
21518
|
+
* Returns only public component styling, color tokens and custom fonts for the selected company. Uses the same page, record and environment-property read checks as reading this webpage; company administration access is not required.
|
|
21519
|
+
* @summary Get authorized webpage editor defaults
|
|
21520
|
+
* @param {string} uuid
|
|
21521
|
+
* @param {string} [environment]
|
|
21522
|
+
* @param {*} [options] Override http request option.
|
|
21523
|
+
* @throws {RequiredError}
|
|
21524
|
+
*/
|
|
21525
|
+
page(uuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseWebpageEditorDefaultsDTO>>;
|
|
20605
21526
|
/**
|
|
20606
21527
|
* Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
|
|
20607
21528
|
* @summary Public URL for a library file
|
|
@@ -20647,6 +21568,15 @@ export declare const WebpagesApiFp: (configuration?: Configuration) => {
|
|
|
20647
21568
|
* @throws {RequiredError}
|
|
20648
21569
|
*/
|
|
20649
21570
|
revokeProtectionGrant(uuid: string, grantUuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseString>>;
|
|
21571
|
+
/**
|
|
21572
|
+
* Returns only public component styling, color tokens and custom fonts for the selected company after its ordinary template-read and tenant object/template resolution checks. No template, lease, company setting or publication is changed.
|
|
21573
|
+
* @summary Get authorized template editor defaults
|
|
21574
|
+
* @param {string} objectName
|
|
21575
|
+
* @param {string} environment
|
|
21576
|
+
* @param {*} [options] Override http request option.
|
|
21577
|
+
* @throws {RequiredError}
|
|
21578
|
+
*/
|
|
21579
|
+
template(objectName: string, environment: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseWebpageEditorDefaultsDTO>>;
|
|
20650
21580
|
/**
|
|
20651
21581
|
* Validates password and returns a short-lived access token.
|
|
20652
21582
|
* @summary Unlock password-protected webpage
|
|
@@ -20986,6 +21916,15 @@ export declare const WebpagesApiFactory: (configuration?: Configuration, basePat
|
|
|
20986
21916
|
* @throws {RequiredError}
|
|
20987
21917
|
*/
|
|
20988
21918
|
listProtectionGrants(uuid: string, environment?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaginationResponseWebpageAccessGrantDTO>;
|
|
21919
|
+
/**
|
|
21920
|
+
* Returns only public component styling, color tokens and custom fonts for the selected company. Uses the same page, record and environment-property read checks as reading this webpage; company administration access is not required.
|
|
21921
|
+
* @summary Get authorized webpage editor defaults
|
|
21922
|
+
* @param {string} uuid
|
|
21923
|
+
* @param {string} [environment]
|
|
21924
|
+
* @param {*} [options] Override http request option.
|
|
21925
|
+
* @throws {RequiredError}
|
|
21926
|
+
*/
|
|
21927
|
+
page(uuid: string, environment?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseWebpageEditorDefaultsDTO>;
|
|
20989
21928
|
/**
|
|
20990
21929
|
* Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
|
|
20991
21930
|
* @summary Public URL for a library file
|
|
@@ -21031,6 +21970,15 @@ export declare const WebpagesApiFactory: (configuration?: Configuration, basePat
|
|
|
21031
21970
|
* @throws {RequiredError}
|
|
21032
21971
|
*/
|
|
21033
21972
|
revokeProtectionGrant(uuid: string, grantUuid: string, environment?: string, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseString>;
|
|
21973
|
+
/**
|
|
21974
|
+
* Returns only public component styling, color tokens and custom fonts for the selected company after its ordinary template-read and tenant object/template resolution checks. No template, lease, company setting or publication is changed.
|
|
21975
|
+
* @summary Get authorized template editor defaults
|
|
21976
|
+
* @param {string} objectName
|
|
21977
|
+
* @param {string} environment
|
|
21978
|
+
* @param {*} [options] Override http request option.
|
|
21979
|
+
* @throws {RequiredError}
|
|
21980
|
+
*/
|
|
21981
|
+
template(objectName: string, environment: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseWebpageEditorDefaultsDTO>;
|
|
21034
21982
|
/**
|
|
21035
21983
|
* Validates password and returns a short-lived access token.
|
|
21036
21984
|
* @summary Unlock password-protected webpage
|
|
@@ -21370,6 +22318,15 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21370
22318
|
* @throws {RequiredError}
|
|
21371
22319
|
*/
|
|
21372
22320
|
listProtectionGrants(uuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PaginationResponseWebpageAccessGrantDTO, any, {}>>;
|
|
22321
|
+
/**
|
|
22322
|
+
* Returns only public component styling, color tokens and custom fonts for the selected company. Uses the same page, record and environment-property read checks as reading this webpage; company administration access is not required.
|
|
22323
|
+
* @summary Get authorized webpage editor defaults
|
|
22324
|
+
* @param {string} uuid
|
|
22325
|
+
* @param {string} [environment]
|
|
22326
|
+
* @param {*} [options] Override http request option.
|
|
22327
|
+
* @throws {RequiredError}
|
|
22328
|
+
*/
|
|
22329
|
+
page(uuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseWebpageEditorDefaultsDTO, any, {}>>;
|
|
21373
22330
|
/**
|
|
21374
22331
|
* Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
|
|
21375
22332
|
* @summary Public URL for a library file
|
|
@@ -21415,6 +22372,15 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21415
22372
|
* @throws {RequiredError}
|
|
21416
22373
|
*/
|
|
21417
22374
|
revokeProtectionGrant(uuid: string, grantUuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SuccessResponseString, any, {}>>;
|
|
22375
|
+
/**
|
|
22376
|
+
* Returns only public component styling, color tokens and custom fonts for the selected company after its ordinary template-read and tenant object/template resolution checks. No template, lease, company setting or publication is changed.
|
|
22377
|
+
* @summary Get authorized template editor defaults
|
|
22378
|
+
* @param {string} objectName
|
|
22379
|
+
* @param {string} environment
|
|
22380
|
+
* @param {*} [options] Override http request option.
|
|
22381
|
+
* @throws {RequiredError}
|
|
22382
|
+
*/
|
|
22383
|
+
template(objectName: string, environment: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseWebpageEditorDefaultsDTO, any, {}>>;
|
|
21418
22384
|
/**
|
|
21419
22385
|
* Validates password and returns a short-lived access token.
|
|
21420
22386
|
* @summary Unlock password-protected webpage
|