@ogcio/building-blocks-sdk 0.2.86 → 0.2.88

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 (35) hide show
  1. package/.azure/pipeline.yaml +15 -14
  2. package/.release-please-manifest.json +1 -1
  3. package/CHANGELOG.md +14 -0
  4. package/biome.jsonc +1 -1
  5. package/dist/client/clients/messaging/index.d.ts.map +1 -1
  6. package/dist/client/clients/messaging/schema.d.ts +167 -0
  7. package/dist/client/clients/messaging/schema.d.ts.map +1 -1
  8. package/dist/client/clients/messaging/support.d.ts +122 -0
  9. package/dist/client/clients/messaging/support.d.ts.map +1 -1
  10. package/dist/client/clients/messaging/support.js +7 -0
  11. package/dist/client/clients/messaging/support.js.map +1 -1
  12. package/dist/client/clients/profile/citizen.d.ts.map +1 -1
  13. package/dist/client/clients/profile/index.d.ts +2 -0
  14. package/dist/client/clients/profile/index.d.ts.map +1 -1
  15. package/dist/client/clients/profile/index.js +3 -0
  16. package/dist/client/clients/profile/index.js.map +1 -1
  17. package/dist/client/clients/profile/organisation.d.ts.map +1 -1
  18. package/dist/client/clients/profile/schema.d.ts +187 -0
  19. package/dist/client/clients/profile/schema.d.ts.map +1 -1
  20. package/dist/client/clients/profile/support.d.ts +146 -0
  21. package/dist/client/clients/profile/support.d.ts.map +1 -0
  22. package/dist/client/clients/profile/support.js +19 -0
  23. package/dist/client/clients/profile/support.js.map +1 -0
  24. package/dist/clients-configurations/read-configuration-file.js +1 -1
  25. package/dist/clients-configurations/read-configuration-file.js.map +1 -1
  26. package/package.json +11 -11
  27. package/renovate.json +51 -0
  28. package/src/client/clients/messaging/open-api-definition.json +337 -0
  29. package/src/client/clients/messaging/schema.ts +167 -0
  30. package/src/client/clients/messaging/support.ts +13 -0
  31. package/src/client/clients/profile/index.ts +7 -0
  32. package/src/client/clients/profile/open-api-definition.json +486 -0
  33. package/src/client/clients/profile/schema.ts +187 -0
  34. package/src/client/clients/profile/support.ts +25 -0
  35. package/src/clients-configurations/read-configuration-file.ts +1 -1
package/dist/client/clients/profile/support.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"support.js","sourceRoot":"","sources":["../../../../src/client/clients/profile/support.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAG1E,MAAM,OAAO,cAAc;IAEN;IACA;IACA;IAHnB,YACmB,MAA8C,EAC9C,WAAmB,EACnB,MAA0B;QAF1B,WAAM,GAAN,MAAM,CAAwC;QAC9C,gBAAW,GAAX,WAAW,CAAQ;QACnB,WAAM,GAAN,MAAM,CAAoB;IAC1C,CAAC;IAEJ,KAAK,CAAC,iBAAiB,CACrB,IAAoG;QAEpG,OAAO,IAAI,CAAC,MAAM;aACf,IAAI,CAAC,iCAAiC,EAAE;YACvC,IAAI;SACL,CAAC;aACD,IAAI,CACH,CAAC,QAAQ,EAAE,EAAE,CAAC,cAAc,CAAC,QAAQ,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,EACrE,CAAC,MAAM,EAAE,EAAE,CAAC,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,CAC/D,CAAC;IACN,CAAC;CACF"}
package/dist/clients-configurations/read-configuration-file.js CHANGED
@@ -27,7 +27,7 @@ function ensureBuildingBlockNameIsValid(bbName) {
27
27
  }
