box-node-sdk

ShieldInformationBarriersManager

• Get shield information barrier with specified ID
• Add changed status of shield information barrier with specified ID
• List shield information barriers
• Create shield information barrier

Get shield information barrier with specified ID

Get shield information barrier based on provided ID.

This operation is performed by calling function getShieldInformationBarrierById.

See the endpoint docs at API Reference.

await client.shieldInformationBarriers.getShieldInformationBarrierById(
  barrierId,
);

Arguments

• shieldInformationBarrierId string
  • The ID of the shield information barrier. Example: “1910967”
• optionalsInput GetShieldInformationBarrierByIdOptionalsInput

Returns

This function returns a value of type ShieldInformationBarrier.

Returns the shield information barrier object.

Add changed status of shield information barrier with specified ID

Change status of shield information barrier with the specified ID.

This operation is performed by calling function updateShieldInformationBarrierStatus.

See the endpoint docs at API Reference.

await client.shieldInformationBarriers.updateShieldInformationBarrierStatus({
  id: barrierId,
  status:
    'disabled' as UpdateShieldInformationBarrierStatusRequestBodyStatusField,
} satisfies UpdateShieldInformationBarrierStatusRequestBody);

Arguments

• requestBody UpdateShieldInformationBarrierStatusRequestBody
  • Request body of updateShieldInformationBarrierStatus method
• optionalsInput UpdateShieldInformationBarrierStatusOptionalsInput

Returns

This function returns a value of type ShieldInformationBarrier.

Returns the updated shield information barrier object.

List shield information barriers

Retrieves a list of shield information barrier objects for the enterprise of JWT.

This operation is performed by calling function getShieldInformationBarriers.

See the endpoint docs at API Reference.

await client.shieldInformationBarriers.getShieldInformationBarriers();

Arguments

• queryParams GetShieldInformationBarriersQueryParams
  • Query parameters of getShieldInformationBarriers method
• headersInput GetShieldInformationBarriersHeadersInput
  • Headers of getShieldInformationBarriers method
• cancellationToken undefined | CancellationToken
  • Token used for request cancellation.

Returns

This function returns a value of type ShieldInformationBarriers.

Returns a paginated list of shield information barrier objects, empty list if currently no barrier.

Create shield information barrier

Creates a shield information barrier to separate individuals/groups within the same firm and prevents confidential information passing between them.

This operation is performed by calling function createShieldInformationBarrier.

See the endpoint docs at API Reference.

await client.shieldInformationBarriers.createShieldInformationBarrier({
  enterprise: { id: enterpriseId } satisfies EnterpriseBase,
} satisfies CreateShieldInformationBarrierRequestBody);

Arguments

• requestBody CreateShieldInformationBarrierRequestBody
  • Request body of createShieldInformationBarrier method
• optionalsInput CreateShieldInformationBarrierOptionalsInput

Returns

This function returns a value of type ShieldInformationBarrier.

Returns a new shield information barrier object.

This site is open source. Improve this page.