# partnership_management

PartnershipManagement - JavaScript client for partnership_management
This is Swagger UI environment generated for the TMF Partnership Management specification
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 4.0
- Package version: 4.0
- Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/),
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install partnership_management --save
```

#### git
#
If the library is hosted at a git repository, e.g.
https://github.com/GIT_USER_ID/GIT_REPO_ID
then install it via:

```shell
    npm install GIT_USER_ID/GIT_REPO_ID --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
the above steps with Node.js and installing browserify with `npm install -g browserify`,
perform the following (assuming *main.js* is your entry file):

```shell
browserify main.js > bundle.js
```

Then include *bundle.js* in the HTML pages.

### Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error:
Cannot resolve module", most certainly you should disable AMD loader. Add/merge
the following section to your webpack config:

```javascript
module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}
```

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
var PartnershipManagement = require('partnership_management');

var api = new PartnershipManagement.EventsSubscriptionApi()
var body = new PartnershipManagement.EventSubscriptionInput(); // {EventSubscriptionInput} Data containing the callback endpoint to deliver the information

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.registerListener(body, callback);
```

## Documentation for API Endpoints

All URIs are relative to *https://serverRoot/tmf-api/partnershipManagement/v4/*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*PartnershipManagement.EventsSubscriptionApi* | [**registerListener**](docs/EventsSubscriptionApi.md#registerListener) | **POST** /hub | Register a listener
*PartnershipManagement.EventsSubscriptionApi* | [**unregisterListener**](docs/EventsSubscriptionApi.md#unregisterListener) | **DELETE** /hub/{id} | Unregister a listener
*PartnershipManagement.NotificationListenersClientSideApi* | [**listenToPartnershipChangeEvent**](docs/NotificationListenersClientSideApi.md#listenToPartnershipChangeEvent) | **POST** /listener/partnershipChangeEvent | Client listener for entity PartnershipChangeEvent
*PartnershipManagement.NotificationListenersClientSideApi* | [**listenToPartnershipCreateEvent**](docs/NotificationListenersClientSideApi.md#listenToPartnershipCreateEvent) | **POST** /listener/partnershipCreateEvent | Client listener for entity PartnershipCreateEvent
*PartnershipManagement.NotificationListenersClientSideApi* | [**listenToPartnershipDeleteEvent**](docs/NotificationListenersClientSideApi.md#listenToPartnershipDeleteEvent) | **POST** /listener/partnershipDeleteEvent | Client listener for entity PartnershipDeleteEvent
*PartnershipManagement.NotificationListenersClientSideApi* | [**listenToPartnershipSpecificationChangeEvent**](docs/NotificationListenersClientSideApi.md#listenToPartnershipSpecificationChangeEvent) | **POST** /listener/partnershipSpecificationChangeEvent | Client listener for entity PartnershipSpecificationChangeEvent
*PartnershipManagement.NotificationListenersClientSideApi* | [**listenToPartnershipSpecificationCreateEvent**](docs/NotificationListenersClientSideApi.md#listenToPartnershipSpecificationCreateEvent) | **POST** /listener/partnershipSpecificationCreateEvent | Client listener for entity PartnershipSpecificationCreateEvent
*PartnershipManagement.NotificationListenersClientSideApi* | [**listenToPartnershipSpecificationDeleteEvent**](docs/NotificationListenersClientSideApi.md#listenToPartnershipSpecificationDeleteEvent) | **POST** /listener/partnershipSpecificationDeleteEvent | Client listener for entity PartnershipSpecificationDeleteEvent
*PartnershipManagement.PartnershipApi* | [**createPartnership**](docs/PartnershipApi.md#createPartnership) | **POST** /partnership | Creates a Partnership
*PartnershipManagement.PartnershipApi* | [**deletePartnership**](docs/PartnershipApi.md#deletePartnership) | **DELETE** /partnership/{id} | Deletes a Partnership
*PartnershipManagement.PartnershipApi* | [**listPartnership**](docs/PartnershipApi.md#listPartnership) | **GET** /partnership | List or find Partnership objects
*PartnershipManagement.PartnershipApi* | [**patchPartnership**](docs/PartnershipApi.md#patchPartnership) | **PATCH** /partnership/{id} | Updates partially a Partnership
*PartnershipManagement.PartnershipApi* | [**retrievePartnership**](docs/PartnershipApi.md#retrievePartnership) | **GET** /partnership/{id} | Retrieves a Partnership by ID
*PartnershipManagement.PartnershipSpecificationApi* | [**createPartnershipSpecification**](docs/PartnershipSpecificationApi.md#createPartnershipSpecification) | **POST** /partnershipSpecification | Creates a PartnershipSpecification
*PartnershipManagement.PartnershipSpecificationApi* | [**deletePartnershipSpecification**](docs/PartnershipSpecificationApi.md#deletePartnershipSpecification) | **DELETE** /partnershipSpecification/{id} | Deletes a PartnershipSpecification
*PartnershipManagement.PartnershipSpecificationApi* | [**listPartnershipSpecification**](docs/PartnershipSpecificationApi.md#listPartnershipSpecification) | **GET** /partnershipSpecification | List or find PartnershipSpecification objects
*PartnershipManagement.PartnershipSpecificationApi* | [**patchPartnershipSpecification**](docs/PartnershipSpecificationApi.md#patchPartnershipSpecification) | **PATCH** /partnershipSpecification/{id} | Updates partially a PartnershipSpecification
*PartnershipManagement.PartnershipSpecificationApi* | [**retrievePartnershipSpecification**](docs/PartnershipSpecificationApi.md#retrievePartnershipSpecification) | **GET** /partnershipSpecification/{id} | Retrieves a PartnershipSpecification by ID

## Documentation for Models

 - [PartnershipManagement.AccountRef](docs/AccountRef.md)
 - [PartnershipManagement.AgreementRef](docs/AgreementRef.md)
 - [PartnershipManagement.AgreementSpecificationRef](docs/AgreementSpecificationRef.md)
 - [PartnershipManagement.Any](docs/Any.md)
 - [PartnershipManagement.Characteristic](docs/Characteristic.md)
 - [PartnershipManagement.ContactMedium](docs/ContactMedium.md)
 - [PartnershipManagement.CreditProfile](docs/CreditProfile.md)
 - [PartnershipManagement.EntityRef](docs/EntityRef.md)
 - [PartnershipManagement.Error](docs/Error.md)
 - [PartnershipManagement.EventSubscription](docs/EventSubscription.md)
 - [PartnershipManagement.EventSubscriptionInput](docs/EventSubscriptionInput.md)
 - [PartnershipManagement.MediumCharacteristic](docs/MediumCharacteristic.md)
 - [PartnershipManagement.Partner](docs/Partner.md)
 - [PartnershipManagement.Partnership](docs/Partnership.md)
 - [PartnershipManagement.PartnershipChangeEvent](docs/PartnershipChangeEvent.md)
 - [PartnershipManagement.PartnershipChangeEventPayload](docs/PartnershipChangeEventPayload.md)
 - [PartnershipManagement.PartnershipCreate](docs/PartnershipCreate.md)
 - [PartnershipManagement.PartnershipCreateEvent](docs/PartnershipCreateEvent.md)
 - [PartnershipManagement.PartnershipCreateEventPayload](docs/PartnershipCreateEventPayload.md)
 - [PartnershipManagement.PartnershipDeleteEvent](docs/PartnershipDeleteEvent.md)
 - [PartnershipManagement.PartnershipDeleteEventPayload](docs/PartnershipDeleteEventPayload.md)
 - [PartnershipManagement.PartnershipRoleSpecification](docs/PartnershipRoleSpecification.md)
 - [PartnershipManagement.PartnershipSpecification](docs/PartnershipSpecification.md)
 - [PartnershipManagement.PartnershipSpecificationChangeEvent](docs/PartnershipSpecificationChangeEvent.md)
 - [PartnershipManagement.PartnershipSpecificationChangeEventPayload](docs/PartnershipSpecificationChangeEventPayload.md)
 - [PartnershipManagement.PartnershipSpecificationCreate](docs/PartnershipSpecificationCreate.md)
 - [PartnershipManagement.PartnershipSpecificationCreateEvent](docs/PartnershipSpecificationCreateEvent.md)
 - [PartnershipManagement.PartnershipSpecificationCreateEventPayload](docs/PartnershipSpecificationCreateEventPayload.md)
 - [PartnershipManagement.PartnershipSpecificationDeleteEvent](docs/PartnershipSpecificationDeleteEvent.md)
 - [PartnershipManagement.PartnershipSpecificationDeleteEventPayload](docs/PartnershipSpecificationDeleteEventPayload.md)
 - [PartnershipManagement.PartnershipSpecificationRef](docs/PartnershipSpecificationRef.md)
 - [PartnershipManagement.PartnershipSpecificationUpdate](docs/PartnershipSpecificationUpdate.md)
 - [PartnershipManagement.PartnershipUpdate](docs/PartnershipUpdate.md)
 - [PartnershipManagement.PaymentMethodRef](docs/PaymentMethodRef.md)
 - [PartnershipManagement.RelatedParty](docs/RelatedParty.md)
 - [PartnershipManagement.RoleSpecification](docs/RoleSpecification.md)
 - [PartnershipManagement.TimePeriod](docs/TimePeriod.md)

## Documentation for Authorization

 All endpoints do not require authorization.