Skip to content

E-goi/sdk-javascript

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
docs
docs
 
 
src
src
 
 
test
test
 
 
.babelrc
.babelrc
 
 
.gitignore
.gitignore
 
 
.travis.yml
.travis.yml
 
 
README.md
README.md
 
 
mocha.opts
mocha.opts
 
 
package.json
package.json
 
 

Repository files navigation

E-goi

Get started quickly with E-goi with our integration tools. Our SDK is a modern open source library that makes it easy to integrate your application with E-goi services.

Almost anything you can do in E-goi, you can do with our API.

The API describes each available method. Learn about parameters, errors, and how to format your requests. That means you can easily call on E-goi actions for your integration. API Full documentation at https://developers.e-goi.com/api/v3/

Note: This repository is currently in Release Candidate stage. Use with caution in production environments.

Feel free to fork this repository and adapt it to your needs. Contributions and improvements are always welcome!

Changelog

1.1.7RC1

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 egoisdk --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 egoisdk 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/e-goi/sdk-javascript then install it via:

    npm install e-goi/sdk-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 egoisdk = require('egoisdk');

var defaultClient = egoisdk.ApiClient.instance;
// Configure API key authorization: Apikey
var Apikey = defaultClient.authentications['Apikey'];
Apikey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.apiKeyPrefix['Apikey'] = "Token"

var api = new egoisdk.AdvancedReportsApi()
var generateByModelReport = new egoisdk.GenerateByModelReport(); // {GenerateByModelReport} Parameters for the report by model Id
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateByModelReport(generateByModelReport, callback);

Documentation for API Endpoints

All URIs are relative to https://api.egoiapp.com

