Created
February 26, 2023 13:11
-
-
Save florianmartens/ee1623903cb55037d15ef6796e43f720 to your computer and use it in GitHub Desktop.
Sample swagger file to illustrate bug in oatyp
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
{ | |
"openapi": "3.0.0", | |
"paths": { | |
"/": { | |
"get": { | |
"operationId": "health", | |
"parameters": [], | |
"responses": { "200": { "description": "" } } | |
} | |
}, | |
"/auth/signin": { | |
"post": { | |
"operationId": "signIn", | |
"parameters": [], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/LoginDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TokenResponseDto" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Auth"] | |
} | |
}, | |
"/auth/google-auth": { | |
"get": { | |
"operationId": "googleSignIn", | |
"parameters": [], | |
"responses": { "200": { "description": "" } }, | |
"tags": ["Auth"] | |
} | |
}, | |
"/auth/google-redirect": { | |
"get": { | |
"operationId": "googleRedirect", | |
"parameters": [ | |
{ | |
"name": "code", | |
"required": true, | |
"in": "query", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "scope", | |
"required": true, | |
"in": "query", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "authUser", | |
"required": true, | |
"in": "query", | |
"schema": { "type": "number" } | |
}, | |
{ | |
"name": "prompt", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TokenResponseDto" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Auth"] | |
} | |
}, | |
"/auth/refresh-token": { | |
"post": { | |
"operationId": "refreshToken", | |
"parameters": [], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TokenRefreshDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TokenResponseDto" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Auth"] | |
} | |
}, | |
"/auth/confirm-email": { | |
"post": { | |
"operationId": "confirmEmailAddress", | |
"parameters": [], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ConfirmEmailDto" | |
} | |
} | |
} | |
}, | |
"responses": { "201": { "description": "" } }, | |
"tags": ["Auth"] | |
} | |
}, | |
"/auth/resend-confirm-email": { | |
"post": { | |
"operationId": "resendConfirmEmailAddress", | |
"parameters": [], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ResendEmailVerificationDto" | |
} | |
} | |
} | |
}, | |
"responses": { "200": { "description": "" } }, | |
"tags": ["Auth"] | |
} | |
}, | |
"/auth/password-reset": { | |
"post": { | |
"operationId": "resetPassword", | |
"parameters": [], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PasswordResetDto" | |
} | |
} | |
} | |
}, | |
"responses": { "201": { "description": "" } }, | |
"tags": ["Auth"] | |
} | |
}, | |
"/auth/send-password-reset-token": { | |
"post": { | |
"operationId": "sendPasswordResetToken", | |
"parameters": [], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PasswordResetRequestDto" | |
} | |
} | |
} | |
}, | |
"responses": { "201": { "description": "" } }, | |
"tags": ["Auth"] | |
} | |
}, | |
"/auth/signup": { | |
"post": { | |
"operationId": "createUser", | |
"parameters": [], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CreateUserDto" | |
} | |
} | |
} | |
}, | |
"responses": { "201": { "description": "" } }, | |
"tags": ["Auth"] | |
} | |
}, | |
"/auth/self/update-email": { | |
"put": { | |
"operationId": "updateEmailAddress", | |
"parameters": [], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateEmailAddressDto" | |
} | |
} | |
} | |
}, | |
"responses": { "200": { "description": "" } }, | |
"tags": ["Auth"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/auth/self/update-email/success": { | |
"post": { | |
"operationId": "updateEmailAddressSuccess", | |
"parameters": [ | |
{ | |
"name": "token", | |
"required": true, | |
"in": "query", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { "201": { "description": "" } }, | |
"tags": ["Auth"] | |
} | |
}, | |
"/licenses/licenseOverwrite/{id}": { | |
"get": { | |
"operationId": "getlicenseOverwrite", | |
"parameters": [], | |
"responses": { | |
"200": { "description": "" }, | |
"default": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/LicenseOverwriteEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Licenses"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/licenses/{organizationId}/sync-license-info": { | |
"get": { | |
"operationId": "getSyncLicenseInfo", | |
"parameters": [ | |
{ | |
"name": "organizationId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { "type": "object" } | |
} | |
} | |
}, | |
"default": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SyncLicenseInfoDto" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Licenses"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/licenses/{organizationId}/consumed": { | |
"get": { | |
"operationId": "getCurrentLicenseConsumption", | |
"parameters": [ | |
{ | |
"name": "organizationId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/LicenseConsumptionDto" | |
} | |
} | |
} | |
}, | |
"default": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/LicenseConsumptionDto" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Licenses"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/licenses/{organizationId}/claim-sponsored": { | |
"post": { | |
"operationId": "claimSponsoredLicense", | |
"parameters": [ | |
{ | |
"name": "organizationId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ClaimSponsoredLicenseDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"201": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { "type": "object" } | |
} | |
} | |
}, | |
"default": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Licenses"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/organizations/account-setup": { | |
"post": { | |
"operationId": "accountSetup", | |
"parameters": [], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AccountSetupDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationEntity" | |
} | |
} | |
} | |
}, | |
"201": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { "type": "object" } | |
} | |
} | |
} | |
}, | |
"tags": ["Organizations"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/organizations/{organizationId}/roles": { | |
"get": { | |
"operationId": "findUserWithRoles", | |
"parameters": [ | |
{ | |
"name": "organizationId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "role", | |
"required": true, | |
"in": "query", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { "type": "object" } | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Organizations"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/organizations/{organizationId}/change-role": { | |
"post": { | |
"operationId": "changeOrganizationRole", | |
"parameters": [ | |
{ | |
"name": "organizationId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ChangeOrganizationRoleDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"201": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { "type": "object" } | |
} | |
} | |
} | |
}, | |
"tags": ["Organizations"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/organizations/{organizationId}/remove-user": { | |
"post": { | |
"operationId": "removeUserFromOrganization", | |
"parameters": [ | |
{ | |
"name": "organizationId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/RemoveUserFromOrganizationDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationEntity" | |
} | |
} | |
} | |
}, | |
"201": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { "type": "object" } | |
} | |
} | |
} | |
}, | |
"tags": ["Organizations"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/organizations/{organizationId}": { | |
"get": { | |
"operationId": "findOrganizationForMember", | |
"parameters": [ | |
{ | |
"name": "organizationId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Organizations"], | |
"security": [{ "bearer": [] }] | |
}, | |
"put": { | |
"operationId": "updateOrganization", | |
"parameters": [ | |
{ | |
"name": "organizationId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateOrganizationDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Organizations"], | |
"security": [{ "bearer": [] }] | |
}, | |
"delete": { | |
"operationId": "deleteOrganization", | |
"parameters": [ | |
{ | |
"name": "organizationId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { "200": { "description": "" } }, | |
"tags": ["Organizations"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/organizations/{slug}/public": { | |
"get": { | |
"operationId": "findOrganizationPublic", | |
"parameters": [ | |
{ | |
"name": "slug", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PublicOrganizaitionEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Organizations"] | |
} | |
}, | |
"/organizations/{organizationId}/user-list": { | |
"get": { | |
"operationId": "findUserList", | |
"parameters": [ | |
{ | |
"name": "organizationId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/UserEntity" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Organizations"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/organizations": { | |
"post": { | |
"operationId": "createOrganization", | |
"parameters": [], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CreateOrganizationDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationEntity" | |
} | |
} | |
} | |
}, | |
"201": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { "type": "object" } | |
} | |
} | |
} | |
}, | |
"tags": ["Organizations"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/workspaces/slug/{slug}": { | |
"get": { | |
"operationId": "findWorkspaceBySlug", | |
"parameters": [ | |
{ | |
"name": "slug", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/WorkspaceEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Workspaces"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/workspaces": { | |
"get": { | |
"operationId": "getUserWorkspaces", | |
"parameters": [], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/WorkspaceEntity" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Workspaces"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/workspaces/{workspaceId}": { | |
"get": { | |
"operationId": "getUserWorkspaceById", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/WorkspaceEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Workspaces"], | |
"security": [{ "bearer": [] }] | |
}, | |
"put": { | |
"operationId": "updateWorkspace", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateWorkspaceDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/WorkspaceEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Workspaces"], | |
"security": [{ "bearer": [] }] | |
}, | |
"delete": { | |
"operationId": "deleteWorkspace", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { "type": "object" } | |
} | |
} | |
} | |
}, | |
"tags": ["Workspaces"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/workspaces/{workspaceId}/users": { | |
"get": { | |
"operationId": "findUsersForWorkspace", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/UserEntity" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Workspaces"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/workspaces/{workspaceId}/user-on-workspace": { | |
"get": { | |
"operationId": "findUserOnWorkspace", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UsersOnWorkspacesEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Workspaces"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/workspaces/{workspaceId}/users-on-workspace": { | |
"get": { | |
"operationId": "findUsersOnWorkspaceList", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/UsersOnWorkspacesEntity" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Workspaces"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/workspaces/{workspaceId}/change-role": { | |
"post": { | |
"operationId": "changeWorkspaceUserRole", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ChangeWorkspaceRoleDto" | |
} | |
} | |
} | |
}, | |
"responses": { "201": { "description": "" } }, | |
"tags": ["Workspaces"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/workspaces/{organizationId}/workspace-list": { | |
"post": { | |
"operationId": "createWorkspace", | |
"parameters": [ | |
{ | |
"name": "organizationId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CreateWorkspaceDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/WorkspaceEntity" | |
} | |
} | |
} | |
}, | |
"201": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { "type": "object" } | |
} | |
} | |
} | |
}, | |
"tags": ["Workspaces"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/workspaces/{slug}/public": { | |
"get": { | |
"operationId": "findWorkspacePublic", | |
"parameters": [ | |
{ | |
"name": "slug", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PublicWorkspaceEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Workspaces"] | |
} | |
}, | |
"/connected-accounts/{organizationId}/social-identities": { | |
"get": { | |
"operationId": "findSocialIdentityList", | |
"parameters": [ | |
{ | |
"name": "organizationId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "workspaceId", | |
"required": false, | |
"in": "query", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/SocialIdentityEntity" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Connected accounts"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/connected-accounts/{organizationId}/social-identities/{socialIdentityId}": { | |
"get": { | |
"operationId": "findSocialIdentity", | |
"parameters": [ | |
{ | |
"name": "organizationId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "socialIdentityId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SocialIdentityEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Connected accounts"], | |
"security": [{ "bearer": [] }] | |
}, | |
"post": { | |
"operationId": "changeWorkspaces", | |
"parameters": [ | |
{ | |
"name": "organizationId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "socialIdentityId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "action", | |
"required": true, | |
"in": "query", | |
"schema": { | |
"enum": ["add", "remove"], | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ChangeWorkspacesDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SocialIdentityEntity" | |
} | |
} | |
} | |
}, | |
"201": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { "type": "object" } | |
} | |
} | |
} | |
}, | |
"tags": ["Connected accounts"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/connected-accounts/linkedin-connect": { | |
"get": { | |
"operationId": "linkedInConnect", | |
"parameters": [], | |
"responses": { "200": { "description": "" } }, | |
"tags": ["Connected accounts"] | |
} | |
}, | |
"/connected-accounts/{organizationId}/linkedin-redirect": { | |
"get": { | |
"operationId": "linkedinRedirect", | |
"parameters": [ | |
{ | |
"name": "code", | |
"required": true, | |
"in": "query", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "organizationId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SocialIdentityEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Connected accounts"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/connected-accounts/twitter-connect": { | |
"get": { | |
"operationId": "twitterConnect", | |
"parameters": [], | |
"responses": { "200": { "description": "" } }, | |
"tags": ["Connected accounts"] | |
} | |
}, | |
"/connected-accounts/{organizationId}/twitter-redirect": { | |
"get": { | |
"operationId": "twitterRedirect", | |
"parameters": [ | |
{ | |
"name": "state", | |
"required": true, | |
"in": "query", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "code", | |
"required": true, | |
"in": "query", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "organizationId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SocialIdentityEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Connected accounts"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/connected-accounts/{organizationId}/{socialIdentityId}": { | |
"delete": { | |
"operationId": "deleteSocialIdentity", | |
"parameters": [ | |
{ | |
"name": "organizationId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "socialIdentityId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { "type": "object" } | |
} | |
} | |
} | |
}, | |
"tags": ["Connected accounts"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/connected-accounts/{workspaceId}/{socialIdentityId}/refresh-provider-values": { | |
"put": { | |
"operationId": "refreshProviderValues", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "socialIdentityId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { "type": "object" } | |
} | |
} | |
} | |
}, | |
"tags": ["Connected accounts"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/slack/slack-connect": { | |
"get": { | |
"operationId": "slackConnect", | |
"parameters": [], | |
"responses": { "200": { "description": "" } }, | |
"tags": ["Slack"] | |
} | |
}, | |
"/slack/{organizationId}/slack-redirect": { | |
"get": { | |
"operationId": "slackRedirect", | |
"parameters": [ | |
{ | |
"name": "code", | |
"required": true, | |
"in": "query", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "organizationId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SlackChannelEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Slack"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/slack/{organizationId}/channel-list": { | |
"get": { | |
"operationId": "getSlackChannelList", | |
"parameters": [ | |
{ | |
"name": "organizationId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "workspaceId", | |
"required": false, | |
"in": "query", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/SlackChannelEntity" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Slack"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/slack/{organizationId}/{slackChannelId}": { | |
"get": { | |
"operationId": "getSlackChannel", | |
"parameters": [ | |
{ | |
"name": "organizationId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "slackChannelId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SlackChannelEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Slack"], | |
"security": [{ "bearer": [] }] | |
}, | |
"delete": { | |
"operationId": "deleteSlackChannel", | |
"parameters": [ | |
{ | |
"name": "organizationId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "slackChannelId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { "type": "object" } | |
} | |
} | |
} | |
}, | |
"tags": ["Slack"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/slack/{organizationId}/{slackChannelId}/change-workspaces": { | |
"post": { | |
"operationId": "changeSlackChannelWorkspaces", | |
"parameters": [ | |
{ | |
"name": "organizationId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "slackChannelId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "action", | |
"required": true, | |
"in": "query", | |
"schema": { | |
"enum": ["add", "remove"], | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ChangeWorkspacesDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SlackChannelEntity" | |
} | |
} | |
} | |
}, | |
"201": { "description": "" } | |
}, | |
"tags": ["Slack"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/twitter/{workspaceId}/{socialIdentityId}/posts": { | |
"get": { | |
"operationId": "getTwitterPosts", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "socialIdentityId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "source", | |
"required": true, | |
"in": "query", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/TwitterPostEntity" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Twitter"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/twitter/{workspaceId}/{socialIdentityId}/update-identity": { | |
"get": { | |
"operationId": "updateTwitterSelf", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "socialIdentityId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/TwitterPostEntity" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Twitter"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/linkedin/{workspaceId}/organizations": { | |
"get": { | |
"operationId": "findOrganizationsWhereUserIsAdmin", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/LinkedInOrganizationEntity" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["LinkedIn"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/linkedin/{workspaceId}/provider-orgs/{providerOrgId}/{socialIdentityId}/shares": { | |
"get": { | |
"operationId": "findOrganizationsShares", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "socialIdentityId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "providerOrgId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/LinkedInShareEntity" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["LinkedIn"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/linkedin/{workspaceId}/{socialIdentityId}/update-identity": { | |
"put": { | |
"operationId": "updateLinkedInSelf", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "socialIdentityId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/LinkedInShareEntity" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["LinkedIn"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/contacts/public/id/{contactId}": { | |
"get": { | |
"operationId": "findEmailPreferencesById", | |
"parameters": [ | |
{ | |
"name": "contactId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PublicContactEmailManagementEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Contacts"] | |
} | |
}, | |
"/contacts/public/{contactId}/manage": { | |
"post": { | |
"operationId": "manageContactEmailSettings", | |
"parameters": [ | |
{ | |
"name": "contactId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ManageContactEmailSettingsDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PublicContactEmailManagementEntity" | |
} | |
} | |
} | |
}, | |
"201": { "description": "" } | |
}, | |
"tags": ["Contacts"] | |
} | |
}, | |
"/contacts/{workspaceId}/{squadId}/add-contact-to-squad": { | |
"post": { | |
"operationId": "addContactToSquad", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "squadId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AddContactToSquadDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"201": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { "type": "object" } | |
} | |
} | |
} | |
}, | |
"tags": ["Contacts"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/contacts/{workspaceId}/{squadId}/remove-contact-from-squad": { | |
"post": { | |
"operationId": "removeContactFromSquad", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "squadId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AddContactToSquadDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"201": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { "type": "object" } | |
} | |
} | |
} | |
}, | |
"tags": ["Contacts"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/contacts/{workspaceId}/{contactId}": { | |
"get": { | |
"operationId": "findContact", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "contactId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ContactEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Contacts"], | |
"security": [{ "bearer": [] }] | |
}, | |
"put": { | |
"operationId": "updateContact", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "contactId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateContactDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ContactEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Contacts"], | |
"security": [{ "bearer": [] }] | |
}, | |
"delete": { | |
"operationId": "deleteContact", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "contactId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { "200": { "description": "" } }, | |
"tags": ["Contacts"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/contacts/{workspaceId}": { | |
"get": { | |
"operationId": "findContactList", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/ContactEntity" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Contacts"], | |
"security": [{ "bearer": [] }] | |
}, | |
"post": { | |
"operationId": "createContact", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CreateContactDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ContactEntity" | |
} | |
} | |
} | |
}, | |
"201": { "description": "" } | |
}, | |
"tags": ["Contacts"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/users/self": { | |
"get": { | |
"operationId": "findSelf", | |
"parameters": [], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UserEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Users"], | |
"security": [{ "bearer": [] }] | |
}, | |
"patch": { | |
"operationId": "updateSelf", | |
"parameters": [], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateUserDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"201": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UserEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Users"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/profile/self": { | |
"get": { | |
"operationId": "findProfile", | |
"parameters": [], | |
"responses": { "200": { "description": "" } }, | |
"tags": ["Profile"], | |
"security": [{ "bearer": [] }] | |
}, | |
"put": { | |
"operationId": "updateProfile", | |
"parameters": [], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateProfileDto" | |
} | |
} | |
} | |
}, | |
"responses": { "200": { "description": "" } }, | |
"tags": ["Profile"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/customer-requests": { | |
"post": { | |
"operationId": "createCustomerRequest", | |
"parameters": [], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CreateCustomerRequestDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"201": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CustomerRequestEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["CustomerRequests"] | |
} | |
}, | |
"/digests/{workspaceId}": { | |
"get": { | |
"operationId": "findDigestsList", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "max_age", | |
"required": false, | |
"in": "query", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "take", | |
"required": false, | |
"in": "query", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/DigestEntity" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Digests"], | |
"security": [{ "bearer": [] }] | |
}, | |
"post": { | |
"operationId": "createDigest", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CreateDigestDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DigestEntity" | |
} | |
} | |
} | |
}, | |
"201": { "description": "" } | |
}, | |
"tags": ["Digests"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/digests/{workspaceId}/{digestId}": { | |
"get": { | |
"operationId": "findDigest", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "digestId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DigestEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Digests"], | |
"security": [{ "bearer": [] }] | |
}, | |
"put": { | |
"operationId": "updateDigest", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "digestId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateDigestDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DigestEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Digests"], | |
"security": [{ "bearer": [] }] | |
}, | |
"delete": { | |
"operationId": "deleteDigest", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "digestId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { "type": "object" } | |
} | |
} | |
} | |
}, | |
"tags": ["Digests"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/digests/{workspaceId}/{digestId}/update-recipients": { | |
"put": { | |
"operationId": "updateDigestSquadList", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "digestId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateDigestRecipientsDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DigestEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Digests"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/digests/{workspaceId}/{digestId}/send": { | |
"post": { | |
"operationId": "sendDigest", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "digestId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { "201": { "description": "" } }, | |
"tags": ["Digests"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/digests/{workspaceId}/{digestId}/preview": { | |
"get": { | |
"operationId": "previewDigest", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "digestId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { "200": { "description": "" } }, | |
"tags": ["Digests"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/digests/{workspaceId}/{digestId}/recipients": { | |
"get": { | |
"operationId": "findDigestRecipients", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "digestId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/ContactEntity" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Digests"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/squads/public/{squadId}": { | |
"get": { | |
"operationId": "findPublicSquad", | |
"parameters": [ | |
{ | |
"name": "squadId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { "description": "" }, | |
"default": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PublicSquadEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Squads"] | |
} | |
}, | |
"/squads/invitations/accept": { | |
"post": { | |
"operationId": "acceptInviation", | |
"parameters": [], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AcceptSquadInviationDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"201": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { "type": "object" } | |
} | |
} | |
}, | |
"default": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ContactEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Squads"] | |
} | |
}, | |
"/squads/invitations/{squadId}/preview": { | |
"get": { | |
"operationId": "previewInvitation", | |
"parameters": [ | |
{ | |
"name": "squadId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { "200": { "description": "" } }, | |
"tags": ["Squads"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/squads/invitations/{workspaceId}": { | |
"post": { | |
"operationId": "createSquadInvitation", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CreateSquadInvitationDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"201": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { "type": "object" } | |
} | |
} | |
}, | |
"default": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SquadInvitationEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Squads"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/squads/invitations/public/{workspaceSlug}": { | |
"post": { | |
"operationId": "createPublicSquadInvitation", | |
"parameters": [ | |
{ | |
"name": "workspaceSlug", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CreateSquadInvitationDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"201": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { "type": "object" } | |
} | |
} | |
}, | |
"default": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SquadInvitationEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Squads"] | |
} | |
}, | |
"/squads/invitations/{workspaceId}/{invitationId}": { | |
"delete": { | |
"operationId": "deleteInvitation", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "invitationId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { "description": "" }, | |
"default": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/SquadInvitationEntity" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Squads"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/squads/invitations/{workspaceId}/{squadId}": { | |
"get": { | |
"operationId": "findSquadInvitationList", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "squadId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { "type": "object" } | |
} | |
} | |
} | |
}, | |
"default": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/SquadInvitationEntity" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Squads"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/squads/{workspaceId}": { | |
"get": { | |
"operationId": "findSquadList", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "digestId", | |
"required": false, | |
"in": "query", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/SquadEntity" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Squads"], | |
"security": [{ "bearer": [] }] | |
}, | |
"post": { | |
"operationId": "createSquad", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CreateSquadDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SquadEntity" | |
} | |
} | |
} | |
}, | |
"201": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { "type": "object" } | |
} | |
} | |
} | |
}, | |
"tags": ["Squads"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/squads/{workspaceId}/{squadId}": { | |
"get": { | |
"operationId": "findSquad", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "squadId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SquadEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Squads"], | |
"security": [{ "bearer": [] }] | |
}, | |
"put": { | |
"operationId": "updateSquad", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "squadId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateSquadDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SquadEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Squads"], | |
"security": [{ "bearer": [] }] | |
}, | |
"delete": { | |
"operationId": "deleteSquad", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "squadId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { "200": { "description": "" } }, | |
"tags": ["Squads"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/squads/{workspaceId}/{squadId}/contacts": { | |
"get": { | |
"operationId": "findContactListForSquad", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "squadId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { "type": "object" } | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Squads"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/syncs/send-syncs": { | |
"post": { | |
"operationId": "sendSyncs", | |
"parameters": [ | |
{ | |
"name": "forceSend", | |
"required": false, | |
"in": "query", | |
"schema": { "type": "boolean" } | |
} | |
], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendSyncsDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SyncEntity" | |
} | |
} | |
} | |
}, | |
"201": { "description": "" } | |
}, | |
"tags": ["Syncs"] | |
} | |
}, | |
"/syncs/{workspaceId}/{syncId}": { | |
"get": { | |
"operationId": "findSync", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "syncId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SyncEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Syncs"], | |
"security": [{ "bearer": [] }] | |
}, | |
"delete": { | |
"operationId": "deleteSync", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "syncId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { "type": "object" } | |
} | |
} | |
} | |
}, | |
"tags": ["Syncs"], | |
"security": [{ "bearer": [] }] | |
}, | |
"patch": { | |
"operationId": "updateSync", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "syncId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateSyncDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SyncEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Syncs"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/syncs/{workspaceId}": { | |
"get": { | |
"operationId": "findSyncList", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "max_age", | |
"required": false, | |
"in": "query", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "take", | |
"required": false, | |
"in": "query", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/SyncEntity" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Syncs"], | |
"security": [{ "bearer": [] }] | |
}, | |
"post": { | |
"operationId": "createSync", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CreateSyncDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SyncEntity" | |
} | |
} | |
} | |
}, | |
"201": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { "type": "object" } | |
} | |
} | |
} | |
}, | |
"tags": ["Syncs"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/syncs/{workspaceId}/{syncId}/start": { | |
"get": { | |
"operationId": "startSync", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "syncId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SyncEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Syncs"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/syncs/{workspaceId}/{syncId}/pause": { | |
"get": { | |
"operationId": "pauseSync", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "syncId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SyncEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Syncs"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/syncs/content-sources/{workspaceId}/candidates": { | |
"get": { | |
"operationId": "getContentSourceCandidateList", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/ContentSourceCandidateEntity" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Syncs"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/recipients/{workspaceId}/add-recipient": { | |
"put": { | |
"operationId": "addRecipient", | |
"parameters": [], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AddRecipientDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/RecipientEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Recipients"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/recipients/{workspaceId}/remove-recipient": { | |
"put": { | |
"operationId": "removeRecipient", | |
"parameters": [], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/RemoveRecipientDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/RecipientEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Recipients"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/shares/get-metadata": { | |
"post": { | |
"operationId": "findLinkMetaData", | |
"parameters": [], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/FindMetaDataDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"201": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { "type": "object" } | |
} | |
} | |
} | |
}, | |
"tags": ["Shares"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/shares/{workspaceId}": { | |
"get": { | |
"operationId": "findShareList", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/ShareEntity" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Shares"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/shares/{workspaceId}/{shareId}": { | |
"get": { | |
"operationId": "findShare", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "shareId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ShareEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Shares"], | |
"security": [{ "bearer": [] }] | |
}, | |
"delete": { | |
"operationId": "deleteShare", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "shareId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { "200": { "description": "" } }, | |
"tags": ["Shares"], | |
"security": [{ "bearer": [] }] | |
}, | |
"put": { | |
"operationId": "updateShare", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "shareId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateShareDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ShareEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Shares"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/shares/{workspaceId}/{contentListId}/{socialidentityId}": { | |
"post": { | |
"operationId": "createPost", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "contentListId", | |
"required": false, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CreateShareDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ShareEntity" | |
} | |
} | |
} | |
}, | |
"201": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { "type": "object" } | |
} | |
} | |
} | |
}, | |
"tags": ["Shares"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/content-lists/{workspaceId}": { | |
"post": { | |
"operationId": "createContentList", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CreateContentListDto" | |
} | |
} | |
} | |
}, | |
"responses": { "201": { "description": "" } }, | |
"tags": ["Content-Lists"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/content-lists/{workspaceId}/{contentListId}": { | |
"get": { | |
"operationId": "findContentList", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "contentListId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ContentListEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Content-Lists"], | |
"security": [{ "bearer": [] }] | |
}, | |
"delete": { | |
"operationId": "deleteContentList", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "contentListId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { "200": { "description": "" } }, | |
"tags": ["Content-Lists"], | |
"security": [{ "bearer": [] }] | |
}, | |
"put": { | |
"operationId": "updateContentList", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "contentListId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateContentListDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ContentListEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Content-Lists"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/content-lists/{workspaceId}/{contentListId}/update-post": { | |
"put": { | |
"operationId": "updateShareAssociation", | |
"parameters": [ | |
{ | |
"name": "workspaceId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "contentListId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
}, | |
{ | |
"name": "action", | |
"required": true, | |
"in": "query", | |
"schema": { | |
"enum": ["add", "remove"], | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ShareAssocciationDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ContentListEntity" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Content-Lists"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/slack/webhook": { | |
"post": { | |
"operationId": "webhhok", | |
"parameters": [], | |
"responses": { "201": { "description": "" } } | |
} | |
}, | |
"/billing/products": { | |
"get": { | |
"operationId": "findProducts", | |
"parameters": [ | |
{ | |
"name": "currency", | |
"required": false, | |
"in": "query", | |
"schema": { "enum": ["usd", "eur"], "type": "string" } | |
}, | |
{ | |
"name": "interval", | |
"required": false, | |
"in": "query", | |
"schema": { | |
"enum": ["month", "year"], | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/ProductEntity" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Billing"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/billing/license/{organizationId}": { | |
"get": { | |
"operationId": "findStripeSubscription", | |
"parameters": [ | |
{ | |
"name": "organizationId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { "type": "object" } | |
} | |
} | |
} | |
}, | |
"tags": ["Billing"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/billing/retrieve-session-info": { | |
"post": { | |
"operationId": "retrieveStripeSessionAndCustomer", | |
"parameters": [], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/RetrieveCustomerAndSessionDto" | |
} | |
} | |
} | |
}, | |
"responses": { "201": { "description": "" } }, | |
"tags": ["Billing"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/billing/create-checkout-session": { | |
"post": { | |
"operationId": "createCheckoutSession", | |
"parameters": [ | |
{ | |
"name": "coupon", | |
"required": false, | |
"in": "query", | |
"schema": { "type": "string" } | |
} | |
], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CreateCheckoutSessionDto" | |
} | |
} | |
} | |
}, | |
"responses": { "201": { "description": "" } }, | |
"tags": ["Billing"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/billing/webhook": { | |
"post": { | |
"operationId": "stripeWebhookEndpoint", | |
"parameters": [], | |
"responses": { "201": { "description": "" } }, | |
"tags": ["Billing"] | |
} | |
}, | |
"/billing/create-billing-portal-session": { | |
"post": { | |
"operationId": "createBillingPortalSession", | |
"parameters": [], | |
"responses": { | |
"201": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CreateBillingPortalSessionDto" | |
} | |
} | |
} | |
} | |
}, | |
"tags": ["Billing"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/invitations/organiatzions/accept/{token}": { | |
"get": { | |
"operationId": "acceptOrganizationInvitation", | |
"parameters": [ | |
{ | |
"name": "token", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"responses": { "200": { "description": "" } }, | |
"tags": ["Invitations"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/invitations/organizations/find": { | |
"post": { | |
"operationId": "findOrganizationInviation", | |
"parameters": [], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/FindOrganizationInvitationDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationInvitationEntity" | |
} | |
} | |
} | |
}, | |
"201": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { "type": "object" } | |
} | |
} | |
} | |
}, | |
"tags": ["Invitations"], | |
"security": [{ "bearer": [] }] | |
} | |
}, | |
"/invitations/organizations/{organizationId}": { | |
"post": { | |
"operationId": "createOrganizationInvitation", | |
"parameters": [ | |
{ | |
"name": "organizationId", | |
"required": true, | |
"in": "path", | |
"schema": { "type": "string" } | |
} | |
], | |
"requestBody": { | |
"required": true, | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CreateOrganizationInvitationDto" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "", | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationInvitationEntity" | |
} | |
} | |
} | |
}, | |
"201": { "description": "" } | |
}, | |
"tags": ["Invitations"], | |
"security": [{ "bearer": [] }] | |
} | |
} | |
}, | |
"info": { | |
"title": "GoSquad API", | |
"description": "API for GoSquad app", | |
"version": "0.0.1", | |
"contact": {} | |
}, | |
"tags": [{ "name": "", "description": "" }], | |
"servers": [], | |
"components": { | |
"securitySchemes": { | |
"bearer": { | |
"scheme": "bearer", | |
"bearerFormat": "JWT", | |
"type": "http" | |
} | |
}, | |
"schemas": { | |
"LoginDto": { | |
"type": "object", | |
"properties": { | |
"username": { "type": "string" }, | |
"password": { "type": "string" } | |
}, | |
"required": ["username", "password"] | |
}, | |
"TokenResponseDto": { | |
"type": "object", | |
"properties": { | |
"accessToken": { "type": "string" }, | |
"refreshToken": { "type": "string" } | |
}, | |
"required": ["accessToken", "refreshToken"] | |
}, | |
"TokenRefreshDto": { | |
"type": "object", | |
"properties": { "refreshToken": { "type": "string" } }, | |
"required": ["refreshToken"] | |
}, | |
"ConfirmEmailDto": { | |
"type": "object", | |
"properties": { "token": { "type": "string" } }, | |
"required": ["token"] | |
}, | |
"ResendEmailVerificationDto": { | |
"type": "object", | |
"properties": { "email": { "type": "string" } }, | |
"required": ["email"] | |
}, | |
"PasswordResetDto": { | |
"type": "object", | |
"properties": { | |
"newPassword": { "type": "string" }, | |
"token": { "type": "string" } | |
}, | |
"required": ["newPassword", "token"] | |
}, | |
"PasswordResetRequestDto": { | |
"type": "object", | |
"properties": { "email": { "type": "string" } }, | |
"required": ["email"] | |
}, | |
"CreateUserDto": { | |
"type": "object", | |
"properties": { | |
"email": { "type": "string" }, | |
"firstName": { "type": "string" }, | |
"lastName": { "type": "string" }, | |
"username": { "type": "string" }, | |
"password": { "type": "string" } | |
}, | |
"required": ["email", "username", "password"] | |
}, | |
"UpdateEmailAddressDto": { | |
"type": "object", | |
"properties": { "email": { "type": "string" } }, | |
"required": ["email"] | |
}, | |
"LicenseOverwriteEntity": { | |
"type": "object", | |
"properties": { | |
"id": { "type": "string" }, | |
"updatedAt": { | |
"format": "date-time", | |
"type": "string", | |
"nullable": true | |
}, | |
"createdAt": { "format": "date-time", "type": "string" }, | |
"features": { | |
"type": "array", | |
"items": { "type": "string" } | |
}, | |
"expiresAt": { | |
"format": "date-time", | |
"type": "string", | |
"nullable": true | |
}, | |
"emailLimit": { "type": "number", "nullable": true }, | |
"connectedInAccountLimit": { | |
"type": "number", | |
"nullable": true | |
}, | |
"connectedOutAccountLimit": { | |
"type": "number", | |
"nullable": true | |
}, | |
"syncSourceLimit": { "type": "number", "nullable": true }, | |
"postsPerSourceLimit": { | |
"type": "number", | |
"nullable": true | |
}, | |
"weeklySyncLimit": { "type": "number", "nullable": true }, | |
"organizationMemberLimit": { | |
"type": "number", | |
"nullable": true | |
}, | |
"workspaceLimit": { "type": "number", "nullable": true }, | |
"integrationOutLimit": { | |
"type": "number", | |
"nullable": true | |
}, | |
"organizationId": { "type": "string" } | |
}, | |
"required": [ | |
"id", | |
"updatedAt", | |
"createdAt", | |
"features", | |
"expiresAt", | |
"emailLimit", | |
"connectedInAccountLimit", | |
"connectedOutAccountLimit", | |
"syncSourceLimit", | |
"postsPerSourceLimit", | |
"weeklySyncLimit", | |
"organizationMemberLimit", | |
"workspaceLimit", | |
"integrationOutLimit", | |
"organizationId" | |
] | |
}, | |
"SyncLicenseInfoDto": { | |
"type": "object", | |
"properties": { | |
"postPerSourceLimit": { "type": "number" }, | |
"weeklySyncLimit": { "type": "number" }, | |
"availableSyncs": { "type": "number" }, | |
"syncSourceLimit": { "type": "number" } | |
}, | |
"required": [ | |
"postPerSourceLimit", | |
"weeklySyncLimit", | |
"availableSyncs", | |
"syncSourceLimit" | |
] | |
}, | |
"LicenseConsumptionDto": { | |
"type": "object", | |
"properties": { | |
"emailConsumption": { "type": "number" }, | |
"integrationOutConsumption": { "type": "number" }, | |
"memberConsumption": { "type": "number" }, | |
"workspaceConsumption": { "type": "number" }, | |
"connectedInAccountCount": { "type": "number" }, | |
"connectedOutAccountCount": { "type": "number" } | |
}, | |
"required": [ | |
"emailConsumption", | |
"integrationOutConsumption", | |
"memberConsumption", | |
"workspaceConsumption", | |
"connectedInAccountCount", | |
"connectedOutAccountCount" | |
] | |
}, | |
"ClaimSponsoredLicenseDto": { | |
"type": "object", | |
"properties": { "code": { "type": "string" } }, | |
"required": ["code"] | |
}, | |
"OrganizationEntity": { | |
"type": "object", | |
"properties": { | |
"id": { "type": "string" }, | |
"updatedAt": { | |
"format": "date-time", | |
"type": "string", | |
"nullable": true | |
}, | |
"createdAt": { "format": "date-time", "type": "string" }, | |
"name": { "type": "string" }, | |
"licenseType": { | |
"type": "string", | |
"enum": [ | |
"FREE", | |
"ESSENTIAL", | |
"BUSINESS", | |
"PROFESSIONAL", | |
"SPONSORED" | |
] | |
}, | |
"cancelledAt": { "format": "date-time", "type": "string" }, | |
"stripeCustomerId": { "type": "string" }, | |
"stripeSubscriptionId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"currentBillingPeriodEndsAt": { | |
"format": "date-time", | |
"type": "string", | |
"nullable": true | |
}, | |
"paymentStatus": { | |
"type": "string", | |
"enum": ["EXPIRED", "PAIMENT_FAILED"] | |
}, | |
"licenseOverwrite": { | |
"nullable": true, | |
"allOf": [ | |
{ | |
"$ref": "#/components/schemas/LicenseOverwriteEntity" | |
} | |
] | |
}, | |
"slug": { "type": "string" }, | |
"licenseId": { "type": "string" } | |
}, | |
"required": [ | |
"id", | |
"updatedAt", | |
"createdAt", | |
"name", | |
"licenseType", | |
"cancelledAt", | |
"stripeCustomerId", | |
"stripeSubscriptionId", | |
"currentBillingPeriodEndsAt", | |
"paymentStatus", | |
"licenseOverwrite", | |
"slug" | |
] | |
}, | |
"CreateOrganizationDto": { | |
"type": "object", | |
"properties": { | |
"name": { "type": "string" }, | |
"slug": { "type": "string" } | |
}, | |
"required": ["name", "slug"] | |
}, | |
"CreateWorkspaceDto": { | |
"type": "object", | |
"properties": { | |
"slug": { | |
"type": "string", | |
"minLength": 3, | |
"maxLength": 55 | |
}, | |
"name": { | |
"type": "string", | |
"minLength": 3, | |
"maxLength": 55 | |
} | |
}, | |
"required": ["slug", "name"] | |
}, | |
"AccountSetupDto": { | |
"type": "object", | |
"properties": { | |
"organization": { | |
"$ref": "#/components/schemas/CreateOrganizationDto" | |
}, | |
"workspace": { | |
"$ref": "#/components/schemas/CreateWorkspaceDto" | |
} | |
}, | |
"required": ["organization", "workspace"] | |
}, | |
"ChangeOrganizationRoleDto": { | |
"type": "object", | |
"properties": { | |
"userId": { "type": "string" }, | |
"organizationUserRole": { "type": "string" } | |
}, | |
"required": ["userId", "organizationUserRole"] | |
}, | |
"RemoveUserFromOrganizationDto": { | |
"type": "object", | |
"properties": { "userId": { "type": "string" } }, | |
"required": ["userId"] | |
}, | |
"PublicOrganizaitionEntity": { | |
"type": "object", | |
"properties": { | |
"name": { "type": "string" }, | |
"slug": { "type": "string" } | |
}, | |
"required": ["name", "slug"] | |
}, | |
"ProfileEntity": { | |
"type": "object", | |
"properties": { | |
"id": { "type": "string" }, | |
"createdAt": { "format": "date-time", "type": "string" }, | |
"updatedAt": { "format": "date-time", "type": "string" }, | |
"phone": { "type": "string" }, | |
"twitterLink": { "type": "string" }, | |
"linkedInLink": { "type": "string" }, | |
"userId": { "type": "string" } | |
}, | |
"required": ["id", "createdAt", "updatedAt", "userId"] | |
}, | |
"UserEntity": { | |
"type": "object", | |
"properties": { | |
"id": { "type": "string" }, | |
"email": { "type": "string" }, | |
"organizationRole": { | |
"type": "string", | |
"enum": ["ADMIN", "USER"] | |
}, | |
"firstName": { "type": "string" }, | |
"lastName": { "type": "string" }, | |
"username": { "type": "string" }, | |
"password": { "type": "string" }, | |
"isGlobalAppAdministrator": { "type": "boolean" }, | |
"isActive": { "type": "boolean" }, | |
"isVerified": { "type": "boolean" }, | |
"lastLogin": { "format": "date-time", "type": "string" }, | |
"workspaceId": { "type": "string" }, | |
"createdAt": { "format": "date-time", "type": "string" }, | |
"updatedAt": { "format": "date-time", "type": "string" }, | |
"organizationId": { "type": "string" }, | |
"avatar": { "type": "string" }, | |
"profile": { "$ref": "#/components/schemas/ProfileEntity" } | |
}, | |
"required": [ | |
"id", | |
"email", | |
"organizationRole", | |
"username", | |
"password", | |
"isGlobalAppAdministrator", | |
"isActive", | |
"isVerified", | |
"lastLogin", | |
"workspaceId", | |
"createdAt", | |
"updatedAt", | |
"organizationId", | |
"profile" | |
] | |
}, | |
"UpdateOrganizationDto": { | |
"type": "object", | |
"properties": { "name": { "type": "string" } }, | |
"required": ["name"] | |
}, | |
"WorkspaceEntity": { | |
"type": "object", | |
"properties": { | |
"id": { "type": "string" }, | |
"updatedAt": { | |
"format": "date-time", | |
"type": "string", | |
"nullable": true | |
}, | |
"createdAt": { "format": "date-time", "type": "string" }, | |
"slug": { | |
"type": "string", | |
"minLength": 3, | |
"maxLength": 55 | |
}, | |
"name": { | |
"type": "string", | |
"minLength": 3, | |
"maxLength": 55 | |
}, | |
"organizationId": { "type": "string" }, | |
"organization": { | |
"$ref": "#/components/schemas/OrganizationEntity" | |
} | |
}, | |
"required": [ | |
"id", | |
"updatedAt", | |
"createdAt", | |
"slug", | |
"name", | |
"organizationId", | |
"organization" | |
] | |
}, | |
"UsersOnWorkspacesEntity": { | |
"type": "object", | |
"properties": { | |
"assignedAt": { "format": "date-time", "type": "string" }, | |
"workspaceId": { "type": "string" }, | |
"userId": { "type": "string" }, | |
"role": { "type": "string" } | |
}, | |
"required": ["assignedAt", "workspaceId", "userId", "role"] | |
}, | |
"ChangeWorkspaceRoleDto": { | |
"type": "object", | |
"properties": { | |
"userId": { "type": "string" }, | |
"role": { "type": "string" } | |
}, | |
"required": ["userId", "role"] | |
}, | |
"UpdateWorkspaceDto": { | |
"type": "object", | |
"properties": { | |
"slug": { | |
"type": "string", | |
"minLength": 3, | |
"maxLength": 55 | |
} | |
}, | |
"required": ["slug"] | |
}, | |
"PublicWorkspaceEntity": { | |
"type": "object", | |
"properties": { | |
"slug": { | |
"type": "string", | |
"minLength": 3, | |
"maxLength": 55 | |
}, | |
"name": { | |
"type": "string", | |
"minLength": 3, | |
"maxLength": 55 | |
} | |
}, | |
"required": ["slug", "name"] | |
}, | |
"SocialIdentityEntity": { | |
"type": "object", | |
"properties": { | |
"id": { "type": "string" }, | |
"updatedAt": { | |
"format": "date-time", | |
"type": "string", | |
"nullable": true | |
}, | |
"createdAt": { "format": "date-time", "type": "string" }, | |
"organizationId": { "type": "string" }, | |
"provider": { | |
"type": "string", | |
"enum": ["LINKEDIN", "TWITTER"] | |
}, | |
"profileId": { "type": "string" }, | |
"username": { "type": "string" }, | |
"name": { "type": "string" }, | |
"profileImageUrl": { "type": "string" }, | |
"accessTokenExpiresAt": { | |
"format": "date-time", | |
"type": "string" | |
}, | |
"refreshTokenExpiresAt": { | |
"format": "date-time", | |
"type": "string" | |
}, | |
"workspaceList": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/WorkspaceEntity" | |
} | |
} | |
}, | |
"required": [ | |
"id", | |
"updatedAt", | |
"createdAt", | |
"organizationId", | |
"provider", | |
"profileId", | |
"username", | |
"name", | |
"profileImageUrl", | |
"accessTokenExpiresAt", | |
"refreshTokenExpiresAt", | |
"workspaceList" | |
] | |
}, | |
"ChangeWorkspacesDto": { | |
"type": "object", | |
"properties": { "workspaceId": { "type": "string" } }, | |
"required": ["workspaceId"] | |
}, | |
"SlackChannelEntity": { | |
"type": "object", | |
"properties": { | |
"id": { "type": "string" }, | |
"updatedAt": { | |
"format": "date-time", | |
"type": "string", | |
"nullable": true | |
}, | |
"createdAt": { "format": "date-time", "type": "string" }, | |
"channelId": { "type": "string" }, | |
"channelName": { "type": "string" }, | |
"encryptedWriteUrl": { "type": "string" }, | |
"configurationUrl": { "type": "string" }, | |
"organizationId": { "type": "string" }, | |
"teamName": { "type": "string" }, | |
"teamId": { "type": "string" }, | |
"workspaceList": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/WorkspaceEntity" | |
} | |
} | |
}, | |
"required": [ | |
"id", | |
"updatedAt", | |
"createdAt", | |
"channelId", | |
"channelName", | |
"encryptedWriteUrl", | |
"configurationUrl", | |
"organizationId", | |
"teamName", | |
"teamId", | |
"workspaceList" | |
] | |
}, | |
"TwitterPostEntity": { | |
"type": "object", | |
"properties": { | |
"id": { "type": "string" }, | |
"author_id": { "type": "string" }, | |
"text": { "type": "string" }, | |
"created_at": { "type": "string" }, | |
"possibily_sensitive": { "type": "boolean" }, | |
"url": { "type": "string" } | |
}, | |
"required": [ | |
"id", | |
"author_id", | |
"text", | |
"created_at", | |
"possibily_sensitive", | |
"url" | |
] | |
}, | |
"LinkedInOrganizationEntity": { | |
"type": "object", | |
"properties": { | |
"id": { "type": "string" }, | |
"name": { "type": "string" }, | |
"socialIdentityId": { "type": "string" } | |
}, | |
"required": ["id", "name", "socialIdentityId"] | |
}, | |
"LinkedInShareEntity": { | |
"type": "object", | |
"properties": { | |
"bodyText": { "type": "string" }, | |
"organizationUrn": { "type": "string" }, | |
"activityUrn": { "type": "string" }, | |
"url": { "type": "string" } | |
}, | |
"required": [ | |
"bodyText", | |
"organizationUrn", | |
"activityUrn", | |
"url" | |
] | |
}, | |
"PublicContactEmailManagementEntity": { | |
"type": "object", | |
"properties": { | |
"id": { "type": "string" }, | |
"allowsGeneralEmails": { "type": "boolean" } | |
}, | |
"required": ["id", "allowsGeneralEmails"] | |
}, | |
"ManageContactEmailSettingsDto": { | |
"type": "object", | |
"properties": { "allowsGeneralEmails": { "type": "boolean" } }, | |
"required": ["allowsGeneralEmails"] | |
}, | |
"AddContactToSquadDto": { | |
"type": "object", | |
"properties": { "contactId": { "type": "string" } }, | |
"required": ["contactId"] | |
}, | |
"SquadEntityCountDto": { | |
"type": "object", | |
"properties": { "contactList": { "type": "number" } }, | |
"required": ["contactList"] | |
}, | |
"SquadEntity": { | |
"type": "object", | |
"properties": { | |
"id": { "type": "string" }, | |
"updatedAt": { | |
"format": "date-time", | |
"type": "string", | |
"nullable": true | |
}, | |
"createdAt": { "format": "date-time", "type": "string" }, | |
"name": { "type": "string" }, | |
"organizationId": { "type": "string" }, | |
"description": { "type": "string" }, | |
"workspaceId": { "type": "string" }, | |
"visibility": { | |
"type": "string", | |
"enum": ["PRIVATE", "PUBLIC"] | |
}, | |
"_count": { | |
"$ref": "#/components/schemas/SquadEntityCountDto" | |
} | |
}, | |
"required": [ | |
"id", | |
"updatedAt", | |
"createdAt", | |
"name", | |
"organizationId", | |
"description", | |
"workspaceId", | |
"visibility", | |
"_count" | |
] | |
}, | |
"ContactsOnSquadsEntity": { | |
"type": "object", | |
"properties": { | |
"createdAt": { "format": "date-time", "type": "string" }, | |
"updatedAt": { "format": "date-time", "type": "string" }, | |
"squadId": { "type": "string" }, | |
"contactId": { "type": "string" }, | |
"squad": { "$ref": "#/components/schemas/SquadEntity" } | |
}, | |
"required": [ | |
"createdAt", | |
"updatedAt", | |
"squadId", | |
"contactId", | |
"squad" | |
] | |
}, | |
"ProtectedUserEntity": { | |
"type": "object", | |
"properties": { | |
"id": { "type": "string" }, | |
"firstName": { "type": "string" }, | |
"lastName": { "type": "string" }, | |
"username": { "type": "string" }, | |
"isGlobalAppAdministrator": { "type": "boolean" }, | |
"isActive": { "type": "boolean" }, | |
"createdAt": { "format": "date-time", "type": "string" }, | |
"updatedAt": { "format": "date-time", "type": "string" }, | |
"avatar": { "type": "string" } | |
}, | |
"required": [ | |
"id", | |
"username", | |
"isGlobalAppAdministrator", | |
"isActive", | |
"createdAt", | |
"updatedAt" | |
] | |
}, | |
"ContactEntity": { | |
"type": "object", | |
"properties": { | |
"id": { "type": "string" }, | |
"updatedAt": { | |
"format": "date-time", | |
"type": "string", | |
"nullable": true | |
}, | |
"createdAt": { "format": "date-time", "type": "string" }, | |
"firstName": { "type": "string" }, | |
"lastName": { "type": "string" }, | |
"allowsGeneralEmails": { "type": "boolean" }, | |
"email": { "type": "string" }, | |
"userId": { "type": "string" }, | |
"organizationId": { "type": "string" }, | |
"workspaceId": { "type": "string" }, | |
"user": { | |
"$ref": "#/components/schemas/ProtectedUserEntity" | |
}, | |
"squadList": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/ContactsOnSquadsEntity" | |
} | |
} | |
}, | |
"required": [ | |
"id", | |
"updatedAt", | |
"createdAt", | |
"firstName", | |
"lastName", | |
"allowsGeneralEmails", | |
"email", | |
"userId", | |
"organizationId", | |
"workspaceId", | |
"user", | |
"squadList" | |
] | |
}, | |
"CreateContactDto": { | |
"type": "object", | |
"properties": { | |
"firstName": { "type": "string" }, | |
"lastName": { "type": "string" }, | |
"email": { "type": "string" } | |
}, | |
"required": ["firstName", "lastName", "email"] | |
}, | |
"UpdateContactDto": { | |
"type": "object", | |
"properties": { | |
"firstName": { "type": "string" }, | |
"lastName": { "type": "string" }, | |
"email": { "type": "string" } | |
}, | |
"required": ["firstName", "lastName", "email"] | |
}, | |
"UpdateUserDto": { | |
"type": "object", | |
"properties": { | |
"firstName": { "type": "string" }, | |
"lastName": { "type": "string" }, | |
"username": { "type": "string" } | |
}, | |
"required": ["username"] | |
}, | |
"UpdateProfileDto": { | |
"type": "object", | |
"properties": { | |
"phone": { "type": "string" }, | |
"linkedInLink": { "type": "string" } | |
} | |
}, | |
"CreateCustomerRequestDto": { | |
"type": "object", | |
"properties": { | |
"title": { "type": "string" }, | |
"type": { "type": "string", "enum": ["CONTACT_US"] }, | |
"senderId": { "type": "string" }, | |
"bodyText": { "type": "string" } | |
}, | |
"required": ["title", "type", "senderId", "bodyText"] | |
}, | |
"CustomerRequestEntity": { | |
"type": "object", | |
"properties": { | |
"id": { "type": "string" }, | |
"updatedAt": { | |
"format": "date-time", | |
"type": "string", | |
"nullable": true | |
}, | |
"createdAt": { "format": "date-time", "type": "string" }, | |
"title": { "type": "string" }, | |
"type": { "type": "string", "enum": ["CONTACT_US"] }, | |
"senderId": { "type": "string" }, | |
"bodyText": { "type": "string" } | |
}, | |
"required": [ | |
"id", | |
"updatedAt", | |
"createdAt", | |
"title", | |
"type", | |
"senderId", | |
"bodyText" | |
] | |
}, | |
"SquadNoCountEntity": { | |
"type": "object", | |
"properties": { | |
"id": { "type": "string" }, | |
"updatedAt": { | |
"format": "date-time", | |
"type": "string", | |
"nullable": true | |
}, | |
"createdAt": { "format": "date-time", "type": "string" }, | |
"name": { "type": "string" }, | |
"organizationId": { "type": "string" }, | |
"description": { "type": "string" }, | |
"workspaceId": { "type": "string" }, | |
"visibility": { | |
"type": "string", | |
"enum": ["PRIVATE", "PUBLIC"] | |
} | |
}, | |
"required": [ | |
"id", | |
"updatedAt", | |
"createdAt", | |
"name", | |
"organizationId", | |
"description", | |
"workspaceId", | |
"visibility" | |
] | |
}, | |
"DigestEntity": { | |
"type": "object", | |
"properties": { | |
"id": { "type": "string" }, | |
"updatedAt": { | |
"format": "date-time", | |
"type": "string", | |
"nullable": true | |
}, | |
"createdAt": { "format": "date-time", "type": "string" }, | |
"status": { | |
"type": "string", | |
"enum": [ | |
"SENDING_IN_PROGRESS", | |
"SENT", | |
"DRAFT", | |
"ERROR" | |
] | |
}, | |
"name": { "type": "string" }, | |
"workspaceId": { "type": "string" }, | |
"organizationId": { "type": "string" }, | |
"squadList": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/SquadNoCountEntity" | |
} | |
}, | |
"slackChannelList": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/SlackChannelEntity" | |
} | |
}, | |
"title": { "type": "string" }, | |
"editorState": { "type": "string" }, | |
"type": { "type": "string", "enum": ["SYNC"] } | |
}, | |
"required": [ | |
"id", | |
"updatedAt", | |
"createdAt", | |
"status", | |
"name", | |
"workspaceId", | |
"organizationId", | |
"squadList", | |
"slackChannelList", | |
"type" | |
] | |
}, | |
"UpdateDigestDto": { | |
"type": "object", | |
"properties": { | |
"title": { "type": "string" }, | |
"editorState": { "type": "string" }, | |
"name": { "type": "string" } | |
} | |
}, | |
"UpdateDigestRecipientsDto": { | |
"type": "object", | |
"properties": { | |
"squadIdList": { | |
"type": "array", | |
"items": { "type": "string" } | |
}, | |
"slackChannelList": { | |
"type": "array", | |
"items": { "type": "string" } | |
} | |
}, | |
"required": ["squadIdList", "slackChannelList"] | |
}, | |
"CreateDigestDto": { | |
"type": "object", | |
"properties": { "name": { "type": "string" } }, | |
"required": ["name"] | |
}, | |
"PublicSquadEntity": { | |
"type": "object", | |
"properties": { | |
"id": { "type": "string" }, | |
"name": { "type": "string" }, | |
"description": { "type": "string" }, | |
"visibility": { | |
"type": "string", | |
"enum": ["PRIVATE", "PUBLIC"] | |
} | |
}, | |
"required": ["id", "name", "description", "visibility"] | |
}, | |
"AcceptSquadInviationDto": { | |
"type": "object", | |
"properties": { "token": { "type": "string" } }, | |
"required": ["token"] | |
}, | |
"CreateSquadInvitationDto": { | |
"type": "object", | |
"properties": { | |
"firstName": { "type": "string" }, | |
"lastName": { "type": "string" }, | |
"email": { "type": "string" }, | |
"squadId": { "type": "string" } | |
}, | |
"required": ["firstName", "lastName", "email", "squadId"] | |
}, | |
"SquadInvitationEntity": { | |
"type": "object", | |
"properties": { | |
"id": { "type": "string" }, | |
"updatedAt": { | |
"format": "date-time", | |
"type": "string", | |
"nullable": true | |
}, | |
"createdAt": { "format": "date-time", "type": "string" }, | |
"firstName": { "type": "string" }, | |
"lastName": { "type": "string" }, | |
"token": { "type": "string" }, | |
"creatorType": { | |
"type": "string", | |
"enum": ["SQUAD_OWNER", "INVITEE"] | |
}, | |
"email": { "type": "string" }, | |
"squadId": { "type": "string" }, | |
"organizationId": { "type": "string" }, | |
"workspaceId": { "type": "string" } | |
}, | |
"required": [ | |
"id", | |
"updatedAt", | |
"createdAt", | |
"firstName", | |
"lastName", | |
"token", | |
"creatorType", | |
"email", | |
"squadId", | |
"organizationId", | |
"workspaceId" | |
] | |
}, | |
"CreateSquadDto": { | |
"type": "object", | |
"properties": { | |
"name": { "type": "string" }, | |
"description": { "type": "string" }, | |
"visibility": { | |
"type": "string", | |
"enum": ["PRIVATE", "PUBLIC"] | |
} | |
}, | |
"required": ["name", "description", "visibility"] | |
}, | |
"UpdateSquadDto": { | |
"type": "object", | |
"properties": { | |
"name": { "type": "string" }, | |
"description": { "type": "string" }, | |
"visibility": { | |
"type": "string", | |
"enum": ["PRIVATE", "PUBLIC"] | |
} | |
}, | |
"required": ["name", "description", "visibility"] | |
}, | |
"SendSyncsDto": { | |
"type": "object", | |
"properties": { "apiKey": { "type": "string" } }, | |
"required": ["apiKey"] | |
}, | |
"RecipientEntity": { | |
"type": "object", | |
"properties": { | |
"id": { "type": "string" }, | |
"updatedAt": { | |
"format": "date-time", | |
"type": "string", | |
"nullable": true | |
}, | |
"createdAt": { "format": "date-time", "type": "string" }, | |
"workspaceId": { "type": "string" }, | |
"organizationId": { "type": "string" }, | |
"slackChannelId": { "type": "string" }, | |
"squadId": { "type": "string" }, | |
"contactId": { "type": "string" }, | |
"syncId": { "type": "string" }, | |
"digestId": { "type": "string" }, | |
"squad": { | |
"nullable": true, | |
"allOf": [ | |
{ "$ref": "#/components/schemas/SquadEntity" } | |
] | |
}, | |
"slackChannel": { | |
"nullable": true, | |
"allOf": [ | |
{ | |
"$ref": "#/components/schemas/SlackChannelEntity" | |
} | |
] | |
} | |
}, | |
"required": [ | |
"id", | |
"updatedAt", | |
"createdAt", | |
"workspaceId", | |
"organizationId", | |
"slackChannelId", | |
"squadId", | |
"contactId", | |
"syncId", | |
"digestId" | |
] | |
}, | |
"ContentSourceEntity": { | |
"type": "object", | |
"properties": { | |
"id": { "type": "string" }, | |
"updatedAt": { | |
"format": "date-time", | |
"type": "string", | |
"nullable": true | |
}, | |
"createdAt": { "format": "date-time", "type": "string" }, | |
"organizationId": { "type": "string" }, | |
"workspaceId": { "type": "string" }, | |
"referenceId": { "type": "string" }, | |
"referenceUsername": { "type": "string" }, | |
"referenceAvatarUrl": { "type": "string" }, | |
"socialIdentityId": { "type": "string" }, | |
"socialIdentity": { | |
"$ref": "#/components/schemas/SocialIdentityEntity" | |
}, | |
"status": { "type": "object" }, | |
"type": { | |
"type": "string", | |
"enum": ["LINKED_IN_PAGE", "TWITTER_ACCOUNT"] | |
} | |
}, | |
"required": [ | |
"id", | |
"updatedAt", | |
"createdAt", | |
"organizationId", | |
"workspaceId", | |
"socialIdentityId", | |
"socialIdentity", | |
"status", | |
"type" | |
] | |
}, | |
"SyncEntity": { | |
"type": "object", | |
"properties": { | |
"id": { "type": "string" }, | |
"updatedAt": { | |
"format": "date-time", | |
"type": "string", | |
"nullable": true | |
}, | |
"createdAt": { "format": "date-time", "type": "string" }, | |
"name": { "type": "string" }, | |
"postsPerSource": { | |
"type": "number", | |
"minimum": 1, | |
"maximum": 50 | |
}, | |
"status": { | |
"type": "string", | |
"enum": ["ACTIVE", "PAUSED", "ERROR"] | |
}, | |
"frequency": { | |
"type": "string", | |
"enum": ["DAILY", "WEEKLY"] | |
}, | |
"workspaceId": { "type": "string" }, | |
"lastSentAt": { "format": "date-time", "type": "string" }, | |
"lastStatus": { | |
"type": "string", | |
"enum": ["SUCCESS", "ERROR"] | |
}, | |
"organizationId": { "type": "string" }, | |
"userId": { "type": "string" }, | |
"recipientList": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/RecipientEntity" | |
} | |
}, | |
"contentSourceList": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/ContentSourceEntity" | |
} | |
} | |
}, | |
"required": [ | |
"id", | |
"updatedAt", | |
"createdAt", | |
"name", | |
"postsPerSource", | |
"status", | |
"frequency", | |
"workspaceId", | |
"lastSentAt", | |
"lastStatus", | |
"organizationId", | |
"userId", | |
"recipientList", | |
"contentSourceList" | |
] | |
}, | |
"ContentSourceCandidateCreateDto": { | |
"type": "object", | |
"properties": { | |
"provider": { | |
"type": "string", | |
"enum": ["LINKEDIN", "TWITTER", "INSTAGRAM"] | |
}, | |
"referenceId": { "type": "string" }, | |
"referenceUsername": { "type": "string" }, | |
"referenceAvatarUrl": { "type": "string" }, | |
"socialIdentityId": { "type": "string" } | |
}, | |
"required": ["socialIdentityId"] | |
}, | |
"CreateSyncDto": { | |
"type": "object", | |
"properties": { | |
"name": { "type": "string" }, | |
"postsPerSource": { | |
"type": "number", | |
"minimum": 1, | |
"maximum": 50 | |
}, | |
"frequency": { | |
"type": "string", | |
"enum": ["DAILY", "WEEKLY"] | |
}, | |
"slackChannelIdList": { | |
"type": "array", | |
"items": { "type": "string" } | |
}, | |
"squadIdList": { | |
"type": "array", | |
"items": { "type": "string" } | |
}, | |
"contentSourceCandidateList": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/ContentSourceCandidateCreateDto" | |
} | |
} | |
}, | |
"required": [ | |
"name", | |
"postsPerSource", | |
"frequency", | |
"slackChannelIdList", | |
"squadIdList", | |
"contentSourceCandidateList" | |
] | |
}, | |
"ContentSourceCandidateEntity": { | |
"type": "object", | |
"properties": { | |
"provider": { | |
"type": "string", | |
"enum": ["LINKEDIN", "TWITTER", "INSTAGRAM"] | |
}, | |
"referenceId": { "type": "string" }, | |
"referenceUsername": { "type": "string" }, | |
"referenceAvatarUrl": { "type": "string" }, | |
"username": { "type": "string" }, | |
"socialIdentityId": { "type": "string" } | |
}, | |
"required": ["username", "socialIdentityId"] | |
}, | |
"UpdateSyncDto": { | |
"type": "object", | |
"properties": { | |
"postsPerSource": { | |
"type": "number", | |
"minimum": 1, | |
"maximum": 50 | |
}, | |
"frequency": { | |
"type": "string", | |
"enum": ["DAILY", "WEEKLY"] | |
}, | |
"slackChannelIdList": { | |
"type": "array", | |
"items": { "type": "string" } | |
}, | |
"squadIdList": { | |
"type": "array", | |
"items": { "type": "string" } | |
}, | |
"contentSourceCandidateList": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/ContentSourceCandidateCreateDto" | |
} | |
} | |
}, | |
"required": [ | |
"postsPerSource", | |
"frequency", | |
"slackChannelIdList", | |
"squadIdList", | |
"contentSourceCandidateList" | |
] | |
}, | |
"AddRecipientDto": { "type": "object", "properties": {} }, | |
"RemoveRecipientDto": { | |
"type": "object", | |
"properties": { "recipientId": { "type": "string" } }, | |
"required": ["recipientId"] | |
}, | |
"FindMetaDataDto": { | |
"type": "object", | |
"properties": { "url": { "type": "string" } }, | |
"required": ["url"] | |
}, | |
"OmitTypeClass": { | |
"type": "object", | |
"properties": { | |
"id": { "type": "string" }, | |
"updatedAt": { | |
"format": "date-time", | |
"type": "string", | |
"nullable": true | |
}, | |
"createdAt": { "format": "date-time", "type": "string" }, | |
"organizationId": { "type": "string" }, | |
"provider": { | |
"type": "string", | |
"enum": ["LINKEDIN", "TWITTER"] | |
}, | |
"profileId": { "type": "string" }, | |
"username": { "type": "string" }, | |
"name": { "type": "string" }, | |
"profileImageUrl": { "type": "string" }, | |
"accessTokenExpiresAt": { | |
"format": "date-time", | |
"type": "string" | |
}, | |
"refreshTokenExpiresAt": { | |
"format": "date-time", | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"id", | |
"updatedAt", | |
"createdAt", | |
"organizationId", | |
"provider", | |
"profileId", | |
"username", | |
"name", | |
"profileImageUrl", | |
"accessTokenExpiresAt", | |
"refreshTokenExpiresAt" | |
] | |
}, | |
"ShareEntity": { | |
"type": "object", | |
"properties": { | |
"id": { "type": "string" }, | |
"updatedAt": { | |
"format": "date-time", | |
"type": "string", | |
"nullable": true | |
}, | |
"createdAt": { "format": "date-time", "type": "string" }, | |
"workspaceId": { "type": "string" }, | |
"socialIdentityId": { "type": "string" }, | |
"organizationId": { "type": "string" }, | |
"title": { "type": "string" }, | |
"postedAt": { "format": "date-time", "type": "string" }, | |
"contentSourceId": { "type": "string" }, | |
"bodyText": { "type": "string" }, | |
"url": { "type": "string" }, | |
"user": { "$ref": "#/components/schemas/UserEntity" }, | |
"socialIdentity": { | |
"$ref": "#/components/schemas/OmitTypeClass" | |
}, | |
"userId": { "type": "string" }, | |
"provider": { | |
"type": "string", | |
"enum": ["LINKEDIN", "TWITTER", "INSTAGRAM"] | |
}, | |
"providerDomain": { "type": "string" }, | |
"sourceId": { "type": "string" } | |
}, | |
"required": [ | |
"id", | |
"updatedAt", | |
"createdAt", | |
"workspaceId", | |
"organizationId", | |
"postedAt", | |
"bodyText", | |
"url", | |
"user", | |
"socialIdentity", | |
"userId", | |
"providerDomain" | |
] | |
}, | |
"UpdateShareDto": { | |
"type": "object", | |
"properties": { | |
"title": { "type": "string" }, | |
"bodyText": { "type": "string" } | |
}, | |
"required": ["bodyText"] | |
}, | |
"CreateShareDto": { | |
"type": "object", | |
"properties": { | |
"socialIdentityId": { "type": "string" }, | |
"title": { "type": "string" }, | |
"bodyText": { "type": "string" }, | |
"url": { "type": "string" }, | |
"provider": { | |
"type": "string", | |
"enum": ["LINKEDIN", "TWITTER", "INSTAGRAM"] | |
}, | |
"providerDomain": { "type": "string" }, | |
"sourceId": { "type": "string" } | |
}, | |
"required": ["bodyText", "url", "providerDomain"] | |
}, | |
"CreateContentListDto": { | |
"type": "object", | |
"properties": { "digestId": { "type": "string" } }, | |
"required": ["digestId"] | |
}, | |
"ContentListEntity": { | |
"type": "object", | |
"properties": { | |
"id": { "type": "string" }, | |
"updatedAt": { | |
"format": "date-time", | |
"type": "string", | |
"nullable": true | |
}, | |
"createdAt": { "format": "date-time", "type": "string" }, | |
"workspaceId": { "type": "string" }, | |
"digestId": { "type": "string" }, | |
"name": { "type": "string" }, | |
"shareList": { | |
"type": "array", | |
"items": { "$ref": "#/components/schemas/ShareEntity" } | |
} | |
}, | |
"required": [ | |
"id", | |
"updatedAt", | |
"createdAt", | |
"workspaceId", | |
"digestId", | |
"shareList" | |
] | |
}, | |
"UpdateContentListDto": { | |
"type": "object", | |
"properties": { "name": { "type": "string" } } | |
}, | |
"ShareAssocciationDto": { | |
"type": "object", | |
"properties": { "shareId": { "type": "string" } }, | |
"required": ["shareId"] | |
}, | |
"PriceEntity": { | |
"type": "object", | |
"properties": { | |
"unitAmount": { "type": "number" }, | |
"stripeProductId": { "type": "string" }, | |
"stripePriceId": { "type": "string" }, | |
"currency": { "type": "string", "enum": ["usd", "eur"] }, | |
"interval": { "type": "string", "enum": ["month", "year"] } | |
}, | |
"required": [ | |
"unitAmount", | |
"stripeProductId", | |
"stripePriceId", | |
"currency", | |
"interval" | |
] | |
}, | |
"ProductEntity": { | |
"type": "object", | |
"properties": { | |
"name": { "type": "string" }, | |
"stripeProductId": { "type": "string" }, | |
"prices": { | |
"type": "array", | |
"items": { "$ref": "#/components/schemas/PriceEntity" } | |
} | |
}, | |
"required": ["name", "stripeProductId", "prices"] | |
}, | |
"RetrieveCustomerAndSessionDto": { | |
"type": "object", | |
"properties": { "sessionId": { "type": "string" } }, | |
"required": ["sessionId"] | |
}, | |
"CreateCheckoutSessionDto": { | |
"type": "object", | |
"properties": { "priceId": { "type": "string" } }, | |
"required": ["priceId"] | |
}, | |
"CreateBillingPortalSessionDto": { | |
"type": "object", | |
"properties": { "url": { "type": "string" } }, | |
"required": ["url"] | |
}, | |
"FindOrganizationInvitationDto": { | |
"type": "object", | |
"properties": { "email": { "type": "string" } }, | |
"required": ["email"] | |
}, | |
"OrganizationInvitationEntity": { | |
"type": "object", | |
"properties": { | |
"id": { "type": "string" }, | |
"updatedAt": { | |
"format": "date-time", | |
"type": "string", | |
"nullable": true | |
}, | |
"createdAt": { "format": "date-time", "type": "string" }, | |
"organizationId": { "type": "string" }, | |
"addToWorkspaces": { "type": "boolean" }, | |
"email": { "type": "string" }, | |
"firstName": { "type": "string" }, | |
"lastName": { "type": "string" }, | |
"token": { "type": "string" }, | |
"validUntil": { "format": "date-time", "type": "string" }, | |
"organization": { | |
"$ref": "#/components/schemas/PublicOrganizaitionEntity" | |
} | |
}, | |
"required": [ | |
"id", | |
"updatedAt", | |
"createdAt", | |
"organizationId", | |
"addToWorkspaces", | |
"email", | |
"firstName", | |
"lastName", | |
"token", | |
"validUntil", | |
"organization" | |
] | |
}, | |
"CreateOrganizationInvitationDto": { | |
"type": "object", | |
"properties": { | |
"addToWorkspaces": { "type": "boolean" }, | |
"email": { "type": "string" }, | |
"firstName": { "type": "string" }, | |
"lastName": { "type": "string" } | |
}, | |
"required": [ | |
"addToWorkspaces", | |
"email", | |
"firstName", | |
"lastName" | |
] | |
} | |
} | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment