Module crowdin_api.api_resources.advisors.resource

Classes

class AdvisorsResource (requester: APIRequester, project_id: Optional[int] = None, page_size=25)

Resource for Advisors.

Advisors run inspectors against a project and report insights about its localization health.

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/Advisors

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#tag/Advisors

Ancestors

Methods

def create_advisor_check(self, category: Optional[str] = None, inspectors: Optional[Iterable[AdvisorCheckInspector]] = None, projectId: Optional[int] = None)

Create Advisor Check.

At most one of category or inspectors may be set; if neither is set, every inspector is re-checked.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.advisors.checks.post

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.advisors.checks.post

def create_or_update_application_advisor_insight(self, applicationIdentifier: str, moduleKey: str, outcome: AdvisorInsightOutcome, checkedAt: Union[datetime.datetime, str, None] = None, metrics: Optional[Iterable[AdvisorInsightMetric]] = None, recommendations: Optional[Iterable[AdvisorInsightRecommendation]] = None, payload: Optional[Dict[str, Any]] = None, projectId: Optional[int] = None)

Create or Update Application Advisor Insight.

Called by an installed application's advisor-inspector module to publish its check result.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.applications.modules.advisors.insights.put

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.applications.modules.advisors.insights.put

def edit_advisor_insight(self, insightId: int, data: Iterable[AdvisorInsightPatchRequest], projectId: Optional[int] = None)

Edit Advisor Insight.

Currently only /isDismissed is patchable.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.advisors.insights.patch

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.advisors.insights.patch

def get_advisor_check_status(self, checkId: str, projectId: Optional[int] = None)

Get Advisor Check Status.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.advisors.checks.get

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.advisors.checks.get

def get_advisor_checks_path(self, projectId: int, checkId: Optional[str] = None)
def get_advisor_insights_path(self, projectId: int, insightId: Optional[int] = None)
def list_advisor_insights(self, projectId: Optional[int] = None, isDismissed: Optional[bool] = None, status: Union[str, AdvisorInsightStatus, Iterable[Union[str, AdvisorInsightStatus]], None] = None, outcome: Union[str, AdvisorInsightOutcome, Iterable[Union[str, AdvisorInsightOutcome]], None] = None, offset: Optional[int] = None, limit: Optional[int] = None)

List Advisor Insights.

status and outcome accept a single value or a list of values (sent comma-separated).

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.advisors.insights.getMany

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.advisors.insights.getMany