gcore 0.3.0__py3-none-any.whl → 0.4.0__py3-none-any.whl

gcore/resources/cloud/reserved_fixed_ips/vip.py

@@ -63,7 +63,7 @@ class VipResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> CandidatePortList:
         """
-        List instance ports that are available for connecting to VIP
+        List all instance ports that are available for connecting to a VIP.
 
         Args:
           extra_headers: Send extra headers
@@ -102,7 +102,7 @@ class VipResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> ConnectedPortList:
         """
-        List instance ports that share VIP
+        List all instance ports that share a VIP.
 
         Args:
           extra_headers: Send extra headers
@@ -142,7 +142,7 @@ class VipResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> ConnectedPortList:
         """
-        Replace ports that share VIP
+        Replace the list of instance ports that share a VIP.
 
         Args:
           port_ids: List of port IDs that will share one VIP
@@ -187,7 +187,7 @@ class VipResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> ReservedFixedIP:
         """
-        Switch VIP status of reserved fixed IP
+        Update the VIP status of a reserved fixed IP.
 
         Args:
           is_vip: If reserved fixed IP should be a VIP
@@ -230,7 +230,7 @@ class VipResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> ConnectedPortList:
         """
-        Add ports that share VIP
+        Add instance ports to share a VIP.
 
         Args:
           port_ids: List of port IDs that will share one VIP
@@ -295,7 +295,7 @@ class AsyncVipResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> CandidatePortList:
         """
-        List instance ports that are available for connecting to VIP
+        List all instance ports that are available for connecting to a VIP.
 
         Args:
           extra_headers: Send extra headers
@@ -334,7 +334,7 @@ class AsyncVipResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> ConnectedPortList:
         """
-        List instance ports that share VIP
+        List all instance ports that share a VIP.
 
         Args:
           extra_headers: Send extra headers
@@ -374,7 +374,7 @@ class AsyncVipResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> ConnectedPortList:
         """
-        Replace ports that share VIP
+        Replace the list of instance ports that share a VIP.
 
         Args:
           port_ids: List of port IDs that will share one VIP
@@ -419,7 +419,7 @@ class AsyncVipResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> ReservedFixedIP:
         """
-        Switch VIP status of reserved fixed IP
+        Update the VIP status of a reserved fixed IP.
 
         Args:
           is_vip: If reserved fixed IP should be a VIP
@@ -462,7 +462,7 @@ class AsyncVipResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> ConnectedPortList:
         """
-        Add ports that share VIP
+        Add instance ports to share a VIP.
 
         Args:
           port_ids: List of port IDs that will share one VIP

gcore/resources/cloud/security_groups/rules.py

@@ -92,7 +92,7 @@ class RulesResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SecurityGroupRule:
         """
-        Add new rule to security group
+        Add a new rule to an existing security group.
 
         Args:
           description: Rule description
@@ -160,7 +160,7 @@ class RulesResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
         """
-        Delete security group rule
+        Delete a specific rule from a security group.
 
         Args:
           extra_headers: Send extra headers
@@ -235,7 +235,7 @@ class RulesResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SecurityGroupRule:
         """
-        Edit the security group rule: delete old and create new rule
+        Update the configuration of an existing security group rule.
 
         Args:
           direction: Ingress or egress, which is the direction in which the security group rule is
@@ -363,7 +363,7 @@ class AsyncRulesResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SecurityGroupRule:
         """
-        Add new rule to security group
+        Add a new rule to an existing security group.
 
         Args:
           description: Rule description
@@ -431,7 +431,7 @@ class AsyncRulesResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
         """
-        Delete security group rule
+        Delete a specific rule from a security group.
 
         Args:
           extra_headers: Send extra headers
@@ -506,7 +506,7 @@ class AsyncRulesResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SecurityGroupRule:
         """
-        Edit the security group rule: delete old and create new rule
+        Update the configuration of an existing security group rule.
 
         Args:
           direction: Ingress or egress, which is the direction in which the security group rule is

gcore/resources/cloud/security_groups/security_groups.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import List, Iterable
+from typing import List, Iterable, Optional
 
 import httpx
 
