@oystehr/sdk 3.0.0

package/dist/esm/resources/types/UserInviteParams.d.ts

@@ -0,0 +1,35 @@
+import { Patient, Practitioner } from 'fhir/r4b';
+import { AccessPolicy } from './AccessPolicy';
+export interface UserInviteParams {
+    /**
+     * A name for the User to help you differentiate them from other Users in the project. Defaults to the User's email or phone number if not provided.
+     */
+    username?: string;
+    /**
+     * The User's email address.
+     */
+    email: string | null;
+    /**
+     * The User's phone number.
+     */
+    phoneNumber?: string | null;
+    accessPolicy?: AccessPolicy;
+    /**
+     * ssoData contains information about the user from a third-party SSO identity provider. For example, if you send a `upn` or other information in a SAML payload, it is stored here. It is only populated if the User authenticated via SSO with a third-party identity provider.
+     */
+    ssoData?: {
+        [k: string]: any;
+    };
+    /**
+     * The application ID to which you want to invite a user
+     */
+    applicationId: string;
+    /**
+     * A valid Patient or Practitioner FHIR Resource which will be created and become the User's 'profile'.
+     */
+    resource: Patient | Practitioner;
+    /**
+     * A list of Role IDs to assign to the invited user. If the accessPolicy property is not provided this property is required and may not be empty.
+     */
+    roles?: string[];
+}

package/dist/esm/resources/types/UserInviteResponse.d.ts

@@ -0,0 +1,37 @@
+import { AccessPolicy } from './AccessPolicy';
+import { RoleStub } from './RoleStub';
+/**
+ * Successfully invited a user
+ */
+export interface UserInviteResponse {
+    id: string;
+    /**
+     * A name for the User to help you differentiate them from other Users in the project. Defaults to the User's email or phone number if not provided.
+     */
+    name: string;
+    /**
+     * The User's email address.
+     */
+    email: string | null;
+    /**
+     * The User's phone number.
+     */
+    phoneNumber: string | null;
+    /**
+     * The name of the connection used to authenticate the User. One of: email, sms, or the name of a custom SSO connection.
+     */
+    authenticationMethod: string;
+    accessPolicy?: AccessPolicy;
+    /**
+     * Reference to the FHIR resource that represents the User in the FHIR store. May be any of the following resource types: Practitioner, Patient, RelatedPerson.
+     */
+    profile: string;
+    /**
+     * The roles assigned to the User.
+     */
+    roles?: RoleStub[];
+    /**
+     * The invitation url to the project
+     */
+    invitationUrl: string;
+}

package/dist/esm/resources/types/UserListItem.d.ts

@@ -0,0 +1,15 @@
+export interface UserListItem {
+    id: string;
+    /**
+     * A name for the User to help you differentiate them from other Users in the project. Defaults to the User's email or phone number if not provided.
+     */
+    name: string;
+    /**
+     * The User's email address.
+     */
+    email: string;
+    /**
+     * Reference to the FHIR resource that represents the User in the FHIR store. May be any of the following resource types: Practitioner, Patient, RelatedPerson.
+     */
+    profile: string;
+}

package/dist/esm/resources/types/UserListResponse.d.ts

@@ -0,0 +1,5 @@
+import { UserListItem } from './UserListItem';
+/**
+ * List of all Users.
+ */
+export type UserListResponse = UserListItem[];

package/dist/esm/resources/types/UserListV2Params.d.ts

@@ -0,0 +1,11 @@
+export interface UserListV2Params {
+    name?: string;
+    id?: string;
+    email?: string;
+    profile?: string;
+    roleId?: string;
+    cursor?: string;
+    limit?: number;
+    sort?: string;
+    sortOrder?: string;
+}

package/dist/esm/resources/types/UserListV2Response.d.ts

@@ -0,0 +1,16 @@
+import { UserListItem } from './UserListItem';
+/**
+ * List of all Users with pagination details.
+ */
+export interface UserListV2Response {
+    /**
+     * An array of user objects. This array is empty if no users match the query criteria.
+     */
+    data: UserListItem[];
+    metadata: {
+        /**
+         * Cursor to fetch the next page of results. Null if there are no further pages.
+         */
+        nextCursor: string | null;
+    };
+}

package/dist/esm/resources/types/UserMeResponse.d.ts

@@ -0,0 +1,5 @@
+import { User } from './User';
+/**
+ * Details about the current User.
+ */
+export type UserMeResponse = User;

package/dist/esm/resources/types/UserUpdateParams.d.ts

