anaplan-sdk 0.5.0a5__py3-none-any.whl → 0.5.1__py3-none-any.whl

anaplan_sdk/models/scim.py

@@ -0,0 +1,282 @@
+from typing import Any, Literal
+
+from pydantic import Field
+from typing_extensions import Self
+
+from anaplan_sdk.models import AnaplanModel
+
+AnaplanFilterFields = Literal[
+    "id", "externalId", "userName", "name.familyName", "name.givenName", "active"
+]
+
+
+class _FilterExpression:
+    def __init__(self, _field: AnaplanFilterFields) -> None:
+        self._field: AnaplanFilterFields = _field
+        self._exprs: list[str] = []
+        self._operators = []
+
+    def __str__(self) -> str:
+        if not self._exprs:
+            return "active eq true" if self._field == "active" else f"{self._field} pr"
+        parts = []
+        for i, expr in enumerate(self._exprs):
+            if i > 0:
+                parts.append(self._operators[i - 1])
+            parts.append(expr)
+        return " ".join(parts)
+
+    def __invert__(self) -> Self:
+        self._exprs.append(
+            "active eq false" if self._field == "active" else f"{self._field} eq null"
+        )
+        return self
+
+    def __and__(self, other: Self) -> Self:
+        return self._combine(other, "and")
+
+    def __or__(self, other: Self) -> Self:
+        return self._combine(other, "or")
+
+    def _combine(self, other: Self, operator: Literal["and", "or"]) -> Self:
+        if self._requires_grouping(operator):
+            self._exprs = [f"({str(self)})"]
+            self._operators = []
+        self._operators.append(operator)
+        if not self._exprs:
+            self._exprs.append(str(self))
+        self._exprs.append(f"({str(other)})" if other._requires_grouping(operator) else str(other))
+        return self
+
+    def _requires_grouping(self, operator: Literal["and", "or"]) -> bool:
+        return len(self._operators) > 0 and ("or" in self._operators or operator == "or")
+
+    def __eq__(self, other: Any) -> Self:
+        self._exprs.append(f'{self._field} eq "{other}"')
+        return self
+
+    def __ne__(self, other: Any) -> Self:
+        self._exprs.append(f'{self._field} ne "{other}"')
+        return self
+
+    def __gt__(self, other: Any) -> Self:
+        self._exprs.append(f'{self._field} gt "{other}"')
+        return self
+
+    def __ge__(self, other: Any) -> Self:
+        self._exprs.append(f'{self._field} ge "{other}"')
+        return self
+
+    def __lt__(self, other: Any) -> Self:
+        self._exprs.append(f'{self._field} lt "{other}"')
+        return self
+
+    def __le__(self, other: Any) -> Self:
+        self._exprs.append(f'{self._field} le "{other}"')
+        return self
+
+
+field = _FilterExpression
+
+
+class NameInput(AnaplanModel):
+    family_name: str = Field(
+        description="The family name of the User, or last name in most Western languages"
+    )
+    given_name: str = Field(
+        description="The given name of the User, or first name in most Western languages"
+    )
+
+
+class Name(NameInput):
+    formatted: str = Field(
+        description=(
+            "The formatted full name, including given name and family name. Anaplan does as of now "
+            "not have other standard SCIM fields such as middle name or honorific pre- or suffixes."
+        )
+    )
+
+
+class Email(AnaplanModel):
+    value: str = Field(description="Email address of the User")
+    type: Literal["work", "home", "other"] = Field(
+        default=None, description="A label indicating the emails's function, e.g., 'work' or 'home'"
+    )
+    primary: bool | None = Field(
+        default=None, description="Indicates if this is the primary or 'preferred' email"
+    )
+
+
+class EntitlementInput(AnaplanModel):
+    value: str = Field(description="The value of an entitlement.")
+    type: Literal["WORKSPACE", "WORKSPACE_IDS", "WORKSPACE_NAMES"] = Field(
+        description="A label indicating the attribute's function."
+    )
+
+
+class Entitlement(EntitlementInput):
+    display: str | None = Field(
+        default=None, description="A human-readable name, primarily used for display purposes."
+    )
+    primary: bool | None = Field(
+        default=None,
+        description="Indicating the 'primary' or preferred attribute value for this attribute.",
+    )
+
+
+class _BaseUser(AnaplanModel):
+    schemas: list[str] = Field(default=["urn:ietf:params:scim:schemas:core:2.0:User"])
+    user_name: str = Field(description="Unique name for the User.")
+
+
+class User(_BaseUser):
+    id: str = Field(description="The unique identifier for the User.")
+    name: Name = Field(description="The user's real name.")
+    active: bool = Field(description="Indicating the User's active status.")
+    emails: list[Email] = Field(default=[], description="Email addresses for the user.")
+    display_name: str = Field(description="Display Name for the User.")
+    entitlements: list[Entitlement] = Field(
+        default=[], description="A list of entitlements (Workspaces) the User has."
+    )
+
+
+class ReplaceUserInput(_BaseUser):
+    id: str = Field(description="The unique identifier for the User.")
+    name: NameInput = Field(description="The user's real name.")
+    active: bool | None = Field(default=None, description="Indicating the User's active status.")
+    display_name: str | None = Field(default=None, description="Display Name for the User.")
+    entitlements: list[EntitlementInput] | None = Field(
+        default=None, description="A list of entitlements (Workspaces) the User has."
+    )
+
+
+class UserInput(_BaseUser):
+    external_id: str = Field(
+        description="Your unique id for this user (as stored in your company systems)."
+    )
+    name: NameInput = Field(description="The user's real name.")
+
+
+class Meta(AnaplanModel):
+    resource_type: str = Field(description="The type of the resource.")
+    location: str = Field(description="The URI of the resource.")
+
+
+class MetaWithDates(Meta):
+    created: str = Field(description="The timestamp when the resource was created.")
+    last_modified: str = Field(description="The timestamp when the resource was last modified.")
+
+
+class Supported(AnaplanModel):
+    supported: bool = Field(description="Indicates whether the Feature is supported.")
+
+
+class BulkConfig(Supported):
+    max_operations: int = Field(
+        description="The maximum number of operations permitted in a single request."
+    )
+    max_payload_size: int = Field(description="The maximum payload size in bytes.")
+
+
+class FilterConfig(Supported):
+    max_results: int = Field(
+        description="The maximum number of results returned from a filtered query."
+    )
+
+
+class AuthenticationScheme(AnaplanModel):
+    name: str = Field(description="The name of the authentication scheme.")
+    type: str = Field(description="The type of the authentication scheme.")
+    description: str = Field(description="A description of the authentication scheme.")
+    spec_uri: str = Field(
+        description="The URI that points to the specification of the authentication scheme."
+    )
+    documentation_uri: str = Field(
+        description="The URI that points to the documentation of the authentication scheme."
+    )
+
+
+class ServiceProviderConfig(AnaplanModel):
+    schemas: list[str] = Field(
+        default=["urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"],
+        description="Schemas for this resource.",
+    )
+    meta: MetaWithDates = Field(description="Metadata about the resource.")
+    documentation_uri: str = Field(description="URI of the service provider's documentation.")
+    patch: Supported = Field(description="Configuration for PATCH operations.")
+    bulk: BulkConfig = Field(description="Configuration for bulk operations.")
+    filter: FilterConfig = Field(description="Configuration for filtering.")
+    change_password: Supported = Field(description="Configuration for password changes.")
+    sort: Supported = Field(description="Configuration for sorting.")
+    etag: Supported = Field(description="Configuration for ETags.")
+    authentication_schemes: list[AuthenticationScheme] = Field(
+        description="List of supported authentication schemes."
+    )
+
+
+class Resource(AnaplanModel):
+    schemas: list[str] = Field(
+        default=["urn:ietf:params:scim:schemas:core:2.0:ResourceType"],
+        description="Schemas for this resource.",
+    )
+    meta: Meta = Field(description="Metadata about the resource.")
+    id: str = Field(description="The identifier of the resource type.")
+    name: str = Field(description="The name of the resource type.")
+    endpoint: str = Field(description="The endpoint where resources of this type may be accessed.")
+    description: str = Field(description="A description of the resource type.")
+
+
+class Attribute(AnaplanModel):
+    name: str = Field(description="The name of the attribute.")
+    type: str = Field(description="The data type of the attribute.")
+    multi_valued: bool = Field(description="Indicates if the attribute can have multiple values.")
+    description: str = Field(description="A human-readable description of the attribute.")
+    required: bool = Field(description="Indicates if the attribute is required.")
+    case_exact: bool = Field(
+        description="Indicates if case sensitivity should be considered when comparing values."
+    )
+    mutability: str = Field(description="Indicates if and how the attribute can be modified.")
+    returned: str = Field(
+        description="Indicates when the attribute's values are returned in a response."
+    )
+    uniqueness: str = Field(
+        description="Indicates how uniqueness is enforced on the attribute value."
+    )
+    sub_attributes: list["Attribute"] | None = Field(
+        default=None, description="A list of sub-attributes if the attribute is complex."
+    )
+
+
+class Schema(AnaplanModel):
+    meta: Meta = Field(description="Metadata about the schema resource.")
+    id: str = Field(description="The unique identifier for the schema.")
+    name: str = Field(description="The name of the schema.")
+    description: str = Field(description="A description of the schema.")
+    attributes: list[Attribute] = Field(description="A list of attributes that define the schema.")
+
+
+class Operation(AnaplanModel):
+    op: Literal["add", "remove", "replace"] = Field(description="The operation to be performed.")
+    path: str = Field(
+        description=(
+            "A string containing a JSON-Pointer value that references a location within the target "
+            "resource."
+        )
+    )
+    value: Any | None = Field(default=None, description="The value to be used in the operation.")
+
+
+class Replace(Operation):
+    op: Literal["replace"] = Field(
+        default="replace", description="Replace the value at path with the new given value."
+    )
+
+
+class Add(Operation):
+    op: Literal["add"] = Field(
+        default="add", description="Add the given value to the attribute at path."
+    )
+
+
+class Remove(Operation):
+    op: Literal["remove"] = Field(default="remove", description="Remove the value at path.")

