OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-02-23 15:49:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

make regen-apis

Browse Source
This commit is contained in:
OMGeeky
2024-05-16 21:23:40 +02:00
parent 52d2e89e51
commit ad85cafeef
5108 changed files with 1615625 additions and 992044 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
gen/gmailpostmastertools1/Cargo.toml
View File

@@ -4,12 +4,12 @@
[package]
name = "google-gmailpostmastertools1"
version = "5.0.4+20240303"
version = "5.0.5+20240418"
authors = ["Sebastian Thiel <byronimo@gmail.com>"]
description = "A complete library to interact with Postmaster Tools (protocol v1)"
repository = "https://github.com/Byron/google-apis-rs/tree/main/gen/gmailpostmastertools1"
homepage = "https://developers.google.com/gmail/postmaster"
documentation = "https://docs.rs/google-gmailpostmastertools1/5.0.4+20240303"
documentation = "https://docs.rs/google-gmailpostmastertools1/5.0.5+20240418"
license = "MIT"
keywords = ["gmailpostmastertools", "google", "protocol", "web", "api"]
autobins = false
@@ -18,12 +18,12 @@ edition = "2018"
[dependencies]
anyhow = "^ 1.0"
hyper-rustls = "0.24.0"
hyper-rustls = "0.25.0"
mime = "^ 0.3.0"
serde = { version = "^ 1.0", features = ["derive"] }
serde_json = "^ 1.0"
itertools = "^ 0.10"
google-apis-common = { path = "../../google-apis-common", version = "6.0" }
google-apis-common = { path = "../../google-apis-common", version = "6.0.3" }
hyper = "^ 0.14"
http = "^0.2"
tokio = "^1.0"

2
gen/gmailpostmastertools1/LICENSE.md
View File

@@ -6,7 +6,7 @@ DO NOT EDIT !
The MIT License (MIT)
=====================
Copyright © `2015-2020` `Sebastian Thiel`
Copyright 2015–2024 Sebastian Thiel
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation

69
gen/gmailpostmastertools1/README.md
View File

