Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .codegen.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{ "engineHash": "91b0f90", "specHash": "ec8720b", "version": "0.1.0" }
{ "engineHash": "fa469c0", "specHash": "60778fb", "version": "0.1.0" }
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Browse the [docs](docs/README.md) or see [API Reference](https://developer.box.c

# Upgrades

The SDK is updated regularly to include new features, enhancements, and bug fixes. If you are upgrading from manual SDK to this new generated SDK checkout the [migration guide](MIGRATION_GUIDE.md) and [changelog](CHANGELOG.md) for more information.
The SDK is updated regularly to include new features, enhancements, and bug fixes. If you are upgrading from manual SDK to this new generated SDK checkout the [migration guide](migration-guides/from-v4-to-v10.md) and [changelog](CHANGELOG.md) for more information.

# Integration Tests

Expand Down
29 changes: 29 additions & 0 deletions docs/EventStream.md
Original file line number Diff line number Diff line change
@@ -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.
28 changes: 28 additions & 0 deletions docs/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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`.




42 changes: 21 additions & 21 deletions docs/hubcollaborations.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# HubCollaborationsManager


- [Get hub collaborations](#get-hub-collaborations)
- [Create hub collaboration](#create-hub-collaboration)
- [Get hub collaboration by collaboration ID](#get-hub-collaboration-by-collaboration-id)
- [Update hub collaboration](#update-hub-collaboration)
- [Remove hub collaboration](#remove-hub-collaboration)
- [Get Box Hub collaborations](#get-box-hub-collaborations)
- [Create Box Hub collaboration](#create-box-hub-collaboration)
- [Get Box Hub collaboration by collaboration ID](#get-box-hub-collaboration-by-collaboration-id)
- [Update Box Hub collaboration](#update-box-hub-collaboration)
- [Remove Box Hub collaboration](#remove-box-hub-collaboration)

## Get hub collaborations
## Get Box Hub collaborations

Retrieves all collaborations for a hub.
Retrieves all collaborations for a Box Hub.

This operation is performed by calling function `getHubCollaborationsV2025R0`.

Expand All @@ -33,12 +33,12 @@ client.getHubCollaborations().getHubCollaborationsV2025R0(new GetHubCollaboratio

This function returns a value of type `HubCollaborationsV2025R0`.

Retrieves the collaborations associated with the specified hub.
Retrieves the collaborations associated with the specified Box Hub.


## Create hub collaboration
## Create Box Hub collaboration

Adds a collaboration for a single user or a single group to a hub.
Adds a collaboration for a single user or a single group to a Box Hub.

Collaborations can be created using email address, user IDs, or group IDs.

Expand All @@ -64,12 +64,12 @@ client.getHubCollaborations().createHubCollaborationV2025R0(new HubCollaboration

This function returns a value of type `HubCollaborationV2025R0`.

Returns a new hub collaboration object.
Returns a new Box Hub collaboration object.


## Get hub collaboration by collaboration ID
## Get Box Hub collaboration by collaboration ID

Retrieves details for a hub collaboration by collaboration ID.
Retrieves details for a Box Hub collaboration by collaboration ID.

This operation is performed by calling function `getHubCollaborationByIdV2025R0`.

Expand All @@ -93,13 +93,13 @@ client.getHubCollaborations().getHubCollaborationByIdV2025R0(createdCollaboratio

This function returns a value of type `HubCollaborationV2025R0`.

Returns a hub collaboration object.
Returns a Box Hub collaboration object.


## Update hub collaboration
## Update Box Hub collaboration

Updates a hub collaboration.
Can be used to change the hub role.
Updates a Box Hub collaboration.
Can be used to change the Box Hub role.

This operation is performed by calling function `updateHubCollaborationByIdV2025R0`.

Expand All @@ -125,12 +125,12 @@ client.getHubCollaborations().updateHubCollaborationByIdV2025R0(createdCollabora

This function returns a value of type `HubCollaborationV2025R0`.

Returns an updated hub collaboration object.
Returns an updated Box Hub collaboration object.


## Remove hub collaboration
## Remove Box Hub collaboration

Deletes a single hub collaboration.
Deletes a single Box Hub collaboration.

This operation is performed by calling function `deleteHubCollaborationByIdV2025R0`.

Expand All @@ -154,7 +154,7 @@ client.getHubCollaborations().deleteHubCollaborationByIdV2025R0(createdCollabora

This function returns a value of type `void`.

A blank response is returned if the hub collaboration was
A blank response is returned if the Box Hub collaboration was
successfully deleted.


14 changes: 7 additions & 7 deletions docs/hubitems.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# HubItemsManager


- [Get hub items](#get-hub-items)
- [Manage hub items](#manage-hub-items)
- [Get Box Hub items](#get-box-hub-items)
- [Manage Box Hub items](#manage-box-hub-items)

## Get hub items
## Get Box Hub items

Retrieves all items associated with a Hub.
Retrieves all items associated with a Box Hub.

This operation is performed by calling function `getHubItemsV2025R0`.

Expand All @@ -30,12 +30,12 @@ client.getHubItems().getHubItemsV2025R0(new GetHubItemsV2025R0QueryParams(create

This function returns a value of type `HubItemsV2025R0`.

Retrieves the items associated with the specified Hub.
Retrieves the items associated with the specified Box Hub.


## Manage hub items
## Manage Box Hub items

Adds and/or removes Hub items from a Hub.
Adds and/or removes Box Hub items from a Box Hub.

This operation is performed by calling function `manageHubItemsV2025R0`.

Expand Down
48 changes: 24 additions & 24 deletions docs/hubs.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# HubsManager


- [List all hubs](#list-all-hubs)
- [Create hub](#create-hub)
- [List all hubs for requesting enterprise](#list-all-hubs-for-requesting-enterprise)
- [Get hub information by ID](#get-hub-information-by-id)
- [Update hub information by ID](#update-hub-information-by-id)
- [Delete hub](#delete-hub)
- [Copy hub](#copy-hub)
- [List all Box Hubs](#list-all-box-hubs)
- [Create Box Hub](#create-box-hub)
- [List all Box Hubs for requesting enterprise](#list-all-box-hubs-for-requesting-enterprise)
- [Get Box Hub information by ID](#get-box-hub-information-by-id)
- [Update Box Hub information by ID](#update-box-hub-information-by-id)
- [Delete Box Hub](#delete-box-hub)
- [Copy Box Hub](#copy-box-hub)

## List all hubs
## List all Box Hubs

Retrieves all hubs for requesting user.
Retrieves all Box Hubs for requesting user.

This operation is performed by calling function `getHubsV2025R0`.

Expand All @@ -35,12 +35,12 @@ client.getHubs().getHubsV2025R0(new GetHubsV2025R0QueryParams.Builder().scope("a

This function returns a value of type `HubsV2025R0`.

Returns all hubs for the given user or enterprise.
Returns all Box Hubs for the given user or enterprise.


## Create hub
## Create Box Hub

Creates a new Hub.
Creates a new Box Hub.

This operation is performed by calling function `createHubV2025R0`.

Expand All @@ -67,9 +67,9 @@ This function returns a value of type `HubV2025R0`.
Returns a new Hub object.


## List all hubs for requesting enterprise
## List all Box Hubs for requesting enterprise

Retrieves all hubs for a given enterprise.
Retrieves all Box Hubs for a given enterprise.

Admins or Hub Co-admins of an enterprise
with GCM scope can make this call.
Expand All @@ -96,12 +96,12 @@ client.getHubs().getEnterpriseHubsV2025R0(new GetEnterpriseHubsV2025R0QueryParam

This function returns a value of type `HubsV2025R0`.

Returns all hubs for the given user or enterprise.
Returns all Box Hubs for the given user or enterprise.


## Get hub information by ID
## Get Box Hub information by ID

Retrieves details for a hub by its ID.
Retrieves details for a Box Hub by its ID.

This operation is performed by calling function `getHubByIdV2025R0`.

Expand All @@ -128,9 +128,9 @@ This function returns a value of type `HubV2025R0`.
Returns a hub object.


## Update hub information by ID
## Update Box Hub information by ID

Updates a Hub. Can be used to change title, description, or Hub settings.
Updates a Box Hub. Can be used to change title, description, or Box Hub settings.

This operation is performed by calling function `updateHubByIdV2025R0`.

Expand Down Expand Up @@ -159,9 +159,9 @@ This function returns a value of type `HubV2025R0`.
Returns a Hub object.


## Delete hub
## Delete Box Hub

Deletes a single hub.
Deletes a single Box Hub.

This operation is performed by calling function `deleteHubByIdV2025R0`.

Expand Down Expand Up @@ -189,11 +189,11 @@ A blank response is returned if the hub was
successfully deleted.


## Copy hub
## Copy Box Hub

Creates a copy of a Hub.
Creates a copy of a Box Hub.

The original Hub will not be modified.
The original Box Hub will not be modified.

This operation is performed by calling function `copyHubV2025R0`.

Expand Down
Loading