@vng-api/openvtb-berichten 0.1.0 → 0.1.1

package/README.md

@@ -1,8 +1,10 @@
 # @vng-api/openvtb-berichten
 
-Gebundelde OpenAPI-specificatie voor **Berichten API** (versie 0.1.0), uit [VNG-Realisatie/Interactie-APIs](https://github.com/VNG-Realisatie/Interactie-APIs).
+Gebundelde OpenAPI-specificatie voor **Berichten API** (specversie v0.1.0, pakketrevisie 0.1.1), uit [VNG-Realisatie/Interactie-APIs](https://github.com/VNG-Realisatie/Interactie-APIs).
+
+```ts
+import type { paths, components } from "@vng-api/openvtb-berichten"; // TypeScript-types
 
-```js
 const spec = require("@vng-api/openvtb-berichten"); // geparste openapi.json
 ```
 

package/package.json

@@ -1,16 +1,25 @@
 {
   "name": "@vng-api/openvtb-berichten",
-  "version": "0.1.0",
+  "version": "0.1.1",
+  "vngSpecVersion": "0.1.0",
   "description": "OpenAPI-specificatie voor Berichten API — De berichten-service bestaat uit een beschrijving van afspraken, standaarden en referentiecomponenten aangevuld met interactiepatronen, ontwerpbesluiten en aanbevelingen. Het Berichten-patroon biedt een gesta",
   "main": "openapi.json",
+  "types": "types.d.ts",
   "exports": {
-    ".": "./openapi.json",
+    ".": {
+      "types": "./types.d.ts",
+      "default": "./openapi.json"
+    },
     "./openapi.json": "./openapi.json",
-    "./openapi.yaml": "./openapi.yaml"
+    "./openapi.yaml": "./openapi.yaml",
+    "./types": {
+      "types": "./types.d.ts"
+    }
   },
   "files": [
     "openapi.yaml",
     "openapi.json",
+    "types.d.ts",
     "README.md"
   ],
   "keywords": [

package/types.d.ts

@@ -0,0 +1,259 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export interface paths {
+    "/berichten": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Vraag alle berichten aan.
+         * @description Vraag alle berichten aan.
+         */
+        get: operations["berichtenList"];
+        put?: never;
+        /**
+         * Maak een bericht aan.
+         * @description Maak een bericht aan.
+         */
+        post: operations["berichtenCreate"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/berichten/{uuid}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Een specifiek bericht opvragen.
+         * @description Een specifiek bericht opvragen.
+         */
+        get: operations["berichtenRetrieve"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        /**
+         * Werk het veld 'geopendOp' van een bericht bij.
+         * @description Werk het veld 'geopendOp' van een bericht bij.
+         */
+        patch: operations["berichtenPartialUpdate"];
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        Bericht: {
+            /**
+             * Format: uri
+             * @description De unieke URL van het Bericht binnen deze API.
+             */
+            readonly url: string;
+            /**
+             * Format: urn
+             * @description De Uniform Resource Name van het Bericht.
+             * @example urn:namespace:component:resource:uuid
+             */
+            readonly urn: string;
+            /**
+             * Format: uuid
+             * @description Unieke identificatiecode (UUID4) voor het Bericht.
+             */
+            readonly uuid: string;
+            /** @description Onderwerp van het bericht. */
+            onderwerp: string;
+            /** @description Tekst van het bericht. URLs worden altijd weergegeven als klikbare URLs op alle portalen. Voor portalen van lokale overheden is de basic syntax van Markdown toegestaan, voor de Mijn Overheid berichtenbox enkel newlines (\r\n). */
+            berichtTekst: string;
+            /**
+             * Format: date-time
+             * @description Datum/tijd waarop bericht zichtbaar moet worden voor de ontvanger. Dit geldt voor zowel de Mijn Overheid berichtenbox als het portaal van de lokale overheid. De standaardwaarde is de huidige datum/tijd.
+             */
+            publicatiedatum?: string | null;
+            /** @description Zenderreferentie / interne referentie. */
+            referentie?: string;
+            /**
+             * Format: urn
+             * @description URN van een NATUURLIJK PERSOON of NIET-NATUURLIJK PERSOON. Bijvoorbeeld: `urn:nld:brp:bsn:111222333`, `urn:nld:hr:kvknummer:444555666` of `urn:nld:hr:kvknummer:444555666:vestigingsnummer:777888999`
+             * @example urn:namespace:component:resource:uuid
+             */
+            ontvanger: string;
+            /**
+             * Format: date-time
+             * @description Het bericht is door de geadresseerde geopend op dit tijdstip in het portaal van de lokale overheid. Deze waarde is onafhankelijk Mijn Overheid.
+             */
+            geopendOp?: string | null;
+            /** @description Een code voor het technisch identificeren van een bericht soort & origine. Wordt ook gebruikt in de Mijn Overheid berichtenbox. */
+            berichtType?: string;
+            /** @description De door de toegewezen persoon of bedrijf uit te voeren handeling. Bijvoorbeeld: `lezen`, `naleveren`, `invullen`. */
+            handelingsPerspectief?: string;
+            /**
+             * Format: date-time
+             * @description Datum/tijd waarop handeling afgerond moet zijn.
+             */
+            einddatumHandelingsTermijn?: string | null;
+            /** @description Geeft aan of dit bericht geschikt is voor publicatie in de MijnOverheid Berichtenbox. Als dit op ``False`` staat, is het bericht niet bedoeld voor publicatie in de Berichtenbox. */
+            mijnOverheidBerichtenbox: boolean;
+            /** @description Lijst van bijlagen bij het bericht. Let op; In het geval dat dit bericht naar de Mijn Overheid Berichtenbox moet, moet rekening gehouden worden met de requirements van Logius in haar technische aansluithandleiding. */
+            bijlagen?: components["schemas"]["Bijlage"][];
+        };
+        Bijlage: {
+            /**
+             * Format: urn
+             * @description URN naar het ENKELVOUDIGINFORMATIEOBJECT. Bijvoorbeeld: `urn:nld:gemeenteutrecht:informatieobject:uuid:717815f6-1939-4fd2-93f0-83d25bad154e`
+             * @example urn:namespace:component:resource:uuid
+             */
+            informatieObject: string;
+            /** @description Een korte omschrijving of de titel van de bijlage. Deze wordt typisch getoond in een portaal. */
+            omschrijving?: string;
+            /**
+             * @description Geeft aan of dit document een standaardbijlage is die vooraf geüpload is in het Berichtenbox Leveranciersportaal. Standaard `false`. Indien `true` moet deze bijlage door het outputmanagementcomponent genegeerd worden - als de Berichtenbox het doelkanaal is.
+             * @default false
+             */
+            isBerichtTypeBijlage: boolean;
+        };
+        PaginatedBerichtList: {
+            /** @example 123 */
+            count: number;
+            /**
+             * Format: uri
+             * @example http://api.example.org/accounts/?page=4
+             */
+            next?: string | null;
+            /**
+             * Format: uri
+             * @example http://api.example.org/accounts/?page=2
+             */
+            previous?: string | null;
+            results: components["schemas"]["Bericht"][];
+        };
+        PatchedBerichtGeopendOp: {
+            /**
+             * Format: date-time
+             * @description Het bericht is door de geadresseerde geopend op dit tijdstip in het portaal van de lokale overheid. Deze waarde is onafhankelijk Mijn Overheid.
+             */
+            geopendOp?: string | null;
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    berichtenList: {
+        parameters: {
+            query?: {
+                /** @description Een pagina binnen de gepagineerde set resultaten. */
+                page?: number;
+                /** @description Het aantal resultaten terug te geven per pagina. (default: 100, maximum: 500). */
+                pageSize?: number;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    /** @description Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1. */
+                    "API-version"?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PaginatedBerichtList"];
+                };
+            };
+        };
+    };
+    berichtenCreate: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["Bericht"];
+            };
+        };
+        responses: {
+            201: {
+                headers: {
+                    /** @description Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1. */
+                    "API-version"?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Bericht"];
+                };
+            };
+        };
+    };
+    berichtenRetrieve: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                uuid: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    /** @description Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1. */
+                    "API-version"?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Bericht"];
+                };
+            };
+        };
+    };
+    berichtenPartialUpdate: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                uuid: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["PatchedBerichtGeopendOp"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    /** @description Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1. */
+                    "API-version"?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Bericht"];
+                };
+            };
+        };
+    };
+}