opdgo

README

opdgo

Golang client for OpenPanel.dev

Usage

Local client

package main

import (
    "log"
	
    "github.com/onrik/opdgo"
)

func main() {
    client := opdgo.New("<client_id>", "<client_secret>", nil)

    client.Track("purchase_completed", {
        "product_id": "123",
        "price": 99.99,
        "currency": "USD"
    })
}

Global client

package main

import (
    "log"
	
    "github.com/onrik/opdgo"
)

func main() {
    opdgo.Init(
        opdgo.New("<client_id>", "<client_secret>", nil),
    )

    opdgo.Track("purchase_completed", {
        "product_id": "123",
        "price": 99.99,
        "currency": "USD"
    })
}

Documentation

Index

• func Init(client *Client)
• func Track(action string, properties map[string]any)
• type Client
  • func Global() *Client
  • func New(clientID, clientSecret string, options Options) *Client
  • func (c *Client) ClearGlobal()
  • func (c *Client) SetGlobal(properties map[string]any)
  • func (c *Client) Track(action string, properties map[string]any)
• type Logger
• type Options
• type Payload
  • func (p *Payload) Add(properties map[string]any)
• type Request

Functions

func Init

func Init(client *Client)

func Track

func Track(action string, properties map[string]any)

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func Global

func Global() *Client

func New

func New(clientID, clientSecret string, options Options) *Client

func (*Client) ClearGlobal

func (c *Client) ClearGlobal()

func (*Client) SetGlobal

func (c *Client) SetGlobal(properties map[string]any)

func (*Client) Track

func (c *Client) Track(action string, properties map[string]any)

type Logger

type Logger interface {
	Error(msg string, args ...any)
	Debug(msg string, args ...any)
}

type Options

type Options struct {
	Logger     Logger
	ApiURL     string
	HttpClient *http.Client
	Debug      bool
}

type Payload

type Payload struct {
	Name       string         `json:"name"`
	ProfileID  string         `json:"profile_id,omitempty"`
	Properties map[string]any `json:"properties"`
}

func (*Payload) Add

func (p *Payload) Add(properties map[string]any)

type Request

type Request struct {
	Type    string  `json:"type,omitempty"`
	Payload Payload `json:"payload,omitempty"`
}