Enhancements

class Enhancements(session_kwargs, client, return_type='raw')

Civis API /enhancements endpoint.

Methods

delete_cass_ncoa_projects(id, project_id)

Remove a CASS/NCOA Enhancement from a project

delete_cass_ncoa_runs(id, run_id)

Cancel a run

delete_cass_ncoa_shares_groups(id, group_id)

Revoke the permissions a group has on this object

delete_cass_ncoa_shares_users(id, user_id)

Revoke the permissions a user has on this object

delete_civis_data_match_projects(id, project_id)

Remove a Civis Data Match Enhancement from a project

delete_civis_data_match_runs(id, run_id)

Cancel a run

delete_civis_data_match_shares_groups(id, ...)

Revoke the permissions a group has on this object

delete_civis_data_match_shares_users(id, user_id)

Revoke the permissions a user has on this object

delete_geocode_projects(id, project_id)

Remove a Geocode Enhancement from a project

delete_geocode_runs(id, run_id)

Cancel a run

delete_geocode_shares_groups(id, group_id)

Revoke the permissions a group has on this object

delete_geocode_shares_users(id, user_id)

Revoke the permissions a user has on this object

delete_identity_resolution_projects(id, ...)

Remove an Identity Resolution Enhancement from a project

delete_identity_resolution_runs(id, run_id)

Cancel a run

delete_identity_resolution_shares_groups(id, ...)

Revoke the permissions a group has on this object

delete_identity_resolution_shares_users(id, ...)

Revoke the permissions a user has on this object

get_cass_ncoa(id)

Get a CASS/NCOA Enhancement

get_cass_ncoa_runs(id, run_id)

Check status of a run

get_cass_ncoa_runs_inputs(id, run_id)

Get the inputs for a run

get_civis_data_match(id)

Get a Civis Data Match Enhancement

get_civis_data_match_runs(id, run_id)

Check status of a run

get_civis_data_match_runs_inputs(id, run_id)

Get the inputs for a run

get_geocode(id)

Get a Geocode Enhancement

get_geocode_runs(id, run_id)

Check status of a run

get_geocode_runs_inputs(id, run_id)

Get the inputs for a run

get_identity_resolution(id, *[, is_legacy_id])

Get an Identity Resolution Enhancement

get_identity_resolution_runs(id, run_id)

Check status of a run

list(*[, type, author, status, archived, ...])

List Enhancements

list_cass_ncoa_dependencies(id, *[, user_id])

List dependent objects for this object

list_cass_ncoa_projects(id, *[, hidden])

List the projects a CASS/NCOA Enhancement belongs to

list_cass_ncoa_runs(id, *[, limit, ...])

List runs for the given CASS NCOA job

list_cass_ncoa_runs_logs(id, run_id, *[, ...])

Get the logs for a run

list_cass_ncoa_runs_outputs(id, run_id, *[, ...])

List the outputs for a run

list_cass_ncoa_shares(id)

List users and groups permissioned on this object

list_civis_data_match_dependencies(id, *[, ...])

List dependent objects for this object

list_civis_data_match_projects(id, *[, hidden])

List the projects a Civis Data Match Enhancement belongs to

list_civis_data_match_runs(id, *[, limit, ...])

List runs for the given Civis Data Match job

list_civis_data_match_runs_logs(id, run_id, *)

Get the logs for a run

list_civis_data_match_runs_outputs(id, run_id, *)

List the outputs for a run

list_civis_data_match_shares(id)

List users and groups permissioned on this object

list_field_mapping()

List the fields in a field mapping for Civis Data Match, Data Unification, and Table Deduplication jobs

list_geocode_dependencies(id, *[, user_id])

List dependent objects for this object

list_geocode_projects(id, *[, hidden])

List the projects a Geocode Enhancement belongs to

list_geocode_runs(id, *[, limit, page_num, ...])

List runs for the given Geocode job

list_geocode_runs_logs(id, run_id, *[, ...])

Get the logs for a run

list_geocode_runs_outputs(id, run_id, *[, ...])

List the outputs for a run

list_geocode_shares(id)

List users and groups permissioned on this object

list_identity_resolution(*[, archived, ...])

List Identity Resolution Enhancements

