@osdk/internal.foundry.ontologies 0.0.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.
Files changed (102) hide show
  1. package/README.md +8 -0
  2. package/build/js/chunk-3CQOP27F.browser.mjs +21 -0
  3. package/build/js/chunk-3CQOP27F.browser.mjs.map +1 -0
  4. package/build/js/chunk-3UJWR3GU.cjs +31 -0
  5. package/build/js/chunk-3UJWR3GU.cjs.map +1 -0
  6. package/build/js/chunk-6TPJBPG6.cjs +37 -0
  7. package/build/js/chunk-6TPJBPG6.cjs.map +1 -0
  8. package/build/js/chunk-7G2FSZUY.cjs +11 -0
  9. package/build/js/chunk-7G2FSZUY.cjs.map +1 -0
  10. package/build/js/chunk-A4PQBZQS.cjs +49 -0
  11. package/build/js/chunk-A4PQBZQS.cjs.map +1 -0
  12. package/build/js/chunk-CMBIRNOI.mjs +26 -0
  13. package/build/js/chunk-CMBIRNOI.mjs.map +1 -0
  14. package/build/js/chunk-DBWFBHSD.mjs +31 -0
  15. package/build/js/chunk-DBWFBHSD.mjs.map +1 -0
  16. package/build/js/chunk-DGTR7KLJ.browser.mjs +26 -0
  17. package/build/js/chunk-DGTR7KLJ.browser.mjs.map +1 -0
  18. package/build/js/chunk-EVCRGZFN.mjs +26 -0
  19. package/build/js/chunk-EVCRGZFN.mjs.map +1 -0
  20. package/build/js/chunk-GWL6IPIE.mjs +41 -0
  21. package/build/js/chunk-GWL6IPIE.mjs.map +1 -0
  22. package/build/js/chunk-HASCYZDS.browser.mjs +46 -0
  23. package/build/js/chunk-HASCYZDS.browser.mjs.map +1 -0
  24. package/build/js/chunk-I5OUFBE4.browser.mjs +31 -0
  25. package/build/js/chunk-I5OUFBE4.browser.mjs.map +1 -0
  26. package/build/js/chunk-IR5QL7BJ.browser.mjs +26 -0
  27. package/build/js/chunk-IR5QL7BJ.browser.mjs.map +1 -0
  28. package/build/js/chunk-IUVRU6RC.cjs +31 -0
  29. package/build/js/chunk-IUVRU6RC.cjs.map +1 -0
  30. package/build/js/chunk-KYTCDLIO.cjs +25 -0
  31. package/build/js/chunk-KYTCDLIO.cjs.map +1 -0
  32. package/build/js/chunk-NBW2Y6ZB.cjs +55 -0
  33. package/build/js/chunk-NBW2Y6ZB.cjs.map +1 -0
  34. package/build/js/chunk-R2RMUNCR.browser.mjs +9 -0
  35. package/build/js/chunk-R2RMUNCR.browser.mjs.map +1 -0
  36. package/build/js/chunk-UF2ZGGVK.mjs +46 -0
  37. package/build/js/chunk-UF2ZGGVK.mjs.map +1 -0
  38. package/build/js/chunk-URU47N22.mjs +21 -0
  39. package/build/js/chunk-URU47N22.mjs.map +1 -0
  40. package/build/js/chunk-X4HMDAEO.browser.mjs +41 -0
  41. package/build/js/chunk-X4HMDAEO.browser.mjs.map +1 -0
  42. package/build/js/chunk-ZSTKOCBT.mjs +9 -0
  43. package/build/js/chunk-ZSTKOCBT.mjs.map +1 -0
  44. package/build/js/index.browser.mjs +9 -0
  45. package/build/js/index.browser.mjs.map +1 -0
  46. package/build/js/index.cjs +38 -0
  47. package/build/js/index.cjs.map +1 -0
  48. package/build/js/index.mjs +9 -0
  49. package/build/js/index.mjs.map +1 -0
  50. package/build/js/public/ActionType.browser.mjs +4 -0
  51. package/build/js/public/ActionType.browser.mjs.map +1 -0
  52. package/build/js/public/ActionType.cjs +37 -0
  53. package/build/js/public/ActionType.cjs.map +1 -0
  54. package/build/js/public/ActionType.mjs +4 -0
  55. package/build/js/public/ActionType.mjs.map +1 -0
  56. package/build/js/public/Attachment.browser.mjs +4 -0
  57. package/build/js/public/Attachment.browser.mjs.map +1 -0
  58. package/build/js/public/Attachment.cjs +21 -0
  59. package/build/js/public/Attachment.cjs.map +1 -0
  60. package/build/js/public/Attachment.mjs +4 -0
  61. package/build/js/public/Attachment.mjs.map +1 -0
  62. package/build/js/public/ObjectType.browser.mjs +4 -0
  63. package/build/js/public/ObjectType.browser.mjs.map +1 -0
  64. package/build/js/public/ObjectType.cjs +25 -0
  65. package/build/js/public/ObjectType.cjs.map +1 -0
  66. package/build/js/public/ObjectType.mjs +4 -0
  67. package/build/js/public/ObjectType.mjs.map +1 -0
  68. package/build/js/public/Ontology.browser.mjs +4 -0
  69. package/build/js/public/Ontology.browser.mjs.map +1 -0
  70. package/build/js/public/Ontology.cjs +17 -0
  71. package/build/js/public/Ontology.cjs.map +1 -0
  72. package/build/js/public/Ontology.mjs +4 -0
  73. package/build/js/public/Ontology.mjs.map +1 -0
  74. package/build/js/public/OntologyObject.browser.mjs +4 -0
  75. package/build/js/public/OntologyObject.browser.mjs.map +1 -0
  76. package/build/js/public/OntologyObject.cjs +33 -0
  77. package/build/js/public/OntologyObject.cjs.map +1 -0
  78. package/build/js/public/OntologyObject.mjs +4 -0
  79. package/build/js/public/OntologyObject.mjs.map +1 -0
  80. package/build/js/public/QueryType.browser.mjs +4 -0
  81. package/build/js/public/QueryType.browser.mjs.map +1 -0
  82. package/build/js/public/QueryType.cjs +21 -0
  83. package/build/js/public/QueryType.cjs.map +1 -0
  84. package/build/js/public/QueryType.mjs +4 -0
  85. package/build/js/public/QueryType.mjs.map +1 -0
  86. package/build/types/_components.d.ts +4 -0
  87. package/build/types/_components.d.ts.map +1 -0
  88. package/build/types/index.d.ts +8 -0
  89. package/build/types/index.d.ts.map +1 -0
  90. package/build/types/public/ActionType.d.ts +122 -0
  91. package/build/types/public/ActionType.d.ts.map +1 -0
  92. package/build/types/public/Attachment.d.ts +45 -0
  93. package/build/types/public/Attachment.d.ts.map +1 -0
  94. package/build/types/public/ObjectType.d.ts +62 -0
  95. package/build/types/public/ObjectType.d.ts.map +1 -0
  96. package/build/types/public/Ontology.d.ts +21 -0
  97. package/build/types/public/Ontology.d.ts.map +1 -0
  98. package/build/types/public/OntologyObject.d.ts +150 -0
  99. package/build/types/public/OntologyObject.d.ts.map +1 -0
  100. package/build/types/public/QueryType.d.ts +53 -0
  101. package/build/types/public/QueryType.d.ts.map +1 -0
  102. package/package.json +65 -0
