npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

cakemail_api

v1.9.4

Published

The_Cakemail_API_exposes_multiple_APIs_including_Authentication_Marketing_Contact_Transactional_Analytic_Content_Account_and_Partner_

Downloads

3

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

joemingnajoemingna

Keywords

Readme

cakemail_api

CakemailApi - JavaScript client for cakemail_api The Cakemail API exposes multiple APIs including Authentication, Marketing, Contact, Transactional, Analytic, Content, Account and Partner. This SDK is automatically generated by the OpenAPI Generator project:

  • API version: stagingrelease-1.9.4.6
  • Package version: stagingrelease-1.9.4.6
  • Build package: org.openapitools.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 cakemail_api --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 cakemail_api 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/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --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 CakemailApi = require('cakemail_api');

var defaultClient = CakemailApi.ApiClient.instance;
// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
var OAuth2PasswordBearer = defaultClient.authentications['OAuth2PasswordBearer'];
OAuth2PasswordBearer.accessToken = "YOUR ACCESS TOKEN"

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

Documentation for API Endpoints

All URIs are relative to https://api-gateway.staging.ovh.cakemail.io

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- CakemailApi.AccountApi | getSelfAccount | GET /accounts/self | Show my account details CakemailApi.AccountApi | patchSelfAccount | PATCH /accounts/self | Update my account CakemailApi.ActionApi | createAction | POST /workflows/{workflow_id}/actions | Create an action CakemailApi.ActionApi | deleteAction | DELETE /workflows/{workflow_id}/actions/{action_id} | Delete an action CakemailApi.ActionApi | getAction | GET /workflows/{workflow_id}/actions/{action_id} | Get an action CakemailApi.ActionApi | listActionLinks | GET /workflows/{workflow_id}/actions/{action_id}/links | Show action links CakemailApi.ActionApi | listActions | GET /workflows/{workflow_id}/actions | List actions CakemailApi.ActionApi | patchAction | PATCH /workflows/{workflow_id}/actions/{action_id} | Update an action CakemailApi.ActionApi | renderAction | GET /workflows/{workflow_id}/actions/{action_id}/render | Render an action CakemailApi.ActionApi | sendTestAction | POST /workflows/{workflow_id}/actions/{action_id}/send-test | Send a test of an action CakemailApi.CampaignApi | archiveCampaign | POST /campaigns/{campaign_id}/archive | Archive a campaign CakemailApi.CampaignApi | cancelCampaign | POST /campaigns/{campaign_id}/cancel | Cancel a campaign CakemailApi.CampaignApi | createCampaign | POST /campaigns | Create a campaign CakemailApi.CampaignApi | deleteCampaign | DELETE /campaigns/{campaign_id} | Delete a campaign CakemailApi.CampaignApi | getCampaign | GET /campaigns/{campaign_id} | Show a campaign details CakemailApi.CampaignApi | listCampaigns | GET /campaigns | Show all campaigns CakemailApi.CampaignApi | listLinks | GET /campaigns/{campaign_id}/links | Show a campaign links CakemailApi.CampaignApi | patchCampaign | PATCH /campaigns/{campaign_id} | Update a campaign CakemailApi.CampaignApi | renderCampaign | GET /campaigns/{campaign_id}/render | Render a campaign CakemailApi.CampaignApi | rescheduleCampaign | POST /campaigns/{campaign_id}/reschedule | Reschedule a campaign CakemailApi.CampaignApi | resumeCampaign | POST /campaigns/{campaign_id}/resume | Resume a campaign CakemailApi.CampaignApi | scheduleCampaign | POST /campaigns/{campaign_id}/schedule | Schedule a campaign CakemailApi.CampaignApi | sendTestEmail | POST /campaigns/{campaign_id}/send-test | Send a test email CakemailApi.CampaignApi | suspendCampaign | POST /campaigns/{campaign_id}/suspend | Suspend a campaign CakemailApi.CampaignApi | unarchiveCampaign | POST /campaigns/{campaign_id}/unarchive | Unarchive a campaign CakemailApi.CampaignApi | unscheduleCampaign | POST /campaigns/{campaign_id}/unschedule | Unschedule a campaign CakemailApi.CampaignBlueprintApi | getCampaignBlueprint | GET /campaign-blueprints/{blueprint_id} | Get a campaign blueprint CakemailApi.CampaignBlueprintApi | listCampaignBlueprints | GET /campaign-blueprints | Show all campaign blueprints CakemailApi.CampaignBlueprintApi | renderCampaignBlueprint | GET /campaign-blueprints/{blueprint_id}/render | Render campaign blueprint CakemailApi.ContactApi | createContact | POST /lists/{list_id}/contacts | Add a contact to a list CakemailApi.ContactApi | deleteContact | DELETE /lists/{list_id}/contacts/{contact_id} | Delete a contact CakemailApi.ContactApi | getContact | GET /lists/{list_id}/contacts/{contact_id} | Show a contact details CakemailApi.ContactApi | importContacts | POST /lists/{list_id}/import-contacts | Import contacts CakemailApi.ContactApi | listContactsOfList | GET /lists/{list_id}/contacts | Show all contacts in a list CakemailApi.ContactApi | listContactsOfSegment | GET /lists/{list_id}/segments/{segment_id}/contacts | Show all contacts in a segment CakemailApi.ContactApi | patchContact | PATCH /lists/{list_id}/contacts/{contact_id} | Update a contact CakemailApi.ContactApi | unsubscribeContact | POST /lists/{list_id}/contacts/{contact_id}/unsubscribe | Unsubscribe a contact from a list CakemailApi.CustomAttributeApi | createCustomAttribute | POST /lists/{list_id}/custom-attributes | Create a custom attribute CakemailApi.CustomAttributeApi | deleteCustomAttribute | DELETE /lists/{list_id}/custom-attributes/{name} | Delete a custom attribute CakemailApi.CustomAttributeApi | getCustomAttribute | GET /lists/{list_id}/custom-attributes/{name} | Show a custom attribute CakemailApi.CustomAttributeApi | listCustomAttributes | GET /lists/{list_id}/custom-attributes | Show all custom attributes CakemailApi.DomainApi | patchDomains | PATCH /brands/default/domains/default | Change domains CakemailApi.DomainApi | showDomains | GET /brands/default/domains/default | Show domains CakemailApi.DomainApi | validateDomains | GET /brands/default/domains/default/validate | Validate domains CakemailApi.FormApi | createForm | POST /forms | Create a form CakemailApi.FormApi | deleteForm | DELETE /forms/{form_id} | Delete a form CakemailApi.FormApi | getForm | GET /forms/{form_id} | Show a form details CakemailApi.FormApi | listForms | GET /forms | Show all forms CakemailApi.FormApi | patchForm | PATCH /forms/{form_id} | Update a form CakemailApi.LinksApi | getLink | GET /links/{link_id} | Show a link information CakemailApi.ListApi | acceptListPolicy | POST /lists/{list_id}/accept-policy | Accept policy for a list CakemailApi.ListApi | archiveList | POST /lists/{list_id}/archive | Archive a list CakemailApi.ListApi | createList | POST /lists | Create a List CakemailApi.ListApi | deleteList | DELETE /lists/{list_id} | Delete a List CakemailApi.ListApi | getList | GET /lists/{list_id} | Show a list parameters CakemailApi.ListApi | listLists | GET /lists | Show all lists CakemailApi.ListApi | patchList | PATCH /lists/{list_id} | Update a list parameters CakemailApi.ListApi | unarchiveList | POST /lists/{list_id}/unarchive | Unarchive a list CakemailApi.LogApi | getActionLogs | GET /logs/workflows/{workflow_id}/actions/{action_id} | Show action logs CakemailApi.LogApi | getCampaignLogs | GET /logs/campaigns/{campaign_id} | Show campaign logs CakemailApi.LogApi | getEmailLogs | GET /logs/emails | Show transactional email logs CakemailApi.LogApi | getListLogs | GET /logs/lists/{list_id} | Show list logs CakemailApi.LogoApi | uploadDefaultLogo | PUT /brands/default/logos/default | Upload a default logo CakemailApi.ReportApi | getAccountStats | GET /reports/accounts/{account_id} | Show an account report CakemailApi.ReportApi | getActionStats | GET /reports/workflows/{workflow_id}/actions/{action_id} | Show action report CakemailApi.ReportApi | getCampaignLinksStats | GET /reports/campaigns/{campaign_id}/links | Show campaign links report CakemailApi.ReportApi | getCampaignStats | GET /reports/campaigns/{campaign_id} | Show campaign report CakemailApi.ReportApi | getEmailsStats | GET /reports/emails | Show transactional email report CakemailApi.ReportApi | getListStats | GET /reports/lists/{list_id} | Show list report CakemailApi.ReportApi | getSelfAccountStats | GET /reports/accounts/self | Show my account report CakemailApi.SegmentApi | createSegment | POST /lists/{list_id}/segments | Create a segment CakemailApi.SegmentApi | deleteSegment | DELETE /lists/{list_id}/segments/{segment_id} | Delete a segment CakemailApi.SegmentApi | getSegment | GET /lists/{list_id}/segments/{segment_id} | Show a segment details CakemailApi.SegmentApi | listSegments | GET /lists/{list_id}/segments | Show all segments CakemailApi.SegmentApi | patchSegment | PATCH /lists/{list_id}/segments/{segment_id} | Update a segment CakemailApi.SenderApi | confirmSender | POST /brands/default/senders/confirm-email | Confirm a sender CakemailApi.SenderApi | createSender | POST /brands/default/senders | Add a sender CakemailApi.SenderApi | deleteSender | DELETE /brands/default/senders/{sender_id} | Delete a sender CakemailApi.SenderApi | getSender | GET /brands/default/senders/{sender_id} | Show a sender details CakemailApi.SenderApi | listSenders | GET /brands/default/senders | Show all senders CakemailApi.SenderApi | patchSender | PATCH /brands/default/senders/{sender_id} | Update a sender CakemailApi.SenderApi | resendConfirmationEmail | POST /brands/default/senders/{sender_id}/resend-confirmation-email | Resend confirmation email CakemailApi.SubAccountApi | confirmAccount | POST /accounts/{account_id}/confirm | Confirm sub-account creation CakemailApi.SubAccountApi | createAccount | POST /accounts | Create a sub-account CakemailApi.SubAccountApi | deleteAccount | DELETE /accounts/{account_id} | Delete a sub-account CakemailApi.SubAccountApi | getAccount | GET /accounts/{account_id} | Show a sub-account details CakemailApi.SubAccountApi | listAccounts | GET /accounts | Show all sub-accounts CakemailApi.SubAccountApi | patchAccount | PATCH /accounts/{account_id} | Update a sub-account CakemailApi.SubAccountApi | resendAccountVerification | POST /accounts/resend-verification-email | Resend the account verification email CakemailApi.SubAccountApi | suspendAccount | POST /accounts/{account_id}/suspend | Suspend a sub-account CakemailApi.SubAccountApi | unsuspendAccount | POST /accounts/{account_id}/unsuspend | Unsuspend a sub-account CakemailApi.SuppressedEmailApi | createSuppressedEmail | POST /suppressed-emails | Add a suppressed email CakemailApi.SuppressedEmailApi | deleteSuppressedEmail | DELETE /suppressed-emails/{email} | Delete a suppressed email CakemailApi.SuppressedEmailApi | listSuppressedEmails | GET /suppressed-emails | Show all suppressed emails CakemailApi.SystemEmailApi | patchSystemEmails | PATCH /brands/default/system-emails | Update system emails configuration CakemailApi.SystemEmailApi | setSystemEmails | PUT /brands/default/system-emails | Set system emails configuration CakemailApi.SystemEmailApi | showSystemEmails | GET /brands/default/system-emails | Show system emails configuration CakemailApi.TemplateApi | createTemplate | POST /templates | Create a template CakemailApi.TemplateApi | deleteTemplate | DELETE /templates/{template_id} | Delete a template CakemailApi.TemplateApi | getTemplate | GET /templates/{template_id} | Get a template CakemailApi.TemplateApi | listTemplates | GET /templates | Show all templates CakemailApi.TemplateApi | patchTemplate | PATCH /templates/{template_id} | Update a template CakemailApi.TemplateApi | renderTemplate | GET /templates/{template_id}/render | Render a template CakemailApi.TokenApi | createToken | POST /token | Create a token CakemailApi.TokenApi | refreshToken | PUT /token | Refresh a token CakemailApi.TransactionalEmailApi | sendEmail | POST /emails | Send a transactional email CakemailApi.UserApi | confirmUser | POST /users/{user_id}/confirm | Confirm a user CakemailApi.UserApi | createUser | POST /users | Create a user CakemailApi.UserApi | deleteUser | DELETE /users/{user_id} | Delete a user CakemailApi.UserApi | forgotMyPassword | POST /users/forgot-my-password | Forgot my password CakemailApi.UserApi | getSelfUser | GET /users/self | Show my user details CakemailApi.UserApi | getUser | GET /users/{user_id} | Show a user details CakemailApi.UserApi | listUsers | GET /users | Show all users in my account CakemailApi.UserApi | patchUser | PATCH /users/{user_id} | Update a user CakemailApi.UserApi | resendUserVerification | POST /users/{user_id}/resend-verification-email | Resend the user verification email CakemailApi.UserApi | resetPasswordConfirm | POST /users/reset-password-confirm | Reset password confirmation CakemailApi.UserApi | resetSelfPassword | POST /users/self/reset-password | Reset my password CakemailApi.UserApi | resetUserPassword | POST /users/{user_id}/reset-password | Reset a user password CakemailApi.UserApi | suspendUser | POST /users/{user_id}/suspend | Suspend a user CakemailApi.UserApi | unsuspendUser | POST /users/{user_id}/unsuspend | Unsuspend a user CakemailApi.WebhookApi | archiveWebhook | POST /webhooks/{webhook_id}/archive | Archive a webhook CakemailApi.WebhookApi | createWebhook | POST /webhooks | Create a webhook CakemailApi.WebhookApi | getWebhook | GET /webhooks/{webhook_id} | Show a webhook CakemailApi.WebhookApi | listWebhooks | GET /webhooks | List all webhooks CakemailApi.WebhookApi | patchWebhook | PATCH /webhooks/{webhook_id} | Patch a webhook CakemailApi.WebhookApi | unarchiveWebhook | POST /webhooks/{webhook_id}/unarchive | Unarchive a webhook CakemailApi.WorkflowApi | activateWorkflow | POST /workflows/{workflow_id}/activate | Activate a workflow CakemailApi.WorkflowApi | createWorkflow | POST /workflows | Create a workflow CakemailApi.WorkflowApi | deactivateWorkflow | POST /workflows/{workflow_id}/deactivate | Deactivate a workflow CakemailApi.WorkflowApi | deleteWorkflow | DELETE /workflows/{workflow_id} | Delete a workflow CakemailApi.WorkflowApi | getWorkflow | GET /workflows/{workflow_id} | Show a workflow CakemailApi.WorkflowApi | listWorkflows | GET /workflows | Show all workflows CakemailApi.WorkflowApi | lockWorkflow | POST /workflows/{workflow_id}/lock | Lock a workflow CakemailApi.WorkflowApi | patchWorkflow | PATCH /workflows/{workflow_id} | Update a workflow CakemailApi.WorkflowApi | unlockWorkflow | POST /workflows/{workflow_id}/unlock | Unlock a workflow CakemailApi.WorkflowBlueprintApi | getWorkflowBlueprint | GET /workflow-blueprints/{blueprint_id} | Show a workflow blueprint CakemailApi.WorkflowBlueprintApi | getWorkflowBlueprintAction | GET /workflow-blueprints/{blueprint_id}/actions/{action_id} | Show a workflow blueprint action CakemailApi.WorkflowBlueprintApi | listWorkflowBlueprintActions | GET /workflow-blueprints/{blueprint_id}/actions | Show workflow blueprint actions CakemailApi.WorkflowBlueprintApi | listWorkflowBlueprints | GET /workflow-blueprints | Show all workflow blueprints

Documentation for Models

Documentation for Authorization

OAuth2PasswordBearer

  • Type: OAuth
  • Flow: password
  • Authorization URL:
  • Scopes:
    • user: Grants read-write to customer endpoints
    • admin: Grants read-write to restricted endpoints
    • internal: Grants write access to internal endpoints