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

// Copyright Materialize, Inc. and contributors. All rights reserved.
//
// Use of this software is governed by the Business Source License
// included in the LICENSE file.
//
// As of the Change Date specified in that file, in accordance with
// the Business Source License, use of this software will be governed
// by the Apache License, Version 2.0.

#![warn(missing_docs)]

//! A client to interact with the Materialize Cloud API.
//!
//! # Example
//!
//! ```ignore
//! use mz_cloud_api::client::{Client};
//! use mz_cloud_api::config::{ClientBuilder, ClientConfig};
//! use mz_frontegg_client::client::{Client as FronteggClient};
//! use mz_frontegg_auth::AppPassword;
//!
//! // Build the Frontegg Client
//! let frontegg_client: FronteggClient;
//!
//! let config = ClientConfig { frontegg_client };
//!
//! let client = ClientBuilder::default()
//!     .build(config);
//!
//! // List all the available providers
//! let cloud_providers = client.list_cloud_regions().await.unwrap();
//! ```
//!
//! ## Implementation
//!
//! It is divided into three modules: [client], [config], [error]
//!
//! ## Error
//!
//! The [error] crate contains the definitions and structures for all possible errors.
//!
//! ## Client
//!
//! The Materialize cloud API capabilities are provided by the [client] module.
//!
//! ## Config
//!
//! The client's builder, instantiation and  configuration reside in the [config] module.
//! Every client requires an optional endpoint, otherwise, you can use the default.
//!
//! ## Note
//!
//! This crate is implemented following a similar pattern to [`mz-frontegg-client`], [rust-orb-billing] and [rust-frontegg].
//!
//! [mz-frontegg-client]:
//! [rust-orb-billing]: <https://github.com/MaterializeInc/rust-orb-billing>
//! [rust-frontegg]: <https://github.com/MaterializeInc/rust-frontegg>

pub mod client;
pub mod config;
pub mod error;