Skip to content

Commit

Permalink
Merge branch 'main' of https://github.com/treeben77/rblx-open-cloud i…
Browse files Browse the repository at this point in the history
…nto v2
  • Loading branch information
treeben77 committed Sep 26, 2024
1 parent 694ec7e commit 319c4da
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ rblx-open-cloud is a Python API wrapper for [Roblox Open Cloud](https://create.r
- Allows both syncronous and asyncronous usage.
- Logic for operation polling and internal error retrying.

**Documentation: https://rblx-open-cloud.readthedocs.io**
**Documentation: https://rblx-open-cloud.readthedocs.io/en/latest/**

## Quickstart

Expand Down
10 changes: 9 additions & 1 deletion rblxopencloud/oauth2.py
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,15 @@ def __repr__(self) -> str:

def revoke_refresh_token(self):
"""
Shortcut to revoke the refresh token.
Shortcut for [`OAuth2App.revoke_token()`][rblxopencloud.OAuth2App.revoke_token] to revoke the refresh token.
Raises:
InvalidKey: The client ID or client secret is invalid.
ServiceUnavailable: The Roblox servers ran into an error, or are unavailable right now.
rblx_opencloudException: Roblox gave an unexpected response.
!!! warning
Revoking an access token or refresh token will also invalidate it's pair, so you should only revoke a token once you're completely done with it.
"""
self.app.revoke_token(self.refresh_token)

Expand Down
10 changes: 9 additions & 1 deletion rblxopencloud/webhook.py
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,15 @@ def event(self, func: Callable):

class Notification:
"""
Represents a recieved webhook event.
Represents a recieved base webhook event.
!!! warning
This class isn't designed to be created by users. It is returned by some decorated functions from [`Webhook.event()`][rblxopencloud.Webhook.event].
Attributes:
notification_id: The notifications unique ID. If an ID is repeated, assume it is a duplicate and ignore it.
timestamp: The time the notification was created.
webhook: The webhook that the notifcation came from.
"""

def __init__(self, body, webhook, api_key):
Expand Down

0 comments on commit 319c4da

Please sign in to comment.