Skip to content

Commit

Permalink
fix: docs
Browse files Browse the repository at this point in the history
Signed-off-by: sarthakjdev <jsarthak448@gmail.com>
  • Loading branch information
sarthakjdev committed Jun 1, 2024
1 parent 5595073 commit 161a86b
Show file tree
Hide file tree
Showing 101 changed files with 788 additions and 860 deletions.
24 changes: 11 additions & 13 deletions apps/js.wapikit.com/api-reference/classes/AdInteractionEvent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@

[Wapi.js Docs](../globals.mdx) / AdInteractionEvent

# Class: AdInteractionEvent

Represents an ad interaction event.

## Implements
Expand Down Expand Up @@ -80,7 +78,7 @@ The data object.

#### Source

[packages/wapi.js/src/webhook/events/interaction/index.ts:254](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/webhook/events/interaction/index.ts#L254)
[packages/wapi.js/src/webhook/events/interaction/index.ts:254](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/webhook/events/interaction/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=254)

## Properties

Expand All @@ -100,7 +98,7 @@ The client instance associated with the event.

#### Source

[packages/wapi.js/src/webhook/events/base/index.ts:20](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/webhook/events/base/index.ts#L20)
[packages/wapi.js/src/webhook/events/base/index.ts:20](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/webhook/events/base/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=20)

***

Expand All @@ -120,7 +118,7 @@ The context of the message.

#### Source

[packages/wapi.js/src/webhook/events/base/index.ts:37](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/webhook/events/base/index.ts#L37)
[packages/wapi.js/src/webhook/events/base/index.ts:37](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/webhook/events/base/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=37)

***

Expand All @@ -134,7 +132,7 @@ The context of the message.

#### Source

[packages/wapi.js/src/webhook/events/base/index.ts:39](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/webhook/events/base/index.ts#L39)
[packages/wapi.js/src/webhook/events/base/index.ts:39](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/webhook/events/base/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=39)

***

Expand All @@ -154,7 +152,7 @@ The ID of the message.

#### Source

[packages/wapi.js/src/webhook/events/base/index.ts:36](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/webhook/events/base/index.ts#L36)
[packages/wapi.js/src/webhook/events/base/index.ts:36](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/webhook/events/base/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=36)

***

Expand Down Expand Up @@ -204,7 +202,7 @@ The ID of the message.

#### Source

[packages/wapi.js/src/webhook/events/interaction/index.ts:221](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/webhook/events/interaction/index.ts#L221)
[packages/wapi.js/src/webhook/events/interaction/index.ts:221](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/webhook/events/interaction/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=221)

***

Expand All @@ -218,7 +216,7 @@ The ID of the message.

#### Source

[packages/wapi.js/src/webhook/events/interaction/index.ts:220](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/webhook/events/interaction/index.ts#L220)
[packages/wapi.js/src/webhook/events/interaction/index.ts:220](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/webhook/events/interaction/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=220)

***

Expand All @@ -238,7 +236,7 @@ The timestamp of the message.

#### Source

[packages/wapi.js/src/webhook/events/base/index.ts:38](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/webhook/events/base/index.ts#L38)
[packages/wapi.js/src/webhook/events/base/index.ts:38](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/webhook/events/base/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=38)

## Methods

Expand Down Expand Up @@ -274,7 +272,7 @@ The phone number of the sender.

#### Source

[packages/wapi.js/src/webhook/events/base/index.ts:100](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/webhook/events/base/index.ts#L100)
[packages/wapi.js/src/webhook/events/base/index.ts:100](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/webhook/events/base/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=100)

***

Expand All @@ -300,7 +298,7 @@ MessageEvent

#### Source

[packages/wapi.js/src/webhook/events/base/index.ts:121](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/webhook/events/base/index.ts#L121)
[packages/wapi.js/src/webhook/events/base/index.ts:121](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/webhook/events/base/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=121)

***

Expand Down Expand Up @@ -340,4 +338,4 @@ The message to send as a reply.

#### Source

[packages/wapi.js/src/webhook/events/base/index.ts:75](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/webhook/events/base/index.ts#L75)
[packages/wapi.js/src/webhook/events/base/index.ts:75](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/webhook/events/base/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=75)
18 changes: 8 additions & 10 deletions apps/js.wapikit.com/api-reference/classes/AudioMessage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@

[Wapi.js Docs](../globals.mdx) / AudioMessage

# Class: AudioMessage

Represents an audio message.

## Implements
Expand Down Expand Up @@ -46,7 +44,7 @@ AudioMessage

#### Source

[packages/wapi.js/src/structures/media/index.ts:48](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/structures/media/index.ts#L48)
[packages/wapi.js/src/structures/media/index.ts:48](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/structures/media/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=48)

## Properties

Expand All @@ -56,7 +54,7 @@ AudioMessage
#### Source

[packages/wapi.js/src/structures/media/index.ts:39](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/structures/media/index.ts#L39)
[packages/wapi.js/src/structures/media/index.ts:39](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/structures/media/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=39)

***

Expand All @@ -70,7 +68,7 @@ AudioMessage

#### Source

[packages/wapi.js/src/structures/media/index.ts:35](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/structures/media/index.ts#L35)
[packages/wapi.js/src/structures/media/index.ts:35](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/structures/media/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=35)

***

Expand All @@ -90,7 +88,7 @@ The messaging product.

#### Source

[packages/wapi.js/src/structures/message/index.ts:17](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/structures/message/index.ts#L17)
[packages/wapi.js/src/structures/message/index.ts:17](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/structures/message/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=17)

***

Expand All @@ -110,7 +108,7 @@ The recipient type.

#### Source

[packages/wapi.js/src/structures/message/index.ts:18](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/structures/message/index.ts#L18)
[packages/wapi.js/src/structures/message/index.ts:18](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/structures/message/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=18)

***

Expand All @@ -130,7 +128,7 @@ The type of the message.

#### Source

[packages/wapi.js/src/structures/message/index.ts:16](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/structures/message/index.ts#L16)
[packages/wapi.js/src/structures/message/index.ts:16](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/structures/message/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=16)

## Methods

Expand Down Expand Up @@ -166,7 +164,7 @@ An error if the parsing fails.

#### Source

[packages/wapi.js/src/structures/message/index.ts:42](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/structures/message/index.ts#L42)
[packages/wapi.js/src/structures/message/index.ts:42](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/structures/message/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=42)

***

Expand Down Expand Up @@ -238,4 +236,4 @@ AudioMessage

#### Source

[packages/wapi.js/src/structures/media/index.ts:67](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/structures/media/index.ts#L67)
[packages/wapi.js/src/structures/media/index.ts:67](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/structures/media/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=67)
30 changes: 14 additions & 16 deletions apps/js.wapikit.com/api-reference/classes/AudioMessageEvent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@

[Wapi.js Docs](../globals.mdx) / AudioMessageEvent

# Class: AudioMessageEvent

Represents an event for an audio message.

## Implements
Expand Down Expand Up @@ -70,7 +68,7 @@ AudioMessageEvent

#### Source

[packages/wapi.js/src/webhook/events/audio/index.ts:34](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/webhook/events/audio/index.ts#L34)
[packages/wapi.js/src/webhook/events/audio/index.ts:34](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/webhook/events/audio/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=34)

## Properties

Expand All @@ -86,7 +84,7 @@ The audio message associated with the event.

#### Source

[packages/wapi.js/src/webhook/events/audio/index.ts:16](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/webhook/events/audio/index.ts#L16)
[packages/wapi.js/src/webhook/events/audio/index.ts:16](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/webhook/events/audio/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=16)

***

Expand All @@ -106,7 +104,7 @@ The client instance associated with the event.

#### Source

[packages/wapi.js/src/webhook/events/base/index.ts:20](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/webhook/events/base/index.ts#L20)
[packages/wapi.js/src/webhook/events/base/index.ts:20](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/webhook/events/base/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=20)

***

Expand All @@ -126,7 +124,7 @@ The context of the message.

#### Source

[packages/wapi.js/src/webhook/events/base/index.ts:37](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/webhook/events/base/index.ts#L37)
[packages/wapi.js/src/webhook/events/base/index.ts:37](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/webhook/events/base/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=37)

***

Expand All @@ -140,7 +138,7 @@ The context of the message.

#### Source

[packages/wapi.js/src/webhook/events/base/index.ts:39](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/webhook/events/base/index.ts#L39)
[packages/wapi.js/src/webhook/events/base/index.ts:39](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/webhook/events/base/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=39)

***

Expand All @@ -160,7 +158,7 @@ The ID of the media.

#### Source

[packages/wapi.js/src/webhook/events/base/index.ts:147](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/webhook/events/base/index.ts#L147)
[packages/wapi.js/src/webhook/events/base/index.ts:147](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/webhook/events/base/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=147)

***

Expand All @@ -180,7 +178,7 @@ The ID of the message.

#### Source

[packages/wapi.js/src/webhook/events/base/index.ts:36](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/webhook/events/base/index.ts#L36)
[packages/wapi.js/src/webhook/events/base/index.ts:36](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/webhook/events/base/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=36)

***

Expand All @@ -200,7 +198,7 @@ The MIME type of the media.

#### Source

[packages/wapi.js/src/webhook/events/base/index.ts:148](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/webhook/events/base/index.ts#L148)
[packages/wapi.js/src/webhook/events/base/index.ts:148](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/webhook/events/base/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=148)

***

Expand All @@ -220,7 +218,7 @@ The SHA256 hash of the media.

#### Source

[packages/wapi.js/src/webhook/events/base/index.ts:149](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/webhook/events/base/index.ts#L149)
[packages/wapi.js/src/webhook/events/base/index.ts:149](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/webhook/events/base/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=149)

***

Expand All @@ -240,7 +238,7 @@ The timestamp of the message.

#### Source

[packages/wapi.js/src/webhook/events/base/index.ts:38](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/webhook/events/base/index.ts#L38)
[packages/wapi.js/src/webhook/events/base/index.ts:38](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/webhook/events/base/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=38)

## Methods

Expand All @@ -266,7 +264,7 @@ Gets the URL of the media.

#### Source

[packages/wapi.js/src/webhook/events/base/index.ts:191](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/webhook/events/base/index.ts#L191)
[packages/wapi.js/src/webhook/events/base/index.ts:191](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/webhook/events/base/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=191)

***

Expand Down Expand Up @@ -302,7 +300,7 @@ The phone number of the sender.

#### Source

[packages/wapi.js/src/webhook/events/base/index.ts:100](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/webhook/events/base/index.ts#L100)
[packages/wapi.js/src/webhook/events/base/index.ts:100](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/webhook/events/base/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=100)

***

Expand All @@ -328,7 +326,7 @@ MessageEvent

#### Source

[packages/wapi.js/src/webhook/events/base/index.ts:121](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/webhook/events/base/index.ts#L121)
[packages/wapi.js/src/webhook/events/base/index.ts:121](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/webhook/events/base/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=121)

***

Expand Down Expand Up @@ -368,4 +366,4 @@ The message to send as a reply.

#### Source

[packages/wapi.js/src/webhook/events/base/index.ts:75](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/webhook/events/base/index.ts#L75)
[packages/wapi.js/src/webhook/events/base/index.ts:75](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/webhook/events/base/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=75)
6 changes: 2 additions & 4 deletions apps/js.wapikit.com/api-reference/classes/BaseEvent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@

[Wapi.js Docs](../globals.mdx) / BaseEvent

# Class: BaseEvent

Represents the base event for webhook events.

## Implements
Expand Down Expand Up @@ -37,7 +35,7 @@ Represents the base event for webhook events.

#### Source

[packages/wapi.js/src/webhook/events/base/index.ts:21](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/webhook/events/base/index.ts#L21)
[packages/wapi.js/src/webhook/events/base/index.ts:21](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/webhook/events/base/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=21)

## Properties

Expand All @@ -53,4 +51,4 @@ The client instance associated with the event.

#### Source

[packages/wapi.js/src/webhook/events/base/index.ts:20](https://github.com/sarthakjdev/wapi.js/blob/13b0ae8a179e1d2ead89d348fa5b05387c8fc977/packages/wapi.js/src/webhook/events/base/index.ts#L20)
[packages/wapi.js/src/webhook/events/base/index.ts:20](https://github.com/sarthakjdev/wapi.js/packages/wapi.js/src/webhook/events/base/index.ts?at=55950734d72fca04a6c87f7236ee551d251cec7e#line=20)
Loading

0 comments on commit 161a86b

Please sign in to comment.