Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://github.com/DripEmail/drip-nodejs below:

DripEmail/drip-nodejs: The complete Nodejs wrapper for the Drip REST API

A complete Nodejs wrapper for the Drip REST API.

npm install drip-nodejs --save

Drip's documentation doesn't explicitly describe the required schema for each endpoint. In versions prior to 3 you would need to explicitly pass payloads with the required schema, which aren't obvious. In version 3 and later, I've attempted to make this a bit simpler. For example, batch endpoints will now only need you to pass an array of objects as:

payload = [
  {
    email: 'user@example.com',
    action: 'Purchased'
  },
  {
    email: 'user@example.com',
    action: 'Purchased'
  }
]
// client.recordBatchEvents(payload, ...)

Prior to v3 changes you would need to do something like the following where the entire payload structure is defined:

payload = {
  batches: [
    {
      events: [
        {
          email: 'user@example.com',
          action: 'Purchased'
        },
        {
          email: 'user@example.com',
          action: 'Purchased'
        }
      ]
    }
  ]
}
// client.recordBatchEvents(payload, ...)

This should help to get up and running simpler without much knowledge of the required schema. However, existing users will need to take special note of these changes.

For private use and integrations, use your API Token found here. Create a new instance of the client library with:

const client = require('drip-nodejs')({ token: YOUR_API_KEY, accountId: YOUR_ACCOUNT_ID });

For public integrations with an OAuth2 application registered with Drip, you'll need to specify the type of token you're passing (e.g. "Bearer"):

const client = require('drip-nodejs')({ token: YOUR_ACCESS_TOKEN, tokenType: TOKEN_TYPE, accountId: YOUR_ACCOUNT_ID });

You'll need your Drip Account ID when requiring the client which can be found here in your Drip account.

The following methods are currently available on the client instance. You can find a detailed explanation of all methods and their effect on resources in your Drip account here.

Note: All methods except updateBatchSubscribers return promises and support an optional asynchronous callback. The batch subscribers method only supports callbacks for now.

Note: The beta purchases endpoint has been deprecated and its methods have been removed from the package except createPurchase, which now sends requests to the Order creation endpoint here.

See the official REST API docs for a complete API reference.

The listSubscribers accepts an optional object of filter arguments. Refer to Drip's API docs for all the available filters.

/**
 * Using a promise
 */

const options = {
  status: "unsubscribed",
  page: 2
  // or with more options
};

client.listSubscribers(options)
  .then((response) => {
    // do something with the raw response object or with `response.data`
  })
  .catch((error) => {
    // do something with the error
  });

/**
 * Using a callback
 */

client.listSubscribers(options, (error, response, data) => {
  // do someting with the response or handle errors
});

The updateBatchSubscribers method takes a batch object for the payload and is most suitable for sending thousands of subscriber updates.

Because Drip's batch APIs support a maximum of 1000 records, this method breaks the payload into N "batches" and calls the API N times. The callback is invoked only after all batches' API calls have returned, and receives N-sized arrays for values (i.e. errors, responses, and bodies).

It is the responsibility of the caller to interpret these values and handle any errors.

var batch = {
  "batches": [{
    "subscribers": [
      {
        "email": "john@acme.com",
        "tags": "Dog Person"
      },
      {
        "email": "joe@acme.com",
        "tags": "Cat Person"
      }
      // Lots more subscribers...
    ]
  }]
}

client.updateBatchSubscribers(batch, (errors, responses, bodies) => {
    if (errors) {
      console.error('Some requests failed:', errors);
    } else {
      console.log('All requests succeeded');
    }
    console.log('Responses:', responses);
    console.log('Bodies:', bodies);
  });

The recordBatchEvents methods takes a batch object for the payload and is most suitable for sending thousands of events. Note that the batch events method will not break up the payload into nice chunks like the subscribers batch method. This will be handled in a future update.

var batch = {
  "batches": [{
    "events": [
      {
        "email": "john@acme.com",
        "action": "Opened a door"
      },
      {
        "email": "joe@acme.com",
        "action": "Closed a door"
      }
      // Lots more events...
    ]
  }]
}

client.recordBatchEvents(batch, function (error, response, data) {
  // Do stuff
  }
)

• Security update for axios CVE-2024-39338

• Bug fix in updateBatchSubscribers

Breaking Changes:

• Updated HTTP Client: We have switched to a Axios client to improve performance and reliability.

• Property Name Change: The body property in responses has been renamed to data to ensure compatibility with the new client and align with modern conventions.

  • Old: response.body
  • New: response.data

Please update your code accordingly. Example update:

// Old usage
const result = response.body;

// New usage
const result = response.data;

// EXAMPLE
const client = require('drip-nodejs')({ token: YOUR_API_KEY, accountId: YOUR_ACCOUNT_ID });
const payload = {
  email: "john@acme.com",
  time_zone: "America/Los_Angeles",
  custom_fields: {
    shirt_size: "Medium"
  }
};

client.createUpdateSubscriber(payload)
  .then((response) => {
    console.log(response.data)
  })
  .catch((error) => {
    // Handle errors
  });

1. Fork it ( https://github.com/samudary/drip-nodejs/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Note: Jasmine is used for testing

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4