csc-cia-stne 0.0.33__py3-none-any.whl → 0.0.35__py3-none-any.whl

csc_cia_stne/utilitarios/validations/ServiceNowValidator.py

@@ -3,10 +3,29 @@ from typing import List
 
 
 class InitParamsValidator(BaseModel):
-    username : str
-    password : str
-    env : str
-    
+    """
+    Classe responsável por validar os parâmetros de inicialização.
+    Atributos:
+    - username (str): O nome de usuário.
+    - password (str): A senha.
+    - env (str): O ambiente.
+    Métodos:
+    - check_str_input(value, info): Valida se o valor é uma string não vazia.
+    """
+    username: str
+    password: str
+    env: str
+
+    """
+    Valida se o valor é uma string não vazia.
+    Parâmetros:
+    - value: O valor a ser validado.
+    - info: Informações sobre o campo.
+    Retorna:
+    - O valor validado.
+    Lança:
+    - ValueError: Se o valor não for uma string ou for uma string vazia.
+    """
     @field_validator('username', 'password', 'env')
     def check_str_input(cls, value, info):
         if not isinstance(value, str) or not value.strip():
@@ -14,16 +33,47 @@ class InitParamsValidator(BaseModel):
         return value
 
 class RequestValidator(BaseModel):
-    url : str
-    params : str
-    timeout : int = 15
+    """
+    Classe para validar os campos de uma requisição.
+    Atributos:
+    - url (str): A URL da requisição.
+    - params (str): Os parâmetros da requisição.
+    - timeout (int): O tempo limite da requisição em segundos. O valor padrão é 15.
+    Métodos:
+    - check_str_input(value, info): Valida se o valor é uma string não vazia.
+    - check_input_basic(value, info): Valida se o valor é um inteiro.
+    """
+    url: str
+    params: str
+    timeout: int = 15
+    
 
+    """
+    Valida se o valor é uma string não vazia.
+    Parâmetros:
+    - value: O valor a ser validado.
+    - info: Informações sobre o campo.
+    Retorna:
+    - O valor validado.
+    Lança:
+    - ValueError: Se o valor não for uma string ou estiver vazio.
+    """
     @field_validator('url', 'params')
     def check_str_input(cls, value, info):
         if not isinstance(value, str) or not value.strip():
             raise ValueError(f"O campo '{info.field_name}' deve ser uma string e não um {type(value)} e não vazio")
         return value
     
+    """
+    Valida se o valor é um inteiro.
+    Parâmetros:
+    - value: O valor a ser validado.
+    - info: Informações sobre o campo.
+    Retorna:
+    - O valor validado.
+    Lança:
+    - ValueError: Se o valor não for um inteiro.
+    """
     @field_validator('timeout')
     def check_input_basic(cls, value, info):
         if not isinstance(value, int):
@@ -32,22 +82,64 @@ class RequestValidator(BaseModel):
         return value
 
 class PutValidator(BaseModel):
+    """
+    Classe de validação para requisições PUT.
+    Atributos:
+    - url (str): A URL da requisição PUT.
+    - payload (dict): O payload da requisição PUT.
+    - timeout (int): O tempo limite da requisição PUT em segundos. O valor padrão é 15.
+    Métodos:
+    - check_str_input(value, info): Valida se o valor do atributo 'url' é uma string não vazia.
+    - check_input_basic(value, info): Valida se o valor do atributo 'timeout' é um inteiro.
+    - check_dict_input(value, info): Valida se o valor do atributo 'payload' é um dicionário.
+    """
+        
     url : str
     payload : dict
     timeout : int = 15
 
+    """
+    Valida se o valor do atributo 'url' é uma string não vazia.
+    Parâmetros:
+    - value: O valor do atributo 'url'.
+    - info: Informações sobre o campo sendo validado.
+    Retorna:
+    - O valor do atributo 'url' se for válido.
+    Lança:
+    - ValueError: Se o valor não for uma string ou for uma string vazia.
+    """
     @field_validator('url')
     def check_str_input(cls, value, info):
         if not isinstance(value, str) or not value.strip():
             raise ValueError(f"O campo '{info.field_name}' deve ser uma string e não um {type(value)} e não vazio")
         return value
     
