@verdigado/[email protected]

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @verdigado/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to https://api.gruene.de

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- BookmarksApi | createBookmark | POST /v1/bookmarks | Create bookmark BookmarksApi | deleteBookmark | DELETE /v1/bookmarks/{bookmarkId} | Delete bookmark BookmarksApi | findBookmarks | GET /v1/bookmarks | List bookmarks for the authenticated user CampaignsApi | addPoiPhoto | POST /v1/campaigns/pois/{poiId}/photos | Add POI photo CampaignsApi | createArea | POST /v1/campaigns/areas | Create a new Area CampaignsApi | createCampaign | POST /v1/campaigns/campaigns | Create a new campaign CampaignsApi | createExperienceArea | POST /v1/campaigns/experience-areas | Create a new ExperienceArea CampaignsApi | createFocusArea | POST /v1/campaigns/focus-areas | Create a new FocusArea CampaignsApi | createPoi | POST /v1/campaigns/pois | Create a new POI CampaignsApi | createPollingStation | POST /v1/campaigns/polling-stations | Create a new PollingStation CampaignsApi | createRoute | POST /v1/campaigns/routes | Create a new Route CampaignsApi | deleteArea | DELETE /v1/campaigns/areas/{areaId} | Delete an Area CampaignsApi | deleteExperienceArea | DELETE /v1/campaigns/experience-areas/{experienceAreaId} | Delete a ExperienceArea CampaignsApi | deleteFocusArea | DELETE /v1/campaigns/focus-areas/{focusAreaId} | Delete a FocusArea CampaignsApi | deletePoi | DELETE /v1/campaigns/pois/{poiId} | Delete a POI CampaignsApi | deletePoiPhoto | DELETE /v1/campaigns/pois/{poiId}/photos/{photoId} | Delete a POI Photo CampaignsApi | deletePollingStation | DELETE /v1/campaigns/polling-stations/{pollingStationId} | Delete a PollingStation CampaignsApi | deleteRoute | DELETE /v1/campaigns/routes/{routeId} | Delete a Route CampaignsApi | findAreas | GET /v1/campaigns/areas | Find Areas CampaignsApi | findCampaigns | GET /v1/campaigns/campaigns | Find campaigns CampaignsApi | findExperienceAreas | GET /v1/campaigns/experience-areas | Find ExperienceAreas CampaignsApi | findFocusAreas | GET /v1/campaigns/focus-areas | Find FocusAreas CampaignsApi | findOwnAreas | GET /v1/campaigns/areas/self | Find own Areas CampaignsApi | findOwnPois | GET /v1/campaigns/pois/self | Find own POIs CampaignsApi | findPois | GET /v1/campaigns/pois | Find POIs CampaignsApi | findPollingStations | GET /v1/campaigns/polling-stations | Find PollingStations CampaignsApi | findRoutes | GET /v1/campaigns/routes | Find Routes CampaignsApi | getArea | GET /v1/campaigns/areas/{areaId} | Get an Area CampaignsApi | getCampaignStatistics | GET /v1/campaigns/statistics | Get campaign statistics CampaignsApi | getExperienceArea | GET /v1/campaigns/experience-areas/{experienceAreaId} | Get a ExperienceArea CampaignsApi | getFocusArea | GET /v1/campaigns/focus-areas/{focusAreaId} | Get a FocusArea CampaignsApi | getPoi | GET /v1/campaigns/pois/{poiId} | Get a POI CampaignsApi | getPollingStation | GET /v1/campaigns/polling-stations/{pollingStationId} | Get a PollingStation CampaignsApi | getRoute | GET /v1/campaigns/routes/{routeId} | Get a Route CampaignsApi | updateArea | PUT /v1/campaigns/areas/{areaId} | Update an Area CampaignsApi | updateCampaign | PUT /v1/campaigns/campaigns/{campaignId} | Update a campaign CampaignsApi | updateExperienceArea | PUT /v1/campaigns/experience-areas/{experienceAreaId} | Update a ExperienceArea CampaignsApi | updateFocusArea | PUT /v1/campaigns/focus-areas/{focusAreaId} | Update a FocusArea CampaignsApi | updatePoi | PUT /v1/campaigns/pois/{poiId} | Update a POI CampaignsApi | updatePollingStation | PUT /v1/campaigns/polling-stations/{pollingStationId} | Update a PollingStation CampaignsApi | updateRoute | PUT /v1/campaigns/routes/{routeId} | Update a Route ClientInfoApi | clientInfoControllerGetClientInfoV1 | GET /v1/client-info | DivisionsApi | findDivisions | GET /v1/divisions | Find divisions DivisionsApi | getDivision | GET /v1/divisions/{divisionId} | Get division by id GnetzApplicationsApi | findGnetzApplications | GET /v1/gnetz-applications | Find GNetz Applications GreenDirectoryApi | createGreenDirectoryLocation | POST /v1/green-directory/locations | Create Green Directory Location GreenDirectoryApi | createGreenDirectoryRecord | POST /v1/green-directory/records | Create Green Directory Record GreenDirectoryApi | deleteGreenDirectoryLocation | DELETE /v1/green-directory/locations/{locationId} | Delete Green Directory Location GreenDirectoryApi | deleteGreenDirectoryRecord | DELETE /v1/green-directory/records/{recordId} | Delete Green Directory Record GreenDirectoryApi | findGreenDirectoryLocations | GET /v1/green-directory/locations | Find Green Directory Locations GreenDirectoryApi | findGreenDirectoryRecords | GET /v1/green-directory/records | Find Green Directory Records GreenDirectoryApi | getGreenDirectoryLocation | GET /v1/green-directory/locations/{locationId} | Get Green Directory Location GreenDirectoryApi | getGreenDirectoryRecord | GET /v1/green-directory/records/{recordId} | Get Green Directory Record GreenDirectoryApi | updateGreenDirectoryLocation | PUT /v1/green-directory/locations/{locationId} | Update Green Directory Location GreenDirectoryApi | updateGreenDirectoryRecord | PATCH /v1/green-directory/records/{recordId} | Update Green Directory Record HealthApi | healthGet | GET /health | NbApiApi | findGroups | GET /v1/party/groups | Find all groups NbApiApi | findOrganizations | GET /v1/party/organizations | Find all organizations NbApiApi | findRegionalChapters | GET /v1/party/regionalchapters | Find all regional chapters NbApiApi | getRegionalChapter | GET /v1/party/regionalchapters/{divisionKey} | Get regional chapter by division key NewsApi | findNews | GET /v1/news | Find news NewsApi | getNews | GET /v1/news/{newsId} | Get a news post OffboardingApi | batchUpdateOffboardingServiceUsers | POST /v1/offboarding/users/self/batch | Batch update offboarding users for the authenticated service. OffboardingApi | findUsersToOffboard | GET /v1/offboarding/users/self | Find users to offboard for the service associated with the used credentials ProfilesApi | createProfile | POST /v1/profiles | Create user profile ProfilesApi | deleteProfile | DELETE /v1/profiles/{profileId} | Delete user profile ProfilesApi | deleteProfileImage | DELETE /v1/profiles/{profileId}/image | Delete user profile image ProfilesApi | findProfileTags | GET /v1/profile-tags | List profile tags ProfilesApi | findProfiles | GET /v1/profiles | Find user profiles ProfilesApi | getOwnProfile | GET /v1/profiles/self | Get the authenticated user's profile ProfilesApi | getProfile | GET /v1/profiles/{profileId} | Get a user profile ProfilesApi | updateProfile | PUT /v1/profiles/{profileId} | Update user profile ProfilesApi | updateProfileImage | PUT /v1/profiles/{profileId}/image | Update profile image RolesApi | findRoleCategories | GET /v1/role-categories | Find role categories RolesApi | findRoleTags | GET /v1/role-tags | Find role tags RolesApi | findRoles | GET /v1/roles | Find roles RolesApi | getRole | GET /v1/roles/{roleId} | Get role by id UsersApi | findUsers | GET /v1/users | Find users UsersApi | getSelf | GET /v1/users/self | Get the authenticated user UsersApi | getUser | GET /v1/users/{userId} | Get user by id UsersApi | getUserRbacStructure | GET /v1/users/{userId}/rbac-structure | Get user RBAC structure

