@openmrs/esm-api 3.1.15-pre.701 → 3.1.15-pre.707

package/docs/interfaces/LoggedInUserFetchResponse.md

@@ -1,281 +0,0 @@
-[@openmrs/esm-api](../API.md) / LoggedInUserFetchResponse
-
-# Interface: LoggedInUserFetchResponse
-
-## Hierarchy
-
-- [`FetchResponse`](FetchResponse.md)
-
-  ↳ **`LoggedInUserFetchResponse`**
-
-## Table of contents
-
-### Properties
-
-- [body](LoggedInUserFetchResponse.md#body)
-- [bodyUsed](LoggedInUserFetchResponse.md#bodyused)
-- [data](LoggedInUserFetchResponse.md#data)
-- [headers](LoggedInUserFetchResponse.md#headers)
-- [ok](LoggedInUserFetchResponse.md#ok)
-- [redirected](LoggedInUserFetchResponse.md#redirected)
-- [status](LoggedInUserFetchResponse.md#status)
-- [statusText](LoggedInUserFetchResponse.md#statustext)
-- [type](LoggedInUserFetchResponse.md#type)
-- [url](LoggedInUserFetchResponse.md#url)
-
-### Methods
-
-- [arrayBuffer](LoggedInUserFetchResponse.md#arraybuffer)
-- [blob](LoggedInUserFetchResponse.md#blob)
-- [clone](LoggedInUserFetchResponse.md#clone)
-- [formData](LoggedInUserFetchResponse.md#formdata)
-- [json](LoggedInUserFetchResponse.md#json)
-- [text](LoggedInUserFetchResponse.md#text)
-
-## Properties
-
-### body
-
-• `Readonly` **body**: ``null`` \| `ReadableStream`<`Uint8Array`\>
-
-#### Inherited from
-
-[FetchResponse](FetchResponse.md).[body](FetchResponse.md#body)
-
-#### Defined in
-
-node_modules/typescript/lib/lib.dom.d.ts:2402
-
-___
-
-### bodyUsed
-
-• `Readonly` **bodyUsed**: `boolean`
-
-#### Inherited from
-
-[FetchResponse](FetchResponse.md).[bodyUsed](FetchResponse.md#bodyused)
-
-#### Defined in
-
-node_modules/typescript/lib/lib.dom.d.ts:2403
-
-___
-
-### data
-
-• **data**: [`LoggedInUserData`](../API.md#loggedinuserdata)
-
-#### Overrides
-
-[FetchResponse](FetchResponse.md).[data](FetchResponse.md#data)
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/fetch.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/fetch.ts#L12)
-
-___
-
-### headers
-
-• `Readonly` **headers**: `Headers`
-
-#### Inherited from
-
-[FetchResponse](FetchResponse.md).[headers](FetchResponse.md#headers)
-
-#### Defined in
-
-node_modules/typescript/lib/lib.dom.d.ts:11136
-
-___
-
-### ok
-
-• `Readonly` **ok**: `boolean`
-
-#### Inherited from
-
-[FetchResponse](FetchResponse.md).[ok](FetchResponse.md#ok)
-
-#### Defined in
-
-node_modules/typescript/lib/lib.dom.d.ts:11137
-
-___
-
-### redirected
-
-• `Readonly` **redirected**: `boolean`
-
-#### Inherited from
-
-[FetchResponse](FetchResponse.md).[redirected](FetchResponse.md#redirected)
-
-#### Defined in
-
-node_modules/typescript/lib/lib.dom.d.ts:11138
-
-___
-
-### status
-
-• `Readonly` **status**: `number`
-
-#### Inherited from
-
-[FetchResponse](FetchResponse.md).[status](FetchResponse.md#status)
-
-#### Defined in
-
-node_modules/typescript/lib/lib.dom.d.ts:11139
-
-___
-
-### statusText
-
-• `Readonly` **statusText**: `string`
-
-#### Inherited from
-
-[FetchResponse](FetchResponse.md).[statusText](FetchResponse.md#statustext)
-
-#### Defined in
-
-node_modules/typescript/lib/lib.dom.d.ts:11140
-
-___
-
-### type
-
-• `Readonly` **type**: `ResponseType`
-
-#### Inherited from
-
-[FetchResponse](FetchResponse.md).[type](FetchResponse.md#type)
-
-#### Defined in
-
-node_modules/typescript/lib/lib.dom.d.ts:11141
-
-___
-
-### url
-
-• `Readonly` **url**: `string`
-
-#### Inherited from
-
-[FetchResponse](FetchResponse.md).[url](FetchResponse.md#url)
-
-#### Defined in
-
-node_modules/typescript/lib/lib.dom.d.ts:11142
-
-## Methods
-
-### arrayBuffer
-
-▸ **arrayBuffer**(): `Promise`<`ArrayBuffer`\>
-
-#### Returns
-
-`Promise`<`ArrayBuffer`\>
-
-#### Inherited from
-
-[FetchResponse](FetchResponse.md).[arrayBuffer](FetchResponse.md#arraybuffer)
-
-#### Defined in
-
-node_modules/typescript/lib/lib.dom.d.ts:2404
-
-___
-
-### blob
-
-▸ **blob**(): `Promise`<`Blob`\>
-
-#### Returns
-
-`Promise`<`Blob`\>
-
-#### Inherited from
-
-[FetchResponse](FetchResponse.md).[blob](FetchResponse.md#blob)
-
-#### Defined in
-
-node_modules/typescript/lib/lib.dom.d.ts:2405
-
-___
-
-### clone
-
-▸ **clone**(): `Response`
-
-#### Returns
-
-`Response`
-
-#### Inherited from
-
-[FetchResponse](FetchResponse.md).[clone](FetchResponse.md#clone)
-
-#### Defined in
-
-node_modules/typescript/lib/lib.dom.d.ts:11143
-
-___
-
-### formData
-
-▸ **formData**(): `Promise`<`FormData`\>
-
-#### Returns
-
-`Promise`<`FormData`\>
-
-#### Inherited from
-
-[FetchResponse](FetchResponse.md).[formData](FetchResponse.md#formdata)
-
-#### Defined in
-
-node_modules/typescript/lib/lib.dom.d.ts:2406
-
-___
-
-### json
-
-▸ **json**(): `Promise`<`any`\>
-
-#### Returns
-
-`Promise`<`any`\>
-
-#### Inherited from
-
-[FetchResponse](FetchResponse.md).[json](FetchResponse.md#json)
-
-#### Defined in
-
-node_modules/typescript/lib/lib.dom.d.ts:2407
-
-___
-
-### text
-
-▸ **text**(): `Promise`<`string`\>
-
-#### Returns
-
-`Promise`<`string`\>
-
-#### Inherited from
-
-[FetchResponse](FetchResponse.md).[text](FetchResponse.md#text)
-
-#### Defined in
-
-node_modules/typescript/lib/lib.dom.d.ts:2408

package/docs/interfaces/NewVisitPayload.md

@@ -1,74 +0,0 @@
-[@openmrs/esm-api](../API.md) / NewVisitPayload
-
-# Interface: NewVisitPayload
-
-## Table of contents
-
-### Properties
-
-- [location](NewVisitPayload.md#location)
-- [patient](NewVisitPayload.md#patient)
-- [startDatetime](NewVisitPayload.md#startdatetime)
-- [stopDatetime](NewVisitPayload.md#stopdatetime)
-- [uuid](NewVisitPayload.md#uuid)
-- [visitType](NewVisitPayload.md#visittype)
-
-## Properties
-
-### location
-
-• **location**: `string`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/visit-resource.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L5)
-
-___
-
-### patient
-
-• `Optional` **patient**: `string`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/visit-resource.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L6)
-
-___
-
-### startDatetime
-
-• **startDatetime**: `Date`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/visit-resource.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L7)
-
-___
-
-### stopDatetime
-
-• `Optional` **stopDatetime**: `Date`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/visit-resource.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L9)
-
-___
-
-### uuid
-
-• `Optional` **uuid**: `string`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/visit-resource.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L4)
-
-___
-
-### visitType
-
-• **visitType**: `string`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/visit-resource.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L8)

package/docs/interfaces/OnlyThePatient.md

@@ -1,29 +0,0 @@
-[@openmrs/esm-api](../API.md) / OnlyThePatient
-
-# Interface: OnlyThePatient
-
-## Hierarchy
-
-- [`CurrentPatientOptions`](CurrentPatientOptions.md)
-
-  ↳ **`OnlyThePatient`**
-
-## Table of contents
-
-### Properties
-
-- [includeConfig](OnlyThePatient.md#includeconfig)
-
-## Properties
-
-### includeConfig
-
-• **includeConfig**: ``false``
-
-#### Overrides
-
-[CurrentPatientOptions](CurrentPatientOptions.md).[includeConfig](CurrentPatientOptions.md#includeconfig)
-
-#### Defined in
-
-[packages/framework/esm-api/src/shared-api-objects/current-patient.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-patient.ts#L15)

package/docs/interfaces/OpenmrsResource.md

@@ -1,34 +0,0 @@
-[@openmrs/esm-api](../API.md) / OpenmrsResource
-
-# Interface: OpenmrsResource
-
-## Indexable
-
-▪ [anythingElse: `string`]: `any`
-
-## Table of contents
-
-### Properties
-
-- [display](OpenmrsResource.md#display)
-- [uuid](OpenmrsResource.md#uuid)
-
-## Properties
-
-### display
-
-• `Optional` **display**: `string`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/openmrs-resource.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L3)
-
-___
-
-### uuid
-
-• **uuid**: `string`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/openmrs-resource.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L2)

package/docs/interfaces/PatientWithFullResponse.md

@@ -1,29 +0,0 @@
-[@openmrs/esm-api](../API.md) / PatientWithFullResponse
-
-# Interface: PatientWithFullResponse
-
-## Hierarchy
-
-- [`CurrentPatientOptions`](CurrentPatientOptions.md)
-
-  ↳ **`PatientWithFullResponse`**
-
-## Table of contents
-
-### Properties
-
-- [includeConfig](PatientWithFullResponse.md#includeconfig)
-
-## Properties
-
-### includeConfig
-
-• **includeConfig**: ``true``
-
-#### Overrides
-
-[CurrentPatientOptions](CurrentPatientOptions.md).[includeConfig](CurrentPatientOptions.md#includeconfig)
-
-#### Defined in
-
-[packages/framework/esm-api/src/shared-api-objects/current-patient.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-patient.ts#L11)

package/docs/interfaces/Person.md

@@ -1,41 +0,0 @@
-[@openmrs/esm-api](../API.md) / Person
-
-# Interface: Person
-
-## Table of contents
-
-### Properties
-
-- [display](Person.md#display)
-- [links](Person.md#links)
-- [uuid](Person.md#uuid)
-
-## Properties
-
-### display
-
-• **display**: `string`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/user-resource.ts:43](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L43)
-
-___
-
-### links
-
-• **links**: `any`[]
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/user-resource.ts:44](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L44)
-
-___
-
-### uuid
-
-• **uuid**: `string`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/user-resource.ts:42](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L42)

package/docs/interfaces/Privilege.md

@@ -1,41 +0,0 @@
-[@openmrs/esm-api](../API.md) / Privilege
-
-# Interface: Privilege
-
-## Table of contents
-
-### Properties
-
-- [display](Privilege.md#display)
-- [links](Privilege.md#links)
-- [uuid](Privilege.md#uuid)
-
-## Properties
-
-### display
-
-• **display**: `string`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/user-resource.ts:49](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L49)
-
-___
-
-### links
-
-• **links**: `any`[]
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/user-resource.ts:50](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L50)
-
-___
-
-### uuid
-
-• **uuid**: `string`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/user-resource.ts:48](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L48)

package/docs/interfaces/Role.md

@@ -1,41 +0,0 @@
-[@openmrs/esm-api](../API.md) / Role
-
-# Interface: Role
-
-## Table of contents
-
-### Properties
-
-- [display](Role.md#display)
-- [links](Role.md#links)
-- [uuid](Role.md#uuid)
-
-## Properties
-
-### display
-
-• **display**: `string`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/user-resource.ts:55](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L55)
-
-___
-
-### links
-
-• **links**: `any`[]
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/user-resource.ts:56](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L56)
-
-___
-
-### uuid
-
-• **uuid**: `string`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/user-resource.ts:54](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L54)

package/docs/interfaces/SessionLocation.md

@@ -1,41 +0,0 @@
-[@openmrs/esm-api](../API.md) / SessionLocation
-
-# Interface: SessionLocation
-
-## Table of contents
-
-### Properties
-
-- [display](SessionLocation.md#display)
-- [links](SessionLocation.md#links)
-- [uuid](SessionLocation.md#uuid)
-
-## Properties
-
-### display
-
-• **display**: `string`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/user-resource.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L37)
-
-___
-
-### links
-
-• **links**: `any`[]
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/user-resource.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L38)
-
-___
-
-### uuid
-
-• **uuid**: `string`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/user-resource.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L36)

package/docs/interfaces/SessionUser.md

@@ -1,92 +0,0 @@
-[@openmrs/esm-api](../API.md) / SessionUser
-
-# Interface: SessionUser
-
-## Table of contents
-
-### Properties
-
-- [allowedLocales](SessionUser.md#allowedlocales)
-- [authenticated](SessionUser.md#authenticated)
-- [currentProvider](SessionUser.md#currentprovider)
-- [locale](SessionUser.md#locale)
-- [sessionId](SessionUser.md#sessionid)
-- [sessionLocation](SessionUser.md#sessionlocation)
-- [user](SessionUser.md#user)
-
-## Properties
-
-### allowedLocales
-
-• **allowedLocales**: `string`[]
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/openmrs-resource.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L8)
-
-___
-
-### authenticated
-
-• **authenticated**: `boolean`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/openmrs-resource.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L9)
-
-___
-
-### currentProvider
-
-• **currentProvider**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `identifier` | `string` |
-| `uuid` | `string` |
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/openmrs-resource.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L13)
-
-___
-
-### locale
-
-• **locale**: `string`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/openmrs-resource.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L10)
-
-___
-
-### sessionId
-
-• **sessionId**: `string`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/openmrs-resource.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L11)
-
-___
-
-### sessionLocation
-
-• **sessionLocation**: `any`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/openmrs-resource.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L14)
-
-___
-
-### user
-
-• **user**: [`User`](User.md)
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/openmrs-resource.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L12)