Environment

Enum Environment 

Source
pub enum Environment {
    PRODUCTION,
    SANDBOX,
}
Expand description

Represents the QuickBooks API environment.

QuickBooks provides two environments:

  • SANDBOX: For development and testing, uses sandbox URLs and data
  • PRODUCTION: For live applications, uses production URLs and real data

The environment determines which API endpoints are used for all operations.

§Examples

use quick_oxibooks::Environment;

// For development
let env = Environment::SANDBOX;

// For production
let env = Environment::PRODUCTION;

// Default is SANDBOX for safety
let default_env = Environment::default();
assert_eq!(default_env, Environment::SANDBOX);

Variants§

§

PRODUCTION

Production environment for live QuickBooks data

§

SANDBOX

Sandbox environment for development and testing (default)

Implementations§

Source§

impl Environment

Source

pub fn discovery_url(&self) -> &'static str

Returns the OAuth 2.0 discovery URL for the environment.

The discovery URL provides OAuth endpoints and configuration for authentication.

§Returns

A static string containing the discovery URL for the environment.

Source

pub fn migration_url(&self) -> &'static str

Returns the token migration URL for the environment.

Used for migrating OAuth 1.0 tokens to OAuth 2.0.

§Returns

A static string containing the migration URL for the environment.

Source

pub fn user_info_url(&self) -> &'static str

Returns the user info URL for the environment.

Used to retrieve user information from the OpenID Connect userinfo endpoint.

§Returns

A static string containing the user info URL for the environment.

Source

pub fn endpoint_url(&self) -> &'static str

Returns the base API endpoint URL for the environment.

This is the root URL for all QuickBooks API operations (CRUD, queries, reports, etc.).

§Returns

A static string containing the API endpoint URL for the environment.

Trait Implementations§

Source§

impl Clone for Environment

Source§

fn clone(&self) -> Environment

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Environment

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Environment

Source§

fn default() -> Environment

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Environment

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Environment

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for Environment

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Copy for Environment

Source§

impl StructuralPartialEq for Environment

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,