@oystehr/sdk 4.1.3 → 4.1.6

package/src/resources/classes/erx.ts

@@ -34,6 +34,8 @@ export class Erx extends SDKResource {
   }
   /**
    * Search for allergens.
+   * Action: `eRx:SearchAllergen`
+   * Access Policy Resource: `eRx:Allergen`
    */
   searchAllergens(
     params: ErxSearchAllergensParams,
@@ -43,6 +45,8 @@ export class Erx extends SDKResource {
   }
   /**
    * Search for medications.
+   * Action: `eRx:SearchMedication`
+   * Access Policy Resource: `eRx:Medication`
    */
   searchMedications(
     params: ErxSearchMedicationsParams,
@@ -52,12 +56,16 @@ export class Erx extends SDKResource {
   }
   /**
    * Get eRx configuration for project.
+   * Action: `eRx:GetConfiguration`
+   * Access Policy Resource: `eRx:Configuration`
    */
   getConfiguration(request?: OystehrClientRequest): Promise<ErxGetConfigurationResponse> {
     return this.request('/config', 'get', this.#baseUrlThunk.bind(this))(request);
   }
   /**
-   * Checks for drug-allergy interactions for a patient. This endpoint requires the patient's allergies to be synced with the upstream eRx provider.
+   * Check for drug-allergy interactions for a patient. This endpoint requires the patient's allergies to be synced with the upstream eRx provider.
+   * Action: `eRx:Check`
+   * Access Policy Resource: `eRx:Interaction`
    */
   checkAllergyInteractions(
     params: ErxCheckAllergyInteractionsParams,
@@ -70,7 +78,9 @@ export class Erx extends SDKResource {
     )(params, request);
   }
   /**
-   * Checks for drug-drug interactions for a patient. This endpoint requires the patient's medications to be synced with the upstream eRx provider.
+   * Check for drug-drug interactions for a patient. This endpoint requires the patient's medications to be synced with the upstream eRx provider.
+   * Action: `eRx:Check`
+   * Access Policy Resource: `eRx:Interaction`
    */
   checkMedicationInteractions(
     params: ErxCheckMedicationInteractionsParams,
@@ -83,7 +93,9 @@ export class Erx extends SDKResource {
     )(params, request);
   }
   /**
-   * Checks for drug-allergy and drug-drug interactions with a specific drug for a patient. This endpoint requires the patient's allergies and medications to be synced with the upstream eRx provider.
+   * Check for drug-allergy and drug-drug interactions with a specific drug for a patient. This endpoint requires the patient's allergies and medications to be synced with the upstream eRx provider.
+   * Action: `eRx:Check`
+   * Access Policy Resource: `eRx:Interaction`
    */
   checkPrecheckInteractions(
     params: ErxCheckPrecheckInteractionsParams,
@@ -97,6 +109,8 @@ export class Erx extends SDKResource {
   }
   /**
    * Cancel prescription for patient.
+   * Action: `eRx:CancelPrescription`
+   * Access Policy Resource: `eRx:Prescription`
    */
   cancelPrescription(params: ErxCancelPrescriptionParams, request?: OystehrClientRequest): Promise<void> {
     return this.request(
@@ -107,12 +121,16 @@ export class Erx extends SDKResource {
   }
   /**
    * Syncs demographic, allergy, and medication data for a patient with the upstream eRx provider.
+   * Action: `eRx:SyncPatient`
+   * Access Policy Resource: `eRx:Patient`
    */
   syncPatient(params: ErxSyncPatientParams, request?: OystehrClientRequest): Promise<void> {
     return this.request('/patient/{patientId}/sync', 'post', this.#baseUrlThunk.bind(this))(params, request);
   }
   /**
    * Create an SSO link for a practitioner. This link can be used to log in to the eRx service as the specified practitioner.
+   * Action: `eRx:Connect`
+   * Access Policy Resource: `eRx:SSO`
    */
   connectPractitioner(
     params: ErxConnectPractitionerParams,
@@ -120,10 +138,14 @@ export class Erx extends SDKResource {
   ): Promise<ErxConnectPractitionerResponse>;
   /**
    * Create an SSO link for a practitioner. This link can be used to log in to the eRx service as the specified practitioner.
+   * Action: `eRx:Connect`
+   * Access Policy Resource: `eRx:SSO`
    */
   connectPractitioner(request?: OystehrClientRequest): Promise<ErxConnectPractitionerResponse>;
   /**
    * Create an SSO link for a practitioner. This link can be used to log in to the eRx service as the specified practitioner.
+   * Action: `eRx:Connect`
+   * Access Policy Resource: `eRx:SSO`
    */
   connectPractitioner(
     params?: ErxConnectPractitionerParams | OystehrClientRequest,
@@ -133,6 +155,8 @@ export class Erx extends SDKResource {
   }
   /**
    * Check eRx enrollment for a practitioner.
+   * Action: `eRx:Read`
+   * Access Policy Resource: `eRx:Enrollment`
    */
   checkPractitionerEnrollment(
     params: ErxCheckPractitionerEnrollmentParams,
@@ -142,12 +166,16 @@ export class Erx extends SDKResource {
   }
   /**
    * Enroll a practitioner in the eRx service.
+   * Action: `eRx:Create`
+   * Access Policy Resource: `eRx:Enrollment`
    */
   enrollPractitioner(params: ErxEnrollPractitionerParams, request?: OystehrClientRequest): Promise<void> {
     return this.request('/practitioner/{practitionerId}', 'post', this.#baseUrlThunk.bind(this))(params, request);
   }
   /**
    * Unenroll a practitioner from the eRx service.
+   * Action: `eRx:Delete`
+   * Access Policy Resource: `eRx:Enrollment`
    */
   unenrollPractitioner(params: ErxUnenrollPractitionerParams, request?: OystehrClientRequest): Promise<void> {
     return this.request('/practitioner/{practitionerId}', 'delete', this.#baseUrlThunk.bind(this))(params, request);

package/src/resources/classes/fax.ts

@@ -1,6 +1,12 @@
 // AUTOGENERATED -- DO NOT EDIT
 
-import { FaxOnboardResponse, FaxSendParams, FaxSendResponse, OystehrClientRequest } from '../..';
+import {
+  FaxGetConfigurationResponse,
+  FaxOnboardResponse,
+  FaxSendParams,
+  FaxSendResponse,
+  OystehrClientRequest,
+} from '../..';
 import { SDKResource } from '../../client/client';
 import { OystehrConfig } from '../../config';
 
@@ -31,6 +37,16 @@ export class Fax extends SDKResource {
   onboard(request?: OystehrClientRequest): Promise<FaxOnboardResponse> {
     return this.request('/onboard', 'post', this.#baseUrlThunk.bind(this))(request);
   }
+  /**
+   * Get fax service configuration.
+   *
+   * Access Policy Requirements:
+   * Action: `Fax:GetConfiguration`
+   * Access Policy Resource: `Fax:Configuration`
+   */
+  getConfiguration(request?: OystehrClientRequest): Promise<FaxGetConfigurationResponse> {
+    return this.request('/config', 'get', this.#baseUrlThunk.bind(this))(request);
+  }
   /**
    * Send a fax. Oystehr's [fax sending](https://docs.oystehr.com/oystehr/services/fax/send/) feature makes it easy to send a fax to a chosen recipient with a single API call. You can use this feature to send referrals, medical records, prescriptions, and other documents that require fax transmission e.g. for HIPAA compliance.
    *

package/src/resources/classes/lab.ts

@@ -103,7 +103,7 @@ export class Lab extends SDKResource {
     )(params, request);
   }
   /**
-   * Submit a lab order. Oystehr's [Submit Lab](https://docs.oystehr.com/oystehr/services/lab/submit-an-order/) feature allows users to submit a well configured ServiceRequest to an external lab. In order to successfully submit an order, a [Route](https://docs.oystehr.com/oystehr/services/lab/onboarding-a-lab/#create-route) to and Organization representing that lab must exist. If the lab requires its own requisition document (eReq) or an Advance Beneficiary Notice (ABN), the appropriate DocumentReferences will be included in the response.
+   * Submit a lab order. Oystehr's [Submit Lab](https://docs.oystehr.com/oystehr/services/lab/submit-an-order/) feature allows users to submit an order consisting of one or more well-configured ServiceRequests to an external lab. In order to successfully submit an order, a [Route](https://docs.oystehr.com/oystehr/services/lab/onboarding-a-lab/#create-route) to and Organization representing that lab must exist. If the lab requires its own requisition document (eReq) or an Advance Beneficiary Notice (ABN), the appropriate DocumentReferences will be included in the response.
    *
    * Access Policy Requirements:
    * Action: `Lab:SubmitOrder`

package/src/resources/classes/m2m.ts

@@ -47,7 +47,7 @@ export class M2m extends SDKResource {
     return this.request('/m2m', 'post', this.#baseUrlThunk.bind(this))(params, request);
   }
   /**
-   * Get information about the calling M2M Client [M2M Clients](https://docs.oystehr.com/oystehr/services/iam/m2m-clients) are used to access Oystehr APIs from scripts and server-side code like [Zambda Functions](https://docs.oystehr.com/oystehr/services/zambda).
+   * Get information about the calling M2M Client. [M2M Clients](https://docs.oystehr.com/oystehr/services/iam/m2m-clients) are used to access Oystehr APIs from scripts and server-side code like [Zambda Functions](https://docs.oystehr.com/oystehr/services/zambda).
    *
    * Access Policy Action: `App:GetM2MClient`
    * Access Policy Resource: `IAM:M2MClient`

package/src/resources/types/Application.ts

@@ -10,6 +10,10 @@ export interface Application {
    * The Application's OAuth 2.0 client identifier.
    */
   clientId: string;
+  /**
+   * The Application's connection name for use with frontend components.
+   */
+  connectionName?: string;
   /**
    * A description of the application to help you differentiate it from other applications in the project. This value is not displayed to end users.
    */

package/src/resources/types/FaxGetConfigurationResponse.ts

@@ -0,0 +1,15 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+/**
+ * Successfully retrieved fax service configuration.
+ */
+export interface FaxGetConfigurationResponse {
+  /**
+   * True if the project is configured with the fax service.
+   */
+  configured: boolean;
+  /**
+   * An array of fax numbers assigned to your project in E.164 format.
+   */
+  faxNumbers?: string[];
+}

package/src/resources/types/LabOrderSubmitParams.ts

@@ -7,7 +7,11 @@ export interface LabOrderSubmitParams {
    */
   accountNumber: string;
   /**
-   * Valid ServiceRequest FHIR resource representing an order. See [Submit Lab](https://docs.oystehr.com/oystehr/services/lab/submit-an-order/) for more details.
+   * Reference to a valid ServiceRequest FHIR resource representing an order. See [Submit Lab](https://docs.oystehr.com/oystehr/services/lab/submit-an-order/) for more details.
    */
-  serviceRequest: string;
+  serviceRequest: string | string[];
+  /**
+   * A client-provided string used to identify all tests in an order. See [Submit Lab](https://docs.oystehr.com/oystehr/services/lab/submit-an-order/#client-provided-order-number/) for more details.
+   */
+  orderNumber?: string;
 }

package/src/resources/types/ZambdaCreateParams.ts

@@ -15,7 +15,7 @@ export interface ZambdaCreateParams {
   /**
    * The runtime to use for the Zambda Function.
    */
-  runtime: 'nodejs18.x' | 'nodejs20.x' | 'nodejs22.x' | 'python3.13' | 'python3.12' | 'java21' | 'dotnet9' | 'ruby3.3';
+  runtime: 'nodejs20.x' | 'nodejs22.x' | 'python3.13' | 'python3.12' | 'java21' | 'dotnet9' | 'ruby3.3';
   /**
    * The amount of memory in MB to allocate to the Zambda Function. If not specified, a system default (1024MB) will be used. Min: 128MB, Max: 10240MB.
    */
@@ -24,8 +24,4 @@ export interface ZambdaCreateParams {
    * The timeout for the Zambda Function in seconds. If not specified, a system default (27 seconds) will be used. Min: 1s, Max: 900s (15 minutes). Note: For 'http_auth' and 'http_open' trigger methods, the timeout cannot exceed 27 seconds due to API Gateway limitations.
    */
   timeoutInSeconds?: number;
-  /**
-   * The ID of the IAM role that the Zambda Function will assume when it is invoked.
-   */
-  executionRoleId?: string;
 }

package/src/resources/types/ZambdaFunction.ts

@@ -46,8 +46,4 @@ export interface ZambdaFunction {
    * The timeout for the Zambda Function in seconds. If not specified, a system default (27 seconds) will be used. Min: 1s, Max: 900s (15 minutes). Note: For 'http_auth' and 'http_open' trigger methods, the timeout cannot exceed 27 seconds due to API Gateway limitations.
    */
   timeoutInSeconds?: number;
-  /**
-   * The ID of the IAM role that the Zambda Function will assume when it is invoked.
-   */
-  executionRoleId?: string;
 }

package/src/resources/types/ZambdaUpdateParams.ts

@@ -15,7 +15,7 @@ export interface ZambdaUpdateParams {
   /**
    * The runtime to use for the Zambda Function.
    */
-  runtime?: 'nodejs18.x' | 'nodejs20.x' | 'nodejs22.x' | 'python3.13' | 'python3.12' | 'java21' | 'dotnet9' | 'ruby3.3';
+  runtime?: 'nodejs20.x' | 'nodejs22.x' | 'python3.13' | 'python3.12' | 'java21' | 'dotnet9' | 'ruby3.3';
   /**
    * The amount of memory in MB to allocate to the Zambda Function. If not specified, a system default (1024MB) will be used. Min: 128MB, Max: 10240MB.
    */
@@ -24,9 +24,5 @@ export interface ZambdaUpdateParams {
    * The timeout for the Zambda Function in seconds. If not specified, a system default (27 seconds) will be used. Min: 1s, Max: 900s (15 minutes). Note: For 'http_auth' and 'http_open' trigger methods, the timeout cannot exceed 27 seconds due to API Gateway limitations.
    */
   timeoutInSeconds?: number;
-  /**
-   * The ID of the IAM role that the Zambda Function will assume when it is invoked.
-   */
-  executionRoleId?: string;
   id: string;
 }

package/src/resources/types/index.ts

@@ -167,6 +167,7 @@ export * from './ZambdaLogStreamSearchResponse';
 export * from './ZambdaLogStreamGetParams';
 export * from './ZambdaLogStreamGetResponse';
 export * from './FaxOnboardResponse';
+export * from './FaxGetConfigurationResponse';
 export * from './FaxSendParams';
 export * from './FaxSendResponse';
 export * from './LabRouteListResponse';