@evergis/api 5.0.36 → 5.0.38

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.
@@ -1,5 +1,5 @@
1
1
  import { Service } from './Service';
2
- import { GetConfigurationParams, GetConfigurationsListParams, PagedListConfigDc, RemoveConfigurationParams, SetConfigurationParams, SetConfigurationPayload } from './data-contracts';
2
+ import { ConfigOverrideDc, ConfigOverrideViewDc, GetConfigurationOverridesParams, GetConfigurationParams, GetConfigurationsListParams, PagedListConfigDc, RemoveConfigurationOverrideParams, RemoveConfigurationOverridesBatchParams, RemoveConfigurationOverridesBatchPayload, RemoveConfigurationParams, SetConfigurationOverrideParams, SetConfigurationOverridesBatchParams, SetConfigurationOverridesBatchPayload, SetConfigurationParams, SetConfigurationPayload } from './data-contracts';
3
3
  /**
4
4
  * @title Spatial Processing Gateway API
5
5
  * @version 1.5.1.0
@@ -24,23 +24,24 @@ export declare class ClientSettingsService extends Service {
24
24
  * @tags ClientSettings
25
25
  * @name GetConfiguration
26
26
  * @operationId ClientSettingsController_GetConfiguration
27
- * @summary Get config for urlPath.
27
+ * @summary Get config for urlPath, with the current user's role overrides applied.
28
28
  * @request GET:/settings
29
29
  * @secure
30
30
  * @response `200` OK
31
31
  */
32
32
  getConfiguration(query: GetConfigurationParams): Promise<string>;
33
33
  /**
34
- * No description
35
- *
36
- * @tags ClientSettings
37
- * @name SetConfiguration
38
- * @operationId ClientSettingsController_SetConfiguration
39
- * @summary Set config for urlPath.
40
- * @request POST:/settings
41
- * @secure
42
- * @response `200` OK
43
- */
34
+ * No description
35
+ *
36
+ * @tags ClientSettings
37
+ * @name SetConfiguration
38
+ * @operationId ClientSettingsController_SetConfiguration
39
+ * @summary Set config for urlPath. This is an idempotent upsert keyed by urlPath,
40
+ so `PUT` is the correct verb; `POST` is kept alongside it for existing clients.
41
+ * @request POST:/settings
42
+ * @secure
43
+ * @response `200` OK
44
+ */
44
45
  setConfiguration(query: SetConfigurationParams, data: SetConfigurationPayload): Promise<void>;
45
46
  /**
46
47
  * No description
@@ -54,4 +55,65 @@ export declare class ClientSettingsService extends Service {
54
55
  * @response `200` OK
55
56
  */
56
57
  removeConfiguration(query: RemoveConfigurationParams): Promise<void>;
58
+ /**
59
+ * No description
60
+ *
61
+ * @tags ClientSettings
62
+ * @name GetConfigurationOverrides
63
+ * @operationId ClientSettingsController_GetConfigurationOverrides
64
+ * @summary Get overrides of a configuration. A superuser sees every role; other users see only their own.
65
+ * @request GET:/settings/overrides
66
+ * @secure
67
+ * @response `200` OK
68
+ */
69
+ getConfigurationOverrides(query: GetConfigurationOverridesParams): Promise<ConfigOverrideViewDc[]>;
70
+ /**
71
+ * No description
72
+ *
73
+ * @tags ClientSettings
74
+ * @name SetConfigurationOverride
75
+ * @operationId ClientSettingsController_SetConfigurationOverride
76
+ * @summary Create or update an override for a single configuration element.
77
+ * @request PUT:/settings/overrides
78
+ * @secure
79
+ * @response `200` OK
80
+ */
81
+ setConfigurationOverride(query: SetConfigurationOverrideParams, data: ConfigOverrideDc): Promise<void>;
82
+ /**
83
+ * No description
84
+ *
85
+ * @tags ClientSettings
86
+ * @name RemoveConfigurationOverride
87
+ * @operationId ClientSettingsController_RemoveConfigurationOverride
88
+ * @summary Remove an override of a single configuration element.
89
+ * @request DELETE:/settings/overrides
90
+ * @secure
91
+ * @response `200` OK
92
+ */
93
+ removeConfigurationOverride(query: RemoveConfigurationOverrideParams): Promise<void>;
94
+ /**
95
+ * No description
96
+ *
97
+ * @tags ClientSettings
98
+ * @name SetConfigurationOverridesBatch
99
+ * @operationId ClientSettingsController_SetConfigurationOverridesBatch
100
+ * @summary Create or update several overrides of one configuration in a single transaction (all or none).
101
+ * @request PUT:/settings/overrides/batch
102
+ * @secure
103
+ * @response `200` OK
104
+ */
105
+ setConfigurationOverridesBatch(query: SetConfigurationOverridesBatchParams, data: SetConfigurationOverridesBatchPayload): Promise<void>;
106
+ /**
107
+ * No description
108
+ *
109
+ * @tags ClientSettings
110
+ * @name RemoveConfigurationOverridesBatch
111
+ * @operationId ClientSettingsController_RemoveConfigurationOverridesBatch
112
+ * @summary Remove several overrides of one configuration in a single transaction. Idempotent: keys that no
113
+ longer exist are skipped. Uses POST because a request body is required.
114
+ * @request POST:/settings/overrides/batch-delete
115
+ * @secure
116
+ * @response `200` OK
117
+ */
118
+ removeConfigurationOverridesBatch(query: RemoveConfigurationOverridesBatchParams, data: RemoveConfigurationOverridesBatchPayload): Promise<void>;
57
119
  }
