Skip to content

Commit

Permalink
Minor update
Browse files Browse the repository at this point in the history
  • Loading branch information
potibm committed Apr 14, 2019
1 parent 14c1f90 commit d8bd1c8
Show file tree
Hide file tree
Showing 9 changed files with 45 additions and 45 deletions.
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# digitale-kultur/evoke-api-client
# digitale-kultur/evoke-api-client-js

DigitaleKulturEvokeApiClient - JavaScript client for digitale-kultur/evoke-api-client
DigitaleKulturEvokeApiClientJs - JavaScript client for digitale-kultur/evoke-api-client-js
This API provides endpoints used by the Evoke demoparty website. <br><br><a href='https://www.evoke.eu/imprint/'>Imprint</a><br><a href='https://www.evoke.eu/privacy/'>Privacy Information</a>
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

Expand All @@ -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 digitale-kultur/evoke-api-client --save
npm install digitale-kultur/evoke-api-client-js --save
```

#### git
Expand Down Expand Up @@ -66,11 +66,11 @@ module: {
Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
var DigitaleKulturEvokeApiClient = require('digitale-kultur/evoke-api-client');
var DigitaleKulturEvokeApiClientJs = require('digitale-kultur/evoke-api-client-js');


var api = new DigitaleKulturEvokeApiClient.ContactApi()
var contactMessage = new DigitaleKulturEvokeApiClient.ContactMessage(); // {ContactMessage} Information about the message to be sent
var api = new DigitaleKulturEvokeApiClientJs.ContactApi()
var contactMessage = new DigitaleKulturEvokeApiClientJs.ContactMessage(); // {ContactMessage} Information about the message to be sent
var callback = function(error, data, response) {
if (error) {
console.error(error);
Expand All @@ -88,21 +88,21 @@ All URIs are relative to *http://localhost/api*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*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
*DigitaleKulturEvokeApiClientJs.ContactApi* | [**createMessage**](docs/ContactApi.md#createMessage) | **POST** /contact | Send a new message
*DigitaleKulturEvokeApiClientJs.ContactApi* | [**showAllCategories**](docs/ContactApi.md#showAllCategories) | **GET** /contact/categories | Get a list of all contact categories
*DigitaleKulturEvokeApiClientJs.RegistrationApi* | [**createRegistration**](docs/RegistrationApi.md#createRegistration) | **POST** /registration/{year} | Create a new registration
*DigitaleKulturEvokeApiClientJs.RegistrationApi* | [**deleteRegistration**](docs/RegistrationApi.md#deleteRegistration) | **DELETE** /registration/{year}/{id} | Delete a single registration
*DigitaleKulturEvokeApiClientJs.RegistrationApi* | [**numberOfRegistrations**](docs/RegistrationApi.md#numberOfRegistrations) | **GET** /registration/{year}/count | Get the number of registrations
*DigitaleKulturEvokeApiClientJs.RegistrationApi* | [**showAllCountries**](docs/RegistrationApi.md#showAllCountries) | **GET** /registration/countries | Get a list of countries
*DigitaleKulturEvokeApiClientJs.RegistrationApi* | [**showAllRegistrations**](docs/RegistrationApi.md#showAllRegistrations) | **GET** /registration/{year} | Get a list of all registrations


## Documentation for Models

- [DigitaleKulturEvokeApiClient.ContactCategory](docs/ContactCategory.md)
- [DigitaleKulturEvokeApiClient.ContactMessage](docs/ContactMessage.md)
- [DigitaleKulturEvokeApiClient.Registration](docs/Registration.md)
- [DigitaleKulturEvokeApiClient.Rfc7807](docs/Rfc7807.md)
- [DigitaleKulturEvokeApiClientJs.ContactCategory](docs/ContactCategory.md)
- [DigitaleKulturEvokeApiClientJs.ContactMessage](docs/ContactMessage.md)
- [DigitaleKulturEvokeApiClientJs.Registration](docs/Registration.md)
- [DigitaleKulturEvokeApiClientJs.Rfc7807](docs/Rfc7807.md)


## Documentation for Authorization
Expand Down
12 changes: 6 additions & 6 deletions docs/ContactApi.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# DigitaleKulturEvokeApiClient.ContactApi
# DigitaleKulturEvokeApiClientJs.ContactApi

All URIs are relative to *http://localhost/api*

Expand All @@ -18,10 +18,10 @@ Send a new message
### Example

```javascript
import DigitaleKulturEvokeApiClient from 'digitale-kultur/evoke-api-client';
import DigitaleKulturEvokeApiClientJs from 'digitale-kultur/evoke-api-client-js';