@@ -0,0 +1,4 @@
1
+ export { aggregateObjects, getLinkedObject, getObject, listLinkedObjects, listObjects, searchObjects } from '../chunk-GWL6IPIE.mjs';
2
+ import '../chunk-ZSTKOCBT.mjs';
3
+ //# sourceMappingURL=out.js.map
4
+ //# sourceMappingURL=OntologyObject.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":[],"names":[],"mappings":""}
@@ -0,0 +1,4 @@
1
+ export { executeQuery, getQueryType, listQueryTypes } from '../chunk-DGTR7KLJ.browser.mjs';
2
+ import '../chunk-R2RMUNCR.browser.mjs';
3
+ //# sourceMappingURL=out.js.map
4
+ //# sourceMappingURL=QueryType.browser.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":[],"names":[],"mappings":""}
@@ -0,0 +1,21 @@
1
+ 'use strict';
2
+
3
+ var chunk3UJWR3GU_cjs = require('../chunk-3UJWR3GU.cjs');
4
+ require('../chunk-7G2FSZUY.cjs');
5
+
6
+
7
+
8
+ Object.defineProperty(exports, "executeQuery", {
9
+ enumerable: true,
10
+ get: function () { return chunk3UJWR3GU_cjs.executeQuery; }
11
+ });
12
+ Object.defineProperty(exports, "getQueryType", {
13
+ enumerable: true,
14
+ get: function () { return chunk3UJWR3GU_cjs.getQueryType; }
15
+ });
16
+ Object.defineProperty(exports, "listQueryTypes", {
17
+ enumerable: true,
18
+ get: function () { return chunk3UJWR3GU_cjs.listQueryTypes; }
19
+ });
20
+ //# sourceMappingURL=out.js.map
21
+ //# sourceMappingURL=QueryType.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":[],"names":[],"mappings":""}
@@ -0,0 +1,4 @@
1
+ export { executeQuery, getQueryType, listQueryTypes } from '../chunk-EVCRGZFN.mjs';
2
+ import '../chunk-ZSTKOCBT.mjs';
3
+ //# sourceMappingURL=out.js.map
4
+ //# sourceMappingURL=QueryType.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":[],"names":[],"mappings":""}
@@ -0,0 +1,4 @@
1
+ export type LooselyBrandedString<T extends string> = string & {
2
+ __LOOSE_BRAND?: T;
3
+ };
4
+ //# sourceMappingURL=_components.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"_components.d.ts","sourceRoot":"","sources":["../../src/_components.ts"],"names":[],"mappings":"AAgBA,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,MAAM,IAAI,MAAM,GAAG;IAC5D,aAAa,CAAC,EAAE,CAAC,CAAC;CACnB,CAAC"}
@@ -0,0 +1,8 @@
1
+ export type * from "./_components.js";
2
+ export * as ActionType from "./public/ActionType.js";
3
+ export * as Attachment from "./public/Attachment.js";
4
+ export * as ObjectType from "./public/ObjectType.js";
5
+ export * as Ontology from "./public/Ontology.js";
6
+ export * as OntologyObject from "./public/OntologyObject.js";
7
+ export * as QueryType from "./public/QueryType.js";
8
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAgBA,mBAAmB,kBAAkB,CAAC;AACtC,OAAO,KAAK,UAAU,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,UAAU,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,UAAU,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,QAAQ,MAAM,sBAAsB,CAAC;AACjD,OAAO,KAAK,cAAc,MAAM,4BAA4B,CAAC;AAC7D,OAAO,KAAK,SAAS,MAAM,uBAAuB,CAAC"}
@@ -0,0 +1,122 @@
1
+ import type { ActionRid, ActionType, ActionTypeApiName, ApplyActionRequest, ApplyActionResponse, AsyncActionOperation, AsyncApplyActionRequest, BatchApplyActionRequest, BatchApplyActionResponse, ListActionTypesResponse, OntologyRid, PageSize, PageToken, PreviewMode, ValidateActionRequest, ValidateActionResponse } from "@osdk/internal.foundry.core";
2
+ import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.net";
3
+ /**
4
+ * Lists the action types for the given Ontology.
5
+ *
6
+ * Each page may be smaller than the requested page size. However, it is guaranteed that if there are more
7
+ * results available, at least one result will be present in the response.
8
+ *
9
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
10
+ *
11
+ * Required Scopes: [api:read-data]
12
+ * URL: /v1/ontologies/{ontologyRid}/actionTypes
13
+ */
14
+ export declare function listActionTypes($ctx: $Client | $ClientContext, ...args: [
15
+ ontologyRid: OntologyRid,
16
+ $queryParams?: {
17
+ pageSize?: PageSize | undefined;
18
+ pageToken?: PageToken | undefined;
19
+ }
20
+ ]): Promise<ListActionTypesResponse>;
21
+ /**
22
+ * Gets a specific action type with the given API name.
23
+ *
24
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
25
+ *
26
+ * Required Scopes: [api:read-data]
27
+ * URL: /v1/ontologies/{ontologyRid}/actionTypes/{actionTypeApiName}
28
+ */
29
+ export declare function getActionType($ctx: $Client | $ClientContext, ...args: [ontologyRid: OntologyRid, actionTypeApiName: ActionTypeApiName]): Promise<ActionType>;
30
+ /**
31
+ * Applies an action using the given parameters. Changes to the Ontology are eventually consistent and may take
32
+ * some time to be visible.
33
+ *
34
+ * Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by
35
+ * this endpoint.
36
+ *
37
+ * Third-party applications using this endpoint via OAuth2 must request the
38
+ * following operation scopes: `api:read-data api:write-data`.
39
+ *
40
+ * Required Scopes: [api:read-data, api:write-data]
41
+ * URL: /v1/ontologies/{ontologyRid}/actions/{actionType}/apply
42
+ */
43
+ export declare function applyAction($ctx: $Client | $ClientContext, ...args: [
44
+ ontologyRid: OntologyRid,
45
+ actionType: ActionTypeApiName,
46
+ $body: ApplyActionRequest
47
+ ]): Promise<ApplyActionResponse>;
48
+ /**
49
+ * Applies multiple actions (of the same Action Type) using the given parameters.
50
+ * Changes to the Ontology are eventually consistent and may take some time to be visible.
51
+ *
52
+ * Up to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not
53
+ * call Functions may receive a higher limit.
54
+ *
55
+ * Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by
56
+ * this endpoint.
57
+ *
58
+ * Third-party applications using this endpoint via OAuth2 must request the
59
+ * following operation scopes: `api:read-data api:write-data`.
60
+ *
61
+ * Required Scopes: [api:read-data, api:write-data]
62
+ * URL: /v1/ontologies/{ontologyRid}/actions/{actionType}/applyBatch
63
+ */
64
+ export declare function applyActionBatch($ctx: $Client | $ClientContext, ...args: [
65
+ ontologyRid: OntologyRid,
66
+ actionType: ActionTypeApiName,
67
+ $body: BatchApplyActionRequest
68
+ ]): Promise<BatchApplyActionResponse>;
69
+ /**
70
+ * Applies an action asynchronously using the given parameters. Changes to the Ontology are eventually consistent
71
+ * and may take some time to be visible.
72
+ *
73
+ * Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently
74
+ * supported by this endpoint.
75
+ *
76
+ * Third-party applications using this endpoint via OAuth2 must request the
77
+ * following operation scopes: `api:read-data api:write-data`.
78
+ *
79
+ * Required Scopes: [api:read-data, api:write-data]
80
+ * URL: /v1/ontologies/{ontologyRid}/actions/{actionType}/applyAsync
81
+ */
82
+ export declare function applyActionAsync($ctx: $Client | $ClientContext, ...args: [
83
+ ontologyRid: OntologyRid,
84
+ actionType: ActionTypeApiName,
85
+ $body: AsyncApplyActionRequest,
86
+ $queryParams?: {
87
+ preview?: PreviewMode | undefined;
88
+ }
89
+ ]): Promise<void>;
90
+ /**
91
+ * Required Scopes: [api:read-data, api:write-data]
92
+ * URL: /v1/ontologies/{ontologyRid}/actions/{actionType}/applyAsync/{actionRid}
93
+ */
94
+ export declare function getAsyncActionStatus($ctx: $Client | $ClientContext, ...args: [
95
+ ontologyRid: OntologyRid,
96
+ actionType: ActionTypeApiName,
97
+ actionRid: ActionRid,
98
+ $queryParams?: {
99
+ preview?: PreviewMode | undefined;
100
+ }
101
+ ]): Promise<AsyncActionOperation>;
102
+ /**
103
+ * Validates if an action can be run with the given set of parameters.
104
+ * The response contains the evaluation of parameters and **submission criteria**
105
+ * that determine if the request is `VALID` or `INVALID`.
106
+ * For performance reasons, validations will not consider existing objects or other data in Foundry.
107
+ * For example, the uniqueness of a primary key or the existence of a user ID will not be checked.
108
+ * Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by
109
+ * this endpoint. Unspecified parameters will be given a default value of `null`.
110
+ *
111
+ * Third-party applications using this endpoint via OAuth2 must request the
112
+ * following operation scopes: `api:read-data`.
113
+ *
114
+ * Required Scopes: [api:read-data]
115
+ * URL: /v1/ontologies/{ontologyRid}/actions/{actionType}/validate
116
+ */
117
+ export declare function validateAction($ctx: $Client | $ClientContext, ...args: [
118
+ ontologyRid: OntologyRid,
119
+ actionType: ActionTypeApiName,
120
+ $body: ValidateActionRequest
121
+ ]): Promise<ValidateActionResponse>;
122
+ //# sourceMappingURL=ActionType.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ActionType.d.ts","sourceRoot":"","sources":["../../../src/public/ActionType.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EACV,SAAS,EACT,UAAU,EACV,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACpB,uBAAuB,EACvB,uBAAuB,EACvB,wBAAwB,EACxB,uBAAuB,EACvB,WAAW,EACX,QAAQ,EACR,SAAS,EACT,WAAW,EACX,qBAAqB,EACrB,sBAAsB,EACvB,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EAEV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,kBAAkB,CAAC;AAe1B;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,WAAW,EAAE,WAAW;IAExB,YAAY,CAAC,EAAE;QACb,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;QAChC,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;KACnC;CACF,GACA,OAAO,CAAC,uBAAuB,CAAC,CAElC;AASD;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE,CAAC,WAAW,EAAE,WAAW,EAAE,iBAAiB,EAAE,iBAAiB,CAAC,GACxE,OAAO,CAAC,UAAU,CAAC,CAErB;AAUD;;;;;;;;;;;;GAYG;AACH,wBAAgB,WAAW,CACzB,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,WAAW,EAAE,WAAW;IACxB,UAAU,EAAE,iBAAiB;IAC7B,KAAK,EAAE,kBAAkB;CAC1B,GACA,OAAO,CAAC,mBAAmB,CAAC,CAE9B;AAUD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,WAAW,EAAE,WAAW;IACxB,UAAU,EAAE,iBAAiB;IAC7B,KAAK,EAAE,uBAAuB;CAC/B,GACA,OAAO,CAAC,wBAAwB,CAAC,CAEnC;AAWD;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,WAAW,EAAE,WAAW;IACxB,UAAU,EAAE,iBAAiB;IAC7B,KAAK,EAAE,uBAAuB;IAC9B,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,WAAW,GAAG,SAAS,CAAA;KAAE;CACrD,GACA,OAAO,CAAC,IAAI,CAAC,CAEf;AAWD;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,WAAW,EAAE,WAAW;IACxB,UAAU,EAAE,iBAAiB;IAC7B,SAAS,EAAE,SAAS;IAEpB,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,WAAW,GAAG,SAAS,CAAA;KAAE;CACrD,GACA,OAAO,CAAC,oBAAoB,CAAC,CAE/B;AAUD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,cAAc,CAC5B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,WAAW,EAAE,WAAW;IACxB,UAAU,EAAE,iBAAiB;IAC7B,KAAK,EAAE,qBAAqB;CAC7B,GACA,OAAO,CAAC,sBAAsB,CAAC,CAEjC"}
@@ -0,0 +1,45 @@
1
+ import type { Attachment, AttachmentRid, ContentLength, ContentType, Filename } from "@osdk/internal.foundry.core";
2
+ import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.net";
3
+ /**
4
+ * Upload an attachment to use in an action. Any attachment which has not been linked to an object via
5
+ * an action within one hour after upload will be removed.
6
+ * Previously mapped attachments which are not connected to any object anymore are also removed on
7
+ * a biweekly basis.
8
+ * The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`.
9
+ *
10
+ * Third-party applications using this endpoint via OAuth2 must request the
11
+ * following operation scopes: `api:write-data`.
12
+ *
13
+ * Required Scopes: [api:write-data]
14
+ * URL: /v1/attachments/upload
15
+ */
16
+ export declare function uploadAttachment($ctx: $Client | $ClientContext, ...args: [
17
+ $queryParams: {
18
+ filename: Filename;
19
+ },
20
+ $headerParams: {
21
+ "Content-Length": ContentLength;
22
+ "Content-Type": ContentType;
23
+ }
24
+ ]): Promise<Attachment>;
25
+ /**
26
+ * Get the content of an attachment.
27
+ *
28
+ * Third-party applications using this endpoint via OAuth2 must request the
29
+ * following operation scopes: `api:read-data`.
30
+ *
31
+ * Required Scopes: [api:read-data]
32
+ * URL: /v1/attachments/{attachmentRid}/content
33
+ */
34
+ export declare function getAttachmentContent($ctx: $Client | $ClientContext, ...args: [attachmentRid: AttachmentRid]): Promise<unknown>;
35
+ /**
36
+ * Get the metadata of an attachment.
37
+ *
38
+ * Third-party applications using this endpoint via OAuth2 must request the
39
+ * following operation scopes: `api:read-data`.
40
+ *
41
+ * Required Scopes: [api:read-data]
42
+ * URL: /v1/attachments/{attachmentRid}
43
+ */
44
+ export declare function getAttachment($ctx: $Client | $ClientContext, ...args: [attachmentRid: AttachmentRid]): Promise<Attachment>;
45
+ //# sourceMappingURL=Attachment.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Attachment.d.ts","sourceRoot":"","sources":["../../../src/public/Attachment.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EACV,UAAU,EACV,aAAa,EACb,aAAa,EACb,WAAW,EACX,QAAQ,EACT,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EAEV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,kBAAkB,CAAC;AAe1B;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,YAAY,EAAE;QAAE,QAAQ,EAAE,QAAQ,CAAA;KAAE;IACpC,aAAa,EAAE;QACb,gBAAgB,EAAE,aAAa,CAAC;QAChC,cAAc,EAAE,WAAW,CAAC;KAC7B;CACF,GACA,OAAO,CAAC,UAAU,CAAC,CAErB;AAMD;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE,CAAC,aAAa,EAAE,aAAa,CAAC,GACtC,OAAO,CAAC,OAAO,CAAC,CAElB;AAMD;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE,CAAC,aAAa,EAAE,aAAa,CAAC,GACtC,OAAO,CAAC,UAAU,CAAC,CAErB"}
@@ -0,0 +1,62 @@
1
+ import type { LinkTypeApiName, LinkTypeSide, ListObjectTypesResponse, ListOutgoingLinkTypesResponse, ObjectType, ObjectTypeApiName, OntologyRid, PageSize, PageToken } from "@osdk/internal.foundry.core";
2
+ import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.net";
3
+ /**
4
+ * Lists the object types for the given Ontology.
5
+ *
6
+ * Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are
7
+ * more results available, at least one result will be present in the
8
+ * response.
9
+ *
10
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
11
+ *
12
+ * Required Scopes: [api:read-data]
13
+ * URL: /v1/ontologies/{ontologyRid}/objectTypes
14
+ */
15
+ export declare function listObjectTypes($ctx: $Client | $ClientContext, ...args: [
16
+ ontologyRid: OntologyRid,
17
+ $queryParams?: {
18
+ pageSize?: PageSize | undefined;
19
+ pageToken?: PageToken | undefined;
20
+ }
21
+ ]): Promise<ListObjectTypesResponse>;
22
+ /**
23
+ * Gets a specific object type with the given API name.
24
+ *
25
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
26
+ *
27
+ * Required Scopes: [api:read-data]
28
+ * URL: /v1/ontologies/{ontologyRid}/objectTypes/{objectType}
29
+ */
30
+ export declare function getObjectType($ctx: $Client | $ClientContext, ...args: [ontologyRid: OntologyRid, objectType: ObjectTypeApiName]): Promise<ObjectType>;
31
+ /**
32
+ * List the outgoing links for an object type.
33
+ *
34
+ * Third-party applications using this endpoint via OAuth2 must request the
35
+ * following operation scopes: `api:read-data`.
36
+ *
37
+ * Required Scopes: [api:read-data]
38
+ * URL: /v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes
39
+ */
40
+ export declare function listOutgoingLinkTypes($ctx: $Client | $ClientContext, ...args: [
41
+ ontologyRid: OntologyRid,
42
+ objectType: ObjectTypeApiName,
43
+ $queryParams?: {
44
+ pageSize?: PageSize | undefined;
45
+ pageToken?: PageToken | undefined;
46
+ }
47
+ ]): Promise<ListOutgoingLinkTypesResponse>;
48
+ /**
49
+ * Get an outgoing link for an object type.
50
+ *
51
+ * Third-party applications using this endpoint via OAuth2 must request the
52
+ * following operation scopes: `api:read-data`.
53
+ *
54
+ * Required Scopes: [api:read-data]
55
+ * URL: /v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes/{linkType}
56
+ */
57
+ export declare function getOutgoingLinkType($ctx: $Client | $ClientContext, ...args: [
58
+ ontologyRid: OntologyRid,
59
+ objectType: ObjectTypeApiName,
60
+ linkType: LinkTypeApiName
61
+ ]): Promise<LinkTypeSide>;
62
+ //# sourceMappingURL=ObjectType.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ObjectType.d.ts","sourceRoot":"","sources":["../../../src/public/ObjectType.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EACV,eAAe,EACf,YAAY,EACZ,uBAAuB,EACvB,6BAA6B,EAC7B,UAAU,EACV,iBAAiB,EACjB,WAAW,EACX,QAAQ,EACR,SAAS,EACV,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EAEV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,kBAAkB,CAAC;AAe1B;;;;;;;;;;;GAWG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,WAAW,EAAE,WAAW;IAExB,YAAY,CAAC,EAAE;QACb,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;QAChC,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;KACnC;CACF,GACA,OAAO,CAAC,uBAAuB,CAAC,CAElC;AASD;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE,CAAC,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,iBAAiB,CAAC,GACjE,OAAO,CAAC,UAAU,CAAC,CAErB;AAaD;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,WAAW,EAAE,WAAW;IACxB,UAAU,EAAE,iBAAiB;IAE7B,YAAY,CAAC,EAAE;QACb,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;QAChC,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;KACnC;CACF,GACA,OAAO,CAAC,6BAA6B,CAAC,CAExC;AAUD;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,WAAW,EAAE,WAAW;IACxB,UAAU,EAAE,iBAAiB;IAC7B,QAAQ,EAAE,eAAe;CAC1B,GACA,OAAO,CAAC,YAAY,CAAC,CAEvB"}
@@ -0,0 +1,21 @@
1
+ import type { ListOntologiesResponse, Ontology, OntologyRid } from "@osdk/internal.foundry.core";
2
+ import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.net";
3
+ /**
4
+ * Lists the Ontologies visible to the current user.
5
+ *
6
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
7
+ *
8
+ * Required Scopes: [api:read-data]
9
+ * URL: /v1/ontologies
10
+ */
11
+ export declare function listOntologies($ctx: $Client | $ClientContext, ...args: []): Promise<ListOntologiesResponse>;
12
+ /**
13
+ * Gets a specific ontology with the given Ontology RID.
14
+ *
15
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
16
+ *
17
+ * Required Scopes: [api:read-data]
18
+ * URL: /v1/ontologies/{ontologyRid}
19
+ */
20
+ export declare function getOntology($ctx: $Client | $ClientContext, ...args: [ontologyRid: OntologyRid]): Promise<Ontology>;
21
+ //# sourceMappingURL=Ontology.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Ontology.d.ts","sourceRoot":"","sources":["../../../src/public/Ontology.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EACV,sBAAsB,EACtB,QAAQ,EACR,WAAW,EACZ,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EAEV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,kBAAkB,CAAC;AAS1B;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC5B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE,EAAE,GACV,OAAO,CAAC,sBAAsB,CAAC,CAEjC;AAMD;;;;;;;GAOG;AACH,wBAAgB,WAAW,CACzB,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE,CAAC,WAAW,EAAE,WAAW,CAAC,GAClC,OAAO,CAAC,QAAQ,CAAC,CAEnB"}
@@ -0,0 +1,150 @@
1
+ import type { AggregateObjectsRequest, AggregateObjectsResponse, LinkTypeApiName, ListLinkedObjectsResponse, ListObjectsResponse, ObjectTypeApiName, OntologyObject, OntologyRid, OrderBy, PageSize, PageToken, PropertyValueEscapedString, SearchObjectsRequest, SearchObjectsResponse, SelectedPropertyApiName } from "@osdk/internal.foundry.core";
2
+ import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.net";
3
+ /**
4
+ * Lists the objects for the given Ontology and object type.
5
+ *
6
+ * This endpoint supports filtering objects.
7
+ * See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/object-basics/#filtering-objects) for details.
8
+ *
9
+ * Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or
10
+ * repeated objects in the response pages.
11
+ *
12
+ * For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects
13
+ * are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects.
14
+ *
15
+ * Each page may be smaller or larger than the requested page size. However, it
16
+ * is guaranteed that if there are more results available, at least one result will be present
17
+ * in the response.
18
+ *
19
+ * Note that null value properties will not be returned.
20
+ *
21
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
22
+ *
23
+ * Required Scopes: [api:read-data]
24
+ * URL: /v1/ontologies/{ontologyRid}/objects/{objectType}
25
+ */
26
+ export declare function listObjects($ctx: $Client | $ClientContext, ...args: [
27
+ ontologyRid: OntologyRid,
28
+ objectType: ObjectTypeApiName,
29
+ $queryParams: {
30
+ pageSize?: PageSize | undefined;
31
+ pageToken?: PageToken | undefined;
32
+ properties: Array<SelectedPropertyApiName>;
33
+ orderBy?: OrderBy | undefined;
34
+ }
35
+ ]): Promise<ListObjectsResponse>;
36
+ /**
37
+ * Gets a specific object with the given primary key.
38
+ *
39
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
40
+ *
41
+ * Required Scopes: [api:read-data]
42
+ * URL: /v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}
43
+ */
44
+ export declare function getObject($ctx: $Client | $ClientContext, ...args: [
45
+ ontologyRid: OntologyRid,
46
+ objectType: ObjectTypeApiName,
47
+ primaryKey: PropertyValueEscapedString,
48
+ $queryParams: {
49
+ properties: Array<SelectedPropertyApiName>;
50
+ }
51
+ ]): Promise<OntologyObject>;
52
+ /**
53
+ * Lists the linked objects for a specific object and the given link type.
54
+ *
55
+ * This endpoint supports filtering objects.
56
+ * See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/object-basics/#filtering-objects) for details.
57
+ *
58
+ * Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or
59
+ * repeated objects in the response pages.
60
+ *
61
+ * For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects
62
+ * are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects.
63
+ *
64
+ * Each page may be smaller or larger than the requested page size. However, it
65
+ * is guaranteed that if there are more results available, at least one result will be present
66
+ * in the response.
67
+ *
68
+ * Note that null value properties will not be returned.
69
+ *
70
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
71
+ *
72
+ * Required Scopes: [api:read-data]
73
+ * URL: /v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType}
74
+ */
75
+ export declare function listLinkedObjects($ctx: $Client | $ClientContext, ...args: [
76
+ ontologyRid: OntologyRid,
77
+ objectType: ObjectTypeApiName,
78
+ primaryKey: PropertyValueEscapedString,
79
+ linkType: LinkTypeApiName,
80
+ $queryParams: {
81
+ pageSize?: PageSize | undefined;
82
+ pageToken?: PageToken | undefined;
83
+ properties: Array<SelectedPropertyApiName>;
84
+ orderBy?: OrderBy | undefined;
85
+ }
86
+ ]): Promise<ListLinkedObjectsResponse>;
87
+ /**
88
+ * Get a specific linked object that originates from another object. If there is no link between the two objects,
89
+ * LinkedObjectNotFound is thrown.
90
+ *
91
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
92
+ *
93
+ * Required Scopes: [api:read-data]
94
+ * URL: /v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey}
95
+ */
96
+ export declare function getLinkedObject($ctx: $Client | $ClientContext, ...args: [
97
+ ontologyRid: OntologyRid,
98
+ objectType: ObjectTypeApiName,
99
+ primaryKey: PropertyValueEscapedString,
100
+ linkType: LinkTypeApiName,
101
+ linkedObjectPrimaryKey: PropertyValueEscapedString,
102
+ $queryParams: {
103
+ properties: Array<SelectedPropertyApiName>;
104
+ }
105
+ ]): Promise<OntologyObject>;
106
+ /**
107
+ * Search for objects in the specified ontology and object type. The request body is used
108
+ * to filter objects based on the specified query. The supported queries are:
109
+ *
110
+ * | Query type | Description | Supported Types |
111
+ * |----------|-----------------------------------------------------------------------------------|---------------------------------|
112
+ * | lt | The provided property is less than the provided value. | number, string, date, timestamp |
113
+ * | gt | The provided property is greater than the provided value. | number, string, date, timestamp |
114
+ * | lte | The provided property is less than or equal to the provided value. | number, string, date, timestamp |
115
+ * | gte | The provided property is greater than or equal to the provided value. | number, string, date, timestamp |
116
+ * | eq | The provided property is exactly equal to the provided value. | number, string, date, timestamp |
117
+ * | isNull | The provided property is (or is not) null. | all |
118
+ * | contains | The provided property contains the provided value. | array |
119
+ * | not | The sub-query does not match. | N/A (applied on a query) |
120
+ * | and | All the sub-queries match. | N/A (applied on queries) |
121
+ * | or | At least one of the sub-queries match. | N/A (applied on queries) |
122
+ * | prefix | The provided property starts with the provided value. | string |
123
+ * | phrase | The provided property contains the provided value as a substring. | string |
124
+ * | anyTerm | The provided property contains at least one of the terms separated by whitespace. | string |
125
+ * | allTerms | The provided property contains all the terms separated by whitespace. | string | |
126
+ *
127
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
128
+ *
129
+ * Required Scopes: [api:read-data]
130
+ * URL: /v1/ontologies/{ontologyRid}/objects/{objectType}/search
131
+ */
132
+ export declare function searchObjects($ctx: $Client | $ClientContext, ...args: [
133
+ ontologyRid: OntologyRid,
134
+ objectType: ObjectTypeApiName,
135
+ $body: SearchObjectsRequest
136
+ ]): Promise<SearchObjectsResponse>;
137
+ /**
138
+ * Perform functions on object fields in the specified ontology and object type.
139
+ *
140
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
141
+ *
142
+ * Required Scopes: [api:read-data]
143
+ * URL: /v1/ontologies/{ontologyRid}/objects/{objectType}/aggregate
144
+ */
145
+ export declare function aggregateObjects($ctx: $Client | $ClientContext, ...args: [
146
+ ontologyRid: OntologyRid,
147
+ objectType: ObjectTypeApiName,
148
+ $body: AggregateObjectsRequest
149
+ ]): Promise<AggregateObjectsResponse>;
150
+ //# sourceMappingURL=OntologyObject.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"OntologyObject.d.ts","sourceRoot":"","sources":["../../../src/public/OntologyObject.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EACV,uBAAuB,EACvB,wBAAwB,EACxB,eAAe,EACf,yBAAyB,EACzB,mBAAmB,EACnB,iBAAiB,EACjB,cAAc,EACd,WAAW,EACX,OAAO,EACP,QAAQ,EACR,SAAS,EACT,0BAA0B,EAC1B,oBAAoB,EACpB,qBAAqB,EACrB,uBAAuB,EACxB,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EAEV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,kBAAkB,CAAC;AAkB1B;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,WAAW,CACzB,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,WAAW,EAAE,WAAW;IACxB,UAAU,EAAE,iBAAiB;IAE7B,YAAY,EAAE;QACZ,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;QAChC,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;QAClC,UAAU,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC3C,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;KAC/B;CACF,GACA,OAAO,CAAC,mBAAmB,CAAC,CAE9B;AAWD;;;;;;;GAOG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,WAAW,EAAE,WAAW;IACxB,UAAU,EAAE,iBAAiB;IAC7B,UAAU,EAAE,0BAA0B;IAEtC,YAAY,EAAE;QAAE,UAAU,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAA;KAAE;CAC7D,GACA,OAAO,CAAC,cAAc,CAAC,CAEzB;AAiBD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,WAAW,EAAE,WAAW;IACxB,UAAU,EAAE,iBAAiB;IAC7B,UAAU,EAAE,0BAA0B;IACtC,QAAQ,EAAE,eAAe;IAEzB,YAAY,EAAE;QACZ,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;QAChC,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;QAClC,UAAU,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC3C,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;KAC/B;CACF,GACA,OAAO,CAAC,yBAAyB,CAAC,CAEpC;AAaD;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,WAAW,EAAE,WAAW;IACxB,UAAU,EAAE,iBAAiB;IAC7B,UAAU,EAAE,0BAA0B;IACtC,QAAQ,EAAE,eAAe;IACzB,sBAAsB,EAAE,0BAA0B;IAElD,YAAY,EAAE;QAAE,UAAU,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAA;KAAE;CAC7D,GACA,OAAO,CAAC,cAAc,CAAC,CAEzB;AAUD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,WAAW,EAAE,WAAW;IACxB,UAAU,EAAE,iBAAiB;IAC7B,KAAK,EAAE,oBAAoB;CAC5B,GACA,OAAO,CAAC,qBAAqB,CAAC,CAEhC;AAUD;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,WAAW,EAAE,WAAW;IACxB,UAAU,EAAE,iBAAiB;IAC7B,KAAK,EAAE,uBAAuB;CAC/B,GACA,OAAO,CAAC,wBAAwB,CAAC,CAEnC"}
@@ -0,0 +1,53 @@
1
+ import type { ExecuteQueryRequest, ExecuteQueryResponse, ListQueryTypesResponse, OntologyRid, PageSize, PageToken, PreviewMode, QueryApiName, QueryType } from "@osdk/internal.foundry.core";
2
+ import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.net";
3
+ /**
4
+ * Lists the query types for the given Ontology.
5
+ *
6
+ * Each page may be smaller than the requested page size. However, it is guaranteed that if there are more
7
+ * results available, at least one result will be present in the response.
8
+ *
9
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
10
+ *
11
+ * Required Scopes: [api:read-data]
12
+ * URL: /v1/ontologies/{ontologyRid}/queryTypes
13
+ */
14
+ export declare function listQueryTypes($ctx: $Client | $ClientContext, ...args: [
15
+ ontologyRid: OntologyRid,
16
+ $queryParams?: {
17
+ pageSize?: PageSize | undefined;
18
+ pageToken?: PageToken | undefined;
19
+ preview?: PreviewMode | undefined;
20
+ }
21
+ ]): Promise<ListQueryTypesResponse>;
22
+ /**
23
+ * Gets a specific query type with the given API name.
24
+ *
25
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
26
+ *
27
+ * Required Scopes: [api:read-data]
28
+ * URL: /v1/ontologies/{ontologyRid}/queryTypes/{queryApiName}
29
+ */
30
+ export declare function getQueryType($ctx: $Client | $ClientContext, ...args: [
31
+ ontologyRid: OntologyRid,
32
+ queryApiName: QueryApiName,
33
+ $queryParams?: {
34
+ preview?: PreviewMode | undefined;
35
+ }
36
+ ]): Promise<QueryType>;
37
+ /**
38
+ * Executes a Query using the given parameters. Optional parameters do not need to be supplied.
39
+ * Third-party applications using this endpoint via OAuth2 must request the
40
+ * following operation scopes: `api:read-data`.
41
+ *
42
+ * Required Scopes: [api:read-data]
43
+ * URL: /v1/ontologies/{ontologyRid}/queries/{queryApiName}/execute
44
+ */
45
+ export declare function executeQuery($ctx: $Client | $ClientContext, ...args: [
46
+ ontologyRid: OntologyRid,
47
+ queryApiName: QueryApiName,
48
+ $body: ExecuteQueryRequest,
49
+ $queryParams?: {
50
+ preview?: PreviewMode | undefined;
51
+ }
52
+ ]): Promise<ExecuteQueryResponse>;
53
+ //# sourceMappingURL=QueryType.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"QueryType.d.ts","sourceRoot":"","sources":["../../../src/public/QueryType.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EACV,mBAAmB,EACnB,oBAAoB,EACpB,sBAAsB,EACtB,WAAW,EACX,QAAQ,EACR,SAAS,EACT,WAAW,EACX,YAAY,EACZ,SAAS,EACV,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EAEV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,kBAAkB,CAAC;AAgB1B;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAC5B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,WAAW,EAAE,WAAW;IAExB,YAAY,CAAC,EAAE;QACb,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;QAChC,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;QAClC,OAAO,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;KACnC;CACF,GACA,OAAO,CAAC,sBAAsB,CAAC,CAEjC;AAUD;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAC1B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,WAAW,EAAE,WAAW;IACxB,YAAY,EAAE,YAAY;IAE1B,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,WAAW,GAAG,SAAS,CAAA;KAAE;CACrD,GACA,OAAO,CAAC,SAAS,CAAC,CAEpB;AAWD;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAC1B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,WAAW,EAAE,WAAW;IACxB,YAAY,EAAE,YAAY;IAC1B,KAAK,EAAE,mBAAmB;IAC1B,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,WAAW,GAAG,SAAS,CAAA;KAAE;CACrD,GACA,OAAO,CAAC,oBAAoB,CAAC,CAE/B"}
package/package.json ADDED
@@ -0,0 +1,65 @@
1
+ {
2
+ "name": "@osdk/internal.foundry.ontologies",
3
+ "version": "0.0.0",
4
+ "license": "Apache-2.0",
5
+ "repository": {
6
+ "type": "git",
7
+ "url": "https://github.com/palantir/osdk-ts.git"
8
+ },
9
+ "exports": {
10
+ ".": {
11
+ "types": "./build/types/index.d.ts",
12
+ "browser": "./build/js/index.browser.mjs",
13
+ "import": "./build/js/index.mjs",
14
+ "require": "./build/js/index.cjs"
15
+ },
16
+ "./*": {
17
+ "types": "./build/types/public/*.d.ts",
18
+ "browser": "./build/js/public/*.browser.mjs",
19
+ "import": "./build/js/public/*.mjs",
20
+ "require": "./build/js/public/*.cjs"
21
+ }
22
+ },
23
+ "dependencies": {
24
+ "@osdk/api": "^1.8.0",
25
+ "@osdk/internal.foundry.core": "0.0.0"
26
+ },
27
+ "peerDependencies": {
28
+ "@osdk/client": "^0.19.0",
29
+ "@osdk/shared.net": "^1.11.0"
30
+ },
31
+ "devDependencies": {
32
+ "typescript": "^5.4.5",
33
+ "@osdk/shared.net": "^1.11.0"
34
+ },
35
+ "publishConfig": {
36
+ "access": "public"
37
+ },
38
+ "files": [
39
+ "build/types",
40
+ "build/js",
41
+ "CHANGELOG.md",
42
+ "package.json",
43
+ "templates",
44
+ "*.d.ts"
45
+ ],
46
+ "main": "./build/js/index.cjs",
47
+ "module": "./build/js/index.mjs",
48
+ "types": "./build/types/index.d.ts",
49
+ "sls": {
50
+ "dependencies": {
51
+ "com.palantir.foundry.api:api-gateway": {
52
+ "minVersion": "1.834.0",
53
+ "maxVersion": "1.x.x"
54
+ }
55
+ }
56
+ },
57
+ "type": "module",
58
+ "scripts": {
59
+ "clean": "rm -rf lib dist types build tsconfig.tsbuildinfo",
60
+ "fix-lint": "eslint . --fix && dprint fmt --config $(find-up dprint.json)",
61
+ "lint": "eslint . && dprint check --config $(find-up dprint.json)",
62
+ "transpile": "tsup",
63
+ "typecheck": "tsc-absolute"
64
+ }
65
+ }