@targetprocess/shared-data-model-client 0.21.0 → 0.24.0

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.
@@ -3,6 +3,7 @@ import { type AttachmentsRequestBuilder } from './attachments/index.js';
3
3
  import { type WithEntityTypeItemRequestBuilder } from './item/index.js';
4
4
  import { type MentionsRequestBuilder } from './mentions/index.js';
5
5
  import { type SchemaRequestBuilder } from './schema/index.js';
6
+ import { type TermsRequestBuilder } from './terms/index.js';
6
7
  import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata } from '@microsoft/kiota-abstractions';
7
8
  /**
8
9
  * Builds and executes requests for operations under /api/sdm
@@ -24,6 +25,10 @@ export interface SdmRequestBuilder extends BaseRequestBuilder<SdmRequestBuilder>
24
25
  * The schema property
25
26
  */
26
27
  get schema(): SchemaRequestBuilder;
28
+ /**
29
+ * The terms property
30
+ */
31
+ get terms(): TermsRequestBuilder;
27
32
  /**
28
33
  * Gets an item from the Tp.api.sdm.item collection
29
34
  * @param entityType Unique identifier of the item
@@ -14,6 +14,8 @@ const index_js_3 = require("./item/index.js");
14
14
  const index_js_4 = require("./mentions/index.js");
15
15
  // @ts-ignore
16
16
  const index_js_5 = require("./schema/index.js");
17
+ // @ts-ignore
18
+ const index_js_6 = require("./terms/index.js");
17
19
  /**
18
20
  * Uri template for the request builder.
19
21
  */
@@ -39,6 +41,9 @@ exports.SdmRequestBuilderNavigationMetadata = {
39
41
  schema: {
40
42
  navigationMetadata: index_js_5.SchemaRequestBuilderNavigationMetadata,
41
43
  },
44
+ terms: {
45
+ requestsMetadata: index_js_6.TermsRequestBuilderRequestsMetadata,
46
+ },
42
47
  };
43
48
  /* tslint:enable */
44
49
  /* eslint-enable */
@@ -0,0 +1,39 @@
1
+ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
2
+ /**
3
+ * Builds and executes requests for operations under /api/sdm/terms
4
+ */
5
+ export interface TermsRequestBuilder extends BaseRequestBuilder<TermsRequestBuilder> {
6
+ /**
7
+ * Gets terms for a given process id.
8
+ * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
9
+ * @throws {HttpValidationProblemDetails} error when the service returns a 400 status code
10
+ * @throws {ProblemDetails} error when the service returns a 401 status code
11
+ * @throws {ProblemDetails} error when the service returns a 404 status code
12
+ * @throws {ProblemDetails} error when the service returns a 409 status code
13
+ * @throws {ProblemDetails} error when the service returns a 500 status code
14
+ */
15
+ get(requestConfiguration?: RequestConfiguration<TermsRequestBuilderGetQueryParameters> | undefined): Promise<void>;
16
+ /**
17
+ * Gets terms for a given process id.
18
+ * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
19
+ * @returns {RequestInformation}
20
+ */
21
+ toGetRequestInformation(requestConfiguration?: RequestConfiguration<TermsRequestBuilderGetQueryParameters> | undefined): RequestInformation;
22
+ }
23
+ /**
24
+ * Gets terms for a given process id.
25
+ */
26
+ export interface TermsRequestBuilderGetQueryParameters {
27
+ /**
28
+ * Id of the process to read terms from. If not set, default process will be returned
29
+ */
30
+ processId?: number;
31
+ }
32
+ /**
33
+ * Uri template for the request builder.
34
+ */
35
+ export declare const TermsRequestBuilderUriTemplate = "{+baseurl}/api/sdm/terms{?processId*}";
36
+ /**
37
+ * Metadata for all the requests in the request builder.
38
+ */
39
+ export declare const TermsRequestBuilderRequestsMetadata: RequestsMetadata;
@@ -0,0 +1,31 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.TermsRequestBuilderRequestsMetadata = exports.TermsRequestBuilderUriTemplate = void 0;
4
+ /* tslint:disable */
5
+ /* eslint-disable */
6
+ // Generated by Microsoft Kiota
7
+ // @ts-ignore
8
+ const index_js_1 = require("../../../models/index.js");
9
+ /**
10
+ * Uri template for the request builder.
11
+ */
12
+ exports.TermsRequestBuilderUriTemplate = "{+baseurl}/api/sdm/terms{?processId*}";
13
+ /**
14
+ * Metadata for all the requests in the request builder.
15
+ */
16
+ exports.TermsRequestBuilderRequestsMetadata = {
17
+ get: {
18
+ uriTemplate: exports.TermsRequestBuilderUriTemplate,
19
+ responseBodyContentType: "application/problem+json",
20
+ errorMappings: {
21
+ 400: index_js_1.createHttpValidationProblemDetailsFromDiscriminatorValue,
22
+ 401: index_js_1.createProblemDetailsFromDiscriminatorValue,
23
+ 404: index_js_1.createProblemDetailsFromDiscriminatorValue,
24
+ 409: index_js_1.createProblemDetailsFromDiscriminatorValue,
25
+ 500: index_js_1.createProblemDetailsFromDiscriminatorValue,
26
+ },
27
+ adapterMethodName: "sendNoResponseContent",
28
+ },
29
+ };
30
+ /* tslint:enable */
31
+ /* eslint-enable */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@targetprocess/shared-data-model-client",
3
- "version": "0.21.0",
3
+ "version": "0.24.0",
4
4
  "description": "",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -12,6 +12,8 @@ import { MentionsRequestBuilderRequestsMetadata, type MentionsRequestBuilder } f
