/paddlex

An Elixir wrapper for the paddle.com API

Primary LanguageElixirMIT LicenseMIT

Paddlex

An Elixir wrapper for the paddle.com API, inspired by paddle_pay and stripity_stripe

Hex.pm Hex.pm Hex.pm GitHub Workflow Status

Table of Contents

Installation

Add paddlex to your list of dependencies in mix.exs:

def deps do
  [
    {:paddlex, "~> 0.1.1"}
  ]
end

Usage

Configuration

Configure lib the credentials obtained from the Paddle Dashboard

# config/dev.exs
config :paddlex,
  environment: :sandbox
  vendor_id: "YOUR SANBOX VENDOR ID (as number)"
  vendor_auth_code: 'YOUR SANDBOX VENDOR AUTH CODE'

# config/prod.exs
config :paddlex,
  environment: :production
  vendor_id: "YOUR PRODUCTION VENDOR ID (as number)"
  vendor_auth_code: 'YOUR PRODUCTION VENDOR AUTH CODE'

Examples

For examples of usage, please see the HexDocs

Contributing

Feedback, feature requests, and fixes are welcomed and encouraged.

To ensure a commit passes CI you should run mix check

License

Paddlex is released under the MIT license. See the LICENSE.