ark-sdk-python 2.1.7__py3-none-any.whl → 2.2.0__py3-none-any.whl

ark_sdk_python/models/services/access/assets/ark_access_assets_asset.py

@@ -0,0 +1,61 @@
+from typing import Any, Dict, List, Optional
+
+from pydantic import Field
+
+from ark_sdk_python.models.ark_model import ArkCamelizedModel
+
+
+class ArkAccessAssetsAsset(ArkCamelizedModel):
+    # identifiers
+    asset_category: str = Field(description='The category of the asset')
+    asset_type: str = Field(description='The type of the asset')
+    asset_id: str = Field(description='Asset identifier')
+
+    # metadata fields
+    last_accessed: Optional[str] = Field(default=None, description='The date and time when the asset was last accessed (ISO 8601 format)')
+    is_favorite: bool = Field(default=False, description='Is the asset marked as a favorite')
+    link_type: Optional[str] = Field(default=None, description='The link type of the asset')
+    link_uid: Optional[str] = Field(default=None, description='The UID of the base asset this asset is linked to')
+
+    # general connection fields
+    protocol: Optional[str] = Field(default=None, description='The infrastructure asset protocol')
+    access_method: Optional[str] = Field(default=None, description='The access method to the infrastructure asset')
+    address: Optional[str] = Field(default=None, description='The infrastructure asset address/ID')
+    domain: Optional[str] = Field(default=None, description='The infrastructure asset domain')
+    network_name: Optional[str] = Field(default=None, description='The infrastructure asset network name')
+    platform_type: Optional[str] = Field(default=None, description='The infrastructure asset platform type')
+
+    # vaulted fields
+    username: Optional[str] = Field(default=None, description='The infrastructure asset username')
+    platform_id: Optional[str] = Field(default=None, description='The infrastructure asset platform identifier')
+    platform_subtype: Optional[str] = Field(default=None, description='The infrastructure asset platform subtype')
+    workflow_status: Optional[Dict[str, Any]] = Field(default=None, description='The infrastructure asset workflow status')
+    file_categories: Optional[Dict[str, Any]] = Field(default=None, description='The infrastructure asset file categories')
+    jit_elevate_vaulted_cred: Optional[bool] = Field(
+        default=None,
+        description='Indicates whether Just-in-Time (JIT) credential elevation is enabled for this vaulted infrastructure asset',
+    )
+
+    # discovery zsp fields
+    os_type: Optional[str] = Field(default=None, description='The infrastructure asset operating system')
+    protocols: Optional[Dict[str, str]] = Field(
+        default=None, description='The infrastructure asset protocols and their permissions for Discovery ZSP assets'
+    )
+    ips: Optional[List[str]] = Field(default=None, description='The infrastructure asset IPs')
+    workspace_id: Optional[str] = Field(default=None, description='The infrastructure asset workspace identifier')
+    location_type: Optional[str] = Field(default=None, description='The infrastructure asset location')
+
+    # identity fields
+    name: Optional[str] = Field(default=None, description='The Identity asset name')
+    icon: Optional[str] = Field(default=None, description='The Identity asset icon URL')
+    is_sca_enabled: Optional[bool] = Field(
+        default=None, description='Indicates whether SCA (Secure Cloud Access) is enabled for the asset application'
+    )
+    is_sws_enabled: Optional[bool] = Field(
+        default=None, description='Indicates whether SWS (Secure Web Sessions) is enabled for the asset application'
+    )
+    is_launch_disabled: Optional[bool] = Field(default=None, description='Indicates if launch is disabled for the Identity application')
+
+    # Manual ZSP fields
+    selected_token_option: Optional[str] = Field(default=None, description='Selected token option')
+    network_id: Optional[str] = Field(default=None, description='Network ID')

ark_sdk_python/models/services/access/assets/ark_access_assets_assets.py