@@ -33,6 +33,7 @@ from ....types.cloud import (
 )
 from ...._base_client import AsyncPaginator, make_request_options
 from ....types.cloud.security_group import SecurityGroup
+from ....types.cloud.tag_update_map_param import TagUpdateMapParam
 
 __all__ = ["SecurityGroupsResource", "AsyncSecurityGroupsResource"]
 
@@ -76,7 +77,7 @@ class SecurityGroupsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SecurityGroup:
         """
-        Create security group
+        Create a new security group with the specified configuration.
 
         Args:
           security_group: Security group
@@ -118,6 +119,7 @@ class SecurityGroupsResource(SyncAPIResource):
         region_id: int | None = None,
         changed_rules: Iterable[security_group_update_params.ChangedRule] | NotGiven = NOT_GIVEN,
         name: str | NotGiven = NOT_GIVEN,
+        tags: Optional[TagUpdateMapParam] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -126,13 +128,33 @@ class SecurityGroupsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SecurityGroup:
         """
-        Change security group
+        Update the configuration of an existing security group.
 
         Args:
           changed_rules: List of rules to create or delete
 
           name: Name
 
+          tags: Update key-value tags using JSON Merge Patch semantics (RFC 7386). Provide
+              key-value pairs to add or update tags. Set tag values to `null` to remove tags.
+              Unspecified tags remain unchanged. Read-only tags are always preserved and
+              cannot be modified. **Examples:**
+
+              - **Add/update tags:**
+                `{'tags': {'environment': 'production', 'team': 'backend'}}` adds new tags or
+                updates existing ones.
+              - **Delete tags:** `{'tags': {'`old_tag`': null}}` removes specific tags.
+              - **Remove all tags:** `{'tags': null}` removes all user-managed tags (read-only
+                tags are preserved).
+              - **Partial update:** `{'tags': {'environment': 'staging'}}` only updates
+                specified tags.
+              - **Mixed operations:**
+                `{'tags': {'environment': 'production', '`cost_center`': 'engineering', '`deprecated_tag`': null}}`
+                adds/updates 'environment' and '`cost_center`' while removing
+                '`deprecated_tag`', preserving other existing tags.
+              - **Replace all:** first delete existing tags with null values, then add new
+                ones in the same request.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -153,6 +175,7 @@ class SecurityGroupsResource(SyncAPIResource):
                 {
                     "changed_rules": changed_rules,
                     "name": name,
+                    "tags": tags,
                 },
                 security_group_update_params.SecurityGroupUpdateParams,
             ),
@@ -179,18 +202,16 @@ class SecurityGroupsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SyncOffsetPage[SecurityGroup]:
         """
-        Get security groups
+        List all security groups in the specified project and region.
 
         Args:
-          limit: Limit the number of returned limit request entities.
+          limit: Limit the number of returned security groups
 
-          offset: Offset value is used to exclude the first set of records from the result.
+          offset: Offset value is used to exclude the first set of records from the result
 
           tag_key: Filter by tag keys.
 
-          tag_key_value: Filter by tag key-value pairs. Must be a valid JSON string. curl -G
-              --data-urlencode "`tag_key_value`={"key": "value"}" --url
-              "http://localhost:1111/v1/securitygroups/1/1"
+          tag_key_value: Filter by tag key-value pairs. Must be a valid JSON string.
 
           extra_headers: Send extra headers
 
@@ -239,7 +260,7 @@ class SecurityGroupsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
         """
-        Delete security group
+        Delete a specific security group and all its associated rules.
 
         Args:
           extra_headers: Send extra headers
@@ -278,9 +299,9 @@ class SecurityGroupsResource(SyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> None:
+    ) -> SecurityGroup:
         """
-        Create a deep copy of security group
+        Create a deep copy of an existing security group.
 
         Args:
           name: Name.
@@ -299,14 +320,13 @@ class SecurityGroupsResource(SyncAPIResource):
             region_id = self._client._get_cloud_region_id_path_param()
         if not group_id:
             raise ValueError(f"Expected a non-empty value for `group_id` but received {group_id!r}")
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return self._post(
             f"/cloud/v1/securitygroups/{project_id}/{region_id}/{group_id}/copy",
             body=maybe_transform({"name": name}, security_group_copy_params.SecurityGroupCopyParams),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NoneType,
+            cast_to=SecurityGroup,
         )
 
     def get(
@@ -323,7 +343,7 @@ class SecurityGroupsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SecurityGroup:
         """
