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

package/src/react-query/zonesGetSecurityZone.ts

@@ -59,11 +59,15 @@ export type ZonesGetSecurityZoneQueryError =
  * @remarks
  * Get security zone details
  *
+ * **Permissions.** Requires the `zones.view` permission.
+ *
  * Available `expand` scopes are:
  *
- * - zone.facility
- * - zone.department
- * - zone.rules
+ * - `zone.facility`
+ * - `zone.department`
+ * - `zone.rules`
+ *
+ * Unrecognised values are ignored.
  */
 export function useZonesGetSecurityZone(
   request: operations.GetSecurityZoneRequest,
@@ -92,11 +96,15 @@ export function useZonesGetSecurityZone(
  * @remarks
  * Get security zone details
  *
+ * **Permissions.** Requires the `zones.view` permission.
+ *
  * Available `expand` scopes are:
  *
- * - zone.facility
- * - zone.department
- * - zone.rules
+ * - `zone.facility`
+ * - `zone.department`
+ * - `zone.rules`
+ *
+ * Unrecognised values are ignored.
  */
 export function useZonesGetSecurityZoneSuspense(
   request: operations.GetSecurityZoneRequest,

package/src/react-query/zonesListOrSearchSecurityZones.ts

@@ -76,6 +76,8 @@ export type ZonesListOrSearchSecurityZonesQueryError =
  *
  * @remarks
  * List or search security zones
+ *
+ * **Permissions.** Requires the `zones.view` permission.
  */
 export function useZonesListOrSearchSecurityZones(
   request: operations.ListOrSearchSecurityZonesRequest,
@@ -103,6 +105,8 @@ export function useZonesListOrSearchSecurityZones(
  *
  * @remarks
  * List or search security zones
+ *
+ * **Permissions.** Requires the `zones.view` permission.
  */
 export function useZonesListOrSearchSecurityZonesSuspense(
   request: operations.ListOrSearchSecurityZonesRequest,
@@ -130,6 +134,8 @@ export function useZonesListOrSearchSecurityZonesSuspense(
  *
  * @remarks
  * List or search security zones
+ *
+ * **Permissions.** Requires the `zones.view` permission.
  */
 export function useZonesListOrSearchSecurityZonesInfinite(
   request: operations.ListOrSearchSecurityZonesRequest,
@@ -171,6 +177,8 @@ export function useZonesListOrSearchSecurityZonesInfinite(
  *
  * @remarks
  * List or search security zones
+ *
+ * **Permissions.** Requires the `zones.view` permission.
  */
 export function useZonesListOrSearchSecurityZonesInfiniteSuspense(
   request: operations.ListOrSearchSecurityZonesRequest,

package/src/react-query/zonesSecurityZoneCheckin.ts

@@ -51,6 +51,8 @@ export type ZonesSecurityZoneCheckinMutationError =
  *
  * @remarks
  * Security zone checkin request
+ *
+ * **Permissions.** Requires a valid token. This endpoint is not gated on a named permission - the caller's role and their relationship to the record decide what is returned.
  */
 export function useZonesSecurityZoneCheckinMutation(
   options?: MutationHookOptions<

package/src/sdk/alerts.ts

@@ -15,6 +15,8 @@ export class Alerts extends ClientSDK {
    *
    * @remarks
    * List alerts for user.
+   *
+   * **Permissions.** Requires the `alerts.view` permission.
    */
   async listAlerts(
     request: operations.ListAlertsRequest,
@@ -32,6 +34,8 @@ export class Alerts extends ClientSDK {
    *
    * @remarks
    * Update user alerts
+   *
+   * **Permissions.** Requires the `alerts.edit` permission.
    */
   async updateUserAlerts(
     request: operations.UpdateUserAlertsRequestBody,

package/src/sdk/companies.ts

@@ -6,6 +6,7 @@ import { companiesAddCompanyManager } from "../funcs/companiesAddCompanyManager.
 import { companiesGetCompany } from "../funcs/companiesGetCompany.js";
 import { companiesListCompanyCredentials } from "../funcs/companiesListCompanyCredentials.js";
 import { companiesListCompanyCredits } from "../funcs/companiesListCompanyCredits.js";
+import { companiesListCompanyManagerContacts } from "../funcs/companiesListCompanyManagerContacts.js";
 import { companiesListCompanyManagers } from "../funcs/companiesListCompanyManagers.js";
 import { companiesListOrSearchCompanies } from "../funcs/companiesListOrSearchCompanies.js";
 import { companiesLookupCompanies } from "../funcs/companiesLookupCompanies.js";
@@ -21,6 +22,15 @@ export class Companies extends ClientSDK {
    *
    * @remarks
    * List or search companies.
+   *
+   * **Permissions.** Requires the `companies.view` permission.
+   *
+   * Available `expand` scopes are:
+   *
+   * - `company.location`
+   * - `company.vendor_type_restrictions`
+   *
+   * Any other value is rejected with `422 Unprocessable Entity`.
    */
   async listOrSearchCompanies(
     request: operations.ListOrSearchCompaniesRequest,
@@ -41,10 +51,14 @@ export class Companies extends ClientSDK {
    * @remarks
    * Get company details.
    *
+   * **Permissions.** Requires the `companies.view` permission.
+   *
    * Available `expand` scopes are:
    *
-   * company.location
-   * company.vendor_type_restrictions
+   * - `company.location`
+   * - `company.vendor_type_restrictions`
+   *
+   * Any other value is rejected with `422 Unprocessable Entity`.
    */
   async getCompany(
     request: operations.GetCompanyRequest,
@@ -62,6 +76,8 @@ export class Companies extends ClientSDK {
    *
    * @remarks
    * List companies available to the caller as minimal lookup summaries for dropdown and typeahead UIs.
+   *
+   * **Permissions.** Requires the `companies.view` permission.
    */
   async lookupCompanies(
     request: operations.LookupCompaniesRequest,
@@ -84,6 +100,8 @@ export class Companies extends ClientSDK {
    * A welcome email is sent to the new manager with login instructions.
    * Requires `company_managers` add permission. Company managers can add to their
    * own company; API users can add to companies in their marketplace app scope.
+   *
+   * **Permissions.** Requires the `company_managers.add` permission.
    */
   async addCompanyManager(
     request: operations.AddCompanyManagerRequest,
@@ -101,6 +119,8 @@ export class Companies extends ClientSDK {
    *
    * @remarks
    * List or search company managers.
+   *
+   * **Permissions.** Requires the `company_managers.view` permission.
    */
   async listCompanyManagers(
     request: operations.ListCompanyManagersRequest,
@@ -120,6 +140,14 @@ export class Companies extends ClientSDK {
    *
    * @remarks
    * Lists credentials required for the specified company, based on CompanyRequiredCredentials.
+   *
+   * **Permissions.** Requires the `vendor_credentials.view` permission. Callers who also hold `vendor_credentials.add` and can update the company trigger a recalculation of the required-credential set; everyone else reads the last computed set.
+   *
+   * Available `expand` scopes are:
+   *
+   * - `vendor_credential.systems`
+   *
+   * Any other value is rejected with `422 Unprocessable Entity`.
    */
   async listCompanyCredentials(
     request: operations.ListCompanyCredentialsRequest,
@@ -139,6 +167,16 @@ export class Companies extends ClientSDK {
    *
    * @remarks
    * Returns a paginated list of credits associated with the specified company, including incoming and outgoing transactions.
+   *
+   * **Permissions.** Requires the `company_credits.view` permission.
+   *
+   * Available `expand` scopes are:
+   *
+   * - `entity`
+   * - `from_entity`
+   * - `to_entity`
+   *
+   * Any other value is rejected with `422 Unprocessable Entity`.
    */
   async listCompanyCredits(
     request: operations.ListCompanyCreditsRequest,
@@ -152,4 +190,26 @@ export class Companies extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * List the contact details of a company's managers
+   *
+   * @remarks
+   * Deprecated in favor of `/lookups/company_managers`, which returns the same list. Kept so app builds released before the move keep working.
+   * **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.
+   *
+   * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  async listCompanyManagerContacts(
+    request: operations.ListCompanyManagerContactsRequest,
+    options?: RequestOptions,
+  ): Promise<
+    operations.ListCompanyManagerContactsListCompanyManagerContactsOk
+  > {
+    return unwrapAsync(companiesListCompanyManagerContacts(
+      this,
+      request,
+      options,
+    ));
+  }
 }

package/src/sdk/datarequests.ts

@@ -15,6 +15,8 @@ export class DataRequests extends ClientSDK {
    *
    * @remarks
    * It will set the vendor credential data request file attributes
+   *
+   * **Permissions.** Requires the `vendor-credential-data-requests.view` permission.
    */
   async addDataRequestFile(
     request: operations.AddDataRequestFileRequest,
@@ -32,6 +34,8 @@ export class DataRequests extends ClientSDK {
    *
    * @remarks
    * It will delete the vendor credential data request file
+   *
+   * **Permissions.** Requires the `vendor-credential-data-requests.delete` permission.
    */
   async deleteDataRequestFile(
     request: operations.DeleteDataRequestFileRequest,
@@ -49,6 +53,8 @@ export class DataRequests extends ClientSDK {
    *
    * @remarks
    * It will update the vendor credential data request attributes
+   *
+   * **Permissions.** Requires the `vendor-credential-data-requests.view` permission.
    */
   async updateDataRequest(
     request: operations.UpdateDataRequestRequest,

package/src/sdk/events.ts

@@ -25,6 +25,8 @@ export class Events extends ClientSDK {
    *
    * @remarks
    * Create a new event for calendar
+   *
+   * **Permissions.** Requires the `events.add` permission.
    */
   async createEvent(
     request: operations.CreateEventRequestBody,
@@ -43,16 +45,27 @@ export class Events extends ClientSDK {
    * @remarks
    * Retrieve a single event by ID.
    *
+   * **Permissions.** Requires the `events.view` permission.
+   *
    * Available `expand` scopes are:
    *
    * - event.facility
    * - event.department
    * - event.invitees
+   * - event.location
+   * - event.attendees
+   * - event.creator
+   *
+   * Unrecognised values are ignored.
+   *
+   * This route always returns the current `Event` shape, whatever SDK version is calling: it was
+   * introduced after the calendar list endpoints and has never served the older string-valued
+   * shape they did.
    */
   async getEvent(
     request: operations.GetEventRequest,
     options?: RequestOptions,
-  ): Promise<operations.GetEventGetEventOk> {
+  ): Promise<components.Event> {
     return unwrapAsync(eventsGetEvent(
       this,
       request,
@@ -65,6 +78,8 @@ export class Events extends ClientSDK {
    *
    * @remarks
    * Update event for calendar
+   *
+   * **Permissions.** Requires the `events.edit` permission.
    */
   async updateEvent(
     request: operations.UpdateEventRequest,
@@ -82,6 +97,8 @@ export class Events extends ClientSDK {
    *
    * @remarks
    * Delete event for calendar
+   *
+   * **Permissions.** Requires the `events.delete` permission.
    */
   async deleteEvent(
     request: operations.DeleteEventRequest,
@@ -99,6 +116,8 @@ export class Events extends ClientSDK {
    *
    * @remarks
    * Accept event invitation
+   *
+   * **Permissions.** Requires the `events.edit` permission.
    */
   async acceptInvitation(
     request: operations.AcceptInvitationRequest,
@@ -116,6 +135,8 @@ export class Events extends ClientSDK {
    *
    * @remarks
    * Decline event invitation
+   *
+   * **Permissions.** Requires the `events.edit` permission.
    */
   async declineInvitation(
     request: operations.DeclineInvitationRequest,
@@ -134,12 +155,16 @@ export class Events extends ClientSDK {
    * @remarks
    * List or search vendor invitees.
    *
+   * **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:
    *
-   * - contact.facility
-   * - contact.system
-   * - contact.department
-   * - contact.user
+   * - `contact.user`
+   * - `contact.facility`
+   * - `contact.system`
+   * - `contact.department`
+   *
+   * Unrecognised values are ignored.
    */
   async listOrSearchVendorInvitees(
     request: operations.ListOrSearchVendorInviteesRequest,
@@ -162,6 +187,8 @@ export class Events extends ClientSDK {
    *
    * @remarks
    * List meeting locations for invitees or an event
+   *
+   * **Permissions.** Requires the `events.view` permission. Results are also scoped to the caller's own tenant: `event_id` is resolved through the caller's own event access (organizer, invitee, or the facility/system/company hosting it), and `invitee_user_ids`/`invitee_department_ids` only return labels for facilities the caller may otherwise see.
    */
   async listLocations(
     request: operations.ListLocationsRequest,
@@ -178,7 +205,21 @@ export class Events extends ClientSDK {
    * List pending invitations
    *
    * @remarks
-   * List pending invitations
+   * List pending invitations.
+   *
+   * **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.
+   *
+   * Returns `Invite` items with the `invite.event` and `invite.invitee` scopes already applied,
+   * so `event` is the expanded `{ id, name }` summary rather than a bare id, and `invitee` is
+   * populated — the appointment and the recipient this list has always named. This endpoint
+   * takes no `expand` parameter; both scopes are applied on every call and cannot be turned off.
+   * SDK builds below `0.55.0-beta.1` receive the older `PendingInvitation` shape instead, which
+   * embeds the appointment.
+   *
+   * The boundary is the prerelease build `0.55.0-beta.1`, not the `0.55.0` release, so
+   * `0.55.0-beta.1` itself already receives `Invite`. See the `Invite` schema for exactly how a
+   * build is compared against it.
    */
   async listPendingInvitations(
     request: operations.ListPendingInvitationsRequest,
@@ -197,7 +238,21 @@ export class Events extends ClientSDK {
    * List events feed
    *
    * @remarks
-   * List events feed
+   * List events feed.
+   *
+   * **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.
+   *
+   * Returns `Event` items with the `event.creator` and `event.invitees` scopes already applied,
+   * so `event_creator`, `event_creator_img_url` and `invitees` are populated — the fields this
+   * feed has always carried. SDK builds below `0.55.0-beta.1` receive the older `Feed` shape
+   * instead, in which `facility` and `department` are name strings rather than ids; the server
+   * chooses by the `X-SDK-User-Agent` header the SDK sends, so an existing client keeps the
+   * shape it was generated against until it is regenerated.
+   *
+   * The boundary is the prerelease build `0.55.0-beta.1`, not the `0.55.0` release, so
+   * `0.55.0-beta.1` itself already receives `Event`. See the `Event` schema for exactly how a
+   * build is compared against it.
    */
   async listFeed(
     request: operations.ListFeedRequest,
@@ -214,7 +269,20 @@ export class Events extends ClientSDK {
    * List standing appointments
    *
    * @remarks
-   * List standing appointment
+   * List standing appointments.
+   *
+   * **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.
+   *
+   * Returns `Event` items with the `event.location`, `event.attendees`, `event.viewer_invite`,
+   * `event.creator` and `event.invitees` scopes already applied, so `location`, `attendees`,
+   * `event_creator`, `event_creator_img_url` and `invitees` are populated and `status` carries
+   * the reader's own outstanding invite. SDK builds below `0.55.0-beta.1` receive the older
+   * `StandingAppointment` shape instead.
+   *
+   * The boundary is the prerelease build `0.55.0-beta.1`, not the `0.55.0` release, so
+   * `0.55.0-beta.1` itself already receives `Event`. See the `Event` schema for exactly how a
+   * build is compared against it.
    */
   async listStandingAppointments(
     request: operations.ListStandingAppointmentsRequest,

package/src/sdk/fhirconfigs.ts

@@ -19,6 +19,8 @@ export class FhirConfigs extends ClientSDK {
    *
    * @remarks
    * List available FHIR configurations. This method requires the `fhir_config` / `view` permission.
+   *
+   * **Permissions.** Requires the `fhir_configs.view` permission.
    */
   async listOfFhirConfigurations(
     request: operations.ListOfFhirConfigurationsRequest,
@@ -40,6 +42,8 @@ export class FhirConfigs extends ClientSDK {
    * Create a new FHIR configuration. The `facility_id` under the `applies_to` property is required to match the Facility that the user belongs to.
    *
    * This endpoint requires the `fhir_configs` / `add` permission.
+   *
+   * **Permissions.** Requires the `fhir_configs.add` permission.
    */
   async createAFhirConfig(
     request: components.FhirConfigCreate,
@@ -59,6 +63,8 @@ export class FhirConfigs extends ClientSDK {
    * Retrieve a FHIR configuration by ID.
    *
    * This endpoint requires the `fhir_configs` / `view` permission.
+   *
+   * **Permissions.** Requires the `fhir_configs.view` permission.
    */
   async getFhirConfig(
     request: operations.GetFhirConfigRequest,
@@ -73,6 +79,9 @@ export class FhirConfigs extends ClientSDK {
 
   /**
    * Update any portion of a FHIR config by ID
+   *
+   * @remarks
+   * **Permissions.** Requires the `fhir_configs.edit` permission.
    */
   async updateFhirConfigById(
     request: operations.UpdateFhirConfigByIdRequest,
@@ -90,6 +99,8 @@ export class FhirConfigs extends ClientSDK {
    *
    * @remarks
    * Requires the `fhir_config` / `delete` permission.
+   *
+   * **Permissions.** Requires the `fhir_configs.delete` permission.
    */
   async deleteFhirConfigById(
     request: operations.DeleteFhirConfigByIdRequest,

package/src/sdk/invoices.ts

@@ -32,6 +32,8 @@ export class Invoices extends ClientSDK {
    * results to invoices that include a credentialing product line item. At
    * most one of `vendor_id`, `company_id`, `facility_id`, or `system_id`
    * may be provided.
+   *
+   * **Permissions.** Requires the `invoices.view` permission.
    */
   async getInvoice(
     request: operations.GetInvoiceRequest,
@@ -57,13 +59,17 @@ export class Invoices extends ClientSDK {
    * Supplying more than one will return `400 Bad Request`.
    * If none are provided, the request falls back to all authorized resources.
    *
+   * **Permissions.** Requires the `invoices.view` permission.
+   *
    * Available `expand` scopes are:
-   * - invoice.line_items
-   * - invoice.invoice_transactions
-   * - invoice.representative
-   * - invoice.custom_fields
-   * - invoice.invoice_type
-   * - invoice.may_pay_invoice
+   *
+   * - `invoice.invoice_type`
+   * - `invoice.custom_fields`
+   * - `invoice.line_items`
+   * - `invoice.invoice_transactions`
+   * - `invoice.representative`
+   *
+   * Any other value is rejected with `422 Unprocessable Entity`.
    *
    * Available `sort` values are:
    * - id (default)
@@ -98,6 +104,8 @@ export class Invoices extends ClientSDK {
    *          - new_vendor_type_id: required, must be integer
    *          - old_facility_ids:   required, must be an array of integers (can be empty)
    *          - new_facility_ids:   required, must be array of integers
+   *
+   * **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 createInvoice(
     request: operations.CreateInvoiceRequestBody,
@@ -124,6 +132,8 @@ export class Invoices extends ClientSDK {
    *          - new_vendor_type_id: required, must be integer
    *          - old_facility_ids:   required, must be an array of integers (can be empty)
    *          - new_facility_ids:   required, must be array of integers
+   *
+   * **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 updateInvoice(
     request: operations.UpdateInvoiceRequest,
@@ -141,6 +151,8 @@ export class Invoices extends ClientSDK {
    *
    * @remarks
    * Make payment for the invoice
+   *
+   * **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 makePayment(
     request: operations.MakePaymentRequest,
@@ -171,6 +183,8 @@ export class Invoices extends ClientSDK {
    * linked `VendorCredential` responds `401`.
    *
    * Takes no request body.
+   *
+   * **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 convertQuote(
     request: operations.ConvertQuoteRequest,
@@ -189,6 +203,18 @@ export class Invoices extends ClientSDK {
    * @remarks
    * Enqueues an asynchronous job to generate a CSV export of invoices based on the provided filters. Returns a
    * `status_url` for polling until the export is ready, along with a `download_url` , `status_id` and `request_token`.
+   *
+   * **Permissions.** Requires the `invoices.view` permission.
+   *
+   * Available `expand` scopes are:
+   *
+   * - `invoice.invoice_type`
+   * - `invoice.custom_fields`
+   * - `invoice.line_items`
+   * - `invoice.invoice_transactions`
+   * - `invoice.representative`
+   *
+   * Any other value is rejected with `422 Unprocessable Entity`.
    */
   async invoicesExport(
     request: operations.InvoicesExportRequest,
@@ -207,6 +233,8 @@ export class Invoices extends ClientSDK {
    * @remarks
    * Poll the status of an asynchronous invoice export job. When `ready` is true,
    * the export is complete and can be downloaded via the download endpoint.
+   *
+   * **Permissions.** Requires the `invoices.view` permission.
    */
   async getInvoicesExportStatus(
     request: operations.GetInvoicesExportStatusRequest,
@@ -224,6 +252,8 @@ export class Invoices extends ClientSDK {
    *
    * @remarks
    * Streams the exported CSV file.
+   *
+   * **Permissions.** Requires the `invoices.view` permission.
    */
   async downloadInvoicesExport(
     request: operations.DownloadInvoicesExportRequest,

package/src/sdk/lookups.ts

@@ -3,11 +3,31 @@
  */
 
 import { lookupsListLookupSystems } from "../funcs/lookupsListLookupSystems.js";
+import { lookupsLookupCompanyManagers } from "../funcs/lookupsLookupCompanyManagers.js";
+import { lookupsLookupPostalCode } from "../funcs/lookupsLookupPostalCode.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class Lookups extends ClientSDK {
+  /**
+   * List the managers of a company for addressing a message
+   *
+   * @remarks
+   * List the active managers of a company who have an email address, so someone who belongs to that company can contact them. Readable by a vendor of the company, a manager of the company, or an admin; every other caller receives a 404. Carries only the fields needed to address a message, not the full company manager or user record. Distinct from `/companies/{id}/managers`, which is the administration listing and is gated on the `company_managers` view permission.
+   * **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 lookupCompanyManagers(
+    request: operations.LookupCompanyManagersRequest,
+    options?: RequestOptions,
+  ): Promise<operations.LookupCompanyManagersLookupCompanyManagersOk> {
+    return unwrapAsync(lookupsLookupCompanyManagers(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * List systems for dropdown/picker use
    *
@@ -20,6 +40,14 @@ export class Lookups extends ClientSDK {
    * - **API user**: returns systems scoped to their MarketplaceAppActivation (facility, system, or site level).
    *
    * Use `expand=system.facilities` to include the facilities array on each system.
+   *
+   * **Permissions.** Requires the `systems.view` permission. Passing `expand=system.facilities` additionally requires `facilities.view`.
+   *
+   * Available `expand` scopes are:
+   *
+   * - `system.facilities`
+   *
+   * Any other value is rejected with `422 Unprocessable Entity`.
    */
   async listLookupSystems(
     request: operations.ListLookupSystemsRequest,
@@ -31,4 +59,38 @@ export class Lookups extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Check a postal code against a state and country
+   *
+   * @remarks
+   * Cross-checks a postal code against a state/province and country, the same check
+   * every write path that stores a US or Canadian address enforces server-side (e.g.
+   * `PUT /users/{id}`, `PUT /vendors/{vendor_id_or_me}`). Useful for validating an
+   * address before submitting it elsewhere.
+   *
+   * `status` is one of:
+   * - `ok` — the postal code belongs to the given state/province.
+   * - `invalid` — the postal code is not shaped like a real one for the given country.
+   * - `mismatch` — the postal code is well-formed but belongs to a different state or
+   *   province. `expected_states` names the state(s) it actually maps to.
+   * - `unknown` — nothing to check against (an unsupported country, or a postal code
+   *   absent from the US ZIP dataset). Treated as acceptable by every write path that
+   *   uses this check.
+   *
+   * Only the US and Canada have a real code-to-subdivision map; every other country
+   * always returns `unknown`.
+   *
+   * **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 lookupPostalCode(
+    request: operations.LookupPostalCodeRequest,
+    options?: RequestOptions,
+  ): Promise<operations.LookupPostalCodeLookupPostalCodeOk> {
+    return unwrapAsync(lookupsLookupPostalCode(
+      this,
+      request,
+      options,
+    ));
+  }
 }