|
1 |
| -We assume the `wrapper` variable has been bound to. |
| 1 | +# Wrapper Usage |
2 | 2 |
|
| 3 | +## Core Functions |
3 | 4 | ```
|
4 |
| -Non-helper functions: |
5 |
| -wrapper.init(token) where token is an object with the fields 'type' and 'value'. |
| 5 | +wrapper.init(token) |
6 | 6 | wrapper.get(endpoint, sort_options)
|
7 | 7 | wrapper.patch(endpoint, body)
|
8 | 8 | wrapper.post(endpoint, body)
|
9 | 9 | wrapper.delete(endpoint)
|
10 | 10 | wrapper.health()
|
11 | 11 | wrapper.ping()
|
| 12 | +``` |
12 | 13 |
|
13 |
| -Alerts: |
| 14 | +## Alerts |
| 15 | +``` |
14 | 16 | wrapper.alerts.list(sort_options)
|
15 | 17 | wrapper.alerts.list_all(sort_options)
|
16 | 18 | wrapper.alerts.list_until(func, sort_options)
|
17 | 19 | wrapper.alerts.mark_as_read()
|
| 20 | +``` |
18 | 21 |
|
19 |
| -Conversations: |
| 22 | +## Conversations |
| 23 | +``` |
20 | 24 | wrapper.conversations.list(sort_options)
|
| 25 | +wrapper.conversations.list_all(sort_options) |
| 26 | +wrapper.conversations.list_until(func, sort_options) |
21 | 27 | wrapper.conversations.create(title, message, recipient_id)
|
22 | 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) |
23 | 31 | wrapper.conversations.reply(conversation_id, message)
|
| 32 | +``` |
24 | 33 |
|
25 |
| -Members: |
| 34 | +## Members |
| 35 | +``` |
26 | 36 | wrapper.members.self()
|
27 | 37 | wrapper.members.fetch(member_id)
|
28 | 38 |
|
29 | 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) |
30 | 42 | wrapper.member.profile_posts.fetch(profile_post_id)
|
31 | 43 | wrapper.member.profile_posts.edit(profile_post_id, message)
|
32 | 44 | wrapper.member.profile_posts.delete(profile_post_id)
|
| 45 | +``` |
33 | 46 |
|
34 |
| -Resources: |
| 47 | +## Resources |
| 48 | +``` |
35 | 49 | wrapper.resources.list(sort_options)
|
36 | 50 | wrapper.resources.list_owned(sort_options)
|
| 51 | +wrapper.resources.list_owned_all(sort_options) |
| 52 | +wrapper.resources.list_owned_until(func, sort_options) |
37 | 53 | wrapper.resources.fetch(resource_id)
|
38 | 54 | wrapper.resources.edit(resource_id, fields)
|
| 55 | +``` |
39 | 56 |
|
| 57 | +#### Downloads |
| 58 | +``` |
40 | 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) |
41 | 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) |
42 | 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) |
| 68 | +``` |
43 | 69 |
|
| 70 | +#### Licenses |
| 71 | +``` |
44 | 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) |
45 | 75 | wrapper.resources.licenses.issue(resource_id, fields)
|
46 | 76 | wrapper.resources.licenses.fetch(resource_id, license_id)
|
47 | 77 | wrapper.resources.licenses.modify(resource_id, license_id, fields)
|
48 | 78 | wrapper.resources.licenses.validate(resource_id, member_id, fields)
|
| 79 | +``` |
49 | 80 |
|
| 81 | +### Purchases |
| 82 | +``` |
50 | 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) |
51 | 86 | wrapper.resources.purchases.fetch(resource_id, purchase_id)
|
| 87 | +``` |
52 | 88 |
|
| 89 | +#### Reviews |
| 90 | +``` |
53 | 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) |
54 | 94 | wrapper.resources.reviews.fetch(resource_id, member_id)
|
55 | 95 | wrapper.resources.reviews.respond(resource_id, review_id, message)
|
| 96 | +``` |
56 | 97 |
|
| 98 | +#### Updates |
| 99 | +``` |
57 | 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) |
58 | 103 | wrapper.resources.updates.latest(resource_id)
|
59 | 104 | wrapper.resources.updates.fetch(resource_id, update_id)
|
60 | 105 | wrapper.resources.updates.delete(resource_id, update_id)
|
| 106 | +``` |
61 | 107 |
|
| 108 | +#### Versions |
| 109 | +``` |
62 | 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) |
63 | 113 | wrapper.resources.versions.latest(resource_id)
|
64 | 114 | wrapper.resources.versions.fetch(resource_id, version_id)
|
65 | 115 | wrapper.resources.versions.delete(resource_id, version_id)
|
| 116 | +``` |
66 | 117 |
|
67 |
| -Threads: |
| 118 | +## Threads |
| 119 | +``` |
68 | 120 | wrapper.threads.list(sort_options)
|
| 121 | +wrapper.threads.list_all(sort_options) |
| 122 | +wrapper.threads.list_until(func, sort_options) |
69 | 123 | wrapper.threads.fetch(thread_id)
|
70 | 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) |
71 | 127 | wrapper.threads.reply(thread_id, message)
|
72 | 128 | ```
|
0 commit comments