magicbell-js 1.5.0 → 1.6.0

package/dist/commonjs/project-client/services/events/models/event-collection.d.ts

@@ -1,6 +1,8 @@
 import { z } from 'zod';
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the EventCollection model.
+ * Defines the structure and validation rules for this data type.
+ * This is the shape used in application code - what developers interact with.
  */
 export declare const eventCollection: z.ZodLazy<z.ZodObject<{
     data: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodObject<{
@@ -9,6 +11,7 @@ export declare const eventCollection: z.ZodLazy<z.ZodObject<{
         id: z.ZodString;
         level: z.ZodOptional<z.ZodString>;
         log: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        payload: z.ZodNullable<z.ZodOptional<z.ZodAny>>;
         timestamp: z.ZodString;
         type: z.ZodString;
     }, "strip", z.ZodTypeAny, {
@@ -19,6 +22,7 @@ export declare const eventCollection: z.ZodLazy<z.ZodObject<{
         context?: any;
         level?: string | undefined;
         log?: string | null | undefined;
+        payload?: any;
     }, {
         type: string;
         id: string;
@@ -27,6 +31,7 @@ export declare const eventCollection: z.ZodLazy<z.ZodObject<{
         context?: any;
         level?: string | undefined;
         log?: string | null | undefined;
+        payload?: any;
     }>>, "many">>;
     links: z.ZodOptional<z.ZodLazy<z.ZodObject<{
         first: z.ZodOptional<z.ZodString>;
@@ -50,6 +55,7 @@ export declare const eventCollection: z.ZodLazy<z.ZodObject<{
         context?: any;
         level?: string | undefined;
         log?: string | null | undefined;
+        payload?: any;
     }[] | undefined;
     links?: {
         first?: string | undefined;
@@ -65,6 +71,7 @@ export declare const eventCollection: z.ZodLazy<z.ZodObject<{
         context?: any;
         level?: string | undefined;
         log?: string | null | undefined;
+        payload?: any;
     }[] | undefined;
     links?: {
         first?: string | undefined;
@@ -80,8 +87,9 @@ export declare const eventCollection: z.ZodLazy<z.ZodObject<{
  */
 export type EventCollection = z.infer<typeof eventCollection>;
 /**
- * The shape of the model mapping from the api schema into the application shape.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping API responses to the EventCollection application shape.
+ * Handles any property name transformations from the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export declare const eventCollectionResponse: z.ZodLazy<z.ZodEffects<z.ZodObject<{
     data: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodEffects<z.ZodObject<{
@@ -90,6 +98,7 @@ export declare const eventCollectionResponse: z.ZodLazy<z.ZodEffects<z.ZodObject
         id: z.ZodString;
         level: z.ZodOptional<z.ZodString>;
         log: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        payload: z.ZodNullable<z.ZodOptional<z.ZodAny>>;
         timestamp: z.ZodString;
         type: z.ZodString;
     }, "strip", z.ZodTypeAny, {
@@ -100,6 +109,7 @@ export declare const eventCollectionResponse: z.ZodLazy<z.ZodEffects<z.ZodObject
         context?: any;
         level?: string | undefined;
         log?: string | null | undefined;
+        payload?: any;
     }, {
         type: string;
         id: string;
@@ -108,12 +118,14 @@ export declare const eventCollectionResponse: z.ZodLazy<z.ZodEffects<z.ZodObject
         context?: any;
         level?: string | undefined;
         log?: string | null | undefined;
+        payload?: any;
     }>, {
         code: number | undefined;
         context: any;
         id: string;
         level: string | undefined;
         log: string | null | undefined;
+        payload: any;
         timestamp: string;
         type: string;
     }, {
@@ -124,6 +136,7 @@ export declare const eventCollectionResponse: z.ZodLazy<z.ZodEffects<z.ZodObject
         context?: any;
         level?: string | undefined;
         log?: string | null | undefined;
+        payload?: any;
     }>>, "many">>;
     links: z.ZodOptional<z.ZodLazy<z.ZodEffects<z.ZodObject<{
         first: z.ZodOptional<z.ZodString>;
@@ -153,6 +166,7 @@ export declare const eventCollectionResponse: z.ZodLazy<z.ZodEffects<z.ZodObject
         id: string;
         level: string | undefined;
         log: string | null | undefined;
+        payload: any;
         timestamp: string;
         type: string;
     }[] | undefined;
@@ -170,6 +184,7 @@ export declare const eventCollectionResponse: z.ZodLazy<z.ZodEffects<z.ZodObject
         context?: any;
         level?: string | undefined;
         log?: string | null | undefined;
+        payload?: any;
     }[] | undefined;
     links?: {
         first?: string | undefined;
@@ -183,6 +198,7 @@ export declare const eventCollectionResponse: z.ZodLazy<z.ZodEffects<z.ZodObject
         id: string;
         level: string | undefined;
         log: string | null | undefined;
+        payload: any;
         timestamp: string;
         type: string;
     }[] | undefined;
@@ -200,6 +216,7 @@ export declare const eventCollectionResponse: z.ZodLazy<z.ZodEffects<z.ZodObject
         context?: any;
         level?: string | undefined;
         log?: string | null | undefined;
+        payload?: any;
     }[] | undefined;
     links?: {
         first?: string | undefined;
@@ -208,8 +225,9 @@ export declare const eventCollectionResponse: z.ZodLazy<z.ZodEffects<z.ZodObject
     } | undefined;
 }>>;
 /**
- * The shape of the model mapping from the application shape into the api schema.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping the EventCollection application shape to API requests.
+ * Handles any property name transformations required by the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export declare const eventCollectionRequest: z.ZodLazy<z.ZodEffects<z.ZodObject<{
     data: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodEffects<z.ZodObject<{
@@ -218,6 +236,7 @@ export declare const eventCollectionRequest: z.ZodLazy<z.ZodEffects<z.ZodObject<
         id: z.ZodString;
         level: z.ZodOptional<z.ZodString>;
         log: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        payload: z.ZodNullable<z.ZodOptional<z.ZodAny>>;
         timestamp: z.ZodString;
         type: z.ZodString;
     }, "strip", z.ZodTypeAny, {
@@ -228,6 +247,7 @@ export declare const eventCollectionRequest: z.ZodLazy<z.ZodEffects<z.ZodObject<
         context?: any;
         level?: string | undefined;
         log?: string | null | undefined;
+        payload?: any;
     }, {
         type: string;
         id: string;
@@ -236,12 +256,14 @@ export declare const eventCollectionRequest: z.ZodLazy<z.ZodEffects<z.ZodObject<
         context?: any;
         level?: string | undefined;
         log?: string | null | undefined;
+        payload?: any;
     }>, {
         code: number | undefined;
         context: any;
         id: string;
         level: string | undefined;
         log: string | null | undefined;
+        payload: any;
         timestamp: string;
         type: string;
     }, {
@@ -252,6 +274,7 @@ export declare const eventCollectionRequest: z.ZodLazy<z.ZodEffects<z.ZodObject<
         context?: any;
         level?: string | undefined;
         log?: string | null | undefined;
+        payload?: any;
     }>>, "many">>;
     links: z.ZodOptional<z.ZodLazy<z.ZodEffects<z.ZodObject<{
         first: z.ZodOptional<z.ZodString>;
@@ -281,6 +304,7 @@ export declare const eventCollectionRequest: z.ZodLazy<z.ZodEffects<z.ZodObject<
         id: string;
         level: string | undefined;
         log: string | null | undefined;
+        payload: any;
         timestamp: string;
         type: string;
     }[] | undefined;
@@ -298,6 +322,7 @@ export declare const eventCollectionRequest: z.ZodLazy<z.ZodEffects<z.ZodObject<
         context?: any;
         level?: string | undefined;
         log?: string | null | undefined;
+        payload?: any;
     }[] | undefined;
     links?: {
         first?: string | undefined;
@@ -311,6 +336,7 @@ export declare const eventCollectionRequest: z.ZodLazy<z.ZodEffects<z.ZodObject<
         id: string;
         level: string | undefined;
         log: string | null | undefined;
+        payload: any;
         timestamp: string;
         type: string;
     }[] | undefined;
@@ -328,6 +354,7 @@ export declare const eventCollectionRequest: z.ZodLazy<z.ZodEffects<z.ZodObject<
         context?: any;
         level?: string | undefined;
         log?: string | null | undefined;
+        payload?: any;
     }[] | undefined;
     links?: {
         first?: string | undefined;

package/dist/commonjs/project-client/services/events/models/event-collection.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"event-collection.d.ts","sourceRoot":"","sources":["../../../../../../src/project-client/services/events/models/event-collection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAKxB;;GAEG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAK1B,CAAC;AAEH;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAE9D;;;GAGG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAUlC,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAUjC,CAAC"}
+{"version":3,"file":"event-collection.d.ts","sourceRoot":"","sources":["../../../../../../src/project-client/services/events/models/event-collection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAKxB;;;;GAIG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAK1B,CAAC;AAEH;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAE9D;;;;GAIG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAUlC,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAUjC,CAAC"}

package/dist/commonjs/project-client/services/events/models/event-collection.js

@@ -5,7 +5,9 @@ const zod_1 = require("zod");
 const links_js_1 = require("../../common/links.js");
 const event_js_1 = require("./event.js");
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the EventCollection model.
+ * Defines the structure and validation rules for this data type.
+ * This is the shape used in application code - what developers interact with.
  */
 exports.eventCollection = zod_1.z.lazy(() => {
     return zod_1.z.object({
@@ -14,8 +16,9 @@ exports.eventCollection = zod_1.z.lazy(() => {
     });
 });
 /**
- * The shape of the model mapping from the api schema into the application shape.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping API responses to the EventCollection application shape.
+ * Handles any property name transformations from the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 exports.eventCollectionResponse = zod_1.z.lazy(() => {
     return zod_1.z
@@ -29,8 +32,9 @@ exports.eventCollectionResponse = zod_1.z.lazy(() => {
     }));
 });
 /**
- * The shape of the model mapping from the application shape into the api schema.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping the EventCollection application shape to API requests.
+ * Handles any property name transformations required by the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 exports.eventCollectionRequest = zod_1.z.lazy(() => {
     return zod_1.z

package/dist/commonjs/project-client/services/events/models/event-collection.js.map

@@ -1 +1 @@
-{"version":3,"file":"event-collection.js","sourceRoot":"","sources":["../../../../../../src/project-client/services/events/models/event-collection.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB,oDAAkF;AAClF,yCAAuE;AAEvE;;GAEG;AACU,QAAA,eAAe,GAAG,OAAC,CAAC,IAAI,CAAC,GAAG,EAAE;IACzC,OAAO,OAAC,CAAC,MAAM,CAAC;QACd,IAAI,EAAE,OAAC,CAAC,KAAK,CAAC,gBAAK,CAAC,CAAC,QAAQ,EAAE;QAC/B,KAAK,EAAE,gBAAK,CAAC,QAAQ,EAAE;KACxB,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAUH;;;GAGG;AACU,QAAA,uBAAuB,GAAG,OAAC,CAAC,IAAI,CAAC,GAAG,EAAE;IACjD,OAAO,OAAC;SACL,MAAM,CAAC;QACN,IAAI,EAAE,OAAC,CAAC,KAAK,CAAC,wBAAa,CAAC,CAAC,QAAQ,EAAE;QACvC,KAAK,EAAE,wBAAa,CAAC,QAAQ,EAAE;KAChC,CAAC;SACD,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACpB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;QAClB,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC;KACrB,CAAC,CAAC,CAAC;AACR,CAAC,CAAC,CAAC;AAEH;;;GAGG;AACU,QAAA,sBAAsB,GAAG,OAAC,CAAC,IAAI,CAAC,GAAG,EAAE;IAChD,OAAO,OAAC;SACL,MAAM,CAAC;QACN,IAAI,EAAE,OAAC,CAAC,KAAK,CAAC,uBAAY,CAAC,CAAC,QAAQ,EAAE;QACtC,KAAK,EAAE,uBAAY,CAAC,QAAQ,EAAE;KAC/B,CAAC;SACD,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACpB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;QAClB,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC;KACrB,CAAC,CAAC,CAAC;AACR,CAAC,CAAC,CAAC"}
+{"version":3,"file":"event-collection.js","sourceRoot":"","sources":["../../../../../../src/project-client/services/events/models/event-collection.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB,oDAAkF;AAClF,yCAAuE;AAEvE;;;;GAIG;AACU,QAAA,eAAe,GAAG,OAAC,CAAC,IAAI,CAAC,GAAG,EAAE;IACzC,OAAO,OAAC,CAAC,MAAM,CAAC;QACd,IAAI,EAAE,OAAC,CAAC,KAAK,CAAC,gBAAK,CAAC,CAAC,QAAQ,EAAE;QAC/B,KAAK,EAAE,gBAAK,CAAC,QAAQ,EAAE;KACxB,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAUH;;;;GAIG;AACU,QAAA,uBAAuB,GAAG,OAAC,CAAC,IAAI,CAAC,GAAG,EAAE;IACjD,OAAO,OAAC;SACL,MAAM,CAAC;QACN,IAAI,EAAE,OAAC,CAAC,KAAK,CAAC,wBAAa,CAAC,CAAC,QAAQ,EAAE;QACvC,KAAK,EAAE,wBAAa,CAAC,QAAQ,EAAE;KAChC,CAAC;SACD,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACpB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;QAClB,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC;KACrB,CAAC,CAAC,CAAC;AACR,CAAC,CAAC,CAAC;AAEH;;;;GAIG;AACU,QAAA,sBAAsB,GAAG,OAAC,CAAC,IAAI,CAAC,GAAG,EAAE;IAChD,OAAO,OAAC;SACL,MAAM,CAAC;QACN,IAAI,EAAE,OAAC,CAAC,KAAK,CAAC,uBAAY,CAAC,CAAC,QAAQ,EAAE;QACtC,KAAK,EAAE,uBAAY,CAAC,QAAQ,EAAE;KAC/B,CAAC;SACD,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACpB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;QAClB,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC;KACrB,CAAC,CAAC,CAAC;AACR,CAAC,CAAC,CAAC"}

package/dist/commonjs/project-client/services/events/models/event.d.ts

@@ -1,6 +1,8 @@
 import { z } from 'zod';
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the Event model.
+ * Defines the structure and validation rules for this data type.
+ * This is the shape used in application code - what developers interact with.
  */
 export declare const event: z.ZodLazy<z.ZodObject<{
     code: z.ZodOptional<z.ZodNumber>;
@@ -8,6 +10,7 @@ export declare const event: z.ZodLazy<z.ZodObject<{
     id: z.ZodString;
     level: z.ZodOptional<z.ZodString>;
     log: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    payload: z.ZodNullable<z.ZodOptional<z.ZodAny>>;
     timestamp: z.ZodString;
     type: z.ZodString;
 }, "strip", z.ZodTypeAny, {
@@ -18,6 +21,7 @@ export declare const event: z.ZodLazy<z.ZodObject<{
     context?: any;
     level?: string | undefined;
     log?: string | null | undefined;
+    payload?: any;
 }, {
     type: string;
     id: string;
@@ -26,22 +30,25 @@ export declare const event: z.ZodLazy<z.ZodObject<{
     context?: any;
     level?: string | undefined;
     log?: string | null | undefined;
+    payload?: any;
 }>>;
 /**
  *
  * @typedef  {Event} event
- * @property {number}
- * @property {any}
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
+ * @property {number} - The numeric code that categorizes the event.
+ * @property {any} - Additional contextual attributes for the event.
+ * @property {string} - The unique identifier for the event.
+ * @property {string} - The severity level assigned to the event.
+ * @property {string} - A human-readable log message.
+ * @property {any} - The raw payload delivered by the event source.
+ * @property {string} - The time at which the event was recorded.
+ * @property {string} - The type of event that occurred.
  */
 export type Event = z.infer<typeof event>;
 /**
- * The shape of the model mapping from the api schema into the application shape.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping API responses to the Event application shape.
+ * Handles any property name transformations from the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export declare const eventResponse: z.ZodLazy<z.ZodEffects<z.ZodObject<{
     code: z.ZodOptional<z.ZodNumber>;
@@ -49,6 +56,7 @@ export declare const eventResponse: z.ZodLazy<z.ZodEffects<z.ZodObject<{
     id: z.ZodString;
     level: z.ZodOptional<z.ZodString>;
     log: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    payload: z.ZodNullable<z.ZodOptional<z.ZodAny>>;
     timestamp: z.ZodString;
     type: z.ZodString;
 }, "strip", z.ZodTypeAny, {
@@ -59,6 +67,7 @@ export declare const eventResponse: z.ZodLazy<z.ZodEffects<z.ZodObject<{
     context?: any;
     level?: string | undefined;
     log?: string | null | undefined;
+    payload?: any;
 }, {
     type: string;
     id: string;
@@ -67,12 +76,14 @@ export declare const eventResponse: z.ZodLazy<z.ZodEffects<z.ZodObject<{
     context?: any;
     level?: string | undefined;
     log?: string | null | undefined;
+    payload?: any;
 }>, {
     code: number | undefined;
     context: any;
     id: string;
     level: string | undefined;
     log: string | null | undefined;
+    payload: any;
     timestamp: string;
     type: string;
 }, {
@@ -83,10 +94,12 @@ export declare const eventResponse: z.ZodLazy<z.ZodEffects<z.ZodObject<{
     context?: any;
     level?: string | undefined;
     log?: string | null | undefined;
+    payload?: any;
 }>>;
 /**
- * The shape of the model mapping from the application shape into the api schema.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping the Event application shape to API requests.
+ * Handles any property name transformations required by the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export declare const eventRequest: z.ZodLazy<z.ZodEffects<z.ZodObject<{
     code: z.ZodOptional<z.ZodNumber>;
@@ -94,6 +107,7 @@ export declare const eventRequest: z.ZodLazy<z.ZodEffects<z.ZodObject<{
     id: z.ZodString;
     level: z.ZodOptional<z.ZodString>;
     log: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    payload: z.ZodNullable<z.ZodOptional<z.ZodAny>>;
     timestamp: z.ZodString;
     type: z.ZodString;
 }, "strip", z.ZodTypeAny, {
@@ -104,6 +118,7 @@ export declare const eventRequest: z.ZodLazy<z.ZodEffects<z.ZodObject<{
     context?: any;
     level?: string | undefined;
     log?: string | null | undefined;
+    payload?: any;
 }, {
     type: string;
     id: string;
@@ -112,12 +127,14 @@ export declare const eventRequest: z.ZodLazy<z.ZodEffects<z.ZodObject<{
     context?: any;
     level?: string | undefined;
     log?: string | null | undefined;
+    payload?: any;
 }>, {
     code: number | undefined;
     context: any;
     id: string;
     level: string | undefined;
     log: string | null | undefined;
+    payload: any;
     timestamp: string;
     type: string;
 }, {
@@ -128,5 +145,6 @@ export declare const eventRequest: z.ZodLazy<z.ZodEffects<z.ZodObject<{
     context?: any;
     level?: string | undefined;
     log?: string | null | undefined;
+    payload?: any;
 }>>;
 //# sourceMappingURL=event.d.ts.map

package/dist/commonjs/project-client/services/events/models/event.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"event.d.ts","sourceRoot":"","sources":["../../../../../../src/project-client/services/events/models/event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;;;;;;;;;;GAUhB,CAAC;AAEH;;;;;;;;;;GAUG;AACH,MAAM,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,KAAK,CAAC,CAAC;AAE1C;;;GAGG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoBxB,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoBvB,CAAC"}
+{"version":3,"file":"event.d.ts","sourceRoot":"","sources":["../../../../../../src/project-client/services/events/models/event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;GAIG;AACH,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;GAWhB,CAAC;AAEH;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,KAAK,CAAC,CAAC;AAE1C;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsBxB,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsBvB,CAAC"}

package/dist/commonjs/project-client/services/events/models/event.js

@@ -3,7 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.eventRequest = exports.eventResponse = exports.event = void 0;
 const zod_1 = require("zod");
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the Event model.
+ * Defines the structure and validation rules for this data type.
+ * This is the shape used in application code - what developers interact with.
  */
 exports.event = zod_1.z.lazy(() => {
     return zod_1.z.object({
@@ -12,13 +14,15 @@ exports.event = zod_1.z.lazy(() => {
         id: zod_1.z.string(),
         level: zod_1.z.string().optional(),
         log: zod_1.z.string().optional().nullable(),
+        payload: zod_1.z.any().optional().nullable(),
         timestamp: zod_1.z.string(),
         type: zod_1.z.string(),
     });
 });
 /**
- * The shape of the model mapping from the api schema into the application shape.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping API responses to the Event application shape.
+ * Handles any property name transformations from the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 exports.eventResponse = zod_1.z.lazy(() => {
     return zod_1.z
@@ -28,6 +32,7 @@ exports.eventResponse = zod_1.z.lazy(() => {
         id: zod_1.z.string(),
         level: zod_1.z.string().optional(),
         log: zod_1.z.string().optional().nullable(),
+        payload: zod_1.z.any().optional().nullable(),
         timestamp: zod_1.z.string(),
         type: zod_1.z.string(),
     })
@@ -37,13 +42,15 @@ exports.eventResponse = zod_1.z.lazy(() => {
         id: data['id'],
         level: data['level'],
         log: data['log'],
+        payload: data['payload'],
         timestamp: data['timestamp'],
         type: data['type'],
     }));
 });
 /**
- * The shape of the model mapping from the application shape into the api schema.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping the Event application shape to API requests.
+ * Handles any property name transformations required by the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 exports.eventRequest = zod_1.z.lazy(() => {
     return zod_1.z
@@ -53,6 +60,7 @@ exports.eventRequest = zod_1.z.lazy(() => {
         id: zod_1.z.string(),
         level: zod_1.z.string().optional(),
         log: zod_1.z.string().optional().nullable(),
+        payload: zod_1.z.any().optional().nullable(),
         timestamp: zod_1.z.string(),
         type: zod_1.z.string(),
     })
@@ -62,6 +70,7 @@ exports.eventRequest = zod_1.z.lazy(() => {
         id: data['id'],
         level: data['level'],
         log: data['log'],
+        payload: data['payload'],
         timestamp: data['timestamp'],
         type: data['type'],
     }));

package/dist/commonjs/project-client/services/events/models/event.js.map

@@ -1 +1 @@
-{"version":3,"file":"event.js","sourceRoot":"","sources":["../../../../../../src/project-client/services/events/models/event.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB;;GAEG;AACU,QAAA,KAAK,GAAG,OAAC,CAAC,IAAI,CAAC,GAAG,EAAE;IAC/B,OAAO,OAAC,CAAC,MAAM,CAAC;QACd,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC3B,OAAO,EAAE,OAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;QACtC,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE;QACd,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC5B,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;QACrC,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;QACrB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;KACjB,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAeH;;;GAGG;AACU,QAAA,aAAa,GAAG,OAAC,CAAC,IAAI,CAAC,GAAG,EAAE;IACvC,OAAO,OAAC;SACL,MAAM,CAAC;QACN,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC3B,OAAO,EAAE,OAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;QACtC,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE;QACd,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC5B,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;QACrC,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;QACrB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;KACjB,CAAC;SACD,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACpB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;QAClB,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC;QACxB,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC;QACd,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC;QACpB,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC;QAChB,SAAS,EAAE,IAAI,CAAC,WAAW,CAAC;QAC5B,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;KACnB,CAAC,CAAC,CAAC;AACR,CAAC,CAAC,CAAC;AAEH;;;GAGG;AACU,QAAA,YAAY,GAAG,OAAC,CAAC,IAAI,CAAC,GAAG,EAAE;IACtC,OAAO,OAAC;SACL,MAAM,CAAC;QACN,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC3B,OAAO,EAAE,OAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;QACtC,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE;QACd,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC5B,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;QACrC,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;QACrB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;KACjB,CAAC;SACD,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACpB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;QAClB,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC;QACxB,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC;QACd,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC;QACpB,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC;QAChB,SAAS,EAAE,IAAI,CAAC,WAAW,CAAC;QAC5B,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;KACnB,CAAC,CAAC,CAAC;AACR,CAAC,CAAC,CAAC"}
+{"version":3,"file":"event.js","sourceRoot":"","sources":["../../../../../../src/project-client/services/events/models/event.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB;;;;GAIG;AACU,QAAA,KAAK,GAAG,OAAC,CAAC,IAAI,CAAC,GAAG,EAAE;IAC/B,OAAO,OAAC,CAAC,MAAM,CAAC;QACd,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC3B,OAAO,EAAE,OAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;QACtC,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE;QACd,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC5B,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;QACrC,OAAO,EAAE,OAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;QACtC,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;QACrB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;KACjB,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAgBH;;;;GAIG;AACU,QAAA,aAAa,GAAG,OAAC,CAAC,IAAI,CAAC,GAAG,EAAE;IACvC,OAAO,OAAC;SACL,MAAM,CAAC;QACN,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC3B,OAAO,EAAE,OAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;QACtC,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE;QACd,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC5B,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;QACrC,OAAO,EAAE,OAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;QACtC,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;QACrB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;KACjB,CAAC;SACD,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACpB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;QAClB,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC;QACxB,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC;QACd,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC;QACpB,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC;QAChB,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC;QACxB,SAAS,EAAE,IAAI,CAAC,WAAW,CAAC;QAC5B,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;KACnB,CAAC,CAAC,CAAC;AACR,CAAC,CAAC,CAAC;AAEH;;;;GAIG;AACU,QAAA,YAAY,GAAG,OAAC,CAAC,IAAI,CAAC,GAAG,EAAE;IACtC,OAAO,OAAC;SACL,MAAM,CAAC;QACN,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC3B,OAAO,EAAE,OAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;QACtC,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE;QACd,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC5B,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;QACrC,OAAO,EAAE,OAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;QACtC,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;QACrB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;KACjB,CAAC;SACD,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACpB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;QAClB,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC;QACxB,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC;QACd,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC;QACpB,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC;QAChB,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC;QACxB,SAAS,EAAE,IAAI,CAAC,WAAW,CAAC;QAC5B,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;KACnB,CAAC,CAAC,CAAC;AACR,CAAC,CAAC,CAAC"}

package/dist/commonjs/project-client/services/integrations/integrations-service.d.ts

@@ -34,12 +34,17 @@ import { TwilioConfigPayload } from './models/twilio-config-payload.js';
 import { WebpushConfigCollection } from './models/webpush-config-collection.js';
 import { WebpushConfigPayload } from './models/webpush-config-payload.js';
 import { DeleteApnsIntegrationParams, DeleteEventsourceIntegrationParams, DeleteExpoIntegrationParams, DeleteFcmIntegrationParams, DeleteGithubIntegrationParams, DeleteInboxIntegrationParams, DeleteMagicbellSlackbotIntegrationParams, DeleteMailgunIntegrationParams, DeletePingEmailIntegrationParams, DeleteSendgridIntegrationParams, DeleteSesIntegrationParams, DeleteSlackIntegrationParams, DeleteSmtpIntegrationParams, DeleteStripeIntegrationParams, DeleteTwilioIntegrationParams, DeleteWebPushIntegrationParams, ListIntegrationsParams } from './request-params.js';
+/**
+ * Service class for IntegrationsService operations.
+ * Provides methods to interact with IntegrationsService-related API endpoints.
+ * All methods return promises and handle request/response serialization automatically.
+ */
 export declare class IntegrationsService extends BaseService {
     /**
      * Lists all available and configured integrations for the project. Returns a summary of each integration including its type, status, and basic configuration information.
-     * @param {number} [params.limit] -
-     * @param {string} [params.startingAfter] -
-     * @param {string} [params.endingBefore] -
+     * @param {number} [params.limit] - defines the maximum number of items to return per page (default: 50)
+     * @param {string} [params.startingAfter] - a cursor for use in pagination, points to the last ID in previous page
+     * @param {string} [params.endingBefore] - a cursor for use in pagination, points to the first ID in next page
      * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
      * @returns {Promise<HttpResponse<IntegrationConfigCollection>>} - OK
      */
@@ -58,7 +63,7 @@ export declare class IntegrationsService extends BaseService {
     saveApnsIntegration(body: ApnsConfigPayload, requestConfig?: RequestConfig): Promise<HttpResponse<ApnsConfigPayload>>;
     /**
      * Deletes the APNs integration configuration from the project. This will disable the integration's functionality within the project.
-     * @param {string} [params.id] -
+     * @param {string} [params.id] - the unique identifier of the integration to be deleted
      * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
      * @returns {Promise<HttpResponse<any>>} - No Content
      */
@@ -77,7 +82,7 @@ export declare class IntegrationsService extends BaseService {
     saveEventsourceIntegration(body: EventSourceConfigPayload, requestConfig?: RequestConfig): Promise<HttpResponse<EventSourceConfigPayload>>;
     /**
      * Deletes the EventSource integration configuration from the project. This will disable the integration's functionality within the project.
-     * @param {string} [params.id] -
+     * @param {string} [params.id] - the unique identifier of the integration to be deleted
      * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
      * @returns {Promise<HttpResponse<any>>} - No Content
      */
@@ -96,7 +101,7 @@ export declare class IntegrationsService extends BaseService {
     saveExpoIntegration(body: ExpoConfigPayload, requestConfig?: RequestConfig): Promise<HttpResponse<ExpoConfigPayload>>;
     /**
      * Deletes the Expo integration configuration from the project. This will disable the integration's functionality within the project.
-     * @param {string} [params.id] -
+     * @param {string} [params.id] - the unique identifier of the integration to be deleted
      * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
      * @returns {Promise<HttpResponse<any>>} - No Content
      */
@@ -115,7 +120,7 @@ export declare class IntegrationsService extends BaseService {
     saveFcmIntegration(body: FcmConfigPayload, requestConfig?: RequestConfig): Promise<HttpResponse<FcmConfigPayload>>;
     /**
      * Deletes the FCM integration configuration from the project. This will disable the integration's functionality within the project.
-     * @param {string} [params.id] -
+     * @param {string} [params.id] - the unique identifier of the integration to be deleted
      * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
      * @returns {Promise<HttpResponse<any>>} - No Content
      */
@@ -134,7 +139,7 @@ export declare class IntegrationsService extends BaseService {
     saveGithubIntegration(body: GithubConfigPayload, requestConfig?: RequestConfig): Promise<HttpResponse<GithubConfigPayload>>;
     /**
      * Deletes the GitHub integration configuration from the project. This will disable the integration's functionality within the project.
-     * @param {string} [params.id] -
+     * @param {string} [params.id] - the unique identifier of the integration to be deleted
      * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
      * @returns {Promise<HttpResponse<any>>} - No Content
      */
@@ -153,7 +158,7 @@ export declare class IntegrationsService extends BaseService {
     saveInboxIntegration(body: InboxConfigPayload, requestConfig?: RequestConfig): Promise<HttpResponse<InboxConfigPayload>>;
     /**
      * Deletes the Inbox integration configuration from the project. This will disable the integration's functionality within the project.
-     * @param {string} [params.id] -
+     * @param {string} [params.id] - the unique identifier of the integration to be deleted
      * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
      * @returns {Promise<HttpResponse<any>>} - No Content
      */
@@ -172,7 +177,7 @@ export declare class IntegrationsService extends BaseService {
     saveMagicbellSlackbotIntegration(body: SlackBotConfigPayload, requestConfig?: RequestConfig): Promise<HttpResponse<SlackBotConfigPayload>>;
     /**
      * Deletes the MagicBell SlackBot integration configuration from the project. This will disable the integration's functionality within the project.
-     * @param {string} [params.id] -
+     * @param {string} [params.id] - the unique identifier of the integration to be deleted
      * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
      * @returns {Promise<HttpResponse<any>>} - No Content
      */
@@ -191,7 +196,7 @@ export declare class IntegrationsService extends BaseService {
     saveMailgunIntegration(body: MailgunConfigPayload, requestConfig?: RequestConfig): Promise<HttpResponse<MailgunConfigPayload>>;
     /**
      * Deletes the Mailgun integration configuration from the project. This will disable the integration's functionality within the project.
-     * @param {string} [params.id] -
+     * @param {string} [params.id] - the unique identifier of the integration to be deleted
      * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
      * @returns {Promise<HttpResponse<any>>} - No Content
      */
@@ -210,7 +215,7 @@ export declare class IntegrationsService extends BaseService {
     savePingEmailIntegration(body: PingConfigPayload, requestConfig?: RequestConfig): Promise<HttpResponse<PingConfigPayload>>;
     /**
      * Deletes the Ping Email integration configuration from the project. This will disable the integration's functionality within the project.
-     * @param {string} [params.id] -
+     * @param {string} [params.id] - the unique identifier of the integration to be deleted
      * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
      * @returns {Promise<HttpResponse<any>>} - No Content
      */
@@ -229,7 +234,7 @@ export declare class IntegrationsService extends BaseService {
     saveSendgridIntegration(body: SendgridConfigPayload, requestConfig?: RequestConfig): Promise<HttpResponse<SendgridConfigPayload>>;
     /**
      * Deletes the SendGrid integration configuration from the project. This will disable the integration's functionality within the project.
-     * @param {string} [params.id] -
+     * @param {string} [params.id] - the unique identifier of the integration to be deleted
      * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
      * @returns {Promise<HttpResponse<any>>} - No Content
      */
@@ -248,7 +253,7 @@ export declare class IntegrationsService extends BaseService {
     saveSesIntegration(body: SesConfigPayload, requestConfig?: RequestConfig): Promise<HttpResponse<SesConfigPayload>>;
     /**
      * Deletes the Amazon SES integration configuration from the project. This will disable the integration's functionality within the project.
-     * @param {string} [params.id] -
+     * @param {string} [params.id] - the unique identifier of the integration to be deleted
      * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
      * @returns {Promise<HttpResponse<any>>} - No Content
      */
@@ -267,7 +272,7 @@ export declare class IntegrationsService extends BaseService {
     saveSlackIntegration(body: SlackConfigPayload, requestConfig?: RequestConfig): Promise<HttpResponse<SlackConfigPayload>>;
     /**
      * Deletes the Slack integration configuration from the project. This will disable the integration's functionality within the project.
-     * @param {string} [params.id] -
+     * @param {string} [params.id] - the unique identifier of the integration to be deleted
      * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
      * @returns {Promise<HttpResponse<any>>} - No Content
      */
@@ -286,7 +291,7 @@ export declare class IntegrationsService extends BaseService {
     saveSmtpIntegration(body: SmtpConfig, requestConfig?: RequestConfig): Promise<HttpResponse<SmtpConfig>>;
     /**
      * Deletes the SMTP integration configuration from the project. This will disable the integration's functionality within the project.
-     * @param {string} [params.id] -
+     * @param {string} [params.id] - the unique identifier of the integration to be deleted
      * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
      * @returns {Promise<HttpResponse<any>>} - No Content
      */
@@ -305,7 +310,7 @@ export declare class IntegrationsService extends BaseService {
     saveStripeIntegration(body: StripeConfigPayload, requestConfig?: RequestConfig): Promise<HttpResponse<StripeConfigPayload>>;
     /**
      * Deletes the Stripe integration configuration from the project. This will disable the integration's functionality within the project.
-     * @param {string} [params.id] -
+     * @param {string} [params.id] - the unique identifier of the integration to be deleted
      * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
      * @returns {Promise<HttpResponse<any>>} - No Content
      */
@@ -324,7 +329,7 @@ export declare class IntegrationsService extends BaseService {
     saveTwilioIntegration(body: TwilioConfigPayload, requestConfig?: RequestConfig): Promise<HttpResponse<TwilioConfigPayload>>;
     /**
      * Deletes the Twilio integration configuration from the project. This will disable the integration's functionality within the project.
-     * @param {string} [params.id] -
+     * @param {string} [params.id] - the unique identifier of the integration to be deleted
      * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
      * @returns {Promise<HttpResponse<any>>} - No Content
      */
@@ -343,7 +348,7 @@ export declare class IntegrationsService extends BaseService {
     saveWebPushIntegration(body: WebpushConfigPayload, requestConfig?: RequestConfig): Promise<HttpResponse<WebpushConfigPayload>>;
     /**
      * Deletes the Web Push integration configuration from the project. This will disable the integration's functionality within the project.
-     * @param {string} [params.id] -
+     * @param {string} [params.id] - the unique identifier of the integration to be deleted
      * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
      * @returns {Promise<HttpResponse<any>>} - No Content
      */