From 87391ea028493a4be09648fd561d555bced8e3b9 Mon Sep 17 00:00:00 2001 From: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com> Date: Sun, 17 Nov 2024 21:04:22 +0100 Subject: [PATCH] Add New Parameters to `create_invoice_link` --- telegram/_bot.py | 20 +++++++++++++++++++- telegram/constants.py | 4 ++++ telegram/ext/_extbot.py | 6 +++++- tests/_payment/test_invoice.py | 11 +++++++++-- 4 files changed, 37 insertions(+), 4 deletions(-) diff --git a/telegram/_bot.py b/telegram/_bot.py index cc2ba38fb..08db838b4 100644 --- a/telegram/_bot.py +++ b/telegram/_bot.py @@ -24,7 +24,7 @@ import contextlib import copy import pickle from collections.abc import Sequence -from datetime import datetime +from datetime import datetime, timedelta from types import TracebackType from typing import ( TYPE_CHECKING, @@ -8024,6 +8024,8 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified. send_phone_number_to_provider: Optional[bool] = None, send_email_to_provider: Optional[bool] = None, is_flexible: Optional[bool] = None, + subscription_period: Optional[Union[int, timedelta]] = None, + business_connection_id: Optional[str] = None, *, read_timeout: ODVInput[float] = DEFAULT_NONE, write_timeout: ODVInput[float] = DEFAULT_NONE, @@ -8036,6 +8038,9 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified. .. versionadded:: 20.0 Args: + business_connection_id (:obj:`str`, optional): |business_id_str| + + .. versionadded:: NEXT.VERSION title (:obj:`str`): Product name. :tg-const:`telegram.Invoice.MIN_TITLE_LENGTH`- :tg-const:`telegram.Invoice.MAX_TITLE_LENGTH` characters. description (:obj:`str`): Product description. @@ -8062,6 +8067,13 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified. .. versionchanged:: 20.0 |sequenceargs| + subscription_period (:obj:`int` | :class:`datetime.timedelta`, optional): The time the + subscription will be active for before the next payment, either as number of + seconds or as :class:`datetime.timedelta` object. The currency must be set to + ``“XTR”`` (Telegram Stars) if the parameter is used. Currently, it must always be + :tg-const:`telegram.constants.InvoiceLimit.SUBSCRIPTION_PERIOD` if specified. + + .. versionadded:: NEXT.VERSION max_tip_amount (:obj:`int`, optional): The maximum accepted amount for tips in the *smallest units* of the currency (integer, **not** float/double). For example, for a maximum tip of ``US$ 1.45`` pass ``max_tip_amount = 145``. See the ``exp`` @@ -8127,6 +8139,12 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified. "is_flexible": is_flexible, "send_phone_number_to_provider": send_phone_number_to_provider, "send_email_to_provider": send_email_to_provider, + "subscription_period": ( + subscription_period.total_seconds() + if isinstance(subscription_period, timedelta) + else subscription_period + ), + "business_connection_id": business_connection_id, } return await self._post( diff --git a/telegram/constants.py b/telegram/constants.py index 10f887a93..bcb451539 100644 --- a/telegram/constants.py +++ b/telegram/constants.py @@ -2902,6 +2902,10 @@ class InvoiceLimit(IntEnum): .. versionadded:: 21.6 """ + SUBSCRIPTION_PERIOD = datetime.timedelta(days=30).total_seconds() + """:obj:`int`: The period of time for which the subscription is active before + the next payment, passed as :paramref:`~telegram.Bot.create_invoice_link.subscription_period` + parameter of :meth:`telegram.Bot.create_invoice_link`.""" class UserProfilePhotosLimit(IntEnum): diff --git a/telegram/ext/_extbot.py b/telegram/ext/_extbot.py index 66921e415..b9842781a 100644 --- a/telegram/ext/_extbot.py +++ b/telegram/ext/_extbot.py @@ -20,7 +20,7 @@ """This module contains an object that represents a Telegram Bot with convenience extensions.""" from collections.abc import Sequence from copy import copy -from datetime import datetime +from datetime import datetime, timedelta from typing import ( TYPE_CHECKING, Any, @@ -1171,6 +1171,8 @@ class ExtBot(Bot, Generic[RLARGS]): send_phone_number_to_provider: Optional[bool] = None, send_email_to_provider: Optional[bool] = None, is_flexible: Optional[bool] = None, + subscription_period: Optional[Union[int, timedelta]] = None, + business_connection_id: Optional[str] = None, *, read_timeout: ODVInput[float] = DEFAULT_NONE, write_timeout: ODVInput[float] = DEFAULT_NONE, @@ -1204,6 +1206,8 @@ class ExtBot(Bot, Generic[RLARGS]): write_timeout=write_timeout, connect_timeout=connect_timeout, pool_timeout=pool_timeout, + subscription_period=subscription_period, + business_connection_id=business_connection_id, api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), ) diff --git a/tests/_payment/test_invoice.py b/tests/_payment/test_invoice.py index 585f4fd3e..a28aedc43 100644 --- a/tests/_payment/test_invoice.py +++ b/tests/_payment/test_invoice.py @@ -17,6 +17,7 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. import asyncio +import datetime as dtm import pytest @@ -122,10 +123,14 @@ class TestInvoiceWithoutRequest(InvoiceTestBase): protect_content=True, ) - async def test_send_all_args_create_invoice_link(self, offline_bot, monkeypatch): + @pytest.mark.parametrize("subscription_period", [42, dtm.timedelta(seconds=42)]) + async def test_send_all_args_create_invoice_link( + self, offline_bot, monkeypatch, subscription_period + ): async def make_assertion(*args, **_): kwargs = args[1] - return all(kwargs[i] == i for i in kwargs) + sp = kwargs.pop("subscription_period") == 42 + return all(kwargs[i] == i for i in kwargs) and sp monkeypatch.setattr(offline_bot, "_post", make_assertion) assert await offline_bot.create_invoice_link( @@ -149,6 +154,8 @@ class TestInvoiceWithoutRequest(InvoiceTestBase): send_phone_number_to_provider="send_phone_number_to_provider", send_email_to_provider="send_email_to_provider", is_flexible="is_flexible", + business_connection_id="business_connection_id", + subscription_period=subscription_period, ) async def test_send_object_as_provider_data(