API coverage checklist

[not-so-smart]

Current state of API coverage

Groups

• [x] #4
  • [x] Framework
  • [x] Implementation
  • [ ] Tests
• [x] #5
  • [x] Framework
  • [x] Implementation
  • [ ] Tests
• [x] #6
  • [x] Framework
  • [x] Implementation
  • [ ] Tests
• [x] #7
  • [x] Framework
  • [x] Implementation
  • [ ] Tests
• [x] #8
  • [x] Framework
  • [x] Implementation
  • [ ] Tests
• [x] #9
  • [x] Framework
  • [x] Implementation
  • [ ] Tests
• [x] #10
  • [x] Framework
  • [x] Implementation
  • [ ] Tests
• [ ] #11
  • [ ] Framework
  • [ ] Implementation
  • [ ] Tests
• [x] #12
  • [x] Framework
  • [x] Implementation
  • [ ] Tests

    Group Messages

• [x] #13
  • [x] Framework
  • [x] Implementation
  • [ ] Tests
• [x] #14
  • [x] Framework
  • [x] Implementation
  • [ ] Tests
• [x] #15
  • [x] Framework
  • [x] Implementation
  • [ ] Tests

Members

• [ ] #16
  • [ ] Framework
  • [ ] Implementation
  • [ ] Tests
• [ ] #17
  • [ ] Framework
  • [ ] Implementation
  • [ ] Tests
• [x] #18
  • [ ] Framework
  • [ ] Implementation
  • [ ] Tests
• [ ] #19
  • [ ] Framework
  • [ ] Implementation
  • [ ] Tests

Chats

• [ ] #20
  • [ ] Framework
  • [ ] Implementation
  • [ ] Tests

    Chat Messages

• [x] #21
  • [x] Framework
  • [x] Implementation
  • [ ] Tests
• [x] #22
  • [x] Framework
  • [x] Implementation
  • [ ] Tests
• [ ] #23
  • [ ] Framework
  • [ ] Implementation
  • [ ] Tests

Users

• [ ] #24
  • [ ] Framework
  • [ ] Implementation
  • [ ] Tests
• [ ] #25
  • [ ] Framework
  • [ ] Implementation
  • [ ] Tests
• [ ] #26
  • [ ] Framework
  • [ ] Implementation
  • [ ] Tests
• [ ] #27
  • [ ] Framework
  • [ ] Implementation
  • [ ] Tests

Likes

• [ ] #28
  • [ ] Framework
  • [ ] Implementation
  • [ ] Tests
• [ ] #29
  • [ ] Framework
  • [ ] Implementation
  • [ ] Tests
• [ ] #30
  • [ ] Framework
  • [ ] Implementation
  • [ ] Tests
• [ ] #31
  • [ ] Framework
  • [ ] Implementation
  • [ ] Tests
• [ ] #32
  • [ ] Framework
  • [ ] Implementation
  • [ ] Tests

Calendar

• [ ] #33
  • [ ] Framework
  • [ ] Implementation
  • [ ] Tests
• [ ] #34
  • [ ] Framework
  • [ ] Implementation
  • [ ] Tests
• [ ] #35
  • [ ] Framework
  • [ ] Implementation
  • [ ] Tests
• [ ] #36
  • [ ] Framework
  • [ ] Implementation
  • [ ] Tests
• [ ] #37
  • [ ] Framework
  • [ ] Implementation
  • [ ] Tests
• [ ] #38
  • [ ] Framework
  • [ ] Implementation
  • [ ] Tests

Account

• [ ] #39
  • [ ] Framework
  • [ ] Implementation
  • [ ] Tests
• [x] #40
  • [ ] Framework
  • [ ] Implementation
  • [ ] Tests
• [x] #41
  • [ ] Framework
  • [ ] Implementation
  • [ ] Tests
• [x] #42
  • [ ] Framework
  • [ ] Implementation
  • [ ] Tests

Polls

• [x] #43
  • [x] Framework
  • [ ] Implementation
  • [ ] Tests
• [x] #44
  • [x] Framework
  • [ ] Implementation
  • [ ] Tests
• [x] #45
  • [x] Framework
  • [ ] Implementation
  • [ ] Tests
• [x] #46
  • [x] Framework
  • [ ] Implementation
  • [ ] Tests
• [x] #47
  • [x] Framework
  • [ ] Implementation
  • [ ] Tests

Attachments

• [x] #48
  • [ ] Framework
  • [ ] Implementation
  • [ ] Tests
• [x] #49
  • [ ] Framework
  • [ ] Implementation
  • [ ] Tests
• [ ] #50
  • [ ] Framework
  • [ ] Implementation
  • [ ] Tests

Push

• [ ] Implement push events

Miscellaneous and v4 stuff

• [ ] Pending memberships
• [ ] Relationships

Bots (ignored for now)

[AlureonTheVirus]

not that I can speak for the project but I'd like to add that groupme has also added subgroups as what it calls "topics".

I assume that we will want to have websocket support at some point built in. A more Event-Driven approach would make bot development with this library a lot simpler and more straightforward/intuitive. (Let me know if I'm wrong and that's already implemented.)

It also seems that this project lacks a lot of in depth documentation and examples that other API wrappers typically have. (Not a diss, just an observation and possibly another goal to work towards.)

[not-so-smart]

not that I can speak for the project but I'd like to add that groupme has also added subgroups as what it calls "topics".

Thank you! Yes, we do want to add support for topics, currently there is no framework for it but feel free to open a PR if you'd like to get that started :)

I assume that we will want to have websocket support at some point built in. A more Event-Driven approach would make bot development with this library a lot simpler and more straightforward/intuitive. (Let me know if I'm wrong and that's already implemented.)

Good news! The PR for websockets (#104) is currently open and will be merged soon! :D

It also seems that this project lacks a lot of in depth documentation and examples that other API wrappers typically have. (Not a diss, just an observation and possibly another goal to work towards.)

Yes, as you can see from this checklist, a lot of the framework (files, classes and method stubs to shape the relevant data structures) and even most of the implementation (filling in those method stubs with code that interacts with the API) is currently missing. API coverage is a slightly higher priority than documentation at this stage, but we do have docs at https://groupme.js.org/ which are automatically generated on each release and built from TS type information (for classes and their properties) along with any JSdoc comments present in the code (for descriptions of these objects and example usage). If you want to add to this documentation, just open a PR adding comments following the JSdoc standard (https://jsdoc.app/) and they'll be added to the generated docs in the next build.