Skip to content

Relationship strength (V1)

Service for querying relationship strengths.

Source code in affinity/services/v1_only.py
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
class RelationshipStrengthService:
    """Service for querying relationship strengths."""

    def __init__(self, client: HTTPClient):
        self._client = client

    def get(
        self,
        external_id: PersonId,
        internal_id: UserId | None = None,
    ) -> list[RelationshipStrength]:
        """
        Get relationship strength(s) for an external person.

        Args:
            external_id: External person to query
            internal_id: Optional internal person for specific relationship

        Returns:
            List of relationship strengths (may be empty)
        """
        params: dict[str, Any] = {"external_id": int(external_id)}
        if internal_id:
            params["internal_id"] = int(internal_id)

        data = self._client.get("/relationships-strengths", params=params, v1=True)
        items = data.get("data", [])
        if not isinstance(items, list):
            items = []
        return [RelationshipStrength.model_validate(r) for r in items]

get(external_id: PersonId, internal_id: UserId | None = None) -> list[RelationshipStrength]

Get relationship strength(s) for an external person.

Parameters:

Name Type Description Default
external_id PersonId

External person to query

required
internal_id UserId | None

Optional internal person for specific relationship

None

Returns:

Type Description
list[RelationshipStrength]

List of relationship strengths (may be empty)

Source code in affinity/services/v1_only.py
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
def get(
    self,
    external_id: PersonId,
    internal_id: UserId | None = None,
) -> list[RelationshipStrength]:
    """
    Get relationship strength(s) for an external person.

    Args:
        external_id: External person to query
        internal_id: Optional internal person for specific relationship

    Returns:
        List of relationship strengths (may be empty)
    """
    params: dict[str, Any] = {"external_id": int(external_id)}
    if internal_id:
        params["internal_id"] = int(internal_id)

    data = self._client.get("/relationships-strengths", params=params, v1=True)
    items = data.get("data", [])
    if not isinstance(items, list):
        items = []
    return [RelationshipStrength.model_validate(r) for r in items]