everyaction.services.ExportJobs

class everyaction.services.ExportJobs(ea: EAClient)

Represents the Export Jobs service.

Methods

create(**kwargs)	See POST /exportJobs.
find_type(name)	Finds the ExportJobType with the given name, case insensitive.
get(job_id, /)	See GET /exportJobs/{exportJobId}.
name_to_type()	Gives a mapping from names to the ExportJobTypes .ExportJobType of the same name, case-insensitive.
types(*[, limit])	See GET /exportJobTypes.

create(**kwargs: EAValue) → ExportJob

See POST /exportJobs.

Parameters

kwargs – The applicable query arguments and JSON data for the request.

Returns

The resulting ExportJob object.

Keyword Arguments

• savedListId (saved_list_id, saved_list, list)

• type

• webhookUrl (webhook_url, webhook)

find_type(name: str) → ExportJobType

Finds the ExportJobType with the given name, case insensitive.

Parameters

name – Name of export job type to find.

Returns

The resulting ExportJobType object.

Raises

EAFindFailedException – If the export job type could not be found.

get(job_id: int, /) → ExportJob

See GET /exportJobs/{exportJobId}.

Parameters

job_id – The exportJobId path parameter.

Returns

The resulting ExportJob object.

name_to_type() → Dict[str, ExportJobType]

Gives a mapping from names to the ExportJobTypes .ExportJobType of the same name, case-insensitive.

Returns

Name of Export Job Type to the resulting ExportJobType objects.

types(*, limit: Optional[int] = None, **kwargs: EAValue) → List[ExportJobType]

See GET /exportJobTypes.

Parameters

• limit – Maximum number of records to get for this request.

• kwargs – The applicable query arguments and JSON data for the request.

Returns

List of the resulting ExportJobType objects.