Pakat-api-v3-sdk NPM

Pakat's API v3 Node.js Library

Pakat's API exposes the entire Pakat features via a standardized programmatic interface. Please refer to the full documentation to learn more. Pakat is a proxy for SendinBlue.

This is the wrapper for the API. It implements all the features of the API v3. It supports promises.

Pakat's API matches the OpenAPI v2 definition. The specification can be downloaded here.

This library is automatically generated by the Swagger Codegen project and is reviewed and maintained by SendinBlue:

API version: 3.0.0
Package version: 8.0.0
Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

The following recommended installation requires npm. If you are unfamiliar with npm, see the npm docs.

Then install it via:

npm install pakat-api-v3-sdk --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 pakat-api-v3-sdk from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('pakat-api-v3-sdk') 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/irandoust/pakat-APIv3-nodejs-library then install it via:

    npm install irandoust/pakat-APIv3-nodejs-library --save

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 PakatApiV3Sdk = require('pakat-api-v3-sdk');

var defaultClient = PakatApiV3Sdk.ApiClient.instance;

// Configure API key authorization: api-key
var apiKey = defaultClient.authentications['api-key'];
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['api-key'] = "Token"

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

var api = new PakatApiV3Sdk.AccountApi()
api.getAccount().then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://api.sendinblue.com/v3

