Index

_

__add__() (pypix_api.scopes.base.ScopeGroup method), [1] __contains__() (pypix_api.scopes.base.ScopeGroup method), [1] __enter__() (pypix_api.error_handling.ErrorContext method) (pypix_api.metrics.PerformanceTracker method) __exit__() (pypix_api.error_handling.ErrorContext method) (pypix_api.metrics.PerformanceTracker method) __init__() (pypix_api.APIError method) (pypix_api.auth.oauth2.OAuth2Client method), [1] (pypix_api.AuthenticationError method) (pypix_api.banks.base.BankPixAPIBase method) (pypix_api.banks.exceptions.PixAPIException method) (pypix_api.error_handling.APIError method) (pypix_api.error_handling.AuthenticationError method) (pypix_api.error_handling.AuthorizationError method) (pypix_api.error_handling.BankSpecificError method) (pypix_api.error_handling.CertificateError method) (pypix_api.error_handling.ConfigurationError method) (pypix_api.error_handling.ErrorContext method) (pypix_api.error_handling.ErrorHandler method) (pypix_api.error_handling.NetworkError method) (pypix_api.error_handling.PIXError method) (pypix_api.error_handling.PIXTransactionError method) (pypix_api.error_handling.RateLimitError method) (pypix_api.error_handling.ValidationError method) (pypix_api.logging.APICallLogger method) (pypix_api.logging.PIXLogger method) (pypix_api.logging.StructuredFormatter method) (pypix_api.metrics.APICallMetric method) (pypix_api.metrics.MetricEntry method) (pypix_api.metrics.MetricsCollector method) (pypix_api.metrics.PerformanceTracker method) (pypix_api.MetricsCollector method) (pypix_api.models.pix.PixCobranca method) (pypix_api.OAuth2Client method) (pypix_api.observability.HealthCheck method) (pypix_api.observability.ObservabilityConfig method) (pypix_api.observability.ObservabilityMixin method) (pypix_api.PixCobranca method) (pypix_api.PIXError method) (pypix_api.PIXLogger method) (pypix_api.scopes.base.ScopeGroup method), [1] (pypix_api.ValidationError method)

__new__() (pypix_api.logging.PIXLogger static method) (pypix_api.metrics.MetricsCollector static method) (pypix_api.MetricsCollector static method) (pypix_api.PIXLogger static method) __str__() (pypix_api.error_handling.PIXError method) (pypix_api.PIXError method)

A

add_context() (pypix_api.logging.PIXLogger method) (pypix_api.PIXLogger method) APICallLogger (class in pypix_api.logging) APICallMetric (class in pypix_api.metrics)

APIError, [1] as_string() (pypix_api.scopes.base.ScopeGroup method), [1] AuthenticationError, [1] AuthorizationError

B

bank (pypix_api.metrics.APICallMetric attribute) BANK_CODE (pypix_api.scopes.base.BankScopesBase attribute), [1] (pypix_api.scopes.bb.BBScopes attribute), [1] (pypix_api.scopes.BBScopes attribute) (pypix_api.scopes.sicoob.SicoobScopes attribute), [1] (pypix_api.scopes.SicoobScopes attribute) BANK_CODES (pypix_api.scopes.base.BankScopesBase attribute), [1] (pypix_api.scopes.bb.BBScopes attribute), [1] (pypix_api.scopes.BBScopes attribute) (pypix_api.scopes.sicoob.SicoobScopes attribute), [1] (pypix_api.scopes.SicoobScopes attribute) BANK_NAME (pypix_api.scopes.base.BankScopesBase attribute), [1] (pypix_api.scopes.bb.BBScopes attribute), [1] (pypix_api.scopes.BBScopes attribute) (pypix_api.scopes.sicoob.SicoobScopes attribute), [1] (pypix_api.scopes.SicoobScopes attribute) BankPixAPIBase (class in pypix_api.banks.base) BankScopesBase (class in pypix_api.scopes.base), [1]

