Class: WebhookPayloadClient<Trigger>

Defined in: rest/v2/webhooks/payload.ts:28

Type Parameters

Type Parameter
Trigger extends PatreonWebhookTrigger

Constructors

Constructor

new WebhookPayloadClient<Trigger>(trigger, payload): WebhookPayloadClient<Trigger>

Defined in: rest/v2/webhooks/payload.ts:98

Parameters

Parameter	Type
trigger	Trigger
payload	WebhookPayload<Trigger>

Returns

WebhookPayloadClient<Trigger>

Properties

Property	Modifier	Type
payload	public	WebhookPayload<Trigger>
trigger	public	Trigger

Accessors

campaign

Get Signature

get campaign(): undefined | AttributeItem<Campaign, Pick<Campaign, keyof Campaign>>

Defined in: rest/v2/webhooks/payload.ts:124

Returns

undefined | AttributeItem<Campaign, Pick<Campaign, keyof Campaign>>

---

campaignId

Get Signature

get campaignId(): string

Defined in: rest/v2/webhooks/payload.ts:118

Returns

string

---

user

Get Signature

get user(): undefined | AttributeItem<User, Pick<User, keyof User>>

Defined in: rest/v2/webhooks/payload.ts:109

Returns

undefined | AttributeItem<User, Pick<User, keyof User>>

---

userId

Get Signature

get userId(): string

Defined in: rest/v2/webhooks/payload.ts:103

Returns

string

Methods

convert()

convert<Data>(converter): Data

Defined in: rest/v2/webhooks/payload.ts:133

Type Parameters

Type Parameter
Data extends Partial<Record<string, string | number | boolean | Partial<Record<string, string | number | boolean>> | Partial<Record<string, string | number | boolean>>[]>>

Parameters

Parameter	Type
converter	WebhookPayloadDataConverter<Data>

Returns

Data

---

convert()

static convert<Data>(converter): (trigger, payload) => Data

Defined in: rest/v2/webhooks/payload.ts:79

Type Parameters

Type Parameter
Data extends Partial<Record<string, string | number | boolean | Partial<Record<string, string | number | boolean>> | Partial<Record<string, string | number | boolean>>[]>>

Parameters

Parameter	Type
converter	WebhookPayloadDataConverter<Data>

Returns

(trigger, payload): Data

Parameters

Parameter	Type
trigger	PatreonWebhookTrigger
payload	WebhookPayload

Returns

Data

---

createAttributeText()

static createAttributeText<Keys>(option, attributes, attribute?, unknown?): string

Defined in: rest/v2/webhooks/payload.ts:29

Type Parameters

Type Parameter
Keys extends string

Parameters

Parameter	Type
option	undefined | string
attributes	Record<Keys, unknown>
attribute?	Keys
unknown?	string

Returns

string

---

isPostPayload()

static isPostPayload(trigger, payload): payload is GetRequestPayload<Post, "campaign" | "user", RelationshipMap<Post, "campaign" | "user">>

Defined in: rest/v2/webhooks/payload.ts:53

Parameters

Parameter	Type
trigger	PatreonWebhookTrigger
payload	WebhookPayload

Returns

payload is GetRequestPayload<Post, "campaign" | "user", RelationshipMap<Post, "campaign" | "user">>

---

isPostTrigger()

static isPostTrigger(trigger): trigger is PatreonWebhookPostTrigger

Defined in: rest/v2/webhooks/payload.ts:43

Parameters

Parameter	Type
trigger	PatreonWebhookTrigger

Returns

trigger is PatreonWebhookPostTrigger