ipaas-sync-test

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

• API version: 1.0.0
• Package version: 0.0.1-alpha-84
• 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-test --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-test 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 IpaasSyncTest = require('ipaas-sync-test');
IpaasSyncTest.ApiClient.instance.setRequest($request);
IpaasSyncTest.ApiClient.instance.setBasePath('https://ipaas-v2-demo.pipestage.com')
IpaasSyncTest.ApiClient.instance.setProduct('FRESHDESK');
const app = new IpaasSyncTest.App(APP_UUID);
IpaasSyncTest.ApiClient.instance.setApp(app);
IpaasSyncTest.ApiClient.instance.setVendorAccountId(payload.account_id);

Getting Started

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

const IpaasSyncTest = require('ipaas-sync-test');


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

Documentation for Models

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

Documentation for Authorization

All endpoints do not require authorization.