+    """
+    Valida se o valor do atributo 'timeout' é um inteiro.
+    Parâmetros:
+    - value: O valor do atributo 'timeout'.
+    - info: Informações sobre o campo sendo validado.
+    Retorna:
+    - O valor do atributo 'timeout' se for válido.
+    Lança:
+    - ValueError: Se o valor não for um inteiro.
+    """
     @field_validator('timeout')
     def check_input_basic(cls, value, info):
         if not isinstance(value, int):
             raise ValueError(f"O campo '{info.field_name}' deve ser um inteiro e não um {type(value)}")
         return value
     
+    """
+    Valida se o valor do atributo 'payload' é um dicionário.
+    Parâmetros:
+    - value: O valor do atributo 'payload'.
+    - info: Informações sobre o campo sendo validado.
+    Retorna:
+    - O valor do atributo 'payload' se for válido.
+    Lança:
+    - ValueError: Se o valor não for um dicionário.
+    """
     @field_validator('payload')
     def check_dict_input(cls, value, info):
         if not isinstance(value, dict):
@@ -55,6 +147,15 @@ class PutValidator(BaseModel):
         return value
 
 class PostValidator(BaseModel):
+    """
+    Classe responsável por validar os dados de um post.
+    Atributos:
+    - url (str): A URL do post.
+    - variables (dict): As variáveis do post.
+    Métodos:
+    - check_str_input(value, info): Valida se o valor do campo 'url' é uma string não vazia.
+    - check_dict_input(value, info): Valida se o valor do campo 'variables' é um dicionário.
+    """
     url : str
     variables : dict
 
@@ -71,6 +172,19 @@ class PostValidator(BaseModel):
         return value
 
 class ListTicketValidator(BaseModel):
+    """
+    Classe para validar os campos de entrada da lista de tickets.
+    Atributos:
+    - tabela (str): Nome da tabela.
+    - query (str): Consulta a ser realizada.
+    - campos (List[str]): Lista de campos.
+    - timeout (int): Tempo limite.
+    - limit (int): Limite de resultados.
+    Métodos:
+    - check_str_input(value, info): Valida se o valor é uma string não vazia.
+    - check_input_basic(value, info): Valida se o valor é um inteiro.
+    - check_list_input(value, info): Valida se o valor é uma lista.
+    """
     tabela : str
     query : str
     campos : List[str]
@@ -96,23 +210,66 @@ class ListTicketValidator(BaseModel):
         return value
     
 class UpdateTicketValidator(BaseModel):
+    """
+    Classe responsável por validar os campos do ticket de atualização.
+    Atributos:
+    - sys_id (str): O ID do ticket.
+    - tabela (str): A tabela do ticket.
+    - payload (List[str]): A carga útil do ticket.
+    - timeout (int): O tempo limite para a operação.
+    Métodos:
+    - check_str_input(value, info): Valida se o valor fornecido é uma string não vazia.
+    - check_input_basic(value, info): Valida se o valor fornecido é um inteiro.
+    - check_list_input(value, info): Valida se o valor fornecido é uma lista.
+    """
+        
     sys_id : str
     tabela : str
     payload : List[str]
     timeout : int
 
+    """
+    Valida se o valor fornecido é uma string não vazia.
+    Parâmetros:
+    - value (Any): O valor a ser validado.
+    - info (FieldInfo): Informações sobre o campo.
+    Retorna:
+    - value (Any): O valor validado.
+    Lança:
+    - ValueError: Se o valor não for uma string ou estiver vazio.
+    """
     @field_validator('sys_id', 'tabela')
     def check_str_input(cls, value, info):
         if not isinstance(value, str) or not value.strip():
             raise ValueError(f"O campo '{info.field_name}' deve ser uma string e não um {type(value)} e não vazio")
         return value
     
+    """
+    Valida se o valor fornecido é um inteiro.
+    Parâmetros:
+    - value (Any): O valor a ser validado.
+    - info (FieldInfo): Informações sobre o campo.
+    Retorna:
+    - value (Any): O valor validado.
+    Lança:
+    - ValueError: Se o valor não for um inteiro.
+    """
     @field_validator('timeout')
     def check_input_basic(cls, value, info):
         if not isinstance(value, int):
             raise ValueError(f"O campo '{info.field_name}' deve ser um inteiro e não um {type(value)}")
         return value
 
+    """
+    Valida se o valor fornecido é uma lista.
+    Parâmetros:
+    - value (Any): O valor a ser validado.
+    - info (FieldInfo): Informações sobre o campo.
+    Retorna:
+    - value (Any): O valor validado.
+    Lança:
+    - ValueError: Se o valor não for uma lista.
+    """
     @field_validator('payload')
     def check_list_input(cls, value, info):
         if not isinstance(value, list):
