Skip to content

Latest commit

 

History

History
205 lines (184 loc) · 40.9 KB

ugc.md

File metadata and controls

205 lines (184 loc) · 40.9 KB

Ugc Service Index

 

Operations

Admin Channel Wrapper: AdminChannel

Endpoint Method ID Class Wrapper Example
/ugc/v1/admin/namespaces/{namespace}/channels GET SingleAdminGetChannelShort SingleAdminGetChannelShort SingleAdminGetChannelShort SingleAdminGetChannelShort
/ugc/v1/admin/namespaces/{namespace}/channels POST AdminCreateChannelShort AdminCreateChannelShort AdminCreateChannelShort AdminCreateChannelShort
/ugc/v1/admin/namespaces/{namespace}/channels/{channelId} PUT SingleAdminUpdateChannelShort SingleAdminUpdateChannelShort SingleAdminUpdateChannelShort SingleAdminUpdateChannelShort
/ugc/v1/admin/namespaces/{namespace}/channels/{channelId} DELETE SingleAdminDeleteChannelShort SingleAdminDeleteChannelShort SingleAdminDeleteChannelShort SingleAdminDeleteChannelShort
/ugc/v1/admin/namespaces/{namespace}/users/{userId}/channels GET AdminGetChannelShort AdminGetChannelShort AdminGetChannelShort AdminGetChannelShort
/ugc/v1/admin/namespaces/{namespace}/users/{userId}/channels/{channelId} PUT AdminUpdateChannelShort AdminUpdateChannelShort AdminUpdateChannelShort AdminUpdateChannelShort
/ugc/v1/admin/namespaces/{namespace}/users/{userId}/channels/{channelId} DELETE AdminDeleteChannelShort AdminDeleteChannelShort AdminDeleteChannelShort AdminDeleteChannelShort

Admin Content Wrapper: AdminContent

