Index

_

__init__() (apilinker.core.error_handling.CircuitBreaker method) (apilinker.core.error_handling.DeadLetterQueue method) (apilinker.core.error_handling.ErrorAnalytics method) (apilinker.core.error_handling.ErrorRecoveryManager method) (apilinker.core.plugins.PluginBase method), [1] (apilinker.core.plugins.PluginManager method), [1]

A

add_item() (apilinker.core.error_handling.DeadLetterQueue method) add_mapping() (apilinker.api_linker.ApiLinker method), [1], [2], [3] (apilinker.core.mapper.FieldMapper method), [1] add_named_source() (apilinker.api_linker.ApiLinker method), [1], [2], [3] add_schedule() (apilinker.api_linker.ApiLinker method), [1], [2], [3] (apilinker.core.scheduler.Scheduler method), [1] add_source() (apilinker.api_linker.ApiLinker method), [1], [2], [3] add_target() (apilinker.api_linker.ApiLinker method), [1], [2], [3] add_user() (apilinker.api_linker.ApiLinker method), [1], [2], [3] aggregate_source_data() (apilinker.api_linker.ApiLinker method), [1], [2], [3] aggregate_sources() (apilinker.api_linker.ApiLinker method), [1], [2], [3] ApiConnector (class in apilinker.core.connector), [1] ApiKeyAuth (class in apilinker.core.auth), [1] ApiLinker (class in apilinker.api_linker), [1], [2], [3] apilinker.api_linker module, [1], [2], [3] apilinker.core.auth module, [1]

apilinker.core.connector module, [1] apilinker.core.error_handling module apilinker.core.mapper module, [1] apilinker.core.plugins module apilinker.core.scheduler module, [1] ApiLinkerError apply_transform() (apilinker.core.mapper.FieldMapper method), [1] AuthConfig (class in apilinker.core.auth), [1] authenticate() (apilinker.core.plugins.AuthPlugin method), [1] AUTHENTICATION (apilinker.core.error_handling.ErrorCategory attribute) AuthManager (class in apilinker.core.auth), [1] authorization_code (apilinker.core.auth.OAuth2PKCE attribute), [1] authorization_url (apilinker.core.auth.OAuth2PKCE attribute), [1] AuthPlugin (class in apilinker.core.plugins), [1]

B

BasicAuth (class in apilinker.core.auth), [1]

BearerAuth (class in apilinker.core.auth), [1] body_template (apilinker.core.connector.EndpointConfig attribute), [1]

C

check_health() (apilinker.core.connector.ApiConnector method), [1] CIRCUIT_BREAKER (apilinker.core.error_handling.RecoveryStrategy attribute) CircuitBreaker (class in apilinker.core.error_handling) CircuitBreakerState (class in apilinker.core.error_handling) CLIENT (apilinker.core.error_handling.ErrorCategory attribute) client_id (apilinker.core.auth.OAuth2ClientCredentials attribute), [1] (apilinker.core.auth.OAuth2DeviceFlow attribute), [1] (apilinker.core.auth.OAuth2PKCE attribute), [1] client_secret (apilinker.core.auth.OAuth2ClientCredentials attribute), [1] (apilinker.core.auth.OAuth2DeviceFlow attribute), [1] CLOSED (apilinker.core.error_handling.CircuitBreakerState attribute) code_challenge (apilinker.core.auth.OAuth2PKCE attribute), [1]

code_verifier (apilinker.core.auth.OAuth2PKCE attribute), [1] complete_pkce_flow() (apilinker.core.auth.AuthManager method), [1] config (apilinker.core.plugins.AuthPlugin attribute) (apilinker.core.plugins.ConnectorPlugin attribute) (apilinker.core.plugins.PluginBase attribute), [1], [2] (apilinker.core.plugins.TransformerPlugin attribute) configure_auth() (apilinker.core.auth.AuthManager method), [1] connect() (apilinker.core.plugins.ConnectorPlugin method), [1] ConnectorPlugin (class in apilinker.core.plugins), [1] consume_sse() (apilinker.core.connector.ApiConnector method), [1] correlation_id (apilinker.api_linker.SyncResult attribute), [1], [2], [3] count (apilinker.api_linker.SyncResult attribute), [1], [2], [3] create_error_handler() (in module apilinker.core.error_handling)

D

DeadLetterQueue (class in apilinker.core.error_handling) details (apilinker.api_linker.SyncResult attribute), [1], [2], [3] device_authorization_url (apilinker.core.auth.OAuth2DeviceFlow attribute), [1] device_code (apilinker.core.auth.OAuth2DeviceFlow attribute), [1]

