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

package/dist/commonjs/funcs/vendorsListVendors.d.ts

@@ -15,13 +15,13 @@ import { PageIterator } from "../types/operations.js";
  * @remarks
  * Returns a paginated list of vendors.
  *
- * External vendors are 3rd parties who have consented to have their profile managed by companies in our system.
+ * External vendors are third parties who have consented to have their profile managed by companies on the platform.
  * Common use cases for this are 1099 contractors who represent multiple companies or any vendor that has their
  * credentials or payments handled by a company other than the one they use to do business with a facility.
  *
  * **Permissions.** Requires the `vendors.view` permission.
  *
- * Available `expand` scopes are:
+ * The `expand` parameter accepts the following scopes:
  *
  * - `vendor.user`
  * - `vendor.vendor_type`
@@ -57,7 +57,7 @@ import { PageIterator } from "../types/operations.js";
  * - `subscription.next_financial_status`
  * - `subscription.expedited_offers`
  *
- * Any other value is rejected with `422 Unprocessable Entity`.
+ * The API rejects any other value with `422 Unprocessable Entity`.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/dist/commonjs/funcs/vendorsListVendors.js

@@ -54,13 +54,13 @@ const operations_js_1 = require("../types/operations.js");
  * @remarks
  * Returns a paginated list of vendors.
  *
- * External vendors are 3rd parties who have consented to have their profile managed by companies in our system.
+ * External vendors are third parties who have consented to have their profile managed by companies on the platform.
  * Common use cases for this are 1099 contractors who represent multiple companies or any vendor that has their
  * credentials or payments handled by a company other than the one they use to do business with a facility.
  *
  * **Permissions.** Requires the `vendors.view` permission.
  *
- * Available `expand` scopes are:
+ * The `expand` parameter accepts the following scopes:
  *
  * - `vendor.user`
  * - `vendor.vendor_type`
@@ -96,7 +96,7 @@ const operations_js_1 = require("../types/operations.js");
  * - `subscription.next_financial_status`
  * - `subscription.expedited_offers`
  *
- * Any other value is rejected with `422 Unprocessable Entity`.
+ * The API rejects any other value with `422 Unprocessable Entity`.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/dist/commonjs/funcs/vendorsPurchaseScrubCredits.d.ts

@@ -12,9 +12,9 @@ import { Result } from "../types/fp.js";
  * Purchase scrub credits
  *
  * @remarks
- * Purchase scrub credits
+ * Purchases scrub credits.
  *
- * **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.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/dist/commonjs/funcs/vendorsPurchaseScrubCredits.js

@@ -51,9 +51,9 @@ const async_js_1 = require("../types/async.js");
  * Purchase scrub credits
  *
  * @remarks
- * Purchase scrub credits
+ * Purchases scrub credits.
  *
- * **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.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/dist/commonjs/funcs/vendorsSendDownloadCode.d.ts

@@ -12,9 +12,9 @@ import { Result } from "../types/fp.js";
  * Send download code for vendor credential
  *
  * @remarks
- * It will send download code for vendor credential
+ * Sends a download code for the vendor credential.
  *
- * **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 decide what the response includes.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/dist/commonjs/funcs/vendorsSendDownloadCode.js

@@ -52,9 +52,9 @@ const types$ = __importStar(require("../types/primitives.js"));
  * Send download code for vendor credential
  *
  * @remarks
- * It will send download code for vendor credential
+ * Sends a download code for the vendor credential.
  *
- * **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 decide what the response includes.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/dist/commonjs/funcs/vendorsSubmitVendorCredential.d.ts

@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
  * Submit vendor credential
  *
  * @remarks
- * It will submit vendor credential
+ * Submits the vendor credential.
  *
  * **Permissions.** Requires the `vendor_credentials.view` permission.
  *

package/dist/commonjs/funcs/vendorsSubmitVendorCredential.js

@@ -52,7 +52,7 @@ const types$ = __importStar(require("../types/primitives.js"));
  * Submit vendor credential
  *
  * @remarks
