Merge pull request #13 from crowdsecurity/$main-6c91baa

Update python SDK version: 1.69.0

Author: nitescuc

crowdsec_service_api/__init__.py

@@ -77,12 +77,12 @@ class Server(Enum):
     'MetricUnits',
     'OriginMetrics',
     'OutputFormat',
-    'PageAllowlistGetItemsResponse',
-    'PageAllowlistGetResponse',
-    'PageAllowlistSubscriberEntity',
-    'PageBlocklistSubscriberEntity',
-    'PageIntegrationGetResponse',
-    'PagePublicBlocklistResponse',
+    'PageTAnyCustomizedAllowlistGetItemsResponse',
+    'PageTAnyCustomizedAllowlistGetResponse',
+    'PageTAnyCustomizedAllowlistSubscriberEntity',
+    'PageTAnyCustomizedBlocklistSubscriberEntity',
+    'PageTAnyCustomizedIntegrationGetResponse',
+    'PageTAnyCustomizedPublicBlocklistResponse',
     'Permission',
     'PricingTiers',
     'PublicBlocklistResponse',

crowdsec_service_api/__pycache__/base_model.cpython-311.pyc

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  <stdin>
-#   timestamp: 2025-04-16T07:12:57+00:00
+#   timestamp: 2025-05-02T13:09:22+00:00
 
 from __future__ import annotations
 
@@ -180,7 +180,12 @@ class BlocklistAddIPsRequest(BaseModelSdk):
     )
     ips: Annotated[List[str], Field(description='List of IPs or networks', title='Ips')]
     expiration: Annotated[
-        Optional[datetime], Field(description='Expiration date', title='Expiration')
+        Optional[datetime],
+        Field(
+            description='Expiration date',
+            examples=['2030-01-01T00:00:00.000Z'],
+            title='Expiration',
+        ),
     ] = None
 
 
@@ -724,7 +729,7 @@ class BlocklistsUploadBlocklistContentQueryParameters(BaseModelSdk):
         Optional[datetime],
         Field(
             description='Blocklist expiration',
-            examples='2025-04-16T07:12:36.323875+00:00',
+            examples='2025-05-02T13:08:57.499429+00:00',
             title='Expiration',
         ),
     ] = None
@@ -746,6 +751,12 @@ class BlocklistsAddIpsToBlocklistPathParameters(BaseModelSdk):
     ]
 
 
+class BlocklistsOverwriteIpsPathParameters(BaseModelSdk):
+    blocklist_id: Annotated[
+        str, Field(examples=['5f9d88b9e5c4f5b9a3d3e8b1'], title='Blocklist Id')
+    ]
+
+
 class BlocklistsDeleteIpsFromBlocklistPathParameters(BaseModelSdk):
     blocklist_id: Annotated[
         str, Field(examples=['5f9d88b9e5c4f5b9a3d3e8b1'], title='Blocklist Id')
@@ -1463,7 +1474,7 @@ class OriginMetrics(BaseModelSdk):
     ]
 
 
-class PageAllowlistSubscriberEntity(BaseModelSdk):
+class PageTAnyCustomizedAllowlistSubscriberEntity(BaseModelSdk):
     items: Annotated[List[AllowlistSubscriberEntity], Field(title='Items')]
     total: Annotated[Optional[Total], Field(title='Total')] = None
     page: Annotated[Optional[Page], Field(title='Page')] = None
@@ -1472,7 +1483,7 @@ class PageAllowlistSubscriberEntity(BaseModelSdk):
     links: Links
 
 
-class PageBlocklistSubscriberEntity(BaseModelSdk):
+class PageTAnyCustomizedBlocklistSubscriberEntity(BaseModelSdk):
     items: Annotated[List[BlocklistSubscriberEntity], Field(title='Items')]
     total: Annotated[Optional[Total], Field(title='Total')] = None
     page: Annotated[Optional[Page], Field(title='Page')] = None
@@ -1481,7 +1492,7 @@ class PageBlocklistSubscriberEntity(BaseModelSdk):
     links: Links
 
 
-class PageIntegrationGetResponse(BaseModelSdk):
+class PageTAnyCustomizedIntegrationGetResponse(BaseModelSdk):
     items: Annotated[List[IntegrationGetResponse], Field(title='Items')]
     total: Annotated[Optional[Total], Field(title='Total')] = None
     page: Annotated[Optional[Page], Field(title='Page')] = None