28
28
  export async function readConfigurationFile(configurationFilePath) {
29
29
  const { default: rawConfigurationFile } = await import(configurationFilePath, {
30
- assert: {
30
+ with: {
31
31
  type: "json",
32
32
  },
33
33
  });
package/dist/clients-configurations/read-configuration-file.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"read-configuration-file.js","sourceRoot":"","sources":["../../src/clients-configurations/read-configuration-file.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,IAAI,EAAE,MAAM,SAAS,CAAC;AAC5C,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAEtC,MAAM,CAAN,IAAY,kBAGX;AAHD,WAAY,kBAAkB;IAC5B,mCAAa,CAAA;IACb,mCAAa,CAAA;AACf,CAAC,EAHW,kBAAkB,KAAlB,kBAAkB,QAG7B;AAED,MAAM,gCAAgC,GAAG,IAAI,CAAC,MAAM,CAAC;IACnD,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE;IACnB,oBAAoB,EAAE,IAAI,CAAC,MAAM,EAAE;IACnC,uBAAuB,EAAE,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC;IACtD,kBAAkB,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IAC9D,wBAAwB,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IACpE,iBAAiB,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;CACnD,CAAC,CAAC;AAMH,MAAM,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC;IAClC,cAAc,EAAE,IAAI,CAAC,KAAK,CAAC,gCAAgC,CAAC;CAC7D,CAAC,CAAC;AAMH,SAAS,8BAA8B,CAAC,MAAc;IACpD,oDAAoD;IACpD,uDAAuD;IACvD,qDAAqD;IACrD,wBAAwB;IACxB,MAAM,KAAK,GAAG,cAAc,CAAC;IAC7B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC;QACrB,MAAM,IAAI,KAAK,CACb,mDAAmD,MAAM,eAAe,CACzE,CAAC;AACN,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,qBAA6B;IAE7B,MAAM,EAAE,OAAO,EAAE,oBAAoB,EAAE,GAAG,MAAM,MAAM,CACpD,qBAAqB,EACrB;QACE,MAAM,EAAE;YACN,IAAI,EAAE,MAAM;SACb;KACF,CACF,CAAC;IAEF,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC,eAAe,EAAE,oBAAoB,CAAC,CAAC;IAEtE,8DAA8D;IAC9D,4DAA4D;IAC5D,kDAAkD;IAClD,mDAAmD;IACnD,8BAA8B;IAC9B,MAAM,UAAU,GAAsB,EAAE,cAAc,EAAE,EAAE,EAAE,CAAC;IAC7D,KAAK,MAAM,WAAW,IAAI,UAAU,CAAC,cAAc,EAAE,CAAC;QACpD,8BAA8B,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACjD,UAAU,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC;IAC5D,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC"}
1
+ {"version":3,"file":"read-configuration-file.js","sourceRoot":"","sources":["../../src/clients-configurations/read-configuration-file.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,IAAI,EAAE,MAAM,SAAS,CAAC;AAC5C,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAEtC,MAAM,CAAN,IAAY,kBAGX;AAHD,WAAY,kBAAkB;IAC5B,mCAAa,CAAA;IACb,mCAAa,CAAA;AACf,CAAC,EAHW,kBAAkB,KAAlB,kBAAkB,QAG7B;AAED,MAAM,gCAAgC,GAAG,IAAI,CAAC,MAAM,CAAC;IACnD,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE;IACnB,oBAAoB,EAAE,IAAI,CAAC,MAAM,EAAE;IACnC,uBAAuB,EAAE,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC;IACtD,kBAAkB,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IAC9D,wBAAwB,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IACpE,iBAAiB,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;CACnD,CAAC,CAAC;AAMH,MAAM,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC;IAClC,cAAc,EAAE,IAAI,CAAC,KAAK,CAAC,gCAAgC,CAAC;CAC7D,CAAC,CAAC;AAMH,SAAS,8BAA8B,CAAC,MAAc;IACpD,oDAAoD;IACpD,uDAAuD;IACvD,qDAAqD;IACrD,wBAAwB;IACxB,MAAM,KAAK,GAAG,cAAc,CAAC;IAC7B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC;QACrB,MAAM,IAAI,KAAK,CACb,mDAAmD,MAAM,eAAe,CACzE,CAAC;AACN,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,qBAA6B;IAE7B,MAAM,EAAE,OAAO,EAAE,oBAAoB,EAAE,GAAG,MAAM,MAAM,CACpD,qBAAqB,EACrB;QACE,IAAI,EAAE;YACJ,IAAI,EAAE,MAAM;SACb;KACF,CACF,CAAC;IAEF,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC,eAAe,EAAE,oBAAoB,CAAC,CAAC;IAEtE,8DAA8D;IAC9D,4DAA4D;IAC5D,kDAAkD;IAClD,mDAAmD;IACnD,8BAA8B;IAC9B,MAAM,UAAU,GAAsB,EAAE,cAAc,EAAE,EAAE,EAAE,CAAC;IAC7D,KAAK,MAAM,WAAW,IAAI,UAAU,CAAC,cAAc,EAAE,CAAC;QACpD,8BAA8B,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACjD,UAAU,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC;IAC5D,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC"}
package/package.json CHANGED
@@ -1,31 +1,31 @@
1
1
  {
2
2
  "name": "@ogcio/building-blocks-sdk",
3
- "version": "0.2.86",
3
+ "version": "0.2.88",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/index.d.ts",
6
6
  "type": "module",
7
7
  "dependencies": {
8
- "@ogcio/analytics-sdk": "^0.2.9",
9
- "typebox": "^1.1.4",
8
+ "@ogcio/analytics-sdk": "^0.2.11",
9
+ "typebox": "^1.1.11",
10
10
  "commander": "^14.0.3",
11
11
  "http-errors": "^2.0.1",
12
12
  "openapi-fetch": "^0.17.0",
13
13
  "openapi-typescript": "^7.13.0",
14
14
  "openapi-typescript-helpers": "^0.1.0",
15
15
  "safe-stable-stringify": "^2.5.0",
16
- "yaml": "^2.8.2"
16
+ "yaml": "^2.8.3"
17
17
  },
18
18
  "devDependencies": {
19
- "@biomejs/biome": "2.4.4",
20
- "@commitlint/config-conventional": "^20.4.2",
19
+ "@biomejs/biome": "2.4.10",
20
+ "@commitlint/config-conventional": "^20.5.0",
21
21
  "@types/http-errors": "^2.0.5",
22
- "@types/node": "^25.3.1",
23
- "@vitest/coverage-istanbul": "^4.0.18",
24
- "commitlint": "^20.4.2",
22
+ "@types/node": "^25.5.0",
23
+ "@vitest/coverage-istanbul": "^4.1.2",
24
+ "commitlint": "^20.5.0",
25
25
  "husky": "^9.1.7",
26
26
  "tsx": "^4.21.0",
27
- "typescript": "^5.9.3",
28
- "vitest": "^4.0.18"
27
+ "typescript": "^6.0.2",
28
+ "vitest": "^4.1.2"
29
29
  },
30
30
  "peerDependencies": {
31
31
  "@logto/node": "2.5.5",
package/renovate.json ADDED
@@ -0,0 +1,51 @@
1
+ {
2
+ "$schema": "https://docs.renovatebot.com/renovate-schema.json",
3
+ "extends": [
4
+ "config:recommended",
5
+ ":semanticCommits",
6
+ ":semanticPrefixFixDepsChoreOthers",
7
+ ":prConcurrentLimit10",
8
+ ":maintainLockFilesWeekly",
9
+ ":dependencyDashboard",
10
+ ":ignoreModulesAndTests",
11
+ ":rebaseStalePrs"
12
+ ],
13
+ "schedule": ["at any time"],
14
+ "rangeStrategy": "auto",
15
+ "npm": {
16
+ "enabled": true,
17
+ "postUpdateOptions": ["pnpmDedupe"]
18
+ },
19
+ "azure-pipelines": {
20
+ "enabled": true
21
+ },
22
+ "packageRules": [
23
+ {
24
+ "matchCategories": ["docker"],
25
+ "enabled": true,
26
+ "pinDigests": false
27
+ },
28
+ {
29
+ "matchPackageNames": [
30
+ "@logto/**",
31
+ "@ogcio/design-system-react",
32
+ "@ogcio/theme-govie",
33
+ "@biomejs/biome",
34
+ "next",
35
+ "react",
36
+ "react-dom"
37
+ ],
38
+ "enabled": false
39
+ },
40
+ {
41
+ "matchPackagePatterns": ["*"],
42
+ "matchUpdateTypes": ["minor", "patch"],
43
+ "groupName": "all non-major dependencies",
44
+ "groupSlug": "all-minor-patch"
45
+ }
46
+ ],
47
+ "ignoreDeps": ["husky"],
48
+ "commitBody": "Automated update by Renovate Bot",
49
+ "baseBranches": ["dev"],
50
+ "enabledManagers": ["npm", "dockerfile", "github-actions"]
51
+ }
package/src/client/clients/messaging/open-api-definition.json CHANGED
@@ -6219,6 +6219,343 @@
6219
6219
  }
6220
6220
  }
6221
6221
  }
6222
+ },
6223
+ "/api/v1/support/messages/": {
6224
+ "post": {
6225
+ "operationId": "SupportCreateMessage",
6226
+ "tags": [
6227
+ "Messages"
6228
+ ],
6229
+ "description": "Creates a message",
6230
+ "requestBody": {
6231
+ "required": true,
6232
+ "content": {
6233
+ "application/json": {
6234
+ "schema": {
6235
+ "type": "object",
6236
+ "required": [
6237
+ "preferredTransports",
6238
+ "recipientUserId",
6239
+ "security",
6240
+ "scheduleAt",
6241
+ "message"
6242
+ ],
6243
+ "properties": {
6244
+ "preferredTransports": {
6245
+ "type": "array",
6246
+ "items": {
6247
+ "type": "string",
6248
+ "enum": [
6249
+ "email",
6250
+ "lifeEvent"
6251
+ ],
6252
+ "description": "All the available provider types"
6253
+ },
6254
+ "description": "The list of the preferred transports to use. If the selected transports are not available for the recipient, others will be used"
6255
+ },
6256
+ "recipientUserId": {
6257
+ "type": "string",
6258
+ "description": "Unique user id of the recipient"
6259
+ },
6260
+ "security": {
6261
+ "type": "string",
6262
+ "enum": [
6263
+ "confidential",
6264
+ "public"
6265
+ ],
6266
+ "description": "Confidentiality level of the message"
6267
+ },
6268
+ "scheduleAt": {
6269
+ "type": "string",
6270
+ "format": "date-time",
6271
+ "description": "Date and time of when schedule the message"
6272
+ },
6273
+ "message": {
6274
+ "type": "object",
6275
+ "required": [
6276
+ "subject",
6277
+ "plainText",
6278
+ "language"
6279
+ ],
6280
+ "properties": {
6281
+ "threadName": {
6282
+ "type": "string",
6283
+ "description": "Thread Name used to group messages",
6284
+ "minLength": 1
6285
+ },
6286
+ "subject": {
6287
+ "type": "string",
6288
+ "description": "Subject. This is the only part that will be seen outside of the messaging platform is security is 'confidential'",
6289
+ "minLength": 1
6290
+ },
6291
+ "excerpt": {
6292
+ "type": "string",
6293
+ "description": "Brief description of the message"
6294
+ },
6295
+ "plainText": {
6296
+ "type": "string",
6297
+ "description": "Plain text version of the message",
6298
+ "minLength": 1
6299
+ },
6300
+ "richText": {
6301
+ "type": "string",
6302
+ "description": "Rich text (html) version of the message"
6303
+ },
6304
+ "language": {
6305
+ "type": "string",
6306
+ "enum": [
6307
+ "en",
6308
+ "ga"
6309
+ ],
6310
+ "description": "Language used to send the message"
6311
+ },
6312
+ "externalId": {
6313
+ "type": "string",
6314
+ "description": "External id to link the message to an external system"
6315
+ }
6316
+ }
6317
+ },
6318
+ "attachments": {
6319
+ "type": "array",
6320
+ "items": {
6321
+ "type": "string",
6322
+ "format": "uuid"
6323
+ }
6324
+ }
6325
+ }
6326
+ }
6327
+ }
6328
+ }
6329
+ },
6330
+ "responses": {
6331
+ "201": {
6332
+ "description": "Default Response",
6333
+ "content": {
6334
+ "application/json": {
6335
+ "schema": {
6336
+ "type": "object",
6337
+ "required": [
6338
+ "data"
6339
+ ],
6340
+ "properties": {
6341
+ "data": {
6342
+ "type": "object",
6343
+ "required": [
6344
+ "id"
6345
+ ],
6346
+ "properties": {
6347
+ "id": {
6348
+ "type": "string",
6349
+ "format": "uuid",
6350
+ "description": "Unique Id of the resource"
6351
+ }
6352
+ }
6353
+ },
6354
+ "metadata": {
6355
+ "type": "object",
6356
+ "properties": {
6357
+ "links": {
6358
+ "type": "object",
6359
+ "required": [
6360
+ "self",
6361
+ "first",
6362
+ "last",
6363
+ "pages"
6364
+ ],
6365
+ "properties": {
6366
+ "self": {
6367
+ "type": "object",
6368
+ "properties": {
6369
+ "href": {
6370
+ "type": "string",
6371
+ "description": "URL pointing to the request itself"
6372
+ }
6373
+ }
6374
+ },
6375
+ "next": {
6376
+ "type": "object",
6377
+ "properties": {
6378
+ "href": {
6379
+ "type": "string",
6380
+ "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted"
6381
+ }
6382
+ }
6383
+ },
6384
+ "prev": {
6385
+ "type": "object",
6386
+ "properties": {
6387
+ "href": {
6388
+ "type": "string",
6389
+ "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted"
6390
+ }
6391
+ }
6392
+ },
6393
+ "first": {
6394
+ "type": "object",
6395
+ "properties": {
6396
+ "href": {
6397
+ "type": "string",
6398
+ "description": "URL pointing to the first page of results in a paginated response"
6399
+ }
6400
+ }
6401
+ },
6402
+ "last": {
6403
+ "type": "object",
6404
+ "properties": {
6405
+ "href": {
6406
+ "type": "string",
6407
+ "description": "URL pointing to the first page of results in a paginated response"
6408
+ }
6409
+ }
6410
+ },
6411
+ "pages": {
6412
+ "type": "object",
6413
+ "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
6414
+ "additionalProperties": {
6415
+ "type": "object",
6416
+ "properties": {
6417
+ "href": {
6418
+ "type": "string"
6419
+ }
6420
+ }
6421
+ }
6422
+ }
6423
+ },
6424
+ "description": "Object containing the links to the related endpoints"
6425
+ },
6426
+ "totalCount": {
6427
+ "type": "number",
6428
+ "description": "Number representing the total number of available items"
6429
+ }
6430
+ }
6431
+ }
6432
+ }
6433
+ }
6434
+ }
6435
+ }
6436
+ },
6437
+ "4XX": {
6438
+ "description": "Default Response",
6439
+ "content": {
6440
+ "application/json": {
6441
+ "schema": {
6442
+ "type": "object",
6443
+ "required": [
6444
+ "code",
6445
+ "detail",
6446
+ "requestId",
6447
+ "name",
6448
+ "statusCode"
6449
+ ],
6450
+ "properties": {
6451
+ "code": {
6452
+ "type": "string",
6453
+ "description": "Code used to categorize the error"
6454
+ },
6455
+ "detail": {
6456
+ "type": "string",
6457
+ "description": "Description of the error"
6458
+ },
6459
+ "requestId": {
6460
+ "type": "string",
6461
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
6462
+ },
6463
+ "name": {
6464
+ "type": "string",
6465
+ "description": "Name of the error type"
6466
+ },
6467
+ "validation": {
6468
+ "type": "array",
6469
+ "items": {
6470
+ "type": "object",
6471
+ "required": [
6472
+ "fieldName",
6473
+ "message"
6474
+ ],
6475
+ "properties": {
6476
+ "fieldName": {
6477
+ "type": "string"
6478
+ },
6479
+ "message": {
6480
+ "type": "string"
6481
+ }
6482
+ }
6483
+ },
6484
+ "description": "List of the validation errors"
6485
+ },
6486
+ "validationContext": {
6487
+ "type": "string"
6488
+ },
6489
+ "statusCode": {
6490
+ "type": "number"
6491
+ }
6492
+ }
6493
+ }
6494
+ }
6495
+ }
6496
+ },
6497
+ "5XX": {
6498
+ "description": "Default Response",
6499
+ "content": {
6500
+ "application/json": {
6501
+ "schema": {
6502
+ "type": "object",
6503
+ "required": [
6504
+ "code",
6505
+ "detail",
6506
+ "requestId",
6507
+ "name",
6508
+ "statusCode"
6509
+ ],
6510
+ "properties": {
6511
+ "code": {
6512
+ "type": "string",
6513
+ "description": "Code used to categorize the error"
6514
+ },
6515
+ "detail": {
6516
+ "type": "string",
6517
+ "description": "Description of the error"
6518
+ },
6519
+ "requestId": {
6520
+ "type": "string",
6521
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
6522
+ },
6523
+ "name": {
6524
+ "type": "string",
6525
+ "description": "Name of the error type"
6526
+ },
6527
+ "validation": {
6528
+ "type": "array",
6529
+ "items": {
6530
+ "type": "object",
6531
+ "required": [
6532
+ "fieldName",
6533
+ "message"
6534
+ ],
6535
+ "properties": {
6536
+ "fieldName": {
6537
+ "type": "string"
6538
+ },
6539
+ "message": {
6540
+ "type": "string"
6541
+ }
6542
+ }
6543
+ },
6544
+ "description": "List of the validation errors"
6545
+ },
6546
+ "validationContext": {
6547
+ "type": "string"
6548
+ },
6549
+ "statusCode": {
6550
+ "type": "number"
6551
+ }
6552
+ }
6553
+ }
6554
+ }
6555
+ }
6556
+ }
6557
+ }
6558
+ }
6222
6559
  }
6223
6560
  },
