Api-roll 45: 2017-02-13

discovery/googleapis/gmail__v1.json

 {
     "auth": {
         "oauth2": {
             "scopes": {
                 "https://mail.google.com/": {
                     "description": "View and manage your mail"
                 },
                 "https://www.googleapis.com/auth/gmail.compose": {
                     "description": "Manage drafts and send emails"
                 },
@@ skipping 23 matching lines @@
                 }
             }
         }
     },
     "basePath": "/gmail/v1/users/",
     "baseUrl": "https://www.googleapis.com/gmail/v1/users/",
     "batchPath": "batch",
     "description": "Access Gmail mailboxes including sending user email.",
     "discoveryVersion": "v1",
     "documentationLink": "https://developers.google.com/gmail/api/",
-    "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/iEu64OqTQaadpg92fJ0bQ4GFW7U\"",
+    "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/bv4LA8S_yqDUVUFrxfui1vcVGzk\"",
     "icons": {
         "x16": "https://www.google.com/images/icons/product/googlemail-16.png",
         "x32": "https://www.google.com/images/icons/product/googlemail-32.png"
     },
     "id": "gmail:v1",
     "kind": "discovery#restDescription",
     "name": "gmail",
     "ownerDomain": "google.com",
     "ownerName": "Google",
     "parameters": {
@@ skipping 413 matching lines @@
                 "history": {
                     "methods": {
                         "list": {
                             "description": "Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing historyId).",
                             "httpMethod": "GET",
                             "id": "gmail.users.history.list",
                             "parameterOrder": [
                                 "userId"
                             ],
                             "parameters": {
+                                "historyTypes": {
+                                    "description": "History types to be returned by the function",
+                                    "enum": [
+                                        "labelAdded",
+                                        "labelRemoved",
+                                        "messageAdded",
+                                        "messageDeleted"
+                                    ],
+                                    "enumDescriptions": [
+                                        "",
+                                        "",
+                                        "",
+                                        ""
+                                    ],
+                                    "location": "query",
+                                    "repeated": true,
+                                    "type": "string"
+                                },
                                 "labelId": {
                                     "description": "Only return messages with a label matching the ID.",
                                     "location": "query",
                                     "type": "string"
                                 },
                                 "maxResults": {
                                     "default": "100",
                                     "description": "The maximum number of history records to return.",
                                     "format": "uint32",
                                     "location": "query",
@@ skipping 385 matching lines @@
                                         "path": "/upload/gmail/v1/users/{userId}/messages/import"
                                     }
                                 }
                             },
                             "parameterOrder": [
                                 "userId"
                             ],
                             "parameters": {
                                 "deleted": {
                                     "default": "false",
-                                    "description": "Mark the email as permanently deleted (not TRASH) and only visible in Google Apps Vault to a Vault administrator. Only used for Google Apps for Work accounts.",
+                                    "description": "Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts.",
                                     "location": "query",
                                     "type": "boolean"
                                 },
                                 "internalDateSource": {
                                     "default": "dateHeader",
                                     "description": "Source for Gmail's internal date of the message.",
                                     "enum": [
                                         "dateHeader",
                                         "receivedTime"
                                     ],
@@ skipping 57 matching lines @@
                                         "path": "/upload/gmail/v1/users/{userId}/messages"
                                     }
                                 }
                             },
                             "parameterOrder": [
                                 "userId"
                             ],
                             "parameters": {
                                 "deleted": {
                                     "default": "false",
-                                    "description": "Mark the email as permanently deleted (not TRASH) and only visible in Google Apps Vault to a Vault administrator. Only used for Google Apps for Work accounts.",
+                                    "description": "Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts.",
                                     "location": "query",
                                     "type": "boolean"
                                 },
                                 "internalDateSource": {
                                     "default": "receivedTime",
                                     "description": "Source for Gmail's internal date of the message.",
                                     "enum": [
                                         "dateHeader",
                                         "receivedTime"
                                     ],
@@ skipping 945 matching lines @@
                                             "location": "path",
                                             "required": true,
                                             "type": "string"
                                         }
                                     },
                                     "path": "{userId}/settings/sendAs/{sendAsEmail}/verify",
                                     "scopes": [
                                         "https://www.googleapis.com/auth/gmail.settings.sharing"
                                     ]
                                 }
+                            },
+                            "resources": {
+                                "smimeInfo": {
+                                    "methods": {
+                                        "delete": {
+                                            "description": "Deletes the specified S/MIME config for the specified send-as alias.",
+                                            "httpMethod": "DELETE",
+                                            "id": "gmail.users.settings.sendAs.smimeInfo.delete",
+                                            "parameterOrder": [
+                                                "userId",
+                                                "sendAsEmail",
+                                                "id"
+                                            ],
+                                            "parameters": {
+                                                "id": {
+                                                    "description": "The immutable ID for the SmimeInfo.",
+                                                    "location": "path",
+                                                    "required": true,
+                                                    "type": "string"
+                                                },
+                                                "sendAsEmail": {
+                                                    "description": "The email address that appears in the \"From:\" header for mail sent using this alias.",
+                                                    "location": "path",
+                                                    "required": true,
+                                                    "type": "string"
+                                                },
+                                                "userId": {
+                                                    "default": "me",
+                                                    "description": "The user's email address. The special value me can be used to indicate the authenticated user.",
+                                                    "location": "path",
+                                                    "required": true,
+                                                    "type": "string"
+                                                }
+                                            },
+                                            "path": "{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}",
+                                            "scopes": [
+                                                "https://www.googleapis.com/auth/gmail.settings.basic",
+                                                "https://www.googleapis.com/auth/gmail.settings.sharing"
+                                            ]
+                                        },
+                                        "get": {
+                                            "description": "Gets the specified S/MIME config for the specified send-as alias.",
+                                            "httpMethod": "GET",
+                                            "id": "gmail.users.settings.sendAs.smimeInfo.get",
+                                            "parameterOrder": [
+                                                "userId",
+                                                "sendAsEmail",
+                                                "id"
+                                            ],
+                                            "parameters": {
+                                                "id": {
+                                                    "description": "The immutable ID for the SmimeInfo.",
+                                                    "location": "path",
+                                                    "required": true,
+                                                    "type": "string"
+                                                },
+                                                "sendAsEmail": {
+                                                    "description": "The email address that appears in the \"From:\" header for mail sent using this alias.",
+                                                    "location": "path",
+                                                    "required": true,
+                                                    "type": "string"
+                                                },
+                                                "userId": {
+                                                    "default": "me",
+                                                    "description": "The user's email address. The special value me can be used to indicate the authenticated user.",
+                                                    "location": "path",
+                                                    "required": true,
+                                                    "type": "string"
+                                                }
+                                            },
+                                            "path": "{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}",
+                                            "response": {
+                                                "$ref": "SmimeInfo"
+                                            },
+                                            "scopes": [
+                                                "https://mail.google.com/",
+                                                "https://www.googleapis.com/auth/gmail.modify",
+                                                "https://www.googleapis.com/auth/gmail.readonly",
+                                                "https://www.googleapis.com/auth/gmail.settings.basic",
+                                                "https://www.googleapis.com/auth/gmail.settings.sharing"
+                                            ]
+                                        },
+                                        "insert": {
+                                            "description": "Insert (upload) the given S/MIME config for the specified send-as alias. Note that pkcs12 format is required for the key.",
+                                            "httpMethod": "POST",
+                                            "id": "gmail.users.settings.sendAs.smimeInfo.insert",
+                                            "parameterOrder": [
+                                                "userId",
+                                                "sendAsEmail"
+                                            ],
+                                            "parameters": {
+                                                "sendAsEmail": {
+                                                    "description": "The email address that appears in the \"From:\" header for mail sent using this alias.",
+                                                    "location": "path",
+                                                    "required": true,
+                                                    "type": "string"
+                                                },
+                                                "userId": {
+                                                    "default": "me",
+                                                    "description": "The user's email address. The special value me can be used to indicate the authenticated user.",
+                                                    "location": "path",
+                                                    "required": true,
+                                                    "type": "string"
+                                                }
+                                            },
+                                            "path": "{userId}/settings/sendAs/{sendAsEmail}/smimeInfo",
+                                            "request": {
+                                                "$ref": "SmimeInfo"
+                                            },
+                                            "response": {
+                                                "$ref": "SmimeInfo"
+                                            },
+                                            "scopes": [
+                                                "https://www.googleapis.com/auth/gmail.settings.basic",
+                                                "https://www.googleapis.com/auth/gmail.settings.sharing"
+                                            ]
+                                        },
+                                        "list": {
+                                            "description": "Lists S/MIME configs for the specified send-as alias.",
+                                            "httpMethod": "GET",
+                                            "id": "gmail.users.settings.sendAs.smimeInfo.list",
+                                            "parameterOrder": [
+                                                "userId",
+                                                "sendAsEmail"
+                                            ],
+                                            "parameters": {
+                                                "sendAsEmail": {
+                                                    "description": "The email address that appears in the \"From:\" header for mail sent using this alias.",
+                                                    "location": "path",
+                                                    "required": true,
+                                                    "type": "string"
+                                                },
+                                                "userId": {
+                                                    "default": "me",
+                                                    "description": "The user's email address. The special value me can be used to indicate the authenticated user.",
+                                                    "location": "path",
+                                                    "required": true,
+                                                    "type": "string"
+                                                }
+                                            },
+                                            "path": "{userId}/settings/sendAs/{sendAsEmail}/smimeInfo",
+                                            "response": {
+                                                "$ref": "ListSmimeInfoResponse"
+                                            },
+                                            "scopes": [
+                                                "https://mail.google.com/",
+                                                "https://www.googleapis.com/auth/gmail.modify",
+                                                "https://www.googleapis.com/auth/gmail.readonly",
+                                                "https://www.googleapis.com/auth/gmail.settings.basic",
+                                                "https://www.googleapis.com/auth/gmail.settings.sharing"
+                                            ]
+                                        },
+                                        "setDefault": {
+                                            "description": "Sets the default S/MIME config for the specified send-as alias.",
+                                            "httpMethod": "POST",
+                                            "id": "gmail.users.settings.sendAs.smimeInfo.setDefault",
+                                            "parameterOrder": [
+                                                "userId",
+                                                "sendAsEmail",
+                                                "id"
+                                            ],
+                                            "parameters": {
+                                                "id": {
+                                                    "description": "The immutable ID for the SmimeInfo.",
+                                                    "location": "path",
+                                                    "required": true,
+                                                    "type": "string"
+                                                },
+                                                "sendAsEmail": {
+                                                    "description": "The email address that appears in the \"From:\" header for mail sent using this alias.",
+                                                    "location": "path",
+                                                    "required": true,
+                                                    "type": "string"
+                                                },
+                                                "userId": {
+                                                    "default": "me",
+                                                    "description": "The user's email address. The special value me can be used to indicate the authenticated user.",
+                                                    "location": "path",
+                                                    "required": true,
+                                                    "type": "string"
+                                                }
+                                            },
+                                            "path": "{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault",
+                                            "scopes": [
+                                                "https://www.googleapis.com/auth/gmail.settings.basic",
+                                                "https://www.googleapis.com/auth/gmail.settings.sharing"
+                                            ]
+                                        }
+                                    }
+                                }
                             }
                         }
                     }
                 },
                 "threads": {
                     "methods": {
                         "delete": {
                             "description": "Immediately and permanently deletes the specified thread. This operation cannot be undone. Prefer threads.trash instead.",
                             "httpMethod": "DELETE",
                             "id": "gmail.users.threads.delete",
@@ skipping 230 matching lines @@
                             "scopes": [
                                 "https://mail.google.com/",
                                 "https://www.googleapis.com/auth/gmail.modify"
                             ]
                         }
                     }
                 }
             }
         }
     },