{anaplan_sdk-0.5.0a5.dist-info → anaplan_sdk-0.5.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: anaplan-sdk
-Version: 0.5.0a5
+Version: 0.5.1
 Summary: Streamlined Python Interface for the Anaplan API.
 Project-URL: Homepage, https://vinzenzklass.github.io/anaplan-sdk/
 Project-URL: Repository, https://github.com/VinzenzKlass/anaplan-sdk
@@ -29,7 +29,7 @@ Description-Content-Type: text/markdown
 </h3>
 
 <p align="center" style="font-size: 1.2rem; font-weight: 300; margin: 15px 0">
-    Streamlined Python Interface for Anaplan
+    Streamlined Python Interface for the Anaplan API.
 </p>
 
 <div align="center">
@@ -45,9 +45,11 @@ Description-Content-Type: text/markdown
 </div>
 
 ---
+Streamlined Python Interface for the Anaplan API. Get up and running with the Anaplan API in minutes.
 
 Anaplan SDK is an independent, unofficial project providing pythonic access to Anaplan. It delivers high-level
-abstractions over all Anaplan APIs, allowing you to focus on business requirements rather than implementation details.
+abstractions over all parts of the Anaplan API, allowing you to focus on business requirements rather than
+implementation details.
 
 ## Key Features
 

anaplan_sdk-0.5.1.dist-info/RECORD

@@ -0,0 +1,34 @@
+anaplan_sdk/__init__.py,sha256=wkK6fPTp2-YiR9XVC-O1Iyf1FhVAcAxvJbX_YrF0p_c,397
+anaplan_sdk/_auth.py,sha256=l5z2WCcfQ05OkuQ1dcmikp6dB87Rw1qy2zu8bbaAQTs,16620
+anaplan_sdk/_oauth.py,sha256=AynlJDrGIinQT0jwxI2RSvtU4D7Wasyw3H1uicdlLVI,12672
+anaplan_sdk/_services.py,sha256=zW0ePBQNyP759OvagDuM02SwkXxyE71IuJNz6wcWVsw,13027
+anaplan_sdk/_utils.py,sha256=jsrhdfLpriMoANukVvXpjpEJ5hWDNx7ZJKAguLvKgJA,7517
+anaplan_sdk/exceptions.py,sha256=ALkA9fBF0NQ7dufFxV6AivjmHyuJk9DOQ9jtJV2n7f0,1809
+anaplan_sdk/_async_clients/__init__.py,sha256=oDYqtZIHWMA0iAfAv49htKaiS3sBBouqD_hEqaTWQL8,491
+anaplan_sdk/_async_clients/_alm.py,sha256=_PTD9Eght879HAadjcsfdvS0KCN93jgwpPOF8r3_E14,13178
+anaplan_sdk/_async_clients/_audit.py,sha256=6s6IceSyz1GXxigH1JAYarL9WMCxUdaCCAj4AjCgY_E,2897
+anaplan_sdk/_async_clients/_bulk.py,sha256=v-nyyf68NTs0PbQ-_5tGKbyUJZhRwZ8k0Pop5Yfg2K8,30517
+anaplan_sdk/_async_clients/_cloud_works.py,sha256=aSgmJQvE7dSJawwK0A7GEBWs7wokWk7eCwRiQuiVg6I,17701
+anaplan_sdk/_async_clients/_cw_flow.py,sha256=qJJFfnwLR7zIdZ_ay4fVI9zr3eP5B-qMcs4GlC9vqQY,3966
+anaplan_sdk/_async_clients/_scim.py,sha256=pBIrxP31n5YhFnDEu0eu8VpQas8SBy6JIdCBn_Z9oNM,7036
+anaplan_sdk/_async_clients/_transactional.py,sha256=f-NlIjvRJ0NIKRcI6ZaO2YatLERwIaC0TY0fKvgUJ5Q,18050
+anaplan_sdk/_clients/__init__.py,sha256=RB2ZYSW5vDrw8oAeDAkf7jmxu-Fr4yFLt3ebTtigE4Y,421
+anaplan_sdk/_clients/_alm.py,sha256=oRHTjnCuwQYZDE2CBWA1u410jSImIroCsDOSeP9U9w8,12905
+anaplan_sdk/_clients/_audit.py,sha256=Am6VviRw88_VC5i0N7TQTXEm6pJAHZb7xNaJTljD0fc,2850
+anaplan_sdk/_clients/_bulk.py,sha256=e1yRHcskAALhG1JClLYknRo_kXZUQkmG_Zc6TXY6IUk,30659
+anaplan_sdk/_clients/_cloud_works.py,sha256=1bbMYM_g8MSorxTI9Au_dFzbJZgKGJVBE6DYlbWBR0U,17492
+anaplan_sdk/_clients/_cw_flow.py,sha256=x64Ua2FwCpt8vab6gaLV8tDwW_ugJrDfU5dv-TnmM2M,3855
+anaplan_sdk/_clients/_scim.py,sha256=a5i7CNVNzF45YMbLY70ta_UumFumthZRmlfNm8rj2O0,6960
+anaplan_sdk/_clients/_transactional.py,sha256=IgkvBaq1Ep5mB-uxu6QoE17cUCfsodvV8dppASQrIT4,17875
+anaplan_sdk/models/__init__.py,sha256=zfwDQJQrXuLEXSpbJcm08a_YK1P7a7u-kMhwtJiJFmA,1783
+anaplan_sdk/models/_alm.py,sha256=oeENd0YM7-LoIRBq2uATIQTxVgIP9rXx3UZE2UnQAp0,4670
+anaplan_sdk/models/_base.py,sha256=6AZc9CfireUKgpZfMxYKu4MbwiyHQOsGLjKrxGXBLic,508
+anaplan_sdk/models/_bulk.py,sha256=C0s6XdvHxuJHrPXU-pnZ1JXK1PJOl9FScHArpaox_mQ,8489
+anaplan_sdk/models/_transactional.py,sha256=2bH10zvtMb5Lfh6DC7iQk72aEwq6tyLQ-XnH_0wYSqI,14172
+anaplan_sdk/models/cloud_works.py,sha256=APUGDt_e-JshtXkba5cQh5rZkXOZBz0Aix0qVNdEWgw,19501
+anaplan_sdk/models/flows.py,sha256=SuLgNj5-2SeE3U1i8iY8cq2IkjuUgd_3M1n2ENructk,3625
+anaplan_sdk/models/scim.py,sha256=jxPrn-LgoZFYm5rtfCwmceD6i8rkJwAZUlgLx036gjg,11099
+anaplan_sdk-0.5.1.dist-info/METADATA,sha256=Mmspki0fIDEGKOA4hjAmUdi6eGz1iOO8G9TM5lT1Rto,3799
+anaplan_sdk-0.5.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+anaplan_sdk-0.5.1.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
+anaplan_sdk-0.5.1.dist-info/RECORD,,

anaplan_sdk-0.5.0a5.dist-info/RECORD

@@ -1,30 +0,0 @@
-anaplan_sdk/__init__.py,sha256=WScEKtXlnRLjCb-j3qW9W4kEACTyPsTLFs-L54et2TQ,351
-anaplan_sdk/_auth.py,sha256=l5z2WCcfQ05OkuQ1dcmikp6dB87Rw1qy2zu8bbaAQTs,16620
-anaplan_sdk/_oauth.py,sha256=AynlJDrGIinQT0jwxI2RSvtU4D7Wasyw3H1uicdlLVI,12672
-anaplan_sdk/_services.py,sha256=D54hGrzj1MSj7_6-WDZUZsoLcThI_neW4aIoDOqALjE,20869
-anaplan_sdk/exceptions.py,sha256=ALkA9fBF0NQ7dufFxV6AivjmHyuJk9DOQ9jtJV2n7f0,1809
-anaplan_sdk/_async_clients/__init__.py,sha256=pZXgMMg4S9Aj_pxQCaSiPuNG-sePVGBtNJ0133VjqW4,364
-anaplan_sdk/_async_clients/_alm.py,sha256=zvKEvXlxNkcQim_XvyZLCbDafFldljg8APHqhAAIfvw,13147
-anaplan_sdk/_async_clients/_audit.py,sha256=r3pJ4iHmXHyfDu19L80UTZzMReg6FKE7DlzyhXLhI8A,2896
-anaplan_sdk/_async_clients/_bulk.py,sha256=JkXZ6mtK04bATyVZA6yA8akjVerurRjgINCViXAwoWM,30069
-anaplan_sdk/_async_clients/_cloud_works.py,sha256=VB4l93426A0Xes5dZ6DsDu0go-BVNhs2RZn2zX5DSOc,17675
-anaplan_sdk/_async_clients/_cw_flow.py,sha256=_allKIOP-qb33wrOj6GV5VAOvrCXOVJ1QXvck-jsocQ,3935
-anaplan_sdk/_async_clients/_transactional.py,sha256=U6X5pW7By387JOgvHx-GmgVRi7MRJKALpx0lWI6xRMo,18024
-anaplan_sdk/_clients/__init__.py,sha256=FsbwvZC1FHrxuRXwbPxUzbhz_lO1DpXIxEOjx6-3QuA,219
-anaplan_sdk/_clients/_alm.py,sha256=3U7Cy5U5TsePF1YPogXvsOzNeQlQm_ezO5TlmD-Xbbs,12874
-anaplan_sdk/_clients/_audit.py,sha256=oF1-7rGfYWG6LfM-i0vJzgpx4NAsLczo4welJR14N-U,2819
-anaplan_sdk/_clients/_bulk.py,sha256=-I0e5yBHhQPIuS9pF_dRRi7OmY7H88P5mGPusGupKi4,30226
-anaplan_sdk/_clients/_cloud_works.py,sha256=FsCp2wPxIoArAN1vcIfOI6ANNkK2ZebQ4MWJZB-nFJU,17466
-anaplan_sdk/_clients/_cw_flow.py,sha256=O6t4utbDZdSVXGC0PXUcPpQ4oXrPohU9_8SUBCpxTXw,3824
-anaplan_sdk/_clients/_transactional.py,sha256=SaHAnaGLZrhXmM8d6JnWWkwf-sVCEDW0nL2a4_wvjfk,17849
-anaplan_sdk/models/__init__.py,sha256=zfwDQJQrXuLEXSpbJcm08a_YK1P7a7u-kMhwtJiJFmA,1783
-anaplan_sdk/models/_alm.py,sha256=oeENd0YM7-LoIRBq2uATIQTxVgIP9rXx3UZE2UnQAp0,4670
-anaplan_sdk/models/_base.py,sha256=6AZc9CfireUKgpZfMxYKu4MbwiyHQOsGLjKrxGXBLic,508
-anaplan_sdk/models/_bulk.py,sha256=C0s6XdvHxuJHrPXU-pnZ1JXK1PJOl9FScHArpaox_mQ,8489
-anaplan_sdk/models/_transactional.py,sha256=2bH10zvtMb5Lfh6DC7iQk72aEwq6tyLQ-XnH_0wYSqI,14172
-anaplan_sdk/models/cloud_works.py,sha256=APUGDt_e-JshtXkba5cQh5rZkXOZBz0Aix0qVNdEWgw,19501
-anaplan_sdk/models/flows.py,sha256=SuLgNj5-2SeE3U1i8iY8cq2IkjuUgd_3M1n2ENructk,3625
-anaplan_sdk-0.5.0a5.dist-info/METADATA,sha256=cPMNYurLnr08YAdhsgOUFlrcw-xehz2gd5MQF_TrFg8,3678
-anaplan_sdk-0.5.0a5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-anaplan_sdk-0.5.0a5.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
-anaplan_sdk-0.5.0a5.dist-info/RECORD,,