ipaas-sync

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

Class	Method	HTTP request	Description
IpaasSync.AppApi	deleteAppDetails	DELETE /integration-rest/apps/{appuuid}/details	Delete the configuration details of an app with the given appuuid and accountId
IpaasSync.AppApi	getAppDetails	GET /integration-rest/apps/{appuuid}/details	Fetch an app configuration details
IpaasSync.AppApi	saveAppDetails	POST /integration-rest/apps/{appuuid}/details	Save an app configuration details
IpaasSync.AppApi	updateAppDetails	PUT /integration-rest/apps/{appuuid}/details	Update an App Configuration details
IpaasSync.ConnectorApi	createSchema	POST /transformation-rest/schemas	Create a schema for Connector
IpaasSync.ConnectorApi	deleteConnectorById	DELETE /generic-connector-rest/connectors/{id}	Delete a Connector
IpaasSync.ConnectorApi	getConnectorById	GET /generic-connector-rest/connectors/{id}	Fetch Connector details
IpaasSync.ConnectorApi	getSchemaById	GET /transformation-rest/schemas/{id}	Get a schema
IpaasSync.ConnectorApi	getSchemasByConnectorId	GET /generic-connector-rest/connectors/{id}/schemas	Get all schemas
IpaasSync.ConnectorApi	updateConnector	PUT /generic-connector-rest/connectors/{id}	Update a Connector
IpaasSync.ConnectorApi	updateSchema	PUT /transformation-rest/schemas/{id}	Update a schema
IpaasSync.FormApi	createForm	POST /integration-rest/forms	Create a form
IpaasSync.FormApi	createMappingForm	POST /integration-rest/mappingforms	Create a Mapping form
IpaasSync.FormApi	deleteForm	DELETE /integration-rest/forms	delete form
IpaasSync.FormApi	deleteFormById	DELETE /integration-rest/forms/{id}	delete form
IpaasSync.FormApi	getForm	GET /integration-rest/forms	Fetch details of a form
IpaasSync.FormApi	getFormById	GET /integration-rest/forms/{id}	Fetch details of a form
IpaasSync.FormApi	getMappingForm	GET /integration-rest/mappingforms	Fetch Mapping Form
IpaasSync.FormApi	updateForm	PUT /integration-rest/forms/{id}	update form details
IpaasSync.FormApi	updateMappingForm	PUT /integration-rest/mappingforms	Update Mapping Form
IpaasSync.IntegrationApi	createIntegration	POST /integration-rest/integrations	Create Integration
IpaasSync.IntegrationApi	deleteApp	DELETE /integration-rest/apps	Delete App
IpaasSync.IntegrationApi	deleteIntegrations	DELETE /integration-rest/integrations	Delete integrations
IpaasSync.IntegrationApi	getIPaaSAccount	GET /integration-rest/accounts	Get IPaaS Account Details
IpaasSync.IntegrationApi	getIntegrationById	GET /integration-rest/integrations/{id}	Fetch details of an Integration
IpaasSync.IntegrationApi	getIntegrations	GET /integration-rest/integrations	Fetch list of integrations
IpaasSync.IntegrationApi	installBackendApp	POST /integration-rest/backendApps	Install Backend App
IpaasSync.IntegrationApi	uninstallBackendApp	DELETE /integration-rest/backendApps	Delete Backend App
IpaasSync.IntegrationApi	updateBackendApp	PUT /integration-rest/backendApps	Update Backend App
IpaasSync.LogApi	getLogs	GET /logging-rest/logs	Fetch logs
IpaasSync.MatchingApi	deleteObjectReferencesByTransformationGroup	DELETE /matching-rest/transformationGroups/{id}/objectReferences	Delete object references
IpaasSync.MatchingApi	getObjectReferences	GET /matching-rest/objectReferences	Get the Object References
IpaasSync.MatchingApi	saveObjectReferences	POST /matching-rest/objectReferences	Create/Update an object reference.
IpaasSync.SyncApi	clearCollision	POST /data-sync-rest/objects	Clear collision of an object
IpaasSync.SyncApi	deleteObjectSyncStatusByTransformation	DELETE /data-sync-rest/transformations/{id}/objectSyncStatuses	Delete object sync status
IpaasSync.SyncApi	getObjectSyncStatus	GET /data-sync-rest/objectStatus	Get Object Sync status
IpaasSync.SyncApi	startBulkSync	POST /data-sync-rest/bulk/sync	Start bulk Sync
IpaasSync.SyncApi	startSync	POST /data-sync-rest/sync	Start a Sync
IpaasSync.TransformationApi	createMapping	POST /transformation-rest/mappings	Create mapping
IpaasSync.TransformationApi	deleteMappingById	DELETE /transformation-rest/mappings/{id}	Delete Mapping
IpaasSync.TransformationApi	deleteMatchingSettingsByTransformationGroup	DELETE /matching-rest/transformationGroups/{id}/matchingSettings	Delete matching settings
IpaasSync.TransformationApi	getMappingById	GET /transformation-rest/mappings/{id}	Fetch details of a Mapping
IpaasSync.TransformationApi	getMappings	GET /integration-rest/formServMappings/{transformationId}	Fetch details of a FormServMapping
IpaasSync.TransformationApi	getMappingsBySchemaIds	GET /transformation-rest/schemas/{src_schema_id}/schemas/{dest_schema_id}/mappings	Get transformation
IpaasSync.TransformationApi	getMappingsOfIntegration	GET /transformation-rest/integrations/{id}/mappings	Get transformations
IpaasSync.TransformationApi	saveMapping	PUT /integration-rest/formServMappings/{transformationId}	Save formServ Mapping
IpaasSync.TransformationApi	saveMatchingSettings	POST /matching-rest/transformationGroups/{id}/matchingSettings	Save matching settings
IpaasSync.TransformationApi	updateMapping	PUT /transformation-rest/mappings/{id}	Update mapping
IpaasSync.TransformationApi	updateMatchingSettings	PUT /matching-rest/transformationGroups/{id}/matchingSettings	Update matching settings

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.