client

package module
v0.0.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 14, 2021 License: Apache-2.0 Imports: 21 Imported by: 7

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	AttachmentsApi *AttachmentsApiService

	CasesApi *CasesApiService

	CustomFieldsApi *CustomFieldsApiService

	DefectsApi *DefectsApiService

	EnvironmentsApi *EnvironmentsApiService

	MilestonesApi *MilestonesApiService

	PlansApi *PlansApiService

	ProjectsApi *ProjectsApiService

	ResultsApi *ResultsApiService

	RunsApi *RunsApiService

	SearchApi *SearchApiService

	SharedStepsApi *SharedStepsApiService

	SuitesApi *SuitesApiService

	UsersApi *UsersApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Qase.io API API v1.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

type AnyOfTestCaseParams 

type AnyOfTestCaseParams struct {
}

type Attachment 

type Attachment struct {
	Size     int32  `json:"size,omitempty"`
	Mime     string `json:"mime,omitempty"`
	Filename string `json:"filename,omitempty"`
	Url      string `json:"url,omitempty"`
}

type AttachmentCodeOrHashBody 

type AttachmentCodeOrHashBody struct {
	File []*os.File `json:"file,omitempty"`
}

type AttachmentGet 

type AttachmentGet struct {
	Hash      string `json:"hash,omitempty"`
	File      string `json:"file,omitempty"`
	Mime      string `json:"mime,omitempty"`
	Size      int32  `json:"size,omitempty"`
	Extension string `json:"extension,omitempty"`
	FullPath  string `json:"full_path,omitempty"`
}

type AttachmentHash 

type AttachmentHash struct {
	Size     int32  `json:"size,omitempty"`
	Mime     string `json:"mime,omitempty"`
	Filename string `json:"filename,omitempty"`
	Url      string `json:"url,omitempty"`
	Hash     string `json:"hash,omitempty"`
}

type AttachmentListResponse 

type AttachmentListResponse struct {
	Status bool                          `json:"status,omitempty"`
	Result *AttachmentListResponseResult `json:"result,omitempty"`
}

type AttachmentListResponseResult 

type AttachmentListResponseResult struct {
	Total    int32           `json:"total,omitempty"`
	Filtered int32           `json:"filtered,omitempty"`
	Count    int32           `json:"count,omitempty"`
	Entities []AttachmentGet `json:"entities,omitempty"`
}

type AttachmentResponse 

type AttachmentResponse struct {
	Status bool           `json:"status,omitempty"`
	Result *AttachmentGet `json:"result,omitempty"`
}

type AttachmentUploadsResponse 

type AttachmentUploadsResponse struct {
	Status bool            `json:"status,omitempty"`
	Result []AttachmentGet `json:"result,omitempty"`
}

type AttachmentsApiGetAttachmentsOpts 

type AttachmentsApiGetAttachmentsOpts struct {
	Limit  optional.Int32
	Offset optional.Int32
}

type AttachmentsApiService 

type AttachmentsApiService service

func (*AttachmentsApiService) DeleteAttachment 

func (a *AttachmentsApiService) DeleteAttachment(ctx context.Context, codeOrHash string) (HashResponse, *http.Response, error)

AttachmentsApiService Remove attachment by Hash. This method allows to retrieve attachment by Hash.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param codeOrHash Code or Hash.

@return HashResponse

func (*AttachmentsApiService) GetAttachment 

func (a *AttachmentsApiService) GetAttachment(ctx context.Context, codeOrHash string) (AttachmentResponse, *http.Response, error)

AttachmentsApiService Get attachment by Hash. This method allows to retrieve attachment by Hash.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param codeOrHash Code or Hash.

@return AttachmentResponse

func (*AttachmentsApiService) GetAttachments 

func (a *AttachmentsApiService) GetAttachments(ctx context.Context, localVarOptionals *AttachmentsApiGetAttachmentsOpts) (AttachmentListResponse, *http.Response, error)

func (*AttachmentsApiService) UploadAttachment 

func (a *AttachmentsApiService) UploadAttachment(ctx context.Context, codeOrHash string, localVarOptionals *AttachmentsApiUploadAttachmentOpts) (AttachmentUploadsResponse, *http.Response, error)

type AttachmentsApiUploadAttachmentOpts 

type AttachmentsApiUploadAttachmentOpts struct {
	File optional.Interface
}

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type CasesApiGetCasesOpts 

type CasesApiGetCasesOpts struct {
	Limit              optional.Int32
	Offset             optional.Int32
	FiltersSearch      optional.String
	FiltersMilestoneId optional.Int32
	FiltersSuiteId     optional.Int32
	FiltersSeverity    optional.String
	FiltersPriority    optional.String
	FiltersType        optional.String
	FiltersBehavior    optional.String
	FiltersAutomation  optional.String
	FiltersStatus      optional.String
}

type CasesApiService 

type CasesApiService service

func (*CasesApiService) CreateCase 

func (a *CasesApiService) CreateCase(ctx context.Context, body TestCaseCreate, code string) (IdResponse, *http.Response, error)

CasesApiService Create a new test case. This method allows to create a new test case in selected project.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param code Code of project, where to search entities.

@return IdResponse

func (*CasesApiService) DeleteCase 

func (a *CasesApiService) DeleteCase(ctx context.Context, code string, id int32) (IdResponse, *http.Response, error)

CasesApiService Delete test case. This method completely deletes a test case from repository.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param code Code of project, where to search entities.
  • @param id Identifier.

@return IdResponse

func (*CasesApiService) GetCase 

func (a *CasesApiService) GetCase(ctx context.Context, code string, id int32) (TestCaseResponse, *http.Response, error)

CasesApiService Get a specific test case. This method allows to retrieve a specific test case.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param code Code of project, where to search entities.
  • @param id Identifier.

@return TestCaseResponse

func (*CasesApiService) GetCases 

func (a *CasesApiService) GetCases(ctx context.Context, code string, localVarOptionals *CasesApiGetCasesOpts) (TestCaseListResponse, *http.Response, error)

func (*CasesApiService) UpdateCase 

func (a *CasesApiService) UpdateCase(ctx context.Context, body TestCaseUpdate, code string, id int32) (IdResponse, *http.Response, error)

CasesApiService Update test case. This method updates a test case.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param code Code of project, where to search entities.
  • @param id Identifier.

@return IdResponse

type Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration 

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

type CustomField 

type CustomField struct {
	Id            int64     `json:"id,omitempty"`
	Title         string    `json:"title,omitempty"`
	Entity        string    `json:"entity,omitempty"`
	Type_         string    `json:"type,omitempty"`
	Placeholder   string    `json:"placeholder,omitempty"`
	DefaultValue  string    `json:"default_value,omitempty"`
	Value         string    `json:"value,omitempty"`
	IsRequired    bool      `json:"is_required,omitempty"`
	IsVisible     bool      `json:"is_visible,omitempty"`
	IsFilterable  bool      `json:"is_filterable,omitempty"`
	Created       time.Time `json:"created,omitempty"`
	Updated       time.Time `json:"updated,omitempty"`
	ProjectsCodes []string  `json:"projects_codes,omitempty"`
}

type CustomFieldCreate 

type CustomFieldCreate struct {
	Title string                   `json:"title"`
	Value []CustomFieldCreateValue `json:"value,omitempty"`
	// Possible values: 0 - case; 1 - run; 2 - defect;
	Entity int32 `json:"entity"`
	// Possible values: 0 - number; 1 - string; 2 - text; 3 - selectbox; 4 - checkbox; 5 - radio; 6 - multiselect; 7 - url; 8 - user; 9 - datetime;
	Type_         int32    `json:"type"`
	Placeholder   string   `json:"placeholder,omitempty"`
	DefaultValue  string   `json:"default_value,omitempty"`
	IsFilterable  bool     `json:"is_filterable,omitempty"`
	IsVisible     bool     `json:"is_visible,omitempty"`
	IsRequired    bool     `json:"is_required,omitempty"`
	ProjectsCodes []string `json:"projects_codes"`
}

type CustomFieldCreateValue 

