diff --git a/README.md b/README.md index 4d6e151..537de04 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Evoke Api Javascript Client +# digitale-kultur/evoke-api-client -EvokeApiJavascriptClient - JavaScript client for Evoke Api Javascript Client +DigitaleKulturEvokeApiClient - JavaScript client for digitale-kultur/evoke-api-client This API provides endpoints used by the Evoke demoparty website.

Imprint
Privacy Information This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: @@ -19,7 +19,7 @@ To publish the library as a [npm](https://www.npmjs.com/), please follow the pro Then install it via: ```shell -npm install Evoke Api Javascript Client --save +npm install digitale-kultur/evoke-api-client --save ``` #### git @@ -66,11 +66,11 @@ module: { Please follow the [installation](#installation) instruction and execute the following JS code: ```javascript -var EvokeApiJavascriptClient = require('Evoke Api Javascript Client'); +var DigitaleKulturEvokeApiClient = require('digitale-kultur/evoke-api-client'); -var api = new EvokeApiJavascriptClient.ContactApi() -var contactMessage = new EvokeApiJavascriptClient.ContactMessage(); // {ContactMessage} Information about the message to be sent +var api = new DigitaleKulturEvokeApiClient.ContactApi() +var contactMessage = new DigitaleKulturEvokeApiClient.ContactMessage(); // {ContactMessage} Information about the message to be sent var callback = function(error, data, response) { if (error) { console.error(error); @@ -88,21 +88,21 @@ All URIs are relative to *http://localhost/api* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- -*EvokeApiJavascriptClient.ContactApi* | [**createMessage**](docs/ContactApi.md#createMessage) | **POST** /contact | Send a new message -*EvokeApiJavascriptClient.ContactApi* | [**showAllCategories**](docs/ContactApi.md#showAllCategories) | **GET** /contact/categories | Get a list of all contact categories -*EvokeApiJavascriptClient.RegistrationApi* | [**createRegistration**](docs/RegistrationApi.md#createRegistration) | **POST** /registration/{year} | Create a new registration -*EvokeApiJavascriptClient.RegistrationApi* | [**deleteRegistration**](docs/RegistrationApi.md#deleteRegistration) | **DELETE** /registration/{year}/{id} | Delete a single registration -*EvokeApiJavascriptClient.RegistrationApi* | [**numberOfRegistrations**](docs/RegistrationApi.md#numberOfRegistrations) | **GET** /registration/{year}/count | Get the number of registrations -*EvokeApiJavascriptClient.RegistrationApi* | [**showAllCountries**](docs/RegistrationApi.md#showAllCountries) | **GET** /registration/countries | Get a list of countries -*EvokeApiJavascriptClient.RegistrationApi* | [**showAllRegistrations**](docs/RegistrationApi.md#showAllRegistrations) | **GET** /registration/{year} | Get a list of all registrations +*DigitaleKulturEvokeApiClient.ContactApi* | [**createMessage**](docs/ContactApi.md#createMessage) | **POST** /contact | Send a new message +*DigitaleKulturEvokeApiClient.ContactApi* | [**showAllCategories**](docs/ContactApi.md#showAllCategories) | **GET** /contact/categories | Get a list of all contact categories +*DigitaleKulturEvokeApiClient.RegistrationApi* | [**createRegistration**](docs/RegistrationApi.md#createRegistration) | **POST** /registration/{year} | Create a new registration +*DigitaleKulturEvokeApiClient.RegistrationApi* | [**deleteRegistration**](docs/RegistrationApi.md#deleteRegistration) | **DELETE** /registration/{year}/{id} | Delete a single registration +*DigitaleKulturEvokeApiClient.RegistrationApi* | [**numberOfRegistrations**](docs/RegistrationApi.md#numberOfRegistrations) | **GET** /registration/{year}/count | Get the number of registrations +*DigitaleKulturEvokeApiClient.RegistrationApi* | [**showAllCountries**](docs/RegistrationApi.md#showAllCountries) | **GET** /registration/countries | Get a list of countries +*DigitaleKulturEvokeApiClient.RegistrationApi* | [**showAllRegistrations**](docs/RegistrationApi.md#showAllRegistrations) | **GET** /registration/{year} | Get a list of all registrations ## Documentation for Models - - [EvokeApiJavascriptClient.ContactCategory](docs/ContactCategory.md) - - [EvokeApiJavascriptClient.ContactMessage](docs/ContactMessage.md) - - [EvokeApiJavascriptClient.Registration](docs/Registration.md) - - [EvokeApiJavascriptClient.Rfc7807](docs/Rfc7807.md) + - [DigitaleKulturEvokeApiClient.ContactCategory](docs/ContactCategory.md) + - [DigitaleKulturEvokeApiClient.ContactMessage](docs/ContactMessage.md) + - [DigitaleKulturEvokeApiClient.Registration](docs/Registration.md) + - [DigitaleKulturEvokeApiClient.Rfc7807](docs/Rfc7807.md) ## Documentation for Authorization diff --git a/docs/ContactApi.md b/docs/ContactApi.md index a0d7da2..9f7360f 100644 --- a/docs/ContactApi.md +++ b/docs/ContactApi.md @@ -1,4 +1,4 @@ -# EvokeApiJavascriptClient.ContactApi +# DigitaleKulturEvokeApiClient.ContactApi All URIs are relative to *http://localhost/api* @@ -18,10 +18,10 @@ Send a new message ### Example ```javascript -import EvokeApiJavascriptClient from 'Evoke Api Javascript Client'; +import DigitaleKulturEvokeApiClient from 'digitale-kultur/evoke-api-client'; -let apiInstance = new EvokeApiJavascriptClient.ContactApi(); -let contactMessage = new EvokeApiJavascriptClient.ContactMessage(); // ContactMessage | Information about the message to be sent +let apiInstance = new DigitaleKulturEvokeApiClient.ContactApi(); +let contactMessage = new DigitaleKulturEvokeApiClient.ContactMessage(); // ContactMessage | Information about the message to be sent apiInstance.createMessage(contactMessage, (error, data, response) => { if (error) { console.error(error); @@ -61,9 +61,9 @@ Get a list of all contact categories ### Example ```javascript -import EvokeApiJavascriptClient from 'Evoke Api Javascript Client'; +import DigitaleKulturEvokeApiClient from 'digitale-kultur/evoke-api-client'; -let apiInstance = new EvokeApiJavascriptClient.ContactApi(); +let apiInstance = new DigitaleKulturEvokeApiClient.ContactApi(); apiInstance.showAllCategories((error, data, response) => { if (error) { console.error(error); diff --git a/docs/ContactCategory.md b/docs/ContactCategory.md index 963f02b..e0b11a2 100644 --- a/docs/ContactCategory.md +++ b/docs/ContactCategory.md @@ -1,4 +1,4 @@ -# EvokeApiJavascriptClient.ContactCategory +# DigitaleKulturEvokeApiClient.ContactCategory ## Properties diff --git a/docs/ContactMessage.md b/docs/ContactMessage.md index 53f7972..0ea48a1 100644 --- a/docs/ContactMessage.md +++ b/docs/ContactMessage.md @@ -1,4 +1,4 @@ -# EvokeApiJavascriptClient.ContactMessage +# DigitaleKulturEvokeApiClient.ContactMessage ## Properties diff --git a/docs/Registration.md b/docs/Registration.md index 47b2e07..22aa9fe 100644 --- a/docs/Registration.md +++ b/docs/Registration.md @@ -1,4 +1,4 @@ -# EvokeApiJavascriptClient.Registration +# DigitaleKulturEvokeApiClient.Registration ## Properties diff --git a/docs/RegistrationApi.md b/docs/RegistrationApi.md index 135938c..570cbac 100644 --- a/docs/RegistrationApi.md +++ b/docs/RegistrationApi.md @@ -1,4 +1,4 @@ -# EvokeApiJavascriptClient.RegistrationApi +# DigitaleKulturEvokeApiClient.RegistrationApi All URIs are relative to *http://localhost/api* @@ -21,11 +21,11 @@ Create a new registration ### Example ```javascript -import EvokeApiJavascriptClient from 'Evoke Api Javascript Client'; +import DigitaleKulturEvokeApiClient from 'digitale-kultur/evoke-api-client'; -let apiInstance = new EvokeApiJavascriptClient.RegistrationApi(); +let apiInstance = new DigitaleKulturEvokeApiClient.RegistrationApi(); let year = 2019; // Number | Year to query for -let registration = new EvokeApiJavascriptClient.Registration(); // Registration | Information about the user to be added +let registration = new DigitaleKulturEvokeApiClient.Registration(); // Registration | Information about the user to be added apiInstance.createRegistration(year, registration, (error, data, response) => { if (error) { console.error(error); @@ -66,9 +66,9 @@ Delete a single registration ### Example ```javascript -import EvokeApiJavascriptClient from 'Evoke Api Javascript Client'; +import DigitaleKulturEvokeApiClient from 'digitale-kultur/evoke-api-client'; -let apiInstance = new EvokeApiJavascriptClient.RegistrationApi(); +let apiInstance = new DigitaleKulturEvokeApiClient.RegistrationApi(); let year = 2019; // Number | Year to query for let id = 1; // Number | ID to delete let key = czC3BzTbyxHCNm1; // String | Hash to authenticate the deletion of this ID @@ -113,9 +113,9 @@ Get the number of registrations ### Example ```javascript -import EvokeApiJavascriptClient from 'Evoke Api Javascript Client'; +import DigitaleKulturEvokeApiClient from 'digitale-kultur/evoke-api-client'; -let apiInstance = new EvokeApiJavascriptClient.RegistrationApi(); +let apiInstance = new DigitaleKulturEvokeApiClient.RegistrationApi(); let year = 2019; // Number | Year to query for apiInstance.numberOfRegistrations(year, (error, data, response) => { if (error) { @@ -156,9 +156,9 @@ Get a list of countries ### Example ```javascript -import EvokeApiJavascriptClient from 'Evoke Api Javascript Client'; +import DigitaleKulturEvokeApiClient from 'digitale-kultur/evoke-api-client'; -let apiInstance = new EvokeApiJavascriptClient.RegistrationApi(); +let apiInstance = new DigitaleKulturEvokeApiClient.RegistrationApi(); apiInstance.showAllCountries((error, data, response) => { if (error) { console.error(error); @@ -195,9 +195,9 @@ Get a list of all registrations ### Example ```javascript -import EvokeApiJavascriptClient from 'Evoke Api Javascript Client'; +import DigitaleKulturEvokeApiClient from 'digitale-kultur/evoke-api-client'; -let apiInstance = new EvokeApiJavascriptClient.RegistrationApi(); +let apiInstance = new DigitaleKulturEvokeApiClient.RegistrationApi(); let year = 2019; // Number | Year to query for apiInstance.showAllRegistrations(year, (error, data, response) => { if (error) { diff --git a/docs/Rfc7807.md b/docs/Rfc7807.md index 311e0e0..c6928d5 100644 --- a/docs/Rfc7807.md +++ b/docs/Rfc7807.md @@ -1,4 +1,4 @@ -# EvokeApiJavascriptClient.Rfc7807 +# DigitaleKulturEvokeApiClient.Rfc7807 ## Properties diff --git a/git_push.sh b/git_push.sh index 12d03a9..d684c74 100755 --- a/git_push.sh +++ b/git_push.sh @@ -1,4 +1,4 @@ -c#!/bin/sh +#!/bin/sh # ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ # # Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update" diff --git a/package.json b/package.json index 3895fc0..d94565c 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "Evoke Api Javascript Client", + "name": "digitale-kultur/evoke-api-client", "version": "0.1.0", "description": "This_API_provides_endpoints_used_by_the_Evoke_demoparty_website_brbra_hrefhttps__www_evoke_eu_imprint_Imprint_abra_hrefhttps__www_evoke_eu_privacy_Privacy_Information_a", "license": "Unlicense", diff --git a/src/index.js b/src/index.js index 049f545..2e95b20 100644 --- a/src/index.js +++ b/src/index.js @@ -27,9 +27,9 @@ import RegistrationApi from './api/RegistrationApi'; *

* An AMD (recommended!) or CommonJS application will generally do something equivalent to the following: *

-* var EvokeApiJavascriptClient = require('index'); // See note below*.
-* var xxxSvc = new EvokeApiJavascriptClient.XxxApi(); // Allocate the API class we're going to use.
-* var yyyModel = new EvokeApiJavascriptClient.Yyy(); // Construct a model instance.
+* var DigitaleKulturEvokeApiClient = require('index'); // See note below*.
+* var xxxSvc = new DigitaleKulturEvokeApiClient.XxxApi(); // Allocate the API class we're going to use.
+* var yyyModel = new DigitaleKulturEvokeApiClient.Yyy(); // Construct a model instance.
 * yyyModel.someProperty = 'someValue';
 * ...
 * var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.
@@ -41,8 +41,8 @@ import RegistrationApi from './api/RegistrationApi';
 * 

* A non-AMD browser application (discouraged) might do something like this: *

-* var xxxSvc = new EvokeApiJavascriptClient.XxxApi(); // Allocate the API class we're going to use.
-* var yyy = new EvokeApiJavascriptClient.Yyy(); // Construct a model instance.
+* var xxxSvc = new DigitaleKulturEvokeApiClient.XxxApi(); // Allocate the API class we're going to use.
+* var yyy = new DigitaleKulturEvokeApiClient.Yyy(); // Construct a model instance.
 * yyyModel.someProperty = 'someValue';
 * ...
 * var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.