BankSpecificError BASE_URL (pypix_api.banks.base.BankPixAPIBase attribute), [1] (pypix_api.banks.bb.BBPixAPI attribute), [1], [2] (pypix_api.banks.sicoob.SicoobPixAPI attribute), [1], [2] (pypix_api.BBPixAPI attribute), [1] (pypix_api.SicoobPixAPI attribute), [1] BBPixAPI (class in pypix_api) (class in pypix_api.banks.bb), [1] BBScopes (class in pypix_api.scopes) (class in pypix_api.scopes.bb), [1] BOLETO (pypix_api.scopes.bb.BBScopes attribute), [1] (pypix_api.scopes.BBScopes attribute) (pypix_api.scopes.sicoob.SicoobScopes attribute), [1] (pypix_api.scopes.SicoobScopes attribute) BOLETO_BASIC (pypix_api.scopes.sicoob.SicoobScopes attribute), [1] (pypix_api.scopes.SicoobScopes attribute) BOLETO_WEBHOOK (pypix_api.scopes.sicoob.SicoobScopes attribute), [1] (pypix_api.scopes.SicoobScopes attribute)

C

CertificateError chave (pypix_api.models.pix.PixCobranca attribute) (pypix_api.PixCobranca attribute) check_system_health() (pypix_api.observability.HealthCheck method) classify_error() (pypix_api.error_handling.ErrorHandler method) clear_context() (pypix_api.logging.PIXLogger method) (pypix_api.PIXLogger method) clear_metrics() (in module pypix_api.metrics) (pypix_api.metrics.MetricsCollector method) (pypix_api.MetricsCollector method) client_id (pypix_api.banks.base.BankPixAPIBase attribute) COB (pypix_api.scopes.bb.BBScopes attribute), [1] (pypix_api.scopes.BBScopes attribute) CobMethods (class in pypix_api.banks.methods.cob_methods) COBR (pypix_api.scopes.bb.BBScopes attribute), [1] (pypix_api.scopes.BBScopes attribute) COBV (pypix_api.scopes.bb.BBScopes attribute), [1] (pypix_api.scopes.BBScopes attribute) CobVMethods (class in pypix_api.banks.methods.cobv_methods) combine_scopes() (pypix_api.scopes.base.BankScopesBase class method), [1] (pypix_api.scopes.registry.ScopeRegistry class method), [1] (pypix_api.scopes.ScopeRegistry class method) (pypix_api.scopes.sicoob.SicoobScopes class method), [1] (pypix_api.scopes.SicoobScopes class method)

configurar_webhook() (pypix_api.banks.methods.webhook_methods.WebHookMethods method) ConfigurationError configure_observability() (in module pypix_api) (in module pypix_api.observability) consultar_cob() (pypix_api.banks.methods.cob_methods.CobMethods method) consultar_cobs() (pypix_api.banks.methods.cob_methods.CobMethods method) consultar_cobv() (pypix_api.banks.methods.cobv_methods.CobVMethods method) consultar_devolucao_pix() (pypix_api.banks.methods.pix_methods.PixMethods method) consultar_pix() (pypix_api.banks.methods.pix_methods.PixMethods method) consultar_pix_por_e2eid() (pypix_api.banks.methods.pix_methods.PixMethods method) consultar_recorrencia() (pypix_api.banks.methods.rec_methods.RecMethods method) consultar_webhook() (pypix_api.banks.methods.webhook_methods.WebHookMethods method) CONTA_CORRENTE (pypix_api.scopes.bb.BBScopes attribute), [1] (pypix_api.scopes.BBScopes attribute) (pypix_api.scopes.sicoob.SicoobScopes attribute), [1] (pypix_api.scopes.SicoobScopes attribute) create_error_report() (in module pypix_api.error_handling) create_observability_report() (in module pypix_api.observability) criar_cob() (pypix_api.banks.methods.cob_methods.CobMethods method) criar_cob_auto_txid() (pypix_api.banks.methods.cob_methods.CobMethods method) criar_cobv() (pypix_api.banks.methods.cobv_methods.CobVMethods method) criar_recorrencia() (pypix_api.banks.methods.rec_methods.RecMethods method) critical() (pypix_api.logging.PIXLogger method) (pypix_api.PIXLogger method)

