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

gcore/resources/cloud/instances/instances.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import List, Union, Iterable, Optional
+from typing import Dict, List, Union, Iterable, Optional
 from datetime import datetime
 from typing_extensions import Literal, overload
 
@@ -68,7 +68,6 @@ from ....types.cloud.console import Console
 from ....types.cloud.instance import Instance
 from ....types.cloud.task_id_list import TaskIDList
 from ....types.cloud.instance_interface import InstanceInterface
-from ....types.cloud.tag_update_map_param import TagUpdateMapParam
 
 __all__ = ["InstancesResource", "AsyncInstancesResource"]
 
@@ -125,7 +124,7 @@ class InstancesResource(SyncAPIResource):
         security_groups: Iterable[instance_create_params.SecurityGroup] | NotGiven = NOT_GIVEN,
         servergroup_id: str | NotGiven = NOT_GIVEN,
         ssh_key_name: Optional[str] | NotGiven = NOT_GIVEN,
-        tags: TagUpdateMapParam | NotGiven = NOT_GIVEN,
+        tags: Dict[str, str] | NotGiven = NOT_GIVEN,
         user_data: str | NotGiven = NOT_GIVEN,
         username: str | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -135,22 +134,20 @@ class InstancesResource(SyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> TaskIDList:
-        """
-        For Linux,
+        """Create an instance with specified configuration.
+
+        How to get access: For Linux,
 
         - Use the `user_data` field to provide a
-          <a href=https://cloudinit.readthedocs.io/en/latest/reference/examples.html>cloud-init
-          script</a> in base64 to apply configurations to the instance.
+          [cloud-init script](https://cloudinit.readthedocs.io/en/latest/reference/examples.html)
+          in base64 to apply configurations to the instance.
         - Specify the `username` and `password` to create a new user.
         - When only `password` is provided, it is set as the password for the default
           user of the image.
-        - The `user_data` is ignored when the `password` is specified.
-
-        For Windows,
-
+        - The `user_data` is ignored when the `password` is specified. For Windows,
         - Use the `user_data` field to provide a
-          <a href=https://cloudbase-init.readthedocs.io/en/latest/userdata.html#cloud-config>cloudbase-init
-          script</a> in base64 to create new users on Windows.
+          [cloudbase-init script](https://cloudbase-init.readthedocs.io/en/latest/userdata.html#cloud-config)
+          in base64 to create new users on Windows.
         - Use the `password` field to set the password for the 'Admin' user on Windows.
         - The password of the Admin user cannot be updated via `user_data`.
         - The `username` cannot be specified in the request.
@@ -179,21 +176,20 @@ class InstancesResource(SyncAPIResource):
           name_template: If you want the instance name to be automatically generated based on IP
               addresses, you can provide a name template instead of specifying the name
               manually. The template should include a placeholder that will be replaced during
-              provisioning. Supported placeholders are: `{ip_octets}` (last 3 octets of the
-              IP), `{two_ip_octets}`, and `{one_ip_octet}`.
+              provisioning. Supported placeholders are: `{`ip_octets`}` (last 3 octets of the
+              IP), `{`two_ip_octets`}`, and `{`one_ip_octet`}`.
 
           password: For Linux instances, 'username' and 'password' are used to create a new user.
               When only 'password' is provided, it is set as the password for the default user
               of the image. For Windows instances, 'username' cannot be specified. Use the
               'password' field to set the password for the 'Admin' user on Windows. Use the
-              'user_data' field to provide a script to create new users on Windows. The
-              password of the Admin user cannot be updated via 'user_data'.
+              '`user_data`' field to provide a script to create new users on Windows. The
+              password of the Admin user cannot be updated via '`user_data`'.
 
           security_groups: Specifies security group UUIDs to be applied to all instance network interfaces.
 
-          servergroup_id: Placement group ID for instance placement policy.
-
-              Supported group types:
+          servergroup_id:
+              Placement group ID for instance placement policy. Supported group types:
 
               - `anti-affinity`: Ensures instances are placed on different hosts for high
                 availability.
@@ -202,7 +198,7 @@ class InstancesResource(SyncAPIResource):
                 sharing if needed.
 
           ssh_key_name: Specifies the name of the SSH keypair, created via the
-              <a href="#operation/SSHKeyCollectionViewSet.post">/v1/ssh_keys endpoint</a>.
+              [/v1/`ssh_keys` endpoint](/docs/api-reference/ssh-keys/add-or-generate-ssh-key).
 
           tags: Key-value tags to associate with the resource. A tag is a key-value pair that
               can be associated with a resource, enabling efficient filtering and grouping for
@@ -210,10 +206,10 @@ class InstancesResource(SyncAPIResource):
               modified by the user. Tags are also integrated with cost reports, allowing cost
               data to be filtered based on tag keys or values.
 
-          user_data: String in base64 format. For Linux instances, 'user_data' is ignored when
+          user_data: String in base64 format. For Linux instances, '`user_data`' is ignored when
               'password' field is provided. For Windows instances, Admin user password is set
-              by 'password' field and cannot be updated via 'user_data'. Examples of the
-              user_data: https://cloudinit.readthedocs.io/en/latest/topics/examples.html
+              by 'password' field and cannot be updated via '`user_data`'. Examples of the
+              `user_data`: https://cloudinit.readthedocs.io/en/latest/topics/examples.html
 
           username: For Linux instances, 'username' and 'password' are used to create a new user.
               For Windows instances, 'username' cannot be specified. Use 'password' field to
@@ -274,7 +270,7 @@ class InstancesResource(SyncAPIResource):
         security_groups: Iterable[instance_create_params.SecurityGroup] | NotGiven = NOT_GIVEN,
         servergroup_id: str | NotGiven = NOT_GIVEN,
         ssh_key_name: Optional[str] | NotGiven = NOT_GIVEN,
-        tags: TagUpdateMapParam | NotGiven = NOT_GIVEN,
+        tags: Dict[str, str] | NotGiven = NOT_GIVEN,
         user_data: str | NotGiven = NOT_GIVEN,
         username: str | NotGiven = NOT_GIVEN,
         polling_interval_seconds: int | NotGiven = NOT_GIVEN,
@@ -433,8 +429,10 @@ class InstancesResource(SyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SyncOffsetPage[Instance]:
-        """
-        List instances
+        """List all instances in the specified project and region.
+
+        Results can be filtered
+        by various parameters like name, status, and IP address.
 
         Args:
           project_id: Project ID
@@ -452,9 +450,9 @@ class InstancesResource(SyncAPIResource):
 
           exclude_secgroup: Exclude instances with specified security group name
 
-          flavor_id: Filter out instances by flavor_id. Flavor id must match exactly.
+          flavor_id: Filter out instances by `flavor_id`. Flavor id must match exactly.
 
-          flavor_prefix: Filter out instances by flavor_prefix.
+          flavor_prefix: Filter out instances by `flavor_prefix`.
 
           include_ai: Include GPU clusters' servers
 
@@ -481,22 +479,20 @@ class InstancesResource(SyncAPIResource):
 
           order_by: Order by field and direction.
 
-          profile_name: Filter result by ddos protection profile name. Effective only with with_ddos set
-              to true.
+          profile_name: Filter result by ddos protection profile name. Effective only with `with_ddos`
+              set to true.
 
-          protection_status: Filter result by DDoS protection_status. if parameter is provided. Effective
-              only with with_ddos set to true. (Active, Queued or Error)
+          protection_status: Filter result by DDoS `protection_status`. if parameter is provided. Effective
+              only with `with_ddos` set to true. (Active, Queued or Error)
 
           status: Filters instances by status.
 
-          tag_key_value: Optional. Filter by tag key-value pairs. curl -G --data-urlencode
-              "tag_key_value={"key": "value"}" --url
-              "https://example.com/cloud/v1/resource/1/1"
+          tag_key_value: Optional. Filter by tag key-value pairs.
 
-          tag_value: Optional. Filter by tag values. ?tag_value=value1&tag_value=value2
+          tag_value: Optional. Filter by tag values. ?`tag_value`=value1&`tag_value`=value2
 
           type_ddos_profile: Return bare metals either only with advanced or only basic DDoS protection.
-              Effective only with with_ddos set to true. (advanced or basic)
+              Effective only with `with_ddos` set to true. (advanced or basic)
 
           uuid: Filter the server list result by the UUID of the server. Allowed UUID part
 
@@ -691,7 +687,7 @@ class InstancesResource(SyncAPIResource):
     ) -> TaskIDList:
         """
         The action can be one of: start, stop, reboot, powercycle, suspend or resume.
-        Suspend and resume are not available for baremetal instances.
+        Suspend and resume are not available for bare metal instances.
 
         Args:
           action: Instance action name
@@ -725,7 +721,7 @@ class InstancesResource(SyncAPIResource):
     ) -> TaskIDList:
         """
         The action can be one of: start, stop, reboot, powercycle, suspend or resume.
-        Suspend and resume are not available for baremetal instances.
+        Suspend and resume are not available for bare metal instances.
 
         Args:
           action: Instance action name
@@ -791,8 +787,10 @@ class InstancesResource(SyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> TaskIDList:
-        """
-        Put instance into the server group
+        """Add an instance to a server group.
+
+        The instance must not already be in a server
+        group. Bare metal servers do not support server groups.
 
         Args:
           servergroup_id: Anti-affinity or affinity or soft-anti-affinity server group ID.
@@ -884,7 +882,7 @@ class InstancesResource(SyncAPIResource):
         """Assign the security group to the server.
 
         To assign multiple security groups to
-        all ports, use the NULL value for the port_id field
+        all ports, use the NULL value for the `port_id` field
 
         Args:
           name: Security group name, applies to all ports
@@ -1012,14 +1010,17 @@ class InstancesResource(SyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> Instance:
-        """
-        **Cookie Parameters**:
+        """Retrieve detailed information about a specific instance.
+
+        The response content
+        language for `ddos_profile` can be controlled via the 'language' cookie
+        parameter. **Cookie Parameters**:
 
         - `language` (str, optional): Language for the response content. Affects the
           `ddos_profile` field. Supported values:
-          - `'en'` (default)
-          - `'de'`
-          - `'ru'`
+        - `'en'` (default)
+        - `'de'`
+        - `'ru'`
 
         Args:
           project_id: Project ID
@@ -1111,8 +1112,10 @@ class InstancesResource(SyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> TaskIDList:
-        """
-        Remove instance from the server group
+        """Remove an instance from its current server group.
+
+        The instance must be in a
+        server group to be removed. Bare metal servers do not support server groups.
 
         Args:
           extra_headers: Send extra headers
@@ -1281,7 +1284,7 @@ class InstancesResource(SyncAPIResource):
         """Un-assign the security group to the server.
 
         To un-assign multiple security
-        groups to all ports, use the NULL value for the port_id field
+        groups to all ports, use the NULL value for the `port_id` field
 
         Args:
           name: Security group name, applies to all ports
@@ -1371,7 +1374,7 @@ class AsyncInstancesResource(AsyncAPIResource):
         security_groups: Iterable[instance_create_params.SecurityGroup] | NotGiven = NOT_GIVEN,
         servergroup_id: str | NotGiven = NOT_GIVEN,
         ssh_key_name: Optional[str] | NotGiven = NOT_GIVEN,
-        tags: TagUpdateMapParam | NotGiven = NOT_GIVEN,
+        tags: Dict[str, str] | NotGiven = NOT_GIVEN,
         user_data: str | NotGiven = NOT_GIVEN,
         username: str | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -1381,22 +1384,20 @@ class AsyncInstancesResource(AsyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> TaskIDList:
-        """
-        For Linux,
+        """Create an instance with specified configuration.
+
+        How to get access: For Linux,
 
         - Use the `user_data` field to provide a
-          <a href=https://cloudinit.readthedocs.io/en/latest/reference/examples.html>cloud-init
-          script</a> in base64 to apply configurations to the instance.
+          [cloud-init script](https://cloudinit.readthedocs.io/en/latest/reference/examples.html)
+          in base64 to apply configurations to the instance.
         - Specify the `username` and `password` to create a new user.
         - When only `password` is provided, it is set as the password for the default
           user of the image.
-        - The `user_data` is ignored when the `password` is specified.
-
-        For Windows,
-
+        - The `user_data` is ignored when the `password` is specified. For Windows,
         - Use the `user_data` field to provide a
-          <a href=https://cloudbase-init.readthedocs.io/en/latest/userdata.html#cloud-config>cloudbase-init
-          script</a> in base64 to create new users on Windows.
+          [cloudbase-init script](https://cloudbase-init.readthedocs.io/en/latest/userdata.html#cloud-config)
+          in base64 to create new users on Windows.
         - Use the `password` field to set the password for the 'Admin' user on Windows.
         - The password of the Admin user cannot be updated via `user_data`.
         - The `username` cannot be specified in the request.
@@ -1425,21 +1426,20 @@ class AsyncInstancesResource(AsyncAPIResource):
           name_template: If you want the instance name to be automatically generated based on IP
               addresses, you can provide a name template instead of specifying the name
               manually. The template should include a placeholder that will be replaced during
-              provisioning. Supported placeholders are: `{ip_octets}` (last 3 octets of the
-              IP), `{two_ip_octets}`, and `{one_ip_octet}`.
+              provisioning. Supported placeholders are: `{`ip_octets`}` (last 3 octets of the
+              IP), `{`two_ip_octets`}`, and `{`one_ip_octet`}`.
 
           password: For Linux instances, 'username' and 'password' are used to create a new user.
               When only 'password' is provided, it is set as the password for the default user
               of the image. For Windows instances, 'username' cannot be specified. Use the
               'password' field to set the password for the 'Admin' user on Windows. Use the
-              'user_data' field to provide a script to create new users on Windows. The
-              password of the Admin user cannot be updated via 'user_data'.
+              '`user_data`' field to provide a script to create new users on Windows. The
+              password of the Admin user cannot be updated via '`user_data`'.
 
           security_groups: Specifies security group UUIDs to be applied to all instance network interfaces.
 
-          servergroup_id: Placement group ID for instance placement policy.
-
-              Supported group types:
+          servergroup_id:
+              Placement group ID for instance placement policy. Supported group types:
 
               - `anti-affinity`: Ensures instances are placed on different hosts for high
                 availability.
@@ -1448,7 +1448,7 @@ class AsyncInstancesResource(AsyncAPIResource):
                 sharing if needed.
 
           ssh_key_name: Specifies the name of the SSH keypair, created via the
-              <a href="#operation/SSHKeyCollectionViewSet.post">/v1/ssh_keys endpoint</a>.
+              [/v1/`ssh_keys` endpoint](/docs/api-reference/ssh-keys/add-or-generate-ssh-key).
 
           tags: Key-value tags to associate with the resource. A tag is a key-value pair that
               can be associated with a resource, enabling efficient filtering and grouping for
@@ -1456,10 +1456,10 @@ class AsyncInstancesResource(AsyncAPIResource):
               modified by the user. Tags are also integrated with cost reports, allowing cost
               data to be filtered based on tag keys or values.
 
-          user_data: String in base64 format. For Linux instances, 'user_data' is ignored when
+          user_data: String in base64 format. For Linux instances, '`user_data`' is ignored when
               'password' field is provided. For Windows instances, Admin user password is set
-              by 'password' field and cannot be updated via 'user_data'. Examples of the
-              user_data: https://cloudinit.readthedocs.io/en/latest/topics/examples.html
+              by 'password' field and cannot be updated via '`user_data`'. Examples of the
+              `user_data`: https://cloudinit.readthedocs.io/en/latest/topics/examples.html
 
           username: For Linux instances, 'username' and 'password' are used to create a new user.
               For Windows instances, 'username' cannot be specified. Use 'password' field to
@@ -1520,7 +1520,7 @@ class AsyncInstancesResource(AsyncAPIResource):
         security_groups: Iterable[instance_create_params.SecurityGroup] | NotGiven = NOT_GIVEN,
         servergroup_id: str | NotGiven = NOT_GIVEN,
         ssh_key_name: Optional[str] | NotGiven = NOT_GIVEN,
-        tags: TagUpdateMapParam | NotGiven = NOT_GIVEN,
+        tags: Dict[str, str] | NotGiven = NOT_GIVEN,
         user_data: str | NotGiven = NOT_GIVEN,
         username: str | NotGiven = NOT_GIVEN,
         polling_interval_seconds: int | NotGiven = NOT_GIVEN,
@@ -1679,8 +1679,10 @@ class AsyncInstancesResource(AsyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> AsyncPaginator[Instance, AsyncOffsetPage[Instance]]:
-        """
-        List instances
+        """List all instances in the specified project and region.
+
+        Results can be filtered
+        by various parameters like name, status, and IP address.
 
         Args:
           project_id: Project ID
@@ -1698,9 +1700,9 @@ class AsyncInstancesResource(AsyncAPIResource):
 
           exclude_secgroup: Exclude instances with specified security group name
 
-          flavor_id: Filter out instances by flavor_id. Flavor id must match exactly.
+          flavor_id: Filter out instances by `flavor_id`. Flavor id must match exactly.
 
-          flavor_prefix: Filter out instances by flavor_prefix.
+          flavor_prefix: Filter out instances by `flavor_prefix`.
 
           include_ai: Include GPU clusters' servers
 
@@ -1727,22 +1729,20 @@ class AsyncInstancesResource(AsyncAPIResource):
 
           order_by: Order by field and direction.
 
-          profile_name: Filter result by ddos protection profile name. Effective only with with_ddos set
-              to true.
+          profile_name: Filter result by ddos protection profile name. Effective only with `with_ddos`
+              set to true.
 
-          protection_status: Filter result by DDoS protection_status. if parameter is provided. Effective
-              only with with_ddos set to true. (Active, Queued or Error)
+          protection_status: Filter result by DDoS `protection_status`. if parameter is provided. Effective
+              only with `with_ddos` set to true. (Active, Queued or Error)
 
           status: Filters instances by status.
 
-          tag_key_value: Optional. Filter by tag key-value pairs. curl -G --data-urlencode
-              "tag_key_value={"key": "value"}" --url
-              "https://example.com/cloud/v1/resource/1/1"
+          tag_key_value: Optional. Filter by tag key-value pairs.
 
-          tag_value: Optional. Filter by tag values. ?tag_value=value1&tag_value=value2
+          tag_value: Optional. Filter by tag values. ?`tag_value`=value1&`tag_value`=value2
 
           type_ddos_profile: Return bare metals either only with advanced or only basic DDoS protection.
-              Effective only with with_ddos set to true. (advanced or basic)
+              Effective only with `with_ddos` set to true. (advanced or basic)
 
           uuid: Filter the server list result by the UUID of the server. Allowed UUID part
 
@@ -1937,7 +1937,7 @@ class AsyncInstancesResource(AsyncAPIResource):
     ) -> TaskIDList:
         """
         The action can be one of: start, stop, reboot, powercycle, suspend or resume.
-        Suspend and resume are not available for baremetal instances.
+        Suspend and resume are not available for bare metal instances.
 
         Args:
           action: Instance action name
@@ -1971,7 +1971,7 @@ class AsyncInstancesResource(AsyncAPIResource):
     ) -> TaskIDList:
         """
         The action can be one of: start, stop, reboot, powercycle, suspend or resume.
-        Suspend and resume are not available for baremetal instances.
+        Suspend and resume are not available for bare metal instances.
 
         Args:
           action: Instance action name
@@ -2037,8 +2037,10 @@ class AsyncInstancesResource(AsyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> TaskIDList:
-        """
-        Put instance into the server group
+        """Add an instance to a server group.
+
+        The instance must not already be in a server
+        group. Bare metal servers do not support server groups.
 
         Args:
           servergroup_id: Anti-affinity or affinity or soft-anti-affinity server group ID.
@@ -2130,7 +2132,7 @@ class AsyncInstancesResource(AsyncAPIResource):
         """Assign the security group to the server.
 
         To assign multiple security groups to
-        all ports, use the NULL value for the port_id field
+        all ports, use the NULL value for the `port_id` field
 
         Args:
           name: Security group name, applies to all ports
@@ -2258,14 +2260,17 @@ class AsyncInstancesResource(AsyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> Instance:
-        """
-        **Cookie Parameters**:
+        """Retrieve detailed information about a specific instance.
+
+        The response content
+        language for `ddos_profile` can be controlled via the 'language' cookie
+        parameter. **Cookie Parameters**:
 
         - `language` (str, optional): Language for the response content. Affects the
           `ddos_profile` field. Supported values:
-          - `'en'` (default)
-          - `'de'`
-          - `'ru'`
+        - `'en'` (default)
+        - `'de'`
+        - `'ru'`
 
         Args:
           project_id: Project ID
@@ -2357,8 +2362,10 @@ class AsyncInstancesResource(AsyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> TaskIDList:
-        """
-        Remove instance from the server group
+        """Remove an instance from its current server group.
+
+        The instance must be in a
+        server group to be removed. Bare metal servers do not support server groups.
 
         Args:
           extra_headers: Send extra headers
@@ -2527,7 +2534,7 @@ class AsyncInstancesResource(AsyncAPIResource):
         """Un-assign the security group to the server.
 
         To un-assign multiple security
-        groups to all ports, use the NULL value for the port_id field
+        groups to all ports, use the NULL value for the `port_id` field
 
         Args:
           name: Security group name, applies to all ports

gcore/resources/cloud/instances/interfaces.py

@@ -59,7 +59,7 @@ class InterfacesResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> NetworkInterfaceList:
         """
-        List network interfaces attached to the instance
+        List all network interfaces attached to the specified instance.
 
         Args:
           extra_headers: Send extra headers
@@ -217,7 +217,7 @@ class InterfacesResource(SyncAPIResource):
 
           security_groups: List of security group IDs
 
-          type: Must be 'any_subnet'
+          type: Must be '`any_subnet`'
 
           extra_headers: Send extra headers
 
@@ -264,7 +264,7 @@ class InterfacesResource(SyncAPIResource):
 
           security_groups: List of security group IDs
 
-          type: Must be 'reserved_fixed_ip'. Union tag
+          type: Must be '`reserved_fixed_ip`'. Union tag
 
           extra_headers: Send extra headers
 
@@ -415,7 +415,7 @@ class AsyncInterfacesResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> NetworkInterfaceList:
         """
-        List network interfaces attached to the instance
+        List all network interfaces attached to the specified instance.
 
         Args:
           extra_headers: Send extra headers
@@ -573,7 +573,7 @@ class AsyncInterfacesResource(AsyncAPIResource):
 
           security_groups: List of security group IDs
 
-          type: Must be 'any_subnet'
+          type: Must be '`any_subnet`'
 
           extra_headers: Send extra headers
 
@@ -620,7 +620,7 @@ class AsyncInterfacesResource(AsyncAPIResource):
 
           security_groups: List of security group IDs
 
-          type: Must be 'reserved_fixed_ip'. Union tag
+          type: Must be '`reserved_fixed_ip`'. Union tag
 
           extra_headers: Send extra headers
 

gcore/resources/cloud/ip_ranges.py

@@ -49,7 +49,23 @@ class IPRangesResource(SyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> IPRanges:
-        """List of all Edge Cloud Egress Public IPs."""
+        """
+        Returns the complete list of IPv4 and IPv6 address ranges that Cloud uses for
+        outbound (egress) traffic. Typical reasons to call this endpoint:
+
+        - Host-file delivery workflows – You upload images or other assets to the Cloud
+          and share a download link that points to your own infrastructure. Add these
+          egress prefixes to your firewall or object-storage allow-list so our clients
+          can fetch the files without being blocked.
+        - Push integrations / webhooks – You subscribe to the user-actions event log and
+          Cloud pushes events to your listener endpoint. Whitelisting the egress IP
+          ranges lets you accept only traffic that originates from us.
+        - General security controls, audit tooling, or SIEM rules that need to verify
+          that traffic truly comes from the Cloud. The list is global (covers all
+          regions) and refreshed automatically whenever Gcore allocates new egress IP
+          space. The response is an array of CIDR blocks; duplicate prefixes are not
+          returned.
+        """
         return self._get(
             "/cloud/public/v1/ipranges/egress",
             options=make_request_options(
@@ -89,7 +105,23 @@ class AsyncIPRangesResource(AsyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> IPRanges:
-        """List of all Edge Cloud Egress Public IPs."""
+        """
+        Returns the complete list of IPv4 and IPv6 address ranges that Cloud uses for
+        outbound (egress) traffic. Typical reasons to call this endpoint:
+
+        - Host-file delivery workflows – You upload images or other assets to the Cloud
+          and share a download link that points to your own infrastructure. Add these
+          egress prefixes to your firewall or object-storage allow-list so our clients
+          can fetch the files without being blocked.
+        - Push integrations / webhooks – You subscribe to the user-actions event log and
+          Cloud pushes events to your listener endpoint. Whitelisting the egress IP
+          ranges lets you accept only traffic that originates from us.
+        - General security controls, audit tooling, or SIEM rules that need to verify
+          that traffic truly comes from the Cloud. The list is global (covers all
+          regions) and refreshed automatically whenever Gcore allocates new egress IP
+          space. The response is an array of CIDR blocks; duplicate prefixes are not
+          returned.
+        """
         return await self._get(
             "/cloud/public/v1/ipranges/egress",
             options=make_request_options(

gcore/resources/cloud/load_balancers/flavors.py

@@ -56,7 +56,7 @@ class FlavorsResource(SyncAPIResource):
     ) -> LoadBalancerFlavorList:
         """Retrieve a list of load balancer flavors.
 
-        When the include_prices query
+        When the `include_prices` query
         parameter is specified, the list shows prices. A client in trial mode gets all
         price values as 0. If you get Pricing Error contact the support
 
@@ -123,7 +123,7 @@ class AsyncFlavorsResource(AsyncAPIResource):
     ) -> LoadBalancerFlavorList:
         """Retrieve a list of load balancer flavors.
 
-        When the include_prices query
+        When the `include_prices` query
         parameter is specified, the list shows prices. A client in trial mode gets all
         price values as 0. If you get Pricing Error contact the support