@@ -0,0 +1,15 @@
+from typing import List
+
+from pydantic import Field
+
+from ark_sdk_python.models.ark_model import ArkCamelizedModel
+from ark_sdk_python.models.services.access.assets.ark_access_assets_asset import ArkAccessAssetsAsset
+
+
+class ArkAccessAssetsAssets(ArkCamelizedModel):
+    assets: List[ArkAccessAssetsAsset] = Field(
+        description='List of the end-user assets.',
+        default_factory=list,
+        validation_alias='targets',
+    )
+    size: int = Field(description='The total number of assets')

ark_sdk_python/models/services/access/assets/ark_access_assets_list_assets.py

@@ -0,0 +1,32 @@
+from typing import Optional
+
+from pydantic import Field
+
+from ark_sdk_python.models.ark_model import ArkModel
+
+
+class ArkAccessAssetsListAssets(ArkModel):
+    recents_only: bool = Field(description='Should return only recently-used assets', default=False)
+    favorites_only: bool = Field(description='Should return only favorite assets', default=False)
+    access_method: Optional[str] = Field(
+        description='Filter infrastructure assets by access method', default=None, examples=['vaulted', 'zsp']
+    )
+    limit: Optional[int] = Field(
+        ge=1,
+        le=1000,
+        default=None,
+        description='This parameter sets the maximum number of the infrastructure items to be retrieved. '
+        'The default value is 1000, the minimum limit is 1, and the maximum limit is 1000',
+    )
+    sort: Optional[str] = Field(
+        description='This parameter sets the sorting order of the retrieved items.'
+        ' The sorting order can be set to ascending or descending. '
+        'The default value is ascending',
+        default=None,
+        examples=['address.asc', 'platformId.desc', 'lastAccessed.desc'],
+    )
+    search: Optional[str] = Field(
+        description='This parameter is used to search for the assets based on specific criteria',
+        default=None,
+        examples=['address contains "1.2.3.4"'],
+    )

ark_sdk_python/models/services/access/assets/ark_access_assets_secret.py

@@ -0,0 +1,15 @@
+from typing import Optional
+
+from pydantic import Field
+from ark_sdk_python.models.ark_model import ArkCamelizedModel, ArkModel
+
+
+class ArkAccessAssetsSecretRequest(ArkModel):
+    asset_id: str = Field(description='Asset identifier', min_length=1)
+    reason: Optional[str] = Field(description='Reason for retrieving the secret', default=None)
+
+
+class ArkAccessAssetsSecretResponse(ArkCamelizedModel):
+    asset_id: str = Field(description='Asset identifier', min_length=1)
+    secret: str = Field(description='Secret value')
+    security_message: Optional[str] = Field(default=None, description='Security guidelines for users handling sensitive information')

ark_sdk_python/models/services/ars/common/__init__.py

@@ -0,0 +1,9 @@
+from ark_sdk_python.models.services.ars.common.ark_ars_filter import ArkARSFilter
+from ark_sdk_python.models.services.ars.common.ark_ars_query import ArkARSPaginationQuery, ArkARSSortDirection, ArkARSSortQuery
+
+__all__ = [
+    'ArkARSPaginationQuery',
+    'ArkARSSortDirection',
+    'ArkARSSortQuery',
+    'ArkARSFilter',
+]

ark_sdk_python/models/services/ars/common/ark_ars_filter.py

@@ -0,0 +1,14 @@
+from typing import Optional
+
+from pydantic import Field
+
+from ark_sdk_python.models import ArkCamelizedModel
+from ark_sdk_python.models.services.ars.common.ark_ars_query import ArkARSPaginationQuery
+
+
+class ArkARSFilter(ArkCamelizedModel):
+    pagination: ArkARSPaginationQuery = Field(
+        default_factory=ArkARSPaginationQuery, description='Pagination details on the response after the filter'
+    )
+    filter: Optional[str] = Field(default=None, description='Filter string to perform on the response items')
+    extended: bool = Field(description='Whether to return an extended response or not', default=False)

ark_sdk_python/models/services/ars/common/ark_ars_query.py

