leaf_engine.io.gdrive.service
=============================

.. py:module:: leaf_engine.io.gdrive.service


Attributes
----------

.. autoapisummary::

   leaf_engine.io.gdrive.service.GOOGLE_DRIVE_SCOPES
   leaf_engine.io.gdrive.service.LeafGoogleDriveException
   leaf_engine.io.gdrive.service.MIME_TYPE_CSV
   leaf_engine.io.gdrive.service.MIME_TYPE_EXCEL_SPREADSHEET
   leaf_engine.io.gdrive.service.MIME_TYPE_FOLDER


Functions
---------

.. autoapisummary::

   leaf_engine.io.gdrive.service.create
   leaf_engine.io.gdrive.service.get_credentials
   leaf_engine.io.gdrive.service.get_service
   leaf_engine.io.gdrive.service.update


Module Contents
---------------

.. py:function:: create(name: str, parent_folder_id: Optional[str], drive_id: str, mime_type: Optional[str] = None, media: Optional[Union[googleapiclient.http.MediaFileUpload, googleapiclient.http.MediaIoBaseUpload]] = None) -> dict

   Executes Google Drive HttpRequest to create/upload resources (files,
   folders).

   :param name: Resource name.
   :type name: str
   :param parent_folder_id: Google Drive folder ID where to place resource. The ID
                            can be found in the folder URL. If None, creates resource in Drive root.
   :type parent_folder_id: str
   :param drive_id: The Google Drive ID to upload to.
   :type drive_id: str, optional
   :param mime_type: Type of resource to create.
   :type mime_type: Optional[str], optional
   :param media: When creating/uploading files, the file content.
   :type media: Optional[Union[MediaFileUpload, MediaIoBaseUpload]], optional

   :returns: Request response.
   :rtype: dict


.. py:function:: get_credentials() -> dict

.. py:function:: get_service()

.. py:function:: update(file_id: str, media: Union[googleapiclient.http.MediaFileUpload, googleapiclient.http.MediaIoBaseUpload]) -> dict

   Executes Google Drive HttpRequest to update files.

   :param file_id: File ID.
   :type file_id: str
   :param media: File content.
   :type media: Union[MediaFileUpload, MediaIoBaseUpload]]

   :returns: Request response.
   :rtype: dict


.. py:data:: GOOGLE_DRIVE_SCOPES
   :value: ['https://www.googleapis.com/auth/drive']


.. py:data:: LeafGoogleDriveException

.. py:data:: MIME_TYPE_CSV
   :value: 'text/csv'


.. py:data:: MIME_TYPE_EXCEL_SPREADSHEET
   :value: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'


.. py:data:: MIME_TYPE_FOLDER
   :value: 'application/vnd.google-apps.folder'