12
12
  // @ts-ignore
13
13
  import { SchemaRequestBuilderNavigationMetadata, type SchemaRequestBuilder } from './schema/index.js';
14
14
  // @ts-ignore
15
+ import { TermsRequestBuilderRequestsMetadata, type TermsRequestBuilder } from './terms/index.js';
16
+ // @ts-ignore
15
17
  import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata } from '@microsoft/kiota-abstractions';
16
18
 
17
19
  /**
@@ -34,6 +36,10 @@ export interface SdmRequestBuilder extends BaseRequestBuilder<SdmRequestBuilder>
34
36
  * The schema property
35
37
  */
36
38
  get schema(): SchemaRequestBuilder;
39
+ /**
40
+ * The terms property
41
+ */
42
+ get terms(): TermsRequestBuilder;
37
43
  /**
38
44
  * Gets an item from the Tp.api.sdm.item collection
39
45
  * @param entityType Unique identifier of the item
@@ -66,6 +72,9 @@ export const SdmRequestBuilderNavigationMetadata: Record<Exclude<keyof SdmReques
66
72
  schema: {
67
73
  navigationMetadata: SchemaRequestBuilderNavigationMetadata,
68
74
  },
75
+ terms: {
76
+ requestsMetadata: TermsRequestBuilderRequestsMetadata,
77
+ },
69
78
  };
70
79
  /* tslint:enable */
71
80
  /* eslint-enable */