- * It will submit vendor credential
+ * Submits the vendor credential.
  *
  * **Permissions.** Requires the `vendor_credentials.view` permission.
  *

package/dist/commonjs/funcs/vendorsUpdateVendorCredentialData.d.ts

@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
  * Update vendor credential data
  *
  * @remarks
- * Update vendor credential data
+ * Updates vendor credential data
  *
  * **Permissions.** Requires the `vendor_credentials.edit` permission.
  *

package/dist/commonjs/funcs/vendorsUpdateVendorCredentialData.js

@@ -52,7 +52,7 @@ const types$ = __importStar(require("../types/primitives.js"));
  * Update vendor credential data
  *
  * @remarks
- * Update vendor credential data
+ * Updates vendor credential data
  *
  * **Permissions.** Requires the `vendor_credentials.edit` permission.
  *

package/dist/commonjs/funcs/vendorsUpdateVendorCredentialFile.d.ts

@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
  * Update vendor credential file
  *
  * @remarks
- * It will update the vendor credential file properties
+ * Updates the vendor credential file properties.
  *
  * **Permissions.** Requires the `vendor_credentials.view` permission.
  *

package/dist/commonjs/funcs/vendorsUpdateVendorCredentialFile.js

@@ -52,7 +52,7 @@ const types$ = __importStar(require("../types/primitives.js"));
  * Update vendor credential file
  *
  * @remarks
- * It will update the vendor credential file properties
+ * Updates the vendor credential file properties.
  *
  * **Permissions.** Requires the `vendor_credentials.view` permission.
  *

package/dist/commonjs/funcs/vendorsUpdateVendorCustomField.d.ts

@@ -14,7 +14,7 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  * Sets or updates a custom field value for the specified vendor. If the value
- * does not exist it is created; if it already exists it is updated (upsert).
+ * does not exist, the API creates it; if it already exists, the API updates it (upsert).
  *
  * The vendor field must belong to the vendor's company or to one of the
  * vendor's targeted facilities, and must have `show_to_vendor` set to `true`.

package/dist/commonjs/funcs/vendorsUpdateVendorCustomField.js

@@ -53,7 +53,7 @@ const async_js_1 = require("../types/async.js");
  *
  * @remarks
  * Sets or updates a custom field value for the specified vendor. If the value
- * does not exist it is created; if it already exists it is updated (upsert).
+ * does not exist, the API creates it; if it already exists, the API updates it (upsert).
  *
  * The vendor field must belong to the vendor's company or to one of the
  * vendor's targeted facilities, and must have `show_to_vendor` set to `true`.

package/dist/commonjs/funcs/vendorsUpdateVendorDetails.d.ts

@@ -12,27 +12,27 @@ import { Result } from "../types/fp.js";
  * Update vendor details
  *
  * @remarks
- * Update an individual vendor's profile — title, location, supervisor, email
+ * Updates an individual vendor's profile—title, location, supervisor, email
  * preferences, primary department, and primary sales state. A company manager
  * can also remove the vendor from their company by sending `company_id: null`.
  *
  * From `location` this endpoint reads only `timezone`, `address1`, `address2`,
  * `city`, `state`, `zip`, `phone`, `mobile_phone` and `fax`. The `address` and
- * `country` properties of the shared `UserLocation` schema are ignored here and
+ * `country` properties of the shared `UserLocation` schema have no effect here, and
  * updating them is not supported. `state` accepts a US state or a Canadian
- * province — the vendor's country, set only at registration, is not editable
+ * province—the vendor's country, set only at registration, is not editable
  * through this endpoint.
  *
  * Submitting `location.zip` or `location.state` cross-checks the postal code
  * against the resulting state (using the vendor's existing value for whichever
- * of the two is left out of the request). A code that is not shaped like a real
- * postal code, or that provably belongs to a different state, is rejected with
+ * of the two you omit from the request). The server rejects a code that is not shaped like a real
+ * postal code, or that provably belongs to a different state, with
  * `422` naming the correct state.
  *
  * For `title`, the `supervisor` fields, and every `location` field except
