@caraer/client 2.0.695 → 2.0.701

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. package/.openapi-generator/FILES +41 -0
  2. package/api.ts +1856 -201
  3. package/dist/api.d.ts +1017 -31
  4. package/dist/api.js +1280 -84
  5. package/dist/esm/api.d.ts +1017 -31
  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/Audience.md +36 -0
  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/CRUD.md +2 -0
  21. package/docs/CreatePrivateAppRequest.md +4 -0
  22. package/docs/CrudAccessContext.md +22 -0
  23. package/docs/EnsureRelationDTO.md +27 -0
  24. package/docs/ErrorResponse.md +2 -0
  25. package/docs/ExistingWidgetSummary.md +2 -2
  26. package/docs/FavoriteViewDTO.md +22 -0
  27. package/docs/NavigationApi.md +280 -0
  28. package/docs/NavigationDTO.md +27 -0
  29. package/docs/NavigationObjectDTO.md +38 -0
  30. package/docs/NavigationViewDTO.md +44 -0
  31. package/docs/NotificationDeviceReceipt.md +26 -0
  32. package/docs/NotificationDeviceRegistration.md +28 -0
  33. package/docs/NotificationsApi.md +172 -0
  34. package/docs/ObjectReferenceDTO.md +32 -0
  35. package/docs/ObjectsApi.md +5 -2
  36. package/docs/Palette.md +22 -0
  37. package/docs/Permissions.md +22 -0
  38. package/docs/RecordsApi.md +119 -0
  39. package/docs/RelationCapabilities.md +26 -0
  40. package/docs/RelationCapabilityEdge.md +22 -0
  41. package/docs/RelationCapabilityEdges.md +22 -0
  42. package/docs/RelationCapabilityOperation.md +22 -0
  43. package/docs/RelationCapabilityPair.md +22 -0
  44. package/docs/RelationCapabilityPairCapability.md +34 -0
  45. package/docs/RelationCapabilityPrimary.md +22 -0
  46. package/docs/RelationCapabilityRequest.md +22 -0
  47. package/docs/ShowResponseBrowserAuthSessionResponse.md +23 -0
  48. package/docs/ShowResponseBrowserAuthStartResponse.md +23 -0
  49. package/docs/ShowResponseItem.md +23 -0
  50. package/docs/ShowResponseNotificationDeviceReceipt.md +23 -0
  51. package/docs/ShowResponseRelationCapabilities.md +23 -0
  52. package/docs/ShowResponseWebpageEditorDefaultsDTO.md +23 -0
  53. package/docs/SimpleCompanyDTO.md +22 -0
  54. package/docs/SuccessResponseEnsureRelationDTO.md +23 -0
  55. package/docs/SuccessResponseListFavoriteViewDTO.md +23 -0
  56. package/docs/SuccessResponseListNavigationViewDTO.md +23 -0
  57. package/docs/SuccessResponseNavigationDTO.md +23 -0
  58. package/docs/UserDTO.md +46 -0
  59. package/docs/ViewNavigationPreferencesRequest.md +23 -0
  60. package/docs/WebpageEditorDefaultsDTO.md +25 -0
  61. package/docs/WebpagesApi.md +118 -0
  62. 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
  */
@@ -1054,6 +1100,17 @@ export interface ArchivedRecordObjectDTO {
1054
1100
  'icon'?: string;
1055
1101
  'index'?: number;
1056
1102
  }
1103
+ export interface Audience {
1104
+ 'authentication'?: any;
1105
+ 'principal'?: any;
1106
+ 'authenticated'?: boolean;
1107
+ 'database'?: string;
1108
+ 'principalDatabase'?: string;
1109
+ 'companyUuid'?: string;
1110
+ 'principalUuid'?: string;
1111
+ 'authorities'?: Array<string>;
1112
+ 'roles'?: Array<string>;
1113
+ }
1057
1114
  /**
1058
1115
  * The billing settings of the company.
1059
1116
  */
