@devvit/public-api 0.11.18-next-2025-06-25-22-59-20-64e5118a3.0 → 0.11.18-next-2025-06-26-15-24-44-27ef5bd97.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/apis/reddit/models/User.d.ts +21 -0
  2. package/apis/reddit/models/User.d.ts.map +1 -1
  3. package/meta.json +2 -2
  4. package/meta.min.json +2 -2
  5. package/package.json +8 -8
  6. package/public-api.d.ts +21 -0
  7. package/public-api.iife.js +1 -1
  8. package/public-api.min.js.map +2 -2
package/apis/reddit/models/User.d.ts CHANGED
@@ -31,12 +31,33 @@ export type RemoveRelationshipOptions = {
31
31
  type: RelationshipType | 'moderator';
32
32
  };
33
33
  export type BanUserOptions = {
34
+ /**
35
+ * The username of the user you want to ban.
36
+ */
34
37
  username: string;
38
+ /**
39
+ * The name of the subreddit you want to ban the user from.
40
+ */
35
41
  subredditName: string;
42
+ /**
43
+ * The id of the post or comment you want to cite as rule breaking.
44
+ */
36
45
  context?: string;
46
+ /**
47
+ * The message to display to the user. (The "Note from the moderators:" in the ban message modmail.)
48
+ */
37
49
  message?: string;
50
+ /**
51
+ * The reason for the ban. This shows up in the Banned Users Menu.
52
+ */
38
53
  reason?: string;
54
+ /**
55
+ * The duration of the ban, in days. Use 0 for permanent; otherwise, it must be in the range of 1 to 999.
56
+ */
39
57
  duration?: number;
58
+ /**
59
+ * The reason to show in the modlog, and the UI's user notes. This isn't show to the user, just other moderators.
60
+ */
40
61
  note?: string;
41
62
  };
