ds_provider_powerofficego_py_lib.linked_service
===============================================

.. py:module:: ds_provider_powerofficego_py_lib.linked_service

.. autoapi-nested-parse::

   **File:** ``__init__.py``
   **Region:** ``ds_provider_powerofficego_py_lib/linked_service``

   PowerOfficeGo Linked Service

   This module defines the PowerOfficeGo linked service for the PowerOfficeGo provider.

   .. rubric:: Example

   >>> from uuid import UUID
   >>> linked_service = PowerOfficeGoLinkedService(
   ...     id=UUID("12345678-1234-5678-1234-1234567890ab"),
   ...     name="pogo-linked-service",
   ...     version="v1.0.0",
   ...     settings=PowerOfficeGoLinkedServiceSettings(
   ...         application_key="my-application-key",
   ...         client_id="my-client-id",
   ...         subscription_key="my-subscription-key",
   ...     ),
   ... )
   >>> linked_service.connect()
   >>> linked_service.test_connection()



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/ds_provider_powerofficego_py_lib/linked_service/powerofficego/index


Classes
-------

.. autoapisummary::

   ds_provider_powerofficego_py_lib.linked_service.PowerOfficeGoLinkedService
   ds_provider_powerofficego_py_lib.linked_service.PowerOfficeGoLinkedServiceSettings


Package Contents
----------------

.. py:class:: PowerOfficeGoLinkedService

   Bases: :py:obj:`ds_protocol_http_py_lib.HttpLinkedService`\ [\ :py:obj:`PowerOfficeGoLinkedServiceSettingsType`\ ], :py:obj:`Generic`\ [\ :py:obj:`PowerOfficeGoLinkedServiceSettingsType`\ ]


   PowerOfficeGo linked service for connecting to the PowerOfficeGo API.

   This class extends the HttpLinkedService and provides specific settings for
   connecting to the PowerOfficeGo API. It includes the necessary authentication
   details and configuration required to establish a connection with the PowerOfficeGo service.


   .. py:attribute:: settings
      :type:  PowerOfficeGoLinkedServiceSettingsType

      Settings for PowerOfficeGo linked service.


   .. py:property:: type
      :type: ds_provider_powerofficego_py_lib.enums.ResourceType


      Get the resource type for PowerOfficeGo linked service.

      :returns: The resource type for PowerOfficeGo linked service.
      :rtype: ResourceType


   .. py:method:: __post_init__() -> None

      Post-initialization processing for PowerOfficeGo linked service.

      This method is called after the dataclass has been initialized. It can be used
      to perform any additional setup or validation required for the PowerOfficeGo linked service.



.. py:class:: PowerOfficeGoLinkedServiceSettings

   Bases: :py:obj:`ds_protocol_http_py_lib.HttpLinkedServiceSettings`


   Settings for PowerOfficeGo linked service in order to connect to the PowerOfficeGo API.

   Attributes:


   .. py:attribute:: application_key
      :type:  str

      Application key for PowerOfficeGo API authentication.


   .. py:attribute:: client_id
      :type:  str

      Client ID for PowerOfficeGo API authentication.


   .. py:attribute:: subscription_key
      :type:  str

      Subscription key for PowerOfficeGo API authentication.


   .. py:attribute:: headers
      :type:  dict[str, str] | None
      :value: None


      Headers for PowerOfficeGo API requests.


   .. py:attribute:: token_endpoint
      :type:  str
      :value: 'https://goapi.poweroffice.net/OAuth/Token'


      Token endpoint URL for PowerOfficeGo API authentication.


   .. py:attribute:: host
      :type:  str
      :value: 'https://goapi.poweroffice.net/'


      Host URL for PowerOfficeGo API.


   .. py:attribute:: api_version
      :type:  str
      :value: 'v2'


      API version for PowerOfficeGo API.


   .. py:attribute:: auth_type
      :type:  ds_protocol_http_py_lib.enums.AuthType

      Authentication type for PowerOfficeGo API.


   .. py:attribute:: oauth2
      :type:  ds_protocol_http_py_lib.linked_service.OAuth2AuthSettings | None
      :value: None


      OAuth2 authentication settings for PowerOfficeGo API.