{"openapi":"3.0.0","servers":[{"url":"https://api.motaword.com"},{"url":"https://sandbox.motaword.com"},{"url":"http://localhost"}],"info":{"description":"Use MotaWord API to post and track your translation projects.","title":"MotaWord API","version":"1.0","x-apiClientRegistration":{"url":"https://www.motaword.com/developer/register"},"x-apisguru-categories":["text"],"x-cli-description":"Use MotaWord CLI to interact with your MotaWord account in many ways to manage your translation and localization needs. Visit motaword.com/developer for details.","x-cli-name":"motaword","x-logo":{"url":"https://dentycj2qhk72.cloudfront.net/new/images/new_logo_horizontal.png"},"x-origin":[{"format":"openapi","url":"https://api.motaword.com/swagger","version":"3.0"}],"x-providerName":"motaword.com"},"externalDocs":{"url":"https://www.motaword.com/developer"},"security":[{"mwoAuth":["default"]}],"paths":{"/":{"get":{"description":"The root endpoint will provide you with an OpenAPI definition of MotaWord API.\n","operationId":"getEndpoints","responses":{"200":{"content":{"text/yaml":{"schema":{"type":"object"}}},"description":"YAML representation of our OpenAPI definition."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication error"}},"security":[],"summary":"Available endpoints","tags":["Static"],"x-cli-cmd-group":"static"},"x-internal":true},"/async/download":{"get":{"description":"Download the result of an async operation that you have requested in other endpoints.","operationId":"downloadAsync","parameters":[{"description":"Async operation key","example":"f0db2468-6b77-41a4-bafe-70157bc166ad","in":"query","name":"async_request_key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}}},"description":"File"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Download result of an async operation","tags":["Async"],"x-cli-cmd-group":"async"}},"/blogs":{"get":{"operationId":"getBlogPosts","parameters":[{"description":"Article language, default `en`. When no blog article is available and `fallback=true` is specified, it falls back to `en`.","in":"query","name":"locale","required":false,"schema":{"type":"string"}},{"description":"When `true`, and no article is found in the locale, it falls back to `locale=en`.","in":"query","name":"fallback","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"page","required":false,"schema":{"default":1,"format":"int64","type":"integer"}},{"in":"query","name":"per_page","required":false,"schema":{"default":1,"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlogArticleList"}}},"description":"List of blog articles"}},"summary":"Get blog posts - ordered by created desc by default","tags":["Blog"],"x-cli-cmd-group":"blog"},"x-internal":true},"/cache/{key}":{"delete":{"operationId":"deleteCache","parameters":[{"description":"Cache key","example":"any key","in":"path","name":"key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Operation status"}},"summary":"Clear cache by key"},"x-internal":true},"/commissions":{"get":{"operationId":"getCommissions","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommissionList"}}},"description":"Commissions for client."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnauthorizedUser"}},"summary":"Returns a commission list of current client.","tags":["Commission"],"x-cli-cmd-group":"commissions"},"post":{"operationId":"getCommissionsByFilter","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportFilter"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommissionList"}}},"description":"Commissions for client."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnauthorizedUser"}},"summary":"Returns a commission list of current client.","tags":["Commission"],"x-cli-cmd-group":"commissions"},"x-internal":true},"/continuous_projects":{"get":{"description":"View a list of continuous projects under your account. Continuous projects are those that are constantly updated, such as a CI/CD project, software project, website translation and such.","operationId":"getContinuousProjects","parameters":[{"description":"Type of continuous project.","in":"query","name":"type","required":false,"schema":{"default":"active","enum":["active"],"nullable":true,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuousProjectsList"}}},"description":"Newly created continuous project"}},"summary":"View continuous projects","tags":["ContinuousProject"],"x-cli-aliases":["list"],"x-cli-cmd-group":"continuous-projects"},"post":{"description":"Create a new continuous project for your software, website, CI/CD translation needs.","operationId":"createContinuousProject","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuousProject"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuousProject"}}},"description":"Newly created continuous project"}},"summary":"Create a continuous project","tags":["ContinuousProject"],"x-cli-aliases":["create"],"x-cli-cmd-group":"continuous-projects"}},"/continuous_projects/{id}":{"delete":{"description":"Delete an existing continuous project. Your project will be cancelled, and you will still be charged for the amount of translations we have done for you so far.","operationId":"deleteContinuousProject","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Continuous project deleted successfully"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Delete a continuous project","tags":["ContinuousProject"],"x-cli-aliases":["delete"],"x-cli-cmd-group":"continuous-projects"},"get":{"description":"View the details of a continuous project.","operationId":"getContinuousProject","parameters":[{"description":"Continuous Project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuousProject"}}},"description":"ContinuousProject model"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"View a continuous project","tags":["ContinuousProject"],"x-cli-aliases":["get"],"x-cli-cmd-group":"continuous-projects"},"post":{"description":"Update the details and settings of continuous project.","operationId":"updateContinuousProject","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuousProjectUpdateContent"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuousProject"}}},"description":"Update continuous project operation status"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Update a continuous project","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"}},"/continuous_projects/{id}/analytics-token":{"get":{"description":"Get JWT token to be used in analytics dashboards","operationId":"getAnalyticsToken","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsToken"}}},"description":"JWT token result"}},"summary":"Get JWT token to be used in analytics dashboards","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"},"x-internal":true},"/continuous_projects/{id}/collect-analytics":{"post":{"description":"Save/collect analytics data from Active widget","operationId":"collectAnalytics","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsCollection"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Analytics data collection result"}},"summary":"Save/collect analytics data from Active widget","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"},"x-internal":true},"/continuous_projects/{id}/complete":{"post":{"description":"Complete continuous project","operationId":"complete","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Operation status"}},"summary":"Complete continuous project","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"},"x-internal":true},"/continuous_projects/{id}/documents/quote":{"post":{"description":"Get a new quote for provided documents in continuous project","operationId":"getQuoteForDocuments","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetQuotesForDocumentsBody"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectList"}}},"description":"Newly created project"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"FileTooLarge FileTooSmall FileWasAlreadyUploaded"},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnsupportedDocumentFormat UnsupportedStyleGuideFormat UnsupportedGlossaryFormat"},"406":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnsupportedLanguage TooManyGlossaries ProjectAlreadyHasGlossary"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectInsertFailed"}},"summary":"Get quote for documents","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"},"x-internal":true},"/continuous_projects/{id}/documents/{documentId}/complete":{"post":{"description":"Complete a continuous project document. Per your project settings, a continuous project document can be target language-specific or project-wide for all target languages of the project.","operationId":"completeContinuousDocument","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Document ID","example":179469,"in":"path","name":"documentId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Operation status"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound FileNotFound DocumentNotFound"}},"summary":"Complete a continuous project document","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"},"x-internal":true},"/continuous_projects/{id}/documents/{documentId}/quote":{"post":{"description":"Get a new quote for provided document in continuous project. Per your project settings, a continuous project document can be target language-specific or project-wide for all target languages of the project.","operationId":"getQuoteForDocument","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Document ID","example":179469,"in":"path","name":"documentId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectList"}}},"description":"Newly created project"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"FileTooLarge FileTooSmall FileWasAlreadyUploaded"},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnsupportedDocumentFormat UnsupportedStyleGuideFormat UnsupportedGlossaryFormat"},"406":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnsupportedLanguage TooManyGlossaries ProjectAlreadyHasGlossary"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectInsertFailed"}},"summary":"Get a quote for a continuous project document","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"},"x-internal":true},"/continuous_projects/{id}/languages/quote":{"post":{"description":"Get a new quote for provided target languages in continuous project","operationId":"getQuoteForLanguages","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetQuotesForLanguagesBody"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectList"}}},"description":"Newly created project"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"FileTooLarge FileTooSmall FileWasAlreadyUploaded"},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnsupportedDocumentFormat UnsupportedStyleGuideFormat UnsupportedGlossaryFormat"},"406":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnsupportedLanguage TooManyGlossaries ProjectAlreadyHasGlossary"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectInsertFailed"}},"summary":"Get quote for languages","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"},"x-internal":true},"/continuous_projects/{id}/languages/{targetLanguage}/complete":{"post":{"description":"Complete continuous project language","operationId":"completeLanguage","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Target language that you want to complete","example":"en-US","in":"path","name":"targetLanguage","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Operation status"}},"summary":"Complete continuous project language","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"},"x-internal":true},"/continuous_projects/{id}/languages/{targetLanguage}/quote":{"post":{"description":"Get a new quote for provided target language in continuous project","operationId":"getQuoteForLanguage","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Target language that you want to complete","example":"en-US","in":"path","name":"targetLanguage","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectList"}}},"description":"Newly created project(s)"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"FileTooLarge FileTooSmall FileWasAlreadyUploaded"},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnsupportedDocumentFormat UnsupportedStyleGuideFormat UnsupportedGlossaryFormat"},"406":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnsupportedLanguage TooManyGlossaries ProjectAlreadyHasGlossary"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectInsertFailed"}},"summary":"Get quote for language","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"},"x-internal":true},"/continuous_projects/{id}/subscription":{"delete":{"description":"Delete subscription for continuous project","operationId":"deleteSubscription","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}},"description":"Delete continuous project subscription"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"MissingParameter"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Delete subscription for continuous project","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"},"get":{"description":"Get subscription for continuous project","operationId":"getSubscription","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}},"description":"Get continuous project subscription"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"MissingParameter"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Get subscription for continuous project","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"},"post":{"description":"Create subscription for continuous project","operationId":"createSubscription","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}},"description":"Newly created continuous project subscription"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"MissingParameter"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Create subscription for continuous project","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"},"put":{"description":"Update subscription for continuous project","operationId":"updateSubscription","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}},"description":"Updated continuous project subscription"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"MissingParameter"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Update subscription for continuous project","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"}},"/continuous_projects/{id}/subscription/payment":{"put":{"description":"Update subscription payment method for continuous project","operationId":"updateSubscriptionPaymentMethod","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}},"description":"Updated continuous project subscription"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"MissingParameter"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Update subscription payment method for continuous project","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"}},"/continuous_projects/{id}/translate/{targetLanguage}":{"post":{"description":"Instantly translate your content with your existing TM and MT resources. This is the primary endpoint to translate your files and content on the fly, especially in CI/CD environments. This is a complex endpoint that is configured in your Active or Continuous Project dashboards. For instance, you can configure whether to use your TM, or translate missing strings via MT and then post-edit those new translations. There are various scenarios you can establish via a set of configurations.","operationId":"translate","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Target language that you want to instantly translate your file into.","example":"en-US","in":"path","name":"targetLanguage","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantTranslationRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantTranslationResult"}}},"description":"Instant translation result. It may return a list of translated strings, or a list of translated files."}},"summary":"Instantly translate your content","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"}},"/continuous_projects/{projectId}/documents":{"get":{"description":"View the documents under this continuous project","operationId":"getContinuousProjectDocuments","parameters":[{"description":"Continuous Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"in":"query","name":"filterByLanguage","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuousProjectDocumentList"}}},"description":"A list of continuous project document models"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error","/continuous_projects/{id}/translate/{targetLanguage}":null}}},"description":"ProjectNotFound"}},"summary":"View continuous documents","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"},"post":{"description":"Add a new document to your continuous project. If the name already exists, it will update the existing document. In most scenarios, this operation will also trigger auto-translation of your document, via MT and/or TM.","operationId":"addDocument","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddOrUpdateDocumentRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuousProjectDocument"}}},"description":"The newly added continuous project document object."}},"summary":"Add a new document to your continuous project","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"}},"/continuous_projects/{projectId}/documents/progress":{"post":{"description":"Get continuous project document progress for multiple IDs","operationId":"postContinuousProjectDocumentProgress","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuousProjectDocumentProgressBody"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Progress"}}},"description":"Progress information"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Get continuous project document progress for multiple IDs","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"}},"/continuous_projects/{projectId}/documents/strings":{"post":{"operationId":"postContinuousProjectFileStrings","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuousProjectDocumentStringsBody"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StringList"}}},"description":"Response for strings and their translations"}},"summary":"Get a list of strings and its translations in the project.","tags":["Strings"],"x-cli-cmd-group":"strings"}},"/continuous_projects/{projectId}/documents/{documentId}":{"get":{"description":"View the details of a source document in continuous translation project.","operationId":"getContinuousProjectDocument","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Document ID/Name","example":179469,"in":"path","name":"documentId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuousProjectDocument"}}},"description":"Progress information"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"View a continuous document","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"},"post":{"description":"Update source document in your continuous project. In most scenarios, this operation will also trigger auto-translation of your document, via MT and/or TM.","operationId":"updateDocument","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Continuous project document ID","example":179469,"in":"path","name":"documentId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddOrUpdateDocumentRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuousProjectDocument"}}},"description":"The updated continuous project document object."}},"summary":"Update the document","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"}},"/continuous_projects/{projectId}/documents/{documentId}/progress":{"get":{"description":"Monitor the translation progress of a document in a continuous project in real-time.","operationId":"getContinuousProjectDocumentProgress","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Document ID/Name","example":179469,"in":"path","name":"documentId","required":true,"schema":{"format":"int64","type":"integer"}},{"in":"query","name":"filterByLanguage","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Progress"}}},"description":"Progress information"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Monitor progress of a continuous document","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"}},"/continuous_projects/{projectId}/documents/{documentId}/strings":{"get":{"description":"View the strings from a document and their translations in your continuous translation project, for all target languages. If you need the translated version of your source document/file, then you need to use package and download endpoints.","operationId":"getContinuousProjectFileStrings","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Document ID/Name","example":179469,"in":"path","name":"documentId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StringList"}}},"description":"Response for strings and their translations"}},"summary":"View strings their translations in a continuous document","tags":["Strings"],"x-cli-cmd-group":"strings"}},"/continuous_projects/{projectId}/invoices":{"get":{"description":"Get real-time access to a continuous project's invoices.","operationId":"getContinuousProjectInvoices","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuousProjectInvoices"}}},"description":"Invoices List"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Invoices of a continuous project","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"}},"/continuous_projects/{projectId}/progress":{"get":{"description":"Monitor the translation progress of an ongoing continuous project in real-time.","operationId":"getContinuousProjectProgress","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"in":"query","name":"filterByLanguage","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuousProjectProgress"}}},"description":"Progress information"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Monitor progress and status of a continous project","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"}},"/continuous_projects/{projectId}/strings":{"get":{"description":"View the strings and their translations in your continuous translation project, for all target languages. If you need the translated version of your source document/file, then you need to use package and download endpoints.","operationId":"getContinuousProjectStrings","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StringList"}}},"description":"Response for strings and their translations"}},"summary":"View strings and translations in continuous project","tags":["Strings"],"x-cli-cmd-group":"strings"}},"/continuous_projects/{projectId}/strings/cached":{"delete":{"description":"Clear/delete continuous project translation cache.","operationId":"clearTranslationCache","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Locale","in":"query","name":"locale","required":false,"schema":{"type":"string"}},{"description":"Continuous Project File ID","in":"query","name":"file_id","required":false,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Operation response"}},"summary":"Clear translation cache","tags":["Strings"],"x-cli-cmd-group":"strings"},"get":{"description":"MotaWord caches your account intensively (and in a smart way) in real-time translation environments. This endpoint will return the currently cached strings and translations in your continuous translation project.","operationId":"getTranslationCache","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Flatten cache results and ignore document keys","in":"query","name":"flatten","required":false,"schema":{"default":1,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuousProjectCache"}}},"description":"Response for strings and their translations"}},"summary":"View cached strings translations in continuous project","tags":["Strings"],"x-cli-cmd-group":"strings"}},"/continuous_projects/{projectId}/strings/recache-tms":{"post":{"description":"Recache translations for the continuous project.","operationId":"recacheTranslations","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Locale","in":"query","name":"locale","required":false,"schema":{"type":"string"}},{"description":"Continuous Project File ID","in":"query","name":"file_id","required":false,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Operation response"}},"summary":"Recache translations","tags":["Strings"],"x-cli-cmd-group":"strings"}},"/continuous_projects/{projectId}/widgets":{"get":{"description":"View a list of widgets in your Active project to be used in your website. Most website-specific configuration is provided via widgets.","operationId":"getActiveWidgets","parameters":[{"description":"Continuous Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActiveWidgetList"}}},"description":"List of widgets"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"View Active widgets","tags":["ContinuousProject"],"x-cli-aliases":["widgets"],"x-cli-cmd-group":"continuous-projects"},"post":{"description":"Create a new widget for your Active project to be used in your website. Most website-specific configuration is provided via widgets. This does not create a new Active project, just a separate widget.","operationId":"createActiveWidget","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActiveWidget"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActiveWidget"}}},"description":"Updated widget details"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound | ActiveWidgetNotFound | UnauthorizedUser"}},"summary":"Create a new Active widget","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"}},"/continuous_projects/{projectId}/widgets/{widgetId}":{"delete":{"description":"Delete a single widget for this Active project","operationId":"deleteActiveWidget","parameters":[{"description":"Continuous Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Active widget ID belonging to this Continuous Project","example":236,"in":"path","name":"widgetId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Delete operation result"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound | ActiveWidgetNotFound | UnauthorizedUser"}},"summary":"Delete a single widget for this Active project","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"},"get":{"description":"View the details of an Active widget to be used in your website. Most website-specific configuration is provided via widgets.","operationId":"getActiveWidget","parameters":[{"description":"Continuous Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Active widget ID belonging to this Continuous Project","example":236,"in":"path","name":"widgetId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActiveWidget"}}},"description":"Active widget details"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound | ActiveWidgetNotFound"}},"summary":"View an Active widget","tags":["ContinuousProject"],"x-cli-aliases":["widget"],"x-cli-cmd-group":"continuous-projects"},"post":{"description":"Update Active widget settings.","operationId":"updateActiveWidget","parameters":[{"description":"Continuous Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Active widget ID belonging to this Continuous Project","example":236,"in":"path","name":"widgetId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActiveWidget"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActiveWidget"}}},"description":"Updated widget details"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound | ActiveWidgetNotFound | UnauthorizedUser"}},"summary":"Update Active widget settings.","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"}},"/continuous_projects/{projectId}/widgets/{widgetId}/reset-token":{"post":{"description":"Reset the public token used with your Active widget. This token is used when communicating from your environment to MotaWord systems for translation, analytics and meta.","operationId":"resetActiveWidgetToken","parameters":[{"description":"Continuous Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Active widget ID belonging to this Continuous Project","example":236,"in":"path","name":"widgetId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActiveWidget"}}},"description":"Updated widget details"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound | ActiveWidgetNotFound | UnauthorizedUser"}},"summary":"Reset Active widget token","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"}},"/corporate":{"get":{"description":"View the details of the corporate account that your user account belongs to.","operationId":"getCorporate","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorporateAccount"}}},"description":"Corporate account details"}},"summary":"View your corporate account","tags":["Corporate"],"x-cli-cmd-group":"corporates"}},"/corporate/permissions":{"get":{"description":"View a list of available permissions for your corporate account. They are used when assigning permissions to your corporate users.","operationId":"getAvailableCorporatePermissions","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionList"}}},"description":"List of permission strings"}},"summary":"View available permissions","tags":["Corporate"],"x-cli-cmd-group":"corporates"}},"/corporate/user-groups":{"get":{"description":"View a list of user groups under my corporate account. User groups are a part of our RBAC implementation and can be used to configure complex permission scenarios.","operationId":"getCorporateUserGroups","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroupList"}}},"description":"User group list"}},"summary":"View user groups","tags":["Corporate"],"x-cli-cmd-group":"corporates"},"post":{"description":"Create or update a corporate user group","operationId":"saveCorporateUserGroup","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroup"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroup"}}},"description":"User group list"}},"summary":"Create or update a corporate user group","tags":["Corporate"],"x-cli-cmd-group":"corporates"}},"/corporate/users":{"get":{"description":"View a list of users under your corporate account. This endpoint will only return information if your user account is permitted to view corporate account users, configured by your administrator.","operationId":"getCorporateUsers","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserList"}}},"description":"User list"}},"summary":"View users","tags":["Corporate"],"x-cli-cmd-group":"corporates"},"post":{"description":"Create or update a user under your corporate account. This endpoint requires permissions for corporate user management, configured by your administrator.","operationId":"saveCorporateUser","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserUpdateContent"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"Created or updated user"}},"summary":"Create or update a user","tags":["Corporate"],"x-cli-cmd-group":"corporates"}},"/corporates/all":{"get":{"description":"Get a list of corporate accounts","operationId":"getCorporatesList","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CorporateAccount"},"type":"array"}}},"description":"Corporate account list"}},"summary":"Get a list of corporate accounts","tags":["Corporate"],"x-cli-cmd-group":"corporates"}},"/corporates/{corporateId}":{"get":{"description":"Get details of this corporate account","operationId":"getCorporateById","parameters":[{"description":"Corporate ID","example":2,"in":"path","name":"corporateId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorporateAccount"}}},"description":"Corporate account details"}},"summary":"Get details of this corporate account","tags":["Corporate"],"x-cli-cmd-group":"corporates"},"x-internal":true},"/corporates/{corporateId}/permissions":{"get":{"description":"Get a list of available permissions for this corporate account. They are used when assigning permissions to corporate users.","operationId":"getAvailableCorporatePermissionsById","parameters":[{"description":"Corporate ID","example":2,"in":"path","name":"corporateId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionList"}}},"description":"List of permission strings"}},"summary":"Get a list of available permissions for this corporate account. They are used when assigning permissions to corporate users.","tags":["Corporate"],"x-cli-cmd-group":"corporates"},"x-internal":true},"/corporates/{corporateId}/user-groups":{"get":{"description":"Get a list of user groups for this corporate account","operationId":"getCorporateUserGroupsById","parameters":[{"description":"Corporate ID","example":2,"in":"path","name":"corporateId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroupList"}}},"description":"User group list"}},"summary":"Get a list of user groups for this corporate account","tags":["Corporate"],"x-cli-cmd-group":"corporates"},"post":{"description":"Create or update a corporate user group for this corporate account","operationId":"saveCorporateUserGroupById","parameters":[{"description":"Corporate ID","example":2,"in":"path","name":"corporateId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroup"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroup"}}},"description":"User group list"}},"summary":"Create or update a corporate user group for this corporate account","tags":["Corporate"],"x-cli-cmd-group":"corporates"},"x-internal":true},"/corporates/{corporateId}/users":{"get":{"description":"Get a list of users for this corporate account","operationId":"getCorporateUsersById","parameters":[{"description":"Corporate ID","example":2,"in":"path","name":"corporateId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserList"}}},"description":"User list"}},"summary":"Get a list of users for this corporate account","tags":["Corporate"],"x-cli-cmd-group":"corporates"},"x-internal":true},"/delete-account":{"delete":{"description":"Delete your MotaWord account. Be careful; once deleted, you will not have access to MotaWord via API or your dashboards.","operationId":"deleteAccount","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Successful operation"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"summary":"Delete your account","tags":["User"],"x-cli-cmd-group":"users"}},"/documents":{"get":{"description":"View a list of files and documents that you have translations for. This endpoint lets you view your MotaWord account as a multilingual translated file repository, without needing to go through your projects to interact with files in them.","operationId":"getDocuments","parameters":[{"description":"When true, this will return the most 4 recent active documents.","in":"query","name":"recent","required":false,"schema":{"default":0,"type":"boolean"}},{"in":"query","name":"search","required":false,"schema":{"type":"string"}},{"in":"query","name":"type_filter","required":false,"schema":{"default":"ALL","enum":["ALL","TEXT_DOCUMENTS","PRESENTATIONS","SPREADSHEETS","PDFS","IMAGES","SUBTITLES","DESIGNS","LOCALIZATION","WEB","STYLE_GUIDES","GLOSSARIES"],"type":"string"}},{"description":"searches in source language of documents, in source and target languages of document's quote","in":"query","name":"language_code","required":false,"schema":{"type":"string"}},{"in":"query","name":"page","required":false,"schema":{"default":1,"format":"int64","type":"integer"}},{"in":"query","name":"per_page","required":false,"schema":{"default":10,"format":"int64","type":"integer"}},{"in":"query","name":"order_by","required":false,"schema":{"default":"updated_at","enum":["id","updated_at","created_at","name"],"type":"string"}},{"in":"query","name":"order_type","required":false,"schema":{"$ref":"#/components/schemas/ListOrderType","default":"desc"}},{"description":"Attach further information. Possible values 'preview' to fetch temporary preview URLs. This is NOT recommended to be used with list calls. Only use with[]=preview for single document/style guide calls.","in":"query","name":"with[]","required":false,"schema":{"items":{"enum":["preview","editors"],"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentList"}}},"description":"Document list"}},"summary":"View your documents","tags":["Document"],"x-cli-cmd-group":"documents"}},"/documents/subjects":{"get":{"description":"Get a list of subjects of projects","operationId":"getAllDocumentSubjects","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/DocumentSubjects"},"type":"array"}}},"description":"List of subjects of all projects."}},"summary":"Get a list of subjects of projects","tags":["Document"],"x-cli-cmd-group":"documents"}},"/documents/{documentId}":{"get":{"description":"View a single document from your MotaWord account with its translation info.","operationId":"getDocument","parameters":[{"description":"Document ID or filename","example":"179469","in":"path","name":"documentId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuousProjectDocument"}}},"description":"Document"}},"summary":"View a single document","tags":["Document"],"x-cli-cmd-group":"documents"}},"/documents/{documentId}/progress":{"get":{"description":"View the translation or proofreading progress of a document in your account. You can also track the progress of a document under the project that it was ordered with.","operationId":"getDocumentProgress","parameters":[{"description":"Document ID","example":179469,"in":"path","name":"documentId","required":true,"schema":{"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Progress"}}},"description":"Progress information"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"DocumentNotFound"}},"summary":"View a document translation progress","tags":["Document"],"x-cli-cmd-group":"documents"}},"/documents/{documentId}/regenerate_preview":{"post":{"description":"Regenerate preview and return preview URL for given file","operationId":"regeneratePreview","parameters":[{"description":"Document ID","example":179469,"in":"path","name":"documentId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegeneratePreviewResponse"}}},"description":"RegeneratePreviewResponse"}},"summary":"Regenerate preview and return preview URL for given file","tags":["Document"],"x-cli-cmd-group":"documents"},"x-internal":true},"/documents/{documentId}/similars":{"get":{"description":"Find documents similar to this document. Optionally, include translation information.","operationId":"getSimilarDocuments","parameters":[{"description":"Document ID","example":179469,"in":"path","name":"documentId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Determines the number of similar documents to return.","in":"query","name":"per_page","required":false,"schema":{"default":1,"format":"int64","type":"integer"}},{"description":"Attach further information. Possible values 'preview' to fetch temporary preview URLs. This is NOT recommended to be used with list calls. Only use with[]=preview for single document/style guide calls.","in":"query","name":"with[]","required":false,"schema":{"items":{"enum":["preview","editors"],"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentList"}}},"description":"Document list"}},"summary":"Find documents similar to this document.","tags":["Document"],"x-cli-cmd-group":"documents"},"x-internal":true},"/documents/{documentId}/use_as_draft":{"post":{"description":"Use the translation of given source manual document as manual draft source for the given target document.","operationId":"useAsDraft","parameters":[{"description":"Document ID","example":179469,"in":"path","name":"documentId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UseAsDraftPayload"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Operation status"}},"summary":"Use the translation of given source manual document as manual draft source for the given target document.","tags":["Document"],"x-cli-cmd-group":"documents"},"x-internal":true},"/documents/{documentId}/use_as_regular":{"post":{"description":"Use the translation of the given manual document as a regular file.","operationId":"useAsRegular","parameters":[{"description":"Document ID","example":179469,"in":"path","name":"documentId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UseAsRegularPayload"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Operation status"}},"summary":"Use the translation of the given manual document as a regular file.","tags":["Document"],"x-cli-cmd-group":"documents"},"x-internal":true},"/downgrade-proofreader":{"post":{"operationId":"downgradeProofreader","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Successful operation"},"304":{"description":"Vendor is already a translator"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"VendorNotFound"}},"tags":["User"],"x-cli-cmd-group":"users"},"x-internal":true},"/earnings":{"get":{"description":"View your vendor earnings from your translation activites. Includes real-time earnings from ongoing projects, and fixed earnings from completed projects, as well as total earnings and string edits.","operationId":"getEarnings","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Earnings"}}},"description":"Earnings for vendors"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"summary":"View your vendor earnings","tags":["User"],"x-cli-cmd-group":"users"}},"/formats":{"get":{"description":"Get a list of supported formats for documents, style guides and extensions.\n","operationId":"getFormats","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Formats"},"type":"object"}}},"description":"A list of supported formats"}},"security":[],"summary":"List of supported file formats","tags":["Static"],"x-cli-cmd-group":"static"}},"/freeze-account":{"post":{"description":"Freeze your account temporarily, especially to stop receiving project notifications.","operationId":"freezeAccount","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Successful operation"},"304":{"description":"Account is already frozen for notifications"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"summary":"Freeze account","tags":["User"],"x-cli-cmd-group":"users"}},"/glossary":{"get":{"description":"Download your corporate account's global glossary. This endpoint is available only for corporate account customers. This glossary will be automatically attached to each new project under your account.","operationId":"downloadGlobalGlossary","responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"Glossary file streamed."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"GlossaryNotFound"}},"summary":"Download account glossary.","tags":["Glossary"],"x-cli-cmd-group":"glossaries"},"post":{"description":"Update your corporate account's global glossary. This endpoint is available only for corporate account customers. This glossary will be automatically attached to each new project under your account.","operationId":"updateGlobalGlossary","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountGlossaryUploadRequest"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/AccountGlossaryUploadRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Successful operation"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"FileTooLarge FileTooSmall NoFileUploaded"},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnsupportedGlossaryFormat"}},"summary":"Create or update the account glossary","tags":["Glossary"],"x-cli-cmd-group":"glossaries"}},"/integrations/token":{"get":{"description":"Generate a new access token for MotaWord's integrations service","operationId":"getIntegrationsToken","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationsToken"}}},"description":"Token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"IntegrationsNotEnabled"}},"summary":"Generate a new access token for MotaWord's integrations service","tags":["Integrations"]}},"/invitation/vendors":{"post":{"description":"Get vendor list for compiled invitation needs","operationId":"getInvitationVendors","requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/FileNeedsVendor"},"type":"array"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VendorInvitationList"}}},"description":"Invitation need grouped by vendor"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"FileTooLarge FileTooSmall NoFileUploaded"},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnsupportedGlossaryFormat"}},"summary":"Get vendor list for compiled invitation needs","tags":["Invitation"]},"x-internal":true},"/languages":{"get":{"description":"Get a list of supported languages","operationId":"getLanguages","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Language"},"type":"array"}}},"description":"A list of supported languages"}},"security":[],"summary":"List of supported languages","tags":["Static"],"x-cli-cmd-group":"static"}},"/location":{"post":{"operationId":"logLocation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationUpdateContent"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Successful operation"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"summary":"Log user's current location. This data is used in our Intelligent Project Manager for various data analysis, including project prioritization for vendors and account validation.","tags":["User"],"x-cli-cmd-group":"users"},"x-internal":true},"/make-proofreader":{"post":{"operationId":"makeProofreader","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Successful operation"},"304":{"description":"Vendor is already a proofreader"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"VendorNotFound"}},"tags":["User"],"x-cli-cmd-group":"users"},"x-internal":true},"/me":{"get":{"description":"Get your user information, including client, corporate account and vendor account information.","operationId":"getMe","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"User summary"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"summary":"View your account info","tags":["User"],"x-cli-cmd-group":"users"},"post":{"operationId":"updateMe","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserUpdateContent"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"User info"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"summary":"Update your account info","tags":["User"],"x-cli-cmd-group":"users"}},"/ml/delivery-prediction":{"post":{"description":"Get a delivery prediction for a project","operationId":"getDeliveryPrediction","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryPredictionPayload"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryPredictionResponse"}}},"description":"Prediction and its probability"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"MissingParameter"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Get a delivery prediction for a project","tags":["MachineLearning"]},"x-internal":true},"/notifications/subscribe":{"post":{"description":"Subscribe to push notifications to receive project and platform notifications.","operationId":"subscribeNotification","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationSubscription"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Saved notification subscription information"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"MissingParameter | Failed to save subscription"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"summary":"Subscribe to push notifications","tags":["User"],"x-cli-cmd-group":"users"},"x-internal":true},"/notifications/unsubscribe":{"post":{"operationId":"unsubscribeNotification","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationSubscription"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Deleted notification subscription information"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"MissingParameter | Failed to delete subscription"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"tags":["User"],"x-cli-cmd-group":"users"},"x-internal":true},"/pam/chat":{"post":{"description":"Sends a message to the channel.","operationId":"postMessage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PamMessage"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Successful operation"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Missing Parameter"}},"summary":"Sends a message to chat","tags":["Pam"],"x-cli-cmd-group":"pam"},"x-internal":true},"/pam/profiles/client/{clientId}":{"get":{"description":"Get the Pam  profile of a client for this client ID","operationId":"getClientProfileForPam","parameters":[{"description":"Client ID","example":3707,"in":"path","name":"clientId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientProfile"}}},"description":"Client profile"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ClientProfileNotFound"}},"summary":"Get the Pam profile of a client for this client ID","tags":["Pam"],"x-cli-cmd-group":"pam"},"x-internal":true},"/pam/projects/{projectId}/completion-report":{"get":{"description":"Get completion report data of a project","operationId":"getProjectCompletionReportForPam","parameters":[{"description":"Quote ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectCompletionReport"}}},"description":"Project Completion Report"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Get completion report data of a project","tags":["Pam"],"x-cli-cmd-group":"pam"},"x-internal":true},"/password":{"post":{"description":"Password should contain at least one uppercase, lowercase character and one number","operationId":"updatePassword","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PasswordUpdateContent"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Successful operation"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"summary":"Update your account password","tags":["User"],"x-cli-cmd-group":"users"}},"/payment":{"get":{"description":"Returns billing and saved credit card information for user, and their corporate account if present & allowed.","operationId":"getPaymentInfo","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentInfo"}}},"description":"Returns billing and saved card information for user, and their corporate if present."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound UnauthorizedUser"}},"summary":"View your payment and billing info","tags":["User"],"x-cli-cmd-group":"users"},"post":{"description":"Update your billing and saved credit card information","operationId":"updatePaymentInfo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePaymentInfo"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentInfo"}}},"description":"Successful operation"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"summary":"Update payment info","tags":["User"],"x-cli-cmd-group":"users"}},"/payment/reset-corporate-payment-code":{"post":{"description":"Reset your corporate account's payment code to bypass credit card payment. This will invalidate your current payment code and your users should be aware of this change while ordering translations.","operationId":"resetCorporatePaymentCode","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditCard"}}},"description":"Credit card content"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound UnauthorizedUser MissingCorporateAccount"}},"summary":"Reset payment code","tags":["Payment"],"x-cli-cmd-group":"payment"}},"/payment/toggle-corporate-auto-charge":{"post":{"description":"Toggle (enable/disable) automatic charges on the credit card on file.","operationId":"toggleCorporateAutoCharge","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Successful operation"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound UnauthorizedUser MissingCorporateAccount"}},"summary":"Manage automatic charges on your credit card","tags":["Payment"],"x-cli-cmd-group":"payment"}},"/payment/{cardId}":{"get":{"operationId":"getCreditCard","parameters":[{"description":"Credit Card ID","example":4242424242424242,"in":"path","name":"cardId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditCard"}}},"description":"Credit card content"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"MissingCreditCard"}},"summary":"View saved credit card","tags":["Payment"],"x-cli-cmd-group":"payment"}},"/payment/{cardId}/delete":{"delete":{"operationId":"deleteCreditCard","parameters":[{"description":"Credit Card ID","example":4242424242424242,"in":"path","name":"cardId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Successful operation"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound MissingCorporateAccount MissingParameter MissingCreditCard UnauthorizedUser"}},"summary":"Delete credit card","tags":["Payment"],"x-cli-cmd-group":"payment"}},"/payment/{cardId}/reset-payment-code":{"post":{"description":"Reset the payment code used to bypass credit card payment. This will invalidate your current payment code and your users should be aware of this change while ordering translations.","operationId":"resetCardPaymentCode","parameters":[{"description":"Credit Card ID","example":4242424242424242,"in":"path","name":"cardId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditCard"}}},"description":"Credit card content"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound MissingCorporateAccount MissingParameter MissingCreditCard UnauthorizedUser"}},"summary":"Reset credit card payment code","tags":["Payment"],"x-cli-cmd-group":"payment"}},"/permissions":{"get":{"description":"View a list of permissions that your user account is authorized for, configured either by default, or by your account administator.","operationId":"getPermissions","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionList"}}},"description":"List of permission strings"}},"summary":"View your permissions","tags":["User"],"x-cli-cmd-group":"users"}},"/profile-picture":{"post":{"description":"Upload a profile picture on your account. This is used where your profile is mentioned throughout the platform. Your picture is not used publicly.","operationId":"uploadProfilePicture","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfilePictureUpload"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ProfilePictureUpload"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Successful operation"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Email already exists"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"summary":"Upload profile picture","tags":["User"],"x-cli-cmd-group":"users"}},"/projects":{"get":{"description":"View the translation projects ordered in your account. If you have the related permission (configured by your account administrator), you can view the projects of your colleagues under the same company account.","operationId":"getProjects","parameters":[{"in":"query","name":"page","required":false,"schema":{"default":1,"format":"int64","type":"integer"}},{"in":"query","name":"per_page","required":false,"schema":{"default":10,"format":"int64","type":"integer"}},{"description":"Filter projects by status. Accepts multiple statuses. Possible values 'pending', 'started', 'completed'","in":"query","name":"status[]","required":false,"schema":{"items":{"$ref":"#/components/schemas/ProjectStatus","description":"progress-related project status enums are not supported, such as \"translated\", \"proofread\"."},"type":"array"}},{"deprecated":true,"description":"deprecated. use `status[]` param.","in":"query","name":"with_pending","required":false,"schema":{"default":true,"type":"boolean"}},{"deprecated":true,"description":"deprecated. use `status[]` param.","in":"query","name":"with_started","required":false,"schema":{"default":true,"type":"boolean"}},{"deprecated":true,"description":"deprecated. use `status[]` param.","in":"query","name":"with_completed","required":false,"schema":{"default":true,"type":"boolean"}},{"in":"query","name":"order_by","required":false,"schema":{"default":"id","enum":["id","status","delivery","price"],"type":"string"}},{"in":"query","name":"order_type","required":false,"schema":{"$ref":"#/components/schemas/ListOrderType","default":"desc"}},{"description":"Include detailed information. Possible values 'client', 'vendor'","in":"query","name":"with[]","required":false,"schema":{"items":{"enum":["client","vendor"],"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectList"}}},"description":"Project list"}},"summary":"View your translation projects","tags":["Project"],"x-cli-cmd-group":"projects"},"post":{"description":"Create a new translation project. Projects are not launched (you are not charged) until you `/launch` the created project.","operationId":"createProject","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewProject"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/NewProject"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}},"description":"Newly created project"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"FileTooLarge FileTooSmall FileWasAlreadyUploaded"},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnsupportedDocumentFormat UnsupportedStyleGuideFormat UnsupportedGlossaryFormat"},"406":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnsupportedLanguage TooManyGlossaries ProjectAlreadyHasGlossary"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectInsertFailed"}},"summary":"Create a new project","tags":["Project"],"x-cli-cmd-group":"projects"}},"/projects/from-internal-id/{projectId}":{"get":{"description":"Get Quote Id","operationId":"getQuoteIdFromInternalId","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectId"}}},"description":"QuoteId"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Get Quote Id","tags":["Project"],"x-cli-cmd-group":"projects"},"x-internal":true},"/projects/vendor":{"get":{"description":"Get a list of projects that are available to you to work on as a vendor. This is not a list of projects that you ordered as a customer.","operationId":"getVendorProjects","parameters":[{"description":"Return only projects that this user has already joined","in":"query","name":"joined","required":false,"schema":{"type":"boolean"}},{"description":"Return only projects that have been completed. When `true`, this makes `joined` true as well.","in":"query","name":"completed","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"page","required":false,"schema":{"default":1,"format":"int64","type":"integer"}},{"in":"query","name":"per_page","required":false,"schema":{"default":10,"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectList"}}},"description":"Vendor project list"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"VendorNotFound - this is not a vendor user account"}},"summary":"List projects as a vendor","tags":["Project"],"x-cli-cmd-group":"projects"}},"/projects/{id}":{"delete":{"description":"If you haven't launched your translation project yet, we will delete it. If MotaWord already started working on your project, we will cancel the project and refund the volume that we haven't worked on yet.","operationId":"deleteProject","parameters":[{"description":"Project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Project canceled successfully"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Delete your translation project","tags":["Project"],"x-cli-cmd-group":"projects"},"get":{"description":"View the details of a translation project in your account.","operationId":"getProject","parameters":[{"description":"Project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Include detailed information. Possible values 'client', 'vendor', 'score'","in":"query","name":"with[]","required":false,"schema":{"items":{"enum":["client","vendor","score"],"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}},"description":"Project model"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"View a translation project","tags":["Project"],"x-cli-cmd-group":"projects"},"put":{"operationId":"updateProject","parameters":[{"description":"Project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectUpdate"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ProjectUpdate"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}},"description":"Updated project"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"},"406":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnsupportedLanguage"}},"summary":"Update project info and settings","tags":["Project"],"x-cli-cmd-group":"projects"}},"/projects/{id}/assign-cm":{"post":{"operationId":"assignCM","parameters":[{"description":"Project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CM"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Operation started successfully"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Assign a CM to the project","tags":["Project"],"x-cli-cmd-group":"projects"},"x-internal":true},"/projects/{id}/callback/{actionType}":{"get":{"description":"Trigger a call to your callback URL related to this project.","operationId":"triggerCallback","parameters":[{"description":"Project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Callback type","in":"path","name":"actionType","required":true,"schema":{"enum":["translated","proofread","completed"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallbackResult"}}},"description":"Callback result"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Trigger a call to your callback URL related to this project.","tags":["Project"],"x-cli-cmd-group":"projects"},"x-internal":true},"/projects/{id}/cancel":{"post":{"description":"If you haven't launched your translation project yet, we will delete it. If MotaWord already started working on your project, we will cancel the project and refund the volume that we haven't worked on yet.","operationId":"cancelProject","parameters":[{"description":"Project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelProjectRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Project canceled successfully"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Cancel your translation project","tags":["Project"],"x-cli-cmd-group":"projects"}},"/projects/{id}/deliver":{"post":{"description":"Deliver project to the owner of the project. You can also download your translations in `/package` and `/download` endpoints.","operationId":"deliverProject","parameters":[{"description":"Project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Operation started successfully"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Deliver project","tags":["Project"],"x-cli-cmd-group":"projects"}},"/projects/{id}/download":{"get":{"description":"Download the latest translation package. You must have requested a `/package` call beforehand and wait until the packaging status is 'completed'.","operationId":"download","parameters":[{"description":"Project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}}},"description":"Translation package streamed. The streamed file is always a ZIP file, except when the API client is configured for Drupal and Wordpress."},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotLaunchedYet"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"TranslationPackageNotFound"}},"summary":"Download your translated project","tags":["Project"],"x-cli-cmd-group":"projects"}},"/projects/{id}/download/{language}":{"get":{"description":"Download the latest translation package for your target language. You must have requested a `/package` call beforehand and wait until the packaging status is 'completed'.","operationId":"downloadLanguage","parameters":[{"description":"Project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Language code. You can download the translation of only a specific language.","example":"en-US","in":"path","name":"language","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}}},"description":"Translation package streamed. The streamed file is always a ZIP file, except when the API client is configured for Drupal and Wordpress."},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotLaunchedYet"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"TranslationPackageNotFound"}},"summary":"Download your translated project language","tags":["Project"],"x-cli-cmd-group":"projects"}},"/projects/{id}/email-quote":{"post":{"description":"Send a quote email","operationId":"sendQuoteEmail","parameters":[{"description":"Project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Email sent successfully"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Send a quote email","tags":["Project"],"x-cli-cmd-group":"projects"}},"/projects/{id}/invoice":{"get":{"description":"View your invoice details for your translation project.","operationId":"getInvoice","parameters":[{"description":"Project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}},"description":"Invoice"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound or InvoiceNotFound"}},"summary":"View project invoice","tags":["Project"],"x-cli-cmd-group":"projects"}},"/projects/{id}/invoice.html":{"get":{"description":"Download your project invoice as HTML. This is useful when you want to show your users the invoice in a webpage.","operationId":"downloadHtmlInvoice","parameters":[{"description":"Project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"text/html":{"schema":{"type":"string"}}},"description":"Invoice"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound or InvoiceNotFound"}},"summary":"Download project invoice (HTML)","tags":["Project"],"x-cli-cmd-group":"projects"}},"/projects/{id}/invoice.pdf":{"get":{"description":"Download your project invoice as PDF. Your invoice may be in \"unpaid\" status, in which case youn can see the payment instructions in the PDF file.","operationId":"downloadPdfInvoice","parameters":[{"description":"Project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"Invoice"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound or InvoiceNotFound"}},"summary":"Download project invoice (PDF)","tags":["Project"],"x-cli-cmd-group":"projects"}},"/projects/{id}/launch":{"post":{"description":"Launch your translation project so MotaWord can actually start working on your translation.","operationId":"launchProject","parameters":[{"description":"Project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectPayment"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectLaunchResponse"}}},"description":"Project launched successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"MissingPaymentCode MissingCorporateAccount MissingPaymentMethod"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"CorporateAccountNotAllowedForApiPayment ApiClientMissingPaymentInformation"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Launch your translation project","tags":["Project"],"x-cli-cmd-group":"projects"}},"/projects/{id}/package":{"post":{"description":"Package the translations in your project, prepare translated documents and make it ready to be downloaded. Once packaged, you can download your translated project.","operationId":"package","parameters":[{"description":"Project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"If you want to package and download the translation synchronously, mark this parameter as '0'. It will package the translation and then return the packaged file in the response, identical to /download call after an asynchronous /package call.","in":"query","name":"async","schema":{"default":0,"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}}},"description":"Packaged translation streamed."},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotLaunchedYet"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"TranslationPackageNotFound"}},"summary":"Package your translated project","tags":["Project"],"x-cli-cmd-group":"projects"}},"/projects/{id}/package/check":{"get":{"description":"Track the packaging status of your translations, by using the `key` from packaging request. Once packaging is completed, you can download your translations via `/download` endpoints.","operationId":"trackPackage","parameters":[{"description":"Project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"This is the package tracking key provided in the response of a /package call.","in":"query","name":"key","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackageStatus"}}},"description":"Current status of packaging process."},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotLaunchedYet"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"PackagingStatusMissing"}},"summary":"Track translation packaging status","tags":["Project"],"x-cli-cmd-group":"projects"}},"/projects/{id}/package/{language}":{"post":{"description":"Package the translations in your project for a specific target language, prepare translated documents and make it ready to be downloaded. Once packaged, you can download your translated project in this target language.","operationId":"packageLanguage","parameters":[{"description":"Project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Language code. You can package the translation of only a specific language.","example":"en-US","in":"path","name":"language","required":true,"schema":{"type":"string"}},{"description":"If you want to package and download the translation synchronously, mark this parameter as '0'. It will package the translation and then return the packaged file in the response, identical to /download call after an asynchronous /package call.","in":"query","name":"async","schema":{"default":0,"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Package"}},"application/octet-stream":{"schema":{"format":"binary","type":"string"}}},"description":"Packaging status and tracking code. With the package key, you can track the progress of translation packaging.Also packaged translation streamed."},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotLaunchedYet"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"TranslationPackageNotFound"}},"summary":"Package your translated project language","tags":["Project"],"x-cli-cmd-group":"projects"}},"/projects/{id}/progress":{"get":{"description":"Monitor the translation progress of an already launched project in real-time.","operationId":"getProgress","parameters":[{"description":"Project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"This will return a more raw progress information for translation and proofreading. For instance, when completed, we will return 100% for both tasks by default, whereas their actual progress may be lower than 100%.","in":"query","name":"raw","schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Progress"}}},"description":"Progress information"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotLaunchedYet"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"View progress of a project","tags":["Project"],"x-cli-cmd-group":"projects"}},"/projects/{id}/recreate":{"post":{"operationId":"recreateProject","parameters":[{"description":"Project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Project recreation process started successfully"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnauthorizedUser"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Recreate your translation project from scratch. This is a risky action, you will lose current translations.","tags":["Project"],"x-cli-cmd-group":"projects"},"x-internal":true},"/projects/{id}/reports":{"post":{"operationId":"submitProjectReports","parameters":[{"description":"Project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportContent"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Report submitted successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"MissingMessage"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Submit feedback report for a project","tags":["Project"],"x-cli-cmd-group":"projects"}},"/projects/{id}/sales/activities":{"get":{"operationId":"getSalesActivities","parameters":[{"description":"Project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"in":"query","name":"excludeOwner","required":false,"schema":{"type":"string"}},{"in":"query","name":"type","required":false,"schema":{"$ref":"#/components/schemas/SalesActivityType"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesActivities"}}},"description":"Activities fetched successfully"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Get sales activities for a project","tags":["Activity"],"x-cli-cmd-group":"activities"},"post":{"operationId":"insertSalesActivity","parameters":[{"description":"Project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewSalesActivity"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/NewSalesActivity"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Acvitity inserted successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"BadRequest"}},"summary":"Insert sales activity for a project","tags":["Activity"],"x-cli-cmd-group":"activities"},"x-internal":true},"/projects/{id}/webhooks":{"delete":{"description":"Delete project webhooks. Projects currently support registering only 1 webhook. This endpoint deletes the previously registered webhook.","operationId":"deleteProjectWebhook","parameters":[{"description":"Project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Project webhook deleted successfully"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Delete project webhooks","tags":["Project Webhooks"],"x-cli-cmd-group":"webhooks"},"get":{"description":"This endpoint returns Project entity which contains `callback_url` field for webhook URL. Currently projects can have only 1 webhook registered.","operationId":"getProjectWebhooks","parameters":[{"description":"Project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}},"description":"Project model"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"View project webhooks","tags":["Project Webhooks"],"x-cli-cmd-group":"webhooks"},"post":{"description":"Update project webhook URL","operationId":"postProjectWebhook","parameters":[{"description":"Project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}},"description":"Updated project"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Update project webhook","tags":["Project Webhooks"],"x-cli-cmd-group":"webhooks"},"put":{"description":"Update project webhook URL","operationId":"updateProjectWebhook","parameters":[{"description":"Project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}},"description":"Updated project"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Update project webhook","tags":["Project Webhooks"],"x-cli-cmd-group":"webhooks"}},"/projects/{projectId}/activities":{"get":{"description":"Get a list of real-time activities in the project, such as translation suggestion and translation approval.","operationId":"getActivities","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"in":"query","name":"page","schema":{"default":1,"format":"int64","type":"integer"}},{"in":"query","name":"per_page","schema":{"default":10,"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityList"}}},"description":"A list of activity models"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Monitor project activities","tags":["Activity"],"x-cli-cmd-group":"activities"}},"/projects/{projectId}/activities/{activityId}":{"get":{"description":"View the details of an activity in the project.","operationId":"getActivity","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Activity ID","example":6879,"in":"path","name":"activityId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Activity"}}},"description":"Activity model"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectActivityNotFound"}},"summary":"View an activity","tags":["Activity"],"x-cli-cmd-group":"activities"},"post":{"description":"Submit a comment to an activity in the project, such as translation or editing.","operationId":"submitComment","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Activity ID","example":6879,"in":"path","name":"activityId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Comment"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Comment"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Comment"}}},"description":"Comment model"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectActivityNotFound"}},"summary":"Submit comment to an activity","tags":["Activity"],"x-cli-cmd-group":"activities"}},"/projects/{projectId}/activities/{activityId}/comments":{"get":{"description":"View a list of comments added to this activity.","operationId":"getActivityComments","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Activity ID","example":6879,"in":"path","name":"activityId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentList"}}},"description":"A list of Comment models"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectActivityNotFound"}},"summary":"View activity comments","tags":["Activity"],"x-cli-cmd-group":"activities"}},"/projects/{projectId}/comments":{"get":{"description":"View a list of activity comments in the project.","operationId":"getComments","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"in":"query","name":"page","schema":{"default":1,"format":"int64","type":"integer"}},{"in":"query","name":"per_page","schema":{"default":10,"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentList"}}},"description":"A list of Comment models"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"View all project comments","tags":["Activity"],"x-cli-cmd-group":"activities"}},"/projects/{projectId}/documents":{"get":{"description":"Get a list of source files you uploaded to be translated in your project.","operationId":"getProjectDocuments","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Attach further information. Possible values 'preview' to fetch temporary preview URLs. This is NOT recommended to be used with list calls. Only use with[]=preview for single document/style guide calls.","in":"query","name":"with[]","required":false,"schema":{"items":{"enum":["preview","editors"],"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentList"}}},"description":"A list of document models"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"View project source documents","tags":["Project Document"],"x-cli-cmd-group":"project-documents"},"post":{"description":"Upload a new document","operationId":"createProjectDocument","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentUpdates"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/DocumentUpdates"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentList"}}},"description":"A list of successfully added new documents."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"FileTooLarge FileTooSmall FileWasAlreadyUploaded"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnsupportedDocumentFormat"},"406":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"InvalidDocumentScheme"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectAlreadyStarted"}},"summary":"Upload a new document","tags":["Project Document"],"x-cli-cmd-group":"project-documents"}},"/projects/{projectId}/documents/{documentId}":{"delete":{"description":"Delete the document","operationId":"deleteProjectDocument","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Document ID","example":179469,"in":"path","name":"documentId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Document deleted successfully"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"DocumentNotFound"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectAlreadyStarted"}},"summary":"Delete the document","tags":["Project Document"],"x-cli-cmd-group":"project-documents"},"get":{"description":"View the details of a source file you uploaded to be translated in your project.","operationId":"getProjectDocument","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Document ID","example":179469,"in":"path","name":"documentId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Attach further information. Possible values 'preview' to fetch temporary preview URLs. This is NOT recommended to be used with list calls. Only use with[]=preview for single document/style guide calls.","in":"query","name":"with[]","required":false,"schema":{"items":{"enum":["preview","editors"],"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}},"description":"Document model"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"DocumentNotFound"}},"summary":"View a project source document","tags":["Project Document"],"x-cli-cmd-group":"project-documents"},"post":{"description":"Update the document. File name and contents will replaced with the new one.","operationId":"updateProjectDocument","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Document ID","example":179469,"in":"path","name":"documentId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentUploadRequest"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/DocumentUploadRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}},"description":"Updated document model"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"FileTooLarge FileTooSmall FileWasAlreadyUploaded"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"DocumentNotFound"},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnsupportedDocumentFormat"},"406":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"InvalidDocumentScheme"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectAlreadyStarted"}},"summary":"Update the document.","tags":["Project Document"],"x-cli-cmd-group":"project-documents"}},"/projects/{projectId}/documents/{documentId}/download":{"get":{"description":"Download an actual source file you uploaded to be translated in your project.","operationId":"downloadProjectDocument","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Document ID","example":179469,"in":"path","name":"documentId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"Document streamed"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"DocumentNotFound"}},"summary":"Download a project source document","tags":["Project Document"],"x-cli-cmd-group":"project-documents"}},"/projects/{projectId}/documents/{documentId}/translations":{"get":{"description":"View the strings and their translations in your translation project for the specified source document. The list of translations is live if your project is not completed yet. If you need the translated version of your source document/file, then you need to use package and download endpoints.","operationId":"getDocumentTranslations","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Document ID","example":179469,"in":"path","name":"documentId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StringList"}}},"description":"Response for strings and their translations"}},"summary":"View strings and translations of a document","tags":["Strings"],"x-cli-cmd-group":"translations"}},"/projects/{projectId}/documents/{documentId}/translations/download/{language}":{"get":{"description":"Download translated document in the given target language.","operationId":"downloadTranslatedDocumentForLanguage","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Document ID","example":179469,"in":"path","name":"documentId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Target language code.","example":"en-US","in":"path","name":"language","required":true,"schema":{"type":"string"}},{"description":"Download certified translation","in":"query","name":"certified","required":false,"schema":{"default":0,"type":"boolean"}}],"responses":{"200":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}}},"description":"File"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"DocumentNotFound"}},"summary":"Download translated document","tags":["Project Document"],"x-cli-cmd-group":"project-documents"}},"/projects/{projectId}/documents/{documentId}/translations/{language}":{"get":{"description":"View the strings and their translations in the given target language for the specified source document. The list of translations is live if your project is not completed yet. If you need the translated version of your source document/file, then you need to use package and download endpoints.","operationId":"getDocumentTranslationsForLanguage","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Document ID","example":179469,"in":"path","name":"documentId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Target language code.","example":"en-US","in":"path","name":"language","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StringList"}}},"description":"Response for strings and their translations"}},"summary":"View strings and translations of a document for target language","tags":["Strings"],"x-cli-cmd-group":"translations"}},"/projects/{projectId}/glossaries":{"get":{"description":"View a list of glossaries previously uploaded to the project.","operationId":"getGlossaries","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlossaryList"}}},"description":"A list of glossary models"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"View glossaries","tags":["Glossary"],"x-cli-cmd-group":"glossaries"},"post":{"description":"Upload a new glossary file to your project to be used during translation. Glossaries can be CSV or TBX files.","operationId":"createGlossary","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlossaryUploadRequest"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/GlossaryUploadRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Glossary"}}},"description":"Newly created glossary model."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"FileTooLarge"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnsupportedGlossaryFormat"},"406":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectAlreadyHasGlossary"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectAlreadyStarted"}},"summary":"Upload a glossary file","tags":["Glossary"],"x-cli-cmd-group":"glossaries"}},"/projects/{projectId}/glossaries/{glossaryId}":{"delete":{"description":"Delete the existing glossary from the project.","operationId":"deleteGlossary","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Glossary ID","example":1411,"in":"path","name":"glossaryId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Glossary deleted successfully"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"GlossaryNotFound"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectAlreadyStarted"}},"summary":"Delete a glossary","tags":["Glossary"],"x-cli-cmd-group":"glossaries"},"get":{"description":"View the details of a glossary file uploaded to a project.","operationId":"getGlossary","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Glossary ID","example":1411,"in":"path","name":"glossaryId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Glossary"}}},"description":"Glossary model"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"GlossaryNotFound"}},"summary":"View a glossary","tags":["Glossary"],"x-cli-cmd-group":"glossaries"},"put":{"description":"Update the existing glossary file in the project. Public users are allowed to have only 1 glossary per project and file name and contents will replaced with the new glossary file that you are uploading via this endpoint.","operationId":"updateGlossary","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Glossary ID","example":1411,"in":"path","name":"glossaryId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlossaryUploadRequest"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/GlossaryUploadRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Glossary"}}},"description":"Updated glossary model"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"FileTooLarge"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"GlossaryNotFound"},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnsupportedGlossaryFormat"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectAlreadyStarted"}},"summary":"Update a glossary","tags":["Glossary"],"x-cli-cmd-group":"glossaries"}},"/projects/{projectId}/glossaries/{glossaryId}/download":{"get":{"description":"Download a previously uploaded glossary file.","operationId":"downloadGlossary","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Glossary ID","example":1411,"in":"path","name":"glossaryId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"Glossary streamed"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"GlossaryNotFound"}},"summary":"Download a glossary","tags":["Glossary"],"x-cli-cmd-group":"glossaries"}},"/projects/{projectId}/strings":{"get":{"description":"View the strings and their translations in your translation project, for all target languages. The list of translations is live if your project is not completed yet. If you need the translated version of your source document/file, then you need to use package and download endpoints.","operationId":"getProjectStrings","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StringList"}}},"description":"Response for strings and their translations"}},"summary":"View project strings and translations","tags":["Strings"],"x-cli-cmd-group":"strings"}},"/projects/{projectId}/strings/package":{"post":{"description":"Package and download project translation memory in TMX format","operationId":"packageProjectTranslationMemory","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"If you want to package and download the translation memory synchronously, mark this parameter as '0'. It will package the translation memory and then return the packaged file in the response, identical to async/download call after an asynchronous /package call.","in":"query","name":"async","schema":{"default":0,"format":"int64","type":"integer"}},{"description":"Translation Memory file format","in":"query","name":"format","required":false,"schema":{"default":"tmx","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncOperationStatus"}},"application/xml":{"schema":{"format":"binary","type":"string"}}},"description":"Response in TMX or async request"}},"summary":"Download project translation memory","tags":["Strings"],"x-cli-cmd-group":"strings"}},"/projects/{projectId}/strings/package/status":{"get":{"description":"Check translation memory packaging status for async packaging requests, using the key returned from strings/package call.","operationId":"packageProjectTranslationMemoryStatus","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Async operation key","example":"f0db2468-6b77-41a4-bafe-70157bc166ad","in":"query","name":"async_request_key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncOperationStatus"}}},"description":"Async operation status. Use the key to query status of this operation."}},"summary":"Check translation memory packaging status","tags":["Strings"],"x-cli-cmd-group":"strings"}},"/projects/{projectId}/strings/{languageCode}/package":{"post":{"description":"Package and download project translation memory in TMX format for a specific target language.","operationId":"packageProjectTranslationMemoryForLanguage","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Language Code","example":"en-US","in":"path","name":"languageCode","required":true,"schema":{"type":"string"}},{"description":"If you want to package and download the translation memory synchronously, mark this parameter as '0'. It will package the translation memory and then return the packaged file in the response, identical to async/download call after an asynchronous /package call.","in":"query","name":"async","schema":{"default":0,"format":"int64","type":"integer"}},{"description":"Translation Memory file format","in":"query","name":"format","required":false,"schema":{"default":"tmx","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncOperationStatus"}},"application/xml":{"schema":{"format":"binary","type":"string"}}},"description":"Response in TMX or async request"}},"summary":"Download language-specific project translation memory","tags":["Strings"],"x-cli-cmd-group":"strings"}},"/projects/{projectId}/strings/{languageCode}/package/status":{"get":{"description":"Check translation memory packaging status for async packaging requests, using the key returned from strings/package call.","operationId":"packageProjectTranslationMemoryForLanguageStatus","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Language Code","example":"en-US","in":"path","name":"languageCode","required":true,"schema":{"type":"string"}},{"description":"Async operation key","example":"f0db2468-6b77-41a4-bafe-70157bc166ad","in":"query","name":"async_request_key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncOperationStatus"}}},"description":"Async operation status. Use the key to query status of this operation."}},"summary":"Check language-specific translation memory packaging status","tags":["Strings"],"x-cli-cmd-group":"strings"}},"/projects/{projectId}/strings/{language}":{"get":{"description":"View the strings and their translations in your translation project for the specified target language. The list of translations is live if your project is not completed yet. If you need the translated version of your source document/file, then you need to use package and download endpoints.","operationId":"getProjectStringsForLanguage","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Target language code","example":"en-US","in":"path","name":"language","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StringList"}}},"description":"Response for strings and their translations"}},"summary":"View strings and translations for target language","tags":["Strings"],"x-cli-cmd-group":"strings"}},"/projects/{projectId}/styleguides":{"get":{"description":"View a list of style guides in your project.","operationId":"getStyleGuides","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Attach further information. Possible values 'preview' to fetch temporary preview URLs. This is NOT recommended to be used with list calls. Only use with[]=preview for single document/style guide calls.","in":"query","name":"with[]","required":false,"schema":{"items":{"enum":["preview"],"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StyleGuideList"}}},"description":"A list of style guide models"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"View style guides","tags":["Style Guide"],"x-cli-cmd-group":"styleguides"},"post":{"description":"Upload a new style guide","operationId":"createStyleGuide","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StyleGuideUploadRequest"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/StyleGuideUploadRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StyleGuideList"}}},"description":"Newly created style guide model or a list of new style guide models"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"FileTooLarge"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnsupportedStyleGuideFormat"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectAlreadyStarted"}},"summary":"Upload a new style guide","tags":["Style Guide"],"x-cli-cmd-group":"styleguides"}},"/projects/{projectId}/styleguides/{styleGuideId}":{"delete":{"description":"Delete the existing style guide from the project.","operationId":"deleteStyleGuide","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Style Guide ID","example":13959,"in":"path","name":"styleGuideId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Style guide deleted successfully"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"StyleGuideNotFound"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectAlreadyStarted"}},"summary":"Delete a style guide","tags":["Style Guide"],"x-cli-cmd-group":"styleguides"},"get":{"description":"View the details of a style guide uploaded to a project","operationId":"getStyleGuide","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Style Guide ID","example":13959,"in":"path","name":"styleGuideId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Attach further information. Possible values 'preview' to fetch temporary preview URLs. This is NOT recommended to be used with list calls. Only use with[]=preview for single document/style guide calls.","in":"query","name":"with[]","required":false,"schema":{"items":{"enum":["preview"],"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StyleGuide"}}},"description":"Style guide model"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"StyleGuideNotFound"}},"summary":"View a style guide","tags":["Style Guide"],"x-cli-cmd-group":"styleguides"},"put":{"description":"Update the existing style guide in the project. Public users are allowed to have only 1 style guide per project and file name and contents will replaced with the new style guide that you are uploading via this endpoint.","operationId":"updateStyleGuide","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Style guide ID","example":13959,"in":"path","name":"styleGuideId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StyleGuideUploadRequest"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/StyleGuideUploadRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StyleGuide"}}},"description":"Updated style guide model"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"FileTooLarge"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"StyleGuideNotFound"},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnsupportedStyleGuideFormat"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectAlreadyStarted"}},"summary":"Update a style guide","tags":["Style Guide"],"x-cli-cmd-group":"styleguides"}},"/projects/{projectId}/styleguides/{styleGuideId}/download":{"get":{"description":"Download a previously uploaded style guide file.","operationId":"downloadStyleGuide","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Style Guide ID","example":13959,"in":"path","name":"styleGuideId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"Style guide streamed"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"StyleGuideNotFound"}},"summary":"Download a style guide","tags":["Style Guide"],"x-cli-cmd-group":"styleguides"}},"/projects/{projectId}/translations":{"get":{"deprecated":true,"operationId":"getProjectTranslations","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StringList"}}},"description":"Response for strings and their translations"}},"summary":"Deprecated. Use /projects/{projectId}/strings instead.","tags":["Strings"],"x-cli-cmd-group":"translations"},"x-internal":true},"/projects/{projectId}/translations/{language}":{"get":{"deprecated":true,"operationId":"getProjectTranslationsForLanguage","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Target language code","example":"en-US","in":"path","name":"language","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StringList"}}},"description":"Response for strings and their translations"}},"summary":"Deprecated. use /projects/{projectId}/strings/{language} instead.","tags":["Strings"],"x-cli-cmd-group":"translations"},"x-internal":true},"/projects/{projectId}/vendors":{"get":{"description":"Get a list of vendors.","operationId":"getProjectVendors","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserList"}}},"description":"User list"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotLaunchedYet"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Get a list of vendors.","tags":["Project"],"x-cli-cmd-group":"projects"},"x-internal":true},"/reports/filter":{"post":{"operationId":"getFilterContents","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilterDates"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilterContents"}}},"description":"Filter contents"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"summary":"Returns available options for selected timeframe.","tags":["Report"],"x-cli-cmd-group":"reports"}},"/reports/language-pairs":{"post":{"description":"View translation reports for each language pair with translations under your account. You can view company-wide language pairs if you have the user permission.","operationId":"getLanguagePairsReport","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportFilter"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanguagePairsReport"}}},"description":"Language pairs stats for client and vendors"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"summary":"Language pairs report","tags":["Report"],"x-cli-cmd-group":"reports"}},"/reports/projects":{"post":{"description":"View projects under your account, with advanced filtering. You can view company-wide projects if you have the user permission.","operationId":"getProjectsReport","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportFilter"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectList"}}},"description":"User stats for client and vendors"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"summary":"Projects report","tags":["Report"],"x-cli-cmd-group":"reports"}},"/reports/qa":{"post":{"description":"Generate a QA report for given filter","operationId":"generateQAReport","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QaFilter"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QaWarnings"}}},"description":"List of QA entries"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"MissingParameter"}},"summary":"Generate a QA report for given filter","tags":["Report"]}},"/reports/users":{"post":{"description":"View translation reports for each user under your company account. You need the permission to view users in your company.","operationId":"getUsersReport","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportFilter"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsersReport"}}},"description":"User stats for client and vendors"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"summary":"Company users report","tags":["Report"],"x-cli-cmd-group":"reports"}},"/resend-email-confirmation":{"post":{"operationId":"sendEmailConfirmation","responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OperationStatus"},{"properties":{"status":{"default":"success","enum":["success","already_confirmed"],"type":"string"}},"type":"object"}]}}},"description":"When confirmation email is sent, status is `success`, or `already_confirmed` when user has already confirmed their email address."}},"summary":"Sends email confirmation email for current user","tags":["User"],"x-cli-cmd-group":"users"},"x-internal":true},"/responsivity":{"get":{"description":"View your statistical analysis of responsiveness to our translation projects, invitations, notifications and such.","operationId":"getResponsivity","parameters":[{"description":"Time period to calculate your responsiveness","in":"query","name":"period","schema":{"default":"monthly","enum":["monthly","weekly"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsivityList"}}},"description":"Vendor responsivity stats"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"VendorNotFound - this is not a vendor user account"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"summary":"View your vendor responsiveness","tags":["User"],"x-cli-cmd-group":"users"}},"/search":{"get":{"description":"Search through everything in your account, from projects to documents, from source strings to translations...","operationId":"searchEverywhere","parameters":[{"description":"Search query term","example":"en-US","in":"query","name":"query","required":true,"schema":{"type":"string"}},{"description":"Search in these entities. Current oprions are projects, documents, strings. Can be multiple. When not provided, we'll search through all entities.","in":"query","name":"include[]","required":false,"schema":{"items":{"enum":["projects","documents","strings"],"type":"string"},"type":"array"}},{"in":"query","name":"page","required":false,"schema":{"default":1,"format":"int64","type":"integer"}},{"in":"query","name":"per_page","required":false,"schema":{"default":10,"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchEverywhereResult"}}},"description":"Search result for multiple entities and paging"}},"summary":"Search everything in your account","tags":["Search"],"x-cli-cmd-group":"search"}},"/search/documents/reindex":{"post":{"operationId":"reindexDocuments","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncOperationStatus"}}},"description":"Async operation status. Use the key to query status of this operation."}},"summary":"Reindex for search all of the client source and translation documents.","tags":["Search"],"x-cli-cmd-group":"search"},"x-internal":true},"/search/documents/reindex/status":{"get":{"operationId":"checkDocumentsReindex","parameters":[{"description":"Async operation key","example":"f0db2468-6b77-41a4-bafe-70157bc166ad","in":"query","name":"async_request_key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncOperationStatus"}}},"description":"Async operation status. Use the key to query status of this operation."}},"summary":"Check reindex status of the client source and translation documents.","tags":["Search"],"x-cli-cmd-group":"search"},"x-internal":true},"/stats":{"get":{"description":"View your client and vendor statistics.","operationId":"getStats","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Stats"}}},"description":"Client and vendor statistics for your account"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"summary":"View your account statistics","tags":["User"],"x-cli-cmd-group":"users"}},"/stats/commissions":{"get":{"operationId":"getCommissionStats","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommissionStats"}}},"description":"User's commission stats"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnauthorizedUser"}},"summary":"Returns the total commissions stats.","tags":["Stats"],"x-cli-cmd-group":"commissions"},"post":{"operationId":"getCommissionStatsByFilter","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportFilter"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommissionStats"}}},"description":"User's commission stats"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnauthorizedUser"}},"summary":"Returns the total commissions stats by report filter.","tags":["Stats"],"x-cli-cmd-group":"commissions"},"x-internal":true},"/stats/popular-pairs":{"get":{"operationId":"getPopularPairs","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PopularLanguagePairs"}}},"description":"Your most ordered language pairs"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"summary":"View your popular language pairs","tags":["Stats"],"x-cli-cmd-group":"stats"}},"/stats/projects":{"get":{"operationId":"getProjectStats","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientProjectStats"}}},"description":"Project statistics for your account"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"summary":"View your project statistics","tags":["Stats"],"x-cli-cmd-group":"stats"}},"/stats/strings":{"get":{"operationId":"getStringStats","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientStringStats"}}},"description":"Translation statistics for your account"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"summary":"View your translation statistics","tags":["Stats"],"x-cli-cmd-group":"stats"}},"/strings":{"get":{"description":"Get a list of all strings and their translations under your account, from all projects. This is your MotaWord translation memory. If you have the related permission, this endpoint will also return strings from your company account.","operationId":"getStrings","parameters":[{"description":"Source Language Code","in":"query","name":"source_language","required":false,"schema":{"type":"string"}},{"description":"Requested page","in":"query","name":"page","required":false,"schema":{"default":0,"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientStrings"}}},"description":"List of strings in JSON"}},"summary":"View account strings (translation memory)","tags":["Strings"],"x-cli-cmd-group":"strings"},"post":{"deprecated":true,"description":"Deprecated, use instant translation mechanism for continuous projects.","operationId":"postStrings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeprecatedStringTranslationContent"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MachineTranslatedStrings"}}},"description":"Machine Translated Strings in JSON"}},"summary":"Translate Strings with MT","tags":["Strings"],"x-cli-cmd-group":"strings","x-internal":true},"put":{"description":"Update the translation of a string from your account strings/translation memory.","operationId":"updateTranslationMemoryUnit","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranslationMemoryUnit"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Translation updated by adding new translation memory unit"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Corporate id, source language, target language, source string or target string is not provided"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Source language or target language is not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Something went wrong and translation unit is not updated"}},"summary":"Update string translation","tags":["Strings"]}},"/strings/{languageCode}/package":{"post":{"description":"Package and download account translation memory in TMX format. If you have the related permission, this will also download your company translation memory.","operationId":"packageUserTranslationMemory","parameters":[{"description":"Source Language Code","example":"en-US","in":"path","name":"languageCode","required":true,"schema":{"type":"string"}},{"description":"If you want to package and download the translation memory synchronously, mark this parameter as '0'. It will package the translation memory and then return the packaged file in the response, identical to async/download call after an asynchronous /package call.","in":"query","name":"async","schema":{"default":0,"format":"int64","type":"integer"}},{"description":"If you don't need us to email the TMX, set this to '0'. Default is 1.","in":"query","name":"email","schema":{"default":1,"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncOperationStatus"}},"application/xml":{"schema":{"format":"binary","type":"string"}}},"description":"Response in TMX or async request"}},"summary":"Download account translation memory","tags":["Strings"],"x-cli-cmd-group":"strings"}},"/strings/{languageCode}/package/status":{"get":{"description":"Check translation memory packaging status for async packaging requests, using the key returned from strings/package call.","operationId":"packageUserTranslationMemoryForLanguageStatus","parameters":[{"description":"Language Code","example":"en-US","in":"path","name":"languageCode","required":true,"schema":{"type":"string"}},{"description":"Async operation key","example":"f0db2468-6b77-41a4-bafe-70157bc166ad","in":"query","name":"async_request_key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncOperationStatus"}}},"description":"Async operation status. Use the key to query status of this operation."}},"summary":"Check account translation memory packaging status","tags":["Strings"],"x-cli-cmd-group":"strings"}},"/styleguide":{"get":{"description":"Download your account's global style guide. This endpoint is available only for corporate account customers. This style guide will be automatically attached to each new project under your account.","operationId":"downloadGlobalStyleGuide","responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"Style guide file streamed."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"StyleGuideNotFound"}},"summary":"Download account style guide","tags":["Style Guide"],"x-cli-cmd-group":"styleguides"},"post":{"description":"Update your corporate account's global style guide. This endpoint is available only for corporate account customers. This style guide will be automatically attached to each new project under your account.","operationId":"updateGlobalStyleGuide","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountStyleGuideUploadRequest"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/AccountStyleGuideUploadRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Successful operation"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"FileTooLarge FileTooSmall NoFileUploaded MissingCorporateAccount"},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnsupportedStyleGuideFormat"}},"summary":"Create or update the account style guide","tags":["Style Guide"],"x-cli-cmd-group":"styleguides"}},"/surveys/{scope}/{type}":{"get":{"description":"Get survey questions in given scope and type","operationId":"getQuestions","parameters":[{"description":"Scope","example":"vendor","in":"path","name":"scope","required":true,"schema":{"type":"string"}},{"description":"Type","example":"profile","in":"path","name":"type","required":true,"schema":{"type":"string"}},{"description":"Project ID","example":74,"in":"query","name":"attach_answers_for_project","required":false,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SurveyQuestions"}}},"description":"Survey Questions"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"SurveyQuestionsNotFound"}},"summary":"Get survey questions in given scope and type","tags":["Surveys"]},"post":{"description":"Post survey answers for scope and type","operationId":"submitAnswers","parameters":[{"description":"Scope","example":"vendor","in":"path","name":"scope","required":true,"schema":{"type":"string"}},{"description":"Type","example":"profile","in":"path","name":"type","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SurveyAnswers"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Survey Answers"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"FailedToSubmitSurveyAnswers"}},"summary":"Post survey answers for scope and type","tags":["Surveys"]}},"/swagger":{"get":{"description":"Get Swagger YAML","operationId":"getSwaggerYaml","responses":{"200":{"content":{"text/yaml":{"schema":{"type":"string"}}},"description":"Swagger YAML"}},"summary":"OpenAPI YAML representation of our API","tags":["Static"],"x-cli-cmd-group":"static"}},"/token":{"post":{"description":"MotaWord API is using OAuth2 procedures when authenticating or authorizing your API call.\n","operationId":"getAccessToken","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenRequest"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/TokenRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}},"description":"Authentication response"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenError"}}},"description":"Authentication error - for vendor auth, it will also fail if their account is not approved yet. In that case, the error response will include \"account_status\" key."}},"security":[{"basicAuth":[]}],"summary":"Retrieve an access token","tags":["Auth"],"x-cli-cmd-group":"auth"}},"/unfreeze-account":{"post":{"description":"Reactive your account to start receiving notifications.","operationId":"unfreezeAccount","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Successful operation"},"304":{"description":"Account is already unfrozen for notifications"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"summary":"Defreeze your account","tags":["User"],"x-cli-cmd-group":"users"}},"/user-groups":{"get":{"description":"View the user groups that your user account belongs to. This is typically configured by your account administator's dashboard.","operationId":"getUserGroups","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroupList"}}},"description":"List of user groups"}},"summary":"View your user groups","tags":["User"],"x-cli-cmd-group":"users"}},"/users":{"get":{"description":"Get a list of platform users","operationId":"getUsers","parameters":[{"in":"query","name":"page","required":false,"schema":{"default":1,"format":"int64","type":"integer"}},{"in":"query","name":"per_page","required":false,"schema":{"default":10,"format":"int64","type":"integer"}},{"in":"query","name":"user_type","required":false,"schema":{"default":"all","enum":["vendor","all"],"type":"string"}},{"in":"query","name":"search","required":false,"schema":{"type":"string"}},{"in":"query","name":"email","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserList"}}},"description":"User list"}},"summary":"Get a list of platform users","tags":["User"],"x-cli-cmd-group":"users"},"post":{"description":"Create a new platform user","operationId":"createUser","parameters":[{"description":"Send a welcome email to the user","in":"query","name":"notify","required":false,"schema":{"default":1,"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"Created user"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid information given for user!"}},"summary":"Create a new user","tags":["User"],"x-cli-cmd-group":"users"},"x-internal":true},"/users/available-vendors":{"post":{"description":"Get a list of vendors available for the criteria given","operationId":"getAvailableVendors","parameters":[{"description":"Include detailed information. Possible values 'user'. Requesting user info enrichment takes much longer.","in":"query","name":"with[]","required":false,"schema":{"items":{"enum":["user"],"type":"string"},"type":"array"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailableVendorsFilter"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserList"}}},"description":"User list"}},"summary":"Get a list of vendors available for the criteria given","tags":["Vendor"],"x-cli-cmd-group":"vendors"},"x-internal":true},"/users/filter":{"post":{"description":"Get a list of vendors available for the criteria given","operationId":"getFilteredVendors","parameters":[{"description":"The page number","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"The number of items per page","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The field to order the results by","in":"query","name":"order_by","required":false,"schema":{"type":"string"}},{"description":"The order to sort the results by (ascending or descending)","in":"query","name":"order","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilterVendorRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserList"}}},"description":"Successful response User List"}},"summary":"Filter vendors based on provided parameters","tags":["User"],"x-cli-cmd-group":"users"}},"/users/send-password-reminder":{"post":{"operationId":"sendPasswordReminder","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Email"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Successful operation"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Reminder already sent, wait for a while before new request!"}},"summary":"Sends password reset email to the user's registered email address","tags":["User"],"x-cli-cmd-group":"users"},"x-internal":true},"/users/tags":{"get":{"description":"Returns all vendor tags for vendors filter","operationId":"getAllVendorTags","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/VendorTag"},"type":"array"}}},"description":"Successful response tag list"}},"summary":"Returns all vendor tags for vendors filter","tags":["User"],"x-cli-cmd-group":"users"}},"/{userId}":{"get":{"operationId":"getUser","parameters":[{"description":"User ID","example":1,"in":"path","name":"userId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"User summary"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"security":[{"mwoAuth":["privileged"]}],"summary":"Get user information, including client or vendor specific info.","tags":["User"],"x-cli-cmd-group":"users"},"post":{"operationId":"updateUser","parameters":[{"description":"User ID","example":1,"in":"path","name":"userId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserUpdateContent"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"User info"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"tags":["User"],"x-cli-cmd-group":"users"},"x-internal":true},"/{userId}/approve":{"post":{"operationId":"approveVendorApplication","parameters":[{"description":"User ID","example":1,"in":"path","name":"userId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Vendor application of this user is approved. User is ready to work with us."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"security":[{"mwoAuth":["privileged"]}],"tags":["User"],"x-cli-cmd-group":"users"},"x-internal":true},"/{userId}/delete-account":{"delete":{"operationId":"deleteUserAccount","parameters":[{"description":"User ID","example":1,"in":"path","name":"userId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Successful operation"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"summary":"Delete requester account","tags":["User"],"x-cli-cmd-group":"users"},"x-internal":true},"/{userId}/documents":{"get":{"description":"Get a list of your documents","operationId":"getUserDocuments","parameters":[{"description":"User ID","example":1,"in":"path","name":"userId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"When true, this will return the most 4 recent active documents.","in":"query","name":"recent","required":false,"schema":{"default":0,"type":"boolean"}},{"in":"query","name":"search","required":false,"schema":{"type":"string"}},{"in":"query","name":"type_filter","required":false,"schema":{"default":"ALL","enum":["ALL","TEXT_DOCUMENTS","PRESENTATIONS","SPREADSHEETS","PDFS","IMAGES","SUBTITLES","DESIGNS","LOCALIZATION","WEB","STYLE_GUIDES","GLOSSARIES"],"type":"string"}},{"description":"searches in source language of documents, in source and target languages of document's quote","in":"query","name":"language_code","required":false,"schema":{"type":"string"}},{"in":"query","name":"page","required":false,"schema":{"default":1,"format":"int64","type":"integer"}},{"in":"query","name":"per_page","required":false,"schema":{"default":10,"format":"int64","type":"integer"}},{"in":"query","name":"order_by","required":false,"schema":{"default":"updated_at","enum":["id","updated_at","created_at","name"],"type":"string"}},{"in":"query","name":"order_type","required":false,"schema":{"$ref":"#/components/schemas/ListOrderType","default":"desc"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentList"}}},"description":"Document list"}},"summary":"Get a list of your documents","tags":["Document"],"x-cli-cmd-group":"documents"},"x-internal":true},"/{userId}/downgrade-proofreader":{"post":{"operationId":"downgradeUserProofreader","parameters":[{"description":"User ID","example":1,"in":"path","name":"userId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Successful operation"},"304":{"description":"Vendor is already a translator"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"VendorNotFound"}},"security":[{"mwoAuth":["privileged"]}],"tags":["User"],"x-cli-cmd-group":"users"},"x-internal":true},"/{userId}/earnings":{"get":{"operationId":"getUserEarnings","parameters":[{"description":"User ID","example":1,"in":"path","name":"userId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Earnings"}}},"description":"Earnings for vendors"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"security":[{"mwoAuth":["privileged"]}],"summary":"Returns your vendor earnings. Includes real-time earnings from ongoing projects, and fixed earnings from completed projects. Also includes total earnings and string edits.","tags":["User"],"x-cli-cmd-group":"users"},"x-internal":true},"/{userId}/freeze-account":{"post":{"operationId":"freezeUserAccount","parameters":[{"description":"User ID","example":1,"in":"path","name":"userId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Successful operation"},"304":{"description":"Account is already frozen for notifications"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"summary":"Freeze requester account for project notifications","tags":["User"],"x-cli-cmd-group":"users"},"x-internal":true},"/{userId}/make-proofreader":{"post":{"operationId":"makeUserProofreader","parameters":[{"description":"User ID","example":1,"in":"path","name":"userId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Successful operation"},"304":{"description":"Vendor is already a proofreader"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"VendorNotFound"}},"security":[{"mwoAuth":["privileged"]}],"tags":["User"],"x-cli-cmd-group":"users"},"x-internal":true},"/{userId}/notifications/subscribe":{"post":{"operationId":"subscribeUserNotification","parameters":[{"description":"User ID","example":1,"in":"path","name":"userId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationSubscription"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Saved notification subscription information"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"MissingParameter | Failed to save subscription"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"security":[{"mwoAuth":["privileged"]}],"tags":["User"],"x-cli-cmd-group":"users"},"x-internal":true},"/{userId}/notifications/unsubscribe":{"post":{"operationId":"unsubscribeUserNotification","parameters":[{"description":"User ID","example":1,"in":"path","name":"userId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationSubscription"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Deleted notification subscription information"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"MissingParameter | Failed to delete subscription"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"security":[{"mwoAuth":["privileged"]}],"tags":["User"],"x-cli-cmd-group":"users"},"x-internal":true},"/{userId}/payment":{"get":{"description":"Returns billing and saved credit card information for user, and their corporate account if present & allowed.","operationId":"getUserPaymentInfo","parameters":[{"description":"User ID","example":1,"in":"path","name":"userId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentInfo"}}},"description":"Returns billing and saved card information for user, and their corporate if present."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound UnauthorizedUser"}},"summary":"View user's payment and billing info","tags":["User"],"x-cli-cmd-group":"users"},"post":{"description":"Update user's billing and saved credit card information","operationId":"updateUserPaymentInfo","parameters":[{"description":"User ID","example":1,"in":"path","name":"userId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentInfo"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Successful operation"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"summary":"Update user payment info","tags":["User"],"x-cli-cmd-group":"users"},"x-internal":true},"/{userId}/permissions":{"get":{"operationId":"getUserPermissions","parameters":[{"description":"User ID","example":1,"in":"path","name":"userId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionList"}}},"description":"List of permission strings"}},"summary":"Returns a list of permissions that this user is authorized for.","tags":["User"],"x-cli-cmd-group":"corporates"},"x-internal":true},"/{userId}/profile-picture":{"post":{"operationId":"uploadUserProfilePicture","parameters":[{"description":"User ID","example":1,"in":"path","name":"userId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfilePictureUpload"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ProfilePictureUpload"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Successful operation"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"NoFileUploaded"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"security":[{"mwoAuth":["privileged"]}],"tags":["User"],"x-cli-cmd-group":"users"},"x-internal":true},"/{userId}/projects/vendor":{"get":{"description":"Get a list of user/vendor projects","operationId":"getVendorProjectsByUserId","parameters":[{"description":"User ID","example":1,"in":"path","name":"userId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Return only projects that this user has already joined","in":"query","name":"joined","required":false,"schema":{"type":"boolean"}},{"description":"Return only projects that have been completed. When `true`, this makes `joined` true as well.","in":"query","name":"completed","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"page","required":false,"schema":{"default":1,"format":"int64","type":"integer"}},{"in":"query","name":"per_page","required":false,"schema":{"default":10,"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectList"}}},"description":"Vendor project list"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"VendorNotFound - this is not a vendor user account"}},"summary":"Get a list of user/vendor projects","tags":["Project"],"x-cli-cmd-group":"projects"},"x-internal":true},"/{userId}/reject":{"post":{"operationId":"rejectVendorApplication","parameters":[{"description":"User ID","example":1,"in":"path","name":"userId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Vendor application of this user is rejected."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"security":[{"mwoAuth":["privileged"]}],"tags":["User"],"x-cli-cmd-group":"users"},"x-internal":true},"/{userId}/resend-email-confirmation":{"post":{"operationId":"sendUserEmailConfirmation","parameters":[{"description":"User ID","example":1,"in":"path","name":"userId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OperationStatus"},{"properties":{"status":{"default":"success","enum":["success"],"type":"string"}},"type":"object"}]}}},"description":"confirmation email has been sent"},"202":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OperationStatus"},{"properties":{"status":{"default":"already_confirmed","enum":["already_confirmed"],"type":"string"}},"type":"object"}]}}},"description":"status is `already_confirmed` when user has already confirmed their email address."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"VendorNotFound - this is not a vendor user account"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"security":[{"mwoAuth":["privileged"]}],"summary":"Sends email confirmation email for a user","tags":["User"],"x-cli-cmd-group":"users"},"x-internal":true},"/{userId}/responsivity":{"get":{"operationId":"getUserResponsivity","parameters":[{"description":"User ID","example":1,"in":"path","name":"userId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Period for calcualtion.","in":"query","name":"period","schema":{"default":"monthly","enum":["monthly","weekly"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsivityList"}}},"description":"Vendor responsivity stats"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"VendorNotFound - this is not a vendor user account"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"security":[{"mwoAuth":["privileged"]}],"summary":"Returns a user's vendor responsivity stats","tags":["User"],"x-cli-cmd-group":"users"},"x-internal":true},"/{userId}/stats":{"get":{"operationId":"getUserStats","parameters":[{"description":"User ID","example":1,"in":"path","name":"userId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Stats"}}},"description":"User stats for client and vendors"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"security":[{"mwoAuth":["privileged"]}],"summary":"Returns a user's client and vendor statistics. This used to be called \"summary\" (\\@deprecated).","tags":["User"],"x-cli-cmd-group":"users"},"x-internal":true},"/{userId}/stats/popular-pairs":{"get":{"operationId":"getUserPopularPairs","parameters":[{"description":"User ID","example":1,"in":"path","name":"userId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PopularLanguagePairs"}}},"description":"User's most ordered language pairs"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"security":[{"mwoAuth":["privileged"]}],"summary":"Returns the language pairs that the user has ordered most.","tags":["User"],"x-cli-cmd-group":"users"},"x-internal":true},"/{userId}/stats/projects":{"get":{"operationId":"getUserProjectStats","parameters":[{"description":"User ID","example":1,"in":"path","name":"userId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientProjectStats"}}},"description":"User stats for client and vendors"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"security":[{"mwoAuth":["privileged"]}],"summary":"Returns a user's project statistics.","tags":["User"],"x-cli-cmd-group":"users"},"x-internal":true},"/{userId}/suspend":{"post":{"operationId":"suspendUser","parameters":[{"description":"User ID","example":1,"in":"path","name":"userId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuspendUserRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Suspended user account."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"security":[{"mwoAuth":["privileged"]}],"tags":["User"],"x-cli-cmd-group":"users"},"x-internal":true},"/{userId}/unfreeze-account":{"post":{"operationId":"unfreezeUserAccount","parameters":[{"description":"User ID","example":1,"in":"path","name":"userId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Successful operation"},"304":{"description":"Account is already unfrozen for notifications"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"summary":"Unfreeze requester account for project notifications","tags":["User"],"x-cli-cmd-group":"users"},"x-internal":true},"/{userId}/user-groups":{"get":{"operationId":"getThisUserGroups","parameters":[{"description":"User ID","example":1,"in":"path","name":"userId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroupList"}}},"description":"List of user groups"}},"summary":"Returns a list of user groups that this user belongs to.","tags":["User"],"x-cli-cmd-group":"users"},"post":{"operationId":"updateUserGroup","parameters":[{"description":"User ID","example":1,"in":"path","name":"userId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActiveWidget"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroupList"}}},"description":"List of user groups"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"InvalidParameter"}},"security":[{"mwoAuth":["privileged"]}],"tags":["User"],"x-cli-cmd-group":"users"},"x-internal":true}},"components":{"schemas":{"AccountGlossaryUploadRequest":{"properties":{"glossary":{"description":"Glossary file. Currently supported formats: .xlsx, .tbx","format":"binary","type":"string"}},"required":["glossary"],"type":"object"},"AccountStyleGuideUploadRequest":{"properties":{"styleguide":{"description":"Style guide file. Currently supported formats: .pdf, .docx, .txt","format":"binary","type":"string"}},"required":["styleguide"],"type":"object"},"ActiveWidget":{"properties":{"admin_mode":{"description":"Is the Active Widget in admin mode? This changes a couple of behaviors in the widget to configure some rules like elements, sections, pages, etc.","type":"boolean"},"allow_hash_in_url":{"description":"When true, hash params are included in filenames. When false, params are ignored.","type":"boolean"},"allow_query_in_url":{"description":"When true, query params are included in filenames. When false, params are ignored.","type":"boolean"},"auto_detect_source_language":{"description":"When true, we will ignore the source language of your project and try to automatically detect the source language of the given content. This is especially useful in environments with unpredictable source contents, such as a chat environment.","type":"boolean"},"created_at":{"description":"the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z","format":"date-time","type":"string"},"debug_mode":{"description":"When true, Active ecosystem will print debug-level logs from all Active modules.","type":"boolean"},"elements":{"description":"Continuous project exclusive elements and rules","type":"string"},"follow_user":{"description":"Specify whether we should follow the user around in your website and automatically translate pages.","type":"boolean"},"force_cache_refresh_interval":{"description":"Determines whether to force-refresh local browser cache of your translations in certain period of times, no matter if there is a new activity in the project.","type":"boolean"},"hit_backend_for_existing":{"description":"When true, Active ecosystem will collect all strings on TMS no matter if the translation is present in the cache.","type":"boolean"},"id":{"format":"int64","type":"integer"},"language_mappings":{"description":"Continuous project language mappings","type":"string"},"live":{"description":"Whether ActiveJS should be considered live in an embedded site. Use `false` if you are still testing Active. Go to your Active dashboard and follow links to your website to actually test Active.","type":"boolean"},"modify_links":{"description":"We can automatically localize the same-domain URLs in your page. The way we localize the URL depends on urlMode configuration. We can either add/update the locale query parameter, or add/update the path of the URL.","type":"boolean"},"name":{"type":"string"},"optimize_per_page":{"description":"When true, Active ecosystem will optimize the script and data flows per page, rather than per project. This decreases the bandwidth usage per script, but makes translation publishing more complex and script serving per-page.","type":"boolean"},"pages":{"description":"Continuous project page rules","type":"string"},"path_regex":{"description":"Custom regex for path-type URL mode.","type":"string"},"position":{"description":"Options are \"bottom-left\", \"bottom-right\", \"in-place\"","type":"string"},"query_name":{"default":"locale","description":"Query parameter name to be used with query-type URL mode. Default is 'locale'.","type":"string"},"reboot_on_url_change":{"description":"When true, Active ecosystem reboots itself when url changes.","type":"boolean"},"restricted_domains":{"description":"JSON string for a list of domains that this widget's API interactions are limited to.","type":"string"},"sections":{"description":"Continuous project section rules","type":"string"},"test_mode":{"description":"Is the Active Widget in test mode? This changes a couple behaviors in the widget to make it easier for you to test and develop your Active integration.","type":"boolean"},"theme":{"description":"\\\"light\\\", \\\"dark\\\" OR custom JSON.","type":"string"},"token":{"description":"Token that you should use when you are using this widget on your website.","type":"string"},"url_change_mode":{"description":"When a user changes locale (or when we automatically detect and change it for them), we will change the URL of the page they are in. We can do this by actually redirecting the user to the new page, or by simply changing the URL in the address bar via browser's History API. When NULL, we won't apply any URL changes.","type":"string"},"url_mode":{"description":"When a user changes locale (or when we automatically detect and change it for them), we will change the URL of the page they are in. We can either change the path of the URL to prefix it with the locale code, or we can add a query parameter to the URL. We also use this mode to detect the locale for the current page when a user directly loads a page. When NULL, locale detection from URL will be disabled (even then, if the user has selected a locale manually, and followUser is enabled, we will still automatically translate the page in user's locale.","type":"string"},"use_cache":{"description":"Should we make use of local browser cache for your visitors? We will refresh the cache when Active JS detects new activity in your project.","type":"boolean"},"use_dummy_translations":{"description":"When enabled, we will translate your website with dummy content, rather than actually using MT/TM.","type":"boolean"},"variables":{"description":"Continuous project variable definitions","type":"string"}},"type":"object"},"ActiveWidgetList":{"properties":{"meta":{"$ref":"#/components/schemas/PagingMeta"},"widgets":{"items":{"$ref":"#/components/schemas/ActiveWidget"},"type":"array"}},"type":"object"},"Activity":{"properties":{"activity_at":{"description":"Unix epoch time","format":"int64","type":"integer"},"id":{"format":"int64","type":"integer"},"links":{"$ref":"#/components/schemas/ActivityLinks"},"source_text":{"description":"Source text","type":"string"},"target_text":{"description":"Target text of the activity, which is actually the translation of the source text.","type":"string"},"translator":{"description":"Unique identifier of the translator/proofreader of this activity.","format":"int64","type":"integer"},"type":{"description":"Currently there are two available activity types; 'translated', 'proofread'.","enum":["translated","proofread"],"type":"string"}},"type":"object"},"ActivityLinks":{"allOf":[{"$ref":"#/components/schemas/LinksMeta"},{"properties":{"comments":{"$ref":"#/components/schemas/Href"},"project":{"$ref":"#/components/schemas/Href"}},"type":"object"}]},"ActivityList":{"properties":{"activities":{"items":{"$ref":"#/components/schemas/Activity"},"type":"array"},"meta":{"$ref":"#/components/schemas/PagingMeta"}},"type":"object"},"AddOrUpdateDocumentRequest":{"properties":{"document":{"$ref":"#/components/schemas/FileAsData"}},"type":"object"},"Address":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"phone":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"},"zip":{"type":"string"}},"type":"object"},"AnalyticsCollection":{"properties":{"anonymousId":{"type":"string"},"properties":{"additionalProperties":{"type":"string"},"type":"object"},"sessionId":{"type":"string"},"type":{"type":"string"},"userId":{"type":"string"}},"type":"object"},"AnalyticsToken":{"properties":{"jwt":{"type":"string"}},"type":"object"},"AsyncOperationStatus":{"properties":{"duration":{"description":"operation duration in milliseconds","format":"int64","type":"integer"},"key":{"type":"string"},"message":{"type":"object"},"status":{"$ref":"#/components/schemas/AsyncOperationStatusEnum"}},"type":"object"},"AsyncOperationStatusEnum":{"default":"sent","enum":["sent","started","completed","failed"],"type":"string"},"AvailableVendorsFilter":{"properties":{"corporateId":{"description":"Corporate account ID to filter for vendor authorization","type":"number"},"manualWorkPermission":{"default":0,"description":"Filter vendors for manual work permission","type":"boolean"},"sourceLanguage":{"description":"Source language code","type":"string"},"targetLanguages":{"description":"List of target language codes.","items":{"type":"string"},"type":"array"},"types":{"description":"List of vendor types","items":{"enum":["translator","proofreader","both"],"type":"string"},"type":"array"}},"type":"object"},"BillingAddress":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"name":{"default":"","description":"addressing name, such as company name. used in billing address.","type":"string"}},"type":"object"}]},"BlogArticle":{"properties":{"announcement_type":{"enum":["article","case","famous-translators","sales"],"type":"string"},"author":{"type":"string"},"content":{"description":"Article content","type":"string"},"created_at":{"description":"the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z","format":"date-time","type":"string"},"excerpt":{"description":"Article excerpt","type":"string"},"id":{"format":"int64","type":"integer"},"language":{"description":"language code","type":"string"},"links":{"$ref":"#/components/schemas/BlogArticleLinks"},"slug":{"type":"string"},"title":{"type":"string"},"topic":{"type":"string"}},"type":"object"},"BlogArticleLinks":{"allOf":[{"$ref":"#/components/schemas/LinksMeta"},{"properties":{"android":{"$ref":"#/components/schemas/Href"},"header_image":{"$ref":"#/components/schemas/Href"},"ios":{"$ref":"#/components/schemas/Href"},"web":{"$ref":"#/components/schemas/Href"}},"type":"object"}]},"BlogArticleList":{"properties":{"articles":{"items":{"$ref":"#/components/schemas/BlogArticle"},"type":"array"},"meta":{"$ref":"#/components/schemas/PagingMeta"}},"type":"object"},"CM":{"properties":{"user_id":{"format":"int64","type":"integer"}},"type":"object"},"CallbackResult":{"properties":{"data":{"$ref":"#/components/schemas/Project"},"result":{"description":"Callback response returned from `url`.","type":"string"},"type":{"$ref":"#/components/schemas/ProjectStatus"},"url":{"description":"The URL that received the callback.","type":"string"}},"type":"object"},"CancelProjectRequest":{"properties":{"reason":{"description":"Cancellation reason","type":"string"}},"type":"object"},"ClientProfile":{"properties":{"account_creation_date":{"description":"the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z","format":"date-time","type":"string"},"client_project_count":{"description":"total project count that this client sent","type":"number"},"corporate":{"description":"corporate name","type":"string"},"corporate_id":{"description":"corporate id","type":"number"},"corporate_user_count":{"description":"total user count in a corporation","type":"number"},"frequent_file_extension":{"description":"the file extension for the files that usually this client sent","type":"string"},"frequent_language_pairs":{"description":"frequent language pairs","items":{"type":"string"},"type":"array"},"full_name":{"description":"full name of the client","type":"string"},"growth":{"description":"The answer for the question \"Is there any growth for this corporate's spending\". The values can be true, false or null if the corporate is oour client for less than 6 months","type":"boolean"},"is_complex":{"description":"the answer for the question \"Is this client usually sent complex projects?\"","type":"boolean"},"last_12_months_spending":{"description":"corporate's spending in twelve months","format":"float","type":"number"},"last_project":{"description":"the quote number for the last project of this client","type":"number"},"last_project_time":{"description":"the creation date of the last project that is sent by this client","format":"date-time","type":"string"},"last_proofreaders":{"description":"list of prooofreaders for the target languages of last project","items":{"$ref":"#/components/schemas/ProofreaderWithLanguage"},"type":"array"},"notes":{"description":"notes that is submited for this client and/or with her projects","items":{"type":"string"},"type":"array"},"nps":{"description":"net promoter score info for this client","properties":{"average":{"description":"information for all nps survey that this client completed","properties":{"completed_surveys_count":{"description":"total number of completed survey count by this client","type":"number"},"score":{"description":"average score for all coompleted surveys","format":"float","type":"number"}},"type":"object"},"last":{"description":"last survey info","properties":{"completion_date":{"description":"last surveys completion date","format":"date-time","type":"string"},"score":{"description":"score that the client gave us","type":"number"}},"type":"object"}},"type":"object"},"user_rank_in_project_count":{"description":"rank of the user in all corporate users for project count. If the user is the most active user foor sending projects her rank is 1","type":"number"},"user_rank_in_spending":{"description":"rank of the user in all corporate users for total spending. If the user is the most active user for spending her rank is 1","type":"number"}},"type":"object"},"ClientProjectStat":{"properties":{"languages":{"items":{"type":"string"},"type":"array"},"month":{"type":"string"},"number_of_projects":{"format":"int64","type":"integer"},"total_spending":{"format":"float","type":"number"},"week":{"type":"string"}},"type":"object"},"ClientProjectStats":{"properties":{"stats":{"items":{"$ref":"#/components/schemas/ClientProjectStat"},"type":"array"}},"type":"object"},"ClientStats":{"properties":{"document_count":{"format":"int64","type":"integer"},"nps":{"format":"float","type":"number"},"started_project_count":{"format":"int64","type":"integer"},"total_discounted":{"$ref":"#/components/schemas/Monetary"},"total_project_count":{"format":"int64","type":"integer"},"total_spending":{"format":"float","type":"number"},"translator_count":{"format":"int64","type":"integer"}},"type":"object"},"ClientStringStats":{"properties":{"language_counts":{"items":{"$ref":"#/components/schemas/LanguageStringStat"},"type":"array"},"total_project_strings_count":{"format":"int64","type":"integer"},"total_tm_strings_count":{"format":"int64","type":"integer"}},"type":"object"},"ClientStringTranslation":{"properties":{"content":{"type":"string"},"last_changed":{"description":"the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z","format":"date-time","type":"string"},"resource":{"type":"string"},"resource_id":{"type":"string"},"state":{"enum":["Translated","Approved"],"type":"string"},"target_language":{"type":"string"}},"type":"object"},"ClientStringWithTranslations":{"properties":{"content":{"type":"string"},"language":{"type":"string"},"last_changed":{"description":"the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z","format":"date-time","type":"string"},"translations":{"items":{"$ref":"#/components/schemas/ClientStringTranslation"},"type":"array"}},"type":"object"},"ClientStrings":{"properties":{"meta":{"$ref":"#/components/schemas/PagingMeta"},"strings":{"items":{"$ref":"#/components/schemas/ClientStringWithTranslations"},"type":"array"}},"type":"object"},"Comment":{"properties":{"comment":{"description":"Comment text.","type":"string"},"commented_at":{"description":"Unix epoch time","format":"int64","type":"integer"},"id":{"format":"int64","type":"integer"},"links":{"$ref":"#/components/schemas/CommentLinks"}},"required":["comment"],"type":"object"},"CommentLinks":{"allOf":[{"$ref":"#/components/schemas/LinksMeta"},{"properties":{"activity":{"$ref":"#/components/schemas/Href","description":"Link to the activity to which this comment was submitted."},"project":{"$ref":"#/components/schemas/Href"}},"type":"object"}]},"CommentList":{"properties":{"activities":{"items":{"$ref":"#/components/schemas/Comment"},"type":"array"},"meta":{"$ref":"#/components/schemas/PagingMeta"}},"type":"object"},"Commission":{"properties":{"amount":{"$ref":"#/components/schemas/Monetary"},"date":{"description":"the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z","format":"date-time","type":"string"},"project":{"$ref":"#/components/schemas/Project"},"status":{"enum":["completed","unclaimed","failed","sent","waiting","waiting_invoice"],"type":"string"}},"type":"object"},"CommissionList":{"properties":{"commissions":{"items":{"$ref":"#/components/schemas/Commission"},"type":"array"},"meta":{"$ref":"#/components/schemas/PagingMeta"}},"type":"object"},"CommissionStats":{"properties":{"balance":{"$ref":"#/components/schemas/Monetary"},"paid":{"$ref":"#/components/schemas/Monetary"},"quote_total":{"$ref":"#/components/schemas/Monetary"},"total":{"$ref":"#/components/schemas/Monetary"}},"type":"object"},"ContinuousProject":{"properties":{"analytics_enabled":{"description":"Should we collect analytics data from Active for this continuous project?","type":"boolean"},"auto_start_postedit":{"description":"Immediately start post-editing project for translation requests that are applied MT.","type":"boolean"},"created_at":{"description":"the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z","format":"date-time","type":"string"},"id":{"format":"int64","type":"integer"},"is_enabled":{"type":"boolean"},"last_activity_at":{"description":"the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z","format":"date-time","type":"string"},"links":{"$ref":"#/components/schemas/ContinuousProjectLinks"},"mt_enabled":{"description":"Immediately apply MT on translation requests if they are missing from TM.","type":"boolean"},"mt_engine":{"description":"One of \"MOTAWORD\", \"GOOGLE\", \"AMAZON\", \"MS\". Default is \"MOTAWORD\".","type":"string"},"name":{"type":"string"},"postedit_enabled":{"description":"Get an instant quote for translation requests that are applied MT.","type":"boolean"},"source_language":{"type":"string"},"status":{"description":"One of \"a => ACTIVE\", \"i => INACTIVE\", \"d => DELETED\", \"c => SCHEDULED CANCELLATION\", \"p => SCHEDULED CHANGE\"","type":"string"},"subscription":{"$ref":"#/components/schemas/Subscription"},"target_languages":{"items":{"type":"string"},"type":"array"},"type":{"description":"Continuous project type. We currently have only 2 types, NULL and \"active\".","type":"string"},"word_count":{"format":"int64","type":"integer"}},"type":"object"},"ContinuousProjectCache":{"description":"Continuous project cache for translations per target language.","properties":{"meta":{"$ref":"#/components/schemas/PagingMeta"},"translations":{"additionalProperties":{"$ref":"#/components/schemas/ContinuousProjectLanguageCache"},"type":"object"}},"type":"object"},"ContinuousProjectCachedStrings":{"additionalProperties":{"type":"string"},"description":"source > target map of strings for translations","type":"object"},"ContinuousProjectCosts":{"properties":{"mt":{"$ref":"#/components/schemas/Monetary"},"post_edit":{"$ref":"#/components/schemas/Monetary"},"saved":{"$ref":"#/components/schemas/Monetary"},"total":{"$ref":"#/components/schemas/Monetary"}},"type":"object"},"ContinuousProjectDocument":{"properties":{"billed_word_count":{"format":"int64","type":"integer"},"id":{"type":"string"},"links":{"$ref":"#/components/schemas/DocumentLinks"},"name":{"type":"string"},"post_edit_enabled":{"type":"boolean"},"project_id":{"type":"string"},"source_language":{"type":"string"},"target_languages":{"items":{"type":"string"},"type":"array"},"word_count":{"format":"int64","type":"integer"}},"type":"object"},"ContinuousProjectDocumentList":{"properties":{"documents":{"items":{"$ref":"#/components/schemas/ContinuousProjectDocument"},"type":"array"},"meta":{"$ref":"#/components/schemas/PagingMeta"}},"type":"object"},"ContinuousProjectDocumentProgressBody":{"properties":{"documentName":{"type":"string"},"filterByLanguage":{"type":"string"}},"type":"object"},"ContinuousProjectDocumentStringsBody":{"properties":{"documentName":{"type":"string"}},"type":"object"},"ContinuousProjectInvoices":{"properties":{"invoices":{"items":{"$ref":"#/components/schemas/Invoice"},"type":"array"}},"type":"object"},"ContinuousProjectLanguage":{"properties":{"code":{"type":"string"},"is_enabled":{"type":"boolean"}},"type":"object"},"ContinuousProjectLanguageCache":{"description":"TM, MT and Nonparsed cache list for translations","properties":{"mt":{"$ref":"#/components/schemas/ContinuousProjectCachedStrings"},"nonparsed":{"$ref":"#/components/schemas/ContinuousProjectCachedStrings"},"tm":{"$ref":"#/components/schemas/ContinuousProjectCachedStrings"}},"type":"object"},"ContinuousProjectLinks":{"allOf":[{"$ref":"#/components/schemas/LinksMeta"},{"properties":{"editors":{"additionalProperties":{"$ref":"#/components/schemas/Href","description":"MotaWord editor link for this file, in this language code."},"type":"object"}},"type":"object"}]},"ContinuousProjectProgress":{"properties":{"costs":{"$ref":"#/components/schemas/ContinuousProjectCosts"},"progress":{"$ref":"#/components/schemas/Progress"},"word_counts":{"$ref":"#/components/schemas/ContinuousProjectWordCounts"}},"type":"object"},"ContinuousProjectUpdateContent":{"properties":{"analytics_enabled":{"type":"boolean"},"auto_start_postedit":{"type":"boolean"},"is_enabled":{"type":"boolean"},"languages":{"items":{"$ref":"#/components/schemas/ContinuousProjectLanguage"},"type":"array"},"mt_enabled":{"type":"boolean"},"name":{"type":"string"},"postedit_enabled":{"type":"boolean"}},"type":"object"},"ContinuousProjectWordCounts":{"properties":{"mt":{"format":"int64","type":"integer"},"post_edit":{"format":"int64","type":"integer"},"total":{"format":"int64","type":"integer"}},"type":"object"},"ContinuousProjectsList":{"properties":{"meta":{"$ref":"#/components/schemas/PagingMeta"},"projects":{"items":{"$ref":"#/components/schemas/ContinuousProject"},"type":"array"}},"type":"object"},"CorporateAccount":{"properties":{"billing":{"$ref":"#/components/schemas/BillingAddress"},"domain":{"type":"string"},"email":{"type":"string"},"id":{"format":"int64","type":"integer"},"logo":{"type":"string"},"name":{"type":"string"},"web_site":{"deprecated":true,"description":"Deprecated, use `domain`.","type":"string"}},"type":"object"},"CreditCard":{"properties":{"bin":{"type":"string"},"id":{"format":"int64","type":"integer"},"is_default":{"type":"boolean"},"payment_code":{"type":"string"}},"type":"object"},"DeliveryPredictionInLanguage":{"properties":{"language":{"type":"string"},"late":{"description":"true for late, false for on-time delivery","type":"boolean"},"probability":{"format":"float","type":"number"}},"type":"object"},"DeliveryPredictionPayload":{"properties":{"projectId":{"format":"int64","type":"integer"}},"type":"object"},"DeliveryPredictionResponse":{"properties":{"result":{"items":{"$ref":"#/components/schemas/DeliveryPredictionInLanguage"},"type":"array"}},"type":"object"},"DeprecatedStringTranslationContent":{"properties":{"contents":{"items":{"type":"string"},"type":"array"},"source_language":{"type":"string"},"target_languages":{"items":{"type":"string"},"type":"array"}},"type":"object"},"Document":{"properties":{"file_type":{"description":"Extension of the file","type":"string"},"has_custom_package":{"type":"boolean"},"id":{"format":"int64","type":"integer"},"links":{"$ref":"#/components/schemas/DocumentLinks"},"manual_files":{"items":{"$ref":"#/components/schemas/ManualFile"},"type":"array"},"name":{"type":"string"},"project_id":{"format":"int64","type":"integer"},"review_in_manual_editor":{"type":"boolean"},"scheme":{"type":"object"},"search_score":{"format":"float","type":"number"},"source_language":{"type":"string"},"subject":{"type":"string"},"target_languages":{"items":{"type":"string"},"type":"array"},"uploaded_at":{"description":"Unix epoch time","format":"int64","type":"integer"},"word_count":{"format":"int64","type":"integer"}},"type":"object"},"DocumentInSearch":{"allOf":[{"$ref":"#/components/schemas/Document"},{"properties":{"search_result_reason":{"type":"string"}},"type":"object"}]},"DocumentLinks":{"allOf":[{"$ref":"#/components/schemas/LinksMeta"},{"properties":{"admins":{"additionalProperties":{"$ref":"#/components/schemas/Href","description":"MotaWord admin link for this file, in this language code."},"type":"object"},"download":{"$ref":"#/components/schemas/Href"},"editors":{"additionalProperties":{"$ref":"#/components/schemas/Href","description":"MotaWord editor link for this file, in this language code."},"type":"object"},"preview-box":{"$ref":"#/components/schemas/Href","description":"Box.com URL to preview this document. This URL is temporary. You need to re-fetch the file to refresh the Box.com preview URL. Available for documents and style guides."},"preview-pdf":{"$ref":"#/components/schemas/Href","description":"This is our fallback preview URL, providing a PDF file. Use this file to embed in your PDF viewer. Available for documents and style guides."},"preview-pdf-viewer":{"$ref":"#/components/schemas/Href","description":"This is another version of preview-pdf, this time pointing to a preview viewer page on front application. This page requires authentication and comes with its own PDF viewer."},"progress":{"$ref":"#/components/schemas/Href","description":"Progress endpoint URL for this file"},"project":{"$ref":"#/components/schemas/Href"},"strings":{"$ref":"#/components/schemas/Href","description":"Strings endpoint URL for this file"},"thumbnail":{"$ref":"#/components/schemas/Href","description":"Thumbnail preview URL of the document. If doc has a page structure, this is probably only the first page."}},"type":"object"}]},"DocumentList":{"properties":{"documents":{"items":{"$ref":"#/components/schemas/Document"},"type":"array"},"meta":{"$ref":"#/components/schemas/PagingMeta"}},"type":"object"},"DocumentSubjects":{"properties":{"name":{"type":"string"}},"type":"object"},"DocumentUpdates":{"properties":{"documents[]":{"description":"You can add as many files as you want in documents[] parameter.","items":{"format":"binary","type":"string"},"type":"array"},"schemes[]":{"description":"JSON string. If your documents have a scheme, as in cases of CSV files, use the same array index keys for `schemes` parameter to specify their schemes. See `Document Schemes` title in the API documentation.","type":"string"},"source-links[]":{"description":"When provided, we will download the files from these URLs, in addition to files provded in `documents` parameter and then save as source documents","items":{"$ref":"#/components/schemas/LinkedSourceDocument"},"type":"array"}},"type":"object"},"DocumentUploadRequest":{"properties":{"documents":{"description":"Single file data. The name is plural to provide a consistent naming convention.","format":"binary","type":"string"},"schemes":{"description":"JSON string. If your documents have a scheme, as in cases of CSV files, use the same array index keys for `schemes` parameter to specify their schemes. See `Document Schemes` title in the API documentation.","type":"string"},"source-link":{"$ref":"#/components/schemas/LinkedSourceDocument"}}},"Earning":{"properties":{"amount":{"format":"float","type":"number"},"currency":{"default":"usd","type":"string"},"due_date":{"description":"the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z","format":"date-time","type":"string"},"status":{"enum":["paid","pending","failed"],"type":"string"},"words":{"format":"int64","type":"integer"},"words_approved":{"format":"int64","type":"integer"},"words_translated":{"format":"int64","type":"integer"}},"type":"object"},"EarningWithTQS":{"allOf":[{"$ref":"#/components/schemas/Earning"},{"$ref":"#/components/schemas/ProjectTQS"},{"properties":{"project_id":{"format":"int64","type":"integer"}},"type":"object"}]},"Earnings":{"properties":{"completed":{"items":{"$ref":"#/components/schemas/EarningWithTQS"},"type":"array"},"ongoing":{"items":{"$ref":"#/components/schemas/EarningWithTQS"},"type":"array"},"total":{"format":"float","type":"number"}},"type":"object"},"Email":{"properties":{"email":{"type":"string"}},"type":"object"},"Error":{"properties":{"code":{"type":"string"},"help":{"type":"string"},"http_code":{"format":"int32","type":"integer"},"message":{"type":"string"}},"type":"object"},"FileAsData":{"properties":{"data":{"description":"Base64 encoded contents of your file.","format":"byte","type":"string"},"name":{"description":"Name of your file","type":"string"}},"type":"object"},"FileNeedsVendor":{"properties":{"fileId":{"format":"int64","type":"integer"},"guid":{"type":"string"},"projectId":{"format":"int64","type":"integer"},"reason":{"type":"string"},"targetLanguage":{"items":{"type":"string"},"type":"array"},"taskType":{"items":{"type":"string"},"type":"array"}},"type":"object"},"FilterContents":{"properties":{"budget_codes":{"items":{"type":"string"},"type":"array"},"categories":{"items":{"type":"string"},"type":"array"},"clients":{"items":{"$ref":"#/components/schemas/SimpleModel"},"type":"array"},"documents":{"items":{"$ref":"#/components/schemas/SimpleModel"},"type":"array"},"projects":{"items":{"$ref":"#/components/schemas/SimpleModel"},"type":"array"},"severities":{"items":{"type":"string"},"type":"array"},"source_languages":{"items":{"type":"string"},"type":"array"},"subjects":{"items":{"type":"string"},"type":"array"},"target_languages":{"items":{"type":"string"},"type":"array"},"vendors":{"items":{"$ref":"#/components/schemas/SimpleModel"},"type":"array"}},"type":"object"},"FilterDates":{"properties":{"date_from":{"description":"the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z","format":"date-time","type":"string"},"date_to":{"description":"the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z","format":"date-time","type":"string"}},"type":"object"},"FilterVendorRequest":{"properties":{"clients":{"items":{"type":"integer"},"type":"array"},"communication_channel":{"items":{"type":"string"},"type":"array"},"corporate_ids_for_auth":{"items":{"type":"integer"},"type":"array"},"corporates":{"items":{"type":"integer"},"type":"array"},"country":{"items":{"type":"string"},"type":"array"},"created_at":{"type":"string"},"current_services":{"items":{"type":"string"},"type":"array"},"daily_proofreading_capacity":{"type":"integer"},"daily_translation_capacity":{"type":"integer"},"destination_languages":{"items":{"type":"integer"},"type":"array"},"dtp_software":{"items":{"type":"string"},"type":"array"},"email_address":{"type":"string"},"experience":{"items":{"type":"string"},"type":"array"},"first_name":{"type":"string"},"id":{"items":{"type":"integer"},"type":"array"},"is_certified_translator":{"type":"boolean"},"is_sworn_translator":{"type":"boolean"},"language_pairs":{"items":{"items":{"type":"integer"},"type":"array"},"type":"array"},"last_name":{"type":"string"},"last_online":{"type":"string"},"last_worked":{"type":"string"},"memoq":{"type":"integer"},"memsource":{"type":"integer"},"min_tqs":{"type":"number"},"omegat":{"type":"integer"},"project_count":{"type":"integer"},"proofreader_experience":{"type":"integer"},"provides_creative_writing_service":{"type":"boolean"},"provides_postedit_service":{"type":"boolean"},"quote_file_subjects":{"items":{"type":"string"},"type":"array"},"reference":{"type":"string"},"sdl_trados":{"type":"integer"},"search":{"type":"string"},"skype_id":{"type":"string"},"smartcat":{"type":"integer"},"smartling":{"type":"integer"},"source_languages":{"items":{"type":"integer"},"type":"array"},"specialization":{"items":{"type":"string"},"type":"array"},"status":{"items":{"type":"string"},"type":"array"},"subtitle_edit":{"type":"integer"},"subtitle_workshop":{"type":"integer"},"translator_association":{"type":"string"},"transsuite_2000":{"type":"integer"},"user_working_timezone":{"items":{"type":"string"},"type":"array"},"vendor_profile_lsp":{"type":"string"},"vendor_tags":{"items":{"type":"string"},"type":"array"},"vendor_type":{"items":{"type":"string"},"type":"array"},"vendor_working_timezone":{"items":{"type":"string"},"type":"array"},"word_count":{"type":"integer"},"wordbee":{"type":"integer"},"wordfast":{"type":"integer"},"work_type":{"type":"string"},"work_with":{"type":"string"},"working_as":{"items":{"type":"string"},"type":"array"},"xbench":{"type":"integer"},"xtm":{"type":"integer"}},"type":"object"},"Formats":{"properties":{"documents":{"properties":{"extensions":{"items":{"type":"string"},"type":"array"},"mimes":{"items":{"type":"string"},"type":"array"}},"type":"object"},"glossaries":{"properties":{"extensions":{"items":{"type":"string"},"type":"array"}},"type":"object"},"styleguides":{"properties":{"extensions":{"items":{"type":"string"},"type":"array"}},"type":"object"}},"type":"object"},"GetQuotesForDocumentsBody":{"properties":{"files":{"items":{"format":"int64","type":"integer"},"type":"array"}},"type":"object"},"GetQuotesForLanguagesBody":{"properties":{"languages":{"items":{"type":"string"},"type":"array"}},"type":"object"},"Glossary":{"properties":{"id":{"format":"int64","type":"integer"},"links":{"$ref":"#/components/schemas/DocumentLinks"},"name":{"type":"string"},"uploaded_at":{"description":"Unix epoch time","format":"int64","type":"integer"}},"type":"object"},"GlossaryList":{"properties":{"glossaries":{"items":{"$ref":"#/components/schemas/Glossary"},"type":"array"},"meta":{"$ref":"#/components/schemas/PagingMeta"}},"type":"object"},"GlossaryUploadRequest":{"properties":{"glossaries":{"description":"You can only add one glossary, even though the name suggests multiple glossaries. This may be updated in the future to support multiple glossaries.","format":"binary","type":"string"}},"required":["glossaries"],"type":"object"},"Href":{"properties":{"href":{"type":"string"}},"type":"object"},"InstantContentsTranslationResult":{"properties":{"results":{"additionalProperties":{"type":"string"},"description":"a map of source string > translated string.","type":"object"}},"type":"object"},"InstantFilesTranslationResult":{"properties":{"results":{"additionalProperties":{"format":"byte","type":"string"},"description":"a map of source file name > base64-encoded translated file.","type":"object"}},"type":"object"},"InstantTranslationFilter":{"properties":{"skipMt":{"items":{"type":"string"},"type":"array"},"skipPostEdit":{"items":{"type":"string"},"type":"array"}},"type":"object"},"InstantTranslationRequest":{"properties":{"contents":{"description":"Simple list of strings to be translated. You can also choose to upload files instead of strings.","items":{"type":"string"},"type":"array"},"documents":{"description":"You can add as many files as you want in documents parameter.","items":{"$ref":"#/components/schemas/FileAsData"},"type":"array"},"filters":{"$ref":"#/components/schemas/InstantTranslationFilter"},"meta":{"description":"Free-form meta data to attach to your instant translation request. This can be used in statistics and analytical dashboards.","type":"object"}},"type":"object"},"InstantTranslationResult":{"oneOf":[{"$ref":"#/components/schemas/InstantContentsTranslationResult"},{"$ref":"#/components/schemas/InstantFilesTranslationResult"}]},"IntegrationsToken":{"properties":{"token":{"type":"string"}}},"InvitedVendor":{"properties":{"action":{"description":"Action to be taken","type":"string"},"email_open_rate":{"description":"Email opening rate of the vendor","type":"number"},"is_entered":{"description":"Did the vendor enter the given project","type":"boolean"},"is_get_paid":{"description":"Is vendor get ever paid?","type":"boolean"},"is_worked":{"description":"Did the vendor work on the given project","type":"boolean"},"is_worked_in_any_project":{"description":"Vendors working status in any project","type":"boolean"},"last_project_date":{"description":"Last project date","format":"date","type":"string"},"project_status_when_interacted":{"description":"Project translation percentage when interacted with the vendor","type":"number"},"registration_date":{"description":"Registration date","format":"date","type":"string"},"responsiveness":{"description":"Responsiveness of the vendor","type":"number"},"user_id":{"description":"Id in the Users","format":"int64","type":"number"},"vendor_id":{"description":"Id in the Vendors","format":"int64","type":"number"},"vendor_name":{"description":"The name of the vendor","type":"string"},"vendor_type":{"description":"Type of the vendor in the given project namely translator or proofreader","type":"string"}},"type":"object"},"InvitedVendorsByLanguage":{"properties":{"invited_vendors":{"description":"Invited vendors for this target language","items":{"$ref":"#/components/schemas/InvitedVendor"},"type":"array"},"target_language":{"description":"Target Language that the vendors invited for","type":"string"}},"type":"object"},"Invoice":{"properties":{"amount":{"description":"Monetary amount","format":"float","type":"number"},"base_amount":{"description":"Monetary amount","format":"float","type":"number"},"base_currency":{"default":"usd","type":"string"},"billing":{"$ref":"#/components/schemas/BillingAddress"},"currency":{"default":"usd","type":"string"},"id":{"format":"int64","type":"integer"},"invoice_no":{"format":"int64","type":"integer"},"invoiced_at":{"description":"the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z","format":"date-time","type":"string"},"links":{"$ref":"#/components/schemas/InvoiceLinks"},"status":{"type":"string"}},"type":"object"},"InvoiceLinks":{"allOf":[{"$ref":"#/components/schemas/LinksMeta"},{"properties":{"corporate":{"$ref":"#/components/schemas/Href"},"html":{"$ref":"#/components/schemas/Href"},"json":{"$ref":"#/components/schemas/Href"},"pdf":{"$ref":"#/components/schemas/Href"},"project":{"$ref":"#/components/schemas/Href"},"view":{"$ref":"#/components/schemas/Href"}},"type":"object"}]},"Language":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"type":"object"},"LanguagePair":{"properties":{"source_language":{"type":"string"},"target_language":{"type":"string"}},"type":"object"},"LanguagePairsReport":{"properties":{"meta":{"$ref":"#/components/schemas/PagingMeta"},"report":{"items":{"properties":{"language_pair":{"properties":{"source_language":{"type":"string"},"target_language":{"type":"string"}},"type":"object"},"spending":{"format":"float","type":"number"},"word_count":{"format":"int64","type":"integer"}},"type":"object"},"type":"array"}},"type":"object"},"LanguageScore":{"format":"float","type":"number"},"LanguageStringStat":{"properties":{"project_string_count":{"format":"int64","type":"integer"},"source_language":{"type":"string"},"tm_string_count":{"format":"int64","type":"integer"}},"type":"object"},"LinkedSourceDocument":{"properties":{"name":{"type":"string"},"size":{"description":"file size in bytes. optional.","format":"int64","type":"integer"},"source":{"description":"Preferred source names are listed as enum. If you have a custom file type, simply enter that name.","enum":["dropbox","googledrive","icloud"],"type":"string"},"url":{"format":"uri","type":"string"}},"type":"object"},"LinksMeta":{"properties":{"self":{"$ref":"#/components/schemas/Href"}},"type":"object"},"ListOrderType":{"enum":["asc","desc"],"type":"string"},"LocationUpdateContent":{"properties":{"lat":{"description":"Latitude of location","format":"float","type":"number"},"lon":{"description":"Longitude of location","format":"float","type":"number"},"timestamp":{"type":"integer"}},"required":["lat","lon"],"type":"object"},"MachineTranslatedStrings":{"properties":{"cost":{"$ref":"#/components/schemas/Monetary"},"strings":{"items":{"$ref":"#/components/schemas/ClientStringWithTranslations"},"type":"array"}},"type":"object"},"ManualFile":{"properties":{"driveFileId":{"format":"int64","type":"integer"},"isProofread":{"type":"boolean"},"isTranslated":{"type":"boolean"},"language":{"type":"string"},"proofreadingFileId":{"format":"int64","type":"integer"},"translationFileId":{"format":"int64","type":"integer"}},"type":"object"},"Monetary":{"properties":{"amount":{"format":"float","type":"number"},"currency":{"default":"usd","type":"string"}},"type":"object"},"NewProject":{"properties":{"callback_url":{"description":"Optional. If you provide a callback URL, we will send POST callbacks when the status of the current project is changed. Possible status changes are, 'translated', 'proofread', 'completed'.","type":"string"},"coupon_code":{"description":"Coupon code to redeem","type":"string"},"custom":{"description":"Optional. This is a consistent custom data parameter that will be given to you in the response across every request of this project model. Values should be provided like this, custom[my_key] = my_value.","items":{"type":"string"},"type":"array"},"documents[]":{"description":"Optional. You can add as many files as you want in documents[] parameter. Or you add your documents later in separate calls.","format":"binary","type":"string"},"glossaries[]":{"description":"Optional. Only one glossary is supported at the moment.","format":"binary","type":"string"},"source_language":{"type":"string"},"styleguides[]":{"description":"Optional. You can add as many files as you want in styleguides[] parameter. Or you add your style guides later in separate calls.","format":"binary","type":"string"},"target_languages[]":{"items":{"type":"string"},"type":"array"}},"type":"object"},"NewSalesActivity":{"properties":{"subject":{"type":"string"},"timestamp":{"format":"int64","type":"integer"},"type":{"description":"Activity Type","type":"string"}},"type":"object"},"NotificationSubscription":{"properties":{"device":{"enum":["iOS","Android","Chrome","Firefox","Safari","Edge","Amazon","WindowsPhone","Windows","MacOS"],"type":"string"},"endpoint":{"description":"OneSignal calls this \"player ID\".","type":"string"},"type":{"default":"OneSignal","enum":["OneSignal"],"type":"string"}},"type":"object"},"OperationStatus":{"properties":{"status":{"$ref":"#/components/schemas/OperationStatusEnum"}},"type":"object"},"OperationStatusEnum":{"default":"success","enum":["success","error"],"type":"string"},"Package":{"allOf":[{"$ref":"#/components/schemas/PackageStatus"},{"properties":{"key":{"description":"This is the unique package tracking key. You can use this key to track the current progress of the translation packaging with /package/check call.","type":"string"}},"type":"object"}]},"PackageStatus":{"properties":{"status":{"$ref":"#/components/schemas/PackageStatusEnum"}},"type":"object"},"PackageStatusEnum":{"description":"The status of translation packaging. Possible values are 'started', 'packaging', 'completed'. When completed, you can make a /download call to download the last translation package.","enum":["started","packaging","completed"],"type":"string"},"PagingLinksMeta":{"allOf":[{"$ref":"#/components/schemas/LinksMeta"},{"properties":{"next":{"type":"string"},"previous":{"type":"string"}},"type":"object"}]},"PagingMeta":{"properties":{"paging":{"properties":{"count":{"format":"int64","type":"integer"},"links":{"$ref":"#/components/schemas/PagingLinksMeta"},"page":{"default":1,"format":"int64","type":"integer"},"per_page":{"default":10,"format":"int64","type":"integer"},"total_count":{"format":"int64","type":"integer"}},"type":"object"}},"type":"object"},"PamMessage":{"properties":{"message":{"description":"the message to be sent","type":"string"},"recipients":{"description":"name of the recipients in the channel","items":{"type":"string"},"type":"array"},"slots":{"description":"contexts for next message","items":{"type":"string"},"type":"array"},"thread_id":{"description":"id of the thread","type":"string"},"thread_key":{"description":"the key for thread_id default is project","type":"string"}},"type":"object"},"PasswordUpdateContent":{"properties":{"password":{"description":"New Password","type":"string"}},"type":"object"},"PaymentInfo":{"properties":{"billing":{"$ref":"#/components/schemas/BillingAddress"},"card":{"$ref":"#/components/schemas/CreditCard"},"cards":{"items":{"$ref":"#/components/schemas/CreditCard"},"type":"array"},"corporate":{"properties":{"allow_api_invoicing":{"type":"boolean"},"allow_payment_code":{"type":"boolean"},"auto_charge":{"type":"boolean"},"billing":{"$ref":"#/components/schemas/BillingAddress"},"card":{"$ref":"#/components/schemas/CreditCard"},"contact_email_address":{"type":"string"},"payment_code":{"type":"string"}},"type":"object"},"shared_card":{"$ref":"#/components/schemas/CreditCard"}},"type":"object"},"Permission":{"type":"string"},"PermissionList":{"properties":{"meta":{"$ref":"#/components/schemas/PagingMeta"},"permissions":{"items":{"$ref":"#/components/schemas/Permission"},"type":"array"}},"type":"object"},"PopularLanguagePairs":{"properties":{"pairs":{"items":{"$ref":"#/components/schemas/LanguagePair"},"type":"array"}},"type":"object"},"ProfilePictureUpload":{"properties":{"profile_picture":{"description":"Profile picture file contents. Accepted extensions are png, jpg.","format":"binary","type":"string"}},"required":["profile_picture"],"type":"object"},"ProfileSurvey":{"properties":{"current_services":{"type":"string"},"daily_proofreading_capacity":{"type":"string"},"daily_translation_capacity":{"type":"string"},"dtp_software":{"type":"string"},"experience":{"type":"string"},"is_certified_translator":{"type":"string"},"is_sworn_translator":{"type":"string"},"memoq":{"type":"string"},"memsource":{"type":"string"},"omegat":{"type":"string"},"proofreader_experience":{"type":"string"},"provides_creative_writing_service":{"type":"string"},"provides_postedit_service":{"type":"string"},"reference":{"type":"string"},"sdl_trados":{"type":"string"},"skype_id":{"type":"string"},"smartcat":{"type":"string"},"smartling":{"type":"string"},"software":{"type":"string"},"specialization":{"type":"string"},"subtitle_edit":{"type":"string"},"subtitle_workshop":{"type":"string"},"translator_association":{"type":"string"},"transsuite_2000":{"type":"string"},"vendor_profile_lsp":{"type":"string"},"wordbee":{"type":"string"},"wordfast":{"type":"string"},"work_type":{"type":"string"},"work_with":{"type":"string"},"working_as":{"type":"string"},"working_timezone":{"type":"string"},"xbench":{"type":"string"},"xtm":{"type":"string"}},"type":"object"},"Progress":{"allOf":[{"properties":{"languages":{"additionalProperties":{"$ref":"#/components/schemas/ProgressSub"},"type":"object"},"links":{"$ref":"#/components/schemas/ProgressLink"},"project_status":{"$ref":"#/components/schemas/ProjectStatus"}},"type":"object"},{"$ref":"#/components/schemas/ProgressSub"}]},"ProgressLink":{"allOf":[{"$ref":"#/components/schemas/LinksMeta"},{"properties":{"project":{"$ref":"#/components/schemas/Href"}},"type":"object"}]},"ProgressSub":{"properties":{"proofreading":{"format":"float","type":"number"},"total":{"format":"float","type":"number"},"translation":{"format":"float","type":"number"},"word_count":{"format":"int64","type":"integer"}},"type":"object"},"Project":{"properties":{"average_scores":{"additionalProperties":{"$ref":"#/components/schemas/LanguageScore"},"type":"object","x-internal":true},"budget_code":{"type":"string"},"callback_url":{"description":"Callback URL to notify when project status changed.","type":"string"},"can_pam_manage":{"type":"boolean","x-internal":true},"client":{"$ref":"#/components/schemas/User","description":"User entity for Client. This is only given when project is requested with detailed=true"},"cm_id":{"description":"Assigned admin's id","format":"int64","type":"integer","x-internal":true},"completed_on":{"description":"the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z","format":"date-time","type":"string"},"continuous_project_type":{"type":"string"},"created_at":{"description":"Unix epoch time","format":"int64","type":"integer"},"custom":{"description":"Custom data provided while creating a new project.","type":"object"},"delivery_at":{"description":"Unix epoch time","format":"int64","type":"integer"},"errors":{"description":"A list of errors. Visible when creating a project and uploading your documents at the same time, in case of multiple errors.","items":{"$ref":"#/components/schemas/Error"},"type":"array"},"id":{"format":"int64","type":"integer"},"is_api_project":{"type":"boolean","x-internal":true},"is_certified":{"type":"boolean"},"is_continuous":{"type":"boolean"},"is_manual":{"type":"boolean","x-internal":true},"links":{"$ref":"#/components/schemas/ProjectLinks"},"pairs":{"description":"Currently authed vendor's available working language pairs in this project. Includes rates per language pair. Includes complex pair logic such as bilingualism, project reverse pair enforcement etc.","items":{"$ref":"#/components/schemas/VendorProjectPair"},"type":"array","x-internal":true},"pivoted_projects":{"description":"Quote IDs of pivots","items":{"format":"int64","type":"integer"},"type":"array"},"price":{"properties":{"amount":{"format":"float","type":"number"},"base_amount":{"format":"float","type":"number"},"base_currency":{"default":"usd","type":"string"},"currency":{"default":"usd","type":"string"},"usd_amount":{"description":"USD is our base pricing currency. If `currency` is different, this will help.","format":"float","type":"number"}},"type":"object"},"price_without_discount":{"properties":{"amount":{"format":"float","type":"number"},"base_amount":{"format":"float","type":"number"},"base_currency":{"default":"usd","type":"string"},"currency":{"default":"usd","type":"string"},"usd_amount":{"description":"USD is our base pricing currency. If `currency` is different, this will help.","format":"float","type":"number"}},"type":"object"},"role":{"$ref":"#/components/schemas/VendorProjectRole","x-internal":true},"should_send_client_survey":{"type":"boolean","x-internal":true},"source":{"$ref":"#/components/schemas/ProjectSource","description":"The source platform where this project was first created. Current options are \"api\", \"web\"."},"source_language":{"type":"string"},"status":{"$ref":"#/components/schemas/ProjectStatus"},"subjects":{"items":{"type":"string"},"type":"array"},"target_languages":{"items":{"type":"string"},"type":"array"},"tms_name":{"description":"TMS project name for this MW project. Requires privileged scope.","type":"string","x-internal":true},"valid_until":{"description":"Unix epoch time. Available only if status is `pending`.","format":"int64","type":"integer"},"vendor_word_count":{"format":"int64","type":"integer","x-internal":true},"word_count":{"format":"int64","type":"integer"},"word_count_analysis":{"properties":{"base":{"format":"int64","type":"number"},"duplicate":{"format":"int64","type":"number"},"exclusion":{"format":"int64","type":"number"},"final":{"format":"int64","type":"number"},"tm":{"format":"int64","type":"number"}},"type":"object"}},"type":"object"},"ProjectCompletionReport":{"properties":{"admin_user_id":{"description":"Assigned admin's user id","format":"int64","type":"number"},"completion_report_data":{"items":{"$ref":"#/components/schemas/InvitedVendorsByLanguage"},"type":"array"},"id":{"description":"internal id of the project","format":"int64","type":"number"},"quote_id":{"description":"quote id of the project","format":"int64","type":"number"}},"type":"object"},"ProjectId":{"properties":{"internal-id":{"format":"int64","type":"integer"},"public-id":{"format":"int64","type":"integer"}},"type":"object"},"ProjectInSearch":{"allOf":[{"$ref":"#/components/schemas/Project"},{"properties":{"search_result_reason":{"type":"string"}},"type":"object"}]},"ProjectLaunchResponse":{"properties":{"status":{"$ref":"#/components/schemas/ProjectLaunchResponseEnum"}},"type":"object"},"ProjectLaunchResponseEnum":{"enum":["started"],"type":"string"},"ProjectLinks":{"allOf":[{"$ref":"#/components/schemas/LinksMeta"},{"properties":{"documents":{"$ref":"#/components/schemas/Href"},"glossaries":{"$ref":"#/components/schemas/Href"},"payment":{"$ref":"#/components/schemas/Href"},"quote-pdf":{"$ref":"#/components/schemas/Href"},"styleguides":{"$ref":"#/components/schemas/Href"}},"type":"object"}]},"ProjectList":{"properties":{"meta":{"$ref":"#/components/schemas/PagingMeta"},"projects":{"items":{"$ref":"#/components/schemas/Project"},"type":"array"}},"type":"object"},"ProjectPayment":{"properties":{"bin":{"description":"Last 4 digits of the credit card you are using one-time. This parameter is only required when stripe_token is provided.","type":"string","x-internal":true},"budget_code":{"description":"Optional with corporate accounts. Not available for others.","type":"string"},"card_id":{"description":"Optional. `client`, `app`, `corporate_card` methods require a credit card ID. `credit` method requires Stripe token and bin.","format":"int64","type":"integer"},"payment_code":{"description":"Optional. `corporate` payment method requires this.s","type":"string"},"payment_method":{"description":"Optional. Determines which method to use for payment. `client`, `app`, `corporate_card` methods require a credit card ID. `credit` method requires Stripe token and bin. `corporate` method follows corporate account policy automatically, either follows invoicing flow or automatically charges corporate's primary card.","enum":["corporate","client","app","credit","corporate_card"],"type":"string"},"stripe_token":{"description":"This is required if you are using a one-time credit card. This is the token generted from frontend via Stripe SDK. If you are using a one-time card with `stripe_token`, you must also provide `bin`, last 4 digits of the card.","type":"string","x-internal":true}},"type":"object"},"ProjectSource":{"enum":["api","web"],"type":"string"},"ProjectStatus":{"enum":["pending","started","completed","translated","proofread"],"type":"string"},"ProjectTQS":{"properties":{"is_above_average":{"description":"Is this score above or below the average among other vendors in the same project?","type":"boolean"},"score":{"format":"float","type":"number"},"strings_edited":{"description":"The number of translated strings by this translator which was edited by a proofreader.","format":"int64","type":"integer"},"strings_translated":{"description":"The number of translated strings by this translator.","format":"int64","type":"integer"}},"type":"object"},"ProjectUpdate":{"properties":{"callback_url":{"description":"Optional. If you provide a callback URL, we will send POST callbacks when the status of the current project is changed. Possible status changes are, 'translated', 'proofread', 'completed'.","type":"string"},"coupon_code":{"description":"Coupon code to redeem","type":"string"},"custom":{"description":"Optional. This is a consistent custom data parameter that will be given to you in the response across every request of this project model. Values should be provided like this, custom[my_key] = my_value. If you previously provided one, it will be replaced.","items":{"type":"string"},"type":"array"},"source_language":{"type":"string"},"target_languages[]":{"items":{"type":"string"},"type":"array"}},"type":"object"},"ProofreaderWithLanguage":{"properties":{"full_name":{"description":"full name of the proofreader","type":"string"},"id":{"description":"proofreader id","format":"int64","type":"number"},"language":{"description":"language code (i.e en-US)","type":"string"},"vendor_link":{"description":"link to the vendor that can be only used in motaword admin application","type":"string"}},"type":"object"},"QaEntry":{"properties":{"category":{"type":"string"},"comment":{"type":"string"},"docId":{"type":"string"},"editorLink":{"type":"string"},"end":{"format":"int64","type":"integer"},"inSource":{"type":"boolean"},"isCurrent":{"type":"boolean"},"module":{"type":"string"},"projectId":{"$ref":"#/components/schemas/SimpleModel"},"severity":{"type":"string"},"source":{"type":"string"},"sourceLanguage":{"$ref":"#/components/schemas/SimpleModel"},"start":{"format":"int64","type":"integer"},"state":{"type":"string"},"targetLanguage":{"$ref":"#/components/schemas/SimpleModel"},"translation":{"type":"string"},"uniqueKey":{"type":"string"},"vendor":{"$ref":"#/components/schemas/SimpleModel"}},"type":"object"},"QaFilter":{"properties":{"budget_codes":{"items":{"type":"string"},"type":"array"},"categories":{"items":{"type":"string"},"type":"array"},"clients":{"items":{"format":"int64","type":"number"},"type":"array"},"date_from":{"description":"the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z","format":"date-time","type":"string"},"date_to":{"description":"the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z","format":"date-time","type":"string"},"documents":{"items":{"format":"int64","type":"number"},"type":"array"},"projects":{"items":{"format":"int64","type":"number"},"type":"array"},"severities":{"items":{"type":"string"},"type":"array"},"source_languages":{"items":{"type":"string"},"type":"array"},"subjects":{"items":{"type":"string"},"type":"array"},"target_languages":{"items":{"type":"string"},"type":"array"},"vendors":{"items":{"format":"int64","type":"number"},"type":"array"}},"type":"object"},"QaWarnings":{"properties":{"report":{"items":{"$ref":"#/components/schemas/QaEntry"},"type":"array"}},"type":"object"},"RegeneratePreviewResponse":{"properties":{"link":{"$ref":"#/components/schemas/Href"},"source":{"type":"string"}},"type":"object"},"ReportContent":{"properties":{"activity_type":{"description":"Activity Type","type":"string"},"message":{"description":"Report Message","type":"string"}},"type":"object"},"ReportFilter":{"properties":{"budget_code":{"description":"budget code filter. valid for corporate accounts only.","type":"string"},"date_from":{"description":"the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z","format":"date-time","type":"string"},"date_to":{"description":"the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z","format":"date-time","type":"string"},"source_languages":{"description":"List of source language codes.","items":{"type":"string"},"type":"array"},"target_languages":{"description":"List of target language codes.","items":{"type":"string"},"type":"array"},"users":{"description":"List of corporate user IDs. Valid for corporate accounts only.","items":{"format":"int64","type":"integer"},"type":"array"}},"type":"object"},"Responsivity":{"properties":{"invited":{"format":"int64","type":"integer"},"month":{"type":"string"},"notEntered":{"format":"int64","type":"integer"},"onlyEntered":{"format":"int64","type":"integer"},"score":{"format":"float","type":"number"},"week":{"type":"string"},"worked":{"format":"int64","type":"integer"}},"type":"object"},"ResponsivityList":{"properties":{"links":{"allOf":[{"$ref":"#/components/schemas/LinksMeta"}]},"responsivity":{"items":{"$ref":"#/components/schemas/Responsivity"},"type":"array"}},"type":"object"},"SalesActivities":{"properties":{"activities":{"items":{"$ref":"#/components/schemas/SalesActivity"},"type":"array"}},"type":"object"},"SalesActivity":{"properties":{"body":{"type":"string"},"created_at":{"description":"timestamp","format":"int64","type":"integer"},"created_by":{"type":"string"},"type":{"type":"string"}},"type":"object"},"SalesActivityType":{"enum":["EMAIL","NOTE","INCOMING_EMAIL","TASK"],"type":"string"},"SearchEverywhereResult":{"properties":{"meta":{"$ref":"#/components/schemas/PagingMeta"},"result":{"properties":{"documents":{"items":{"$ref":"#/components/schemas/DocumentInSearch"},"type":"array"},"projects":{"items":{"$ref":"#/components/schemas/ProjectInSearch"},"type":"array"},"strings":{"items":{"$ref":"#/components/schemas/StringInSearch"},"type":"array"}},"type":"object"}},"type":"object"},"SimpleModel":{"properties":{"id":{"format":"int64","type":"integer"},"name":{"type":"string"}},"type":"object"},"SingleString":{"properties":{"content":{"description":"source string content","type":"string"},"file_id":{"format":"int64","type":"integer"},"id":{"type":"string"}},"type":"object"},"SocialMedia":{"properties":{"facebook_url":{"type":"string"},"linkedIn_url":{"type":"string"},"twitter_url":{"type":"string"}},"type":"object"},"Stats":{"properties":{"client":{"$ref":"#/components/schemas/ClientStats"},"vendor":{"$ref":"#/components/schemas/VendorStats"}},"type":"object"},"StringInSearch":{"properties":{"file_id":{"format":"int64","type":"integer"},"internal_project_id":{"format":"int64","type":"integer"},"last_updated":{"description":"the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z","format":"date-time","type":"string"},"project_id":{"format":"int64","type":"integer"},"search_score":{"format":"float","type":"number"},"source":{"type":"string"},"status":{"$ref":"#/components/schemas/StringTranslationState"},"string_id":{"format":"int64","type":"integer"},"target":{"type":"string"},"targets":{"items":{"type":"string"},"type":"array"},"tm_name":{"type":"string"},"type":{"description":"String search result typ from ZNT. Options are LOCAL_PROJECT, IMPORTED_TM. Imported TM results should probably not be visible to end users.","enum":["LOCAL_PROJECT","IMPORTED_TM"],"type":"string"}},"type":"object"},"StringList":{"properties":{"meta":{"$ref":"#/components/schemas/PagingMeta"},"translations":{"items":{"$ref":"#/components/schemas/StringWithTranslations"},"type":"array"}},"type":"object"},"StringTranslation":{"properties":{"content":{"description":"source string content","type":"string"},"id":{"type":"string"},"state":{"$ref":"#/components/schemas/StringTranslationState"}},"type":"object"},"StringTranslationState":{"enum":["Approved","Translated"],"type":"string"},"StringWithTranslations":{"allOf":[{"$ref":"#/components/schemas/SingleString"},{"properties":{"translations":{"additionalProperties":{"$ref":"#/components/schemas/StringTranslation"},"type":"object"}},"type":"object"}]},"StyleGuide":{"properties":{"id":{"format":"int64","type":"integer"},"links":{"$ref":"#/components/schemas/DocumentLinks"},"name":{"type":"string"},"uploaded_at":{"description":"Unix epoch time","format":"int64","type":"integer"}},"type":"object"},"StyleGuideList":{"properties":{"meta":{"$ref":"#/components/schemas/PagingMeta"},"styleguides":{"items":{"$ref":"#/components/schemas/StyleGuide"},"type":"array"}},"type":"object"},"StyleGuideUploadRequest":{"properties":{"styleguides":{"description":"You can only add one style guide, even though the name suggests multiple style guides. This may be updated in the future to support multiple style guides.","format":"binary","type":"string"}},"required":["styleguides"],"type":"object"},"Subscription":{"properties":{"downgrade":{"description":"Stripe downgradable plan","items":{"type":"string"},"type":"array"},"payment_method":{"description":"Stripe subscription plan payment card internal id","type":"integer"},"period_end":{"description":"Stripe plan period end","format":"date-time","type":"string"},"plan_id":{"description":"Stripe subscription plan id","type":"string"},"plan_name":{"description":"Stripe subscription plan name","type":"string"},"price":{"description":"Stripe plan price","type":"string"},"products":{"items":{},"type":"array"},"schedule_name":{"description":"Stripe Scheduled plan period end","type":"string"},"schedule_start":{"description":"Stripe Scheduled start date","format":"date-time","type":"string"},"subscription_id":{"description":"Stripe subscription id for this project","type":"string"},"upgrade":{"description":"Stripe upgradable plan","items":{"type":"string"},"type":"array"},"withTrial":{"description":"Stripe plan trial","format":"boolean"}},"type":"object"},"SurveyAnswer":{"properties":{"answer":{"type":"string"},"project_id":{"format":"int64","type":"integer"},"question_answer_id":{"format":"int64","type":"integer"},"question_id":{"format":"int64","type":"integer"},"user_id":{"format":"int64","type":"integer"}},"type":"object"},"SurveyAnswers":{"properties":{"answers":{"items":{"$ref":"#/components/schemas/SurveyAnswer"},"type":"array"}},"type":"object"},"SurveyQuestion":{"properties":{"answers":{"items":{"$ref":"#/components/schemas/SimpleModel"},"type":"array"},"question":{"properties":{"enabled":{"type":"boolean"},"format":{"type":"string"},"id":{"format":"int64","type":"integer"},"question":{"type":"string"},"text":{"type":"string"}},"type":"object"},"question_answers":{"items":{"$ref":"#/components/schemas/SimpleModel"},"type":"array"}},"type":"object"},"SurveyQuestions":{"items":{"$ref":"#/components/schemas/SurveyQuestion"},"type":"array"},"SuspendUserRequest":{"properties":{"reason":{"description":"Suspension reason for vendor","type":"string"}},"type":"object"},"Tag":{"type":"string"},"Token":{"properties":{"access_token":{"type":"string"},"expires_in":{"format":"int64","type":"integer"},"refresh_token":{"type":"string"},"scope":{"type":"string"},"token_type":{"type":"string"},"user_id":{"format":"int64","type":"integer"}}},"TokenError":{"allOf":[{"$ref":"#/components/schemas/Error"},{"properties":{"account_status":{"enum":["registered","email_confirmed","deleted","suspended","rejected","approved","resume","webinar","course"],"type":"string"}},"type":"object"}]},"TokenRequest":{"properties":{"grant_type":{"description":"OAuth2 grant type. Supports 'client_credentials', 'password', 'refresh_token' or 'user_id'.","type":"string","x-public-description":"OAuth2 grant type. We publicly support 'client_credentials' or 'refresh_token' grant types, while other strategies are also possible but not allowed regularly."},"password":{"description":"MW Account password (to be used in password grant type)","type":"string","x-internal":true},"refresh_token":{"description":"Refresh token value for refresh token flow.","type":"string"},"scope":{"description":"Authorization scope. Use 'privileged' for private endpoints.","type":"string"},"user_id":{"description":"Value for user_id grant type flow.","format":"int64","type":"integer","x-internal":true},"username":{"description":"MW Account email (to be used in password grant type)","type":"string","x-internal":true}},"required":["grant_type","scope"]},"TranslationMemoryUnit":{"properties":{"sourceLanguage":{"type":"string"},"sourceText":{"type":"string"},"targetLanguage":{"type":"string"},"targetText":{"type":"string"}},"type":"object"},"UpdatePaymentInfo":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"bin":{"type":"string"},"save_as_corporate_primary":{"type":"boolean"},"share_with_corporate_users":{"type":"boolean"},"stripeToken":{"type":"string"}},"type":"object"}]},"UseAsDraftPayload":{"properties":{"fromFileId":{"type":"number"},"fromManualTranslationFileId":{"type":"number"},"toManualTranslationFileId":{"type":"number"}},"type":"object"},"UseAsRegularPayload":{"properties":{"allowOriginalFilePreview":{"type":"boolean"},"allowReviewInManualEditor":{"type":"boolean"},"disableInvitations":{"type":"boolean"},"fromManualTranslationFileId":{"type":"number"},"hideNumbers":{"type":"boolean"},"recreate":{"type":"boolean"}},"type":"object"},"User":{"properties":{"billing":{"$ref":"#/components/schemas/BillingAddress","x-internal":true},"birthday":{"format":"date","type":"string","x-internal":true},"can_work_manual_files":{"deprecated":true,"description":"\\@deprecated. use `vendor` key","type":"boolean"},"city":{"deprecated":true,"description":"\\@deprecated. use mailing or billing key.","type":"string","x-internal":true},"client":{"properties":{"corporate":{"properties":{"email":{"type":"string","x-internal":true},"id":{"format":"int64","type":"integer"},"logo":{"type":"string"},"name":{"type":"string"},"phone_number":{"type":"string","x-internal":true}},"type":"object"},"nps":{"format":"float","type":"number"},"subjects":{"additionalProperties":{"format":"int64","type":"integer"},"type":"object"}},"type":"object"},"corporate_id":{"format":"int64","type":"integer"},"country":{"deprecated":true,"description":"\\@deprecated. use mailing or billing key.","type":"string","x-internal":true},"created_at":{"description":"Unix epoch time","format":"int64","type":"integer"},"do_not_contact":{"type":"boolean"},"email":{"type":"string","x-internal":true},"first_name":{"type":"string"},"has_pwd":{"type":"boolean"},"id":{"format":"int64","type":"integer"},"is_client":{"type":"boolean"},"is_developer":{"type":"boolean"},"is_proofreader":{"deprecated":true,"description":"\\@deprecated. use `vendor` key","type":"boolean"},"is_prospect":{"type":"boolean","x-internal":true},"is_sales_person":{"type":"boolean","x-internal":true},"is_vendor":{"type":"boolean"},"language_pairs":{"deprecated":true,"description":"\\@deprecated. use `vendor` key","items":{"$ref":"#/components/schemas/LanguagePair"},"type":"array"},"last_name":{"type":"string"},"last_seen_online_at":{"description":"Unix epoch time","format":"int64","type":"integer"},"links":{"$ref":"#/components/schemas/UserLinks"},"locale":{"description":"User Locale","type":"string"},"mailing":{"$ref":"#/components/schemas/Address","x-internal":true},"name":{"type":"string"},"native_language":{"deprecated":true,"description":"\\@deprecated. Native language of user","type":"string"},"nps":{"deprecated":true,"description":"\\@deprecated. use /stats endpoint for the current nps value.","format":"float","type":"number","x-internal":true},"phone_number":{"type":"string","x-internal":true},"profile_picture_path":{"type":"string"},"social_media":{"$ref":"#/components/schemas/SocialMedia","x-internal":true},"state":{"deprecated":true,"description":"\\@deprecated. use mailing or billing key.","type":"string","x-internal":true},"status":{"type":"string"},"street":{"deprecated":true,"description":"\\@deprecated. use mailing or billing key.","type":"string","x-internal":true},"timezone":{"type":"string"},"tms_user_name":{"deprecated":true,"description":"\\@deprecated. use `vendor` key","type":"string","x-internal":true},"user_groups":{"items":{"$ref":"#/components/schemas/UserGroup"},"type":"array"},"vendor":{"properties":{"can_work_manual_files":{"type":"boolean"},"email_open_rate":{"format":"float","type":"number"},"is_frozen":{"type":"boolean"},"is_proofreader":{"type":"boolean"},"language_pairs":{"items":{"$ref":"#/components/schemas/LanguagePair"},"type":"array"},"native_language":{"description":"Native language of user","type":"string"},"pam_tqs":{"format":"float","type":"number"},"paypal_email":{"type":"string","x-internal":true},"profile_survey":{"$ref":"#/components/schemas/ProfileSurvey","description":"Vendor Profile Survey answers","type":"object"},"require_1099":{"type":"boolean","x-internal":true},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","x-internal":true},"tms_user_name":{"type":"string","x-internal":true},"vendor_type":{"type":"string"}},"type":"object"},"zip_code":{"deprecated":true,"description":"\\@deprecated. use mailing or billing key. new key name is \"zip\".","type":"string","x-internal":true}},"type":"object"},"UserGroup":{"properties":{"corporate_id":{"format":"int64","type":"integer"},"id":{"format":"int64","type":"integer"},"name":{"type":"string"},"permissions":{"items":{"type":"string"},"type":"array"}},"type":"object"},"UserGroupList":{"properties":{"meta":{"$ref":"#/components/schemas/PagingMeta"},"user_groups":{"items":{"$ref":"#/components/schemas/UserGroup"},"type":"array"}},"type":"object"},"UserLinks":{"allOf":[{"$ref":"#/components/schemas/LinksMeta"},{"properties":{"login_as":{"$ref":"#/components/schemas/Href","description":"Exculusive users only"},"projects":{"$ref":"#/components/schemas/Href","description":"client users only"},"responsivity":{"$ref":"#/components/schemas/Href","description":"vendor users only"},"stats":{"$ref":"#/components/schemas/Href"}},"type":"object"}]},"UserList":{"properties":{"meta":{"$ref":"#/components/schemas/PagingMeta"},"users":{"items":{"$ref":"#/components/schemas/User"},"type":"array"}},"type":"object"},"UserUpdateContent":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"birthday":{"format":"date","type":"string"},"email":{"description":"Optional. User e-mail.","type":"string"},"first_name":{"description":"Optional. User first name.","type":"string"},"id":{"description":"Optional. ID of the user being updated.","format":"int64","type":"integer"},"last_name":{"description":"Optional. User last name.","type":"string"},"notifications":{"description":"Notification settings","properties":{"phone_number":{"description":"User phone number","type":"string"},"sms_enabled":{"description":"User sms notification setting","type":"boolean"}},"type":"object"},"notify":{"description":"Notify new user account creation with login information and MotaWord introduction.","type":"boolean"},"paypal_email":{"description":"Optional. Vendor paypal e-mail","type":"string"},"require_1099":{"description":"Optional. Whether this vendor requires 1099 form in US for their earnings.","type":"boolean"},"user_groups":{"description":"A list of user group IDs","items":{"format":"int64","type":"integer"},"type":"array"}},"type":"object"}]},"UsersReport":{"properties":{"meta":{"$ref":"#/components/schemas/PagingMeta"},"report":{"items":{"properties":{"currency":{"type":"string"},"spending":{"format":"float","type":"number"},"user":{"$ref":"#/components/schemas/User"},"word_count":{"format":"int64","type":"integer"}},"type":"object"},"type":"array"}},"type":"object"},"VendorEarningStats":{"properties":{"total":{"description":"total amount of USD that this user has earned in the platform so far.","format":"float","type":"number"}},"type":"object"},"VendorInvitationList":{"properties":{"vendors":{"items":{"$ref":"#/components/schemas/VendorWithNeeds"},"type":"array"}},"type":"object"},"VendorProjectPair":{"properties":{"currency":{"default":"usd","type":"string"},"is_proofreader":{"description":"Indicates if the vendor be able to proofred this pair","type":"boolean"},"proofreader":{"$ref":"#/components/schemas/User"},"proofreading_rate":{"format":"float","type":"number"},"source_language":{"description":"Source language code","type":"string"},"target_language":{"description":"Target language code","type":"string"},"translation_rate":{"format":"float","type":"number"}},"type":"object"},"VendorProjectRole":{"description":"Currently authed vendor's role in this project. If vendor has already joined, this contains the role they joined the project with. If not joined yet, this is the role that they can join the project with.","enum":["translator","proofreader","both"],"type":"string"},"VendorProjectStats":{"properties":{"invited":{"description":"total number of projects that this user was invited to. TODO this key is to replace \"total\" key due to naming ambiguity.","format":"int64","type":"integer"},"total":{"description":"total number of projects that this user was invited to.","format":"int64","type":"integer"},"worked":{"description":"total number of projects that this user actually worked on.","format":"int64","type":"integer"}},"type":"object"},"VendorStats":{"properties":{"earnings":{"$ref":"#/components/schemas/VendorEarningStats"},"projects":{"$ref":"#/components/schemas/VendorProjectStats"},"words":{"$ref":"#/components/schemas/VendorWordStats"}},"type":"object"},"VendorTag":{"properties":{"color":{"type":"string"},"name":{"type":"string"}},"type":"object"},"VendorWithNeeds":{"properties":{"matchedNeeds":{"items":{"$ref":"#/components/schemas/FileNeedsVendor"},"type":"array"},"userId":{"format":"int64","type":"integer"}},"type":"object"},"VendorWordStats":{"properties":{"approved":{"description":"total number of words that this user has approved so far.","format":"int64","type":"integer"},"translated":{"description":"total number of words that this user has translated so far.","format":"int64","type":"integer"}},"type":"object"},"Webhook":{"properties":{"callback_url":{"description":"Webhook URL. We will send POST callbacks when the status of the current project is changed. Possible status changes are, 'translated', 'proofread', 'completed'.","type":"string"}},"type":"object"}},"securitySchemes":{"basicAuth":{"scheme":"basic","type":"http"},"mwoAuth":{"description":"OAuth2 authentication, Client Credentials flow.","flows":{"authorizationCode":{"authorizationUrl":"/token","refreshUrl":"/token","scopes":{"default":"default","privileged":"privileged"},"tokenUrl":"/token"},"clientCredentials":{"scopes":{"default":"default","privileged":"privileged"},"tokenUrl":"/token"},"password":{"refreshUrl":"/token","scopes":{"default":"default","privileged":"privileged"},"tokenUrl":"/token"}},"type":"oauth2"}}},"x-cli-cmd-groups":{"activities":{"long":"Manage activities","parent":"projects","short":"Manage activities"},"async":{"long":"Manage async operations","short":"Manage async operations"},"blog":{"long":"Manage blog articles","short":"Manage blog articles"},"clients":{"long":"Manage client account","short":"Manage client account"},"commissions":{"long":"Manage commissions","short":"Manage commissions","x-internal":true},"continuous-projects":{"long":"Manage your continuous localization or translation projects","short":"Manage your continuous projects"},"corporates":{"long":"Manage corporate account","parent":"clients","short":"Manage corporate account"},"documents":{"long":"Manage documents","short":"Manage documents"},"glossaries":{"long":"Manage glossaries","short":"Manage glossaries"},"pam":{"long":"Endpoints for PAM","short":"Endpoints for PAM","x-internal":true},"project-documents":{"long":"Manage project source documents","parent":"projects","short":"Manage project source documents"},"projects":{"long":"Manage projects","short":"Manage projects"},"reports":{"long":"Manage reports","short":"Manage reports"},"search":{"long":"Manage search operations","short":"Manage search operations"},"static":{"long":"Manage static endpoints","short":"Manage static endpoints"},"stats":{"long":"Manage stats","short":"Manage stats"},"strings":{"long":"Manage strings","short":"Manage strings"},"styleguides":{"long":"Manage styleguides","short":"Manage styleguides"},"token":{"long":"Manage token operations","short":"Manage token operations"},"translations":{"long":"Manage translations","parent":"projects","short":"Manage translations"},"users":{"long":"Manage users","short":"Manage users"},"vendors":{"long":"Manage vendors","parent":"users","short":"Manage vendors"},"webhooks":{"long":"Manage webhooks","short":"Manage webhooks"}}}