@epilot/email-settings-client 0.3.0 → 0.4.1

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.
Files changed (2) hide show
  1. package/dist/openapi.d.ts +47 -11
  2. package/package.json +5 -5
package/dist/openapi.d.ts CHANGED
@@ -16,23 +16,63 @@ declare namespace Components {
16
16
  */
17
17
  domain?: string;
18
18
  }
19
+ /**
20
+ * Setting that allows to add an email address on the custom domain. For e.g; john@doe.com
21
+ */
22
+ export type EmailAddressSetting = "email_address";
23
+ /**
24
+ * Setting that allows to add a custom domain. For e.g; doe.com
25
+ */
26
+ export type EmailDomainSetting = "email_domain";
27
+ /**
28
+ * - Restrict duplicates within:
29
+ * * 10s
30
+ * * 5m
31
+ * * 1d
32
+ * * 5000 // It converts to 5 seconds.When expressed as a numerical value, it will be interpreted as being in milliseconds.
33
+ * - Defaults to 3 minutes
34
+ *
35
+ */
36
+ export type RestrictDuplicatesWithinSetting = "restrict_duplicates_within";
19
37
  export interface Setting {
20
38
  [name: string]: any;
21
39
  id?: string;
22
40
  name?: string;
23
41
  org_id?: string;
24
- /**
25
- * example:
26
- * signature
27
- */
28
- type: "signature" | "email_domain" | "email_address" | "whitelist_email_address";
42
+ type: SettingType;
43
+ value?: string;
29
44
  html?: string;
30
45
  created_at?: string;
31
46
  updated_at?: string;
32
47
  created_by?: string;
33
48
  updated_by?: string;
34
49
  }
50
+ export type SettingType = /* Setting that allows to add a signature. */ SignatureSetting | /* Setting that allows to add a custom domain. For e.g; doe.com */ EmailDomainSetting | /* Setting that allows to add an email address on the custom domain. For e.g; john@doe.com */ EmailAddressSetting | /**
51
+ * - Setting that specifies a list of addresses exempt from being flagged as duplicate emails.
52
+ * - An email will be flagged as a duplicate if it has the same content and is sent to the same recipient within the time frame specified in the RestrictDuplicatesWithinSetting.
53
+ *
54
+ */
55
+ WhitelistEmailAddressSetting | /**
56
+ * - Restrict duplicates within:
57
+ * * 10s
58
+ * * 5m
59
+ * * 1d
60
+ * * 5000 // It converts to 5 seconds.When expressed as a numerical value, it will be interpreted as being in milliseconds.
61
+ * - Defaults to 3 minutes
62
+ *
63
+ */
64
+ RestrictDuplicatesWithinSetting;
35
65
  export type SettingsResponse = Setting[];
66
+ /**
67
+ * Setting that allows to add a signature.
68
+ */
69
+ export type SignatureSetting = "signature";
70
+ /**
71
+ * - Setting that specifies a list of addresses exempt from being flagged as duplicate emails.
72
+ * - An email will be flagged as a duplicate if it has the same content and is sent to the same recipient within the time frame specified in the RestrictDuplicatesWithinSetting.
73
+ *
74
+ */
75
+ export type WhitelistEmailAddressSetting = "whitelist_email_address";
36
76
  }
37
77
  }
38
78
  declare namespace Paths {
@@ -69,11 +109,7 @@ declare namespace Paths {
69
109
  }
70
110
  namespace DeleteSetting {
71
111
  export interface RequestBody {
72
- /**
73
- * example:
74
- * signature
75
- */
76
- type: "signature" | "email_domain" | "email_address" | "whitelist_email_address";
112
+ type: Components.Schemas.SettingType;
77
113
  }
78
114
  namespace Responses {
79
115
  export type $200 = Components.Schemas.Setting;
@@ -86,7 +122,7 @@ declare namespace Paths {
86
122
  namespace GetSettings {
87
123
  namespace Parameters {
88
124
  export type Id = string;
89
- export type Type = "signature" | "email_domain" | "email_address" | "whitelist_email_address";
125
+ export type Type = Components.Schemas.SettingType;
90
126
  }
91
127
  export interface QueryParameters {
92
128
  type: Parameters.Type;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/email-settings-client",
3
- "version": "0.3.0",
3
+ "version": "0.4.1",
4
4
  "description": "API Client for epilot Email Settings API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -43,25 +43,25 @@
43
43
  "author": "epilot GmbH",
44
44
  "license": "UNLICENSED",
45
45
  "peerDependencies": {
46
- "axios": "^0.25.0"
46
+ "axios": "^1.6.2"
47
47
  },
48
48
  "dependencies": {
49
49
  "@dazn/lambda-powertools-correlation-ids": "^1.28.1",
50
50
  "buffer": "^6.0.3",
51
51
  "https-browserify": "^1.0.0",
52
- "openapi-client-axios": "^7.1.3",
52
+ "openapi-client-axios": "^7.5.1",
53
53
  "stream-http": "^3.1.1",
54
54
  "url": "^0.11.0",
55
55
  "util": "^0.12.3"
56
56
  },
57
57
  "devDependencies": {
58
58
  "@types/jest": "^26.0.20",
59
- "axios": "^0.25.0",
59
+ "axios": "^1.6.2",
60
60
  "copy-webpack-plugin": "^7.0.0",
61
61
  "jest": "^26.6.3",
62
62
  "json-loader": "^0.5.7",
63
63
  "openapi-client-axios-typegen": "^7.4.1",
64
- "openapicmd": "^1.16.2",
64
+ "openapicmd": "^2.1.0",
65
65
  "ts-jest": "^26.5.0",
66
66
  "ts-loader": "^8.0.14",
67
67
  "ts-node": "^10.9.1",