devopness 2.4.0__tar.gz → 2.4.1__tar.gz

{devopness-2.4.0 → devopness-2.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: devopness
-Version: 2.4.0
+Version: 2.4.1
 Summary: Devopness API Python SDK - Painless essential DevOps to everyone
 License-Expression: MIT
 Keywords: API Client,Cloud Engineering,Cloud Infrastructure,Cloud Platform,Cloud Resource Management,Configuration Management,Deployment Automation,Devopness,DevOps,Infrastructure as Code,Platform Engineering,Python SDK,Server Management,Server Provisioning,Zero Downtime Deployment

{devopness-2.4.0 → devopness-2.4.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [project]
 name = "devopness"
-version = "2.4.0"
+version = "2.4.1"
 description = "Devopness API Python SDK - Painless essential DevOps to everyone"
 license = "MIT"
 readme = "README.md"
@@ -68,7 +68,7 @@ exclude = ["src/devopness/generated/.openapi-generator-ignore"]
 
 [tool.poetry.group.dev.dependencies]
 openapi-generator-cli = { version = "7.22.0", markers = "python_version < '4.0'" }
-ruff = "^0.15.12"
+ruff = "^0.15.13"
 mypy = "2.1.0"
 
 [tool.ruff]

{devopness-2.4.0 → devopness-2.4.1}/src/devopness/generated/api/credentials_api.py

@@ -97,6 +97,7 @@ class CredentialsApiService(DevopnessBaseService):
         self,
         environment_id: int,
         provider_code: str,
+        state: str | None = None,
     ) -> DevopnessResponse[CredentialSetting]:
         """
         Return provider settings
@@ -106,8 +107,15 @@ class CredentialsApiService(DevopnessBaseService):
             DevopnessNetworkError: If a network error occurs.
         """
 
+        query_string = parse_query_string(
+            {
+                "state": state,
+            }
+        )
+
         endpoint_parts = [
             f"/environments/{environment_id}/credentials/{provider_code}/settings",
+            f"?{query_string}",
         ]
 
         endpoint: str = "".join(endpoint_parts)
@@ -119,6 +127,7 @@ class CredentialsApiService(DevopnessBaseService):
         self,
         organization_id: str,
         provider_code: str,
+        state: str | None = None,
     ) -> DevopnessResponse[CredentialSetting]:
         """
         Return provider settings
@@ -128,8 +137,15 @@ class CredentialsApiService(DevopnessBaseService):
             DevopnessNetworkError: If a network error occurs.
         """
 
+        query_string = parse_query_string(
+            {
+                "state": state,
+            }
+        )
+
         endpoint_parts = [
             f"/organizations/{organization_id}/credentials/{provider_code}/settings",
+            f"?{query_string}",
         ]
 
         endpoint: str = "".join(endpoint_parts)
@@ -374,6 +390,7 @@ class CredentialsApiServiceAsync(DevopnessBaseServiceAsync):
         self,
         environment_id: int,
         provider_code: str,
+        state: str | None = None,
     ) -> DevopnessResponse[CredentialSetting]:
         """
         Return provider settings
@@ -383,8 +400,15 @@ class CredentialsApiServiceAsync(DevopnessBaseServiceAsync):
             DevopnessNetworkError: If a network error occurs.
         """
 
+        query_string = parse_query_string(
+            {
+                "state": state,
+            }
+        )
+
         endpoint_parts = [
             f"/environments/{environment_id}/credentials/{provider_code}/settings",
+            f"?{query_string}",
         ]
 
         endpoint: str = "".join(endpoint_parts)
@@ -396,6 +420,7 @@ class CredentialsApiServiceAsync(DevopnessBaseServiceAsync):
         self,
         organization_id: str,
         provider_code: str,
+        state: str | None = None,
     ) -> DevopnessResponse[CredentialSetting]:
         """
         Return provider settings
@@ -405,8 +430,15 @@ class CredentialsApiServiceAsync(DevopnessBaseServiceAsync):
             DevopnessNetworkError: If a network error occurs.
         """
 
