@digdir/dialogporten-schema 1.20.2 → 1.21.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digdir/dialogporten-schema",
-  "version": "1.20.2",
+  "version": "1.21.0",
   "description": "GraphQl schema and OpenAPI spec for Dialogporten",
   "engines": {
     "node": "20"

package/schema.verified.graphql

@@ -1,5 +1,6 @@
 schema {
   query: Queries
+  mutation: Mutations
   subscription: Subscriptions
 }
 
@@ -11,6 +12,10 @@ interface SearchDialogError {
   message: String!
 }
 
+interface SetSystemLabelError {
+  message: String!
+}
+
 type Activity {
   id: UUID!
   createdAt: DateTime
@@ -155,6 +160,10 @@ type Localization {
   languageCode: String!
 }
 
+type Mutations {
+  setSystemLabel(input: SetSystemLabelInput!): SetSystemLabelPayload!
+}
+
 type Queries @authorize(policy: "enduser") {
   dialogById(dialogId: UUID!): DialogByIdPayload!
   searchDialogs(input: SearchDialogInput!): SearchDialogsPayload!
@@ -211,6 +220,15 @@ type SeenLog {
   isCurrentEndUser: Boolean!
 }
 
+type SetSystemLabelEntityNotFound implements SetSystemLabelError {
+  message: String!
+}
+
+type SetSystemLabelPayload {
+  success: Boolean!
+  errors: [SetSystemLabelError!]!
+}
+
 type Subscriptions {
   "Requires a dialog token in the 'DigDir-Dialog-Token' header."
   dialogEvents(dialogId: UUID!): DialogEventPayload! @authorize(policy: "enduserSubscription", apply: VALIDATION)
@@ -265,6 +283,11 @@ input SearchDialogInput {
   searchLanguageCode: String
 }
 
+input SetSystemLabelInput {
+  dialogId: UUID!
+  label: SystemLabel!
+}
+
 enum ActivityType {
   "Refers to a dialog that has been created."
   DIALOG_CREATED
@@ -336,6 +359,12 @@ enum HttpVerb {
   CONNECT
 }
 
+enum SystemLabel {
+  DEFAULT
+  BIN
+  ARCHIVE
+}
+
 enum TransmissionType {
   "For general information, not related to any submissions"
   INFORMATION

package/src/index.js

@@ -1,5 +1,6 @@
 export const schema_verified_graphql = `schema {
   query: Queries
+  mutation: Mutations
   subscription: Subscriptions
 }
 
@@ -11,6 +12,10 @@ interface SearchDialogError {
   message: String!
 }
 
+interface SetSystemLabelError {
+  message: String!
+}
+
 type Activity {
   id: UUID!
   createdAt: DateTime
@@ -155,6 +160,10 @@ type Localization {
   languageCode: String!
 }
 
+type Mutations {
+  setSystemLabel(input: SetSystemLabelInput!): SetSystemLabelPayload!
+}
+
 type Queries @authorize(policy: "enduser") {
   dialogById(dialogId: UUID!): DialogByIdPayload!
   searchDialogs(input: SearchDialogInput!): SearchDialogsPayload!
@@ -211,6 +220,15 @@ type SeenLog {
   isCurrentEndUser: Boolean!
 }
 
+type SetSystemLabelEntityNotFound implements SetSystemLabelError {
+  message: String!
+}
+
+type SetSystemLabelPayload {
+  success: Boolean!
+  errors: [SetSystemLabelError!]!
+}
+
 type Subscriptions {
   "Requires a dialog token in the 'DigDir-Dialog-Token' header."
   dialogEvents(dialogId: UUID!): DialogEventPayload! @authorize(policy: "enduserSubscription", apply: VALIDATION)
@@ -265,6 +283,11 @@ input SearchDialogInput {
   searchLanguageCode: String
 }
 
+input SetSystemLabelInput {
+  dialogId: UUID!
+  label: SystemLabel!
+}
+
 enum ActivityType {
   "Refers to a dialog that has been created."
   DIALOG_CREATED
@@ -336,6 +359,12 @@ enum HttpVerb {
   CONNECT
 }
 
+enum SystemLabel {
+  DEFAULT
+  BIN
+  ARCHIVE
+}
+
 enum TransmissionType {
   "For general information, not related to any submissions"
   INFORMATION

package/swagger.verified.json

@@ -261,6 +261,15 @@
               }
             ]
           },
+          "systemLabel": {
+            "description": "Set the system label of the dialog Migration purposes ",
+            "nullable": true,
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/SystemLabel_Values"
+              }
+            ]
+          },
           "transmissions": {
             "description": "The immutable list of transmissions associated with the dialog",
             "items": {
@@ -2093,6 +2102,14 @@
               }
             ]
           },
+          "systemLabel": {
+            "description": "Current display state.",
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/SystemLabel_Values"
+              }
+            ]
+          },
           "transmissions": {
             "description": "The immutable list of transmissions associated with the dialog",
             "items": {
@@ -2254,6 +2271,14 @@
               }
             ]
           },
+          "systemLabel": {
+            "description": "Current display state.",
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/SystemLabel_Values"
+              }
+            ]
+          },
           "transmissions": {
             "description": "The immutable list of transmissions associated with the dialog",
             "items": {
@@ -2551,6 +2576,18 @@
         },
         "type": "object"
       },
+      "LabelAssignmentLogActorDto": {
+        "additionalProperties": false,
+        "properties": {
+          "actorId": {
+            "type": "string"
+          },
+          "actorName": {
+            "type": "string"
+          }
+        },
+        "type": "object"
+      },
       "LocalizationDto": {
         "additionalProperties": false,
         "properties": {
@@ -3180,6 +3217,14 @@
               }
             ]
           },
+          "systemLabel": {
+            "description": "Current display state.",
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/SystemLabel_Values"
+              }
+            ]
+          },
           "updatedAt": {
             "description": "The date and time when the dialog was last updated.",
             "example": "2022-12-31T23:59:59Z",
@@ -3295,6 +3340,14 @@
               }
             ]
           },
+          "systemLabel": {
+            "description": "Current display state.",
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/SystemLabel_Values"
+              }
+            ]
+          },
           "updatedAt": {
             "description": "The date and time when the dialog was last updated.",
             "example": "2022-12-31T23:59:59Z",
@@ -3310,6 +3363,25 @@
         },
         "type": "object"
       },
+      "SearchDialogLabelAssignmentLogDto": {
+        "additionalProperties": false,
+        "properties": {
+          "action": {
+            "type": "string"
+          },
+          "createdAt": {
+            "format": "date-time",
+            "type": "string"
+          },
+          "name": {
+            "type": "string"
+          },
+          "performedBy": {
+            "$ref": "#/components/schemas/LabelAssignmentLogActorDto"
+          }
+        },
+        "type": "object"
+      },
       "SearchDialogSeenLogDto": {
         "additionalProperties": false,
         "properties": {
@@ -3386,6 +3458,34 @@
         },
         "type": "object"
       },
+      "SetDialogSystemLabelCommand": {
+        "additionalProperties": false,
+        "properties": {
+          "ifMatchDialogRevision": {
+            "format": "guid",
+            "nullable": true,
+            "type": "string"
+          },
+          "label": {
+            "$ref": "#/components/schemas/SystemLabel_Values"
+          }
+        },
+        "type": "object"
+      },
+      "SystemLabel_Values": {
+        "description": "",
+        "enum": [
+          "Default",
+          "Bin",
+          "Archive"
+        ],
+        "type": "string",
+        "x-enumNames": [
+          "Default",
+          "Bin",
+          "Archive"
+        ]
+      },
       "UpdateDialogContentDto": {
         "additionalProperties": false,
         "properties": {
@@ -4237,6 +4337,20 @@
               "type": "string"
             }
           },
+          {
+            "description": "Filter by Display state ",
+            "explode": true,
+            "in": "query",
+            "name": "systemLabel",
+            "schema": {
+              "items": {
+                "$ref": "#/components/schemas/SystemLabel_Values"
+              },
+              "nullable": true,
+              "type": "array"
+            },
+            "style": "form"
+          },
           {
             "description": "Search string for free text search. Will attempt to fuzzily match in all free text fields in the aggregate",
             "in": "query",
@@ -4472,6 +4586,64 @@
         ]
       }
     },
+    "/api/v1/enduser/dialogs/{dialogId}/labellog": {
+      "get": {
+        "operationId": "SearchDialogLabelAssignmentLog",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "dialogId",
+            "required": true,
+            "schema": {
+              "format": "guid",
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "items": {
+                    "$ref": "#/components/schemas/SearchDialogLabelAssignmentLogDto"
+                  },
+                  "type": "array"
+                }
+              }
+            },
+            "description": "Success"
+          },
+          "401": {
+            "description": "Unauthorized"
+          },
+          "403": {
+            "description": "Forbidden"
+          },
+          "404": {
+            "content": {
+              "application/problem\u002Bjson": {
+                "schema": {
+                  "$ref": "#/components/schemas/ProblemDetails"
+                }
+              }
+            },
+            "description": "Not Found"
+          },
+          "410": {
+            "description": ""
+          }
+        },
+        "security": [
+          {
+            "JWTBearerAuth": []
+          }
+        ],
+        "tags": [
+          "Enduser"
+        ]
+      }
+    },
     "/api/v1/enduser/dialogs/{dialogId}/seenlog": {
       "get": {
         "description": "Gets all seen log records for a dialog. For more information see the documentation (link TBD).",
@@ -4592,6 +4764,97 @@
         ]
       }
     },
+    "/api/v1/enduser/dialogs/{dialogId}/systemlabels": {
+      "put": {
+        "operationId": "SetDialogLabel",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "dialogId",
+            "required": true,
+            "schema": {
+              "format": "guid",
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/SetDialogSystemLabelCommand"
+              }
+            }
+          },
+          "description": "",
+          "required": true,
+          "x-name": "SetDialogSystemLabelCommand",
+          "x-position": 1
+        },
+        "responses": {
+          "204": {
+            "description": "No Content"
+          },
+          "400": {
+            "content": {
+              "application/problem\u002Bjson": {
+                "schema": {
+                  "$ref": "#/components/schemas/ProblemDetails"
+                }
+              }
+            },
+            "description": "Bad Request"
+          },
+          "401": {
+            "description": "Unauthorized"
+          },
+          "403": {
+            "description": "Forbidden"
+          },
+          "404": {
+            "content": {
+              "application/problem\u002Bjson": {
+                "schema": {
+                  "$ref": "#/components/schemas/ProblemDetails"
+                }
+              }
+            },
+            "description": "Not Found"
+          },
+          "410": {
+            "description": ""
+          },
+          "412": {
+            "content": {
+              "application/problem\u002Bjson": {
+                "schema": {
+                  "$ref": "#/components/schemas/ProblemDetails"
+                }
+              }
+            },
+            "description": ""
+          },
+          "422": {
+            "content": {
+              "application/problem\u002Bjson": {
+                "schema": {
+                  "$ref": "#/components/schemas/ProblemDetails"
+                }
+              }
+            },
+            "description": ""
+          }
+        },
+        "security": [
+          {
+            "JWTBearerAuth": []
+          }
+        ],
+        "tags": [
+          "Enduser"
+        ]
+      }
+    },
     "/api/v1/enduser/dialogs/{dialogId}/transmissions": {
       "get": {
         "description": "Gets the list of transmissions belonging to a dialog",
@@ -4897,6 +5160,20 @@
               "type": "string"
             }
           },
+          {
+            "description": "Filter by Display state ",
+            "explode": true,
+            "in": "query",
+            "name": "systemLabel",
+            "schema": {
+              "items": {
+                "$ref": "#/components/schemas/SystemLabel_Values"
+              },
+              "nullable": true,
+              "type": "array"
+            },
+            "style": "form"
+          },
           {
             "description": "Search string for free text search. Will attempt to fuzzily match in all free text fields in the aggregate",
             "in": "query",