@digdir/dialogporten-schema 1.116.0 → 1.117.1-c564f79

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@digdir/dialogporten-schema",
3
- "version": "1.116.0",
3
+ "version": "1.117.1-c564f79",
4
4
  "description": "GraphQl schema and OpenAPI spec for Dialogporten",
5
5
  "engines": {
6
6
  "node": "24"
@@ -213,8 +213,18 @@ type Dialog {
213
213
  dialogToken: String
214
214
  "The aggregated status of the dialog."
215
215
  status: DialogStatus!
216
- "Indicates whether the dialog contains content that has not been viewed or opened by the user yet."
217
- hasUnopenedContent: Boolean! @deprecated(reason: "Use IsContentSeen instead. See the new field's description for an explanation of the new behavior.")
216
+ """
217
+ Whether the service owner has not yet reported all dialog Transmissions they sent as seen by the end user.
218
+ A Transmission is considered "sent from the service owner" if the DialogTransmissionType is not one of Submission or Correction.
219
+ The value of this field is:
220
+ - true when there are any new unopened Transmissions sent from the service owner.
221
+ - false when the service owner has created an Activity of type TransmissionOpened for all Transmissions sent from the service owner. The Activities must each contain the relevant Id for all relevant Transmissions.
222
+ Note that the value is
223
+ - determined by the service owner and not to be confused with IsContentSeen
224
+ - not affected by SystemLabels
225
+ For correspondence: HasUnopenedContent is still true until the service owner also adds a Dialog level Activity (no transmission id) of type CorrespondenceOpened
226
+ """
227
+ hasUnopenedContent: Boolean!
218
228
  "The number of transmissions sent by the service owner"
219
229
  fromServiceOwnerTransmissionsCount: Int!
220
230
  "The number of transmissions sent by a party representative"
@@ -235,7 +245,14 @@ type Dialog {
235
245
  seenSinceLastUpdate: [SeenLog!]!
236
246
  "The list of seen log entries for the dialog newer than the dialog ContentUpdatedAt date."
237
247
  seenSinceLastContentUpdate: [SeenLog!]!
238
- "A dialog is considered seen if it has been retrieved by a user since its last content update, and there is no SystemLabel MarkedAsUnopened"
248
+ """
249
+ Indicates whether a dialog has been seen since its last content update.
250
+ The value of this field is
251
+ - true if the dialog has been retrieved since its last content update by either GET /enduser/dialogs/{dialogId} or GET /serviceowner/dialogs/{dialogId}?EndUserId={userId} and there is no SystemLabel MarkedAsUnopened
252
+ - false if there is a SystemLabel MarkedAsUnopened, even if the dialog has been seen since its last content update
253
+ - false after the dialog receives a content update.
254
+ Note that the value is determined by Dialogporten and not to be confused with HasUnopenedContent
255
+ """
239
256
  isContentSeen: Boolean!
240
257
  "The immutable list of transmissions associated with the dialog."
241
258
  transmissions: [Transmission!]!
@@ -442,8 +459,18 @@ type SearchDialog {
442
459
  dueAt: DateTime
443
460
  "The aggregated status of the dialog."
444
461
  status: DialogStatus!
445
- "Indicates whether the dialog contains content that has not been viewed or opened by the user yet."
446
- hasUnopenedContent: Boolean! @deprecated(reason: "Use IsContentSeen instead. See the new field's description for an explanation of the new behavior.")
462
+ """
463
+ Whether the service owner has not yet reported all dialog Transmissions they sent as seen by the end user.
464
+ A Transmission is considered "sent from the service owner" if the DialogTransmissionType is not one of Submission or Correction.
465
+ The value of this field is:
466
+ - true when there are any new unopened Transmissions sent from the service owner.
467
+ - false when the service owner has created an Activity of type TransmissionOpened for all Transmissions sent from the service owner. The Activities must each contain the relevant Id for all relevant Transmissions.
468
+ Note that the value is
469
+ - determined by the service owner and not to be confused with IsContentSeen
470
+ - not affected by SystemLabels
471
+ For correspondence: HasUnopenedContent is still true until the service owner also adds a Dialog level Activity (no transmission id) of type CorrespondenceOpened
472
+ """
473
+ hasUnopenedContent: Boolean!
447
474
  "Indicates if this dialog is intended for API consumption only and should not be shown in frontends aimed at humans."
448
475
  isApiOnly: Boolean!
449
476
  "The number of transmissions sent by the service owner"
@@ -458,7 +485,14 @@ type SearchDialog {
458
485
  seenSinceLastUpdate: [SeenLog!]!
459
486
  "The list of seen log entries for the dialog newer than the dialog ContentUpdatedAt date."
460
487
  seenSinceLastContentUpdate: [SeenLog!]!
461
- "A dialog is considered seen if it has been retrieved by a user since its last content update, and there is no SystemLabel MarkedAsUnopened"
488
+ """
489
+ Indicates whether a dialog has been seen since its last content update.
490
+ The value of this field is
491
+ - true if the dialog has been retrieved since its last content update by either GET /enduser/dialogs/{dialogId} or GET /serviceowner/dialogs/{dialogId}?EndUserId={userId} and there is no SystemLabel MarkedAsUnopened
492
+ - false if there is a SystemLabel MarkedAsUnopened, even if the dialog has been seen since its last content update
493
+ - false after the dialog receives a content update.
494
+ Note that the value is determined by Dialogporten and not to be confused with HasUnopenedContent
495
+ """
462
496
  isContentSeen: Boolean!
463
497
  "Metadata about the dialog owned by end-users."
464
498
  endUserContext: EndUserContext!
@@ -860,4 +894,4 @@ scalar DateTime @specifiedBy(url: "https:\/\/www.graphql-scalars.com\/date-time"
860
894
 
861
895
  scalar URL @specifiedBy(url: "https:\/\/tools.ietf.org\/html\/rfc3986")
862
896
 
863
- scalar UUID @specifiedBy(url: "https:\/\/tools.ietf.org\/html\/rfc4122")
897
+ scalar UUID @specifiedBy(url: "https:\/\/tools.ietf.org\/html\/rfc4122")
package/src/index.js CHANGED
@@ -213,8 +213,18 @@ type Dialog {
213
213
  dialogToken: String
214
214
  "The aggregated status of the dialog."
215
215
  status: DialogStatus!
216
- "Indicates whether the dialog contains content that has not been viewed or opened by the user yet."
217
- hasUnopenedContent: Boolean! @deprecated(reason: "Use IsContentSeen instead. See the new field's description for an explanation of the new behavior.")
216
+ """
217
+ Whether the service owner has not yet reported all dialog Transmissions they sent as seen by the end user.
218
+ A Transmission is considered "sent from the service owner" if the DialogTransmissionType is not one of Submission or Correction.
219
+ The value of this field is:
220
+ - true when there are any new unopened Transmissions sent from the service owner.
221
+ - false when the service owner has created an Activity of type TransmissionOpened for all Transmissions sent from the service owner. The Activities must each contain the relevant Id for all relevant Transmissions.
222
+ Note that the value is
223
+ - determined by the service owner and not to be confused with IsContentSeen
224
+ - not affected by SystemLabels
225
+ For correspondence: HasUnopenedContent is still true until the service owner also adds a Dialog level Activity (no transmission id) of type CorrespondenceOpened
226
+ """
227
+ hasUnopenedContent: Boolean!
218
228
  "The number of transmissions sent by the service owner"
219
229
  fromServiceOwnerTransmissionsCount: Int!
220
230
  "The number of transmissions sent by a party representative"
@@ -235,7 +245,14 @@ type Dialog {
235
245
  seenSinceLastUpdate: [SeenLog!]!
236
246
  "The list of seen log entries for the dialog newer than the dialog ContentUpdatedAt date."
237
247
  seenSinceLastContentUpdate: [SeenLog!]!
238
- "A dialog is considered seen if it has been retrieved by a user since its last content update, and there is no SystemLabel MarkedAsUnopened"
248
+ """
249
+ Indicates whether a dialog has been seen since its last content update.
250
+ The value of this field is
251
+ - true if the dialog has been retrieved since its last content update by either GET /enduser/dialogs/{dialogId} or GET /serviceowner/dialogs/{dialogId}?EndUserId={userId} and there is no SystemLabel MarkedAsUnopened
252
+ - false if there is a SystemLabel MarkedAsUnopened, even if the dialog has been seen since its last content update
253
+ - false after the dialog receives a content update.
254
+ Note that the value is determined by Dialogporten and not to be confused with HasUnopenedContent
255
+ """
239
256
  isContentSeen: Boolean!
240
257
  "The immutable list of transmissions associated with the dialog."
241
258
  transmissions: [Transmission!]!
@@ -442,8 +459,18 @@ type SearchDialog {
442
459
  dueAt: DateTime
443
460
  "The aggregated status of the dialog."
444
461
  status: DialogStatus!
445
- "Indicates whether the dialog contains content that has not been viewed or opened by the user yet."
446
- hasUnopenedContent: Boolean! @deprecated(reason: "Use IsContentSeen instead. See the new field's description for an explanation of the new behavior.")
462
+ """
463
+ Whether the service owner has not yet reported all dialog Transmissions they sent as seen by the end user.
464
+ A Transmission is considered "sent from the service owner" if the DialogTransmissionType is not one of Submission or Correction.
465
+ The value of this field is:
466
+ - true when there are any new unopened Transmissions sent from the service owner.
467
+ - false when the service owner has created an Activity of type TransmissionOpened for all Transmissions sent from the service owner. The Activities must each contain the relevant Id for all relevant Transmissions.
468
+ Note that the value is
469
+ - determined by the service owner and not to be confused with IsContentSeen
470
+ - not affected by SystemLabels
471
+ For correspondence: HasUnopenedContent is still true until the service owner also adds a Dialog level Activity (no transmission id) of type CorrespondenceOpened
472
+ """
473
+ hasUnopenedContent: Boolean!
447
474
  "Indicates if this dialog is intended for API consumption only and should not be shown in frontends aimed at humans."
448
475
  isApiOnly: Boolean!
449
476
  "The number of transmissions sent by the service owner"
@@ -458,7 +485,14 @@ type SearchDialog {
458
485
  seenSinceLastUpdate: [SeenLog!]!
459
486
  "The list of seen log entries for the dialog newer than the dialog ContentUpdatedAt date."
460
487
  seenSinceLastContentUpdate: [SeenLog!]!
461
- "A dialog is considered seen if it has been retrieved by a user since its last content update, and there is no SystemLabel MarkedAsUnopened"
488
+ """
489
+ Indicates whether a dialog has been seen since its last content update.
490
+ The value of this field is
491
+ - true if the dialog has been retrieved since its last content update by either GET /enduser/dialogs/{dialogId} or GET /serviceowner/dialogs/{dialogId}?EndUserId={userId} and there is no SystemLabel MarkedAsUnopened
492
+ - false if there is a SystemLabel MarkedAsUnopened, even if the dialog has been seen since its last content update
493
+ - false after the dialog receives a content update.
494
+ Note that the value is determined by Dialogporten and not to be confused with HasUnopenedContent
495
+ """
462
496
  isContentSeen: Boolean!
463
497
  "Metadata about the dialog owned by end-users."
464
498
  endUserContext: EndUserContext!
@@ -916,10 +916,8 @@
916
916
  "type": "array"
917
917
  },
918
918
  "hasUnopenedContent": {
919
- "deprecated": true,
920
- "description": "Indicates whether the dialog contains content that has not been viewed or opened by the user yet.",
921
- "type": "boolean",
922
- "x-deprecatedMessage": "Use IsContentSeen instead. See the new field\u0027s description for an explanation of the new behavior."
919
+ "description": "Whether the service owner has not yet reported all dialog Transmissions they sent as seen by the end user.\nA Transmission is considered \u0022sent from the service owner\u0022 if the DialogTransmissionType is not one of Submission or Correction.\n \nThe value of this field is:\n- true when there are any new unopened Transmissions sent from the service owner.\n- false when the service owner has created an Activity of type TransmissionOpened for all Transmissions sent from the service owner. The Activities must each contain the relevant Id for all relevant Transmissions.\n \nNote that the value is\n- determined by the service owner and not to be confused with IsContentSeen\n- not affected by SystemLabels\n \nFor correspondence: HasUnopenedContent is still true until the service owner also adds a Dialog level Activity (no transmission id) of type CorrespondenceOpened",
920
+ "type": "boolean"
923
921
  },
924
922
  "id": {
925
923
  "description": "The unique identifier for the dialog in UUIDv7 format.",
@@ -932,7 +930,7 @@
932
930
  "type": "boolean"
933
931
  },
934
932
  "isContentSeen": {
935
- "description": "A dialog is considered seen if\n- it has been retrieved by a user, since its last content update, and\n- there is no SystemLabels MarkedAsUnopened",
933
+ "description": "Indicates whether a dialog has been seen since its last content update.\n \nThe value of this field is\n- true if the dialog has been retrieved since its last content update by either GET /enduser/dialogs/{dialogId} or GET /serviceowner/dialogs/{dialogId}?EndUserId={userId} and there is no SystemLabels MarkedAsUnopened\n- false if there is a SystemLabels MarkedAsUnopened, even if the dialog has been seen since its last content update\n- false after the dialog receives a content update.\n \nNote that the value is determined by Dialogporten and not to be confused with HasUnopenedContent",
936
934
  "type": "boolean"
937
935
  },
938
936
  "org": {
@@ -2008,10 +2006,8 @@
2008
2006
  "type": "integer"
2009
2007
  },
2010
2008
  "hasUnopenedContent": {
2011
- "deprecated": true,
2012
- "description": "Indicates whether the dialog contains content that has not been viewed or opened by the user yet.",
2013
- "type": "boolean",
2014
- "x-deprecatedMessage": "Use IsContentSeen instead. See the new field\u0027s description for an explanation of the new behavior."
2009
+ "description": "Whether the service owner has not yet reported all dialog Transmissions they sent as seen by the end user.\nA Transmission is considered \u0022sent from the service owner\u0022 if the DialogTransmissionType is not one of Submission or Correction.\n \nThe value of this field is:\n- true when there are any new unopened Transmissions sent from the service owner.\n- false when the service owner has created an Activity of type TransmissionOpened for all Transmissions sent from the service owner. The Activities must each contain the relevant Id for all relevant Transmissions.\n \nNote that the value is\n- determined by the service owner and not to be confused with IsContentSeen\n- not affected by SystemLabels\n \nFor correspondence: HasUnopenedContent is still true until the service owner also adds a Dialog level Activity (no transmission id) of type CorrespondenceOpened",
2010
+ "type": "boolean"
2015
2011
  },
2016
2012
  "id": {
2017
2013
  "description": "The unique identifier for the dialog in UUIDv7 format.",
@@ -2024,7 +2020,7 @@
2024
2020
  "type": "boolean"
2025
2021
  },
2026
2022
  "isContentSeen": {
2027
- "description": "A dialog is considered seen if\n- it has been retrieved by a user, since its last content update, and\n- there is no SystemLabels MarkedAsUnopened",
2023
+ "description": "Indicates whether a dialog has been seen since its last content update.\n \nThe value of this field is\n- true if the dialog has been retrieved since its last content update by either GET /enduser/dialogs/{dialogId} or GET /serviceowner/dialogs/{dialogId}?EndUserId={userId} and there is no SystemLabels MarkedAsUnopened\n- false if there is a SystemLabels MarkedAsUnopened, even if the dialog has been seen since its last content update\n- false after the dialog receives a content update.\n \nNote that the value is determined by Dialogporten and not to be confused with HasUnopenedContent",
2028
2024
  "type": "boolean"
2029
2025
  },
2030
2026
  "latestActivity": {
@@ -5067,10 +5063,8 @@
5067
5063
  "type": "array"
5068
5064
  },
5069
5065
  "hasUnopenedContent": {
5070
- "deprecated": true,
5071
- "description": "Indicates whether the dialog contains content that has not been viewed or opened by the user yet.",
5072
- "type": "boolean",
5073
- "x-deprecatedMessage": "Use IsContentSeen instead. See the new field\u0027s description for an explanation of the new behavior."
5066
+ "description": "Whether the service owner has not yet reported all dialog Transmissions they sent as seen by the end user.\nA Transmission is considered \u0022sent from the service owner\u0022 if the DialogTransmissionType is not one of Submission or Correction.\n \nThe value of this field is:\n- true when there are any new unopened Transmissions sent from the service owner.\n- false when the service owner has created an Activity of type TransmissionOpened for all Transmissions sent from the service owner. The Activities must each contain the relevant Id for all relevant Transmissions.\n \nNote that the value is\n- determined by the service owner and not to be confused with IsContentSeen\n- not affected by SystemLabels\n \nFor correspondence: HasUnopenedContent is still true until the service owner also adds a Dialog level Activity (no transmission id) of type CorrespondenceOpened",
5067
+ "type": "boolean"
5074
5068
  },
5075
5069
  "id": {
5076
5070
  "description": "The unique identifier for the dialog in UUIDv7 format.",
@@ -5088,7 +5082,7 @@
5088
5082
  "type": "boolean"
5089
5083
  },
5090
5084
  "isContentSeen": {
5091
- "description": "A dialog is considered seen if\n- it has been retrieved by a user, since its last content update, and\n- there is no SystemLabels MarkedAsUnopened",
5085
+ "description": "Indicates whether a dialog has been seen since its last content update.\n \nThe value of this field is\n- true if the dialog has been retrieved since its last content update by either GET /enduser/dialogs/{dialogId} or GET /serviceowner/dialogs/{dialogId}?EndUserId={userId} and there is no SystemLabels MarkedAsUnopened\n- false if there is a SystemLabels MarkedAsUnopened, even if the dialog has been seen since its last content update\n- false after the dialog receives a content update.\n \nNote that the value is determined by Dialogporten and not to be confused with HasUnopenedContent",
5092
5086
  "type": "boolean"
5093
5087
  },
5094
5088
  "org": {
@@ -6230,10 +6224,8 @@
6230
6224
  "type": "integer"
6231
6225
  },
6232
6226
  "hasUnopenedContent": {
6233
- "deprecated": true,
6234
- "description": "Indicates whether the dialog contains content that has not been viewed or opened by the user yet.",
6235
- "type": "boolean",
6236
- "x-deprecatedMessage": "Use IsContentSeen instead. See the new field\u0027s description for an explanation of the new behavior."
6227
+ "description": "Whether the service owner has not yet reported all dialog Transmissions they sent as seen by the end user.\nA Transmission is considered \u0022sent from the service owner\u0022 if the DialogTransmissionType is not one of Submission or Correction.\n \nThe value of this field is:\n- true when there are any new unopened Transmissions sent from the service owner.\n- false when the service owner has created an Activity of type TransmissionOpened for all Transmissions sent from the service owner. The Activities must each contain the relevant Id for all relevant Transmissions.\n \nNote that the value is\n- determined by the service owner and not to be confused with IsContentSeen\n- not affected by SystemLabels\n \nFor correspondence: HasUnopenedContent is still true until the service owner also adds a Dialog level Activity (no transmission id) of type CorrespondenceOpened",
6228
+ "type": "boolean"
6237
6229
  },
6238
6230
  "id": {
6239
6231
  "description": "The unique identifier for the dialog in UUIDv7 format.",
@@ -6246,7 +6238,7 @@
6246
6238
  "type": "boolean"
6247
6239
  },
6248
6240
  "isContentSeen": {
6249
- "description": "A dialog is considered seen if\n- it has been retrieved by a user, since its last content update, and\n- there is no SystemLabels MarkedAsUnopened",
6241
+ "description": "Indicates whether a dialog has been seen since its last content update.\n \nThe value of this field is\n- true if the dialog has been retrieved since its last content update by either GET /enduser/dialogs/{dialogId} or GET /serviceowner/dialogs/{dialogId}?EndUserId={userId} and there is no SystemLabels MarkedAsUnopened\n- false if there is a SystemLabels MarkedAsUnopened, even if the dialog has been seen since its last content update\n- false after the dialog receives a content update.\n \nNote that the value is determined by Dialogporten and not to be confused with HasUnopenedContent",
6250
6242
  "type": "boolean"
6251
6243
  },
6252
6244
  "latestActivity": {
@@ -11539,4 +11531,4 @@
11539
11531
  }
11540
11532
  }
11541
11533
  }
11542
- }
11534
+ }