Google Trash API

Operations related to Trash

OpenAPI Specification

google-trash-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Google Books About Trash API
  description: API for retrieving Bookshelf and Volume resources from Google Books
  version: 1.0.0
  contact:
    name: Google Books API
    url: https://developers.google.com/books
servers:
- url: https://www.googleapis.com/books/v1
  description: Google Books API v1
tags:
- name: Trash
  description: Operations related to Trash
paths:
  /gmail/v1/users/{userId}/messages/{id}/trash:
    post:
      tags:
      - Trash
      summary: Google Trash Messsages
      description: Moves the specified message to the trash.
      parameters:
      - name: Accept
        in: header
        schema:
          type: string
        example: application/json
      - name: userId
        in: path
        schema:
          type: string
        required: true
        description: '(Required) '
        example: incididunt labore i
      - name: id
        in: path
        schema:
          type: string
        required: true
        description: '(Required) '
        example: incididunt labore i
      requestBody:
        content: {}
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersMessagesTrashPostResponse'
              examples:
                UsersMessagesTrashPostResponseExample:
                  $ref: '#/components/examples/UsersMessagesTrashPostResponseExample'
      x-api-evangelist-processing:
        ChooseTags: true
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: UsersMessagesTrashPostResponseExample
  /gmail/v1/users/{userId}/threads/{id}/trash:
    post:
      tags:
      - Trash
      summary: Google Trash Threads
      description: Moves the specified thread to the trash. Any messages that belong to the thread are also moved to the trash.
      parameters:
      - name: Accept
        in: header
        schema:
          type: string
        example: application/json
      - name: userId
        in: path
        schema:
          type: string
        required: true
        description: '(Required) '
        example: incididunt labore i
      - name: id
        in: path
        schema:
          type: string
        required: true
        description: '(Required) '
        example: incididunt labore i
      requestBody:
        content: {}
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersThreadsTrashPostResponse'
              examples:
                UsersThreadsTrashPostResponseExample:
                  $ref: '#/components/examples/UsersThreadsTrashPostResponseExample'
      x-api-evangelist-processing:
        ChooseTags: true
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: UsersThreadsTrashPostResponseExample
components:
  schemas:
    UsersThreadsTrashPostResponse:
      description: UsersThreadsTrashPostResponse schema
      type: object
      properties:
        id:
          type: string
        snippet:
          type: string
        historyId:
          type: string
        messages:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              threadId:
                type: string
              labelIds:
                type: array
                items:
                  type: string
              snippet:
                type: string
              historyId:
                type: string
              internalDate:
                type: string
              payload:
                type: object
                properties:
                  partId:
                    type: string
                  mimeType:
                    type: string
                  filename:
                    type: string
                  headers:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                        value:
                          type: string
                  body:
                    type: object
                    properties:
                      attachmentId:
                        type: string
                      size:
                        type: integer
                      data:
                        type: string
                  parts:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
              sizeEstimate:
                type: integer
              raw:
                type: string
    UsersMessagesTrashPostResponsePayload:
      description: UsersMessagesTrashPostResponsePayload schema
      type: object
      properties:
        partId:
          type: string
        mimeType:
          type: string
        filename:
          type: string
        headers:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              value:
                type: string
        body:
          $ref: '#/components/schemas/UsersMessagesTrashPostResponsePayloadBody'
        parts:
          type: array
          items:
            type: object
            properties:
              value:
                type: string
    UsersMessagesTrashPostResponsePayloadBody:
      description: UsersMessagesTrashPostResponsePayloadBody schema
      type: object
      properties:
        attachmentId:
          type: string
        size:
          type: integer
        data:
          type: string
    UsersMessagesTrashPostResponse:
      description: UsersMessagesTrashPostResponse schema
      type: object
      properties:
        id:
          type: string
        threadId:
          type: string
        labelIds:
          type: array
          items:
            type: string
        snippet:
          type: string
        historyId:
          type: string
        internalDate:
          type: string
        payload:
          $ref: '#/components/schemas/UsersMessagesTrashPostResponsePayload'
        sizeEstimate:
          type: integer
        raw:
          type: string
  examples:
    UsersMessagesTrashPostResponseExample:
      summary: Successful 200 response
      value:
        id: eu incididunt laborum irure
        threadId: magna Ut officia
        labelIds:
        - mollit amet dolore cupidatat
        - cupidatat deserunt mollit
        snippet: ut dolor
        historyId: nisi tempor do
        internalDate: cupidatat officia anim
        payload:
          partId: dolore velit incididunt est a
          mimeType: sit dolor mollit
          filename: ea commodo dolor nisi
          headers:
          - name: quis id velit laborum
            value: et voluptate dolor ea
          - name: sit nostrud
            value: deserunt fugiat ex
          body:
            attachmentId: id nulla consequat
            size: -93837667
            data: ad in occaecat
          parts:
          - value: '<Circular reference to #/components/schemas/MessagePart detected>'
          - value: '<Circular reference to #/components/schemas/MessagePart detected>'
        sizeEstimate: 21128811
        raw: do laboris
    UsersThreadsTrashPostResponseExample:
      summary: Successful 200 response
      value:
        id: nostrud deserunt
        snippet: cillum quis
        historyId: id ea ad amet venia
        messages:
        - id: exercitation sint
          threadId: Ut sed occaecat
          labelIds:
          - in commodo
          - sit dolor
          snippet: dolor fugiat Ut
          historyId: Lorem quis ullamco veniam
          internalDate: consectetur elit dolor
          payload:
            partId: mi
            mimeType: elit
            filename: ex
            headers:
            - name: velit do voluptate
              value: in reprehenderit sit pariatur
            - name: enim
              value: vel
            body:
              attachmentId: e
              size: 62147464
              data: aliquip aute in Excepteur
            parts:
            - value: '<Circular reference to #/components/schemas/MessagePart detected>'
            - value: '<Circular reference to #/components/schemas/MessagePart detected>'
          sizeEstimate: -33441686
          raw: Ut sit
        - id: magna pariatur
          threadId: et
          labelIds:
          - est dolore
          - Lorem Duis amet dolore
          snippet: dolore est reprehender
          historyId: in ex veniam nulla
          internalDate: ut
          payload:
            partId: do consectetur tempor qui in
            mimeType: Excepteur in
            filename: reprehenderit
            headers:
            - name: nulla sed ut
              value: et occaecat
            - name: mollit elit commodo nostrud pariatur
              value: aliqua
            body:
              attachmentId: sit sunt occaecat
              size: 23654047
              data: dolor ut
            parts:
            - value: '<Circular reference to #/components/schemas/MessagePart detected>'
            - value: '<Circular reference to #/components/schemas/MessagePart detected>'
          sizeEstimate: 2028457
          raw: ipsum enim minim
  securitySchemes:
    OAuth2:
      type: oauth2
      description: OAuth 2.0 authentication for Google Books API
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.google.com/o/oauth2/v2/auth
          tokenUrl: https://oauth2.googleapis.com/token
          scopes:
            https://www.googleapis.com/auth/books: Manage your Google Books library