type CustomFieldCreateValue struct {
	Id    int64  `json:"id,omitempty"`
	Title string `json:"title,omitempty"`
}

type CustomFieldResponse 

type CustomFieldResponse struct {
	Status bool         `json:"status,omitempty"`
	Result *CustomField `json:"result,omitempty"`
}

type CustomFieldUpdate 

type CustomFieldUpdate struct {
	Title string                   `json:"title"`
	Value []CustomFieldCreateValue `json:"value,omitempty"`
	// Dictionary of old values and their replacemants
	ReplaceValues map[string]string `json:"replace_values,omitempty"`
	Placeholder   string            `json:"placeholder,omitempty"`
	DefaultValue  string            `json:"default_value,omitempty"`
	IsFilterable  bool              `json:"is_filterable,omitempty"`
	IsVisible     bool              `json:"is_visible,omitempty"`
	IsRequired    bool              `json:"is_required,omitempty"`
	ProjectsCodes []string          `json:"projects_codes"`
}

type CustomFieldValue 

type CustomFieldValue struct {
	Id    int64  `json:"id,omitempty"`
	Value string `json:"value,omitempty"`
}

type CustomFieldsApiGetCustomFieldsOpts 

type CustomFieldsApiGetCustomFieldsOpts struct {
	Limit         optional.Int32
	Offset        optional.Int32
	FiltersEntity optional.String
	FiltersType   optional.String
}

type CustomFieldsApiService 

type CustomFieldsApiService service

func (*CustomFieldsApiService) CreateCustomField 

func (a *CustomFieldsApiService) CreateCustomField(ctx context.Context, body CustomFieldCreate) (IdResponse, *http.Response, error)

CustomFieldsApiService Create new Custom Field. This method allows to create custom field.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body

@return IdResponse

func (*CustomFieldsApiService) DeleteCustomField 

func (a *CustomFieldsApiService) DeleteCustomField(ctx context.Context, id int32) (Response, *http.Response, error)

CustomFieldsApiService Delete Custom Field by id. This method allows to delete custom field.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id Identifier.

@return Response

func (*CustomFieldsApiService) GetCustomField 

func (a *CustomFieldsApiService) GetCustomField(ctx context.Context, id int32) (CustomFieldResponse, *http.Response, error)

CustomFieldsApiService Get Custom Field by id. This method allows to retrieve custom field.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id Identifier.

@return CustomFieldResponse

func (*CustomFieldsApiService) GetCustomFields 

func (a *CustomFieldsApiService) GetCustomFields(ctx context.Context, localVarOptionals *CustomFieldsApiGetCustomFieldsOpts) (CustomFieldsResponse, *http.Response, error)

func (*CustomFieldsApiService) UpdateCustomField 

func (a *CustomFieldsApiService) UpdateCustomField(ctx context.Context, body CustomFieldUpdate, id int32) (Response, *http.Response, error)

CustomFieldsApiService Update Custom Field by id. This method allows to update custom field.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param id Identifier.

@return Response

type CustomFieldsResponse 

type CustomFieldsResponse struct {
	Status bool                        `json:"status,omitempty"`
	Result *CustomFieldsResponseResult `json:"result,omitempty"`
}

type CustomFieldsResponseResult 

type CustomFieldsResponseResult struct {
	Total    int32         `json:"total,omitempty"`
	Filtered int32         `json:"filtered,omitempty"`
	Count    int32         `json:"count,omitempty"`
	Entities []CustomField `json:"entities,omitempty"`
}

type Defect 

type Defect struct {
	Id           int64              `json:"id,omitempty"`
	Title        string             `json:"title,omitempty"`
	ActualResult string             `json:"actual_result,omitempty"`
	Severity     string             `json:"severity,omitempty"`
	Status       string             `json:"status,omitempty"`
	MilestoneId  int64              `json:"milestone_id,omitempty"`
	CustomFields []CustomFieldValue `json:"custom_fields,omitempty"`
	Attachments  []Attachment       `json:"attachments,omitempty"`
	Created      time.Time          `json:"created,omitempty"`
	Updated      time.Time          `json:"updated,omitempty"`
	Deleted      time.Time          `json:"deleted,omitempty"`
	Resolved     time.Time          `json:"resolved,omitempty"`
	ProjectId    int64              `json:"project_id,omitempty"`
	MemberId     int64              `json:"member_id,omitempty"`
	ExternalData string             `json:"external_data,omitempty"`
	Tags         []TagValue         `json:"tags,omitempty"`
}

type DefectCreate 

type DefectCreate struct {
	Title        string   `json:"title"`
	ActualResult string   `json:"actual_result"`
	Severity     int32    `json:"severity"`
	MilestoneId  int64    `json:"milestone_id,omitempty"`
	Attachments  []string `json:"attachments,omitempty"`
	// A map of custom fields values (id => value)
	CustomField map[string]string `json:"custom_field,omitempty"`
	Tags        []string          `json:"tags,omitempty"`
}

type DefectListResponse 

type DefectListResponse struct {
	Status bool                      `json:"status,omitempty"`
	Result *DefectListResponseResult `json:"result,omitempty"`
}

type DefectListResponseResult 

type DefectListResponseResult struct {
	Total    int32    `json:"total,omitempty"`
	Filtered int32    `json:"filtered,omitempty"`
	Count    int32    `json:"count,omitempty"`
	Entities []Defect `json:"entities,omitempty"`
}

type DefectResponse 

type DefectResponse struct {
	Status bool    `json:"status,omitempty"`
	Result *Defect `json:"result,omitempty"`
}

type DefectStatus 

type DefectStatus struct {
	Status string `json:"status"`
}

type DefectUpdate 

type DefectUpdate struct {
	Title        string   `json:"title,omitempty"`
	ActualResult string   `json:"actual_result,omitempty"`
	Severity     int32    `json:"severity,omitempty"`
	MilestoneId  int64    `json:"milestone_id,omitempty"`
	Attachments  []string `json:"attachments,omitempty"`
	// A map of custom fields values (id => value)
	CustomField map[string]string `json:"custom_field,omitempty"`
	Tags        []string          `json:"tags,omitempty"`
}

type DefectsApiGetDefectsOpts 

type DefectsApiGetDefectsOpts struct {
	Limit         optional.Int32
	Offset        optional.Int32
	FiltersStatus optional.String
}

type DefectsApiService 

type DefectsApiService service

func (*DefectsApiService) CreateDefect 

func (a *DefectsApiService) CreateDefect(ctx context.Context, body DefectCreate, code string) (IdResponse, *http.Response, error)

DefectsApiService Create a new defect. This method allows to create a defect in selected project.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param code Code of project, where to search entities.

@return IdResponse

func (*DefectsApiService) DeleteDefect 

func (a *DefectsApiService) DeleteDefect(ctx context.Context, code string, id int32) (IdResponse, *http.Response, error)

DefectsApiService Delete defect. This method completely deletes a defect from repository.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param code Code of project, where to search entities.
  • @param id Identifier.

@return IdResponse

func (*DefectsApiService) GetDefect 

func (a *DefectsApiService) GetDefect(ctx context.Context, code string, id int32) (DefectResponse, *http.Response, error)

DefectsApiService Get a specific defect. This method allows to retrieve a specific defect.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param code Code of project, where to search entities.
  • @param id Identifier.

@return DefectResponse

func (*DefectsApiService) GetDefects 

func (a *DefectsApiService) GetDefects(ctx context.Context, code string, localVarOptionals *DefectsApiGetDefectsOpts) (DefectListResponse, *http.Response, error)

func (*DefectsApiService) ResolveDefect 

func (a *DefectsApiService) ResolveDefect(ctx context.Context, code string, id int32) (IdResponse, *http.Response, error)

DefectsApiService Resolve a specific defect. This method allows to resolve a specific defect.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param code Code of project, where to search entities.
  • @param id Identifier.

@return IdResponse

func (*DefectsApiService) UpdateDefect 

func (a *DefectsApiService) UpdateDefect(ctx context.Context, body DefectUpdate, code string, id int32) (IdResponse, *http.Response, error)

