Skip to content

Latest commit

 

History

History
154 lines (91 loc) · 4.68 KB

shieldlists.md

File metadata and controls

154 lines (91 loc) · 4.68 KB

ShieldListsManager

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.

client.getShieldLists().getShieldListsV2025R0()

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.

client.getShieldLists().createShieldListV2025R0(new ShieldListsCreateV2025R0.Builder(shieldListCountryName, new ShieldListContentCountryV2025R0.Builder(Arrays.asList("US", "PL")).type(ShieldListContentCountryV2025R0TypeField.COUNTRY).build()).description("A list of things that are shielded").build())

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.

client.getShieldLists().getShieldListByIdV2025R0(shieldListCountry.getId())

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.

client.getShieldLists().deleteShieldListByIdV2025R0(shieldListCountry.getId())

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.

client.getShieldLists().updateShieldListByIdV2025R0(shieldListCountry.getId(), new ShieldListsUpdateV2025R0.Builder(shieldListCountryName, new ShieldListContentCountryV2025R0.Builder(Arrays.asList("US")).type(ShieldListContentCountryV2025R0TypeField.COUNTRY).build()).description("Updated description").build())

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.