42
63
  export type BanWikiContributorOptions = {
package/apis/reddit/models/User.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"User.d.ts","sourceRoot":"","sources":["../../../../src/apis/reddit/models/User.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,6BAA6B,CAAC;AAOxD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAC7D,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAE5C,OAAO,KAAK,EAAE,mBAAmB,EAAwB,MAAM,cAAc,CAAC;AAC9E,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AACvD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,MAAM,MAAM,8BAA8B,GAAG,mBAAmB,GAAG;IACjE,aAAa,EAAE,MAAM,CAAC;IACtB,IAAI,EAAE,QAAQ,GAAG,OAAO,GAAG,YAAY,GAAG,cAAc,GAAG,kBAAkB,GAAG,YAAY,CAAC;IAC7F,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GACxB,kBAAkB,GAClB,aAAa,GACb,QAAQ,GACR,OAAO,GACP,YAAY,GACZ,iBAAiB,CAAC;AAEtB,MAAM,MAAM,mBAAmB,GAC3B,KAAK,GACL,MAAM,GACN,OAAO,GACP,QAAQ,GACR,MAAM,GACN,QAAQ,GACR,OAAO,GACP,eAAe,GACf,aAAa,GACb,UAAU,GACV,gBAAgB,CAAC;AAErB,MAAM,MAAM,yBAAyB,GAAG;IACtC,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,gBAAgB,CAAC;IACvB,yDAAyD;IACzD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,mBAAmB,EAAE,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,gBAAgB,GAAG,WAAW,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,eAAe,CAAC;IAC/C,SAAS,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,CAAC;IAC/D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,0BAAkB,cAAc;IAC9B,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,SAAS,cAAc;IACvB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,UAAU,eAAe;IACzB,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,OAAO,aAAa;IACpB,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,QAAQ,aAAa;IACrB,WAAW,gBAAgB;IAC3B,SAAS,cAAc;IACvB,YAAY,oBAAoB;IAChC,OAAO,YAAY;CACpB;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,cAAc,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAOF;;GAEG;AACH,qBAAa,IAAI;;IAwDf;;;OAGG;IACH,IAAI,EAAE,IAAI,IAAI,CAEb;IAED;;;OAGG;IACH,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,IAAI,CAEpB;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED;;OAEG;IACH,IAAI,YAAY,IAAI,MAAM,CAEzB;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,OAAO,CAElB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;OAEG;IACH,IAAI,cAAc,IAAI,GAAG,CAAC,MAAM,EAAE,mBAAmB,EAAE,CAAC,CAEvD;IAED;;OAEG;IACH,IAAI,GAAG,IAAI,MAAM,CAEhB;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED;;OAEG;IACH,IAAI,gBAAgB,IAAI,OAAO,CAE9B;IAED,MAAM,IAAI,IAAI,CAAC,IAAI,EAAE,IAAI,GAAG,UAAU,GAAG,WAAW,GAAG,WAAW,GAAG,cAAc,GAAG,MAAM,CAAC,GAAG;QAC9F,yBAAyB,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,EAAE,CAAC,CAAC;KAClE;IAYD;;;;;OAKG;IACG,6BAA6B,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;IA2B1F;;;;;;;;;OASG;IACH,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,wBAAwB,EAAE,UAAU,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAUlF;;;;;;;;;OASG;IACH,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC,qBAAqB,EAAE,UAAU,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAUzE;;;;;;;;;;;;OAYG;IACG,uBAAuB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC;IAWhF,eAAe,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAI9C;;;;;;;;OAQG;IACG,cAAc,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;CA4LlD"}
1
+ {"version":3,"file":"User.d.ts","sourceRoot":"","sources":["../../../../src/apis/reddit/models/User.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,6BAA6B,CAAC;AAOxD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAC7D,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAE5C,OAAO,KAAK,EAAE,mBAAmB,EAAwB,MAAM,cAAc,CAAC;AAC9E,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AACvD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,MAAM,MAAM,8BAA8B,GAAG,mBAAmB,GAAG;IACjE,aAAa,EAAE,MAAM,CAAC;IACtB,IAAI,EAAE,QAAQ,GAAG,OAAO,GAAG,YAAY,GAAG,cAAc,GAAG,kBAAkB,GAAG,YAAY,CAAC;IAC7F,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GACxB,kBAAkB,GAClB,aAAa,GACb,QAAQ,GACR,OAAO,GACP,YAAY,GACZ,iBAAiB,CAAC;AAEtB,MAAM,MAAM,mBAAmB,GAC3B,KAAK,GACL,MAAM,GACN,OAAO,GACP,QAAQ,GACR,MAAM,GACN,QAAQ,GACR,OAAO,GACP,eAAe,GACf,aAAa,GACb,UAAU,GACV,gBAAgB,CAAC;AAErB,MAAM,MAAM,yBAAyB,GAAG;IACtC,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,gBAAgB,CAAC;IACvB,yDAAyD;IACzD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,mBAAmB,EAAE,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,gBAAgB,GAAG,WAAW,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,eAAe,CAAC;IAC/C,SAAS,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,CAAC;IAC/D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,0BAAkB,cAAc;IAC9B,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,SAAS,cAAc;IACvB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,UAAU,eAAe;IACzB,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,OAAO,aAAa;IACpB,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,QAAQ,aAAa;IACrB,WAAW,gBAAgB;IAC3B,SAAS,cAAc;IACvB,YAAY,oBAAoB;IAChC,OAAO,YAAY;CACpB;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,cAAc,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAOF;;GAEG;AACH,qBAAa,IAAI;;IAwDf;;;OAGG;IACH,IAAI,EAAE,IAAI,IAAI,CAEb;IAED;;;OAGG;IACH,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,IAAI,CAEpB;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED;;OAEG;IACH,IAAI,YAAY,IAAI,MAAM,CAEzB;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,OAAO,CAElB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;OAEG;IACH,IAAI,cAAc,IAAI,GAAG,CAAC,MAAM,EAAE,mBAAmB,EAAE,CAAC,CAEvD;IAED;;OAEG;IACH,IAAI,GAAG,IAAI,MAAM,CAEhB;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED;;OAEG;IACH,IAAI,gBAAgB,IAAI,OAAO,CAE9B;IAED,MAAM,IAAI,IAAI,CAAC,IAAI,EAAE,IAAI,GAAG,UAAU,GAAG,WAAW,GAAG,WAAW,GAAG,cAAc,GAAG,MAAM,CAAC,GAAG;QAC9F,yBAAyB,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,EAAE,CAAC,CAAC;KAClE;IAYD;;;;;OAKG;IACG,6BAA6B,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;IA2B1F;;;;;;;;;OASG;IACH,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,wBAAwB,EAAE,UAAU,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAUlF;;;;;;;;;OASG;IACH,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC,qBAAqB,EAAE,UAAU,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAUzE;;;;;;;;;;;;OAYG;IACG,uBAAuB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC;IAWhF,eAAe,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAI9C;;;;;;;;OAQG;IACG,cAAc,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;CA4LlD"}
package/meta.json CHANGED
@@ -9201,7 +9201,7 @@
9201
9201
  "format": "esm"
9202
9202
  },
9203
9203
  "src/apis/reddit/models/User.ts": {
9204
- "bytes": 19738,
9204
+ "bytes": 20397,
9205
9205
  "imports": [
9206
9206
  {
9207
9207
  "path": "../shared-types/dist/Header.js",
@@ -10450,7 +10450,7 @@
10450
10450
  "bytesInOutput": 4418
10451
10451
  }
10452
10452
  },
10453
- "bytes": 12576370
10453
+ "bytes": 12577278
10454
10454
  }
10455
10455
  }
