ipaas-sync v0.0.2-beta-91

ipaas-sync

IpaasSync - JavaScript client for ipaas-sync Freshpipe API This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 0.0.2-beta-89
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://www.freshpipe.co

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 ipaas-sync --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 ipaas-sync from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

Client Initialization:

To start using the sync SDK the client must be initialised. The client initialisation requires the following:

An HTTP request object. This must be the $request object that is provided by the marketplace. This is because IPaaS allows API calls only from Marketplace.

The IPaaS domain. The domain varies depending on whether the app is for staging or prod.

• Staging: https://ipaas-v2-demo.pipestage.com
• Prod: TBD

The product in which the app is created. This can take the following values:

• FRESHDESK
• FRESHSALES
• FRESHTEAM
• FRESHSERVICE

The app id. This is a unique identifier given to each app by the platform. Contact IPaaS team to get an id. (An automated system will be soon created to get this ID)

The account_id of the account in which the app is installed.

const IpaasSync = require('ipaas-sync');
IpaasSync.ApiClient.instance.setRequest($request);
IpaasSync.ApiClient.instance.setBasePath('https://ipaas-v2-demo.pipestage.com')
IpaasSync.ApiClient.instance.setProduct('FRESHDESK');
const app = new IpaasSync.App(APP_UUID);
IpaasSync.ApiClient.instance.setApp(app);
IpaasSync.ApiClient.instance.setVendorAccountId(payload.account_id);

Getting Started

Please follow the installation and initialization(#client initialization) instruction and execute the following JS code:

const IpaasSync = require('ipaas-sync');


var api = new IpaasSync.AppApi()
var appuuid = "appuuid_example"; // {String} Unique identifier of the app
api.deleteAppDetails(appuuid).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://localhost

Documentation for Models

• IpaasSync.Account
• IpaasSync.AccountAppDetails
• IpaasSync.BackendApp
• IpaasSync.BulkSyncRequest
• IpaasSync.Choice
• IpaasSync.ClearCollisionRequest
• IpaasSync.Connector
• IpaasSync.ConnectorDetails
• IpaasSync.ConnectorDetailsPlatformOAuthConfig
• IpaasSync.ConnectorDetailsSoapMsgParseParams
• IpaasSync.CreateMatchingSettingsPayload
• IpaasSync.CreateSchemaPayload
• IpaasSync.CreateSchemaPayloadAllOf
• IpaasSync.CreateSchemaPayloadAllOf1
• IpaasSync.CreateTransformationPagePayload
• IpaasSync.DeleteTransformationPayload
• IpaasSync.Error
• IpaasSync.FieldMap
• IpaasSync.FieldMeta
• IpaasSync.Form
• IpaasSync.FormServField
• IpaasSync.FormServFieldFieldOptins
• IpaasSync.FormServMapping
• IpaasSync.FormServObject
• IpaasSync.Integration
• IpaasSync.LogObject
• IpaasSync.Mapping
• IpaasSync.MappingForm
• IpaasSync.MatchingSettings
• IpaasSync.ObjectReferences
• IpaasSync.ObjectSyncStatus
• IpaasSync.PaginatedObjectStatusList
• IpaasSync.PaginatedSyncLog
• IpaasSync.PaginationMeta
• IpaasSync.Property
• IpaasSync.SaveMappingPayload
• IpaasSync.Schema
• IpaasSync.SyncRequest
• IpaasSync.UpdateConnectorPayload
• IpaasSync.UpdateConnectorPayloadOauthDetails
• IpaasSync.ValueOption

Documentation for Authorization

All endpoints do not require authorization.