@greensecurity/javascript-sdk 0.45.0 → 0.46.0-beta.1

package/dist/commonjs/sdk/organizations.d.ts

@@ -9,18 +9,22 @@ export declare class Organizations extends ClientSDK {
      * @remarks
      * List or search facilities.
      *
+     * **Permissions.** Requires any of `facilities.view`, `facility.search` or `targeted_facilities.view`. Callers holding only `targeted_facilities.view` or `facility.search` see a reduced record, and expansion scopes are applied only to facilities within their read scope.
+     *
      * Available `expand` scopes are:
      *
-     * - facility.appointment_policy
-     * - facility.contacts
-     * - facility.vendor_counts
-     * - facility.flu_credential
-     * - facility.scrubs_policy
-     * - facility.system
-     * - facility.vendor_guest_policy
-     * - facility.vendor_policy
-     * - facility.visitor_policy
-     * - facility.workflow
+     * - `facility.system`
+     * - `facility.contacts`
+     * - `facility.vendor_counts`
+     * - `facility.appointment_policy`
+     * - `facility.vendor_policy`
+     * - `facility.vendor_guest_policy`
+     * - `facility.visitor_policy`
+     * - `facility.workflow_policy`
+     * - `facility.scrubs_policy`
+     * - `facility.flu_credential`
+     *
+     * Unrecognised values are ignored. Expansion is applied only to facilities the caller can read; rows outside that scope are returned unexpanded.
      */
     listOrSearchFacilities(request: operations.ListOrSearchFacilitiesRequest, options?: RequestOptions): Promise<PageIterator<operations.ListOrSearchFacilitiesResponse, {
         page: number;
@@ -30,6 +34,26 @@ export declare class Organizations extends ClientSDK {
      *
      * @remarks
      * Retrieve an individual facility.
+     *
+     * **Permissions.** Requires `facilities.view`, `facility_profile.view`, or `targeted_facilities.view`. `facility.search` does not grant access on its own — it only extends the reach of a `targeted_facilities.view` caller to a facility they are not targeted at, returning the public summary for it instead of a 403.
+     *
+     * - Callers with `facilities.view` or `facility_profile.view` can look up any facility, but only receive full expansion for their own facility; for any other facility, expansion is dropped and only the public summary is returned.
+     * - Callers with `targeted_facilities.view` receive the full record and full expansion for a facility they are targeted at (a vendor's target facilities, or a facility/system user's own facility). For a facility they are not targeted at, they receive the public summary (no expansion) if they also hold `facility.search`, or a 401 otherwise.
+     *
+     * Available `expand` scopes are:
+     *
+     * - `facility.system`
+     * - `facility.contacts`
+     * - `facility.vendor_counts`
+     * - `facility.appointment_policy`
+     * - `facility.vendor_policy`
+     * - `facility.vendor_guest_policy`
+     * - `facility.visitor_policy`
+     * - `facility.workflow_policy`
+     * - `facility.scrubs_policy`
+     * - `facility.flu_credential`
+     *
+     * Unrecognised values are ignored. Expansion is dropped entirely for callers who can only see the facility's public summary.
      */
     getFacility(request: operations.GetFacilityRequest, options?: RequestOptions): Promise<components.Facility>;
     /**
@@ -37,6 +61,8 @@ export declare class Organizations extends ClientSDK {
      *
      * @remarks
      * List or search departments.
+     *
+     * **Permissions.** Requires the `departments.view` permission.
      */
     listOrSearchDepartments(request: operations.ListOrSearchDepartmentsRequest, options?: RequestOptions): Promise<PageIterator<operations.ListOrSearchDepartmentsResponse, {
         page: number;
@@ -50,9 +76,15 @@ export declare class Organizations extends ClientSDK {
      * and parent system), the link status, and per-facility counts of the
      * company's individuals targeting it.
      *
-     * When `include_potential_targets=true`, returns ALL non-deleted facilities
-     * via a LEFT JOIN. Targeted rows carry their CTF `id` and `status`; non-targeted
-     * rows have `id: null` and `status: "Not Targeted"`.
+     * When `include_potential_targets=true`, returns every non-deleted facility
+     * reachable via a LEFT JOIN against the caller's *potential-target* scope:
+     * for a facility/system/vendor/company-manager caller, that's the public,
+     * non-deleted, listed facility directory plus the caller's own read scope
+     * for Facility — not the read scope alone, so the roster includes
+     * facilities the caller has no existing relationship with. An API-user
+     * caller is the exception: it sees only its own read scope, with no
+     * directory added. Targeted rows carry their CTF `id` and `status`;
+     * non-targeted rows have `id: null` and `status: "Not Targeted"`.
      *
      * Access control: the URL's `company_id` must be in the caller's read scope
      * for Company (a company manager's or vendor's own company, or a company
@@ -62,9 +94,13 @@ export declare class Organizations extends ClientSDK {
      * Filter with `has_individual` / `has_active_individual` to drive the
      * facility roster views.
      *
+     * **Permissions.** Requires the `target_facilities.view` permission.
+     *
      * Available `expand` scopes are:
      *
-     * - company_target_facility.facility
+     * - `company_target_facility.facility`
+     *
+     * Any other value is rejected with `422 Unprocessable Entity`.
      */
     listCompanyTargetFacilities(request: operations.ListCompanyTargetFacilitiesRequest, options?: RequestOptions): Promise<PageIterator<operations.ListCompanyTargetFacilitiesResponse, {
         page: number;
@@ -79,15 +115,27 @@ export declare class Organizations extends ClientSDK {
      *
      * Access control: the URL's `company_id` must be in the caller's update
      * scope for Company, AND the `facility_id` must be in the caller's create
-     * scope for Facility (a facility on the company's site, or a facility
-     * reachable via the API user's site/system/facility-scoped activation).
-     * Either being out of scope returns `404 Company not found` /
-     * `404 Facility not found` respectively. Deleted facilities also return
-     * `404 Facility not found`.
+     * scope for Facility. For a facility/system/vendor/company-manager caller,
+     * that create scope is widened the same way listing's potential-target
+     * scope is: it includes the public, non-deleted, listed facility directory
+     * in addition to the caller's own create scope, so a non-deleted publicly
+     * listed facility can be targeted even when it isn't otherwise in the
+     * caller's Facility relation. An API-user caller is the exception —
+     * restricted to its own create scope (a facility on the company's site, or
+     * a facility reachable via the API user's site/system/facility-scoped
+     * activation), with no directory added. Either being out of scope returns
+     * `404 Company not found` / `404 Facility not found` respectively. Deleted
+     * facilities also return `404 Facility not found`.
+     *
+     * **Permissions.** Requires the `target_facilities.add` permission.
+     *
+     * **Permissions.** Requires the `target_facilities.add` permission.
      *
      * Available `expand` scopes are:
      *
-     * - company_target_facility.facility
+     * - `company_target_facility.facility`
+     *
+     * Any other value is rejected with `422 Unprocessable Entity`.
      */
     createCompanyTargetFacility(request: operations.CreateCompanyTargetFacilityRequest, options?: RequestOptions): Promise<operations.CreateCompanyTargetFacilityCreateCompanyTargetFacilityOk>;
     /**
@@ -103,6 +151,8 @@ export declare class Organizations extends ClientSDK {
      * scope for Company (a company manager's or vendor's own company, or a
      * company whose app is activated for the API user). Callers outside that
      * scope receive `404 Company not found`.
+     *
+     * **Permissions.** Requires the `target_facilities.delete` permission.
      */
     deleteCompanyTargetFacility(request: operations.DeleteCompanyTargetFacilityRequest, options?: RequestOptions): Promise<boolean>;
     /**
@@ -117,6 +167,8 @@ export declare class Organizations extends ClientSDK {
      *
      * Access control: the URL's `company_id` must be in the caller's read scope for Company. Callers
      * outside that scope receive `404 Company not found`.
+     *
+     * **Permissions.** Requires the `target_facilities.view` permission.
      */
     exportCompanyTargetFacilities(request: operations.ExportCompanyTargetFacilitiesRequest, options?: RequestOptions): Promise<operations.ExportCompanyTargetFacilitiesResponseBody>;
     /**
@@ -125,6 +177,8 @@ export declare class Organizations extends ClientSDK {
      * @remarks
      * Poll the state of an asynchronous company target facilities export job. When `ready` is true,
      * the export is complete and can be downloaded via the download endpoint.
+     *
+     * **Permissions.** Requires the `target_facilities.view` permission.
      */
     getCompanyTargetFacilitiesExportStatus(request: operations.GetCompanyTargetFacilitiesExportStatusRequest, options?: RequestOptions): Promise<operations.GetCompanyTargetFacilitiesExportStatusResponseBody>;
     /**
@@ -133,6 +187,8 @@ export declare class Organizations extends ClientSDK {
      * @remarks
      * Returns the exported company target facilities 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 `target_facilities.view` permission.
      */
     downloadCompanyTargetFacilitiesExport(request: operations.DownloadCompanyTargetFacilitiesExportRequest, options?: RequestOptions): Promise<operations.DownloadCompanyTargetFacilitiesExportResponse | undefined>;
     /**
@@ -159,6 +215,8 @@ export declare class Organizations extends ClientSDK {
      *   * API users: must pass `company_id`. Both the company and the facility
      *     must be activated for the caller's marketplace app
      *     (`MarketplaceAppActivation`).
+     *
+     * **Permissions.** Requires the `vendors.view` permission.
      */
     listFacilityVendors(request: operations.ListFacilityVendorsRequest, options?: RequestOptions): Promise<PageIterator<operations.ListFacilityVendorsResponse, {
         page: number;
@@ -182,6 +240,8 @@ export declare class Organizations extends ClientSDK {
      *   * API users — `company_id` required; both the company AND the facility must be
      *     activated for the caller's marketplace app via the join-scoped
      *     `MarketplaceAppActivation` check.
+     *
+     * **Permissions.** Requires the `vendors.view` permission.
      */
     exportFacilityVendors(request: operations.ExportFacilityVendorsRequest, options?: RequestOptions): Promise<operations.ExportFacilityVendorsResponseBody>;
     /**
@@ -190,6 +250,8 @@ export declare class Organizations extends ClientSDK {
      * @remarks
      * Poll the state of an asynchronous facility vendors export job. When `ready` is true,
      * the export is complete and can be downloaded via the download endpoint.
+     *
+     * **Permissions.** Requires the `vendors.view` permission.
      */
     getFacilityVendorsExportStatus(request: operations.GetFacilityVendorsExportStatusRequest, options?: RequestOptions): Promise<components.CsvExportStatusResponse>;
     /**
@@ -199,6 +261,8 @@ export declare class Organizations extends ClientSDK {
      * Returns the exported facility vendors 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 `vendors.view` permission.
      */
     downloadFacilityVendorsExport(request: operations.DownloadFacilityVendorsExportRequest, options?: RequestOptions): Promise<operations.DownloadFacilityVendorsExportResponse | undefined>;
     /**
@@ -207,10 +271,14 @@ export declare class Organizations extends ClientSDK {
      * @remarks
      * List or search department contacts.
      *
+     * **Permissions.** Requires the `departments.view` permission.
+     *
      * Available `expand` scopes are:
      *
-     * - department_membership.contact
-     * - department_membership.department
+     * - `department_membership.contact`
+     * - `department_membership.department`
+     *
+     * Unrecognised values are ignored.
      */
     listOrSearchDepartmentContacts(request: operations.ListOrSearchDepartmentContactsRequest, options?: RequestOptions): Promise<PageIterator<operations.ListOrSearchDepartmentContactsResponse, {
         page: number;

package/dist/commonjs/sdk/organizations.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"organizations.d.ts","sourceRoot":"","sources":["../../../src/sdk/organizations.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAE5D,OAAO,EAAE,YAAY,EAAwB,MAAM,wBAAwB,CAAC;AAE5E,qBAAa,aAAc,SAAQ,SAAS;IAC1C;;;;;;;;;;;;;;;;;;OAkBG;IACG,sBAAsB,CAC1B,OAAO,EAAE,UAAU,CAAC,6BAA6B,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CAAC,UAAU,CAAC,8BAA8B,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAC1E;IAQD;;;;;OAKG;IACG,WAAW,CACf,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC;IAQ/B;;;;;OAKG;IACG,uBAAuB,CAC3B,OAAO,EAAE,UAAU,CAAC,8BAA8B,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CAAC,UAAU,CAAC,+BAA+B,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAC3E;IAQD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,2BAA2B,CAC/B,OAAO,EAAE,UAAU,CAAC,kCAAkC,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CACV,UAAU,CAAC,mCAAmC,EAC9C;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CACjB,CACF;IAQD;;;;;;;;;;;;;;;;;;;OAmBG;IACG,2BAA2B,CAC/B,OAAO,EAAE,UAAU,CAAC,kCAAkC,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,UAAU,CAAC,wDAAwD,CACpE;IAQD;;;;;;;;;;;;;OAaG;IACG,2BAA2B,CAC/B,OAAO,EAAE,UAAU,CAAC,kCAAkC,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,OAAO,CAAC;IAQnB;;;;;;;;;;;;OAYG;IACG,6BAA6B,CACjC,OAAO,EAAE,UAAU,CAAC,oCAAoC,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,yCAAyC,CAAC;IAQhE;;;;;;OAMG;IACG,sCAAsC,CAC1C,OAAO,EAAE,UAAU,CAAC,6CAA6C,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,kDAAkD,CAAC;IAQzE;;;;;;OAMG;IACG,qCAAqC,CACzC,OAAO,EAAE,UAAU,CAAC,4CAA4C,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,UAAU,CAAC,6CAA6C,GAAG,SAAS,CACrE;IAQD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,mBAAmB,CACvB,OAAO,EAAE,UAAU,CAAC,0BAA0B,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CAAC,UAAU,CAAC,2BAA2B,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CACvE;IAQD;;;;;;;;;;;;;;;;;;;OAmBG;IACG,qBAAqB,CACzB,OAAO,EAAE,UAAU,CAAC,4BAA4B,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,iCAAiC,CAAC;IAQxD;;;;;;OAMG;IACG,8BAA8B,CAClC,OAAO,EAAE,UAAU,CAAC,qCAAqC,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,uBAAuB,CAAC;IAQ9C;;;;;;;OAOG;IACG,6BAA6B,CACjC,OAAO,EAAE,UAAU,CAAC,oCAAoC,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qCAAqC,GAAG,SAAS,CAAC;IAQxE;;;;;;;;;;OAUG;IACG,8BAA8B,CAClC,OAAO,EAAE,UAAU,CAAC,qCAAqC,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CACV,UAAU,CAAC,sCAAsC,EACjD;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CACjB,CACF;CAOF"}
+{"version":3,"file":"organizations.d.ts","sourceRoot":"","sources":["../../../src/sdk/organizations.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAE5D,OAAO,EAAE,YAAY,EAAwB,MAAM,wBAAwB,CAAC;AAE5E,qBAAa,aAAc,SAAQ,SAAS;IAC1C;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,sBAAsB,CAC1B,OAAO,EAAE,UAAU,CAAC,6BAA6B,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CAAC,UAAU,CAAC,8BAA8B,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAC1E;IAQD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,WAAW,CACf,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC;IAQ/B;;;;;;;OAOG;IACG,uBAAuB,CAC3B,OAAO,EAAE,UAAU,CAAC,8BAA8B,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CAAC,UAAU,CAAC,+BAA+B,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAC3E;IAQD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,2BAA2B,CAC/B,OAAO,EAAE,UAAU,CAAC,kCAAkC,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CACV,UAAU,CAAC,mCAAmC,EAC9C;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CACjB,CACF;IAQD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,2BAA2B,CAC/B,OAAO,EAAE,UAAU,CAAC,kCAAkC,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,UAAU,CAAC,wDAAwD,CACpE;IAQD;;;;;;;;;;;;;;;OAeG;IACG,2BAA2B,CAC/B,OAAO,EAAE,UAAU,CAAC,kCAAkC,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,OAAO,CAAC;IAQnB;;;;;;;;;;;;;;OAcG;IACG,6BAA6B,CACjC,OAAO,EAAE,UAAU,CAAC,oCAAoC,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,yCAAyC,CAAC;IAQhE;;;;;;;;OAQG;IACG,sCAAsC,CAC1C,OAAO,EAAE,UAAU,CAAC,6CAA6C,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,kDAAkD,CAAC;IAQzE;;;;;;;;OAQG;IACG,qCAAqC,CACzC,OAAO,EAAE,UAAU,CAAC,4CAA4C,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,UAAU,CAAC,6CAA6C,GAAG,SAAS,CACrE;IAQD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,mBAAmB,CACvB,OAAO,EAAE,UAAU,CAAC,0BAA0B,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CAAC,UAAU,CAAC,2BAA2B,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CACvE;IAQD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,qBAAqB,CACzB,OAAO,EAAE,UAAU,CAAC,4BAA4B,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,iCAAiC,CAAC;IAQxD;;;;;;;;OAQG;IACG,8BAA8B,CAClC,OAAO,EAAE,UAAU,CAAC,qCAAqC,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,uBAAuB,CAAC;IAQ9C;;;;;;;;;OASG;IACG,6BAA6B,CACjC,OAAO,EAAE,UAAU,CAAC,oCAAoC,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qCAAqC,GAAG,SAAS,CAAC;IAQxE;;;;;;;;;;;;;;OAcG;IACG,8BAA8B,CAClC,OAAO,EAAE,UAAU,CAAC,qCAAqC,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CACV,UAAU,CAAC,sCAAsC,EACjD;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CACjB,CACF;CAOF"}

package/dist/commonjs/sdk/organizations.js

@@ -28,18 +28,22 @@ class Organizations extends sdks_js_1.ClientSDK {
      * @remarks
      * List or search facilities.
      *
+     * **Permissions.** Requires any of `facilities.view`, `facility.search` or `targeted_facilities.view`. Callers holding only `targeted_facilities.view` or `facility.search` see a reduced record, and expansion scopes are applied only to facilities within their read scope.
+     *
      * Available `expand` scopes are:
      *
-     * - facility.appointment_policy
-     * - facility.contacts
-     * - facility.vendor_counts
-     * - facility.flu_credential
-     * - facility.scrubs_policy
-     * - facility.system
-     * - facility.vendor_guest_policy
-     * - facility.vendor_policy
-     * - facility.visitor_policy
-     * - facility.workflow
+     * - `facility.system`
+     * - `facility.contacts`
+     * - `facility.vendor_counts`
+     * - `facility.appointment_policy`
+     * - `facility.vendor_policy`
+     * - `facility.vendor_guest_policy`
+     * - `facility.visitor_policy`
+     * - `facility.workflow_policy`
+     * - `facility.scrubs_policy`
+     * - `facility.flu_credential`
+     *
+     * Unrecognised values are ignored. Expansion is applied only to facilities the caller can read; rows outside that scope are returned unexpanded.
      */
     async listOrSearchFacilities(request, options) {
         return (0, operations_js_1.unwrapResultIterator)((0, organizationsListOrSearchFacilities_js_1.organizationsListOrSearchFacilities)(this, request, options));
@@ -49,6 +53,26 @@ class Organizations extends sdks_js_1.ClientSDK {
      *
      * @remarks
      * Retrieve an individual facility.
+     *
+     * **Permissions.** Requires `facilities.view`, `facility_profile.view`, or `targeted_facilities.view`. `facility.search` does not grant access on its own — it only extends the reach of a `targeted_facilities.view` caller to a facility they are not targeted at, returning the public summary for it instead of a 403.
+     *
+     * - Callers with `facilities.view` or `facility_profile.view` can look up any facility, but only receive full expansion for their own facility; for any other facility, expansion is dropped and only the public summary is returned.
+     * - Callers with `targeted_facilities.view` receive the full record and full expansion for a facility they are targeted at (a vendor's target facilities, or a facility/system user's own facility). For a facility they are not targeted at, they receive the public summary (no expansion) if they also hold `facility.search`, or a 401 otherwise.
+     *
+     * Available `expand` scopes are:
+     *
+     * - `facility.system`
+     * - `facility.contacts`
+     * - `facility.vendor_counts`
+     * - `facility.appointment_policy`
+     * - `facility.vendor_policy`
+     * - `facility.vendor_guest_policy`
+     * - `facility.visitor_policy`
+     * - `facility.workflow_policy`
+     * - `facility.scrubs_policy`
+     * - `facility.flu_credential`
+     *
+     * Unrecognised values are ignored. Expansion is dropped entirely for callers who can only see the facility's public summary.
      */
     async getFacility(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, organizationsGetFacility_js_1.organizationsGetFacility)(this, request, options));
@@ -58,6 +82,8 @@ class Organizations extends sdks_js_1.ClientSDK {
      *
      * @remarks
      * List or search departments.
+     *
+     * **Permissions.** Requires the `departments.view` permission.
      */
     async listOrSearchDepartments(request, options) {
         return (0, operations_js_1.unwrapResultIterator)((0, organizationsListOrSearchDepartments_js_1.organizationsListOrSearchDepartments)(this, request, options));
@@ -71,9 +97,15 @@ class Organizations extends sdks_js_1.ClientSDK {
      * and parent system), the link status, and per-facility counts of the
      * company's individuals targeting it.
      *
-     * When `include_potential_targets=true`, returns ALL non-deleted facilities
-     * via a LEFT JOIN. Targeted rows carry their CTF `id` and `status`; non-targeted
-     * rows have `id: null` and `status: "Not Targeted"`.
+     * When `include_potential_targets=true`, returns every non-deleted facility
+     * reachable via a LEFT JOIN against the caller's *potential-target* scope:
+     * for a facility/system/vendor/company-manager caller, that's the public,
+     * non-deleted, listed facility directory plus the caller's own read scope
+     * for Facility — not the read scope alone, so the roster includes
+     * facilities the caller has no existing relationship with. An API-user
+     * caller is the exception: it sees only its own read scope, with no
+     * directory added. Targeted rows carry their CTF `id` and `status`;
+     * non-targeted rows have `id: null` and `status: "Not Targeted"`.
      *
      * Access control: the URL's `company_id` must be in the caller's read scope
      * for Company (a company manager's or vendor's own company, or a company
@@ -83,9 +115,13 @@ class Organizations extends sdks_js_1.ClientSDK {
      * Filter with `has_individual` / `has_active_individual` to drive the
      * facility roster views.
      *
+     * **Permissions.** Requires the `target_facilities.view` permission.
+     *
      * Available `expand` scopes are:
      *
-     * - company_target_facility.facility
+     * - `company_target_facility.facility`
+     *
+     * Any other value is rejected with `422 Unprocessable Entity`.
      */
     async listCompanyTargetFacilities(request, options) {
         return (0, operations_js_1.unwrapResultIterator)((0, organizationsListCompanyTargetFacilities_js_1.organizationsListCompanyTargetFacilities)(this, request, options));
@@ -100,15 +136,27 @@ class Organizations extends sdks_js_1.ClientSDK {
      *
      * Access control: the URL's `company_id` must be in the caller's update
      * scope for Company, AND the `facility_id` must be in the caller's create
-     * scope for Facility (a facility on the company's site, or a facility
-     * reachable via the API user's site/system/facility-scoped activation).
-     * Either being out of scope returns `404 Company not found` /
-     * `404 Facility not found` respectively. Deleted facilities also return
-     * `404 Facility not found`.
+     * scope for Facility. For a facility/system/vendor/company-manager caller,
+     * that create scope is widened the same way listing's potential-target
+     * scope is: it includes the public, non-deleted, listed facility directory
+     * in addition to the caller's own create scope, so a non-deleted publicly
+     * listed facility can be targeted even when it isn't otherwise in the
+     * caller's Facility relation. An API-user caller is the exception —
+     * restricted to its own create scope (a facility on the company's site, or
+     * a facility reachable via the API user's site/system/facility-scoped
+     * activation), with no directory added. Either being out of scope returns
+     * `404 Company not found` / `404 Facility not found` respectively. Deleted
+     * facilities also return `404 Facility not found`.
+     *
+     * **Permissions.** Requires the `target_facilities.add` permission.
+     *
+     * **Permissions.** Requires the `target_facilities.add` permission.
      *
      * Available `expand` scopes are:
      *
-     * - company_target_facility.facility
+     * - `company_target_facility.facility`
+     *
+     * Any other value is rejected with `422 Unprocessable Entity`.
      */
     async createCompanyTargetFacility(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, organizationsCreateCompanyTargetFacility_js_1.organizationsCreateCompanyTargetFacility)(this, request, options));
@@ -126,6 +174,8 @@ class Organizations extends sdks_js_1.ClientSDK {
      * scope for Company (a company manager's or vendor's own company, or a
      * company whose app is activated for the API user). Callers outside that
      * scope receive `404 Company not found`.
+     *
+     * **Permissions.** Requires the `target_facilities.delete` permission.
      */
     async deleteCompanyTargetFacility(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, organizationsDeleteCompanyTargetFacility_js_1.organizationsDeleteCompanyTargetFacility)(this, request, options));
@@ -142,6 +192,8 @@ class Organizations extends sdks_js_1.ClientSDK {
      *
      * Access control: the URL's `company_id` must be in the caller's read scope for Company. Callers
      * outside that scope receive `404 Company not found`.
+     *
+     * **Permissions.** Requires the `target_facilities.view` permission.
      */
     async exportCompanyTargetFacilities(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, organizationsExportCompanyTargetFacilities_js_1.organizationsExportCompanyTargetFacilities)(this, request, options));
@@ -152,6 +204,8 @@ class Organizations extends sdks_js_1.ClientSDK {
      * @remarks
      * Poll the state of an asynchronous company target facilities export job. When `ready` is true,
      * the export is complete and can be downloaded via the download endpoint.
+     *
+     * **Permissions.** Requires the `target_facilities.view` permission.
      */
     async getCompanyTargetFacilitiesExportStatus(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, organizationsGetCompanyTargetFacilitiesExportStatus_js_1.organizationsGetCompanyTargetFacilitiesExportStatus)(this, request, options));
@@ -162,6 +216,8 @@ class Organizations extends sdks_js_1.ClientSDK {
      * @remarks
      * Returns the exported company target facilities 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 `target_facilities.view` permission.
      */
     async downloadCompanyTargetFacilitiesExport(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, organizationsDownloadCompanyTargetFacilitiesExport_js_1.organizationsDownloadCompanyTargetFacilitiesExport)(this, request, options));
@@ -190,6 +246,8 @@ class Organizations extends sdks_js_1.ClientSDK {
      *   * API users: must pass `company_id`. Both the company and the facility
      *     must be activated for the caller's marketplace app
      *     (`MarketplaceAppActivation`).
+     *
+     * **Permissions.** Requires the `vendors.view` permission.
      */
     async listFacilityVendors(request, options) {
         return (0, operations_js_1.unwrapResultIterator)((0, organizationsListFacilityVendors_js_1.organizationsListFacilityVendors)(this, request, options));
@@ -213,6 +271,8 @@ class Organizations extends sdks_js_1.ClientSDK {
      *   * API users — `company_id` required; both the company AND the facility must be
      *     activated for the caller's marketplace app via the join-scoped
      *     `MarketplaceAppActivation` check.
+     *
+     * **Permissions.** Requires the `vendors.view` permission.
      */
     async exportFacilityVendors(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, organizationsExportFacilityVendors_js_1.organizationsExportFacilityVendors)(this, request, options));
@@ -223,6 +283,8 @@ class Organizations extends sdks_js_1.ClientSDK {
      * @remarks
      * Poll the state of an asynchronous facility vendors export job. When `ready` is true,
      * the export is complete and can be downloaded via the download endpoint.
+     *
+     * **Permissions.** Requires the `vendors.view` permission.
      */
     async getFacilityVendorsExportStatus(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, organizationsGetFacilityVendorsExportStatus_js_1.organizationsGetFacilityVendorsExportStatus)(this, request, options));
@@ -234,6 +296,8 @@ class Organizations extends sdks_js_1.ClientSDK {
      * Returns the exported facility vendors 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 `vendors.view` permission.
      */
     async downloadFacilityVendorsExport(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, organizationsDownloadFacilityVendorsExport_js_1.organizationsDownloadFacilityVendorsExport)(this, request, options));
@@ -244,10 +308,14 @@ class Organizations extends sdks_js_1.ClientSDK {
      * @remarks
      * List or search department contacts.
      *
+     * **Permissions.** Requires the `departments.view` permission.
+     *
      * Available `expand` scopes are:
      *
-     * - department_membership.contact
-     * - department_membership.department
+     * - `department_membership.contact`
+     * - `department_membership.department`
+     *
+     * Unrecognised values are ignored.
      */
     async listOrSearchDepartmentContacts(request, options) {
         return (0, operations_js_1.unwrapResultIterator)((0, organizationsListOrSearchDepartmentContacts_js_1.organizationsListOrSearchDepartmentContacts)(this, request, options));

package/dist/commonjs/sdk/organizations.js.map

@@ -1 +1 @@
-{"version":3,"file":"organizations.js","sourceRoot":"","sources":["../../../src/sdk/organizations.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,sHAAgH;AAChH,sHAAgH;AAChH,0IAAoI;AACpI,0HAAoH;AACpH,0HAAoH;AACpH,0GAAoG;AACpG,4IAAsI;AACtI,sFAAgF;AAChF,4HAAsH;AACtH,sHAAgH;AAChH,sGAAgG;AAChG,4HAAsH;AACtH,8GAAwG;AACxG,4GAAsG;AACtG,4CAA2D;AAG3D,0CAA6C;AAC7C,0DAA4E;AAE5E,MAAa,aAAc,SAAQ,mBAAS;IAC1C;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,sBAAsB,CAC1B,OAAiD,EACjD,OAAwB;QAIxB,OAAO,IAAA,oCAAoB,EAAC,IAAA,4EAAmC,EAC7D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,WAAW,CACf,OAAsC,EACtC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,sDAAwB,EACzC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,uBAAuB,CAC3B,OAAkD,EAClD,OAAwB;QAIxB,OAAO,IAAA,oCAAoB,EAAC,IAAA,8EAAoC,EAC9D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,KAAK,CAAC,2BAA2B,CAC/B,OAAsD,EACtD,OAAwB;QAOxB,OAAO,IAAA,oCAAoB,EAAC,IAAA,sFAAwC,EAClE,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,2BAA2B,CAC/B,OAAsD,EACtD,OAAwB;QAIxB,OAAO,IAAA,mBAAW,EAAC,IAAA,sFAAwC,EACzD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,2BAA2B,CAC/B,OAAsD,EACtD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,sFAAwC,EACzD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,6BAA6B,CACjC,OAAwD,EACxD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0FAA0C,EAC3D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,sCAAsC,CAC1C,OAAiE,EACjE,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,4GAAmD,EACpE,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,qCAAqC,CACzC,OAAgE,EAChE,OAAwB;QAIxB,OAAO,IAAA,mBAAW,EAAC,IAAA,0GAAkD,EACnE,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAA8C,EAC9C,OAAwB;QAIxB,OAAO,IAAA,oCAAoB,EAAC,IAAA,sEAAgC,EAC1D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,qBAAqB,CACzB,OAAgD,EAChD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0EAAkC,EACnD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,8BAA8B,CAClC,OAAyD,EACzD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,4FAA2C,EAC5D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,6BAA6B,CACjC,OAAwD,EACxD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0FAA0C,EAC3D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,8BAA8B,CAClC,OAAyD,EACzD,OAAwB;QAOxB,OAAO,IAAA,oCAAoB,EAAC,IAAA,4FAA2C,EACrE,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AA1WD,sCA0WC"}
+{"version":3,"file":"organizations.js","sourceRoot":"","sources":["../../../src/sdk/organizations.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,sHAAgH;AAChH,sHAAgH;AAChH,0IAAoI;AACpI,0HAAoH;AACpH,0HAAoH;AACpH,0GAAoG;AACpG,4IAAsI;AACtI,sFAAgF;AAChF,4HAAsH;AACtH,sHAAgH;AAChH,sGAAgG;AAChG,4HAAsH;AACtH,8GAAwG;AACxG,4GAAsG;AACtG,4CAA2D;AAG3D,0CAA6C;AAC7C,0DAA4E;AAE5E,MAAa,aAAc,SAAQ,mBAAS;IAC1C;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,sBAAsB,CAC1B,OAAiD,EACjD,OAAwB;QAIxB,OAAO,IAAA,oCAAoB,EAAC,IAAA,4EAAmC,EAC7D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,KAAK,CAAC,WAAW,CACf,OAAsC,EACtC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,sDAAwB,EACzC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,uBAAuB,CAC3B,OAAkD,EAClD,OAAwB;QAIxB,OAAO,IAAA,oCAAoB,EAAC,IAAA,8EAAoC,EAC9D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,KAAK,CAAC,2BAA2B,CAC/B,OAAsD,EACtD,OAAwB;QAOxB,OAAO,IAAA,oCAAoB,EAAC,IAAA,sFAAwC,EAClE,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,KAAK,CAAC,2BAA2B,CAC/B,OAAsD,EACtD,OAAwB;QAIxB,OAAO,IAAA,mBAAW,EAAC,IAAA,sFAAwC,EACzD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,2BAA2B,CAC/B,OAAsD,EACtD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,sFAAwC,EACzD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,6BAA6B,CACjC,OAAwD,EACxD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0FAA0C,EAC3D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,sCAAsC,CAC1C,OAAiE,EACjE,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,4GAAmD,EACpE,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,qCAAqC,CACzC,OAAgE,EAChE,OAAwB;QAIxB,OAAO,IAAA,mBAAW,EAAC,IAAA,0GAAkD,EACnE,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAA8C,EAC9C,OAAwB;QAIxB,OAAO,IAAA,oCAAoB,EAAC,IAAA,sEAAgC,EAC1D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,qBAAqB,CACzB,OAAgD,EAChD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0EAAkC,EACnD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,8BAA8B,CAClC,OAAyD,EACzD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,4FAA2C,EAC5D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,6BAA6B,CACjC,OAAwD,EACxD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0FAA0C,EAC3D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,8BAA8B,CAClC,OAAyD,EACzD,OAAwB;QAOxB,OAAO,IAAA,oCAAoB,EAAC,IAAA,4FAA2C,EACrE,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AA9aD,sCA8aC"}

package/dist/commonjs/sdk/paymentprofile.d.ts

@@ -10,6 +10,8 @@ export declare class PaymentProfile extends ClientSDK {
      * This includes credit_balance and payment_profile which are account-level data, not invoice-specific.
      *
      * Only vendors and company managers can access this endpoint.
+     *
+     * **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.
      */
     getPaymentProfile(options?: RequestOptions): Promise<components.PaymentProfileInfo>;
     /**
@@ -19,6 +21,8 @@ export declare class PaymentProfile extends ClientSDK {
      * Deletes the payment profile for the logged-in user (vendor or company manager).
      *
      * Only vendors and company managers can access this endpoint.
+     *
+     * **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.
      */
     deletePaymentProfile(options?: RequestOptions): Promise<operations.DeletePaymentProfileDeletePaymentProfileOk>;
 }

package/dist/commonjs/sdk/paymentprofile.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"paymentprofile.d.ts","sourceRoot":"","sources":["../../../src/sdk/paymentprofile.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,cAAe,SAAQ,SAAS;IAC3C;;;;;;;;OAQG;IACG,iBAAiB,CACrB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAOzC;;;;;;;OAOG;IACG,oBAAoB,CACxB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,0CAA0C,CAAC;CAMlE"}
+{"version":3,"file":"paymentprofile.d.ts","sourceRoot":"","sources":["../../../src/sdk/paymentprofile.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,cAAe,SAAQ,SAAS;IAC3C;;;;;;;;;;OAUG;IACG,iBAAiB,CACrB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAOzC;;;;;;;;;OASG;IACG,oBAAoB,CACxB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,0CAA0C,CAAC;CAMlE"}

package/dist/commonjs/sdk/paymentprofile.js

@@ -17,6 +17,8 @@ class PaymentProfile extends sdks_js_1.ClientSDK {
      * This includes credit_balance and payment_profile which are account-level data, not invoice-specific.
      *
      * Only vendors and company managers can access this endpoint.
+     *
+     * **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 getPaymentProfile(options) {
         return (0, fp_js_1.unwrapAsync)((0, paymentProfileGetPaymentProfile_js_1.paymentProfileGetPaymentProfile)(this, options));
@@ -28,6 +30,8 @@ class PaymentProfile extends sdks_js_1.ClientSDK {
      * Deletes the payment profile for the logged-in user (vendor or company manager).
      *
      * Only vendors and company managers can access this endpoint.
+     *
+     * **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 deletePaymentProfile(options) {
         return (0, fp_js_1.unwrapAsync)((0, paymentProfileDeletePaymentProfile_js_1.paymentProfileDeletePaymentProfile)(this, options));

package/dist/commonjs/sdk/paymentprofile.js.map

@@ -1 +1 @@
-{"version":3,"file":"paymentprofile.js","sourceRoot":"","sources":["../../../src/sdk/paymentprofile.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,0GAAoG;AACpG,oGAA8F;AAC9F,4CAA2D;AAG3D,0CAA6C;AAE7C,MAAa,cAAe,SAAQ,mBAAS;IAC3C;;;;;;;;OAQG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,oEAA+B,EAChD,IAAI,EACJ,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,oBAAoB,CACxB,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0EAAkC,EACnD,IAAI,EACJ,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AAnCD,wCAmCC"}
+{"version":3,"file":"paymentprofile.js","sourceRoot":"","sources":["../../../src/sdk/paymentprofile.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,0GAAoG;AACpG,oGAA8F;AAC9F,4CAA2D;AAG3D,0CAA6C;AAE7C,MAAa,cAAe,SAAQ,mBAAS;IAC3C;;;;;;;;;;OAUG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,oEAA+B,EAChD,IAAI,EACJ,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,oBAAoB,CACxB,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0EAAkC,EACnD,IAAI,EACJ,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AAvCD,wCAuCC"}

package/dist/commonjs/sdk/reports.d.ts

@@ -23,6 +23,8 @@ export declare class Reports extends ClientSDK {
      * for `ScheduledReport` — the facility or system it belongs to, a scheduled report the
      * caller is an explicit recipient of, or a scheduled report whose app is activated for
      * the API user. Callers outside that scope receive `404 Scheduled report not found`.
+     *
+     * **Permissions.** Requires the `scheduled_reports.view` permission.
      */
     initiateScheduledReport(request: operations.InitiateScheduledReportRequest, options?: RequestOptions): Promise<operations.InitiateScheduledReportInitiateScheduledReportOk>;
     /**
@@ -53,6 +55,8 @@ export declare class Reports extends ClientSDK {
      * `FullReport` — the facility or system it was run for, a recipient of the schedule that
      * produced it, or a report whose app is activated for the API user. Callers outside that
      * scope receive `404 Full report not found`.
+     *
+     * **Permissions.** Requires the `scheduled_reports.view` permission.
      */
     getFullReport(request: operations.GetFullReportRequest, options?: RequestOptions): Promise<operations.GetFullReportGetFullReportOk>;
 }

package/dist/commonjs/sdk/reports.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reports.d.ts","sourceRoot":"","sources":["../../../src/sdk/reports.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,OAAQ,SAAQ,SAAS;IACpC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,uBAAuB,CAC3B,OAAO,EAAE,UAAU,CAAC,8BAA8B,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,gDAAgD,CAAC;IAQvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,4BAA4B,CAAC;CAOpD"}
+{"version":3,"file":"reports.d.ts","sourceRoot":"","sources":["../../../src/sdk/reports.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,OAAQ,SAAQ,SAAS;IACpC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,uBAAuB,CAC3B,OAAO,EAAE,UAAU,CAAC,8BAA8B,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,gDAAgD,CAAC;IAQvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,4BAA4B,CAAC;CAOpD"}

package/dist/commonjs/sdk/reports.js

@@ -31,6 +31,8 @@ class Reports extends sdks_js_1.ClientSDK {
      * for `ScheduledReport` — the facility or system it belongs to, a scheduled report the
      * caller is an explicit recipient of, or a scheduled report whose app is activated for
      * the API user. Callers outside that scope receive `404 Scheduled report not found`.
+     *
+     * **Permissions.** Requires the `scheduled_reports.view` permission.
      */
     async initiateScheduledReport(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, reportsInitiateScheduledReport_js_1.reportsInitiateScheduledReport)(this, request, options));
@@ -63,6 +65,8 @@ class Reports extends sdks_js_1.ClientSDK {
      * `FullReport` — the facility or system it was run for, a recipient of the schedule that
      * produced it, or a report whose app is activated for the API user. Callers outside that
      * scope receive `404 Full report not found`.
+     *
+     * **Permissions.** Requires the `scheduled_reports.view` permission.
      */
     async getFullReport(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, reportsGetFullReport_js_1.reportsGetFullReport)(this, request, options));

package/dist/commonjs/sdk/reports.js.map

@@ -1 +1 @@
-{"version":3,"file":"reports.js","sourceRoot":"","sources":["../../../src/sdk/reports.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,8EAAwE;AACxE,kGAA4F;AAC5F,4CAA2D;AAE3D,0CAA6C;AAE7C,MAAa,OAAQ,SAAQ,mBAAS;IACpC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,uBAAuB,CAC3B,OAAkD,EAClD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,kEAA8B,EAC/C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,KAAK,CAAC,aAAa,CACjB,OAAwC,EACxC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,8CAAoB,EACrC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AA1ED,0BA0EC"}
+{"version":3,"file":"reports.js","sourceRoot":"","sources":["../../../src/sdk/reports.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,8EAAwE;AACxE,kGAA4F;AAC5F,4CAA2D;AAE3D,0CAA6C;AAE7C,MAAa,OAAQ,SAAQ,mBAAS;IACpC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,KAAK,CAAC,uBAAuB,CAC3B,OAAkD,EAClD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,kEAA8B,EAC/C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,KAAK,CAAC,aAAa,CACjB,OAAwC,EACxC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,8CAAoB,EACrC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AA9ED,0BA8EC"}

package/dist/commonjs/sdk/supportarticles.d.ts

@@ -8,6 +8,8 @@ export declare class SupportArticles extends ClientSDK {
      *
      * @remarks
      * List or search support articles for FAQ.
+     *
+     * **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.
      */
     listOrSearchSupportArticles(request: operations.ListOrSearchSupportArticlesRequest, options?: RequestOptions): Promise<PageIterator<operations.ListOrSearchSupportArticlesResponse, {
         page: number;
@@ -18,12 +20,16 @@ export declare class SupportArticles extends ClientSDK {
      * @remarks
      * Retrieve an individual support article.
      *
+     * **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.
+     *
      * Available `expand` scopes are:
      *
-     * - support_article.description
-     * - support_article.published
-     * - support_article.notes
-     * - support_article.support_category
+     * - `support_article.description`
+     * - `support_article.notes`
+     * - `support_article.published`
+     * - `support_article.support_category`
+     *
+     * Unrecognised values are ignored.
      */
     getSupportArticle(request: operations.GetSupportArticleRequest, options?: RequestOptions): Promise<components.SupportArticle>;
 }

package/dist/commonjs/sdk/supportarticles.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"supportarticles.d.ts","sourceRoot":"","sources":["../../../src/sdk/supportarticles.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAE5D,OAAO,EAAE,YAAY,EAAwB,MAAM,wBAAwB,CAAC;AAE5E,qBAAa,eAAgB,SAAQ,SAAS;IAC5C;;;;;OAKG;IACG,2BAA2B,CAC/B,OAAO,EAAE,UAAU,CAAC,kCAAkC,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CACV,UAAU,CAAC,mCAAmC,EAC9C;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CACjB,CACF;IAQD;;;;;;;;;;;;OAYG;IACG,iBAAiB,CACrB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC;CAOtC"}
+{"version":3,"file":"supportarticles.d.ts","sourceRoot":"","sources":["../../../src/sdk/supportarticles.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAE5D,OAAO,EAAE,YAAY,EAAwB,MAAM,wBAAwB,CAAC;AAE5E,qBAAa,eAAgB,SAAQ,SAAS;IAC5C;;;;;;;OAOG;IACG,2BAA2B,CAC/B,OAAO,EAAE,UAAU,CAAC,kCAAkC,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CACV,UAAU,CAAC,mCAAmC,EAC9C;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CACjB,CACF;IAQD;;;;;;;;;;;;;;;;OAgBG;IACG,iBAAiB,CACrB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC;CAOtC"}