@@ -0,0 +1,22 @@
+from enum import Enum
+from typing import List, Optional, Union
+
+from pydantic import Field
+
+from ark_sdk_python.models import ArkCamelizedModel
+
+
+class ArkARSSortDirection(str, Enum):
+    ASC = 'asc'
+    DESC = 'desc'
+
+
+class ArkARSSortQuery(ArkCamelizedModel):
+    direction: Optional[ArkARSSortDirection] = Field(default=None, description='Direction in which to sort the response')
+    field: Optional[str] = Field(default=None, description='Which field to sort the response on')
+
+
+class ArkARSPaginationQuery(ArkCamelizedModel):
+    offset: Optional[int] = Field(default=None, description='Offset of the items for the response')
+    limit: int = Field(default=1000, description='Limit amount of items for the response')
+    sort: Optional[Union[ArkARSSortQuery, List[ArkARSSortQuery]]] = Field(default=None, description='How to sort the response')

ark_sdk_python/models/services/ars/requests/__init__.py

@@ -0,0 +1,31 @@
+from ark_sdk_python.models.services.ars.requests.ark_ars_access_request import (
+    ArkARSAccessRequest,
+    ArkARSAccessRequestResult,
+    ArkARSAccessRequestState,
+)
+from ark_sdk_python.models.services.ars.requests.ark_ars_access_request_async_task import ArkARSAccessRequestAsyncTask
+from ark_sdk_python.models.services.ars.requests.ark_ars_access_request_form import ArkARSAccessRequestForm, ArkARSAccessRequestForms
+from ark_sdk_python.models.services.ars.requests.ark_ars_access_request_info import ArkARSAccessRequestInfo, ArkARSAccessRequestsInfo
+from ark_sdk_python.models.services.ars.requests.ark_ars_access_requests_stats import ArkARSAccessRequestsStats
+from ark_sdk_python.models.services.ars.requests.ark_ars_cancel_access_request import ArkARSCancelAccessRequest
+from ark_sdk_python.models.services.ars.requests.ark_ars_finalize_access_request import ArkARSFinalizeAccessRequest
+from ark_sdk_python.models.services.ars.requests.ark_ars_get_access_request import ArkARSGetAccessRequest
+from ark_sdk_python.models.services.ars.requests.ark_ars_list_access_request_forms import ArkARSListAccessRequestForms
+from ark_sdk_python.models.services.ars.requests.ark_ars_submit_access_request import ArkARSSubmitAccessRequest
+
+__all__ = [
+    'ArkARSCancelAccessRequest',
+    'ArkARSFinalizeAccessRequest',
+    'ArkARSGetAccessRequest',
+    'ArkARSSubmitAccessRequest',
+    'ArkARSAccessRequestInfo',
+    'ArkARSAccessRequestsInfo',
+    'ArkARSAccessRequestState',
+    'ArkARSAccessRequestResult',
+    'ArkARSAccessRequest',
+    'ArkARSAccessRequestsStats',
+    'ArkARSAccessRequestAsyncTask',
+    'ArkARSAccessRequestForm',
+    'ArkARSAccessRequestForms',
+    'ArkARSListAccessRequestForms',
+]

ark_sdk_python/models/services/ars/requests/ark_ars_access_request.py

