Skip to content

Commit 807a376

Browse files
EraYaNEraYaN
committed
Release 1.3.1 (2024-05-14)
- Add `DeelWaarderingWebhookPayload` model. - Use of strings for CBS codes. - Add `buurtCode` field to `CbsIndeling` model. - Allow for string input for endpoint `buurt`. - Add UserAgent header to callback requests with format: CalcasaPublicAPI/`<version>`
1 parent b2a069f commit 807a376

File tree

90 files changed

+387
-151
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

90 files changed

+387
-151
lines changed

‎Calcasa.Api.sln

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@ Microsoft Visual Studio Solution File, Format Version 12.00
22
# Visual Studio 14
33
VisualStudioVersion = 14.0.25420.1
44
MinimumVisualStudioVersion = 10.0.40219.1
5-
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Calcasa.Api", "src\Calcasa.Api\Calcasa.Api.csproj", "{6BB4513D-95FB-4CC7-9F74-2F0560179FE6}"
5+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Calcasa.Api", "src\Calcasa.Api\Calcasa.Api.csproj", "{FF69C973-A54C-4B94-A793-9E94DD3B479D}"
66
EndProject
77
Global
88
GlobalSection(SolutionConfigurationPlatforms) = preSolution
99
Debug|Any CPU = Debug|Any CPU
1010
Release|Any CPU = Release|Any CPU
1111
EndGlobalSection
1212
GlobalSection(ProjectConfigurationPlatforms) = postSolution
13-
{6BB4513D-95FB-4CC7-9F74-2F0560179FE6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
14-
{6BB4513D-95FB-4CC7-9F74-2F0560179FE6}.Debug|Any CPU.Build.0 = Debug|Any CPU
15-
{6BB4513D-95FB-4CC7-9F74-2F0560179FE6}.Release|Any CPU.ActiveCfg = Release|Any CPU
16-
{6BB4513D-95FB-4CC7-9F74-2F0560179FE6}.Release|Any CPU.Build.0 = Release|Any CPU
13+
{FF69C973-A54C-4B94-A793-9E94DD3B479D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
14+
{FF69C973-A54C-4B94-A793-9E94DD3B479D}.Debug|Any CPU.Build.0 = Debug|Any CPU
15+
{FF69C973-A54C-4B94-A793-9E94DD3B479D}.Release|Any CPU.ActiveCfg = Release|Any CPU
16+
{FF69C973-A54C-4B94-A793-9E94DD3B479D}.Release|Any CPU.Build.0 = Release|Any CPU
1717
{19F1DEBC-DE5E-4517-8062-F000CD499087}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
1818
{19F1DEBC-DE5E-4517-8062-F000CD499087}.Debug|Any CPU.Build.0 = Debug|Any CPU
1919
{19F1DEBC-DE5E-4517-8062-F000CD499087}.Release|Any CPU.ActiveCfg = Release|Any CPU

‎README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,14 @@ This API is documented in **OpenAPI format version 3** you can use tools like th
1717

1818
## Changelog
1919

20-
### 2023-10-24 (v1.3.0)
20+
### 2024-05-14 (v1.3.1)
21+
- Add `DeelWaarderingWebhookPayload` model.
22+
- Use of strings for CBS codes.
23+
- Add `buurtCode` field to `CbsIndeling` model.
24+
- Allow for string input for endpoint `buurt`.
25+
- Add UserAgent header to callback requests with format: CalcasaPublicAPI/`<version>`
26+
27+
### 2023-11-14 (v1.3.0)
2128
- Add `geldverstrekker` field to the `CallbackInschrijving` model.
2229
- Add support for mTLS on the callback service.
2330
- By default when requested by the target server the public CA signed TLS certificate with the appropriate domain as Common Name will be offered as the client certificate.
@@ -171,8 +178,8 @@ Authentication is done via [OAuth2](https://oauth.net/2/) and the [client creden
171178

172179
This C# SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
173180

174-
- API version: 1.3.0
175-
- SDK version: 1.3.0
181+
- API version: 1.3.1
182+
- SDK version: 1.3.1
176183
- Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen
177184
For more information, please visit [https://www.calcasa.nl/contact](https://www.calcasa.nl/contact)
178185

@@ -301,7 +308,7 @@ Class | Method | HTTP request | Description
301308
*AdressenApi* | [**SearchAdres**](docs/AdressenApi.md#searchadres) | **POST** /api/v1/adressen/zoeken | Zoek adres info op basis van het gegeven adres.
302309
*BestemmingsplannenApi* | [**GetBestemmingById**](docs/BestemmingsplannenApi.md#getbestemmingbyid) | **GET** /api/v1/bestemmingsplannen/{bagNummeraanduidingId} | Gegevens over de bestemmingsplannen op de locatie van een adres (BAG Nummeraanduiding ID).
303310
*BodemApi* | [**GetBodemById**](docs/BodemApi.md#getbodembyid) | **GET** /api/v1/bodem/{bagNummeraanduidingId} | Gegevens over de bodemkwaliteit op de locatie van een adres (BAG Nummeraanduiding ID).
304-
*BuurtApi* | [**GetBuurt**](docs/BuurtApi.md#getbuurt) | **GET** /api/v1/buurt/{buurtId} | Gegevens over een buurt en de wijk, gemeente en land waarin deze buurt gesitueerd is.
311+
*BuurtApi* | [**GetBuurt**](docs/BuurtApi.md#getbuurt) | **GET** /api/v1/buurt/{buurtCode} | Gegevens over een buurt en de wijk, gemeente en land waarin deze buurt gesitueerd is.
305312
*CallbacksApi* | [**AddOrUpdateCallbackSubscription**](docs/CallbacksApi.md#addorupdatecallbacksubscription) | **POST** /api/v1/callbacks/inschrijvingen | Voeg een callback inschrijving toe (of werk bij) voor de huidige client voor een adres.
306313
*CallbacksApi* | [**DeleteNotificationSubscription**](docs/CallbacksApi.md#deletenotificationsubscription) | **DELETE** /api/v1/callbacks/inschrijvingen/{bagNummeraanduidingId} | Verwijder de callback inschrijving voor deze client, dit adres en optioneel een geldverstrekker.
307314
*CallbacksApi* | [**GetNotificationSubscription**](docs/CallbacksApi.md#getnotificationsubscription) | **GET** /api/v1/callbacks/inschrijvingen/{bagNummeraanduidingId} | Haal de callback inschrijving op voor deze client, dit adres en eventueel opgegeven geldverstrekker.
@@ -334,6 +341,7 @@ Class | Method | HTTP request | Description
334341
- [Model.Callback](docs/Callback.md)
335342
- [Model.CallbackInschrijving](docs/CallbackInschrijving.md)
336343
- [Model.CbsIndeling](docs/CbsIndeling.md)
344+
- [Model.DeelWaarderingWebhookPayload](docs/DeelWaarderingWebhookPayload.md)
337345
- [Model.Energielabel](docs/Energielabel.md)
338346
- [Model.EnergielabelData](docs/EnergielabelData.md)
339347
- [Model.Factuur](docs/Factuur.md)
@@ -426,7 +434,7 @@ Class | Method | HTTP request | Description
426434

427435
- **Type**: OAuth
428436
- **Flow**: accessCode
429-
- **Authorization URL**: https://authentication.calcasa.nl/oauth2/v2.0/authorize
437+
- **Authorization URL**: https://authentication.01.staging.calcasa.nl/oauth2/v2.0/authorize
430438
- **Scopes**:
431439
- all: Full permissions for all areas.
432440
- api:all: Full permissions for all areas of the public API.

‎src/Calcasa.Api/Api/AdressenApi.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
*
1616
* Calcasa Public API v1
1717
*
18-
* The version of the OpenAPI document: 1.3.0
18+
* The version of the OpenAPI document: 1.3.1
1919
* Contact: [email protected]
2020
* Generated by: https://github.com/openapitools/openapi-generator.git
2121
*/

‎src/Calcasa.Api/Api/BestemmingsplannenApi.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
*
1616
* Calcasa Public API v1
1717
*
18-
* The version of the OpenAPI document: 1.3.0
18+
* The version of the OpenAPI document: 1.3.1
1919
* Contact: [email protected]
2020
* Generated by: https://github.com/openapitools/openapi-generator.git
2121
*/

‎src/Calcasa.Api/Api/BodemApi.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
*
1616
* Calcasa Public API v1
1717
*
18-
* The version of the OpenAPI document: 1.3.0
18+
* The version of the OpenAPI document: 1.3.1
1919
* Contact: [email protected]
2020
* Generated by: https://github.com/openapitools/openapi-generator.git
2121
*/

‎src/Calcasa.Api/Api/BuurtApi.cs

Lines changed: 31 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
*
1616
* Calcasa Public API v1
1717
*
18-
* The version of the OpenAPI document: 1.3.0
18+
* The version of the OpenAPI document: 1.3.1
1919
* Contact: [email protected]
2020
* Generated by: https://github.com/openapitools/openapi-generator.git
2121
*/
@@ -46,9 +46,9 @@ public interface IBuurtApiSync : IApiAccessor
4646
/// Het omgevingdata object zal gefilterd terug komen afhankelijk van het client_id wat gebruikt is voor de authenticatie.
4747
/// </remarks>
4848
/// <exception cref="Calcasa.Api.Client.ApiException">Thrown when fails to make API call</exception>
49-
/// <param name="buurtId">Een CBS buurt ID.</param>
49+
/// <param name="buurtCode">Een CBS buurt code.</param>
5050
/// <returns>Omgevingsdata</returns>
51-
Omgevingsdata GetBuurt(int buurtId);
51+
Omgevingsdata GetBuurt(string buurtCode);
5252

5353
/// <summary>
5454
/// Gegevens over een buurt en de wijk, gemeente en land waarin deze buurt gesitueerd is.
@@ -57,9 +57,9 @@ public interface IBuurtApiSync : IApiAccessor
5757
/// Het omgevingdata object zal gefilterd terug komen afhankelijk van het client_id wat gebruikt is voor de authenticatie.
5858
/// </remarks>
5959
/// <exception cref="Calcasa.Api.Client.ApiException">Thrown when fails to make API call</exception>
60-
/// <param name="buurtId">Een CBS buurt ID.</param>
60+
/// <param name="buurtCode">Een CBS buurt code.</param>
6161
/// <returns>ApiResponse of Omgevingsdata</returns>
62-
ApiResponse<Omgevingsdata> GetBuurtWithHttpInfo(int buurtId);
62+
ApiResponse<Omgevingsdata> GetBuurtWithHttpInfo(string buurtCode);
6363
#endregion Synchronous Operations
6464
}
6565

@@ -76,10 +76,10 @@ public interface IBuurtApiAsync : IApiAccessor
7676
/// Het omgevingdata object zal gefilterd terug komen afhankelijk van het client_id wat gebruikt is voor de authenticatie.
7777
/// </remarks>
7878
/// <exception cref="Calcasa.Api.Client.ApiException">Thrown when fails to make API call</exception>
79-
/// <param name="buurtId">Een CBS buurt ID.</param>
79+
/// <param name="buurtCode">Een CBS buurt code.</param>
8080
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
8181
/// <returns>Task of Omgevingsdata</returns>
82-
System.Threading.Tasks.Task<Omgevingsdata> GetBuurtAsync(int buurtId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken));
82+
System.Threading.Tasks.Task<Omgevingsdata> GetBuurtAsync(string buurtCode, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken));
8383

8484
/// <summary>
8585
/// Gegevens over een buurt en de wijk, gemeente en land waarin deze buurt gesitueerd is.
@@ -88,10 +88,10 @@ public interface IBuurtApiAsync : IApiAccessor
8888
/// Het omgevingdata object zal gefilterd terug komen afhankelijk van het client_id wat gebruikt is voor de authenticatie.
8989
/// </remarks>
9090
/// <exception cref="Calcasa.Api.Client.ApiException">Thrown when fails to make API call</exception>
91-
/// <param name="buurtId">Een CBS buurt ID.</param>
91+
/// <param name="buurtCode">Een CBS buurt code.</param>
9292
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
9393
/// <returns>Task of ApiResponse (Omgevingsdata)</returns>
94-
System.Threading.Tasks.Task<ApiResponse<Omgevingsdata>> GetBuurtWithHttpInfoAsync(int buurtId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken));
94+
System.Threading.Tasks.Task<ApiResponse<Omgevingsdata>> GetBuurtWithHttpInfoAsync(string buurtCode, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken));
9595
#endregion Asynchronous Operations
9696
}
9797

@@ -309,22 +309,26 @@ public Calcasa.Api.Client.ExceptionFactory ExceptionFactory
309309
/// Gegevens over een buurt en de wijk, gemeente en land waarin deze buurt gesitueerd is. Het omgevingdata object zal gefilterd terug komen afhankelijk van het client_id wat gebruikt is voor de authenticatie.
310310
/// </summary>
311311
/// <exception cref="Calcasa.Api.Client.ApiException">Thrown when fails to make API call</exception>
312-
/// <param name="buurtId">Een CBS buurt ID.</param>
312+
/// <param name="buurtCode">Een CBS buurt code.</param>
313313
/// <returns>Omgevingsdata</returns>
314-
public Omgevingsdata GetBuurt(int buurtId)
314+
public Omgevingsdata GetBuurt(string buurtCode)
315315
{
316-
Calcasa.Api.Client.ApiResponse<Omgevingsdata> localVarResponse = GetBuurtWithHttpInfo(buurtId);
316+
Calcasa.Api.Client.ApiResponse<Omgevingsdata> localVarResponse = GetBuurtWithHttpInfo(buurtCode);
317317
return localVarResponse.Data;
318318
}
319319

320320
/// <summary>
321321
/// Gegevens over een buurt en de wijk, gemeente en land waarin deze buurt gesitueerd is. Het omgevingdata object zal gefilterd terug komen afhankelijk van het client_id wat gebruikt is voor de authenticatie.
322322
/// </summary>
323323
/// <exception cref="Calcasa.Api.Client.ApiException">Thrown when fails to make API call</exception>
324-
/// <param name="buurtId">Een CBS buurt ID.</param>
324+
/// <param name="buurtCode">Een CBS buurt code.</param>
325325
/// <returns>ApiResponse of Omgevingsdata</returns>
326-
public Calcasa.Api.Client.ApiResponse<Omgevingsdata> GetBuurtWithHttpInfo(int buurtId)
326+
public Calcasa.Api.Client.ApiResponse<Omgevingsdata> GetBuurtWithHttpInfo(string buurtCode)
327327
{
328+
// verify the required parameter 'buurtCode' is set
329+
if (buurtCode == null)
330+
throw new Calcasa.Api.Client.ApiException(400, "Missing required parameter 'buurtCode' when calling BuurtApi->GetBuurt");
331+
328332
Calcasa.Api.Client.RequestOptions localVarRequestOptions = new Calcasa.Api.Client.RequestOptions();
329333

330334
string[] _contentTypes = new string[] {
@@ -342,7 +346,7 @@ public Calcasa.Api.Client.ApiResponse<Omgevingsdata> GetBuurtWithHttpInfo(int bu
342346
var localVarAccept = Calcasa.Api.Client.ClientUtils.SelectHeaderAccept(_accepts);
343347
if (localVarAccept != null) localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept);
344348

345-
localVarRequestOptions.PathParameters.Add("buurtId", Calcasa.Api.Client.ClientUtils.ParameterToString(buurtId)); // path parameter
349+
localVarRequestOptions.PathParameters.Add("buurtCode", Calcasa.Api.Client.ClientUtils.ParameterToString(buurtCode)); // path parameter
346350

347351
// authentication (oauth) required
348352
// oauth required
@@ -358,7 +362,7 @@ public Calcasa.Api.Client.ApiResponse<Omgevingsdata> GetBuurtWithHttpInfo(int bu
358362
}
359363

360364
// make the HTTP request
361-
var localVarResponse = this.Client.Get<Omgevingsdata>("/api/v1/buurt/{buurtId}", localVarRequestOptions, this.Configuration);
365+
var localVarResponse = this.Client.Get<Omgevingsdata>("/api/v1/buurt/{buurtCode}", localVarRequestOptions, this.Configuration);
362366

363367
if (this.ExceptionFactory != null)
364368
{
@@ -373,24 +377,28 @@ public Calcasa.Api.Client.ApiResponse<Omgevingsdata> GetBuurtWithHttpInfo(int bu
373377
/// Gegevens over een buurt en de wijk, gemeente en land waarin deze buurt gesitueerd is. Het omgevingdata object zal gefilterd terug komen afhankelijk van het client_id wat gebruikt is voor de authenticatie.
374378
/// </summary>
375379
/// <exception cref="Calcasa.Api.Client.ApiException">Thrown when fails to make API call</exception>
376-
/// <param name="buurtId">Een CBS buurt ID.</param>
380+
/// <param name="buurtCode">Een CBS buurt code.</param>
377381
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
378382
/// <returns>Task of Omgevingsdata</returns>
379-
public async System.Threading.Tasks.Task<Omgevingsdata> GetBuurtAsync(int buurtId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))
383+
public async System.Threading.Tasks.Task<Omgevingsdata> GetBuurtAsync(string buurtCode, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))
380384
{
381-
Calcasa.Api.Client.ApiResponse<Omgevingsdata> localVarResponse = await GetBuurtWithHttpInfoAsync(buurtId, cancellationToken).ConfigureAwait(false);
385+
Calcasa.Api.Client.ApiResponse<Omgevingsdata> localVarResponse = await GetBuurtWithHttpInfoAsync(buurtCode, cancellationToken).ConfigureAwait(false);
382386
return localVarResponse.Data;
383387
}
384388

385389
/// <summary>
386390
/// Gegevens over een buurt en de wijk, gemeente en land waarin deze buurt gesitueerd is. Het omgevingdata object zal gefilterd terug komen afhankelijk van het client_id wat gebruikt is voor de authenticatie.
387391
/// </summary>
388392
/// <exception cref="Calcasa.Api.Client.ApiException">Thrown when fails to make API call</exception>
389-
/// <param name="buurtId">Een CBS buurt ID.</param>
393+
/// <param name="buurtCode">Een CBS buurt code.</param>
390394
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
391395
/// <returns>Task of ApiResponse (Omgevingsdata)</returns>
392-
public async System.Threading.Tasks.Task<Calcasa.Api.Client.ApiResponse<Omgevingsdata>> GetBuurtWithHttpInfoAsync(int buurtId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))
396+
public async System.Threading.Tasks.Task<Calcasa.Api.Client.ApiResponse<Omgevingsdata>> GetBuurtWithHttpInfoAsync(string buurtCode, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))
393397
{
398+
// verify the required parameter 'buurtCode' is set
399+
if (buurtCode == null)
400+
throw new Calcasa.Api.Client.ApiException(400, "Missing required parameter 'buurtCode' when calling BuurtApi->GetBuurt");
401+
394402

395403
Calcasa.Api.Client.RequestOptions localVarRequestOptions = new Calcasa.Api.Client.RequestOptions();
396404

@@ -410,7 +418,7 @@ public Calcasa.Api.Client.ApiResponse<Omgevingsdata> GetBuurtWithHttpInfo(int bu
410418
var localVarAccept = Calcasa.Api.Client.ClientUtils.SelectHeaderAccept(_accepts);
411419
if (localVarAccept != null) localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept);
412420

413-
localVarRequestOptions.PathParameters.Add("buurtId", Calcasa.Api.Client.ClientUtils.ParameterToString(buurtId)); // path parameter
421+
localVarRequestOptions.PathParameters.Add("buurtCode", Calcasa.Api.Client.ClientUtils.ParameterToString(buurtCode)); // path parameter
414422

415423
// authentication (oauth) required
416424
// oauth required
@@ -427,7 +435,7 @@ public Calcasa.Api.Client.ApiResponse<Omgevingsdata> GetBuurtWithHttpInfo(int bu
427435

428436
// make the HTTP request
429437

430-
var localVarResponse = await this.AsynchronousClient.GetAsync<Omgevingsdata>("/api/v1/buurt/{buurtId}", localVarRequestOptions, this.Configuration, cancellationToken).ConfigureAwait(false);
438+
var localVarResponse = await this.AsynchronousClient.GetAsync<Omgevingsdata>("/api/v1/buurt/{buurtCode}", localVarRequestOptions, this.Configuration, cancellationToken).ConfigureAwait(false);
431439

432440
if (this.ExceptionFactory != null)
433441
{

‎src/Calcasa.Api/Api/CallbacksApi.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
*
1616
* Calcasa Public API v1
1717
*
18-
* The version of the OpenAPI document: 1.3.0
18+
* The version of the OpenAPI document: 1.3.1
1919
* Contact: [email protected]
2020
* Generated by: https://github.com/openapitools/openapi-generator.git
2121
*/

‎src/Calcasa.Api/Api/ConfiguratieApi.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
*
1616
* Calcasa Public API v1
1717
*
18-
* The version of the OpenAPI document: 1.3.0
18+
* The version of the OpenAPI document: 1.3.1
1919
* Contact: [email protected]
2020
* Generated by: https://github.com/openapitools/openapi-generator.git
2121
*/

‎src/Calcasa.Api/Api/FacturenApi.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
*
1616
* Calcasa Public API v1
1717
*
18-
* The version of the OpenAPI document: 1.3.0
18+
* The version of the OpenAPI document: 1.3.1
1919
* Contact: [email protected]
2020
* Generated by: https://github.com/openapitools/openapi-generator.git
2121
*/

‎src/Calcasa.Api/Api/FotosApi.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
*
1616
* Calcasa Public API v1
1717
*
18-
* The version of the OpenAPI document: 1.3.0
18+
* The version of the OpenAPI document: 1.3.1
1919
* Contact: [email protected]
2020
* Generated by: https://github.com/openapitools/openapi-generator.git
2121
*/

0 commit comments

Comments
 (0)