@credal/sdk 0.0.3 → 0.0.6

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 (111) hide show
  1. package/README.md +168 -0
  2. package/api/resources/copilots/client/Client.d.ts +15 -0
  3. package/api/resources/copilots/client/Client.js +62 -2
  4. package/api/resources/copilots/client/requests/ProvideMessageFeedbackRequest.d.ts +32 -0
  5. package/api/resources/copilots/client/requests/index.d.ts +1 -0
  6. package/api/resources/copilots/types/FeedbackEnum.d.ts +8 -0
  7. package/api/resources/copilots/types/FeedbackEnum.js +10 -0
  8. package/api/resources/copilots/types/MessageFeedback.d.ts +8 -0
  9. package/api/resources/copilots/types/MessageReply.d.ts +2 -0
  10. package/api/resources/copilots/types/ReferencedSource.d.ts +10 -0
  11. package/api/resources/copilots/types/ReferencedSource.js +5 -0
  12. package/api/resources/copilots/types/index.d.ts +3 -0
  13. package/api/resources/copilots/types/index.js +3 -0
  14. package/api/resources/documentCatalog/client/Client.js +2 -2
  15. package/api/resources/documentCollections/client/Client.js +1 -1
  16. package/api/resources/permissionsService/client/Client.d.ts +3 -4
  17. package/api/resources/permissionsService/client/Client.js +6 -7
  18. package/api/resources/permissionsService/client/requests/CheckBulkResourcesAuthorizationForUserRequest.d.ts +2 -3
  19. package/api/resources/permissionsService/types/AuthorizedResource.d.ts +8 -0
  20. package/api/resources/permissionsService/types/AuthorizedResource.js +5 -0
  21. package/api/resources/permissionsService/types/{ResourceListPage.d.ts → AuthorizedResourceListPage.d.ts} +1 -3
  22. package/api/resources/permissionsService/types/AuthorizedResourceListPage.js +5 -0
  23. package/api/resources/permissionsService/types/ResourceAuthorizationResult.d.ts +2 -1
  24. package/api/resources/permissionsService/types/index.d.ts +2 -1
  25. package/api/resources/permissionsService/types/index.js +2 -1
  26. package/api/resources/search/client/Client.js +1 -1
  27. package/api/resources/search/client/requests/SearchDocumentCollectionRequest.d.ts +1 -1
  28. package/api/resources/users/client/Client.js +1 -1
  29. package/dist/api/resources/copilots/client/Client.d.ts +15 -0
  30. package/dist/api/resources/copilots/client/Client.js +62 -2
  31. package/dist/api/resources/copilots/client/requests/ProvideMessageFeedbackRequest.d.ts +32 -0
  32. package/dist/api/resources/copilots/client/requests/ProvideMessageFeedbackRequest.js +5 -0
  33. package/dist/api/resources/copilots/client/requests/index.d.ts +1 -0
  34. package/dist/api/resources/copilots/types/FeedbackEnum.d.ts +8 -0
  35. package/dist/api/resources/copilots/types/FeedbackEnum.js +10 -0
  36. package/dist/api/resources/copilots/types/MessageFeedback.d.ts +8 -0
  37. package/dist/api/resources/copilots/types/MessageFeedback.js +5 -0
  38. package/dist/api/resources/copilots/types/MessageReply.d.ts +2 -0
  39. package/dist/api/resources/copilots/types/ReferencedSource.d.ts +10 -0
  40. package/dist/api/resources/copilots/types/ReferencedSource.js +5 -0
  41. package/dist/api/resources/copilots/types/index.d.ts +3 -0
  42. package/dist/api/resources/copilots/types/index.js +3 -0
  43. package/dist/api/resources/documentCatalog/client/Client.js +2 -2
  44. package/dist/api/resources/documentCollections/client/Client.js +1 -1
  45. package/dist/api/resources/permissionsService/client/Client.d.ts +3 -4
  46. package/dist/api/resources/permissionsService/client/Client.js +6 -7
  47. package/dist/api/resources/permissionsService/client/requests/CheckBulkResourcesAuthorizationForUserRequest.d.ts +2 -3
  48. package/dist/api/resources/permissionsService/types/AuthorizedResource.d.ts +8 -0
  49. package/dist/api/resources/permissionsService/types/AuthorizedResource.js +5 -0
  50. package/dist/api/resources/permissionsService/types/{ResourceListPage.d.ts → AuthorizedResourceListPage.d.ts} +1 -3
  51. package/dist/api/resources/permissionsService/types/AuthorizedResourceListPage.js +5 -0
  52. package/dist/api/resources/permissionsService/types/ResourceAuthorizationResult.d.ts +2 -1
  53. package/dist/api/resources/permissionsService/types/index.d.ts +2 -1
  54. package/dist/api/resources/permissionsService/types/index.js +2 -1
  55. package/dist/api/resources/search/client/Client.js +1 -1
  56. package/dist/api/resources/search/client/requests/SearchDocumentCollectionRequest.d.ts +1 -1
  57. package/dist/api/resources/users/client/Client.js +1 -1
  58. package/dist/serialization/resources/copilots/client/requests/ProvideMessageFeedbackRequest.d.ts +15 -0
  59. package/dist/serialization/resources/copilots/client/requests/ProvideMessageFeedbackRequest.js +36 -0
  60. package/dist/serialization/resources/copilots/client/requests/index.d.ts +1 -0
  61. package/dist/serialization/resources/copilots/client/requests/index.js +3 -1
  62. package/dist/serialization/resources/copilots/types/FeedbackEnum.d.ts +10 -0
  63. package/dist/serialization/resources/copilots/types/FeedbackEnum.js +31 -0
  64. package/dist/serialization/resources/copilots/types/MessageFeedback.d.ts +14 -0
  65. package/dist/serialization/resources/{permissionsService/types/ResourceListPage.js → copilots/types/MessageFeedback.js} +5 -4
  66. package/dist/serialization/resources/copilots/types/MessageReply.d.ts +3 -0
  67. package/dist/serialization/resources/copilots/types/MessageReply.js +3 -0
  68. package/dist/serialization/resources/copilots/types/ReferencedSource.d.ts +16 -0
  69. package/dist/serialization/resources/copilots/types/ReferencedSource.js +37 -0
  70. package/dist/serialization/resources/copilots/types/index.d.ts +3 -0
  71. package/dist/serialization/resources/copilots/types/index.js +3 -0
  72. package/dist/serialization/resources/permissionsService/types/AuthorizedResource.d.ts +14 -0
  73. package/dist/serialization/resources/permissionsService/types/AuthorizedResource.js +35 -0
  74. package/dist/serialization/resources/permissionsService/types/AuthorizedResourceListPage.d.ts +11 -0
  75. package/dist/serialization/resources/permissionsService/types/AuthorizedResourceListPage.js +32 -0
  76. package/dist/serialization/resources/permissionsService/types/ResourceAuthorizationResult.d.ts +3 -2
  77. package/dist/serialization/resources/permissionsService/types/ResourceAuthorizationResult.js +3 -2
  78. package/dist/serialization/resources/permissionsService/types/index.d.ts +2 -1
  79. package/dist/serialization/resources/permissionsService/types/index.js +2 -1
  80. package/dist/serialization/resources/search/client/requests/SearchDocumentCollectionRequest.d.ts +1 -1
  81. package/dist/serialization/resources/search/client/requests/SearchDocumentCollectionRequest.js +1 -1
  82. package/package.json +1 -1
  83. package/reference.md +73 -4
  84. package/serialization/resources/copilots/client/requests/ProvideMessageFeedbackRequest.d.ts +15 -0
  85. package/serialization/resources/copilots/client/requests/ProvideMessageFeedbackRequest.js +36 -0
  86. package/serialization/resources/copilots/client/requests/index.d.ts +1 -0
  87. package/serialization/resources/copilots/client/requests/index.js +3 -1
  88. package/serialization/resources/copilots/types/FeedbackEnum.d.ts +10 -0
  89. package/serialization/resources/copilots/types/FeedbackEnum.js +31 -0
  90. package/serialization/resources/copilots/types/MessageFeedback.d.ts +14 -0
  91. package/serialization/resources/{permissionsService/types/ResourceListPage.js → copilots/types/MessageFeedback.js} +5 -4
  92. package/serialization/resources/copilots/types/MessageReply.d.ts +3 -0
  93. package/serialization/resources/copilots/types/MessageReply.js +3 -0
  94. package/serialization/resources/copilots/types/ReferencedSource.d.ts +16 -0
  95. package/serialization/resources/copilots/types/ReferencedSource.js +37 -0
  96. package/serialization/resources/copilots/types/index.d.ts +3 -0
  97. package/serialization/resources/copilots/types/index.js +3 -0
  98. package/serialization/resources/permissionsService/types/AuthorizedResource.d.ts +14 -0
  99. package/serialization/resources/permissionsService/types/AuthorizedResource.js +35 -0
  100. package/serialization/resources/permissionsService/types/AuthorizedResourceListPage.d.ts +11 -0
  101. package/serialization/resources/permissionsService/types/AuthorizedResourceListPage.js +32 -0
  102. package/serialization/resources/permissionsService/types/ResourceAuthorizationResult.d.ts +3 -2
  103. package/serialization/resources/permissionsService/types/ResourceAuthorizationResult.js +3 -2
  104. package/serialization/resources/permissionsService/types/index.d.ts +2 -1
  105. package/serialization/resources/permissionsService/types/index.js +2 -1
  106. package/serialization/resources/search/client/requests/SearchDocumentCollectionRequest.d.ts +1 -1
  107. package/serialization/resources/search/client/requests/SearchDocumentCollectionRequest.js +1 -1
  108. package/dist/serialization/resources/permissionsService/types/ResourceListPage.d.ts +0 -13
  109. package/serialization/resources/permissionsService/types/ResourceListPage.d.ts +0 -13
  110. /package/api/resources/{permissionsService/types/ResourceListPage.js → copilots/client/requests/ProvideMessageFeedbackRequest.js} +0 -0
  111. /package/{dist/api/resources/permissionsService/types/ResourceListPage.js → api/resources/copilots/types/MessageFeedback.js} +0 -0
