@caraer/client 2.0.696 → 2.0.702

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