Module crowdin_api.api_resources.fields.resource

Classes

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

Resource for Fields.

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#tag/Fields

Ancestors

• BaseResource

Methods

def add_field(self, name: str, slug: str, type: FieldType, entities: Iterable[FieldEntity], description: Optional[str] = None, config: Union[ListFieldConfig, NumberFieldConfig, OtherFieldConfig, None] = None)

Add Field

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.fields.post

def delete_field(self, fieldId: int)

Delete Field

Link to documetation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.fields.delete

def edit_field(self, fieldId: int, data: Iterable[FieldPatchRequest])

Edit Field

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.fields.patch

def get_field(self, fieldId: int)

Get Field

Link to documentaion: https://developer.crowdin.com/enterprise/api/v2/#operation/api.fields.get

def get_fields_path(self, fieldId: Optional[int] = None)

def list_fields(self, search: Optional[str] = None, entity: Optional[FieldEntity] = None, type: Optional[FieldType] = None, limit: Optional[int] = None, offset: Optional[int] = None)

List Fields

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.fields.getMany