@@ -0,0 +1,9 @@
+import { AccessPolicy } from './AccessPolicy';
+export interface UserUpdateParams {
+    accessPolicy?: AccessPolicy;
+    /**
+     * A list of Role IDs to assign to the user. If the accessPolicy property is not provided this property is required and may not be empty.
+     */
+    roles?: string[];
+    id: string;
+}

package/dist/esm/resources/types/UserUpdateResponse.d.ts

@@ -0,0 +1,5 @@
+import { User } from './User';
+/**
+ * Updated information response body about a specific user
+ */
+export type UserUpdateResponse = User;

package/dist/esm/resources/types/VersionGetResponse.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The project API version
+ */
+export interface VersionGetResponse {
+    /**
+     * Always "project"
+     */
+    api: string;
+    /**
+     * The project API version
+     */
+    version: string;
+    /**
+     * Always "production"
+     */
+    environment: string;
+}

package/dist/esm/resources/types/Z3CreateBucketParams.d.ts

@@ -0,0 +1,3 @@
+export interface Z3CreateBucketParams {
+    bucketName: string;
+}

package/dist/esm/resources/types/Z3CreateBucketResponse.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Z3 Bucket was created successfully.
+ */
+export interface Z3CreateBucketResponse {
+    id: string;
+    /**
+     * The bucket name as specified in the bucketName path parameter.
+     */
+    name: string;
+}

package/dist/esm/resources/types/Z3DeleteBucketParams.d.ts

@@ -0,0 +1,3 @@
+export interface Z3DeleteBucketParams {
+    bucketName: string;
+}

package/dist/esm/resources/types/Z3DeleteObjectParams.d.ts

@@ -0,0 +1,8 @@
+export interface Z3DeleteObjectParams {
+    /**
+     * An optional parameter that serves two goals: 1 - differentiate files and folders (undefined for files and empty/non-empty array for folders), 2 - allow deletion of folder content to avoid cases when folder is still visible after deletion because it's part of its children's path.
+     */
+    children?: string[];
+    bucketName: string;
+    'objectPath+': string;
+}

package/dist/esm/resources/types/Z3GetPresignedUrlParams.d.ts

@@ -0,0 +1,9 @@
+export interface Z3GetPresignedUrlParams {
+    action: string;
+    /**
+     * An optional parameter that determines which type of S3 object should be created.
+     */
+    isFolder?: boolean;
+    bucketName: string;
+    'objectPath+': string;
+}

package/dist/esm/resources/types/Z3GetPresignedUrlResponse.d.ts

@@ -0,0 +1,9 @@
+/**
+ * A URL was successfully prepared for the client to upload/download the object.
+ */
+export interface Z3GetPresignedUrlResponse {
+    /**
+     * The URL that the client should use for uploading/downloading the object.
+     */
+    signedUrl: string;
+}

package/dist/esm/resources/types/Z3ListBucketsResponse.d.ts

@@ -0,0 +1,14 @@
+/**
+ * List of all Z3 Buckets in the project.
+ */
+export type Z3ListBucketsResponse = {
+    id: string;
+    /**
+     * The name of the Z3 Bucket.
+     */
+    name: string;
+    /**
+     * The date and time when the Z3 Bucket was created in ISO 8601 format.
+     */
+    creationDate: string;
+}[];

package/dist/esm/resources/types/Z3ListObjectsParams.d.ts

@@ -0,0 +1,4 @@
+export interface Z3ListObjectsParams {
+    bucketName: string;
+    'objectPath+': string;
+}

package/dist/esm/resources/types/Z3ListObjectsResponse.d.ts

@@ -0,0 +1,13 @@
+/**
+ * List of all objects in the Z3 Bucket.
+ */
+export type Z3ListObjectsResponse = {
+    /**
+     * The key (path) of the Z3 Object which may be used to GET the Z3 Object.
+     */
+    key: string;
+    /**
+     * The date and time when the Z3 Object was last modified in ISO 8601 format.
+     */
+    lastModified: string;
+}[];

package/dist/esm/resources/types/ZambdaCreateParams.d.ts

@@ -0,0 +1,12 @@
+import { ZambdaSchedule } from './ZambdaSchedule';
+export interface ZambdaCreateParams {
+    /**
+     * A name for the Zambda Function. May contain letters, numbers, dashes, and underscores. Must be unique within the project.
+     */
+    name: string;
+    /**
+     * The trigger method for the Zambda Function determines how the Function is invoked. Learn more about the different types here, https://docs.oystehr.com/services/zambda/#types-of-zambdas.
+     */
+    triggerMethod: string;
+    schedule?: ZambdaSchedule;
+}