discover_plugins() (apilinker.core.plugins.PluginManager method), [1] download() (apilinker.api_linker.ApiLinker method), [1], [2], [3] download_stream() (apilinker.core.connector.ApiConnector method), [1] duration_ms (apilinker.api_linker.SyncResult attribute), [1], [2], [3]

E

EndpointConfig (class in apilinker.core.connector), [1] error_type (apilinker.api_linker.ErrorDetail attribute), [1], [2], [3] ErrorAnalytics (class in apilinker.core.error_handling) ErrorCategory (class in apilinker.core.error_handling) ErrorDetail (class in apilinker.api_linker), [1], [2], [3] ErrorRecoveryManager (class in apilinker.core.error_handling)

errors (apilinker.api_linker.SyncResult attribute), [1], [2], [3] execute() (apilinker.core.error_handling.CircuitBreaker method) expires_at (apilinker.core.auth.OAuth2ClientCredentials attribute), [1] (apilinker.core.auth.OAuth2DeviceFlow attribute), [1] (apilinker.core.auth.OAuth2PKCE attribute), [1] EXPONENTIAL_BACKOFF (apilinker.core.error_handling.RecoveryStrategy attribute)

F

FAIL_FAST (apilinker.core.error_handling.RecoveryStrategy attribute) FALLBACK (apilinker.core.error_handling.RecoveryStrategy attribute) fetch() (apilinker.api_linker.ApiLinker method), [1], [2], [3] (apilinker.core.plugins.ConnectorPlugin method), [1]

fetch_data() (apilinker.core.connector.ApiConnector method), [1] FieldMapper (class in apilinker.core.mapper), [1] from_apilinker_error() (apilinker.api_linker.ErrorDetail class method), [1], [2], [3] from_exception() (apilinker.core.error_handling.ApiLinkerError class method)

G

get_auth_plugin() (apilinker.core.plugins.PluginManager method), [1] get_circuit_breaker() (apilinker.core.error_handling.ErrorRecoveryManager method) get_connector() (apilinker.core.plugins.PluginManager method), [1] get_credential() (apilinker.api_linker.ApiLinker method), [1], [2], [3] get_error_analytics() (apilinker.api_linker.ApiLinker method), [1], [2], [3] get_error_rate() (apilinker.core.error_handling.ErrorAnalytics method) get_first_mapping() (apilinker.core.mapper.FieldMapper method), [1] get_items() (apilinker.core.error_handling.DeadLetterQueue method) get_mappings() (apilinker.core.mapper.FieldMapper method), [1]

get_pkce_authorization_url() (apilinker.core.auth.AuthManager method), [1] get_plugin() (apilinker.core.plugins.PluginManager method), [1] get_plugin_info() (apilinker.core.plugins.PluginBase class method), [1] get_schedule_info() (apilinker.core.scheduler.Scheduler method), [1] get_strategies() (apilinker.core.error_handling.ErrorRecoveryManager method) get_summary() (apilinker.core.error_handling.ErrorAnalytics method) get_top_errors() (apilinker.core.error_handling.ErrorAnalytics method) get_transformer() (apilinker.core.plugins.PluginManager method), [1] get_value_from_path() (apilinker.core.mapper.FieldMapper method), [1]

H

HALF_OPEN (apilinker.core.error_handling.CircuitBreakerState attribute) handle_error() (apilinker.core.error_handling.ErrorRecoveryManager method)

header_name (apilinker.core.auth.ApiKeyAuth attribute), [1] headers (apilinker.core.connector.EndpointConfig attribute), [1]

I

in_header (apilinker.core.auth.ApiKeyAuth attribute), [1] in_query (apilinker.core.auth.ApiKeyAuth attribute), [1]

instantiate_plugin() (apilinker.core.plugins.PluginManager method), [1] interval (apilinker.core.auth.OAuth2DeviceFlow attribute), [1]

K

key (apilinker.core.auth.ApiKeyAuth attribute), [1]

L

list_credentials() (apilinker.api_linker.ApiLinker method), [1], [2], [3] list_users() (apilinker.api_linker.ApiLinker method), [1], [2], [3]

load_config() (apilinker.api_linker.ApiLinker method), [1], [2], [3] load_custom_transformer() (apilinker.core.mapper.FieldMapper method), [1]

M

