@greensecurity/javascript-sdk 0.48.0 → 0.49.0-beta.0

package/src/sdk/vendors.ts

@@ -744,8 +744,9 @@ export class Vendors extends ClientSDK {
    * @remarks
    * Changes a vendor's credentialing subscription by updating the vendor type,
    * the target facilities, or both. If the selection increases the subscription
-   * price, the server creates an invoice and charges the payment profile; the
-   * response includes the invoice id.
+   * price, the server creates an invoice and charges the payment profile for the
+   * invoice total, including any tax and convenience fee; the response includes
+   * the invoice id.
    *
    * **Permissions.** Requires the `vendor_transactions.add` permission.
    */
@@ -1026,12 +1027,20 @@ export class Vendors extends ClientSDK {
    * 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
+   * `city`, `state`, `zip`, `phone`, `mobile_phone`, `fax`, `work_email` and `personal_email`. The `address` 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
    * through this endpoint.
    *
+   * `location.work_email` and `location.personal_email` are stored lowercased, and a
+   * value that is not a valid email address, or is longer than 255 characters, gets a
+   * `422` response. They are contact fields: the login stays `email`, which this
+   * endpoint does not change. When an update sets either of them, one must be the
+   * vendor's `email` and the other a different address or empty, or it gets a `422`.
+   * A vendor with neither one copying `email` yet can set just one and leave the
+   * other empty: the save puts `email` in the empty one (work, if both are).
+   *
    * 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 you omit from the request). The server rejects a code that is not shaped like a real