DefectsApiService Update defect. This method updates a defect.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param code Code of project, where to search entities.
  • @param id Identifier.

@return IdResponse

func (*DefectsApiService) UpdateDefectStatus 

func (a *DefectsApiService) UpdateDefectStatus(ctx context.Context, body DefectStatus, code string, id int32) (Response, *http.Response, error)

DefectsApiService Update a specific defect status. This method allows to update a specific defect status.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param code Code of project, where to search entities.
  • @param id Identifier.

@return Response

type Environment 

type Environment struct {
	Id          int64  `json:"id,omitempty"`
	Title       string `json:"title,omitempty"`
	Description string `json:"description,omitempty"`
	Slug        string `json:"slug,omitempty"`
	Host        string `json:"host,omitempty"`
}

type EnvironmentCreate 

type EnvironmentCreate struct {
	Title       string `json:"title"`
	Description string `json:"description,omitempty"`
	Slug        string `json:"slug"`
	Host        string `json:"host,omitempty"`
}

type EnvironmentListResponse 

type EnvironmentListResponse struct {
	Status bool                           `json:"status,omitempty"`
	Result *EnvironmentListResponseResult `json:"result,omitempty"`
}

type EnvironmentListResponseResult 

type EnvironmentListResponseResult struct {
	Total    int32         `json:"total,omitempty"`
	Filtered int32         `json:"filtered,omitempty"`
	Count    int32         `json:"count,omitempty"`
	Entities []Environment `json:"entities,omitempty"`
}

type EnvironmentResponse 

type EnvironmentResponse struct {
	Status bool         `json:"status,omitempty"`
	Result *Environment `json:"result,omitempty"`
}

type EnvironmentUpdate 

type EnvironmentUpdate struct {
	Title       string `json:"title,omitempty"`
	Description string `json:"description,omitempty"`
	Slug        string `json:"slug,omitempty"`
	Host        string `json:"host,omitempty"`
}

type EnvironmentsApiGetEnvironmentsOpts 

type EnvironmentsApiGetEnvironmentsOpts struct {
	Limit  optional.Int32
	Offset optional.Int32
}

type EnvironmentsApiService 

type EnvironmentsApiService service

func (*EnvironmentsApiService) CreateEnvironment 

func (a *EnvironmentsApiService) CreateEnvironment(ctx context.Context, body EnvironmentCreate, code string) (IdResponse, *http.Response, error)

EnvironmentsApiService Create a new environment. This method allows to create a environment in selected project.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param code Code of project, where to search entities.

@return IdResponse

func (*EnvironmentsApiService) DeleteEnvironment 

func (a *EnvironmentsApiService) DeleteEnvironment(ctx context.Context, code string, id int32) (IdResponse, *http.Response, error)

EnvironmentsApiService Delete environment. This method completely deletes a environment from repository.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param code Code of project, where to search entities.
  • @param id Identifier.

@return IdResponse

func (*EnvironmentsApiService) GetEnvironment 

func (a *EnvironmentsApiService) GetEnvironment(ctx context.Context, code string, id int32) (EnvironmentResponse, *http.Response, error)

EnvironmentsApiService Get a specific environment. This method allows to retrieve a specific environment.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param code Code of project, where to search entities.
  • @param id Identifier.

@return EnvironmentResponse

func (*EnvironmentsApiService) GetEnvironments 

func (a *EnvironmentsApiService) GetEnvironments(ctx context.Context, code string, localVarOptionals *EnvironmentsApiGetEnvironmentsOpts) (EnvironmentListResponse, *http.Response, error)

func (*EnvironmentsApiService) UpdateEnvironment 

func (a *EnvironmentsApiService) UpdateEnvironment(ctx context.Context, body EnvironmentUpdate, code string, id int32) (IdResponse, *http.Response, error)

EnvironmentsApiService Update environment. This method updates a environment.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param code Code of project, where to search entities.
  • @param id Identifier.

@return IdResponse

type Filters 

type Filters struct {
	// Provide a string that will be used to search by name.
	Search string `json:"search,omitempty"`
	// ID of milestone.
	MilestoneId int32 `json:"milestone_id,omitempty"`
	// ID of test suite.
	SuiteId int32 `json:"suite_id,omitempty"`
	// A list of severity values separated by comma. Possible values: undefined, blocker, critical, major, normal, minor, trivial
	Severity string `json:"severity,omitempty"`
	// A list of priority values separated by comma. Possible values: undefined, high, medium, low
	Priority string `json:"priority,omitempty"`
	// A list of type values separated by comma. Possible values: other, functional smoke, regression, security, usability, performance, acceptance
	Type_ string `json:"type,omitempty"`
	// A list of behavior values separated by comma. Possible values: undefined, positive negative, destructive
	Behavior string `json:"behavior,omitempty"`
	// A list of values separated by comma. Possible values: is-not-automated, automated to-be-automated
	Automation string `json:"automation,omitempty"`
	// A list of values separated by comma. Possible values: actual, draft deprecated
	Status string `json:"status,omitempty"`
}

type Filters1 

type Filters1 struct {
	Entity string `json:"entity,omitempty"`
	Type_  string `json:"type,omitempty"`
}

type Filters2 

type Filters2 struct {
	Status string `json:"status,omitempty"`
}

type Filters3 

type Filters3 struct {
	// Provide a string that will be used to search by name.
	Search string `json:"search,omitempty"`
}

type Filters4 

type Filters4 struct {
	// A single test run result status. Possible values: in_progress, passed, failed, blocked, skipped, invalid.
	Status string `json:"status,omitempty"`
	// A list of run IDs separated by comma.
	Run string `json:"run,omitempty"`
	// A list of case IDs separated by comma.
	CaseId string `json:"case_id,omitempty"`
	// A list of member IDs separated by comma.
	Member string `json:"member,omitempty"`
	Api    bool   `json:"api,omitempty"`
	// Will return all results created after provided datetime. Allowed format: `Y-m-d H:i:s`.
	FromEndTime string `json:"from_end_time,omitempty"`
	// Will return all results created before provided datetime. Allowed format: `Y-m-d H:i:s`.
	ToEndTime string `json:"to_end_time,omitempty"`
}

type Filters5 

type Filters5 struct {
	// A list of status values separated by comma. Possible values: active, complete, abort.
	Status      string `json:"status,omitempty"`
	Milestone   int32  `json:"milestone,omitempty"`
	Environment int32  `json:"environment,omitempty"`
}

type Filters6 

type Filters6 struct {
	// Provide a string that will be used to search by name.
	Search string `json:"search,omitempty"`
}

type Filters7 

type Filters7 struct {
	// Provide a string that will be used to search by name.
	Search string `json:"search,omitempty"`
}

type GenericSwaggerError 

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body 

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error 

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model 

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type HashResponse 

type HashResponse struct {
	Status bool                `json:"status,omitempty"`
	Result *HashResponseResult `json:"result,omitempty"`
}

type HashResponseResult 

type HashResponseResult struct {
	Hash string `json:"hash,omitempty"`
}

type IdOrHash 

type IdOrHash struct {
}

type IdResponse 

type IdResponse struct {
	Status bool              `json:"status,omitempty"`
	Result *IdResponseResult `json:"result,omitempty"`
}

type IdResponseResult 

type IdResponseResult struct {
	Id int64 `json:"id,omitempty"`
}

type InlineResponse200 

type InlineResponse200 struct {
	Status bool                     `json:"status,omitempty"`
	Result *InlineResponse200Result `json:"result,omitempty"`
}

type InlineResponse200Result 

type InlineResponse200Result struct {
	CaseId int64  `json:"case_id,omitempty"`
	Hash   string `json:"hash,omitempty"`
}

type Milestone 

type Milestone struct {
	Id          int64     `json:"id,omitempty"`
	Title       string    `json:"title,omitempty"`
	Description string    `json:"description,omitempty"`
	Status      string    `json:"status,omitempty"`
	DueDate     time.Time `json:"due_date,omitempty"`
	Created     time.Time `json:"created,omitempty"`
	Updated     time.Time `json:"updated,omitempty"`
}

