Giters

karngyan / send_post_api

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

send_post_api

SendPostApi - JavaScript client for send_post_api Email API and SMTP relay to not just send and measure email sending, but also alert and optimise. We provide you with tools, expertise and support needed to reliably deliver emails to your customers inboxes on time, every time. This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.JavascriptClientCodegen

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 send_post_api --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 send_post_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('send_post_api') 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/YOUR_USERNAME/send_post_api then install it via:

    npm install YOUR_USERNAME/send_post_api --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 SendPostApi = require('send_post_api');

var api = new SendPostApi.AccountalertApi()

var xAccountApiKey = "xAccountApiKey_example"; // {String} Account API Key

var opts = { 
  'search': "search_example" // {String} search term
};

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

Documentation for API Endpoints

All URIs are relative to https://api.sendpost.io/api/v1

Class Method HTTP request Description
SendPostApi.AccountalertApi alertRouterCount GET /account/alert/count
SendPostApi.AccountalertApi alertRouterCreateAlert POST /account/alert/
SendPostApi.AccountalertApi alertRouterDelete DELETE /account/alert/{alertId}
SendPostApi.AccountalertApi alertRouterGetAll GET /account/alert/
SendPostApi.AccountalertApi alertRouterUpdate PUT /account/alert/{alertId}
SendPostApi.AccountdomainApi accountDomainRouterCount GET /account/domain/count
SendPostApi.AccountdomainApi accountDomainRouterGetAll GET /account/domain/
SendPostApi.AccountdomainReportApi domainReportRouterReputation GET /account/domainReport/reputation
SendPostApi.AccountdomainStatApi domainStatRouterGetAllAggregateDomainStatsByGroup GET /account/domainStat/{domainId}/aggregate/provider
SendPostApi.AccountdomainStatApi domainStatRouterGetStatsForASingleDomainStats GET /account/domainStat/{domainId}/aggregate
SendPostApi.AccounteventApi eventRouterCountAllEventsFromAAccountForAGivenTimeRange GET /account/event/count
SendPostApi.AccounteventApi eventRouterCountAllEventsFromANodeOfASubAccountForAGivenTimeRange GET /account/event/node/count
SendPostApi.AccounteventApi eventRouterGet GET /account/event/{eventId}
SendPostApi.AccounteventApi eventRouterGetAllEventTimestampKeysOfASubAccountFromASpecificNodeForAGivenTimeRange GET /account/event/node/timestampkeys
SendPostApi.AccounteventApi eventRouterGetAllEventsFromAAccountForAGivenTimeRange GET /account/event/
SendPostApi.AccounteventApi eventRouterGetAllEventsFromAnAccountWhichHasOnlyProccessed GET /account/event/node/eventType
SendPostApi.AccounteventApi eventRouterGetAllEventsOfAAccountFromASpecificNode POST /account/event/node
SendPostApi.AccounteventApi eventRouterGetEventInNode GET /account/event/node/{eventId}
SendPostApi.AccountincidentApi incidentRouterAdd POST /account/incident/{incidentId}/comment
SendPostApi.AccountincidentApi incidentRouterCount GET /account/incident/count
SendPostApi.AccountincidentApi incidentRouterCreate POST /account/incident/
SendPostApi.AccountincidentApi incidentRouterGetAll GET /account/incident/
SendPostApi.AccountincidentApi incidentRouterGetAllComments GET /account/incident/{incidentId}/comment
SendPostApi.AccountincidentApi incidentRouterGetIncident GET /account/incident/{incidentId}
SendPostApi.AccountincidentApi incidentRouterUpdate PUT /account/incident/{incidentId}
SendPostApi.AccountintegrationApi accountIntegrationRouterCount GET /account/integration/count
SendPostApi.AccountintegrationApi accountIntegrationRouterCreate POST /account/integration/{itype}
SendPostApi.AccountintegrationApi accountIntegrationRouterDelete DELETE /account/integration/{itype}
SendPostApi.AccountintegrationApi accountIntegrationRouterDisableGlockappsIPMonitoring DELETE /account/integration/glockapps/monitor/{ipid}
SendPostApi.AccountintegrationApi accountIntegrationRouterEnableGlockappsIPMonitoring POST /account/integration/glockapps/monitor/{ipid}
SendPostApi.AccountintegrationApi accountIntegrationRouterGetAll GET /account/integration/
SendPostApi.AccountintegrationApi accountIntegrationRouterGetMonitoredIPStats GET /account/integration/glockapps/monitor/stat/{ipid}
SendPostApi.AccountintegrationApi accountIntegrationRouterUpdate PUT /account/integration/{itype}
SendPostApi.AccountinvitationApi invitationRouterCreate POST /account/invitation/
SendPostApi.AccountinvitationApi invitationRouterDelete DELETE /account/invitation/{invitationId}
SendPostApi.AccountinvitationApi invitationRouterGetAll GET /account/invitation/
SendPostApi.AccountipApi iPRouterAllocateIP POST /account/ip/allocate
SendPostApi.AccountipApi iPRouterCount GET /account/ip/count
SendPostApi.AccountipApi iPRouterDelete DELETE /account/ip/{ipid}
SendPostApi.AccountipApi iPRouterGet GET /account/ip/{ipid}
SendPostApi.AccountipApi iPRouterGetAll GET /account/ip/
SendPostApi.AccountipApi iPRouterGetAllIPIncidents GET /account/ip/{ipid}/incident
SendPostApi.AccountipApi iPRouterUpdate PUT /account/ip/{ipid}
SendPostApi.AccountippoolApi accountIPPoolRouterCount GET /account/ippool/count
SendPostApi.AccountippoolApi accountIPPoolRouterCreate POST /account/ippool/
SendPostApi.AccountippoolApi accountIPPoolRouterDelete DELETE /account/ippool/{ippoolid}
SendPostApi.AccountippoolApi accountIPPoolRouterGet GET /account/ippool/{ippoolid}
SendPostApi.AccountippoolApi accountIPPoolRouterGetAll GET /account/ippool/
SendPostApi.AccountippoolApi accountIPPoolRouterUpdate PUT /account/ippool/{ippoolid}
SendPostApi.AccountipstatApi iPStatRouterGetAllAggregateIPStats GET /account/ip/stat/{ipid}/aggregate
SendPostApi.AccountipstatApi iPStatRouterGetAllAggregateIPStatsByProvider GET /account/ip/stat/{ipid}/aggregate/provider
SendPostApi.AccountipstatApi iPStatRouterGetAllAggregatedProviderStatsForAIP GET /account/ip/stat/{ipid}/aggregate/providers
SendPostApi.AccountipstatApi iPStatRouterGetAllAggregatedProviderStatsForASpecificSubAccountOfAIP GET /account/ip/stat/{ipid}/aggregate/sid/{sid}/providers
SendPostApi.AccountipstatApi iPStatRouterGetAllAggregatedSubAccountStatsForAnIP GET /account/ip/stat/{ipid}/aggregate/subaccounts
SendPostApi.AccountipstatApi iPStatRouterGetAllIPStats GET /account/ip/stat/{ipid}
SendPostApi.AccountlabelApi labelRouterCount GET /account/label/count
SendPostApi.AccountlabelApi labelRouterCreate POST /account/label/
SendPostApi.AccountlabelApi labelRouterDelete DELETE /account/label/{labelId}
SendPostApi.AccountlabelApi labelRouterGet GET /account/label/{labelId}
SendPostApi.AccountlabelApi labelRouterGetAll GET /account/label/
SendPostApi.AccountlabelApi labelRouterUpdate PUT /account/label/{labelId}
SendPostApi.AccountmailReportApi mailReportRouterMailReport POST /account/mailReport/
SendPostApi.AccountmailReportApi mailReportRouterMailReportGetSingleReport GET /account/mailReport/{reportId}
SendPostApi.AccountmailReportApi mailReportRouterMailReportProviders GET /account/mailReport/provider
SendPostApi.AccountmemberApi memberRouterDelete DELETE /account/member/{memberId}
SendPostApi.AccountmemberApi memberRouterGet GET /account/member/{memberId}
SendPostApi.AccountmemberApi memberRouterGetAll GET /account/member/
SendPostApi.AccountmemberApi memberRouterUpdate PUT /account/member/{memberId}
SendPostApi.AccountmemberApi memberRouterVerifyByEmailRequest POST /account/member/{memberId}/verify/email
SendPostApi.AccountmessageApi messageRouterGet GET /account/message/{messageId}
SendPostApi.AccountmessageApi messageRouterGetAllEventsForAMessageId GET /account/message/{messageId}/events
SendPostApi.AccountmessageApi messageRouterGetAllEventsForAMessageIdFromANode GET /account/message/node/{messageId}/events
SendPostApi.AccountmessageApi messageRouterGetMessageFromNode GET /account/message/node/{messageId}
SendPostApi.AccountonboardingApi onboardingRouterGetOnboardingChecklist GET /account/onboarding/checklist
SendPostApi.AccountpaymentApi paymentRouterApplyCouponToStripeCustomer POST /account/payment/customer/coupon
SendPostApi.AccountpaymentApi paymentRouterCreateCustomerPortal POST /account/payment/portal
SendPostApi.AccountpaymentApi paymentRouterCreatePaymentSubscription POST /account/payment/subscription
SendPostApi.AccountpaymentApi paymentRouterHandlePaymentWebhook POST /account/payment/webhook
SendPostApi.AccountrecipientApi recipientRouterGetAllMessagesForARecipient GET /account/recipient/{recipient}/messages
SendPostApi.AccountrecipientApi recipientRouterGetAllMessagesForARecipientFromANode GET /account/recipient/node/{recipient}/messages
SendPostApi.AccountsettingApi accountSettingRouterUpdate PUT /account/setting/
SendPostApi.AccountsmtpstatApi sMTPStatRouterGetAllAggregateIPProviderSMTPStats GET /account/smtp/stat/ip/{ipid}/provider/{provider}/aggregate
SendPostApi.AccountsmtpstatApi sMTPStatRouterGetAllAggregateIPSMTPStats GET /account/smtp/stat/ip/{ipid}/aggregate
SendPostApi.AccountsmtpstatApi sMTPStatRouterGetAllAggregateIPSMTPStatsForSubAccount GET /account/smtp/stat/ip/{ipid}/subaccount/{sid}/aggregate
SendPostApi.AccountsmtpstatApi sMTPStatRouterGetAllAggregateSubAccountProviderSMTPStats GET /account/smtp/stat/subaccount/{sid}/provider/{provider}/aggregate
SendPostApi.AccountsmtpstatApi sMTPStatRouterGetAllAggregateSubAccountSMTPStats GET /account/smtp/stat/subaccount/{sid}/aggregate
SendPostApi.AccountsmtpstatApi sMTPStatRouterGetAllAggregateSubAccountSMTPStatsForIP GET /account/smtp/stat/subaccount/{sid}/ip/{ipid}/aggregate
SendPostApi.AccountstatApi accountStatRouterGetAllAccountStats GET /account/stat/
SendPostApi.AccountstatApi accountStatRouterGetAllAccountStatsByGroup GET /account/stat/group
SendPostApi.AccountstatApi accountStatRouterGetAllAggregateAccountStats GET /account/stat/aggregate
SendPostApi.AccountstatApi accountStatRouterGetAllAggregateAccountStatsByGroup GET /account/stat/aggregate/group
SendPostApi.AccountsubaccountApi subAccountRouterCount GET /account/subaccount/count
SendPostApi.AccountsubaccountApi subAccountRouterCreate POST /account/subaccount/
SendPostApi.AccountsubaccountApi subAccountRouterDelete DELETE /account/subaccount/{subAccountId}
SendPostApi.AccountsubaccountApi subAccountRouterGet GET /account/subaccount/{subAccountId}
SendPostApi.AccountsubaccountApi subAccountRouterGetAll GET /account/subaccount/
SendPostApi.AccountsubaccountApi subAccountRouterGetAllSubAccountIncidents GET /account/subaccount/{subAccountId}/incident
SendPostApi.AccountsubaccountApi subAccountRouterUpdate PUT /account/subaccount/{subAccountId}
SendPostApi.AccounttagApi tagRouterCreate POST /account/tag/
SendPostApi.AccounttagApi tagRouterDelete DELETE /account/tag/{tagid}
SendPostApi.AccounttagApi tagRouterGetAll GET /account/tag/
SendPostApi.AccounttemplateApi accountTemplateRouterCopy POST /account/template/{templateid}/copy
SendPostApi.AccounttemplateApi accountTemplateRouterCount GET /account/template/count
SendPostApi.AccounttemplateApi accountTemplateRouterCreate POST /account/template/
SendPostApi.AccounttemplateApi accountTemplateRouterDelete DELETE /account/template/{templateid}
SendPostApi.AccounttemplateApi accountTemplateRouterGet GET /account/template/{templateid}
SendPostApi.AccounttemplateApi accountTemplateRouterGetAll GET /account/template/
SendPostApi.AccounttemplateApi accountTemplateRouterUpdate PUT /account/template/{templateid}
SendPostApi.AccountvalidationApi validateRouterValidateEmailBulk POST /account/validation/bulk
SendPostApi.AccountvalidationApi validationRouterCount GET /account/validation/count
SendPostApi.AccountvalidationApi validationRouterDeleteValidation DELETE /account/validation/
SendPostApi.AccountvalidationApi validationRouterGetAll GET /account/validation/
SendPostApi.AccountvalidationApi validationRouterValidateEmailList POST /account/validation/
SendPostApi.AccountwebhookApi accountWebhookRouterCount GET /account/webhook/count
SendPostApi.AccountwebhookApi accountWebhookRouterCreate POST /account/webhook/
SendPostApi.AccountwebhookApi accountWebhookRouterDelete DELETE /account/webhook/{webhookId}
SendPostApi.AccountwebhookApi accountWebhookRouterGet GET /account/webhook/{webhookId}
SendPostApi.AccountwebhookApi accountWebhookRouterGetAll GET /account/webhook/
SendPostApi.AccountwebhookApi accountWebhookRouterUpdate PUT /account/webhook/{webhookId}
SendPostApi.AuthApi authRouterCreate POST /auth/create
SendPostApi.AuthApi authRouterGetAuthInfo POST /auth/info
SendPostApi.AuthApi authRouterUpdateAuthInfo PUT /auth/info
SendPostApi.ClusterApi clusterRouterAddItemsToSuppressionFilterOfEveryNodeInCluster POST /cluster/suppression/filter
SendPostApi.ClusterApi clusterRouterDeleteItemFromCacheOfEveryNodeInCluster DELETE /cluster/cache
SendPostApi.ClusterApi clusterRouterDeleteItemsFromSuppressionFilterOfEveryNodeInCluster DELETE /cluster/suppression/filter
SendPostApi.ClusterApi clusterRouterGetItemFromCacheOfEveryNodeInCluster GET /cluster/cache
SendPostApi.ClusterApi clusterRouterGetItemFromCacheOfSpecificNodeInCluster GET /cluster/cache/node
SendPostApi.ClusterApi clusterRouterGetItemFromCacheOfSpecificNodeInCluster_0 DELETE /cluster/cache/node
SendPostApi.EditorApi editorApiRouterGetToken GET /editor/
SendPostApi.SmtpApi sMTPRouterReceiveWebhooksRaisedFromSMTPServers POST /smtp/webhook
SendPostApi.SubaccountdomainApi domainRouterCount GET /subaccount/domain/count
SendPostApi.SubaccountdomainApi domainRouterCreate POST /subaccount/domain/
SendPostApi.SubaccountdomainApi domainRouterDelete DELETE /subaccount/domain/{domainId}
SendPostApi.SubaccountdomainApi domainRouterGet GET /subaccount/domain/{domainId}
SendPostApi.SubaccountdomainApi domainRouterGetAll GET /subaccount/domain/
SendPostApi.SubaccountdomainApi domainRouterUpdate PUT /subaccount/domain/{domainId}
SendPostApi.SubaccountdomainApi domainRouterVerify POST /subaccount/domain/{domainId}/verify
SendPostApi.SubaccountdomainApi domainRouterVerifyByToken POST /subaccount/domain/{domainId}/verify/email/{token}
SendPostApi.SubaccountdomainApi domainRouterVerifyRequest POST /subaccount/domain/{domainId}/verify/email
SendPostApi.SubaccountemailApi emailRouterSendEmail POST /subaccount/email/
SendPostApi.SubaccountemailApi emailRouterSendEmailWithTemplate POST /subaccount/email/template
SendPostApi.SubaccountippoolApi iPPoolRouterCount GET /subaccount/ippool/count
SendPostApi.SubaccountippoolApi iPPoolRouterCreate POST /subaccount/ippool/
SendPostApi.SubaccountippoolApi iPPoolRouterDelete DELETE /subaccount/ippool/{ippoolid}
SendPostApi.SubaccountippoolApi iPPoolRouterGet GET /subaccount/ippool/{ippoolid}
SendPostApi.SubaccountippoolApi iPPoolRouterGetAll GET /subaccount/ippool/
SendPostApi.SubaccountippoolApi iPPoolRouterUpdate PUT /subaccount/ippool/{ippoolid}
SendPostApi.SubaccountsenderApi senderRouterCount GET /subaccount/sender/count
SendPostApi.SubaccountsenderApi senderRouterCreate POST /subaccount/sender/
SendPostApi.SubaccountsenderApi senderRouterDelete DELETE /subaccount/sender/{senderId}
SendPostApi.SubaccountsenderApi senderRouterGet GET /subaccount/sender/{senderId}
SendPostApi.SubaccountsenderApi senderRouterGetAll GET /subaccount/sender/
SendPostApi.SubaccountsenderApi senderRouterUpdate PUT /subaccount/sender/{senderId}
SendPostApi.SubaccountstatApi subAccountStatRouterGetAllAggregateSubAccountStats GET /subaccount/stat/aggregate
SendPostApi.SubaccountstatApi subAccountStatRouterGetAllAggregateSubAccountStatsByGroup GET /subaccount/stat/aggregate/group
SendPostApi.SubaccountstatApi subAccountStatRouterGetAllAggregatedGroupStatsForASubAccount GET /subaccount/stat/aggregate/groups
SendPostApi.SubaccountstatApi subAccountStatRouterGetAllAggregatedIPStatsForASubAccount GET /subaccount/stat/aggregate/ips
SendPostApi.SubaccountstatApi subAccountStatRouterGetAllAggregatedProviderStatsForASpecificIPOfASubAccount GET /subaccount/stat/aggregate/ip/{ipid}/providers
SendPostApi.SubaccountstatApi subAccountStatRouterGetAllAggregatedProviderStatsForASubAccount GET /subaccount/stat/aggregate/providers
SendPostApi.SubaccountstatApi subAccountStatRouterGetAllSubAccountStats GET /subaccount/stat/
SendPostApi.SubaccountstatApi subAccountStatRouterGetAllSubAccountStatsByGroup GET /subaccount/stat/group
SendPostApi.SubaccountsuppressionApi suppressionRouterCount GET /subaccount/suppression/count
SendPostApi.SubaccountsuppressionApi suppressionRouterCreateSuppressions POST /subaccount/suppression/
SendPostApi.SubaccountsuppressionApi suppressionRouterCreateSuppressionsInSuppressionFilter POST /subaccount/suppression/filter
SendPostApi.SubaccountsuppressionApi suppressionRouterDeleteSuppression DELETE /subaccount/suppression/
SendPostApi.SubaccountsuppressionApi suppressionRouterDeleteSuppressionsInSuppressionFilter DELETE /subaccount/suppression/filter
SendPostApi.SubaccountsuppressionApi suppressionRouterGetAllSuppressions GET /subaccount/suppression/
SendPostApi.SystemtemplateApi systemTemplateRouterGetAllSystemTemplates GET /system/template/
SendPostApi.TrackApi trackRouterTrackEmailOpen GET /track/open/{accountId}/{subAccountId}/{ipId}/{emailType}/{messageId}/1.png
SendPostApi.TrackApi trackRouterTrackLinkClick GET /track/click/{accountId}/{subAccountId}/{ipId}/{emailType}/{messageId}
SendPostApi.TrackApi trackRouterTrackUnsubscribe GET /track/unsubscribe/{accountId}/{subAccountId}/{ipId}/{emailType}/{messageId}

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

About

Languages

Language:JavaScript 99.9%Language:Shell 0.1%