@@ -2364,7 +2375,7 @@ class ComputedSavedMetrics(BaseModelSdk):
     ] = []
 
 
-class PageAllowlistGetItemsResponse(BaseModelSdk):
+class PageTAnyCustomizedAllowlistGetItemsResponse(BaseModelSdk):
     items: Annotated[List[AllowlistGetItemsResponse], Field(title='Items')]
     total: Annotated[Optional[Total], Field(title='Total')] = None
     page: Annotated[Optional[Page], Field(title='Page')] = None
@@ -2373,7 +2384,7 @@ class PageAllowlistGetItemsResponse(BaseModelSdk):
     links: Links
 
 
-class PageAllowlistGetResponse(BaseModelSdk):
+class PageTAnyCustomizedAllowlistGetResponse(BaseModelSdk):
     items: Annotated[List[AllowlistGetResponse], Field(title='Items')]
     total: Annotated[Optional[Total], Field(title='Total')] = None
     page: Annotated[Optional[Page], Field(title='Page')] = None
@@ -2382,7 +2393,7 @@ class PageAllowlistGetResponse(BaseModelSdk):
     links: Links
 
 
-class PagePublicBlocklistResponse(BaseModelSdk):
+class PageTAnyCustomizedPublicBlocklistResponse(BaseModelSdk):
     items: Annotated[List[PublicBlocklistResponse], Field(title='Items')]
     total: Annotated[Optional[Total], Field(title='Total')] = None
     page: Annotated[Optional[Page], Field(title='Page')] = None

crowdsec_service_api/__pycache__/http_client.cpython-311.pyc