package/dist/esm/resources/types/ZambdaCreateResponse.d.ts

@@ -0,0 +1,5 @@
+import { ZambdaFunction } from './ZambdaFunction';
+/**
+ * Successfully created a zambda
+ */
+export type ZambdaCreateResponse = ZambdaFunction;

package/dist/esm/resources/types/ZambdaDeleteParams.d.ts

@@ -0,0 +1,3 @@
+export interface ZambdaDeleteParams {
+    id: string;
+}

package/dist/esm/resources/types/ZambdaExecuteParams.d.ts

@@ -0,0 +1,4 @@
+export interface ZambdaExecuteParams {
+    id: string;
+    [k: string]: any;
+}

package/dist/esm/resources/types/ZambdaExecutePublicParams.d.ts

@@ -0,0 +1,4 @@
+export interface ZambdaExecutePublicParams {
+    id: string;
+    [k: string]: any;
+}

package/dist/esm/resources/types/ZambdaExecutePublicResponse.d.ts

@@ -0,0 +1,5 @@
+import { ZambdaExecuteResult } from './ZambdaExecuteResult';
+/**
+ * Zambda Function was executed successfully. The response body contains the output from the Zambda Function.
+ */
+export type ZambdaExecutePublicResponse = ZambdaExecuteResult;

package/dist/esm/resources/types/ZambdaExecuteResponse.d.ts

@@ -0,0 +1,5 @@
+import { ZambdaExecuteResult } from './ZambdaExecuteResult';
+/**
+ * Zambda Function was executed successfully. The response body contains the output from the Zambda Function.
+ */
+export type ZambdaExecuteResponse = ZambdaExecuteResult;

package/dist/esm/resources/types/ZambdaExecuteResult.d.ts

@@ -0,0 +1,10 @@
+export interface ZambdaExecuteResult {
+    /**
+     * HTTP status code from the Zambda Function
+     */
+    status: number;
+    /**
+     * JSON response payload from the Zambda Function
+     */
+    output: string;
+}

package/dist/esm/resources/types/ZambdaFunction.d.ts

@@ -0,0 +1,38 @@
+import { ZambdaSchedule } from './ZambdaSchedule';
+export interface ZambdaFunction {
+    id: string;
+    /**
+     * A name for the Zambda Function. May contain letters, numbers, dashes, and underscores. Must be unique within the project.
+     */
+    name: string;
+    /**
+     * The runtime of the Zambda Function.
+     */
+    runtime?: string;
+    /**
+     * The Zambda Function status provides information about the Functions state including whether it is ready to be invoked.
+     */
+    status: string;
+    /**
+     * The trigger method for the Zambda Function determines how the Function is invoked. Learn more about the different types here, https://docs.oystehr.com/services/zambda/#types-of-zambdas.
+     */
+    triggerMethod: string;
+    schedule?: ZambdaSchedule;
+    /**
+     * Info about the zip file that was uploaded for the Zambda Function.
+     */
+    fileInfo?: {
+        /**
+         * The name of the zip file that was uploaded for the Zambda Function.
+         */
+        name?: string;
+        /**
+         * The size of the zip file that was uploaded for the Zambda Function.
+         */
+        size?: number;
+        /**
+         * The date and time when the Z3 Object was last modified in ISO 8601 format.
+         */
+        lastModified?: string;
+    };
+}

package/dist/esm/resources/types/ZambdaGetParams.d.ts

@@ -0,0 +1,3 @@
+export interface ZambdaGetParams {
+    id: string;
+}

package/dist/esm/resources/types/ZambdaGetResponse.d.ts

@@ -0,0 +1,5 @@
+import { ZambdaFunction } from './ZambdaFunction';
+/**
+ * The requested Zambda Function
+ */
+export type ZambdaGetResponse = ZambdaFunction;

package/dist/esm/resources/types/ZambdaListResponse.d.ts

@@ -0,0 +1,5 @@
+import { ZambdaFunction } from './ZambdaFunction';
+/**
+ * List of all Zambda Functions in the Project
+ */
+export type ZambdaListResponse = ZambdaFunction[];

package/dist/esm/resources/types/ZambdaLogStreamGetParams.d.ts

@@ -0,0 +1,8 @@
+export interface ZambdaLogStreamGetParams {
+    /**
+     * The token to get the next set of items. This value is returned in the "nextForwardToken" field of the response from the previous call.
+     */
+    nextToken?: string;
+    id: string;
+    logStreamName: string;
+}

