Skip to content

shieldInformationBarrierReports.md

Latest commit

 

History

History
99 lines (65 loc) · 3.06 KB

shieldInformationBarrierReports.md

File metadata and controls

99 lines (65 loc) · 3.06 KB
Raw

ShieldInformationBarrierReportsManager

List shield information barrier reports

Lists shield information barrier reports.

This operation is performed by calling function getShieldInformationBarrierReports.

See the endpoint docs at API Reference.

await client.shieldInformationBarrierReports.getShieldInformationBarrierReports(
  {
    shieldInformationBarrierId: barrierId,
  } satisfies GetShieldInformationBarrierReportsQueryParams,
);

Arguments

  • queryParams GetShieldInformationBarrierReportsQueryParams
    • Query parameters of getShieldInformationBarrierReports method
  • optionalsInput GetShieldInformationBarrierReportsOptionalsInput

Returns

This function returns a value of type ShieldInformationBarrierReports.

Returns a paginated list of shield information barrier report objects.

Create shield information barrier report

Creates a shield information barrier report for a given barrier.

This operation is performed by calling function createShieldInformationBarrierReport.

See the endpoint docs at API Reference.

await client.shieldInformationBarrierReports.createShieldInformationBarrierReport(
  {
    shieldInformationBarrier: {
      id: barrierId,
      type: 'shield_information_barrier' as ShieldInformationBarrierBaseTypeField,
    } satisfies ShieldInformationBarrierBase,
  } satisfies ShieldInformationBarrierReference,
);

Arguments

  • requestBody ShieldInformationBarrierReference
    • Request body of createShieldInformationBarrierReport method
  • optionalsInput CreateShieldInformationBarrierReportOptionalsInput

Returns

This function returns a value of type ShieldInformationBarrierReport.

Returns the shield information barrier report information object.

Get shield information barrier report by ID

Retrieves a shield information barrier report by its ID.

This operation is performed by calling function getShieldInformationBarrierReportById.

See the endpoint docs at API Reference.

await client.shieldInformationBarrierReports.getShieldInformationBarrierReportById(
  createdReport.id!,
);

Arguments

  • shieldInformationBarrierReportId string
    • The ID of the shield information barrier Report. Example: "3423"
  • optionalsInput GetShieldInformationBarrierReportByIdOptionalsInput

Returns

This function returns a value of type ShieldInformationBarrierReport.

Returns the shield information barrier report object.