- * `timezone`, the value sent is the value stored: omit a field to leave it
+ * `timezone`, the value sent is the value stored. Omit a field to leave it
  * unchanged, or send an empty string to clear it. `timezone` is the one
- * exception — it accepts only the values in its enum, so send one of those to
+ * exception. It accepts only the values in its enum, so send one of those to
  * change it and omit it to leave it unchanged.
  *
  * **Permissions.** Requires the `vendors.edit` permission.

package/dist/commonjs/funcs/vendorsUpdateVendorDetails.js

@@ -52,27 +52,27 @@ const types$ = __importStar(require("../types/primitives.js"));
  * Update vendor details
  *
  * @remarks
- * Update an individual vendor's profile — title, location, supervisor, email
+ * Updates an individual vendor's profile—title, location, supervisor, email
  * preferences, primary department, and primary sales state. A company manager
  * can also remove the vendor from their company by sending `company_id: null`.
  *
  * From `location` this endpoint reads only `timezone`, `address1`, `address2`,
  * `city`, `state`, `zip`, `phone`, `mobile_phone` and `fax`. The `address` and
- * `country` properties of the shared `UserLocation` schema are ignored here and
+ * `country` properties of the shared `UserLocation` schema have no effect here, and
  * updating them is not supported. `state` accepts a US state or a Canadian
- * province — the vendor's country, set only at registration, is not editable
+ * province—the vendor's country, set only at registration, is not editable
  * through this endpoint.
  *
  * Submitting `location.zip` or `location.state` cross-checks the postal code
  * against the resulting state (using the vendor's existing value for whichever
- * of the two is left out of the request). A code that is not shaped like a real
- * postal code, or that provably belongs to a different state, is rejected with
+ * of the two you omit from the request). The server rejects a code that is not shaped like a real
+ * postal code, or that provably belongs to a different state, with
  * `422` naming the correct state.
  *
  * For `title`, the `supervisor` fields, and every `location` field except
- * `timezone`, the value sent is the value stored: omit a field to leave it
+ * `timezone`, the value sent is the value stored. Omit a field to leave it
  * unchanged, or send an empty string to clear it. `timezone` is the one
- * exception — it accepts only the values in its enum, so send one of those to
+ * exception. It accepts only the values in its enum, so send one of those to
  * change it and omit it to leave it unchanged.
  *
  * **Permissions.** Requires the `vendors.edit` permission.

package/dist/commonjs/funcs/vendorsUpdateVendorManagedByCompany.d.ts

@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
  * Update vendor managed by company access rights
  *
  * @remarks
- * It will update the vendor managed by company access rights
+ * Updates the access rights that a company has for the vendor it manages.
  *
  * **Permissions.** Requires the `vendors.edit` permission.
  *

package/dist/commonjs/funcs/vendorsUpdateVendorManagedByCompany.js

@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
  * Update vendor managed by company access rights
  *
  * @remarks
- * It will update the vendor managed by company access rights
+ * Updates the access rights that a company has for the vendor it manages.
  *
  * **Permissions.** Requires the `vendors.edit` permission.
  *

package/dist/commonjs/funcs/vendorsUpdateVendorPaymentResponsibility.d.ts

@@ -15,8 +15,8 @@ import { Result } from "../types/fp.js";
  * Partially updates the payment responsibility record for a vendor. Only company
  * managers may call this endpoint. Each supplied `_user_id` must be either the
  * vendor's user ID (to assign responsibility back to the vendor) or the
- * authenticated manager's own user ID (to claim responsibility). Omitted fields
- * are left unchanged.
+ * authenticated manager's own user ID (to claim responsibility). The server leaves omitted fields
+ * unchanged.
  *
  * **Permissions.** Requires the `vendors.edit` permission.
  *

package/dist/commonjs/funcs/vendorsUpdateVendorPaymentResponsibility.js

@@ -54,8 +54,8 @@ const async_js_1 = require("../types/async.js");
  * Partially updates the payment responsibility record for a vendor. Only company
  * managers may call this endpoint. Each supplied `_user_id` must be either the
  * vendor's user ID (to assign responsibility back to the vendor) or the
