Skip to content

Latest commit

 

History

History
224 lines (180 loc) · 6.45 KB

README.md

File metadata and controls

224 lines (180 loc) · 6.45 KB
Raw

Mercoa Go Library

The Mercoa Go library provides convenient access to the Mercoa API from Go.

Requirements

This module requires Go version >= 1.13.

Installation

Run the following command to use the Mercoa Go library in your module:

go get github.com/mercoa-finance/go

Usage

import (
  mercoa "github.com/mercoa-finance/go"
  mercoaclient "github.com/mercoa-finance/go/client"
  "github.com/mercoa-finance/go/option"
)

client := mercoaclient.NewClient(
  option.WithToken("<YOUR_API_KEY>"),
)

response, err := client.Fees.Calculate(
  context.TODO(),
  &mercoa.CalculateFeesRequest{
    Amount:               42.0,
    PaymentSourceID:      "pm_c0f9f5e8-516b-4516-9185-0a2c67ed1fe5",
    PaymentDestinationID: "pm_12121928-47a0-488b-9357-70e1fded0568",

  },
)

Optionals

This library models optional primitives and enum types as pointers. This is primarily meant to distinguish default zero values from explicit values (e.g. false for bool and "" for string). A collection of helper functions are provided to easily map a primitive or enum to its pointer-equivalent (e.g. mercoa.Int).

For example, consider the client.Entity.Find endpoint usage below:

response, err := client.Entity.Find(
  context.TODO(),
  &entity.FindEntities{
    IsCustomer: mercoa.Bool(true),
    Limit:      mercoa.Int(100),
    Status: []*mercoa.EntityStatus{
      mercoa.EntityStatusVerified.Ptr(),
    },
  },
)

Timeouts

Setting a timeout for each individual request is as simple as using the standard context library. Setting a one second timeout for an individual API call looks like the following:

ctx, cancel := context.WithTimeout(context.TODO(), time.Second)
defer cancel()

response, err := client.Fees.Calculate(
  ctx,
  &mercoa.CalculateFeesRequest{
    Amount:               42.0,
    PaymentSourceID:      "pm_c0f9f5e8-516b-4516-9185-0a2c67ed1fe5",
    PaymentDestinationID: "pm_12121928-47a0-488b-9357-70e1fded0568",

  },
)

Request Options

A variety of request options are included to adapt the behavior of the library, which includes configuring authorization tokens, or providing your own instrumented *http.Client. Both of these options are shown below:

client := mercoaclient.NewClient(
  option.WithToken("<YOUR_API_KEY>"),
  option.WithHTTPClient(
    &http.Client{
      Timeout: 5 * time.Second,
    },
  ),
)

These request options can either be specified on the client so that they're applied on every request (shown above), or for an individual request like so:

response, err := client.Fees.Calculate(
  ctx,
  &mercoa.CalculateFeesRequest{
    Amount:               42.0,
    PaymentSourceID:      "pm_c0f9f5e8-516b-4516-9185-0a2c67ed1fe5",
    PaymentDestinationID: "pm_12121928-47a0-488b-9357-70e1fded0568",
  },
  option.WithToken("<YOUR_API_KEY>"),
)

Providing your own *http.Client is recommended. Otherwise, the http.DefaultClient will be used, and your client will wait indefinitely for a response (unless the per-request, context-based timeout is used).

Automatic Retries

The Mercoa Go client is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retriable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

A request is deemed retriable when any of the following HTTP status codes is returned:

  • 408 (Timeout)
  • 409 (Conflict)
  • 429 (Too Many Requests)
  • 5XX (Internal Server Errors)

You can use the option.WithMaxAttempts option to configure the maximum retry limit to your liking. For example, if you want to disable retries for the client entirely, you can set this value to 1 like so:

client := mercoaclient.NewClient(
  option.WithMaxAttempts(1),
)

This can be done for an individual request, too:

response, err := client.Fees.Calculate(
  ctx,
  &mercoa.CalculateFeesRequest{
    Amount:               42.0,
    PaymentSourceID:      "pm_c0f9f5e8-516b-4516-9185-0a2c67ed1fe5",
    PaymentDestinationID: "pm_12121928-47a0-488b-9357-70e1fded0568",
  },
  option.WithMaxAttempts(1),
)

Errors

Structured error types are returned from API calls that return non-success status codes. For example, you can check if the error was due to a bad request (i.e. status code 400) with the following:

response, err := client.Fees.Calculate(
  ctx,
  &mercoa.CalculateFeesRequest{
    Amount:               42.0,
    PaymentSourceID:      "pm_c0f9f5e8-516b-4516-9185-0a2c67ed1fe5",
    PaymentDestinationID: "pm_12121928-47a0-488b-9357-70e1fded0568",
  },
)
if err != nil {
  if notFoundErr, ok := err.(*mercoa.NotFound);
    // Do something with the not found error ...
  }
  return err
}

These errors are also compatible with the errors.Is and errors.As APIs, so you can access the error like so:

response, err := client.Fees.Calculate(
  ctx,
  &mercoa.CalculateFeesRequest{
    Amount:               42.0,
    PaymentSourceID:      "pm_c0f9f5e8-516b-4516-9185-0a2c67ed1fe5",
    PaymentDestinationID: "pm_12121928-47a0-488b-9357-70e1fded0568",
  },
)
if err != nil {
  var notFoundErr *mercoa.NotFound
  if errors.As(err, notFoundErr) {
    // Do something with the not found error ...
  }
  return err
}

If you'd like to wrap the errors with additional information and still retain the ability to access the type with errors.Is and errors.As, you can use the %w directive:

response, err := client.Fees.Calculate(
  ctx,
  &mercoa.CalculateFeesRequest{
    Amount:               42.0,
    PaymentSourceID:      "pm_c0f9f5e8-516b-4516-9185-0a2c67ed1fe5",
    PaymentDestinationID: "pm_12121928-47a0-488b-9357-70e1fded0568",
  },
)
if err != nil {
  return fmt.Errorf("failed to calculate fees: %w", err)
}

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README.md are always very welcome!