Class	Method	HTTP request	Description
PakatApiV3Sdk.AccountApi	getAccount	GET /account	Get your account information, plan and credits details
PakatApiV3Sdk.AttributesApi	createAttribute	POST /contacts/attributes/{attributeCategory}/{attributeName}	Create contact attribute
PakatApiV3Sdk.AttributesApi	deleteAttribute	DELETE /contacts/attributes/{attributeCategory}/{attributeName}	Delete an attribute
PakatApiV3Sdk.AttributesApi	getAttributes	GET /contacts/attributes	List all attributes
PakatApiV3Sdk.AttributesApi	updateAttribute	PUT /contacts/attributes/{attributeCategory}/{attributeName}	Update contact attribute
PakatApiV3Sdk.ContactsApi	addContactToList	POST /contacts/lists/{listId}/contacts/add	Add existing contacts to a list
PakatApiV3Sdk.ContactsApi	createAttribute	POST /contacts/attributes/{attributeCategory}/{attributeName}	Create contact attribute
PakatApiV3Sdk.ContactsApi	createContact	POST /contacts	Create a contact
PakatApiV3Sdk.ContactsApi	createDoiContact	POST /contacts/doubleOptinConfirmation	Create Contact via DOI (Double-Opt-In) Flow
PakatApiV3Sdk.ContactsApi	createFolder	POST /contacts/folders	Create a folder
PakatApiV3Sdk.ContactsApi	createList	POST /contacts/lists	Create a list
PakatApiV3Sdk.ContactsApi	deleteAttribute	DELETE /contacts/attributes/{attributeCategory}/{attributeName}	Delete an attribute
PakatApiV3Sdk.ContactsApi	deleteContact	DELETE /contacts/{identifier}	Delete a contact
PakatApiV3Sdk.ContactsApi	deleteFolder	DELETE /contacts/folders/{folderId}	Delete a folder (and all its lists)
PakatApiV3Sdk.ContactsApi	deleteList	DELETE /contacts/lists/{listId}	Delete a list
PakatApiV3Sdk.ContactsApi	getAttributes	GET /contacts/attributes	List all attributes
PakatApiV3Sdk.ContactsApi	getContactInfo	GET /contacts/{identifier}	Get a contact's details
PakatApiV3Sdk.ContactsApi	getContactStats	GET /contacts/{identifier}/campaignStats	Get email campaigns' statistics for a contact
PakatApiV3Sdk.ContactsApi	getContacts	GET /contacts	Get all the contacts
PakatApiV3Sdk.ContactsApi	getContactsFromList	GET /contacts/lists/{listId}/contacts	Get contacts in a list
PakatApiV3Sdk.ContactsApi	getFolder	GET /contacts/folders/{folderId}	Returns a folder's details
PakatApiV3Sdk.ContactsApi	getFolderLists	GET /contacts/folders/{folderId}/lists	Get lists in a folder
PakatApiV3Sdk.ContactsApi	getFolders	GET /contacts/folders	Get all folders
PakatApiV3Sdk.ContactsApi	getList	GET /contacts/lists/{listId}	Get a list's details
PakatApiV3Sdk.ContactsApi	getLists	GET /contacts/lists	Get all the lists
PakatApiV3Sdk.ContactsApi	importContacts	POST /contacts/import	Import contacts
PakatApiV3Sdk.ContactsApi	removeContactFromList	POST /contacts/lists/{listId}/contacts/remove	Delete a contact from a list
PakatApiV3Sdk.ContactsApi	requestContactExport	POST /contacts/export	Export contacts
PakatApiV3Sdk.ContactsApi	updateAttribute	PUT /contacts/attributes/{attributeCategory}/{attributeName}	Update contact attribute
PakatApiV3Sdk.ContactsApi	updateContact	PUT /contacts/{identifier}	Update a contact
PakatApiV3Sdk.ContactsApi	updateFolder	PUT /contacts/folders/{folderId}	Update a folder
PakatApiV3Sdk.ContactsApi	updateList	PUT /contacts/lists/{listId}	Update a list
PakatApiV3Sdk.EmailCampaignsApi	createEmailCampaign	POST /emailCampaigns	Create an email campaign
PakatApiV3Sdk.EmailCampaignsApi	deleteEmailCampaign	DELETE /emailCampaigns/{campaignId}	Delete an email campaign
PakatApiV3Sdk.EmailCampaignsApi	emailExportRecipients	POST /emailCampaigns/{campaignId}/exportRecipients	Export the recipients of an email campaign
PakatApiV3Sdk.EmailCampaignsApi	getAbTestCampaignResult	GET /emailCampaigns/{campaignId}/abTestCampaignResult	Get an A/B test email campaign results
PakatApiV3Sdk.EmailCampaignsApi	getEmailCampaign	GET /emailCampaigns/{campaignId}	Get an email campaign report
PakatApiV3Sdk.EmailCampaignsApi	getEmailCampaigns	GET /emailCampaigns	Return all your created email campaigns
PakatApiV3Sdk.EmailCampaignsApi	getSharedTemplateUrl	GET /emailCampaigns/{campaignId}/sharedUrl	Get a shared template url
PakatApiV3Sdk.EmailCampaignsApi	sendEmailCampaignNow	POST /emailCampaigns/{campaignId}/sendNow	Send an email campaign immediately, based on campaignId
PakatApiV3Sdk.EmailCampaignsApi	sendReport	POST /emailCampaigns/{campaignId}/sendReport	Send the report of a campaign
PakatApiV3Sdk.EmailCampaignsApi	sendTestEmail	POST /emailCampaigns/{campaignId}/sendTest	Send an email campaign to your test list
PakatApiV3Sdk.EmailCampaignsApi	updateCampaignStatus	PUT /emailCampaigns/{campaignId}/status	Update an email campaign status
PakatApiV3Sdk.EmailCampaignsApi	updateEmailCampaign	PUT /emailCampaigns/{campaignId}	Update an email campaign
PakatApiV3Sdk.EmailCampaignsApi	uploadImageToGallery	POST /emailCampaigns/images	Upload an image to your account's image gallery
PakatApiV3Sdk.FoldersApi	createFolder	POST /contacts/folders	Create a folder
PakatApiV3Sdk.FoldersApi	deleteFolder	DELETE /contacts/folders/{folderId}	Delete a folder (and all its lists)
PakatApiV3Sdk.FoldersApi	getFolder	GET /contacts/folders/{folderId}	Returns a folder's details
PakatApiV3Sdk.FoldersApi	getFolderLists	GET /contacts/folders/{folderId}/lists	Get lists in a folder
PakatApiV3Sdk.FoldersApi	getFolders	GET /contacts/folders	Get all folders
PakatApiV3Sdk.FoldersApi	updateFolder	PUT /contacts/folders/{folderId}	Update a folder
PakatApiV3Sdk.ListsApi	addContactToList	POST /contacts/lists/{listId}/contacts/add	Add existing contacts to a list
PakatApiV3Sdk.ListsApi	createList	POST /contacts/lists	Create a list
PakatApiV3Sdk.ListsApi	deleteList	DELETE /contacts/lists/{listId}	Delete a list
PakatApiV3Sdk.ListsApi	getContactsFromList	GET /contacts/lists/{listId}/contacts	Get contacts in a list
PakatApiV3Sdk.ListsApi	getFolderLists	GET /contacts/folders/{folderId}/lists	Get lists in a folder
PakatApiV3Sdk.ListsApi	getList	GET /contacts/lists/{listId}	Get a list's details
PakatApiV3Sdk.ListsApi	getLists	GET /contacts/lists	Get all the lists
PakatApiV3Sdk.ListsApi	removeContactFromList	POST /contacts/lists/{listId}/contacts/remove	Delete a contact from a list
PakatApiV3Sdk.ListsApi	updateList	PUT /contacts/lists/{listId}	Update a list
PakatApiV3Sdk.ProcessApi	getProcess	GET /processes/{processId}	Return the informations for a process
PakatApiV3Sdk.ProcessApi	getProcesses	GET /processes	Return all the processes for your account
PakatApiV3Sdk.ResellerApi	addCredits	POST /reseller/children/{childIdentifier}/credits/add	Add Email and/or SMS credits to a specific child account
PakatApiV3Sdk.ResellerApi	associateIpToChild	POST /reseller/children/{childIdentifier}/ips/associate	Associate a dedicated IP to the child
PakatApiV3Sdk.ResellerApi	createChildDomain	POST /reseller/children/{childIdentifier}/domains	Create a domain for a child account
PakatApiV3Sdk.ResellerApi	createResellerChild	POST /reseller/children	Creates a reseller child
PakatApiV3Sdk.ResellerApi	deleteChildDomain	DELETE /reseller/children/{childIdentifier}/domains/{domainName}	Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
PakatApiV3Sdk.ResellerApi	deleteResellerChild	DELETE /reseller/children/{childIdentifier}	Delete a single reseller child based on the child identifier supplied
PakatApiV3Sdk.ResellerApi	dissociateIpFromChild	POST /reseller/children/{childIdentifier}/ips/dissociate	Dissociate a dedicated IP to the child
PakatApiV3Sdk.ResellerApi	getChildAccountCreationStatus	GET /reseller/children/{childIdentifier}/accountCreationStatus	Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied
PakatApiV3Sdk.ResellerApi	getChildDomains	GET /reseller/children/{childIdentifier}/domains	Get all sender domains for a specific child account
PakatApiV3Sdk.ResellerApi	getChildInfo	GET /reseller/children/{childIdentifier}	Get a child account's details
PakatApiV3Sdk.ResellerApi	getResellerChilds	GET /reseller/children	Get the list of all children accounts
PakatApiV3Sdk.ResellerApi	getSsoToken	GET /reseller/children/{childIdentifier}/auth	Get session token to access Sendinblue (SSO)
PakatApiV3Sdk.ResellerApi	removeCredits	POST /reseller/children/{childIdentifier}/credits/remove	Remove Email and/or SMS credits from a specific child account
PakatApiV3Sdk.ResellerApi	updateChildAccountStatus	PUT /reseller/children/{childIdentifier}/accountStatus	Update info of reseller's child account status based on the childIdentifier supplied
PakatApiV3Sdk.ResellerApi	updateChildDomain	PUT /reseller/children/{childIdentifier}/domains/{domainName}	Update the sender domain of reseller's child based on the childIdentifier and domainName passed
PakatApiV3Sdk.ResellerApi	updateResellerChild	PUT /reseller/children/{childIdentifier}	Update info of reseller's child based on the child identifier supplied
PakatApiV3Sdk.SMSCampaignsApi	createSmsCampaign	POST /smsCampaigns	Creates an SMS campaign
PakatApiV3Sdk.SMSCampaignsApi	deleteSmsCampaign	DELETE /smsCampaigns/{campaignId}	Delete an SMS campaign
PakatApiV3Sdk.SMSCampaignsApi	getSmsCampaign	GET /smsCampaigns/{campaignId}	Get an SMS campaign
PakatApiV3Sdk.SMSCampaignsApi	getSmsCampaigns	GET /smsCampaigns	Returns the information for all your created SMS campaigns
PakatApiV3Sdk.SMSCampaignsApi	requestSmsRecipientExport	POST /smsCampaigns/{campaignId}/exportRecipients	Export an SMS campaign's recipients
PakatApiV3Sdk.SMSCampaignsApi	sendSmsCampaignNow	POST /smsCampaigns/{campaignId}/sendNow	Send your SMS campaign immediately
PakatApiV3Sdk.SMSCampaignsApi	sendSmsReport	POST /smsCampaigns/{campaignId}/sendReport	Send an SMS campaign's report
PakatApiV3Sdk.SMSCampaignsApi	sendTestSms	POST /smsCampaigns/{campaignId}/sendTest	Send a test SMS campaign
PakatApiV3Sdk.SMSCampaignsApi	updateSmsCampaign	PUT /smsCampaigns/{campaignId}	Update an SMS campaign
PakatApiV3Sdk.SMSCampaignsApi	updateSmsCampaignStatus	PUT /smsCampaigns/{campaignId}/status	Update a campaign's status
PakatApiV3Sdk.SendersApi	createSender	POST /senders	Create a new sender
PakatApiV3Sdk.SendersApi	deleteSender	DELETE /senders/{senderId}	Delete a sender
PakatApiV3Sdk.SendersApi	getIps	GET /senders/ips	Get all the dedicated IPs for your account
PakatApiV3Sdk.SendersApi	getIpsFromSender	GET /senders/{senderId}/ips	Get all the dedicated IPs for a sender
PakatApiV3Sdk.SendersApi	getSenders	GET /senders	Get the list of all your senders
PakatApiV3Sdk.SendersApi	updateSender	PUT /senders/{senderId}	Update a sender
PakatApiV3Sdk.TransactionalEmailsApi	createSmtpTemplate	POST /smtp/templates	Create an email template
PakatApiV3Sdk.TransactionalEmailsApi	deleteHardbounces	POST /smtp/deleteHardbounces	Delete hardbounces
PakatApiV3Sdk.TransactionalEmailsApi	deleteSmtpTemplate	DELETE /smtp/templates/{templateId}	Delete an inactive email template
PakatApiV3Sdk.TransactionalEmailsApi	getAggregatedSmtpReport	GET /smtp/statistics/aggregatedReport	Get your transactional email activity aggregated over a period of time
PakatApiV3Sdk.TransactionalEmailsApi	getEmailEventReport	GET /smtp/statistics/events	Get all your transactional email activity (unaggregated events)
PakatApiV3Sdk.TransactionalEmailsApi	getSmtpReport	GET /smtp/statistics/reports	Get your transactional email activity aggregated per day
PakatApiV3Sdk.TransactionalEmailsApi	getSmtpTemplate	GET /smtp/templates/{templateId}	Returns the template information
PakatApiV3Sdk.TransactionalEmailsApi	getSmtpTemplates	GET /smtp/templates	Get the list of email templates
PakatApiV3Sdk.TransactionalEmailsApi	getTransacBlockedContacts	GET /smtp/blockedContacts	Get the list of blocked or unsubscribed transactional contacts
PakatApiV3Sdk.TransactionalEmailsApi	getTransacEmailContent	GET /smtp/emails/{uuid}	Get the personalized content of a sent transactional email
PakatApiV3Sdk.TransactionalEmailsApi	getTransacEmailsList	GET /smtp/emails	Get the list of transactional emails on the basis of allowed filters
PakatApiV3Sdk.TransactionalEmailsApi	sendTemplate	POST /smtp/templates/{templateId}/send	Send a template
PakatApiV3Sdk.TransactionalEmailsApi	sendTestTemplate	POST /smtp/templates/{templateId}/sendTest	Send a template to your test list
PakatApiV3Sdk.TransactionalEmailsApi	sendTransacEmail	POST /smtp/email	Send a transactional email
PakatApiV3Sdk.TransactionalEmailsApi	smtpBlockedContactsEmailDelete	DELETE /smtp/blockedContacts/{email}	Unblock or resubscribe a transactional contact
PakatApiV3Sdk.TransactionalEmailsApi	smtpLogMessageIdDelete	DELETE /smtp/log/{messageId}	Delete an SMTP transactional log
PakatApiV3Sdk.TransactionalEmailsApi	updateSmtpTemplate	PUT /smtp/templates/{templateId}	Update an email template
PakatApiV3Sdk.TransactionalSMSApi	getSmsEvents	GET /transactionalSMS/statistics/events	Get all your SMS activity (unaggregated events)
PakatApiV3Sdk.TransactionalSMSApi	getTransacAggregatedSmsReport	GET /transactionalSMS/statistics/aggregatedReport	Get your SMS activity aggregated over a period of time
PakatApiV3Sdk.TransactionalSMSApi	getTransacSmsReport	GET /transactionalSMS/statistics/reports	Get your SMS activity aggregated per day
PakatApiV3Sdk.TransactionalSMSApi	sendTransacSms	POST /transactionalSMS/sms	Send SMS message to a mobile number
PakatApiV3Sdk.WebhooksApi	createWebhook	POST /webhooks	Create a webhook
PakatApiV3Sdk.WebhooksApi	deleteWebhook	DELETE /webhooks/{webhookId}	Delete a webhook
PakatApiV3Sdk.WebhooksApi	getWebhook	GET /webhooks/{webhookId}	Get a webhook details
PakatApiV3Sdk.WebhooksApi	getWebhooks	GET /webhooks	Get all webhooks
PakatApiV3Sdk.WebhooksApi	updateWebhook	PUT /webhooks/{webhookId}	Update a webhook

Documentation for Models

Documentation for Authorization

api-key

Type: API key
API key parameter name: api-key
Location: HTTP header

partner-key

Type: API key
API key parameter name: partner-key
Location: HTTP header

superagent

@infinitebrahmanuniverse/nolb-pak @everything-registry/sub-chunk-2404 strapi-provider-email-pakat

4 years ago

4 years ago

4 years ago

4 years ago