@unified-api/typescript-sdk 2.9.19 → 2.9.20

package/src/lib/encodings.ts

@@ -16,12 +16,16 @@ export function encodeMatrix(
   key: string,
   value: unknown,
   options?: { explode?: boolean; charEncoding?: "percent" | "none" },
-): string {
+): string | undefined {
   let out = "";
   const pairs: [string, unknown][] = options?.explode
     ? explode(key, value)
     : [[key, value]];
 
+  if (pairs.every(([_, v]) => v == null)) {
+    return;
+  }
+
   const encodeString = (v: string) => {
     return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
   };
@@ -29,21 +33,25 @@ export function encodeMatrix(
 
   pairs.forEach(([pk, pv]) => {
     let tmp = "";
-    let encValue = "";
+    let encValue: string | null | undefined = null;
 
-    if (pv === undefined) {
+    if (pv == null) {
       return;
     } else if (Array.isArray(pv)) {
-      encValue = mapDefined(pv, (v) => `${encodeValue(v)}`).join(",");
+      encValue = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(",");
     } else if (isPlainObject(pv)) {
-      encValue = mapDefinedEntries(Object.entries(pv), ([k, v]) => {
+      const mapped = mapDefinedEntries(Object.entries(pv), ([k, v]) => {
         return `,${encodeString(k)},${encodeValue(v)}`;
-      }).join("");
-      encValue = encValue.slice(1);
+      });
+      encValue = mapped?.join("").slice(1);
     } else {
       encValue = `${encodeValue(pv)}`;
     }
 
+    if (encValue == null) {
+      return;
+    }
+
     const keyPrefix = encodeString(pk);
     tmp = `${keyPrefix}=${encValue}`;
     // trim trailing '=' if value was empty
@@ -66,36 +74,40 @@ export function encodeLabel(
   key: string,
   value: unknown,
   options?: { explode?: boolean; charEncoding?: "percent" | "none" },
-): string {
+): string | undefined {
   let out = "";
   const pairs: [string, unknown][] = options?.explode
     ? explode(key, value)
     : [[key, value]];
 
+  if (pairs.every(([_, v]) => v == null)) {
+    return;
+  }
+
   const encodeString = (v: string) => {
     return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
   };
   const encodeValue = (v: unknown) => encodeString(serializeValue(v));
 
   pairs.forEach(([pk, pv]) => {
-    let encValue = "";
+    let encValue: string | null | undefined = "";
 
-    if (pv === undefined) {
+    if (pv == null) {
       return;
     } else if (Array.isArray(pv)) {
-      encValue = mapDefined(pv, (v) => `${encodeValue(v)}`).join(".");
+      encValue = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(".");
     } else if (isPlainObject(pv)) {
-      encValue = mapDefinedEntries(Object.entries(pv), ([k, v]) => {
+      const mapped = mapDefinedEntries(Object.entries(pv), ([k, v]) => {
         return `.${encodeString(k)}.${encodeValue(v)}`;
-      }).join("");
-      encValue = encValue.slice(1);
+      });
+      encValue = mapped?.join("").slice(1);
     } else {
       const k =
         options?.explode && isPlainObject(value) ? `${encodeString(pk)}=` : "";
       encValue = `${k}${encodeValue(pv)}`;
     }
 
-    out += `.${encValue}`;
+    out += encValue == null ? "" : `.${encValue}`;
   });
 
   return out;
@@ -105,7 +117,7 @@ type FormEncoder = (
   key: string,
   value: unknown,
   options?: { explode?: boolean; charEncoding?: "percent" | "none" },
-) => string;
+) => string | undefined;
 
 function formEncoder(sep: string): FormEncoder {
   return (
@@ -118,6 +130,10 @@ function formEncoder(sep: string): FormEncoder {
       ? explode(key, value)
       : [[key, value]];
 
+    if (pairs.every(([_, v]) => v == null)) {
+      return;
+    }
+
     const encodeString = (v: string) => {
       return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
     };
@@ -128,20 +144,24 @@ function formEncoder(sep: string): FormEncoder {
 
     pairs.forEach(([pk, pv]) => {
       let tmp = "";
-      let encValue = "";
+      let encValue: string | null | undefined = null;
 
-      if (pv === undefined) {
+      if (pv == null) {
         return;
       } else if (Array.isArray(pv)) {
-        encValue = mapDefined(pv, (v) => `${encodeValue(v)}`).join(encodedSep);
+        encValue = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(encodedSep);
       } else if (isPlainObject(pv)) {
         encValue = mapDefinedEntries(Object.entries(pv), ([k, v]) => {
           return `${encodeString(k)}${encodedSep}${encodeValue(v)}`;
-        }).join(encodedSep);
+        })?.join(encodedSep);
       } else {
         encValue = `${encodeValue(pv)}`;
       }
 
+      if (encValue == null) {
+        return;
+      }
+
       tmp = `${encodeString(pk)}=${encValue}`;
 
       // If we end up with the nothing then skip forward
@@ -180,7 +200,7 @@ export function encodeBodyForm(
     let tmp = "";
     let encValue = "";
 
-    if (pv === undefined) {
+    if (pv == null) {
       return;
     } else if (Array.isArray(pv)) {
       encValue = JSON.stringify(pv, jsonReplacer);
@@ -207,14 +227,14 @@ export function encodeDeepObject(
   key: string,
   value: unknown,
   options?: { charEncoding?: "percent" | "none" },
-): string {
+): string | undefined {
   if (value == null) {
-    return "";
+    return;
   }
 
   if (!isPlainObject(value)) {
     throw new EncodingError(
-      `Value of parameter '${key}' which uses deepObject encoding must be an object`,
+      `Value of parameter '${key}' which uses deepObject encoding must be an object or null`,
     );
   }
 
@@ -225,9 +245,9 @@ export function encodeDeepObjectObject(
   key: string,
   value: unknown,
   options?: { charEncoding?: "percent" | "none" },
-): string {
+): string | undefined {
   if (value == null) {
-    return "";
+    return;
   }
 
   let out = "";
@@ -241,7 +261,7 @@ export function encodeDeepObjectObject(
   }
 
   Object.entries(value).forEach(([ck, cv]) => {
-    if (cv === undefined) {
+    if (cv == null) {
       return;
     }
 
@@ -250,19 +270,17 @@ export function encodeDeepObjectObject(
     if (isPlainObject(cv)) {
       const objOut = encodeDeepObjectObject(pk, cv, options);
 
-      out += `&${objOut}`;
+      out += objOut == null ? "" : `&${objOut}`;
 
       return;
     }
 
     const pairs: unknown[] = Array.isArray(cv) ? cv : [cv];
-    let encoded = "";
-
-    encoded = mapDefined(pairs, (v) => {
+    const encoded = mapDefined(pairs, (v) => {
       return `${encodeString(pk)}=${encodeString(serializeValue(v))}`;
-    }).join("&");
+    })?.join("&");
 
-    out += `&${encoded}`;
+    out += encoded == null ? "" : `&${encoded}`;
   });
 
   return out.slice(1);
@@ -272,9 +290,9 @@ export function encodeJSON(
   key: string,
   value: unknown,
   options?: { explode?: boolean; charEncoding?: "percent" | "none" },
-): string {
+): string | undefined {
   if (typeof value === "undefined") {
-    return "";
+    return;
   }
 
   const encodeString = (v: string) => {
@@ -290,40 +308,39 @@ export const encodeSimple = (
   key: string,
   value: unknown,
   options?: { explode?: boolean; charEncoding?: "percent" | "none" },
-): string => {
+): string | undefined => {
   let out = "";
   const pairs: [string, unknown][] = options?.explode
     ? explode(key, value)
     : [[key, value]];
 
+  if (pairs.every(([_, v]) => v == null)) {
+    return;
+  }
+
   const encodeString = (v: string) => {
     return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
   };
   const encodeValue = (v: unknown) => encodeString(serializeValue(v));
 
   pairs.forEach(([pk, pv]) => {
-    let tmp = "";
+    let tmp: string | null | undefined = "";
 
-    if (pv === undefined) {
+    if (pv == null) {
       return;
     } else if (Array.isArray(pv)) {
-      tmp = mapDefined(pv, (v) => `${encodeValue(v)}`).join(",");
+      tmp = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(",");
     } else if (isPlainObject(pv)) {
-      tmp = mapDefinedEntries(Object.entries(pv), ([k, v]) => {
+      const mapped = mapDefinedEntries(Object.entries(pv), ([k, v]) => {
         return `,${encodeString(k)},${encodeValue(v)}`;
-      }).join("");
-      tmp = tmp.slice(1);
+      });
+      tmp = mapped?.join("").slice(1);
     } else {
       const k = options?.explode && isPlainObject(value) ? `${pk}=` : "";
       tmp = `${k}${encodeValue(pv)}`;
     }
 
-    // If we end up with the nothing then skip forward
-    if (!tmp) {
-      return;
-    }
-
-    out += `,${tmp}`;
+    out += tmp ? `,${tmp}` : "";
   });
 
   return out.slice(1);
@@ -341,9 +358,7 @@ function explode(key: string, value: unknown): [string, unknown][] {
 }
 
 function serializeValue(value: unknown): string {
-  if (value === null) {
-    return "null";
-  } else if (typeof value === "undefined") {
+  if (value == null) {
     return "";
   } else if (value instanceof Date) {
     return value.toISOString();
@@ -364,14 +379,14 @@ function jsonReplacer(_: string, value: unknown): unknown {
   }
 }
 
-function mapDefined<T, R>(inp: T[], mapper: (v: T) => R): R[] {
-  return inp.reduce<R[]>((acc, v) => {
-    if (v === undefined) {
+function mapDefined<T, R>(inp: T[], mapper: (v: T) => R): R[] | null {
+  const res = inp.reduce<R[]>((acc, v) => {
+    if (v == null) {
       return acc;
     }
 
     const m = mapper(v);
-    if (m === undefined) {
+    if (m == null) {
       return acc;
     }
 
@@ -379,30 +394,32 @@ function mapDefined<T, R>(inp: T[], mapper: (v: T) => R): R[] {
 
     return acc;
   }, []);
+
+  return res.length ? res : null;
 }
 
 function mapDefinedEntries<K, V, R>(
   inp: Iterable<[K, V]>,
   mapper: (v: [K, V]) => R,
-): R[] {
+): R[] | null {
   const acc: R[] = [];
   for (const [k, v] of inp) {
-    if (v === undefined) {
+    if (v == null) {
       continue;
     }
 
     const m = mapper([k, v]);
-    if (m === undefined) {
+    if (m == null) {
       continue;
     }
 
     acc.push(m);
   }
 
-  return acc;
+  return acc.length ? acc : null;
 }
 
-export function queryJoin(...args: string[]): string {
+export function queryJoin(...args: (string | undefined)[]): string {
   return args.filter(Boolean).join("&");
 }
 
@@ -415,7 +432,7 @@ type QueryEncoder = (
   key: string,
   value: unknown,
   options?: QueryEncoderOptions,
-) => string;
+) => string | undefined;
 
 type BulkQueryEncoder = (
   values: Record<string, unknown>,
@@ -447,3 +464,20 @@ export const encodeFormQuery = queryEncoder(encodeForm);
 export const encodeSpaceDelimitedQuery = queryEncoder(encodeSpaceDelimited);
 export const encodePipeDelimitedQuery = queryEncoder(encodePipeDelimited);
 export const encodeDeepObjectQuery = queryEncoder(encodeDeepObject);
+
+export function appendForm(
+  fd: FormData,
+  key: string,
+  value: unknown,
+  fileName?: string,
+): void {
+  if (value == null) {
+    return;
+  } else if (value instanceof Blob && fileName) {
+    fd.append(key, value, fileName);
+  } else if (value instanceof Blob) {
+    fd.append(key, value);
+  } else {
+    fd.append(key, String(value));
+  }
+}

package/src/lib/primitives.ts

@@ -120,3 +120,17 @@ export function abortSignalAny(signals: AbortSignal[]): AbortSignal {
 
   return result;
 }
+
+export function compactMap<T>(
+  values: Record<string, T | undefined>,
+): Record<string, T> {
+  const out: Record<string, T> = {};
+
+  for (const [k, v] of Object.entries(values)) {
+    if (typeof v !== "undefined") {
+      out[k] = v;
+    }
+  }
+
+  return out;
+}

package/src/lib/sdks.ts

@@ -131,7 +131,10 @@ export class ClientSDK {
 
     const secQuery: string[] = [];
     for (const [k, v] of Object.entries(security?.queryParams || {})) {
-      secQuery.push(encodeForm(k, v, { charEncoding: "percent" }));
+      const q = encodeForm(k, v, { charEncoding: "percent" });
+      if (typeof q !== "undefined") {
+        secQuery.push(q);
+      }
     }
     if (secQuery.length) {
       finalQuery += `&${secQuery.join("&")}`;

package/src/sdk/models/shared/marketinglist.ts

@@ -12,14 +12,19 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  * Mailing List
  */
 export type MarketingList = {
-  createdAt?: string | undefined;
+  createdAt?: Date | undefined;
+  description?: string | undefined;
+  endAt?: Date | undefined;
   id?: string | undefined;
+  isActive?: boolean | undefined;
   name?: string | undefined;
   /**
    * The raw data returned by the integration for this list
    */
   raw?: { [k: string]: any } | undefined;
+  startAt?: Date | undefined;
   updatedAt?: Date | undefined;
+  userId?: string | undefined;
 };
 
 /** @internal */
@@ -28,26 +33,43 @@ export const MarketingList$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  created_at: z.string().optional(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  description: z.string().optional(),
+  end_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
   id: z.string().optional(),
+  is_active: z.boolean().optional(),
   name: z.string().optional(),
   raw: z.record(z.any()).optional(),
+  start_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
   updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),
+  user_id: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     "created_at": "createdAt",
+    "end_at": "endAt",
+    "is_active": "isActive",
+    "start_at": "startAt",
     "updated_at": "updatedAt",
+    "user_id": "userId",
   });
 });
 
 /** @internal */
 export type MarketingList$Outbound = {
   created_at?: string | undefined;
+  description?: string | undefined;
+  end_at?: string | undefined;
   id?: string | undefined;
+  is_active?: boolean | undefined;
   name?: string | undefined;
   raw?: { [k: string]: any } | undefined;
+  start_at?: string | undefined;
   updated_at?: string | undefined;
+  user_id?: string | undefined;
 };
 
 /** @internal */
@@ -56,15 +78,24 @@ export const MarketingList$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   MarketingList
 > = z.object({
-  createdAt: z.string().optional(),
+  createdAt: z.date().transform(v => v.toISOString()).optional(),
+  description: z.string().optional(),
+  endAt: z.date().transform(v => v.toISOString()).optional(),
   id: z.string().optional(),
+  isActive: z.boolean().optional(),
   name: z.string().optional(),
   raw: z.record(z.any()).optional(),
+  startAt: z.date().transform(v => v.toISOString()).optional(),
   updatedAt: z.date().transform(v => v.toISOString()).optional(),
+  userId: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     createdAt: "created_at",
+    endAt: "end_at",
+    isActive: "is_active",
+    startAt: "start_at",
     updatedAt: "updated_at",
+    userId: "user_id",
   });
 });
 

package/src/sdk/models/shared/messagingmessage.ts

@@ -30,6 +30,10 @@ export type MessagingMessage = {
   attachments?: Array<MessagingAttachment> | undefined;
   authorMember?: PropertyMessagingMessageAuthorMember | undefined;
   channelId?: string | undefined;
+  /**
+   * Represents the IDs of all channels to which the message is sent. Identifies the channels where the message is posted.
+   */
+  channelIds?: Array<string> | undefined;
   createdAt?: Date | undefined;
   destinationMembers?: Array<MessagingMember> | undefined;
   hiddenMembers?: Array<MessagingMember> | undefined;
@@ -55,6 +59,7 @@ export const MessagingMessage$inboundSchema: z.ZodType<
   attachments: z.array(MessagingAttachment$inboundSchema).optional(),
   author_member: PropertyMessagingMessageAuthorMember$inboundSchema.optional(),
   channel_id: z.string().optional(),
+  channel_ids: z.array(z.string()).optional(),
   created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),
   destination_members: z.array(MessagingMember$inboundSchema).optional(),
@@ -75,6 +80,7 @@ export const MessagingMessage$inboundSchema: z.ZodType<
   return remap$(v, {
     "author_member": "authorMember",
     "channel_id": "channelId",
+    "channel_ids": "channelIds",
     "created_at": "createdAt",
     "destination_members": "destinationMembers",
     "hidden_members": "hiddenMembers",
@@ -92,6 +98,7 @@ export type MessagingMessage$Outbound = {
   attachments?: Array<MessagingAttachment$Outbound> | undefined;
   author_member?: PropertyMessagingMessageAuthorMember$Outbound | undefined;
   channel_id?: string | undefined;
+  channel_ids?: Array<string> | undefined;
   created_at?: string | undefined;
   destination_members?: Array<MessagingMember$Outbound> | undefined;
   hidden_members?: Array<MessagingMember$Outbound> | undefined;
@@ -117,6 +124,7 @@ export const MessagingMessage$outboundSchema: z.ZodType<
   attachments: z.array(MessagingAttachment$outboundSchema).optional(),
   authorMember: PropertyMessagingMessageAuthorMember$outboundSchema.optional(),
   channelId: z.string().optional(),
+  channelIds: z.array(z.string()).optional(),
   createdAt: z.date().transform(v => v.toISOString()).optional(),
   destinationMembers: z.array(MessagingMember$outboundSchema).optional(),
   hiddenMembers: z.array(MessagingMember$outboundSchema).optional(),
@@ -135,6 +143,7 @@ export const MessagingMessage$outboundSchema: z.ZodType<
   return remap$(v, {
     authorMember: "author_member",
     channelId: "channel_id",
+    channelIds: "channel_ids",
     createdAt: "created_at",
     destinationMembers: "destination_members",
     hiddenMembers: "hidden_members",