box-node-sdk

ShieldInformationBarrierSegmentRestrictionsManager

• Get shield information barrier segment restriction by ID
• Delete shield information barrier segment restriction by ID
• List shield information barrier segment restrictions
• Create shield information barrier segment restriction

Get shield information barrier segment restriction by ID

Retrieves a shield information barrier segment restriction based on provided ID.

This operation is performed by calling function getShieldInformationBarrierSegmentRestrictionById.

See the endpoint docs at API Reference.

await client.shieldInformationBarrierSegmentRestrictions.getShieldInformationBarrierSegmentRestrictionById(
  segmentRestrictionId,
);

Arguments

• shieldInformationBarrierSegmentRestrictionId string
  • The ID of the shield information barrier segment Restriction. Example: “4563”
• optionalsInput GetShieldInformationBarrierSegmentRestrictionByIdOptionalsInput

Returns

This function returns a value of type ShieldInformationBarrierSegmentRestriction.

Returns the shield information barrier segment restriction object.

Delete shield information barrier segment restriction by ID

Delete shield information barrier segment restriction based on provided ID.

This operation is performed by calling function deleteShieldInformationBarrierSegmentRestrictionById.

See the endpoint docs at API Reference.

await client.shieldInformationBarrierSegmentRestrictions.deleteShieldInformationBarrierSegmentRestrictionById(
  segmentRestrictionId,
);

Arguments

• shieldInformationBarrierSegmentRestrictionId string
  • The ID of the shield information barrier segment Restriction. Example: “4563”
• optionalsInput DeleteShieldInformationBarrierSegmentRestrictionByIdOptionalsInput

Returns

This function returns a value of type undefined.

Empty body in response.

List shield information barrier segment restrictions

Lists shield information barrier segment restrictions based on provided segment ID.

This operation is performed by calling function getShieldInformationBarrierSegmentRestrictions.

See the endpoint docs at API Reference.

await client.shieldInformationBarrierSegmentRestrictions.getShieldInformationBarrierSegmentRestrictions(
  {
    shieldInformationBarrierSegmentId: segmentId,
  } satisfies GetShieldInformationBarrierSegmentRestrictionsQueryParams,
);

Arguments

• queryParams GetShieldInformationBarrierSegmentRestrictionsQueryParams
  • Query parameters of getShieldInformationBarrierSegmentRestrictions method
• optionalsInput GetShieldInformationBarrierSegmentRestrictionsOptionalsInput

Returns

This function returns a value of type ShieldInformationBarrierSegmentRestrictions.

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

Create shield information barrier segment restriction

Creates a shield information barrier segment restriction object.

This operation is performed by calling function createShieldInformationBarrierSegmentRestriction.

See the endpoint docs at API Reference.

await client.shieldInformationBarrierSegmentRestrictions.createShieldInformationBarrierSegmentRestriction(
  {
    restrictedSegment: {
      id: segmentToRestrictId,
      type: 'shield_information_barrier_segment' as CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentTypeField,
    } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentField,
    shieldInformationBarrierSegment: {
      id: segmentId,
      type: 'shield_information_barrier_segment' as CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentTypeField,
    } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentField,
    type: 'shield_information_barrier_segment_restriction' as CreateShieldInformationBarrierSegmentRestrictionRequestBodyTypeField,
  } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBodyInput,
);

Arguments

• requestBodyInput CreateShieldInformationBarrierSegmentRestrictionRequestBodyInput
  • Request body of createShieldInformationBarrierSegmentRestriction method
• optionalsInput CreateShieldInformationBarrierSegmentRestrictionOptionalsInput

Returns

This function returns a value of type ShieldInformationBarrierSegmentRestriction.

Returns the newly created Shield Information Barrier Segment Restriction object.

This site is open source. Improve this page.