@novu/api 0.0.1-alpha.52 → 0.0.1-alpha.53

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/config.d.ts CHANGED
@@ -27,8 +27,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
27
27
  export declare const SDK_METADATA: {
28
28
  readonly language: "typescript";
29
29
  readonly openapiDocVersion: "1.0";
30
- readonly sdkVersion: "0.0.1-alpha.52";
30
+ readonly sdkVersion: "0.0.1-alpha.53";
31
31
  readonly genVersion: "2.470.1";
32
- readonly userAgent: "speakeasy-sdk/typescript 0.0.1-alpha.52 2.470.1 1.0 @novu/api";
32
+ readonly userAgent: "speakeasy-sdk/typescript 0.0.1-alpha.53 2.470.1 1.0 @novu/api";
33
33
  };
34
34
  //# sourceMappingURL=config.d.ts.map
package/lib/config.js CHANGED
@@ -30,8 +30,8 @@ exports.serverURLFromOptions = serverURLFromOptions;
30
30
  exports.SDK_METADATA = {
31
31
  language: "typescript",
32
32
  openapiDocVersion: "1.0",
33
- sdkVersion: "0.0.1-alpha.52",
33
+ sdkVersion: "0.0.1-alpha.53",
34
34
  genVersion: "2.470.1",
35
- userAgent: "speakeasy-sdk/typescript 0.0.1-alpha.52 2.470.1 1.0 @novu/api",
35
+ userAgent: "speakeasy-sdk/typescript 0.0.1-alpha.53 2.470.1 1.0 @novu/api",
36
36
  };
37
37
  //# sourceMappingURL=config.js.map
@@ -4,6 +4,9 @@ import { Result as SafeParseResult } from "../../types/fp.js";
4
4
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
5
5
  import { CredentialsDto, CredentialsDto$Outbound } from "./credentialsdto.js";
6
6
  import { StepFilter, StepFilter$Outbound } from "./stepfilter.js";
