Skip to content

shieldInformationBarrierSegmentMembers.md

Latest commit

 

History

History
135 lines (90 loc) · 4.65 KB

shieldInformationBarrierSegmentMembers.md

File metadata and controls

135 lines (90 loc) · 4.65 KB
Raw

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.

await client.shieldInformationBarrierSegmentMembers.getShieldInformationBarrierSegmentMemberById(
  segmentMember.id!,
);

Arguments

  • shieldInformationBarrierSegmentMemberId string
    • The ID of the shield information barrier segment Member. Example: "7815"
  • optionalsInput GetShieldInformationBarrierSegmentMemberByIdOptionalsInput

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.

await client.shieldInformationBarrierSegmentMembers.deleteShieldInformationBarrierSegmentMemberById(
  segmentMember.id!,
);

Arguments

  • shieldInformationBarrierSegmentMemberId string
    • The ID of the shield information barrier segment Member. Example: "7815"
  • optionalsInput DeleteShieldInformationBarrierSegmentMemberByIdOptionalsInput

Returns

This function returns a value of type undefined.

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.

await client.shieldInformationBarrierSegmentMembers.getShieldInformationBarrierSegmentMembers(
  {
    shieldInformationBarrierSegmentId: segment.id!,
  } satisfies GetShieldInformationBarrierSegmentMembersQueryParams,
);

Arguments

  • queryParams GetShieldInformationBarrierSegmentMembersQueryParams
    • Query parameters of getShieldInformationBarrierSegmentMembers method
  • optionalsInput GetShieldInformationBarrierSegmentMembersOptionalsInput

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.

await client.shieldInformationBarrierSegmentMembers.createShieldInformationBarrierSegmentMember(
  {
    shieldInformationBarrierSegment: {
      id: segment.id!,
      type: 'shield_information_barrier_segment' as CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentTypeField,
    } satisfies CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentField,
    user: new UserBase({ id: getEnvVar('USER_ID') }),
  } satisfies CreateShieldInformationBarrierSegmentMemberRequestBody,
);

Arguments

  • requestBody CreateShieldInformationBarrierSegmentMemberRequestBody
    • Request body of createShieldInformationBarrierSegmentMember method
  • optionalsInput CreateShieldInformationBarrierSegmentMemberOptionalsInput

Returns

This function returns a value of type ShieldInformationBarrierSegmentMember.

Returns a new shield information barrier segment member object.