@@ -0,0 +1,35 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
18
+ }) : function(o, v) {
19
+ o["default"] = v;
20
+ });
21
+ var __importStar = (this && this.__importStar) || function (mod) {
22
+ if (mod && mod.__esModule) return mod;
23
+ var result = {};
24
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
+ __setModuleDefault(result, mod);
26
+ return result;
27
+ };
28
+ Object.defineProperty(exports, "__esModule", { value: true });
29
+ exports.AuthorizedResource = void 0;
30
+ const core = __importStar(require("../../../../core"));
31
+ const ExternalResourceId_1 = require("../../common/types/ExternalResourceId");
32
+ exports.AuthorizedResource = core.serialization.object({
33
+ credalId: core.serialization.string(),
34
+ externalId: ExternalResourceId_1.ExternalResourceId,
35
+ });
@@ -0,0 +1,11 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as serializers from "../../../index";
5
+ import * as Credal from "../../../../api/index";
6
+ import * as core from "../../../../core";
7
+ import { AuthorizedResource } from "./AuthorizedResource";
8
+ export declare const AuthorizedResourceListPage: core.serialization.Schema<serializers.AuthorizedResourceListPage.Raw, Credal.AuthorizedResourceListPage>;
9
+ export declare namespace AuthorizedResourceListPage {
10
+ type Raw = AuthorizedResource.Raw[];
11
+ }
@@ -0,0 +1,32 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
18
+ }) : function(o, v) {
19
+ o["default"] = v;
20
+ });
21
+ var __importStar = (this && this.__importStar) || function (mod) {
22
+ if (mod && mod.__esModule) return mod;
23
+ var result = {};
24
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
+ __setModuleDefault(result, mod);
26
+ return result;
27
+ };
28
+ Object.defineProperty(exports, "__esModule", { value: true });
29
+ exports.AuthorizedResourceListPage = void 0;
30
+ const core = __importStar(require("../../../../core"));
31
+ const AuthorizedResource_1 = require("./AuthorizedResource");
32
+ exports.AuthorizedResourceListPage = core.serialization.list(AuthorizedResource_1.AuthorizedResource);
@@ -4,11 +4,12 @@
4
4
  import * as serializers from "../../../index";
