feat: V2 API endpoint create phone call #16528

Udit-takkar · 2024-09-06T15:20:30Z

What does this PR do?

Fixes [CAL-4299] create ai phone call api endpoint #16566 (GitHub issue number)
Fixes CAL-4299 (Linear issue number - should be visible at the bottom of the GitHub issue description)

Mandatory Tasks (DO NOT REMOVE)

I have self-reviewed the code (A decent size PR without self-review might be rejected) .
I have added a Docs issue here if this PR makes changes that would require a documentation change. If N/A, write N/A here and check the checkbox.
I confirm automated tests are in place that prove my fix is effective or that my feature works [To Be Added Later in follow up PR].

How should this be tested?

DM me for input body and api key

POST:- /api/v2/organizations/{org.id}/teams/{team.id}/event-types/{eventType.id}/create-phone-call

{
    yourPhoneNumber: <PHONE_NUMBER_FROM_RETELL>,
    numberToCall: <NUMBER_YOU_WANT_TO_CALL>,
    calApiKey: <CAL_API_KEY>
}

RETELL_AI_KEY required

Checklist

vercel · 2024-09-06T16:06:28Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
cal	⬜️ Ignored (Inspect)	Visit Preview		Sep 11, 2024 10:49am
calcom-web-canary	⬜️ Ignored (Inspect)	Visit Preview		Sep 11, 2024 10:49am

linear · 2024-09-10T08:23:34Z

CAL-4299 create ai phone call api endpoint

apps/api/v2/src/ee/event-types/event-types_2024_06_14/controllers/event-types.controller.ts

packages/features/handleCreatePhoneCall.ts

apps/api/v2/src/ee/event-types/event-types_2024_06_14/controllers/event-types.controller.ts

graphite-app · 2024-09-10T09:00:10Z

Graphite Automations

"Add consumer team as reviewer" took an action on this PR • (09/10/24)

1 reviewer was added to this PR based on Keith Williams's automation.

Udit-takkar · 2024-09-11T05:57:00Z

https://github.com/calcom/cal.com/pull/16528/files#r1751676555

alishaz-polymath

LGTM 🚀

supalarry · 2024-09-11T06:25:47Z

apps/api/v2/src/ee/event-types/event-types_2024_06_14/inputs/create-phone-call.input.ts

+
+  @IsBoolean()
+  @DocsProperty({ description: "Enabled status", default: true })
+  enabled = true;


To make typescript happy need to add ! aka enabled!

I don't see any ts error on this

since the type is 'true' it should be fine without the ! indeed, ! would be needed if the type was boolean

apps/api/v2/src/ee/event-types/event-types_2024_06_14/outputs/create-phone-call.output.ts

supalarry · 2024-09-11T06:30:09Z

...v2/src/modules/organizations/controllers/event-types/organizations-event-types.controller.ts

+        timeZone: user.timeZone,
+        profile: { organization: { id: orgId } },
+      },
+      input: { ...body, eventTypeId },


We are passing eventTypeId to handleCreatePhoneCall which has TCreatePhoneCallSchema for input, but eventTypeId does not exist on that schema.

It has eventTypeId. check this code

const requiredFields = z.object({ yourPhoneNumber: z.string().refine((val) => isValidPhoneNumber(val)), numberToCall: z.string().refine((val) => isValidPhoneNumber(val)), calApiKey: z.string().trim().min(1, { message: "Please enter CAL API Key", }), eventTypeId: z.number(), enabled: z.boolean().default(false), templateType: templateTypeEnum, }); export const createPhoneCallSchema = requiredFields.merge( z.object({ schedulerName: z.string().min(1).optional().nullable(), guestName: z .string() .optional() .transform((val) => { return !!val ? val : undefined; }), guestEmail: z .string() .optional() .transform((val) => { return !!val ? val : undefined; }), guestCompany: z .string() .optional() .transform((val) => { return !!val ? val : undefined; }), beginMessage: z.string().optional(), generalPrompt: z.string().optional(), }) );

Notice we are using merge

