a2a-ap2 0.3.1

AP2 (Agent Payments Protocol) extension for the A2A Protocol
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

//! # a2a-ap2 — Agent Payments Protocol extension for A2A
//!
//! This crate implements the [AP2 (Agent Payments Protocol) v0.1](https://ap2-protocol.org/)
//! as a companion library to [`a2a-rs`]. It provides:
//!
//! - Strongly-typed Rust models for all AP2 types (mandates, payment requests,
//!   receipts, roles)
//! - Helpers for embedding AP2 data into A2A `Message` and `Artifact` parts
//! - Helpers for extracting AP2 data from A2A parts
//! - `AgentExtension` builders for declaring AP2 support in `AgentCard`s
//! - Validation for all AP2 types
//!
//! ## Quick Start
//!
//! ```rust
//! use a2a_ap2::{
//!     IntentMandate, intent_mandate_message,
//!     ap2_extension, Ap2Role,
//! };
//!
//! // Declare AP2 support in an agent card
//! let ext = ap2_extension(vec![Ap2Role::Shopper], false);
//!
//! // Create an intent mandate and wrap it in an A2A message
//! let intent = IntentMandate {
//!     user_cart_confirmation_required: true,
//!     natural_language_description: "Buy red shoes under $100".into(),
//!     merchants: None,
//!     skus: None,
//!     requires_refundability: Some(true),
//!     intent_expiry: "2026-12-31T23:59:59Z".into(),
//! };
//! let message = intent_mandate_message(&intent, "msg-1".into()).unwrap();
//! ```

pub mod error;
pub mod extension;
pub mod helpers;
pub mod types;
pub mod validation;

// Re-export types at crate root for convenience.
pub use error::{Ap2Error, Result};

pub use types::{
    // Constants
    AP2_EXTENSION_URI,
    Ap2Role,
    CART_MANDATE_DATA_KEY,
    CartContents,
    CartMandate,
    ContactAddress,
    // Receipt variant structs
    Error,
    Failure,
    INTENT_MANDATE_DATA_KEY,
    IntentMandate,
    PAYMENT_MANDATE_DATA_KEY,
    PAYMENT_RECEIPT_DATA_KEY,
    PaymentCurrencyAmount,
    PaymentDetailsInit,
    PaymentDetailsModifier,
    PaymentItem,
    PaymentMandate,
    PaymentMandateContents,
    PaymentMethodData,
    PaymentOptions,
    PaymentReceipt,
    PaymentRequest,
    PaymentResponse,
    PaymentShippingOption,
    PaymentStatus,
    RISK_DATA_KEY,
    Success,
};

pub use helpers::{
    cart_mandate_artifact, cart_mandate_to_part, extract_cart_mandate, extract_intent_mandate,
    extract_payment_mandate, extract_payment_receipt, find_cart_mandate, find_intent_mandate,
    find_payment_mandate, find_payment_receipt_in_parts, intent_mandate_message,
    intent_mandate_to_part, payment_mandate_message, payment_mandate_to_part,
    payment_receipt_to_part, risk_data_to_part,
};

pub use extension::{ap2_extension, get_ap2_roles, has_ap2_role, supports_ap2, with_ap2};

pub use validation::Validate;