@greensecurity/javascript-sdk 0.46.0-beta.4 → 0.46.0-beta.6

package/src/sdk/organizations.ts

@@ -27,11 +27,11 @@ export class Organizations extends ClientSDK {
    * List or search facilities
    *
    * @remarks
-   * List or search facilities.
+   * Lists or searches 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.
+   * **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 the API applies expansion scopes only to facilities within their read scope.
    *
-   * Available `expand` scopes are:
+   * The `expand` parameter accepts these scopes:
    *
    * - `facility.system`
    * - `facility.contacts`
@@ -44,7 +44,7 @@ export class Organizations extends ClientSDK {
    * - `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.
+   * The API ignores unrecognized values. It applies expansion only to facilities the caller can read and returns rows outside that scope unexpanded.
    */
   async listOrSearchFacilities(
     request: operations.ListOrSearchFacilitiesRequest,
@@ -63,14 +63,14 @@ export class Organizations extends ClientSDK {
    * Get facility
    *
    * @remarks
-   * Retrieve an individual facility.
+   * Retrieves 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.
+   * **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.
+   * - 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, the server drops the expansion and returns only the public summary.
+   * - 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 user's or 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:
+   * Use any of the following `expand` scopes:
    *
    * - `facility.system`
    * - `facility.contacts`
@@ -83,7 +83,7 @@ export class Organizations extends ClientSDK {
    * - `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.
+   * The server ignores unrecognized values. The server drops expansion entirely for callers who can see only the facility's public summary.
    */
   async getFacility(
     request: operations.GetFacilityRequest,
@@ -100,7 +100,7 @@ export class Organizations extends ClientSDK {
    * List or search departments
    *
    * @remarks
-   * List or search departments.
+   * Lists or searches departments.
    *
    * **Permissions.** Requires the `departments.view` permission.
    */
@@ -121,24 +121,24 @@ export class Organizations extends ClientSDK {
    * List company target facilities
    *
    * @remarks
-   * Lists the CompanyTargetFacility links for a company — the facilities the
+   * Lists the CompanyTargetFacility links for a company—the facilities the
    * company is targeting. Each row carries the linked facility (with location
    * and parent system), the link status, and per-facility counts of the
    * company's individuals targeting it.
    *
    * 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,
+   * in the caller's *potential-target* scope, whether or not it is targeted.
+   * For a facility/system/vendor/company-manager caller, that scope is 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
+   * for facilities—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`;
+   * directory added. Targeted rows carry their link `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
-   * whose app is activated for the API user). Callers outside that scope
+   * with an app activation for the API user). Callers outside that scope
    * receive `404 Company not found`.
    *
    * Filter with `has_individual` / `has_active_individual` to drive the
@@ -146,11 +146,9 @@ export class Organizations extends ClientSDK {
    *
    * **Permissions.** Requires the `target_facilities.view` permission.
    *
-   * Available `expand` scopes are:
+   * The only available `expand` scope is `company_target_facility.facility`.
    *
-   * - `company_target_facility.facility`
-   *
-   * Any other value is rejected with `422 Unprocessable Entity`.
+   * The server rejects any other value with `422 Unprocessable Entity`.
    */
   async listCompanyTargetFacilities(
     request: operations.ListCompanyTargetFacilitiesRequest,
@@ -172,20 +170,20 @@ export class Organizations extends ClientSDK {
    * Add a company target facility
    *
    * @remarks
-   * Links the URL's company to an existing facility. The link is created with
-   * status `Pending`. Only the link row is created — the Facility entity
-   * itself is never created or modified by this endpoint.
+   * Links the URL's company to an existing facility. The link starts with
+   * status `Pending`. This endpoint creates only the link row. It never creates or modifies the facility entity
+   * itself.
    *
    * 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 Company, and the `facility_id` must be in the caller's create
    * 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
+   * that create scope widens the same way listing's potential-target
+   * scope does. 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 —
+   * listed facility is a valid target even when it isn't otherwise in the
+   * caller's Facility relation. An API-user caller is the exception. Its access is
    * 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
+   * a facility reachable through 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`.
@@ -194,11 +192,9 @@ export class Organizations extends ClientSDK {
    *
    * **Permissions.** Requires the `target_facilities.add` permission.
    *
-   * Available `expand` scopes are:
-   *
-   * - `company_target_facility.facility`
+   * The only available `expand` scope is `company_target_facility.facility`.
    *
-   * Any other value is rejected with `422 Unprocessable Entity`.
+   * The server rejects any other value with `422 Unprocessable Entity`.
    */
   async createCompanyTargetFacility(
     request: operations.CreateCompanyTargetFacilityRequest,
@@ -219,10 +215,10 @@ export class Organizations extends ClientSDK {
    * @remarks
    * Removes a CompanyTargetFacility link. Blocked when any of the company's
    * individuals still target the same facility (to avoid orphaning their
-   * vendor-scoped target rows). Only the link row is removed — the Facility
+   * vendor-scoped target rows). The operation removes only the link row; the facility
    * entity itself is never touched.
    *
-   * Access control: the URL's `company_id` must be in the caller's update
+   * Access control: the `company_id` in the URL must be in the caller's update
    * 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`.
@@ -250,7 +246,7 @@ export class Organizations extends ClientSDK {
    *
    * Returns a `status_url` for polling until the export is ready, along with a `download_url` and `status_id`.
    *
-   * Access control: the URL's `company_id` must be in the caller's read scope for Company. Callers
+   * Access control: the `company_id` in the URL 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.
@@ -270,8 +266,8 @@ export class Organizations extends ClientSDK {
    * Get company target facilities export status
    *
    * @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.
+   * Polls the state of an asynchronous company target facilities export job. When `ready` is true,
+   * the export is complete and you can download it from the download endpoint.
    *
    * **Permissions.** Requires the `target_facilities.view` permission.
    */
@@ -290,8 +286,8 @@ export class Organizations extends ClientSDK {
    * Download company target facilities CSV
    *
    * @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.
+   * Returns the exported company target facilities CSV through a 302 redirect to a short-lived presigned Amazon Simple Storage Service (S3) URL.
+   * If the export is still in progress, returns 202 with a JSON `{ ready: false }` payload.
    *
    * **Permissions.** Requires the `target_facilities.view` permission.
    */
@@ -312,25 +308,21 @@ export class Organizations extends ClientSDK {
    * List vendors targeting a facility
    *
    * @remarks
-   * Powers the Company Portal → Facility Details page. Returns the
-   * paginated list of company-scoped vendor reps that are targeting the
-   * given facility, with each row carrying the rep's name + email, their
+   * Returns the paginated list of company-scoped vendor reps that are targeting the
+   * given facility, with each row carrying the rep's name and email, their
    * last visit to this facility, their facility access status, and any
-   * company custom fields the company has flagged `show_to_vendor` (which
-   * is where the "Employee ID" column on the UI lives).
+   * company custom fields the company has flagged `show_to_vendor`.
    *
-   * Filtering: pass `status=approved|pending|denied` to scope the rows to a
-   * single status tab. Pass `search=<term>` for a single search box that
-   * matches first name, last name, full name, email, OR any visible custom
-   * field value (covering the "search by name / email / Employee ID"
-   * requirement).
+   * Filtering: pass `status=approved|pending|denied` to return only the rows
+   * with that status. Pass `search=<term>` to match first name, last name,
+   * full name, email, or any visible custom field value.
    *
    * Access control:
-   *   * Regular users: the URL's `:id` must be in the caller's read scope for
-   *     Facility (resolved via `has_facility_access_policy`). Out-of-scope or
+   *   * Non-API users: the `:id` in the URL must be in the caller's read scope for
+   *     Facility (resolved through `has_facility_access_policy`). Out-of-scope or
    *     soft-deleted facilities return `404 Facility not found`.
    *   * API users: must pass `company_id`. Both the company and the facility
-   *     must be activated for the caller's marketplace app
+   *     must have an activation for the caller's marketplace app
    *     (`MarketplaceAppActivation`).
    *
    * **Permissions.** Requires the `vendors.view` permission.
@@ -353,19 +345,19 @@ export class Organizations extends ClientSDK {
    *
    * @remarks
    * Enqueues an asynchronous job to generate a CSV export of the vendors (vendor reps)
-   * targeting the given facility, applying the same access scope and filter parameters as
+   * targeting the given facility. The job applies the same access scope and filter parameters as
    * the listing endpoint. The CSV contains: Name, Email, one column per company custom field
-   * flagged `show_to_vendor` (e.g. Employee ID), Last Visit, and Status.
+   * flagged `show_to_vendor` (for example, Employee ID), Last Visit, and Status.
    *
    * Returns a `status_url` for polling until the export is ready, along with a `download_url`
    * and `status_id`.
    *
    * Access control mirrors the list endpoint:
-   *   * Regular users — facility must be in the caller's read scope (via
+   *   * Non-API users: facility must be in the caller's read scope (through
    *     `has_facility_access_policy`); company resolved from the session. Out-of-scope or
    *     soft-deleted facilities return `404 Facility not found`.
-   *   * API users — `company_id` required; both the company AND the facility must be
-   *     activated for the caller's marketplace app via the join-scoped
+   *   * API users: `company_id` required; both the company and the facility need an activation
+   *     for the caller's marketplace app, verified with the join-scoped
    *     `MarketplaceAppActivation` check.
    *
    * **Permissions.** Requires the `vendors.view` permission.
@@ -385,8 +377,8 @@ export class Organizations extends ClientSDK {
    * Get facility vendors export status
    *
    * @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.
+   * Polls the state of an asynchronous facility vendors export job. When `ready` is true,
+   * the export is complete and you can download it from the download endpoint.
    *
    * **Permissions.** Requires the `vendors.view` permission.
    */
@@ -405,8 +397,8 @@ export class Organizations extends ClientSDK {
    * Download facility vendors CSV
    *
    * @remarks
-   * 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
+   * Returns the exported facility vendors CSV through a 302 redirect to a short-lived
+   * presigned Amazon Simple Storage Service (S3) URL. If the export is still in progress, returns 202 with a JSON
    * `{ ready: false }` payload.
    *
    * **Permissions.** Requires the `vendors.view` permission.
@@ -426,16 +418,16 @@ export class Organizations extends ClientSDK {
    * List or search department contacts
    *
    * @remarks
-   * List or search department contacts.
+   * Lists or searches department contacts.
    *
    * **Permissions.** Requires the `departments.view` permission.
    *
-   * Available `expand` scopes are:
+   * The `expand` parameter accepts the following scopes:
    *
    * - `department_membership.contact`
    * - `department_membership.department`
    *
-   * Unrecognised values are ignored.
+   * The server ignores unrecognized values.
    */
   async listOrSearchDepartmentContacts(
     request: operations.ListOrSearchDepartmentContactsRequest,

package/src/sdk/paymentprofile.ts

@@ -15,11 +15,11 @@ export class PaymentProfile extends ClientSDK {
    *
    * @remarks
    * Returns payment profile information for the logged-in user (vendor or company manager).
-   * This includes credit_balance and payment_profile which are account-level data, not invoice-specific.
+   * 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.
+   * **Permissions.** Requires a valid token. This endpoint is not gated on a named permission: the caller's role and their relationship to the record determine what the response contains.
    */
   async getPaymentProfile(
     options?: RequestOptions,
@@ -38,7 +38,7 @@ export class PaymentProfile extends ClientSDK {
    *
    * 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.
+   * **Permissions.** Requires a valid token. This endpoint is not gated on a named permission: the caller's role and their relationship to the record determine what the response contains.
    */
   async deletePaymentProfile(
     options?: RequestOptions,

package/src/sdk/reports.ts

@@ -13,22 +13,21 @@ export class Reports extends ClientSDK {
    * Generate a scheduled report now
    *
    * @remarks
-   * Immediately generates a new report run for a scheduled report, independent of its
+   * Generates a report run for a scheduled report immediately, independent of its
    * configured schedule. Returns a `poll_url` for the generated `FullReport`.
    *
    * Generation is asynchronous. Poll `GET /reports/{full_report_id}` on the **status code**,
    * not on a status field: while the run is pending or processing that endpoint returns `409`
    * with an error envelope and no `status` to read. Retry the `409` until it turns into `200`,
    * which carries the `full_report` payload and the signed download URL. `409` is the only
-   * retryable status — a canceled or failed run returns `422`, so no error-message matching is
-   * needed to decide when to give up.
+   * retryable status—a canceled or failed run returns `422`, so you do not need error-message matching
+   * to decide when to give up.
    *
-   * Bound the retries with your own timeout or attempt limit. Report generation has no terminal
-   * failure state today, so a run whose generation crashed stays in `processing` and answers
-   * `409` indefinitely rather than turning into a `422`.
+   * Bound the retries with your own timeout or attempt limit. A run whose generation worker crashed
+   * can stay in `processing` and answer `409` indefinitely instead of turning into a `422`.
    *
-   * Access control: the URL's `scheduled_report_id` must be in the caller's read scope
-   * for `ScheduledReport` — the facility or system it belongs to, a scheduled report the
+   * Access control: the `scheduled_report_id` in the URL must be in the caller's read scope
+   * 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`.
    *
@@ -49,29 +48,29 @@ export class Reports extends ClientSDK {
    * Get a generated report's status and download URL
    *
    * @remarks
-   * Returns a completed report run and a short-lived signed `report_url` (valid 5 minutes).
+   * Returns a completed report run and a short-lived signed `report_url` (valid for five minutes).
    *
    * Only a completed run returns the `full_report` payload. A run that has not finished does
-   * **not** come back with a `status` field to inspect — it returns an error envelope. Poll on
+   * **not** come back with a `status` field to inspect—it returns an error envelope. Poll on
    * the status code alone; `409` is the only retryable outcome, so no error-message matching is
    * needed:
    *
    * | Status | Meaning | What to do |
    * | --- | --- | --- |
    * | `200` | The run finished. | Download `full_report.report_url` within 5 minutes. |
-   * | `409` | Still pending or processing. | Retry, but bound it — see below. |
-   * | `422` | Terminal: the run was canceled or failed, or the id is not a positive integer. | Stop. |
+   * | `409` | Still pending or processing. | Retry, but bound it (see **Bound your polling**). |
+   * | `422` | Terminal: The run was canceled or failed, or the id is not a positive integer. | Stop. |
    * | `404` | No such run, or it is outside your access scope. | Stop. |
    * | `403` | Your account is locked, or lacks the `scheduled_reports` view permission. | Stop. |
    *
    * **Bound your polling.** A `409` is not a promise that the run will finish. A run that fails
-   * while generating is now recorded as `failed` and answers `422`, but a run whose worker died
+   * while generating is recorded as `failed` and answers `422`. A run whose worker died
    * outright still stays in `processing` and keeps answering `409` indefinitely. Apply your own
    * timeout or maximum attempt count and treat exhaustion as a failure; do not retry forever.
    *
-   * Access control: the URL's `full_report_id` must be in the caller's read scope for
-   * `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
+   * Access control: the `full_report_id` in the URL must be in the caller's read scope for
+   * `FullReport`—the facility or system it ran for, a recipient of the schedule that
+   * produced it, or a report whose app has an activation for the API user. Callers outside that
    * scope receive `404 Full report not found`.
    *
    * **Permissions.** Requires the `scheduled_reports.view` permission.

package/src/sdk/supportarticles.ts

@@ -15,9 +15,9 @@ export class SupportArticles extends ClientSDK {
    * List or search support articles
    *
    * @remarks
-   * List or search support articles for FAQ.
+   * Lists or searches 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.
+   * **Permissions.** Requires a valid token. This endpoint is not gated on a named permission. The caller's role and their relationship to the record determine what the response contains.
    */
   async listOrSearchSupportArticles(
     request: operations.ListOrSearchSupportArticlesRequest,
@@ -39,18 +39,18 @@ export class SupportArticles extends ClientSDK {
    * Get support article
    *
    * @remarks
-   * Retrieve an individual support article.
+   * Retrieves 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.
+   * **Permissions.** Requires a valid token. This endpoint is not gated on a named permission. The caller's role and their relationship to the record determine what the endpoint returns.
    *
-   * Available `expand` scopes are:
+   * The `expand` parameter accepts the following scopes:
    *
    * - `support_article.description`
    * - `support_article.notes`
    * - `support_article.published`
    * - `support_article.support_category`
    *
-   * Unrecognised values are ignored.
+   * The endpoint ignores unrecognized values.
    */
   async getSupportArticle(
     request: operations.GetSupportArticleRequest,

package/src/sdk/systems.ts

@@ -12,11 +12,11 @@ export class Systems extends ClientSDK {
    * List systems
    *
    * @remarks
-   * List or search systems.
+   * Lists or searches systems.
    *
-   * **Permissions.** Requires the `systems.view` permission. `facilities.view` is additionally needed for the `system.facilities` expansion scope to be applied.
+   * **Permissions.** Requires the `systems.view` permission. The `system.facilities` expansion scope also requires `facilities.view`.
    *
-   * Available `expand` scopes are:
+   * The `expand` parameter accepts the following scopes:
    *
    * - `system.facilities`
    * - `system.location`
@@ -31,7 +31,7 @@ export class Systems extends ClientSDK {
    * - `system.pricing_model`
    * - `system.initiate_visit_request_requirements`
    *
-   * Unrecognised values are ignored. Each scope is also accepted without the `system.` prefix (`location`, `gpo`, and so on) for backwards compatibility. Expansion is dropped for callers without facilities-view permission.
+   * The endpoint ignores unrecognized values. Each scope is also accepted without the `system.` prefix (`location`, `gpo`, and so on) for backwards compatibility. The endpoint drops expansion for callers without facilities-view permission.
    */
   async listSystems(
     request: operations.ListSystemsRequest,