D

debug() (pypix_api.logging.PIXLogger method) (pypix_api.PIXLogger method)

description (pypix_api.scopes.base.ScopeGroup attribute), [1]

E

endpoint (pypix_api.metrics.APICallMetric attribute) error (pypix_api.metrics.APICallMetric attribute) error() (pypix_api.logging.PIXLogger method) (pypix_api.PIXLogger method)

ErrorContext (class in pypix_api.error_handling) ErrorHandler (class in pypix_api.error_handling) ErrorRecovery (class in pypix_api.error_handling) excluir_webhook() (pypix_api.banks.methods.webhook_methods.WebHookMethods method) export_metrics() (in module pypix_api.metrics)

F

flush_metrics() (pypix_api.metrics.MetricsCollector method) (pypix_api.MetricsCollector method)

format() (pypix_api.logging.StructuredFormatter method) from_dict() (pypix_api.observability.ObservabilityConfig class method)

G

gauge() (pypix_api.metrics.MetricsCollector method) (pypix_api.MetricsCollector method) get_bank_code() (pypix_api.banks.base.BankPixAPIBase method) (pypix_api.banks.bb.BBPixAPI method), [1] (pypix_api.banks.sicoob.SicoobPixAPI method), [1] (pypix_api.BBPixAPI method) (pypix_api.SicoobPixAPI method) get_bank_info() (pypix_api.scopes.base.BankScopesBase class method), [1] get_bank_scopes() (in module pypix_api.scopes) (in module pypix_api.scopes.registry), [1] get_base_url() (pypix_api.banks.bb.BBPixAPI method), [1] (pypix_api.banks.sicoob.SicoobPixAPI method), [1] (pypix_api.BBPixAPI method) (pypix_api.SicoobPixAPI method) get_metrics_summary() (in module pypix_api) (in module pypix_api.metrics) get_observability_status() (in module pypix_api) (in module pypix_api.observability) get_pix_scopes() (in module pypix_api.scopes) (in module pypix_api.scopes.registry), [1] (pypix_api.scopes.base.BankScopesBase class method), [1] (pypix_api.scopes.bb.BBScopes class method), [1] (pypix_api.scopes.BBScopes class method) (pypix_api.scopes.registry.ScopeRegistry class method), [1] (pypix_api.scopes.ScopeRegistry class method) (pypix_api.scopes.sicoob.SicoobScopes class method), [1] (pypix_api.scopes.SicoobScopes class method)

get_retry_delay() (pypix_api.error_handling.ErrorRecovery static method) get_scope_group() (pypix_api.scopes.base.BankScopesBase class method), [1] (pypix_api.scopes.registry.ScopeRegistry class method), [1] (pypix_api.scopes.ScopeRegistry class method) (pypix_api.scopes.sicoob.SicoobScopes class method), [1] (pypix_api.scopes.SicoobScopes class method) get_scopes() (pypix_api.scopes.registry.ScopeRegistry class method), [1] (pypix_api.scopes.ScopeRegistry class method) get_session_with_mtls() (in module pypix_api.auth.mtls) get_summary() (pypix_api.metrics.MetricsCollector method) (pypix_api.MetricsCollector method) get_token() (pypix_api.auth.oauth2.OAuth2Client method), [1] (pypix_api.OAuth2Client method)

H

handle_error() (pypix_api.error_handling.ErrorHandler method) handle_errors() (in module pypix_api.error_handling)

HealthCheck (class in pypix_api.observability) histogram() (pypix_api.metrics.MetricsCollector method) (pypix_api.MetricsCollector method)

I

increment() (pypix_api.metrics.MetricsCollector method) (pypix_api.MetricsCollector method)

info() (pypix_api.logging.PIXLogger method) (pypix_api.PIXLogger method)

L