map_data() (apilinker.core.mapper.FieldMapper method), [1] map_fields() (apilinker.core.mapper.FieldMapper method), [1] MAPPING (apilinker.core.error_handling.ErrorCategory attribute) message (apilinker.api_linker.ErrorDetail attribute), [1], [2], [3] method (apilinker.core.connector.EndpointConfig attribute), [1] model_config (apilinker.api_linker.ErrorDetail attribute), [1], [2], [3] (apilinker.api_linker.SyncResult attribute), [1], [2], [3] (apilinker.core.auth.ApiKeyAuth attribute), [1] (apilinker.core.auth.AuthConfig attribute), [1] (apilinker.core.auth.BasicAuth attribute), [1] (apilinker.core.auth.BearerAuth attribute), [1] (apilinker.core.auth.OAuth2ClientCredentials attribute), [1] (apilinker.core.auth.OAuth2DeviceFlow attribute), [1] (apilinker.core.auth.OAuth2PKCE attribute), [1] (apilinker.core.connector.EndpointConfig attribute), [1]

module apilinker.api_linker, [1], [2], [3] apilinker.core.auth, [1] apilinker.core.connector, [1] apilinker.core.error_handling apilinker.core.mapper, [1] apilinker.core.plugins apilinker.core.scheduler, [1]

N

NETWORK (apilinker.core.error_handling.ErrorCategory attribute)

O

OAuth2ClientCredentials (class in apilinker.core.auth), [1] OAuth2DeviceFlow (class in apilinker.core.auth), [1]

OAuth2PKCE (class in apilinker.core.auth), [1] OPEN (apilinker.core.error_handling.CircuitBreakerState attribute)

P

pagination (apilinker.core.connector.EndpointConfig attribute), [1] params (apilinker.core.connector.EndpointConfig attribute), [1] password (apilinker.core.auth.BasicAuth attribute), [1] path (apilinker.core.connector.EndpointConfig attribute), [1] PLUGIN (apilinker.core.error_handling.ErrorCategory attribute) plugin_name (apilinker.core.plugins.PluginBase attribute), [1], [2], [3] plugin_type (apilinker.core.plugins.AuthPlugin attribute), [1] (apilinker.core.plugins.ConnectorPlugin attribute), [1] (apilinker.core.plugins.PluginBase attribute), [1], [2], [3] (apilinker.core.plugins.TransformerPlugin attribute), [1] PluginBase (class in apilinker.core.plugins), [1]

PluginError (class in apilinker.core.plugins) PluginInitializationError (class in apilinker.core.plugins) PluginManager (class in apilinker.core.plugins), [1] PluginNotFoundError (class in apilinker.core.plugins) PluginValidationError (class in apilinker.core.plugins) poll_device_flow() (apilinker.core.auth.AuthManager method), [1] process_dlq() (apilinker.api_linker.ApiLinker method), [1], [2], [3]

Q

query_param (apilinker.core.auth.ApiKeyAuth attribute), [1]

R

rate_limit (apilinker.core.connector.EndpointConfig attribute), [1] RATE_LIMIT (apilinker.core.error_handling.ErrorCategory attribute) record_error() (apilinker.core.error_handling.ErrorAnalytics method) RecoveryStrategy (class in apilinker.core.error_handling) redirect_uri (apilinker.core.auth.OAuth2PKCE attribute), [1] refresh_oauth2_token() (apilinker.core.auth.AuthManager method), [1] refresh_pkce_token() (apilinker.core.auth.AuthManager method), [1] refresh_token (apilinker.core.auth.OAuth2DeviceFlow attribute), [1] (apilinker.core.auth.OAuth2PKCE attribute), [1]

register_plugin() (apilinker.core.plugins.PluginManager method), [1] register_transformer() (apilinker.core.mapper.FieldMapper method), [1] request_method (apilinker.api_linker.ErrorDetail attribute), [1], [2], [3] request_schema (apilinker.core.connector.EndpointConfig attribute), [1] request_url (apilinker.api_linker.ErrorDetail attribute), [1], [2], [3] response_body (apilinker.api_linker.ErrorDetail attribute), [1], [2], [3] response_path (apilinker.core.connector.EndpointConfig attribute), [1] response_schema (apilinker.core.connector.EndpointConfig attribute), [1] RETRY (apilinker.core.error_handling.RecoveryStrategy attribute) retry_item() (apilinker.core.error_handling.DeadLetterQueue method)

S

