ghost-payments

    1.0.0 • Public • Published

    Ghost Analytics node.js client

    Installation

    npm install ghost-analytics-client

    Documentation

    Documentation is not yet available.

    API Overview

    Every resource is accessed via your ghost-analytics-client instance:

    const GhostAnalytics = require('ghost-analytics-client')({ publicKey: ' your public key ', secretKey: ' your secret key ' });
    // GhostAnalytics.{ RESOURCE_NAME }.{ METHOD_NAME }

    Every resource method returns a promise (bluebird):

    GhostAnalytics.customer.create({ email: 'customer@example.com' })
    .then(customer => { //...do stuff })
    .catch(err => { //...handle error });

    Notes

    Where you see params it is a plain JavaScript object, e.g. { email: 'foo@example.com' } For requests that return a single item, the item will be contained inside of the doc property in the response body. For requests that return multiple items, the items will be contained inside of the docs property in the response body. For requests that delete an item, the response body will contain { success: true }.

    [Account]

    Endpoint Description
    [GET /api/v1/accounts/{accountId}] Get an account

    GET /api/v1/accounts/{accountId}

    Returns an account object.

    Example Request

    GhostAnalytics.account.get({ accountId: 1 })
    .then(account => { //...do stuff })
    .catch(err => { //...handle error });

    Example Response

    {
      "doc": {
        // the account object
      }
    }

    [Charge]

    Endpoint Description
    [POST /api/v1/charges] Create a charge

    POST /api/v1/charges

    Creates and returns a charge object.

    Example Request

    GhostAnalytics.charge.create({ 
      amount: 1000, // in cents
      cardId: card_somecardid,
      customerId: customer_somecustomerid,
      description: 'some charge description',
    })
    .then(charge => { //...do stuff })
    .catch(err => { //...handle error });

    Example Response

    {
      "doc": {
        // the charge object
      }
    }

    [CustomerCard]

    Endpoint Description
    [GET /api/v1/customers/{customerId}/cards/{cardId}] Get a customer card
    [POST /api/v1/customers//{customerId}] Create a customer card
    [DELETE /api/v1/customers/{customerId}/cards/{cardId}] Delete a customer card

    GET /api/v1/customers/{customerId}/cards/{cardId}

    Returns a customer card object.

    Example Request

    GhostAnalytics.customerCard.get({ 
      cardId: card_somecardid,
      customerId: customer_somecustomerid
    })
    .then(card => { //...do stuff })
    .catch(err => { //...handle error });

    Example Response

    {
      "doc": {
        // the card object
      }
    }

    POST /api/v1/customers/{customerId}/cards

    Creates and returns a customer card object.

    Example Request

    GhostAnalytics.customerCard.get({
      number: 4242424242424242,
      expMonth: '02',
      expYear: '2018',
      cvc: 123
      customerId: customer_somecustomerid
    })
    .then(card => { //...do stuff })
    .catch(err => { //...handle error });

    Example Response

    {
      "doc": {
        // the card object
      }
    }

    DELETE /api/v1/customers/{customerId}/cards/{cardId}

    Deletes a customer card object.

    Example Request

    GhostAnalytics.customerCard.delete({
      cardId: card_somecardid
      customerId: customer_somecustomerid
    })
    .then(success => { //...do stuff })
    .catch(err => { //...handle error });

    Example Response

    {
      "success": true
    }

    [Customer]

    Endpoint Description
    [GET /api/v1/customers/:customerId] Get a customer
    [POST /api/v1/customers] Create a customer
    [PUT /api/v1/customers/:customerId] Update a customer
    [DELETE /api/v1/customers/:customerId] Delete a customer

    GET /api/v1/customers/{customerId}

    Returns a customer card object.

    Example Request

    GhostAnalytics.customer.get({ 
      customerId: customer_somecustomerid
    })
    .then(customer => { //...do stuff })
    .catch(err => { //...handle error });

    Example Response

    {
      "doc": {
        // the customer object
      }
    }

    POST /api/v1/customers

    Creates and returns a customer card object.

    Example Request

    GhostAnalytics.customerCard.get({
      description: 'some customer description'
    })
    .then(customer => { //...do stuff })
    .catch(err => { //...handle error });

    Example Response

    {
      "doc": {
        // the customer object
      }
    }

    PUT /api/v1/customers/{customerId}

    Updates and returns a customer card object.

    Example Request

    GhostAnalytics.customerCard.update({
      customerId: customer_somecustomerid,
      description: 'some new customer description'
    })
    .then(customer => { //...do stuff })
    .catch(err => { //...handle error });

    Example Response

    {
      "doc": {
        // the customer object
      }
    }

    DELETE /api/v1/customers/{customerId}

    Deletes a customer object.

    Example Request

    GhostAnalytics.customer.delete({
      customerId: customer_somecustomerid
    })
    .then(success => { //...do stuff })
    .catch(err => { //...handle error });

    Example Response

    {
      "success": true
    }

    Errors

    All error responses are in the following format, delivered with the corresponding status code:

    {
        "message":"Invalid id",
        "status":400,
        "error":"Bad Request"
    }

    Keywords

    none

    Install

    npm i ghost-payments

    DownloadsWeekly Downloads

    1

    Version

    1.0.0

    License

    ISC

    Last publish

    Collaborators

    • njgerner