Skip to content

Commit 4102192

Browse files
bundesbotbundesbot
authored andcommitted
Generate newest code from openapi.yaml
1 parent f39f4a2 commit 4102192

44 files changed

Lines changed: 507 additions & 303 deletions

Some content is hidden

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

python-client/README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# jobsuche
2-
Die größte Stellendatenbank Deutschlands durchsuchen, Details zu Stellenanzeigen und Informationen über Arbeitgeber abrufen. <br><br>Die Authentifizierung funktioniert über die clientId:<br><br>clientId: jobboerse-jobsuche<br><br>Bei folgenden GET-requests ist die clientId als Header-Parameter 'X-API-Key' zu übergeben.
2+
Die größte Stellendatenbank Deutschlands durchsuchen, Details zu Stellenanzeigen und Informationen über Arbeitgeber abrufen. <br><br>Die Authentifizierung funktioniert über die clientId:<br><br>clientId: jobboerse-jobsuche<br><br>Bei folgenden GET-requests ist die clientId als Header-Parameter 'X-API-Key' zu übergeben.<br><br>Ablauf: (1) Stellen suchen via /pc/v4/jobs oder /pc/v4/app/jobs → refnr merken. (2) Details abrufen via /pc/v4/jobdetails/{base64(refnr)}. (3) Arbeitgeberlogo abrufen via /ct/v1/arbeitgeberlogo/{arbeitgeberKundennummerHash} (sofern vorhanden).
33

44
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
55

6-
- API version: 2.0.2
6+
- API version: 2.1.0
77
- Package version: 0.1.0
88
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
99

@@ -50,6 +50,7 @@ import time
5050
from deutschland import jobsuche
5151
from pprint import pprint
5252
from deutschland.jobsuche.api import default_api
53+
from deutschland.jobsuche.model.job_details import JobDetails
5354
from deutschland.jobsuche.model.job_search_response import JobSearchResponse
5455
# Defining the host is optional and defaults to https://rest.arbeitsagentur.de/jobboerse/jobsuche-service
5556
# See configuration.py for a list of all supported configuration parameters.
@@ -73,14 +74,14 @@ configuration.api_key['APIKeyHeaders'] = 'YOUR_API_KEY'
7374
with jobsuche.ApiClient(configuration) as api_client:
7475
# Create an instance of the API class
7576
api_instance = default_api.DefaultApi(api_client)
76-
hash_id = "VK2qoXBe0s-UAdH_qxLDRrZrY5iY8a1PJt3MjJCXsdo=" # str |
77+
kundennummer_hash = "Z-HzVkUCLGQiQFxQSAICs302sSdB9Sp7XtgOiO4GGCA=" # str | Wert des Feldes arbeitgeberKundennummerHash aus der Jobdetail-Antwort (URL-kodiert falls nötig).
7778

