zabel-elements 1.47.2__tar.gz → 1.48.0__tar.gz

{zabel_elements-1.47.2/zabel_elements.egg-info → zabel_elements-1.48.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zabel-elements
-Version: 1.47.2
+Version: 1.48.0
 Summary: TThe Zabel default clients and images
 Author-email: Martin Lafaix <martin.lafaix@external.engie.com>
 License-Expression: EPL-2.0

{zabel_elements-1.47.2 → zabel_elements-1.48.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "zabel-elements"
-version = "1.47.2"
+version = "1.48.0"
 description = "TThe Zabel default clients and images"
 readme = "README.md"
 license = "EPL-2.0"

{zabel_elements-1.47.2 → zabel_elements-1.48.0}/zabel/elements/clients/base/confluence.py

@@ -957,6 +957,8 @@ class Confluence:
     # list_space_permissionsets*
     # create_space
     # delete_space
+    # archive_space
+    # restore_space
     # add_space_label*
     # remove_space_permission*
     # add_space_permissions*
@@ -1262,6 +1264,40 @@ class Confluence:
         response = self._delete(f'/space/{space_key}')
         return response
 
+    @api_call
+    def archive_space(self, space_key: str) -> bool:
+        """Archive a space.
+
+        # Required parameters
+
+        - space_key: a non-empty string
+
+        # Returned value
+
+        A boolean, True if successful
+        """
+        ensure_nonemptystring('space_key')
+
+        response = self._put(f'/space/{space_key}/archive')
+        return response.status_code == 204
+
+    @api_call
+    def restore_space(self, space_key: str) -> bool:
+        """Restore a space.
+
+        # Required parameters
+
+        - space_key: a non-empty string
+
+        # Returned value
+
+        A boolean, True if successful
+        """
+        ensure_nonemptystring('space_key')
+
+        response = self._put(f'/space/{space_key}/restore')
+        return response.status_code == 204
+
     @api_call
     def add_space_label(self, space_key: str, label: str) -> bool:
         """Add label to space.

{zabel_elements-1.47.2 → zabel_elements-1.48.0}/zabel/elements/clients/base/github.py

@@ -4582,12 +4582,10 @@ class GitHub:
 
             remaining = response.headers.get('X-RateLimit-Remaining')
             retry_after = response.headers.get('Retry-After')
-            reset = response.headers.get('X-RateLimit-Reset')
             if (
                 response.status_code == 403
                 and remaining != '0'
                 and retry_after is None
-                and reset is None
             ):
                 return response
 

{zabel_elements-1.47.2 → zabel_elements-1.48.0}/zabel/elements/clients/base/githubcloud.py

@@ -2190,7 +2190,10 @@ class GitHubCloud:
         - `report_id`: a string, the ID of the created report export.
         """
         ensure_nonemptystring('enterprise_name')
-        ensure_in('report_type', ('detailed', 'summarized', 'premium_request'))
+        ensure_in(
+            'report_type',
+            ('detailed', 'summarized', 'premium_request', 'ai_credit'),
+        )
         ensure_nonemptystring('start_date')
         ensure_nonemptystring('end_date')
         ensure_instance('send_email', bool)
@@ -2447,6 +2450,316 @@ class GitHubCloud:
         response = self._post('graphql', json=json_data)
         return response.json()
 
+    ####################################################################
+    # GitHubCloud Budget
+    #
+    # list_budgets
+    # create_budget
+    # get_budget
+    # update_budget
+    # delete_budget
+
+    @api_call
+    @require_pat_auth
+    def list_budgets(self, enterprise_name: str) -> List[Dict[str, Any]]:
+        """List all budgets for an enterprise.
+
+        !!! important
+            This endpoint does not work with GitHub App user
+             access tokens, GitHub App installation access
+             tokens, or fine-grained personal access tokens.
+
+        # Required parameters
+
+        - enterprise_name: a non-empty string
+
+        # Returned value
+
+        A list of _budgets_.  Each budget is a dictionary with the
+        following entries:
+
+        - id: a string
+        - budget_type: a string
+        - budget_product_sku: a string
+        - budget_scope: a string
+        - budget_amount: an integer
+        - prevent_further_usage: a boolean
+        - budget_entity_name: a string
+        - budget_alerting: a dictionary with the following entries:
+
+            * will_alert: a boolean
+            * alert_recipients: a list of strings
+
+        - consumed_amount: a float
+        - user: a string
+        """
+        ensure_nonemptystring('enterprise_name')
+
+        params = {'page': 1}
+        session = self._get_session()
+        api_url = join_url(
+            self.url, f'enterprises/{enterprise_name}/settings/billing/budgets'
+        )
+        collected: List[Dict[str, Any]] = []
+
+        while True:
+            response = session.get(api_url, params=params)
+            if response.status_code // 100 != 2:
+                raise ApiError(response.text)
+            try:
+                response_data = response.json()
+            except Exception as exception:
+                raise ApiError from exception
+            if isinstance(response_data, dict):
+                collected += response_data.get('budgets', [])
+                has_next = response_data.get('has_next_page', False)
+            elif isinstance(response_data, list):
+                collected += response_data
+                has_next = False
+            else:
+                raise ApiError(
+                    f'Unexpected response type: {type(response_data)!r}'
+                )
+            if not has_next:
+                break
+            params['page'] += 1
+
+        return collected
+
+    @api_call
+    @require_pat_auth
+    def create_budget(
+        self,
+        enterprise_name: str,
+        budget_amount: int,
+        prevent_further_usage: bool,
+        budget_alerting: Dict[str, Any],
+        budget_scope: str,
+        budget_type: str,
+        budget_entity_name: Optional[str] = None,
+        budget_product_sku: Optional[str] = None,
+        user: Optional[str] = None,
+    ) -> Dict[str, Any]:
+        """Create a budget for an enterprise.
+
+        !!! important
+            This endpoint does not work with GitHub App user
+             access tokens, GitHub App installation access
+             tokens, or fine-grained personal access tokens.
+
+        # Required parameters
+
+        - enterprise_name: a non-empty string
+        - budget_amount: an integer, the budget amount
+        - prevent_further_usage: a boolean, whether to prevent further
+          usage when the budget is exceeded
+        - budget_alerting: a dictionary with alerting configuration
+        - budget_scope: a non-empty string, one of `'enterprise'`,
+          `'organization'`, `'repository'`, `'cost_center'`, or `'user'`
+        - budget_type: a non-empty string, the type of budget
+
+        # Optional parameters
+
+        - budget_entity_name: a string or None (None by default), the
+          name of the entity the budget applies to
+        - budget_product_sku: a string or None (None by default), the
+          product SKU the budget applies to
+        - user: a string or None (None by default), the user the budget
+          applies to
+
+        # Returned value
+
+        A _budget_. A budget is a dictionary.
+        """
+        ensure_nonemptystring('enterprise_name')
+        ensure_instance('budget_amount', int)
+        ensure_instance('prevent_further_usage', bool)
+        ensure_instance('budget_alerting', dict)
+        ensure_in(
+            'budget_scope',
+            (
+                'enterprise',
+                'organization',
+                'repository',
+                'cost_center',
+                'user',
+            ),
+        )
+        ensure_nonemptystring('budget_type')
+        ensure_noneorinstance('budget_entity_name', str)
+        ensure_noneorinstance('budget_product_sku', str)
+        ensure_noneorinstance('user', str)
+
+        data: Dict[str, Any] = {
+            'budget_amount': budget_amount,
+            'prevent_further_usage': prevent_further_usage,
+            'budget_alerting': budget_alerting,
+            'budget_scope': budget_scope,
+            'budget_type': budget_type,
+        }
+        add_if_specified(data, 'budget_entity_name', budget_entity_name)
+        add_if_specified(data, 'budget_product_sku', budget_product_sku)
+        add_if_specified(data, 'user', user)
+        return self._post(
+            f'enterprises/{enterprise_name}/settings/billing/budgets',
+            json=data,
+        )
+
+    @api_call
+    @require_pat_auth
+    def get_budget(
+        self,
+        enterprise_name: str,
+        budget_id: str,
+    ) -> Dict[str, Any]:
+        """Get a budget for an enterprise.
+
+        !!! important
+            This endpoint does not work with GitHub App user
+             access tokens, GitHub App installation access
+             tokens, or fine-grained personal access tokens.
+
+        # Required parameters
+
+        - enterprise_name: a non-empty string
+        - budget_id: a non-empty string
+
+        # Returned value
+
+        A _budget_. A budget is a dictionary with the following entries:
+
+        - id: a string
+        - budget_type: a string
+        - budget_product_sku: a string
+        - budget_scope: a string
+        - budget_amount: an integer
+        - prevent_further_usage: a boolean
+        - budget_entity_name: a string
+        - budget_alerting: a dictionary with the following entries:
+
+            * will_alert: a boolean
+            * alert_recipients: a list of strings
+
+        - consumed_amount: a float
+        - user: a string
+        """
+        ensure_nonemptystring('enterprise_name')
+        ensure_nonemptystring('budget_id')
+
+        return self._get(
+            f'enterprises/{enterprise_name}/settings/billing/budgets/{budget_id}'
+        )
+
+    @api_call
+    @require_pat_auth
+    def update_budget(
+        self,
+        enterprise_name: str,
+        budget_id: str,
+        budget_amount: Optional[int] = None,
+        prevent_further_usage: Optional[bool] = None,
+        budget_alerting: Optional[Dict[str, Any]] = None,
+        budget_scope: Optional[str] = None,
+        budget_type: Optional[str] = None,
+        budget_entity_name: Optional[str] = None,
+        budget_product_sku: Optional[str] = None,
+    ) -> Dict[str, Any]:
+        """Update a budget for an enterprise.
+
+        !!! important
+            This endpoint does not work with GitHub App user
+             access tokens, GitHub App installation access
+             tokens, or fine-grained personal access tokens.
+
+        # Required parameters
+
+        - enterprise_name: a non-empty string
+        - budget_id: a non-empty string
+
+        # Optional parameters
+
+        - budget_amount: an integer or None (None by default)
+        - prevent_further_usage: a boolean or None (None by default)
+        - budget_alerting: a dictionary or None (None by default)
+        - budget_scope: a string or None, one of `'enterprise'`,
+          `'organization'`, `'repository'`, `'cost_center'`, or `'user'`
+          (None by default)
+        - budget_type: a string or None (None by default)
+        - budget_entity_name: a string or None (None by default)
+        - budget_product_sku: a string or None (None by default)
+
+        # Returned value
+
+        A _budget_. A budget is a dictionary.
+        """
+        ensure_nonemptystring('enterprise_name')
+        ensure_nonemptystring('budget_id')
+        ensure_noneorinstance('budget_amount', int)
+        ensure_noneorinstance('prevent_further_usage', bool)
+        ensure_noneorinstance('budget_alerting', dict)
+        if budget_scope is not None:
+            ensure_in(
+                'budget_scope',
+                (
+                    'enterprise',
+                    'organization',
+                    'repository',
+                    'cost_center',
+                    'user',
+                ),
+            )
+        ensure_noneorinstance('budget_type', str)
+        ensure_noneorinstance('budget_entity_name', str)
+        ensure_noneorinstance('budget_product_sku', str)
+
+        data: Dict[str, Any] = {}
+        add_if_specified(data, 'budget_amount', budget_amount)
+        add_if_specified(data, 'prevent_further_usage', prevent_further_usage)
+        add_if_specified(data, 'budget_alerting', budget_alerting)
+        add_if_specified(data, 'budget_scope', budget_scope)
+        add_if_specified(data, 'budget_type', budget_type)
+        add_if_specified(data, 'budget_entity_name', budget_entity_name)
+        add_if_specified(data, 'budget_product_sku', budget_product_sku)
+
+        return self._patch(
+            f'enterprises/{enterprise_name}/settings/billing/budgets/{budget_id}',
+            json=data,
+        )
+
+    @api_call
+    @require_pat_auth
+    def delete_budget(
+        self,
+        enterprise_name: str,
+        budget_id: str,
+    ) -> bool:
+        """Delete a budget for an enterprise.
+
+        !!! important
+            This endpoint does not work with GitHub App user
+             access tokens, GitHub App installation access
+             tokens, or fine-grained personal access tokens.
+
+        # Required parameters
+
+        - enterprise_name: a non-empty string
+        - budget_id: a non-empty string
+
+        # Returned value
+
+        A boolean. True if the budget was deleted.
+        """
+        ensure_nonemptystring('enterprise_name')
+        ensure_nonemptystring('budget_id')
+
+        return (
+            self._delete(
+                f'enterprises/{enterprise_name}/settings/billing/budgets/{budget_id}'
+            ).status_code
+            // 100
+            == 2
+        )
+
     ####################################################################
     # GitHub helpers
     #
@@ -2486,6 +2799,16 @@ class GitHubCloud:
         api_url = join_url(self.url, api)
         return self._request('put', api_url, json=json, headers=headers)
 
+    def _patch(
+        self,
+        api: str,
+        json: Optional[Mapping[str, Any]] = None,
+        headers: Optional[Mapping[str, str]] = None,
+    ) -> requests.Response:
+        """Return GitHub API PATCH call results, as Response."""
+        api_url = join_url(self.url, api)
+        return self._request('patch', api_url, json=json, headers=headers)
+
     def _delete(
         self,
         api: str,
@@ -2522,18 +2845,15 @@ class GitHubCloud:
 
         while self._max_retries < 0 or attempt <= self._max_retries:
             response = session.request(method=method, url=url, **kwargs)
-
             if response.status_code not in (403, 429):
                 return response
 
             remaining = response.headers.get('X-RateLimit-Remaining')
             retry_after = response.headers.get('Retry-After')
-            reset = response.headers.get('X-RateLimit-Reset')
             if (
                 response.status_code == 403
                 and remaining != '0'
                 and retry_after is None
-                and reset is None
             ):
                 return response
 
@@ -2596,7 +2916,6 @@ class GitHubCloud:
                 )
             except Exception as exception:
                 raise ApiError from exception
-
             if 'next' not in response.links:
                 break
             api_url = response.links['next']['url']

{zabel_elements-1.47.2 → zabel_elements-1.48.0/zabel_elements.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zabel-elements
-Version: 1.47.2
+Version: 1.48.0
 Summary: TThe Zabel default clients and images
 Author-email: Martin Lafaix <martin.lafaix@external.engie.com>
 License-Expression: EPL-2.0