- * authenticated manager's own user ID (to claim responsibility). Omitted fields
- * are left unchanged.
+ * authenticated manager's own user ID (to claim responsibility). The server leaves omitted fields
+ * unchanged.
  *
  * **Permissions.** Requires the `vendors.edit` permission.
  *

package/dist/commonjs/funcs/vendorsUpdateVendorScrubDetails.d.ts

@@ -12,9 +12,9 @@ import { Result } from "../types/fp.js";
  * Update vendor scrub details
  *
  * @remarks
- * Update vendor scrub details
+ * Updates vendor scrub details
  *
- * **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 decide what the endpoint returns.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/dist/commonjs/funcs/vendorsUpdateVendorScrubDetails.js

@@ -52,9 +52,9 @@ const types$ = __importStar(require("../types/primitives.js"));
  * Update vendor scrub details
  *
  * @remarks
- * Update vendor scrub details
+ * Updates vendor scrub details
  *
- * **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 decide what the endpoint returns.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/dist/commonjs/funcs/vendorsVendorsExport.d.ts

@@ -14,8 +14,8 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  * Enqueues an asynchronous job to generate a CSV export of vendors based on the
- * provided filters (the same filters supported by the vendors list endpoint), in the same
- * credential-inclusive format as the portal's "Download Full Report" button - one column per
+ * provided filters (the same filters supported by the vendors list endpoint). The file uses the same
+ * credential-inclusive format: one column per
  * applicable credential (status, due date, expiration), plus counts and percentage approved,
  * alongside the vendor's identity, contact, and company details.
  * Returns a `status_url` to poll until the export is ready, plus a
@@ -23,7 +23,7 @@ import { Result } from "../types/fp.js";
  *
  * **Permissions.** Requires the `vendors.view` permission.
  *
- * Available `expand` scopes are:
+ * Use any of the following `expand` scopes:
  *
  * - `vendor.user`
  * - `vendor.vendor_type`
@@ -59,7 +59,7 @@ import { Result } from "../types/fp.js";
  * - `subscription.next_financial_status`
  * - `subscription.expedited_offers`
  *
- * Any other value is rejected with `422 Unprocessable Entity`. The export job builds its own columns and does not consult `expand`, so the parameter is validated but has no effect on the generated CSV; it is accepted for backwards compatibility.
+ * For any other value, the server responds with `422 Unprocessable Entity`. The export job builds its own columns and ignores `expand`. The server still validates the parameter for backward compatibility, but it does not change the generated CSV.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/dist/commonjs/funcs/vendorsVendorsExport.js

@@ -53,8 +53,8 @@ const async_js_1 = require("../types/async.js");
  *
  * @remarks
  * Enqueues an asynchronous job to generate a CSV export of vendors based on the
- * provided filters (the same filters supported by the vendors list endpoint), in the same
- * credential-inclusive format as the portal's "Download Full Report" button - one column per
+ * provided filters (the same filters supported by the vendors list endpoint). The file uses the same
+ * credential-inclusive format: one column per
  * applicable credential (status, due date, expiration), plus counts and percentage approved,
  * alongside the vendor's identity, contact, and company details.
  * Returns a `status_url` to poll until the export is ready, plus a
@@ -62,7 +62,7 @@ const async_js_1 = require("../types/async.js");
  *
  * **Permissions.** Requires the `vendors.view` permission.
  *
- * Available `expand` scopes are:
+ * Use any of the following `expand` scopes:
  *
  * - `vendor.user`
  * - `vendor.vendor_type`
@@ -98,7 +98,7 @@ const async_js_1 = require("../types/async.js");
  * - `subscription.next_financial_status`
  * - `subscription.expedited_offers`
  *
