magicbell

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

type APIError struct {
	Code       APIErrorCode `json:"code"`
	Suggestion string       `json:"suggestion"`
	Message    string       `json:"message"`
	HelpLink   string       `json:"help_link"`
}

type APIErrorCode string

type APIErrors []APIError

type BaseNotification struct {
	// ID is the MagicBell ID for the notification
	ID string `json:"id"`
}

type Config struct {
	// APIKey is the api key for your MagicBell account
	APIKey string
	// APISecret is the api secret for your MagicBell account
	APISecret string
	// BaseURL is the MagicBell API url, this is optional
	// and will default to https://api.magicbell.io
	BaseURL string `yaml:",omitempty"`
	// Timeout is an optional time.Duration to wait for HTTP requests to timeout.
	// If not provided, it will default to 5 seconds.
	Timeout *time.Duration `yaml:",omitempty"` // optional
}

type CreateNotificationRequest struct {
	// Title is the title of the notification
	Title string `json:"title"`
	// Recipients are the users to send the notification to
	Recipients []NotificationRecipient `json:"recipients"`
	// Content is the content of the notification to send
	Content string `json:"content,omitempty"`
	// CustomAttributes are a set of key-value pairs that you can attach to a notification
	CustomAttributes CustomAttributes `json:"custom_attributes,omitempty"`
	// ActionURL is a URL to redirect the user to when they click on the notification in MagicBell's embeddable notification center.
	ActionURL string `json:"action_url,omitempty"`
	// Category is the category this notification belongs to.
	Category string `json:"category,omitempty"`
}

type CreateUserRequest struct {
	// ExternalID is a unique string that MagicBell can utilize to uniquely identify the user.
	// We recommend setting this attribute to the ID of the user in your database.
	// Provide the external id if the user's email is unavailable.
	ExternalID string `json:"external_id"`
	// Email is the user's email.
	Email string `json:"email"`
	// FirstName is the user's first name.
	FirstName string `json:"first_name,omitempty"`
	// LastName is the user's last name.
	LastName string `json:"last_name,omitempty"`
	// CustomAttributes are any customers attributes that you'd like to associate with the user.
	// These custom attributes can later be utilized in MagicBell's web interface (when writing email templates for example).
	CustomAttributes CustomAttributes `json:"custom_attributes,omitempty"`
}

type CustomAttributes map[string]interface{}

type IAPI interface {
	// GenerateUserEmailHMAC generates a sha256 HMAC signature of the user's email
	// using the APISecret as the HMAC key. The returned value is a base64 encoded
	// string of the resulting HMAC signature. See https://developer.magicbell.io/reference#performing-api-requests-from-javascript
	GenerateUserEmailHMAC(userEmail string) string
	// CreateNotification sends a notification to one or multiple users.
	CreateNotification(req CreateNotificationRequest) (*BaseNotification, error)
	// CreateNotificationC sends a notification to one or multiple users, using a context.Context in the HTTP request.
	CreateNotificationC(ctx context.Context, req CreateNotificationRequest) (*BaseNotification, error)
	//FetchUserNotifications()
	//FetchUserNotificationsC(ctx context.Context)
	//FetchUserNotification()
	//FetchUserNotificationC(ctx context.Context)
	//DeleteUserNotification()
	//DeleteUserNotificationC(ctx context.Context)
	//MarkNotificationRead()
	//MarkNotificationReadC(ctx context.Context)
	//MarkNotificationUnread()
	//MarkNotificationUnreadC(ctx context.Context)
	//MarkAllNotificationsRead()
	//MarkAllNotificationsReadC(ctx context.Context)
	//MarkAllNotificationsSeen()
	//MarkAllNotificationsSeenC(ctx context.Context)
	// CreateUser creates a new user in MagicBell.
	// Please note that you must provide the user's email or the external id so MagicBell can uniquely identify the user.
	// The external id, if provided, must be unique to the user.
	CreateUser(req CreateUserRequest) (*User, error)
	// CreateUserC creates a new user in MagicBell, using a context.Context in the HTTP request.
	// Please note that you must provide the user's email or the external id so MagicBell can uniquely identify the user.
	// The external id, if provided, must be unique to the user.
	CreateUserC(ctx context.Context, req CreateUserRequest) (*User, error)
	// UpdateUser updates a user in MagicBell with the given ID.
	// The user id is the MagicBell user id. Alternatively, provide an id like
	// email:theusersemail@example.com or external_id:theusersexternalid as the user id.
	UpdateUser(userID string, req UpdateUserRequest) (*User, error)
	// UpdateUserC updates a user in MagicBell with the given ID, using a context.Context in the HTTP request.
	// The user id is the MagicBell user id. Alternatively, provide an id like
	// email:theusersemail@example.com or external_id:theusersexternalid as the user id.
	UpdateUserC(ctx context.Context, userID string, req UpdateUserRequest) (*User, error)
}

type InternalServerError struct {
	// StatusCode is the HTTP status code returned from the request
	StatusCode int
	// Body is the response body, if any
	Body string
}

type Notification struct {
	BaseNotification
}

type NotificationRecipient struct {
	// Email is the email of the recipient to send the notification to.
	Email string `json:"email,omitempty"`
	// ExternalID is the unique string to identify the user in your database.
	ExternalID string `json:"external_id,omitempty"`
	Matches    string `json:"matches,omitempty"`
}

type UpdateUserRequest struct {
	// ExternalID is a unique string that MagicBell can utilize to uniquely identify the user.
	// We recommend setting this attribute to the ID of the user in your database.
	// Provide the external id if the user's email is unavailable.
	ExternalID string `json:"external_id"`
	// Email is the user's email.
	Email string `json:"email"`
	// FirstName is the user's first name.
	FirstName string `json:"first_name,omitempty"`
	// LastName is the user's last name.
	LastName string `json:"last_name,omitempty"`
	// CustomAttributes are any customers attributes that you'd like to associate with the user.
	// These custom attributes can later be utilized in MagicBell's web interface (when writing email templates for example).
	CustomAttributes CustomAttributes `json:"custom_attributes,omitempty"`
}

type User struct {
	// ID is the unique ID MagicBell internally uses to represent your user.
	ID string `json:"id"`
	// ExternalID is a unique string that MagicBell can utilize to uniquely identify the user.
	ExternalID string `json:"external_id"`
	// Email is the user's email.
	Email string `json:"email"`
	// FirstName is the user's first name.
	FirstName string `json:"first_name"`
	// LastName is the user's last name.
	LastName string `json:"last_name"`
	// CustomAttributes are any customers attributes that you'd like to associate with the user.
	CustomAttributes CustomAttributes `json:"custom_attributes"`
}