square

README

Square Go SDK

Tags

go square

Installation

go install github.com/KoeInoue/square-go-sdk

or

import the package in a file where you want to use the package

import "github.com/KoeInoue/square-go-sdk"

then run

go mod tidy

Minimal Example

1. Set environment variables

export SQUARE_ACCESS_TOKEN=yourSandboxAccessToken
export ENV=dev

※ ENV is a variable that just identifies the environment

1. Write code

package main

import (
    "os"

    "github.com/KoeInoue/square-go-sdk"
    "github.com/KoeInoue/square-go-sdk/http"
    "github.com/KoeInoue/square-go-sdk/models"
)

func main() {
    client := getClient()
    client.CustomerApi.CreateCustomer()
}

func getClient() *http.Client {
    envType := os.Getenv("ENV")
    accessToken := os.Getenv("SQUARE_ACCESS_TOKEN")

    if envType != "production" {
        return http.NewClient(square.Config[square.Sandbox]{
            AccessToken: accessToken,
            Environment: square.Environments.Sandbox,
        })
    } else {
        return http.NewClient(square.Config[square.Production]{
            AccessToken: accessToken,
            Environment: square.Environments.Production,
        })
    }
}

SDK Reference

Payments

• Cards

Subscriptions

• Subscriptions

Item

• Catalog

Customers

• Customers

Contributors

• Koe Inoue

Documentation

Index

• Constants
• Variables
• type Config
• type Env
• type Production
• type Sandbox

Constants

const (
	ENV_SANDBOX    = Sandbox("https://connect.squareupsandbox.com")
	ENV_PRODUCTION = Production("https://connect.squareup.com")
)

Variables

var Environments = struct {
	Sandbox    Sandbox
	Production Production
}{
	Sandbox:    ENV_SANDBOX,
	Production: ENV_PRODUCTION,
}

Environment has part of the domain that varies with the environment.

Types

type Config

type Config[T Env] struct {
	AccessToken string
	Environment T
}

Config struct contains access token and environment

type Env

type Env interface {
	Sandbox | Production
}

Environment has part of the domain that varies with the environment.

type Production

type Production string

type Sandbox

type Sandbox string