Egoisdk NPM | npm.io

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/

If you find a bug or something worth fixing, create an issue.

Changelog

1.1.0RC2

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

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

Finally, switch to the directory you want to use your egoiSdk from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('egoiSdk') in javascript files from the directory you ran the last command above from.

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, that's to say your javascript file where you actually use this library):

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 generateEmailBouncesReport = new egoiSdk.GenerateEmailBouncesReport(); // {GenerateEmailBouncesReport} Parameters for the email bounces report

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateEmailBouncesReport(generateEmailBouncesReport, callback);

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
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	generateEmailSmsReport	POST /reports/advanced/sms-bounces	Generate SMS bounces 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	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.AutomationsApi	deleteAutomation	DELETE /automations/{automation_id}	Remove 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.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	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	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.EcommerceApi	createCatalog	POST /catalogs	Create new catalog
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	updateList	PATCH /lists/{list_id}	Update a specific list
egoiSdk.MyAccountApi	enableTe	POST /my-account/actions/enable-te	Enable Track&Engage
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	patchPushCampaign	PATCH /campaigns/push/{campaign_hash}	Update a specific push campaign
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	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.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

egoisdk

superagent

@infinitebrahmanuniverse/nolb-ego @everything-registry/sub-chunk-1560

1.1.0-RC2

3 years ago