Giter VIP home page Giter VIP logo

go-mixmax's Introduction

Go Mixmax

GoDoc Go project version Go Report Card

Summary

A golang Mixmax client library.

Installation

go get github.com/ghmeier/go-mixmax

Documentation

Check out the Mixmax API documentation for an exhaustive list of examples and explanations.

View the GoDoc for implementation details on go-mixmax

Here are some simple examples:

Contacts

mixmax := mixmax.New(apiKey)
params := &models.ContactParams{
    Email: "[email protected]",
    Name:  "test",
}

err := mixmax.Contacts.New(params)

Send

mixmax := mixmax.New(apiKey)
params := &models.Send{
    To:      []*Recipient{&Recipient{Email: "[email protected]"}},
    From:    "[email protected]",
    Subject: "Welcome to the Mixmax API",
    HTML:    "The body of the email",
}

err := mixmax.Send.New(params)

Usage

Each major API resource is contained under the main mixmax client, so usage requires initializing the mixmax client with your Mixmax API Token and importing models that will be used to send requests. This example uses the Contact resource, but other resources follow the same pattern:

import (
    "github.com/ghmeier/go-mixmax"
    mixmodels "github.com/ghmeier/go-mixmax/models"
)

mm := mixmax.New(MIXMAX_API_TOKEN)

err := mm.Contact.New(mixmodels.ContactParams)

contacts, err := mm.Contact.List()

Development

Go Mixmax is still in early development with changes likely to come. If you spot problems or missing functionality open an issue or submit a pull request.

Note: The /insightsreport resource is not yet implemented

go-mixmax's People

Contributors

ghmeier avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

aanandh-c ttacon

go-mixmax's Issues

Add support for `shared`

Some objects have shared keys with objects that describe how an object can be shared between users.

go-mixmax should support this object in the multiple endpoints that use it.

Add support for expand parameter

As in the documentation here. expand has some functionality that isn't supported in the current version for handling expanded user params and counts.

POST /snippet/:id/send response unknown

The API documentation does not provide a response format, so we'll need to test the endpoint with valid snippets and requests to determine what the response type is.

Add Search Support

Currently, list endpoints that allow search don't support any search queries, we should add support for querying.

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.