everyaction.services.BulkImport

class everyaction.services.BulkImport(ea: EAClient)

Represents the Bulk Import service.

Methods

create(**kwargs)	See POST /bulkImportJobs.
get(job_id, /)	See GET /bulkImportJobs/{jobId}.
mapping_type(name, /)	See GET /bulkImportMappingTypes/{mappingTypeName}.
mapping_types(*[, limit])	See GET /bulkImportMappingTypes.
resources()	See GET /bulkImportJobs/resources.
values(mapping_name, field_name, /, *[, limit])	See GET /bulkImportMappingTypes/{mappingTypeName}/{fieldName}/values.

create(**kwargs: EAValue) → BulkImportJobData

See POST /bulkImportJobs.

Parameters

kwargs – The applicable query arguments and JSON data for the request. A BulkImportJob is appropriate to unpack here.

Returns

The BulkImportJobData object for the created Bulk Import Job.

Keyword Arguments

• actions (action (singular))

• description (desc)

• file

get(job_id: int, /) → BulkImportJobData

See GET /bulkImportJobs/{jobId}.

Parameters

job_id – The jobId path parameter.

Returns

The resulting BulkImportJobData object.

mapping_type(name: str, /) → MappingTypeData

See GET /bulkImportMappingTypes/{mappingTypeName}.

Parameters

name – The mappingTypeName path parameter.

Returns

The resulting MappingTypeData object.

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

See GET /bulkImportMappingTypes.

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 MappingTypeData objects.

resources() → List[str]

See GET /bulkImportJobs/resources.

Returns

List of resource type names.

values(mapping_name: str, field_name: str, /, *, limit: Optional[int] = None, **kwargs: EAValue) → List[ValueMappingData]

See GET /bulkImportMappingTypes/{mappingTypeName}/{fieldName}/values.

Parameters

• mapping_name – The mappingTypeName path parameter.

• field_name – The fieldName path parameter.

• 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 ValueMappingData objects.