list_available_groups() (pypix_api.scopes.base.BankScopesBase class method), [1] (pypix_api.scopes.sicoob.SicoobScopes class method), [1] (pypix_api.scopes.SicoobScopes class method) list_banks() (pypix_api.scopes.registry.ScopeRegistry class method), [1] (pypix_api.scopes.ScopeRegistry class method) list_scope_groups() (pypix_api.scopes.registry.ScopeRegistry class method), [1] (pypix_api.scopes.ScopeRegistry class method) listar_cobv() (pypix_api.banks.methods.cobv_methods.CobVMethods method) listar_recorrencias() (pypix_api.banks.methods.rec_methods.RecMethods method) listar_webhooks() (pypix_api.banks.methods.webhook_methods.WebHookMethods method)

LOCATION (pypix_api.scopes.bb.BBScopes attribute), [1] (pypix_api.scopes.BBScopes attribute) log_authentication() (in module pypix_api.logging) log_bank_operation() (in module pypix_api.logging) log_performance() (in module pypix_api.logging) log_pix_transaction() (in module pypix_api.logging) log_request() (pypix_api.logging.APICallLogger method) log_response() (pypix_api.logging.APICallLogger method) LOTECOBV (pypix_api.scopes.bb.BBScopes attribute), [1] (pypix_api.scopes.BBScopes attribute)

M

method (pypix_api.metrics.APICallMetric attribute) MetricEntry (class in pypix_api.metrics) MetricsCollector (class in pypix_api) (class in pypix_api.metrics) module pypix_api pypix_api.auth.mtls pypix_api.auth.oauth2, [1] pypix_api.banks.base pypix_api.banks.bb, [1] pypix_api.banks.exceptions pypix_api.banks.methods.cob_methods pypix_api.banks.methods.cobv_methods pypix_api.banks.methods.pix_methods pypix_api.banks.methods.rec_methods pypix_api.banks.methods.webhook_methods pypix_api.banks.sicoob, [1] pypix_api.error_handling pypix_api.logging pypix_api.metrics pypix_api.models.pix pypix_api.observability pypix_api.scopes pypix_api.scopes.base, [1] pypix_api.scopes.bb, [1] pypix_api.scopes.registry, [1] pypix_api.scopes.sicoob, [1]

N

name (pypix_api.metrics.MetricEntry attribute) (pypix_api.scopes.base.ScopeGroup attribute), [1]

NetworkError

O

oauth (pypix_api.banks.base.BankPixAPIBase attribute) OAuth2Client (class in pypix_api) (class in pypix_api.auth.oauth2), [1] ObservabilityConfig (class in pypix_api.observability)

ObservabilityMixin (class in pypix_api.observability) observable_method() (in module pypix_api.observability) observe_api_call() (pypix_api.observability.ObservabilityMixin method) observe_operation() (pypix_api.observability.ObservabilityMixin method)

P

PerformanceTracker (class in pypix_api.metrics) PIX (pypix_api.scopes.bb.BBScopes attribute), [1] (pypix_api.scopes.BBScopes attribute) (pypix_api.scopes.sicoob.SicoobScopes attribute), [1] (pypix_api.scopes.SicoobScopes attribute) PIX_BASIC (pypix_api.scopes.sicoob.SicoobScopes attribute), [1] (pypix_api.scopes.SicoobScopes attribute) PIX_COB (pypix_api.scopes.sicoob.SicoobScopes attribute), [1] (pypix_api.scopes.SicoobScopes attribute) PIX_COBV (pypix_api.scopes.sicoob.SicoobScopes attribute), [1] (pypix_api.scopes.SicoobScopes attribute) PIX_COMPLETO (pypix_api.scopes.sicoob.SicoobScopes attribute), [1] (pypix_api.scopes.SicoobScopes attribute) PIX_LOTE_COBV (pypix_api.scopes.sicoob.SicoobScopes attribute), [1] (pypix_api.scopes.SicoobScopes attribute) PIX_PAYLOAD (pypix_api.scopes.sicoob.SicoobScopes attribute), [1] (pypix_api.scopes.SicoobScopes attribute) PIX_WEBHOOK (pypix_api.scopes.sicoob.SicoobScopes attribute), [1] (pypix_api.scopes.SicoobScopes attribute) PixAcessoNegadoException PixAPIException PixCobranca (class in pypix_api) (class in pypix_api.models.pix) PixErroDesconhecidoException PIXError, [1] PixErroServicoIndisponivelException PixErroValidacaoException PIXLogger (class in pypix_api) (class in pypix_api.logging) PixMethods (class in pypix_api.banks.methods.pix_methods) PixRecursoNaoEncontradoException PixRespostaInvalidaError PIXTransactionError pypix_api module pypix_api.auth.mtls module pypix_api.auth.oauth2 module, [1]

