Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@mergeapi/merge_ticketing_api

Package Overview
Dependencies
Maintainers
4
Versions
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@mergeapi/merge_ticketing_api

The_unified_API_for_building_rich_integrations_with_multiple_Ticketing_platforms_

  • 1.0.0
  • latest
  • npm
  • Socket score

Version published
Weekly downloads
2
Maintainers
4
Weekly downloads
 
Created
Source

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

ClassMethodHTTP requestDescription
MergeTicketingApi.AccountDetailsApiaccountDetailsRetrieveGET /account-details
MergeTicketingApi.AccountTokenApiaccountTokenRetrieveGET /account-token/{public_token}
MergeTicketingApi.AccountsApiaccountsListGET /accounts
MergeTicketingApi.AccountsApiaccountsRetrieveGET /accounts/{id}
MergeTicketingApi.AttachmentsApiattachmentsCreatePOST /attachments
MergeTicketingApi.AttachmentsApiattachmentsListGET /attachments
MergeTicketingApi.AttachmentsApiattachmentsMetaPostRetrieveGET /attachments/meta/post
MergeTicketingApi.AttachmentsApiattachmentsRetrieveGET /attachments/{id}
MergeTicketingApi.AvailableActionsApiavailableActionsRetrieveGET /available-actions
MergeTicketingApi.CommentsApicommentsCreatePOST /comments
MergeTicketingApi.CommentsApicommentsListGET /comments
MergeTicketingApi.CommentsApicommentsMetaPostRetrieveGET /comments/meta/post
MergeTicketingApi.CommentsApicommentsRetrieveGET /comments/{id}
MergeTicketingApi.ContactsApicontactsListGET /contacts
MergeTicketingApi.ContactsApicontactsRetrieveGET /contacts/{id}
MergeTicketingApi.DeleteAccountApideleteAccountCreatePOST /delete-account
MergeTicketingApi.ForceResyncApisyncStatusResyncCreatePOST /sync-status/resync
MergeTicketingApi.GenerateKeyApigenerateKeyCreatePOST /generate-key
MergeTicketingApi.IssuesApiissuesListGET /issues
MergeTicketingApi.IssuesApiissuesRetrieveGET /issues/{id}
MergeTicketingApi.LinkTokenApilinkTokenCreatePOST /link-token
MergeTicketingApi.LinkedAccountsApilinkedAccountsListGET /linked-accounts
MergeTicketingApi.PassthroughApipassthroughCreatePOST /passthrough
MergeTicketingApi.ProjectsApiprojectsListGET /projects
MergeTicketingApi.ProjectsApiprojectsRetrieveGET /projects/{id}
MergeTicketingApi.ProjectsApiprojectsUsersListGET /projects/{id}/users
MergeTicketingApi.RegenerateKeyApiregenerateKeyCreatePOST /regenerate-key
MergeTicketingApi.SyncStatusApisyncStatusListGET /sync-status
MergeTicketingApi.TagsApitagsListGET /tags
MergeTicketingApi.TagsApitagsRetrieveGET /tags/{id}
MergeTicketingApi.TeamsApiteamsListGET /teams
MergeTicketingApi.TeamsApiteamsRetrieveGET /teams/{id}
MergeTicketingApi.TicketsApiticketsCollaboratorsListGET /tickets/{id}/collaborators
MergeTicketingApi.TicketsApiticketsCreatePOST /tickets
MergeTicketingApi.TicketsApiticketsListGET /tickets
MergeTicketingApi.TicketsApiticketsMetaPostRetrieveGET /tickets/meta/post
MergeTicketingApi.TicketsApiticketsRetrieveGET /tickets/{id}
MergeTicketingApi.UsersApiusersListGET /users
MergeTicketingApi.UsersApiusersRetrieveGET /users/{id}
MergeTicketingApi.WebhookReceiversApiwebhookReceiversCreatePOST /webhook-receivers
MergeTicketingApi.WebhookReceiversApiwebhookReceiversListGET /webhook-receivers

Documentation for Models

Documentation for Authorization

tokenAuth

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

FAQs

Package last updated on 07 Jul 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc