Metadata-Version: 1.2
Name: odoo-addon-crm_lead_dms_api
Version: 16.0.1.1.0
Summary: API to check if a CRM Lead has all the required documents
Home-page: https://gitlab.com/somitcoop/erp-research/odoo-helpdesk
Author: Som It Cooperatiu SCCL, Som Connexió SCCL, Odoo Community Association (OCA)
Author-email: support@odoo-community.org
License: AGPL-3
Description: ##################
         CRM LEAD DMS API
        ##################
        
        ..
           !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
           !! This file is generated by oca-gen-addon-readme !!
           !! changes will be overwritten.                   !!
           !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
           !! source digest: sha256:fa88a5911e9d75e4ccaee78931e61a91ccfe34e0de09254e0edd30ad0752f428
           !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
        
        .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
           :alt: Beta
           :target: https://odoo-community.org/page/development-status
        
        .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
           :alt: License: AGPL-3
           :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
        
        |badge1| |badge2|
        
        CRM LEAD DMS API
        
        **Table of contents**
        
        .. contents::
           :local:
        
        ***************
         Configuration
        ***************
        
        To give access to the API to a structure, go to
        
        -  Settings > Technical (debug mode) > Auth API Key
        -  Click create and select a user, save.
        -  Communicate the API-KEY to those in need to use the API.
        
        *******
         Usage
        *******
        
        Example of curl to check crm-lead required documents with these
        variables to fill:
        
        -  `API_KEY`: authorized key from the odoo server's API-KEY (see
           previows paragraph)
        -  `BASE_URL`: target ODOO server's URL
        -  `ENDPOINT`: '/api/crm-lead/documents_required'
        -  `CRM_LEAD_TOKEN`: token of the crm-lead to check
        
        .. code:: bash
        
           curl -sX GET -H  "api-key: $APIKEY" "$BASE_URL/$ENDPOINT/$CRM_LEAD_TOKEN"
        
        Response: - 200: OK
        
           .. code:: JSON
        
              {
                  "crm_lead_id": <<crm-lead-id>>,
                  "crm_lead_token": <<crm-lead-token>>,
                  "document_category": <<document-category-code>>,
                  "document_id": <<dms-file-id>>,
                  "document_exit": false
              }
        
        ************************
         Known issues / Roadmap
        ************************
        
        There are no issues for the moment.
        
        *************
         Bug Tracker
        *************
        
        Bugs are tracked on `GitLab Issues
        <https://gitlab.com/somitcoop/erp-research/odoo-helpdesk/-/issues>`_. In
        case of trouble, please check there if your issue has already been
        reported. If you spotted it first, help us smashing it by providing a
        detailed and welcomed feedback.
        
        Do not contact contributors directly about support or help with
        technical issues.
        
        *********
         Credits
        *********
        
        Authors
        =======
        
        -  SomIT SCCL
        -  Som Connexio SCCL
        
        Contributors
        ============
        
        -  `SomIT SCCL <https://somit.coop>`_:
        
              -  Álvaro García <alvaro.garcia@somit.coop>
              -  José Robles <jose.robles@somit.coop>
              -  Juan Manuel Regalado <juanmanuel.regalado@somit.coop>
        
        -  `Som Connexio SCCL <https://somconnexio.coop>`_:
        
              -  Gerard Funosas <gerard.funosas@somconnexio.coop>
        
        Maintainers
        ===========
        
        This module is maintained by the OCA.
        
        .. image:: https://odoo-community.org/logo.png
           :alt: Odoo Community Association
           :target: https://odoo-community.org
        
        OCA, or the Odoo Community Association, is a nonprofit organization
        whose mission is to support the collaborative development of Odoo
        features and promote its widespread use.
        
        You are welcome to contribute. To learn how please visit
        https://odoo-community.org/page/Contribute.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 16.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Requires-Python: >=3.10
