@awell-health/awell-extensions 2.0.65 → 2.0.67

Sign up to get free protection for your applications and to get access to all the features.
Files changed (66) hide show
  1. package/dist/extensions/bland/actions/index.d.ts +52 -0
  2. package/dist/extensions/bland/actions/index.js +10 -0
  3. package/dist/extensions/bland/actions/index.js.map +1 -0
  4. package/dist/extensions/bland/actions/sendCall/config/dataPoints.d.ts +10 -0
  5. package/dist/extensions/bland/actions/sendCall/config/dataPoints.js +14 -0
  6. package/dist/extensions/bland/actions/sendCall/config/dataPoints.js.map +1 -0
  7. package/dist/extensions/bland/actions/sendCall/config/fields.d.ts +29 -0
  8. package/dist/extensions/bland/actions/sendCall/config/fields.js +30 -0
  9. package/dist/extensions/bland/actions/sendCall/config/fields.js.map +1 -0
  10. package/dist/extensions/bland/actions/sendCall/config/index.d.ts +2 -0
  11. package/dist/extensions/bland/actions/sendCall/config/index.js +9 -0
  12. package/dist/extensions/bland/actions/sendCall/config/index.js.map +1 -0
  13. package/dist/extensions/bland/actions/sendCall/index.d.ts +1 -0
  14. package/dist/extensions/bland/actions/sendCall/index.js +18 -0
  15. package/dist/extensions/bland/actions/sendCall/index.js.map +1 -0
  16. package/dist/extensions/bland/actions/sendCall/sendCall.d.ts +4 -0
  17. package/dist/extensions/bland/actions/sendCall/sendCall.js +38 -0
  18. package/dist/extensions/bland/actions/sendCall/sendCall.js.map +1 -0
  19. package/dist/extensions/bland/actions/sendCallWithPathway/config/dataPoints.d.ts +10 -0
  20. package/dist/extensions/bland/actions/sendCallWithPathway/config/dataPoints.js +14 -0
  21. package/dist/extensions/bland/actions/sendCallWithPathway/config/dataPoints.js.map +1 -0
  22. package/dist/extensions/bland/actions/sendCallWithPathway/config/fields.d.ts +29 -0
  23. package/dist/extensions/bland/actions/sendCallWithPathway/config/fields.js +30 -0
  24. package/dist/extensions/bland/actions/sendCallWithPathway/config/fields.js.map +1 -0
  25. package/dist/extensions/bland/actions/sendCallWithPathway/config/index.d.ts +2 -0
  26. package/dist/extensions/bland/actions/sendCallWithPathway/config/index.js +9 -0
  27. package/dist/extensions/bland/actions/sendCallWithPathway/config/index.js.map +1 -0
  28. package/dist/extensions/bland/actions/sendCallWithPathway/index.d.ts +1 -0
  29. package/dist/extensions/bland/actions/sendCallWithPathway/index.js +18 -0
  30. package/dist/extensions/bland/actions/sendCallWithPathway/index.js.map +1 -0
  31. package/dist/extensions/bland/actions/sendCallWithPathway/sendCallWithPathway.d.ts +4 -0
  32. package/dist/extensions/bland/actions/sendCallWithPathway/sendCallWithPathway.js +39 -0
  33. package/dist/extensions/bland/actions/sendCallWithPathway/sendCallWithPathway.js.map +1 -0
  34. package/dist/extensions/bland/api/client.d.ts +10 -0
  35. package/dist/extensions/bland/api/client.js +24 -0
  36. package/dist/extensions/bland/api/client.js.map +1 -0
  37. package/dist/extensions/bland/api/schema/SendCall.schema.d.ts +132 -0
  38. package/dist/extensions/bland/api/schema/SendCall.schema.js +50 -0
  39. package/dist/extensions/bland/api/schema/SendCall.schema.js.map +1 -0
  40. package/dist/extensions/bland/api/schema/index.d.ts +1 -0
  41. package/dist/extensions/bland/api/schema/index.js +18 -0
  42. package/dist/extensions/bland/api/schema/index.js.map +1 -0
  43. package/dist/extensions/bland/index.d.ts +2 -0
  44. package/dist/extensions/bland/index.js +19 -0
  45. package/dist/extensions/bland/index.js.map +1 -0
  46. package/dist/extensions/bland/lib/validatePayloadAndCreateSdk.d.ts +18 -0
  47. package/dist/extensions/bland/lib/validatePayloadAndCreateSdk.js +34 -0
  48. package/dist/extensions/bland/lib/validatePayloadAndCreateSdk.js.map +1 -0
  49. package/dist/extensions/bland/settings.d.ts +17 -0
  50. package/dist/extensions/bland/settings.js +17 -0
  51. package/dist/extensions/bland/settings.js.map +1 -0
  52. package/dist/extensions/calDotCom/actions/createBooking/config/fields.d.ts +2 -2
  53. package/dist/extensions/calDotCom/schema.d.ts +18 -18
  54. package/dist/extensions/calendly/schema.d.ts +46 -46
  55. package/dist/extensions/elation/validation/appointment.zod.d.ts +2 -2
  56. package/dist/extensions/gridspace/actions/callWithGrace/config.d.ts +2 -2
  57. package/dist/extensions/healthie/actions/createAppointment/config/fields.d.ts +1 -1
  58. package/dist/extensions/healthie/actions/index.d.ts +1 -1
  59. package/dist/extensions/hubspot/actions/sendEmailWithSmtp/config/fields.d.ts +2 -2
  60. package/dist/extensions/hubspot/lib/smtpApi/smtp.schema.d.ts +2 -2
  61. package/dist/extensions/index.js +2 -0
  62. package/dist/extensions/index.js.map +1 -1
  63. package/dist/extensions/markdown.json +4 -0
  64. package/dist/extensions/textline/client/schema.d.ts +10 -10
  65. package/dist/extensions/twilio/v2/actions/getMessages/config/fields.d.ts +2 -2
  66. package/package.json +1 -1
