0.1.0 • Published 5 years ago

email-template-client-javascript v0.1.0

Weekly downloads
-
License
Unlicense
Repository
-
Last release
5 years ago

email_template_service

EmailTemplateService - JavaScript client for email_template_service No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 0.1.0
  • Build package: org.openapitools.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 email_template_service --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 email_template_service from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('email_template_service') 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 EmailTemplateService = require('email_template_service');

var api = new EmailTemplateService.SlsEmailTemplateServiceApi()
var template = new EmailTemplateService.Template(); // {Template} 
api.addTemplate(template).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://d270xru3ja.execute-api.us-east-1.amazonaws.com/dev

ClassMethodHTTP requestDescription
EmailTemplateService.SlsEmailTemplateServiceApiaddTemplatePOST /email-template-service/templateAdd a new template to the store
EmailTemplateService.SlsEmailTemplateServiceApishowTemplateByIdGET /email-template-service/template/{templateId}Info for a specific template

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.