Skip to content
This repository was archived by the owner on Mar 28, 2021. It is now read-only.

Commit 29bc714

Browse files
metagnmetagn
committed
commit
1 parent cc0d5e5 commit 29bc714

5 files changed

Lines changed: 235 additions & 29 deletions

File tree

‎docs/reference/integrations/connections.rst‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
|stub| Connections
2+
==================
3+
4+
Get All Connections
5+
-------------------
6+
7+
Request
8+
~~~~~~~
9+
10+
.. code-block:: http
11+
12+
GET https://discordapp.com/api/users/@me/connections
13+
14+
Response
15+
~~~~~~~~
16+
17+
An array of connections. See `Connection Format`_.
18+
19+
20+
Connection Format
21+
-----------------
22+
23+
.. code-block:: json
24+
25+
{
26+
"type": "twitch",
27+
"name": "Twitch username",
28+
"id": "11223344",
29+
"integrations": [
30+
{
31+
"subscriber_count": 1,
32+
"syncing": false,
33+
"enable_emoticons": true,
34+
"expire_behavior": 0,
35+
"user": {
36+
"username": "Discord username",
37+
"discriminator": "1234",
38+
"id": "discord account ID",
39+
"avatar": "avatar ID"
40+
},
41+
"id": "integration ID",
42+
"expire_grace_period": 3,
43+
"account": {
44+
"id": "twitch ID",
45+
"name": "twitch username"
46+
},
47+
"name": "twitch username",
48+
"enabled": true,
49+
"role_id": "subscriber role ID",
50+
"synced_at": "2016-02-06T00:00:00.000000+00:00",
51+
"type": "twitch",
52+
},
53+
],
54+
}

‎docs/reference/integrations/general.rst‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
|stub| General
2+
==============
3+
4+
Get Server Integrations
5+
-----------------------
6+
7+
Request
8+
~~~~~~~
9+
10+
.. code-block:: http
11+
12+
GET https://discordapp.com/api/guilds/:guild_id/integrations
13+
14+
Response
15+
~~~~~~~~
16+
17+
An array of integration objects. See `Twitch Format`_ or `YouTube Gaming Format`_.
18+
19+
20+
21+
Delete Integration
22+
------------------
23+
24+
Request
25+
~~~~~~~
26+
27+
.. code-block:: http
28+
29+
DELETE https://discordapp.com/api/guilds/:guild_id/integrations/:integration_id
30+
31+
32+
33+
Edit Integration
34+
----------------
35+
36+
Request
37+
~~~~~~~
38+
39+
.. code-block:: http
40+
41+
PATCH https://discordapp.com/api/guilds/:guild_id/integrations/:integration_id
42+
43+
Parameters
44+
^^^^^^^^^^
45+
46+
- **enable_emoticons** (Optional): Enable in-chat emoticons associated with the integration (boolean).
47+
- **expire_behaviour** (Optional): How the integration will expire (integer).
48+
- **expire_grace_period** (Optional): Amount of days to ignore subscription expiration (integer).
49+
- **enable** (Optional): Enable the integration (boolean).
50+
51+
Response
52+
~~~~~~~~
53+
54+
See `Twitch Format`_ or `YouTube Gaming Format`_.
55+
56+
57+
Twitch Format
58+
-------------
59+
60+
.. code-block:: json
61+
62+
{
63+
{
64+
"subscriber_count": 1,
65+
"syncing": false,
66+
"enable_emoticons": true,
67+
"expire_behavior": 0,
68+
"user": {
69+
"username": "Discord username",
70+
"discriminator": "1234",
71+
"id": "discord account ID",
72+
"avatar": "avatar ID"
73+
},
74+
"id": "integration ID",
75+
"expire_grace_period": 3,
76+
"account": {
77+
"id": "twitch ID",
78+
"name": "twitch username"
79+
},
80+
"name": "twitch username",
81+
"enabled": true,
82+
"role_id": "subscriber role ID",
83+
"synced_at": "2016-02-06T00:00:00.000000+00:00",
84+
"type": "twitch",
85+
}
86+
}
87+
88+
YouTube Gaming Format
89+
---------------------
90+
91+
.. code-block:: json
92+
93+
{
94+
95+
}

