Skip to content

Commit

Permalink
feat(gmail): update the api
Browse files Browse the repository at this point in the history
#### gmail:v1

The following keys were added:
- resources.users.resources.settings.resources.cse.resources.identities.methods.create (Total Keys: 12)
- resources.users.resources.settings.resources.cse.resources.identities.methods.delete (Total Keys: 13)
- resources.users.resources.settings.resources.cse.resources.identities.methods.get (Total Keys: 14)
- resources.users.resources.settings.resources.cse.resources.identities.methods.list (Total Keys: 17)
- resources.users.resources.settings.resources.cse.resources.identities.methods.patch (Total Keys: 15)
- resources.users.resources.settings.resources.cse.resources.keypairs.methods.create (Total Keys: 12)
- resources.users.resources.settings.resources.cse.resources.keypairs.methods.disable (Total Keys: 15)
- resources.users.resources.settings.resources.cse.resources.keypairs.methods.enable (Total Keys: 15)
- resources.users.resources.settings.resources.cse.resources.keypairs.methods.get (Total Keys: 14)
- resources.users.resources.settings.resources.cse.resources.keypairs.methods.list (Total Keys: 17)
- resources.users.resources.settings.resources.cse.resources.keypairs.methods.obliterate (Total Keys: 14)
- schemas.CseIdentity (Total Keys: 4)
- schemas.CseKeyPair (Total Keys: 17)
- schemas.CsePrivateKeyMetadata (Total Keys: 5)
- schemas.DisableCseKeyPairRequest (Total Keys: 2)
- schemas.EnableCseKeyPairRequest (Total Keys: 2)
- schemas.KaclsKeyMetadata (Total Keys: 4)
- schemas.ListCseIdentitiesResponse (Total Keys: 5)
- schemas.ListCseKeyPairsResponse (Total Keys: 5)
- schemas.ObliterateCseKeyPairRequest (Total Keys: 2)
  • Loading branch information
yoshi-automation committed Dec 20, 2022
1 parent 89b34a9 commit a4ca99c
Show file tree
Hide file tree
Showing 5 changed files with 1,250 additions and 1 deletion.
96 changes: 96 additions & 0 deletions docs/dyn/gmail_v1.users.settings.cse.html
@@ -0,0 +1,96 @@
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}

body {
font-size: 13px;
padding: 1em;
}

h1 {
font-size: 26px;
margin-bottom: 1em;
}

h2 {
font-size: 24px;
margin-bottom: 1em;
}

h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}

pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
margin-top: 0.5em;
}

h1, h2, h3, p {
font-family: Arial, sans serif;
}

h1, h2, h3 {
border-bottom: solid #CCC 1px;
}

.toc_element {
margin-top: 0.5em;
}

.firstline {
margin-left: 2 em;
}

.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}

.details {
font-weight: bold;
font-size: 14px;
}

</style>

<h1><a href="gmail_v1.html">Gmail API</a> . <a href="gmail_v1.users.html">users</a> . <a href="gmail_v1.users.settings.html">settings</a> . <a href="gmail_v1.users.settings.cse.html">cse</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="gmail_v1.users.settings.cse.identities.html">identities()</a></code>
</p>
<p class="firstline">Returns the identities Resource.</p>

<p class="toc_element">
<code><a href="gmail_v1.users.settings.cse.keypairs.html">keypairs()</a></code>
</p>
<p class="firstline">Returns the keypairs Resource.</p>

<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>

</body></html>
237 changes: 237 additions & 0 deletions docs/dyn/gmail_v1.users.settings.cse.identities.html
@@ -0,0 +1,237 @@
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}

body {
font-size: 13px;
padding: 1em;
}

h1 {
font-size: 26px;
margin-bottom: 1em;
}

h2 {
font-size: 24px;
margin-bottom: 1em;
}

h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}

pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
margin-top: 0.5em;
}

h1, h2, h3, p {
font-family: Arial, sans serif;
}

h1, h2, h3 {
border-bottom: solid #CCC 1px;
}

