@greensecurity/javascript-sdk 0.45.0-beta.22 → 0.45.0-beta.23

package/src/sdk/vendorscans.ts

@@ -29,10 +29,14 @@ export class VendorScans extends ClientSDK {
    * @remarks
    * List or search vendor scans.
    *
+   * **Permissions.** Requires the `vendor_scans.view` permission.
+   *
    * Available `expand` scopes are:
    *
-   * - vendor_scan.vendor
-   * - vendor_scan.zone
+   * - `vendor_scan.vendor`
+   * - `vendor_scan.zone`
+   *
+   * Any other value is rejected with `422 Unprocessable Entity`.
    */
   async listVendorScans(
     request: operations.ListVendorScansRequest,
@@ -58,6 +62,8 @@ export class VendorScans extends ClientSDK {
    * notes, and the screening-required / screening-finished flags.
    *
    * Returns a `status_url` for polling until the export is ready, along with a `download_url` and `status_id`.
+   *
+   * **Permissions.** Requires the `vendor_scans.view` permission.
    */
   async exportVendorScans(
     request: operations.ExportVendorScansRequest,
@@ -76,6 +82,8 @@ export class VendorScans extends ClientSDK {
    * @remarks
    * Poll the status of an asynchronous vendor scans export job. When `ready` is true,
    * the export is complete and can be downloaded via the download endpoint.
+   *
+   * **Permissions.** Requires the `vendor_scans.view` permission.
    */
   async getVendorScansExportStatus(
     request: operations.GetVendorScansExportStatusRequest,
@@ -94,6 +102,8 @@ export class VendorScans extends ClientSDK {
    * @remarks
    * Returns the exported vendor scans CSV via a 302 redirect to a short-lived presigned S3 URL.
    * If the export is still being generated, returns 202 with a JSON `{ ready: false }` payload.
+   *
+   * **Permissions.** Requires the `vendor_scans.view` permission.
    */
   async downloadVendorScansExport(
     request: operations.DownloadVendorScansExportRequest,
@@ -114,15 +124,19 @@ export class VendorScans extends ClientSDK {
    * @remarks
    * Retrieve a single vendor scan by ID.
    *
+   * **Permissions.** Requires the `vendor_scans.view` permission.
+   *
    * Available `expand` scopes are:
    *
-   * - vendor_scan.vendor
-   * - vendor_scan.zone
-   * - vendor_scan.department
-   * - vendor_scan.badge_data
-   * - vendor_scan.company
-   * - vendor_scan.appointment
-   * - vendor_scan.screening_responses
+   * - `vendor_scan.vendor`
+   * - `vendor_scan.zone`
+   * - `vendor_scan.department`
+   * - `vendor_scan.company`
+   * - `vendor_scan.appointment`
+   * - `vendor_scan.badge_data`
+   * - `vendor_scan.screening_responses`
+   *
+   * Any other value is rejected with `422 Unprocessable Entity`.
    */
   async getVendorScan(
     request: operations.GetVendorScanRequest,
@@ -142,9 +156,15 @@ export class VendorScans extends ClientSDK {
    * Retrieve the next unanswered screening question for the specified vendor scan.
    * If a question exists, the endpoint returns the question and its available answers.
    *
+   * **Permissions.** Requires the `vendor_scans.view` permission.
+   *
    * Available `expand` scopes are:
    *
-   * screening_question.screening_answers
+   * - `screening_question.screening_answers`
+   *
+   * Unrecognised values are ignored. `screening_question.screening_answer_actions`
+   * is not available here: this endpoint's response is sliced down to the
+   * minimal fields the vendor check-in UI needs, which excludes answer actions.
    */
   async getNextScreeningQuestion(
     request: operations.GetNextScreeningQuestionRequest,
@@ -166,6 +186,8 @@ export class VendorScans extends ClientSDK {
    * (for multi-select questions), or a custom free-text answer. The endpoint
    * also executes any triggered actions associated with the response and
    * indicates whether there is a next screening question.
+   *
+   * **Permissions.** Requires the `vendor_scans.add` permission.
    */
   async submitScreeningResponse(
     request: operations.SubmitScreeningResponseRequest,
@@ -183,6 +205,7 @@ export class VendorScans extends ClientSDK {
    *
    * @remarks
    * Scans a vendor out of a facility. Set `gps_checkout` when a device decided the vendor had left a configured geofence; it adds the automatic check-out notification and changes nothing else.
+   * **Permissions.** Requires the `vendor_scans.edit` permission.
    */
   async vendorScanOut(
     request: operations.VendorScanOutRequest,
@@ -200,6 +223,7 @@ export class VendorScans extends ClientSDK {
    *
    * @remarks
    * Returns the geofence a client should arm to detect that the vendor has left the location this scan belongs to. A facility that has automatic GPS check-out configured owns the geofence for every one of its zones; only when it does not does the zone's own setting apply.
+   * **Permissions.** Requires the `vendor_scans.edit` permission.
    */
   async vendorScanGpsCheckoutConfig(
     request: operations.VendorScanGpsCheckoutConfigRequest,

package/src/sdk/webhooks.ts

@@ -25,6 +25,8 @@ export class Webhooks extends ClientSDK {
    * Sortable by `id`, `webhook_url`, `created_at` and `updated_at`.
    *
    * Requires the `webhook` / `view` permission.
+   *
+   * **Permissions.** Requires the `webhook.view` permission.
    */
   async listAllWebhookEndpoints(
     request: operations.ListAllWebhookEndpointsRequest,
@@ -59,6 +61,8 @@ export class Webhooks extends ClientSDK {
    * site-wide marketplace app installations, to every event of the site.
    *
    * Requires the `webhook` / `add` permission.
+   *
+   * **Permissions.** Requires the `webhook.add` permission.
    */
   async createWebhookEndpoint(
     request: components.WebhookEndpointCreate,
@@ -82,6 +86,8 @@ export class Webhooks extends ClientSDK {
    * indistinguishable from one that does not exist.
    *
    * Requires the `webhook` / `view` permission.
+   *
+   * **Permissions.** Requires the `webhook.view` permission.
    */
   async getWebhookEndpoint(
     request: operations.GetWebhookEndpointRequest,
@@ -123,6 +129,8 @@ export class Webhooks extends ClientSDK {
    * ignored if you send them back.
    *
    * Requires the `webhook` / `edit` permission.
+   *
+   * **Permissions.** Requires the `webhook.edit` permission.
    */
   async updatesTheWebhookEndpointWithTheGivenId(
     request: operations.UpdatesTheWebhookEndpointWithTheGivenIdRequest,
@@ -146,6 +154,8 @@ export class Webhooks extends ClientSDK {
    * events for entities it lost access to.
    *
    * Requires the `webhook` / `delete` permission.
+   *
+   * **Permissions.** Requires the `webhook.delete` permission.
    */
   async deleteWebhookEndpoint(
     request: operations.DeleteWebhookEndpointRequest,

package/src/sdk/zones.ts

@@ -17,6 +17,8 @@ export class Zones extends ClientSDK {
    *
    * @remarks
    * List or search security zones
+   *
+   * **Permissions.** Requires the `zones.view` permission.
    */
   async listOrSearchSecurityZones(
     request: operations.ListOrSearchSecurityZonesRequest,
@@ -37,11 +39,15 @@ export class Zones extends ClientSDK {
    * @remarks
    * Get security zone details
    *
+   * **Permissions.** Requires the `zones.view` permission.
+   *
    * Available `expand` scopes are:
    *
-   * - zone.facility
-   * - zone.department
-   * - zone.rules
+   * - `zone.facility`
+   * - `zone.department`
+   * - `zone.rules`
+   *
+   * Unrecognised values are ignored.
    */
   async getSecurityZone(
     request: operations.GetSecurityZoneRequest,
@@ -59,6 +65,8 @@ export class Zones extends ClientSDK {
    *
    * @remarks
    * Security zone checkin request
+   *
+   * **Permissions.** Requires a valid token. This endpoint is not gated on a named permission - the caller's role and their relationship to the record decide what is returned.
    */
   async securityZoneCheckin(
     request: operations.SecurityZoneCheckinRequestBody,