@@ -0,0 +1,82 @@
+from datetime import datetime
+from enum import Enum
+from typing import Any, Dict, List, Optional
+
+from humps.main import decamelize
+from pydantic import Field, field_validator, model_validator
+
+from ark_sdk_python.models import ArkCamelizedModel
+from ark_sdk_python.models.services.ars.requests.ark_target_category import ArkTargetCategory
+
+
+class ArkARSAccessRequestState(str, Enum):
+    STARTING = 'STARTING'
+    RUNNING = 'RUNNING'
+    PENDING = 'PENDING'
+    FULFILLING = 'FULFILLING'
+    REVERTING_FULFILLMENT = 'REVERTING_FULFILLMENT'
+    FINISHED = 'FINISHED'
+    EXPIRED = 'EXPIRED'
+
+
+class ArkARSAccessRequestResult(str, Enum):
+    FULFILLED = 'FULFILLED'
+    APPROVED = 'APPROVED'
+    REJECTED = 'REJECTED'
+    CANCELED = 'CANCELED'
+    FAILED = 'FAILED'
+    UNKNOWN = 'UNKNOWN'
+
+
+class ArkARSAccessRequest(ArkCamelizedModel):
+    request_id: str = Field(description='ID of the request')
+    target_category: ArkTargetCategory = Field(description='Target category the request is related to')
+    request_link: Optional[str] = Field(description='Link to the request itself', default=None)
+    request_state: ArkARSAccessRequestState = Field(description='Current request state')
+    request_result: ArkARSAccessRequestResult = Field(description='Result of the request', default=ArkARSAccessRequestResult.UNKNOWN)
+    request_survey_input: Optional[Dict[str, Any]] = Field(
+        description='Survey input given to this request. Deprecated: use request_details instead.', default=None, deprecated=True
+    )
+    request_details: Optional[Dict[str, Any]] = Field(description='Details given to this request', default=None)
+    request_approvers: List[Dict[str, Any]] = Field(
+        description='Related entities who approved or rejected the request', default_factory=list
+    )
+    request_outcomes: Optional[Dict[str, Any]] = Field(description='Outcomes of this request', default_factory=dict)
+    request_steps: Dict[str, Any] = Field(description='Status in regards to the steps in the access request', default_factory=dict)
+    last_executed_step: Optional[str] = Field(description='Last step that was actually executed', default=None)
+    associations: Dict[str, List[Dict[str, Any]]] = Field(description='Entity associations to the request', default_factory=dict)
+    finalization_reason: Optional[str] = Field(description='Reason for canceling or rejecting or approving the request', default=None)
+    requester: Optional[Dict[str, Any]] = Field(description='The requester of the request', default=None)
+    created_by: str = Field(description='Who created the request')
+    created_at: datetime = Field(description='Creation time of the request')
+    updated_by: str = Field(description='Who last updated the request')
+    updated_at: datetime = Field(description='When was the request last updated')
+
+    @staticmethod
+    def _validate_dict_snake_case(v):
+        if v is None:
+            return v
+        if not isinstance(v, dict):
+            raise ValueError('Value must be a dictionary')
+        snake_case_dict = {}
+        for key, value in v.items():
+            if not isinstance(key, str):
+                raise ValueError('All keys must be strings')
+            snake_case_key = decamelize(key)
+            snake_case_dict[snake_case_key] = value
+        return snake_case_dict
+
+    # pylint: disable=no-self-use,no-self-argument
+    @field_validator('request_survey_input', mode='before')
+    def validate_request_survey_input(cls, v):
+        return cls._validate_dict_snake_case(v)
+
+    @field_validator('request_details', mode='before')
+    def validate_request_details(cls, v):
+        return cls._validate_dict_snake_case(v)
+
+    @model_validator(mode='after')
+    def sync_request_fields(self):
+        if self.request_details is None and self.request_survey_input is not None:
+            self.request_details = self.request_survey_input
+        return self

ark_sdk_python/models/services/ars/requests/ark_ars_access_request_async_task.py