- * Any other value is rejected with `422 Unprocessable Entity`. The export job builds its own columns and does not consult `expand`, so the parameter is validated but has no effect on the generated CSV; it is accepted for backwards compatibility.
+ * For any other value, the server responds with `422 Unprocessable Entity`. The export job builds its own columns and ignores `expand`. The server still validates the parameter for backward compatibility, but it does not change the generated CSV.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/dist/commonjs/funcs/webhooksCreateWebhookEndpoint.d.ts

@@ -13,18 +13,18 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  * Registers a URL to receive one or more events, and returns the endpoint together with its
- * signing secret. **The secret is only ever returned by this call** — store it before you
- * move on, it cannot be read back afterwards.
+ * signing secret. **The secret is only ever returned by this call**—store it before you
+ * move on, because you cannot read it back afterward.
  *
  * `subscriptions` takes event names, objects naming a `model`, an `action` and their own
  * `expands`, or a mix of the two. Only the pair of URL and event has to be unique, so the
- * events may be split over as many endpoints as you like, sharing a URL or not, as long as
+ * events can be split over as many endpoints as you like, sharing a URL or not, as long as
  * no URL hears the same event twice. A receiver taking several events on one path routes on
  * the `Green-Security-Event` header.
  *
- * `consumers` decides which entities you hear about and is validated against your own
- * access: naming a facility, system, company or user you cannot reach is rejected with a
- * `401`. Omit it and the endpoint is scoped to your own entity — for administrators and
+ * `consumers` selects which entities send you events, and the API validates it against your own
+ * access: naming a facility, system, company, or user you cannot reach gets a
+ * `401`. Omit it and the endpoint applies to your own entity—for administrators and
  * site-wide marketplace app installations, to every event of the site.
  *
  * Requires the `webhook` / `add` permission.

package/dist/commonjs/funcs/webhooksCreateWebhookEndpoint.js

@@ -52,18 +52,18 @@ const async_js_1 = require("../types/async.js");
  *
  * @remarks
  * Registers a URL to receive one or more events, and returns the endpoint together with its
- * signing secret. **The secret is only ever returned by this call** — store it before you
- * move on, it cannot be read back afterwards.
+ * signing secret. **The secret is only ever returned by this call**—store it before you
+ * move on, because you cannot read it back afterward.
  *
  * `subscriptions` takes event names, objects naming a `model`, an `action` and their own
  * `expands`, or a mix of the two. Only the pair of URL and event has to be unique, so the
- * events may be split over as many endpoints as you like, sharing a URL or not, as long as
+ * events can be split over as many endpoints as you like, sharing a URL or not, as long as
  * no URL hears the same event twice. A receiver taking several events on one path routes on
  * the `Green-Security-Event` header.
  *
- * `consumers` decides which entities you hear about and is validated against your own
- * access: naming a facility, system, company or user you cannot reach is rejected with a
- * `401`. Omit it and the endpoint is scoped to your own entity — for administrators and
+ * `consumers` selects which entities send you events, and the API validates it against your own
+ * access: naming a facility, system, company, or user you cannot reach gets a
+ * `401`. Omit it and the endpoint applies to your own entity—for administrators and
  * site-wide marketplace app installations, to every event of the site.
  *
  * Requires the `webhook` / `add` permission.

package/dist/commonjs/funcs/webhooksDeleteWebhookEndpoint.d.ts

