ipaas-sync-test-internal

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

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

Getting Started

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

const IpaasSyncTestInternal = require('ipaas-sync-test-internal');


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

Documentation for Models

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

Documentation for Authorization

All endpoints do not require authorization.