circleci

type APIClient struct {
	InsightsApi *InsightsApiService

	JobApi *JobApiService

	PipelineApi *PipelineApiService

	PreviewApi *PreviewApiService

	ProjectApi *ProjectApiService

	UserApi *UserApiService

	WorkflowApi *WorkflowApiService
	// contains filtered or unexported fields
}

type APIKey struct {
	Key    string
	Prefix string
}

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:"-"`
}

type Artifact struct {
	// The artifact path.
	Path string `json:"path"`
	// The index of the node that stored the artifact.
	NodeIndex int64 `json:"node_index"`
	// The URL to download the artifact contents.
	Url string `json:"url"`
}

type ArtifactListResponse struct {
	Items []Artifact `json:"items"`
	// A token to pass as a `page-token` query parameter to return the next page of results.
	NextPageToken string `json:"next_page_token"`
}

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

type CheckoutKey struct {
	// A public SSH key.
	PublicKey string `json:"public-key"`
	// The type of checkout key. This may be either `deploy-key` or `github-user-key`.
	Type_ string `json:"type"`
	// An SSH key fingerprint.
	Fingerprint string `json:"fingerprint"`
	// A boolean value that indicates if this key is preferred.
	Preferred bool `json:"preferred"`
	// The date and time the checkout key was created.
	CreatedAt time.Time `json:"created-at"`
}

type CheckoutKey1 struct {
	// A public SSH key.
	PublicKey string `json:"public-key"`
	// The type of checkout key. This may be either `deploy-key` or `github-user-key`.
	Type_ string `json:"type"`
	// An SSH key fingerprint.
	Fingerprint string `json:"fingerprint"`
	// A boolean value that indicates if this key is preferred.
	Preferred bool `json:"preferred"`
	// The date and time the checkout key was created.
	CreatedAt time.Time `json:"created-at"`
}

type CheckoutKeyInput struct {
	// The type of checkout key to create. This may be either `deploy-key` or `user-key`.
	Type_ string `json:"type"`
}

type CheckoutKeyListResponse struct {
	Items []CheckoutKey1 `json:"items"`
	// A token to pass as a `page-token` query parameter to return the next page of results.
	NextPageToken string `json:"next_page_token"`
}

type Collaboration struct {
	// The VCS provider
	VcsType string `json:"vcs-type"`
	// The name of the organization
	Name string `json:"name"`
	// URL to the user's avatar on the VCS
	AvatarUrl string `json:"avatar_url"`
}

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
}

type EnvironmentVariableListResponse struct {
	Items []EnvironmentVariablePair1 `json:"items"`
	// A token to pass as a `page-token` query parameter to return the next page of results.
	NextPageToken string `json:"next_page_token"`
}

type EnvironmentVariablePair struct {
	// The name of the environment variable.
	Name string `json:"name"`
	// The value of the environment variable.
	Value string `json:"value"`
}

type EnvironmentVariablePair1 struct {
	// The name of the environment variable.
	Name string `json:"name"`
	// The value of the environment variable.
	Value string `json:"value"`
}

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

type InlineResponse200 struct {
	// Workflow summary metrics.
	Items []InlineResponse200Items `json:"items"`
	// A token to pass as a `page-token` query parameter to return the next page of results.
	NextPageToken string `json:"next_page_token"`
}

type InlineResponse2001 struct {
	// Recent workflow runs.
	Items []InlineResponse2001Items `json:"items"`
	// A token to pass as a `page-token` query parameter to return the next page of results.
	NextPageToken string `json:"next_page_token"`
}

type InlineResponse2001Items struct {
	// The unique ID of the workflow.
	Id string `json:"id"`
	// The duration in seconds of a run.
	Duration int64 `json:"duration"`
	// The date and time the workflow was created.
	CreatedAt time.Time `json:"created_at"`
	// The date and time the workflow stopped.
	StoppedAt time.Time `json:"stopped_at"`
	// The number of credits used during execution
	CreditsUsed int64 `json:"credits_used"`
	// Workflow status.
	Status string `json:"status"`
}

type InlineResponse2002 struct {
	// Job summary metrics.
	Items []InlineResponse2002Items `json:"items"`
	// A token to pass as a `page-token` query parameter to return the next page of results.
	NextPageToken string `json:"next_page_token"`
}

type InlineResponse2002Items struct {
	// The name of the job.
	Name string `json:"name"`
	// The start of the aggregation window for job metrics.
	WindowStart time.Time `json:"window_start"`
	// The end of the aggregation window for job metrics.
	WindowEnd time.Time                  `json:"window_end"`
	Metrics   *InlineResponse2002Metrics `json:"metrics"`
}

type InlineResponse2002Metrics struct {
	// The ratio of successful runs / total runs.
	SuccessRate float32 `json:"success_rate"`
	// The total number of runs.
	TotalRuns int64 `json:"total_runs"`
	// The number of failed runs.
	FailedRuns int64 `json:"failed_runs"`
	// The number of successful runs.
	SuccessfulRuns int64 `json:"successful_runs"`
	// The average number of job runs per day.
	Throughput float32 `json:"throughput"`
	// The total credits consumed by the job in the aggregation window.
	TotalCreditsUsed int64                                     `json:"total_credits_used"`
	DurationMetrics  *InlineResponse2002MetricsDurationMetrics `json:"duration_metrics"`
}

type InlineResponse2002MetricsDurationMetrics struct {
	// The minimum duration, in seconds, among a group of runs.
	Min int64 `json:"min"`
	// The mean duration, in seconds, among a group of runs.
	Mean int64 `json:"mean"`
	// The median duration, in seconds, among a group of runs.
	Median int64 `json:"median"`
	// The 95th percentile duration, in seconds, among a group of runs.
	P95 int64 `json:"p95"`
	// The max duration, in seconds, among a group of runs.
	Max int64 `json:"max"`
	// The standard deviation, in seconds, among a group of runs.
	StandardDeviation float32 `json:"standard_deviation"`
}

type InlineResponse2003 struct {
	// Recent job runs.
	Items []InlineResponse2003Items `json:"items"`
	// A token to pass as a `page-token` query parameter to return the next page of results.
	NextPageToken string `json:"next_page_token"`
}

type InlineResponse2003Items struct {
	// The unique ID of the job.
	Id string `json:"id"`
	// The date and time the job started.
	StartedAt time.Time `json:"started_at"`
	// The time when the job stopped.
	StoppedAt time.Time `json:"stopped_at"`
	// Job status.
	Status string `json:"status"`
	// The number of credits used during execution
	CreditsUsed int64 `json:"credits_used"`
}

type InlineResponse200Items struct {
	// The name of the workflow.
	Name string `json:"name"`
	// The start of the aggregation window for workflow metrics.
	WindowStart time.Time `json:"window_start"`
	// The end of the aggregation window for workflow metrics.
	WindowEnd time.Time                 `json:"window_end"`
	Metrics   *InlineResponse200Metrics `json:"metrics"`
}

type InlineResponse200Metrics struct {
	// The ratio of successful runs / total runs.
	SuccessRate float32 `json:"success_rate"`
	// The total number of runs.
	TotalRuns int64 `json:"total_runs"`
	// The number of failed runs.
	FailedRuns int64 `json:"failed_runs"`
	// The number of successful runs.
	SuccessfulRuns int64 `json:"successful_runs"`
	// The average number of workflow runs per day.
	Throughput float32 `json:"throughput"`
	// The mean time to recovery (mean time between failures and their next success) in seconds.
	Mttr int64 `json:"mttr"`
	// The total credits consumed by the workflow in the aggregation window.
	TotalCreditsUsed int64                                    `json:"total_credits_used"`
	DurationMetrics  *InlineResponse200MetricsDurationMetrics `json:"duration_metrics"`
}

type InlineResponse200MetricsDurationMetrics struct {
	// The minimum duration, in seconds, among a group of runs.
	Min int64 `json:"min"`
	// The mean duration, in seconds, among a group of runs.
	Mean int64 `json:"mean"`
	// The median duration, in seconds, among a group of runs.
	Median int64 `json:"median"`
	// The 95th percentile duration, in seconds, among a group of runs.
	P95 int64 `json:"p95"`
	// The max duration, in seconds, among a group of runs.
	Max int64 `json:"max"`
	// The standard deviation, in seconds, among a group of runs.
	StandardDeviation float32 `json:"standard_deviation"`
}

type InsightsApiGetProjectJobRunsOpts struct {
	Branch    optional.String
	PageToken optional.String
}

type InsightsApiGetProjectWorkflowJobMetricsOpts struct {
	PageToken optional.String
	Branch    optional.String
}

type InsightsApiGetProjectWorkflowMetricsOpts struct {
	PageToken optional.String
	Branch    optional.String
}

type InsightsApiGetProjectWorkflowRunsOpts struct {
	Branch    optional.String
	PageToken optional.String
}

type InsightsApiService service

type Job struct {
	// The unique ID of the user.
	CanceledBy string `json:"canceled_by,omitempty"`
	// A sequence of the unique job IDs for the jobs that this job depends upon in the workflow.
	Dependencies []string `json:"dependencies"`
	// The number of the job.
	JobNumber int64 `json:"job_number,omitempty"`
	// The unique ID of the job.
	Id string `json:"id"`
	// The date and time the job started.
	StartedAt time.Time `json:"started_at"`
	// The name of the job.
	Name string `json:"name"`
	// The unique ID of the user.
	ApprovedBy string `json:"approved_by,omitempty"`
	// The project-slug for the job.
	ProjectSlug string `json:"project_slug"`
	// The current status of the job.
	Status *string `json:"status"`
	// The type of job.
	Type_ string `json:"type"`
	// The time when the job stopped.
	StoppedAt time.Time `json:"stopped_at,omitempty"`
	// The unique ID of the job.
	ApprovalRequestId string `json:"approval_request_id,omitempty"`
}

type JobApiService service

type JobDetails struct {
	// URL of the job in CircleCI Web UI.
	WebUrl  string             `json:"web_url"`
	Project *JobDetailsProject `json:"project"`
	// Info about parallels runs and their status.
	ParallelRuns []JobDetailsParallelRuns `json:"parallel_runs"`
	// The date and time the job started.
	StartedAt      time.Time                 `json:"started_at"`
	LatestWorkflow *JobDetailsLatestWorkflow `json:"latest_workflow"`
	// The name of the job.
	Name     string              `json:"name"`
	Executor *JobDetailsExecutor `json:"executor"`
	// A number of parallel runs the job has.
	Parallelism int64 `json:"parallelism"`
	// The current status of the job.
	Status *string `json:"status"`
	// The number of the job.
	Number   int64               `json:"number"`
	Pipeline *JobDetailsPipeline `json:"pipeline"`
	// Duration of a job in milliseconds.
	Duration int64 `json:"duration"`
	// The time when the job was created.
	CreatedAt time.Time `json:"created_at"`
	// Messages from CircleCI execution platform.
	Messages []JobDetailsMessages `json:"messages"`
	// List of contexts used by the job.
	Contexts     []JobDetailsContexts    `json:"contexts"`
	Organization *JobDetailsOrganization `json:"organization"`
	// The time when the job was placed in a queue.
	QueuedAt time.Time `json:"queued_at"`
	// The time when the job stopped.
	StoppedAt time.Time `json:"stopped_at,omitempty"`
}

type JobDetailsContexts struct {
	// The name of the context.
	Name string `json:"name"`
}

type JobDetailsExecutor struct {
	// Executor type.
	Type_ string `json:"type"`
	// Resource class name.
	ResourceClass string `json:"resource_class"`
}

type JobDetailsLatestWorkflow struct {
	// The unique ID of the workflow.
	Id string `json:"id"`
	// The name of the workflow.
	Name string `json:"name"`
}

type JobDetailsMessages struct {
	// Message type.
	Type_ string `json:"type"`
	// Information describing message.
	Message string `json:"message"`
	// Value describing the reason for message to be added to the job.
	Reason string `json:"reason,omitempty"`
}

type JobDetailsOrganization struct {
	// The name of the organization.
	Name string `json:"name"`
}

type JobDetailsParallelRuns struct {
	// Index of the parallel run.
	Index int64 `json:"index"`
	// Status of the parallel run.
	Status string `json:"status"`
}

type JobDetailsPipeline struct {
	// The unique ID of the pipeline.
	Id string `json:"id"`
}

type JobDetailsProject struct {
	// Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped.
	Slug string `json:"slug"`
	// The name of the project
	Name string `json:"name"`
	// URL to the repository hosting the project's code
	ExternalUrl string `json:"external_url"`
}

type MessageResponse struct {
	// A human-readable message
	Message string `json:"message"`
}

type Pipeline struct {
	// The unique ID of the pipeline.
	Id string `json:"id"`
	// A sequence of errors that have occurred within the pipeline.
	Errors []PipelineListResponseErrors `json:"errors"`
	// The project-slug for the pipeline.
	ProjectSlug string `json:"project_slug"`
	// The date and time the pipeline was last updated.
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// The number of the pipeline.
	Number int64 `json:"number"`
	// The current state of the pipeline.
	State string `json:"state"`
	// The date and time the pipeline was created.
	CreatedAt time.Time                    `json:"created_at"`
	Trigger   *PipelineListResponseTrigger `json:"trigger"`
	Vcs       *PipelineListResponseVcs     `json:"vcs,omitempty"`
}

type Pipeline1 struct {
	// The unique ID of the pipeline.
	Id string `json:"id"`
	// A sequence of errors that have occurred within the pipeline.
	Errors []PipelineListResponseErrors `json:"errors"`
	// The project-slug for the pipeline.
	ProjectSlug string `json:"project_slug"`
	// The date and time the pipeline was last updated.
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// The number of the pipeline.
	Number int64 `json:"number"`
	// The current state of the pipeline.
	State string `json:"state"`
	// The date and time the pipeline was created.
	CreatedAt time.Time                    `json:"created_at"`
	Trigger   *PipelineListResponseTrigger `json:"trigger"`
	Vcs       *PipelineListResponseVcs     `json:"vcs,omitempty"`
}

type PipelineApiListMyPipelinesOpts struct {
	PageToken optional.String
}

type PipelineApiListPipelinesForProjectOpts struct {
	Branch    optional.String
	PageToken optional.String
}

type PipelineApiListPipelinesOpts struct {
	PageToken optional.String
}

type PipelineApiListWorkflowsByPipelineIdOpts struct {
	PageToken optional.String
}

type PipelineApiService service

type PipelineApiTriggerPipelineOpts struct {
	Body                optional.Interface
	XAttributionLogin   optional.String
	XAttributionActorId optional.String
}

type PipelineConfig struct {
	// The source configuration for the pipeline, before any config compilation has been performed. If there is no config, then this field will be empty.
	Source string `json:"source"`
	// The compiled configuration for the pipeline, after all orb expansion has been performed. If there were errors processing the pipeline's configuration, then this field may be empty.
	Compiled string `json:"compiled"`
}

type PipelineCreation struct {
	// The unique ID of the pipeline.
	Id string `json:"id"`
	// The current state of the pipeline.
	State string `json:"state"`
	// The number of the pipeline.
	Number int64 `json:"number"`
	// The date and time the pipeline was created.
	CreatedAt time.Time `json:"created_at"`
}

type PipelineListResponse struct {
	Items []Pipeline1 `json:"items"`
	// A token to pass as a `page-token` query parameter to return the next page of results.
	NextPageToken string `json:"next_page_token"`
}

type PipelineListResponseErrors struct {
	// The type of error.
	Type_ string `json:"type"`
	// A human-readable error message.
	Message string `json:"message"`
}

type PipelineListResponseTrigger struct {
	// The type of trigger.
	Type_ string `json:"type"`
	// The date and time the trigger was received.
	ReceivedAt time.Time                         `json:"received_at"`
	Actor      *PipelineListResponseTriggerActor `json:"actor"`
}

type PipelineListResponseTriggerActor struct {
	// The login information for the user on the VCS.
	Login string `json:"login"`
	// URL to the user's avatar on the VCS
	AvatarUrl string `json:"avatar_url"`
}

type PipelineListResponseVcs struct {
	// Name of the VCS provider (e.g. GitHub, Bitbucket).
	ProviderName string `json:"provider_name"`
	// URL for the repository where the trigger originated. For fork-PR pipelines, this is the URL to the fork. For other pipelines the `origin_` and `target_repository_url`s will be the same.
	OriginRepositoryUrl string `json:"origin_repository_url"`
	// URL for the repository the trigger targets (i.e. the repository where the PR will be merged). For fork-PR pipelines, this is the URL to the parent repo. For other pipelines, the `origin_` and `target_repository_url`s will be the same.
	TargetRepositoryUrl string `json:"target_repository_url"`
	// The code revision the pipeline ran.
	Revision string `json:"revision"`
	// The branch where the pipeline ran. The HEAD commit on this branch was used for the pipeline. Note that `branch` and `tag` are mutually exclusive.
	Branch string `json:"branch,omitempty"`
	// The tag used by the pipeline. The commit that this tag points to was used for the pipeline. Note that `branch` and `tag` are mutually exclusive.
	Tag    string                         `json:"tag,omitempty"`
	Commit *PipelineListResponseVcsCommit `json:"commit,omitempty"`
}

type PipelineListResponseVcsCommit struct {
	// The subject of the commit message.
	Subject string `json:"subject"`
	// The body of the commit message.
	Body string `json:"body"`
}

type PreviewApiCreateCheckoutKeyOpts struct {
	Body optional.Interface
}

type PreviewApiCreateEnvVarOpts struct {
	Body optional.Interface
}

type PreviewApiGetProjectJobRunsOpts struct {
	Branch    optional.String
	PageToken optional.String
}

type PreviewApiGetProjectWorkflowJobMetricsOpts struct {
	PageToken optional.String
	Branch    optional.String
}

type PreviewApiGetProjectWorkflowMetricsOpts struct {
	PageToken optional.String
	Branch    optional.String
}

type PreviewApiGetProjectWorkflowRunsOpts struct {
	Branch    optional.String
	PageToken optional.String
}

type PreviewApiListPipelinesOpts struct {
	PageToken optional.String
}

type PreviewApiService service

type Project struct {
	// Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped.
	Slug string `json:"slug"`
	// The name of the project
	Name string `json:"name"`
	// The name of the organization the project belongs to
	OrganizationName string          `json:"organization_name"`
	VcsInfo          *ProjectVcsInfo `json:"vcs_info"`
}

type ProjectApiCreateCheckoutKeyOpts struct {
	Body optional.Interface
}

type ProjectApiCreateEnvVarOpts struct {
	Body optional.Interface
}

type ProjectApiService service

type ProjectVcsInfo struct {
	// URL to the repository hosting the project's code
	VcsUrl string `json:"vcs_url"`
	// The VCS provider
	Provider      string `json:"provider"`
	DefaultBranch string `json:"default_branch"`
}

type RerunWorkflowParameters struct {
	// A list of job IDs to rerun.
	Jobs []string `json:"jobs,omitempty"`
	// Whether to rerun the workflow from the failed job. Mutually exclusive with the jobs parameter.
	FromFailed bool `json:"from_failed,omitempty"`
}

type TestsResponse struct {
	Items []TestsResponseItems `json:"items"`
	// A token to pass as a `page-token` query parameter to return the next page of results.
	NextPageToken string `json:"next_page_token"`
}

type TestsResponseItems struct {
	// The failure message associated with the test.
	Message string `json:"message"`
	// The program that generated the test results
	Source string `json:"source"`
	// The time it took to run the test in seconds
	RunTime float64 `json:"run_time"`
	// The file in which the test is defined.
	File string `json:"file"`
	// Indication of whether the test succeeded.
	Result string `json:"result"`
	// The name of the test.
	Name string `json:"name"`
	// The programmatic location of the test.
	Classname string `json:"classname"`
}

type TriggerPipelineParameters struct {
	// The branch where the pipeline ran. The HEAD commit on this branch was used for the pipeline. Note that `branch` and `tag` are mutually exclusive.
	Branch string `json:"branch,omitempty"`
	// The tag used by the pipeline. The commit that this tag points to was used for the pipeline. Note that `branch` and `tag` are mutually exclusive.
	Tag string `json:"tag,omitempty"`
	// An object containing pipeline parameters and their values.
	Parameters map[string]string `json:"parameters,omitempty"`
}

type User struct {
	// The unique ID of the user.
	Id string `json:"id"`
	// The login information for the user on the VCS.
	Login string `json:"login"`
	// The name of the user.
	Name string `json:"name"`
}

type UserApiService service

type Workflow struct {
	// The ID of the pipeline this workflow belongs to.
	PipelineId string `json:"pipeline_id"`
	CanceledBy string `json:"canceled_by,omitempty"`
	// The unique ID of the workflow.
	Id string `json:"id"`
	// The name of the workflow.
	Name string `json:"name"`
	// The project-slug for the pipeline this workflow belongs to.
	ProjectSlug string `json:"project_slug"`
	ErroredBy   string `json:"errored_by,omitempty"`
	// The current status of the workflow.
	Status    string `json:"status"`
	StartedBy string `json:"started_by"`
	// The number of the pipeline this workflow belongs to.
	PipelineNumber int64 `json:"pipeline_number"`
	// The date and time the workflow was created.
	CreatedAt time.Time `json:"created_at"`
	// The date and time the workflow stopped.
	StoppedAt time.Time `json:"stopped_at"`
}

type Workflow1 struct {
	// The ID of the pipeline this workflow belongs to.
	PipelineId string `json:"pipeline_id"`
	CanceledBy string `json:"canceled_by,omitempty"`
	// The unique ID of the workflow.
	Id string `json:"id"`
	// The name of the workflow.
	Name string `json:"name"`
	// The project-slug for the pipeline this workflow belongs to.
	ProjectSlug string `json:"project_slug"`
	ErroredBy   string `json:"errored_by,omitempty"`
	// The current status of the workflow.
	Status    string `json:"status"`
	StartedBy string `json:"started_by"`
	// The number of the pipeline this workflow belongs to.
	PipelineNumber int64 `json:"pipeline_number"`
	// The date and time the workflow was created.
	CreatedAt time.Time `json:"created_at"`
	// The date and time the workflow stopped.
	StoppedAt time.Time `json:"stopped_at"`
}

type WorkflowApiRerunWorkflowOpts struct {
	Body optional.Interface
}

type WorkflowApiService service

type WorkflowJobListResponse struct {
	Items []Job `json:"items"`
	// A token to pass as a `page-token` query parameter to return the next page of results.
	NextPageToken string `json:"next_page_token"`
}

type WorkflowListResponse struct {
	// A list of workflows.
	Items []Workflow1 `json:"items"`
	// A token to pass as a `page-token` query parameter to return the next page of results.
	NextPageToken string `json:"next_page_token"`
}