Code Monkey home page Code Monkey logo

mailerlite-ruby's Introduction

MailerLite API v1 Ruby wrapper

A Ruby gem which helps to communicate with MailerLite API.

Gem Version Coverage Status

Installation

Add this line to your application's Gemfile:

gem 'mailerlite'

Usage

Before making any request, you should authenticate first. Use the response object to make requests afterward. See create a campaign example.

Authentication

When you sign up for an account, you are given an API key. You authenticate to the MailerLite API by providing your API key in the request. You can find your API key in page: Integrations » Developer API.

client = MailerLite::Client.new(api_key: 'my-secret-api-key')

Example:

client.groups

Or create file under config/initializers/mailerlite.rb

MailerLite.configure do |config|
  config.api_key = 'my-secret-api-key'
  # config.timeout = 10
end

When you configured global settings in file, then you can request methods on MailerLite class directly.

Example:

MailerLite.campaigns

See more documentation in examples directory.

Supported Ruby Versions

This library aims to support and is tested against the following Ruby implementations:

  • Ruby 2.7.0
  • Ruby 3.0.0
  • Ruby 3.1.0
  • Ruby 3.2.0
  • Truffleruby

License

The gem is available as open source under the terms of the MIT License.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.