@@ -1123,6 +1180,29 @@ export interface BillingSettingsDTO {
1123
1180
  */
1124
1181
  'country'?: string;
1125
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
+ }
1126
1206
  /**
1127
1207
  * Payload of a bulk delete records response.
1128
1208
  */
@@ -1182,7 +1262,15 @@ export interface BulkEditRecordErrorItem {
1182
1262
  * Field-level validation errors.
1183
1263
  */
1184
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;
1185
1269
  }
1270
+ export declare const BulkEditRecordErrorItemRecordWriteOutcomeEnum: {
1271
+ readonly NotStarted: "NOT_STARTED";
1272
+ };
1273
+ export type BulkEditRecordErrorItemRecordWriteOutcomeEnum = typeof BulkEditRecordErrorItemRecordWriteOutcomeEnum[keyof typeof BulkEditRecordErrorItemRecordWriteOutcomeEnum];
1186
1274
  /**
1187
1275
  * A single record to create or update in a bulk edit request.
1188
1276
  */
@@ -1261,6 +1349,7 @@ export interface BulkEditRecordsResponse {
1261
1349
  export interface CRUD {
1262
1350
  'httpSessionId'?: string;
1263
1351
  'turnOffMetaRelationships'?: boolean;
1352
+ 'httpAccessContext'?: CrudAccessContext;
1264
1353
  }
1265
1354
  export interface CalendarBootstrapDTO {
1266
1355
  'defaultCalendar'?: CalendarRecordDTO;
@@ -1809,6 +1898,14 @@ export interface CreateOrUpdateEnvironmentRequest {
1809
1898
  * Private app creator manifest; label is required and internal name is optional
1810
1899
  */
1811
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;
1812
1909
  /**
1813
1910
  * Unique identifier for the entity
1814
1911
  */
@@ -2189,6 +2286,10 @@ export interface CrossObjectRecordSearchRequest {
2189
2286
  */
2190
2287
  'excludeRecordUuid'?: string;
2191
2288
  }
2289
+ export interface CrudAccessContext {
2290
+ 'audience'?: Audience;
2291
+ 'permissions'?: Permissions;
2292
+ }
2192
2293
  export interface Currency extends PropertyFormat {
2193
2294
  }
2194
2295
  export interface CurrencyRange extends PropertyFormat {
@@ -2757,6 +2858,20 @@ export interface EngagementBatchRequest {
2757
2858
  'sessionId'?: string;
2758
2859
  'events'?: Array<TrackingEventRequest>;
2759
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];
2760
2875
  /**
2761
2876
  * Defines the structure of error responses returned by the API.
2762
2877
  */
@@ -2773,6 +2888,10 @@ export interface ErrorResponse {
2773
2888
  * The HTTP status code associated with the error.
2774
2889
  */
2775
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;
2776
2895
  'stackTrace'?: string;
2777
2896
  /**
2778
2897
  * Roles the caller is missing when the failure is an authorization error.
@@ -2787,6 +2906,10 @@ export interface ErrorResponse {
2787
2906
  */
2788
2907
  'requestId'?: string;
2789
2908
  }
2909
+ export declare const ErrorResponseRecordWriteOutcomeEnum: {
2910
+ readonly NotStarted: "NOT_STARTED";
2911
+ };
2912
+ export type ErrorResponseRecordWriteOutcomeEnum = typeof ErrorResponseRecordWriteOutcomeEnum[keyof typeof ErrorResponseRecordWriteOutcomeEnum];
2790
2913
  export declare const ErrorResponseRolesEnum: {
2791
2914
  readonly User: "USER";
2792
2915
  readonly Admin: "ADMIN";
@@ -2819,9 +2942,9 @@ export declare const EventRsvpRequestScopeEnum: {
2819
2942
  };
2820
2943
  export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
2821
2944
  export interface ExistingWidgetSummary {
2822
- 'xproperty'?: string;
2823
2945
  'ymetric'?: string;
2824
2946
  'yproperty'?: string;
2947
+ 'xproperty'?: string;
2825
2948
  'title'?: string;
2826
2949
  'chartType'?: string;
2827
2950
  'xProperty'?: string;
@@ -2837,6 +2960,10 @@ export interface ExtendRecordRequest {
2837
2960
  */
2838
2961
  'objects'?: Set<CaraerObjectDTO>;
2839
2962
  }
2963
+ export interface FavoriteViewDTO {
2964
+ 'object'?: ObjectReferenceDTO;
2965
+ 'view'?: NavigationViewDTO;
2966
+ }
2840
2967
  export interface FeedDTO {
2841
2968
  /**
2842
2969
  * Unique identifier for the entity
@@ -3772,6 +3899,42 @@ export interface MultiValueMapStringString {
3772
3899
  };
3773
3900
  'empty'?: boolean;
3774
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
+ }
3775
3938
  export interface NotFoundError {
3776
3939
  'cause'?: NotFoundErrorCause;
3777
3940
  'stackTrace'?: Array<NotFoundErrorCauseStackTraceInner>;
@@ -3813,6 +3976,19 @@ export interface NotFoundErrorCauseStackTraceInner {
3813
3976
  'className'?: string;
3814
3977
  'nativeMethod'?: boolean;
3815
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
+ }
3816
3992
  export interface NotificationInboxDTO {
3817
3993
  'notifications'?: Array<Item>;
3818
3994
  'unreadCount'?: number;
@@ -3880,6 +4056,15 @@ export interface ObjectAccessGrantSectionDTO {
3880
4056
  [key: string]: Array<string>;
3881
4057
  };
3882
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
+ }
3883
4068
  /**
3884
4069
  * Data transfer object representing a webpage content
3885
4070
  */
@@ -4663,6 +4848,18 @@ export interface PaginationResponseWebpageAccessGrantDTO {
4663
4848
  */
4664
4849
  'lastPage'?: number;
4665
4850
  }
4851
+ export interface Palette {
4852
+ 'light'?: {
4853
+ [key: string]: string;
4854
+ };
4855
+ 'dark'?: {
4856
+ [key: string]: string;
4857
+ };
4858
+ }
4859
+ export interface Permissions {
4860
+ 'scopes'?: Array<string>;
4861
+ 'filters'?: any;
4862
+ }
4666
4863
  export interface Phone extends PropertyFormat {
4667
4864
  }
4668
4865
  /**
@@ -5515,6 +5712,69 @@ export interface RegisterRequest {
5515
5712
  'firstname': string;
5516
5713
  'lastname': string;
5517
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
+ }
5518
5778
  /**
5519
5779
  * Data transfer object representing a relation between Caraer objects
5520
5780
  */
@@ -6210,6 +6470,32 @@ export interface ShowResponseBillingStatusDTO {
6210
6470
  [key: string]: any;
6211
6471
  };
6212
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
+ }
6213
6499
  /**
6214
6500
  * Success response (ShowResponseCaraerObjectDTO).
6215
6501
  */
@@ -6311,6 +6597,19 @@ export interface ShowResponseFormDTO {
6311
6597
  [key: string]: any;
6312
6598
  };
6313
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
+ }
6314
6613
  /**
6315
6614
  * Represents the response for viewing or showing a specific resource.
6316
6615
  */
@@ -6516,6 +6815,19 @@ export interface ShowResponseMapStringString {
6516
6815
  [key: string]: string;
6517
6816
  };
6518
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
+ }
6519
6831
  /**
6520
6832
  * Represents the response for viewing or showing a specific resource.
6521
6833
  */
@@ -6595,6 +6907,19 @@ export interface ShowResponsePublicFormDTO {
6595
6907
  [key: string]: any;
6596
6908
  };
6597
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
+ }
6598
6923
  /**
6599
6924
  * Success response (ShowResponseRelationDTO).
6600
6925
  */
@@ -6695,6 +7020,19 @@ export interface ShowResponseWebMenuDTO {
6695
7020
  [key: string]: any;
6696
7021
  };
6697
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
+ }
6698
7036
  /**
6699
7037
  * Represents the response for viewing or showing a specific resource.
6700
7038
  */
@@ -6739,6 +7077,10 @@ export interface SignedUrlResultDTO {
6739
7077
  'expiresAt'?: number;
6740
7078
  'queryParams'?: string;
6741
7079
  }
7080
+ export interface SimpleCompanyDTO {
7081
+ 'uuid'?: string;
7082
+ 'name'?: string;
7083
+ }
6742
7084
  /**
6743
7085
  * Data Transfer Object representing a public-facing view of a company
6744
7086
  */
@@ -7330,6 +7672,19 @@ export interface SuccessResponseCompanyDTO {
7330
7672
  */
7331
7673
  'data'?: CompanyDTO;
7332
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
+ }
7333
7688
  /**
7334
7689
  * Represents a standard successful response with a message and optional data.
7335
7690
  */
@@ -7457,6 +7812,19 @@ export interface SuccessResponseListDeveloperSandboxDTO {
7457
7812
  */
7458
7813
  'data'?: Array<DeveloperSandboxDTO>;
7459
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
+ }
7460
7828
  /**
7461
7829
  * Represents a standard successful response with a message and optional data.
7462
7830
  */
@@ -7485,6 +7853,19 @@ export interface SuccessResponseListMapStringObject {
7485
7853
  [key: string]: any | null;
7486
7854
  }>;
7487
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
+ }
7488
7869
  /**
7489
7870
  * Represents a standard successful response with a message and optional data.
7490
7871
  */
@@ -7549,6 +7930,19 @@ export interface SuccessResponseMapStringObject {
7549
7930
  [key: string]: any;
7550
7931
  };
7551
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
+ }
7552
7946
  /**
7553
7947
  * Success response (SuccessResponseObject).
7554
7948
  */
