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

//! Composite API resources.
//!
//! The Composite resource is an enhanced REST API that allows you to execute
//! sequential and dependent requests in a single call.
//!
//! This module provides the `CompositeHandler` which serves as the entry point
//! for composite operations like `batch` and `graph`.

pub(crate) mod batch;
#[cfg(feature = "composite_graph")]
pub(crate) mod graph;
#[cfg(feature = "composite")]
pub(crate) mod query_batch;
#[cfg(feature = "composite")]
pub(crate) mod soql_mass_op;

pub use batch::{BatchRequest, BatchResponse, BatchSubResponse};
#[cfg(feature = "composite_graph")]
pub use graph::{
    CompositeGraphRequest, Graph, GraphErrorResponse, GraphRequest, GraphResponse, GraphResult,
    GraphSubResponse,
};
#[cfg(feature = "composite")]
pub use query_batch::{BatchOp, BatchStats, QueryBatch};
#[cfg(feature = "composite")]
pub use soql_mass_op::SoqlMassOp;

use crate::auth::Authenticator;
use crate::session::Session;
use std::sync::Arc;

/// Composite API handler for Salesforce.
///
/// Provides access to the Composite API resources.
#[derive(Debug)]
pub struct CompositeHandler<A: Authenticator> {
    pub(crate) inner: Arc<Session<A>>,
}

impl<A: Authenticator> Clone for CompositeHandler<A> {
    fn clone(&self) -> Self {
        Self {
            inner: Arc::clone(&self.inner),
        }
    }
}

impl<A: Authenticator> CompositeHandler<A> {
    /// Creates a new Composite handler.
    #[must_use]
    pub(crate) fn new(inner: Arc<Session<A>>) -> Self {
        Self { inner }
    }

    /// Creates a new batch request.
    ///
    /// A batch request can contain up to 25 subrequests. Subrequests are independent
    /// and can be of different types (GET, POST, PATCH, DELETE).
    ///
    /// # Examples
    ///
    /// ```ignore
    /// let batch = client.composite().batch();
    /// batch.get("Account", "001...");
    /// batch.post("Contact", json!({...}));
    /// let results = batch.execute().await?;
    /// ```
    #[must_use]
    pub fn batch(&self) -> batch::BatchRequest<A> {
        batch::BatchRequest::new(self.clone())
    }

    /// Creates a new graph request.
    ///
    /// The Composite Graph API allows you to execute complex, dependent requests
    /// (up to 500 nodes) in a single call.
    #[cfg(feature = "composite_graph")]
    #[must_use]
    pub fn graph(&self) -> graph::CompositeGraphRequest<A> {
        graph::CompositeGraphRequest::new(self.clone())
    }
}