@@ -120,6 +277,19 @@ class UpdateTicketValidator(BaseModel):
         return value
 
 class AttachFileTicketValidator(BaseModel):
+    """
+    Classe responsável por validar os campos de entrada do anexo de um ticket no ServiceNow.
+    Atributos:
+    - header_content_type (dict): O cabeçalho Content-Type da requisição.
+    - anexo_path (str): O caminho do anexo a ser enviado.
+    - tabela (str): O nome da tabela do ServiceNow.
+    - sys_id (str): O ID do registro no ServiceNow.
+    - timeout (int): O tempo limite da requisição.
+    Métodos:
+    - check_str_input(value, info): Valida se o valor do campo é uma string não vazia.
+    - check_input_basic(value, info): Valida se o valor do campo é um inteiro.
+    - check_dict_input(value, info): Valida se o valor do campo é um dicionário.
+    """
     header_content_type : dict
     anexo_path : str
     tabela : str
@@ -145,18 +315,51 @@ class AttachFileTicketValidator(BaseModel):
         return value
     
 class GetAttachValidator(BaseModel):
+    """
+    Classe responsável por validar os campos de entrada para a obtenção de anexos no ServiceNow.
+    Atributos:
+    - sys_id (str): O ID do registro no ServiceNow.
+    - tabela (str): O nome da tabela no ServiceNow.
+    - campo (str): O nome do campo no ServiceNow.
+    - download_dir (str): O diretório onde o anexo será salvo.
+    - timeout (int): O tempo limite para a operação de obtenção de anexo.
+    Métodos:
+    - check_str_input(value, info): Valida se os campos sys_id, tabela, campo e download_dir são strings não vazias.
+    - check_input_basic(value, info): Valida se o campo timeout é um inteiro.
+    """
+        
     sys_id : str
     tabela : str
     campo :str
     download_dir : str
     timeout : int
 
+    """
+    Valida se os campos sys_id, tabela, campo e download_dir são strings não vazias.
+    Parâmetros:
+    - value: O valor do campo a ser validado.
+    - info: Informações sobre o campo.
+    Retorna:
+    - O valor do campo, se for válido.
+    Lança:
+    - ValueError: Se o campo não for uma string ou estiver vazio.
+    """
     @field_validator('sys_id', 'tabela', 'campo', 'download_dir')
     def check_str_input(cls, value, info):
         if not isinstance(value, str) or not value.strip():
             raise ValueError(f"O campo '{info.field_name}' deve ser uma string e não um {type(value)} e não vazio")
         return value
     
+    """
+    Valida se o campo timeout é um inteiro.
+    Parâmetros:
+    - value: O valor do campo a ser validado.
+    - info: Informações sobre o campo.
+    Retorna:
+    - O valor do campo, se for válido.
+    Lança:
+    - ValueError: Se o campo não for um inteiro.
+    """
     @field_validator('timeout')
     def check_input_basic(cls, value, info):
         if not isinstance(value, int):

