Skip to content

Commit afaa405

Browse files
authored
feat: documentation moved to mintlify with api extractor & typedoc markdown generator for typescript code files and other minor fixes (#27)
1 parent 0f50da7 commit afaa405

252 files changed

Lines changed: 19566 additions & 5088 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/documentation-preview.yaml

Lines changed: 0 additions & 91 deletions
This file was deleted.

.github/workflows/documentation-prod.yaml

Lines changed: 0 additions & 141 deletions
This file was deleted.

.github/workflows/format-tag/action.yml

Lines changed: 0 additions & 16 deletions
This file was deleted.

.github/workflows/format-tag/formatTag.js

Lines changed: 0 additions & 22 deletions
This file was deleted.

.github/workflows/format-tag/index.js

Lines changed: 0 additions & 11 deletions
This file was deleted.

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<div align="center">
22
<br />
33
<p align="center">
4-
<a href="https://wapijs.co"><img src="https://www.wapijs.co/assets/logo/logo-light.svg" alt="@wapijs/wapi.js" height="200" width="360" /></a>
4+
<a href="https://wapijs.co"><img src="https://media.discordapp.net/attachments/1046394448088674371/1247281980111061054/wapijs_banner.png?ex=665f755d&is=665e23dd&hm=b0f47091e442022d562ee535c8fefdf1d9006db11e09ea5d380186ab4a40a97a&=&format=webp&quality=lossless&width=2261&height=1034" alt="@wapijs/wapi.js" /></a>
55
</p>
66
<br />
77
<p>
@@ -13,7 +13,7 @@
1313

1414
## 📌 Status
1515

16-
Beta Version - This library is not stable right now. It is currently in beta version. Report issues [here](https://github.com/sarthakjdev/wapi.js/issues).
16+
Beta Version - This SDK is not stable right now. It is currently in beta version. Report issues [here](https://github.com/sarthakjdev/wapi.js/issues).
1717

1818
## 📖 About
1919

@@ -35,15 +35,15 @@ Wapi.js is a JavaScript module, written in TypeScript, designed to interact with
3535

3636
## 💻 Installation
3737

38-
Ensure you have the Node.js 18 LTS version to use this library.
38+
Ensure you have the Node.js 18 LTS version to use this SDK.
3939

4040
```sh
4141
npm install @wapijs/wapi.js
4242
yarn add @wapijs/wapi.js
4343
pnpm install @wapijs/wapi.js
4444
```
4545

46-
> Note: This library is not affiliated with the official WhatsApp Cloud API or does not act as any official solution provided the the Meta Inclusive Private Limited, this is just a open source library built for developers to support them in building whatsapp cloud api based chat bots easily.
46+
> Note: This SDK is not affiliated with the official WhatsApp Cloud API or does not act as any official solution provided the the Meta Inclusive Private Limited, this is just a open source SDK built for developers to support them in building whatsapp cloud api based chat bots easily.
4747
4848
## 🚀 Usage
4949

@@ -81,7 +81,7 @@ import { Client, TextMessage } from 'wapi.js'
8181
})
8282

8383
await whatsappClient.message.send({
84-
message: new TextMessage({ text: 'hiii, this is wapijs library' }),
84+
message: new TextMessage({ text: 'hiii, this is wapijs SDK' }),
8585
phoneNumber: 'XXXXXXXXXX'
8686
})
8787

@@ -91,13 +91,19 @@ import { Client, TextMessage } from 'wapi.js'
9191

9292
whatsappClient.on('TextMessage', async (message) => {
9393
message.reply({
94-
message: new TextMessage({ text: 'hiii, this is wapijs library' }),,
94+
message: new TextMessage({ text: 'hiii, this is wapijs SDK' }),,
9595
})
9696
})
9797

9898
whatsappClient.initiate()
9999
```
100100

101+
## Upcoming features:
102+
103+
- [Interactive Address Message Support](https://developers.facebook.com/docs/whatsapp/cloud-api/messages/address-messages)
104+
- [Business Management API Support](https://developers.facebook.com/docs/whatsapp/business-management-api)
105+
-
106+
101107
## 🤝 Contribution Guidelines
102108

103109
1. Fork the Project
@@ -118,4 +124,4 @@ Distributed under the Apache 2.0 License. View [LICENSE](./LICENSE).
118124
- Email: sarthak@softlancer.co
119125
- [Twitter](https://twitter.com/sarthakjdev) | [LinkedIn](https://www.linkedin.com/in/sarthakjdev)
120126

121-
Note: This library is part of an open-source product-building initiative by [Softlancer](https://github.com/softlancerhq), and this repository will soon be moved under the same organization.
127+
Note: This SDK is part of an open-source product-building initiative by [Softlancer](https://github.com/softlancerhq), and this repository will soon be moved under the same organization.

apps/.DS_Store

-6 KB
Binary file not shown.

0 commit comments

Comments
 (0)