api.fluff4.me 1.0.1088 → 1.0.1091

package/index.d.ts

@@ -307,19 +307,32 @@ export interface CommentsResponse {
 	authors: AuthorMetadata[]
 }
 
-export interface Recommendations {
-	recommendations: Recommendation[]
-	works: WorkMetadata[]
+export interface ContextualCommentsResponse {
+	comments: ContextualComment[]
 	authors: AuthorMetadata[]
+	works: WorkMetadata[]
+	chapters: ChapterMetadata[]
 }
 
 export interface RecommendationsSearchSchema {
 	following_only?: boolean | null
 }
 
-export interface Recommendation {
-	recommendation: Comment
+export interface ContextualComment {
+	comment: Comment
+	root_object: CommentRootComment | CommentRootWork | CommentRootChapter | CommentRootWorkPrivate | CommentRootChapterPrivate
+	is_reply?: true | null
+}
+
+export interface CommentRootComment {
+	comment_id: string
+	type: "comment"
+}
+
+export interface CommentRootWork {
 	work: WorkReference
+	visibility: "Private" | "Public" | "Patreon"
+	type: "work"
 }
 
 export interface WorkReference {
@@ -327,6 +340,52 @@ export interface WorkReference {
 	vanity: string
 }
 
+export interface CommentRootChapter {
+	chapter: ChapterReference
+	visibility: "Private" | "Public" | "Patreon"
+	type: "chapter"
+}
+
+export interface ChapterReference {
+	author: string
+	work: string
+	url: string
+}
+
+export interface CommentRootWorkPrivate {
+	visibility: "Private"
+	type: "work_private"
+}
+
+export interface CommentRootChapterPrivate {
+	visibility: "Private"
+	type: "chapter_private"
+}
+
+export interface ChapterMetadata {
+	url: string
+	index_public?: number | null
+	name?: string | null
+	visibility: ChapterVisibility
+	word_count: number
+	time_last_update?: string | null
+	time_publish?: string | null
+	author: string
+	work: string
+	patreon?: PatreonRestriction | null
+	is_numbered: boolean
+	statistics?: ChapterStatistics | null
+}
+
+export type ChapterVisibility = "Private" | "Public" | "Patreon"
+
+export interface ChapterStatistics {
+	comment_count: number
+	reaction_count: number
+	read_count: number
+	visits: string
+}
+
 export interface Work {
 	name: string
 	description: string
@@ -451,15 +510,6 @@ export interface ChapterCreateBody {
 	work?: { status?: WorkStatus | null } | null
 }
 
-export type ChapterVisibility = "Private" | "Public" | "Patreon"
-
-export interface ChapterStatistics {
-	comment_count: number
-	reaction_count: number
-	read_count: number
-	visits: string
-}
-
 export interface SupporterReactions {
 	reaction_type: "heart"
 	author: string
@@ -520,21 +570,6 @@ export interface ChapterUpdateBody {
 	work?: { status?: WorkStatus | null } | null
 }
 
-export interface ChapterMetadata {
-	url: string
-	index_public?: number | null
-	name?: string | null
-	visibility: ChapterVisibility
-	word_count: number
-	time_last_update?: string | null
-	time_publish?: string | null
-	author: string
-	work: string
-	patreon?: PatreonRestriction | null
-	is_numbered: boolean
-	statistics?: ChapterStatistics | null
-}
-
 export type Chapters = ChapterMetadata[]
 
 export interface CampaignTierSetBody {
@@ -597,56 +632,6 @@ export interface RoleReorderBody {
 	roles: string[]
 }
 
-export interface AuthorCommentsResponse {
-	comments: AuthorComment[]
-	authors: AuthorMetadata[]
-	works: WorkMetadata[]
-	chapters: ChapterMetadata[]
-}
-
-export interface CommentGetAllAuthorSearch {
-	filter?: ("chapter" | "work") | null
-}
-
-export interface AuthorComment {
-	comment: Comment
-	root_object: CommentRootComment | CommentRootWork | CommentRootChapter | CommentRootWorkPrivate | CommentRootChapterPrivate
-	is_reply?: true | null
-}
-
-export interface CommentRootComment {
-	comment_id: string
-	type: "comment"
-}
-
-export interface CommentRootWork {
-	work: WorkReference
-	visibility: "Private" | "Public" | "Patreon"
-	type: "work"
-}
-
-export interface CommentRootChapter {
-	chapter: ChapterReference
-	visibility: "Private" | "Public" | "Patreon"
-	type: "chapter"
-}
-
-export interface ChapterReference {
-	author: string
-	work: string
-	url: string
-}
-
-export interface CommentRootWorkPrivate {
-	visibility: "Private"
-	type: "work_private"
-}
-
-export interface CommentRootChapterPrivate {
-	visibility: "Private"
-	type: "chapter_private"
-}
-
 export interface Tag {
 	name: string
 	description: TextBody
@@ -1111,7 +1096,7 @@ export interface Shelves {
 }
 
 export interface ShelvesPreviewResponse {
-	recommendations: Recommendation[]
+	comments: ContextualComment[]
 	shelves: ShelvesPreview[]
 	authors: AuthorMetadata[]
 	works: WorkMetadata[]
@@ -1361,7 +1346,7 @@ export interface Paths {
 		method: "get"
 		body?: undefined
 		search: RecommendationsSearchSchema & PaginationSearch
-		response: PaginatedResponse<Recommendations> | ErrorResponse
+		response: PaginatedResponse<ContextualCommentsResponse> | ErrorResponse
 	},
 	"/work/create": {
 		method: "post"
@@ -1834,20 +1819,20 @@ export interface Paths {
 	"/comments/author/{vanity}": {
 		method: "get"
 		body?: undefined
-		search: CommentGetAllAuthorSearch & PaginationSearch
-		response: PaginatedResponse<AuthorCommentsResponse> | ErrorResponse
+		search: PaginationSearch
+		response: PaginatedResponse<ContextualCommentsResponse> | ErrorResponse
 	},
 	"/comments/author/{vanity}/chapter": {
 		method: "get"
 		body?: undefined
 		search: PaginationSearch
-		response: PaginatedResponse<AuthorCommentsResponse> | ErrorResponse
+		response: PaginatedResponse<ContextualCommentsResponse> | ErrorResponse
 	},
 	"/comments/author/{vanity}/work": {
 		method: "get"
 		body?: undefined
 		search: PaginationSearch
-		response: PaginatedResponse<AuthorCommentsResponse> | ErrorResponse
+		response: PaginatedResponse<ContextualCommentsResponse> | ErrorResponse
 	},
 	"/patreon/campaign/tiers/get": {
 		method: "get"
@@ -2351,6 +2336,6 @@ export interface Paths {
 		method: "get"
 		body?: undefined
 		search: RecommendationsSearchSchema & PaginationSearch
-		response: PaginatedResponse<Recommendations> | ErrorResponse
+		response: PaginatedResponse<ContextualCommentsResponse> | ErrorResponse
 	},
 }

package/openapi.json

@@ -1855,13 +1855,19 @@
 					"authors"
 				]
 			},
-			"Recommendations": {
+			"ContextualCommentsResponse": {
 				"type": "object",
 				"properties": {
-					"recommendations": {
+					"comments": {
 						"type": "array",
 						"items": {
-							"$ref": "#/components/schema/Recommendation"
+							"$ref": "#/components/schema/ContextualComment"
+						}
+					},
+					"authors": {
+						"type": "array",
+						"items": {
+							"$ref": "#/components/schema/AuthorMetadata"
 						}
 					},
 					"works": {
@@ -1870,17 +1876,18 @@
 							"$ref": "#/components/schema/WorkMetadata"
 						}
 					},
-					"authors": {
+					"chapters": {
 						"type": "array",
 						"items": {
-							"$ref": "#/components/schema/AuthorMetadata"
+							"$ref": "#/components/schema/ChapterMetadata"
 						}
 					}
 				},
 				"required": [
-					"recommendations",
+					"comments",
+					"authors",
 					"works",
-					"authors"
+					"chapters"
 				]
 			},
 			"RecommendationsSearchSchema": {
@@ -1898,19 +1905,93 @@
 					}
 				}
 			},
-			"Recommendation": {
+			"ContextualComment": {
 				"type": "object",
 				"properties": {
-					"recommendation": {
+					"comment": {
 						"$ref": "#/components/schema/Comment"
 					},
+					"root_object": {
+						"anyOf": [
+							{
+								"$ref": "#/components/schema/CommentRootComment"
+							},
+							{
+								"$ref": "#/components/schema/CommentRootWork"
+							},
+							{
+								"$ref": "#/components/schema/CommentRootChapter"
+							},
+							{
+								"$ref": "#/components/schema/CommentRootWorkPrivate"
+							},
+							{
+								"$ref": "#/components/schema/CommentRootChapterPrivate"
+							}
+						]
+					},
+					"is_reply": {
+						"anyOf": [
+							{
+								"type": "boolean",
+								"enum": [
+									true
+								]
+							},
+							{
+								"type": "null"
+							}
+						]
+					}
+				},
+				"required": [
+					"comment",
+					"root_object"
+				]
+			},
+			"CommentRootComment": {
+				"type": "object",
+				"properties": {
+					"comment_id": {
+						"type": "string"
+					},
+					"type": {
+						"type": "string",
+						"enum": [
+							"comment"
+						]
+					}
+				},
+				"required": [
+					"comment_id",
+					"type"
+				]
+			},
+			"CommentRootWork": {
+				"type": "object",
+				"properties": {
 					"work": {
 						"$ref": "#/components/schema/WorkReference"
+					},
+					"visibility": {
+						"type": "string",
+						"enum": [
+							"Private",
+							"Public",
+							"Patreon"
+						]
+					},
+					"type": {
+						"type": "string",
+						"enum": [
+							"work"
+						]
 					}
 				},
 				"required": [
-					"recommendation",
-					"work"
+					"work",
+					"visibility",
+					"type"
 				]
 			},
 			"WorkReference": {
@@ -1928,6 +2009,218 @@
 					"vanity"
 				]
 			},
+			"CommentRootChapter": {
+				"type": "object",
+				"properties": {
+					"chapter": {
+						"$ref": "#/components/schema/ChapterReference"
+					},
+					"visibility": {
+						"type": "string",
+						"enum": [
+							"Private",
+							"Public",
+							"Patreon"
+						]
+					},
+					"type": {
+						"type": "string",
+						"enum": [
+							"chapter"
+						]
+					}
+				},
+				"required": [
+					"chapter",
+					"visibility",
+					"type"
+				]
+			},
+			"ChapterReference": {
+				"type": "object",
+				"properties": {
+					"author": {
+						"type": "string"
+					},
+					"work": {
+						"type": "string"
+					},
+					"url": {
+						"type": "string"
+					}
+				},
+				"required": [
+					"author",
+					"work",
+					"url"
+				]
+			},
+			"CommentRootWorkPrivate": {
+				"type": "object",
+				"properties": {
+					"visibility": {
+						"type": "string",
+						"enum": [
+							"Private"
+						]
+					},
+					"type": {
+						"type": "string",
+						"enum": [
+							"work_private"
+						]
+					}
+				},
+				"required": [
+					"visibility",
+					"type"
+				]
+			},
+			"CommentRootChapterPrivate": {
+				"type": "object",
+				"properties": {
+					"visibility": {
+						"type": "string",
+						"enum": [
+							"Private"
+						]
+					},
+					"type": {
+						"type": "string",
+						"enum": [
+							"chapter_private"
+						]
+					}
+				},
+				"required": [
+					"visibility",
+					"type"
+				]
+			},
+			"ChapterMetadata": {
+				"type": "object",
+				"properties": {
+					"url": {
+						"type": "string"
+					},
+					"index_public": {
+						"anyOf": [
+							{
+								"type": "number"
+							},
+							{
+								"type": "null"
+							}
+						]
+					},
+					"name": {
+						"anyOf": [
+							{
+								"type": "string",
+								"minLength": 1,
+								"maxLength": 256
+							},
+							{
+								"type": "null"
+							}
+						]
+					},
+					"visibility": {
+						"$ref": "#/components/schema/ChapterVisibility"
+					},
+					"word_count": {
+						"type": "number"
+					},
+					"time_last_update": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "null"
+							}
+						]
+					},
+					"time_publish": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "null"
+							}
+						]
+					},
+					"author": {
+						"type": "string"
+					},
+					"work": {
+						"type": "string"
+					},
+					"patreon": {
+						"anyOf": [
+							{
+								"$ref": "#/components/schema/PatreonRestriction"
+							},
+							{
+								"type": "null"
+							}
+						]
+					},
+					"is_numbered": {
+						"type": "boolean"
+					},
+					"statistics": {
+						"anyOf": [
+							{
+								"$ref": "#/components/schema/ChapterStatistics"
+							},
+							{
+								"type": "null"
+							}
+						]
+					}
+				},
+				"required": [
+					"url",
+					"visibility",
+					"word_count",
+					"author",
+					"work",
+					"is_numbered"
+				]
+			},
+			"ChapterVisibility": {
+				"type": "string",
+				"enum": [
+					"Private",
+					"Public",
+					"Patreon"
+				]
+			},
+			"ChapterStatistics": {
+				"type": "object",
+				"properties": {
+					"comment_count": {
+						"type": "number"
+					},
+					"reaction_count": {
+						"type": "number"
+					},
+					"read_count": {
+						"type": "number"
+					},
+					"visits": {
+						"type": "string"
+					}
+				},
+				"required": [
+					"comment_count",
+					"reaction_count",
+					"read_count",
+					"visits"
+				]
+			},
 			"Work": {
 				"type": "object",
 				"properties": {
@@ -2896,37 +3189,6 @@
 					"body"
 				]
 			},
-			"ChapterVisibility": {
-				"type": "string",
-				"enum": [
-					"Private",
-					"Public",
-					"Patreon"
-				]
-			},
-			"ChapterStatistics": {
-				"type": "object",
-				"properties": {
-					"comment_count": {
-						"type": "number"
-					},
-					"reaction_count": {
-						"type": "number"
-					},
-					"read_count": {
-						"type": "number"
-					},
-					"visits": {
-						"type": "string"
-					}
-				},
-				"required": [
-					"comment_count",
-					"reaction_count",
-					"read_count",
-					"visits"
-				]
-			},
 			"SupporterReactions": {
 				"type": "object",
 				"properties": {
@@ -3350,110 +3612,17 @@
 											},
 											{
 												"type": "null"
-											}
-										]
-									}
-								}
-							},
-							{
-								"type": "null"
-							}
-						]
-					}
-				}
-			},
-			"ChapterMetadata": {
-				"type": "object",
-				"properties": {
-					"url": {
-						"type": "string"
-					},
-					"index_public": {
-						"anyOf": [
-							{
-								"type": "number"
-							},
-							{
-								"type": "null"
-							}
-						]
-					},
-					"name": {
-						"anyOf": [
-							{
-								"type": "string",
-								"minLength": 1,
-								"maxLength": 256
-							},
-							{
-								"type": "null"
-							}
-						]
-					},
-					"visibility": {
-						"$ref": "#/components/schema/ChapterVisibility"
-					},
-					"word_count": {
-						"type": "number"
-					},
-					"time_last_update": {
-						"anyOf": [
-							{
-								"type": "string"
-							},
-							{
-								"type": "null"
-							}
-						]
-					},
-					"time_publish": {
-						"anyOf": [
-							{
-								"type": "string"
-							},
-							{
-								"type": "null"
-							}
-						]
-					},
-					"author": {
-						"type": "string"
-					},
-					"work": {
-						"type": "string"
-					},
-					"patreon": {
-						"anyOf": [
-							{
-								"$ref": "#/components/schema/PatreonRestriction"
-							},
-							{
-								"type": "null"
-							}
-						]
-					},
-					"is_numbered": {
-						"type": "boolean"
-					},
-					"statistics": {
-						"anyOf": [
-							{
-								"$ref": "#/components/schema/ChapterStatistics"
+											}
+										]
+									}
+								}
 							},
 							{
 								"type": "null"
 							}
 						]
 					}
