Newsletter2-go-api NPM

newsletter2-go-api-(https://api/newsletter2go/com)

Newsletter2GoApi(https:ApiNewsletter2goCom) - JavaScript client for newsletter2-go-api-(https://api/newsletter2go/com)

API version: 1.0.0
Package version: 1.0.0
Build date: 2016-06-08T06:59:42.502Z
Build package: class io.swagger.codegen.languages.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 newsletter2-go-api-(https://api/newsletter2go/com) --save

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/newsletter2-go-api-(https://api/newsletter2go/com) then install it via:

    npm install YOUR_USERNAME/newsletter2-go-api-(https://api/newsletter2go/com) --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.

Getting Started

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

var Newsletter2GoApi(https:ApiNewsletter2goCom) = require('newsletter2-go-api-(https://api/newsletter2go/com)');

var defaultClient = Newsletter2GoApi(https:ApiNewsletter2goCom).ApiClient.default;

// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN"

var api = new Newsletter2GoApi(https:ApiNewsletter2goCom).AttributeApi()

var attribute = new Newsletter2GoApi(https:ApiNewsletter2goCom).AttributePost(); // {AttributePost} the data to save


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

Documentation for API Endpoints

All URIs are relative to https://api.newsletter2go.com

Class	Method	HTTP request	Description
Newsletter2GoApi(https:ApiNewsletter2goCom).AttributeApi	createAttribute	POST /attributes	creates a new attribute
Newsletter2GoApi(https:ApiNewsletter2goCom).AttributeApi	deleteAttribute	DELETE /lists/{lid}/attributes/{id}	delete the attribute
Newsletter2GoApi(https:ApiNewsletter2goCom).AttributeApi	getAttributes	GET /lists/{lid}/attributes	get all Attributes of selected list
Newsletter2GoApi(https:ApiNewsletter2goCom).AttributeApi	updateAttribute	PATCH /attributes/{id}	update the attribute
Newsletter2GoApi(https:ApiNewsletter2goCom).AuthorizationApi	getToken	POST /oauth/v2/token	Endpoint for retrieving a token
Newsletter2GoApi(https:ApiNewsletter2goCom).CompanyApi	getCompany	GET /companies	get the details of a company
Newsletter2GoApi(https:ApiNewsletter2goCom).CompanyApi	updateCompany	PATCH /companies/{id}	update the Company
Newsletter2GoApi(https:ApiNewsletter2goCom).GroupApi	addRecipientToGroup	POST /lists/{lid}/groups/{gid}/recipients/{id}	add single recipient to group
Newsletter2GoApi(https:ApiNewsletter2goCom).GroupApi	addRecipientsToGroup	POST /lists/{lid}/groups/{gid}/recipients	add all Recipients to the given group
Newsletter2GoApi(https:ApiNewsletter2goCom).GroupApi	createGroup	POST /groups	creates a new group
Newsletter2GoApi(https:ApiNewsletter2goCom).GroupApi	deleteGroup	DELETE /groups/{id}	delete the Group
Newsletter2GoApi(https:ApiNewsletter2goCom).GroupApi	getGroups	GET /lists/{lid}/groups	get all Group of selected list
Newsletter2GoApi(https:ApiNewsletter2goCom).GroupApi	getRecipientsByGroup	GET /lists/{lid}/groups/{gid}/recipients	get all Recipients of selected group
Newsletter2GoApi(https:ApiNewsletter2goCom).GroupApi	removeRecipientFromGroup	DELETE /lists/{lid}/groups/{gid}/recipients/{id}	remove single recipient from group
Newsletter2GoApi(https:ApiNewsletter2goCom).GroupApi	removeRecipientsFromGroup	DELETE /lists/{lid}/groups/{gid}/recipients	remove all Recipients from given group
Newsletter2GoApi(https:ApiNewsletter2goCom).GroupApi	updateGroup	PATCH /groups/{id}	update the Group
Newsletter2GoApi(https:ApiNewsletter2goCom).ListApi	createList	POST /lists	creates a new list
Newsletter2GoApi(https:ApiNewsletter2goCom).ListApi	deleteList	DELETE /lists/{id}	delete the List
Newsletter2GoApi(https:ApiNewsletter2goCom).ListApi	getLists	GET /lists	get all lists
Newsletter2GoApi(https:ApiNewsletter2goCom).ListApi	getRecipients	GET /lists/{lid}/recipients	get all Recipients of selected list
Newsletter2GoApi(https:ApiNewsletter2goCom).ListApi	removeRecipientsFromList	DELETE /lists/{lid}/recipients	remove all Recipients from selected list
Newsletter2GoApi(https:ApiNewsletter2goCom).ListApi	updateList	PATCH /lists/{id}	update the List
Newsletter2GoApi(https:ApiNewsletter2goCom).ListApi	updateRecipients	PATCH /lists/{lid}/recipients	update all Recipients in selected list
Newsletter2GoApi(https:ApiNewsletter2goCom).NewsletterApi	createNewsletter	POST /lists/{lid}/newsletters	creates a new newsletter
Newsletter2GoApi(https:ApiNewsletter2goCom).NewsletterApi	getNewsletter	GET /newsletters/{id}	get one newsletter
Newsletter2GoApi(https:ApiNewsletter2goCom).NewsletterApi	getNewsletters	GET /lists/{lid}/newsletters	get all newsletters of the given list
Newsletter2GoApi(https:ApiNewsletter2goCom).NewsletterApi	getReports	GET /lists/{lid}/newsletters/{nid}/aggregations	get reports for the newsletter aggregated by days
Newsletter2GoApi(https:ApiNewsletter2goCom).NewsletterApi	sendNewsletter	POST /newsletters/{id}/send	Sends the newsletter to a list or group
Newsletter2GoApi(https:ApiNewsletter2goCom).NewsletterApi	updateNewsletter	PATCH /newsletters/{id}	update the Newsletter
Newsletter2GoApi(https:ApiNewsletter2goCom).RecipientApi	addRecipientToGroup	POST /lists/{lid}/groups/{gid}/recipients/{id}	add single recipient to group
Newsletter2GoApi(https:ApiNewsletter2goCom).RecipientApi	addRecipientsToGroup	POST /lists/{lid}/groups/{gid}/recipients	add all Recipients to the given group
Newsletter2GoApi(https:ApiNewsletter2goCom).RecipientApi	createRecipient	POST /recipients	create new recipient(s) or updates existing ones
Newsletter2GoApi(https:ApiNewsletter2goCom).RecipientApi	deleteRecipient	DELETE /lists/{lid}/recipients/{id}	delete the recipient
Newsletter2GoApi(https:ApiNewsletter2goCom).RecipientApi	getRecipients	GET /lists/{lid}/recipients	get all Recipients of selected list
Newsletter2GoApi(https:ApiNewsletter2goCom).RecipientApi	getRecipientsByGroup	GET /lists/{lid}/groups/{gid}/recipients	get all Recipients of selected group
Newsletter2GoApi(https:ApiNewsletter2goCom).RecipientApi	importRecipientsInit	POST /lists/{lid}/recipients/import/init	Initialize the import of recipients by file
Newsletter2GoApi(https:ApiNewsletter2goCom).RecipientApi	importRecipientsSave	POST /lists/{lid}/recipients/import/save	Start the import recipients by file
Newsletter2GoApi(https:ApiNewsletter2goCom).RecipientApi	importRecipientsStatistics	GET /import/{id}/info	Get statistics about the import by file
Newsletter2GoApi(https:ApiNewsletter2goCom).RecipientApi	removeRecipientFromGroup	DELETE /lists/{lid}/groups/{gid}/recipients/{id}	remove single recipient from group
Newsletter2GoApi(https:ApiNewsletter2goCom).RecipientApi	removeRecipientsFromGroup	DELETE /lists/{lid}/groups/{gid}/recipients	remove all Recipients from given group
Newsletter2GoApi(https:ApiNewsletter2goCom).RecipientApi	removeRecipientsFromList	DELETE /lists/{lid}/recipients	remove all Recipients from selected list
Newsletter2GoApi(https:ApiNewsletter2goCom).RecipientApi	subscribeRecipient	POST /forms/submit/{code}	Creates a new recipient and sends a DOI-Mail
Newsletter2GoApi(https:ApiNewsletter2goCom).RecipientApi	updateRecipient	PATCH /lists/{lid}/recipients/{id}	update the recipient.
Newsletter2GoApi(https:ApiNewsletter2goCom).RecipientApi	updateRecipients	PATCH /lists/{lid}/recipients	update all Recipients in selected list
Newsletter2GoApi(https:ApiNewsletter2goCom).ReportApi	getReports	GET /lists/{lid}/newsletters/{nid}/aggregations	get reports for the newsletter aggregated by days
Newsletter2GoApi(https:ApiNewsletter2goCom).UserApi	getUsers	GET /users	get all users of the company where the current user has access to
Newsletter2GoApi(https:ApiNewsletter2goCom).UserApi	updateUser	PATCH /users/{id}	update the user

Documentation for Models

Documentation for Authorization

OAuth

Type: OAuth
Flow: implicit
Authorization URL: /oauth/v2/token
Scopes: N/A

Basic

Type: HTTP basic authentication

superagent

@everything-registry/sub-chunk-2266

1.0.0

4 years ago