dyspatch-client

dyspatch-client

DyspatchClient - JavaScript client for dyspatch-client

Introduction

The Dyspatch API is based on the REST paradigm, and features resource based URLs with standard HTTP response codes to indicate errors. We use standard HTTP authentication and request verbs, and all responses are JSON formatted. See our Implementation Guide for more details on how to implement Dyspatch.

API Client Libraries

Dyspatch provides API Clients for popular languages and web frameworks.

• Java
• Javascript
• Python
• C#
• Go
• Ruby

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 2020.11
• Package version: 6.0.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://docs.dyspatch.io

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 dyspatch-client --save

Finally, you need to build the module:

npm run build

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

To use the link you just defined in your project, switch to the directory you want to use your dyspatch-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/getdyspatch/dyspatch-javascript then install it via:

    npm install getdyspatch/dyspatch-javascript --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 DyspatchClient = require('dyspatch-client');

var defaultClient = DyspatchClient.ApiClient.instance;
// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new DyspatchClient.DraftsApi()
var draftId = "draftId_example"; // {String} A draft ID
var languageId = "languageId_example"; // {String} A language ID (eg: en-US)
var accept = "accept_example"; // {String} A version of the API that should be used for the request. For example, to use version \"2020.11\", set the value to \"application/vnd.dyspatch.2020.11+json\"
api.deleteLocalization(draftId, languageId, accept).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://api.dyspatch.io

Class	Method	HTTP request	Description
DyspatchClient.DraftsApi	deleteLocalization	DELETE /drafts/{draftId}/localizations/{languageId}	Remove a localization
DyspatchClient.DraftsApi	getDraftById	GET /drafts/{draftId}	Get Draft by ID
DyspatchClient.DraftsApi	getDraftLocalizationKeys	GET /drafts/{draftId}/localizationKeys	Get localization keys
DyspatchClient.DraftsApi	getDrafts	GET /drafts	List Drafts
DyspatchClient.DraftsApi	getLocalizationForDraft	GET /drafts/{draftId}/localizations	Get localizations on a draft
DyspatchClient.DraftsApi	saveLocalization	PUT /drafts/{draftId}/localizations/{languageId}	Create or update a localization
DyspatchClient.DraftsApi	setTranslation	PUT /drafts/{draftId}/localizations/{languageId}/translations	Set translations for language
DyspatchClient.DraftsApi	submitDraftForApproval	POST /drafts/{draftId}/publishRequest	Submit the draft for approval
DyspatchClient.LocalizationsApi	getDraftLocalizationById	GET /localizations/{localizationId}/drafts/{draftId}	Get Draft Localization Object by ID
DyspatchClient.LocalizationsApi	getPublishedLocalizationById	GET /localizations/{localizationId}	Get Localization Object by ID
DyspatchClient.TemplatesApi	getTemplateById	GET /templates/{templateId}	Get Template by ID
DyspatchClient.TemplatesApi	getTemplates	GET /templates	List Templates

Documentation for Models

• DyspatchClient.APIError
• DyspatchClient.CompiledRead
• DyspatchClient.Cursor
• DyspatchClient.DraftMetaRead
• DyspatchClient.DraftRead
• DyspatchClient.DraftsRead
• DyspatchClient.InlineObject
• DyspatchClient.LocalizationKeyRead
• DyspatchClient.LocalizationMetaRead
• DyspatchClient.LocalizationRead
• DyspatchClient.TemplateMetaRead
• DyspatchClient.TemplateRead
• DyspatchClient.TemplatesRead

Documentation for Authorization

Bearer

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header