@@ -10,13 +10,13 @@ import * as operations from "../models/operations/index.js";
 import { APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 /**
- * Deletes the webhook endpoint with the given ID.
+ * Deletes the webhook endpoint with the given ID
  *
  * @remarks
  * Stops the deliveries and removes the endpoint together with its delivery history.
  *
- * Endpoints are also removed on your behalf when the marketplace app installation they were
- * registered under is narrowed or uninstalled, so an integration never keeps receiving
+ * The server also removes endpoints on your behalf when someone narrows or uninstalls the marketplace app installation they were
+ * registered under. An integration therefore never keeps receiving
  * events for entities it lost access to.
  *
  * Requires the `webhook` / `delete` permission.

package/dist/commonjs/funcs/webhooksDeleteWebhookEndpoint.js

@@ -49,13 +49,13 @@ const errors = __importStar(require("../models/errors/index.js"));
 const operations = __importStar(require("../models/operations/index.js"));
 const async_js_1 = require("../types/async.js");
 /**
- * Deletes the webhook endpoint with the given ID.
+ * Deletes the webhook endpoint with the given ID
  *
  * @remarks
  * Stops the deliveries and removes the endpoint together with its delivery history.
  *
- * Endpoints are also removed on your behalf when the marketplace app installation they were
- * registered under is narrowed or uninstalled, so an integration never keeps receiving
+ * The server also removes endpoints on your behalf when someone narrows or uninstalls the marketplace app installation they were
+ * registered under. An integration therefore never keeps receiving
  * events for entities it lost access to.
  *
  * Requires the `webhook` / `delete` permission.

package/dist/commonjs/funcs/webhooksGetWebhookEndpoint.d.ts

@@ -10,13 +10,13 @@ import * as operations from "../models/operations/index.js";
 import { APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 /**
- * Retrieves the webhook endpoint with the given ID.
+ * Retrieves the webhook endpoint with the given ID
  *
  * @remarks
  * Returns the definition of a webhook endpoint by ID. `secrets` is not included: the signing
  * secret is only returned by `POST /webhooks`.
  *
- * An endpoint you cannot see is reported as `404`, so an ID belonging to somebody else is
+ * The API reports an endpoint you cannot see as `404`, so an ID belonging to somebody else is
  * indistinguishable from one that does not exist.
  *
  * Requires the `webhook` / `view` permission.

package/dist/commonjs/funcs/webhooksGetWebhookEndpoint.js

@@ -49,13 +49,13 @@ const errors = __importStar(require("../models/errors/index.js"));
 const operations = __importStar(require("../models/operations/index.js"));
 const async_js_1 = require("../types/async.js");
 /**
- * Retrieves the webhook endpoint with the given ID.
+ * Retrieves the webhook endpoint with the given ID
  *
  * @remarks
  * Returns the definition of a webhook endpoint by ID. `secrets` is not included: the signing
  * secret is only returned by `POST /webhooks`.
  *
- * An endpoint you cannot see is reported as `404`, so an ID belonging to somebody else is
+ * The API reports an endpoint you cannot see as `404`, so an ID belonging to somebody else is
  * indistinguishable from one that does not exist.
  *
  * Requires the `webhook` / `view` permission.

package/dist/commonjs/funcs/webhooksUpdatesTheWebhookEndpointWithTheGivenId.d.ts

@@ -10,32 +10,32 @@ import * as operations from "../models/operations/index.js";
 import { APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 /**
- * Updates the webhook endpoint with the given ID.
+ * Updates the webhook endpoint with the given ID
  *
  * @remarks
- * Changes the URL, the events, their expansion scopes or the consumers of an endpoint.
+ * Changes the URL, the events, their expansion scopes, or the consumers of an endpoint.
  * Anything you leave out keeps its current value.
  *
- * Two properties replace rather than merge: naming any consumer clears the others, and
- * `subscriptions` replaces every event, so an event you do not list again is dropped along
+ * Two properties replace instead of merging. Naming any consumer clears the others, and
+ * `subscriptions` replaces every event, so the API drops any event you do not list again along
  * with its scopes. `expand` on its own, without `subscriptions`, re-scopes the events the
- * endpoint already receives — each one takes the scopes that name its own entity, so an
+ * endpoint already receives. Each one takes the scopes that name its own entity, so an
  * endpoint receiving two models can be re-scoped in a single request (send `[]` to clear every
- * scope). A scope naming an entity the endpoint does not receive applies to nothing and is
- * rejected. New consumers are re-authorized against your own access, so an endpoint cannot be
- * pointed at an entity you could not have registered it for in the first place.
+ * scope). A scope naming an entity the endpoint does not receive applies to nothing, so the API
+ * rejects it. The API re-authorizes consumers against your own access, so you cannot
+ * point an endpoint at an entity you could not have registered it for.
  *
- * Changing `webhook_url` is reserved to whoever registered the endpoint, and to admins.
- * Deliveries are filtered by the registering user's access, so a new destination would receive
- * whatever that access reaches — if you did not register it, register your own instead.
+ * Only whoever registered the endpoint, and administrators, can change `webhook_url`.
+ * The registering user's access filters deliveries, so another destination would receive
+ * whatever that access reaches. If you did not register it, register your own instead.
  *
  * Changing the URL or the consumers withdraws the deliveries still queued for this endpoint.
- * Their payloads were serialized for the previous configuration, so they would otherwise
- * arrive at the new destination describing the old one. Changing only `subscriptions` or
+ * The server serialized their payloads for the previous configuration, so they would otherwise
+ * arrive at the changed destination describing the old one. Changing only `subscriptions` or
  * `expand` leaves queued deliveries alone.
  *
- * The signing secret cannot be rotated here, and `id`, `signature_algo` and `secrets` are
- * ignored if you send them back.
+ * You cannot rotate the signing secret here, and the API ignores `id`, `signature_algo`, and `secrets`
+ * if you send them back.
  *
  * Requires the `webhook` / `edit` permission.
  *

package/dist/commonjs/funcs/webhooksUpdatesTheWebhookEndpointWithTheGivenId.js

@@ -49,32 +49,32 @@ const errors = __importStar(require("../models/errors/index.js"));
 const operations = __importStar(require("../models/operations/index.js"));
 const async_js_1 = require("../types/async.js");
 /**
- * Updates the webhook endpoint with the given ID.
+ * Updates the webhook endpoint with the given ID
  *
  * @remarks
- * Changes the URL, the events, their expansion scopes or the consumers of an endpoint.
+ * Changes the URL, the events, their expansion scopes, or the consumers of an endpoint.
  * Anything you leave out keeps its current value.
  *
- * Two properties replace rather than merge: naming any consumer clears the others, and
- * `subscriptions` replaces every event, so an event you do not list again is dropped along
+ * Two properties replace instead of merging. Naming any consumer clears the others, and
+ * `subscriptions` replaces every event, so the API drops any event you do not list again along
  * with its scopes. `expand` on its own, without `subscriptions`, re-scopes the events the
- * endpoint already receives — each one takes the scopes that name its own entity, so an
+ * endpoint already receives. Each one takes the scopes that name its own entity, so an
  * endpoint receiving two models can be re-scoped in a single request (send `[]` to clear every
- * scope). A scope naming an entity the endpoint does not receive applies to nothing and is
- * rejected. New consumers are re-authorized against your own access, so an endpoint cannot be
- * pointed at an entity you could not have registered it for in the first place.
+ * scope). A scope naming an entity the endpoint does not receive applies to nothing, so the API
+ * rejects it. The API re-authorizes consumers against your own access, so you cannot
+ * point an endpoint at an entity you could not have registered it for.
  *
- * Changing `webhook_url` is reserved to whoever registered the endpoint, and to admins.
- * Deliveries are filtered by the registering user's access, so a new destination would receive
- * whatever that access reaches — if you did not register it, register your own instead.
+ * Only whoever registered the endpoint, and administrators, can change `webhook_url`.
+ * The registering user's access filters deliveries, so another destination would receive
+ * whatever that access reaches. If you did not register it, register your own instead.
  *
  * Changing the URL or the consumers withdraws the deliveries still queued for this endpoint.
- * Their payloads were serialized for the previous configuration, so they would otherwise
- * arrive at the new destination describing the old one. Changing only `subscriptions` or
+ * The server serialized their payloads for the previous configuration, so they would otherwise
+ * arrive at the changed destination describing the old one. Changing only `subscriptions` or
  * `expand` leaves queued deliveries alone.
  *
- * The signing secret cannot be rotated here, and `id`, `signature_algo` and `secrets` are
- * ignored if you send them back.
+ * You cannot rotate the signing secret here, and the API ignores `id`, `signature_algo`, and `secrets`
+ * if you send them back.
  *
  * Requires the `webhook` / `edit` permission.
  *