Skip to content

Relationship strength (V1)

Service for querying relationship strengths.

Source code in affinity/services/v1_only.py
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
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
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
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]