@@ -0,0 +1,44 @@
+from typing import List
+
+from overrides import overrides
+from pydantic import Field
+from typing_extensions import Literal
+
+from ark_sdk_python.models.common import ArkStatus
+from ark_sdk_python.models.common.ark_async_task import ArkAsyncTask
+from ark_sdk_python.models.services.ars.requests.ark_ars_access_request import (
+    ArkARSAccessRequest,
+    ArkARSAccessRequestResult,
+    ArkARSAccessRequestState,
+)
+
+
+class ArkARSAccessRequestAsyncTask(ArkAsyncTask):
+    request: ArkARSAccessRequest = Field(description='Request itself')
+    action: Literal['StartRequest', 'UpdateRequest', 'FinalizeRequest', 'CancelRequest'] = Field(description='Action performed')
+    target_statuses: List[ArkStatus] = Field(description='Target status')
+
+    # pylint: disable=no-member
+    @overrides
+    def task_status(self) -> ArkStatus:
+        if self.request.request_state == ArkARSAccessRequestState.FINISHED:
+            if self.request.request_result in (
+                ArkARSAccessRequestResult.APPROVED,
+                ArkARSAccessRequestResult.FULFILLED,
+                ArkARSAccessRequestResult.REJECTED,
+                ArkARSAccessRequestResult.CANCELED,
+            ):
+                return ArkStatus.Success
+            return ArkStatus.Failed
+        if self.request.request_state == ArkARSAccessRequestState.EXPIRED:
+            return ArkStatus.Failed
+        if self.request.request_state == ArkARSAccessRequestState.PENDING:
+            return ArkStatus.Pending
+        if self.request.request_state in (
+            ArkARSAccessRequestState.RUNNING,
+            ArkARSAccessRequestState.FULFILLING,
+            ArkARSAccessRequestState.REVERTING_FULFILLMENT,
+            ArkARSAccessRequestState.STARTING,
+        ):
+            return ArkStatus.InProgress
+        return ArkStatus.Failed

ark_sdk_python/models/services/ars/requests/ark_ars_access_request_form.py

@@ -0,0 +1,67 @@
+from enum import Enum
+from typing import Any, List, Optional, Union
+
+from pydantic import Field
+
+from ark_sdk_python.models import ArkCamelizedModel
+from ark_sdk_python.models.services.ars.requests.ark_ars_request_type import ArkARSRequestType
+from ark_sdk_python.models.services.ars.requests.ark_target_category import ArkTargetCategory
+
+
+class ArkARSQueryValueType(str, Enum):
+    string = 'STRING'
+    text = 'TEXT'
+    choice = 'CHOICE'
+    datetime = 'DATETIME'
+    date = 'DATE'
+    time = 'TIME'
+    timezone = 'TIMEZONE'
+    integer = 'INTEGER'
+    bool = 'BOOL'
+    list = 'LIST'
+    any = 'ANY'
+
+
+class ArkARSQueryBinaryOperator(str, Enum):
+    and_ = 'AND'
+    or_ = 'OR'
+
+
+class ArkARSRegexCondition(ArkCamelizedModel):
+    name: str = Field(default='regex_condition', description='Name of the condition')
+    key: str = Field(description='Key name (id) of the question')
+    condition: str = Field(description='Regex pattern to match the value of the answer')
+
+
+class ArkARSConditionalField(ArkCamelizedModel):
+    operator: ArkARSQueryBinaryOperator = Field(default=ArkARSQueryBinaryOperator.and_, description='Operator to use for the conditions')
+    conditions: List[ArkARSRegexCondition] = Field(description='List of conditions to check')
+
+
+class ArkARSValueValidator(ArkCamelizedModel):
+    name: str = Field(description='Name of the validator')
+
+
+class ArkARSSurveyQuestion(ArkCamelizedModel):
+    key: str = Field(description='Key name / id of the question')
+    required: Union[bool, ArkARSConditionalField] = Field(description='Whether this is a required question or not')
+    default: Optional[Any] = Field(default=None, description='Default value for the question')
+    title: Optional[str] = Field(default=None, description='Title of the question')
+    description: Optional[str] = Field(default=None, description='Description of the question')
+    value_type: Optional[ArkARSQueryValueType] = Field(default=None, description='Type of the response value')
+    value_choices: Optional[List[Any]] = Field(default=None, description='If the value is a choice, what are the possible choices')
+    validators: Optional[List[ArkARSValueValidator]] = Field(default=None, description='Validators for the question')
+
+
+class ArkARSSurvey(ArkCamelizedModel):
+    questions: List[ArkARSSurveyQuestion] = Field(description='Questions required answering on the survey')
+
+
+class ArkARSAccessRequestForm(ArkCamelizedModel):
+    target_category: ArkTargetCategory = Field(description='Target category the request form is related to')
+    request_type: ArkARSRequestType = Field(description='Request type the request form is related to')
+    request_form: ArkARSSurvey = Field(description='Structure of the request form, as the questions to answer when submitting a request')
+
+
+class ArkARSAccessRequestForms(ArkCamelizedModel):
+    request_forms: List[ArkARSAccessRequestForm] = Field(description='Request forms matching the given filters', default_factory=list)