type MilestoneCreate 

type MilestoneCreate struct {
	Title       string `json:"title"`
	Description string `json:"description,omitempty"`
	Status      string `json:"status,omitempty"`
	// unix timestamp
	DueDate int64 `json:"due_date,omitempty"`
}

type MilestoneListResponse 

type MilestoneListResponse struct {
	Status bool                         `json:"status,omitempty"`
	Result *MilestoneListResponseResult `json:"result,omitempty"`
}

type MilestoneListResponseResult 

type MilestoneListResponseResult struct {
	Total    int32       `json:"total,omitempty"`
	Filtered int32       `json:"filtered,omitempty"`
	Count    int32       `json:"count,omitempty"`
	Entities []Milestone `json:"entities,omitempty"`
}

type MilestoneResponse 

type MilestoneResponse struct {
	Status bool       `json:"status,omitempty"`
	Result *Milestone `json:"result,omitempty"`
}

type MilestoneUpdate 

type MilestoneUpdate struct {
	Title       string `json:"title,omitempty"`
	Description string `json:"description,omitempty"`
	Status      string `json:"status,omitempty"`
}

type MilestonesApiGetMilestonesOpts 

type MilestonesApiGetMilestonesOpts struct {
	Limit         optional.Int32
	Offset        optional.Int32
	FiltersSearch optional.String
}

type MilestonesApiService 

type MilestonesApiService service

func (*MilestonesApiService) CreateMilestone 

func (a *MilestonesApiService) CreateMilestone(ctx context.Context, body MilestoneCreate, code string) (IdResponse, *http.Response, error)

MilestonesApiService Create a new milestone. This method allows to create a milestone in selected project.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param code Code of project, where to search entities.

@return IdResponse

func (*MilestonesApiService) DeleteMilestone 

func (a *MilestonesApiService) DeleteMilestone(ctx context.Context, code string, id int32) (IdResponse, *http.Response, error)

MilestonesApiService Delete milestone. This method completely deletes a milestone from repository.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param code Code of project, where to search entities.
  • @param id Identifier.

@return IdResponse

func (*MilestonesApiService) GetMilestone 

func (a *MilestonesApiService) GetMilestone(ctx context.Context, code string, id int32) (MilestoneResponse, *http.Response, error)

MilestonesApiService Get a specific milestone. This method allows to retrieve a specific milestone.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param code Code of project, where to search entities.
  • @param id Identifier.

@return MilestoneResponse

func (*MilestonesApiService) GetMilestones 

func (a *MilestonesApiService) GetMilestones(ctx context.Context, code string, localVarOptionals *MilestonesApiGetMilestonesOpts) (MilestoneListResponse, *http.Response, error)

func (*MilestonesApiService) UpdateMilestone 

func (a *MilestonesApiService) UpdateMilestone(ctx context.Context, body MilestoneUpdate, code string, id int32) (IdResponse, *http.Response, error)

MilestonesApiService Update milestone. This method updates a milestone.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param code Code of project, where to search entities.
  • @param id Identifier.

@return IdResponse

type OneOfSearchResponseResultEntitiesItems 

type OneOfSearchResponseResultEntitiesItems struct {
	TestCase
	Defect
	Run
	Result
	Plan
	Requirement
}

type OneOfidOrHash 

type OneOfidOrHash struct {
}

type Plan 

type Plan struct {
	Id          int64     `json:"id,omitempty"`
	Title       string    `json:"title,omitempty"`
	Description string    `json:"description,omitempty"`
	CasesCount  int32     `json:"cases_count,omitempty"`
	Created     time.Time `json:"created,omitempty"`
	Updated     time.Time `json:"updated,omitempty"`
}

type PlanCreate 

type PlanCreate struct {
	Title       string  `json:"title"`
	Description string  `json:"description,omitempty"`
	Cases       []int64 `json:"cases"`
}

type PlanDetailed 

type PlanDetailed struct {
	Id          int64               `json:"id,omitempty"`
	Title       string              `json:"title,omitempty"`
	Description string              `json:"description,omitempty"`
	CasesCount  int32               `json:"cases_count,omitempty"`
	Created     time.Time           `json:"created,omitempty"`
	Updated     time.Time           `json:"updated,omitempty"`
	AverageTime float64             `json:"average_time,omitempty"`
	Cases       []PlanDetailedCases `json:"cases,omitempty"`
}

type PlanDetailedCases 

type PlanDetailedCases struct {
	CaseId     int64 `json:"case_id,omitempty"`
	AssigneeId int64 `json:"assignee_id,omitempty"`
}

type PlanListResponse 

type PlanListResponse struct {
	Status bool                    `json:"status,omitempty"`
	Result *PlanListResponseResult `json:"result,omitempty"`
}

type PlanListResponseResult 

type PlanListResponseResult struct {
	Total    int32  `json:"total,omitempty"`
	Filtered int32  `json:"filtered,omitempty"`
	Count    int32  `json:"count,omitempty"`
	Entities []Plan `json:"entities,omitempty"`
}

type PlanResponse 

type PlanResponse struct {
	Status bool          `json:"status,omitempty"`
	Result *PlanDetailed `json:"result,omitempty"`
}

type PlanUpdate 

type PlanUpdate struct {
	Title       string  `json:"title,omitempty"`
	Description string  `json:"description,omitempty"`
	Cases       []int64 `json:"cases,omitempty"`
}

type PlansApiGetPlansOpts 

type PlansApiGetPlansOpts struct {
	Limit  optional.Int32
	Offset optional.Int32
}

type PlansApiService 

type PlansApiService service

func (*PlansApiService) CreatePlan 

func (a *PlansApiService) CreatePlan(ctx context.Context, body PlanCreate, code string) (IdResponse, *http.Response, error)

PlansApiService Create a new plan. This method allows to create a plan in selected project.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param code Code of project, where to search entities.

@return IdResponse

func (*PlansApiService) DeletePlan 

func (a *PlansApiService) DeletePlan(ctx context.Context, code string, id int32) (IdResponse, *http.Response, error)

PlansApiService Delete plan. This method completely deletes a plan from repository.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param code Code of project, where to search entities.
  • @param id Identifier.

@return IdResponse

func (*PlansApiService) GetPlan 

func (a *PlansApiService) GetPlan(ctx context.Context, code string, id int32) (PlanResponse, *http.Response, error)

PlansApiService Get a specific plan. This method allows to retrieve a specific plan.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param code Code of project, where to search entities.
  • @param id Identifier.

@return PlanResponse

func (*PlansApiService) GetPlans 

func (a *PlansApiService) GetPlans(ctx context.Context, code string, localVarOptionals *PlansApiGetPlansOpts) (PlanListResponse, *http.Response, error)

func (*PlansApiService) UpdatePlan 

func (a *PlansApiService) UpdatePlan(ctx context.Context, body PlanUpdate, code string, id int32) (IdResponse, *http.Response, error)

PlansApiService Update plan. This method updates a plan.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param code Code of project, where to search entities.
  • @param id Identifier.

@return IdResponse

type Project 

type Project struct {
	Title  string         `json:"title,omitempty"`
	Code   string         `json:"code,omitempty"`
	Counts *ProjectCounts `json:"counts,omitempty"`
}

type ProjectAccess 

type ProjectAccess struct {
	// Team member id title.
	MemeberId int64 `json:"memeber_id,omitempty"`
}

type ProjectCodeResponse 

type ProjectCodeResponse struct {
	Status bool                       `json:"status,omitempty"`
	Result *ProjectCodeResponseResult `json:"result,omitempty"`
}

type ProjectCodeResponseResult 

type ProjectCodeResponseResult struct {
	Code string `json:"code,omitempty"`
}

type ProjectCounts 

type ProjectCounts struct {
	Cases      int32                 `json:"cases,omitempty"`
	Suites     int32                 `json:"suites,omitempty"`
	Milestones int32                 `json:"milestones,omitempty"`
	Runs       *ProjectCountsRuns    `json:"runs,omitempty"`
	Defects    *ProjectCountsDefects `json:"defects,omitempty"`
}

