feat: Create new RestClientOptions for more graceful RestClient configuration

Author: evansims

auth0/v3/management/auth0.py

@@ -32,31 +32,36 @@ class Auth0(object):
         domain (str): Your Auth0 domain, e.g: 'username.auth0.com'
 
         token (str): Management API v2 Token
+
+        rest_options (RestClientOptions): Pass an instance of
+            RestClientOptions to configure additional RestClient
+            options, such as rate-limit retries.
+            (defaults to None)
     """
 
-    def __init__(self, domain, token):
-        self.blacklists = Blacklists(domain, token)
-        self.client_grants = ClientGrants(domain, token)
-        self.clients = Clients(domain, token)
-        self.connections = Connections(domain, token)
-        self.custom_domains = CustomDomains(domain, token)
-        self.device_credentials = DeviceCredentials(domain, token)
-        self.email_templates = EmailTemplates(domain, token)
-        self.emails = Emails(domain, token)
-        self.grants = Grants(domain, token)
-        self.guardian = Guardian(domain, token)
-        self.hooks = Hooks(domain, token)
-        self.jobs = Jobs(domain, token)
-        self.log_streams = LogStreams(domain, token)
-        self.logs = Logs(domain, token)
-        self.organizations = Organizations(domain, token)
-        self.resource_servers = ResourceServers(domain, token)
-        self.roles = Roles(domain, token)
-        self.rules_configs = RulesConfigs(domain, token)
-        self.rules = Rules(domain, token)
-        self.stats = Stats(domain, token)
-        self.tenants = Tenants(domain, token)
-        self.tickets = Tickets(domain, token)
-        self.user_blocks = UserBlocks(domain, token)
-        self.users_by_email = UsersByEmail(domain, token)
-        self.users = Users(domain, token)
+    def __init__(self, domain, token, rest_options=None):
+        self.blacklists = Blacklists(domain=domain, token=token, rest_options=rest_options)
+        self.client_grants = ClientGrants(domain=domain, token=token, rest_options=rest_options)
+        self.clients = Clients(domain=domain, token=token, rest_options=rest_options)
+        self.connections = Connections(domain=domain, token=token, rest_options=rest_options)
+        self.custom_domains = CustomDomains(domain=domain, token=token, rest_options=rest_options)
+        self.device_credentials = DeviceCredentials(domain=domain, token=token, rest_options=rest_options)
+        self.email_templates = EmailTemplates(domain=domain, token=token, rest_options=rest_options)
+        self.emails = Emails(domain=domain, token=token, rest_options=rest_options)
+        self.grants = Grants(domain=domain, token=token, rest_options=rest_options)
+        self.guardian = Guardian(domain=domain, token=token, rest_options=rest_options)
+        self.hooks = Hooks(domain=domain, token=token, rest_options=rest_options)
+        self.jobs = Jobs(domain=domain, token=token, rest_options=rest_options)
+        self.log_streams = LogStreams(domain=domain, token=token, rest_options=rest_options)
+        self.logs = Logs(domain=domain, token=token, rest_options=rest_options)
+        self.organizations = Organizations(domain=domain, token=token, rest_options=rest_options)
+        self.resource_servers = ResourceServers(domain=domain, token=token, rest_options=rest_options)
+        self.roles = Roles(domain=domain, token=token, rest_options=rest_options)
+        self.rules_configs = RulesConfigs(domain=domain, token=token, rest_options=rest_options)
+        self.rules = Rules(domain=domain, token=token, rest_options=rest_options)
+        self.stats = Stats(domain=domain, token=token, rest_options=rest_options)
+        self.tenants = Tenants(domain=domain, token=token, rest_options=rest_options)
+        self.tickets = Tickets(domain=domain, token=token, rest_options=rest_options)
+        self.user_blocks = UserBlocks(domain=domain, token=token, rest_options=rest_options)
+        self.users_by_email = UsersByEmail(domain=domain, token=token, rest_options=rest_options)
+        self.users = Users(domain=domain, token=token, rest_options=rest_options)

auth0/v3/management/blacklists.py

@@ -16,11 +16,16 @@ class Blacklists(object):
             connect and read timeout. Pass a tuple to specify
             both values separately or a float to set both to it.
             (defaults to 5.0 for both)
+
+        rest_options (RestClientOptions): Pass an instance of
+            RestClientOptions to configure additional RestClient
+            options, such as rate-limit retries.
+            (defaults to None)
     """
 