@@ -7,6 +7,10 @@
7
7
  "readme": "---\ntitle: Awell Workflow\ndescription: Enrich your care flows with powerful Awell actions.\n---\n\n# Awell API extension\n\n## Extension settings\n\nYou will need to provide the [API URL](https://developers.awellhealth.com/awell-orchestration/api-reference/overview/endpoints) and an [API key](https://developers.awellhealth.com/awell-orchestration/api-reference/overview/authorization).\n\n## Custom Actions\n\n### Start care flow\n\nStarts a new care flow for the patient enrolled in your current care flow.\n\n**Passing baseline info:**\nPlease read the documentation on [our developer hub](https://developers.awellhealth.com/awell-orchestration/api-reference/mutations/start-pathway) to learn more about how to pass baseline info.\n\n**Example of how to configure a value for the baseline info action field:**\n\n```json\n[\n {\n \"data_point_definition_id\": \"age\",\n \"value\": \"29\"\n },\n {\n \"data_point_definition_id\": \"dob\",\n \"value\": \"1993-11-30\"\n }\n]\n```\n\n### Stop care flow\n\nStops the care flow the patient is currently enrolled in. A reason is why you are stopping the care flow is mandatory.\n\n### Update patient\n\nAllows updating patient data for the patient currently enrolled in the care flow.\n\n### Is patient already enrolled in care flow\n\nChecks whether the patient is already enrolled in a care flow definition. The care flow the patient is currently enrolled in does not count and is excluded from the results.\n\n**Action fields:**\n\n- pathwayStatus: a comma-separated string of care flow statuses that will be used when looking for care flows the patient is already enrolled in. By default, we only look at active care flows. Options: \"active\", \"completed\", \"missing_baseline_info\", \"starting\", and \"stopped\".\n- careFlowDefinitionIds: a comma-separated string of care flow definition ids that will be used when looking for care flows the patient is already enrolled in. By default, we only search for care flows that match the current care flow definition id (i.e. is the patient already included in the current care flow?).\n\n**Data points:**\n\n- result: a boolean indicating whether the patient is already enrolled in another care flow that matches your criteria (status & care flow definition id)\n- nbrOfResults: the number of care flows found for the patient that match the criteria.\n- careFlowIds: a comma-separated string of care flow ids that matched your search criteria. It will be empty when the result is `false` because then there are no other care flow ids that match your criteria.\n\n### Search patients by patient code\n\nNote that this action is deprecated and we recommend using [identifiers](https://developers.awellhealth.com/awell-orchestration/docs/misc/patient-identifiers) instead.\n\nSearch whether, apart from the patient currently enrolled in the care flow, another patient with the same `patient_code` already exists.\n\n**Data points:**\n\n1. patientAlreadyExists: a boolean which will be true if minimum one patient with the patient code already exists.\n2. numberOfPatientsFound: the number of patients found with the same patient code.\n3. awellPatientIds: a comma-separated string of all Awell patient ids (except the current patient) that have the same patient code as the patient currently enrolled in the care flow. Will return an empty string when there are no other patients with the same patient code.\n\n### Get patient by identifier\n\nThis action lets you check if a patient with a specific identifier already exists in Awell. It's particularly useful when a patient's identity is initially anonymous during the start of the care flow, but later becomes identifiable through the identifiers collected during the care flow. This check ensures whether a patient with that identifier is already present or not.\n\n### Add identifier to patient\n\nThis action allows you to add a unique identifier to the current patient's profile. If the patient already has an identifier with the same system but a different value, this action will update the existing identifier with the new value provided. \n\nFirst, it checks if this identifier (system and value) is already associated with another patient. If it's safe to proceed, it will add or update the identifier as needed. However, if another patient already has this identifier, the action will stop and notify you, preventing duplicates. To avoid conflicts, we recommend first running the \"Get patient by identifier\" action to check for any existing matches.\n\n## Webhooks\n\nWebhooks in the Awell extension offer ways to trigger a care flow based on the end of another care flow, or from any event that happens in your system (via the pathwayStart webhook).\n",
