@gleanwork/api-client 0.6.7 → 0.7.1
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.
- package/dist/commonjs/funcs/clientEntitiesList.d.ts +1 -1
- package/dist/commonjs/funcs/clientEntitiesList.js +1 -1
- package/dist/commonjs/lib/config.d.ts +2 -2
- package/dist/commonjs/lib/config.js +2 -2
- package/dist/commonjs/models/components/answer.d.ts +3 -1
- package/dist/commonjs/models/components/answer.d.ts.map +1 -1
- package/dist/commonjs/models/components/answer.js.map +1 -1
- package/dist/commonjs/models/components/answercreationdata.d.ts +3 -1
- package/dist/commonjs/models/components/answercreationdata.d.ts.map +1 -1
- package/dist/commonjs/models/components/answercreationdata.js.map +1 -1
- package/dist/commonjs/models/components/editanswerrequest.d.ts +3 -1
- package/dist/commonjs/models/components/editanswerrequest.d.ts.map +1 -1
- package/dist/commonjs/models/components/editanswerrequest.js.map +1 -1
- package/dist/commonjs/models/components/facetfiltervalue.d.ts +3 -0
- package/dist/commonjs/models/components/facetfiltervalue.d.ts.map +1 -1
- package/dist/commonjs/models/components/facetfiltervalue.js +1 -0
- package/dist/commonjs/models/components/facetfiltervalue.js.map +1 -1
- package/dist/commonjs/models/components/feedrequest.d.ts +3 -0
- package/dist/commonjs/models/components/feedrequest.d.ts.map +1 -1
- package/dist/commonjs/models/components/feedrequest.js +1 -0
- package/dist/commonjs/models/components/feedrequest.js.map +1 -1
- package/dist/commonjs/models/components/inputoptions.d.ts +3 -0
- package/dist/commonjs/models/components/inputoptions.d.ts.map +1 -1
- package/dist/commonjs/models/components/inputoptions.js +1 -0
- package/dist/commonjs/models/components/inputoptions.js.map +1 -1
- package/dist/commonjs/models/components/listentitiesrequest.d.ts +36 -0
- package/dist/commonjs/models/components/listentitiesrequest.d.ts.map +1 -1
- package/dist/commonjs/models/components/listentitiesrequest.js +26 -1
- package/dist/commonjs/models/components/listentitiesrequest.js.map +1 -1
- package/dist/commonjs/models/components/relateddocuments.d.ts +12 -6
- package/dist/commonjs/models/components/relateddocuments.d.ts.map +1 -1
- package/dist/commonjs/models/components/relateddocuments.js +4 -2
- package/dist/commonjs/models/components/relateddocuments.js.map +1 -1
- package/dist/commonjs/models/components/searchwarning.d.ts +3 -0
- package/dist/commonjs/models/components/searchwarning.d.ts.map +1 -1
- package/dist/commonjs/models/components/searchwarning.js +1 -0
- package/dist/commonjs/models/components/searchwarning.js.map +1 -1
- package/dist/commonjs/models/components/timerange.d.ts +5 -0
- package/dist/commonjs/models/components/timerange.d.ts.map +1 -1
- package/dist/commonjs/models/components/timerange.js +2 -0
- package/dist/commonjs/models/components/timerange.js.map +1 -1
- package/dist/commonjs/react-query/clientEntitiesList.d.ts +1 -1
- package/dist/commonjs/react-query/clientEntitiesList.js +1 -1
- package/dist/commonjs/sdk/entities.d.ts +1 -1
- package/dist/commonjs/sdk/entities.js +1 -1
- package/dist/esm/funcs/clientEntitiesList.d.ts +1 -1
- package/dist/esm/funcs/clientEntitiesList.js +1 -1
- package/dist/esm/lib/config.d.ts +2 -2
- package/dist/esm/lib/config.js +2 -2
- package/dist/esm/models/components/answer.d.ts +3 -1
- package/dist/esm/models/components/answer.d.ts.map +1 -1
- package/dist/esm/models/components/answer.js.map +1 -1
- package/dist/esm/models/components/answercreationdata.d.ts +3 -1
- package/dist/esm/models/components/answercreationdata.d.ts.map +1 -1
- package/dist/esm/models/components/answercreationdata.js.map +1 -1
- package/dist/esm/models/components/editanswerrequest.d.ts +3 -1
- package/dist/esm/models/components/editanswerrequest.d.ts.map +1 -1
- package/dist/esm/models/components/editanswerrequest.js.map +1 -1
- package/dist/esm/models/components/facetfiltervalue.d.ts +3 -0
- package/dist/esm/models/components/facetfiltervalue.d.ts.map +1 -1
- package/dist/esm/models/components/facetfiltervalue.js +1 -0
- package/dist/esm/models/components/facetfiltervalue.js.map +1 -1
- package/dist/esm/models/components/feedrequest.d.ts +3 -0
- package/dist/esm/models/components/feedrequest.d.ts.map +1 -1
- package/dist/esm/models/components/feedrequest.js +1 -0
- package/dist/esm/models/components/feedrequest.js.map +1 -1
- package/dist/esm/models/components/inputoptions.d.ts +3 -0
- package/dist/esm/models/components/inputoptions.d.ts.map +1 -1
- package/dist/esm/models/components/inputoptions.js +1 -0
- package/dist/esm/models/components/inputoptions.js.map +1 -1
- package/dist/esm/models/components/listentitiesrequest.d.ts +36 -0
- package/dist/esm/models/components/listentitiesrequest.d.ts.map +1 -1
- package/dist/esm/models/components/listentitiesrequest.js +25 -0
- package/dist/esm/models/components/listentitiesrequest.js.map +1 -1
- package/dist/esm/models/components/relateddocuments.d.ts +12 -6
- package/dist/esm/models/components/relateddocuments.d.ts.map +1 -1
- package/dist/esm/models/components/relateddocuments.js +4 -2
- package/dist/esm/models/components/relateddocuments.js.map +1 -1
- package/dist/esm/models/components/searchwarning.d.ts +3 -0
- package/dist/esm/models/components/searchwarning.d.ts.map +1 -1
- package/dist/esm/models/components/searchwarning.js +1 -0
- package/dist/esm/models/components/searchwarning.js.map +1 -1
- package/dist/esm/models/components/timerange.d.ts +5 -0
- package/dist/esm/models/components/timerange.d.ts.map +1 -1
- package/dist/esm/models/components/timerange.js +2 -0
- package/dist/esm/models/components/timerange.js.map +1 -1
- package/dist/esm/react-query/clientEntitiesList.d.ts +1 -1
- package/dist/esm/react-query/clientEntitiesList.js +1 -1
- package/dist/esm/sdk/entities.d.ts +1 -1
- package/dist/esm/sdk/entities.js +1 -1
- package/docs/sdks/agents/README.md +20 -0
- package/docs/sdks/entities/README.md +1 -1
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/funcs/clientEntitiesList.ts +1 -1
- package/src/lib/config.ts +2 -2
- package/src/models/components/answer.ts +3 -1
- package/src/models/components/answercreationdata.ts +3 -1
- package/src/models/components/editanswerrequest.ts +3 -1
- package/src/models/components/facetfiltervalue.ts +1 -0
- package/src/models/components/feedrequest.ts +1 -0
- package/src/models/components/inputoptions.ts +1 -0
- package/src/models/components/listentitiesrequest.ts +38 -0
- package/src/models/components/relateddocuments.ts +4 -2
- package/src/models/components/searchwarning.ts +1 -0
- package/src/models/components/timerange.ts +7 -0
- package/src/react-query/clientEntitiesList.ts +1 -1
- package/src/sdk/entities.ts +1 -1
|
@@ -44,6 +44,18 @@ export type ListEntitiesRequestIncludeField = ClosedEnum<
|
|
|
44
44
|
typeof ListEntitiesRequestIncludeField
|
|
45
45
|
>;
|
|
46
46
|
|
|
47
|
+
/**
|
|
48
|
+
* The type of request being made.
|
|
49
|
+
*/
|
|
50
|
+
export const RequestType = {
|
|
51
|
+
Standard: "STANDARD",
|
|
52
|
+
FullDirectory: "FULL_DIRECTORY",
|
|
53
|
+
} as const;
|
|
54
|
+
/**
|
|
55
|
+
* The type of request being made.
|
|
56
|
+
*/
|
|
57
|
+
export type RequestType = ClosedEnum<typeof RequestType>;
|
|
58
|
+
|
|
47
59
|
export type ListEntitiesRequest = {
|
|
48
60
|
filter?: Array<FacetFilter> | undefined;
|
|
49
61
|
/**
|
|
@@ -75,6 +87,10 @@ export type ListEntitiesRequest = {
|
|
|
75
87
|
* A string denoting the search surface from which the endpoint is called.
|
|
76
88
|
*/
|
|
77
89
|
source?: string | undefined;
|
|
90
|
+
/**
|
|
91
|
+
* The type of request being made.
|
|
92
|
+
*/
|
|
93
|
+
requestType?: RequestType | undefined;
|
|
78
94
|
};
|
|
79
95
|
|
|
80
96
|
/** @internal */
|
|
@@ -119,6 +135,25 @@ export namespace ListEntitiesRequestIncludeField$ {
|
|
|
119
135
|
export const outboundSchema = ListEntitiesRequestIncludeField$outboundSchema;
|
|
120
136
|
}
|
|
121
137
|
|
|
138
|
+
/** @internal */
|
|
139
|
+
export const RequestType$inboundSchema: z.ZodNativeEnum<typeof RequestType> = z
|
|
140
|
+
.nativeEnum(RequestType);
|
|
141
|
+
|
|
142
|
+
/** @internal */
|
|
143
|
+
export const RequestType$outboundSchema: z.ZodNativeEnum<typeof RequestType> =
|
|
144
|
+
RequestType$inboundSchema;
|
|
145
|
+
|
|
146
|
+
/**
|
|
147
|
+
* @internal
|
|
148
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
149
|
+
*/
|
|
150
|
+
export namespace RequestType$ {
|
|
151
|
+
/** @deprecated use `RequestType$inboundSchema` instead. */
|
|
152
|
+
export const inboundSchema = RequestType$inboundSchema;
|
|
153
|
+
/** @deprecated use `RequestType$outboundSchema` instead. */
|
|
154
|
+
export const outboundSchema = RequestType$outboundSchema;
|
|
155
|
+
}
|
|
156
|
+
|
|
122
157
|
/** @internal */
|
|
123
158
|
export const ListEntitiesRequest$inboundSchema: z.ZodType<
|
|
124
159
|
ListEntitiesRequest,
|
|
@@ -135,6 +170,7 @@ export const ListEntitiesRequest$inboundSchema: z.ZodType<
|
|
|
135
170
|
pageSize: z.number().int().optional(),
|
|
136
171
|
cursor: z.string().optional(),
|
|
137
172
|
source: z.string().optional(),
|
|
173
|
+
requestType: RequestType$inboundSchema.default("STANDARD"),
|
|
138
174
|
});
|
|
139
175
|
|
|
140
176
|
/** @internal */
|
|
@@ -148,6 +184,7 @@ export type ListEntitiesRequest$Outbound = {
|
|
|
148
184
|
pageSize?: number | undefined;
|
|
149
185
|
cursor?: string | undefined;
|
|
150
186
|
source?: string | undefined;
|
|
187
|
+
requestType: string;
|
|
151
188
|
};
|
|
152
189
|
|
|
153
190
|
/** @internal */
|
|
@@ -166,6 +203,7 @@ export const ListEntitiesRequest$outboundSchema: z.ZodType<
|
|
|
166
203
|
pageSize: z.number().int().optional(),
|
|
167
204
|
cursor: z.string().optional(),
|
|
168
205
|
source: z.string().optional(),
|
|
206
|
+
requestType: RequestType$outboundSchema.default("STANDARD"),
|
|
169
207
|
});
|
|
170
208
|
|
|
171
209
|
/**
|
|
@@ -33,12 +33,14 @@ export const Relation = {
|
|
|
33
33
|
Attachment: "ATTACHMENT",
|
|
34
34
|
Canonical: "CANONICAL",
|
|
35
35
|
Case: "CASE",
|
|
36
|
-
|
|
36
|
+
ContactLower: "contact",
|
|
37
|
+
ContactUpper: "CONTACT",
|
|
37
38
|
ConversationMessages: "CONVERSATION_MESSAGES",
|
|
38
39
|
Expert: "EXPERT",
|
|
39
40
|
From: "FROM",
|
|
40
41
|
Highlight: "HIGHLIGHT",
|
|
41
|
-
|
|
42
|
+
OpportunityLower: "opportunity",
|
|
43
|
+
OpportunityUpper: "OPPORTUNITY",
|
|
42
44
|
Recent: "RECENT",
|
|
43
45
|
Source: "SOURCE",
|
|
44
46
|
Ticket: "TICKET",
|
|
@@ -18,6 +18,7 @@ export const WarningType = {
|
|
|
18
18
|
CopypastedQuotes: "COPYPASTED_QUOTES",
|
|
19
19
|
InvalidOperator: "INVALID_OPERATOR",
|
|
20
20
|
MaybeInvalidFacetQuery: "MAYBE_INVALID_FACET_QUERY",
|
|
21
|
+
TooManyDatasourceGroups: "TOO_MANY_DATASOURCE_GROUPS",
|
|
21
22
|
} as const;
|
|
22
23
|
/**
|
|
23
24
|
* The type of the warning.
|
|
@@ -16,6 +16,10 @@ export type TimeRange = {
|
|
|
16
16
|
* end time of the time range, applicable for the CUSTOM type.
|
|
17
17
|
*/
|
|
18
18
|
endTime?: Date | undefined;
|
|
19
|
+
/**
|
|
20
|
+
* The number of days to look back from the current time, applicable for the LAST_N_DAYS type.
|
|
21
|
+
*/
|
|
22
|
+
lastNDaysValue?: number | undefined;
|
|
19
23
|
};
|
|
20
24
|
|
|
21
25
|
/** @internal */
|
|
@@ -28,12 +32,14 @@ export const TimeRange$inboundSchema: z.ZodType<
|
|
|
28
32
|
.optional(),
|
|
29
33
|
endTime: z.string().datetime({ offset: true }).transform(v => new Date(v))
|
|
30
34
|
.optional(),
|
|
35
|
+
lastNDaysValue: z.number().int().optional(),
|
|
31
36
|
});
|
|
32
37
|
|
|
33
38
|
/** @internal */
|
|
34
39
|
export type TimeRange$Outbound = {
|
|
35
40
|
startTime?: string | undefined;
|
|
36
41
|
endTime?: string | undefined;
|
|
42
|
+
lastNDaysValue?: number | undefined;
|
|
37
43
|
};
|
|
38
44
|
|
|
39
45
|
/** @internal */
|
|
@@ -44,6 +50,7 @@ export const TimeRange$outboundSchema: z.ZodType<
|
|
|
44
50
|
> = z.object({
|
|
45
51
|
startTime: z.date().transform(v => v.toISOString()).optional(),
|
|
46
52
|
endTime: z.date().transform(v => v.toISOString()).optional(),
|
|
53
|
+
lastNDaysValue: z.number().int().optional(),
|
|
47
54
|
});
|
|
48
55
|
|
|
49
56
|
/**
|
|
@@ -27,7 +27,7 @@ export type ClientEntitiesListMutationData = components.ListEntitiesResponse;
|
|
|
27
27
|
* List entities
|
|
28
28
|
*
|
|
29
29
|
* @remarks
|
|
30
|
-
* List some set of details for all entities that fit the given criteria and return in the requested order. Does not support negation in filters, assumes relation type EQUALS. There is a limit of 10000 entities that can be retrieved via this endpoint.
|
|
30
|
+
* List some set of details for all entities that fit the given criteria and return in the requested order. Does not support negation in filters, assumes relation type EQUALS. There is a limit of 10000 entities that can be retrieved via this endpoint, except when using FULL_DIRECTORY request type for people entities.
|
|
31
31
|
*/
|
|
32
32
|
export function useClientEntitiesListMutation(
|
|
33
33
|
options?: MutationHookOptions<
|
package/src/sdk/entities.ts
CHANGED
|
@@ -13,7 +13,7 @@ export class Entities extends ClientSDK {
|
|
|
13
13
|
* List entities
|
|
14
14
|
*
|
|
15
15
|
* @remarks
|
|
16
|
-
* List some set of details for all entities that fit the given criteria and return in the requested order. Does not support negation in filters, assumes relation type EQUALS. There is a limit of 10000 entities that can be retrieved via this endpoint.
|
|
16
|
+
* List some set of details for all entities that fit the given criteria and return in the requested order. Does not support negation in filters, assumes relation type EQUALS. There is a limit of 10000 entities that can be retrieved via this endpoint, except when using FULL_DIRECTORY request type for people entities.
|
|
17
17
|
*/
|
|
18
18
|
async list(
|
|
19
19
|
request: components.ListEntitiesRequest,
|