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

package/src/funcs/eventsDeclineInvitation.ts

@@ -32,6 +32,8 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Decline event invitation
  *
+ * **Permissions.** Requires the `events.edit` permission.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function eventsDeclineInvitation(

package/src/funcs/eventsDeleteEvent.ts

@@ -33,6 +33,8 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Delete event for calendar
  *
+ * **Permissions.** Requires the `events.delete` permission.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function eventsDeleteEvent(

package/src/funcs/eventsGetEvent.ts

@@ -11,6 +11,7 @@ import { safeParse } from "../lib/schemas.js";
 import { RequestOptions } from "../lib/sdks.js";
 import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
 import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
 import { GreenSecurityError } from "../models/errors/greensecurityerror.js";
 import {
   ConnectionError,
@@ -32,11 +33,22 @@ import { Result } from "../types/fp.js";
  * @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.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
@@ -46,7 +58,7 @@ export function eventsGetEvent(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.GetEventGetEventOk,
+    components.Event,
     | errors.ApiErrorResponse
     | GreenSecurityError
     | ResponseValidationError
@@ -72,7 +84,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.GetEventGetEventOk,
+      components.Event,
       | errors.ApiErrorResponse
       | GreenSecurityError
       | ResponseValidationError
@@ -164,7 +176,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.GetEventGetEventOk,
+    components.Event,
     | errors.ApiErrorResponse
     | GreenSecurityError
     | ResponseValidationError
@@ -175,7 +187,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.GetEventGetEventOk$inboundSchema),
+    M.json(200, components.Event$inboundSchema),
     M.jsonErr([400, 401, 403, 404], errors.ApiErrorResponse$inboundSchema),
     M.fail("4XX"),
     M.fail([500, "5XX"]),

package/src/funcs/eventsListFeed.ts

@@ -36,7 +36,21 @@ import {
  * 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.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/src/funcs/eventsListLocations.ts

@@ -38,6 +38,8 @@ import {
  * @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.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function eventsListLocations(

package/src/funcs/eventsListOrSearchVendorInvitees.ts

@@ -38,12 +38,16 @@ import {
  * @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.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
@@ -119,10 +123,12 @@ async function $do(
     }, { explode: false }),
     encodeFormQuery({
       "desc": payload.desc,
+      "facility_id": payload.facility_id,
       "items_per_page": payload.items_per_page,
       "page": payload.page,
       "search": payload.search,
       "sort": payload.sort,
+      "vendor_id": payload.vendor_id,
     }),
   );
 

package/src/funcs/eventsListPendingInvitations.ts

@@ -36,7 +36,21 @@ import {
  * 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.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/src/funcs/eventsListStandingAppointments.ts

@@ -36,7 +36,20 @@ import {
  * 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.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/src/funcs/eventsUpdateEvent.ts

@@ -32,6 +32,8 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Update event for calendar
  *
+ * **Permissions.** Requires the `events.edit` permission.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function eventsUpdateEvent(

package/src/funcs/fhirConfigsCreateAFhirConfig.ts

@@ -34,6 +34,8 @@ import { Result } from "../types/fp.js";
  *
  * This endpoint requires the `fhir_configs` / `add` permission.
  *
+ * **Permissions.** Requires the `fhir_configs.add` permission.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function fhirConfigsCreateAFhirConfig(

package/src/funcs/fhirConfigsDeleteFhirConfigById.ts

@@ -33,6 +33,8 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Requires the `fhir_config` / `delete` permission.
  *
+ * **Permissions.** Requires the `fhir_configs.delete` permission.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function fhirConfigsDeleteFhirConfigById(

package/src/funcs/fhirConfigsGetFhirConfig.ts

@@ -35,6 +35,8 @@ import { Result } from "../types/fp.js";
  *
  * This endpoint requires the `fhir_configs` / `view` permission.
  *
+ * **Permissions.** Requires the `fhir_configs.view` permission.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function fhirConfigsGetFhirConfig(

package/src/funcs/fhirConfigsListOfFhirConfigurations.ts

@@ -38,6 +38,8 @@ import {
  * @remarks
  * List available FHIR configurations. This method requires the `fhir_config` / `view` permission.
  *
+ * **Permissions.** Requires the `fhir_configs.view` permission.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function fhirConfigsListOfFhirConfigurations(

package/src/funcs/fhirConfigsUpdateFhirConfigById.ts

@@ -30,6 +30,9 @@ import { Result } from "../types/fp.js";
 /**
  * Update any portion of a FHIR config by ID
  *
+ * @remarks
+ * **Permissions.** Requires the `fhir_configs.edit` permission.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function fhirConfigsUpdateFhirConfigById(

package/src/funcs/invoicesConvertQuote.ts

@@ -45,6 +45,8 @@ import { Result } from "../types/fp.js";
  *
  * 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.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function invoicesConvertQuote(

package/src/funcs/invoicesCreateInvoice.ts

@@ -41,6 +41,8 @@ import { Result } from "../types/fp.js";
  *          - 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.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function invoicesCreateInvoice(

package/src/funcs/invoicesDownloadInvoicesExport.ts

@@ -38,6 +38,8 @@ export enum DownloadInvoicesExportAcceptEnum {
  * @remarks
  * Streams the exported CSV file.
  *
+ * **Permissions.** Requires the `invoices.view` permission.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function invoicesDownloadInvoicesExport(

package/src/funcs/invoicesGetInvoice.ts

@@ -37,6 +37,8 @@ import { Result } from "../types/fp.js";
  * most one of `vendor_id`, `company_id`, `facility_id`, or `system_id`
  * may be provided.
  *
+ * **Permissions.** Requires the `invoices.view` permission.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function invoicesGetInvoice(

package/src/funcs/invoicesGetInvoicesExportStatus.ts

@@ -33,6 +33,8 @@ import { Result } from "../types/fp.js";
  * 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.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function invoicesGetInvoicesExportStatus(

package/src/funcs/invoicesInvoicesExport.ts

@@ -34,6 +34,18 @@ import { Result } from "../types/fp.js";
  * 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`.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function invoicesInvoicesExport(

package/src/funcs/invoicesListInvoices.ts

@@ -45,13 +45,17 @@ import {
  * 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)

package/src/funcs/invoicesMakePayment.ts

@@ -32,6 +32,8 @@ import { Result } from "../types/fp.js";
  * @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.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function invoicesMakePayment(

package/src/funcs/invoicesUpdateInvoice.ts

@@ -42,6 +42,8 @@ import * as types$ from "../types/primitives.js";
  *          - 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.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function invoicesUpdateInvoice(

package/src/funcs/lookupsListLookupSystems.ts

@@ -39,6 +39,14 @@ import { Result } from "../types/fp.js";
  *
  * 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`.
+ *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function lookupsListLookupSystems(

package/src/funcs/lookupsLookupCompanyManagers.ts

@@ -0,0 +1,179 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GreenSecurityCore } from "../core.js";
+import { encodeFormQuery } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { GreenSecurityError } from "../models/errors/greensecurityerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * 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.
+ */
+export function lookupsLookupCompanyManagers(
+  client: GreenSecurityCore,
+  request: operations.LookupCompanyManagersRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.LookupCompanyManagersLookupCompanyManagersOk,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GreenSecurityCore,
+  request: operations.LookupCompanyManagersRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.LookupCompanyManagersLookupCompanyManagersOk,
+      | errors.ApiErrorResponse
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.LookupCompanyManagersRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/lookups/company_managers")();
+
+  const query = encodeFormQuery({
+    "company_id": payload.company_id,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "lookupCompanyManagers",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.security,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.LookupCompanyManagersLookupCompanyManagersOk,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      200,
+      operations.LookupCompanyManagersLookupCompanyManagersOk$inboundSchema,
+    ),
+    M.jsonErr([400, 401, 403, 404], errors.ApiErrorResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail([500, "5XX"]),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}