Part_mgmt_001 NPM

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 project:

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

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

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:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. 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):

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:

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

Getting Started

Please follow the installation instruction and execute the following JS code:

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	POST /hub	Register a listener
PartnershipManagement.EventsSubscriptionApi	unregisterListener	DELETE /hub/{id}	Unregister a listener
PartnershipManagement.NotificationListenersClientSideApi	listenToPartnershipChangeEvent	POST /listener/partnershipChangeEvent	Client listener for entity PartnershipChangeEvent
PartnershipManagement.NotificationListenersClientSideApi	listenToPartnershipCreateEvent	POST /listener/partnershipCreateEvent	Client listener for entity PartnershipCreateEvent
PartnershipManagement.NotificationListenersClientSideApi	listenToPartnershipDeleteEvent	POST /listener/partnershipDeleteEvent	Client listener for entity PartnershipDeleteEvent
PartnershipManagement.NotificationListenersClientSideApi	listenToPartnershipSpecificationChangeEvent	POST /listener/partnershipSpecificationChangeEvent	Client listener for entity PartnershipSpecificationChangeEvent
PartnershipManagement.NotificationListenersClientSideApi	listenToPartnershipSpecificationCreateEvent	POST /listener/partnershipSpecificationCreateEvent	Client listener for entity PartnershipSpecificationCreateEvent
PartnershipManagement.NotificationListenersClientSideApi	listenToPartnershipSpecificationDeleteEvent	POST /listener/partnershipSpecificationDeleteEvent	Client listener for entity PartnershipSpecificationDeleteEvent
PartnershipManagement.PartnershipApi	createPartnership	POST /partnership	Creates a Partnership
PartnershipManagement.PartnershipApi	deletePartnership	DELETE /partnership/{id}	Deletes a Partnership
PartnershipManagement.PartnershipApi	listPartnership	GET /partnership	List or find Partnership objects
PartnershipManagement.PartnershipApi	patchPartnership	PATCH /partnership/{id}	Updates partially a Partnership
PartnershipManagement.PartnershipApi	retrievePartnership	GET /partnership/{id}	Retrieves a Partnership by ID
PartnershipManagement.PartnershipSpecificationApi	createPartnershipSpecification	POST /partnershipSpecification	Creates a PartnershipSpecification
PartnershipManagement.PartnershipSpecificationApi	deletePartnershipSpecification	DELETE /partnershipSpecification/{id}	Deletes a PartnershipSpecification
PartnershipManagement.PartnershipSpecificationApi	listPartnershipSpecification	GET /partnershipSpecification	List or find PartnershipSpecification objects
PartnershipManagement.PartnershipSpecificationApi	patchPartnershipSpecification	PATCH /partnershipSpecification/{id}	Updates partially a PartnershipSpecification
PartnershipManagement.PartnershipSpecificationApi	retrievePartnershipSpecification	GET /partnershipSpecification/{id}	Retrieves a PartnershipSpecification by ID

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

@babel/cli superagent

@everything-registry/sub-chunk-2412 @infinitebrahmanuniverse/nolb-part

1.0.0

2 years ago