-        Get security group
+        Get detailed information about a specific security group.
 
         Args:
           extra_headers: Send extra headers
@@ -362,7 +382,7 @@ class SecurityGroupsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SecurityGroup:
         """
-        Revert security group
+        Revert a security group to its previous state.
 
         Args:
           extra_headers: Send extra headers
@@ -427,7 +447,7 @@ class AsyncSecurityGroupsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SecurityGroup:
         """
-        Create security group
+        Create a new security group with the specified configuration.
 
         Args:
           security_group: Security group
@@ -469,6 +489,7 @@ class AsyncSecurityGroupsResource(AsyncAPIResource):
         region_id: int | None = None,
         changed_rules: Iterable[security_group_update_params.ChangedRule] | NotGiven = NOT_GIVEN,
         name: str | NotGiven = NOT_GIVEN,
+        tags: Optional[TagUpdateMapParam] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -477,13 +498,33 @@ class AsyncSecurityGroupsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SecurityGroup:
         """
-        Change security group
+        Update the configuration of an existing security group.
 
         Args:
           changed_rules: List of rules to create or delete
 
           name: Name
 
+          tags: Update key-value tags using JSON Merge Patch semantics (RFC 7386). Provide
+              key-value pairs to add or update tags. Set tag values to `null` to remove tags.
+              Unspecified tags remain unchanged. Read-only tags are always preserved and
+              cannot be modified. **Examples:**
+
+              - **Add/update tags:**
+                `{'tags': {'environment': 'production', 'team': 'backend'}}` adds new tags or
+                updates existing ones.
+              - **Delete tags:** `{'tags': {'`old_tag`': null}}` removes specific tags.
+              - **Remove all tags:** `{'tags': null}` removes all user-managed tags (read-only
+                tags are preserved).
+              - **Partial update:** `{'tags': {'environment': 'staging'}}` only updates
+                specified tags.
+              - **Mixed operations:**
+                `{'tags': {'environment': 'production', '`cost_center`': 'engineering', '`deprecated_tag`': null}}`
+                adds/updates 'environment' and '`cost_center`' while removing
+                '`deprecated_tag`', preserving other existing tags.
+              - **Replace all:** first delete existing tags with null values, then add new
+                ones in the same request.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -504,6 +545,7 @@ class AsyncSecurityGroupsResource(AsyncAPIResource):
                 {
                     "changed_rules": changed_rules,
                     "name": name,
+                    "tags": tags,
                 },
                 security_group_update_params.SecurityGroupUpdateParams,
             ),
@@ -530,18 +572,16 @@ class AsyncSecurityGroupsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> AsyncPaginator[SecurityGroup, AsyncOffsetPage[SecurityGroup]]:
         """
-        Get security groups
+        List all security groups in the specified project and region.
 
         Args:
-          limit: Limit the number of returned limit request entities.
+          limit: Limit the number of returned security groups
 
-          offset: Offset value is used to exclude the first set of records from the result.
+          offset: Offset value is used to exclude the first set of records from the result
 
           tag_key: Filter by tag keys.
 
-          tag_key_value: Filter by tag key-value pairs. Must be a valid JSON string. curl -G
-              --data-urlencode "`tag_key_value`={"key": "value"}" --url
-              "http://localhost:1111/v1/securitygroups/1/1"
+          tag_key_value: Filter by tag key-value pairs. Must be a valid JSON string.
 
           extra_headers: Send extra headers
 
@@ -590,7 +630,7 @@ class AsyncSecurityGroupsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
         """
-        Delete security group
+        Delete a specific security group and all its associated rules.
 
         Args:
           extra_headers: Send extra headers
@@ -629,9 +669,9 @@ class AsyncSecurityGroupsResource(AsyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> None:
+    ) -> SecurityGroup:
         """
-        Create a deep copy of security group
+        Create a deep copy of an existing security group.
 
         Args:
           name: Name.