@@ -0,0 +1,61 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ // Generated by Microsoft Kiota
4
+ // @ts-ignore
5
+ import { createHttpValidationProblemDetailsFromDiscriminatorValue, createProblemDetailsFromDiscriminatorValue, type HttpValidationProblemDetails, type ProblemDetails } from '../../../models/index.js';
6
+ // @ts-ignore
7
+ import { type BaseRequestBuilder, type Parsable, type ParsableFactory, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
8
+
9
+ /**
10
+ * Builds and executes requests for operations under /api/sdm/terms
11
+ */
12
+ export interface TermsRequestBuilder extends BaseRequestBuilder<TermsRequestBuilder> {
13
+ /**
14
+ * Gets terms for a given process id.
15
+ * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
16
+ * @throws {HttpValidationProblemDetails} error when the service returns a 400 status code
17
+ * @throws {ProblemDetails} error when the service returns a 401 status code
18
+ * @throws {ProblemDetails} error when the service returns a 404 status code
19
+ * @throws {ProblemDetails} error when the service returns a 409 status code
20
+ * @throws {ProblemDetails} error when the service returns a 500 status code
21
+ */
22
+ get(requestConfiguration?: RequestConfiguration<TermsRequestBuilderGetQueryParameters> | undefined) : Promise<void>;
23
+ /**
24
+ * Gets terms for a given process id.
25
+ * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
26
+ * @returns {RequestInformation}
27
+ */
28
+ toGetRequestInformation(requestConfiguration?: RequestConfiguration<TermsRequestBuilderGetQueryParameters> | undefined) : RequestInformation;
29
+ }
30
+ /**
31
+ * Gets terms for a given process id.
32
+ */
33
+ export interface TermsRequestBuilderGetQueryParameters {
34
+ /**
35
+ * Id of the process to read terms from. If not set, default process will be returned
36
+ */
37
+ processId?: number;
38
+ }
39
+ /**
40
+ * Uri template for the request builder.
41
+ */
42
+ export const TermsRequestBuilderUriTemplate = "{+baseurl}/api/sdm/terms{?processId*}";
43
+ /**
44
+ * Metadata for all the requests in the request builder.
45
+ */
46
+ export const TermsRequestBuilderRequestsMetadata: RequestsMetadata = {
47
+ get: {
48
+ uriTemplate: TermsRequestBuilderUriTemplate,
49
+ responseBodyContentType: "application/problem+json",
50
+ errorMappings: {
51
+ 400: createHttpValidationProblemDetailsFromDiscriminatorValue as ParsableFactory<Parsable>,
52
+ 401: createProblemDetailsFromDiscriminatorValue as ParsableFactory<Parsable>,
53
+ 404: createProblemDetailsFromDiscriminatorValue as ParsableFactory<Parsable>,
54
+ 409: createProblemDetailsFromDiscriminatorValue as ParsableFactory<Parsable>,
55
+ 500: createProblemDetailsFromDiscriminatorValue as ParsableFactory<Parsable>,
56
+ },
57
+ adapterMethodName: "sendNoResponseContent",
58
+ },
59
+ };
60
+ /* tslint:enable */
61
+ /* eslint-enable */
@@ -1,5 +1,5 @@
1
1
  {
2
- "descriptionHash": "45D831AC5F90A191E02967C185AC4EDD5AFBEFA9106CA92D0BF436187EAE303D27626E4A2579B35EFDD2F5B5F732497DF3225588CF1752E807C0E1BE0A9441CB",
2
+ "descriptionHash": "FE2CB22F7DF468E7073B9054EB0A6AF65D42498D19BBF93DB197EBC2D1C38C5B33AAA88625A35FC4AD3E3F640318B3ACCF81941ECAA6CD8CF82C2107D77FD61C",
3
3
  "descriptionLocation": "v1.json",
4
4
  "lockFileVersion": "1.0.0",
5
5
  "kiotaVersion": "1.27.0",
package/src/v1.json CHANGED
@@ -6,6 +6,90 @@
6
6
  "version": "v1"
7
7
  },
8
8
  "paths": {
9
+ "/api/sdm/terms": {
10
+ "get": {
11
+ "tags": [
12
+ "Sdm"
13
+ ],
14
+ "summary": "Gets terms for a given process id.",
15
+ "operationId": "TermsEndpoint",
16
+ "parameters": [
17
+ {
18
+ "name": "processId",
19
+ "in": "query",
20
+ "description": "Id of the process to read terms from. If not set, default process will be returned",
21
+ "schema": {
22
+ "type": "integer",
23
+ "format": "int32",
24
+ "nullable": true
25
+ }
26
+ }
27
+ ],
28
+ "responses": {
29
+ "400": {
30
+ "description": "Validation error",
31
+ "content": {
32
+ "application/problem+json": {
33
+ "schema": {
34
+ "$ref": "#/components/schemas/HttpValidationProblemDetails"
35
+ }
36
+ }
37
+ }
38
+ },
39
+ "401": {
40
+ "description": "Unauthorized",
41
+ "content": {
42
+ "application/problem+json": {
43
+ "schema": {
44
+ "$ref": "#/components/schemas/ProblemDetails"
45
+ }
46
+ }
47
+ }
48
+ },
49
+ "404": {
50
+ "description": "Unable to find resource",
51
+ "content": {
52
+ "application/problem+json": {
53
+ "schema": {
54
+ "$ref": "#/components/schemas/ProblemDetails"
55
+ }
56
+ }
57
+ }
58
+ },
59
+ "409": {
60
+ "description": "Conflict",
61
+ "content": {
62
+ "application/problem+json": {
63
+ "schema": {
64
+ "$ref": "#/components/schemas/ProblemDetails"
65
+ }
66
+ }
67
+ }
68
+ },
69
+ "500": {
70
+ "description": "Internal server error",
71
+ "content": {
72
+ "application/problem+json": {
73
+ "schema": {
74
+ "$ref": "#/components/schemas/ProblemDetails"
75
+ }
76
+ }
77
+ }
78
+ },
79
+ "204": {
80
+ "description": "No Content"
81
+ },
82
+ "403": {
83
+ "description": "Forbidden"
84
+ }
85
+ },
86
+ "security": [
87
+ {
88
+ "apptio-token-scheme": []
89
+ }
90
+ ]
91
+ }
92
+ },
9
93
  "/api/sdm/{entityType}": {
10
94
  "post": {
11
95
  "tags": [
@@ -94,7 +178,12 @@
94
178
  "403": {
95
179
  "description": "Forbidden"
96
180
  }
97
- }
181
+ },
182
+ "security": [
183
+ {
184
+ "apptio-token-scheme": []
185
+ }
186
+ ]
98
187
  },
99
188
  "delete": {
100
189
  "tags": [
@@ -187,7 +276,12 @@
187
276
  "403": {
188
277
  "description": "Forbidden"
189
278
  }
190
- }
279
+ },
280
+ "security": [
281
+ {
282
+ "apptio-token-scheme": []
283
+ }
284
+ ]
191
285
  }
192
286
  },