Endpoint Method ID Class Wrapper Example
/ugc/v1/admin/namespaces/{namespace}/channels/{channelId}/contents POST AdminUploadContentDirectShort AdminUploadContentDirectShort AdminUploadContentDirectShort AdminUploadContentDirectShort
/ugc/v1/admin/namespaces/{namespace}/channels/{channelId}/contents/s3 POST AdminUploadContentS3Short AdminUploadContentS3Short AdminUploadContentS3Short AdminUploadContentS3Short
/ugc/v1/admin/namespaces/{namespace}/channels/{channelId}/contents/s3/{contentId} PUT SingleAdminUpdateContentS3Short SingleAdminUpdateContentS3Short SingleAdminUpdateContentS3Short SingleAdminUpdateContentS3Short
/ugc/v1/admin/namespaces/{namespace}/channels/{channelId}/contents/search GET AdminSearchChannelSpecificContentShort AdminSearchChannelSpecificContentShort AdminSearchChannelSpecificContentShort AdminSearchChannelSpecificContentShort
/ugc/v1/admin/namespaces/{namespace}/channels/{channelId}/contents/{contentId} PUT SingleAdminUpdateContentDirectShort SingleAdminUpdateContentDirectShort SingleAdminUpdateContentDirectShort SingleAdminUpdateContentDirectShort
/ugc/v1/admin/namespaces/{namespace}/channels/{channelId}/contents/{contentId} DELETE SingleAdminDeleteContentShort SingleAdminDeleteContentShort SingleAdminDeleteContentShort SingleAdminDeleteContentShort
/ugc/v1/admin/namespaces/{namespace}/contents GET SingleAdminGetContentShort SingleAdminGetContentShort SingleAdminGetContentShort SingleAdminGetContentShort
/ugc/v1/admin/namespaces/{namespace}/contents/search GET AdminSearchContentShort AdminSearchContentShort AdminSearchContentShort AdminSearchContentShort
/ugc/v1/admin/namespaces/{namespace}/contents/sharecodes/{shareCode} GET AdminGetUserContentByShareCodeShort AdminGetUserContentByShareCodeShort AdminGetUserContentByShareCodeShort AdminGetUserContentByShareCodeShort
/ugc/v1/admin/namespaces/{namespace}/contents/{contentId} GET AdminGetSpecificContentShort AdminGetSpecificContentShort AdminGetSpecificContentShort AdminGetSpecificContentShort
/ugc/v1/admin/namespaces/{namespace}/contents/{contentId}/preview GET AdminDownloadContentPreviewShort AdminDownloadContentPreviewShort AdminDownloadContentPreviewShort AdminDownloadContentPreviewShort
/ugc/v1/admin/namespaces/{namespace}/contents/{contentId}/screenshots PUT AdminUpdateScreenshotsShort AdminUpdateScreenshotsShort AdminUpdateScreenshotsShort AdminUpdateScreenshotsShort
/ugc/v1/admin/namespaces/{namespace}/contents/{contentId}/screenshots POST AdminUploadContentScreenshotShort AdminUploadContentScreenshotShort AdminUploadContentScreenshotShort AdminUploadContentScreenshotShort
/ugc/v1/admin/namespaces/{namespace}/contents/{contentId}/screenshots/{screenshotId} DELETE AdminDeleteContentScreenshotShort AdminDeleteContentScreenshotShort AdminDeleteContentScreenshotShort AdminDeleteContentScreenshotShort
/ugc/v1/admin/namespaces/{namespace}/users/{userId}/channels/{channelId}/contents/s3/{contentId} PUT AdminUpdateContentS3Short AdminUpdateContentS3Short AdminUpdateContentS3Short AdminUpdateContentS3Short
/ugc/v1/admin/namespaces/{namespace}/users/{userId}/channels/{channelId}/contents/{contentId} PUT AdminUpdateContentDirectShort AdminUpdateContentDirectShort AdminUpdateContentDirectShort AdminUpdateContentDirectShort
/ugc/v1/admin/namespaces/{namespace}/users/{userId}/channels/{channelId}/contents/{contentId} DELETE AdminDeleteContentShort AdminDeleteContentShort AdminDeleteContentShort AdminDeleteContentShort
/ugc/v1/admin/namespaces/{namespace}/users/{userId}/contents GET AdminGetContentShort AdminGetContentShort AdminGetContentShort AdminGetContentShort
/ugc/v1/admin/namespaces/{namespace}/users/{userId}/contents/{contentId}/hide PUT AdminHideUserContentShort AdminHideUserContentShort AdminHideUserContentShort AdminHideUserContentShort

Admin Group Wrapper: AdminGroup

Endpoint Method ID Class Wrapper Example
/ugc/v1/admin/namespaces/{namespace}/groups GET SingleAdminGetAllGroupsShort SingleAdminGetAllGroupsShort SingleAdminGetAllGroupsShort SingleAdminGetAllGroupsShort
/ugc/v1/admin/namespaces/{namespace}/groups POST AdminCreateGroupShort AdminCreateGroupShort AdminCreateGroupShort AdminCreateGroupShort
/ugc/v1/admin/namespaces/{namespace}/groups/{groupId} GET SingleAdminGetGroupShort SingleAdminGetGroupShort SingleAdminGetGroupShort SingleAdminGetGroupShort
/ugc/v1/admin/namespaces/{namespace}/groups/{groupId} PUT SingleAdminUpdateGroupShort SingleAdminUpdateGroupShort SingleAdminUpdateGroupShort SingleAdminUpdateGroupShort
/ugc/v1/admin/namespaces/{namespace}/groups/{groupId} DELETE SingleAdminDeleteGroupShort SingleAdminDeleteGroupShort SingleAdminDeleteGroupShort SingleAdminDeleteGroupShort
/ugc/v1/admin/namespaces/{namespace}/groups/{groupId}/contents GET SingleAdminGetGroupContentsShort SingleAdminGetGroupContentsShort SingleAdminGetGroupContentsShort SingleAdminGetGroupContentsShort
/ugc/v1/admin/namespaces/{namespace}/users/{userId}/groups GET AdminGetAllGroupsShort AdminGetAllGroupsShort AdminGetAllGroupsShort AdminGetAllGroupsShort
/ugc/v1/admin/namespaces/{namespace}/users/{userId}/groups/{groupId} GET AdminGetGroupShort AdminGetGroupShort AdminGetGroupShort AdminGetGroupShort
/ugc/v1/admin/namespaces/{namespace}/users/{userId}/groups/{groupId} PUT AdminUpdateGroupShort AdminUpdateGroupShort AdminUpdateGroupShort AdminUpdateGroupShort
/ugc/v1/admin/namespaces/{namespace}/users/{userId}/groups/{groupId} DELETE AdminDeleteGroupShort AdminDeleteGroupShort AdminDeleteGroupShort AdminDeleteGroupShort
/ugc/v1/admin/namespaces/{namespace}/users/{userId}/groups/{groupId}/contents GET AdminGetGroupContentsShort AdminGetGroupContentsShort AdminGetGroupContentsShort AdminGetGroupContentsShort

