@vng-api/openproduct-producten 1.6.0 → 1.6.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 (3) hide show
  1. package/README.md +4 -2
  2. package/package.json +12 -3
  3. package/types.d.ts +914 -0
package/README.md CHANGED
@@ -1,8 +1,10 @@
1
1
  # @vng-api/openproduct-producten
2
2
 
3
- Gebundelde OpenAPI-specificatie voor **Producten API** (versie 1.6.0), uit [VNG-Realisatie/Interactie-APIs](https://github.com/VNG-Realisatie/Interactie-APIs).
3
+ Gebundelde OpenAPI-specificatie voor **Producten API** (specversie v1.6.0, pakketrevisie 1.6.1), uit [VNG-Realisatie/Interactie-APIs](https://github.com/VNG-Realisatie/Interactie-APIs).
4
+
5
+ ```ts
6
+ import type { paths, components } from "@vng-api/openproduct-producten"; // TypeScript-types
4
7
 
5
- ```js
6
8
  const spec = require("@vng-api/openproduct-producten"); // geparste openapi.json
7
9
  ```
8
10
 
package/package.json CHANGED
@@ -1,16 +1,25 @@
1
1
  {
2
2
  "name": "@vng-api/openproduct-producten",
3
- "version": "1.6.0",
3
+ "version": "1.6.1",
4
+ "vngSpecVersion": "1.6.0",
4
5
  "description": "OpenAPI-specificatie voor Producten API — Een API voor Producten.",
5
6
  "main": "openapi.json",
7
+ "types": "types.d.ts",
6
8
  "exports": {
7
- ".": "./openapi.json",
9
+ ".": {
10
+ "types": "./types.d.ts",
11
+ "default": "./openapi.json"
12
+ },
8
13
  "./openapi.json": "./openapi.json",
9
- "./openapi.yaml": "./openapi.yaml"
14
+ "./openapi.yaml": "./openapi.yaml",
15
+ "./types": {
16
+ "types": "./types.d.ts"
17
+ }
10
18
  },
11
19
  "files": [
12
20
  "openapi.yaml",
13
21
  "openapi.json",
22
+ "types.d.ts",
14
23
  "README.md"
15
24
  ],
16
25
  "keywords": [
package/types.d.ts ADDED
@@ -0,0 +1,914 @@
1
+ /**
2
+ * This file was auto-generated by openapi-typescript.
3
+ * Do not make direct changes to the file.
4
+ */
5
+
6
+ export interface paths {
7
+ "/producten": {
8
+ parameters: {
9
+ query?: never;
10
+ header?: never;
11
+ path?: never;
12
+ cookie?: never;
13
+ };
14
+ /**
15
+ * Alle PRODUCTEN opvragen.
16
+ * @description Deze lijst kan gefilterd wordt met query-string parameters.
17
+ */
18
+ get: operations["producten_list"];
19
+ put?: never;
20
+ /** Maak een PRODUCT aan. */
21
+ post: operations["producten_create"];
22
+ delete?: never;
23
+ options?: never;
24
+ head?: never;
25
+ patch?: never;
26
+ trace?: never;
27
+ };
28
+ "/producten/{uuid}": {
29
+ parameters: {
30
+ query?: never;
31
+ header?: never;
32
+ path?: never;
33
+ cookie?: never;
34
+ };
35
+ /** Een specifiek PRODUCT opvragen. */
36
+ get: operations["producten_retrieve"];
37
+ /** Werk een PRODUCT in zijn geheel bij. */
38
+ put: operations["producten_update"];
39
+ post?: never;
40
+ /** Verwijder een PRODUCT. */
41
+ delete: operations["producten_destroy"];
42
+ options?: never;
43
+ head?: never;
44
+ /** Werk een PRODUCT deels bij. */
45
+ patch: operations["producten_partial_update"];
46
+ trace?: never;
47
+ };
48
+ }
49
+ export type webhooks = Record<string, never>;
50
+ export interface components {
51
+ schemas: {
52
+ /** @enum {unknown} */
53
+ BlankEnum: "";
54
+ DetailError: {
55
+ detail: string;
56
+ };
57
+ Eigenaar: {
58
+ /** Format: uuid */
59
+ uuid?: string;
60
+ /**
61
+ * Burgerservicenummer
62
+ * @description Het BSN van de product eigenaar, BSN van 8 karakters moet met een extra 0 beginnen.
63
+ */
64
+ bsn?: string;
65
+ /** @description Het kvk nummer van de product eigenaar */
66
+ kvk_nummer?: string;
67
+ /** @description Een korte unieke aanduiding van een vestiging. */
68
+ vestigingsnummer?: string;
69
+ /** @description generiek veld voor de identificatie van een klant of partij. */
70
+ klantnummer?: string;
71
+ };
72
+ EigenaarRequest: {
73
+ /** Format: uuid */
74
+ uuid?: string;
75
+ /**
76
+ * Burgerservicenummer
77
+ * @description Het BSN van de product eigenaar, BSN van 8 karakters moet met een extra 0 beginnen.
78
+ */
79
+ bsn?: string;
80
+ /** @description Het kvk nummer van de product eigenaar */
81
+ kvk_nummer?: string;
82
+ /** @description Een korte unieke aanduiding van een vestiging. */
83
+ vestigingsnummer?: string;
84
+ /** @description generiek veld voor de identificatie van een klant of partij. */
85
+ klantnummer?: string;
86
+ };
87
+ Error: {
88
+ veld_a: string[];
89
+ veld_b: string[];
90
+ };
91
+ /**
92
+ * @description * `eenmalig` - Eenmalig
93
+ * * `maandelijks` - Maandelijks
94
+ * * `jaarlijks` - Jaarlijks
95
+ * @enum {string}
96
+ */
97
+ FrequentieEnum: "eenmalig" | "maandelijks" | "jaarlijks";
98
+ NestedDocument: {
99
+ urn?: string | null;
100
+ /** Format: uri */
101
+ url?: string | null;
102
+ };
103
+ NestedDocumentRequest: {
104
+ urn?: string | null;
105
+ /** Format: uri */
106
+ url?: string | null;
107
+ };
108
+ NestedProductType: {
109
+ /** Format: uuid */
110
+ readonly uuid: string;
111
+ /** @description code van het producttype. */
112
+ code: string;
113
+ /** @description Lijst van keywords waarop kan worden gezocht. */
114
+ keywords?: string[];
115
+ /** @description Uniforme product naam */
116
+ uniforme_product_naam: string;
117
+ /** @description toegestane statussen voor producten van dit type. */
118
+ toegestane_statussen?: components["schemas"]["ToegestaneStatussenEnum"][];
119
+ /** @description Geeft aan of het producttype getoond kan worden. */
120
+ readonly gepubliceerd: boolean;
121
+ /**
122
+ * Publicatie startdatum
123
+ * Format: date
124
+ * @description De datum waarop het producttype gepubliceerd is
125
+ */
126
+ publicatie_start_datum?: string | null;
127
+ /**
128
+ * Publicatie einddatum
129
+ * Format: date
130
+ * @description De datum waarop de publicatie eindigt
131
+ */
132
+ publicatie_eind_datum?: string | null;
133
+ /**
134
+ * Format: date-time
135
+ * @description De datum waarop het object is aangemaakt.
136
+ */
137
+ readonly aanmaak_datum: string;
138
+ /**
139
+ * Format: date-time
140
+ * @description De datum waarop het object voor het laatst is gewijzigd.
141
+ */
142
+ readonly update_datum: string;
143
+ themas: components["schemas"]["NestedThema"][];
144
+ };
145
+ NestedProductTypeRequest: {
146
+ /** @description code van het producttype. */
147
+ code: string;
148
+ /** @description Lijst van keywords waarop kan worden gezocht. */
149
+ keywords?: string[];
150
+ /** @description Uniforme product naam */
151
+ uniforme_product_naam: string;
152
+ /** @description toegestane statussen voor producten van dit type. */
153
+ toegestane_statussen?: components["schemas"]["ToegestaneStatussenEnum"][];
154
+ /**
155
+ * Publicatie startdatum
156
+ * Format: date
157
+ * @description De datum waarop het producttype gepubliceerd is
158
+ */
159
+ publicatie_start_datum?: string | null;
160
+ /**
161
+ * Publicatie einddatum
162
+ * Format: date
163
+ * @description De datum waarop de publicatie eindigt
164
+ */
165
+ publicatie_eind_datum?: string | null;
166
+ themas: components["schemas"]["NestedThemaRequest"][];
167
+ };
168
+ NestedTaak: {
169
+ urn?: string | null;
170
+ /** Format: uri */
171
+ url?: string | null;
172
+ };
173
+ NestedTaakRequest: {
174
+ urn?: string | null;
175
+ /** Format: uri */
176
+ url?: string | null;
177
+ };
178
+ NestedThema: {
179
+ /** Format: uuid */
180
+ readonly uuid: string;
181
+ /** @description Naam van het thema. */
182
+ naam: string;
183
+ /** @description Beschrijving van het thema, ondersteund markdown format. */
184
+ beschrijving?: string;
185
+ /** @description Geeft aan of het thema getoond kan worden. */
186
+ gepubliceerd?: boolean;
187
+ /**
188
+ * Format: date-time
189
+ * @description De datum waarop het object is aangemaakt.
190
+ */
191
+ readonly aanmaak_datum: string;
192
+ /**
193
+ * Format: date-time
194
+ * @description De datum waarop het object voor het laatst is gewijzigd.
195
+ */
196
+ readonly update_datum: string;
197
+ /**
198
+ * Format: uuid
199
+ * @description Het hoofd thema waaronder dit thema valt.
200
+ */
201
+ hoofd_thema: string;
202
+ };
203
+ NestedThemaRequest: {
204
+ /** @description Naam van het thema. */
205
+ naam: string;
206
+ /** @description Beschrijving van het thema, ondersteund markdown format. */
207
+ beschrijving?: string;
208
+ /** @description Geeft aan of het thema getoond kan worden. */
209
+ gepubliceerd?: boolean;
210
+ /**
211
+ * Format: uuid
212
+ * @description Het hoofd thema waaronder dit thema valt.
213
+ */
214
+ hoofd_thema: string;
215
+ };
216
+ NestedZaak: {
217
+ urn?: string | null;
218
+ /** Format: uri */
219
+ url?: string | null;
220
+ };
221
+ NestedZaakRequest: {
222
+ urn?: string | null;
223
+ /** Format: uri */
224
+ url?: string | null;
225
+ };
226
+ PaginatedProductList: {
227
+ /** @example 123 */
228
+ count: number;
229
+ /**
230
+ * Format: uri
231
+ * @example http://api.example.org/accounts/?page=4
232
+ */
233
+ next?: string | null;
234
+ /**
235
+ * Format: uri
236
+ * @example http://api.example.org/accounts/?page=2
237
+ */
238
+ previous?: string | null;
239
+ results: components["schemas"]["Product"][];
240
+ };
241
+ PatchedProductRequest: {
242
+ /** @description De naam van dit product. */
243
+ naam?: string;
244
+ /**
245
+ * Format: date
246
+ * @description De start datum van dit product. Op deze datum zal de status van het product automatisch naar ACTIEF worden gezet. Op het moment dat de start_datum wordt ingevuld moet de status ACTIEF op het producttype zijn toegestaan.
247
+ */
248
+ start_datum?: string | null;
249
+ /**
250
+ * Format: date
251
+ * @description De einddatum van dit product. Op deze datum zal de status van het product automatisch naar VERLOPEN worden gezet. Op het moment dat de eind_datum wordt ingevuld moet de status VERLOPEN op het producttype zijn toegestaan.
252
+ */
253
+ eind_datum?: string | null;
254
+ /** Format: uuid */
255
+ producttype_uuid?: string;
256
+ /** @description Geeft aan of het product getoond kan worden. */
257
+ gepubliceerd?: boolean;
258
+ eigenaren?: components["schemas"]["EigenaarRequest"][];
259
+ documenten?: components["schemas"]["NestedDocumentRequest"][];
260
+ zaken?: components["schemas"]["NestedZaakRequest"][];
261
+ taken?: components["schemas"]["NestedTaakRequest"][];
262
+ /**
263
+ * @description De status opties worden bepaald door het veld 'toegestane statussen' van het gerelateerde producttype. Via start & eind_datum kan de status automatisch naar ACTIEF of VERLOPEN worden gezet (mits deze statussen zijn toegestaan op het producttype).
264
+ *
265
+ * * `initieel` - Initieel
266
+ * * `in_aanvraag` - In aanvraag
267
+ * * `gereed` - Gereed
268
+ * * `actief` - Actief
269
+ * * `ingetrokken` - Ingetrokken
270
+ * * `geweigerd` - Geweigerd
271
+ * * `verlopen` - Verlopen
272
+ */
273
+ status?: components["schemas"]["StatusEnum"];
274
+ /**
275
+ * Format: decimal
276
+ * @description De prijs van het product.
277
+ */
278
+ prijs?: string | null;
279
+ /**
280
+ * Prijs frequentie
281
+ * @description De frequentie van betalingen.
282
+ *
283
+ * * `eenmalig` - Eenmalig
284
+ * * `maandelijks` - Maandelijks
285
+ * * `jaarlijks` - Jaarlijks
286
+ */
287
+ frequentie?: components["schemas"]["FrequentieEnum"] | components["schemas"]["BlankEnum"];
288
+ /** @description Verbruiksobject van dit product. Wordt gevalideerd met het `verbruiksobject_schema` uit het producttype. */
289
+ verbruiksobject?: {
290
+ [key: string]: unknown;
291
+ } | null;
292
+ /** @description Dataobject van dit product. Wordt gevalideerd met het `dataobject_schema` uit het producttype. */
293
+ dataobject?: {
294
+ [key: string]: unknown;
295
+ } | null;
296
+ /** @description De zaak waaruit dit product is ontstaan. (<organisatie>:<systeem>:<component>:<resource>:<identificatie>) */
297
+ aanvraag_zaak_urn?: string | null;
298
+ /**
299
+ * Format: uri
300
+ * @description De zaak waaruit dit product is ontstaan.
301
+ */
302
+ aanvraag_zaak_url?: string | null;
303
+ };
304
+ Product: {
305
+ /** Format: uuid */
306
+ readonly uuid: string;
307
+ /**
308
+ * Format: uri
309
+ * @description URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object.
310
+ */
311
+ readonly url: string;
312
+ /** @description De naam van dit product. */
313
+ naam?: string;
314
+ /**
315
+ * Format: date
316
+ * @description De start datum van dit product. Op deze datum zal de status van het product automatisch naar ACTIEF worden gezet. Op het moment dat de start_datum wordt ingevuld moet de status ACTIEF op het producttype zijn toegestaan.
317
+ */
318
+ start_datum?: string | null;
319
+ /**
320
+ * Format: date
321
+ * @description De einddatum van dit product. Op deze datum zal de status van het product automatisch naar VERLOPEN worden gezet. Op het moment dat de eind_datum wordt ingevuld moet de status VERLOPEN op het producttype zijn toegestaan.
322
+ */
323
+ eind_datum?: string | null;
324
+ /**
325
+ * Format: date-time
326
+ * @description De datum waarop het object is aangemaakt.
327
+ */
328
+ readonly aanmaak_datum: string;
329
+ /**
330
+ * Format: date-time
331
+ * @description De datum waarop het object voor het laatst is gewijzigd.
332
+ */
333
+ readonly update_datum: string;
334
+ readonly producttype: components["schemas"]["NestedProductType"];
335
+ /** @description Geeft aan of het product getoond kan worden. */
336
+ gepubliceerd?: boolean;
337
+ eigenaren: components["schemas"]["Eigenaar"][];
338
+ documenten?: components["schemas"]["NestedDocument"][];
339
+ zaken?: components["schemas"]["NestedZaak"][];
340
+ taken?: components["schemas"]["NestedTaak"][];
341
+ /**
342
+ * @description De status opties worden bepaald door het veld 'toegestane statussen' van het gerelateerde producttype. Via start & eind_datum kan de status automatisch naar ACTIEF of VERLOPEN worden gezet (mits deze statussen zijn toegestaan op het producttype).
343
+ *
344
+ * * `initieel` - Initieel
345
+ * * `in_aanvraag` - In aanvraag
346
+ * * `gereed` - Gereed
347
+ * * `actief` - Actief
348
+ * * `ingetrokken` - Ingetrokken
349
+ * * `geweigerd` - Geweigerd
350
+ * * `verlopen` - Verlopen
351
+ */
352
+ status?: components["schemas"]["StatusEnum"];
353
+ /**
354
+ * Format: decimal
355
+ * @description De prijs van het product.
356
+ */
357
+ prijs?: string | null;
358
+ /**
359
+ * Prijs frequentie
360
+ * @description De frequentie van betalingen.
361
+ *
362
+ * * `eenmalig` - Eenmalig
363
+ * * `maandelijks` - Maandelijks
364
+ * * `jaarlijks` - Jaarlijks
365
+ */
366
+ frequentie?: components["schemas"]["FrequentieEnum"] | components["schemas"]["BlankEnum"];
367
+ /** @description Verbruiksobject van dit product. Wordt gevalideerd met het `verbruiksobject_schema` uit het producttype. */
368
+ verbruiksobject?: {
369
+ [key: string]: unknown;
370
+ } | null;
371
+ /** @description Dataobject van dit product. Wordt gevalideerd met het `dataobject_schema` uit het producttype. */
372
+ dataobject?: {
373
+ [key: string]: unknown;
374
+ } | null;
375
+ /** @description De zaak waaruit dit product is ontstaan. (<organisatie>:<systeem>:<component>:<resource>:<identificatie>) */
376
+ aanvraag_zaak_urn?: string | null;
377
+ /**
378
+ * Format: uri
379
+ * @description De zaak waaruit dit product is ontstaan.
380
+ */
381
+ aanvraag_zaak_url?: string | null;
382
+ };
383
+ ProductRequest: {
384
+ /** @description De naam van dit product. */
385
+ naam?: string;
386
+ /**
387
+ * Format: date
388
+ * @description De start datum van dit product. Op deze datum zal de status van het product automatisch naar ACTIEF worden gezet. Op het moment dat de start_datum wordt ingevuld moet de status ACTIEF op het producttype zijn toegestaan.
389
+ */
390
+ start_datum?: string | null;
391
+ /**
392
+ * Format: date
393
+ * @description De einddatum van dit product. Op deze datum zal de status van het product automatisch naar VERLOPEN worden gezet. Op het moment dat de eind_datum wordt ingevuld moet de status VERLOPEN op het producttype zijn toegestaan.
394
+ */
395
+ eind_datum?: string | null;
396
+ /** Format: uuid */
397
+ producttype_uuid: string;
398
+ /** @description Geeft aan of het product getoond kan worden. */
399
+ gepubliceerd?: boolean;
400
+ eigenaren: components["schemas"]["EigenaarRequest"][];
401
+ documenten?: components["schemas"]["NestedDocumentRequest"][];
402
+ zaken?: components["schemas"]["NestedZaakRequest"][];
403
+ taken?: components["schemas"]["NestedTaakRequest"][];
404
+ /**
405
+ * @description De status opties worden bepaald door het veld 'toegestane statussen' van het gerelateerde producttype. Via start & eind_datum kan de status automatisch naar ACTIEF of VERLOPEN worden gezet (mits deze statussen zijn toegestaan op het producttype).
406
+ *
407
+ * * `initieel` - Initieel
408
+ * * `in_aanvraag` - In aanvraag
409
+ * * `gereed` - Gereed
410
+ * * `actief` - Actief
411
+ * * `ingetrokken` - Ingetrokken
412
+ * * `geweigerd` - Geweigerd
413
+ * * `verlopen` - Verlopen
414
+ */
415
+ status?: components["schemas"]["StatusEnum"];
416
+ /**
417
+ * Format: decimal
418
+ * @description De prijs van het product.
419
+ */
420
+ prijs?: string | null;
421
+ /**
422
+ * Prijs frequentie
423
+ * @description De frequentie van betalingen.
424
+ *
425
+ * * `eenmalig` - Eenmalig
426
+ * * `maandelijks` - Maandelijks
427
+ * * `jaarlijks` - Jaarlijks
428
+ */
429
+ frequentie?: components["schemas"]["FrequentieEnum"] | components["schemas"]["BlankEnum"];
430
+ /** @description Verbruiksobject van dit product. Wordt gevalideerd met het `verbruiksobject_schema` uit het producttype. */
431
+ verbruiksobject?: {
432
+ [key: string]: unknown;
433
+ } | null;
434
+ /** @description Dataobject van dit product. Wordt gevalideerd met het `dataobject_schema` uit het producttype. */
435
+ dataobject?: {
436
+ [key: string]: unknown;
437
+ } | null;
438
+ /** @description De zaak waaruit dit product is ontstaan. (<organisatie>:<systeem>:<component>:<resource>:<identificatie>) */
439
+ aanvraag_zaak_urn?: string | null;
440
+ /**
441
+ * Format: uri
442
+ * @description De zaak waaruit dit product is ontstaan.
443
+ */
444
+ aanvraag_zaak_url?: string | null;
445
+ };
446
+ /**
447
+ * @description * `initieel` - Initieel
448
+ * * `in_aanvraag` - In aanvraag
449
+ * * `gereed` - Gereed
450
+ * * `actief` - Actief
451
+ * * `ingetrokken` - Ingetrokken
452
+ * * `geweigerd` - Geweigerd
453
+ * * `verlopen` - Verlopen
454
+ * @enum {string}
455
+ */
456
+ StatusEnum: "initieel" | "in_aanvraag" | "gereed" | "actief" | "ingetrokken" | "geweigerd" | "verlopen";
457
+ /**
458
+ * @description * `in_aanvraag` - In aanvraag
459
+ * * `gereed` - Gereed
460
+ * * `actief` - Actief
461
+ * * `ingetrokken` - Ingetrokken
462
+ * * `geweigerd` - Geweigerd
463
+ * * `verlopen` - Verlopen
464
+ * @enum {string}
465
+ */
466
+ ToegestaneStatussenEnum: "in_aanvraag" | "gereed" | "actief" | "ingetrokken" | "geweigerd" | "verlopen";
467
+ };
468
+ responses: never;
469
+ parameters: never;
470
+ requestBodies: never;
471
+ headers: never;
472
+ pathItems: never;
473
+ }
474
+ export type $defs = Record<string, never>;
475
+ export interface operations {
476
+ producten_list: {
477
+ parameters: {
478
+ query?: {
479
+ /** @description De datum waarop het object is aangemaakt. */
480
+ aanmaak_datum?: string;
481
+ /** @description De datum waarop het object is aangemaakt. */
482
+ aanmaak_datum__gte?: string;
483
+ /** @description De datum waarop het object is aangemaakt. */
484
+ aanmaak_datum__lte?: string;
485
+ /** @description De zaak waaruit dit product is ontstaan. */
486
+ aanvraag_zaak_url?: string;
487
+ /** @description De zaak waaruit dit product is ontstaan. */
488
+ aanvraag_zaak_url__contains?: string;
489
+ /** @description De zaak waaruit dit product is ontstaan. (<organisatie>:<systeem>:<component>:<resource>:<identificatie>) */
490
+ aanvraag_zaak_urn?: string;
491
+ /** @description De zaak waaruit dit product is ontstaan. (<organisatie>:<systeem>:<component>:<resource>:<identificatie>) */
492
+ aanvraag_zaak_urn__contains?: string;
493
+ /**
494
+ * @description Een json filter parameter heeft de format `key__operator__waarde`.
495
+ * `key` is de naam van de attribuut, `operator` is de operator die gebruikt moet worden en `waarde` is de waarde waarop zal worden gezocht.
496
+ *
497
+ * Waardes kunnen een string, nummer of datum (ISO format; YYYY-MM-DD) zijn.
498
+ *
499
+ * De ondersteunde operators zijn:
500
+ * * `exact` - gelijk aan
501
+ * * `gt` - groter dan
502
+ * * `gte` - groter dan of gelijk aan
503
+ * * `lt` - kleiner dan
504
+ * * `lte` - kleiner dan of gelijk aan
505
+ * * `icontains` - hoofdletterongevoelige gedeeltelijke match
506
+ * * `in` - in een lijst van waarden gescheiden door `|`
507
+ *
508
+ * `key` mag ook geen komma's bevatten.
509
+ *
510
+ * Voorbeeld: om producten met `kenteken`: `AA-111-B` in het dataobject vinden: `dataobject_attr=kenteken__exact__AA-111-B`.
511
+ * Als `kenteken` genest zit in `auto`: `dataobject_attr=auto__kenteken__exact__AA-111-B`
512
+ *
513
+ *
514
+ *
515
+ * Meerdere filters kunnen worden toegevoegd door `dataobject_attr` meerdere keren aan het request toe te voegen.
516
+ * Bijvoorbeeld: `dataobject_attr=kenteken__exact__AA-111-B&objectdata_attr=zone__exact__B`
517
+ */
518
+ dataobject_attr?: string;
519
+ documenten__url?: string;
520
+ documenten__url__contains?: string;
521
+ documenten__urn?: string;
522
+ documenten__urn__contains?: string;
523
+ /** @description Het BSN van de product eigenaar, BSN van 8 karakters moet met een extra 0 beginnen. */
524
+ eigenaren__bsn?: string;
525
+ /** @description generiek veld voor de identificatie van een klant of partij. */
526
+ eigenaren__klantnummer?: string;
527
+ /** @description Het kvk nummer van de product eigenaar */
528
+ eigenaren__kvk_nummer?: string;
529
+ eigenaren__uuid?: string;
530
+ /** @description Een korte unieke aanduiding van een vestiging. */
531
+ eigenaren__vestigingsnummer?: string;
532
+ /** @description De einddatum van dit product. Op deze datum zal de status van het product automatisch naar VERLOPEN worden gezet. Op het moment dat de eind_datum wordt ingevuld moet de status VERLOPEN op het producttype zijn toegestaan. */
533
+ eind_datum?: string;
534
+ /** @description De einddatum van dit product. Op deze datum zal de status van het product automatisch naar VERLOPEN worden gezet. Op het moment dat de eind_datum wordt ingevuld moet de status VERLOPEN op het producttype zijn toegestaan. */
535
+ eind_datum__gte?: string;
536
+ /** @description De einddatum van dit product. Op deze datum zal de status van het product automatisch naar VERLOPEN worden gezet. Op het moment dat de eind_datum wordt ingevuld moet de status VERLOPEN op het producttype zijn toegestaan. */
537
+ eind_datum__lte?: string;
538
+ /**
539
+ * @description De frequentie van betalingen.
540
+ *
541
+ * * `eenmalig` - Eenmalig
542
+ * * `maandelijks` - Maandelijks
543
+ * * `jaarlijks` - Jaarlijks
544
+ */
545
+ frequentie?: "eenmalig" | "jaarlijks" | "maandelijks";
546
+ /** @description Geeft aan of het product getoond kan worden. */
547
+ gepubliceerd?: boolean;
548
+ /** @description De naam van dit product. */
549
+ naam?: string;
550
+ /** @description Een pagina binnen de gepagineerde set resultaten. */
551
+ page?: number;
552
+ /** @description Het aantal resultaten terug te geven per pagina. (default: 100, maximum: 500). */
553
+ page_size?: number;
554
+ /** @description De prijs van het product. */
555
+ prijs?: number;
556
+ /** @description De prijs van het product. */
557
+ prijs__gte?: number;
558
+ /** @description De prijs van het product. */
559
+ prijs__lte?: number;
560
+ /** @description code van het producttype. */
561
+ producttype__code?: string;
562
+ /** @description Meerdere waarden kunnen gescheiden worden door komma's. */
563
+ producttype__code__in?: string[];
564
+ producttype__gepubliceerd?: boolean;
565
+ producttype__locaties__uuid?: string;
566
+ /** @description De Nederlandse naam van het producttype */
567
+ producttype__naam?: string;
568
+ /** @description De Nederlandse naam van het producttype */
569
+ producttype__naam__icontains?: string;
570
+ /** @description De Nederlandse naam van het producttype */
571
+ producttype__naam__in?: string[];
572
+ /** @description code van de organisatie. */
573
+ producttype__organisaties__code?: string;
574
+ producttype__organisaties__uuid?: string;
575
+ /** @description Naam van het thema. */
576
+ producttype__themas__naam?: string;
577
+ /** @description Lijst van thema namen waarop kan worden gezocht. */
578
+ producttype__themas__naam__in?: string[];
579
+ producttype__themas__uuid?: string;
580
+ /** @description Lijst van thema uuids waarop kan worden gezocht. */
581
+ producttype__themas__uuid__in?: string[];
582
+ producttype__uuid?: string;
583
+ /** @description Meerdere waarden kunnen gescheiden worden door komma's. */
584
+ producttype__uuid__in?: string[];
585
+ /** @description De start datum van dit product. Op deze datum zal de status van het product automatisch naar ACTIEF worden gezet. Op het moment dat de start_datum wordt ingevuld moet de status ACTIEF op het producttype zijn toegestaan. */
586
+ start_datum?: string;
587
+ /** @description De start datum van dit product. Op deze datum zal de status van het product automatisch naar ACTIEF worden gezet. Op het moment dat de start_datum wordt ingevuld moet de status ACTIEF op het producttype zijn toegestaan. */
588
+ start_datum__gte?: string;
589
+ /** @description De start datum van dit product. Op deze datum zal de status van het product automatisch naar ACTIEF worden gezet. Op het moment dat de start_datum wordt ingevuld moet de status ACTIEF op het producttype zijn toegestaan. */
590
+ start_datum__lte?: string;
591
+ /**
592
+ * @description De status opties worden bepaald door het veld 'toegestane statussen' van het gerelateerde producttype. Via start & eind_datum kan de status automatisch naar ACTIEF of VERLOPEN worden gezet (mits deze statussen zijn toegestaan op het producttype).
593
+ *
594
+ * * `initieel` - Initieel
595
+ * * `in_aanvraag` - In aanvraag
596
+ * * `gereed` - Gereed
597
+ * * `actief` - Actief
598
+ * * `ingetrokken` - Ingetrokken
599
+ * * `geweigerd` - Geweigerd
600
+ * * `verlopen` - Verlopen
601
+ */
602
+ status?: "actief" | "gereed" | "geweigerd" | "in_aanvraag" | "ingetrokken" | "initieel" | "verlopen";
603
+ taken__url?: string;
604
+ taken__url__contains?: string;
605
+ taken__urn?: string;
606
+ taken__urn__contains?: string;
607
+ /** @description Uniforme product naam */
608
+ uniforme_product_naam?: string;
609
+ /** @description De datum waarop het object voor het laatst is gewijzigd. */
610
+ update_datum?: string;
611
+ /** @description De datum waarop het object voor het laatst is gewijzigd. */
612
+ update_datum__gte?: string;
613
+ /** @description De datum waarop het object voor het laatst is gewijzigd. */
614
+ update_datum__lte?: string;
615
+ /**
616
+ * @description Een json filter parameter heeft de format `key__operator__waarde`.
617
+ * `key` is de naam van de attribuut, `operator` is de operator die gebruikt moet worden en `waarde` is de waarde waarop zal worden gezocht.
618
+ *
619
+ * Waardes kunnen een string, nummer of datum (ISO format; YYYY-MM-DD) zijn.
620
+ *
621
+ * De ondersteunde operators zijn:
622
+ * * `exact` - gelijk aan
623
+ * * `gt` - groter dan
624
+ * * `gte` - groter dan of gelijk aan
625
+ * * `lt` - kleiner dan
626
+ * * `lte` - kleiner dan of gelijk aan
627
+ * * `icontains` - hoofdletterongevoelige gedeeltelijke match
628
+ * * `in` - in een lijst van waarden gescheiden door `|`
629
+ *
630
+ * `key` mag ook geen komma's bevatten.
631
+ *
632
+ * Voorbeeld: om producten met `kenteken`: `AA-111-B` in het dataobject vinden: `dataobject_attr=kenteken__exact__AA-111-B`.
633
+ * Als `kenteken` genest zit in `auto`: `dataobject_attr=auto__kenteken__exact__AA-111-B`
634
+ *
635
+ *
636
+ *
637
+ * Meerdere filters kunnen worden toegevoegd door `dataobject_attr` meerdere keren aan het request toe te voegen.
638
+ * Bijvoorbeeld: `dataobject_attr=kenteken__exact__AA-111-B&objectdata_attr=zone__exact__B`
639
+ */
640
+ verbruiksobject_attr?: string;
641
+ zaken__url?: string;
642
+ zaken__url__contains?: string;
643
+ zaken__urn?: string;
644
+ zaken__urn__contains?: string;
645
+ };
646
+ header?: never;
647
+ path?: never;
648
+ cookie?: never;
649
+ };
650
+ requestBody?: never;
651
+ responses: {
652
+ 200: {
653
+ headers: {
654
+ /** @description Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1. */
655
+ "API-version"?: string;
656
+ [name: string]: unknown;
657
+ };
658
+ content: {
659
+ "application/json": components["schemas"]["PaginatedProductList"];
660
+ };
661
+ };
662
+ /** @description Validation error */
663
+ 400: {
664
+ headers: {
665
+ /** @description Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1. */
666
+ "API-version"?: string;
667
+ [name: string]: unknown;
668
+ };
669
+ content: {
670
+ "application/json": components["schemas"]["Error"];
671
+ };
672
+ };
673
+ 403: {
674
+ headers: {
675
+ /** @description Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1. */
676
+ "API-version"?: string;
677
+ [name: string]: unknown;
678
+ };
679
+ content: {
680
+ "application/json": components["schemas"]["DetailError"];
681
+ };
682
+ };
683
+ };
684
+ };
685
+ producten_create: {
686
+ parameters: {
687
+ query?: never;
688
+ header?: never;
689
+ path?: never;
690
+ cookie?: never;
691
+ };
692
+ requestBody: {
693
+ content: {
694
+ "application/json": components["schemas"]["ProductRequest"];
695
+ };
696
+ };
697
+ responses: {
698
+ 201: {
699
+ headers: {
700
+ /** @description Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1. */
701
+ "API-version"?: string;
702
+ [name: string]: unknown;
703
+ };
704
+ content: {
705
+ "application/json": components["schemas"]["Product"];
706
+ };
707
+ };
708
+ /** @description Validation error */
709
+ 400: {
710
+ headers: {
711
+ /** @description Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1. */
712
+ "API-version"?: string;
713
+ [name: string]: unknown;
714
+ };
715
+ content: {
716
+ "application/json": components["schemas"]["Error"];
717
+ };
718
+ };
719
+ 403: {
720
+ headers: {
721
+ /** @description Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1. */
722
+ "API-version"?: string;
723
+ [name: string]: unknown;
724
+ };
725
+ content: {
726
+ "application/json": components["schemas"]["DetailError"];
727
+ };
728
+ };
729
+ };
730
+ };
731
+ producten_retrieve: {
732
+ parameters: {
733
+ query?: never;
734
+ header?: never;
735
+ path: {
736
+ uuid: string;
737
+ };
738
+ cookie?: never;
739
+ };
740
+ requestBody?: never;
741
+ responses: {
742
+ 200: {
743
+ headers: {
744
+ /** @description Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1. */
745
+ "API-version"?: string;
746
+ [name: string]: unknown;
747
+ };
748
+ content: {
749
+ "application/json": components["schemas"]["Product"];
750
+ };
751
+ };
752
+ /** @description Validation error */
753
+ 400: {
754
+ headers: {
755
+ /** @description Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1. */
756
+ "API-version"?: string;
757
+ [name: string]: unknown;
758
+ };
759
+ content: {
760
+ "application/json": components["schemas"]["Error"];
761
+ };
762
+ };
763
+ 403: {
764
+ headers: {
765
+ /** @description Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1. */
766
+ "API-version"?: string;
767
+ [name: string]: unknown;
768
+ };
769
+ content: {
770
+ "application/json": components["schemas"]["DetailError"];
771
+ };
772
+ };
773
+ };
774
+ };
775
+ producten_update: {
776
+ parameters: {
777
+ query?: never;
778
+ header?: never;
779
+ path: {
780
+ uuid: string;
781
+ };
782
+ cookie?: never;
783
+ };
784
+ requestBody: {
785
+ content: {
786
+ "application/json": components["schemas"]["ProductRequest"];
787
+ };
788
+ };
789
+ responses: {
790
+ 200: {
791
+ headers: {
792
+ /** @description Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1. */
793
+ "API-version"?: string;
794
+ [name: string]: unknown;
795
+ };
796
+ content: {
797
+ "application/json": components["schemas"]["Product"];
798
+ };
799
+ };
800
+ /** @description Validation error */
801
+ 400: {
802
+ headers: {
803
+ /** @description Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1. */
804
+ "API-version"?: string;
805
+ [name: string]: unknown;
806
+ };
807
+ content: {
808
+ "application/json": components["schemas"]["Error"];
809
+ };
810
+ };
811
+ 403: {
812
+ headers: {
813
+ /** @description Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1. */
814
+ "API-version"?: string;
815
+ [name: string]: unknown;
816
+ };
817
+ content: {
818
+ "application/json": components["schemas"]["DetailError"];
819
+ };
820
+ };
821
+ };
822
+ };
823
+ producten_destroy: {
824
+ parameters: {
825
+ query?: never;
826
+ header?: never;
827
+ path: {
828
+ uuid: string;
829
+ };
830
+ cookie?: never;
831
+ };
832
+ requestBody?: never;
833
+ responses: {
834
+ /** @description No response body */
835
+ 204: {
836
+ headers: {
837
+ /** @description Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1. */
838
+ "API-version"?: string;
839
+ [name: string]: unknown;
840
+ };
841
+ content?: never;
842
+ };
843
+ /** @description Validation error */
844
+ 400: {
845
+ headers: {
846
+ /** @description Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1. */
847
+ "API-version"?: string;
848
+ [name: string]: unknown;
849
+ };
850
+ content: {
851
+ "application/json": components["schemas"]["Error"];
852
+ };
853
+ };
854
+ 403: {
855
+ headers: {
856
+ /** @description Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1. */
857
+ "API-version"?: string;
858
+ [name: string]: unknown;
859
+ };
860
+ content: {
861
+ "application/json": components["schemas"]["DetailError"];
862
+ };
863
+ };
864
+ };
865
+ };
866
+ producten_partial_update: {
867
+ parameters: {
868
+ query?: never;
869
+ header?: never;
870
+ path: {
871
+ uuid: string;
872
+ };
873
+ cookie?: never;
874
+ };
875
+ requestBody?: {
876
+ content: {
877
+ "application/json": components["schemas"]["PatchedProductRequest"];
878
+ };
879
+ };
880
+ responses: {
881
+ 200: {
882
+ headers: {
883
+ /** @description Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1. */
884
+ "API-version"?: string;
885
+ [name: string]: unknown;
886
+ };
887
+ content: {
888
+ "application/json": components["schemas"]["Product"];
889
+ };
890
+ };
891
+ /** @description Validation error */
892
+ 400: {
893
+ headers: {
894
+ /** @description Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1. */
895
+ "API-version"?: string;
896
+ [name: string]: unknown;
897
+ };
898
+ content: {
899
+ "application/json": components["schemas"]["Error"];
900
+ };
901
+ };
902
+ 403: {
903
+ headers: {
904
+ /** @description Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1. */
905
+ "API-version"?: string;
906
+ [name: string]: unknown;
907
+ };
908
+ content: {
909
+ "application/json": components["schemas"]["DetailError"];
910
+ };
911
+ };
912
+ };
913
+ };
914
+ }