7879
try:
7980
# Unternehmen Logo
80-
api_response = api_instance.ed_v1_arbeitgeberlogo_hash_id_get(hash_id)
81+
api_response = api_instance.ct_v1_arbeitgeberlogo_kundennummer_hash_get(kundennummer_hash)
8182
pprint(api_response)
8283
except jobsuche.ApiException as e:
83-
print("Exception when calling DefaultApi->ed_v1_arbeitgeberlogo_hash_id_get: %s\n" % e)
84+
print("Exception when calling DefaultApi->ct_v1_arbeitgeberlogo_kundennummer_hash_get: %s\n" % e)
8485
```
8586

8687
## Documentation for API Endpoints
@@ -89,8 +90,10 @@ All URIs are relative to *https://rest.arbeitsagentur.de/jobboerse/jobsuche-serv
8990

9091
Class | Method | HTTP request | Description
9192
------------ | ------------- | ------------- | -------------
92-
*DefaultApi* | [**ed_v1_arbeitgeberlogo_hash_id_get**](docs/DefaultApi.md#ed_v1_arbeitgeberlogo_hash_id_get) | **GET** /ed/v1/arbeitgeberlogo/{hashID} | Unternehmen Logo
93+
*DefaultApi* | [**ct_v1_arbeitgeberlogo_kundennummer_hash_get**](docs/DefaultApi.md#ct_v1_arbeitgeberlogo_kundennummer_hash_get) | **GET** /ct/v1/arbeitgeberlogo/{kundennummerHash} | Unternehmen Logo
94+
*DefaultApi* | [**pc_v3_jobdetails_encrypted_job_code_get**](docs/DefaultApi.md#pc_v3_jobdetails_encrypted_job_code_get) | **GET** /pc/v3/jobdetails/{encryptedJobCode} | Jobdetails (v3)
9395
*DefaultApi* | [**pc_v4_app_jobs_get**](docs/DefaultApi.md#pc_v4_app_jobs_get) | **GET** /pc/v4/app/jobs | Jobsuche via App
96+
*DefaultApi* | [**pc_v4_jobdetails_encrypted_job_code_get**](docs/DefaultApi.md#pc_v4_jobdetails_encrypted_job_code_get) | **GET** /pc/v4/jobdetails/{encryptedJobCode} | Jobdetails (v4)
9497
*DefaultApi* | [**pc_v4_jobs_get**](docs/DefaultApi.md#pc_v4_jobs_get) | **GET** /pc/v4/jobs | Jobsuche
9598

9699

python-client/deutschland/jobsuche/__init__.py

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
# flake8: noqa
22

33
"""
4-
Arbeitsagentur Jobsuche API
4+
Arbeitsagentur Jobsuche API
55
6-
Die größte Stellendatenbank Deutschlands durchsuchen, Details zu Stellenanzeigen und Informationen über Arbeitgeber abrufen. <br><br>Die Authentifizierung funktioniert über die clientId:<br><br>clientId: jobboerse-jobsuche<br><br>Bei folgenden GET-requests ist die clientId als Header-Parameter 'X-API-Key' zu übergeben. # noqa: E501
6+
Die größte Stellendatenbank Deutschlands durchsuchen, Details zu Stellenanzeigen und Informationen über Arbeitgeber abrufen. <br><br>Die Authentifizierung funktioniert über die clientId:<br><br>clientId: jobboerse-jobsuche<br><br>Bei folgenden GET-requests ist die clientId als Header-Parameter 'X-API-Key' zu übergeben.<br><br>Ablauf: (1) Stellen suchen via /pc/v4/jobs oder /pc/v4/app/jobs → refnr merken. (2) Details abrufen via /pc/v4/jobdetails/{base64(refnr)}. (3) Arbeitgeberlogo abrufen via /ct/v1/arbeitgeberlogo/{arbeitgeberKundennummerHash} (sofern vorhanden). # noqa: E501
77
8-
The version of the OpenAPI document: 2.0.2
9-
Contact: kontakt@bund.dev
10-
Generated by: https://openapi-generator.tech
8+
The version of the OpenAPI document: 2.1.0
9+
Contact: kontakt@bund.dev
10+
Generated by: https://openapi-generator.tech
1111
"""
1212

13-
1413
__version__ = "0.1.0"
1514

1615
# import ApiClient

python-client/deutschland/jobsuche/api/default_api.py

Lines changed: 90 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
"""
2-
Arbeitsagentur Jobsuche API
2+
Arbeitsagentur Jobsuche API
33
4-
Die größte Stellendatenbank Deutschlands durchsuchen, Details zu Stellenanzeigen und Informationen über Arbeitgeber abrufen. <br><br>Die Authentifizierung funktioniert über die clientId:<br><br>clientId: jobboerse-jobsuche<br><br>Bei folgenden GET-requests ist die clientId als Header-Parameter 'X-API-Key' zu übergeben. # noqa: E501
4+
Die größte Stellendatenbank Deutschlands durchsuchen, Details zu Stellenanzeigen und Informationen über Arbeitgeber abrufen. <br><br>Die Authentifizierung funktioniert über die clientId:<br><br>clientId: jobboerse-jobsuche<br><br>Bei folgenden GET-requests ist die clientId als Header-Parameter 'X-API-Key' zu übergeben.<br><br>Ablauf: (1) Stellen suchen via /pc/v4/jobs oder /pc/v4/app/jobs → refnr merken. (2) Details abrufen via /pc/v4/jobdetails/{base64(refnr)}. (3) Arbeitgeberlogo abrufen via /ct/v1/arbeitgeberlogo/{arbeitgeberKundennummerHash} (sofern vorhanden). # noqa: E501
55
6-
The version of the OpenAPI document: 2.0.2
7-
Contact: kontakt@bund.dev
8-
Generated by: https://openapi-generator.tech
6+
The version of the OpenAPI document: 2.1.0
7+
Contact: kontakt@bund.dev
8+
Generated by: https://openapi-generator.tech
99
"""
1010

1111
import re # noqa: F401
@@ -47,8 +47,8 @@ def __init__(self, api_client=None):
4747
"servers": [
4848
{
4949
"url": "https://rest.arbeitsagentur.de/vermittlung/ag-darstellung-service",
50-
"description": "Arbeitgeberdarstellung service",
51-
}
50+
"description": "No description provided",
51+
},
5252
],
5353
},
5454
params_map={
@@ -82,46 +82,6 @@ def __init__(self, api_client=None):
8282
},
8383
api_client=api_client,
8484
)
85-
self.pc_v4_jobdetails_encrypted_job_code_get_endpoint = _Endpoint(
86-
settings={
87-
"response_type": (JobDetails,),
88-
"auth": ["APIKeyHeaders"],
89-
"endpoint_path": "/pc/v4/jobdetails/{encryptedJobCode}",
90-
"operation_id": "pc_v4_jobdetails_encrypted_job_code_get",
91-
"http_method": "GET",
92-
"servers": None,
93-
},
94-
params_map={
95-
"all": [
96-
"encrypted_job_code",
97-
],
98-
"required": [
99-
"encrypted_job_code",
100-
],
101-
"nullable": [],
102-
"enum": [],
103-
"validation": [],
104-
},
105-
root_map={
106-
"validations": {},
107-
"allowed_values": {},
108-
"openapi_types": {
109-
"encrypted_job_code": (str,),
110-
},
111-
"attribute_map": {
112-
"encrypted_job_code": "encryptedJobCode",
113-
},
114-
"location_map": {
115-
"encrypted_job_code": "path",
116-
},
117-
"collection_format_map": {},
118-
},
119-
headers_map={
120-
"accept": ["application/json"],
121-
"content_type": [],
122-
},
123-
api_client=api_client,
124-
)
12585
self.pc_v3_jobdetails_encrypted_job_code_get_endpoint = _Endpoint(
12686
settings={
12787
"response_type": (JobDetails,),
@@ -266,6 +226,46 @@ def __init__(self, api_client=None):
266226
},
267227
api_client=api_client,
268228
)
229+
self.pc_v4_jobdetails_encrypted_job_code_get_endpoint = _Endpoint(
230+
settings={
231+
"response_type": (JobDetails,),
232+
"auth": ["APIKeyHeaders"],
233+
"endpoint_path": "/pc/v4/jobdetails/{encryptedJobCode}",
234+
"operation_id": "pc_v4_jobdetails_encrypted_job_code_get",
235+
"http_method": "GET",
236+
"servers": None,
237+
},
238+
params_map={
239+
"all": [
240+
"encrypted_job_code",
241+
],
242+
"required": [
243+
"encrypted_job_code",
244+
],
245+
"nullable": [],
246+
"enum": [],
247+
"validation": [],
248+
},
249+
root_map={
250+
"validations": {},
251+
"allowed_values": {},
252+
"openapi_types": {
253+
"encrypted_job_code": (str,),
254+
},
255+
"attribute_map": {
256+
"encrypted_job_code": "encryptedJobCode",
257+
},
258+
"location_map": {
259+
"encrypted_job_code": "path",
260+
},
261+
"collection_format_map": {},
262+
},
263+
headers_map={
264+
"accept": ["application/json"],
265+
"content_type": [],
266+
},
267+
api_client=api_client,
268+
)
269269
self.pc_v4_jobs_get_endpoint = _Endpoint(
270270
settings={
271271
"response_type": (JobSearchResponse,),
@@ -382,7 +382,7 @@ def ct_v1_arbeitgeberlogo_kundennummer_hash_get(self, kundennummer_hash, **kwarg
382382
>>> result = thread.get()
383383
384384
Args:
385-
kundennummer_hash (str): Wert des Feldes arbeitgeberKundennummerHash aus der Jobdetail-Antwort.
385+
kundennummer_hash (str): Wert des Feldes arbeitgeberKundennummerHash aus der Jobdetail-Antwort (URL-kodiert falls nötig).
386386
387387
Keyword Args:
388388
_return_http_data_only (bool): response data without head status
@@ -436,18 +436,18 @@ def ct_v1_arbeitgeberlogo_kundennummer_hash_get(self, kundennummer_hash, **kwarg
436436
**kwargs
437437
)
438438

439-
def pc_v4_jobdetails_encrypted_job_code_get(self, encrypted_job_code, **kwargs):
440-
"""Jobdetails (v4) # noqa: E501
439+
def pc_v3_jobdetails_encrypted_job_code_get(self, encrypted_job_code, **kwargs):
440+
"""Jobdetails (v3) # noqa: E501
441441
442-
Abrufen der Details einer Stellenanzeige anhand des Base64-kodierten Referenzwertes (base64(refnr)). Empfohlene Version. # noqa: E501
442+
Abrufen der Details einer Stellenanzeige anhand des Base64-kodierten Referenzwertes (base64(refnr)). # noqa: E501
443443
This method makes a synchronous HTTP request by default. To make an
444444
asynchronous HTTP request, please pass async_req=True
445445
446-
>>> thread = api.pc_v4_jobdetails_encrypted_job_code_get(encrypted_job_code, async_req=True)
446+
>>> thread = api.pc_v3_jobdetails_encrypted_job_code_get(encrypted_job_code, async_req=True)
447447
>>> result = thread.get()
448448
449449
Args:
450-
encrypted_job_code (str): Base64-kodierter Wert der refnr. Beispiel: base64('10001-1002716922-S') = 'MTAwMDEtMTAwMjcxNjkyMi1T'
450+
encrypted_job_code (str): Base64-kodierter Wert der refnr aus der Jobsuche. Beispiel: base64('10001-1002716922-S') = 'MTAwMDEtMTAwMjcxNjkyMi1T'
451451
452452
Keyword Args:
453453
_return_http_data_only (bool): response data without head status
@@ -497,24 +497,38 @@ def pc_v4_jobdetails_encrypted_job_code_get(self, encrypted_job_code, **kwargs):
497497
kwargs["_host_index"] = kwargs.get("_host_index")
498498
kwargs["_request_auths"] = kwargs.get("_request_auths", None)
499499
kwargs["encrypted_job_code"] = encrypted_job_code
500-
return self.pc_v4_jobdetails_encrypted_job_code_get_endpoint.call_with_http_info(
501-
**kwargs
500+
return (
501+
self.pc_v3_jobdetails_encrypted_job_code_get_endpoint.call_with_http_info(
502+
**kwargs
503+
)
502504
)
503505

504-
def pc_v3_jobdetails_encrypted_job_code_get(self, encrypted_job_code, **kwargs):
505-
"""Jobdetails (v3) # noqa: E501
506+
def pc_v4_app_jobs_get(self, **kwargs):
507+
"""Jobsuche via App # noqa: E501
506508
507-
Abrufen der Details einer Stellenanzeige anhand des Base64-kodierten Referenzwertes (base64(refnr)). # noqa: E501
509+
Die Jobsuche via App ermöglicht verfügbare Jobangebote mit verschiedenen get Parametern zu filtern. # noqa: E501
508510
This method makes a synchronous HTTP request by default. To make an
509511
asynchronous HTTP request, please pass async_req=True
510512
511-
>>> thread = api.pc_v3_jobdetails_encrypted_job_code_get(encrypted_job_code, async_req=True)
513+
>>> thread = api.pc_v4_app_jobs_get(async_req=True)
512514
>>> result = thread.get()
513515
514-
Args:
515-
encrypted_job_code (str): Base64-kodierter Wert der refnr. Beispiel: base64('10001-1002716922-S') = 'MTAwMDEtMTAwMjcxNjkyMi1T'
516516
517517
Keyword Args:
518+
was (str): Freitext suche Jobtitel. [optional]
519+
wo (str): Freitext suche Beschäftigungsort. [optional]
520+
berufsfeld (str): Freitext suche Berufsfeld. [optional]
521+
page (int): Ergebnissseite. [optional]
522+
size (int): Anzahl von Ergebnissen. [optional]
523+
arbeitgeber (str): Arbeitgeber der Stelle. [optional]
524+
veroeffentlichtseit (int): Anzahl der Tage, seit der Job veröffentlicht wurde. Kann zwischen 0 und 100 Tagen liegen.. [optional]
525+
zeitarbeit (bool): Gibt an, ob Jobs von Zeitarbeitsfirmen in die Suchergebnisse einbezogen werden sollen (default true).. [optional]
526+
angebotsart (int): 1=ARBEIT; 2=SELBSTAENDIGKEIT, 4=AUSBILDUNG/Duales Studium, 34=Praktikum/Trainee. [optional]
527+
befristung (int): Semikolon-separierte mehrere Werte möglich (z.B. befristung=1;2) 1 = befristet; 2 = unbefristet. [optional]
528+
arbeitszeit (str): Semikolon-separierte mehrere Werte möglich (z.B. arbeitszeit=vz;tz) vz=VOLLZEIT, tz=TEILZEIT, snw=SCHICHT_NACHTARBEIT_WOCHENENDE, ho=HEIM_TELEARBEIT, mj=MINIJOB. [optional]
529+
behinderung (bool): [optional]
530+
corona (bool): Wenn true, werden nur Jobs die im Kontext von Corona angeboten werden angezeigt.. [optional]
531+
umkreis (int): Umkreis in Kilometern von Wo-Parameter. (z.B. 25 oder 200). [optional]
518532
_return_http_data_only (bool): response data without head status
519533
code and headers. Default is True.
520534
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -547,7 +561,7 @@ def pc_v3_jobdetails_encrypted_job_code_get(self, encrypted_job_code, **kwargs):
547561
async_req (bool): execute request asynchronously
548562
549563
Returns:
550-
JobDetails
564+
JobSearchResponse
551565
If the method is called asynchronously, returns the request
552566
thread.
553567
"""
@@ -561,37 +575,22 @@ def pc_v3_jobdetails_encrypted_job_code_get(self, encrypted_job_code, **kwargs):
561575
kwargs["_content_type"] = kwargs.get("_content_type")
562576
kwargs["_host_index"] = kwargs.get("_host_index")
563577
kwargs["_request_auths"] = kwargs.get("_request_auths", None)
564-
kwargs["encrypted_job_code"] = encrypted_job_code
565-
return self.pc_v3_jobdetails_encrypted_job_code_get_endpoint.call_with_http_info(
566-
**kwargs
567-
)
578+
return self.pc_v4_app_jobs_get_endpoint.call_with_http_info(**kwargs)
568579

569-
def pc_v4_app_jobs_get(self, **kwargs):
570-
"""Jobsuche via App # noqa: E501
580+
def pc_v4_jobdetails_encrypted_job_code_get(self, encrypted_job_code, **kwargs):
581+
"""Jobdetails (v4) # noqa: E501
571582
572-
Die Jobsuche via App ermöglicht verfügbare Jobangebote mit verschiedenen get Parametern zu filtern. # noqa: E501
583+
Abrufen der Details einer Stellenanzeige anhand des Base64-kodierten Referenzwertes (base64(refnr)). Empfohlene Version. # noqa: E501
573584
This method makes a synchronous HTTP request by default. To make an
574585
asynchronous HTTP request, please pass async_req=True
575586
576-
>>> thread = api.pc_v4_app_jobs_get(async_req=True)
587+
>>> thread = api.pc_v4_jobdetails_encrypted_job_code_get(encrypted_job_code, async_req=True)
577588
>>> result = thread.get()
578589
590+
Args:
591+
encrypted_job_code (str): Base64-kodierter Wert der refnr aus der Jobsuche. Beispiel: base64('10001-1002716922-S') = 'MTAwMDEtMTAwMjcxNjkyMi1T'
579592
580593
Keyword Args:
581-
was (str): Freitext suche Jobtitel. [optional]
582-
wo (str): Freitext suche Beschäftigungsort. [optional]
583-
berufsfeld (str): Freitext suche Berufsfeld. [optional]
584-
page (int): Ergebnissseite. [optional]
585-
size (int): Anzahl von Ergebnissen. [optional]
586-
arbeitgeber (str): Arbeitgeber der Stelle. [optional]
587-
veroeffentlichtseit (int): Anzahl der Tage, seit der Job veröffentlicht wurde. Kann zwischen 0 und 100 Tagen liegen.. [optional]
588-
zeitarbeit (bool): Gibt an, ob Jobs von Zeitarbeitsfirmen in die Suchergebnisse einbezogen werden sollen (default true).. [optional]
589-
angebotsart (int): 1=ARBEIT; 2=SELBSTAENDIGKEIT, 4=AUSBILDUNG/Duales Studium, 34=Praktikum/Trainee. [optional]
590-
befristung (int): Semikolon-separierte mehrere Werte möglich (z.B. befristung=1;2) 1 = befristet; 2 = unbefristet. [optional]
591-
arbeitszeit (str): Semikolon-separierte mehrere Werte möglich (z.B. arbeitszeit=vz;tz) vz=VOLLZEIT, tz=TEILZEIT, snw=SCHICHT_NACHTARBEIT_WOCHENENDE, ho=HEIM_TELEARBEIT, mj=MINIJOB. [optional]
592-
behinderung (bool): [optional]
593-
corona (bool): Wenn true, werden nur Jobs die im Kontext von Corona angeboten werden angezeigt.. [optional]
594-
umkreis (int): Umkreis in Kilometern von Wo-Parameter. (z.B. 25 oder 200). [optional]
595594
_return_http_data_only (bool): response data without head status
596595
code and headers. Default is True.
597596
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -624,7 +623,7 @@ def pc_v4_app_jobs_get(self, **kwargs):
624623
async_req (bool): execute request asynchronously
625624
626625
Returns:
627-
JobSearchResponse
626+
JobDetails
628627
If the method is called asynchronously, returns the request
629628
thread.
630629
"""
@@ -638,7 +637,12 @@ def pc_v4_app_jobs_get(self, **kwargs):
638637
kwargs["_content_type"] = kwargs.get("_content_type")
639638
kwargs["_host_index"] = kwargs.get("_host_index")
640639
kwargs["_request_auths"] = kwargs.get("_request_auths", None)
641-
return self.pc_v4_app_jobs_get_endpoint.call_with_http_info(**kwargs)
640+
kwargs["encrypted_job_code"] = encrypted_job_code
641+
return (
642+
self.pc_v4_jobdetails_encrypted_job_code_get_endpoint.call_with_http_info(
643+
**kwargs
644+
)
645+
)
642646

643647
def pc_v4_jobs_get(self, **kwargs):
644648
"""Jobsuche # noqa: E501

0 commit comments

Comments
 (0)