Skip to content

shieldinformationbarriersegmentmembers.md

Latest commit

 

History

History
129 lines (78 loc) · 4.7 KB

shieldinformationbarriersegmentmembers.md

File metadata and controls

129 lines (78 loc) · 4.7 KB

ShieldInformationBarrierSegmentMembersManager

Get shield information barrier segment member by ID

Retrieves a shield information barrier segment member by its ID.

This operation is performed by calling function getShieldInformationBarrierSegmentMemberById.

See the endpoint docs at API Reference.

client.getShieldInformationBarrierSegmentMembers().getShieldInformationBarrierSegmentMemberById(segmentMember.getId())

Arguments

  • shieldInformationBarrierSegmentMemberId String
    • The ID of the shield information barrier segment Member. Example: "7815"
  • headers GetShieldInformationBarrierSegmentMemberByIdHeaders
    • Headers of getShieldInformationBarrierSegmentMemberById method

Returns

This function returns a value of type ShieldInformationBarrierSegmentMember.

Returns the shield information barrier segment member object.

Delete shield information barrier segment member by ID

Deletes a shield information barrier segment member based on provided ID.

This operation is performed by calling function deleteShieldInformationBarrierSegmentMemberById.

See the endpoint docs at API Reference.

client.getShieldInformationBarrierSegmentMembers().deleteShieldInformationBarrierSegmentMemberById(segmentMember.getId())

Arguments

  • shieldInformationBarrierSegmentMemberId String
    • The ID of the shield information barrier segment Member. Example: "7815"
  • headers DeleteShieldInformationBarrierSegmentMemberByIdHeaders
    • Headers of deleteShieldInformationBarrierSegmentMemberById method

Returns

This function returns a value of type void.

Returns an empty response if the segment member was deleted successfully.

List shield information barrier segment members

Lists shield information barrier segment members based on provided segment IDs.

This operation is performed by calling function getShieldInformationBarrierSegmentMembers.

See the endpoint docs at API Reference.

client.getShieldInformationBarrierSegmentMembers().getShieldInformationBarrierSegmentMembers(new GetShieldInformationBarrierSegmentMembersQueryParams(segment.getId()))

Arguments

  • queryParams GetShieldInformationBarrierSegmentMembersQueryParams
    • Query parameters of getShieldInformationBarrierSegmentMembers method
  • headers GetShieldInformationBarrierSegmentMembersHeaders
    • Headers of getShieldInformationBarrierSegmentMembers method

Returns

This function returns a value of type ShieldInformationBarrierSegmentMembers.

Returns a paginated list of shield information barrier segment member objects.

Create shield information barrier segment member

Creates a new shield information barrier segment member.

This operation is performed by calling function createShieldInformationBarrierSegmentMember.

See the endpoint docs at API Reference.

client.getShieldInformationBarrierSegmentMembers().createShieldInformationBarrierSegmentMember(new CreateShieldInformationBarrierSegmentMemberRequestBody(new CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentField.Builder().id(segment.getId()).type(CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentTypeField.SHIELD_INFORMATION_BARRIER_SEGMENT).build(), new UserBase(getEnvVar("USER_ID"))))

Arguments

  • requestBody CreateShieldInformationBarrierSegmentMemberRequestBody
    • Request body of createShieldInformationBarrierSegmentMember method
  • headers CreateShieldInformationBarrierSegmentMemberHeaders
    • Headers of createShieldInformationBarrierSegmentMember method

Returns

This function returns a value of type ShieldInformationBarrierSegmentMember.

Returns a new shield information barrier segment member object.