Skip to content

Client

ClientService

Service which can be used to communicate with Client type in UGC API.

To use this service, you need to instantiate it with a valid Move UGC client.

from move_ugc import MoveUgc
ugc = MoveUgc(api_key="my-api-key")

# Call client service methods directly
ugc.clients.retrieve(id="client-<guid>")

# Or use the client service as a mixin
client_service = ugc.clients
client_service.retrieve(id="client-<guid>")

retrieve

retrieve() -> Client

Retrieve a client with given client_id from MoveUGC.

Returns:

Type Description
Client

Client instance of Pydantic model type.

update

update(metadata: Dict[str, Any]) -> Client

Update a client with given client_id from MoveUGC.

Parameters:

Name Type Description Default
metadata Dict[str, Any]

metadata to be updated.

required

Returns:

Type Description
Client

Client instance of Pydantic model type.