@caraer/client 2.0.695 → 2.0.701
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 +41 -0
- package/api.ts +1856 -201
- package/dist/api.d.ts +1017 -31
- package/dist/api.js +1280 -84
- package/dist/esm/api.d.ts +1017 -31
- 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/Audience.md +36 -0
- 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/CRUD.md +2 -0
- package/docs/CreatePrivateAppRequest.md +4 -0
- package/docs/CrudAccessContext.md +22 -0
- package/docs/EnsureRelationDTO.md +27 -0
- package/docs/ErrorResponse.md +2 -0
- package/docs/ExistingWidgetSummary.md +2 -2
- 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/Permissions.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/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
|
*/
|
|
@@ -1055,6 +1101,17 @@ export interface ArchivedRecordObjectDTO {
|
|
|
1055
1101
|
'icon'?: string;
|
|
1056
1102
|
'index'?: number;
|
|
1057
1103
|
}
|
|
1104
|
+
export interface Audience {
|
|
1105
|
+
'authentication'?: any;
|
|
1106
|
+
'principal'?: any;
|
|
1107
|
+
'authenticated'?: boolean;
|
|
1108
|
+
'database'?: string;
|
|
1109
|
+
'principalDatabase'?: string;
|
|
1110
|
+
'companyUuid'?: string;
|
|
1111
|
+
'principalUuid'?: string;
|
|
1112
|
+
'authorities'?: Array<string>;
|
|
1113
|
+
'roles'?: Array<string>;
|
|
1114
|
+
}
|
|
1058
1115
|
/**
|
|
1059
1116
|
* The billing settings of the company.
|
|
1060
1117
|
*/
|
|
@@ -1124,6 +1181,29 @@ export interface BillingSettingsDTO {
|
|
|
1124
1181
|
*/
|
|
1125
1182
|
'country'?: string;
|
|
1126
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
|
+
}
|
|
1127
1207
|
/**
|
|
1128
1208
|
* Payload of a bulk delete records response.
|
|
1129
1209
|
*/
|
|
@@ -1183,7 +1263,15 @@ export interface BulkEditRecordErrorItem {
|
|
|
1183
1263
|
* Field-level validation errors.
|
|
1184
1264
|
*/
|
|
1185
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;
|
|
1186
1270
|
}
|
|
1271
|
+
export declare const BulkEditRecordErrorItemRecordWriteOutcomeEnum: {
|
|
1272
|
+
readonly NotStarted: "NOT_STARTED";
|
|
1273
|
+
};
|
|
1274
|
+
export type BulkEditRecordErrorItemRecordWriteOutcomeEnum = typeof BulkEditRecordErrorItemRecordWriteOutcomeEnum[keyof typeof BulkEditRecordErrorItemRecordWriteOutcomeEnum];
|
|
1187
1275
|
/**
|
|
1188
1276
|
* A single record to create or update in a bulk edit request.
|
|
1189
1277
|
*/
|
|
@@ -1262,6 +1350,7 @@ export interface BulkEditRecordsResponse {
|
|
|
1262
1350
|
export interface CRUD {
|
|
1263
1351
|
'httpSessionId'?: string;
|
|
1264
1352
|
'turnOffMetaRelationships'?: boolean;
|
|
1353
|
+
'httpAccessContext'?: CrudAccessContext;
|
|
1265
1354
|
}
|
|
1266
1355
|
export interface CalendarBootstrapDTO {
|
|
1267
1356
|
'defaultCalendar'?: CalendarRecordDTO;
|
|
@@ -1810,6 +1899,14 @@ export interface CreateOrUpdateEnvironmentRequest {
|
|
|
1810
1899
|
* Private app creator manifest; label is required and internal name is optional
|
|
1811
1900
|
*/
|
|
1812
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;
|
|
1813
1910
|
/**
|
|
1814
1911
|
* Unique identifier for the entity
|
|
1815
1912
|
*/
|
|
@@ -2190,6 +2287,10 @@ export interface CrossObjectRecordSearchRequest {
|
|
|
2190
2287
|
*/
|
|
2191
2288
|
'excludeRecordUuid'?: string;
|
|
2192
2289
|
}
|
|
2290
|
+
export interface CrudAccessContext {
|
|
2291
|
+
'audience'?: Audience;
|
|
2292
|
+
'permissions'?: Permissions;
|
|
2293
|
+
}
|
|
2193
2294
|
export interface Currency extends PropertyFormat {
|
|
2194
2295
|
}
|
|
2195
2296
|
export interface CurrencyRange extends PropertyFormat {
|
|
@@ -2758,6 +2859,20 @@ export interface EngagementBatchRequest {
|
|
|
2758
2859
|
'sessionId'?: string;
|
|
2759
2860
|
'events'?: Array<TrackingEventRequest>;
|
|
2760
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];
|
|
2761
2876
|
/**
|
|
2762
2877
|
* Defines the structure of error responses returned by the API.
|
|
2763
2878
|
*/
|
|
@@ -2774,6 +2889,10 @@ export interface ErrorResponse {
|
|
|
2774
2889
|
* The HTTP status code associated with the error.
|
|
2775
2890
|
*/
|
|
2776
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;
|
|
2777
2896
|
'stackTrace'?: string;
|
|
2778
2897
|
/**
|
|
2779
2898
|
* Roles the caller is missing when the failure is an authorization error.
|
|
@@ -2788,6 +2907,10 @@ export interface ErrorResponse {
|
|
|
2788
2907
|
*/
|
|
2789
2908
|
'requestId'?: string;
|
|
2790
2909
|
}
|
|
2910
|
+
export declare const ErrorResponseRecordWriteOutcomeEnum: {
|
|
2911
|
+
readonly NotStarted: "NOT_STARTED";
|
|
2912
|
+
};
|
|
2913
|
+
export type ErrorResponseRecordWriteOutcomeEnum = typeof ErrorResponseRecordWriteOutcomeEnum[keyof typeof ErrorResponseRecordWriteOutcomeEnum];
|
|
2791
2914
|
export declare const ErrorResponseRolesEnum: {
|
|
2792
2915
|
readonly User: "USER";
|
|
2793
2916
|
readonly Admin: "ADMIN";
|
|
@@ -2820,9 +2943,9 @@ export declare const EventRsvpRequestScopeEnum: {
|
|
|
2820
2943
|
};
|
|
2821
2944
|
export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
|
|
2822
2945
|
export interface ExistingWidgetSummary {
|
|
2823
|
-
'xproperty'?: string;
|
|
2824
2946
|
'ymetric'?: string;
|
|
2825
2947
|
'yproperty'?: string;
|
|
2948
|
+
'xproperty'?: string;
|
|
2826
2949
|
'title'?: string;
|
|
2827
2950
|
'chartType'?: string;
|
|
2828
2951
|
'xProperty'?: string;
|
|
@@ -2838,6 +2961,10 @@ export interface ExtendRecordRequest {
|
|
|
2838
2961
|
*/
|
|
2839
2962
|
'objects'?: Set<CaraerObjectDTO>;
|
|
2840
2963
|
}
|
|
2964
|
+
export interface FavoriteViewDTO {
|
|
2965
|
+
'object'?: ObjectReferenceDTO;
|
|
2966
|
+
'view'?: NavigationViewDTO;
|
|
2967
|
+
}
|
|
2841
2968
|
export interface FeedDTO {
|
|
2842
2969
|
/**
|
|
2843
2970
|
* Unique identifier for the entity
|
|
@@ -3773,6 +3900,42 @@ export interface MultiValueMapStringString {
|
|
|
3773
3900
|
};
|
|
3774
3901
|
'empty'?: boolean;
|
|
3775
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
|
+
}
|
|
3776
3939
|
export interface NotFoundError {
|
|
3777
3940
|
'cause'?: NotFoundErrorCause;
|
|
3778
3941
|
'stackTrace'?: Array<NotFoundErrorCauseStackTraceInner>;
|
|
@@ -3814,6 +3977,19 @@ export interface NotFoundErrorCauseStackTraceInner {
|
|
|
3814
3977
|
'className'?: string;
|
|
3815
3978
|
'nativeMethod'?: boolean;
|
|
3816
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
|
+
}
|
|
3817
3993
|
export interface NotificationInboxDTO {
|
|
3818
3994
|
'notifications'?: Array<Item>;
|
|
3819
3995
|
'unreadCount'?: number;
|
|
@@ -3881,6 +4057,15 @@ export interface ObjectAccessGrantSectionDTO {
|
|
|
3881
4057
|
[key: string]: Array<string>;
|
|
3882
4058
|
};
|
|
3883
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
|
+
}
|
|
3884
4069
|
/**
|
|
3885
4070
|
* Data transfer object representing a webpage content
|
|
3886
4071
|
*/
|
|
@@ -4664,6 +4849,18 @@ export interface PaginationResponseWebpageAccessGrantDTO {
|
|
|
4664
4849
|
*/
|
|
4665
4850
|
'lastPage'?: number;
|
|
4666
4851
|
}
|
|
4852
|
+
export interface Palette {
|
|
4853
|
+
'light'?: {
|
|
4854
|
+
[key: string]: string;
|
|
4855
|
+
};
|
|
4856
|
+
'dark'?: {
|
|
4857
|
+
[key: string]: string;
|
|
4858
|
+
};
|
|
4859
|
+
}
|
|
4860
|
+
export interface Permissions {
|
|
4861
|
+
'scopes'?: Array<string>;
|
|
4862
|
+
'filters'?: any;
|
|
4863
|
+
}
|
|
4667
4864
|
export interface Phone extends PropertyFormat {
|
|
4668
4865
|
}
|
|
4669
4866
|
/**
|
|
@@ -5516,6 +5713,69 @@ export interface RegisterRequest {
|
|
|
5516
5713
|
'firstname': string;
|
|
5517
5714
|
'lastname': string;
|
|
5518
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
|
+
}
|
|
5519
5779
|
/**
|
|
5520
5780
|
* Data transfer object representing a relation between Caraer objects
|
|
5521
5781
|
*/
|
|
@@ -6211,6 +6471,32 @@ export interface ShowResponseBillingStatusDTO {
|
|
|
6211
6471
|
[key: string]: any;
|
|
6212
6472
|
};
|
|
6213
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
|
+
}
|
|
6214
6500
|
/**
|
|
6215
6501
|
* Success response (ShowResponseCaraerObjectDTO).
|
|
6216
6502
|
*/
|
|
@@ -6312,6 +6598,19 @@ export interface ShowResponseFormDTO {
|
|
|
6312
6598
|
[key: string]: any;
|
|
6313
6599
|
};
|
|
6314
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
|
+
}
|
|
6315
6614
|
/**
|
|
6316
6615
|
* Represents the response for viewing or showing a specific resource.
|
|
6317
6616
|
*/
|
|
@@ -6517,6 +6816,19 @@ export interface ShowResponseMapStringString {
|
|
|
6517
6816
|
[key: string]: string;
|
|
6518
6817
|
};
|
|
6519
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
|
+
}
|
|
6520
6832
|
/**
|
|
6521
6833
|
* Represents the response for viewing or showing a specific resource.
|
|
6522
6834
|
*/
|
|
@@ -6596,6 +6908,19 @@ export interface ShowResponsePublicFormDTO {
|
|
|
6596
6908
|
[key: string]: any;
|
|
6597
6909
|
};
|
|
6598
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
|
+
}
|
|
6599
6924
|
/**
|
|
6600
6925
|
* Success response (ShowResponseRelationDTO).
|
|
6601
6926
|
*/
|
|
@@ -6696,6 +7021,19 @@ export interface ShowResponseWebMenuDTO {
|
|
|
6696
7021
|
[key: string]: any;
|
|
6697
7022
|
};
|
|
6698
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
|
+
}
|
|
6699
7037
|
/**
|
|
6700
7038
|
* Represents the response for viewing or showing a specific resource.
|
|
6701
7039
|
*/
|
|
@@ -6740,6 +7078,10 @@ export interface SignedUrlResultDTO {
|
|
|
6740
7078
|
'expiresAt'?: number;
|
|
6741
7079
|
'queryParams'?: string;
|
|
6742
7080
|
}
|
|
7081
|
+
export interface SimpleCompanyDTO {
|
|
7082
|
+
'uuid'?: string;
|
|
7083
|
+
'name'?: string;
|
|
7084
|
+
}
|
|
6743
7085
|
/**
|
|
6744
7086
|
* Data Transfer Object representing a public-facing view of a company
|
|
6745
7087
|
*/
|
|
@@ -7331,6 +7673,19 @@ export interface SuccessResponseCompanyDTO {
|
|
|
7331
7673
|
*/
|
|
7332
7674
|
'data'?: CompanyDTO;
|
|
7333
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
|
+
}
|
|
7334
7689
|
/**
|
|
7335
7690
|
* Represents a standard successful response with a message and optional data.
|
|
7336
7691
|
*/
|
|
@@ -7458,6 +7813,19 @@ export interface SuccessResponseListDeveloperSandboxDTO {
|
|
|
7458
7813
|
*/
|
|
7459
7814
|
'data'?: Array<DeveloperSandboxDTO>;
|
|
7460
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
|
+
}
|
|
7461
7829
|
/**
|
|
7462
7830
|
* Represents a standard successful response with a message and optional data.
|
|
7463
7831
|
*/
|
|
@@ -7486,6 +7854,19 @@ export interface SuccessResponseListMapStringObject {
|
|
|
7486
7854
|
[key: string]: any | null;
|
|
7487
7855
|
}>;
|
|
7488
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
|
+
}
|
|
7489
7870
|
/**
|
|
7490
7871
|
* Represents a standard successful response with a message and optional data.
|
|
7491
7872
|
*/
|
|
@@ -7550,6 +7931,19 @@ export interface SuccessResponseMapStringObject {
|
|
|
7550
7931
|
[key: string]: any;
|
|
7551
7932
|
};
|
|
7552
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
|
+
}
|
|
7553
7947
|
/**
|
|
7554
7948
|
* Success response (SuccessResponseObject).
|
|
7555
7949
|
*/
|
|
@@ -7949,6 +8343,24 @@ export interface UsedInResult {
|
|
|
7949
8343
|
'recordUuids'?: Array<string>;
|
|
7950
8344
|
'count'?: number;
|
|
7951
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
|
+
}
|
|
7952
8364
|
/**
|
|
7953
8365
|
* Record response for user API endpoints, including linked user data.
|
|
7954
8366
|
*/
|
|
@@ -8124,6 +8536,17 @@ export interface ViewDTO {
|
|
|
8124
8536
|
'isInternallyPublic'?: boolean;
|
|
8125
8537
|
'analytics'?: AnalyticsDashboardConfig;
|
|
8126
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
|
+
}
|
|
8127
8550
|
export interface ViewShareRequest {
|
|
8128
8551
|
'users'?: Array<ModelRecord>;
|
|
8129
8552
|
'teams'?: Array<ModelRecord>;
|
|
@@ -8389,6 +8812,16 @@ export interface WebpageEditingStatusDTO {
|
|
|
8389
8812
|
*/
|
|
8390
8813
|
'message'?: string;
|
|
8391
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
|
+
}
|
|
8392
8825
|
/**
|
|
8393
8826
|
* Resolved public map markers for a webpage map block
|
|
8394
8827
|
*/
|
|
@@ -8775,10 +9208,11 @@ export declare const AppBarsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8775
9208
|
* @param {string} [viewId] View ID in context
|
|
8776
9209
|
* @param {string} [trait] Trait name in context
|
|
8777
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.
|
|
8778
9212
|
* @param {*} [options] Override http request option.
|
|
8779
9213
|
* @throws {RequiredError}
|
|
8780
9214
|
*/
|
|
8781
|
-
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>;
|
|
8782
9216
|
/**
|
|
8783
9217
|
* Fires the app bar webhook with optional settings values and record/view context.
|
|
8784
9218
|
* @summary Trigger an action-based app bar
|
|
@@ -8802,10 +9236,11 @@ export declare const AppBarsApiFp: (configuration?: Configuration) => {
|
|
|
8802
9236
|
* @param {string} [viewId] View ID in context
|
|
8803
9237
|
* @param {string} [trait] Trait name in context
|
|
8804
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.
|
|
8805
9240
|
* @param {*} [options] Override http request option.
|
|
8806
9241
|
* @throws {RequiredError}
|
|
8807
9242
|
*/
|
|
8808
|
-
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>>;
|
|
8809
9244
|
/**
|
|
8810
9245
|
* Fires the app bar webhook with optional settings values and record/view context.
|
|
8811
9246
|
* @summary Trigger an action-based app bar
|
|
@@ -8829,10 +9264,11 @@ export declare const AppBarsApiFactory: (configuration?: Configuration, basePath
|
|
|
8829
9264
|
* @param {string} [viewId] View ID in context
|
|
8830
9265
|
* @param {string} [trait] Trait name in context
|
|
8831
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.
|
|
8832
9268
|
* @param {*} [options] Override http request option.
|
|
8833
9269
|
* @throws {RequiredError}
|
|
8834
9270
|
*/
|
|
8835
|
-
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>;
|
|
8836
9272
|
/**
|
|
8837
9273
|
* Fires the app bar webhook with optional settings values and record/view context.
|
|
8838
9274
|
* @summary Trigger an action-based app bar
|
|
@@ -8856,10 +9292,11 @@ export declare class AppBarsApi extends BaseAPI {
|
|
|
8856
9292
|
* @param {string} [viewId] View ID in context
|
|
8857
9293
|
* @param {string} [trait] Trait name in context
|
|
8858
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.
|
|
8859
9296
|
* @param {*} [options] Override http request option.
|
|
8860
9297
|
* @throws {RequiredError}
|
|
8861
9298
|
*/
|
|
8862
|
-
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, {}>>;
|
|
8863
9300
|
/**
|
|
8864
9301
|
* Fires the app bar webhook with optional settings values and record/view context.
|
|
8865
9302
|
* @summary Trigger an action-based app bar
|
|
@@ -8879,6 +9316,11 @@ export declare const ListAppBarsLocationEnum: {
|
|
|
8879
9316
|
readonly RecordTrait: "RECORD_TRAIT";
|
|
8880
9317
|
};
|
|
8881
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];
|
|
8882
9324
|
/**
|
|
8883
9325
|
* AppInstallationRuntimeApi - axios parameter creator
|
|
8884
9326
|
*/
|
|
@@ -10958,37 +11400,153 @@ export declare class BillingApi extends BaseAPI {
|
|
|
10958
11400
|
sendSetupEmail(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseMapStringBoolean, any, {}>>;
|
|
10959
11401
|
}
|
|
10960
11402
|
/**
|
|
10961
|
-
*
|
|
11403
|
+
* BrowserAuthenticationApi - axios parameter creator
|
|
10962
11404
|
*/
|
|
10963
|
-
export declare const
|
|
11405
|
+
export declare const BrowserAuthenticationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
10964
11406
|
/**
|
|
10965
|
-
*
|
|
10966
|
-
* @summary
|
|
10967
|
-
* @param {string}
|
|
11407
|
+
*
|
|
11408
|
+
* @summary Open the browser-owned provider session
|
|
11409
|
+
* @param {string} flow
|
|
10968
11410
|
* @param {*} [options] Override http request option.
|
|
10969
11411
|
* @throws {RequiredError}
|
|
10970
11412
|
*/
|
|
10971
|
-
|
|
11413
|
+
authorize: (flow: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10972
11414
|
/**
|
|
10973
|
-
*
|
|
10974
|
-
* @summary
|
|
10975
|
-
* @param {
|
|
10976
|
-
* @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
|
|
10977
11418
|
* @param {*} [options] Override http request option.
|
|
10978
11419
|
* @throws {RequiredError}
|
|
10979
11420
|
*/
|
|
10980
|
-
|
|
10981
|
-
[key: string]: any | null;
|
|
10982
|
-
}, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11421
|
+
exchange: (browserAuthExchangeRequest: BrowserAuthExchangeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10983
11422
|
/**
|
|
10984
|
-
*
|
|
10985
|
-
* @summary
|
|
10986
|
-
* @param {
|
|
10987
|
-
* @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
|
|
10988
11426
|
* @param {*} [options] Override http request option.
|
|
10989
11427
|
* @throws {RequiredError}
|
|
10990
11428
|
*/
|
|
10991
|
-
|
|
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: {
|
|
10992
11550
|
[key: string]: any | null;
|
|
10993
11551
|
}, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10994
11552
|
};
|
|
@@ -15489,6 +16047,186 @@ export declare class ModuleApi extends BaseAPI {
|
|
|
15489
16047
|
*/
|
|
15490
16048
|
updatePersonalModule(moduleId: string, pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateResponse, any, {}>>;
|
|
15491
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
|
+
}
|
|
15492
16230
|
/**
|
|
15493
16231
|
* NotificationsApi - axios parameter creator
|
|
15494
16232
|
*/
|
|
@@ -15508,6 +16246,14 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
15508
16246
|
* @throws {RequiredError}
|
|
15509
16247
|
*/
|
|
15510
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>;
|
|
15511
16257
|
/**
|
|
15512
16258
|
* Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
|
|
15513
16259
|
* @summary List in-app notifications for the logged-in user
|
|
@@ -15532,6 +16278,15 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
15532
16278
|
* @throws {RequiredError}
|
|
15533
16279
|
*/
|
|
15534
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>;
|
|
15535
16290
|
/**
|
|
15536
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.
|
|
15537
16292
|
* @summary Send a notification (app token)
|
|
@@ -15540,6 +16295,14 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
15540
16295
|
* @throws {RequiredError}
|
|
15541
16296
|
*/
|
|
15542
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>;
|
|
15543
16306
|
};
|
|
15544
16307
|
/**
|
|
15545
16308
|
* NotificationsApi - functional programming interface
|
|
@@ -15560,6 +16323,14 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
|
|
|
15560
16323
|
* @throws {RequiredError}
|
|
15561
16324
|
*/
|
|
15562
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>>;
|
|
15563
16334
|
/**
|
|
15564
16335
|
* Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
|
|
15565
16336
|
* @summary List in-app notifications for the logged-in user
|
|
@@ -15584,6 +16355,15 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
|
|
|
15584
16355
|
* @throws {RequiredError}
|
|
15585
16356
|
*/
|
|
15586
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>>;
|
|
15587
16367
|
/**
|
|
15588
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.
|
|
15589
16369
|
* @summary Send a notification (app token)
|
|
@@ -15592,6 +16372,14 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
|
|
|
15592
16372
|
* @throws {RequiredError}
|
|
15593
16373
|
*/
|
|
15594
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>>;
|
|
15595
16383
|
};
|
|
15596
16384
|
/**
|
|
15597
16385
|
* NotificationsApi - factory interface
|
|
@@ -15612,6 +16400,14 @@ export declare const NotificationsApiFactory: (configuration?: Configuration, ba
|
|
|
15612
16400
|
* @throws {RequiredError}
|
|
15613
16401
|
*/
|
|
15614
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>;
|
|
15615
16411
|
/**
|
|
15616
16412
|
* Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
|
|
15617
16413
|
* @summary List in-app notifications for the logged-in user
|
|
@@ -15636,6 +16432,15 @@ export declare const NotificationsApiFactory: (configuration?: Configuration, ba
|
|
|
15636
16432
|
* @throws {RequiredError}
|
|
15637
16433
|
*/
|
|
15638
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>;
|
|
15639
16444
|
/**
|
|
15640
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.
|
|
15641
16446
|
* @summary Send a notification (app token)
|
|
@@ -15644,6 +16449,14 @@ export declare const NotificationsApiFactory: (configuration?: Configuration, ba
|
|
|
15644
16449
|
* @throws {RequiredError}
|
|
15645
16450
|
*/
|
|
15646
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>;
|
|
15647
16460
|
};
|
|
15648
16461
|
/**
|
|
15649
16462
|
* NotificationsApi - object-oriented interface
|
|
@@ -15664,6 +16477,14 @@ export declare class NotificationsApi extends BaseAPI {
|
|
|
15664
16477
|
* @throws {RequiredError}
|
|
15665
16478
|
*/
|
|
15666
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, {}>>;
|
|
15667
16488
|
/**
|
|
15668
16489
|
* Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
|
|
15669
16490
|
* @summary List in-app notifications for the logged-in user
|
|
@@ -15688,6 +16509,15 @@ export declare class NotificationsApi extends BaseAPI {
|
|
|
15688
16509
|
* @throws {RequiredError}
|
|
15689
16510
|
*/
|
|
15690
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, {}>>;
|
|
15691
16521
|
/**
|
|
15692
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.
|
|
15693
16523
|
* @summary Send a notification (app token)
|
|
@@ -15696,6 +16526,14 @@ export declare class NotificationsApi extends BaseAPI {
|
|
|
15696
16526
|
* @throws {RequiredError}
|
|
15697
16527
|
*/
|
|
15698
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, {}>>;
|
|
15699
16537
|
}
|
|
15700
16538
|
/**
|
|
15701
16539
|
* ObjectsApi - axios parameter creator
|
|
@@ -15728,16 +16566,17 @@ export declare const ObjectsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
15728
16566
|
*/
|
|
15729
16567
|
getAccessGrantCandidates: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15730
16568
|
/**
|
|
15731
|
-
* 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.
|
|
15732
16570
|
* @summary Get object by UUID
|
|
15733
16571
|
* @param {string} uuid
|
|
15734
16572
|
* @param {string} [views]
|
|
15735
16573
|
* @param {string} [properties]
|
|
15736
16574
|
* @param {string} [relations]
|
|
16575
|
+
* @param {boolean} [includeHiddenProperties]
|
|
15737
16576
|
* @param {*} [options] Override http request option.
|
|
15738
16577
|
* @throws {RequiredError}
|
|
15739
16578
|
*/
|
|
15740
|
-
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>;
|
|
15741
16580
|
/**
|
|
15742
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.
|
|
15743
16582
|
* @summary Fetch paginated objects
|
|
@@ -15876,16 +16715,17 @@ export declare const ObjectsApiFp: (configuration?: Configuration) => {
|
|
|
15876
16715
|
*/
|
|
15877
16716
|
getAccessGrantCandidates(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseObjectAccessGrantCandidatesDTO>>;
|
|
15878
16717
|
/**
|
|
15879
|
-
* 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.
|
|
15880
16719
|
* @summary Get object by UUID
|
|
15881
16720
|
* @param {string} uuid
|
|
15882
16721
|
* @param {string} [views]
|
|
15883
16722
|
* @param {string} [properties]
|
|
15884
16723
|
* @param {string} [relations]
|
|
16724
|
+
* @param {boolean} [includeHiddenProperties]
|
|
15885
16725
|
* @param {*} [options] Override http request option.
|
|
15886
16726
|
* @throws {RequiredError}
|
|
15887
16727
|
*/
|
|
15888
|
-
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>>;
|
|
15889
16729
|
/**
|
|
15890
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.
|
|
15891
16731
|
* @summary Fetch paginated objects
|
|
@@ -16024,16 +16864,17 @@ export declare const ObjectsApiFactory: (configuration?: Configuration, basePath
|
|
|
16024
16864
|
*/
|
|
16025
16865
|
getAccessGrantCandidates(options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseObjectAccessGrantCandidatesDTO>;
|
|
16026
16866
|
/**
|
|
16027
|
-
* 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.
|
|
16028
16868
|
* @summary Get object by UUID
|
|
16029
16869
|
* @param {string} uuid
|
|
16030
16870
|
* @param {string} [views]
|
|
16031
16871
|
* @param {string} [properties]
|
|
16032
16872
|
* @param {string} [relations]
|
|
16873
|
+
* @param {boolean} [includeHiddenProperties]
|
|
16033
16874
|
* @param {*} [options] Override http request option.
|
|
16034
16875
|
* @throws {RequiredError}
|
|
16035
16876
|
*/
|
|
16036
|
-
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>;
|
|
16037
16878
|
/**
|
|
16038
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.
|
|
16039
16880
|
* @summary Fetch paginated objects
|
|
@@ -16172,16 +17013,17 @@ export declare class ObjectsApi extends BaseAPI {
|
|
|
16172
17013
|
*/
|
|
16173
17014
|
getAccessGrantCandidates(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShowResponseObjectAccessGrantCandidatesDTO, any, {}>>;
|
|
16174
17015
|
/**
|
|
16175
|
-
* 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.
|
|
16176
17017
|
* @summary Get object by UUID
|
|
16177
17018
|
* @param {string} uuid
|
|
16178
17019
|
* @param {string} [views]
|
|
16179
17020
|
* @param {string} [properties]
|
|
16180
17021
|
* @param {string} [relations]
|
|
17022
|
+
* @param {boolean} [includeHiddenProperties]
|
|
16181
17023
|
* @param {*} [options] Override http request option.
|
|
16182
17024
|
* @throws {RequiredError}
|
|
16183
17025
|
*/
|
|
16184
|
-
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, {}>>;
|
|
16185
17027
|
/**
|
|
16186
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.
|
|
16187
17029
|
* @summary Fetch paginated objects
|
|
@@ -16872,6 +17714,14 @@ export declare const RecordsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
16872
17714
|
* @throws {RequiredError}
|
|
16873
17715
|
*/
|
|
16874
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>;
|
|
16875
17725
|
/**
|
|
16876
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.
|
|
16877
17727
|
* @summary Create a new record
|
|
@@ -16918,6 +17768,16 @@ export declare const RecordsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
16918
17768
|
* @throws {RequiredError}
|
|
16919
17769
|
*/
|
|
16920
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>;
|
|
16921
17781
|
/**
|
|
16922
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.
|
|
16923
17783
|
* @summary Extend a record
|
|
@@ -17145,6 +18005,14 @@ export declare const RecordsApiFp: (configuration?: Configuration) => {
|
|
|
17145
18005
|
* @throws {RequiredError}
|
|
17146
18006
|
*/
|
|
17147
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>>;
|
|
17148
18016
|
/**
|
|
17149
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.
|
|
17150
18018
|
* @summary Create a new record
|
|
@@ -17191,6 +18059,16 @@ export declare const RecordsApiFp: (configuration?: Configuration) => {
|
|
|
17191
18059
|
* @throws {RequiredError}
|
|
17192
18060
|
*/
|
|
17193
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>>;
|
|
17194
18072
|
/**
|
|
17195
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.
|
|
17196
18074
|
* @summary Extend a record
|
|
@@ -17418,6 +18296,14 @@ export declare const RecordsApiFactory: (configuration?: Configuration, basePath
|
|
|
17418
18296
|
* @throws {RequiredError}
|
|
17419
18297
|
*/
|
|
17420
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>;
|
|
17421
18307
|
/**
|
|
17422
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.
|
|
17423
18309
|
* @summary Create a new record
|
|
@@ -17464,6 +18350,16 @@ export declare const RecordsApiFactory: (configuration?: Configuration, basePath
|
|
|
17464
18350
|
* @throws {RequiredError}
|
|
17465
18351
|
*/
|
|
17466
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>;
|
|
17467
18363
|
/**
|
|
17468
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.
|
|
17469
18365
|
* @summary Extend a record
|
|
@@ -17691,6 +18587,14 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17691
18587
|
* @throws {RequiredError}
|
|
17692
18588
|
*/
|
|
17693
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, {}>>;
|
|
17694
18598
|
/**
|
|
17695
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.
|
|
17696
18600
|
* @summary Create a new record
|
|
@@ -17737,6 +18641,16 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17737
18641
|
* @throws {RequiredError}
|
|
17738
18642
|
*/
|
|
17739
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, {}>>;
|
|
17740
18654
|
/**
|
|
17741
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.
|
|
17742
18656
|
* @summary Extend a record
|
|
@@ -20198,6 +21112,15 @@ export declare const WebpagesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
20198
21112
|
* @throws {RequiredError}
|
|
20199
21113
|
*/
|
|
20200
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>;
|
|
20201
21124
|
/**
|
|
20202
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.
|
|
20203
21126
|
* @summary Public URL for a library file
|
|
@@ -20243,6 +21166,15 @@ export declare const WebpagesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
20243
21166
|
* @throws {RequiredError}
|
|
20244
21167
|
*/
|
|
20245
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>;
|
|
20246
21178
|
/**
|
|
20247
21179
|
* Validates password and returns a short-lived access token.
|
|
20248
21180
|
* @summary Unlock password-protected webpage
|
|
@@ -20582,6 +21514,15 @@ export declare const WebpagesApiFp: (configuration?: Configuration) => {
|
|
|
20582
21514
|
* @throws {RequiredError}
|
|
20583
21515
|
*/
|
|
20584
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>>;
|
|
20585
21526
|
/**
|
|
20586
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.
|
|
20587
21528
|
* @summary Public URL for a library file
|
|
@@ -20627,6 +21568,15 @@ export declare const WebpagesApiFp: (configuration?: Configuration) => {
|
|
|
20627
21568
|
* @throws {RequiredError}
|
|
20628
21569
|
*/
|
|
20629
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>>;
|
|
20630
21580
|
/**
|
|
20631
21581
|
* Validates password and returns a short-lived access token.
|
|
20632
21582
|
* @summary Unlock password-protected webpage
|
|
@@ -20966,6 +21916,15 @@ export declare const WebpagesApiFactory: (configuration?: Configuration, basePat
|
|
|
20966
21916
|
* @throws {RequiredError}
|
|
20967
21917
|
*/
|
|
20968
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>;
|
|
20969
21928
|
/**
|
|
20970
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.
|
|
20971
21930
|
* @summary Public URL for a library file
|
|
@@ -21011,6 +21970,15 @@ export declare const WebpagesApiFactory: (configuration?: Configuration, basePat
|
|
|
21011
21970
|
* @throws {RequiredError}
|
|
21012
21971
|
*/
|
|
21013
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>;
|
|
21014
21982
|
/**
|
|
21015
21983
|
* Validates password and returns a short-lived access token.
|
|
21016
21984
|
* @summary Unlock password-protected webpage
|
|
@@ -21350,6 +22318,15 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21350
22318
|
* @throws {RequiredError}
|
|
21351
22319
|
*/
|
|
21352
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, {}>>;
|
|
21353
22330
|
/**
|
|
21354
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.
|
|
21355
22332
|
* @summary Public URL for a library file
|
|
@@ -21395,6 +22372,15 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
21395
22372
|
* @throws {RequiredError}
|
|
21396
22373
|
*/
|
|
21397
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, {}>>;
|
|
21398
22384
|
/**
|
|
21399
22385
|
* Validates password and returns a short-lived access token.
|
|
21400
22386
|
* @summary Unlock password-protected webpage
|