{csc_cia_stne-0.0.33.dist-info → csc_cia_stne-0.0.35.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: csc_cia_stne
-Version: 0.0.33
+Version: 0.0.35
 Summary: Biblioteca do time CSC-CIA utilizada no desenvolvimento de RPAs
 License: MIT
 Keywords: karavela,csc,cia,stone,rpa
@@ -17,6 +17,7 @@ Requires-Dist: google-cloud-storage
 Requires-Dist: google-auth-oauthlib
 Requires-Dist: google-auth-httplib2
 Requires-Dist: pyjwt
+Requires-Dist: PyYAML
 Requires-Dist: python-dotenv
 
 Essa biblioteca é desenvolvida e atualizada pelo time **CSC-CIA** da **Stone**

csc_cia_stne-0.0.35.dist-info/RECORD

@@ -0,0 +1,28 @@
+csc_cia_stne/__init__.py,sha256=Btr1EaCLDdKc8zRXX__Jz-Sf2yrhw67f80gr2CibEIU,2339
+csc_cia_stne/bc_correios.py,sha256=pQAnRrcXEMrx3N1MWydZVIhEQLerh3x8-0B045zZIzk,24174
+csc_cia_stne/bc_sta.py,sha256=f75HJ7FLIDSJFLDTvvSvCYo9z0HchzP7rDY5WIdiKXY,16830
+csc_cia_stne/email.py,sha256=RK_TzWBVnUfpP-s5NvjTJJjzhICy8e2fME9EuaiySMY,8162
+csc_cia_stne/gcp_bigquery.py,sha256=yNCx0yD1peoxOKEiu2Ml6FfDtXUTzcJGcypjWPH8QqE,7449
+csc_cia_stne/google_drive.py,sha256=yLfaAWcrOKk9YuI1qcOTkZEqyrSSEF68RmzYgC7dq-g,11569
+csc_cia_stne/karavela.py,sha256=LlpFiDu0ww7eh8F-oREWSQo2mVoQMibx0EGiHR6tznI,4231
+csc_cia_stne/logger_json.py,sha256=W6Fj0G1-TWXHdHoLLX5SbVV7BSpVvjHm1fkKI5Q69YQ,3129
+csc_cia_stne/logger_rich.py,sha256=FYO9tG-tEJJDP2EDYFTQYS8GayvbRMgRbKI9FcXvRCs,7812
+csc_cia_stne/provio.py,sha256=-HU1wcCX9fHSiaxSDKeTj5VXfATcnMeZJJ-nBLmNyfY,3696
+csc_cia_stne/servicenow.py,sha256=QN7R49Bb8HcqfGT9iytbPaqwV2rtH4N7Nhvb_kfTsHU,36400
+csc_cia_stne/stne_admin.py,sha256=vnGSEzcmqWE42vg71oEuoRg6ENaGsZsXFOjxduSH4KU,23561
+csc_cia_stne/utilitarios/__init__.py,sha256=_itV0qp-4E2Ophm09fXedqbDROlEfSEGJ8P8lSIuV30,108
+csc_cia_stne/utilitarios/functions/__init__.py,sha256=l--LlAXQbDxcE6NPlceyB91ES1RXUxjKKH7C7VKtBCg,218
+csc_cia_stne/utilitarios/functions/func_b64.py,sha256=XGU34BIQQXWXBS0yM2B4A2wDlcrMl1unIJXjq4lpLnk,1254
+csc_cia_stne/utilitarios/functions/func_converters.py,sha256=EY1zvlBaRX7G1MceVSiRXwwKDQDZwUO9iECBL0fe5iU,481
+csc_cia_stne/utilitarios/functions/func_recriar_pastas.py,sha256=4whZpB3aJQaCPJ3osMAQpKrzEhqYtJbljGWlx_OvKIM,826
+csc_cia_stne/utilitarios/functions/func_settings.py,sha256=ygzr56kEmLxe4Vp3c51092_cbQr9IqWCRc6JW4PT6Hs,1589
+csc_cia_stne/utilitarios/functions/func_titulo.py,sha256=bH4tYxovTARF-g2kWUK_GIzzXt8egbVdp6mWD6fc_3I,5345
+csc_cia_stne/utilitarios/validations/GcpBigQueryValidator.py,sha256=PfCeeQquheZkrm07HTIjobleh3QQOjljRFGdxbQ1amQ,4630
+csc_cia_stne/utilitarios/validations/GoogleDriveValidator.py,sha256=JqE5CQSN7ZbRyB0slvXhMwPgn-r89FPkvd-TKf_h5Pk,3736
+csc_cia_stne/utilitarios/validations/ServiceNowValidator.py,sha256=Vg4i9P7PV_qQ-gUDtSbSK4wOybt3deKG0OcotpufT7Y,13391
+csc_cia_stne/utilitarios/validations/__init__.py,sha256=VE49g8ExrBUyyUzhOUjsP9880L1PWCKPHckd848MQeo,71
+csc_cia_stne-0.0.35.dist-info/LICENCE,sha256=LPGMtgKki2C3KEZP7hDhA1HBrlq5JCHkIeStUCLEMx4,1073
+csc_cia_stne-0.0.35.dist-info/METADATA,sha256=ZANz6cz75kZGvYPsGyo18SJnyikBCoswPoEanNmJOv0,1025
+csc_cia_stne-0.0.35.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+csc_cia_stne-0.0.35.dist-info/top_level.txt,sha256=ldo7GVv3tQx5KJvwBzdZzzQmjPys2NDVVn1rv0BOF2Q,13
+csc_cia_stne-0.0.35.dist-info/RECORD,,

csc_cia_stne-0.0.33.dist-info/RECORD

@@ -1,27 +0,0 @@
-csc_cia_stne/__init__.py,sha256=PlHybccf5ZcwFE56zRvXFKB-z7Hv0l1rp1AXuA4AlnU,1529
-csc_cia_stne/bc_correios.py,sha256=ANsvLyL7wdkM0MvjjBHB2Ih4eyTcyWgt5IqiK0Rv89E,23014
-csc_cia_stne/bc_sta.py,sha256=uyoCp-KTpkWwpyWNWp20JuDfMRYGCKxERnRQVso80iQ,10903
-csc_cia_stne/email.py,sha256=dGgn-0_EM2-AUyz2genrokINHCaqYqAh4QC3xhl4deA,4160
-csc_cia_stne/gcp_bigquery.py,sha256=yNCx0yD1peoxOKEiu2Ml6FfDtXUTzcJGcypjWPH8QqE,7449
-csc_cia_stne/google_drive.py,sha256=3kGd4swPr6fLUJnQplq4VzAgF8X0Ho0Ke4JJN4RE-_8,10388
-csc_cia_stne/karavela.py,sha256=Q7MbQXXz_jtrLHM7QeenbSzcro07EpoFk4lKglivJ_I,3564
-csc_cia_stne/logger_json.py,sha256=W6Fj0G1-TWXHdHoLLX5SbVV7BSpVvjHm1fkKI5Q69YQ,3129
-csc_cia_stne/logger_rich.py,sha256=4KVwxz87AA52qEMpgCh1SlS--7a57LK4Y4HSnKmRruc,7514
-csc_cia_stne/provio.py,sha256=TF6_1uygkzftkhsOn6eMGkNqIWliKwcvh54RM10WzRo,2383
-csc_cia_stne/servicenow.py,sha256=QN7R49Bb8HcqfGT9iytbPaqwV2rtH4N7Nhvb_kfTsHU,36400
-csc_cia_stne/stne_admin.py,sha256=G5ozXt18VjKL2BHtROQk4GnfVY1xM14RXSQ-rra_D54,15487
-csc_cia_stne/utilitarios/__init__.py,sha256=4YFhzxu8F_CDHU6iaNhpzz9mfX-8wfJc1XEQInJzwJ4,98
-csc_cia_stne/utilitarios/functions/__init__.py,sha256=X0PmuSe0RilU824Lvlg-DtO0qDb_D_VfL4ftzR93d40,180
-csc_cia_stne/utilitarios/functions/func_b64.py,sha256=XGU34BIQQXWXBS0yM2B4A2wDlcrMl1unIJXjq4lpLnk,1254
-csc_cia_stne/utilitarios/functions/func_converters.py,sha256=EY1zvlBaRX7G1MceVSiRXwwKDQDZwUO9iECBL0fe5iU,481
-csc_cia_stne/utilitarios/functions/func_recriar_pastas.py,sha256=2_unoSoQHxShcMw_0XIL9F0NgiF1QCKsX4drvg0fEb8,415
-csc_cia_stne/utilitarios/functions/func_titulo.py,sha256=IMiTKdlMkOGHPJmPZEj2HnBEfOu2uDoUNkaqZxiZq54,3829
-csc_cia_stne/utilitarios/validations/GcpBigQueryValidator.py,sha256=BSJ84FBuOxbhYpyoebGMW15t0np9PHA8OCHFjkLOIRA,2984
-csc_cia_stne/utilitarios/validations/GoogleDriveValidator.py,sha256=OaT6F98RyP3iIMsIQMc0CCDUt0u7EkKxG_UoHm2ME3c,1376
-csc_cia_stne/utilitarios/validations/ServiceNowValidator.py,sha256=9IS3ucuLXeeebfVpvywEu9OiN-BfbXTuowTBEotUbow,5991
-csc_cia_stne/utilitarios/validations/__init__.py,sha256=VE49g8ExrBUyyUzhOUjsP9880L1PWCKPHckd848MQeo,71
-csc_cia_stne-0.0.33.dist-info/LICENCE,sha256=LPGMtgKki2C3KEZP7hDhA1HBrlq5JCHkIeStUCLEMx4,1073
-csc_cia_stne-0.0.33.dist-info/METADATA,sha256=_H_zaP8InDgMCsvQHlafwnLTrBxfwA3-OHmdF9e4Zts,1003
-csc_cia_stne-0.0.33.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-csc_cia_stne-0.0.33.dist-info/top_level.txt,sha256=ldo7GVv3tQx5KJvwBzdZzzQmjPys2NDVVn1rv0BOF2Q,13
-csc_cia_stne-0.0.33.dist-info/RECORD,,