Skip to content

Commit d1652d4

Browse files
fern-api[bot]fern-api[bot]
committed
Release 0.9.1
1 parent d6ef2f8 commit d1652d4

File tree

150 files changed

+4029
-490
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

150 files changed

+4029
-490
lines changed

‎reference.md

Lines changed: 308 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -511,6 +511,311 @@ await client.chats.createResponse({
511511
</dl>
512512
</details>
513513

514+
## Campaigns
515+
516+
<details><summary><code>client.campaigns.<a href="/src/api/resources/campaigns/client/Client.ts">campaignControllerFindAll</a>({ ...params }) -> Vapi.Campaign[]</code></summary>
517+
<dl>
518+
<dd>
519+
520+
#### 🔌 Usage
521+
522+
<dl>
523+
<dd>
524+
525+
<dl>
526+
<dd>
527+
528+
```typescript
529+
await client.campaigns.campaignControllerFindAll();
530+
```
531+
532+
</dd>
533+
</dl>
534+
</dd>
535+
</dl>
536+
537+
#### ⚙️ Parameters
538+
539+
<dl>
540+
<dd>
541+
542+
<dl>
543+
<dd>
544+
545+
**request:** `Vapi.CampaignControllerFindAllRequest`
546+
547+
</dd>
548+
</dl>
549+
550+
<dl>
551+
<dd>
552+
553+
**requestOptions:** `Campaigns.RequestOptions`
554+
555+
</dd>
556+
</dl>
557+
</dd>
558+
</dl>
559+
560+
</dd>
561+
</dl>
562+
</details>
563+
564+
<details><summary><code>client.campaigns.<a href="/src/api/resources/campaigns/client/Client.ts">campaignControllerCreate</a>({ ...params }) -> Vapi.Campaign</code></summary>
565+
<dl>
566+
<dd>
567+
568+
#### 🔌 Usage
569+
570+
<dl>
571+
<dd>
572+
573+
<dl>
574+
<dd>
575+
576+
```typescript
577+
await client.campaigns.campaignControllerCreate({
578+
name: "Q2 Sales Campaign",
579+
phoneNumberId: "phoneNumberId",
580+
schedulePlan: {
581+
earliestAt: "2024-01-15T09:30:00Z",
582+
},
583+
customers: [{}],
584+
});
585+
```
586+
587+
</dd>
588+
</dl>
589+
</dd>
590+
</dl>
591+
592+
#### ⚙️ Parameters
593+
594+
<dl>
595+
<dd>
596+
597+
<dl>
598+
<dd>
599+
600+
**request:** `Vapi.CreateCampaignDto`
601+
602+
</dd>
603+
</dl>
604+
605+
<dl>
606+
<dd>
607+
608+
**requestOptions:** `Campaigns.RequestOptions`
609+
610+
</dd>
611+
</dl>
612+
</dd>
613+
</dl>
614+
615+
</dd>
616+
</dl>
617+
</details>
618+
619+
<details><summary><code>client.campaigns.<a href="/src/api/resources/campaigns/client/Client.ts">campaignControllerFindAllPaginated</a>({ ...params }) -> Vapi.Campaign</code></summary>
620+
<dl>
621+
<dd>
622+
623+
#### 🔌 Usage
624+
625+
<dl>
626+
<dd>
627+
628+
<dl>
629+
<dd>
630+
631+
```typescript
632+
await client.campaigns.campaignControllerFindAllPaginated();
633+
```
634+
635+
</dd>
636+
</dl>
637+
</dd>
638+
</dl>
639+
640+
#### ⚙️ Parameters
641+
642+
<dl>
643+
<dd>
644+
645+
<dl>
646+
<dd>
647+
648+
**request:** `Vapi.CampaignControllerFindAllPaginatedRequest`
649+
650+
</dd>
651+
</dl>
652+
653+
<dl>
654+
<dd>
655+
656+
**requestOptions:** `Campaigns.RequestOptions`
657+
658+
</dd>
659+
</dl>
660+
</dd>
661+
</dl>
662+
663+
</dd>
664+
</dl>
665+
</details>
666+
667+
<details><summary><code>client.campaigns.<a href="/src/api/resources/campaigns/client/Client.ts">campaignControllerFindOne</a>(id) -> Vapi.Campaign</code></summary>
668+
<dl>
669+
<dd>
670+
671+
#### 🔌 Usage
672+
673+
<dl>
674+
<dd>
675+
676+
<dl>
677+
<dd>
678+
679+
```typescript
680+
await client.campaigns.campaignControllerFindOne("id");
681+
```
682+
683+
</dd>
684+
</dl>
685+
</dd>
686+
</dl>
687+
688+
#### ⚙️ Parameters
689+
690+
<dl>
691+
<dd>
692+
693+
<dl>
694+
<dd>
695+
696+
**id:** `string`
697+
698+
</dd>
699+
</dl>
700+
701+
<dl>
702+
<dd>
703+
704+
**requestOptions:** `Campaigns.RequestOptions`
705+
706+
</dd>
707+
</dl>
708+
</dd>
709+
</dl>
710+
711+
</dd>
712+
</dl>
713+
</details>
714+
715+
<details><summary><code>client.campaigns.<a href="/src/api/resources/campaigns/client/Client.ts">campaignControllerRemove</a>(id) -> Vapi.Campaign</code></summary>
716+
<dl>
717+
<dd>
718+
719+
#### 🔌 Usage
720+
721+
<dl>
722+
<dd>
723+
724+
<dl>
725+
<dd>
726+
727+
```typescript
728+
await client.campaigns.campaignControllerRemove("id");
729+
```
730+
731+
</dd>
732+
</dl>
733+
</dd>
734+
</dl>
735+
736+
#### ⚙️ Parameters
737+
738+
<dl>
739+
<dd>
740+
741+
<dl>
742+
<dd>
743+
744+
**id:** `string`
745+
746+
</dd>
747+
</dl>
748+
749+
<dl>
750+
<dd>
751+
752+
**requestOptions:** `Campaigns.RequestOptions`
753+
754+
</dd>
755+
</dl>
756+
</dd>
757+
</dl>
758+
759+
</dd>
760+
</dl>
761+
</details>
762+
763+
<details><summary><code>client.campaigns.<a href="/src/api/resources/campaigns/client/Client.ts">campaignControllerUpdate</a>(id, { ...params }) -> Vapi.Campaign</code></summary>
764+
<dl>
765+
<dd>
766+
767+
#### 🔌 Usage
768+
769+
<dl>
770+
<dd>
771+
772+
<dl>
773+
<dd>
774+
775+
```typescript
776+
await client.campaigns.campaignControllerUpdate("id");
777+
```
778+
779+
</dd>
780+
</dl>
781+
</dd>
782+
</dl>
783+
784+
#### ⚙️ Parameters
785+
786+
<dl>
787+
<dd>
788+
789+
<dl>
790+
<dd>
791+
792+
**id:** `string`
793+
794+
</dd>
795+
</dl>
796+
797+
<dl>
798+
<dd>
799+
800+
**request:** `Vapi.UpdateCampaignDto`
801+
802+
</dd>
803+
</dl>
804+
805+
<dl>
806+
<dd>
807+
808+
**requestOptions:** `Campaigns.RequestOptions`
809+
810+
</dd>
811+
</dl>
812+
</dd>
813+
</dl>
814+
815+
</dd>
816+
</dl>
817+
</details>
818+
514819
## Sessions
515820

516821
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">list</a>({ ...params }) -> Vapi.SessionPaginatedResponse</code></summary>
@@ -1328,7 +1633,9 @@ await client.tools.list();
13281633

13291634
```typescript
13301635
await client.tools.create({
1331-
type: "dtmf",
1636+
type: "apiRequest",
1637+
method: "POST",
1638+
url: "url",
13321639
});
13331640
```
13341641

‎src/Client.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import * as environments from "./environments";
66
import * as core from "./core";
77
import { Calls } from "./api/resources/calls/client/Client";
88
import { Chats } from "./api/resources/chats/client/Client";
9+
import { Campaigns } from "./api/resources/campaigns/client/Client";
910
import { Sessions } from "./api/resources/sessions/client/Client";
1011
import { Assistants } from "./api/resources/assistants/client/Client";
1112
import { PhoneNumbers } from "./api/resources/phoneNumbers/client/Client";
@@ -44,6 +45,7 @@ export declare namespace VapiClient {
4445
export class VapiClient {
4546
protected _calls: Calls | undefined;
4647
protected _chats: Chats | undefined;
48+
protected _campaigns: Campaigns | undefined;
4749
protected _sessions: Sessions | undefined;
4850
protected _assistants: Assistants | undefined;
4951
protected _phoneNumbers: PhoneNumbers | undefined;
@@ -68,6 +70,10 @@ export class VapiClient {
6870
return (this._chats ??= new Chats(this._options));
6971
}
7072

73+
public get campaigns(): Campaigns {
74+
return (this._campaigns ??= new Campaigns(this._options));
75+
}
76+
7177
public get sessions(): Sessions {
7278
return (this._sessions ??= new Sessions(this._options));
7379
}

‎src/api/resources/assistants/client/requests/UpdateAssistantDto.ts

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,9 @@ export interface UpdateAssistantDto {
7979
/** These are the configurations to be passed to the transport providers of assistant's calls, like Twilio. You can store multiple configurations for different transport providers. For a call, only the configuration matching the call transport provider is used. */
8080
transportConfigurations?: Vapi.TransportConfigurationTwilio[];
8181
/**
82-
* This is the plan for observability configuration of assistant's calls.
83-
* Currently supports Langfuse for tracing and monitoring.
82+
* This is the plan for observability of assistant's calls.
83+
*
84+
* Currently, only Langfuse is supported.
8485
*/
8586
observabilityPlan?: Vapi.LangfuseObservabilityPlan;
8687
/** These are dynamic credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can supplement an additional credentials using this. Dynamic credentials override existing credentials. */
@@ -110,13 +111,23 @@ export interface UpdateAssistantDto {
110111
compliancePlan?: Vapi.CompliancePlan;
111112
/** This is for metadata you want to store on the assistant. */
112113
metadata?: Record<string, unknown>;
113-
/** This is the plan for analysis of assistant's calls. Stored in `call.analysis`. */
114-
analysisPlan?: Vapi.AnalysisPlan;
115114
/**
116-
* This is the plan for artifacts generated during assistant's calls. Stored in `call.artifact`.
115+
* This enables filtering of noise and background speech while the user is talking.
116+
*
117+
* Features:
118+
* - Smart denoising using Krisp
119+
* - Fourier denoising
117120
*
118-
* Note: `recordingEnabled` is currently at the root level. It will be moved to `artifactPlan` in the future, but will remain backwards compatible.
121+
* Smart denoising can be combined with or used independently of Fourier denoising.
122+
*
123+
* Order of precedence:
124+
* - Smart denoising
125+
* - Fourier denoising
119126
*/
127+
backgroundSpeechDenoisingPlan?: Vapi.BackgroundSpeechDenoisingPlan;
128+
/** This is the plan for analysis of assistant's calls. Stored in `call.analysis`. */
129+
analysisPlan?: Vapi.AnalysisPlan;
130+
/** This is the plan for artifacts generated during assistant's calls. Stored in `call.artifact`. */
120131
artifactPlan?: Vapi.ArtifactPlan;
121132
/**
122133
* This is the plan for static predefined messages that can be spoken by the assistant during the call, like `idleMessages`.
@@ -150,8 +161,6 @@ export interface UpdateAssistantDto {
150161
* Usage:
151162
* - To enable live listening of the assistant's calls, set `monitorPlan.listenEnabled` to `true`.
152163
* - To enable live control of the assistant's calls, set `monitorPlan.controlEnabled` to `true`.
153-
*
154-
* Note, `serverMessages`, `clientMessages`, `serverUrl` and `serverUrlSecret` are currently at the root level but will be moved to `monitorPlan` in the future. Will remain backwards compatible
155164
*/
156165
monitorPlan?: Vapi.MonitorPlan;
157166
/** These are the credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can provide a subset using this. */

0 commit comments

Comments
 (0)