@mergeapi/merge_ticketing_api

v1.0.0

Published

a year ago

The_unified_API_for_building_rich_integrations_with_multiple_Ticketing_platforms_

Downloads

0High
0Medium
0Low

merge_ticketing_api

MergeTicketingApi - JavaScript client for merge_ticketing_api The unified API for building rich integrations with multiple Ticketing platforms. This SDK is automatically generated by the OpenAPI Generator project:

API version: 1.0
Package version: 1.0
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://www.merge.dev/

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 merge_ticketing_api --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 merge_ticketing_api 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/merge-api/merge-ticketing-javascript then install it via:

    npm install merge-api/merge-ticketing-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 MergeTicketingApi = require('merge_ticketing_api');

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

var api = new MergeTicketingApi.AccountDetailsApi()
var x_account_token = "x_account_token_example"; // {String} Token identifying the end user.
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountDetailsRetrieve(x_account_token, callback);

Documentation for API Endpoints

All URIs are relative to https://api.merge.dev/api/ticketing/v1

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- MergeTicketingApi.AccountDetailsApi | accountDetailsRetrieve | GET /account-details | MergeTicketingApi.AccountTokenApi | accountTokenRetrieve | GET /account-token/{public_token} | MergeTicketingApi.AccountsApi | accountsList | GET /accounts | MergeTicketingApi.AccountsApi | accountsRetrieve | GET /accounts/{id} | MergeTicketingApi.AttachmentsApi | attachmentsCreate | POST /attachments | MergeTicketingApi.AttachmentsApi | attachmentsList | GET /attachments | MergeTicketingApi.AttachmentsApi | attachmentsMetaPostRetrieve | GET /attachments/meta/post | MergeTicketingApi.AttachmentsApi | attachmentsRetrieve | GET /attachments/{id} | MergeTicketingApi.AvailableActionsApi | availableActionsRetrieve | GET /available-actions | MergeTicketingApi.CommentsApi | commentsCreate | POST /comments | MergeTicketingApi.CommentsApi | commentsList | GET /comments | MergeTicketingApi.CommentsApi | commentsMetaPostRetrieve | GET /comments/meta/post | MergeTicketingApi.CommentsApi | commentsRetrieve | GET /comments/{id} | MergeTicketingApi.ContactsApi | contactsList | GET /contacts | MergeTicketingApi.ContactsApi | contactsRetrieve | GET /contacts/{id} | MergeTicketingApi.DeleteAccountApi | deleteAccountCreate | POST /delete-account | MergeTicketingApi.ForceResyncApi | syncStatusResyncCreate | POST /sync-status/resync | MergeTicketingApi.GenerateKeyApi | generateKeyCreate | POST /generate-key | MergeTicketingApi.IssuesApi | issuesList | GET /issues | MergeTicketingApi.IssuesApi | issuesRetrieve | GET /issues/{id} | MergeTicketingApi.LinkTokenApi | linkTokenCreate | POST /link-token | MergeTicketingApi.LinkedAccountsApi | linkedAccountsList | GET /linked-accounts | MergeTicketingApi.PassthroughApi | passthroughCreate | POST /passthrough | MergeTicketingApi.ProjectsApi | projectsList | GET /projects | MergeTicketingApi.ProjectsApi | projectsRetrieve | GET /projects/{id} | MergeTicketingApi.ProjectsApi | projectsUsersList | GET /projects/{id}/users | MergeTicketingApi.RegenerateKeyApi | regenerateKeyCreate | POST /regenerate-key | MergeTicketingApi.SyncStatusApi | syncStatusList | GET /sync-status | MergeTicketingApi.TagsApi | tagsList | GET /tags | MergeTicketingApi.TagsApi | tagsRetrieve | GET /tags/{id} | MergeTicketingApi.TeamsApi | teamsList | GET /teams | MergeTicketingApi.TeamsApi | teamsRetrieve | GET /teams/{id} | MergeTicketingApi.TicketsApi | ticketsCollaboratorsList | GET /tickets/{id}/collaborators | MergeTicketingApi.TicketsApi | ticketsCreate | POST /tickets | MergeTicketingApi.TicketsApi | ticketsList | GET /tickets | MergeTicketingApi.TicketsApi | ticketsMetaPostRetrieve | GET /tickets/meta/post | MergeTicketingApi.TicketsApi | ticketsRetrieve | GET /tickets/{id} | MergeTicketingApi.UsersApi | usersList | GET /users | MergeTicketingApi.UsersApi | usersRetrieve | GET /users/{id} | MergeTicketingApi.WebhookReceiversApi | webhookReceiversCreate | POST /webhook-receivers | MergeTicketingApi.WebhookReceiversApi | webhookReceiversList | GET /webhook-receivers |

Documentation for Models

Documentation for Authorization

tokenAuth

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