pypix_api.banks.base module pypix_api.banks.bb module, [1] pypix_api.banks.exceptions module pypix_api.banks.methods.cob_methods module pypix_api.banks.methods.cobv_methods module pypix_api.banks.methods.pix_methods module pypix_api.banks.methods.rec_methods module pypix_api.banks.methods.webhook_methods module pypix_api.banks.sicoob module, [1] pypix_api.error_handling module pypix_api.logging module pypix_api.metrics module pypix_api.models.pix module pypix_api.observability module pypix_api.scopes module pypix_api.scopes.base module, [1] pypix_api.scopes.bb module, [1] pypix_api.scopes.registry module, [1] pypix_api.scopes.sicoob module, [1]

R

RateLimitError REC (pypix_api.scopes.bb.BBScopes attribute), [1] (pypix_api.scopes.BBScopes attribute) RecMethods (class in pypix_api.banks.methods.rec_methods) record_api_call() (pypix_api.metrics.MetricsCollector method) (pypix_api.MetricsCollector method)

register() (pypix_api.scopes.registry.ScopeRegistry class method), [1] (pypix_api.scopes.ScopeRegistry class method) response_time (pypix_api.metrics.APICallMetric attribute) retry_with_backoff() (pypix_api.error_handling.ErrorRecovery static method) revisar_cob() (pypix_api.banks.methods.cob_methods.CobMethods method) revisar_cobv() (pypix_api.banks.methods.cobv_methods.CobVMethods method) revisar_recorrencia() (pypix_api.banks.methods.rec_methods.RecMethods method)

S

SANDBOX_BASE_URL (pypix_api.banks.bb.BBPixAPI attribute), [1], [2] (pypix_api.banks.sicoob.SicoobPixAPI attribute), [1], [2] (pypix_api.BBPixAPI attribute), [1] (pypix_api.SicoobPixAPI attribute), [1] sandbox_mode (pypix_api.banks.base.BankPixAPIBase attribute) SCOPE_COB_READ (pypix_api.scopes.sicoob.SicoobScopes attribute), [1] (pypix_api.scopes.SicoobScopes attribute) SCOPE_COB_WRITE (pypix_api.scopes.sicoob.SicoobScopes attribute), [1] (pypix_api.scopes.SicoobScopes attribute) SCOPE_COBV_READ (pypix_api.scopes.sicoob.SicoobScopes attribute), [1] (pypix_api.scopes.SicoobScopes attribute) SCOPE_COBV_WRITE (pypix_api.scopes.sicoob.SicoobScopes attribute), [1] (pypix_api.scopes.SicoobScopes attribute) SCOPE_LOTECOBV_READ (pypix_api.scopes.sicoob.SicoobScopes attribute), [1] (pypix_api.scopes.SicoobScopes attribute) SCOPE_LOTECOBV_WRITE (pypix_api.scopes.sicoob.SicoobScopes attribute), [1] (pypix_api.scopes.SicoobScopes attribute) SCOPE_PAYLOADLOCATION_READ (pypix_api.scopes.sicoob.SicoobScopes attribute), [1] (pypix_api.scopes.SicoobScopes attribute) SCOPE_PAYLOADLOCATION_WRITE (pypix_api.scopes.sicoob.SicoobScopes attribute), [1] (pypix_api.scopes.SicoobScopes attribute) SCOPE_PIX_READ (pypix_api.scopes.sicoob.SicoobScopes attribute), [1] (pypix_api.scopes.SicoobScopes attribute) SCOPE_PIX_WRITE (pypix_api.scopes.sicoob.SicoobScopes attribute), [1] (pypix_api.scopes.SicoobScopes attribute) SCOPE_WEBHOOK_READ (pypix_api.scopes.sicoob.SicoobScopes attribute), [1] (pypix_api.scopes.SicoobScopes attribute)

