google-groups-settings

Crates.iogoogle-groups-settings
lib.rsgoogle-groups-settings
version0.7.0
sourcesrc
created_at2021-08-17 20:53:52.707581
updated_at2023-07-19 18:27:07.396689
descriptionA fully generated & opinionated API client for the Google Groups Settings API.
homepage
repositoryhttps://github.com/oxidecomputer/third-party-api-clients/tree/main/google/groups-settings
max_upload_size
id438661
size87,215
(oxideservicebot)

documentation

https://docs.rs/google-groups-settings/

README

google-groups-settings

A fully generated, opinionated API client library for Google Groups Settings.

docs.rs

API Details

Manages permission levels and related settings of a group.

API Terms of Service

Contact

name url
Google https://google.com

License

name url
Creative Commons Attribution 3.0 http://creativecommons.org/licenses/by/3.0/

Client Details

This client is generated from the Google Groups Settings OpenAPI specs based on API spec version v1. This way it will remain up to date as features are added. The documentation for the crate is generated along with the code to make this library easy to use.

To install the library, add the following to your Cargo.toml file.

[dependencies]
google-groups-settings = "0.7.0"

Basic example

Typical use will require intializing a Client. This requires a user agent string and set of credentials.

use google_groups_settings::Client;

let google groups settings = Client::new(
    String::from("client-id"),
    String::from("client-secret"),
    String::from("redirect-uri"),
    String::from("token"),
    String::from("refresh-token")
);

Alternatively, the library can search for most of the variables required for the client in the environment:

  • GOOGLE GROUPS SETTINGS_CLIENT_ID
  • GOOGLE GROUPS SETTINGS_CLIENT_SECRET
  • GOOGLE GROUPS SETTINGS_REDIRECT_URI

And then you can create a client from the environment.

use google_groups_settings::Client;

let google groups settings = Client::new_from_env(
    String::from("token"),
    String::from("refresh-token")
);

It is okay to pass empty values for token and refresh_token. In the initial state of the client, you will not know these values.

To start off a fresh client and get a token and refresh_token, use the following.

use google_groups_settings::Client;

async fn do_call() {
    let mut google groups settings = Client::new_from_env("", "");

    // Get the URL to request consent from the user.
    // You can optionally pass in scopes. If none are provided, then the
    // resulting URL will not have any scopes.
    let user_consent_url = google groups settings.user_consent_url(&["some-scope".to_string()]);

    // In your redirect URL capture the code sent and our state.
    // Send it along to the request for the token.
    let code = "thing-from-redirect-url";
    let state = "state-from-redirect-url";
    let mut access_token = google groups settings.get_access_token(code, state).await.unwrap();

    // You can additionally refresh the access token with the following.
    // You must have a refresh token to be able to call this function.
    access_token = google groups settings.refresh_access_token().await.unwrap();
}
Commit count: 0

cargo fmt