Admin Tag Wrapper: AdminTag

Endpoint Method ID Class Wrapper Example
/ugc/v1/admin/namespaces/{namespace}/tags GET AdminGetTagShort AdminGetTagShort AdminGetTagShort AdminGetTagShort
/ugc/v1/admin/namespaces/{namespace}/tags POST AdminCreateTagShort AdminCreateTagShort AdminCreateTagShort AdminCreateTagShort
/ugc/v1/admin/namespaces/{namespace}/tags/{tagId} PUT AdminUpdateTagShort AdminUpdateTagShort AdminUpdateTagShort AdminUpdateTagShort
/ugc/v1/admin/namespaces/{namespace}/tags/{tagId} DELETE AdminDeleteTagShort AdminDeleteTagShort AdminDeleteTagShort AdminDeleteTagShort

Admin Type Wrapper: AdminType

Endpoint Method ID Class Wrapper Example
/ugc/v1/admin/namespaces/{namespace}/types GET AdminGetTypeShort AdminGetTypeShort AdminGetTypeShort AdminGetTypeShort
/ugc/v1/admin/namespaces/{namespace}/types POST AdminCreateTypeShort AdminCreateTypeShort AdminCreateTypeShort AdminCreateTypeShort
/ugc/v1/admin/namespaces/{namespace}/types/{typeId} PUT AdminUpdateTypeShort AdminUpdateTypeShort AdminUpdateTypeShort AdminUpdateTypeShort
/ugc/v1/admin/namespaces/{namespace}/types/{typeId} DELETE AdminDeleteTypeShort AdminDeleteTypeShort AdminDeleteTypeShort AdminDeleteTypeShort

Anonymization Wrapper: Anonymization

Endpoint Method ID Class Wrapper Example
/ugc/v1/admin/namespaces/{namespace}/users/{userId}/channels DELETE AdminDeleteAllUserChannelsShort AdminDeleteAllUserChannelsShort AdminDeleteAllUserChannelsShort AdminDeleteAllUserChannelsShort
/ugc/v1/admin/namespaces/{namespace}/users/{userId}/contents DELETE AdminDeleteAllUserContentsShort AdminDeleteAllUserContentsShort AdminDeleteAllUserContentsShort AdminDeleteAllUserContentsShort
/ugc/v1/admin/namespaces/{namespace}/users/{userId}/groups DELETE AdminDeleteAllUserGroupShort AdminDeleteAllUserGroupShort AdminDeleteAllUserGroupShort AdminDeleteAllUserGroupShort
/ugc/v1/admin/namespaces/{namespace}/users/{userId}/states DELETE AdminDeleteAllUserStatesShort AdminDeleteAllUserStatesShort AdminDeleteAllUserStatesShort AdminDeleteAllUserStatesShort
/ugc/v1/public/namespaces/{namespace}/users/{userId}/channels DELETE DeleteAllUserChannelShort DeleteAllUserChannelShort DeleteAllUserChannelShort DeleteAllUserChannelShort
/ugc/v1/public/namespaces/{namespace}/users/{userId}/contents DELETE DeleteAllUserContentsShort DeleteAllUserContentsShort DeleteAllUserContentsShort DeleteAllUserContentsShort
/ugc/v1/public/namespaces/{namespace}/users/{userId}/groups DELETE DeleteAllUserGroupShort DeleteAllUserGroupShort DeleteAllUserGroupShort DeleteAllUserGroupShort
/ugc/v1/public/namespaces/{namespace}/users/{userId}/states DELETE DeleteAllUserStatesShort DeleteAllUserStatesShort DeleteAllUserStatesShort DeleteAllUserStatesShort