@@ -124,8 +124,6 @@ export interface AttributeConfigurationDc {
124
124
  * @minLength 1
125
125
  */
126
126
  attributeName: string;
127
- /** The name of the column in the data table that holds the attribute values. */
128
- columnName?: string;
129
127
  /** Human-friendly name for the attribute. */
130
128
  alias?: string;
131
129
  /** Description for the attribute. */
@@ -135,22 +133,13 @@ export interface AttributeConfigurationDc {
135
133
  * @default true
136
134
  */
137
135
  isEditable?: boolean;
138
- /**
139
- * If false, attribute will not be returned in feature query.
140
- * @default true
141
- */
142
- isDisplayed?: boolean;
143
136
  /** Client data storage. Storage isn't used by server. */
144
137
  clientData?: any;
145
- /** Id of table given attribute is referenced. */
146
- referenceId?: string;
147
- /** A set of layer references. */
148
- layerReferenceId?: string[];
149
- attributeSelectorType?: AttributeSelectorType;
150
138
  /** Sets attribute format settings. */
151
139
  stringFormat?: AttributeFormatConfigurationDc;
152
140
  /** Information about an attribute icon. */
153
141
  icon?: AttributeIconDc;
142
+ aggregation?: AggregationFunction;
154
143
  }
155
144
  /**
156
145
  * Attribute configuration type.
@@ -256,12 +245,6 @@ export declare enum AttributeIconType {
256
245
  PNG = "PNG",
257
246
  SVG = "SVG"
258
247
  }
259
- export declare enum AttributeSelectorType {
260
- None = "None",
261
- SelectFromHandBook = "SelectFromHandBook",
262
- SelectFromRange = "SelectFromRange",
263
- ViewHandBook = "ViewHandBook"
264
- }
265
248
  export declare enum AttributeType {
266
249
  Unknown = "Unknown",
267
250
  String = "String",
@@ -383,7 +366,18 @@ export type CalculatedAttributeConfigurationDc = AttributeConfigurationDc & {
383
366
  attributeConfigurationType?: AttributeConfigurationType;
384
367
  /** String condition. */
385
368
  expression?: string | null;
386
- aggregation?: AggregationFunction;
369
+ geometryType?: OgcGeometryType;
370
+ /**
371
+ * Spatial reference identifier type in geometry type column.
372
+ * @format int32
373
+ */
374
+ srId?: number | null;
375
+ /**
376
+ * Size of H3 index grid.
377
+ * @format float
378
+ */
379
+ cellSize?: number | null;
380
+ subType?: StringSubType;
387
381
  };
388
382
  /**
389
383
  * Base class for catalog configuration responses.
@@ -544,6 +538,105 @@ export interface ConfigDc {
544
538
  /** Gets or sets config url path. */
545
539
  urlPath?: string;
546
540
  }
