Service Class

The Yola class is a thin wrapper over the Yola API.

class yolapy.services.Yola(**kwargs)

Client for Yola’s API.

If using yolapy.configuration:

configure(
    url='https://wl.yola.net/',
    auth=('username', 'password'))
yola = Yola()
yola.get_user('user_id')

Or configured manually:

yola = Yola(
    url='https://wl.yola.net/',
    auth=('username', 'password'))
yola.get_user('user_id')

When appropriate, successful responses will return parsed json objects.

Failures will raise instances of demands.HTTPServiceError.

__init__(**kwargs)

Initialize with optional headers.

Auth and url defaults are pulled from yolapy.configuration.

Passed arguments will override configuration:

Yola(headers={'Header-Name': 'value'})

Partners

The following methods are mixed in to the Yola class to provide access to the Partner resource:

class yolapy.resources.partner.PartnerResourceMixin

Methods for managing Partner resources.

create_partner(**attributes)

Create a partner.

>>> partner = yola.create_partner(
    id='COMPANY_ID',
    name='Company Name',
    parent_partner_id='PARENT_ID',
    properties={'name': 'value'})
>>> partner['name']
'Company Name'

See https://wl.qa.yola.net/partners/ for available properties.

delete_partner(partner_id)

Delete a partner.

>>> yola.delete_partner('PARTNER_ID')

get_partner(partner_id)

Return details for a particular partner.

>>> partner = yola.get_partner('PARTNER_ID')
>>> partner['name']
'Company Name'

list_partners(**options)

Return paginated list of partners.

>>> yola.list_partners()
{
    'count': 999,
    'previous': None,
    'next': 'https://wl.qa.yola.net/pr/partners/?page=2',
    'results': [{...}, {...}, ...]
}

You can pass page_size and page as keyword arguments:

>>> yola.list_partners(page_size=50, page=2)

update_partner(partner_id, **attributes)

Update a partner.

>>> yola.update_partner('PARTNER_ID', name='New name')

Users

The following methods are mixed in to the Yola class to provide access to the User resource:

class yolapy.resources.user.UserResourceMixin

Methods for managing User resources.

create_user(**attributes)

Create a user.

>>> user = yola.create_user(
    name='John',
    surname='Smith',
    email='johnsmith@example.com',
    partner_id='WL_PARTNER_ID',
    preferences={'preference_name': 'preference_value'})
>>> user['name']
'John'

delete_user(user_id)

Delete a user.

>>> yola.delete_user('user_id')

get_sso_create_site_url(user_id, domain, locale=None)

Get SSO create site url for a particular user and domain.

>>> yola.get_sso_create_site_url('user_id', 'example.com')

get_sso_open_site_url(user_id, site_id=None, locale=None)

Get SSO open site url for a particular user.

>>> yola.get_sso_open_site_url('user_id')

get_user(user_id)

Get details for a particular user.

>>> user = yola.get_user('user_id')
>>> user['name']
'John'

list_users(**filters)

Return paginated list of users.

>>> yola.list_users()
{
    'count': 999,
    'previous': None,
    'next': 'https://wl.qa.yola.net/pr/users/?page=2',
    'results': [
        {'name': 'John', 'surname': 'Smith', ...}
    ]
}

If there are no users, results will be an empty list. No exception will be raised.

You may pass pagination options and attribute filters as keyword arguments. See https://wl.qa.yola.net/users/ for available parameters.

For example:

>>> yola.list_users(page=2, page_size=50, partner_id='WL_YOLA')

update_user(user_id, **attributes)

Update a user.

>>> yola.update_user('user_id', name='New name')

Sites

The following methods are mixed in to the Yola class to provide access to the Site resource:

class yolapy.resources.site.SiteResourceMixin

Methods for managing Site resources.

change_site_domain(site_id, new_domain)

Change site’s domain.

>>> yola.change_site_domain('site_id', 'newdomain.com')

change_site_owner(site_id, new_user_id)

Change site owner.

>>> yola.change_site_owner('site_id', 'new_user_id')

delete_site(site_id)

Delete a site.

>>> yola.get_site('site_id')['deleted_at']
None
>>> yola.delete_site('site_id')
>>> yola.get_site('site_id')['deleted_at']
'2015-08-27T10:00:07'

disable_site(site_id)

Disable a site.

A disabled site can be edited but can’t be published.

>>> yola.disable_site('site_id')

enable_site(site_id)

Enable a site.

>>> yola.enable_site('site_id')

get_site(site_id)

Return details for a particular site.

>>> site = yola.get_site('site_id')
>>> site['name']
'My Site'

list_sites(**options)

Return paginated list of sites.

>>> yola.list_sites()
{
    'count': 999,
    'previous': None,
    'next': 'https://wl.qa.yola.net/pr/sites/?page=2',
    'results': [{...}, {...}, ...]
}

You can pass page_size and page as keyword arguments:

>>> yola.list_sites(page_size=50, page=2)

You can also pass filters and odering options as keyword arguments. See https://wl.qa.yola.net/sites/ for available options.

undelete_site(site_id)

Un-delete a site.

>>> yola.get_site('site_id')['deleted_at']
'2015-08-27T10:00:07'
>>> yola.undelete_site('site_id')
>>> yola.get_site('site_id')['deleted_at']
None

Subscriptions

The following methods are mixed in to the Yola class to provide access to the Subscription resource:

class yolapy.resources.subscription.SubscriptionResourceMixin

Methods for managing Subscription resources.

activate_trial_subscription(subscription_id)

Convert trial subscription to active.

>>> yola.activate_trial_subscription('subscription_id')

cancel_subscription(subscription_id, reason)

Cancel active subscription.

>>> yola.cancel_subscription('subscription_id', 'some reason')

change_subscription_type(subscription_id, new_type)

Change subscription type.

>>> yola.change_subscription_type('subscription_id', 'new_type')

See https://wl.qa.yola.net/subscriptions/ for available types.

create_subscription(subscription_type, user_id, properties)

Create a new subscription.

>>> subscription_type = 'wl_basic'
>>> user_id = 'abcdef0123456789abcdef0123456789'
>>> properties = {...}
>>> yola.create_subscription(subscription_type, user_id, properties)

See https://wl.qa.yola.net/subscriptions/ for available types and properties.

get_subscription(subscription_id)

Return details for a particular subscription.

>>> subscription = yola.get_subscription('subscription_id')
>>> subscription['name']
'My Subscription'

list_subscriptions(**options)

Return paginated list of subscriptions.

>>> yola.list_subscriptions()
{
    'count': 999,
    'previous': None,
    'next': 'https://wl.qa.yola.net/pr/subscriptions/?page=2',
    'results': [{...}, {...}, ...]
}

You can pass page_size and page as keyword arguments:

>>> yola.list_subscriptions(page_size=50, page=2)

You can also pass filters and odering options as keyword arguments. See https://wl.qa.yola.net/subscriptions/ for available options.

reactivate_subscription(subscription_id, reason)

Re-activate a cancelled subscription.

>>> yola.reactivate_subscription('subscription_id', 'some reason')

Campaigns

The following methods are mixed in to the Yola class to provide access to the Campaign resource:

class yolapy.resources.campaign.CampaignResourceMixin

Methods for managing Campaign resources.

delete_campaign(site_id, campaign_id)

Delete a campaign.

get_campaign(site_id, campaign_id)

Return details for a particular campaign.

>>> campaign = yola.get_campaign('site_id', 'campaign_id')
>>> campaign['name']
'My Campaign'

list_campaigns(site_id, **options)

Return list of campaigns for a site.

Indices and tables

• Index
• Module Index
• Search Page