10456
10456
  }
package/meta.min.json CHANGED
@@ -1979,7 +1979,7 @@
1979
1979
  "format": "esm"
1980
1980
  },
1981
1981
  "src/apis/reddit/models/User.ts": {
1982
- "bytes": 19738,
1982
+ "bytes": 20397,
1983
1983
  "imports": [
1984
1984
  {
1985
1985
  "path": "../shared-types/dist/Header.js",
@@ -2557,7 +2557,7 @@
2557
2557
  "imports": [],
2558
2558
  "exports": [],
2559
2559
  "inputs": {},
2560
- "bytes": 1074020
2560
+ "bytes": 1074702
2561
2561
  },
2562
2562
  "dist/public-api.min.js": {
2563
2563
  "imports": [
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@devvit/public-api",
3
- "version": "0.11.18-next-2025-06-25-22-59-20-64e5118a3.0",
3
+ "version": "0.11.18-next-2025-06-26-15-24-44-27ef5bd97.0",
4
4
  "license": "BSD-3-Clause",
5
5
  "repository": {
6
6
  "type": "git",
@@ -30,18 +30,18 @@
30
30
  },
31
31
  "types": "./index.d.ts",
32
32
  "dependencies": {
33
- "@devvit/metrics": "0.11.18-next-2025-06-25-22-59-20-64e5118a3.0",
34
- "@devvit/protos": "0.11.18-next-2025-06-25-22-59-20-64e5118a3.0",
35
- "@devvit/shared": "0.11.18-next-2025-06-25-22-59-20-64e5118a3.0",
36
- "@devvit/shared-types": "0.11.18-next-2025-06-25-22-59-20-64e5118a3.0",
33
+ "@devvit/metrics": "0.11.18-next-2025-06-26-15-24-44-27ef5bd97.0",
34
+ "@devvit/protos": "0.11.18-next-2025-06-26-15-24-44-27ef5bd97.0",
35
+ "@devvit/shared": "0.11.18-next-2025-06-26-15-24-44-27ef5bd97.0",
36
+ "@devvit/shared-types": "0.11.18-next-2025-06-26-15-24-44-27ef5bd97.0",
37
37
  "base64-js": "1.5.1",
38
38
  "clone-deep": "4.0.1",
39
39
  "moderndash": "4.0.0"
40
40
  },
41
41
  "devDependencies": {
42
42
  "@ampproject/filesize": "4.3.0",
43
- "@devvit/repo-tools": "0.11.18-next-2025-06-25-22-59-20-64e5118a3.0",
44
- "@devvit/tsconfig": "0.11.18-next-2025-06-25-22-59-20-64e5118a3.0",
43
+ "@devvit/repo-tools": "0.11.18-next-2025-06-26-15-24-44-27ef5bd97.0",
44
+ "@devvit/tsconfig": "0.11.18-next-2025-06-26-15-24-44-27ef5bd97.0",
45
45
  "@microsoft/api-extractor": "7.41.0",
46
46
  "@reddit/faceplate-ui": "18.0.1",
47
47
  "@types/clone-deep": "4.0.1",
@@ -62,5 +62,5 @@
62
62
  }
63
63
  },
64
64
  "source": "./src/index.ts",
65
- "gitHead": "3e476a3aada9d043a65593a9234d4b46a7da686a"
65
+ "gitHead": "41b71a78b0e3b443876a98578293ea445f7bda7e"
66
66
  }
package/public-api.d.ts CHANGED
@@ -1485,12 +1485,33 @@ declare enum BanInfo_BanInfoAction {
1485
1485
  export declare type BannerHeight = 'small' | 'medium' | 'large';
1486
1486
 
1487
1487
  export declare type BanUserOptions = {
1488
+ /**
1489
+ * The username of the user you want to ban.
1490
+ */
1488
1491
  username: string;
1492
+ /**
1493
+ * The name of the subreddit you want to ban the user from.
1494
+ */
1489
1495
  subredditName: string;
1496
+ /**
1497
+ * The id of the post or comment you want to cite as rule breaking.
1498
+ */
1490
1499
  context?: string;
1500
+ /**
1501
+ * The message to display to the user. (The "Note from the moderators:" in the ban message modmail.)
1502
+ */
1491
1503
  message?: string;
1504
+ /**
1505
+ * The reason for the ban. This shows up in the Banned Users Menu.
1506
+ */
1492
1507
  reason?: string;
1508
+ /**
1509
+ * The duration of the ban, in days. Use 0 for permanent; otherwise, it must be in the range of 1 to 999.
1510
+ */
1493
1511
  duration?: number;
1512
+ /**
1513
+ * The reason to show in the modlog, and the UI's user notes. This isn't show to the user, just other moderators.
1514
+ */
1494
1515
  note?: string;
1495
1516
  };
1496
1517