kard-financial-sdk 0.0.82__py3-none-any.whl

kard/notifications/subscriptions/client.py

@@ -0,0 +1,372 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ...commons.types.notification_type import NotificationType
+from ...commons.types.organization_id import OrganizationId
+from ...commons.types.subscription_id import SubscriptionId
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.request_options import RequestOptions
+from .raw_client import AsyncRawSubscriptionsClient, RawSubscriptionsClient
+from .types.create_subscriptions_response_object import CreateSubscriptionsResponseObject
+from .types.subscription_request_union import SubscriptionRequestUnion
+from .types.subscriptions_response_object import SubscriptionsResponseObject
+from .types.update_subscription_request_union import UpdateSubscriptionRequestUnion
+from .types.update_subscriptions_response_object import UpdateSubscriptionsResponseObject
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class SubscriptionsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawSubscriptionsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawSubscriptionsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawSubscriptionsClient
+        """
+        return self._raw_client
+
+    def get(
+        self,
+        organization_id: OrganizationId,
+        *,
+        filter_event_name: typing.Optional[NotificationType] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> SubscriptionsResponseObject:
+        """
+        Call this endpoint to fetch the subscriptions of the provided issuer.<br/>
+        <b>Required scopes:</b> `notifications:read`
+
+        Parameters
+        ----------
+        organization_id : OrganizationId
+
+        filter_event_name : typing.Optional[NotificationType]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SubscriptionsResponseObject
+
+        Examples
+        --------
+        from kard import KardApi
+
+        client = KardApi(
+            client_id="YOUR_CLIENT_ID",
+            client_secret="YOUR_CLIENT_SECRET",
+        )
+        client.notifications.subscriptions.get(
+            organization_id="organization-123",
+        )
+        """
+        _response = self._raw_client.get(
+            organization_id, filter_event_name=filter_event_name, request_options=request_options
+        )
+        return _response.data
+
+    def create(
+        self,
+        organization_id: OrganizationId,
+        *,
+        data: typing.Sequence[SubscriptionRequestUnion],
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateSubscriptionsResponseObject:
+        """
+        Call this endpoint to subscribe to notification events.<br/>
+        <b>Required scopes:</b> `notifications:write`
+
+        Parameters
+        ----------
+        organization_id : OrganizationId
+
+        data : typing.Sequence[SubscriptionRequestUnion]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateSubscriptionsResponseObject
+
+        Examples
+        --------
+        from kard import KardApi
+        from kard.notifications.subscriptions import (
+            SubscriptionRequestAttributes,
+            SubscriptionRequestUnion_Subscription,
+        )
+
+        client = KardApi(
+            client_id="YOUR_CLIENT_ID",
+            client_secret="YOUR_CLIENT_SECRET",
+        )
+        client.notifications.subscriptions.create(
+            organization_id="organization-123",
+            data=[
+                SubscriptionRequestUnion_Subscription(
+                    attributes=SubscriptionRequestAttributes(
+                        event_name="earnedRewardApproved",
+                        webhook_url="https://webhookUrl.com/post",
+                        enabled=True,
+                    ),
+                )
+            ],
+        )
+        """
+        _response = self._raw_client.create(organization_id, data=data, request_options=request_options)
+        return _response.data
+
+    def update(
+        self,
+        organization_id: OrganizationId,
+        subscription_id: SubscriptionId,
+        *,
+        data: UpdateSubscriptionRequestUnion,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> UpdateSubscriptionsResponseObject:
+        """
+        Call this endpoint to update existing notification subscriptions.<br/>
+        <b>Required scopes:</b> `notifications:write`
+
+        Parameters
+        ----------
+        organization_id : OrganizationId
+
+        subscription_id : SubscriptionId
+
+        data : UpdateSubscriptionRequestUnion
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        UpdateSubscriptionsResponseObject
+
+        Examples
+        --------
+        from kard import KardApi
+        from kard.notifications.subscriptions import (
+            UpdateSubscriptionRequestAttributes,
+            UpdateSubscriptionRequestUnion_Subscription,
+        )
+
+        client = KardApi(
+            client_id="YOUR_CLIENT_ID",
+            client_secret="YOUR_CLIENT_SECRET",
+        )
+        client.notifications.subscriptions.update(
+            organization_id="organization-123",
+            subscription_id="subscription-123",
+            data=UpdateSubscriptionRequestUnion_Subscription(
+                attributes=UpdateSubscriptionRequestAttributes(
+                    event_name="earnedRewardApproved",
+                    webhook_url="https://webhookUrl.com/post",
+                    enabled=True,
+                ),
+            ),
+        )
+        """
+        _response = self._raw_client.update(
+            organization_id, subscription_id, data=data, request_options=request_options
+        )
+        return _response.data
+
+
+class AsyncSubscriptionsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawSubscriptionsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawSubscriptionsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawSubscriptionsClient
+        """
+        return self._raw_client
+
+    async def get(
+        self,
+        organization_id: OrganizationId,
+        *,
+        filter_event_name: typing.Optional[NotificationType] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> SubscriptionsResponseObject:
+        """
+        Call this endpoint to fetch the subscriptions of the provided issuer.<br/>
+        <b>Required scopes:</b> `notifications:read`
+
+        Parameters
+        ----------
+        organization_id : OrganizationId
+
+        filter_event_name : typing.Optional[NotificationType]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SubscriptionsResponseObject
+
+        Examples
+        --------
+        import asyncio
+
+        from kard import AsyncKardApi
+
+        client = AsyncKardApi(
+            client_id="YOUR_CLIENT_ID",
+            client_secret="YOUR_CLIENT_SECRET",
+        )
+
+
+        async def main() -> None:
+            await client.notifications.subscriptions.get(
+                organization_id="organization-123",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get(
+            organization_id, filter_event_name=filter_event_name, request_options=request_options
+        )
+        return _response.data
+
+    async def create(
+        self,
+        organization_id: OrganizationId,
+        *,
+        data: typing.Sequence[SubscriptionRequestUnion],
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateSubscriptionsResponseObject:
+        """
+        Call this endpoint to subscribe to notification events.<br/>
+        <b>Required scopes:</b> `notifications:write`
+
+        Parameters
+        ----------
+        organization_id : OrganizationId
+
+        data : typing.Sequence[SubscriptionRequestUnion]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateSubscriptionsResponseObject
+
+        Examples
+        --------
+        import asyncio
+
+        from kard import AsyncKardApi
+        from kard.notifications.subscriptions import (
+            SubscriptionRequestAttributes,
+            SubscriptionRequestUnion_Subscription,
+        )
+
+        client = AsyncKardApi(
+            client_id="YOUR_CLIENT_ID",
+            client_secret="YOUR_CLIENT_SECRET",
+        )
+
+
+        async def main() -> None:
+            await client.notifications.subscriptions.create(
+                organization_id="organization-123",
+                data=[
+                    SubscriptionRequestUnion_Subscription(
+                        attributes=SubscriptionRequestAttributes(
+                            event_name="earnedRewardApproved",
+                            webhook_url="https://webhookUrl.com/post",
+                            enabled=True,
+                        ),
+                    )
+                ],
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create(organization_id, data=data, request_options=request_options)
+        return _response.data
+
+    async def update(
+        self,
+        organization_id: OrganizationId,
+        subscription_id: SubscriptionId,
+        *,
+        data: UpdateSubscriptionRequestUnion,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> UpdateSubscriptionsResponseObject:
+        """
+        Call this endpoint to update existing notification subscriptions.<br/>
+        <b>Required scopes:</b> `notifications:write`
+
+        Parameters
+        ----------
+        organization_id : OrganizationId
+
+        subscription_id : SubscriptionId
+
+        data : UpdateSubscriptionRequestUnion
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        UpdateSubscriptionsResponseObject
+
+        Examples
+        --------
+        import asyncio
+
+        from kard import AsyncKardApi
+        from kard.notifications.subscriptions import (
+            UpdateSubscriptionRequestAttributes,
+            UpdateSubscriptionRequestUnion_Subscription,
+        )
+
+        client = AsyncKardApi(
+            client_id="YOUR_CLIENT_ID",
+            client_secret="YOUR_CLIENT_SECRET",
+        )
+
+
+        async def main() -> None:
+            await client.notifications.subscriptions.update(
+                organization_id="organization-123",
+                subscription_id="subscription-123",
+                data=UpdateSubscriptionRequestUnion_Subscription(
+                    attributes=UpdateSubscriptionRequestAttributes(
+                        event_name="earnedRewardApproved",
+                        webhook_url="https://webhookUrl.com/post",
+                        enabled=True,
+                    ),
+                ),
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.update(
+            organization_id, subscription_id, data=data, request_options=request_options
+        )
+        return _response.data