@postlight/mailchimp_sdk_playground
v0.0.9
Published
ERROR_UNKNOWN
Downloads
5
Keywords
Readme
@postlight/mailchimp_sdk_playground
mailchimp_sdk_playground - JavaScript client for @postlight/mailchimp_sdk_playground No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:
- API version: 0.0.9
- Package version: 0.0.9
- Build package: 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 @postlight/mailchimp_sdk_playground --save
Local development
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing
into the directory containing package.json
(and this README). Let's call this JAVASCRIPT_CLIENT_DIR
. Then run:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
Finally, switch to the directory you want to use your @postlight/mailchimp_sdk_playground from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('@postlight/mailchimp_sdk_playground')
in javascript files from the directory you ran the last
command above from.
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, that's to say your javascript file where you actually
use this library):
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 mailchimp_sdk_playground = require('@postlight/mailchimp_sdk_playground');
var defaultClient = mailchimp_sdk_playground.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'
var api = new mailchimp_sdk_playground.DefaultApi()
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getPing(callback);
Documentation for API Endpoints
All URIs are relative to https://us19.api.mailchimp.com/3.0
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- mailchimp_sdk_playground.DefaultApi | getPing | GET /ping | Ping the API
Documentation for Models
- mailchimp_sdk_playground.APIHealthStatus
- mailchimp_sdk_playground.AddressMergeSegment
- mailchimp_sdk_playground.AimSegment
- mailchimp_sdk_playground.AutomationRuntimeHours
- mailchimp_sdk_playground.AutomationSegment
- mailchimp_sdk_playground.AutomationTrigger
- mailchimp_sdk_playground.AutomationWorkflowRuntimeSettings
- mailchimp_sdk_playground.BirthdayMergeSegment
- mailchimp_sdk_playground.CampaignPollSegment
- mailchimp_sdk_playground.ConversationSegment
- mailchimp_sdk_playground.CountryStateSegment
- mailchimp_sdk_playground.DateMergeSegment
- mailchimp_sdk_playground.DateSegment
- mailchimp_sdk_playground.EcommCategorySegment
- mailchimp_sdk_playground.EcommNumberSegment
- mailchimp_sdk_playground.EcommPurchasedSegment
- mailchimp_sdk_playground.EcommSpentSegment
- mailchimp_sdk_playground.EcommStoreSegment
- mailchimp_sdk_playground.EmailClientSegment
- mailchimp_sdk_playground.EmailSegment
- mailchimp_sdk_playground.EventBestCustomers
- mailchimp_sdk_playground.EventCategoryFollowup
- mailchimp_sdk_playground.EventEmailFollowup
- mailchimp_sdk_playground.EventEmailSeries
- mailchimp_sdk_playground.EventGroupAdd
- mailchimp_sdk_playground.EventGroupRemove
- mailchimp_sdk_playground.EventMandrill
- mailchimp_sdk_playground.EventProductFollowup
- mailchimp_sdk_playground.EventPurchaseFollowup
- mailchimp_sdk_playground.EventVisitUrl
- mailchimp_sdk_playground.EventWelcomeSeries
- mailchimp_sdk_playground.FuzzySegment
- mailchimp_sdk_playground.GeoInSegment
- mailchimp_sdk_playground.GoalActivitySegment
- mailchimp_sdk_playground.Hours
- mailchimp_sdk_playground.IpGeoInZipSegment
- mailchimp_sdk_playground.LanguageSegment
- mailchimp_sdk_playground.MemberRatingSegment
- mailchimp_sdk_playground.MergeRecurringEvent
- mailchimp_sdk_playground.MergeSpecialEvent
- mailchimp_sdk_playground.ProblemDetailDocument
- mailchimp_sdk_playground.RuntimeASAP
- mailchimp_sdk_playground.RuntimeAt
- mailchimp_sdk_playground.RuntimeBetween
- mailchimp_sdk_playground.SegmentCondition
- mailchimp_sdk_playground.SignupSourceSegment
- mailchimp_sdk_playground.SocialAgeSegment
- mailchimp_sdk_playground.SocialGenderSegment
- mailchimp_sdk_playground.SocialInfluenceSegment
- mailchimp_sdk_playground.SocialNetworkFollowSegment
- mailchimp_sdk_playground.SocialNetworkSegment
- mailchimp_sdk_playground.StaticSegment
- mailchimp_sdk_playground.SurveyMonkeySegment
- mailchimp_sdk_playground.TextMergeSegment
- mailchimp_sdk_playground.VIPSegment
- mailchimp_sdk_playground.ZipSegment
Documentation for Authorization
basicAuth
- Type: HTTP basic authentication