Scheduler (class in apilinker.core.scheduler), [1] scope (apilinker.core.auth.OAuth2ClientCredentials attribute), [1] (apilinker.core.auth.OAuth2DeviceFlow attribute), [1] (apilinker.core.auth.OAuth2PKCE attribute), [1] send() (apilinker.api_linker.ApiLinker method), [1], [2], [3] (apilinker.core.plugins.ConnectorPlugin method), [1] send_data() (apilinker.core.connector.ApiConnector method), [1] SERVER (apilinker.core.error_handling.ErrorCategory attribute) set_strategy() (apilinker.core.error_handling.ErrorRecoveryManager method) set_value_at_path() (apilinker.core.mapper.FieldMapper method), [1] SKIP (apilinker.core.error_handling.RecoveryStrategy attribute) source_response (apilinker.api_linker.SyncResult attribute), [1], [2], [3] sse (apilinker.core.connector.EndpointConfig attribute), [1] start() (apilinker.core.scheduler.Scheduler method), [1] start_device_flow() (apilinker.core.auth.AuthManager method), [1]

start_scheduled_sync() (apilinker.api_linker.ApiLinker method), [1], [2], [3] state (apilinker.core.auth.OAuth2PKCE attribute), [1] (apilinker.core.error_handling.CircuitBreaker property) status_code (apilinker.api_linker.ErrorDetail attribute), [1], [2], [3] stop() (apilinker.core.scheduler.Scheduler method), [1] stop_scheduled_sync() (apilinker.api_linker.ApiLinker method), [1], [2], [3] storage_key (apilinker.core.auth.OAuth2DeviceFlow attribute), [1] (apilinker.core.auth.OAuth2PKCE attribute), [1] store_credential() (apilinker.api_linker.ApiLinker method), [1], [2], [3] stream() (apilinker.api_linker.ApiLinker method), [1], [2], [3] stream_response() (apilinker.core.connector.ApiConnector method), [1] stream_sse() (apilinker.core.connector.ApiConnector method), [1] streaming (apilinker.core.connector.EndpointConfig attribute), [1] success (apilinker.api_linker.SyncResult attribute), [1], [2], [3] sync() (apilinker.api_linker.ApiLinker method), [1], [2], [3] SyncResult (class in apilinker.api_linker), [1], [2], [3]

T

target_response (apilinker.api_linker.SyncResult attribute), [1], [2], [3] TIMEOUT (apilinker.core.error_handling.ErrorCategory attribute) timestamp (apilinker.api_linker.ErrorDetail attribute), [1], [2], [3] to_dict() (apilinker.core.error_handling.ApiLinkerError method) token (apilinker.core.auth.BearerAuth attribute), [1] (apilinker.core.auth.OAuth2ClientCredentials attribute), [1] (apilinker.core.auth.OAuth2DeviceFlow attribute), [1] (apilinker.core.auth.OAuth2PKCE attribute), [1] token_url (apilinker.core.auth.OAuth2ClientCredentials attribute), [1] (apilinker.core.auth.OAuth2DeviceFlow attribute), [1] (apilinker.core.auth.OAuth2PKCE attribute), [1]

transform() (apilinker.core.mapper.FieldMapper method), [1] (apilinker.core.plugins.TransformerPlugin method), [1] TransformerPlugin (class in apilinker.core.plugins), [1] type (apilinker.core.auth.ApiKeyAuth attribute), [1] (apilinker.core.auth.AuthConfig attribute), [1] (apilinker.core.auth.BasicAuth attribute), [1] (apilinker.core.auth.BearerAuth attribute), [1] (apilinker.core.auth.OAuth2ClientCredentials attribute), [1] (apilinker.core.auth.OAuth2DeviceFlow attribute), [1] (apilinker.core.auth.OAuth2PKCE attribute), [1]

U

UNKNOWN (apilinker.core.error_handling.ErrorCategory attribute)

user_code (apilinker.core.auth.OAuth2DeviceFlow attribute), [1] username (apilinker.core.auth.BasicAuth attribute), [1]

V

validate_connection() (apilinker.core.plugins.ConnectorPlugin method), [1] validate_credentials() (apilinker.core.plugins.AuthPlugin method), [1] validate_input() (apilinker.core.plugins.TransformerPlugin method), [1]

VALIDATION (apilinker.core.error_handling.ErrorCategory attribute) verification_uri (apilinker.core.auth.OAuth2DeviceFlow attribute), [1] verification_uri_complete (apilinker.core.auth.OAuth2DeviceFlow attribute), [1]