Metadata-Version: 2.4
Name: odoo-addon-contract_api_somconnexio
Version: 16.0.1.0.15
Summary: Expose the REST API used in Som Connexió to create and manage contracts in Odoo.
Home-page: https://git.coopdevs.org/coopdevs/som-connexio/odoo/odoo-somconnexio
Author: Som Connexió SCCL, Coopdevs Treball SCCL
License: AGPL-3
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
Requires-Dist: faker
Requires-Dist: odoo-addon-contract_group_somconnexio<16.1dev,>=16.0dev
Requires-Dist: odoo-addon-res_partner_api_somconnexio<16.1dev,>=16.0dev
Requires-Dist: odoo-addon-somconnexio<16.1dev,>=16.0dev
Requires-Dist: odoo-addon-switchboard_somconnexio<16.1dev,>=16.0dev
Requires-Dist: odoo<16.1dev,>=16.0a
Dynamic: author
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: license
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

############################
 Contract API - SomConnexio
############################

..
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:1614423d340008335f552b55056ced34554a9187993e584db2ccb85c9738b530
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |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

.. |badge3| image:: https://img.shields.io/badge/gitlab-coopdevs%2Fodoo--somconnexio-lightgray.png?logo=gitlab
   :alt: coopdevs/som-connexio/odoo-somconnexio
   :target: https://git.coopdevs.org/coopdevs/som-connexio/odoo-somconnexio

|badge1| |badge2| |badge3|

This module is a part of SomConnexió original module.

We are working to separate the monolitic original module in small
modules splited by functionalities.

This module manage the Contract API. The API is used to get, create and
modify contracts using the Som Connexió processes.

**Table of contents**

.. contents::
   :local:

***************
 Configuration
***************

Create a API key with a user related with the needed security rights to
read and modify contracts.

You can follow the next instruccions:

-  Settings > Technical (debug mode) > Auth API Key
-  click create and select a user, save.
-  communicate the API-KEY to the client or app to use the API.

*******
 Usage
*******

This module provides a REST API to manage contract-related operations in
Odoo. Below are the key endpoints and their functionalities:

-  **Create Contract**

   -  Endpoint: `/api/contract/create`
   -  Method: POST
   -  Description: Create a new contract with the provided details.

-  **Get Contract**

   -  Endpoint: `/api/contract/get`
   -  Method: GET
   -  Description: Retrieve details of an existing contract.

-  **Update the Services**

   -  **Change Tariff**

      -  Endpoint: `/api/contract/service/change_tariff`
      -  Method: PUT
      -  Description: Update the tariff of an existing service.

   -  **Add One Shot**

      -  Endpoint: `/api/contract/service/add_one_shot`
      -  Method: POST
      -  Description: Add a one-time service to the contract.

   -  **Terminate Contract**

      -  Endpoint: `/api/contract/service/terminate`
      -  Method: DELETE
      -  Description: Terminate a specific service in the contract.

-  **Update the Contract Data**

   -  **Change Email**

      -  Endpoint: `/api/contract/update/email`
      -  Method: PUT
      -  Description: Update the email address associated with the
         contract.

   -  **Change IBAN**

      -  Endpoint: `/api/contract/update/iban`
      -  Method: PUT
      -  Description: Update the IBAN for payments related to the
         contract.

-  **Query Actions**

   -  **Terminate Reasons**

      -  Endpoint: `/api/contract/query/terminate_reasons`
      -  Method: GET
      -  Description: Retrieve a list of valid reasons for contract
         termination.

   -  **Available Fibers**

      -  Endpoint: `/api/contract/query/available_fibers`
      -  Method: GET
      -  Description: Get a list of available fiber connections to link
         with mobile services.

   -  **Contract Count**

      -  Endpoint: `/api/contract/query/count`
      -  Method: GET
      -  Description: Get the total number of contracts in the system.

More info about the listeners:
https://odoo-connector.com/api/api_components.html#listeners

**************
 Contributors
**************

-  ``Som Connexió SCCL <https://somconnexio.coop/>``

   -  Gerard Funonsas gerard.funosas@somconnexio.coop
   -  Borja Gimeno borja.gimeno@somconnexio.coop

-  ``Coopdevs Treball SCCL <https://coopdevs.coop/>``

   -  Daniel Palomar daniel.palomar@coopdevs.org
   -  Cesar Lopez cesar.lopez@coopdevs.org
   -  Carla Berenguer carla.berenguer@coopdevs.org
