retell-sdk 6.0.0 → 6.1.0

package/resources/contact.mjs

@@ -6,21 +6,40 @@ import { path } from "../internal/utils/path.mjs";
 export class Contact extends APIResource {
     /**
      * Create a new contact.
+     *
+     * @example
+     * ```ts
+     * const contactResponse = await client.contact.create({
+     *   phone_number: 'phone_number',
+     * });
+     * ```
      */
     create(body, options) {
         return this._client.post('/create-contact', { body, ...options });
     }
     /**
      * Update an existing contact.
+     *
+     * @example
+     * ```ts
+     * const contactResponse = await client.contact.update(
+     *   'contact_id',
+     * );
+     * ```
      */
     update(contactID, body, options) {
         return this._client.patch(path `/update-contact/${contactID}`, { body, ...options });
     }
     /**
-     * List contacts, newest conversation first by default, with the total count of
-     * matches alongside the page. Page through results with `pagination_key`; `skip`
-     * is available for offset-style paging but is slower on large contact sets and can
-     * repeat or miss rows as contacts are updated.
+     * List contacts, newest created first by default, with the total count of matches
+     * alongside the page. Page through results with `pagination_key`; `skip` is
+     * available for offset-style paging but is slower on large contact sets and can
+     * repeat or miss rows as contacts are added or deleted.
+     *
+     * @example
+     * ```ts
+     * const contacts = await client.contact.list();
+     * ```
      */
     list(body = {}, options) {
         return this._client.post('/list-contacts', { body, ...options });
@@ -29,6 +48,11 @@ export class Contact extends APIResource {
      * Delete a contact. A contact linked to a record in a connected CRM cannot be
      * deleted while two-way sync is active — unlink the CRM app first, otherwise the
      * next sync would recreate it.
+     *
+     * @example
+     * ```ts
+     * await client.contact.delete('contact_id');
+     * ```
      */
     delete(contactID, options) {
         return this._client.delete(path `/delete-contact/${contactID}`, {
@@ -36,6 +60,24 @@ export class Contact extends APIResource {
             headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
         });
     }
+    /**
+     * Trigger a backfill job that re-applies analysis data mappings to contacts using
+     * historical call and SMS chat data. Only one backfill job can run per
+     * organization at a time. Select contact_memory to rewrite memory from matching
+     * ended phone calls and SMS chats in chronological order, one conversation at a
+     * time, with no conversation-count cap. Backfill starts with the contact's
+     * existing memory. Each rewrite builds on the previous result, and the final
+     * successful result is saved once per contact. When mapped analysis fields and
+     * contact_memory are selected together, they are saved together in one contact
+     * update. Memory rewrites use the currently stored contact fields.
+     *
+     * @example
+     * ```ts
+     * const response = await client.contact.backfillAnalysisData({
+     *   backfill_attributes: ['contact_memory'],
+     * });
+     * ```
+     */
     backfillAnalysisData(body, options) {
         return this._client.post('/backfill-contact-analysis-data', { body, ...options });
     }
@@ -44,18 +86,44 @@ export class Contact extends APIResource {
      * and updates existing ones matched by phone number. Mapped columns overwrite the
      * matched contact's fields; unmapped columns are ignored. Runs asynchronously —
      * poll get-contact-import for progress.
+     *
+     * @example
+     * ```ts
+     * const response = await client.contact.createImport({
+     *   column_mapping: [
+     *     {
+     *       external_field_name: 'external_field_name',
+     *       field_name: 'field_name',
+     *     },
+     *   ],
+     *   upload_id: 'upload_26f1cbdf5713',
+     * });
+     * ```
      */
     createImport(body, options) {
         return this._client.post('/create-contact-import', { body, ...options });
     }
     /**
      * Retrieve a contact by ID.
+     *
+     * @example
+     * ```ts
+     * const contactResponse = await client.contact.get(
+     *   'contact_id',
+     * );
+     * ```
      */
     get(contactID, options) {
         return this._client.get(path `/get-contact/${contactID}`, options);
     }
     /**
      * Get the status of the contact analysis data backfill job.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.contact.getBackfillJobStatus();
+     * ```
      */
     getBackfillJobStatus(options) {
         return this._client.get('/get-backfill-contact-job-status', options);
@@ -63,12 +131,24 @@ export class Contact extends APIResource {
     /**
      * Retrieve a contact by phone number. At most one contact exists per phone number
      * in an organization.
+     *
+     * @example
+     * ```ts
+     * const contactResponse = await client.contact.getByPhone(
+     *   'phone_number',
+     * );
+     * ```
      */
     getByPhone(phoneNumber, options) {
         return this._client.get(path `/get-contact-by-phone/${phoneNumber}`, options);
     }
     /**
      * Status and counts for the org's current or latest contact import.
+     *
+     * @example
+     * ```ts
+     * const response = await client.contact.getImport();
+     * ```
      */
     getImport(options) {
         return this._client.get('/get-contact-import', options);
@@ -77,6 +157,13 @@ export class Contact extends APIResource {
      * List a contact's conversations (inbound calls, outbound calls, and chats) merged
      * into a single timeline, most recent first. Results are matched by the contact's
      * phone number. Use the returned `pagination_key` to fetch the next page.
+     *
+     * @example
+     * ```ts
+     * const response = await client.contact.listConversations(
+     *   'contact_id',
+     * );
+     * ```
      */
     listConversations(contactID, query = {}, options) {
         return this._client.get(path `/list-contact-conversations/${contactID}`, { query, ...options });
@@ -84,6 +171,13 @@ export class Contact extends APIResource {
     /**
      * Upload a CSV file for a contact import. The file is stored privately and
      * referenced by the returned upload_id in create-contact-import.
+     *
+     * @example
+     * ```ts
+     * const response = await client.contact.uploadImportFile({
+     *   file: fs.createReadStream('path/to/file'),
+     * });
+     * ```
      */
     uploadImportFile(body, options) {
         return this._client.post('/upload-contact-import-file', multipartFormRequestOptions({ body, ...options }, this._client));

package/resources/contact.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"contact.mjs","sourceRoot":"","sources":["../src/resources/contact.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAG/C,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,2BAA2B,EAAE,gCAA4B;AAClE,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,SAAiB,EACjB,IAAyB,EACzB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,mBAAmB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;;;;OAKG;IACH,IAAI,CACF,OAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,SAAiB,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,mBAAmB,SAAS,EAAE,EAAE;YAC7D,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED,oBAAoB,CAClB,IAAuC,EACvC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iCAAiC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;OAKG;IACH,YAAY,CACV,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,SAAiB,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACH,oBAAoB,CAAC,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kCAAkC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,WAAmB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,OAAwB;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CACf,SAAiB,EACjB,QAA2D,EAAE,EAC7D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,+BAA+B,SAAS,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjG,CAAC;IAED;;;OAGG;IACH,gBAAgB,CACd,IAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,6BAA6B,EAC7B,2BAA2B,CAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAChE,CAAC;IACJ,CAAC;CACF"}
+{"version":3,"file":"contact.mjs","sourceRoot":"","sources":["../src/resources/contact.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAG/C,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,2BAA2B,EAAE,gCAA4B;AAClE,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,SAAiB,EACjB,IAAyB,EACzB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,mBAAmB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,OAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,SAAiB,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,mBAAmB,SAAS,EAAE,EAAE;YAC7D,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,oBAAoB,CAClB,IAAuC,EACvC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iCAAiC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,YAAY,CACV,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;;OASG;IACH,GAAG,CAAC,SAAiB,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;OAQG;IACH,oBAAoB,CAAC,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kCAAkC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;OAUG;IACH,UAAU,CAAC,WAAmB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,OAAwB;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;OAWG;IACH,iBAAiB,CACf,SAAiB,EACjB,QAA2D,EAAE,EAC7D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,+BAA+B,SAAS,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjG,CAAC;IAED;;;;;;;;;;OAUG;IACH,gBAAgB,CACd,IAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,6BAA6B,EAC7B,2BAA2B,CAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAChE,CAAC;IACJ,CAAC;CACF"}