@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://sherpa.gruene.de/sherpa/ws/m2m

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AnyApi | anyFindDivisions | GET /any/v1/divisions | find divisions AnyApi | anyFindRoles | GET /any/v1/roles | find roles AnyApi | anyFindTags | GET /any/v1/tags | find tags AnyApi | anyGetAlive | GET /any/v1/alive | healthcheck GnetzApi | gnCreateProfile | POST /gnetz/v2/profiles | Create user profile GnetzApi | gnDeleteProfiles | POST /gnetz/v2/profiles/delete | Delete user profiles GnetzApi | gnFindInterests | GET /gnetz/v2/interests | find interest tags GnetzApi | gnFindSkills | GET /gnetz/v2/skills | find skill tags GnetzApi | gnFindTags | GET /gnetz/v2/tags | find tags GnetzApi | gnGetDivision | GET /gnetz/v2/divisions/{divisionKey} | get division GnetzApi | gnGetProfileFormValues | GET /gnetz/v2/profiles/{profileId}/form-values | Get profile form values GnetzApi | gnGetProfileIds | GET /gnetz/v2/profiles/ids | get user profile ids GnetzApi | gnGetProfiles | POST /gnetz/v2/profiles/list | Get user profiles GnetzApi | gnUpdateProfile | PUT /gnetz/v2/profiles/{profileId} | Update user profile MailinglistsApi | mlAddSubscription | PUT /mailinglists/v1/subscriptions | add subscription MailinglistsApi | mlAddUnsubscription | PUT /mailinglists/v1/unsubscriptions | add unsubscription MailinglistsApi | mlDeleteMailinglist | DELETE /mailinglists/v1/lists/{mailinglistId} | delete mailinglist MailinglistsApi | mlDeleteSubscriptions | DELETE /mailinglists/v1/subscriptions | delete subscriptions MailinglistsApi | mlDeleteUnsubscription | DELETE /mailinglists/v1/unsubscriptions | delete unsubscription MailinglistsApi | mlDeleteUser | DELETE /mailinglists/v1/users/{userId} | delete mailinglist user MailinglistsApi | mlFindBannedEmails | GET /mailinglists/v1/banned-emails | find banned emails MailinglistsApi | mlFindDivisions | GET /mailinglists/v1/divisions | find divisions MailinglistsApi | mlFindInternalSubscribers | GET /mailinglists/v1/internal-subscribers | find internal subscribers MailinglistsApi | mlFindMailinglists | GET /mailinglists/v1/lists | find mailinglists MailinglistsApi | mlFindSubscriptions | GET /mailinglists/v1/subscriptions | find subscriptions MailinglistsApi | mlFindUnsubscriptions | GET /mailinglists/v1/unsubscriptions | find unsubscriptions MailinglistsApi | mlFindUsers | GET /mailinglists/v1/users | find mailinglist users MailinglistsApi | mlGetDivision | GET /mailinglists/v1/divisions/{divisionId} | get division MailinglistsApi | mlGetMailinglist | GET /mailinglists/v1/lists/{mailinglistId} | get mailinglist MailinglistsApi | mlGetUser | GET /mailinglists/v1/users/{userId} | get mailinglist user MailinglistsApi | mlGetUserBySherpaId | GET /mailinglists/v1/users/sherpa-id/{sherpaId} | get mailinglist user by sherpa id MailinglistsApi | mlUpsertMailinglist | PUT /mailinglists/v1/lists | create or update mailinglist MailinglistsApi | mlUpsertUser | PUT /mailinglists/v1/users | create or update mailinglist user SamlApi | samlFindNewUsersByDate | POST /saml/party/newusers | Find new users by date SamlApi | samlFindUsers | GET /saml/v1/users | Find users SamlApi | samlGetUsersById | POST /saml/party/list | Get users by ids

Documentation For Models

• AnyDivision
• AnyDivisionEmailPurposeValue
• AnyRole
• AnyRoleAlias
• AnyRoleCategory
• AnyRoleTag
• AnyTag
• GnCreateProfileDto
• GnDeletedProfileDto
• GnDivisionMembership
• GnError
• GnGetProfilesRequest
• GnImageLink
• GnMessenger
• GnMessengerType
• GnPhoneNumber
• GnPrivacySettings
• GnProfile
• GnProfileFormValues
• GnProfileImage
• GnRole
• GnRoleType
• GnSocialMedia
• GnSocialMediaType
• GnTag
• GnTagType
• GnUpdateMessengerDto
• GnUpdatePhoneNumberDto
• GnUpdateProfileDto
• GnUpdateSocialMediaDto
• GnValidationError
• GnValidationErrorConstraintsInner
• GnVisibility
• HierarchyType
• MlAddSubscriptionDto
• MlDivision
• MlErrorDto
• MlMailinglist
• MlSherpaDistributor
• MlSherpaDistributorItem
• MlSubscription
• MlUnsubscription
• MlUpsertMailinglistDto
• MlUpsertUserDto
• MlUser
• MlUserItem
• SamlError
• SamlFindNewUsersByDateRequest
• SamlFindUsersResponse
• SamlFindUsersResponseMeta
• SamlGetUsersByIdRequest
• SamlNewUser
• SamlUser
• SamlUserMembership
• SamlUserRole
• SamlUserRoleTag
• ServerAliveDto

Documentation For Authorization

Endpoints do not require authorization.