541
+ /**
542
+ * Kind of change an override applies to a configuration element (RFC 6902 semantics).
543
+ */
544
+ export declare enum ConfigOperationType {
545
+ Replace = "Replace",
546
+ Remove = "Remove",
547
+ Add = "Add"
548
+ }
549
+ /**
550
+ * One override in a batch upsert. The configuration is shared for the whole batch (query parameter),
551
+ so each item carries the element path, the target role, and the override content.
552
+ */
553
+ export interface ConfigOverrideBatchItemDc {
554
+ /**
555
+ * Gets or sets the path of the element to override, relative to the configuration root.
556
+ * @minLength 1
557
+ */
558
+ configPath: string;
559
+ /**
560
+ * Gets or sets the target role. Omit to address the current user's own role; naming a role
561
+ * requires superuser access.
562
+ */
563
+ role?: string;
564
+ /** Kind of change an override applies to a configuration element (RFC 6902 semantics). */
565
+ operationType?: ConfigOperationType;
566
+ /** Gets or sets the new value. Required except for SPCore.Modules.ClientSettings.Data.ConfigOperationType.Remove. */
567
+ value?: any;
568
+ /** Gets or sets an optional authoring note. */
569
+ description?: string;
570
+ /**
571
+ * Gets or sets the apply order; the highest priority wins on a shared path.
572
+ * @format int32
573
+ */
574
+ priority?: number;
575
+ }
576
+ /**
577
+ * Body of a request that stores an override. The element being overridden and the target role are
578
+ passed as query parameters, so this contract carries only the override's content.
579
+ */
580
+ export interface ConfigOverrideDc {
581
+ /** Kind of change an override applies to a configuration element (RFC 6902 semantics). */
582
+ operationType?: ConfigOperationType;
583
+ /**
584
+ * Gets or sets the new value. Required except for SPCore.Modules.ClientSettings.Data.ConfigOperationType.Remove.
585
+ * A Newtonsoft.Json.Linq.JToken so the value may be an object, array, or scalar (for example a boolean
586
+ * for `items/0/active` or a string for `defaultProject`).
587
+ */
588
+ value?: any;
589
+ /** Gets or sets an optional authoring note. */
590
+ description?: string;
591
+ /**
592
+ * Gets or sets the apply order; the highest priority wins on a shared path.
593
+ * @format int32
594
+ */
595
+ priority?: number;
596
+ }
597
+ /**
598
+ * Identifies one override to delete in a batch. The configuration is shared for the whole batch
599
+ (query parameter), so each key carries only the element path and the target role.
600
+ */
601
+ export interface ConfigOverrideDeleteKeyDc {
602
+ /**
603
+ * Gets or sets the path of the overridden element, relative to the configuration root.
604
+ * @minLength 1
605
+ */
606
+ configPath: string;
607
+ /**
608
+ * Gets or sets the target role. Omit to address the current user's own role; naming a role
609
+ * requires superuser access.
610
+ */
611
+ role?: string;
612
+ }
613
+ /**
614
+ * An override as shown in the administration UI.
615
+ */
616
+ export interface ConfigOverrideViewDc {
617
+ /**
618
+ * Gets the apply order; the highest priority wins on a shared path.
619
+ * @format int32
620
+ */
621
+ priority?: number;
622
+ /** Gets the URL path of the configuration. */
623
+ urlPath?: string;
624
+ /** Gets the path of the overridden element. */
625
+ configPath?: string;
626
+ /** Gets the authoring note, if any. */
627
+ description?: string;
628
+ /** Gets the role the override applies to. */
629
+ userRole?: string;
630
+ /** Kind of change an override applies to a configuration element (RFC 6902 semantics). */
631
+ configOperationType?: ConfigOperationType;
632
+ /**
633
+ * Gets the value applied by the override; null for
634
+ * SPCore.Modules.ClientSettings.Data.ConfigOperationType.Remove.
635
+ */
636
+ value?: any;
637
+ /** Gets or sets a value indicating whether the current user may change this override. */
638
+ canEdit?: boolean;
639
+ }
547
640
  export declare enum ConflictResolutionStrategy {
548
641
  Skip = "Skip",
549
642
  Overwrite = "Overwrite",
@@ -4456,6 +4549,11 @@ export interface GetConfigurationsListParams {
4456
4549
  export interface GetConfigurationParams {
4457
4550
  /** URL path. */
4458
4551
  urlPath: string;
4552
+ /**
4553
+ * When true, returns the base configuration without applying role overrides. Superuser only.
4554
+ * @default false
4555
+ */
4556
+ raw?: boolean;
4459
4557
  }
4460
4558
  export type SetConfigurationPayload = any;
4461
4559
  export interface SetConfigurationParams {
@@ -4468,6 +4566,44 @@ export interface RemoveConfigurationParams {
4468
4566
  /** URL path. */
4469
4567
  urlPath: string;
4470
4568
  }
4569
+ export interface GetConfigurationOverridesParams {
4570
+ /** URL path of the configuration. */
4571
+ urlPath: string;
4572
+ /** Optional prefix to filter overrides by configuration path. */
4573
+ configPathFilter?: string;
4574
+ }
4575
+ export interface SetConfigurationOverrideParams {
4576
+ /** Gets or sets the URL path of the configuration. */
4577
+ UrlPath: string;
4578
+ /** Gets or sets the path of the element, relative to the configuration root. */
4579
+ ConfigPath: string;
4580
+ /**
4581
+ * Gets or sets the target role. Omit to address the current user's own role;
4582
+ * naming a role requires superuser access.
4583
+ */
4584
+ Role?: string;
4585
+ }
4586
+ export interface RemoveConfigurationOverrideParams {
4587
+ /** Gets or sets the URL path of the configuration. */
4588
+ UrlPath: string;
4589
+ /** Gets or sets the path of the element, relative to the configuration root. */
4590
+ ConfigPath: string;
4591
+ /**
4592
+ * Gets or sets the target role. Omit to address the current user's own role;
4593
+ * naming a role requires superuser access.
4594
+ */
4595
+ Role?: string;
4596
+ }
4597
+ export type SetConfigurationOverridesBatchPayload = ConfigOverrideBatchItemDc[];
4598
+ export interface SetConfigurationOverridesBatchParams {
4599
+ /** URL path of the configuration. */
4600
+ urlPath: string;
4601
+ }
4602
+ export type RemoveConfigurationOverridesBatchPayload = ConfigOverrideDeleteKeyDc[];
4603
+ export interface RemoveConfigurationOverridesBatchParams {
4604
+ /** URL path of the configuration. */
4605
+ urlPath: string;
4606
+ }
4471
4607
  export interface GetDataSourcesListParams {
4472
4608
  /** Owner. */
4473
4609
  owner?: string;
package/dist/api.esm.js CHANGED
@@ -1317,7 +1317,7 @@ class ClientSettingsService extends Service {
1317
1317
  * @tags ClientSettings
1318
1318
  * @name GetConfiguration
1319
1319
  * @operationId ClientSettingsController_GetConfiguration
1320
- * @summary Get config for urlPath.
1320
+ * @summary Get config for urlPath, with the current user's role overrides applied.
1321
1321
  * @request GET:/settings
1322
1322
  * @secure
1323
1323
  * @response `200` OK
@@ -1326,16 +1326,17 @@ class ClientSettingsService extends Service {
1326
1326
  return this.http.get(`/settings`, query).text();
1327
1327
  }
1328
1328
  /**
1329
- * No description
1330
- *
1331
- * @tags ClientSettings
1332
- * @name SetConfiguration
1333
- * @operationId ClientSettingsController_SetConfiguration
1334
- * @summary Set config for urlPath.
1335
- * @request POST:/settings
1336
- * @secure
1337
- * @response `200` OK
1338
- */
1329
+ * No description
1330
+ *
1331
+ * @tags ClientSettings
1332
+ * @name SetConfiguration
1333
+ * @operationId ClientSettingsController_SetConfiguration
1334
+ * @summary Set config for urlPath. This is an idempotent upsert keyed by urlPath,
1335
+ so `PUT` is the correct verb; `POST` is kept alongside it for existing clients.
1336
+ * @request POST:/settings
1337
+ * @secure
1338
+ * @response `200` OK
1339
+ */
1339
1340
  setConfiguration(query, data) {
1340
1341
  return this.http.post(`/settings`, data, query).then(() => { });
1341
1342
  }
@@ -1353,6 +1354,77 @@ class ClientSettingsService extends Service {
1353
1354
  removeConfiguration(query) {
1354
1355
  return this.http.delete(`/settings`, null, query).then(() => { });
1355
1356
  }
1357
+ /**
1358
+ * No description
1359
+ *
1360
+ * @tags ClientSettings
1361
+ * @name GetConfigurationOverrides
1362
+ * @operationId ClientSettingsController_GetConfigurationOverrides
1363
+ * @summary Get overrides of a configuration. A superuser sees every role; other users see only their own.
1364
+ * @request GET:/settings/overrides
1365
+ * @secure
1366
+ * @response `200` OK
1367
+ */
1368
+ getConfigurationOverrides(query) {
1369
+ return this.http.get(`/settings/overrides`, query).json();
1370
+ }
1371
+ /**
1372
+ * No description
1373
+ *
1374
+ * @tags ClientSettings
1375
+ * @name SetConfigurationOverride
1376
+ * @operationId ClientSettingsController_SetConfigurationOverride
1377
+ * @summary Create or update an override for a single configuration element.
1378
+ * @request PUT:/settings/overrides
1379
+ * @secure
1380
+ * @response `200` OK
1381
+ */
1382
+ setConfigurationOverride(query, data) {
1383
+ return this.http.put(`/settings/overrides`, data, query).then(() => { });
1384
+ }
1385
+ /**
1386
+ * No description
1387
+ *
1388
+ * @tags ClientSettings
1389
+ * @name RemoveConfigurationOverride
1390
+ * @operationId ClientSettingsController_RemoveConfigurationOverride
1391
+ * @summary Remove an override of a single configuration element.
1392
+ * @request DELETE:/settings/overrides
1393
+ * @secure
1394
+ * @response `200` OK
1395
+ */
1396
+ removeConfigurationOverride(query) {
1397
+ return this.http.delete(`/settings/overrides`, null, query).then(() => { });
1398
+ }
1399
+ /**
1400
+ * No description
1401
+ *
1402
+ * @tags ClientSettings
1403
+ * @name SetConfigurationOverridesBatch
1404
+ * @operationId ClientSettingsController_SetConfigurationOverridesBatch
1405
+ * @summary Create or update several overrides of one configuration in a single transaction (all or none).
1406
+ * @request PUT:/settings/overrides/batch
1407
+ * @secure
1408
+ * @response `200` OK
1409
+ */
1410
+ setConfigurationOverridesBatch(query, data) {
1411
+ return this.http.put(`/settings/overrides/batch`, data, query).then(() => { });
1412
+ }
1413
+ /**
1414
+ * No description
1415
+ *
1416
+ * @tags ClientSettings
1417
+ * @name RemoveConfigurationOverridesBatch
1418
+ * @operationId ClientSettingsController_RemoveConfigurationOverridesBatch
1419
+ * @summary Remove several overrides of one configuration in a single transaction. Idempotent: keys that no
1420
+ longer exist are skipped. Uses POST because a request body is required.
1421
+ * @request POST:/settings/overrides/batch-delete
1422
+ * @secure
1423
+ * @response `200` OK
1424
+ */
1425
+ removeConfigurationOverridesBatch(query, data) {
1426
+ return this.http.post(`/settings/overrides/batch-delete`, data, query).then(() => { });
1427
+ }
1356
1428
  }
1357
1429
 
1358
1430
  class ClientSettings extends ClientSettingsService {
@@ -3152,13 +3224,6 @@ var AttributeIconType;
3152
3224
  AttributeIconType["PNG"] = "PNG";
3153
3225
  AttributeIconType["SVG"] = "SVG";
3154
3226
  })(AttributeIconType || (AttributeIconType = {}));
3155
- var AttributeSelectorType;
3156
- (function (AttributeSelectorType) {
3157
- AttributeSelectorType["None"] = "None";
3158
- AttributeSelectorType["SelectFromHandBook"] = "SelectFromHandBook";
3159
- AttributeSelectorType["SelectFromRange"] = "SelectFromRange";
3160
- AttributeSelectorType["ViewHandBook"] = "ViewHandBook";
3161
- })(AttributeSelectorType || (AttributeSelectorType = {}));
3162
3227
  var AttributeType;
3163
3228
  (function (AttributeType) {
3164
3229
  AttributeType["Unknown"] = "Unknown";
@@ -3210,6 +3275,15 @@ var ClassifyAttributeType;
3210
3275
  ClassifyAttributeType["DateTime"] = "dateTime";
3211
3276
  ClassifyAttributeType["Text"] = "text";
3212
3277
  })(ClassifyAttributeType || (ClassifyAttributeType = {}));
3278
+ /**
3279
+ * Kind of change an override applies to a configuration element (RFC 6902 semantics).
3280
+ */
3281
+ var ConfigOperationType;
3282
+ (function (ConfigOperationType) {
3283
+ ConfigOperationType["Replace"] = "Replace";
3284
+ ConfigOperationType["Remove"] = "Remove";
3285
+ ConfigOperationType["Add"] = "Add";
3286
+ })(ConfigOperationType || (ConfigOperationType = {}));
3213
3287
  var ConflictResolutionStrategy;
3214
3288
  (function (ConflictResolutionStrategy) {
3215
3289
  ConflictResolutionStrategy["Skip"] = "Skip";
@@ -5171,5 +5245,5 @@ class VectorTileService extends Service {
5171
5245
  class VectorTiles extends VectorTileService {
5172
5246
  }
5173
5247
 
5174
- export { AccessMode, Account, AccountPreview, AggregationFunction, Api, ApiEvent, AttributeConfigurationType, AttributeIconType, AttributeSelectorType, AttributeType, AuthorizationGrant, BulkOperations, CatalogResourceType, CatalogShare, ClassificationType, ClassifyAttributeType, ClientSettings, ConflictResolutionStrategy, DataSourceConnectionType, DataSourceType, DependencyType, Eql, ErrorDetailsType, ErrorReason, External, Feedback, FileUpload, Filters, GEOCODE_PROVIDER, Geocode, History, HttpClient, Import, LayerServiceType, Layers, Names, OgcGeometryType, PbfSchema, Permissions, PolicyType, PortalSettings, Projects, RemoteTaskManager, RemoteTaskStatus, ResourceSeparator, ResourceSubTypeFilter, ResourceType, ResourceTypeFilter, Resources, ResponseType, STORAGE_REFRESH_TOKEN_KEY, STORAGE_TOKEN_KEY, Security, ShareInvitationStatus, SimplifyType, Statistic, StringSubType, TableConfigurationType, Tables, TaskResourceSubType, Tools, UrlPath, VectorTiles, WorkerMethodType, WorkerSettingsFieldType, addSubDomainToLocation, errorHandler, formDataFromFile, generateId, getFetchingUrlPath, isHTTPError, isHandledError, isProjectContentItems, isString, isTileLayerService, parseJwt, promiseAllIgnoreErrors, stripUselessSlashes, toFormData, unique, useToken };
5248
+ export { AccessMode, Account, AccountPreview, AggregationFunction, Api, ApiEvent, AttributeConfigurationType, AttributeIconType, AttributeType, AuthorizationGrant, BulkOperations, CatalogResourceType, CatalogShare, ClassificationType, ClassifyAttributeType, ClientSettings, ConfigOperationType, ConflictResolutionStrategy, DataSourceConnectionType, DataSourceType, DependencyType, Eql, ErrorDetailsType, ErrorReason, External, Feedback, FileUpload, Filters, GEOCODE_PROVIDER, Geocode, History, HttpClient, Import, LayerServiceType, Layers, Names, OgcGeometryType, PbfSchema, Permissions, PolicyType, PortalSettings, Projects, RemoteTaskManager, RemoteTaskStatus, ResourceSeparator, ResourceSubTypeFilter, ResourceType, ResourceTypeFilter, Resources, ResponseType, STORAGE_REFRESH_TOKEN_KEY, STORAGE_TOKEN_KEY, Security, ShareInvitationStatus, SimplifyType, Statistic, StringSubType, TableConfigurationType, Tables, TaskResourceSubType, Tools, UrlPath, VectorTiles, WorkerMethodType, WorkerSettingsFieldType, addSubDomainToLocation, errorHandler, formDataFromFile, generateId, getFetchingUrlPath, isHTTPError, isHandledError, isProjectContentItems, isString, isTileLayerService, parseJwt, promiseAllIgnoreErrors, stripUselessSlashes, toFormData, unique, useToken };
5175
5249
  //# sourceMappingURL=api.esm.js.map