Skip to content

Commit ac2b317

Browse files
authored
Update USAGE.md
1 parent d50e905 commit ac2b317

File tree

1 file changed

+48
-48
lines changed

1 file changed

+48
-48
lines changed

USAGE.md

+48-48
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Core Functions
44
```
55
wrapper.init(token)
6-
wrapper.get(endpoint, sort_options)
6+
wrapper.get(endpoint, ?sort_options)
77
wrapper.patch(endpoint, body)
88
wrapper.post(endpoint, body)
99
wrapper.delete(endpoint)
@@ -13,21 +13,21 @@ wrapper.ping()
1313

1414
## Alerts
1515
```
16-
wrapper.alerts.list(sort_options)
17-
wrapper.alerts.list_all(sort_options)
18-
wrapper.alerts.list_until(func, sort_options)
16+
wrapper.alerts.list(?sort_options)
17+
wrapper.alerts.list_all(?sort_options)
18+
wrapper.alerts.list_until(should_continue, ?sort_options)
1919
wrapper.alerts.mark_as_read()
2020
```
2121

2222
## Conversations
2323
```
24-
wrapper.conversations.list(sort_options)
25-
wrapper.conversations.list_all(sort_options)
26-
wrapper.conversations.list_until(func, sort_options)
24+
wrapper.conversations.list(?sort_options)
25+
wrapper.conversations.list_all(?sort_options)
26+
wrapper.conversations.list_until(should_continue, ?sort_options)
27+
wrapper.conversations.list_replies(conversation_id, ?sort_options)
28+
wrapper.conversations.list_replies_all(conversation_id, ?sort_options)
29+
wrapper.conversations.list_replies_until(conversation_id, should_continue, ?sort_options)
2730
wrapper.conversations.create(title, message, recipient_id)
28-
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)
3131
wrapper.conversations.reply(conversation_id, message)
3232
```
3333

@@ -36,93 +36,93 @@ wrapper.conversations.reply(conversation_id, message)
3636
wrapper.members.self()
3737
wrapper.members.fetch(member_id)
3838
39-
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)
39+
wrapper.member.profile_posts.list(?sort_options)
40+
wrapper.member.profile_posts.list_all(?sort_options)
41+
wrapper.member.profile_posts.list_until(should_continue, ?sort_options)
4242
wrapper.member.profile_posts.fetch(profile_post_id)
4343
wrapper.member.profile_posts.edit(profile_post_id, message)
4444
wrapper.member.profile_posts.delete(profile_post_id)
4545
```
4646

4747
## Resources
4848
```
49-
wrapper.resources.list(sort_options)
50-
wrapper.resources.list_owned(sort_options)
51-
wrapper.resources.list_owned_all(sort_options)
52-
wrapper.resources.list_owned_until(func, sort_options)
49+
wrapper.resources.list(?sort_options)
50+
wrapper.resources.list_owned(?sort_options)
51+
wrapper.resources.list_owned_all(?sort_options)
52+
wrapper.resources.list_owned_until(should_continue, ?sort_options)
5353
wrapper.resources.fetch(resource_id)
5454
wrapper.resources.edit(resource_id, fields)
5555
```
5656

5757
#### Downloads
5858
```
59-
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)
62-
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)
65-
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)
59+
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, should_continue, ?sort_options)
62+
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, should_continue, ?sort_options)
65+
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, should_continue, ?sort_options)
6868
```
6969

7070
#### Licenses
7171
```
72-
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)
72+
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, should_continue, ?sort_options)
7575
wrapper.resources.licenses.issue(resource_id, fields)
7676
wrapper.resources.licenses.fetch(resource_id, license_id)
7777
wrapper.resources.licenses.modify(resource_id, license_id, fields)
7878
wrapper.resources.licenses.validate(resource_id, member_id, fields)
7979
```
8080

81-
### Purchases
81+
#### Purchases
8282
```
83-
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)
83+
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, should_continue, ?sort_options)
8686
wrapper.resources.purchases.fetch(resource_id, purchase_id)
8787
```
8888

8989
#### Reviews
9090
```
91-
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)
91+
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, should_continue, ?sort_options)
9494
wrapper.resources.reviews.fetch(resource_id, member_id)
9595
wrapper.resources.reviews.respond(resource_id, review_id, message)
9696
```
9797

9898
#### Updates
9999
```
100-
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)
100+
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, should_continue, ?sort_options)
103103
wrapper.resources.updates.latest(resource_id)
104104
wrapper.resources.updates.fetch(resource_id, update_id)
105105
wrapper.resources.updates.delete(resource_id, update_id)
106106
```
107107

108108
#### Versions
109109
```
110-
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)
110+
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, should_continue, ?sort_options)
113113
wrapper.resources.versions.latest(resource_id)
114114
wrapper.resources.versions.fetch(resource_id, version_id)
115115
wrapper.resources.versions.delete(resource_id, version_id)
116116
```
117117

118118
## Threads
119119
```
120-
wrapper.threads.list(sort_options)
121-
wrapper.threads.list_all(sort_options)
122-
wrapper.threads.list_until(func, sort_options)
120+
wrapper.threads.list(?sort_options)
121+
wrapper.threads.list_all(?sort_options)
122+
wrapper.threads.list_until(should_continue, ?sort_options)
123+
wrapper.threads.list_replies(thread_id, ?sort_options)
124+
wrapper.threads.list_replies_all(thread_id, ?sort_options)
125+
wrapper.threads.list_replies_until(thread_id, should_continue, ?sort_options)
123126
wrapper.threads.fetch(thread_id)
124-
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)
127127
wrapper.threads.reply(thread_id, message)
128128
```

0 commit comments

Comments
 (0)