branch

Documentation

Index

• Constants
• type Client
  • func NewClient(cfg *Config) (*Client, error)
  • func NewClientFromEnvVariables() (*Client, error)
  • func (c *Client) CreateDynamicLink(apiKey string, config *types.LinkConfig) (string, error)
• type Config
  • func NewConfig(apiKey string) *Config
  • func NewConfigFromEnvVariables() (*Config, error)
• type CreateLinkConfig
  • func NewCreateLinkConfig(linkConfig *types.LinkConfig) CreateLinkConfig
  • func (c CreateLinkConfig) MarshalJSON() ([]byte, error)

Constants

const (
	APIEndpoint = "https://api2.branch.io/v1/url"

	EnvBranchKey = "BRANCH_KEY"
)

Types

type Client

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

Client represents a client that allows to interact with Branch.io APIs

func NewClient

func NewClient(cfg *Config) (*Client, error)

NewClient allows to build a new Client instance

func NewClientFromEnvVariables

func NewClientFromEnvVariables() (*Client, error)

NewClientFromEnvVariables allows to build a new Client instance from the environment variables

func (*Client) CreateDynamicLink

func (c *Client) CreateDynamicLink(apiKey string, config *types.LinkConfig) (string, error)

CreateDynamicLink allows to create a new dynamic link using the given link and request configurations

type Config

type Config struct {
	ApiKey string
}

Config contains the data used to build a new Client instance

func NewConfig

func NewConfig(apiKey string) *Config

NewConfig allows to build a new Config instance

func NewConfigFromEnvVariables

func NewConfigFromEnvVariables() (*Config, error)

NewConfigFromEnvVariables allows to build a new Config instance from the environment variables

type CreateLinkConfig

type CreateLinkConfig struct {
	*types.LinkConfig
}

func NewCreateLinkConfig

func NewCreateLinkConfig(linkConfig *types.LinkConfig) CreateLinkConfig

func (CreateLinkConfig) MarshalJSON

func (c CreateLinkConfig) MarshalJSON() ([]byte, error)