BentoSdk.Client (BentoSDK v0.1.2)

View Source

HTTP client for the Bento API.

Summary

Functions

Add a field to a subscriber.

Add a tag to a subscriber.

Add a tag to a subscriber via an event.

Change a subscriber's email.

Check if a domain or IP address is on any blacklists.

Create new broadcasts.

Create a new field in your account.

Create a subscriber in Bento.

Create a new tag in your account.

Check if an email is risky.

Check if an email is valid.

Find or create a subscriber in Bento.

Find a subscriber in Bento.

Geolocate an IP address.

Get broadcast statistics.

Get a list of broadcasts.

Get email statistics for a time period.

Get all fields in your account.

Get report statistics.

Get segment statistics.

Get site statistics.

Get subscriber growth statistics.

Get all tags in your account.

Guess the gender of a name.

Import events in bulk.

Import or update subscribers in bulk.

Check against the special "Jesse's Ruleset".

Moderate content for profanity and other inappropriate content.

Remove a field from a subscriber.

Remove a tag from a subscriber.

Run a command to change a subscriber's data.

Subscribe a user.

Unsubscribe a user.

Validate an email address using Bento's validation service.

Functions

add_field(email, key, value)

Add a field to a subscriber.

add_tag(email, tag)

Add a tag to a subscriber.

add_tag_via_event(email, tag)

Add a tag to a subscriber via an event.

change_email(old_email, new_email)

Change a subscriber's email.

check_blacklist(params)

Check if a domain or IP address is on any blacklists.

Returns a map with blacklist check results.

create_broadcasts(broadcasts)

Create new broadcasts.

create_field(key)

Create a new field in your account.

Returns the details of the created field.

create_subscriber(email)

Create a subscriber in Bento.

create_tag(name)

Create a new tag in your account.

email_risky?(email)

Check if an email is risky.

email_valid?(email)

Check if an email is valid.

find_or_create_subscriber(email)

Find or create a subscriber in Bento.

find_subscriber(email)

Find a subscriber in Bento.

geolocate(ip_address)

Geolocate an IP address.

Returns a map with geolocation information.

get_broadcast_stats(broadcast_id)

Get broadcast statistics.

Returns statistics for a specific broadcast.

get_broadcasts()

Get a list of broadcasts.

get_email_stats(start_date, end_date)

Get email statistics for a time period.

Returns a map with email statistics.

get_fields()

Get all fields in your account.

Returns a list of fields.

get_report_stats(report_id)

Get report statistics.

Returns data for a specific report.

get_segment_stats(segment_id)

Get segment statistics.

Returns statistics for a specific segment, including user count, subscriber count, and unsubscriber count.

get_site_stats()

Get site statistics.

Returns basic statistics about your Bento site, including user count, subscriber count, and unsubscriber count.

get_subscriber_growth(start_date, end_date)

Get subscriber growth statistics.

Returns subscriber growth statistics for a specific time period.

get_tag_stats(tag_name, start_date, end_date)

Get tag statistics.

Returns statistics for a specific tag over a time period.

get_tags()

Get all tags in your account.

guess_gender(name)

Guess the gender of a name.

Returns a map with gender probability information.

import_events(events)

Import events in bulk.

import_subscribers(subscribers)

Import or update subscribers in bulk.

jesses_ruleset(email, opts)

Check against the special "Jesse's Ruleset".

moderate_content(content)

Moderate content for profanity and other inappropriate content.

Returns a map with moderation results.

remove_field(email, field)

Remove a field from a subscriber.

remove_tag(email, tag)

Remove a tag from a subscriber.

run_command(command, email, query)

Run a command to change a subscriber's data.

send_email(to, from, subject, html_body, personalizations \\ %{}, transactional \\ false)

Send an email through Bento.

subscribe(email)

Subscribe a user.

track_event(email, type, fields \\ %{}, details \\ %{})

Track an event in Bento.

unsubscribe(email)

Unsubscribe a user.

validate_email(email, opts)

Validate an email address using Bento's validation service.

Returns a map with validation results.