force 0.2.0

Production-ready Salesforce Platform API client with REST and Bulk API 2.0 support
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
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

//! CPQ Document generation operations.
//!
//! Provides quote document/proposal generation via the ServiceRouter.

use super::CpqHandler;
use super::types::{GenerateDocumentRequest, ServiceRouterRequest};
use crate::error::Result;

/// CPQ Document API loader class name.
const GENERATE_PROPOSAL: &str = "SBQQ.QuoteAPI.GenerateProposal";

impl<A: crate::auth::Authenticator> CpqHandler<A> {
    /// Generates a quote document/proposal.
    ///
    /// Creates a document for the specified quote using the CPQ document
    /// generation engine. Returns raw JSON since the response shape varies
    /// by template and configuration.
    ///
    /// # Errors
    ///
    /// Returns an error if document generation fails.
    ///
    /// # Examples
    ///
    /// ```ignore
    /// let request = GenerateDocumentRequest::new("a0x000000000001AAA")
    ///     .with_template("a0z000000000001AAA")
    ///     .with_format("pdf");
    ///
    /// let result = client.cpq().generate_document(&request).await?;
    /// ```
    pub async fn generate_document(
        &self,
        request: &GenerateDocumentRequest,
    ) -> Result<serde_json::Value> {
        let envelope = ServiceRouterRequest::new(GENERATE_PROPOSAL, request).map_err(|e| {
            crate::error::ForceError::Serialization(crate::error::SerializationError::from(e))
        })?;

        self.service_router_post(GENERATE_PROPOSAL, &envelope).await
    }
}

#[cfg(test)]
mod tests {
    use super::GENERATE_PROPOSAL;
    use crate::api::cpq::GenerateDocumentRequest;
    use crate::test_support::{MockAuthenticator, Must};
    use wiremock::matchers::{method, path, query_param};
    use wiremock::{Mock, MockServer, ResponseTemplate};

    async fn setup() -> (MockServer, crate::client::ForceClient<MockAuthenticator>) {
        let server = MockServer::start().await;
        let auth = MockAuthenticator::new("test_token", &server.uri());
        let client = crate::client::builder()
            .authenticate(auth)
            .build()
            .await
            .must();
        (server, client)
    }

    #[tokio::test]
    async fn test_generate_document_success() {
        let (server, client) = setup().await;

        Mock::given(method("POST"))
            .and(path("/services/apexrest/SBQQ/ServiceRouter"))
            .and(query_param("loader", GENERATE_PROPOSAL))
            .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
                "documentId": "069000000000001AAA",
                "status": "Generated",
                "contentVersionId": "068000000000001AAA"
            })))
            .mount(&server)
            .await;

        let request = GenerateDocumentRequest::new("a0x000000000001AAA")
            .with_template("a0z000000000001AAA")
            .with_format("pdf");

        let result = client.cpq().generate_document(&request).await.must();
        assert_eq!(result["documentId"], "069000000000001AAA");
        assert_eq!(result["status"], "Generated");
    }

    #[tokio::test]
    async fn test_generate_document_minimal_request() {
        let (server, client) = setup().await;

        Mock::given(method("POST"))
            .and(path("/services/apexrest/SBQQ/ServiceRouter"))
            .and(query_param("loader", GENERATE_PROPOSAL))
            .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
                "documentId": "069000000000001AAA",
                "status": "Generated"
            })))
            .mount(&server)
            .await;

        let request = GenerateDocumentRequest::new("a0x000000000001AAA");
        let result = client.cpq().generate_document(&request).await.must();
        assert_eq!(result["status"], "Generated");
    }

    #[tokio::test]
    async fn test_generate_document_error() {
        let (server, client) = setup().await;

        Mock::given(method("POST"))
            .and(path("/services/apexrest/SBQQ/ServiceRouter"))
            .and(query_param("loader", GENERATE_PROPOSAL))
            .respond_with(ResponseTemplate::new(400).set_body_json(serde_json::json!({
                "message": "Template not found",
                "errorCode": "INVALID_TEMPLATE"
            })))
            .mount(&server)
            .await;

        let request =
            GenerateDocumentRequest::new("a0x000000000001AAA").with_template("invalid_template");

        let result = client.cpq().generate_document(&request).await;
        assert!(result.is_err());
    }
}