@oystehr/sdk 3.0.0

package/src/resources/types/RoleListItem.ts

@@ -0,0 +1,16 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+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/src/resources/types/RoleListResponse.ts

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

package/src/resources/types/RoleStub.ts

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

package/src/resources/types/RoleUpdateParams.ts

@@ -0,0 +1,20 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+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/src/resources/types/RoleUpdateResponse.ts

@@ -0,0 +1,7 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+import { Role } from './Role';
+/**
+ * Role Updated
+ */
+export type RoleUpdateResponse = Role;

package/src/resources/types/Secret.ts

@@ -0,0 +1,12 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+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/src/resources/types/SecretDeleteParams.ts

@@ -0,0 +1,5 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+export interface SecretDeleteParams {
+  name: string;
+}

package/src/resources/types/SecretGetParams.ts

@@ -0,0 +1,5 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+export interface SecretGetParams {
+  name: string;
+}

package/src/resources/types/SecretGetResponse.ts

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

package/src/resources/types/SecretListItem.ts

@@ -0,0 +1,8 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+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/src/resources/types/SecretListResponse.ts

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

package/src/resources/types/SecretSetParams.ts

@@ -0,0 +1,12 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+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/src/resources/types/SecretSetResponse.ts

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

package/src/resources/types/TelemedCreateMeetingParams.ts

@@ -0,0 +1,10 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+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/src/resources/types/TelemedCreateMeetingResponse.ts

@@ -0,0 +1,12 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+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/src/resources/types/TelemedJoinMeetingParams.ts

@@ -0,0 +1,6 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+export interface TelemedJoinMeetingParams {
+  encounterId: string;
+  anonymous?: boolean;
+}

package/src/resources/types/TelemedJoinMeetingResponse.ts

@@ -0,0 +1,29 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+/**
+ * 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/src/resources/types/TransactionalSMSSendParams.ts

@@ -0,0 +1,12 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+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/src/resources/types/TransactionalSMSSendResponse.ts

@@ -0,0 +1,11 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+/**
+ * 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/src/resources/types/User.ts

@@ -0,0 +1,39 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+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/src/resources/types/UserDeleteParams.ts

@@ -0,0 +1,5 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+export interface UserDeleteParams {
+  id: string;
+}

package/src/resources/types/UserGetParams.ts

@@ -0,0 +1,5 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+export interface UserGetParams {
+  id: string;
+}

package/src/resources/types/UserGetResponse.ts

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

package/src/resources/types/UserInviteParams.ts

@@ -0,0 +1,38 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+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/src/resources/types/UserInviteResponse.ts

@@ -0,0 +1,39 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+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/src/resources/types/UserListItem.ts

@@ -0,0 +1,17 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+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/src/resources/types/UserListResponse.ts

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

package/src/resources/types/UserListV2Params.ts

@@ -0,0 +1,13 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+export interface UserListV2Params {
+  name?: string;
+  id?: string;
+  email?: string;
+  profile?: string;
+  roleId?: string;
+  cursor?: string;
+  limit?: number;
+  sort?: string;
+  sortOrder?: string;
+}

package/src/resources/types/UserListV2Response.ts

@@ -0,0 +1,18 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+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/src/resources/types/UserMeResponse.ts

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

package/src/resources/types/UserUpdateParams.ts

@@ -0,0 +1,12 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+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/src/resources/types/UserUpdateResponse.ts

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

package/src/resources/types/VersionGetResponse.ts

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

package/src/resources/types/Z3CreateBucketParams.ts

@@ -0,0 +1,5 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+export interface Z3CreateBucketParams {
+  bucketName: string;
+}

package/src/resources/types/Z3CreateBucketResponse.ts

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

package/src/resources/types/Z3DeleteBucketParams.ts

@@ -0,0 +1,5 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+export interface Z3DeleteBucketParams {
+  bucketName: string;
+}

package/src/resources/types/Z3DeleteObjectParams.ts

@@ -0,0 +1,10 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+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/src/resources/types/Z3GetPresignedUrlParams.ts

@@ -0,0 +1,11 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+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/src/resources/types/Z3GetPresignedUrlResponse.ts

@@ -0,0 +1,11 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+/**
+ * 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/src/resources/types/Z3ListBucketsResponse.ts

@@ -0,0 +1,16 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+/**
+ * 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/src/resources/types/Z3ListObjectsParams.ts

@@ -0,0 +1,6 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+export interface Z3ListObjectsParams {
+  bucketName: string;
+  'objectPath+': string;
+}

package/src/resources/types/Z3ListObjectsResponse.ts

@@ -0,0 +1,15 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+/**
+ * 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/src/resources/types/ZambdaCreateParams.ts

@@ -0,0 +1,15 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+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/src/resources/types/ZambdaCreateResponse.ts

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

package/src/resources/types/ZambdaDeleteParams.ts

@@ -0,0 +1,5 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+export interface ZambdaDeleteParams {
+  id: string;
+}

package/src/resources/types/ZambdaExecuteParams.ts

@@ -0,0 +1,6 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+export interface ZambdaExecuteParams {
+  id: string;
+  [k: string]: any;
+}

package/src/resources/types/ZambdaExecutePublicParams.ts

@@ -0,0 +1,6 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+export interface ZambdaExecutePublicParams {
+  id: string;
+  [k: string]: any;
+}

package/src/resources/types/ZambdaExecutePublicResponse.ts

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