type ProjectCountsDefects 

type ProjectCountsDefects struct {
	Total int32 `json:"total,omitempty"`
	Open  int32 `json:"open,omitempty"`
}

type ProjectCountsRuns 

type ProjectCountsRuns struct {
	Total  int32 `json:"total,omitempty"`
	Active int32 `json:"active,omitempty"`
}

type ProjectCreate 

type ProjectCreate struct {
	// Project title.
	Title string `json:"title"`
	// Project code. Unique for team. Digits and special characters are not allowed.
	Code string `json:"code"`
	// Project description.
	Description string `json:"description,omitempty"`
	Access      string `json:"access,omitempty"`
	// Team group hash. Required if access param is set to group.
	Group string `json:"group,omitempty"`
}

type ProjectListResponse 

type ProjectListResponse struct {
	Status bool                       `json:"status,omitempty"`
	Result *ProjectListResponseResult `json:"result,omitempty"`
}

type ProjectListResponseResult 

type ProjectListResponseResult struct {
	Total    int32     `json:"total,omitempty"`
	Filtered int32     `json:"filtered,omitempty"`
	Count    int32     `json:"count,omitempty"`
	Entities []Project `json:"entities,omitempty"`
}

type ProjectResponse 

type ProjectResponse struct {
	Status bool     `json:"status,omitempty"`
	Result *Project `json:"result,omitempty"`
}

type ProjectsApiGetProjectsOpts 

type ProjectsApiGetProjectsOpts struct {
	Limit  optional.Int32
	Offset optional.Int32
}

type ProjectsApiService 

type ProjectsApiService service

func (*ProjectsApiService) CreateProject 

func (a *ProjectsApiService) CreateProject(ctx context.Context, body ProjectCreate) (ProjectCodeResponse, *http.Response, error)

ProjectsApiService Create new project. This method is used to create a new project through API.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body

@return ProjectCodeResponse

func (*ProjectsApiService) DeleteProject 

func (a *ProjectsApiService) DeleteProject(ctx context.Context, code string) (Response, *http.Response, error)

ProjectsApiService Delete Project by code. This method allows to delete a specific project.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param code Code of project, where to search entities.

@return Response

func (*ProjectsApiService) GetProject 

func (a *ProjectsApiService) GetProject(ctx context.Context, code string) (ProjectResponse, *http.Response, error)

ProjectsApiService Get Project by code. This method allows to retrieve a specific project.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param code Code of project, where to search entities.

@return ProjectResponse

func (*ProjectsApiService) GetProjects 

func (a *ProjectsApiService) GetProjects(ctx context.Context, localVarOptionals *ProjectsApiGetProjectsOpts) (ProjectListResponse, *http.Response, error)

func (*ProjectsApiService) GrantAccessToProject 

func (a *ProjectsApiService) GrantAccessToProject(ctx context.Context, body ProjectAccess, code string) (Response, *http.Response, error)

ProjectsApiService Grant access to project by code. This method allows to grant access to a specific project.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param code Code of project, where to search entities.

@return Response

func (*ProjectsApiService) RevokeAccessToProject 

func (a *ProjectsApiService) RevokeAccessToProject(ctx context.Context, body ProjectAccess, code string) (Response, *http.Response, error)

ProjectsApiService Revoke access to project by code. This method allows to revoke access to a specific project.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param code Code of project, where to search entities.

@return Response

type Requirement 

type Requirement struct {
	Id          int64     `json:"id,omitempty"`
	ParentId    int64     `json:"parent_id,omitempty"`
	MemberId    int64     `json:"member_id,omitempty"`
	Title       string    `json:"title,omitempty"`
	Description string    `json:"description,omitempty"`
	Status      string    `json:"status,omitempty"`
	Type_       string    `json:"type,omitempty"`
	Created     time.Time `json:"created,omitempty"`
	Updated     time.Time `json:"updated,omitempty"`
}

type Response 

type Response struct {
	Status bool         `json:"status,omitempty"`
	Result *interface{} `json:"result,omitempty"`
}

type Result 

type Result struct {
	Hash        string        `json:"hash,omitempty"`
	Comment     string        `json:"comment,omitempty"`
	Stacktrace  string        `json:"stacktrace,omitempty"`
	RunId       int64         `json:"run_id,omitempty"`
	CaseId      int64         `json:"case_id,omitempty"`
	Steps       []ResultSteps `json:"steps,omitempty"`
	Status      string        `json:"status,omitempty"`
	IsApiResult bool          `json:"is_api_result,omitempty"`
	TimeSpentMs int64         `json:"time_spent_ms,omitempty"`
	EndTime     time.Time     `json:"end_time,omitempty"`
	Attachments []Attachment  `json:"attachments,omitempty"`
}

type ResultCreate 

type ResultCreate struct {
	CaseId      int64               `json:"case_id,omitempty"`
	Case_       *ResultCreateCase   `json:"case,omitempty"`
	Status      string              `json:"status,omitempty"`
	Time        int64               `json:"time,omitempty"`
	TimeMs      int64               `json:"time_ms,omitempty"`
	Defect      bool                `json:"defect,omitempty"`
	Attachments []string            `json:"attachments,omitempty"`
	Stacktrace  string              `json:"stacktrace,omitempty"`
	Comment     string              `json:"comment,omitempty"`
	Param       []string            `json:"param,omitempty"`
	Steps       []ResultCreateSteps `json:"steps,omitempty"`
}

type ResultCreateBulk 

type ResultCreateBulk struct {
	Results []ResultCreate `json:"results"`
}

type ResultCreateCase 

type ResultCreateCase struct {
	Title       string `json:"title,omitempty"`
	SuiteTitle  string `json:"suite_title,omitempty"`
	Description string `json:"description,omitempty"`
	Layer       string `json:"layer,omitempty"`
	Severity    string `json:"severity,omitempty"`
}

Could be used insetad of case_id

type ResultCreateSteps 

type ResultCreateSteps struct {
	Position       int32    `json:"position"`
	Status         string   `json:"status"`
	Comment        string   `json:"comment,omitempty"`
	Attachments    []string `json:"attachments,omitempty"`
	Action         string   `json:"action,omitempty"`
	ExpectedResult string   `json:"expected_result,omitempty"`
	Data           string   `json:"data,omitempty"`
}

type ResultListResponse 

type ResultListResponse struct {
	Status bool                      `json:"status,omitempty"`
	Result *ResultListResponseResult `json:"result,omitempty"`
}

type ResultListResponseResult 

type ResultListResponseResult struct {
	Total    int32    `json:"total,omitempty"`
	Filtered int32    `json:"filtered,omitempty"`
	Count    int32    `json:"count,omitempty"`
	Entities []Result `json:"entities,omitempty"`
}

type ResultResponse 

type ResultResponse struct {
	Status bool    `json:"status,omitempty"`
	Result *Result `json:"result,omitempty"`
}

type ResultSteps 

type ResultSteps struct {
	Status      int32        `json:"status,omitempty"`
	Position    int32        `json:"position,omitempty"`
	Attachments []Attachment `json:"attachments,omitempty"`
}

type ResultUpdate 

type ResultUpdate struct {
	Status      string              `json:"status,omitempty"`
	TimeMs      int64               `json:"time_ms,omitempty"`
	Defect      bool                `json:"defect,omitempty"`
	Attachments []string            `json:"attachments,omitempty"`
	Stacktrace  string              `json:"stacktrace,omitempty"`
	Comment     string              `json:"comment,omitempty"`
	Steps       []ResultUpdateSteps `json:"steps,omitempty"`
}

type ResultUpdateSteps 

type ResultUpdateSteps struct {
	Position    int32    `json:"position,omitempty"`
	Status      string   `json:"status,omitempty"`
	Comment     string   `json:"comment,omitempty"`
	Attachments []string `json:"attachments,omitempty"`
}

type ResultsApiGetResultsOpts 