Public Content Wrapper: PublicContent

Endpoint Method ID Class Wrapper Example
/ugc/v1/public/namespaces/{namespace}/channels/{channelId}/contents GET SearchChannelSpecificContentShort SearchChannelSpecificContentShort SearchChannelSpecificContentShort SearchChannelSpecificContentShort
/ugc/v1/public/namespaces/{namespace}/contents GET PublicSearchContentShort PublicSearchContentShort PublicSearchContentShort PublicSearchContentShort
/ugc/v1/public/namespaces/{namespace}/contents/bulk POST PublicGetContentBulkShort PublicGetContentBulkShort PublicGetContentBulkShort PublicGetContentBulkShort
/ugc/v1/public/namespaces/{namespace}/contents/sharecodes/{shareCode} GET PublicDownloadContentByShareCodeShort PublicDownloadContentByShareCodeShort PublicDownloadContentByShareCodeShort PublicDownloadContentByShareCodeShort
/ugc/v1/public/namespaces/{namespace}/contents/{contentId} GET PublicDownloadContentByContentIDShort PublicDownloadContentByContentIDShort PublicDownloadContentByContentIDShort PublicDownloadContentByContentIDShort
/ugc/v1/public/namespaces/{namespace}/contents/{contentId}/preview GET PublicDownloadContentPreviewShort PublicDownloadContentPreviewShort PublicDownloadContentPreviewShort PublicDownloadContentPreviewShort
/ugc/v1/public/namespaces/{namespace}/users/{userId}/channels/{channelId}/contents POST CreateContentDirectShort CreateContentDirectShort CreateContentDirectShort CreateContentDirectShort
/ugc/v1/public/namespaces/{namespace}/users/{userId}/channels/{channelId}/contents/s3 POST CreateContentS3Short CreateContentS3Short CreateContentS3Short CreateContentS3Short
/ugc/v1/public/namespaces/{namespace}/users/{userId}/channels/{channelId}/contents/s3/{contentId} PUT UpdateContentS3Short UpdateContentS3Short UpdateContentS3Short UpdateContentS3Short
/ugc/v1/public/namespaces/{namespace}/users/{userId}/channels/{channelId}/contents/{contentId} PUT UpdateContentDirectShort UpdateContentDirectShort UpdateContentDirectShort UpdateContentDirectShort
/ugc/v1/public/namespaces/{namespace}/users/{userId}/channels/{channelId}/contents/{contentId} DELETE DeleteContentShort DeleteContentShort DeleteContentShort DeleteContentShort
/ugc/v1/public/namespaces/{namespace}/users/{userId}/contents GET PublicGetUserContentShort PublicGetUserContentShort PublicGetUserContentShort PublicGetUserContentShort
/ugc/v1/public/namespaces/{namespace}/users/{userId}/contents/{contentId}/screenshots PUT UpdateScreenshotsShort UpdateScreenshotsShort UpdateScreenshotsShort UpdateScreenshotsShort
/ugc/v1/public/namespaces/{namespace}/users/{userId}/contents/{contentId}/screenshots POST UploadContentScreenshotShort UploadContentScreenshotShort UploadContentScreenshotShort UploadContentScreenshotShort
/ugc/v1/public/namespaces/{namespace}/users/{userId}/contents/{contentId}/screenshots/{screenshotId} DELETE DeleteContentScreenshotShort DeleteContentScreenshotShort DeleteContentScreenshotShort DeleteContentScreenshotShort

