@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/api.ts CHANGED
@@ -237,10 +237,26 @@ export interface AnalyticsWidgetStyle {
237
237
  'colors'?: { [key: string]: string; };
238
238
  'referenceLines'?: Array<AnalyticsReferenceLine>;
239
239
  }
240
+ export interface ApiTokenDTO {
241
+ 'token'?: string;
242
+ 'expiresAt'?: number;
243
+ }
240
244
  /**
241
245
  * Data transfer object for an app bar (location-specific settings and action config)
242
246
  */
243
247
  export interface AppBarDTO {
248
+ /**
249
+ * TOOL_BAR navigation: SUITE (legacy default) or suite-independent SETTINGS. Omission preserves an existing value.
250
+ */
251
+ 'navigationPlacement'?: AppBarDTONavigationPlacementEnum;
252
+ /**
253
+ * Literal human caller scopes required for TOOL_BAR discovery and iframe access. Omission preserves; [] clears.
254
+ */
255
+ 'requiredUserScopes'?: Array<string>;
256
+ /**
257
+ * Unique unreserved settings-relative route slugs for a SETTINGS tool. Omission preserves; [] clears.
258
+ */
259
+ 'routeAliases'?: Array<string>;
244
260
  /**
245
261
  * Unique identifier for the entity
246
262
  */
@@ -315,6 +331,12 @@ export interface AppBarDTO {
315
331
  'webhook'?: SubscribeWebhookDTO;
316
332
  }
317
333
 
334
+ export const AppBarDTONavigationPlacementEnum = {
335
+ Suite: 'SUITE',
336
+ Settings: 'SETTINGS',
337
+ } as const;
338
+
339
+ export type AppBarDTONavigationPlacementEnum = typeof AppBarDTONavigationPlacementEnum[keyof typeof AppBarDTONavigationPlacementEnum];
318
340
  export const AppBarDTOLocationEnum = {
319
341
  RecordPreview: 'RECORD_PREVIEW',
320
342
  RecordOverview: 'RECORD_OVERVIEW',
@@ -330,6 +352,14 @@ export type AppBarDTOLocationEnum = typeof AppBarDTOLocationEnum[keyof typeof Ap
330
352
  * Request body for creating an iframe session token
331
353
  */
332
354
  export interface AppBarIframeSessionRequest {
355
+ /**
356
+ * Selected suite for explicit SUITE tool requests; omitted legacy requests retain configured-suite behavior
357
+ */
358
+ 'suite'?: string;
359
+ /**
360
+ * Explicit TOOL_BAR placement; must match the stored descriptor
361
+ */
362
+ 'navigationPlacement'?: AppBarIframeSessionRequestNavigationPlacementEnum;
333
363
  /**
334
364
  * Object name in context
335
365
  */
@@ -351,6 +381,14 @@ export interface AppBarIframeSessionRequest {
351
381
  */
352
382
  'viewData'?: { [key: string]: any | null; };
353
383
  }
384
+
385
+ export const AppBarIframeSessionRequestNavigationPlacementEnum = {
386
+ Suite: 'SUITE',
387
+ Settings: 'SETTINGS',
388
+ } as const;
389
+
390
+ export type AppBarIframeSessionRequestNavigationPlacementEnum = typeof AppBarIframeSessionRequestNavigationPlacementEnum[keyof typeof AppBarIframeSessionRequestNavigationPlacementEnum];
391
+
354
392
  /**
355
393
  * Request body for validating an iframe session token
356
394
  */
@@ -431,6 +469,14 @@ export interface AppConnectionStatusDTO {
431
469
  * Full app payload (AppCreatorDTO) to apply
432
470
  */
433
471
  export interface AppDTO {
472
+ /**
473
+ * Stable creator input for brandmark; display uses brandmark URL
474
+ */
475
+ 'brandmarkReference'?: string;
476
+ /**
477
+ * Stable creator input for details.image; display uses image URL
478
+ */
479
+ 'imageReference'?: string;
434
480
  /**
435
481
  * Unique identifier for the entity
436
482
  */
@@ -647,6 +693,10 @@ export interface AppDetailsDTO {
647
693
  */
648
694
  'description'?: string;
649
695
  'image'?: string;
696
+ /**
697
+ * Stable creator input for image; never persist a signed display URL
698
+ */
699
+ 'imageReference'?: string;
650
700
  /**
651
701
  * Hex accent color (#RRGGBB) for installed app-bar action buttons and toolbar icons
652
702
  */
@@ -1064,6 +1114,17 @@ export interface ArchivedRecordObjectDTO {
1064
1114
  'icon'?: string;
1065
1115
  'index'?: number;
1066
1116
  }
1117
+ export interface Audience {
1118
+ 'authentication'?: any;
1119
+ 'principal'?: any;
1120
+ 'authenticated'?: boolean;
1121
+ 'database'?: string;
1122
+ 'principalDatabase'?: string;
1123
+ 'companyUuid'?: string;
1124
+ 'principalUuid'?: string;
1125
+ 'authorities'?: Array<string>;
1126
+ 'roles'?: Array<string>;
1127
+ }
1067
1128
  /**
1068
1129
  * The billing settings of the company.
1069
1130
  */
@@ -1133,6 +1194,29 @@ export interface BillingSettingsDTO {
1133
1194
  */
1134
1195
  'country'?: string;
1135
1196
  }
1197
+ export interface BrowserAuthExchangeRequest {
1198
+ 'code'?: string;
1199
+ 'codeVerifier'?: string;
1200
+ 'redirectUri'?: string;
1201
+ }
1202
+ export interface BrowserAuthSessionResponse {
1203
+ 'accessToken'?: string;
1204
+ 'refreshToken'?: string;
1205
+ 'tokenType'?: string;
1206
+ 'user'?: UserDTO;
1207
+ 'companyUuid'?: string;
1208
+ }
1209
+ export interface BrowserAuthStartRequest {
1210
+ 'provider'?: string;
1211
+ 'redirectUri'?: string;
1212
+ 'codeChallenge'?: string;
1213
+ 'codeChallengeMethod'?: string;
1214
+ 'state'?: string;
1215
+ }
1216
+ export interface BrowserAuthStartResponse {
1217
+ 'authorizationUrl'?: string;
1218
+ 'expiresIn'?: number;
1219
+ }
1136
1220
  /**
1137
1221
  * Payload of a bulk delete records response.
1138
1222
  */
@@ -1192,7 +1276,18 @@ export interface BulkEditRecordErrorItem {
1192
1276
  * Field-level validation errors.
1193
1277
  */
1194
1278
  'errors'?: Array<CaraerErrorType>;
1279
+ /**
1280
+ * 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.
1281
+ */
1282
+ 'recordWriteOutcome'?: BulkEditRecordErrorItemRecordWriteOutcomeEnum;
1195
1283
  }
1284
+
1285
+ export const BulkEditRecordErrorItemRecordWriteOutcomeEnum = {
1286
+ NotStarted: 'NOT_STARTED',
1287
+ } as const;
1288
+
1289
+ export type BulkEditRecordErrorItemRecordWriteOutcomeEnum = typeof BulkEditRecordErrorItemRecordWriteOutcomeEnum[keyof typeof BulkEditRecordErrorItemRecordWriteOutcomeEnum];
1290
+
1196
1291
  /**
1197
1292
  * A single record to create or update in a bulk edit request.
1198
1293
  */
@@ -1269,6 +1364,7 @@ export interface BulkEditRecordsResponse {
1269
1364
  export interface CRUD {
1270
1365
  'httpSessionId'?: string;
1271
1366
  'turnOffMetaRelationships'?: boolean;
1367
+ 'httpAccessContext'?: CrudAccessContext;
1272
1368
  }
1273
1369
  export interface CalendarBootstrapDTO {
1274
1370
  'defaultCalendar'?: CalendarRecordDTO;
@@ -1806,6 +1902,14 @@ export interface CreateOrUpdateEnvironmentRequest {
1806
1902
  * Private app creator manifest; label is required and internal name is optional
1807
1903
  */
1808
1904
  export interface CreatePrivateAppRequest {
1905
+ /**
1906
+ * Stable creator input for brandmark; display uses brandmark URL
1907
+ */
1908
+ 'brandmarkReference'?: string;
1909
+ /**
1910
+ * Stable creator input for details.image; display uses image URL
1911
+ */
1912
+ 'imageReference'?: string;
1809
1913
  /**
1810
1914
  * Unique identifier for the entity
1811
1915
  */
@@ -2187,6 +2291,10 @@ export interface CrossObjectRecordSearchRequest {
2187
2291
  */
2188
2292
  'excludeRecordUuid'?: string;
2189
2293
  }
2294
+ export interface CrudAccessContext {
2295
+ 'audience'?: Audience;
2296
+ 'permissions'?: Permissions;
2297
+ }
2190
2298
  export interface Currency extends PropertyFormat {
2191
2299
  }
2192
2300
  export interface CurrencyRange extends PropertyFormat {
@@ -2755,6 +2863,23 @@ export interface EngagementBatchRequest {
2755
2863
  'sessionId'?: string;
2756
2864
  'events'?: Array<TrackingEventRequest>;
2757
2865
  }
2866
+ /**
2867
+ * Atomic ensure-link receipt. UNCHANGED leaves every existing edge property untouched.
2868
+ */
2869
+ export interface EnsureRelationDTO {
2870
+ 'fromUuid'?: string;
2871
+ 'toUuid'?: string;
2872
+ 'relationName'?: string;
2873
+ 'outcome'?: EnsureRelationDTOOutcomeEnum;
2874
+ }
2875
+
2876
+ export const EnsureRelationDTOOutcomeEnum = {
2877
+ Created: 'CREATED',
2878
+ Unchanged: 'UNCHANGED',
2879
+ } as const;
2880
+
2881
+ export type EnsureRelationDTOOutcomeEnum = typeof EnsureRelationDTOOutcomeEnum[keyof typeof EnsureRelationDTOOutcomeEnum];
2882
+
2758
2883
  /**
2759
2884
  * Defines the structure of error responses returned by the API.
2760
2885
  */
@@ -2771,6 +2896,10 @@ export interface ErrorResponse {
2771
2896
  * The HTTP status code associated with the error.
2772
2897
  */
2773
2898
  'status'?: number;
2899
+ /**
2900
+ * 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.
2901
+ */
2902
+ 'recordWriteOutcome'?: ErrorResponseRecordWriteOutcomeEnum;
2774
2903
  'stackTrace'?: string;
2775
2904
  /**
2776
2905
  * Roles the caller is missing when the failure is an authorization error.
@@ -2786,6 +2915,11 @@ export interface ErrorResponse {
2786
2915
  'requestId'?: string;
2787
2916
  }
2788
2917
 
2918
+ export const ErrorResponseRecordWriteOutcomeEnum = {
2919
+ NotStarted: 'NOT_STARTED',
2920
+ } as const;
2921
+
2922
+ export type ErrorResponseRecordWriteOutcomeEnum = typeof ErrorResponseRecordWriteOutcomeEnum[keyof typeof ErrorResponseRecordWriteOutcomeEnum];
2789
2923
  export const ErrorResponseRolesEnum = {
2790
2924
  User: 'USER',
2791
2925
  Admin: 'ADMIN',
@@ -2824,9 +2958,9 @@ export const EventRsvpRequestScopeEnum = {
2824
2958
  export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
2825
2959
 
2826
2960
  export interface ExistingWidgetSummary {
2827
- 'xproperty'?: string;
2828
2961
  'ymetric'?: string;
2829
2962
  'yproperty'?: string;
2963
+ 'xproperty'?: string;
2830
2964
  'title'?: string;
2831
2965
  'chartType'?: string;
2832
2966
  'xProperty'?: string;
@@ -2842,6 +2976,10 @@ export interface ExtendRecordRequest {
2842
2976
  */
2843
2977
  'objects'?: Set<CaraerObjectDTO>;
2844
2978
  }
2979
+ export interface FavoriteViewDTO {
2980
+ 'object'?: ObjectReferenceDTO;
2981
+ 'view'?: NavigationViewDTO;
2982
+ }
2845
2983
  export interface FeedDTO {
2846
2984
  /**
2847
2985
  * Unique identifier for the entity
@@ -3756,6 +3894,42 @@ export interface MultiValueMapStringString {
3756
3894
  'all'?: { [key: string]: string; };
3757
3895
  'empty'?: boolean;
3758
3896
  }
3897
+ /**
3898
+ * Authorized application navigation for the currently selected company. Contains no record schema or user configuration.
3899
+ */
3900
+ export interface NavigationDTO {
3901
+ 'objects'?: Array<NavigationObjectDTO>;
3902
+ 'suites'?: Array<string>;
3903
+ 'tools'?: WebMenuDTO;
3904
+ 'settings'?: WebMenuDTO;
3905
+ }
3906
+ export interface NavigationObjectDTO {
3907
+ 'uuid'?: string;
3908
+ 'name'?: string;
3909
+ 'label'?: string;
3910
+ 'plural'?: string;
3911
+ 'icon'?: string;
3912
+ 'defaultTrait'?: string;
3913
+ 'index'?: number;
3914
+ 'suites'?: Array<string>;
3915
+ 'views'?: Array<NavigationViewDTO>;
3916
+ 'traits'?: Array<string>;
3917
+ }
3918
+ export interface NavigationViewDTO {
3919
+ 'uuid'?: string;
3920
+ 'name'?: string;
3921
+ 'label'?: string;
3922
+ 'icon'?: string;
3923
+ 'trait'?: string;
3924
+ 'defaultView'?: boolean;
3925
+ 'index'?: number;
3926
+ 'favorite'?: boolean;
3927
+ 'personal'?: boolean;
3928
+ 'shared'?: boolean;
3929
+ 'team'?: boolean;
3930
+ 'isInternallyPublic'?: boolean;
3931
+ 'deletedAt'?: number;
3932
+ }
3759
3933
  export interface NotFoundError {
3760
3934
  'cause'?: NotFoundErrorCause;
3761
3935
  'stackTrace'?: Array<NotFoundErrorCauseStackTraceInner>;
@@ -3797,6 +3971,19 @@ export interface NotFoundErrorCauseStackTraceInner {
3797
3971
  'className'?: string;
3798
3972
  'nativeMethod'?: boolean;
3799
3973
  }
3974
+ export interface NotificationDeviceReceipt {
3975
+ 'installationId'?: string;
3976
+ 'platform'?: string;
3977
+ 'applicationId'?: string;
3978
+ 'permission'?: string;
3979
+ }
3980
+ export interface NotificationDeviceRegistration {
3981
+ 'platform'?: string;
3982
+ 'applicationId'?: string;
3983
+ 'registrationKind'?: string;
3984
+ 'registration'?: string;
3985
+ 'permission'?: string;
3986
+ }
3800
3987
  export interface NotificationInboxDTO {
3801
3988
  'notifications'?: Array<Item>;
3802
3989
  'unreadCount'?: number;
@@ -3862,6 +4049,15 @@ export interface ObjectAccessGrantSectionDTO {
3862
4049
  */
3863
4050
  'overrides'?: { [key: string]: Array<string>; };
3864
4051
  }
4052
+ export interface ObjectReferenceDTO {
4053
+ 'uuid'?: string;
4054
+ 'name'?: string;
4055
+ 'label'?: string;
4056
+ 'plural'?: string;
4057
+ 'icon'?: string;
4058
+ 'defaultTrait'?: string;
4059
+ 'traits'?: Array<string>;
4060
+ }
3865
4061
  /**
3866
4062
  * Data transfer object representing a webpage content
3867
4063
  */
@@ -4637,6 +4833,14 @@ export interface PaginationResponseWebpageAccessGrantDTO {
4637
4833
  */
4638
4834
  'lastPage'?: number;
4639
4835
  }
4836
+ export interface Palette {
4837
+ 'light'?: { [key: string]: string; };
4838
+ 'dark'?: { [key: string]: string; };
4839
+ }
4840
+ export interface Permissions {
4841
+ 'scopes'?: Array<string>;
4842
+ 'filters'?: any;
4843
+ }
4640
4844
  export interface Phone extends PropertyFormat {
4641
4845
  }
4642
4846
  /**
@@ -5471,209 +5675,282 @@ export interface RegisterRequest {
5471
5675
  'firstname': string;
5472
5676
  'lastname': string;
5473
5677
  }
5474
- /**
5475
- * Data transfer object representing a relation between Caraer objects
5476
- */
5477
- export interface RelationDTO {
5478
- /**
5479
- * Unique identifier for the entity
5480
- */
5481
- 'uuid': string;
5482
- /**
5483
- * Unique identifier name for the relation
5484
- */
5485
- 'name'?: string;
5486
- /**
5487
- * Display label for the relation
5488
- */
5489
- 'label'?: string;
5490
- /**
5491
- * Unix timestamp when the entity was created
5492
- */
5493
- 'createdAt'?: number;
5494
- /**
5495
- * Identifier of the user who created the entity
5496
- */
5497
- 'createdBy'?: ModelRecord;
5498
- /**
5499
- * Unix timestamp when the entity was last updated
5500
- */
5501
- 'updatedAt'?: number;
5502
- /**
5503
- * Identifier of the user who last updated the entity
5504
- */
5505
- 'updatedBy'?: ModelRecord;
5506
- /**
5507
- * Unix timestamp when the entity was deleted (null if not deleted)
5508
- */
5509
- 'deletedAt'?: number;
5510
- /**
5511
- * Identifier of the user who deleted the entity
5512
- */
5513
- 'deletedBy'?: ModelRecord;
5514
- /**
5515
- * Index number for ordering entities
5516
- */
5517
- 'index'?: number;
5518
- /**
5519
- * Detailed description of the relation\'s purpose and usage
5520
- */
5521
- 'description'?: string;
5522
- /**
5523
- * Set of Caraer objects that are part of this relation
5524
- */
5525
- 'objects'?: Set<CaraerObjectDTO>;
5526
- /**
5527
- * Whether the relation is immutable
5528
- */
5529
- 'immutable'?: boolean;
5530
- /**
5531
- * Whether the relation is editable
5532
- */
5533
- 'editable'?: boolean;
5678
+ export interface RelationCapabilities {
5679
+ 'unlinkMatch'?: string;
5680
+ 'primaryReset'?: string;
5681
+ 'pairs'?: Array<RelationCapabilityPairCapability>;
5682
+ 'ensureLink'?: boolean;
5534
5683
  }
5535
- /**
5536
- * Optional relation edge payload
5537
- */
5538
- export interface RelationEdgeRequestDTO {
5539
- /**
5540
- * Values for properties declared on the relation schema, stored on the edge itself. A null value clears that key.
5541
- */
5542
- 'edgeProperties'?: { [key: string]: any | null; };
5543
- /**
5544
- * When true, marks this relation edge as primary. Overrides the primary query parameter.
5545
- */
5546
- 'primary'?: boolean;
5547
- }
5548
- export interface RelationPillSort {
5549
- /**
5550
- * Property of the related object used to order its pills.
5551
- */
5552
- 'property'?: string;
5553
- 'direction'?: RelationPillSortDirectionEnum;
5684
+ export interface RelationCapabilityEdge {
5685
+ 'exists'?: boolean;
5686
+ 'primary'?: RelationCapabilityEdgePrimaryEnum;
5554
5687
  }
5555
5688
 
5556
- export const RelationPillSortDirectionEnum = {
5557
- Asc: 'ASC',
5558
- Desc: 'DESC',
5689
+ export const RelationCapabilityEdgePrimaryEnum = {
5690
+ Absent: 'ABSENT',
5691
+ False: 'FALSE',
5692
+ True: 'TRUE',
5693
+ Mixed: 'MIXED',
5559
5694
  } as const;
5560
5695
 
5561
- export type RelationPillSortDirectionEnum = typeof RelationPillSortDirectionEnum[keyof typeof RelationPillSortDirectionEnum];
5696
+ export type RelationCapabilityEdgePrimaryEnum = typeof RelationCapabilityEdgePrimaryEnum[keyof typeof RelationCapabilityEdgePrimaryEnum];
5562
5697
 
5563
- export interface ResetPasswordRequest {
5564
- 'email'?: string;
5565
- 'token'?: string;
5566
- 'password'?: string;
5698
+ export interface RelationCapabilityEdges {
5699
+ 'sourceToTarget'?: RelationCapabilityEdge;
5700
+ 'targetToSource'?: RelationCapabilityEdge;
5567
5701
  }
5568
- /**
5569
- * Represents the response returned when a restore operation is performed successfully.
5570
- */
5571
- export interface RestoreResponse {
5572
- /**
5573
- * A message detailing the result of the operation.
5574
- */
5575
- 'message'?: string;
5576
- /**
5577
- * The data payload of the response, if any.
5578
- */
5579
- 'data'?: any;
5702
+ export interface RelationCapabilityOperation {
5703
+ 'allowed'?: boolean;
5704
+ 'from'?: RelationCapabilityOperationFromEnum;
5580
5705
  }
5581
- /**
5582
- * Represents the response returned when a restore operation is performed successfully.
5583
- */
5584
- export interface RestoreResponseCaraerObjectDTO {
5585
- /**
5586
- * A message detailing the result of the operation.
5587
- */
5588
- 'message'?: string;
5589
- /**
5590
- * The data payload of the response, if any.
5591
- */
5592
- 'data'?: CaraerObjectDTO;
5593
- }
5594
- /**
5595
- * Represents the response returned when a restore operation is performed successfully.
5596
- */
5597
- export interface RestoreResponseSavedFilterDTO {
5598
- /**
5599
- * A message detailing the result of the operation.
5600
- */
5601
- 'message'?: string;
5602
- /**
5603
- * The data payload of the response, if any.
5604
- */
5605
- 'data'?: SavedFilterDTO;
5606
- }
5607
- /**
5608
- * Represents the response returned when a restore operation is performed successfully.
5609
- */
5610
- export interface RestoreResponseTeamDTO {
5611
- /**
5612
- * A message detailing the result of the operation.
5613
- */
5614
- 'message'?: string;
5615
- /**
5616
- * The data payload of the response, if any.
5617
- */
5618
- 'data'?: TeamDTO;
5619
- }
5620
- /**
5621
- * Represents the response returned when a restore operation is performed successfully.
5622
- */
5623
- export interface RestoreResponseViewDTO {
5624
- /**
5625
- * A message detailing the result of the operation.
5626
- */
5627
- 'message'?: string;
5628
- /**
5629
- * The data payload of the response, if any.
5630
- */
5631
- 'data'?: ViewDTO;
5706
+
5707
+ export const RelationCapabilityOperationFromEnum = {
5708
+ Source: 'SOURCE',
5709
+ Target: 'TARGET',
5710
+ } as const;
5711
+
5712
+ export type RelationCapabilityOperationFromEnum = typeof RelationCapabilityOperationFromEnum[keyof typeof RelationCapabilityOperationFromEnum];
5713
+
5714
+ export interface RelationCapabilityPair {
5715
+ 'targetUuid'?: string;
5716
+ 'relationName'?: string;
5632
5717
  }
5633
- /**
5634
- * Review request with feedback, reviewer notes, and publish state
5635
- */
5636
- export interface ReviewRequest {
5637
- /**
5638
- * Feedback shown to the developer.
5639
- */
5640
- 'feedback'?: string;
5641
- /**
5642
- * Internal notes for reviewers (not shown to the developer).
5643
- */
5644
- 'reviewerNotes'?: string;
5645
- /**
5646
- * Publish state after review: APPROVED, REJECTED, CHANGES_REQUESTED.
5647
- */
5648
- 'publishState'?: string;
5718
+ export interface RelationCapabilityPairCapability {
5719
+ 'index'?: number;
5720
+ 'status'?: RelationCapabilityPairCapabilityStatusEnum;
5721
+ 'link'?: RelationCapabilityOperation;
5722
+ 'unlink'?: RelationCapabilityOperation;
5723
+ 'primary'?: RelationCapabilityPrimary;
5724
+ 'edges'?: RelationCapabilityEdges;
5725
+ 'reason'?: RelationCapabilityPairCapabilityReasonEnum;
5726
+ 'linkAttemptPermitted'?: boolean;
5727
+ }
5728
+
5729
+ export const RelationCapabilityPairCapabilityStatusEnum = {
5730
+ Available: 'AVAILABLE',
5731
+ Unavailable: 'UNAVAILABLE',
5732
+ Unresolved: 'UNRESOLVED',
5733
+ } as const;
5734
+
5735
+ export type RelationCapabilityPairCapabilityStatusEnum = typeof RelationCapabilityPairCapabilityStatusEnum[keyof typeof RelationCapabilityPairCapabilityStatusEnum];
5736
+ export const RelationCapabilityPairCapabilityReasonEnum = {
5737
+ OrientationAmbiguous: 'ORIENTATION_AMBIGUOUS',
5738
+ UnsupportedRelationName: 'UNSUPPORTED_RELATION_NAME',
5739
+ } as const;
5740
+
5741
+ export type RelationCapabilityPairCapabilityReasonEnum = typeof RelationCapabilityPairCapabilityReasonEnum[keyof typeof RelationCapabilityPairCapabilityReasonEnum];
5742
+
5743
+ export interface RelationCapabilityPrimary {
5744
+ 'canSet'?: boolean;
5745
+ 'canClear'?: boolean;
5649
5746
  }
5650
- /**
5651
- * Request body for generating a sample webhook payload from a record and event type.
5652
- */
5653
- export interface SamplePayloadRequest {
5654
- /**
5655
- * UUID of the record to base the sample payload on.
5656
- */
5657
- 'recordUuid'?: string;
5658
- /**
5659
- * Event type to simulate (created, updated, deleted, etc.).
5660
- */
5661
- 'eventType'?: string;
5747
+ export interface RelationCapabilityRequest {
5748
+ 'sourceUuid'?: string;
5749
+ 'pairs'?: Array<RelationCapabilityPair>;
5662
5750
  }
5663
5751
  /**
5664
- * DTO representing a property to be saved
5752
+ * Data transfer object representing a relation between Caraer objects
5665
5753
  */
5666
- export interface SavePropertyDTO {
5754
+ export interface RelationDTO {
5667
5755
  /**
5668
5756
  * Unique identifier for the entity
5669
5757
  */
5670
5758
  'uuid': string;
5671
5759
  /**
5672
- * The internal name of the property
5760
+ * Unique identifier name for the relation
5673
5761
  */
5674
5762
  'name'?: string;
5675
5763
  /**
5676
- * The display label of the property
5764
+ * Display label for the relation
5765
+ */
5766
+ 'label'?: string;
5767
+ /**
5768
+ * Unix timestamp when the entity was created
5769
+ */
5770
+ 'createdAt'?: number;
5771
+ /**
5772
+ * Identifier of the user who created the entity
5773
+ */
5774
+ 'createdBy'?: ModelRecord;
5775
+ /**
5776
+ * Unix timestamp when the entity was last updated
5777
+ */
5778
+ 'updatedAt'?: number;
5779
+ /**
5780
+ * Identifier of the user who last updated the entity
5781
+ */
5782
+ 'updatedBy'?: ModelRecord;
5783
+ /**
5784
+ * Unix timestamp when the entity was deleted (null if not deleted)
5785
+ */
5786
+ 'deletedAt'?: number;
5787
+ /**
5788
+ * Identifier of the user who deleted the entity
5789
+ */
5790
+ 'deletedBy'?: ModelRecord;
5791
+ /**
5792
+ * Index number for ordering entities
5793
+ */
5794
+ 'index'?: number;
5795
+ /**
5796
+ * Detailed description of the relation\'s purpose and usage
5797
+ */
5798
+ 'description'?: string;
5799
+ /**
5800
+ * Set of Caraer objects that are part of this relation
5801
+ */
5802
+ 'objects'?: Set<CaraerObjectDTO>;
5803
+ /**
5804
+ * Whether the relation is immutable
5805
+ */
5806
+ 'immutable'?: boolean;
5807
+ /**
5808
+ * Whether the relation is editable
5809
+ */
5810
+ 'editable'?: boolean;
5811
+ }
5812
+ /**
5813
+ * Optional relation edge payload
5814
+ */
5815
+ export interface RelationEdgeRequestDTO {
5816
+ /**
5817
+ * Values for properties declared on the relation schema, stored on the edge itself. A null value clears that key.
5818
+ */
5819
+ 'edgeProperties'?: { [key: string]: any | null; };
5820
+ /**
5821
+ * When true, marks this relation edge as primary. Overrides the primary query parameter.
5822
+ */
5823
+ 'primary'?: boolean;
5824
+ }
5825
+ export interface RelationPillSort {
5826
+ /**
5827
+ * Property of the related object used to order its pills.
5828
+ */
5829
+ 'property'?: string;
5830
+ 'direction'?: RelationPillSortDirectionEnum;
5831
+ }
5832
+
5833
+ export const RelationPillSortDirectionEnum = {
5834
+ Asc: 'ASC',
5835
+ Desc: 'DESC',
5836
+ } as const;
5837
+
5838
+ export type RelationPillSortDirectionEnum = typeof RelationPillSortDirectionEnum[keyof typeof RelationPillSortDirectionEnum];
5839
+
5840
+ export interface ResetPasswordRequest {
5841
+ 'email'?: string;
5842
+ 'token'?: string;
5843
+ 'password'?: string;
5844
+ }
5845
+ /**
5846
+ * Represents the response returned when a restore operation is performed successfully.
5847
+ */
5848
+ export interface RestoreResponse {
5849
+ /**
5850
+ * A message detailing the result of the operation.
5851
+ */
5852
+ 'message'?: string;
5853
+ /**
5854
+ * The data payload of the response, if any.
5855
+ */
5856
+ 'data'?: any;
5857
+ }
5858
+ /**
5859
+ * Represents the response returned when a restore operation is performed successfully.
5860
+ */
5861
+ export interface RestoreResponseCaraerObjectDTO {
5862
+ /**
5863
+ * A message detailing the result of the operation.
5864
+ */
5865
+ 'message'?: string;
5866
+ /**
5867
+ * The data payload of the response, if any.
5868
+ */
5869
+ 'data'?: CaraerObjectDTO;
5870
+ }
5871
+ /**
5872
+ * Represents the response returned when a restore operation is performed successfully.
5873
+ */
5874
+ export interface RestoreResponseSavedFilterDTO {
5875
+ /**
5876
+ * A message detailing the result of the operation.
5877
+ */
5878
+ 'message'?: string;
5879
+ /**
5880
+ * The data payload of the response, if any.
5881
+ */
5882
+ 'data'?: SavedFilterDTO;
5883
+ }
5884
+ /**
5885
+ * Represents the response returned when a restore operation is performed successfully.
5886
+ */
5887
+ export interface RestoreResponseTeamDTO {
5888
+ /**
5889
+ * A message detailing the result of the operation.
5890
+ */
5891
+ 'message'?: string;
5892
+ /**
5893
+ * The data payload of the response, if any.
5894
+ */
5895
+ 'data'?: TeamDTO;
5896
+ }
5897
+ /**
5898
+ * Represents the response returned when a restore operation is performed successfully.
5899
+ */
5900
+ export interface RestoreResponseViewDTO {
5901
+ /**
5902
+ * A message detailing the result of the operation.
5903
+ */
5904
+ 'message'?: string;
5905
+ /**
5906
+ * The data payload of the response, if any.
5907
+ */
5908
+ 'data'?: ViewDTO;
5909
+ }
5910
+ /**
5911
+ * Review request with feedback, reviewer notes, and publish state
5912
+ */
5913
+ export interface ReviewRequest {
5914
+ /**
5915
+ * Feedback shown to the developer.
5916
+ */
5917
+ 'feedback'?: string;
5918
+ /**
5919
+ * Internal notes for reviewers (not shown to the developer).
5920
+ */
5921
+ 'reviewerNotes'?: string;
5922
+ /**
5923
+ * Publish state after review: APPROVED, REJECTED, CHANGES_REQUESTED.
5924
+ */
5925
+ 'publishState'?: string;
5926
+ }
5927
+ /**
5928
+ * Request body for generating a sample webhook payload from a record and event type.
5929
+ */
5930
+ export interface SamplePayloadRequest {
5931
+ /**
5932
+ * UUID of the record to base the sample payload on.
5933
+ */
5934
+ 'recordUuid'?: string;
5935
+ /**
5936
+ * Event type to simulate (created, updated, deleted, etc.).
5937
+ */
5938
+ 'eventType'?: string;
5939
+ }
5940
+ /**
5941
+ * DTO representing a property to be saved
5942
+ */
5943
+ export interface SavePropertyDTO {
5944
+ /**
5945
+ * Unique identifier for the entity
5946
+ */
5947
+ 'uuid': string;
5948
+ /**
5949
+ * The internal name of the property
5950
+ */
5951
+ 'name'?: string;
5952
+ /**
5953
+ * The display label of the property
5677
5954
  */
5678
5955
  'label'?: string;
5679
5956
  /**
@@ -6152,6 +6429,32 @@ export interface ShowResponseBillingStatusDTO {
6152
6429
  'message'?: string;
6153
6430
  'data'?: { [key: string]: any; };
6154
6431
  }
6432
+ /**
6433
+ * Represents the response for viewing or showing a specific resource.
6434
+ */
6435
+ export interface ShowResponseBrowserAuthSessionResponse {
6436
+ /**
6437
+ * A message detailing the result of the operation.
6438
+ */
6439
+ 'message'?: string;
6440
+ /**
6441
+ * The data payload of the response, if any.
6442
+ */
6443
+ 'data'?: BrowserAuthSessionResponse;
6444
+ }
6445
+ /**
6446
+ * Represents the response for viewing or showing a specific resource.
6447
+ */
6448
+ export interface ShowResponseBrowserAuthStartResponse {
6449
+ /**
6450
+ * A message detailing the result of the operation.
6451
+ */
6452
+ 'message'?: string;
6453
+ /**
6454
+ * The data payload of the response, if any.
6455
+ */
6456
+ 'data'?: BrowserAuthStartResponse;
6457
+ }
6155
6458
  /**
6156
6459
  * Success response (ShowResponseCaraerObjectDTO).
6157
6460
  */
@@ -6245,6 +6548,19 @@ export interface ShowResponseFormDTO {
6245
6548
  'message'?: string;
6246
6549
  'data'?: { [key: string]: any; };
6247
6550
  }
6551
+ /**
6552
+ * Represents the response for viewing or showing a specific resource.
6553
+ */
6554
+ export interface ShowResponseItem {
6555
+ /**
6556
+ * A message detailing the result of the operation.
6557
+ */
6558
+ 'message'?: string;
6559
+ /**
6560
+ * The data payload of the response, if any.
6561
+ */
6562
+ 'data'?: Item;
6563
+ }
6248
6564
  /**
6249
6565
  * Represents the response for viewing or showing a specific resource.
6250
6566
  */
@@ -6438,6 +6754,19 @@ export interface ShowResponseMapStringString {
6438
6754
  */
6439
6755
  'data'?: { [key: string]: string; };
6440
6756
  }
6757
+ /**
6758
+ * Represents the response for viewing or showing a specific resource.
6759
+ */
6760
+ export interface ShowResponseNotificationDeviceReceipt {
6761
+ /**
6762
+ * A message detailing the result of the operation.
6763
+ */
6764
+ 'message'?: string;
6765
+ /**
6766
+ * The data payload of the response, if any.
6767
+ */
6768
+ 'data'?: NotificationDeviceReceipt;
6769
+ }
6441
6770
  /**
6442
6771
  * Represents the response for viewing or showing a specific resource.
6443
6772
  */
@@ -6511,6 +6840,19 @@ export interface ShowResponsePublicFormDTO {
6511
6840
  'message'?: string;
6512
6841
  'data'?: { [key: string]: any; };
6513
6842
  }
6843
+ /**
6844
+ * Represents the response for viewing or showing a specific resource.
6845
+ */
6846
+ export interface ShowResponseRelationCapabilities {
6847
+ /**
6848
+ * A message detailing the result of the operation.
6849
+ */
6850
+ 'message'?: string;
6851
+ /**
6852
+ * The data payload of the response, if any.
6853
+ */
6854
+ 'data'?: RelationCapabilities;
6855
+ }
6514
6856
  /**
6515
6857
  * Success response (ShowResponseRelationDTO).
6516
6858
  */
@@ -6599,6 +6941,19 @@ export interface ShowResponseWebMenuDTO {
6599
6941
  'message'?: string;
6600
6942
  'data'?: { [key: string]: any; };
6601
6943
  }
6944
+ /**
6945
+ * Represents the response for viewing or showing a specific resource.
6946
+ */
6947
+ export interface ShowResponseWebpageEditorDefaultsDTO {
6948
+ /**
6949
+ * A message detailing the result of the operation.
6950
+ */
6951
+ 'message'?: string;
6952
+ /**
6953
+ * The data payload of the response, if any.
6954
+ */
6955
+ 'data'?: WebpageEditorDefaultsDTO;
6956
+ }
6602
6957
  /**
6603
6958
  * Represents the response for viewing or showing a specific resource.
6604
6959
  */
@@ -6641,6 +6996,10 @@ export interface SignedUrlResultDTO {
6641
6996
  'expiresAt'?: number;
6642
6997
  'queryParams'?: string;
6643
6998
  }
6999
+ export interface SimpleCompanyDTO {
7000
+ 'uuid'?: string;
7001
+ 'name'?: string;
7002
+ }
6644
7003
  /**
6645
7004
  * Data Transfer Object representing a public-facing view of a company
6646
7005
  */
@@ -7231,6 +7590,19 @@ export interface SuccessResponseCompanyDTO {
7231
7590
  */
7232
7591
  'data'?: CompanyDTO;
7233
7592
  }
7593
+ /**
7594
+ * Represents a standard successful response with a message and optional data.
7595
+ */
7596
+ export interface SuccessResponseEnsureRelationDTO {
7597
+ /**
7598
+ * A message detailing the result of the operation.
7599
+ */
7600
+ 'message'?: string;
7601
+ /**
7602
+ * The data payload of the response, if any.
7603
+ */
7604
+ 'data'?: EnsureRelationDTO;
7605
+ }
7234
7606
  /**
7235
7607
  * Represents a standard successful response with a message and optional data.
7236
7608
  */
@@ -7356,6 +7728,19 @@ export interface SuccessResponseListDeveloperSandboxDTO {
7356
7728
  */
7357
7729
  'data'?: Array<DeveloperSandboxDTO>;
7358
7730
  }
7731
+ /**
7732
+ * Represents a standard successful response with a message and optional data.
7733
+ */
7734
+ export interface SuccessResponseListFavoriteViewDTO {
7735
+ /**
7736
+ * A message detailing the result of the operation.
7737
+ */
7738
+ 'message'?: string;
7739
+ /**
7740
+ * The data payload of the response, if any.
7741
+ */
7742
+ 'data'?: Array<FavoriteViewDTO>;
7743
+ }
7359
7744
  /**
7360
7745
  * Represents a standard successful response with a message and optional data.
7361
7746
  */
@@ -7382,6 +7767,19 @@ export interface SuccessResponseListMapStringObject {
7382
7767
  */
7383
7768
  'data'?: Array<{ [key: string]: any | null; }>;
7384
7769
  }
7770
+ /**
7771
+ * Represents a standard successful response with a message and optional data.
7772
+ */
7773
+ export interface SuccessResponseListNavigationViewDTO {
7774
+ /**
7775
+ * A message detailing the result of the operation.
7776
+ */
7777
+ 'message'?: string;
7778
+ /**
7779
+ * The data payload of the response, if any.
7780
+ */
7781
+ 'data'?: Array<NavigationViewDTO>;
7782
+ }
7385
7783
  /**
7386
7784
  * Represents a standard successful response with a message and optional data.
7387
7785
  */
@@ -7442,6 +7840,19 @@ export interface SuccessResponseMapStringObject {
7442
7840
  'message'?: string;
7443
7841
  'data'?: { [key: string]: any; };
7444
7842
  }
7843
+ /**
7844
+ * Represents a standard successful response with a message and optional data.
7845
+ */
7846
+ export interface SuccessResponseNavigationDTO {
7847
+ /**
7848
+ * A message detailing the result of the operation.
7849
+ */
7850
+ 'message'?: string;
7851
+ /**
7852
+ * The data payload of the response, if any.
7853
+ */
7854
+ 'data'?: NavigationDTO;
7855
+ }
7445
7856
  /**
7446
7857
  * Success response (SuccessResponseObject).
7447
7858
  */
@@ -7827,6 +8238,22 @@ export interface UsedInResult {
7827
8238
  'recordUuids'?: Array<string>;
7828
8239
  'count'?: number;
7829
8240
  }
8241
+ export interface UserDTO {
8242
+ 'uuid'?: string;
8243
+ 'email'?: string;
8244
+ 'firstname'?: string;
8245
+ 'lastname'?: string;
8246
+ 'initials'?: string;
8247
+ 'selectedCompany'?: CompanyDTO;
8248
+ 'companies'?: Array<SimpleCompanyDTO>;
8249
+ 'scopes'?: Array<string>;
8250
+ 'filters'?: { [key: string]: Filter; };
8251
+ 'role'?: string;
8252
+ 'roles'?: Array<string>;
8253
+ 'token'?: ApiTokenDTO;
8254
+ 'record'?: ModelRecord;
8255
+ 'easterEggs'?: Array<string>;
8256
+ }
7830
8257
  /**
7831
8258
  * Record response for user API endpoints, including linked user data.
7832
8259
  */
@@ -8003,6 +8430,13 @@ export interface ViewDTO {
8003
8430
  'isInternallyPublic'?: boolean;
8004
8431
  'analytics'?: AnalyticsDashboardConfig;
8005
8432
  }
8433
+ /**
8434
+ * 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.
8435
+ */
8436
+ export interface ViewNavigationPreferencesRequest {
8437
+ 'indices'?: { [key: string]: number; };
8438
+ 'favorites'?: { [key: string]: boolean; };
8439
+ }
8006
8440
  export interface ViewShareRequest {
8007
8441
  'users'?: Array<ModelRecord>;
8008
8442
  'teams'?: Array<ModelRecord>;
@@ -8264,6 +8698,14 @@ export interface WebpageEditingStatusDTO {
8264
8698
  */
8265
8699
  'message'?: string;
8266
8700
  }
8701
+ /**
8702
+ * Read-only style, color and font defaults for an authorized webpage editor. Contains no company administration or executable script configuration.
8703
+ */
8704
+ export interface WebpageEditorDefaultsDTO {
8705
+ 'componentStyles'?: { [key: string]: PageContentStylingDTO; };
8706
+ 'palette'?: Palette;
8707
+ 'fonts'?: Array<CustomFontDTO>;
8708
+ }
8267
8709
  /**
8268
8710
  * Resolved public map markers for a webpage map block
8269
8711
  */
@@ -8744,10 +9186,11 @@ export const AppBarsApiAxiosParamCreator = function (configuration?: Configurati
8744
9186
  * @param {string} [viewId] View ID in context
8745
9187
  * @param {string} [trait] Trait name in context
8746
9188
  * @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
9189
+ * @param {ListAppBarsNavigationPlacementEnum} [navigationPlacement] TOOL_BAR placement. Omitted means legacy SUITE; SETTINGS is suite-independent.
8747
9190
  * @param {*} [options] Override http request option.
8748
9191
  * @throws {RequiredError}
8749
9192
  */
8750
- listAppBars: async (location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, suite?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
9193
+ listAppBars: async (location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, suite?: string, navigationPlacement?: ListAppBarsNavigationPlacementEnum, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
8751
9194
  // verify required parameter 'location' is not null or undefined
8752
9195
  assertParamExists('listAppBars', 'location', location)
8753
9196
  const localVarPath = `/api/v2/app-bars`;
@@ -8790,6 +9233,10 @@ export const AppBarsApiAxiosParamCreator = function (configuration?: Configurati
8790
9233
  localVarQueryParameter['suite'] = suite;
8791
9234
  }
8792
9235
 
9236
+ if (navigationPlacement !== undefined) {
9237
+ localVarQueryParameter['navigationPlacement'] = navigationPlacement;
9238
+ }
9239
+
8793
9240
  localVarHeaderParameter['Accept'] = 'application/json';
8794
9241
 
8795
9242
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -8860,11 +9307,12 @@ export const AppBarsApiFp = function(configuration?: Configuration) {
8860
9307
  * @param {string} [viewId] View ID in context
8861
9308
  * @param {string} [trait] Trait name in context
8862
9309
  * @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
9310
+ * @param {ListAppBarsNavigationPlacementEnum} [navigationPlacement] TOOL_BAR placement. Omitted means legacy SUITE; SETTINGS is suite-independent.
8863
9311
  * @param {*} [options] Override http request option.
8864
9312
  * @throws {RequiredError}
8865
9313
  */
8866
- async listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, suite?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseListInstalledAppBarDTO>> {
8867
- const localVarAxiosArgs = await localVarAxiosParamCreator.listAppBars(location, object, recordUuid, viewId, trait, suite, options);
9314
+ async listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, suite?: string, navigationPlacement?: ListAppBarsNavigationPlacementEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseListInstalledAppBarDTO>> {
9315
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listAppBars(location, object, recordUuid, viewId, trait, suite, navigationPlacement, options);
8868
9316
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8869
9317
  const localVarOperationServerBasePath = operationServerMap['AppBarsApi.listAppBars']?.[localVarOperationServerIndex]?.url;
8870
9318
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -8901,11 +9349,12 @@ export const AppBarsApiFactory = function (configuration?: Configuration, basePa
8901
9349
  * @param {string} [viewId] View ID in context
8902
9350
  * @param {string} [trait] Trait name in context
8903
9351
  * @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
9352
+ * @param {ListAppBarsNavigationPlacementEnum} [navigationPlacement] TOOL_BAR placement. Omitted means legacy SUITE; SETTINGS is suite-independent.
8904
9353
  * @param {*} [options] Override http request option.
8905
9354
  * @throws {RequiredError}
8906
9355
  */
8907
- listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, suite?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseListInstalledAppBarDTO> {
8908
- return localVarFp.listAppBars(location, object, recordUuid, viewId, trait, suite, options).then((request) => request(axios, basePath));
9356
+ listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, suite?: string, navigationPlacement?: ListAppBarsNavigationPlacementEnum, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseListInstalledAppBarDTO> {
9357
+ return localVarFp.listAppBars(location, object, recordUuid, viewId, trait, suite, navigationPlacement, options).then((request) => request(axios, basePath));
8909
9358
  },
8910
9359
  /**
8911
9360
  * Fires the app bar webhook with optional settings values and record/view context.
@@ -8934,11 +9383,12 @@ export class AppBarsApi extends BaseAPI {
8934
9383
  * @param {string} [viewId] View ID in context
8935
9384
  * @param {string} [trait] Trait name in context
8936
9385
  * @param {string} [suite] Suite selected in the UI. A tool bar is included when this suite is saved on the bar.
9386
+ * @param {ListAppBarsNavigationPlacementEnum} [navigationPlacement] TOOL_BAR placement. Omitted means legacy SUITE; SETTINGS is suite-independent.
8937
9387
  * @param {*} [options] Override http request option.
8938
9388
  * @throws {RequiredError}
8939
9389
  */
8940
- public listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, suite?: string, options?: RawAxiosRequestConfig) {
8941
- return AppBarsApiFp(this.configuration).listAppBars(location, object, recordUuid, viewId, trait, suite, options).then((request) => request(this.axios, this.basePath));
9390
+ public listAppBars(location: ListAppBarsLocationEnum, object?: string, recordUuid?: string, viewId?: string, trait?: string, suite?: string, navigationPlacement?: ListAppBarsNavigationPlacementEnum, options?: RawAxiosRequestConfig) {
9391
+ return AppBarsApiFp(this.configuration).listAppBars(location, object, recordUuid, viewId, trait, suite, navigationPlacement, options).then((request) => request(this.axios, this.basePath));
8942
9392
  }
8943
9393
 
8944
9394
  /**
@@ -8963,6 +9413,11 @@ export const ListAppBarsLocationEnum = {
8963
9413
  RecordTrait: 'RECORD_TRAIT',
8964
9414
  } as const;
8965
9415
  export type ListAppBarsLocationEnum = typeof ListAppBarsLocationEnum[keyof typeof ListAppBarsLocationEnum];
9416
+ export const ListAppBarsNavigationPlacementEnum = {
9417
+ Suite: 'SUITE',
9418
+ Settings: 'SETTINGS',
9419
+ } as const;
9420
+ export type ListAppBarsNavigationPlacementEnum = typeof ListAppBarsNavigationPlacementEnum[keyof typeof ListAppBarsNavigationPlacementEnum];
8966
9421
 
8967
9422
 
8968
9423
  /**
@@ -13404,6 +13859,260 @@ export class BillingApi extends BaseAPI {
13404
13859
 
13405
13860
 
13406
13861
 
13862
+ /**
13863
+ * BrowserAuthenticationApi - axios parameter creator
13864
+ */
13865
+ export const BrowserAuthenticationApiAxiosParamCreator = function (configuration?: Configuration) {
13866
+ return {
13867
+ /**
13868
+ *
13869
+ * @summary Open the browser-owned provider session
13870
+ * @param {string} flow
13871
+ * @param {*} [options] Override http request option.
13872
+ * @throws {RequiredError}
13873
+ */
13874
+ authorize: async (flow: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13875
+ // verify required parameter 'flow' is not null or undefined
13876
+ assertParamExists('authorize', 'flow', flow)
13877
+ const localVarPath = `/api/v2/auth/browser/authorize`;
13878
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
13879
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
13880
+ let baseOptions;
13881
+ if (configuration) {
13882
+ baseOptions = configuration.baseOptions;
13883
+ }
13884
+
13885
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
13886
+ const localVarHeaderParameter = {} as any;
13887
+ const localVarQueryParameter = {} as any;
13888
+
13889
+ // authentication bearerAuth required
13890
+ // http bearer authentication required
13891
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
13892
+
13893
+ if (flow !== undefined) {
13894
+ localVarQueryParameter['flow'] = flow;
13895
+ }
13896
+
13897
+ localVarHeaderParameter['Accept'] = 'application/json';
13898
+
13899
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
13900
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
13901
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
13902
+
13903
+ return {
13904
+ url: toPathString(localVarUrlObj),
13905
+ options: localVarRequestOptions,
13906
+ };
13907
+ },
13908
+ /**
13909
+ * 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.
13910
+ * @summary Exchange a native callback code
13911
+ * @param {BrowserAuthExchangeRequest} browserAuthExchangeRequest
13912
+ * @param {*} [options] Override http request option.
13913
+ * @throws {RequiredError}
13914
+ */
13915
+ exchange: async (browserAuthExchangeRequest: BrowserAuthExchangeRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13916
+ // verify required parameter 'browserAuthExchangeRequest' is not null or undefined
13917
+ assertParamExists('exchange', 'browserAuthExchangeRequest', browserAuthExchangeRequest)
13918
+ const localVarPath = `/api/v2/auth/browser/exchange`;
13919
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
13920
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
13921
+ let baseOptions;
13922
+ if (configuration) {
13923
+ baseOptions = configuration.baseOptions;
13924
+ }
13925
+
13926
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
13927
+ const localVarHeaderParameter = {} as any;
13928
+ const localVarQueryParameter = {} as any;
13929
+
13930
+ // authentication bearerAuth required
13931
+ // http bearer authentication required
13932
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
13933
+
13934
+ localVarHeaderParameter['Content-Type'] = 'application/json';
13935
+ localVarHeaderParameter['Accept'] = '*/*,application/json';
13936
+
13937
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
13938
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
13939
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
13940
+ localVarRequestOptions.data = serializeDataIfNeeded(browserAuthExchangeRequest, localVarRequestOptions, configuration)
13941
+
13942
+ return {
13943
+ url: toPathString(localVarUrlObj),
13944
+ options: localVarRequestOptions,
13945
+ };
13946
+ },
13947
+ /**
13948
+ * Requires an exact configured redirect URI, random client state and S256 PKCE challenge. Open the returned URL in the system browser.
13949
+ * @summary Start browser sign-in
13950
+ * @param {BrowserAuthStartRequest} browserAuthStartRequest
13951
+ * @param {*} [options] Override http request option.
13952
+ * @throws {RequiredError}
13953
+ */
13954
+ start: async (browserAuthStartRequest: BrowserAuthStartRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13955
+ // verify required parameter 'browserAuthStartRequest' is not null or undefined
13956
+ assertParamExists('start', 'browserAuthStartRequest', browserAuthStartRequest)
13957
+ const localVarPath = `/api/v2/auth/browser/start`;
13958
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
13959
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
13960
+ let baseOptions;
13961
+ if (configuration) {
13962
+ baseOptions = configuration.baseOptions;
13963
+ }
13964
+
13965
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
13966
+ const localVarHeaderParameter = {} as any;
13967
+ const localVarQueryParameter = {} as any;
13968
+
13969
+ // authentication bearerAuth required
13970
+ // http bearer authentication required
13971
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
13972
+
13973
+ localVarHeaderParameter['Content-Type'] = 'application/json';
13974
+ localVarHeaderParameter['Accept'] = '*/*,application/json';
13975
+
13976
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
13977
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
13978
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
13979
+ localVarRequestOptions.data = serializeDataIfNeeded(browserAuthStartRequest, localVarRequestOptions, configuration)
13980
+
13981
+ return {
13982
+ url: toPathString(localVarUrlObj),
13983
+ options: localVarRequestOptions,
13984
+ };
13985
+ },
13986
+ }
13987
+ };
13988
+
13989
+ /**
13990
+ * BrowserAuthenticationApi - functional programming interface
13991
+ */
13992
+ export const BrowserAuthenticationApiFp = function(configuration?: Configuration) {
13993
+ const localVarAxiosParamCreator = BrowserAuthenticationApiAxiosParamCreator(configuration)
13994
+ return {
13995
+ /**
13996
+ *
13997
+ * @summary Open the browser-owned provider session
13998
+ * @param {string} flow
13999
+ * @param {*} [options] Override http request option.
14000
+ * @throws {RequiredError}
14001
+ */
14002
+ async authorize(flow: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
14003
+ const localVarAxiosArgs = await localVarAxiosParamCreator.authorize(flow, options);
14004
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
14005
+ const localVarOperationServerBasePath = operationServerMap['BrowserAuthenticationApi.authorize']?.[localVarOperationServerIndex]?.url;
14006
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14007
+ },
14008
+ /**
14009
+ * 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.
14010
+ * @summary Exchange a native callback code
14011
+ * @param {BrowserAuthExchangeRequest} browserAuthExchangeRequest
14012
+ * @param {*} [options] Override http request option.
14013
+ * @throws {RequiredError}
14014
+ */
14015
+ async exchange(browserAuthExchangeRequest: BrowserAuthExchangeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseBrowserAuthSessionResponse>> {
14016
+ const localVarAxiosArgs = await localVarAxiosParamCreator.exchange(browserAuthExchangeRequest, options);
14017
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
14018
+ const localVarOperationServerBasePath = operationServerMap['BrowserAuthenticationApi.exchange']?.[localVarOperationServerIndex]?.url;
14019
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14020
+ },
14021
+ /**
14022
+ * Requires an exact configured redirect URI, random client state and S256 PKCE challenge. Open the returned URL in the system browser.
14023
+ * @summary Start browser sign-in
14024
+ * @param {BrowserAuthStartRequest} browserAuthStartRequest
14025
+ * @param {*} [options] Override http request option.
14026
+ * @throws {RequiredError}
14027
+ */
14028
+ async start(browserAuthStartRequest: BrowserAuthStartRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseBrowserAuthStartResponse>> {
14029
+ const localVarAxiosArgs = await localVarAxiosParamCreator.start(browserAuthStartRequest, options);
14030
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
14031
+ const localVarOperationServerBasePath = operationServerMap['BrowserAuthenticationApi.start']?.[localVarOperationServerIndex]?.url;
14032
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14033
+ },
14034
+ }
14035
+ };
14036
+
14037
+ /**
14038
+ * BrowserAuthenticationApi - factory interface
14039
+ */
14040
+ export const BrowserAuthenticationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
14041
+ const localVarFp = BrowserAuthenticationApiFp(configuration)
14042
+ return {
14043
+ /**
14044
+ *
14045
+ * @summary Open the browser-owned provider session
14046
+ * @param {string} flow
14047
+ * @param {*} [options] Override http request option.
14048
+ * @throws {RequiredError}
14049
+ */
14050
+ authorize(flow: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
14051
+ return localVarFp.authorize(flow, options).then((request) => request(axios, basePath));
14052
+ },
14053
+ /**
14054
+ * 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.
14055
+ * @summary Exchange a native callback code
14056
+ * @param {BrowserAuthExchangeRequest} browserAuthExchangeRequest
14057
+ * @param {*} [options] Override http request option.
14058
+ * @throws {RequiredError}
14059
+ */
14060
+ exchange(browserAuthExchangeRequest: BrowserAuthExchangeRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseBrowserAuthSessionResponse> {
14061
+ return localVarFp.exchange(browserAuthExchangeRequest, options).then((request) => request(axios, basePath));
14062
+ },
14063
+ /**
14064
+ * Requires an exact configured redirect URI, random client state and S256 PKCE challenge. Open the returned URL in the system browser.
14065
+ * @summary Start browser sign-in
14066
+ * @param {BrowserAuthStartRequest} browserAuthStartRequest
14067
+ * @param {*} [options] Override http request option.
14068
+ * @throws {RequiredError}
14069
+ */
14070
+ start(browserAuthStartRequest: BrowserAuthStartRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseBrowserAuthStartResponse> {
14071
+ return localVarFp.start(browserAuthStartRequest, options).then((request) => request(axios, basePath));
14072
+ },
14073
+ };
14074
+ };
14075
+
14076
+ /**
14077
+ * BrowserAuthenticationApi - object-oriented interface
14078
+ */
14079
+ export class BrowserAuthenticationApi extends BaseAPI {
14080
+ /**
14081
+ *
14082
+ * @summary Open the browser-owned provider session
14083
+ * @param {string} flow
14084
+ * @param {*} [options] Override http request option.
14085
+ * @throws {RequiredError}
14086
+ */
14087
+ public authorize(flow: string, options?: RawAxiosRequestConfig) {
14088
+ return BrowserAuthenticationApiFp(this.configuration).authorize(flow, options).then((request) => request(this.axios, this.basePath));
14089
+ }
14090
+
14091
+ /**
14092
+ * 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.
14093
+ * @summary Exchange a native callback code
14094
+ * @param {BrowserAuthExchangeRequest} browserAuthExchangeRequest
14095
+ * @param {*} [options] Override http request option.
14096
+ * @throws {RequiredError}
14097
+ */
14098
+ public exchange(browserAuthExchangeRequest: BrowserAuthExchangeRequest, options?: RawAxiosRequestConfig) {
14099
+ return BrowserAuthenticationApiFp(this.configuration).exchange(browserAuthExchangeRequest, options).then((request) => request(this.axios, this.basePath));
14100
+ }
14101
+
14102
+ /**
14103
+ * Requires an exact configured redirect URI, random client state and S256 PKCE challenge. Open the returned URL in the system browser.
14104
+ * @summary Start browser sign-in
14105
+ * @param {BrowserAuthStartRequest} browserAuthStartRequest
14106
+ * @param {*} [options] Override http request option.
14107
+ * @throws {RequiredError}
14108
+ */
14109
+ public start(browserAuthStartRequest: BrowserAuthStartRequest, options?: RawAxiosRequestConfig) {
14110
+ return BrowserAuthenticationApiFp(this.configuration).start(browserAuthStartRequest, options).then((request) => request(this.axios, this.basePath));
14111
+ }
14112
+ }
14113
+
14114
+
14115
+
13407
14116
  /**
13408
14117
  * CMSModulesApi - axios parameter creator
13409
14118
  */
@@ -23153,6 +23862,402 @@ export class ModuleApi extends BaseAPI {
23153
23862
 
23154
23863
 
23155
23864
 
23865
+ /**
23866
+ * NavigationApi - axios parameter creator
23867
+ */
23868
+ export const NavigationApiAxiosParamCreator = function (configuration?: Configuration) {
23869
+ return {
23870
+ /**
23871
+ * Selected-company favorites across objects. Archived readable favorites require includeArchived=true. Each result carries only object identity/capability names and view navigation metadata.
23872
+ * @summary Read authorized favorite views
23873
+ * @param {boolean} [includeArchived]
23874
+ * @param {*} [options] Override http request option.
23875
+ * @throws {RequiredError}
23876
+ */
23877
+ favorites: async (includeArchived?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
23878
+ const localVarPath = `/api/v2/navigation/favorites`;
23879
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
23880
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
23881
+ let baseOptions;
23882
+ if (configuration) {
23883
+ baseOptions = configuration.baseOptions;
23884
+ }
23885
+
23886
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
23887
+ const localVarHeaderParameter = {} as any;
23888
+ const localVarQueryParameter = {} as any;
23889
+
23890
+ // authentication bearerAuth required
23891
+ // http bearer authentication required
23892
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
23893
+
23894
+ if (includeArchived !== undefined) {
23895
+ localVarQueryParameter['includeArchived'] = includeArchived;
23896
+ }
23897
+
23898
+ localVarHeaderParameter['Accept'] = '*/*,application/json';
23899
+
23900
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
23901
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
23902
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
23903
+
23904
+ return {
23905
+ url: toPathString(localVarUrlObj),
23906
+ options: localVarRequestOptions,
23907
+ };
23908
+ },
23909
+ /**
23910
+ * Selected-company object and view summaries with permission-gated menus. Does not load schemas, users, scopes, branding or dashboards.
23911
+ * @summary Read authorized navigation
23912
+ * @param {*} [options] Override http request option.
23913
+ * @throws {RequiredError}
23914
+ */
23915
+ navigation: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
23916
+ const localVarPath = `/api/v2/navigation`;
23917
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
23918
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
23919
+ let baseOptions;
23920
+ if (configuration) {
23921
+ baseOptions = configuration.baseOptions;
23922
+ }
23923
+
23924
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
23925
+ const localVarHeaderParameter = {} as any;
23926
+ const localVarQueryParameter = {} as any;
23927
+
23928
+ // authentication bearerAuth required
23929
+ // http bearer authentication required
23930
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
23931
+
23932
+ localVarHeaderParameter['Accept'] = '*/*,application/json';
23933
+
23934
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
23935
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
23936
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
23937
+
23938
+ return {
23939
+ url: toPathString(localVarUrlObj),
23940
+ options: localVarRequestOptions,
23941
+ };
23942
+ },
23943
+ /**
23944
+ * 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.
23945
+ * @summary Set personal view navigation preferences
23946
+ * @param {string} objectUuid
23947
+ * @param {ViewNavigationPreferencesRequest} viewNavigationPreferencesRequest
23948
+ * @param {*} [options] Override http request option.
23949
+ * @throws {RequiredError}
23950
+ */
23951
+ preferences: async (objectUuid: string, viewNavigationPreferencesRequest: ViewNavigationPreferencesRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
23952
+ // verify required parameter 'objectUuid' is not null or undefined
23953
+ assertParamExists('preferences', 'objectUuid', objectUuid)
23954
+ // verify required parameter 'viewNavigationPreferencesRequest' is not null or undefined
23955
+ assertParamExists('preferences', 'viewNavigationPreferencesRequest', viewNavigationPreferencesRequest)
23956
+ const localVarPath = `/api/v2/navigation/objects/{objectUuid}/view-preferences`
23957
+ .replace('{objectUuid}', encodeURIComponent(String(objectUuid)));
23958
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
23959
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
23960
+ let baseOptions;
23961
+ if (configuration) {
23962
+ baseOptions = configuration.baseOptions;
23963
+ }
23964
+
23965
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
23966
+ const localVarHeaderParameter = {} as any;
23967
+ const localVarQueryParameter = {} as any;
23968
+
23969
+ // authentication bearerAuth required
23970
+ // http bearer authentication required
23971
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
23972
+
23973
+ localVarHeaderParameter['Content-Type'] = 'application/json';
23974
+ localVarHeaderParameter['Accept'] = '*/*,application/json';
23975
+
23976
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
23977
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
23978
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
23979
+ localVarRequestOptions.data = serializeDataIfNeeded(viewNavigationPreferencesRequest, localVarRequestOptions, configuration)
23980
+
23981
+ return {
23982
+ url: toPathString(localVarUrlObj),
23983
+ options: localVarRequestOptions,
23984
+ };
23985
+ },
23986
+ /**
23987
+ * 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.
23988
+ * @summary Read available access scopes
23989
+ * @param {*} [options] Override http request option.
23990
+ * @throws {RequiredError}
23991
+ */
23992
+ scopes: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
23993
+ const localVarPath = `/api/v2/access/scopes`;
23994
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
23995
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
23996
+ let baseOptions;
23997
+ if (configuration) {
23998
+ baseOptions = configuration.baseOptions;
23999
+ }
24000
+
24001
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
24002
+ const localVarHeaderParameter = {} as any;
24003
+ const localVarQueryParameter = {} as any;
24004
+
24005
+ // authentication bearerAuth required
24006
+ // http bearer authentication required
24007
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
24008
+
24009
+ localVarHeaderParameter['Accept'] = '*/*,application/json';
24010
+
24011
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
24012
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
24013
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
24014
+
24015
+ return {
24016
+ url: toPathString(localVarUrlObj),
24017
+ options: localVarRequestOptions,
24018
+ };
24019
+ },
24020
+ /**
24021
+ * Intent-loaded selected-company metadata. Archived readable views are included only with includeArchived=true; no filters, schemas or sharing grants are returned.
24022
+ * @summary Read authorized view navigation summaries
24023
+ * @param {string} objectUuid
24024
+ * @param {boolean} [includeArchived]
24025
+ * @param {*} [options] Override http request option.
24026
+ * @throws {RequiredError}
24027
+ */
24028
+ views: async (objectUuid: string, includeArchived?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
24029
+ // verify required parameter 'objectUuid' is not null or undefined
24030
+ assertParamExists('views', 'objectUuid', objectUuid)
24031
+ const localVarPath = `/api/v2/navigation/objects/{objectUuid}/views`
24032
+ .replace('{objectUuid}', encodeURIComponent(String(objectUuid)));
24033
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
24034
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
24035
+ let baseOptions;
24036
+ if (configuration) {
24037
+ baseOptions = configuration.baseOptions;
24038
+ }
24039
+
24040
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
24041
+ const localVarHeaderParameter = {} as any;
24042
+ const localVarQueryParameter = {} as any;
24043
+
24044
+ // authentication bearerAuth required
24045
+ // http bearer authentication required
24046
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
24047
+
24048
+ if (includeArchived !== undefined) {
24049
+ localVarQueryParameter['includeArchived'] = includeArchived;
24050
+ }
24051
+
24052
+ localVarHeaderParameter['Accept'] = '*/*,application/json';
24053
+
24054
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
24055
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
24056
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
24057
+
24058
+ return {
24059
+ url: toPathString(localVarUrlObj),
24060
+ options: localVarRequestOptions,
24061
+ };
24062
+ },
24063
+ }
24064
+ };
24065
+
24066
+ /**
24067
+ * NavigationApi - functional programming interface
24068
+ */
24069
+ export const NavigationApiFp = function(configuration?: Configuration) {
24070
+ const localVarAxiosParamCreator = NavigationApiAxiosParamCreator(configuration)
24071
+ return {
24072
+ /**
24073
+ * Selected-company favorites across objects. Archived readable favorites require includeArchived=true. Each result carries only object identity/capability names and view navigation metadata.
24074
+ * @summary Read authorized favorite views
24075
+ * @param {boolean} [includeArchived]
24076
+ * @param {*} [options] Override http request option.
24077
+ * @throws {RequiredError}
24078
+ */
24079
+ async favorites(includeArchived?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseListFavoriteViewDTO>> {
24080
+ const localVarAxiosArgs = await localVarAxiosParamCreator.favorites(includeArchived, options);
24081
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
24082
+ const localVarOperationServerBasePath = operationServerMap['NavigationApi.favorites']?.[localVarOperationServerIndex]?.url;
24083
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
24084
+ },
24085
+ /**
24086
+ * Selected-company object and view summaries with permission-gated menus. Does not load schemas, users, scopes, branding or dashboards.
24087
+ * @summary Read authorized navigation
24088
+ * @param {*} [options] Override http request option.
24089
+ * @throws {RequiredError}
24090
+ */
24091
+ async navigation(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseNavigationDTO>> {
24092
+ const localVarAxiosArgs = await localVarAxiosParamCreator.navigation(options);
24093
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
24094
+ const localVarOperationServerBasePath = operationServerMap['NavigationApi.navigation']?.[localVarOperationServerIndex]?.url;
24095
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
24096
+ },
24097
+ /**
24098
+ * 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.
24099
+ * @summary Set personal view navigation preferences
24100
+ * @param {string} objectUuid
24101
+ * @param {ViewNavigationPreferencesRequest} viewNavigationPreferencesRequest
24102
+ * @param {*} [options] Override http request option.
24103
+ * @throws {RequiredError}
24104
+ */
24105
+ async preferences(objectUuid: string, viewNavigationPreferencesRequest: ViewNavigationPreferencesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseListNavigationViewDTO>> {
24106
+ const localVarAxiosArgs = await localVarAxiosParamCreator.preferences(objectUuid, viewNavigationPreferencesRequest, options);
24107
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
24108
+ const localVarOperationServerBasePath = operationServerMap['NavigationApi.preferences']?.[localVarOperationServerIndex]?.url;
24109
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
24110
+ },
24111
+ /**
24112
+ * 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.
24113
+ * @summary Read available access scopes
24114
+ * @param {*} [options] Override http request option.
24115
+ * @throws {RequiredError}
24116
+ */
24117
+ async scopes(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseListString>> {
24118
+ const localVarAxiosArgs = await localVarAxiosParamCreator.scopes(options);
24119
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
24120
+ const localVarOperationServerBasePath = operationServerMap['NavigationApi.scopes']?.[localVarOperationServerIndex]?.url;
24121
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
24122
+ },
24123
+ /**
24124
+ * Intent-loaded selected-company metadata. Archived readable views are included only with includeArchived=true; no filters, schemas or sharing grants are returned.
24125
+ * @summary Read authorized view navigation summaries
24126
+ * @param {string} objectUuid
24127
+ * @param {boolean} [includeArchived]
24128
+ * @param {*} [options] Override http request option.
24129
+ * @throws {RequiredError}
24130
+ */
24131
+ async views(objectUuid: string, includeArchived?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseListNavigationViewDTO>> {
24132
+ const localVarAxiosArgs = await localVarAxiosParamCreator.views(objectUuid, includeArchived, options);
24133
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
24134
+ const localVarOperationServerBasePath = operationServerMap['NavigationApi.views']?.[localVarOperationServerIndex]?.url;
24135
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
24136
+ },
24137
+ }
24138
+ };
24139
+
24140
+ /**
24141
+ * NavigationApi - factory interface
24142
+ */
24143
+ export const NavigationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
24144
+ const localVarFp = NavigationApiFp(configuration)
24145
+ return {
24146
+ /**
24147
+ * Selected-company favorites across objects. Archived readable favorites require includeArchived=true. Each result carries only object identity/capability names and view navigation metadata.
24148
+ * @summary Read authorized favorite views
24149
+ * @param {boolean} [includeArchived]
24150
+ * @param {*} [options] Override http request option.
24151
+ * @throws {RequiredError}
24152
+ */
24153
+ favorites(includeArchived?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseListFavoriteViewDTO> {
24154
+ return localVarFp.favorites(includeArchived, options).then((request) => request(axios, basePath));
24155
+ },
24156
+ /**
24157
+ * Selected-company object and view summaries with permission-gated menus. Does not load schemas, users, scopes, branding or dashboards.
24158
+ * @summary Read authorized navigation
24159
+ * @param {*} [options] Override http request option.
24160
+ * @throws {RequiredError}
24161
+ */
24162
+ navigation(options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseNavigationDTO> {
24163
+ return localVarFp.navigation(options).then((request) => request(axios, basePath));
24164
+ },
24165
+ /**
24166
+ * 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.
24167
+ * @summary Set personal view navigation preferences
24168
+ * @param {string} objectUuid
24169
+ * @param {ViewNavigationPreferencesRequest} viewNavigationPreferencesRequest
24170
+ * @param {*} [options] Override http request option.
24171
+ * @throws {RequiredError}
24172
+ */
24173
+ preferences(objectUuid: string, viewNavigationPreferencesRequest: ViewNavigationPreferencesRequest, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseListNavigationViewDTO> {
24174
+ return localVarFp.preferences(objectUuid, viewNavigationPreferencesRequest, options).then((request) => request(axios, basePath));
24175
+ },
24176
+ /**
24177
+ * 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.
24178
+ * @summary Read available access scopes
24179
+ * @param {*} [options] Override http request option.
24180
+ * @throws {RequiredError}
24181
+ */
24182
+ scopes(options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseListString> {
24183
+ return localVarFp.scopes(options).then((request) => request(axios, basePath));
24184
+ },
24185
+ /**
24186
+ * Intent-loaded selected-company metadata. Archived readable views are included only with includeArchived=true; no filters, schemas or sharing grants are returned.
24187
+ * @summary Read authorized view navigation summaries
24188
+ * @param {string} objectUuid
24189
+ * @param {boolean} [includeArchived]
24190
+ * @param {*} [options] Override http request option.
24191
+ * @throws {RequiredError}
24192
+ */
24193
+ views(objectUuid: string, includeArchived?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseListNavigationViewDTO> {
24194
+ return localVarFp.views(objectUuid, includeArchived, options).then((request) => request(axios, basePath));
24195
+ },
24196
+ };
24197
+ };
24198
+
24199
+ /**
24200
+ * NavigationApi - object-oriented interface
24201
+ */
24202
+ export class NavigationApi extends BaseAPI {
24203
+ /**
24204
+ * Selected-company favorites across objects. Archived readable favorites require includeArchived=true. Each result carries only object identity/capability names and view navigation metadata.
24205
+ * @summary Read authorized favorite views
24206
+ * @param {boolean} [includeArchived]
24207
+ * @param {*} [options] Override http request option.
24208
+ * @throws {RequiredError}
24209
+ */
24210
+ public favorites(includeArchived?: boolean, options?: RawAxiosRequestConfig) {
24211
+ return NavigationApiFp(this.configuration).favorites(includeArchived, options).then((request) => request(this.axios, this.basePath));
24212
+ }
24213
+
24214
+ /**
24215
+ * Selected-company object and view summaries with permission-gated menus. Does not load schemas, users, scopes, branding or dashboards.
24216
+ * @summary Read authorized navigation
24217
+ * @param {*} [options] Override http request option.
24218
+ * @throws {RequiredError}
24219
+ */
24220
+ public navigation(options?: RawAxiosRequestConfig) {
24221
+ return NavigationApiFp(this.configuration).navigation(options).then((request) => request(this.axios, this.basePath));
24222
+ }
24223
+
24224
+ /**
24225
+ * 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.
24226
+ * @summary Set personal view navigation preferences
24227
+ * @param {string} objectUuid
24228
+ * @param {ViewNavigationPreferencesRequest} viewNavigationPreferencesRequest
24229
+ * @param {*} [options] Override http request option.
24230
+ * @throws {RequiredError}
24231
+ */
24232
+ public preferences(objectUuid: string, viewNavigationPreferencesRequest: ViewNavigationPreferencesRequest, options?: RawAxiosRequestConfig) {
24233
+ return NavigationApiFp(this.configuration).preferences(objectUuid, viewNavigationPreferencesRequest, options).then((request) => request(this.axios, this.basePath));
24234
+ }
24235
+
24236
+ /**
24237
+ * 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.
24238
+ * @summary Read available access scopes
24239
+ * @param {*} [options] Override http request option.
24240
+ * @throws {RequiredError}
24241
+ */
24242
+ public scopes(options?: RawAxiosRequestConfig) {
24243
+ return NavigationApiFp(this.configuration).scopes(options).then((request) => request(this.axios, this.basePath));
24244
+ }
24245
+
24246
+ /**
24247
+ * Intent-loaded selected-company metadata. Archived readable views are included only with includeArchived=true; no filters, schemas or sharing grants are returned.
24248
+ * @summary Read authorized view navigation summaries
24249
+ * @param {string} objectUuid
24250
+ * @param {boolean} [includeArchived]
24251
+ * @param {*} [options] Override http request option.
24252
+ * @throws {RequiredError}
24253
+ */
24254
+ public views(objectUuid: string, includeArchived?: boolean, options?: RawAxiosRequestConfig) {
24255
+ return NavigationApiFp(this.configuration).views(objectUuid, includeArchived, options).then((request) => request(this.axios, this.basePath));
24256
+ }
24257
+ }
24258
+
24259
+
24260
+
23156
24261
  /**
23157
24262
  * NotificationsApi - axios parameter creator
23158
24263
  */
@@ -23230,6 +24335,44 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi
23230
24335
  options: localVarRequestOptions,
23231
24336
  };
23232
24337
  },
24338
+ /**
24339
+ * Returns an inbox entry only for its human recipient in the authorized selected company, including entries outside the inbox page.
24340
+ * @summary Get an authoritative notification by ID
24341
+ * @param {string} notificationId
24342
+ * @param {*} [options] Override http request option.
24343
+ * @throws {RequiredError}
24344
+ */
24345
+ getNotification: async (notificationId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
24346
+ // verify required parameter 'notificationId' is not null or undefined
24347
+ assertParamExists('getNotification', 'notificationId', notificationId)
24348
+ const localVarPath = `/api/v2/notifications/{notificationId}`
24349
+ .replace('{notificationId}', encodeURIComponent(String(notificationId)));
24350
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
24351
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
24352
+ let baseOptions;
24353
+ if (configuration) {
24354
+ baseOptions = configuration.baseOptions;
24355
+ }
24356
+
24357
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
24358
+ const localVarHeaderParameter = {} as any;
24359
+ const localVarQueryParameter = {} as any;
24360
+
24361
+ // authentication bearerAuth required
24362
+ // http bearer authentication required
24363
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
24364
+
24365
+ localVarHeaderParameter['Accept'] = 'application/json';
24366
+
24367
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
24368
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
24369
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
24370
+
24371
+ return {
24372
+ url: toPathString(localVarUrlObj),
24373
+ options: localVarRequestOptions,
24374
+ };
24375
+ },
23233
24376
  /**
23234
24377
  * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
23235
24378
  * @summary List in-app notifications for the logged-in user
@@ -23346,6 +24489,49 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi
23346
24489
  options: localVarRequestOptions,
23347
24490
  };
23348
24491
  },
24492
+ /**
24493
+ * Idempotently registers an allowed native application. Human authentication required. Does not accept a target user or company. Rotate the registration when moving between accounts.
24494
+ * @summary Register this user\'s native notification device
24495
+ * @param {string} deviceInstallationId
24496
+ * @param {NotificationDeviceRegistration} notificationDeviceRegistration
24497
+ * @param {*} [options] Override http request option.
24498
+ * @throws {RequiredError}
24499
+ */
24500
+ registerDevice: async (deviceInstallationId: string, notificationDeviceRegistration: NotificationDeviceRegistration, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
24501
+ // verify required parameter 'deviceInstallationId' is not null or undefined
24502
+ assertParamExists('registerDevice', 'deviceInstallationId', deviceInstallationId)
24503
+ // verify required parameter 'notificationDeviceRegistration' is not null or undefined
24504
+ assertParamExists('registerDevice', 'notificationDeviceRegistration', notificationDeviceRegistration)
24505
+ const localVarPath = `/api/v2/notifications/devices/{deviceInstallationId}`
24506
+ .replace('{deviceInstallationId}', encodeURIComponent(String(deviceInstallationId)));
24507
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
24508
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
24509
+ let baseOptions;
24510
+ if (configuration) {
24511
+ baseOptions = configuration.baseOptions;
24512
+ }
24513
+
24514
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
24515
+ const localVarHeaderParameter = {} as any;
24516
+ const localVarQueryParameter = {} as any;
24517
+
24518
+ // authentication bearerAuth required
24519
+ // http bearer authentication required
24520
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
24521
+
24522
+ localVarHeaderParameter['Content-Type'] = 'application/json';
24523
+ localVarHeaderParameter['Accept'] = 'application/json';
24524
+
24525
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
24526
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
24527
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
24528
+ localVarRequestOptions.data = serializeDataIfNeeded(notificationDeviceRegistration, localVarRequestOptions, configuration)
24529
+
24530
+ return {
24531
+ url: toPathString(localVarUrlObj),
24532
+ options: localVarRequestOptions,
24533
+ };
24534
+ },
23349
24535
  /**
23350
24536
  * 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.
23351
24537
  * @summary Send a notification (app token)
@@ -23380,6 +24566,44 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi
23380
24566
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
23381
24567
  localVarRequestOptions.data = serializeDataIfNeeded(sendNotificationRequest, localVarRequestOptions, configuration)
23382
24568
 
24569
+ return {
24570
+ url: toPathString(localVarUrlObj),
24571
+ options: localVarRequestOptions,
24572
+ };
24573
+ },
24574
+ /**
24575
+ * Idempotent. Call before logout; other users\' device registrations are inaccessible.
24576
+ * @summary Unregister this user\'s native notification device
24577
+ * @param {string} deviceInstallationId
24578
+ * @param {*} [options] Override http request option.
24579
+ * @throws {RequiredError}
24580
+ */
24581
+ unregisterDevice: async (deviceInstallationId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
24582
+ // verify required parameter 'deviceInstallationId' is not null or undefined
24583
+ assertParamExists('unregisterDevice', 'deviceInstallationId', deviceInstallationId)
24584
+ const localVarPath = `/api/v2/notifications/devices/{deviceInstallationId}`
24585
+ .replace('{deviceInstallationId}', encodeURIComponent(String(deviceInstallationId)));
24586
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
24587
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
24588
+ let baseOptions;
24589
+ if (configuration) {
24590
+ baseOptions = configuration.baseOptions;
24591
+ }
24592
+
24593
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
24594
+ const localVarHeaderParameter = {} as any;
24595
+ const localVarQueryParameter = {} as any;
24596
+
24597
+ // authentication bearerAuth required
24598
+ // http bearer authentication required
24599
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
24600
+
24601
+ localVarHeaderParameter['Accept'] = 'application/json';
24602
+
24603
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
24604
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
24605
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
24606
+
23383
24607
  return {
23384
24608
  url: toPathString(localVarUrlObj),
23385
24609
  options: localVarRequestOptions,
@@ -23419,6 +24643,19 @@ export const NotificationsApiFp = function(configuration?: Configuration) {
23419
24643
  const localVarOperationServerBasePath = operationServerMap['NotificationsApi.firebaseToken']?.[localVarOperationServerIndex]?.url;
23420
24644
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
23421
24645
  },
24646
+ /**
24647
+ * Returns an inbox entry only for its human recipient in the authorized selected company, including entries outside the inbox page.
24648
+ * @summary Get an authoritative notification by ID
24649
+ * @param {string} notificationId
24650
+ * @param {*} [options] Override http request option.
24651
+ * @throws {RequiredError}
24652
+ */
24653
+ async getNotification(notificationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseItem>> {
24654
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getNotification(notificationId, options);
24655
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
24656
+ const localVarOperationServerBasePath = operationServerMap['NotificationsApi.getNotification']?.[localVarOperationServerIndex]?.url;
24657
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
24658
+ },
23422
24659
  /**
23423
24660
  * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
23424
24661
  * @summary List in-app notifications for the logged-in user
@@ -23458,6 +24695,20 @@ export const NotificationsApiFp = function(configuration?: Configuration) {
23458
24695
  const localVarOperationServerBasePath = operationServerMap['NotificationsApi.markAsRead']?.[localVarOperationServerIndex]?.url;
23459
24696
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
23460
24697
  },
24698
+ /**
24699
+ * Idempotently registers an allowed native application. Human authentication required. Does not accept a target user or company. Rotate the registration when moving between accounts.
24700
+ * @summary Register this user\'s native notification device
24701
+ * @param {string} deviceInstallationId
24702
+ * @param {NotificationDeviceRegistration} notificationDeviceRegistration
24703
+ * @param {*} [options] Override http request option.
24704
+ * @throws {RequiredError}
24705
+ */
24706
+ async registerDevice(deviceInstallationId: string, notificationDeviceRegistration: NotificationDeviceRegistration, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseNotificationDeviceReceipt>> {
24707
+ const localVarAxiosArgs = await localVarAxiosParamCreator.registerDevice(deviceInstallationId, notificationDeviceRegistration, options);
24708
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
24709
+ const localVarOperationServerBasePath = operationServerMap['NotificationsApi.registerDevice']?.[localVarOperationServerIndex]?.url;
24710
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
24711
+ },
23461
24712
  /**
23462
24713
  * 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.
23463
24714
  * @summary Send a notification (app token)
@@ -23471,6 +24722,19 @@ export const NotificationsApiFp = function(configuration?: Configuration) {
23471
24722
  const localVarOperationServerBasePath = operationServerMap['NotificationsApi.sendNotification']?.[localVarOperationServerIndex]?.url;
23472
24723
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
23473
24724
  },
24725
+ /**
24726
+ * Idempotent. Call before logout; other users\' device registrations are inaccessible.
24727
+ * @summary Unregister this user\'s native notification device
24728
+ * @param {string} deviceInstallationId
24729
+ * @param {*} [options] Override http request option.
24730
+ * @throws {RequiredError}
24731
+ */
24732
+ async unregisterDevice(deviceInstallationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseString>> {
24733
+ const localVarAxiosArgs = await localVarAxiosParamCreator.unregisterDevice(deviceInstallationId, options);
24734
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
24735
+ const localVarOperationServerBasePath = operationServerMap['NotificationsApi.unregisterDevice']?.[localVarOperationServerIndex]?.url;
24736
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
24737
+ },
23474
24738
  }
23475
24739
  };
23476
24740
 
@@ -23499,6 +24763,16 @@ export const NotificationsApiFactory = function (configuration?: Configuration,
23499
24763
  firebaseToken(options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringString> {
23500
24764
  return localVarFp.firebaseToken(options).then((request) => request(axios, basePath));
23501
24765
  },
24766
+ /**
24767
+ * Returns an inbox entry only for its human recipient in the authorized selected company, including entries outside the inbox page.
24768
+ * @summary Get an authoritative notification by ID
24769
+ * @param {string} notificationId
24770
+ * @param {*} [options] Override http request option.
24771
+ * @throws {RequiredError}
24772
+ */
24773
+ getNotification(notificationId: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseItem> {
24774
+ return localVarFp.getNotification(notificationId, options).then((request) => request(axios, basePath));
24775
+ },
23502
24776
  /**
23503
24777
  * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
23504
24778
  * @summary List in-app notifications for the logged-in user
@@ -23529,6 +24803,17 @@ export const NotificationsApiFactory = function (configuration?: Configuration,
23529
24803
  markAsRead(notificationId: string, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseString> {
23530
24804
  return localVarFp.markAsRead(notificationId, options).then((request) => request(axios, basePath));
23531
24805
  },
24806
+ /**
24807
+ * Idempotently registers an allowed native application. Human authentication required. Does not accept a target user or company. Rotate the registration when moving between accounts.
24808
+ * @summary Register this user\'s native notification device
24809
+ * @param {string} deviceInstallationId
24810
+ * @param {NotificationDeviceRegistration} notificationDeviceRegistration
24811
+ * @param {*} [options] Override http request option.
24812
+ * @throws {RequiredError}
24813
+ */
24814
+ registerDevice(deviceInstallationId: string, notificationDeviceRegistration: NotificationDeviceRegistration, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseNotificationDeviceReceipt> {
24815
+ return localVarFp.registerDevice(deviceInstallationId, notificationDeviceRegistration, options).then((request) => request(axios, basePath));
24816
+ },
23532
24817
  /**
23533
24818
  * 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.
23534
24819
  * @summary Send a notification (app token)
@@ -23539,6 +24824,16 @@ export const NotificationsApiFactory = function (configuration?: Configuration,
23539
24824
  sendNotification(sendNotificationRequest: SendNotificationRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateResponseMapStringString> {
23540
24825
  return localVarFp.sendNotification(sendNotificationRequest, options).then((request) => request(axios, basePath));
23541
24826
  },
24827
+ /**
24828
+ * Idempotent. Call before logout; other users\' device registrations are inaccessible.
24829
+ * @summary Unregister this user\'s native notification device
24830
+ * @param {string} deviceInstallationId
24831
+ * @param {*} [options] Override http request option.
24832
+ * @throws {RequiredError}
24833
+ */
24834
+ unregisterDevice(deviceInstallationId: string, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseString> {
24835
+ return localVarFp.unregisterDevice(deviceInstallationId, options).then((request) => request(axios, basePath));
24836
+ },
23542
24837
  };
23543
24838
  };
23544
24839
 
@@ -23567,6 +24862,17 @@ export class NotificationsApi extends BaseAPI {
23567
24862
  return NotificationsApiFp(this.configuration).firebaseToken(options).then((request) => request(this.axios, this.basePath));
23568
24863
  }
23569
24864
 
24865
+ /**
24866
+ * Returns an inbox entry only for its human recipient in the authorized selected company, including entries outside the inbox page.
24867
+ * @summary Get an authoritative notification by ID
24868
+ * @param {string} notificationId
24869
+ * @param {*} [options] Override http request option.
24870
+ * @throws {RequiredError}
24871
+ */
24872
+ public getNotification(notificationId: string, options?: RawAxiosRequestConfig) {
24873
+ return NotificationsApiFp(this.configuration).getNotification(notificationId, options).then((request) => request(this.axios, this.basePath));
24874
+ }
24875
+
23570
24876
  /**
23571
24877
  * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
23572
24878
  * @summary List in-app notifications for the logged-in user
@@ -23600,6 +24906,18 @@ export class NotificationsApi extends BaseAPI {
23600
24906
  return NotificationsApiFp(this.configuration).markAsRead(notificationId, options).then((request) => request(this.axios, this.basePath));
23601
24907
  }
23602
24908
 
24909
+ /**
24910
+ * Idempotently registers an allowed native application. Human authentication required. Does not accept a target user or company. Rotate the registration when moving between accounts.
24911
+ * @summary Register this user\'s native notification device
24912
+ * @param {string} deviceInstallationId
24913
+ * @param {NotificationDeviceRegistration} notificationDeviceRegistration
24914
+ * @param {*} [options] Override http request option.
24915
+ * @throws {RequiredError}
24916
+ */
24917
+ public registerDevice(deviceInstallationId: string, notificationDeviceRegistration: NotificationDeviceRegistration, options?: RawAxiosRequestConfig) {
24918
+ return NotificationsApiFp(this.configuration).registerDevice(deviceInstallationId, notificationDeviceRegistration, options).then((request) => request(this.axios, this.basePath));
24919
+ }
24920
+
23603
24921
  /**
23604
24922
  * 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.
23605
24923
  * @summary Send a notification (app token)
@@ -23610,6 +24928,17 @@ export class NotificationsApi extends BaseAPI {
23610
24928
  public sendNotification(sendNotificationRequest: SendNotificationRequest, options?: RawAxiosRequestConfig) {
23611
24929
  return NotificationsApiFp(this.configuration).sendNotification(sendNotificationRequest, options).then((request) => request(this.axios, this.basePath));
23612
24930
  }
24931
+
24932
+ /**
24933
+ * Idempotent. Call before logout; other users\' device registrations are inaccessible.
24934
+ * @summary Unregister this user\'s native notification device
24935
+ * @param {string} deviceInstallationId
24936
+ * @param {*} [options] Override http request option.
24937
+ * @throws {RequiredError}
24938
+ */
24939
+ public unregisterDevice(deviceInstallationId: string, options?: RawAxiosRequestConfig) {
24940
+ return NotificationsApiFp(this.configuration).unregisterDevice(deviceInstallationId, options).then((request) => request(this.axios, this.basePath));
24941
+ }
23613
24942
  }
23614
24943
 
23615
24944
 
@@ -23746,16 +25075,17 @@ export const ObjectsApiAxiosParamCreator = function (configuration?: Configurati
23746
25075
  };
23747
25076
  },
23748
25077
  /**
23749
- * Fetches a single object by its UUID. Optional parameters determine whether to include views, properties, and relations in the response.
25078
+ * 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.
23750
25079
  * @summary Get object by UUID
23751
25080
  * @param {string} uuid
23752
25081
  * @param {string} [views]
23753
25082
  * @param {string} [properties]
23754
25083
  * @param {string} [relations]
25084
+ * @param {boolean} [includeHiddenProperties]
23755
25085
  * @param {*} [options] Override http request option.
23756
25086
  * @throws {RequiredError}
23757
25087
  */
23758
- getObject: async (uuid: string, views?: string, properties?: string, relations?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
25088
+ getObject: async (uuid: string, views?: string, properties?: string, relations?: string, includeHiddenProperties?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
23759
25089
  // verify required parameter 'uuid' is not null or undefined
23760
25090
  assertParamExists('getObject', 'uuid', uuid)
23761
25091
  const localVarPath = `/api/v2/objects/{uuid}`
@@ -23787,6 +25117,10 @@ export const ObjectsApiAxiosParamCreator = function (configuration?: Configurati
23787
25117
  localVarQueryParameter['relations'] = relations;
23788
25118
  }
23789
25119
 
25120
+ if (includeHiddenProperties !== undefined) {
25121
+ localVarQueryParameter['includeHiddenProperties'] = includeHiddenProperties;
25122
+ }
25123
+
23790
25124
  localVarHeaderParameter['Accept'] = 'application/json';
23791
25125
 
23792
25126
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -24348,17 +25682,18 @@ export const ObjectsApiFp = function(configuration?: Configuration) {
24348
25682
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
24349
25683
  },
24350
25684
  /**
24351
- * Fetches a single object by its UUID. Optional parameters determine whether to include views, properties, and relations in the response.
25685
+ * 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.
24352
25686
  * @summary Get object by UUID
24353
25687
  * @param {string} uuid
24354
25688
  * @param {string} [views]
24355
25689
  * @param {string} [properties]
24356
25690
  * @param {string} [relations]
25691
+ * @param {boolean} [includeHiddenProperties]
24357
25692
  * @param {*} [options] Override http request option.
24358
25693
  * @throws {RequiredError}
24359
25694
  */
24360
- async getObject(uuid: string, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseCaraerObjectDTO>> {
24361
- const localVarAxiosArgs = await localVarAxiosParamCreator.getObject(uuid, views, properties, relations, options);
25695
+ async getObject(uuid: string, views?: string, properties?: string, relations?: string, includeHiddenProperties?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseCaraerObjectDTO>> {
25696
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getObject(uuid, views, properties, relations, includeHiddenProperties, options);
24362
25697
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
24363
25698
  const localVarOperationServerBasePath = operationServerMap['ObjectsApi.getObject']?.[localVarOperationServerIndex]?.url;
24364
25699
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -24564,17 +25899,18 @@ export const ObjectsApiFactory = function (configuration?: Configuration, basePa
24564
25899
  return localVarFp.getAccessGrantCandidates(options).then((request) => request(axios, basePath));
24565
25900
  },
24566
25901
  /**
24567
- * Fetches a single object by its UUID. Optional parameters determine whether to include views, properties, and relations in the response.
25902
+ * 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.
24568
25903
  * @summary Get object by UUID
24569
25904
  * @param {string} uuid
24570
25905
  * @param {string} [views]
24571
25906
  * @param {string} [properties]
24572
25907
  * @param {string} [relations]
25908
+ * @param {boolean} [includeHiddenProperties]
24573
25909
  * @param {*} [options] Override http request option.
24574
25910
  * @throws {RequiredError}
24575
25911
  */
24576
- getObject(uuid: string, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseCaraerObjectDTO> {
24577
- return localVarFp.getObject(uuid, views, properties, relations, options).then((request) => request(axios, basePath));
25912
+ getObject(uuid: string, views?: string, properties?: string, relations?: string, includeHiddenProperties?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseCaraerObjectDTO> {
25913
+ return localVarFp.getObject(uuid, views, properties, relations, includeHiddenProperties, options).then((request) => request(axios, basePath));
24578
25914
  },
24579
25915
  /**
24580
25916
  * 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.
@@ -24745,17 +26081,18 @@ export class ObjectsApi extends BaseAPI {
24745
26081
  }
24746
26082
 
24747
26083
  /**
24748
- * Fetches a single object by its UUID. Optional parameters determine whether to include views, properties, and relations in the response.
26084
+ * 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.
24749
26085
  * @summary Get object by UUID
24750
26086
  * @param {string} uuid
24751
26087
  * @param {string} [views]
24752
26088
  * @param {string} [properties]
24753
26089
  * @param {string} [relations]
26090
+ * @param {boolean} [includeHiddenProperties]
24754
26091
  * @param {*} [options] Override http request option.
24755
26092
  * @throws {RequiredError}
24756
26093
  */
24757
- public getObject(uuid: string, views?: string, properties?: string, relations?: string, options?: RawAxiosRequestConfig) {
24758
- return ObjectsApiFp(this.configuration).getObject(uuid, views, properties, relations, options).then((request) => request(this.axios, this.basePath));
26094
+ public getObject(uuid: string, views?: string, properties?: string, relations?: string, includeHiddenProperties?: boolean, options?: RawAxiosRequestConfig) {
26095
+ return ObjectsApiFp(this.configuration).getObject(uuid, views, properties, relations, includeHiddenProperties, options).then((request) => request(this.axios, this.basePath));
24759
26096
  }
24760
26097
 
24761
26098
  /**
@@ -26286,6 +27623,45 @@ export const RecordsApiAxiosParamCreator = function (configuration?: Configurati
26286
27623
  options: localVarRequestOptions,
26287
27624
  };
26288
27625
  },
27626
+ /**
27627
+ * 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.
27628
+ * @summary Inspect bounded record relation operations
27629
+ * @param {RelationCapabilityRequest} relationCapabilityRequest
27630
+ * @param {*} [options] Override http request option.
27631
+ * @throws {RequiredError}
27632
+ */
27633
+ capabilities: async (relationCapabilityRequest: RelationCapabilityRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
27634
+ // verify required parameter 'relationCapabilityRequest' is not null or undefined
27635
+ assertParamExists('capabilities', 'relationCapabilityRequest', relationCapabilityRequest)
27636
+ const localVarPath = `/api/v2/records/relations/capabilities`;
27637
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
27638
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
27639
+ let baseOptions;
27640
+ if (configuration) {
27641
+ baseOptions = configuration.baseOptions;
27642
+ }
27643
+
27644
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
27645
+ const localVarHeaderParameter = {} as any;
27646
+ const localVarQueryParameter = {} as any;
27647
+
27648
+ // authentication bearerAuth required
27649
+ // http bearer authentication required
27650
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
27651
+
27652
+ localVarHeaderParameter['Content-Type'] = 'application/json';
27653
+ localVarHeaderParameter['Accept'] = 'application/json';
27654
+
27655
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
27656
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
27657
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
27658
+ localVarRequestOptions.data = serializeDataIfNeeded(relationCapabilityRequest, localVarRequestOptions, configuration)
27659
+
27660
+ return {
27661
+ url: toPathString(localVarUrlObj),
27662
+ options: localVarRequestOptions,
27663
+ };
27664
+ },
26289
27665
  /**
26290
27666
  * 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.
26291
27667
  * @summary Create a new record
@@ -26504,6 +27880,52 @@ export const RecordsApiAxiosParamCreator = function (configuration?: Configurati
26504
27880
  options: localVarRequestOptions,
26505
27881
  };
26506
27882
  },
27883
+ /**
27884
+ * 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.
27885
+ * @summary Ensure a relation without changing an existing edge
27886
+ * @param {string} fromUuid
27887
+ * @param {string} relationName
27888
+ * @param {string} toUuid
27889
+ * @param {*} [options] Override http request option.
27890
+ * @throws {RequiredError}
27891
+ */
27892
+ ensure: async (fromUuid: string, relationName: string, toUuid: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
27893
+ // verify required parameter 'fromUuid' is not null or undefined
27894
+ assertParamExists('ensure', 'fromUuid', fromUuid)
27895
+ // verify required parameter 'relationName' is not null or undefined
27896
+ assertParamExists('ensure', 'relationName', relationName)
27897
+ // verify required parameter 'toUuid' is not null or undefined
27898
+ assertParamExists('ensure', 'toUuid', toUuid)
27899
+ const localVarPath = `/api/v2/records/relations/{fromUuid}/{relationName}/{toUuid}`
27900
+ .replace('{fromUuid}', encodeURIComponent(String(fromUuid)))
27901
+ .replace('{relationName}', encodeURIComponent(String(relationName)))
27902
+ .replace('{toUuid}', encodeURIComponent(String(toUuid)));
27903
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
27904
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
27905
+ let baseOptions;
27906
+ if (configuration) {
27907
+ baseOptions = configuration.baseOptions;
27908
+ }
27909
+
27910
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
27911
+ const localVarHeaderParameter = {} as any;
27912
+ const localVarQueryParameter = {} as any;
27913
+
27914
+ // authentication bearerAuth required
27915
+ // http bearer authentication required
27916
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
27917
+
27918
+ localVarHeaderParameter['Accept'] = 'application/json';
27919
+
27920
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
27921
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
27922
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
27923
+
27924
+ return {
27925
+ url: toPathString(localVarUrlObj),
27926
+ options: localVarRequestOptions,
27927
+ };
27928
+ },
26507
27929
  /**
26508
27930
  * 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.
26509
27931
  * @summary Extend a record
@@ -27420,6 +28842,19 @@ export const RecordsApiFp = function(configuration?: Configuration) {
27420
28842
  const localVarOperationServerBasePath = operationServerMap['RecordsApi.bulkEdit']?.[localVarOperationServerIndex]?.url;
27421
28843
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
27422
28844
  },
28845
+ /**
28846
+ * 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.
28847
+ * @summary Inspect bounded record relation operations
28848
+ * @param {RelationCapabilityRequest} relationCapabilityRequest
28849
+ * @param {*} [options] Override http request option.
28850
+ * @throws {RequiredError}
28851
+ */
28852
+ async capabilities(relationCapabilityRequest: RelationCapabilityRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseRelationCapabilities>> {
28853
+ const localVarAxiosArgs = await localVarAxiosParamCreator.capabilities(relationCapabilityRequest, options);
28854
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
28855
+ const localVarOperationServerBasePath = operationServerMap['RecordsApi.capabilities']?.[localVarOperationServerIndex]?.url;
28856
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
28857
+ },
27423
28858
  /**
27424
28859
  * 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.
27425
28860
  * @summary Create a new record
@@ -27486,6 +28921,21 @@ export const RecordsApiFp = function(configuration?: Configuration) {
27486
28921
  const localVarOperationServerBasePath = operationServerMap['RecordsApi.deleteRelation']?.[localVarOperationServerIndex]?.url;
27487
28922
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
27488
28923
  },
28924
+ /**
28925
+ * 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.
28926
+ * @summary Ensure a relation without changing an existing edge
28927
+ * @param {string} fromUuid
28928
+ * @param {string} relationName
28929
+ * @param {string} toUuid
28930
+ * @param {*} [options] Override http request option.
28931
+ * @throws {RequiredError}
28932
+ */
28933
+ async ensure(fromUuid: string, relationName: string, toUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseEnsureRelationDTO>> {
28934
+ const localVarAxiosArgs = await localVarAxiosParamCreator.ensure(fromUuid, relationName, toUuid, options);
28935
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
28936
+ const localVarOperationServerBasePath = operationServerMap['RecordsApi.ensure']?.[localVarOperationServerIndex]?.url;
28937
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
28938
+ },
27489
28939
  /**
27490
28940
  * 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.
27491
28941
  * @summary Extend a record
@@ -27809,6 +29259,16 @@ export const RecordsApiFactory = function (configuration?: Configuration, basePa
27809
29259
  bulkEdit(objectName: string, bulkEditRecordsRequest: BulkEditRecordsRequest, ignoreErrors?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<BulkEditRecordsResponse> {
27810
29260
  return localVarFp.bulkEdit(objectName, bulkEditRecordsRequest, ignoreErrors, options).then((request) => request(axios, basePath));
27811
29261
  },
29262
+ /**
29263
+ * 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.
29264
+ * @summary Inspect bounded record relation operations
29265
+ * @param {RelationCapabilityRequest} relationCapabilityRequest
29266
+ * @param {*} [options] Override http request option.
29267
+ * @throws {RequiredError}
29268
+ */
29269
+ capabilities(relationCapabilityRequest: RelationCapabilityRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseRelationCapabilities> {
29270
+ return localVarFp.capabilities(relationCapabilityRequest, options).then((request) => request(axios, basePath));
29271
+ },
27812
29272
  /**
27813
29273
  * 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.
27814
29274
  * @summary Create a new record
@@ -27863,6 +29323,18 @@ export const RecordsApiFactory = function (configuration?: Configuration, basePa
27863
29323
  deleteRelation(fromUuid: string, relationName: string, toUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseString> {
27864
29324
  return localVarFp.deleteRelation(fromUuid, relationName, toUuid, options).then((request) => request(axios, basePath));
27865
29325
  },
29326
+ /**
29327
+ * 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.
29328
+ * @summary Ensure a relation without changing an existing edge
29329
+ * @param {string} fromUuid
29330
+ * @param {string} relationName
29331
+ * @param {string} toUuid
29332
+ * @param {*} [options] Override http request option.
29333
+ * @throws {RequiredError}
29334
+ */
29335
+ ensure(fromUuid: string, relationName: string, toUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseEnsureRelationDTO> {
29336
+ return localVarFp.ensure(fromUuid, relationName, toUuid, options).then((request) => request(axios, basePath));
29337
+ },
27866
29338
  /**
27867
29339
  * 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.
27868
29340
  * @summary Extend a record
@@ -28142,6 +29614,17 @@ export class RecordsApi extends BaseAPI {
28142
29614
  return RecordsApiFp(this.configuration).bulkEdit(objectName, bulkEditRecordsRequest, ignoreErrors, options).then((request) => request(this.axios, this.basePath));
28143
29615
  }
28144
29616
 
29617
+ /**
29618
+ * 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.
29619
+ * @summary Inspect bounded record relation operations
29620
+ * @param {RelationCapabilityRequest} relationCapabilityRequest
29621
+ * @param {*} [options] Override http request option.
29622
+ * @throws {RequiredError}
29623
+ */
29624
+ public capabilities(relationCapabilityRequest: RelationCapabilityRequest, options?: RawAxiosRequestConfig) {
29625
+ return RecordsApiFp(this.configuration).capabilities(relationCapabilityRequest, options).then((request) => request(this.axios, this.basePath));
29626
+ }
29627
+
28145
29628
  /**
28146
29629
  * 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.
28147
29630
  * @summary Create a new record
@@ -28200,6 +29683,19 @@ export class RecordsApi extends BaseAPI {
28200
29683
  return RecordsApiFp(this.configuration).deleteRelation(fromUuid, relationName, toUuid, options).then((request) => request(this.axios, this.basePath));
28201
29684
  }
28202
29685
 
29686
+ /**
29687
+ * 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.
29688
+ * @summary Ensure a relation without changing an existing edge
29689
+ * @param {string} fromUuid
29690
+ * @param {string} relationName
29691
+ * @param {string} toUuid
29692
+ * @param {*} [options] Override http request option.
29693
+ * @throws {RequiredError}
29694
+ */
29695
+ public ensure(fromUuid: string, relationName: string, toUuid: string, options?: RawAxiosRequestConfig) {
29696
+ return RecordsApiFp(this.configuration).ensure(fromUuid, relationName, toUuid, options).then((request) => request(this.axios, this.basePath));
29697
+ }
29698
+
28203
29699
  /**
28204
29700
  * 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.
28205
29701
  * @summary Extend a record
@@ -33929,6 +35425,49 @@ export const WebpagesApiAxiosParamCreator = function (configuration?: Configurat
33929
35425
  options: localVarRequestOptions,
33930
35426
  };
33931
35427
  },
35428
+ /**
35429
+ * 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.
35430
+ * @summary Get authorized webpage editor defaults
35431
+ * @param {string} uuid
35432
+ * @param {string} [environment]
35433
+ * @param {*} [options] Override http request option.
35434
+ * @throws {RequiredError}
35435
+ */
35436
+ page: async (uuid: string, environment?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
35437
+ // verify required parameter 'uuid' is not null or undefined
35438
+ assertParamExists('page', 'uuid', uuid)
35439
+ const localVarPath = `/api/v2/webpages/{uuid}/editor-defaults`
35440
+ .replace('{uuid}', encodeURIComponent(String(uuid)));
35441
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
35442
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
35443
+ let baseOptions;
35444
+ if (configuration) {
35445
+ baseOptions = configuration.baseOptions;
35446
+ }
35447
+
35448
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
35449
+ const localVarHeaderParameter = {} as any;
35450
+ const localVarQueryParameter = {} as any;
35451
+
35452
+ // authentication bearerAuth required
35453
+ // http bearer authentication required
35454
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
35455
+
35456
+ if (environment !== undefined) {
35457
+ localVarQueryParameter['environment'] = environment;
35458
+ }
35459
+
35460
+ localVarHeaderParameter['Accept'] = 'application/json';
35461
+
35462
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
35463
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
35464
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
35465
+
35466
+ return {
35467
+ url: toPathString(localVarUrlObj),
35468
+ options: localVarRequestOptions,
35469
+ };
35470
+ },
33932
35471
  /**
33933
35472
  * Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
33934
35473
  * @summary Public URL for a library file
@@ -34145,6 +35684,48 @@ export const WebpagesApiAxiosParamCreator = function (configuration?: Configurat
34145
35684
  options: localVarRequestOptions,
34146
35685
  };
34147
35686
  },
35687
+ /**
35688
+ * 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.
35689
+ * @summary Get authorized template editor defaults
35690
+ * @param {string} objectName
35691
+ * @param {string} environment
35692
+ * @param {*} [options] Override http request option.
35693
+ * @throws {RequiredError}
35694
+ */
35695
+ template: async (objectName: string, environment: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
35696
+ // verify required parameter 'objectName' is not null or undefined
35697
+ assertParamExists('template', 'objectName', objectName)
35698
+ // verify required parameter 'environment' is not null or undefined
35699
+ assertParamExists('template', 'environment', environment)
35700
+ const localVarPath = `/api/v2/webpages/template/{objectName}/{environment}/editor-defaults`
35701
+ .replace('{objectName}', encodeURIComponent(String(objectName)))
35702
+ .replace('{environment}', encodeURIComponent(String(environment)));
35703
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
35704
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
35705
+ let baseOptions;
35706
+ if (configuration) {
35707
+ baseOptions = configuration.baseOptions;
35708
+ }
35709
+
35710
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
35711
+ const localVarHeaderParameter = {} as any;
35712
+ const localVarQueryParameter = {} as any;
35713
+
35714
+ // authentication bearerAuth required
35715
+ // http bearer authentication required
35716
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
35717
+
35718
+ localVarHeaderParameter['Accept'] = 'application/json';
35719
+
35720
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
35721
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
35722
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
35723
+
35724
+ return {
35725
+ url: toPathString(localVarUrlObj),
35726
+ options: localVarRequestOptions,
35727
+ };
35728
+ },
34148
35729
  /**
34149
35730
  * Validates password and returns a short-lived access token.
34150
35731
  * @summary Unlock password-protected webpage
@@ -34810,6 +36391,20 @@ export const WebpagesApiFp = function(configuration?: Configuration) {
34810
36391
  const localVarOperationServerBasePath = operationServerMap['WebpagesApi.listProtectionGrants']?.[localVarOperationServerIndex]?.url;
34811
36392
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
34812
36393
  },
36394
+ /**
36395
+ * 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.
36396
+ * @summary Get authorized webpage editor defaults
36397
+ * @param {string} uuid
36398
+ * @param {string} [environment]
36399
+ * @param {*} [options] Override http request option.
36400
+ * @throws {RequiredError}
36401
+ */
36402
+ async page(uuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseWebpageEditorDefaultsDTO>> {
36403
+ const localVarAxiosArgs = await localVarAxiosParamCreator.page(uuid, environment, options);
36404
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
36405
+ const localVarOperationServerBasePath = operationServerMap['WebpagesApi.page']?.[localVarOperationServerIndex]?.url;
36406
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
36407
+ },
34813
36408
  /**
34814
36409
  * Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
34815
36410
  * @summary Public URL for a library file
@@ -34880,6 +36475,20 @@ export const WebpagesApiFp = function(configuration?: Configuration) {
34880
36475
  const localVarOperationServerBasePath = operationServerMap['WebpagesApi.revokeProtectionGrant']?.[localVarOperationServerIndex]?.url;
34881
36476
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
34882
36477
  },
36478
+ /**
36479
+ * 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.
36480
+ * @summary Get authorized template editor defaults
36481
+ * @param {string} objectName
36482
+ * @param {string} environment
36483
+ * @param {*} [options] Override http request option.
36484
+ * @throws {RequiredError}
36485
+ */
36486
+ async template(objectName: string, environment: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseWebpageEditorDefaultsDTO>> {
36487
+ const localVarAxiosArgs = await localVarAxiosParamCreator.template(objectName, environment, options);
36488
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
36489
+ const localVarOperationServerBasePath = operationServerMap['WebpagesApi.template']?.[localVarOperationServerIndex]?.url;
36490
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
36491
+ },
34883
36492
  /**
34884
36493
  * Validates password and returns a short-lived access token.
34885
36494
  * @summary Unlock password-protected webpage
@@ -35302,6 +36911,17 @@ export const WebpagesApiFactory = function (configuration?: Configuration, baseP
35302
36911
  listProtectionGrants(uuid: string, environment?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaginationResponseWebpageAccessGrantDTO> {
35303
36912
  return localVarFp.listProtectionGrants(uuid, environment, options).then((request) => request(axios, basePath));
35304
36913
  },
36914
+ /**
36915
+ * 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.
36916
+ * @summary Get authorized webpage editor defaults
36917
+ * @param {string} uuid
36918
+ * @param {string} [environment]
36919
+ * @param {*} [options] Override http request option.
36920
+ * @throws {RequiredError}
36921
+ */
36922
+ page(uuid: string, environment?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseWebpageEditorDefaultsDTO> {
36923
+ return localVarFp.page(uuid, environment, options).then((request) => request(axios, basePath));
36924
+ },
35305
36925
  /**
35306
36926
  * Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
35307
36927
  * @summary Public URL for a library file
@@ -35357,6 +36977,17 @@ export const WebpagesApiFactory = function (configuration?: Configuration, baseP
35357
36977
  revokeProtectionGrant(uuid: string, grantUuid: string, environment?: string, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseString> {
35358
36978
  return localVarFp.revokeProtectionGrant(uuid, grantUuid, environment, options).then((request) => request(axios, basePath));
35359
36979
  },
36980
+ /**
36981
+ * 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.
36982
+ * @summary Get authorized template editor defaults
36983
+ * @param {string} objectName
36984
+ * @param {string} environment
36985
+ * @param {*} [options] Override http request option.
36986
+ * @throws {RequiredError}
36987
+ */
36988
+ template(objectName: string, environment: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseWebpageEditorDefaultsDTO> {
36989
+ return localVarFp.template(objectName, environment, options).then((request) => request(axios, basePath));
36990
+ },
35360
36991
  /**
35361
36992
  * Validates password and returns a short-lived access token.
35362
36993
  * @summary Unlock password-protected webpage
@@ -35789,6 +37420,18 @@ export class WebpagesApi extends BaseAPI {
35789
37420
  return WebpagesApiFp(this.configuration).listProtectionGrants(uuid, environment, options).then((request) => request(this.axios, this.basePath));
35790
37421
  }
35791
37422
 
37423
+ /**
37424
+ * 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.
37425
+ * @summary Get authorized webpage editor defaults
37426
+ * @param {string} uuid
37427
+ * @param {string} [environment]
37428
+ * @param {*} [options] Override http request option.
37429
+ * @throws {RequiredError}
37430
+ */
37431
+ public page(uuid: string, environment?: string, options?: RawAxiosRequestConfig) {
37432
+ return WebpagesApiFp(this.configuration).page(uuid, environment, options).then((request) => request(this.axios, this.basePath));
37433
+ }
37434
+
35792
37435
  /**
35793
37436
  * Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
35794
37437
  * @summary Public URL for a library file
@@ -35849,6 +37492,18 @@ export class WebpagesApi extends BaseAPI {
35849
37492
  return WebpagesApiFp(this.configuration).revokeProtectionGrant(uuid, grantUuid, environment, options).then((request) => request(this.axios, this.basePath));
35850
37493
  }
35851
37494
 
37495
+ /**
37496
+ * 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.
37497
+ * @summary Get authorized template editor defaults
37498
+ * @param {string} objectName
37499
+ * @param {string} environment
37500
+ * @param {*} [options] Override http request option.
37501
+ * @throws {RequiredError}
37502
+ */
37503
+ public template(objectName: string, environment: string, options?: RawAxiosRequestConfig) {
37504
+ return WebpagesApiFp(this.configuration).template(objectName, environment, options).then((request) => request(this.axios, this.basePath));
37505
+ }
37506
+
35852
37507
  /**
35853
37508
  * Validates password and returns a short-lived access token.
35854
37509
  * @summary Unlock password-protected webpage