-				},
-				"required": [
-					"url",
-					"visibility",
-					"word_count",
-					"author",
-					"work",
-					"is_numbered"
-				]
+				}
 			},
 			"Chapters": {
 				"type": "array",
@@ -3762,237 +3931,6 @@
 					"roles"
 				]
 			},
-			"AuthorCommentsResponse": {
-				"type": "object",
-				"properties": {
-					"comments": {
-						"type": "array",
-						"items": {
-							"$ref": "#/components/schema/AuthorComment"
-						}
-					},
-					"authors": {
-						"type": "array",
-						"items": {
-							"$ref": "#/components/schema/AuthorMetadata"
-						}
-					},
-					"works": {
-						"type": "array",
-						"items": {
-							"$ref": "#/components/schema/WorkMetadata"
-						}
-					},
-					"chapters": {
-						"type": "array",
-						"items": {
-							"$ref": "#/components/schema/ChapterMetadata"
-						}
-					}
-				},
-				"required": [
-					"comments",
-					"authors",
-					"works",
-					"chapters"
-				]
-			},
-			"CommentGetAllAuthorSearch": {
-				"type": "object",
-				"properties": {
-					"filter": {
-						"anyOf": [
-							{
-								"type": "string",
-								"enum": [
-									"chapter",
-									"work"
-								]
-							},
-							{
-								"type": "null"
-							}
-						]
-					}
-				}
-			},
-			"AuthorComment": {
-				"type": "object",
-				"properties": {
-					"comment": {
-						"$ref": "#/components/schema/Comment"
-					},
-					"root_object": {
-						"anyOf": [
-							{
-								"$ref": "#/components/schema/CommentRootComment"
-							},
-							{
-								"$ref": "#/components/schema/CommentRootWork"
-							},
-							{
-								"$ref": "#/components/schema/CommentRootChapter"
-							},
-							{
-								"$ref": "#/components/schema/CommentRootWorkPrivate"
-							},
-							{
-								"$ref": "#/components/schema/CommentRootChapterPrivate"
-							}
-						]
-					},
-					"is_reply": {
-						"anyOf": [
-							{
-								"type": "boolean",
-								"enum": [
-									true
-								]
-							},
-							{
-								"type": "null"
-							}
-						]
-					}
-				},
-				"required": [
-					"comment",
-					"root_object"
-				]
-			},
-			"CommentRootComment": {
-				"type": "object",
-				"properties": {
-					"comment_id": {
-						"type": "string"
-					},
-					"type": {
-						"type": "string",
-						"enum": [
-							"comment"
-						]
-					}
-				},
-				"required": [
-					"comment_id",
-					"type"
-				]
-			},
-			"CommentRootWork": {
-				"type": "object",
-				"properties": {
-					"work": {
-						"$ref": "#/components/schema/WorkReference"
-					},
-					"visibility": {
-						"type": "string",
-						"enum": [
-							"Private",
-							"Public",
-							"Patreon"
-						]
-					},
-					"type": {
-						"type": "string",
-						"enum": [
-							"work"
-						]
-					}
-				},
-				"required": [
-					"work",
-					"visibility",
-					"type"
-				]
-			},
-			"CommentRootChapter": {
-				"type": "object",
-				"properties": {
-					"chapter": {
-						"$ref": "#/components/schema/ChapterReference"
-					},
-					"visibility": {
-						"type": "string",
-						"enum": [
-							"Private",
-							"Public",
-							"Patreon"
-						]
-					},
-					"type": {
-						"type": "string",
-						"enum": [
-							"chapter"
-						]
-					}
-				},
-				"required": [
-					"chapter",
-					"visibility",
-					"type"
-				]
-			},
-			"ChapterReference": {
-				"type": "object",
-				"properties": {
-					"author": {
-						"type": "string"
-					},
-					"work": {
-						"type": "string"
-					},
-					"url": {
-						"type": "string"
-					}
-				},
-				"required": [
-					"author",
-					"work",
-					"url"
-				]
-			},
-			"CommentRootWorkPrivate": {
-				"type": "object",
-				"properties": {
-					"visibility": {
-						"type": "string",
-						"enum": [
-							"Private"
-						]
-					},
-					"type": {
-						"type": "string",
-						"enum": [
-							"work_private"
-						]
-					}
-				},
-				"required": [
-					"visibility",
-					"type"
-				]
-			},
-			"CommentRootChapterPrivate": {
-				"type": "object",
-				"properties": {
-					"visibility": {
-						"type": "string",
-						"enum": [
-							"Private"
-						]
-					},
-					"type": {
-						"type": "string",
-						"enum": [
-							"chapter_private"
-						]
-					}
-				},
-				"required": [
-					"visibility",
-					"type"
-				]
-			},
 			"Tag": {
 				"type": "object",
 				"properties": {
@@ -6541,10 +6479,10 @@
 			"ShelvesPreviewResponse": {
 				"type": "object",
 				"properties": {
-					"recommendations": {
+					"comments": {
 						"type": "array",
 						"items": {
-							"$ref": "#/components/schema/Recommendation"
+							"$ref": "#/components/schema/ContextualComment"
 						}
 					},
 					"shelves": {
@@ -6567,7 +6505,7 @@
 					}
 				},
 				"required": [
-					"recommendations",
+					"comments",
 					"shelves",
 					"authors",
 					"works"
@@ -7909,7 +7847,7 @@
 									"type": "object",
 									"properties": {
 										"data": {
-											"$ref": "#/components/schemas/Recommendations"
+											"$ref": "#/components/schemas/ContextualCommentsResponse"
 										},
 										"has_more": {
 											"type": "boolean"
@@ -11553,25 +11491,6 @@
 							"minimum": 1,
 							"maximum": 25
 						}
-					},
-					{
-						"name": "filter",
-						"in": "query",
-						"required": false,
-						"schema": {
-							"anyOf": [
-								{
-									"type": "string",
-									"enum": [
-										"chapter",
-										"work"
-									]
-								},
-								{
-									"type": "null"
-								}
-							]
-						}
 					}
 				],
 				"responses": {
@@ -11583,7 +11502,7 @@
 									"type": "object",
 									"properties": {
 										"data": {
-											"$ref": "#/components/schemas/AuthorCommentsResponse"
+											"$ref": "#/components/schemas/ContextualCommentsResponse"
 										},
 										"has_more": {
 											"type": "boolean"
@@ -11675,7 +11594,7 @@
 									"type": "object",
 									"properties": {
 										"data": {
-											"$ref": "#/components/schemas/AuthorCommentsResponse"
+											"$ref": "#/components/schemas/ContextualCommentsResponse"
 										},
 										"has_more": {
 											"type": "boolean"
@@ -11767,7 +11686,7 @@
 									"type": "object",
 									"properties": {
 										"data": {
-											"$ref": "#/components/schemas/AuthorCommentsResponse"
+											"$ref": "#/components/schemas/ContextualCommentsResponse"
 										},
 										"has_more": {
 											"type": "boolean"
@@ -15642,7 +15561,7 @@
 									"type": "object",
 									"properties": {
 										"data": {
-											"$ref": "#/components/schemas/Recommendations"
+											"$ref": "#/components/schemas/ContextualCommentsResponse"
 										},
 										"has_more": {
 											"type": "boolean"

package/package.json

@@ -1,5 +1,5 @@
 {
 	"name": "api.fluff4.me",
-	"version": "1.0.1088",
+	"version": "1.0.1091",
 	"types": "index.d.ts"
 }