@opencloud-eu/web-client 8.1.0 → 8.2.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.
- package/dist/{axios-CiL7Z3dm.js → axios-DRPhbClr.js} +13 -49
- package/dist/{dist-p2k0FYjB.js → dist-CHy-DaIN.js} +1 -1
- package/dist/{generated-5SvS30Rr.js → generated-4nR8KA38.js} +435 -267
- package/dist/{graph-u53S3WT9.js → graph-CwVan2Jp.js} +148 -123
- package/dist/{helpers-CrYtf7Ol.js → helpers-Bh5xR_vg.js} +45 -36
- package/dist/{ocs-CDSkdguM.js → ocs-Dfdjrujs.js} +407 -432
- package/dist/{schemas-BlxXwTjV.js → schemas-rdabTCJb.js} +1014 -1008
- package/dist/src/errors.d.ts +2 -1
- package/dist/src/graph/generated/api.d.ts +527 -0
- package/dist/src/graph/guestLinks/guestLinks.d.ts +3 -0
- package/dist/src/graph/guestLinks/index.d.ts +2 -0
- package/dist/src/graph/guestLinks/types.d.ts +13 -0
- package/dist/src/graph/index.d.ts +3 -0
- package/dist/src/graph/types.d.ts +1 -0
- package/dist/src/helpers/resource/types.d.ts +2 -1
- package/dist/src/helpers/share/types.d.ts +3 -0
- package/dist/src/helpers/space/functions.d.ts +2 -2
- package/dist/src/ocs/capabilities.d.ts +1 -0
- package/dist/src/webdav/client/dav.d.ts +3 -1
- package/dist/src/webdav/client/parsers.d.ts +1 -0
- package/dist/src/webdav/constants/dav.d.ts +5 -1
- package/dist/src/webdav/index.d.ts +1 -1
- package/dist/{toString-CVetDRwx.js → toString-uorCN9F3.js} +1 -1
- package/dist/web-client/graph/generated.js +1 -2
- package/dist/web-client/graph.js +1 -2
- package/dist/web-client/ocs.js +1 -2
- package/dist/web-client/ox.js +1 -1
- package/dist/web-client/sse.js +1 -1
- package/dist/web-client/webdav.js +2 -2
- package/dist/web-client.js +4 -4
- package/dist/{webdav-BdeuuZHv.js → webdav-DrQsSfxZ.js} +95 -86
- package/package.json +1 -3
package/dist/src/errors.d.ts
CHANGED
|
@@ -6,5 +6,6 @@ export declare class HttpError extends Error {
|
|
|
6
6
|
}
|
|
7
7
|
export declare class DavHttpError extends HttpError {
|
|
8
8
|
errorCode: DavErrorCode;
|
|
9
|
-
|
|
9
|
+
errorType: string | undefined;
|
|
10
|
+
constructor(message: string, errorCode: DavErrorCode, response: Response, statusCode?: number, errorType?: string);
|
|
10
11
|
}
|
|
@@ -67,6 +67,26 @@ export interface ActivityTopic {
|
|
|
67
67
|
*/
|
|
68
68
|
'value': string;
|
|
69
69
|
}
|
|
70
|
+
/**
|
|
71
|
+
* Specifies an aggregation that should be computed and returned alongside search results. Follows the [MS Graph aggregationOption](https://learn.microsoft.com/en-us/graph/api/resources/aggregationoption) resource type. For string fields, terms aggregations return the distinct values and their counts. For numeric and date fields, range aggregations can be defined using the `ranges` property of `bucketDefinition`. At most one of `bucketDefinition`, `@libre.graph.metricDefinition` and `@libre.graph.geohashDefinition` may be set; requests specifying more than one are rejected with `invalidRequest`.
|
|
72
|
+
*/
|
|
73
|
+
export interface AggregationOption {
|
|
74
|
+
/**
|
|
75
|
+
* Specifies the field in the schema of the specified entity type that the aggregation should be computed on. Required. Examples: `audio.artist`, `audio.genre`, `audio.year`, `mimeType`.
|
|
76
|
+
*/
|
|
77
|
+
'field': string;
|
|
78
|
+
/**
|
|
79
|
+
* The number of `searchBucket` resources to be returned. This is optional and only applies to terms and geohash aggregations. For terms aggregations it combines with `bucketDefinition.sortBy` and `bucketDefinition.isDescending` to produce the top N results by count or key; for geohash aggregations it limits the buckets to the top N cells by count. When not specified, all buckets are returned.
|
|
80
|
+
*/
|
|
81
|
+
'size'?: number;
|
|
82
|
+
'bucketDefinition'?: BucketDefinition;
|
|
83
|
+
/**
|
|
84
|
+
* Nested aggregations computed within each bucket of this aggregation. Libregraph extension not present in MS Graph. Backends that don\'t support native composite aggregations (e.g. bleve) emulate them by walking the matched result set; OpenSearch translates them to native composite aggregations.
|
|
85
|
+
*/
|
|
86
|
+
'@libre.graph.subAggregations'?: Array<AggregationOption>;
|
|
87
|
+
'@libre.graph.metricDefinition'?: MetricDefinition;
|
|
88
|
+
'@libre.graph.geohashDefinition'?: GeohashDefinition;
|
|
89
|
+
}
|
|
70
90
|
export interface AppRole {
|
|
71
91
|
/**
|
|
72
92
|
* Specifies whether this app role can be assigned to users and groups (by setting to [\'User\']), to other application\'s (by setting to [\'Application\'], or both (by setting to [\'User\', \'Application\']). App roles supporting assignment to other applications\' service principals are also known as application permissions. The \'Application\' value is only supported for app roles defined on application entities.
|
|
@@ -203,6 +223,46 @@ export interface Audio {
|
|
|
203
223
|
*/
|
|
204
224
|
'year'?: number;
|
|
205
225
|
}
|
|
226
|
+
/**
|
|
227
|
+
* Specifies the lower and upper bound to compute a range aggregation bucket. At least one of `from` or `to` must be provided.
|
|
228
|
+
*/
|
|
229
|
+
export interface BucketAggregationRange {
|
|
230
|
+
/**
|
|
231
|
+
* Defines the lower bound from which to compute the aggregation. The value is always a string. Numeric bounds must be provided as their string representation (e.g. `\"1980\"`). Date bounds must use the `YYYY-MM-DDTHH:mm:ssZ` format. Optional if `to` is provided.
|
|
232
|
+
*/
|
|
233
|
+
'from'?: string;
|
|
234
|
+
/**
|
|
235
|
+
* Defines the upper bound up to which to compute the aggregation. The value is always a string. Numeric bounds must be provided as their string representation (e.g. `\"2000\"`). Date bounds must use the `YYYY-MM-DDTHH:mm:ssZ` format. Optional if `from` is provided.
|
|
236
|
+
*/
|
|
237
|
+
'to'?: string;
|
|
238
|
+
}
|
|
239
|
+
/**
|
|
240
|
+
* Provides the details of how to generate the aggregation buckets in the response. Follows the [MS Graph bucketAggregationDefinition](https://learn.microsoft.com/en-us/graph/api/resources/bucketaggregationdefinition) resource type.
|
|
241
|
+
*/
|
|
242
|
+
export interface BucketDefinition {
|
|
243
|
+
/**
|
|
244
|
+
* The possible values are `count` to sort by the number of matches in the aggregation, `keyAsString` to sort alphabetically based on the key in the aggregation, and `keyAsNumber` to sort numerically based on the key in the aggregation. Required.
|
|
245
|
+
*/
|
|
246
|
+
'sortBy': BucketDefinitionSortByEnum;
|
|
247
|
+
/**
|
|
248
|
+
* Set to `true` to specify the sort order as descending. Optional, defaults to `false` (ascending).
|
|
249
|
+
*/
|
|
250
|
+
'isDescending'?: boolean;
|
|
251
|
+
/**
|
|
252
|
+
* The minimum number of items that should be present in the aggregation for the bucket to be returned in the response. Optional, default is 0.
|
|
253
|
+
*/
|
|
254
|
+
'minimumCount'?: number;
|
|
255
|
+
/**
|
|
256
|
+
* Specifies the manual ranges to compute the aggregation buckets. This is only valid for non-string facets of date or numeric type. Optional. Follows the [MS Graph bucketAggregationRange](https://learn.microsoft.com/en-us/graph/api/resources/bucketaggregationrange) resource type.
|
|
257
|
+
*/
|
|
258
|
+
'ranges'?: Array<BucketAggregationRange>;
|
|
259
|
+
}
|
|
260
|
+
export declare const BucketDefinitionSortByEnum: {
|
|
261
|
+
readonly Count: "count";
|
|
262
|
+
readonly KeyAsString: "keyAsString";
|
|
263
|
+
readonly KeyAsNumber: "keyAsNumber";
|
|
264
|
+
};
|
|
265
|
+
export type BucketDefinitionSortByEnum = typeof BucketDefinitionSortByEnum[keyof typeof BucketDefinitionSortByEnum];
|
|
206
266
|
export interface ClassMemberReference {
|
|
207
267
|
'@odata.id'?: string;
|
|
208
268
|
}
|
|
@@ -796,6 +856,15 @@ export interface GeoCoordinates {
|
|
|
796
856
|
*/
|
|
797
857
|
'longitude'?: number;
|
|
798
858
|
}
|
|
859
|
+
/**
|
|
860
|
+
* Provides the details of how to compute a geohash-grid aggregation over `field`, which must resolve to a geo-point field (e.g. `location`). When set on an `aggregationOption`, each `searchBucket` of the corresponding `searchAggregation` carries a geohash cell as its `key`, with `count` holding the number of matches in the cell, suitable for density/heatmap rendering. `size` limits the buckets to the top N cells by count. Libregraph extension not present in MS Graph.
|
|
861
|
+
*/
|
|
862
|
+
export interface GeohashDefinition {
|
|
863
|
+
/**
|
|
864
|
+
* The geohash length of the returned cells (1-12); higher means finer cells. Required.
|
|
865
|
+
*/
|
|
866
|
+
'precision': number;
|
|
867
|
+
}
|
|
799
868
|
export interface Group {
|
|
800
869
|
/**
|
|
801
870
|
* Read-only.
|
|
@@ -822,6 +891,89 @@ export interface Group {
|
|
|
822
891
|
*/
|
|
823
892
|
'members@odata.bind'?: Set<string>;
|
|
824
893
|
}
|
|
894
|
+
/**
|
|
895
|
+
* Error returned by a guest link endpoint.
|
|
896
|
+
*/
|
|
897
|
+
export interface GuestLinkError {
|
|
898
|
+
/**
|
|
899
|
+
* Machine-readable error identifier.
|
|
900
|
+
*/
|
|
901
|
+
'errorType': GuestLinkErrorErrorTypeEnum;
|
|
902
|
+
/**
|
|
903
|
+
* Human-readable error message.
|
|
904
|
+
*/
|
|
905
|
+
'message': string;
|
|
906
|
+
/**
|
|
907
|
+
* Permission (share) identifier related to the error, when known.
|
|
908
|
+
*/
|
|
909
|
+
'permissionId': string;
|
|
910
|
+
/**
|
|
911
|
+
* Number of seconds the client should wait before retrying. Present on rate-limited (429) responses and mirrored in the Retry-After response header.
|
|
912
|
+
*/
|
|
913
|
+
'retryAfter'?: number;
|
|
914
|
+
}
|
|
915
|
+
export declare const GuestLinkErrorErrorTypeEnum: {
|
|
916
|
+
readonly TokenInvalid: "tokenInvalid";
|
|
917
|
+
readonly TokenNotFound: "tokenNotFound";
|
|
918
|
+
readonly TokenExpired: "tokenExpired";
|
|
919
|
+
readonly TokenAlreadyRedeemed: "tokenAlreadyRedeemed";
|
|
920
|
+
readonly ShareNotFound: "shareNotFound";
|
|
921
|
+
readonly ShareExpired: "shareExpired";
|
|
922
|
+
readonly PinInvalid: "pinInvalid";
|
|
923
|
+
readonly PinExpired: "pinExpired";
|
|
924
|
+
readonly NonceInvalid: "nonceInvalid";
|
|
925
|
+
readonly NonceExpired: "nonceExpired";
|
|
926
|
+
readonly Conflict: "conflict";
|
|
927
|
+
readonly TooManyRequests: "tooManyRequests";
|
|
928
|
+
readonly ServiceUnavailable: "serviceUnavailable";
|
|
929
|
+
readonly InvalidRequest: "invalidRequest";
|
|
930
|
+
readonly InternalError: "internalError";
|
|
931
|
+
};
|
|
932
|
+
export type GuestLinkErrorErrorTypeEnum = typeof GuestLinkErrorErrorTypeEnum[keyof typeof GuestLinkErrorErrorTypeEnum];
|
|
933
|
+
/**
|
|
934
|
+
* Request body for renewing a guest link. Only the share (permission) id is sent; the request is authorized by the guest session cookie when one is present.
|
|
935
|
+
*/
|
|
936
|
+
export interface GuestLinkRenewRequest {
|
|
937
|
+
/**
|
|
938
|
+
* Identifier of the share (permission) the guest was invited to.
|
|
939
|
+
*/
|
|
940
|
+
'permissionId': string;
|
|
941
|
+
}
|
|
942
|
+
/**
|
|
943
|
+
* Response body for a successful guest link authentication: the share (permission) id the guest was invited to and the expiry of the guest session. A session cookie is set via the Set-Cookie header.
|
|
944
|
+
*/
|
|
945
|
+
export interface GuestLinkSessionResponse {
|
|
946
|
+
/**
|
|
947
|
+
* Identifier of the share (permission) the guest was invited to.
|
|
948
|
+
*/
|
|
949
|
+
'permissionId': string;
|
|
950
|
+
/**
|
|
951
|
+
* The date and time when the guest session expires, in UTC. After that the guest has to renew the guest link.
|
|
952
|
+
*/
|
|
953
|
+
'expirationDateTime': string;
|
|
954
|
+
}
|
|
955
|
+
/**
|
|
956
|
+
* Request body for verifying a guest link PIN.
|
|
957
|
+
*/
|
|
958
|
+
export interface GuestLinkVerifyPinRequest {
|
|
959
|
+
/**
|
|
960
|
+
* One-time PIN received from the renewed guest link.
|
|
961
|
+
*/
|
|
962
|
+
'pin': string;
|
|
963
|
+
/**
|
|
964
|
+
* Identifier of the share (permission) the guest was invited to.
|
|
965
|
+
*/
|
|
966
|
+
'permissionId': string;
|
|
967
|
+
}
|
|
968
|
+
/**
|
|
969
|
+
* Request body for verifying a guest link token.
|
|
970
|
+
*/
|
|
971
|
+
export interface GuestLinkVerifyTokenRequest {
|
|
972
|
+
/**
|
|
973
|
+
* One-time guest link token received from the guest link.
|
|
974
|
+
*/
|
|
975
|
+
'token': string;
|
|
976
|
+
}
|
|
825
977
|
/**
|
|
826
978
|
* Hashes of the file\'s binary content, if available. Read-only.
|
|
827
979
|
*/
|
|
@@ -1011,6 +1163,22 @@ export type LockInfoLockTypeEnum = typeof LockInfoLockTypeEnum[keyof typeof Lock
|
|
|
1011
1163
|
export interface MemberReference {
|
|
1012
1164
|
'@odata.id'?: string;
|
|
1013
1165
|
}
|
|
1166
|
+
/**
|
|
1167
|
+
* Provides the details of how to compute a scalar metric over the aggregation `field`, the counterpart of `bucketDefinition` for metric aggregations. When set on an `aggregationOption`, `size` is ignored, and the corresponding `searchAggregation` in the response carries a `@libre.graph.metric` rather than `buckets`. Libregraph extension not present in MS Graph.
|
|
1168
|
+
*/
|
|
1169
|
+
export interface MetricDefinition {
|
|
1170
|
+
/**
|
|
1171
|
+
* The reducer applied to the field values of all matches. Required. `avg` is not a simple reducer (averages of averages are not averages): the backend carries `(sum, count)` internally and emits only the final value on the outermost merge.
|
|
1172
|
+
*/
|
|
1173
|
+
'kind': MetricDefinitionKindEnum;
|
|
1174
|
+
}
|
|
1175
|
+
export declare const MetricDefinitionKindEnum: {
|
|
1176
|
+
readonly Sum: "sum";
|
|
1177
|
+
readonly Min: "min";
|
|
1178
|
+
readonly Max: "max";
|
|
1179
|
+
readonly Avg: "avg";
|
|
1180
|
+
};
|
|
1181
|
+
export type MetricDefinitionKindEnum = typeof MetricDefinitionKindEnum[keyof typeof MetricDefinitionKindEnum];
|
|
1014
1182
|
/**
|
|
1015
1183
|
* Motion Photo metadata. A Motion Photo is a still image with a short video clip appended to the end of the file. The presence of this facet on a driveItem indicates that the item is a Motion Photo; absence indicates it is not. Based on the Google Motion Photo format v1.0 specification: https://developer.android.com/media/platform/motion-photo-format
|
|
1016
1184
|
*/
|
|
@@ -1273,6 +1441,168 @@ export interface RemoteItem {
|
|
|
1273
1441
|
*/
|
|
1274
1442
|
'webUrl'?: string;
|
|
1275
1443
|
}
|
|
1444
|
+
/**
|
|
1445
|
+
* Provides the details of a search aggregation in the search response. Follows the [MS Graph searchAggregation](https://learn.microsoft.com/en-us/graph/api/resources/searchaggregation) resource type.
|
|
1446
|
+
*/
|
|
1447
|
+
export interface SearchAggregation {
|
|
1448
|
+
/**
|
|
1449
|
+
* Defines the field in the request on which the aggregation was computed.
|
|
1450
|
+
*/
|
|
1451
|
+
'field'?: string;
|
|
1452
|
+
/**
|
|
1453
|
+
* Defines the computed buckets for this aggregation. For bucket aggregations they are sorted according to the `sortBy` and `isDescending` specified in the `bucketDefinition` of the corresponding `aggregationOption`; for geohash aggregations they are ordered by `count`, descending.
|
|
1454
|
+
*/
|
|
1455
|
+
'buckets'?: Array<SearchBucket>;
|
|
1456
|
+
'@libre.graph.metric'?: SearchMetric;
|
|
1457
|
+
}
|
|
1458
|
+
/**
|
|
1459
|
+
* Represents a single bucket in a search aggregation result. Follows the [MS Graph searchBucket](https://learn.microsoft.com/en-us/graph/api/resources/searchbucket) resource type.
|
|
1460
|
+
*/
|
|
1461
|
+
export interface SearchBucket {
|
|
1462
|
+
/**
|
|
1463
|
+
* The discrete value of the field that was used to compute the aggregation. For terms aggregations this is the field value. For range aggregations this is a string representation of the range. For geohash aggregations this is a geohash cell.
|
|
1464
|
+
*/
|
|
1465
|
+
'key'?: string;
|
|
1466
|
+
/**
|
|
1467
|
+
* The approximate number of search matches that share the same value specified in the `key` property.
|
|
1468
|
+
*/
|
|
1469
|
+
'count'?: number;
|
|
1470
|
+
/**
|
|
1471
|
+
* A token containing the encoded filter that narrows search matches to this bucket. To use it, pass it as part of the `aggregationFilters` property of a subsequent `searchRequest` in the format `{field}:{aggregationFilterToken}`. The filter matches the bucket `key` exactly and case-sensitively, so the narrowed result set is the set of matches counted in this bucket. For terms buckets the token is the key encoded as lowercase hex of its UTF-8 bytes, prefixed with `ǂǂ` (U+01C2 twice) and wrapped in double quotes, e.g. `\"ǂǂ5361786f6e\"` for the key `Saxon`. For range buckets the token is `range({from}, {to})` with the bounds of the matching `bucketAggregationRange`; an open lower bound is written as `min`, an open upper bound as `max` followed by `to=\"le\"`, e.g. `range(min, 1980)`, `range(1980, 1990)` and `range(2010, max, to=\"le\")`. This is the same encoding MS Graph uses. Geohash buckets carry no token; narrow by location through the search query instead.
|
|
1472
|
+
*/
|
|
1473
|
+
'aggregationFilterToken'?: string;
|
|
1474
|
+
/**
|
|
1475
|
+
* Nested aggregation results, one per sub-aggregation requested on the parent `aggregationOption`. Libregraph extension not present in MS Graph.
|
|
1476
|
+
*/
|
|
1477
|
+
'@libre.graph.subAggregations'?: Array<SearchAggregation>;
|
|
1478
|
+
}
|
|
1479
|
+
/**
|
|
1480
|
+
* Represents an individual search result. Follows the [MS Graph searchHit](https://learn.microsoft.com/en-us/graph/api/resources/searchhit) resource type.
|
|
1481
|
+
*/
|
|
1482
|
+
export interface SearchHit {
|
|
1483
|
+
/**
|
|
1484
|
+
* The internal identifier for the item.
|
|
1485
|
+
*/
|
|
1486
|
+
'hitId'?: string;
|
|
1487
|
+
/**
|
|
1488
|
+
* The rank or the order of the result.
|
|
1489
|
+
*/
|
|
1490
|
+
'rank'?: number;
|
|
1491
|
+
/**
|
|
1492
|
+
* A summary of the result, if a summary is available.
|
|
1493
|
+
*/
|
|
1494
|
+
'summary'?: string;
|
|
1495
|
+
'resource'?: DriveItem;
|
|
1496
|
+
}
|
|
1497
|
+
/**
|
|
1498
|
+
* Contains a collection of search results. Follows the [MS Graph searchHitsContainer](https://learn.microsoft.com/en-us/graph/api/resources/searchhitscontainer) resource type.
|
|
1499
|
+
*/
|
|
1500
|
+
export interface SearchHitsContainer {
|
|
1501
|
+
/**
|
|
1502
|
+
* A collection of the search results, ordered by relevance or, when the request specifies `sortProperties`, by those properties.
|
|
1503
|
+
*/
|
|
1504
|
+
'hits'?: Array<SearchHit>;
|
|
1505
|
+
/**
|
|
1506
|
+
* The total number of results. Note this is not the number of results on the page, but the total number of results satisfying the query.
|
|
1507
|
+
*/
|
|
1508
|
+
'total'?: number;
|
|
1509
|
+
/**
|
|
1510
|
+
* Provides information if more results are available. Based on this information, you can adjust the `from` and `size` properties of the `searchRequest` accordingly.
|
|
1511
|
+
*/
|
|
1512
|
+
'moreResultsAvailable'?: boolean;
|
|
1513
|
+
/**
|
|
1514
|
+
* Contains the collection of aggregations computed based on the provided `aggregationOption` definitions in the request.
|
|
1515
|
+
*/
|
|
1516
|
+
'aggregations'?: Array<SearchAggregation>;
|
|
1517
|
+
}
|
|
1518
|
+
/**
|
|
1519
|
+
* The result of a metric aggregation, the counterpart of `buckets` for aggregations requested with a `@libre.graph.metricDefinition`. Absent for terms, range and geohash aggregations. Libregraph extension not present in MS Graph.
|
|
1520
|
+
*/
|
|
1521
|
+
export interface SearchMetric {
|
|
1522
|
+
/**
|
|
1523
|
+
* Echoes the `kind` of the corresponding `metricDefinition`, allowing consumers (and the search service\'s cross-space merge layer) to pick the right reducer when combining results.
|
|
1524
|
+
*/
|
|
1525
|
+
'kind'?: SearchMetricKindEnum;
|
|
1526
|
+
/**
|
|
1527
|
+
* The scalar result of the metric.
|
|
1528
|
+
*/
|
|
1529
|
+
'value'?: number;
|
|
1530
|
+
}
|
|
1531
|
+
export declare const SearchMetricKindEnum: {
|
|
1532
|
+
readonly Sum: "sum";
|
|
1533
|
+
readonly Min: "min";
|
|
1534
|
+
readonly Max: "max";
|
|
1535
|
+
readonly Avg: "avg";
|
|
1536
|
+
};
|
|
1537
|
+
export type SearchMetricKindEnum = typeof SearchMetricKindEnum[keyof typeof SearchMetricKindEnum];
|
|
1538
|
+
/**
|
|
1539
|
+
* Represents the search query. Follows the [MS Graph searchQuery](https://learn.microsoft.com/en-us/graph/api/resources/searchquery) resource type.
|
|
1540
|
+
*/
|
|
1541
|
+
export interface SearchQuery {
|
|
1542
|
+
/**
|
|
1543
|
+
* The search query string in KQL (Keyword Query Language) format. The query string can contain free-text keywords and property filters. Examples: - `budget report`: free text search - `mediatype:audio`: filter by media type - `audio.artist:\"Saxon\"`: filter by audio metadata - `audio.genre:Rock AND audio.year:1979`: combined filters
|
|
1544
|
+
*/
|
|
1545
|
+
'queryString': string;
|
|
1546
|
+
}
|
|
1547
|
+
export interface SearchQuery200Response {
|
|
1548
|
+
/**
|
|
1549
|
+
* A collection of search response objects, one per request.
|
|
1550
|
+
*/
|
|
1551
|
+
'value'?: Array<SearchResponse>;
|
|
1552
|
+
}
|
|
1553
|
+
export interface SearchQueryRequest {
|
|
1554
|
+
/**
|
|
1555
|
+
* A collection of one or more search requests.
|
|
1556
|
+
*/
|
|
1557
|
+
'requests': Array<SearchRequest>;
|
|
1558
|
+
}
|
|
1559
|
+
/**
|
|
1560
|
+
* Represents an individual search request within a search query. Follows the [MS Graph searchRequest](https://learn.microsoft.com/en-us/graph/api/resources/searchrequest) resource type.
|
|
1561
|
+
*/
|
|
1562
|
+
export interface SearchRequest {
|
|
1563
|
+
/**
|
|
1564
|
+
* One or more types of resources expected in the response. Currently only `driveItem` is supported.
|
|
1565
|
+
*/
|
|
1566
|
+
'entityTypes': Array<SearchRequestEntityTypesEnum>;
|
|
1567
|
+
'query': SearchQuery;
|
|
1568
|
+
/**
|
|
1569
|
+
* Specifies the offset for the search results. Offset 0 returns the very first result. Used together with the `size` property for pagination.
|
|
1570
|
+
*/
|
|
1571
|
+
'from'?: number;
|
|
1572
|
+
/**
|
|
1573
|
+
* The size of the page to be retrieved. The maximum value is 500. Set to 0 to return only aggregations without any hits.
|
|
1574
|
+
*/
|
|
1575
|
+
'size'?: number;
|
|
1576
|
+
/**
|
|
1577
|
+
* Specifies aggregations (also known as refiners or facets) to be returned alongside the search results. Optional.
|
|
1578
|
+
*/
|
|
1579
|
+
'aggregations'?: Array<AggregationOption>;
|
|
1580
|
+
/**
|
|
1581
|
+
* Contains one or more filters to narrow search results to specific buckets of a prior aggregation. Build each filter from the response of a prior search that aggregated on the same field: take the `aggregationFilterToken` of the wanted `searchBucket` and combine it with the field as `{field}:{aggregationFilterToken}`, e.g. `audio.artist:\"ǂǂ5361786f6e\"` for a terms bucket or `audio.year:range(1980, 1990)` for a range bucket. Several buckets of the same field are combined with `{field}:or({aggregationFilterToken},{aggregationFilterToken})`. Whitespace after the commas of `range(...)` and `or(...)` is optional. Multiple filters can be provided as separate array items. This results in a logical AND between the filters. Filters that are not built from server-issued tokens are rejected with `invalidRequest`.
|
|
1582
|
+
*/
|
|
1583
|
+
'aggregationFilters'?: Array<string>;
|
|
1584
|
+
/**
|
|
1585
|
+
* Contains the ordered collection of fields to sort the results on, primary sort key first. At most 5 sort properties. If absent, the results are sorted by relevance. See `sortProperty.name` for the set of sortable fields. Ties are broken by relevance, and results missing the sort property are placed last. Optional.
|
|
1586
|
+
*/
|
|
1587
|
+
'sortProperties'?: Array<SortProperty>;
|
|
1588
|
+
}
|
|
1589
|
+
export declare const SearchRequestEntityTypesEnum: {
|
|
1590
|
+
readonly DriveItem: "driveItem";
|
|
1591
|
+
};
|
|
1592
|
+
export type SearchRequestEntityTypesEnum = typeof SearchRequestEntityTypesEnum[keyof typeof SearchRequestEntityTypesEnum];
|
|
1593
|
+
/**
|
|
1594
|
+
* Represents the response for an individual search request. Follows the [MS Graph searchResponse](https://learn.microsoft.com/en-us/graph/api/resources/searchresponse) resource type.
|
|
1595
|
+
*/
|
|
1596
|
+
export interface SearchResponse {
|
|
1597
|
+
/**
|
|
1598
|
+
* Contains the search terms sent in the initial search query.
|
|
1599
|
+
*/
|
|
1600
|
+
'searchTerms'?: Array<string>;
|
|
1601
|
+
/**
|
|
1602
|
+
* A collection of search result sets. One for each entity type that was queried.
|
|
1603
|
+
*/
|
|
1604
|
+
'hitsContainers'?: Array<SearchHitsContainer>;
|
|
1605
|
+
}
|
|
1276
1606
|
/**
|
|
1277
1607
|
* This resource is used to represent a set of identities associated with various events for an item, such as created by or last modified by.
|
|
1278
1608
|
*/
|
|
@@ -1338,6 +1668,19 @@ export interface SignInActivity {
|
|
|
1338
1668
|
*/
|
|
1339
1669
|
'lastSuccessfulSignInDateTime'?: string;
|
|
1340
1670
|
}
|
|
1671
|
+
/**
|
|
1672
|
+
* Indicates the order to sort search results in. Follows the [MS Graph sortProperty](https://learn.microsoft.com/en-us/graph/api/resources/sortproperty) resource type.
|
|
1673
|
+
*/
|
|
1674
|
+
export interface SortProperty {
|
|
1675
|
+
/**
|
|
1676
|
+
* The name of the property to sort the search results by. Required. Sortable are the scalar search fields of the search hit\'s resource: `name`, `size`, `lastModifiedDateTime`, `mimeType` and the scalar facet properties such as `photo.takenDateTime`, `photo.iso`, `audio.artist`, `audio.year` or `image.width`. Strings sort lexicographically, numbers and dates by value. Multivalued properties (e.g. `@libre.graph.tags`) and unknown properties are rejected with `invalidRequest`.
|
|
1677
|
+
*/
|
|
1678
|
+
'name': string;
|
|
1679
|
+
/**
|
|
1680
|
+
* Set to `true` to specify the sort order as descending. Optional, defaults to `false` (ascending).
|
|
1681
|
+
*/
|
|
1682
|
+
'isDescending'?: boolean;
|
|
1683
|
+
}
|
|
1341
1684
|
/**
|
|
1342
1685
|
* If the current item is also available as a special folder, this facet is returned. Read-only
|
|
1343
1686
|
*/
|
|
@@ -1379,6 +1722,10 @@ export interface Thumbnail {
|
|
|
1379
1722
|
* The width of the thumbnail, in pixels.
|
|
1380
1723
|
*/
|
|
1381
1724
|
'width'?: number;
|
|
1725
|
+
/**
|
|
1726
|
+
* The mime type the thumbnail is served in, e.g. `image/png`. It can differ from the mime type of the item the thumbnail belongs to, for example when the thumbnail is an image taken from inside the item, such as the cover art of an audio file.
|
|
1727
|
+
*/
|
|
1728
|
+
'@libre.graph.mimeType'?: string;
|
|
1382
1729
|
}
|
|
1383
1730
|
/**
|
|
1384
1731
|
* The ThumbnailSet resource is a keyed collection of thumbnail resources. It\'s used to represent a set of thumbnails associated with a DriveItem.
|
|
@@ -4458,6 +4805,126 @@ export declare const ListGroupsExpandEnum: {
|
|
|
4458
4805
|
readonly Members: "members";
|
|
4459
4806
|
};
|
|
4460
4807
|
export type ListGroupsExpandEnum = typeof ListGroupsExpandEnum[keyof typeof ListGroupsExpandEnum];
|
|
4808
|
+
/**
|
|
4809
|
+
* GuestLinksApi - axios parameter creator
|
|
4810
|
+
*/
|
|
4811
|
+
export declare const GuestLinksApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
4812
|
+
/**
|
|
4813
|
+
* Renew a guest link. When the request carries a valid guest session cookie (possibly expired), a new link token and PIN are generated, the renewal event is published so the guest can be notified, and the nonce cookie that binds the PIN to the browser is set. Without a valid session the link token is rotated silently: no new PIN is generated, no nonce cookie is set, and the request is rate limited.
|
|
4814
|
+
* @summary Renew a guest link
|
|
4815
|
+
* @param {GuestLinkRenewRequest} guestLinkRenewRequest
|
|
4816
|
+
* @param {*} [options] Override http request option.
|
|
4817
|
+
* @throws {RequiredError}
|
|
4818
|
+
*/
|
|
4819
|
+
renewGuestLink: (guestLinkRenewRequest: GuestLinkRenewRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4820
|
+
/**
|
|
4821
|
+
* Exchange a PIN and a share id for a guest session.
|
|
4822
|
+
* @summary Verify a guest link PIN
|
|
4823
|
+
* @param {string} hostOcGuestNonce Per-share nonce cookie set by the renew endpoint (`__Host-oc_guest_nonce_<share-hash>`), binding the PIN to the browser that renewed the link.
|
|
4824
|
+
* @param {GuestLinkVerifyPinRequest} guestLinkVerifyPinRequest
|
|
4825
|
+
* @param {*} [options] Override http request option.
|
|
4826
|
+
* @throws {RequiredError}
|
|
4827
|
+
*/
|
|
4828
|
+
verifyGuestLinkPin: (hostOcGuestNonce: string, guestLinkVerifyPinRequest: GuestLinkVerifyPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4829
|
+
/**
|
|
4830
|
+
* Verify a guest link token to obtain a guest session.
|
|
4831
|
+
* @summary Verify a guest link token
|
|
4832
|
+
* @param {GuestLinkVerifyTokenRequest} guestLinkVerifyTokenRequest
|
|
4833
|
+
* @param {*} [options] Override http request option.
|
|
4834
|
+
* @throws {RequiredError}
|
|
4835
|
+
*/
|
|
4836
|
+
verifyGuestLinkToken: (guestLinkVerifyTokenRequest: GuestLinkVerifyTokenRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4837
|
+
};
|
|
4838
|
+
/**
|
|
4839
|
+
* GuestLinksApi - functional programming interface
|
|
4840
|
+
*/
|
|
4841
|
+
export declare const GuestLinksApiFp: (configuration?: Configuration) => {
|
|
4842
|
+
/**
|
|
4843
|
+
* Renew a guest link. When the request carries a valid guest session cookie (possibly expired), a new link token and PIN are generated, the renewal event is published so the guest can be notified, and the nonce cookie that binds the PIN to the browser is set. Without a valid session the link token is rotated silently: no new PIN is generated, no nonce cookie is set, and the request is rate limited.
|
|
4844
|
+
* @summary Renew a guest link
|
|
4845
|
+
* @param {GuestLinkRenewRequest} guestLinkRenewRequest
|
|
4846
|
+
* @param {*} [options] Override http request option.
|
|
4847
|
+
* @throws {RequiredError}
|
|
4848
|
+
*/
|
|
4849
|
+
renewGuestLink(guestLinkRenewRequest: GuestLinkRenewRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
4850
|
+
/**
|
|
4851
|
+
* Exchange a PIN and a share id for a guest session.
|
|
4852
|
+
* @summary Verify a guest link PIN
|
|
4853
|
+
* @param {string} hostOcGuestNonce Per-share nonce cookie set by the renew endpoint (`__Host-oc_guest_nonce_<share-hash>`), binding the PIN to the browser that renewed the link.
|
|
4854
|
+
* @param {GuestLinkVerifyPinRequest} guestLinkVerifyPinRequest
|
|
4855
|
+
* @param {*} [options] Override http request option.
|
|
4856
|
+
* @throws {RequiredError}
|
|
4857
|
+
*/
|
|
4858
|
+
verifyGuestLinkPin(hostOcGuestNonce: string, guestLinkVerifyPinRequest: GuestLinkVerifyPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GuestLinkSessionResponse>>;
|
|
4859
|
+
/**
|
|
4860
|
+
* Verify a guest link token to obtain a guest session.
|
|
4861
|
+
* @summary Verify a guest link token
|
|
4862
|
+
* @param {GuestLinkVerifyTokenRequest} guestLinkVerifyTokenRequest
|
|
4863
|
+
* @param {*} [options] Override http request option.
|
|
4864
|
+
* @throws {RequiredError}
|
|
4865
|
+
*/
|
|
4866
|
+
verifyGuestLinkToken(guestLinkVerifyTokenRequest: GuestLinkVerifyTokenRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GuestLinkSessionResponse>>;
|
|
4867
|
+
};
|
|
4868
|
+
/**
|
|
4869
|
+
* GuestLinksApi - factory interface
|
|
4870
|
+
*/
|
|
4871
|
+
export declare const GuestLinksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4872
|
+
/**
|
|
4873
|
+
* Renew a guest link. When the request carries a valid guest session cookie (possibly expired), a new link token and PIN are generated, the renewal event is published so the guest can be notified, and the nonce cookie that binds the PIN to the browser is set. Without a valid session the link token is rotated silently: no new PIN is generated, no nonce cookie is set, and the request is rate limited.
|
|
4874
|
+
* @summary Renew a guest link
|
|
4875
|
+
* @param {GuestLinkRenewRequest} guestLinkRenewRequest
|
|
4876
|
+
* @param {*} [options] Override http request option.
|
|
4877
|
+
* @throws {RequiredError}
|
|
4878
|
+
*/
|
|
4879
|
+
renewGuestLink(guestLinkRenewRequest: GuestLinkRenewRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4880
|
+
/**
|
|
4881
|
+
* Exchange a PIN and a share id for a guest session.
|
|
4882
|
+
* @summary Verify a guest link PIN
|
|
4883
|
+
* @param {string} hostOcGuestNonce Per-share nonce cookie set by the renew endpoint (`__Host-oc_guest_nonce_<share-hash>`), binding the PIN to the browser that renewed the link.
|
|
4884
|
+
* @param {GuestLinkVerifyPinRequest} guestLinkVerifyPinRequest
|
|
4885
|
+
* @param {*} [options] Override http request option.
|
|
4886
|
+
* @throws {RequiredError}
|
|
4887
|
+
*/
|
|
4888
|
+
verifyGuestLinkPin(hostOcGuestNonce: string, guestLinkVerifyPinRequest: GuestLinkVerifyPinRequest, options?: RawAxiosRequestConfig): AxiosPromise<GuestLinkSessionResponse>;
|
|
4889
|
+
/**
|
|
4890
|
+
* Verify a guest link token to obtain a guest session.
|
|
4891
|
+
* @summary Verify a guest link token
|
|
4892
|
+
* @param {GuestLinkVerifyTokenRequest} guestLinkVerifyTokenRequest
|
|
4893
|
+
* @param {*} [options] Override http request option.
|
|
4894
|
+
* @throws {RequiredError}
|
|
4895
|
+
*/
|
|
4896
|
+
verifyGuestLinkToken(guestLinkVerifyTokenRequest: GuestLinkVerifyTokenRequest, options?: RawAxiosRequestConfig): AxiosPromise<GuestLinkSessionResponse>;
|
|
4897
|
+
};
|
|
4898
|
+
/**
|
|
4899
|
+
* GuestLinksApi - object-oriented interface
|
|
4900
|
+
*/
|
|
4901
|
+
export declare class GuestLinksApi extends BaseAPI {
|
|
4902
|
+
/**
|
|
4903
|
+
* Renew a guest link. When the request carries a valid guest session cookie (possibly expired), a new link token and PIN are generated, the renewal event is published so the guest can be notified, and the nonce cookie that binds the PIN to the browser is set. Without a valid session the link token is rotated silently: no new PIN is generated, no nonce cookie is set, and the request is rate limited.
|
|
4904
|
+
* @summary Renew a guest link
|
|
4905
|
+
* @param {GuestLinkRenewRequest} guestLinkRenewRequest
|
|
4906
|
+
* @param {*} [options] Override http request option.
|
|
4907
|
+
* @throws {RequiredError}
|
|
4908
|
+
*/
|
|
4909
|
+
renewGuestLink(guestLinkRenewRequest: GuestLinkRenewRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
|
|
4910
|
+
/**
|
|
4911
|
+
* Exchange a PIN and a share id for a guest session.
|
|
4912
|
+
* @summary Verify a guest link PIN
|
|
4913
|
+
* @param {string} hostOcGuestNonce Per-share nonce cookie set by the renew endpoint (`__Host-oc_guest_nonce_<share-hash>`), binding the PIN to the browser that renewed the link.
|
|
4914
|
+
* @param {GuestLinkVerifyPinRequest} guestLinkVerifyPinRequest
|
|
4915
|
+
* @param {*} [options] Override http request option.
|
|
4916
|
+
* @throws {RequiredError}
|
|
4917
|
+
*/
|
|
4918
|
+
verifyGuestLinkPin(hostOcGuestNonce: string, guestLinkVerifyPinRequest: GuestLinkVerifyPinRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GuestLinkSessionResponse, any, {}, any>>;
|
|
4919
|
+
/**
|
|
4920
|
+
* Verify a guest link token to obtain a guest session.
|
|
4921
|
+
* @summary Verify a guest link token
|
|
4922
|
+
* @param {GuestLinkVerifyTokenRequest} guestLinkVerifyTokenRequest
|
|
4923
|
+
* @param {*} [options] Override http request option.
|
|
4924
|
+
* @throws {RequiredError}
|
|
4925
|
+
*/
|
|
4926
|
+
verifyGuestLinkToken(guestLinkVerifyTokenRequest: GuestLinkVerifyTokenRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GuestLinkSessionResponse, any, {}, any>>;
|
|
4927
|
+
}
|
|
4461
4928
|
/**
|
|
4462
4929
|
* InvitationsApi - axios parameter creator
|
|
4463
4930
|
*/
|
|
@@ -5343,6 +5810,66 @@ export declare class RoleManagementApi extends BaseAPI {
|
|
|
5343
5810
|
*/
|
|
5344
5811
|
listPermissionRoleDefinitions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UnifiedRoleDefinition[], any, {}, any>>;
|
|
5345
5812
|
}
|
|
5813
|
+
/**
|
|
5814
|
+
* SearchApi - axios parameter creator
|
|
5815
|
+
*/
|
|
5816
|
+
export declare const SearchApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5817
|
+
/**
|
|
5818
|
+
* Run a specified search query. Search results are provided in the response. The search endpoint allows clients to search for resources across all accessible spaces and retrieve aggregated metadata (facets) about the result set. Aggregations can be used to group results by properties such as file type, author, or any indexed metadata field. This is useful for building faceted search UIs or computing statistics about the result set. The query string uses KQL (Keyword Query Language) syntax for filtering. Results are sorted by relevance unless the request specifies `sortProperties`. Modeled on the MS Graph search query endpoint (https://learn.microsoft.com/en-us/graph/api/search-query). Request and response follow the MS Graph resource types; Libregraph additions carry the `@libre.graph.` prefix.
|
|
5819
|
+
* @summary Search for resources
|
|
5820
|
+
* @param {SearchQueryRequest} searchQueryRequest
|
|
5821
|
+
* @param {Set<SearchQueryExpandEnum>} [$expand] Relationships to expand inline on each hit\'s driveItem. Only `thumbnails` is supported, attaching a preview thumbnail set for thumbnailable mime types. Libregraph extension: MS Graph search has no $expand and returns no thumbnails on search hits.
|
|
5822
|
+
* @param {*} [options] Override http request option.
|
|
5823
|
+
* @throws {RequiredError}
|
|
5824
|
+
*/
|
|
5825
|
+
searchQuery: (searchQueryRequest: SearchQueryRequest, $expand?: Set<SearchQueryExpandEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5826
|
+
};
|
|
5827
|
+
/**
|
|
5828
|
+
* SearchApi - functional programming interface
|
|
5829
|
+
*/
|
|
5830
|
+
export declare const SearchApiFp: (configuration?: Configuration) => {
|
|
5831
|
+
/**
|
|
5832
|
+
* Run a specified search query. Search results are provided in the response. The search endpoint allows clients to search for resources across all accessible spaces and retrieve aggregated metadata (facets) about the result set. Aggregations can be used to group results by properties such as file type, author, or any indexed metadata field. This is useful for building faceted search UIs or computing statistics about the result set. The query string uses KQL (Keyword Query Language) syntax for filtering. Results are sorted by relevance unless the request specifies `sortProperties`. Modeled on the MS Graph search query endpoint (https://learn.microsoft.com/en-us/graph/api/search-query). Request and response follow the MS Graph resource types; Libregraph additions carry the `@libre.graph.` prefix.
|
|
5833
|
+
* @summary Search for resources
|
|
5834
|
+
* @param {SearchQueryRequest} searchQueryRequest
|
|
5835
|
+
* @param {Set<SearchQueryExpandEnum>} [$expand] Relationships to expand inline on each hit\'s driveItem. Only `thumbnails` is supported, attaching a preview thumbnail set for thumbnailable mime types. Libregraph extension: MS Graph search has no $expand and returns no thumbnails on search hits.
|
|
5836
|
+
* @param {*} [options] Override http request option.
|
|
5837
|
+
* @throws {RequiredError}
|
|
5838
|
+
*/
|
|
5839
|
+
searchQuery(searchQueryRequest: SearchQueryRequest, $expand?: Set<SearchQueryExpandEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchQuery200Response>>;
|
|
5840
|
+
};
|
|
5841
|
+
/**
|
|
5842
|
+
* SearchApi - factory interface
|
|
5843
|
+
*/
|
|
5844
|
+
export declare const SearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5845
|
+
/**
|
|
5846
|
+
* Run a specified search query. Search results are provided in the response. The search endpoint allows clients to search for resources across all accessible spaces and retrieve aggregated metadata (facets) about the result set. Aggregations can be used to group results by properties such as file type, author, or any indexed metadata field. This is useful for building faceted search UIs or computing statistics about the result set. The query string uses KQL (Keyword Query Language) syntax for filtering. Results are sorted by relevance unless the request specifies `sortProperties`. Modeled on the MS Graph search query endpoint (https://learn.microsoft.com/en-us/graph/api/search-query). Request and response follow the MS Graph resource types; Libregraph additions carry the `@libre.graph.` prefix.
|
|
5847
|
+
* @summary Search for resources
|
|
5848
|
+
* @param {SearchQueryRequest} searchQueryRequest
|
|
5849
|
+
* @param {Set<SearchQueryExpandEnum>} [$expand] Relationships to expand inline on each hit\'s driveItem. Only `thumbnails` is supported, attaching a preview thumbnail set for thumbnailable mime types. Libregraph extension: MS Graph search has no $expand and returns no thumbnails on search hits.
|
|
5850
|
+
* @param {*} [options] Override http request option.
|
|
5851
|
+
* @throws {RequiredError}
|
|
5852
|
+
*/
|
|
5853
|
+
searchQuery(searchQueryRequest: SearchQueryRequest, $expand?: Set<SearchQueryExpandEnum>, options?: RawAxiosRequestConfig): AxiosPromise<SearchQuery200Response>;
|
|
5854
|
+
};
|
|
5855
|
+
/**
|
|
5856
|
+
* SearchApi - object-oriented interface
|
|
5857
|
+
*/
|
|
5858
|
+
export declare class SearchApi extends BaseAPI {
|
|
5859
|
+
/**
|
|
5860
|
+
* Run a specified search query. Search results are provided in the response. The search endpoint allows clients to search for resources across all accessible spaces and retrieve aggregated metadata (facets) about the result set. Aggregations can be used to group results by properties such as file type, author, or any indexed metadata field. This is useful for building faceted search UIs or computing statistics about the result set. The query string uses KQL (Keyword Query Language) syntax for filtering. Results are sorted by relevance unless the request specifies `sortProperties`. Modeled on the MS Graph search query endpoint (https://learn.microsoft.com/en-us/graph/api/search-query). Request and response follow the MS Graph resource types; Libregraph additions carry the `@libre.graph.` prefix.
|
|
5861
|
+
* @summary Search for resources
|
|
5862
|
+
* @param {SearchQueryRequest} searchQueryRequest
|
|
5863
|
+
* @param {Set<SearchQueryExpandEnum>} [$expand] Relationships to expand inline on each hit\'s driveItem. Only `thumbnails` is supported, attaching a preview thumbnail set for thumbnailable mime types. Libregraph extension: MS Graph search has no $expand and returns no thumbnails on search hits.
|
|
5864
|
+
* @param {*} [options] Override http request option.
|
|
5865
|
+
* @throws {RequiredError}
|
|
5866
|
+
*/
|
|
5867
|
+
searchQuery(searchQueryRequest: SearchQueryRequest, $expand?: Set<SearchQueryExpandEnum>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchQuery200Response, any, {}, any>>;
|
|
5868
|
+
}
|
|
5869
|
+
export declare const SearchQueryExpandEnum: {
|
|
5870
|
+
readonly Thumbnails: "thumbnails";
|
|
5871
|
+
};
|
|
5872
|
+
export type SearchQueryExpandEnum = typeof SearchQueryExpandEnum[keyof typeof SearchQueryExpandEnum];
|
|
5346
5873
|
/**
|
|
5347
5874
|
* TagsApi - axios parameter creator
|
|
5348
5875
|
*/
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { GraphRequestOptions } from '../types';
|
|
2
|
+
import type { GuestLinkSessionResponse } from '../generated';
|
|
3
|
+
export interface GuestLinkSession extends GuestLinkSessionResponse {
|
|
4
|
+
serverDateTime?: string;
|
|
5
|
+
}
|
|
6
|
+
export interface GraphGuestLinks {
|
|
7
|
+
verifyGuestLinkToken: (token: string, requestOptions?: GraphRequestOptions) => Promise<GuestLinkSession>;
|
|
8
|
+
verifyGuestLinkPin: (data: {
|
|
9
|
+
pin: string;
|
|
10
|
+
permissionId: string;
|
|
11
|
+
}, requestOptions?: GraphRequestOptions) => Promise<GuestLinkSession>;
|
|
12
|
+
renewGuestLink: (permissionId: string, requestOptions?: GraphRequestOptions) => Promise<void>;
|
|
13
|
+
}
|
|
@@ -8,6 +8,8 @@ import { GraphTags } from './tags';
|
|
|
8
8
|
import { GraphActivities } from './activities';
|
|
9
9
|
import { GraphPermissions } from './permissions';
|
|
10
10
|
import { GraphPhotos } from './photos';
|
|
11
|
+
import { GraphGuestLinks } from './guestLinks';
|
|
12
|
+
export type { GuestLinkSession } from './guestLinks';
|
|
11
13
|
export interface Graph {
|
|
12
14
|
activities: GraphActivities;
|
|
13
15
|
applications: GraphApplications;
|
|
@@ -18,5 +20,6 @@ export interface Graph {
|
|
|
18
20
|
groups: GraphGroups;
|
|
19
21
|
permissions: GraphPermissions;
|
|
20
22
|
photos: GraphPhotos;
|
|
23
|
+
guestLinks: GraphGuestLinks;
|
|
21
24
|
}
|
|
22
25
|
export declare const graph: (baseURI: string, axiosClient: AxiosInstance) => Graph;
|