@oystehr/sdk 3.0.0

package/dist/cjs/resources/types/RcmValidateProfessionalClaimParams.d.ts

@@ -0,0 +1,6 @@
+import { ClaimCMS1500 } from './ClaimCMS1500';
+export interface RcmValidateProfessionalClaimParams {
+    cms1500: ClaimCMS1500;
+    submitterOrganizationName: string;
+    payerId: string;
+}

package/dist/cjs/resources/types/RcmValidateProfessionalClaimResponse.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Claim validation result.
+ */
+export interface RcmValidateProfessionalClaimResponse {
+    errors?: {
+        field?: string;
+        value?: string;
+        code?: string;
+        description?: string;
+        followupAction?: string;
+        location?: string;
+    }[];
+    meta?: {
+        submitterId?: string;
+        senderId?: string;
+        billerId?: string;
+        traceId?: string;
+        applicationMode?: string;
+    };
+    editStatus?: string;
+}

package/dist/cjs/resources/types/Role.d.ts

@@ -0,0 +1,16 @@
+import { AccessPolicy } from './AccessPolicy';
+export interface Role {
+    /**
+     * The unique id of the role
+     */
+    id: string;
+    /**
+     * The name of the role.
+     */
+    name: string;
+    /**
+     * A description of the Role to help you differentiate it from other Roles in the project.
+     */
+    description?: string;
+    accessPolicy: AccessPolicy;
+}

package/dist/cjs/resources/types/RoleCreateParams.d.ts

@@ -0,0 +1,12 @@
+import { AccessPolicy } from './AccessPolicy';
+export interface RoleCreateParams {
+    /**
+     * The name of the role.
+     */
+    name: string;
+    /**
+     * A description of the Role to help you differentiate it from other Roles in the project.
+     */
+    description?: string;
+    accessPolicy?: AccessPolicy;
+}

package/dist/cjs/resources/types/RoleCreateResponse.d.ts

@@ -0,0 +1,5 @@
+import { Role } from './Role';
+/**
+ * Successfully created a new role.
+ */
+export type RoleCreateResponse = Role;

package/dist/cjs/resources/types/RoleDeleteParams.d.ts

@@ -0,0 +1,3 @@
+export interface RoleDeleteParams {
+    roleId: string;
+}

package/dist/cjs/resources/types/RoleGetParams.d.ts

@@ -0,0 +1,3 @@
+export interface RoleGetParams {
+    roleId: string;
+}

package/dist/cjs/resources/types/RoleGetResponse.d.ts

@@ -0,0 +1,5 @@
+import { Role } from './Role';
+/**
+ * Role with a map of Users, Developers, and M2M Clients assigned the Role.
+ */
+export type RoleGetResponse = Role;

package/dist/cjs/resources/types/RoleListItem.d.ts

@@ -0,0 +1,14 @@
+export interface RoleListItem {
+    /**
+     * The unique id of the role
+     */
+    id: string;
+    /**
+     * The name of the role.
+     */
+    name: string;
+    /**
+     * The number of users, developers, and M2M Clients that have this role.
+     */
+    memberCount: number;
+}

package/dist/cjs/resources/types/RoleListResponse.d.ts

@@ -0,0 +1,5 @@
+import { RoleListItem } from './RoleListItem';
+/**
+ * List of all Roles in the project.
+ */
+export type RoleListResponse = RoleListItem[];

package/dist/cjs/resources/types/RoleStub.d.ts

@@ -0,0 +1,10 @@
+export interface RoleStub {
+    /**
+     * The unique id of the role
+     */
+    id: string;
+    /**
+     * The name of the role.
+     */
+    name: string;
+}

package/dist/cjs/resources/types/RoleUpdateParams.d.ts

@@ -0,0 +1,17 @@
+import { AccessPolicy } from './AccessPolicy';
+export interface RoleUpdateParams {
+    /**
+     * The unique id of the role
+     */
+    id?: string;
+    /**
+     * The name of the role.
+     */
+    name?: string;
+    /**
+     * A description of the Role to help you differentiate it from other Roles in the project.
+     */
+    description?: string;
+    accessPolicy?: AccessPolicy;
+    roleId: string;
+}

package/dist/cjs/resources/types/RoleUpdateResponse.d.ts

@@ -0,0 +1,5 @@
+import { Role } from './Role';
+/**
+ * Role Updated
+ */
+export type RoleUpdateResponse = Role;

package/dist/cjs/resources/types/Secret.d.ts

@@ -0,0 +1,10 @@
+export interface Secret {
+    /**
+     * A name for the secret used to identify it for use in Zambda Functions. May contain letters, numbers, dashes, and underscores.
+     */
+    name: string;
+    /**
+     * The secret value. Common examples include M2M Client credentials used to call Oystehr APIs, and third-party API keys used to integrate with external systems.
+     */
+    value: string;
+}

package/dist/cjs/resources/types/SecretDeleteParams.d.ts

@@ -0,0 +1,3 @@
+export interface SecretDeleteParams {
+    name: string;
+}

package/dist/cjs/resources/types/SecretGetParams.d.ts

@@ -0,0 +1,3 @@
+export interface SecretGetParams {
+    name: string;
+}

package/dist/cjs/resources/types/SecretGetResponse.d.ts

@@ -0,0 +1,5 @@
+import { Secret } from './Secret';
+/**
+ * The secret was fetched successfully.
+ */
+export type SecretGetResponse = Secret;