package/dist/esm/resources/types/ZambdaLogStreamGetResponse.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Zambda Function log stream logs response
+ */
+export interface ZambdaLogStreamGetResponse {
+    logEvents: {
+        /**
+         * The content of the log event.
+         */
+        message: string;
+        /**
+         * The time the event occurred. Formatted as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
+         */
+        timestamp: number;
+        /**
+         * The time the event was ingested. Formatted as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
+         */
+        ingestionTime: number;
+    }[];
+    /**
+     * The token for the next set of items in the backward direction.
+     */
+    nextBackwardToken?: string;
+    /**
+     * The token for the next set of items in the forward direction.
+     */
+    nextForwardToken?: string;
+}

package/dist/esm/resources/types/ZambdaLogStreamListParams.d.ts

@@ -0,0 +1,4 @@
+export interface ZambdaLogStreamListParams {
+    id: string;
+    token?: string;
+}

package/dist/esm/resources/types/ZambdaLogStreamListResponse.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Zambda Function log streams response object.
+ */
+export interface ZambdaLogStreamListResponse {
+    /**
+     * The log streams for the Zambda Function.
+     */
+    logStreams: {
+        /**
+         * The name of the Zambda Function log stream.
+         */
+        logStreamName: string;
+        /**
+         * The time of the most recent log event in the Zambda Function log stream. Formatted as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
+         */
+        lastEventTimestamp: number;
+        /**
+         * The sequence token.
+         */
+        uploadSequenceToken?: string;
+        /**
+         * The ID of the log stream.
+         */
+        arn?: string;
+        /**
+         * The time of the first event. Formatted as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
+         */
+        firstEventTimestamp: number;
+        /**
+         * Deprecated and not usable. Always returns zero.
+         */
+        storedBytes?: number;
+        /**
+         * The ingestion time of the log stream. Formatted as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
+         */
+        lastIngestionTime?: number;
+        /**
+         * The creation time of the log stream. Formatted as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
+         */
+        creationTime?: number;
+    }[];
+    /**
+     * The token that indexes the next group of logStreams. This value is returned in the "nextToken" field of the response from the previous call.
+     */
+    nextToken?: string;
+}

package/dist/esm/resources/types/ZambdaLogStreamSearchParams.d.ts

@@ -0,0 +1,19 @@
+export interface ZambdaLogStreamSearchParams {
+    /**
+     * The filter to use for log messages. Supports the full scope of Cloudwatch's search behavior https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html.
+     */
+    filter?: string;
+    /**
+     * The minimum date and time of the log's timestamp. Formatted as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
+     */
+    start?: number;
+    /**
+     * The maximum date and time of the log's timestamp. Formatted as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
+     */
+    end?: number;
+    /**
+     * The token to get the next set of items. This value is returned in the "nextToken" field of the response from the previous call.
+     */
+    nextToken?: string;
+    id: string;
+}

package/dist/esm/resources/types/ZambdaLogStreamSearchResponse.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Zambda Function log stream logs response
+ */
+export interface ZambdaLogStreamSearchResponse {
+    logEvents: {
+        /**
+         * The content of the log event.
+         */
+        message: string;
+        /**
+         * The time the event occurred. Formatted as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
+         */
+        timestamp: number;
+        /**
+         * The time the event was ingested. Formatted as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
+         */
+        ingestionTime: number;
+    }[];
+    /**
+     * The token to get the next set of items. This value is returned in the "nextToken" field of the response from the previous call.
+     */
+    nextToken?: string;
+}

package/dist/esm/resources/types/ZambdaS3UploadParams.d.ts

@@ -0,0 +1,7 @@
+export interface ZambdaS3UploadParams {
+    /**
+     * Optional filename for the Zambda Function code zip. If not provided, the filename will be randomized.
+     */
+    filename?: string;
+    id: string;
+}

package/dist/esm/resources/types/ZambdaS3UploadResponse.d.ts

@@ -0,0 +1,9 @@
+/**
+ * The URL to upload your Zambda Function code zip to.
+ */
+export interface ZambdaS3UploadResponse {
+    /**
+     * The URL to upload your Zambda Function code zip to.
+     */
+    signedUrl: string;
+}