8
8
  "changelog": "# Awell changelog\n\n## April 2024\n\nTwo new action were added: \"Get patient by identifier\" and \"Add identifier to patient\".\n\n## October 26, 2023\n\nGeneric webhook to start a care flow added\n\n## April 19, 2023\n\nStop care flow action added.\nSearch patients by patient code action was added.\n\"Is patient enrolled in care flow\" action added.\n"
9
9
  },
10
+ "bland": {
11
+ "readme": "---\ntitle: Bland.ai\ndescription: To do\n---\n\n# Bland.ai\n\nTo do",
12
+ "changelog": "# CHANGELOG"
13
+ },
10
14
  "calDotCom": {
11
15
  "readme": "---\ntitle: Cal.com\ndescription: Cal.com is a modern and open source scheduling platform. With HIPAA, GDPR and SOC2 compliance, you can ensure that data is well-protected and that makes Cal.com a great fit for healthcare use cases.\n---\n\n# Cal.com\n\n[Cal.com](https://cal.com/) is a modern and **open source** scheduling platform. With HIPAA, GDPR and SOC2 compliance, you can ensure that data is well-protected and that makes Cal.com a great fit for healthcare use cases.\n\n## Cal.com x Awell\n\nThis extension allows you to let a stakeholder (eg: a patient) book an appointment as part of a care flow and to retrieve the booking details of an appointment.\n\n## Extension settings\n\nIn order to set up this extension, **you will need to provide a Cal.com API key**. You can obtain an API key via the Cal.com portal (`Settings > Developer > API keys`).\n\n## Custom Actions\n\n### Book appointment action\n\nYou can add this action to your care flow to enable a stakeholder (eg: a patient) to book an appointment in a predefined calendar. This is a **stakeholder-actionable action** which means it requires an actual user to book an appointment. Also note that this is a blocking action and that the care flow will not progress - unless there are parallel tracks or transitions - until the action/activity is completed (i.e. an appointment was booked).\n\n**The actual booking of the appointment can happen in two ways:**\n\n1. With Awell Hosted Pages: when the \"Book appointment\" action is activated, we serve the booking widget to the stakeholder so they can book an appointment directly from within Awell Hosted Pages.\n2. If you are not leveraging Awell Hosted Pages but have built a custom integration then we expose you all the details via our API so you can either create a Cal.com booking widget yourself or redirect the user to the Cal.com platform. Additionally, we expose a mutation that allows you to complete the activity and pass in the required data.\n\nBelow you can find an overview of all Awell Apps and whether they support rendering of the booking widget.\n\n| App | Supported |\n| ----------------------------- | --------- |\n| Awell Hosted Pages | Yes |\n| Your app (custom integration) | Yes |\n| Awell Care | No |\n| Awell MyCare | No |\n\n#### Data points\n\nAdding this action to your care flow will expose a new data point you can use in your care flow, the `bookingId`. When the care flow is orchestrated and the book appointment activity is completed, the id of the actual booking will be ingested as the value of that `bookingId` data point.\n\n### Get booking action\n\nThis action allows you to fetch the details of a booking based on the provided `bookingId`. This action will make the following data points available for you to use in your care flow:\n\n1. Event type ID\n2. Title\n3. Description\n4. Start time\n5. End time\n6. Status\n7. Cancel URL\n8. Reschedule URL\n9. Video call URL (if available)\n10. First Attendee's name\n12. First Attendee's timezone\n12. First Attendee's email\n13. Organizer's email\n\n### Update booking\n\nUpdates a booking and saves new `bookingId` and `bookingUid` as Data Points. Values possible to update:\n\n- Title - Title of Booking event\n- Description - Description of the meeting\n- Status - Status of the meeting to be set. Possible values: \"ACCEPTED\", \"PENDING\", \"CANCELLED\", \"REJECTED\".\n- Start - Start time of the Event in ISO 8601 format, e.g. 2023-05-24T13:00:00.000Z. Please note that start/end time must be within user's availability hours.\n- End - End time of the Event in ISO 8601 format, e.g. 2023-05-24T13:00:00.000Z. Please note that start/end time must be within user's availability hours.\n\n### Create booking\n\nCreates a booking and saves new `bookingId` as Data Points. Available fields:\n\n- Event Type ID - ID of the event type to book\n- Responses - Object containing email, name, location\n - ```json\n \"responses\": {\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"location\": \"Calcom HQ\"\n },\n ```\n- Metadata - Any metadata associated with the booking\n- Timezone - Timezone of the Attendee\n- Language - Language of the Attendee\n- Recurring Event ID - Recurring Event ID if the event is recurring\n- Title - Title of Booking event\n- Description - Description of the meeting\n- Status - Status of the meeting to be set. Possible values: \"ACCEPTED\", \"PENDING\", \"CANCELLED\", \"REJECTED\".\n- Start - Start time of the Event in ISO 8601 format, e.g. 2023-05-24T13:00:00.000Z. Please note that start/end time must be within user's availability hours.\n- End - End time of the Event in ISO 8601 format, e.g. 2023-05-24T13:00:00.000Z. Please note that start/end time must be within user's availability hours.\n\n### Delete Boooking\n\nDeletes a Booking with a given ID.\n\n## Pricing\n\n**This extension is free** but keep in mind that you might need a paid plan for Cal.com depending on your needs.\n\n## Limitations\n\n### Rescheduling\n\nWhen a previously made booking is rescheduled, there is no way yet to get the new/updated booking details into the care flow or have the care flow react on the updated booking.\n\nAlso note that when a booking is rescheduled, Cal.com doesn't update the original booking resource but creates a new one instead. As far as we know, there is no reference from the old booking to the new (rescheduled) booking.\n\n#### Example\n\nAn appointment has been booked with Cal.com and we have the below booking resource:\n\n```json\n{\n ...,\n \"bookingId\": \"1\",\n \"date\": \"Jan 1, 2023\"\n}\n```\n\nHowever, the patient reschedules the booking to Jan 10, 2023. When querying Cal.com's API (`GET v1/bookings/{bookingId}`), it will still return the old booking date instead of the new/rescheduled date.\n\n```json\n{\n ...,\n \"bookingId\": \"1\",\n \"date\": \"Jan 1, 2023\"\n}\n```\n\n## Webhooks\n\nWebhooks offer a great way to automate the flow with Awell when invitees schedule, cancel, or reschedule events, or when the meeting ends.\n\n**Important notes:**\n\n1. An Awell webhook endpoint can only listen to one event type. So make sure that when you create a webhook in Cal.com, the subscriber URL and the event trigger match the Awell webhook endpoint. This also means there can only be one event type per subscriber URL.\n2. Using a secret to verify the authenticity of the received payload is not yet supported.\n3. Custom payload templates are not supported, please use the default ones.\n",
12
16
  "changelog": "# Cal.com changelog\n\n## September 15, 2023\n\n- add createBooking action\n- add first attendee name and timezone to getBooking data points\n\n## September 4, 2023\n\n- add updateBooking and deleteBooking actions\n- update and refactor structure of getBooking and bookAppointment actions\n\n## July 4, 2023\n\n- Get booking action: add validation that bookingId and apiKey are not empty\n- Get booking action: add validation of response data to make sure we have data points\n\n## April 27, 2023\n\n- Get booking action: `startTime` and `endTime` data points are now of value type `date` instead of `string`.\n"
@@ -19,6 +19,7 @@ declare const PostSchema: z.ZodObject<{
19
19
  uuid: z.ZodString;
20
20
  }, "strip", z.ZodTypeAny, {
21
21
  body: string;
22
+ uuid: string;
22
23
  created_at: number;
23
24
  creator: {
24
25
  type: string;
@@ -26,9 +27,9 @@ declare const PostSchema: z.ZodObject<{
26
27
  phone_number?: string | undefined;
27
28
  };
28
29
  conversation_uuid: string;
29
- uuid: string;
30
30
  }, {
31
31
  body: string;
32
+ uuid: string;
32
33
  created_at: number;
33
34
  creator: {
34
35
  type: string;
@@ -36,7 +37,6 @@ declare const PostSchema: z.ZodObject<{
36
37
  phone_number?: string | undefined;
37
38
  };
38
39
  conversation_uuid: string;
39
- uuid: string;
40
40
  }>;
41
41
  export declare const GetMessagesSchema: z.ZodObject<{
42
42
  posts: z.ZodOptional<z.ZodArray<z.ZodObject<{
@@ -59,6 +59,7 @@ export declare const GetMessagesSchema: z.ZodObject<{
59
59
  uuid: z.ZodString;
60
60
  }, "strip", z.ZodTypeAny, {
61
61
  body: string;
62
+ uuid: string;
62
63
  created_at: number;
63
64
  creator: {
64
65
  type: string;
@@ -66,9 +67,9 @@ export declare const GetMessagesSchema: z.ZodObject<{
66
67
  phone_number?: string | undefined;
67
68
  };
68
69
  conversation_uuid: string;
69
- uuid: string;
70
70
  }, {
71
71
  body: string;
72
+ uuid: string;
72
73
  created_at: number;
73
74
  creator: {
74
75
  type: string;
@@ -76,11 +77,11 @@ export declare const GetMessagesSchema: z.ZodObject<{
76
77
  phone_number?: string | undefined;
77
78
  };
78
79
  conversation_uuid: string;
79
- uuid: string;
80
80
  }>, "many">>;
81
81
  }, "strip", z.ZodTypeAny, {
82
82
  posts?: {
83
83
  body: string;
84
+ uuid: string;
84
85
  created_at: number;
85
86
  creator: {
86
87
  type: string;
@@ -88,11 +89,11 @@ export declare const GetMessagesSchema: z.ZodObject<{
88
89
  phone_number?: string | undefined;
89
90
  };
90
91
  conversation_uuid: string;
91
- uuid: string;
92
92
  }[] | undefined;
93
93
  }, {
94
94
  posts?: {
95
95
  body: string;
96
+ uuid: string;
96
97
  created_at: number;
97
98
  creator: {
98
99
  type: string;
@@ -100,7 +101,6 @@ export declare const GetMessagesSchema: z.ZodObject<{
100
101
  phone_number?: string | undefined;
101
102
  };
102
103
  conversation_uuid: string;
103
- uuid: string;
104
104
  }[] | undefined;
105
105
  }>;
106
106
  declare const SendMessageResponseSchema: z.ZodObject<{
@@ -124,6 +124,7 @@ declare const SendMessageResponseSchema: z.ZodObject<{
124
124
  uuid: z.ZodString;
125
125
  }, "strip", z.ZodTypeAny, {
126
126
  body: string;
127
+ uuid: string;
127
128
  created_at: number;
128
129
  creator: {
129
130
  type: string;
@@ -131,9 +132,9 @@ declare const SendMessageResponseSchema: z.ZodObject<{
131
132
  phone_number?: string | undefined;
132
133
  };
133
134
  conversation_uuid: string;
134
- uuid: string;
135
135
  }, {
136
136
  body: string;
137
+ uuid: string;
137
138
  created_at: number;
138
139
  creator: {
139
140
  type: string;
@@ -141,11 +142,11 @@ declare const SendMessageResponseSchema: z.ZodObject<{
141
142
  phone_number?: string | undefined;
142
143
  };
143
144
  conversation_uuid: string;
144
- uuid: string;
145
145
  }>;
146
146
  }, "strip", z.ZodTypeAny, {
147
147
  post: {
148
148
  body: string;
149
+ uuid: string;
149
150
  created_at: number;
150
151
  creator: {
151
152
  type: string;
@@ -153,11 +154,11 @@ declare const SendMessageResponseSchema: z.ZodObject<{
153
154
  phone_number?: string | undefined;
154
155
  };
155
156
  conversation_uuid: string;
156
- uuid: string;
157
157
  };
158
158
  }, {
159
159
  post: {
160
160
  body: string;
161
+ uuid: string;
161
162
  created_at: number;
162
163
  creator: {
163
164
  type: string;
@@ -165,7 +166,6 @@ declare const SendMessageResponseSchema: z.ZodObject<{
165
166
  phone_number?: string | undefined;
166
167
  };
167
168
  conversation_uuid: string;
168
- uuid: string;
169
169
  };
170
170
  }>;
171
171
  export type SendMessageResponse = z.infer<typeof SendMessageResponseSchema>;
@@ -55,14 +55,14 @@ export declare const FieldsValidationSchema: z.ZodObject<{
55
55
  date_sent_before: z.ZodEffects<z.ZodUnion<[z.ZodOptional<z.ZodEffects<z.ZodDate, string, Date>>, z.ZodEffects<z.ZodLiteral<"">, undefined, "">]>, Date | undefined, "" | Date | undefined>;
56
56
  }, "strip", z.ZodTypeAny, {
57
57
  page_size: number;
58
- recipient?: import("libphonenumber-js").E164Number | undefined;
59
58
  from?: import("libphonenumber-js").E164Number | undefined;
59
+ recipient?: import("libphonenumber-js").E164Number | undefined;
60
60
  date_sent_after?: Date | undefined;
61
61
  date_sent_before?: Date | undefined;
62
62
  date_sent?: Date | undefined;
63
63
  }, {
64
- recipient?: string | undefined;
65
64
  from?: string | undefined;
65
+ recipient?: string | undefined;
66
66
  page_size?: number | undefined;
67
67
  date_sent_after?: "" | Date | undefined;
68
68
  date_sent_before?: "" | Date | undefined;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@awell-health/awell-extensions",
3
- "version": "2.0.65",
3
+ "version": "2.0.67",
4
4
  "packageManager": "yarn@3.4.1",
5
5
  "main": "dist/src/index.js",
6
6
  "repository": {