api library

Classes

ActionUpdate
ActionUpdateTypeTransformer
Transformation class that can encode an instance of ActionUpdate to String, and decode dynamic data back to ActionUpdate.
ApiClient
ApiKeyAuth
AssignAttachmentApiModel
AssignIterationApiModel
AttachmentApiResult
AttachmentChangeViewModel
AttachmentChangeViewModelArrayChangedFieldViewModel
AttachmentModel
AttachmentPutModel
AttachmentPutModelAutoTestStepResultsModel
AttachmentsApi
AttachmentUpdateRequest
AuditApiResult
Authentication
AutoTest
AutoTestApiResult
AutoTestAverageDurationModel
AutoTestBulkDeleteApiModel
AutoTestBulkDeleteApiResult
AutoTestChangeViewModel
AutoTestChangeViewModelArrayChangedFieldViewModel
AutoTestClassCountApiModel
AutoTestExtractionApiModel
AutoTestFilterApiModel
AutoTestFilterModel
AutoTestFlakyBulkApiModel
AutoTestIdModel
AutoTestModel
AutoTestModelV2GetModel
AutoTestNamespaceCountApiModel
AutoTestNamespaceModel
AutoTestNamespacesCountResponse
AutoTestOutcome
AutoTestOutcomeTypeTransformer
Transformation class that can encode an instance of AutoTestOutcome to String, and decode dynamic data back to AutoTestOutcome.
AutoTestPostModel
AutoTestProjectSettingsGetModel
AutoTestProjectSettingsPostModel
AutoTestPutModel
AutoTestResultHistoryApiResult
AutoTestResultHistorySelectApiModel
AutotestResultOutcome
AutotestResultOutcomeTypeTransformer
Transformation class that can encode an instance of AutotestResultOutcome to String, and decode dynamic data back to AutotestResultOutcome.
AutoTestResultReasonShort
AutoTestResultsForTestRunModel
AutoTestsApi
AutoTestSearchApiModel
AutoTestSearchIncludeApiModel
AutoTestSelectApiModel
AutoTestSelectModel
AutoTestsExtractionModel
AutoTestShortApiResult
AutoTestStep
AutoTestStepApiResult
AutoTestStepModel
AutoTestStepResult
AutoTestStepResultsApiResult
AutoTestStepResultUpdateRequest
AvailableTestResultOutcome
AvailableTestResultOutcomeTypeTransformer
Transformation class that can encode an instance of AvailableTestResultOutcome to String, and decode dynamic data back to AvailableTestResultOutcome.
BackgroundJobAttachmentModel
BackgroundJobFilterModel
BackgroundJobGetModel
BackgroundJobsApi
BackgroundJobState
BackgroundJobStateTypeTransformer
Transformation class that can encode an instance of BackgroundJobState to String, and decode dynamic data back to BackgroundJobState.
BackgroundJobType
BackgroundJobTypeTypeTransformer
Transformation class that can encode an instance of BackgroundJobType to String, and decode dynamic data back to BackgroundJobType.
BooleanChangedFieldViewModel
BooleanNullableChangedFieldViewModel
CompositeFilter
ConfigurationByParametersModel
ConfigurationExtractionModel
ConfigurationFilterModel
ConfigurationModel
ConfigurationPostModel
ConfigurationPutModel
ConfigurationsApi
ConfigurationSelectModel
ConfigurationShort
ConfigurationShortApiResult
ConfigurationShortModel
CreateDefectApiModel
CreateEmptyTestRunApiModel
CreateLinkApiModel
CreateParameterApiModel
CreateProjectApiModel
CreateStepApiModel
CreateTagApiModel
CreateTestPlanApiModel
CreateTestRunAndFillByAutoTestsApiModel
CreateTestRunAndFillByConfigurationsApiModel
CreateTestRunAndFillByWorkItemsApiModel
CreateTestStatusApiModel
CreateWorkflowApiModel
CreateWorkItemApiModel
CreateWorkItemPreviewsApiModel
CustomAttributeChangeModel
CustomAttributeGetModel
CustomAttributeModel
CustomAttributeOptionModel
CustomAttributeOptionPostModel
CustomAttributePostModel
CustomAttributePutModel
CustomAttributesApi
CustomAttributeSearchQueryModel
CustomAttributeSearchResponseModel
CustomAttributeTemplateModel
CustomAttributeTemplatePostModel
CustomAttributeTemplatePutModel
CustomAttributeTemplatesApi
CustomAttributeTemplateSearchQueryModel
CustomAttributeTemplateValidationResult
CustomAttributeTestPlanProjectRelationPutModel
CustomAttributeTypesEnum
CustomAttributeTypesEnumTypeTransformer
Transformation class that can encode an instance of CustomAttributeTypesEnum to String, and decode dynamic data back to CustomAttributeTypesEnum.
CustomAttributeValidationResult
DateTimeRangeSelectorModel
DefectApiModel
DeletionState
DeletionStateTypeTransformer
Transformation class that can encode an instance of DeletionState to String, and decode dynamic data back to DeletionState.
DemoProjectApiResult
DeserializationMessage
Primarily intended for use in an isolate.
EnableProjectExternalServiceApiModel
ExternalFormAllowedValueModel
ExternalFormCreateModel
ExternalFormFieldModel
ExternalFormLinkModel
ExternalFormModel
ExternalLinkModel
ExternalServiceCategoryApiResult
ExternalServiceCategoryApiResultTypeTransformer
Transformation class that can encode an instance of ExternalServiceCategoryApiResult to String, and decode dynamic data back to ExternalServiceCategoryApiResult.
ExternalServiceMetadataApiResult
ExternalServicesMetadataApiResult
FailureCategory
FailureCategoryModel
FailureCategoryModelTypeTransformer
Transformation class that can encode an instance of FailureCategoryModel to String, and decode dynamic data back to FailureCategoryModel.
FailureCategoryTypeTransformer
Transformation class that can encode an instance of FailureCategory to String, and decode dynamic data back to FailureCategory.
FailureClassModel
FailureClassRegexModel
FilterModel
GenerateWorkItemPreviewsApiModel
GenerateWorkItemPreviewsApiResult
GetExternalFormApiResult
GetShortProjectsApiModel
GetXlsxTestPointsByTestPlanModel
GlobalCustomAttributePostModel
GlobalCustomAttributeUpdateModel
GlobalSearchItemResult
GlobalSearchRequest
GlobalSearchResponse
GuidChangedFieldViewModel
GuidExtractionModel
HttpBasicAuth
HttpBearerAuth
ImageResizeType
ImageResizeTypeTypeTransformer
Transformation class that can encode an instance of ImageResizeType to String, and decode dynamic data back to ImageResizeType.
Inquiry
Int32ChangedFieldViewModel
Int32RangeSelectorModel
Int64ChangedFieldViewModel
Int64RangeSelectorModel
IterationApiResult
IterationModel
Label
LabelApiResult
LabelPostModel
LabelShortModel
LastTestResultApiResult
LastTestResultModel
LinkApiResult
LinkModel
LinkPostModel
LinkPutModel
LinkShort
LinkShortApiResult
LinkShortModel
LinkType
LinkTypeTypeTransformer
Transformation class that can encode an instance of LinkType to String, and decode dynamic data back to LinkType.
ListSortDirection
ListSortDirectionTypeTransformer
Transformation class that can encode an instance of ListSortDirection to String, and decode dynamic data back to ListSortDirection.
LogicalOperator
LogicalOperatorTypeTransformer
Transformation class that can encode an instance of LogicalOperator to String, and decode dynamic data back to LogicalOperator.
ManualRerunApiResult
ManualRerunSelectTestResultsApiModel
ManualRerunTestResultApiModel
NamedEntityApiModel
NotificationModel
NotificationQueryFilterModel
NotificationsApi
NotificationTypeModel
NotificationTypeModelTypeTransformer
Transformation class that can encode an instance of NotificationTypeModel to String, and decode dynamic data back to NotificationTypeModel.
OAuth
Operation
Order
Page
ParameterApiResult
ParameterGroupApiResult
ParameterGroupsFilterApiModel
ParameterIterationModel
ParametersApi
ParametersFilterApiModel
ParameterShortApiResult
ParameterShortModel
PeriodViewModel
PeriodViewModelChangedFieldViewModel
PreviewsIssueLinkApiModel
PreviewsIssueLinkApiResult
ProblemDetails
ProjectAttributesApi
ProjectAttributesFilterModel
ProjectAttributeTemplatesApi
ProjectConfigurationsApi
ProjectCustomAttributesTemplatesFilterModel
ProjectCustomAttributeTemplateGetModel
ProjectExternalServiceApiResult
ProjectExternalServicesApiResult
ProjectExternalServiceSettingsApiResult
ProjectExtractionModel
ProjectModel
ProjectsApi
ProjectSectionsApi
ProjectSelectModel
ProjectSettingsApi
ProjectsFilterModel
ProjectShortApiResult
ProjectShortApiResultReply
ProjectShortestModel
ProjectShortModel
ProjectTestPlanAttributesApi
ProjectTestPlansApi
ProjectTestPlansFilterModel
ProjectType
ProjectTypeModel
ProjectTypeModelTypeTransformer
Transformation class that can encode an instance of ProjectTypeModel to String, and decode dynamic data back to ProjectTypeModel.
ProjectTypeTypeTransformer
Transformation class that can encode an instance of ProjectType to String, and decode dynamic data back to ProjectType.
ProjectWorkItemsApi
PublicTestPointModel
PublicTestRunModel
QueryParam
RequestTypeApiModel
RequestTypeApiModelTypeTransformer
Transformation class that can encode an instance of RequestTypeApiModel to String, and decode dynamic data back to RequestTypeApiModel.
RequestTypeModel
RequestTypeModelTypeTransformer
Transformation class that can encode an instance of RequestTypeModel to String, and decode dynamic data back to RequestTypeModel.
RerunsModel
RerunTestResultApiResult
RerunTestResultModel
SearchApi
SearchCustomAttributeTemplateGetModel
SearchTestRunsApiModel
SearchTestStatusesApiModel
SearchWebhooksQueryModel
SearchWorkflowsApiModel
SearchWorkItemLinkUrlsApiResult
SectionModel
SectionMoveModel
SectionPostModel
SectionPutModel
SectionRenameModel
SectionsApi
SectionWithStepsModel
SelectTagsApiModel
SharedStepChangeViewModel
SharedStepModel
SharedStepReferenceModel
SharedStepReferenceSectionModel
SharedStepReferenceSectionsQueryFilterModel
SharedStepReferencesQueryFilterModel
SharedStepResultApiModel
ShortConfiguration
StepCommentApiModel
StepModel
StepPostModel
StepPutModel
StepResultApiModel
StringArrayChangedFieldViewModel
StringChangedFieldViewModel
StringChangedFieldWithDiffsViewModel
StringExtractionModel
TagApiModel
TagApiResult
TagModel
TagsApi
TagsExtractionApiModel
TagsFilterApiModel
TagShortApiResult
TestPlanApiResult
TestPlanChangedFieldsViewModel
TestPlanChangeModel
TestPlanExtractionModel
TestPlanGroupByStatus
TestPlanGroupByStatusCode
TestPlanGroupByTester
TestPlanGroupByTesterAndStatus
TestPlanGroupByTesterAndStatusCode
TestPlanGroupByTestSuite
TestPlanModel
TestPlansApi
TestPlanSelectModel
TestPlanShortModel
TestPlanStatus
TestPlanStatusModel
TestPlanStatusModelTypeTransformer
Transformation class that can encode an instance of TestPlanStatusModel to String, and decode dynamic data back to TestPlanStatusModel.
TestPlanStatusTypeTransformer
Transformation class that can encode an instance of TestPlanStatus to String, and decode dynamic data back to TestPlanStatus.
TestPlanSummaryModel
TestPlanTagApiResult
TestPlanTestPointsAnalyticsApiModel
TestPlanTestPointsAnalyticsApiResult
TestPlanTestPointsApiModel
TestPlanTestPointsAutoTestsRerunApiModel
TestPlanTestPointsExtractionApiModel
TestPlanTestPointsGroupApiModel
TestPlanTestPointsGroupApiResult
TestPlanTestPointsGroupSearchApiResult
TestPlanTestPointsGroupSearchItemApiResult
TestPlanTestPointsInquiryApiModel
TestPlanTestPointsSearchApiModel
TestPlanTestPointsSearchApiResult
TestPlanTestPointsSearchStatusCountersApiResult
TestPlanTestPointsSectionSearchApiResult
TestPlanTestPointsSetTestersApiModel
TestPlanTestPointsStatusGroupApiResult
TestPlanTestPointsTesterAndStatusGroupApiResult
TestPlanTestPointsTesterGroupApiResult
TestPlanTestPointsTestSuiteSearchApiResult
TestPlanTestPointsWorkItemSearchApiResult
TestPlanWithAnalyticModel
TestPlanWithTestSuiteTreeModel
TestPoint
TestPointAnalyticResult
TestPointByTestSuiteModel
TestPointChangeViewModel
TestPointChangeViewModelChangedFieldViewModel
TestPointFilterModel
TestPointFilterRequestModel
TestPointResultApiResult
TestPointsApi
TestPointSelectModel
TestPointSelector
TestPointsExtractionModel
TestPointShortApiResult
TestPointShortModel
TestPointShortResponseModel
TestPointStatus
TestPointStatusTypeTransformer
Transformation class that can encode an instance of TestPointStatus to String, and decode dynamic data back to TestPointStatus.
TestPointWithLastResultResponseModel
TestResultApiResult
TestResultChangeViewModel
TestResultChangeViewModelChangedFieldViewModel
TestResultChronologyModel
TestResultFailureClassApiResult
TestResultHistoryReportApiResult
TestResultOutcome
TestResultOutcomeTypeTransformer
Transformation class that can encode an instance of TestResultOutcome to String, and decode dynamic data back to TestResultOutcome.
TestResultResponse
TestResultsApi
TestResultsExtractionApiModel
TestResultsFilterApiModel
TestResultShortApiResult
TestResultShortResponse
TestResultsLocalFilterModel
TestResultsSelectApiModel
TestResultsStatisticsApiResult
TestResultsStatisticsFailureCategoriesApiResult
TestResultsStatisticsStatusesApiResult
TestResultStepCommentUpdateRequest
TestResultUpdateV2Request
TestResultV2GetModel
TestResultV2ShortModel
TestRunAnalyticApiResult
TestRunApiResult
TestRunByAutoTestApiResult
TestRunExtractionApiModel
TestRunFilterApiModel
TestRunGroupByFailureClassApiResult
TestRunGroupByStatusApiResult
TestRunGroupByStatusTypeApiResult
TestRunsApi
TestRunSelectApiModel
TestRunShortApiResult
TestRunState
TestRunStateTypeTransformer
Transformation class that can encode an instance of TestRunState to String, and decode dynamic data back to TestRunState.
TestRunStatisticsFilterApiModel
TestRunTestResultsPartialBulkSetModel
TestRunTestResultsSelectModel
TestRunV2ApiResult
TestStatusApiResult
TestStatusApiResultReply
TestStatusApiType
Collection of possible status types
TestStatusApiTypeTypeTransformer
Transformation class that can encode an instance of TestStatusApiType to String, and decode dynamic data back to TestStatusApiType.
TestStatusModel
TestStatusShortApiResult
TestStatusType
TestStatusTypeTypeTransformer
Transformation class that can encode an instance of TestStatusType to String, and decode dynamic data back to TestStatusType.
TestSuiteChangeViewModel
TestSuiteChangeViewModelChangedFieldViewModel
TestSuitesApi
TestSuiteTestPlanApiModel
TestSuiteType
TestSuiteTypeTypeTransformer
Transformation class that can encode an instance of TestSuiteType to String, and decode dynamic data back to TestSuiteType.
TestSuiteV2GetModel
TestSuiteV2PostModel
TestSuiteV2PutModel
TestSuiteV2TreeModel
TestSuiteWithChildrenModel
TestSuiteWorkItemsSearchModel
UpdateEmptyTestRunApiModel
UpdateLinkApiModel
UpdateMultipleAttachmentsApiModel
UpdateMultipleLinksApiModel
UpdateMultipleTestRunsApiModel
UpdateParameterApiModel
UpdateProjectApiModel
UpdateStepApiModel
UpdateTagApiModel
UpdateTestPlanApiModel
UpdateTestStatusApiModel
UpdateWorkflowApiModel
UpdateWorkItemApiModel
UserCustomNameValidationResponse
UserNameApiResult
UserRankModel
UsersApi
UserWithRankModel
ValidationProblemDetails
WebhookBulkUpdateApiModel
WebHookEventType
WebHookEventTypeModel
WebHookEventTypeModelTypeTransformer
Transformation class that can encode an instance of WebHookEventTypeModel to String, and decode dynamic data back to WebHookEventTypeModel.
WebHookEventTypeRequest
WebHookEventTypeRequestTypeTransformer
Transformation class that can encode an instance of WebHookEventTypeRequest to String, and decode dynamic data back to WebHookEventTypeRequest.
WebHookEventTypeTypeTransformer
Transformation class that can encode an instance of WebHookEventType to String, and decode dynamic data back to WebHookEventType.
WebHookLogModel
WebHookModel
WebHookPostModel
WebhookResponse
WebhooksApi
WebhooksDeleteApiModel
WebhooksDeleteFilterApiModel
WebhooksExtractionApiModel
WebhooksFilterApiModel
WebhooksLogsApi
WebhooksUpdateApiModel
WebhooksUpdateApiResult
WebHookTestModel
WebhookVariablesType
WebhookVariablesTypeTypeTransformer
Transformation class that can encode an instance of WebhookVariablesType to String, and decode dynamic data back to WebhookVariablesType.
WorkflowApiResult
WorkflowExistsByNameApiResult
WorkflowShortApiResult
WorkflowShortApiResultReply
WorkflowStatusApiModel
WorkflowStatusApiResult
WorkItemChangedAttributeViewModel
WorkItemChangedFieldsViewModel
WorkItemChangeModel
WorkItemCommentModel
WorkItemCommentPostModel
WorkItemCommentPutModel
WorkItemEntityTypes
WorkItemEntityTypesTypeTransformer
Transformation class that can encode an instance of WorkItemEntityTypes to String, and decode dynamic data back to WorkItemEntityTypes.
WorkItemExtractionApiModel
WorkItemExtractionModel
WorkItemFilterApiModel
WorkItemFilterModel
WorkItemGroupGetModel
WorkItemGroupModel
WorkItemGroupType
WorkItemGroupTypeTypeTransformer
Transformation class that can encode an instance of WorkItemGroupType to String, and decode dynamic data back to WorkItemGroupType.
WorkItemIdentifierModel
WorkItemIdModel
WorkItemLikeModel
WorkItemLinkChangeViewModel
WorkItemLinkChangeViewModelArrayChangedFieldViewModel
WorkItemLinkExtractionApiModel
WorkItemLinkFilterApiModel
WorkItemLinkFilterModel
WorkItemLinkUrlApiModel
WorkItemLinkUrlApiResult
WorkItemLinkUrlFilterApiModel
WorkItemLocalFilterModel
WorkItemLocalSelectModel
WorkItemModel
WorkItemMovePostModel
WorkItemPreviewApiModel
WorkItemPriority
WorkItemPriorityModel
WorkItemPriorityModelTypeTransformer
Transformation class that can encode an instance of WorkItemPriorityModel to String, and decode dynamic data back to WorkItemPriorityModel.
WorkItemPriorityTypeTransformer
Transformation class that can encode an instance of WorkItemPriority to String, and decode dynamic data back to WorkItemPriority.
WorkItemsApi
WorkItemsCommentsApi
WorkItemSearchQueryModel
WorkItemSelectApiModel
WorkItemSelectModel
WorkItemShortApiResult
WorkItemShortModel
WorkItemSourceTypeModel
WorkItemSourceTypeModelTypeTransformer
Transformation class that can encode an instance of WorkItemSourceTypeModel to String, and decode dynamic data back to WorkItemSourceTypeModel.
WorkItemState
WorkItemStates
WorkItemStatesTypeTransformer
Transformation class that can encode an instance of WorkItemStates to String, and decode dynamic data back to WorkItemStates.
WorkItemStateTypeTransformer
Transformation class that can encode an instance of WorkItemState to String, and decode dynamic data back to WorkItemState.
WorkItemStepChangeViewModel
WorkItemStepChangeViewModelArrayChangedFieldWithDiffsViewModel
WorkItemVersionModel

Properties

defaultApiClient ApiClient
An ApiClient instance that uses the default values obtained from the OpenAPI specification file.
getter/setter pair

Functions

decodeAsync(DeserializationMessage message) Future
Primarily intended for use in an isolate.
deserializeAsync(DeserializationMessage message) Future
Primarily intended for use in an isolate.
mapCastOfType<K, V>(dynamic map, String key) Map<K, V>?
Returns a valid Map<K, V> found at the specified Map key, null otherwise.
mapDateTime(dynamic map, String key, [String? pattern]) DateTime?
Returns a valid DateTime found at the specified Map key, null otherwise.
mapValueOfType<T>(dynamic map, String key) → T?
Returns a valid T value found at the specified Map key, null otherwise.
parameterToString(dynamic value) String
Format the given parameter object into a String.
serializeAsync(Object? value) Future<String>
Primarily intended for use in an isolate.

Typedefs

HttpBearerAuthProvider = String Function()

Exceptions / Errors

ApiException