package/dist/esm/resources/types/ZambdaSchedule.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Required when triggerMethod is 'cron', the schedule object defines when the Zambda Function is invoked.
+ */
+export interface ZambdaSchedule {
+    /**
+     * A cron expression that determines when the Zambda Function is invoked. The expression must conform to the format here, https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cron-expressions.html.
+     */
+    expression: string;
+    /**
+     * An optional start date and time when the cron expression will go into effect.
+     */
+    start?: string;
+    /**
+     * An optional end date and time when the cron expression will no longer be in effect.
+     */
+    end?: string;
+    /**
+     * Optional retry policy that defines the behavior of retry attempts and event age.
+     */
+    retryPolicy?: {
+        /**
+         * The maximum age of a request that Zambda sends to a function for processing, in seconds.
+         */
+        maximumEventAge?: number;
+        /**
+         * The maximum number of times to retry when the function returns an error.
+         */
+        maximumRetry?: number;
+    };
+}

package/dist/esm/resources/types/ZambdaUpdateParams.d.ts

@@ -0,0 +1,17 @@
+import { ZambdaSchedule } from './ZambdaSchedule';
+export interface ZambdaUpdateParams {
+    /**
+     * A name for the Zambda Function. May contain letters, numbers, dashes, and underscores. Must be unique within the project.
+     */
+    name?: string;
+    /**
+     * The trigger method for the Zambda Function determines how the Function is invoked. Learn more about the different types here, https://docs.oystehr.com/services/zambda/#types-of-zambdas.
+     */
+    triggerMethod?: string;
+    schedule?: ZambdaSchedule;
+    /**
+     * The runtime to use for the Zambda Function. This property is optional and defaults to "nodejs20.x".
+     */
+    runtime?: string;
+    id: string;
+}

package/dist/esm/resources/types/ZambdaUpdateResponse.d.ts

@@ -0,0 +1,5 @@
+import { ZambdaFunction } from './ZambdaFunction';
+/**
+ * Zambda Function updated successfully
+ */
+export type ZambdaUpdateResponse = ZambdaFunction;

package/dist/esm/resources/types/fhir.d.ts

@@ -0,0 +1,46 @@
+import type { Operation } from 'fast-json-patch';
+import type { Binary as BinaryR4B, Bundle as BundleR4B, BundleEntry as BundleEntryR4B, FhirResource as FhirResourceR4B, OperationOutcome as OperationOutcomeR4B } from 'fhir/r4b';
+import type { Binary as BinaryR5, Bundle as BundleR5, BundleEntry as BundleEntryR5, FhirResource as FhirResourceR5, OperationOutcome as OperationOutcomeR5 } from 'fhir/r5';
+export type FhirResource = FhirResourceR4B | FhirResourceR5;
+export type FhirBundle<F extends FhirResource> = F extends FhirResourceR4B ? BundleR4B<F> : BundleR5<F>;
+export type Bundle<F extends FhirResource> = FhirBundle<F> & {
+    unbundle: (this: Bundle<F>) => F[];
+};
+export type BundleEntry<F extends FhirResource> = F extends FhirResourceR4B ? BundleEntryR4B<F> : BundleEntryR5<F>;
+export type Binary<F extends FhirResource> = F extends FhirResourceR4B ? BinaryR4B : BinaryR5;
+export type OperationOutcome = OperationOutcomeR4B | OperationOutcomeR5;
+interface BatchInputBaseRequest {
+    url: string;
+}
+export interface BatchInputGetRequest extends BatchInputBaseRequest {
+    method: 'GET';
+}
+export interface BatchInputHeadRequest extends BatchInputBaseRequest {
+    method: 'HEAD';
+}
+export interface BatchInputDeleteRequest extends BatchInputBaseRequest {
+    method: 'DELETE';
+}
+export interface BatchInputPutRequest<F extends FhirResource> extends BatchInputBaseRequest {
+    method: 'PUT';
+    resource: F;
+}
+export interface BatchInputPostRequest<F extends FhirResource> extends BatchInputBaseRequest {
+    method: 'POST';
+    resource: F;
+    fullUrl?: string;
+}
+export interface BatchInputBinaryPatchRequest<F extends FhirResource> extends BatchInputBaseRequest {
+    method: 'PATCH';
+    resource: Binary<F>;
+}
+export interface BatchInputJSONPatchRequest extends BatchInputBaseRequest {
+    method: 'PATCH';
+    operations: Operation[];
+}
+export type BatchInputPatchRequest<F extends FhirResource> = BatchInputBinaryPatchRequest<F> | BatchInputJSONPatchRequest;
+export type BatchInputRequest<F extends FhirResource> = BatchInputGetRequest | BatchInputHeadRequest | BatchInputPutRequest<F> | BatchInputPatchRequest<F> | BatchInputPostRequest<F> | BatchInputDeleteRequest;
+export interface BatchInput<F extends FhirResource> {
+    requests: BatchInputRequest<F>[];
+}
+export {};