+        query_string = parse_query_string(
+            {
+                "state": state,
+            }
+        )
+
         endpoint_parts = [
             f"/organizations/{organization_id}/credentials/{provider_code}/settings",
+            f"?{query_string}",
         ]
 
         endpoint: str = "".join(endpoint_parts)

{devopness-2.4.0 → devopness-2.4.1}/src/devopness/generated/models/__init__.py

@@ -128,6 +128,7 @@ from .cloud_provider_service_resource_type_scope import (
     CloudProviderServiceResourceTypeScope,
     CloudProviderServiceResourceTypeScopePlain,
 )
+from .cloud_provider_settings import CloudProviderSettings, CloudProviderSettingsPlain
 from .cloud_provider_settings_list import (
     CloudProviderSettingsList,
     CloudProviderSettingsListPlain,
@@ -399,6 +400,11 @@ from .project_organization_create import (
 )
 from .project_relation import ProjectRelation, ProjectRelationPlain
 from .project_update import ProjectUpdate, ProjectUpdatePlain
+from .provider_auth_type import ProviderAuthType, ProviderAuthTypePlain
+from .provider_callback_config import (
+    ProviderCallbackConfig,
+    ProviderCallbackConfigPlain,
+)
 from .provider_code import ProviderCode, ProviderCodePlain
 from .provider_input_settings import ProviderInputSettings, ProviderInputSettingsPlain
 from .provider_input_settings_validation import (
@@ -484,11 +490,19 @@ from .social_account_displayable_name import (
 from .social_account_provider import SocialAccountProvider, SocialAccountProviderPlain
 from .social_account_relation import SocialAccountRelation, SocialAccountRelationPlain
 from .social_account_status import SocialAccountStatus, SocialAccountStatusPlain
+from .source_provider_auth_method_settings import (
+    SourceProviderAuthMethodSettings,
+    SourceProviderAuthMethodSettingsPlain,
+)
 from .source_provider_displayable_name import (
     SourceProviderDisplayableName,
     SourceProviderDisplayableNamePlain,
 )
 from .source_provider_name import SourceProviderName, SourceProviderNamePlain
+from .source_provider_settings import (
+    SourceProviderSettings,
+    SourceProviderSettingsPlain,
+)
 from .source_type import SourceType, SourceTypePlain
 from .ssh_key import SshKey, SshKeyPlain
 from .ssh_key_deploy import SshKeyDeploy, SshKeyDeployPlain
@@ -780,8 +794,10 @@ __all__ = [
     "CloudProviderServiceResourceTypePlain",
     "CloudProviderServiceResourceTypeScope",
     "CloudProviderServiceResourceTypeScopePlain",
+    "CloudProviderSettings",
     "CloudProviderSettingsList",
     "CloudProviderSettingsListPlain",
+    "CloudProviderSettingsPlain",
     "CloudResourceType",
     "CloudResourceTypePlain",
     "CloudServiceSettingsAwsEc2",
@@ -1052,6 +1068,10 @@ __all__ = [
     "ProjectRelationPlain",
     "ProjectUpdate",
     "ProjectUpdatePlain",
+    "ProviderAuthType",
+    "ProviderAuthTypePlain",
+    "ProviderCallbackConfig",
+    "ProviderCallbackConfigPlain",
     "ProviderCode",
     "ProviderCodePlain",
     "ProviderInputSettings",
@@ -1174,10 +1194,14 @@ __all__ = [
     "SocialAccountRelationPlain",
     "SocialAccountStatus",
     "SocialAccountStatusPlain",
+    "SourceProviderAuthMethodSettings",
+    "SourceProviderAuthMethodSettingsPlain",
     "SourceProviderDisplayableName",
     "SourceProviderDisplayableNamePlain",
     "SourceProviderName",
     "SourceProviderNamePlain",
+    "SourceProviderSettings",
+    "SourceProviderSettingsPlain",
     "SourceType",
     "SourceTypePlain",
     "SshKey",

devopness-2.4.0/src/devopness/generated/models/provider_settings.py → devopness-2.4.1/src/devopness/generated/models/cloud_provider_settings.py

@@ -12,39 +12,33 @@ from typing import (
     Union,
 )
 
-from pydantic import Field, StrictStr
+from pydantic import Field
 
 from .. import DevopnessBaseModel
 from .cloud_provider_service import CloudProviderService, CloudProviderServicePlain
 from .provider_input_settings import ProviderInputSettings, ProviderInputSettingsPlain
 
 
-class ProviderSettings(DevopnessBaseModel):
+class CloudProviderSettings(DevopnessBaseModel):
     """
-    ProviderSettings
+    CloudProviderSettings
 
     Attributes:
-        connect_url (str, optional): The URL used to connect Devopness to a credential provider of type `source_provider`
         input_settings (List[ProviderInputSettings]): The list of input settings for credentials of specific provider
-        cloud_services (List[CloudProviderService], optional):
+        cloud_services (List[CloudProviderService]):
     """
 
-    connect_url: StrictStr | None = Field(
-        default=None,
-        description="The URL used to connect Devopness to a credential provider of type `source_provider`",
-    )
     input_settings: list[ProviderInputSettings] = Field(
         description="The list of input settings for credentials of specific provider"
     )
-    cloud_services: list[CloudProviderService] | None = None
+    cloud_services: list[CloudProviderService]
 
 
-class ProviderSettingsPlain(TypedDict, total=False):
+class CloudProviderSettingsPlain(TypedDict, total=False):
     """
-    Plain version of ProviderSettings.
+    Plain version of CloudProviderSettings.
     """
 
-    connect_url: str | None
     input_settings: Required[
         list[
             Union[
@@ -53,4 +47,11 @@ class ProviderSettingsPlain(TypedDict, total=False):
             ]
         ]
     ]
-    cloud_services: list[Union[CloudProviderService, CloudProviderServicePlain]] | None
+    cloud_services: Required[
+        list[
+            Union[
+                CloudProviderService,
+                CloudProviderServicePlain,
+            ]
+        ]
+    ]

{devopness-2.4.0 → devopness-2.4.1}/src/devopness/generated/models/credential.py

@@ -31,6 +31,8 @@ class Credential(DevopnessBaseModel):
         provider (ProviderRelation):
         provider_type (str): The type of the credential
         provider_type_human_readable (str): The human readable version of the type of the credential
+        provider_auth_type (str): The authentication type of the credential
+        provider_auth_type_human_readable (str): The human readable version of the authentication type
         active (bool): If this credential is active or not
         organization (OrganizationRelation, optional, nullable):
         created_by_user (UserRelation, optional, nullable):
@@ -46,6 +48,12 @@ class Credential(DevopnessBaseModel):
     provider_type_human_readable: StrictStr = Field(
         description="The human readable version of the type of the credential"
     )
+    provider_auth_type: StrictStr = Field(
+        description="The authentication type of the credential"
+    )
+    provider_auth_type_human_readable: StrictStr = Field(
+        description="The human readable version of the authentication type"
+    )
     active: StrictBool = Field(description="If this credential is active or not")
     organization: OrganizationRelation | None = None
     created_by_user: UserRelation | None
@@ -73,6 +81,8 @@ class CredentialPlain(TypedDict, total=False):
     ]
     provider_type: Required[str]
     provider_type_human_readable: Required[str]
+    provider_auth_type: Required[str]
+    provider_auth_type_human_readable: Required[str]
     active: Required[bool]
     organization: Union[OrganizationRelation, OrganizationRelationPlain] | None
     created_by_user: Union[UserRelation, UserRelationPlain] | None

{devopness-2.4.0 → devopness-2.4.1}/src/devopness/generated/models/credential_relation.py

@@ -31,6 +31,8 @@ class CredentialRelation(DevopnessBaseModel):
         provider (ProviderRelation):
         provider_type (ProviderType):
         provider_type_human_readable (str): The human readable version of the type of the credential
+        provider_auth_type (str): The authentication type of the credential
+        provider_auth_type_human_readable (str): The human readable version of the authentication type
         active (bool): If this credential is active or not
         created_by_user (UserRelation, optional, nullable):
         last_action (ActionRelationShallow, optional, nullable):
@@ -45,6 +47,12 @@ class CredentialRelation(DevopnessBaseModel):
     provider_type_human_readable: StrictStr = Field(
         description="The human readable version of the type of the credential"
     )
+    provider_auth_type: StrictStr = Field(
+        description="The authentication type of the credential"
+    )
+    provider_auth_type_human_readable: StrictStr = Field(
+        description="The human readable version of the authentication type"
+    )
     active: StrictBool = Field(description="If this credential is active or not")
     created_by_user: UserRelation | None
     last_action: ActionRelationShallow | None = None
@@ -76,6 +84,8 @@ class CredentialRelationPlain(TypedDict, total=False):
         ]
     ]
     provider_type_human_readable: Required[str]
+    provider_auth_type: Required[str]
+    provider_auth_type_human_readable: Required[str]
     active: Required[bool]
     created_by_user: Union[UserRelation, UserRelationPlain] | None
     last_action: Union[ActionRelationShallow, ActionRelationShallowPlain] | None

devopness-2.4.1/src/devopness/generated/models/credential_source_provider.py

@@ -0,0 +1,60 @@
+"""
+Devopness API Python SDK - Painless essential DevOps to everyone
+
+Note:
+    This is auto generated by OpenAPI Generator.
+    https://openapi-generator.tech
+"""
+
+from typing import (
+    Required,
+    TypedDict,
+    Union,
+)
+
+from pydantic import Field, StrictStr
+
+from .. import DevopnessBaseModel
+from .provider_auth_type import ProviderAuthType, ProviderAuthTypePlain
+
+
+class CredentialSourceProvider(DevopnessBaseModel):
+    """
+    CredentialSourceProvider
+
+    Attributes:
+        auth_type (ProviderAuthType):
+        callback_code (str, optional): The temporary code forwarded by the OAuth provider as a parameter to our callback URL
+        installation_id (str, optional): The installation ID of the source provider integration installation.
+        setup_action (str, optional): The action to be performed with the provided callback code.
+    """
+
+    auth_type: ProviderAuthType
+    callback_code: StrictStr | None = Field(
+        default=None,
+        description="The temporary code forwarded by the OAuth provider as a parameter to our callback URL",
+    )
+    installation_id: StrictStr | None = Field(
+        default=None,
+        description="The installation ID of the source provider integration installation.",
+    )
+    setup_action: StrictStr | None = Field(
+        default=None,
+        description="The action to be performed with the provided callback code.",
+    )
+
+
+class CredentialSourceProviderPlain(TypedDict, total=False):
+    """
+    Plain version of CredentialSourceProvider.
+    """
+
+    auth_type: Required[
+        Union[
+            ProviderAuthType,
+            ProviderAuthTypePlain,
+        ]
+    ]
+    callback_code: str | None
+    installation_id: str | None
+    setup_action: str | None

devopness-2.4.1/src/devopness/generated/models/provider_auth_type.py

@@ -0,0 +1,38 @@
+"""
+Devopness API Python SDK - Painless essential DevOps to everyone
+
+Note:
+    This is auto generated by OpenAPI Generator.
+    https://openapi-generator.tech
+"""
+
+import json
+from enum import Enum
+from typing import Literal, Self
+
+
+class ProviderAuthType(str, Enum):
+    """
+    Authentication method for provider credentials.
+    """
+
+    OAUTH = "oauth"
+    APPLICATION = "application"
+    API_CREDENTIALS = "api_credentials"
+
+    def __str__(self) -> str:
+        """Return the string representation of the ProviderAuthType"""
+        return self.value
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ProviderAuthType from a JSON string"""
+        return cls(json.loads(json_str))
+
+
+# The plain version of ProviderAuthType
+ProviderAuthTypePlain = Literal[
+    "oauth",
+    "application",
+    "api_credentials",
+]

devopness-2.4.1/src/devopness/generated/models/provider_callback_config.py

@@ -0,0 +1,51 @@
+"""
+Devopness API Python SDK - Painless essential DevOps to everyone
+
+Note:
+    This is auto generated by OpenAPI Generator.
+    https://openapi-generator.tech
+"""
+
+from typing import (
+    Required,
+    TypedDict,
+)
+
+from pydantic import Field, StrictBool, StrictStr
+
+from .. import DevopnessBaseModel
+
+
+class ProviderCallbackConfig(DevopnessBaseModel):
+    """
+    ProviderCallbackConfig
+
+    Attributes:
+        field (str): The credential field name that this parameter maps to
+        query_string (str): The query parameter name in the callback URL
+        required (bool): Whether this parameter is required in the callback
+        type (str): The expected data type of the parameter value
+    """
+
+    var_field: StrictStr = Field(
+        description="The credential field name that this parameter maps to",
+        alias="field",
+    )
+    query_string: StrictStr = Field(
+        description="The query parameter name in the callback URL"
+    )
+    required: StrictBool = Field(
+        description="Whether this parameter is required in the callback"
+    )
+    type: StrictStr = Field(description="The expected data type of the parameter value")
+
+
+class ProviderCallbackConfigPlain(TypedDict, total=False):
+    """
+    Plain version of ProviderCallbackConfig.
+    """
+
+    field: Required[str]
+    query_string: Required[str]
+    required: Required[bool]
+    type: Required[str]

{devopness-2.4.0 → devopness-2.4.1}/src/devopness/generated/models/provider_input_settings_validation.py

@@ -10,7 +10,7 @@ from typing import (
     TypedDict,
 )
 
-from pydantic import StrictBool, StrictInt, StrictStr
+from pydantic import Field, StrictBool, StrictInt, StrictStr
 
 from .. import DevopnessBaseModel
 
@@ -25,6 +25,7 @@ class ProviderInputSettingsValidation(DevopnessBaseModel):
         min (int, optional):
         max (int, optional):
         allowed_values (List[str], optional):
+        hidden (bool, optional): If true, this field should not be shown to the user (system-provided, like OAuth callback_code)
     """
 
     required: StrictBool | None = None
@@ -32,6 +33,10 @@ class ProviderInputSettingsValidation(DevopnessBaseModel):
     min: StrictInt | None = None
     max: StrictInt | None = None
     allowed_values: list[StrictStr] | None = None
+    hidden: StrictBool | None = Field(
+        default=None,
+        description="If true, this field should not be shown to the user (system-provided, like OAuth callback_code)",
+    )
 
 
 class ProviderInputSettingsValidationPlain(TypedDict, total=False):
@@ -44,3 +49,4 @@ class ProviderInputSettingsValidationPlain(TypedDict, total=False):
     min: int | None
     max: int | None
     allowed_values: list[str] | None
+    hidden: bool | None

devopness-2.4.1/src/devopness/generated/models/provider_settings.py

@@ -0,0 +1,28 @@
+"""
+Devopness API Python SDK - Painless essential DevOps to everyone
+
+Note:
+    This is auto generated by OpenAPI Generator.
+    https://openapi-generator.tech
+"""
+
+from typing import Union
+
+from .cloud_provider_settings import CloudProviderSettings, CloudProviderSettingsPlain
+from .source_provider_settings import (
+    SourceProviderSettings,
+    SourceProviderSettingsPlain,
+)
+
+#: OneOf Type
+#: Settings related to a supported provider
+ProviderSettings = Union[
+    CloudProviderSettings,
+    SourceProviderSettings,
+]
+
+#: The plain version of ProviderSettings
+ProviderSettingsPlain = Union[
+    CloudProviderSettingsPlain,
+    SourceProviderSettingsPlain,
+]

devopness-2.4.1/src/devopness/generated/models/source_provider_auth_method_settings.py

@@ -0,0 +1,83 @@
+"""
+Devopness API Python SDK - Painless essential DevOps to everyone
+
+Note:
+    This is auto generated by OpenAPI Generator.
+    https://openapi-generator.tech
+"""
+
+from typing import (
+    Required,
+    TypedDict,
+    Union,
+)
+
+from pydantic import Field, StrictBool, StrictStr
+
+from .. import DevopnessBaseModel
+from .provider_callback_config import (
+    ProviderCallbackConfig,
+    ProviderCallbackConfigPlain,
+)
+from .provider_input_settings import ProviderInputSettings, ProviderInputSettingsPlain
+
+
+class SourceProviderAuthMethodSettings(DevopnessBaseModel):
+    """
+    SourceProviderAuthMethodSettings
+
+    Attributes:
+        auth_type (str): The authentication type identifier
+        auth_type_human_readable (str, optional): Human-readable name for the authentication method
+        hint (str, optional): Hint text explaining the authentication flow
+        recommended (bool, optional): Whether this authentication method is recommended for this provider
+        connect_url (str, optional): The URL to redirect the user for authentication. For OAuth methods, this is the authorization URL. For application installation methods (e.g., GitHub App), this is the installation URL.
+        input_settings (List[ProviderInputSettings]): The list of input settings for credentials of specific provider
+        provider_config (List[ProviderCallbackConfig], optional): Configuration mapping for extracting authentication parameters from OAuth/provider callback URLs.
+    """
+
+    auth_type: StrictStr = Field(description="The authentication type identifier")
+    auth_type_human_readable: StrictStr | None = Field(
+        default=None, description="Human-readable name for the authentication method"
+    )
+    hint: StrictStr | None = Field(
+        default=None, description="Hint text explaining the authentication flow"
+    )
+    recommended: StrictBool | None = Field(
+        default=None,
+        description="Whether this authentication method is recommended for this provider",
+    )
+    connect_url: StrictStr | None = Field(
+        default=None,
+        description="The URL to redirect the user for authentication. For OAuth methods, this is the authorization URL. For application installation methods (e.g., GitHub App), this is the installation URL.",
+    )
+    input_settings: list[ProviderInputSettings] = Field(
+        description="The list of input settings for credentials of specific provider"
+    )
+    provider_config: list[ProviderCallbackConfig] | None = Field(
+        default=None,
+        description="Configuration mapping for extracting authentication parameters from OAuth/provider callback URLs.",
+    )
+
+
+class SourceProviderAuthMethodSettingsPlain(TypedDict, total=False):
+    """
+    Plain version of SourceProviderAuthMethodSettings.
+    """
+
+    auth_type: Required[str]
+    auth_type_human_readable: str | None
+    hint: str | None
+    recommended: bool | None
+    connect_url: str | None
+    input_settings: Required[
+        list[
+            Union[
+                ProviderInputSettings,
+                ProviderInputSettingsPlain,
+            ]
+        ]
+    ]
+    provider_config: (
+        list[Union[ProviderCallbackConfig, ProviderCallbackConfigPlain]] | None
+    )

devopness-2.4.1/src/devopness/generated/models/source_provider_settings.py

@@ -0,0 +1,49 @@
+"""
+Devopness API Python SDK - Painless essential DevOps to everyone
+
+Note:
+    This is auto generated by OpenAPI Generator.
+    https://openapi-generator.tech
+"""
+
+from typing import (
+    Required,
+    TypedDict,
+    Union,
+)
+
+from pydantic import Field
+
+from .. import DevopnessBaseModel
+from .source_provider_auth_method_settings import (
+    SourceProviderAuthMethodSettings,
+    SourceProviderAuthMethodSettingsPlain,
+)
+
+
+class SourceProviderSettings(DevopnessBaseModel):
+    """
+    SourceProviderSettings
+
+    Attributes:
+        auth_methods (List[SourceProviderAuthMethodSettings]): Available authentication methods for this source provider
+    """
+
+    auth_methods: list[SourceProviderAuthMethodSettings] = Field(
+        description="Available authentication methods for this source provider"
+    )
+
+
+class SourceProviderSettingsPlain(TypedDict, total=False):
+    """
+    Plain version of SourceProviderSettings.
+    """
+
+    auth_methods: Required[
+        list[
+            Union[
+                SourceProviderAuthMethodSettings,
+                SourceProviderAuthMethodSettingsPlain,
+            ]
+        ]
+    ]