docs: Shield Lists documentation (box/box-openapi#528)

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "20cb559", "specHash": "a54170e", "version": "0.7.0" }
+{ "engineHash": "20cb559", "specHash": "630fc85", "version": "0.7.0" }

docs/README.md

@@ -58,6 +58,7 @@ the SDK are available by topic:
 * [Shieldinformationbarriersegmentmembers](shieldinformationbarriersegmentmembers.md)
 * [Shieldinformationbarriersegmentrestrictions](shieldinformationbarriersegmentrestrictions.md)
 * [Shieldinformationbarriersegments](shieldinformationbarriersegments.md)
+* [Shieldlists](shieldlists.md)
 * [Signrequests](signrequests.md)
 * [Signtemplates](signtemplates.md)
 * [Skills](skills.md)

docs/shieldlists.md

@@ -0,0 +1,139 @@
+# ShieldListsManager
+
+
+- [Get all shield lists in enterprise](#get-all-shield-lists-in-enterprise)
+- [Create shield list](#create-shield-list)
+- [Get single shield list by shield list id](#get-single-shield-list-by-shield-list-id)
+- [Delete single shield list by shield list id](#delete-single-shield-list-by-shield-list-id)
+- [Update shield list](#update-shield-list)
+
+## Get all shield lists in enterprise
+
+Retrieves all shield lists in the enterprise.
+
+This operation is performed by calling function `getShieldListsV2025R0`.
+
+See the endpoint docs at
+[API Reference](https://developer.box.com/reference/v2025.0/get-shield-lists/).
+
+*Currently we don't have an example for calling `getShieldListsV2025R0` in integration tests*
+
+### Arguments
+
+- headers `GetShieldListsV2025R0Headers`
+  - Headers of getShieldListsV2025R0 method
+
+
+### Returns
+
+This function returns a value of type `ShieldListsV2025R0`.
+
+Returns the list of shield list objects.
+
+
+## Create shield list
+
+Creates a shield list.
+
+This operation is performed by calling function `createShieldListV2025R0`.
+
+See the endpoint docs at
+[API Reference](https://developer.box.com/reference/v2025.0/post-shield-lists/).
+
+*Currently we don't have an example for calling `createShieldListV2025R0` in integration tests*
+
+### Arguments
+
+- requestBody `ShieldListsCreateV2025R0`
+  - Request body of createShieldListV2025R0 method
+- headers `CreateShieldListV2025R0Headers`
+  - Headers of createShieldListV2025R0 method
+
+
+### Returns
+
+This function returns a value of type `ShieldListV2025R0`.
+
+Returns the shield list object.
+
+
+## Get single shield list by shield list id
+
+Retrieves a single shield list by its ID.
+
+This operation is performed by calling function `getShieldListByIdV2025R0`.
+
+See the endpoint docs at
+[API Reference](https://developer.box.com/reference/v2025.0/get-shield-lists-id/).
+
+*Currently we don't have an example for calling `getShieldListByIdV2025R0` in integration tests*
+
+### Arguments
+
+- shieldListId `String`
+  - The unique identifier that represents a shield list. The ID for any Shield List can be determined by the response from the endpoint fetching all shield lists for the enterprise. Example: "90fb0e17-c332-40ed-b4f9-fa8908fbbb24 "
+- headers `GetShieldListByIdV2025R0Headers`
+  - Headers of getShieldListByIdV2025R0 method
+
+
+### Returns
+
+This function returns a value of type `ShieldListV2025R0`.
+
+Returns the shield list object.
+
+
+## Delete single shield list by shield list id
+
+Delete a single shield list by its ID.
+
+This operation is performed by calling function `deleteShieldListByIdV2025R0`.
+
+See the endpoint docs at
+[API Reference](https://developer.box.com/reference/v2025.0/delete-shield-lists-id/).
+
+*Currently we don't have an example for calling `deleteShieldListByIdV2025R0` in integration tests*
+
+### Arguments
+
+- shieldListId `String`
+  - The unique identifier that represents a shield list. The ID for any Shield List can be determined by the response from the endpoint fetching all shield lists for the enterprise. Example: "90fb0e17-c332-40ed-b4f9-fa8908fbbb24 "
+- headers `DeleteShieldListByIdV2025R0Headers`
+  - Headers of deleteShieldListByIdV2025R0 method
+
+
+### Returns
+
+This function returns a value of type `void`.
+
+Shield List correctly removed. No content in response.
+
+
+## Update shield list
+
+Updates a shield list.
+
+This operation is performed by calling function `updateShieldListByIdV2025R0`.
+
+See the endpoint docs at
+[API Reference](https://developer.box.com/reference/v2025.0/put-shield-lists-id/).
+
+*Currently we don't have an example for calling `updateShieldListByIdV2025R0` in integration tests*
+
+### Arguments
+
+- shieldListId `String`
+  - The unique identifier that represents a shield list. The ID for any Shield List can be determined by the response from the endpoint fetching all shield lists for the enterprise. Example: "90fb0e17-c332-40ed-b4f9-fa8908fbbb24 "
+- requestBody `ShieldListsUpdateV2025R0`
+  - Request body of updateShieldListByIdV2025R0 method
+- headers `UpdateShieldListByIdV2025R0Headers`
+  - Headers of updateShieldListByIdV2025R0 method
+
+
+### Returns
+
+This function returns a value of type `ShieldListV2025R0`.
+
+Returns the shield list object.
+
+

src/main/java/com/box/sdkgen/client/BoxClient.java

@@ -56,6 +56,7 @@
 import com.box.sdkgen.managers.shieldinformationbarriersegmentmembers.ShieldInformationBarrierSegmentMembersManager;
 import com.box.sdkgen.managers.shieldinformationbarriersegmentrestrictions.ShieldInformationBarrierSegmentRestrictionsManager;
 import com.box.sdkgen.managers.shieldinformationbarriersegments.ShieldInformationBarrierSegmentsManager;
+import com.box.sdkgen.managers.shieldlists.ShieldListsManager;
 import com.box.sdkgen.managers.signrequests.SignRequestsManager;
 import com.box.sdkgen.managers.signtemplates.SignTemplatesManager;
 import com.box.sdkgen.managers.skills.SkillsManager;
@@ -241,6 +242,8 @@ public class BoxClient {
 
   public final DocgenManager docgen;
 
+  public final ShieldListsManager shieldLists;
+
   public BoxClient(Authentication auth) {
     this.auth = auth;
     this.networkSession =
@@ -618,6 +621,11 @@ public BoxClient(Authentication auth) {
             .auth(this.auth)
             .networkSession(this.networkSession)
             .build();
+    this.shieldLists =
+        new ShieldListsManager.ShieldListsManagerBuilder()
+            .auth(this.auth)
+            .networkSession(this.networkSession)
+            .build();
   }
 
   protected BoxClient(BoxClientBuilder builder) {
@@ -996,6 +1004,11 @@ protected BoxClient(BoxClientBuilder builder) {
             .auth(this.auth)
             .networkSession(this.networkSession)
             .build();
+    this.shieldLists =
+        new ShieldListsManager.ShieldListsManagerBuilder()
+            .auth(this.auth)
+            .networkSession(this.networkSession)
+            .build();
   }
 
   public FetchResponse makeRequest(FetchOptions fetchOptions) {
@@ -1361,6 +1374,10 @@ public DocgenManager getDocgen() {
     return docgen;
   }
 
+  public ShieldListsManager getShieldLists() {
+    return shieldLists;
+  }
+
   public static class BoxClientBuilder {
 
     protected final Authentication auth;

src/main/java/com/box/sdkgen/managers/shieldlists/CreateShieldListV2025R0Headers.java

@@ -0,0 +1,59 @@
+package com.box.sdkgen.managers.shieldlists;
+
+import static com.box.sdkgen.internal.utils.UtilsManager.mapOf;
+
+import com.box.sdkgen.parameters.v2025r0.boxversionheaderv2025r0.BoxVersionHeaderV2025R0;
+import com.box.sdkgen.serialization.json.EnumWrapper;
+import java.util.Map;
+
+public class CreateShieldListV2025R0Headers {
+
+  public EnumWrapper<BoxVersionHeaderV2025R0> boxVersion;
+
+  public Map<String, String> extraHeaders;
+
+  public CreateShieldListV2025R0Headers() {
+    this.boxVersion = new EnumWrapper<BoxVersionHeaderV2025R0>(BoxVersionHeaderV2025R0._2025_0);
+    this.extraHeaders = mapOf();
+  }
+
+  protected CreateShieldListV2025R0Headers(CreateShieldListV2025R0HeadersBuilder builder) {
+    this.boxVersion = builder.boxVersion;
+    this.extraHeaders = builder.extraHeaders;
+  }
+
+  public EnumWrapper<BoxVersionHeaderV2025R0> getBoxVersion() {
+    return boxVersion;
+  }
+
+  public Map<String, String> getExtraHeaders() {
+    return extraHeaders;
+  }
+
+  public static class CreateShieldListV2025R0HeadersBuilder {
+
+    protected EnumWrapper<BoxVersionHeaderV2025R0> boxVersion;
+
+    protected Map<String, String> extraHeaders;
+
+    public CreateShieldListV2025R0HeadersBuilder boxVersion(BoxVersionHeaderV2025R0 boxVersion) {
+      this.boxVersion = new EnumWrapper<BoxVersionHeaderV2025R0>(boxVersion);
+      return this;
+    }
+
+    public CreateShieldListV2025R0HeadersBuilder boxVersion(
+        EnumWrapper<BoxVersionHeaderV2025R0> boxVersion) {
+      this.boxVersion = boxVersion;
+      return this;
+    }
+
+    public CreateShieldListV2025R0HeadersBuilder extraHeaders(Map<String, String> extraHeaders) {
+      this.extraHeaders = extraHeaders;
+      return this;
+    }
+
+    public CreateShieldListV2025R0Headers build() {
+      return new CreateShieldListV2025R0Headers(this);
+    }
+  }
+}

src/main/java/com/box/sdkgen/managers/shieldlists/DeleteShieldListByIdV2025R0Headers.java

@@ -0,0 +1,61 @@
+package com.box.sdkgen.managers.shieldlists;
+
+import static com.box.sdkgen.internal.utils.UtilsManager.mapOf;
+
+import com.box.sdkgen.parameters.v2025r0.boxversionheaderv2025r0.BoxVersionHeaderV2025R0;
+import com.box.sdkgen.serialization.json.EnumWrapper;
+import java.util.Map;
+
+public class DeleteShieldListByIdV2025R0Headers {
+
+  public EnumWrapper<BoxVersionHeaderV2025R0> boxVersion;
+
+  public Map<String, String> extraHeaders;
+
+  public DeleteShieldListByIdV2025R0Headers() {
+    this.boxVersion = new EnumWrapper<BoxVersionHeaderV2025R0>(BoxVersionHeaderV2025R0._2025_0);
+    this.extraHeaders = mapOf();
+  }
+
+  protected DeleteShieldListByIdV2025R0Headers(DeleteShieldListByIdV2025R0HeadersBuilder builder) {
+    this.boxVersion = builder.boxVersion;
+    this.extraHeaders = builder.extraHeaders;
+  }
+
+  public EnumWrapper<BoxVersionHeaderV2025R0> getBoxVersion() {
+    return boxVersion;
+  }
+
+  public Map<String, String> getExtraHeaders() {
+    return extraHeaders;
+  }
+
+  public static class DeleteShieldListByIdV2025R0HeadersBuilder {
+
+    protected EnumWrapper<BoxVersionHeaderV2025R0> boxVersion;
+
+    protected Map<String, String> extraHeaders;
+
+    public DeleteShieldListByIdV2025R0HeadersBuilder boxVersion(
+        BoxVersionHeaderV2025R0 boxVersion) {
+      this.boxVersion = new EnumWrapper<BoxVersionHeaderV2025R0>(boxVersion);
+      return this;
+    }
+
+    public DeleteShieldListByIdV2025R0HeadersBuilder boxVersion(
+        EnumWrapper<BoxVersionHeaderV2025R0> boxVersion) {
+      this.boxVersion = boxVersion;
+      return this;
+    }
+
+    public DeleteShieldListByIdV2025R0HeadersBuilder extraHeaders(
+        Map<String, String> extraHeaders) {
+      this.extraHeaders = extraHeaders;
+      return this;
+    }
+
+    public DeleteShieldListByIdV2025R0Headers build() {
+      return new DeleteShieldListByIdV2025R0Headers(this);
+    }
+  }
+}

src/main/java/com/box/sdkgen/managers/shieldlists/GetShieldListByIdV2025R0Headers.java

@@ -0,0 +1,59 @@
+package com.box.sdkgen.managers.shieldlists;
+
+import static com.box.sdkgen.internal.utils.UtilsManager.mapOf;
+
+import com.box.sdkgen.parameters.v2025r0.boxversionheaderv2025r0.BoxVersionHeaderV2025R0;
+import com.box.sdkgen.serialization.json.EnumWrapper;
+import java.util.Map;
+
+public class GetShieldListByIdV2025R0Headers {
+
+  public EnumWrapper<BoxVersionHeaderV2025R0> boxVersion;
+
+  public Map<String, String> extraHeaders;
+
+  public GetShieldListByIdV2025R0Headers() {
+    this.boxVersion = new EnumWrapper<BoxVersionHeaderV2025R0>(BoxVersionHeaderV2025R0._2025_0);
+    this.extraHeaders = mapOf();
+  }
+
+  protected GetShieldListByIdV2025R0Headers(GetShieldListByIdV2025R0HeadersBuilder builder) {
+    this.boxVersion = builder.boxVersion;
+    this.extraHeaders = builder.extraHeaders;
+  }
+
+  public EnumWrapper<BoxVersionHeaderV2025R0> getBoxVersion() {
+    return boxVersion;
+  }
+
+  public Map<String, String> getExtraHeaders() {
+    return extraHeaders;
+  }
+
+  public static class GetShieldListByIdV2025R0HeadersBuilder {
+
+    protected EnumWrapper<BoxVersionHeaderV2025R0> boxVersion;
+
+    protected Map<String, String> extraHeaders;
+
+    public GetShieldListByIdV2025R0HeadersBuilder boxVersion(BoxVersionHeaderV2025R0 boxVersion) {
+      this.boxVersion = new EnumWrapper<BoxVersionHeaderV2025R0>(boxVersion);
+      return this;
+    }
+
+    public GetShieldListByIdV2025R0HeadersBuilder boxVersion(
+        EnumWrapper<BoxVersionHeaderV2025R0> boxVersion) {
+      this.boxVersion = boxVersion;
+      return this;
+    }
+
+    public GetShieldListByIdV2025R0HeadersBuilder extraHeaders(Map<String, String> extraHeaders) {
+      this.extraHeaders = extraHeaders;
+      return this;
+    }
+
+    public GetShieldListByIdV2025R0Headers build() {
+      return new GetShieldListByIdV2025R0Headers(this);
+    }
+  }
+}