WebhooksClient

​

하위 모듈

• xdk.webhooks.client 모듈
  • WebhooksClient
    • WebhooksClient.__init__()
    • WebhooksClient.create()
    • WebhooksClient.create_stream_link()
    • WebhooksClient.create_webhook_replay_job()
    • WebhooksClient.delete()
    • WebhooksClient.delete_stream_link()
    • WebhooksClient.get()
    • WebhooksClient.get_stream_links()
    • WebhooksClient.validate()
• xdk.webhooks.models 모듈
  • CreateRequest
    • CreateRequest.model_config
  • CreateResponse
    • CreateResponse.model_config
  • CreateStreamLinkResponse
    • CreateStreamLinkResponse.model_config
  • CreateWebhookReplayJobRequest
    • CreateWebhookReplayJobRequest.model_config
  • CreateWebhookReplayJobResponse
    • CreateWebhookReplayJobResponse.model_config
  • DeleteResponse
    • DeleteResponse.model_config
  • DeleteStreamLinkResponse
    • DeleteStreamLinkResponse.model_config
  • GetResponse
    • GetResponse.model_config
  • GetStreamLinksResponse
    • GetStreamLinksResponse.model_config
  • ValidateResponse
    • ValidateResponse.model_config

​

모듈 내용

이 모듈은 X API의 웹훅 엔드포인트에 대한 접근을 제공하며, 웹훅 관련 모든 기능을 위한 기본 진입점 역할을 합니다.

​

class xdk.webhooks.WebhooksClient

웹훅 작업용 Client

​

매개변수

path.client · Client

​

__init__

​

매개변수

path.client · Client

​

create

웹훅 생성 새 웹훅 구성을 만듭니다. body: 요청 본문 :returns: 응답 데이터 :rtype: CreateResponse

​

매개변수

body.body · CreateRequest

​

create_stream_link

스트림 링크 생성 FilteredStream 이벤트를 지정된 웹훅으로 전달하기 위한 링크를 생성합니다.

​

매개변수

path.webhook_id · Any

FilteredStream 규칙 집합에 연결할 webhook ID입니다.

path.tweet_fields · str or None · 기본값: "None"

표시할 Tweet 필드 목록을 쉼표로 구분한 값입니다.

path.expansions · str or None · 기본값: "None"

확장할 필드 목록을 쉼표로 구분한 값입니다.

path.media_fields · str or None · 기본값: "None"

표시할 Media 필드 목록을 쉼표로 구분한 값입니다.

path.poll_fields · str or None · 기본값: "None"

표시할 Poll 필드 목록을 쉼표로 구분한 값입니다.

path.user_fields · str or None · 기본값: "None"

표시할 User 필드 목록을 쉼표로 구분한 값입니다.

path.place_fields · str or None · 기본값: "None"

표시할 Place 필드 목록을 쉼표로 구분한 값입니다.

​

반환값

CreateStreamLinkResponse - 응답 데이터

​

create_webhook_replay_job

웹후크용 재생 작업 생성 웹후크로 전달되었거나 전달을 시도한 모든 이벤트에 대해, 최대 지난 24시간 이내의 이벤트를 가져오기 위한 재생 작업을 생성합니다. body: 요청 본문 :returns: 응답 데이터 :rtype: CreateWebhookReplayJobResponse

​

매개변수

body.body · CreateWebhookReplayJobRequest

​

delete

웹후크 삭제 기존 웹후크 설정을 삭제합니다.

​

매개변수

path.webhook_id · Any

삭제할 webhook의 id입니다.

​

반환값

DeleteResponse - 응답 데이터

​

delete_stream_link

스트림 링크 삭제 FilteredStream 이벤트와 지정된 웹훅 사이의 링크를 삭제합니다.

​

매개변수

path.webhook_id · Any

FilteredStream 규칙 세트에 연결할 webhook의 id입니다.

​

반환값

DeleteStreamLinkResponse - 응답 데이터

​

get

웹훅 조회 클라이언트 앱과 연관된 웹훅 구성 목록을 가져옵니다.

​

매개변수

path.webhook_config_fields · List or None · 기본값: "None"

표시할 WebhookConfig 필드의 쉼표로 구분된 리스트입니다.

​

반환

GetResponse - 응답 데이터

​

get_stream_links

스트림 링크 가져오기 필터링된 스트림 규칙 세트와 연결된 웹훅 링크 목록을 가져옵니다. :returns: 응답 데이터 :rtype: GetStreamLinksResponse

​

반환

GetStreamLinksResponse

​

validate

웹후크를 검증합니다. 지정된 웹후크에 대해 CRC 검사를 실행합니다.

​

매개변수

path.webhook_id · Any

확인할 웹훅의 ID입니다.

​

반환 값

ValidateResponse - 응답 데이터