5
5
  import * as Credal from "../../../../api/index";
6
6
  import * as core from "../../../../core";
7
- import { ResourceIdentifier } from "../../common/types/ResourceIdentifier";
7
+ import { ExternalResourceId } from "../../common/types/ExternalResourceId";
8
8
  export declare const ResourceAuthorizationResult: core.serialization.ObjectSchema<serializers.ResourceAuthorizationResult.Raw, Credal.ResourceAuthorizationResult>;
9
9
  export declare namespace ResourceAuthorizationResult {
10
10
  interface Raw {
11
- resourceIdentifier: ResourceIdentifier.Raw;
11
+ externalResourceId: ExternalResourceId.Raw;
12
+ inputUrl?: string | null;
12
13
  authorized: boolean;
13
14
  }
14
15
  }
@@ -28,8 +28,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
28
28
  Object.defineProperty(exports, "__esModule", { value: true });
29
29
  exports.ResourceAuthorizationResult = void 0;
30
30
  const core = __importStar(require("../../../../core"));
31
- const ResourceIdentifier_1 = require("../../common/types/ResourceIdentifier");
31
+ const ExternalResourceId_1 = require("../../common/types/ExternalResourceId");
32
32
  exports.ResourceAuthorizationResult = core.serialization.object({
33
- resourceIdentifier: ResourceIdentifier_1.ResourceIdentifier,
33
+ externalResourceId: ExternalResourceId_1.ExternalResourceId,
34
+ inputUrl: core.serialization.string().optional(),
34
35
  authorized: core.serialization.boolean(),
35
36
  });