6224
6561
  "security": [
package/src/client/clients/messaging/schema.ts CHANGED
@@ -934,6 +934,23 @@ export interface paths {
934
934
  patch?: never;
935
935
  trace?: never;
936
936
  };
937
+ "/api/v1/support/messages/": {
938
+ parameters: {
939
+ query?: never;
940
+ header?: never;
941
+ path?: never;
942
+ cookie?: never;
943
+ };
944
+ get?: never;
945
+ put?: never;
946
+ /** @description Creates a message */
947
+ post: operations["SupportCreateMessage"];
948
+ delete?: never;
949
+ options?: never;
950
+ head?: never;
951
+ patch?: never;
952
+ trace?: never;
953
+ };
937
954
  }
938
955
  export type webhooks = Record<string, never>;
939
956
  export interface components {
@@ -2833,4 +2850,154 @@ export interface operations {
2833
2850
  };
2834
2851
  };
2835
2852
  };
2853
+ SupportCreateMessage: {
2854
+ parameters: {
2855
+ query?: never;
2856
+ header?: never;
2857
+ path?: never;
2858
+ cookie?: never;
2859
+ };
2860
+ requestBody: {
2861
+ content: {
2862
+ "application/json": {
2863
+ /** @description The list of the preferred transports to use. If the selected transports are not available for the recipient, others will be used */
2864
+ preferredTransports: ("email" | "lifeEvent")[];
2865
+ /** @description Unique user id of the recipient */
2866
+ recipientUserId: string;
2867
+ /**
2868
+ * @description Confidentiality level of the message
2869
+ * @enum {string}
2870
+ */
2871
+ security: "confidential" | "public";
2872
+ /**
2873
+ * Format: date-time
2874
+ * @description Date and time of when schedule the message
2875
+ */
2876
+ scheduleAt: string;
2877
+ message: {
2878
+ /** @description Thread Name used to group messages */
2879
+ threadName?: string;
2880
+ /** @description Subject. This is the only part that will be seen outside of the messaging platform is security is 'confidential' */
2881
+ subject: string;
2882
+ /** @description Brief description of the message */
2883
+ excerpt?: string;
2884
+ /** @description Plain text version of the message */
2885
+ plainText: string;
2886
+ /** @description Rich text (html) version of the message */
2887
+ richText?: string;
2888
+ /**
2889
+ * @description Language used to send the message
2890
+ * @enum {string}
2891
+ */
2892
+ language: "en" | "ga";
2893
+ /** @description External id to link the message to an external system */
2894
+ externalId?: string;
2895
+ };
2896
+ attachments?: string[];
2897
+ };
2898
+ };
2899
+ };
2900
+ responses: {
2901
+ /** @description Default Response */
2902
+ 201: {
2903
+ headers: {
2904
+ [name: string]: unknown;
2905
+ };
2906
+ content: {
2907
+ "application/json": {
2908
+ data: {
2909
+ /**
2910
+ * Format: uuid
2911
+ * @description Unique Id of the resource
2912
+ */
2913
+ id: string;
2914
+ };
2915
+ metadata?: {
2916
+ /** @description Object containing the links to the related endpoints */
2917
+ links?: {
2918
+ self: {
2919
+ /** @description URL pointing to the request itself */
2920
+ href?: string;
2921
+ };
2922
+ next?: {
2923
+ /** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
2924
+ href?: string;
2925
+ };
2926
+ prev?: {
2927
+ /** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
2928
+ href?: string;
2929
+ };
2930
+ first: {
2931
+ /** @description URL pointing to the first page of results in a paginated response */
2932
+ href?: string;
2933
+ };
2934
+ last: {
2935
+ /** @description URL pointing to the first page of results in a paginated response */
2936
+ href?: string;
2937
+ };
2938
+ /** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */
2939
+ pages: {
2940
+ [key: string]: {
2941
+ href?: string;
2942
+ };
2943
+ };
2944
+ };
2945
+ /** @description Number representing the total number of available items */
2946
+ totalCount?: number;
2947
+ };
2948
+ };
2949
+ };
2950
+ };
2951
+ /** @description Default Response */
2952
+ "4XX": {
2953
+ headers: {
2954
+ [name: string]: unknown;
2955
+ };
2956
+ content: {
2957
+ "application/json": {
2958
+ /** @description Code used to categorize the error */
2959
+ code: string;
2960
+ /** @description Description of the error */
2961
+ detail: string;
2962
+ /** @description Unique request id. This one will be used to troubleshoot the problems */
2963
+ requestId: string;
2964
+ /** @description Name of the error type */
2965
+ name: string;
2966
+ /** @description List of the validation errors */
2967
+ validation?: {
2968
+ fieldName: string;
2969
+ message: string;
2970
+ }[];
2971
+ validationContext?: string;
2972
+ statusCode: number;
2973
+ };
2974
+ };
2975
+ };
2976
+ /** @description Default Response */
2977
+ "5XX": {
2978
+ headers: {
2979
+ [name: string]: unknown;
2980
+ };
2981
+ content: {
2982
+ "application/json": {
2983
+ /** @description Code used to categorize the error */
2984
+ code: string;
2985
+ /** @description Description of the error */
2986
+ detail: string;
2987
+ /** @description Unique request id. This one will be used to troubleshoot the problems */
2988
+ requestId: string;
2989
+ /** @description Name of the error type */
2990
+ name: string;
2991
+ /** @description List of the validation errors */
2992
+ validation?: {
2993
+ fieldName: string;
2994
+ message: string;
2995
+ }[];
2996
+ validationContext?: string;
2997
+ statusCode: number;
2998
+ };
2999
+ };
3000
+ };
3001
+ };
3002
+ };
2836
3003
  }
package/src/client/clients/messaging/support.ts CHANGED
@@ -24,4 +24,17 @@ export class MessagingSupport {
24
24
  (reason) => formatError(reason, this.serviceName, this.logger),
25
25
  );
26
26
  }
27
+
28
+ async send(
29
+ body: paths["/api/v1/support/messages/"]["post"]["requestBody"]["content"]["application/json"],
30
+ ) {
31
+ return this.client
32
+ .POST("/api/v1/support/messages/", {
33
+ body,
34
+ })
35
+ .then(
36
+ (response) => formatResponse(response, this.serviceName, this.logger),
37
+ (reason) => formatError(reason, this.serviceName, this.logger),
38
+ );
39
+ }
27
40
  }