Struct DiscoveryDoc 

pub struct DiscoveryDoc {
    pub issuer: String,
    pub authorization_endpoint: String,
    pub token_endpoint: String,
    pub userinfo_endpoint: String,
    pub revocation_endpoint: String,
    pub jwks_uri: String,
    pub response_types_supported: Vec<String>,
    pub subject_types_supported: Vec<String>,
    pub id_token_signing_alg_values_supported: Vec<String>,
    pub scopes_supported: Vec<String>,
    pub token_endpoint_auth_methods_supported: Vec<String>,
    pub claims_supported: Vec<String>,
}

OAuth 2.0 discovery document for QuickBooks API.

Contains OAuth 2.0 endpoint URLs and supported capabilities discovered from the QuickBooks OAuth discovery endpoint. This is automatically fetched when creating a QBContext and used for authentication flows.

Fields

• issuer: The OAuth 2.0 issuer identifier
• authorization_endpoint: URL for user authorization
• token_endpoint: URL for token exchange
• userinfo_endpoint: URL for retrieving user information
• revocation_endpoint: URL for token revocation
• jwks_uri: URL for JSON Web Key Set
• Various supported capabilities arrays

Examples

use quick_oxibooks::{DiscoveryDoc, Environment};
use ureq::Agent;

let client = Agent::new_with_defaults();
let discovery = DiscoveryDoc::get(Environment::SANDBOX, &client).unwrap();
println!("Token endpoint: {}", discovery.token_endpoint);

Fields

issuer: String

authorization_endpoint: String

token_endpoint: String

userinfo_endpoint: String

revocation_endpoint: String

jwks_uri: String

response_types_supported: Vec<String>

subject_types_supported: Vec<String>

id_token_signing_alg_values_supported: Vec<String>

scopes_supported: Vec<String>

token_endpoint_auth_methods_supported: Vec<String>

claims_supported: Vec<String>

Implementations

impl DiscoveryDoc

pub fn get(environment: Environment, client: &Agent) -> APIResult<Self>

Fetches the OAuth 2.0 discovery document from QuickBooks.

This method makes an HTTP request to the QuickBooks discovery endpoint to retrieve OAuth 2.0 configuration and supported capabilities.

Parameters

• environment: The QuickBooks environment (sandbox or production)
• client: HTTP client for making the request

Returns

Returns the parsed discovery document on success, or an APIError on failure.

Errors

• Network errors when fetching the discovery document
• JSON parsing errors if the response format is invalid
• HTTP errors if the discovery endpoint returns an error response

Examples

use quick_oxibooks::{DiscoveryDoc, Environment};
use ureq::Agent;

let client = Agent::new_with_defaults();
let discovery = DiscoveryDoc::get(Environment::SANDBOX, &client).unwrap();

Trait Implementations

impl Clone for DiscoveryDoc

fn clone(&self) -> DiscoveryDoc

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DiscoveryDoc

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DiscoveryDoc

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for DiscoveryDoc

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for DiscoveryDoc

fn cmp(&self, other: &DiscoveryDoc) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for DiscoveryDoc

fn eq(&self, other: &DiscoveryDoc) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for DiscoveryDoc

fn partial_cmp(&self, other: &DiscoveryDoc) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for DiscoveryDoc

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for DiscoveryDoc

impl StructuralPartialEq for DiscoveryDoc