Wizard Resources

Wizard

API Endpoints

• “/” loads the wizard, lists the substeps. POST to skip steps

Methods

class hyperadmin.resources.wizard.Wizard(**kwargs)

Bases: hyperadmin.resources.resources.BaseResource

step_definitions = []

list_endpoint

alias of StepList

instance_form_class

alias of StepStatusForm

storage_class

alias of SessionStorage

get_index_endpoint()

storage

create_storage()

get_storage_class()

get_storage_kwargs()

steps

available_steps

step_index(slug)

get_instances()

get_item_url(item)

get_view_endpoints()

set_step_status(slug, status)

update_statuses(statuses)

step_statuses

get_step_statuses()

set_step_statuses(statuses)

get_step_data(key)

set_step_data(key, value)

get_next_step(skip_steps=[], desired_step=None)

next_step(skip_steps=[], desired_step=None)

done(submissions)

get_current_step_links()

get_context_data(**kwargs)

FormStep

API Endpoints

• “/<slug>/” POST to submit step

Methods

class hyperadmin.resources.wizard.FormStep(**kwargs)

Bases: hyperadmin.resources.wizard.endpoints.Step

link_prototype

alias of FormStepLinkPrototype

form_class = None

prototype_method_map

get_link_prototypes()

get_context_data(**kwargs)

form_valid(form)

form_invalid(form)

MultiPartStep

API Endpoints

• “/<slug>/” POST to skip substeps
• “/<slug>/<substep>/” POST to submit substep

Methods

class hyperadmin.resources.wizard.MultiPartStep(**kwargs)

Bases: hyperadmin.resources.wizard.endpoints.StepProvider, hyperadmin.resources.wizard.resources.Wizard

get_resource_name()

get_url_suffix()

get_base_url_name_suffix()

can_skip()

get_outbound_links()

done(submissions)

get_current_step_links()

expand_template_names(suffixes)

create_apirequest(**kwargs)