Public Follow Wrapper: PublicFollow

Endpoint Method ID Class Wrapper Example
/ugc/v1/public/namespaces/{namespace}/contents/followed GET GetFollowedContentShort GetFollowedContentShort GetFollowedContentShort GetFollowedContentShort
/ugc/v1/public/namespaces/{namespace}/users/followed GET GetFollowedUsersShort GetFollowedUsersShort GetFollowedUsersShort GetFollowedUsersShort
/ugc/v1/public/namespaces/{namespace}/users/{userId}/follow PUT UpdateUserFollowStatusShort UpdateUserFollowStatusShort UpdateUserFollowStatusShort UpdateUserFollowStatusShort
/ugc/v1/public/namespaces/{namespace}/users/{userId}/followers GET GetPublicFollowersShort GetPublicFollowersShort GetPublicFollowersShort GetPublicFollowersShort
/ugc/v1/public/namespaces/{namespace}/users/{userId}/following GET GetPublicFollowingShort GetPublicFollowingShort GetPublicFollowingShort GetPublicFollowingShort

Public Like Wrapper: PublicLike

Endpoint Method ID Class Wrapper Example
/ugc/v1/public/namespaces/{namespace}/contents/liked GET GetLikedContentShort GetLikedContentShort GetLikedContentShort GetLikedContentShort
/ugc/v1/public/namespaces/{namespace}/contents/{contentId}/like PUT UpdateContentLikeStatusShort UpdateContentLikeStatusShort UpdateContentLikeStatusShort UpdateContentLikeStatusShort

Public Download Count Wrapper: PublicDownloadCount

Endpoint Method ID Class Wrapper Example
/ugc/v1/public/namespaces/{namespace}/contents/{contentId}/downloadcount POST AddDownloadCountShort AddDownloadCountShort AddDownloadCountShort AddDownloadCountShort

Public Tag Wrapper: PublicTag

Endpoint Method ID Class Wrapper Example
/ugc/v1/public/namespaces/{namespace}/tags GET GetTagShort GetTagShort GetTagShort GetTagShort

Public Type Wrapper: PublicType

Endpoint Method ID Class Wrapper Example
/ugc/v1/public/namespaces/{namespace}/types GET GetTypeShort GetTypeShort GetTypeShort GetTypeShort

Public Creator Wrapper: PublicCreator

Endpoint Method ID Class Wrapper Example
/ugc/v1/public/namespaces/{namespace}/users GET PublicSearchCreatorShort PublicSearchCreatorShort PublicSearchCreatorShort PublicSearchCreatorShort
/ugc/v1/public/namespaces/{namespace}/users/{userId} GET PublicGetCreatorShort PublicGetCreatorShort PublicGetCreatorShort PublicGetCreatorShort

Public Channel Wrapper: PublicChannel

Endpoint Method ID Class Wrapper Example
/ugc/v1/public/namespaces/{namespace}/users/{userId}/channels GET GetChannelsShort GetChannelsShort GetChannelsShort GetChannelsShort
/ugc/v1/public/namespaces/{namespace}/users/{userId}/channels POST CreateChannelShort CreateChannelShort CreateChannelShort CreateChannelShort
/ugc/v1/public/namespaces/{namespace}/users/{userId}/channels/{channelId} PUT UpdateChannelShort UpdateChannelShort UpdateChannelShort UpdateChannelShort
/ugc/v1/public/namespaces/{namespace}/users/{userId}/channels/{channelId} DELETE DeleteChannelShort DeleteChannelShort DeleteChannelShort DeleteChannelShort