@@ -650,14 +690,13 @@ class AsyncSecurityGroupsResource(AsyncAPIResource):
             region_id = self._client._get_cloud_region_id_path_param()
         if not group_id:
             raise ValueError(f"Expected a non-empty value for `group_id` but received {group_id!r}")
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return await self._post(
             f"/cloud/v1/securitygroups/{project_id}/{region_id}/{group_id}/copy",
             body=await async_maybe_transform({"name": name}, security_group_copy_params.SecurityGroupCopyParams),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NoneType,
+            cast_to=SecurityGroup,
         )
 
     async def get(
@@ -674,7 +713,7 @@ class AsyncSecurityGroupsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SecurityGroup:
         """
-        Get security group
+        Get detailed information about a specific security group.
 
         Args:
           extra_headers: Send extra headers
@@ -713,7 +752,7 @@ class AsyncSecurityGroupsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SecurityGroup:
         """
-        Revert security group
+        Revert a security group to its previous state.
 
         Args:
           extra_headers: Send extra headers

gcore/resources/cloud/tasks.py

@@ -233,7 +233,7 @@ class TasksResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
         """
-        Acknowledge all client tasks in project or region
+        Acknowledge all tasks
 
         Args:
           project_id: Project ID
@@ -279,7 +279,7 @@ class TasksResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> Task:
         """
-        Acknowledge one task on project scope
+        Acknowledge one task
 
         Args:
           task_id: Task ID
@@ -541,7 +541,7 @@ class AsyncTasksResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
         """
-        Acknowledge all client tasks in project or region
+        Acknowledge all tasks
 
         Args:
           project_id: Project ID
@@ -587,7 +587,7 @@ class AsyncTasksResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> Task:
         """
-        Acknowledge one task on project scope
+        Acknowledge one task
 
         Args:
           task_id: Task ID

gcore/resources/cloud/users/role_assignments.py

@@ -64,7 +64,7 @@ class RoleAssignmentsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> RoleAssignment:
         """
-        Assign role to existing user
+        Assign a role to an existing user in the specified scope.
 
         Args:
           role: User role
@@ -116,7 +116,7 @@ class RoleAssignmentsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> RoleAssignmentUpdateDelete:
         """
-        Modify role assignment to existing user
+        Modify an existing role assignment for a user.
 
         Args:
           assignment_id: Assignment ID
@@ -168,12 +168,11 @@ class RoleAssignmentsResource(SyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SyncOffsetPage[RoleAssignment]:
-        """List assignments
+        """
+        List all role assignments in the specified scope.
 
         Args:
-          limit: Limit the number of returned items.
-
-        Falls back to default of 1000 if not
+          limit: Limit the number of returned items. Falls back to default of 1000 if not
               specified. Limited by max limit value of 1000
 
           offset: Offset value is used to exclude the first set of records from the result
@@ -223,7 +222,7 @@ class RoleAssignmentsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> RoleAssignmentUpdateDelete:
         """
-        Delete role assignment
+        Delete an existing role assignment.
 
         Args:
           assignment_id: Assignment ID
@@ -280,7 +279,7 @@ class AsyncRoleAssignmentsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> RoleAssignment:
         """
-        Assign role to existing user
+        Assign a role to an existing user in the specified scope.
 
         Args:
           role: User role
@@ -332,7 +331,7 @@ class AsyncRoleAssignmentsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> RoleAssignmentUpdateDelete:
         """
-        Modify role assignment to existing user
+        Modify an existing role assignment for a user.
 
         Args:
           assignment_id: Assignment ID
@@ -384,12 +383,11 @@ class AsyncRoleAssignmentsResource(AsyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> AsyncPaginator[RoleAssignment, AsyncOffsetPage[RoleAssignment]]:
-        """List assignments
+        """
+        List all role assignments in the specified scope.
 
         Args:
-          limit: Limit the number of returned items.
-
-        Falls back to default of 1000 if not
+          limit: Limit the number of returned items. Falls back to default of 1000 if not
               specified. Limited by max limit value of 1000
 
           offset: Offset value is used to exclude the first set of records from the result
@@ -439,7 +437,7 @@ class AsyncRoleAssignmentsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> RoleAssignmentUpdateDelete:
         """
-        Delete role assignment
+        Delete an existing role assignment.
 
         Args:
           assignment_id: Assignment ID