Class Method HTTP request Description
egoisdk.AdvancedReportsApi generateByModelReport POST /reports/advanced/model Generate report by model
egoisdk.AdvancedReportsApi generateContactActivityReport POST /reports/advanced/contact-activity Generate contact activity report
egoisdk.AdvancedReportsApi generateEmailBouncesReport POST /reports/advanced/email-bounces Generate email bounces report
egoisdk.AdvancedReportsApi generateEmailClicksByContactReport POST /reports/advanced/email-clicks-by-contact Generate email clicks by contact report
egoisdk.AdvancedReportsApi generateEmailClicksByUrlReport POST /reports/advanced/email-clicks-by-url Generate email clicks by URL report
egoisdk.AdvancedReportsApi generateEmailEventsReport POST /reports/advanced/email-events Generate email events report
egoisdk.AdvancedReportsApi generateEmailUnsubscriptionsReport POST /reports/advanced/email-unsubscriptions Generate email unsubscriptions report
egoisdk.AdvancedReportsApi generateFormAnswersReport POST /reports/advanced/form-answers Generate form answers report
egoisdk.AdvancedReportsApi generateSendsReport POST /reports/advanced/sends Generate sends report
egoisdk.AdvancedReportsApi generateSmsBouncesReport POST /reports/advanced/sms-bounces Generate SMS bounces report
egoisdk.AdvancedReportsApi generateSmsEventsReport POST /reports/advanced/sms-events Generate SMS events report
egoisdk.AdvancedReportsApi generateSubscriptionsReport POST /reports/advanced/subscriptions Generate subscriptions report
egoisdk.AdvancedReportsApi generateUnsubscriptionsReport POST /reports/advanced/unsubscriptions Generate unsubscriptions report
egoisdk.AdvancedReportsApi getAllAdvancedReports GET /reports/advanced Get all advanced reports
egoisdk.AdvancedReportsApi getAllAdvancedReportsModels GET /reports/advanced/models Get all advanced reports models
egoisdk.AutomationsApi deleteAutomation DELETE /automations/{automation_id} Remove automation
egoisdk.AutomationsApi getAllActions GET /automations/{automation_id}/actions Get all actions from given automation
egoisdk.AutomationsApi getAllAutomations GET /automations Get all automations
egoisdk.CNamesApi createCName POST /cnames Create cname
egoisdk.CNamesApi getAllCNames GET /cnames Get All CNames
egoisdk.CampaignGroupsApi createCampaignGroup POST /campaign-groups Create new campaign group
egoisdk.CampaignGroupsApi deleteCampaignGroup DELETE /campaign-groups/{group_id} Remove Campaign Group
egoisdk.CampaignGroupsApi getAllCampaignGroups GET /campaign-groups Get all campaign groups
egoisdk.CampaignGroupsApi updateCampaignGroup PUT /campaign-groups/{group_id} Update a specific campaign group
egoisdk.CampaignsApi deleteCampaigns DELETE /campaigns/{campaign_hash} Remove Campaign
egoisdk.CampaignsApi getAllCampaigns GET /campaigns Get all Campaigns
egoisdk.ConnectedSitesApi createConnectedSites POST /connectedsites Creates a Connected Site
egoisdk.ConnectedSitesApi deleteConnectedSites DELETE /connectedsites/{domain} Deletes a Connected Site
egoisdk.ConnectedSitesApi getAllConnectedSites GET /connectedsites Get all Connected Sites
egoisdk.ConnectedSitesApi getConnectedSites GET /connectedsites/{domain} Get a Connected Site
egoisdk.ContactsApi actionActivateContacts POST /lists/{list_id}/contacts/actions/activate Activate contacts
egoisdk.ContactsApi actionAttachTag POST /lists/{list_id}/contacts/actions/attach-tag Attach tag to contact
egoisdk.ContactsApi actionDeactivateContacts POST /lists/{list_id}/contacts/actions/deactivate Deactivate contacts
egoisdk.ContactsApi actionDetachTag POST /lists/{list_id}/contacts/actions/detach-tag Detach tag to contact
egoisdk.ContactsApi actionExportContacts POST /lists/{list_id}/contacts/actions/export Exports a list of contacts
egoisdk.ContactsApi actionForgetContacts POST /lists/{list_id}/contacts/actions/forget Forget contacts
egoisdk.ContactsApi actionImportBulk POST /lists/{list_id}/contacts/actions/import-bulk Import collection of contacts
egoisdk.ContactsApi actionStartAutomation POST /lists/{list_id}/contacts/actions/start-automation Start automation
egoisdk.ContactsApi actionUnsubscribeContact POST /lists/{list_id}/contacts/actions/unsubscribe Unsubscribes contacts
egoisdk.ContactsApi actionUpdateContacts POST /lists/{list_id}/contacts/actions/update Updates contacts
egoisdk.ContactsApi createContact POST /lists/{list_id}/contacts Create new contact
egoisdk.ContactsApi getAllContactActivities GET /lists/{list_id}/contacts/{contact_id}/activities Get all contact activities
egoisdk.ContactsApi getAllContacts GET /lists/{list_id}/contacts Get all contacts
egoisdk.ContactsApi getAllContactsBySegment GET /lists/{list_id}/contacts/segment/{segment_id} Get all contacts by Segment Id
egoisdk.ContactsApi getContact GET /lists/{list_id}/contacts/{contact_id} Get contact
egoisdk.ContactsApi patchContact PATCH /lists/{list_id}/contacts/{contact_id} Update a specific contact
egoisdk.ContactsApi searchContacts GET /contacts/search Search contact
egoisdk.ContactsApi updateContactByField POST /lists/{list_id}/contacts/by-field Updates a contact by field
egoisdk.EcommerceApi createCart POST /{domain}/carts Create cart
egoisdk.EcommerceApi createCatalog POST /catalogs Create new catalog
egoisdk.EcommerceApi createOrder POST /{domain}/orders Create order
egoisdk.EcommerceApi createProduct POST /catalogs/{catalog_id}/products Create new product
egoisdk.EcommerceApi deleteCatalog DELETE /catalogs/{catalog_id} Remove catalog
egoisdk.EcommerceApi deleteProduct DELETE /catalogs/{catalog_id}/products/{product_identifier} Remove product
egoisdk.EcommerceApi getAllCatalogs GET /catalogs Get all catalogs
egoisdk.EcommerceApi getAllProducts GET /catalogs/{catalog_id}/products Get all products
egoisdk.EcommerceApi getProduct GET /catalogs/{catalog_id}/products/{product_identifier} Get product
egoisdk.EcommerceApi importOrdersBulk POST /lists/{list_id}/orders Orders import bulk request
egoisdk.EcommerceApi importProducts POST /catalogs/{catalog_id}/products/actions/import Import products
egoisdk.EcommerceApi updateProduct PATCH /catalogs/{catalog_id}/products/{product_identifier} Update product
egoisdk.EmailApi actionEnableEmailRss POST /campaigns/email/rss/{campaign_hash}/actions/enable Enables a rss email campaign
egoisdk.EmailApi actionSendEmail POST /campaigns/email/{campaign_hash}/actions/send Send email message
egoisdk.EmailApi createEmailCampaign POST /campaigns/email Create new email campaign
egoisdk.EmailApi createEmailRssCampaign POST /campaigns/email/rss Create new email rss campaign
egoisdk.EmailApi patchEmailCampaign PATCH /campaigns/email/{campaign_hash} Update a specific email campaign
egoisdk.FieldsApi createExtraField POST /lists/{list_id}/fields/extra Create extra field
egoisdk.FieldsApi createFieldOption POST /lists/{list_id}/fields/extra/{field_id}/options Create new field option
egoisdk.FieldsApi deleteExtraField DELETE /lists/{list_id}/fields/extra/{field_id} Remove extra field
egoisdk.FieldsApi deleteFieldOption DELETE /lists/{list_id}/fields/extra/{field_id}/options/{option_id} Deletes an option
egoisdk.FieldsApi getAllFieldOptions GET /lists/{list_id}/fields/extra/{field_id}/options Get all field options
egoisdk.FieldsApi getAllFields GET /lists/{list_id}/fields Get all fields
egoisdk.FieldsApi patchBaseField PATCH /lists/{list_id}/fields/base/{field_id} Update base field
egoisdk.FieldsApi patchExtraField PATCH /lists/{list_id}/fields/extra/{field_id} Update extra field
egoisdk.FieldsApi updateFieldOption PATCH /lists/{list_id}/fields/extra/{field_id}/options/{option_id} Update field option
egoisdk.ListsApi createList POST /lists Create new list
egoisdk.ListsApi deleteList DELETE /lists/{list_id} Remove list
egoisdk.ListsApi getAllLists GET /lists Get all lists
egoisdk.ListsApi getList GET /lists/{list_id} Get list
egoisdk.ListsApi updateList PATCH /lists/{list_id} Update a specific list
egoisdk.MyAccountApi enableTe POST /my-account/actions/enable-te Enable Track&Engage
egoisdk.MyAccountApi enableTransactional POST /my-account/actions/enable-transactional Enable Transactional
egoisdk.MyAccountApi getMyAccount GET /my-account Get My Account Info
egoisdk.OperationsApi actionApproveOperation POST /operations/actions/approve Approve operation
egoisdk.OperationsApi actionCancelOperation POST /operations/actions/cancel Cancel operation
egoisdk.OperationsApi actionPauseOperation POST /operations/actions/pause Pause operation
egoisdk.OperationsApi actionResumeOperation POST /operations/actions/resume Resume operation
egoisdk.OperationsApi getAllOperations GET /operations Get all queued operations
egoisdk.PingApi ping POST /ping Pings the API
egoisdk.PushApi actionSendPush POST /campaigns/push/{campaign_hash}/actions/send Send push message
egoisdk.PushApi createPushCampaign POST /campaigns/push Create new push campaign
egoisdk.PushApi getPushApp GET /push/apps/{app_id} Get a Push application from E-goi
egoisdk.PushApi getPushApps GET /push/apps Get all Push applications from E-goi
egoisdk.PushApi patchPushCampaign PATCH /campaigns/push/{campaign_hash} Update a specific push campaign
egoisdk.PushApi registerPushEvent POST /push/apps/{app_id}/event Registers an event from the push notification.
egoisdk.PushApi registerPushToken POST /push/apps/{app_id}/token Registers a Firebase token
egoisdk.ReportsApi getEmailReport GET /reports/email/{campaign_hash} Get email report
egoisdk.ReportsApi getPushReport GET /reports/push/{campaign_hash} Get push report
egoisdk.ReportsApi getSMSReport GET /reports/sms/{campaign_hash} Get sms report
egoisdk.ReportsApi getVoiceReport GET /reports/voice/{campaign_hash} Get voice report
egoisdk.ReportsApi getWebPushReport GET /reports/web-push/{campaign_hash} Get webpush report
egoisdk.SegmentsApi deleteSegment DELETE /lists/{list_id}/segments/{segment_id} Remove segment
egoisdk.SegmentsApi getAllSegments GET /lists/{list_id}/segments Get all segments
egoisdk.SendersApi createCellphoneSender POST /senders/cellphone Create cellphone sender
egoisdk.SendersApi createEmailSender POST /senders/email Create email sender
egoisdk.SendersApi createPhoneSender POST /senders/phone Create phone sender
egoisdk.SendersApi deleteCellphoneSender DELETE /senders/cellphone/{sender_id} Remove cellphone sender
egoisdk.SendersApi deleteEmailSender DELETE /senders/email/{sender_id} Remove email sender
egoisdk.SendersApi deletePhoneSender DELETE /senders/phone/{sender_id} Remove phone sender
egoisdk.SendersApi getAllCellphoneSenders GET /senders/cellphone Get all cellphone senders
egoisdk.SendersApi getAllEmailSenders GET /senders/email Get all email senders
egoisdk.SendersApi getAllPhoneSenders GET /senders/phone Get all phone senders
egoisdk.SendersApi putEmailSender PUT /senders/email/{sender_id} Update email sender
egoisdk.SmartSmsApi actionSendSmartSms POST /campaigns/smart-sms/{campaign_hash}/actions/send Send smart sms message
egoisdk.SmartSmsApi createSmartSmsCampaign POST /campaigns/smart-sms Create new smart sms campaign
egoisdk.SmartSmsApi patchSmartSmsCampaign PATCH /campaigns/smart-sms/{campaign_hash} Update a specific smart sms campaign
egoisdk.SmsApi actionSendSms POST /campaigns/sms/{campaign_hash}/actions/send Send sms message
egoisdk.SmsApi createSmsCampaign POST /campaigns/sms Create new sms campaign
egoisdk.SmsApi patchSmsCampaign PATCH /campaigns/sms/{campaign_hash} Update a specific sms campaign
egoisdk.SuppressionListApi createSuppressionList POST /suppression-list Add to suppression list
egoisdk.SuppressionListApi deleteSuppressionList DELETE /suppression-list/{suppression_id} Delete from suppression list
egoisdk.SuppressionListApi getAllSuppressionList GET /suppression-list Get the suppression list
egoisdk.TagsApi createTag POST /tags Create new tag
egoisdk.TagsApi deleteTag DELETE /tags/{tag_id} Remove tag
egoisdk.TagsApi getAllTags GET /tags Get all tags
egoisdk.TagsApi updateTag PUT /tags/{tag_id} Update a specific tag
egoisdk.TrackEngageApi getAllDomains GET /trackengage/domains Get all domains
egoisdk.TrackEngageApi getAllGoals GET /trackengage/goals Get all goals
egoisdk.UsersApi deleteUser DELETE /users/{user_id} Remove user
egoisdk.UsersApi getAllUsers GET /users Get all users
egoisdk.UtilitiesApi getAllCountries GET /utilities/countries Get all countries
egoisdk.VoiceApi actionSendVoice POST /campaigns/voice/{campaign_hash}/actions/send Send voice message
egoisdk.VoiceApi createVoiceCampaign POST /campaigns/voice Create new voice campaign
egoisdk.VoiceApi patchVoiceCampaign PATCH /campaigns/voice/{campaign_hash} Update a specific voice campaign
egoisdk.WebHooksApi createWebhook POST /webhooks Create new webhook
egoisdk.WebHooksApi deleteWebhook DELETE /webhooks/{webhook_id} Remove webhook
egoisdk.WebHooksApi getAllWebhooks GET /webhooks Get all webhooks
egoisdk.WebpushApi actionEnableWebPushRss POST /campaigns/webpush/rss/{campaign_hash}/actions/enable Enable a rss webpush campaign
egoisdk.WebpushApi actionSendWebPush POST /campaigns/web-push/{campaign_hash}/actions/send Send webpush message
egoisdk.WebpushApi createWebPushCampaign POST /campaigns/web-push Create new webpush campaign
egoisdk.WebpushApi createWebPushRssCampaign POST /campaigns/webpush/rss Create new webpush rss campaign
egoisdk.WebpushApi createWebpushSite POST /webpush/sites Creates a webpush site
egoisdk.WebpushApi getAllWebPushSites GET /webpush/sites Get all webpush sites
egoisdk.WebpushApi patchWebPushCampaign PATCH /campaigns/web-push/{campaign_hash} Update a specific webpush campaign

Documentation for Models

Documentation for Authorization

Apikey

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

About

E-goi Javascript Client

developers.e-goi.com/api/v3/

Resources

Readme
Activity
Custom properties

Stars

2 stars

Watchers

4 watching

Forks

2 forks
Report repository

Releases

7 tags

Packages

No packages published

Contributors 2

  •  
  •  

Languages