ark_sdk_python/models/services/ars/requests/ark_ars_access_request_info.py

@@ -0,0 +1,23 @@
+from datetime import datetime
+from typing import List, Optional, Union
+
+from pydantic import Field
+
+from ark_sdk_python.models import ArkCamelizedModel
+from ark_sdk_python.models.services.ars.requests.ark_ars_access_request import ArkARSAccessRequest, ArkARSAccessRequestState
+from ark_sdk_python.models.services.ars.requests.ark_target_category import ArkTargetCategory
+
+
+class ArkARSAccessRequestInfo(ArkCamelizedModel):
+    request_id: str = Field(description='ID of the request')
+    target_category: ArkTargetCategory = Field(description='Target category the request is related to')
+    request_link: Optional[str] = Field(description='Link to the request itself', default=None)
+    request_state: ArkARSAccessRequestState = Field(description='Current request state')
+    creation_time: datetime = Field(description='Creation time of the request')
+    last_update_time: datetime = Field(description='When was the request last updated')
+
+
+class ArkARSAccessRequestsInfo(ArkCamelizedModel):
+    items: List[Union[ArkARSAccessRequestInfo, ArkARSAccessRequest]] = Field(description='Amount of items')
+    count: int = Field(description='Count of items returned post filter / pagination')
+    total_count: int = Field(description='Overall items that exists')

ark_sdk_python/models/services/ars/requests/ark_ars_access_requests_stats.py

@@ -0,0 +1,17 @@
+from typing import Dict
+
+from pydantic import Field
+
+from ark_sdk_python.models import ArkCamelizedModel
+from ark_sdk_python.models.services.ars.requests.ark_ars_access_request import (
+    ArkARSAccessRequestResult,
+    ArkARSAccessRequestState,
+    ArkTargetCategory,
+)
+
+
+class ArkARSAccessRequestsStats(ArkCamelizedModel):
+    requests_count: int = Field(description='Overall access requests count')
+    requests_count_by_category: Dict[ArkTargetCategory, int] = Field(description='Access requests count by category')
+    requests_count_by_state: Dict[ArkARSAccessRequestState, int] = Field(description='Access requests count by state')
+    requests_count_by_result: Dict[ArkARSAccessRequestResult, int] = Field(description='Access requests count by result')

ark_sdk_python/models/services/ars/requests/ark_ars_cancel_access_request.py

@@ -0,0 +1,8 @@
+from pydantic import Field
+
+from ark_sdk_python.models import ArkPollableModel
+
+
+class ArkARSCancelAccessRequest(ArkPollableModel):
+    request_id: str = Field(description='The access request id to cancel')
+    cancel_reason: str = Field(description='What is the reason for the cancel')

ark_sdk_python/models/services/ars/requests/ark_ars_finalize_access_request.py

@@ -0,0 +1,20 @@
+from typing import Any, Dict, Optional
+
+from pydantic import Field
+
+from ark_sdk_python.models import ArkPollableModel
+from ark_sdk_python.models.services.ars.requests.ark_ars_access_request import ArkARSAccessRequestResult
+
+
+class ArkARSFinalizeAccessRequest(ArkPollableModel):
+    request_id: str = Field(description='Which request to finalize')
+    result: ArkARSAccessRequestResult = Field(description='The finalized result')
+    request_details: Optional[Dict[str, Any]] = Field(
+        default=None,
+        description='Optionally, the request details related to the request that needs to be updated',
+    )
+    finalization_reason: Optional[str] = Field(default=None, description='If rejected, what is the reason for the rejection')
+    wait_until_finished: bool = Field(
+        description='If polling is enabled, whether to wait for the entire ' 'request to finish, or only until it reaches pending state',
+        default=False,
+    )

