api

package
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 20, 2026 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	PathCampaignTrigger           = "campaigns/trigger"
	PathCampaignActivateTriggered = "campaigns/activateTriggered"
	PathCampaignCreate            = "campaigns/create"
	PathCampaignAbort             = "campaigns/abort"
	PathCampaignCancel            = "campaigns/cancel"
	PathChildCampaigns            = "campaigns/recurring/{campaignId}/childCampaigns"
	PathCampaigns                 = "campaigns"
)
View Source 
var (
	PathCatalogs            = "catalogs"
	PathCatalogFieldMapping = "catalogs/{catalogName}/fieldMappings"
	PathCatalog             = "catalogs/{catalogName}"
	PathCatalogItem         = "catalogs/{catalogName}/items/{itemId}"
	PathCatalogItems        = "catalogs/{catalogName}/items"
)
View Source 
var (
	PathEventsTrack     = "events/track"
	PathEventsTrackBulk = "events/trackBulk"
	PathEventsByEmail   = "events/{email}"
	PathEventsByUserId  = "events/byUserId/{userId}"
)
View Source 
var (
	PathChannels = "channels"
)

Functions

This section is empty.

Types

type Campaigns 

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

Campaigns implements a set of /api/campaigns API methods, See: https://api.iterable.com/api/docs#campaigns_campaigns

func NewCampaignsApi 

func NewCampaignsApi(apiKey string, httpClient *http.Client, logger logger.Logger, limiter rate.Limiter) *Campaigns

func (*Campaigns) Abort 

func (c *Campaigns) Abort(campaignId int64) (*types.PostResponse, error)

func (*Campaigns) ActivateTriggered 

func (c *Campaigns) ActivateTriggered(campaignId int64) (*types.PostResponse, error)

func (*Campaigns) All 

func (c *Campaigns) All() ([]types.Campaign, error)

func (*Campaigns) Cancel 

func (c *Campaigns) Cancel(campaignId int64) (*types.PostResponse, error)

func (*Campaigns) ChildRecurringCampaigns 

func (c *Campaigns) ChildRecurringCampaigns(campaignId int64) ([]types.Campaign, error)

func (*Campaigns) Create 

func (c *Campaigns) Create(req types.CreateCampaignRequest) (int64, error)

func (*Campaigns) Trigger 

func (c *Campaigns) Trigger(req types.TriggerCampaignRequest) (*types.PostResponse, error)

type Catalog 

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

Catalog implements a set of /api/catalogs API methods, See: https://api.iterable.com/api/docs#catalogs_listCatalogs

func NewCatalogApi 

func NewCatalogApi(apiKey string, httpClient *http.Client, logger logger.Logger, limiter rate.Limiter) *Catalog

func (*Catalog) All 

func (c *Catalog) All() (*types.Catalogs, error)

func (*Catalog) FieldMapping 

func (c *Catalog) FieldMapping(catalogName string) (*types.CatalogFieldMapping, error)

type Channels 

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

Channels implements a set of /api/channels API methods, See: https://api.iterable.com/api/docs#channels_channels

func NewChannelsApi 

func NewChannelsApi(apiKey string, httpClient *http.Client, logger logger.Logger, limiter rate.Limiter) *Channels

func (*Channels) Channels 

func (c *Channels) Channels() ([]types.Channel, error)

type Events 

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

Events implements a set of /api/events API methods, See: https://api.iterable.com/api/docs#events_embedded_track_click

From Iterable API Docs: Events are created asynchronously and processed separately from single event (non-bulk) endpoint. To make sure events are tracked in order, send them all to the same endpoint (either bulk or non-bulk).

func NewEventsApi 

func NewEventsApi(apiKey string, httpClient *http.Client, logger logger.Logger, limiter rate.Limiter) *Events

func (*Events) GetByEmail 

func (e *Events) GetByEmail(email string) ([]types.Event, error)

func (*Events) GetByUserId 

func (e *Events) GetByUserId(userId string) ([]types.Event, error)

func (*Events) Track 

func (e *Events) Track(req types.EventTrackRequest) (*types.PostResponse, error)