.toc_element {
margin-top: 0.5em;
}

.firstline {
margin-left: 2 em;
}

.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}

.details {
font-weight: bold;
font-size: 14px;
}

</style>

<h1><a href="gmail_v1.html">Gmail API</a> . <a href="gmail_v1.users.html">users</a> . <a href="gmail_v1.users.settings.html">settings</a> . <a href="gmail_v1.users.settings.cse.html">cse</a> . <a href="gmail_v1.users.settings.cse.identities.html">identities</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(userId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates and configures a client-side encryption identity that's authorized to send mail from the user account. Google publishes the S/MIME certificate to a shared domain-wide directory so that people within a Google Workspace organization can encrypt and send mail to the identity. [Beta](https://workspace.google.com/terms/service-terms/index.html).</p>
<p class="toc_element">
<code><a href="#delete">delete(userId, cseEmailAddress, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a client-side encryption identity. The authenticated user can no longer use the identity to send encrypted messages. You cannot restore the identity after you delete it. Instead, use the CreateCseIdentity method to create another identity with the same configuration. [Beta](https://workspace.google.com/terms/service-terms/index.html).</p>
<p class="toc_element">
<code><a href="#get">get(userId, cseEmailAddress, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a client-side encryption identity configuration. [Beta](https://workspace.google.com/terms/service-terms/index.html).</p>
<p class="toc_element">
<code><a href="#list">list(userId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the client-side encrypted identities for an authenticated user. [Beta](https://workspace.google.com/terms/service-terms/index.html).</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(userId, emailAddress, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Associates a different key pair with an existing client-side encryption identity. The updated key pair must validate against Google's [S/MIME certificate profiles](https://support.google.com/a/answer/7300887?hl=en). [Beta](https://workspace.google.com/terms/service-terms/index.html).</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>

<div class="method">
<code class="details" id="create">create(userId, body=None, x__xgafv=None)</code>
<pre>Creates and configures a client-side encryption identity that&#x27;s authorized to send mail from the user account. Google publishes the S/MIME certificate to a shared domain-wide directory so that people within a Google Workspace organization can encrypt and send mail to the identity. [Beta](https://workspace.google.com/terms/service-terms/index.html).

Args:
userId: string, The requester&#x27;s primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
body: object, The request body.
The object takes the form of:

{ # [Beta](https://workspace.google.com/terms/service-terms/index.html). The client-side encryption (CSE) configuration for the email address of an authenticated user. Gmail uses CSE configurations to save drafts of client-side encrypted email messages, and to sign and send encrypted email messages.
&quot;emailAddress&quot;: &quot;A String&quot;, # The email address for the sending identity. The email address must be the primary email address of the authenticated user.
&quot;primaryKeyPairId&quot;: &quot;A String&quot;, # If a key pair is associated, the identifier of the key pair, CseKeyPair.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # [Beta](https://workspace.google.com/terms/service-terms/index.html). The client-side encryption (CSE) configuration for the email address of an authenticated user. Gmail uses CSE configurations to save drafts of client-side encrypted email messages, and to sign and send encrypted email messages.
&quot;emailAddress&quot;: &quot;A String&quot;, # The email address for the sending identity. The email address must be the primary email address of the authenticated user.
&quot;primaryKeyPairId&quot;: &quot;A String&quot;, # If a key pair is associated, the identifier of the key pair, CseKeyPair.
}</pre>
</div>

<div class="method">
<code class="details" id="delete">delete(userId, cseEmailAddress, x__xgafv=None)</code>
<pre>Deletes a client-side encryption identity. The authenticated user can no longer use the identity to send encrypted messages. You cannot restore the identity after you delete it. Instead, use the CreateCseIdentity method to create another identity with the same configuration. [Beta](https://workspace.google.com/terms/service-terms/index.html).

Args:
userId: string, The requester&#x27;s primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
cseEmailAddress: string, The primary email address associated with the client-side encryption identity configuration that&#x27;s removed. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>

<div class="method">
<code class="details" id="get">get(userId, cseEmailAddress, x__xgafv=None)</code>
<pre>Retrieves a client-side encryption identity configuration. [Beta](https://workspace.google.com/terms/service-terms/index.html).

Args:
userId: string, The requester&#x27;s primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
cseEmailAddress: string, The primary email address associated with the client-side encryption identity configuration that&#x27;s retrieved. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # [Beta](https://workspace.google.com/terms/service-terms/index.html). The client-side encryption (CSE) configuration for the email address of an authenticated user. Gmail uses CSE configurations to save drafts of client-side encrypted email messages, and to sign and send encrypted email messages.
&quot;emailAddress&quot;: &quot;A String&quot;, # The email address for the sending identity. The email address must be the primary email address of the authenticated user.
&quot;primaryKeyPairId&quot;: &quot;A String&quot;, # If a key pair is associated, the identifier of the key pair, CseKeyPair.
}</pre>
</div>

<div class="method">
<code class="details" id="list">list(userId, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the client-side encrypted identities for an authenticated user. [Beta](https://workspace.google.com/terms/service-terms/index.html).

Args:
userId: string, The requester&#x27;s primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
pageSize: integer, The number of identities to return. If not provided, the page size will default to 20 entries.
pageToken: string, Pagination token indicating which page of identities to return. If the token is not supplied, then the API will return the first page of results.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{
&quot;cseIdentities&quot;: [ # One page of the list of CSE identities configured for the user.
{ # [Beta](https://workspace.google.com/terms/service-terms/index.html). The client-side encryption (CSE) configuration for the email address of an authenticated user. Gmail uses CSE configurations to save drafts of client-side encrypted email messages, and to sign and send encrypted email messages.
&quot;emailAddress&quot;: &quot;A String&quot;, # The email address for the sending identity. The email address must be the primary email address of the authenticated user.
&quot;primaryKeyPairId&quot;: &quot;A String&quot;, # If a key pair is associated, the identifier of the key pair, CseKeyPair.
},
],
&quot;nextPageToken&quot;: &quot;A String&quot;, # Pagination token to be passed to a subsequent ListCseIdentities call in order to retrieve the next page of identities. If this value is not returned or is the empty string, then no further pages remain.
}</pre>
</div>

<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.

Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)

Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>

<div class="method">
<code class="details" id="patch">patch(userId, emailAddress, body=None, x__xgafv=None)</code>
<pre>Associates a different key pair with an existing client-side encryption identity. The updated key pair must validate against Google&#x27;s [S/MIME certificate profiles](https://support.google.com/a/answer/7300887?hl=en). [Beta](https://workspace.google.com/terms/service-terms/index.html).

Args:
userId: string, The requester&#x27;s primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
emailAddress: string, The email address of the client-side encryption identity to update. (required)
body: object, The request body.
The object takes the form of:

{ # [Beta](https://workspace.google.com/terms/service-terms/index.html). The client-side encryption (CSE) configuration for the email address of an authenticated user. Gmail uses CSE configurations to save drafts of client-side encrypted email messages, and to sign and send encrypted email messages.
&quot;emailAddress&quot;: &quot;A String&quot;, # The email address for the sending identity. The email address must be the primary email address of the authenticated user.
&quot;primaryKeyPairId&quot;: &quot;A String&quot;, # If a key pair is associated, the identifier of the key pair, CseKeyPair.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # [Beta](https://workspace.google.com/terms/service-terms/index.html). The client-side encryption (CSE) configuration for the email address of an authenticated user. Gmail uses CSE configurations to save drafts of client-side encrypted email messages, and to sign and send encrypted email messages.
&quot;emailAddress&quot;: &quot;A String&quot;, # The email address for the sending identity. The email address must be the primary email address of the authenticated user.
&quot;primaryKeyPairId&quot;: &quot;A String&quot;, # If a key pair is associated, the identifier of the key pair, CseKeyPair.
}</pre>
</div>

</body></html>

0 comments on commit a4ca99c

Please sign in to comment.