ds_provider_powerofficego_py_lib.linked_service¶

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.

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¶

ds_provider_powerofficego_py_lib.linked_service.powerofficego

Classes¶

`PowerOfficeGoLinkedService`	PowerOfficeGo linked service for connecting to the PowerOfficeGo API.
`PowerOfficeGoLinkedServiceSettings`	Settings for PowerOfficeGo linked service in order to connect to the PowerOfficeGo API.

Package Contents¶

class ds_provider_powerofficego_py_lib.linked_service.PowerOfficeGoLinkedService[source]¶

Bases: ds_protocol_http_py_lib.HttpLinkedService[PowerOfficeGoLinkedServiceSettingsType], Generic[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.

settings: PowerOfficeGoLinkedServiceSettingsType¶: Settings for PowerOfficeGo linked service.

property type: ds_provider_powerofficego_py_lib.enums.ResourceType¶

Get the resource type for PowerOfficeGo linked service.

Returns:: The resource type for PowerOfficeGo linked service.
Return type:: ResourceType

__post_init__() → None[source]¶

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.

class ds_provider_powerofficego_py_lib.linked_service.PowerOfficeGoLinkedServiceSettings[source]¶

Bases: ds_protocol_http_py_lib.HttpLinkedServiceSettings

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

Attributes:

application_key: str¶: Application key for PowerOfficeGo API authentication.

client_id: str¶: Client ID for PowerOfficeGo API authentication.

subscription_key: str¶: Subscription key for PowerOfficeGo API authentication.

headers: dict[str, str] | None = None¶: Headers for PowerOfficeGo API requests.

token_endpoint: str = 'https://goapi.poweroffice.net/OAuth/Token'¶: Token endpoint URL for PowerOfficeGo API authentication.

host: str = 'https://goapi.poweroffice.net/'¶: Host URL for PowerOfficeGo API.

api_version: str = 'v2'¶: API version for PowerOfficeGo API.

auth_type: ds_protocol_http_py_lib.enums.AuthType¶: Authentication type for PowerOfficeGo API.

oauth2: ds_protocol_http_py_lib.linked_service.OAuth2AuthSettings | None = None¶: OAuth2 authentication settings for PowerOfficeGo API.