azure-devops/azext_devops/devops_sdk/v5_0/work_item_tracking/models.py [216:1348]: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - class FieldsToEvaluate(Model): """FieldsToEvaluate. :param fields: List of fields to evaluate. :type fields: list of str :param field_updates: Updated field values to evaluate. :type field_updates: dict :param field_values: Initial field values. :type field_values: dict :param rules_from: URL of the work item type for which the rules need to be executed. :type rules_from: list of str """ _attribute_map = { 'fields': {'key': 'fields', 'type': '[str]'}, 'field_updates': {'key': 'fieldUpdates', 'type': '{object}'}, 'field_values': {'key': 'fieldValues', 'type': '{object}'}, 'rules_from': {'key': 'rulesFrom', 'type': '[str]'} } def __init__(self, fields=None, field_updates=None, field_values=None, rules_from=None): super(FieldsToEvaluate, self).__init__() self.fields = fields self.field_updates = field_updates self.field_values = field_values self.rules_from = rules_from class GraphSubjectBase(Model): """GraphSubjectBase. :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. :type descriptor: str :param display_name: This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider. :type display_name: str :param url: This url is the full route to the source resource of this graph subject. :type url: str """ _attribute_map = { '_links': {'key': '_links', 'type': 'ReferenceLinks'}, 'descriptor': {'key': 'descriptor', 'type': 'str'}, 'display_name': {'key': 'displayName', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, _links=None, descriptor=None, display_name=None, url=None): super(GraphSubjectBase, self).__init__() self._links = _links self.descriptor = descriptor self.display_name = display_name self.url = url class IdentityRef(GraphSubjectBase): """IdentityRef. :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. :type descriptor: str :param display_name: This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider. :type display_name: str :param url: This url is the full route to the source resource of this graph subject. :type url: str :param directory_alias: :type directory_alias: str :param id: :type id: str :param image_url: :type image_url: str :param inactive: :type inactive: bool :param is_aad_identity: :type is_aad_identity: bool :param is_container: :type is_container: bool :param is_deleted_in_origin: :type is_deleted_in_origin: bool :param profile_url: :type profile_url: str :param unique_name: :type unique_name: str """ _attribute_map = { '_links': {'key': '_links', 'type': 'ReferenceLinks'}, 'descriptor': {'key': 'descriptor', 'type': 'str'}, 'display_name': {'key': 'displayName', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'}, 'directory_alias': {'key': 'directoryAlias', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'image_url': {'key': 'imageUrl', 'type': 'str'}, 'inactive': {'key': 'inactive', 'type': 'bool'}, 'is_aad_identity': {'key': 'isAadIdentity', 'type': 'bool'}, 'is_container': {'key': 'isContainer', 'type': 'bool'}, 'is_deleted_in_origin': {'key': 'isDeletedInOrigin', 'type': 'bool'}, 'profile_url': {'key': 'profileUrl', 'type': 'str'}, 'unique_name': {'key': 'uniqueName', 'type': 'str'} } def __init__(self, _links=None, descriptor=None, display_name=None, url=None, directory_alias=None, id=None, image_url=None, inactive=None, is_aad_identity=None, is_container=None, is_deleted_in_origin=None, profile_url=None, unique_name=None): super(IdentityRef, self).__init__(_links=_links, descriptor=descriptor, display_name=display_name, url=url) self.directory_alias = directory_alias self.id = id self.image_url = image_url self.inactive = inactive self.is_aad_identity = is_aad_identity self.is_container = is_container self.is_deleted_in_origin = is_deleted_in_origin self.profile_url = profile_url self.unique_name = unique_name class IdentityReference(IdentityRef): """IdentityReference. :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. :type descriptor: str :param display_name: This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider. :type display_name: str :param url: This url is the full route to the source resource of this graph subject. :type url: str :param directory_alias: :type directory_alias: str :param image_url: :type image_url: str :param inactive: :type inactive: bool :param is_aad_identity: :type is_aad_identity: bool :param is_container: :type is_container: bool :param is_deleted_in_origin: :type is_deleted_in_origin: bool :param profile_url: :type profile_url: str :param unique_name: :type unique_name: str :param id: :type id: str :param name: Legacy back-compat property. This has been the WIT specific value from Constants. Will be hidden (but exists) on the client unless they are targeting the newest version :type name: str """ _attribute_map = { '_links': {'key': '_links', 'type': 'ReferenceLinks'}, 'descriptor': {'key': 'descriptor', 'type': 'str'}, 'display_name': {'key': 'displayName', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'}, 'directory_alias': {'key': 'directoryAlias', 'type': 'str'}, 'image_url': {'key': 'imageUrl', 'type': 'str'}, 'inactive': {'key': 'inactive', 'type': 'bool'}, 'is_aad_identity': {'key': 'isAadIdentity', 'type': 'bool'}, 'is_container': {'key': 'isContainer', 'type': 'bool'}, 'is_deleted_in_origin': {'key': 'isDeletedInOrigin', 'type': 'bool'}, 'profile_url': {'key': 'profileUrl', 'type': 'str'}, 'unique_name': {'key': 'uniqueName', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'} } def __init__(self, _links=None, descriptor=None, display_name=None, url=None, directory_alias=None, image_url=None, inactive=None, is_aad_identity=None, is_container=None, is_deleted_in_origin=None, profile_url=None, unique_name=None, id=None, name=None): super(IdentityReference, self).__init__(_links=_links, descriptor=descriptor, display_name=display_name, url=url, directory_alias=directory_alias, image_url=image_url, inactive=inactive, is_aad_identity=is_aad_identity, is_container=is_container, is_deleted_in_origin=is_deleted_in_origin, profile_url=profile_url, unique_name=unique_name) self.id = id self.name = name class JsonPatchOperation(Model): """JsonPatchOperation. :param from_: The path to copy from for the Move/Copy operation. :type from_: str :param op: The patch operation :type op: object :param path: The path for the operation :type path: str :param value: The value for the operation. This is either a primitive or a JToken. :type value: object """ _attribute_map = { 'from_': {'key': 'from', 'type': 'str'}, 'op': {'key': 'op', 'type': 'object'}, 'path': {'key': 'path', 'type': 'str'}, 'value': {'key': 'value', 'type': 'object'} } def __init__(self, from_=None, op=None, path=None, value=None): super(JsonPatchOperation, self).__init__() self.from_ = from_ self.op = op self.path = path self.value = value class Link(Model): """Link. :param attributes: Collection of link attributes. :type attributes: dict :param rel: Relation type. :type rel: str :param url: Link url. :type url: str """ _attribute_map = { 'attributes': {'key': 'attributes', 'type': '{object}'}, 'rel': {'key': 'rel', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, attributes=None, rel=None, url=None): super(Link, self).__init__() self.attributes = attributes self.rel = rel self.url = url class ProjectWorkItemStateColors(Model): """ProjectWorkItemStateColors. :param project_name: Project name :type project_name: str :param work_item_type_state_colors: State colors for all work item type in a project :type work_item_type_state_colors: list of :class:`WorkItemTypeStateColors ` """ _attribute_map = { 'project_name': {'key': 'projectName', 'type': 'str'}, 'work_item_type_state_colors': {'key': 'workItemTypeStateColors', 'type': '[WorkItemTypeStateColors]'} } def __init__(self, project_name=None, work_item_type_state_colors=None): super(ProjectWorkItemStateColors, self).__init__() self.project_name = project_name self.work_item_type_state_colors = work_item_type_state_colors class ProvisioningResult(Model): """ProvisioningResult. :param provisioning_import_events: Details about of the provisioning import events. :type provisioning_import_events: list of str """ _attribute_map = { 'provisioning_import_events': {'key': 'provisioningImportEvents', 'type': '[str]'} } def __init__(self, provisioning_import_events=None): super(ProvisioningResult, self).__init__() self.provisioning_import_events = provisioning_import_events class QueryBatchGetRequest(Model): """QueryBatchGetRequest. :param expand: The expand parameters for queries. Possible options are { None, Wiql, Clauses, All, Minimal } :type expand: object :param error_policy: The flag to control error policy in a query batch request. Possible options are { Fail, Omit }. :type error_policy: object :param ids: The requested query ids :type ids: list of str """ _attribute_map = { 'expand': {'key': '$expand', 'type': 'object'}, 'error_policy': {'key': 'errorPolicy', 'type': 'object'}, 'ids': {'key': 'ids', 'type': '[str]'} } def __init__(self, expand=None, error_policy=None, ids=None): super(QueryBatchGetRequest, self).__init__() self.expand = expand self.error_policy = error_policy self.ids = ids class QueryHierarchyItemsResult(Model): """QueryHierarchyItemsResult. :param count: The count of items. :type count: int :param has_more: Indicates if the max return limit was hit but there are still more items :type has_more: bool :param value: The list of items :type value: list of :class:`QueryHierarchyItem ` """ _attribute_map = { 'count': {'key': 'count', 'type': 'int'}, 'has_more': {'key': 'hasMore', 'type': 'bool'}, 'value': {'key': 'value', 'type': '[QueryHierarchyItem]'} } def __init__(self, count=None, has_more=None, value=None): super(QueryHierarchyItemsResult, self).__init__() self.count = count self.has_more = has_more self.value = value class ReferenceLinks(Model): """ReferenceLinks. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict """ _attribute_map = { 'links': {'key': 'links', 'type': '{object}'} } def __init__(self, links=None): super(ReferenceLinks, self).__init__() self.links = links class ReportingWorkItemRevisionsFilter(Model): """ReportingWorkItemRevisionsFilter. :param fields: A list of fields to return in work item revisions. Omit this parameter to get all reportable fields. :type fields: list of str :param include_deleted: Include deleted work item in the result. :type include_deleted: bool :param include_identity_ref: Return an identity reference instead of a string value for identity fields. :type include_identity_ref: bool :param include_latest_only: Include only the latest version of a work item, skipping over all previous revisions of the work item. :type include_latest_only: bool :param include_tag_ref: Include tag reference instead of string value for System.Tags field :type include_tag_ref: bool :param types: A list of types to filter the results to specific work item types. Omit this parameter to get work item revisions of all work item types. :type types: list of str """ _attribute_map = { 'fields': {'key': 'fields', 'type': '[str]'}, 'include_deleted': {'key': 'includeDeleted', 'type': 'bool'}, 'include_identity_ref': {'key': 'includeIdentityRef', 'type': 'bool'}, 'include_latest_only': {'key': 'includeLatestOnly', 'type': 'bool'}, 'include_tag_ref': {'key': 'includeTagRef', 'type': 'bool'}, 'types': {'key': 'types', 'type': '[str]'} } def __init__(self, fields=None, include_deleted=None, include_identity_ref=None, include_latest_only=None, include_tag_ref=None, types=None): super(ReportingWorkItemRevisionsFilter, self).__init__() self.fields = fields self.include_deleted = include_deleted self.include_identity_ref = include_identity_ref self.include_latest_only = include_latest_only self.include_tag_ref = include_tag_ref self.types = types class StreamedBatch(Model): """StreamedBatch. :param continuation_token: :type continuation_token: str :param is_last_batch: :type is_last_batch: bool :param next_link: :type next_link: str :param values: :type values: list of object """ _attribute_map = { 'continuation_token': {'key': 'continuationToken', 'type': 'str'}, 'is_last_batch': {'key': 'isLastBatch', 'type': 'bool'}, 'next_link': {'key': 'nextLink', 'type': 'str'}, 'values': {'key': 'values', 'type': '[object]'} } def __init__(self, continuation_token=None, is_last_batch=None, next_link=None, values=None): super(StreamedBatch, self).__init__() self.continuation_token = continuation_token self.is_last_batch = is_last_batch self.next_link = next_link self.values = values class TeamContext(Model): """TeamContext. :param project: The team project Id or name. Ignored if ProjectId is set. :type project: str :param project_id: The Team Project ID. Required if Project is not set. :type project_id: str :param team: The Team Id or name. Ignored if TeamId is set. :type team: str :param team_id: The Team Id :type team_id: str """ _attribute_map = { 'project': {'key': 'project', 'type': 'str'}, 'project_id': {'key': 'projectId', 'type': 'str'}, 'team': {'key': 'team', 'type': 'str'}, 'team_id': {'key': 'teamId', 'type': 'str'} } def __init__(self, project=None, project_id=None, team=None, team_id=None): super(TeamContext, self).__init__() self.project = project self.project_id = project_id self.team = team self.team_id = team_id class Wiql(Model): """Wiql. :param query: The text of the WIQL query :type query: str """ _attribute_map = { 'query': {'key': 'query', 'type': 'str'} } def __init__(self, query=None): super(Wiql, self).__init__() self.query = query class WorkArtifactLink(Model): """WorkArtifactLink. :param artifact_type: Target artifact type. :type artifact_type: str :param link_type: Outbound link type. :type link_type: str :param tool_type: Target tool type. :type tool_type: str """ _attribute_map = { 'artifact_type': {'key': 'artifactType', 'type': 'str'}, 'link_type': {'key': 'linkType', 'type': 'str'}, 'tool_type': {'key': 'toolType', 'type': 'str'} } def __init__(self, artifact_type=None, link_type=None, tool_type=None): super(WorkArtifactLink, self).__init__() self.artifact_type = artifact_type self.link_type = link_type self.tool_type = tool_type class WorkItemBatchGetRequest(Model): """WorkItemBatchGetRequest. :param expand: The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All } :type expand: object :param as_of: AsOf UTC date time string :type as_of: datetime :param error_policy: The flag to control error policy in a bulk get work items request. Possible options are {Fail, Omit}. :type error_policy: object :param fields: The requested fields :type fields: list of str :param ids: The requested work item ids :type ids: list of int """ _attribute_map = { 'expand': {'key': '$expand', 'type': 'object'}, 'as_of': {'key': 'asOf', 'type': 'iso-8601'}, 'error_policy': {'key': 'errorPolicy', 'type': 'object'}, 'fields': {'key': 'fields', 'type': '[str]'}, 'ids': {'key': 'ids', 'type': '[int]'} } def __init__(self, expand=None, as_of=None, error_policy=None, fields=None, ids=None): super(WorkItemBatchGetRequest, self).__init__() self.expand = expand self.as_of = as_of self.error_policy = error_policy self.fields = fields self.ids = ids class WorkItemDeleteReference(Model): """WorkItemDeleteReference. :param code: The HTTP status code for work item operation in a batch request. :type code: int :param deleted_by: The user who deleted the work item type. :type deleted_by: str :param deleted_date: The work item deletion date. :type deleted_date: str :param id: Work item ID. :type id: int :param message: The exception message for work item operation in a batch request. :type message: str :param name: Name or title of the work item. :type name: str :param project: Parent project of the deleted work item. :type project: str :param type: Type of work item. :type type: str :param url: REST API URL of the resource :type url: str """ _attribute_map = { 'code': {'key': 'code', 'type': 'int'}, 'deleted_by': {'key': 'deletedBy', 'type': 'str'}, 'deleted_date': {'key': 'deletedDate', 'type': 'str'}, 'id': {'key': 'id', 'type': 'int'}, 'message': {'key': 'message', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'project': {'key': 'project', 'type': 'str'}, 'type': {'key': 'type', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, code=None, deleted_by=None, deleted_date=None, id=None, message=None, name=None, project=None, type=None, url=None): super(WorkItemDeleteReference, self).__init__() self.code = code self.deleted_by = deleted_by self.deleted_date = deleted_date self.id = id self.message = message self.name = name self.project = project self.type = type self.url = url class WorkItemDeleteShallowReference(Model): """WorkItemDeleteShallowReference. :param id: Work item ID. :type id: int :param url: REST API URL of the resource :type url: str """ _attribute_map = { 'id': {'key': 'id', 'type': 'int'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, id=None, url=None): super(WorkItemDeleteShallowReference, self).__init__() self.id = id self.url = url class WorkItemDeleteUpdate(Model): """WorkItemDeleteUpdate. :param is_deleted: Sets a value indicating whether this work item is deleted. :type is_deleted: bool """ _attribute_map = { 'is_deleted': {'key': 'isDeleted', 'type': 'bool'} } def __init__(self, is_deleted=None): super(WorkItemDeleteUpdate, self).__init__() self.is_deleted = is_deleted class WorkItemFieldOperation(Model): """WorkItemFieldOperation. :param name: Name of the operation. :type name: str :param reference_name: Reference name of the operation. :type reference_name: str """ _attribute_map = { 'name': {'key': 'name', 'type': 'str'}, 'reference_name': {'key': 'referenceName', 'type': 'str'} } def __init__(self, name=None, reference_name=None): super(WorkItemFieldOperation, self).__init__() self.name = name self.reference_name = reference_name class WorkItemFieldReference(Model): """WorkItemFieldReference. :param name: The name of the field. :type name: str :param reference_name: The reference name of the field. :type reference_name: str :param url: The REST URL of the resource. :type url: str """ _attribute_map = { 'name': {'key': 'name', 'type': 'str'}, 'reference_name': {'key': 'referenceName', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, name=None, reference_name=None, url=None): super(WorkItemFieldReference, self).__init__() self.name = name self.reference_name = reference_name self.url = url class WorkItemFieldUpdate(Model): """WorkItemFieldUpdate. :param new_value: The new value of the field. :type new_value: object :param old_value: The old value of the field. :type old_value: object """ _attribute_map = { 'new_value': {'key': 'newValue', 'type': 'object'}, 'old_value': {'key': 'oldValue', 'type': 'object'} } def __init__(self, new_value=None, old_value=None): super(WorkItemFieldUpdate, self).__init__() self.new_value = new_value self.old_value = old_value class WorkItemIcon(Model): """WorkItemIcon. :param id: The identifier of the icon. :type id: str :param url: The REST URL of the resource. :type url: str """ _attribute_map = { 'id': {'key': 'id', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, id=None, url=None): super(WorkItemIcon, self).__init__() self.id = id self.url = url class WorkItemLink(Model): """WorkItemLink. :param rel: The type of link. :type rel: str :param source: The source work item. :type source: :class:`WorkItemReference ` :param target: The target work item. :type target: :class:`WorkItemReference ` """ _attribute_map = { 'rel': {'key': 'rel', 'type': 'str'}, 'source': {'key': 'source', 'type': 'WorkItemReference'}, 'target': {'key': 'target', 'type': 'WorkItemReference'} } def __init__(self, rel=None, source=None, target=None): super(WorkItemLink, self).__init__() self.rel = rel self.source = source self.target = target class WorkItemNextStateOnTransition(Model): """WorkItemNextStateOnTransition. :param error_code: Error code if there is no next state transition possible. :type error_code: str :param id: Work item ID. :type id: int :param message: Error message if there is no next state transition possible. :type message: str :param state_on_transition: Name of the next state on transition. :type state_on_transition: str """ _attribute_map = { 'error_code': {'key': 'errorCode', 'type': 'str'}, 'id': {'key': 'id', 'type': 'int'}, 'message': {'key': 'message', 'type': 'str'}, 'state_on_transition': {'key': 'stateOnTransition', 'type': 'str'} } def __init__(self, error_code=None, id=None, message=None, state_on_transition=None): super(WorkItemNextStateOnTransition, self).__init__() self.error_code = error_code self.id = id self.message = message self.state_on_transition = state_on_transition class WorkItemQueryClause(Model): """WorkItemQueryClause. :param clauses: Child clauses if the current clause is a logical operator :type clauses: list of :class:`WorkItemQueryClause ` :param field: Field associated with condition :type field: :class:`WorkItemFieldReference ` :param field_value: Right side of the condition when a field to field comparison :type field_value: :class:`WorkItemFieldReference ` :param is_field_value: Determines if this is a field to field comparison :type is_field_value: bool :param logical_operator: Logical operator separating the condition clause :type logical_operator: object :param operator: The field operator :type operator: :class:`WorkItemFieldOperation ` :param value: Right side of the condition when a field to value comparison :type value: str """ _attribute_map = { 'clauses': {'key': 'clauses', 'type': '[WorkItemQueryClause]'}, 'field': {'key': 'field', 'type': 'WorkItemFieldReference'}, 'field_value': {'key': 'fieldValue', 'type': 'WorkItemFieldReference'}, 'is_field_value': {'key': 'isFieldValue', 'type': 'bool'}, 'logical_operator': {'key': 'logicalOperator', 'type': 'object'}, 'operator': {'key': 'operator', 'type': 'WorkItemFieldOperation'}, 'value': {'key': 'value', 'type': 'str'} } def __init__(self, clauses=None, field=None, field_value=None, is_field_value=None, logical_operator=None, operator=None, value=None): super(WorkItemQueryClause, self).__init__() self.clauses = clauses self.field = field self.field_value = field_value self.is_field_value = is_field_value self.logical_operator = logical_operator self.operator = operator self.value = value class WorkItemQueryResult(Model): """WorkItemQueryResult. :param as_of: The date the query was run in the context of. :type as_of: datetime :param columns: The columns of the query. :type columns: list of :class:`WorkItemFieldReference ` :param query_result_type: The result type :type query_result_type: object :param query_type: The type of the query :type query_type: object :param sort_columns: The sort columns of the query. :type sort_columns: list of :class:`WorkItemQuerySortColumn ` :param work_item_relations: The work item links returned by the query. :type work_item_relations: list of :class:`WorkItemLink ` :param work_items: The work items returned by the query. :type work_items: list of :class:`WorkItemReference ` """ _attribute_map = { 'as_of': {'key': 'asOf', 'type': 'iso-8601'}, 'columns': {'key': 'columns', 'type': '[WorkItemFieldReference]'}, 'query_result_type': {'key': 'queryResultType', 'type': 'object'}, 'query_type': {'key': 'queryType', 'type': 'object'}, 'sort_columns': {'key': 'sortColumns', 'type': '[WorkItemQuerySortColumn]'}, 'work_item_relations': {'key': 'workItemRelations', 'type': '[WorkItemLink]'}, 'work_items': {'key': 'workItems', 'type': '[WorkItemReference]'} } def __init__(self, as_of=None, columns=None, query_result_type=None, query_type=None, sort_columns=None, work_item_relations=None, work_items=None): super(WorkItemQueryResult, self).__init__() self.as_of = as_of self.columns = columns self.query_result_type = query_result_type self.query_type = query_type self.sort_columns = sort_columns self.work_item_relations = work_item_relations self.work_items = work_items class WorkItemQuerySortColumn(Model): """WorkItemQuerySortColumn. :param descending: The direction to sort by. :type descending: bool :param field: A work item field. :type field: :class:`WorkItemFieldReference ` """ _attribute_map = { 'descending': {'key': 'descending', 'type': 'bool'}, 'field': {'key': 'field', 'type': 'WorkItemFieldReference'} } def __init__(self, descending=None, field=None): super(WorkItemQuerySortColumn, self).__init__() self.descending = descending self.field = field class WorkItemReference(Model): """WorkItemReference. :param id: Work item ID. :type id: int :param url: REST API URL of the resource :type url: str """ _attribute_map = { 'id': {'key': 'id', 'type': 'int'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, id=None, url=None): super(WorkItemReference, self).__init__() self.id = id self.url = url class WorkItemRelation(Link): """WorkItemRelation. :param attributes: Collection of link attributes. :type attributes: dict :param rel: Relation type. :type rel: str :param url: Link url. :type url: str """ _attribute_map = { 'attributes': {'key': 'attributes', 'type': '{object}'}, 'rel': {'key': 'rel', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'}, } def __init__(self, attributes=None, rel=None, url=None): super(WorkItemRelation, self).__init__(attributes=attributes, rel=rel, url=url) class WorkItemRelationUpdates(Model): """WorkItemRelationUpdates. :param added: List of newly added relations. :type added: list of :class:`WorkItemRelation ` :param removed: List of removed relations. :type removed: list of :class:`WorkItemRelation ` :param updated: List of updated relations. :type updated: list of :class:`WorkItemRelation ` """ _attribute_map = { 'added': {'key': 'added', 'type': '[WorkItemRelation]'}, 'removed': {'key': 'removed', 'type': '[WorkItemRelation]'}, 'updated': {'key': 'updated', 'type': '[WorkItemRelation]'} } def __init__(self, added=None, removed=None, updated=None): super(WorkItemRelationUpdates, self).__init__() self.added = added self.removed = removed self.updated = updated class WorkItemStateColor(Model): """WorkItemStateColor. :param category: Category of state :type category: str :param color: Color value :type color: str :param name: Work item type state name :type name: str """ _attribute_map = { 'category': {'key': 'category', 'type': 'str'}, 'color': {'key': 'color', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'} } def __init__(self, category=None, color=None, name=None): super(WorkItemStateColor, self).__init__() self.category = category self.color = color self.name = name class WorkItemStateTransition(Model): """WorkItemStateTransition. :param actions: Gets a list of actions needed to transition to that state. :type actions: list of str :param to: Name of the next state. :type to: str """ _attribute_map = { 'actions': {'key': 'actions', 'type': '[str]'}, 'to': {'key': 'to', 'type': 'str'} } def __init__(self, actions=None, to=None): super(WorkItemStateTransition, self).__init__() self.actions = actions self.to = to class WorkItemTrackingResourceReference(Model): """WorkItemTrackingResourceReference. :param url: :type url: str """ _attribute_map = { 'url': {'key': 'url', 'type': 'str'} } def __init__(self, url=None): super(WorkItemTrackingResourceReference, self).__init__() self.url = url class WorkItemTypeColor(Model): """WorkItemTypeColor. :param primary_color: Gets or sets the color of the primary. :type primary_color: str :param secondary_color: Gets or sets the color of the secondary. :type secondary_color: str :param work_item_type_name: The name of the work item type. :type work_item_type_name: str """ _attribute_map = { 'primary_color': {'key': 'primaryColor', 'type': 'str'}, 'secondary_color': {'key': 'secondaryColor', 'type': 'str'}, 'work_item_type_name': {'key': 'workItemTypeName', 'type': 'str'} } def __init__(self, primary_color=None, secondary_color=None, work_item_type_name=None): super(WorkItemTypeColor, self).__init__() self.primary_color = primary_color self.secondary_color = secondary_color self.work_item_type_name = work_item_type_name class WorkItemTypeColorAndIcon(Model): """WorkItemTypeColorAndIcon. :param color: The color of the work item type in hex format. :type color: str :param icon: Tthe work item type icon. :type icon: str :param work_item_type_name: The name of the work item type. :type work_item_type_name: str """ _attribute_map = { 'color': {'key': 'color', 'type': 'str'}, 'icon': {'key': 'icon', 'type': 'str'}, 'work_item_type_name': {'key': 'workItemTypeName', 'type': 'str'} } def __init__(self, color=None, icon=None, work_item_type_name=None): super(WorkItemTypeColorAndIcon, self).__init__() self.color = color self.icon = icon self.work_item_type_name = work_item_type_name class WorkItemTypeFieldInstanceBase(WorkItemFieldReference): """WorkItemTypeFieldInstanceBase. :param name: The name of the field. :type name: str :param reference_name: The reference name of the field. :type reference_name: str :param url: The REST URL of the resource. :type url: str :param always_required: Indicates whether field value is always required. :type always_required: bool :param dependent_fields: The list of dependent fields. :type dependent_fields: list of :class:`WorkItemFieldReference ` :param help_text: Gets the help text for the field. :type help_text: str """ _attribute_map = { 'name': {'key': 'name', 'type': 'str'}, 'reference_name': {'key': 'referenceName', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'}, 'always_required': {'key': 'alwaysRequired', 'type': 'bool'}, 'dependent_fields': {'key': 'dependentFields', 'type': '[WorkItemFieldReference]'}, 'help_text': {'key': 'helpText', 'type': 'str'} } def __init__(self, name=None, reference_name=None, url=None, always_required=None, dependent_fields=None, help_text=None): super(WorkItemTypeFieldInstanceBase, self).__init__(name=name, reference_name=reference_name, url=url) self.always_required = always_required self.dependent_fields = dependent_fields self.help_text = help_text class WorkItemTypeFieldWithReferences(WorkItemTypeFieldInstanceBase): """WorkItemTypeFieldWithReferences. :param name: The name of the field. :type name: str :param reference_name: The reference name of the field. :type reference_name: str :param url: The REST URL of the resource. :type url: str :param always_required: Indicates whether field value is always required. :type always_required: bool :param dependent_fields: The list of dependent fields. :type dependent_fields: list of :class:`WorkItemFieldReference ` :param help_text: Gets the help text for the field. :type help_text: str :param allowed_values: The list of field allowed values. :type allowed_values: list of object :param default_value: Represents the default value of the field. :type default_value: object """ _attribute_map = { 'name': {'key': 'name', 'type': 'str'}, 'reference_name': {'key': 'referenceName', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'}, 'always_required': {'key': 'alwaysRequired', 'type': 'bool'}, 'dependent_fields': {'key': 'dependentFields', 'type': '[WorkItemFieldReference]'}, 'help_text': {'key': 'helpText', 'type': 'str'}, 'allowed_values': {'key': 'allowedValues', 'type': '[object]'}, 'default_value': {'key': 'defaultValue', 'type': 'object'} } def __init__(self, name=None, reference_name=None, url=None, always_required=None, dependent_fields=None, help_text=None, allowed_values=None, default_value=None): super(WorkItemTypeFieldWithReferences, self).__init__(name=name, reference_name=reference_name, url=url, always_required=always_required, dependent_fields=dependent_fields, help_text=help_text) self.allowed_values = allowed_values self.default_value = default_value class WorkItemTypeReference(WorkItemTrackingResourceReference): """WorkItemTypeReference. :param url: :type url: str :param name: Name of the work item type. :type name: str """ _attribute_map = { 'url': {'key': 'url', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'} } def __init__(self, url=None, name=None): super(WorkItemTypeReference, self).__init__(url=url) self.name = name class WorkItemTypeStateColors(Model): """WorkItemTypeStateColors. :param state_colors: Work item type state colors :type state_colors: list of :class:`WorkItemStateColor ` :param work_item_type_name: Work item type name :type work_item_type_name: str """ _attribute_map = { 'state_colors': {'key': 'stateColors', 'type': '[WorkItemStateColor]'}, 'work_item_type_name': {'key': 'workItemTypeName', 'type': 'str'} } def __init__(self, state_colors=None, work_item_type_name=None): super(WorkItemTypeStateColors, self).__init__() self.state_colors = state_colors self.work_item_type_name = work_item_type_name class WorkItemTypeTemplate(Model): """WorkItemTypeTemplate. :param template: XML template in string format. :type template: str """ _attribute_map = { 'template': {'key': 'template', 'type': 'str'} } def __init__(self, template=None): super(WorkItemTypeTemplate, self).__init__() self.template = template class WorkItemTypeTemplateUpdateModel(Model): """WorkItemTypeTemplateUpdateModel. :param action_type: Describes the type of the action for the update request. :type action_type: object :param methodology: Methodology to which the template belongs, eg. Agile, Scrum, CMMI. :type methodology: str :param template: String representation of the work item type template. :type template: str :param template_type: The type of the template described in the request body. :type template_type: object """ _attribute_map = { 'action_type': {'key': 'actionType', 'type': 'object'}, 'methodology': {'key': 'methodology', 'type': 'str'}, 'template': {'key': 'template', 'type': 'str'}, 'template_type': {'key': 'templateType', 'type': 'object'} } def __init__(self, action_type=None, methodology=None, template=None, template_type=None): super(WorkItemTypeTemplateUpdateModel, self).__init__() self.action_type = action_type self.methodology = methodology self.template = template self.template_type = template_type - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - azure-devops/azext_devops/devops_sdk/v5_1/work_item_tracking/models.py [247:1414]: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - class FieldsToEvaluate(Model): """ Describes a set fields for rule evaluation. :param fields: List of fields to evaluate. :type fields: list of str :param field_updates: Updated field values to evaluate. :type field_updates: dict :param field_values: Initial field values. :type field_values: dict :param rules_from: URL of the work item type for which the rules need to be executed. :type rules_from: list of str """ _attribute_map = { 'fields': {'key': 'fields', 'type': '[str]'}, 'field_updates': {'key': 'fieldUpdates', 'type': '{object}'}, 'field_values': {'key': 'fieldValues', 'type': '{object}'}, 'rules_from': {'key': 'rulesFrom', 'type': '[str]'} } def __init__(self, fields=None, field_updates=None, field_values=None, rules_from=None): super(FieldsToEvaluate, self).__init__() self.fields = fields self.field_updates = field_updates self.field_values = field_values self.rules_from = rules_from class GraphSubjectBase(Model): """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. :type descriptor: str :param display_name: This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider. :type display_name: str :param url: This url is the full route to the source resource of this graph subject. :type url: str """ _attribute_map = { '_links': {'key': '_links', 'type': 'ReferenceLinks'}, 'descriptor': {'key': 'descriptor', 'type': 'str'}, 'display_name': {'key': 'displayName', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, _links=None, descriptor=None, display_name=None, url=None): super(GraphSubjectBase, self).__init__() self._links = _links self.descriptor = descriptor self.display_name = display_name self.url = url class IdentityRef(GraphSubjectBase): """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. :type descriptor: str :param display_name: This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider. :type display_name: str :param url: This url is the full route to the source resource of this graph subject. :type url: str :param directory_alias: Deprecated - Can be retrieved by querying the Graph user referenced in the "self" entry of the IdentityRef "_links" dictionary :type directory_alias: str :param id: :type id: str :param image_url: Deprecated - Available in the "avatar" entry of the IdentityRef "_links" dictionary :type image_url: str :param inactive: Deprecated - Can be retrieved by querying the Graph membership state referenced in the "membershipState" entry of the GraphUser "_links" dictionary :type inactive: bool :param is_aad_identity: Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) :type is_aad_identity: bool :param is_container: Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType) :type is_container: bool :param is_deleted_in_origin: :type is_deleted_in_origin: bool :param profile_url: Deprecated - not in use in most preexisting implementations of ToIdentityRef :type profile_url: str :param unique_name: Deprecated - use Domain+PrincipalName instead :type unique_name: str """ _attribute_map = { '_links': {'key': '_links', 'type': 'ReferenceLinks'}, 'descriptor': {'key': 'descriptor', 'type': 'str'}, 'display_name': {'key': 'displayName', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'}, 'directory_alias': {'key': 'directoryAlias', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'image_url': {'key': 'imageUrl', 'type': 'str'}, 'inactive': {'key': 'inactive', 'type': 'bool'}, 'is_aad_identity': {'key': 'isAadIdentity', 'type': 'bool'}, 'is_container': {'key': 'isContainer', 'type': 'bool'}, 'is_deleted_in_origin': {'key': 'isDeletedInOrigin', 'type': 'bool'}, 'profile_url': {'key': 'profileUrl', 'type': 'str'}, 'unique_name': {'key': 'uniqueName', 'type': 'str'} } def __init__(self, _links=None, descriptor=None, display_name=None, url=None, directory_alias=None, id=None, image_url=None, inactive=None, is_aad_identity=None, is_container=None, is_deleted_in_origin=None, profile_url=None, unique_name=None): super(IdentityRef, self).__init__(_links=_links, descriptor=descriptor, display_name=display_name, url=url) self.directory_alias = directory_alias self.id = id self.image_url = image_url self.inactive = inactive self.is_aad_identity = is_aad_identity self.is_container = is_container self.is_deleted_in_origin = is_deleted_in_origin self.profile_url = profile_url self.unique_name = unique_name class IdentityReference(IdentityRef): """ Describes a reference to an identity. :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. :type descriptor: str :param display_name: This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider. :type display_name: str :param url: This url is the full route to the source resource of this graph subject. :type url: str :param directory_alias: Deprecated - Can be retrieved by querying the Graph user referenced in the "self" entry of the IdentityRef "_links" dictionary :type directory_alias: str :param image_url: Deprecated - Available in the "avatar" entry of the IdentityRef "_links" dictionary :type image_url: str :param inactive: Deprecated - Can be retrieved by querying the Graph membership state referenced in the "membershipState" entry of the GraphUser "_links" dictionary :type inactive: bool :param is_aad_identity: Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) :type is_aad_identity: bool :param is_container: Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType) :type is_container: bool :param is_deleted_in_origin: :type is_deleted_in_origin: bool :param profile_url: Deprecated - not in use in most preexisting implementations of ToIdentityRef :type profile_url: str :param unique_name: Deprecated - use Domain+PrincipalName instead :type unique_name: str :param id: :type id: str :param name: Legacy back-compat property. This has been the WIT specific value from Constants. Will be hidden (but exists) on the client unless they are targeting the newest version :type name: str """ _attribute_map = { '_links': {'key': '_links', 'type': 'ReferenceLinks'}, 'descriptor': {'key': 'descriptor', 'type': 'str'}, 'display_name': {'key': 'displayName', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'}, 'directory_alias': {'key': 'directoryAlias', 'type': 'str'}, 'image_url': {'key': 'imageUrl', 'type': 'str'}, 'inactive': {'key': 'inactive', 'type': 'bool'}, 'is_aad_identity': {'key': 'isAadIdentity', 'type': 'bool'}, 'is_container': {'key': 'isContainer', 'type': 'bool'}, 'is_deleted_in_origin': {'key': 'isDeletedInOrigin', 'type': 'bool'}, 'profile_url': {'key': 'profileUrl', 'type': 'str'}, 'unique_name': {'key': 'uniqueName', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'} } def __init__(self, _links=None, descriptor=None, display_name=None, url=None, directory_alias=None, image_url=None, inactive=None, is_aad_identity=None, is_container=None, is_deleted_in_origin=None, profile_url=None, unique_name=None, id=None, name=None): super(IdentityReference, self).__init__(_links=_links, descriptor=descriptor, display_name=display_name, url=url, directory_alias=directory_alias, image_url=image_url, inactive=inactive, is_aad_identity=is_aad_identity, is_container=is_container, is_deleted_in_origin=is_deleted_in_origin, profile_url=profile_url, unique_name=unique_name) self.id = id self.name = name class JsonPatchOperation(Model): """ The JSON model for a JSON Patch operation :param from_: The path to copy from for the Move/Copy operation. :type from_: str :param op: The patch operation :type op: object :param path: The path for the operation. In the case of an array, a zero based index can be used to specify the position in the array (e.g. /biscuits/0/name). The "-" character can be used instead of an index to insert at the end of the array (e.g. /biscuits/-). :type path: str :param value: The value for the operation. This is either a primitive or a JToken. :type value: object """ _attribute_map = { 'from_': {'key': 'from', 'type': 'str'}, 'op': {'key': 'op', 'type': 'object'}, 'path': {'key': 'path', 'type': 'str'}, 'value': {'key': 'value', 'type': 'object'} } def __init__(self, from_=None, op=None, path=None, value=None): super(JsonPatchOperation, self).__init__() self.from_ = from_ self.op = op self.path = path self.value = value class Link(Model): """ Link description. :param attributes: Collection of link attributes. :type attributes: dict :param rel: Relation type. :type rel: str :param url: Link url. :type url: str """ _attribute_map = { 'attributes': {'key': 'attributes', 'type': '{object}'}, 'rel': {'key': 'rel', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, attributes=None, rel=None, url=None): super(Link, self).__init__() self.attributes = attributes self.rel = rel self.url = url class ProjectWorkItemStateColors(Model): """ Project work item type state colors :param project_name: Project name :type project_name: str :param work_item_type_state_colors: State colors for all work item type in a project :type work_item_type_state_colors: list of :class:`WorkItemTypeStateColors ` """ _attribute_map = { 'project_name': {'key': 'projectName', 'type': 'str'}, 'work_item_type_state_colors': {'key': 'workItemTypeStateColors', 'type': '[WorkItemTypeStateColors]'} } def __init__(self, project_name=None, work_item_type_state_colors=None): super(ProjectWorkItemStateColors, self).__init__() self.project_name = project_name self.work_item_type_state_colors = work_item_type_state_colors class ProvisioningResult(Model): """ Result of an update work item type XML update operation. :param provisioning_import_events: Details about of the provisioning import events. :type provisioning_import_events: list of str """ _attribute_map = { 'provisioning_import_events': {'key': 'provisioningImportEvents', 'type': '[str]'} } def __init__(self, provisioning_import_events=None): super(ProvisioningResult, self).__init__() self.provisioning_import_events = provisioning_import_events class QueryBatchGetRequest(Model): """ Describes a request to get a list of queries :param expand: The expand parameters for queries. Possible options are { None, Wiql, Clauses, All, Minimal } :type expand: object :param error_policy: The flag to control error policy in a query batch request. Possible options are { Fail, Omit }. :type error_policy: object :param ids: The requested query ids :type ids: list of str """ _attribute_map = { 'expand': {'key': '$expand', 'type': 'object'}, 'error_policy': {'key': 'errorPolicy', 'type': 'object'}, 'ids': {'key': 'ids', 'type': '[str]'} } def __init__(self, expand=None, error_policy=None, ids=None): super(QueryBatchGetRequest, self).__init__() self.expand = expand self.error_policy = error_policy self.ids = ids class QueryHierarchyItemsResult(Model): """ :param count: The count of items. :type count: int :param has_more: Indicates if the max return limit was hit but there are still more items :type has_more: bool :param value: The list of items :type value: list of :class:`QueryHierarchyItem ` """ _attribute_map = { 'count': {'key': 'count', 'type': 'int'}, 'has_more': {'key': 'hasMore', 'type': 'bool'}, 'value': {'key': 'value', 'type': '[QueryHierarchyItem]'} } def __init__(self, count=None, has_more=None, value=None): super(QueryHierarchyItemsResult, self).__init__() self.count = count self.has_more = has_more self.value = value class ReferenceLinks(Model): """ The class to represent a collection of REST reference links. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict """ _attribute_map = { 'links': {'key': 'links', 'type': '{object}'} } def __init__(self, links=None): super(ReferenceLinks, self).__init__() self.links = links class ReportingWorkItemRevisionsFilter(Model): """ The class represents the reporting work item revision filer. :param fields: A list of fields to return in work item revisions. Omit this parameter to get all reportable fields. :type fields: list of str :param include_deleted: Include deleted work item in the result. :type include_deleted: bool :param include_identity_ref: Return an identity reference instead of a string value for identity fields. :type include_identity_ref: bool :param include_latest_only: Include only the latest version of a work item, skipping over all previous revisions of the work item. :type include_latest_only: bool :param include_tag_ref: Include tag reference instead of string value for System.Tags field :type include_tag_ref: bool :param types: A list of types to filter the results to specific work item types. Omit this parameter to get work item revisions of all work item types. :type types: list of str """ _attribute_map = { 'fields': {'key': 'fields', 'type': '[str]'}, 'include_deleted': {'key': 'includeDeleted', 'type': 'bool'}, 'include_identity_ref': {'key': 'includeIdentityRef', 'type': 'bool'}, 'include_latest_only': {'key': 'includeLatestOnly', 'type': 'bool'}, 'include_tag_ref': {'key': 'includeTagRef', 'type': 'bool'}, 'types': {'key': 'types', 'type': '[str]'} } def __init__(self, fields=None, include_deleted=None, include_identity_ref=None, include_latest_only=None, include_tag_ref=None, types=None): super(ReportingWorkItemRevisionsFilter, self).__init__() self.fields = fields self.include_deleted = include_deleted self.include_identity_ref = include_identity_ref self.include_latest_only = include_latest_only self.include_tag_ref = include_tag_ref self.types = types class StreamedBatch(Model): """ The class describes reporting work item revision batch. :param continuation_token: ContinuationToken acts as a waterMark. Used while querying large results. :type continuation_token: str :param is_last_batch: Returns 'true' if it's last batch, 'false' otherwise. :type is_last_batch: bool :param next_link: The next link for the work item. :type next_link: str :param values: Values such as rel, sourceId, TargetId, ChangedDate, isActive. :type values: list of object """ _attribute_map = { 'continuation_token': {'key': 'continuationToken', 'type': 'str'}, 'is_last_batch': {'key': 'isLastBatch', 'type': 'bool'}, 'next_link': {'key': 'nextLink', 'type': 'str'}, 'values': {'key': 'values', 'type': '[object]'} } def __init__(self, continuation_token=None, is_last_batch=None, next_link=None, values=None): super(StreamedBatch, self).__init__() self.continuation_token = continuation_token self.is_last_batch = is_last_batch self.next_link = next_link self.values = values class TeamContext(Model): """ The Team Context for an operation. :param project: The team project Id or name. Ignored if ProjectId is set. :type project: str :param project_id: The Team Project ID. Required if Project is not set. :type project_id: str :param team: The Team Id or name. Ignored if TeamId is set. :type team: str :param team_id: The Team Id :type team_id: str """ _attribute_map = { 'project': {'key': 'project', 'type': 'str'}, 'project_id': {'key': 'projectId', 'type': 'str'}, 'team': {'key': 'team', 'type': 'str'}, 'team_id': {'key': 'teamId', 'type': 'str'} } def __init__(self, project=None, project_id=None, team=None, team_id=None): super(TeamContext, self).__init__() self.project = project self.project_id = project_id self.team = team self.team_id = team_id class Wiql(Model): """ A WIQL query :param query: The text of the WIQL query :type query: str """ _attribute_map = { 'query': {'key': 'query', 'type': 'str'} } def __init__(self, query=None): super(Wiql, self).__init__() self.query = query class WorkArtifactLink(Model): """ A work artifact link describes an outbound artifact link type. :param artifact_type: Target artifact type. :type artifact_type: str :param link_type: Outbound link type. :type link_type: str :param tool_type: Target tool type. :type tool_type: str """ _attribute_map = { 'artifact_type': {'key': 'artifactType', 'type': 'str'}, 'link_type': {'key': 'linkType', 'type': 'str'}, 'tool_type': {'key': 'toolType', 'type': 'str'} } def __init__(self, artifact_type=None, link_type=None, tool_type=None): super(WorkArtifactLink, self).__init__() self.artifact_type = artifact_type self.link_type = link_type self.tool_type = tool_type class WorkItemBatchGetRequest(Model): """ Describes a request to get a set of work items :param expand: The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All } :type expand: object :param as_of: AsOf UTC date time string :type as_of: datetime :param error_policy: The flag to control error policy in a bulk get work items request. Possible options are {Fail, Omit}. :type error_policy: object :param fields: The requested fields :type fields: list of str :param ids: The requested work item ids :type ids: list of int """ _attribute_map = { 'expand': {'key': '$expand', 'type': 'object'}, 'as_of': {'key': 'asOf', 'type': 'iso-8601'}, 'error_policy': {'key': 'errorPolicy', 'type': 'object'}, 'fields': {'key': 'fields', 'type': '[str]'}, 'ids': {'key': 'ids', 'type': '[int]'} } def __init__(self, expand=None, as_of=None, error_policy=None, fields=None, ids=None): super(WorkItemBatchGetRequest, self).__init__() self.expand = expand self.as_of = as_of self.error_policy = error_policy self.fields = fields self.ids = ids class WorkItemDeleteReference(Model): """ Reference to a deleted work item. :param code: The HTTP status code for work item operation in a batch request. :type code: int :param deleted_by: The user who deleted the work item type. :type deleted_by: str :param deleted_date: The work item deletion date. :type deleted_date: str :param id: Work item ID. :type id: int :param message: The exception message for work item operation in a batch request. :type message: str :param name: Name or title of the work item. :type name: str :param project: Parent project of the deleted work item. :type project: str :param type: Type of work item. :type type: str :param url: REST API URL of the resource :type url: str """ _attribute_map = { 'code': {'key': 'code', 'type': 'int'}, 'deleted_by': {'key': 'deletedBy', 'type': 'str'}, 'deleted_date': {'key': 'deletedDate', 'type': 'str'}, 'id': {'key': 'id', 'type': 'int'}, 'message': {'key': 'message', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'project': {'key': 'project', 'type': 'str'}, 'type': {'key': 'type', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, code=None, deleted_by=None, deleted_date=None, id=None, message=None, name=None, project=None, type=None, url=None): super(WorkItemDeleteReference, self).__init__() self.code = code self.deleted_by = deleted_by self.deleted_date = deleted_date self.id = id self.message = message self.name = name self.project = project self.type = type self.url = url class WorkItemDeleteShallowReference(Model): """ Shallow Reference to a deleted work item. :param id: Work item ID. :type id: int :param url: REST API URL of the resource :type url: str """ _attribute_map = { 'id': {'key': 'id', 'type': 'int'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, id=None, url=None): super(WorkItemDeleteShallowReference, self).__init__() self.id = id self.url = url class WorkItemDeleteUpdate(Model): """ Describes an update request for a deleted work item. :param is_deleted: Sets a value indicating whether this work item is deleted. :type is_deleted: bool """ _attribute_map = { 'is_deleted': {'key': 'isDeleted', 'type': 'bool'} } def __init__(self, is_deleted=None): super(WorkItemDeleteUpdate, self).__init__() self.is_deleted = is_deleted class WorkItemFieldOperation(Model): """ Describes a work item field operation. :param name: Friendly name of the operation. :type name: str :param reference_name: Reference name of the operation. :type reference_name: str """ _attribute_map = { 'name': {'key': 'name', 'type': 'str'}, 'reference_name': {'key': 'referenceName', 'type': 'str'} } def __init__(self, name=None, reference_name=None): super(WorkItemFieldOperation, self).__init__() self.name = name self.reference_name = reference_name class WorkItemFieldReference(Model): """ Reference to a field in a work item :param name: The friendly name of the field. :type name: str :param reference_name: The reference name of the field. :type reference_name: str :param url: The REST URL of the resource. :type url: str """ _attribute_map = { 'name': {'key': 'name', 'type': 'str'}, 'reference_name': {'key': 'referenceName', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, name=None, reference_name=None, url=None): super(WorkItemFieldReference, self).__init__() self.name = name self.reference_name = reference_name self.url = url class WorkItemFieldUpdate(Model): """ Describes an update to a work item field. :param new_value: The new value of the field. :type new_value: object :param old_value: The old value of the field. :type old_value: object """ _attribute_map = { 'new_value': {'key': 'newValue', 'type': 'object'}, 'old_value': {'key': 'oldValue', 'type': 'object'} } def __init__(self, new_value=None, old_value=None): super(WorkItemFieldUpdate, self).__init__() self.new_value = new_value self.old_value = old_value class WorkItemIcon(Model): """ Reference to a work item icon. :param id: The identifier of the icon. :type id: str :param url: The REST URL of the resource. :type url: str """ _attribute_map = { 'id': {'key': 'id', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, id=None, url=None): super(WorkItemIcon, self).__init__() self.id = id self.url = url class WorkItemLink(Model): """ A link between two work items. :param rel: The type of link. :type rel: str :param source: The source work item. :type source: :class:`WorkItemReference ` :param target: The target work item. :type target: :class:`WorkItemReference ` """ _attribute_map = { 'rel': {'key': 'rel', 'type': 'str'}, 'source': {'key': 'source', 'type': 'WorkItemReference'}, 'target': {'key': 'target', 'type': 'WorkItemReference'} } def __init__(self, rel=None, source=None, target=None): super(WorkItemLink, self).__init__() self.rel = rel self.source = source self.target = target class WorkItemNextStateOnTransition(Model): """ Describes the next state for a work item. :param error_code: Error code if there is no next state transition possible. :type error_code: str :param id: Work item ID. :type id: int :param message: Error message if there is no next state transition possible. :type message: str :param state_on_transition: Name of the next state on transition. :type state_on_transition: str """ _attribute_map = { 'error_code': {'key': 'errorCode', 'type': 'str'}, 'id': {'key': 'id', 'type': 'int'}, 'message': {'key': 'message', 'type': 'str'}, 'state_on_transition': {'key': 'stateOnTransition', 'type': 'str'} } def __init__(self, error_code=None, id=None, message=None, state_on_transition=None): super(WorkItemNextStateOnTransition, self).__init__() self.error_code = error_code self.id = id self.message = message self.state_on_transition = state_on_transition class WorkItemQueryClause(Model): """ Represents a clause in a work item query. This shows the structure of a work item query. :param clauses: Child clauses if the current clause is a logical operator :type clauses: list of :class:`WorkItemQueryClause ` :param field: Field associated with condition :type field: :class:`WorkItemFieldReference ` :param field_value: Right side of the condition when a field to field comparison :type field_value: :class:`WorkItemFieldReference ` :param is_field_value: Determines if this is a field to field comparison :type is_field_value: bool :param logical_operator: Logical operator separating the condition clause :type logical_operator: object :param operator: The field operator :type operator: :class:`WorkItemFieldOperation ` :param value: Right side of the condition when a field to value comparison :type value: str """ _attribute_map = { 'clauses': {'key': 'clauses', 'type': '[WorkItemQueryClause]'}, 'field': {'key': 'field', 'type': 'WorkItemFieldReference'}, 'field_value': {'key': 'fieldValue', 'type': 'WorkItemFieldReference'}, 'is_field_value': {'key': 'isFieldValue', 'type': 'bool'}, 'logical_operator': {'key': 'logicalOperator', 'type': 'object'}, 'operator': {'key': 'operator', 'type': 'WorkItemFieldOperation'}, 'value': {'key': 'value', 'type': 'str'} } def __init__(self, clauses=None, field=None, field_value=None, is_field_value=None, logical_operator=None, operator=None, value=None): super(WorkItemQueryClause, self).__init__() self.clauses = clauses self.field = field self.field_value = field_value self.is_field_value = is_field_value self.logical_operator = logical_operator self.operator = operator self.value = value class WorkItemQueryResult(Model): """ The result of a work item query. :param as_of: The date the query was run in the context of. :type as_of: datetime :param columns: The columns of the query. :type columns: list of :class:`WorkItemFieldReference ` :param query_result_type: The result type :type query_result_type: object :param query_type: The type of the query :type query_type: object :param sort_columns: The sort columns of the query. :type sort_columns: list of :class:`WorkItemQuerySortColumn ` :param work_item_relations: The work item links returned by the query. :type work_item_relations: list of :class:`WorkItemLink ` :param work_items: The work items returned by the query. :type work_items: list of :class:`WorkItemReference ` """ _attribute_map = { 'as_of': {'key': 'asOf', 'type': 'iso-8601'}, 'columns': {'key': 'columns', 'type': '[WorkItemFieldReference]'}, 'query_result_type': {'key': 'queryResultType', 'type': 'object'}, 'query_type': {'key': 'queryType', 'type': 'object'}, 'sort_columns': {'key': 'sortColumns', 'type': '[WorkItemQuerySortColumn]'}, 'work_item_relations': {'key': 'workItemRelations', 'type': '[WorkItemLink]'}, 'work_items': {'key': 'workItems', 'type': '[WorkItemReference]'} } def __init__(self, as_of=None, columns=None, query_result_type=None, query_type=None, sort_columns=None, work_item_relations=None, work_items=None): super(WorkItemQueryResult, self).__init__() self.as_of = as_of self.columns = columns self.query_result_type = query_result_type self.query_type = query_type self.sort_columns = sort_columns self.work_item_relations = work_item_relations self.work_items = work_items class WorkItemQuerySortColumn(Model): """ A sort column. :param descending: The direction to sort by. :type descending: bool :param field: A work item field. :type field: :class:`WorkItemFieldReference ` """ _attribute_map = { 'descending': {'key': 'descending', 'type': 'bool'}, 'field': {'key': 'field', 'type': 'WorkItemFieldReference'} } def __init__(self, descending=None, field=None): super(WorkItemQuerySortColumn, self).__init__() self.descending = descending self.field = field class WorkItemReference(Model): """ Contains reference to a work item. :param id: Work item ID. :type id: int :param url: REST API URL of the resource :type url: str """ _attribute_map = { 'id': {'key': 'id', 'type': 'int'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, id=None, url=None): super(WorkItemReference, self).__init__() self.id = id self.url = url class WorkItemRelation(Link): """ :param attributes: Collection of link attributes. :type attributes: dict :param rel: Relation type. :type rel: str :param url: Link url. :type url: str """ _attribute_map = { 'attributes': {'key': 'attributes', 'type': '{object}'}, 'rel': {'key': 'rel', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'}, } def __init__(self, attributes=None, rel=None, url=None): super(WorkItemRelation, self).__init__(attributes=attributes, rel=rel, url=url) class WorkItemRelationUpdates(Model): """ Describes updates to a work item's relations. :param added: List of newly added relations. :type added: list of :class:`WorkItemRelation ` :param removed: List of removed relations. :type removed: list of :class:`WorkItemRelation ` :param updated: List of updated relations. :type updated: list of :class:`WorkItemRelation ` """ _attribute_map = { 'added': {'key': 'added', 'type': '[WorkItemRelation]'}, 'removed': {'key': 'removed', 'type': '[WorkItemRelation]'}, 'updated': {'key': 'updated', 'type': '[WorkItemRelation]'} } def __init__(self, added=None, removed=None, updated=None): super(WorkItemRelationUpdates, self).__init__() self.added = added self.removed = removed self.updated = updated class WorkItemStateColor(Model): """ Work item type state name, color and state category :param category: Category of state :type category: str :param color: Color value :type color: str :param name: Work item type state name :type name: str """ _attribute_map = { 'category': {'key': 'category', 'type': 'str'}, 'color': {'key': 'color', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'} } def __init__(self, category=None, color=None, name=None): super(WorkItemStateColor, self).__init__() self.category = category self.color = color self.name = name class WorkItemStateTransition(Model): """ Describes a state transition in a work item. :param actions: Gets a list of actions needed to transition to that state. :type actions: list of str :param to: Name of the next state. :type to: str """ _attribute_map = { 'actions': {'key': 'actions', 'type': '[str]'}, 'to': {'key': 'to', 'type': 'str'} } def __init__(self, actions=None, to=None): super(WorkItemStateTransition, self).__init__() self.actions = actions self.to = to class WorkItemTrackingResourceReference(Model): """ Base class for work item tracking resource references. :param url: :type url: str """ _attribute_map = { 'url': {'key': 'url', 'type': 'str'} } def __init__(self, url=None): super(WorkItemTrackingResourceReference, self).__init__() self.url = url class WorkItemTypeColor(Model): """ Describes a work item type's colors. :param primary_color: Gets or sets the color of the primary. :type primary_color: str :param secondary_color: Gets or sets the color of the secondary. :type secondary_color: str :param work_item_type_name: The name of the work item type. :type work_item_type_name: str """ _attribute_map = { 'primary_color': {'key': 'primaryColor', 'type': 'str'}, 'secondary_color': {'key': 'secondaryColor', 'type': 'str'}, 'work_item_type_name': {'key': 'workItemTypeName', 'type': 'str'} } def __init__(self, primary_color=None, secondary_color=None, work_item_type_name=None): super(WorkItemTypeColor, self).__init__() self.primary_color = primary_color self.secondary_color = secondary_color self.work_item_type_name = work_item_type_name class WorkItemTypeColorAndIcon(Model): """ Describes work item type nam, its icon and color. :param color: The color of the work item type in hex format. :type color: str :param icon: The work item type icon. :type icon: str :param work_item_type_name: The name of the work item type. :type work_item_type_name: str """ _attribute_map = { 'color': {'key': 'color', 'type': 'str'}, 'icon': {'key': 'icon', 'type': 'str'}, 'work_item_type_name': {'key': 'workItemTypeName', 'type': 'str'} } def __init__(self, color=None, icon=None, work_item_type_name=None): super(WorkItemTypeColorAndIcon, self).__init__() self.color = color self.icon = icon self.work_item_type_name = work_item_type_name class WorkItemTypeFieldInstanceBase(WorkItemFieldReference): """ Base field instance for workItemType fields. :param name: The friendly name of the field. :type name: str :param reference_name: The reference name of the field. :type reference_name: str :param url: The REST URL of the resource. :type url: str :param always_required: Indicates whether field value is always required. :type always_required: bool :param dependent_fields: The list of dependent fields. :type dependent_fields: list of :class:`WorkItemFieldReference ` :param help_text: Gets the help text for the field. :type help_text: str """ _attribute_map = { 'name': {'key': 'name', 'type': 'str'}, 'reference_name': {'key': 'referenceName', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'}, 'always_required': {'key': 'alwaysRequired', 'type': 'bool'}, 'dependent_fields': {'key': 'dependentFields', 'type': '[WorkItemFieldReference]'}, 'help_text': {'key': 'helpText', 'type': 'str'} } def __init__(self, name=None, reference_name=None, url=None, always_required=None, dependent_fields=None, help_text=None): super(WorkItemTypeFieldInstanceBase, self).__init__(name=name, reference_name=reference_name, url=url) self.always_required = always_required self.dependent_fields = dependent_fields self.help_text = help_text class WorkItemTypeFieldWithReferences(WorkItemTypeFieldInstanceBase): """ Field Instance of a workItemype with detailed references. :param name: The friendly name of the field. :type name: str :param reference_name: The reference name of the field. :type reference_name: str :param url: The REST URL of the resource. :type url: str :param always_required: Indicates whether field value is always required. :type always_required: bool :param dependent_fields: The list of dependent fields. :type dependent_fields: list of :class:`WorkItemFieldReference ` :param help_text: Gets the help text for the field. :type help_text: str :param allowed_values: The list of field allowed values. :type allowed_values: list of object :param default_value: Represents the default value of the field. :type default_value: object """ _attribute_map = { 'name': {'key': 'name', 'type': 'str'}, 'reference_name': {'key': 'referenceName', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'}, 'always_required': {'key': 'alwaysRequired', 'type': 'bool'}, 'dependent_fields': {'key': 'dependentFields', 'type': '[WorkItemFieldReference]'}, 'help_text': {'key': 'helpText', 'type': 'str'}, 'allowed_values': {'key': 'allowedValues', 'type': '[object]'}, 'default_value': {'key': 'defaultValue', 'type': 'object'} } def __init__(self, name=None, reference_name=None, url=None, always_required=None, dependent_fields=None, help_text=None, allowed_values=None, default_value=None): super(WorkItemTypeFieldWithReferences, self).__init__(name=name, reference_name=reference_name, url=url, always_required=always_required, dependent_fields=dependent_fields, help_text=help_text) self.allowed_values = allowed_values self.default_value = default_value class WorkItemTypeReference(WorkItemTrackingResourceReference): """ Reference to a work item type. :param url: :type url: str :param name: Name of the work item type. :type name: str """ _attribute_map = { 'url': {'key': 'url', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'} } def __init__(self, url=None, name=None): super(WorkItemTypeReference, self).__init__(url=url) self.name = name class WorkItemTypeStateColors(Model): """ State colors for a work item type :param state_colors: Work item type state colors :type state_colors: list of :class:`WorkItemStateColor ` :param work_item_type_name: Work item type name :type work_item_type_name: str """ _attribute_map = { 'state_colors': {'key': 'stateColors', 'type': '[WorkItemStateColor]'}, 'work_item_type_name': {'key': 'workItemTypeName', 'type': 'str'} } def __init__(self, state_colors=None, work_item_type_name=None): super(WorkItemTypeStateColors, self).__init__() self.state_colors = state_colors self.work_item_type_name = work_item_type_name class WorkItemTypeTemplate(Model): """ Describes a work item type template. :param template: XML template in string format. :type template: str """ _attribute_map = { 'template': {'key': 'template', 'type': 'str'} } def __init__(self, template=None): super(WorkItemTypeTemplate, self).__init__() self.template = template class WorkItemTypeTemplateUpdateModel(Model): """ Describes a update work item type template request body. :param action_type: Describes the type of the action for the update request. :type action_type: object :param methodology: Methodology to which the template belongs, eg. Agile, Scrum, CMMI. :type methodology: str :param template: String representation of the work item type template. :type template: str :param template_type: The type of the template described in the request body. :type template_type: object """ _attribute_map = { 'action_type': {'key': 'actionType', 'type': 'object'}, 'methodology': {'key': 'methodology', 'type': 'str'}, 'template': {'key': 'template', 'type': 'str'}, 'template_type': {'key': 'templateType', 'type': 'object'} } def __init__(self, action_type=None, methodology=None, template=None, template_type=None): super(WorkItemTypeTemplateUpdateModel, self).__init__() self.action_type = action_type self.methodology = methodology self.template = template self.template_type = template_type - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -