otf-api 0.9.0__py3-none-any.whl → 0.9.1__py3-none-any.whl

otf_api/__init__.py

@@ -4,7 +4,7 @@ from otf_api.api import Otf
 from otf_api import models
 from otf_api.auth import OtfUser
 
-__version__ = "0.9.0"
+__version__ = "0.9.1"
 
 
 __all__ = ["Otf", "OtfUser", "models"]

otf_api/api.py

@@ -1007,14 +1007,58 @@ class Otf:
         res = self._telemetry_request("GET", path, params=params)
         return models.Telemetry(**res)
 
-    def get_sms_notification_settings(self):
+    def get_sms_notification_settings(self) -> models.SmsNotificationSettings:
+        """Get the member's SMS notification settings.
+
+        Returns:
+            SmsNotificationSettings: The member's SMS notification settings.
+        """
         res = self._default_request("GET", url="/sms/v1/preferences", params={"phoneNumber": self.member.phone_number})
 
-        return res["data"]
+        return models.SmsNotificationSettings(**res["data"])
+
+    def update_sms_notification_settings(
+        self, promotional_enabled: bool | None = None, transactional_enabled: bool | None = None
+    ) -> models.SmsNotificationSettings:
+        """Update the member's SMS notification settings. Arguments not provided will be left unchanged.
+
+        Args:
+            promotional_enabled (bool | None): Whether to enable promotional SMS notifications.
+            transactional_enabled (bool | None): Whether to enable transactional SMS notifications.
+
+        Returns:
+            SmsNotificationSettings: The updated SMS notification settings.
 
-    def update_sms_notification_settings(self, promotional_enabled: bool, transactional_enabled: bool):
+        Warning:
+            ---
+            This endpoint seems to accept almost anything, converting values to truthy/falsey and
+            updating the settings accordingly. The one error I've gotten is with -1
+
+            ```
+            ERROR - Response:
+            {
+            "code": "ER_WARN_DATA_OUT_OF_RANGE",
+            "message": "An unexpected server error occurred, please try again.",
+            "details": [
+                    {
+                "message": "ER_WARN_DATA_OUT_OF_RANGE: Out of range value for column 'IsPromotionalSMSOptIn' at row 1",
+                "additionalInfo": ""
+                    }
+                ]
+            }
+            ```
+        """
         url = "/sms/v1/preferences"
 
+        current_settings = self.get_sms_notification_settings()
+
+        promotional_enabled = (
+            promotional_enabled if promotional_enabled is not None else current_settings.is_promotional_sms_opt_in
+        )
+        transactional_enabled = (
+            transactional_enabled if transactional_enabled is not None else current_settings.is_transactional_sms_opt_in
+        )
+
         body = {
             "promosms": promotional_enabled,
             "source": "OTF",
@@ -1022,11 +1066,45 @@ class Otf:
             "phoneNumber": self.member.phone_number,
         }
 
-        res = self._default_request("POST", url, json=body)
+        self._default_request("POST", url, json=body)
 
-        return res["data"]
+        # the response returns nothing useful, so we just query the settings again
+        new_settings = self.get_sms_notification_settings()
+        return new_settings
+
+    def get_email_notification_settings(self) -> models.EmailNotificationSettings:
+        """Get the member's email notification settings.
+
+        Returns:
+            EmailNotificationSettings: The member's email notification settings.
+        """
+        res = self._default_request("GET", url="/otfmailing/v2/preferences", params={"email": self.member.email})
+
+        return models.EmailNotificationSettings(**res["data"])
+
+    def update_email_notification_settings(
+        self, promotional_enabled: bool | None = None, transactional_enabled: bool | None = None
+    ) -> models.EmailNotificationSettings:
+        """Update the member's email notification settings. Arguments not provided will be left unchanged.
+
+        Args:
+            promotional_enabled (bool | None): Whether to enable promotional email notifications.
+            transactional_enabled (bool | None): Whether to enable transactional email notifications.
+
+        Returns:
+            EmailNotificationSettings: The updated email notification settings.
+        """
+        current_settings = self.get_email_notification_settings()
+
+        promotional_enabled = (
+            promotional_enabled if promotional_enabled is not None else current_settings.is_promotional_email_opt_in
+        )
+        transactional_enabled = (
+            transactional_enabled
+            if transactional_enabled is not None
+            else current_settings.is_transactional_email_opt_in
+        )
 
-    def update_email_notification_settings(self, promotional_enabled: bool, transactional_enabled: bool):
         body = {
             "promotionalEmail": promotional_enabled,
             "source": "OTF",
@@ -1034,9 +1112,11 @@ class Otf:
             "email": self.member.email,
         }
 
-        res = self._default_request("POST", "/otfmailing/v2/preferences", json=body)
+        self._default_request("POST", "/otfmailing/v2/preferences", json=body)
 
-        return res["data"]
+        # the response returns nothing useful, so we just query the settings again
+        new_settings = self.get_email_notification_settings()
+        return new_settings
 
     def update_member_name(self, first_name: str | None = None, last_name: str | None = None) -> models.MemberDetail:
         """Update the member's name. Will return the original member details if no names are provided.

otf_api/models/__init__.py

@@ -8,6 +8,7 @@ from .lifetime_stats import StatsResponse, TimeStats
 from .member_detail import MemberDetail
 from .member_membership import MemberMembership
 from .member_purchases import MemberPurchase
+from .notifications import EmailNotificationSettings, SmsNotificationSettings
 from .out_of_studio_workout_history import OutOfStudioWorkoutHistory
 from .performance_summary_detail import PerformanceSummaryDetail
 from .performance_summary_list import PerformanceSummaryEntry
@@ -24,6 +25,7 @@ __all__ = [
     "ChallengeTracker",
     "ClassType",
     "DoW",
+    "EmailNotificationSettings",
     "EquipmentType",
     "FitnessBenchmark",
     "LatestAgreement",
@@ -34,6 +36,7 @@ __all__ = [
     "OutOfStudioWorkoutHistory",
     "PerformanceSummaryDetail",
     "PerformanceSummaryEntry",
+    "SmsNotificationSettings",
     "StatsResponse",
     "StatsTime",
     "StudioDetail",

otf_api/models/notifications.py

@@ -0,0 +1,17 @@
+from pydantic import Field
+
+from otf_api.models.base import OtfItemBase
+
+
+class SmsNotificationSettings(OtfItemBase):
+    is_promotional_sms_opt_in: bool | None = Field(None, alias="isPromotionalSmsOptIn")
+    is_transactional_sms_opt_in: bool | None = Field(None, alias="isTransactionalSmsOptIn")
+    is_promotional_phone_opt_in: bool | None = Field(None, alias="isPromotionalPhoneOptIn")
+    is_transactional_phone_opt_in: bool | None = Field(None, alias="isTransactionalPhoneOptIn")
+
+
+class EmailNotificationSettings(OtfItemBase):
+    is_system_email_opt_in: bool | None = Field(None, alias="isSystemEmailOptIn")
+    is_promotional_email_opt_in: bool | None = Field(None, alias="isPromotionalEmailOptIn")
+    is_transactional_email_opt_in: bool | None = Field(None, alias="isTransactionalEmailOptIn")
+    email: str | None = None

{otf_api-0.9.0.dist-info → otf_api-0.9.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: otf-api
-Version: 0.9.0
+Version: 0.9.1
 Summary: Python OrangeTheory Fitness API Client
 License: MIT
 Author: Jessica Smith
@@ -44,11 +44,20 @@ pip install otf-api
 
 ## Overview
 
-To use the API, you need to create an instance of the `Otf` class, providing your email address and password. This will authenticate you with the API and allow you to make requests. When the `Otf` object is created it automatically grabs your member details and home studio, to simplify the process of making requests.
+To use the API, you need to create an instance of the `Otf` class. This will authenticate you with the API and allow you to make requests. When the `Otf` object is created it automatically grabs your member details and home studio, to simplify the process of making requests.
 
+You can either pass an `OtfUser` object to the `OtfClass` or you can pass nothing and allow it to prompt you for your username and password.
 
-See the [examples](./examples) for more information on how to use the API.
+You can also export environment variables `OTF_EMAIL` and `OTF_PASSWORD` to get these from the environment.
 
-Disclaimer:
-This project is in no way affiliated with OrangeTheory Fitness.
+```python
+from otf_api import Otf, OtfUser
+
+otf = Otf()
+
+# OR
+
+otf = Otf(user=OtfUser(<email_address>,<password>))
+
+```
 

{otf_api-0.9.0.dist-info → otf_api-0.9.1.dist-info}/RECORD

@@ -1,5 +1,5 @@
-otf_api/__init__.py,sha256=pwX9albBmqssSx-TBlK4GFkWw-HSHWE__Miv-8nBelQ,204
-otf_api/api.py,sha256=IOC3QAL8jK-FgW1UJg2IOOtq0aE6gbr-7k2fSYJFdys,43573
+otf_api/__init__.py,sha256=dGgyclSo165V_hZAl7Z5E06WQrs5NjO6fXtPcbo3RIg,204
+otf_api/api.py,sha256=Ah6bheezsV-RLxPLGKZqqW77gotWkznLYmEeRhEwJaY,47006
 otf_api/auth/__init__.py,sha256=Pu6ugbEXhgjJEpYKr7K2CqEac53Wq9FRF3F16GLQ_ww,133
 otf_api/auth/auth.py,sha256=m9qzUn0hdAo6AZHm2Mn054nLqUWPxEyP3y3DOBVkvYA,9010
 otf_api/auth/user.py,sha256=HgggfneeVMnKFWSUMnlikfZyC__HE8vVaKSpBS4_sIg,2256
@@ -7,7 +7,7 @@ otf_api/auth/utils.py,sha256=jUH_A1-DU3KfY-XrymCuQoud79o9qfu5P9Ws9QA2aWs,3211
 otf_api/exceptions.py,sha256=mt0k0-2oNcpNhboYzkywpt535W6bHjx6gro7P3PpYzo,1463
 otf_api/filters.py,sha256=fk2bFGi3srjS96qZlaDx-ARZRaj93NUTUdMJ01TX420,3702
 otf_api/logging.py,sha256=PRZpCaJ1F1Xya3L9Efkt3mKS5_QNr3sXjEUERSxYjvE,563
-otf_api/models/__init__.py,sha256=na4JscryHHwNdIkefA6Eqoiny3PUEBgUa4tnv1-g5M0,1446
+otf_api/models/__init__.py,sha256=czt_OYsU4igeudRAi8kqOQro6fjNrbE9aLr--FA76Sg,1588
 otf_api/models/base.py,sha256=KJlIxl_sRj6f-g5vKYPw4yV6fGDk-fwZ93EO0JGPYMw,202
 otf_api/models/body_composition_list.py,sha256=jGdR-9ScvIOtULJNB99aYh2INk2ihoHAnTWtbQCIea4,12202
 otf_api/models/bookings.py,sha256=8zgLnQ40ci0c7AimGeoAI-Raw8d2byvKoXkJXyW1xUE,4260
@@ -20,6 +20,7 @@ otf_api/models/member_detail.py,sha256=CDDZg3Ow07U57yRqbm3i-BVha0cvCNOZ8QhN0pliU
 otf_api/models/member_membership.py,sha256=jZwHzwtVyMUr8dWGlFbMYj9qveCbiOblWW5szXDUFFo,1338
 otf_api/models/member_purchases.py,sha256=Ne7ByEbGTqTJhuEyCgywWe8I3nc-D46qw09up7ys38s,1627
 otf_api/models/mixins.py,sha256=VR5EeweySHhzaiqqnCr853Cpe1uK97cxY0IFEdf5T8w,2262
+otf_api/models/notifications.py,sha256=AkmIfiIiU6wox_7puyenbhCX10SFvBD5eBAovcurRgY,833
 otf_api/models/out_of_studio_workout_history.py,sha256=El5i0K2Td_sMReyfUKP-Iv1L1WgRx0ijjjnHzYvlCeY,1703
 otf_api/models/performance_summary_detail.py,sha256=HmtAJIKkekYy2rJOQBxfQGsKJxuFZm7gP4Dauae-PqM,2711
 otf_api/models/performance_summary_list.py,sha256=jv28jZJEOXOZtghhHhNR-4BPVBY3TpyiwHNKmnoTRcA,1692
@@ -28,7 +29,7 @@ otf_api/models/studio_services.py,sha256=aGLQMQmjGVpI6YxzAl-mcp3Y9cHPXuH9dIqrl6E
 otf_api/models/telemetry.py,sha256=_g-wtJDbaXENk1DqH0bbpJUsGepWDYraRIsIvpvDBU8,2531
 otf_api/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 otf_api/utils.py,sha256=Af_Xg2QLoFqRzHOj4LtCIIqpRsdih-7HW1rJ8tUo8tE,3937
-otf_api-0.9.0.dist-info/LICENSE,sha256=UaPT9ynYigC3nX8n22_rC37n-qmTRKLFaHrtUwF9ktE,1071
-otf_api-0.9.0.dist-info/METADATA,sha256=0xUtxE1NRXvulEc_i34wWC5TbFnRJzO-ukPuqMVHNnY,2121
-otf_api-0.9.0.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
-otf_api-0.9.0.dist-info/RECORD,,
+otf_api-0.9.1.dist-info/LICENSE,sha256=UaPT9ynYigC3nX8n22_rC37n-qmTRKLFaHrtUwF9ktE,1071
+otf_api-0.9.1.dist-info/METADATA,sha256=SPUE5dzWt65jmeoSiWbCY-Tb84vO-x6kOg91kKlvlmg,2296
+otf_api-0.9.1.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+otf_api-0.9.1.dist-info/RECORD,,