type ResultsApiGetResultsOpts struct {
	Limit              optional.Int32
	Offset             optional.Int32
	FiltersStatus      optional.String
	FiltersRun         optional.String
	FiltersCaseId      optional.String
	FiltersMember      optional.String
	FiltersApi         optional.Bool
	FiltersFromEndTime optional.String
	FiltersToEndTime   optional.String
}

type ResultsApiService 

type ResultsApiService service

func (*ResultsApiService) CreateResult 

func (a *ResultsApiService) CreateResult(ctx context.Context, body ResultCreate, code string, idOrHash IdOrHash) (InlineResponse200, *http.Response, error)

ResultsApiService Create test run result. This method allows to create test run result by Run Id.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param code Code of project, where to search entities.
  • @param idOrHash Id or Hash.

@return InlineResponse200

func (*ResultsApiService) CreateResultBulk 

func (a *ResultsApiService) CreateResultBulk(ctx context.Context, body ResultCreateBulk, code string, id int32) (Response, *http.Response, error)

ResultsApiService Bulk create test run result. This method allows to create a lot of test run result at once.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param code Code of project, where to search entities.
  • @param id Identifier.

@return Response

func (*ResultsApiService) DeleteResult 

func (a *ResultsApiService) DeleteResult(ctx context.Context, code string, id int32, hash string) (HashResponse, *http.Response, error)

ResultsApiService Delete test run result. This method allows to delete test run result.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param code Code of project, where to search entities.
  • @param id Identifier.
  • @param hash Hash.

@return HashResponse

func (*ResultsApiService) GetResult 

func (a *ResultsApiService) GetResult(ctx context.Context, code string, idOrHash IdOrHash) (ResultResponse, *http.Response, error)

ResultsApiService Get test run result by code. This method allows to retrieve a specific test run result by Hash.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param code Code of project, where to search entities.
  • @param idOrHash Id or Hash.

@return ResultResponse

func (*ResultsApiService) GetResults 

func (a *ResultsApiService) GetResults(ctx context.Context, code string, localVarOptionals *ResultsApiGetResultsOpts) (ResultListResponse, *http.Response, error)

func (*ResultsApiService) UpdateResult 

func (a *ResultsApiService) UpdateResult(ctx context.Context, body ResultUpdate, code string, id int32, hash string) (HashResponse, *http.Response, error)

ResultsApiService Update test run result. This method allows to update test run result.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param code Code of project, where to search entities.
  • @param id Identifier.
  • @param hash Hash.

@return HashResponse

type Run 

type Run struct {
	Id          int64     `json:"id,omitempty"`
	Title       string    `json:"title,omitempty"`
	Description string    `json:"description,omitempty"`
	Status      int32     `json:"status,omitempty"`
	StatusText  string    `json:"status_text,omitempty"`
	StartTime   time.Time `json:"start_time,omitempty"`
	EndTime     time.Time `json:"end_time,omitempty"`
	Public      bool      `json:"public,omitempty"`
	Stats       *RunStats `json:"stats,omitempty"`
	// Time in ms.
	TimeSpent    int64              `json:"time_spent,omitempty"`
	Environment  *RunEnvironment    `json:"environment,omitempty"`
	Milestone    *RunMilestone      `json:"milestone,omitempty"`
	CustomFields []CustomFieldValue `json:"custom_fields,omitempty"`
	Tags         []TagValue         `json:"tags,omitempty"`
	Cases        []int64            `json:"cases,omitempty"`
}

type RunCreate 

type RunCreate struct {
	Title           string   `json:"title"`
	Description     string   `json:"description,omitempty"`
	IncludeAllCases bool     `json:"include_all_cases,omitempty"`
	Cases           []int64  `json:"cases,omitempty"`
	IsAutotest      bool     `json:"is_autotest,omitempty"`
	EnvironmentId   int64    `json:"environment_id,omitempty"`
	MilestoneId     int64    `json:"milestone_id,omitempty"`
	PlanId          int64    `json:"plan_id,omitempty"`
	Tags            []string `json:"tags,omitempty"`
}

type RunEnvironment 

type RunEnvironment struct {
	Title       string `json:"title,omitempty"`
	Description string `json:"description,omitempty"`
	Slug        string `json:"slug,omitempty"`
	Host        string `json:"host,omitempty"`
}

type RunListResponse 

type RunListResponse struct {
	Status bool                   `json:"status,omitempty"`
	Result *RunListResponseResult `json:"result,omitempty"`
}

type RunListResponseResult 

type RunListResponseResult struct {
	Total    int32 `json:"total,omitempty"`
	Filtered int32 `json:"filtered,omitempty"`
	Count    int32 `json:"count,omitempty"`
	Entities []Run `json:"entities,omitempty"`
}

type RunMilestone 

type RunMilestone struct {
	Title       string `json:"title,omitempty"`
	Description string `json:"description,omitempty"`
}

type RunPublic 

type RunPublic struct {
	Status bool `json:"status"`
}

type RunPublicResponse 

type RunPublicResponse struct {
	Status bool                     `json:"status,omitempty"`
	Result *RunPublicResponseResult `json:"result,omitempty"`
}

type RunPublicResponseResult 

type RunPublicResponseResult struct {
	Url string `json:"url,omitempty"`
}

type RunResponse 

type RunResponse struct {
	Status bool `json:"status,omitempty"`
	Result *Run `json:"result,omitempty"`
}

type RunStats 

type RunStats struct {
	Total      int32 `json:"total,omitempty"`
	Untested   int32 `json:"untested,omitempty"`
	Passed     int32 `json:"passed,omitempty"`
	Failed     int32 `json:"failed,omitempty"`
	Blocked    int32 `json:"blocked,omitempty"`
	Skipped    int32 `json:"skipped,omitempty"`
	Retest     int32 `json:"retest,omitempty"`
	InProgress int32 `json:"in_progress,omitempty"`
	Invalid    int32 `json:"invalid,omitempty"`
}

type RunsApiGetRunsOpts 

type RunsApiGetRunsOpts struct {
	Limit              optional.Int32
	Offset             optional.Int32
	Include            optional.Interface
	FiltersStatus      optional.String
	FiltersMilestone   optional.Int32
	FiltersEnvironment optional.Int32
}

type RunsApiService 

type RunsApiService service

func (*RunsApiService) CompleteRun 

func (a *RunsApiService) CompleteRun(ctx context.Context, code string, id int32) (Response, *http.Response, error)

RunsApiService Complete a specific run. This method allows to complete a specific run.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param code Code of project, where to search entities.
  • @param id Identifier.

@return Response

func (*RunsApiService) CreateRun 

func (a *RunsApiService) CreateRun(ctx context.Context, body RunCreate, code string) (IdResponse, *http.Response, error)

RunsApiService Create a new run. This method allows to create a run in selected project.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param code Code of project, where to search entities.

@return IdResponse

func (*RunsApiService) DeleteRun 

func (a *RunsApiService) DeleteRun(ctx context.Context, code string, id int32) (IdResponse, *http.Response, error)

RunsApiService Delete run. This method completely deletes a run from repository.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param code Code of project, where to search entities.
  • @param id Identifier.

@return IdResponse

func (*RunsApiService) GetRun 

func (a *RunsApiService) GetRun(ctx context.Context, code string, id int32) (RunResponse, *http.Response, error)

RunsApiService Get a specific run. This method allows to retrieve a specific run.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param code Code of project, where to search entities.
  • @param id Identifier.

@return RunResponse

func (*RunsApiService) GetRuns 

func (a *RunsApiService) GetRuns(ctx context.Context, code string, localVarOptionals *RunsApiGetRunsOpts) (RunListResponse, *http.Response, error)

func (*RunsApiService) UpdateRunPublicity 

func (a *RunsApiService) UpdateRunPublicity(ctx context.Context, body RunPublic, code string, id int32) (RunPublicResponse, *http.Response, error)

RunsApiService Update publicity of a specific run. This method allows to update a publicity of specific run.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param code Code of project, where to search entities.
  • @param id Identifier.

@return RunPublicResponse

type SearchApiSearchOpts 