Documentation For Models

• Address
• Area
• AreaFlyerSpot
• AreaHouse
• BatchUpdateOffboardingServiceUsers
• Bookmark
• Campaign
• CampaignStatistics
• ClientInfo
• CreateArea
• CreateBookmark
• CreateCampaign
• CreateExperienceArea
• CreateFocusArea
• CreateGreenDirectoryLocation
• CreateGreenDirectoryRecord
• CreatePoi
• CreatePollingStation
• CreateProfile
• CreateRoute
• Division
• DivisionEmail
• DivisionMembership
• ExperienceArea
• FindAreasResponse
• FindBookmarksResponse
• FindCampaignsResponse
• FindDivisionsResponse
• FindExperienceAreasResponse
• FindFocusAreasResponse
• FindGnetzApplicationsResponse
• FindGreenDirectoryLocationsResponse
• FindGreenDirectoryRecordsResponse
• FindNbGroupsResponse
• FindNbOrganizationsResponse
• FindNbRegionalChaptersResponse
• FindNewsResponse
• FindOffboardingUsersResponse
• FindPoisResponse
• FindPollingStationsResponse
• FindProfileTagsResponse
• FindProfilesResponse
• FindRoleCategoriesResponse
• FindRoleTagsResponse
• FindRolesResponse
• FindRoutesResponse
• FindUsersResponse
• FocusArea
• GnetzApplication
• GnetzApplicationCategory
• GreenDirectoryEmail
• GreenDirectoryExternalRef
• GreenDirectoryLocation
• GreenDirectoryRecord
• GreenDirectoryRecordPerson
• GreenDirectoryUrl
• HealthCheckResponse
• HealthCheckResponseErrorValue
• HealthCheckResponseInfoValue
• Image
• ImageLink
• ImageSrcSet
• KeysetPaginationMeta
• LineString
• MessengerEntry
• NbExternalRef
• NbGroup
• NbGroupFilter
• NbOrganization
• NbRegionalChapter
• NbRegionalChapterFilter
• News
• NewsBody
• NewsCategory
• OffboardingUserInfo
• OffsetPaginationMeta
• PhoneNumberEntry
• Poi
• PoiAddress
• PoiFlyerSpot
• PoiHouse
• PoiPoster
• PoiStatistics
• PollingStation
• Polygon
• Profile
• ProfileImage
• ProfilePrivacySettings
• ProfileRole
• ProfileTag
• PublicProfile
• Role
• RoleAlias
• RoleCategory
• RoleTag
• Route
• SocialMediaEntry
• UpdateArea
• UpdateCampaign
• UpdateExperienceArea
• UpdateFocusArea
• UpdateGreenDirectoryLocation
• UpdateGreenDirectoryRecord
• UpdateMessengerEntry
• UpdatePhoneNumber
• UpdatePoi
• UpdatePollingStation
• UpdateProfile
• UpdateRoute
• UpdateSocialMediaEntry
• UpsertOffboardingServiceUser
• User
• UserRbacGroup
• UserRbacRole
• UserRbacStructure

Documentation For Authorization

Authentication schemes defined for the API:

basic

• Type: HTTP basic authentication

bearer

• Type: Bearer authentication (JWT)

api_key

• Type: API key
• API key parameter name: x-api-key
• Location: HTTP header