@@ -175,6 +175,32 @@ def add_ips_to_blocklist(
 
         return None
 
+    def overwrite_ips(
+        self,
+        request: BlocklistAddIPsRequest,
+        blocklist_id: str,
+    ):
+        endpoint_url = "/blocklists/{blocklist_id}/ips/bulk_overwrite"
+        loc = locals()
+        headers = {}
+        params = {}
+        path_params = json.loads(
+            BlocklistsOverwriteIpsPathParameters(**loc).model_dump_json(
+                exclude_none=True
+            )
+        )
+        
+        payload = json.loads(
+            request.model_dump_json(
+                exclude_none=True
+            )
+        ) if "request" in loc else None
+        response = self.http_client.post(
+            url=endpoint_url, path_params=path_params, params=params, headers=headers, json=payload
+        )
+        
+        return None
+    
     def delete_ips_from_blocklist(
         self,
         request: BlocklistDeleteIPsRequest,

crowdsec_service_api/models.py

@@ -73,6 +73,7 @@ from crowdsec_service_api import (
     Allowlists,
     Server,
     ApiKeyAuth,
+    AllowlistCreateRequest,
 )
 auth = ApiKeyAuth(api_key='your_api_key')
 client = Allowlists(base_url=Server.production_server.value, auth=auth)
@@ -177,6 +178,7 @@ from crowdsec_service_api import (
     Allowlists,
     Server,
     ApiKeyAuth,
+    AllowlistUpdateRequest,
 )
 auth = ApiKeyAuth(api_key='your_api_key')
 client = Allowlists(base_url=Server.production_server.value, auth=auth)
@@ -251,6 +253,7 @@ from crowdsec_service_api import (
     Allowlists,
     Server,
     ApiKeyAuth,
+    AllowlistItemsCreateRequest,
 )
 auth = ApiKeyAuth(api_key='your_api_key')
 client = Allowlists(base_url=Server.production_server.value, auth=auth)
@@ -360,6 +363,7 @@ from crowdsec_service_api import (
     Allowlists,
     Server,
     ApiKeyAuth,
+    AllowlistItemUpdateRequest,
 )
 auth = ApiKeyAuth(api_key='your_api_key')
 client = Allowlists(base_url=Server.production_server.value, auth=auth)
@@ -437,6 +441,7 @@ from crowdsec_service_api import (
     Allowlists,
     Server,
     ApiKeyAuth,
+    AllowlistSubscriptionRequest,
 )
 auth = ApiKeyAuth(api_key='your_api_key')
 client = Allowlists(base_url=Server.production_server.value, auth=auth)

crowdsec_service_api/services/__pycache__/__init__.cpython-311.pyc

@@ -10,6 +10,7 @@
 | [delete_blocklist](#delete_blocklist) | Delete a blocklist by ID. If the blocklist is shared with other organizations or it has subscriptions, the operation will fail. If you want to force delete the blocklist, you can use the force query parameter, so the blocklists will be unshared / unsubscribed. |
 | [update_blocklist](#update_blocklist) | Update a blocklist's details by ID. It is not possible to update the blocklist content using this operation. |
 | [add_ips_to_blocklist](#add_ips_to_blocklist) | Add IPs to a blocklist. If an IP is already in the blocklist, its expiration will be updated with the new expiration. |
+| [overwrite_ips](#overwrite_ips) | Overwrite blocklist content |
 | [delete_ips_from_blocklist](#delete_ips_from_blocklist) | Delete IPs from a blocklist |
 | [download_blocklist_content](#download_blocklist_content) | Download blocklist content as a list of ips as plain text separated by new lines. The response will include the ETag header for cache control. If_Modified_Since and If_None_Match cache control headers are supported for conditional requests. |
 | [get_blocklist_subscribers](#get_blocklist_subscribers) | Get blocklist subscribers within your organization. |
@@ -85,6 +86,7 @@ from crowdsec_service_api import (
     Blocklists,
     Server,
     ApiKeyAuth,
+    BlocklistCreateRequest,
 )
 auth = ApiKeyAuth(api_key='your_api_key')
 client = Blocklists(base_url=Server.production_server.value, auth=auth)
@@ -124,6 +126,7 @@ from crowdsec_service_api import (
     Blocklists,
     Server,
     ApiKeyAuth,
+    BlocklistSearchRequest,
 )
 auth = ApiKeyAuth(api_key='your_api_key')
 client = Blocklists(base_url=Server.production_server.value, auth=auth)
@@ -240,6 +243,7 @@ from crowdsec_service_api import (
     Blocklists,
     Server,
     ApiKeyAuth,
+    BlocklistUpdateRequest,
 )
 auth = ApiKeyAuth(api_key='your_api_key')
 client = Blocklists(base_url=Server.production_server.value, auth=auth)
@@ -284,6 +288,7 @@ from crowdsec_service_api import (
     Blocklists,
     Server,
     ApiKeyAuth,
+    BlocklistAddIPsRequest,
 )
 auth = ApiKeyAuth(api_key='your_api_key')
 client = Blocklists(base_url=Server.production_server.value, auth=auth)
@@ -299,6 +304,47 @@ print(response)
 ```
 
 
+## **overwrite_ips**
+### Overwrite blocklist content 
+- Endpoint: `/blocklists/{blocklist_id}/ips/bulk_overwrite`
+- Method: `POST`
+
+### Parameters:
+| Parameter | Type | Description | Required | Default |
+| --------- | ---- | ----------- | -------- | ------- |
+| request | [BlocklistAddIPsRequest](./Models.md#blocklistaddipsrequest) | Request body | Yes | - |
+| blocklist_id | str |  | True |  |
+### Errors:
+| Code | Description |
+| ---- | ----------- |
+| 403 | Blocklist is read-only |
+| 404 | Blocklist not found |
+| 412 | Payload too large for one operation, limit is 20000 IPs per request |
+| 500 | Internal server error |
+| 422 | Validation Error |
+### Usage
+
+```python
+from crowdsec_service_api import (
+    Blocklists,
+    Server,
+    ApiKeyAuth,
+    BlocklistAddIPsRequest,
+)
+auth = ApiKeyAuth(api_key='your_api_key')
+client = Blocklists(base_url=Server.production_server.value, auth=auth)
+request = BlocklistAddIPsRequest(
+        ips=None,
+        expiration=None,
+)
+response = client.overwrite_ips(
+    request=request,
+    blocklist_id='sample-blocklist-id',
+)
+print(response)
+```
+
+
 ## **delete_ips_from_blocklist**
 ### Delete IPs from a blocklist 
 - Endpoint: `/blocklists/{blocklist_id}/ips/delete`
@@ -323,6 +369,7 @@ from crowdsec_service_api import (
     Blocklists,
     Server,
     ApiKeyAuth,
+    BlocklistDeleteIPsRequest,
 )
 auth = ApiKeyAuth(api_key='your_api_key')
 client = Blocklists(base_url=Server.production_server.value, auth=auth)
@@ -437,6 +484,7 @@ from crowdsec_service_api import (
     Blocklists,
     Server,
     ApiKeyAuth,
+    BlocklistSubscriptionRequest,
 )
 auth = ApiKeyAuth(api_key='your_api_key')
 client = Blocklists(base_url=Server.production_server.value, auth=auth)
@@ -509,6 +557,7 @@ from crowdsec_service_api import (
     Blocklists,
     Server,
     ApiKeyAuth,
+    BlocklistShareRequest,
 )
 auth = ApiKeyAuth(api_key='your_api_key')
 client = Blocklists(base_url=Server.production_server.value, auth=auth)

crowdsec_service_api/services/blocklists.py

@@ -70,6 +70,7 @@ from crowdsec_service_api import (
     Integrations,
     Server,
     ApiKeyAuth,
+    IntegrationCreateRequest,
 )
 auth = ApiKeyAuth(api_key='your_api_key')
 client = Integrations(base_url=Server.production_server.value, auth=auth)
@@ -171,6 +172,7 @@ from crowdsec_service_api import (
     Integrations,
     Server,
     ApiKeyAuth,
+    IntegrationUpdateRequest,
 )
 auth = ApiKeyAuth(api_key='your_api_key')
 client = Integrations(base_url=Server.production_server.value, auth=auth)

doc/Allowlists.md

@@ -578,8 +578,6 @@ id, name, organization_id, created_at, updated_at, entity_type, output_format, b
 | credentials | Optional[ApiKeyCredentials, BasicAuthCredentials] | Credentials for the integration ||
 
 # **Links**
-## Required: 
-first, last, self, next, prev
 ## Properties
 | Property | Type | Description | Example |
 |----------|------|-------------|---------|
@@ -606,9 +604,9 @@ origin, data
 ## Enum: 
 PLAIN_TEXT, F5, REMEDIATION_COMPONENT, FORTIGATE, PALOALTO, CHECKPOINT, CISCO, JUNIPER, MIKROTIK, PFSENSE, OPNSENSE, SOPHOS
 
-# **Page_AllowlistGetItemsResponse_**
+# **Page__TAny_Customized_AllowlistGetItemsResponse_**
 ## Required: 
-items, total, page, size, links
+items, page, size, links
 ## Properties
 | Property | Type | Description | Example |
 |----------|------|-------------|---------|
@@ -619,9 +617,9 @@ items, total, page, size, links
 | pages | Optional[int] | None ||
 | links | Links | None ||
 
-# **Page_AllowlistGetResponse_**
+# **Page__TAny_Customized_AllowlistGetResponse_**
 ## Required: 
-items, total, page, size, links
+items, page, size, links
 ## Properties
 | Property | Type | Description | Example |
 |----------|------|-------------|---------|
@@ -632,9 +630,9 @@ items, total, page, size, links
 | pages | Optional[int] | None ||
 | links | Links | None ||
 
-# **Page_AllowlistSubscriberEntity_**
+# **Page__TAny_Customized_AllowlistSubscriberEntity_**
 ## Required: 
-items, total, page, size, links
+items, page, size, links
 ## Properties
 | Property | Type | Description | Example |
 |----------|------|-------------|---------|
@@ -645,9 +643,9 @@ items, total, page, size, links
 | pages | Optional[int] | None ||
 | links | Links | None ||
 
-# **Page_BlocklistSubscriberEntity_**
+# **Page__TAny_Customized_BlocklistSubscriberEntity_**
 ## Required: 
-items, total, page, size, links
+items, page, size, links
 ## Properties
 | Property | Type | Description | Example |
 |----------|------|-------------|---------|
@@ -658,9 +656,9 @@ items, total, page, size, links
 | pages | Optional[int] | None ||
 | links | Links | None ||
 
-# **Page_IntegrationGetResponse_**
+# **Page__TAny_Customized_IntegrationGetResponse_**
 ## Required: 
-items, total, page, size, links
+items, page, size, links
 ## Properties
 | Property | Type | Description | Example |
 |----------|------|-------------|---------|
@@ -671,9 +669,9 @@ items, total, page, size, links
 | pages | Optional[int] | None ||
 | links | Links | None ||
 
-# **Page_PublicBlocklistResponse_**
+# **Page__TAny_Customized_PublicBlocklistResponse_**
 ## Required: 
-items, total, page, size, links
+items, page, size, links
 ## Properties
 | Property | Type | Description | Example |
 |----------|------|-------------|---------|