let apiInstance = new DigitaleKulturEvokeApiClient.ContactApi();
let contactMessage = new DigitaleKulturEvokeApiClient.ContactMessage(); // ContactMessage | Information about the message to be sent
let apiInstance = new DigitaleKulturEvokeApiClientJs.ContactApi();
let contactMessage = new DigitaleKulturEvokeApiClientJs.ContactMessage(); // ContactMessage | Information about the message to be sent
apiInstance.createMessage(contactMessage, (error, data, response) => {
if (error) {
console.error(error);
Expand Down Expand Up @@ -61,9 +61,9 @@ Get a list of all contact categories
### Example

```javascript
import DigitaleKulturEvokeApiClient from 'digitale-kultur/evoke-api-client';
import DigitaleKulturEvokeApiClientJs from 'digitale-kultur/evoke-api-client-js';

let apiInstance = new DigitaleKulturEvokeApiClient.ContactApi();
let apiInstance = new DigitaleKulturEvokeApiClientJs.ContactApi();
apiInstance.showAllCategories((error, data, response) => {
if (error) {
console.error(error);
Expand Down
2 changes: 1 addition & 1 deletion docs/ContactCategory.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# DigitaleKulturEvokeApiClient.ContactCategory
# DigitaleKulturEvokeApiClientJs.ContactCategory

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/ContactMessage.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# DigitaleKulturEvokeApiClient.ContactMessage
# DigitaleKulturEvokeApiClientJs.ContactMessage

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/Registration.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# DigitaleKulturEvokeApiClient.Registration
# DigitaleKulturEvokeApiClientJs.Registration

## Properties

Expand Down
24 changes: 12 additions & 12 deletions docs/RegistrationApi.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# DigitaleKulturEvokeApiClient.RegistrationApi
# DigitaleKulturEvokeApiClientJs.RegistrationApi

All URIs are relative to *http://localhost/api*

Expand All @@ -21,11 +21,11 @@ Create a new registration
### Example

```javascript
import DigitaleKulturEvokeApiClient from 'digitale-kultur/evoke-api-client';
import DigitaleKulturEvokeApiClientJs from 'digitale-kultur/evoke-api-client-js';

let apiInstance = new DigitaleKulturEvokeApiClient.RegistrationApi();
let apiInstance = new DigitaleKulturEvokeApiClientJs.RegistrationApi();
let year = 2019; // Number | Year to query for
let registration = new DigitaleKulturEvokeApiClient.Registration(); // Registration | Information about the user to be added
let registration = new DigitaleKulturEvokeApiClientJs.Registration(); // Registration | Information about the user to be added
apiInstance.createRegistration(year, registration, (error, data, response) => {
if (error) {
console.error(error);
Expand Down Expand Up @@ -66,9 +66,9 @@ Delete a single registration
### Example

```javascript
import DigitaleKulturEvokeApiClient from 'digitale-kultur/evoke-api-client';
import DigitaleKulturEvokeApiClientJs from 'digitale-kultur/evoke-api-client-js';

let apiInstance = new DigitaleKulturEvokeApiClient.RegistrationApi();
let apiInstance = new DigitaleKulturEvokeApiClientJs.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
Expand Down Expand Up @@ -113,9 +113,9 @@ Get the number of registrations
### Example

```javascript
import DigitaleKulturEvokeApiClient from 'digitale-kultur/evoke-api-client';
import DigitaleKulturEvokeApiClientJs from 'digitale-kultur/evoke-api-client-js';

let apiInstance = new DigitaleKulturEvokeApiClient.RegistrationApi();
let apiInstance = new DigitaleKulturEvokeApiClientJs.RegistrationApi();
let year = 2019; // Number | Year to query for
apiInstance.numberOfRegistrations(year, (error, data, response) => {
if (error) {
Expand Down Expand Up @@ -156,9 +156,9 @@ Get a list of countries
### Example

```javascript
import DigitaleKulturEvokeApiClient from 'digitale-kultur/evoke-api-client';
import DigitaleKulturEvokeApiClientJs from 'digitale-kultur/evoke-api-client-js';

let apiInstance = new DigitaleKulturEvokeApiClient.RegistrationApi();
let apiInstance = new DigitaleKulturEvokeApiClientJs.RegistrationApi();
apiInstance.showAllCountries((error, data, response) => {
if (error) {
console.error(error);
Expand Down Expand Up @@ -195,9 +195,9 @@ Get a list of all registrations
### Example

```javascript
import DigitaleKulturEvokeApiClient from 'digitale-kultur/evoke-api-client';
import DigitaleKulturEvokeApiClientJs from 'digitale-kultur/evoke-api-client-js';

let apiInstance = new DigitaleKulturEvokeApiClient.RegistrationApi();
let apiInstance = new DigitaleKulturEvokeApiClientJs.RegistrationApi();
let year = 2019; // Number | Year to query for
apiInstance.showAllRegistrations(year, (error, data, response) => {
if (error) {
Expand Down
2 changes: 1 addition & 1 deletion docs/Rfc7807.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# DigitaleKulturEvokeApiClient.Rfc7807
# DigitaleKulturEvokeApiClientJs.Rfc7807

## Properties

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "digitale-kultur/evoke-api-client",
"name": "digitale-kultur/evoke-api-client-js",
"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",
Expand Down
10 changes: 5 additions & 5 deletions src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ import RegistrationApi from './api/RegistrationApi';
* <p>
* An AMD (recommended!) or CommonJS application will generally do something equivalent to the following:
* <pre>
* 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.
* var DigitaleKulturEvokeApiClientJs = require('index'); // See note below*.
* var xxxSvc = new DigitaleKulturEvokeApiClientJs.XxxApi(); // Allocate the API class we're going to use.
* var yyyModel = new DigitaleKulturEvokeApiClientJs.Yyy(); // Construct a model instance.
* yyyModel.someProperty = 'someValue';
* ...
* var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.
Expand All @@ -41,8 +41,8 @@ import RegistrationApi from './api/RegistrationApi';
* <p>
* A non-AMD browser application (discouraged) might do something like this:
* <pre>
* var xxxSvc = new DigitaleKulturEvokeApiClient.XxxApi(); // Allocate the API class we're going to use.
* var yyy = new DigitaleKulturEvokeApiClient.Yyy(); // Construct a model instance.
* var xxxSvc = new DigitaleKulturEvokeApiClientJs.XxxApi(); // Allocate the API class we're going to use.
* var yyy = new DigitaleKulturEvokeApiClientJs.Yyy(); // Construct a model instance.
* yyyModel.someProperty = 'someValue';
* ...
* var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.
Expand Down

0 comments on commit d8bd1c8

Please sign in to comment.