{"swaggerDoc":{"openapi":"3.0.0","info":{"version":"1.14.2","title":"Asset Service","description":"The Easil Asset Service handles requests for asset related items like designs, images and fonts"},"servers":[{"url":"http://localhost:3000","description":"Local server"},{"url":"https://dev-asset.easil.com","description":"Development server"}],"paths":{"/v1/template-sizes":{"post":{"summary":"Create template size","description":"Create a specific template size based on the given data","operationId":"postTemplateSize","tags":["Template Size"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["templateCode","name","category","width","height","templateType","active","doubleSided","measurementUnits"],"properties":{"templateCode":{"type":"string"},"name":{"type":"string"},"category":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"templateType":{"type":"string"},"active":{"type":"boolean"},"doubleSided":{"type":"boolean"},"measurementUnits":{"type":"string","example":["mm","in"]}}}}}},"responses":{"201":{"description":"TemplateSize created","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemplateSize"}}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/template-sizes/{templateCode}":{"get":{"summary":"Find template size","description":"Find a specific template size based on the template code","operationId":"getTemplateSize","tags":["Template Size"],"security":[{"bearerToken":[]}],"parameters":[{"in":"path","name":"templateCode","schema":{"type":"string"},"required":true,"description":"template code of the template size."}],"responses":{"200":{"description":"TemplateSize found","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemplateSize"}}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"put":{"summary":"update template size","description":"update a specific template size based on the template code","operationId":"putTemplateSize","tags":["Template Size"],"security":[{"bearerToken":[]}],"parameters":[{"in":"path","name":"templateCode","schema":{"type":"string"},"required":true,"description":"template code of the template size."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["templateCode","name","category","width","height","templateType","active","doubleSided","measurementUnits"],"properties":{"templateCode":{"type":"string"},"name":{"type":"string"},"category":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"templateType":{"type":"string"},"active":{"type":"boolean"},"doubleSided":{"type":"boolean"},"measurementUnits":{"type":"string","example":["mm","in"]}}}}}},"responses":{"200":{"description":"TemplateSize updated","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemplateSize"}}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/designs":{"post":{"summary":"Creates a design","description":"Create design by: 1. Duplicate an exisiting workspace DRAFT design. Edit design of team template 3. Edit design of easil catalogue","operationId":"createDesign","tags":["design"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["teamId"],"properties":{"teamId":{"type":"string","format":"UUID"},"parentId":{"type":"string","format":"UUID"},"measurements":{"$ref":"#/components/schemas/Measurements"}}}}}},"responses":{"201":{"description":"Design successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesignResponse"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"patch":{"summary":"Updates a set of designs","description":"Updates a set of designs","operationId":"partialUpdateDesign","tags":["design"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"UUID"},"status":{"type":"string"},"archived":{"type":"string"}}}}}}},"responses":{"207":{"description":"Designs successfully processed. Response position corresponds with request position","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"status":{"type":"integer","example":200},"body":{"$ref":"#/components/schemas/Design"}}}}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"get":{"summary":"Search designs","description":"Search a users workspace or team catalogue for designs matching the provided term","operationId":"searchDesigns","tags":["design"],"security":[{"bearerToken":[]}],"parameters":[{"in":"query","name":"term","schema":{"type":"string"},"required":true,"description":"General search term used in the query. Matches against design title and tags"},{"in":"query","name":"context","schema":{"type":"string","enum":["workspace","templates"]},"required":true,"description":"Search either Workspace or Templates for matching designs"},{"in":"query","name":"scope","schema":{"type":"string","enum":["easil","team"]},"required":true,"description":"Combines with the 'context' param to determine whether to search the Easil or Team templates"},{"in":"query","name":"status","schema":{"type":"string"},"required":true,"description":"Filter search by status"},{"in":"query","name":"offset","schema":{"type":"integer"},"description":"Offset pagination value. Default: 0"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Count pagination value. Default: 20. Max: 100"}],"responses":{"200":{"description":"Designs found","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CategoryDesignResponse"}}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/designs/suggestions":{"get":{"summary":"Design search suggestion list","description":"Curated list of Design search suggestions","operationId":"getSuggestionsDeprecated","deprecated":true,"tags":["design"],"security":[{"bearerToken":[]}],"parameters":[{"in":"query","name":"term","schema":{"type":"string"},"required":true,"description":"General search term used in the query"},{"in":"query","name":"offset","schema":{"type":"integer"},"description":"Offset pagination value"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Count pagination value"}],"responses":{"200":{"description":"Suggestions found","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v2/designs/suggestions":{"get":{"summary":"Get design suggestions based on partial search term","description":"Fetches a list of either design term (title) or design size suggestions from a partial search term that than can be used to search designs with.","operationId":"getSuggestions","tags":["design"],"security":[{"bearerToken":[]}],"parameters":[{"in":"query","name":"term","schema":{"type":"string"},"required":true,"description":"General search term used in the query"},{"in":"query","name":"offset","schema":{"type":"integer"},"description":"Offset pagination value"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Count pagination value"}],"responses":{"200":{"description":"Suggestions found","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SuggestionResponse"}}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/designs/subscriptions":{"post":{"deprecated":true,"summary":"Promote a MASTER design to subscription design","description":"Promote a MASTER design to subscription design","operationId":"createSubscriptionDesign","tags":["design"],"security":[{"bearerToken":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"designId":{"type":"string","format":"UUID"},"subscriptionCode":{"type":"string","enum":["BASIC","PLUS","EDGE"]}}}}}}},"responses":{"207":{"description":"subscriptionDesign created. Note error response corresponds with Validator Error","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"status":{"type":"integer","example":201},"body":{"$ref":"#/components/schemas/SubscriptionDesign"}}}}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/designs/{designId}":{"parameters":[{"in":"path","name":"designId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the design"}],"get":{"summary":"Gets a design","description":"Gets a design","operationId":"getDesign","tags":["design"],"security":[{"bearerToken":[]}],"responses":{"200":{"description":"Design successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Design"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"put":{"summary":"Updates a design","description":"Updates a design","operationId":"updateDesign","tags":["design"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["id","title","subtitle","status","notes","priority"],"properties":{"id":{"type":"string","format":"UUID"},"subtitle":{"type":"string","nullable":true},"status":{"type":"string","example":["MASTER","DRAFT","ARCHIVED"]},"notes":{"type":"string","nullable":true},"priority":{"type":"integer","nullable":true}}}}}},"responses":{"200":{"description":"Design successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Design"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"patch":{"summary":"Partially update the writeable fields for a design","description":"Partially update the writeable fields (title, subtitle, notes & priority) for a design","operationId":"updatePartialDesign","tags":["design"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["title","subtitle","notes","priority"],"properties":{"id":{"type":"string","format":"UUID"},"subtitle":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true},"priority":{"type":"integer","nullable":true}}}}}},"responses":{"200":{"description":"Design successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Design"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v2/designs/{designId}":{"parameters":[{"in":"path","name":"designId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the design"}],"get":{"summary":"Get design with nested categories.","description":"Gets a design with all the categories for the design included as a nested property.","operationId":"getDesignWithCategories","tags":["design"],"security":[{"bearerToken":[]}],"responses":{"200":{"description":"Design with categories successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesignWithCategoriesResponse"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/designs/{designId}/allocation":{"parameters":[{"in":"path","name":"designId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the design"}],"put":{"summary":"Updates allocation of a design","description":"Updates allocation of a design. Allocations can only be granted to direct sub teams of the users currently authenticated team.","operationId":"updateDesignTeamAllocation","tags":["design allocation"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["designId","destinationTeamIds","originTeamId"],"properties":{"teamIds":{"type":"object","properties":{"designId":{"type":"string","format":"UUID"},"destinationTeamIds":{"type":"array","items":{"type":"string","format":"UUID"}},"originTeamId":{"type":"string","format":"UUID"}}}}}}}},"responses":{"200":{"description":"Design successfully updated","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"designId":{"type":"string","format":"uuid"},"teamId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date"},"updatedAt":{"type":"string","format":"date"}}}}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"get":{"summary":"Gets a designs allocation based on the users currently authenticated team","description":"Gets a designs allocation based on the users currently authenticated team. Only direct child teams who have been allocated the design will be returned","operationId":"getDesignAllocation","tags":["design allocation"],"security":[{"bearerToken":[]}],"responses":{"200":{"description":"Design allocation successfully retrieved","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DesignAllocation"}}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/designs/{designId}/allocations/${teamId}":{"parameters":[{"in":"path","name":"designId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the design"},{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"}],"delete":{"summary":"Removes a teams access to the given template","description":"Delete Design Allocation","operationId":"deleteDesignAllocation","tags":["design allocation"],"security":[{"bearerToken":[]}],"responses":{"204":{"description":"Design allocation successfully deleted"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/designs/{designId}/categories":{"parameters":[{"in":"path","name":"designId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the design"}],"get":{"summary":"Gets the categories associated with the design","description":"Gets the categories associated with the design","operationId":"getCategoriesForDesign","tags":["design categories"],"security":[{"bearerToken":[]}],"responses":{"200":{"description":"Design categories successfully retrieved","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Category"}}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"summary":"Creates (links) a category to the design","description":"Creates (links) a category to the design. Creates the category if no matching name is found","operationId":"addCategoryForDesign","tags":["design categories"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["categoryName","designId"],"properties":{"categoryName":{"type":"string"},"designId":{"type":"string","format":"UUID"}}}}}},"responses":{"201":{"description":"Design category successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/designs/{designId}/categories/{categoryId}":{"parameters":[{"in":"path","name":"designId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the design"},{"in":"path","name":"categoryId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the category"}],"delete":{"summary":"Removes (unlinks) the category from the design","description":"Removes (unlinks) the category from the design","operationId":"removeCategoryFromDesign","tags":["design categories"],"security":[{"bearerToken":[]}],"responses":{"204":{"description":"Category successfully removed from the design"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/designs/{designId}/folder":{"parameters":[{"in":"path","name":"designId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the design"}],"get":{"summary":"Gets the folder associated with the design","description":"Gets the folder associated with the design","operationId":"getDesignFolder","tags":["design folder"],"security":[{"bearerToken":[]}],"responses":{"200":{"description":"Design folder successfully retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","example":200},"body":{"$ref":"#/components/schemas/Folder"}}}}}},"204":{"description":"No folder found for the design"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/designs/{designId}/requires-approval":{"parameters":[{"in":"path","name":"designId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team template"}],"put":{"summary":"Flag a team template as requiring approval, or deactivate approvals on a template","description":"This API allows for team templates “requires approval” flag to be switched on/off. The requesting user must be in context of the team and have the Brand Manager role to make this request.","operationId":"updateRequiresApproval","tags":["design"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesignRequiresApproval"}}}},"responses":{"201":{"description":"Design require approval flag has been successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesignRequiresApproval"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/designs/{designId}/size":{"parameters":[{"in":"path","name":"designId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the design"}],"get":{"summary":"Gets DRAFT design size","description":"Currently only used by order-service to retrieve print purchases, which can only be DRAFT (workspace) designs","operationId":"getDesignSize","tags":["design"],"security":[{"bearerToken":[]}],"responses":{"200":{"description":"Design size successfully retrieved","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemplateSize"}}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/designs/{designId}/data/{designDataId}":{"patch":{"summary":"Partially updates a design's data","description":"Partially updates a design's data","operationId":"updatePartialData","tags":["design"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"ordered":{"type":"boolean"}}}}}},"responses":{"201":{"description":"Design data successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesignData"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/designs/{designId}/data":{"parameters":[{"in":"path","name":"designId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the design"}],"get":{"summary":"Gets the latest version of a designs data","description":"Retrieves the latest version of a designs data","operationId":"readData","tags":["design"],"security":[{"bearerToken":[]}],"responses":{"200":{"description":"Design data successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesignData"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"put":{"summary":"Update a design's data","description":"Update a design's data","operationId":"updateData","tags":["design"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesignData"}}}},"responses":{"201":{"description":"Design data successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesignData"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/catalogue":{"get":{"summary":"Gets the designs in a team's catalogue","description":"Retrieves the designs in a team's catalogue","operationId":"getTeamCatalogue","tags":["catalogue"],"security":[{"bearerToken":[]}],"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team whose templates should be returned"},{"in":"query","name":"archived","schema":{"type":"boolean"},"description":"Set to true to return only archived templates"},{"in":"query","name":"folderId","schema":{"type":"string","format":"UUID"},"description":"Provide a folderId to only return templates from within that folder"},{"in":"query","name":"scope","schema":{"type":"string","enum":["all","team","subscription"]},"description":"Quick filter to allow retrieval of only team based or only subscription based templates"},{"in":"query","name":"size","schema":{"type":"string"},"description":"template code to filter the results"},{"in":"query","name":"offset","schema":{"type":"integer"},"description":"Offset pagination value. Default: 0"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Count pagination value. Default: 20. Max: 100"}],"responses":{"200":{"description":"Designs successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryDesignResponse"}}}},"204":{"description":"No designs exist"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/catalogue/sizes":{"get":{"deprecated":true,"summary":"Gets the distinct template sizes for the designs associated with the team catalogue","description":"Gets the distinct template sizes for the designs associated with the team catalogue","operationId":"getTeamCatalogueSizes","tags":["catalogue"],"security":[{"bearerToken":[]}],"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"query","name":"archived","schema":{"type":"boolean"},"description":"Set to true to retrieve sizes for archived designs only "},{"in":"query","name":"offset","schema":{"type":"integer"},"description":"Offset pagination value. Default: 0"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Count pagination value. Default: 20. Max: 100"},{"in":"query","name":"scope","schema":{"type":"string","enum":["all","team","subscription"]},"description":"Quick filter to allow retrieval of only team based or only subscription based templates"}],"responses":{"200":{"description":"Catalogue template sizes retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateSize"}}}},"204":{"description":"No sizes found for catalogue"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/catalogue/categories":{"get":{"deprecated":true,"summary":"Deprecated: Gets the categories for the designs associated with the team catalogue","description":"Deprecated: Gets the categories for the designs associated with the team catalogue","operationId":"getTeamCatalogueCategories","tags":["catalogue"],"security":[{"bearerToken":[]}],"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"query","name":"archived","schema":{"type":"boolean"},"description":"true to retrieve categories for archived designs only "},{"in":"query","name":"size","schema":{"type":"string"},"description":"Filter category by size"}],"responses":{"200":{"description":"Catalogue categories retrieved","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Category"}}}}},"204":{"description":"No categories found for catalogue"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/catalogue/subscription/sizes":{"get":{"summary":"Returns sizes for the easil catalogue.","description":"Returns sizes for the easil catalogue. Can also filter by subscription plan.","operationId":"getEasilCatalogueSizes","tags":["catalogue"],"security":[{"bearerToken":[]}],"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"query","name":"subscriptionCode","schema":{"type":"string","enum":["BASIC","PLUS","EDGE"]},"description":"Provide a subscriptionCode to only return sizes from for that plan."},{"in":"query","name":"offset","schema":{"type":"integer"},"description":"Offset pagination value. Default: 0"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Count pagination value. Default: 20. Max: 100"}],"responses":{"200":{"description":"Easil catalogue successfully retrieved","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemplateSize"}}}}},"204":{"description":"No sizes exist"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/credits/current":{"get":{"summary":"Gets the current credits for a user within a team","description":"Gets the current credits for a user within a team","operationId":"getCurrentCredits","tags":["credits"],"security":[{"bearerToken":[]}],"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"}],"responses":{"200":{"description":"Credits successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credits"}}}},"204":{"description":"No credits exist"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/drafts":{"get":{"summary":"Gets the draft designs for a user within a team","description":"Gets the draft designs for a user within a team","operationId":"getUserDraftDesigns","tags":["workspace"],"security":[{"bearerToken":[]}],"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team the user is in context of"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user to fetch drafts for"},{"in":"query","name":"archived","schema":{"type":"boolean"},"description":"Set to true to retrieve archived drafts only"},{"in":"query","name":"folderId","schema":{"type":"string","format":"UUID"},"description":"UUID of the design folder whose designs to fetch"},{"in":"query","name":"status","schema":{"type":"string","enum":["APPROVED","DECLINED","DRAFT","PENDING_APPROVAL"]},"description":"Design status filter to limit results to a particular draft status"},{"in":"query","name":"size","schema":{"type":"string"},"description":"template code to filter the results"},{"in":"query","name":"offset","schema":{"type":"integer"},"description":"Offset pagination value. Default: 0"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Count pagination value. Default: 20. Max: 100"}],"responses":{"200":{"description":"Designs successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Design"}}}},"204":{"description":"No designs exist"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"put":{"summary":"Update supplied designs","description":"Apply preset updates to supplied designs. Preset updates currenly include: archiving and unarchiving.","operationId":"updateDesigns","tags":["workspace"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Design"}}}}},"responses":{"200":{"description":"Design successfully updated","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Design"}}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/drafts/approved":{"get":{"summary":"Gets the approved designs for a user workspace within a team","description":"Retrieve a users workspace designs that have been approved. Users can only request their own approved designs and must be in the context of the team to make the request.","operationId":"listApprovedDesigns","tags":["approval"],"security":[{"bearerToken":[]}],"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team containing the approved designs"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user whose approved drafts should be returned"},{"in":"query","name":"offset","schema":{"type":"integer"},"description":"Offset pagination value"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Count pagination value"}],"responses":{"200":{"description":"Users approved designs successfully retrieved","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Design"}}}}},"204":{"description":"No approved designs exist"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/drafts/pending-approval":{"get":{"summary":"Gets the pending approval designs for a user workspace within a team","description":"Retrieve a users workspace designs that are pending approval. Will only return designs owned or shared to the user within the team context.","operationId":"listDesignsPendingApproval","tags":["approval"],"security":[{"bearerToken":[]}],"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team containing the pending approval designs"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user whose pending approval designs should be returned"},{"in":"query","name":"offset","schema":{"type":"integer"},"description":"Offset pagination value"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Count pagination value"}],"responses":{"200":{"description":"Designs pending approval successfully retrieved","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Design"}}}}},"204":{"description":"No designs pending approval exist"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/drafts/sizes":{"get":{"summary":"Gets the distinct template sizes for the designs associated with the users workspace","description":"Gets the distinct template sizes for the designs associated with the users workspace","operationId":"getWorkspaceSizes","tags":["workspace"],"security":[{"bearerToken":[]}],"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team the user is in context of"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user whose workspace is being requested"},{"in":"query","name":"archived","schema":{"type":"boolean"},"description":"Set to true to retrieve sizes for archived designs only "},{"in":"query","name":"status","schema":{"type":"string","enum":["APPROVED","DECLINED","DRAFT","PENDING_APPROVAL"]}},{"in":"query","name":"offset","schema":{"type":"integer"},"description":"Offset pagination value. Default: 0"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Count pagination value. Default: 20. Max: 100"}],"responses":{"200":{"description":"Workspace template sizes retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateSize"}}}},"204":{"description":"No sizes found for workspace"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/drafts/categories":{"get":{"deprecated":true,"summary":"Gets the distinct template sizes for the designs associated with the users workspace","description":"Gets the distinct template sizes for the designs associated with the users workspace","operationId":"getWorkspaceCategories","tags":["workspace"],"security":[{"bearerToken":[]}],"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"},{"in":"query","name":"archived","schema":{"type":"boolean"},"description":"true to retrieve categories for archived designs only "},{"in":"query","name":"size","schema":{"type":"string"},"description":"Filter categories by template size"},{"in":"query","name":"offset","schema":{"type":"integer"},"description":"Offset pagination value. Default: 0"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Count pagination value. Default: 20. Max: 100"}],"responses":{"200":{"description":"Workspace categories retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}}},"204":{"description":"No Categories found for users workspace"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/drafts/shared":{"get":{"summary":"Gets the draft designs shared for a user within a team","description":"Gets the draft designs shared for a user within a team","operationId":"listSharedDesigns","tags":["workspace"],"security":[{"bearerToken":[]}],"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"},{"in":"query","name":"status","schema":{"type":"string","enum":["APPROVED","DECLINED","DRAFT","PENDING_APPROVAL"]},"description":"Filter designs by status (defaults to DRAFT)"},{"in":"query","name":"size","schema":{"type":"string"},"description":"Filter designs by template code"},{"in":"query","name":"offset","schema":{"type":"integer"},"description":"Offset pagination value"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Count pagination value"}],"responses":{"200":{"description":"Shared designs successfully retrieved","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Design"}}}}},"204":{"description":"No designs exist"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/drafts/shared/sizes":{"get":{"summary":"Gets the distinct sizes for shared designs","description":"Gets the distinct sizes for shared designs","operationId":"getSharedDesignSizes","tags":["workspace"],"security":[{"bearerToken":[]}],"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"query","name":"offset","schema":{"type":"integer"},"description":"Offset pagination value. Default: 0"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Count pagination value. Default: 20. Max: 100"}],"responses":{"200":{"description":"Shared design sizes retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateSize"}}}},"204":{"description":"No sizes found for shared designs"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/media":{"get":{"summary":"Search media","description":"Searches across user-team, brand kit and subscription based media","operationId":"searchMedia","tags":["media"],"security":[{"bearerToken":[]}],"parameters":[{"in":"query","name":"term","schema":{"type":"string"},"description":"Search term used to match against media name and filename"},{"in":"query","name":"category","schema":{"type":"string"},"description":"Media Category to search within"},{"in":"query","name":"type","schema":{"type":"string","enum":["all","animation","image","vector","video"]},"description":"Media format type"},{"in":"query","name":"folderId","schema":{"type":"string","format":"UUID"},"description":"UUID of the folder"},{"in":"query","name":"context","schema":{"type":"string","enum":["all","brand_animation","brand_image","brand_logo","brand","my_animation","my_image","stock_animation","stock","uploaded"]},"description":"Media context scope"},{"in":"query","name":"offset","schema":{"type":"integer"},"description":"Offset pagination value"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Count pagination value"}],"responses":{"200":{"description":"Media found","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MediaSearchResponse"}}}}},"204":{"description":"No media found matching criteria"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/media/{mediaId}/thumbnail/url":{"parameters":[{"in":"path","name":"mediaId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the media"}],"post":{"summary":"Create URL to override generated media thumbnail","description":"Create URL to directly upload a thumbnail media (image or video) to override the one generated by default","operationId":"createTeamAnimationUrl","tags":["media"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["filename","responseContentType","id"],"properties":{"id":{"type":"string","format":"UUID"},"filename":{"type":"string"},"responseContentType":{"type":"string"}}}}}},"responses":{"201":{"description":"Created URL for uploading media thumbnail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedUrl"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/media/{mediaId}/folder":{"parameters":[{"in":"path","name":"mediaId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the media item"}],"get":{"summary":"Gets the folder associated with the media item","description":"Allows Easil devs to GET the folder that is associated with the given media item. This can be used to check whether a media item is inside of a folder or not","operationId":"getMediaFolder","tags":["media folder"],"security":[{"bearerToken":[]}],"responses":{"200":{"description":"Media folder successfully retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","example":200},"body":{"$ref":"#/components/schemas/Folder"}}}}}},"204":{"description":"No folder found for the media item"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/approval-requests":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"}],"post":{"summary":"Create approval requests for designs that require approval.","description":"Create approval requests by creating new appprovalAction entities and for each design publishing an actionApproval notification and status change to PENDING_APPROVAL.","operationId":"createApprovalRequests","tags":["approvalRequests"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["designId","comment"],"properties":{"designId":{"type":"string","format":"UUID"},"comment":{"type":"string"}}}}}},"responses":{"207":{"description":"Approval requests successfully created","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApprovalAction"}}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/animations/url":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"}],"post":{"summary":"Create URL to upload brandkit animations","description":"Create a URL and mediaId for client to directly upload a brandkit animation to our storage layer","operationId":"createTeamAnimationUrl","tags":["Team Animations"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["filename","responseContentType","teamId"],"properties":{"teamId":{"type":"string","format":"UUID"},"filename":{"type":"string"},"responseContentType":{"type":"string"}}}}}},"responses":{"201":{"description":"Created URL and proposed mediaId for uploading brandkit animations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedUrl"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/folders":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"},{"in":"query","name":"offset","schema":{"type":"integer"},"description":"Offset pagination value"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Count pagination value"}],"post":{"summary":"Creates a folder for a user within a team","description":"Creates a folder for a user within a team","operationId":"createUserTeamFolder","tags":["workspace folder"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["userId","teamId","name","type"],"properties":{"userId":{"type":"string","format":"UUID"},"teamId":{"type":"string","format":"UUID"},"name":{"type":"string"},"type":{"type":"string"}}}}}},"responses":{"201":{"description":"Folder successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Folder"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"get":{"summary":"Retrieves the users workspace folders","description":"Retrieves the users workspace folders.","operationId":"getWorkspaceFolders","tags":["workspace folder"],"security":[{"bearerToken":[]}],"parameters":[{"in":"query","name":"type","schema":{"type":"string","enum":["IMAGE","DESIGN"]},"description":"Filter folder results by folder content type"}],"responses":{"200":{"description":"Workspace Folders successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Folder"}}}},"204":{"description":"No workspace folders found"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/drafts/pending-approval":{"get":{"summary":"Gets the draft designs within a team that have been submitted for approval","description":"Brand Managers can request all drafts within a team that are pending approval","operationId":"getPendingApproval","tags":["approval"],"security":[{"bearerToken":[]}],"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team the user is in context of"},{"in":"query","name":"size","schema":{"type":"string"},"description":"template code to filter the results"},{"in":"query","name":"offset","schema":{"type":"integer"},"description":"Offset pagination value. Default: 0"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Count pagination value. Default: 20. Max: 100"}],"responses":{"200":{"description":"Designs successfully retrieved","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Design"}}}}},"204":{"description":"No designs exist"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/drafts/{designId}/approval-action":{"post":{"summary":"Action a draft design as part of the approval flow","description":"Users can request approval of their drafts once they believe they are ready for review. They also have the ability to cancel their approval request once a design has entered pending approval state.\nBrand managers can action an approval request and either approve or decline a design that is pending approval","operationId":"createApprovalAction","tags":["approval"],"security":[{"bearerToken":[]}],"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team the user is in context of"},{"in":"path","name":"designId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the draft design to perform an approval action on"}],"responses":{"201":{"description":"Approval action successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApprovalAction"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"get":{"summary":"Retrieve list of approval actions for a design","description":"Retrieve list of approval actions for a design","operationId":"getApprovalActions","tags":["approval"],"security":[{"bearerToken":[]}],"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team the user is in context of"},{"in":"path","name":"designId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the draft design to perform an approval action on"},{"in":"query","name":"action","schema":{"type":"string","enum":["APPROVED","CANCELLED","DECLINED","REQUESTED","UNAPPROVED"]},"description":"approval action to filter the results"},{"in":"query","name":"offset","schema":{"type":"integer"},"description":"Offset pagination value. Default: 0"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Count pagination value. Default: 20. Max: 100"}],"responses":{"200":{"description":"Retrieved approval actions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApprovalAction"}}}}},"204":{"description":"No approval actions found for design"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/drafts/approved":{"get":{"summary":"Gets the draft designs approved within a team","description":"Brand Managers can retrieve all designs within a team that have been approved whether the approval has been actioned by the requesting brand manager or another team brand manager","operationId":"getApproved","tags":["approval"],"security":[{"bearerToken":[]}],"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team the user is in context of"},{"in":"query","name":"term","schema":{"type":"string"},"required":true,"description":"Search for a term within design title and subtitle"},{"in":"query","name":"size","schema":{"type":"string"},"description":"template code to filter the results"},{"in":"query","name":"offset","schema":{"type":"integer"},"description":"Offset pagination value. Default: 0"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Count pagination value. Default: 20. Max: 100"}],"responses":{"200":{"description":"Designs successfully retrieved","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Design"}}}}},"204":{"description":"No designs exist"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/drafts/approved/sizes":{"get":{"summary":"Gets the sizes of draft designs approved within a team by a BRAND_MANAGER","description":"Gets the sizes of draft designs approved within a team by a BRAND_MANAGER","operationId":"getApprovedSizes","tags":["workspace"],"security":[{"bearerToken":[]}],"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"query","name":"offset","schema":{"type":"integer"},"description":"Offset pagination value. Default: 0"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Count pagination value. Default: 20. Max: 100"}],"responses":{"200":{"description":"Templates successfully retrieved","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemplateSize"}}}}},"204":{"description":"No template exist"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/folders":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"query","name":"offset","schema":{"type":"integer"},"description":"Offset pagination value"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Count pagination value"}],"post":{"summary":"Creates a folder for a team","description":"Creates a folder for a team. To maintain backwards compatibility, folder type will be set to DESIGN if no 'type' parameter is provided.","operationId":"createTeamFolder","tags":["Team Folder"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["teamId","name"],"properties":{"teamId":{"type":"string","format":"UUID"},"type":{"type":"string","enum":["DESIGN","BRAND_IMAGE","BRAND_LOGO"]},"name":{"type":"string"}}}}}},"responses":{"201":{"description":"Folder successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Folder"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"get":{"summary":"Retrieves the team folders","description":"Retrieves team folders based on the provided folder type. To maintain backwards compatibility, team catalogue folders (type=DESIGN) will be returned if no 'type' query param is provided. If includeNestedFolders=false query param is set, will only return root directory level folders (by default, will include nested folders)","operationId":"gTeamFolders","tags":["Team Folder"],"security":[{"bearerToken":[]}],"parameters":[{"in":"query","name":"type","schema":{"type":"string","enum":["BRAND_ANIMATION","BRAND_IMAGE","BRAND_LOGO","DESIGN (default)"]},"description":"Filter folder results by folder content type"}],"responses":{"200":{"description":"Team Folders successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamFolderResponse"}}}},"204":{"description":"No team folders found"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/folders/{folderId}":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"folderId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the folder"}],"delete":{"summary":"Delete team folder","description":"Delete team folder","operationId":"deleteTeamFolder","tags":["Team Folder"],"security":[{"bearerToken":[]}],"responses":{"204":{"description":"Folder successfully deleted"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"put":{"summary":"Update team folder","description":"Update team folder","operationId":"updateTeamFolder","tags":["Team Folder"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","type"],"properties":{"id":{"type":"string","format":"UUID"},"name":{"type":"string"},"type":{"type":"string","enum":["DESIGN","IMAGE"]},"createdAt":{"type":"string","format":"date"},"updatedAt":{"type":"string","format":"date"}}}}}},"responses":{"200":{"description":"Folder successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Folder"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"get":{"summary":"Retrieve a team folder","description":"Retrieve a team folder for the BRAND_MANAGER within team context","operationId":"getTeamFolder","tags":["Team Folder"],"security":[{"bearerToken":[]}],"responses":{"200":{"description":"Team Folder successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamFolderResponse"}}}},"204":{"description":"No team folders found"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/folders/{folderId}/allocations":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"folderId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the folder"}],"post":{"summary":"Share Team Folder to sub team(s).","description":"Creates the associations neccessary for folders and the designs within the folders to be accessed by the shared teams. If shareToAll is supplied, no need to supply teamIds.","operationId":"shareTeamFolderToSubTeams","tags":["Team Folder"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["folderId"],"properties":{"folderId":{"type":"string","format":"UUID"},"teamIds":{"type":"array","items":{"type":"string","format":"UUID"}},"shareToAll":{"type":"boolean"}}}}}},"responses":{"200":{"description":"Folder successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Folder"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"get":{"summary":"Retrieves the teams a team folder has been shared to","description":"Retrieves the sub-teams (direct children) that the folder has been shared to.","operationId":"teamFolder.getSharedSubTeams","tags":["Team Folder"],"security":[{"bearerToken":[]}],"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"folderId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the folder"},{"in":"query","name":"offset","schema":{"type":"integer"},"description":"Offset pagination value. Default: 0"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Count pagination value. Default: 20. Max: 100"}],"responses":{"200":{"description":"List of direct sub-teams folder has been shared to.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Team"}}}}},"204":{"description":"No teams have been shared this folder"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/folders/{folderId}/allocations/{sharedTeamId}":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"folderId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the folder"},{"in":"path","name":"sharedTeamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team to unshare the folder"}],"delete":{"summary":"Unshare Team Folder to sub team(s)","description":"Unshare Team Folder to supplied sub team. If the sub team has onshared the folder, those teams will also be unshared as a conseuqence.","operationId":"teamFolder.unshareToSubTeams","tags":["Team Catalogue Folder"],"security":[{"bearerToken":[]}],"responses":{"204":{"description":"Folder successfully unshared."},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/folders/{folderId}/designs":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"folderId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the folder"}],"post":{"deprecated":"true","summary":"Add a design to the teams catalogue folder","description":"Add a design to the teams catalogue folder. Any design within the scope of the teams design visibility can be added. This endpoint was replaced by POST teams/{teamId}/folders/{folderId}/content/{contentId}.","operationId":"addTeamFolderDesign","tags":["Team Catalogue Folder"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["teamId","designId","folderId"],"properties":{"teamId":{"type":"string","format":"UUID"},"designId":{"type":"string","format":"UUID"},"folderId":{"type":"string","format":"UUID"}}}}}},"responses":{"201":{"description":"Design successfully added to the teams folder","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderDesign"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/folders/{folderId}/designs/{designId}":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"folderId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the folder"},{"in":"path","name":"designId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the design"}],"delete":{"summary":"Remove a design to the teams catalogue folder","description":"Remove a design to the teams catalogue folder.","operationId":"removeTeamFolderDesign","tags":["Team Catalogue Folder"],"security":[{"bearerToken":[]}],"responses":{"204":{"description":"Design successfully removed from the teams folder"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/folders/{folderId}/sizes":{"get":{"summary":"Gets the distinct template sizes for the designs associated with the teams folder","description":"Gets the distinct template sizes for the designs associated with the teams folder","operationId":"getTeamFolderSizes","tags":["workspace"],"security":[{"bearerToken":[]}],"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"folderId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the folder"},{"in":"query","name":"offset","schema":{"type":"integer"},"description":"Offset pagination value. Default: 0"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Count pagination value. Default: 20. Max: 100"}],"responses":{"200":{"description":"Team folder template sizes retrieved","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemplateSize"}}}}},"204":{"description":"No sizes found for team folder"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/folders/{folderId}/content/{contentId}":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"folderId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the folder"},{"in":"path","name":"contentId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the content"}],"delete":{"summary":"Remove content from team folder.","description":"Remove content (collection or media) from team folder. In the case of removing designs from a design folder, all designs within the collection will be placed in the root of the workspace for the owner of each design.","operationId":"removeTeamFolderContent","tags":["Team Folder"],"security":[{"bearerToken":[]}],"responses":{"204":{"description":"Content successfully removed from team folder"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"summary":"Add content (collection) to team folder.","description":"Add content (collection) to team folder. All designs within the collection will be placed in the supplied team folder. If one or more are in another folder, they will be moved.","operationId":"addTeamFolderContent","tags":["Team Folder"],"security":[{"bearerToken":[]}],"responses":{"201":{"description":"Content successfully added to team folder","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FolderDesign"}}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v2/teams/{teamId}/folders/{folderId}/content":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"folderId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the folder"}],"post":{"summary":"Add content to a team folder.","description":"Add content to a team folder, the content being added can be either a collection or a media, based on the type provided. In case of collection, all designs within the collection will be placed in the supplied team folder. If one or more are in another folder, they will be moved.","operationId":"addTeamFolderContent","tags":["Team Folder"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["teamId","folderId","contentId","type"],"properties":{"teamId":{"type":"string","format":"UUID"},"folderId":{"type":"string","format":"UUID"},"contentId":{"type":"string","format":"UUID"},"type":{"type":"string","enum":["DESIGN","BRAND_IMAGE","BRAND_LOGO","BRAND_ANIMATION"]}}}}}},"responses":{"201":{"description":"Content successfully added to team folder","content":{"application/json":{"schema":{"properties":{"FolderDesign":{"$ref":"#/components/schemas/FolderDesign"},"FolderMedia":{"$ref":"#/components/schemas/FolderMedia"}}}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/colors":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"}],"get":{"summary":"Retrieves the teams defined color groups","description":"Returns the teams color groups for the given teamId. Groups are ordered by name ASC.","operationId":"getTeamColorGroups","tags":["Team Colors"],"security":[{"bearerToken":[]}],"responses":{"200":{"description":"Team Color Groups successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamColorGroup"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"summary":"Creates a color group within the users authenticated team","description":"Creates a color group within the users authenticated team","operationId":"createTeamColorGroups","tags":["Team Colors"],"security":[{"bearerToken":[]}],"responses":{"201":{"description":"Team Color Groups successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderDesign"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/colors/{id}":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"id","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the color group to delete"}],"delete":{"summary":"Deletes a color group that forms part of the teams Brand Kit","description":"Deletes a color group that forms part of the teams Brand Kit","operationId":"deleteTeamColorGroup","tags":["Team Colors"],"security":[{"bearerToken":[]}],"responses":{"204":{"description":"Team Color Group successfully deleted"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"put":{"summary":"Updates a color group that forms part of the teams Brand Kit","description":"Updates a color group that forms part of the teams Brand Kit","operationId":"updateTeamGroup","tags":["Team Colors"],"security":[{"bearerToken":[]}],"responses":{"200":{"description":"Team Color Group successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamColorGroup"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/logos/{mediaId}":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"mediaId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the logo media item"}],"delete":{"summary":"Deletes a logo that forms part of the teams Brand Kit","description":"Deletes a logo that forms part of the teams Brand Kit","operationId":"deleteTeamLogo","tags":["Team Logos"],"security":[{"bearerToken":[]}],"responses":{"204":{"description":"Team Logo successfully deleted"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"put":{"summary":"Updates a logo that forms part of the teams Brand Kit","description":"Updates a logo that forms part of the teams Brand Kit","operationId":"updateTeamLogo","tags":["Team Logos"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamLogo"}}}},"responses":{"200":{"description":"Team Logo successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamLogo"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"get":{"summary":"Retrieve a team logo","description":"Retrieve a team logo for the BRAND_MANAGER within team context","operationId":"getTeamLogo","tags":["Team Logos"],"security":[{"bearerToken":[]}],"responses":{"200":{"description":"Team Logo successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamLogo"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/logos":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"}],"get":{"summary":"Retrieves the teams logos","description":"Returns the list of team specific logos. Logos are ordered by updatedAt ASC. Providing folderId filter results within the given folder, otherwise all logos that are not in a folder are returned.","operationId":"getTeamLogos","tags":["Team Logos"],"security":[{"bearerToken":[]}],"parameters":[{"in":"query","name":"folderId","schema":{"type":"string","format":"UUID"},"required":false,"description":"Used to filter logos within a given folder"}],"responses":{"200":{"description":"Team Logos successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamLogo"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"summary":"Creates a logo within the users authenticated team","description":"Creates a logo within the users authenticated team","operationId":"createTeamLogo","tags":["Team Logos"],"security":[{"bearerToken":[]}],"responses":{"201":{"description":"Team Logo successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamLogo"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/logos/url":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"}],"post":{"summary":"Creates a presignedurl and id (proposed mediaId) for client to directly upload logo to s3","description":"Creates a presignedurl and (proposed mediaId) for client to directly upload logo to s3","operationId":"createTeamLogoUploadUrl","tags":["Team Logos"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["filename","responseContentType","teamId"],"properties":{"teamId":{"type":"string","format":"UUID"},"filename":{"type":"string"},"responseContentType":{"type":"string"}}}}}},"responses":{"201":{"description":"presignedurl and proposed mediaId created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedUrl"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/images/{mediaId}":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"mediaId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the image media item"}],"delete":{"summary":"Deletes an image that forms part of the teams Brand Kit","description":"Deletes an image that forms part of the teams Brand Kit","operationId":"deleteTeamImage","tags":["Team Images"],"security":[{"bearerToken":[]}],"responses":{"204":{"description":"Team Image successfully deleted"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"put":{"summary":"Updates an image that forms part of the teams Brand Kit","description":"Updates an image that forms part of the teams Brand Kit","operationId":"updateTeamImage","tags":["Team Images"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamImage"}}}},"responses":{"200":{"description":"Team Image successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamImage"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"get":{"summary":"Retrieve a team image","description":"Retrieve a team image for the BRAND_MANAGER within team context","operationId":"getTeamImage","tags":["Team Images"],"security":[{"bearerToken":[]}],"responses":{"200":{"description":"Team Image successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamImage"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/images":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"}],"get":{"summary":"Retrieves the teams images","description":"Returns the list of team specific images. Images are ordered by updatedAt DESC","operationId":"getTeamImages","tags":["Team Images"],"security":[{"bearerToken":[]}],"parameters":[{"in":"query","name":"folderId","schema":{"type":"string","format":"UUID"},"required":false,"description":"Specific the folder to scope the request to"}],"responses":{"200":{"description":"Team Images successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamImage"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"summary":"Creates a brand kit image within the users authenticated team","description":"Creates a brand kit image within the users authenticated team","operationId":"createTeamImage","tags":["Team Images"],"parameters":[{"in":"query","name":"sortBy","schema":{"type":"string","enum":["name","updatedAt"]},"description":"Can be supplied many times (i.e. sortBy=name&sortOrder=asc&sortBy=updatedAt&sortOrder=desc) and to be used in conjuction with sortOrder"},{"in":"query","name":"sortOrder","schema":{"type":"string","enum":["asc","desc"]},"description":"Can be supplied many times, and to be used in conjuction with sortBy"},{"in":"query","name":"offset","schema":{"type":"integer"},"description":"Offset pagination value. Default: 0"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Count pagination value. Default: 20. Max: 100"}],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"teamId":{"type":"string","format":"UUID"},"mediaId":{"type":"string","format":"UUID"},"imageFile":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"Team Image successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamImage"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/images/url":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"}],"post":{"summary":"Creates a presignedurl and id (proposed mediaId) for client to directly upload team image to s3","description":"Creates a presignedurl and (proposed mediaId) for client to directly upload team image to s3","operationId":"createTeamImageUploadUrl","tags":["Team Images"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["filename","responseContentType","teamId"],"properties":{"teamId":{"type":"string","format":"UUID"},"filename":{"type":"string"},"responseContentType":{"type":"string"}}}}}},"responses":{"201":{"description":"presignedurl and proposed mediaId created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedUrl"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/animations":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"}],"get":{"summary":"Retrieves the teams animations","description":"Returns the list of team specific animation. Animations are ordered by updatedAt DESC","operationId":"getTeamAnimations","tags":["Team Animations"],"security":[{"bearerToken":[]}],"parameters":[{"in":"query","name":"folderId","schema":{"type":"string","format":"UUID"},"required":false,"description":"Specific the folder to scope the request to"}],"responses":{"200":{"description":"Team Animations successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamImage"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"summary":"Creates a brand kit animation within the users authenticated team","description":"Creates a brand kit animation within the users authenticated team","operationId":"createTeamAnimation","tags":["Team Animations"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"teamId":{"type":"string","format":"UUID"},"mediaId":{"type":"string","format":"UUID"},"animationFile":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"Team Animation successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamImage"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/animations/{mediaId}":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"mediaId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the animation media item"}],"delete":{"summary":"Deletes an animation from the teams Brand Kit","description":"Deletes an animation that forms part of the teams Brand Kit that is removed from our storage layer","operationId":"deleteTeamAnimation","tags":["Team Animations"],"security":[{"bearerToken":[]}],"responses":{"204":{"description":"Team Animation successfully deleted"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"put":{"summary":"Updates an animations from the teams Brand Kit","description":"This endpoint allows animations within a teams Brand Kit to be updated. The requesting user must be in context of the team and have the Brand Manager role to make this request.","operationId":"updateTeamAnimation","tags":["Team Animations"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamImage"}}}},"responses":{"200":{"description":"Team Animation successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamImage"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"get":{"summary":"Retrieve a team animation","description":"Retrieve a team animation for the BRAND_MANAGER within team context","operationId":"getTeamAnimation","tags":["Team Animations"],"security":[{"bearerToken":[]}],"responses":{"200":{"description":"Team Animation successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamImage"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/fonts":{"get":{"summary":"Retrieves the publicly available fonts","description":"Returns the list of publicly available fonts. Fonts are ordered by name ASC","operationId":"getPublicFonts","tags":["Public Fonts"],"security":[{"bearerToken":[]}],"responses":{"200":{"description":"Fonts successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FontFamily"}}}},"204":{"description":"No public fonts available"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/fonts":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"}],"get":{"summary":"Retrieves the teams fonts","description":"Returns the list of team specific fonts. Fonts are ordered by name ASC.","operationId":"getTeamFonts","tags":["Team Fonts"],"security":[{"bearerToken":[]}],"responses":{"200":{"description":"Team Fonts successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamFontResponse"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"summary":"Creates a new team font definition for the given team","description":"Creates a new team font definition for the given team.","operationId":"createTeamFont","tags":["Team Fonts"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["teamId","fontId","teamFontName","bold","italic"],"properties":{"teamId":{"type":"string","format":"UUID"},"fontId":{"type":"string","format":"UUID"},"teamFontName":{"type":"string"},"bold":{"type":"boolean"},"italic":{"type":"boolean"}}}}}},"responses":{"201":{"description":"Team Fonts successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamFontResponse"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/fonts/{teamFontId}":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"teamFontId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the teamFont association"}],"delete":{"summary":"Deletes an font that forms part of the teams Brand Kit","description":"Deletes an font that forms part of the teams Brand Kit","operationId":"deleteTeamFont","tags":["Team Fonts"],"security":[{"bearerToken":[]}],"responses":{"204":{"description":"Team Font successfully deleted"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"put":{"summary":"Updates a font that forms part of the teams Brand Kit","description":"Updates a font that forms part of the teams Brand Kit","operationId":"updateTeamFont","tags":["Team Fonts"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["id","teamId","fontId","teamFontName","bold","italic"],"properties":{"id":{"type":"string","format":"UUID"},"teamId":{"type":"string","format":"UUID"},"fontId":{"type":"string","format":"UUID"},"teamFontName":{"type":"string"},"bold":{"type":"boolean"},"italic":{"type":"boolean"}}}}}},"responses":{"200":{"description":"Team font successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamFontResponse"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"patch":{"summary":"Partially update a team font","description":"Partially update a font that forms part of the teams Brand Kit, with the option to also update the font file","operationId":"partialUpdateTeamFont","tags":["Team Fonts"],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["fontFamilyName","fontId","fontName","id","teamFontName","teamId"],"properties":{"fontFamilyName":{"type":"string"},"fontId":{"type":"string","format":"UUID"},"fontName":{"type":"string"},"id":{"type":"string","format":"UUID"},"teamFontName":{"type":"string"},"teamId":{"type":"string","format":"UUID"},"fontFile":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"Team font successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamFontResponse"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/folders/{folderId}":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"},{"in":"path","name":"folderId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the folder"}],"delete":{"summary":"Delete workspace folder","description":"Delete workspace folder","operationId":"deleteUserTeamFolder","tags":["workspace folder"],"security":[{"bearerToken":[]}],"responses":{"204":{"description":"Folder successfully deleted"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"get":{"summary":"Retrieve a specific workspace folder","description":"Retrieve a workspace folder owned by a specified user within a specified team.","operationId":"getUserTeamFolder","tags":["workspace folder"],"security":[{"bearerToken":[]}],"responses":{"200":{"description":"Folder has been retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Folder"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"put":{"summary":"Update workspace folder","description":"Update workspace folder","operationId":"updateUserTeamFolder","tags":["workspace folder"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","type"],"properties":{"id":{"type":"string","format":"UUID"},"name":{"type":"string"},"type":{"type":"string","enum":["DESIGN","IMAGE"]},"createdAt":{"type":"string","format":"date"},"updatedAt":{"type":"string","format":"date"}}}}}},"responses":{"200":{"description":"Folder successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Folder"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/folders/{folderId}/videos":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"},{"in":"path","name":"folderId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the folder (or 'root')"}],"post":{"summary":"Move video from one workspace folder to another.","description":"Move video from one workspace folder to another. FolderId can be root if moving videos out of a folder.","operationId":"moveVideosToWorkspaceFolder","tags":["Video"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"schema":{"required":["userId","teamId","folderId","mediaIds"],"properties":{"userId":{"type":"string","format":"UUID"},"teamId":{"type":"string","format":"UUID"},"folderId":{"type":"string","format":"UUID"},"mediaIds":{"type":"array","items":{"type":"string","format":"UUID"}}}}}},"responses":{"201":{"description":"Videos successfully moved to workspace folder.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderMedia"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/folders/{folderId}/images":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"},{"in":"path","name":"folderId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the folder (or 'root')"}],"post":{"summary":"Move images from one workspace folder to another.","description":"Move images from one workspace folder to another. FolderId can be root if moving images out of a folder.","operationId":"addUserTeamFolderContent","tags":["workspace folder"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"schema":{"required":["userId","teamId","folderId","mediaIds"],"properties":{"userId":{"type":"string","format":"UUID"},"teamId":{"type":"string","format":"UUID"},"folderId":{"type":"string","format":"UUID"},"mediaId":{"type":"array","items":{"type":"string","format":"UUID"}}}}}},"responses":{"201":{"description":"Images successfully moved to workspace folder.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderMedia"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/folders/{folderId}/content":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"},{"in":"path","name":"folderId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the folder"}],"post":{"summary":"Add content to the users team workspace folder","description":"Add content to the users team workspace folder. Supplying a contentId will either add an existing collection or media to a folder. Supplying an imageFile will upload and add image to folder.","operationId":"addUserTeamFolderContent","tags":["workspace folder"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["userId","teamId","folderId","type"],"properties":{"userId":{"type":"string","format":"UUID"},"teamId":{"type":"string","format":"UUID"},"folderId":{"type":"string","format":"UUID"},"imageFile":{"description":"Omit if including a contentId","type":"string","format":"binary"},"contentId":{"description":"Omit if including an imageFile","type":"string","format":"UUID","example":"collectionId|mediaId"},"type":{"type":"string","enum":["IMAGE","COLLECTION"]}}}}}},"responses":{"201":{"description":"Content successfully added to the users team workspace folder","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/FolderMedia"},{"$ref":"#/components/schemas/FolderDesign"}]}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v2/teams/{teamId}/users/{userId}/folders/{folderId}/content":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"},{"in":"path","name":"folderId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the folder"}],"post":{"summary":"Add content to the users team workspace folder.","description":"Add content to the users team workspace folder. Can either be a direct upload to s3, moving existiing media to a folder or removing the background of an exisiting image within a folder","operationId":"addUserTeamFolderContent","tags":["workspace folder"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["userId","teamId","folderId"],"properties":{"userId":{"type":"string","format":"UUID"},"teamId":{"type":"string","format":"UUID"},"folderId":{"type":"string","format":"UUID"},"id":{"description":"Required for direct upload to s3","type":"string","format":"UUID"},"filename":{"description":"Required for direct upload to s3","type":"string"},"mediaId":{"description":"Required for remove background of an existing image","type":"string","format":"UUID"},"contentId":{"description":"Required for moving existing image to folder","type":"string","format":"UUID"},"type":{"description":"Required for moving existing image to folder","type":"string","enum":["IMAGE"]}}}}}},"responses":{"201":{"description":"Content successfully added to the users team workspace folder","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/FolderMedia"},{"$ref":"#/components/schemas/FolderDesign"}]}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/folders/{folderId}/content/{contentId}":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"},{"in":"path","name":"folderId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the folder"},{"in":"path","name":"contentId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the content"}],"delete":{"summary":"Remove content from users team workspace folder.","description":"Remove content from users team workspace folder.","operationId":"removeUserTeamFolderContent","tags":["workspace folder"],"security":[{"bearerToken":[]}],"responses":{"204":{"description":"Content successfully removed from users team workspace folder"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/folders/{folderId}/content/url":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"},{"in":"path","name":"folderId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the folder"}],"post":{"summary":"Creates a presignedurl and id (proposed mediaId) for client to directly upload user team folder image to s3","description":"Creates a presignedurl and (proposed mediaId) for client to directly upload user team folder image to s3","operationId":"createUserTeamFolderImageUploadUrl","tags":["workspace folder"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["filename","responseContentType","teamId","userId","folderId"],"properties":{"teamId":{"type":"string","format":"UUID"},"userId":{"type":"string","format":"UUID"},"folderId":{"type":"string","format":"UUID"},"filename":{"type":"string"},"responseContentType":{"type":"string"}}}}}},"responses":{"201":{"description":"presignedurl and proposed mediaId created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedUrl"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/folders/{folderId}/designs":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"},{"in":"path","name":"folderId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the folder"}],"post":{"summary":"Add a design to the users team workspace folder","description":"Add a design to the users team workspace folder. Only draft designs in the users workspace can be added","operationId":"addUserTeamFolderDesign","tags":["workspace folder"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["userId","teamId","designId","folderId"],"properties":{"userId":{"type":"string","format":"UUID"},"teamId":{"type":"string","format":"UUID"},"designId":{"type":"string","format":"UUID"},"folderId":{"type":"string","format":"UUID"}}}}}},"responses":{"201":{"description":"Design successfully added to the users team workspace folder","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderDesign"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/folders/{folderId}/designs/{designId}":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"},{"in":"path","name":"folderId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the folder"},{"in":"path","name":"designId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the design"}],"delete":{"summary":"Remove a design to the users workspace folder","description":"Remove a design to the users workspace folder.","operationId":"removeWorkspaceFolderDesign","tags":["workspace folder"],"security":[{"bearerToken":[]}],"responses":{"204":{"description":"Design successfully removed from the users workspace folder"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/folders/{folderId}/collections":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"},{"in":"path","name":"folderId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the folder"}],"post":{"summary":"Move collections to the given workspace folder","description":"Allows a user to move multiple collections at once to and from a given workspace folder. The folderId param can also take 'root'. This will allow the endpoint to then remove the collections from the folder","operationId":"moveCollectionsToWorkspaceFolder","tags":["workspace folder"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["userId","teamId","folderId","collectionIds"],"properties":{"userId":{"type":"string","format":"UUID"},"teamId":{"type":"string","format":"UUID"},"folderId":{"type":"string","format":"UUID"},"collectionIds":{"type":"array","items":{"type":"string","format":"UUID"}}}}}}},"responses":{"207":{"description":"Collections successfully added to the users team workspace folder","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkFolderDesign"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/folders/{folderId}/sizes":{"get":{"summary":"Gets the distinct template sizes for the designs associated with the users folder","description":"Gets the distinct template sizes for the designs associated with the users folder","operationId":"getUserTeamFolderSizes","tags":["workspace"],"security":[{"bearerToken":[]}],"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team the user is in context of"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user whose workspace is being requested"},{"in":"path","name":"folderId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the folder"},{"in":"query","name":"offset","schema":{"type":"integer"},"description":"Offset pagination value. Default: 0"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Count pagination value. Default: 20. Max: 100"}],"responses":{"200":{"description":"User team folder template sizes retrieved","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemplateSize"}}}}},"204":{"description":"No sizes found for user team folder"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/fonts":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"}],"get":{"summary":"Retrieves the users fonts for the requested team","description":"Returns the users fonts for a particular team. Fonts are ordered by fontName ASC.","operationId":"getUserTeamFonts","tags":["User Team Fonts"],"security":[{"bearerToken":[]}],"responses":{"200":{"description":"Users team fonts successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTeamFontResponse"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"summary":"Creates a font for a user within a team","description":"Creates a font for a user within a team","operationId":"createUserTeamFolder","tags":["User Team Fonts"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["userId","teamId","fontFile"],"properties":{"userId":{"type":"string","format":"UUID"},"teamId":{"type":"string","format":"UUID"},"fontFile":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"Font successfully created for user within team","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTeamFontResponse"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/fonts/deletions":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"}],"post":{"summary":"Create workspace font deletion request.","description":"Create workspace font deletion request. To be complete the deletion, a follow up request must be sent to the url specified in the location header.","operationId":"createFontDeletionRequest","tags":["User Team Fonts"],"security":[{"bearerToken":[]}],"requestBody":{"required":["userId","teamId","fontIds"],"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","format":"UUID"},"teamId":{"type":"string","format":"UUID"},"fontIds":{"type":"array","items":{"type":"string","format":"UUID"}}}}}}},"responses":{"201":{"description":"Video deletion request successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FontDeletionRequest"}}},"headers":{"location":{"type":"string","description":"To complete the deletion request, make a POST request to this url."}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/fonts/deletions/{deletionId}":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"},{"in":"path","name":"deletionId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the deletion request"}],"delete":{"summary":"Action workspace font deletion request.","description":"Action workspace font deletion request. Will delete associations that map the font to the user in team context.","operationId":"actionFontDeletionRequest","tags":["User Team Fonts"],"security":[{"bearerToken":[]}],"responses":{"204":{"description":"Font deletion request successfully actioned"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/fonts/{fontId}":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"},{"in":"path","name":"fontId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the font"}],"delete":{"summary":"Deletes a users team font","description":"Deletes an image from the users team font repository","operationId":"deleteUserTeamFont","tags":["User Team Fonts"],"security":[{"bearerToken":[]}],"responses":{"204":{"description":"User team font successfully deleted"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/images":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"}],"get":{"summary":"Retrieves the users images for the requested team","description":"Returns the users images for a particular team. Images are ordered by createdAt ASC.","operationId":"getUserTeamImages","tags":["User Team Images"],"parameters":[{"in":"query","name":"folderId","schema":{"type":"string"},"description":"Get user team images within folder"}],"security":[{"bearerToken":[]}],"responses":{"200":{"description":"Users team images successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTeamImage"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"summary":"Creates an image within the users root image 'directory' of team","description":"Allows users to upload new images, or remove the backgrounds of existing images. Only one of mediaId or imageFile can be provided","operationId":"createUserTeamImageDeprecated","deprecated":true,"tags":["User Team Images"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"userId":{"type":"string","format":"UUID"},"teamId":{"type":"string","format":"UUID"},"mediaId":{"type":"string","format":"UUID"},"imageFile":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"User team image successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTeamImage"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v2/teams/{teamId}/users/{userId}/images":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"}],"post":{"summary":"Create or remove background of an image.","description":"Persist an image that has been directly uploaded to s3 within the user's workspace or remove the background from an existing image.","operationId":"createUserTeamImage","tags":["User Team Images"],"security":[{"bearerToken":[]}],"requestBody":{"required":["userId","teamId","id","filename"],"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","format":"UUID"},"teamId":{"type":"string","format":"UUID"},"id":{"type":"string","format":"UUID"},"filename":{"type":"string"},"duration":{"type":"number"}}}}}},"responses":{"201":{"description":"User team image successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTeamImage"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/smart-images":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"}],"get":{"summary":"Retrieves the users smart images for the requested team","description":"Returns the users smart images for a particular team. Images are ordered by updatedAt DESC.","operationId":"getUserTeamSmartImages","tags":["User Team Smart Images"],"parameters":[{"in":"query","name":"offset","schema":{"type":"integer"},"description":"Offset pagination value. Default: 0"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Count pagination value. Default: 20. Max: 100"}],"security":[{"bearerToken":[]}],"responses":{"200":{"description":"Users team smart images successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTeamSmartImage"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"summary":"Create smart image for the requested team","description":"Persist a users smart images for a particular team.","operationId":"createUserTeamSmartImage","tags":["User Team Smart Images"],"security":[{"bearerToken":[]}],"requestBody":{"required":["userId","teamId","label","mediaId"],"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","format":"UUID"},"teamId":{"type":"string","format":"UUID"},"mediaId":{"type":"string","format":"UUID"},"label":{"type":"string"}}}}}},"responses":{"201":{"description":"User team smart image successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTeamSmartImage"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/smart-images/{smartImageId}":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"},{"in":"path","name":"smartImageId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the smart image entity"}],"delete":{"summary":"Deletes a users team smart image","description":"Deletes an smart image from the users team image repository","operationId":"deleteUserTeamSmartImage","tags":["User Team Smart Images"],"security":[{"bearerToken":[]}],"responses":{"204":{"description":"User team smart image successfully deleted"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"put":{"summary":"Updates smart image for the requested team","description":"updates a users smart image for a particular smart image based off the provided id.","operationId":"updateUserTeamSmartImage","tags":["User Team Smart Images"],"security":[{"bearerToken":[]}],"requestBody":{"required":["id","userId","teamId","label","mediaId","createdAt","updatedAt"],"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"UUID"},"userId":{"type":"string","format":"UUID"},"teamId":{"type":"string","format":"UUID"},"mediaId":{"type":"string","format":"UUID"},"label":{"type":"string"},"createdAt":{"type":"date"},"updatedAt":{"type":"date"}}}}}},"responses":{"201":{"description":"User team smart image successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTeamSmartImage"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v2/teams/{teamId}/images":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"}],"post":{"summary":"Create brand kit image.","description":"Persist an image that has been directly uploaded to s3 within the team's brand kit.","operationId":"v2CreateTeamImage","tags":["Team Images"],"security":[{"bearerToken":[]}],"requestBody":{"required":["teamId","id","filename"],"content":{"application/json":{"schema":{"type":"object","properties":{"teamId":{"type":"string","format":"UUID"},"id":{"type":"string","format":"UUID"},"filename":{"type":"string"},"duration":{"type":"number"}}}}}},"responses":{"201":{"description":"Team image successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamImage"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/images/url":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"}],"post":{"summary":"Creates a presignedurl and id (proposed mediaId) for client to directly upload user team image to s3","description":"Creates a presignedurl and (proposed mediaId) for client to directly upload user team image to s3","operationId":"createUserTeamImageUploadUrl","tags":["User Team Images"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["filename","responseContentType","teamId"],"properties":{"teamId":{"type":"string","format":"UUID"},"filename":{"type":"string"},"responseContentType":{"type":"string"}}}}}},"responses":{"201":{"description":"presignedurl and proposed mediaId created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedUrl"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/images/deletions":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"}],"post":{"summary":"Create workspace image deletion request.","description":"Create workspace image deletion request. To be complete the deletion, a follow up request must be sent to the url specified in the location header.","operationId":"createImageDeletionRequest","tags":["Image"],"security":[{"bearerToken":[]}],"requestBody":{"required":["userId","teamId","mediaIds"],"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","format":"UUID"},"teamId":{"type":"string","format":"UUID"},"mediaIds":{"type":"array","items":{"type":"string","format":"UUID"}}}}}}},"responses":{"201":{"description":"Creates deletion request to be actioned before it expires","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaDeletionRequest"}}},"headers":{"location":{"type":"string","description":"To complete the deletion request, make a POST request to this url."}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/images/deletions/{deletionId}":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"},{"in":"path","name":"deletionId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the deletion request"}],"delete":{"summary":"Action workspace image deletion request.","description":"Action workspace image deletion request. Will delete associations that map the media to the user in team context.","operationId":"actionImageDeletionRequest","tags":["Image"],"security":[{"bearerToken":[]}],"responses":{"204":{"description":"Image deletion request successfully actioned"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/images/{mediaId}":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"},{"in":"path","name":"mediaId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the image"}],"delete":{"summary":"Deletes a users team image","description":"Deletes an image from the users team image repository","operationId":"deleteUserTeamImage","tags":["User Team Images"],"security":[{"bearerToken":[]}],"responses":{"204":{"description":"User team image successfully deleted"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"put":{"summary":"Updates an image within the users authenticated team","description":"Updates an image within the users authenticated team","operationId":"updateUserTeamImage","tags":["User Team Images"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTeamImage"}}}},"responses":{"200":{"description":"User team image successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTeamImage"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"get":{"summary":"Get a workspace image","description":"Get a workspace image for the user in team context.","operationId":"getUserTeamImage","tags":["User Team Images"],"security":[{"bearerToken":[]}],"responses":{"200":{"description":"Users team image successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTeamImage"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/smart-images":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"}],"get":{"summary":"Retrieves smart images for the requested team","description":"Returns smart images for a particular team. Images are ordered by updatedAt DESC.","operationId":"getTeamSmartImages","tags":["Team Smart Images"],"parameters":[{"in":"query","name":"offset","schema":{"type":"integer"},"description":"Offset pagination value. Default: 0"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Count pagination value. Default: 20. Max: 100"}],"security":[{"bearerToken":[]}],"responses":{"200":{"description":"Teams smart images successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamSmartImage"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"summary":"Create smart image for the requested team","description":"Persist a smart images for a particular team.","operationId":"createTeamSmartImage","tags":["Team Smart Images"],"security":[{"bearerToken":[]}],"requestBody":{"required":["teamId","label","mediaId"],"content":{"application/json":{"schema":{"type":"object","properties":{"teamId":{"type":"string","format":"UUID"},"mediaId":{"type":"string","format":"UUID"},"label":{"type":"string"},"duration":{"type":"number"}}}}}},"responses":{"201":{"description":"User team smart image successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTeamSmartImage"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/smart-images/{smartImageId}":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"smartImageId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the smart image entity"}],"delete":{"summary":"Deletes a team smart image","description":"Deletes an smart image from the team image repository","operationId":"deleteTeamSmartImage","tags":["Team Smart Images"],"security":[{"bearerToken":[]}],"responses":{"204":{"description":"team smart image successfully deleted"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"put":{"summary":"Updates smart image for the requested team","description":"updates a teams smart image based off the provided id.","operationId":"updateTeamSmartImage","tags":["Team Smart Images"],"security":[{"bearerToken":[]}],"requestBody":{"required":["id","teamId","label","mediaId","createdAt","updatedAt"],"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"UUID"},"teamId":{"type":"string","format":"UUID"},"mediaId":{"type":"string","format":"UUID"},"label":{"type":"string"},"createdAt":{"type":"date"},"updatedAt":{"type":"date"}}}}}},"responses":{"201":{"description":"team smart image successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamSmartImage"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/videos/deletions":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"}],"post":{"summary":"Create workspace video deletion request.","description":"Create workspace video deletion request. To be complete the deletion, a follow up request must be sent to the url specified in the location header.","operationId":"createVideoDeletionRequest","tags":["Video"],"security":[{"bearerToken":[]}],"requestBody":{"required":["userId","teamId","mediaIds"],"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","format":"UUID"},"teamId":{"type":"string","format":"UUID"},"mediaIds":{"type":"array","items":{"type":"string","format":"UUID"}}}}}}},"responses":{"201":{"description":"Video deletion request successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaDeletionRequest"}}},"headers":{"location":{"type":"string","description":"To complete the deletion request, make a POST request to this url."}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/videos/deletions/{deletionId}":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"},{"in":"path","name":"deletionId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the deletion request"}],"delete":{"summary":"Action workspace video deletion request.","description":"Action workspace video deletion request. Will delete associations that map the media to the user in team context.","operationId":"actionVideoDeletionRequest","tags":["Video"],"security":[{"bearerToken":[]}],"responses":{"204":{"description":"Video deletion request successfully actioned"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/animations":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"}],"post":{"summary":"Create animation.","description":"Persist an animation that has been directly uploaded within the user's workspace.","operationId":"createUserTeamAnimation","tags":["User Team Animations"],"security":[{"bearerToken":[]}],"requestBody":{"required":["userId","teamId","id","filename","duration"],"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","format":"UUID"},"teamId":{"type":"string","format":"UUID"},"id":{"type":"string","format":"UUID"},"filename":{"type":"string"},"duration":{"type":"number"}}}}}},"responses":{"201":{"description":"User team animation successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTeamImage"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"get":{"summary":"Retrieves the users animations for the requested team","description":"Returns the users animations for a particular team. Animations are ordered by updatedAt DESC.","operationId":"getUserTeamAnimations","tags":["User Team Animations"],"parameters":[{"in":"query","name":"folderId","schema":{"type":"string"},"description":"Get user team animations within folder"}],"security":[{"bearerToken":[]}],"responses":{"200":{"description":"Users team animations successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTeamImage"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/animations/url":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"}],"post":{"summary":"Create URL to upload workspace animations","description":"Create a URL and mediaId for client to directly upload a workspace animation to our storage layer","operationId":"createUserTeamUploadUrl","tags":["User Team Animations"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["filename","responseContentType","teamId"],"properties":{"teamId":{"type":"string","format":"UUID"},"userId":{"type":"string","format":"UUID"},"filename":{"type":"string"},"responseContentType":{"type":"string"}}}}}},"responses":{"201":{"description":"Created URL and proposed mediaId for uploading workspace animations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedUrl"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/animations/{mediaId}":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"},{"in":"path","name":"mediaId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the animation"}],"put":{"summary":"Updates an animation within the users authenticated team","description":"Updates an animation within the users authenticated team","operationId":"updateUserTeamAnimation","tags":["User Team Animations"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTeamImage"}}}},"responses":{"200":{"description":"User team Animation successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTeamImage"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"delete":{"summary":"Deletes a users team animation","description":"Deletes an animation from the users team animation repository","operationId":"deleteUserTeamAnimation","tags":["User Team Animations"],"security":[{"bearerToken":[]}],"responses":{"204":{"description":"User team animations successfully deleted"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"get":{"summary":"Get a workspace animation","description":"Get a workspace animation for the user in team context.","operationId":"getUserTeamAnimation","tags":["User Team Animations"],"security":[{"bearerToken":[]}],"responses":{"200":{"description":"Users team animation successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTeamImage"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/favorites":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"},{"in":"query","name":"type","schema":{"type":"string","enum":["image","vector","all"]},"description":"Optional filter by media type"}],"get":{"summary":"Retrieves the users favorited items for the team in context","description":"Retrieves the users favorited items for the team in context. Favorites are ordered by createdAt ASC.","operationId":"getUserTeamFavorites","tags":["User Team Favorites"],"security":[{"bearerToken":[]}],"responses":{"200":{"description":"Users team favorites successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTeamFavorite"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"summary":"Adds a media item to the users team favorites","description":"Adds a media item to the users team favorites","operationId":"createUserTeamFavorite","tags":["User Team Favorites"],"security":[{"bearerToken":[]}],"responses":{"201":{"description":"Media item successfully favorited","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTeamFavorite"}}}},"204":{"description":"Not user team favourites found"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/favorites/{mediaId}":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"},{"in":"path","name":"mediaId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the media iteam"}],"delete":{"summary":"Deletes a media item from the users team favorites","description":"Deletes a media item from the users team favorites","operationId":"deleteUserTeamFavorite","tags":["User Team Favorites"],"security":[{"bearerToken":[]}],"responses":{"204":{"description":"User team favorite successfully deleted"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/collections":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"}],"post":{"summary":"Copies a collection of designs into a user workspace","description":"Copies a collection of designs into a user workspace. Either one of the parentId or remixToken values must be provided. Provide the parentId to create a collection from an Easil Catalogue collection, Team Template collection or Purchased Template collection. RemixTokens can only be obtained by Easil admins to provide an authorised method to copy ANY collection within Easil into the users workspace.","operationId":"createCollection","tags":["collection"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["teamId","userId"],"properties":{"teamId":{"type":"string","format":"uuid"},"userId":{"type":"string","format":"uuid"},"parentId":{"type":"string","format":"uuid"},"remixToken":{"type":"string"}}}}}},"responses":{"201":{"description":"Collection successfully created","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/CollectionDesigns"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"get":{"summary":"Retrieves a users collections and it’s associated designs","description":"Retrieves a users collections and it’s associated designs","operationId":"getUserTeamCollections","tags":["collection"],"security":[{"bearerToken":[]}],"responses":{"200":{"description":"Collections successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionDesigns"}}}},"204":{"description":"No collections found"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/collections/{collectionId}/designs":{"parameters":[{"in":"path","name":"collectionId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the collection"}],"post":{"summary":"Creates a new size of the original design within a collection","description":"Creates a new size of the original design within the original designs collection","operationId":"createCollectionDesign","tags":["collection"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["designId","collectionId","templateCode","measurements"],"properties":{"designId":{"type":"string","format":"uuid"},"collectionId":{"type":"string","format":"uuid"},"templateCode":{"type":"string"},"measurements":{"$ref":"#/components/schemas/Measurements"}}}}}},"responses":{"201":{"description":"Design successfully resized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesignResponse"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"get":{"summary":"Retrieves the list of designs within the collection","description":"Retrieves the list of designs within the collection, at this point, only active DRAFT designs are retrieved.","operationId":"getCollectionDesigns","tags":["collection"],"security":[{"bearerToken":[]}],"responses":{"200":{"description":"Users team favorites successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTeamFavorite"}}}},"204":{"description":"Not designs found within collection"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/collections/{collectionId}/requires-approval":{"parameters":[{"in":"path","name":"collectionId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the collection"}],"put":{"summary":"Flag all team templates within a collection as requiring approval or deactivate approvals","description":"This API allows for team templates collections “requires approval” flag to be switched on/off. The requesting user must be in context of the team and have the Brand Manager role to make this request.","operationId":"updateRequiresApproval","tags":["collection"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionRequiresApproval"}}}},"responses":{"200":{"description":"Collection require approval flag has been successfully updated for all designs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionRequiresApproval"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/:teamId/collections/:collectionId/allocations":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"collectionId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the collection"}],"get":{"summary":"Gets users who have been shared the collection within the team context","description":"Gets users who have been shared the collection within the team context","operationId":"getTeamCollectionAllocations","tags":["collection"],"security":[{"bearerToken":[]}],"responses":{"200":{"description":"Users within team for shared collection successfully retrieved","content":{"application/json":{"schema":{"type":"array","items":{"properties":{"id":{"type":"string","format":"uuid","readOnly":true},"teamId":{"type":"string","format":"uuid"},"collectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date","readOnly":true},"updatedAt":{"type":"string","format":"date","readOnly":true},"user":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"email":{"type":"string","format":"email"},"name":{"type":"string"},"avatar":{"type":"string"},"teamId":{"type":"string","format":"uuid"},"teamName":{"type":"string"},"createdAt":{"type":"string","format":"date","readOnly":true},"updatedAt":{"type":"string","format":"date","readOnly":true}}}}}}}}},"204":{"description":"{}"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"summary":"Creates a collection user team for an individual within a team","description":"Creates collection user team for an individual within a team","operationId":"createCollectionUserTeam","tags":["collection"],"security":[{"bearerToken":[]}],"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team owner of the collection"},{"in":"path","name":"collectionId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the collection to allocate"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"collectionId":{"type":"string","format":"UUID"},"teamId":{"type":"string","format":"UUID"},"userId":{"type":"string","format":"UUID"}}}}}}},"responses":{"207":{"description":"Allocation successfully created. Note error response corresponds with Validator Error","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"status":{"type":"integer","example":201},"body":{"$ref":"#/components/schemas/CollectionUserTeam"}}}}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/:teamId/collections/:collectionId/allocations/:allocationId":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"collectionId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the collection"},{"in":"path","name":"allocationId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the allocation"}],"delete":{"summary":"Deletes a user from the shared collection","description":"Deletes a user from the shared collection","operationId":"deleteTeamCollectionAllocation","tags":["collection"],"security":[{"bearerToken":[]}],"responses":{"204":{"description":"User team collection successfully deleted"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/collections/{collectionId}/allocations":{"parameters":[{"in":"path","name":"collectionId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the collection"}],"put":{"deprecated":true,"summary":"Allocates all designs within a collection to the provided sub teams","description":"Allocates all designs within a collection to the provided sub teams","operationId":"createCollectionTeamAllocation","tags":["collection"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["collectionId","teamIds"],"properties":{"collectionId":{"type":"string","format":"UUID"},"teamIds":{"type":"array","items":{"type":"string","format":"UUID"}}}}}}},"responses":{"200":{"description":"Allocations successfully created.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DesignTeam"}}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"get":{"summary":"Gets sub teams who have been allocated the team template collection","description":"Gets sub teams who have been allocated the team template collection","operationId":"getCollectionAllocations","tags":["collection"],"security":[{"bearerToken":[]}],"responses":{"200":{"description":"Sub teams for allocated collection successfully retrieved","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DesignTeam"}}}}},"204":{"description":"{}"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/collections/{collectionId}/allocations/{teamId}":{"parameters":[{"in":"path","name":"collectionId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the collection"},{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"}],"delete":{"summary":"Deallocates all designs within a collection from the provided sub team","description":"Deallocates all designs within a collection from the provided sub team","operationId":"removeCollectionTeamAllocation","tags":["collection"],"security":[{"bearerToken":[]}],"responses":{"204":{"description":"Allocations successfully removed."},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/remix":{"post":{"summary":"Creates a remix design","description":"Creates a remix design","operationId":"createRemixDesign","tags":["design","remix"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["teamId","designId","userId"],"properties":{"teamId":{"type":"string","format":"UUID"},"designId":{"type":"string","format":"UUID"},"userId":{"type":"string","format":"UUID"}}}}}},"responses":{"201":{"description":"Remix Design successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesignResponse"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/remix":{"post":{"summary":"Creates a remix design in the user's default team","description":"Creates a remix design in the user's default team","operationId":"createRemixDesignDefaultUserTeam","tags":["design","remix"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["designId","userId"],"properties":{"designId":{"type":"string","format":"UUID"},"userId":{"type":"string","format":"UUID"}}}}}},"responses":{"201":{"description":"Remix Design in the user's default team successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesignResponse"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/tutorials":{"get":{"summary":"Retrieves the tutorial designs","description":"Retrieves the tutorial designs","operationId":"getTutorialDesigns","tags":["tutorials"],"security":[{"bearerToken":[]}],"parameters":[{"in":"query","name":"offset","schema":{"type":"integer"},"description":"Offset pagination value. Default: 0"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Count pagination value. Default: 20. Max: 100"}],"responses":{"200":{"description":"Tutorial designs successfully retrieved","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DesignResponse"}}}}},"204":{"description":"No tutorial design found"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/drafts/{designId}":{"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user"},{"in":"path","name":"designId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the design"}],"delete":{"summary":"Permanently deletes a design","description":"Permanently deletes a design","operationId":"deleteDesign","tags":["design"],"security":[{"bearerToken":[]}],"responses":{"204":{"description":"Design successfully deleted"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/purchased/templates":{"get":{"summary":"Get a list of templates belonging to the collections purchased by a user within a team","description":"Get a list of templates from every collection that a user within the team context has purchased","operationId":"getPurchasedTemplates","tags":["purchased collection"],"security":[{"bearerToken":[]}],"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team the user is in context of"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user to fetch templates for"},{"in":"query","name":"size","schema":{"type":"string"},"description":"Template code to filter designs by size"},{"in":"query","name":"offset","schema":{"type":"integer"},"description":"Offset pagination value. Default: 0"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Count pagination value. Default: 20. Max: 100"}],"responses":{"200":{"description":"Designs successfully retrieved","content":{"application/json":{"schema":{"type":"array","$ref":"#/components/schemas/Design"}}}},"204":{"description":"No designs found"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/teams/{teamId}/users/{userId}/purchased/sizes":{"get":{"summary":"List all purchased collection sizes for a user within team context","description":"List all distinct sizes for templates that a user within team context has purchased as a collection","operationId":"getPurchasedTemplateSizes","tags":["purchased collection"],"security":[{"bearerToken":[]}],"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team the user is in context of"},{"in":"path","name":"userId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the user whose workspace is being requested"},{"in":"query","name":"offset","schema":{"type":"integer"},"description":"Offset pagination value. Default: 0"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Count pagination value. Default: 20. Max: 100"}],"responses":{"200":{"description":"Purchased collection template sizes retrieved","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemplateSize"}}}}},"204":{"description":"No sizes found for purchased collection"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/collections/{collectionId}":{"parameters":[{"in":"path","name":"collectionId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the collection"}],"get":{"summary":"Retrieves a collection","description":"Retrieves a subscription master collection resources","operationId":"getCollection","tags":["collection"],"security":[{"bearerToken":[]}],"responses":{"200":{"description":"Collection resources successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionResources"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v2/teams/{teamId}/catalogue/subscription":{"get":{"summary":"Retrieves the subscription catalogue","description":"Retrieves all the subscription designs if the team in context has easil catalogue enabled (default setting). Results can be filtered by size.","operationId":"getSubscriptionCatalogue","tags":["catalogue"],"security":[{"bearerToken":[]}],"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"query","name":"size","schema":{"type":"string"},"description":"template code to filter the results"},{"in":"query","name":"offset","schema":{"type":"integer"},"description":"Offset pagination value. Default: 0"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Count pagination value. Default: 20. Max: 100"},{"in":"query","name":"sortBy","schema":{"type":"string","enum":["createdAt","title","priority","updatedAt"]},"description":"The column to sort results by"},{"in":"query","name":"sortOrder","schema":{"type":"string","enum":["asc","desc"]},"description":"The directions to sort results by"}],"responses":{"200":{"description":"Subscription catalogue successfully retrieved","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CategoryDesignResponse"}}}}},"204":{"description":"No subscription designs exist"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v2/teams/{teamId}/catalogue/sizes":{"get":{"summary":"Returns sizes for the team catalogue.","description":"Returns sizes for the team catalogue. Can also filter by team folders.","operationId":"getTeamCatalogueSizes","tags":["catalogue"],"security":[{"bearerToken":[]}],"parameters":[{"in":"path","name":"teamId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the team"},{"in":"query","name":"folderId","schema":{"type":"string","format":"UUID"},"description":"Provide a folderId to only return sizes from within that folder"},{"in":"query","name":"offset","schema":{"type":"integer"},"description":"Offset pagination value. Default: 0"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Count pagination value. Default: 20. Max: 100"}],"responses":{"200":{"description":"Team catalogue successfully retrieved","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemplateSize"}}}}},"204":{"description":"No sizes exist"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v2/collections/{collectionId}/allocations":{"parameters":[{"in":"path","name":"collectionId","schema":{"type":"string","format":"UUID"},"required":true,"description":"UUID of the collection"}],"put":{"summary":"Allocates all designs within a collection to sub teams","description":"Allocates all designs within a collection to sub teams, sub teams can be optionally provided in the body request param teamIds or suplying the body param shareToAll equals true then allocations are created for all sub teams.","operationId":"createCollectionTeamAllocation","tags":["collection"],"security":[{"bearerToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["collectionId"],"properties":{"collectionId":{"type":"string","format":"UUID"},"teamIds":{"type":"array","items":{"type":"string","format":"UUID"}},"shareToAll":{"type":"boolean"}}}}}},"responses":{"200":{"description":"Allocations successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionAllocationResponse"}}}},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/v1/search":{"get":{"summary":"Search user content (not easil catalogue) for media and designs","description":"Search workspace, team templates, purchased collections, user uploaded media and brandkit media by term","operationId":"searchUserContent","tags":["search"],"security":[{"bearerToken":[]}],"parameters":[{"in":"query","name":"term","schema":{"type":"string"},"required":true,"description":"General search term used in the query. Matches against category as well as design title/subtitle and media name/asset"}],"responses":{"200":{"description":"User Content Found","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SearchResponse"}}}}},"204":{"description":"User Content Not Found"},"400":{"$ref":"#/components/responses/ValidatorError"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AuthorizationError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}},"components":{"securitySchemes":{"bearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"responses":{"ValidatorError":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidatorError"}}}},"AuthenticationError":{"description":"Not authenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"AuthorizationError":{"description":"Insufficient permissions to access resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"InternalServerError":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}},"schemas":{"ApprovalAction":{"required":["id","designId","actionedById","action","comment","createdAt","updatedAt"],"properties":{"id":{"type":"string","format":"uuid","readOnly":true},"designId":{"type":"string","format":"uuid","readOnly":true},"actionedById":{"type":"string","format":"uuid","readOnly":true},"action":{"type":"string","readOnly":true},"comment":{"type":"string","readOnly":true},"createdAt":{"type":"string","format":"date","readOnly":true},"updatedAt":{"type":"string","format":"date","readOnly":true}}},"Category":{"required":["id","title","name","createdAt","updatedAt"],"properties":{"id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":"string","readOnly":true},"createdAt":{"type":"string","format":"date","readOnly":true},"updatedAt":{"type":"string","format":"date","readOnly":true}}},"Credits":{"required":["removeBackground"],"properties":{"removeBackground":{"$ref":"#/components/schemas/RemoveBackgroundCredits"}}},"Design":{"required":["id","title","subtitle","parentId","teamId","userId","collectionId","status","archived","notes","priority","createdAt","updatedAt"],"properties":{"id":{"type":"string","format":"uuid","readOnly":true},"title":{"type":"string"},"subtitle":{"type":"string"},"parentId":{"type":"string","format":"uuid","readOnly":true},"teamId":{"type":"string","format":"uuid","readOnly":true},"userId":{"type":"string","format":"uuid","readOnly":true},"collectionId":{"type":"string","format":"uuid"},"status":{"type":"string","readOnly":true},"width":{"type":"integer","readOnly":true},"height":{"type":"integer","readOnly":true},"isDoubleSided":{"type":"boolean","readOnly":true},"thumbnailUrl":{"type":"string","readOnly":true},"templateSize":{"type":"string","readOnly":true},"templateCode":{"type":"string","readOnly":true},"archived":{"type":"boolean","readOnly":true},"notes":{"type":"string"},"priority":{"type":"integer"},"measurementUnits":{"type":"string"},"isShared":{"type":"boolean","readOnly":true},"isAnimated":{"type":"boolean","readOnly":true},"isLocked":{"type":"boolean","readOnly":true},"lastEditedBy":{"type":"string","format":"date","readOnly":true},"createdAt":{"type":"string","format":"date","readOnly":true},"updatedAt":{"type":"string","format":"date","readOnly":true}}},"DesignWithCategoriesResponse":{"allOf":[{"$ref":"#/components/schemas/Design"},{"properties":{"categories":{"type":"array","items":{"$ref":"#/components/schemas/Category"}}}}]},"CategoryDesignResponse":{"allOf":[{"$ref":"#/components/schemas/Design"},{"required":["subscriptionCode","priceAud","priceUsd"],"properties":{"subscriptionCode":{"type":"string","nullable":true},"priceAud":{"type":"number","nullable":true},"priceUsd":{"type":"number","nullable":true}}}]},"DesignAllocation":{"required":["designId","teamId","createdAt","updatedAt","teamName","teamLogoUrl"],"properties":{"designId":{"type":"string","format":"uuid","readOnly":true},"teamId":{"type":"string","format":"uuid","readOnly":true},"createdAt":{"type":"string","format":"date","readOnly":true},"updatedAt":{"type":"string","format":"date","readOnly":true},"teamName":{"type":"string"},"teamLogoUrl":{"type":"string"}}},"DesignData":{"required":["id","designId","data","documentRestrictions","bleed","ordered","createdAt","updatedAt"],"properties":{"id":{"type":"string","format":"uuid"},"designId":{"type":"string","format":"uuid"},"data":{"type":"string"},"bleed":{"type":"integer"},"documentRestrictions":{"type":"array","items":{"type":"string"}},"ordered":{"type":"boolean"},"createdAt":{"type":"string","format":"date"},"updatedAt":{"type":"string","format":"date"}}},"DesignTeam":{"required":["designId","teamId","createdAt","updatedAt"],"properties":{"designId":{"type":"string","format":"uuid","readOnly":true},"teamId":{"type":"string","format":"uuid","readOnly":true},"createdAt":{"type":"string","format":"date","readOnly":true},"updatedAt":{"type":"string","format":"date","readOnly":true},"team":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":"string","format":"uuid","readOnly":true},"logo":{"type":"string","format":"uuid","readOnly":true}}}}},"DesignResponse":{"properties":{"design":{"$ref":"#/components/schemas/Design"},"designData":{"$ref":"#/components/schemas/DesignData"}}},"FontDeletionRequest":{"required":["id","fontIds"],"properties":{"id":{"type":"string","format":"uuid"},"fontIds":{"type":"array","items":{"type":"string","format":"UUID"}}}},"Media":{"required":["id","name","status","asset","thumbnail","preview","type","createdAt","updatedAt"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"status":{"type":"string"},"asset":{"type":"string"},"thumbnail":{"type":"string"},"preview":{"type":"string"},"priority":{"type":"integer"},"type":{"type":"string"},"size":{"type":"integer"},"width":{"type":"integer"},"height":{"type":"integer"},"createdAt":{"type":"string","format":"date"},"updatedAt":{"type":"string","format":"date"}}},"MediaDeletionRequest":{"required":["id","mediaIds"],"properties":{"id":{"type":"string","format":"uuid"},"mediaIds":{"type":"array","items":{"type":"string","format":"UUID"}}}},"MediaSearchResponse":{"properties":{"id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":"string"},"duration":{"type":"number"},"teamId":{"type":"string","format":"uuid","readOnly":true},"userId":{"type":"string","format":"uuid","readOnly":true},"url":{"type":"string","format":"url","readOnly":true},"previewUrl":{"type":"string","format":"url","readOnly":true},"thumbnailUrl":{"type":"string","format":"url","readOnly":true},"price":{"type":"number","readOnly":true},"subscriptionCode":{"type":"string","readOnly":true}}},"Folder":{"required":["id","name","type","createdAt","updatedAt"],"properties":{"id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":"string"},"type":{"type":"string"},"createdAt":{"type":"string","format":"date","readOnly":true},"updatedAt":{"type":"string","format":"date","readOnly":true}}},"FolderDesign":{"properties":{"folderId":{"type":"string","format":"uuid"},"designId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date"},"updatedAt":{"type":"string","format":"date"}}},"FolderMedia":{"properties":{"folderId":{"type":"string","format":"uuid"},"mediaId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date","readOnly":true},"updatedAt":{"type":"string","format":"date","readOnly":true}}},"BulkFolderDesign":{"allOf":[{"$ref":"#/components/schemas/FolderDesign"},{"required":["collectionId"],"properties":{"collectionId":{"type":"string","format":"uuid"}}}]},"FontFamily":{"properties":{"id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":"string"},"normal":{"type":"boolean"},"bold":{"type":"boolean"},"italic":{"type":"string"},"boldItalic":{"type":"boolean"},"previewUrl":{"type":"string"},"stylesheetUrl":{"type":"string"},"licenceUrl":{"type":"string"},"active":{"type":"boolean"},"public":{"type":"boolean"},"vendor":{"type":"string"},"variants":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"bold":{"type":"boolean"},"italic":{"type":"boolean"},"fontFamily":{"type":"string"}}}},"createdAt":{"type":"string","format":"date","readOnly":true},"updatedAt":{"type":"string","format":"date","readOnly":true}}},"Measurements":{"required":["width","height","units"],"properties":{"width":{"type":"integer"},"height":{"type":"integer"},"units":{"type":"string"}}},"RemoveBackgroundCredits":{"required":["userId","teamId","total","consumed","startAt","endAt","createdAt","updatedAt"],"properties":{"userId":{"type":"string","format":"uuid"},"teamId":{"type":"string","format":"uuid"},"consumed":{"type":"string","readOnly":true},"total":{"type":"string","readOnly":true},"startAt":{"type":"string","format":"date","readOnly":true},"endAt":{"type":"string","format":"date","readOnly":true},"createdAt":{"type":"string","format":"date","readOnly":true},"updatedAt":{"type":"string","format":"date","readOnly":true}}},"SearchResponse":{"type":"object","properties":{"type":{"type":"string","enum":["DESIGN","MEDIA"]},"data":{"type":"object","oneOf":[{"$ref":"#/components/schemas/Design"},{"$ref":"#/components/schemas/MediaSearchResponse"}]}}},"SubscriptionDesign":{"required":["designId","subscritionCode","teamId"],"properties":{"designId":{"type":"string","format":"uuid"},"subscriptionCode":{"type":"string","enum":["BASIC","PLUS","EDGE"]},"createdAt":{"type":"string","format":"date","readOnly":true},"updatedAt":{"type":"string","format":"date","readOnly":true}}},"SuggestionResponse":{"required":["displayName","searchTerm","type"],"properties":{"displayName":{"type":"string"},"searchTerm":{"type":"string"},"type":{"type":"string","enum":["size","term"]}}},"TeamColorGroup":{"required":["id","teamId","name","colors","createdAt","updatedAt"],"properties":{"id":{"type":"string","format":"uuid"},"teamId":{"type":"string","format":"uuid"},"name":{"type":"string"},"colors":{"type":"array","items":{"type":"string"}},"createdAt":{"type":"string","format":"date","readOnly":true},"updatedAt":{"type":"string","format":"date","readOnly":true}}},"TeamFont":{"properties":{"id":{"type":"string"},"teamId":{"type":"string"},"fontId":{"type":"string"},"teamFontName":{"type":"string"},"name":{"type":"string"},"normal":{"type":"boolean"},"bold":{"type":"boolean"},"italic":{"type":"string"},"boldItalic":{"type":"boolean"},"previewUrl":{"type":"string"},"stylesheetUrl":{"type":"string"},"licenceUrl":{"type":"string"},"active":{"type":"boolean"},"public":{"type":"boolean"},"vendor":{"type":"string"},"createdAt":{"type":"string","format":"date","readOnly":true},"updatedAt":{"type":"string","format":"date","readOnly":true}}},"TeamFontResponse":{"properties":{"teamId":{"type":"string"},"fontId":{"type":"string"},"teamFontName":{"type":"string"},"name":{"type":"string"},"normal":{"type":"boolean"},"bold":{"type":"boolean"},"italic":{"type":"string"},"boldItalic":{"type":"boolean"},"previewUrl":{"type":"string"},"stylesheetUrl":{"type":"string"},"licenceUrl":{"type":"string"},"active":{"type":"boolean"},"public":{"type":"boolean"},"vendor":{"type":"string"},"createdAt":{"type":"string","format":"date","readOnly":true},"updatedAt":{"type":"string","format":"date","readOnly":true}}},"TeamFolderResponse":{"allOf":[{"$ref":"#/components/schemas/Folder"},{"required":["sharedByMe","sharedWithMe"],"properties":{"sharedByMe":{"type":"boolean"},"sharedWithMe":{"type":"boolean"}}}]},"SignedUrl":{"required":["id","url","filename"],"properties":{"id":{"type":"string","format":"uuid"},"filename":{"type":"string"},"url":{"type":"string"}}},"TeamLogo":{"required":["media","teamId","mediaId","url","thumbnailUrl","previewUrl","createdAt","updatedAt"],"properties":{"media":{"$ref":"#/components/schemas/Media"},"teamId":{"type":"string","format":"uuid"},"mediaId":{"type":"string","format":"uuid"},"url":{"type":"string"},"thumbnailUrl":{"type":"string"},"previewUrl":{"type":"string"},"createdAt":{"type":"string","format":"date"},"updatedAt":{"type":"string","format":"date"}}},"DesignRequiresApproval":{"required":["designId","requiresApproval"],"properties":{"designId":{"type":"string","format":"uuid"},"requiresApproval":{"type":"boolean"}}},"User":{"required":["id","email","avatar","active","createdAt","updatedAt","roles"],"properties":{"id":{"type":"string","format":"uuid","readOnly":true},"email":{"type":"string","format":"email"},"name":{"type":"string"},"avatar":{"type":"string"},"active":{"type":"boolean","readOnly":true},"createdAt":{"type":"string","format":"date","readOnly":true},"updatedAt":{"type":"string","format":"date","readOnly":true},"roles":{"type":"array","example":["ADMIN","DESIGNER","BRAND_MANAGER","MEMBER"]}}},"Team":{"required":["id","name","country","parentPath","logo","active","createdAt","updatedAt"],"properties":{"id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":"string"},"country":{"type":"string"},"parentPath":{"type":"string","readOnly":true},"logo":{"type":"string"},"active":{"type":"boolean","readOnly":true},"createdAt":{"type":"string","format":"date","readOnly":true},"updatedAt":{"type":"string","format":"date","readOnly":true}}},"TeamImage":{"required":["media","teamId","mediaId","url","thumbnailUrl","previewUrl","createdAt","updatedAt"],"properties":{"media":{"$ref":"#/components/schemas/Media"},"teamId":{"type":"string","format":"uuid"},"mediaId":{"type":"string","format":"uuid"},"url":{"type":"string"},"thumbnailUrl":{"type":"string"},"previewUrl":{"type":"string"},"createdAt":{"type":"string","format":"date"},"updatedAt":{"type":"string","format":"date"}}},"TeamSmartImage":{"required":["id","label","media","teamId","mediaId","url","thumbnailUrl","previewUrl","createdAt","updatedAt"],"properties":{"id":{"type":"string","format":"uuid"},"media":{"$ref":"#/components/schemas/Media"},"teamId":{"type":"string","format":"uuid"},"mediaId":{"type":"string","format":"uuid"},"label":{"type":"string"},"url":{"type":"string"},"thumbnailUrl":{"type":"string","readOnly":true},"previewUrl":{"type":"string","readOnly":true},"createdAt":{"type":"string","format":"date","readOnly":true},"updatedAt":{"type":"string","format":"date","readOnly":true}}},"UserTeamImage":{"required":["media","userId","teamId","mediaId","url","thumbnailUrl","previewUrl","createdAt","updatedAt"],"properties":{"media":{"$ref":"#/components/schemas/Media"},"userId":{"type":"string","format":"uuid"},"teamId":{"type":"string","format":"uuid"},"mediaId":{"type":"string","format":"uuid"},"url":{"type":"string"},"thumbnailUrl":{"type":"string","readOnly":true},"previewUrl":{"type":"string","readOnly":true},"createdAt":{"type":"string","format":"date","readOnly":true},"updatedAt":{"type":"string","format":"date","readOnly":true}}},"UserTeamSmartImage":{"required":["id","label","media","userId","teamId","mediaId","url","thumbnailUrl","previewUrl","createdAt","updatedAt"],"properties":{"id":{"type":"string","format":"uuid"},"media":{"$ref":"#/components/schemas/Media"},"userId":{"type":"string","format":"uuid"},"teamId":{"type":"string","format":"uuid"},"mediaId":{"type":"string","format":"uuid"},"label":{"type":"string"},"url":{"type":"string"},"thumbnailUrl":{"type":"string","readOnly":true},"previewUrl":{"type":"string","readOnly":true},"createdAt":{"type":"string","format":"date","readOnly":true},"updatedAt":{"type":"string","format":"date","readOnly":true}}},"UserTeamFontResponse":{"properties":{"userId":{"type":"string"},"teamId":{"type":"string"},"fontId":{"type":"string"},"teamFontName":{"type":"string"},"fontName":{"type":"string"},"stylesheetUrl":{"type":"string"},"createdAt":{"type":"string","format":"date","readOnly":true},"updatedAt":{"type":"string","format":"date","readOnly":true}}},"UserTeamFavorite":{"required":["userId","teamId","mediaId","url","thumbnailUrl","previewUrl","createdAt","updatedAt"],"properties":{"userId":{"type":"string","format":"uuid"},"teamId":{"type":"string","format":"uuid"},"mediaId":{"type":"string","format":"uuid"},"url":{"type":"string"},"thumbnailUrl":{"type":"integer","readOnly":true},"previewUrl":{"type":"string","readOnly":true},"createdAt":{"type":"string","format":"date","readOnly":true},"updatedAt":{"type":"string","format":"date","readOnly":true}}},"TemplateSize":{"required":["templateCode","name","category","createdAt","updatedAt"],"properties":{"templateCode":{"type":"string"},"name":{"type":"string"},"category":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"widthInMm":{"type":"integer"},"heightInMm":{"type":"integer"},"widthInInches":{"type":"integer"},"heightInInches":{"type":"integer"},"templateType":{"type":"integer"},"createdAt":{"type":"string","format":"date","readOnly":true},"updatedAt":{"type":"string","format":"date","readOnly":true}}},"CollectionUserTeam":{"required":["id","collectionId","userId","teamId","createdAt","updatedAt"],"properties":{"id":{"type":"string","format":"uuid","readOnly":true},"collectionId":{"type":"string","format":"uuid","readOnly":true},"userId":{"type":"string","format":"uuid","readOnly":true},"teamId":{"type":"string","format":"uuid","readOnly":true},"createdAt":{"type":"string","format":"date","readOnly":true},"updatedAt":{"type":"string","format":"date","readOnly":true}}},"CollectionRequiresApproval":{"required":["collectionId","requiresApproval"],"properties":{"collectionId":{"type":"string","format":"uuid"},"requiresApproval":{"type":"boolean"}}},"CollectionDesigns":{"required":["id","createdAt","updatedAt","designs"],"properties":{"id":{"type":"string","format":"uuid","readOnly":true},"createdAt":{"type":"string","format":"date","readOnly":true},"updatedAt":{"type":"string","format":"date","readOnly":true},"designs":{"type":"array","items":{"$ref":"#/components/schemas/Design"},"readOnly":true}}},"CollectionResources":{"required":["id","priceAud","priceUsd","designs","createdAt","updatedAt"],"properties":{"id":{"type":"string","format":"uuid","readOnly":true},"priceAud":{"type":"number","nullable":true},"priceUsd":{"type":"number","nullable":true},"designs":{"type":"array","items":{"$ref":"#/components/schemas/Design"},"readOnly":true},"createdAt":{"type":"string","format":"date","readOnly":true},"updatedAt":{"type":"string","format":"date","readOnly":true}}},"CollectionAllocationResponse":{"required":["collectionId","links"],"properties":{"collectionId":{"type":"string","format":"uuid"},"links":{"properties":{"allocations":{"properties":{"href":{"type":"string"}}}}}}},"FolderAllocationResponse":{"required":["folderId","teamId","links"],"properties":{"collectionId":{"type":"string","format":"uuid"},"links":{"properties":{"allocations":{"properties":{"href":{"type":"string"}}}}}}},"ValidatorError":{"required":["name","status","message","error"],"properties":{"name":{"type":"string","readOnly":true},"status":{"type":"integer","readOnly":true},"message":{"type":"string","readOnly":true},"error":{"type":"object","readOnly":true}},"example":{"name":"HttpError","status":400,"message":"Bad request","error":{"errorCode":"code","path":"path","message":"message"}}},"AuthenticationError":{"required":["name","status","message"],"properties":{"name":{"type":"string","readOnly":true},"status":{"type":"integer","readOnly":true},"message":{"type":"string","readOnly":true},"error":{"type":"object","readOnly":true}},"example":{"name":"HttpError","status":401,"message":"Not authenticated or token has expired"}},"AuthorizationError":{"required":["name","status","message"],"properties":{"name":{"type":"string","readOnly":true},"status":{"type":"integer","readOnly":true},"message":{"type":"string","readOnly":true},"error":{"type":"object","readOnly":true}},"example":{"name":"HttpError","status":403,"message":"Forbidden"}},"InternalServerError":{"required":["name","status","message","error"],"properties":{"name":{"type":"string","readOnly":true},"status":{"type":"integer","readOnly":true},"message":{"type":"string","readOnly":true},"error":{"type":"object","readOnly":true}},"example":{"name":"HttpError","status":500,"message":"Internal server error","error":{}}}}}},"customOptions":{}}