Skip to content

Commit d50e905

Browse files
authored
Update USAGE.md
1 parent 740f151 commit d50e905

File tree

1 file changed

+64
-8
lines changed

1 file changed

+64
-8
lines changed

USAGE.md

Lines changed: 64 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,128 @@
1-
We assume the `wrapper` variable has been bound to.
1+
# Wrapper Usage
22

3+
## Core Functions
34
```
4-
Non-helper functions:
5-
wrapper.init(token) where token is an object with the fields 'type' and 'value'.
5+
wrapper.init(token)
66
wrapper.get(endpoint, sort_options)
77
wrapper.patch(endpoint, body)
88
wrapper.post(endpoint, body)
99
wrapper.delete(endpoint)
1010
wrapper.health()
1111
wrapper.ping()
12+
```
1213

13-
Alerts:
14+
## Alerts
15+
```
1416
wrapper.alerts.list(sort_options)
1517
wrapper.alerts.list_all(sort_options)
1618
wrapper.alerts.list_until(func, sort_options)
1719
wrapper.alerts.mark_as_read()
20+
```
1821

19-
Conversations:
22+
## Conversations
23+
```
2024
wrapper.conversations.list(sort_options)
25+
wrapper.conversations.list_all(sort_options)
26+
wrapper.conversations.list_until(func, sort_options)
2127
wrapper.conversations.create(title, message, recipient_id)
2228
wrapper.conversations.list_replies(conversation_id, sort_options)
29+
wrapper.conversations.list_replies_all(conversation_id, sort_options)
30+
wrapper.conversations.list_replies_until(conversation_id, func, sort_options)
2331
wrapper.conversations.reply(conversation_id, message)
32+
```
2433

25-
Members:
34+
## Members
35+
```
2636
wrapper.members.self()
2737
wrapper.members.fetch(member_id)
2838
2939
wrapper.member.profile_posts.list(sort_options)
40+
wrapper.member.profile_posts.list_all(sort_options)
41+
wrapper.member.profile_posts.list_until(func, sort_options)
3042
wrapper.member.profile_posts.fetch(profile_post_id)
3143
wrapper.member.profile_posts.edit(profile_post_id, message)
3244
wrapper.member.profile_posts.delete(profile_post_id)
45+
```
3346

34-
Resources:
47+
## Resources
48+
```
3549
wrapper.resources.list(sort_options)
3650
wrapper.resources.list_owned(sort_options)
51+
wrapper.resources.list_owned_all(sort_options)
52+
wrapper.resources.list_owned_until(func, sort_options)
3753
wrapper.resources.fetch(resource_id)
3854
wrapper.resources.edit(resource_id, fields)
55+
```
3956

57+
#### Downloads
58+
```
4059
wrapper.resources.downloads.list(resource_id, sort_options)
60+
wrapper.resources.downloads.list_all(resource_id, sort_options)
61+
wrapper.resources.downloads.list_until(resource_id, func, sort_options)
4162
wrapper.resources.downloads.list_member(resource_id, member_id, sort_options)
63+
wrapper.resources.downloads.list_member_all(resource_id, member_id, sort_options)
64+
wrapper.resources.downloads.list_member_until(resource_id, member_id, func, sort_options)
4265
wrapper.resources.downloads.list_version(resource_id, version_id, sort_options)
66+
wrapper.resources.downloads.list_version_all(resource_id, version_id, sort_options)
67+
wrapper.resources.downloads.list_version_until(resource_id, version_id, func, sort_options)
68+
```
4369

70+
#### Licenses
71+
```
4472
wrapper.resources.licenses.list(resource_id, sort_options)
73+
wrapper.resources.licenses.list_all(resource_id, sort_options)
74+
wrapper.resources.licenses.list_until(resource_id, func, sort_options)
4575
wrapper.resources.licenses.issue(resource_id, fields)
4676
wrapper.resources.licenses.fetch(resource_id, license_id)
4777
wrapper.resources.licenses.modify(resource_id, license_id, fields)
4878
wrapper.resources.licenses.validate(resource_id, member_id, fields)
79+
```
4980

81+
### Purchases
82+
```
5083
wrapper.resources.purchases.list(resource_id, sort_options)
84+
wrapper.resources.purchases.list_all(resource_id, sort_options)
85+
wrapper.resources.purchases.list_until(resource_id, func, sort_options)
5186
wrapper.resources.purchases.fetch(resource_id, purchase_id)
87+
```
5288

89+
#### Reviews
90+
```
5391
wrapper.resources.reviews.list(resource_id, sort_options)
92+
wrapper.resources.reviews.list_all(resource_id, sort_options)
93+
wrapper.resources.reviews.list_until(resource_id, func, sort_options)
5494
wrapper.resources.reviews.fetch(resource_id, member_id)
5595
wrapper.resources.reviews.respond(resource_id, review_id, message)
96+
```
5697

98+
#### Updates
99+
```
57100
wrapper.resources.updates.list(resource_id, sort_options)
101+
wrapper.resources.updates.list_all(resource_id, sort_options)
102+
wrapper.resources.updates.list_until(resource_id, func, sort_options)
58103
wrapper.resources.updates.latest(resource_id)
59104
wrapper.resources.updates.fetch(resource_id, update_id)
60105
wrapper.resources.updates.delete(resource_id, update_id)
106+
```
61107

108+
#### Versions
109+
```
62110
wrapper.resources.versions.list(resource_id, sort_options)
111+
wrapper.resources.versions.list_all(resource_id, sort_options)
112+
wrapper.resources.versions.list_until(resource_id, func, sort_options)
63113
wrapper.resources.versions.latest(resource_id)
64114
wrapper.resources.versions.fetch(resource_id, version_id)
65115
wrapper.resources.versions.delete(resource_id, version_id)
116+
```
66117

67-
Threads:
118+
## Threads
119+
```
68120
wrapper.threads.list(sort_options)
121+
wrapper.threads.list_all(sort_options)
122+
wrapper.threads.list_until(func, sort_options)
69123
wrapper.threads.fetch(thread_id)
70124
wrapper.threads.list_replies(thread_id, sort_options)
125+
wrapper.threads.list_replies_all(thread_id, sort_options)
126+
wrapper.threads.list_replies_until(thread_id, func, sort_options)
71127
wrapper.threads.reply(thread_id, message)
72128
```

0 commit comments

Comments
 (0)