iterable

README

Description

This is an exhaustive list of API endpoints which are excluded from Write/Delete connector implementation and therefore are available only via proxy.

Excluded Endpoints

Authentication

• /api/auth/jwts/invalidate - Invalidate all JWTs issued for a user

Campaigns

• /api/campaigns/abort - Abort Campaign
• /api/campaigns/activateTriggered - Activate a triggered campaign
• /api/campaigns/archive - Archive campaigns
• /api/campaigns/cancel - Cancel a scheduled or recurring campaign
• /api/campaigns/deactivateTriggered - Deactivate a triggered campaign
• /api/campaigns/trigger - Trigger a campaign

Commerce

• /api/commerce/trackPurchase - Track a purchase
• /api/commerce/updateCart - Update a user's shopping cart items

Emails

• /api/email/cancel - Cancel an email to a user
• /api/email/target - Send an email to an email address

Message Events

• /api/embedded-messaging/events/click - Track an embedded message click
• /api/embedded-messaging/events/received - Track an embedded message received event
• /api/embedded-messaging/events/session - Track an embedded message session and related impressions

Events

• /api/events/inAppConsume - Consume or delete an in-app message
• /api/events/trackBulk - Bulk track events
• /api/events/trackInAppClick - Track an in-app message click
• /api/events/trackInAppClose - Track the closing of an in-app message
• /api/events/trackInAppDelivery - Track the delivery of an in-app message
• /api/events/trackInAppOpen - Track an in-app message open
• /api/events/trackPushOpen - Track a mobile push open
• /api/events/trackWebPushClick - Track a web push click
• /api/events/track - Track an event
• /api/export/start - Start export

In-App Notifications

• /api/inApp/cancel - Cancel a scheduled in-app message
• /api/inApp/target - Send an in-app notification to a user

Lists

• /api/lists/subscribe - Add subscribers to list
• /api/lists/unsubscribe - Remove users from a list
• /api/lists - Create a static list

Push Notifications

• /api/push/cancel - Cancel a push notification to a user
• /api/push/target - Send push notification to user

SMS

• /api/sms/cancel - Cancel an SMS to a user
• /api/sms/target - Send SMS notification to user

Subscription

• /api/subscriptions/subscribeToDoubleOptIn - Trigger a double opt-in subscription flow

Templates

• /api/templates/bulkDelete - Bulk delete templates

Users

• /api/users/bulkUpdateSubscriptions - Bulk update user subscriptions
• /api/users/bulkUpdate - Bulk update user data
• /api/users/disableDevice - Disable pushes to a mobile device
• /api/users/forget - Forget a user in compliance with GDPR
• /api/users/registerBrowserToken - Register a browser token for web push
• /api/users/registerDeviceToken - Register a device token for push
• /api/users/unforget - Unforget a user in compliance with GDPR
• /api/users/updateEmail - Update user email
• /api/users/updateSubscriptions - Update user subscriptions

Verifications

• /api/verify/sms/begin - Begin SMS Verification
• /api/verify/sms/check - Check SMS Verification Code

Web Push Notification

• /api/webPush/cancel - Cancel a web push notification to a user
• /api/webPush/target - Send web push notification to user

Workflow

• /api/workflows/triggerWorkflow - Trigger a journey (workflow)

Endpoints that are performing alike operations are excluded as well. In other words they are covered by related endpoint. Excluded similiar endpoints are as follows:

• /api/templates/email/update - Update email template
• /api/templates/inapp/update - Update in-app template
• /api/templates/push/update - Update push template
• /api/templates/sms/update - Update SMS template
• /api/users/{email} - Delete a user by email

Documentation

Index

• Constants
• Variables
• type Connector
  • func NewConnector(opts ...Option) (conn *Connector, outErr error)
  • func (c *Connector) Delete(ctx context.Context, config common.DeleteParams) (*common.DeleteResult, error)
  • func (c *Connector) HTTPClient() *common.HTTPClient
  • func (c *Connector) JSONHTTPClient() *common.JSONHTTPClient
  • func (c *Connector) ListObjectMetadata(ctx context.Context, objectNames []string) (*common.ListObjectMetadataResult, error)
  • func (c *Connector) Provider() providers.Provider
  • func (c *Connector) Read(ctx context.Context, config common.ReadParams) (*common.ReadResult, error)
  • func (c *Connector) String() string
  • func (c *Connector) Write(ctx context.Context, config common.WriteParams) (*common.WriteResult, error)
• type Option
  • func WithAuthenticatedClient(client common.AuthenticatedHTTPClient) Option
  • func WithClient(ctx context.Context, client *http.Client, apiKey string, ...) Option
• type ResponseError
  • func (r ResponseError) CombineErr(base error) error

Constants

const DefaultPageSize = 50

DefaultPageSize is number of elements per page.

Variables

var ErrCatalogCreate = errors.New("payload must have string 'name' to create a catalog")

Types

type Connector

type Connector struct {
	BaseURL string
	Client  *common.JSONHTTPClient
	Module  common.Module
}

func NewConnector

func NewConnector(opts ...Option) (conn *Connector, outErr error)

func (*Connector) Delete

func (c *Connector) Delete(ctx context.Context, config common.DeleteParams) (*common.DeleteResult, error)

func (*Connector) HTTPClient

func (c *Connector) HTTPClient() *common.HTTPClient

func (*Connector) JSONHTTPClient

func (c *Connector) JSONHTTPClient() *common.JSONHTTPClient

JSONHTTPClient returns the underlying JSON HTTP client.

func (*Connector) ListObjectMetadata

func (c *Connector) ListObjectMetadata(
	ctx context.Context, objectNames []string,
) (*common.ListObjectMetadataResult, error)

func (*Connector) Provider

func (c *Connector) Provider() providers.Provider

func (*Connector) Read

func (c *Connector) Read(ctx context.Context, config common.ReadParams) (*common.ReadResult, error)

func (*Connector) String

func (c *Connector) String() string

func (*Connector) Write

func (c *Connector) Write(
	ctx context.Context, config common.WriteParams,
) (*common.WriteResult, error)

type Option

type Option = func(params *parameters)

Option is a function which mutates the connector configuration.

func WithAuthenticatedClient

func WithAuthenticatedClient(client common.AuthenticatedHTTPClient) Option

func WithClient

func WithClient(ctx context.Context, client *http.Client,
	apiKey string, opts ...common.HeaderAuthClientOption,
) Option

type ResponseError

type ResponseError struct {
	Message string `json:"msg"`
	Code    string `json:"code"`
	Params  any    `json:"params"`
}

func (ResponseError) CombineErr

func (r ResponseError) CombineErr(base error) error