@wilix/zvonok-js-client 0.0.1

package/dist/index.d.mts

@@ -0,0 +1,240 @@
+import * as axios$1 from "axios";
+
+//#region src/types.d.ts
+type AddCallProps = {
+  phone: string;
+  campaign_id: number;
+  text?: string;
+  speaker?: string;
+  ivr_lvl_1_btn_1_sms_text?: string;
+  ivr_lvl_1_btn_2_sms_text?: string;
+  ivr_lvl_1_btn_1_email?: string;
+  ivr_lvl_1_btn_1_email_subject?: string;
+  ivr_lvl_1_btn_1_email_text?: string;
+  ivr_lvl_1_btn_1_audioclip_text?: string;
+  ivr_lvl_1_btn_1_to_phone?: string;
+  ivr_lvl_1_btn_1_to_sipname?: string;
+  ivr_lvl_1_btn_a_sms_text?: string;
+  ivr_lvl_1_btn_b_sms_text?: string;
+  ivr_lvl_1_btn_с_sms_text?: string;
+  ivr_lvl_1_btn_d_sms_text?: string;
+  ivr_lvl_1_btn_слово_sms_text?: string;
+  emotion?: string;
+  label?: string;
+  pincode?: number;
+  max_call_time?: number;
+};
+type FlashCallProps = {
+  phone: string;
+  campaign_id: number;
+  phone_suffix?: number;
+};
+type TellCodeProps = {
+  phone: string;
+  campaign_id: number;
+  pincode?: number;
+};
+type Campaigns = {
+  id: number;
+  name: string;
+  created: Date;
+  updated: Date;
+  paused: boolean | null;
+  is_archive: boolean;
+  status: "running";
+};
+type CampaignsResult = {
+  count: number;
+  campaigns: Campaigns[];
+};
+type CampaignCost = {
+  campaign_id: number;
+  forever_cost: string;
+  daily_cost: string;
+  currency: string;
+};
+type GetCallByCallIdProps = {
+  call_id: number;
+  call_ids?: number[];
+  expand?: boolean;
+};
+type GetCallByLabelProps = {
+  label: number;
+  labels?: number[];
+  expand?: boolean;
+};
+type GetCallByPhoneProps = {
+  campaign_id: number;
+  phone: string;
+  from_created_date: Date;
+  to_created_date: Date;
+  from_updated_date: Date;
+  to_updated_date: Date;
+  expand?: boolean;
+  phones: string[];
+};
+type RemoveCallProps = {
+  campaign_id: number;
+} & ({
+  call_id?: number;
+} | {
+  phone?: string;
+});
+type CallAttempt = {
+  "created": Date;
+  "call_type": "outgoing";
+  "attempt_num": number;
+  "status": "attempts_exc";
+  "dial_status": number;
+  "billsec": number;
+  "cost": number;
+  "currency": string;
+  "recorded_audio": string;
+};
+type TranscribingRecord = {
+  "normal_text": string;
+  "channel": number;
+  "start_time": number;
+  "end_time": number;
+};
+type BaseCallResult = {
+  status: "ok" | "error";
+  data: {
+    balance: number;
+    call_id: number;
+    created: string;
+    phone: string;
+    pincode: string;
+  };
+};
+type CallResult = {
+  "phone": string;
+  "status_display": string;
+  "recorded_audio": string;
+  "status": "user";
+  "dial_status_display": string | null;
+  "dial_status": string | null;
+  "call_id": number;
+  "user_choice": string | null;
+  "updated": Date;
+  "user_choice_display": string;
+  "action_type": "sms_to_owner";
+  "created": Date;
+  "button_num": number;
+  "completed": Date;
+  "duration": number;
+  "audioclip_id": number;
+  "ivr_data": null;
+  "transcribing": TranscribingRecord[];
+  "cost": string;
+  "currency": string;
+  "attempts": CallAttempt[];
+};
+type CallError = {
+  status: "error";
+  data: string;
+};
+type GetCallResult = CallResult[] | CallError;
+//#endregion
+//#region src/index.d.ts
+type ApiClientOptions = {
+  publicKey: string;
+  baseUrl?: string;
+};
+/**
+ * Zvonok API Client
+ * Full API documentation https://api-docs.zvonok.com/
+ */
+declare class ZvonokApiClient {
+  private readonly baseUrl;
+  private readonly publicKey;
+  constructor(options: ApiClientOptions);
+  /**
+   * Добавить звонок
+   * https://api-docs.zvonok.com/#ca6f7010-34b2-49e5-93e7-876d08b0b0d6
+   * @param params
+   */
+  addCall(params: AddCallProps): Promise<axios$1.AxiosResponse<CallResult, any, {}>>;
+  /**
+   * Добавить звонок (Ввод кода, Подт. звонком, Пров. номер)
+   * Используется в типах кампаний Ввод кода при звонке, Подтверждение звонком, Звонок на проверочный номер.
+   * https://api-docs.zvonok.com/#e66a370f-1313-41b4-bd67-e4e820f176c2
+   * @param params
+   */
+  confirmCall(params: TellCodeProps): Promise<axios$1.AxiosResponse<BaseCallResult, any, {}>>;
+  /**
+   * Добавить звонок (Диктовка кода)
+   * Используется в типе кампаний Диктовка кода роботом.
+   * https://api-docs.zvonok.com/#293d1bdf-5be8-47fb-86aa-e2082297fcc2
+   * @param params
+   */
+  tellCodeCall(params: TellCodeProps): Promise<axios$1.AxiosResponse<BaseCallResult, any, {}>>;
+  /**
+   * Добавить звонок (Flash Call)
+   * Используется в типе кампаний Flash Call.
+   * https://api-docs.zvonok.com/#4fcea3e4-7326-402b-b168-5daf733391bd
+   * @param params
+   */
+  flashCall(params: FlashCallProps): Promise<axios$1.AxiosResponse<BaseCallResult, any, {}>>;
+  /**
+   * Результаты прозвона по call_id
+   * Можно получить статус одного или нескольких звонков.
+   * Для получения статуса нескольких звонков используйте параметр call_ids вместо call_id.
+   * Посылать одновременно оба параметра запрещено.
+   * https://api-docs.zvonok.com/#50b1f5ff-200b-4177-b2e5-19aa806e5f63
+   * @param params
+   */
+  getCallByCallId(params: GetCallByCallIdProps): Promise<axios$1.AxiosResponse<GetCallResult, any, {}>>;
+  /**
+   * Результаты прозвона по номеру телефона
+   * Можно получить статус одного или нескольких звонков.
+   * Для получения статуса нескольких звонков используйте параметр phones вместо phone.
+   * Посылать одновременно оба параметра запрещено.
+   * https://api-docs.zvonok.com/#8031f9ee-daa5-4d41-9197-118e93efb62b
+   * @param params
+   */
+  getCallByPhone(params: GetCallByPhoneProps): Promise<axios$1.AxiosResponse<GetCallResult, any, {}>>;
+  /**
+   * Результаты прозвона по метке звонка
+   * Можно получить статус одного или нескольких звонков.
+   * Для получения статуса нескольких звонков используйте параметр labels вместо label.
+   * Посылать одновременно оба параметра запрещено.
+   * Дополнительно в результате прозвона в параметре label указана метка каждого звонка.
+   * https://api-docs.zvonok.com/#c3afd5cf-23b7-4714-9cac-62c89d22d838
+   * @param params
+   */
+  getCallByLabel(params: GetCallByLabelProps): Promise<axios$1.AxiosResponse<GetCallResult, any, {}>>;
+  /**
+   * Удаление звонка
+   * Удалить номер из прозвона, если соответствующий звонок не был завершён
+   * https://api-docs.zvonok.com/#112eb551-6062-4480-b5b2-347f9ce2d5b0
+   * @param props
+   */
+  removeCall(props: RemoveCallProps): Promise<axios$1.AxiosResponse<any, any, {}>>;
+  /**
+   * Добавление в стоплист
+   * https://api-docs.zvonok.com/#d5cd66cf-8760-4fb3-bf95-eef5b8332d42
+   * @param phone
+   */
+  addPhoneToStopList(phone: string): Promise<axios$1.AxiosResponse<any, any, {}>>;
+  /**
+   * Получить список кампаний
+   * https://api-docs.zvonok.com/#2b32b1bc-04c7-4489-b590-2edc3b6e9953
+   * @param mode
+   */
+  getCampaigns(mode?: 'all' | 'active' | 'archive'): Promise<axios$1.AxiosResponse<CampaignsResult, any, {}>>;
+  /**
+   * Проверить баланс
+   * https://api-docs.zvonok.com/#ec1dd1d3-54bb-4a41-88d3-e8c06e725d2d
+   */
+  getBalance(): Promise<axios$1.AxiosResponse<any, any, {}>>;
+  /**
+   * Траты по кампании
+   * https://api-docs.zvonok.com/#0499da8b-0b02-4c8e-b22e-b67d3bb64f01
+   * @param campaignId
+   */
+  getCost(campaignId: number): Promise<axios$1.AxiosResponse<CampaignCost, any, {}>>;
+  private post;
+}
+//#endregion
+export { AddCallProps, ApiClientOptions, BaseCallResult, CallAttempt, CallError, CallResult, CampaignCost, Campaigns, CampaignsResult, FlashCallProps, GetCallByCallIdProps, GetCallByLabelProps, GetCallByPhoneProps, GetCallResult, RemoveCallProps, TellCodeProps, TranscribingRecord, ZvonokApiClient as default };