Files
social-media/shared/openapi/openapi.json

5174 lines
131 KiB
JSON

{
"x-generator": "NSwag v14.2.0.0 (NJsonSchema v11.1.0.0 (Newtonsoft.Json v13.0.0.0))",
"openapi": "3.0.0",
"info": {
"title": "Socialize API",
"version": "v1"
},
"servers": [
{
"url": "http://localhost:5080"
}
],
"paths": {
"/api/storage": {
"get": {
"operationId": "GetApiStorage",
"parameters": [
{
"name": "blobPath",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"x-position": 1
}
],
"responses": {
"200": {
"description": ""
}
}
}
},
"/api/workspaces/{id}/logo": {
"post": {
"tags": [
"Workspaces",
"Api"
],
"operationId": "SocializeApiModulesWorkspacesHandlersChangeWorkspaceLogoHandler",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"x-name": "ChangeWorkspaceLogoRequest",
"description": "",
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesWorkspacesHandlersChangeWorkspaceLogoRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesWorkspacesHandlersChangeWorkspaceLogoResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/FastEndpointsErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/workspaces": {
"post": {
"tags": [
"Workspaces",
"Api"
],
"operationId": "SocializeApiModulesWorkspacesHandlersCreateWorkspaceHandler",
"requestBody": {
"x-name": "CreateWorkspaceRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesWorkspacesHandlersCreateWorkspaceRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesWorkspacesHandlersWorkspaceDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/FastEndpointsErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
},
"get": {
"tags": [
"Workspaces",
"Api"
],
"operationId": "SocializeApiModulesWorkspacesHandlersGetWorkspacesHandler",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SocializeApiModulesWorkspacesHandlersWorkspaceDto"
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/workspaces/{workspaceId}/invites": {
"post": {
"tags": [
"Workspaces",
"Api"
],
"operationId": "SocializeApiModulesWorkspacesHandlersCreateWorkspaceInviteHandler",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "guid"
}
}
],
"requestBody": {
"x-name": "CreateWorkspaceInviteRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesWorkspacesHandlersCreateWorkspaceInviteRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesWorkspacesHandlersWorkspaceInviteDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/FastEndpointsErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
},
"get": {
"tags": [
"Workspaces",
"Api"
],
"operationId": "SocializeApiModulesWorkspacesHandlersGetWorkspaceInvitesHandler",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "guid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SocializeApiModulesWorkspacesHandlersWorkspaceInviteDto"
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/workspaces/{workspaceId}/members": {
"get": {
"tags": [
"Workspaces",
"Api"
],
"operationId": "SocializeApiModulesWorkspacesHandlersGetWorkspaceMembersHandler",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "guid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SocializeApiModulesWorkspacesHandlersWorkspaceMemberDto"
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/workspaces/{id}": {
"put": {
"tags": [
"Workspaces",
"Api"
],
"operationId": "SocializeApiModulesWorkspacesHandlersUpdateWorkspaceHandler",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"x-name": "UpdateWorkspaceRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesWorkspacesHandlersUpdateWorkspaceRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesWorkspacesHandlersWorkspaceDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/FastEndpointsErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/organizations/{organizationId}": {
"get": {
"tags": [
"Organizations",
"Api"
],
"operationId": "SocializeApiModulesOrganizationsHandlersGetOrganizationHandler",
"parameters": [
{
"name": "organizationId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "guid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesOrganizationsHandlersOrganizationDto"
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/organizations": {
"get": {
"tags": [
"Organizations",
"Api"
],
"operationId": "SocializeApiModulesOrganizationsHandlersGetOrganizationsHandler",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SocializeApiModulesOrganizationsHandlersOrganizationDto"
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/notifications": {
"get": {
"tags": [
"Notifications",
"Api"
],
"operationId": "SocializeApiModulesNotificationsHandlersGetNotificationsHandler",
"parameters": [
{
"name": "workspaceId",
"in": "query",
"schema": {
"type": "string",
"format": "guid",
"nullable": true
}
},
{
"name": "contentItemId",
"in": "query",
"schema": {
"type": "string",
"format": "guid",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SocializeApiModulesNotificationsHandlersNotificationEventDto"
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/notifications/{id}/read": {
"post": {
"tags": [
"Notifications",
"Api"
],
"operationId": "SocializeApiModulesNotificationsHandlersMarkNotificationAsReadHandler",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/users/address": {
"post": {
"tags": [
"Users",
"Api"
],
"operationId": "SocializeApiModulesIdentityHandlersChangeAddressHandler",
"requestBody": {
"x-name": "ChangeAddressRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesIdentityHandlersChangeAddressRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/users/alias": {
"post": {
"tags": [
"Users",
"Api"
],
"operationId": "SocializeApiModulesIdentityHandlersChangeAliasHandler",
"requestBody": {
"x-name": "ChangeAliasRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesIdentityHandlersChangeAliasRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/users/birthdate": {
"post": {
"tags": [
"Users",
"Api"
],
"operationId": "SocializeApiModulesIdentityHandlersChangeBirthDateHandler",
"requestBody": {
"x-name": "ChangeBirthDateRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesIdentityHandlersChangeBirthDateRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/users/email": {
"post": {
"tags": [
"Users",
"Api"
],
"operationId": "SocializeApiModulesIdentityHandlersChangeEmailHandler",
"requestBody": {
"x-name": "ChangeEmailRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesIdentityHandlersChangeEmailRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/users/fullname": {
"post": {
"tags": [
"Users",
"Api"
],
"operationId": "SocializeApiModulesIdentityHandlersChangeFullnameHandler",
"requestBody": {
"x-name": "ChangeFullnameRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesIdentityHandlersChangeFullnameRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/users/phone": {
"post": {
"tags": [
"Users",
"Api"
],
"operationId": "SocializeApiModulesIdentityHandlersChangePhoneHandler",
"requestBody": {
"x-name": "ChangePhoneRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesIdentityHandlersChangePhoneRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/users/portrait": {
"post": {
"tags": [
"Users",
"Api"
],
"operationId": "SocializeApiModulesIdentityHandlersChangePortraitHandler",
"requestBody": {
"x-name": "ChangePortraitRequest",
"description": "",
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesIdentityHandlersChangePortraitRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesIdentityHandlersChangePortraitResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/FastEndpointsErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
},
"get": {
"tags": [
"Users",
"Api"
],
"operationId": "SocializeApiModulesIdentityHandlersGetCurrentUserPortraitHandler",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SystemIOStream"
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/users/forgot-password": {
"post": {
"tags": [
"Users",
"Api"
],
"operationId": "SocializeApiModulesIdentityHandlersForgotPasswordHandler",
"requestBody": {
"x-name": "ForgotPasswordRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesIdentityHandlersForgotPasswordRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/api/users/profile": {
"get": {
"tags": [
"Memberships",
"Api"
],
"operationId": "SocializeApiModulesIdentityHandlersGetCurrentUserQueryHandler",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesIdentityModelsUserDto"
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/users/login": {
"post": {
"tags": [
"Users",
"Api"
],
"operationId": "SocializeApiModulesIdentityHandlersLoginHandler",
"requestBody": {
"x-name": "LoginRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesIdentityHandlersLoginRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesIdentityHandlersLoginResponse"
}
}
}
}
}
}
},
"/api/users/login-with-facebook": {
"post": {
"tags": [
"Users",
"Api"
],
"operationId": "SocializeApiModulesIdentityHandlersLoginWithFacebookHandler",
"requestBody": {
"x-name": "LoginWithFacebookRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesIdentityHandlersLoginWithFacebookRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesIdentityHandlersLoginWithFacebookResponse"
}
}
}
}
}
}
},
"/api/users/login-with-google": {
"post": {
"tags": [
"Users",
"Api"
],
"operationId": "SocializeApiModulesIdentityHandlersLoginWithGoogleHandler",
"requestBody": {
"x-name": "LoginWithGoogleRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesIdentityHandlersLoginWithGoogleRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesIdentityHandlersLoginWithGoogleResponse"
}
}
}
}
}
}
},
"/api/users/refresh": {
"post": {
"tags": [
"Users",
"Api"
],
"operationId": "SocializeApiModulesIdentityHandlersRefreshTokenHandler",
"requestBody": {
"x-name": "RefreshTokenRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesIdentityHandlersRefreshTokenRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesIdentityHandlersRefreshTokenResponse"
}
}
}
}
}
}
},
"/api/users/register": {
"post": {
"tags": [
"Users",
"Api"
],
"operationId": "SocializeApiModulesIdentityHandlersRegisterHandler",
"requestBody": {
"x-name": "RegisterRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesIdentityHandlersRegisterRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesIdentityHandlersRegisterResponse"
}
}
}
}
}
}
},
"/api/users/resend-verification": {
"post": {
"tags": [
"Users",
"Api"
],
"operationId": "SocializeApiModulesIdentityHandlersResendVerificationHandler",
"requestBody": {
"x-name": "ResendVerificationRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesIdentityHandlersResendVerificationRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesIdentityHandlersResendVerificationResponse"
}
}
}
}
}
}
},
"/api/users/reset-password": {
"post": {
"tags": [
"Users",
"Api"
],
"operationId": "SocializeApiModulesIdentityHandlersResetPasswordHandler",
"requestBody": {
"x-name": "ResetPasswordRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesIdentityHandlersResetPasswordRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/api/users/set-password": {
"post": {
"tags": [
"Users",
"Api"
],
"operationId": "SocializeApiModulesIdentityHandlersSetPasswordHandler",
"requestBody": {
"x-name": "SetPasswordRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesIdentityHandlersSetPasswordRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/users/verify-email": {
"get": {
"tags": [
"Users",
"Api"
],
"operationId": "SocializeApiModulesIdentityHandlersVerifyEmailHandler",
"parameters": [
{
"name": "userId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesIdentityHandlersVerifyEmailResponse"
}
}
}
}
}
}
},
"/api/feedback/{id}/comments": {
"post": {
"tags": [
"Feedback",
"Api"
],
"operationId": "SocializeApiModulesFeedbackHandlersAddDeveloperFeedbackCommentHandler",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"x-name": "AddFeedbackCommentRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesFeedbackHandlersAddFeedbackCommentRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesFeedbackContractsFeedbackTimelineItemDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/FastEndpointsErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
}
},
"security": [
{
"JWTBearerAuth": [
"developer"
]
}
]
}
},
"/api/my-feedback/{id}/comments": {
"post": {
"tags": [
"Feedback",
"Api"
],
"operationId": "SocializeApiModulesFeedbackHandlersAddMyFeedbackCommentHandler",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"x-name": "AddFeedbackCommentRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesFeedbackHandlersAddFeedbackCommentRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesFeedbackContractsFeedbackTimelineItemDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/FastEndpointsErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/my-feedback/{id}/screenshot": {
"post": {
"tags": [
"Feedback",
"Api"
],
"operationId": "SocializeApiModulesFeedbackHandlersAttachMyFeedbackScreenshotHandler",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"x-name": "AttachMyFeedbackScreenshotRequest",
"description": "",
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesFeedbackHandlersAttachMyFeedbackScreenshotRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesFeedbackContractsFeedbackReportDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/FastEndpointsErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/my-feedback/{id}/cancel": {
"post": {
"tags": [
"Feedback",
"Api"
],
"operationId": "SocializeApiModulesFeedbackHandlersCancelMyFeedbackHandler",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"x-name": "CancelMyFeedbackRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesFeedbackHandlersCancelMyFeedbackRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesFeedbackContractsFeedbackReportDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/FastEndpointsErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/feedback/{id}": {
"get": {
"tags": [
"Feedback",
"Api"
],
"operationId": "SocializeApiModulesFeedbackHandlersGetDeveloperFeedbackHandler",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesFeedbackContractsFeedbackReportDto"
}
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
}
},
"security": [
{
"JWTBearerAuth": [
"developer"
]
}
]
},
"patch": {
"tags": [
"Feedback",
"Api"
],
"operationId": "SocializeApiModulesFeedbackHandlersUpdateDeveloperFeedbackHandler",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"x-name": "UpdateDeveloperFeedbackRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesFeedbackHandlersUpdateDeveloperFeedbackRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesFeedbackContractsFeedbackReportDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/FastEndpointsErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
}
},
"security": [
{
"JWTBearerAuth": [
"developer"
]
}
]
}
},
"/api/feedback/{id}/timeline": {
"get": {
"tags": [
"Feedback",
"Api"
],
"operationId": "SocializeApiModulesFeedbackHandlersGetDeveloperFeedbackTimelineHandler",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SocializeApiModulesFeedbackContractsFeedbackTimelineItemDto"
}
}
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
}
},
"security": [
{
"JWTBearerAuth": [
"developer"
]
}
]
}
},
"/api/feedback/{id}/screenshot": {
"get": {
"tags": [
"Feedback",
"Api"
],
"operationId": "SocializeApiModulesFeedbackHandlersGetFeedbackScreenshotHandler",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SystemIOStream"
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/my-feedback/{id}": {
"get": {
"tags": [
"Feedback",
"Api"
],
"operationId": "SocializeApiModulesFeedbackHandlersGetMyFeedbackHandler",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesFeedbackContractsFeedbackReportDto"
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/my-feedback/{id}/timeline": {
"get": {
"tags": [
"Feedback",
"Api"
],
"operationId": "SocializeApiModulesFeedbackHandlersGetMyFeedbackTimelineHandler",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SocializeApiModulesFeedbackContractsFeedbackTimelineItemDto"
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/feedback": {
"get": {
"tags": [
"Feedback",
"Api"
],
"operationId": "SocializeApiModulesFeedbackHandlersListDeveloperFeedbackHandler",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SocializeApiModulesFeedbackContractsFeedbackReportDto"
}
}
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
}
},
"security": [
{
"JWTBearerAuth": [
"developer"
]
}
]
},
"post": {
"tags": [
"Feedback",
"Api"
],
"operationId": "SocializeApiModulesFeedbackHandlersSubmitFeedbackHandler",
"requestBody": {
"x-name": "SubmitFeedbackRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesFeedbackHandlersSubmitFeedbackRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesFeedbackContractsFeedbackReportDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/FastEndpointsErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/feedback/tags": {
"get": {
"tags": [
"Feedback",
"Api"
],
"operationId": "SocializeApiModulesFeedbackHandlersListFeedbackTagsHandler",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
}
},
"security": [
{
"JWTBearerAuth": [
"developer"
]
}
]
}
},
"/api/my-feedback": {
"get": {
"tags": [
"Feedback",
"Api"
],
"operationId": "SocializeApiModulesFeedbackHandlersListMyFeedbackHandler",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SocializeApiModulesFeedbackContractsFeedbackReportDto"
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/content-items": {
"post": {
"tags": [
"Content Items",
"Api"
],
"operationId": "SocializeApiModulesContentItemsHandlersCreateContentItemHandler",
"requestBody": {
"x-name": "CreateContentItemRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesContentItemsHandlersCreateContentItemRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesContentItemsHandlersContentItemDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/FastEndpointsErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
},
"get": {
"tags": [
"Content Items",
"Api"
],
"operationId": "SocializeApiModulesContentItemsHandlersGetContentItemsHandler",
"parameters": [
{
"name": "workspaceId",
"in": "query",
"schema": {
"type": "string",
"format": "guid",
"nullable": true
}
},
{
"name": "clientId",
"in": "query",
"schema": {
"type": "string",
"format": "guid",
"nullable": true
}
},
{
"name": "campaignId",
"in": "query",
"schema": {
"type": "string",
"format": "guid",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SocializeApiModulesContentItemsHandlersContentItemDto"
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/content-items/{id}/revisions": {
"post": {
"tags": [
"Content Items",
"Api"
],
"operationId": "SocializeApiModulesContentItemsHandlersCreateContentItemRevisionHandler",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"x-name": "CreateContentItemRevisionRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesContentItemsHandlersCreateContentItemRevisionRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesContentItemsHandlersContentItemRevisionDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/FastEndpointsErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
},
"get": {
"tags": [
"Content Items",
"Api"
],
"operationId": "SocializeApiModulesContentItemsHandlersGetContentItemRevisionsHandler",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SocializeApiModulesContentItemsHandlersContentItemRevisionDto"
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/content-items/{id}": {
"get": {
"tags": [
"Content Items",
"Api"
],
"operationId": "SocializeApiModulesContentItemsHandlersGetContentItemHandler",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesContentItemsHandlersContentItemDetailDto"
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/content-items/{id}/status": {
"post": {
"tags": [
"Content Items",
"Api"
],
"operationId": "SocializeApiModulesContentItemsHandlersUpdateContentItemStatusHandler",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"x-name": "UpdateContentItemStatusRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesContentItemsHandlersUpdateContentItemStatusRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesContentItemsHandlersContentItemDetailDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/FastEndpointsErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/comments": {
"post": {
"tags": [
"Comments",
"Api"
],
"operationId": "SocializeApiModulesCommentsHandlersCreateCommentHandler",
"requestBody": {
"x-name": "CreateCommentRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesCommentsHandlersCreateCommentRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesCommentsHandlersCommentDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/FastEndpointsErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
},
"get": {
"tags": [
"Comments",
"Api"
],
"operationId": "SocializeApiModulesCommentsHandlersGetCommentsHandler",
"parameters": [
{
"name": "contentItemId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "guid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SocializeApiModulesCommentsHandlersCommentDto"
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/comments/{id}/resolve": {
"post": {
"tags": [
"Comments",
"Api"
],
"operationId": "SocializeApiModulesCommentsHandlersResolveCommentHandler",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesCommentsHandlersCommentDto"
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/clients/{id}/portrait": {
"post": {
"tags": [
"Clients",
"Api"
],
"operationId": "SocializeApiModulesClientsHandlersChangeClientPortraitHandler",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"x-name": "ChangeClientPortraitRequest",
"description": "",
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesClientsHandlersChangeClientPortraitRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesClientsHandlersChangeClientPortraitResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/FastEndpointsErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/clients": {
"post": {
"tags": [
"Clients",
"Api"
],
"operationId": "SocializeApiModulesClientsHandlersCreateClientHandler",
"requestBody": {
"x-name": "CreateClientRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesClientsHandlersCreateClientRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesClientsHandlersClientDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/FastEndpointsErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
},
"get": {
"tags": [
"Clients",
"Api"
],
"operationId": "SocializeApiModulesClientsHandlersGetClientsHandler",
"parameters": [
{
"name": "workspaceId",
"in": "query",
"schema": {
"type": "string",
"format": "guid",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SocializeApiModulesClientsHandlersClientDto"
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/clients/{id}": {
"put": {
"tags": [
"Clients",
"Api"
],
"operationId": "SocializeApiModulesClientsHandlersUpdateClientHandler",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"x-name": "UpdateClientRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesClientsHandlersUpdateClientRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesClientsHandlersClientDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/FastEndpointsErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/campaigns": {
"post": {
"tags": [
"Campaigns",
"Api"
],
"operationId": "SocializeApiModulesCampaignsHandlersCreateCampaignHandler",
"requestBody": {
"x-name": "CreateCampaignRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesCampaignsHandlersCreateCampaignRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesCampaignsHandlersCampaignDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/FastEndpointsErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
},
"get": {
"tags": [
"Campaigns",
"Api"
],
"operationId": "SocializeApiModulesCampaignsHandlersGetCampaignsHandler",
"parameters": [
{
"name": "workspaceId",
"in": "query",
"schema": {
"type": "string",
"format": "guid",
"nullable": true
}
},
{
"name": "clientId",
"in": "query",
"schema": {
"type": "string",
"format": "guid",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SocializeApiModulesCampaignsHandlersCampaignDto"
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/assets/{id}/revisions": {
"post": {
"tags": [
"Assets",
"Api"
],
"operationId": "SocializeApiModulesAssetsHandlersCreateAssetRevisionHandler",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"x-name": "CreateAssetRevisionRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesAssetsHandlersCreateAssetRevisionRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesAssetsHandlersAssetRevisionDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/FastEndpointsErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/assets/google-drive": {
"post": {
"tags": [
"Assets",
"Api"
],
"operationId": "SocializeApiModulesAssetsHandlersCreateGoogleDriveAssetHandler",
"requestBody": {
"x-name": "CreateGoogleDriveAssetRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesAssetsHandlersCreateGoogleDriveAssetRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesAssetsHandlersAssetDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/FastEndpointsErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/assets": {
"get": {
"tags": [
"Assets",
"Api"
],
"operationId": "SocializeApiModulesAssetsHandlersGetAssetsHandler",
"parameters": [
{
"name": "contentItemId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "guid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SocializeApiModulesAssetsHandlersAssetDto"
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/approvals": {
"post": {
"tags": [
"Approvals",
"Api"
],
"operationId": "SocializeApiModulesApprovalsHandlersCreateApprovalRequestHandler",
"requestBody": {
"x-name": "CreateApprovalRequestRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesApprovalsHandlersCreateApprovalRequestRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesApprovalsHandlersApprovalRequestDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/FastEndpointsErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
},
"get": {
"tags": [
"Approvals",
"Api"
],
"operationId": "SocializeApiModulesApprovalsHandlersGetApprovalsHandler",
"parameters": [
{
"name": "contentItemId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "guid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SocializeApiModulesApprovalsHandlersApprovalRequestDto"
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"JWTBearerAuth": []
}
]
}
},
"/api/approvals/{id}/decisions": {
"post": {
"tags": [
"Approvals",
"Api"
],
"operationId": "SocializeApiModulesApprovalsHandlersSubmitApprovalDecisionHandler",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"x-name": "SubmitApprovalDecisionRequest",
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesApprovalsHandlersSubmitApprovalDecisionRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocializeApiModulesApprovalsHandlersApprovalRequestDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/FastEndpointsErrorResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"SocializeApiModulesWorkspacesHandlersChangeWorkspaceLogoResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"blobUrl": {
"type": "string"
}
}
},
"SocializeApiModulesWorkspacesHandlersChangeWorkspaceLogoRequest": {
"type": "object",
"additionalProperties": false,
"required": [
"file"
],
"properties": {
"file": {
"type": "string",
"format": "binary",
"minLength": 1,
"nullable": false
}
}
},
"FastEndpointsErrorResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 400
},
"message": {
"type": "string",
"default": "One or more errors occurred!"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"SocializeApiModulesWorkspacesHandlersWorkspaceDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "guid"
},
"organizationId": {
"type": "string",
"format": "guid"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"logoUrl": {
"type": "string",
"nullable": true
},
"timeZone": {
"type": "string"
},
"approvalMode": {
"type": "string"
},
"schedulePostsAutomaticallyOnApproval": {
"type": "boolean"
},
"lockContentAfterApproval": {
"type": "boolean"
},
"sendAutomaticApprovalReminders": {
"type": "boolean"
},
"approvalSteps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SocializeApiModulesWorkspacesHandlersApprovalStepConfigurationDto"
}
},
"createdAt": {
"type": "string",
"format": "date-time"
}
}
},
"SocializeApiModulesWorkspacesHandlersApprovalStepConfigurationDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "guid"
},
"workspaceId": {
"type": "string",
"format": "guid"
},
"name": {
"type": "string"
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"targetType": {
"type": "string"
},
"targetValue": {
"type": "string"
},
"requiredApproverCount": {
"type": "integer",
"format": "int32"
},
"createdAt": {
"type": "string",
"format": "date-time"
}
}
},
"SocializeApiModulesWorkspacesHandlersCreateWorkspaceRequest": {
"type": "object",
"additionalProperties": false,
"required": [
"organizationId",
"name",
"slug",
"timeZone"
],
"properties": {
"organizationId": {
"type": "string",
"format": "guid",
"minLength": 1,
"nullable": false
},
"name": {
"type": "string",
"maxLength": 256,
"minLength": 0,
"nullable": false
},
"slug": {
"type": "string",
"maxLength": 128,
"minLength": 0,
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"nullable": false
},
"timeZone": {
"type": "string",
"maxLength": 128,
"minLength": 0,
"nullable": false
}
}
},
"SocializeApiModulesWorkspacesHandlersWorkspaceInviteDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "guid"
},
"workspaceId": {
"type": "string",
"format": "guid"
},
"email": {
"type": "string"
},
"role": {
"type": "string"
},
"status": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
}
}
},
"SocializeApiModulesWorkspacesHandlersCreateWorkspaceInviteRequest": {
"type": "object",
"additionalProperties": false,
"required": [
"email",
"role"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 256,
"minLength": 0,
"pattern": "^[^@]+@[^@]+$",
"nullable": false
},
"role": {
"type": "string",
"minLength": 1,
"nullable": false
}
}
},
"SocializeApiModulesWorkspacesHandlersWorkspaceMemberDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "guid"
},
"displayName": {
"type": "string"
},
"email": {
"type": "string"
},
"portraitUrl": {
"type": "string",
"nullable": true
},
"relationshipCategory": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"SocializeApiModulesWorkspacesHandlersUpdateWorkspaceRequest": {
"type": "object",
"additionalProperties": false,
"required": [
"name",
"timeZone"
],
"properties": {
"name": {
"type": "string",
"maxLength": 256,
"minLength": 0,
"nullable": false
},
"timeZone": {
"type": "string",
"maxLength": 128,
"minLength": 0,
"nullable": false
},
"approvalMode": {
"type": "string",
"nullable": true
},
"schedulePostsAutomaticallyOnApproval": {
"type": "boolean",
"nullable": true
},
"lockContentAfterApproval": {
"type": "boolean",
"nullable": true
},
"sendAutomaticApprovalReminders": {
"type": "boolean",
"nullable": true
},
"approvalSteps": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/SocializeApiModulesWorkspacesHandlersUpdateApprovalStepConfigurationRequest"
}
}
}
},
"SocializeApiModulesWorkspacesHandlersUpdateApprovalStepConfigurationRequest": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"targetType": {
"type": "string"
},
"targetValue": {
"type": "string"
},
"requiredApproverCount": {
"type": "integer",
"format": "int32"
}
}
},
"SocializeApiModulesOrganizationsHandlersOrganizationDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "guid"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"ownerUserId": {
"type": "string",
"format": "guid"
},
"currentUserPermissions": {
"type": "array",
"items": {
"type": "string"
}
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SocializeApiModulesOrganizationsHandlersOrganizationMemberDto"
}
},
"workspaces": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SocializeApiModulesWorkspacesHandlersWorkspaceDto"
}
},
"createdAt": {
"type": "string",
"format": "date-time"
}
}
},
"SocializeApiModulesOrganizationsHandlersOrganizationMemberDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"userId": {
"type": "string",
"format": "guid"
},
"displayName": {
"type": "string"
},
"email": {
"type": "string"
},
"portraitUrl": {
"type": "string",
"nullable": true
},
"role": {
"type": "string"
},
"permissions": {
"type": "array",
"items": {
"type": "string"
}
},
"createdAt": {
"type": "string",
"format": "date-time"
}
}
},
"SocializeApiModulesNotificationsHandlersNotificationEventDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "guid"
},
"workspaceId": {
"type": "string",
"format": "guid"
},
"contentItemId": {
"type": "string",
"format": "guid",
"nullable": true
},
"eventType": {
"type": "string"
},
"entityType": {
"type": "string"
},
"entityId": {
"type": "string",
"format": "guid"
},
"message": {
"type": "string"
},
"recipientUserId": {
"type": "string",
"format": "guid",
"nullable": true
},
"recipientEmail": {
"type": "string",
"nullable": true
},
"metadataJson": {
"type": "string",
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"readAt": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
},
"SocializeApiModulesNotificationsHandlersGetNotificationsRequest": {
"type": "object",
"additionalProperties": false
},
"SocializeApiModulesIdentityHandlersChangeAddressRequest": {
"type": "object",
"additionalProperties": false,
"properties": {
"address": {
"type": "string",
"nullable": true
}
}
},
"SocializeApiModulesIdentityHandlersChangeAliasRequest": {
"type": "object",
"additionalProperties": false,
"properties": {
"alias": {
"type": "string",
"nullable": true
}
}
},
"SocializeApiModulesIdentityHandlersChangeBirthDateRequest": {
"type": "object",
"additionalProperties": false,
"properties": {
"birthDate": {
"type": "string",
"format": "date-time"
}
}
},
"SocializeApiModulesIdentityHandlersChangeEmailRequest": {
"type": "object",
"additionalProperties": false,
"properties": {
"email": {
"type": "string",
"nullable": true
}
}
},
"SocializeApiModulesIdentityHandlersChangeFullnameRequest": {
"type": "object",
"additionalProperties": false,
"properties": {
"firstname": {
"type": "string",
"nullable": true
},
"lastname": {
"type": "string",
"nullable": true
}
}
},
"SocializeApiModulesIdentityHandlersChangePhoneRequest": {
"type": "object",
"additionalProperties": false,
"properties": {
"phoneNumber": {
"type": "string",
"nullable": true
}
}
},
"SocializeApiModulesIdentityHandlersChangePortraitResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"blobUrl": {
"type": "string"
}
}
},
"SocializeApiModulesIdentityHandlersChangePortraitRequest": {
"type": "object",
"additionalProperties": false,
"required": [
"file"
],
"properties": {
"file": {
"type": "string",
"format": "binary",
"minLength": 1,
"nullable": false
}
}
},
"SocializeApiModulesIdentityHandlersForgotPasswordRequest": {
"type": "object",
"additionalProperties": false,
"properties": {
"email": {
"type": "string"
}
}
},
"SocializeApiModulesIdentityModelsUserDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "guid"
},
"userRoles": {
"type": "array",
"items": {
"type": "string"
}
},
"persona": {
"type": "string",
"nullable": true
},
"authorizedWorkspaceIds": {
"type": "array",
"items": {
"type": "string",
"format": "guid"
}
},
"authorizedClientIds": {
"type": "array",
"items": {
"type": "string",
"format": "guid"
}
},
"authorizedCampaignIds": {
"type": "array",
"items": {
"type": "string",
"format": "guid"
}
},
"username": {
"type": "string"
},
"alias": {
"type": "string",
"nullable": true
},
"portraitUrl": {
"type": "string",
"nullable": true
},
"firstname": {
"type": "string",
"nullable": true
},
"lastname": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"birthDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"address": {
"type": "string",
"nullable": true
}
}
},
"SystemIOStream": {
"allOf": [
{
"$ref": "#/components/schemas/SystemMarshalByRefObject"
},
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"canTimeout": {
"type": "boolean"
},
"readTimeout": {
"type": "integer",
"format": "int32"
},
"writeTimeout": {
"type": "integer",
"format": "int32"
}
}
}
]
},
"SystemMarshalByRefObject": {
"type": "object",
"x-abstract": true,
"additionalProperties": false
},
"SocializeApiModulesIdentityHandlersLoginResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"accessToken": {
"type": "string"
},
"refreshToken": {
"type": "string"
}
}
},
"SocializeApiModulesIdentityHandlersLoginRequest": {
"type": "object",
"additionalProperties": false,
"properties": {
"email": {
"type": "string"
},
"password": {
"type": "string"
}
}
},
"SocializeApiModulesIdentityHandlersLoginWithFacebookResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"accessToken": {
"type": "string"
},
"refreshToken": {
"type": "string"
}
}
},
"SocializeApiModulesIdentityHandlersLoginWithFacebookRequest": {
"type": "object",
"additionalProperties": false,
"properties": {
"token": {
"type": "string"
}
}
},
"SocializeApiModulesIdentityHandlersLoginWithGoogleResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"accessToken": {
"type": "string"
},
"refreshToken": {
"type": "string"
}
}
},
"SocializeApiModulesIdentityHandlersLoginWithGoogleRequest": {
"type": "object",
"additionalProperties": false,
"properties": {
"token": {
"type": "string"
}
}
},
"SocializeApiModulesIdentityHandlersRefreshTokenResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"accessToken": {
"type": "string"
},
"refreshToken": {
"type": "string"
}
}
},
"SocializeApiModulesIdentityHandlersRefreshTokenRequest": {
"type": "object",
"additionalProperties": false,
"properties": {
"refreshToken": {
"type": "string"
}
}
},
"SocializeApiModulesIdentityHandlersRegisterResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"message": {
"type": "string"
}
}
},
"SocializeApiModulesIdentityHandlersRegisterRequest": {
"type": "object",
"additionalProperties": false,
"properties": {
"email": {
"type": "string"
},
"password": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"SocializeApiModulesIdentityHandlersResendVerificationResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"message": {
"type": "string"
}
}
},
"SocializeApiModulesIdentityHandlersResendVerificationRequest": {
"type": "object",
"additionalProperties": false,
"properties": {
"email": {
"type": "string"
}
}
},
"SocializeApiModulesIdentityHandlersResetPasswordRequest": {
"type": "object",
"additionalProperties": false,
"properties": {
"email": {
"type": "string"
},
"token": {
"type": "string"
},
"newPassword": {
"type": "string"
}
}
},
"SocializeApiModulesIdentityHandlersSetPasswordRequest": {
"type": "object",
"additionalProperties": false,
"properties": {
"newPassword": {
"type": "string"
}
}
},
"SocializeApiModulesIdentityHandlersVerifyEmailResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"message": {
"type": "string"
}
}
},
"SocializeApiModulesIdentityHandlersVerifyEmailRequest": {
"type": "object",
"additionalProperties": false
},
"SocializeApiModulesFeedbackContractsFeedbackTimelineItemDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "guid"
},
"kind": {
"type": "string"
},
"actorUserId": {
"type": "string",
"format": "guid"
},
"actorDisplayName": {
"type": "string"
},
"actorEmail": {
"type": "string"
},
"actorRole": {
"type": "string",
"nullable": true
},
"body": {
"type": "string",
"nullable": true
},
"activityType": {
"type": "string",
"nullable": true
},
"fromValue": {
"type": "string",
"nullable": true
},
"toValue": {
"type": "string",
"nullable": true
},
"note": {
"type": "string",
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time"
}
}
},
"SocializeApiModulesFeedbackHandlersAddFeedbackCommentRequest": {
"type": "object",
"additionalProperties": false,
"required": [
"body"
],
"properties": {
"body": {
"type": "string",
"maxLength": 8000,
"minLength": 0,
"nullable": false
}
}
},
"SocializeApiModulesFeedbackContractsFeedbackReportDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "guid"
},
"type": {
"type": "string"
},
"status": {
"type": "string"
},
"description": {
"type": "string"
},
"reporterUserId": {
"type": "string",
"format": "guid"
},
"reporterDisplayName": {
"type": "string"
},
"reporterEmail": {
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/SocializeApiModulesFeedbackContractsFeedbackMetadataDto"
},
"context": {
"$ref": "#/components/schemas/SocializeApiModulesFeedbackContractsFeedbackContextDto"
},
"screenshot": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SocializeApiModulesFeedbackContractsFeedbackScreenshotDto"
}
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"timeline": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SocializeApiModulesFeedbackContractsFeedbackTimelineItemDto"
}
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"lastActivityAt": {
"type": "string",
"format": "date-time"
},
"cancelledAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"cancellationReason": {
"type": "string",
"nullable": true
}
}
},
"SocializeApiModulesFeedbackContractsFeedbackMetadataDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"submittedPath": {
"type": "string"
},
"browserUserAgent": {
"type": "string",
"nullable": true
},
"viewportWidth": {
"type": "integer",
"format": "int32",
"nullable": true
},
"viewportHeight": {
"type": "integer",
"format": "int32",
"nullable": true
},
"appVersion": {
"type": "string",
"nullable": true
}
}
},
"SocializeApiModulesFeedbackContractsFeedbackContextDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"workspaceId": {
"type": "string",
"format": "guid",
"nullable": true
},
"workspaceName": {
"type": "string",
"nullable": true
},
"clientId": {
"type": "string",
"format": "guid",
"nullable": true
},
"clientName": {
"type": "string",
"nullable": true
},
"campaignId": {
"type": "string",
"format": "guid",
"nullable": true
},
"campaignName": {
"type": "string",
"nullable": true
},
"contentItemId": {
"type": "string",
"format": "guid",
"nullable": true
},
"contentItemTitle": {
"type": "string",
"nullable": true
}
}
},
"SocializeApiModulesFeedbackContractsFeedbackScreenshotDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "guid"
},
"fileName": {
"type": "string"
},
"contentType": {
"type": "string"
},
"sizeBytes": {
"type": "integer",
"format": "int64"
},
"downloadPath": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
}
}
},
"SocializeApiModulesFeedbackHandlersAttachMyFeedbackScreenshotRequest": {
"type": "object",
"additionalProperties": false,
"required": [
"file"
],
"properties": {
"file": {
"type": "string",
"format": "binary",
"minLength": 1,
"nullable": false
}
}
},
"SocializeApiModulesFeedbackHandlersCancelMyFeedbackRequest": {
"type": "object",
"additionalProperties": false,
"properties": {
"reason": {
"type": "string",
"maxLength": 2000,
"minLength": 0,
"nullable": true
}
}
},
"SocializeApiModulesFeedbackHandlersSubmitFeedbackRequest": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"description",
"submittedPath"
],
"properties": {
"type": {
"type": "string",
"maxLength": 32,
"minLength": 0,
"nullable": false
},
"description": {
"type": "string",
"maxLength": 8000,
"minLength": 0,
"nullable": false
},
"submittedPath": {
"type": "string",
"maxLength": 2048,
"minLength": 0,
"nullable": false
},
"browserUserAgent": {
"type": "string",
"maxLength": 1024,
"minLength": 0,
"nullable": true
},
"viewportWidth": {
"type": "integer",
"format": "int32",
"minimum": 0.0,
"nullable": true,
"exclusiveMinimum": true
},
"viewportHeight": {
"type": "integer",
"format": "int32",
"minimum": 0.0,
"nullable": true,
"exclusiveMinimum": true
},
"appVersion": {
"type": "string",
"maxLength": 128,
"minLength": 0,
"nullable": true
},
"workspaceId": {
"type": "string",
"format": "guid",
"nullable": true
},
"workspaceName": {
"type": "string",
"maxLength": 256,
"minLength": 0,
"nullable": true
},
"clientId": {
"type": "string",
"format": "guid",
"nullable": true
},
"clientName": {
"type": "string",
"maxLength": 256,
"minLength": 0,
"nullable": true
},
"campaignId": {
"type": "string",
"format": "guid",
"nullable": true
},
"campaignName": {
"type": "string",
"maxLength": 256,
"minLength": 0,
"nullable": true
},
"contentItemId": {
"type": "string",
"format": "guid",
"nullable": true
},
"contentItemTitle": {
"type": "string",
"maxLength": 256,
"minLength": 0,
"nullable": true
}
}
},
"SocializeApiModulesFeedbackHandlersUpdateDeveloperFeedbackRequest": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"maxLength": 32,
"minLength": 0,
"nullable": true
},
"status": {
"type": "string",
"maxLength": 32,
"minLength": 0,
"nullable": true
},
"tags": {
"type": "array",
"maxLength": 64,
"minLength": 0,
"nullable": true,
"items": {
"type": "string"
}
}
}
},
"SocializeApiModulesContentItemsHandlersContentItemDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "guid"
},
"workspaceId": {
"type": "string",
"format": "guid"
},
"clientId": {
"type": "string",
"format": "guid"
},
"campaignId": {
"type": "string",
"format": "guid"
},
"title": {
"type": "string"
},
"publicationMessage": {
"type": "string"
},
"publicationTargets": {
"type": "string"
},
"hashtags": {
"type": "string",
"nullable": true
},
"status": {
"type": "string"
},
"dueDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"currentRevisionLabel": {
"type": "string"
},
"currentRevisionNumber": {
"type": "integer",
"format": "int32"
}
}
},
"SocializeApiModulesContentItemsHandlersCreateContentItemRequest": {
"type": "object",
"additionalProperties": false,
"required": [
"workspaceId",
"clientId",
"campaignId",
"title",
"publicationMessage",
"publicationTargets"
],
"properties": {
"workspaceId": {
"type": "string",
"format": "guid",
"minLength": 1,
"nullable": false
},
"clientId": {
"type": "string",
"format": "guid",
"minLength": 1,
"nullable": false
},
"campaignId": {
"type": "string",
"format": "guid",
"minLength": 1,
"nullable": false
},
"title": {
"type": "string",
"maxLength": 256,
"minLength": 0,
"nullable": false
},
"publicationMessage": {
"type": "string",
"maxLength": 4000,
"minLength": 0,
"nullable": false
},
"publicationTargets": {
"type": "string",
"maxLength": 512,
"minLength": 0,
"nullable": false
},
"hashtags": {
"type": "string",
"maxLength": 1024,
"minLength": 0,
"nullable": true
},
"dueDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
},
"SocializeApiModulesContentItemsHandlersContentItemRevisionDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "guid"
},
"contentItemId": {
"type": "string",
"format": "guid"
},
"revisionNumber": {
"type": "integer",
"format": "int32"
},
"revisionLabel": {
"type": "string"
},
"title": {
"type": "string"
},
"publicationMessage": {
"type": "string"
},
"publicationTargets": {
"type": "string"
},
"hashtags": {
"type": "string",
"nullable": true
},
"changeSummary": {
"type": "string",
"nullable": true
},
"createdByUserId": {
"type": "string",
"format": "guid",
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time"
}
}
},
"SocializeApiModulesContentItemsHandlersCreateContentItemRevisionRequest": {
"type": "object",
"additionalProperties": false,
"required": [
"title",
"publicationMessage",
"publicationTargets"
],
"properties": {
"title": {
"type": "string",
"maxLength": 256,
"minLength": 0,
"nullable": false
},
"publicationMessage": {
"type": "string",
"maxLength": 4000,
"minLength": 0,
"nullable": false
},
"publicationTargets": {
"type": "string",
"maxLength": 512,
"minLength": 0,
"nullable": false
},
"hashtags": {
"type": "string",
"maxLength": 1024,
"minLength": 0,
"nullable": true
},
"changeSummary": {
"type": "string",
"maxLength": 1024,
"minLength": 0,
"nullable": true
}
}
},
"SocializeApiModulesContentItemsHandlersContentItemDetailDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "guid"
},
"workspaceId": {
"type": "string",
"format": "guid"
},
"clientId": {
"type": "string",
"format": "guid"
},
"campaignId": {
"type": "string",
"format": "guid"
},
"title": {
"type": "string"
},
"publicationMessage": {
"type": "string"
},
"publicationTargets": {
"type": "string"
},
"hashtags": {
"type": "string",
"nullable": true
},
"status": {
"type": "string"
},
"dueDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"currentRevisionLabel": {
"type": "string"
},
"currentRevisionNumber": {
"type": "integer",
"format": "int32"
},
"createdAt": {
"type": "string",
"format": "date-time"
}
}
},
"SocializeApiModulesContentItemsHandlersGetContentItemsRequest": {
"type": "object",
"additionalProperties": false
},
"SocializeApiModulesContentItemsHandlersUpdateContentItemStatusRequest": {
"type": "object",
"additionalProperties": false,
"required": [
"status"
],
"properties": {
"status": {
"type": "string",
"maxLength": 64,
"minLength": 0,
"nullable": false
}
}
},
"SocializeApiModulesCommentsHandlersCommentDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "guid"
},
"workspaceId": {
"type": "string",
"format": "guid"
},
"contentItemId": {
"type": "string",
"format": "guid"
},
"parentCommentId": {
"type": "string",
"format": "guid",
"nullable": true
},
"authorUserId": {
"type": "string",
"format": "guid"
},
"authorDisplayName": {
"type": "string"
},
"authorEmail": {
"type": "string"
},
"authorPortraitUrl": {
"type": "string",
"nullable": true
},
"body": {
"type": "string"
},
"isResolved": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"resolvedAt": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
},
"SocializeApiModulesCommentsHandlersCreateCommentRequest": {
"type": "object",
"additionalProperties": false,
"required": [
"workspaceId",
"contentItemId",
"body"
],
"properties": {
"workspaceId": {
"type": "string",
"format": "guid",
"minLength": 1,
"nullable": false
},
"contentItemId": {
"type": "string",
"format": "guid",
"minLength": 1,
"nullable": false
},
"parentCommentId": {
"type": "string",
"format": "guid",
"nullable": true
},
"body": {
"type": "string",
"maxLength": 4000,
"minLength": 0,
"nullable": false
}
}
},
"SocializeApiModulesCommentsHandlersGetCommentsRequest": {
"type": "object",
"additionalProperties": false
},
"SocializeApiModulesClientsHandlersChangeClientPortraitResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"blobUrl": {
"type": "string"
}
}
},
"SocializeApiModulesClientsHandlersChangeClientPortraitRequest": {
"type": "object",
"additionalProperties": false,
"required": [
"file"
],
"properties": {
"file": {
"type": "string",
"format": "binary",
"minLength": 1,
"nullable": false
}
}
},
"SocializeApiModulesClientsHandlersClientDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "guid"
},
"workspaceId": {
"type": "string",
"format": "guid"
},
"name": {
"type": "string"
},
"status": {
"type": "string"
},
"portraitUrl": {
"type": "string",
"nullable": true
},
"primaryContactName": {
"type": "string",
"nullable": true
},
"primaryContactEmail": {
"type": "string",
"nullable": true
},
"primaryContactPortraitUrl": {
"type": "string",
"nullable": true
}
}
},
"SocializeApiModulesClientsHandlersCreateClientRequest": {
"type": "object",
"additionalProperties": false,
"required": [
"workspaceId",
"name"
],
"properties": {
"workspaceId": {
"type": "string",
"format": "guid",
"minLength": 1,
"nullable": false
},
"name": {
"type": "string",
"maxLength": 256,
"minLength": 0,
"nullable": false
},
"portraitUrl": {
"type": "string",
"maxLength": 2048,
"minLength": 0,
"nullable": true
},
"primaryContactName": {
"type": "string",
"maxLength": 256,
"minLength": 0,
"nullable": true
},
"primaryContactEmail": {
"type": "string",
"format": "email",
"maxLength": 256,
"minLength": 0,
"pattern": "^[^@]+@[^@]+$",
"nullable": true
},
"primaryContactPortraitUrl": {
"type": "string",
"maxLength": 2048,
"minLength": 0,
"nullable": true
}
}
},
"SocializeApiModulesClientsHandlersGetClientsRequest": {
"type": "object",
"additionalProperties": false
},
"SocializeApiModulesClientsHandlersUpdateClientRequest": {
"type": "object",
"additionalProperties": false,
"required": [
"name",
"status"
],
"properties": {
"name": {
"type": "string",
"maxLength": 256,
"minLength": 0,
"nullable": false
},
"portraitUrl": {
"type": "string",
"maxLength": 2048,
"minLength": 0,
"nullable": true
},
"status": {
"type": "string",
"maxLength": 64,
"minLength": 0,
"nullable": false
},
"primaryContactName": {
"type": "string",
"maxLength": 256,
"minLength": 0,
"nullable": true
},
"primaryContactEmail": {
"type": "string",
"format": "email",
"maxLength": 256,
"minLength": 0,
"pattern": "^[^@]+@[^@]+$",
"nullable": true
},
"primaryContactPortraitUrl": {
"type": "string",
"maxLength": 2048,
"minLength": 0,
"nullable": true
}
}
},
"SocializeApiModulesCampaignsHandlersCampaignDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "guid"
},
"workspaceId": {
"type": "string",
"format": "guid"
},
"clientId": {
"type": "string",
"format": "guid"
},
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"notes": {
"type": "string",
"nullable": true
},
"status": {
"type": "string"
},
"startDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
}
}
},
"SocializeApiModulesCampaignsHandlersCreateCampaignRequest": {
"type": "object",
"additionalProperties": false,
"required": [
"workspaceId",
"clientId",
"name",
"startDate",
"endDate"
],
"properties": {
"workspaceId": {
"type": "string",
"format": "guid",
"minLength": 1,
"nullable": false
},
"clientId": {
"type": "string",
"format": "guid",
"minLength": 1,
"nullable": false
},
"name": {
"type": "string",
"maxLength": 256,
"minLength": 0,
"nullable": false
},
"startDate": {
"type": "string",
"format": "date-time",
"minLength": 1,
"nullable": false
},
"endDate": {
"type": "string",
"format": "date-time",
"minLength": 1,
"nullable": false
},
"description": {
"type": "string",
"maxLength": 4000,
"minLength": 0,
"nullable": true
},
"notes": {
"type": "string",
"maxLength": 4000,
"minLength": 0,
"nullable": true
}
}
},
"SocializeApiModulesCampaignsHandlersGetCampaignsRequest": {
"type": "object",
"additionalProperties": false
},
"SocializeApiModulesAssetsHandlersAssetRevisionDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "guid"
},
"assetId": {
"type": "string",
"format": "guid"
},
"revisionNumber": {
"type": "integer",
"format": "int32"
},
"sourceReference": {
"type": "string"
},
"previewUrl": {
"type": "string",
"nullable": true
},
"notes": {
"type": "string",
"nullable": true
},
"createdByUserId": {
"type": "string",
"format": "guid",
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time"
}
}
},
"SocializeApiModulesAssetsHandlersCreateAssetRevisionRequest": {
"type": "object",
"additionalProperties": false,
"required": [
"sourceReference"
],
"properties": {
"sourceReference": {
"type": "string",
"maxLength": 2048,
"minLength": 0,
"nullable": false
},
"previewUrl": {
"type": "string",
"maxLength": 2048,
"minLength": 0,
"nullable": true
},
"notes": {
"type": "string",
"maxLength": 1024,
"minLength": 0,
"nullable": true
}
}
},
"SocializeApiModulesAssetsHandlersAssetDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "guid"
},
"workspaceId": {
"type": "string",
"format": "guid"
},
"contentItemId": {
"type": "string",
"format": "guid"
},
"assetType": {
"type": "string"
},
"sourceType": {
"type": "string"
},
"displayName": {
"type": "string"
},
"googleDriveFileId": {
"type": "string",
"nullable": true
},
"googleDriveLink": {
"type": "string",
"nullable": true
},
"previewUrl": {
"type": "string",
"nullable": true
},
"currentRevisionNumber": {
"type": "integer",
"format": "int32"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"revisions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SocializeApiModulesAssetsHandlersAssetRevisionDto"
}
}
}
},
"SocializeApiModulesAssetsHandlersCreateGoogleDriveAssetRequest": {
"type": "object",
"additionalProperties": false,
"required": [
"workspaceId",
"contentItemId",
"assetType",
"displayName",
"googleDriveFileId",
"googleDriveLink"
],
"properties": {
"workspaceId": {
"type": "string",
"format": "guid",
"minLength": 1,
"nullable": false
},
"contentItemId": {
"type": "string",
"format": "guid",
"minLength": 1,
"nullable": false
},
"assetType": {
"type": "string",
"maxLength": 64,
"minLength": 0,
"nullable": false
},
"displayName": {
"type": "string",
"maxLength": 256,
"minLength": 0,
"nullable": false
},
"googleDriveFileId": {
"type": "string",
"maxLength": 256,
"minLength": 0,
"nullable": false
},
"googleDriveLink": {
"type": "string",
"maxLength": 2048,
"minLength": 0,
"nullable": false
},
"previewUrl": {
"type": "string",
"maxLength": 2048,
"minLength": 0,
"nullable": true
}
}
},
"SocializeApiModulesAssetsHandlersGetAssetsRequest": {
"type": "object",
"additionalProperties": false
},
"SocializeApiModulesApprovalsHandlersApprovalRequestDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "guid"
},
"workspaceId": {
"type": "string",
"format": "guid"
},
"contentItemId": {
"type": "string",
"format": "guid"
},
"workflowInstanceId": {
"type": "string",
"format": "guid",
"nullable": true
},
"workflowStepSortOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"workflowStepTargetType": {
"type": "string",
"nullable": true
},
"workflowStepTargetValue": {
"type": "string",
"nullable": true
},
"workflowStepRequiredApproverCount": {
"type": "integer",
"format": "int32",
"nullable": true
},
"stage": {
"type": "string"
},
"reviewerName": {
"type": "string"
},
"reviewerEmail": {
"type": "string"
},
"requestedByUserId": {
"type": "string",
"format": "guid"
},
"dueAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"state": {
"type": "string"
},
"accessToken": {
"type": "string"
},
"sentAt": {
"type": "string",
"format": "date-time"
},
"completedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"decisions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SocializeApiModulesApprovalsHandlersApprovalDecisionDto"
}
}
}
},
"SocializeApiModulesApprovalsHandlersApprovalDecisionDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "guid"
},
"approvalRequestId": {
"type": "string",
"format": "guid"
},
"decision": {
"type": "string"
},
"comment": {
"type": "string",
"nullable": true
},
"decidedByUserId": {
"type": "string",
"format": "guid",
"nullable": true
},
"decidedByName": {
"type": "string"
},
"decidedByEmail": {
"type": "string"
},
"decidedByPortraitUrl": {
"type": "string",
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time"
}
}
},
"SocializeApiModulesApprovalsHandlersCreateApprovalRequestRequest": {
"type": "object",
"additionalProperties": false,
"required": [
"workspaceId",
"contentItemId",
"stage",
"reviewerName",
"reviewerEmail"
],
"properties": {
"workspaceId": {
"type": "string",
"format": "guid",
"minLength": 1,
"nullable": false
},
"contentItemId": {
"type": "string",
"format": "guid",
"minLength": 1,
"nullable": false
},
"stage": {
"type": "string",
"maxLength": 64,
"minLength": 0,
"nullable": false
},
"reviewerName": {
"type": "string",
"maxLength": 256,
"minLength": 0,
"nullable": false
},
"reviewerEmail": {
"type": "string",
"format": "email",
"maxLength": 256,
"minLength": 0,
"pattern": "^[^@]+@[^@]+$",
"nullable": false
},
"dueAt": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
},
"SocializeApiModulesApprovalsHandlersGetApprovalsRequest": {
"type": "object",
"additionalProperties": false
},
"SocializeApiModulesApprovalsHandlersSubmitApprovalDecisionRequest": {
"type": "object",
"additionalProperties": false,
"required": [
"decision"
],
"properties": {
"decision": {
"type": "string",
"minLength": 1,
"nullable": false
},
"comment": {
"type": "string",
"maxLength": 2048,
"minLength": 0,
"nullable": true
},
"reviewerName": {
"type": "string",
"maxLength": 256,
"minLength": 0,
"nullable": true
},
"reviewerEmail": {
"type": "string",
"format": "email",
"maxLength": 256,
"minLength": 0,
"pattern": "^[^@]+@[^@]+$",
"nullable": true
}
}
}
},
"securitySchemes": {
"JWTBearerAuth": {
"type": "http",
"description": "Enter a JWT token to authorize the requests...",
"scheme": "Bearer",
"bearerFormat": "JWT"
}
}
}
}