type SearchApiSearchOpts struct {
	Limit  optional.Int32
	Offset optional.Int32
}

type SearchApiService 

type SearchApiService service

func (*SearchApiService) Search 

func (a *SearchApiService) Search(ctx context.Context, query string, localVarOptionals *SearchApiSearchOpts) (SearchResponse, *http.Response, error)

type SearchResponse 

type SearchResponse struct {
	Status bool                  `json:"status,omitempty"`
	Result *SearchResponseResult `json:"result,omitempty"`
}

type SearchResponseResult 

type SearchResponseResult struct {
	Entities []OneOfSearchResponseResultEntitiesItems `json:"entities,omitempty"`
}

type SharedStep 

type SharedStep struct {
	Hash           string            `json:"hash,omitempty"`
	Title          string            `json:"title,omitempty"`
	Action         string            `json:"action,omitempty"`
	ExpectedResult string            `json:"expected_result,omitempty"`
	Steps          []SharedStepSteps `json:"steps,omitempty"`
	Data           string            `json:"data,omitempty"`
	Cases          []int64           `json:"cases,omitempty"`
	CasesCount     int32             `json:"cases_count,omitempty"`
	Created        time.Time         `json:"created,omitempty"`
	Updated        time.Time         `json:"updated,omitempty"`
}

type SharedStepCreate 

type SharedStepCreate struct {
	Title          string                  `json:"title,omitempty"`
	Action         string                  `json:"action,omitempty"`
	ExpectedResult string                  `json:"expected_result,omitempty"`
	Data           string                  `json:"data,omitempty"`
	Attachments    []AttachmentHash        `json:"attachments,omitempty"`
	Steps          []SharedStepCreateSteps `json:"steps,omitempty"`
}

type SharedStepCreateSteps 

type SharedStepCreateSteps struct {
	Hash           string           `json:"hash,omitempty"`
	Action         string           `json:"action,omitempty"`
	ExpectedResult string           `json:"expected_result,omitempty"`
	Data           string           `json:"data,omitempty"`
	Attachments    []AttachmentHash `json:"attachments,omitempty"`
}

type SharedStepListResponse 

type SharedStepListResponse struct {
	Status bool                          `json:"status,omitempty"`
	Result *SharedStepListResponseResult `json:"result,omitempty"`
}

type SharedStepListResponseResult 

type SharedStepListResponseResult struct {
	Total    int32        `json:"total,omitempty"`
	Filtered int32        `json:"filtered,omitempty"`
	Count    int32        `json:"count,omitempty"`
	Entities []SharedStep `json:"entities,omitempty"`
}

type SharedStepResponse 

type SharedStepResponse struct {
	Status bool        `json:"status,omitempty"`
	Result *SharedStep `json:"result,omitempty"`
}

type SharedStepSteps 

type SharedStepSteps struct {
	Data           string           `json:"data,omitempty"`
	Hash           string           `json:"hash,omitempty"`
	Action         string           `json:"action,omitempty"`
	ExpectedResult string           `json:"expected_result,omitempty"`
	Attachments    []AttachmentHash `json:"attachments,omitempty"`
}

type SharedStepUpdate 

type SharedStepUpdate struct {
	Title          string                  `json:"title,omitempty"`
	Action         string                  `json:"action,omitempty"`
	ExpectedResult string                  `json:"expected_result,omitempty"`
	Data           string                  `json:"data,omitempty"`
	Steps          []SharedStepCreateSteps `json:"steps,omitempty"`
}

type SharedStepsApiGetSharedStepsOpts 

type SharedStepsApiGetSharedStepsOpts struct {
	Limit         optional.Int32
	Offset        optional.Int32
	FiltersSearch optional.String
}

type SharedStepsApiService 

type SharedStepsApiService service

func (*SharedStepsApiService) CreateSharedStep 

func (a *SharedStepsApiService) CreateSharedStep(ctx context.Context, body SharedStepCreate, code string) (HashResponse, *http.Response, error)

SharedStepsApiService Create a new shared step. This method allows to create a shared step in selected project.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param code Code of project, where to search entities.

@return HashResponse

func (*SharedStepsApiService) DeleteSharedStep 

func (a *SharedStepsApiService) DeleteSharedStep(ctx context.Context, code string, hash string) (HashResponse, *http.Response, error)

SharedStepsApiService Delete shared step. This method completely deletes a shared step from repository.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param code Code of project, where to search entities.
  • @param hash Hash.

@return HashResponse

func (*SharedStepsApiService) GetSharedStep 

func (a *SharedStepsApiService) GetSharedStep(ctx context.Context, code string, hash string) (SharedStepResponse, *http.Response, error)

SharedStepsApiService Get a specific shared step. This method allows to retrieve a specific shared step.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param code Code of project, where to search entities.
  • @param hash Hash.

@return SharedStepResponse

func (*SharedStepsApiService) GetSharedSteps 

func (a *SharedStepsApiService) GetSharedSteps(ctx context.Context, code string, localVarOptionals *SharedStepsApiGetSharedStepsOpts) (SharedStepListResponse, *http.Response, error)

func (*SharedStepsApiService) UpdateSharedStep 

func (a *SharedStepsApiService) UpdateSharedStep(ctx context.Context, body SharedStepUpdate, code string, hash string) (HashResponse, *http.Response, error)

SharedStepsApiService Update shared step. This method updates a shared step.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param code Code of project, where to search entities.
  • @param hash Hash.

@return HashResponse

type Suite 

type Suite struct {
	Id            int64     `json:"id,omitempty"`
	Title         string    `json:"title,omitempty"`
	Description   string    `json:"description,omitempty"`
	Preconditions string    `json:"preconditions,omitempty"`
	Position      int32     `json:"position,omitempty"`
	CasesCount    int32     `json:"cases_count,omitempty"`
	ParentId      int64     `json:"parent_id,omitempty"`
	Created       time.Time `json:"created,omitempty"`
	Updated       time.Time `json:"updated,omitempty"`
}

type SuiteCreate 

type SuiteCreate struct {
	// Test suite title.
	Title string `json:"title"`
	// Test suite description.
	Description string `json:"description,omitempty"`
	// Test suite preconditions
	Preconditions string `json:"preconditions,omitempty"`
	// Parent suite ID
	ParentId int64 `json:"parent_id,omitempty"`
}

type SuiteDelete 

type SuiteDelete struct {
	// If provided, child test cases would be moved to suite with such ID.
	DestinationId int64 `json:"destination_id,omitempty"`
}

type SuiteListResponse 

type SuiteListResponse struct {
	Status bool                     `json:"status,omitempty"`
	Result *SuiteListResponseResult `json:"result,omitempty"`
}

type SuiteListResponseResult 

type SuiteListResponseResult struct {
	Total    int32   `json:"total,omitempty"`
	Filtered int32   `json:"filtered,omitempty"`
	Count    int32   `json:"count,omitempty"`
	Entities []Suite `json:"entities,omitempty"`
}

type SuiteResponse 

type SuiteResponse struct {
	Status bool   `json:"status,omitempty"`
	Result *Suite `json:"result,omitempty"`
}

type SuitesApiDeleteSuiteOpts 

type SuitesApiDeleteSuiteOpts struct {
	Body optional.Interface
}

type SuitesApiGetSuitesOpts 

type SuitesApiGetSuitesOpts struct {
	Limit         optional.Int32
	Offset        optional.Int32
	FiltersSearch optional.String
}

type SuitesApiService 

type SuitesApiService service

func (*SuitesApiService) CreateSuite 

func (a *SuitesApiService) CreateSuite(ctx context.Context, body SuiteCreate, code string) (IdResponse, *http.Response, error)

SuitesApiService Create a new test suite. This method is used to create a new test suite through API.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param code Code of project, where to search entities.

@return IdResponse

func (*SuitesApiService) DeleteSuite 

func (a *SuitesApiService) DeleteSuite(ctx context.Context, code string, id int32, localVarOptionals *SuitesApiDeleteSuiteOpts) (IdResponse, *http.Response, error)

func (*SuitesApiService) GetSuite 

func (a *SuitesApiService) GetSuite(ctx context.Context, code string, id int32) (SuiteResponse, *http.Response, error)

SuitesApiService Get a specific test suite. This method allows to retrieve a specific test suite.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param code Code of project, where to search entities.
  • @param id Identifier.

@return SuiteResponse

func (*SuitesApiService) GetSuites 

func (a *SuitesApiService) GetSuites(ctx context.Context, code string, localVarOptionals *SuitesApiGetSuitesOpts) (SuiteListResponse, *http.Response, error)

func (*SuitesApiService) UpdateSuite 

func (a *SuitesApiService) UpdateSuite(ctx context.Context, body SuiteCreate, code string, id int32) (IdResponse, *http.Response, error)

SuitesApiService Update test suite. This method is used to update a test suite through API.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param code Code of project, where to search entities.
  • @param id Identifier.

@return IdResponse

type TagValue 

type TagValue struct {
	Title      string `json:"title,omitempty"`
	InternalId int64  `json:"internal_id,omitempty"`
}

type TestCase 

type TestCase struct {
	Id             int64                `json:"id,omitempty"`
	Position       int32                `json:"position,omitempty"`
	Title          string               `json:"title,omitempty"`
	Description    string               `json:"description,omitempty"`
	Preconditions  string               `json:"preconditions,omitempty"`
	Postconditions string               `json:"postconditions,omitempty"`
	Severity       int32                `json:"severity,omitempty"`
	Priority       int32                `json:"priority,omitempty"`
	Type_          int32                `json:"type,omitempty"`
	Layer          int32                `json:"layer,omitempty"`
	IsFlaky        int32                `json:"is_flaky,omitempty"`
	Behavior       int32                `json:"behavior,omitempty"`
	Automation     int32                `json:"automation,omitempty"`
	Status         int32                `json:"status,omitempty"`
	MilestoneId    int64                `json:"milestone_id,omitempty"`
	SuiteId        int64                `json:"suite_id,omitempty"`
	CustomFields   []CustomFieldValue   `json:"custom_fields,omitempty"`
	Attachments    []Attachment         `json:"attachments,omitempty"`
	Steps          []TestStep           `json:"steps,omitempty"`
	Params         *AnyOfTestCaseParams `json:"params,omitempty"`
	Created        time.Time            `json:"created,omitempty"`
	Updated        time.Time            `json:"updated,omitempty"`
	Tags           []TagValue           `json:"tags,omitempty"`
	Deleted        time.Time            `json:"deleted,omitempty"`
	MemberId       int64                `json:"member_id,omitempty"`
	ProjectId      int64                `json:"project_id,omitempty"`
}

type TestCaseCreate 

type TestCaseCreate struct {
	Description    string                `json:"description,omitempty"`
	Preconditions  string                `json:"preconditions,omitempty"`
	Postconditions string                `json:"postconditions,omitempty"`
	Title          string                `json:"title"`
	Severity       int32                 `json:"severity,omitempty"`
	Priority       int32                 `json:"priority,omitempty"`
	Behavior       int32                 `json:"behavior,omitempty"`
	Type_          int32                 `json:"type,omitempty"`
	Layer          int32                 `json:"layer,omitempty"`
	IsFlaky        int32                 `json:"is_flaky,omitempty"`
	SuiteId        int64                 `json:"suite_id,omitempty"`
	MilestoneId    int64                 `json:"milestone_id,omitempty"`
	Automation     int32                 `json:"automation,omitempty"`
	Status         int32                 `json:"status,omitempty"`
	Steps          []TestCaseCreateSteps `json:"steps,omitempty"`
	// A map of custom fields values (id => value)
	CustomField map[string]string `json:"custom_field,omitempty"`
}

type TestCaseCreateSteps 

type TestCaseCreateSteps struct {
	Action         string   `json:"action,omitempty"`
	ExpectedResult string   `json:"expected_result,omitempty"`
	InputData      string   `json:"input_data,omitempty"`
	Position       int32    `json:"position,omitempty"`
	Attachments    []string `json:"attachments,omitempty"`
}

type TestCaseListResponse 

type TestCaseListResponse struct {
	Status bool                        `json:"status,omitempty"`
	Result *TestCaseListResponseResult `json:"result,omitempty"`
}

type TestCaseListResponseResult 

type TestCaseListResponseResult struct {
	Total    int32      `json:"total,omitempty"`
	Filtered int32      `json:"filtered,omitempty"`
	Count    int32      `json:"count,omitempty"`
	Entities []TestCase `json:"entities,omitempty"`
}

type TestCaseResponse 

type TestCaseResponse struct {
	Status bool      `json:"status,omitempty"`
	Result *TestCase `json:"result,omitempty"`
}

type TestCaseUpdate 

type TestCaseUpdate struct {
	Description    string                `json:"description,omitempty"`
	Preconditions  string                `json:"preconditions,omitempty"`
	Postconditions string                `json:"postconditions,omitempty"`
	Title          string                `json:"title,omitempty"`
	Severity       int32                 `json:"severity,omitempty"`
	Priority       int32                 `json:"priority,omitempty"`
	Behavior       int32                 `json:"behavior,omitempty"`
	Type_          int32                 `json:"type,omitempty"`
	Layer          int32                 `json:"layer,omitempty"`
	IsFlaky        int32                 `json:"is_flaky,omitempty"`
	SuiteId        int64                 `json:"suite_id,omitempty"`
	MilestoneId    int64                 `json:"milestone_id,omitempty"`
	Automation     int32                 `json:"automation,omitempty"`
	Status         int32                 `json:"status,omitempty"`
	Steps          []TestCaseUpdateSteps `json:"steps,omitempty"`
	// A map of custom fields values (id => value)
	CustomField map[string]string `json:"custom_field,omitempty"`
}

type TestCaseUpdateSteps 

type TestCaseUpdateSteps struct {
	Action         string `json:"action,omitempty"`
	ExpectedResult string `json:"expected_result,omitempty"`
	InputData      string `json:"input_data,omitempty"`
	Position       int32  `json:"position,omitempty"`
}

type TestStep 

type TestStep struct {
	Hash                 string       `json:"hash,omitempty"`
	SharedStepHash       string       `json:"shared_step_hash,omitempty"`
	SharedStepNestedHash string       `json:"shared_step_nested_hash,omitempty"`
	Position             int32        `json:"position,omitempty"`
	Action               string       `json:"action,omitempty"`
	ExpectedResult       string       `json:"expected_result,omitempty"`
	Data                 string       `json:"data,omitempty"`
	Attachments          []Attachment `json:"attachments,omitempty"`
}

type User 

type User struct {
	Id     int64  `json:"id,omitempty"`
	Name   string `json:"name,omitempty"`
	Email  string `json:"email,omitempty"`
	Title  string `json:"title,omitempty"`
	Status int32  `json:"status,omitempty"`
}

type UserListResponse 

type UserListResponse struct {
	Status bool                    `json:"status,omitempty"`
	Result *UserListResponseResult `json:"result,omitempty"`
}

type UserListResponseResult 

type UserListResponseResult struct {
	Total    int32  `json:"total,omitempty"`
	Filtered int32  `json:"filtered,omitempty"`
	Count    int32  `json:"count,omitempty"`
	Entities []User `json:"entities,omitempty"`
}

type UserResponse 

type UserResponse struct {
	Status bool  `json:"status,omitempty"`
	Result *User `json:"result,omitempty"`
}

type UsersApiGetUsersOpts 

type UsersApiGetUsersOpts struct {
	Limit  optional.Int32
	Offset optional.Int32
}

type UsersApiService 

type UsersApiService service

func (*UsersApiService) GetUser 

func (a *UsersApiService) GetUser(ctx context.Context, id int32) (UserResponse, *http.Response, error)

UsersApiService Get a specific user. This method allows to retrieve a specific user.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id Identifier.

@return UserResponse

func (*UsersApiService) GetUsers 

func (a *UsersApiService) GetUsers(ctx context.Context, localVarOptionals *UsersApiGetUsersOpts) (UserListResponse, *http.Response, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.