feat: Support event with long polling (box/box-codegen#807) (#1409)

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "aa448e3", "specHash": "ec8720b", "version": "0.1.0" }
+{ "engineHash": "fa469c0", "specHash": "ec8720b", "version": "0.1.0" }

docs/EventStream.md

@@ -0,0 +1,29 @@
+# Event Stream
+
+The Event Stream class utilizes long-polling to receive real-time events from Box. The SDK provides an easy way to set up and manage the event stream which returns an iterable object and yields events as they are received.
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+- [Event Stream](#event-stream)
+  - [Listening to the Event Stream](#listening-to-the-event-stream)
+  - [Deduplication](#deduplication)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## Listening to the Event Stream
+
+When the `EventStream` is started, it will begin long-polling asynchronously. Events received from the API are then yielded to the caller.
+
+```java
+EventStream stream = client.getEvents().getEventStream();
+for (Event event : stream) {
+  System.out.printf(
+    "Received event: ID=%s, Type=%s, CreatedAt=%s%n\n",event.getEventId(),event.getEventType(),event.getCreatedAt());
+}
+
+```
+
+## Deduplication
+
+The `EventStream` class automatically deduplicates events based on their `eventId`. This means that if the same event is received multiple times, it will only be emitted once to the listeners.

docs/events.md

@@ -3,6 +3,7 @@
 
 - [Get events long poll endpoint](#get-events-long-poll-endpoint)
 - [List user and enterprise events](#list-user-and-enterprise-events)
+- [Get event stream](#get-event-stream)
 
 ## Get events long poll endpoint
 
@@ -107,3 +108,30 @@ chunk, as well as the next `stream_position` that can be
 queried.
 
 
+## Get event stream
+
+Get an event stream for the Box API
+
+This operation is performed by calling function `getEventStream`.
+
+
+
+```
+client.getEvents().getEventStream()
+```
+
+### Arguments
+
+- queryParams `GetEventStreamQueryParams`
+  - Query parameters of getEvents method
+- headers `GetEventStreamHeaders`
+  - Headers of getEvents method
+
+
+### Returns
+
+This function returns a value of type `EventStream`.
+
+
+
+

migration-guides/from-box-java-sdk-gen-v0-to-box-java-sdk-v10.md

@@ -1,4 +1,4 @@
-# Migration guide from beta release (v0.8.0) of the `box-java-sdk-gen` to the v10 version of the `box-java-sdk`
+# Migration guide from beta release (v0.X.Y) of the `box-java-sdk-gen` to the v10 version of the `box-java-sdk`
 
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
@@ -92,6 +92,7 @@ List of changed `OneOf` classes and types associated with them:
 | FileMiniOrFolderMini                                                                       | Resource                                                           |
 | FileOrFolderOrWebLink                                                                      | LegalHoldPolicyAssignedItem/CollaborationItem                      |
 | FileOrFolderScope                                                                          | ResourceScope                                                      |
+| FileOrFolderScopeScopeField                                                                | ResourceScopeScopeField                                            |
 | FileReferenceOrFolderReferenceOrWeblinkReferenceV2025R0                                    | HubItemReferenceV2025R0                                            |
 | GroupMiniOrUserCollaborations                                                              | CollaborationAccessGrantee                                         |
 | IntegrationMappingPartnerItemSlackUnion                                                    | IntegrationMappingPartnerItemSlack                                 |

src/main/java/com/box/sdkgen/box/eventstream/EventStream.java

@@ -0,0 +1,47 @@
+package com.box.sdkgen.box.eventstream;
+
+import com.box.sdkgen.managers.events.EventsManager;
+import com.box.sdkgen.managers.events.GetEventStreamHeaders;
+import com.box.sdkgen.managers.events.GetEventStreamQueryParams;
+import com.box.sdkgen.schemas.event.Event;
+import java.util.Iterator;
+
+public class EventStream implements Iterable<Event> {
+
+  EventStreamIterator iterator;
+
+  private EventStream(Builder builder) {
+    this.iterator =
+        new EventStreamIterator(builder.eventsManager, builder.queryParams, builder.headersInput);
+  }
+
+  @Override
+  public Iterator<Event> iterator() {
+    return this.iterator;
+  }
+
+  public void stop() {
+    this.iterator.stop();
+  }
+
+  public static class Builder {
+    final EventsManager eventsManager;
+    final GetEventStreamQueryParams queryParams;
+    GetEventStreamHeaders headersInput;
+
+    public Builder(EventsManager eventsManager, GetEventStreamQueryParams queryParams) {
+      this.eventsManager = eventsManager;
+      this.queryParams = queryParams;
+      this.headersInput = new GetEventStreamHeaders();
+    }
+
+    public Builder headersInput(GetEventStreamHeaders headersInput) {
+      this.headersInput = headersInput != null ? headersInput : new GetEventStreamHeaders();
+      return this;
+    }
+
+    public EventStream build() {
+      return new EventStream(this);
+    }
+  }
+}