ark_sdk_python/models/services/ars/requests/ark_ars_get_access_request.py

@@ -0,0 +1,7 @@
+from pydantic import Field
+
+from ark_sdk_python.models import ArkCamelizedModel
+
+
+class ArkARSGetAccessRequest(ArkCamelizedModel):
+    request_id: str = Field(description='The access request id to get')

ark_sdk_python/models/services/ars/requests/ark_ars_list_access_request_forms.py

@@ -0,0 +1,12 @@
+from pydantic import Field
+
+from ark_sdk_python.models import ArkCamelizedModel
+from ark_sdk_python.models.services.ars.requests.ark_ars_request_type import ArkARSRequestType
+from ark_sdk_python.models.services.ars.requests.ark_target_category import ArkTargetCategory
+
+
+class ArkARSListAccessRequestForms(ArkCamelizedModel):
+    target_category: ArkTargetCategory = Field(description='Target category to list the access request forms for')
+    request_type: ArkARSRequestType = Field(
+        description='Request type to list the access request forms for', default=ArkARSRequestType.ON_DEMAND
+    )

ark_sdk_python/models/services/ars/requests/ark_ars_request_type.py

@@ -0,0 +1,6 @@
+from enum import StrEnum
+
+
+class ArkARSRequestType(StrEnum):
+    DUAL_CONTROL = 'DUAL_CONTROL'
+    ON_DEMAND = 'ON_DEMAND'

ark_sdk_python/models/services/ars/requests/ark_ars_submit_access_request.py

@@ -0,0 +1,18 @@
+from typing import Any, Dict, Optional
+
+from pydantic import Field
+
+from ark_sdk_python.models import ArkPollableModel
+from ark_sdk_python.models.services.ars.requests.ark_ars_request_type import ArkARSRequestType
+from ark_sdk_python.models.services.ars.requests.ark_target_category import ArkTargetCategory
+
+
+class ArkARSSubmitAccessRequest(ArkPollableModel):
+    target_category: ArkTargetCategory = Field(description='What is the category that is required to execute')
+    request_type: ArkARSRequestType = Field(description='The type of request to start', default=ArkARSRequestType.ON_DEMAND)
+    request_details: Dict[str, Any] = Field(description='The details related to the workload', default=None)
+    association: Optional[Dict[str, Any]] = Field(description='Optionally an associated policy', default=None)
+    wait_until_finished: bool = Field(
+        description='If polling is enabled, whether to wait for the entire request to finish, or only until it reaches pending state',
+        default=False,
+    )

ark_sdk_python/models/services/ars/requests/ark_target_category.py

@@ -0,0 +1,32 @@
+from enum import Enum
+from typing import Annotated, Any, Final, FrozenSet
+
+from packaging.version import Version
+from pydantic import PlainSerializer, PlainValidator
+from pydantic.version import VERSION
+
+from ark_sdk_python.models.common import ArkCategoryType
+
+ARS_SUPPORTED_CATEGORIES: Final[FrozenSet[ArkCategoryType]] = frozenset({ArkCategoryType.CLOUD_CONSOLE, ArkCategoryType.VM})
+
+
+def _validate_target_category(value: Any) -> ArkCategoryType:
+    category = ArkCategoryType.__members__.get(str(value).replace(' ', '_').upper())
+    if category not in ARS_SUPPORTED_CATEGORIES:
+        raise ValueError(f'Unsupported target category [{value}], supported categories are {[c.name for c in ARS_SUPPORTED_CATEGORIES]}')
+    return category
+
+
+# Versions under 2.9 do not support json_schema_input_type
+if Version(VERSION) < Version("2.9"):
+
+    class ArkTargetCategory(str, Enum):
+        CLOUD_CONSOLE = 'CLOUD_CONSOLE'
+        VM = 'VM'
+
+else:
+    ArkTargetCategory = Annotated[
+        ArkCategoryType,
+        PlainValidator(_validate_target_category, json_schema_input_type=str),
+        PlainSerializer(lambda v: v.name),
+    ]