@oystehr/sdk 3.0.7 → 3.0.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -5
- package/dist/cjs/index.cjs +278 -233
- package/dist/cjs/index.cjs.map +1 -1
- package/dist/cjs/index.min.cjs +1 -1
- package/dist/cjs/index.min.cjs.map +1 -1
- package/dist/cjs/resources/classes/application.d.ts +6 -6
- package/dist/cjs/resources/classes/charge.d.ts +1 -1
- package/dist/cjs/resources/classes/conversation.d.ts +6 -6
- package/dist/cjs/resources/classes/developer.d.ts +14 -7
- package/dist/cjs/resources/classes/erx.d.ts +9 -1
- package/dist/cjs/resources/classes/fax.d.ts +4 -4
- package/dist/cjs/resources/classes/fhir.d.ts +1 -1
- package/dist/cjs/resources/classes/m2m.d.ts +15 -8
- package/dist/cjs/resources/classes/messaging.d.ts +1 -1
- package/dist/cjs/resources/classes/paymentMethod.d.ts +1 -1
- package/dist/cjs/resources/classes/project.d.ts +10 -3
- package/dist/cjs/resources/classes/rcm.d.ts +4 -4
- package/dist/cjs/resources/classes/role.d.ts +6 -6
- package/dist/cjs/resources/classes/secret.d.ts +1 -1
- package/dist/cjs/resources/classes/telemed.d.ts +2 -2
- package/dist/cjs/resources/classes/transactionalSMS.d.ts +2 -2
- package/dist/cjs/resources/classes/user.d.ts +15 -8
- package/dist/cjs/resources/classes/version.d.ts +1 -1
- package/dist/cjs/resources/classes/z3.d.ts +8 -8
- package/dist/cjs/resources/classes/zambda.d.ts +9 -9
- package/dist/cjs/resources/classes/zambdaLogStream.d.ts +4 -4
- package/dist/cjs/resources/types/AccessPolicy.d.ts +8 -3
- package/dist/cjs/resources/types/ApplicationCreateParams.d.ts +0 -5
- package/dist/cjs/resources/types/ApplicationUpdateParams.d.ts +0 -4
- package/dist/cjs/resources/types/ChargeIssueParams.d.ts +1 -1
- package/dist/cjs/resources/types/ChargeStatusParams.d.ts +1 -1
- package/dist/cjs/resources/types/DeveloperListV2Params.d.ts +2 -2
- package/dist/cjs/resources/types/FaxSendParams.d.ts +1 -1
- package/dist/cjs/resources/types/M2mListV2Params.d.ts +2 -2
- package/dist/cjs/resources/types/M2mRotateSecretResponse.d.ts +1 -1
- package/dist/cjs/resources/types/RcmEligibilityCheckParams.d.ts +1 -1
- package/dist/cjs/resources/types/RoleUpdateParams.d.ts +0 -4
- package/dist/cjs/resources/types/TelemedCreateMeetingParams.d.ts +1 -1
- package/dist/cjs/resources/types/UserListV2Params.d.ts +2 -2
- package/dist/cjs/resources/types/ZambdaCreateParams.d.ts +1 -1
- package/dist/cjs/resources/types/ZambdaFunction.d.ts +1 -1
- package/dist/cjs/resources/types/ZambdaUpdateParams.d.ts +2 -2
- package/dist/esm/index.min.js +1 -1
- package/dist/esm/index.min.js.map +1 -1
- package/dist/esm/resources/classes/application.d.ts +6 -6
- package/dist/esm/resources/classes/application.js +20 -17
- package/dist/esm/resources/classes/application.js.map +1 -1
- package/dist/esm/resources/classes/charge.d.ts +1 -1
- package/dist/esm/resources/classes/charge.js +9 -6
- package/dist/esm/resources/classes/charge.js.map +1 -1
- package/dist/esm/resources/classes/conversation.d.ts +6 -6
- package/dist/esm/resources/classes/conversation.js +17 -14
- package/dist/esm/resources/classes/conversation.js.map +1 -1
- package/dist/esm/resources/classes/developer.d.ts +14 -7
- package/dist/esm/resources/classes/developer.js +19 -16
- package/dist/esm/resources/classes/developer.js.map +1 -1
- package/dist/esm/resources/classes/erx.d.ts +9 -1
- package/dist/esm/resources/classes/erx.js +13 -10
- package/dist/esm/resources/classes/erx.js.map +1 -1
- package/dist/esm/resources/classes/fax.d.ts +4 -4
- package/dist/esm/resources/classes/fax.js +13 -10
- package/dist/esm/resources/classes/fax.js.map +1 -1
- package/dist/esm/resources/classes/fhir.d.ts +1 -1
- package/dist/esm/resources/classes/fhir.js +3 -4
- package/dist/esm/resources/classes/fhir.js.map +1 -1
- package/dist/esm/resources/classes/index.js +2 -2
- package/dist/esm/resources/classes/index.js.map +1 -1
- package/dist/esm/resources/classes/m2m.d.ts +15 -8
- package/dist/esm/resources/classes/m2m.js +21 -18
- package/dist/esm/resources/classes/m2m.js.map +1 -1
- package/dist/esm/resources/classes/messaging.d.ts +1 -1
- package/dist/esm/resources/classes/messaging.js +8 -5
- package/dist/esm/resources/classes/messaging.js.map +1 -1
- package/dist/esm/resources/classes/paymentMethod.d.ts +1 -1
- package/dist/esm/resources/classes/paymentMethod.js +11 -8
- package/dist/esm/resources/classes/paymentMethod.js.map +1 -1
- package/dist/esm/resources/classes/project.d.ts +10 -3
- package/dist/esm/resources/classes/project.js +11 -8
- package/dist/esm/resources/classes/project.js.map +1 -1
- package/dist/esm/resources/classes/rcm.d.ts +4 -4
- package/dist/esm/resources/classes/rcm.js +13 -10
- package/dist/esm/resources/classes/rcm.js.map +1 -1
- package/dist/esm/resources/classes/role.d.ts +6 -6
- package/dist/esm/resources/classes/role.js +17 -14
- package/dist/esm/resources/classes/role.js.map +1 -1
- package/dist/esm/resources/classes/secret.d.ts +1 -1
- package/dist/esm/resources/classes/secret.js +11 -8
- package/dist/esm/resources/classes/secret.js.map +1 -1
- package/dist/esm/resources/classes/telemed.d.ts +2 -2
- package/dist/esm/resources/classes/telemed.js +10 -7
- package/dist/esm/resources/classes/telemed.js.map +1 -1
- package/dist/esm/resources/classes/transactionalSMS.d.ts +2 -2
- package/dist/esm/resources/classes/transactionalSMS.js +9 -6
- package/dist/esm/resources/classes/transactionalSMS.js.map +1 -1
- package/dist/esm/resources/classes/user.d.ts +15 -8
- package/dist/esm/resources/classes/user.js +21 -18
- package/dist/esm/resources/classes/user.js.map +1 -1
- package/dist/esm/resources/classes/version.d.ts +1 -1
- package/dist/esm/resources/classes/version.js +8 -5
- package/dist/esm/resources/classes/version.js.map +1 -1
- package/dist/esm/resources/classes/z3.d.ts +8 -8
- package/dist/esm/resources/classes/z3.js +20 -17
- package/dist/esm/resources/classes/z3.js.map +1 -1
- package/dist/esm/resources/classes/zambda.d.ts +9 -9
- package/dist/esm/resources/classes/zambda.js +23 -20
- package/dist/esm/resources/classes/zambda.js.map +1 -1
- package/dist/esm/resources/classes/zambdaLogStream.d.ts +4 -4
- package/dist/esm/resources/classes/zambdaLogStream.js +13 -10
- package/dist/esm/resources/classes/zambdaLogStream.js.map +1 -1
- package/dist/esm/resources/types/AccessPolicy.d.ts +8 -3
- package/dist/esm/resources/types/ApplicationCreateParams.d.ts +0 -5
- package/dist/esm/resources/types/ApplicationUpdateParams.d.ts +0 -4
- package/dist/esm/resources/types/ChargeIssueParams.d.ts +1 -1
- package/dist/esm/resources/types/ChargeStatusParams.d.ts +1 -1
- package/dist/esm/resources/types/DeveloperListV2Params.d.ts +2 -2
- package/dist/esm/resources/types/FaxSendParams.d.ts +1 -1
- package/dist/esm/resources/types/M2mListV2Params.d.ts +2 -2
- package/dist/esm/resources/types/M2mRotateSecretResponse.d.ts +1 -1
- package/dist/esm/resources/types/RcmEligibilityCheckParams.d.ts +1 -1
- package/dist/esm/resources/types/RoleUpdateParams.d.ts +0 -4
- package/dist/esm/resources/types/TelemedCreateMeetingParams.d.ts +1 -1
- package/dist/esm/resources/types/UserListV2Params.d.ts +2 -2
- package/dist/esm/resources/types/ZambdaCreateParams.d.ts +1 -1
- package/dist/esm/resources/types/ZambdaFunction.d.ts +1 -1
- package/dist/esm/resources/types/ZambdaUpdateParams.d.ts +2 -2
- package/package.json +1 -1
- package/src/resources/classes/application.ts +18 -14
- package/src/resources/classes/charge.ts +3 -3
- package/src/resources/classes/conversation.ts +11 -11
- package/src/resources/classes/developer.ts +31 -14
- package/src/resources/classes/erx.ts +29 -7
- package/src/resources/classes/fax.ts +7 -7
- package/src/resources/classes/fhir.ts +1 -1
- package/src/resources/classes/index.ts +2 -2
- package/src/resources/classes/m2m.ts +30 -16
- package/src/resources/classes/messaging.ts +2 -2
- package/src/resources/classes/paymentMethod.ts +5 -5
- package/src/resources/classes/project.ts +23 -6
- package/src/resources/classes/rcm.ts +7 -7
- package/src/resources/classes/role.ts +11 -11
- package/src/resources/classes/secret.ts +5 -5
- package/src/resources/classes/telemed.ts +8 -4
- package/src/resources/classes/transactionalSMS.ts +3 -3
- package/src/resources/classes/user.ts +33 -16
- package/src/resources/classes/version.ts +2 -2
- package/src/resources/classes/z3.ts +14 -14
- package/src/resources/classes/zambda.ts +17 -17
- package/src/resources/classes/zambdaLogStream.ts +7 -7
- package/src/resources/types/AccessPolicy.ts +12 -3
- package/src/resources/types/ApplicationCreateParams.ts +0 -5
- package/src/resources/types/ApplicationUpdateParams.ts +0 -4
- package/src/resources/types/ChargeIssueParams.ts +1 -1
- package/src/resources/types/ChargeStatusParams.ts +1 -1
- package/src/resources/types/DeveloperListV2Params.ts +2 -2
- package/src/resources/types/FaxSendParams.ts +1 -1
- package/src/resources/types/M2mListV2Params.ts +2 -2
- package/src/resources/types/M2mRotateSecretResponse.ts +1 -1
- package/src/resources/types/RcmEligibilityCheckParams.ts +1 -1
- package/src/resources/types/RoleUpdateParams.ts +0 -4
- package/src/resources/types/TelemedCreateMeetingParams.ts +1 -1
- package/src/resources/types/UserListV2Params.ts +2 -2
- package/src/resources/types/ZambdaCreateParams.ts +1 -1
- package/src/resources/types/ZambdaFunction.ts +1 -1
- package/src/resources/types/ZambdaUpdateParams.ts +2 -2
- package/dist/esm/node_modules/tslib/package.json +0 -1
- package/dist/esm/node_modules/tslib/tslib.es6.js +0 -34
- package/dist/esm/node_modules/tslib/tslib.es6.js.map +0 -1
package/README.md
CHANGED
|
@@ -46,7 +46,7 @@ npm install @oystehr/sdk
|
|
|
46
46
|
## Usage
|
|
47
47
|
|
|
48
48
|
1. Import the SDK.
|
|
49
|
-
2. Initialize the SDK with
|
|
49
|
+
2. Initialize the SDK with a Oystehr access token. ([Learn how to get an access token](https://docs.oystehr.com/oystehr/core-documentation/authenticating-api-requests)).
|
|
50
50
|
3. Invoke any of Oystehr's APIs with a function call.
|
|
51
51
|
|
|
52
52
|
```typescript filename="Example of using the SDK"
|
|
@@ -235,9 +235,9 @@ const patients/*: Patient[]*/ = patientBundle.unbundle();
|
|
|
235
235
|
|
|
236
236
|
### Batch Requests
|
|
237
237
|
|
|
238
|
-
The Oystehr FHIR service supports two kinds of [batch requests](https://docs.oystehr.com/services/fhir/batch-transaction/): batch and transaction. In the SDK, the syntax to use these is the same.
|
|
238
|
+
The Oystehr FHIR service supports two kinds of [batch requests](https://docs.oystehr.com/oystehr/services/fhir/batch-transaction/): batch and transaction. In the SDK, the syntax to use these is the same.
|
|
239
239
|
|
|
240
|
-
PATCH requests [behave differently in batch requests](https://docs.oystehr.com/services/fhir/batch-transaction#patch). The Oystehr SDK allows you to pass either pre-encoded `Binary` resources or JSON Patch operations directly.
|
|
240
|
+
PATCH requests [behave differently in batch requests](https://docs.oystehr.com/oystehr/services/fhir/batch-transaction#patch). The Oystehr SDK allows you to pass either pre-encoded `Binary` resources or JSON Patch operations directly.
|
|
241
241
|
|
|
242
242
|
Here's an example of a transaction that patches an appointment and then retrieves a list of today's appointments:
|
|
243
243
|
|
|
@@ -313,7 +313,7 @@ const updatedPatient = await oystehr.fhir.update<Patient>({
|
|
|
313
313
|
|
|
314
314
|
### Z3
|
|
315
315
|
|
|
316
|
-
Under the hood, uploading and downloading files with [Z3](/services/z3) is a two-step process:
|
|
316
|
+
Under the hood, uploading and downloading files with [Z3](/oystehr/services/z3) is a two-step process:
|
|
317
317
|
|
|
318
318
|
1. Create a presigned URL to upload or download the file ([API Reference](https://api-reference.oystehr.com/reference/post_z3-bucketname-objectpath)).
|
|
319
319
|
2. Upload or download the file using the presigned URL.
|
|
@@ -348,7 +348,7 @@ Uploading code for your Zambda Functions is very similar to uploading a file wit
|
|
|
348
348
|
|
|
349
349
|
## Migration Guide
|
|
350
350
|
|
|
351
|
-
If you have questions about migrating to a new version of the Oystehr SDK, check out our [migration guide](https://docs.oystehr.com/core-documentation/typescript-sdk/migration-guide).
|
|
351
|
+
If you have questions about migrating to a new version of the Oystehr SDK, check out our [migration guide](https://docs.oystehr.com/oystehr/core-documentation/typescript-sdk/migration-guide).
|
|
352
352
|
|
|
353
353
|
## Contact
|
|
354
354
|
|