...v2/src/modules/organizations/controllers/event-types/organizations-event-types.controller.ts

supalarry · 2024-09-11T06:33:03Z

packages/features/handleCreatePhoneCall.ts

+  user: { timeZone: string; id: number; profile?: { organization?: { id?: number } } };
+  input: TCreatePhoneCallSchema;
+}) => {
+  if (!!!user?.profile?.organization) {


Why a tripple shabang !!! ? We could just have if(!user?.profile?.organization) {

Both are same. Let me replace it if it's harder to read.

packages/features/handleCreatePhoneCall.ts

supalarry · 2024-09-11T06:34:20Z

packages/features/handleCreatePhoneCall.ts

+
+  // If no retell LLM is associated with the event type, create one
+  if (!aiPhoneCallConfig.llmId) {
+    const createdRetellLLM = await retellAI.createRetellLLMAndUpdateWebsocketUrl();


All the code in this block statement could be abstracted in function to make code more readable.

github-actions · 2024-09-11T06:41:21Z

E2E results are ready!

Workflow #31349.1 latest results

socket-security · 2024-09-11T10:37:16Z

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/@formkit/auto-animate@1.0.0-beta.5	None	`0`	35.4 kB	justin-schroeder
npm/bcryptjs@2.4.3	None	`0`	221 kB	dcode
npm/ical.js@1.5.0	None	`0`	669 kB	kewisch

🚮 Removed packages: npm/@babel/code-frame@7.22.13, npm/@bcoe/v8-coverage@0.2.3, npm/@humanwhocodes/module-importer@1.0.1, npm/@humanwhocodes/object-schema@1.2.1, npm/@nodelib/fs.scandir@2.1.5, npm/@nodelib/fs.stat@2.0.5, npm/@nodelib/fs.walk@1.2.8, npm/@tsconfig/node10@1.0.8, npm/@tsconfig/node12@1.0.9, npm/@tsconfig/node14@1.0.1, npm/@tsconfig/node16@1.0.2, npm/@types/istanbul-lib-report@3.0.0, npm/@types/ms@0.7.31, npm/acorn-jsx@5.3.2, npm/acorn-walk@8.2.0, npm/acorn@8.8.0, npm/ajv@6.12.6, npm/ansi-colors@4.1.3, npm/arg@4.1.3, npm/array-union@2.1.0, npm/base64-js@1.5.1, npm/call-bind@1.0.2, npm/callsites@3.1.0, npm/chownr@2.0.0, npm/ci-info@3.3.0, npm/cli-spinners@2.6.1, npm/cli-width@3.0.0, npm/color-convert@2.0.1, npm/concat-stream@2.0.0, npm/convert-source-map@2.0.0, npm/create-require@1.1.1, npm/cross-spawn@7.0.3, npm/debug@4.3.4, npm/deepmerge@4.2.2, npm/define-properties@1.1.4, npm/detect-indent@6.1.0, npm/dir-glob@3.0.1, npm/doctrine@3.0.0, npm/encoding@0.1.13, npm/env-paths@2.2.1, npm/err-code@2.0.3, npm/error-ex@1.3.2, npm/es-shim-unscopables@1.0.0, npm/es-to-primitive@1.2.1, npm/escalade@3.1.1, npm/eslint-utils@3.0.0, npm/espree@9.4.1, npm/esprima@4.0.1, npm/esquery@1.4.0, npm/esrecurse@4.3.0, npm/esutils@2.0.3, npm/events@3.3.0, npm/execa@5.1.1, npm/fast-deep-equal@3.1.3, npm/fast-glob@3.2.11, npm/fast-json-stable-stringify@2.1.0, npm/fast-levenshtein@2.0.6, npm/file-entry-cache@6.0.1, npm/find-up@5.0.0, npm/flat-cache@3.0.4, npm/fsevents@2.3.2, npm/function-bind@1.1.1, npm/function.prototype.name@1.1.5, npm/functions-have-names@1.2.3, npm/get-caller-file@2.0.5, npm/get-package-type@0.1.0, npm/get-stream@6.0.1, npm/get-symbol-description@1.0.0, npm/globby@11.1.0, npm/grapheme-splitter@1.0.4, npm/has-bigints@1.0.2, npm/has-property-descriptors@1.0.0, npm/has-symbols@1.0.3, npm/has-tostringtag@1.0.0, npm/has@1.0.3, npm/html-escaper@2.0.2, npm/http-cache-semantics@4.1.1, npm/human-signals@2.1.0, npm/ieee754@1.2.1, npm/import-fresh@3.3.0, npm/imurmurhash@0.1.4, npm/indent-string@4.0.0, npm/inherits@2.0.4, npm/internal-slot@1.0.3, npm/is-arrayish@0.2.1, npm/is-callable@1.2.4, npm/is-extglob@2.1.1, npm/is-fullwidth-code-point@3.0.0, npm/is-glob@4.0.3, npm/is-lambda@1.0.1, npm/is-negative-zero@2.0.2, npm/is-number@7.0.0, npm/is-path-inside@3.0.3, npm/is-regex@1.1.4, npm/is-shared-array-buffer@1.0.2, npm/is-string@1.0.7, npm/is-weakref@1.0.2, npm/istanbul-lib-coverage@3.2.0, npm/istanbul-lib-report@3.0.0, npm/istanbul-reports@3.1.4, npm/jose@4.15.9, npm/js-tokens@4.0.0, npm/json-stable-stringify-without-jsonify@1.0.1, npm/jsonc-parser@3.2.0, npm/levn@0.4.1, npm/locate-path@6.0.0, npm/lodash.merge@4.6.2, npm/lodash@4.17.21, npm/luxon@3.3.0, npm/make-dir@3.1.0, npm/make-error@1.3.6, npm/merge-stream@2.0.0, npm/merge2@1.4.1, npm/mimic-fn@2.1.0, npm/minipass-flush@1.0.5, npm/minipass-pipeline@1.2.4, npm/minipass-sized@1.0.3, npm/minizlib@2.1.2, npm/mkdirp@1.0.4, npm/ms@2.1.2, npm/mute-stream@0.0.8, npm/natural-compare@1.4.0, npm/negotiator@0.6.3, npm/normalize-path@3.0.0, npm/npm-run-path@4.0.1, npm/object-inspect@1.12.2, npm/object-keys@1.1.1, npm/once@1.4.0, npm/onetime@5.1.2, npm/optionator@0.9.1, npm/p-limit@3.1.0, npm/p-locate@5.0.0, npm/parent-module@1.0.1, npm/parse-json@5.2.0, npm/path-parse@1.0.7, npm/path-type@4.0.0, npm/picocolors@1.0.0, npm/picomatch@2.3.1, npm/prelude-ls@1.2.1, npm/promise-inflight@1.0.1, npm/promise-retry@2.0.1, npm/queue-microtask@1.2.3, npm/react-is@18.2.0, npm/regexp.prototype.flags@1.4.3, npm/regexpp@3.2.0, npm/require-directory@2.1.1, npm/resolve-from@4.0.0, npm/retry@0.12.0, npm/reusify@1.0.4, npm/rfdc@1.3.0, npm/rimraf@3.0.2, npm/run-async@2.4.1, npm/run-parallel@1.2.0, npm/safer-buffer@2.1.2, npm/side-channel@1.0.4, npm/sisteransi@1.0.5, npm/slash@3.0.0, npm/smart-buffer@4.2.0, npm/source-map-js@1.0.2, npm/spdx-exceptions@2.3.0, npm/spdx-expression-parse@3.0.1, npm/string-width@4.2.3, npm/string.prototype.trimend@1.0.5, npm/string.prototype.trimstart@1.0.5, npm/string_decoder@1.3.0, npm/strip-bom@3.0.0, npm/strip-final-newline@2.0.0, npm/supports-preserve-symlinks-flag@1.0.0, npm/terminal-link@2.1.1, npm/test-exclude@6.0.0, npm/text-table@0.2.0, npm/to-regex-range@5.0.1, npm/type-check@0.4.0, npm/type-detect@4.0.8, npm/typedarray@0.0.6, npm/unbox-primitive@1.0.2, npm/uri-js@4.4.1, npm/util-deprecate@1.0.2, npm/validate-npm-package-license@3.0.4, npm/which-boxed-primitive@1.0.2, npm/wrappy@1.0.2, npm/xtend@4.0.2, npm/yaml@1.10.2, npm/yn@3.1.1

View full report↗︎

* refactor: V2 API endpoint create phone call * fix: type err * fix: type and build err * chore: change default value * chore: move it to another route * test: for create phone call * chore: undo constant * chore: remove test * fix: make begin_message optional * chore: improvements * chore: begin message * chore: remove unused import * chore: bump platform libraries with handleCreatePhoneCall * chore: improvement --------- Co-authored-by: Keith Williams <keithwillcode@gmail.com> Co-authored-by: Benny Joo <sldisek783@gmail.com> Co-authored-by: Morgan Vernay <morgan@cal.com> Co-authored-by: Peer Richelsen <peeroke@gmail.com>

refactor: V2 API endpoint create phone call

237e85f

Udit-takkar changed the title ~~refactor: V2 API endpoint create phone call~~ feat: V2 API endpoint create phone call Sep 6, 2024

keithwillcode added core area: core, team members only enterprise area: enterprise, audit log, organisation, SAML, SSO labels Sep 6, 2024

vercel bot had a problem deploying to Preview – api September 6, 2024 15:27 Failure

fix: type err

05ef42d

vercel bot had a problem deploying to Preview – dev September 6, 2024 16:06 Failure

vercel bot deployed to Preview – api September 6, 2024 16:17 View deployment

PeerRich added the High priority Created by Linear-GitHub Sync label Sep 9, 2024

Merge branch 'main' into refactor/create-phone-call-api

9fd57bc

vercel bot deployed to Preview – api September 10, 2024 06:46 View deployment

vercel bot deployed to Preview – dev September 10, 2024 06:50 View deployment

fix: type and build err

874c71c

vercel bot deployed to Preview – api September 10, 2024 08:32 View deployment

ThyMinimalDev reviewed Sep 10, 2024

View reviewed changes

apps/api/v2/src/ee/event-types/event-types_2024_06_14/controllers/event-types.controller.ts Outdated Show resolved Hide resolved

ThyMinimalDev reviewed Sep 10, 2024

View reviewed changes

packages/features/handleCreatePhoneCall.ts Outdated Show resolved Hide resolved

vercel bot deployed to Preview – dev September 10, 2024 08:37 View deployment

ThyMinimalDev reviewed Sep 10, 2024

View reviewed changes

apps/api/v2/src/ee/event-types/event-types_2024_06_14/controllers/event-types.controller.ts Outdated Show resolved Hide resolved

chore: change default value

35ddd81

github-actions bot added ai area: AI, cal.ai api area: API, enterprise API, access token, OAuth labels Sep 10, 2024

Udit-takkar marked this pull request as ready for review September 10, 2024 08:56

graphite-app bot requested a review from a team September 10, 2024 08:56

dosubot bot added the ✨ feature New feature or request label Sep 10, 2024

vercel bot deployed to Preview – api September 10, 2024 09:03 View deployment

vercel bot deployed to Preview – dev September 10, 2024 09:08 View deployment

chore: move it to another route

8dc82b3

keithwillcode added the ready-for-e2e label Sep 10, 2024

Merge branch 'main' into refactor/create-phone-call-api

12d3e06

vercel bot deployed to Preview – api September 10, 2024 19:26 View deployment

vercel bot deployed to Preview – dev September 10, 2024 19:31 View deployment

Merge branch 'main' into refactor/create-phone-call-api

c9f78c3

vercel bot deployed to Preview – api September 10, 2024 20:43 View deployment

vercel bot deployed to Preview – dev September 10, 2024 20:48 View deployment

chore: remove unused import

2e1bbeb

Udit-takkar dismissed hbjORbj’s stale review via 2e1bbeb September 11, 2024 06:00

vercel bot deployed to Preview – api September 11, 2024 06:11 View deployment

alishaz-polymath previously approved these changes Sep 11, 2024

View reviewed changes

vercel bot deployed to Preview – dev September 11, 2024 06:15 View deployment

chore: bump platform libraries with handleCreatePhoneCall

c333afa

ThyMinimalDev dismissed alishaz-polymath’s stale review via c333afa September 11, 2024 06:19

vercel bot deployed to Preview – api September 11, 2024 06:30 View deployment

supalarry reviewed Sep 11, 2024

View reviewed changes

vercel bot deployed to Preview – dev September 11, 2024 06:35 View deployment

chore: improvement

fe3fabb

vercel bot deployed to Preview – api September 11, 2024 10:44 View deployment

PeerRich approved these changes Sep 11, 2024

View reviewed changes

Merge branch 'main' into refactor/create-phone-call-api

c76597b

PeerRich enabled auto-merge (squash) September 11, 2024 10:50

vercel bot deployed to Preview – api September 11, 2024 10:59 View deployment

vercel bot deployed to Preview – dev September 11, 2024 11:05 View deployment

PeerRich merged commit 4d53f32 into main Sep 11, 2024
37 checks passed

PeerRich deleted the refactor/create-phone-call-api branch September 11, 2024 11:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: V2 API endpoint create phone call #16528

feat: V2 API endpoint create phone call #16528

Udit-takkar commented Sep 6, 2024 •

edited

Loading

vercel bot commented Sep 6, 2024 •

edited

Loading

linear bot commented Sep 10, 2024

graphite-app bot commented Sep 10, 2024

Udit-takkar commented Sep 11, 2024

alishaz-polymath left a comment

supalarry Sep 11, 2024

Udit-takkar Sep 11, 2024

ThyMinimalDev Sep 11, 2024 •

edited

Loading

supalarry Sep 11, 2024

Udit-takkar Sep 11, 2024

supalarry Sep 11, 2024

Udit-takkar Sep 11, 2024

supalarry Sep 11, 2024

github-actions bot commented Sep 11, 2024 •

edited

Loading

socket-security bot commented Sep 11, 2024 •

edited

Loading

feat: V2 API endpoint create phone call #16528

feat: V2 API endpoint create phone call #16528

Conversation

Udit-takkar commented Sep 6, 2024 • edited Loading

What does this PR do?

Mandatory Tasks (DO NOT REMOVE)

How should this be tested?

Checklist

vercel bot commented Sep 6, 2024 • edited Loading

linear bot commented Sep 10, 2024

graphite-app bot commented Sep 10, 2024

Graphite Automations

Udit-takkar commented Sep 11, 2024

alishaz-polymath left a comment

Choose a reason for hiding this comment

supalarry Sep 11, 2024

Choose a reason for hiding this comment

Udit-takkar Sep 11, 2024

Choose a reason for hiding this comment

ThyMinimalDev Sep 11, 2024 • edited Loading

Choose a reason for hiding this comment

supalarry Sep 11, 2024

Choose a reason for hiding this comment

Udit-takkar Sep 11, 2024

Choose a reason for hiding this comment

supalarry Sep 11, 2024

Choose a reason for hiding this comment

Udit-takkar Sep 11, 2024

Choose a reason for hiding this comment

supalarry Sep 11, 2024

Choose a reason for hiding this comment

github-actions bot commented Sep 11, 2024 • edited Loading

E2E results are ready!

socket-security bot commented Sep 11, 2024 • edited Loading

Udit-takkar commented Sep 6, 2024 •

edited

Loading

vercel bot commented Sep 6, 2024 •

edited

Loading

ThyMinimalDev Sep 11, 2024 •

edited

Loading

github-actions bot commented Sep 11, 2024 •

edited

Loading

socket-security bot commented Sep 11, 2024 •

edited

Loading