193
287
  "/api/sdm/mentions": {
@@ -264,7 +358,12 @@
264
358
  "403": {
265
359
  "description": "Forbidden"
266
360
  }
267
- }
361
+ },
362
+ "security": [
363
+ {
364
+ "apptio-token-scheme": []
365
+ }
366
+ ]
268
367
  }
269
368
  },
270
369
  "/api/sdm/schema/{entityType}": {
@@ -433,7 +532,12 @@
433
532
  "403": {
434
533
  "description": "Forbidden"
435
534
  }
436
- }
535
+ },
536
+ "security": [
537
+ {
538
+ "apptio-token-scheme": []
539
+ }
540
+ ]
437
541
  }
438
542
  },
439
543
  "/api/sdm/{entityType}/{id}": {
@@ -602,7 +706,12 @@
602
706
  "403": {
603
707
  "description": "Forbidden"
604
708
  }
605
- }
709
+ },
710
+ "security": [
711
+ {
712
+ "apptio-token-scheme": []
713
+ }
714
+ ]
606
715
  }
607
716
  },
608
717
  "/api/sdm/{entityType}/count": {
@@ -703,7 +812,12 @@
703
812
  "403": {
704
813
  "description": "Forbidden"
705
814
  }
706
- }
815
+ },
816
+ "security": [
817
+ {
818
+ "apptio-token-scheme": []
819
+ }
820
+ ]
707
821
  }
708
822
  },
709
823
  "/api/sdm/attachments/{entityId}": {
@@ -801,7 +915,12 @@
801
915
  "403": {
802
916
  "description": "Forbidden"
803
917
  }
804
- }
918
+ },
919
+ "security": [
920
+ {
921
+ "apptio-token-scheme": []
922
+ }
923
+ ]
805
924
  }
806
925
  },
807
926
  "/api/sdm/attachments/{resourceUrl}": {
@@ -886,7 +1005,12 @@
886
1005
  "403": {
887
1006
  "description": "Forbidden"
888
1007
  }
889
- }
1008
+ },
1009
+ "security": [
1010
+ {
1011
+ "apptio-token-scheme": []
1012
+ }
1013
+ ]
890
1014
  }
891
1015
  },
892
1016
  "/api/sdm/alerts/{storageKey}": {
@@ -971,7 +1095,12 @@
971
1095
  "403": {
972
1096
  "description": "Forbidden"
973
1097
  }
974
- }
1098
+ },
1099
+ "security": [
1100
+ {
1101
+ "apptio-token-scheme": []
1102
+ }
1103
+ ]
975
1104
  }
976
1105
  },
977
1106
  "/api/settings/profile/validate": {
@@ -1058,7 +1187,12 @@
1058
1187
  "403": {
1059
1188
  "description": "Forbidden"
1060
1189
  }
1061
- }
1190
+ },
1191
+ "security": [
1192
+ {
1193
+ "apptio-token-scheme": []
1194
+ }
1195
+ ]
1062
1196
  }
1063
1197
  },
1064
1198
  "/api/settings/profile": {
@@ -1147,7 +1281,12 @@
1147
1281
  "403": {
1148
1282
  "description": "Forbidden"
1149
1283
  }
1150
- }
1284
+ },
1285
+ "security": [
1286
+ {
1287
+ "apptio-token-scheme": []
1288
+ }
1289
+ ]
1151
1290
  },
