docs: Query insights API (box/box-openapi#610)

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "2cee311", "specHash": "54953fe", "version": "10.13.0" }
+{ "engineHash": "2cee311", "specHash": "cc375ad", "version": "10.13.0" }

docs/README.md

@@ -62,6 +62,7 @@ the SDK are available by topic:
 - [Metadata taxonomies](metadataTaxonomies.md)
 - [Metadata templates](metadataTemplates.md)
 - [Notes](notes.md)
+- [Query](query.md)
 - [Recent items](recentItems.md)
 - [Retention policies](retentionPolicies.md)
 - [Retention policy assignments](retentionPolicyAssignments.md)

docs/query.md

@@ -0,0 +1,55 @@
+# QueryManager
+
+- [Query for Box items](#query-for-box-items)
+- [Create insights for Box items](#create-insights-for-box-items)
+
+## Query for Box items
+
+Runs a query to discover Box items using a logical predicate that can filter
+across item fields and metadata templates. Results can be sorted, paginated,
+and shaped to include additional item or metadata fields.
+
+This operation is performed by calling function `createQueryV2026R0`.
+
+See the endpoint docs at
+[API Reference](https://developer.box.com/reference/v2026.0/post-query/).
+
+_Currently we don't have an example for calling `createQueryV2026R0` in integration tests_
+
+### Arguments
+
+- requestBody `QueryRequestBodyV2026R0`
+  - Request body of createQueryV2026R0 method
+- optionalsInput `CreateQueryV2026R0OptionalsInput`
+
+### Returns
+
+This function returns a value of type `QueryResultsV2026R0`.
+
+Returns a paginated list of items matching the query.
+
+## Create insights for Box items
+
+Computes aggregated metrics over Box items matching a query predicate.
+Filters are applied first, followed by optional grouping, after which the
+requested metrics (such as `sum`, `avg`, `min`, `max`, and `count`) are
+computed for each resulting group or over the entire filtered dataset.
+
+This operation is performed by calling function `createQueryInsightV2026R0`.
+
+See the endpoint docs at
+[API Reference](https://developer.box.com/reference/v2026.0/post-query-insights/).
+
+_Currently we don't have an example for calling `createQueryInsightV2026R0` in integration tests_
+
+### Arguments
+
+- requestBody `QueryInsightsRequestBodyV2026R0`
+  - Request body of createQueryInsightV2026R0 method
+- optionalsInput `CreateQueryInsightV2026R0OptionalsInput`
+
+### Returns
+
+This function returns a value of type `QueryInsightsV2026R0`.
+
+Returns the computed insight entries.

src/client.ts

@@ -87,6 +87,7 @@ import { ArchivesManager } from './managers/archives';
 import { ExternalUsersManager } from './managers/externalUsers';
 import { AutomateWorkflowsManager } from './managers/automateWorkflows';
 import { NotesManager } from './managers/notes';
+import { QueryManager } from './managers/query';
 import { Authentication } from './networking/auth';
 import { NetworkSession } from './networking/network';
 import { BoxSdkError } from './box/errors';
@@ -194,6 +195,7 @@ export class BoxClient {
   readonly externalUsers: ExternalUsersManager;
   readonly automateWorkflows: AutomateWorkflowsManager;
   readonly notes: NotesManager;
+  readonly query: QueryManager;
   constructor(
     fields: Omit<
       BoxClient,
@@ -282,6 +284,7 @@ export class BoxClient {
       | 'externalUsers'
       | 'automateWorkflows'
       | 'notes'
+      | 'query'
       | 'networkSession'
       | 'makeRequest'
       | 'withAsUserHeader'
@@ -647,6 +650,10 @@ export class BoxClient {
       auth: this.auth,
       networkSession: this.networkSession,
     });
+    this.query = new QueryManager({
+      auth: this.auth,
+      networkSession: this.networkSession,
+    });
   }
   /**
    * Make a custom http request using the client authentication and network session.

src/managers/index.ts

@@ -83,3 +83,4 @@ export * from './archives';
 export * from './externalUsers';
 export * from './automateWorkflows';
 export * from './notes';
+export * from './query';