airgun.entities.syncplan

Module Contents

Classes

SyncPlanEntity
ShowAllSyncPlans	Navigate to All Sync Plans screen.
AddNewSyncPlan	Navigate to New Sync Plan screen.
EditSyncPlan	Navigate to Edit Sync Plan screen.

class airgun.entities.syncplan.SyncPlanEntity(browser)

endpoint_path = /sync_plans

create(values)

Create new sync plan

delete(entity_name)

Delete existing sync plan

search(value)

Search for sync plan

read(entity_name, widget_names=None)

Read values for created sync plan

update(entity_name, values)

Update sync plan with necessary values

add_product(entity_name, products_list)

Add product to sync plan

Parameters

• entity_name (str) – sync plan name

• products_list – either one or list of products

remove_product(entity_name, products_list)

Remove product from sync plan

Parameters

• entity_name (str) – sync plan name

• products_list – either one or list of products

class airgun.entities.syncplan.ShowAllSyncPlans(obj, navigate_obj, logger=None)

Navigate to All Sync Plans screen.

VIEW

step(*args, **kwargs)

Describes the work to be done to get to the destination after the prequisite is met.

This is a default and is generally overridden.

class airgun.entities.syncplan.AddNewSyncPlan(obj, navigate_obj, logger=None)

Navigate to New Sync Plan screen.

VIEW

prerequisite

step(*args, **kwargs)

Describes the work to be done to get to the destination after the prequisite is met.

This is a default and is generally overridden.

class airgun.entities.syncplan.EditSyncPlan(obj, navigate_obj, logger=None)

Navigate to Edit Sync Plan screen.

Parameters

entity_name – name of sync plan

VIEW

prerequisite(*args, **kwargs)

Describes a step that must be carried our prior to this one.

This often calls a previous navigate_to, often using one of the helpers, NavigateToSibling which will navigate to a given destination using the same object, or NavigateToAttribute which will navigate to a destination against an object describe by the attribute of the parent object.

This is a default and is generally overridden.

step(*args, **kwargs)

Describes the work to be done to get to the destination after the prequisite is met.

This is a default and is generally overridden.