package/dist/cjs/resources/types/SecretListItem.d.ts

@@ -0,0 +1,6 @@
+export interface SecretListItem {
+    /**
+     * A name for the secret used to identify it for use in Zambda Functions. May contain letters, numbers, dashes, and underscores.
+     */
+    name: string;
+}

package/dist/cjs/resources/types/SecretListResponse.d.ts

@@ -0,0 +1,5 @@
+import { SecretListItem } from './SecretListItem';
+/**
+ * List of all Secrets in the project.
+ */
+export type SecretListResponse = SecretListItem[];

package/dist/cjs/resources/types/SecretSetParams.d.ts

@@ -0,0 +1,10 @@
+export interface SecretSetParams {
+    /**
+     * A name for the secret used to identify it for use in Zambda Functions. May contain letters, numbers, dashes, and underscores.
+     */
+    name: string;
+    /**
+     * The secret value. Common examples include M2M Client credentials used to call Oystehr APIs, and third-party API keys used to integrate with external systems.
+     */
+    value: string;
+}

package/dist/cjs/resources/types/SecretSetResponse.d.ts

@@ -0,0 +1,5 @@
+import { Secret } from './Secret';
+/**
+ * Secret created, or if secret is already defined, secret is updated.
+ */
+export type SecretSetResponse = Secret;

package/dist/cjs/resources/types/TelemedCreateMeetingParams.d.ts

@@ -0,0 +1,7 @@
+import { Encounter } from 'fhir/r4b';
+export interface TelemedCreateMeetingParams {
+    /**
+     * Well formed Encounter with the https://extensions.fhir.zapehr.com/encounter-other-participants extension specified optionally.
+     */
+    encounter?: Encounter;
+}

package/dist/cjs/resources/types/TelemedCreateMeetingResponse.d.ts

@@ -0,0 +1,10 @@
+import { Encounter } from 'fhir/r4b';
+/**
+ * Successfully created a telemed meeting.
+ */
+export interface TelemedCreateMeetingResponse {
+    /**
+     * Returns well formed Encounter with video meeting information in the https://extensions.fhir.zapehr.com/encounter-virtual-service-pre-release extension.
+     */
+    encounter?: Encounter;
+}

package/dist/cjs/resources/types/TelemedJoinMeetingParams.d.ts

@@ -0,0 +1,4 @@
+export interface TelemedJoinMeetingParams {
+    encounterId: string;
+    anonymous?: boolean;
+}

package/dist/cjs/resources/types/TelemedJoinMeetingResponse.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Meeting and Attendee objects for joining a video meeting returned successfully.
+ */
+export interface TelemedJoinMeetingResponse {
+    /**
+     * The attendee object including details like AttendeeId and ExternalUserId.
+     */
+    Attendee?: {
+        /**
+         * Unique identifier for the attendee.
+         */
+        AttendeeId?: string;
+        /**
+         * External user identifier used to map to the attendee.
+         */
+        ExternalUserId?: string;
+    };
+    /**
+     * The meeting object including details necessary for joining the meeting.
+     */
+    Meeting?: {
+        /**
+         * Unique identifier for the meeting.
+         */
+        MeetingId?: string;
+    };
+}

package/dist/cjs/resources/types/TransactionalSMSSendParams.d.ts

@@ -0,0 +1,10 @@
+export interface TransactionalSMSSendParams {
+    /**
+     * A reference to a FHIR Patient, RelatedPerson, or Practitioner resource in the format: `Patient/some-uuid`, `RelatedPerson/some-uuid`, or `Practitioner/some-uuid`.
+     */
+    resource: string;
+    /**
+     * The message to send. Messages over 160 characters will be split into multiple SMS messages.
+     */
+    message: string;
+}

package/dist/cjs/resources/types/TransactionalSMSSendResponse.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Successfully created a send message request. Note that this does not mean the message was sent successfully; there may be a reason the message is not sent.
+ */
+export interface TransactionalSMSSendResponse {
+    /**
+     * The UUID of the FHIR Communication resource that represents the message
+     */
+    resourceId?: string;
+}

package/dist/cjs/resources/types/User.d.ts

@@ -0,0 +1,36 @@
+import { AccessPolicy } from './AccessPolicy';
+import { RoleStub } from './RoleStub';
+export interface User {
+    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;
+    /**
+     * 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;
+    };
+    /**
+     * 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[];
+}

package/dist/cjs/resources/types/UserDeleteParams.d.ts

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

package/dist/cjs/resources/types/UserGetParams.d.ts

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

package/dist/cjs/resources/types/UserGetResponse.d.ts

@@ -0,0 +1,5 @@
+import { User } from './User';
+/**
+ * Information about a specific user
+ */
+export type UserGetResponse = User;

package/dist/cjs/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/cjs/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/cjs/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/cjs/resources/types/UserListResponse.d.ts

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

package/dist/cjs/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/cjs/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/cjs/resources/types/UserMeResponse.d.ts

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

package/dist/cjs/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/cjs/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/cjs/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/cjs/resources/types/Z3CreateBucketParams.d.ts

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

package/dist/cjs/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/cjs/resources/types/Z3DeleteBucketParams.d.ts

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

package/dist/cjs/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/cjs/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/cjs/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/cjs/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/cjs/resources/types/Z3ListObjectsParams.d.ts

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

package/dist/cjs/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/cjs/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/cjs/resources/types/ZambdaCreateResponse.d.ts

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

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

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

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

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

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

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

package/dist/cjs/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;