Skip to main content

netbox/
lib.rs

1#![doc = include_str!("../docs/client.md")]
2#![warn(missing_docs)]
3#![warn(clippy::all)]
4
5mod client;
6mod config;
7mod error;
8mod hooks;
9mod pagination;
10mod query;
11mod resource;
12
13// api endpoint modules
14/// circuits and provider resources.
15pub mod circuits;
16/// core endpoints and system resources.
17pub mod core;
18/// dcim endpoints.
19pub mod dcim;
20/// extras endpoints (tags, webhooks, scripts, custom fields).
21pub mod extras;
22/// graphql query helper.
23pub mod graphql;
24/// ipam endpoints.
25pub mod ipam;
26/// plugin endpoints.
27pub mod plugins;
28/// schema endpoint.
29pub mod schema;
30/// status endpoint.
31pub mod status;
32/// tenancy endpoints.
33pub mod tenancy;
34/// users and auth endpoints.
35pub mod users;
36/// virtualization endpoints.
37pub mod virtualization;
38/// vpn endpoints.
39pub mod vpn;
40/// wireless endpoints.
41pub mod wireless;
42
43pub use client::Client;
44pub use config::ClientConfig;
45pub use error::{Error, Result};
46pub use hooks::HttpHooks;
47pub use pagination::{Page, Paginator};
48pub use query::QueryBuilder;
49pub use resource::{BulkDelete, BulkUpdate, Resource};
50
51/// generated openapi types and api functions.
52pub mod openapi {
53    pub use netbox_openapi::apis;
54    pub use netbox_openapi::models;
55}
56
57// re-export the generated models for convenience
58pub use netbox_openapi::models;