Public Group Wrapper: PublicGroup

Endpoint Method ID Class Wrapper Example
/ugc/v1/public/namespaces/{namespace}/users/{userId}/groups GET GetGroupsShort GetGroupsShort GetGroupsShort GetGroupsShort
/ugc/v1/public/namespaces/{namespace}/users/{userId}/groups POST CreateGroupShort CreateGroupShort CreateGroupShort CreateGroupShort
/ugc/v1/public/namespaces/{namespace}/users/{userId}/groups/{groupId} GET GetGroupShort GetGroupShort GetGroupShort GetGroupShort
/ugc/v1/public/namespaces/{namespace}/users/{userId}/groups/{groupId} PUT UpdateGroupShort UpdateGroupShort UpdateGroupShort UpdateGroupShort
/ugc/v1/public/namespaces/{namespace}/users/{userId}/groups/{groupId} DELETE DeleteGroupShort DeleteGroupShort DeleteGroupShort DeleteGroupShort
/ugc/v1/public/namespaces/{namespace}/users/{userId}/groups/{groupId}/contents GET GetGroupContentShort GetGroupContentShort GetGroupContentShort GetGroupContentShort

 

Models

Model Struct Class
models.AddDownloadCountResponse ModelsAddDownloadCountResponse
models.ChannelRequest ModelsChannelRequest
models.ChannelResponse ModelsChannelResponse
models.ContentDownloadResponse ModelsContentDownloadResponse
models.ContentLikeRequest ModelsContentLikeRequest
models.ContentLikeResponse ModelsContentLikeResponse
models.CreateContentRequest ModelsCreateContentRequest
models.CreateContentRequestS3 ModelsCreateContentRequestS3
models.CreateContentResponse ModelsCreateContentResponse
models.CreateGroupRequest ModelsCreateGroupRequest
models.CreateGroupResponse ModelsCreateGroupResponse
models.CreateScreenshotRequest ModelsCreateScreenshotRequest
models.CreateScreenshotResponse ModelsCreateScreenshotResponse
models.CreateTagRequest ModelsCreateTagRequest
models.CreateTagResponse ModelsCreateTagResponse
models.CreateTypeRequest ModelsCreateTypeRequest
models.CreateTypeResponse ModelsCreateTypeResponse
models.CreatorFollowState ModelsCreatorFollowState
models.CreatorOverviewResponse ModelsCreatorOverviewResponse
models.CreatorResponse ModelsCreatorResponse
models.GetContentPreviewResponse ModelsGetContentPreviewResponse
models.HideContentRequest ModelsHideContentRequest
models.LikeState ModelsLikeState
models.PaginatedContentDownloadResponse ModelsPaginatedContentDownloadResponse
models.PaginatedCreatorOverviewResponse ModelsPaginatedCreatorOverviewResponse
models.PaginatedGetChannelResponse ModelsPaginatedGetChannelResponse
models.PaginatedGetTagResponse ModelsPaginatedGetTagResponse
models.PaginatedGetTypeResponse ModelsPaginatedGetTypeResponse
models.PaginatedGroupResponse ModelsPaginatedGroupResponse
models.PagingCursor ModelsPagingCursor
models.PayloadURL ModelsPayloadURL
models.PreviewURL ModelsPreviewURL
models.PublicGetContentBulkRequest ModelsPublicGetContentBulkRequest
models.ScreenshotResponse ModelsScreenshotResponse
models.UpdateScreenshotRequest ModelsUpdateScreenshotRequest
models.UpdateScreenshotResponse ModelsUpdateScreenshotResponse
models.UserFollowRequest ModelsUserFollowRequest
models.UserFollowResponse ModelsUserFollowResponse
models.createScreenshotRequestItem ModelsCreateScreenshotRequestItem
models.previewMetadata ModelsPreviewMetadata
models.updateScreenshot ModelsUpdateScreenshot
response.Error ResponseError