AccountActivityClient

Sous-modules

• module xdk.account_activity.client
  • AccountActivityClient
    • AccountActivityClient.__init__()
    • AccountActivityClient.create_replay_job()
    • AccountActivityClient.create_subscription()
    • AccountActivityClient.delete_subscription()
    • AccountActivityClient.get_subscription_count()
    • AccountActivityClient.get_subscriptions()
    • AccountActivityClient.validate_subscription()
• module xdk.account_activity.models
  • CreateReplayJobResponse
    • CreateReplayJobResponse.model_config
  • CreateSubscriptionRequest
    • CreateSubscriptionRequest.model_config
  • CreateSubscriptionResponse
    • CreateSubscriptionResponse.model_config
  • DeleteSubscriptionResponse
    • DeleteSubscriptionResponse.model_config
  • GetSubscriptionCountResponse
    • GetSubscriptionCountResponse.model_config
  • GetSubscriptionsResponse
    • GetSubscriptionsResponse.model_config
  • ValidateSubscriptionResponse
    • ValidateSubscriptionResponse.model_config

Contenu du module

Ce module permet d’accéder aux points de terminaison d’activité de compte de X API et sert de point d’entrée principal pour l’ensemble des fonctionnalités liées à l’activité de compte.

class xdk.account_activity.AccountActivityClient

Client pour les opérations liées à l’activité du compte

Paramètres

path.client · Client

__init__

Paramètres

path.client · Client

create_replay_job

Créer une tâche de relecture Crée une tâche de relecture pour récupérer les activités jusqu’aux cinq derniers jours pour tous les abonnements associés à un webhook donné.

Paramètres

path.webhook_id · Any

L’identifiant unique de la configuration du webhook.

path.from_date · str

L’horodatage UTC le plus ancien (point de départ, inclus) à partir duquel les événements seront fournis, au format yyyymmddhhmm.

path.to_date · str

L’horodatage UTC le plus récent (point de fin, exclu) jusqu’auquel les événements seront fournis, au format yyyymmddhhmm.

Valeur de retour

CreateReplayJobResponse - Données de réponse

create_subscription

Créer un abonnement Crée un abonnement à Account Activity pour l’utilisateur et le webhook spécifié.

Paramètres

path.webhook_id · Any

L’id du webhook servant à vérifier l’abonnement.

body.body · CreateSubscriptionRequest

Corps de la requête

delete_subscription

Supprimer l’abonnement Supprime un abonnement Account Activity pour le webhook et l’id utilisateur spécifiés.

Paramètres

path.webhook_id · Any

ID du webhook dont vérifier l’abonnement.

path.user_id · Any

ID de l’utilisateur à désabonner.

Valeur de retour

DeleteSubscriptionResponse - Données de réponse

get_subscription_count

Obtenir le nombre d’abonnements Renvoie le nombre d’abonnements Account Activity actuellement actifs. :returns: Données de la réponse :rtype: GetSubscriptionCountResponse

Retourne

GetSubscriptionCountResponse

get_subscriptions

Récupérer les abonnements Récupère la liste de tous les abonnements actifs pour un webhook donné.

Paramètres

path.webhook_id · Any

L’ID du webhook pour lequel les abonnements doivent être récupérés.

Valeur de retour

GetSubscriptionsResponse - Données de la réponse

validate_subscription

Valider l’abonnement Vérifie l’abonnement Account Activity d’un utilisateur associé à un webhook donné.

Paramètres

path.webhook_id · Any

L’ID du webhook pour lequel vérifier l’abonnement.

Renvoie

ValidateSubscriptionResponse - Données de la réponse