@greensecurity/javascript-sdk 0.45.0 → 0.46.0-beta.2

package/dist/esm/sdk/events.d.ts

@@ -8,6 +8,8 @@ export declare class Events extends ClientSDK {
      *
      * @remarks
      * Create a new event for calendar
+     *
+     * **Permissions.** Requires the `events.add` permission.
      */
     createEvent(request: operations.CreateEventRequestBody, options?: RequestOptions): Promise<operations.CreateEventCreateEventOk>;
     /**
@@ -16,18 +18,31 @@ export declare 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.
      */
-    getEvent(request: operations.GetEventRequest, options?: RequestOptions): Promise<operations.GetEventGetEventOk>;
+    getEvent(request: operations.GetEventRequest, options?: RequestOptions): Promise<components.Event>;
     /**
      * Update event for calendar
      *
      * @remarks
      * Update event for calendar
+     *
+     * **Permissions.** Requires the `events.edit` permission.
      */
     updateEvent(request: operations.UpdateEventRequest, options?: RequestOptions): Promise<operations.UpdateEventUpdateEventOk>;
     /**
@@ -35,6 +50,8 @@ export declare class Events extends ClientSDK {
      *
      * @remarks
      * Delete event for calendar
+     *
+     * **Permissions.** Requires the `events.delete` permission.
      */
     deleteEvent(request: operations.DeleteEventRequest, options?: RequestOptions): Promise<components.DeleteApiResponse>;
     /**
@@ -42,6 +59,8 @@ export declare class Events extends ClientSDK {
      *
      * @remarks
      * Accept event invitation
+     *
+     * **Permissions.** Requires the `events.edit` permission.
      */
     acceptInvitation(request: operations.AcceptInvitationRequest, options?: RequestOptions): Promise<operations.AcceptInvitationAcceptInvitationOk>;
     /**
@@ -49,6 +68,8 @@ export declare class Events extends ClientSDK {
      *
      * @remarks
      * Decline event invitation
+     *
+     * **Permissions.** Requires the `events.edit` permission.
      */
     declineInvitation(request: operations.DeclineInvitationRequest, options?: RequestOptions): Promise<operations.DeclineInvitationDeclineInvitationOk>;
     /**
@@ -57,12 +78,16 @@ export declare 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.
      */
     listOrSearchVendorInvitees(request: operations.ListOrSearchVendorInviteesRequest, options?: RequestOptions): Promise<PageIterator<operations.ListOrSearchVendorInviteesResponse, {
         page: number;
@@ -72,6 +97,8 @@ export declare 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.
      */
     listLocations(request: operations.ListLocationsRequest, options?: RequestOptions): Promise<PageIterator<operations.ListLocationsResponse, {
         page: number;
@@ -80,7 +107,21 @@ export declare 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.
      */
     listPendingInvitations(request: operations.ListPendingInvitationsRequest, options?: RequestOptions): Promise<PageIterator<operations.ListPendingInvitationsResponse, {
         page: number;
@@ -89,7 +130,21 @@ export declare 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.
      */
     listFeed(request: operations.ListFeedRequest, options?: RequestOptions): Promise<PageIterator<operations.ListFeedResponse, {
         page: number;
@@ -98,7 +153,20 @@ export declare 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.
      */
     listStandingAppointments(request: operations.ListStandingAppointmentsRequest, options?: RequestOptions): Promise<PageIterator<operations.ListStandingAppointmentsResponse, {
         page: number;

package/dist/esm/sdk/events.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../../src/sdk/events.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAE5D,OAAO,EAAE,YAAY,EAAwB,MAAM,wBAAwB,CAAC;AAE5E,qBAAa,MAAO,SAAQ,SAAS;IACnC;;;;;OAKG;IACG,WAAW,CACf,OAAO,EAAE,UAAU,CAAC,sBAAsB,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAQ/C;;;;;;;;;;;OAWG;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,eAAe,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAQzC;;;;;OAKG;IACG,WAAW,CACf,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAQ/C;;;;;OAKG;IACG,WAAW,CACf,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,iBAAiB,CAAC;IAQxC;;;;;OAKG;IACG,gBAAgB,CACpB,OAAO,EAAE,UAAU,CAAC,uBAAuB,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,kCAAkC,CAAC;IAQzD;;;;;OAKG;IACG,iBAAiB,CACrB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,oCAAoC,CAAC;IAQ3D;;;;;;;;;;;;OAYG;IACG,0BAA0B,CAC9B,OAAO,EAAE,UAAU,CAAC,iCAAiC,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CACV,UAAU,CAAC,kCAAkC,EAC7C;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CACjB,CACF;IAQD;;;;;OAKG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,qBAAqB,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAQ5E;;;;;OAKG;IACG,sBAAsB,CAC1B,OAAO,EAAE,UAAU,CAAC,6BAA6B,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CAAC,UAAU,CAAC,8BAA8B,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAC1E;IAQD;;;;;OAKG;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,eAAe,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,gBAAgB,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAQvE;;;;;OAKG;IACG,wBAAwB,CAC5B,OAAO,EAAE,UAAU,CAAC,+BAA+B,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CAAC,UAAU,CAAC,gCAAgC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAC5E;CAOF"}
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../../src/sdk/events.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAE5D,OAAO,EAAE,YAAY,EAAwB,MAAM,wBAAwB,CAAC;AAE5E,qBAAa,MAAO,SAAQ,SAAS;IACnC;;;;;;;OAOG;IACG,WAAW,CACf,OAAO,EAAE,UAAU,CAAC,sBAAsB,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAQ/C;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,eAAe,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC;IAQ5B;;;;;;;OAOG;IACG,WAAW,CACf,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAQ/C;;;;;;;OAOG;IACG,WAAW,CACf,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,iBAAiB,CAAC;IAQxC;;;;;;;OAOG;IACG,gBAAgB,CACpB,OAAO,EAAE,UAAU,CAAC,uBAAuB,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,kCAAkC,CAAC;IAQzD;;;;;;;OAOG;IACG,iBAAiB,CACrB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,oCAAoC,CAAC;IAQ3D;;;;;;;;;;;;;;;;OAgBG;IACG,0BAA0B,CAC9B,OAAO,EAAE,UAAU,CAAC,iCAAiC,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CACV,UAAU,CAAC,kCAAkC,EAC7C;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CACjB,CACF;IAQD;;;;;;;OAOG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,qBAAqB,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAQ5E;;;;;;;;;;;;;;;;;;;OAmBG;IACG,sBAAsB,CAC1B,OAAO,EAAE,UAAU,CAAC,6BAA6B,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CAAC,UAAU,CAAC,8BAA8B,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAC1E;IAQD;;;;;;;;;;;;;;;;;;;OAmBG;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,eAAe,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,gBAAgB,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAQvE;;;;;;;;;;;;;;;;;;OAkBG;IACG,wBAAwB,CAC5B,OAAO,EAAE,UAAU,CAAC,+BAA+B,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CAAC,UAAU,CAAC,gCAAgC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAC5E;CAOF"}

package/dist/esm/sdk/events.js

@@ -21,6 +21,8 @@ export class Events extends ClientSDK {
      *
      * @remarks
      * Create a new event for calendar
+     *
+     * **Permissions.** Requires the `events.add` permission.
      */
     async createEvent(request, options) {
         return unwrapAsync(eventsCreateEvent(this, request, options));
@@ -31,11 +33,22 @@ 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, options) {
         return unwrapAsync(eventsGetEvent(this, request, options));
@@ -45,6 +58,8 @@ export class Events extends ClientSDK {
      *
      * @remarks
      * Update event for calendar
+     *
+     * **Permissions.** Requires the `events.edit` permission.
      */
     async updateEvent(request, options) {
         return unwrapAsync(eventsUpdateEvent(this, request, options));
@@ -54,6 +69,8 @@ export class Events extends ClientSDK {
      *
      * @remarks
      * Delete event for calendar
+     *
+     * **Permissions.** Requires the `events.delete` permission.
      */
     async deleteEvent(request, options) {
         return unwrapAsync(eventsDeleteEvent(this, request, options));
@@ -63,6 +80,8 @@ export class Events extends ClientSDK {
      *
      * @remarks
      * Accept event invitation
+     *
+     * **Permissions.** Requires the `events.edit` permission.
      */
     async acceptInvitation(request, options) {
         return unwrapAsync(eventsAcceptInvitation(this, request, options));
@@ -72,6 +91,8 @@ export class Events extends ClientSDK {
      *
      * @remarks
      * Decline event invitation
+     *
+     * **Permissions.** Requires the `events.edit` permission.
      */
     async declineInvitation(request, options) {
         return unwrapAsync(eventsDeclineInvitation(this, request, options));
@@ -82,12 +103,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, options) {
         return unwrapResultIterator(eventsListOrSearchVendorInvitees(this, request, options));
@@ -97,6 +122,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, options) {
         return unwrapResultIterator(eventsListLocations(this, request, options));
@@ -105,7 +132,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, options) {
         return unwrapResultIterator(eventsListPendingInvitations(this, request, options));
@@ -114,7 +155,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, options) {
         return unwrapResultIterator(eventsListFeed(this, request, options));
@@ -123,7 +178,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, options) {
         return unwrapResultIterator(eventsListStandingAppointments(this, request, options));

package/dist/esm/sdk/events.js.map

@@ -1 +1 @@
-{"version":3,"file":"events.js","sourceRoot":"","sources":["../../../src/sdk/events.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,gCAAgC,EAAE,MAAM,8CAA8C,CAAC;AAChG,OAAO,EAAE,4BAA4B,EAAE,MAAM,0CAA0C,CAAC;AACxF,OAAO,EAAE,8BAA8B,EAAE,MAAM,4CAA4C,CAAC;AAC5F,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAgB,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE5E,MAAM,OAAO,MAAO,SAAQ,SAAS;IACnC;;;;;OAKG;IACH,KAAK,CAAC,WAAW,CACf,OAA0C,EAC1C,OAAwB;QAExB,OAAO,WAAW,CAAC,iBAAiB,CAClC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAmC,EACnC,OAAwB;QAExB,OAAO,WAAW,CAAC,cAAc,CAC/B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,WAAW,CACf,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,iBAAiB,CAClC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,WAAW,CACf,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,iBAAiB,CAClC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAA2C,EAC3C,OAAwB;QAExB,OAAO,WAAW,CAAC,sBAAsB,CACvC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAA4C,EAC5C,OAAwB;QAExB,OAAO,WAAW,CAAC,uBAAuB,CACxC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,0BAA0B,CAC9B,OAAqD,EACrD,OAAwB;QAOxB,OAAO,oBAAoB,CAAC,gCAAgC,CAC1D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CACjB,OAAwC,EACxC,OAAwB;QAExB,OAAO,oBAAoB,CAAC,mBAAmB,CAC7C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,sBAAsB,CAC1B,OAAiD,EACjD,OAAwB;QAIxB,OAAO,oBAAoB,CAAC,4BAA4B,CACtD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAmC,EACnC,OAAwB;QAExB,OAAO,oBAAoB,CAAC,cAAc,CACxC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,wBAAwB,CAC5B,OAAmD,EACnD,OAAwB;QAIxB,OAAO,oBAAoB,CAAC,8BAA8B,CACxD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../../src/sdk/events.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,gCAAgC,EAAE,MAAM,8CAA8C,CAAC;AAChG,OAAO,EAAE,4BAA4B,EAAE,MAAM,0CAA0C,CAAC;AACxF,OAAO,EAAE,8BAA8B,EAAE,MAAM,4CAA4C,CAAC;AAC5F,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAgB,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE5E,MAAM,OAAO,MAAO,SAAQ,SAAS;IACnC;;;;;;;OAOG;IACH,KAAK,CAAC,WAAW,CACf,OAA0C,EAC1C,OAAwB;QAExB,OAAO,WAAW,CAAC,iBAAiB,CAClC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAmC,EACnC,OAAwB;QAExB,OAAO,WAAW,CAAC,cAAc,CAC/B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,WAAW,CACf,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,iBAAiB,CAClC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,WAAW,CACf,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,iBAAiB,CAClC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAA2C,EAC3C,OAAwB;QAExB,OAAO,WAAW,CAAC,sBAAsB,CACvC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAA4C,EAC5C,OAAwB;QAExB,OAAO,WAAW,CAAC,uBAAuB,CACxC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,0BAA0B,CAC9B,OAAqD,EACrD,OAAwB;QAOxB,OAAO,oBAAoB,CAAC,gCAAgC,CAC1D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,aAAa,CACjB,OAAwC,EACxC,OAAwB;QAExB,OAAO,oBAAoB,CAAC,mBAAmB,CAC7C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,sBAAsB,CAC1B,OAAiD,EACjD,OAAwB;QAIxB,OAAO,oBAAoB,CAAC,4BAA4B,CACtD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAmC,EACnC,OAAwB;QAExB,OAAO,oBAAoB,CAAC,cAAc,CACxC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,wBAAwB,CAC5B,OAAmD,EACnD,OAAwB;QAIxB,OAAO,oBAAoB,CAAC,8BAA8B,CACxD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/esm/sdk/fhirconfigs.d.ts

@@ -8,6 +8,8 @@ export declare class FhirConfigs extends ClientSDK {
      *
      * @remarks
      * List available FHIR configurations. This method requires the `fhir_config` / `view` permission.
+     *
+     * **Permissions.** Requires the `fhir_configs.view` permission.
      */
     listOfFhirConfigurations(request: operations.ListOfFhirConfigurationsRequest, options?: RequestOptions): Promise<PageIterator<operations.ListOfFhirConfigurationsResponse, {
         page: number;
@@ -19,6 +21,8 @@ export declare 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.
      */
     createAFhirConfig(request: components.FhirConfigCreate, options?: RequestOptions): Promise<components.FhirConfig>;
     /**
@@ -28,10 +32,15 @@ export declare 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.
      */
     getFhirConfig(request: operations.GetFhirConfigRequest, options?: RequestOptions): Promise<components.FhirConfig>;
     /**
      * Update any portion of a FHIR config by ID
+     *
+     * @remarks
+     * **Permissions.** Requires the `fhir_configs.edit` permission.
      */
     updateFhirConfigById(request: operations.UpdateFhirConfigByIdRequest, options?: RequestOptions): Promise<components.FhirConfig>;
     /**
@@ -39,6 +48,8 @@ export declare class FhirConfigs extends ClientSDK {
      *
      * @remarks
      * Requires the `fhir_config` / `delete` permission.
+     *
+     * **Permissions.** Requires the `fhir_configs.delete` permission.
      */
     deleteFhirConfigById(request: operations.DeleteFhirConfigByIdRequest, options?: RequestOptions): Promise<components.DeleteApiResponse>;
 }

package/dist/esm/sdk/fhirconfigs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fhirconfigs.d.ts","sourceRoot":"","sources":["../../../src/sdk/fhirconfigs.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAE5D,OAAO,EAAE,YAAY,EAAwB,MAAM,wBAAwB,CAAC;AAE5E,qBAAa,WAAY,SAAQ,SAAS;IACxC;;;;;OAKG;IACG,wBAAwB,CAC5B,OAAO,EAAE,UAAU,CAAC,+BAA+B,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CAAC,UAAU,CAAC,gCAAgC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAC5E;IAQD;;;;;;;OAOG;IACG,iBAAiB,CACrB,OAAO,EAAE,UAAU,CAAC,gBAAgB,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;;;OAOG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;OAEG;IACG,oBAAoB,CACxB,OAAO,EAAE,UAAU,CAAC,2BAA2B,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;OAKG;IACG,oBAAoB,CACxB,OAAO,EAAE,UAAU,CAAC,2BAA2B,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,iBAAiB,CAAC;CAOzC"}
+{"version":3,"file":"fhirconfigs.d.ts","sourceRoot":"","sources":["../../../src/sdk/fhirconfigs.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAE5D,OAAO,EAAE,YAAY,EAAwB,MAAM,wBAAwB,CAAC;AAE5E,qBAAa,WAAY,SAAQ,SAAS;IACxC;;;;;;;OAOG;IACG,wBAAwB,CAC5B,OAAO,EAAE,UAAU,CAAC,+BAA+B,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CAAC,UAAU,CAAC,gCAAgC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAC5E;IAQD;;;;;;;;;OASG;IACG,iBAAiB,CACrB,OAAO,EAAE,UAAU,CAAC,gBAAgB,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;;;;;OASG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;OAKG;IACG,oBAAoB,CACxB,OAAO,EAAE,UAAU,CAAC,2BAA2B,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;;;OAOG;IACG,oBAAoB,CACxB,OAAO,EAAE,UAAU,CAAC,2BAA2B,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,iBAAiB,CAAC;CAOzC"}

package/dist/esm/sdk/fhirconfigs.js

@@ -15,6 +15,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, options) {
         return unwrapResultIterator(fhirConfigsListOfFhirConfigurations(this, request, options));
@@ -26,6 +28,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, options) {
         return unwrapAsync(fhirConfigsCreateAFhirConfig(this, request, options));
@@ -37,12 +41,17 @@ 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, options) {
         return unwrapAsync(fhirConfigsGetFhirConfig(this, request, options));
     }
     /**
      * Update any portion of a FHIR config by ID
+     *
+     * @remarks
+     * **Permissions.** Requires the `fhir_configs.edit` permission.
      */
     async updateFhirConfigById(request, options) {
         return unwrapAsync(fhirConfigsUpdateFhirConfigById(this, request, options));
@@ -52,6 +61,8 @@ export class FhirConfigs extends ClientSDK {
      *
      * @remarks
      * Requires the `fhir_config` / `delete` permission.
+     *
+     * **Permissions.** Requires the `fhir_configs.delete` permission.
      */
     async deleteFhirConfigById(request, options) {
         return unwrapAsync(fhirConfigsDeleteFhirConfigById(this, request, options));

package/dist/esm/sdk/fhirconfigs.js.map

@@ -1 +1 @@
-{"version":3,"file":"fhirconfigs.js","sourceRoot":"","sources":["../../../src/sdk/fhirconfigs.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,4BAA4B,EAAE,MAAM,0CAA0C,CAAC;AACxF,OAAO,EAAE,+BAA+B,EAAE,MAAM,6CAA6C,CAAC;AAC9F,OAAO,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAChF,OAAO,EAAE,mCAAmC,EAAE,MAAM,iDAAiD,CAAC;AACtG,OAAO,EAAE,+BAA+B,EAAE,MAAM,6CAA6C,CAAC;AAC9F,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAgB,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE5E,MAAM,OAAO,WAAY,SAAQ,SAAS;IACxC;;;;;OAKG;IACH,KAAK,CAAC,wBAAwB,CAC5B,OAAmD,EACnD,OAAwB;QAIxB,OAAO,oBAAoB,CAAC,mCAAmC,CAC7D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAAoC,EACpC,OAAwB;QAExB,OAAO,WAAW,CAAC,4BAA4B,CAC7C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,aAAa,CACjB,OAAwC,EACxC,OAAwB;QAExB,OAAO,WAAW,CAAC,wBAAwB,CACzC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,oBAAoB,CACxB,OAA+C,EAC/C,OAAwB;QAExB,OAAO,WAAW,CAAC,+BAA+B,CAChD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,oBAAoB,CACxB,OAA+C,EAC/C,OAAwB;QAExB,OAAO,WAAW,CAAC,+BAA+B,CAChD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"fhirconfigs.js","sourceRoot":"","sources":["../../../src/sdk/fhirconfigs.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,4BAA4B,EAAE,MAAM,0CAA0C,CAAC;AACxF,OAAO,EAAE,+BAA+B,EAAE,MAAM,6CAA6C,CAAC;AAC9F,OAAO,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAChF,OAAO,EAAE,mCAAmC,EAAE,MAAM,iDAAiD,CAAC;AACtG,OAAO,EAAE,+BAA+B,EAAE,MAAM,6CAA6C,CAAC;AAC9F,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAgB,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE5E,MAAM,OAAO,WAAY,SAAQ,SAAS;IACxC;;;;;;;OAOG;IACH,KAAK,CAAC,wBAAwB,CAC5B,OAAmD,EACnD,OAAwB;QAIxB,OAAO,oBAAoB,CAAC,mCAAmC,CAC7D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAAoC,EACpC,OAAwB;QAExB,OAAO,WAAW,CAAC,4BAA4B,CAC7C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,aAAa,CACjB,OAAwC,EACxC,OAAwB;QAExB,OAAO,WAAW,CAAC,wBAAwB,CACzC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,oBAAoB,CACxB,OAA+C,EAC/C,OAAwB;QAExB,OAAO,WAAW,CAAC,+BAA+B,CAChD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,oBAAoB,CACxB,OAA+C,EAC/C,OAAwB;QAExB,OAAO,WAAW,CAAC,+BAA+B,CAChD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/esm/sdk/invoices.d.ts

@@ -14,6 +14,8 @@ export declare 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.
      */
     getInvoice(request: operations.GetInvoiceRequest, options?: RequestOptions): Promise<components.Invoice>;
     /**
@@ -29,13 +31,17 @@ export declare 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)
@@ -62,6 +68,8 @@ export declare 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.
      */
     createInvoice(request: operations.CreateInvoiceRequestBody, options?: RequestOptions): Promise<operations.CreateInvoiceCreateInvoiceOk>;
     /**
@@ -78,6 +86,8 @@ export declare 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.
      */
     updateInvoice(request: operations.UpdateInvoiceRequest, options?: RequestOptions): Promise<boolean>;
     /**
@@ -85,6 +95,8 @@ export declare 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.
      */
     makePayment(request: operations.MakePaymentRequest, options?: RequestOptions): Promise<operations.MakePaymentMakePaymentOk>;
     /**
@@ -105,6 +117,8 @@ export declare 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.
      */
     convertQuote(request: operations.ConvertQuoteRequest, options?: RequestOptions): Promise<operations.ConvertQuoteConvertQuoteOk>;
     /**
@@ -113,6 +127,18 @@ export declare 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`.
      */
     invoicesExport(request: operations.InvoicesExportRequest, options?: RequestOptions): Promise<components.CsvExportEnqueuedResponse>;
     /**
@@ -121,6 +147,8 @@ export declare 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.
      */
     getInvoicesExportStatus(request: operations.GetInvoicesExportStatusRequest, options?: RequestOptions): Promise<operations.GetInvoicesExportStatusResponseBody>;
     /**
@@ -128,6 +156,8 @@ export declare class Invoices extends ClientSDK {
      *
      * @remarks
      * Streams the exported CSV file.
+     *
+     * **Permissions.** Requires the `invoices.view` permission.
      */
     downloadInvoicesExport(request: operations.DownloadInvoicesExportRequest, options?: RequestOptions & {
         acceptHeaderOverride?: DownloadInvoicesExportAcceptEnum;

package/dist/esm/sdk/invoices.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"invoices.d.ts","sourceRoot":"","sources":["../../../src/sdk/invoices.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,gCAAgC,EAEjC,MAAM,4CAA4C,CAAC;AAOpD,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAE5D,OAAO,EAAE,YAAY,EAAwB,MAAM,wBAAwB,CAAC;AAE5E,OAAO,EAAE,gCAAgC,EAAE,MAAM,4CAA4C,CAAC;AAE9F,qBAAa,QAAS,SAAQ,SAAS;IACrC;;;;;;;;;OASG;IACG,UAAU,CACd,OAAO,EAAE,UAAU,CAAC,iBAAiB,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC;IAQ9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,YAAY,CAChB,OAAO,EAAE,UAAU,CAAC,mBAAmB,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,oBAAoB,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAQ3E;;;;;;;;;;;;;;OAcG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,4BAA4B,CAAC;IAQnD;;;;;;;;;;;;;;OAcG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,OAAO,CAAC;IAQnB;;;;;OAKG;IACG,WAAW,CACf,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAQ/C;;;;;;;;;;;;;;;;;;OAkBG;IACG,YAAY,CAChB,OAAO,EAAE,UAAU,CAAC,mBAAmB,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,0BAA0B,CAAC;IAQjD;;;;;;OAMG;IACG,cAAc,CAClB,OAAO,EAAE,UAAU,CAAC,qBAAqB,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,yBAAyB,CAAC;IAQhD;;;;;;OAMG;IACG,uBAAuB,CAC3B,OAAO,EAAE,UAAU,CAAC,8BAA8B,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mCAAmC,CAAC;IAQ1D;;;;;OAKG;IACG,sBAAsB,CAC1B,OAAO,EAAE,UAAU,CAAC,6BAA6B,EACjD,OAAO,CAAC,EAAE,cAAc,GAAG;QACzB,oBAAoB,CAAC,EAAE,gCAAgC,CAAC;KACzD,GACA,OAAO,CAAC,UAAU,CAAC,8BAA8B,GAAG,SAAS,CAAC;CAOlE"}
+{"version":3,"file":"invoices.d.ts","sourceRoot":"","sources":["../../../src/sdk/invoices.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,gCAAgC,EAEjC,MAAM,4CAA4C,CAAC;AAOpD,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAE5D,OAAO,EAAE,YAAY,EAAwB,MAAM,wBAAwB,CAAC;AAE5E,OAAO,EAAE,gCAAgC,EAAE,MAAM,4CAA4C,CAAC;AAE9F,qBAAa,QAAS,SAAQ,SAAS;IACrC;;;;;;;;;;;OAWG;IACG,UAAU,CACd,OAAO,EAAE,UAAU,CAAC,iBAAiB,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC;IAQ9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,YAAY,CAChB,OAAO,EAAE,UAAU,CAAC,mBAAmB,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,oBAAoB,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAQ3E;;;;;;;;;;;;;;;;OAgBG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,4BAA4B,CAAC;IAQnD;;;;;;;;;;;;;;;;OAgBG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,OAAO,CAAC;IAQnB;;;;;;;OAOG;IACG,WAAW,CACf,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAQ/C;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,YAAY,CAChB,OAAO,EAAE,UAAU,CAAC,mBAAmB,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,0BAA0B,CAAC;IAQjD;;;;;;;;;;;;;;;;;;OAkBG;IACG,cAAc,CAClB,OAAO,EAAE,UAAU,CAAC,qBAAqB,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,yBAAyB,CAAC;IAQhD;;;;;;;;OAQG;IACG,uBAAuB,CAC3B,OAAO,EAAE,UAAU,CAAC,8BAA8B,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mCAAmC,CAAC;IAQ1D;;;;;;;OAOG;IACG,sBAAsB,CAC1B,OAAO,EAAE,UAAU,CAAC,6BAA6B,EACjD,OAAO,CAAC,EAAE,cAAc,GAAG;QACzB,oBAAoB,CAAC,EAAE,gCAAgC,CAAC;KACzD,GACA,OAAO,CAAC,UAAU,CAAC,8BAA8B,GAAG,SAAS,CAAC;CAOlE"}