Skip to content

Commit 759cf57

Browse files
box-sdk-buildbox-sdk-build
committed
test: add tests for new hub endpoints and hub items (box/box-codegen#766)
1 parent ff145f4 commit 759cf57

File tree

9 files changed

+207
-52
lines changed

9 files changed

+207
-52
lines changed

‎.codegen.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{ "engineHash": "2ecc24a", "specHash": "eaa9cf0", "version": "0.7.0" }
1+
{ "engineHash": "66d6f32", "specHash": "eaa9cf0", "version": "0.7.0" }

‎docs/hubitems.md‎

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,10 @@ This operation is performed by calling function `getHubItemsV2025R0`.
1313
See the endpoint docs at
1414
[API Reference](https://developer.box.com/reference/v2025.0/get-hub-items/).
1515

16-
*Currently we don't have an example for calling `getHubItemsV2025R0` in integration tests*
16+
<!-- sample get_hub_items_v2025.0 -->
17+
```
18+
client.getHubItems().getHubItemsV2025R0(new GetHubItemsV2025R0QueryParams(createdHub.getId()))
19+
```
1720

1821
### Arguments
1922

@@ -34,21 +37,24 @@ Retrieves the items associated with the specified Hub.
3437

3538
Adds and/or removes Hub items from a Hub.
3639

37-
This operation is performed by calling function `createHubManageItemV2025R0`.
40+
This operation is performed by calling function `manageHubItemsV2025R0`.
3841

3942
See the endpoint docs at
4043
[API Reference](https://developer.box.com/reference/v2025.0/post-hubs-id-manage-items/).
4144

42-
*Currently we don't have an example for calling `createHubManageItemV2025R0` in integration tests*
45+
<!-- sample post_hubs_id_manage_items_v2025.0 -->
46+
```
47+
client.getHubItems().manageHubItemsV2025R0(createdHub.getId(), new HubItemsManageRequestV2025R0.Builder().operations(Arrays.asList(new HubItemOperationV2025R0(HubItemOperationV2025R0ActionField.ADD, new FolderReferenceV2025R0(folder.getId())))).build())
48+
```
4349

4450
### Arguments
4551

4652
- hubId `String`
4753
- The unique identifier that represent a hub. The ID for any hub can be determined by visiting this hub in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/hubs/123` the `hub_id` is `123`. Example: "12345"
4854
- requestBody `HubItemsManageRequestV2025R0`
49-
- Request body of createHubManageItemV2025R0 method
50-
- headers `CreateHubManageItemV2025R0Headers`
51-
- Headers of createHubManageItemV2025R0 method
55+
- Request body of manageHubItemsV2025R0 method
56+
- headers `ManageHubItemsV2025R0Headers`
57+
- Headers of manageHubItemsV2025R0 method
5258

5359

5460
### Returns

‎docs/hubs.md‎

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,10 @@ This operation is performed by calling function `createHubV2025R0`.
4747
See the endpoint docs at
4848
[API Reference](https://developer.box.com/reference/v2025.0/post-hubs/).
4949

50-
*Currently we don't have an example for calling `createHubV2025R0` in integration tests*
50+
<!-- sample post_hubs_v2025.0 -->
51+
```
52+
client.getHubs().createHubV2025R0(new HubCreateRequestV2025R0.Builder(hubTitle).description(hubDescription).build())
53+
```
5154

5255
### Arguments
5356

@@ -107,7 +110,7 @@ See the endpoint docs at
107110

108111
<!-- sample get_hubs_id_v2025.0 -->
109112
```
110-
client.getHubs().getHubByIdV2025R0(userHub.getId())
113+
client.getHubs().getHubByIdV2025R0(hubId)
111114
```
112115

113116
### Arguments
@@ -134,7 +137,10 @@ This operation is performed by calling function `updateHubByIdV2025R0`.
134137
See the endpoint docs at
135138
[API Reference](https://developer.box.com/reference/v2025.0/put-hubs-id/).
136139

137-
*Currently we don't have an example for calling `updateHubByIdV2025R0` in integration tests*
140+
<!-- sample put_hubs_id_v2025.0 -->
141+
```
142+
client.getHubs().updateHubByIdV2025R0(hubId, new HubUpdateRequestV2025R0.Builder().title(newHubTitle).description(newHubDescription).build())
143+
```
138144

139145
### Arguments
140146

@@ -164,7 +170,7 @@ See the endpoint docs at
164170

165171
<!-- sample delete_hubs_id_v2025.0 -->
166172
```
167-
client.getHubs().deleteHubByIdV2025R0(hub.getId())
173+
client.getHubs().deleteHubByIdV2025R0(hubId)
168174
```
169175

170176
### Arguments
@@ -189,21 +195,24 @@ Creates a copy of a Hub.
189195

190196
The original Hub will not be modified.
191197

192-
This operation is performed by calling function `createHubCopyV2025R0`.
198+
This operation is performed by calling function `copyHubV2025R0`.
193199

194200
See the endpoint docs at
195201
[API Reference](https://developer.box.com/reference/v2025.0/post-hubs-id-copy/).
196202

197-
*Currently we don't have an example for calling `createHubCopyV2025R0` in integration tests*
203+
<!-- sample post_hubs_id_copy_v2025.0 -->
204+
```
205+
client.getHubs().copyHubV2025R0(createdHub.getId(), new HubCopyRequestV2025R0.Builder().title(copiedHubTitle).description(copiedHubDescription).build())
206+
```
198207

199208
### Arguments
200209

201210
- hubId `String`
202211
- The unique identifier that represent a hub. The ID for any hub can be determined by visiting this hub in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/hubs/123` the `hub_id` is `123`. Example: "12345"
203212
- requestBody `HubCopyRequestV2025R0`
204-
- Request body of createHubCopyV2025R0 method
205-
- headers `CreateHubCopyV2025R0Headers`
206-
- Headers of createHubCopyV2025R0 method
213+
- Request body of copyHubV2025R0 method
214+
- headers `CopyHubV2025R0Headers`
215+
- Headers of copyHubV2025R0 method
207216

208217

209218
### Returns

‎src/main/java/com/box/sdkgen/managers/hubitems/HubItemsManager.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,15 +66,15 @@ public HubItemsV2025R0 getHubItemsV2025R0(
6666
return JsonManager.deserialize(response.getData(), HubItemsV2025R0.class);
6767
}
6868

69-
public HubItemsManageResponseV2025R0 createHubManageItemV2025R0(
69+
public HubItemsManageResponseV2025R0 manageHubItemsV2025R0(
7070
String hubId, HubItemsManageRequestV2025R0 requestBody) {
71-
return createHubManageItemV2025R0(hubId, requestBody, new CreateHubManageItemV2025R0Headers());
71+
return manageHubItemsV2025R0(hubId, requestBody, new ManageHubItemsV2025R0Headers());
7272
}
7373

74-
public HubItemsManageResponseV2025R0 createHubManageItemV2025R0(
74+
public HubItemsManageResponseV2025R0 manageHubItemsV2025R0(
7575
String hubId,
7676
HubItemsManageRequestV2025R0 requestBody,
77-
CreateHubManageItemV2025R0Headers headers) {
77+
ManageHubItemsV2025R0Headers headers) {
7878
Map<String, String> headersMap =
7979
prepareParams(
8080
mergeMaps(

src/main/java/com/box/sdkgen/managers/hubitems/CreateHubManageItemV2025R0Headers.java renamed to src/main/java/com/box/sdkgen/managers/hubitems/ManageHubItemsV2025R0Headers.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@
66
import com.box.sdkgen.serialization.json.EnumWrapper;
77
import java.util.Map;
88

9-
public class CreateHubManageItemV2025R0Headers {
9+
public class ManageHubItemsV2025R0Headers {
1010

1111
public EnumWrapper<BoxVersionHeaderV2025R0> boxVersion;
1212

1313
public Map<String, String> extraHeaders;
1414

15-
public CreateHubManageItemV2025R0Headers() {
15+
public ManageHubItemsV2025R0Headers() {
1616
this.boxVersion = new EnumWrapper<BoxVersionHeaderV2025R0>(BoxVersionHeaderV2025R0._2025_0);
1717
this.extraHeaders = mapOf();
1818
}
1919

20-
protected CreateHubManageItemV2025R0Headers(Builder builder) {
20+
protected ManageHubItemsV2025R0Headers(Builder builder) {
2121
this.boxVersion = builder.boxVersion;
2222
this.extraHeaders = builder.extraHeaders;
2323
}
@@ -56,8 +56,8 @@ public Builder extraHeaders(Map<String, String> extraHeaders) {
5656
return this;
5757
}
5858

59-
public CreateHubManageItemV2025R0Headers build() {
60-
return new CreateHubManageItemV2025R0Headers(this);
59+
public ManageHubItemsV2025R0Headers build() {
60+
return new ManageHubItemsV2025R0Headers(this);
6161
}
6262
}
6363
}

src/main/java/com/box/sdkgen/managers/hubs/CreateHubCopyV2025R0Headers.java renamed to src/main/java/com/box/sdkgen/managers/hubs/CopyHubV2025R0Headers.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@
66
import com.box.sdkgen.serialization.json.EnumWrapper;
77
import java.util.Map;
88

9-
public class CreateHubCopyV2025R0Headers {
9+
public class CopyHubV2025R0Headers {
1010

1111
public EnumWrapper<BoxVersionHeaderV2025R0> boxVersion;
1212

1313
public Map<String, String> extraHeaders;
1414

15-
public CreateHubCopyV2025R0Headers() {
15+
public CopyHubV2025R0Headers() {
1616
this.boxVersion = new EnumWrapper<BoxVersionHeaderV2025R0>(BoxVersionHeaderV2025R0._2025_0);
1717
this.extraHeaders = mapOf();
1818
}
1919

20-
protected CreateHubCopyV2025R0Headers(Builder builder) {
20+
protected CopyHubV2025R0Headers(Builder builder) {
2121
this.boxVersion = builder.boxVersion;
2222
this.extraHeaders = builder.extraHeaders;
2323
}
@@ -56,8 +56,8 @@ public Builder extraHeaders(Map<String, String> extraHeaders) {
5656
return this;
5757
}
5858

59-
public CreateHubCopyV2025R0Headers build() {
60-
return new CreateHubCopyV2025R0Headers(this);
59+
public CopyHubV2025R0Headers build() {
60+
return new CopyHubV2025R0Headers(this);
6161
}
6262
}
6363
}

‎src/main/java/com/box/sdkgen/managers/hubs/HubsManager.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -244,12 +244,12 @@ public void deleteHubByIdV2025R0(String hubId, DeleteHubByIdV2025R0Headers heade
244244
.build());
245245
}
246246

247-
public HubV2025R0 createHubCopyV2025R0(String hubId, HubCopyRequestV2025R0 requestBody) {
248-
return createHubCopyV2025R0(hubId, requestBody, new CreateHubCopyV2025R0Headers());
247+
public HubV2025R0 copyHubV2025R0(String hubId, HubCopyRequestV2025R0 requestBody) {
248+
return copyHubV2025R0(hubId, requestBody, new CopyHubV2025R0Headers());
249249
}
250250

251-
public HubV2025R0 createHubCopyV2025R0(
252-
String hubId, HubCopyRequestV2025R0 requestBody, CreateHubCopyV2025R0Headers headers) {
251+
public HubV2025R0 copyHubV2025R0(
252+
String hubId, HubCopyRequestV2025R0 requestBody, CopyHubV2025R0Headers headers) {
253253
Map<String, String> headersMap =
254254
prepareParams(
255255
mergeMaps(

‎src/test/java/com/box/sdkgen/test/hubitems/HubItemsITest.java‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
package com.box.sdkgen.test.hubitems;
2+
3+
import static com.box.sdkgen.internal.utils.UtilsManager.convertToString;
4+
import static com.box.sdkgen.internal.utils.UtilsManager.getEnvVar;
5+
import static com.box.sdkgen.internal.utils.UtilsManager.getUuid;
6+
import static com.box.sdkgen.test.commons.CommonsManager.getDefaultClientWithUserSubject;
7+
8+
import com.box.sdkgen.client.BoxClient;
9+
import com.box.sdkgen.managers.folders.CreateFolderRequestBody;
10+
import com.box.sdkgen.managers.folders.CreateFolderRequestBodyParentField;
11+
import com.box.sdkgen.managers.hubitems.GetHubItemsV2025R0QueryParams;
12+
import com.box.sdkgen.schemas.folderfull.FolderFull;
13+
import com.box.sdkgen.schemas.v2025r0.folderreferencev2025r0.FolderReferenceV2025R0;
14+
import com.box.sdkgen.schemas.v2025r0.hubcreaterequestv2025r0.HubCreateRequestV2025R0;
15+
import com.box.sdkgen.schemas.v2025r0.hubitemoperationresultv2025r0.HubItemOperationResultV2025R0;
16+
import com.box.sdkgen.schemas.v2025r0.hubitemoperationv2025r0.HubItemOperationV2025R0;
17+
import com.box.sdkgen.schemas.v2025r0.hubitemoperationv2025r0.HubItemOperationV2025R0ActionField;
18+
import com.box.sdkgen.schemas.v2025r0.hubitemsmanagerequestv2025r0.HubItemsManageRequestV2025R0;
19+
import com.box.sdkgen.schemas.v2025r0.hubitemsmanageresponsev2025r0.HubItemsManageResponseV2025R0;
20+
import com.box.sdkgen.schemas.v2025r0.hubitemsv2025r0.HubItemsV2025R0;
21+
import com.box.sdkgen.schemas.v2025r0.hubv2025r0.HubV2025R0;
22+
import java.util.Arrays;
23+
import org.junit.jupiter.api.Test;
24+
25+
public class HubItemsITest {
26+
27+
private static final BoxClient client = getDefaultClientWithUserSubject(getEnvVar("USER_ID"));
28+
29+
@Test
30+
public void testCreateDeleteGetHubItems() {
31+
String hubTitle = getUuid();
32+
FolderFull folder =
33+
client
34+
.getFolders()
35+
.createFolder(
36+
new CreateFolderRequestBody(
37+
getUuid(), new CreateFolderRequestBodyParentField("0")));
38+
HubV2025R0 createdHub =
39+
client.getHubs().createHubV2025R0(new HubCreateRequestV2025R0(hubTitle));
40+
HubItemsV2025R0 hubItemsBeforeAdd =
41+
client
42+
.getHubItems()
43+
.getHubItemsV2025R0(new GetHubItemsV2025R0QueryParams(createdHub.getId()));
44+
assert hubItemsBeforeAdd.getEntries().size() == 0;
45+
HubItemsManageResponseV2025R0 addedHubItems =
46+
client
47+
.getHubItems()
48+
.manageHubItemsV2025R0(
49+
createdHub.getId(),
50+
new HubItemsManageRequestV2025R0.Builder()
51+
.operations(
52+
Arrays.asList(
53+
new HubItemOperationV2025R0(
54+
HubItemOperationV2025R0ActionField.ADD,
55+
new FolderReferenceV2025R0(folder.getId()))))
56+
.build());
57+
HubItemOperationResultV2025R0 addedHubItem = addedHubItems.getOperations().get(0);
58+
assert convertToString(addedHubItem.getAction()).equals("add");
59+
assert addedHubItem.getStatus() == 200;
60+
assert addedHubItem.getItem().getId().equals(folder.getId());
61+
assert addedHubItem.getItem().getType().equals("folder");
62+
HubItemsV2025R0 hubItemsAfterAdd =
63+
client
64+
.getHubItems()
65+
.getHubItemsV2025R0(new GetHubItemsV2025R0QueryParams(createdHub.getId()));
66+
assert hubItemsAfterAdd.getEntries().size() == 1;
67+
HubItemsManageResponseV2025R0 removedHubItems =
68+
client
69+
.getHubItems()
70+
.manageHubItemsV2025R0(
71+
createdHub.getId(),
72+
new HubItemsManageRequestV2025R0.Builder()
73+
.operations(
74+
Arrays.asList(
75+
new HubItemOperationV2025R0(
76+
HubItemOperationV2025R0ActionField.REMOVE,
77+
new FolderReferenceV2025R0(folder.getId()))))
78+
.build());
79+
HubItemOperationResultV2025R0 removedHubItem = removedHubItems.getOperations().get(0);
80+
assert convertToString(removedHubItem.getAction()).equals("remove");
81+
assert removedHubItem.getStatus() == 200;
82+
assert removedHubItem.getItem().getId().equals(folder.getId());
83+
assert removedHubItem.getItem().getType().equals("folder");
84+
HubItemsV2025R0 hubItemsAfterRemove =
85+
client
86+
.getHubItems()
87+
.getHubItemsV2025R0(new GetHubItemsV2025R0QueryParams(createdHub.getId()));
88+
assert hubItemsAfterRemove.getEntries().size() == 0;
89+
client.getHubs().deleteHubByIdV2025R0(createdHub.getId());
90+
client.getFolders().deleteFolderById(folder.getId());
91+
}
92+
}

0 commit comments

Comments
 (0)