@@ -5,16 +5,16 @@ DO NOT EDIT !
-->
The `google-gmailpostmastertools1` library allows access to all features of the *Google Postmaster Tools* service.
This documentation was generated from *Postmaster Tools* crate version *5.0.4+20240303*, where *20240303* is the exact revision of the *gmailpostmastertools:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v5.0.4*.
This documentation was generated from *Postmaster Tools* crate version *5.0.5+20240418*, where *20240418* is the exact revision of the *gmailpostmastertools:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v5.0.5*.
Everything else about the *Postmaster Tools* *v1* API can be found at the
[official documentation site](https://developers.google.com/gmail/postmaster).
# Features
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-gmailpostmastertools1/5.0.4+20240303/google_gmailpostmastertools1/PostmasterTools) ...
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-gmailpostmastertools1/5.0.5+20240418/google_gmailpostmastertools1/PostmasterTools) ...
* [domains](https://docs.rs/google-gmailpostmastertools1/5.0.4+20240303/google_gmailpostmastertools1/api::Domain)
* [*get*](https://docs.rs/google-gmailpostmastertools1/5.0.4+20240303/google_gmailpostmastertools1/api::DomainGetCall), [*list*](https://docs.rs/google-gmailpostmastertools1/5.0.4+20240303/google_gmailpostmastertools1/api::DomainListCall), [*traffic stats get*](https://docs.rs/google-gmailpostmastertools1/5.0.4+20240303/google_gmailpostmastertools1/api::DomainTrafficStatGetCall) and [*traffic stats list*](https://docs.rs/google-gmailpostmastertools1/5.0.4+20240303/google_gmailpostmastertools1/api::DomainTrafficStatListCall)
* [domains](https://docs.rs/google-gmailpostmastertools1/5.0.5+20240418/google_gmailpostmastertools1/api::Domain)
* [*get*](https://docs.rs/google-gmailpostmastertools1/5.0.5+20240418/google_gmailpostmastertools1/api::DomainGetCall), [*list*](https://docs.rs/google-gmailpostmastertools1/5.0.5+20240418/google_gmailpostmastertools1/api::DomainListCall), [*traffic stats get*](https://docs.rs/google-gmailpostmastertools1/5.0.5+20240418/google_gmailpostmastertools1/api::DomainTrafficStatGetCall) and [*traffic stats list*](https://docs.rs/google-gmailpostmastertools1/5.0.5+20240418/google_gmailpostmastertools1/api::DomainTrafficStatListCall)
@@ -23,17 +23,17 @@ Handle the following *Resources* with ease from the central [hub](https://docs.r
The API is structured into the following primary items:
* **[Hub](https://docs.rs/google-gmailpostmastertools1/5.0.4+20240303/google_gmailpostmastertools1/PostmasterTools)**
* **[Hub](https://docs.rs/google-gmailpostmastertools1/5.0.5+20240418/google_gmailpostmastertools1/PostmasterTools)**
* a central object to maintain state and allow accessing all *Activities*
* creates [*Method Builders*](https://docs.rs/google-gmailpostmastertools1/5.0.4+20240303/google_gmailpostmastertools1/client::MethodsBuilder) which in turn
allow access to individual [*Call Builders*](https://docs.rs/google-gmailpostmastertools1/5.0.4+20240303/google_gmailpostmastertools1/client::CallBuilder)
* **[Resources](https://docs.rs/google-gmailpostmastertools1/5.0.4+20240303/google_gmailpostmastertools1/client::Resource)**
* creates [*Method Builders*](https://docs.rs/google-gmailpostmastertools1/5.0.5+20240418/google_gmailpostmastertools1/client::MethodsBuilder) which in turn
allow access to individual [*Call Builders*](https://docs.rs/google-gmailpostmastertools1/5.0.5+20240418/google_gmailpostmastertools1/client::CallBuilder)
* **[Resources](https://docs.rs/google-gmailpostmastertools1/5.0.5+20240418/google_gmailpostmastertools1/client::Resource)**
* primary types that you can apply *Activities* to
* a collection of properties and *Parts*
* **[Parts](https://docs.rs/google-gmailpostmastertools1/5.0.4+20240303/google_gmailpostmastertools1/client::Part)**
* **[Parts](https://docs.rs/google-gmailpostmastertools1/5.0.5+20240418/google_gmailpostmastertools1/client::Part)**
* a collection of properties
* never directly used in *Activities*
* **[Activities](https://docs.rs/google-gmailpostmastertools1/5.0.4+20240303/google_gmailpostmastertools1/client::CallBuilder)**
* **[Activities](https://docs.rs/google-gmailpostmastertools1/5.0.5+20240418/google_gmailpostmastertools1/client::CallBuilder)**
* operations to apply to *Resources*
All *structures* are marked with applicable traits to further categorize them and ease browsing.
@@ -53,8 +53,8 @@ let r = hub.domains().get(...).doit().await
let r = hub.domains().list(...).doit().await
```
The `resource()` and `activity(...)` calls create [builders][builder-pattern]. The second one dealing with `Activities`
supports various methods to configure the impending operation (not shown here). It is made such that all required arguments have to be
The `resource()` and `activity(...)` calls create [builders][builder-pattern]. The second one dealing with `Activities`
supports various methods to configure the impending operation (not shown here). It is made such that all required arguments have to be
specified right away (i.e. `(...)`), whereas all optional ones can be [build up][builder-pattern] as desired.
The `doit()` method performs the actual communication with the server and returns the respective result.
@@ -78,22 +78,23 @@ extern crate hyper;
extern crate hyper_rustls;
extern crate google_gmailpostmastertools1 as gmailpostmastertools1;
use gmailpostmastertools1::{Result, Error};
use gmailpostmastertools1::api::enums::*;
use std::default::Default;
use gmailpostmastertools1::{PostmasterTools, oauth2, hyper, hyper_rustls, chrono, FieldMask};
// Get an ApplicationSecret instance by some means. It contains the `client_id` and
// Get an ApplicationSecret instance by some means. It contains the `client_id` and
// `client_secret`, among other things.
let secret: oauth2::ApplicationSecret = Default::default();
// Instantiate the authenticator. It will choose a suitable authentication flow for you,
// Instantiate the authenticator. It will choose a suitable authentication flow for you,
// unless you replace `None` with the desired Flow.
// Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about
// Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about
// what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
// retrieve them from storage.
let auth = oauth2::InstalledFlowAuthenticator::builder(
secret,
oauth2::InstalledFlowReturnMethod::HTTPRedirect,
).build().await.unwrap();
let mut hub = PostmasterTools::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
let mut hub = PostmasterTools::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
@@ -129,49 +130,49 @@ match result {
```
## Handling Errors
All errors produced by the system are provided either as [Result](https://docs.rs/google-gmailpostmastertools1/5.0.4+20240303/google_gmailpostmastertools1/client::Result) enumeration as return value of
the doit() methods, or handed as possibly intermediate results to either the
[Hub Delegate](https://docs.rs/google-gmailpostmastertools1/5.0.4+20240303/google_gmailpostmastertools1/client::Delegate), or the [Authenticator Delegate](https://docs.rs/yup-oauth2/*/yup_oauth2/trait.AuthenticatorDelegate.html).
All errors produced by the system are provided either as [Result](https://docs.rs/google-gmailpostmastertools1/5.0.5+20240418/google_gmailpostmastertools1/client::Result) enumeration as return value of
the doit() methods, or handed as possibly intermediate results to either the
[Hub Delegate](https://docs.rs/google-gmailpostmastertools1/5.0.5+20240418/google_gmailpostmastertools1/client::Delegate), or the [Authenticator Delegate](https://docs.rs/yup-oauth2/*/yup_oauth2/trait.AuthenticatorDelegate.html).
When delegates handle errors or intermediate values, they may have a chance to instruct the system to retry. This
When delegates handle errors or intermediate values, they may have a chance to instruct the system to retry. This
makes the system potentially resilient to all kinds of errors.
## Uploads and Downloads
If a method supports downloads, the response body, which is part of the [Result](https://docs.rs/google-gmailpostmastertools1/5.0.4+20240303/google_gmailpostmastertools1/client::Result), should be
If a method supports downloads, the response body, which is part of the [Result](https://docs.rs/google-gmailpostmastertools1/5.0.5+20240418/google_gmailpostmastertools1/client::Result), should be
read by you to obtain the media.
If such a method also supports a [Response Result](https://docs.rs/google-gmailpostmastertools1/5.0.4+20240303/google_gmailpostmastertools1/client::ResponseResult), it will return that by default.
If such a method also supports a [Response Result](https://docs.rs/google-gmailpostmastertools1/5.0.5+20240418/google_gmailpostmastertools1/client::ResponseResult), it will return that by default.
You can see it as meta-data for the actual media. To trigger a media download, you will have to set up the builder by making
this call: `.param("alt", "media")`.
Methods supporting uploads can do so using up to 2 different protocols:
*simple* and *resumable*. The distinctiveness of each is represented by customized
Methods supporting uploads can do so using up to 2 different protocols:
*simple* and *resumable*. The distinctiveness of each is represented by customized
`doit(...)` methods, which are then named `upload(...)` and `upload_resumable(...)` respectively.
## Customization and Callbacks
You may alter the way an `doit()` method is called by providing a [delegate](https://docs.rs/google-gmailpostmastertools1/5.0.4+20240303/google_gmailpostmastertools1/client::Delegate) to the
[Method Builder](https://docs.rs/google-gmailpostmastertools1/5.0.4+20240303/google_gmailpostmastertools1/client::CallBuilder) before making the final `doit()` call.
Respective methods will be called to provide progress information, as well as determine whether the system should
You may alter the way an `doit()` method is called by providing a [delegate](https://docs.rs/google-gmailpostmastertools1/5.0.5+20240418/google_gmailpostmastertools1/client::Delegate) to the
[Method Builder](https://docs.rs/google-gmailpostmastertools1/5.0.5+20240418/google_gmailpostmastertools1/client::CallBuilder) before making the final `doit()` call.
Respective methods will be called to provide progress information, as well as determine whether the system should
retry on failure.
The [delegate trait](https://docs.rs/google-gmailpostmastertools1/5.0.4+20240303/google_gmailpostmastertools1/client::Delegate) is default-implemented, allowing you to customize it with minimal effort.
The [delegate trait](https://docs.rs/google-gmailpostmastertools1/5.0.5+20240418/google_gmailpostmastertools1/client::Delegate) is default-implemented, allowing you to customize it with minimal effort.
## Optional Parts in Server-Requests
All structures provided by this library are made to be [encodable](https://docs.rs/google-gmailpostmastertools1/5.0.4+20240303/google_gmailpostmastertools1/client::RequestValue) and
[decodable](https://docs.rs/google-gmailpostmastertools1/5.0.4+20240303/google_gmailpostmastertools1/client::ResponseResult) via *json*. Optionals are used to indicate that partial requests are responses
All structures provided by this library are made to be [encodable](https://docs.rs/google-gmailpostmastertools1/5.0.5+20240418/google_gmailpostmastertools1/client::RequestValue) and
[decodable](https://docs.rs/google-gmailpostmastertools1/5.0.5+20240418/google_gmailpostmastertools1/client::ResponseResult) via *json*. Optionals are used to indicate that partial requests are responses
are valid.
Most optionals are are considered [Parts](https://docs.rs/google-gmailpostmastertools1/5.0.4+20240303/google_gmailpostmastertools1/client::Part) which are identifiable by name, which will be sent to
Most optionals are are considered [Parts](https://docs.rs/google-gmailpostmastertools1/5.0.5+20240418/google_gmailpostmastertools1/client::Part) which are identifiable by name, which will be sent to
the server to indicate either the set parts of the request or the desired parts in the response.
## Builder Arguments
Using [method builders](https://docs.rs/google-gmailpostmastertools1/5.0.4+20240303/google_gmailpostmastertools1/client::CallBuilder), you are able to prepare an action call by repeatedly calling it's methods.
Using [method builders](https://docs.rs/google-gmailpostmastertools1/5.0.5+20240418/google_gmailpostmastertools1/client::CallBuilder), you are able to prepare an action call by repeatedly calling it's methods.
These will always take a single argument, for which the following statements are true.
* [PODs][wiki-pod] are handed by copy
* strings are passed as `&str`
* [request values](https://docs.rs/google-gmailpostmastertools1/5.0.4+20240303/google_gmailpostmastertools1/client::RequestValue) are moved
* [request values](https://docs.rs/google-gmailpostmastertools1/5.0.5+20240418/google_gmailpostmastertools1/client::RequestValue) are moved
Arguments will always be copied or cloned into the builder, to make them independent of their original life times.
@@ -180,7 +181,7 @@ Arguments will always be copied or cloned into the builder, to make them indepen
[google-go-api]: https://github.com/google/google-api-go-client
# License
The **gmailpostmastertools1** library was generated by Sebastian Thiel, and is placed
The **gmailpostmastertools1** library was generated by Sebastian Thiel, and is placed
under the *MIT* license.
You can read the full text at the repository's [license file][repo-license].

585
gen/gmailpostmastertools1/src/api.rs → gen/gmailpostmastertools1/src/api/call_builders.rs
View File

@@ -1,507 +1,4 @@
use std::collections::HashMap;
use std::cell::RefCell;
use std::default::Default;
use std::collections::BTreeSet;
use std::error::Error as StdError;
use serde_json as json;
use std::io;
use std::fs;
use std::mem;
use hyper::client::connect;
use tokio::io::{AsyncRead, AsyncWrite};
use tokio::time::sleep;
use tower_service;
use serde::{Serialize, Deserialize};
use crate::{client, client::GetToken, client::serde_with};
// ##############
// UTILITIES ###
// ############
/// Identifies the an OAuth2 authorization scope.
/// A scope is needed when requesting an
/// [authorization token](https://developers.google.com/youtube/v3/guides/authentication).
#[derive(PartialEq, Eq, Ord, PartialOrd, Hash, Debug, Clone, Copy)]
pub enum Scope {
/// See email traffic metrics for the domains you have registered in Gmail Postmaster Tools
PostmasterReadonly,
}
impl AsRef<str> for Scope {
fn as_ref(&self) -> &str {
match *self {
Scope::PostmasterReadonly => "https://www.googleapis.com/auth/postmaster.readonly",
}
}
}
impl Default for Scope {
fn default() -> Scope {
Scope::PostmasterReadonly
}
}
// ########
// HUB ###
// ######
/// Central instance to access all PostmasterTools related resource activities
///
/// # Examples
///
/// Instantiate a new hub
///
/// ```test_harness,no_run
/// extern crate hyper;
/// extern crate hyper_rustls;
/// extern crate google_gmailpostmastertools1 as gmailpostmastertools1;
/// use gmailpostmastertools1::{Result, Error};
/// # async fn dox() {
/// use std::default::Default;
/// use gmailpostmastertools1::{PostmasterTools, oauth2, hyper, hyper_rustls, chrono, FieldMask};
///
/// // Get an ApplicationSecret instance by some means. It contains the `client_id` and
/// // `client_secret`, among other things.
/// let secret: oauth2::ApplicationSecret = Default::default();
/// // Instantiate the authenticator. It will choose a suitable authentication flow for you,
/// // unless you replace `None` with the desired Flow.
/// // Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about
/// // what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
/// // retrieve them from storage.
/// let auth = oauth2::InstalledFlowAuthenticator::builder(
/// secret,
/// oauth2::InstalledFlowReturnMethod::HTTPRedirect,
/// ).build().await.unwrap();
/// let mut hub = PostmasterTools::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
/// // You can configure optional parameters by calling the respective setters at will, and
/// // execute the final call using `doit()`.
/// // Values shown here are possibly random and not representative !
/// let result = hub.domains().traffic_stats_list("parent")
/// .start_date_year(-55)
/// .start_date_month(-88)
/// .start_date_day(-47)
/// .page_token("duo")
/// .page_size(-50)
/// .end_date_year(-93)
/// .end_date_month(-37)
/// .end_date_day(-12)
/// .doit().await;
///
/// match result {
/// Err(e) => match e {
/// // The Error enum provides details about what exactly happened.
/// // You can also just use its `Debug`, `Display` or `Error` traits
/// Error::HttpError(_)
/// |Error::Io(_)
/// |Error::MissingAPIKey
/// |Error::MissingToken(_)
/// |Error::Cancelled
/// |Error::UploadSizeLimitExceeded(_, _)
/// |Error::Failure(_)
/// |Error::BadRequest(_)
/// |Error::FieldClash(_)
/// |Error::JsonDecodeError(_, _) => println!("{}", e),
/// },
/// Ok(res) => println!("Success: {:?}", res),
/// }
/// # }
/// ```
#[derive(Clone)]
pub struct PostmasterTools<S> {
pub client: hyper::Client<S, hyper::body::Body>,
pub auth: Box<dyn client::GetToken>,
_user_agent: String,
_base_url: String,
_root_url: String,
}
impl<'a, S> client::Hub for PostmasterTools<S> {}
impl<'a, S> PostmasterTools<S> {
pub fn new<A: 'static + client::GetToken>(client: hyper::Client<S, hyper::body::Body>, auth: A) -> PostmasterTools<S> {
PostmasterTools {
client,
auth: Box::new(auth),
_user_agent: "google-api-rust-client/5.0.4".to_string(),
_base_url: "https://gmailpostmastertools.googleapis.com/".to_string(),
_root_url: "https://gmailpostmastertools.googleapis.com/".to_string(),
}
}
pub fn domains(&'a self) -> DomainMethods<'a, S> {
DomainMethods { hub: &self }
}
/// Set the user-agent header field to use in all requests to the server.
/// It defaults to `google-api-rust-client/5.0.4`.
///
/// Returns the previously set user-agent.
pub fn user_agent(&mut self, agent_name: String) -> String {
mem::replace(&mut self._user_agent, agent_name)
}
/// Set the base url to use in all requests to the server.
/// It defaults to `https://gmailpostmastertools.googleapis.com/`.
///
/// Returns the previously set base url.
pub fn base_url(&mut self, new_base_url: String) -> String {
mem::replace(&mut self._base_url, new_base_url)
}
/// Set the root url to use in all requests to the server.
/// It defaults to `https://gmailpostmastertools.googleapis.com/`.
///
/// Returns the previously set root url.
pub fn root_url(&mut self, new_root_url: String) -> String {
mem::replace(&mut self._root_url, new_root_url)
}
}
// ############
// SCHEMAS ###
// ##########
/// Metric on a particular delivery error type.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct DeliveryError {
/// The class of delivery error.
#[serde(rename="errorClass")]
pub error_class: Option<String>,
/// The ratio of messages where the error occurred vs all authenticated traffic.
#[serde(rename="errorRatio")]
pub error_ratio: Option<f64>,
/// The type of delivery error.
#[serde(rename="errorType")]
pub error_type: Option<String>,
}
impl client::Part for DeliveryError {}
/// A registered domain resource in the Postmaster API.
///
/// # Activities
///
/// This type is used in activities, which are methods you may call on this type or where this type is involved in.
/// The list links the activity name, along with information about where it is used (one of *request* and *response*).
///
/// * [traffic stats get domains](DomainTrafficStatGetCall) (none)
/// * [traffic stats list domains](DomainTrafficStatListCall) (none)
/// * [get domains](DomainGetCall) (response)
/// * [list domains](DomainListCall) (none)
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct Domain {
/// Timestamp when the user registered this domain. Assigned by the server.
#[serde(rename="createTime")]
pub create_time: Option<client::chrono::DateTime<client::chrono::offset::Utc>>,
/// The resource name of the Domain. Domain names have the form `domains/{domain_name}`, where domain_name is the fully qualified domain name (i.e., mymail.mydomain.com).
pub name: Option<String>,
/// User’s permission for this domain. Assigned by the server.
pub permission: Option<String>,
}
impl client::Resource for Domain {}
impl client::ResponseResult for Domain {}
/// [Feedback loop](https://support.google.com/mail/answer/6254652) identifier information.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct FeedbackLoop {
/// Feedback loop identifier that uniquely identifies individual campaigns.
pub id: Option<String>,
/// The ratio of user marked spam messages with the identifier vs the total number of inboxed messages with that identifier.
#[serde(rename="spamRatio")]
pub spam_ratio: Option<f64>,
}
impl client::Part for FeedbackLoop {}
/// IP Reputation information for a set of IPs in a specific reputation category.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct IpReputation {
/// Total number of unique IPs in this reputation category. This metric only pertains to traffic that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
#[serde(rename="ipCount")]
#[serde_as(as = "Option<::client::serde_with::DisplayFromStr>")]
pub ip_count: Option<i64>,
/// The reputation category this IP reputation represents.
pub reputation: Option<String>,
/// A sample of IPs in this reputation category.
#[serde(rename="sampleIps")]
pub sample_ips: Option<Vec<String>>,
}
impl client::Part for IpReputation {}
/// Response message for ListDomains.
///
/// # Activities
///
/// This type is used in activities, which are methods you may call on this type or where this type is involved in.
/// The list links the activity name, along with information about where it is used (one of *request* and *response*).
///
/// * [list domains](DomainListCall) (response)
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct ListDomainsResponse {
/// The list of domains.
pub domains: Option<Vec<Domain>>,
/// Token to retrieve the next page of results, or empty if there are no more results in the list.
#[serde(rename="nextPageToken")]
pub next_page_token: Option<String>,
}
impl client::ResponseResult for ListDomainsResponse {}
/// Response message for ListTrafficStats.
///
/// # Activities
///
/// This type is used in activities, which are methods you may call on this type or where this type is involved in.
/// The list links the activity name, along with information about where it is used (one of *request* and *response*).
///
/// * [traffic stats list domains](DomainTrafficStatListCall) (response)
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct ListTrafficStatsResponse {
/// Token to retrieve the next page of results, or empty if there are no more results in the list.
#[serde(rename="nextPageToken")]
pub next_page_token: Option<String>,
/// The list of TrafficStats.
#[serde(rename="trafficStats")]
pub traffic_stats: Option<Vec<TrafficStats>>,
}
impl client::ResponseResult for ListTrafficStatsResponse {}
/// Email traffic statistics pertaining to a specific date.
///
/// # Activities
///
/// This type is used in activities, which are methods you may call on this type or where this type is involved in.
/// The list links the activity name, along with information about where it is used (one of *request* and *response*).
///
/// * [traffic stats get domains](DomainTrafficStatGetCall) (response)
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct TrafficStats {
/// Delivery errors for the domain. This metric only pertains to traffic that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
#[serde(rename="deliveryErrors")]
pub delivery_errors: Option<Vec<DeliveryError>>,
/// The ratio of mail that successfully authenticated with DKIM vs. all mail that attempted to authenticate with [DKIM](http://www.dkim.org/). Spoofed mail is excluded.
#[serde(rename="dkimSuccessRatio")]
pub dkim_success_ratio: Option<f64>,
/// The ratio of mail that passed [DMARC](https://dmarc.org/) alignment checks vs all mail received from the domain that successfully authenticated with either of [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
#[serde(rename="dmarcSuccessRatio")]
pub dmarc_success_ratio: Option<f64>,
/// Reputation of the domain.
#[serde(rename="domainReputation")]
pub domain_reputation: Option<String>,
/// The ratio of incoming mail (to Gmail), that passed secure transport (TLS) vs all mail received from that domain. This metric only pertains to traffic that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
#[serde(rename="inboundEncryptionRatio")]
pub inbound_encryption_ratio: Option<f64>,
/// Reputation information pertaining to the IP addresses of the email servers for the domain. There is exactly one entry for each reputation category except REPUTATION_CATEGORY_UNSPECIFIED.
#[serde(rename="ipReputations")]
pub ip_reputations: Option<Vec<IpReputation>>,
/// The resource name of the traffic statistics. Traffic statistic names have the form `domains/{domain}/trafficStats/{date}`, where domain_name is the fully qualified domain name (i.e., mymail.mydomain.com) of the domain this traffic statistics pertains to and date is the date in yyyymmdd format that these statistics corresponds to. For example: domains/mymail.mydomain.com/trafficStats/20160807
pub name: Option<String>,
/// The ratio of outgoing mail (from Gmail) that was accepted over secure transport (TLS).
#[serde(rename="outboundEncryptionRatio")]
pub outbound_encryption_ratio: Option<f64>,
/// Spammy [Feedback loop identifiers] (https://support.google.com/mail/answer/6254652) with their individual spam rates. This metric only pertains to traffic that is authenticated by [DKIM](http://www.dkim.org/).
#[serde(rename="spammyFeedbackLoops")]
pub spammy_feedback_loops: Option<Vec<FeedbackLoop>>,
/// The ratio of mail that successfully authenticated with SPF vs. all mail that attempted to authenticate with [SPF](http://www.openspf.org/). Spoofed mail is excluded.
#[serde(rename="spfSuccessRatio")]
pub spf_success_ratio: Option<f64>,
/// The ratio of user-report spam vs. email that was sent to the inbox. This is potentially inexact -- users may want to refer to the description of the interval fields userReportedSpamRatioLowerBound and userReportedSpamRatioUpperBound for more explicit accuracy guarantees. This metric only pertains to emails authenticated by [DKIM](http://www.dkim.org/).
#[serde(rename="userReportedSpamRatio")]
pub user_reported_spam_ratio: Option<f64>,
/// The lower bound of the confidence interval for the user reported spam ratio. If this field is set, then the value of userReportedSpamRatio is set to the midpoint of this interval and is thus inexact. However, the true ratio is guaranteed to be in between this lower bound and the corresponding upper bound 95% of the time. This metric only pertains to emails authenticated by [DKIM](http://www.dkim.org/).
#[serde(rename="userReportedSpamRatioLowerBound")]
pub user_reported_spam_ratio_lower_bound: Option<f64>,
/// The upper bound of the confidence interval for the user reported spam ratio. If this field is set, then the value of userReportedSpamRatio is set to the midpoint of this interval and is thus inexact. However, the true ratio is guaranteed to be in between this upper bound and the corresponding lower bound 95% of the time. This metric only pertains to emails authenticated by [DKIM](http://www.dkim.org/).
#[serde(rename="userReportedSpamRatioUpperBound")]
pub user_reported_spam_ratio_upper_bound: Option<f64>,
}
impl client::ResponseResult for TrafficStats {}
// ###################
// MethodBuilders ###
// #################
/// A builder providing access to all methods supported on *domain* resources.
/// It is not used directly, but through the [`PostmasterTools`] hub.
///
/// # Example
///
/// Instantiate a resource builder
///
/// ```test_harness,no_run
/// extern crate hyper;
/// extern crate hyper_rustls;
/// extern crate google_gmailpostmastertools1 as gmailpostmastertools1;
///
/// # async fn dox() {
/// use std::default::Default;
/// use gmailpostmastertools1::{PostmasterTools, oauth2, hyper, hyper_rustls, chrono, FieldMask};
///
/// let secret: oauth2::ApplicationSecret = Default::default();
/// let auth = oauth2::InstalledFlowAuthenticator::builder(
/// secret,
/// oauth2::InstalledFlowReturnMethod::HTTPRedirect,
/// ).build().await.unwrap();
/// let mut hub = PostmasterTools::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
/// // Usually you wouldn't bind this to a variable, but keep calling *CallBuilders*
/// // like `get(...)`, `list(...)`, `traffic_stats_get(...)` and `traffic_stats_list(...)`
/// // to build up your call.
/// let rb = hub.domains();
/// # }
/// ```
pub struct DomainMethods<'a, S>
where S: 'a {
hub: &'a PostmasterTools<S>,
}
impl<'a, S> client::MethodsBuilder for DomainMethods<'a, S> {}
impl<'a, S> DomainMethods<'a, S> {
/// Create a builder to help you perform the following task:
///
/// Get traffic statistics for a domain on a specific date. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain.
///
/// # Arguments
///
/// * `name` - The resource name of the traffic statistics to get. E.g., domains/mymail.mydomain.com/trafficStats/20160807.
pub fn traffic_stats_get(&self, name: &str) -> DomainTrafficStatGetCall<'a, S> {
DomainTrafficStatGetCall {
hub: self.hub,
_name: name.to_string(),
_delegate: Default::default(),
_additional_params: Default::default(),
_scopes: Default::default(),
}
}
/// Create a builder to help you perform the following task:
///
/// List traffic statistics for all available days. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain.
///
/// # Arguments
///
/// * `parent` - The resource name of the domain whose traffic statistics we'd like to list. It should have the form `domains/{domain_name}`, where domain_name is the fully qualified domain name.
pub fn traffic_stats_list(&self, parent: &str) -> DomainTrafficStatListCall<'a, S> {
DomainTrafficStatListCall {
hub: self.hub,
_parent: parent.to_string(),
_start_date_year: Default::default(),
_start_date_month: Default::default(),
_start_date_day: Default::default(),
_page_token: Default::default(),
_page_size: Default::default(),
_end_date_year: Default::default(),
_end_date_month: Default::default(),
_end_date_day: Default::default(),
_delegate: Default::default(),
_additional_params: Default::default(),
_scopes: Default::default(),
}
}
/// Create a builder to help you perform the following task:
///
/// Gets a specific domain registered by the client. Returns NOT_FOUND if the domain does not exist.
///
/// # Arguments
///
/// * `name` - The resource name of the domain. It should have the form `domains/{domain_name}`, where domain_name is the fully qualified domain name.
pub fn get(&self, name: &str) -> DomainGetCall<'a, S> {
DomainGetCall {
hub: self.hub,
_name: name.to_string(),
_delegate: Default::default(),
_additional_params: Default::default(),
_scopes: Default::default(),
}
}
/// Create a builder to help you perform the following task:
///
/// Lists the domains that have been registered by the client. The order of domains in the response is unspecified and non-deterministic. Newly created domains will not necessarily be added to the end of this list.
pub fn list(&self) -> DomainListCall<'a, S> {
DomainListCall {
hub: self.hub,
_page_token: Default::default(),
_page_size: Default::default(),
_delegate: Default::default(),
_additional_params: Default::default(),
_scopes: Default::default(),
}
}
}
// ###################
// CallBuilders ###
// #################
use super::*;
/// Get traffic statistics for a domain on a specific date. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain.
///
/// A builder for the *trafficStats.get* method supported by a *domain* resource.
@@ -515,6 +12,7 @@ impl<'a, S> DomainMethods<'a, S> {
/// # extern crate hyper;
/// # extern crate hyper_rustls;
/// # extern crate google_gmailpostmastertools1 as gmailpostmastertools1;
/// use gmailpostmastertools1::api::enums::*;
/// # async fn dox() {
/// # use std::default::Default;
/// # use gmailpostmastertools1::{PostmasterTools, oauth2, hyper, hyper_rustls, chrono, FieldMask};
@@ -524,7 +22,7 @@ impl<'a, S> DomainMethods<'a, S> {
/// # secret,
/// # oauth2::InstalledFlowReturnMethod::HTTPRedirect,
/// # ).build().await.unwrap();
/// # let mut hub = PostmasterTools::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
/// # let mut hub = PostmasterTools::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
/// // You can configure optional parameters by calling the respective setters at will, and
/// // execute the final call using `doit()`.
/// // Values shown here are possibly random and not representative !
@@ -535,11 +33,11 @@ impl<'a, S> DomainMethods<'a, S> {
pub struct DomainTrafficStatGetCall<'a, S>
where S: 'a {
hub: &'a PostmasterTools<S>,
_name: String,
_delegate: Option<&'a mut dyn client::Delegate>,
_additional_params: HashMap<String, String>,
_scopes: BTreeSet<String>
pub(super) hub: &'a PostmasterTools<S>,
pub(super) _name: String,
pub(super) _delegate: Option<&'a mut dyn client::Delegate>,
pub(super) _additional_params: HashMap<String, String>,
pub(super) _scopes: BTreeSet<String>
}
impl<'a, S> client::CallBuilder for DomainTrafficStatGetCall<'a, S> {}
@@ -573,7 +71,7 @@ where
}
let mut params = Params::with_capacity(3 + self._additional_params.len());
params.push("name", self._name);
params.push("name", &self._name);
params.extend(self._additional_params.iter());
@@ -622,6 +120,7 @@ where
let request = req_builder
.header(CONTENT_LENGTH, 0_u64)
.body(hyper::body::Body::empty());
client.request(request.unwrap()).await
@@ -777,6 +276,7 @@ where
/// # extern crate hyper;
/// # extern crate hyper_rustls;
/// # extern crate google_gmailpostmastertools1 as gmailpostmastertools1;
/// use gmailpostmastertools1::api::enums::*;
/// # async fn dox() {
/// # use std::default::Default;
/// # use gmailpostmastertools1::{PostmasterTools, oauth2, hyper, hyper_rustls, chrono, FieldMask};
@@ -786,7 +286,7 @@ where
/// # secret,
/// # oauth2::InstalledFlowReturnMethod::HTTPRedirect,
/// # ).build().await.unwrap();
/// # let mut hub = PostmasterTools::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
/// # let mut hub = PostmasterTools::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
/// // You can configure optional parameters by calling the respective setters at will, and
/// // execute the final call using `doit()`.
/// // Values shown here are possibly random and not representative !
@@ -805,19 +305,19 @@ where
pub struct DomainTrafficStatListCall<'a, S>
where S: 'a {
hub: &'a PostmasterTools<S>,
_parent: String,
_start_date_year: Option<i32>,
_start_date_month: Option<i32>,
_start_date_day: Option<i32>,
_page_token: Option<String>,
_page_size: Option<i32>,
_end_date_year: Option<i32>,
_end_date_month: Option<i32>,
_end_date_day: Option<i32>,
_delegate: Option<&'a mut dyn client::Delegate>,
_additional_params: HashMap<String, String>,
_scopes: BTreeSet<String>
pub(super) hub: &'a PostmasterTools<S>,
pub(super) _parent: String,
pub(super) _start_date_year: Option<i32>,
pub(super) _start_date_month: Option<i32>,
pub(super) _start_date_day: Option<i32>,
pub(super) _page_token: Option<String>,
pub(super) _page_size: Option<i32>,
pub(super) _end_date_year: Option<i32>,
pub(super) _end_date_month: Option<i32>,
pub(super) _end_date_day: Option<i32>,
pub(super) _delegate: Option<&'a mut dyn client::Delegate>,
pub(super) _additional_params: HashMap<String, String>,
pub(super) _scopes: BTreeSet<String>
}
impl<'a, S> client::CallBuilder for DomainTrafficStatListCall<'a, S> {}
@@ -851,7 +351,7 @@ where
}
let mut params = Params::with_capacity(11 + self._additional_params.len());
params.push("parent", self._parent);
params.push("parent", &self._parent);
if let Some(value) = self._start_date_year.as_ref() {
params.push("startDate.year", value.to_string());
}
@@ -924,6 +424,7 @@ where
let request = req_builder
.header(CONTENT_LENGTH, 0_u64)
.body(hyper::body::Body::empty());
client.request(request.unwrap()).await
@@ -1135,6 +636,7 @@ where
/// # extern crate hyper;
/// # extern crate hyper_rustls;
/// # extern crate google_gmailpostmastertools1 as gmailpostmastertools1;
/// use gmailpostmastertools1::api::enums::*;
/// # async fn dox() {
/// # use std::default::Default;
/// # use gmailpostmastertools1::{PostmasterTools, oauth2, hyper, hyper_rustls, chrono, FieldMask};
@@ -1144,7 +646,7 @@ where
/// # secret,
/// # oauth2::InstalledFlowReturnMethod::HTTPRedirect,
/// # ).build().await.unwrap();
/// # let mut hub = PostmasterTools::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
/// # let mut hub = PostmasterTools::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
/// // You can configure optional parameters by calling the respective setters at will, and
/// // execute the final call using `doit()`.
/// // Values shown here are possibly random and not representative !
@@ -1155,11 +657,11 @@ where
pub struct DomainGetCall<'a, S>
where S: 'a {
hub: &'a PostmasterTools<S>,
_name: String,
_delegate: Option<&'a mut dyn client::Delegate>,
_additional_params: HashMap<String, String>,
_scopes: BTreeSet<String>
pub(super) hub: &'a PostmasterTools<S>,
pub(super) _name: String,
pub(super) _delegate: Option<&'a mut dyn client::Delegate>,
pub(super) _additional_params: HashMap<String, String>,
pub(super) _scopes: BTreeSet<String>
}
impl<'a, S> client::CallBuilder for DomainGetCall<'a, S> {}
@@ -1193,7 +695,7 @@ where
}
let mut params = Params::with_capacity(3 + self._additional_params.len());
params.push("name", self._name);
params.push("name", &self._name);
params.extend(self._additional_params.iter());
@@ -1242,6 +744,7 @@ where
let request = req_builder
.header(CONTENT_LENGTH, 0_u64)
.body(hyper::body::Body::empty());
client.request(request.unwrap()).await
@@ -1397,6 +900,7 @@ where
/// # extern crate hyper;
/// # extern crate hyper_rustls;
/// # extern crate google_gmailpostmastertools1 as gmailpostmastertools1;
/// use gmailpostmastertools1::api::enums::*;
/// # async fn dox() {
/// # use std::default::Default;
/// # use gmailpostmastertools1::{PostmasterTools, oauth2, hyper, hyper_rustls, chrono, FieldMask};
@@ -1406,7 +910,7 @@ where
/// # secret,
/// # oauth2::InstalledFlowReturnMethod::HTTPRedirect,
/// # ).build().await.unwrap();
/// # let mut hub = PostmasterTools::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
/// # let mut hub = PostmasterTools::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
/// // You can configure optional parameters by calling the respective setters at will, and
/// // execute the final call using `doit()`.
/// // Values shown here are possibly random and not representative !
@@ -1419,12 +923,12 @@ where
pub struct DomainListCall<'a, S>
where S: 'a {
hub: &'a PostmasterTools<S>,
_page_token: Option<String>,
_page_size: Option<i32>,
_delegate: Option<&'a mut dyn client::Delegate>,
_additional_params: HashMap<String, String>,
_scopes: BTreeSet<String>
pub(super) hub: &'a PostmasterTools<S>,
pub(super) _page_token: Option<String>,
pub(super) _page_size: Option<i32>,
pub(super) _delegate: Option<&'a mut dyn client::Delegate>,
pub(super) _additional_params: HashMap<String, String>,
pub(super) _scopes: BTreeSet<String>
}
impl<'a, S> client::CallBuilder for DomainListCall<'a, S> {}
@@ -1505,6 +1009,7 @@ where
let request = req_builder
.header(CONTENT_LENGTH, 0_u64)
.body(hyper::body::Body::empty());
client.request(request.unwrap()).await

416
gen/gmailpostmastertools1/src/api/enums.rs Normal file
View File

@@ -0,0 +1,416 @@
use super::*;
// region DeliveryErrorErrorClassEnum
#[derive(Clone, Copy, Eq, Hash, Debug, PartialEq, Serialize, Deserialize)]
/// The class of delivery error.
pub enum DeliveryErrorErrorClassEnum {
/// The default value which should never be used explicitly.
///
/// "DELIVERY_ERROR_CLASS_UNSPECIFIED"
#[serde(rename="DELIVERY_ERROR_CLASS_UNSPECIFIED")]
DELIVERYERRORCLASSUNSPECIFIED,
/// Delivery of message has been rejected.
///
/// "PERMANENT_ERROR"
#[serde(rename="PERMANENT_ERROR")]
PERMANENTERROR,
/// Temporary failure of message delivery to the recipient.
///
/// "TEMPORARY_ERROR"
#[serde(rename="TEMPORARY_ERROR")]
TEMPORARYERROR,
}
impl AsRef<str> for DeliveryErrorErrorClassEnum {
fn as_ref(&self) -> &str {
match *self {
DeliveryErrorErrorClassEnum::DELIVERYERRORCLASSUNSPECIFIED => "DELIVERY_ERROR_CLASS_UNSPECIFIED",
DeliveryErrorErrorClassEnum::PERMANENTERROR => "PERMANENT_ERROR",
DeliveryErrorErrorClassEnum::TEMPORARYERROR => "TEMPORARY_ERROR",
}
}
}
impl std::convert::TryFrom< &str> for DeliveryErrorErrorClassEnum {
type Error = ();
fn try_from(value: &str) -> Result<Self, Self::Error> {
match value {
"DELIVERY_ERROR_CLASS_UNSPECIFIED" => Ok(DeliveryErrorErrorClassEnum::DELIVERYERRORCLASSUNSPECIFIED),
"PERMANENT_ERROR" => Ok(DeliveryErrorErrorClassEnum::PERMANENTERROR),
"TEMPORARY_ERROR" => Ok(DeliveryErrorErrorClassEnum::TEMPORARYERROR),
_=> Err(()),
}
}
}
impl<'a> Into<std::borrow::Cow<'a, str>> for &'a DeliveryErrorErrorClassEnum {
fn into(self) -> std::borrow::Cow<'a, str> {
self.as_ref().into()
}
}
// endregion
// region DeliveryErrorErrorTypeEnum
#[derive(Clone, Copy, Eq, Hash, Debug, PartialEq, Serialize, Deserialize)]
/// The type of delivery error.
pub enum DeliveryErrorErrorTypeEnum {
/// The default value which should never be used explicitly.
///
/// "DELIVERY_ERROR_TYPE_UNSPECIFIED"
#[serde(rename="DELIVERY_ERROR_TYPE_UNSPECIFIED")]
DELIVERYERRORTYPEUNSPECIFIED,
/// The Domain or IP is sending traffic at a suspiciously high rate, due to which temporary rate limits have been imposed. The limit will be lifted when Gmail is confident enough of the nature of the traffic.
///
/// "RATE_LIMIT_EXCEEDED"
#[serde(rename="RATE_LIMIT_EXCEEDED")]
RATELIMITEXCEEDED,
/// The traffic is suspected to be spam, by Gmail, for various reasons.
///
/// "SUSPECTED_SPAM"
#[serde(rename="SUSPECTED_SPAM")]
SUSPECTEDSPAM,
/// The traffic is suspected to be spammy, specific to the content.
///
/// "CONTENT_SPAMMY"
#[serde(rename="CONTENT_SPAMMY")]
CONTENTSPAMMY,
/// Traffic contains attachments not supported by Gmail.
///
/// "BAD_ATTACHMENT"
#[serde(rename="BAD_ATTACHMENT")]
BADATTACHMENT,
/// The sender domain has set up a DMARC rejection policy.
///
/// "BAD_DMARC_POLICY"
#[serde(rename="BAD_DMARC_POLICY")]
BADDMARCPOLICY,
/// The IP reputation of the sending IP is very low.
///
/// "LOW_IP_REPUTATION"
#[serde(rename="LOW_IP_REPUTATION")]
LOWIPREPUTATION,
/// The Domain reputation of the sending domain is very low.
///
/// "LOW_DOMAIN_REPUTATION"
#[serde(rename="LOW_DOMAIN_REPUTATION")]
LOWDOMAINREPUTATION,
/// The IP is listed in one or more public [Real-time Blackhole Lists](http://en.wikipedia.org/wiki/DNSBL). Work with the RBL to get your IP delisted.
///
/// "IP_IN_RBL"
#[serde(rename="IP_IN_RBL")]
IPINRBL,
/// The Domain is listed in one or more public [Real-time Blackhole Lists](http://en.wikipedia.org/wiki/DNSBL). Work with the RBL to get your domain delisted.
///
/// "DOMAIN_IN_RBL"
#[serde(rename="DOMAIN_IN_RBL")]
DOMAININRBL,
/// The sending IP is missing a [PTR record](https://support.google.com/domains/answer/3251147#ptr).
///
/// "BAD_PTR_RECORD"
#[serde(rename="BAD_PTR_RECORD")]
BADPTRRECORD,
}
impl AsRef<str> for DeliveryErrorErrorTypeEnum {
fn as_ref(&self) -> &str {
match *self {
DeliveryErrorErrorTypeEnum::DELIVERYERRORTYPEUNSPECIFIED => "DELIVERY_ERROR_TYPE_UNSPECIFIED",
DeliveryErrorErrorTypeEnum::RATELIMITEXCEEDED => "RATE_LIMIT_EXCEEDED",
DeliveryErrorErrorTypeEnum::SUSPECTEDSPAM => "SUSPECTED_SPAM",
DeliveryErrorErrorTypeEnum::CONTENTSPAMMY => "CONTENT_SPAMMY",
DeliveryErrorErrorTypeEnum::BADATTACHMENT => "BAD_ATTACHMENT",
DeliveryErrorErrorTypeEnum::BADDMARCPOLICY => "BAD_DMARC_POLICY",
DeliveryErrorErrorTypeEnum::LOWIPREPUTATION => "LOW_IP_REPUTATION",
DeliveryErrorErrorTypeEnum::LOWDOMAINREPUTATION => "LOW_DOMAIN_REPUTATION",
DeliveryErrorErrorTypeEnum::IPINRBL => "IP_IN_RBL",
DeliveryErrorErrorTypeEnum::DOMAININRBL => "DOMAIN_IN_RBL",
DeliveryErrorErrorTypeEnum::BADPTRRECORD => "BAD_PTR_RECORD",
}
}
}
impl std::convert::TryFrom< &str> for DeliveryErrorErrorTypeEnum {
type Error = ();
fn try_from(value: &str) -> Result<Self, Self::Error> {
match value {
"DELIVERY_ERROR_TYPE_UNSPECIFIED" => Ok(DeliveryErrorErrorTypeEnum::DELIVERYERRORTYPEUNSPECIFIED),
"RATE_LIMIT_EXCEEDED" => Ok(DeliveryErrorErrorTypeEnum::RATELIMITEXCEEDED),
"SUSPECTED_SPAM" => Ok(DeliveryErrorErrorTypeEnum::SUSPECTEDSPAM),
"CONTENT_SPAMMY" => Ok(DeliveryErrorErrorTypeEnum::CONTENTSPAMMY),
"BAD_ATTACHMENT" => Ok(DeliveryErrorErrorTypeEnum::BADATTACHMENT),
"BAD_DMARC_POLICY" => Ok(DeliveryErrorErrorTypeEnum::BADDMARCPOLICY),
"LOW_IP_REPUTATION" => Ok(DeliveryErrorErrorTypeEnum::LOWIPREPUTATION),
"LOW_DOMAIN_REPUTATION" => Ok(DeliveryErrorErrorTypeEnum::LOWDOMAINREPUTATION),
"IP_IN_RBL" => Ok(DeliveryErrorErrorTypeEnum::IPINRBL),
"DOMAIN_IN_RBL" => Ok(DeliveryErrorErrorTypeEnum::DOMAININRBL),
"BAD_PTR_RECORD" => Ok(DeliveryErrorErrorTypeEnum::BADPTRRECORD),
_=> Err(()),
}
}
}
impl<'a> Into<std::borrow::Cow<'a, str>> for &'a DeliveryErrorErrorTypeEnum {
fn into(self) -> std::borrow::Cow<'a, str> {
self.as_ref().into()
}
}
// endregion
// region DomainPermissionEnum
#[derive(Clone, Copy, Eq, Hash, Debug, PartialEq, Serialize, Deserialize)]
/// User’s permission for this domain. Assigned by the server.
pub enum DomainPermissionEnum {
/// The default value and should never be used explicitly.
///
/// "PERMISSION_UNSPECIFIED"
#[serde(rename="PERMISSION_UNSPECIFIED")]
PERMISSIONUNSPECIFIED,
/// User has read access to the domain and can share access with others.
///
/// "OWNER"
#[serde(rename="OWNER")]
OWNER,
/// User has read access to the domain.
///
/// "READER"
#[serde(rename="READER")]
READER,
/// User doesn't have permission to access information about the domain. User did not verify ownership of domain nor was access granted by other domain owners.
///
/// "NONE"
#[serde(rename="NONE")]
NONE,
}
impl AsRef<str> for DomainPermissionEnum {
fn as_ref(&self) -> &str {
match *self {
DomainPermissionEnum::PERMISSIONUNSPECIFIED => "PERMISSION_UNSPECIFIED",
DomainPermissionEnum::OWNER => "OWNER",
DomainPermissionEnum::READER => "READER",
DomainPermissionEnum::NONE => "NONE",
}
}
}
impl std::convert::TryFrom< &str> for DomainPermissionEnum {
type Error = ();
fn try_from(value: &str) -> Result<Self, Self::Error> {
match value {
"PERMISSION_UNSPECIFIED" => Ok(DomainPermissionEnum::PERMISSIONUNSPECIFIED),
"OWNER" => Ok(DomainPermissionEnum::OWNER),
"READER" => Ok(DomainPermissionEnum::READER),
"NONE" => Ok(DomainPermissionEnum::NONE),
_=> Err(()),
}
}
}
impl<'a> Into<std::borrow::Cow<'a, str>> for &'a DomainPermissionEnum {
fn into(self) -> std::borrow::Cow<'a, str> {
self.as_ref().into()
}
}
// endregion
// region IpReputationReputationEnum
#[derive(Clone, Copy, Eq, Hash, Debug, PartialEq, Serialize, Deserialize)]
/// The reputation category this IP reputation represents.
pub enum IpReputationReputationEnum {
/// The default value which should never be used explicitly. This represents the state where no reputation information is available.
///
/// "REPUTATION_CATEGORY_UNSPECIFIED"
#[serde(rename="REPUTATION_CATEGORY_UNSPECIFIED")]
REPUTATIONCATEGORYUNSPECIFIED,
/// Has a good track record of a very low spam rate, and complies with Gmail's sender guidelines. Mail will rarely be marked by the spam filter.
///
/// "HIGH"
#[serde(rename="HIGH")]
HIGH,
/// Known to send good mail, but is prone to sending a low volume of spam intermittently. Most of the email from this entity will have a fair deliverability rate, except when there is a notable increase in spam levels.
///
/// "MEDIUM"
#[serde(rename="MEDIUM")]
MEDIUM,
/// Known to send a considerable volume of spam regularly, and mail from this sender will likely be marked as spam.
///
/// "LOW"
#[serde(rename="LOW")]
LOW,
/// History of sending an enormously high volume of spam. Mail coming from this entity will almost always be rejected at SMTP level or marked as spam.
///
/// "BAD"
#[serde(rename="BAD")]
BAD,
}
impl AsRef<str> for IpReputationReputationEnum {
fn as_ref(&self) -> &str {
match *self {
IpReputationReputationEnum::REPUTATIONCATEGORYUNSPECIFIED => "REPUTATION_CATEGORY_UNSPECIFIED",
IpReputationReputationEnum::HIGH => "HIGH",
IpReputationReputationEnum::MEDIUM => "MEDIUM",
IpReputationReputationEnum::LOW => "LOW",
IpReputationReputationEnum::BAD => "BAD",
}
}
}
impl std::convert::TryFrom< &str> for IpReputationReputationEnum {
type Error = ();
fn try_from(value: &str) -> Result<Self, Self::Error> {
match value {
"REPUTATION_CATEGORY_UNSPECIFIED" => Ok(IpReputationReputationEnum::REPUTATIONCATEGORYUNSPECIFIED),
"HIGH" => Ok(IpReputationReputationEnum::HIGH),
"MEDIUM" => Ok(IpReputationReputationEnum::MEDIUM),
"LOW" => Ok(IpReputationReputationEnum::LOW),
"BAD" => Ok(IpReputationReputationEnum::BAD),
_=> Err(()),
}
}
}
impl<'a> Into<std::borrow::Cow<'a, str>> for &'a IpReputationReputationEnum {
fn into(self) -> std::borrow::Cow<'a, str> {
self.as_ref().into()
}
}
// endregion
// region TrafficStatDomainReputationEnum
#[derive(Clone, Copy, Eq, Hash, Debug, PartialEq, Serialize, Deserialize)]
/// Reputation of the domain.
pub enum TrafficStatDomainReputationEnum {
/// The default value which should never be used explicitly. This represents the state where no reputation information is available.
///
/// "REPUTATION_CATEGORY_UNSPECIFIED"
#[serde(rename="REPUTATION_CATEGORY_UNSPECIFIED")]
REPUTATIONCATEGORYUNSPECIFIED,
/// Has a good track record of a very low spam rate, and complies with Gmail's sender guidelines. Mail will rarely be marked by the spam filter.
///
/// "HIGH"
#[serde(rename="HIGH")]
HIGH,
/// Known to send good mail, but is prone to sending a low volume of spam intermittently. Most of the email from this entity will have a fair deliverability rate, except when there is a notable increase in spam levels.
///
/// "MEDIUM"
#[serde(rename="MEDIUM")]
MEDIUM,
/// Known to send a considerable volume of spam regularly, and mail from this sender will likely be marked as spam.
///
/// "LOW"
#[serde(rename="LOW")]
LOW,
/// History of sending an enormously high volume of spam. Mail coming from this entity will almost always be rejected at SMTP level or marked as spam.
///
/// "BAD"
#[serde(rename="BAD")]
BAD,
}
impl AsRef<str> for TrafficStatDomainReputationEnum {
fn as_ref(&self) -> &str {
match *self {
TrafficStatDomainReputationEnum::REPUTATIONCATEGORYUNSPECIFIED => "REPUTATION_CATEGORY_UNSPECIFIED",
TrafficStatDomainReputationEnum::HIGH => "HIGH",
TrafficStatDomainReputationEnum::MEDIUM => "MEDIUM",
TrafficStatDomainReputationEnum::LOW => "LOW",
TrafficStatDomainReputationEnum::BAD => "BAD",
}
}
}
impl std::convert::TryFrom< &str> for TrafficStatDomainReputationEnum {
type Error = ();
fn try_from(value: &str) -> Result<Self, Self::Error> {
match value {
"REPUTATION_CATEGORY_UNSPECIFIED" => Ok(TrafficStatDomainReputationEnum::REPUTATIONCATEGORYUNSPECIFIED),
"HIGH" => Ok(TrafficStatDomainReputationEnum::HIGH),
"MEDIUM" => Ok(TrafficStatDomainReputationEnum::MEDIUM),
"LOW" => Ok(TrafficStatDomainReputationEnum::LOW),
"BAD" => Ok(TrafficStatDomainReputationEnum::BAD),
_=> Err(()),
}
}
}
impl<'a> Into<std::borrow::Cow<'a, str>> for &'a TrafficStatDomainReputationEnum {
fn into(self) -> std::borrow::Cow<'a, str> {
self.as_ref().into()
}
}
// endregion

115
gen/gmailpostmastertools1/src/api/hub.rs Normal file
View File

@@ -0,0 +1,115 @@
use super::*;
/// Central instance to access all PostmasterTools related resource activities
///
/// # Examples
///
/// Instantiate a new hub
///
/// ```test_harness,no_run
/// extern crate hyper;
/// extern crate hyper_rustls;
/// extern crate google_gmailpostmastertools1 as gmailpostmastertools1;
/// use gmailpostmastertools1::{Result, Error};
/// use gmailpostmastertools1::api::enums::*;
/// # async fn dox() {
/// use std::default::Default;
/// use gmailpostmastertools1::{PostmasterTools, oauth2, hyper, hyper_rustls, chrono, FieldMask};
///
/// // Get an ApplicationSecret instance by some means. It contains the `client_id` and
/// // `client_secret`, among other things.
/// let secret: oauth2::ApplicationSecret = Default::default();
/// // Instantiate the authenticator. It will choose a suitable authentication flow for you,
/// // unless you replace `None` with the desired Flow.
/// // Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about
/// // what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
/// // retrieve them from storage.
/// let auth = oauth2::InstalledFlowAuthenticator::builder(
/// secret,
/// oauth2::InstalledFlowReturnMethod::HTTPRedirect,
/// ).build().await.unwrap();
/// let mut hub = PostmasterTools::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
/// // You can configure optional parameters by calling the respective setters at will, and
/// // execute the final call using `doit()`.
/// // Values shown here are possibly random and not representative !
/// let result = hub.domains().traffic_stats_list("parent")
/// .start_date_year(-55)
/// .start_date_month(-88)
/// .start_date_day(-47)
/// .page_token("duo")
/// .page_size(-50)
/// .end_date_year(-93)
/// .end_date_month(-37)
/// .end_date_day(-12)
/// .doit().await;
///
/// match result {
/// Err(e) => match e {
/// // The Error enum provides details about what exactly happened.
/// // You can also just use its `Debug`, `Display` or `Error` traits
/// Error::HttpError(_)
/// |Error::Io(_)
/// |Error::MissingAPIKey
/// |Error::MissingToken(_)
/// |Error::Cancelled
/// |Error::UploadSizeLimitExceeded(_, _)
/// |Error::Failure(_)
/// |Error::BadRequest(_)
/// |Error::FieldClash(_)
/// |Error::JsonDecodeError(_, _) => println!("{}", e),
/// },
/// Ok(res) => println!("Success: {:?}", res),
/// }
/// # }
/// ```
#[derive(Clone)]
pub struct PostmasterTools<S> {
pub client: hyper::Client<S, hyper::body::Body>,
pub auth: Box<dyn client::GetToken>,
pub(super) _user_agent: String,
pub(super) _base_url: String,
pub(super) _root_url: String,
}
impl<'a, S> client::Hub for PostmasterTools<S> {}
impl<'a, S> PostmasterTools<S> {
pub fn new<A: 'static + client::GetToken>(client: hyper::Client<S, hyper::body::Body>, auth: A) -> PostmasterTools<S> {
PostmasterTools {
client,
auth: Box::new(auth),
_user_agent: "google-api-rust-client/5.0.5".to_string(),
_base_url: "https://gmailpostmastertools.googleapis.com/".to_string(),
_root_url: "https://gmailpostmastertools.googleapis.com/".to_string(),
}
}
pub fn domains(&'a self) -> DomainMethods<'a, S> {
DomainMethods { hub: &self }
}
/// Set the user-agent header field to use in all requests to the server.
/// It defaults to `google-api-rust-client/5.0.5`.
///
/// Returns the previously set user-agent.
pub fn user_agent(&mut self, agent_name: String) -> String {
mem::replace(&mut self._user_agent, agent_name)
}
/// Set the base url to use in all requests to the server.
/// It defaults to `https://gmailpostmastertools.googleapis.com/`.
///
/// Returns the previously set base url.
pub fn base_url(&mut self, new_base_url: String) -> String {
mem::replace(&mut self._base_url, new_base_url)
}
/// Set the root url to use in all requests to the server.
/// It defaults to `https://gmailpostmastertools.googleapis.com/`.
///
/// Returns the previously set root url.
pub fn root_url(&mut self, new_root_url: String) -> String {
mem::replace(&mut self._root_url, new_root_url)
}
}

115
gen/gmailpostmastertools1/src/api/method_builders.rs Normal file
View File

@@ -0,0 +1,115 @@
use super::*;
/// A builder providing access to all methods supported on *domain* resources.
/// It is not used directly, but through the [`PostmasterTools`] hub.
///
/// # Example
///
/// Instantiate a resource builder
///
/// ```test_harness,no_run
/// extern crate hyper;
/// extern crate hyper_rustls;
/// extern crate google_gmailpostmastertools1 as gmailpostmastertools1;
///
/// # async fn dox() {
/// use std::default::Default;
/// use gmailpostmastertools1::{PostmasterTools, oauth2, hyper, hyper_rustls, chrono, FieldMask};
///
/// let secret: oauth2::ApplicationSecret = Default::default();
/// let auth = oauth2::InstalledFlowAuthenticator::builder(
/// secret,
/// oauth2::InstalledFlowReturnMethod::HTTPRedirect,
/// ).build().await.unwrap();
/// let mut hub = PostmasterTools::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
/// // Usually you wouldn't bind this to a variable, but keep calling *CallBuilders*
/// // like `get(...)`, `list(...)`, `traffic_stats_get(...)` and `traffic_stats_list(...)`
/// // to build up your call.
/// let rb = hub.domains();
/// # }
/// ```
pub struct DomainMethods<'a, S>
where S: 'a {
pub(super) hub: &'a PostmasterTools<S>,
}
impl<'a, S> client::MethodsBuilder for DomainMethods<'a, S> {}
impl<'a, S> DomainMethods<'a, S> {
/// Create a builder to help you perform the following task:
///
/// Get traffic statistics for a domain on a specific date. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain.
///
/// # Arguments
///
/// * `name` - The resource name of the traffic statistics to get. E.g., domains/mymail.mydomain.com/trafficStats/20160807.
pub fn traffic_stats_get(&self, name: &str) -> DomainTrafficStatGetCall<'a, S> {
DomainTrafficStatGetCall {
hub: self.hub,
_name: name.to_string(),
_delegate: Default::default(),
_additional_params: Default::default(),
_scopes: Default::default(),
}
}
/// Create a builder to help you perform the following task:
///
/// List traffic statistics for all available days. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain.
///
/// # Arguments
///
/// * `parent` - The resource name of the domain whose traffic statistics we'd like to list. It should have the form `domains/{domain_name}`, where domain_name is the fully qualified domain name.
pub fn traffic_stats_list(&self, parent: &str) -> DomainTrafficStatListCall<'a, S> {
DomainTrafficStatListCall {
hub: self.hub,
_parent: parent.to_string(),
_start_date_year: Default::default(),
_start_date_month: Default::default(),
_start_date_day: Default::default(),
_page_token: Default::default(),
_page_size: Default::default(),
_end_date_year: Default::default(),
_end_date_month: Default::default(),
_end_date_day: Default::default(),
_delegate: Default::default(),
_additional_params: Default::default(),
_scopes: Default::default(),
}
}
/// Create a builder to help you perform the following task:
///
/// Gets a specific domain registered by the client. Returns NOT_FOUND if the domain does not exist.
///
/// # Arguments
///
/// * `name` - The resource name of the domain. It should have the form `domains/{domain_name}`, where domain_name is the fully qualified domain name.
pub fn get(&self, name: &str) -> DomainGetCall<'a, S> {
DomainGetCall {
hub: self.hub,
_name: name.to_string(),
_delegate: Default::default(),
_additional_params: Default::default(),
_scopes: Default::default(),
}
}
/// Create a builder to help you perform the following task:
///
/// Lists the domains that have been registered by the client. The order of domains in the response is unspecified and non-deterministic. Newly created domains will not necessarily be added to the end of this list.
pub fn list(&self) -> DomainListCall<'a, S> {
DomainListCall {
hub: self.hub,
_page_token: Default::default(),
_page_size: Default::default(),
_delegate: Default::default(),
_additional_params: Default::default(),
_scopes: Default::default(),
}
}
}

35
gen/gmailpostmastertools1/src/api/mod.rs Normal file
View File

@@ -0,0 +1,35 @@
use std::collections::HashMap;
use std::cell::RefCell;
use std::default::Default;
use std::collections::BTreeSet;
use std::error::Error as StdError;
use serde_json as json;
use std::io;
use std::fs;
use std::mem;
use hyper::client::connect;
use tokio::io::{AsyncRead, AsyncWrite};
use tokio::time::sleep;
use tower_service;
use serde::{Serialize, Deserialize};
use crate::{client, client::GetToken, client::serde_with};
mod utilities;
pub use utilities::*;
mod hub;
pub use hub::*;
mod schemas;
pub use schemas::*;
mod method_builders;
pub use method_builders::*;
mod call_builders;
pub use call_builders::*;
pub mod enums;
pub(crate) use enums::*;

212
gen/gmailpostmastertools1/src/api/schemas.rs Normal file
View File

@@ -0,0 +1,212 @@
use super::*;
/// Metric on a particular delivery error type.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct DeliveryError {
/// The class of delivery error.
#[serde(rename="errorClass")]
pub error_class: Option<DeliveryErrorErrorClassEnum>,
/// The ratio of messages where the error occurred vs all authenticated traffic.
#[serde(rename="errorRatio")]
pub error_ratio: Option<f64>,
/// The type of delivery error.
#[serde(rename="errorType")]
pub error_type: Option<DeliveryErrorErrorTypeEnum>,
}
impl client::Part for DeliveryError {}
/// A registered domain resource in the Postmaster API.
///
/// # Activities
///
/// This type is used in activities, which are methods you may call on this type or where this type is involved in.
/// The list links the activity name, along with information about where it is used (one of *request* and *response*).
///
/// * [traffic stats get domains](DomainTrafficStatGetCall) (none)
/// * [traffic stats list domains](DomainTrafficStatListCall) (none)
/// * [get domains](DomainGetCall) (response)
/// * [list domains](DomainListCall) (none)
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct Domain {
/// Timestamp when the user registered this domain. Assigned by the server.
#[serde(rename="createTime")]
pub create_time: Option<client::chrono::DateTime<client::chrono::offset::Utc>>,
/// The resource name of the Domain. Domain names have the form `domains/{domain_name}`, where domain_name is the fully qualified domain name (i.e., mymail.mydomain.com).
pub name: Option<String>,
/// User’s permission for this domain. Assigned by the server.
pub permission: Option<DomainPermissionEnum>,
}
impl client::Resource for Domain {}
impl client::ResponseResult for Domain {}
/// [Feedback loop](https://support.google.com/mail/answer/6254652) identifier information.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct FeedbackLoop {
/// Feedback loop identifier that uniquely identifies individual campaigns.
pub id: Option<String>,
/// The ratio of user marked spam messages with the identifier vs the total number of inboxed messages with that identifier.
#[serde(rename="spamRatio")]
pub spam_ratio: Option<f64>,
}
impl client::Part for FeedbackLoop {}
/// IP Reputation information for a set of IPs in a specific reputation category.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct IpReputation {
/// Total number of unique IPs in this reputation category. This metric only pertains to traffic that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
#[serde(rename="ipCount")]
#[serde_as(as = "Option<::client::serde_with::DisplayFromStr>")]
pub ip_count: Option<i64>,
/// The reputation category this IP reputation represents.
pub reputation: Option<IpReputationReputationEnum>,
/// A sample of IPs in this reputation category.
#[serde(rename="sampleIps")]
pub sample_ips: Option<Vec<String>>,
}
impl client::Part for IpReputation {}
/// Response message for ListDomains.
///
/// # Activities
///
/// This type is used in activities, which are methods you may call on this type or where this type is involved in.
/// The list links the activity name, along with information about where it is used (one of *request* and *response*).
///
/// * [list domains](DomainListCall) (response)
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct ListDomainsResponse {
/// The list of domains.
pub domains: Option<Vec<Domain>>,
/// Token to retrieve the next page of results, or empty if there are no more results in the list.
#[serde(rename="nextPageToken")]
pub next_page_token: Option<String>,
}
impl client::ResponseResult for ListDomainsResponse {}
/// Response message for ListTrafficStats.
///
/// # Activities
///
/// This type is used in activities, which are methods you may call on this type or where this type is involved in.
/// The list links the activity name, along with information about where it is used (one of *request* and *response*).
///
/// * [traffic stats list domains](DomainTrafficStatListCall) (response)
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct ListTrafficStatsResponse {
/// Token to retrieve the next page of results, or empty if there are no more results in the list.
#[serde(rename="nextPageToken")]
pub next_page_token: Option<String>,
/// The list of TrafficStats.
#[serde(rename="trafficStats")]
pub traffic_stats: Option<Vec<TrafficStats>>,
}
impl client::ResponseResult for ListTrafficStatsResponse {}
/// Email traffic statistics pertaining to a specific date.
///
/// # Activities
///
/// This type is used in activities, which are methods you may call on this type or where this type is involved in.
/// The list links the activity name, along with information about where it is used (one of *request* and *response*).
///
/// * [traffic stats get domains](DomainTrafficStatGetCall) (response)
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct TrafficStats {
/// Delivery errors for the domain. This metric only pertains to traffic that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
#[serde(rename="deliveryErrors")]
pub delivery_errors: Option<Vec<DeliveryError>>,
/// The ratio of mail that successfully authenticated with DKIM vs. all mail that attempted to authenticate with [DKIM](http://www.dkim.org/). Spoofed mail is excluded.
#[serde(rename="dkimSuccessRatio")]
pub dkim_success_ratio: Option<f64>,
/// The ratio of mail that passed [DMARC](https://dmarc.org/) alignment checks vs all mail received from the domain that successfully authenticated with either of [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
#[serde(rename="dmarcSuccessRatio")]
pub dmarc_success_ratio: Option<f64>,
/// Reputation of the domain.
#[serde(rename="domainReputation")]
pub domain_reputation: Option<TrafficStatDomainReputationEnum>,
/// The ratio of incoming mail (to Gmail), that passed secure transport (TLS) vs all mail received from that domain. This metric only pertains to traffic that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
#[serde(rename="inboundEncryptionRatio")]
pub inbound_encryption_ratio: Option<f64>,
/// Reputation information pertaining to the IP addresses of the email servers for the domain. There is exactly one entry for each reputation category except REPUTATION_CATEGORY_UNSPECIFIED.
#[serde(rename="ipReputations")]
pub ip_reputations: Option<Vec<IpReputation>>,
/// The resource name of the traffic statistics. Traffic statistic names have the form `domains/{domain}/trafficStats/{date}`, where domain_name is the fully qualified domain name (i.e., mymail.mydomain.com) of the domain this traffic statistics pertains to and date is the date in yyyymmdd format that these statistics corresponds to. For example: domains/mymail.mydomain.com/trafficStats/20160807
pub name: Option<String>,
/// The ratio of outgoing mail (from Gmail) that was accepted over secure transport (TLS).
#[serde(rename="outboundEncryptionRatio")]
pub outbound_encryption_ratio: Option<f64>,
/// Spammy [Feedback loop identifiers] (https://support.google.com/mail/answer/6254652) with their individual spam rates. This metric only pertains to traffic that is authenticated by [DKIM](http://www.dkim.org/).
#[serde(rename="spammyFeedbackLoops")]
pub spammy_feedback_loops: Option<Vec<FeedbackLoop>>,
/// The ratio of mail that successfully authenticated with SPF vs. all mail that attempted to authenticate with [SPF](http://www.openspf.org/). Spoofed mail is excluded.
#[serde(rename="spfSuccessRatio")]
pub spf_success_ratio: Option<f64>,
/// The ratio of user-report spam vs. email that was sent to the inbox. This is potentially inexact -- users may want to refer to the description of the interval fields userReportedSpamRatioLowerBound and userReportedSpamRatioUpperBound for more explicit accuracy guarantees. This metric only pertains to emails authenticated by [DKIM](http://www.dkim.org/).
#[serde(rename="userReportedSpamRatio")]
pub user_reported_spam_ratio: Option<f64>,
/// The lower bound of the confidence interval for the user reported spam ratio. If this field is set, then the value of userReportedSpamRatio is set to the midpoint of this interval and is thus inexact. However, the true ratio is guaranteed to be in between this lower bound and the corresponding upper bound 95% of the time. This metric only pertains to emails authenticated by [DKIM](http://www.dkim.org/).
#[serde(rename="userReportedSpamRatioLowerBound")]
pub user_reported_spam_ratio_lower_bound: Option<f64>,
/// The upper bound of the confidence interval for the user reported spam ratio. If this field is set, then the value of userReportedSpamRatio is set to the midpoint of this interval and is thus inexact. However, the true ratio is guaranteed to be in between this upper bound and the corresponding lower bound 95% of the time. This metric only pertains to emails authenticated by [DKIM](http://www.dkim.org/).
#[serde(rename="userReportedSpamRatioUpperBound")]
pub user_reported_spam_ratio_upper_bound: Option<f64>,
}
impl client::ResponseResult for TrafficStats {}

24
gen/gmailpostmastertools1/src/api/utilities.rs Normal file
View File

@@ -0,0 +1,24 @@
use super::*;
/// Identifies the an OAuth2 authorization scope.
/// A scope is needed when requesting an
/// [authorization token](https://developers.google.com/youtube/v3/guides/authentication).
#[derive(PartialEq, Eq, Hash, Debug, Clone)]
pub enum Scope {
/// See email traffic metrics for the domains you have registered in Gmail Postmaster Tools
PostmasterReadonly,
}
impl AsRef<str> for Scope {
fn as_ref(&self) -> &str {
match *self {
Scope::PostmasterReadonly => "https://www.googleapis.com/auth/postmaster.readonly",
}
}
}
impl Default for Scope {
fn default() -> Scope {
Scope::PostmasterReadonly
}
}

37
gen/gmailpostmastertools1/src/lib.rs
View File

@@ -2,14 +2,14 @@
// This file was generated automatically from 'src/generator/templates/api/lib.rs.mako'
// DO NOT EDIT !
//! This documentation was generated from *Postmaster Tools* crate version *5.0.4+20240303*, where *20240303* is the exact revision of the *gmailpostmastertools:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v5.0.4*.
//! This documentation was generated from *Postmaster Tools* crate version *5.0.5+20240418*, where *20240418* is the exact revision of the *gmailpostmastertools:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v5.0.5*.
//!
//! Everything else about the *Postmaster Tools* *v1* API can be found at the
//! [official documentation site](https://developers.google.com/gmail/postmaster).
//! The original source code is [on github](https://github.com/Byron/google-apis-rs/tree/main/gen/gmailpostmastertools1).
//! # Features
//!
//! Handle the following *Resources* with ease from the central [hub](PostmasterTools) ...
//! Handle the following *Resources* with ease from the central [hub](PostmasterTools) ...
//!
//! * [domains](api::Domain)
//! * [*get*](api::DomainGetCall), [*list*](api::DomainListCall), [*traffic stats get*](api::DomainTrafficStatGetCall) and [*traffic stats list*](api::DomainTrafficStatListCall)
@@ -53,8 +53,8 @@
//! let r = hub.domains().list(...).doit().await
//! ```
//!
//! The `resource()` and `activity(...)` calls create [builders][builder-pattern]. The second one dealing with `Activities`
//! supports various methods to configure the impending operation (not shown here). It is made such that all required arguments have to be
//! The `resource()` and `activity(...)` calls create [builders][builder-pattern]. The second one dealing with `Activities`
//! supports various methods to configure the impending operation (not shown here). It is made such that all required arguments have to be
//! specified right away (i.e. `(...)`), whereas all optional ones can be [build up][builder-pattern] as desired.
//! The `doit()` method performs the actual communication with the server and returns the respective result.
//!
@@ -78,23 +78,24 @@
//! extern crate hyper_rustls;
//! extern crate google_gmailpostmastertools1 as gmailpostmastertools1;
//! use gmailpostmastertools1::{Result, Error};
//! use gmailpostmastertools1::api::enums::*;
//! # async fn dox() {
//! use std::default::Default;
//! use gmailpostmastertools1::{PostmasterTools, oauth2, hyper, hyper_rustls, chrono, FieldMask};
//!
//! // Get an ApplicationSecret instance by some means. It contains the `client_id` and
//! // Get an ApplicationSecret instance by some means. It contains the `client_id` and
//! // `client_secret`, among other things.
//! let secret: oauth2::ApplicationSecret = Default::default();
//! // Instantiate the authenticator. It will choose a suitable authentication flow for you,
//! // Instantiate the authenticator. It will choose a suitable authentication flow for you,
//! // unless you replace `None` with the desired Flow.
//! // Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about
//! // Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about
//! // what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
//! // retrieve them from storage.
//! let auth = oauth2::InstalledFlowAuthenticator::builder(
//! secret,
//! oauth2::InstalledFlowReturnMethod::HTTPRedirect,
//! ).build().await.unwrap();
//! let mut hub = PostmasterTools::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
//! let mut hub = PostmasterTools::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
//! // You can configure optional parameters by calling the respective setters at will, and
//! // execute the final call using `doit()`.
//! // Values shown here are possibly random and not representative !
@@ -131,10 +132,10 @@
//! ## Handling Errors
//!
//! All errors produced by the system are provided either as [Result](client::Result) enumeration as return value of
//! the doit() methods, or handed as possibly intermediate results to either the
//! the doit() methods, or handed as possibly intermediate results to either the
//! [Hub Delegate](client::Delegate), or the [Authenticator Delegate](https://docs.rs/yup-oauth2/*/yup_oauth2/trait.AuthenticatorDelegate.html).
//!
//! When delegates handle errors or intermediate values, they may have a chance to instruct the system to retry. This
//! When delegates handle errors or intermediate values, they may have a chance to instruct the system to retry. This
//! makes the system potentially resilient to all kinds of errors.
//!
//! ## Uploads and Downloads
@@ -144,25 +145,25 @@
//! You can see it as meta-data for the actual media. To trigger a media download, you will have to set up the builder by making
//! this call: `.param("alt", "media")`.
//!
//! Methods supporting uploads can do so using up to 2 different protocols:
//! *simple* and *resumable*. The distinctiveness of each is represented by customized
//! Methods supporting uploads can do so using up to 2 different protocols:
//! *simple* and *resumable*. The distinctiveness of each is represented by customized
//! `doit(...)` methods, which are then named `upload(...)` and `upload_resumable(...)` respectively.
//!
//! ## Customization and Callbacks
//!
//! You may alter the way an `doit()` method is called by providing a [delegate](client::Delegate) to the
//! [Method Builder](client::CallBuilder) before making the final `doit()` call.
//! Respective methods will be called to provide progress information, as well as determine whether the system should
//! You may alter the way an `doit()` method is called by providing a [delegate](client::Delegate) to the
//! [Method Builder](client::CallBuilder) before making the final `doit()` call.
//! Respective methods will be called to provide progress information, as well as determine whether the system should
//! retry on failure.
//!
//! The [delegate trait](client::Delegate) is default-implemented, allowing you to customize it with minimal effort.
//!
//! ## Optional Parts in Server-Requests
//!
//! All structures provided by this library are made to be [encodable](client::RequestValue) and
//! [decodable](client::ResponseResult) via *json*. Optionals are used to indicate that partial requests are responses
//! All structures provided by this library are made to be [encodable](client::RequestValue) and
//! [decodable](client::ResponseResult) via *json*. Optionals are used to indicate that partial requests are responses
//! are valid.
//! Most optionals are are considered [Parts](client::Part) which are identifiable by name, which will be sent to
//! Most optionals are are considered [Parts](client::Part) which are identifiable by name, which will be sent to
//! the server to indicate either the set parts of the request or the desired parts in the response.
//!
//! ## Builder Arguments