list_identity_resolution_dependencies(id, *)

List dependent objects for this object

list_identity_resolution_projects(id, *[, ...])

List the projects an Identity Resolution Enhancement belongs to

list_identity_resolution_runs(id, *[, ...])

List runs for the given Identity Resolution job

list_identity_resolution_runs_logs(id, run_id, *)

Get the logs for a run

list_identity_resolution_shares(id)

List users and groups permissioned on this object

list_types()

List available enhancement types

patch_cass_ncoa(id, *[, name, schedule, ...])

Update some attributes of this CASS/NCOA Enhancement

patch_civis_data_match(id, *[, name, ...])

Update some attributes of this Civis Data Match Enhancement

patch_geocode(id, *[, name, schedule, ...])

Update some attributes of this Geocode Enhancement

patch_identity_resolution(id, *[, name, ...])

Update some attributes of this Identity Resolution Enhancement

post_cass_ncoa(name, source, *[, schedule, ...])

Create a CASS/NCOA Enhancement

post_cass_ncoa_cancel(id)

Cancel a run

post_cass_ncoa_runs(id)

Start a run

post_civis_data_match(name, ...[, schedule, ...])

Create a Civis Data Match Enhancement

post_civis_data_match_cancel(id)

Cancel a run

post_civis_data_match_clone(id, *[, ...])

Clone this Civis Data Match Enhancement

post_civis_data_match_runs(id)

Start a run

post_geocode(name, remote_host_id, ...[, ...])

Create a Geocode Enhancement

post_geocode_cancel(id)

Cancel a run

post_geocode_clone(id, *[, clone_schedule, ...])

Clone this Geocode Enhancement

post_geocode_runs(id)

Start a run

post_identity_resolution(name, sources, *[, ...])

Create an Identity Resolution Enhancement

post_identity_resolution_cancel(id)

Cancel a run

post_identity_resolution_clone(id, *[, ...])

Clone this Identity Resolution Enhancement

post_identity_resolution_runs(id)

Start a run

put_cass_ncoa(id, name, source, *[, ...])

Replace all attributes of this CASS/NCOA Enhancement

put_cass_ncoa_archive(id, status)

Update the archive status of this object

put_cass_ncoa_projects(id, project_id)

Add a CASS/NCOA Enhancement to a project

put_cass_ncoa_shares_groups(id, group_ids, ...)

Set the permissions groups has on this object

put_cass_ncoa_shares_users(id, user_ids, ...)

Set the permissions users have on this object

put_cass_ncoa_transfer(id, user_id, ...[, ...])

Transfer ownership of this object to another user

put_civis_data_match(id, name, ...[, ...])

Replace all attributes of this Civis Data Match Enhancement

put_civis_data_match_archive(id, status)

Update the archive status of this object

put_civis_data_match_projects(id, project_id)

Add a Civis Data Match Enhancement to a project

put_civis_data_match_shares_groups(id, ...)

Set the permissions groups has on this object

put_civis_data_match_shares_users(id, ...[, ...])

Set the permissions users have on this object

put_civis_data_match_transfer(id, user_id, ...)

Transfer ownership of this object to another user

put_geocode(id, name, remote_host_id, ...[, ...])

Replace all attributes of this Geocode Enhancement

put_geocode_archive(id, status)

Update the archive status of this object

put_geocode_projects(id, project_id)

Add a Geocode Enhancement to a project

put_geocode_shares_groups(id, group_ids, ...)

Set the permissions groups has on this object

put_geocode_shares_users(id, user_ids, ...)

Set the permissions users have on this object

put_geocode_transfer(id, user_id, ...[, ...])

Transfer ownership of this object to another user

put_identity_resolution(id, name, sources, *)

Replace all attributes of this Identity Resolution Enhancement

put_identity_resolution_archive(id, status)

Update the archive status of this object

put_identity_resolution_projects(id, project_id)

Add an Identity Resolution Enhancement to a project

put_identity_resolution_shares_groups(id, ...)

Set the permissions groups has on this object

put_identity_resolution_shares_users(id, ...)

Set the permissions users have on this object

put_identity_resolution_transfer(id, ...[, ...])

Transfer ownership of this object to another user