-    def __init__(self, domain, token, telemetry=True, timeout=5.0, protocol="https"):
+    def __init__(self, domain, token, telemetry=True, timeout=5.0, protocol="https", rest_options=None):
         self.url = '{}://{}/api/v2/blacklists/tokens'.format(protocol, domain)
-        self.client = RestClient(jwt=token, telemetry=telemetry, timeout=timeout)
+        self.client = RestClient(jwt=token, telemetry=telemetry, timeout=timeout, options=rest_options)
 
     def get(self, aud=None):
         """Retrieves the jti and aud of all tokens in the blacklist.

auth0/v3/management/client_grants.py

@@ -16,12 +16,17 @@ class ClientGrants(object):
             connect and read timeout. Pass a tuple to specify
             both values separately or a float to set both to it.
             (defaults to 5.0 for both)
+
+        rest_options (RestClientOptions): Pass an instance of
+            RestClientOptions to configure additional RestClient
+            options, such as rate-limit retries.
+            (defaults to None)
     """
 
-    def __init__(self, domain, token, telemetry=True, timeout=5.0, protocol="https"):
+    def __init__(self, domain, token, telemetry=True, timeout=5.0, protocol="https", rest_options=None):
         self.domain = domain
         self.protocol = protocol
-        self.client = RestClient(jwt=token, telemetry=telemetry, timeout=timeout)
+        self.client = RestClient(jwt=token, telemetry=telemetry, timeout=timeout, options=rest_options)
 
     def _url(self, id=None):
         url = '{}://{}/api/v2/client-grants'.format(self.protocol, self.domain)

auth0/v3/management/clients.py

@@ -16,12 +16,17 @@ class Clients(object):
             connect and read timeout. Pass a tuple to specify
             both values separately or a float to set both to it.
             (defaults to 5.0 for both)
+
+        rest_options (RestClientOptions): Pass an instance of
+            RestClientOptions to configure additional RestClient
+            options, such as rate-limit retries.
+            (defaults to None)
     """
 
-    def __init__(self, domain, token, telemetry=True, timeout=5.0, protocol="https"):
+    def __init__(self, domain, token, telemetry=True, timeout=5.0, protocol="https", rest_options=None):
         self.domain = domain
         self.protocol = protocol
-        self.client = RestClient(jwt=token, telemetry=telemetry, timeout=timeout)
+        self.client = RestClient(jwt=token, telemetry=telemetry, timeout=timeout, options=rest_options)
 
     def _url(self, id=None):
         url = '{}://{}/api/v2/clients'.format(self.protocol, self.domain)

auth0/v3/management/connections.py

@@ -16,12 +16,17 @@ class Connections(object):
             connect and read timeout. Pass a tuple to specify
             both values separately or a float to set both to it.
             (defaults to 5.0 for both)
+
+        rest_options (RestClientOptions): Pass an instance of
+            RestClientOptions to configure additional RestClient
+            options, such as rate-limit retries.
+            (defaults to None)
     """
 
-    def __init__(self, domain, token, telemetry=True, timeout=5.0, protocol="https"):
+    def __init__(self, domain, token, telemetry=True, timeout=5.0, protocol="https", rest_options=None):
         self.domain = domain
         self.protocol = protocol
-        self.client = RestClient(jwt=token, telemetry=telemetry, timeout=timeout)
+        self.client = RestClient(jwt=token, telemetry=telemetry, timeout=timeout, options=rest_options)
 
     def _url(self, id=None):
         url = '{}://{}/api/v2/connections'.format(self.protocol, self.domain)

auth0/v3/management/custom_domains.py

@@ -16,12 +16,17 @@ class CustomDomains(object):
             connect and read timeout. Pass a tuple to specify
             both values separately or a float to set both to it.
             (defaults to 5.0 for both)
+
+        rest_options (RestClientOptions): Pass an instance of
+            RestClientOptions to configure additional RestClient
+            options, such as rate-limit retries.
+            (defaults to None)
     """
 
-    def __init__(self, domain, token, telemetry=True, timeout=5.0, protocol="https"):
+    def __init__(self, domain, token, telemetry=True, timeout=5.0, protocol="https", rest_options=None):
         self.domain = domain
         self.protocol = protocol
-        self.client = RestClient(jwt=token, telemetry=telemetry, timeout=timeout)
+        self.client = RestClient(jwt=token, telemetry=telemetry, timeout=timeout, options=rest_options)
 
     def _url(self, id=None):
         url = '{}://{}/api/v2/custom-domains'.format(self.protocol, self.domain)

auth0/v3/management/device_credentials.py

@@ -16,12 +16,17 @@ class DeviceCredentials(object):
             connect and read timeout. Pass a tuple to specify
             both values separately or a float to set both to it.
             (defaults to 5.0 for both)
+
+        rest_options (RestClientOptions): Pass an instance of
+            RestClientOptions to configure additional RestClient
+            options, such as rate-limit retries.
+            (defaults to None)
     """
 
