pdk-contracts-lib 1.9.1-alpha.2

PDK Contracts Library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
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

// Copyright (c) 2026, Salesforce, Inc.,
// All rights reserved.
// For full license text, see the LICENSE.txt file

use pdk_core::classy::hl::HttpClientError;

#[allow(unused)]
use crate::ContractValidator;

/// Error returned when [ContractValidator::authenticate()] fails.
#[non_exhaustive]
#[derive(thiserror::Error, Debug, Clone, PartialEq, Eq)]
pub enum AuthenticationError {
    /// Client ID does not match.
    #[error("Client ID does not match.")]
    InvalidClientId,

    /// Client Secret does not match.
    #[error("Client Secret does not match.")]
    InvalidClientSecret,

    ///Contract does not have client_secret configured; client credentials authentication is not supported for this contract.
    #[error("Contract does not have client_secret configured; client credentials authentication is not supported for this contract.")]
    ContractHasNoClientSecret,

    /// Contracts are unavailable.
    #[error("Contracts are unavailable.")]
    UnavailableContracts,
}

/// Error returned when [ContractValidator::authorize()] fails.
#[non_exhaustive]
#[derive(thiserror::Error, Debug, Clone, PartialEq, Eq)]
pub enum AuthorizationError {
    /// Client ID does not match.
    #[error("Client ID does not match.")]
    InvalidClientId,

    /// Contracts are unavailable.
    #[error("Contracts are unavailable.")]
    UnavailableContracts,
}

/// Error returned when [ContractValidator::update_contracts()] fails.
#[non_exhaustive]
#[derive(thiserror::Error, Debug)]
pub enum UpdateError {
    /// Contracts upstream login problem.
    #[error("Contracts upstream login problem.")]
    InvalidLogin(HttpClientError),

    /// Contracts upstream request problem.
    #[error("Contracts upstream request problem.")]
    InvalidRequest(HttpClientError),
}