@@ -1,7 +1,8 @@
1
1
  export * from "./Group";
2
2
  export * from "./User";
3
3
  export * from "./Principal";
4
- export * from "./ResourceListPage";
4
+ export * from "./AuthorizedResource";
5
+ export * from "./AuthorizedResourceListPage";
5
6
  export * from "./PrincipalListPage";
6
7
  export * from "./CheckResourceAuthorizationResponse";
7
8
  export * from "./ResourceAuthorizationResult";
@@ -17,7 +17,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./Group"), exports);
18
18
  __exportStar(require("./User"), exports);
19
19
  __exportStar(require("./Principal"), exports);
20
- __exportStar(require("./ResourceListPage"), exports);
20
+ __exportStar(require("./AuthorizedResource"), exports);
21
+ __exportStar(require("./AuthorizedResourceListPage"), exports);
21
22
  __exportStar(require("./PrincipalListPage"), exports);
22
23
  __exportStar(require("./CheckResourceAuthorizationResponse"), exports);
23
24
  __exportStar(require("./ResourceAuthorizationResult"), exports);
@@ -12,7 +12,7 @@ export declare namespace SearchDocumentCollectionRequest {
12
12
  documentCollectionId: string;
13
13
  searchQuery: string;
14
14
  userEmail: string;
15
- structuredQueryFilters: SingleFieldFilter.Raw[];
15
+ structuredQueryFilters?: SingleFieldFilter.Raw[] | null;
16
16
  searchOptions?: DocumentCollectionSearchOptions.Raw | null;
17
17
  metadataFilterExpression?: string | null;
18
18
  }
@@ -34,7 +34,7 @@ exports.SearchDocumentCollectionRequest = core.serialization.object({
34
34
  documentCollectionId: core.serialization.string(),
35
35
  searchQuery: core.serialization.string(),
36
36
  userEmail: core.serialization.string(),
37
- structuredQueryFilters: core.serialization.list(SingleFieldFilter_1.SingleFieldFilter),
37
+ structuredQueryFilters: core.serialization.list(SingleFieldFilter_1.SingleFieldFilter).optional(),
38
38
  searchOptions: DocumentCollectionSearchOptions_1.DocumentCollectionSearchOptions.optional(),
39
39
  metadataFilterExpression: core.serialization.string().optional(),
40
40
  });
@@ -1,13 +0,0 @@
1
- /**
2
- * This file was auto-generated by Fern from our API Definition.
3
- */
4
- import * as serializers from "../../../index";
5
- import * as Credal from "../../../../api/index";
6
- import * as core from "../../../../core";
7
- import { ResourceIdentifier } from "../../common/types/ResourceIdentifier";
8
- export declare const ResourceListPage: core.serialization.ObjectSchema<serializers.ResourceListPage.Raw, Credal.ResourceListPage>;
9
- export declare namespace ResourceListPage {
10
- interface Raw {
11
- resources: ResourceIdentifier.Raw[];
12
- }
13
- }
@@ -1,13 +0,0 @@
1
- /**
2
- * This file was auto-generated by Fern from our API Definition.
3
- */
4
- import * as serializers from "../../../index";
5
- import * as Credal from "../../../../api/index";
6
- import * as core from "../../../../core";
7
- import { ResourceIdentifier } from "../../common/types/ResourceIdentifier";
8
- export declare const ResourceListPage: core.serialization.ObjectSchema<serializers.ResourceListPage.Raw, Credal.ResourceListPage>;
9
- export declare namespace ResourceListPage {
10
- interface Raw {
11
- resources: ResourceIdentifier.Raw[];
12
- }
13
- }