-    def __init__(self, domain, token, telemetry=True, timeout=5.0, protocol="https"):
+    def __init__(self, domain, token, telemetry=True, timeout=5.0, protocol="https", rest_options=None):
         self.domain = domain
         self.protocol = protocol
-        self.client = RestClient(jwt=token, telemetry=telemetry, timeout=timeout)
+        self.client = RestClient(jwt=token, telemetry=telemetry, timeout=timeout, options=rest_options)
 
     def _url(self, id=None):
         url = '{}://{}/api/v2/device-credentials'.format(self.protocol, self.domain)

auth0/v3/management/email_templates.py

@@ -16,12 +16,17 @@ class EmailTemplates(object):
             connect and read timeout. Pass a tuple to specify
             both values separately or a float to set both to it.
             (defaults to 5.0 for both)
+
+        rest_options (RestClientOptions): Pass an instance of
+            RestClientOptions to configure additional RestClient
+            options, such as rate-limit retries.
+            (defaults to None)
     """
 
-    def __init__(self, domain, token, telemetry=True, timeout=5.0, protocol="https"):
+    def __init__(self, domain, token, telemetry=True, timeout=5.0, protocol="https", rest_options=None):
         self.domain = domain
         self.protocol = protocol
-        self.client = RestClient(jwt=token, telemetry=telemetry, timeout=timeout)
+        self.client = RestClient(jwt=token, telemetry=telemetry, timeout=timeout, options=rest_options)
 
     def _url(self, id=None):
         url = '{}://{}/api/v2/email-templates'.format(self.protocol, self.domain)

auth0/v3/management/emails.py

@@ -16,12 +16,17 @@ class Emails(object):
             connect and read timeout. Pass a tuple to specify
             both values separately or a float to set both to it.
             (defaults to 5.0 for both)
+
+        rest_options (RestClientOptions): Pass an instance of
+            RestClientOptions to configure additional RestClient
+            options, such as rate-limit retries.
+            (defaults to None)
     """
 
-    def __init__(self, domain, token, telemetry=True, timeout=5.0, protocol="https"):
+    def __init__(self, domain, token, telemetry=True, timeout=5.0, protocol="https", rest_options=None):
         self.domain = domain
         self.protocol = protocol
-        self.client = RestClient(jwt=token, telemetry=telemetry, timeout=timeout)
+        self.client = RestClient(jwt=token, telemetry=telemetry, timeout=timeout, options=rest_options)
 
     def _url(self, id=None):
         url = '{}://{}/api/v2/emails/provider'.format(self.protocol, self.domain)

auth0/v3/management/grants.py

@@ -16,12 +16,17 @@ class Grants(object):
             connect and read timeout. Pass a tuple to specify
             both values separately or a float to set both to it.
             (defaults to 5.0 for both)
+
+        rest_options (RestClientOptions): Pass an instance of
+            RestClientOptions to configure additional RestClient
+            options, such as rate-limit retries.
+            (defaults to None)
     """
 
-    def __init__(self, domain, token, telemetry=True, timeout=5.0, protocol="https"):
+    def __init__(self, domain, token, telemetry=True, timeout=5.0, protocol="https", rest_options=None):
         self.domain = domain
         self.protocol = protocol
-        self.client = RestClient(jwt=token, telemetry=telemetry, timeout=timeout)
+        self.client = RestClient(jwt=token, telemetry=telemetry, timeout=timeout, options=rest_options)
 
     def _url(self, id=None):
         url = '{}://{}/api/v2/grants'.format(self.protocol, self.domain)
@@ -45,7 +50,7 @@ def all(self, page=None, per_page=None, include_totals=False, extra_params=None)
            extra_params (dictionary, optional): The extra parameters to add to
                the request. The page, per_page, and include_totals values
                specified as parameters take precedence over the ones defined here.
-            
+
         See: https://auth0.com/docs/api/management/v2#!/Grants/get_grants
         """
         params = extra_params or {}