SCOPE_WEBHOOK_WRITE (pypix_api.scopes.sicoob.SicoobScopes attribute), [1] (pypix_api.scopes.SicoobScopes attribute) ScopeGroup (class in pypix_api.scopes.base), [1] ScopeRegistry (class in pypix_api.scopes) (class in pypix_api.scopes.registry), [1] SCOPES (pypix_api.banks.base.BankPixAPIBase attribute) (pypix_api.banks.bb.BBPixAPI attribute), [1] (pypix_api.banks.sicoob.SicoobPixAPI attribute), [1] (pypix_api.BBPixAPI attribute) scopes (pypix_api.scopes.base.ScopeGroup attribute), [1] SCOPES (pypix_api.SicoobPixAPI attribute) session (pypix_api.banks.base.BankPixAPIBase attribute) setup_global_observability() (pypix_api.observability.ObservabilityConfig method) setup_logging() (in module pypix_api) (in module pypix_api.logging) should_retry() (pypix_api.error_handling.ErrorRecovery static method) SicoobPixAPI (class in pypix_api) (class in pypix_api.banks.sicoob), [1] SicoobScopes (class in pypix_api.scopes) (class in pypix_api.scopes.sicoob), [1] solicitar_devolucao_pix() (pypix_api.banks.methods.pix_methods.PixMethods method) SOLICREC (pypix_api.scopes.bb.BBScopes attribute), [1] (pypix_api.scopes.BBScopes attribute) status (pypix_api.models.pix.PixCobranca attribute) (pypix_api.PixCobranca attribute) status_code (pypix_api.metrics.APICallMetric attribute) StructuredFormatter (class in pypix_api.logging)

T

tags (pypix_api.metrics.MetricEntry attribute) timed_function() (in module pypix_api.metrics) timestamp (pypix_api.metrics.APICallMetric attribute) (pypix_api.metrics.MetricEntry attribute) timing() (pypix_api.metrics.MetricsCollector method) (pypix_api.MetricsCollector method) to_dict() (pypix_api.error_handling.PIXError method) (pypix_api.PIXError method) TODOS_ESCOPOS (pypix_api.scopes.sicoob.SicoobScopes attribute), [1] (pypix_api.scopes.SicoobScopes attribute)

TOKEN_URL (pypix_api.banks.base.BankPixAPIBase attribute), [1] (pypix_api.banks.bb.BBPixAPI attribute), [1], [2] (pypix_api.banks.sicoob.SicoobPixAPI attribute), [1], [2] (pypix_api.BBPixAPI attribute), [1] (pypix_api.SicoobPixAPI attribute), [1] track_api_call() (in module pypix_api.metrics) track_bank_operation() (in module pypix_api.metrics) txid (pypix_api.models.pix.PixCobranca attribute) (pypix_api.PixCobranca attribute)

U

unit (pypix_api.metrics.MetricEntry attribute)

V

ValidationError, [1] valor (pypix_api.models.pix.PixCobranca attribute) (pypix_api.PixCobranca attribute)

value (pypix_api.metrics.MetricEntry attribute)

W

warning() (pypix_api.logging.PIXLogger method) (pypix_api.PIXLogger method) WEBHOOK (pypix_api.scopes.bb.BBScopes attribute), [1] (pypix_api.scopes.BBScopes attribute)

WEBHOOK_COBR (pypix_api.scopes.bb.BBScopes attribute), [1] (pypix_api.scopes.BBScopes attribute) WEBHOOK_REC (pypix_api.scopes.bb.BBScopes attribute), [1] (pypix_api.scopes.BBScopes attribute) WebHookMethods (class in pypix_api.banks.methods.webhook_methods)