@@ -7948,6 +8342,24 @@ export interface UsedInResult {
7948
8342
  'recordUuids'?: Array<string>;
7949
8343
  'count'?: number;
7950
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
+ }
7951
8363
  /**
7952
8364
  * Record response for user API endpoints, including linked user data.
7953
8365
  */
@@ -8123,6 +8535,17 @@ export interface ViewDTO {
8123
8535
  'isInternallyPublic'?: boolean;
8124
8536
  'analytics'?: AnalyticsDashboardConfig;
8125
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
+ }
8126
8549
  export interface ViewShareRequest {
8127
8550
  'users'?: Array<ModelRecord>;
8128
8551
  'teams'?: Array<ModelRecord>;
@@ -8388,6 +8811,16 @@ export interface WebpageEditingStatusDTO {
8388
8811
  */
8389
8812
  'message'?: string;
8390
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
+ }
8391
8824
  /**
8392
8825
  * Resolved public map markers for a webpage map block
8393
8826
  */
@@ -8774,10 +9207,11 @@ export declare const AppBarsApiAxiosParamCreator: (configuration?: Configuration
8774
9207
  * @param {string} [viewId] View ID in context
8775
9208
  * @param {string} [trait] Trait name in context
8776
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.
8777
9211
  * @param {*} [options] Override http request option.
8778
9212
  * @throws {RequiredError}
8779
9213
  */
8780
- 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>;
8781
9215
  /**
8782
9216
  * Fires the app bar webhook with optional settings values and record/view context.
8783
9217
  * @summary Trigger an action-based app bar
@@ -8801,10 +9235,11 @@ export declare const AppBarsApiFp: (configuration?: Configuration) => {
8801
9235
  * @param {string} [viewId] View ID in context
8802
9236
  * @param {string} [trait] Trait name in context
8803
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.
8804
9239
  * @param {*} [options] Override http request option.
8805
9240
  * @throws {RequiredError}
8806
9241
  */
8807
- 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>>;
8808
9243
  /**
8809
9244
  * Fires the app bar webhook with optional settings values and record/view context.
8810
9245
  * @summary Trigger an action-based app bar
@@ -8828,10 +9263,11 @@ export declare const AppBarsApiFactory: (configuration?: Configuration, basePath
8828
9263
  * @param {string} [viewId] View ID in context
8829
9264
  * @param {string} [trait] Trait name in context
8830
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.
8831
9267
  * @param {*} [options] Override http request option.
8832
9268
  * @throws {RequiredError}
8833
9269
  */
8834
- 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>;
8835
9271
  /**
8836
9272
  * Fires the app bar webhook with optional settings values and record/view context.
8837
9273
  * @summary Trigger an action-based app bar
@@ -8855,10 +9291,11 @@ export declare class AppBarsApi extends BaseAPI {
8855
9291
  * @param {string} [viewId] View ID in context
8856
9292
  * @param {string} [trait] Trait name in context
8857
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.
8858
9295
  * @param {*} [options] Override http request option.
8859
9296
  * @throws {RequiredError}
8860
9297
  */
8861
- 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, {}>>;
8862
9299
  /**
8863
9300
  * Fires the app bar webhook with optional settings values and record/view context.
8864
9301
  * @summary Trigger an action-based app bar
@@ -8878,6 +9315,11 @@ export declare const ListAppBarsLocationEnum: {
8878
9315
  readonly RecordTrait: "RECORD_TRAIT";
8879
9316
  };
8880
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];
8881
9323
  /**
8882
9324
  * AppInstallationRuntimeApi - axios parameter creator
8883
9325
  */
@@ -10957,37 +11399,153 @@ export declare class BillingApi extends BaseAPI {
10957
11399
  sendSetupEmail(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringBoolean, any, {}>>;
10958
11400
  }
10959
11401
  /**
10960
- * CMSModulesApi - axios parameter creator
11402
+ * BrowserAuthenticationApi - axios parameter creator
10961
11403
  */
10962
- export declare const CMSModulesApiAxiosParamCreator: (configuration?: Configuration) => {
11404
+ export declare const BrowserAuthenticationApiAxiosParamCreator: (configuration?: Configuration) => {
10963
11405
  /**
10964
- * Includes retired modules, so a developer can see what a push removed.
10965
- * @summary List an app\'s CMS modules
10966
- * @param {string} appUuid
11406
+ *
11407
+ * @summary Open the browser-owned provider session
11408
+ * @param {string} flow
10967
11409
  * @param {*} [options] Override http request option.
10968
11410
  * @throws {RequiredError}
10969
11411
  */
10970
- list: (appUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11412
+ authorize: (flow: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10971
11413
  /**
10972
- * Accepts a staged npm tarball (base64) and module manifests. Publishes to the platform registry with the host token, then replaces the catalog.
10973
- * @summary Publish an app\'s CMS module package
10974
- * @param {string} appUuid
10975
- * @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
10976
11417
  * @param {*} [options] Override http request option.
10977
11418
  * @throws {RequiredError}
10978
11419
  */
10979
- publishPackage: (appUuid: string, requestBody: {
10980
- [key: string]: any | null;
10981
- }, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11420
+ exchange: (browserAuthExchangeRequest: BrowserAuthExchangeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10982
11421
  /**
10983
- * 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.
10984
- * @summary Replace an app\'s CMS module catalog
10985
- * @param {string} appUuid
10986
- * @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
10987
11425
  * @param {*} [options] Override http request option.
10988
11426
  * @throws {RequiredError}
10989
11427
  */
10990
- upsert: (appUuid: string, requestBody: {
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: {
10991
11549
  [key: string]: any | null;
10992
11550
  }, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10993
11551
  };
@@ -15488,6 +16046,186 @@ export declare class ModuleApi extends BaseAPI {
15488
16046
  */
15489
16047
  updatePersonalModule(moduleId: string, pageContentDTO: PageContentDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateResponse, any, {}>>;
15490
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
+ }
15491
16229
  /**
15492
16230
  * NotificationsApi - axios parameter creator
15493
16231
  */
@@ -15507,6 +16245,14 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
15507
16245
  * @throws {RequiredError}
15508
16246
  */
15509
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>;
15510
16256
  /**
15511
16257
  * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
15512
16258
  * @summary List in-app notifications for the logged-in user
@@ -15531,6 +16277,15 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
15531
16277
  * @throws {RequiredError}
15532
16278
  */
15533
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>;
15534
16289
  /**
15535
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.
15536
16291
  * @summary Send a notification (app token)
@@ -15539,6 +16294,14 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
15539
16294
  * @throws {RequiredError}
15540
16295
  */
15541
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>;
15542
16305
  };
15543
16306
  /**
15544
16307
  * NotificationsApi - functional programming interface
@@ -15559,6 +16322,14 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
15559
16322
  * @throws {RequiredError}
15560
16323
  */
15561
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>>;
15562
16333
  /**
15563
16334
  * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
15564
16335
  * @summary List in-app notifications for the logged-in user
@@ -15583,6 +16354,15 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
15583
16354
  * @throws {RequiredError}
15584
16355
  */
15585
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>>;
15586
16366
  /**
15587
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.
15588
16368
  * @summary Send a notification (app token)
@@ -15591,6 +16371,14 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
15591
16371
  * @throws {RequiredError}
15592
16372
  */
15593
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>>;
15594
16382
  };
15595
16383
  /**
15596
16384
  * NotificationsApi - factory interface
@@ -15611,6 +16399,14 @@ export declare const NotificationsApiFactory: (configuration?: Configuration, ba
15611
16399
  * @throws {RequiredError}
15612
16400
  */
15613
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>;
15614
16410
  /**
15615
16411
  * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
15616
16412
  * @summary List in-app notifications for the logged-in user
@@ -15635,6 +16431,15 @@ export declare const NotificationsApiFactory: (configuration?: Configuration, ba
15635
16431
  * @throws {RequiredError}
15636
16432
  */
15637
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>;
15638
16443
  /**
15639
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.
15640
16445
  * @summary Send a notification (app token)
@@ -15643,6 +16448,14 @@ export declare const NotificationsApiFactory: (configuration?: Configuration, ba
15643
16448
  * @throws {RequiredError}
15644
16449
  */
15645
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>;
15646
16459
  };
15647
16460
  /**
15648
16461
  * NotificationsApi - object-oriented interface
@@ -15663,6 +16476,14 @@ export declare class NotificationsApi extends BaseAPI {
15663
16476
  * @throws {RequiredError}
15664
16477
  */
15665
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, {}>>;
15666
16487
  /**
15667
16488
  * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
15668
16489
  * @summary List in-app notifications for the logged-in user
@@ -15687,6 +16508,15 @@ export declare class NotificationsApi extends BaseAPI {
15687
16508
  * @throws {RequiredError}
15688
16509
  */
15689
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, {}>>;
15690
16520
  /**
15691
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.
15692
16522
  * @summary Send a notification (app token)
@@ -15695,6 +16525,14 @@ export declare class NotificationsApi extends BaseAPI {
15695
16525
  * @throws {RequiredError}
15696
16526
  */
15697
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, {}>>;
15698
16536
  }
15699
16537
  /**
15700
16538
  * ObjectsApi - axios parameter creator
@@ -15727,16 +16565,17 @@ export declare const ObjectsApiAxiosParamCreator: (configuration?: Configuration
15727
16565
  */
15728
16566
  getAccessGrantCandidates: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
15729
16567
  /**
15730
- * 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.
15731
16569
  * @summary Get object by UUID
15732
16570
  * @param {string} uuid
15733
16571
  * @param {string} [views]
15734
16572
  * @param {string} [properties]
15735
16573
  * @param {string} [relations]
16574
+ * @param {boolean} [includeHiddenProperties]
15736
16575
  * @param {*} [options] Override http request option.
15737
16576
  * @throws {RequiredError}
15738
16577
  */
15739
- 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>;
15740
16579
  /**
15741
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.
15742
16581
  * @summary Fetch paginated objects
@@ -15875,16 +16714,17 @@ export declare const ObjectsApiFp: (configuration?: Configuration) => {
15875
16714
  */
15876
16715
  getAccessGrantCandidates(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseObjectAccessGrantCandidatesDTO>>;
15877
16716
  /**
15878
- * 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.
15879
16718
  * @summary Get object by UUID
15880
16719
  * @param {string} uuid
15881
16720
  * @param {string} [views]
15882
16721
  * @param {string} [properties]
15883
16722
  * @param {string} [relations]
16723
+ * @param {boolean} [includeHiddenProperties]
15884
16724
  * @param {*} [options] Override http request option.
15885
16725
  * @throws {RequiredError}
15886
16726
  */
15887
- 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>>;
15888
16728
  /**
15889
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.
15890
16730
  * @summary Fetch paginated objects
@@ -16023,16 +16863,17 @@ export declare const ObjectsApiFactory: (configuration?: Configuration, basePath
16023
16863
  */
16024
16864
  getAccessGrantCandidates(options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseObjectAccessGrantCandidatesDTO>;
16025
16865
  /**
16026
- * 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.
16027
16867
  * @summary Get object by UUID
16028
16868
  * @param {string} uuid
16029
16869
  * @param {string} [views]
16030
16870
  * @param {string} [properties]
16031
16871
  * @param {string} [relations]
16872
+ * @param {boolean} [includeHiddenProperties]
16032
16873
  * @param {*} [options] Override http request option.
16033
16874
  * @throws {RequiredError}
16034
16875
  */
16035
- 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>;
16036
16877
  /**
16037
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.
16038
16879
  * @summary Fetch paginated objects
@@ -16171,16 +17012,17 @@ export declare class ObjectsApi extends BaseAPI {
16171
17012
  */
16172
17013
  getAccessGrantCandidates(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseObjectAccessGrantCandidatesDTO, any, {}>>;
16173
17014
  /**
16174
- * 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.
16175
17016
  * @summary Get object by UUID
16176
17017
  * @param {string} uuid
16177
17018
  * @param {string} [views]
16178
17019
  * @param {string} [properties]
16179
17020
  * @param {string} [relations]
17021
+ * @param {boolean} [includeHiddenProperties]
16180
17022
  * @param {*} [options] Override http request option.
16181
17023
  * @throws {RequiredError}
16182
17024
  */
16183
- 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, {}>>;
16184
17026
  /**
16185
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.
16186
17028
  * @summary Fetch paginated objects
@@ -16871,6 +17713,14 @@ export declare const RecordsApiAxiosParamCreator: (configuration?: Configuration
16871
17713
  * @throws {RequiredError}
16872
17714
  */
16873
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>;
16874
17724
  /**
16875
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.
16876
17726
  * @summary Create a new record
@@ -16917,6 +17767,16 @@ export declare const RecordsApiAxiosParamCreator: (configuration?: Configuration
16917
17767
  * @throws {RequiredError}
16918
17768
  */
16919
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>;
16920
17780
  /**
16921
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.
16922
17782
  * @summary Extend a record
@@ -17144,6 +18004,14 @@ export declare const RecordsApiFp: (configuration?: Configuration) => {
17144
18004
  * @throws {RequiredError}
17145
18005
  */
17146
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>>;
17147
18015
  /**
17148
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.
17149
18017
  * @summary Create a new record
@@ -17190,6 +18058,16 @@ export declare const RecordsApiFp: (configuration?: Configuration) => {
17190
18058
  * @throws {RequiredError}
17191
18059
  */
17192
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>>;
17193
18071
  /**
17194
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.
17195
18073
  * @summary Extend a record
@@ -17417,6 +18295,14 @@ export declare const RecordsApiFactory: (configuration?: Configuration, basePath
17417
18295
  * @throws {RequiredError}
17418
18296
  */
17419
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>;
17420
18306
  /**
17421
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.
17422
18308
  * @summary Create a new record
@@ -17463,6 +18349,16 @@ export declare const RecordsApiFactory: (configuration?: Configuration, basePath
17463
18349
  * @throws {RequiredError}
17464
18350
  */
17465
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>;
17466
18362
  /**
17467
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.
17468
18364
  * @summary Extend a record
@@ -17690,6 +18586,14 @@ export declare class RecordsApi extends BaseAPI {
17690
18586
  * @throws {RequiredError}
17691
18587
  */
17692
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, {}>>;
17693
18597
  /**
17694
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.
17695
18599
  * @summary Create a new record
@@ -17736,6 +18640,16 @@ export declare class RecordsApi extends BaseAPI {
17736
18640
  * @throws {RequiredError}
17737
18641
  */
17738
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, {}>>;
17739
18653
  /**
17740
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.
17741
18655
  * @summary Extend a record
@@ -20197,6 +21111,15 @@ export declare const WebpagesApiAxiosParamCreator: (configuration?: Configuratio
20197
21111
  * @throws {RequiredError}
20198
21112
  */
20199
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>;
20200
21123
  /**
20201
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.
20202
21125
  * @summary Public URL for a library file
@@ -20242,6 +21165,15 @@ export declare const WebpagesApiAxiosParamCreator: (configuration?: Configuratio
20242
21165
  * @throws {RequiredError}
20243
21166
  */
20244
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>;
20245
21177
  /**
20246
21178
  * Validates password and returns a short-lived access token.
20247
21179
  * @summary Unlock password-protected webpage
@@ -20581,6 +21513,15 @@ export declare const WebpagesApiFp: (configuration?: Configuration) => {
20581
21513
  * @throws {RequiredError}
20582
21514
  */
20583
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>>;
20584
21525
  /**
20585
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.
20586
21527
  * @summary Public URL for a library file
@@ -20626,6 +21567,15 @@ export declare const WebpagesApiFp: (configuration?: Configuration) => {
20626
21567
  * @throws {RequiredError}
20627
21568
  */
20628
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>>;
20629
21579
  /**
20630
21580
  * Validates password and returns a short-lived access token.
20631
21581
  * @summary Unlock password-protected webpage
@@ -20965,6 +21915,15 @@ export declare const WebpagesApiFactory: (configuration?: Configuration, basePat
20965
21915
  * @throws {RequiredError}
20966
21916
  */
20967
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>;
20968
21927
  /**
20969
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.
20970
21929
  * @summary Public URL for a library file
@@ -21010,6 +21969,15 @@ export declare const WebpagesApiFactory: (configuration?: Configuration, basePat
21010
21969
  * @throws {RequiredError}
21011
21970
  */
21012
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>;
21013
21981
  /**
21014
21982
  * Validates password and returns a short-lived access token.
21015
21983
  * @summary Unlock password-protected webpage
@@ -21349,6 +22317,15 @@ export declare class WebpagesApi extends BaseAPI {
21349
22317
  * @throws {RequiredError}
21350
22318
  */
21351
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, {}>>;
21352
22329
  /**
21353
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.
21354
22331
  * @summary Public URL for a library file
@@ -21394,6 +22371,15 @@ export declare class WebpagesApi extends BaseAPI {
21394
22371
  * @throws {RequiredError}
21395
22372
  */
21396
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, {}>>;
21397
22383
  /**
21398
22384
  * Validates password and returns a short-lived access token.
21399
22385
  * @summary Unlock password-protected webpage