-    "revision": "20170117",
+    "revision": "20170206",
     "rootUrl": "https://www.googleapis.com/",
     "schemas": {
         "AutoForwarding": {
             "description": "Auto-forwarding settings for an account.",
             "id": "AutoForwarding",
             "properties": {
                 "disposition": {
                     "description": "The state that a message should be left in after it has been forwarded.",
                     "enum": [
                         "archive",
@@ skipping 548 matching lines @@
                 "sendAs": {
                     "description": "List of send-as aliases.",
                     "items": {
                         "$ref": "SendAs"
                     },
                     "type": "array"
                 }
             },
             "type": "object"
         },
+        "ListSmimeInfoResponse": {
+            "id": "ListSmimeInfoResponse",
+            "properties": {
+                "smimeInfo": {
+                    "description": "List of SmimeInfo.",
+                    "items": {
+                        "$ref": "SmimeInfo"
+                    },
+                    "type": "array"
+                }
+            },
+            "type": "object"
+        },
         "ListThreadsResponse": {
             "id": "ListThreadsResponse",
             "properties": {
                 "nextPageToken": {
                     "description": "Page token to retrieve the next page of results in the list.",
                     "type": "string"
                 },
                 "resultSizeEstimate": {
                     "description": "Estimated total number of results.",
                     "format": "uint32",
@@ skipping 292 matching lines @@
                     "enumDescriptions": [
                         "",
                         "",
                         ""
                     ],
                     "type": "string"
                 }
             },
             "type": "object"
         },
+        "SmimeInfo": {
+            "description": "An S/MIME email config.",
+            "id": "SmimeInfo",
+            "properties": {
+                "encryptedKeyPassword": {
+                    "description": "Encrypted key password, when key is encrypted.",
+                    "type": "string"
+                },
+                "expiration": {
+                    "description": "When the certificate expires (in milliseconds since epoch).",
+                    "format": "int64",
+                    "type": "string"
+                },
+                "id": {
+                    "description": "The immutable ID for the SmimeInfo.",
+                    "type": "string"
+                },
+                "isDefault": {
+                    "description": "Whether this SmimeInfo is the default one for this user's send-as address.",
+                    "type": "boolean"
+                },
+                "issuerCn": {
+                    "description": "The S/MIME certificate issuer's common name.",
+                    "type": "string"
+                },
+                "pem": {
+                    "description": "PEM formatted X509 concatenated certificate string (standard base64 encoding). Format used for returning key, which includes public key as well as certificate chain (not private key).",
+                    "type": "string"
+                },
+                "pkcs12": {
+                    "description": "PKCS#12 format containing a single private/public key pair and certificate chain. This format is only accepted from client for creating a new SmimeInfo and is never returned, because the private key is not intended to be exported. PKCS#12 may be encrypted, in which case encryptedKeyPassword should be set appropriately.",
+                    "format": "byte",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
         "SmtpMsa": {
             "description": "Configuration for communication with an SMTP service.",
             "id": "SmtpMsa",
             "properties": {
                 "host": {
                     "description": "The hostname of the SMTP service. Required.",
                     "type": "string"
                 },
                 "password": {
                     "description": "The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.",
@@ skipping 77 matching lines @@
                 },
                 "responseSubject": {
                     "description": "Optional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty.",
                     "type": "string"
                 },
                 "restrictToContacts": {
                     "description": "Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.",
                     "type": "boolean"
                 },
                 "restrictToDomain": {
-                    "description": "Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for Google Apps users.",
+                    "description": "Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for G Suite users.",
                     "type": "boolean"
                 },
                 "startTime": {
                     "description": "An optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both startTime and endTime are specified, startTime must precede endTime.",
                     "format": "int64",
                     "type": "string"
                 }
             },
             "type": "object"
         },
@@ skipping 42 matching lines @@
                     "type": "string"
                 }
             },
             "type": "object"
         }
     },
     "servicePath": "gmail/v1/users/",
     "title": "Gmail API",
     "version": "v1"
 }