7
+ /**
8
+ * The channel type for the integration
9
+ */
7
10
  export declare const CreateIntegrationRequestDtoChannel: {
8
11
  readonly InApp: "in_app";
9
12
  readonly Email: "email";
@@ -11,19 +14,46 @@ export declare const CreateIntegrationRequestDtoChannel: {
11
14
  readonly Chat: "chat";
12
15
  readonly Push: "push";
13
16
  };
17
+ /**
18
+ * The channel type for the integration
19
+ */
14
20
  export type CreateIntegrationRequestDtoChannel = ClosedEnum<typeof CreateIntegrationRequestDtoChannel>;
15
21
  export type CreateIntegrationRequestDto = {
22
+ /**
23
+ * The name of the integration
24
+ */
16
25
  name?: string | undefined;
26
+ /**
27
+ * The unique identifier for the integration
28
+ */
17
29
  identifier?: string | undefined;
30
+ /**
31
+ * The ID of the associated environment
32
+ */
18
33
  environmentId?: string | undefined;
34
+ /**
35
+ * The provider ID for the integration
36
+ */
19
37
  providerId: string;
38
+ /**
39
+ * The channel type for the integration
40
+ */
20
41
  channel: CreateIntegrationRequestDtoChannel;
42
+ /**
43
+ * The credentials for the integration
44
+ */
21
45
  credentials?: CredentialsDto | undefined;
22
46
  /**
23
- * If the integration is active the validation on the credentials field will run
47
+ * If the integration is active, the validation on the credentials field will run
24
48
  */
25
49
  active?: boolean | undefined;
50
+ /**
51
+ * Flag to check the integration status
52
+ */
26
53
  check?: boolean | undefined;
54
+ /**
55
+ * Conditions for the integration
56
+ */
27
57
  conditions?: Array<StepFilter> | undefined;
28
58
  };
29
59
  /** @internal */
@@ -1 +1 @@
1
- {"version":3,"file":"createintegrationrequestdto.d.ts","sourceRoot":"","sources":["../../src/models/components/createintegrationrequestdto.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAGzB,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EACL,cAAc,EAEd,uBAAuB,EAExB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,UAAU,EAEV,mBAAmB,EAEpB,MAAM,iBAAiB,CAAC;AAEzB,eAAO,MAAM,kCAAkC;;;;;;CAMrC,CAAC;AACX,MAAM,MAAM,kCAAkC,GAAG,UAAU,CACzD,OAAO,kCAAkC,CAC1C,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,kCAAkC,CAAC;IAC5C,WAAW,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;IACzC;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7B,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC5B,UAAU,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC;CAC5C,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,gDAAgD,EAAE,CAAC,CAAC,aAAa,CAC5E,OAAO,kCAAkC,CACS,CAAC;AAErD,gBAAgB;AAChB,eAAO,MAAM,iDAAiD,EAAE,CAAC,CAAC,aAAa,CAC7E,OAAO,kCAAkC,CACS,CAAC;AAErD;;;GAGG;AACH,yBAAiB,mCAAmC,CAAC;IACnD,kFAAkF;IAC3E,MAAM,aAAa;;;;;;MAAmD,CAAC;IAC9E,mFAAmF;IAC5E,MAAM,cAAc;;;;;;MACwB,CAAC;CACrD;AAED,gBAAgB;AAChB,eAAO,MAAM,yCAAyC,EAAE,CAAC,CAAC,OAAO,CAC/D,2BAA2B,EAC3B,CAAC,CAAC,UAAU,EACZ,OAAO,CAeP,CAAC;AAEH,gBAAgB;AAChB,MAAM,MAAM,oCAAoC,GAAG;IACjD,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,uBAAuB,GAAG,SAAS,CAAC;IAClD,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7B,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC5B,UAAU,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,GAAG,SAAS,CAAC;CACrD,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,0CAA0C,EAAE,CAAC,CAAC,OAAO,CAChE,oCAAoC,EACpC,CAAC,CAAC,UAAU,EACZ,2BAA2B,CAe3B,CAAC;AAEH;;;GAGG;AACH,yBAAiB,4BAA4B,CAAC;IAC5C,2EAA2E;IACpE,MAAM,aAAa,+DAA4C,CAAC;IACvE,4EAA4E;IACrE,MAAM,cAAc,4FAA6C,CAAC;IACzE,sEAAsE;IACtE,KAAY,QAAQ,GAAG,oCAAoC,CAAC;CAC7D;AAED,wBAAgB,iCAAiC,CAC/C,2BAA2B,EAAE,2BAA2B,GACvD,MAAM,CAMR;AAED,wBAAgB,mCAAmC,CACjD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,2BAA2B,EAAE,kBAAkB,CAAC,CAMlE"}
1
+ {"version":3,"file":"createintegrationrequestdto.d.ts","sourceRoot":"","sources":["../../src/models/components/createintegrationrequestdto.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAGzB,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EACL,cAAc,EAEd,uBAAuB,EAExB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,UAAU,EAEV,mBAAmB,EAEpB,MAAM,iBAAiB,CAAC;AAEzB;;GAEG;AACH,eAAO,MAAM,kCAAkC;;;;;;CAMrC,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAAG,UAAU,CACzD,OAAO,kCAAkC,CAC1C,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,EAAE,kCAAkC,CAAC;IAC5C;;OAEG;IACH,WAAW,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;IACzC;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC;CAC5C,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,gDAAgD,EAAE,CAAC,CAAC,aAAa,CAC5E,OAAO,kCAAkC,CACS,CAAC;AAErD,gBAAgB;AAChB,eAAO,MAAM,iDAAiD,EAAE,CAAC,CAAC,aAAa,CAC7E,OAAO,kCAAkC,CACS,CAAC;AAErD;;;GAGG;AACH,yBAAiB,mCAAmC,CAAC;IACnD,kFAAkF;IAC3E,MAAM,aAAa;;;;;;MAAmD,CAAC;IAC9E,mFAAmF;IAC5E,MAAM,cAAc;;;;;;MACwB,CAAC;CACrD;AAED,gBAAgB;AAChB,eAAO,MAAM,yCAAyC,EAAE,CAAC,CAAC,OAAO,CAC/D,2BAA2B,EAC3B,CAAC,CAAC,UAAU,EACZ,OAAO,CAeP,CAAC;AAEH,gBAAgB;AAChB,MAAM,MAAM,oCAAoC,GAAG;IACjD,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,uBAAuB,GAAG,SAAS,CAAC;IAClD,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7B,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC5B,UAAU,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,GAAG,SAAS,CAAC;CACrD,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,0CAA0C,EAAE,CAAC,CAAC,OAAO,CAChE,oCAAoC,EACpC,CAAC,CAAC,UAAU,EACZ,2BAA2B,CAe3B,CAAC;AAEH;;;GAGG;AACH,yBAAiB,4BAA4B,CAAC;IAC5C,2EAA2E;IACpE,MAAM,aAAa,+DAA4C,CAAC;IACvE,4EAA4E;IACrE,MAAM,cAAc,4FAA6C,CAAC;IACzE,sEAAsE;IACtE,KAAY,QAAQ,GAAG,oCAAoC,CAAC;CAC7D;AAED,wBAAgB,iCAAiC,CAC/C,2BAA2B,EAAE,2BAA2B,GACvD,MAAM,CAMR;AAED,wBAAgB,mCAAmC,CACjD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,2BAA2B,EAAE,kBAAkB,CAAC,CAMlE"}
@@ -32,6 +32,9 @@ const primitives_js_1 = require("../../lib/primitives.js");
32
32
  const schemas_js_1 = require("../../lib/schemas.js");
33
33
  const credentialsdto_js_1 = require("./credentialsdto.js");
34
34
  const stepfilter_js_1 = require("./stepfilter.js");
35
+ /**
36
+ * The channel type for the integration
37
+ */
35
38
  exports.CreateIntegrationRequestDtoChannel = {
36
39
  InApp: "in_app",
37
40
  Email: "email",
@@ -1 +1 @@
1
- {"version":3,"file":"createintegrationrequestdto.js","sourceRoot":"","sources":["../../src/models/components/createintegrationrequestdto.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,uCAAyB;AACzB,2DAA0D;AAC1D,qDAAiD;AAIjD,2DAK6B;AAC7B,mDAKyB;AAEZ,QAAA,kCAAkC,GAAG;IAChD,KAAK,EAAE,QAAQ;IACf,KAAK,EAAE,OAAO;IACd,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;CACJ,CAAC;AAoBX,gBAAgB;AACH,QAAA,gDAAgD,GAEzD,CAAC,CAAC,UAAU,CAAC,0CAAkC,CAAC,CAAC;AAErD,gBAAgB;AACH,QAAA,iDAAiD,GAE1D,wDAAgD,CAAC;AAErD;;;GAGG;AACH,IAAiB,mCAAmC,CAMnD;AAND,WAAiB,mCAAmC;IAClD,kFAAkF;IACrE,iDAAa,GAAG,wDAAgD,CAAC;IAC9E,mFAAmF;IACtE,kDAAc,GACzB,yDAAiD,CAAC;AACtD,CAAC,EANgB,mCAAmC,mDAAnC,mCAAmC,QAMnD;AAED,gBAAgB;AACH,QAAA,yCAAyC,GAIlD,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,OAAO,EAAE,wDAAgD;IACzD,WAAW,EAAE,gDAA4B,CAAC,QAAQ,EAAE;IACpD,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC9B,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC7B,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,wCAAwB,CAAC,CAAC,QAAQ,EAAE;CACzD,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,gBAAgB,EAAE,eAAe;KAClC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAeH,gBAAgB;AACH,QAAA,0CAA0C,GAInD,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,OAAO,EAAE,yDAAiD;IAC1D,WAAW,EAAE,iDAA6B,CAAC,QAAQ,EAAE;IACrD,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC9B,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC7B,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,yCAAyB,CAAC,CAAC,QAAQ,EAAE;CAC1D,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,aAAa,EAAE,gBAAgB;KAChC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH;;;GAGG;AACH,IAAiB,4BAA4B,CAO5C;AAPD,WAAiB,4BAA4B;IAC3C,2EAA2E;IAC9D,0CAAa,GAAG,iDAAyC,CAAC;IACvE,4EAA4E;IAC/D,2CAAc,GAAG,kDAA0C,CAAC;AAG3E,CAAC,EAPgB,4BAA4B,4CAA5B,4BAA4B,QAO5C;AAED,SAAgB,iCAAiC,CAC/C,2BAAwD;IAExD,OAAO,IAAI,CAAC,SAAS,CACnB,kDAA0C,CAAC,KAAK,CAC9C,2BAA2B,CAC5B,CACF,CAAC;AACJ,CAAC;AARD,8EAQC;AAED,SAAgB,mCAAmC,CACjD,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,iDAAyC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACrE,yDAAyD,CAC1D,CAAC;AACJ,CAAC;AARD,kFAQC"}
1
+ {"version":3,"file":"createintegrationrequestdto.js","sourceRoot":"","sources":["../../src/models/components/createintegrationrequestdto.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,uCAAyB;AACzB,2DAA0D;AAC1D,qDAAiD;AAIjD,2DAK6B;AAC7B,mDAKyB;AAEzB;;GAEG;AACU,QAAA,kCAAkC,GAAG;IAChD,KAAK,EAAE,QAAQ;IACf,KAAK,EAAE,OAAO;IACd,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;CACJ,CAAC;AA+CX,gBAAgB;AACH,QAAA,gDAAgD,GAEzD,CAAC,CAAC,UAAU,CAAC,0CAAkC,CAAC,CAAC;AAErD,gBAAgB;AACH,QAAA,iDAAiD,GAE1D,wDAAgD,CAAC;AAErD;;;GAGG;AACH,IAAiB,mCAAmC,CAMnD;AAND,WAAiB,mCAAmC;IAClD,kFAAkF;IACrE,iDAAa,GAAG,wDAAgD,CAAC;IAC9E,mFAAmF;IACtE,kDAAc,GACzB,yDAAiD,CAAC;AACtD,CAAC,EANgB,mCAAmC,mDAAnC,mCAAmC,QAMnD;AAED,gBAAgB;AACH,QAAA,yCAAyC,GAIlD,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,OAAO,EAAE,wDAAgD;IACzD,WAAW,EAAE,gDAA4B,CAAC,QAAQ,EAAE;IACpD,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC9B,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC7B,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,wCAAwB,CAAC,CAAC,QAAQ,EAAE;CACzD,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,gBAAgB,EAAE,eAAe;KAClC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAeH,gBAAgB;AACH,QAAA,0CAA0C,GAInD,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,OAAO,EAAE,yDAAiD;IAC1D,WAAW,EAAE,iDAA6B,CAAC,QAAQ,EAAE;IACrD,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC9B,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC7B,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,yCAAyB,CAAC,CAAC,QAAQ,EAAE;CAC1D,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,aAAa,EAAE,gBAAgB;KAChC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH;;;GAGG;AACH,IAAiB,4BAA4B,CAO5C;AAPD,WAAiB,4BAA4B;IAC3C,2EAA2E;IAC9D,0CAAa,GAAG,iDAAyC,CAAC;IACvE,4EAA4E;IAC/D,2CAAc,GAAG,kDAA0C,CAAC;AAG3E,CAAC,EAPgB,4BAA4B,4CAA5B,4BAA4B,QAO5C;AAED,SAAgB,iCAAiC,CAC/C,2BAAwD;IAExD,OAAO,IAAI,CAAC,SAAS,CACnB,kDAA0C,CAAC,KAAK,CAC9C,2BAA2B,CAC5B,CACF,CAAC;AACJ,CAAC;AARD,8EAQC;AAED,SAAgB,mCAAmC,CACjD,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,iDAAyC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACrE,yDAAyD,CAC1D,CAAC;AACJ,CAAC;AARD,kFAQC"}
@@ -4,6 +4,9 @@ import { Result as SafeParseResult } from "../../types/fp.js";
4
4
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
5
5
  import { CredentialsDto, CredentialsDto$Outbound } from "./credentialsdto.js";
6
6
  import { StepFilter, StepFilter$Outbound } from "./stepfilter.js";
7
+ /**
8
+ * The channel type for the integration, which defines how the integration communicates (e.g., email, SMS).
9
+ */
7
10
  export declare const IntegrationResponseDtoChannel: {
8
11
  readonly InApp: "in_app";
9
12
  readonly Email: "email";
@@ -11,21 +14,66 @@ export declare const IntegrationResponseDtoChannel: {
11
14
  readonly Chat: "chat";
12
15
  readonly Push: "push";
13
16
  };
17
+ /**
18
+ * The channel type for the integration, which defines how the integration communicates (e.g., email, SMS).
19
+ */
14
20
  export type IntegrationResponseDtoChannel = ClosedEnum<typeof IntegrationResponseDtoChannel>;
15
21
  export type IntegrationResponseDto = {
22
+ /**
23
+ * The unique identifier of the integration record in the database. This is automatically generated.
24
+ */
16
25
  id?: string | undefined;
26
+ /**
27
+ * The unique identifier for the environment associated with this integration. This links to the Environment collection.
28
+ */
17
29
  environmentId: string;
30
+ /**
31
+ * The unique identifier for the organization that owns this integration. This links to the Organization collection.
32
+ */
18
33
  organizationId: string;
34
+ /**
35
+ * The name of the integration, which is used to identify it in the user interface.
36
+ */
19
37
  name: string;
38
+ /**
39
+ * A unique string identifier for the integration, often used for API calls or internal references.
40
+ */
20
41
  identifier: string;
42
+ /**
43
+ * The identifier for the provider of the integration (e.g., "mailgun", "twilio").
44
+ */
21
45
  providerId: string;
46
+ /**
47
+ * The channel type for the integration, which defines how the integration communicates (e.g., email, SMS).
48
+ */
22
49
  channel: IntegrationResponseDtoChannel;
50
+ /**
51
+ * The credentials required for the integration to function, including API keys and other sensitive information.
52
+ */
23
53
  credentials: CredentialsDto;
54
+ /**
55
+ * Indicates whether the integration is currently active. An active integration will process events and messages.
56
+ */
24
57
  active: boolean;
58
+ /**
59
+ * Indicates whether the integration has been marked as deleted (soft delete).
60
+ */
25
61
  deleted: boolean;
26
- deletedAt: string;
27
- deletedBy: string;
62
+ /**
63
+ * The timestamp indicating when the integration was deleted. This is set when the integration is soft deleted.
64
+ */
65
+ deletedAt?: string | undefined;
66
+ /**
67
+ * The identifier of the user who performed the deletion of this integration. Useful for audit trails.
68
+ */
69
+ deletedBy?: string | undefined;
70
+ /**
71
+ * Indicates whether this integration is marked as primary. A primary integration is often the default choice for processing.
72
+ */
28
73
  primary: boolean;
74
+ /**
75
+ * An array of conditions associated with the integration that may influence its behavior or processing logic.
76
+ */
29
77
  conditions?: Array<StepFilter> | undefined;
30
78
  };
31
79
  /** @internal */
@@ -68,8 +116,8 @@ export type IntegrationResponseDto$Outbound = {
68
116
  credentials: CredentialsDto$Outbound;
69
117
  active: boolean;
70
118
  deleted: boolean;
71
- deletedAt: string;
72
- deletedBy: string;
119
+ deletedAt?: string | undefined;
120
+ deletedBy?: string | undefined;
73
121
  primary: boolean;
74
122
  conditions?: Array<StepFilter$Outbound> | undefined;
75
123
  };
@@ -1 +1 @@
1
- {"version":3,"file":"integrationresponsedto.d.ts","sourceRoot":"","sources":["../../src/models/components/integrationresponsedto.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAGzB,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EACL,cAAc,EAEd,uBAAuB,EAExB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,UAAU,EAEV,mBAAmB,EAEpB,MAAM,iBAAiB,CAAC;AAEzB,eAAO,MAAM,6BAA6B;;;;;;CAMhC,CAAC;AACX,MAAM,MAAM,6BAA6B,GAAG,UAAU,CACpD,OAAO,6BAA6B,CACrC,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,6BAA6B,CAAC;IACvC,WAAW,EAAE,cAAc,CAAC;IAC5B,MAAM,EAAE,OAAO,CAAC;IAChB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC;CAC5C,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,2CAA2C,EAAE,CAAC,CAAC,aAAa,CACvE,OAAO,6BAA6B,CACS,CAAC;AAEhD,gBAAgB;AAChB,eAAO,MAAM,4CAA4C,EAAE,CAAC,CAAC,aAAa,CACxE,OAAO,6BAA6B,CACS,CAAC;AAEhD;;;GAGG;AACH,yBAAiB,8BAA8B,CAAC;IAC9C,6EAA6E;IACtE,MAAM,aAAa;;;;;;MAA8C,CAAC;IACzE,8EAA8E;IACvE,MAAM,cAAc;;;;;;MAA+C,CAAC;CAC5E;AAED,gBAAgB;AAChB,eAAO,MAAM,oCAAoC,EAAE,CAAC,CAAC,OAAO,CAC1D,sBAAsB,EACtB,CAAC,CAAC,UAAU,EACZ,OAAO,CAsBP,CAAC;AAEH,gBAAgB;AAChB,MAAM,MAAM,+BAA+B,GAAG;IAC5C,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,uBAAuB,CAAC;IACrC,MAAM,EAAE,OAAO,CAAC;IAChB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,GAAG,SAAS,CAAC;CACrD,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,qCAAqC,EAAE,CAAC,CAAC,OAAO,CAC3D,+BAA+B,EAC/B,CAAC,CAAC,UAAU,EACZ,sBAAsB,CAsBtB,CAAC;AAEH;;;GAGG;AACH,yBAAiB,uBAAuB,CAAC;IACvC,sEAAsE;IAC/D,MAAM,aAAa,0DAAuC,CAAC;IAClE,uEAAuE;IAChE,MAAM,cAAc,kFAAwC,CAAC;IACpE,iEAAiE;IACjE,KAAY,QAAQ,GAAG,+BAA+B,CAAC;CACxD;AAED,wBAAgB,4BAA4B,CAC1C,sBAAsB,EAAE,sBAAsB,GAC7C,MAAM,CAIR;AAED,wBAAgB,8BAA8B,CAC5C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,sBAAsB,EAAE,kBAAkB,CAAC,CAM7D"}
1
+ {"version":3,"file":"integrationresponsedto.d.ts","sourceRoot":"","sources":["../../src/models/components/integrationresponsedto.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAGzB,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EACL,cAAc,EAEd,uBAAuB,EAExB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,UAAU,EAEV,mBAAmB,EAEpB,MAAM,iBAAiB,CAAC;AAEzB;;GAEG;AACH,eAAO,MAAM,6BAA6B;;;;;;CAMhC,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,UAAU,CACpD,OAAO,6BAA6B,CACrC,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,EAAE,6BAA6B,CAAC;IACvC;;OAEG;IACH,WAAW,EAAE,cAAc,CAAC;IAC5B;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC;CAC5C,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,2CAA2C,EAAE,CAAC,CAAC,aAAa,CACvE,OAAO,6BAA6B,CACS,CAAC;AAEhD,gBAAgB;AAChB,eAAO,MAAM,4CAA4C,EAAE,CAAC,CAAC,aAAa,CACxE,OAAO,6BAA6B,CACS,CAAC;AAEhD;;;GAGG;AACH,yBAAiB,8BAA8B,CAAC;IAC9C,6EAA6E;IACtE,MAAM,aAAa;;;;;;MAA8C,CAAC;IACzE,8EAA8E;IACvE,MAAM,cAAc;;;;;;MAA+C,CAAC;CAC5E;AAED,gBAAgB;AAChB,eAAO,MAAM,oCAAoC,EAAE,CAAC,CAAC,OAAO,CAC1D,sBAAsB,EACtB,CAAC,CAAC,UAAU,EACZ,OAAO,CAsBP,CAAC;AAEH,gBAAgB;AAChB,MAAM,MAAM,+BAA+B,GAAG;IAC5C,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,uBAAuB,CAAC;IACrC,MAAM,EAAE,OAAO,CAAC;IAChB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,GAAG,SAAS,CAAC;CACrD,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,qCAAqC,EAAE,CAAC,CAAC,OAAO,CAC3D,+BAA+B,EAC/B,CAAC,CAAC,UAAU,EACZ,sBAAsB,CAsBtB,CAAC;AAEH;;;GAGG;AACH,yBAAiB,uBAAuB,CAAC;IACvC,sEAAsE;IAC/D,MAAM,aAAa,0DAAuC,CAAC;IAClE,uEAAuE;IAChE,MAAM,cAAc,kFAAwC,CAAC;IACpE,iEAAiE;IACjE,KAAY,QAAQ,GAAG,+BAA+B,CAAC;CACxD;AAED,wBAAgB,4BAA4B,CAC1C,sBAAsB,EAAE,sBAAsB,GAC7C,MAAM,CAIR;AAED,wBAAgB,8BAA8B,CAC5C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,sBAAsB,EAAE,kBAAkB,CAAC,CAM7D"}
@@ -32,6 +32,9 @@ const primitives_js_1 = require("../../lib/primitives.js");
32
32
  const schemas_js_1 = require("../../lib/schemas.js");
33
33
  const credentialsdto_js_1 = require("./credentialsdto.js");
34
34
  const stepfilter_js_1 = require("./stepfilter.js");
35
+ /**
36
+ * The channel type for the integration, which defines how the integration communicates (e.g., email, SMS).
37
+ */
35
38
  exports.IntegrationResponseDtoChannel = {
36
39
  InApp: "in_app",
37
40
  Email: "email",
@@ -66,8 +69,8 @@ exports.IntegrationResponseDto$inboundSchema = z.object({
66
69
  credentials: credentialsdto_js_1.CredentialsDto$inboundSchema,
67
70
  active: z.boolean(),
68
71
  deleted: z.boolean(),
69
- deletedAt: z.string(),
70
- deletedBy: z.string(),
72
+ deletedAt: z.string().optional(),
73
+ deletedBy: z.string().optional(),
71
74
  primary: z.boolean(),
72
75
  conditions: z.array(stepfilter_js_1.StepFilter$inboundSchema).optional(),
73
76
  }).transform((v) => {
@@ -89,8 +92,8 @@ exports.IntegrationResponseDto$outboundSchema = z.object({
89
92
  credentials: credentialsdto_js_1.CredentialsDto$outboundSchema,
90
93
  active: z.boolean(),
91
94
  deleted: z.boolean(),
92
- deletedAt: z.string(),
93
- deletedBy: z.string(),
95
+ deletedAt: z.string().optional(),
96
+ deletedBy: z.string().optional(),
94
97
  primary: z.boolean(),
95
98
  conditions: z.array(stepfilter_js_1.StepFilter$outboundSchema).optional(),
96
99
  }).transform((v) => {
@@ -1 +1 @@
1
- {"version":3,"file":"integrationresponsedto.js","sourceRoot":"","sources":["../../src/models/components/integrationresponsedto.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,uCAAyB;AACzB,2DAA0D;AAC1D,qDAAiD;AAIjD,2DAK6B;AAC7B,mDAKyB;AAEZ,QAAA,6BAA6B,GAAG;IAC3C,KAAK,EAAE,QAAQ;IACf,KAAK,EAAE,OAAO;IACd,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;CACJ,CAAC;AAsBX,gBAAgB;AACH,QAAA,2CAA2C,GAEpD,CAAC,CAAC,UAAU,CAAC,qCAA6B,CAAC,CAAC;AAEhD,gBAAgB;AACH,QAAA,4CAA4C,GAErD,mDAA2C,CAAC;AAEhD;;;GAGG;AACH,IAAiB,8BAA8B,CAK9C;AALD,WAAiB,8BAA8B;IAC7C,6EAA6E;IAChE,4CAAa,GAAG,mDAA2C,CAAC;IACzE,8EAA8E;IACjE,6CAAc,GAAG,oDAA4C,CAAC;AAC7E,CAAC,EALgB,8BAA8B,8CAA9B,8BAA8B,QAK9C;AAED,gBAAgB;AACH,QAAA,oCAAoC,GAI7C,CAAC,CAAC,MAAM,CAAC;IACX,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1B,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE;IAC3B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,OAAO,EAAE,mDAA2C;IACpD,WAAW,EAAE,gDAA4B;IACzC,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE;IACnB,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,wCAAwB,CAAC,CAAC,QAAQ,EAAE;CACzD,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,KAAK,EAAE,IAAI;QACX,gBAAgB,EAAE,eAAe;QACjC,iBAAiB,EAAE,gBAAgB;KACpC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAoBH,gBAAgB;AACH,QAAA,qCAAqC,GAI9C,CAAC,CAAC,MAAM,CAAC;IACX,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE;IACzB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,OAAO,EAAE,oDAA4C;IACrD,WAAW,EAAE,iDAA6B;IAC1C,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE;IACnB,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,yCAAyB,CAAC,CAAC,QAAQ,EAAE;CAC1D,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,EAAE,EAAE,KAAK;QACT,aAAa,EAAE,gBAAgB;QAC/B,cAAc,EAAE,iBAAiB;KAClC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH;;;GAGG;AACH,IAAiB,uBAAuB,CAOvC;AAPD,WAAiB,uBAAuB;IACtC,sEAAsE;IACzD,qCAAa,GAAG,4CAAoC,CAAC;IAClE,uEAAuE;IAC1D,sCAAc,GAAG,6CAAqC,CAAC;AAGtE,CAAC,EAPgB,uBAAuB,uCAAvB,uBAAuB,QAOvC;AAED,SAAgB,4BAA4B,CAC1C,sBAA8C;IAE9C,OAAO,IAAI,CAAC,SAAS,CACnB,6CAAqC,CAAC,KAAK,CAAC,sBAAsB,CAAC,CACpE,CAAC;AACJ,CAAC;AAND,oEAMC;AAED,SAAgB,8BAA8B,CAC5C,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,4CAAoC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAChE,oDAAoD,CACrD,CAAC;AACJ,CAAC;AARD,wEAQC"}
1
+ {"version":3,"file":"integrationresponsedto.js","sourceRoot":"","sources":["../../src/models/components/integrationresponsedto.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,uCAAyB;AACzB,2DAA0D;AAC1D,qDAAiD;AAIjD,2DAK6B;AAC7B,mDAKyB;AAEzB;;GAEG;AACU,QAAA,6BAA6B,GAAG;IAC3C,KAAK,EAAE,QAAQ;IACf,KAAK,EAAE,OAAO;IACd,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;CACJ,CAAC;AAmEX,gBAAgB;AACH,QAAA,2CAA2C,GAEpD,CAAC,CAAC,UAAU,CAAC,qCAA6B,CAAC,CAAC;AAEhD,gBAAgB;AACH,QAAA,4CAA4C,GAErD,mDAA2C,CAAC;AAEhD;;;GAGG;AACH,IAAiB,8BAA8B,CAK9C;AALD,WAAiB,8BAA8B;IAC7C,6EAA6E;IAChE,4CAAa,GAAG,mDAA2C,CAAC;IACzE,8EAA8E;IACjE,6CAAc,GAAG,oDAA4C,CAAC;AAC7E,CAAC,EALgB,8BAA8B,8CAA9B,8BAA8B,QAK9C;AAED,gBAAgB;AACH,QAAA,oCAAoC,GAI7C,CAAC,CAAC,MAAM,CAAC;IACX,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1B,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE;IAC3B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,OAAO,EAAE,mDAA2C;IACpD,WAAW,EAAE,gDAA4B;IACzC,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE;IACnB,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,wCAAwB,CAAC,CAAC,QAAQ,EAAE;CACzD,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,KAAK,EAAE,IAAI;QACX,gBAAgB,EAAE,eAAe;QACjC,iBAAiB,EAAE,gBAAgB;KACpC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAoBH,gBAAgB;AACH,QAAA,qCAAqC,GAI9C,CAAC,CAAC,MAAM,CAAC;IACX,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE;IACzB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,OAAO,EAAE,oDAA4C;IACrD,WAAW,EAAE,iDAA6B;IAC1C,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE;IACnB,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,yCAAyB,CAAC,CAAC,QAAQ,EAAE;CAC1D,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,EAAE,EAAE,KAAK;QACT,aAAa,EAAE,gBAAgB;QAC/B,cAAc,EAAE,iBAAiB;KAClC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH;;;GAGG;AACH,IAAiB,uBAAuB,CAOvC;AAPD,WAAiB,uBAAuB;IACtC,sEAAsE;IACzD,qCAAa,GAAG,4CAAoC,CAAC;IAClE,uEAAuE;IAC1D,sCAAc,GAAG,6CAAqC,CAAC;AAGtE,CAAC,EAPgB,uBAAuB,uCAAvB,uBAAuB,QAOvC;AAED,SAAgB,4BAA4B,CAC1C,sBAA8C;IAE9C,OAAO,IAAI,CAAC,SAAS,CACnB,6CAAqC,CAAC,KAAK,CAAC,sBAAsB,CAAC,CACpE,CAAC;AACJ,CAAC;AAND,oEAMC;AAED,SAAgB,8BAA8B,CAC5C,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,4CAAoC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAChE,oDAAoD,CACrD,CAAC;AACJ,CAAC;AARD,wEAQC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@novu/api",
3
- "version": "0.0.1-alpha.52",
3
+ "version": "0.0.1-alpha.53",
4
4
  "author": "Novu",
5
5
  "main": "./index.js",
6
6
  "sideEffects": false,
package/src/lib/config.ts CHANGED
@@ -55,7 +55,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
55
55
  export const SDK_METADATA = {
56
56
  language: "typescript",
57
57
  openapiDocVersion: "1.0",
58
- sdkVersion: "0.0.1-alpha.52",
58
+ sdkVersion: "0.0.1-alpha.53",
59
59
  genVersion: "2.470.1",
60
- userAgent: "speakeasy-sdk/typescript 0.0.1-alpha.52 2.470.1 1.0 @novu/api",
60
+ userAgent: "speakeasy-sdk/typescript 0.0.1-alpha.53 2.470.1 1.0 @novu/api",
61
61
  } as const;
@@ -21,6 +21,9 @@ import {
21
21
  StepFilter$outboundSchema,
22
22
  } from "./stepfilter.js";
23
23
 
24
+ /**
25
+ * The channel type for the integration
26
+ */
24
27
  export const CreateIntegrationRequestDtoChannel = {
25
28
  InApp: "in_app",
26
29
  Email: "email",
@@ -28,22 +31,49 @@ export const CreateIntegrationRequestDtoChannel = {
28
31
  Chat: "chat",
29
32
  Push: "push",
30
33
  } as const;
34
+ /**
35
+ * The channel type for the integration
36
+ */
31
37
  export type CreateIntegrationRequestDtoChannel = ClosedEnum<
32
38
  typeof CreateIntegrationRequestDtoChannel
33
39
  >;
34
40
 
35
41
  export type CreateIntegrationRequestDto = {
42
+ /**
43
+ * The name of the integration
44
+ */
36
45
  name?: string | undefined;
46
+ /**
47
+ * The unique identifier for the integration
48
+ */
37
49
  identifier?: string | undefined;
50
+ /**
51
+ * The ID of the associated environment
52
+ */
38
53
  environmentId?: string | undefined;
54
+ /**
55
+ * The provider ID for the integration
56
+ */
39
57
  providerId: string;
58
+ /**
59
+ * The channel type for the integration
60
+ */
40
61
  channel: CreateIntegrationRequestDtoChannel;
62
+ /**
63
+ * The credentials for the integration
64
+ */
41
65
  credentials?: CredentialsDto | undefined;
42
66
  /**
43
- * If the integration is active the validation on the credentials field will run
67
+ * If the integration is active, the validation on the credentials field will run
44
68
  */
45
69
  active?: boolean | undefined;
70
+ /**
71
+ * Flag to check the integration status
72
+ */
46
73
  check?: boolean | undefined;
74
+ /**
75
+ * Conditions for the integration
76
+ */
47
77
  conditions?: Array<StepFilter> | undefined;
48
78
  };
49
79
 
@@ -21,6 +21,9 @@ import {
21
21
  StepFilter$outboundSchema,
22
22
  } from "./stepfilter.js";
23
23
 
24
+ /**
25
+ * The channel type for the integration, which defines how the integration communicates (e.g., email, SMS).
26
+ */
24
27
  export const IntegrationResponseDtoChannel = {
25
28
  InApp: "in_app",
26
29
  Email: "email",
@@ -28,24 +31,69 @@ export const IntegrationResponseDtoChannel = {
28
31
  Chat: "chat",
29
32
  Push: "push",
30
33
  } as const;
34
+ /**
35
+ * The channel type for the integration, which defines how the integration communicates (e.g., email, SMS).
36
+ */
31
37
  export type IntegrationResponseDtoChannel = ClosedEnum<
32
38
  typeof IntegrationResponseDtoChannel
33
39
  >;
34
40
 
35
41
  export type IntegrationResponseDto = {
42
+ /**
43
+ * The unique identifier of the integration record in the database. This is automatically generated.
44
+ */
36
45
  id?: string | undefined;
46
+ /**
47
+ * The unique identifier for the environment associated with this integration. This links to the Environment collection.
48
+ */
37
49
  environmentId: string;
50
+ /**
51
+ * The unique identifier for the organization that owns this integration. This links to the Organization collection.
52
+ */
38
53
  organizationId: string;
54
+ /**
55
+ * The name of the integration, which is used to identify it in the user interface.
56
+ */
39
57
  name: string;
58
+ /**
59
+ * A unique string identifier for the integration, often used for API calls or internal references.
60
+ */
40
61
  identifier: string;
62
+ /**
63
+ * The identifier for the provider of the integration (e.g., "mailgun", "twilio").
64
+ */
41
65
  providerId: string;
66
+ /**
67
+ * The channel type for the integration, which defines how the integration communicates (e.g., email, SMS).
68
+ */
42
69
  channel: IntegrationResponseDtoChannel;
70
+ /**
71
+ * The credentials required for the integration to function, including API keys and other sensitive information.
72
+ */
43
73
  credentials: CredentialsDto;
74
+ /**
75
+ * Indicates whether the integration is currently active. An active integration will process events and messages.
76
+ */
44
77
  active: boolean;
78
+ /**
79
+ * Indicates whether the integration has been marked as deleted (soft delete).
80
+ */
45
81
  deleted: boolean;
46
- deletedAt: string;
47
- deletedBy: string;
82
+ /**
83
+ * The timestamp indicating when the integration was deleted. This is set when the integration is soft deleted.
84
+ */
85
+ deletedAt?: string | undefined;
86
+ /**
87
+ * The identifier of the user who performed the deletion of this integration. Useful for audit trails.
88
+ */
89
+ deletedBy?: string | undefined;
90
+ /**
91
+ * Indicates whether this integration is marked as primary. A primary integration is often the default choice for processing.
92
+ */
48
93
  primary: boolean;
94
+ /**
95
+ * An array of conditions associated with the integration that may influence its behavior or processing logic.
96
+ */
49
97
  conditions?: Array<StepFilter> | undefined;
50
98
  };
51
99
 
@@ -86,8 +134,8 @@ export const IntegrationResponseDto$inboundSchema: z.ZodType<
86
134
  credentials: CredentialsDto$inboundSchema,
87
135
  active: z.boolean(),
88
136
  deleted: z.boolean(),
89
- deletedAt: z.string(),
90
- deletedBy: z.string(),
137
+ deletedAt: z.string().optional(),
138
+ deletedBy: z.string().optional(),
91
139
  primary: z.boolean(),
92
140
  conditions: z.array(StepFilter$inboundSchema).optional(),
93
141
  }).transform((v) => {
@@ -110,8 +158,8 @@ export type IntegrationResponseDto$Outbound = {
110
158
  credentials: CredentialsDto$Outbound;
111
159
  active: boolean;
112
160
  deleted: boolean;
113
- deletedAt: string;
114
- deletedBy: string;
161
+ deletedAt?: string | undefined;
162
+ deletedBy?: string | undefined;
115
163
  primary: boolean;
116
164
  conditions?: Array<StepFilter$Outbound> | undefined;
117
165
  };
@@ -132,8 +180,8 @@ export const IntegrationResponseDto$outboundSchema: z.ZodType<
132
180
  credentials: CredentialsDto$outboundSchema,
133
181
  active: z.boolean(),
134
182
  deleted: z.boolean(),
135
- deletedAt: z.string(),
136
- deletedBy: z.string(),
183
+ deletedAt: z.string().optional(),
184
+ deletedBy: z.string().optional(),
137
185
  primary: z.boolean(),
138
186
  conditions: z.array(StepFilter$outboundSchema).optional(),
139
187
  }).transform((v) => {