‎docs/reference/integrations/index.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Integrations
2+
============
3+
4+
Using Discord's Integrations API

‎docs/reference/invites/invites.rst‎

Lines changed: 51 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -59,33 +59,7 @@ Parameters
5959
Response
6060
~~~~~~~~
6161

62-
.. code-block:: json
63-
64-
{
65-
"max_age": 86400,
66-
"code": "0cFbBdvaQwLBiyyI",
67-
"guild": {
68-
"id": "110451980584914944",
69-
"name": "Guild Name"
70-
},
71-
"revoked": false,
72-
"created_at": "2015-11-01T19:23:29.137000+00:00",
73-
"temporary": false,
74-
"uses": 0,
75-
"max_uses": 0,
76-
"inviter": {
77-
"username": "Person",
78-
"discriminator": "1849",
79-
"id": "112462135683509820",
80-
"avatar": null
81-
},
82-
"xkcdpass": null,
83-
"channel": {
84-
"type": "text",
85-
"id": "110453227215937536",
86-
"name": "Channel Name"
87-
}
88-
}
62+
See `Rich Invite Format`_.
8963

9064

9165

@@ -107,7 +81,7 @@ See `Basic Invite Format`_.
10781

10882

10983
Get Guild Invites
110-
-------------
84+
-----------------
11185

11286
Request
11387
~~~~~~~
@@ -119,7 +93,24 @@ Request
11993
Response
12094
~~~~~~~~
12195

122-
An array of invite objects. See `Basic Invite Format`_.
96+
An array of invite objects. See `Rich Invite Format`_.
97+
98+
99+
100+
Get Channel Invites
101+
-----------------
102+
103+
Request
104+
~~~~~~~
105+
106+
.. code-block:: http
107+
108+
GET https://discordapp.com/api/channels/:channel_id/invites
109+
110+
Response
111+
~~~~~~~~
112+
113+
An array of invite objects. See `Rich Invite Format`_.
123114

124115

125116

@@ -141,3 +132,34 @@ Basic Invite Format
141132
"name": "Channel Name"
142133
}
143134
}
135+
136+
Rich Invite Format
137+
------------------
138+
139+
.. code-block:: json
140+
141+
{
142+
"max_age": 86400,
143+
"code": "0cFbBdvaQwLBiyyI",
144+
"guild": {
145+
"id": "110451980584914944",
146+
"name": "Guild Name"
147+
},
148+
"revoked": false,
149+
"created_at": "2015-11-01T19:23:29.137000+00:00",
150+
"temporary": false,
151+
"uses": 0,
152+
"max_uses": 0,
153+
"inviter": {
154+
"username": "Person",
155+
"discriminator": "1849",
156+
"id": "112462135683509820",
157+
"avatar": null
158+
},
159+
"xkcdpass": null,
160+
"channel": {
161+
"type": "text",
162+
"id": "110453227215937536",
163+
"name": "Channel Name"
164+
}
165+
}

‎docs/reference/voice/general.rst‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,37 @@ An array of objects. Below is an example of a response with one location. There
3232
3333
3434
35+
Move Member
36+
-----------
37+
38+
Request
39+
~~~~~~~
40+
41+
.. code-block:: http
42+
43+
PATCH https://discordapp.com/api/guilds/:guild_id/members/:member_id
44+
45+
.. code-block:: json
46+
47+
{
48+
"channel_id": "111222333444555666"
49+
}
50+
51+
Parameters
52+
^^^^^^^^^^
53+
54+
- **channel_id** (Required): ID of the channel to move the member to.
55+
56+
Response
57+
~~~~~~~~
58+
59+
.. code-block:: json
60+
61+
{
62+
}
63+
64+
65+
3566
???
3667
---
3768

0 commit comments

Comments
 (0)