func (*Events) TrackBulk 

func (e *Events) TrackBulk(req types.EventTrackBulkRequest) (*types.BulkEventsResponse, error)

type Lists 

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

Lists implements a set of /api/events API methods, See: https://api.iterable.com/api/docs#lists_getLists

func NewListsApi 

func NewListsApi(apiKey string, httpClient *http.Client, logger logger.Logger, limiter rate.Limiter) *Lists

func (*Lists) All 

func (c *Lists) All() ([]types.List, error)

func (*Lists) Create 

func (c *Lists) Create(name string, description string) (int64, error)

func (*Lists) Delete 

func (c *Lists) Delete(listId int64) (*types.PostResponse, error)

func (*Lists) Size 

func (c *Lists) Size(listId int64) (int64, error)

func (*Lists) Subscribe 

func (c *Lists) Subscribe(req types.ListSubscribeRequest) (*types.ListSubscribeResponse, error)

func (*Lists) UnSubscribe 

func (c *Lists) UnSubscribe(req types.ListUnSubscribeRequest) (*types.ListUnSubscribeResponse, error)

func (*Lists) Users 

func (c *Lists) Users(listId int64) (string, error)

type MessageTypes 

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

MessageTypes implements a set of /api/messageTypes API methods, See: https://api.iterable.com/api/docs#messageTypes_messageTypes

func NewMessageTypesApi 

func NewMessageTypesApi(apiKey string, httpClient *http.Client, logger logger.Logger, limiter rate.Limiter) *MessageTypes

func (*MessageTypes) Get 

func (m *MessageTypes) Get() (*types.MessageTypeResponse, error)

type Users 

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

Users implements a set of /api/users API methods, See: https://api.iterable.com/api/docs#messageTypes_messageTypes

func NewUsersApi 

func NewUsersApi(apiKey string, httpClient *http.Client, logger logger.Logger, limiter rate.Limiter) *Users

func (*Users) BulkUpdate 

func (u *Users) BulkUpdate(update types.BulkUpdateRequest) (*types.BulkUpdateResponse, error)

func (*Users) BulkUpdateSubscriptions 

func (u *Users) BulkUpdateSubscriptions(update types.BulkUserUpdateSubscriptionsRequest) (
	*types.BulkUserUpdateSubscriptionsResponse, error)

func (*Users) DeleteByEmail 

func (u *Users) DeleteByEmail(email string) (*types.PostResponse, error)

func (*Users) DeleteById 

func (u *Users) DeleteById(userId string) (*types.PostResponse, error)

func (*Users) ForgetByEmail 

func (u *Users) ForgetByEmail(email string) (*types.PostResponse, error)

func (*Users) ForgetByUserId 

func (u *Users) ForgetByUserId(userId string) (*types.PostResponse, error)

func (*Users) GetAllFields 

func (u *Users) GetAllFields() (map[string]string, error)

func (*Users) GetByEmail 

func (u *Users) GetByEmail(email string) (*types.User, bool, error)

func (*Users) GetById 

func (u *Users) GetById(userId string) (*types.User, bool, error)

func (*Users) GetForgottenEmails 

func (u *Users) GetForgottenEmails() ([]string, error)

func (*Users) GetSentMessages 

func (u *Users) GetSentMessages(query types.UserSentMessagesRequest) ([]types.UserSentMessage, error)

func (*Users) UnForgetByEmail 

func (u *Users) UnForgetByEmail(email string) (*types.PostResponse, error)

func (*Users) UnForgetByUserId 

func (u *Users) UnForgetByUserId(userId string) (*types.PostResponse, error)

func (*Users) UpdateEmail 

func (u *Users) UpdateEmail(
	email string,
	userId string,
	newEmail string,
) (*types.PostResponse, error)

func (*Users) UpdateOrCreate 

func (u *Users) UpdateOrCreate(user types.UserRequest) (*types.PostResponse, error)

func (*Users) UpdateSubscriptions 

func (u *Users) UpdateSubscriptions(update types.UserUpdateSubscriptionsRequest) (*types.PostResponse, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.