1152
1291
  "get": {
1153
1292
  "tags": [
@@ -1222,7 +1361,12 @@
1222
1361
  "403": {
1223
1362
  "description": "Forbidden"
1224
1363
  }
1225
- }
1364
+ },
1365
+ "security": [
1366
+ {
1367
+ "apptio-token-scheme": []
1368
+ }
1369
+ ]
1226
1370
  },
1227
1371
  "delete": {
1228
1372
  "tags": [
@@ -1312,7 +1456,12 @@
1312
1456
  "403": {
1313
1457
  "description": "Forbidden"
1314
1458
  }
1315
- }
1459
+ },
1460
+ "security": [
1461
+ {
1462
+ "apptio-token-scheme": []
1463
+ }
1464
+ ]
1316
1465
  }
1317
1466
  },
1318
1467
  "/api/settings/profile/testTypeMapping": {
@@ -1400,7 +1549,12 @@
1400
1549
  "403": {
1401
1550
  "description": "Forbidden"
1402
1551
  }
1403
- }
1552
+ },
1553
+ "security": [
1554
+ {
1555
+ "apptio-token-scheme": []
1556
+ }
1557
+ ]
1404
1558
  }
1405
1559
  },
1406
1560
  "/api/settings/profile/current": {
@@ -1487,7 +1641,12 @@
1487
1641
  "403": {
1488
1642
  "description": "Forbidden"
1489
1643
  }
1490
- }
1644
+ },
1645
+ "security": [
1646
+ {
1647
+ "apptio-token-scheme": []
1648
+ }
1649
+ ]
1491
1650
  },
1492
1651
  "get": {
1493
1652
  "tags": [
@@ -1559,7 +1718,12 @@
1559
1718
  "403": {
1560
1719
  "description": "Forbidden"
1561
1720
  }
1562
- }
1721
+ },
1722
+ "security": [
1723
+ {
1724
+ "apptio-token-scheme": []
1725
+ }
1726
+ ]
1563
1727
  }
1564
1728
  },
1565
1729
  "/api/settings/internal/test-k8s-token": {
@@ -1634,7 +1798,12 @@
1634
1798
  "403": {
1635
1799
  "description": "Forbidden"
1636
1800
  }
1637
- }
1801
+ },
1802
+ "security": [
1803
+ {
1804
+ "apptio-token-scheme": []
1805
+ }
1806
+ ]
1638
1807
  }
1639
1808
  },
1640
1809
  "/api/settings/entityTypes": {
@@ -1708,7 +1877,12 @@
1708
1877
  "403": {
1709
1878
  "description": "Forbidden"
1710
1879
  }
1711
- }
1880
+ },
1881
+ "security": [
1882
+ {
1883
+ "apptio-token-scheme": []
1884
+ }
1885
+ ]
1712
1886
  }
1713
1887
  },
1714
1888
  "/api/settings/profile/copy": {
@@ -1795,7 +1969,12 @@
1795
1969
  "403": {
1796
1970
  "description": "Forbidden"
1797
1971
  }
1798
- }
1972
+ },
1973
+ "security": [
1974
+ {
1975
+ "apptio-token-scheme": []
1976
+ }
1977
+ ]
1799
1978
  }
1800
1979
  }
1801
1980
  },
@@ -1857,6 +2036,11 @@
1857
2036
  }
1858
2037
  }
1859
2038
  },
2039
+ "TermsRequestDto": {
2040
+ "type": "object",
2041
+ "description": "Get terms for process",
2042
+ "additionalProperties": false
2043
+ },
1860
2044
  "MentionsRequestDto": {
1861
2045
  "type": "object",
1862
2046
  "additionalProperties": false
@@ -2383,6 +2567,12 @@
2383
2567
  "scheme": "Bearer",
2384
2568
  "bearerFormat": "JWT"
2385
2569
  },
2570
+ "apptio-token-scheme": {
2571
+ "type": "apiKey",
2572
+ "description": "Frontdoor token",
2573
+ "name": "apptio-opentoken",
2574
+ "in": "header"
2575
+ },
2386
2576
  "OAuth2": {
2387
2577
  "type": "oauth2",
2388
2578
  "name": "OAuth2",