Pular para conteúdo

client

Cliente principal para interação com a API do PLDPro.

PLDProClient

Cliente principal para interação com a API do PLDPro.

Parameters:

Name Type Description Default
config Configuration

Configuração do cliente SDK.

 required
Source code in pldpro_sdk/core/client.py 
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
class PLDProClient:
    """
    Cliente principal para interação com a API do PLDPro.

    :param config: Configuração do cliente SDK.
    :type config: SDKConfig
    """

    def __init__(
        self,
        config: SDKConfig,
        tenant_code: Optional[str] = None,
        api_key: Optional[str] = None,
        development_mode: bool = False,
        dev_user: Optional[str] = None,
        dev_user_id: Optional[str] = None,
        dev_roles: Optional[str] = None,
    ) -> None:
        """
        Em homologação e produção, injeta a API key e o tenant.
        Em desenvolvimento, envia apenas os headers de desenvolvimento.

        :param config: Instância de Configuration (host, retries, etc.)
        """
        if development_mode:
            self._config = config_development_auth(
                config,
                tenant_code or "",
                dev_user=dev_user,
                dev_user_id=dev_user_id,
                dev_roles=dev_roles,
            )
        elif not api_key:
            self._config = config_api_key_from_env(config)
        else:
            self._config = config_api_key(config, api_key, tenant_code or "")

        self._api_client = ApiClient(self._config)

        self._node = Nodes(self._api_client)
        self._caso = Caso(self._api_client)
        self._execucoes = Execucoes(self._api_client)
        self._data = Data(self._api_client)
        self._license = License(self._api_client)
        self._volumes = Volumes(self._api_client)

    @property
    def nodes(self):
        """
        Propriedade para acessar as operações relacionadas aos nodes.

        :return: Instância da classe Nodes para gerenciar nodes.
        :rtype: Nodes
        """
        return self._node

    @property
    def casos(self):
        """
        Propriedade para acessar as operações relacionadas aos casos.

        :return: Instância da classe Caso para gerenciar casos.
        :rtype: Caso
        """
        return self._caso

    @property
    def execucoes(self):
        """
        Propriedade para acessar as operações relacionadas as execucoes.

        :return: Instância da classe Caso para gerenciar execucoes.
        :rtype: Execucoes
        """
        return self._execucoes

    @property
    def data(self):
        """
        Propriedade para acessar as operações relacionadas aos dados disponíveis na API.

        :return: Instância da classe Data para gerenciar dados.
        :rtype: Data
        """
        return self._data

    @property
    def license(self):
        """
        Propriedade para acessar as operações relacionadas as licencas.

        :return: Instancia da classe License para gerenciar licencas.
        :rtype: License
        """
        return self._license

    @property
    def volumes(self) -> Volumes:
        """
        Acessa as operações relacionadas aos volumes.

        :return: Instância para gerenciar volumes.
        :rtype: Volumes
        """
        return self._volumes

    @property
    def config(self):
        """
        Propriedade para acessar a configuração do cliente.

        :return: Configuração do cliente SDK.
        :rtype: SDKConfig
        """
        return self._config

casos property

Propriedade para acessar as operações relacionadas aos casos.

Returns:

Type Description
Caso

Instância da classe Caso para gerenciar casos.

config property

Propriedade para acessar a configuração do cliente.

Returns:

Type Description
SDKConfig

Configuração do cliente SDK.

data property

Propriedade para acessar as operações relacionadas aos dados disponíveis na API.

Returns:

Type Description
Data

Instância da classe Data para gerenciar dados.

execucoes property

Propriedade para acessar as operações relacionadas as execucoes.

Returns:

Type Description
Execucoes

Instância da classe Caso para gerenciar execucoes.

license property

Propriedade para acessar as operações relacionadas as licencas.

Returns:

Type Description
License

Instancia da classe License para gerenciar licencas.

nodes property

Propriedade para acessar as operações relacionadas aos nodes.

Returns:

Type Description
Nodes

Instância da classe Nodes para gerenciar nodes.

volumes property

Acessa as operações relacionadas aos volumes.

Returns:

Type Description
Volumes

Instância para gerenciar volumes.

__init__(config, tenant_code=None, api_key=None, development_mode=False, dev_user=None, dev_user_id=None, dev_roles=None)

Em homologação e produção, injeta a API key e o tenant. Em desenvolvimento, envia apenas os headers de desenvolvimento.

Parameters:

Name Type Description Default
config Configuration

Instância de Configuration (host, retries, etc.)

 required
Source code in pldpro_sdk/core/client.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
def __init__(
    self,
    config: SDKConfig,
    tenant_code: Optional[str] = None,
    api_key: Optional[str] = None,
    development_mode: bool = False,
    dev_user: Optional[str] = None,
    dev_user_id: Optional[str] = None,
    dev_roles: Optional[str] = None,
) -> None:
    """
    Em homologação e produção, injeta a API key e o tenant.
    Em desenvolvimento, envia apenas os headers de desenvolvimento.

    :param config: Instância de Configuration (host, retries, etc.)
    """
    if development_mode:
        self._config = config_development_auth(
            config,
            tenant_code or "",
            dev_user=dev_user,
            dev_user_id=dev_user_id,
            dev_roles=dev_roles,
        )
    elif not api_key:
        self._config = config_api_key_from_env(config)
    else:
        self._config = config_api_key(config, api_key, tenant_code or "")

    self._api_client = ApiClient(self._config)

    self._node = Nodes(self._api_client)
    self._caso = Caso(self._api_client)
    self._execucoes = Execucoes(self._api_client)
    self._data = Data(self._api_client)
    self._license = License(self._api_client)
    self._volumes = Volumes(self._api_client)